From 84a14b6a109f1292d47e2d971c508b97241cd827 Mon Sep 17 00:00:00 2001 From: PureCloud Jenkins Date: Thu, 4 Mar 2021 04:32:04 +0000 Subject: [PATCH] 34.0.0 --- Makefile | 5 +- README.md | 2 +- build/.gitignore | 25 - build/.swagger-codegen-ignore | 23 - build/Makefile | 7 - build/README.md | 182 - build/docs/index.md | 182 - build/docs/releaseNotes.md | 10 - build/platformclientv2/action.go | 49 - build/platformclientv2/actionconfig.go | 21 - build/platformclientv2/actioncontract.go | 21 - build/platformclientv2/actioncontractinput.go | 21 - build/platformclientv2/actionentitylisting.go | 53 - build/platformclientv2/actioninput.go | 25 - build/platformclientv2/actionmap.go | 86 - build/platformclientv2/actionmapaction.go | 25 - .../actionmapactiontemplate.go | 21 - build/platformclientv2/actionmaplisting.go | 53 - .../actionmapschedulegroup.go | 17 - .../actionmapschedulegroups.go | 21 - build/platformclientv2/actionoutput.go | 37 - build/platformclientv2/actionproperties.go | 33 - build/platformclientv2/actions.go | 17 - build/platformclientv2/actionsurvey.go | 17 - build/platformclientv2/actiontarget.go | 58 - build/platformclientv2/actiontargetlisting.go | 53 - build/platformclientv2/actiontemplate.go | 50 - .../platformclientv2/actiontemplatelisting.go | 53 - build/platformclientv2/activation.go | 21 - build/platformclientv2/activealertcount.go | 17 - build/platformclientv2/activitycode.go | 57 - .../platformclientv2/activitycodecontainer.go | 21 - build/platformclientv2/acwsettings.go | 21 - .../addconversationrequest.go | 17 - .../addconversationresponse.go | 21 - build/platformclientv2/additionalmessage.go | 29 - build/platformclientv2/address.go | 33 - .../platformclientv2/addressableentityref.go | 21 - .../addressablelicensedefinition.go | 21 - .../platformclientv2/addshifttraderequest.go | 34 - .../addworkplanrotationagentrequest.go | 25 - .../addworkplanrotationrequest.go | 29 - build/platformclientv2/adfs.go | 49 - build/platformclientv2/adherencesettings.go | 37 - .../adhocrecordingtopicconversationdata.go | 17 - .../adhocrecordingtopiclockdata.go | 26 - .../adhocrecordingtopicrecordingdatav2.go | 82 - .../adhocrecordingtopicworkspacedata.go | 17 - build/platformclientv2/adjacents.go | 25 - .../admintimeoffrequestpatch.go | 42 - build/platformclientv2/aftercallwork.go | 26 - build/platformclientv2/agent.go | 17 - build/platformclientv2/agentactivity.go | 69 - .../agentactivitychangedtopicagentactivity.go | 38 - ...ctivitychangedtopicorganizationpresence.go | 21 - .../agentactivitychangedtopicoutofoffice.go | 22 - .../agentactivitychangedtopicpresence.go | 26 - .../agentactivitychangedtopicroutingstatus.go | 22 - .../agentactivityentitylisting.go | 53 - .../agentevaluatoractivity.go | 45 - .../agenttimeoffrequestpatch.go | 25 - build/platformclientv2/aggregatemetricdata.go | 25 - build/platformclientv2/aggregateviewdata.go | 21 - build/platformclientv2/aggregationrange.go | 21 - build/platformclientv2/aggregationresult.go | 33 - .../aggregationresultentry.go | 29 - build/platformclientv2/alertingapi.go | 877 -- build/platformclientv2/amazonlexrequest.go | 21 - build/platformclientv2/analyticsapi.go | 3119 ----- .../platformclientv2/analyticsconversation.go | 58 - ...analyticsconversationasyncqueryresponse.go | 26 - .../analyticsconversationqueryresponse.go | 21 - .../analyticsconversationsegment.go | 114 - .../analyticsconversationwithoutattributes.go | 58 - ...sationwithoutattributesmultigetresponse.go | 17 - build/platformclientv2/analyticsevaluation.go | 66 - build/platformclientv2/analyticsflow.go | 69 - .../platformclientv2/analyticsflowoutcome.go | 34 - .../analyticsmediaendpointstat.go | 53 - .../platformclientv2/analyticsparticipant.go | 53 - .../analyticsparticipantwithoutattributes.go | 49 - build/platformclientv2/analyticsproperty.go | 25 - .../analyticsproposedagent.go | 21 - .../analyticsqueryaggregation.go | 33 - build/platformclientv2/analyticsresolution.go | 25 - .../analyticsroutingstatusrecord.go | 26 - .../platformclientv2/analyticsscoredagent.go | 21 - build/platformclientv2/analyticssession.go | 262 - .../analyticssessionmetric.go | 26 - build/platformclientv2/analyticssurvey.go | 58 - build/platformclientv2/analyticsuserdetail.go | 25 - .../analyticsuserdetailsasyncqueryresponse.go | 26 - .../analyticsuserdetailsqueryresponse.go | 21 - .../analyticsuserpresencerecord.go | 30 - build/platformclientv2/annotation.go | 101 - build/platformclientv2/answeroption.go | 25 - build/platformclientv2/apiclient.go | 275 - build/platformclientv2/apiresponse.go | 112 - build/platformclientv2/apiusagequery.go | 29 - build/platformclientv2/apiusagequeryresult.go | 21 - build/platformclientv2/apiusagerow.go | 66 - build/platformclientv2/architectapi.go | 9115 ------------- ...pendencytrackingbuildnotificationclient.go | 21 - ...tiondependencytrackingbuildnotification.go | 30 - ...ackingbuildnotificationhomeorganization.go | 25 - ...dependencytrackingbuildnotificationuser.go | 25 - build/platformclientv2/architectflowfields.go | 21 - ...itectflownotificationarchitectoperation.go | 53 - .../architectflownotificationclient.go | 21 - .../architectflownotificationerrordetail.go | 29 - ...itectflownotificationerrormessageparams.go | 17 - ...chitectflownotificationflownotification.go | 45 - .../architectflownotificationflowversion.go | 17 - ...chitectflownotificationhomeorganization.go | 25 - .../architectflownotificationuser.go | 25 - ...owoutcomenotificationarchitectoperation.go | 53 - .../architectflowoutcomenotificationclient.go | 21 - ...itectflowoutcomenotificationerrordetail.go | 29 - ...owoutcomenotificationerrormessageparams.go | 17 - ...comenotificationflowoutcomenotification.go | 29 - ...flowoutcomenotificationhomeorganization.go | 25 - .../architectflowoutcomenotificationuser.go | 25 - ...ectpromptnotificationarchitectoperation.go | 53 - .../architectpromptnotificationclient.go | 21 - .../architectpromptnotificationerrordetail.go | 29 - ...ectpromptnotificationerrormessageparams.go | 17 - ...itectpromptnotificationhomeorganization.go | 25 - ...ectpromptnotificationpromptnotification.go | 29 - .../architectpromptnotificationuser.go | 25 - ...enotificationpromptresourcenotification.go | 37 - ...icationsystempromptresourcenotification.go | 37 - build/platformclientv2/archiveretention.go | 21 - build/platformclientv2/arraynode.go | 97 - build/platformclientv2/assignedwrapupcode.go | 34 - build/platformclientv2/assignmentgroup.go | 29 - .../asyncconversationquery.go | 57 - .../asyncforecastoperationresult.go | 29 - .../platformclientv2/asyncintradayresponse.go | 25 - build/platformclientv2/asyncqueryresponse.go | 17 - build/platformclientv2/asyncquerystatus.go | 34 - .../platformclientv2/asyncuserdetailsquery.go | 37 - build/platformclientv2/attachment.go | 37 - build/platformclientv2/attemptlimits.go | 58 - .../attemptlimitsentitylisting.go | 53 - build/platformclientv2/attributefilteritem.go | 25 - build/platformclientv2/atzmtimeslot.go | 21 - .../atzmtimeslotwithtimezone.go | 25 - build/platformclientv2/auditapi.go | 490 - build/platformclientv2/auditchange.go | 29 - build/platformclientv2/auditentity.go | 29 - .../platformclientv2/auditentityreference.go | 33 - build/platformclientv2/auditfacet.go | 21 - build/platformclientv2/auditfilter.go | 29 - build/platformclientv2/auditlogmessage.go | 66 - build/platformclientv2/auditmessage.go | 77 - build/platformclientv2/auditqueryentity.go | 21 - .../auditqueryexecutionresultsresponse.go | 29 - .../auditqueryexecutionstatusresponse.go | 42 - build/platformclientv2/auditqueryfilter.go | 21 - build/platformclientv2/auditqueryrequest.go | 29 - build/platformclientv2/auditqueryresponse.go | 13 - build/platformclientv2/auditqueryservice.go | 21 - .../auditqueryservicemapping.go | 17 - build/platformclientv2/auditquerysort.go | 21 - .../auditrealtimequeryrequest.go | 37 - .../auditrealtimequeryresultsresponse.go | 33 - build/platformclientv2/auditsearchresult.go | 37 - build/platformclientv2/audituser.go | 25 - build/platformclientv2/authorizationapi.go | 3349 ----- build/platformclientv2/authzdivision.go | 37 - .../authzdivisionentitylisting.go | 53 - .../authzdivisiongrantentitylisting.go | 33 - build/platformclientv2/authzgrant.go | 30 - build/platformclientv2/authzgrantpolicy.go | 29 - build/platformclientv2/authzgrantrole.go | 37 - build/platformclientv2/authzsubject.go | 33 - .../automatictimezonemappingsettings.go | 17 - .../platformclientv2/availablelanguagelist.go | 17 - build/platformclientv2/availabletopic.go | 57 - .../availabletopicentitylisting.go | 17 - .../platformclientv2/availabletranslations.go | 21 - .../batchdownloadjobresult.go | 45 - .../batchdownloadjobstatusresult.go | 41 - .../batchdownloadjobsubmission.go | 17 - .../batchdownloadjobsubmissionresult.go | 21 - .../platformclientv2/batchdownloadrequest.go | 21 - build/platformclientv2/billingapi.go | 215 - build/platformclientv2/billingusage.go | 25 - build/platformclientv2/billingusagereport.go | 42 - .../platformclientv2/billingusageresource.go | 22 - build/platformclientv2/biography.go | 33 - build/platformclientv2/buabandonrate.go | 21 - .../buagentscheduleactivity.go | 46 - .../buagentschedulehistorychange.go | 29 - .../buagentschedulehistorychangemetadata.go | 22 - .../buagentschedulehistorydeletedchange.go | 26 - .../buagentschedulehistorydroppedchange.go | 30 - .../buagentschedulehistoryresponse.go | 29 - ...agentschedulepublishedschedulereference.go | 30 - .../buagentschedulequeryresponse.go | 37 - .../buagentschedulerescheduleresponse.go | 33 - .../buagentschedulesearchresponse.go | 25 - .../platformclientv2/buagentscheduleshift.go | 38 - .../buagentschedulesqueryresponse.go | 21 - .../buagentschedulessearchresponse.go | 25 - .../platformclientv2/buagentscheduleupdate.go | 22 - .../buasyncagentschedulesqueryresponse.go | 33 - .../buasyncagentschedulessearchresponse.go | 33 - .../buasyncscheduleresponse.go | 25 - .../buasyncschedulerunresponse.go | 25 - .../buaveragespeedofanswer.go | 21 - .../platformclientv2/bucopyschedulerequest.go | 22 - .../bucreateblankschedulerequest.go | 25 - .../bucurrentagentschedulesearchresponse.go | 38 - ...buforecastgenerationplanninggroupresult.go | 21 - .../buforecastgenerationresult.go | 17 - .../buforecastmodification.go | 57 - build/platformclientv2/buforecastresult.go | 30 - .../buforecastresultresponse.go | 21 - .../buforecasttimeseriesresult.go | 21 - .../bufulldaytimeoffmarker.go | 38 - .../bugenerateschedulerequest.go | 25 - .../bugetcurrentagentschedulerequest.go | 22 - build/platformclientv2/buheadcountforecast.go | 22 - .../buheadcountforecastresponse.go | 21 - build/platformclientv2/buintradaydatagroup.go | 41 - .../buintradayforecastdata.go | 21 - build/platformclientv2/buintradayresponse.go | 46 - .../buintradayscheduledata.go | 17 - .../bulkshifttradestateupdaterequest.go | 17 - .../bulkupdateshifttradestaterequestitem.go | 25 - .../bulkupdateshifttradestateresponse.go | 25 - .../bulkupdateshifttradestateresult.go | 17 - .../bulkupdateshifttradestateresultitem.go | 38 - build/platformclientv2/bullseye.go | 17 - .../bumanagementunitschedulesummary.go | 34 - .../buplanninggroupheadcountforecast.go | 25 - .../buqueryagentschedulesrequest.go | 25 - .../burescheduleagentscheduleresult.go | 25 - build/platformclientv2/bureschedulerequest.go | 50 - build/platformclientv2/burescheduleresult.go | 33 - build/platformclientv2/buschedulelisting.go | 17 - build/platformclientv2/buschedulelistitem.go | 50 - build/platformclientv2/buschedulemetadata.go | 54 - build/platformclientv2/buschedulereference.go | 26 - .../buschedulereferenceformuroute.go | 30 - build/platformclientv2/buschedulerun.go | 82 - .../platformclientv2/buschedulerunlisting.go | 17 - .../busearchagentschedulesrequest.go | 26 - build/platformclientv2/buservicelevel.go | 25 - build/platformclientv2/bushorttermforecast.go | 74 - .../bushorttermforecastingsettings.go | 17 - .../bushorttermforecastlisting.go | 17 - .../bushorttermforecastlistitem.go | 46 - .../bushorttermforecastreference.go | 30 - build/platformclientv2/businessunit.go | 33 - .../businessunitactivitycode.go | 57 - .../businessunitactivitycodelisting.go | 17 - build/platformclientv2/businessunitlisting.go | 17 - .../platformclientv2/businessunitlistitem.go | 33 - .../platformclientv2/businessunitreference.go | 21 - .../platformclientv2/businessunitsettings.go | 29 - build/platformclientv2/buttoncomponent.go | 29 - build/platformclientv2/calibration.go | 78 - .../platformclientv2/calibrationassignment.go | 29 - build/platformclientv2/calibrationcreate.go | 78 - .../calibrationentitylisting.go | 53 - build/platformclientv2/call.go | 130 - .../callablecontactsdiagnostic.go | 29 - build/platformclientv2/callabletime.go | 21 - build/platformclientv2/callabletimeset.go | 42 - .../callabletimesetentitylisting.go | 53 - build/platformclientv2/callablewindow.go | 21 - build/platformclientv2/callback.go | 114 - build/platformclientv2/callbackbasic.go | 114 - .../platformclientv2/callbackconversation.go | 33 - .../callbackconversationentitylisting.go | 53 - build/platformclientv2/callbackidentifier.go | 21 - .../callbackmediaparticipant.go | 182 - build/platformclientv2/callbasic.go | 130 - build/platformclientv2/callcommand.go | 21 - build/platformclientv2/callconversation.go | 41 - .../callconversationentitylisting.go | 53 - build/platformclientv2/callforwarding.go | 50 - .../callforwardingeventcall.go | 17 - .../callforwardingeventcallforwarding.go | 34 - .../callforwardingeventtarget.go | 21 - .../callforwardingeventuser.go | 17 - .../callhistoryconversation.go | 66 - .../callhistoryconversationentitylisting.go | 53 - .../callhistoryparticipant.go | 90 - .../platformclientv2/callmediaparticipant.go | 194 - build/platformclientv2/callmediapolicy.go | 21 - .../callmediapolicyconditions.go | 45 - build/platformclientv2/callrecord.go | 22 - build/platformclientv2/callroute.go | 17 - build/platformclientv2/calltarget.go | 21 - build/platformclientv2/calltoaction.go | 25 - build/platformclientv2/campaign.go | 146 - build/platformclientv2/campaigndiagnostics.go | 33 - .../platformclientv2/campaigndivisionview.go | 29 - .../campaigndivisionviewlisting.go | 53 - .../platformclientv2/campaignentitylisting.go | 53 - build/platformclientv2/campaigninteraction.go | 98 - .../platformclientv2/campaigninteractions.go | 37 - build/platformclientv2/campaignprogress.go | 37 - build/platformclientv2/campaignrule.go | 58 - build/platformclientv2/campaignruleaction.go | 29 - .../campaignruleactionentities.go | 25 - .../platformclientv2/campaignrulecondition.go | 25 - .../platformclientv2/campaignruleentities.go | 21 - .../campaignruleentitylisting.go | 53 - .../campaignruleparameters.go | 29 - build/platformclientv2/campaignschedule.go | 50 - build/platformclientv2/campaignsequence.go | 58 - .../campaignsequenceentitylisting.go | 53 - build/platformclientv2/campaignstats.go | 37 - build/platformclientv2/campaigntimeslot.go | 25 - build/platformclientv2/category.go | 17 - build/platformclientv2/categorylisting.go | 29 - build/platformclientv2/certificate.go | 17 - .../certificateauthorityentitylisting.go | 53 - build/platformclientv2/certificatedetails.go | 42 - build/platformclientv2/change.go | 29 - .../changemypasswordrequest.go | 21 - .../platformclientv2/changepasswordrequest.go | 17 - build/platformclientv2/channel.go | 26 - .../platformclientv2/channelentitylisting.go | 17 - build/platformclientv2/channeltopic.go | 21 - .../channeltopicentitylisting.go | 17 - build/platformclientv2/chat.go | 17 - build/platformclientv2/chatapi.go | 237 - .../chatbadgetopicbadgeentity.go | 17 - .../chatbadgetopicchatbadge.go | 26 - build/platformclientv2/chatconversation.go | 33 - .../chatconversationentitylisting.go | 53 - .../platformclientv2/chatmediaparticipant.go | 154 - build/platformclientv2/chatmediapolicy.go | 21 - .../chatmediapolicyconditions.go | 41 - build/platformclientv2/chatmessage.go | 61 - build/platformclientv2/chatmessageuser.go | 33 - build/platformclientv2/chatsettings.go | 17 - build/platformclientv2/clientapp.go | 49 - .../clientappconfigurationinfo.go | 21 - .../clientappentitylisting.go | 53 - .../closebuttonstyleproperties.go | 21 - build/platformclientv2/coachingannotation.go | 50 - .../coachingannotationcreaterequest.go | 21 - .../coachingannotationlist.go | 53 - build/platformclientv2/coachingapi.go | 1664 --- .../coachingappointmentaggregaterequest.go | 29 - .../coachingappointmentaggregateresponse.go | 17 - .../coachingappointmentreference.go | 21 - .../coachingappointmentresponse.go | 78 - .../coachingappointmentresponselist.go | 53 - .../coachingappointmentstatusrequest.go | 17 - .../coachingappointmentstatusresponse.go | 30 - .../coachingappointmentstatusresponselist.go | 33 - .../platformclientv2/coachingnotification.go | 58 - .../coachingnotificationlist.go | 53 - .../platformclientv2/cobrowseconversation.go | 33 - .../cobrowseconversationentitylisting.go | 53 - .../cobrowsemediaparticipant.go | 166 - build/platformclientv2/cobrowsesession.go | 86 - build/platformclientv2/commandstatus.go | 46 - .../commandstatusentitylisting.go | 53 - build/platformclientv2/commoncampaign.go | 33 - .../commoncampaigndivisionview.go | 33 - ...commoncampaigndivisionviewentitylisting.go | 53 - .../commoncampaignentitylisting.go | 53 - build/platformclientv2/condition.go | 49 - build/platformclientv2/configuration.go | 271 - build/platformclientv2/connectrate.go | 25 - .../constraintconflictmessage.go | 21 - build/platformclientv2/consulttransfer.go | 21 - .../consulttransferresponse.go | 17 - .../platformclientv2/consulttransferupdate.go | 17 - .../consumedresourcesentitylisting.go | 53 - .../consumingresourcesentitylisting.go | 53 - build/platformclientv2/contact.go | 37 - build/platformclientv2/contactaddress.go | 37 - .../contactcallbackrequest.go | 33 - .../platformclientv2/contactcentersettings.go | 17 - .../platformclientv2/contactcolumntimezone.go | 21 - .../contactcolumntodataactionfieldmapping.go | 13 - build/platformclientv2/contactlist.go | 78 - .../contactlistdivisionview.go | 45 - .../contactlistdivisionviewlisting.go | 53 - .../contactlistdownloadreadyexporturi.go | 25 - .../contactlistentitylisting.go | 53 - build/platformclientv2/contactlistfilter.go | 50 - .../contactlistfilterclause.go | 21 - .../contactlistfilterentitylisting.go | 53 - .../contactlistfilterpredicate.go | 37 - .../contactlistfilterrange.go | 33 - .../contactlistimportstatusimportstatus.go | 37 - build/platformclientv2/contactlisting.go | 53 - .../contactphonenumbercolumn.go | 25 - build/platformclientv2/contactsort.go | 25 - build/platformclientv2/contentactions.go | 33 - build/platformclientv2/contentattachment.go | 41 - .../contentattributefilteritem.go | 25 - .../contentfacetfilteritem.go | 29 - build/platformclientv2/contentfilteritem.go | 29 - build/platformclientv2/contentgeneric.go | 41 - build/platformclientv2/contentlist.go | 41 - build/platformclientv2/contentlocation.go | 33 - .../platformclientv2/contentmanagementapi.go | 3496 ----- ...gementsingledocumenttopicdocumentdatav2.go | 70 - ...ntmanagementsingledocumenttopiclockdata.go | 26 - ...ntmanagementsingledocumenttopicuserdata.go | 21 - ...agementsingledocumenttopicworkspacedata.go | 17 - ...ntworkspacedocumentstopicdocumentdatav2.go | 70 - ...nagementworkspacedocumentstopiclockdata.go | 26 - ...nagementworkspacedocumentstopicuserdata.go | 21 - ...entworkspacedocumentstopicworkspacedata.go | 17 - .../contentnotificationtemplate.go | 33 - build/platformclientv2/contentoffer.go | 45 - .../contentofferstyleproperties.go | 25 - .../contentofferstylingconfiguration.go | 41 - .../contentpositionproperties.go | 29 - build/platformclientv2/contentpostback.go | 25 - build/platformclientv2/contentqueryrequest.go | 45 - build/platformclientv2/contentquickreply.go | 33 - build/platformclientv2/contentreaction.go | 21 - build/platformclientv2/contentsortitem.go | 21 - build/platformclientv2/context.go | 17 - build/platformclientv2/contextentity.go | 17 - build/platformclientv2/contextintent.go | 17 - build/platformclientv2/contextpattern.go | 17 - build/platformclientv2/conversation.go | 62 - .../conversationaggregatedatacontainer.go | 21 - .../conversationaggregatequeryclause.go | 21 - .../conversationaggregatequeryfilter.go | 25 - .../conversationaggregatequerypredicate.go | 33 - .../conversationaggregatequeryresponse.go | 17 - .../conversationaggregationquery.go | 49 - .../conversationaggregationview.go | 29 - .../conversationassociation.go | 29 - build/platformclientv2/conversationbasic.go | 42 - ...ncallbackeventtopiccallbackconversation.go | 29 - ...lbackeventtopiccallbackmediaparticipant.go | 186 - ...llbackeventtopicconversationroutingdata.go | 33 - .../conversationcallbackeventtopicdetail.go | 29 - ...ersationcallbackeventtopicdialerpreview.go | 37 - ...conversationcallbackeventtopicerrorbody.go | 53 - ...ersationcallbackeventtopicjourneyaction.go | 21 - ...ationcallbackeventtopicjourneyactionmap.go | 21 - ...rsationcallbackeventtopicjourneycontext.go | 25 - ...sationcallbackeventtopicjourneycustomer.go | 21 - ...allbackeventtopicjourneycustomersession.go | 21 - ...tioncallbackeventtopicphonenumbercolumn.go | 25 - ...nversationcallbackeventtopicscoredagent.go | 21 - ...versationcallbackeventtopicurireference.go | 21 - ...conversationcallbackeventtopicvoicemail.go | 21 - .../conversationcallbackeventtopicwrapup.go | 38 - ...versationcalleventtopiccallconversation.go | 37 - ...ationcalleventtopiccallmediaparticipant.go | 194 - ...oncalleventtopicconversationroutingdata.go | 33 - .../conversationcalleventtopicdetail.go | 29 - .../conversationcalleventtopicerrorbody.go | 53 - .../conversationcalleventtopicfaxstatus.go | 45 - ...conversationcalleventtopicjourneyaction.go | 21 - ...versationcalleventtopicjourneyactionmap.go | 21 - ...onversationcalleventtopicjourneycontext.go | 25 - ...nversationcalleventtopicjourneycustomer.go | 21 - ...ioncalleventtopicjourneycustomersession.go | 21 - .../conversationcalleventtopicscoredagent.go | 21 - .../conversationcalleventtopicurireference.go | 21 - .../conversationcalleventtopicwrapup.go | 38 - build/platformclientv2/conversationchat.go | 94 - ...versationchateventtopicchatconversation.go | 29 - ...ationchateventtopicchatmediaparticipant.go | 158 - ...onchateventtopicconversationroutingdata.go | 33 - .../conversationchateventtopicdetail.go | 29 - .../conversationchateventtopicerrorbody.go | 53 - ...conversationchateventtopicjourneyaction.go | 21 - ...versationchateventtopicjourneyactionmap.go | 21 - ...onversationchateventtopicjourneycontext.go | 25 - ...nversationchateventtopicjourneycustomer.go | 21 - ...ionchateventtopicjourneycustomersession.go | 21 - .../conversationchateventtopicscoredagent.go | 21 - .../conversationchateventtopicurireference.go | 21 - .../conversationchateventtopicwrapup.go | 38 - ...ncobrowseeventtopiccobrowseconversation.go | 29 - ...rowseeventtopiccobrowsemediaparticipant.go | 170 - ...browseeventtopicconversationroutingdata.go | 33 - .../conversationcobrowseeventtopicdetail.go | 29 - ...conversationcobrowseeventtopicerrorbody.go | 53 - ...ersationcobrowseeventtopicjourneyaction.go | 21 - ...ationcobrowseeventtopicjourneyactionmap.go | 21 - ...rsationcobrowseeventtopicjourneycontext.go | 25 - ...sationcobrowseeventtopicjourneycustomer.go | 21 - ...obrowseeventtopicjourneycustomersession.go | 21 - ...nversationcobrowseeventtopicscoredagent.go | 21 - ...versationcobrowseeventtopicurireference.go | 21 - .../conversationcobrowseeventtopicwrapup.go | 38 - .../conversationdeletionprotectionquery.go | 17 - .../conversationdetailqueryclause.go | 21 - .../conversationdetailqueryfilter.go | 25 - .../conversationdetailquerypredicate.go | 37 - ...topicdataavailabilitychangenotification.go | 17 - ...etailsdatalakeavailabilitytopicdatetime.go | 29 - .../conversationdivisionmembership.go | 21 - .../conversationemaileventtopicattachment.go | 37 - ...nemaileventtopicconversationroutingdata.go | 33 - .../conversationemaileventtopicdetail.go | 29 - ...rsationemaileventtopicemailconversation.go | 29 - ...ionemaileventtopicemailmediaparticipant.go | 174 - .../conversationemaileventtopicerrorbody.go | 53 - ...onversationemaileventtopicjourneyaction.go | 21 - ...ersationemaileventtopicjourneyactionmap.go | 21 - ...nversationemaileventtopicjourneycontext.go | 25 - ...versationemaileventtopicjourneycustomer.go | 21 - ...onemaileventtopicjourneycustomersession.go | 21 - .../conversationemaileventtopicscoredagent.go | 21 - ...conversationemaileventtopicurireference.go | 21 - .../conversationemaileventtopicwrapup.go | 38 - .../conversationentitylisting.go | 53 - .../conversationeventtopicaddress.go | 37 - .../conversationeventtopicaftercallwork.go | 26 - .../conversationeventtopicattachment.go | 37 - .../conversationeventtopiccall.go | 122 - .../conversationeventtopiccallback.go | 110 - .../conversationeventtopicchat.go | 82 - .../conversationeventtopiccobrowse.go | 90 - .../conversationeventtopicconversation.go | 33 - ...sationeventtopicconversationroutingdata.go | 33 - .../conversationeventtopicdialerpreview.go | 37 - .../conversationeventtopicdisconnectreason.go | 25 - .../conversationeventtopicemail.go | 102 - .../conversationeventtopicerrordetails.go | 45 - .../conversationeventtopicfaxstatus.go | 45 - .../conversationeventtopicjourneyaction.go | 21 - .../conversationeventtopicjourneyactionmap.go | 21 - .../conversationeventtopicjourneycontext.go | 25 - .../conversationeventtopicjourneycustomer.go | 21 - ...rsationeventtopicjourneycustomersession.go | 21 - .../conversationeventtopicmessage.go | 106 - .../conversationeventtopicmessagedetails.go | 38 - .../conversationeventtopicmessagemedia.go | 33 - .../conversationeventtopicmessagesticker.go | 21 - .../conversationeventtopicparticipant.go | 162 - ...conversationeventtopicphonenumbercolumn.go | 25 - .../conversationeventtopicscoredagent.go | 21 - .../conversationeventtopicscreenshare.go | 74 - .../conversationeventtopicsocialexpression.go | 90 - .../conversationeventtopicurireference.go | 21 - .../conversationeventtopicvideo.go | 86 - .../conversationeventtopicvoicemail.go | 21 - .../conversationeventtopicwrapup.go | 38 - ...essageeventtopicconversationroutingdata.go | 33 - .../conversationmessageeventtopicdetail.go | 29 - .../conversationmessageeventtopicerrorbody.go | 53 - ...versationmessageeventtopicjourneyaction.go | 21 - ...sationmessageeventtopicjourneyactionmap.go | 21 - ...ersationmessageeventtopicjourneycontext.go | 25 - ...rsationmessageeventtopicjourneycustomer.go | 21 - ...messageeventtopicjourneycustomersession.go | 21 - ...ionmessageeventtopicmessageconversation.go | 29 - ...ersationmessageeventtopicmessagedetails.go | 38 - ...nversationmessageeventtopicmessagemedia.go | 33 - ...essageeventtopicmessagemediaparticipant.go | 166 - ...ersationmessageeventtopicmessagesticker.go | 21 - ...onversationmessageeventtopicscoredagent.go | 21 - ...nversationmessageeventtopicurireference.go | 21 - .../conversationmessageeventtopicwrapup.go | 38 - build/platformclientv2/conversationmetrics.go | 25 - .../conversationproperties.go | 57 - build/platformclientv2/conversationquery.go | 57 - .../platformclientv2/conversationreference.go | 21 - .../conversationroutingdata.go | 33 - build/platformclientv2/conversationsapi.go | 10673 --------------- ...nshareeventtopicconversationroutingdata.go | 33 - ...conversationscreenshareeventtopicdetail.go | 29 - ...versationscreenshareeventtopicerrorbody.go | 53 - ...ationscreenshareeventtopicjourneyaction.go | 21 - ...onscreenshareeventtopicjourneyactionmap.go | 21 - ...tionscreenshareeventtopicjourneycontext.go | 25 - ...ionscreenshareeventtopicjourneycustomer.go | 21 - ...enshareeventtopicjourneycustomersession.go | 21 - ...rsationscreenshareeventtopicscoredagent.go | 21 - ...nshareeventtopicscreenshareconversation.go | 29 - ...reeventtopicscreensharemediaparticipant.go | 162 - ...sationscreenshareeventtopicurireference.go | 21 - ...conversationscreenshareeventtopicwrapup.go | 38 - ...essioneventtopicconversationroutingdata.go | 33 - ...rsationsocialexpressioneventtopicdetail.go | 29 - ...tionsocialexpressioneventtopicerrorbody.go | 53 - ...socialexpressioneventtopicjourneyaction.go | 21 - ...ialexpressioneventtopicjourneyactionmap.go | 21 - ...ocialexpressioneventtopicjourneycontext.go | 25 - ...cialexpressioneventtopicjourneycustomer.go | 21 - ...ressioneventtopicjourneycustomersession.go | 21 - ...onsocialexpressioneventtopicscoredagent.go | 21 - ...lexpressioneventtopicsocialconversation.go | 29 - ...ressioneventtopicsocialmediaparticipant.go | 166 - ...nsocialexpressioneventtopicurireference.go | 21 - ...rsationsocialexpressioneventtopicwrapup.go | 38 - build/platformclientv2/conversationuser.go | 17 - ...nvideoeventtopicconversationroutingdata.go | 33 - .../conversationvideoeventtopicdetail.go | 29 - .../conversationvideoeventtopicerrorbody.go | 53 - ...onversationvideoeventtopicjourneyaction.go | 21 - ...ersationvideoeventtopicjourneyactionmap.go | 21 - ...nversationvideoeventtopicjourneycontext.go | 25 - ...versationvideoeventtopicjourneycustomer.go | 21 - ...onvideoeventtopicjourneycustomersession.go | 21 - .../conversationvideoeventtopicscoredagent.go | 21 - ...conversationvideoeventtopicurireference.go | 21 - ...rsationvideoeventtopicvideoconversation.go | 29 - ...ionvideoeventtopicvideomediaparticipant.go | 174 - .../conversationvideoeventtopicwrapup.go | 38 - .../copyattachmentsrequest.go | 21 - .../platformclientv2/copybuforecastrequest.go | 22 - .../platformclientv2/copyvoicemailmessage.go | 25 - build/platformclientv2/copyworkplan.go | 17 - .../copyworkplanrotationrequest.go | 17 - build/platformclientv2/coretype.go | 58 - build/platformclientv2/coretypelisting.go | 25 - build/platformclientv2/coversheet.go | 21 - .../createactivitycoderequest.go | 37 - .../createadmintimeoffrequest.go | 42 - .../createagenttimeoffrequest.go | 34 - .../createbusinessunitrequest.go | 25 - .../createbusinessunitsettings.go | 25 - .../platformclientv2/createcallbackcommand.go | 50 - .../createcallbackonconversationcommand.go | 50 - .../createcallbackresponse.go | 21 - build/platformclientv2/createcallrequest.go | 61 - build/platformclientv2/createcallresponse.go | 25 - .../createcoachingappointmentrequest.go | 46 - build/platformclientv2/createemailrequest.go | 73 - .../createintegrationrequest.go | 29 - .../createmanagementunitapirequest.go | 37 - .../createmanagementunitsettingsrequest.go | 33 - ...ateoutboundmessagingconversationrequest.go | 37 - .../createplanninggrouprequest.go | 25 - build/platformclientv2/createqueuerequest.go | 118 - build/platformclientv2/createsecuresession.go | 29 - .../createservicegoaltemplate.go | 29 - build/platformclientv2/createsharerequest.go | 33 - .../createsharerequestmember.go | 21 - build/platformclientv2/createshareresponse.go | 57 - build/platformclientv2/createuser.go | 45 - .../createwebchatconversationrequest.go | 37 - .../createwebchatconversationresponse.go | 29 - .../createwebchatmessagerequest.go | 21 - .../platformclientv2/createwebchatrequest.go | 41 - build/platformclientv2/createworkplan.go | 81 - .../createworkplanactivity.go | 57 - build/platformclientv2/createworkplanshift.go | 85 - build/platformclientv2/credential.go | 33 - build/platformclientv2/credentialinfo.go | 38 - .../platformclientv2/credentialinfolisting.go | 53 - .../credentialspecification.go | 25 - build/platformclientv2/credentialtype.go | 33 - .../platformclientv2/credentialtypelisting.go | 53 - build/platformclientv2/criteria.go | 29 - .../crossplatformcallmediapolicy.go | 21 - .../crossplatformchatmediapolicy.go | 21 - .../crossplatformemailmediapolicy.go | 21 - .../crossplatformmediapolicies.go | 29 - .../crossplatformmessagemediapolicy.go | 21 - build/platformclientv2/crossplatformpolicy.go | 62 - .../crossplatformpolicyactions.go | 53 - .../crossplatformpolicycreate.go | 62 - .../ctabuttonstyleproperties.go | 33 - .../currentuserschedulerequestbody.go | 26 - .../platformclientv2/cursorcontactlisting.go | 29 - build/platformclientv2/cursornotelisting.go | 29 - .../cursororganizationlisting.go | 29 - .../cursorrelationshiplisting.go | 29 - build/platformclientv2/cursors.go | 21 - .../customerinteractioncenter.go | 45 - .../dataactionconditionpredicate.go | 13 - .../dataavailabilityresponse.go | 18 - build/platformclientv2/dataextensionsapi.go | 227 - build/platformclientv2/dataschema.go | 50 - build/platformclientv2/dataschemalisting.go | 25 - build/platformclientv2/datatable.go | 33 - build/platformclientv2/datatableexportjob.go | 54 - build/platformclientv2/datatableimportjob.go | 66 - .../datatablerowentitylisting.go | 53 - .../datatablesdomainentitylisting.go | 53 - build/platformclientv2/daterange.go | 21 - .../daterangewithoptionalend.go | 22 - build/platformclientv2/defaultgreetinglist.go | 54 - .../deletableuserreference.go | 25 - build/platformclientv2/deleteretention.go | 17 - build/platformclientv2/dependency.go | 45 - build/platformclientv2/dependencyobject.go | 53 - .../dependencyobjectentitylisting.go | 53 - build/platformclientv2/dependencystatus.go | 54 - build/platformclientv2/dependencytype.go | 29 - .../dependencytypeentitylisting.go | 53 - build/platformclientv2/destination.go | 29 - build/platformclientv2/detail.go | 29 - build/platformclientv2/detecteddialogact.go | 21 - build/platformclientv2/detectedintent.go | 25 - build/platformclientv2/detectednamedentity.go | 29 - .../detectednamedentityvalue.go | 21 - build/platformclientv2/developmentactivity.go | 62 - .../developmentactivityaggregateparam.go | 29 - ...mentactivityaggregatequeryrequestclause.go | 21 - ...mentactivityaggregatequeryrequestfilter.go | 21 - ...tactivityaggregatequeryrequestpredicate.go | 21 - ...pmentactivityaggregatequeryresponsedata.go | 21 - ...tivityaggregatequeryresponsegroupeddata.go | 21 - ...entactivityaggregatequeryresponsemetric.go | 21 - ...ctivityaggregatequeryresponsestatistics.go | 17 - .../developmentactivityaggregateresponse.go | 17 - .../developmentactivitylisting.go | 53 - build/platformclientv2/dialeraction.go | 29 - ...rattemptlimitsconfigchangeattemptlimits.go | 62 - ...lerattemptlimitsconfigchangerecallentry.go | 25 - build/platformclientv2/dialerauditrequest.go | 29 - ...callabletimesetconfigchangecallabletime.go | 25 - ...labletimesetconfigchangecallabletimeset.go | 42 - ...alercallabletimesetconfigchangetimeslot.go | 29 - .../dialercampaignconfigchangecampaign.go | 150 - .../dialercampaignconfigchangecontactsort.go | 29 - .../dialercampaignconfigchangephonecolumn.go | 25 - ...alercampaignconfigchangeresterrordetail.go | 25 - .../dialercampaignconfigchangeurireference.go | 21 - ...ercampaignprogresseventcampaignprogress.go | 37 - ...dialercampaignprogresseventurireference.go | 21 - ...lercampaignruleconfigchangecampaignrule.go | 58 - ...paignruleconfigchangecampaignruleaction.go | 33 - ...econfigchangecampaignruleactionentities.go | 29 - ...gnruleconfigchangecampaignrulecondition.go | 29 - ...ignruleconfigchangecampaignruleentities.go | 21 - ...lercampaignruleconfigchangeurireference.go | 21 - ...ignscheduleconfigchangecampaignschedule.go | 50 - ...ignscheduleconfigchangescheduleinterval.go | 25 - ...ampaignscheduleconfigchangeurireference.go | 21 - build/platformclientv2/dialercontact.go | 49 - build/platformclientv2/dialercontactid.go | 21 - ...ialercontactlistconfigchangecontactlist.go | 78 - ...istconfigchangecontactphonenumbercolumn.go | 29 - ...alercontactlistconfigchangeimportstatus.go | 37 - ...alercontactlistconfigchangeurireference.go | 21 - ...listfilterconfigchangecontactlistfilter.go | 54 - ...ntactlistfilterconfigchangefilterclause.go | 25 - ...ctlistfilterconfigchangefilterpredicate.go | 41 - ...ialercontactlistfilterconfigchangerange.go | 37 - ...ntactlistfilterconfigchangeurireference.go | 21 - .../dialerdnclistconfigchangednclist.go | 66 - .../dialerdnclistconfigchangeimportstatus.go | 37 - .../dialerdnclistconfigchangeurireference.go | 21 - .../dialerevententitylisting.go | 53 - ...utboundsettingsconfigchangeatzmtimeslot.go | 21 - ...ngsconfigchangeatzmtimeslotwithtimezone.go | 25 - ...gchangeautomatictimezonemappingsettings.go | 17 - ...boundsettingsconfigchangecallablewindow.go | 21 - ...undsettingsconfigchangeoutboundsettings.go | 54 - build/platformclientv2/dialerpreview.go | 33 - .../dialerresponsesetconfigchangereaction.go | 29 - ...ialerresponsesetconfigchangeresponseset.go | 46 - build/platformclientv2/dialerrule.go | 37 - .../dialerrulesetconfigchangeaction.go | 33 - .../dialerrulesetconfigchangecondition.go | 81 - ...gecontactcolumntodataactionfieldmapping.go | 25 - ...onfigchangedataactionconditionpredicate.go | 37 - .../dialerrulesetconfigchangerule.go | 41 - .../dialerrulesetconfigchangeruleset.go | 50 - .../dialerrulesetconfigchangeurireference.go | 21 - ...lersequenceconfigchangecampaignsequence.go | 58 - .../dialersequenceconfigchangeurireference.go | 21 - ...ncescheduleconfigchangescheduleinterval.go | 25 - ...ncescheduleconfigchangesequenceschedule.go | 50 - ...equencescheduleconfigchangeurireference.go | 21 - ...odemappingconfigchangewrapupcodemapping.go | 42 - build/platformclientv2/dialogflowagent.go | 41 - .../dialogflowagentsummary.go | 33 - .../dialogflowagentsummaryentitylisting.go | 53 - build/platformclientv2/dialogflowintent.go | 21 - build/platformclientv2/dialogflowparameter.go | 21 - build/platformclientv2/dialogflowproject.go | 21 - build/platformclientv2/did.go | 78 - build/platformclientv2/didentitylisting.go | 53 - build/platformclientv2/didnumber.go | 45 - .../didnumberentitylisting.go | 53 - build/platformclientv2/didpool.go | 78 - .../platformclientv2/didpoolentitylisting.go | 53 - build/platformclientv2/digitlength.go | 21 - build/platformclientv2/digits.go | 17 - .../directoryuserdeviceslisting.go | 53 - build/platformclientv2/disconnectreason.go | 25 - .../divspermittedentitylisting.go | 57 - build/platformclientv2/dnclist.go | 66 - build/platformclientv2/dnclistcreate.go | 66 - build/platformclientv2/dnclistdivisionview.go | 37 - .../dnclistdivisionviewlisting.go | 53 - .../dnclistdownloadreadyexporturi.go | 25 - .../platformclientv2/dnclistentitylisting.go | 53 - .../dnclistimportstatusimportstatus.go | 37 - build/platformclientv2/document.go | 138 - build/platformclientv2/documentationresult.go | 94 - .../documentationsearchcriteria.go | 49 - .../documentationsearchrequest.go | 37 - .../documentationsearchresponse.go | 49 - build/platformclientv2/documentattribute.go | 21 - build/platformclientv2/documentaudit.go | 78 - .../documentauditentitylisting.go | 53 - .../platformclientv2/documentcategoryinput.go | 17 - .../platformclientv2/documententitylisting.go | 53 - build/platformclientv2/documentfaq.go | 25 - build/platformclientv2/documentlisting.go | 29 - build/platformclientv2/documentreference.go | 21 - build/platformclientv2/documentthumbnail.go | 29 - build/platformclientv2/documentupdate.go | 49 - build/platformclientv2/documentupload.go | 29 - build/platformclientv2/domaincapabilities.go | 37 - .../domaincertificateauthority.go | 78 - .../domainedgesoftwareupdatedto.go | 54 - .../domainedgesoftwareversiondto.go | 46 - ...mainedgesoftwareversiondtoentitylisting.go | 53 - build/platformclientv2/domainentity.go | 25 - build/platformclientv2/domainentitylisting.go | 53 - .../domainentitylistingevaluationform.go | 53 - .../domainentitylistingqueryresult.go | 53 - .../domainentitylistingsurveyform.go | 53 - build/platformclientv2/domainentityref.go | 25 - .../domainlogicalinterface.go | 178 - .../platformclientv2/domainnetworkaddress.go | 29 - .../domainnetworkcommandresponse.go | 29 - build/platformclientv2/domainnetworkroute.go | 33 - .../domainorganizationproduct.go | 17 - .../domainorganizationrole.go | 61 - .../domainorganizationrolecreate.go | 61 - .../domainorganizationroleupdate.go | 61 - .../domainorgroledifference.go | 33 - build/platformclientv2/domainpermission.go | 37 - .../domainpermissioncollection.go | 33 - .../domainpermissionpolicy.go | 45 - .../domainphysicalcapabilities.go | 21 - .../domainphysicalinterface.go | 82 - .../domainresourceconditionnode.go | 33 - .../domainresourceconditionvalue.go | 29 - build/platformclientv2/domainrole.go | 21 - .../platformclientv2/domainschemareference.go | 62 - build/platformclientv2/downloadresponse.go | 25 - .../platformclientv2/draftvalidationresult.go | 21 - build/platformclientv2/durationcondition.go | 25 - build/platformclientv2/edge.go | 178 - .../platformclientv2/edgeautoupdateconfig.go | 30 - build/platformclientv2/edgechangetopicedge.go | 21 - build/platformclientv2/edgeentitylisting.go | 53 - build/platformclientv2/edgegroup.go | 78 - .../edgegroupentitylisting.go | 53 - build/platformclientv2/edgeinterface.go | 45 - build/platformclientv2/edgeline.go | 94 - .../platformclientv2/edgelineentitylisting.go | 53 - ...changetopicdomainlogicalinterfacechange.go | 21 - ...gelogicalinterfaceschangetopicerrorinfo.go | 29 - build/platformclientv2/edgelogsjob.go | 66 - build/platformclientv2/edgelogsjobfile.go | 86 - build/platformclientv2/edgelogsjobrequest.go | 25 - build/platformclientv2/edgelogsjobresponse.go | 62 - .../edgelogsjobuploadrequest.go | 17 - build/platformclientv2/edgemetrics.go | 46 - build/platformclientv2/edgemetricsdisk.go | 25 - build/platformclientv2/edgemetricsmemory.go | 25 - build/platformclientv2/edgemetricsnetwork.go | 33 - .../platformclientv2/edgemetricsprocessor.go | 33 - .../platformclientv2/edgemetricssubsystem.go | 25 - .../edgemetricstopicedgemetricdisk.go | 25 - .../edgemetricstopicedgemetricmemory.go | 25 - .../edgemetricstopicedgemetricnetworks.go | 33 - .../edgemetricstopicedgemetricprocessor.go | 33 - .../edgemetricstopicedgemetrics.go | 45 - .../edgemetricstopicedgemetricsubsystem.go | 25 - ...dgemetricstopicedgemetricsubsystemmedia.go | 21 - .../edgemetricstopiclocaldate.go | 29 - .../edgemetricstopiclocaldatetime.go | 21 - .../edgemetricstopiclocaltime.go | 29 - .../edgemetricstopicoffsetdatetime.go | 21 - .../edgemetricstopicurireference.go | 21 - .../edgemetricstopiczoneoffset.go | 17 - .../platformclientv2/edgenetworkdiagnostic.go | 21 - .../edgenetworkdiagnosticrequest.go | 17 - .../edgenetworkdiagnosticresponse.go | 21 - .../platformclientv2/edgerebootparameters.go | 17 - .../edgeservicestaterequest.go | 21 - ...wareupdatetopicdomainedgesoftwareupdate.go | 34 - build/platformclientv2/edgetrunkbase.go | 74 - .../edgeversioninformation.go | 17 - build/platformclientv2/edgeversionreport.go | 21 - build/platformclientv2/education.go | 34 - .../effectiveconfiguration.go | 33 - build/platformclientv2/email.go | 110 - build/platformclientv2/emailaddress.go | 21 - build/platformclientv2/emailattachment.go | 33 - build/platformclientv2/emailconversation.go | 33 - .../emailconversationentitylisting.go | 53 - .../platformclientv2/emailmediaparticipant.go | 170 - build/platformclientv2/emailmediapolicy.go | 21 - .../emailmediapolicyconditions.go | 37 - build/platformclientv2/emailmessage.go | 66 - build/platformclientv2/emailmessagelisting.go | 53 - build/platformclientv2/emailsetup.go | 17 - build/platformclientv2/embeddedintegration.go | 21 - build/platformclientv2/emergencycallflow.go | 21 - build/platformclientv2/emergencygroup.go | 70 - .../platformclientv2/emergencygrouplisting.go | 53 - build/platformclientv2/employerinfo.go | 29 - build/platformclientv2/empty.go | 13 - build/platformclientv2/encryptionkey.go | 42 - .../encryptionkeyentitylisting.go | 53 - build/platformclientv2/endpoint.go | 86 - build/platformclientv2/entity.go | 17 - build/platformclientv2/entitytypecriteria.go | 33 - build/platformclientv2/entry.go | 21 - build/platformclientv2/errorbody.go | 53 - build/platformclientv2/errordetails.go | 45 - build/platformclientv2/errorinfo.go | 21 - .../estimatedwaittimepredictions.go | 17 - build/platformclientv2/evaluation.go | 110 - .../evaluationaggregatedatacontainer.go | 21 - .../evaluationaggregatequeryclause.go | 21 - .../evaluationaggregatequeryfilter.go | 25 - .../evaluationaggregatequerypredicate.go | 33 - .../evaluationaggregatequeryresponse.go | 17 - .../evaluationaggregationquery.go | 49 - .../evaluationaggregationview.go | 29 - .../platformclientv2/evaluationassignment.go | 21 - .../evaluationdetailqueryclause.go | 21 - .../evaluationdetailqueryfilter.go | 25 - .../evaluationdetailquerypredicate.go | 37 - .../evaluationentitylisting.go | 53 - build/platformclientv2/evaluationform.go | 46 - .../evaluationformandscoringset.go | 21 - .../evaluationformentitylisting.go | 53 - ...ationqualityv2topicevaluationscoringset.go | 21 - .../evaluationqualityv2topicevaluationv2.go | 98 - .../evaluationqualityv2topicuser.go | 21 - build/platformclientv2/evaluationquestion.go | 53 - .../evaluationquestiongroup.go | 53 - .../evaluationquestiongroupscore.go | 73 - .../evaluationquestionscore.go | 37 - .../platformclientv2/evaluationscoringset.go | 41 - build/platformclientv2/evaluatoractivity.go | 57 - .../evaluatoractivityentitylisting.go | 53 - build/platformclientv2/eventcondition.go | 37 - build/platformclientv2/evententity.go | 21 - build/platformclientv2/eventlog.go | 54 - build/platformclientv2/eventmessage.go | 37 - .../executerecordingjobsquery.go | 17 - build/platformclientv2/expansioncriterium.go | 21 - build/platformclientv2/exportscriptrequest.go | 21 - .../platformclientv2/exportscriptresponse.go | 17 - build/platformclientv2/exporturi.go | 22 - build/platformclientv2/extension.go | 78 - .../extensionentitylisting.go | 53 - build/platformclientv2/extensionpool.go | 70 - .../extensionpoolentitylisting.go | 53 - build/platformclientv2/externalcontact.go | 122 - build/platformclientv2/externalcontactsapi.go | 3933 ------ build/platformclientv2/externaldatasource.go | 21 - .../platformclientv2/externalorganization.go | 102 - .../externalorganizationlisting.go | 53 - .../externalorganizationtrustorlink.go | 30 - .../facebookappcredentials.go | 17 - build/platformclientv2/facebookid.go | 21 - build/platformclientv2/facebookintegration.go | 70 - .../facebookintegrationentitylisting.go | 53 - .../facebookintegrationrequest.go | 45 - .../facebookintegrationupdaterequest.go | 33 - build/platformclientv2/facebookscopedid.go | 17 - build/platformclientv2/facet.go | 21 - build/platformclientv2/facetentry.go | 45 - build/platformclientv2/facetinfo.go | 21 - build/platformclientv2/facetkeyattribute.go | 25 - build/platformclientv2/facetstatistics.go | 42 - build/platformclientv2/facetterm.go | 38 - build/platformclientv2/failedobject.go | 29 - build/platformclientv2/faxapi.go | 465 - build/platformclientv2/faxdocument.go | 86 - .../faxdocumententitylisting.go | 53 - build/platformclientv2/faxsendrequest.go | 49 - build/platformclientv2/faxsendresponse.go | 33 - build/platformclientv2/faxstatus.go | 45 - build/platformclientv2/faxsummary.go | 25 - build/platformclientv2/faxtopicfaxdatav2.go | 82 - build/platformclientv2/faxtopiclockdata.go | 26 - build/platformclientv2/faxtopicuserdata.go | 21 - .../platformclientv2/faxtopicworkspacedata.go | 17 - build/platformclientv2/featurestate.go | 17 - build/platformclientv2/fieldconfig.go | 45 - build/platformclientv2/fieldconfigs.go | 29 - build/platformclientv2/fieldlist.go | 49 - build/platformclientv2/filter.go | 29 - .../platformclientv2/filterpreviewresponse.go | 25 - build/platformclientv2/flow.go | 97 - .../flowaggregatedatacontainer.go | 21 - .../flowaggregatequeryclause.go | 21 - .../flowaggregatequeryfilter.go | 25 - .../flowaggregatequerypredicate.go | 33 - .../flowaggregatequeryresponse.go | 17 - .../platformclientv2/flowaggregationquery.go | 49 - build/platformclientv2/flowaggregationview.go | 29 - build/platformclientv2/flowdiagnosticinfo.go | 17 - build/platformclientv2/flowdivisionview.go | 49 - .../flowdivisionviewentitylisting.go | 53 - build/platformclientv2/flowentitylisting.go | 53 - .../flowexecutionlaunchrequest.go | 29 - .../flowexecutionlaunchresponse.go | 29 - build/platformclientv2/flowmilestone.go | 29 - .../platformclientv2/flowmilestonelisting.go | 53 - .../flowobservationdatacontainer.go | 21 - .../platformclientv2/flowobservationquery.go | 25 - .../flowobservationqueryclause.go | 21 - .../flowobservationqueryfilter.go | 25 - .../flowobservationquerypredicate.go | 33 - .../flowobservationqueryresponse.go | 17 - build/platformclientv2/flowoutcome.go | 33 - build/platformclientv2/flowoutcomelisting.go | 53 - .../platformclientv2/flowruntimeexecution.go | 58 - build/platformclientv2/flowsapi.go | 174 - build/platformclientv2/flowversion.go | 85 - .../flowversionentitylisting.go | 53 - .../forecastabandonrateresponse.go | 17 - .../forecastaveragespeedofanswerresponse.go | 17 - .../forecastplanninggroupdata.go | 25 - .../forecastplanninggroupresponse.go | 29 - .../forecastplanninggroupsresponse.go | 17 - .../forecastservicegoaltemplateresponse.go | 25 - .../forecastservicelevelresponse.go | 21 - .../forecastsourcedaypointer.go | 33 - .../freeseatingconfiguration.go | 21 - build/platformclientv2/gdprjourneycustomer.go | 21 - build/platformclientv2/gdprrequest.go | 54 - .../gdprrequestentitylisting.go | 53 - build/platformclientv2/gdprsubject.go | 49 - .../gdprsubjectentitylisting.go | 53 - .../generaldataprotectionregulationapi.go | 374 - .../generatebuforecastrequest.go | 21 - build/platformclientv2/genericsaml.go | 61 - build/platformclientv2/genesysbotconnector.go | 17 - build/platformclientv2/geolocation.go | 57 - build/platformclientv2/geolocationapi.go | 324 - .../geolocationeventgeolocation.go | 33 - build/platformclientv2/geolocationsettings.go | 33 - .../gkndocumentationresult.go | 29 - .../gkndocumentationsearchcriteria.go | 49 - .../gkndocumentationsearchrequest.go | 37 - .../gkndocumentationsearchresponse.go | 49 - .../googledialogflowcustomsettings.go | 29 - build/platformclientv2/greeting.go | 62 - build/platformclientv2/greetingaudiofile.go | 25 - build/platformclientv2/greetinglisting.go | 53 - build/platformclientv2/greetingmediainfo.go | 25 - build/platformclientv2/greetingowner.go | 25 - build/platformclientv2/greetingsapi.go | 1257 -- build/platformclientv2/group.go | 70 - build/platformclientv2/groupcontact.go | 33 - build/platformclientv2/groupcreate.go | 70 - build/platformclientv2/groupentitylisting.go | 53 - .../groupgreetingeventgreeting.go | 41 - .../groupgreetingeventgreetingaudiofile.go | 21 - .../groupgreetingeventgreetingowner.go | 17 - build/platformclientv2/groupmembersupdate.go | 21 - build/platformclientv2/groupprofile.go | 38 - .../groupprofileentitylisting.go | 53 - build/platformclientv2/groupsapi.go | 1231 -- build/platformclientv2/groupsearchcriteria.go | 49 - build/platformclientv2/groupsearchrequest.go | 37 - .../platformclientv2/groupssearchresponse.go | 49 - build/platformclientv2/groupupdate.go | 57 - build/platformclientv2/gsuite.go | 49 - build/platformclientv2/guestmemberinfo.go | 41 - build/platformclientv2/headcountforecast.go | 21 - build/platformclientv2/headcountinterval.go | 22 - build/platformclientv2/helplink.go | 25 - .../historicaladherenceactuals.go | 25 - .../historicaladherencedaymetrics.go | 57 - .../historicaladherenceexceptioninfo.go | 49 - .../historicaladherencequeryresult.go | 50 - build/platformclientv2/historyentry.go | 42 - build/platformclientv2/historylisting.go | 94 - build/platformclientv2/homerrecord.go | 218 - build/platformclientv2/identitynow.go | 49 - build/platformclientv2/identityproviderapi.go | 2262 ---- .../ignoredactivitycategories.go | 17 - .../importscriptstatusresponse.go | 25 - build/platformclientv2/importstatus.go | 33 - build/platformclientv2/inbounddomain.go | 41 - .../inbounddomainentitylisting.go | 53 - .../inbounddomainpatchrequest.go | 21 - .../platformclientv2/inboundmessagerequest.go | 61 - build/platformclientv2/inboundroute.go | 69 - .../inboundrouteentitylisting.go | 53 - .../initiatescreenrecording.go | 25 - build/platformclientv2/integration.go | 49 - build/platformclientv2/integrationaction.go | 21 - .../integrationactionfields.go | 21 - .../integrationconfiguration.go | 45 - .../integrationconfigurationinfo.go | 17 - .../integrationentitylisting.go | 53 - build/platformclientv2/integrationevent.go | 58 - .../integrationevententitylisting.go | 53 - build/platformclientv2/integrationexport.go | 21 - build/platformclientv2/integrationsapi.go | 4840 ------- .../platformclientv2/integrationstatusinfo.go | 30 - build/platformclientv2/integrationtype.go | 109 - .../integrationtypeentitylisting.go | 53 - build/platformclientv2/intentdefinition.go | 25 - build/platformclientv2/intentfeedback.go | 29 - .../platformclientv2/interactionstatsalert.go | 82 - .../interactionstatsalertcontainer.go | 53 - .../platformclientv2/interactionstatsrule.go | 69 - .../interactionstatsrulecontainer.go | 53 - .../intradayperformancepredictiondata.go | 25 - .../intradayplanninggrouprequest.go | 30 - .../ipaddressauthentication.go | 17 - build/platformclientv2/ipaddressrange.go | 25 - .../platformclientv2/ipaddressrangelisting.go | 17 - build/platformclientv2/items.go | 21 - .../platformclientv2/itemvalidationlimits.go | 21 - build/platformclientv2/ivr.go | 82 - build/platformclientv2/ivrentitylisting.go | 53 - build/platformclientv2/journey.go | 17 - build/platformclientv2/journeyaction.go | 21 - build/platformclientv2/journeyactionmap.go | 21 - .../journeyaggregatedatacontainer.go | 21 - .../journeyaggregatequeryclause.go | 21 - .../journeyaggregatequeryfilter.go | 25 - .../journeyaggregatequerypredicate.go | 33 - .../journeyaggregatequeryresponse.go | 17 - .../journeyaggregationquery.go | 49 - .../journeyaggregationview.go | 29 - build/platformclientv2/journeyapi.go | 1939 --- build/platformclientv2/journeycontext.go | 25 - build/platformclientv2/journeycustomer.go | 21 - .../journeycustomersession.go | 21 - build/platformclientv2/journeypattern.go | 33 - build/platformclientv2/journeysegment.go | 70 - .../platformclientv2/journeysurveyquestion.go | 33 - build/platformclientv2/jsonnode.go | 97 - .../jsonnodesearchresponse.go | 53 - build/platformclientv2/jsonschemadocument.go | 45 - build/platformclientv2/jsonsearchresponse.go | 41 - build/platformclientv2/keyrotationschedule.go | 29 - build/platformclientv2/keyvalue.go | 21 - build/platformclientv2/keyword.go | 65 - build/platformclientv2/keywordset.go | 49 - .../keywordsetentitylisting.go | 53 - ...laxonheartbeatalertstopicheartbeatalert.go | 54 - ...xonheartbeatalertstopicnotificationuser.go | 21 - .../klaxonheartbeatrulestopicheartbeatrule.go | 49 - ...axonheartbeatrulestopicnotificationuser.go | 21 - ...ionstatsalertstopicinteractionstatalert.go | 78 - ...ractionstatsalertstopicnotificationuser.go | 21 - ...ctionstatsrulestopicinteractionstatrule.go | 69 - ...eractionstatsrulestopicnotificationuser.go | 21 - build/platformclientv2/knowledgeapi.go | 1926 --- build/platformclientv2/knowledgebase.go | 50 - .../platformclientv2/knowledgebaselisting.go | 29 - build/platformclientv2/knowledgecategory.go | 46 - .../knowledgecategoryrequest.go | 33 - build/platformclientv2/knowledgedocument.go | 58 - .../knowledgedocumentbulkrequest.go | 33 - .../knowledgedocumentrequest.go | 29 - .../knowledgeextendedcategory.go | 54 - .../knowledgesearchdocument.go | 62 - .../knowledgesearchrequest.go | 37 - .../knowledgesearchresponse.go | 37 - build/platformclientv2/knowledgetraining.go | 54 - .../platformclientv2/languageentitylisting.go | 53 - build/platformclientv2/languageoverride.go | 25 - build/platformclientv2/languagereference.go | 21 - build/platformclientv2/languagesapi.go | 782 -- .../languageunderstandingapi.go | 1570 --- build/platformclientv2/lexbot.go | 29 - build/platformclientv2/lexbotalias.go | 49 - .../lexbotaliasentitylisting.go | 53 - build/platformclientv2/lexbotentitylisting.go | 53 - build/platformclientv2/lexintent.go | 29 - build/platformclientv2/lexslot.go | 29 - build/platformclientv2/library.go | 42 - .../platformclientv2/libraryentitylisting.go | 53 - build/platformclientv2/licenseapi.go | 658 - .../licenseassignmentrequest.go | 25 - .../licensebatchassignmentrequest.go | 17 - build/platformclientv2/licensedefinition.go | 37 - build/platformclientv2/licenseorgtoggle.go | 21 - build/platformclientv2/licenseupdatestatus.go | 25 - build/platformclientv2/licenseuser.go | 25 - build/platformclientv2/line.go | 98 - build/platformclientv2/linebase.go | 70 - .../platformclientv2/linebaseentitylisting.go | 53 - build/platformclientv2/lineentitylisting.go | 53 - build/platformclientv2/lineid.go | 21 - build/platformclientv2/lineintegration.go | 70 - .../lineintegrationentitylisting.go | 53 - .../lineintegrationrequest.go | 41 - build/platformclientv2/linestatus.go | 34 - build/platformclientv2/lineuserid.go | 17 - build/platformclientv2/listitemcomponent.go | 41 - build/platformclientv2/listwrapperinterval.go | 17 - .../listwrappershiftstartvariance.go | 17 - .../localencryptionconfiguration.go | 37 - .../localencryptionconfigurationlisting.go | 25 - .../localencryptionkeyrequest.go | 25 - build/platformclientv2/location.go | 33 - build/platformclientv2/locationaddress.go | 41 - .../locationaddressverificationdetails.go | 30 - .../locationcreatedefinition.go | 45 - build/platformclientv2/locationdefinition.go | 77 - .../locationemergencynumber.go | 25 - .../platformclientv2/locationentitylisting.go | 53 - build/platformclientv2/locationimage.go | 21 - build/platformclientv2/locationsapi.go | 676 - .../locationsearchcriteria.go | 49 - .../platformclientv2/locationsearchrequest.go | 41 - .../locationssearchresponse.go | 49 - .../locationupdatedefinition.go | 45 - build/platformclientv2/lockinfo.go | 30 - .../logcaptureuserconfiguration.go | 26 - .../logicalinterfaceentitylisting.go | 53 - build/platformclientv2/mailfromresult.go | 25 - build/platformclientv2/managementunit.go | 58 - .../platformclientv2/managementunitlisting.go | 53 - .../managementunitreference.go | 21 - .../managementunitsettingsrequest.go | 37 - .../managementunitsettingsresponse.go | 37 - build/platformclientv2/manager.go | 21 - .../matchshifttraderequest.go | 25 - .../matchshifttraderesponse.go | 25 - build/platformclientv2/maxlength.go | 21 - build/platformclientv2/maxparticipants.go | 17 - .../mediaendpointstatdetailqueryclause.go | 21 - .../mediaendpointstatdetailqueryfilter.go | 25 - .../mediaendpointstatdetailquerypredicate.go | 33 - .../mediaparticipantrequest.go | 41 - build/platformclientv2/mediapolicies.go | 29 - build/platformclientv2/mediaresult.go | 21 - build/platformclientv2/mediasetting.go | 21 - build/platformclientv2/mediasummary.go | 21 - build/platformclientv2/mediasummarydetail.go | 21 - build/platformclientv2/mediatranscription.go | 25 - build/platformclientv2/mediatype.go | 17 - build/platformclientv2/mediatypeaccess.go | 21 - build/platformclientv2/mediatypes.go | 17 - build/platformclientv2/mediautilization.go | 25 - build/platformclientv2/memberentity.go | 17 - build/platformclientv2/message.go | 114 - build/platformclientv2/messagecontent.go | 53 - build/platformclientv2/messageconversation.go | 33 - .../messageconversationentitylisting.go | 53 - build/platformclientv2/messagedata.go | 70 - build/platformclientv2/messagedetails.go | 42 - build/platformclientv2/messageevaluation.go | 30 - build/platformclientv2/messageinfo.go | 29 - build/platformclientv2/messagemedia.go | 33 - .../messagemediaattachment.go | 33 - build/platformclientv2/messagemediadata.go | 45 - .../messagemediaparticipant.go | 170 - build/platformclientv2/messagemediapolicy.go | 21 - .../messagemediapolicyconditions.go | 37 - build/platformclientv2/messagesticker.go | 21 - .../messagestickerattachment.go | 21 - build/platformclientv2/messagingcampaign.go | 78 - .../messagingcampaigndivisionview.go | 29 - ...sagingcampaigndivisionviewentitylisting.go | 53 - .../messagingcampaignentitylisting.go | 53 - .../platformclientv2/messagingintegration.go | 58 - .../messagingintegrationentitylisting.go | 53 - build/platformclientv2/messagingrecipient.go | 37 - build/platformclientv2/messagingsticker.go | 53 - .../messagingstickerentitylisting.go | 53 - build/platformclientv2/messagingtemplate.go | 17 - .../messagingtemplaterequest.go | 21 - build/platformclientv2/metabase.go | 66 - build/platformclientv2/metadata.go | 25 - .../meteredassignmentbyagent.go | 37 - .../meteredevaluationassignment.go | 37 - build/platformclientv2/minlength.go | 21 - build/platformclientv2/mobiledevicesapi.go | 411 - .../modelingprocessingerror.go | 21 - .../modelingstatusresponse.go | 29 - .../movemanagementunitrequest.go | 17 - .../movemanagementunitresponse.go | 21 - .../murescheduleresultwrapper.go | 17 - build/platformclientv2/namedentity.go | 21 - .../platformclientv2/namedentityannotation.go | 17 - .../namedentitytypebinding.go | 21 - .../namedentitytypedefinition.go | 25 - build/platformclientv2/namedentitytypeitem.go | 21 - .../namedentitytypemechanism.go | 25 - .../nluconfusionmatrixcolumn.go | 21 - .../platformclientv2/nluconfusionmatrixrow.go | 21 - build/platformclientv2/nludetectioncontext.go | 21 - build/platformclientv2/nludetectioninput.go | 17 - build/platformclientv2/nludetectionoutput.go | 21 - build/platformclientv2/nludetectionrequest.go | 21 - .../platformclientv2/nludetectionresponse.go | 25 - build/platformclientv2/nludomain.go | 46 - build/platformclientv2/nludomainlisting.go | 53 - build/platformclientv2/nludomainversion.go | 70 - .../nludomainversionlisting.go | 53 - .../nludomainversionqualityreport.go | 25 - .../nludomainversiontrainingresponse.go | 21 - build/platformclientv2/nlufeedbacklisting.go | 53 - build/platformclientv2/nlufeedbackrequest.go | 25 - build/platformclientv2/nlufeedbackresponse.go | 38 - build/platformclientv2/nluinfo.go | 17 - .../nluqualityreportsummary.go | 17 - .../nluqualityreportsummarymetric.go | 21 - build/platformclientv2/nluutterance.go | 17 - build/platformclientv2/nluutterancesegment.go | 21 - build/platformclientv2/note.go | 46 - build/platformclientv2/notelisting.go | 53 - build/platformclientv2/notificationsapi.go | 550 - .../platformclientv2/notificationsresponse.go | 17 - .../notificationtemplatebody.go | 21 - .../notificationtemplatefooter.go | 17 - .../notificationtemplateheader.go | 29 - .../notificationtemplateparameter.go | 21 - build/platformclientv2/ntpsettings.go | 17 - build/platformclientv2/number.go | 21 - build/platformclientv2/numberplan.go | 90 - build/platformclientv2/numericrange.go | 29 - build/platformclientv2/oauthapi.go | 954 -- build/platformclientv2/oauthauthorization.go | 50 - .../oauthauthorizationlisting.go | 25 - build/platformclientv2/oauthclient.go | 82 - .../oauthcliententitylisting.go | 53 - build/platformclientv2/oauthclientlisting.go | 78 - build/platformclientv2/oauthclientrequest.go | 54 - .../platformclientv2/oauthlasttokenissued.go | 18 - build/platformclientv2/oauthprovider.go | 29 - .../oauthproviderentitylisting.go | 53 - build/platformclientv2/oauthscope.go | 25 - build/platformclientv2/oauthscopelisting.go | 25 - build/platformclientv2/objectsapi.go | 722 - .../platformclientv2/observationmetricdata.go | 33 - build/platformclientv2/observationvalue.go | 90 - build/platformclientv2/okta.go | 45 - build/platformclientv2/onelogin.go | 45 - build/platformclientv2/operation.go | 53 - build/platformclientv2/organization.go | 73 - build/platformclientv2/organizationapi.go | 722 - .../organizationauthorizationapi.go | 1959 --- .../platformclientv2/organizationfeatures.go | 65 - .../platformclientv2/organizationpresence.go | 58 - .../organizationpresenceentitylisting.go | 53 - .../organizationproductentitylisting.go | 33 - .../organizationroleentitylisting.go | 53 - build/platformclientv2/orgoauthclient.go | 62 - build/platformclientv2/orguser.go | 149 - .../platformclientv2/orgwhitelistsettings.go | 21 - build/platformclientv2/orphanrecording.go | 66 - .../orphanrecordinglisting.go | 53 - build/platformclientv2/orphanupdaterequest.go | 26 - build/platformclientv2/outboundapi.go | 9569 -------------- ...essagingcampaignconfigchangecontactsort.go | 29 - ...essagingcampaignconfigchangeerrordetail.go | 21 - ...ngcampaignconfigchangemessagingcampaign.go | 78 - ...essagingcampaignconfigchangeresponseref.go | 17 - ...gmessagingcampaignconfigchangesmsconfig.go | 29 - ...ngcampaignconfigchangesmsphonenumberref.go | 17 - ...ssagingcampaignconfigchangeurireference.go | 21 - ...ngcampaignprogresseventcampaignprogress.go | 37 - ...sagingcampaignprogresseventurireference.go | 21 - build/platformclientv2/outboundroute.go | 86 - build/platformclientv2/outboundroutebase.go | 78 - .../outboundroutebaseentitylisting.go | 53 - .../outboundrouteentitylisting.go | 53 - build/platformclientv2/outboundsettings.go | 58 - build/platformclientv2/outcome.go | 58 - build/platformclientv2/outcomelisting.go | 53 - .../outcomeprobabilitycondition.go | 25 - build/platformclientv2/outofoffice.go | 46 - .../outofofficeeventoutofoffice.go | 34 - .../platformclientv2/outofofficeeventuser.go | 17 - build/platformclientv2/page.go | 46 - build/platformclientv2/pagingspec.go | 21 - build/platformclientv2/parameter.go | 29 - build/platformclientv2/parsedcertificate.go | 17 - build/platformclientv2/participant.go | 194 - .../platformclientv2/participantattributes.go | 17 - build/platformclientv2/participantbasic.go | 194 - build/platformclientv2/participantmetrics.go | 13 - build/platformclientv2/patchaction.go | 25 - build/platformclientv2/patchactionmap.go | 86 - .../patchactionmapschedulegroups.go | 21 - .../platformclientv2/patchactionproperties.go | 33 - build/platformclientv2/patchactionsurvey.go | 17 - build/platformclientv2/patchactiontarget.go | 33 - build/platformclientv2/patchactiontemplate.go | 33 - ...eschedulingoptionsmanagementunitrequest.go | 21 - .../patchbureschedulingoptionsrequest.go | 17 - .../patchbuschedulerunrequest.go | 17 - build/platformclientv2/patchcalltoaction.go | 25 - .../patchclosebuttonstyleproperties.go | 21 - build/platformclientv2/patchcontentoffer.go | 45 - .../patchcontentofferstyleproperties.go | 25 - .../patchcontentofferstylingconfiguration.go | 41 - .../patchcontentpositionproperties.go | 29 - .../patchctabuttonstyleproperties.go | 33 - .../patchintegrationaction.go | 17 - .../patchintegrationactionfields.go | 21 - build/platformclientv2/patchoutcome.go | 58 - build/platformclientv2/patchsegment.go | 66 - .../patchshifttraderequest.go | 29 - build/platformclientv2/patchsurveyquestion.go | 33 - .../patchtextstyleproperties.go | 29 - build/platformclientv2/patchuser.go | 33 - .../permissioncollectionentitylisting.go | 53 - build/platformclientv2/permissions.go | 17 - build/platformclientv2/phone.go | 114 - build/platformclientv2/phonebase.go | 78 - .../phonebaseentitylisting.go | 53 - build/platformclientv2/phonecapabilities.go | 49 - .../phonechangetopicedgereference.go | 25 - .../phonechangetopiclinestatus.go | 34 - .../phonechangetopiclocaldate.go | 29 - .../phonechangetopiclocaldatetime.go | 21 - .../phonechangetopiclocaltime.go | 29 - .../phonechangetopicoffsetdatetime.go | 21 - .../platformclientv2/phonechangetopicphone.go | 29 - .../phonechangetopicphonestatus.go | 37 - .../phonechangetopicprovisioninfo.go | 26 - .../phonechangetopicuseragentinfo.go | 25 - .../phonechangetopiczoneoffset.go | 17 - build/platformclientv2/phonecolumn.go | 21 - build/platformclientv2/phoneentitylisting.go | 53 - .../phonemetabaseentitylisting.go | 53 - build/platformclientv2/phonenumber.go | 37 - build/platformclientv2/phonenumbercolumn.go | 21 - build/platformclientv2/phonenumberstatus.go | 17 - build/platformclientv2/phonesreboot.go | 21 - build/platformclientv2/phonestatus.go | 53 - .../physicalinterfaceentitylisting.go | 53 - build/platformclientv2/pinconfiguration.go | 21 - build/platformclientv2/pingidentity.go | 49 - build/platformclientv2/planninggroup.go | 37 - build/platformclientv2/planninggrouplist.go | 17 - .../planninggroupreference.go | 21 - .../planningperiodsettings.go | 22 - .../platformclientv2/platformclientv2_test.go | 292 - build/platformclientv2/policy.go | 62 - build/platformclientv2/policyactions.go | 61 - build/platformclientv2/policyconditions.go | 45 - build/platformclientv2/policycreate.go | 62 - build/platformclientv2/policyentitylisting.go | 53 - build/platformclientv2/policyerrormessage.go | 42 - build/platformclientv2/policyerrors.go | 17 - build/platformclientv2/postactioninput.go | 37 - build/platformclientv2/postinputcontract.go | 17 - build/platformclientv2/postoutputcontract.go | 17 - build/platformclientv2/posttextmessage.go | 25 - build/platformclientv2/posttextrequest.go | 65 - build/platformclientv2/posttextresponse.go | 45 - build/platformclientv2/predictionresults.go | 25 - build/platformclientv2/presenceapi.go | 949 -- build/platformclientv2/presencedefinition.go | 25 - .../presencedetailqueryclause.go | 21 - .../presencedetailqueryfilter.go | 25 - .../presencedetailquerypredicate.go | 33 - .../presenceeventorganizationpresence.go | 21 - .../presenceeventuserpresence.go | 34 - build/platformclientv2/presenceexpand.go | 33 - build/platformclientv2/prompt.go | 37 - build/platformclientv2/promptasset.go | 65 - build/platformclientv2/promptassetcreate.go | 65 - .../promptassetentitylisting.go | 53 - build/platformclientv2/promptentitylisting.go | 53 - build/platformclientv2/propertychange.go | 25 - .../platformclientv2/propertyindexrequest.go | 26 - build/platformclientv2/provisioninfo.go | 26 - build/platformclientv2/publishdraftinput.go | 17 - .../publishedsurveyformreference.go | 29 - build/platformclientv2/publishform.go | 21 - .../publishprogrampublishjob.go | 21 - .../publishtopicpublishjob.go | 21 - build/platformclientv2/purecloud.go | 29 - build/platformclientv2/pureengage.go | 49 - build/platformclientv2/qualityapi.go | 5635 -------- build/platformclientv2/qualityaudit.go | 61 - build/platformclientv2/qualityauditpage.go | 53 - build/platformclientv2/querydivision.go | 13 - build/platformclientv2/queryfacetinfo.go | 21 - build/platformclientv2/queryrequest.go | 45 - build/platformclientv2/queryrequestclause.go | 21 - build/platformclientv2/queryrequestfilter.go | 21 - .../platformclientv2/queryrequestpredicate.go | 21 - build/platformclientv2/queryresponsedata.go | 21 - .../queryresponsegroupeddata.go | 21 - build/platformclientv2/queryresponsemetric.go | 21 - build/platformclientv2/queryresponsestats.go | 17 - build/platformclientv2/queryresult.go | 29 - build/platformclientv2/queryresults.go | 21 - build/platformclientv2/queue.go | 114 - ...ncallbackeventtopiccallbackconversation.go | 29 - ...lbackeventtopiccallbackmediaparticipant.go | 186 - ...llbackeventtopicconversationroutingdata.go | 33 - ...eueconversationcallbackeventtopicdetail.go | 29 - ...ersationcallbackeventtopicdialerpreview.go | 37 - ...conversationcallbackeventtopicerrorbody.go | 53 - ...ersationcallbackeventtopicjourneyaction.go | 21 - ...ationcallbackeventtopicjourneyactionmap.go | 21 - ...rsationcallbackeventtopicjourneycontext.go | 25 - ...sationcallbackeventtopicjourneycustomer.go | 21 - ...allbackeventtopicjourneycustomersession.go | 21 - ...tioncallbackeventtopicphonenumbercolumn.go | 25 - ...nversationcallbackeventtopicscoredagent.go | 21 - ...versationcallbackeventtopicurireference.go | 21 - ...conversationcallbackeventtopicvoicemail.go | 21 - ...eueconversationcallbackeventtopicwrapup.go | 38 - ...versationcalleventtopiccallconversation.go | 37 - ...ationcalleventtopiccallmediaparticipant.go | 194 - ...oncalleventtopicconversationroutingdata.go | 33 - .../queueconversationcalleventtopicdetail.go | 29 - ...ueueconversationcalleventtopicerrorbody.go | 53 - ...ueueconversationcalleventtopicfaxstatus.go | 45 - ...conversationcalleventtopicjourneyaction.go | 21 - ...versationcalleventtopicjourneyactionmap.go | 21 - ...onversationcalleventtopicjourneycontext.go | 25 - ...nversationcalleventtopicjourneycustomer.go | 21 - ...ioncalleventtopicjourneycustomersession.go | 21 - ...ueconversationcalleventtopicscoredagent.go | 21 - ...econversationcalleventtopicurireference.go | 21 - .../queueconversationcalleventtopicwrapup.go | 38 - ...versationchateventtopicchatconversation.go | 29 - ...ationchateventtopicchatmediaparticipant.go | 158 - ...onchateventtopicconversationroutingdata.go | 33 - .../queueconversationchateventtopicdetail.go | 29 - ...ueueconversationchateventtopicerrorbody.go | 53 - ...conversationchateventtopicjourneyaction.go | 21 - ...versationchateventtopicjourneyactionmap.go | 21 - ...onversationchateventtopicjourneycontext.go | 25 - ...nversationchateventtopicjourneycustomer.go | 21 - ...ionchateventtopicjourneycustomersession.go | 21 - ...ueconversationchateventtopicscoredagent.go | 21 - ...econversationchateventtopicurireference.go | 21 - .../queueconversationchateventtopicwrapup.go | 38 - ...ncobrowseeventtopiccobrowseconversation.go | 29 - ...rowseeventtopiccobrowsemediaparticipant.go | 170 - ...browseeventtopicconversationroutingdata.go | 33 - ...eueconversationcobrowseeventtopicdetail.go | 29 - ...conversationcobrowseeventtopicerrorbody.go | 53 - ...ersationcobrowseeventtopicjourneyaction.go | 21 - ...ationcobrowseeventtopicjourneyactionmap.go | 21 - ...rsationcobrowseeventtopicjourneycontext.go | 25 - ...sationcobrowseeventtopicjourneycustomer.go | 21 - ...obrowseeventtopicjourneycustomersession.go | 21 - ...nversationcobrowseeventtopicscoredagent.go | 21 - ...versationcobrowseeventtopicurireference.go | 21 - ...eueconversationcobrowseeventtopicwrapup.go | 38 - ...ueconversationemaileventtopicattachment.go | 37 - ...nemaileventtopicconversationroutingdata.go | 33 - .../queueconversationemaileventtopicdetail.go | 29 - ...rsationemaileventtopicemailconversation.go | 29 - ...ionemaileventtopicemailmediaparticipant.go | 174 - ...eueconversationemaileventtopicerrorbody.go | 53 - ...onversationemaileventtopicjourneyaction.go | 21 - ...ersationemaileventtopicjourneyactionmap.go | 21 - ...nversationemaileventtopicjourneycontext.go | 25 - ...versationemaileventtopicjourneycustomer.go | 21 - ...onemaileventtopicjourneycustomersession.go | 21 - ...econversationemaileventtopicscoredagent.go | 21 - ...conversationemaileventtopicurireference.go | 21 - .../queueconversationemaileventtopicwrapup.go | 38 - .../queueconversationeventtopicaddress.go | 37 - ...ueueconversationeventtopicaftercallwork.go | 26 - .../queueconversationeventtopicattachment.go | 37 - .../queueconversationeventtopiccall.go | 122 - .../queueconversationeventtopiccallback.go | 110 - .../queueconversationeventtopicchat.go | 82 - .../queueconversationeventtopiccobrowse.go | 90 - ...queueconversationeventtopicconversation.go | 33 - ...sationeventtopicconversationroutingdata.go | 33 - ...ueueconversationeventtopicdialerpreview.go | 37 - ...econversationeventtopicdisconnectreason.go | 25 - .../queueconversationeventtopicemail.go | 102 - ...queueconversationeventtopicerrordetails.go | 45 - .../queueconversationeventtopicfaxstatus.go | 45 - ...ueueconversationeventtopicjourneyaction.go | 21 - ...econversationeventtopicjourneyactionmap.go | 21 - ...eueconversationeventtopicjourneycontext.go | 25 - ...ueconversationeventtopicjourneycustomer.go | 21 - ...rsationeventtopicjourneycustomersession.go | 21 - .../queueconversationeventtopicmessage.go | 106 - ...eueconversationeventtopicmessagedetails.go | 38 - ...queueconversationeventtopicmessagemedia.go | 33 - ...eueconversationeventtopicmessagesticker.go | 21 - .../queueconversationeventtopicparticipant.go | 162 - ...conversationeventtopicphonenumbercolumn.go | 25 - .../queueconversationeventtopicscoredagent.go | 21 - .../queueconversationeventtopicscreenshare.go | 74 - ...econversationeventtopicsocialexpression.go | 90 - ...queueconversationeventtopicurireference.go | 21 - .../queueconversationeventtopicvideo.go | 86 - .../queueconversationeventtopicvoicemail.go | 21 - .../queueconversationeventtopicwrapup.go | 38 - ...essageeventtopicconversationroutingdata.go | 33 - ...ueueconversationmessageeventtopicdetail.go | 29 - ...econversationmessageeventtopicerrorbody.go | 53 - ...versationmessageeventtopicjourneyaction.go | 21 - ...sationmessageeventtopicjourneyactionmap.go | 21 - ...ersationmessageeventtopicjourneycontext.go | 25 - ...rsationmessageeventtopicjourneycustomer.go | 21 - ...messageeventtopicjourneycustomersession.go | 21 - ...ionmessageeventtopicmessageconversation.go | 29 - ...ersationmessageeventtopicmessagedetails.go | 38 - ...nversationmessageeventtopicmessagemedia.go | 33 - ...essageeventtopicmessagemediaparticipant.go | 166 - ...ersationmessageeventtopicmessagesticker.go | 21 - ...onversationmessageeventtopicscoredagent.go | 21 - ...nversationmessageeventtopicurireference.go | 21 - ...ueueconversationmessageeventtopicwrapup.go | 38 - ...nshareeventtopicconversationroutingdata.go | 33 - ...conversationscreenshareeventtopicdetail.go | 29 - ...versationscreenshareeventtopicerrorbody.go | 53 - ...ationscreenshareeventtopicjourneyaction.go | 21 - ...onscreenshareeventtopicjourneyactionmap.go | 21 - ...tionscreenshareeventtopicjourneycontext.go | 25 - ...ionscreenshareeventtopicjourneycustomer.go | 21 - ...enshareeventtopicjourneycustomersession.go | 21 - ...rsationscreenshareeventtopicscoredagent.go | 21 - ...nshareeventtopicscreenshareconversation.go | 29 - ...reeventtopicscreensharemediaparticipant.go | 162 - ...sationscreenshareeventtopicurireference.go | 21 - ...conversationscreenshareeventtopicwrapup.go | 38 - ...sationsocialexpressioneventtopicaddress.go | 37 - ...socialexpressioneventtopicaftercallwork.go | 26 - ...ionsocialexpressioneventtopicattachment.go | 37 - ...versationsocialexpressioneventtopiccall.go | 122 - ...ationsocialexpressioneventtopiccallback.go | 110 - ...versationsocialexpressioneventtopicchat.go | 82 - ...ationsocialexpressioneventtopiccobrowse.go | 90 - ...nsocialexpressioneventtopicconversation.go | 33 - ...essioneventtopicconversationroutingdata.go | 33 - ...socialexpressioneventtopicdialerpreview.go | 37 - ...ialexpressioneventtopicdisconnectreason.go | 25 - ...ersationsocialexpressioneventtopicemail.go | 102 - ...nsocialexpressioneventtopicerrordetails.go | 45 - ...tionsocialexpressioneventtopicfaxstatus.go | 45 - ...socialexpressioneventtopicjourneyaction.go | 21 - ...ialexpressioneventtopicjourneyactionmap.go | 21 - ...ocialexpressioneventtopicjourneycontext.go | 25 - ...cialexpressioneventtopicjourneycustomer.go | 21 - ...ressioneventtopicjourneycustomersession.go | 21 - ...sationsocialexpressioneventtopicmessage.go | 106 - ...ocialexpressioneventtopicmessagedetails.go | 38 - ...nsocialexpressioneventtopicmessagemedia.go | 33 - ...ocialexpressioneventtopicmessagesticker.go | 21 - ...onsocialexpressioneventtopicparticipant.go | 162 - ...alexpressioneventtopicphonenumbercolumn.go | 25 - ...onsocialexpressioneventtopicscoredagent.go | 21 - ...onsocialexpressioneventtopicscreenshare.go | 74 - ...ialexpressioneventtopicsocialexpression.go | 90 - ...nsocialexpressioneventtopicurireference.go | 21 - ...ersationsocialexpressioneventtopicvideo.go | 86 - ...tionsocialexpressioneventtopicvoicemail.go | 21 - ...rsationsocialexpressioneventtopicwrapup.go | 38 - ...queueconversationvideoeventtopicaddress.go | 37 - ...onversationvideoeventtopicaftercallwork.go | 26 - ...ueconversationvideoeventtopicattachment.go | 37 - .../queueconversationvideoeventtopiccall.go | 122 - ...ueueconversationvideoeventtopiccallback.go | 110 - .../queueconversationvideoeventtopicchat.go | 82 - ...ueueconversationvideoeventtopiccobrowse.go | 90 - ...conversationvideoeventtopicconversation.go | 33 - ...nvideoeventtopicconversationroutingdata.go | 33 - ...onversationvideoeventtopicdialerpreview.go | 37 - ...ersationvideoeventtopicdisconnectreason.go | 25 - .../queueconversationvideoeventtopicemail.go | 102 - ...conversationvideoeventtopicerrordetails.go | 45 - ...eueconversationvideoeventtopicfaxstatus.go | 45 - ...onversationvideoeventtopicjourneyaction.go | 21 - ...ersationvideoeventtopicjourneyactionmap.go | 21 - ...nversationvideoeventtopicjourneycontext.go | 25 - ...versationvideoeventtopicjourneycustomer.go | 21 - ...onvideoeventtopicjourneycustomersession.go | 21 - ...queueconversationvideoeventtopicmessage.go | 106 - ...nversationvideoeventtopicmessagedetails.go | 38 - ...conversationvideoeventtopicmessagemedia.go | 33 - ...nversationvideoeventtopicmessagesticker.go | 21 - ...econversationvideoeventtopicparticipant.go | 162 - ...rsationvideoeventtopicphonenumbercolumn.go | 25 - ...econversationvideoeventtopicscoredagent.go | 21 - ...econversationvideoeventtopicscreenshare.go | 74 - ...ersationvideoeventtopicsocialexpression.go | 90 - ...conversationvideoeventtopicurireference.go | 21 - .../queueconversationvideoeventtopicvideo.go | 86 - ...eueconversationvideoeventtopicvoicemail.go | 21 - .../queueconversationvideoeventtopicwrapup.go | 38 - build/platformclientv2/queueemailaddress.go | 21 - build/platformclientv2/queueentitylisting.go | 53 - build/platformclientv2/queuemember.go | 45 - .../queuememberentitylisting.go | 53 - .../queuemessagingaddresses.go | 17 - .../queueobservationdatacontainer.go | 21 - .../platformclientv2/queueobservationquery.go | 25 - .../queueobservationqueryclause.go | 21 - .../queueobservationqueryfilter.go | 25 - .../queueobservationquerypredicate.go | 33 - .../queueobservationqueryresponse.go | 21 - build/platformclientv2/queuereference.go | 21 - build/platformclientv2/queuerequest.go | 114 - .../queueusereventtopicqueuemember.go | 33 - .../queueusereventtopicuserreference.go | 17 - .../queueutilizationdiagnostic.go | 49 - build/platformclientv2/reaction.go | 25 - build/platformclientv2/recallentry.go | 21 - build/platformclientv2/recipient.go | 50 - build/platformclientv2/recipientlisting.go | 53 - build/platformclientv2/record.go | 25 - build/platformclientv2/recording.go | 130 - build/platformclientv2/recordingapi.go | 4346 ------ ...recordingarchiverestoretopicmediaresult.go | 29 - .../recordingarchiverestoretopicrecording.go | 37 - .../platformclientv2/recordingemailmessage.go | 54 - .../recordingeventmediaresult.go | 29 - .../recordingeventrecording.go | 37 - build/platformclientv2/recordingjob.go | 58 - .../recordingjobentitylisting.go | 53 - build/platformclientv2/recordingjobsquery.go | 34 - .../recordingmessagingmessage.go | 50 - build/platformclientv2/recordingmetadata.go | 90 - build/platformclientv2/recordingsettings.go | 21 - ...ordingtranscodecompletetopicmediaresult.go | 29 - ...ecordingtranscodecompletetopicrecording.go | 37 - build/platformclientv2/regiontimezone.go | 29 - build/platformclientv2/relationship.go | 41 - build/platformclientv2/relationshiplisting.go | 53 - build/platformclientv2/replacementterm.go | 25 - build/platformclientv2/replacerequest.go | 25 - build/platformclientv2/replaceresponse.go | 37 - ...ngdataexporttopicdataexportnotification.go | 74 - .../reportingexportjoblisting.go | 53 - .../reportingexportjobrequest.go | 85 - .../reportingexportjobresponse.go | 134 - .../reportingexportmetadatajoblisting.go | 53 - .../reportingexportmetadatajobresponse.go | 53 - build/platformclientv2/reportmetadata.go | 49 - .../reportmetadataentitylisting.go | 53 - build/platformclientv2/reportrunentry.go | 58 - .../reportrunentryentitydomainlisting.go | 53 - build/platformclientv2/reportschedule.go | 82 - .../reportscheduleentitylisting.go | 53 - build/platformclientv2/requestconfig.go | 33 - build/platformclientv2/requestmapping.go | 29 - .../reschedulingmanagementunitresponse.go | 21 - .../reschedulingoptionsrunresponse.go | 54 - .../resolutiondetailqueryclause.go | 21 - .../resolutiondetailqueryfilter.go | 25 - .../resolutiondetailquerypredicate.go | 33 - .../platformclientv2/resourceconditionnode.go | 33 - .../resourceconditionvalue.go | 21 - .../resourcepermissionpolicy.go | 57 - build/platformclientv2/response.go | 66 - build/platformclientv2/responseconfig.go | 29 - build/platformclientv2/responseentitylist.go | 53 - .../platformclientv2/responseentitylisting.go | 53 - build/platformclientv2/responsefilter.go | 25 - .../platformclientv2/responsemanagementapi.go | 930 -- .../platformclientv2/responsequeryrequest.go | 25 - .../platformclientv2/responsequeryresults.go | 17 - build/platformclientv2/responseset.go | 42 - .../responsesetentitylisting.go | 53 - .../platformclientv2/responsesubstitution.go | 25 - build/platformclientv2/responsetext.go | 21 - build/platformclientv2/resterrordetail.go | 21 - build/platformclientv2/retentionduration.go | 21 - .../reversewhitepageslookupresult.go | 21 - build/platformclientv2/ring.go | 21 - build/platformclientv2/roledivision.go | 21 - build/platformclientv2/roledivisiongrants.go | 17 - build/platformclientv2/roledivisionpair.go | 21 - build/platformclientv2/routepathrequest.go | 33 - build/platformclientv2/routepathresponse.go | 29 - build/platformclientv2/routingapi.go | 7449 ----------- build/platformclientv2/routingdata.go | 33 - build/platformclientv2/routingrule.go | 25 - build/platformclientv2/routingsettings.go | 17 - build/platformclientv2/routingskill.go | 38 - .../platformclientv2/routingskillreference.go | 21 - build/platformclientv2/routingstatus.go | 26 - .../routingstatusdetailqueryclause.go | 21 - .../routingstatusdetailqueryfilter.go | 25 - .../routingstatusdetailquerypredicate.go | 33 - build/platformclientv2/ruleset.go | 50 - build/platformclientv2/rulesetdiagnostic.go | 21 - .../platformclientv2/rulesetentitylisting.go | 53 - build/platformclientv2/salesforce.go | 45 - build/platformclientv2/schedule.go | 74 - .../platformclientv2/scheduleentitylisting.go | 53 - .../schedulegenerationmessage.go | 21 - .../schedulegenerationresult.go | 29 - .../schedulegenerationresultsummary.go | 25 - .../schedulegenerationwarning.go | 45 - build/platformclientv2/schedulegroup.go | 78 - .../schedulegroupentitylisting.go | 53 - build/platformclientv2/scheduleinterval.go | 21 - .../schedulermessageargument.go | 21 - .../schedulingprocessingerror.go | 21 - .../schedulingsettingsrequest.go | 25 - .../schedulingsettingsresponse.go | 25 - .../schedulingstatusresponse.go | 33 - .../schedulingtestingoptionsrequest.go | 29 - build/platformclientv2/schema.go | 33 - build/platformclientv2/schemacategory.go | 62 - .../schemacategoryentitylisting.go | 53 - .../platformclientv2/schemaquantitylimits.go | 69 - .../schemareferenceentitylisting.go | 53 - build/platformclientv2/scimapi.go | 2589 ---- .../scimconfigresourcetype.go | 45 - .../scimconfigresourcetypeschemaextension.go | 21 - .../scimconfigresourcetypeslistresponse.go | 33 - build/platformclientv2/scimemail.go | 25 - build/platformclientv2/scimerror.go | 29 - .../scimgenesysuserexternalid.go | 21 - .../platformclientv2/scimgrouplistresponse.go | 33 - build/platformclientv2/scimmetadata.go | 30 - build/platformclientv2/scimphonenumber.go | 25 - .../scimserviceproviderconfig.go | 53 - ...rviceproviderconfigauthenticationscheme.go | 37 - .../scimserviceproviderconfigbulkfeature.go | 25 - .../scimserviceproviderconfigfilterfeature.go | 21 - .../scimserviceproviderconfigsimplefeature.go | 17 - build/platformclientv2/scimuserextensions.go | 25 - .../platformclientv2/scimuserlistresponse.go | 33 - build/platformclientv2/scimuserrole.go | 17 - .../scimuserroutinglanguage.go | 21 - .../platformclientv2/scimuserroutingskill.go | 21 - build/platformclientv2/scimv2createuser.go | 65 - .../platformclientv2/scimv2enterpriseuser.go | 29 - build/platformclientv2/scimv2group.go | 37 - .../platformclientv2/scimv2groupreference.go | 25 - .../platformclientv2/scimv2memberreference.go | 25 - .../platformclientv2/scimv2patchoperation.go | 25 - build/platformclientv2/scimv2patchrequest.go | 21 - .../platformclientv2/scimv2schemaattribute.go | 61 - .../scimv2schemadefinition.go | 33 - .../scimv2schemalistresponse.go | 33 - build/platformclientv2/scimv2user.go | 73 - build/platformclientv2/scorablesurvey.go | 37 - build/platformclientv2/scoredagent.go | 21 - .../screenrecordingsession.go | 42 - .../screenrecordingsessionlisting.go | 53 - .../screenrecordingsessionrequest.go | 26 - build/platformclientv2/screenshare.go | 74 - build/platformclientv2/script.go | 70 - build/platformclientv2/scriptentitylisting.go | 53 - build/platformclientv2/scriptsapi.go | 1124 -- build/platformclientv2/searchaggregation.go | 37 - build/platformclientv2/searchapi.go | 1586 --- build/platformclientv2/searchcriteria.go | 49 - build/platformclientv2/searchrequest.go | 53 - .../searchshifttraderesponse.go | 25 - .../searchshifttradesrequest.go | 21 - .../searchshifttradesresponse.go | 17 - build/platformclientv2/searchsort.go | 21 - build/platformclientv2/section.go | 29 - build/platformclientv2/securesession.go | 41 - .../securesessionentitylisting.go | 17 - build/platformclientv2/securityprofile.go | 29 - .../securityprofileentitylisting.go | 53 - build/platformclientv2/segment.go | 34 - .../segmentdetailqueryclause.go | 21 - .../segmentdetailqueryfilter.go | 25 - .../segmentdetailquerypredicate.go | 45 - build/platformclientv2/segmentlisting.go | 53 - build/platformclientv2/selectedcolumns.go | 21 - .../sendagentlessoutboundmessagerequest.go | 29 - .../sendagentlessoutboundmessageresponse.go | 50 - build/platformclientv2/sequenceschedule.go | 50 - build/platformclientv2/serverdate.go | 18 - build/platformclientv2/servicecontext.go | 17 - build/platformclientv2/servicegoaltemplate.go | 41 - .../servicegoaltemplatelist.go | 17 - .../servicegoaltemplatereference.go | 21 - build/platformclientv2/servicelevel.go | 21 - build/platformclientv2/setuuidatarequest.go | 17 - build/platformclientv2/setwrapperdayofweek.go | 17 - .../setwrapperroutepathrequest.go | 17 - build/platformclientv2/share.go | 57 - build/platformclientv2/sharedentity.go | 17 - build/platformclientv2/sharedresponse.go | 33 - build/platformclientv2/shareentitylisting.go | 53 - build/platformclientv2/shiftstartvariance.go | 21 - .../shifttradeactivitypreviewresponse.go | 30 - .../shifttradeactivityrule.go | 25 - .../shifttradelistresponse.go | 17 - .../shifttradematchessummaryresponse.go | 17 - .../shifttradematchreviewresponse.go | 29 - .../shifttradematchreviewuserresponse.go | 33 - .../shifttradematchviolation.go | 21 - .../shifttradenotification.go | 46 - .../shifttradepreviewresponse.go | 17 - build/platformclientv2/shifttraderesponse.go | 86 - build/platformclientv2/shifttradesettings.go | 65 - .../shorttermforecastingsettings.go | 17 - .../shorttermforecastreference.go | 29 - build/platformclientv2/shrinkageoverride.go | 21 - build/platformclientv2/shrinkageoverrides.go | 21 - build/platformclientv2/signedurlresponse.go | 29 - build/platformclientv2/sipdownloadresponse.go | 21 - .../sipsearchpublicrequest.go | 54 - build/platformclientv2/sipsearchresult.go | 45 - build/platformclientv2/site.go | 114 - build/platformclientv2/siteentitylisting.go | 53 - build/platformclientv2/skillentitylisting.go | 53 - build/platformclientv2/skillstoremove.go | 25 - build/platformclientv2/smsaddress.go | 49 - .../smsaddressentitylisting.go | 53 - build/platformclientv2/smsaddressprovision.go | 49 - .../smsavailablephonenumber.go | 53 - .../smsavailablephonenumberentitylisting.go | 17 - build/platformclientv2/smsconfig.go | 25 - build/platformclientv2/smsphonenumber.go | 94 - .../smsphonenumberentitylisting.go | 53 - .../smsphonenumberprovision.go | 41 - build/platformclientv2/smsphonenumberref.go | 21 - build/platformclientv2/socialexpression.go | 94 - build/platformclientv2/socialhandle.go | 21 - build/platformclientv2/sortitem.go | 21 - .../sourceplanninggrouprequest.go | 21 - .../speechtextanalyticsapi.go | 381 - .../speechtextanalyticssettingsrequest.go | 21 - .../speechtextanalyticssettingsresponse.go | 21 - .../stateventcampaigntopicdatum.go | 21 - .../stateventcampaigntopicmetric.go | 25 - ...stateventcampaigntopicstatsnotification.go | 21 - .../stateventflowoutcometopicdatum.go | 21 - .../stateventflowoutcometopicmetric.go | 25 - ...teventflowoutcometopicstatsnotification.go | 21 - .../stateventflowtopicdatum.go | 21 - .../stateventflowtopicmetric.go | 25 - .../stateventflowtopicstatsnotification.go | 21 - .../stateventqueuetopicdatum.go | 21 - .../stateventqueuetopicmetric.go | 25 - .../stateventqueuetopicstatsnotification.go | 21 - .../stateventusertopicdatum.go | 21 - .../stateventusertopicmetric.go | 25 - .../stateventusertopicstatsnotification.go | 21 - .../stateventwrapupcodetopicdatum.go | 21 - .../stateventwrapupcodetopicmetric.go | 25 - ...ateventwrapupcodetopicstatsnotification.go | 21 - build/platformclientv2/station.go | 69 - .../platformclientv2/stationentitylisting.go | 53 - build/platformclientv2/stationsapi.go | 462 - build/platformclientv2/stationsettings.go | 17 - build/platformclientv2/statisticalresponse.go | 25 - build/platformclientv2/statisticalsummary.go | 57 - build/platformclientv2/streetaddress.go | 45 - .../platformclientv2/subjectdivisiongrants.go | 33 - .../subjectdivisiongrantsentitylisting.go | 53 - build/platformclientv2/subjectdivisions.go | 21 - build/platformclientv2/subscriberresponse.go | 21 - .../subscriptionoverviewusage.go | 61 - build/platformclientv2/suggestapi.go | 414 - .../platformclientv2/suggestsearchcriteria.go | 45 - .../platformclientv2/suggestsearchrequest.go | 25 - build/platformclientv2/supportedcontent.go | 17 - build/platformclientv2/supportedlanguage.go | 21 - build/platformclientv2/survey.go | 58 - .../surveyaggregatedatacontainer.go | 21 - .../surveyaggregatequeryclause.go | 21 - .../surveyaggregatequeryfilter.go | 25 - .../surveyaggregatequerypredicate.go | 33 - .../surveyaggregatequeryresponse.go | 17 - .../surveyaggregationquery.go | 49 - .../platformclientv2/surveyaggregationview.go | 29 - build/platformclientv2/surveyassignment.go | 33 - .../surveydetailqueryclause.go | 21 - .../surveydetailqueryfilter.go | 25 - .../surveydetailquerypredicate.go | 37 - build/platformclientv2/surveyerrordetails.go | 21 - build/platformclientv2/surveyform.go | 62 - .../surveyformandscoringset.go | 21 - .../surveyformentitylisting.go | 53 - build/platformclientv2/surveyquestion.go | 49 - build/platformclientv2/surveyquestiongroup.go | 37 - .../surveyquestiongroupscore.go | 33 - build/platformclientv2/surveyquestionscore.go | 41 - build/platformclientv2/surveyscoringset.go | 25 - .../systemmessagesystemmessage.go | 49 - build/platformclientv2/systempresence.go | 25 - build/platformclientv2/systemprompt.go | 33 - build/platformclientv2/systempromptasset.go | 69 - .../systempromptassetentitylisting.go | 53 - .../systempromptentitylisting.go | 53 - build/platformclientv2/tagqueryrequest.go | 25 - build/platformclientv2/tagvalue.go | 33 - .../platformclientv2/tagvalueentitylisting.go | 53 - build/platformclientv2/telephonyapi.go | 320 - .../telephonyprovidersedgeapi.go | 10877 ---------------- build/platformclientv2/templateparameter.go | 21 - build/platformclientv2/termattribute.go | 25 - .../testexecutionoperationresult.go | 33 - build/platformclientv2/testexecutionresult.go | 29 - build/platformclientv2/testmessage.go | 42 - build/platformclientv2/textbotsapi.go | 103 - build/platformclientv2/textmessagelisting.go | 53 - build/platformclientv2/textstyleproperties.go | 29 - build/platformclientv2/ticker.go | 21 - build/platformclientv2/timeallowed.go | 25 - build/platformclientv2/timeinterval.go | 29 - build/platformclientv2/timeoffrequest.go | 78 - build/platformclientv2/timeoffrequestlist.go | 29 - .../platformclientv2/timeoffrequestlisting.go | 17 - .../timeoffrequestnotification.go | 38 - .../timeoffrequestquerybody.go | 25 - .../timeoffrequestresponse.go | 86 - .../timeoffrequestsettings.go | 25 - build/platformclientv2/timeslot.go | 25 - .../platformclientv2/timezoneentitylisting.go | 53 - .../timezonemappingpreview.go | 49 - build/platformclientv2/tokeninfo.go | 33 - build/platformclientv2/tokeninfocloneduser.go | 21 - build/platformclientv2/tokensapi.go | 221 - build/platformclientv2/traininglisting.go | 29 - .../transcriptaggregatedatacontainer.go | 21 - .../transcriptaggregatequeryclause.go | 21 - .../transcriptaggregatequeryfilter.go | 25 - .../transcriptaggregatequerypredicate.go | 33 - .../transcriptaggregatequeryresponse.go | 17 - .../transcriptaggregationquery.go | 49 - .../transcriptaggregationview.go | 29 - ...nscriptconversationdetailsearchcriteria.go | 49 - ...anscriptconversationdetailsearchrequest.go | 41 - .../platformclientv2/transcriptionsettings.go | 25 - build/platformclientv2/transcripts.go | 25 - .../transcriptsearchcriteria.go | 49 - .../transcriptsearchrequest.go | 45 - build/platformclientv2/transcripturl.go | 17 - build/platformclientv2/transferrequest.go | 33 - build/platformclientv2/trunk.go | 126 - build/platformclientv2/trunkbase.go | 78 - build/platformclientv2/trunkbaseassignment.go | 21 - .../trunkbaseentitylisting.go | 53 - .../platformclientv2/trunkconnectedstatus.go | 22 - build/platformclientv2/trunkentitylisting.go | 53 - build/platformclientv2/trunkerrorinfo.go | 25 - .../platformclientv2/trunkerrorinfodetails.go | 25 - .../trunkinstancetopictrunk.go | 33 - .../trunkinstancetopictrunkconnectedstatus.go | 22 - .../trunkinstancetopictrunkerrorinfo.go | 25 - ...trunkinstancetopictrunkerrorinfodetails.go | 25 - ...kinstancetopictrunkmetricsnetworktypeip.go | 21 - .../trunkinstancetopictrunkmetricsoptions.go | 30 - ...trunkinstancetopictrunkmetricsregisters.go | 30 - .../trunkmetabaseentitylisting.go | 53 - build/platformclientv2/trunkmetrics.go | 34 - build/platformclientv2/trunkmetricscalls.go | 21 - .../trunkmetricsnetworktypeip.go | 21 - build/platformclientv2/trunkmetricsoptions.go | 30 - build/platformclientv2/trunkmetricsqos.go | 17 - .../platformclientv2/trunkmetricsregisters.go | 30 - .../trunkmetricstopiclocaldate.go | 29 - .../trunkmetricstopiclocaldatetime.go | 21 - .../trunkmetricstopiclocaltime.go | 29 - .../trunkmetricstopicoffsetdatetime.go | 21 - .../trunkmetricstopictrunkmetrics.go | 29 - .../trunkmetricstopictrunkmetricscalls.go | 21 - .../trunkmetricstopictrunkmetricsqos.go | 17 - .../trunkmetricstopicurireference.go | 21 - .../trunkmetricstopiczoneoffset.go | 17 - .../trunkrecordingenabledcount.go | 21 - build/platformclientv2/trustcreate.go | 29 - build/platformclientv2/trustee.go | 38 - .../trusteeauditqueryrequest.go | 42 - .../platformclientv2/trusteeauthorization.go | 17 - .../trusteebillingoverview.go | 82 - build/platformclientv2/trustentitylisting.go | 53 - build/platformclientv2/trustgroup.go | 74 - build/platformclientv2/trustmembercreate.go | 25 - build/platformclientv2/trustor.go | 42 - .../trustorauditqueryrequest.go | 42 - .../platformclientv2/trustorentitylisting.go | 53 - build/platformclientv2/trustrequest.go | 42 - build/platformclientv2/trustrequestcreate.go | 21 - build/platformclientv2/trustuser.go | 149 - build/platformclientv2/trustuserdetails.go | 22 - .../trustuserentitylisting.go | 53 - build/platformclientv2/ttsengineentity.go | 45 - .../ttsengineentitylisting.go | 53 - build/platformclientv2/ttssettings.go | 21 - build/platformclientv2/ttsvoiceentity.go | 41 - .../platformclientv2/ttsvoiceentitylisting.go | 53 - build/platformclientv2/twitterid.go | 33 - build/platformclientv2/twitterintegration.go | 86 - .../twitterintegrationentitylisting.go | 53 - .../twitterintegrationrequest.go | 49 - build/platformclientv2/unreadmetric.go | 17 - build/platformclientv2/unreadstatus.go | 17 - build/platformclientv2/updateactioninput.go | 29 - .../updateactivitycoderequest.go | 41 - .../updatebusinessunitrequest.go | 25 - .../updatebusinessunitsettings.go | 29 - .../updatecoachingappointmentrequest.go | 42 - build/platformclientv2/updatedraftinput.go | 37 - .../updatemanagementunitrequest.go | 25 - .../updatenotificationresponse.go | 21 - .../updatenotificationsrequest.go | 17 - .../updatenotificationsresponse.go | 17 - .../updateplanninggrouprequest.go | 29 - .../updateservicegoaltemplate.go | 33 - build/platformclientv2/updateuser.go | 97 - .../updateworkplanrotationagentrequest.go | 29 - .../updateworkplanrotationrequest.go | 37 - build/platformclientv2/uploadsapi.go | 316 - build/platformclientv2/uploadurlrequest.go | 29 - build/platformclientv2/uploadurlresponse.go | 25 - build/platformclientv2/urlcondition.go | 21 - build/platformclientv2/usage.go | 17 - build/platformclientv2/usageapi.go | 172 - .../platformclientv2/usageexecutionresult.go | 21 - build/platformclientv2/usageitem.go | 25 - build/platformclientv2/user.go | 149 - build/platformclientv2/useractioncategory.go | 25 - .../useractioncategoryentitylisting.go | 53 - build/platformclientv2/useragentinfo.go | 25 - .../useraggregatedatacontainer.go | 21 - .../useraggregatequeryclause.go | 21 - .../useraggregatequeryfilter.go | 25 - .../useraggregatequerypredicate.go | 33 - .../useraggregatequeryresponse.go | 21 - .../platformclientv2/useraggregationquery.go | 49 - build/platformclientv2/useraggregationview.go | 29 - build/platformclientv2/userapp.go | 33 - .../userappconfigurationinfo.go | 21 - .../platformclientv2/userappentitylisting.go | 53 - build/platformclientv2/userauthorization.go | 29 - .../userconversationseventmediasummary.go | 21 - ...serconversationseventmediasummarydetail.go | 21 - ...nversationseventuserconversationsummary.go | 45 - .../userconversationsummary.go | 45 - .../platformclientv2/userdetailqueryclause.go | 21 - .../platformclientv2/userdetailqueryfilter.go | 25 - .../userdetailquerypredicate.go | 33 - ...topicdataavailabilitychangenotification.go | 17 - ...etailsdatalakeavailabilitytopicdatetime.go | 29 - build/platformclientv2/userdetailsquery.go | 45 - build/platformclientv2/userdevice.go | 53 - build/platformclientv2/userentitylisting.go | 53 - build/platformclientv2/userexpands.go | 41 - .../usergreetingeventgreeting.go | 41 - .../usergreetingeventgreetingaudiofile.go | 21 - .../usergreetingeventgreetingowner.go | 17 - build/platformclientv2/userimage.go | 21 - .../userlanguageentitylisting.go | 53 - build/platformclientv2/userlicenses.go | 25 - .../userlicensesentitylisting.go | 33 - .../userlistschedulerequestbody.go | 30 - build/platformclientv2/userme.go | 209 - .../userobservationdatacontainer.go | 21 - .../platformclientv2/userobservationquery.go | 25 - .../userobservationqueryclause.go | 21 - .../userobservationqueryfilter.go | 25 - .../userobservationquerypredicate.go | 33 - .../userobservationqueryresponse.go | 17 - build/platformclientv2/userparam.go | 21 - build/platformclientv2/userpresence.go | 46 - build/platformclientv2/userprofile.go | 42 - .../userprofileentitylisting.go | 53 - build/platformclientv2/userqueue.go | 114 - .../userqueueentitylisting.go | 53 - build/platformclientv2/userrecording.go | 66 - .../userrecordingentitylisting.go | 53 - build/platformclientv2/userrecordingsapi.go | 519 - build/platformclientv2/userreference.go | 21 - build/platformclientv2/userroutinglanguage.go | 37 - .../userroutinglanguagepost.go | 29 - build/platformclientv2/userroutingskill.go | 37 - .../platformclientv2/userroutingskillpost.go | 29 - .../userroutingstatuserrorinfo.go | 37 - .../userroutingstatusroutingstatus.go | 22 - .../userroutingstatususerparam.go | 25 - .../userroutingstatususerroutingstatus.go | 21 - build/platformclientv2/usersapi.go | 6483 --------- build/platformclientv2/usersapi_test.go | 33 - build/platformclientv2/userschedule.go | 33 - .../platformclientv2/userscheduleactivity.go | 42 - .../platformclientv2/userscheduleadherence.go | 90 - .../userscheduleadherencelisting.go | 21 - .../platformclientv2/userschedulecontainer.go | 25 - .../userschedulefulldaytimeoffmarker.go | 37 - build/platformclientv2/userscheduleshift.go | 42 - build/platformclientv2/usersearchcriteria.go | 49 - build/platformclientv2/usersearchrequest.go | 49 - .../userskillentitylisting.go | 53 - build/platformclientv2/userssearchresponse.go | 49 - build/platformclientv2/userstation.go | 42 - .../userstationchangetopicuser.go | 17 - .../userstationchangetopicuserstation.go | 25 - .../userstationchangetopicuserstations.go | 17 - build/platformclientv2/userstations.go | 29 - .../usertokenstopictokennotification.go | 41 - .../usertokenstopicurireference.go | 21 - build/platformclientv2/utilitiesapi.go | 318 - build/platformclientv2/utilization.go | 17 - .../validateaddressrequest.go | 17 - .../validateaddressresponse.go | 21 - .../validateworkplanmessages.go | 21 - .../validateworkplanresponse.go | 25 - build/platformclientv2/validationlimits.go | 37 - build/platformclientv2/valuewrapperdate.go | 18 - .../valuewrapperplanningperiodsettings.go | 17 - build/platformclientv2/valuewrapperstring.go | 17 - .../vendorconnectionrequest.go | 25 - build/platformclientv2/video.go | 86 - build/platformclientv2/viewfilter.go | 409 - build/platformclientv2/visibilitycondition.go | 21 - build/platformclientv2/vmpairinginfo.go | 29 - build/platformclientv2/voicemail.go | 21 - build/platformclientv2/voicemailapi.go | 1832 --- build/platformclientv2/voicemailcopyrecord.go | 26 - .../platformclientv2/voicemailgrouppolicy.go | 45 - .../platformclientv2/voicemailmailboxinfo.go | 38 - build/platformclientv2/voicemailmediainfo.go | 29 - build/platformclientv2/voicemailmessage.go | 94 - .../voicemailmessageentitylisting.go | 53 - .../voicemailmessagestopicowner.go | 17 - ...icemailmessagestopicvoicemailcopyrecord.go | 21 - .../voicemailmessagestopicvoicemailmessage.go | 70 - .../voicemailorganizationpolicy.go | 42 - .../voicemailretentionpolicy.go | 21 - .../voicemailsearchcriteria.go | 49 - .../voicemailsearchrequest.go | 41 - .../voicemailssearchresponse.go | 49 - build/platformclientv2/voicemailuserpolicy.go | 34 - build/platformclientv2/webchatapi.go | 1461 --- build/platformclientv2/webchatconfig.go | 17 - build/platformclientv2/webchatconversation.go | 29 - build/platformclientv2/webchatdeployment.go | 53 - .../webchatdeploymententitylisting.go | 25 - .../webchatguestmediarequest.go | 41 - .../webchatguestmediarequestentitylist.go | 17 - build/platformclientv2/webchatmemberinfo.go | 66 - .../webchatmemberinfoentitylist.go | 53 - build/platformclientv2/webchatmessage.go | 46 - .../webchatmessageentitylist.go | 33 - .../platformclientv2/webchatroutingtarget.go | 33 - build/platformclientv2/webchatsettings.go | 17 - build/platformclientv2/webchattyping.go | 30 - ...gtopicwebmessagingconfigchangeeventbody.go | 25 - ...ttopicwebmessagingconfigchangeeventbody.go | 25 - ...icwebmessagingdeploymentchangeeventbody.go | 25 - build/platformclientv2/weekschedule.go | 57 - .../weekschedulegenerationresult.go | 29 - .../weekschedulelistitemresponse.go | 45 - .../weekschedulelistresponse.go | 17 - .../platformclientv2/weekschedulereference.go | 25 - .../platformclientv2/weekscheduleresponse.go | 21 - .../weekshifttradelistresponse.go | 17 - .../weekshifttradematchessummaryresponse.go | 22 - .../weekshifttraderesponse.go | 21 - ...enttopiccoachingappointmentconversation.go | 21 - ...intmenttopiccoachingappointmentdocument.go | 21 - ...enttopiccoachingappointmentexternallink.go | 21 - ...enttopiccoachingappointmentnotification.go | 78 - ...emcoachingappointmenttopicuserreference.go | 17 - ...iclearningassignmentrulerunnotification.go | 21 - ...mentruleruntopiclearningmodulereference.go | 21 - ...leruntopicwemlearningassignmentscreated.go | 17 - ...menttopiclearningassignmentnotification.go | 54 - ...gassignmenttopiclearningmodulereference.go | 21 - ...wemlearningassignmenttopicuserreference.go | 17 - build/platformclientv2/wfmagent.go | 57 - ...fmagentscheduleupdatetopicuserreference.go | 17 - ...heduleupdatetopicwfmagentscheduleupdate.go | 22 - ...topicwfmagentscheduleupdatenotification.go | 38 - ...eduleupdatetopicwfmfulldaytimeoffmarker.go | 41 - ...tscheduleupdatetopicwfmscheduleactivity.go | 38 - ...gentscheduleupdatetopicwfmscheduleshift.go | 38 - ...radaydataupdatetopicbuintradaydatagroup.go | 41 - ...aydataupdatetopicbuintradayforecastdata.go | 21 - ...aydataupdatetopicbuintradaynotification.go | 21 - ...intradaydataupdatetopicbuintradayresult.go | 46 - ...aydataupdatetopicbuintradayscheduledata.go | 17 - ...radaydataupdatetopicbuschedulereference.go | 21 - ...updatetopicbushorttermforecastreference.go | 25 - ...etopicintradayperformancepredictiondata.go | 25 - .../wfmbuintradaydataupdatetopiclocaldate.go | 29 - ...icbulkshifttradestateupdatenotification.go | 29 - ...iontopicbulkshifttradestateupdateresult.go | 38 - ...cbulkshifttradestateupdateresultlisting.go | 17 - ...destateupdatenotificationtopiclocaldate.go | 29 - ...ateupdatenotificationtopicuserreference.go | 17 - ...ficationtopicwfmversionedentitymetadata.go | 26 - ...topicbuschedulesearchresultnotification.go | 25 - ...fmbuscheduleruntopicbuschedulereference.go | 21 - .../wfmbuscheduleruntopicbuschedulerun.go | 49 - ...opicbuschedulingrunprogressnotification.go | 25 - .../wfmbuscheduleruntopiclocaldate.go | 29 - .../wfmbuscheduleruntopicuserreference.go | 17 - ...topicbuschedulesearchresultnotification.go | 25 - ...uletopicbumanagementunitschedulesummary.go | 34 - ...etopicbuschedulegenerationresultsummary.go | 25 - .../wfmbuscheduletopicbuschedulemetadata.go | 49 - ...fmbuscheduletopicbuschedulenotification.go | 29 - ...heduletopicbushorttermforecastreference.go | 25 - .../wfmbuscheduletopiclocaldate.go | 29 - .../wfmbuscheduletopicmanagementunit.go | 17 - .../wfmbuscheduletopicuserreference.go | 17 - ...scheduletopicwfmversionedentitymetadata.go | 26 - ...copycompletetopicbuforecastmodification.go | 57 - ...astcopycompletetopicbushorttermforecast.go | 66 - ...etetopicbushorttermforecastnotification.go | 25 - ...pycompletetopicforecastsourcedaypointer.go | 33 - ...etetopicmodificationintervaloffsetvalue.go | 21 - ...mforecastcopycompletetopicuserreference.go | 17 - ...completetopicwfmversionedentitymetadata.go | 26 - ...rateprogresstopicbuforecastmodification.go | 57 - ...enerateprogresstopicbushorttermforecast.go | 66 - ...teprogresstopicforecastsourcedaypointer.go | 33 - ...bushorttermforecastprogressnotification.go | 29 - ...esstopicmodificationintervaloffsetvalue.go | 21 - ...ecastgenerateprogresstopicuserreference.go | 17 - ...progresstopicwfmversionedentitymetadata.go | 26 - ...portcompletetopicbuforecastmodification.go | 57 - ...timportcompletetopicbushorttermforecast.go | 66 - ...etetopicbushorttermforecastnotification.go | 25 - ...rtcompletetopicforecastsourcedaypointer.go | 33 - ...etetopicmodificationintervaloffsetvalue.go | 21 - ...orecastimportcompletetopicuserreference.go | 17 - ...completetopicwfmversionedentitymetadata.go | 26 - ...datecompletetopicbuforecastmodification.go | 57 - ...tupdatecompletetopicbushorttermforecast.go | 66 - ...etetopicbushorttermforecastnotification.go | 25 - ...tecompletetopicforecastsourcedaypointer.go | 33 - ...etetopicmodificationintervaloffsetvalue.go | 21 - ...orecastupdatecompletetopicuserreference.go | 17 - ...completetopicwfmversionedentitymetadata.go | 26 - .../wfmbusinessunitreference.go | 21 - ...forecastmodificationintervaloffsetvalue.go | 21 - ...icaladherencecalculationscompletenotice.go | 29 - .../wfmhistoricaladherencequery.go | 38 - .../wfmhistoricaladherencequeryforusers.go | 34 - .../wfmhistoricaladherenceresponse.go | 33 - .../wfmhistoricaladherenceresultwrapper.go | 25 - ...chistoricaldatauploadpurgerequestupdate.go | 17 - ...caldatauploadrequeststatustopicdatetime.go | 29 - ...stopichistoricaldatauploadrequestupdate.go | 45 - ...ntradaydataupdatetopicintradaydatagroup.go | 41 - ...tradaydataupdatetopicintradaydataupdate.go | 42 - ...adaydataupdatetopicintradayforecastdata.go | 25 - ...aupdatetopicintradayhistoricalagentdata.go | 21 - ...aupdatetopicintradayhistoricalqueuedata.go | 45 - ...fmintradaydataupdatetopicintradaymetric.go | 21 - ...cintradayperformancepredictionagentdata.go | 17 - ...cintradayperformancepredictionqueuedata.go | 25 - ...adaydataupdatetopicintradayscheduledata.go | 21 - .../wfmintradayplanninggrouplisting.go | 21 - ...fmmoveagentscompletetopicmanagementunit.go | 17 - ...wfmmoveagentscompletetopicuserreference.go | 17 - ...moveagentscompletetopicwfmmoveagentdata.go | 21 - ...gentscompletetopicwfmmoveagentscomplete.go | 25 - .../wfmmovemanagementunittopicbusinessunit.go | 17 - ...unittopicmovemanagementunitnotification.go | 21 - .../platformclientv2/wfmschedulereference.go | 30 - ...wfmscheduletopicwfmschedulenotification.go | 33 - ...frequestupdatetopictimeoffrequestupdate.go | 77 - ...mtimeoffrequestupdatetopicuserreference.go | 17 - ...tailstopicwfmupdateagentdetailscomplete.go | 17 - .../platformclientv2/wfmuserentitylisting.go | 17 - build/platformclientv2/wfmusernotification.go | 50 - ...notificationtopicshifttradenotification.go | 46 - ...ficationtopictimeoffrequestnotification.go | 38 - .../wfmusernotificationtopicuserreference.go | 17 - ...sernotificationtopicwfmusernotification.go | 50 - ...leadherenceupdatedmutopicqueuereference.go | 17 - ...duleadherenceupdatedmutopicurireference.go | 21 - ...uleadherenceupdatedmutopicuserreference.go | 17 - ...datedmutopicuserscheduleadherenceupdate.go | 78 - ...adherenceupdatedteamtopicqueuereference.go | 17 - ...leadherenceupdatedteamtopicurireference.go | 21 - ...eadherenceupdatedteamtopicuserreference.go | 17 - ...tedteamtopicuserscheduleadherenceupdate.go | 78 - ...duleadherenceupdatedtopicqueuereference.go | 17 - ...heduleadherenceupdatedtopicurireference.go | 21 - ...eduleadherenceupdatedtopicuserreference.go | 17 - ...updatedtopicuserscheduleadherenceupdate.go | 78 - .../wfmversionedentitymetadata.go | 26 - build/platformclientv2/whatsappdefinition.go | 25 - build/platformclientv2/whatsappid.go | 21 - build/platformclientv2/whatsappintegration.go | 74 - .../whatsappintegrationentitylisting.go | 53 - .../whatsappintegrationrequest.go | 33 - .../whatsappintegrationupdaterequest.go | 37 - build/platformclientv2/widgetclientconfig.go | 29 - .../widgetclientconfigthirdparty.go | 13 - .../platformclientv2/widgetclientconfigv1.go | 21 - .../widgetclientconfigv1http.go | 21 - .../platformclientv2/widgetclientconfigv2.go | 13 - build/platformclientv2/widgetdeployment.go | 53 - .../widgetdeploymententitylisting.go | 25 - build/platformclientv2/widgetsapi.go | 378 - .../workforcemanagementapi.go | 8473 ------------ build/platformclientv2/workplan.go | 93 - build/platformclientv2/workplanactivity.go | 65 - .../workplanconfigurationviolationmessage.go | 25 - .../workplanconstraintconflictmessage.go | 21 - .../workplanconstraintmessage.go | 21 - .../workplanlistitemresponse.go | 97 - .../platformclientv2/workplanlistresponse.go | 17 - .../workplanpatternrequest.go | 17 - .../workplanpatternresponse.go | 17 - build/platformclientv2/workplanreference.go | 25 - .../workplanrotationagentresponse.go | 25 - .../workplanrotationlistresponse.go | 17 - .../workplanrotationreference.go | 21 - .../workplanrotationresponse.go | 49 - build/platformclientv2/workplanshift.go | 93 - .../workplanvalidationmessageargument.go | 21 - .../workplanvalidationrequest.go | 89 - build/platformclientv2/workspace.go | 62 - build/platformclientv2/workspacecreate.go | 25 - .../workspaceentitylisting.go | 53 - build/platformclientv2/workspacemember.go | 49 - .../workspacememberentitylisting.go | 53 - build/platformclientv2/workspacesummary.go | 21 - build/platformclientv2/wrapup.go | 42 - .../wrapupcodeentitylisting.go | 53 - build/platformclientv2/wrapupcodemapping.go | 46 - build/platformclientv2/wrapupcodereference.go | 17 - .../platformclientv2/writabledialercontact.go | 33 - build/platformclientv2/writabledivision.go | 25 - build/platformclientv2/writableentity.go | 17 - docs/index.md | 29 +- docs/releaseNotes.md | 454 +- platformclientv2/analyticsevaluation.go | 8 +- platformclientv2/apiclient.go | 48 +- platformclientv2/apiresponse.go | 3 +- platformclientv2/architectapi.go | 14 +- platformclientv2/arraynode.go | 24 +- platformclientv2/authorizationapi.go | 2 +- platformclientv2/availabletopic.go | 4 + .../baseprogramentity.go | 6 +- .../basetopicentitiy.go | 6 +- platformclientv2/configuration.go | 67 +- platformclientv2/conversationsapi.go | 64 +- .../createmanagementunitapirequest.go | 2 +- platformclientv2/createworkplan.go | 44 + platformclientv2/createworkplanactivity.go | 8 + platformclientv2/createworkplanshift.go | 8 + platformclientv2/datatable.go | 4 + platformclientv2/domainorganizationrole.go | 8 +- .../domainorganizationrolecreate.go | 8 +- .../domainorganizationroleupdate.go | 8 +- platformclientv2/externalsegment.go | 25 + .../generalprogramjob.go | 22 +- platformclientv2/generalprogramjobrequest.go | 21 + .../generaltopic.go | 6 +- .../generaltopicsentitylisting.go | 17 + .../go.mod | 0 .../go.sum | 0 platformclientv2/historylisting.go | 8 +- platformclientv2/journeysegment.go | 4 + platformclientv2/jsonnode.go | 24 +- .../listedprogram.go | 30 +- platformclientv2/listedtopic.go | 66 + platformclientv2/managementunit.go | 4 + platformclientv2/managementunitlisting.go | 16 +- platformclientv2/objectsapi.go | 2 +- .../patchexternalsegment.go | 12 +- platformclientv2/patchsegment.go | 4 + platformclientv2/permissiondetails.go | 29 + platformclientv2/phrase.go | 25 + platformclientv2/program.go | 58 + .../programjob.go | 26 +- platformclientv2/programjobrequest.go | 17 + platformclientv2/programrequest.go | 29 + .../programsentitylisting.go | 16 +- .../retry_test.go | 0 platformclientv2/routingapi.go | 30 +- platformclientv2/routingdata.go | 4 + platformclientv2/schedulingsettingsrequest.go | 8 + .../schedulingsettingsresponse.go | 8 + platformclientv2/speechtextanalyticsapi.go | 1467 ++- platformclientv2/supportedcontentreference.go | 29 + platformclientv2/topic.go | 74 + .../topicjob.go | 24 +- platformclientv2/topicjobrequest.go | 17 + platformclientv2/topicrequest.go | 45 + .../topicsentitylisting.go | 16 +- .../unpublishedprogramsentitylisting.go | 33 + platformclientv2/usersearchrequest.go | 2 +- ...menttopiclearningassignmentnotification.go | 4 + platformclientv2/workforcemanagementapi.go | 2 +- platformclientv2/workplan.go | 46 +- platformclientv2/workplanactivity.go | 8 + platformclientv2/workplanlistitemresponse.go | 46 +- platformclientv2/workplanshift.go | 8 + platformclientv2/workplanvalidationrequest.go | 46 +- releaseNotes.md | 396 +- swagger.json | 2 +- version.json | 8 +- 2495 files changed, 3048 insertions(+), 220606 deletions(-) delete mode 100644 build/.gitignore delete mode 100644 build/.swagger-codegen-ignore delete mode 100644 build/Makefile delete mode 100644 build/README.md delete mode 100644 build/docs/index.md delete mode 100644 build/docs/releaseNotes.md delete mode 100644 build/platformclientv2/action.go delete mode 100644 build/platformclientv2/actionconfig.go delete mode 100644 build/platformclientv2/actioncontract.go delete mode 100644 build/platformclientv2/actioncontractinput.go delete mode 100644 build/platformclientv2/actionentitylisting.go delete mode 100644 build/platformclientv2/actioninput.go delete mode 100644 build/platformclientv2/actionmap.go delete mode 100644 build/platformclientv2/actionmapaction.go delete mode 100644 build/platformclientv2/actionmapactiontemplate.go delete mode 100644 build/platformclientv2/actionmaplisting.go delete mode 100644 build/platformclientv2/actionmapschedulegroup.go delete mode 100644 build/platformclientv2/actionmapschedulegroups.go delete mode 100644 build/platformclientv2/actionoutput.go delete mode 100644 build/platformclientv2/actionproperties.go delete mode 100644 build/platformclientv2/actions.go delete mode 100644 build/platformclientv2/actionsurvey.go delete mode 100644 build/platformclientv2/actiontarget.go delete mode 100644 build/platformclientv2/actiontargetlisting.go delete mode 100644 build/platformclientv2/actiontemplate.go delete mode 100644 build/platformclientv2/actiontemplatelisting.go delete mode 100644 build/platformclientv2/activation.go delete mode 100644 build/platformclientv2/activealertcount.go delete mode 100644 build/platformclientv2/activitycode.go delete mode 100644 build/platformclientv2/activitycodecontainer.go delete mode 100644 build/platformclientv2/acwsettings.go delete mode 100644 build/platformclientv2/addconversationrequest.go delete mode 100644 build/platformclientv2/addconversationresponse.go delete mode 100644 build/platformclientv2/additionalmessage.go delete mode 100644 build/platformclientv2/address.go delete mode 100644 build/platformclientv2/addressableentityref.go delete mode 100644 build/platformclientv2/addressablelicensedefinition.go delete mode 100644 build/platformclientv2/addshifttraderequest.go delete mode 100644 build/platformclientv2/addworkplanrotationagentrequest.go delete mode 100644 build/platformclientv2/addworkplanrotationrequest.go delete mode 100644 build/platformclientv2/adfs.go delete mode 100644 build/platformclientv2/adherencesettings.go delete mode 100644 build/platformclientv2/adhocrecordingtopicconversationdata.go delete mode 100644 build/platformclientv2/adhocrecordingtopiclockdata.go delete mode 100644 build/platformclientv2/adhocrecordingtopicrecordingdatav2.go delete mode 100644 build/platformclientv2/adhocrecordingtopicworkspacedata.go delete mode 100644 build/platformclientv2/adjacents.go delete mode 100644 build/platformclientv2/admintimeoffrequestpatch.go delete mode 100644 build/platformclientv2/aftercallwork.go delete mode 100644 build/platformclientv2/agent.go delete mode 100644 build/platformclientv2/agentactivity.go delete mode 100644 build/platformclientv2/agentactivitychangedtopicagentactivity.go delete mode 100644 build/platformclientv2/agentactivitychangedtopicorganizationpresence.go delete mode 100644 build/platformclientv2/agentactivitychangedtopicoutofoffice.go delete mode 100644 build/platformclientv2/agentactivitychangedtopicpresence.go delete mode 100644 build/platformclientv2/agentactivitychangedtopicroutingstatus.go delete mode 100644 build/platformclientv2/agentactivityentitylisting.go delete mode 100644 build/platformclientv2/agentevaluatoractivity.go delete mode 100644 build/platformclientv2/agenttimeoffrequestpatch.go delete mode 100644 build/platformclientv2/aggregatemetricdata.go delete mode 100644 build/platformclientv2/aggregateviewdata.go delete mode 100644 build/platformclientv2/aggregationrange.go delete mode 100644 build/platformclientv2/aggregationresult.go delete mode 100644 build/platformclientv2/aggregationresultentry.go delete mode 100644 build/platformclientv2/alertingapi.go delete mode 100644 build/platformclientv2/amazonlexrequest.go delete mode 100644 build/platformclientv2/analyticsapi.go delete mode 100644 build/platformclientv2/analyticsconversation.go delete mode 100644 build/platformclientv2/analyticsconversationasyncqueryresponse.go delete mode 100644 build/platformclientv2/analyticsconversationqueryresponse.go delete mode 100644 build/platformclientv2/analyticsconversationsegment.go delete mode 100644 build/platformclientv2/analyticsconversationwithoutattributes.go delete mode 100644 build/platformclientv2/analyticsconversationwithoutattributesmultigetresponse.go delete mode 100644 build/platformclientv2/analyticsevaluation.go delete mode 100644 build/platformclientv2/analyticsflow.go delete mode 100644 build/platformclientv2/analyticsflowoutcome.go delete mode 100644 build/platformclientv2/analyticsmediaendpointstat.go delete mode 100644 build/platformclientv2/analyticsparticipant.go delete mode 100644 build/platformclientv2/analyticsparticipantwithoutattributes.go delete mode 100644 build/platformclientv2/analyticsproperty.go delete mode 100644 build/platformclientv2/analyticsproposedagent.go delete mode 100644 build/platformclientv2/analyticsqueryaggregation.go delete mode 100644 build/platformclientv2/analyticsresolution.go delete mode 100644 build/platformclientv2/analyticsroutingstatusrecord.go delete mode 100644 build/platformclientv2/analyticsscoredagent.go delete mode 100644 build/platformclientv2/analyticssession.go delete mode 100644 build/platformclientv2/analyticssessionmetric.go delete mode 100644 build/platformclientv2/analyticssurvey.go delete mode 100644 build/platformclientv2/analyticsuserdetail.go delete mode 100644 build/platformclientv2/analyticsuserdetailsasyncqueryresponse.go delete mode 100644 build/platformclientv2/analyticsuserdetailsqueryresponse.go delete mode 100644 build/platformclientv2/analyticsuserpresencerecord.go delete mode 100644 build/platformclientv2/annotation.go delete mode 100644 build/platformclientv2/answeroption.go delete mode 100644 build/platformclientv2/apiclient.go delete mode 100644 build/platformclientv2/apiresponse.go delete mode 100644 build/platformclientv2/apiusagequery.go delete mode 100644 build/platformclientv2/apiusagequeryresult.go delete mode 100644 build/platformclientv2/apiusagerow.go delete mode 100644 build/platformclientv2/architectapi.go delete mode 100644 build/platformclientv2/architectdependencytrackingbuildnotificationclient.go delete mode 100644 build/platformclientv2/architectdependencytrackingbuildnotificationdependencytrackingbuildnotification.go delete mode 100644 build/platformclientv2/architectdependencytrackingbuildnotificationhomeorganization.go delete mode 100644 build/platformclientv2/architectdependencytrackingbuildnotificationuser.go delete mode 100644 build/platformclientv2/architectflowfields.go delete mode 100644 build/platformclientv2/architectflownotificationarchitectoperation.go delete mode 100644 build/platformclientv2/architectflownotificationclient.go delete mode 100644 build/platformclientv2/architectflownotificationerrordetail.go delete mode 100644 build/platformclientv2/architectflownotificationerrormessageparams.go delete mode 100644 build/platformclientv2/architectflownotificationflownotification.go delete mode 100644 build/platformclientv2/architectflownotificationflowversion.go delete mode 100644 build/platformclientv2/architectflownotificationhomeorganization.go delete mode 100644 build/platformclientv2/architectflownotificationuser.go delete mode 100644 build/platformclientv2/architectflowoutcomenotificationarchitectoperation.go delete mode 100644 build/platformclientv2/architectflowoutcomenotificationclient.go delete mode 100644 build/platformclientv2/architectflowoutcomenotificationerrordetail.go delete mode 100644 build/platformclientv2/architectflowoutcomenotificationerrormessageparams.go delete mode 100644 build/platformclientv2/architectflowoutcomenotificationflowoutcomenotification.go delete mode 100644 build/platformclientv2/architectflowoutcomenotificationhomeorganization.go delete mode 100644 build/platformclientv2/architectflowoutcomenotificationuser.go delete mode 100644 build/platformclientv2/architectpromptnotificationarchitectoperation.go delete mode 100644 build/platformclientv2/architectpromptnotificationclient.go delete mode 100644 build/platformclientv2/architectpromptnotificationerrordetail.go delete mode 100644 build/platformclientv2/architectpromptnotificationerrormessageparams.go delete mode 100644 build/platformclientv2/architectpromptnotificationhomeorganization.go delete mode 100644 build/platformclientv2/architectpromptnotificationpromptnotification.go delete mode 100644 build/platformclientv2/architectpromptnotificationuser.go delete mode 100644 build/platformclientv2/architectpromptresourcenotificationpromptresourcenotification.go delete mode 100644 build/platformclientv2/architectsystempromptresourcenotificationsystempromptresourcenotification.go delete mode 100644 build/platformclientv2/archiveretention.go delete mode 100644 build/platformclientv2/arraynode.go delete mode 100644 build/platformclientv2/assignedwrapupcode.go delete mode 100644 build/platformclientv2/assignmentgroup.go delete mode 100644 build/platformclientv2/asyncconversationquery.go delete mode 100644 build/platformclientv2/asyncforecastoperationresult.go delete mode 100644 build/platformclientv2/asyncintradayresponse.go delete mode 100644 build/platformclientv2/asyncqueryresponse.go delete mode 100644 build/platformclientv2/asyncquerystatus.go delete mode 100644 build/platformclientv2/asyncuserdetailsquery.go delete mode 100644 build/platformclientv2/attachment.go delete mode 100644 build/platformclientv2/attemptlimits.go delete mode 100644 build/platformclientv2/attemptlimitsentitylisting.go delete mode 100644 build/platformclientv2/attributefilteritem.go delete mode 100644 build/platformclientv2/atzmtimeslot.go delete mode 100644 build/platformclientv2/atzmtimeslotwithtimezone.go delete mode 100644 build/platformclientv2/auditapi.go delete mode 100644 build/platformclientv2/auditchange.go delete mode 100644 build/platformclientv2/auditentity.go delete mode 100644 build/platformclientv2/auditentityreference.go delete mode 100644 build/platformclientv2/auditfacet.go delete mode 100644 build/platformclientv2/auditfilter.go delete mode 100644 build/platformclientv2/auditlogmessage.go delete mode 100644 build/platformclientv2/auditmessage.go delete mode 100644 build/platformclientv2/auditqueryentity.go delete mode 100644 build/platformclientv2/auditqueryexecutionresultsresponse.go delete mode 100644 build/platformclientv2/auditqueryexecutionstatusresponse.go delete mode 100644 build/platformclientv2/auditqueryfilter.go delete mode 100644 build/platformclientv2/auditqueryrequest.go delete mode 100644 build/platformclientv2/auditqueryresponse.go delete mode 100644 build/platformclientv2/auditqueryservice.go delete mode 100644 build/platformclientv2/auditqueryservicemapping.go delete mode 100644 build/platformclientv2/auditquerysort.go delete mode 100644 build/platformclientv2/auditrealtimequeryrequest.go delete mode 100644 build/platformclientv2/auditrealtimequeryresultsresponse.go delete mode 100644 build/platformclientv2/auditsearchresult.go delete mode 100644 build/platformclientv2/audituser.go delete mode 100644 build/platformclientv2/authorizationapi.go delete mode 100644 build/platformclientv2/authzdivision.go delete mode 100644 build/platformclientv2/authzdivisionentitylisting.go delete mode 100644 build/platformclientv2/authzdivisiongrantentitylisting.go delete mode 100644 build/platformclientv2/authzgrant.go delete mode 100644 build/platformclientv2/authzgrantpolicy.go delete mode 100644 build/platformclientv2/authzgrantrole.go delete mode 100644 build/platformclientv2/authzsubject.go delete mode 100644 build/platformclientv2/automatictimezonemappingsettings.go delete mode 100644 build/platformclientv2/availablelanguagelist.go delete mode 100644 build/platformclientv2/availabletopic.go delete mode 100644 build/platformclientv2/availabletopicentitylisting.go delete mode 100644 build/platformclientv2/availabletranslations.go delete mode 100644 build/platformclientv2/batchdownloadjobresult.go delete mode 100644 build/platformclientv2/batchdownloadjobstatusresult.go delete mode 100644 build/platformclientv2/batchdownloadjobsubmission.go delete mode 100644 build/platformclientv2/batchdownloadjobsubmissionresult.go delete mode 100644 build/platformclientv2/batchdownloadrequest.go delete mode 100644 build/platformclientv2/billingapi.go delete mode 100644 build/platformclientv2/billingusage.go delete mode 100644 build/platformclientv2/billingusagereport.go delete mode 100644 build/platformclientv2/billingusageresource.go delete mode 100644 build/platformclientv2/biography.go delete mode 100644 build/platformclientv2/buabandonrate.go delete mode 100644 build/platformclientv2/buagentscheduleactivity.go delete mode 100644 build/platformclientv2/buagentschedulehistorychange.go delete mode 100644 build/platformclientv2/buagentschedulehistorychangemetadata.go delete mode 100644 build/platformclientv2/buagentschedulehistorydeletedchange.go delete mode 100644 build/platformclientv2/buagentschedulehistorydroppedchange.go delete mode 100644 build/platformclientv2/buagentschedulehistoryresponse.go delete mode 100644 build/platformclientv2/buagentschedulepublishedschedulereference.go delete mode 100644 build/platformclientv2/buagentschedulequeryresponse.go delete mode 100644 build/platformclientv2/buagentschedulerescheduleresponse.go delete mode 100644 build/platformclientv2/buagentschedulesearchresponse.go delete mode 100644 build/platformclientv2/buagentscheduleshift.go delete mode 100644 build/platformclientv2/buagentschedulesqueryresponse.go delete mode 100644 build/platformclientv2/buagentschedulessearchresponse.go delete mode 100644 build/platformclientv2/buagentscheduleupdate.go delete mode 100644 build/platformclientv2/buasyncagentschedulesqueryresponse.go delete mode 100644 build/platformclientv2/buasyncagentschedulessearchresponse.go delete mode 100644 build/platformclientv2/buasyncscheduleresponse.go delete mode 100644 build/platformclientv2/buasyncschedulerunresponse.go delete mode 100644 build/platformclientv2/buaveragespeedofanswer.go delete mode 100644 build/platformclientv2/bucopyschedulerequest.go delete mode 100644 build/platformclientv2/bucreateblankschedulerequest.go delete mode 100644 build/platformclientv2/bucurrentagentschedulesearchresponse.go delete mode 100644 build/platformclientv2/buforecastgenerationplanninggroupresult.go delete mode 100644 build/platformclientv2/buforecastgenerationresult.go delete mode 100644 build/platformclientv2/buforecastmodification.go delete mode 100644 build/platformclientv2/buforecastresult.go delete mode 100644 build/platformclientv2/buforecastresultresponse.go delete mode 100644 build/platformclientv2/buforecasttimeseriesresult.go delete mode 100644 build/platformclientv2/bufulldaytimeoffmarker.go delete mode 100644 build/platformclientv2/bugenerateschedulerequest.go delete mode 100644 build/platformclientv2/bugetcurrentagentschedulerequest.go delete mode 100644 build/platformclientv2/buheadcountforecast.go delete mode 100644 build/platformclientv2/buheadcountforecastresponse.go delete mode 100644 build/platformclientv2/buintradaydatagroup.go delete mode 100644 build/platformclientv2/buintradayforecastdata.go delete mode 100644 build/platformclientv2/buintradayresponse.go delete mode 100644 build/platformclientv2/buintradayscheduledata.go delete mode 100644 build/platformclientv2/bulkshifttradestateupdaterequest.go delete mode 100644 build/platformclientv2/bulkupdateshifttradestaterequestitem.go delete mode 100644 build/platformclientv2/bulkupdateshifttradestateresponse.go delete mode 100644 build/platformclientv2/bulkupdateshifttradestateresult.go delete mode 100644 build/platformclientv2/bulkupdateshifttradestateresultitem.go delete mode 100644 build/platformclientv2/bullseye.go delete mode 100644 build/platformclientv2/bumanagementunitschedulesummary.go delete mode 100644 build/platformclientv2/buplanninggroupheadcountforecast.go delete mode 100644 build/platformclientv2/buqueryagentschedulesrequest.go delete mode 100644 build/platformclientv2/burescheduleagentscheduleresult.go delete mode 100644 build/platformclientv2/bureschedulerequest.go delete mode 100644 build/platformclientv2/burescheduleresult.go delete mode 100644 build/platformclientv2/buschedulelisting.go delete mode 100644 build/platformclientv2/buschedulelistitem.go delete mode 100644 build/platformclientv2/buschedulemetadata.go delete mode 100644 build/platformclientv2/buschedulereference.go delete mode 100644 build/platformclientv2/buschedulereferenceformuroute.go delete mode 100644 build/platformclientv2/buschedulerun.go delete mode 100644 build/platformclientv2/buschedulerunlisting.go delete mode 100644 build/platformclientv2/busearchagentschedulesrequest.go delete mode 100644 build/platformclientv2/buservicelevel.go delete mode 100644 build/platformclientv2/bushorttermforecast.go delete mode 100644 build/platformclientv2/bushorttermforecastingsettings.go delete mode 100644 build/platformclientv2/bushorttermforecastlisting.go delete mode 100644 build/platformclientv2/bushorttermforecastlistitem.go delete mode 100644 build/platformclientv2/bushorttermforecastreference.go delete mode 100644 build/platformclientv2/businessunit.go delete mode 100644 build/platformclientv2/businessunitactivitycode.go delete mode 100644 build/platformclientv2/businessunitactivitycodelisting.go delete mode 100644 build/platformclientv2/businessunitlisting.go delete mode 100644 build/platformclientv2/businessunitlistitem.go delete mode 100644 build/platformclientv2/businessunitreference.go delete mode 100644 build/platformclientv2/businessunitsettings.go delete mode 100644 build/platformclientv2/buttoncomponent.go delete mode 100644 build/platformclientv2/calibration.go delete mode 100644 build/platformclientv2/calibrationassignment.go delete mode 100644 build/platformclientv2/calibrationcreate.go delete mode 100644 build/platformclientv2/calibrationentitylisting.go delete mode 100644 build/platformclientv2/call.go delete mode 100644 build/platformclientv2/callablecontactsdiagnostic.go delete mode 100644 build/platformclientv2/callabletime.go delete mode 100644 build/platformclientv2/callabletimeset.go delete mode 100644 build/platformclientv2/callabletimesetentitylisting.go delete mode 100644 build/platformclientv2/callablewindow.go delete mode 100644 build/platformclientv2/callback.go delete mode 100644 build/platformclientv2/callbackbasic.go delete mode 100644 build/platformclientv2/callbackconversation.go delete mode 100644 build/platformclientv2/callbackconversationentitylisting.go delete mode 100644 build/platformclientv2/callbackidentifier.go delete mode 100644 build/platformclientv2/callbackmediaparticipant.go delete mode 100644 build/platformclientv2/callbasic.go delete mode 100644 build/platformclientv2/callcommand.go delete mode 100644 build/platformclientv2/callconversation.go delete mode 100644 build/platformclientv2/callconversationentitylisting.go delete mode 100644 build/platformclientv2/callforwarding.go delete mode 100644 build/platformclientv2/callforwardingeventcall.go delete mode 100644 build/platformclientv2/callforwardingeventcallforwarding.go delete mode 100644 build/platformclientv2/callforwardingeventtarget.go delete mode 100644 build/platformclientv2/callforwardingeventuser.go delete mode 100644 build/platformclientv2/callhistoryconversation.go delete mode 100644 build/platformclientv2/callhistoryconversationentitylisting.go delete mode 100644 build/platformclientv2/callhistoryparticipant.go delete mode 100644 build/platformclientv2/callmediaparticipant.go delete mode 100644 build/platformclientv2/callmediapolicy.go delete mode 100644 build/platformclientv2/callmediapolicyconditions.go delete mode 100644 build/platformclientv2/callrecord.go delete mode 100644 build/platformclientv2/callroute.go delete mode 100644 build/platformclientv2/calltarget.go delete mode 100644 build/platformclientv2/calltoaction.go delete mode 100644 build/platformclientv2/campaign.go delete mode 100644 build/platformclientv2/campaigndiagnostics.go delete mode 100644 build/platformclientv2/campaigndivisionview.go delete mode 100644 build/platformclientv2/campaigndivisionviewlisting.go delete mode 100644 build/platformclientv2/campaignentitylisting.go delete mode 100644 build/platformclientv2/campaigninteraction.go delete mode 100644 build/platformclientv2/campaigninteractions.go delete mode 100644 build/platformclientv2/campaignprogress.go delete mode 100644 build/platformclientv2/campaignrule.go delete mode 100644 build/platformclientv2/campaignruleaction.go delete mode 100644 build/platformclientv2/campaignruleactionentities.go delete mode 100644 build/platformclientv2/campaignrulecondition.go delete mode 100644 build/platformclientv2/campaignruleentities.go delete mode 100644 build/platformclientv2/campaignruleentitylisting.go delete mode 100644 build/platformclientv2/campaignruleparameters.go delete mode 100644 build/platformclientv2/campaignschedule.go delete mode 100644 build/platformclientv2/campaignsequence.go delete mode 100644 build/platformclientv2/campaignsequenceentitylisting.go delete mode 100644 build/platformclientv2/campaignstats.go delete mode 100644 build/platformclientv2/campaigntimeslot.go delete mode 100644 build/platformclientv2/category.go delete mode 100644 build/platformclientv2/categorylisting.go delete mode 100644 build/platformclientv2/certificate.go delete mode 100644 build/platformclientv2/certificateauthorityentitylisting.go delete mode 100644 build/platformclientv2/certificatedetails.go delete mode 100644 build/platformclientv2/change.go delete mode 100644 build/platformclientv2/changemypasswordrequest.go delete mode 100644 build/platformclientv2/changepasswordrequest.go delete mode 100644 build/platformclientv2/channel.go delete mode 100644 build/platformclientv2/channelentitylisting.go delete mode 100644 build/platformclientv2/channeltopic.go delete mode 100644 build/platformclientv2/channeltopicentitylisting.go delete mode 100644 build/platformclientv2/chat.go delete mode 100644 build/platformclientv2/chatapi.go delete mode 100644 build/platformclientv2/chatbadgetopicbadgeentity.go delete mode 100644 build/platformclientv2/chatbadgetopicchatbadge.go delete mode 100644 build/platformclientv2/chatconversation.go delete mode 100644 build/platformclientv2/chatconversationentitylisting.go delete mode 100644 build/platformclientv2/chatmediaparticipant.go delete mode 100644 build/platformclientv2/chatmediapolicy.go delete mode 100644 build/platformclientv2/chatmediapolicyconditions.go delete mode 100644 build/platformclientv2/chatmessage.go delete mode 100644 build/platformclientv2/chatmessageuser.go delete mode 100644 build/platformclientv2/chatsettings.go delete mode 100644 build/platformclientv2/clientapp.go delete mode 100644 build/platformclientv2/clientappconfigurationinfo.go delete mode 100644 build/platformclientv2/clientappentitylisting.go delete mode 100644 build/platformclientv2/closebuttonstyleproperties.go delete mode 100644 build/platformclientv2/coachingannotation.go delete mode 100644 build/platformclientv2/coachingannotationcreaterequest.go delete mode 100644 build/platformclientv2/coachingannotationlist.go delete mode 100644 build/platformclientv2/coachingapi.go delete mode 100644 build/platformclientv2/coachingappointmentaggregaterequest.go delete mode 100644 build/platformclientv2/coachingappointmentaggregateresponse.go delete mode 100644 build/platformclientv2/coachingappointmentreference.go delete mode 100644 build/platformclientv2/coachingappointmentresponse.go delete mode 100644 build/platformclientv2/coachingappointmentresponselist.go delete mode 100644 build/platformclientv2/coachingappointmentstatusrequest.go delete mode 100644 build/platformclientv2/coachingappointmentstatusresponse.go delete mode 100644 build/platformclientv2/coachingappointmentstatusresponselist.go delete mode 100644 build/platformclientv2/coachingnotification.go delete mode 100644 build/platformclientv2/coachingnotificationlist.go delete mode 100644 build/platformclientv2/cobrowseconversation.go delete mode 100644 build/platformclientv2/cobrowseconversationentitylisting.go delete mode 100644 build/platformclientv2/cobrowsemediaparticipant.go delete mode 100644 build/platformclientv2/cobrowsesession.go delete mode 100644 build/platformclientv2/commandstatus.go delete mode 100644 build/platformclientv2/commandstatusentitylisting.go delete mode 100644 build/platformclientv2/commoncampaign.go delete mode 100644 build/platformclientv2/commoncampaigndivisionview.go delete mode 100644 build/platformclientv2/commoncampaigndivisionviewentitylisting.go delete mode 100644 build/platformclientv2/commoncampaignentitylisting.go delete mode 100644 build/platformclientv2/condition.go delete mode 100644 build/platformclientv2/configuration.go delete mode 100644 build/platformclientv2/connectrate.go delete mode 100644 build/platformclientv2/constraintconflictmessage.go delete mode 100644 build/platformclientv2/consulttransfer.go delete mode 100644 build/platformclientv2/consulttransferresponse.go delete mode 100644 build/platformclientv2/consulttransferupdate.go delete mode 100644 build/platformclientv2/consumedresourcesentitylisting.go delete mode 100644 build/platformclientv2/consumingresourcesentitylisting.go delete mode 100644 build/platformclientv2/contact.go delete mode 100644 build/platformclientv2/contactaddress.go delete mode 100644 build/platformclientv2/contactcallbackrequest.go delete mode 100644 build/platformclientv2/contactcentersettings.go delete mode 100644 build/platformclientv2/contactcolumntimezone.go delete mode 100644 build/platformclientv2/contactcolumntodataactionfieldmapping.go delete mode 100644 build/platformclientv2/contactlist.go delete mode 100644 build/platformclientv2/contactlistdivisionview.go delete mode 100644 build/platformclientv2/contactlistdivisionviewlisting.go delete mode 100644 build/platformclientv2/contactlistdownloadreadyexporturi.go delete mode 100644 build/platformclientv2/contactlistentitylisting.go delete mode 100644 build/platformclientv2/contactlistfilter.go delete mode 100644 build/platformclientv2/contactlistfilterclause.go delete mode 100644 build/platformclientv2/contactlistfilterentitylisting.go delete mode 100644 build/platformclientv2/contactlistfilterpredicate.go delete mode 100644 build/platformclientv2/contactlistfilterrange.go delete mode 100644 build/platformclientv2/contactlistimportstatusimportstatus.go delete mode 100644 build/platformclientv2/contactlisting.go delete mode 100644 build/platformclientv2/contactphonenumbercolumn.go delete mode 100644 build/platformclientv2/contactsort.go delete mode 100644 build/platformclientv2/contentactions.go delete mode 100644 build/platformclientv2/contentattachment.go delete mode 100644 build/platformclientv2/contentattributefilteritem.go delete mode 100644 build/platformclientv2/contentfacetfilteritem.go delete mode 100644 build/platformclientv2/contentfilteritem.go delete mode 100644 build/platformclientv2/contentgeneric.go delete mode 100644 build/platformclientv2/contentlist.go delete mode 100644 build/platformclientv2/contentlocation.go delete mode 100644 build/platformclientv2/contentmanagementapi.go delete mode 100644 build/platformclientv2/contentmanagementsingledocumenttopicdocumentdatav2.go delete mode 100644 build/platformclientv2/contentmanagementsingledocumenttopiclockdata.go delete mode 100644 build/platformclientv2/contentmanagementsingledocumenttopicuserdata.go delete mode 100644 build/platformclientv2/contentmanagementsingledocumenttopicworkspacedata.go delete mode 100644 build/platformclientv2/contentmanagementworkspacedocumentstopicdocumentdatav2.go delete mode 100644 build/platformclientv2/contentmanagementworkspacedocumentstopiclockdata.go delete mode 100644 build/platformclientv2/contentmanagementworkspacedocumentstopicuserdata.go delete mode 100644 build/platformclientv2/contentmanagementworkspacedocumentstopicworkspacedata.go delete mode 100644 build/platformclientv2/contentnotificationtemplate.go delete mode 100644 build/platformclientv2/contentoffer.go delete mode 100644 build/platformclientv2/contentofferstyleproperties.go delete mode 100644 build/platformclientv2/contentofferstylingconfiguration.go delete mode 100644 build/platformclientv2/contentpositionproperties.go delete mode 100644 build/platformclientv2/contentpostback.go delete mode 100644 build/platformclientv2/contentqueryrequest.go delete mode 100644 build/platformclientv2/contentquickreply.go delete mode 100644 build/platformclientv2/contentreaction.go delete mode 100644 build/platformclientv2/contentsortitem.go delete mode 100644 build/platformclientv2/context.go delete mode 100644 build/platformclientv2/contextentity.go delete mode 100644 build/platformclientv2/contextintent.go delete mode 100644 build/platformclientv2/contextpattern.go delete mode 100644 build/platformclientv2/conversation.go delete mode 100644 build/platformclientv2/conversationaggregatedatacontainer.go delete mode 100644 build/platformclientv2/conversationaggregatequeryclause.go delete mode 100644 build/platformclientv2/conversationaggregatequeryfilter.go delete mode 100644 build/platformclientv2/conversationaggregatequerypredicate.go delete mode 100644 build/platformclientv2/conversationaggregatequeryresponse.go delete mode 100644 build/platformclientv2/conversationaggregationquery.go delete mode 100644 build/platformclientv2/conversationaggregationview.go delete mode 100644 build/platformclientv2/conversationassociation.go delete mode 100644 build/platformclientv2/conversationbasic.go delete mode 100644 build/platformclientv2/conversationcallbackeventtopiccallbackconversation.go delete mode 100644 build/platformclientv2/conversationcallbackeventtopiccallbackmediaparticipant.go delete mode 100644 build/platformclientv2/conversationcallbackeventtopicconversationroutingdata.go delete mode 100644 build/platformclientv2/conversationcallbackeventtopicdetail.go delete mode 100644 build/platformclientv2/conversationcallbackeventtopicdialerpreview.go delete mode 100644 build/platformclientv2/conversationcallbackeventtopicerrorbody.go delete mode 100644 build/platformclientv2/conversationcallbackeventtopicjourneyaction.go delete mode 100644 build/platformclientv2/conversationcallbackeventtopicjourneyactionmap.go delete mode 100644 build/platformclientv2/conversationcallbackeventtopicjourneycontext.go delete mode 100644 build/platformclientv2/conversationcallbackeventtopicjourneycustomer.go delete mode 100644 build/platformclientv2/conversationcallbackeventtopicjourneycustomersession.go delete mode 100644 build/platformclientv2/conversationcallbackeventtopicphonenumbercolumn.go delete mode 100644 build/platformclientv2/conversationcallbackeventtopicscoredagent.go delete mode 100644 build/platformclientv2/conversationcallbackeventtopicurireference.go delete mode 100644 build/platformclientv2/conversationcallbackeventtopicvoicemail.go delete mode 100644 build/platformclientv2/conversationcallbackeventtopicwrapup.go delete mode 100644 build/platformclientv2/conversationcalleventtopiccallconversation.go delete mode 100644 build/platformclientv2/conversationcalleventtopiccallmediaparticipant.go delete mode 100644 build/platformclientv2/conversationcalleventtopicconversationroutingdata.go delete mode 100644 build/platformclientv2/conversationcalleventtopicdetail.go delete mode 100644 build/platformclientv2/conversationcalleventtopicerrorbody.go delete mode 100644 build/platformclientv2/conversationcalleventtopicfaxstatus.go delete mode 100644 build/platformclientv2/conversationcalleventtopicjourneyaction.go delete mode 100644 build/platformclientv2/conversationcalleventtopicjourneyactionmap.go delete mode 100644 build/platformclientv2/conversationcalleventtopicjourneycontext.go delete mode 100644 build/platformclientv2/conversationcalleventtopicjourneycustomer.go delete mode 100644 build/platformclientv2/conversationcalleventtopicjourneycustomersession.go delete mode 100644 build/platformclientv2/conversationcalleventtopicscoredagent.go delete mode 100644 build/platformclientv2/conversationcalleventtopicurireference.go delete mode 100644 build/platformclientv2/conversationcalleventtopicwrapup.go delete mode 100644 build/platformclientv2/conversationchat.go delete mode 100644 build/platformclientv2/conversationchateventtopicchatconversation.go delete mode 100644 build/platformclientv2/conversationchateventtopicchatmediaparticipant.go delete mode 100644 build/platformclientv2/conversationchateventtopicconversationroutingdata.go delete mode 100644 build/platformclientv2/conversationchateventtopicdetail.go delete mode 100644 build/platformclientv2/conversationchateventtopicerrorbody.go delete mode 100644 build/platformclientv2/conversationchateventtopicjourneyaction.go delete mode 100644 build/platformclientv2/conversationchateventtopicjourneyactionmap.go delete mode 100644 build/platformclientv2/conversationchateventtopicjourneycontext.go delete mode 100644 build/platformclientv2/conversationchateventtopicjourneycustomer.go delete mode 100644 build/platformclientv2/conversationchateventtopicjourneycustomersession.go delete mode 100644 build/platformclientv2/conversationchateventtopicscoredagent.go delete mode 100644 build/platformclientv2/conversationchateventtopicurireference.go delete mode 100644 build/platformclientv2/conversationchateventtopicwrapup.go delete mode 100644 build/platformclientv2/conversationcobrowseeventtopiccobrowseconversation.go delete mode 100644 build/platformclientv2/conversationcobrowseeventtopiccobrowsemediaparticipant.go delete mode 100644 build/platformclientv2/conversationcobrowseeventtopicconversationroutingdata.go delete mode 100644 build/platformclientv2/conversationcobrowseeventtopicdetail.go delete mode 100644 build/platformclientv2/conversationcobrowseeventtopicerrorbody.go delete mode 100644 build/platformclientv2/conversationcobrowseeventtopicjourneyaction.go delete mode 100644 build/platformclientv2/conversationcobrowseeventtopicjourneyactionmap.go delete mode 100644 build/platformclientv2/conversationcobrowseeventtopicjourneycontext.go delete mode 100644 build/platformclientv2/conversationcobrowseeventtopicjourneycustomer.go delete mode 100644 build/platformclientv2/conversationcobrowseeventtopicjourneycustomersession.go delete mode 100644 build/platformclientv2/conversationcobrowseeventtopicscoredagent.go delete mode 100644 build/platformclientv2/conversationcobrowseeventtopicurireference.go delete mode 100644 build/platformclientv2/conversationcobrowseeventtopicwrapup.go delete mode 100644 build/platformclientv2/conversationdeletionprotectionquery.go delete mode 100644 build/platformclientv2/conversationdetailqueryclause.go delete mode 100644 build/platformclientv2/conversationdetailqueryfilter.go delete mode 100644 build/platformclientv2/conversationdetailquerypredicate.go delete mode 100644 build/platformclientv2/conversationdetailsdatalakeavailabilitytopicdataavailabilitychangenotification.go delete mode 100644 build/platformclientv2/conversationdetailsdatalakeavailabilitytopicdatetime.go delete mode 100644 build/platformclientv2/conversationdivisionmembership.go delete mode 100644 build/platformclientv2/conversationemaileventtopicattachment.go delete mode 100644 build/platformclientv2/conversationemaileventtopicconversationroutingdata.go delete mode 100644 build/platformclientv2/conversationemaileventtopicdetail.go delete mode 100644 build/platformclientv2/conversationemaileventtopicemailconversation.go delete mode 100644 build/platformclientv2/conversationemaileventtopicemailmediaparticipant.go delete mode 100644 build/platformclientv2/conversationemaileventtopicerrorbody.go delete mode 100644 build/platformclientv2/conversationemaileventtopicjourneyaction.go delete mode 100644 build/platformclientv2/conversationemaileventtopicjourneyactionmap.go delete mode 100644 build/platformclientv2/conversationemaileventtopicjourneycontext.go delete mode 100644 build/platformclientv2/conversationemaileventtopicjourneycustomer.go delete mode 100644 build/platformclientv2/conversationemaileventtopicjourneycustomersession.go delete mode 100644 build/platformclientv2/conversationemaileventtopicscoredagent.go delete mode 100644 build/platformclientv2/conversationemaileventtopicurireference.go delete mode 100644 build/platformclientv2/conversationemaileventtopicwrapup.go delete mode 100644 build/platformclientv2/conversationentitylisting.go delete mode 100644 build/platformclientv2/conversationeventtopicaddress.go delete mode 100644 build/platformclientv2/conversationeventtopicaftercallwork.go delete mode 100644 build/platformclientv2/conversationeventtopicattachment.go delete mode 100644 build/platformclientv2/conversationeventtopiccall.go delete mode 100644 build/platformclientv2/conversationeventtopiccallback.go delete mode 100644 build/platformclientv2/conversationeventtopicchat.go delete mode 100644 build/platformclientv2/conversationeventtopiccobrowse.go delete mode 100644 build/platformclientv2/conversationeventtopicconversation.go delete mode 100644 build/platformclientv2/conversationeventtopicconversationroutingdata.go delete mode 100644 build/platformclientv2/conversationeventtopicdialerpreview.go delete mode 100644 build/platformclientv2/conversationeventtopicdisconnectreason.go delete mode 100644 build/platformclientv2/conversationeventtopicemail.go delete mode 100644 build/platformclientv2/conversationeventtopicerrordetails.go delete mode 100644 build/platformclientv2/conversationeventtopicfaxstatus.go delete mode 100644 build/platformclientv2/conversationeventtopicjourneyaction.go delete mode 100644 build/platformclientv2/conversationeventtopicjourneyactionmap.go delete mode 100644 build/platformclientv2/conversationeventtopicjourneycontext.go delete mode 100644 build/platformclientv2/conversationeventtopicjourneycustomer.go delete mode 100644 build/platformclientv2/conversationeventtopicjourneycustomersession.go delete mode 100644 build/platformclientv2/conversationeventtopicmessage.go delete mode 100644 build/platformclientv2/conversationeventtopicmessagedetails.go delete mode 100644 build/platformclientv2/conversationeventtopicmessagemedia.go delete mode 100644 build/platformclientv2/conversationeventtopicmessagesticker.go delete mode 100644 build/platformclientv2/conversationeventtopicparticipant.go delete mode 100644 build/platformclientv2/conversationeventtopicphonenumbercolumn.go delete mode 100644 build/platformclientv2/conversationeventtopicscoredagent.go delete mode 100644 build/platformclientv2/conversationeventtopicscreenshare.go delete mode 100644 build/platformclientv2/conversationeventtopicsocialexpression.go delete mode 100644 build/platformclientv2/conversationeventtopicurireference.go delete mode 100644 build/platformclientv2/conversationeventtopicvideo.go delete mode 100644 build/platformclientv2/conversationeventtopicvoicemail.go delete mode 100644 build/platformclientv2/conversationeventtopicwrapup.go delete mode 100644 build/platformclientv2/conversationmessageeventtopicconversationroutingdata.go delete mode 100644 build/platformclientv2/conversationmessageeventtopicdetail.go delete mode 100644 build/platformclientv2/conversationmessageeventtopicerrorbody.go delete mode 100644 build/platformclientv2/conversationmessageeventtopicjourneyaction.go delete mode 100644 build/platformclientv2/conversationmessageeventtopicjourneyactionmap.go delete mode 100644 build/platformclientv2/conversationmessageeventtopicjourneycontext.go delete mode 100644 build/platformclientv2/conversationmessageeventtopicjourneycustomer.go delete mode 100644 build/platformclientv2/conversationmessageeventtopicjourneycustomersession.go delete mode 100644 build/platformclientv2/conversationmessageeventtopicmessageconversation.go delete mode 100644 build/platformclientv2/conversationmessageeventtopicmessagedetails.go delete mode 100644 build/platformclientv2/conversationmessageeventtopicmessagemedia.go delete mode 100644 build/platformclientv2/conversationmessageeventtopicmessagemediaparticipant.go delete mode 100644 build/platformclientv2/conversationmessageeventtopicmessagesticker.go delete mode 100644 build/platformclientv2/conversationmessageeventtopicscoredagent.go delete mode 100644 build/platformclientv2/conversationmessageeventtopicurireference.go delete mode 100644 build/platformclientv2/conversationmessageeventtopicwrapup.go delete mode 100644 build/platformclientv2/conversationmetrics.go delete mode 100644 build/platformclientv2/conversationproperties.go delete mode 100644 build/platformclientv2/conversationquery.go delete mode 100644 build/platformclientv2/conversationreference.go delete mode 100644 build/platformclientv2/conversationroutingdata.go delete mode 100644 build/platformclientv2/conversationsapi.go delete mode 100644 build/platformclientv2/conversationscreenshareeventtopicconversationroutingdata.go delete mode 100644 build/platformclientv2/conversationscreenshareeventtopicdetail.go delete mode 100644 build/platformclientv2/conversationscreenshareeventtopicerrorbody.go delete mode 100644 build/platformclientv2/conversationscreenshareeventtopicjourneyaction.go delete mode 100644 build/platformclientv2/conversationscreenshareeventtopicjourneyactionmap.go delete mode 100644 build/platformclientv2/conversationscreenshareeventtopicjourneycontext.go delete mode 100644 build/platformclientv2/conversationscreenshareeventtopicjourneycustomer.go delete mode 100644 build/platformclientv2/conversationscreenshareeventtopicjourneycustomersession.go delete mode 100644 build/platformclientv2/conversationscreenshareeventtopicscoredagent.go delete mode 100644 build/platformclientv2/conversationscreenshareeventtopicscreenshareconversation.go delete mode 100644 build/platformclientv2/conversationscreenshareeventtopicscreensharemediaparticipant.go delete mode 100644 build/platformclientv2/conversationscreenshareeventtopicurireference.go delete mode 100644 build/platformclientv2/conversationscreenshareeventtopicwrapup.go delete mode 100644 build/platformclientv2/conversationsocialexpressioneventtopicconversationroutingdata.go delete mode 100644 build/platformclientv2/conversationsocialexpressioneventtopicdetail.go delete mode 100644 build/platformclientv2/conversationsocialexpressioneventtopicerrorbody.go delete mode 100644 build/platformclientv2/conversationsocialexpressioneventtopicjourneyaction.go delete mode 100644 build/platformclientv2/conversationsocialexpressioneventtopicjourneyactionmap.go delete mode 100644 build/platformclientv2/conversationsocialexpressioneventtopicjourneycontext.go delete mode 100644 build/platformclientv2/conversationsocialexpressioneventtopicjourneycustomer.go delete mode 100644 build/platformclientv2/conversationsocialexpressioneventtopicjourneycustomersession.go delete mode 100644 build/platformclientv2/conversationsocialexpressioneventtopicscoredagent.go delete mode 100644 build/platformclientv2/conversationsocialexpressioneventtopicsocialconversation.go delete mode 100644 build/platformclientv2/conversationsocialexpressioneventtopicsocialmediaparticipant.go delete mode 100644 build/platformclientv2/conversationsocialexpressioneventtopicurireference.go delete mode 100644 build/platformclientv2/conversationsocialexpressioneventtopicwrapup.go delete mode 100644 build/platformclientv2/conversationuser.go delete mode 100644 build/platformclientv2/conversationvideoeventtopicconversationroutingdata.go delete mode 100644 build/platformclientv2/conversationvideoeventtopicdetail.go delete mode 100644 build/platformclientv2/conversationvideoeventtopicerrorbody.go delete mode 100644 build/platformclientv2/conversationvideoeventtopicjourneyaction.go delete mode 100644 build/platformclientv2/conversationvideoeventtopicjourneyactionmap.go delete mode 100644 build/platformclientv2/conversationvideoeventtopicjourneycontext.go delete mode 100644 build/platformclientv2/conversationvideoeventtopicjourneycustomer.go delete mode 100644 build/platformclientv2/conversationvideoeventtopicjourneycustomersession.go delete mode 100644 build/platformclientv2/conversationvideoeventtopicscoredagent.go delete mode 100644 build/platformclientv2/conversationvideoeventtopicurireference.go delete mode 100644 build/platformclientv2/conversationvideoeventtopicvideoconversation.go delete mode 100644 build/platformclientv2/conversationvideoeventtopicvideomediaparticipant.go delete mode 100644 build/platformclientv2/conversationvideoeventtopicwrapup.go delete mode 100644 build/platformclientv2/copyattachmentsrequest.go delete mode 100644 build/platformclientv2/copybuforecastrequest.go delete mode 100644 build/platformclientv2/copyvoicemailmessage.go delete mode 100644 build/platformclientv2/copyworkplan.go delete mode 100644 build/platformclientv2/copyworkplanrotationrequest.go delete mode 100644 build/platformclientv2/coretype.go delete mode 100644 build/platformclientv2/coretypelisting.go delete mode 100644 build/platformclientv2/coversheet.go delete mode 100644 build/platformclientv2/createactivitycoderequest.go delete mode 100644 build/platformclientv2/createadmintimeoffrequest.go delete mode 100644 build/platformclientv2/createagenttimeoffrequest.go delete mode 100644 build/platformclientv2/createbusinessunitrequest.go delete mode 100644 build/platformclientv2/createbusinessunitsettings.go delete mode 100644 build/platformclientv2/createcallbackcommand.go delete mode 100644 build/platformclientv2/createcallbackonconversationcommand.go delete mode 100644 build/platformclientv2/createcallbackresponse.go delete mode 100644 build/platformclientv2/createcallrequest.go delete mode 100644 build/platformclientv2/createcallresponse.go delete mode 100644 build/platformclientv2/createcoachingappointmentrequest.go delete mode 100644 build/platformclientv2/createemailrequest.go delete mode 100644 build/platformclientv2/createintegrationrequest.go delete mode 100644 build/platformclientv2/createmanagementunitapirequest.go delete mode 100644 build/platformclientv2/createmanagementunitsettingsrequest.go delete mode 100644 build/platformclientv2/createoutboundmessagingconversationrequest.go delete mode 100644 build/platformclientv2/createplanninggrouprequest.go delete mode 100644 build/platformclientv2/createqueuerequest.go delete mode 100644 build/platformclientv2/createsecuresession.go delete mode 100644 build/platformclientv2/createservicegoaltemplate.go delete mode 100644 build/platformclientv2/createsharerequest.go delete mode 100644 build/platformclientv2/createsharerequestmember.go delete mode 100644 build/platformclientv2/createshareresponse.go delete mode 100644 build/platformclientv2/createuser.go delete mode 100644 build/platformclientv2/createwebchatconversationrequest.go delete mode 100644 build/platformclientv2/createwebchatconversationresponse.go delete mode 100644 build/platformclientv2/createwebchatmessagerequest.go delete mode 100644 build/platformclientv2/createwebchatrequest.go delete mode 100644 build/platformclientv2/createworkplan.go delete mode 100644 build/platformclientv2/createworkplanactivity.go delete mode 100644 build/platformclientv2/createworkplanshift.go delete mode 100644 build/platformclientv2/credential.go delete mode 100644 build/platformclientv2/credentialinfo.go delete mode 100644 build/platformclientv2/credentialinfolisting.go delete mode 100644 build/platformclientv2/credentialspecification.go delete mode 100644 build/platformclientv2/credentialtype.go delete mode 100644 build/platformclientv2/credentialtypelisting.go delete mode 100644 build/platformclientv2/criteria.go delete mode 100644 build/platformclientv2/crossplatformcallmediapolicy.go delete mode 100644 build/platformclientv2/crossplatformchatmediapolicy.go delete mode 100644 build/platformclientv2/crossplatformemailmediapolicy.go delete mode 100644 build/platformclientv2/crossplatformmediapolicies.go delete mode 100644 build/platformclientv2/crossplatformmessagemediapolicy.go delete mode 100644 build/platformclientv2/crossplatformpolicy.go delete mode 100644 build/platformclientv2/crossplatformpolicyactions.go delete mode 100644 build/platformclientv2/crossplatformpolicycreate.go delete mode 100644 build/platformclientv2/ctabuttonstyleproperties.go delete mode 100644 build/platformclientv2/currentuserschedulerequestbody.go delete mode 100644 build/platformclientv2/cursorcontactlisting.go delete mode 100644 build/platformclientv2/cursornotelisting.go delete mode 100644 build/platformclientv2/cursororganizationlisting.go delete mode 100644 build/platformclientv2/cursorrelationshiplisting.go delete mode 100644 build/platformclientv2/cursors.go delete mode 100644 build/platformclientv2/customerinteractioncenter.go delete mode 100644 build/platformclientv2/dataactionconditionpredicate.go delete mode 100644 build/platformclientv2/dataavailabilityresponse.go delete mode 100644 build/platformclientv2/dataextensionsapi.go delete mode 100644 build/platformclientv2/dataschema.go delete mode 100644 build/platformclientv2/dataschemalisting.go delete mode 100644 build/platformclientv2/datatable.go delete mode 100644 build/platformclientv2/datatableexportjob.go delete mode 100644 build/platformclientv2/datatableimportjob.go delete mode 100644 build/platformclientv2/datatablerowentitylisting.go delete mode 100644 build/platformclientv2/datatablesdomainentitylisting.go delete mode 100644 build/platformclientv2/daterange.go delete mode 100644 build/platformclientv2/daterangewithoptionalend.go delete mode 100644 build/platformclientv2/defaultgreetinglist.go delete mode 100644 build/platformclientv2/deletableuserreference.go delete mode 100644 build/platformclientv2/deleteretention.go delete mode 100644 build/platformclientv2/dependency.go delete mode 100644 build/platformclientv2/dependencyobject.go delete mode 100644 build/platformclientv2/dependencyobjectentitylisting.go delete mode 100644 build/platformclientv2/dependencystatus.go delete mode 100644 build/platformclientv2/dependencytype.go delete mode 100644 build/platformclientv2/dependencytypeentitylisting.go delete mode 100644 build/platformclientv2/destination.go delete mode 100644 build/platformclientv2/detail.go delete mode 100644 build/platformclientv2/detecteddialogact.go delete mode 100644 build/platformclientv2/detectedintent.go delete mode 100644 build/platformclientv2/detectednamedentity.go delete mode 100644 build/platformclientv2/detectednamedentityvalue.go delete mode 100644 build/platformclientv2/developmentactivity.go delete mode 100644 build/platformclientv2/developmentactivityaggregateparam.go delete mode 100644 build/platformclientv2/developmentactivityaggregatequeryrequestclause.go delete mode 100644 build/platformclientv2/developmentactivityaggregatequeryrequestfilter.go delete mode 100644 build/platformclientv2/developmentactivityaggregatequeryrequestpredicate.go delete mode 100644 build/platformclientv2/developmentactivityaggregatequeryresponsedata.go delete mode 100644 build/platformclientv2/developmentactivityaggregatequeryresponsegroupeddata.go delete mode 100644 build/platformclientv2/developmentactivityaggregatequeryresponsemetric.go delete mode 100644 build/platformclientv2/developmentactivityaggregatequeryresponsestatistics.go delete mode 100644 build/platformclientv2/developmentactivityaggregateresponse.go delete mode 100644 build/platformclientv2/developmentactivitylisting.go delete mode 100644 build/platformclientv2/dialeraction.go delete mode 100644 build/platformclientv2/dialerattemptlimitsconfigchangeattemptlimits.go delete mode 100644 build/platformclientv2/dialerattemptlimitsconfigchangerecallentry.go delete mode 100644 build/platformclientv2/dialerauditrequest.go delete mode 100644 build/platformclientv2/dialercallabletimesetconfigchangecallabletime.go delete mode 100644 build/platformclientv2/dialercallabletimesetconfigchangecallabletimeset.go delete mode 100644 build/platformclientv2/dialercallabletimesetconfigchangetimeslot.go delete mode 100644 build/platformclientv2/dialercampaignconfigchangecampaign.go delete mode 100644 build/platformclientv2/dialercampaignconfigchangecontactsort.go delete mode 100644 build/platformclientv2/dialercampaignconfigchangephonecolumn.go delete mode 100644 build/platformclientv2/dialercampaignconfigchangeresterrordetail.go delete mode 100644 build/platformclientv2/dialercampaignconfigchangeurireference.go delete mode 100644 build/platformclientv2/dialercampaignprogresseventcampaignprogress.go delete mode 100644 build/platformclientv2/dialercampaignprogresseventurireference.go delete mode 100644 build/platformclientv2/dialercampaignruleconfigchangecampaignrule.go delete mode 100644 build/platformclientv2/dialercampaignruleconfigchangecampaignruleaction.go delete mode 100644 build/platformclientv2/dialercampaignruleconfigchangecampaignruleactionentities.go delete mode 100644 build/platformclientv2/dialercampaignruleconfigchangecampaignrulecondition.go delete mode 100644 build/platformclientv2/dialercampaignruleconfigchangecampaignruleentities.go delete mode 100644 build/platformclientv2/dialercampaignruleconfigchangeurireference.go delete mode 100644 build/platformclientv2/dialercampaignscheduleconfigchangecampaignschedule.go delete mode 100644 build/platformclientv2/dialercampaignscheduleconfigchangescheduleinterval.go delete mode 100644 build/platformclientv2/dialercampaignscheduleconfigchangeurireference.go delete mode 100644 build/platformclientv2/dialercontact.go delete mode 100644 build/platformclientv2/dialercontactid.go delete mode 100644 build/platformclientv2/dialercontactlistconfigchangecontactlist.go delete mode 100644 build/platformclientv2/dialercontactlistconfigchangecontactphonenumbercolumn.go delete mode 100644 build/platformclientv2/dialercontactlistconfigchangeimportstatus.go delete mode 100644 build/platformclientv2/dialercontactlistconfigchangeurireference.go delete mode 100644 build/platformclientv2/dialercontactlistfilterconfigchangecontactlistfilter.go delete mode 100644 build/platformclientv2/dialercontactlistfilterconfigchangefilterclause.go delete mode 100644 build/platformclientv2/dialercontactlistfilterconfigchangefilterpredicate.go delete mode 100644 build/platformclientv2/dialercontactlistfilterconfigchangerange.go delete mode 100644 build/platformclientv2/dialercontactlistfilterconfigchangeurireference.go delete mode 100644 build/platformclientv2/dialerdnclistconfigchangednclist.go delete mode 100644 build/platformclientv2/dialerdnclistconfigchangeimportstatus.go delete mode 100644 build/platformclientv2/dialerdnclistconfigchangeurireference.go delete mode 100644 build/platformclientv2/dialerevententitylisting.go delete mode 100644 build/platformclientv2/dialeroutboundsettingsconfigchangeatzmtimeslot.go delete mode 100644 build/platformclientv2/dialeroutboundsettingsconfigchangeatzmtimeslotwithtimezone.go delete mode 100644 build/platformclientv2/dialeroutboundsettingsconfigchangeautomatictimezonemappingsettings.go delete mode 100644 build/platformclientv2/dialeroutboundsettingsconfigchangecallablewindow.go delete mode 100644 build/platformclientv2/dialeroutboundsettingsconfigchangeoutboundsettings.go delete mode 100644 build/platformclientv2/dialerpreview.go delete mode 100644 build/platformclientv2/dialerresponsesetconfigchangereaction.go delete mode 100644 build/platformclientv2/dialerresponsesetconfigchangeresponseset.go delete mode 100644 build/platformclientv2/dialerrule.go delete mode 100644 build/platformclientv2/dialerrulesetconfigchangeaction.go delete mode 100644 build/platformclientv2/dialerrulesetconfigchangecondition.go delete mode 100644 build/platformclientv2/dialerrulesetconfigchangecontactcolumntodataactionfieldmapping.go delete mode 100644 build/platformclientv2/dialerrulesetconfigchangedataactionconditionpredicate.go delete mode 100644 build/platformclientv2/dialerrulesetconfigchangerule.go delete mode 100644 build/platformclientv2/dialerrulesetconfigchangeruleset.go delete mode 100644 build/platformclientv2/dialerrulesetconfigchangeurireference.go delete mode 100644 build/platformclientv2/dialersequenceconfigchangecampaignsequence.go delete mode 100644 build/platformclientv2/dialersequenceconfigchangeurireference.go delete mode 100644 build/platformclientv2/dialersequencescheduleconfigchangescheduleinterval.go delete mode 100644 build/platformclientv2/dialersequencescheduleconfigchangesequenceschedule.go delete mode 100644 build/platformclientv2/dialersequencescheduleconfigchangeurireference.go delete mode 100644 build/platformclientv2/dialerwrapupcodemappingconfigchangewrapupcodemapping.go delete mode 100644 build/platformclientv2/dialogflowagent.go delete mode 100644 build/platformclientv2/dialogflowagentsummary.go delete mode 100644 build/platformclientv2/dialogflowagentsummaryentitylisting.go delete mode 100644 build/platformclientv2/dialogflowintent.go delete mode 100644 build/platformclientv2/dialogflowparameter.go delete mode 100644 build/platformclientv2/dialogflowproject.go delete mode 100644 build/platformclientv2/did.go delete mode 100644 build/platformclientv2/didentitylisting.go delete mode 100644 build/platformclientv2/didnumber.go delete mode 100644 build/platformclientv2/didnumberentitylisting.go delete mode 100644 build/platformclientv2/didpool.go delete mode 100644 build/platformclientv2/didpoolentitylisting.go delete mode 100644 build/platformclientv2/digitlength.go delete mode 100644 build/platformclientv2/digits.go delete mode 100644 build/platformclientv2/directoryuserdeviceslisting.go delete mode 100644 build/platformclientv2/disconnectreason.go delete mode 100644 build/platformclientv2/divspermittedentitylisting.go delete mode 100644 build/platformclientv2/dnclist.go delete mode 100644 build/platformclientv2/dnclistcreate.go delete mode 100644 build/platformclientv2/dnclistdivisionview.go delete mode 100644 build/platformclientv2/dnclistdivisionviewlisting.go delete mode 100644 build/platformclientv2/dnclistdownloadreadyexporturi.go delete mode 100644 build/platformclientv2/dnclistentitylisting.go delete mode 100644 build/platformclientv2/dnclistimportstatusimportstatus.go delete mode 100644 build/platformclientv2/document.go delete mode 100644 build/platformclientv2/documentationresult.go delete mode 100644 build/platformclientv2/documentationsearchcriteria.go delete mode 100644 build/platformclientv2/documentationsearchrequest.go delete mode 100644 build/platformclientv2/documentationsearchresponse.go delete mode 100644 build/platformclientv2/documentattribute.go delete mode 100644 build/platformclientv2/documentaudit.go delete mode 100644 build/platformclientv2/documentauditentitylisting.go delete mode 100644 build/platformclientv2/documentcategoryinput.go delete mode 100644 build/platformclientv2/documententitylisting.go delete mode 100644 build/platformclientv2/documentfaq.go delete mode 100644 build/platformclientv2/documentlisting.go delete mode 100644 build/platformclientv2/documentreference.go delete mode 100644 build/platformclientv2/documentthumbnail.go delete mode 100644 build/platformclientv2/documentupdate.go delete mode 100644 build/platformclientv2/documentupload.go delete mode 100644 build/platformclientv2/domaincapabilities.go delete mode 100644 build/platformclientv2/domaincertificateauthority.go delete mode 100644 build/platformclientv2/domainedgesoftwareupdatedto.go delete mode 100644 build/platformclientv2/domainedgesoftwareversiondto.go delete mode 100644 build/platformclientv2/domainedgesoftwareversiondtoentitylisting.go delete mode 100644 build/platformclientv2/domainentity.go delete mode 100644 build/platformclientv2/domainentitylisting.go delete mode 100644 build/platformclientv2/domainentitylistingevaluationform.go delete mode 100644 build/platformclientv2/domainentitylistingqueryresult.go delete mode 100644 build/platformclientv2/domainentitylistingsurveyform.go delete mode 100644 build/platformclientv2/domainentityref.go delete mode 100644 build/platformclientv2/domainlogicalinterface.go delete mode 100644 build/platformclientv2/domainnetworkaddress.go delete mode 100644 build/platformclientv2/domainnetworkcommandresponse.go delete mode 100644 build/platformclientv2/domainnetworkroute.go delete mode 100644 build/platformclientv2/domainorganizationproduct.go delete mode 100644 build/platformclientv2/domainorganizationrole.go delete mode 100644 build/platformclientv2/domainorganizationrolecreate.go delete mode 100644 build/platformclientv2/domainorganizationroleupdate.go delete mode 100644 build/platformclientv2/domainorgroledifference.go delete mode 100644 build/platformclientv2/domainpermission.go delete mode 100644 build/platformclientv2/domainpermissioncollection.go delete mode 100644 build/platformclientv2/domainpermissionpolicy.go delete mode 100644 build/platformclientv2/domainphysicalcapabilities.go delete mode 100644 build/platformclientv2/domainphysicalinterface.go delete mode 100644 build/platformclientv2/domainresourceconditionnode.go delete mode 100644 build/platformclientv2/domainresourceconditionvalue.go delete mode 100644 build/platformclientv2/domainrole.go delete mode 100644 build/platformclientv2/domainschemareference.go delete mode 100644 build/platformclientv2/downloadresponse.go delete mode 100644 build/platformclientv2/draftvalidationresult.go delete mode 100644 build/platformclientv2/durationcondition.go delete mode 100644 build/platformclientv2/edge.go delete mode 100644 build/platformclientv2/edgeautoupdateconfig.go delete mode 100644 build/platformclientv2/edgechangetopicedge.go delete mode 100644 build/platformclientv2/edgeentitylisting.go delete mode 100644 build/platformclientv2/edgegroup.go delete mode 100644 build/platformclientv2/edgegroupentitylisting.go delete mode 100644 build/platformclientv2/edgeinterface.go delete mode 100644 build/platformclientv2/edgeline.go delete mode 100644 build/platformclientv2/edgelineentitylisting.go delete mode 100644 build/platformclientv2/edgelogicalinterfaceschangetopicdomainlogicalinterfacechange.go delete mode 100644 build/platformclientv2/edgelogicalinterfaceschangetopicerrorinfo.go delete mode 100644 build/platformclientv2/edgelogsjob.go delete mode 100644 build/platformclientv2/edgelogsjobfile.go delete mode 100644 build/platformclientv2/edgelogsjobrequest.go delete mode 100644 build/platformclientv2/edgelogsjobresponse.go delete mode 100644 build/platformclientv2/edgelogsjobuploadrequest.go delete mode 100644 build/platformclientv2/edgemetrics.go delete mode 100644 build/platformclientv2/edgemetricsdisk.go delete mode 100644 build/platformclientv2/edgemetricsmemory.go delete mode 100644 build/platformclientv2/edgemetricsnetwork.go delete mode 100644 build/platformclientv2/edgemetricsprocessor.go delete mode 100644 build/platformclientv2/edgemetricssubsystem.go delete mode 100644 build/platformclientv2/edgemetricstopicedgemetricdisk.go delete mode 100644 build/platformclientv2/edgemetricstopicedgemetricmemory.go delete mode 100644 build/platformclientv2/edgemetricstopicedgemetricnetworks.go delete mode 100644 build/platformclientv2/edgemetricstopicedgemetricprocessor.go delete mode 100644 build/platformclientv2/edgemetricstopicedgemetrics.go delete mode 100644 build/platformclientv2/edgemetricstopicedgemetricsubsystem.go delete mode 100644 build/platformclientv2/edgemetricstopicedgemetricsubsystemmedia.go delete mode 100644 build/platformclientv2/edgemetricstopiclocaldate.go delete mode 100644 build/platformclientv2/edgemetricstopiclocaldatetime.go delete mode 100644 build/platformclientv2/edgemetricstopiclocaltime.go delete mode 100644 build/platformclientv2/edgemetricstopicoffsetdatetime.go delete mode 100644 build/platformclientv2/edgemetricstopicurireference.go delete mode 100644 build/platformclientv2/edgemetricstopiczoneoffset.go delete mode 100644 build/platformclientv2/edgenetworkdiagnostic.go delete mode 100644 build/platformclientv2/edgenetworkdiagnosticrequest.go delete mode 100644 build/platformclientv2/edgenetworkdiagnosticresponse.go delete mode 100644 build/platformclientv2/edgerebootparameters.go delete mode 100644 build/platformclientv2/edgeservicestaterequest.go delete mode 100644 build/platformclientv2/edgesoftwareupdatetopicdomainedgesoftwareupdate.go delete mode 100644 build/platformclientv2/edgetrunkbase.go delete mode 100644 build/platformclientv2/edgeversioninformation.go delete mode 100644 build/platformclientv2/edgeversionreport.go delete mode 100644 build/platformclientv2/education.go delete mode 100644 build/platformclientv2/effectiveconfiguration.go delete mode 100644 build/platformclientv2/email.go delete mode 100644 build/platformclientv2/emailaddress.go delete mode 100644 build/platformclientv2/emailattachment.go delete mode 100644 build/platformclientv2/emailconversation.go delete mode 100644 build/platformclientv2/emailconversationentitylisting.go delete mode 100644 build/platformclientv2/emailmediaparticipant.go delete mode 100644 build/platformclientv2/emailmediapolicy.go delete mode 100644 build/platformclientv2/emailmediapolicyconditions.go delete mode 100644 build/platformclientv2/emailmessage.go delete mode 100644 build/platformclientv2/emailmessagelisting.go delete mode 100644 build/platformclientv2/emailsetup.go delete mode 100644 build/platformclientv2/embeddedintegration.go delete mode 100644 build/platformclientv2/emergencycallflow.go delete mode 100644 build/platformclientv2/emergencygroup.go delete mode 100644 build/platformclientv2/emergencygrouplisting.go delete mode 100644 build/platformclientv2/employerinfo.go delete mode 100644 build/platformclientv2/empty.go delete mode 100644 build/platformclientv2/encryptionkey.go delete mode 100644 build/platformclientv2/encryptionkeyentitylisting.go delete mode 100644 build/platformclientv2/endpoint.go delete mode 100644 build/platformclientv2/entity.go delete mode 100644 build/platformclientv2/entitytypecriteria.go delete mode 100644 build/platformclientv2/entry.go delete mode 100644 build/platformclientv2/errorbody.go delete mode 100644 build/platformclientv2/errordetails.go delete mode 100644 build/platformclientv2/errorinfo.go delete mode 100644 build/platformclientv2/estimatedwaittimepredictions.go delete mode 100644 build/platformclientv2/evaluation.go delete mode 100644 build/platformclientv2/evaluationaggregatedatacontainer.go delete mode 100644 build/platformclientv2/evaluationaggregatequeryclause.go delete mode 100644 build/platformclientv2/evaluationaggregatequeryfilter.go delete mode 100644 build/platformclientv2/evaluationaggregatequerypredicate.go delete mode 100644 build/platformclientv2/evaluationaggregatequeryresponse.go delete mode 100644 build/platformclientv2/evaluationaggregationquery.go delete mode 100644 build/platformclientv2/evaluationaggregationview.go delete mode 100644 build/platformclientv2/evaluationassignment.go delete mode 100644 build/platformclientv2/evaluationdetailqueryclause.go delete mode 100644 build/platformclientv2/evaluationdetailqueryfilter.go delete mode 100644 build/platformclientv2/evaluationdetailquerypredicate.go delete mode 100644 build/platformclientv2/evaluationentitylisting.go delete mode 100644 build/platformclientv2/evaluationform.go delete mode 100644 build/platformclientv2/evaluationformandscoringset.go delete mode 100644 build/platformclientv2/evaluationformentitylisting.go delete mode 100644 build/platformclientv2/evaluationqualityv2topicevaluationscoringset.go delete mode 100644 build/platformclientv2/evaluationqualityv2topicevaluationv2.go delete mode 100644 build/platformclientv2/evaluationqualityv2topicuser.go delete mode 100644 build/platformclientv2/evaluationquestion.go delete mode 100644 build/platformclientv2/evaluationquestiongroup.go delete mode 100644 build/platformclientv2/evaluationquestiongroupscore.go delete mode 100644 build/platformclientv2/evaluationquestionscore.go delete mode 100644 build/platformclientv2/evaluationscoringset.go delete mode 100644 build/platformclientv2/evaluatoractivity.go delete mode 100644 build/platformclientv2/evaluatoractivityentitylisting.go delete mode 100644 build/platformclientv2/eventcondition.go delete mode 100644 build/platformclientv2/evententity.go delete mode 100644 build/platformclientv2/eventlog.go delete mode 100644 build/platformclientv2/eventmessage.go delete mode 100644 build/platformclientv2/executerecordingjobsquery.go delete mode 100644 build/platformclientv2/expansioncriterium.go delete mode 100644 build/platformclientv2/exportscriptrequest.go delete mode 100644 build/platformclientv2/exportscriptresponse.go delete mode 100644 build/platformclientv2/exporturi.go delete mode 100644 build/platformclientv2/extension.go delete mode 100644 build/platformclientv2/extensionentitylisting.go delete mode 100644 build/platformclientv2/extensionpool.go delete mode 100644 build/platformclientv2/extensionpoolentitylisting.go delete mode 100644 build/platformclientv2/externalcontact.go delete mode 100644 build/platformclientv2/externalcontactsapi.go delete mode 100644 build/platformclientv2/externaldatasource.go delete mode 100644 build/platformclientv2/externalorganization.go delete mode 100644 build/platformclientv2/externalorganizationlisting.go delete mode 100644 build/platformclientv2/externalorganizationtrustorlink.go delete mode 100644 build/platformclientv2/facebookappcredentials.go delete mode 100644 build/platformclientv2/facebookid.go delete mode 100644 build/platformclientv2/facebookintegration.go delete mode 100644 build/platformclientv2/facebookintegrationentitylisting.go delete mode 100644 build/platformclientv2/facebookintegrationrequest.go delete mode 100644 build/platformclientv2/facebookintegrationupdaterequest.go delete mode 100644 build/platformclientv2/facebookscopedid.go delete mode 100644 build/platformclientv2/facet.go delete mode 100644 build/platformclientv2/facetentry.go delete mode 100644 build/platformclientv2/facetinfo.go delete mode 100644 build/platformclientv2/facetkeyattribute.go delete mode 100644 build/platformclientv2/facetstatistics.go delete mode 100644 build/platformclientv2/facetterm.go delete mode 100644 build/platformclientv2/failedobject.go delete mode 100644 build/platformclientv2/faxapi.go delete mode 100644 build/platformclientv2/faxdocument.go delete mode 100644 build/platformclientv2/faxdocumententitylisting.go delete mode 100644 build/platformclientv2/faxsendrequest.go delete mode 100644 build/platformclientv2/faxsendresponse.go delete mode 100644 build/platformclientv2/faxstatus.go delete mode 100644 build/platformclientv2/faxsummary.go delete mode 100644 build/platformclientv2/faxtopicfaxdatav2.go delete mode 100644 build/platformclientv2/faxtopiclockdata.go delete mode 100644 build/platformclientv2/faxtopicuserdata.go delete mode 100644 build/platformclientv2/faxtopicworkspacedata.go delete mode 100644 build/platformclientv2/featurestate.go delete mode 100644 build/platformclientv2/fieldconfig.go delete mode 100644 build/platformclientv2/fieldconfigs.go delete mode 100644 build/platformclientv2/fieldlist.go delete mode 100644 build/platformclientv2/filter.go delete mode 100644 build/platformclientv2/filterpreviewresponse.go delete mode 100644 build/platformclientv2/flow.go delete mode 100644 build/platformclientv2/flowaggregatedatacontainer.go delete mode 100644 build/platformclientv2/flowaggregatequeryclause.go delete mode 100644 build/platformclientv2/flowaggregatequeryfilter.go delete mode 100644 build/platformclientv2/flowaggregatequerypredicate.go delete mode 100644 build/platformclientv2/flowaggregatequeryresponse.go delete mode 100644 build/platformclientv2/flowaggregationquery.go delete mode 100644 build/platformclientv2/flowaggregationview.go delete mode 100644 build/platformclientv2/flowdiagnosticinfo.go delete mode 100644 build/platformclientv2/flowdivisionview.go delete mode 100644 build/platformclientv2/flowdivisionviewentitylisting.go delete mode 100644 build/platformclientv2/flowentitylisting.go delete mode 100644 build/platformclientv2/flowexecutionlaunchrequest.go delete mode 100644 build/platformclientv2/flowexecutionlaunchresponse.go delete mode 100644 build/platformclientv2/flowmilestone.go delete mode 100644 build/platformclientv2/flowmilestonelisting.go delete mode 100644 build/platformclientv2/flowobservationdatacontainer.go delete mode 100644 build/platformclientv2/flowobservationquery.go delete mode 100644 build/platformclientv2/flowobservationqueryclause.go delete mode 100644 build/platformclientv2/flowobservationqueryfilter.go delete mode 100644 build/platformclientv2/flowobservationquerypredicate.go delete mode 100644 build/platformclientv2/flowobservationqueryresponse.go delete mode 100644 build/platformclientv2/flowoutcome.go delete mode 100644 build/platformclientv2/flowoutcomelisting.go delete mode 100644 build/platformclientv2/flowruntimeexecution.go delete mode 100644 build/platformclientv2/flowsapi.go delete mode 100644 build/platformclientv2/flowversion.go delete mode 100644 build/platformclientv2/flowversionentitylisting.go delete mode 100644 build/platformclientv2/forecastabandonrateresponse.go delete mode 100644 build/platformclientv2/forecastaveragespeedofanswerresponse.go delete mode 100644 build/platformclientv2/forecastplanninggroupdata.go delete mode 100644 build/platformclientv2/forecastplanninggroupresponse.go delete mode 100644 build/platformclientv2/forecastplanninggroupsresponse.go delete mode 100644 build/platformclientv2/forecastservicegoaltemplateresponse.go delete mode 100644 build/platformclientv2/forecastservicelevelresponse.go delete mode 100644 build/platformclientv2/forecastsourcedaypointer.go delete mode 100644 build/platformclientv2/freeseatingconfiguration.go delete mode 100644 build/platformclientv2/gdprjourneycustomer.go delete mode 100644 build/platformclientv2/gdprrequest.go delete mode 100644 build/platformclientv2/gdprrequestentitylisting.go delete mode 100644 build/platformclientv2/gdprsubject.go delete mode 100644 build/platformclientv2/gdprsubjectentitylisting.go delete mode 100644 build/platformclientv2/generaldataprotectionregulationapi.go delete mode 100644 build/platformclientv2/generatebuforecastrequest.go delete mode 100644 build/platformclientv2/genericsaml.go delete mode 100644 build/platformclientv2/genesysbotconnector.go delete mode 100644 build/platformclientv2/geolocation.go delete mode 100644 build/platformclientv2/geolocationapi.go delete mode 100644 build/platformclientv2/geolocationeventgeolocation.go delete mode 100644 build/platformclientv2/geolocationsettings.go delete mode 100644 build/platformclientv2/gkndocumentationresult.go delete mode 100644 build/platformclientv2/gkndocumentationsearchcriteria.go delete mode 100644 build/platformclientv2/gkndocumentationsearchrequest.go delete mode 100644 build/platformclientv2/gkndocumentationsearchresponse.go delete mode 100644 build/platformclientv2/googledialogflowcustomsettings.go delete mode 100644 build/platformclientv2/greeting.go delete mode 100644 build/platformclientv2/greetingaudiofile.go delete mode 100644 build/platformclientv2/greetinglisting.go delete mode 100644 build/platformclientv2/greetingmediainfo.go delete mode 100644 build/platformclientv2/greetingowner.go delete mode 100644 build/platformclientv2/greetingsapi.go delete mode 100644 build/platformclientv2/group.go delete mode 100644 build/platformclientv2/groupcontact.go delete mode 100644 build/platformclientv2/groupcreate.go delete mode 100644 build/platformclientv2/groupentitylisting.go delete mode 100644 build/platformclientv2/groupgreetingeventgreeting.go delete mode 100644 build/platformclientv2/groupgreetingeventgreetingaudiofile.go delete mode 100644 build/platformclientv2/groupgreetingeventgreetingowner.go delete mode 100644 build/platformclientv2/groupmembersupdate.go delete mode 100644 build/platformclientv2/groupprofile.go delete mode 100644 build/platformclientv2/groupprofileentitylisting.go delete mode 100644 build/platformclientv2/groupsapi.go delete mode 100644 build/platformclientv2/groupsearchcriteria.go delete mode 100644 build/platformclientv2/groupsearchrequest.go delete mode 100644 build/platformclientv2/groupssearchresponse.go delete mode 100644 build/platformclientv2/groupupdate.go delete mode 100644 build/platformclientv2/gsuite.go delete mode 100644 build/platformclientv2/guestmemberinfo.go delete mode 100644 build/platformclientv2/headcountforecast.go delete mode 100644 build/platformclientv2/headcountinterval.go delete mode 100644 build/platformclientv2/helplink.go delete mode 100644 build/platformclientv2/historicaladherenceactuals.go delete mode 100644 build/platformclientv2/historicaladherencedaymetrics.go delete mode 100644 build/platformclientv2/historicaladherenceexceptioninfo.go delete mode 100644 build/platformclientv2/historicaladherencequeryresult.go delete mode 100644 build/platformclientv2/historyentry.go delete mode 100644 build/platformclientv2/historylisting.go delete mode 100644 build/platformclientv2/homerrecord.go delete mode 100644 build/platformclientv2/identitynow.go delete mode 100644 build/platformclientv2/identityproviderapi.go delete mode 100644 build/platformclientv2/ignoredactivitycategories.go delete mode 100644 build/platformclientv2/importscriptstatusresponse.go delete mode 100644 build/platformclientv2/importstatus.go delete mode 100644 build/platformclientv2/inbounddomain.go delete mode 100644 build/platformclientv2/inbounddomainentitylisting.go delete mode 100644 build/platformclientv2/inbounddomainpatchrequest.go delete mode 100644 build/platformclientv2/inboundmessagerequest.go delete mode 100644 build/platformclientv2/inboundroute.go delete mode 100644 build/platformclientv2/inboundrouteentitylisting.go delete mode 100644 build/platformclientv2/initiatescreenrecording.go delete mode 100644 build/platformclientv2/integration.go delete mode 100644 build/platformclientv2/integrationaction.go delete mode 100644 build/platformclientv2/integrationactionfields.go delete mode 100644 build/platformclientv2/integrationconfiguration.go delete mode 100644 build/platformclientv2/integrationconfigurationinfo.go delete mode 100644 build/platformclientv2/integrationentitylisting.go delete mode 100644 build/platformclientv2/integrationevent.go delete mode 100644 build/platformclientv2/integrationevententitylisting.go delete mode 100644 build/platformclientv2/integrationexport.go delete mode 100644 build/platformclientv2/integrationsapi.go delete mode 100644 build/platformclientv2/integrationstatusinfo.go delete mode 100644 build/platformclientv2/integrationtype.go delete mode 100644 build/platformclientv2/integrationtypeentitylisting.go delete mode 100644 build/platformclientv2/intentdefinition.go delete mode 100644 build/platformclientv2/intentfeedback.go delete mode 100644 build/platformclientv2/interactionstatsalert.go delete mode 100644 build/platformclientv2/interactionstatsalertcontainer.go delete mode 100644 build/platformclientv2/interactionstatsrule.go delete mode 100644 build/platformclientv2/interactionstatsrulecontainer.go delete mode 100644 build/platformclientv2/intradayperformancepredictiondata.go delete mode 100644 build/platformclientv2/intradayplanninggrouprequest.go delete mode 100644 build/platformclientv2/ipaddressauthentication.go delete mode 100644 build/platformclientv2/ipaddressrange.go delete mode 100644 build/platformclientv2/ipaddressrangelisting.go delete mode 100644 build/platformclientv2/items.go delete mode 100644 build/platformclientv2/itemvalidationlimits.go delete mode 100644 build/platformclientv2/ivr.go delete mode 100644 build/platformclientv2/ivrentitylisting.go delete mode 100644 build/platformclientv2/journey.go delete mode 100644 build/platformclientv2/journeyaction.go delete mode 100644 build/platformclientv2/journeyactionmap.go delete mode 100644 build/platformclientv2/journeyaggregatedatacontainer.go delete mode 100644 build/platformclientv2/journeyaggregatequeryclause.go delete mode 100644 build/platformclientv2/journeyaggregatequeryfilter.go delete mode 100644 build/platformclientv2/journeyaggregatequerypredicate.go delete mode 100644 build/platformclientv2/journeyaggregatequeryresponse.go delete mode 100644 build/platformclientv2/journeyaggregationquery.go delete mode 100644 build/platformclientv2/journeyaggregationview.go delete mode 100644 build/platformclientv2/journeyapi.go delete mode 100644 build/platformclientv2/journeycontext.go delete mode 100644 build/platformclientv2/journeycustomer.go delete mode 100644 build/platformclientv2/journeycustomersession.go delete mode 100644 build/platformclientv2/journeypattern.go delete mode 100644 build/platformclientv2/journeysegment.go delete mode 100644 build/platformclientv2/journeysurveyquestion.go delete mode 100644 build/platformclientv2/jsonnode.go delete mode 100644 build/platformclientv2/jsonnodesearchresponse.go delete mode 100644 build/platformclientv2/jsonschemadocument.go delete mode 100644 build/platformclientv2/jsonsearchresponse.go delete mode 100644 build/platformclientv2/keyrotationschedule.go delete mode 100644 build/platformclientv2/keyvalue.go delete mode 100644 build/platformclientv2/keyword.go delete mode 100644 build/platformclientv2/keywordset.go delete mode 100644 build/platformclientv2/keywordsetentitylisting.go delete mode 100644 build/platformclientv2/klaxonheartbeatalertstopicheartbeatalert.go delete mode 100644 build/platformclientv2/klaxonheartbeatalertstopicnotificationuser.go delete mode 100644 build/platformclientv2/klaxonheartbeatrulestopicheartbeatrule.go delete mode 100644 build/platformclientv2/klaxonheartbeatrulestopicnotificationuser.go delete mode 100644 build/platformclientv2/klaxoninteractionstatsalertstopicinteractionstatalert.go delete mode 100644 build/platformclientv2/klaxoninteractionstatsalertstopicnotificationuser.go delete mode 100644 build/platformclientv2/klaxoninteractionstatsrulestopicinteractionstatrule.go delete mode 100644 build/platformclientv2/klaxoninteractionstatsrulestopicnotificationuser.go delete mode 100644 build/platformclientv2/knowledgeapi.go delete mode 100644 build/platformclientv2/knowledgebase.go delete mode 100644 build/platformclientv2/knowledgebaselisting.go delete mode 100644 build/platformclientv2/knowledgecategory.go delete mode 100644 build/platformclientv2/knowledgecategoryrequest.go delete mode 100644 build/platformclientv2/knowledgedocument.go delete mode 100644 build/platformclientv2/knowledgedocumentbulkrequest.go delete mode 100644 build/platformclientv2/knowledgedocumentrequest.go delete mode 100644 build/platformclientv2/knowledgeextendedcategory.go delete mode 100644 build/platformclientv2/knowledgesearchdocument.go delete mode 100644 build/platformclientv2/knowledgesearchrequest.go delete mode 100644 build/platformclientv2/knowledgesearchresponse.go delete mode 100644 build/platformclientv2/knowledgetraining.go delete mode 100644 build/platformclientv2/languageentitylisting.go delete mode 100644 build/platformclientv2/languageoverride.go delete mode 100644 build/platformclientv2/languagereference.go delete mode 100644 build/platformclientv2/languagesapi.go delete mode 100644 build/platformclientv2/languageunderstandingapi.go delete mode 100644 build/platformclientv2/lexbot.go delete mode 100644 build/platformclientv2/lexbotalias.go delete mode 100644 build/platformclientv2/lexbotaliasentitylisting.go delete mode 100644 build/platformclientv2/lexbotentitylisting.go delete mode 100644 build/platformclientv2/lexintent.go delete mode 100644 build/platformclientv2/lexslot.go delete mode 100644 build/platformclientv2/library.go delete mode 100644 build/platformclientv2/libraryentitylisting.go delete mode 100644 build/platformclientv2/licenseapi.go delete mode 100644 build/platformclientv2/licenseassignmentrequest.go delete mode 100644 build/platformclientv2/licensebatchassignmentrequest.go delete mode 100644 build/platformclientv2/licensedefinition.go delete mode 100644 build/platformclientv2/licenseorgtoggle.go delete mode 100644 build/platformclientv2/licenseupdatestatus.go delete mode 100644 build/platformclientv2/licenseuser.go delete mode 100644 build/platformclientv2/line.go delete mode 100644 build/platformclientv2/linebase.go delete mode 100644 build/platformclientv2/linebaseentitylisting.go delete mode 100644 build/platformclientv2/lineentitylisting.go delete mode 100644 build/platformclientv2/lineid.go delete mode 100644 build/platformclientv2/lineintegration.go delete mode 100644 build/platformclientv2/lineintegrationentitylisting.go delete mode 100644 build/platformclientv2/lineintegrationrequest.go delete mode 100644 build/platformclientv2/linestatus.go delete mode 100644 build/platformclientv2/lineuserid.go delete mode 100644 build/platformclientv2/listitemcomponent.go delete mode 100644 build/platformclientv2/listwrapperinterval.go delete mode 100644 build/platformclientv2/listwrappershiftstartvariance.go delete mode 100644 build/platformclientv2/localencryptionconfiguration.go delete mode 100644 build/platformclientv2/localencryptionconfigurationlisting.go delete mode 100644 build/platformclientv2/localencryptionkeyrequest.go delete mode 100644 build/platformclientv2/location.go delete mode 100644 build/platformclientv2/locationaddress.go delete mode 100644 build/platformclientv2/locationaddressverificationdetails.go delete mode 100644 build/platformclientv2/locationcreatedefinition.go delete mode 100644 build/platformclientv2/locationdefinition.go delete mode 100644 build/platformclientv2/locationemergencynumber.go delete mode 100644 build/platformclientv2/locationentitylisting.go delete mode 100644 build/platformclientv2/locationimage.go delete mode 100644 build/platformclientv2/locationsapi.go delete mode 100644 build/platformclientv2/locationsearchcriteria.go delete mode 100644 build/platformclientv2/locationsearchrequest.go delete mode 100644 build/platformclientv2/locationssearchresponse.go delete mode 100644 build/platformclientv2/locationupdatedefinition.go delete mode 100644 build/platformclientv2/lockinfo.go delete mode 100644 build/platformclientv2/logcaptureuserconfiguration.go delete mode 100644 build/platformclientv2/logicalinterfaceentitylisting.go delete mode 100644 build/platformclientv2/mailfromresult.go delete mode 100644 build/platformclientv2/managementunit.go delete mode 100644 build/platformclientv2/managementunitlisting.go delete mode 100644 build/platformclientv2/managementunitreference.go delete mode 100644 build/platformclientv2/managementunitsettingsrequest.go delete mode 100644 build/platformclientv2/managementunitsettingsresponse.go delete mode 100644 build/platformclientv2/manager.go delete mode 100644 build/platformclientv2/matchshifttraderequest.go delete mode 100644 build/platformclientv2/matchshifttraderesponse.go delete mode 100644 build/platformclientv2/maxlength.go delete mode 100644 build/platformclientv2/maxparticipants.go delete mode 100644 build/platformclientv2/mediaendpointstatdetailqueryclause.go delete mode 100644 build/platformclientv2/mediaendpointstatdetailqueryfilter.go delete mode 100644 build/platformclientv2/mediaendpointstatdetailquerypredicate.go delete mode 100644 build/platformclientv2/mediaparticipantrequest.go delete mode 100644 build/platformclientv2/mediapolicies.go delete mode 100644 build/platformclientv2/mediaresult.go delete mode 100644 build/platformclientv2/mediasetting.go delete mode 100644 build/platformclientv2/mediasummary.go delete mode 100644 build/platformclientv2/mediasummarydetail.go delete mode 100644 build/platformclientv2/mediatranscription.go delete mode 100644 build/platformclientv2/mediatype.go delete mode 100644 build/platformclientv2/mediatypeaccess.go delete mode 100644 build/platformclientv2/mediatypes.go delete mode 100644 build/platformclientv2/mediautilization.go delete mode 100644 build/platformclientv2/memberentity.go delete mode 100644 build/platformclientv2/message.go delete mode 100644 build/platformclientv2/messagecontent.go delete mode 100644 build/platformclientv2/messageconversation.go delete mode 100644 build/platformclientv2/messageconversationentitylisting.go delete mode 100644 build/platformclientv2/messagedata.go delete mode 100644 build/platformclientv2/messagedetails.go delete mode 100644 build/platformclientv2/messageevaluation.go delete mode 100644 build/platformclientv2/messageinfo.go delete mode 100644 build/platformclientv2/messagemedia.go delete mode 100644 build/platformclientv2/messagemediaattachment.go delete mode 100644 build/platformclientv2/messagemediadata.go delete mode 100644 build/platformclientv2/messagemediaparticipant.go delete mode 100644 build/platformclientv2/messagemediapolicy.go delete mode 100644 build/platformclientv2/messagemediapolicyconditions.go delete mode 100644 build/platformclientv2/messagesticker.go delete mode 100644 build/platformclientv2/messagestickerattachment.go delete mode 100644 build/platformclientv2/messagingcampaign.go delete mode 100644 build/platformclientv2/messagingcampaigndivisionview.go delete mode 100644 build/platformclientv2/messagingcampaigndivisionviewentitylisting.go delete mode 100644 build/platformclientv2/messagingcampaignentitylisting.go delete mode 100644 build/platformclientv2/messagingintegration.go delete mode 100644 build/platformclientv2/messagingintegrationentitylisting.go delete mode 100644 build/platformclientv2/messagingrecipient.go delete mode 100644 build/platformclientv2/messagingsticker.go delete mode 100644 build/platformclientv2/messagingstickerentitylisting.go delete mode 100644 build/platformclientv2/messagingtemplate.go delete mode 100644 build/platformclientv2/messagingtemplaterequest.go delete mode 100644 build/platformclientv2/metabase.go delete mode 100644 build/platformclientv2/metadata.go delete mode 100644 build/platformclientv2/meteredassignmentbyagent.go delete mode 100644 build/platformclientv2/meteredevaluationassignment.go delete mode 100644 build/platformclientv2/minlength.go delete mode 100644 build/platformclientv2/mobiledevicesapi.go delete mode 100644 build/platformclientv2/modelingprocessingerror.go delete mode 100644 build/platformclientv2/modelingstatusresponse.go delete mode 100644 build/platformclientv2/movemanagementunitrequest.go delete mode 100644 build/platformclientv2/movemanagementunitresponse.go delete mode 100644 build/platformclientv2/murescheduleresultwrapper.go delete mode 100644 build/platformclientv2/namedentity.go delete mode 100644 build/platformclientv2/namedentityannotation.go delete mode 100644 build/platformclientv2/namedentitytypebinding.go delete mode 100644 build/platformclientv2/namedentitytypedefinition.go delete mode 100644 build/platformclientv2/namedentitytypeitem.go delete mode 100644 build/platformclientv2/namedentitytypemechanism.go delete mode 100644 build/platformclientv2/nluconfusionmatrixcolumn.go delete mode 100644 build/platformclientv2/nluconfusionmatrixrow.go delete mode 100644 build/platformclientv2/nludetectioncontext.go delete mode 100644 build/platformclientv2/nludetectioninput.go delete mode 100644 build/platformclientv2/nludetectionoutput.go delete mode 100644 build/platformclientv2/nludetectionrequest.go delete mode 100644 build/platformclientv2/nludetectionresponse.go delete mode 100644 build/platformclientv2/nludomain.go delete mode 100644 build/platformclientv2/nludomainlisting.go delete mode 100644 build/platformclientv2/nludomainversion.go delete mode 100644 build/platformclientv2/nludomainversionlisting.go delete mode 100644 build/platformclientv2/nludomainversionqualityreport.go delete mode 100644 build/platformclientv2/nludomainversiontrainingresponse.go delete mode 100644 build/platformclientv2/nlufeedbacklisting.go delete mode 100644 build/platformclientv2/nlufeedbackrequest.go delete mode 100644 build/platformclientv2/nlufeedbackresponse.go delete mode 100644 build/platformclientv2/nluinfo.go delete mode 100644 build/platformclientv2/nluqualityreportsummary.go delete mode 100644 build/platformclientv2/nluqualityreportsummarymetric.go delete mode 100644 build/platformclientv2/nluutterance.go delete mode 100644 build/platformclientv2/nluutterancesegment.go delete mode 100644 build/platformclientv2/note.go delete mode 100644 build/platformclientv2/notelisting.go delete mode 100644 build/platformclientv2/notificationsapi.go delete mode 100644 build/platformclientv2/notificationsresponse.go delete mode 100644 build/platformclientv2/notificationtemplatebody.go delete mode 100644 build/platformclientv2/notificationtemplatefooter.go delete mode 100644 build/platformclientv2/notificationtemplateheader.go delete mode 100644 build/platformclientv2/notificationtemplateparameter.go delete mode 100644 build/platformclientv2/ntpsettings.go delete mode 100644 build/platformclientv2/number.go delete mode 100644 build/platformclientv2/numberplan.go delete mode 100644 build/platformclientv2/numericrange.go delete mode 100644 build/platformclientv2/oauthapi.go delete mode 100644 build/platformclientv2/oauthauthorization.go delete mode 100644 build/platformclientv2/oauthauthorizationlisting.go delete mode 100644 build/platformclientv2/oauthclient.go delete mode 100644 build/platformclientv2/oauthcliententitylisting.go delete mode 100644 build/platformclientv2/oauthclientlisting.go delete mode 100644 build/platformclientv2/oauthclientrequest.go delete mode 100644 build/platformclientv2/oauthlasttokenissued.go delete mode 100644 build/platformclientv2/oauthprovider.go delete mode 100644 build/platformclientv2/oauthproviderentitylisting.go delete mode 100644 build/platformclientv2/oauthscope.go delete mode 100644 build/platformclientv2/oauthscopelisting.go delete mode 100644 build/platformclientv2/objectsapi.go delete mode 100644 build/platformclientv2/observationmetricdata.go delete mode 100644 build/platformclientv2/observationvalue.go delete mode 100644 build/platformclientv2/okta.go delete mode 100644 build/platformclientv2/onelogin.go delete mode 100644 build/platformclientv2/operation.go delete mode 100644 build/platformclientv2/organization.go delete mode 100644 build/platformclientv2/organizationapi.go delete mode 100644 build/platformclientv2/organizationauthorizationapi.go delete mode 100644 build/platformclientv2/organizationfeatures.go delete mode 100644 build/platformclientv2/organizationpresence.go delete mode 100644 build/platformclientv2/organizationpresenceentitylisting.go delete mode 100644 build/platformclientv2/organizationproductentitylisting.go delete mode 100644 build/platformclientv2/organizationroleentitylisting.go delete mode 100644 build/platformclientv2/orgoauthclient.go delete mode 100644 build/platformclientv2/orguser.go delete mode 100644 build/platformclientv2/orgwhitelistsettings.go delete mode 100644 build/platformclientv2/orphanrecording.go delete mode 100644 build/platformclientv2/orphanrecordinglisting.go delete mode 100644 build/platformclientv2/orphanupdaterequest.go delete mode 100644 build/platformclientv2/outboundapi.go delete mode 100644 build/platformclientv2/outboundmessagingmessagingcampaignconfigchangecontactsort.go delete mode 100644 build/platformclientv2/outboundmessagingmessagingcampaignconfigchangeerrordetail.go delete mode 100644 build/platformclientv2/outboundmessagingmessagingcampaignconfigchangemessagingcampaign.go delete mode 100644 build/platformclientv2/outboundmessagingmessagingcampaignconfigchangeresponseref.go delete mode 100644 build/platformclientv2/outboundmessagingmessagingcampaignconfigchangesmsconfig.go delete mode 100644 build/platformclientv2/outboundmessagingmessagingcampaignconfigchangesmsphonenumberref.go delete mode 100644 build/platformclientv2/outboundmessagingmessagingcampaignconfigchangeurireference.go delete mode 100644 build/platformclientv2/outboundmessagingmessagingcampaignprogresseventcampaignprogress.go delete mode 100644 build/platformclientv2/outboundmessagingmessagingcampaignprogresseventurireference.go delete mode 100644 build/platformclientv2/outboundroute.go delete mode 100644 build/platformclientv2/outboundroutebase.go delete mode 100644 build/platformclientv2/outboundroutebaseentitylisting.go delete mode 100644 build/platformclientv2/outboundrouteentitylisting.go delete mode 100644 build/platformclientv2/outboundsettings.go delete mode 100644 build/platformclientv2/outcome.go delete mode 100644 build/platformclientv2/outcomelisting.go delete mode 100644 build/platformclientv2/outcomeprobabilitycondition.go delete mode 100644 build/platformclientv2/outofoffice.go delete mode 100644 build/platformclientv2/outofofficeeventoutofoffice.go delete mode 100644 build/platformclientv2/outofofficeeventuser.go delete mode 100644 build/platformclientv2/page.go delete mode 100644 build/platformclientv2/pagingspec.go delete mode 100644 build/platformclientv2/parameter.go delete mode 100644 build/platformclientv2/parsedcertificate.go delete mode 100644 build/platformclientv2/participant.go delete mode 100644 build/platformclientv2/participantattributes.go delete mode 100644 build/platformclientv2/participantbasic.go delete mode 100644 build/platformclientv2/participantmetrics.go delete mode 100644 build/platformclientv2/patchaction.go delete mode 100644 build/platformclientv2/patchactionmap.go delete mode 100644 build/platformclientv2/patchactionmapschedulegroups.go delete mode 100644 build/platformclientv2/patchactionproperties.go delete mode 100644 build/platformclientv2/patchactionsurvey.go delete mode 100644 build/platformclientv2/patchactiontarget.go delete mode 100644 build/platformclientv2/patchactiontemplate.go delete mode 100644 build/platformclientv2/patchbureschedulingoptionsmanagementunitrequest.go delete mode 100644 build/platformclientv2/patchbureschedulingoptionsrequest.go delete mode 100644 build/platformclientv2/patchbuschedulerunrequest.go delete mode 100644 build/platformclientv2/patchcalltoaction.go delete mode 100644 build/platformclientv2/patchclosebuttonstyleproperties.go delete mode 100644 build/platformclientv2/patchcontentoffer.go delete mode 100644 build/platformclientv2/patchcontentofferstyleproperties.go delete mode 100644 build/platformclientv2/patchcontentofferstylingconfiguration.go delete mode 100644 build/platformclientv2/patchcontentpositionproperties.go delete mode 100644 build/platformclientv2/patchctabuttonstyleproperties.go delete mode 100644 build/platformclientv2/patchintegrationaction.go delete mode 100644 build/platformclientv2/patchintegrationactionfields.go delete mode 100644 build/platformclientv2/patchoutcome.go delete mode 100644 build/platformclientv2/patchsegment.go delete mode 100644 build/platformclientv2/patchshifttraderequest.go delete mode 100644 build/platformclientv2/patchsurveyquestion.go delete mode 100644 build/platformclientv2/patchtextstyleproperties.go delete mode 100644 build/platformclientv2/patchuser.go delete mode 100644 build/platformclientv2/permissioncollectionentitylisting.go delete mode 100644 build/platformclientv2/permissions.go delete mode 100644 build/platformclientv2/phone.go delete mode 100644 build/platformclientv2/phonebase.go delete mode 100644 build/platformclientv2/phonebaseentitylisting.go delete mode 100644 build/platformclientv2/phonecapabilities.go delete mode 100644 build/platformclientv2/phonechangetopicedgereference.go delete mode 100644 build/platformclientv2/phonechangetopiclinestatus.go delete mode 100644 build/platformclientv2/phonechangetopiclocaldate.go delete mode 100644 build/platformclientv2/phonechangetopiclocaldatetime.go delete mode 100644 build/platformclientv2/phonechangetopiclocaltime.go delete mode 100644 build/platformclientv2/phonechangetopicoffsetdatetime.go delete mode 100644 build/platformclientv2/phonechangetopicphone.go delete mode 100644 build/platformclientv2/phonechangetopicphonestatus.go delete mode 100644 build/platformclientv2/phonechangetopicprovisioninfo.go delete mode 100644 build/platformclientv2/phonechangetopicuseragentinfo.go delete mode 100644 build/platformclientv2/phonechangetopiczoneoffset.go delete mode 100644 build/platformclientv2/phonecolumn.go delete mode 100644 build/platformclientv2/phoneentitylisting.go delete mode 100644 build/platformclientv2/phonemetabaseentitylisting.go delete mode 100644 build/platformclientv2/phonenumber.go delete mode 100644 build/platformclientv2/phonenumbercolumn.go delete mode 100644 build/platformclientv2/phonenumberstatus.go delete mode 100644 build/platformclientv2/phonesreboot.go delete mode 100644 build/platformclientv2/phonestatus.go delete mode 100644 build/platformclientv2/physicalinterfaceentitylisting.go delete mode 100644 build/platformclientv2/pinconfiguration.go delete mode 100644 build/platformclientv2/pingidentity.go delete mode 100644 build/platformclientv2/planninggroup.go delete mode 100644 build/platformclientv2/planninggrouplist.go delete mode 100644 build/platformclientv2/planninggroupreference.go delete mode 100644 build/platformclientv2/planningperiodsettings.go delete mode 100644 build/platformclientv2/platformclientv2_test.go delete mode 100644 build/platformclientv2/policy.go delete mode 100644 build/platformclientv2/policyactions.go delete mode 100644 build/platformclientv2/policyconditions.go delete mode 100644 build/platformclientv2/policycreate.go delete mode 100644 build/platformclientv2/policyentitylisting.go delete mode 100644 build/platformclientv2/policyerrormessage.go delete mode 100644 build/platformclientv2/policyerrors.go delete mode 100644 build/platformclientv2/postactioninput.go delete mode 100644 build/platformclientv2/postinputcontract.go delete mode 100644 build/platformclientv2/postoutputcontract.go delete mode 100644 build/platformclientv2/posttextmessage.go delete mode 100644 build/platformclientv2/posttextrequest.go delete mode 100644 build/platformclientv2/posttextresponse.go delete mode 100644 build/platformclientv2/predictionresults.go delete mode 100644 build/platformclientv2/presenceapi.go delete mode 100644 build/platformclientv2/presencedefinition.go delete mode 100644 build/platformclientv2/presencedetailqueryclause.go delete mode 100644 build/platformclientv2/presencedetailqueryfilter.go delete mode 100644 build/platformclientv2/presencedetailquerypredicate.go delete mode 100644 build/platformclientv2/presenceeventorganizationpresence.go delete mode 100644 build/platformclientv2/presenceeventuserpresence.go delete mode 100644 build/platformclientv2/presenceexpand.go delete mode 100644 build/platformclientv2/prompt.go delete mode 100644 build/platformclientv2/promptasset.go delete mode 100644 build/platformclientv2/promptassetcreate.go delete mode 100644 build/platformclientv2/promptassetentitylisting.go delete mode 100644 build/platformclientv2/promptentitylisting.go delete mode 100644 build/platformclientv2/propertychange.go delete mode 100644 build/platformclientv2/propertyindexrequest.go delete mode 100644 build/platformclientv2/provisioninfo.go delete mode 100644 build/platformclientv2/publishdraftinput.go delete mode 100644 build/platformclientv2/publishedsurveyformreference.go delete mode 100644 build/platformclientv2/publishform.go delete mode 100644 build/platformclientv2/publishprogrampublishjob.go delete mode 100644 build/platformclientv2/publishtopicpublishjob.go delete mode 100644 build/platformclientv2/purecloud.go delete mode 100644 build/platformclientv2/pureengage.go delete mode 100644 build/platformclientv2/qualityapi.go delete mode 100644 build/platformclientv2/qualityaudit.go delete mode 100644 build/platformclientv2/qualityauditpage.go delete mode 100644 build/platformclientv2/querydivision.go delete mode 100644 build/platformclientv2/queryfacetinfo.go delete mode 100644 build/platformclientv2/queryrequest.go delete mode 100644 build/platformclientv2/queryrequestclause.go delete mode 100644 build/platformclientv2/queryrequestfilter.go delete mode 100644 build/platformclientv2/queryrequestpredicate.go delete mode 100644 build/platformclientv2/queryresponsedata.go delete mode 100644 build/platformclientv2/queryresponsegroupeddata.go delete mode 100644 build/platformclientv2/queryresponsemetric.go delete mode 100644 build/platformclientv2/queryresponsestats.go delete mode 100644 build/platformclientv2/queryresult.go delete mode 100644 build/platformclientv2/queryresults.go delete mode 100644 build/platformclientv2/queue.go delete mode 100644 build/platformclientv2/queueconversationcallbackeventtopiccallbackconversation.go delete mode 100644 build/platformclientv2/queueconversationcallbackeventtopiccallbackmediaparticipant.go delete mode 100644 build/platformclientv2/queueconversationcallbackeventtopicconversationroutingdata.go delete mode 100644 build/platformclientv2/queueconversationcallbackeventtopicdetail.go delete mode 100644 build/platformclientv2/queueconversationcallbackeventtopicdialerpreview.go delete mode 100644 build/platformclientv2/queueconversationcallbackeventtopicerrorbody.go delete mode 100644 build/platformclientv2/queueconversationcallbackeventtopicjourneyaction.go delete mode 100644 build/platformclientv2/queueconversationcallbackeventtopicjourneyactionmap.go delete mode 100644 build/platformclientv2/queueconversationcallbackeventtopicjourneycontext.go delete mode 100644 build/platformclientv2/queueconversationcallbackeventtopicjourneycustomer.go delete mode 100644 build/platformclientv2/queueconversationcallbackeventtopicjourneycustomersession.go delete mode 100644 build/platformclientv2/queueconversationcallbackeventtopicphonenumbercolumn.go delete mode 100644 build/platformclientv2/queueconversationcallbackeventtopicscoredagent.go delete mode 100644 build/platformclientv2/queueconversationcallbackeventtopicurireference.go delete mode 100644 build/platformclientv2/queueconversationcallbackeventtopicvoicemail.go delete mode 100644 build/platformclientv2/queueconversationcallbackeventtopicwrapup.go delete mode 100644 build/platformclientv2/queueconversationcalleventtopiccallconversation.go delete mode 100644 build/platformclientv2/queueconversationcalleventtopiccallmediaparticipant.go delete mode 100644 build/platformclientv2/queueconversationcalleventtopicconversationroutingdata.go delete mode 100644 build/platformclientv2/queueconversationcalleventtopicdetail.go delete mode 100644 build/platformclientv2/queueconversationcalleventtopicerrorbody.go delete mode 100644 build/platformclientv2/queueconversationcalleventtopicfaxstatus.go delete mode 100644 build/platformclientv2/queueconversationcalleventtopicjourneyaction.go delete mode 100644 build/platformclientv2/queueconversationcalleventtopicjourneyactionmap.go delete mode 100644 build/platformclientv2/queueconversationcalleventtopicjourneycontext.go delete mode 100644 build/platformclientv2/queueconversationcalleventtopicjourneycustomer.go delete mode 100644 build/platformclientv2/queueconversationcalleventtopicjourneycustomersession.go delete mode 100644 build/platformclientv2/queueconversationcalleventtopicscoredagent.go delete mode 100644 build/platformclientv2/queueconversationcalleventtopicurireference.go delete mode 100644 build/platformclientv2/queueconversationcalleventtopicwrapup.go delete mode 100644 build/platformclientv2/queueconversationchateventtopicchatconversation.go delete mode 100644 build/platformclientv2/queueconversationchateventtopicchatmediaparticipant.go delete mode 100644 build/platformclientv2/queueconversationchateventtopicconversationroutingdata.go delete mode 100644 build/platformclientv2/queueconversationchateventtopicdetail.go delete mode 100644 build/platformclientv2/queueconversationchateventtopicerrorbody.go delete mode 100644 build/platformclientv2/queueconversationchateventtopicjourneyaction.go delete mode 100644 build/platformclientv2/queueconversationchateventtopicjourneyactionmap.go delete mode 100644 build/platformclientv2/queueconversationchateventtopicjourneycontext.go delete mode 100644 build/platformclientv2/queueconversationchateventtopicjourneycustomer.go delete mode 100644 build/platformclientv2/queueconversationchateventtopicjourneycustomersession.go delete mode 100644 build/platformclientv2/queueconversationchateventtopicscoredagent.go delete mode 100644 build/platformclientv2/queueconversationchateventtopicurireference.go delete mode 100644 build/platformclientv2/queueconversationchateventtopicwrapup.go delete mode 100644 build/platformclientv2/queueconversationcobrowseeventtopiccobrowseconversation.go delete mode 100644 build/platformclientv2/queueconversationcobrowseeventtopiccobrowsemediaparticipant.go delete mode 100644 build/platformclientv2/queueconversationcobrowseeventtopicconversationroutingdata.go delete mode 100644 build/platformclientv2/queueconversationcobrowseeventtopicdetail.go delete mode 100644 build/platformclientv2/queueconversationcobrowseeventtopicerrorbody.go delete mode 100644 build/platformclientv2/queueconversationcobrowseeventtopicjourneyaction.go delete mode 100644 build/platformclientv2/queueconversationcobrowseeventtopicjourneyactionmap.go delete mode 100644 build/platformclientv2/queueconversationcobrowseeventtopicjourneycontext.go delete mode 100644 build/platformclientv2/queueconversationcobrowseeventtopicjourneycustomer.go delete mode 100644 build/platformclientv2/queueconversationcobrowseeventtopicjourneycustomersession.go delete mode 100644 build/platformclientv2/queueconversationcobrowseeventtopicscoredagent.go delete mode 100644 build/platformclientv2/queueconversationcobrowseeventtopicurireference.go delete mode 100644 build/platformclientv2/queueconversationcobrowseeventtopicwrapup.go delete mode 100644 build/platformclientv2/queueconversationemaileventtopicattachment.go delete mode 100644 build/platformclientv2/queueconversationemaileventtopicconversationroutingdata.go delete mode 100644 build/platformclientv2/queueconversationemaileventtopicdetail.go delete mode 100644 build/platformclientv2/queueconversationemaileventtopicemailconversation.go delete mode 100644 build/platformclientv2/queueconversationemaileventtopicemailmediaparticipant.go delete mode 100644 build/platformclientv2/queueconversationemaileventtopicerrorbody.go delete mode 100644 build/platformclientv2/queueconversationemaileventtopicjourneyaction.go delete mode 100644 build/platformclientv2/queueconversationemaileventtopicjourneyactionmap.go delete mode 100644 build/platformclientv2/queueconversationemaileventtopicjourneycontext.go delete mode 100644 build/platformclientv2/queueconversationemaileventtopicjourneycustomer.go delete mode 100644 build/platformclientv2/queueconversationemaileventtopicjourneycustomersession.go delete mode 100644 build/platformclientv2/queueconversationemaileventtopicscoredagent.go delete mode 100644 build/platformclientv2/queueconversationemaileventtopicurireference.go delete mode 100644 build/platformclientv2/queueconversationemaileventtopicwrapup.go delete mode 100644 build/platformclientv2/queueconversationeventtopicaddress.go delete mode 100644 build/platformclientv2/queueconversationeventtopicaftercallwork.go delete mode 100644 build/platformclientv2/queueconversationeventtopicattachment.go delete mode 100644 build/platformclientv2/queueconversationeventtopiccall.go delete mode 100644 build/platformclientv2/queueconversationeventtopiccallback.go delete mode 100644 build/platformclientv2/queueconversationeventtopicchat.go delete mode 100644 build/platformclientv2/queueconversationeventtopiccobrowse.go delete mode 100644 build/platformclientv2/queueconversationeventtopicconversation.go delete mode 100644 build/platformclientv2/queueconversationeventtopicconversationroutingdata.go delete mode 100644 build/platformclientv2/queueconversationeventtopicdialerpreview.go delete mode 100644 build/platformclientv2/queueconversationeventtopicdisconnectreason.go delete mode 100644 build/platformclientv2/queueconversationeventtopicemail.go delete mode 100644 build/platformclientv2/queueconversationeventtopicerrordetails.go delete mode 100644 build/platformclientv2/queueconversationeventtopicfaxstatus.go delete mode 100644 build/platformclientv2/queueconversationeventtopicjourneyaction.go delete mode 100644 build/platformclientv2/queueconversationeventtopicjourneyactionmap.go delete mode 100644 build/platformclientv2/queueconversationeventtopicjourneycontext.go delete mode 100644 build/platformclientv2/queueconversationeventtopicjourneycustomer.go delete mode 100644 build/platformclientv2/queueconversationeventtopicjourneycustomersession.go delete mode 100644 build/platformclientv2/queueconversationeventtopicmessage.go delete mode 100644 build/platformclientv2/queueconversationeventtopicmessagedetails.go delete mode 100644 build/platformclientv2/queueconversationeventtopicmessagemedia.go delete mode 100644 build/platformclientv2/queueconversationeventtopicmessagesticker.go delete mode 100644 build/platformclientv2/queueconversationeventtopicparticipant.go delete mode 100644 build/platformclientv2/queueconversationeventtopicphonenumbercolumn.go delete mode 100644 build/platformclientv2/queueconversationeventtopicscoredagent.go delete mode 100644 build/platformclientv2/queueconversationeventtopicscreenshare.go delete mode 100644 build/platformclientv2/queueconversationeventtopicsocialexpression.go delete mode 100644 build/platformclientv2/queueconversationeventtopicurireference.go delete mode 100644 build/platformclientv2/queueconversationeventtopicvideo.go delete mode 100644 build/platformclientv2/queueconversationeventtopicvoicemail.go delete mode 100644 build/platformclientv2/queueconversationeventtopicwrapup.go delete mode 100644 build/platformclientv2/queueconversationmessageeventtopicconversationroutingdata.go delete mode 100644 build/platformclientv2/queueconversationmessageeventtopicdetail.go delete mode 100644 build/platformclientv2/queueconversationmessageeventtopicerrorbody.go delete mode 100644 build/platformclientv2/queueconversationmessageeventtopicjourneyaction.go delete mode 100644 build/platformclientv2/queueconversationmessageeventtopicjourneyactionmap.go delete mode 100644 build/platformclientv2/queueconversationmessageeventtopicjourneycontext.go delete mode 100644 build/platformclientv2/queueconversationmessageeventtopicjourneycustomer.go delete mode 100644 build/platformclientv2/queueconversationmessageeventtopicjourneycustomersession.go delete mode 100644 build/platformclientv2/queueconversationmessageeventtopicmessageconversation.go delete mode 100644 build/platformclientv2/queueconversationmessageeventtopicmessagedetails.go delete mode 100644 build/platformclientv2/queueconversationmessageeventtopicmessagemedia.go delete mode 100644 build/platformclientv2/queueconversationmessageeventtopicmessagemediaparticipant.go delete mode 100644 build/platformclientv2/queueconversationmessageeventtopicmessagesticker.go delete mode 100644 build/platformclientv2/queueconversationmessageeventtopicscoredagent.go delete mode 100644 build/platformclientv2/queueconversationmessageeventtopicurireference.go delete mode 100644 build/platformclientv2/queueconversationmessageeventtopicwrapup.go delete mode 100644 build/platformclientv2/queueconversationscreenshareeventtopicconversationroutingdata.go delete mode 100644 build/platformclientv2/queueconversationscreenshareeventtopicdetail.go delete mode 100644 build/platformclientv2/queueconversationscreenshareeventtopicerrorbody.go delete mode 100644 build/platformclientv2/queueconversationscreenshareeventtopicjourneyaction.go delete mode 100644 build/platformclientv2/queueconversationscreenshareeventtopicjourneyactionmap.go delete mode 100644 build/platformclientv2/queueconversationscreenshareeventtopicjourneycontext.go delete mode 100644 build/platformclientv2/queueconversationscreenshareeventtopicjourneycustomer.go delete mode 100644 build/platformclientv2/queueconversationscreenshareeventtopicjourneycustomersession.go delete mode 100644 build/platformclientv2/queueconversationscreenshareeventtopicscoredagent.go delete mode 100644 build/platformclientv2/queueconversationscreenshareeventtopicscreenshareconversation.go delete mode 100644 build/platformclientv2/queueconversationscreenshareeventtopicscreensharemediaparticipant.go delete mode 100644 build/platformclientv2/queueconversationscreenshareeventtopicurireference.go delete mode 100644 build/platformclientv2/queueconversationscreenshareeventtopicwrapup.go delete mode 100644 build/platformclientv2/queueconversationsocialexpressioneventtopicaddress.go delete mode 100644 build/platformclientv2/queueconversationsocialexpressioneventtopicaftercallwork.go delete mode 100644 build/platformclientv2/queueconversationsocialexpressioneventtopicattachment.go delete mode 100644 build/platformclientv2/queueconversationsocialexpressioneventtopiccall.go delete mode 100644 build/platformclientv2/queueconversationsocialexpressioneventtopiccallback.go delete mode 100644 build/platformclientv2/queueconversationsocialexpressioneventtopicchat.go delete mode 100644 build/platformclientv2/queueconversationsocialexpressioneventtopiccobrowse.go delete mode 100644 build/platformclientv2/queueconversationsocialexpressioneventtopicconversation.go delete mode 100644 build/platformclientv2/queueconversationsocialexpressioneventtopicconversationroutingdata.go delete mode 100644 build/platformclientv2/queueconversationsocialexpressioneventtopicdialerpreview.go delete mode 100644 build/platformclientv2/queueconversationsocialexpressioneventtopicdisconnectreason.go delete mode 100644 build/platformclientv2/queueconversationsocialexpressioneventtopicemail.go delete mode 100644 build/platformclientv2/queueconversationsocialexpressioneventtopicerrordetails.go delete mode 100644 build/platformclientv2/queueconversationsocialexpressioneventtopicfaxstatus.go delete mode 100644 build/platformclientv2/queueconversationsocialexpressioneventtopicjourneyaction.go delete mode 100644 build/platformclientv2/queueconversationsocialexpressioneventtopicjourneyactionmap.go delete mode 100644 build/platformclientv2/queueconversationsocialexpressioneventtopicjourneycontext.go delete mode 100644 build/platformclientv2/queueconversationsocialexpressioneventtopicjourneycustomer.go delete mode 100644 build/platformclientv2/queueconversationsocialexpressioneventtopicjourneycustomersession.go delete mode 100644 build/platformclientv2/queueconversationsocialexpressioneventtopicmessage.go delete mode 100644 build/platformclientv2/queueconversationsocialexpressioneventtopicmessagedetails.go delete mode 100644 build/platformclientv2/queueconversationsocialexpressioneventtopicmessagemedia.go delete mode 100644 build/platformclientv2/queueconversationsocialexpressioneventtopicmessagesticker.go delete mode 100644 build/platformclientv2/queueconversationsocialexpressioneventtopicparticipant.go delete mode 100644 build/platformclientv2/queueconversationsocialexpressioneventtopicphonenumbercolumn.go delete mode 100644 build/platformclientv2/queueconversationsocialexpressioneventtopicscoredagent.go delete mode 100644 build/platformclientv2/queueconversationsocialexpressioneventtopicscreenshare.go delete mode 100644 build/platformclientv2/queueconversationsocialexpressioneventtopicsocialexpression.go delete mode 100644 build/platformclientv2/queueconversationsocialexpressioneventtopicurireference.go delete mode 100644 build/platformclientv2/queueconversationsocialexpressioneventtopicvideo.go delete mode 100644 build/platformclientv2/queueconversationsocialexpressioneventtopicvoicemail.go delete mode 100644 build/platformclientv2/queueconversationsocialexpressioneventtopicwrapup.go delete mode 100644 build/platformclientv2/queueconversationvideoeventtopicaddress.go delete mode 100644 build/platformclientv2/queueconversationvideoeventtopicaftercallwork.go delete mode 100644 build/platformclientv2/queueconversationvideoeventtopicattachment.go delete mode 100644 build/platformclientv2/queueconversationvideoeventtopiccall.go delete mode 100644 build/platformclientv2/queueconversationvideoeventtopiccallback.go delete mode 100644 build/platformclientv2/queueconversationvideoeventtopicchat.go delete mode 100644 build/platformclientv2/queueconversationvideoeventtopiccobrowse.go delete mode 100644 build/platformclientv2/queueconversationvideoeventtopicconversation.go delete mode 100644 build/platformclientv2/queueconversationvideoeventtopicconversationroutingdata.go delete mode 100644 build/platformclientv2/queueconversationvideoeventtopicdialerpreview.go delete mode 100644 build/platformclientv2/queueconversationvideoeventtopicdisconnectreason.go delete mode 100644 build/platformclientv2/queueconversationvideoeventtopicemail.go delete mode 100644 build/platformclientv2/queueconversationvideoeventtopicerrordetails.go delete mode 100644 build/platformclientv2/queueconversationvideoeventtopicfaxstatus.go delete mode 100644 build/platformclientv2/queueconversationvideoeventtopicjourneyaction.go delete mode 100644 build/platformclientv2/queueconversationvideoeventtopicjourneyactionmap.go delete mode 100644 build/platformclientv2/queueconversationvideoeventtopicjourneycontext.go delete mode 100644 build/platformclientv2/queueconversationvideoeventtopicjourneycustomer.go delete mode 100644 build/platformclientv2/queueconversationvideoeventtopicjourneycustomersession.go delete mode 100644 build/platformclientv2/queueconversationvideoeventtopicmessage.go delete mode 100644 build/platformclientv2/queueconversationvideoeventtopicmessagedetails.go delete mode 100644 build/platformclientv2/queueconversationvideoeventtopicmessagemedia.go delete mode 100644 build/platformclientv2/queueconversationvideoeventtopicmessagesticker.go delete mode 100644 build/platformclientv2/queueconversationvideoeventtopicparticipant.go delete mode 100644 build/platformclientv2/queueconversationvideoeventtopicphonenumbercolumn.go delete mode 100644 build/platformclientv2/queueconversationvideoeventtopicscoredagent.go delete mode 100644 build/platformclientv2/queueconversationvideoeventtopicscreenshare.go delete mode 100644 build/platformclientv2/queueconversationvideoeventtopicsocialexpression.go delete mode 100644 build/platformclientv2/queueconversationvideoeventtopicurireference.go delete mode 100644 build/platformclientv2/queueconversationvideoeventtopicvideo.go delete mode 100644 build/platformclientv2/queueconversationvideoeventtopicvoicemail.go delete mode 100644 build/platformclientv2/queueconversationvideoeventtopicwrapup.go delete mode 100644 build/platformclientv2/queueemailaddress.go delete mode 100644 build/platformclientv2/queueentitylisting.go delete mode 100644 build/platformclientv2/queuemember.go delete mode 100644 build/platformclientv2/queuememberentitylisting.go delete mode 100644 build/platformclientv2/queuemessagingaddresses.go delete mode 100644 build/platformclientv2/queueobservationdatacontainer.go delete mode 100644 build/platformclientv2/queueobservationquery.go delete mode 100644 build/platformclientv2/queueobservationqueryclause.go delete mode 100644 build/platformclientv2/queueobservationqueryfilter.go delete mode 100644 build/platformclientv2/queueobservationquerypredicate.go delete mode 100644 build/platformclientv2/queueobservationqueryresponse.go delete mode 100644 build/platformclientv2/queuereference.go delete mode 100644 build/platformclientv2/queuerequest.go delete mode 100644 build/platformclientv2/queueusereventtopicqueuemember.go delete mode 100644 build/platformclientv2/queueusereventtopicuserreference.go delete mode 100644 build/platformclientv2/queueutilizationdiagnostic.go delete mode 100644 build/platformclientv2/reaction.go delete mode 100644 build/platformclientv2/recallentry.go delete mode 100644 build/platformclientv2/recipient.go delete mode 100644 build/platformclientv2/recipientlisting.go delete mode 100644 build/platformclientv2/record.go delete mode 100644 build/platformclientv2/recording.go delete mode 100644 build/platformclientv2/recordingapi.go delete mode 100644 build/platformclientv2/recordingarchiverestoretopicmediaresult.go delete mode 100644 build/platformclientv2/recordingarchiverestoretopicrecording.go delete mode 100644 build/platformclientv2/recordingemailmessage.go delete mode 100644 build/platformclientv2/recordingeventmediaresult.go delete mode 100644 build/platformclientv2/recordingeventrecording.go delete mode 100644 build/platformclientv2/recordingjob.go delete mode 100644 build/platformclientv2/recordingjobentitylisting.go delete mode 100644 build/platformclientv2/recordingjobsquery.go delete mode 100644 build/platformclientv2/recordingmessagingmessage.go delete mode 100644 build/platformclientv2/recordingmetadata.go delete mode 100644 build/platformclientv2/recordingsettings.go delete mode 100644 build/platformclientv2/recordingtranscodecompletetopicmediaresult.go delete mode 100644 build/platformclientv2/recordingtranscodecompletetopicrecording.go delete mode 100644 build/platformclientv2/regiontimezone.go delete mode 100644 build/platformclientv2/relationship.go delete mode 100644 build/platformclientv2/relationshiplisting.go delete mode 100644 build/platformclientv2/replacementterm.go delete mode 100644 build/platformclientv2/replacerequest.go delete mode 100644 build/platformclientv2/replaceresponse.go delete mode 100644 build/platformclientv2/reportingdataexporttopicdataexportnotification.go delete mode 100644 build/platformclientv2/reportingexportjoblisting.go delete mode 100644 build/platformclientv2/reportingexportjobrequest.go delete mode 100644 build/platformclientv2/reportingexportjobresponse.go delete mode 100644 build/platformclientv2/reportingexportmetadatajoblisting.go delete mode 100644 build/platformclientv2/reportingexportmetadatajobresponse.go delete mode 100644 build/platformclientv2/reportmetadata.go delete mode 100644 build/platformclientv2/reportmetadataentitylisting.go delete mode 100644 build/platformclientv2/reportrunentry.go delete mode 100644 build/platformclientv2/reportrunentryentitydomainlisting.go delete mode 100644 build/platformclientv2/reportschedule.go delete mode 100644 build/platformclientv2/reportscheduleentitylisting.go delete mode 100644 build/platformclientv2/requestconfig.go delete mode 100644 build/platformclientv2/requestmapping.go delete mode 100644 build/platformclientv2/reschedulingmanagementunitresponse.go delete mode 100644 build/platformclientv2/reschedulingoptionsrunresponse.go delete mode 100644 build/platformclientv2/resolutiondetailqueryclause.go delete mode 100644 build/platformclientv2/resolutiondetailqueryfilter.go delete mode 100644 build/platformclientv2/resolutiondetailquerypredicate.go delete mode 100644 build/platformclientv2/resourceconditionnode.go delete mode 100644 build/platformclientv2/resourceconditionvalue.go delete mode 100644 build/platformclientv2/resourcepermissionpolicy.go delete mode 100644 build/platformclientv2/response.go delete mode 100644 build/platformclientv2/responseconfig.go delete mode 100644 build/platformclientv2/responseentitylist.go delete mode 100644 build/platformclientv2/responseentitylisting.go delete mode 100644 build/platformclientv2/responsefilter.go delete mode 100644 build/platformclientv2/responsemanagementapi.go delete mode 100644 build/platformclientv2/responsequeryrequest.go delete mode 100644 build/platformclientv2/responsequeryresults.go delete mode 100644 build/platformclientv2/responseset.go delete mode 100644 build/platformclientv2/responsesetentitylisting.go delete mode 100644 build/platformclientv2/responsesubstitution.go delete mode 100644 build/platformclientv2/responsetext.go delete mode 100644 build/platformclientv2/resterrordetail.go delete mode 100644 build/platformclientv2/retentionduration.go delete mode 100644 build/platformclientv2/reversewhitepageslookupresult.go delete mode 100644 build/platformclientv2/ring.go delete mode 100644 build/platformclientv2/roledivision.go delete mode 100644 build/platformclientv2/roledivisiongrants.go delete mode 100644 build/platformclientv2/roledivisionpair.go delete mode 100644 build/platformclientv2/routepathrequest.go delete mode 100644 build/platformclientv2/routepathresponse.go delete mode 100644 build/platformclientv2/routingapi.go delete mode 100644 build/platformclientv2/routingdata.go delete mode 100644 build/platformclientv2/routingrule.go delete mode 100644 build/platformclientv2/routingsettings.go delete mode 100644 build/platformclientv2/routingskill.go delete mode 100644 build/platformclientv2/routingskillreference.go delete mode 100644 build/platformclientv2/routingstatus.go delete mode 100644 build/platformclientv2/routingstatusdetailqueryclause.go delete mode 100644 build/platformclientv2/routingstatusdetailqueryfilter.go delete mode 100644 build/platformclientv2/routingstatusdetailquerypredicate.go delete mode 100644 build/platformclientv2/ruleset.go delete mode 100644 build/platformclientv2/rulesetdiagnostic.go delete mode 100644 build/platformclientv2/rulesetentitylisting.go delete mode 100644 build/platformclientv2/salesforce.go delete mode 100644 build/platformclientv2/schedule.go delete mode 100644 build/platformclientv2/scheduleentitylisting.go delete mode 100644 build/platformclientv2/schedulegenerationmessage.go delete mode 100644 build/platformclientv2/schedulegenerationresult.go delete mode 100644 build/platformclientv2/schedulegenerationresultsummary.go delete mode 100644 build/platformclientv2/schedulegenerationwarning.go delete mode 100644 build/platformclientv2/schedulegroup.go delete mode 100644 build/platformclientv2/schedulegroupentitylisting.go delete mode 100644 build/platformclientv2/scheduleinterval.go delete mode 100644 build/platformclientv2/schedulermessageargument.go delete mode 100644 build/platformclientv2/schedulingprocessingerror.go delete mode 100644 build/platformclientv2/schedulingsettingsrequest.go delete mode 100644 build/platformclientv2/schedulingsettingsresponse.go delete mode 100644 build/platformclientv2/schedulingstatusresponse.go delete mode 100644 build/platformclientv2/schedulingtestingoptionsrequest.go delete mode 100644 build/platformclientv2/schema.go delete mode 100644 build/platformclientv2/schemacategory.go delete mode 100644 build/platformclientv2/schemacategoryentitylisting.go delete mode 100644 build/platformclientv2/schemaquantitylimits.go delete mode 100644 build/platformclientv2/schemareferenceentitylisting.go delete mode 100644 build/platformclientv2/scimapi.go delete mode 100644 build/platformclientv2/scimconfigresourcetype.go delete mode 100644 build/platformclientv2/scimconfigresourcetypeschemaextension.go delete mode 100644 build/platformclientv2/scimconfigresourcetypeslistresponse.go delete mode 100644 build/platformclientv2/scimemail.go delete mode 100644 build/platformclientv2/scimerror.go delete mode 100644 build/platformclientv2/scimgenesysuserexternalid.go delete mode 100644 build/platformclientv2/scimgrouplistresponse.go delete mode 100644 build/platformclientv2/scimmetadata.go delete mode 100644 build/platformclientv2/scimphonenumber.go delete mode 100644 build/platformclientv2/scimserviceproviderconfig.go delete mode 100644 build/platformclientv2/scimserviceproviderconfigauthenticationscheme.go delete mode 100644 build/platformclientv2/scimserviceproviderconfigbulkfeature.go delete mode 100644 build/platformclientv2/scimserviceproviderconfigfilterfeature.go delete mode 100644 build/platformclientv2/scimserviceproviderconfigsimplefeature.go delete mode 100644 build/platformclientv2/scimuserextensions.go delete mode 100644 build/platformclientv2/scimuserlistresponse.go delete mode 100644 build/platformclientv2/scimuserrole.go delete mode 100644 build/platformclientv2/scimuserroutinglanguage.go delete mode 100644 build/platformclientv2/scimuserroutingskill.go delete mode 100644 build/platformclientv2/scimv2createuser.go delete mode 100644 build/platformclientv2/scimv2enterpriseuser.go delete mode 100644 build/platformclientv2/scimv2group.go delete mode 100644 build/platformclientv2/scimv2groupreference.go delete mode 100644 build/platformclientv2/scimv2memberreference.go delete mode 100644 build/platformclientv2/scimv2patchoperation.go delete mode 100644 build/platformclientv2/scimv2patchrequest.go delete mode 100644 build/platformclientv2/scimv2schemaattribute.go delete mode 100644 build/platformclientv2/scimv2schemadefinition.go delete mode 100644 build/platformclientv2/scimv2schemalistresponse.go delete mode 100644 build/platformclientv2/scimv2user.go delete mode 100644 build/platformclientv2/scorablesurvey.go delete mode 100644 build/platformclientv2/scoredagent.go delete mode 100644 build/platformclientv2/screenrecordingsession.go delete mode 100644 build/platformclientv2/screenrecordingsessionlisting.go delete mode 100644 build/platformclientv2/screenrecordingsessionrequest.go delete mode 100644 build/platformclientv2/screenshare.go delete mode 100644 build/platformclientv2/script.go delete mode 100644 build/platformclientv2/scriptentitylisting.go delete mode 100644 build/platformclientv2/scriptsapi.go delete mode 100644 build/platformclientv2/searchaggregation.go delete mode 100644 build/platformclientv2/searchapi.go delete mode 100644 build/platformclientv2/searchcriteria.go delete mode 100644 build/platformclientv2/searchrequest.go delete mode 100644 build/platformclientv2/searchshifttraderesponse.go delete mode 100644 build/platformclientv2/searchshifttradesrequest.go delete mode 100644 build/platformclientv2/searchshifttradesresponse.go delete mode 100644 build/platformclientv2/searchsort.go delete mode 100644 build/platformclientv2/section.go delete mode 100644 build/platformclientv2/securesession.go delete mode 100644 build/platformclientv2/securesessionentitylisting.go delete mode 100644 build/platformclientv2/securityprofile.go delete mode 100644 build/platformclientv2/securityprofileentitylisting.go delete mode 100644 build/platformclientv2/segment.go delete mode 100644 build/platformclientv2/segmentdetailqueryclause.go delete mode 100644 build/platformclientv2/segmentdetailqueryfilter.go delete mode 100644 build/platformclientv2/segmentdetailquerypredicate.go delete mode 100644 build/platformclientv2/segmentlisting.go delete mode 100644 build/platformclientv2/selectedcolumns.go delete mode 100644 build/platformclientv2/sendagentlessoutboundmessagerequest.go delete mode 100644 build/platformclientv2/sendagentlessoutboundmessageresponse.go delete mode 100644 build/platformclientv2/sequenceschedule.go delete mode 100644 build/platformclientv2/serverdate.go delete mode 100644 build/platformclientv2/servicecontext.go delete mode 100644 build/platformclientv2/servicegoaltemplate.go delete mode 100644 build/platformclientv2/servicegoaltemplatelist.go delete mode 100644 build/platformclientv2/servicegoaltemplatereference.go delete mode 100644 build/platformclientv2/servicelevel.go delete mode 100644 build/platformclientv2/setuuidatarequest.go delete mode 100644 build/platformclientv2/setwrapperdayofweek.go delete mode 100644 build/platformclientv2/setwrapperroutepathrequest.go delete mode 100644 build/platformclientv2/share.go delete mode 100644 build/platformclientv2/sharedentity.go delete mode 100644 build/platformclientv2/sharedresponse.go delete mode 100644 build/platformclientv2/shareentitylisting.go delete mode 100644 build/platformclientv2/shiftstartvariance.go delete mode 100644 build/platformclientv2/shifttradeactivitypreviewresponse.go delete mode 100644 build/platformclientv2/shifttradeactivityrule.go delete mode 100644 build/platformclientv2/shifttradelistresponse.go delete mode 100644 build/platformclientv2/shifttradematchessummaryresponse.go delete mode 100644 build/platformclientv2/shifttradematchreviewresponse.go delete mode 100644 build/platformclientv2/shifttradematchreviewuserresponse.go delete mode 100644 build/platformclientv2/shifttradematchviolation.go delete mode 100644 build/platformclientv2/shifttradenotification.go delete mode 100644 build/platformclientv2/shifttradepreviewresponse.go delete mode 100644 build/platformclientv2/shifttraderesponse.go delete mode 100644 build/platformclientv2/shifttradesettings.go delete mode 100644 build/platformclientv2/shorttermforecastingsettings.go delete mode 100644 build/platformclientv2/shorttermforecastreference.go delete mode 100644 build/platformclientv2/shrinkageoverride.go delete mode 100644 build/platformclientv2/shrinkageoverrides.go delete mode 100644 build/platformclientv2/signedurlresponse.go delete mode 100644 build/platformclientv2/sipdownloadresponse.go delete mode 100644 build/platformclientv2/sipsearchpublicrequest.go delete mode 100644 build/platformclientv2/sipsearchresult.go delete mode 100644 build/platformclientv2/site.go delete mode 100644 build/platformclientv2/siteentitylisting.go delete mode 100644 build/platformclientv2/skillentitylisting.go delete mode 100644 build/platformclientv2/skillstoremove.go delete mode 100644 build/platformclientv2/smsaddress.go delete mode 100644 build/platformclientv2/smsaddressentitylisting.go delete mode 100644 build/platformclientv2/smsaddressprovision.go delete mode 100644 build/platformclientv2/smsavailablephonenumber.go delete mode 100644 build/platformclientv2/smsavailablephonenumberentitylisting.go delete mode 100644 build/platformclientv2/smsconfig.go delete mode 100644 build/platformclientv2/smsphonenumber.go delete mode 100644 build/platformclientv2/smsphonenumberentitylisting.go delete mode 100644 build/platformclientv2/smsphonenumberprovision.go delete mode 100644 build/platformclientv2/smsphonenumberref.go delete mode 100644 build/platformclientv2/socialexpression.go delete mode 100644 build/platformclientv2/socialhandle.go delete mode 100644 build/platformclientv2/sortitem.go delete mode 100644 build/platformclientv2/sourceplanninggrouprequest.go delete mode 100644 build/platformclientv2/speechtextanalyticsapi.go delete mode 100644 build/platformclientv2/speechtextanalyticssettingsrequest.go delete mode 100644 build/platformclientv2/speechtextanalyticssettingsresponse.go delete mode 100644 build/platformclientv2/stateventcampaigntopicdatum.go delete mode 100644 build/platformclientv2/stateventcampaigntopicmetric.go delete mode 100644 build/platformclientv2/stateventcampaigntopicstatsnotification.go delete mode 100644 build/platformclientv2/stateventflowoutcometopicdatum.go delete mode 100644 build/platformclientv2/stateventflowoutcometopicmetric.go delete mode 100644 build/platformclientv2/stateventflowoutcometopicstatsnotification.go delete mode 100644 build/platformclientv2/stateventflowtopicdatum.go delete mode 100644 build/platformclientv2/stateventflowtopicmetric.go delete mode 100644 build/platformclientv2/stateventflowtopicstatsnotification.go delete mode 100644 build/platformclientv2/stateventqueuetopicdatum.go delete mode 100644 build/platformclientv2/stateventqueuetopicmetric.go delete mode 100644 build/platformclientv2/stateventqueuetopicstatsnotification.go delete mode 100644 build/platformclientv2/stateventusertopicdatum.go delete mode 100644 build/platformclientv2/stateventusertopicmetric.go delete mode 100644 build/platformclientv2/stateventusertopicstatsnotification.go delete mode 100644 build/platformclientv2/stateventwrapupcodetopicdatum.go delete mode 100644 build/platformclientv2/stateventwrapupcodetopicmetric.go delete mode 100644 build/platformclientv2/stateventwrapupcodetopicstatsnotification.go delete mode 100644 build/platformclientv2/station.go delete mode 100644 build/platformclientv2/stationentitylisting.go delete mode 100644 build/platformclientv2/stationsapi.go delete mode 100644 build/platformclientv2/stationsettings.go delete mode 100644 build/platformclientv2/statisticalresponse.go delete mode 100644 build/platformclientv2/statisticalsummary.go delete mode 100644 build/platformclientv2/streetaddress.go delete mode 100644 build/platformclientv2/subjectdivisiongrants.go delete mode 100644 build/platformclientv2/subjectdivisiongrantsentitylisting.go delete mode 100644 build/platformclientv2/subjectdivisions.go delete mode 100644 build/platformclientv2/subscriberresponse.go delete mode 100644 build/platformclientv2/subscriptionoverviewusage.go delete mode 100644 build/platformclientv2/suggestapi.go delete mode 100644 build/platformclientv2/suggestsearchcriteria.go delete mode 100644 build/platformclientv2/suggestsearchrequest.go delete mode 100644 build/platformclientv2/supportedcontent.go delete mode 100644 build/platformclientv2/supportedlanguage.go delete mode 100644 build/platformclientv2/survey.go delete mode 100644 build/platformclientv2/surveyaggregatedatacontainer.go delete mode 100644 build/platformclientv2/surveyaggregatequeryclause.go delete mode 100644 build/platformclientv2/surveyaggregatequeryfilter.go delete mode 100644 build/platformclientv2/surveyaggregatequerypredicate.go delete mode 100644 build/platformclientv2/surveyaggregatequeryresponse.go delete mode 100644 build/platformclientv2/surveyaggregationquery.go delete mode 100644 build/platformclientv2/surveyaggregationview.go delete mode 100644 build/platformclientv2/surveyassignment.go delete mode 100644 build/platformclientv2/surveydetailqueryclause.go delete mode 100644 build/platformclientv2/surveydetailqueryfilter.go delete mode 100644 build/platformclientv2/surveydetailquerypredicate.go delete mode 100644 build/platformclientv2/surveyerrordetails.go delete mode 100644 build/platformclientv2/surveyform.go delete mode 100644 build/platformclientv2/surveyformandscoringset.go delete mode 100644 build/platformclientv2/surveyformentitylisting.go delete mode 100644 build/platformclientv2/surveyquestion.go delete mode 100644 build/platformclientv2/surveyquestiongroup.go delete mode 100644 build/platformclientv2/surveyquestiongroupscore.go delete mode 100644 build/platformclientv2/surveyquestionscore.go delete mode 100644 build/platformclientv2/surveyscoringset.go delete mode 100644 build/platformclientv2/systemmessagesystemmessage.go delete mode 100644 build/platformclientv2/systempresence.go delete mode 100644 build/platformclientv2/systemprompt.go delete mode 100644 build/platformclientv2/systempromptasset.go delete mode 100644 build/platformclientv2/systempromptassetentitylisting.go delete mode 100644 build/platformclientv2/systempromptentitylisting.go delete mode 100644 build/platformclientv2/tagqueryrequest.go delete mode 100644 build/platformclientv2/tagvalue.go delete mode 100644 build/platformclientv2/tagvalueentitylisting.go delete mode 100644 build/platformclientv2/telephonyapi.go delete mode 100644 build/platformclientv2/telephonyprovidersedgeapi.go delete mode 100644 build/platformclientv2/templateparameter.go delete mode 100644 build/platformclientv2/termattribute.go delete mode 100644 build/platformclientv2/testexecutionoperationresult.go delete mode 100644 build/platformclientv2/testexecutionresult.go delete mode 100644 build/platformclientv2/testmessage.go delete mode 100644 build/platformclientv2/textbotsapi.go delete mode 100644 build/platformclientv2/textmessagelisting.go delete mode 100644 build/platformclientv2/textstyleproperties.go delete mode 100644 build/platformclientv2/ticker.go delete mode 100644 build/platformclientv2/timeallowed.go delete mode 100644 build/platformclientv2/timeinterval.go delete mode 100644 build/platformclientv2/timeoffrequest.go delete mode 100644 build/platformclientv2/timeoffrequestlist.go delete mode 100644 build/platformclientv2/timeoffrequestlisting.go delete mode 100644 build/platformclientv2/timeoffrequestnotification.go delete mode 100644 build/platformclientv2/timeoffrequestquerybody.go delete mode 100644 build/platformclientv2/timeoffrequestresponse.go delete mode 100644 build/platformclientv2/timeoffrequestsettings.go delete mode 100644 build/platformclientv2/timeslot.go delete mode 100644 build/platformclientv2/timezoneentitylisting.go delete mode 100644 build/platformclientv2/timezonemappingpreview.go delete mode 100644 build/platformclientv2/tokeninfo.go delete mode 100644 build/platformclientv2/tokeninfocloneduser.go delete mode 100644 build/platformclientv2/tokensapi.go delete mode 100644 build/platformclientv2/traininglisting.go delete mode 100644 build/platformclientv2/transcriptaggregatedatacontainer.go delete mode 100644 build/platformclientv2/transcriptaggregatequeryclause.go delete mode 100644 build/platformclientv2/transcriptaggregatequeryfilter.go delete mode 100644 build/platformclientv2/transcriptaggregatequerypredicate.go delete mode 100644 build/platformclientv2/transcriptaggregatequeryresponse.go delete mode 100644 build/platformclientv2/transcriptaggregationquery.go delete mode 100644 build/platformclientv2/transcriptaggregationview.go delete mode 100644 build/platformclientv2/transcriptconversationdetailsearchcriteria.go delete mode 100644 build/platformclientv2/transcriptconversationdetailsearchrequest.go delete mode 100644 build/platformclientv2/transcriptionsettings.go delete mode 100644 build/platformclientv2/transcripts.go delete mode 100644 build/platformclientv2/transcriptsearchcriteria.go delete mode 100644 build/platformclientv2/transcriptsearchrequest.go delete mode 100644 build/platformclientv2/transcripturl.go delete mode 100644 build/platformclientv2/transferrequest.go delete mode 100644 build/platformclientv2/trunk.go delete mode 100644 build/platformclientv2/trunkbase.go delete mode 100644 build/platformclientv2/trunkbaseassignment.go delete mode 100644 build/platformclientv2/trunkbaseentitylisting.go delete mode 100644 build/platformclientv2/trunkconnectedstatus.go delete mode 100644 build/platformclientv2/trunkentitylisting.go delete mode 100644 build/platformclientv2/trunkerrorinfo.go delete mode 100644 build/platformclientv2/trunkerrorinfodetails.go delete mode 100644 build/platformclientv2/trunkinstancetopictrunk.go delete mode 100644 build/platformclientv2/trunkinstancetopictrunkconnectedstatus.go delete mode 100644 build/platformclientv2/trunkinstancetopictrunkerrorinfo.go delete mode 100644 build/platformclientv2/trunkinstancetopictrunkerrorinfodetails.go delete mode 100644 build/platformclientv2/trunkinstancetopictrunkmetricsnetworktypeip.go delete mode 100644 build/platformclientv2/trunkinstancetopictrunkmetricsoptions.go delete mode 100644 build/platformclientv2/trunkinstancetopictrunkmetricsregisters.go delete mode 100644 build/platformclientv2/trunkmetabaseentitylisting.go delete mode 100644 build/platformclientv2/trunkmetrics.go delete mode 100644 build/platformclientv2/trunkmetricscalls.go delete mode 100644 build/platformclientv2/trunkmetricsnetworktypeip.go delete mode 100644 build/platformclientv2/trunkmetricsoptions.go delete mode 100644 build/platformclientv2/trunkmetricsqos.go delete mode 100644 build/platformclientv2/trunkmetricsregisters.go delete mode 100644 build/platformclientv2/trunkmetricstopiclocaldate.go delete mode 100644 build/platformclientv2/trunkmetricstopiclocaldatetime.go delete mode 100644 build/platformclientv2/trunkmetricstopiclocaltime.go delete mode 100644 build/platformclientv2/trunkmetricstopicoffsetdatetime.go delete mode 100644 build/platformclientv2/trunkmetricstopictrunkmetrics.go delete mode 100644 build/platformclientv2/trunkmetricstopictrunkmetricscalls.go delete mode 100644 build/platformclientv2/trunkmetricstopictrunkmetricsqos.go delete mode 100644 build/platformclientv2/trunkmetricstopicurireference.go delete mode 100644 build/platformclientv2/trunkmetricstopiczoneoffset.go delete mode 100644 build/platformclientv2/trunkrecordingenabledcount.go delete mode 100644 build/platformclientv2/trustcreate.go delete mode 100644 build/platformclientv2/trustee.go delete mode 100644 build/platformclientv2/trusteeauditqueryrequest.go delete mode 100644 build/platformclientv2/trusteeauthorization.go delete mode 100644 build/platformclientv2/trusteebillingoverview.go delete mode 100644 build/platformclientv2/trustentitylisting.go delete mode 100644 build/platformclientv2/trustgroup.go delete mode 100644 build/platformclientv2/trustmembercreate.go delete mode 100644 build/platformclientv2/trustor.go delete mode 100644 build/platformclientv2/trustorauditqueryrequest.go delete mode 100644 build/platformclientv2/trustorentitylisting.go delete mode 100644 build/platformclientv2/trustrequest.go delete mode 100644 build/platformclientv2/trustrequestcreate.go delete mode 100644 build/platformclientv2/trustuser.go delete mode 100644 build/platformclientv2/trustuserdetails.go delete mode 100644 build/platformclientv2/trustuserentitylisting.go delete mode 100644 build/platformclientv2/ttsengineentity.go delete mode 100644 build/platformclientv2/ttsengineentitylisting.go delete mode 100644 build/platformclientv2/ttssettings.go delete mode 100644 build/platformclientv2/ttsvoiceentity.go delete mode 100644 build/platformclientv2/ttsvoiceentitylisting.go delete mode 100644 build/platformclientv2/twitterid.go delete mode 100644 build/platformclientv2/twitterintegration.go delete mode 100644 build/platformclientv2/twitterintegrationentitylisting.go delete mode 100644 build/platformclientv2/twitterintegrationrequest.go delete mode 100644 build/platformclientv2/unreadmetric.go delete mode 100644 build/platformclientv2/unreadstatus.go delete mode 100644 build/platformclientv2/updateactioninput.go delete mode 100644 build/platformclientv2/updateactivitycoderequest.go delete mode 100644 build/platformclientv2/updatebusinessunitrequest.go delete mode 100644 build/platformclientv2/updatebusinessunitsettings.go delete mode 100644 build/platformclientv2/updatecoachingappointmentrequest.go delete mode 100644 build/platformclientv2/updatedraftinput.go delete mode 100644 build/platformclientv2/updatemanagementunitrequest.go delete mode 100644 build/platformclientv2/updatenotificationresponse.go delete mode 100644 build/platformclientv2/updatenotificationsrequest.go delete mode 100644 build/platformclientv2/updatenotificationsresponse.go delete mode 100644 build/platformclientv2/updateplanninggrouprequest.go delete mode 100644 build/platformclientv2/updateservicegoaltemplate.go delete mode 100644 build/platformclientv2/updateuser.go delete mode 100644 build/platformclientv2/updateworkplanrotationagentrequest.go delete mode 100644 build/platformclientv2/updateworkplanrotationrequest.go delete mode 100644 build/platformclientv2/uploadsapi.go delete mode 100644 build/platformclientv2/uploadurlrequest.go delete mode 100644 build/platformclientv2/uploadurlresponse.go delete mode 100644 build/platformclientv2/urlcondition.go delete mode 100644 build/platformclientv2/usage.go delete mode 100644 build/platformclientv2/usageapi.go delete mode 100644 build/platformclientv2/usageexecutionresult.go delete mode 100644 build/platformclientv2/usageitem.go delete mode 100644 build/platformclientv2/user.go delete mode 100644 build/platformclientv2/useractioncategory.go delete mode 100644 build/platformclientv2/useractioncategoryentitylisting.go delete mode 100644 build/platformclientv2/useragentinfo.go delete mode 100644 build/platformclientv2/useraggregatedatacontainer.go delete mode 100644 build/platformclientv2/useraggregatequeryclause.go delete mode 100644 build/platformclientv2/useraggregatequeryfilter.go delete mode 100644 build/platformclientv2/useraggregatequerypredicate.go delete mode 100644 build/platformclientv2/useraggregatequeryresponse.go delete mode 100644 build/platformclientv2/useraggregationquery.go delete mode 100644 build/platformclientv2/useraggregationview.go delete mode 100644 build/platformclientv2/userapp.go delete mode 100644 build/platformclientv2/userappconfigurationinfo.go delete mode 100644 build/platformclientv2/userappentitylisting.go delete mode 100644 build/platformclientv2/userauthorization.go delete mode 100644 build/platformclientv2/userconversationseventmediasummary.go delete mode 100644 build/platformclientv2/userconversationseventmediasummarydetail.go delete mode 100644 build/platformclientv2/userconversationseventuserconversationsummary.go delete mode 100644 build/platformclientv2/userconversationsummary.go delete mode 100644 build/platformclientv2/userdetailqueryclause.go delete mode 100644 build/platformclientv2/userdetailqueryfilter.go delete mode 100644 build/platformclientv2/userdetailquerypredicate.go delete mode 100644 build/platformclientv2/userdetailsdatalakeavailabilitytopicdataavailabilitychangenotification.go delete mode 100644 build/platformclientv2/userdetailsdatalakeavailabilitytopicdatetime.go delete mode 100644 build/platformclientv2/userdetailsquery.go delete mode 100644 build/platformclientv2/userdevice.go delete mode 100644 build/platformclientv2/userentitylisting.go delete mode 100644 build/platformclientv2/userexpands.go delete mode 100644 build/platformclientv2/usergreetingeventgreeting.go delete mode 100644 build/platformclientv2/usergreetingeventgreetingaudiofile.go delete mode 100644 build/platformclientv2/usergreetingeventgreetingowner.go delete mode 100644 build/platformclientv2/userimage.go delete mode 100644 build/platformclientv2/userlanguageentitylisting.go delete mode 100644 build/platformclientv2/userlicenses.go delete mode 100644 build/platformclientv2/userlicensesentitylisting.go delete mode 100644 build/platformclientv2/userlistschedulerequestbody.go delete mode 100644 build/platformclientv2/userme.go delete mode 100644 build/platformclientv2/userobservationdatacontainer.go delete mode 100644 build/platformclientv2/userobservationquery.go delete mode 100644 build/platformclientv2/userobservationqueryclause.go delete mode 100644 build/platformclientv2/userobservationqueryfilter.go delete mode 100644 build/platformclientv2/userobservationquerypredicate.go delete mode 100644 build/platformclientv2/userobservationqueryresponse.go delete mode 100644 build/platformclientv2/userparam.go delete mode 100644 build/platformclientv2/userpresence.go delete mode 100644 build/platformclientv2/userprofile.go delete mode 100644 build/platformclientv2/userprofileentitylisting.go delete mode 100644 build/platformclientv2/userqueue.go delete mode 100644 build/platformclientv2/userqueueentitylisting.go delete mode 100644 build/platformclientv2/userrecording.go delete mode 100644 build/platformclientv2/userrecordingentitylisting.go delete mode 100644 build/platformclientv2/userrecordingsapi.go delete mode 100644 build/platformclientv2/userreference.go delete mode 100644 build/platformclientv2/userroutinglanguage.go delete mode 100644 build/platformclientv2/userroutinglanguagepost.go delete mode 100644 build/platformclientv2/userroutingskill.go delete mode 100644 build/platformclientv2/userroutingskillpost.go delete mode 100644 build/platformclientv2/userroutingstatuserrorinfo.go delete mode 100644 build/platformclientv2/userroutingstatusroutingstatus.go delete mode 100644 build/platformclientv2/userroutingstatususerparam.go delete mode 100644 build/platformclientv2/userroutingstatususerroutingstatus.go delete mode 100644 build/platformclientv2/usersapi.go delete mode 100644 build/platformclientv2/usersapi_test.go delete mode 100644 build/platformclientv2/userschedule.go delete mode 100644 build/platformclientv2/userscheduleactivity.go delete mode 100644 build/platformclientv2/userscheduleadherence.go delete mode 100644 build/platformclientv2/userscheduleadherencelisting.go delete mode 100644 build/platformclientv2/userschedulecontainer.go delete mode 100644 build/platformclientv2/userschedulefulldaytimeoffmarker.go delete mode 100644 build/platformclientv2/userscheduleshift.go delete mode 100644 build/platformclientv2/usersearchcriteria.go delete mode 100644 build/platformclientv2/usersearchrequest.go delete mode 100644 build/platformclientv2/userskillentitylisting.go delete mode 100644 build/platformclientv2/userssearchresponse.go delete mode 100644 build/platformclientv2/userstation.go delete mode 100644 build/platformclientv2/userstationchangetopicuser.go delete mode 100644 build/platformclientv2/userstationchangetopicuserstation.go delete mode 100644 build/platformclientv2/userstationchangetopicuserstations.go delete mode 100644 build/platformclientv2/userstations.go delete mode 100644 build/platformclientv2/usertokenstopictokennotification.go delete mode 100644 build/platformclientv2/usertokenstopicurireference.go delete mode 100644 build/platformclientv2/utilitiesapi.go delete mode 100644 build/platformclientv2/utilization.go delete mode 100644 build/platformclientv2/validateaddressrequest.go delete mode 100644 build/platformclientv2/validateaddressresponse.go delete mode 100644 build/platformclientv2/validateworkplanmessages.go delete mode 100644 build/platformclientv2/validateworkplanresponse.go delete mode 100644 build/platformclientv2/validationlimits.go delete mode 100644 build/platformclientv2/valuewrapperdate.go delete mode 100644 build/platformclientv2/valuewrapperplanningperiodsettings.go delete mode 100644 build/platformclientv2/valuewrapperstring.go delete mode 100644 build/platformclientv2/vendorconnectionrequest.go delete mode 100644 build/platformclientv2/video.go delete mode 100644 build/platformclientv2/viewfilter.go delete mode 100644 build/platformclientv2/visibilitycondition.go delete mode 100644 build/platformclientv2/vmpairinginfo.go delete mode 100644 build/platformclientv2/voicemail.go delete mode 100644 build/platformclientv2/voicemailapi.go delete mode 100644 build/platformclientv2/voicemailcopyrecord.go delete mode 100644 build/platformclientv2/voicemailgrouppolicy.go delete mode 100644 build/platformclientv2/voicemailmailboxinfo.go delete mode 100644 build/platformclientv2/voicemailmediainfo.go delete mode 100644 build/platformclientv2/voicemailmessage.go delete mode 100644 build/platformclientv2/voicemailmessageentitylisting.go delete mode 100644 build/platformclientv2/voicemailmessagestopicowner.go delete mode 100644 build/platformclientv2/voicemailmessagestopicvoicemailcopyrecord.go delete mode 100644 build/platformclientv2/voicemailmessagestopicvoicemailmessage.go delete mode 100644 build/platformclientv2/voicemailorganizationpolicy.go delete mode 100644 build/platformclientv2/voicemailretentionpolicy.go delete mode 100644 build/platformclientv2/voicemailsearchcriteria.go delete mode 100644 build/platformclientv2/voicemailsearchrequest.go delete mode 100644 build/platformclientv2/voicemailssearchresponse.go delete mode 100644 build/platformclientv2/voicemailuserpolicy.go delete mode 100644 build/platformclientv2/webchatapi.go delete mode 100644 build/platformclientv2/webchatconfig.go delete mode 100644 build/platformclientv2/webchatconversation.go delete mode 100644 build/platformclientv2/webchatdeployment.go delete mode 100644 build/platformclientv2/webchatdeploymententitylisting.go delete mode 100644 build/platformclientv2/webchatguestmediarequest.go delete mode 100644 build/platformclientv2/webchatguestmediarequestentitylist.go delete mode 100644 build/platformclientv2/webchatmemberinfo.go delete mode 100644 build/platformclientv2/webchatmemberinfoentitylist.go delete mode 100644 build/platformclientv2/webchatmessage.go delete mode 100644 build/platformclientv2/webchatmessageentitylist.go delete mode 100644 build/platformclientv2/webchatroutingtarget.go delete mode 100644 build/platformclientv2/webchatsettings.go delete mode 100644 build/platformclientv2/webchattyping.go delete mode 100644 build/platformclientv2/webdeploymentsconfigtopicwebmessagingconfigchangeeventbody.go delete mode 100644 build/platformclientv2/webdeploymentsdeploymenttopicwebmessagingconfigchangeeventbody.go delete mode 100644 build/platformclientv2/webdeploymentsdeploymenttopicwebmessagingdeploymentchangeeventbody.go delete mode 100644 build/platformclientv2/weekschedule.go delete mode 100644 build/platformclientv2/weekschedulegenerationresult.go delete mode 100644 build/platformclientv2/weekschedulelistitemresponse.go delete mode 100644 build/platformclientv2/weekschedulelistresponse.go delete mode 100644 build/platformclientv2/weekschedulereference.go delete mode 100644 build/platformclientv2/weekscheduleresponse.go delete mode 100644 build/platformclientv2/weekshifttradelistresponse.go delete mode 100644 build/platformclientv2/weekshifttradematchessummaryresponse.go delete mode 100644 build/platformclientv2/weekshifttraderesponse.go delete mode 100644 build/platformclientv2/wemcoachingappointmenttopiccoachingappointmentconversation.go delete mode 100644 build/platformclientv2/wemcoachingappointmenttopiccoachingappointmentdocument.go delete mode 100644 build/platformclientv2/wemcoachingappointmenttopiccoachingappointmentexternallink.go delete mode 100644 build/platformclientv2/wemcoachingappointmenttopiccoachingappointmentnotification.go delete mode 100644 build/platformclientv2/wemcoachingappointmenttopicuserreference.go delete mode 100644 build/platformclientv2/wemlearningassignmentruleruntopiclearningassignmentrulerunnotification.go delete mode 100644 build/platformclientv2/wemlearningassignmentruleruntopiclearningmodulereference.go delete mode 100644 build/platformclientv2/wemlearningassignmentruleruntopicwemlearningassignmentscreated.go delete mode 100644 build/platformclientv2/wemlearningassignmenttopiclearningassignmentnotification.go delete mode 100644 build/platformclientv2/wemlearningassignmenttopiclearningmodulereference.go delete mode 100644 build/platformclientv2/wemlearningassignmenttopicuserreference.go delete mode 100644 build/platformclientv2/wfmagent.go delete mode 100644 build/platformclientv2/wfmagentscheduleupdatetopicuserreference.go delete mode 100644 build/platformclientv2/wfmagentscheduleupdatetopicwfmagentscheduleupdate.go delete mode 100644 build/platformclientv2/wfmagentscheduleupdatetopicwfmagentscheduleupdatenotification.go delete mode 100644 build/platformclientv2/wfmagentscheduleupdatetopicwfmfulldaytimeoffmarker.go delete mode 100644 build/platformclientv2/wfmagentscheduleupdatetopicwfmscheduleactivity.go delete mode 100644 build/platformclientv2/wfmagentscheduleupdatetopicwfmscheduleshift.go delete mode 100644 build/platformclientv2/wfmbuintradaydataupdatetopicbuintradaydatagroup.go delete mode 100644 build/platformclientv2/wfmbuintradaydataupdatetopicbuintradayforecastdata.go delete mode 100644 build/platformclientv2/wfmbuintradaydataupdatetopicbuintradaynotification.go delete mode 100644 build/platformclientv2/wfmbuintradaydataupdatetopicbuintradayresult.go delete mode 100644 build/platformclientv2/wfmbuintradaydataupdatetopicbuintradayscheduledata.go delete mode 100644 build/platformclientv2/wfmbuintradaydataupdatetopicbuschedulereference.go delete mode 100644 build/platformclientv2/wfmbuintradaydataupdatetopicbushorttermforecastreference.go delete mode 100644 build/platformclientv2/wfmbuintradaydataupdatetopicintradayperformancepredictiondata.go delete mode 100644 build/platformclientv2/wfmbuintradaydataupdatetopiclocaldate.go delete mode 100644 build/platformclientv2/wfmbulkshifttradestateupdatenotificationtopicbulkshifttradestateupdatenotification.go delete mode 100644 build/platformclientv2/wfmbulkshifttradestateupdatenotificationtopicbulkshifttradestateupdateresult.go delete mode 100644 build/platformclientv2/wfmbulkshifttradestateupdatenotificationtopicbulkshifttradestateupdateresultlisting.go delete mode 100644 build/platformclientv2/wfmbulkshifttradestateupdatenotificationtopiclocaldate.go delete mode 100644 build/platformclientv2/wfmbulkshifttradestateupdatenotificationtopicuserreference.go delete mode 100644 build/platformclientv2/wfmbulkshifttradestateupdatenotificationtopicwfmversionedentitymetadata.go delete mode 100644 build/platformclientv2/wfmbuschedulequeryresulttopicbuschedulesearchresultnotification.go delete mode 100644 build/platformclientv2/wfmbuscheduleruntopicbuschedulereference.go delete mode 100644 build/platformclientv2/wfmbuscheduleruntopicbuschedulerun.go delete mode 100644 build/platformclientv2/wfmbuscheduleruntopicbuschedulingrunprogressnotification.go delete mode 100644 build/platformclientv2/wfmbuscheduleruntopiclocaldate.go delete mode 100644 build/platformclientv2/wfmbuscheduleruntopicuserreference.go delete mode 100644 build/platformclientv2/wfmbuschedulesearchresulttopicbuschedulesearchresultnotification.go delete mode 100644 build/platformclientv2/wfmbuscheduletopicbumanagementunitschedulesummary.go delete mode 100644 build/platformclientv2/wfmbuscheduletopicbuschedulegenerationresultsummary.go delete mode 100644 build/platformclientv2/wfmbuscheduletopicbuschedulemetadata.go delete mode 100644 build/platformclientv2/wfmbuscheduletopicbuschedulenotification.go delete mode 100644 build/platformclientv2/wfmbuscheduletopicbushorttermforecastreference.go delete mode 100644 build/platformclientv2/wfmbuscheduletopiclocaldate.go delete mode 100644 build/platformclientv2/wfmbuscheduletopicmanagementunit.go delete mode 100644 build/platformclientv2/wfmbuscheduletopicuserreference.go delete mode 100644 build/platformclientv2/wfmbuscheduletopicwfmversionedentitymetadata.go delete mode 100644 build/platformclientv2/wfmbushorttermforecastcopycompletetopicbuforecastmodification.go delete mode 100644 build/platformclientv2/wfmbushorttermforecastcopycompletetopicbushorttermforecast.go delete mode 100644 build/platformclientv2/wfmbushorttermforecastcopycompletetopicbushorttermforecastnotification.go delete mode 100644 build/platformclientv2/wfmbushorttermforecastcopycompletetopicforecastsourcedaypointer.go delete mode 100644 build/platformclientv2/wfmbushorttermforecastcopycompletetopicmodificationintervaloffsetvalue.go delete mode 100644 build/platformclientv2/wfmbushorttermforecastcopycompletetopicuserreference.go delete mode 100644 build/platformclientv2/wfmbushorttermforecastcopycompletetopicwfmversionedentitymetadata.go delete mode 100644 build/platformclientv2/wfmbushorttermforecastgenerateprogresstopicbuforecastmodification.go delete mode 100644 build/platformclientv2/wfmbushorttermforecastgenerateprogresstopicbushorttermforecast.go delete mode 100644 build/platformclientv2/wfmbushorttermforecastgenerateprogresstopicforecastsourcedaypointer.go delete mode 100644 build/platformclientv2/wfmbushorttermforecastgenerateprogresstopicgeneratebushorttermforecastprogressnotification.go delete mode 100644 build/platformclientv2/wfmbushorttermforecastgenerateprogresstopicmodificationintervaloffsetvalue.go delete mode 100644 build/platformclientv2/wfmbushorttermforecastgenerateprogresstopicuserreference.go delete mode 100644 build/platformclientv2/wfmbushorttermforecastgenerateprogresstopicwfmversionedentitymetadata.go delete mode 100644 build/platformclientv2/wfmbushorttermforecastimportcompletetopicbuforecastmodification.go delete mode 100644 build/platformclientv2/wfmbushorttermforecastimportcompletetopicbushorttermforecast.go delete mode 100644 build/platformclientv2/wfmbushorttermforecastimportcompletetopicbushorttermforecastnotification.go delete mode 100644 build/platformclientv2/wfmbushorttermforecastimportcompletetopicforecastsourcedaypointer.go delete mode 100644 build/platformclientv2/wfmbushorttermforecastimportcompletetopicmodificationintervaloffsetvalue.go delete mode 100644 build/platformclientv2/wfmbushorttermforecastimportcompletetopicuserreference.go delete mode 100644 build/platformclientv2/wfmbushorttermforecastimportcompletetopicwfmversionedentitymetadata.go delete mode 100644 build/platformclientv2/wfmbushorttermforecastupdatecompletetopicbuforecastmodification.go delete mode 100644 build/platformclientv2/wfmbushorttermforecastupdatecompletetopicbushorttermforecast.go delete mode 100644 build/platformclientv2/wfmbushorttermforecastupdatecompletetopicbushorttermforecastnotification.go delete mode 100644 build/platformclientv2/wfmbushorttermforecastupdatecompletetopicforecastsourcedaypointer.go delete mode 100644 build/platformclientv2/wfmbushorttermforecastupdatecompletetopicmodificationintervaloffsetvalue.go delete mode 100644 build/platformclientv2/wfmbushorttermforecastupdatecompletetopicuserreference.go delete mode 100644 build/platformclientv2/wfmbushorttermforecastupdatecompletetopicwfmversionedentitymetadata.go delete mode 100644 build/platformclientv2/wfmbusinessunitreference.go delete mode 100644 build/platformclientv2/wfmforecastmodificationintervaloffsetvalue.go delete mode 100644 build/platformclientv2/wfmhistoricaladherencecalculationscompletetopicwfmhistoricaladherencecalculationscompletenotice.go delete mode 100644 build/platformclientv2/wfmhistoricaladherencequery.go delete mode 100644 build/platformclientv2/wfmhistoricaladherencequeryforusers.go delete mode 100644 build/platformclientv2/wfmhistoricaladherenceresponse.go delete mode 100644 build/platformclientv2/wfmhistoricaladherenceresultwrapper.go delete mode 100644 build/platformclientv2/wfmhistoricaldatauploadpurgerequeststatustopichistoricaldatauploadpurgerequestupdate.go delete mode 100644 build/platformclientv2/wfmhistoricaldatauploadrequeststatustopicdatetime.go delete mode 100644 build/platformclientv2/wfmhistoricaldatauploadrequeststatustopichistoricaldatauploadrequestupdate.go delete mode 100644 build/platformclientv2/wfmintradaydataupdatetopicintradaydatagroup.go delete mode 100644 build/platformclientv2/wfmintradaydataupdatetopicintradaydataupdate.go delete mode 100644 build/platformclientv2/wfmintradaydataupdatetopicintradayforecastdata.go delete mode 100644 build/platformclientv2/wfmintradaydataupdatetopicintradayhistoricalagentdata.go delete mode 100644 build/platformclientv2/wfmintradaydataupdatetopicintradayhistoricalqueuedata.go delete mode 100644 build/platformclientv2/wfmintradaydataupdatetopicintradaymetric.go delete mode 100644 build/platformclientv2/wfmintradaydataupdatetopicintradayperformancepredictionagentdata.go delete mode 100644 build/platformclientv2/wfmintradaydataupdatetopicintradayperformancepredictionqueuedata.go delete mode 100644 build/platformclientv2/wfmintradaydataupdatetopicintradayscheduledata.go delete mode 100644 build/platformclientv2/wfmintradayplanninggrouplisting.go delete mode 100644 build/platformclientv2/wfmmoveagentscompletetopicmanagementunit.go delete mode 100644 build/platformclientv2/wfmmoveagentscompletetopicuserreference.go delete mode 100644 build/platformclientv2/wfmmoveagentscompletetopicwfmmoveagentdata.go delete mode 100644 build/platformclientv2/wfmmoveagentscompletetopicwfmmoveagentscomplete.go delete mode 100644 build/platformclientv2/wfmmovemanagementunittopicbusinessunit.go delete mode 100644 build/platformclientv2/wfmmovemanagementunittopicmovemanagementunitnotification.go delete mode 100644 build/platformclientv2/wfmschedulereference.go delete mode 100644 build/platformclientv2/wfmscheduletopicwfmschedulenotification.go delete mode 100644 build/platformclientv2/wfmtimeoffrequestupdatetopictimeoffrequestupdate.go delete mode 100644 build/platformclientv2/wfmtimeoffrequestupdatetopicuserreference.go delete mode 100644 build/platformclientv2/wfmupdateagentdetailstopicwfmupdateagentdetailscomplete.go delete mode 100644 build/platformclientv2/wfmuserentitylisting.go delete mode 100644 build/platformclientv2/wfmusernotification.go delete mode 100644 build/platformclientv2/wfmusernotificationtopicshifttradenotification.go delete mode 100644 build/platformclientv2/wfmusernotificationtopictimeoffrequestnotification.go delete mode 100644 build/platformclientv2/wfmusernotificationtopicuserreference.go delete mode 100644 build/platformclientv2/wfmusernotificationtopicwfmusernotification.go delete mode 100644 build/platformclientv2/wfmuserscheduleadherenceupdatedmutopicqueuereference.go delete mode 100644 build/platformclientv2/wfmuserscheduleadherenceupdatedmutopicurireference.go delete mode 100644 build/platformclientv2/wfmuserscheduleadherenceupdatedmutopicuserreference.go delete mode 100644 build/platformclientv2/wfmuserscheduleadherenceupdatedmutopicuserscheduleadherenceupdate.go delete mode 100644 build/platformclientv2/wfmuserscheduleadherenceupdatedteamtopicqueuereference.go delete mode 100644 build/platformclientv2/wfmuserscheduleadherenceupdatedteamtopicurireference.go delete mode 100644 build/platformclientv2/wfmuserscheduleadherenceupdatedteamtopicuserreference.go delete mode 100644 build/platformclientv2/wfmuserscheduleadherenceupdatedteamtopicuserscheduleadherenceupdate.go delete mode 100644 build/platformclientv2/wfmuserscheduleadherenceupdatedtopicqueuereference.go delete mode 100644 build/platformclientv2/wfmuserscheduleadherenceupdatedtopicurireference.go delete mode 100644 build/platformclientv2/wfmuserscheduleadherenceupdatedtopicuserreference.go delete mode 100644 build/platformclientv2/wfmuserscheduleadherenceupdatedtopicuserscheduleadherenceupdate.go delete mode 100644 build/platformclientv2/wfmversionedentitymetadata.go delete mode 100644 build/platformclientv2/whatsappdefinition.go delete mode 100644 build/platformclientv2/whatsappid.go delete mode 100644 build/platformclientv2/whatsappintegration.go delete mode 100644 build/platformclientv2/whatsappintegrationentitylisting.go delete mode 100644 build/platformclientv2/whatsappintegrationrequest.go delete mode 100644 build/platformclientv2/whatsappintegrationupdaterequest.go delete mode 100644 build/platformclientv2/widgetclientconfig.go delete mode 100644 build/platformclientv2/widgetclientconfigthirdparty.go delete mode 100644 build/platformclientv2/widgetclientconfigv1.go delete mode 100644 build/platformclientv2/widgetclientconfigv1http.go delete mode 100644 build/platformclientv2/widgetclientconfigv2.go delete mode 100644 build/platformclientv2/widgetdeployment.go delete mode 100644 build/platformclientv2/widgetdeploymententitylisting.go delete mode 100644 build/platformclientv2/widgetsapi.go delete mode 100644 build/platformclientv2/workforcemanagementapi.go delete mode 100644 build/platformclientv2/workplan.go delete mode 100644 build/platformclientv2/workplanactivity.go delete mode 100644 build/platformclientv2/workplanconfigurationviolationmessage.go delete mode 100644 build/platformclientv2/workplanconstraintconflictmessage.go delete mode 100644 build/platformclientv2/workplanconstraintmessage.go delete mode 100644 build/platformclientv2/workplanlistitemresponse.go delete mode 100644 build/platformclientv2/workplanlistresponse.go delete mode 100644 build/platformclientv2/workplanpatternrequest.go delete mode 100644 build/platformclientv2/workplanpatternresponse.go delete mode 100644 build/platformclientv2/workplanreference.go delete mode 100644 build/platformclientv2/workplanrotationagentresponse.go delete mode 100644 build/platformclientv2/workplanrotationlistresponse.go delete mode 100644 build/platformclientv2/workplanrotationreference.go delete mode 100644 build/platformclientv2/workplanrotationresponse.go delete mode 100644 build/platformclientv2/workplanshift.go delete mode 100644 build/platformclientv2/workplanvalidationmessageargument.go delete mode 100644 build/platformclientv2/workplanvalidationrequest.go delete mode 100644 build/platformclientv2/workspace.go delete mode 100644 build/platformclientv2/workspacecreate.go delete mode 100644 build/platformclientv2/workspaceentitylisting.go delete mode 100644 build/platformclientv2/workspacemember.go delete mode 100644 build/platformclientv2/workspacememberentitylisting.go delete mode 100644 build/platformclientv2/workspacesummary.go delete mode 100644 build/platformclientv2/wrapup.go delete mode 100644 build/platformclientv2/wrapupcodeentitylisting.go delete mode 100644 build/platformclientv2/wrapupcodemapping.go delete mode 100644 build/platformclientv2/wrapupcodereference.go delete mode 100644 build/platformclientv2/writabledialercontact.go delete mode 100644 build/platformclientv2/writabledivision.go delete mode 100644 build/platformclientv2/writableentity.go rename build/platformclientv2/division.go => platformclientv2/baseprogramentity.go (79%) rename build/platformclientv2/runnowresponse.go => platformclientv2/basetopicentitiy.go (79%) create mode 100644 platformclientv2/externalsegment.go rename build/platformclientv2/language.go => platformclientv2/generalprogramjob.go (62%) create mode 100644 platformclientv2/generalprogramjobrequest.go rename build/platformclientv2/intent.go => platformclientv2/generaltopic.go (70%) create mode 100644 platformclientv2/generaltopicsentitylisting.go rename {build/platformclientv2 => platformclientv2}/go.mod (100%) rename {build/platformclientv2 => platformclientv2}/go.sum (100%) rename build/platformclientv2/team.go => platformclientv2/listedprogram.go (50%) create mode 100644 platformclientv2/listedtopic.go rename build/platformclientv2/adhocrecordingtopicuserdata.go => platformclientv2/patchexternalsegment.go (50%) create mode 100644 platformclientv2/permissiondetails.go create mode 100644 platformclientv2/phrase.go create mode 100644 platformclientv2/program.go rename build/platformclientv2/wrapupcode.go => platformclientv2/programjob.go (72%) create mode 100644 platformclientv2/programjobrequest.go create mode 100644 platformclientv2/programrequest.go rename build/platformclientv2/entitylisting.go => platformclientv2/programsentitylisting.go (51%) rename {build/platformclientv2 => platformclientv2}/retry_test.go (100%) create mode 100644 platformclientv2/supportedcontentreference.go create mode 100644 platformclientv2/topic.go rename build/platformclientv2/attribute.go => platformclientv2/topicjob.go (63%) create mode 100644 platformclientv2/topicjobrequest.go create mode 100644 platformclientv2/topicrequest.go rename build/platformclientv2/categoryentitylisting.go => platformclientv2/topicsentitylisting.go (51%) create mode 100644 platformclientv2/unpublishedprogramsentitylisting.go diff --git a/Makefile b/Makefile index 586659b99..eaf027b1b 100644 --- a/Makefile +++ b/Makefile @@ -1,8 +1,7 @@ PACKAGE_NAME = platformclientv2 -ROOT_DIR = $(dir $(realpath $(firstword $(MAKEFILE_LIST)))) build: - cd ${ROOT_DIR}; go build -o ./bin/${PACKAGE_NAME} ./${PACKAGE_NAME} + cd ${PACKAGE_NAME}; go build -o ../bin/${PACKAGE_NAME} test: - cd ${ROOT_DIR}; go test -v -failfast ./${PACKAGE_NAME} + cd ${PACKAGE_NAME}; go test -v -failfast diff --git a/README.md b/README.md index 14e35bcd9..f856e77f4 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ title: Platform API Client SDK - Go A Go package to interface with the Genesys Cloud Platform API. View the documentation on the [pkg.go.dev](https://pkg.go.dev/github.com/MyPureCloud/platform-client-sdk-go/platformclientv2). Browse the source code on [Github](https://github.com/MyPureCloud/platform-client-sdk-go). -Latest version: 33.0.3 [![GitHub release](https://img.shields.io/github/release/mypurecloud/platform-client-sdk-go.svg)]() +Latest version: 34.0.0 [![GitHub release](https://img.shields.io/github/release/mypurecloud/platform-client-sdk-go.svg)]() [![Release Notes Badge](https://developer.mypurecloud.com/images/sdk-release-notes.png)](https://github.com/MyPureCloud/platform-client-sdk-go/blob/master/releaseNotes.md) ## Golang Version Dependency diff --git a/build/.gitignore b/build/.gitignore deleted file mode 100644 index a8129ca55..000000000 --- a/build/.gitignore +++ /dev/null @@ -1,25 +0,0 @@ -# Compiled Object files, Static and Dynamic libs (Shared Objects) -*.o -*.a -*.so -bin - -# Folders -_obj -_test - -# Architecture specific extensions/prefixes -*.[568vq] -[568vq].out - -*.cgo1.go -*.cgo2.c -_cgo_defun.c -_cgo_gotypes.go -_cgo_export.* - -_testmain.go - -*.exe -*.test -*.prof diff --git a/build/.swagger-codegen-ignore b/build/.swagger-codegen-ignore deleted file mode 100644 index 19d337718..000000000 --- a/build/.swagger-codegen-ignore +++ /dev/null @@ -1,23 +0,0 @@ -# Swagger Codegen Ignore -# Generated by swagger-codegen https://github.com/swagger-api/swagger-codegen - -# Use this file to prevent files from being overwritten by the generator. -# The patterns follow closely to .gitignore or .dockerignore. - -# As an example, the C# client generator defines ApiClient.cs. -# You can make changes and tell Swagger Codgen to ignore just this file by uncommenting the following line: -#ApiClient.cs - -# You can match any string of characters against a directory, file or extension with a single asterisk (*): -#foo/*/qux -# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux - -# You can recursively match patterns against a directory, file or extension with a double asterisk (**): -#foo/**/qux -# Thsi matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux - -# You can also negate patterns with an exclamation (!). -# For example, you can ignore all files in a docs folder with the file extension .md: -#docs/*.md -# Then explicitly reverse the ignore rule for a single file: -#!docs/README.md diff --git a/build/Makefile b/build/Makefile deleted file mode 100644 index eaf027b1b..000000000 --- a/build/Makefile +++ /dev/null @@ -1,7 +0,0 @@ -PACKAGE_NAME = platformclientv2 - -build: - cd ${PACKAGE_NAME}; go build -o ../bin/${PACKAGE_NAME} - -test: - cd ${PACKAGE_NAME}; go test -v -failfast diff --git a/build/README.md b/build/README.md deleted file mode 100644 index 14e35bcd9..000000000 --- a/build/README.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -title: Platform API Client SDK - Go ---- - -A Go package to interface with the Genesys Cloud Platform API. View the documentation on the [pkg.go.dev](https://pkg.go.dev/github.com/MyPureCloud/platform-client-sdk-go/platformclientv2). Browse the source code on [Github](https://github.com/MyPureCloud/platform-client-sdk-go). - -Latest version: 33.0.3 [![GitHub release](https://img.shields.io/github/release/mypurecloud/platform-client-sdk-go.svg)]() -[![Release Notes Badge](https://developer.mypurecloud.com/images/sdk-release-notes.png)](https://github.com/MyPureCloud/platform-client-sdk-go/blob/master/releaseNotes.md) - -## Golang Version Dependency - -:::danger -Some macOS users encounter the error "argument list too long" when building or installing this package if their golang version is less than 1.15. Visit [Go Downloads](https://golang.org/dl/) and install _go1.15_ or newer if this error is thrown. -::: - -## Get SDK Package - -Retrieve the package from https://github.com/MyPureCloud/platform-client-sdk-go using `go get`: - -```go -go get github.com/mypurecloud/platform-client-sdk-go/platformclientv2 -``` - -## Using the SDK - -### Importing the package - -```go -import ( - "github.com/MyPureCloud/platform-client-sdk-go/platformclientv2" -) -``` - -### Configuring the SDK - -The SDK can be configured by setting properties on a `Configuration` instance. Applications that are using a single access token (most use cases) can use the default configuration. - -The default configuration will be used when creating new API instances without supplying the config. - -```go -// Get default config to set config options -config := platformclientv2.GetDefaultConfiguration() - -// Create API instance using default config -usersAPI := platformclientv2.NewUsersApi() -``` - -Applications that will be making requests using multiple access tokens can create multiple configuration instances and authorize them individually. This is a common pattern when using the SDK in a backend web server where multiple Genesys Cloud users will authenticate using an auth code grant. - -When creating configuration instances, they must be used when creating new API instances. - -```go -// Create new config -config := platformclientv2.NewConfiguration() - -// Create API instance using config -usersAPI := platformclientv2.NewUsersApiWithConfig(config) -``` - -#### Retrying and 429 and 5xx response codes and connection errors - -By default, the SDK does not retry 429 and 5xx response codes (except 501) and connection errors. To enable retries, create an instance of the `RetryConfiguration` object and set it on the `Configuration` instance. -The retry logic will respect the `retry-after` header for all 429 status codes. -The `RetryConfiguration` object has 3 properties that determine the retry behaviour and a RequestLogHook which can be used for debugging and tracing retried requests: -* `RetryWaitMin` determines the minimum time to wait -* `RetryWaitMax` determines the maximum time to wait -* `RetryMax` determines the maximum amount of retries -* `RequestLogHook` a callback called on each retried request - -```go -config.RetryConfiguration = &platformclientv2.RetryConfiguration{ - RetryWaitMin: 5 * time.Second, - RetryWaitMax: 60 * time.Second, - RetryMax: 20, - RequestLogHook: func(req *http.Request, retryNumber int) { - fmt.Printf("%v %v request failed. Retry count: %v\n", req.Method, req.URL, retryNumber) - }, -} -``` - -#### Setting the environment - -To connect to regional Genesys Cloud instances, provide the Platform API's base path: - -```go -config.BasePath = "https://api.mypurecloud.jp" -``` - -Alternatively, use the enum mapping for Genesys Cloud regions to API base paths: - -```go -config.BasePath = platformclientv2.APNortheast1 -``` - -#### Setting the access token - -If using a grant other than client credentials and code authorization, the access token can be set manually: - -```go -config.AccessToken = "anaccesstokenobtainedmanuallyfromanoauthgrant" -``` - -#### Enable debug logging - -Enabling debug logging will trace out information about all requests and responses: - -```go -config.SetDebug(false) -``` - -### Authorization - -#### Client Credentials - -The SDK provides a helper to authorize using client credentials. Use the `AuthorizeClientCredentials` function on the client to make a request to Genesys Cloud to exchange the client id and secret for an access token. If no error was returned, the configuration instance is now authorized and can begin making API requests. - -```go -err := config.AuthorizeClientCredentials(os.Getenv("GENESYS_CLOUD_CLIENT_ID"), os.Getenv("GENESYS_CLOUD_CLIENT_SECRET")) -if err != nil { - panic(err) -} -``` - -#### Authorization Code Grant - -* The app is authenticating as a human, the [Authorization Code Grant](https://developer.mypurecloud.com/api/rest/authorization/use-authorization-code.html) -* The app is served via a web server -* There is server-side code that will be making API requests - -Use the `AuthorizeCodeGrant` function on the client to make a request to Genesys Cloud to exchange the client id, client secret and authorization code for an access token. If no error was returned, the configuration instance is now authorized and can begin making API requests. - -```go -authData, err := config.AuthorizeCodeGrant(clientId, clientSecret, authCode, redirectUri) -if err != nil { - panic(err) -} -``` - -By default the SDK will transparently request a new access token when it expires. If multiple threads are running 1 thread will request a new token, other threads will wait a maximum of 10 seconds for the token refresh to complete, this time can be overriden with the _RefreshTokenWaitTime_ field of the _Configuration_ struct. -If you wish to apply the refresh logic yourself, set `ShouldRefreshAccessToken` to false and store the refresh token. The `ExpiresIn` member of the `authData` struct can be used to preemptively request a new token. Use `RefreshAuthorizationCodeGrant` to request a new token when necessary - -```go -config.ShouldRefreshAccessToken = false -// When token expires -authData, err := config.RefreshAuthorizationCodeGrant(clientId, clientSecret, authData.RefreshToken) -if err != nil { - panic(err) -} -``` - -### Making Requests - -Once the SDK is authorized, API requests can be made. Each function on the API instance returns three values, or just the latter two if the resource does not return any value (e.g. a DELETE operation): - -* A struct representing the API response. This will be nil if any error occurred. -* An `APIResponse` instance providing extended information about the response. This is useful for debugging, custom logging, and advanced error handling. This may be nil under certain error circumstances. This will have a value when the API returns an error. -* An error, if any error occurred at any point during processing. - -```go -userID := "asdf1234-5678-90ab-cde1-123456789012" -usersAPI := platformclientv2.NewUsersApi() - -user, response, err := usersAPI.GetUser(userID, make([]string, 0), "") -fmt.Printf("Response:\n Success: %v\n Status code: %v\n Correlation ID: %v\n", response.IsSuccess, response.StatusCode, response.CorrelationID) -if err != nil { - fmt.Printf("Error calling GetUser: %v\n", err) -} else { - fmt.Printf("Hello, %v\n", *user.Name) -} -``` - - -## Versioning - -The SDK's version is incremented according to the [Semantic Versioning Specification](https://semver.org/). The decision to increment version numbers is determined by [diffing the Platform API's swagger](https://github.com/purecloudlabs/platform-client-sdk-common/blob/master/modules/swaggerDiff.js) for automated builds, and optionally forcing a version bump when a build is triggered manually (e.g. releasing a bugfix). - - -## Support - -This package is intended to be forwards compatible with v2 of Genesys Cloud's Platform API. While the general policy for the API is not to introduce breaking changes, there are certain additions and changes to the API that cause breaking changes for the SDK, often due to the way the API is expressed in its swagger definition. Because of this, the SDK can have a major version bump while the API remains at major version 2. While the SDK is intended to be forward compatible, patches will only be released to the latest version. For these reasons, it is strongly recommended that all applications using this SDK are kept up to date and use the latest version of the SDK. - -For any issues, questions, or suggestions for the SDK, visit the [Genesys Cloud Developer Forum](https://developer.mypurecloud.com/forum/). diff --git a/build/docs/index.md b/build/docs/index.md deleted file mode 100644 index 14e35bcd9..000000000 --- a/build/docs/index.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -title: Platform API Client SDK - Go ---- - -A Go package to interface with the Genesys Cloud Platform API. View the documentation on the [pkg.go.dev](https://pkg.go.dev/github.com/MyPureCloud/platform-client-sdk-go/platformclientv2). Browse the source code on [Github](https://github.com/MyPureCloud/platform-client-sdk-go). - -Latest version: 33.0.3 [![GitHub release](https://img.shields.io/github/release/mypurecloud/platform-client-sdk-go.svg)]() -[![Release Notes Badge](https://developer.mypurecloud.com/images/sdk-release-notes.png)](https://github.com/MyPureCloud/platform-client-sdk-go/blob/master/releaseNotes.md) - -## Golang Version Dependency - -:::danger -Some macOS users encounter the error "argument list too long" when building or installing this package if their golang version is less than 1.15. Visit [Go Downloads](https://golang.org/dl/) and install _go1.15_ or newer if this error is thrown. -::: - -## Get SDK Package - -Retrieve the package from https://github.com/MyPureCloud/platform-client-sdk-go using `go get`: - -```go -go get github.com/mypurecloud/platform-client-sdk-go/platformclientv2 -``` - -## Using the SDK - -### Importing the package - -```go -import ( - "github.com/MyPureCloud/platform-client-sdk-go/platformclientv2" -) -``` - -### Configuring the SDK - -The SDK can be configured by setting properties on a `Configuration` instance. Applications that are using a single access token (most use cases) can use the default configuration. - -The default configuration will be used when creating new API instances without supplying the config. - -```go -// Get default config to set config options -config := platformclientv2.GetDefaultConfiguration() - -// Create API instance using default config -usersAPI := platformclientv2.NewUsersApi() -``` - -Applications that will be making requests using multiple access tokens can create multiple configuration instances and authorize them individually. This is a common pattern when using the SDK in a backend web server where multiple Genesys Cloud users will authenticate using an auth code grant. - -When creating configuration instances, they must be used when creating new API instances. - -```go -// Create new config -config := platformclientv2.NewConfiguration() - -// Create API instance using config -usersAPI := platformclientv2.NewUsersApiWithConfig(config) -``` - -#### Retrying and 429 and 5xx response codes and connection errors - -By default, the SDK does not retry 429 and 5xx response codes (except 501) and connection errors. To enable retries, create an instance of the `RetryConfiguration` object and set it on the `Configuration` instance. -The retry logic will respect the `retry-after` header for all 429 status codes. -The `RetryConfiguration` object has 3 properties that determine the retry behaviour and a RequestLogHook which can be used for debugging and tracing retried requests: -* `RetryWaitMin` determines the minimum time to wait -* `RetryWaitMax` determines the maximum time to wait -* `RetryMax` determines the maximum amount of retries -* `RequestLogHook` a callback called on each retried request - -```go -config.RetryConfiguration = &platformclientv2.RetryConfiguration{ - RetryWaitMin: 5 * time.Second, - RetryWaitMax: 60 * time.Second, - RetryMax: 20, - RequestLogHook: func(req *http.Request, retryNumber int) { - fmt.Printf("%v %v request failed. Retry count: %v\n", req.Method, req.URL, retryNumber) - }, -} -``` - -#### Setting the environment - -To connect to regional Genesys Cloud instances, provide the Platform API's base path: - -```go -config.BasePath = "https://api.mypurecloud.jp" -``` - -Alternatively, use the enum mapping for Genesys Cloud regions to API base paths: - -```go -config.BasePath = platformclientv2.APNortheast1 -``` - -#### Setting the access token - -If using a grant other than client credentials and code authorization, the access token can be set manually: - -```go -config.AccessToken = "anaccesstokenobtainedmanuallyfromanoauthgrant" -``` - -#### Enable debug logging - -Enabling debug logging will trace out information about all requests and responses: - -```go -config.SetDebug(false) -``` - -### Authorization - -#### Client Credentials - -The SDK provides a helper to authorize using client credentials. Use the `AuthorizeClientCredentials` function on the client to make a request to Genesys Cloud to exchange the client id and secret for an access token. If no error was returned, the configuration instance is now authorized and can begin making API requests. - -```go -err := config.AuthorizeClientCredentials(os.Getenv("GENESYS_CLOUD_CLIENT_ID"), os.Getenv("GENESYS_CLOUD_CLIENT_SECRET")) -if err != nil { - panic(err) -} -``` - -#### Authorization Code Grant - -* The app is authenticating as a human, the [Authorization Code Grant](https://developer.mypurecloud.com/api/rest/authorization/use-authorization-code.html) -* The app is served via a web server -* There is server-side code that will be making API requests - -Use the `AuthorizeCodeGrant` function on the client to make a request to Genesys Cloud to exchange the client id, client secret and authorization code for an access token. If no error was returned, the configuration instance is now authorized and can begin making API requests. - -```go -authData, err := config.AuthorizeCodeGrant(clientId, clientSecret, authCode, redirectUri) -if err != nil { - panic(err) -} -``` - -By default the SDK will transparently request a new access token when it expires. If multiple threads are running 1 thread will request a new token, other threads will wait a maximum of 10 seconds for the token refresh to complete, this time can be overriden with the _RefreshTokenWaitTime_ field of the _Configuration_ struct. -If you wish to apply the refresh logic yourself, set `ShouldRefreshAccessToken` to false and store the refresh token. The `ExpiresIn` member of the `authData` struct can be used to preemptively request a new token. Use `RefreshAuthorizationCodeGrant` to request a new token when necessary - -```go -config.ShouldRefreshAccessToken = false -// When token expires -authData, err := config.RefreshAuthorizationCodeGrant(clientId, clientSecret, authData.RefreshToken) -if err != nil { - panic(err) -} -``` - -### Making Requests - -Once the SDK is authorized, API requests can be made. Each function on the API instance returns three values, or just the latter two if the resource does not return any value (e.g. a DELETE operation): - -* A struct representing the API response. This will be nil if any error occurred. -* An `APIResponse` instance providing extended information about the response. This is useful for debugging, custom logging, and advanced error handling. This may be nil under certain error circumstances. This will have a value when the API returns an error. -* An error, if any error occurred at any point during processing. - -```go -userID := "asdf1234-5678-90ab-cde1-123456789012" -usersAPI := platformclientv2.NewUsersApi() - -user, response, err := usersAPI.GetUser(userID, make([]string, 0), "") -fmt.Printf("Response:\n Success: %v\n Status code: %v\n Correlation ID: %v\n", response.IsSuccess, response.StatusCode, response.CorrelationID) -if err != nil { - fmt.Printf("Error calling GetUser: %v\n", err) -} else { - fmt.Printf("Hello, %v\n", *user.Name) -} -``` - - -## Versioning - -The SDK's version is incremented according to the [Semantic Versioning Specification](https://semver.org/). The decision to increment version numbers is determined by [diffing the Platform API's swagger](https://github.com/purecloudlabs/platform-client-sdk-common/blob/master/modules/swaggerDiff.js) for automated builds, and optionally forcing a version bump when a build is triggered manually (e.g. releasing a bugfix). - - -## Support - -This package is intended to be forwards compatible with v2 of Genesys Cloud's Platform API. While the general policy for the API is not to introduce breaking changes, there are certain additions and changes to the API that cause breaking changes for the SDK, often due to the way the API is expressed in its swagger definition. Because of this, the SDK can have a major version bump while the API remains at major version 2. While the SDK is intended to be forward compatible, patches will only be released to the latest version. For these reasons, it is strongly recommended that all applications using this SDK are kept up to date and use the latest version of the SDK. - -For any issues, questions, or suggestions for the SDK, visit the [Genesys Cloud Developer Forum](https://developer.mypurecloud.com/forum/). diff --git a/build/docs/releaseNotes.md b/build/docs/releaseNotes.md deleted file mode 100644 index 2050a2b47..000000000 --- a/build/docs/releaseNotes.md +++ /dev/null @@ -1,10 +0,0 @@ -Platform API version: 4480 - - -# Major Changes (0 changes) - - -# Minor Changes (0 changes) - - -# Point Changes (0 changes) diff --git a/build/platformclientv2/action.go b/build/platformclientv2/action.go deleted file mode 100644 index b54505b3e..000000000 --- a/build/platformclientv2/action.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Action -type Action struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // IntegrationId - The ID of the integration for which this action is associated - IntegrationId *string `json:"integrationId,omitempty"` - - - // Category - Category of Action - Category *string `json:"category,omitempty"` - - - // Contract - Action contract - Contract *Actioncontract `json:"contract,omitempty"` - - - // Version - Version of this action - Version *int `json:"version,omitempty"` - - - // Secure - Indication of whether or not the action is designed to accept sensitive data - Secure *bool `json:"secure,omitempty"` - - - // Config - Configuration to support request and response processing - Config *Actionconfig `json:"config,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Action) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/actionconfig.go b/build/platformclientv2/actionconfig.go deleted file mode 100644 index 26cfcb5f2..000000000 --- a/build/platformclientv2/actionconfig.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Actionconfig - Defines components of the Action Config. -type Actionconfig struct { - // Request - Configuration of outbound request. - Request *Requestconfig `json:"request,omitempty"` - - - // Response - Configuration of response processing. - Response *Responseconfig `json:"response,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Actionconfig) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/actioncontract.go b/build/platformclientv2/actioncontract.go deleted file mode 100644 index 2c4106990..000000000 --- a/build/platformclientv2/actioncontract.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Actioncontract - This resource contains all of the schemas needed to define the inputs and outputs, of a single Action. -type Actioncontract struct { - // Output - The output to expect when executing this action. - Output *Actionoutput `json:"output,omitempty"` - - - // Input - The input required when executing this action. - Input *Actioninput `json:"input,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Actioncontract) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/actioncontractinput.go b/build/platformclientv2/actioncontractinput.go deleted file mode 100644 index e8c9dfd64..000000000 --- a/build/platformclientv2/actioncontractinput.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Actioncontractinput - Contract definition. -type Actioncontractinput struct { - // Input - Execution input contract - Input *Postinputcontract `json:"input,omitempty"` - - - // Output - Execution output contract - Output *Postoutputcontract `json:"output,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Actioncontractinput) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/actionentitylisting.go b/build/platformclientv2/actionentitylisting.go deleted file mode 100644 index dcfcf29d7..000000000 --- a/build/platformclientv2/actionentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Actionentitylisting -type Actionentitylisting struct { - // Entities - Entities *[]Action `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Actionentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/actioninput.go b/build/platformclientv2/actioninput.go deleted file mode 100644 index c12f2ec33..000000000 --- a/build/platformclientv2/actioninput.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Actioninput - Input requirements of Action. -type Actioninput struct { - // InputSchema - JSON Schema that defines the body of the request that the client (edge/architect/postman) is sending to the service, on the /execute path. If the 'flatten' query parameter is omitted or false, this field will be returned. Either inputSchema or inputSchemaFlattened will be returned, not both. - InputSchema *Jsonschemadocument `json:"inputSchema,omitempty"` - - - // InputSchemaFlattened - JSON Schema that defines the body of the request that the client (edge/architect/postman) is sending to the service, on the /execute path. The schema is transformed based on Architect's flattened format. If the 'flatten' query parameter is supplied as true, this field will be returned. Either inputSchema or inputSchemaFlattened will be returned, not both. - InputSchemaFlattened *Jsonschemadocument `json:"inputSchemaFlattened,omitempty"` - - - // InputSchemaUri - The URI of the input schema - InputSchemaUri *string `json:"inputSchemaUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Actioninput) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/actionmap.go b/build/platformclientv2/actionmap.go deleted file mode 100644 index 72f975ac3..000000000 --- a/build/platformclientv2/actionmap.go +++ /dev/null @@ -1,86 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Actionmap -type Actionmap struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Version - The version of the action map. - Version *int `json:"version,omitempty"` - - - // IsActive - Whether the action map is active. - IsActive *bool `json:"isActive,omitempty"` - - - // DisplayName - Display name of the action map. - DisplayName *string `json:"displayName,omitempty"` - - - // TriggerWithSegments - Trigger action map if any segment in the list is assigned to a given customer. - TriggerWithSegments *[]string `json:"triggerWithSegments,omitempty"` - - - // TriggerWithEventConditions - List of event conditions that must be satisfied to trigger the action map. - TriggerWithEventConditions *[]Eventcondition `json:"triggerWithEventConditions,omitempty"` - - - // TriggerWithOutcomeProbabilityConditions - Probability conditions for outcomes that must be satisfied to trigger the action map. - TriggerWithOutcomeProbabilityConditions *[]Outcomeprobabilitycondition `json:"triggerWithOutcomeProbabilityConditions,omitempty"` - - - // PageUrlConditions - URL conditions that a page must match for web actions to be displayable. - PageUrlConditions *[]Urlcondition `json:"pageUrlConditions,omitempty"` - - - // Activation - Type of activation. - Activation *Activation `json:"activation,omitempty"` - - - // Weight - Weight of the action map with higher number denoting higher weight. - Weight *int `json:"weight,omitempty"` - - - // Action - The action that will be executed if this action map is triggered. - Action *Actionmapaction `json:"action,omitempty"` - - - // ActionMapScheduleGroups - The action map's associated schedule groups. - ActionMapScheduleGroups *Actionmapschedulegroups `json:"actionMapScheduleGroups,omitempty"` - - - // IgnoreFrequencyCap - Override organization-level frequency cap and always offer web engagements from this action map. - IgnoreFrequencyCap *bool `json:"ignoreFrequencyCap,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - - - // CreatedDate - Timestamp indicating when the action map was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - CreatedDate *time.Time `json:"createdDate,omitempty"` - - - // ModifiedDate - Timestamp indicating when the action map was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ModifiedDate *time.Time `json:"modifiedDate,omitempty"` - - - // StartDate - Timestamp at which the action map is scheduled to start firing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartDate *time.Time `json:"startDate,omitempty"` - - - // EndDate - Timestamp at which the action map is scheduled to stop firing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - EndDate *time.Time `json:"endDate,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Actionmap) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/actionmapaction.go b/build/platformclientv2/actionmapaction.go deleted file mode 100644 index 2d8a7c675..000000000 --- a/build/platformclientv2/actionmapaction.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Actionmapaction -type Actionmapaction struct { - // ActionTemplate - Action template associated with the action map. - ActionTemplate *Actionmapactiontemplate `json:"actionTemplate,omitempty"` - - - // MediaType - Media type of action. - MediaType *string `json:"mediaType,omitempty"` - - - // ArchitectFlowFields - Architect Flow Id and input contract. - ArchitectFlowFields *Architectflowfields `json:"architectFlowFields,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Actionmapaction) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/actionmapactiontemplate.go b/build/platformclientv2/actionmapactiontemplate.go deleted file mode 100644 index 06b395e4d..000000000 --- a/build/platformclientv2/actionmapactiontemplate.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Actionmapactiontemplate -type Actionmapactiontemplate struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Actionmapactiontemplate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/actionmaplisting.go b/build/platformclientv2/actionmaplisting.go deleted file mode 100644 index 98a0271f4..000000000 --- a/build/platformclientv2/actionmaplisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Actionmaplisting -type Actionmaplisting struct { - // Entities - Entities *[]Actionmap `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Actionmaplisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/actionmapschedulegroup.go b/build/platformclientv2/actionmapschedulegroup.go deleted file mode 100644 index 0f47aeb79..000000000 --- a/build/platformclientv2/actionmapschedulegroup.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Actionmapschedulegroup -type Actionmapschedulegroup struct { - // Id - The ID of the action maps's associated schedule group. - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Actionmapschedulegroup) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/actionmapschedulegroups.go b/build/platformclientv2/actionmapschedulegroups.go deleted file mode 100644 index 3153610a4..000000000 --- a/build/platformclientv2/actionmapschedulegroups.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Actionmapschedulegroups -type Actionmapschedulegroups struct { - // ActionMapScheduleGroup - The actions map's associated schedule group. - ActionMapScheduleGroup *Actionmapschedulegroup `json:"actionMapScheduleGroup,omitempty"` - - - // EmergencyActionMapScheduleGroup - The action map's associated emergency schedule group. - EmergencyActionMapScheduleGroup *Actionmapschedulegroup `json:"emergencyActionMapScheduleGroup,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Actionmapschedulegroups) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/actionoutput.go b/build/platformclientv2/actionoutput.go deleted file mode 100644 index a70bc87ad..000000000 --- a/build/platformclientv2/actionoutput.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Actionoutput - Output definition of Action. -type Actionoutput struct { - // SuccessSchema - JSON schema that defines the transformed, successful result that will be sent back to the caller. If the 'flatten' query parameter is omitted or false, this field will be returned. Either successSchema or successSchemaFlattened will be returned, not both. - SuccessSchema *Jsonschemadocument `json:"successSchema,omitempty"` - - - // SuccessSchemaUri - URI to retrieve success schema - SuccessSchemaUri *string `json:"successSchemaUri,omitempty"` - - - // ErrorSchema - JSON schema that defines the body of response when request is not successful. If the 'flatten' query parameter is omitted or false, this field will be returned. Either errorSchema or errorSchemaFlattened will be returned, not both. - ErrorSchema *Jsonschemadocument `json:"errorSchema,omitempty"` - - - // ErrorSchemaUri - URI to retrieve error schema - ErrorSchemaUri *string `json:"errorSchemaUri,omitempty"` - - - // SuccessSchemaFlattened - JSON schema that defines the transformed, successful result that will be sent back to the caller. The schema is transformed based on Architect's flattened format. If the 'flatten' query parameter is supplied as true, this field will be returned. Either successSchema or successSchemaFlattened will be returned, not both. - SuccessSchemaFlattened *Jsonschemadocument `json:"successSchemaFlattened,omitempty"` - - - // ErrorSchemaFlattened - JSON schema that defines the body of response when request is not successful. The schema is transformed based on Architect's flattened format. If the 'flatten' query parameter is supplied as true, this field will be returned. Either errorSchema or errorSchemaFlattened will be returned, not both. - ErrorSchemaFlattened *map[string]interface{} `json:"errorSchemaFlattened,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Actionoutput) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/actionproperties.go b/build/platformclientv2/actionproperties.go deleted file mode 100644 index 61623f920..000000000 --- a/build/platformclientv2/actionproperties.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Actionproperties -type Actionproperties struct { - // WebchatPrompt - Prompt message shown to user, used for webchat type action. - WebchatPrompt *string `json:"webchatPrompt,omitempty"` - - - // WebchatTitleText - Title shown to the user, used for webchat type action. - WebchatTitleText *string `json:"webchatTitleText,omitempty"` - - - // WebchatAcceptText - Accept button text shown to user, used for webchat type action. - WebchatAcceptText *string `json:"webchatAcceptText,omitempty"` - - - // WebchatDeclineText - Decline button text shown to user, used for webchat type action. - WebchatDeclineText *string `json:"webchatDeclineText,omitempty"` - - - // WebchatSurvey - Survey provided to the user, used for webchat type action. - WebchatSurvey *Actionsurvey `json:"webchatSurvey,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Actionproperties) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/actions.go b/build/platformclientv2/actions.go deleted file mode 100644 index 7de9226d4..000000000 --- a/build/platformclientv2/actions.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Actions -type Actions struct { - // SkillsToRemove - SkillsToRemove *[]Skillstoremove `json:"skillsToRemove,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Actions) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/actionsurvey.go b/build/platformclientv2/actionsurvey.go deleted file mode 100644 index 8ef8b825d..000000000 --- a/build/platformclientv2/actionsurvey.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Actionsurvey -type Actionsurvey struct { - // Questions - Questions shown to the user. - Questions *[]Journeysurveyquestion `json:"questions,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Actionsurvey) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/actiontarget.go b/build/platformclientv2/actiontarget.go deleted file mode 100644 index 98c7f9889..000000000 --- a/build/platformclientv2/actiontarget.go +++ /dev/null @@ -1,58 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Actiontarget -type Actiontarget struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // UserData - Additional user data associated with the target in key/value format. - UserData *[]Keyvalue `json:"userData,omitempty"` - - - // SupportedMediaTypes - Supported media types of the target. - SupportedMediaTypes *[]string `json:"supportedMediaTypes,omitempty"` - - - // State - Indicates the state of the target. - State *string `json:"state,omitempty"` - - - // Description - Description of the target. - Description *string `json:"description,omitempty"` - - - // ServiceLevel - Service Level of the action target. Chat offers for the target will be throttled with the aim of achieving this service level. - ServiceLevel *Servicelevel `json:"serviceLevel,omitempty"` - - - // ShortAbandonThreshold - Indicates the non-default short abandon threshold - ShortAbandonThreshold *int `json:"shortAbandonThreshold,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - - - // CreatedDate - The date the target was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - CreatedDate *time.Time `json:"createdDate,omitempty"` - - - // ModifiedDate - The date the target was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ModifiedDate *time.Time `json:"modifiedDate,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Actiontarget) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/actiontargetlisting.go b/build/platformclientv2/actiontargetlisting.go deleted file mode 100644 index f09d64c36..000000000 --- a/build/platformclientv2/actiontargetlisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Actiontargetlisting -type Actiontargetlisting struct { - // Entities - Entities *[]Actiontarget `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Actiontargetlisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/actiontemplate.go b/build/platformclientv2/actiontemplate.go deleted file mode 100644 index 6c7c24d57..000000000 --- a/build/platformclientv2/actiontemplate.go +++ /dev/null @@ -1,50 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Actiontemplate -type Actiontemplate struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name of the action template. - Name *string `json:"name,omitempty"` - - - // Description - Description of the action template's functionality. - Description *string `json:"description,omitempty"` - - - // MediaType - Media type of action described by the action template. - MediaType *string `json:"mediaType,omitempty"` - - - // State - Whether the action template is currently active, inactive or deleted. - State *string `json:"state,omitempty"` - - - // ContentOffer - Properties used to configure an action of type content offer - ContentOffer *Contentoffer `json:"contentOffer,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - - - // CreatedDate - Date when action template was created in ISO-8601 format. - CreatedDate *time.Time `json:"createdDate,omitempty"` - - - // ModifiedDate - Date when action template was last modified in ISO-8601 format. - ModifiedDate *time.Time `json:"modifiedDate,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Actiontemplate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/actiontemplatelisting.go b/build/platformclientv2/actiontemplatelisting.go deleted file mode 100644 index 7ecb18f2e..000000000 --- a/build/platformclientv2/actiontemplatelisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Actiontemplatelisting -type Actiontemplatelisting struct { - // Entities - Entities *[]Actiontemplate `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Actiontemplatelisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/activation.go b/build/platformclientv2/activation.go deleted file mode 100644 index b7bfd1f2a..000000000 --- a/build/platformclientv2/activation.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Activation -type Activation struct { - // VarType - Type of activation. - VarType *string `json:"type,omitempty"` - - - // DelayInSeconds - Activation delay time amount. - DelayInSeconds *int `json:"delayInSeconds,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Activation) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/activealertcount.go b/build/platformclientv2/activealertcount.go deleted file mode 100644 index 60f269522..000000000 --- a/build/platformclientv2/activealertcount.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Activealertcount -type Activealertcount struct { - // Count - The count of active alerts for a user. - Count *int `json:"count,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Activealertcount) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/activitycode.go b/build/platformclientv2/activitycode.go deleted file mode 100644 index 6a00d06d7..000000000 --- a/build/platformclientv2/activitycode.go +++ /dev/null @@ -1,57 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Activitycode - Activity code data -type Activitycode struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - - - // Name - The name of the activity code. Default activity codes will be created with an empty name - Name *string `json:"name,omitempty"` - - - // IsActive - Whether this activity code is active or has been deleted - IsActive *bool `json:"isActive,omitempty"` - - - // IsDefault - Whether this is a default activity code - IsDefault *bool `json:"isDefault,omitempty"` - - - // Category - The activity code's category. - Category *string `json:"category,omitempty"` - - - // LengthInMinutes - The default length of the activity in minutes - LengthInMinutes *int `json:"lengthInMinutes,omitempty"` - - - // CountsAsPaidTime - Whether an agent is paid while performing this activity - CountsAsPaidTime *bool `json:"countsAsPaidTime,omitempty"` - - - // CountsAsWorkTime - Indicates whether or not the activity should be counted as contiguous work time for calculating daily constraints - CountsAsWorkTime *bool `json:"countsAsWorkTime,omitempty"` - - - // AgentTimeOffSelectable - Whether an agent can select this activity code when creating or editing a time off request. Null if the activity's category is not time off. - AgentTimeOffSelectable *bool `json:"agentTimeOffSelectable,omitempty"` - - - // Metadata - Version metadata for the associated management unit's list of activity codes - Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Activitycode) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/activitycodecontainer.go b/build/platformclientv2/activitycodecontainer.go deleted file mode 100644 index 533ebc895..000000000 --- a/build/platformclientv2/activitycodecontainer.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Activitycodecontainer - Container for a map of ActivityCodeId to ActivityCode -type Activitycodecontainer struct { - // ActivityCodes - Map of activity code id to activity code - ActivityCodes *map[string]Activitycode `json:"activityCodes,omitempty"` - - - // Metadata - Version metadata for the associated management unit's list of activity codes - Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Activitycodecontainer) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/acwsettings.go b/build/platformclientv2/acwsettings.go deleted file mode 100644 index 7d2a06773..000000000 --- a/build/platformclientv2/acwsettings.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Acwsettings -type Acwsettings struct { - // WrapupPrompt - This field controls how the UI prompts the agent for a wrapup. - WrapupPrompt *string `json:"wrapupPrompt,omitempty"` - - - // TimeoutMs - The amount of time the agent can stay in ACW (Min: 1 sec, Max: 1 day). Can only be used when ACW is MANDATORY_TIMEOUT or MANDATORY_FORCED_TIMEOUT. - TimeoutMs *int `json:"timeoutMs,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Acwsettings) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/addconversationrequest.go b/build/platformclientv2/addconversationrequest.go deleted file mode 100644 index 00c4940a4..000000000 --- a/build/platformclientv2/addconversationrequest.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Addconversationrequest - Update coaching appointment request -type Addconversationrequest struct { - // ConversationId - The id of the conversation to add - ConversationId *string `json:"conversationId,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Addconversationrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/addconversationresponse.go b/build/platformclientv2/addconversationresponse.go deleted file mode 100644 index 3d08fa69a..000000000 --- a/build/platformclientv2/addconversationresponse.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Addconversationresponse -type Addconversationresponse struct { - // Conversation - The conversation reference - Conversation *Conversationreference `json:"conversation,omitempty"` - - - // Appointment - The appointment reference - Appointment *Coachingappointmentreference `json:"appointment,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Addconversationresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/additionalmessage.go b/build/platformclientv2/additionalmessage.go deleted file mode 100644 index d4a93630d..000000000 --- a/build/platformclientv2/additionalmessage.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Additionalmessage -type Additionalmessage struct { - // TextBody - The body of the text message. - TextBody *string `json:"textBody,omitempty"` - - - // MediaIds - The media ids associated with the text message. - MediaIds *[]string `json:"mediaIds,omitempty"` - - - // StickerIds - The sticker ids associated with the text message. - StickerIds *[]string `json:"stickerIds,omitempty"` - - - // MessagingTemplate - The messaging template use to send a predefined canned response with the message - MessagingTemplate *Messagingtemplaterequest `json:"messagingTemplate,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Additionalmessage) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/address.go b/build/platformclientv2/address.go deleted file mode 100644 index de17fe8d1..000000000 --- a/build/platformclientv2/address.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Address -type Address struct { - // Name - This will be nameRaw if present, or a locality lookup of the address field otherwise. - Name *string `json:"name,omitempty"` - - - // NameRaw - The name as close to the bits on the wire as possible. - NameRaw *string `json:"nameRaw,omitempty"` - - - // AddressNormalized - The normalized address. This field is acquired from the Address Normalization Table. The addressRaw could have gone through some transformations, such as only using the numeric portion, before being run through the Address Normalization Table. - AddressNormalized *string `json:"addressNormalized,omitempty"` - - - // AddressRaw - The address as close to the bits on the wire as possible. - AddressRaw *string `json:"addressRaw,omitempty"` - - - // AddressDisplayable - The displayable address. This field is acquired from the Address Normalization Table. The addressRaw could have gone through some transformations, such as only using the numeric portion, before being run through the Address Normalization Table. - AddressDisplayable *string `json:"addressDisplayable,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Address) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/addressableentityref.go b/build/platformclientv2/addressableentityref.go deleted file mode 100644 index 2c4b65301..000000000 --- a/build/platformclientv2/addressableentityref.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Addressableentityref -type Addressableentityref struct { - // Id - Id *string `json:"id,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Addressableentityref) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/addressablelicensedefinition.go b/build/platformclientv2/addressablelicensedefinition.go deleted file mode 100644 index 3be2c7442..000000000 --- a/build/platformclientv2/addressablelicensedefinition.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Addressablelicensedefinition -type Addressablelicensedefinition struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Addressablelicensedefinition) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/addshifttraderequest.go b/build/platformclientv2/addshifttraderequest.go deleted file mode 100644 index 320128412..000000000 --- a/build/platformclientv2/addshifttraderequest.go +++ /dev/null @@ -1,34 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Addshifttraderequest -type Addshifttraderequest struct { - // ScheduleId - The ID of the schedule to which the initiating and receiving shifts belong - ScheduleId *string `json:"scheduleId,omitempty"` - - - // InitiatingShiftId - The ID of the shift that the initiating user wants to give up - InitiatingShiftId *string `json:"initiatingShiftId,omitempty"` - - - // ReceivingUserId - The ID of the user to whom to send the request (for use in direct trade requests) - ReceivingUserId *string `json:"receivingUserId,omitempty"` - - - // Expiration - When this shift trade request should expire. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - Expiration *time.Time `json:"expiration,omitempty"` - - - // AcceptableIntervals - AcceptableIntervals *[]string `json:"acceptableIntervals,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Addshifttraderequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/addworkplanrotationagentrequest.go b/build/platformclientv2/addworkplanrotationagentrequest.go deleted file mode 100644 index 1c0f4cd9f..000000000 --- a/build/platformclientv2/addworkplanrotationagentrequest.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Addworkplanrotationagentrequest -type Addworkplanrotationagentrequest struct { - // UserId - The ID of an agent in this work plan rotation - UserId *string `json:"userId,omitempty"` - - - // DateRange - The date range to which this agent is effective in the work plan rotation - DateRange *Daterangewithoptionalend `json:"dateRange,omitempty"` - - - // Position - Start position of the work plan in the pattern for this agent in the work plan rotation. Position value starts from 0 - Position *int `json:"position,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Addworkplanrotationagentrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/addworkplanrotationrequest.go b/build/platformclientv2/addworkplanrotationrequest.go deleted file mode 100644 index d8c5fc6fb..000000000 --- a/build/platformclientv2/addworkplanrotationrequest.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Addworkplanrotationrequest -type Addworkplanrotationrequest struct { - // Name - Name of this work plan rotation - Name *string `json:"name,omitempty"` - - - // DateRange - The date range to which this work plan rotation applies - DateRange *Daterangewithoptionalend `json:"dateRange,omitempty"` - - - // Agents - Agents in this work plan rotation - Agents *[]Addworkplanrotationagentrequest `json:"agents,omitempty"` - - - // Pattern - Pattern with list of work plan IDs that rotate on a weekly basis - Pattern *Workplanpatternrequest `json:"pattern,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Addworkplanrotationrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/adfs.go b/build/platformclientv2/adfs.go deleted file mode 100644 index eafa53ed3..000000000 --- a/build/platformclientv2/adfs.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Adfs -type Adfs struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Disabled - Disabled *bool `json:"disabled,omitempty"` - - - // IssuerURI - IssuerURI *string `json:"issuerURI,omitempty"` - - - // SsoTargetURI - SsoTargetURI *string `json:"ssoTargetURI,omitempty"` - - - // Certificate - Certificate *string `json:"certificate,omitempty"` - - - // Certificates - Certificates *[]string `json:"certificates,omitempty"` - - - // RelyingPartyIdentifier - RelyingPartyIdentifier *string `json:"relyingPartyIdentifier,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Adfs) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/adherencesettings.go b/build/platformclientv2/adherencesettings.go deleted file mode 100644 index e9ae91b86..000000000 --- a/build/platformclientv2/adherencesettings.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Adherencesettings - Schedule Adherence Configuration -type Adherencesettings struct { - // SevereAlertThresholdMinutes - The threshold in minutes where an alert will be triggered when an agent is considered severely out of adherence - SevereAlertThresholdMinutes *int `json:"severeAlertThresholdMinutes,omitempty"` - - - // AdherenceTargetPercent - Target adherence percentage - AdherenceTargetPercent *int `json:"adherenceTargetPercent,omitempty"` - - - // AdherenceExceptionThresholdSeconds - The threshold in seconds for which agents should not be penalized for being momentarily out of adherence - AdherenceExceptionThresholdSeconds *int `json:"adherenceExceptionThresholdSeconds,omitempty"` - - - // NonOnQueueActivitiesEquivalent - Whether to treat all non-on-queue activities as equivalent for adherence purposes - NonOnQueueActivitiesEquivalent *bool `json:"nonOnQueueActivitiesEquivalent,omitempty"` - - - // TrackOnQueueActivity - Whether to track on-queue activities - TrackOnQueueActivity *bool `json:"trackOnQueueActivity,omitempty"` - - - // IgnoredActivityCategories - Activity categories that should be ignored for adherence purposes - IgnoredActivityCategories *Ignoredactivitycategories `json:"ignoredActivityCategories,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Adherencesettings) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/adhocrecordingtopicconversationdata.go b/build/platformclientv2/adhocrecordingtopicconversationdata.go deleted file mode 100644 index bd1b88f7a..000000000 --- a/build/platformclientv2/adhocrecordingtopicconversationdata.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Adhocrecordingtopicconversationdata -type Adhocrecordingtopicconversationdata struct { - // Id - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Adhocrecordingtopicconversationdata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/adhocrecordingtopiclockdata.go b/build/platformclientv2/adhocrecordingtopiclockdata.go deleted file mode 100644 index 37c348514..000000000 --- a/build/platformclientv2/adhocrecordingtopiclockdata.go +++ /dev/null @@ -1,26 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Adhocrecordingtopiclockdata -type Adhocrecordingtopiclockdata struct { - // LockedBy - LockedBy *Adhocrecordingtopicuserdata `json:"lockedBy,omitempty"` - - - // DateCreated - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateExpires - DateExpires *time.Time `json:"dateExpires,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Adhocrecordingtopiclockdata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/adhocrecordingtopicrecordingdatav2.go b/build/platformclientv2/adhocrecordingtopicrecordingdatav2.go deleted file mode 100644 index b2dcac595..000000000 --- a/build/platformclientv2/adhocrecordingtopicrecordingdatav2.go +++ /dev/null @@ -1,82 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Adhocrecordingtopicrecordingdatav2 -type Adhocrecordingtopicrecordingdatav2 struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // DateCreated - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - DateModified *time.Time `json:"dateModified,omitempty"` - - - // Workspace - Workspace *Adhocrecordingtopicworkspacedata `json:"workspace,omitempty"` - - - // CreatedBy - CreatedBy *Adhocrecordingtopicuserdata `json:"createdBy,omitempty"` - - - // ContentType - ContentType *string `json:"contentType,omitempty"` - - - // ContentLength - ContentLength *int `json:"contentLength,omitempty"` - - - // Filename - Filename *string `json:"filename,omitempty"` - - - // ChangeNumber - ChangeNumber *int `json:"changeNumber,omitempty"` - - - // DateUploaded - DateUploaded *time.Time `json:"dateUploaded,omitempty"` - - - // UploadedBy - UploadedBy *Adhocrecordingtopicuserdata `json:"uploadedBy,omitempty"` - - - // LockInfo - LockInfo *Adhocrecordingtopiclockdata `json:"lockInfo,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // DurationMillieconds - DurationMillieconds *int `json:"durationMillieconds,omitempty"` - - - // Conversation - Conversation *Adhocrecordingtopicconversationdata `json:"conversation,omitempty"` - - - // Read - Read *bool `json:"read,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Adhocrecordingtopicrecordingdatav2) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/adhocrecordingtopicworkspacedata.go b/build/platformclientv2/adhocrecordingtopicworkspacedata.go deleted file mode 100644 index 8d7b03786..000000000 --- a/build/platformclientv2/adhocrecordingtopicworkspacedata.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Adhocrecordingtopicworkspacedata -type Adhocrecordingtopicworkspacedata struct { - // Id - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Adhocrecordingtopicworkspacedata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/adjacents.go b/build/platformclientv2/adjacents.go deleted file mode 100644 index 7df13c35f..000000000 --- a/build/platformclientv2/adjacents.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Adjacents -type Adjacents struct { - // Superiors - Superiors *[]User `json:"superiors,omitempty"` - - - // Siblings - Siblings *[]User `json:"siblings,omitempty"` - - - // DirectReports - DirectReports *[]User `json:"directReports,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Adjacents) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/admintimeoffrequestpatch.go b/build/platformclientv2/admintimeoffrequestpatch.go deleted file mode 100644 index c4a5a9478..000000000 --- a/build/platformclientv2/admintimeoffrequestpatch.go +++ /dev/null @@ -1,42 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Admintimeoffrequestpatch -type Admintimeoffrequestpatch struct { - // Status - The status of this time off request - Status *string `json:"status,omitempty"` - - - // ActivityCodeId - The ID of the activity code associated with this time off request. Activity code must be of the TimeOff category - ActivityCodeId *string `json:"activityCodeId,omitempty"` - - - // Notes - Notes about the time off request - Notes *string `json:"notes,omitempty"` - - - // FullDayManagementUnitDates - A set of dates in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone. - FullDayManagementUnitDates *[]string `json:"fullDayManagementUnitDates,omitempty"` - - - // PartialDayStartDateTimes - A set of start date-times in ISO-8601 format for partial day requests. - PartialDayStartDateTimes *[]time.Time `json:"partialDayStartDateTimes,omitempty"` - - - // DailyDurationMinutes - The daily duration of this time off request in minutes - DailyDurationMinutes *int `json:"dailyDurationMinutes,omitempty"` - - - // Metadata - Version metadata for the time off request - Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Admintimeoffrequestpatch) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/aftercallwork.go b/build/platformclientv2/aftercallwork.go deleted file mode 100644 index 6cc5aba34..000000000 --- a/build/platformclientv2/aftercallwork.go +++ /dev/null @@ -1,26 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Aftercallwork -type Aftercallwork struct { - // StartTime - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartTime *time.Time `json:"startTime,omitempty"` - - - // EndTime - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - EndTime *time.Time `json:"endTime,omitempty"` - - - // State - State *string `json:"state,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Aftercallwork) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/agent.go b/build/platformclientv2/agent.go deleted file mode 100644 index d19e0ce1f..000000000 --- a/build/platformclientv2/agent.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Agent -type Agent struct { - // Stage - The current stage for this agent - Stage *string `json:"stage,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Agent) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/agentactivity.go b/build/platformclientv2/agentactivity.go deleted file mode 100644 index e04461e0b..000000000 --- a/build/platformclientv2/agentactivity.go +++ /dev/null @@ -1,69 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Agentactivity -type Agentactivity struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Agent - Agent *User `json:"agent,omitempty"` - - - // NumEvaluations - NumEvaluations *int `json:"numEvaluations,omitempty"` - - - // AverageEvaluationScore - AverageEvaluationScore *int `json:"averageEvaluationScore,omitempty"` - - - // NumCriticalEvaluations - NumCriticalEvaluations *int `json:"numCriticalEvaluations,omitempty"` - - - // AverageCriticalScore - AverageCriticalScore *float32 `json:"averageCriticalScore,omitempty"` - - - // HighestEvaluationScore - HighestEvaluationScore *float32 `json:"highestEvaluationScore,omitempty"` - - - // LowestEvaluationScore - LowestEvaluationScore *float32 `json:"lowestEvaluationScore,omitempty"` - - - // HighestCriticalScore - HighestCriticalScore *float32 `json:"highestCriticalScore,omitempty"` - - - // LowestCriticalScore - LowestCriticalScore *float32 `json:"lowestCriticalScore,omitempty"` - - - // AgentEvaluatorActivityList - AgentEvaluatorActivityList *[]Agentevaluatoractivity `json:"agentEvaluatorActivityList,omitempty"` - - - // NumEvaluationsWithoutViewPermission - NumEvaluationsWithoutViewPermission *int `json:"numEvaluationsWithoutViewPermission,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Agentactivity) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/agentactivitychangedtopicagentactivity.go b/build/platformclientv2/agentactivitychangedtopicagentactivity.go deleted file mode 100644 index dbe34f4b7..000000000 --- a/build/platformclientv2/agentactivitychangedtopicagentactivity.go +++ /dev/null @@ -1,38 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Agentactivitychangedtopicagentactivity -type Agentactivitychangedtopicagentactivity struct { - // Id - Id *string `json:"id,omitempty"` - - - // RoutingStatus - RoutingStatus *Agentactivitychangedtopicroutingstatus `json:"routingStatus,omitempty"` - - - // Presence - Presence *Agentactivitychangedtopicpresence `json:"presence,omitempty"` - - - // OutOfOffice - OutOfOffice *Agentactivitychangedtopicoutofoffice `json:"outOfOffice,omitempty"` - - - // ActiveQueueIds - ActiveQueueIds *[]string `json:"activeQueueIds,omitempty"` - - - // DateActiveQueuesChanged - DateActiveQueuesChanged *time.Time `json:"dateActiveQueuesChanged,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Agentactivitychangedtopicagentactivity) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/agentactivitychangedtopicorganizationpresence.go b/build/platformclientv2/agentactivitychangedtopicorganizationpresence.go deleted file mode 100644 index 28660d9f2..000000000 --- a/build/platformclientv2/agentactivitychangedtopicorganizationpresence.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Agentactivitychangedtopicorganizationpresence -type Agentactivitychangedtopicorganizationpresence struct { - // Id - Id *string `json:"id,omitempty"` - - - // SystemPresence - SystemPresence *string `json:"systemPresence,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Agentactivitychangedtopicorganizationpresence) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/agentactivitychangedtopicoutofoffice.go b/build/platformclientv2/agentactivitychangedtopicoutofoffice.go deleted file mode 100644 index 44a5e5dfe..000000000 --- a/build/platformclientv2/agentactivitychangedtopicoutofoffice.go +++ /dev/null @@ -1,22 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Agentactivitychangedtopicoutofoffice -type Agentactivitychangedtopicoutofoffice struct { - // Active - Active *bool `json:"active,omitempty"` - - - // ModifiedDate - ModifiedDate *time.Time `json:"modifiedDate,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Agentactivitychangedtopicoutofoffice) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/agentactivitychangedtopicpresence.go b/build/platformclientv2/agentactivitychangedtopicpresence.go deleted file mode 100644 index 5dbcabc86..000000000 --- a/build/platformclientv2/agentactivitychangedtopicpresence.go +++ /dev/null @@ -1,26 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Agentactivitychangedtopicpresence -type Agentactivitychangedtopicpresence struct { - // PresenceDefinition - PresenceDefinition *Agentactivitychangedtopicorganizationpresence `json:"presenceDefinition,omitempty"` - - - // PresenceMessage - PresenceMessage *string `json:"presenceMessage,omitempty"` - - - // ModifiedDate - ModifiedDate *time.Time `json:"modifiedDate,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Agentactivitychangedtopicpresence) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/agentactivitychangedtopicroutingstatus.go b/build/platformclientv2/agentactivitychangedtopicroutingstatus.go deleted file mode 100644 index cbf5ebd67..000000000 --- a/build/platformclientv2/agentactivitychangedtopicroutingstatus.go +++ /dev/null @@ -1,22 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Agentactivitychangedtopicroutingstatus -type Agentactivitychangedtopicroutingstatus struct { - // Status - Status *string `json:"status,omitempty"` - - - // StartTime - StartTime *time.Time `json:"startTime,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Agentactivitychangedtopicroutingstatus) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/agentactivityentitylisting.go b/build/platformclientv2/agentactivityentitylisting.go deleted file mode 100644 index 5c2e9a657..000000000 --- a/build/platformclientv2/agentactivityentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Agentactivityentitylisting -type Agentactivityentitylisting struct { - // Entities - Entities *[]Agentactivity `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Agentactivityentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/agentevaluatoractivity.go b/build/platformclientv2/agentevaluatoractivity.go deleted file mode 100644 index 4f1c34133..000000000 --- a/build/platformclientv2/agentevaluatoractivity.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Agentevaluatoractivity -type Agentevaluatoractivity struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Agent - Agent *User `json:"agent,omitempty"` - - - // Evaluator - Evaluator *User `json:"evaluator,omitempty"` - - - // NumEvaluations - NumEvaluations *int `json:"numEvaluations,omitempty"` - - - // AverageEvaluationScore - AverageEvaluationScore *int `json:"averageEvaluationScore,omitempty"` - - - // NumEvaluationsWithoutViewPermission - NumEvaluationsWithoutViewPermission *int `json:"numEvaluationsWithoutViewPermission,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Agentevaluatoractivity) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/agenttimeoffrequestpatch.go b/build/platformclientv2/agenttimeoffrequestpatch.go deleted file mode 100644 index 33ec26704..000000000 --- a/build/platformclientv2/agenttimeoffrequestpatch.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Agenttimeoffrequestpatch -type Agenttimeoffrequestpatch struct { - // MarkedAsRead - Whether this request has been read by the agent - MarkedAsRead *bool `json:"markedAsRead,omitempty"` - - - // Status - The status of this time off request. Can only be canceled if the requested date has not already passed - Status *string `json:"status,omitempty"` - - - // Notes - Notes about the time off request. Can only be edited while the request is still pending - Notes *string `json:"notes,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Agenttimeoffrequestpatch) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/aggregatemetricdata.go b/build/platformclientv2/aggregatemetricdata.go deleted file mode 100644 index 4f435da94..000000000 --- a/build/platformclientv2/aggregatemetricdata.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Aggregatemetricdata -type Aggregatemetricdata struct { - // Metric - Metric *string `json:"metric,omitempty"` - - - // Qualifier - Qualifier *string `json:"qualifier,omitempty"` - - - // Stats - Stats *Statisticalsummary `json:"stats,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Aggregatemetricdata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/aggregateviewdata.go b/build/platformclientv2/aggregateviewdata.go deleted file mode 100644 index 608c2378b..000000000 --- a/build/platformclientv2/aggregateviewdata.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Aggregateviewdata -type Aggregateviewdata struct { - // Name - Name *string `json:"name,omitempty"` - - - // Stats - Stats *Statisticalsummary `json:"stats,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Aggregateviewdata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/aggregationrange.go b/build/platformclientv2/aggregationrange.go deleted file mode 100644 index 84580edbe..000000000 --- a/build/platformclientv2/aggregationrange.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Aggregationrange -type Aggregationrange struct { - // Gte - Greater than or equal to - Gte *float32 `json:"gte,omitempty"` - - - // Lt - Less than - Lt *float32 `json:"lt,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Aggregationrange) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/aggregationresult.go b/build/platformclientv2/aggregationresult.go deleted file mode 100644 index 2c3ebef81..000000000 --- a/build/platformclientv2/aggregationresult.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Aggregationresult -type Aggregationresult struct { - // VarType - VarType *string `json:"type,omitempty"` - - - // Dimension - For termFrequency aggregations - Dimension *string `json:"dimension,omitempty"` - - - // Metric - For numericRange aggregations - Metric *string `json:"metric,omitempty"` - - - // Count - Count *int `json:"count,omitempty"` - - - // Results - Results *[]Aggregationresultentry `json:"results,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Aggregationresult) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/aggregationresultentry.go b/build/platformclientv2/aggregationresultentry.go deleted file mode 100644 index 9177fa94d..000000000 --- a/build/platformclientv2/aggregationresultentry.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Aggregationresultentry -type Aggregationresultentry struct { - // Count - Count *int `json:"count,omitempty"` - - - // Value - For termFrequency aggregations - Value *string `json:"value,omitempty"` - - - // Gte - For numericRange aggregations - Gte *float32 `json:"gte,omitempty"` - - - // Lt - For numericRange aggregations - Lt *float32 `json:"lt,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Aggregationresultentry) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/alertingapi.go b/build/platformclientv2/alertingapi.go deleted file mode 100644 index 238759613..000000000 --- a/build/platformclientv2/alertingapi.go +++ /dev/null @@ -1,877 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "encoding/json" -) - -// AlertingApi provides functions for API endpoints -type AlertingApi struct { - Configuration *Configuration -} - -// NewAlertingApi creates an API instance using the default configuration -func NewAlertingApi() *AlertingApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating AlertingApi with base path: %s", strings.ToLower(config.BasePath))) - return &AlertingApi{ - Configuration: config, - } -} - -// NewAlertingApiWithConfig creates an API instance using the provided configuration -func NewAlertingApiWithConfig(config *Configuration) *AlertingApi { - config.Debugf("Creating AlertingApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &AlertingApi{ - Configuration: config, - } -} - -// DeleteAlertingInteractionstatsAlert invokes DELETE /api/v2/alerting/interactionstats/alerts/{alertId} -// -// Delete an interaction stats alert -// -// -func (a AlertingApi) DeleteAlertingInteractionstatsAlert(alertId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/alerting/interactionstats/alerts/{alertId}" - path = strings.Replace(path, "{alertId}", fmt.Sprintf("%v", alertId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'alertId' is set - if &alertId == nil { - // - return nil, errors.New("Missing required parameter 'alertId' when calling AlertingApi->DeleteAlertingInteractionstatsAlert") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteAlertingInteractionstatsRule invokes DELETE /api/v2/alerting/interactionstats/rules/{ruleId} -// -// Delete an interaction stats rule. -// -// -func (a AlertingApi) DeleteAlertingInteractionstatsRule(ruleId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/alerting/interactionstats/rules/{ruleId}" - path = strings.Replace(path, "{ruleId}", fmt.Sprintf("%v", ruleId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'ruleId' is set - if &ruleId == nil { - // - return nil, errors.New("Missing required parameter 'ruleId' when calling AlertingApi->DeleteAlertingInteractionstatsRule") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// GetAlertingAlertsActive invokes GET /api/v2/alerting/alerts/active -// -// Gets active alert count for a user. -// -// -func (a AlertingApi) GetAlertingAlertsActive() (*Activealertcount, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/alerting/alerts/active" - defaultReturn := new(Activealertcount) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Activealertcount - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAlertingInteractionstatsAlert invokes GET /api/v2/alerting/interactionstats/alerts/{alertId} -// -// Get an interaction stats alert -// -// -func (a AlertingApi) GetAlertingInteractionstatsAlert(alertId string, expand []string) (*Interactionstatsalert, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/alerting/interactionstats/alerts/{alertId}" - path = strings.Replace(path, "{alertId}", fmt.Sprintf("%v", alertId), -1) - defaultReturn := new(Interactionstatsalert) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'alertId' is set - if &alertId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'alertId' when calling AlertingApi->GetAlertingInteractionstatsAlert") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Interactionstatsalert - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAlertingInteractionstatsAlerts invokes GET /api/v2/alerting/interactionstats/alerts -// -// Get interaction stats alert list. -// -// -func (a AlertingApi) GetAlertingInteractionstatsAlerts(expand []string) (*Interactionstatsalertcontainer, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/alerting/interactionstats/alerts" - defaultReturn := new(Interactionstatsalertcontainer) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Interactionstatsalertcontainer - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAlertingInteractionstatsAlertsUnread invokes GET /api/v2/alerting/interactionstats/alerts/unread -// -// Gets user unread count of interaction stats alerts. -// -// -func (a AlertingApi) GetAlertingInteractionstatsAlertsUnread() (*Unreadmetric, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/alerting/interactionstats/alerts/unread" - defaultReturn := new(Unreadmetric) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Unreadmetric - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAlertingInteractionstatsRule invokes GET /api/v2/alerting/interactionstats/rules/{ruleId} -// -// Get an interaction stats rule. -// -// -func (a AlertingApi) GetAlertingInteractionstatsRule(ruleId string, expand []string) (*Interactionstatsrule, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/alerting/interactionstats/rules/{ruleId}" - path = strings.Replace(path, "{ruleId}", fmt.Sprintf("%v", ruleId), -1) - defaultReturn := new(Interactionstatsrule) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'ruleId' is set - if &ruleId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'ruleId' when calling AlertingApi->GetAlertingInteractionstatsRule") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Interactionstatsrule - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAlertingInteractionstatsRules invokes GET /api/v2/alerting/interactionstats/rules -// -// Get an interaction stats rule list. -// -// -func (a AlertingApi) GetAlertingInteractionstatsRules(expand []string) (*Interactionstatsrulecontainer, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/alerting/interactionstats/rules" - defaultReturn := new(Interactionstatsrulecontainer) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Interactionstatsrulecontainer - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostAlertingInteractionstatsRules invokes POST /api/v2/alerting/interactionstats/rules -// -// Create an interaction stats rule. -// -// -func (a AlertingApi) PostAlertingInteractionstatsRules(body Interactionstatsrule, expand []string) (*Interactionstatsrule, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/alerting/interactionstats/rules" - defaultReturn := new(Interactionstatsrule) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling AlertingApi->PostAlertingInteractionstatsRules") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Interactionstatsrule - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutAlertingInteractionstatsAlert invokes PUT /api/v2/alerting/interactionstats/alerts/{alertId} -// -// Update an interaction stats alert read status -// -// -func (a AlertingApi) PutAlertingInteractionstatsAlert(alertId string, body Unreadstatus, expand []string) (*Unreadstatus, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/alerting/interactionstats/alerts/{alertId}" - path = strings.Replace(path, "{alertId}", fmt.Sprintf("%v", alertId), -1) - defaultReturn := new(Unreadstatus) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'alertId' is set - if &alertId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'alertId' when calling AlertingApi->PutAlertingInteractionstatsAlert") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling AlertingApi->PutAlertingInteractionstatsAlert") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Unreadstatus - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutAlertingInteractionstatsRule invokes PUT /api/v2/alerting/interactionstats/rules/{ruleId} -// -// Update an interaction stats rule -// -// -func (a AlertingApi) PutAlertingInteractionstatsRule(ruleId string, body Interactionstatsrule, expand []string) (*Interactionstatsrule, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/alerting/interactionstats/rules/{ruleId}" - path = strings.Replace(path, "{ruleId}", fmt.Sprintf("%v", ruleId), -1) - defaultReturn := new(Interactionstatsrule) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'ruleId' is set - if &ruleId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'ruleId' when calling AlertingApi->PutAlertingInteractionstatsRule") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling AlertingApi->PutAlertingInteractionstatsRule") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Interactionstatsrule - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/amazonlexrequest.go b/build/platformclientv2/amazonlexrequest.go deleted file mode 100644 index 586681d9c..000000000 --- a/build/platformclientv2/amazonlexrequest.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Amazonlexrequest -type Amazonlexrequest struct { - // RequestAttributes - AttributeName/AttributeValue pairs of User Defined Request Attributes to be sent to the amazon bot See - https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-request-attribs - RequestAttributes *map[string]string `json:"requestAttributes,omitempty"` - - - // SessionAttributes - AttributeName/AttributeValue pairs of Session Attributes to be sent to the amazon bot. See - https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-session-attribs - SessionAttributes *map[string]string `json:"sessionAttributes,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Amazonlexrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/analyticsapi.go b/build/platformclientv2/analyticsapi.go deleted file mode 100644 index 1414f7844..000000000 --- a/build/platformclientv2/analyticsapi.go +++ /dev/null @@ -1,3119 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "encoding/json" -) - -// AnalyticsApi provides functions for API endpoints -type AnalyticsApi struct { - Configuration *Configuration -} - -// NewAnalyticsApi creates an API instance using the default configuration -func NewAnalyticsApi() *AnalyticsApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating AnalyticsApi with base path: %s", strings.ToLower(config.BasePath))) - return &AnalyticsApi{ - Configuration: config, - } -} - -// NewAnalyticsApiWithConfig creates an API instance using the provided configuration -func NewAnalyticsApiWithConfig(config *Configuration) *AnalyticsApi { - config.Debugf("Creating AnalyticsApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &AnalyticsApi{ - Configuration: config, - } -} - -// DeleteAnalyticsConversationsDetailsJob invokes DELETE /api/v2/analytics/conversations/details/jobs/{jobId} -// -// Delete/cancel an async request -// -// -func (a AnalyticsApi) DeleteAnalyticsConversationsDetailsJob(jobId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/conversations/details/jobs/{jobId}" - path = strings.Replace(path, "{jobId}", fmt.Sprintf("%v", jobId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'jobId' is set - if &jobId == nil { - // - return nil, errors.New("Missing required parameter 'jobId' when calling AnalyticsApi->DeleteAnalyticsConversationsDetailsJob") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteAnalyticsReportingSchedule invokes DELETE /api/v2/analytics/reporting/schedules/{scheduleId} -// -// Delete a scheduled report job. -// -// -func (a AnalyticsApi) DeleteAnalyticsReportingSchedule(scheduleId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/reporting/schedules/{scheduleId}" - path = strings.Replace(path, "{scheduleId}", fmt.Sprintf("%v", scheduleId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'scheduleId' is set - if &scheduleId == nil { - // - return nil, errors.New("Missing required parameter 'scheduleId' when calling AnalyticsApi->DeleteAnalyticsReportingSchedule") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteAnalyticsUsersDetailsJob invokes DELETE /api/v2/analytics/users/details/jobs/{jobId} -// -// Delete/cancel an async request -// -// -func (a AnalyticsApi) DeleteAnalyticsUsersDetailsJob(jobId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/users/details/jobs/{jobId}" - path = strings.Replace(path, "{jobId}", fmt.Sprintf("%v", jobId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'jobId' is set - if &jobId == nil { - // - return nil, errors.New("Missing required parameter 'jobId' when calling AnalyticsApi->DeleteAnalyticsUsersDetailsJob") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// GetAnalyticsConversationDetails invokes GET /api/v2/analytics/conversations/{conversationId}/details -// -// Get a conversation by id -// -// -func (a AnalyticsApi) GetAnalyticsConversationDetails(conversationId string) (*Analyticsconversationwithoutattributes, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/conversations/{conversationId}/details" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - defaultReturn := new(Analyticsconversationwithoutattributes) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling AnalyticsApi->GetAnalyticsConversationDetails") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Analyticsconversationwithoutattributes - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAnalyticsConversationsDetails invokes GET /api/v2/analytics/conversations/details -// -// Gets multiple conversations by id -// -// -func (a AnalyticsApi) GetAnalyticsConversationsDetails(id []string) (*Analyticsconversationwithoutattributesmultigetresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/conversations/details" - defaultReturn := new(Analyticsconversationwithoutattributesmultigetresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range id { - queryParams["id"] = value - } - } else { - queryParams["id"] = a.Configuration.APIClient.ParameterToString(id, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Analyticsconversationwithoutattributesmultigetresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAnalyticsConversationsDetailsJob invokes GET /api/v2/analytics/conversations/details/jobs/{jobId} -// -// Get status for async query for conversation details -// -// -func (a AnalyticsApi) GetAnalyticsConversationsDetailsJob(jobId string) (*Asyncquerystatus, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/conversations/details/jobs/{jobId}" - path = strings.Replace(path, "{jobId}", fmt.Sprintf("%v", jobId), -1) - defaultReturn := new(Asyncquerystatus) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'jobId' is set - if &jobId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'jobId' when calling AnalyticsApi->GetAnalyticsConversationsDetailsJob") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Asyncquerystatus - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAnalyticsConversationsDetailsJobResults invokes GET /api/v2/analytics/conversations/details/jobs/{jobId}/results -// -// Fetch a page of results for an async query -// -// -func (a AnalyticsApi) GetAnalyticsConversationsDetailsJobResults(jobId string, cursor string, pageSize int) (*Analyticsconversationasyncqueryresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/conversations/details/jobs/{jobId}/results" - path = strings.Replace(path, "{jobId}", fmt.Sprintf("%v", jobId), -1) - defaultReturn := new(Analyticsconversationasyncqueryresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'jobId' is set - if &jobId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'jobId' when calling AnalyticsApi->GetAnalyticsConversationsDetailsJobResults") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(cursor).(string); ok { - if str != "" { - queryParams["cursor"] = a.Configuration.APIClient.ParameterToString(cursor, collectionFormat) - } - } else { - queryParams["cursor"] = a.Configuration.APIClient.ParameterToString(cursor, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Analyticsconversationasyncqueryresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAnalyticsConversationsDetailsJobsAvailability invokes GET /api/v2/analytics/conversations/details/jobs/availability -// -// Lookup the datalake availability date and time -// -// -func (a AnalyticsApi) GetAnalyticsConversationsDetailsJobsAvailability() (*Dataavailabilityresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/conversations/details/jobs/availability" - defaultReturn := new(Dataavailabilityresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Dataavailabilityresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAnalyticsReportingExports invokes GET /api/v2/analytics/reporting/exports -// -// Get all view export requests for a user -// -// -func (a AnalyticsApi) GetAnalyticsReportingExports(pageNumber int, pageSize int) (*Reportingexportjoblisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/reporting/exports" - defaultReturn := new(Reportingexportjoblisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Reportingexportjoblisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAnalyticsReportingExportsMetadata invokes GET /api/v2/analytics/reporting/exports/metadata -// -// Get all export metadata -// -// -func (a AnalyticsApi) GetAnalyticsReportingExportsMetadata() (*Reportingexportmetadatajoblisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/reporting/exports/metadata" - defaultReturn := new(Reportingexportmetadatajoblisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Reportingexportmetadatajoblisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAnalyticsReportingMetadata invokes GET /api/v2/analytics/reporting/metadata -// -// Get list of reporting metadata. -// -// -func (a AnalyticsApi) GetAnalyticsReportingMetadata(pageNumber int, pageSize int, locale string) (*Reportmetadataentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/reporting/metadata" - defaultReturn := new(Reportmetadataentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(locale).(string); ok { - if str != "" { - queryParams["locale"] = a.Configuration.APIClient.ParameterToString(locale, collectionFormat) - } - } else { - queryParams["locale"] = a.Configuration.APIClient.ParameterToString(locale, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Reportmetadataentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAnalyticsReportingReportIdMetadata invokes GET /api/v2/analytics/reporting/{reportId}/metadata -// -// Get a reporting metadata. -// -// -func (a AnalyticsApi) GetAnalyticsReportingReportIdMetadata(reportId string, locale string) (*Reportmetadata, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/reporting/{reportId}/metadata" - path = strings.Replace(path, "{reportId}", fmt.Sprintf("%v", reportId), -1) - defaultReturn := new(Reportmetadata) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'reportId' is set - if &reportId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'reportId' when calling AnalyticsApi->GetAnalyticsReportingReportIdMetadata") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(locale).(string); ok { - if str != "" { - queryParams["locale"] = a.Configuration.APIClient.ParameterToString(locale, collectionFormat) - } - } else { - queryParams["locale"] = a.Configuration.APIClient.ParameterToString(locale, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Reportmetadata - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAnalyticsReportingReportformats invokes GET /api/v2/analytics/reporting/reportformats -// -// Get a list of report formats -// -// Get a list of report formats. -func (a AnalyticsApi) GetAnalyticsReportingReportformats() ([]string, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/reporting/reportformats" - defaultReturn := make([]string, 0) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload []string - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAnalyticsReportingSchedule invokes GET /api/v2/analytics/reporting/schedules/{scheduleId} -// -// Get a scheduled report job. -// -// -func (a AnalyticsApi) GetAnalyticsReportingSchedule(scheduleId string) (*Reportschedule, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/reporting/schedules/{scheduleId}" - path = strings.Replace(path, "{scheduleId}", fmt.Sprintf("%v", scheduleId), -1) - defaultReturn := new(Reportschedule) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'scheduleId' is set - if &scheduleId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'scheduleId' when calling AnalyticsApi->GetAnalyticsReportingSchedule") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Reportschedule - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAnalyticsReportingScheduleHistory invokes GET /api/v2/analytics/reporting/schedules/{scheduleId}/history -// -// Get list of completed scheduled report jobs. -// -// -func (a AnalyticsApi) GetAnalyticsReportingScheduleHistory(scheduleId string, pageNumber int, pageSize int) (*Reportrunentryentitydomainlisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/reporting/schedules/{scheduleId}/history" - path = strings.Replace(path, "{scheduleId}", fmt.Sprintf("%v", scheduleId), -1) - defaultReturn := new(Reportrunentryentitydomainlisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'scheduleId' is set - if &scheduleId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'scheduleId' when calling AnalyticsApi->GetAnalyticsReportingScheduleHistory") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Reportrunentryentitydomainlisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAnalyticsReportingScheduleHistoryLatest invokes GET /api/v2/analytics/reporting/schedules/{scheduleId}/history/latest -// -// Get most recently completed scheduled report job. -// -// -func (a AnalyticsApi) GetAnalyticsReportingScheduleHistoryLatest(scheduleId string) (*Reportrunentry, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/reporting/schedules/{scheduleId}/history/latest" - path = strings.Replace(path, "{scheduleId}", fmt.Sprintf("%v", scheduleId), -1) - defaultReturn := new(Reportrunentry) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'scheduleId' is set - if &scheduleId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'scheduleId' when calling AnalyticsApi->GetAnalyticsReportingScheduleHistoryLatest") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Reportrunentry - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAnalyticsReportingScheduleHistoryRunId invokes GET /api/v2/analytics/reporting/schedules/{scheduleId}/history/{runId} -// -// A completed scheduled report job -// -// A completed scheduled report job. -func (a AnalyticsApi) GetAnalyticsReportingScheduleHistoryRunId(runId string, scheduleId string) (*Reportrunentry, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/reporting/schedules/{scheduleId}/history/{runId}" - path = strings.Replace(path, "{runId}", fmt.Sprintf("%v", runId), -1) - path = strings.Replace(path, "{scheduleId}", fmt.Sprintf("%v", scheduleId), -1) - defaultReturn := new(Reportrunentry) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'runId' is set - if &runId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'runId' when calling AnalyticsApi->GetAnalyticsReportingScheduleHistoryRunId") - } - // verify the required parameter 'scheduleId' is set - if &scheduleId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'scheduleId' when calling AnalyticsApi->GetAnalyticsReportingScheduleHistoryRunId") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Reportrunentry - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAnalyticsReportingSchedules invokes GET /api/v2/analytics/reporting/schedules -// -// Get a list of scheduled report jobs -// -// Get a list of scheduled report jobs. -func (a AnalyticsApi) GetAnalyticsReportingSchedules(pageNumber int, pageSize int) (*Reportscheduleentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/reporting/schedules" - defaultReturn := new(Reportscheduleentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Reportscheduleentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAnalyticsReportingTimeperiods invokes GET /api/v2/analytics/reporting/timeperiods -// -// Get a list of report time periods. -// -// -func (a AnalyticsApi) GetAnalyticsReportingTimeperiods() ([]string, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/reporting/timeperiods" - defaultReturn := make([]string, 0) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload []string - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAnalyticsUsersDetailsJob invokes GET /api/v2/analytics/users/details/jobs/{jobId} -// -// Get status for async query for user details -// -// -func (a AnalyticsApi) GetAnalyticsUsersDetailsJob(jobId string) (*Asyncquerystatus, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/users/details/jobs/{jobId}" - path = strings.Replace(path, "{jobId}", fmt.Sprintf("%v", jobId), -1) - defaultReturn := new(Asyncquerystatus) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'jobId' is set - if &jobId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'jobId' when calling AnalyticsApi->GetAnalyticsUsersDetailsJob") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Asyncquerystatus - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAnalyticsUsersDetailsJobResults invokes GET /api/v2/analytics/users/details/jobs/{jobId}/results -// -// Fetch a page of results for an async query -// -// -func (a AnalyticsApi) GetAnalyticsUsersDetailsJobResults(jobId string, cursor string, pageSize int) (*Analyticsuserdetailsasyncqueryresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/users/details/jobs/{jobId}/results" - path = strings.Replace(path, "{jobId}", fmt.Sprintf("%v", jobId), -1) - defaultReturn := new(Analyticsuserdetailsasyncqueryresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'jobId' is set - if &jobId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'jobId' when calling AnalyticsApi->GetAnalyticsUsersDetailsJobResults") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(cursor).(string); ok { - if str != "" { - queryParams["cursor"] = a.Configuration.APIClient.ParameterToString(cursor, collectionFormat) - } - } else { - queryParams["cursor"] = a.Configuration.APIClient.ParameterToString(cursor, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Analyticsuserdetailsasyncqueryresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAnalyticsUsersDetailsJobsAvailability invokes GET /api/v2/analytics/users/details/jobs/availability -// -// Lookup the datalake availability date and time -// -// -func (a AnalyticsApi) GetAnalyticsUsersDetailsJobsAvailability() (*Dataavailabilityresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/users/details/jobs/availability" - defaultReturn := new(Dataavailabilityresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Dataavailabilityresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostAnalyticsConversationDetailsProperties invokes POST /api/v2/analytics/conversations/{conversationId}/details/properties -// -// Index conversation properties -// -// -func (a AnalyticsApi) PostAnalyticsConversationDetailsProperties(conversationId string, body Propertyindexrequest) (*Propertyindexrequest, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/conversations/{conversationId}/details/properties" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - defaultReturn := new(Propertyindexrequest) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling AnalyticsApi->PostAnalyticsConversationDetailsProperties") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling AnalyticsApi->PostAnalyticsConversationDetailsProperties") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Propertyindexrequest - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostAnalyticsConversationsAggregatesQuery invokes POST /api/v2/analytics/conversations/aggregates/query -// -// Query for conversation aggregates -// -// -func (a AnalyticsApi) PostAnalyticsConversationsAggregatesQuery(body Conversationaggregationquery) (*Conversationaggregatequeryresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/conversations/aggregates/query" - defaultReturn := new(Conversationaggregatequeryresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling AnalyticsApi->PostAnalyticsConversationsAggregatesQuery") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Conversationaggregatequeryresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostAnalyticsConversationsDetailsJobs invokes POST /api/v2/analytics/conversations/details/jobs -// -// Query for conversation details asynchronously -// -// -func (a AnalyticsApi) PostAnalyticsConversationsDetailsJobs(body Asyncconversationquery) (*Asyncqueryresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/conversations/details/jobs" - defaultReturn := new(Asyncqueryresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling AnalyticsApi->PostAnalyticsConversationsDetailsJobs") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Asyncqueryresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostAnalyticsConversationsDetailsQuery invokes POST /api/v2/analytics/conversations/details/query -// -// Query for conversation details -// -// -func (a AnalyticsApi) PostAnalyticsConversationsDetailsQuery(body Conversationquery) (*Analyticsconversationqueryresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/conversations/details/query" - defaultReturn := new(Analyticsconversationqueryresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling AnalyticsApi->PostAnalyticsConversationsDetailsQuery") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Analyticsconversationqueryresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostAnalyticsConversationsTranscriptsQuery invokes POST /api/v2/analytics/conversations/transcripts/query -// -// Search resources. -// -// -func (a AnalyticsApi) PostAnalyticsConversationsTranscriptsQuery(body Transcriptconversationdetailsearchrequest) (*Analyticsconversationwithoutattributesmultigetresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/conversations/transcripts/query" - defaultReturn := new(Analyticsconversationwithoutattributesmultigetresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling AnalyticsApi->PostAnalyticsConversationsTranscriptsQuery") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Analyticsconversationwithoutattributesmultigetresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostAnalyticsEvaluationsAggregatesQuery invokes POST /api/v2/analytics/evaluations/aggregates/query -// -// Query for evaluation aggregates -// -// -func (a AnalyticsApi) PostAnalyticsEvaluationsAggregatesQuery(body Evaluationaggregationquery) (*Evaluationaggregatequeryresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/evaluations/aggregates/query" - defaultReturn := new(Evaluationaggregatequeryresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling AnalyticsApi->PostAnalyticsEvaluationsAggregatesQuery") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Evaluationaggregatequeryresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostAnalyticsFlowsAggregatesQuery invokes POST /api/v2/analytics/flows/aggregates/query -// -// Query for flow aggregates -// -// -func (a AnalyticsApi) PostAnalyticsFlowsAggregatesQuery(body Flowaggregationquery) (*Flowaggregatequeryresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/flows/aggregates/query" - defaultReturn := new(Flowaggregatequeryresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling AnalyticsApi->PostAnalyticsFlowsAggregatesQuery") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Flowaggregatequeryresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostAnalyticsFlowsObservationsQuery invokes POST /api/v2/analytics/flows/observations/query -// -// Query for flow observations -// -// -func (a AnalyticsApi) PostAnalyticsFlowsObservationsQuery(body Flowobservationquery) (*Flowobservationqueryresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/flows/observations/query" - defaultReturn := new(Flowobservationqueryresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling AnalyticsApi->PostAnalyticsFlowsObservationsQuery") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Flowobservationqueryresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostAnalyticsJourneysAggregatesQuery invokes POST /api/v2/analytics/journeys/aggregates/query -// -// Query for journey aggregates -// -// -func (a AnalyticsApi) PostAnalyticsJourneysAggregatesQuery(body Journeyaggregationquery) (*Journeyaggregatequeryresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/journeys/aggregates/query" - defaultReturn := new(Journeyaggregatequeryresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling AnalyticsApi->PostAnalyticsJourneysAggregatesQuery") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Journeyaggregatequeryresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostAnalyticsQueuesObservationsQuery invokes POST /api/v2/analytics/queues/observations/query -// -// Query for queue observations -// -// -func (a AnalyticsApi) PostAnalyticsQueuesObservationsQuery(body Queueobservationquery) (*Queueobservationqueryresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/queues/observations/query" - defaultReturn := new(Queueobservationqueryresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling AnalyticsApi->PostAnalyticsQueuesObservationsQuery") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Queueobservationqueryresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostAnalyticsReportingExports invokes POST /api/v2/analytics/reporting/exports -// -// Generate a view export request -// -// This API creates a reporting export but the desired way to export analytics data is to use the analytics query APIs instead -func (a AnalyticsApi) PostAnalyticsReportingExports(body Reportingexportjobrequest) (*Reportingexportjobresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/reporting/exports" - defaultReturn := new(Reportingexportjobresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling AnalyticsApi->PostAnalyticsReportingExports") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Reportingexportjobresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostAnalyticsReportingScheduleRunreport invokes POST /api/v2/analytics/reporting/schedules/{scheduleId}/runreport -// -// Place a scheduled report immediately into the reporting queue -// -// -func (a AnalyticsApi) PostAnalyticsReportingScheduleRunreport(scheduleId string) (*Runnowresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/reporting/schedules/{scheduleId}/runreport" - path = strings.Replace(path, "{scheduleId}", fmt.Sprintf("%v", scheduleId), -1) - defaultReturn := new(Runnowresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'scheduleId' is set - if &scheduleId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'scheduleId' when calling AnalyticsApi->PostAnalyticsReportingScheduleRunreport") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Runnowresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostAnalyticsReportingSchedules invokes POST /api/v2/analytics/reporting/schedules -// -// Create a scheduled report job -// -// Create a scheduled report job. -func (a AnalyticsApi) PostAnalyticsReportingSchedules(body Reportschedule) (*Reportschedule, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/reporting/schedules" - defaultReturn := new(Reportschedule) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling AnalyticsApi->PostAnalyticsReportingSchedules") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Reportschedule - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostAnalyticsSurveysAggregatesQuery invokes POST /api/v2/analytics/surveys/aggregates/query -// -// Query for survey aggregates -// -// -func (a AnalyticsApi) PostAnalyticsSurveysAggregatesQuery(body Surveyaggregationquery) (*Surveyaggregatequeryresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/surveys/aggregates/query" - defaultReturn := new(Surveyaggregatequeryresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling AnalyticsApi->PostAnalyticsSurveysAggregatesQuery") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Surveyaggregatequeryresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostAnalyticsTranscriptsAggregatesQuery invokes POST /api/v2/analytics/transcripts/aggregates/query -// -// Query for transcript aggregates -// -// -func (a AnalyticsApi) PostAnalyticsTranscriptsAggregatesQuery(body Transcriptaggregationquery) (*Transcriptaggregatequeryresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/transcripts/aggregates/query" - defaultReturn := new(Transcriptaggregatequeryresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling AnalyticsApi->PostAnalyticsTranscriptsAggregatesQuery") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Transcriptaggregatequeryresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostAnalyticsUsersAggregatesQuery invokes POST /api/v2/analytics/users/aggregates/query -// -// Query for user aggregates -// -// -func (a AnalyticsApi) PostAnalyticsUsersAggregatesQuery(body Useraggregationquery) (*Useraggregatequeryresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/users/aggregates/query" - defaultReturn := new(Useraggregatequeryresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling AnalyticsApi->PostAnalyticsUsersAggregatesQuery") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Useraggregatequeryresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostAnalyticsUsersDetailsJobs invokes POST /api/v2/analytics/users/details/jobs -// -// Query for user details asynchronously -// -// -func (a AnalyticsApi) PostAnalyticsUsersDetailsJobs(body Asyncuserdetailsquery) (*Asyncqueryresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/users/details/jobs" - defaultReturn := new(Asyncqueryresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling AnalyticsApi->PostAnalyticsUsersDetailsJobs") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Asyncqueryresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostAnalyticsUsersDetailsQuery invokes POST /api/v2/analytics/users/details/query -// -// Query for user details -// -// -func (a AnalyticsApi) PostAnalyticsUsersDetailsQuery(body Userdetailsquery) (*Analyticsuserdetailsqueryresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/users/details/query" - defaultReturn := new(Analyticsuserdetailsqueryresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling AnalyticsApi->PostAnalyticsUsersDetailsQuery") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Analyticsuserdetailsqueryresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostAnalyticsUsersObservationsQuery invokes POST /api/v2/analytics/users/observations/query -// -// Query for user observations -// -// -func (a AnalyticsApi) PostAnalyticsUsersObservationsQuery(body Userobservationquery) (*Userobservationqueryresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/users/observations/query" - defaultReturn := new(Userobservationqueryresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling AnalyticsApi->PostAnalyticsUsersObservationsQuery") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Userobservationqueryresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutAnalyticsReportingSchedule invokes PUT /api/v2/analytics/reporting/schedules/{scheduleId} -// -// Update a scheduled report job. -// -// -func (a AnalyticsApi) PutAnalyticsReportingSchedule(scheduleId string, body Reportschedule) (*Reportschedule, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/reporting/schedules/{scheduleId}" - path = strings.Replace(path, "{scheduleId}", fmt.Sprintf("%v", scheduleId), -1) - defaultReturn := new(Reportschedule) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'scheduleId' is set - if &scheduleId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'scheduleId' when calling AnalyticsApi->PutAnalyticsReportingSchedule") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling AnalyticsApi->PutAnalyticsReportingSchedule") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Reportschedule - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/analyticsconversation.go b/build/platformclientv2/analyticsconversation.go deleted file mode 100644 index 5214cbe3d..000000000 --- a/build/platformclientv2/analyticsconversation.go +++ /dev/null @@ -1,58 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Analyticsconversation -type Analyticsconversation struct { - // ConversationId - Unique identifier for the conversation - ConversationId *string `json:"conversationId,omitempty"` - - - // ConversationStart - Date/time the conversation started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ConversationStart *time.Time `json:"conversationStart,omitempty"` - - - // ConversationEnd - Date/time the conversation ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ConversationEnd *time.Time `json:"conversationEnd,omitempty"` - - - // MediaStatsMinConversationMos - The lowest estimated average MOS among all the audio streams belonging to this conversation - MediaStatsMinConversationMos *float64 `json:"mediaStatsMinConversationMos,omitempty"` - - - // MediaStatsMinConversationRFactor - The lowest R-factor value among all of the audio streams belonging to this conversation - MediaStatsMinConversationRFactor *float64 `json:"mediaStatsMinConversationRFactor,omitempty"` - - - // OriginatingDirection - The original direction of the conversation - OriginatingDirection *string `json:"originatingDirection,omitempty"` - - - // Evaluations - Evaluations tied to this conversation - Evaluations *[]Analyticsevaluation `json:"evaluations,omitempty"` - - - // Surveys - Surveys tied to this conversation - Surveys *[]Analyticssurvey `json:"surveys,omitempty"` - - - // Resolutions - Resolutions tied to this conversation - Resolutions *[]Analyticsresolution `json:"resolutions,omitempty"` - - - // DivisionIds - Identifiers of divisions associated with this conversation - DivisionIds *[]string `json:"divisionIds,omitempty"` - - - // Participants - Participants in the conversation - Participants *[]Analyticsparticipant `json:"participants,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Analyticsconversation) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/analyticsconversationasyncqueryresponse.go b/build/platformclientv2/analyticsconversationasyncqueryresponse.go deleted file mode 100644 index efd4103e8..000000000 --- a/build/platformclientv2/analyticsconversationasyncqueryresponse.go +++ /dev/null @@ -1,26 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Analyticsconversationasyncqueryresponse -type Analyticsconversationasyncqueryresponse struct { - // Cursor - Optional cursor to indicate where to resume the results - Cursor *string `json:"cursor,omitempty"` - - - // DataAvailabilityDate - Data available up to at least this datetime. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DataAvailabilityDate *time.Time `json:"dataAvailabilityDate,omitempty"` - - - // Conversations - Conversations *[]Analyticsconversation `json:"conversations,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Analyticsconversationasyncqueryresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/analyticsconversationqueryresponse.go b/build/platformclientv2/analyticsconversationqueryresponse.go deleted file mode 100644 index d3bc6a17f..000000000 --- a/build/platformclientv2/analyticsconversationqueryresponse.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Analyticsconversationqueryresponse -type Analyticsconversationqueryresponse struct { - // Aggregations - Aggregations *[]Aggregationresult `json:"aggregations,omitempty"` - - - // Conversations - Conversations *[]Analyticsconversationwithoutattributes `json:"conversations,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Analyticsconversationqueryresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/analyticsconversationsegment.go b/build/platformclientv2/analyticsconversationsegment.go deleted file mode 100644 index a5b87deac..000000000 --- a/build/platformclientv2/analyticsconversationsegment.go +++ /dev/null @@ -1,114 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Analyticsconversationsegment -type Analyticsconversationsegment struct { - // SegmentStart - The timestamp when this segment began. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - SegmentStart *time.Time `json:"segmentStart,omitempty"` - - - // SegmentEnd - The timestamp when this segment ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - SegmentEnd *time.Time `json:"segmentEnd,omitempty"` - - - // QueueId - Queue identifier - QueueId *string `json:"queueId,omitempty"` - - - // WrapUpCode - Wrapup Code id - WrapUpCode *string `json:"wrapUpCode,omitempty"` - - - // WrapUpNote - Note entered by an agent during after-call work - WrapUpNote *string `json:"wrapUpNote,omitempty"` - - - // WrapUpTags - WrapUpTags *[]string `json:"wrapUpTags,omitempty"` - - - // ErrorCode - ErrorCode *string `json:"errorCode,omitempty"` - - - // DisconnectType - A description of the event that disconnected the segment - DisconnectType *string `json:"disconnectType,omitempty"` - - - // SegmentType - The activity taking place for the participant in the segment - SegmentType *string `json:"segmentType,omitempty"` - - - // RequestedRoutingUserIds - RequestedRoutingUserIds *[]string `json:"requestedRoutingUserIds,omitempty"` - - - // RequestedRoutingSkillIds - RequestedRoutingSkillIds *[]string `json:"requestedRoutingSkillIds,omitempty"` - - - // RequestedLanguageId - A unique identifier for the language requested for an interaction. - RequestedLanguageId *string `json:"requestedLanguageId,omitempty"` - - - // ScoredAgents - ScoredAgents *[]Analyticsscoredagent `json:"scoredAgents,omitempty"` - - - // Properties - Properties *[]Analyticsproperty `json:"properties,omitempty"` - - - // SourceConversationId - SourceConversationId *string `json:"sourceConversationId,omitempty"` - - - // DestinationConversationId - DestinationConversationId *string `json:"destinationConversationId,omitempty"` - - - // SourceSessionId - SourceSessionId *string `json:"sourceSessionId,omitempty"` - - - // DestinationSessionId - DestinationSessionId *string `json:"destinationSessionId,omitempty"` - - - // SipResponseCodes - SipResponseCodes *[]int `json:"sipResponseCodes,omitempty"` - - - // Q850ResponseCodes - Q850ResponseCodes *[]int `json:"q850ResponseCodes,omitempty"` - - - // Conference - Indicates whether the segment was a conference - Conference *bool `json:"conference,omitempty"` - - - // GroupId - GroupId *string `json:"groupId,omitempty"` - - - // Subject - Subject *string `json:"subject,omitempty"` - - - // AudioMuted - AudioMuted *bool `json:"audioMuted,omitempty"` - - - // VideoMuted - VideoMuted *bool `json:"videoMuted,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Analyticsconversationsegment) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/analyticsconversationwithoutattributes.go b/build/platformclientv2/analyticsconversationwithoutattributes.go deleted file mode 100644 index 3a83d6145..000000000 --- a/build/platformclientv2/analyticsconversationwithoutattributes.go +++ /dev/null @@ -1,58 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Analyticsconversationwithoutattributes -type Analyticsconversationwithoutattributes struct { - // ConversationId - Unique identifier for the conversation - ConversationId *string `json:"conversationId,omitempty"` - - - // ConversationStart - Date/time the conversation started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ConversationStart *time.Time `json:"conversationStart,omitempty"` - - - // ConversationEnd - Date/time the conversation ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ConversationEnd *time.Time `json:"conversationEnd,omitempty"` - - - // MediaStatsMinConversationMos - The lowest estimated average MOS among all the audio streams belonging to this conversation - MediaStatsMinConversationMos *float64 `json:"mediaStatsMinConversationMos,omitempty"` - - - // MediaStatsMinConversationRFactor - The lowest R-factor value among all of the audio streams belonging to this conversation - MediaStatsMinConversationRFactor *float64 `json:"mediaStatsMinConversationRFactor,omitempty"` - - - // OriginatingDirection - The original direction of the conversation - OriginatingDirection *string `json:"originatingDirection,omitempty"` - - - // Evaluations - Evaluations tied to this conversation - Evaluations *[]Analyticsevaluation `json:"evaluations,omitempty"` - - - // Surveys - Surveys tied to this conversation - Surveys *[]Analyticssurvey `json:"surveys,omitempty"` - - - // Resolutions - Resolutions tied to this conversation - Resolutions *[]Analyticsresolution `json:"resolutions,omitempty"` - - - // DivisionIds - Identifiers of divisions associated with this conversation - DivisionIds *[]string `json:"divisionIds,omitempty"` - - - // Participants - Participants in the conversation - Participants *[]Analyticsparticipantwithoutattributes `json:"participants,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Analyticsconversationwithoutattributes) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/analyticsconversationwithoutattributesmultigetresponse.go b/build/platformclientv2/analyticsconversationwithoutattributesmultigetresponse.go deleted file mode 100644 index d8eaca973..000000000 --- a/build/platformclientv2/analyticsconversationwithoutattributesmultigetresponse.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Analyticsconversationwithoutattributesmultigetresponse -type Analyticsconversationwithoutattributesmultigetresponse struct { - // Conversations - Conversations *[]Analyticsconversationwithoutattributes `json:"conversations,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Analyticsconversationwithoutattributesmultigetresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/analyticsevaluation.go b/build/platformclientv2/analyticsevaluation.go deleted file mode 100644 index 39452ff15..000000000 --- a/build/platformclientv2/analyticsevaluation.go +++ /dev/null @@ -1,66 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Analyticsevaluation -type Analyticsevaluation struct { - // EvaluationId - Unique identifier for the evaluation - EvaluationId *string `json:"evaluationId,omitempty"` - - - // EvaluatorId - A unique identifier of the PureCloud user who evaluated the interaction - EvaluatorId *string `json:"evaluatorId,omitempty"` - - - // UserId - Unique identifier for the user being evaluated - UserId *string `json:"userId,omitempty"` - - - // EventTime - Specifies when an evaluation occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - EventTime *time.Time `json:"eventTime,omitempty"` - - - // QueueId - Unique identifier for the queue the conversation was on - QueueId *string `json:"queueId,omitempty"` - - - // FormId - Unique identifier for the form used to evaluate the conversation/agent - FormId *string `json:"formId,omitempty"` - - - // ContextId - A unique identifier for an evaluation form, regardless of version - ContextId *string `json:"contextId,omitempty"` - - - // FormName - Name of the evaluation form - FormName *string `json:"formName,omitempty"` - - - // CalibrationId - The calibration id used for the purpose of training evaluators - CalibrationId *string `json:"calibrationId,omitempty"` - - - // Rescored - Whether this evaluation has ever been rescored - Rescored *bool `json:"rescored,omitempty"` - - - // Deleted - Whether this evaluation has been deleted - Deleted *bool `json:"deleted,omitempty"` - - - // OTotalScore - OTotalScore *int `json:"oTotalScore,omitempty"` - - - // OTotalCriticalScore - OTotalCriticalScore *int `json:"oTotalCriticalScore,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Analyticsevaluation) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/analyticsflow.go b/build/platformclientv2/analyticsflow.go deleted file mode 100644 index 512d21ba2..000000000 --- a/build/platformclientv2/analyticsflow.go +++ /dev/null @@ -1,69 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Analyticsflow -type Analyticsflow struct { - // FlowId - The unique identifier of this flow - FlowId *string `json:"flowId,omitempty"` - - - // FlowName - The name of this flow - FlowName *string `json:"flowName,omitempty"` - - - // FlowVersion - The version of this flow - FlowVersion *string `json:"flowVersion,omitempty"` - - - // FlowType - The type of this flow - FlowType *string `json:"flowType,omitempty"` - - - // ExitReason - The exit reason for this flow, e.g. DISCONNECT - ExitReason *string `json:"exitReason,omitempty"` - - - // EntryReason - The particular entry reason for this flow, e.g. an address, userId, or flowId - EntryReason *string `json:"entryReason,omitempty"` - - - // EntryType - The entry type for this flow - EntryType *string `json:"entryType,omitempty"` - - - // TransferType - The type of transfer for flows that ended with a transfer - TransferType *string `json:"transferType,omitempty"` - - - // TransferTargetName - The name of a transfer target - TransferTargetName *string `json:"transferTargetName,omitempty"` - - - // TransferTargetAddress - The address of a transfer target - TransferTargetAddress *string `json:"transferTargetAddress,omitempty"` - - - // IssuedCallback - Flag indicating whether the flow issued a callback - IssuedCallback *bool `json:"issuedCallback,omitempty"` - - - // StartingLanguage - Flow starting language, e.g. en-us - StartingLanguage *string `json:"startingLanguage,omitempty"` - - - // EndingLanguage - Flow ending language, e.g. en-us - EndingLanguage *string `json:"endingLanguage,omitempty"` - - - // Outcomes - Flow outcomes - Outcomes *[]Analyticsflowoutcome `json:"outcomes,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Analyticsflow) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/analyticsflowoutcome.go b/build/platformclientv2/analyticsflowoutcome.go deleted file mode 100644 index ccb6ab4b6..000000000 --- a/build/platformclientv2/analyticsflowoutcome.go +++ /dev/null @@ -1,34 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Analyticsflowoutcome -type Analyticsflowoutcome struct { - // FlowOutcomeId - Unique identifiers of a flow outcome - FlowOutcomeId *string `json:"flowOutcomeId,omitempty"` - - - // FlowOutcomeValue - Flow outcome value, e.g. SUCCESS - FlowOutcomeValue *string `json:"flowOutcomeValue,omitempty"` - - - // FlowOutcome - Colon-separated combinations of unique flow outcome identifier and value - FlowOutcome *string `json:"flowOutcome,omitempty"` - - - // FlowOutcomeStartTimestamp - Date/time the outcome started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - FlowOutcomeStartTimestamp *time.Time `json:"flowOutcomeStartTimestamp,omitempty"` - - - // FlowOutcomeEndTimestamp - Date/time the outcome ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - FlowOutcomeEndTimestamp *time.Time `json:"flowOutcomeEndTimestamp,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Analyticsflowoutcome) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/analyticsmediaendpointstat.go b/build/platformclientv2/analyticsmediaendpointstat.go deleted file mode 100644 index f560e6c6b..000000000 --- a/build/platformclientv2/analyticsmediaendpointstat.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Analyticsmediaendpointstat -type Analyticsmediaendpointstat struct { - // Codecs - The MIME types of the audio encodings used by the audio streams belonging to this endpoint - Codecs *[]string `json:"codecs,omitempty"` - - - // MinMos - The lowest estimated average MOS among all the audio streams belonging to this endpoint - MinMos *float64 `json:"minMos,omitempty"` - - - // MinRFactor - The lowest R-factor value among all of the audio streams belonging to this endpoint - MinRFactor *float64 `json:"minRFactor,omitempty"` - - - // MaxLatencyMs - The maximum latency experienced by any audio stream belonging to this endpoint, in milliseconds - MaxLatencyMs *int `json:"maxLatencyMs,omitempty"` - - - // ReceivedPackets - The total number of packets received for all audio streams belonging to this endpoint (includes invalid, duplicate, and discarded packets) - ReceivedPackets *int `json:"receivedPackets,omitempty"` - - - // InvalidPackets - The total number of malformed or not RTP packets, unknown payload type, or discarded probation packets for all audio streams belonging to this endpoint - InvalidPackets *int `json:"invalidPackets,omitempty"` - - - // DiscardedPackets - The total number of packets received too late or too early, jitter queue overrun or underrun, for all audio streams belonging to this endpoint - DiscardedPackets *int `json:"discardedPackets,omitempty"` - - - // DuplicatePackets - The total number of packets received with the same sequence number as another one recently received (window of 64 packets), for all audio streams belonging to this endpoint - DuplicatePackets *int `json:"duplicatePackets,omitempty"` - - - // OverrunPackets - The total number of packets for which there was no room in the jitter queue when it was received, for all audio streams belonging to this endpoint (also counted in discarded) - OverrunPackets *int `json:"overrunPackets,omitempty"` - - - // UnderrunPackets - The total number of packets received after their timestamp/seqnum has been played out, for all audio streams belonging to this endpoint (also counted in discarded) - UnderrunPackets *int `json:"underrunPackets,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Analyticsmediaendpointstat) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/analyticsparticipant.go b/build/platformclientv2/analyticsparticipant.go deleted file mode 100644 index 7685284bf..000000000 --- a/build/platformclientv2/analyticsparticipant.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Analyticsparticipant -type Analyticsparticipant struct { - // ParticipantId - Unique identifier for the participant - ParticipantId *string `json:"participantId,omitempty"` - - - // ParticipantName - A human readable name identifying the participant - ParticipantName *string `json:"participantName,omitempty"` - - - // UserId - If a user, then this will be the unique identifier for the user - UserId *string `json:"userId,omitempty"` - - - // Purpose - The participant's purpose - Purpose *string `json:"purpose,omitempty"` - - - // ExternalContactId - External Contact Identifier - ExternalContactId *string `json:"externalContactId,omitempty"` - - - // ExternalOrganizationId - External Organization Identifier - ExternalOrganizationId *string `json:"externalOrganizationId,omitempty"` - - - // FlaggedReason - Reason for which participant flagged conversation - FlaggedReason *string `json:"flaggedReason,omitempty"` - - - // TeamId - The team id the user is a member of - TeamId *string `json:"teamId,omitempty"` - - - // Sessions - List of sessions associated to this participant - Sessions *[]Analyticssession `json:"sessions,omitempty"` - - - // Attributes - List of attributes associated to this participant - Attributes *map[string]string `json:"attributes,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Analyticsparticipant) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/analyticsparticipantwithoutattributes.go b/build/platformclientv2/analyticsparticipantwithoutattributes.go deleted file mode 100644 index 6982d525f..000000000 --- a/build/platformclientv2/analyticsparticipantwithoutattributes.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Analyticsparticipantwithoutattributes -type Analyticsparticipantwithoutattributes struct { - // ParticipantId - Unique identifier for the participant - ParticipantId *string `json:"participantId,omitempty"` - - - // ParticipantName - A human readable name identifying the participant - ParticipantName *string `json:"participantName,omitempty"` - - - // UserId - If a user, then this will be the unique identifier for the user - UserId *string `json:"userId,omitempty"` - - - // Purpose - The participant's purpose - Purpose *string `json:"purpose,omitempty"` - - - // ExternalContactId - External Contact Identifier - ExternalContactId *string `json:"externalContactId,omitempty"` - - - // ExternalOrganizationId - External Organization Identifier - ExternalOrganizationId *string `json:"externalOrganizationId,omitempty"` - - - // FlaggedReason - Reason for which participant flagged conversation - FlaggedReason *string `json:"flaggedReason,omitempty"` - - - // TeamId - The team id the user is a member of - TeamId *string `json:"teamId,omitempty"` - - - // Sessions - List of sessions associated to this participant - Sessions *[]Analyticssession `json:"sessions,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Analyticsparticipantwithoutattributes) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/analyticsproperty.go b/build/platformclientv2/analyticsproperty.go deleted file mode 100644 index 142777880..000000000 --- a/build/platformclientv2/analyticsproperty.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Analyticsproperty -type Analyticsproperty struct { - // PropertyType - Indicates what the data type is (e.g. integer vs string) and therefore how to evaluate what would constitute a match - PropertyType *string `json:"propertyType,omitempty"` - - - // Property - User-defined rather than intrinsic system-observed values. These are tagged onto segments by other components within PureCloud or by API users directly. This is the name of the user-defined property. - Property *string `json:"property,omitempty"` - - - // Value - What property value to match against - Value *string `json:"value,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Analyticsproperty) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/analyticsproposedagent.go b/build/platformclientv2/analyticsproposedagent.go deleted file mode 100644 index 27c6d3d54..000000000 --- a/build/platformclientv2/analyticsproposedagent.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Analyticsproposedagent -type Analyticsproposedagent struct { - // ProposedAgentId - Unique identifier of an agent that was proposed by predictive routing - ProposedAgentId *string `json:"proposedAgentId,omitempty"` - - - // AgentRank - Proposed agent rank for this conversation from predictive routing (lower is better) - AgentRank *int `json:"agentRank,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Analyticsproposedagent) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/analyticsqueryaggregation.go b/build/platformclientv2/analyticsqueryaggregation.go deleted file mode 100644 index 07e0b5421..000000000 --- a/build/platformclientv2/analyticsqueryaggregation.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Analyticsqueryaggregation -type Analyticsqueryaggregation struct { - // VarType - Optional type, can usually be inferred - VarType *string `json:"type,omitempty"` - - - // Dimension - For use with termFrequency aggregations - Dimension *string `json:"dimension,omitempty"` - - - // Metric - For use with numericRange aggregations - Metric *string `json:"metric,omitempty"` - - - // Size - For use with termFrequency aggregations - Size *int `json:"size,omitempty"` - - - // Ranges - For use with numericRange aggregations - Ranges *[]Aggregationrange `json:"ranges,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Analyticsqueryaggregation) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/analyticsresolution.go b/build/platformclientv2/analyticsresolution.go deleted file mode 100644 index cb49e5645..000000000 --- a/build/platformclientv2/analyticsresolution.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Analyticsresolution -type Analyticsresolution struct { - // QueueId - The ID of the last queue on which the conversation was handled. - QueueId *string `json:"queueId,omitempty"` - - - // UserId - The ID of the last user who handled the conversation. - UserId *string `json:"userId,omitempty"` - - - // GetnNextContactAvoided - The number of interactions for which next contact was avoided. - GetnNextContactAvoided *int `json:"getnNextContactAvoided,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Analyticsresolution) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/analyticsroutingstatusrecord.go b/build/platformclientv2/analyticsroutingstatusrecord.go deleted file mode 100644 index 0f581db98..000000000 --- a/build/platformclientv2/analyticsroutingstatusrecord.go +++ /dev/null @@ -1,26 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Analyticsroutingstatusrecord -type Analyticsroutingstatusrecord struct { - // StartTime - The start time of the record. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartTime *time.Time `json:"startTime,omitempty"` - - - // EndTime - The end time of the record. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - EndTime *time.Time `json:"endTime,omitempty"` - - - // RoutingStatus - The user's ACD routing status - RoutingStatus *string `json:"routingStatus,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Analyticsroutingstatusrecord) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/analyticsscoredagent.go b/build/platformclientv2/analyticsscoredagent.go deleted file mode 100644 index 7bd690cd4..000000000 --- a/build/platformclientv2/analyticsscoredagent.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Analyticsscoredagent -type Analyticsscoredagent struct { - // ScoredAgentId - Unique identifier of an agent that was scored for this conversation - ScoredAgentId *string `json:"scoredAgentId,omitempty"` - - - // AgentScore - Assigned agent score for this conversation (0 - 100, higher being better) - AgentScore *int `json:"agentScore,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Analyticsscoredagent) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/analyticssession.go b/build/platformclientv2/analyticssession.go deleted file mode 100644 index e9e27e62c..000000000 --- a/build/platformclientv2/analyticssession.go +++ /dev/null @@ -1,262 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Analyticssession -type Analyticssession struct { - // MediaType - The session media type - MediaType *string `json:"mediaType,omitempty"` - - - // SessionId - The unique identifier of this session - SessionId *string `json:"sessionId,omitempty"` - - - // AddressOther - AddressOther *string `json:"addressOther,omitempty"` - - - // AddressSelf - AddressSelf *string `json:"addressSelf,omitempty"` - - - // AddressFrom - AddressFrom *string `json:"addressFrom,omitempty"` - - - // AddressTo - AddressTo *string `json:"addressTo,omitempty"` - - - // MessageType - Message type for messaging services such as sms - MessageType *string `json:"messageType,omitempty"` - - - // Ani - Automatic Number Identification (caller's number) - Ani *string `json:"ani,omitempty"` - - - // Direction - Direction - Direction *string `json:"direction,omitempty"` - - - // Dnis - Dialed number identification service (number dialed by the calling party) - Dnis *string `json:"dnis,omitempty"` - - - // SessionDnis - Dialed number for the current session; this can be different from dnis, e.g. if the call was transferred - SessionDnis *string `json:"sessionDnis,omitempty"` - - - // OutboundCampaignId - (Dialer) Unique identifier of the outbound campaign - OutboundCampaignId *string `json:"outboundCampaignId,omitempty"` - - - // OutboundContactId - (Dialer) Unique identifier of the contact - OutboundContactId *string `json:"outboundContactId,omitempty"` - - - // OutboundContactListId - (Dialer) Unique identifier of the contact list that this contact belongs to - OutboundContactListId *string `json:"outboundContactListId,omitempty"` - - - // DispositionAnalyzer - (Dialer) Unique identifier of the contact list that this contact belongs to - DispositionAnalyzer *string `json:"dispositionAnalyzer,omitempty"` - - - // DispositionName - (Dialer) Result of the analysis - DispositionName *string `json:"dispositionName,omitempty"` - - - // EdgeId - Unique identifier of the edge device - EdgeId *string `json:"edgeId,omitempty"` - - - // RemoteNameDisplayable - RemoteNameDisplayable *string `json:"remoteNameDisplayable,omitempty"` - - - // RoomId - Unique identifier for the room - RoomId *string `json:"roomId,omitempty"` - - - // MonitoredSessionId - The sessionID being monitored - MonitoredSessionId *string `json:"monitoredSessionId,omitempty"` - - - // MonitoredParticipantId - MonitoredParticipantId *string `json:"monitoredParticipantId,omitempty"` - - - // CallbackUserName - The name of the user requesting a call back - CallbackUserName *string `json:"callbackUserName,omitempty"` - - - // CallbackNumbers - List of numbers to callback - CallbackNumbers *[]string `json:"callbackNumbers,omitempty"` - - - // CallbackScheduledTime - Scheduled callback date/time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - CallbackScheduledTime *time.Time `json:"callbackScheduledTime,omitempty"` - - - // ScriptId - A unique identifier for a script - ScriptId *string `json:"scriptId,omitempty"` - - - // PeerId - A unique identifier for a peer - PeerId *string `json:"peerId,omitempty"` - - - // SkipEnabled - (Dialer) Whether the agent can skip the dialer contact - SkipEnabled *bool `json:"skipEnabled,omitempty"` - - - // TimeoutSeconds - The number of seconds before PureCloud begins the call for a call back. 0 disables automatic calling - TimeoutSeconds *int `json:"timeoutSeconds,omitempty"` - - - // CobrowseRole - Describe side of the cobrowse (sharer or viewer) - CobrowseRole *string `json:"cobrowseRole,omitempty"` - - - // CobrowseRoomId - A unique identifier for a PureCloud Cobrowse room. - CobrowseRoomId *string `json:"cobrowseRoomId,omitempty"` - - - // MediaBridgeId - MediaBridgeId *string `json:"mediaBridgeId,omitempty"` - - - // ScreenShareAddressSelf - Direct ScreenShare address - ScreenShareAddressSelf *string `json:"screenShareAddressSelf,omitempty"` - - - // SharingScreen - Flag determining if screenShare is started or not (true/false) - SharingScreen *bool `json:"sharingScreen,omitempty"` - - - // ScreenShareRoomId - A unique identifier for a PureCloud ScreenShare room. - ScreenShareRoomId *string `json:"screenShareRoomId,omitempty"` - - - // VideoRoomId - A unique identifier for a PureCloud video room. - VideoRoomId *string `json:"videoRoomId,omitempty"` - - - // VideoAddressSelf - Direct Video address - VideoAddressSelf *string `json:"videoAddressSelf,omitempty"` - - - // Segments - List of segments for this session - Segments *[]Analyticsconversationsegment `json:"segments,omitempty"` - - - // Metrics - List of metrics for this session - Metrics *[]Analyticssessionmetric `json:"metrics,omitempty"` - - - // Flow - IVR flow execution associated with this session - Flow *Analyticsflow `json:"flow,omitempty"` - - - // MediaEndpointStats - Media endpoint stats associated with this session - MediaEndpointStats *[]Analyticsmediaendpointstat `json:"mediaEndpointStats,omitempty"` - - - // Recording - Flag determining if an audio recording was started or not - Recording *bool `json:"recording,omitempty"` - - - // JourneyCustomerId - ID of the journey customer - JourneyCustomerId *string `json:"journeyCustomerId,omitempty"` - - - // JourneyCustomerIdType - Type of the journey customer ID - JourneyCustomerIdType *string `json:"journeyCustomerIdType,omitempty"` - - - // JourneyCustomerSessionId - ID of the journey customer session - JourneyCustomerSessionId *string `json:"journeyCustomerSessionId,omitempty"` - - - // JourneyCustomerSessionIdType - Type of the journey customer session ID - JourneyCustomerSessionIdType *string `json:"journeyCustomerSessionIdType,omitempty"` - - - // JourneyActionId - Journey action ID - JourneyActionId *string `json:"journeyActionId,omitempty"` - - - // JourneyActionMapId - Journey action map ID - JourneyActionMapId *string `json:"journeyActionMapId,omitempty"` - - - // JourneyActionMapVersion - Journey action map version - JourneyActionMapVersion *string `json:"journeyActionMapVersion,omitempty"` - - - // ProtocolCallId - The original voice protocol call ID, e.g. a SIP call ID - ProtocolCallId *string `json:"protocolCallId,omitempty"` - - - // Provider - The source provider for the communication - Provider *string `json:"provider,omitempty"` - - - // Remote - Name, phone number, or email address of the remote party. - Remote *string `json:"remote,omitempty"` - - - // MediaCount - Count of any media (images, files, etc) included in this session - MediaCount *int `json:"mediaCount,omitempty"` - - - // FlowInType - Type of flow in that occurred, e.g. acd, ivr, etc. - FlowInType *string `json:"flowInType,omitempty"` - - - // FlowOutType - Type of flow out that occurred, e.g. voicemail, callback, or acd - FlowOutType *string `json:"flowOutType,omitempty"` - - - // RequestedRoutings - All routing types for requested/attempted routing methods. - RequestedRoutings *[]string `json:"requestedRoutings,omitempty"` - - - // UsedRouting - Complete routing method - UsedRouting *string `json:"usedRouting,omitempty"` - - - // SelectedAgentId - Selected agent id - SelectedAgentId *string `json:"selectedAgentId,omitempty"` - - - // SelectedAgentRank - Selected agent GPR rank - SelectedAgentRank *int `json:"selectedAgentRank,omitempty"` - - - // AgentAssistantId - Unique identifier of the active virtual agent assistant - AgentAssistantId *string `json:"agentAssistantId,omitempty"` - - - // ProposedAgents - Proposed agents - ProposedAgents *[]Analyticsproposedagent `json:"proposedAgents,omitempty"` - - - // AssignerId - ID of the user that manually assigned a conversation - AssignerId *string `json:"assignerId,omitempty"` - - - // AcwSkipped - Marker for an agent that skipped after call work - AcwSkipped *bool `json:"acwSkipped,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Analyticssession) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/analyticssessionmetric.go b/build/platformclientv2/analyticssessionmetric.go deleted file mode 100644 index 76225187d..000000000 --- a/build/platformclientv2/analyticssessionmetric.go +++ /dev/null @@ -1,26 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Analyticssessionmetric -type Analyticssessionmetric struct { - // Name - Unique name of this metric - Name *string `json:"name,omitempty"` - - - // Value - The metric value - Value *int `json:"value,omitempty"` - - - // EmitDate - Metric emission date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - EmitDate *time.Time `json:"emitDate,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Analyticssessionmetric) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/analyticssurvey.go b/build/platformclientv2/analyticssurvey.go deleted file mode 100644 index 83632e964..000000000 --- a/build/platformclientv2/analyticssurvey.go +++ /dev/null @@ -1,58 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Analyticssurvey -type Analyticssurvey struct { - // SurveyId - Unique identifier for the survey - SurveyId *string `json:"surveyId,omitempty"` - - - // SurveyFormId - Unique identifier for the survey form - SurveyFormId *string `json:"surveyFormId,omitempty"` - - - // SurveyFormName - Name of the survey form - SurveyFormName *string `json:"surveyFormName,omitempty"` - - - // SurveyFormContextId - Unique identifier for the survey form, regardless of version - SurveyFormContextId *string `json:"surveyFormContextId,omitempty"` - - - // EventTime - Specifies when a survey occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - EventTime *time.Time `json:"eventTime,omitempty"` - - - // UserId - A unique identifier of the PureCloud user - UserId *string `json:"userId,omitempty"` - - - // QueueId - Unique identifier for the queue the conversation was on - QueueId *string `json:"queueId,omitempty"` - - - // SurveyStatus - Survey status - SurveyStatus *string `json:"surveyStatus,omitempty"` - - - // SurveyPromoterScore - Promoter score of the survey - SurveyPromoterScore *int `json:"surveyPromoterScore,omitempty"` - - - // SurveyCompletedDate - Completion date/time of the survey. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - SurveyCompletedDate *time.Time `json:"surveyCompletedDate,omitempty"` - - - // OSurveyTotalScore - OSurveyTotalScore *int `json:"oSurveyTotalScore,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Analyticssurvey) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/analyticsuserdetail.go b/build/platformclientv2/analyticsuserdetail.go deleted file mode 100644 index 146adba08..000000000 --- a/build/platformclientv2/analyticsuserdetail.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Analyticsuserdetail -type Analyticsuserdetail struct { - // UserId - The identifier for the user - UserId *string `json:"userId,omitempty"` - - - // PrimaryPresence - The presence records for the user - PrimaryPresence *[]Analyticsuserpresencerecord `json:"primaryPresence,omitempty"` - - - // RoutingStatus - The ACD routing status records for the user - RoutingStatus *[]Analyticsroutingstatusrecord `json:"routingStatus,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Analyticsuserdetail) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/analyticsuserdetailsasyncqueryresponse.go b/build/platformclientv2/analyticsuserdetailsasyncqueryresponse.go deleted file mode 100644 index 7602a90d4..000000000 --- a/build/platformclientv2/analyticsuserdetailsasyncqueryresponse.go +++ /dev/null @@ -1,26 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Analyticsuserdetailsasyncqueryresponse -type Analyticsuserdetailsasyncqueryresponse struct { - // UserDetails - UserDetails *[]Analyticsuserdetail `json:"userDetails,omitempty"` - - - // Cursor - Optional cursor to indicate where to resume the results - Cursor *string `json:"cursor,omitempty"` - - - // DataAvailabilityDate - Data available up to at least this datetime. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DataAvailabilityDate *time.Time `json:"dataAvailabilityDate,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Analyticsuserdetailsasyncqueryresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/analyticsuserdetailsqueryresponse.go b/build/platformclientv2/analyticsuserdetailsqueryresponse.go deleted file mode 100644 index 950dd5c1d..000000000 --- a/build/platformclientv2/analyticsuserdetailsqueryresponse.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Analyticsuserdetailsqueryresponse -type Analyticsuserdetailsqueryresponse struct { - // UserDetails - UserDetails *[]Analyticsuserdetail `json:"userDetails,omitempty"` - - - // Aggregations - Aggregations *[]Aggregationresult `json:"aggregations,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Analyticsuserdetailsqueryresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/analyticsuserpresencerecord.go b/build/platformclientv2/analyticsuserpresencerecord.go deleted file mode 100644 index c19023766..000000000 --- a/build/platformclientv2/analyticsuserpresencerecord.go +++ /dev/null @@ -1,30 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Analyticsuserpresencerecord -type Analyticsuserpresencerecord struct { - // StartTime - The start time of the record. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartTime *time.Time `json:"startTime,omitempty"` - - - // EndTime - The end time of the record. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - EndTime *time.Time `json:"endTime,omitempty"` - - - // SystemPresence - The user's system presence - SystemPresence *string `json:"systemPresence,omitempty"` - - - // OrganizationPresenceId - The identifier for the user's organization presence - OrganizationPresenceId *string `json:"organizationPresenceId,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Analyticsuserpresencerecord) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/annotation.go b/build/platformclientv2/annotation.go deleted file mode 100644 index fa1f2ca6d..000000000 --- a/build/platformclientv2/annotation.go +++ /dev/null @@ -1,101 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Annotation -type Annotation struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - - - // Location - Offset of annotation in milliseconds. - Location *int `json:"location,omitempty"` - - - // DurationMs - Duration of annotation in milliseconds. - DurationMs *int `json:"durationMs,omitempty"` - - - // AbsoluteLocation - Offset of annotation (milliseconds) from start of recording. - AbsoluteLocation *int `json:"absoluteLocation,omitempty"` - - - // AbsoluteDurationMs - Duration of annotation (milliseconds). - AbsoluteDurationMs *int `json:"absoluteDurationMs,omitempty"` - - - // RecordingLocation - Offset of annotation (milliseconds) from start of recording, adjusted for any recording cuts - RecordingLocation *int `json:"recordingLocation,omitempty"` - - - // RecordingDurationMs - Duration of annotation (milliseconds), adjusted for any recording cuts. - RecordingDurationMs *int `json:"recordingDurationMs,omitempty"` - - - // User - User that created this annotation (if any). - User *User `json:"user,omitempty"` - - - // Description - Text of annotation. - Description *string `json:"description,omitempty"` - - - // KeywordName - The word or phrase which is being looked for with speech recognition. - KeywordName *string `json:"keywordName,omitempty"` - - - // Confidence - Actual confidence that this is an accurate match. - Confidence *float32 `json:"confidence,omitempty"` - - - // KeywordSetId - A unique identifier for the keyword set to which this spotted keyword belongs. - KeywordSetId *string `json:"keywordSetId,omitempty"` - - - // KeywordSetName - The keyword set to which this spotted keyword belongs. - KeywordSetName *string `json:"keywordSetName,omitempty"` - - - // Utterance - The phonetic spellings for the phrase and alternate spellings. - Utterance *string `json:"utterance,omitempty"` - - - // TimeBegin - Beginning time offset of the keyword spot match. - TimeBegin *string `json:"timeBegin,omitempty"` - - - // TimeEnd - Ending time offset of the keyword spot match. - TimeEnd *string `json:"timeEnd,omitempty"` - - - // KeywordConfidenceThreshold - Configured sensitivity threshold that can be increased to lower false positives or decreased to reduce false negatives. - KeywordConfidenceThreshold *string `json:"keywordConfidenceThreshold,omitempty"` - - - // AgentScoreModifier - A modifier to the evaluation score when the phrase is spotted in the agent channel. - AgentScoreModifier *string `json:"agentScoreModifier,omitempty"` - - - // CustomerScoreModifier - A modifier to the evaluation score when the phrase is spotted in the customer channel. - CustomerScoreModifier *string `json:"customerScoreModifier,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Annotation) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/answeroption.go b/build/platformclientv2/answeroption.go deleted file mode 100644 index 37ecffabd..000000000 --- a/build/platformclientv2/answeroption.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Answeroption -type Answeroption struct { - // Id - Id *string `json:"id,omitempty"` - - - // Text - Text *string `json:"text,omitempty"` - - - // Value - Value *int `json:"value,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Answeroption) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/apiclient.go b/build/platformclientv2/apiclient.go deleted file mode 100644 index c68264676..000000000 --- a/build/platformclientv2/apiclient.go +++ /dev/null @@ -1,275 +0,0 @@ -package platformclientv2 - -import ( - "bytes" - "encoding/json" - "fmt" - "io/ioutil" - "net/http" - "net/url" - "reflect" - "strings" - "sync/atomic" - "time" - - "github.com/hashicorp/go-retryablehttp" -) - -// APIClient provides functions for making API requests -type APIClient struct { - client retryablehttp.Client - configuration *Configuration -} - -// NewAPIClient creates a new API client -func NewAPIClient(c *Configuration) APIClient { - timeout, err := time.ParseDuration("16s") - if err != nil { - panic(err) - } - - client := retryablehttp.NewClient() - client.Logger = nil - client.HTTPClient.Timeout = timeout - - return APIClient{ - client: *client, - configuration: c, - } -} - -// SelectHeaderContentType selects the header content type -func (c *APIClient) SelectHeaderContentType(contentTypes []string) string { - if len(contentTypes) == 0 { - return "" - } - if contains(contentTypes, "application/json") { - return "application/json" - } - return contentTypes[0] // use the first content type specified in 'consumes' -} - -// SelectHeaderAccept selects the header accept -func (c *APIClient) SelectHeaderAccept(accepts []string) string { - if len(accepts) == 0 { - return "" - } - if contains(accepts, "application/json") { - return "application/json" - } - return strings.Join(accepts, ",") -} - -func contains(source []string, containvalue string) bool { - for _, a := range source { - if strings.ToLower(a) == strings.ToLower(containvalue) { - return true - } - } - return false -} - -// CallAPI invokes an API endpoint -func (c *APIClient) CallAPI(path string, method string, - postBody interface{}, - headerParams map[string]string, - queryParams map[string]string, - formParams url.Values, - fileName string, - fileBytes []byte) (*APIResponse, error) { - - // Build request URL w/query params - urlString := path + "?" - if queryParams != nil { - for k, v := range queryParams { - urlString += fmt.Sprintf("%v=%v&", url.QueryEscape(strings.TrimSpace(k)), url.QueryEscape(strings.TrimSpace(v))) - } - } - urlString = urlString[:len(urlString)-1] - u, err := url.Parse(urlString) - if err != nil { - return nil, err - } - - request := retryablehttp.Request{ - Request: &http.Request{ - URL: u, - Close: true, - Method: strings.ToUpper(method), - Header: make(map[string][]string), - }, - } - - // Set default headers - if c.configuration.DefaultHeader != nil { - for k, v := range c.configuration.DefaultHeader { - fmt.Printf(" %v=%v", k, v) - request.Header.Set(k, v) - } - } - - // Set form data - if formParams != nil { - // request.Form = make(map[string][]string) - // request.Header.Set("Content-Type", "application/x-www-form-urlencoded") - // for k, v := range formParams { - // request.Form.Set(k, v) - // } - - request.Header.Set("Content-Type", "application/x-www-form-urlencoded") - request.Body = ioutil.NopCloser(strings.NewReader(formParams.Encode())) - } - - // Set post body - if postBody != nil { - request.Header.Set("Content-Type", "application/json") - j, _ := json.Marshal(postBody) - request.Body = ioutil.NopCloser(bytes.NewReader(j)) - } - - // Set provided headers - if headerParams != nil { - for k, v := range headerParams { - request.Header.Set(k, v) - } - } - - // Debug request - if c.configuration.GetDebug() { - c.configuration.Debugf("======== %v\n", time.Now()) - c.configuration.Debugf("%v %v\n", request.Method, u.Path) - c.configuration.Debugf("HOST: %v:%v\n", u.Host, u.Port()) - c.configuration.Debug("HEADERS:") - for k, v := range request.Header { - c.configuration.Debugf(" %v=%v\n", k, v) - } - c.configuration.Debug(request) - } - - if c.configuration.RetryConfiguration == nil { - c.client.RetryMax = 0 - c.client.RetryWaitMax = 0 - } else { - c.client.RetryWaitMax = c.configuration.RetryConfiguration.RetryWaitMax - c.client.RetryWaitMin = c.configuration.RetryConfiguration.RetryWaitMin - c.client.RetryMax = c.configuration.RetryConfiguration.RetryMax - if c.configuration.RetryConfiguration.RequestLogHook != nil { - c.client.RequestLogHook = func(_ retryablehttp.Logger, req *http.Request, retryNumber int) { - c.configuration.RetryConfiguration.RequestLogHook(req, retryNumber) - } - } - } - - // Execute request - reqStart := time.Now() - res, err := c.client.Do(&request) - if err != nil { - return nil, err - } - - reqEnd := time.Now() - duration := reqEnd.Sub(reqStart) - - // Read body - body, _ := ioutil.ReadAll(res.Body) - - if res.StatusCode == http.StatusUnauthorized && c.configuration.ShouldRefreshAccessToken && c.configuration.RefreshToken != "" { - err := c.handleExpiredAccessToken() - if err != nil { - return nil, err - } - if headerParams != nil { - headerParams["Authorization"] = "Bearer " + c.configuration.AccessToken - } - return c.CallAPI(path, method, postBody, headerParams, queryParams, formParams, fileName, fileBytes) - } - - // Debug response - if c.configuration.GetDebug() { - c.configuration.Debugf("==== RESPONSE %v (%v) ====\n", reqEnd, duration) - c.configuration.Debugf("STATUS: %v\n", res.Status) - c.configuration.Debug("HEADERS:") - for k, v := range res.Header { - c.configuration.Debugf(" %v=%v\n", k, v) - } - if body != nil { - c.configuration.Debugf("BODY:\n%v\n", string(body)) - } - c.configuration.Debug("========") - } - - return NewAPIResponse(res, body) -} - -func buildURL(basePath string, path string, queryParams map[string]string) (*url.URL, error) { - urlString := basePath + path - if len(queryParams) > 0 { - urlString += "?" - for k, v := range queryParams { - urlString += fmt.Sprintf("%v=%v&", strings.TrimSpace(k), strings.TrimSpace(v)) - } - urlString = urlString[:len(urlString)-1] - } - - u, err := url.Parse(urlString) - if err != nil { - return nil, err - } - return u, nil -} - -// ParameterToString joins a parameter in the desired format -func (c *APIClient) ParameterToString(obj interface{}, collectionFormat string) string { - sep := "," - switch collectionFormat { - case "pipes": - sep = "|" - case "ssv": - sep = " " - case "tsv": - sep = "\t" - } - - switch t := reflect.TypeOf(obj).String(); t { - case "[]string": - return strings.Join(obj.([]string), sep) - default: - return fmt.Sprintf("%v", obj) - } -} - -func (c *APIClient) handleExpiredAccessToken() error { - if atomic.CompareAndSwapInt64(&c.configuration.RefreshInProgress, 0, 1) { - defer atomic.StoreInt64(&c.configuration.RefreshInProgress, 0) - _, err := c.configuration.RefreshAuthorizationCodeGrant(c.configuration.ClientID, c.configuration.ClientSecret, c.configuration.RefreshToken) - return err - } else { - // Wait maximum of RefreshTokenWaitTime seconds for other thread to complete refresh - startTime := time.Now().Unix() - sleepDuration := time.Millisecond * 200 - // Check if we've gone over the wait threshold - for time.Now().Unix() - startTime < int64(c.configuration.RefreshTokenWaitTime) { - time.Sleep(sleepDuration) // Sleep for 200ms on every iteration - if atomic.LoadInt64(&c.configuration.RefreshInProgress) == 0 { - return nil - } - } - return fmt.Errorf("token refresh took longer than %d seconds", c.configuration.RefreshTokenWaitTime) - } -} - -// Int32 is an easy way to get a pointer -func Int32(v int) *int32 { - p := int32(v) - return &p -} - -// String is an easy way to get a pointer -func String(v string) *string { - return &v -} - -// Bool is an easy way to get a pointer -func Bool(v bool) *bool { - return &v -} diff --git a/build/platformclientv2/apiresponse.go b/build/platformclientv2/apiresponse.go deleted file mode 100644 index 91a259484..000000000 --- a/build/platformclientv2/apiresponse.go +++ /dev/null @@ -1,112 +0,0 @@ -package platformclientv2 - -import ( - "encoding/json" - "errors" - "fmt" - "net/http" -) - -// APIResponse is a friendly interface for a response from the API -type APIResponse struct { - Response *http.Response `json:"-"` - HasBody bool `json:"hasBody,omitempty"` - RawBody []byte `json:"rawBody,omitempty"` - IsSuccess bool `json:"isSuccess,omitempty"` - StatusCode int `json:"statusCode,omitempty"` - Status string `json:"status,omitempty"` - Error *APIError `json:"error,omitempty"` - ErrorMessage string `json:"errorMessage,omitempty"` - CorrelationID string `json:"correlationId,omitempty"` - Header map[string][]string `json:"header,omitempty"` -} - -// String returns the JSON serialized object -func (r *APIResponse) String() string { - s, _ := json.Marshal(r) - return string(s) -} - -// SetError returns the JSON serialized object -func (r *APIResponse) SetError(err *APIError) { - if err == nil { - return - } - r.Error = err - r.ErrorMessage = fmt.Sprintf("API Error: %v - %v (%v)", r.StatusCode, err.Message, r.CorrelationID) -} - -// APIError is the standard error body from the API -type APIError struct { - Status int `json:"status,omitempty"` - Message string `json:"message,omitempty"` - MessageWithParams string `json:"messageWithParams,omitempty"` - MessageParams map[string]interface{} `json:"messageParams,omitempty"` - Code string `json:"code,omitempty"` - ContextID string `json:"contextId,omitempty"` - Details []string `json:"details,omitempty"` -} - -// String returns the JSON serialized object -func (r *APIError) String() string { - s, _ := json.Marshal(r) - return string(s) -} - -// NewAPIResponse creates an APIResponse from a http Response -func NewAPIResponse(r *http.Response, body []byte) (*APIResponse, error) { - response := &APIResponse{Response: r} - var apiError *APIError - - response.StatusCode = r.StatusCode - response.Status = r.Status - response.HasBody = body != nil - response.IsSuccess = r.StatusCode >= 200 && r.StatusCode < 300 - response.Header = r.Header - if header, exists := response.Header["Inin-Correlation-Id"]; exists { - response.CorrelationID = header[0] - } - - if response.HasBody { - // Set body - response.RawBody = body - - // Handle error body - if !response.IsSuccess { - // Note: an error will always be returned from this block. - // response.Error will only be set if the error is parsed from the HTTP response body - - // Parse response body as error - err := json.Unmarshal(response.RawBody, &apiError) - if err != nil { - // Return response and json parse error - return response, err - } - - // Ensure context id is set - if apiError.ContextID == "" { - apiError.ContextID = response.CorrelationID - } - - // Set response error on the response - response.SetError(apiError) - - // Return response and api error message - return response, errors.New(response.ErrorMessage) - } - } - - // Return response and unknown API error. - // This shouldn't happen, but can if there isn't a response body for an unsuccessful request. - if !response.IsSuccess { - err := APIError{ - Message: "API Error: Unknown API Error", - ContextID: response.CorrelationID, - } - response.SetError(&err) - return response, errors.New(response.ErrorMessage) - } - - // Return response - return response, nil -} diff --git a/build/platformclientv2/apiusagequery.go b/build/platformclientv2/apiusagequery.go deleted file mode 100644 index 1e2b01811..000000000 --- a/build/platformclientv2/apiusagequery.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Apiusagequery -type Apiusagequery struct { - // Interval - Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss - Interval *string `json:"interval,omitempty"` - - - // Granularity - Date granularity of the results - Granularity *string `json:"granularity,omitempty"` - - - // GroupBy - Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group. - GroupBy *[]string `json:"groupBy,omitempty"` - - - // Metrics - Behaves like a SQL SELECT clause. Enables retrieving only named metrics. If omitted, all metrics that are available will be returned (like SELECT *). - Metrics *[]string `json:"metrics,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Apiusagequery) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/apiusagequeryresult.go b/build/platformclientv2/apiusagequeryresult.go deleted file mode 100644 index e13a696a0..000000000 --- a/build/platformclientv2/apiusagequeryresult.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Apiusagequeryresult -type Apiusagequeryresult struct { - // Results - Query results - Results *[]Apiusagerow `json:"results,omitempty"` - - - // QueryStatus - Query status - QueryStatus *string `json:"queryStatus,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Apiusagequeryresult) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/apiusagerow.go b/build/platformclientv2/apiusagerow.go deleted file mode 100644 index 683467f6d..000000000 --- a/build/platformclientv2/apiusagerow.go +++ /dev/null @@ -1,66 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Apiusagerow -type Apiusagerow struct { - // ClientId - Client Id associated with this query result - ClientId *string `json:"clientId,omitempty"` - - - // ClientName - Client Name associated with this query result - ClientName *string `json:"clientName,omitempty"` - - - // OrganizationId - Organization Id associated with this query result - OrganizationId *string `json:"organizationId,omitempty"` - - - // UserId - User Id associated with this query result - UserId *string `json:"userId,omitempty"` - - - // TemplateUri - Template Uri associated with this query result - TemplateUri *string `json:"templateUri,omitempty"` - - - // HttpMethod - HTTP Method associated with this query result - HttpMethod *string `json:"httpMethod,omitempty"` - - - // Status200 - Number of requests resulting in a 2xx HTTP status code - Status200 *int `json:"status200,omitempty"` - - - // Status300 - Number of requests resulting in a 3xx HTTP status code - Status300 *int `json:"status300,omitempty"` - - - // Status400 - Number of requests resulting in a 4xx HTTP status code - Status400 *int `json:"status400,omitempty"` - - - // Status500 - Number of requests resulting in a 5xx HTTP status code - Status500 *int `json:"status500,omitempty"` - - - // Status429 - Number of requests resulting in a 429 HTTP status code, this is a subset of the count returned with status400 - Status429 *int `json:"status429,omitempty"` - - - // Requests - Total number of requests - Requests *int `json:"requests,omitempty"` - - - // Date - Date of requests, based on granularity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - Date *time.Time `json:"date,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Apiusagerow) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/architectapi.go b/build/platformclientv2/architectapi.go deleted file mode 100644 index 175c1fc83..000000000 --- a/build/platformclientv2/architectapi.go +++ /dev/null @@ -1,9115 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "encoding/json" -) - -// ArchitectApi provides functions for API endpoints -type ArchitectApi struct { - Configuration *Configuration -} - -// NewArchitectApi creates an API instance using the default configuration -func NewArchitectApi() *ArchitectApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating ArchitectApi with base path: %s", strings.ToLower(config.BasePath))) - return &ArchitectApi{ - Configuration: config, - } -} - -// NewArchitectApiWithConfig creates an API instance using the provided configuration -func NewArchitectApiWithConfig(config *Configuration) *ArchitectApi { - config.Debugf("Creating ArchitectApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &ArchitectApi{ - Configuration: config, - } -} - -// DeleteArchitectEmergencygroup invokes DELETE /api/v2/architect/emergencygroups/{emergencyGroupId} -// -// Deletes a emergency group by ID -// -// -func (a ArchitectApi) DeleteArchitectEmergencygroup(emergencyGroupId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/architect/emergencygroups/{emergencyGroupId}" - path = strings.Replace(path, "{emergencyGroupId}", fmt.Sprintf("%v", emergencyGroupId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'emergencyGroupId' is set - if &emergencyGroupId == nil { - // - return nil, errors.New("Missing required parameter 'emergencyGroupId' when calling ArchitectApi->DeleteArchitectEmergencygroup") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteArchitectIvr invokes DELETE /api/v2/architect/ivrs/{ivrId} -// -// Delete an IVR Config. -// -// -func (a ArchitectApi) DeleteArchitectIvr(ivrId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/architect/ivrs/{ivrId}" - path = strings.Replace(path, "{ivrId}", fmt.Sprintf("%v", ivrId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'ivrId' is set - if &ivrId == nil { - // - return nil, errors.New("Missing required parameter 'ivrId' when calling ArchitectApi->DeleteArchitectIvr") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteArchitectPrompt invokes DELETE /api/v2/architect/prompts/{promptId} -// -// Delete specified user prompt -// -// -func (a ArchitectApi) DeleteArchitectPrompt(promptId string, allResources bool) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/architect/prompts/{promptId}" - path = strings.Replace(path, "{promptId}", fmt.Sprintf("%v", promptId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'promptId' is set - if &promptId == nil { - // - return nil, errors.New("Missing required parameter 'promptId' when calling ArchitectApi->DeleteArchitectPrompt") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(allResources).(string); ok { - if str != "" { - queryParams["allResources"] = a.Configuration.APIClient.ParameterToString(allResources, collectionFormat) - } - } else { - queryParams["allResources"] = a.Configuration.APIClient.ParameterToString(allResources, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteArchitectPromptResource invokes DELETE /api/v2/architect/prompts/{promptId}/resources/{languageCode} -// -// Delete specified user prompt resource -// -// -func (a ArchitectApi) DeleteArchitectPromptResource(promptId string, languageCode string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/architect/prompts/{promptId}/resources/{languageCode}" - path = strings.Replace(path, "{promptId}", fmt.Sprintf("%v", promptId), -1) - path = strings.Replace(path, "{languageCode}", fmt.Sprintf("%v", languageCode), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'promptId' is set - if &promptId == nil { - // - return nil, errors.New("Missing required parameter 'promptId' when calling ArchitectApi->DeleteArchitectPromptResource") - } - // verify the required parameter 'languageCode' is set - if &languageCode == nil { - // - return nil, errors.New("Missing required parameter 'languageCode' when calling ArchitectApi->DeleteArchitectPromptResource") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteArchitectPromptResourceAudio invokes DELETE /api/v2/architect/prompts/{promptId}/resources/{languageCode}/audio -// -// Delete specified user prompt resource audio -// -// -func (a ArchitectApi) DeleteArchitectPromptResourceAudio(promptId string, languageCode string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/architect/prompts/{promptId}/resources/{languageCode}/audio" - path = strings.Replace(path, "{promptId}", fmt.Sprintf("%v", promptId), -1) - path = strings.Replace(path, "{languageCode}", fmt.Sprintf("%v", languageCode), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'promptId' is set - if &promptId == nil { - // - return nil, errors.New("Missing required parameter 'promptId' when calling ArchitectApi->DeleteArchitectPromptResourceAudio") - } - // verify the required parameter 'languageCode' is set - if &languageCode == nil { - // - return nil, errors.New("Missing required parameter 'languageCode' when calling ArchitectApi->DeleteArchitectPromptResourceAudio") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteArchitectPrompts invokes DELETE /api/v2/architect/prompts -// -// Batch-delete a list of prompts -// -// Multiple IDs can be specified, in which case all specified prompts will be deleted. Asynchronous. Notification topic: v2.architect.prompts.{promptId} -func (a ArchitectApi) DeleteArchitectPrompts(id []string) (*Operation, *APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/architect/prompts" - defaultReturn := new(Operation) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'id' is set - if &id == nil { - // true - return defaultReturn, nil, errors.New("Missing required parameter 'id' when calling ArchitectApi->DeleteArchitectPrompts") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range id { - queryParams["id"] = value - } - } else { - queryParams["id"] = a.Configuration.APIClient.ParameterToString(id, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Operation - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// DeleteArchitectSchedule invokes DELETE /api/v2/architect/schedules/{scheduleId} -// -// Delete a schedule by id -// -// -func (a ArchitectApi) DeleteArchitectSchedule(scheduleId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/architect/schedules/{scheduleId}" - path = strings.Replace(path, "{scheduleId}", fmt.Sprintf("%v", scheduleId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'scheduleId' is set - if &scheduleId == nil { - // - return nil, errors.New("Missing required parameter 'scheduleId' when calling ArchitectApi->DeleteArchitectSchedule") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteArchitectSchedulegroup invokes DELETE /api/v2/architect/schedulegroups/{scheduleGroupId} -// -// Deletes a schedule group by ID -// -// -func (a ArchitectApi) DeleteArchitectSchedulegroup(scheduleGroupId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/architect/schedulegroups/{scheduleGroupId}" - path = strings.Replace(path, "{scheduleGroupId}", fmt.Sprintf("%v", scheduleGroupId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'scheduleGroupId' is set - if &scheduleGroupId == nil { - // - return nil, errors.New("Missing required parameter 'scheduleGroupId' when calling ArchitectApi->DeleteArchitectSchedulegroup") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteArchitectSystempromptResource invokes DELETE /api/v2/architect/systemprompts/{promptId}/resources/{languageCode} -// -// Delete a system prompt resource override. -// -// -func (a ArchitectApi) DeleteArchitectSystempromptResource(promptId string, languageCode string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/architect/systemprompts/{promptId}/resources/{languageCode}" - path = strings.Replace(path, "{promptId}", fmt.Sprintf("%v", promptId), -1) - path = strings.Replace(path, "{languageCode}", fmt.Sprintf("%v", languageCode), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'promptId' is set - if &promptId == nil { - // - return nil, errors.New("Missing required parameter 'promptId' when calling ArchitectApi->DeleteArchitectSystempromptResource") - } - // verify the required parameter 'languageCode' is set - if &languageCode == nil { - // - return nil, errors.New("Missing required parameter 'languageCode' when calling ArchitectApi->DeleteArchitectSystempromptResource") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteFlow invokes DELETE /api/v2/flows/{flowId} -// -// Delete flow -// -// -func (a ArchitectApi) DeleteFlow(flowId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/flows/{flowId}" - path = strings.Replace(path, "{flowId}", fmt.Sprintf("%v", flowId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'flowId' is set - if &flowId == nil { - // - return nil, errors.New("Missing required parameter 'flowId' when calling ArchitectApi->DeleteFlow") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteFlows invokes DELETE /api/v2/flows -// -// Batch-delete a list of flows -// -// Multiple IDs can be specified, in which case all specified flows will be deleted. Asynchronous. Notification topic: v2.flows.{flowId} -func (a ArchitectApi) DeleteFlows(id []string) (*Operation, *APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/flows" - defaultReturn := new(Operation) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'id' is set - if &id == nil { - // true - return defaultReturn, nil, errors.New("Missing required parameter 'id' when calling ArchitectApi->DeleteFlows") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range id { - queryParams["id"] = value - } - } else { - queryParams["id"] = a.Configuration.APIClient.ParameterToString(id, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Operation - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// DeleteFlowsDatatable invokes DELETE /api/v2/flows/datatables/{datatableId} -// -// deletes a specific datatable by id -// -// Deletes an entire datatable (including the schema and data) with a given datatableId -func (a ArchitectApi) DeleteFlowsDatatable(datatableId string, force bool) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/flows/datatables/{datatableId}" - path = strings.Replace(path, "{datatableId}", fmt.Sprintf("%v", datatableId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'datatableId' is set - if &datatableId == nil { - // - return nil, errors.New("Missing required parameter 'datatableId' when calling ArchitectApi->DeleteFlowsDatatable") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(force).(string); ok { - if str != "" { - queryParams["force"] = a.Configuration.APIClient.ParameterToString(force, collectionFormat) - } - } else { - queryParams["force"] = a.Configuration.APIClient.ParameterToString(force, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteFlowsDatatableRow invokes DELETE /api/v2/flows/datatables/{datatableId}/rows/{rowId} -// -// Delete a row entry -// -// Deletes a row with a given rowId (the value of the key field). -func (a ArchitectApi) DeleteFlowsDatatableRow(datatableId string, rowId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/flows/datatables/{datatableId}/rows/{rowId}" - path = strings.Replace(path, "{datatableId}", fmt.Sprintf("%v", datatableId), -1) - path = strings.Replace(path, "{rowId}", fmt.Sprintf("%v", rowId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'datatableId' is set - if &datatableId == nil { - // - return nil, errors.New("Missing required parameter 'datatableId' when calling ArchitectApi->DeleteFlowsDatatableRow") - } - // verify the required parameter 'rowId' is set - if &rowId == nil { - // - return nil, errors.New("Missing required parameter 'rowId' when calling ArchitectApi->DeleteFlowsDatatableRow") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteFlowsMilestone invokes DELETE /api/v2/flows/milestones/{milestoneId} -// -// Delete a flow milestone. -// -// -func (a ArchitectApi) DeleteFlowsMilestone(milestoneId string) (*Empty, *APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/flows/milestones/{milestoneId}" - path = strings.Replace(path, "{milestoneId}", fmt.Sprintf("%v", milestoneId), -1) - defaultReturn := new(Empty) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'milestoneId' is set - if &milestoneId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'milestoneId' when calling ArchitectApi->DeleteFlowsMilestone") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Empty - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetArchitectDependencytracking invokes GET /api/v2/architect/dependencytracking -// -// Get Dependency Tracking objects that have a given display name -// -// -func (a ArchitectApi) GetArchitectDependencytracking(name string, pageNumber int, pageSize int, objectType []string, consumedResources bool, consumingResources bool, consumedResourceType []string, consumingResourceType []string) (*Dependencyobjectentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/architect/dependencytracking" - defaultReturn := new(Dependencyobjectentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'name' is set - if &name == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'name' when calling ArchitectApi->GetArchitectDependencytracking") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range objectType { - queryParams["objectType"] = value - } - } else { - queryParams["objectType"] = a.Configuration.APIClient.ParameterToString(objectType, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(consumedResources).(string); ok { - if str != "" { - queryParams["consumedResources"] = a.Configuration.APIClient.ParameterToString(consumedResources, collectionFormat) - } - } else { - queryParams["consumedResources"] = a.Configuration.APIClient.ParameterToString(consumedResources, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(consumingResources).(string); ok { - if str != "" { - queryParams["consumingResources"] = a.Configuration.APIClient.ParameterToString(consumingResources, collectionFormat) - } - } else { - queryParams["consumingResources"] = a.Configuration.APIClient.ParameterToString(consumingResources, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range consumedResourceType { - queryParams["consumedResourceType"] = value - } - } else { - queryParams["consumedResourceType"] = a.Configuration.APIClient.ParameterToString(consumedResourceType, collectionFormat) - } - - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range consumingResourceType { - queryParams["consumingResourceType"] = value - } - } else { - queryParams["consumingResourceType"] = a.Configuration.APIClient.ParameterToString(consumingResourceType, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Dependencyobjectentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetArchitectDependencytrackingBuild invokes GET /api/v2/architect/dependencytracking/build -// -// Get Dependency Tracking build status for an organization -// -// -func (a ArchitectApi) GetArchitectDependencytrackingBuild() (*Dependencystatus, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/architect/dependencytracking/build" - defaultReturn := new(Dependencystatus) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Dependencystatus - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetArchitectDependencytrackingConsumedresources invokes GET /api/v2/architect/dependencytracking/consumedresources -// -// Get resources that are consumed by a given Dependency Tracking object -// -// -func (a ArchitectApi) GetArchitectDependencytrackingConsumedresources(id string, version string, objectType string, resourceType []string, pageNumber int, pageSize int) (*Consumedresourcesentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/architect/dependencytracking/consumedresources" - defaultReturn := new(Consumedresourcesentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'id' is set - if &id == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'id' when calling ArchitectApi->GetArchitectDependencytrackingConsumedresources") - } - // verify the required parameter 'version' is set - if &version == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'version' when calling ArchitectApi->GetArchitectDependencytrackingConsumedresources") - } - // verify the required parameter 'objectType' is set - if &objectType == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'objectType' when calling ArchitectApi->GetArchitectDependencytrackingConsumedresources") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(id).(string); ok { - if str != "" { - queryParams["id"] = a.Configuration.APIClient.ParameterToString(id, collectionFormat) - } - } else { - queryParams["id"] = a.Configuration.APIClient.ParameterToString(id, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(version).(string); ok { - if str != "" { - queryParams["version"] = a.Configuration.APIClient.ParameterToString(version, collectionFormat) - } - } else { - queryParams["version"] = a.Configuration.APIClient.ParameterToString(version, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(objectType).(string); ok { - if str != "" { - queryParams["objectType"] = a.Configuration.APIClient.ParameterToString(objectType, collectionFormat) - } - } else { - queryParams["objectType"] = a.Configuration.APIClient.ParameterToString(objectType, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range resourceType { - queryParams["resourceType"] = value - } - } else { - queryParams["resourceType"] = a.Configuration.APIClient.ParameterToString(resourceType, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Consumedresourcesentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetArchitectDependencytrackingConsumingresources invokes GET /api/v2/architect/dependencytracking/consumingresources -// -// Get resources that consume a given Dependency Tracking object -// -// -func (a ArchitectApi) GetArchitectDependencytrackingConsumingresources(id string, objectType string, resourceType []string, version string, pageNumber int, pageSize int, flowFilter string) (*Consumingresourcesentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/architect/dependencytracking/consumingresources" - defaultReturn := new(Consumingresourcesentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'id' is set - if &id == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'id' when calling ArchitectApi->GetArchitectDependencytrackingConsumingresources") - } - // verify the required parameter 'objectType' is set - if &objectType == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'objectType' when calling ArchitectApi->GetArchitectDependencytrackingConsumingresources") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(id).(string); ok { - if str != "" { - queryParams["id"] = a.Configuration.APIClient.ParameterToString(id, collectionFormat) - } - } else { - queryParams["id"] = a.Configuration.APIClient.ParameterToString(id, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(objectType).(string); ok { - if str != "" { - queryParams["objectType"] = a.Configuration.APIClient.ParameterToString(objectType, collectionFormat) - } - } else { - queryParams["objectType"] = a.Configuration.APIClient.ParameterToString(objectType, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range resourceType { - queryParams["resourceType"] = value - } - } else { - queryParams["resourceType"] = a.Configuration.APIClient.ParameterToString(resourceType, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(version).(string); ok { - if str != "" { - queryParams["version"] = a.Configuration.APIClient.ParameterToString(version, collectionFormat) - } - } else { - queryParams["version"] = a.Configuration.APIClient.ParameterToString(version, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(flowFilter).(string); ok { - if str != "" { - queryParams["flowFilter"] = a.Configuration.APIClient.ParameterToString(flowFilter, collectionFormat) - } - } else { - queryParams["flowFilter"] = a.Configuration.APIClient.ParameterToString(flowFilter, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Consumingresourcesentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetArchitectDependencytrackingDeletedresourceconsumers invokes GET /api/v2/architect/dependencytracking/deletedresourceconsumers -// -// Get Dependency Tracking objects that consume deleted resources -// -// -func (a ArchitectApi) GetArchitectDependencytrackingDeletedresourceconsumers(name string, objectType []string, flowFilter string, consumedResources bool, consumedResourceType []string, pageNumber int, pageSize int) (*Dependencyobjectentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/architect/dependencytracking/deletedresourceconsumers" - defaultReturn := new(Dependencyobjectentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range objectType { - queryParams["objectType"] = value - } - } else { - queryParams["objectType"] = a.Configuration.APIClient.ParameterToString(objectType, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(flowFilter).(string); ok { - if str != "" { - queryParams["flowFilter"] = a.Configuration.APIClient.ParameterToString(flowFilter, collectionFormat) - } - } else { - queryParams["flowFilter"] = a.Configuration.APIClient.ParameterToString(flowFilter, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(consumedResources).(string); ok { - if str != "" { - queryParams["consumedResources"] = a.Configuration.APIClient.ParameterToString(consumedResources, collectionFormat) - } - } else { - queryParams["consumedResources"] = a.Configuration.APIClient.ParameterToString(consumedResources, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range consumedResourceType { - queryParams["consumedResourceType"] = value - } - } else { - queryParams["consumedResourceType"] = a.Configuration.APIClient.ParameterToString(consumedResourceType, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Dependencyobjectentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetArchitectDependencytrackingObject invokes GET /api/v2/architect/dependencytracking/object -// -// Get a Dependency Tracking object -// -// -func (a ArchitectApi) GetArchitectDependencytrackingObject(id string, version string, objectType string, consumedResources bool, consumingResources bool, consumedResourceType []string, consumingResourceType []string, consumedResourceRequest bool) (*Dependencyobject, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/architect/dependencytracking/object" - defaultReturn := new(Dependencyobject) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'id' is set - if &id == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'id' when calling ArchitectApi->GetArchitectDependencytrackingObject") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(id).(string); ok { - if str != "" { - queryParams["id"] = a.Configuration.APIClient.ParameterToString(id, collectionFormat) - } - } else { - queryParams["id"] = a.Configuration.APIClient.ParameterToString(id, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(version).(string); ok { - if str != "" { - queryParams["version"] = a.Configuration.APIClient.ParameterToString(version, collectionFormat) - } - } else { - queryParams["version"] = a.Configuration.APIClient.ParameterToString(version, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(objectType).(string); ok { - if str != "" { - queryParams["objectType"] = a.Configuration.APIClient.ParameterToString(objectType, collectionFormat) - } - } else { - queryParams["objectType"] = a.Configuration.APIClient.ParameterToString(objectType, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(consumedResources).(string); ok { - if str != "" { - queryParams["consumedResources"] = a.Configuration.APIClient.ParameterToString(consumedResources, collectionFormat) - } - } else { - queryParams["consumedResources"] = a.Configuration.APIClient.ParameterToString(consumedResources, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(consumingResources).(string); ok { - if str != "" { - queryParams["consumingResources"] = a.Configuration.APIClient.ParameterToString(consumingResources, collectionFormat) - } - } else { - queryParams["consumingResources"] = a.Configuration.APIClient.ParameterToString(consumingResources, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range consumedResourceType { - queryParams["consumedResourceType"] = value - } - } else { - queryParams["consumedResourceType"] = a.Configuration.APIClient.ParameterToString(consumedResourceType, collectionFormat) - } - - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range consumingResourceType { - queryParams["consumingResourceType"] = value - } - } else { - queryParams["consumingResourceType"] = a.Configuration.APIClient.ParameterToString(consumingResourceType, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(consumedResourceRequest).(string); ok { - if str != "" { - queryParams["consumedResourceRequest"] = a.Configuration.APIClient.ParameterToString(consumedResourceRequest, collectionFormat) - } - } else { - queryParams["consumedResourceRequest"] = a.Configuration.APIClient.ParameterToString(consumedResourceRequest, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Dependencyobject - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetArchitectDependencytrackingType invokes GET /api/v2/architect/dependencytracking/types/{typeId} -// -// Get a Dependency Tracking type. -// -// -func (a ArchitectApi) GetArchitectDependencytrackingType(typeId string) (*Dependencytype, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/architect/dependencytracking/types/{typeId}" - path = strings.Replace(path, "{typeId}", fmt.Sprintf("%v", typeId), -1) - defaultReturn := new(Dependencytype) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'typeId' is set - if &typeId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'typeId' when calling ArchitectApi->GetArchitectDependencytrackingType") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Dependencytype - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetArchitectDependencytrackingTypes invokes GET /api/v2/architect/dependencytracking/types -// -// Get Dependency Tracking types. -// -// -func (a ArchitectApi) GetArchitectDependencytrackingTypes(pageNumber int, pageSize int) (*Dependencytypeentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/architect/dependencytracking/types" - defaultReturn := new(Dependencytypeentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Dependencytypeentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetArchitectDependencytrackingUpdatedresourceconsumers invokes GET /api/v2/architect/dependencytracking/updatedresourceconsumers -// -// Get Dependency Tracking objects that depend on updated resources -// -// -func (a ArchitectApi) GetArchitectDependencytrackingUpdatedresourceconsumers(name string, objectType []string, consumedResources bool, consumedResourceType []string, pageNumber int, pageSize int) (*Dependencyobjectentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/architect/dependencytracking/updatedresourceconsumers" - defaultReturn := new(Dependencyobjectentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range objectType { - queryParams["objectType"] = value - } - } else { - queryParams["objectType"] = a.Configuration.APIClient.ParameterToString(objectType, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(consumedResources).(string); ok { - if str != "" { - queryParams["consumedResources"] = a.Configuration.APIClient.ParameterToString(consumedResources, collectionFormat) - } - } else { - queryParams["consumedResources"] = a.Configuration.APIClient.ParameterToString(consumedResources, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range consumedResourceType { - queryParams["consumedResourceType"] = value - } - } else { - queryParams["consumedResourceType"] = a.Configuration.APIClient.ParameterToString(consumedResourceType, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Dependencyobjectentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetArchitectEmergencygroup invokes GET /api/v2/architect/emergencygroups/{emergencyGroupId} -// -// Gets a emergency group by ID -// -// -func (a ArchitectApi) GetArchitectEmergencygroup(emergencyGroupId string) (*Emergencygroup, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/architect/emergencygroups/{emergencyGroupId}" - path = strings.Replace(path, "{emergencyGroupId}", fmt.Sprintf("%v", emergencyGroupId), -1) - defaultReturn := new(Emergencygroup) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'emergencyGroupId' is set - if &emergencyGroupId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'emergencyGroupId' when calling ArchitectApi->GetArchitectEmergencygroup") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Emergencygroup - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetArchitectEmergencygroups invokes GET /api/v2/architect/emergencygroups -// -// Get a list of emergency groups. -// -// -func (a ArchitectApi) GetArchitectEmergencygroups(pageNumber int, pageSize int, sortBy string, sortOrder string, name string) (*Emergencygrouplisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/architect/emergencygroups" - defaultReturn := new(Emergencygrouplisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Emergencygrouplisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetArchitectIvr invokes GET /api/v2/architect/ivrs/{ivrId} -// -// Get an IVR config. -// -// -func (a ArchitectApi) GetArchitectIvr(ivrId string) (*Ivr, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/architect/ivrs/{ivrId}" - path = strings.Replace(path, "{ivrId}", fmt.Sprintf("%v", ivrId), -1) - defaultReturn := new(Ivr) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'ivrId' is set - if &ivrId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'ivrId' when calling ArchitectApi->GetArchitectIvr") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Ivr - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetArchitectIvrs invokes GET /api/v2/architect/ivrs -// -// Get IVR configs. -// -// -func (a ArchitectApi) GetArchitectIvrs(pageNumber int, pageSize int, sortBy string, sortOrder string, name string) (*Ivrentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/architect/ivrs" - defaultReturn := new(Ivrentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Ivrentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetArchitectPrompt invokes GET /api/v2/architect/prompts/{promptId} -// -// Get specified user prompt -// -// -func (a ArchitectApi) GetArchitectPrompt(promptId string) (*Prompt, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/architect/prompts/{promptId}" - path = strings.Replace(path, "{promptId}", fmt.Sprintf("%v", promptId), -1) - defaultReturn := new(Prompt) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'promptId' is set - if &promptId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'promptId' when calling ArchitectApi->GetArchitectPrompt") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Prompt - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetArchitectPromptHistoryHistoryId invokes GET /api/v2/architect/prompts/{promptId}/history/{historyId} -// -// Get generated prompt history -// -// -func (a ArchitectApi) GetArchitectPromptHistoryHistoryId(promptId string, historyId string, pageNumber int, pageSize int, sortOrder string, sortBy string, action []string) (*Historylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/architect/prompts/{promptId}/history/{historyId}" - path = strings.Replace(path, "{promptId}", fmt.Sprintf("%v", promptId), -1) - path = strings.Replace(path, "{historyId}", fmt.Sprintf("%v", historyId), -1) - defaultReturn := new(Historylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'promptId' is set - if &promptId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'promptId' when calling ArchitectApi->GetArchitectPromptHistoryHistoryId") - } - // verify the required parameter 'historyId' is set - if &historyId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'historyId' when calling ArchitectApi->GetArchitectPromptHistoryHistoryId") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range action { - queryParams["action"] = value - } - } else { - queryParams["action"] = a.Configuration.APIClient.ParameterToString(action, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Historylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetArchitectPromptResource invokes GET /api/v2/architect/prompts/{promptId}/resources/{languageCode} -// -// Get specified user prompt resource -// -// -func (a ArchitectApi) GetArchitectPromptResource(promptId string, languageCode string) (*Promptasset, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/architect/prompts/{promptId}/resources/{languageCode}" - path = strings.Replace(path, "{promptId}", fmt.Sprintf("%v", promptId), -1) - path = strings.Replace(path, "{languageCode}", fmt.Sprintf("%v", languageCode), -1) - defaultReturn := new(Promptasset) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'promptId' is set - if &promptId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'promptId' when calling ArchitectApi->GetArchitectPromptResource") - } - // verify the required parameter 'languageCode' is set - if &languageCode == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'languageCode' when calling ArchitectApi->GetArchitectPromptResource") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Promptasset - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetArchitectPromptResources invokes GET /api/v2/architect/prompts/{promptId}/resources -// -// Get a pageable list of user prompt resources -// -// The returned list is pageable, and query parameters can be used for filtering. -func (a ArchitectApi) GetArchitectPromptResources(promptId string, pageNumber int, pageSize int) (*Promptassetentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/architect/prompts/{promptId}/resources" - path = strings.Replace(path, "{promptId}", fmt.Sprintf("%v", promptId), -1) - defaultReturn := new(Promptassetentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'promptId' is set - if &promptId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'promptId' when calling ArchitectApi->GetArchitectPromptResources") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Promptassetentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetArchitectPrompts invokes GET /api/v2/architect/prompts -// -// Get a pageable list of user prompts -// -// The returned list is pageable, and query parameters can be used for filtering. Multiple names can be specified, in which case all matching prompts will be returned, and no other filters will be evaluated. -func (a ArchitectApi) GetArchitectPrompts(pageNumber int, pageSize int, name []string, description string, nameOrDescription string, sortBy string, sortOrder string) (*Promptentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/architect/prompts" - defaultReturn := new(Promptentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range name { - queryParams["name"] = value - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(description).(string); ok { - if str != "" { - queryParams["description"] = a.Configuration.APIClient.ParameterToString(description, collectionFormat) - } - } else { - queryParams["description"] = a.Configuration.APIClient.ParameterToString(description, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(nameOrDescription).(string); ok { - if str != "" { - queryParams["nameOrDescription"] = a.Configuration.APIClient.ParameterToString(nameOrDescription, collectionFormat) - } - } else { - queryParams["nameOrDescription"] = a.Configuration.APIClient.ParameterToString(nameOrDescription, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Promptentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetArchitectSchedule invokes GET /api/v2/architect/schedules/{scheduleId} -// -// Get a schedule by ID -// -// -func (a ArchitectApi) GetArchitectSchedule(scheduleId string) (*Schedule, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/architect/schedules/{scheduleId}" - path = strings.Replace(path, "{scheduleId}", fmt.Sprintf("%v", scheduleId), -1) - defaultReturn := new(Schedule) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'scheduleId' is set - if &scheduleId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'scheduleId' when calling ArchitectApi->GetArchitectSchedule") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Schedule - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetArchitectSchedulegroup invokes GET /api/v2/architect/schedulegroups/{scheduleGroupId} -// -// Gets a schedule group by ID -// -// -func (a ArchitectApi) GetArchitectSchedulegroup(scheduleGroupId string) (*Schedulegroup, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/architect/schedulegroups/{scheduleGroupId}" - path = strings.Replace(path, "{scheduleGroupId}", fmt.Sprintf("%v", scheduleGroupId), -1) - defaultReturn := new(Schedulegroup) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'scheduleGroupId' is set - if &scheduleGroupId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'scheduleGroupId' when calling ArchitectApi->GetArchitectSchedulegroup") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Schedulegroup - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetArchitectSchedulegroups invokes GET /api/v2/architect/schedulegroups -// -// Get a list of schedule groups. -// -// -func (a ArchitectApi) GetArchitectSchedulegroups(pageNumber int, pageSize int, sortBy string, sortOrder string, name string, scheduleIds string) (*Schedulegroupentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/architect/schedulegroups" - defaultReturn := new(Schedulegroupentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(scheduleIds).(string); ok { - if str != "" { - queryParams["scheduleIds"] = a.Configuration.APIClient.ParameterToString(scheduleIds, collectionFormat) - } - } else { - queryParams["scheduleIds"] = a.Configuration.APIClient.ParameterToString(scheduleIds, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Schedulegroupentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetArchitectSchedules invokes GET /api/v2/architect/schedules -// -// Get a list of schedules. -// -// -func (a ArchitectApi) GetArchitectSchedules(pageNumber int, pageSize int, sortBy string, sortOrder string, name string) (*Scheduleentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/architect/schedules" - defaultReturn := new(Scheduleentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Scheduleentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetArchitectSystemprompt invokes GET /api/v2/architect/systemprompts/{promptId} -// -// Get a system prompt -// -// -func (a ArchitectApi) GetArchitectSystemprompt(promptId string) (*Systemprompt, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/architect/systemprompts/{promptId}" - path = strings.Replace(path, "{promptId}", fmt.Sprintf("%v", promptId), -1) - defaultReturn := new(Systemprompt) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'promptId' is set - if &promptId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'promptId' when calling ArchitectApi->GetArchitectSystemprompt") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Systemprompt - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetArchitectSystempromptHistoryHistoryId invokes GET /api/v2/architect/systemprompts/{promptId}/history/{historyId} -// -// Get generated prompt history -// -// -func (a ArchitectApi) GetArchitectSystempromptHistoryHistoryId(promptId string, historyId string, pageNumber int, pageSize int, sortOrder string, sortBy string, action []string) (*Historylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/architect/systemprompts/{promptId}/history/{historyId}" - path = strings.Replace(path, "{promptId}", fmt.Sprintf("%v", promptId), -1) - path = strings.Replace(path, "{historyId}", fmt.Sprintf("%v", historyId), -1) - defaultReturn := new(Historylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'promptId' is set - if &promptId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'promptId' when calling ArchitectApi->GetArchitectSystempromptHistoryHistoryId") - } - // verify the required parameter 'historyId' is set - if &historyId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'historyId' when calling ArchitectApi->GetArchitectSystempromptHistoryHistoryId") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range action { - queryParams["action"] = value - } - } else { - queryParams["action"] = a.Configuration.APIClient.ParameterToString(action, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Historylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetArchitectSystempromptResource invokes GET /api/v2/architect/systemprompts/{promptId}/resources/{languageCode} -// -// Get a system prompt resource. -// -// -func (a ArchitectApi) GetArchitectSystempromptResource(promptId string, languageCode string) (*Systempromptasset, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/architect/systemprompts/{promptId}/resources/{languageCode}" - path = strings.Replace(path, "{promptId}", fmt.Sprintf("%v", promptId), -1) - path = strings.Replace(path, "{languageCode}", fmt.Sprintf("%v", languageCode), -1) - defaultReturn := new(Systempromptasset) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'promptId' is set - if &promptId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'promptId' when calling ArchitectApi->GetArchitectSystempromptResource") - } - // verify the required parameter 'languageCode' is set - if &languageCode == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'languageCode' when calling ArchitectApi->GetArchitectSystempromptResource") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Systempromptasset - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetArchitectSystempromptResources invokes GET /api/v2/architect/systemprompts/{promptId}/resources -// -// Get system prompt resources. -// -// -func (a ArchitectApi) GetArchitectSystempromptResources(promptId string, pageNumber int, pageSize int, sortBy string, sortOrder string) (*Systempromptassetentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/architect/systemprompts/{promptId}/resources" - path = strings.Replace(path, "{promptId}", fmt.Sprintf("%v", promptId), -1) - defaultReturn := new(Systempromptassetentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'promptId' is set - if &promptId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'promptId' when calling ArchitectApi->GetArchitectSystempromptResources") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Systempromptassetentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetArchitectSystemprompts invokes GET /api/v2/architect/systemprompts -// -// Get System Prompts -// -// -func (a ArchitectApi) GetArchitectSystemprompts(pageNumber int, pageSize int, sortBy string, sortOrder string, name string, description string, nameOrDescription string) (*Systempromptentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/architect/systemprompts" - defaultReturn := new(Systempromptentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(description).(string); ok { - if str != "" { - queryParams["description"] = a.Configuration.APIClient.ParameterToString(description, collectionFormat) - } - } else { - queryParams["description"] = a.Configuration.APIClient.ParameterToString(description, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(nameOrDescription).(string); ok { - if str != "" { - queryParams["nameOrDescription"] = a.Configuration.APIClient.ParameterToString(nameOrDescription, collectionFormat) - } - } else { - queryParams["nameOrDescription"] = a.Configuration.APIClient.ParameterToString(nameOrDescription, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Systempromptentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetFlow invokes GET /api/v2/flows/{flowId} -// -// Get flow -// -// -func (a ArchitectApi) GetFlow(flowId string, deleted bool) (*Flow, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/flows/{flowId}" - path = strings.Replace(path, "{flowId}", fmt.Sprintf("%v", flowId), -1) - defaultReturn := new(Flow) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'flowId' is set - if &flowId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'flowId' when calling ArchitectApi->GetFlow") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(deleted).(string); ok { - if str != "" { - queryParams["deleted"] = a.Configuration.APIClient.ParameterToString(deleted, collectionFormat) - } - } else { - queryParams["deleted"] = a.Configuration.APIClient.ParameterToString(deleted, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Flow - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetFlowHistoryHistoryId invokes GET /api/v2/flows/{flowId}/history/{historyId} -// -// Get generated flow history -// -// -func (a ArchitectApi) GetFlowHistoryHistoryId(flowId string, historyId string, pageNumber int, pageSize int, sortOrder string, sortBy string, action []string) (*Historylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/flows/{flowId}/history/{historyId}" - path = strings.Replace(path, "{flowId}", fmt.Sprintf("%v", flowId), -1) - path = strings.Replace(path, "{historyId}", fmt.Sprintf("%v", historyId), -1) - defaultReturn := new(Historylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'flowId' is set - if &flowId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'flowId' when calling ArchitectApi->GetFlowHistoryHistoryId") - } - // verify the required parameter 'historyId' is set - if &historyId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'historyId' when calling ArchitectApi->GetFlowHistoryHistoryId") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range action { - queryParams["action"] = value - } - } else { - queryParams["action"] = a.Configuration.APIClient.ParameterToString(action, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Historylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetFlowLatestconfiguration invokes GET /api/v2/flows/{flowId}/latestconfiguration -// -// Get the latest configuration for flow -// -// -func (a ArchitectApi) GetFlowLatestconfiguration(flowId string, deleted bool) (*map[string]interface{}, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/flows/{flowId}/latestconfiguration" - path = strings.Replace(path, "{flowId}", fmt.Sprintf("%v", flowId), -1) - defaultReturn := new(map[string]interface{}) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'flowId' is set - if &flowId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'flowId' when calling ArchitectApi->GetFlowLatestconfiguration") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(deleted).(string); ok { - if str != "" { - queryParams["deleted"] = a.Configuration.APIClient.ParameterToString(deleted, collectionFormat) - } - } else { - queryParams["deleted"] = a.Configuration.APIClient.ParameterToString(deleted, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *map[string]interface{} - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetFlowVersion invokes GET /api/v2/flows/{flowId}/versions/{versionId} -// -// Get flow version -// -// -func (a ArchitectApi) GetFlowVersion(flowId string, versionId string, deleted string) (*Flowversion, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/flows/{flowId}/versions/{versionId}" - path = strings.Replace(path, "{flowId}", fmt.Sprintf("%v", flowId), -1) - path = strings.Replace(path, "{versionId}", fmt.Sprintf("%v", versionId), -1) - defaultReturn := new(Flowversion) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'flowId' is set - if &flowId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'flowId' when calling ArchitectApi->GetFlowVersion") - } - // verify the required parameter 'versionId' is set - if &versionId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'versionId' when calling ArchitectApi->GetFlowVersion") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(deleted).(string); ok { - if str != "" { - queryParams["deleted"] = a.Configuration.APIClient.ParameterToString(deleted, collectionFormat) - } - } else { - queryParams["deleted"] = a.Configuration.APIClient.ParameterToString(deleted, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Flowversion - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetFlowVersionConfiguration invokes GET /api/v2/flows/{flowId}/versions/{versionId}/configuration -// -// Create flow version configuration -// -// -func (a ArchitectApi) GetFlowVersionConfiguration(flowId string, versionId string, deleted string) (*map[string]interface{}, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/flows/{flowId}/versions/{versionId}/configuration" - path = strings.Replace(path, "{flowId}", fmt.Sprintf("%v", flowId), -1) - path = strings.Replace(path, "{versionId}", fmt.Sprintf("%v", versionId), -1) - defaultReturn := new(map[string]interface{}) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'flowId' is set - if &flowId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'flowId' when calling ArchitectApi->GetFlowVersionConfiguration") - } - // verify the required parameter 'versionId' is set - if &versionId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'versionId' when calling ArchitectApi->GetFlowVersionConfiguration") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(deleted).(string); ok { - if str != "" { - queryParams["deleted"] = a.Configuration.APIClient.ParameterToString(deleted, collectionFormat) - } - } else { - queryParams["deleted"] = a.Configuration.APIClient.ParameterToString(deleted, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *map[string]interface{} - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetFlowVersions invokes GET /api/v2/flows/{flowId}/versions -// -// Get flow version list -// -// -func (a ArchitectApi) GetFlowVersions(flowId string, pageNumber int, pageSize int, deleted bool) (*Flowversionentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/flows/{flowId}/versions" - path = strings.Replace(path, "{flowId}", fmt.Sprintf("%v", flowId), -1) - defaultReturn := new(Flowversionentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'flowId' is set - if &flowId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'flowId' when calling ArchitectApi->GetFlowVersions") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(deleted).(string); ok { - if str != "" { - queryParams["deleted"] = a.Configuration.APIClient.ParameterToString(deleted, collectionFormat) - } - } else { - queryParams["deleted"] = a.Configuration.APIClient.ParameterToString(deleted, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Flowversionentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetFlows invokes GET /api/v2/flows -// -// Get a pageable list of flows, filtered by query parameters -// -// If one or more IDs are specified, the search will fetch flows that match the given ID(s) and not use any additional supplied query parameters in the search. -func (a ArchitectApi) GetFlows(varType []string, pageNumber int, pageSize int, sortBy string, sortOrder string, id []string, name string, description string, nameOrDescription string, publishVersionId string, editableBy string, lockedBy string, lockedByClientId string, secure string, deleted bool, includeSchemas bool, publishedAfter string, publishedBefore string, divisionId []string) (*Flowentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/flows" - defaultReturn := new(Flowentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range varType { - queryParams["varType"] = value - } - } else { - queryParams["varType"] = a.Configuration.APIClient.ParameterToString(varType, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range id { - queryParams["id"] = value - } - } else { - queryParams["id"] = a.Configuration.APIClient.ParameterToString(id, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(description).(string); ok { - if str != "" { - queryParams["description"] = a.Configuration.APIClient.ParameterToString(description, collectionFormat) - } - } else { - queryParams["description"] = a.Configuration.APIClient.ParameterToString(description, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(nameOrDescription).(string); ok { - if str != "" { - queryParams["nameOrDescription"] = a.Configuration.APIClient.ParameterToString(nameOrDescription, collectionFormat) - } - } else { - queryParams["nameOrDescription"] = a.Configuration.APIClient.ParameterToString(nameOrDescription, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(publishVersionId).(string); ok { - if str != "" { - queryParams["publishVersionId"] = a.Configuration.APIClient.ParameterToString(publishVersionId, collectionFormat) - } - } else { - queryParams["publishVersionId"] = a.Configuration.APIClient.ParameterToString(publishVersionId, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(editableBy).(string); ok { - if str != "" { - queryParams["editableBy"] = a.Configuration.APIClient.ParameterToString(editableBy, collectionFormat) - } - } else { - queryParams["editableBy"] = a.Configuration.APIClient.ParameterToString(editableBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(lockedBy).(string); ok { - if str != "" { - queryParams["lockedBy"] = a.Configuration.APIClient.ParameterToString(lockedBy, collectionFormat) - } - } else { - queryParams["lockedBy"] = a.Configuration.APIClient.ParameterToString(lockedBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(lockedByClientId).(string); ok { - if str != "" { - queryParams["lockedByClientId"] = a.Configuration.APIClient.ParameterToString(lockedByClientId, collectionFormat) - } - } else { - queryParams["lockedByClientId"] = a.Configuration.APIClient.ParameterToString(lockedByClientId, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(secure).(string); ok { - if str != "" { - queryParams["secure"] = a.Configuration.APIClient.ParameterToString(secure, collectionFormat) - } - } else { - queryParams["secure"] = a.Configuration.APIClient.ParameterToString(secure, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(deleted).(string); ok { - if str != "" { - queryParams["deleted"] = a.Configuration.APIClient.ParameterToString(deleted, collectionFormat) - } - } else { - queryParams["deleted"] = a.Configuration.APIClient.ParameterToString(deleted, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(includeSchemas).(string); ok { - if str != "" { - queryParams["includeSchemas"] = a.Configuration.APIClient.ParameterToString(includeSchemas, collectionFormat) - } - } else { - queryParams["includeSchemas"] = a.Configuration.APIClient.ParameterToString(includeSchemas, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(publishedAfter).(string); ok { - if str != "" { - queryParams["publishedAfter"] = a.Configuration.APIClient.ParameterToString(publishedAfter, collectionFormat) - } - } else { - queryParams["publishedAfter"] = a.Configuration.APIClient.ParameterToString(publishedAfter, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(publishedBefore).(string); ok { - if str != "" { - queryParams["publishedBefore"] = a.Configuration.APIClient.ParameterToString(publishedBefore, collectionFormat) - } - } else { - queryParams["publishedBefore"] = a.Configuration.APIClient.ParameterToString(publishedBefore, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range divisionId { - queryParams["divisionId"] = value - } - } else { - queryParams["divisionId"] = a.Configuration.APIClient.ParameterToString(divisionId, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Flowentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetFlowsDatatable invokes GET /api/v2/flows/datatables/{datatableId} -// -// Returns a specific datatable by id -// -// Given a datatableId returns the datatable object and schema associated with it. -func (a ArchitectApi) GetFlowsDatatable(datatableId string, expand string) (*Datatable, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/flows/datatables/{datatableId}" - path = strings.Replace(path, "{datatableId}", fmt.Sprintf("%v", datatableId), -1) - defaultReturn := new(Datatable) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'datatableId' is set - if &datatableId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'datatableId' when calling ArchitectApi->GetFlowsDatatable") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(expand).(string); ok { - if str != "" { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Datatable - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetFlowsDatatableExportJob invokes GET /api/v2/flows/datatables/{datatableId}/export/jobs/{exportJobId} -// -// Returns the state information about an export job -// -// Returns the state information about an export job. -func (a ArchitectApi) GetFlowsDatatableExportJob(datatableId string, exportJobId string) (*Datatableexportjob, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/flows/datatables/{datatableId}/export/jobs/{exportJobId}" - path = strings.Replace(path, "{datatableId}", fmt.Sprintf("%v", datatableId), -1) - path = strings.Replace(path, "{exportJobId}", fmt.Sprintf("%v", exportJobId), -1) - defaultReturn := new(Datatableexportjob) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'datatableId' is set - if &datatableId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'datatableId' when calling ArchitectApi->GetFlowsDatatableExportJob") - } - // verify the required parameter 'exportJobId' is set - if &exportJobId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'exportJobId' when calling ArchitectApi->GetFlowsDatatableExportJob") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Datatableexportjob - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetFlowsDatatableImportJob invokes GET /api/v2/flows/datatables/{datatableId}/import/jobs/{importJobId} -// -// Returns the state information about an import job -// -// Returns the state information about an import job. -func (a ArchitectApi) GetFlowsDatatableImportJob(datatableId string, importJobId string) (*Datatableimportjob, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/flows/datatables/{datatableId}/import/jobs/{importJobId}" - path = strings.Replace(path, "{datatableId}", fmt.Sprintf("%v", datatableId), -1) - path = strings.Replace(path, "{importJobId}", fmt.Sprintf("%v", importJobId), -1) - defaultReturn := new(Datatableimportjob) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'datatableId' is set - if &datatableId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'datatableId' when calling ArchitectApi->GetFlowsDatatableImportJob") - } - // verify the required parameter 'importJobId' is set - if &importJobId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'importJobId' when calling ArchitectApi->GetFlowsDatatableImportJob") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Datatableimportjob - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetFlowsDatatableImportJobs invokes GET /api/v2/flows/datatables/{datatableId}/import/jobs -// -// Get all recent import jobs -// -// Get all recent import jobs -func (a ArchitectApi) GetFlowsDatatableImportJobs(datatableId string, pageNumber int, pageSize int) (*Entitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/flows/datatables/{datatableId}/import/jobs" - path = strings.Replace(path, "{datatableId}", fmt.Sprintf("%v", datatableId), -1) - defaultReturn := new(Entitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'datatableId' is set - if &datatableId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'datatableId' when calling ArchitectApi->GetFlowsDatatableImportJobs") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Entitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetFlowsDatatableRow invokes GET /api/v2/flows/datatables/{datatableId}/rows/{rowId} -// -// Returns a specific row for the datatable -// -// Given a datatableId and a rowId (the value of the key field) this will return the full row contents for that rowId. -func (a ArchitectApi) GetFlowsDatatableRow(datatableId string, rowId string, showbrief bool) (*map[string]interface{}, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/flows/datatables/{datatableId}/rows/{rowId}" - path = strings.Replace(path, "{datatableId}", fmt.Sprintf("%v", datatableId), -1) - path = strings.Replace(path, "{rowId}", fmt.Sprintf("%v", rowId), -1) - defaultReturn := new(map[string]interface{}) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'datatableId' is set - if &datatableId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'datatableId' when calling ArchitectApi->GetFlowsDatatableRow") - } - // verify the required parameter 'rowId' is set - if &rowId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'rowId' when calling ArchitectApi->GetFlowsDatatableRow") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(showbrief).(string); ok { - if str != "" { - queryParams["showbrief"] = a.Configuration.APIClient.ParameterToString(showbrief, collectionFormat) - } - } else { - queryParams["showbrief"] = a.Configuration.APIClient.ParameterToString(showbrief, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *map[string]interface{} - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetFlowsDatatableRows invokes GET /api/v2/flows/datatables/{datatableId}/rows -// -// Returns the rows for the datatable with the given id -// -// Returns all of the rows for the datatable with the given datatableId. By default this will just be a truncated list returning the key for each row. Set showBrief to false to return all of the row contents. -func (a ArchitectApi) GetFlowsDatatableRows(datatableId string, pageNumber int, pageSize int, showbrief bool) (*Datatablerowentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/flows/datatables/{datatableId}/rows" - path = strings.Replace(path, "{datatableId}", fmt.Sprintf("%v", datatableId), -1) - defaultReturn := new(Datatablerowentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'datatableId' is set - if &datatableId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'datatableId' when calling ArchitectApi->GetFlowsDatatableRows") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(showbrief).(string); ok { - if str != "" { - queryParams["showbrief"] = a.Configuration.APIClient.ParameterToString(showbrief, collectionFormat) - } - } else { - queryParams["showbrief"] = a.Configuration.APIClient.ParameterToString(showbrief, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Datatablerowentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetFlowsDatatables invokes GET /api/v2/flows/datatables -// -// Retrieve a list of datatables for the org -// -// Returns a metadata list of the datatables associated with this org, including datatableId, name and description. -func (a ArchitectApi) GetFlowsDatatables(expand string, pageNumber int, pageSize int, sortBy string, sortOrder string) (*Datatablesdomainentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/flows/datatables" - defaultReturn := new(Datatablesdomainentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(expand).(string); ok { - if str != "" { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Datatablesdomainentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetFlowsDivisionviews invokes GET /api/v2/flows/divisionviews -// -// Get a pageable list of basic flow information objects filterable by query parameters. -// -// This returns a simplified version of /flow consisting of name and type. If one or more IDs are specified, the search will fetch flows that match the given ID(s) and not use any additional supplied query parameters in the search. -func (a ArchitectApi) GetFlowsDivisionviews(varType []string, pageNumber int, pageSize int, sortBy string, sortOrder string, id []string, name string, publishVersionId string, publishedAfter string, publishedBefore string, divisionId []string, includeSchemas bool) (*Flowdivisionviewentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/flows/divisionviews" - defaultReturn := new(Flowdivisionviewentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range varType { - queryParams["varType"] = value - } - } else { - queryParams["varType"] = a.Configuration.APIClient.ParameterToString(varType, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range id { - queryParams["id"] = value - } - } else { - queryParams["id"] = a.Configuration.APIClient.ParameterToString(id, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(publishVersionId).(string); ok { - if str != "" { - queryParams["publishVersionId"] = a.Configuration.APIClient.ParameterToString(publishVersionId, collectionFormat) - } - } else { - queryParams["publishVersionId"] = a.Configuration.APIClient.ParameterToString(publishVersionId, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(publishedAfter).(string); ok { - if str != "" { - queryParams["publishedAfter"] = a.Configuration.APIClient.ParameterToString(publishedAfter, collectionFormat) - } - } else { - queryParams["publishedAfter"] = a.Configuration.APIClient.ParameterToString(publishedAfter, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(publishedBefore).(string); ok { - if str != "" { - queryParams["publishedBefore"] = a.Configuration.APIClient.ParameterToString(publishedBefore, collectionFormat) - } - } else { - queryParams["publishedBefore"] = a.Configuration.APIClient.ParameterToString(publishedBefore, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range divisionId { - queryParams["divisionId"] = value - } - } else { - queryParams["divisionId"] = a.Configuration.APIClient.ParameterToString(divisionId, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(includeSchemas).(string); ok { - if str != "" { - queryParams["includeSchemas"] = a.Configuration.APIClient.ParameterToString(includeSchemas, collectionFormat) - } - } else { - queryParams["includeSchemas"] = a.Configuration.APIClient.ParameterToString(includeSchemas, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Flowdivisionviewentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetFlowsExecution invokes GET /api/v2/flows/executions/{flowExecutionId} -// -// Get a flow execution's details. Flow execution details are available for several days after the flow is started. -// -// -func (a ArchitectApi) GetFlowsExecution(flowExecutionId string) (*Flowruntimeexecution, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/flows/executions/{flowExecutionId}" - path = strings.Replace(path, "{flowExecutionId}", fmt.Sprintf("%v", flowExecutionId), -1) - defaultReturn := new(Flowruntimeexecution) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'flowExecutionId' is set - if &flowExecutionId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'flowExecutionId' when calling ArchitectApi->GetFlowsExecution") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Flowruntimeexecution - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetFlowsMilestone invokes GET /api/v2/flows/milestones/{milestoneId} -// -// Get a flow milestone -// -// Returns a specified flow milestone -func (a ArchitectApi) GetFlowsMilestone(milestoneId string) (*Flowmilestone, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/flows/milestones/{milestoneId}" - path = strings.Replace(path, "{milestoneId}", fmt.Sprintf("%v", milestoneId), -1) - defaultReturn := new(Flowmilestone) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'milestoneId' is set - if &milestoneId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'milestoneId' when calling ArchitectApi->GetFlowsMilestone") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Flowmilestone - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetFlowsMilestones invokes GET /api/v2/flows/milestones -// -// Get a pageable list of flow milestones, filtered by query parameters -// -// Multiple IDs can be specified, in which case all matching flow milestones will be returned, and no other parameters will be evaluated. -func (a ArchitectApi) GetFlowsMilestones(pageNumber int, pageSize int, sortBy string, sortOrder string, id []string, name string, description string, nameOrDescription string) (*Flowmilestonelisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/flows/milestones" - defaultReturn := new(Flowmilestonelisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range id { - queryParams["id"] = value - } - } else { - queryParams["id"] = a.Configuration.APIClient.ParameterToString(id, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(description).(string); ok { - if str != "" { - queryParams["description"] = a.Configuration.APIClient.ParameterToString(description, collectionFormat) - } - } else { - queryParams["description"] = a.Configuration.APIClient.ParameterToString(description, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(nameOrDescription).(string); ok { - if str != "" { - queryParams["nameOrDescription"] = a.Configuration.APIClient.ParameterToString(nameOrDescription, collectionFormat) - } - } else { - queryParams["nameOrDescription"] = a.Configuration.APIClient.ParameterToString(nameOrDescription, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Flowmilestonelisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetFlowsOutcome invokes GET /api/v2/flows/outcomes/{flowOutcomeId} -// -// Get a flow outcome -// -// Returns a specified flow outcome -func (a ArchitectApi) GetFlowsOutcome(flowOutcomeId string) (*Flowoutcome, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/flows/outcomes/{flowOutcomeId}" - path = strings.Replace(path, "{flowOutcomeId}", fmt.Sprintf("%v", flowOutcomeId), -1) - defaultReturn := new(Flowoutcome) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'flowOutcomeId' is set - if &flowOutcomeId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'flowOutcomeId' when calling ArchitectApi->GetFlowsOutcome") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Flowoutcome - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetFlowsOutcomes invokes GET /api/v2/flows/outcomes -// -// Get a pageable list of flow outcomes, filtered by query parameters -// -// Multiple IDs can be specified, in which case all matching flow outcomes will be returned, and no other parameters will be evaluated. -func (a ArchitectApi) GetFlowsOutcomes(pageNumber int, pageSize int, sortBy string, sortOrder string, id []string, name string, description string, nameOrDescription string) (*Flowoutcomelisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/flows/outcomes" - defaultReturn := new(Flowoutcomelisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range id { - queryParams["id"] = value - } - } else { - queryParams["id"] = a.Configuration.APIClient.ParameterToString(id, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(description).(string); ok { - if str != "" { - queryParams["description"] = a.Configuration.APIClient.ParameterToString(description, collectionFormat) - } - } else { - queryParams["description"] = a.Configuration.APIClient.ParameterToString(description, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(nameOrDescription).(string); ok { - if str != "" { - queryParams["nameOrDescription"] = a.Configuration.APIClient.ParameterToString(nameOrDescription, collectionFormat) - } - } else { - queryParams["nameOrDescription"] = a.Configuration.APIClient.ParameterToString(nameOrDescription, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Flowoutcomelisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostArchitectDependencytrackingBuild invokes POST /api/v2/architect/dependencytracking/build -// -// Rebuild Dependency Tracking data for an organization -// -// Asynchronous. Notification topic: v2.architect.dependencytracking.build -func (a ArchitectApi) PostArchitectDependencytrackingBuild() (*APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/architect/dependencytracking/build" - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// PostArchitectEmergencygroups invokes POST /api/v2/architect/emergencygroups -// -// Creates a new emergency group -// -// -func (a ArchitectApi) PostArchitectEmergencygroups(body Emergencygroup) (*Emergencygroup, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/architect/emergencygroups" - defaultReturn := new(Emergencygroup) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ArchitectApi->PostArchitectEmergencygroups") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Emergencygroup - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostArchitectIvrs invokes POST /api/v2/architect/ivrs -// -// Create IVR config. -// -// -func (a ArchitectApi) PostArchitectIvrs(body Ivr) (*Ivr, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/architect/ivrs" - defaultReturn := new(Ivr) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ArchitectApi->PostArchitectIvrs") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Ivr - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostArchitectPromptHistory invokes POST /api/v2/architect/prompts/{promptId}/history -// -// Generate prompt history -// -// Asynchronous. Notification topic: v2.architect.prompts.{promptId} -func (a ArchitectApi) PostArchitectPromptHistory(promptId string) (*Operation, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/architect/prompts/{promptId}/history" - path = strings.Replace(path, "{promptId}", fmt.Sprintf("%v", promptId), -1) - defaultReturn := new(Operation) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'promptId' is set - if &promptId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'promptId' when calling ArchitectApi->PostArchitectPromptHistory") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Operation - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostArchitectPromptResources invokes POST /api/v2/architect/prompts/{promptId}/resources -// -// Create a new user prompt resource -// -// -func (a ArchitectApi) PostArchitectPromptResources(promptId string, body Promptassetcreate) (*Promptasset, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/architect/prompts/{promptId}/resources" - path = strings.Replace(path, "{promptId}", fmt.Sprintf("%v", promptId), -1) - defaultReturn := new(Promptasset) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'promptId' is set - if &promptId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'promptId' when calling ArchitectApi->PostArchitectPromptResources") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ArchitectApi->PostArchitectPromptResources") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Promptasset - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostArchitectPrompts invokes POST /api/v2/architect/prompts -// -// Create a new user prompt -// -// -func (a ArchitectApi) PostArchitectPrompts(body Prompt) (*Prompt, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/architect/prompts" - defaultReturn := new(Prompt) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ArchitectApi->PostArchitectPrompts") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Prompt - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostArchitectSchedulegroups invokes POST /api/v2/architect/schedulegroups -// -// Creates a new schedule group -// -// -func (a ArchitectApi) PostArchitectSchedulegroups(body Schedulegroup) (*Schedulegroup, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/architect/schedulegroups" - defaultReturn := new(Schedulegroup) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ArchitectApi->PostArchitectSchedulegroups") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Schedulegroup - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostArchitectSchedules invokes POST /api/v2/architect/schedules -// -// Create a new schedule. -// -// -func (a ArchitectApi) PostArchitectSchedules(body Schedule) (*Schedule, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/architect/schedules" - defaultReturn := new(Schedule) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ArchitectApi->PostArchitectSchedules") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Schedule - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostArchitectSystempromptHistory invokes POST /api/v2/architect/systemprompts/{promptId}/history -// -// Generate system prompt history -// -// Asynchronous. Notification topic: v2.architect.systemprompts.{systemPromptId} -func (a ArchitectApi) PostArchitectSystempromptHistory(promptId string) (*Operation, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/architect/systemprompts/{promptId}/history" - path = strings.Replace(path, "{promptId}", fmt.Sprintf("%v", promptId), -1) - defaultReturn := new(Operation) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'promptId' is set - if &promptId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'promptId' when calling ArchitectApi->PostArchitectSystempromptHistory") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Operation - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostArchitectSystempromptResources invokes POST /api/v2/architect/systemprompts/{promptId}/resources -// -// Create system prompt resource override. -// -// -func (a ArchitectApi) PostArchitectSystempromptResources(promptId string, body Systempromptasset) (*Systempromptasset, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/architect/systemprompts/{promptId}/resources" - path = strings.Replace(path, "{promptId}", fmt.Sprintf("%v", promptId), -1) - defaultReturn := new(Systempromptasset) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'promptId' is set - if &promptId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'promptId' when calling ArchitectApi->PostArchitectSystempromptResources") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ArchitectApi->PostArchitectSystempromptResources") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Systempromptasset - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostFlowVersions invokes POST /api/v2/flows/{flowId}/versions -// -// Create flow version -// -// -func (a ArchitectApi) PostFlowVersions(flowId string, body map[string]interface{}) (*Flowversion, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/flows/{flowId}/versions" - path = strings.Replace(path, "{flowId}", fmt.Sprintf("%v", flowId), -1) - defaultReturn := new(Flowversion) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'flowId' is set - if &flowId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'flowId' when calling ArchitectApi->PostFlowVersions") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ArchitectApi->PostFlowVersions") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Flowversion - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostFlows invokes POST /api/v2/flows -// -// Create flow -// -// -func (a ArchitectApi) PostFlows(body Flow) (*Flow, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/flows" - defaultReturn := new(Flow) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ArchitectApi->PostFlows") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Flow - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostFlowsActionsCheckin invokes POST /api/v2/flows/actions/checkin -// -// Check-in flow -// -// Asynchronous. Notification topic: v2.flows.{flowId} -func (a ArchitectApi) PostFlowsActionsCheckin(flow string) (*Operation, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/flows/actions/checkin" - defaultReturn := new(Operation) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'flow' is set - if &flow == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'flow' when calling ArchitectApi->PostFlowsActionsCheckin") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(flow).(string); ok { - if str != "" { - queryParams["flow"] = a.Configuration.APIClient.ParameterToString(flow, collectionFormat) - } - } else { - queryParams["flow"] = a.Configuration.APIClient.ParameterToString(flow, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Operation - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostFlowsActionsCheckout invokes POST /api/v2/flows/actions/checkout -// -// Check-out flow -// -// -func (a ArchitectApi) PostFlowsActionsCheckout(flow string) (*Flow, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/flows/actions/checkout" - defaultReturn := new(Flow) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'flow' is set - if &flow == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'flow' when calling ArchitectApi->PostFlowsActionsCheckout") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(flow).(string); ok { - if str != "" { - queryParams["flow"] = a.Configuration.APIClient.ParameterToString(flow, collectionFormat) - } - } else { - queryParams["flow"] = a.Configuration.APIClient.ParameterToString(flow, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Flow - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostFlowsActionsDeactivate invokes POST /api/v2/flows/actions/deactivate -// -// Deactivate flow -// -// -func (a ArchitectApi) PostFlowsActionsDeactivate(flow string) (*Flow, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/flows/actions/deactivate" - defaultReturn := new(Flow) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'flow' is set - if &flow == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'flow' when calling ArchitectApi->PostFlowsActionsDeactivate") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(flow).(string); ok { - if str != "" { - queryParams["flow"] = a.Configuration.APIClient.ParameterToString(flow, collectionFormat) - } - } else { - queryParams["flow"] = a.Configuration.APIClient.ParameterToString(flow, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Flow - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostFlowsActionsPublish invokes POST /api/v2/flows/actions/publish -// -// Publish flow -// -// Asynchronous. Notification topic: v2.flows.{flowId} -func (a ArchitectApi) PostFlowsActionsPublish(flow string, version string) (*Operation, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/flows/actions/publish" - defaultReturn := new(Operation) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'flow' is set - if &flow == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'flow' when calling ArchitectApi->PostFlowsActionsPublish") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(flow).(string); ok { - if str != "" { - queryParams["flow"] = a.Configuration.APIClient.ParameterToString(flow, collectionFormat) - } - } else { - queryParams["flow"] = a.Configuration.APIClient.ParameterToString(flow, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(version).(string); ok { - if str != "" { - queryParams["version"] = a.Configuration.APIClient.ParameterToString(version, collectionFormat) - } - } else { - queryParams["version"] = a.Configuration.APIClient.ParameterToString(version, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Operation - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostFlowsActionsRevert invokes POST /api/v2/flows/actions/revert -// -// Revert flow -// -// -func (a ArchitectApi) PostFlowsActionsRevert(flow string) (*Flow, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/flows/actions/revert" - defaultReturn := new(Flow) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'flow' is set - if &flow == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'flow' when calling ArchitectApi->PostFlowsActionsRevert") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(flow).(string); ok { - if str != "" { - queryParams["flow"] = a.Configuration.APIClient.ParameterToString(flow, collectionFormat) - } - } else { - queryParams["flow"] = a.Configuration.APIClient.ParameterToString(flow, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Flow - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostFlowsActionsUnlock invokes POST /api/v2/flows/actions/unlock -// -// Unlock flow -// -// Allows for unlocking a flow in the case where there is no flow configuration available, and thus a check-in will not unlock the flow. The user must have Architect Admin permissions to perform this action. -func (a ArchitectApi) PostFlowsActionsUnlock(flow string) (*Flow, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/flows/actions/unlock" - defaultReturn := new(Flow) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'flow' is set - if &flow == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'flow' when calling ArchitectApi->PostFlowsActionsUnlock") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(flow).(string); ok { - if str != "" { - queryParams["flow"] = a.Configuration.APIClient.ParameterToString(flow, collectionFormat) - } - } else { - queryParams["flow"] = a.Configuration.APIClient.ParameterToString(flow, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Flow - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostFlowsDatatableExportJobs invokes POST /api/v2/flows/datatables/{datatableId}/export/jobs -// -// Begin an export process for exporting all rows from a datatable -// -// Create an export job for exporting rows. The caller can then poll for status of the export using the token returned in the response -func (a ArchitectApi) PostFlowsDatatableExportJobs(datatableId string) (*Datatableexportjob, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/flows/datatables/{datatableId}/export/jobs" - path = strings.Replace(path, "{datatableId}", fmt.Sprintf("%v", datatableId), -1) - defaultReturn := new(Datatableexportjob) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'datatableId' is set - if &datatableId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'datatableId' when calling ArchitectApi->PostFlowsDatatableExportJobs") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Datatableexportjob - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostFlowsDatatableImportJobs invokes POST /api/v2/flows/datatables/{datatableId}/import/jobs -// -// Begin an import process for importing rows into a datatable -// -// Create an import job for importing rows. The caller can then poll for status of the import using the token returned in the response -func (a ArchitectApi) PostFlowsDatatableImportJobs(datatableId string, body Datatableimportjob) (*Datatableimportjob, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/flows/datatables/{datatableId}/import/jobs" - path = strings.Replace(path, "{datatableId}", fmt.Sprintf("%v", datatableId), -1) - defaultReturn := new(Datatableimportjob) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'datatableId' is set - if &datatableId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'datatableId' when calling ArchitectApi->PostFlowsDatatableImportJobs") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ArchitectApi->PostFlowsDatatableImportJobs") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Datatableimportjob - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostFlowsDatatableRows invokes POST /api/v2/flows/datatables/{datatableId}/rows -// -// Create a new row entry for the datatable. -// -// Will add the passed in row entry to the datatable with the given datatableId after verifying it against the schema. The DataTableRow should be a json-ized' stream of key -> value pairs { \"Field1\": \"XYZZY\", \"Field2\": false, \"KEY\": \"27272\" } -func (a ArchitectApi) PostFlowsDatatableRows(datatableId string, dataTableRow map[string]interface{}) (*map[string]interface{}, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/flows/datatables/{datatableId}/rows" - path = strings.Replace(path, "{datatableId}", fmt.Sprintf("%v", datatableId), -1) - defaultReturn := new(map[string]interface{}) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'datatableId' is set - if &datatableId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'datatableId' when calling ArchitectApi->PostFlowsDatatableRows") - } - // verify the required parameter 'dataTableRow' is set - if &dataTableRow == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'dataTableRow' when calling ArchitectApi->PostFlowsDatatableRows") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &dataTableRow - - var successPayload *map[string]interface{} - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostFlowsDatatables invokes POST /api/v2/flows/datatables -// -// Create a new datatable with the specified json-schema definition -// -// This will create a new datatable with fields that match the property definitions in the JSON schema. The schema's title field will be overridden by the name field in the DataTable object. See also http://json-schema.org/ -func (a ArchitectApi) PostFlowsDatatables(body Datatable) (*Datatable, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/flows/datatables" - defaultReturn := new(Datatable) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ArchitectApi->PostFlowsDatatables") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Datatable - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostFlowsExecutions invokes POST /api/v2/flows/executions -// -// Launch an instance of a flow definition, for flow types that support it such as the 'workflow' type. -// -// The launch is asynchronous, it returns as soon as the flow starts. You can use the returned ID to query its status if you need. -func (a ArchitectApi) PostFlowsExecutions(flowLaunchRequest Flowexecutionlaunchrequest) (*Flowexecutionlaunchresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/flows/executions" - defaultReturn := new(Flowexecutionlaunchresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'flowLaunchRequest' is set - if &flowLaunchRequest == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'flowLaunchRequest' when calling ArchitectApi->PostFlowsExecutions") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &flowLaunchRequest - - var successPayload *Flowexecutionlaunchresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostFlowsMilestones invokes POST /api/v2/flows/milestones -// -// Create a flow milestone -// -// -func (a ArchitectApi) PostFlowsMilestones(body Flowmilestone) (*Flowmilestone, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/flows/milestones" - defaultReturn := new(Flowmilestone) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Flowmilestone - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostFlowsOutcomes invokes POST /api/v2/flows/outcomes -// -// Create a flow outcome -// -// Asynchronous. Notification topic: v2.flows.outcomes.{flowOutcomeId} -func (a ArchitectApi) PostFlowsOutcomes(body Flowoutcome) (*Flowoutcome, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/flows/outcomes" - defaultReturn := new(Flowoutcome) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Flowoutcome - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutArchitectEmergencygroup invokes PUT /api/v2/architect/emergencygroups/{emergencyGroupId} -// -// Updates a emergency group by ID -// -// -func (a ArchitectApi) PutArchitectEmergencygroup(emergencyGroupId string, body Emergencygroup) (*Emergencygroup, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/architect/emergencygroups/{emergencyGroupId}" - path = strings.Replace(path, "{emergencyGroupId}", fmt.Sprintf("%v", emergencyGroupId), -1) - defaultReturn := new(Emergencygroup) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'emergencyGroupId' is set - if &emergencyGroupId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'emergencyGroupId' when calling ArchitectApi->PutArchitectEmergencygroup") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ArchitectApi->PutArchitectEmergencygroup") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Emergencygroup - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutArchitectIvr invokes PUT /api/v2/architect/ivrs/{ivrId} -// -// Update an IVR Config. -// -// -func (a ArchitectApi) PutArchitectIvr(ivrId string, body Ivr) (*Ivr, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/architect/ivrs/{ivrId}" - path = strings.Replace(path, "{ivrId}", fmt.Sprintf("%v", ivrId), -1) - defaultReturn := new(Ivr) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'ivrId' is set - if &ivrId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'ivrId' when calling ArchitectApi->PutArchitectIvr") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ArchitectApi->PutArchitectIvr") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Ivr - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutArchitectPrompt invokes PUT /api/v2/architect/prompts/{promptId} -// -// Update specified user prompt -// -// -func (a ArchitectApi) PutArchitectPrompt(promptId string, body Prompt) (*Prompt, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/architect/prompts/{promptId}" - path = strings.Replace(path, "{promptId}", fmt.Sprintf("%v", promptId), -1) - defaultReturn := new(Prompt) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'promptId' is set - if &promptId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'promptId' when calling ArchitectApi->PutArchitectPrompt") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ArchitectApi->PutArchitectPrompt") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Prompt - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutArchitectPromptResource invokes PUT /api/v2/architect/prompts/{promptId}/resources/{languageCode} -// -// Update specified user prompt resource -// -// -func (a ArchitectApi) PutArchitectPromptResource(promptId string, languageCode string, body Promptasset) (*Promptasset, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/architect/prompts/{promptId}/resources/{languageCode}" - path = strings.Replace(path, "{promptId}", fmt.Sprintf("%v", promptId), -1) - path = strings.Replace(path, "{languageCode}", fmt.Sprintf("%v", languageCode), -1) - defaultReturn := new(Promptasset) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'promptId' is set - if &promptId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'promptId' when calling ArchitectApi->PutArchitectPromptResource") - } - // verify the required parameter 'languageCode' is set - if &languageCode == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'languageCode' when calling ArchitectApi->PutArchitectPromptResource") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ArchitectApi->PutArchitectPromptResource") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Promptasset - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutArchitectSchedule invokes PUT /api/v2/architect/schedules/{scheduleId} -// -// Update schedule by ID -// -// -func (a ArchitectApi) PutArchitectSchedule(scheduleId string, body Schedule) (*Schedule, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/architect/schedules/{scheduleId}" - path = strings.Replace(path, "{scheduleId}", fmt.Sprintf("%v", scheduleId), -1) - defaultReturn := new(Schedule) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'scheduleId' is set - if &scheduleId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'scheduleId' when calling ArchitectApi->PutArchitectSchedule") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ArchitectApi->PutArchitectSchedule") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Schedule - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutArchitectSchedulegroup invokes PUT /api/v2/architect/schedulegroups/{scheduleGroupId} -// -// Updates a schedule group by ID -// -// -func (a ArchitectApi) PutArchitectSchedulegroup(scheduleGroupId string, body Schedulegroup) (*Schedulegroup, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/architect/schedulegroups/{scheduleGroupId}" - path = strings.Replace(path, "{scheduleGroupId}", fmt.Sprintf("%v", scheduleGroupId), -1) - defaultReturn := new(Schedulegroup) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'scheduleGroupId' is set - if &scheduleGroupId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'scheduleGroupId' when calling ArchitectApi->PutArchitectSchedulegroup") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ArchitectApi->PutArchitectSchedulegroup") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Schedulegroup - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutArchitectSystempromptResource invokes PUT /api/v2/architect/systemprompts/{promptId}/resources/{languageCode} -// -// Updates a system prompt resource override. -// -// -func (a ArchitectApi) PutArchitectSystempromptResource(promptId string, languageCode string, body Systempromptasset) (*Systempromptasset, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/architect/systemprompts/{promptId}/resources/{languageCode}" - path = strings.Replace(path, "{promptId}", fmt.Sprintf("%v", promptId), -1) - path = strings.Replace(path, "{languageCode}", fmt.Sprintf("%v", languageCode), -1) - defaultReturn := new(Systempromptasset) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'promptId' is set - if &promptId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'promptId' when calling ArchitectApi->PutArchitectSystempromptResource") - } - // verify the required parameter 'languageCode' is set - if &languageCode == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'languageCode' when calling ArchitectApi->PutArchitectSystempromptResource") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ArchitectApi->PutArchitectSystempromptResource") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Systempromptasset - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutFlow invokes PUT /api/v2/flows/{flowId} -// -// Update flow -// -// -func (a ArchitectApi) PutFlow(flowId string, body Flow) (*Flow, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/flows/{flowId}" - path = strings.Replace(path, "{flowId}", fmt.Sprintf("%v", flowId), -1) - defaultReturn := new(Flow) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'flowId' is set - if &flowId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'flowId' when calling ArchitectApi->PutFlow") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ArchitectApi->PutFlow") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Flow - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutFlowsDatatable invokes PUT /api/v2/flows/datatables/{datatableId} -// -// Updates a specific datatable by id -// -// Updates a schema for a datatable with the given datatableId -updates allow only new fields to be added in the schema, no changes or removals of existing fields. -func (a ArchitectApi) PutFlowsDatatable(datatableId string, expand string, body Datatable) (*Datatable, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/flows/datatables/{datatableId}" - path = strings.Replace(path, "{datatableId}", fmt.Sprintf("%v", datatableId), -1) - defaultReturn := new(Datatable) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'datatableId' is set - if &datatableId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'datatableId' when calling ArchitectApi->PutFlowsDatatable") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(expand).(string); ok { - if str != "" { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Datatable - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutFlowsDatatableRow invokes PUT /api/v2/flows/datatables/{datatableId}/rows/{rowId} -// -// Update a row entry -// -// Updates a row with the given rowId (the value of the key field) to the new values. The DataTableRow should be a json-ized' stream of key -> value pairs { \"Field1\": \"XYZZY\", \"Field2\": false, \"KEY\": \"27272\" } -func (a ArchitectApi) PutFlowsDatatableRow(datatableId string, rowId string, body map[string]interface{}) (*map[string]interface{}, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/flows/datatables/{datatableId}/rows/{rowId}" - path = strings.Replace(path, "{datatableId}", fmt.Sprintf("%v", datatableId), -1) - path = strings.Replace(path, "{rowId}", fmt.Sprintf("%v", rowId), -1) - defaultReturn := new(map[string]interface{}) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'datatableId' is set - if &datatableId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'datatableId' when calling ArchitectApi->PutFlowsDatatableRow") - } - // verify the required parameter 'rowId' is set - if &rowId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'rowId' when calling ArchitectApi->PutFlowsDatatableRow") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *map[string]interface{} - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutFlowsMilestone invokes PUT /api/v2/flows/milestones/{milestoneId} -// -// Updates a flow milestone -// -// -func (a ArchitectApi) PutFlowsMilestone(milestoneId string, body Flowmilestone) (*Flowmilestone, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/flows/milestones/{milestoneId}" - path = strings.Replace(path, "{milestoneId}", fmt.Sprintf("%v", milestoneId), -1) - defaultReturn := new(Flowmilestone) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'milestoneId' is set - if &milestoneId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'milestoneId' when calling ArchitectApi->PutFlowsMilestone") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Flowmilestone - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutFlowsOutcome invokes PUT /api/v2/flows/outcomes/{flowOutcomeId} -// -// Updates a flow outcome -// -// Updates a flow outcome. Asynchronous. Notification topic: v2.flowoutcomes.{flowoutcomeId} -func (a ArchitectApi) PutFlowsOutcome(flowOutcomeId string, body Flowoutcome) (*Operation, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/flows/outcomes/{flowOutcomeId}" - path = strings.Replace(path, "{flowOutcomeId}", fmt.Sprintf("%v", flowOutcomeId), -1) - defaultReturn := new(Operation) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'flowOutcomeId' is set - if &flowOutcomeId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'flowOutcomeId' when calling ArchitectApi->PutFlowsOutcome") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Operation - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/architectdependencytrackingbuildnotificationclient.go b/build/platformclientv2/architectdependencytrackingbuildnotificationclient.go deleted file mode 100644 index 3565efe70..000000000 --- a/build/platformclientv2/architectdependencytrackingbuildnotificationclient.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Architectdependencytrackingbuildnotificationclient -type Architectdependencytrackingbuildnotificationclient struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Architectdependencytrackingbuildnotificationclient) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/architectdependencytrackingbuildnotificationdependencytrackingbuildnotification.go b/build/platformclientv2/architectdependencytrackingbuildnotificationdependencytrackingbuildnotification.go deleted file mode 100644 index 43ec0952c..000000000 --- a/build/platformclientv2/architectdependencytrackingbuildnotificationdependencytrackingbuildnotification.go +++ /dev/null @@ -1,30 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Architectdependencytrackingbuildnotificationdependencytrackingbuildnotification -type Architectdependencytrackingbuildnotificationdependencytrackingbuildnotification struct { - // Status - Status *string `json:"status,omitempty"` - - - // User - User *Architectdependencytrackingbuildnotificationuser `json:"user,omitempty"` - - - // Client - Client *Architectdependencytrackingbuildnotificationclient `json:"client,omitempty"` - - - // StartTime - StartTime *time.Time `json:"startTime,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Architectdependencytrackingbuildnotificationdependencytrackingbuildnotification) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/architectdependencytrackingbuildnotificationhomeorganization.go b/build/platformclientv2/architectdependencytrackingbuildnotificationhomeorganization.go deleted file mode 100644 index 3babab8f3..000000000 --- a/build/platformclientv2/architectdependencytrackingbuildnotificationhomeorganization.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Architectdependencytrackingbuildnotificationhomeorganization -type Architectdependencytrackingbuildnotificationhomeorganization struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // ThirdPartyOrgName - ThirdPartyOrgName *string `json:"thirdPartyOrgName,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Architectdependencytrackingbuildnotificationhomeorganization) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/architectdependencytrackingbuildnotificationuser.go b/build/platformclientv2/architectdependencytrackingbuildnotificationuser.go deleted file mode 100644 index 0bde5f465..000000000 --- a/build/platformclientv2/architectdependencytrackingbuildnotificationuser.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Architectdependencytrackingbuildnotificationuser -type Architectdependencytrackingbuildnotificationuser struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // HomeOrg - HomeOrg *Architectdependencytrackingbuildnotificationhomeorganization `json:"homeOrg,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Architectdependencytrackingbuildnotificationuser) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/architectflowfields.go b/build/platformclientv2/architectflowfields.go deleted file mode 100644 index 7c4272eab..000000000 --- a/build/platformclientv2/architectflowfields.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Architectflowfields -type Architectflowfields struct { - // ArchitectFlow - The architect flow. - ArchitectFlow *Addressableentityref `json:"architectFlow,omitempty"` - - - // FlowRequestMappings - Collection of Architect Flow Request Mappings to use. - FlowRequestMappings *[]Requestmapping `json:"flowRequestMappings,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Architectflowfields) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/architectflownotificationarchitectoperation.go b/build/platformclientv2/architectflownotificationarchitectoperation.go deleted file mode 100644 index 1cca17a24..000000000 --- a/build/platformclientv2/architectflownotificationarchitectoperation.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Architectflownotificationarchitectoperation -type Architectflownotificationarchitectoperation struct { - // Id - Id *string `json:"id,omitempty"` - - - // Complete - Complete *bool `json:"complete,omitempty"` - - - // User - User *Architectflownotificationuser `json:"user,omitempty"` - - - // Client - Client *Architectflownotificationclient `json:"client,omitempty"` - - - // ActionName - ActionName *string `json:"actionName,omitempty"` - - - // ActionStatus - ActionStatus *string `json:"actionStatus,omitempty"` - - - // ErrorMessage - ErrorMessage *string `json:"errorMessage,omitempty"` - - - // ErrorCode - ErrorCode *string `json:"errorCode,omitempty"` - - - // ErrorMessageParams - ErrorMessageParams *Architectflownotificationerrormessageparams `json:"errorMessageParams,omitempty"` - - - // ErrorDetails - ErrorDetails *[]Architectflownotificationerrordetail `json:"errorDetails,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Architectflownotificationarchitectoperation) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/architectflownotificationclient.go b/build/platformclientv2/architectflownotificationclient.go deleted file mode 100644 index 3128ef67a..000000000 --- a/build/platformclientv2/architectflownotificationclient.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Architectflownotificationclient -type Architectflownotificationclient struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Architectflownotificationclient) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/architectflownotificationerrordetail.go b/build/platformclientv2/architectflownotificationerrordetail.go deleted file mode 100644 index 77419f9bf..000000000 --- a/build/platformclientv2/architectflownotificationerrordetail.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Architectflownotificationerrordetail -type Architectflownotificationerrordetail struct { - // ErrorCode - ErrorCode *string `json:"errorCode,omitempty"` - - - // EntityId - EntityId *string `json:"entityId,omitempty"` - - - // EntityName - EntityName *string `json:"entityName,omitempty"` - - - // FieldName - FieldName *string `json:"fieldName,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Architectflownotificationerrordetail) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/architectflownotificationerrormessageparams.go b/build/platformclientv2/architectflownotificationerrormessageparams.go deleted file mode 100644 index fb1dcd3b4..000000000 --- a/build/platformclientv2/architectflownotificationerrormessageparams.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Architectflownotificationerrormessageparams -type Architectflownotificationerrormessageparams struct { - // AdditionalProperties - AdditionalProperties *map[string]string `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Architectflownotificationerrormessageparams) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/architectflownotificationflownotification.go b/build/platformclientv2/architectflownotificationflownotification.go deleted file mode 100644 index 5c7a831b4..000000000 --- a/build/platformclientv2/architectflownotificationflownotification.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Architectflownotificationflownotification -type Architectflownotificationflownotification struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Description - Description *string `json:"description,omitempty"` - - - // Deleted - Deleted *bool `json:"deleted,omitempty"` - - - // CheckedInVersion - CheckedInVersion *Architectflownotificationflowversion `json:"checkedInVersion,omitempty"` - - - // SavedVersion - SavedVersion *Architectflownotificationflowversion `json:"savedVersion,omitempty"` - - - // PublishedVersion - PublishedVersion *Architectflownotificationflowversion `json:"publishedVersion,omitempty"` - - - // CurrentOperation - CurrentOperation *Architectflownotificationarchitectoperation `json:"currentOperation,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Architectflownotificationflownotification) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/architectflownotificationflowversion.go b/build/platformclientv2/architectflownotificationflowversion.go deleted file mode 100644 index a7b25d74d..000000000 --- a/build/platformclientv2/architectflownotificationflowversion.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Architectflownotificationflowversion -type Architectflownotificationflowversion struct { - // Id - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Architectflownotificationflowversion) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/architectflownotificationhomeorganization.go b/build/platformclientv2/architectflownotificationhomeorganization.go deleted file mode 100644 index 3d2349dca..000000000 --- a/build/platformclientv2/architectflownotificationhomeorganization.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Architectflownotificationhomeorganization -type Architectflownotificationhomeorganization struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // ThirdPartyOrgName - ThirdPartyOrgName *string `json:"thirdPartyOrgName,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Architectflownotificationhomeorganization) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/architectflownotificationuser.go b/build/platformclientv2/architectflownotificationuser.go deleted file mode 100644 index 4ed49b91f..000000000 --- a/build/platformclientv2/architectflownotificationuser.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Architectflownotificationuser -type Architectflownotificationuser struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // HomeOrg - HomeOrg *Architectflownotificationhomeorganization `json:"homeOrg,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Architectflownotificationuser) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/architectflowoutcomenotificationarchitectoperation.go b/build/platformclientv2/architectflowoutcomenotificationarchitectoperation.go deleted file mode 100644 index 7fd8a7f97..000000000 --- a/build/platformclientv2/architectflowoutcomenotificationarchitectoperation.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Architectflowoutcomenotificationarchitectoperation -type Architectflowoutcomenotificationarchitectoperation struct { - // Id - Id *string `json:"id,omitempty"` - - - // Complete - Complete *bool `json:"complete,omitempty"` - - - // User - User *Architectflowoutcomenotificationuser `json:"user,omitempty"` - - - // Client - Client *Architectflowoutcomenotificationclient `json:"client,omitempty"` - - - // ActionName - ActionName *string `json:"actionName,omitempty"` - - - // ActionStatus - ActionStatus *string `json:"actionStatus,omitempty"` - - - // ErrorMessage - ErrorMessage *string `json:"errorMessage,omitempty"` - - - // ErrorCode - ErrorCode *string `json:"errorCode,omitempty"` - - - // ErrorMessageParams - ErrorMessageParams *Architectflowoutcomenotificationerrormessageparams `json:"errorMessageParams,omitempty"` - - - // ErrorDetails - ErrorDetails *[]Architectflowoutcomenotificationerrordetail `json:"errorDetails,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Architectflowoutcomenotificationarchitectoperation) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/architectflowoutcomenotificationclient.go b/build/platformclientv2/architectflowoutcomenotificationclient.go deleted file mode 100644 index f1a979db5..000000000 --- a/build/platformclientv2/architectflowoutcomenotificationclient.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Architectflowoutcomenotificationclient -type Architectflowoutcomenotificationclient struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Architectflowoutcomenotificationclient) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/architectflowoutcomenotificationerrordetail.go b/build/platformclientv2/architectflowoutcomenotificationerrordetail.go deleted file mode 100644 index 710083bdc..000000000 --- a/build/platformclientv2/architectflowoutcomenotificationerrordetail.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Architectflowoutcomenotificationerrordetail -type Architectflowoutcomenotificationerrordetail struct { - // ErrorCode - ErrorCode *string `json:"errorCode,omitempty"` - - - // EntityId - EntityId *string `json:"entityId,omitempty"` - - - // EntityName - EntityName *string `json:"entityName,omitempty"` - - - // FieldName - FieldName *string `json:"fieldName,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Architectflowoutcomenotificationerrordetail) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/architectflowoutcomenotificationerrormessageparams.go b/build/platformclientv2/architectflowoutcomenotificationerrormessageparams.go deleted file mode 100644 index e92f379db..000000000 --- a/build/platformclientv2/architectflowoutcomenotificationerrormessageparams.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Architectflowoutcomenotificationerrormessageparams -type Architectflowoutcomenotificationerrormessageparams struct { - // AdditionalProperties - AdditionalProperties *map[string]string `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Architectflowoutcomenotificationerrormessageparams) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/architectflowoutcomenotificationflowoutcomenotification.go b/build/platformclientv2/architectflowoutcomenotificationflowoutcomenotification.go deleted file mode 100644 index 5639f8f8f..000000000 --- a/build/platformclientv2/architectflowoutcomenotificationflowoutcomenotification.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Architectflowoutcomenotificationflowoutcomenotification -type Architectflowoutcomenotificationflowoutcomenotification struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Description - Description *string `json:"description,omitempty"` - - - // CurrentOperation - CurrentOperation *Architectflowoutcomenotificationarchitectoperation `json:"currentOperation,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Architectflowoutcomenotificationflowoutcomenotification) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/architectflowoutcomenotificationhomeorganization.go b/build/platformclientv2/architectflowoutcomenotificationhomeorganization.go deleted file mode 100644 index b506c383a..000000000 --- a/build/platformclientv2/architectflowoutcomenotificationhomeorganization.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Architectflowoutcomenotificationhomeorganization -type Architectflowoutcomenotificationhomeorganization struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // ThirdPartyOrgName - ThirdPartyOrgName *string `json:"thirdPartyOrgName,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Architectflowoutcomenotificationhomeorganization) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/architectflowoutcomenotificationuser.go b/build/platformclientv2/architectflowoutcomenotificationuser.go deleted file mode 100644 index dc368c74a..000000000 --- a/build/platformclientv2/architectflowoutcomenotificationuser.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Architectflowoutcomenotificationuser -type Architectflowoutcomenotificationuser struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // HomeOrg - HomeOrg *Architectflowoutcomenotificationhomeorganization `json:"homeOrg,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Architectflowoutcomenotificationuser) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/architectpromptnotificationarchitectoperation.go b/build/platformclientv2/architectpromptnotificationarchitectoperation.go deleted file mode 100644 index c06cc80c8..000000000 --- a/build/platformclientv2/architectpromptnotificationarchitectoperation.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Architectpromptnotificationarchitectoperation -type Architectpromptnotificationarchitectoperation struct { - // Id - Id *string `json:"id,omitempty"` - - - // Complete - Complete *bool `json:"complete,omitempty"` - - - // User - User *Architectpromptnotificationuser `json:"user,omitempty"` - - - // Client - Client *Architectpromptnotificationclient `json:"client,omitempty"` - - - // ActionName - ActionName *string `json:"actionName,omitempty"` - - - // ActionStatus - ActionStatus *string `json:"actionStatus,omitempty"` - - - // ErrorMessage - ErrorMessage *string `json:"errorMessage,omitempty"` - - - // ErrorCode - ErrorCode *string `json:"errorCode,omitempty"` - - - // ErrorMessageParams - ErrorMessageParams *Architectpromptnotificationerrormessageparams `json:"errorMessageParams,omitempty"` - - - // ErrorDetails - ErrorDetails *[]Architectpromptnotificationerrordetail `json:"errorDetails,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Architectpromptnotificationarchitectoperation) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/architectpromptnotificationclient.go b/build/platformclientv2/architectpromptnotificationclient.go deleted file mode 100644 index 94c25e74d..000000000 --- a/build/platformclientv2/architectpromptnotificationclient.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Architectpromptnotificationclient -type Architectpromptnotificationclient struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Architectpromptnotificationclient) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/architectpromptnotificationerrordetail.go b/build/platformclientv2/architectpromptnotificationerrordetail.go deleted file mode 100644 index cf1efd2dd..000000000 --- a/build/platformclientv2/architectpromptnotificationerrordetail.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Architectpromptnotificationerrordetail -type Architectpromptnotificationerrordetail struct { - // ErrorCode - ErrorCode *string `json:"errorCode,omitempty"` - - - // EntityId - EntityId *string `json:"entityId,omitempty"` - - - // EntityName - EntityName *string `json:"entityName,omitempty"` - - - // FieldName - FieldName *string `json:"fieldName,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Architectpromptnotificationerrordetail) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/architectpromptnotificationerrormessageparams.go b/build/platformclientv2/architectpromptnotificationerrormessageparams.go deleted file mode 100644 index 7f25c7979..000000000 --- a/build/platformclientv2/architectpromptnotificationerrormessageparams.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Architectpromptnotificationerrormessageparams -type Architectpromptnotificationerrormessageparams struct { - // AdditionalProperties - AdditionalProperties *map[string]string `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Architectpromptnotificationerrormessageparams) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/architectpromptnotificationhomeorganization.go b/build/platformclientv2/architectpromptnotificationhomeorganization.go deleted file mode 100644 index 752ed1a66..000000000 --- a/build/platformclientv2/architectpromptnotificationhomeorganization.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Architectpromptnotificationhomeorganization -type Architectpromptnotificationhomeorganization struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // ThirdPartyOrgName - ThirdPartyOrgName *string `json:"thirdPartyOrgName,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Architectpromptnotificationhomeorganization) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/architectpromptnotificationpromptnotification.go b/build/platformclientv2/architectpromptnotificationpromptnotification.go deleted file mode 100644 index ec97cfc40..000000000 --- a/build/platformclientv2/architectpromptnotificationpromptnotification.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Architectpromptnotificationpromptnotification -type Architectpromptnotificationpromptnotification struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Description - Description *string `json:"description,omitempty"` - - - // CurrentOperation - CurrentOperation *Architectpromptnotificationarchitectoperation `json:"currentOperation,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Architectpromptnotificationpromptnotification) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/architectpromptnotificationuser.go b/build/platformclientv2/architectpromptnotificationuser.go deleted file mode 100644 index feee37b66..000000000 --- a/build/platformclientv2/architectpromptnotificationuser.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Architectpromptnotificationuser -type Architectpromptnotificationuser struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // HomeOrg - HomeOrg *Architectpromptnotificationhomeorganization `json:"homeOrg,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Architectpromptnotificationuser) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/architectpromptresourcenotificationpromptresourcenotification.go b/build/platformclientv2/architectpromptresourcenotificationpromptresourcenotification.go deleted file mode 100644 index f706793d7..000000000 --- a/build/platformclientv2/architectpromptresourcenotificationpromptresourcenotification.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Architectpromptresourcenotificationpromptresourcenotification -type Architectpromptresourcenotificationpromptresourcenotification struct { - // PromptId - PromptId *string `json:"promptId,omitempty"` - - - // Id - Id *string `json:"id,omitempty"` - - - // Language - Language *string `json:"language,omitempty"` - - - // MediaUri - MediaUri *string `json:"mediaUri,omitempty"` - - - // UploadStatus - UploadStatus *string `json:"uploadStatus,omitempty"` - - - // DurationSeconds - DurationSeconds *float32 `json:"durationSeconds,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Architectpromptresourcenotificationpromptresourcenotification) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/architectsystempromptresourcenotificationsystempromptresourcenotification.go b/build/platformclientv2/architectsystempromptresourcenotificationsystempromptresourcenotification.go deleted file mode 100644 index 246d85d8a..000000000 --- a/build/platformclientv2/architectsystempromptresourcenotificationsystempromptresourcenotification.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Architectsystempromptresourcenotificationsystempromptresourcenotification -type Architectsystempromptresourcenotificationsystempromptresourcenotification struct { - // PromptId - PromptId *string `json:"promptId,omitempty"` - - - // Id - Id *string `json:"id,omitempty"` - - - // Language - Language *string `json:"language,omitempty"` - - - // MediaUri - MediaUri *string `json:"mediaUri,omitempty"` - - - // UploadStatus - UploadStatus *string `json:"uploadStatus,omitempty"` - - - // DurationSeconds - DurationSeconds *float32 `json:"durationSeconds,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Architectsystempromptresourcenotificationsystempromptresourcenotification) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/archiveretention.go b/build/platformclientv2/archiveretention.go deleted file mode 100644 index 3559582eb..000000000 --- a/build/platformclientv2/archiveretention.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Archiveretention -type Archiveretention struct { - // Days - Days *int `json:"days,omitempty"` - - - // StorageMedium - StorageMedium *string `json:"storageMedium,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Archiveretention) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/arraynode.go b/build/platformclientv2/arraynode.go deleted file mode 100644 index c22def27e..000000000 --- a/build/platformclientv2/arraynode.go +++ /dev/null @@ -1,97 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Arraynode -type Arraynode struct { - // NodeType - NodeType *string `json:"nodeType,omitempty"` - - - // Float - Float *bool `json:"float,omitempty"` - - - // Number - Number *bool `json:"number,omitempty"` - - - // Boolean - Boolean *bool `json:"boolean,omitempty"` - - - // Object - Object *bool `json:"object,omitempty"` - - - // ValueNode - ValueNode *bool `json:"valueNode,omitempty"` - - - // ContainerNode - ContainerNode *bool `json:"containerNode,omitempty"` - - - // FloatingPointNumber - FloatingPointNumber *bool `json:"floatingPointNumber,omitempty"` - - - // Pojo - Pojo *bool `json:"pojo,omitempty"` - - - // IntegralNumber - IntegralNumber *bool `json:"integralNumber,omitempty"` - - - // Short - Short *bool `json:"short,omitempty"` - - - // Int - Int *bool `json:"int,omitempty"` - - - // Long - Long *bool `json:"long,omitempty"` - - - // Double - Double *bool `json:"double,omitempty"` - - - // BigDecimal - BigDecimal *bool `json:"bigDecimal,omitempty"` - - - // BigInteger - BigInteger *bool `json:"bigInteger,omitempty"` - - - // Textual - Textual *bool `json:"textual,omitempty"` - - - // Binary - Binary *bool `json:"binary,omitempty"` - - - // MissingNode - MissingNode *bool `json:"missingNode,omitempty"` - - - // Array - Array *bool `json:"array,omitempty"` - - - // Null - Null *bool `json:"null,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Arraynode) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/assignedwrapupcode.go b/build/platformclientv2/assignedwrapupcode.go deleted file mode 100644 index 00ac98b93..000000000 --- a/build/platformclientv2/assignedwrapupcode.go +++ /dev/null @@ -1,34 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Assignedwrapupcode -type Assignedwrapupcode struct { - // Code - The user configured wrap up code id. - Code *string `json:"code,omitempty"` - - - // Notes - Text entered by the agent to describe the call or disposition. - Notes *string `json:"notes,omitempty"` - - - // Tags - List of tags selected by the agent to describe the call or disposition. - Tags *[]string `json:"tags,omitempty"` - - - // DurationSeconds - The duration in seconds of the wrap-up segment. - DurationSeconds *int `json:"durationSeconds,omitempty"` - - - // EndTime - The timestamp when the wrap-up segment ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - EndTime *time.Time `json:"endTime,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Assignedwrapupcode) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/assignmentgroup.go b/build/platformclientv2/assignmentgroup.go deleted file mode 100644 index 72f0c37d9..000000000 --- a/build/platformclientv2/assignmentgroup.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Assignmentgroup -type Assignmentgroup struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Assignmentgroup) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/asyncconversationquery.go b/build/platformclientv2/asyncconversationquery.go deleted file mode 100644 index ebf6728ee..000000000 --- a/build/platformclientv2/asyncconversationquery.go +++ /dev/null @@ -1,57 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Asyncconversationquery -type Asyncconversationquery struct { - // ConversationFilters - Filters that target conversation-level data - ConversationFilters *[]Conversationdetailqueryfilter `json:"conversationFilters,omitempty"` - - - // SegmentFilters - Filters that target individual segments within a conversation - SegmentFilters *[]Segmentdetailqueryfilter `json:"segmentFilters,omitempty"` - - - // EvaluationFilters - Filters that target evaluations - EvaluationFilters *[]Evaluationdetailqueryfilter `json:"evaluationFilters,omitempty"` - - - // MediaEndpointStatFilters - Filters that target mediaEndpointStats - MediaEndpointStatFilters *[]Mediaendpointstatdetailqueryfilter `json:"mediaEndpointStatFilters,omitempty"` - - - // SurveyFilters - Filters that target surveys - SurveyFilters *[]Surveydetailqueryfilter `json:"surveyFilters,omitempty"` - - - // ResolutionFilters - Filters that target resolutions - ResolutionFilters *[]Resolutiondetailqueryfilter `json:"resolutionFilters,omitempty"` - - - // Order - Sort the result set in ascending/descending order. Default is ascending - Order *string `json:"order,omitempty"` - - - // OrderBy - Specify which data element within the result set to use for sorting. The options to use as a basis for sorting the results: conversationStart, segmentStart, and segmentEnd. If not specified, the default is conversationStart - OrderBy *string `json:"orderBy,omitempty"` - - - // Interval - Specifies the date and time range of data being queried. Results will include all conversations that had activity during the interval. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss - Interval *string `json:"interval,omitempty"` - - - // Limit - Specify number of results to be returned - Limit *int `json:"limit,omitempty"` - - - // StartOfDayIntervalMatching - Add a filter to only include conversations that started after the beginning of the interval start date (UTC) - StartOfDayIntervalMatching *bool `json:"startOfDayIntervalMatching,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Asyncconversationquery) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/asyncforecastoperationresult.go b/build/platformclientv2/asyncforecastoperationresult.go deleted file mode 100644 index 2acc78425..000000000 --- a/build/platformclientv2/asyncforecastoperationresult.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Asyncforecastoperationresult -type Asyncforecastoperationresult struct { - // Status - The status of the operation - Status *string `json:"status,omitempty"` - - - // OperationId - The ID for the operation - OperationId *string `json:"operationId,omitempty"` - - - // Result - The result of the operation. Null unless status == Complete - Result *Bushorttermforecast `json:"result,omitempty"` - - - // Progress - Percent progress for the operation - Progress *int `json:"progress,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Asyncforecastoperationresult) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/asyncintradayresponse.go b/build/platformclientv2/asyncintradayresponse.go deleted file mode 100644 index c9ea7ed07..000000000 --- a/build/platformclientv2/asyncintradayresponse.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Asyncintradayresponse -type Asyncintradayresponse struct { - // Status - The status of the operation - Status *string `json:"status,omitempty"` - - - // OperationId - The ID for the operation - OperationId *string `json:"operationId,omitempty"` - - - // Result - The result of the operation. Null unless status == Complete - Result *Buintradayresponse `json:"result,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Asyncintradayresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/asyncqueryresponse.go b/build/platformclientv2/asyncqueryresponse.go deleted file mode 100644 index 5173fa3e9..000000000 --- a/build/platformclientv2/asyncqueryresponse.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Asyncqueryresponse -type Asyncqueryresponse struct { - // JobId - Unique identifier for the async query execution. Can be used to check the status of the query and retrieve results. - JobId *string `json:"jobId,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Asyncqueryresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/asyncquerystatus.go b/build/platformclientv2/asyncquerystatus.go deleted file mode 100644 index 45ee4cde7..000000000 --- a/build/platformclientv2/asyncquerystatus.go +++ /dev/null @@ -1,34 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Asyncquerystatus -type Asyncquerystatus struct { - // State - The current state of the asynchronous query - State *string `json:"state,omitempty"` - - - // ErrorMessage - The error associated with the current query, if the state is FAILED - ErrorMessage *string `json:"errorMessage,omitempty"` - - - // ExpirationDate - The time at which results for this query will expire. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ExpirationDate *time.Time `json:"expirationDate,omitempty"` - - - // SubmissionDate - The time at which the query was submitted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - SubmissionDate *time.Time `json:"submissionDate,omitempty"` - - - // CompletionDate - The time at which the query completed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - CompletionDate *time.Time `json:"completionDate,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Asyncquerystatus) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/asyncuserdetailsquery.go b/build/platformclientv2/asyncuserdetailsquery.go deleted file mode 100644 index 9d9b84c9b..000000000 --- a/build/platformclientv2/asyncuserdetailsquery.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Asyncuserdetailsquery -type Asyncuserdetailsquery struct { - // Interval - Specifies the date and time range of data being queried. Conversations MUST have started within this time range to potentially be included within the result set. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss - Interval *string `json:"interval,omitempty"` - - - // UserFilters - Filters that target the users to retrieve data for - UserFilters *[]Userdetailqueryfilter `json:"userFilters,omitempty"` - - - // PresenceFilters - Filters that target system and organization presence-level data - PresenceFilters *[]Presencedetailqueryfilter `json:"presenceFilters,omitempty"` - - - // RoutingStatusFilters - Filters that target agent routing status-level data - RoutingStatusFilters *[]Routingstatusdetailqueryfilter `json:"routingStatusFilters,omitempty"` - - - // Order - Sort the result set in ascending/descending order. Default is ascending - Order *string `json:"order,omitempty"` - - - // Limit - Specify number of results to be returned - Limit *int `json:"limit,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Asyncuserdetailsquery) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/attachment.go b/build/platformclientv2/attachment.go deleted file mode 100644 index a87f5ebff..000000000 --- a/build/platformclientv2/attachment.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Attachment -type Attachment struct { - // AttachmentId - The unique identifier for the attachment. - AttachmentId *string `json:"attachmentId,omitempty"` - - - // Name - The name of the attachment. - Name *string `json:"name,omitempty"` - - - // ContentUri - The content uri of the attachment. If set, this is commonly a public api download location. - ContentUri *string `json:"contentUri,omitempty"` - - - // ContentType - The type of file the attachment is. - ContentType *string `json:"contentType,omitempty"` - - - // ContentLength - The length of the attachment file. - ContentLength *int `json:"contentLength,omitempty"` - - - // InlineImage - Whether or not the attachment was attached inline., - InlineImage *bool `json:"inlineImage,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Attachment) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/attemptlimits.go b/build/platformclientv2/attemptlimits.go deleted file mode 100644 index dd1f9e9a3..000000000 --- a/build/platformclientv2/attemptlimits.go +++ /dev/null @@ -1,58 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Attemptlimits -type Attemptlimits struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // DateCreated - Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // Version - Required for updates, must match the version number of the most recent update - Version *int `json:"version,omitempty"` - - - // MaxAttemptsPerContact - The maximum number of times a contact can be called within the resetPeriod. Required if maxAttemptsPerNumber is not defined. - MaxAttemptsPerContact *int `json:"maxAttemptsPerContact,omitempty"` - - - // MaxAttemptsPerNumber - The maximum number of times a phone number can be called within the resetPeriod. Required if maxAttemptsPerContact is not defined. - MaxAttemptsPerNumber *int `json:"maxAttemptsPerNumber,omitempty"` - - - // TimeZoneId - If the resetPeriod is TODAY, this specifies the timezone in which TODAY occurs. Required if the resetPeriod is TODAY. - TimeZoneId *string `json:"timeZoneId,omitempty"` - - - // ResetPeriod - After how long the number of attempts will be set back to 0. Defaults to NEVER. - ResetPeriod *string `json:"resetPeriod,omitempty"` - - - // RecallEntries - Configuration for recall attempts. - RecallEntries *map[string]Recallentry `json:"recallEntries,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Attemptlimits) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/attemptlimitsentitylisting.go b/build/platformclientv2/attemptlimitsentitylisting.go deleted file mode 100644 index 5188734b5..000000000 --- a/build/platformclientv2/attemptlimitsentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Attemptlimitsentitylisting -type Attemptlimitsentitylisting struct { - // Entities - Entities *[]Attemptlimits `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Attemptlimitsentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/attributefilteritem.go b/build/platformclientv2/attributefilteritem.go deleted file mode 100644 index 8be935314..000000000 --- a/build/platformclientv2/attributefilteritem.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Attributefilteritem -type Attributefilteritem struct { - // Id - Id *string `json:"id,omitempty"` - - - // Operator - Operator *string `json:"operator,omitempty"` - - - // Values - Values *[]string `json:"values,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Attributefilteritem) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/atzmtimeslot.go b/build/platformclientv2/atzmtimeslot.go deleted file mode 100644 index c3925c177..000000000 --- a/build/platformclientv2/atzmtimeslot.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Atzmtimeslot -type Atzmtimeslot struct { - // EarliestCallableTime - The earliest time to dial a contact. Valid format is HH:mm - EarliestCallableTime *string `json:"earliestCallableTime,omitempty"` - - - // LatestCallableTime - The latest time to dial a contact. Valid format is HH:mm - LatestCallableTime *string `json:"latestCallableTime,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Atzmtimeslot) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/atzmtimeslotwithtimezone.go b/build/platformclientv2/atzmtimeslotwithtimezone.go deleted file mode 100644 index b5c289b9d..000000000 --- a/build/platformclientv2/atzmtimeslotwithtimezone.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Atzmtimeslotwithtimezone -type Atzmtimeslotwithtimezone struct { - // EarliestCallableTime - The earliest time to dial a contact. Valid format is HH:mm - EarliestCallableTime *string `json:"earliestCallableTime,omitempty"` - - - // LatestCallableTime - The latest time to dial a contact. Valid format is HH:mm - LatestCallableTime *string `json:"latestCallableTime,omitempty"` - - - // TimeZoneId - The time zone to use for contacts that cannot be mapped. - TimeZoneId *string `json:"timeZoneId,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Atzmtimeslotwithtimezone) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/auditapi.go b/build/platformclientv2/auditapi.go deleted file mode 100644 index b6e5e3fc2..000000000 --- a/build/platformclientv2/auditapi.go +++ /dev/null @@ -1,490 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "encoding/json" -) - -// AuditApi provides functions for API endpoints -type AuditApi struct { - Configuration *Configuration -} - -// NewAuditApi creates an API instance using the default configuration -func NewAuditApi() *AuditApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating AuditApi with base path: %s", strings.ToLower(config.BasePath))) - return &AuditApi{ - Configuration: config, - } -} - -// NewAuditApiWithConfig creates an API instance using the provided configuration -func NewAuditApiWithConfig(config *Configuration) *AuditApi { - config.Debugf("Creating AuditApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &AuditApi{ - Configuration: config, - } -} - -// GetAuditsQueryRealtimeServicemapping invokes GET /api/v2/audits/query/realtime/servicemapping -// -// Get service mapping information used in realtime audits. -// -// -func (a AuditApi) GetAuditsQueryRealtimeServicemapping() (*Auditqueryservicemapping, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/audits/query/realtime/servicemapping" - defaultReturn := new(Auditqueryservicemapping) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Auditqueryservicemapping - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAuditsQueryServicemapping invokes GET /api/v2/audits/query/servicemapping -// -// Get service mapping information used in audits. -// -// -func (a AuditApi) GetAuditsQueryServicemapping() (*Auditqueryservicemapping, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/audits/query/servicemapping" - defaultReturn := new(Auditqueryservicemapping) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Auditqueryservicemapping - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAuditsQueryTransactionId invokes GET /api/v2/audits/query/{transactionId} -// -// Get status of audit query execution -// -// -func (a AuditApi) GetAuditsQueryTransactionId(transactionId string) (*Auditqueryexecutionstatusresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/audits/query/{transactionId}" - path = strings.Replace(path, "{transactionId}", fmt.Sprintf("%v", transactionId), -1) - defaultReturn := new(Auditqueryexecutionstatusresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'transactionId' is set - if &transactionId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'transactionId' when calling AuditApi->GetAuditsQueryTransactionId") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Auditqueryexecutionstatusresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAuditsQueryTransactionIdResults invokes GET /api/v2/audits/query/{transactionId}/results -// -// Get results of audit query -// -// -func (a AuditApi) GetAuditsQueryTransactionIdResults(transactionId string, cursor string, pageSize int, expand []string) (*Auditqueryexecutionresultsresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/audits/query/{transactionId}/results" - path = strings.Replace(path, "{transactionId}", fmt.Sprintf("%v", transactionId), -1) - defaultReturn := new(Auditqueryexecutionresultsresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'transactionId' is set - if &transactionId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'transactionId' when calling AuditApi->GetAuditsQueryTransactionIdResults") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(cursor).(string); ok { - if str != "" { - queryParams["cursor"] = a.Configuration.APIClient.ParameterToString(cursor, collectionFormat) - } - } else { - queryParams["cursor"] = a.Configuration.APIClient.ParameterToString(cursor, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Auditqueryexecutionresultsresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostAuditsQuery invokes POST /api/v2/audits/query -// -// Create audit query execution -// -// -func (a AuditApi) PostAuditsQuery(body Auditqueryrequest) (*Auditqueryexecutionstatusresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/audits/query" - defaultReturn := new(Auditqueryexecutionstatusresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling AuditApi->PostAuditsQuery") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Auditqueryexecutionstatusresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostAuditsQueryRealtime invokes POST /api/v2/audits/query/realtime -// -// This endpoint will only retrieve 7 days worth of audits for certain services. Please use /query to get a full list and older audits. -// -// -func (a AuditApi) PostAuditsQueryRealtime(body Auditrealtimequeryrequest, expand []string) (*Auditrealtimequeryresultsresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/audits/query/realtime" - defaultReturn := new(Auditrealtimequeryresultsresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling AuditApi->PostAuditsQueryRealtime") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Auditrealtimequeryresultsresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/auditchange.go b/build/platformclientv2/auditchange.go deleted file mode 100644 index 8c5033a01..000000000 --- a/build/platformclientv2/auditchange.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Auditchange -type Auditchange struct { - // Property - Property *string `json:"property,omitempty"` - - - // Entity - Entity *Auditentityreference `json:"entity,omitempty"` - - - // OldValues - OldValues *[]string `json:"oldValues,omitempty"` - - - // NewValues - NewValues *[]string `json:"newValues,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Auditchange) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/auditentity.go b/build/platformclientv2/auditentity.go deleted file mode 100644 index ff80466a3..000000000 --- a/build/platformclientv2/auditentity.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Auditentity -type Auditentity struct { - // VarType - The type of the entity the action of this AuditEntity targeted. - VarType *string `json:"type,omitempty"` - - - // Id - The id of the entity the action of this AuditEntity targeted. - Id *string `json:"id,omitempty"` - - - // Name - The name of the entity the action of this AuditEntity targeted. - Name *string `json:"name,omitempty"` - - - // SelfUri - The selfUri for this entity. - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Auditentity) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/auditentityreference.go b/build/platformclientv2/auditentityreference.go deleted file mode 100644 index 082a5cb40..000000000 --- a/build/platformclientv2/auditentityreference.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Auditentityreference -type Auditentityreference struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - - - // Action - Action *string `json:"action,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Auditentityreference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/auditfacet.go b/build/platformclientv2/auditfacet.go deleted file mode 100644 index 99290dd49..000000000 --- a/build/platformclientv2/auditfacet.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Auditfacet -type Auditfacet struct { - // Name - The name of the field on which to facet. - Name *string `json:"name,omitempty"` - - - // VarType - The type of the facet, DATE or STRING. - VarType *string `json:"type,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Auditfacet) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/auditfilter.go b/build/platformclientv2/auditfilter.go deleted file mode 100644 index 6266010c1..000000000 --- a/build/platformclientv2/auditfilter.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Auditfilter -type Auditfilter struct { - // Name - The name of the field by which to filter. - Name *string `json:"name,omitempty"` - - - // VarType - The type of the filter, DATE or STRING. - VarType *string `json:"type,omitempty"` - - - // Operator - The operation that the filter performs. - Operator *string `json:"operator,omitempty"` - - - // Values - The values to make the filter comparison against. - Values *[]string `json:"values,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Auditfilter) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/auditlogmessage.go b/build/platformclientv2/auditlogmessage.go deleted file mode 100644 index 96e844b70..000000000 --- a/build/platformclientv2/auditlogmessage.go +++ /dev/null @@ -1,66 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Auditlogmessage -type Auditlogmessage struct { - // Id - Id of the audit message. - Id *string `json:"id,omitempty"` - - - // UserHomeOrgId - Home Organization Id associated with this audit message. - UserHomeOrgId *string `json:"userHomeOrgId,omitempty"` - - - // User - User associated with this audit message. - User *Domainentityref `json:"user,omitempty"` - - - // Client - Client associated with this audit message. - Client *Addressableentityref `json:"client,omitempty"` - - - // RemoteIp - List of IP addresses of systems that originated or handled the request. - RemoteIp *[]string `json:"remoteIp,omitempty"` - - - // ServiceName - Name of the service that logged this audit message. - ServiceName *string `json:"serviceName,omitempty"` - - - // EventDate - Date and time of when the audit message was logged. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - EventDate *time.Time `json:"eventDate,omitempty"` - - - // Message - Message describing the event being audited. - Message *Messageinfo `json:"message,omitempty"` - - - // Action - Action that took place. - Action *string `json:"action,omitempty"` - - - // Entity - Entity that was impacted. - Entity *Domainentityref `json:"entity,omitempty"` - - - // EntityType - Type of the entity that was impacted. - EntityType *string `json:"entityType,omitempty"` - - - // PropertyChanges - List of properties that were changed and changes made to those properties. - PropertyChanges *[]Propertychange `json:"propertyChanges,omitempty"` - - - // Context - Additional context for this message. - Context *map[string]string `json:"context,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Auditlogmessage) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/auditmessage.go b/build/platformclientv2/auditmessage.go deleted file mode 100644 index 95056f808..000000000 --- a/build/platformclientv2/auditmessage.go +++ /dev/null @@ -1,77 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Auditmessage -type Auditmessage struct { - // Id - AuditMessage ID. - Id *string `json:"id,omitempty"` - - - // User - User *Audituser `json:"user,omitempty"` - - - // CorrelationId - Correlation ID. - CorrelationId *string `json:"correlationId,omitempty"` - - - // TransactionId - Transaction ID. - TransactionId *string `json:"transactionId,omitempty"` - - - // TransactionInitiator - Whether or not this audit can be considered the initiator of the transaction it is a part of. - TransactionInitiator *bool `json:"transactionInitiator,omitempty"` - - - // Application - The application through which the action of this AuditMessage was initiated. - Application *string `json:"application,omitempty"` - - - // ServiceName - The name of the service which sent this AuditMessage. - ServiceName *string `json:"serviceName,omitempty"` - - - // Level - The level of this audit. USER or SYSTEM. - Level *string `json:"level,omitempty"` - - - // Timestamp - The time at which the action of this AuditMessage was initiated. - Timestamp *string `json:"timestamp,omitempty"` - - - // ReceivedTimestamp - The time at which this AuditMessage was received. - ReceivedTimestamp *string `json:"receivedTimestamp,omitempty"` - - - // Status - The status of the action of this AuditMessage - Status *string `json:"status,omitempty"` - - - // ActionContext - The context of a system-level action - ActionContext *string `json:"actionContext,omitempty"` - - - // Action - A string representing the action that took place - Action *string `json:"action,omitempty"` - - - // Changes - Details about any changes that occurred in this audit - Changes *[]Change `json:"changes,omitempty"` - - - // Entity - Entity *Auditentity `json:"entity,omitempty"` - - - // ServiceContext - The service-specific context associated with this AuditMessage. - ServiceContext *Servicecontext `json:"serviceContext,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Auditmessage) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/auditqueryentity.go b/build/platformclientv2/auditqueryentity.go deleted file mode 100644 index 632b68034..000000000 --- a/build/platformclientv2/auditqueryentity.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Auditqueryentity -type Auditqueryentity struct { - // Name - Name of the Entity - Name *string `json:"name,omitempty"` - - - // Actions - List of Actions - Actions *[]string `json:"actions,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Auditqueryentity) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/auditqueryexecutionresultsresponse.go b/build/platformclientv2/auditqueryexecutionresultsresponse.go deleted file mode 100644 index 72cae7d79..000000000 --- a/build/platformclientv2/auditqueryexecutionresultsresponse.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Auditqueryexecutionresultsresponse -type Auditqueryexecutionresultsresponse struct { - // Id - Id of the audit query execution request. - Id *string `json:"id,omitempty"` - - - // PageSize - Number of results in a page. - PageSize *int `json:"pageSize,omitempty"` - - - // Cursor - Optional cursor to indicate where to resume the results. - Cursor *string `json:"cursor,omitempty"` - - - // Entities - List of audit messages. - Entities *[]Auditlogmessage `json:"entities,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Auditqueryexecutionresultsresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/auditqueryexecutionstatusresponse.go b/build/platformclientv2/auditqueryexecutionstatusresponse.go deleted file mode 100644 index 4d393c7b2..000000000 --- a/build/platformclientv2/auditqueryexecutionstatusresponse.go +++ /dev/null @@ -1,42 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Auditqueryexecutionstatusresponse -type Auditqueryexecutionstatusresponse struct { - // Id - Id of the audit query execution request. - Id *string `json:"id,omitempty"` - - - // State - Status of the audit query execution request. - State *string `json:"state,omitempty"` - - - // StartDate - Start date and time of the audit query execution. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartDate *time.Time `json:"startDate,omitempty"` - - - // Interval - Interval for the audit query. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss - Interval *string `json:"interval,omitempty"` - - - // ServiceName - Service name for the audit query. - ServiceName *string `json:"serviceName,omitempty"` - - - // Filters - Filters for the audit query. - Filters *[]Auditqueryfilter `json:"filters,omitempty"` - - - // Sort - Sort parameter for the audit query. - Sort *[]Auditquerysort `json:"sort,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Auditqueryexecutionstatusresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/auditqueryfilter.go b/build/platformclientv2/auditqueryfilter.go deleted file mode 100644 index 8927e6c8b..000000000 --- a/build/platformclientv2/auditqueryfilter.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Auditqueryfilter -type Auditqueryfilter struct { - // Property - Name of the property to filter. - Property *string `json:"property,omitempty"` - - - // Value - Value of the property to filter. - Value *string `json:"value,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Auditqueryfilter) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/auditqueryrequest.go b/build/platformclientv2/auditqueryrequest.go deleted file mode 100644 index bbf9753ea..000000000 --- a/build/platformclientv2/auditqueryrequest.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Auditqueryrequest -type Auditqueryrequest struct { - // Interval - Date and time range of data to query. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss - Interval *string `json:"interval,omitempty"` - - - // ServiceName - Name of the service to query audits for. - ServiceName *string `json:"serviceName,omitempty"` - - - // Filters - Additional filters for the query. - Filters *[]Auditqueryfilter `json:"filters,omitempty"` - - - // Sort - Sort parameter for the query. - Sort *[]Auditquerysort `json:"sort,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Auditqueryrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/auditqueryresponse.go b/build/platformclientv2/auditqueryresponse.go deleted file mode 100644 index f079759e7..000000000 --- a/build/platformclientv2/auditqueryresponse.go +++ /dev/null @@ -1,13 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Auditqueryresponse -type Auditqueryresponse struct { } - -// String returns a JSON representation of the model -func (o *Auditqueryresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/auditqueryservice.go b/build/platformclientv2/auditqueryservice.go deleted file mode 100644 index e486bcce5..000000000 --- a/build/platformclientv2/auditqueryservice.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Auditqueryservice -type Auditqueryservice struct { - // Name - Name of the Service - Name *string `json:"name,omitempty"` - - - // Entities - List of Entities - Entities *[]Auditqueryentity `json:"entities,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Auditqueryservice) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/auditqueryservicemapping.go b/build/platformclientv2/auditqueryservicemapping.go deleted file mode 100644 index 55be0fa67..000000000 --- a/build/platformclientv2/auditqueryservicemapping.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Auditqueryservicemapping -type Auditqueryservicemapping struct { - // Services - List of Services - Services *[]Auditqueryservice `json:"services,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Auditqueryservicemapping) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/auditquerysort.go b/build/platformclientv2/auditquerysort.go deleted file mode 100644 index a9799661b..000000000 --- a/build/platformclientv2/auditquerysort.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Auditquerysort -type Auditquerysort struct { - // Name - Name of the property to sort. - Name *string `json:"name,omitempty"` - - - // SortOrder - Sort Order - SortOrder *string `json:"sortOrder,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Auditquerysort) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/auditrealtimequeryrequest.go b/build/platformclientv2/auditrealtimequeryrequest.go deleted file mode 100644 index 3d3c3b462..000000000 --- a/build/platformclientv2/auditrealtimequeryrequest.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Auditrealtimequeryrequest -type Auditrealtimequeryrequest struct { - // Interval - Date and time range of data to query. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss - Interval *string `json:"interval,omitempty"` - - - // ServiceName - Name of the service to query audits for. - ServiceName *string `json:"serviceName,omitempty"` - - - // Filters - Additional filters for the query. - Filters *[]Auditqueryfilter `json:"filters,omitempty"` - - - // Sort - Sort parameter for the query. - Sort *[]Auditquerysort `json:"sort,omitempty"` - - - // PageNumber - Page number - PageNumber *int `json:"pageNumber,omitempty"` - - - // PageSize - Page size - PageSize *int `json:"pageSize,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Auditrealtimequeryrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/auditrealtimequeryresultsresponse.go b/build/platformclientv2/auditrealtimequeryresultsresponse.go deleted file mode 100644 index a8e091c58..000000000 --- a/build/platformclientv2/auditrealtimequeryresultsresponse.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Auditrealtimequeryresultsresponse -type Auditrealtimequeryresultsresponse struct { - // Entities - Entities *[]Auditlogmessage `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Auditrealtimequeryresultsresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/auditsearchresult.go b/build/platformclientv2/auditsearchresult.go deleted file mode 100644 index 8aad848ff..000000000 --- a/build/platformclientv2/auditsearchresult.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Auditsearchresult -type Auditsearchresult struct { - // PageNumber - Which page was returned. - PageNumber *int `json:"pageNumber,omitempty"` - - - // PageSize - The number of results in a page. - PageSize *int `json:"pageSize,omitempty"` - - - // Total - The total number of results. - Total *int `json:"total,omitempty"` - - - // PageCount - The number of pages of results. - PageCount *int `json:"pageCount,omitempty"` - - - // FacetInfo - FacetInfo *[]Facetinfo `json:"facetInfo,omitempty"` - - - // AuditMessages - AuditMessages *[]Auditmessage `json:"auditMessages,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Auditsearchresult) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/audituser.go b/build/platformclientv2/audituser.go deleted file mode 100644 index 84ee521cd..000000000 --- a/build/platformclientv2/audituser.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Audituser -type Audituser struct { - // Id - The ID (UUID) of the user who initiated the action of this AuditMessage. - Id *string `json:"id,omitempty"` - - - // Name - The full username of the user who initiated the action of this AuditMessage. - Name *string `json:"name,omitempty"` - - - // Display - The display name of the user who initiated the action of this AuditMessage. - Display *string `json:"display,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Audituser) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/authorizationapi.go b/build/platformclientv2/authorizationapi.go deleted file mode 100644 index 0cb674dcd..000000000 --- a/build/platformclientv2/authorizationapi.go +++ /dev/null @@ -1,3349 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "encoding/json" -) - -// AuthorizationApi provides functions for API endpoints -type AuthorizationApi struct { - Configuration *Configuration -} - -// NewAuthorizationApi creates an API instance using the default configuration -func NewAuthorizationApi() *AuthorizationApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating AuthorizationApi with base path: %s", strings.ToLower(config.BasePath))) - return &AuthorizationApi{ - Configuration: config, - } -} - -// NewAuthorizationApiWithConfig creates an API instance using the provided configuration -func NewAuthorizationApiWithConfig(config *Configuration) *AuthorizationApi { - config.Debugf("Creating AuthorizationApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &AuthorizationApi{ - Configuration: config, - } -} - -// DeleteAuthorizationDivision invokes DELETE /api/v2/authorization/divisions/{divisionId} -// -// Delete a division. -// -// -func (a AuthorizationApi) DeleteAuthorizationDivision(divisionId string, force bool) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/authorization/divisions/{divisionId}" - path = strings.Replace(path, "{divisionId}", fmt.Sprintf("%v", divisionId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'divisionId' is set - if &divisionId == nil { - // - return nil, errors.New("Missing required parameter 'divisionId' when calling AuthorizationApi->DeleteAuthorizationDivision") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(force).(string); ok { - if str != "" { - queryParams["force"] = a.Configuration.APIClient.ParameterToString(force, collectionFormat) - } - } else { - queryParams["force"] = a.Configuration.APIClient.ParameterToString(force, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteAuthorizationRole invokes DELETE /api/v2/authorization/roles/{roleId} -// -// Delete an organization role. -// -// -func (a AuthorizationApi) DeleteAuthorizationRole(roleId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/authorization/roles/{roleId}" - path = strings.Replace(path, "{roleId}", fmt.Sprintf("%v", roleId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'roleId' is set - if &roleId == nil { - // - return nil, errors.New("Missing required parameter 'roleId' when calling AuthorizationApi->DeleteAuthorizationRole") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteAuthorizationSubjectDivisionRole invokes DELETE /api/v2/authorization/subjects/{subjectId}/divisions/{divisionId}/roles/{roleId} -// -// Delete a grant of a role in a division -// -// -func (a AuthorizationApi) DeleteAuthorizationSubjectDivisionRole(subjectId string, divisionId string, roleId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/authorization/subjects/{subjectId}/divisions/{divisionId}/roles/{roleId}" - path = strings.Replace(path, "{subjectId}", fmt.Sprintf("%v", subjectId), -1) - path = strings.Replace(path, "{divisionId}", fmt.Sprintf("%v", divisionId), -1) - path = strings.Replace(path, "{roleId}", fmt.Sprintf("%v", roleId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'subjectId' is set - if &subjectId == nil { - // - return nil, errors.New("Missing required parameter 'subjectId' when calling AuthorizationApi->DeleteAuthorizationSubjectDivisionRole") - } - // verify the required parameter 'divisionId' is set - if &divisionId == nil { - // - return nil, errors.New("Missing required parameter 'divisionId' when calling AuthorizationApi->DeleteAuthorizationSubjectDivisionRole") - } - // verify the required parameter 'roleId' is set - if &roleId == nil { - // - return nil, errors.New("Missing required parameter 'roleId' when calling AuthorizationApi->DeleteAuthorizationSubjectDivisionRole") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// GetAuthorizationDivision invokes GET /api/v2/authorization/divisions/{divisionId} -// -// Returns an authorization division. -// -// -func (a AuthorizationApi) GetAuthorizationDivision(divisionId string, objectCount bool) (*Authzdivision, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/authorization/divisions/{divisionId}" - path = strings.Replace(path, "{divisionId}", fmt.Sprintf("%v", divisionId), -1) - defaultReturn := new(Authzdivision) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'divisionId' is set - if &divisionId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'divisionId' when calling AuthorizationApi->GetAuthorizationDivision") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(objectCount).(string); ok { - if str != "" { - queryParams["objectCount"] = a.Configuration.APIClient.ParameterToString(objectCount, collectionFormat) - } - } else { - queryParams["objectCount"] = a.Configuration.APIClient.ParameterToString(objectCount, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Authzdivision - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAuthorizationDivisionGrants invokes GET /api/v2/authorization/divisions/{divisionId}/grants -// -// Gets all grants for a given division. -// -// Returns all grants assigned to a given division. Maximum page size is 500. -func (a AuthorizationApi) GetAuthorizationDivisionGrants(divisionId string, pageNumber int, pageSize int) (*Authzdivisiongrantentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/authorization/divisions/{divisionId}/grants" - path = strings.Replace(path, "{divisionId}", fmt.Sprintf("%v", divisionId), -1) - defaultReturn := new(Authzdivisiongrantentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'divisionId' is set - if &divisionId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'divisionId' when calling AuthorizationApi->GetAuthorizationDivisionGrants") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Authzdivisiongrantentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAuthorizationDivisions invokes GET /api/v2/authorization/divisions -// -// Retrieve a list of all divisions defined for the organization -// -// Request specific divisions by id using a query param \"id\", e.g. ?id=5f777167-63be-4c24-ad41-374155d9e28b&id=72e9fb25-c484-488d-9312-7acba82435b3 -func (a AuthorizationApi) GetAuthorizationDivisions(pageSize int, pageNumber int, sortBy string, expand []string, nextPage string, previousPage string, objectCount bool, id []string, name string) (*Authzdivisionentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/authorization/divisions" - defaultReturn := new(Authzdivisionentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(nextPage).(string); ok { - if str != "" { - queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) - } - } else { - queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(previousPage).(string); ok { - if str != "" { - queryParams["previousPage"] = a.Configuration.APIClient.ParameterToString(previousPage, collectionFormat) - } - } else { - queryParams["previousPage"] = a.Configuration.APIClient.ParameterToString(previousPage, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(objectCount).(string); ok { - if str != "" { - queryParams["objectCount"] = a.Configuration.APIClient.ParameterToString(objectCount, collectionFormat) - } - } else { - queryParams["objectCount"] = a.Configuration.APIClient.ParameterToString(objectCount, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range id { - queryParams["id"] = value - } - } else { - queryParams["id"] = a.Configuration.APIClient.ParameterToString(id, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Authzdivisionentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAuthorizationDivisionsHome invokes GET /api/v2/authorization/divisions/home -// -// Retrieve the home division for the organization. -// -// Will not include object counts. -func (a AuthorizationApi) GetAuthorizationDivisionsHome() (*Authzdivision, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/authorization/divisions/home" - defaultReturn := new(Authzdivision) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Authzdivision - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAuthorizationDivisionsLimit invokes GET /api/v2/authorization/divisions/limit -// -// Returns the maximum allowed number of divisions. -// -// -func (a AuthorizationApi) GetAuthorizationDivisionsLimit() (*int, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/authorization/divisions/limit" - defaultReturn := new(int) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *int - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAuthorizationDivisionspermittedMe invokes GET /api/v2/authorization/divisionspermitted/me -// -// Returns which divisions the current user has the given permission in. -// -// This route is deprecated, use authorization/divisionspermitted/paged/me instead. -func (a AuthorizationApi) GetAuthorizationDivisionspermittedMe(permission string, name string) ([]Authzdivision, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/authorization/divisionspermitted/me" - defaultReturn := make([]Authzdivision, 0) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'permission' is set - if &permission == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'permission' when calling AuthorizationApi->GetAuthorizationDivisionspermittedMe") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(permission).(string); ok { - if str != "" { - queryParams["permission"] = a.Configuration.APIClient.ParameterToString(permission, collectionFormat) - } - } else { - queryParams["permission"] = a.Configuration.APIClient.ParameterToString(permission, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload []Authzdivision - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAuthorizationDivisionspermittedPagedMe invokes GET /api/v2/authorization/divisionspermitted/paged/me -// -// Returns which divisions the current user has the given permission in. -// -// -func (a AuthorizationApi) GetAuthorizationDivisionspermittedPagedMe(permission string, pageNumber int, pageSize int) (*Divspermittedentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/authorization/divisionspermitted/paged/me" - defaultReturn := new(Divspermittedentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'permission' is set - if &permission == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'permission' when calling AuthorizationApi->GetAuthorizationDivisionspermittedPagedMe") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(permission).(string); ok { - if str != "" { - queryParams["permission"] = a.Configuration.APIClient.ParameterToString(permission, collectionFormat) - } - } else { - queryParams["permission"] = a.Configuration.APIClient.ParameterToString(permission, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Divspermittedentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAuthorizationDivisionspermittedPagedSubjectId invokes GET /api/v2/authorization/divisionspermitted/paged/{subjectId} -// -// Returns which divisions the specified user has the given permission in. -// -// This route is deprecated, use authorization/divisionspermitted/paged/me instead. -func (a AuthorizationApi) GetAuthorizationDivisionspermittedPagedSubjectId(subjectId string, permission string, pageNumber int, pageSize int) (*Divspermittedentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/authorization/divisionspermitted/paged/{subjectId}" - path = strings.Replace(path, "{subjectId}", fmt.Sprintf("%v", subjectId), -1) - defaultReturn := new(Divspermittedentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'subjectId' is set - if &subjectId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'subjectId' when calling AuthorizationApi->GetAuthorizationDivisionspermittedPagedSubjectId") - } - // verify the required parameter 'permission' is set - if &permission == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'permission' when calling AuthorizationApi->GetAuthorizationDivisionspermittedPagedSubjectId") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(permission).(string); ok { - if str != "" { - queryParams["permission"] = a.Configuration.APIClient.ParameterToString(permission, collectionFormat) - } - } else { - queryParams["permission"] = a.Configuration.APIClient.ParameterToString(permission, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Divspermittedentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAuthorizationPermissions invokes GET /api/v2/authorization/permissions -// -// Get all permissions. -// -// Retrieve a list of all permission defined in the system. -func (a AuthorizationApi) GetAuthorizationPermissions(pageSize int, pageNumber int, queryType string, query string) (*Permissioncollectionentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/authorization/permissions" - defaultReturn := new(Permissioncollectionentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(queryType).(string); ok { - if str != "" { - queryParams["queryType"] = a.Configuration.APIClient.ParameterToString(queryType, collectionFormat) - } - } else { - queryParams["queryType"] = a.Configuration.APIClient.ParameterToString(queryType, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(query).(string); ok { - if str != "" { - queryParams["query"] = a.Configuration.APIClient.ParameterToString(query, collectionFormat) - } - } else { - queryParams["query"] = a.Configuration.APIClient.ParameterToString(query, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Permissioncollectionentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAuthorizationProducts invokes GET /api/v2/authorization/products -// -// Get the list of enabled products -// -// Gets the list of enabled products. Some example product names are: collaborateFree, collaboratePro, communicate, and engage. -func (a AuthorizationApi) GetAuthorizationProducts() (*Organizationproductentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/authorization/products" - defaultReturn := new(Organizationproductentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Organizationproductentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAuthorizationRole invokes GET /api/v2/authorization/roles/{roleId} -// -// Get a single organization role. -// -// Get the organization role specified by its ID. -func (a AuthorizationApi) GetAuthorizationRole(roleId string, expand []string) (*Domainorganizationrole, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/authorization/roles/{roleId}" - path = strings.Replace(path, "{roleId}", fmt.Sprintf("%v", roleId), -1) - defaultReturn := new(Domainorganizationrole) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'roleId' is set - if &roleId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'roleId' when calling AuthorizationApi->GetAuthorizationRole") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Domainorganizationrole - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAuthorizationRoleComparedefaultRightRoleId invokes GET /api/v2/authorization/roles/{leftRoleId}/comparedefault/{rightRoleId} -// -// Get an org role to default role comparison -// -// Compares any organization role to a default role id and show differences -func (a AuthorizationApi) GetAuthorizationRoleComparedefaultRightRoleId(leftRoleId string, rightRoleId string) (*Domainorgroledifference, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/authorization/roles/{leftRoleId}/comparedefault/{rightRoleId}" - path = strings.Replace(path, "{leftRoleId}", fmt.Sprintf("%v", leftRoleId), -1) - path = strings.Replace(path, "{rightRoleId}", fmt.Sprintf("%v", rightRoleId), -1) - defaultReturn := new(Domainorgroledifference) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'leftRoleId' is set - if &leftRoleId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'leftRoleId' when calling AuthorizationApi->GetAuthorizationRoleComparedefaultRightRoleId") - } - // verify the required parameter 'rightRoleId' is set - if &rightRoleId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'rightRoleId' when calling AuthorizationApi->GetAuthorizationRoleComparedefaultRightRoleId") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Domainorgroledifference - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAuthorizationRoleSubjectgrants invokes GET /api/v2/authorization/roles/{roleId}/subjectgrants -// -// Get the subjects' granted divisions in the specified role. -// -// Includes the divisions for which the subject has a grant. -func (a AuthorizationApi) GetAuthorizationRoleSubjectgrants(roleId string, pageSize int, pageNumber int, sortBy string, expand []string, nextPage string, previousPage string) (*Subjectdivisiongrantsentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/authorization/roles/{roleId}/subjectgrants" - path = strings.Replace(path, "{roleId}", fmt.Sprintf("%v", roleId), -1) - defaultReturn := new(Subjectdivisiongrantsentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'roleId' is set - if &roleId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'roleId' when calling AuthorizationApi->GetAuthorizationRoleSubjectgrants") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(nextPage).(string); ok { - if str != "" { - queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) - } - } else { - queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(previousPage).(string); ok { - if str != "" { - queryParams["previousPage"] = a.Configuration.APIClient.ParameterToString(previousPage, collectionFormat) - } - } else { - queryParams["previousPage"] = a.Configuration.APIClient.ParameterToString(previousPage, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Subjectdivisiongrantsentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAuthorizationRoleUsers invokes GET /api/v2/authorization/roles/{roleId}/users -// -// Get a list of the users in a specified role. -// -// Get an array of the UUIDs of the users in the specified role. -func (a AuthorizationApi) GetAuthorizationRoleUsers(roleId string, pageSize int, pageNumber int) (*Userentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/authorization/roles/{roleId}/users" - path = strings.Replace(path, "{roleId}", fmt.Sprintf("%v", roleId), -1) - defaultReturn := new(Userentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'roleId' is set - if &roleId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'roleId' when calling AuthorizationApi->GetAuthorizationRoleUsers") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Userentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAuthorizationRoles invokes GET /api/v2/authorization/roles -// -// Retrieve a list of all roles defined for the organization -// -// -func (a AuthorizationApi) GetAuthorizationRoles(pageSize int, pageNumber int, sortBy string, expand []string, nextPage string, previousPage string, name string, permission []string, defaultRoleId []string, userCount bool, id []string) (*Organizationroleentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/authorization/roles" - defaultReturn := new(Organizationroleentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(nextPage).(string); ok { - if str != "" { - queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) - } - } else { - queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(previousPage).(string); ok { - if str != "" { - queryParams["previousPage"] = a.Configuration.APIClient.ParameterToString(previousPage, collectionFormat) - } - } else { - queryParams["previousPage"] = a.Configuration.APIClient.ParameterToString(previousPage, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range permission { - queryParams["permission"] = value - } - } else { - queryParams["permission"] = a.Configuration.APIClient.ParameterToString(permission, collectionFormat) - } - - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range defaultRoleId { - queryParams["defaultRoleId"] = value - } - } else { - queryParams["defaultRoleId"] = a.Configuration.APIClient.ParameterToString(defaultRoleId, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(userCount).(string); ok { - if str != "" { - queryParams["userCount"] = a.Configuration.APIClient.ParameterToString(userCount, collectionFormat) - } - } else { - queryParams["userCount"] = a.Configuration.APIClient.ParameterToString(userCount, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range id { - queryParams["id"] = value - } - } else { - queryParams["id"] = a.Configuration.APIClient.ParameterToString(id, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Organizationroleentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAuthorizationSubject invokes GET /api/v2/authorization/subjects/{subjectId} -// -// Returns a listing of roles and permissions for a user. -// -// -func (a AuthorizationApi) GetAuthorizationSubject(subjectId string) (*Authzsubject, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/authorization/subjects/{subjectId}" - path = strings.Replace(path, "{subjectId}", fmt.Sprintf("%v", subjectId), -1) - defaultReturn := new(Authzsubject) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'subjectId' is set - if &subjectId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'subjectId' when calling AuthorizationApi->GetAuthorizationSubject") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Authzsubject - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAuthorizationSubjectsMe invokes GET /api/v2/authorization/subjects/me -// -// Returns a listing of roles and permissions for the currently authenticated user. -// -// -func (a AuthorizationApi) GetAuthorizationSubjectsMe() (*Authzsubject, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/authorization/subjects/me" - defaultReturn := new(Authzsubject) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Authzsubject - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAuthorizationSubjectsRolecounts invokes GET /api/v2/authorization/subjects/rolecounts -// -// Get the count of roles granted to a list of subjects -// -// -func (a AuthorizationApi) GetAuthorizationSubjectsRolecounts(id []string) (*map[string]interface{}, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/authorization/subjects/rolecounts" - defaultReturn := new(map[string]interface{}) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range id { - queryParams["id"] = value - } - } else { - queryParams["id"] = a.Configuration.APIClient.ParameterToString(id, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *map[string]interface{} - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetUserRoles invokes GET /api/v2/users/{userId}/roles -// -// Returns a listing of roles and permissions for a user. -// -// -func (a AuthorizationApi) GetUserRoles(userId string) (*Userauthorization, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/roles" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Userauthorization) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling AuthorizationApi->GetUserRoles") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Userauthorization - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchAuthorizationRole invokes PATCH /api/v2/authorization/roles/{roleId} -// -// Patch Organization Role for needsUpdate Field -// -// Patch Organization Role for needsUpdate Field -func (a AuthorizationApi) PatchAuthorizationRole(roleId string, body Domainorganizationrole) (*Domainorganizationrole, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/authorization/roles/{roleId}" - path = strings.Replace(path, "{roleId}", fmt.Sprintf("%v", roleId), -1) - defaultReturn := new(Domainorganizationrole) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'roleId' is set - if &roleId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'roleId' when calling AuthorizationApi->PatchAuthorizationRole") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling AuthorizationApi->PatchAuthorizationRole") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Domainorganizationrole - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostAuthorizationDivisionObject invokes POST /api/v2/authorization/divisions/{divisionId}/objects/{objectType} -// -// Assign a list of objects to a division -// -// Set the division of a specified list of objects. The objects must all be of the same type, one of: CAMPAIGN, MANAGEMENTUNIT, FLOW, QUEUE, or USER. The body of the request is a list of object IDs, which are expected to be GUIDs, e.g. [\"206ce31f-61ec-40ed-a8b1-be6f06303998\",\"250a754e-f5e4-4f51-800f-a92f09d3bf8c\"] -func (a AuthorizationApi) PostAuthorizationDivisionObject(divisionId string, objectType string, body []string) (*APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/authorization/divisions/{divisionId}/objects/{objectType}" - path = strings.Replace(path, "{divisionId}", fmt.Sprintf("%v", divisionId), -1) - path = strings.Replace(path, "{objectType}", fmt.Sprintf("%v", objectType), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'divisionId' is set - if &divisionId == nil { - // - return nil, errors.New("Missing required parameter 'divisionId' when calling AuthorizationApi->PostAuthorizationDivisionObject") - } - // verify the required parameter 'objectType' is set - if &objectType == nil { - // - return nil, errors.New("Missing required parameter 'objectType' when calling AuthorizationApi->PostAuthorizationDivisionObject") - } - // verify the required parameter 'body' is set - if &body == nil { - // true - return nil, errors.New("Missing required parameter 'body' when calling AuthorizationApi->PostAuthorizationDivisionObject") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// PostAuthorizationDivisions invokes POST /api/v2/authorization/divisions -// -// Create a division. -// -// -func (a AuthorizationApi) PostAuthorizationDivisions(body Authzdivision) (*Authzdivision, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/authorization/divisions" - defaultReturn := new(Authzdivision) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling AuthorizationApi->PostAuthorizationDivisions") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Authzdivision - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostAuthorizationRole invokes POST /api/v2/authorization/roles/{roleId} -// -// Bulk-grant subjects and divisions with an organization role. -// -// -func (a AuthorizationApi) PostAuthorizationRole(roleId string, body Subjectdivisions, subjectType string) (*APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/authorization/roles/{roleId}" - path = strings.Replace(path, "{roleId}", fmt.Sprintf("%v", roleId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'roleId' is set - if &roleId == nil { - // - return nil, errors.New("Missing required parameter 'roleId' when calling AuthorizationApi->PostAuthorizationRole") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return nil, errors.New("Missing required parameter 'body' when calling AuthorizationApi->PostAuthorizationRole") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(subjectType).(string); ok { - if str != "" { - queryParams["subjectType"] = a.Configuration.APIClient.ParameterToString(subjectType, collectionFormat) - } - } else { - queryParams["subjectType"] = a.Configuration.APIClient.ParameterToString(subjectType, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// PostAuthorizationRoleComparedefaultRightRoleId invokes POST /api/v2/authorization/roles/{leftRoleId}/comparedefault/{rightRoleId} -// -// Get an unsaved org role to default role comparison -// -// Allows users to compare their existing roles in an unsaved state to its default role -func (a AuthorizationApi) PostAuthorizationRoleComparedefaultRightRoleId(leftRoleId string, rightRoleId string, body Domainorganizationrole) (*Domainorgroledifference, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/authorization/roles/{leftRoleId}/comparedefault/{rightRoleId}" - path = strings.Replace(path, "{leftRoleId}", fmt.Sprintf("%v", leftRoleId), -1) - path = strings.Replace(path, "{rightRoleId}", fmt.Sprintf("%v", rightRoleId), -1) - defaultReturn := new(Domainorgroledifference) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'leftRoleId' is set - if &leftRoleId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'leftRoleId' when calling AuthorizationApi->PostAuthorizationRoleComparedefaultRightRoleId") - } - // verify the required parameter 'rightRoleId' is set - if &rightRoleId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'rightRoleId' when calling AuthorizationApi->PostAuthorizationRoleComparedefaultRightRoleId") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling AuthorizationApi->PostAuthorizationRoleComparedefaultRightRoleId") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Domainorgroledifference - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostAuthorizationRoles invokes POST /api/v2/authorization/roles -// -// Create an organization role. -// -// -func (a AuthorizationApi) PostAuthorizationRoles(body Domainorganizationrolecreate) (*Domainorganizationrole, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/authorization/roles" - defaultReturn := new(Domainorganizationrole) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling AuthorizationApi->PostAuthorizationRoles") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Domainorganizationrole - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostAuthorizationRolesDefault invokes POST /api/v2/authorization/roles/default -// -// Restores all default roles -// -// This endpoint serves several purposes. 1. It provides the org with default roles. This is important for default roles that will be added after go-live (they can retroactively add the new default-role). Note: When not using a query param of force=true, it only adds the default roles not configured for the org; it does not overwrite roles. 2. Using the query param force=true, you can restore all default roles. Note: This does not have an effect on custom roles. -func (a AuthorizationApi) PostAuthorizationRolesDefault(force bool) (*Organizationroleentitylisting, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/authorization/roles/default" - defaultReturn := new(Organizationroleentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(force).(string); ok { - if str != "" { - queryParams["force"] = a.Configuration.APIClient.ParameterToString(force, collectionFormat) - } - } else { - queryParams["force"] = a.Configuration.APIClient.ParameterToString(force, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Organizationroleentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostAuthorizationSubjectBulkadd invokes POST /api/v2/authorization/subjects/{subjectId}/bulkadd -// -// Bulk-grant roles and divisions to a subject. -// -// -func (a AuthorizationApi) PostAuthorizationSubjectBulkadd(subjectId string, body Roledivisiongrants, subjectType string) (*APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/authorization/subjects/{subjectId}/bulkadd" - path = strings.Replace(path, "{subjectId}", fmt.Sprintf("%v", subjectId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'subjectId' is set - if &subjectId == nil { - // - return nil, errors.New("Missing required parameter 'subjectId' when calling AuthorizationApi->PostAuthorizationSubjectBulkadd") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return nil, errors.New("Missing required parameter 'body' when calling AuthorizationApi->PostAuthorizationSubjectBulkadd") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(subjectType).(string); ok { - if str != "" { - queryParams["subjectType"] = a.Configuration.APIClient.ParameterToString(subjectType, collectionFormat) - } - } else { - queryParams["subjectType"] = a.Configuration.APIClient.ParameterToString(subjectType, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// PostAuthorizationSubjectBulkremove invokes POST /api/v2/authorization/subjects/{subjectId}/bulkremove -// -// Bulk-remove grants from a subject. -// -// -func (a AuthorizationApi) PostAuthorizationSubjectBulkremove(subjectId string, body Roledivisiongrants) (*APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/authorization/subjects/{subjectId}/bulkremove" - path = strings.Replace(path, "{subjectId}", fmt.Sprintf("%v", subjectId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'subjectId' is set - if &subjectId == nil { - // - return nil, errors.New("Missing required parameter 'subjectId' when calling AuthorizationApi->PostAuthorizationSubjectBulkremove") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return nil, errors.New("Missing required parameter 'body' when calling AuthorizationApi->PostAuthorizationSubjectBulkremove") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// PostAuthorizationSubjectDivisionRole invokes POST /api/v2/authorization/subjects/{subjectId}/divisions/{divisionId}/roles/{roleId} -// -// Make a grant of a role in a division -// -// -func (a AuthorizationApi) PostAuthorizationSubjectDivisionRole(subjectId string, divisionId string, roleId string, subjectType string) (*APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/authorization/subjects/{subjectId}/divisions/{divisionId}/roles/{roleId}" - path = strings.Replace(path, "{subjectId}", fmt.Sprintf("%v", subjectId), -1) - path = strings.Replace(path, "{divisionId}", fmt.Sprintf("%v", divisionId), -1) - path = strings.Replace(path, "{roleId}", fmt.Sprintf("%v", roleId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'subjectId' is set - if &subjectId == nil { - // - return nil, errors.New("Missing required parameter 'subjectId' when calling AuthorizationApi->PostAuthorizationSubjectDivisionRole") - } - // verify the required parameter 'divisionId' is set - if &divisionId == nil { - // - return nil, errors.New("Missing required parameter 'divisionId' when calling AuthorizationApi->PostAuthorizationSubjectDivisionRole") - } - // verify the required parameter 'roleId' is set - if &roleId == nil { - // - return nil, errors.New("Missing required parameter 'roleId' when calling AuthorizationApi->PostAuthorizationSubjectDivisionRole") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(subjectType).(string); ok { - if str != "" { - queryParams["subjectType"] = a.Configuration.APIClient.ParameterToString(subjectType, collectionFormat) - } - } else { - queryParams["subjectType"] = a.Configuration.APIClient.ParameterToString(subjectType, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// PutAuthorizationDivision invokes PUT /api/v2/authorization/divisions/{divisionId} -// -// Update a division. -// -// -func (a AuthorizationApi) PutAuthorizationDivision(divisionId string, body Authzdivision) (*Authzdivision, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/authorization/divisions/{divisionId}" - path = strings.Replace(path, "{divisionId}", fmt.Sprintf("%v", divisionId), -1) - defaultReturn := new(Authzdivision) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'divisionId' is set - if &divisionId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'divisionId' when calling AuthorizationApi->PutAuthorizationDivision") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling AuthorizationApi->PutAuthorizationDivision") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Authzdivision - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutAuthorizationRole invokes PUT /api/v2/authorization/roles/{roleId} -// -// Update an organization role. -// -// Update -func (a AuthorizationApi) PutAuthorizationRole(roleId string, body Domainorganizationroleupdate) (*Domainorganizationrole, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/authorization/roles/{roleId}" - path = strings.Replace(path, "{roleId}", fmt.Sprintf("%v", roleId), -1) - defaultReturn := new(Domainorganizationrole) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'roleId' is set - if &roleId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'roleId' when calling AuthorizationApi->PutAuthorizationRole") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling AuthorizationApi->PutAuthorizationRole") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Domainorganizationrole - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutAuthorizationRoleUsersAdd invokes PUT /api/v2/authorization/roles/{roleId}/users/add -// -// Sets the users for the role -// -// -func (a AuthorizationApi) PutAuthorizationRoleUsersAdd(roleId string, body []string) ([]string, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/authorization/roles/{roleId}/users/add" - path = strings.Replace(path, "{roleId}", fmt.Sprintf("%v", roleId), -1) - defaultReturn := make([]string, 0) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'roleId' is set - if &roleId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'roleId' when calling AuthorizationApi->PutAuthorizationRoleUsersAdd") - } - // verify the required parameter 'body' is set - if &body == nil { - // true - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling AuthorizationApi->PutAuthorizationRoleUsersAdd") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload []string - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutAuthorizationRoleUsersRemove invokes PUT /api/v2/authorization/roles/{roleId}/users/remove -// -// Removes the users from the role -// -// -func (a AuthorizationApi) PutAuthorizationRoleUsersRemove(roleId string, body []string) ([]string, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/authorization/roles/{roleId}/users/remove" - path = strings.Replace(path, "{roleId}", fmt.Sprintf("%v", roleId), -1) - defaultReturn := make([]string, 0) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'roleId' is set - if &roleId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'roleId' when calling AuthorizationApi->PutAuthorizationRoleUsersRemove") - } - // verify the required parameter 'body' is set - if &body == nil { - // true - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling AuthorizationApi->PutAuthorizationRoleUsersRemove") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload []string - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutAuthorizationRolesDefault invokes PUT /api/v2/authorization/roles/default -// -// Restore specified default roles -// -// -func (a AuthorizationApi) PutAuthorizationRolesDefault(body []Domainorganizationrole) (*Organizationroleentitylisting, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/authorization/roles/default" - defaultReturn := new(Organizationroleentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // true - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling AuthorizationApi->PutAuthorizationRolesDefault") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Organizationroleentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutUserRoles invokes PUT /api/v2/users/{userId}/roles -// -// Sets the user's roles -// -// -func (a AuthorizationApi) PutUserRoles(userId string, body []string) (*Userauthorization, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/roles" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Userauthorization) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling AuthorizationApi->PutUserRoles") - } - // verify the required parameter 'body' is set - if &body == nil { - // true - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling AuthorizationApi->PutUserRoles") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Userauthorization - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/authzdivision.go b/build/platformclientv2/authzdivision.go deleted file mode 100644 index b4281ed69..000000000 --- a/build/platformclientv2/authzdivision.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Authzdivision -type Authzdivision struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Description - A helpful description for the division. - Description *string `json:"description,omitempty"` - - - // HomeDivision - A flag indicating whether this division is the \"Home\" (default) division. Cannot be modified and any supplied value will be ignored on create or update. - HomeDivision *bool `json:"homeDivision,omitempty"` - - - // ObjectCounts - A count of objects in this division, grouped by type. - ObjectCounts *map[string]int `json:"objectCounts,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Authzdivision) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/authzdivisionentitylisting.go b/build/platformclientv2/authzdivisionentitylisting.go deleted file mode 100644 index 031239de7..000000000 --- a/build/platformclientv2/authzdivisionentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Authzdivisionentitylisting -type Authzdivisionentitylisting struct { - // Entities - Entities *[]Authzdivision `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Authzdivisionentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/authzdivisiongrantentitylisting.go b/build/platformclientv2/authzdivisiongrantentitylisting.go deleted file mode 100644 index df4f4b8a3..000000000 --- a/build/platformclientv2/authzdivisiongrantentitylisting.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Authzdivisiongrantentitylisting -type Authzdivisiongrantentitylisting struct { - // Entities - Entities *[]Authzgrant `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Authzdivisiongrantentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/authzgrant.go b/build/platformclientv2/authzgrant.go deleted file mode 100644 index 1c4409ebd..000000000 --- a/build/platformclientv2/authzgrant.go +++ /dev/null @@ -1,30 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Authzgrant -type Authzgrant struct { - // SubjectId - SubjectId *string `json:"subjectId,omitempty"` - - - // Division - Division *Authzdivision `json:"division,omitempty"` - - - // Role - Role *Authzgrantrole `json:"role,omitempty"` - - - // GrantMadeAt - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - GrantMadeAt *time.Time `json:"grantMadeAt,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Authzgrant) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/authzgrantpolicy.go b/build/platformclientv2/authzgrantpolicy.go deleted file mode 100644 index 76363095b..000000000 --- a/build/platformclientv2/authzgrantpolicy.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Authzgrantpolicy -type Authzgrantpolicy struct { - // Actions - Actions *[]string `json:"actions,omitempty"` - - - // Condition - Condition *string `json:"condition,omitempty"` - - - // Domain - Domain *string `json:"domain,omitempty"` - - - // EntityName - EntityName *string `json:"entityName,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Authzgrantpolicy) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/authzgrantrole.go b/build/platformclientv2/authzgrantrole.go deleted file mode 100644 index 3fd94f9c2..000000000 --- a/build/platformclientv2/authzgrantrole.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Authzgrantrole -type Authzgrantrole struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Description - Description *string `json:"description,omitempty"` - - - // Policies - Policies *[]Authzgrantpolicy `json:"policies,omitempty"` - - - // VarDefault - VarDefault *bool `json:"default,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Authzgrantrole) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/authzsubject.go b/build/platformclientv2/authzsubject.go deleted file mode 100644 index 1304b05f1..000000000 --- a/build/platformclientv2/authzsubject.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Authzsubject -type Authzsubject struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Grants - Grants *[]Authzgrant `json:"grants,omitempty"` - - - // Version - Version *int `json:"version,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Authzsubject) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/automatictimezonemappingsettings.go b/build/platformclientv2/automatictimezonemappingsettings.go deleted file mode 100644 index b16cffdfe..000000000 --- a/build/platformclientv2/automatictimezonemappingsettings.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Automatictimezonemappingsettings -type Automatictimezonemappingsettings struct { - // CallableWindows - The time intervals to use for automatic time zone mapping. - CallableWindows *[]Callablewindow `json:"callableWindows,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Automatictimezonemappingsettings) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/availablelanguagelist.go b/build/platformclientv2/availablelanguagelist.go deleted file mode 100644 index afc4bffa7..000000000 --- a/build/platformclientv2/availablelanguagelist.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Availablelanguagelist -type Availablelanguagelist struct { - // Languages - Languages *[]string `json:"languages,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Availablelanguagelist) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/availabletopic.go b/build/platformclientv2/availabletopic.go deleted file mode 100644 index 14bcecf34..000000000 --- a/build/platformclientv2/availabletopic.go +++ /dev/null @@ -1,57 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Availabletopic -type Availabletopic struct { - // Description - Description *string `json:"description,omitempty"` - - - // Id - Id *string `json:"id,omitempty"` - - - // RequiresPermissions - Permissions required to subscribe to the topic - RequiresPermissions *[]string `json:"requiresPermissions,omitempty"` - - - // RequiresDivisionPermissions - True if the subscribing user must belong to the same division as the topic object ID - RequiresDivisionPermissions *bool `json:"requiresDivisionPermissions,omitempty"` - - - // Enforced - Whether or not the permissions on this topic are enforced - Enforced *bool `json:"enforced,omitempty"` - - - // Visibility - Visibility of this topic (Public or Preview) - Visibility *string `json:"visibility,omitempty"` - - - // Schema - Schema *map[string]interface{} `json:"schema,omitempty"` - - - // RequiresCurrentUser - True if the topic user ID is required to match the subscribing user ID - RequiresCurrentUser *bool `json:"requiresCurrentUser,omitempty"` - - - // RequiresCurrentUserOrPermission - True if permissions are only required when the topic user ID does not match the subscribing user ID - RequiresCurrentUserOrPermission *bool `json:"requiresCurrentUserOrPermission,omitempty"` - - - // Transports - Transports that support events for the topic - Transports *[]string `json:"transports,omitempty"` - - - // PublicApiTemplateUriPaths - PublicApiTemplateUriPaths *[]string `json:"publicApiTemplateUriPaths,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Availabletopic) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/availabletopicentitylisting.go b/build/platformclientv2/availabletopicentitylisting.go deleted file mode 100644 index adf46a032..000000000 --- a/build/platformclientv2/availabletopicentitylisting.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Availabletopicentitylisting -type Availabletopicentitylisting struct { - // Entities - Entities *[]Availabletopic `json:"entities,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Availabletopicentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/availabletranslations.go b/build/platformclientv2/availabletranslations.go deleted file mode 100644 index 4bf8d691c..000000000 --- a/build/platformclientv2/availabletranslations.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Availabletranslations -type Availabletranslations struct { - // OrgSpecific - OrgSpecific *[]string `json:"orgSpecific,omitempty"` - - - // Builtin - Builtin *[]string `json:"builtin,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Availabletranslations) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/batchdownloadjobresult.go b/build/platformclientv2/batchdownloadjobresult.go deleted file mode 100644 index ad5d1783c..000000000 --- a/build/platformclientv2/batchdownloadjobresult.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Batchdownloadjobresult -type Batchdownloadjobresult struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // ConversationId - Conversation id of the result - ConversationId *string `json:"conversationId,omitempty"` - - - // RecordingId - Recording id of the result - RecordingId *string `json:"recordingId,omitempty"` - - - // ResultUrl - URL of results... HTTP GET from this location to download results for this item - ResultUrl *string `json:"resultUrl,omitempty"` - - - // ContentType - Content type of this result - ContentType *string `json:"contentType,omitempty"` - - - // ErrorMsg - An error message, in case of failed processing will indicate the cause of the failure - ErrorMsg *string `json:"errorMsg,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Batchdownloadjobresult) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/batchdownloadjobstatusresult.go b/build/platformclientv2/batchdownloadjobstatusresult.go deleted file mode 100644 index 5e46a722a..000000000 --- a/build/platformclientv2/batchdownloadjobstatusresult.go +++ /dev/null @@ -1,41 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Batchdownloadjobstatusresult -type Batchdownloadjobstatusresult struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // JobId - JobId returned when job was initially submitted - JobId *string `json:"jobId,omitempty"` - - - // ExpectedResultCount - Number of results expected when job is completed - ExpectedResultCount *int `json:"expectedResultCount,omitempty"` - - - // ResultCount - Current number of results available - ResultCount *int `json:"resultCount,omitempty"` - - - // ErrorCount - Number of error results produced so far - ErrorCount *int `json:"errorCount,omitempty"` - - - // Results - Current set of results for the job - Results *[]Batchdownloadjobresult `json:"results,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Batchdownloadjobstatusresult) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/batchdownloadjobsubmission.go b/build/platformclientv2/batchdownloadjobsubmission.go deleted file mode 100644 index b04616faf..000000000 --- a/build/platformclientv2/batchdownloadjobsubmission.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Batchdownloadjobsubmission -type Batchdownloadjobsubmission struct { - // BatchDownloadRequestList - List of up to 100 items requested - BatchDownloadRequestList *[]Batchdownloadrequest `json:"batchDownloadRequestList,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Batchdownloadjobsubmission) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/batchdownloadjobsubmissionresult.go b/build/platformclientv2/batchdownloadjobsubmissionresult.go deleted file mode 100644 index 4166268a2..000000000 --- a/build/platformclientv2/batchdownloadjobsubmissionresult.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Batchdownloadjobsubmissionresult -type Batchdownloadjobsubmissionresult struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Batchdownloadjobsubmissionresult) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/batchdownloadrequest.go b/build/platformclientv2/batchdownloadrequest.go deleted file mode 100644 index 82855e35b..000000000 --- a/build/platformclientv2/batchdownloadrequest.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Batchdownloadrequest -type Batchdownloadrequest struct { - // ConversationId - Conversation id requested - ConversationId *string `json:"conversationId,omitempty"` - - - // RecordingId - Recording id requested, optional. Leave null for all recordings on the conversation - RecordingId *string `json:"recordingId,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Batchdownloadrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/billingapi.go b/build/platformclientv2/billingapi.go deleted file mode 100644 index 49ccf491f..000000000 --- a/build/platformclientv2/billingapi.go +++ /dev/null @@ -1,215 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "time" -"encoding/json" -) - -// BillingApi provides functions for API endpoints -type BillingApi struct { - Configuration *Configuration -} - -// NewBillingApi creates an API instance using the default configuration -func NewBillingApi() *BillingApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating BillingApi with base path: %s", strings.ToLower(config.BasePath))) - return &BillingApi{ - Configuration: config, - } -} - -// NewBillingApiWithConfig creates an API instance using the provided configuration -func NewBillingApiWithConfig(config *Configuration) *BillingApi { - config.Debugf("Creating BillingApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &BillingApi{ - Configuration: config, - } -} - -// GetBillingReportsBillableusage invokes GET /api/v2/billing/reports/billableusage -// -// Get a report of the billable license usages -// -// Report is of the billable usages (e.g. licenses and devices utilized) for a given period. If response's status is InProgress, wait a few seconds, then try the same request again. -func (a BillingApi) GetBillingReportsBillableusage(startDate time.Time, endDate time.Time) (*Billingusagereport, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/billing/reports/billableusage" - defaultReturn := new(Billingusagereport) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'startDate' is set - if &startDate == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'startDate' when calling BillingApi->GetBillingReportsBillableusage") - } - // verify the required parameter 'endDate' is set - if &endDate == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'endDate' when calling BillingApi->GetBillingReportsBillableusage") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(startDate).(string); ok { - if str != "" { - queryParams["startDate"] = a.Configuration.APIClient.ParameterToString(startDate, collectionFormat) - } - } else { - queryParams["startDate"] = a.Configuration.APIClient.ParameterToString(startDate, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(endDate).(string); ok { - if str != "" { - queryParams["endDate"] = a.Configuration.APIClient.ParameterToString(endDate, collectionFormat) - } - } else { - queryParams["endDate"] = a.Configuration.APIClient.ParameterToString(endDate, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Billingusagereport - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetBillingTrusteebillingoverviewTrustorOrgId invokes GET /api/v2/billing/trusteebillingoverview/{trustorOrgId} -// -// Get the billing overview for an organization that is managed by a partner. -// -// Tax Disclaimer: Prices returned by this API do not include applicable taxes. It is the responsibility of the customer to pay all taxes that are appropriate in their jurisdiction. See the PureCloud API Documentation in the Developer Center for more information about this API: https://developer.mypurecloud.com/api/rest/v2/ -func (a BillingApi) GetBillingTrusteebillingoverviewTrustorOrgId(trustorOrgId string, billingPeriodIndex int) (*Trusteebillingoverview, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/billing/trusteebillingoverview/{trustorOrgId}" - path = strings.Replace(path, "{trustorOrgId}", fmt.Sprintf("%v", trustorOrgId), -1) - defaultReturn := new(Trusteebillingoverview) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'trustorOrgId' is set - if &trustorOrgId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'trustorOrgId' when calling BillingApi->GetBillingTrusteebillingoverviewTrustorOrgId") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(billingPeriodIndex).(string); ok { - if str != "" { - queryParams["billingPeriodIndex"] = a.Configuration.APIClient.ParameterToString(billingPeriodIndex, collectionFormat) - } - } else { - queryParams["billingPeriodIndex"] = a.Configuration.APIClient.ParameterToString(billingPeriodIndex, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Trusteebillingoverview - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/billingusage.go b/build/platformclientv2/billingusage.go deleted file mode 100644 index 54f9ed0bb..000000000 --- a/build/platformclientv2/billingusage.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Billingusage -type Billingusage struct { - // Name - Identifies the billable usage. - Name *string `json:"name,omitempty"` - - - // TotalUsage - The total amount of usage, expressed as a decimal number in string format. - TotalUsage *string `json:"totalUsage,omitempty"` - - - // Resources - The resources for which usage was observed (e.g. license users, devices). - Resources *[]Billingusageresource `json:"resources,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Billingusage) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/billingusagereport.go b/build/platformclientv2/billingusagereport.go deleted file mode 100644 index 3f876c047..000000000 --- a/build/platformclientv2/billingusagereport.go +++ /dev/null @@ -1,42 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Billingusagereport -type Billingusagereport struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // StartDate - The period start date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartDate *time.Time `json:"startDate,omitempty"` - - - // EndDate - The period end date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - EndDate *time.Time `json:"endDate,omitempty"` - - - // Status - Generation status of report - Status *string `json:"status,omitempty"` - - - // Usages - The usages for the given period. - Usages *[]Billingusage `json:"usages,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Billingusagereport) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/billingusageresource.go b/build/platformclientv2/billingusageresource.go deleted file mode 100644 index b007c2b91..000000000 --- a/build/platformclientv2/billingusageresource.go +++ /dev/null @@ -1,22 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Billingusageresource -type Billingusageresource struct { - // Name - Identifies the resource (e.g. license user, device). - Name *string `json:"name,omitempty"` - - - // Date - The date that the usage was first observed by the billing subsystem. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - Date *time.Time `json:"date,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Billingusageresource) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/biography.go b/build/platformclientv2/biography.go deleted file mode 100644 index d08e2d4b8..000000000 --- a/build/platformclientv2/biography.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Biography -type Biography struct { - // Biography - Personal detailed description - Biography *string `json:"biography,omitempty"` - - - // Interests - Interests *[]string `json:"interests,omitempty"` - - - // Hobbies - Hobbies *[]string `json:"hobbies,omitempty"` - - - // Spouse - Spouse *string `json:"spouse,omitempty"` - - - // Education - User education details - Education *[]Education `json:"education,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Biography) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/buabandonrate.go b/build/platformclientv2/buabandonrate.go deleted file mode 100644 index 111339a74..000000000 --- a/build/platformclientv2/buabandonrate.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Buabandonrate - Service goal abandon rate configuration -type Buabandonrate struct { - // Include - Whether to include abandon rate in the associated configuration - Include *bool `json:"include,omitempty"` - - - // Percent - Abandon rate percent goal. Required if include == true - Percent *int `json:"percent,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Buabandonrate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/buagentscheduleactivity.go b/build/platformclientv2/buagentscheduleactivity.go deleted file mode 100644 index a6b7d5a82..000000000 --- a/build/platformclientv2/buagentscheduleactivity.go +++ /dev/null @@ -1,46 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Buagentscheduleactivity -type Buagentscheduleactivity struct { - // StartDate - The start date/time of this activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartDate *time.Time `json:"startDate,omitempty"` - - - // LengthMinutes - The length of this activity in minutes - LengthMinutes *int `json:"lengthMinutes,omitempty"` - - - // Description - The description of this activity - Description *string `json:"description,omitempty"` - - - // ActivityCodeId - The ID of the activity code associated with this activity - ActivityCodeId *string `json:"activityCodeId,omitempty"` - - - // Paid - Whether this activity is paid - Paid *bool `json:"paid,omitempty"` - - - // TimeOffRequestId - The ID of the time off request associated with this activity, if applicable - TimeOffRequestId *string `json:"timeOffRequestId,omitempty"` - - - // ExternalActivityId - The ID of the external activity associated with this activity, if applicable - ExternalActivityId *string `json:"externalActivityId,omitempty"` - - - // ExternalActivityType - The type of the external activity associated with this activity, if applicable - ExternalActivityType *string `json:"externalActivityType,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Buagentscheduleactivity) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/buagentschedulehistorychange.go b/build/platformclientv2/buagentschedulehistorychange.go deleted file mode 100644 index 23dbfa178..000000000 --- a/build/platformclientv2/buagentschedulehistorychange.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Buagentschedulehistorychange -type Buagentschedulehistorychange struct { - // Metadata - The metadata of the change, including who and when the change was made - Metadata *Buagentschedulehistorychangemetadata `json:"metadata,omitempty"` - - - // Shifts - The list of changed shifts - Shifts *[]Buagentscheduleshift `json:"shifts,omitempty"` - - - // FullDayTimeOffMarkers - The list of changed full day time off markers - FullDayTimeOffMarkers *[]Bufulldaytimeoffmarker `json:"fullDayTimeOffMarkers,omitempty"` - - - // Deletes - The deleted shifts, full day time off markers, or the entire agent schedule - Deletes *Buagentschedulehistorydeletedchange `json:"deletes,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Buagentschedulehistorychange) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/buagentschedulehistorychangemetadata.go b/build/platformclientv2/buagentschedulehistorychangemetadata.go deleted file mode 100644 index 69072b4b2..000000000 --- a/build/platformclientv2/buagentschedulehistorychangemetadata.go +++ /dev/null @@ -1,22 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Buagentschedulehistorychangemetadata -type Buagentschedulehistorychangemetadata struct { - // DateModified - The timestamp of the schedule change. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // ModifiedBy - The user that made the schedule change - ModifiedBy *Userreference `json:"modifiedBy,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Buagentschedulehistorychangemetadata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/buagentschedulehistorydeletedchange.go b/build/platformclientv2/buagentschedulehistorydeletedchange.go deleted file mode 100644 index 8876a65d8..000000000 --- a/build/platformclientv2/buagentschedulehistorydeletedchange.go +++ /dev/null @@ -1,26 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Buagentschedulehistorydeletedchange -type Buagentschedulehistorydeletedchange struct { - // ShiftIds - The IDs of deleted shifts - ShiftIds *[]string `json:"shiftIds,omitempty"` - - - // FullDayTimeOffMarkerDates - The dates of any deleted full day time off markers - FullDayTimeOffMarkerDates *[]time.Time `json:"fullDayTimeOffMarkerDates,omitempty"` - - - // AgentSchedule - Whether the entire agent schedule was deleted - AgentSchedule *bool `json:"agentSchedule,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Buagentschedulehistorydeletedchange) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/buagentschedulehistorydroppedchange.go b/build/platformclientv2/buagentschedulehistorydroppedchange.go deleted file mode 100644 index bd83fafa3..000000000 --- a/build/platformclientv2/buagentschedulehistorydroppedchange.go +++ /dev/null @@ -1,30 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Buagentschedulehistorydroppedchange -type Buagentschedulehistorydroppedchange struct { - // Metadata - The metadata of the change, including who and when the change was made - Metadata *Buagentschedulehistorychangemetadata `json:"metadata,omitempty"` - - - // ShiftIds - The IDs of deleted shifts - ShiftIds *[]string `json:"shiftIds,omitempty"` - - - // FullDayTimeOffMarkerDates - The dates of any deleted full day time off markers - FullDayTimeOffMarkerDates *[]time.Time `json:"fullDayTimeOffMarkerDates,omitempty"` - - - // Deletes - The deleted shifts, full day time off markers, or the entire agent schedule - Deletes *Buagentschedulehistorydeletedchange `json:"deletes,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Buagentschedulehistorydroppedchange) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/buagentschedulehistoryresponse.go b/build/platformclientv2/buagentschedulehistoryresponse.go deleted file mode 100644 index c491c352c..000000000 --- a/build/platformclientv2/buagentschedulehistoryresponse.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Buagentschedulehistoryresponse -type Buagentschedulehistoryresponse struct { - // PriorPublishedSchedules - The list of previously published schedules - PriorPublishedSchedules *[]Buschedulereference `json:"priorPublishedSchedules,omitempty"` - - - // BasePublishedSchedule - The originally published agent schedules - BasePublishedSchedule *Buagentschedulehistorychange `json:"basePublishedSchedule,omitempty"` - - - // DroppedChanges - The changes dropped from the schedule history. This will happen if the schedule history is too large - DroppedChanges *[]Buagentschedulehistorydroppedchange `json:"droppedChanges,omitempty"` - - - // Changes - The list of changes for the schedule history - Changes *[]Buagentschedulehistorychange `json:"changes,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Buagentschedulehistoryresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/buagentschedulepublishedschedulereference.go b/build/platformclientv2/buagentschedulepublishedschedulereference.go deleted file mode 100644 index 4f665e890..000000000 --- a/build/platformclientv2/buagentschedulepublishedschedulereference.go +++ /dev/null @@ -1,30 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Buagentschedulepublishedschedulereference -type Buagentschedulepublishedschedulereference struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // WeekDate - The start week date for this schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd - WeekDate *time.Time `json:"weekDate,omitempty"` - - - // WeekCount - The number of weeks encompassed by the schedule - WeekCount *int `json:"weekCount,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Buagentschedulepublishedschedulereference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/buagentschedulequeryresponse.go b/build/platformclientv2/buagentschedulequeryresponse.go deleted file mode 100644 index 8566d5df3..000000000 --- a/build/platformclientv2/buagentschedulequeryresponse.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Buagentschedulequeryresponse -type Buagentschedulequeryresponse struct { - // User - The user to whom this agent schedule applies - User *Userreference `json:"user,omitempty"` - - - // Shifts - The shift definitions for this agent schedule - Shifts *[]Buagentscheduleshift `json:"shifts,omitempty"` - - - // FullDayTimeOffMarkers - Full day time off markers which apply to this agent schedule - FullDayTimeOffMarkers *[]Bufulldaytimeoffmarker `json:"fullDayTimeOffMarkers,omitempty"` - - - // WorkPlan - The work plan for this user - WorkPlan *Workplanreference `json:"workPlan,omitempty"` - - - // WorkPlansPerWeek - The work plans per week for this user from the work plan rotation. Null values in the list denotes that user is not part of any work plan for that week - WorkPlansPerWeek *[]Workplanreference `json:"workPlansPerWeek,omitempty"` - - - // Metadata - Versioned entity metadata for this agent schedule - Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Buagentschedulequeryresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/buagentschedulerescheduleresponse.go b/build/platformclientv2/buagentschedulerescheduleresponse.go deleted file mode 100644 index f8b0a845d..000000000 --- a/build/platformclientv2/buagentschedulerescheduleresponse.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Buagentschedulerescheduleresponse -type Buagentschedulerescheduleresponse struct { - // User - The user to whom this agent schedule applies - User *Userreference `json:"user,omitempty"` - - - // Shifts - The shift definitions for this agent schedule - Shifts *[]Buagentscheduleshift `json:"shifts,omitempty"` - - - // FullDayTimeOffMarkers - Full day time off markers which apply to this agent schedule - FullDayTimeOffMarkers *[]Bufulldaytimeoffmarker `json:"fullDayTimeOffMarkers,omitempty"` - - - // WorkPlan - The work plan for this user - WorkPlan *Workplanreference `json:"workPlan,omitempty"` - - - // WorkPlansPerWeek - The work plans per week for this user from the work plan rotation. Null values in the list denotes that user is not part of any work plan for that week - WorkPlansPerWeek *[]Workplanreference `json:"workPlansPerWeek,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Buagentschedulerescheduleresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/buagentschedulesearchresponse.go b/build/platformclientv2/buagentschedulesearchresponse.go deleted file mode 100644 index 2c82bd534..000000000 --- a/build/platformclientv2/buagentschedulesearchresponse.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Buagentschedulesearchresponse -type Buagentschedulesearchresponse struct { - // User - The user to whom this agent schedule applies - User *Userreference `json:"user,omitempty"` - - - // Shifts - The shift definitions for this agent schedule - Shifts *[]Buagentscheduleshift `json:"shifts,omitempty"` - - - // FullDayTimeOffMarkers - Full day time off markers which apply to this agent schedule - FullDayTimeOffMarkers *[]Bufulldaytimeoffmarker `json:"fullDayTimeOffMarkers,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Buagentschedulesearchresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/buagentscheduleshift.go b/build/platformclientv2/buagentscheduleshift.go deleted file mode 100644 index 698929632..000000000 --- a/build/platformclientv2/buagentscheduleshift.go +++ /dev/null @@ -1,38 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Buagentscheduleshift -type Buagentscheduleshift struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // StartDate - The start date of this shift. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartDate *time.Time `json:"startDate,omitempty"` - - - // LengthMinutes - The length of this shift in minutes - LengthMinutes *int `json:"lengthMinutes,omitempty"` - - - // Activities - The activities associated with this shift - Activities *[]Buagentscheduleactivity `json:"activities,omitempty"` - - - // ManuallyEdited - Whether this shift was manually edited. This is only set by clients and is used for rescheduling - ManuallyEdited *bool `json:"manuallyEdited,omitempty"` - - - // Schedule - The schedule to which this shift belongs - Schedule *Buschedulereference `json:"schedule,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Buagentscheduleshift) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/buagentschedulesqueryresponse.go b/build/platformclientv2/buagentschedulesqueryresponse.go deleted file mode 100644 index 4b61c7ea6..000000000 --- a/build/platformclientv2/buagentschedulesqueryresponse.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Buagentschedulesqueryresponse -type Buagentschedulesqueryresponse struct { - // AgentSchedules - The requested agent schedules - AgentSchedules *[]Buagentschedulequeryresponse `json:"agentSchedules,omitempty"` - - - // BusinessUnitTimeZone - The time zone configured for the business unit to which these schedules apply - BusinessUnitTimeZone *string `json:"businessUnitTimeZone,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Buagentschedulesqueryresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/buagentschedulessearchresponse.go b/build/platformclientv2/buagentschedulessearchresponse.go deleted file mode 100644 index 3917979cb..000000000 --- a/build/platformclientv2/buagentschedulessearchresponse.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Buagentschedulessearchresponse -type Buagentschedulessearchresponse struct { - // AgentSchedules - The requested agent schedules - AgentSchedules *[]Buagentschedulesearchresponse `json:"agentSchedules,omitempty"` - - - // BusinessUnitTimeZone - The time zone configured for the business unit to which this schedule applies - BusinessUnitTimeZone *string `json:"businessUnitTimeZone,omitempty"` - - - // PublishedSchedules - References to all published week schedules overlapping the start/end date query parameters - PublishedSchedules *[]Buagentschedulepublishedschedulereference `json:"publishedSchedules,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Buagentschedulessearchresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/buagentscheduleupdate.go b/build/platformclientv2/buagentscheduleupdate.go deleted file mode 100644 index 2c3cba55a..000000000 --- a/build/platformclientv2/buagentscheduleupdate.go +++ /dev/null @@ -1,22 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Buagentscheduleupdate -type Buagentscheduleupdate struct { - // VarType - The type of update - VarType *string `json:"type,omitempty"` - - - // ShiftStartDates - The start date for the affected shifts - ShiftStartDates *[]time.Time `json:"shiftStartDates,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Buagentscheduleupdate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/buasyncagentschedulesqueryresponse.go b/build/platformclientv2/buasyncagentschedulesqueryresponse.go deleted file mode 100644 index 01c53049b..000000000 --- a/build/platformclientv2/buasyncagentschedulesqueryresponse.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Buasyncagentschedulesqueryresponse -type Buasyncagentschedulesqueryresponse struct { - // Status - The status of the operation - Status *string `json:"status,omitempty"` - - - // OperationId - The ID for the operation - OperationId *string `json:"operationId,omitempty"` - - - // Result - The result of the operation. Null unless status == Complete - Result *Buagentschedulesqueryresponse `json:"result,omitempty"` - - - // Progress - Percent progress for the operation - Progress *int `json:"progress,omitempty"` - - - // DownloadUrl - The URL from which to download the result if it is too large to pass directly - DownloadUrl *string `json:"downloadUrl,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Buasyncagentschedulesqueryresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/buasyncagentschedulessearchresponse.go b/build/platformclientv2/buasyncagentschedulessearchresponse.go deleted file mode 100644 index 7779d8347..000000000 --- a/build/platformclientv2/buasyncagentschedulessearchresponse.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Buasyncagentschedulessearchresponse -type Buasyncagentschedulessearchresponse struct { - // Status - The status of the operation - Status *string `json:"status,omitempty"` - - - // OperationId - The ID for the operation - OperationId *string `json:"operationId,omitempty"` - - - // Result - The result of the operation. Null unless status == Complete - Result *Buagentschedulessearchresponse `json:"result,omitempty"` - - - // Progress - Percent progress for the operation - Progress *int `json:"progress,omitempty"` - - - // DownloadUrl - The URL from which to download the result if it is too large to pass directly - DownloadUrl *string `json:"downloadUrl,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Buasyncagentschedulessearchresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/buasyncscheduleresponse.go b/build/platformclientv2/buasyncscheduleresponse.go deleted file mode 100644 index 9b329cbbc..000000000 --- a/build/platformclientv2/buasyncscheduleresponse.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Buasyncscheduleresponse -type Buasyncscheduleresponse struct { - // Status - The status of the operation - Status *string `json:"status,omitempty"` - - - // OperationId - The ID for the operation - OperationId *string `json:"operationId,omitempty"` - - - // Result - The result of the operation. Null unless status == Complete - Result *Buschedulemetadata `json:"result,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Buasyncscheduleresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/buasyncschedulerunresponse.go b/build/platformclientv2/buasyncschedulerunresponse.go deleted file mode 100644 index 9bc40ac49..000000000 --- a/build/platformclientv2/buasyncschedulerunresponse.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Buasyncschedulerunresponse -type Buasyncschedulerunresponse struct { - // Status - The status of the operation - Status *string `json:"status,omitempty"` - - - // OperationId - The ID for the operation - OperationId *string `json:"operationId,omitempty"` - - - // Result - The result of the operation. Null unless status == Complete - Result *Buschedulerun `json:"result,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Buasyncschedulerunresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/buaveragespeedofanswer.go b/build/platformclientv2/buaveragespeedofanswer.go deleted file mode 100644 index bc3359330..000000000 --- a/build/platformclientv2/buaveragespeedofanswer.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Buaveragespeedofanswer - Service goal average speed of answer configuration -type Buaveragespeedofanswer struct { - // Include - Whether to include average speed of answer (ASA) in the associated configuration - Include *bool `json:"include,omitempty"` - - - // Seconds - The target average speed of answer (ASA) in seconds. Required if include == true - Seconds *int `json:"seconds,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Buaveragespeedofanswer) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/bucopyschedulerequest.go b/build/platformclientv2/bucopyschedulerequest.go deleted file mode 100644 index 4425dfaad..000000000 --- a/build/platformclientv2/bucopyschedulerequest.go +++ /dev/null @@ -1,22 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Bucopyschedulerequest -type Bucopyschedulerequest struct { - // Description - The description for the new schedule - Description *string `json:"description,omitempty"` - - - // WeekDate - The start weekDate for the new copy of the schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd - WeekDate *time.Time `json:"weekDate,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Bucopyschedulerequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/bucreateblankschedulerequest.go b/build/platformclientv2/bucreateblankschedulerequest.go deleted file mode 100644 index 2caeb1485..000000000 --- a/build/platformclientv2/bucreateblankschedulerequest.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Bucreateblankschedulerequest -type Bucreateblankschedulerequest struct { - // Description - The description for the schedule - Description *string `json:"description,omitempty"` - - - // ShortTermForecast - The forecast to use when generating the schedule. Note that the forecast must fully encompass the schedule's start week + week count - ShortTermForecast *Bushorttermforecastreference `json:"shortTermForecast,omitempty"` - - - // WeekCount - The number of weeks in the schedule. One extra day is added at the end - WeekCount *int `json:"weekCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Bucreateblankschedulerequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/bucurrentagentschedulesearchresponse.go b/build/platformclientv2/bucurrentagentschedulesearchresponse.go deleted file mode 100644 index b9856c1be..000000000 --- a/build/platformclientv2/bucurrentagentschedulesearchresponse.go +++ /dev/null @@ -1,38 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Bucurrentagentschedulesearchresponse -type Bucurrentagentschedulesearchresponse struct { - // AgentSchedules - The requested agent schedules - AgentSchedules *[]Buagentschedulesearchresponse `json:"agentSchedules,omitempty"` - - - // BusinessUnitTimeZone - The time zone configured for the business unit to which this schedule applies - BusinessUnitTimeZone *string `json:"businessUnitTimeZone,omitempty"` - - - // PublishedSchedules - References to all published week schedules overlapping the start/end date query parameters - PublishedSchedules *[]Buagentschedulepublishedschedulereference `json:"publishedSchedules,omitempty"` - - - // StartDate - The start date of the schedules. Only populated on notifications. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartDate *time.Time `json:"startDate,omitempty"` - - - // EndDate - The end date of the schedules. Only populated on notifications. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - EndDate *time.Time `json:"endDate,omitempty"` - - - // Updates - The list of updates for the schedule. Only used in notifications - Updates *[]Buagentscheduleupdate `json:"updates,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Bucurrentagentschedulesearchresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/buforecastgenerationplanninggroupresult.go b/build/platformclientv2/buforecastgenerationplanninggroupresult.go deleted file mode 100644 index 48833cae2..000000000 --- a/build/platformclientv2/buforecastgenerationplanninggroupresult.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Buforecastgenerationplanninggroupresult -type Buforecastgenerationplanninggroupresult struct { - // PlanningGroupId - The ID of the planning group - PlanningGroupId *string `json:"planningGroupId,omitempty"` - - - // MetricResults - The generation results for the associated planning group - MetricResults *[]Buforecasttimeseriesresult `json:"metricResults,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Buforecastgenerationplanninggroupresult) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/buforecastgenerationresult.go b/build/platformclientv2/buforecastgenerationresult.go deleted file mode 100644 index 41bd960b3..000000000 --- a/build/platformclientv2/buforecastgenerationresult.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Buforecastgenerationresult -type Buforecastgenerationresult struct { - // PlanningGroupResults - Generation results, broken down by planning group - PlanningGroupResults *[]Buforecastgenerationplanninggroupresult `json:"planningGroupResults,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Buforecastgenerationresult) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/buforecastmodification.go b/build/platformclientv2/buforecastmodification.go deleted file mode 100644 index d97b375e4..000000000 --- a/build/platformclientv2/buforecastmodification.go +++ /dev/null @@ -1,57 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Buforecastmodification -type Buforecastmodification struct { - // VarType - The type of the modification - VarType *string `json:"type,omitempty"` - - - // StartIntervalIndex - The number of 15 minute intervals past referenceStartDate representing the first interval to which to apply this modification. Must be null if values is populated - StartIntervalIndex *int `json:"startIntervalIndex,omitempty"` - - - // EndIntervalIndex - The number of 15 minute intervals past referenceStartDate representing the last interval to which to apply this modification. Must be null if values is populated - EndIntervalIndex *int `json:"endIntervalIndex,omitempty"` - - - // Metric - The metric to which this modification applies - Metric *string `json:"metric,omitempty"` - - - // LegacyMetric - The legacy metric to which this modification applies if applicable - LegacyMetric *string `json:"legacyMetric,omitempty"` - - - // Value - The value of the modification. Must be null if \"values\" is populated - Value *float64 `json:"value,omitempty"` - - - // Values - The list of values to update. Only applicable for grid-type modifications. Must be null if \"value\" is populated - Values *[]Wfmforecastmodificationintervaloffsetvalue `json:"values,omitempty"` - - - // DisplayGranularity - The client side display granularity of the modification, expressed in the ISO-8601 duration format. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H - DisplayGranularity *string `json:"displayGranularity,omitempty"` - - - // Granularity - The actual granularity of the modification as stored behind the scenes, expressed in the ISO-8601 duration format. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H - Granularity *string `json:"granularity,omitempty"` - - - // Enabled - Whether the modification is enabled for the forecast - Enabled *bool `json:"enabled,omitempty"` - - - // PlanningGroupIds - The IDs of the planning groups to which this forecast modification applies. Leave empty to apply to all - PlanningGroupIds *[]string `json:"planningGroupIds,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Buforecastmodification) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/buforecastresult.go b/build/platformclientv2/buforecastresult.go deleted file mode 100644 index 301cbf0a4..000000000 --- a/build/platformclientv2/buforecastresult.go +++ /dev/null @@ -1,30 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Buforecastresult -type Buforecastresult struct { - // ReferenceStartDate - The reference start date for interval-based data for this forecast. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ReferenceStartDate *time.Time `json:"referenceStartDate,omitempty"` - - - // PlanningGroups - The forecast data broken up by planning group - PlanningGroups *[]Forecastplanninggroupdata `json:"planningGroups,omitempty"` - - - // WeekNumber - The week number represented by this response - WeekNumber *int `json:"weekNumber,omitempty"` - - - // WeekCount - The number of weeks in this forecast - WeekCount *int `json:"weekCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Buforecastresult) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/buforecastresultresponse.go b/build/platformclientv2/buforecastresultresponse.go deleted file mode 100644 index a5a9f80fb..000000000 --- a/build/platformclientv2/buforecastresultresponse.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Buforecastresultresponse -type Buforecastresultresponse struct { - // Result - The result of the operation. Populated whenever the result is small enough to pass through the api directly - Result *Buforecastresult `json:"result,omitempty"` - - - // DownloadUrl - The download url to fetch the result. Only populated if the result is too large to pass through the api directly - DownloadUrl *string `json:"downloadUrl,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Buforecastresultresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/buforecasttimeseriesresult.go b/build/platformclientv2/buforecasttimeseriesresult.go deleted file mode 100644 index d38268707..000000000 --- a/build/platformclientv2/buforecasttimeseriesresult.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Buforecasttimeseriesresult -type Buforecasttimeseriesresult struct { - // Metric - The metric this result applies to - Metric *string `json:"metric,omitempty"` - - - // ForecastingMethod - The forecasting method that was used for this metric - ForecastingMethod *string `json:"forecastingMethod,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Buforecasttimeseriesresult) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/bufulldaytimeoffmarker.go b/build/platformclientv2/bufulldaytimeoffmarker.go deleted file mode 100644 index fe336e2eb..000000000 --- a/build/platformclientv2/bufulldaytimeoffmarker.go +++ /dev/null @@ -1,38 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Bufulldaytimeoffmarker -type Bufulldaytimeoffmarker struct { - // BusinessUnitDate - The date of the time off marker, interpreted in the business unit's time zone. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd - BusinessUnitDate *time.Time `json:"businessUnitDate,omitempty"` - - - // LengthMinutes - The length of the time off marker in minutes - LengthMinutes *int `json:"lengthMinutes,omitempty"` - - - // Description - The description of the time off marker - Description *string `json:"description,omitempty"` - - - // ActivityCodeId - The ID of the activity code associated with the time off marker - ActivityCodeId *string `json:"activityCodeId,omitempty"` - - - // Paid - Whether the time off marker is paid - Paid *bool `json:"paid,omitempty"` - - - // TimeOffRequestId - The ID of the time off request - TimeOffRequestId *string `json:"timeOffRequestId,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Bufulldaytimeoffmarker) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/bugenerateschedulerequest.go b/build/platformclientv2/bugenerateschedulerequest.go deleted file mode 100644 index 224a658c3..000000000 --- a/build/platformclientv2/bugenerateschedulerequest.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Bugenerateschedulerequest -type Bugenerateschedulerequest struct { - // Description - The description for the schedule - Description *string `json:"description,omitempty"` - - - // ShortTermForecast - The forecast to use when generating the schedule. Note that the forecast must fully encompass the schedule's start week + week count - ShortTermForecast *Bushorttermforecastreference `json:"shortTermForecast,omitempty"` - - - // WeekCount - The number of weeks in the schedule. One extra day is added at the end - WeekCount *int `json:"weekCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Bugenerateschedulerequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/bugetcurrentagentschedulerequest.go b/build/platformclientv2/bugetcurrentagentschedulerequest.go deleted file mode 100644 index 4897db4d1..000000000 --- a/build/platformclientv2/bugetcurrentagentschedulerequest.go +++ /dev/null @@ -1,22 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Bugetcurrentagentschedulerequest -type Bugetcurrentagentschedulerequest struct { - // StartDate - Start date of the range to search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartDate *time.Time `json:"startDate,omitempty"` - - - // EndDate - End date of the range to search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - EndDate *time.Time `json:"endDate,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Bugetcurrentagentschedulerequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/buheadcountforecast.go b/build/platformclientv2/buheadcountforecast.go deleted file mode 100644 index f763527ea..000000000 --- a/build/platformclientv2/buheadcountforecast.go +++ /dev/null @@ -1,22 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Buheadcountforecast -type Buheadcountforecast struct { - // Entities - Entities *[]Buplanninggroupheadcountforecast `json:"entities,omitempty"` - - - // ReferenceStartDate - Reference start date for the interval values in each forecast entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ReferenceStartDate *time.Time `json:"referenceStartDate,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Buheadcountforecast) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/buheadcountforecastresponse.go b/build/platformclientv2/buheadcountforecastresponse.go deleted file mode 100644 index 1dec5484e..000000000 --- a/build/platformclientv2/buheadcountforecastresponse.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Buheadcountforecastresponse -type Buheadcountforecastresponse struct { - // Result - The headcount forecast, null when downloadUrl is provided - Result *Buheadcountforecast `json:"result,omitempty"` - - - // DownloadUrl - Download URL. Null unless the response is too large to pass directly through the api - DownloadUrl *string `json:"downloadUrl,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Buheadcountforecastresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/buintradaydatagroup.go b/build/platformclientv2/buintradaydatagroup.go deleted file mode 100644 index 9af072d1c..000000000 --- a/build/platformclientv2/buintradaydatagroup.go +++ /dev/null @@ -1,41 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Buintradaydatagroup -type Buintradaydatagroup struct { - // MediaType - The media type associated with this intraday group - MediaType *string `json:"mediaType,omitempty"` - - - // ForecastDataSummary - Forecast data summary for this date range - ForecastDataSummary *Buintradayforecastdata `json:"forecastDataSummary,omitempty"` - - - // ForecastDataPerInterval - Forecast data per interval for this date range - ForecastDataPerInterval *[]Buintradayforecastdata `json:"forecastDataPerInterval,omitempty"` - - - // ScheduleDataSummary - Schedule data summary for this date range - ScheduleDataSummary *Buintradayscheduledata `json:"scheduleDataSummary,omitempty"` - - - // ScheduleDataPerInterval - Schedule data per interval for this date range - ScheduleDataPerInterval *[]Buintradayscheduledata `json:"scheduleDataPerInterval,omitempty"` - - - // PerformancePredictionDataSummary - Performance prediction data summary for this date range - PerformancePredictionDataSummary *Intradayperformancepredictiondata `json:"performancePredictionDataSummary,omitempty"` - - - // PerformancePredictionDataPerInterval - Performance prediction data per interval for this date range - PerformancePredictionDataPerInterval *[]Intradayperformancepredictiondata `json:"performancePredictionDataPerInterval,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Buintradaydatagroup) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/buintradayforecastdata.go b/build/platformclientv2/buintradayforecastdata.go deleted file mode 100644 index 8b9778257..000000000 --- a/build/platformclientv2/buintradayforecastdata.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Buintradayforecastdata -type Buintradayforecastdata struct { - // Offered - The number of interactions routed into the queues in the selected planning groups for the given media type for an agent to answer - Offered *float64 `json:"offered,omitempty"` - - - // AverageHandleTimeSeconds - The average handle time in seconds an agent spent handling interactions - AverageHandleTimeSeconds *float64 `json:"averageHandleTimeSeconds,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Buintradayforecastdata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/buintradayresponse.go b/build/platformclientv2/buintradayresponse.go deleted file mode 100644 index 4a7a29ce6..000000000 --- a/build/platformclientv2/buintradayresponse.go +++ /dev/null @@ -1,46 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Buintradayresponse -type Buintradayresponse struct { - // StartDate - The start of the date range for which this data applies. This is also the start reference point for the intervals represented in the various arrays. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartDate *time.Time `json:"startDate,omitempty"` - - - // EndDate - The end of the date range for which this data applies. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - EndDate *time.Time `json:"endDate,omitempty"` - - - // IntervalLengthMinutes - The aggregation period in minutes, which determines the interval duration of the returned data - IntervalLengthMinutes *int `json:"intervalLengthMinutes,omitempty"` - - - // NoDataReason - If not null, the reason there was no data for the request - NoDataReason *string `json:"noDataReason,omitempty"` - - - // Categories - The categories to which this data corresponds - Categories *[]string `json:"categories,omitempty"` - - - // ShortTermForecast - Short term forecast reference - ShortTermForecast *Bushorttermforecastreference `json:"shortTermForecast,omitempty"` - - - // Schedule - Schedule reference - Schedule *Buschedulereference `json:"schedule,omitempty"` - - - // IntradayDataGroupings - Intraday data grouped by a single media type and set of planning group IDs - IntradayDataGroupings *[]Buintradaydatagroup `json:"intradayDataGroupings,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Buintradayresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/buintradayscheduledata.go b/build/platformclientv2/buintradayscheduledata.go deleted file mode 100644 index 0d7698630..000000000 --- a/build/platformclientv2/buintradayscheduledata.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Buintradayscheduledata -type Buintradayscheduledata struct { - // OnQueueTimeSeconds - The total on-queue time in seconds for all agents in this group - OnQueueTimeSeconds *int `json:"onQueueTimeSeconds,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Buintradayscheduledata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/bulkshifttradestateupdaterequest.go b/build/platformclientv2/bulkshifttradestateupdaterequest.go deleted file mode 100644 index 1193b25b4..000000000 --- a/build/platformclientv2/bulkshifttradestateupdaterequest.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Bulkshifttradestateupdaterequest -type Bulkshifttradestateupdaterequest struct { - // Entities - The shift trades to update - Entities *[]Bulkupdateshifttradestaterequestitem `json:"entities,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Bulkshifttradestateupdaterequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/bulkupdateshifttradestaterequestitem.go b/build/platformclientv2/bulkupdateshifttradestaterequestitem.go deleted file mode 100644 index cebf92dee..000000000 --- a/build/platformclientv2/bulkupdateshifttradestaterequestitem.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Bulkupdateshifttradestaterequestitem -type Bulkupdateshifttradestaterequestitem struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // State - The new state to set on the shift trade - State *string `json:"state,omitempty"` - - - // Metadata - Version metadata for the shift trade - Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Bulkupdateshifttradestaterequestitem) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/bulkupdateshifttradestateresponse.go b/build/platformclientv2/bulkupdateshifttradestateresponse.go deleted file mode 100644 index 0a17a8f9a..000000000 --- a/build/platformclientv2/bulkupdateshifttradestateresponse.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Bulkupdateshifttradestateresponse -type Bulkupdateshifttradestateresponse struct { - // Status - The status of the operation - Status *string `json:"status,omitempty"` - - - // OperationId - The ID for the operation - OperationId *string `json:"operationId,omitempty"` - - - // Result - The result of the operation. Null unless status == Complete - Result *Bulkupdateshifttradestateresult `json:"result,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Bulkupdateshifttradestateresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/bulkupdateshifttradestateresult.go b/build/platformclientv2/bulkupdateshifttradestateresult.go deleted file mode 100644 index 559d7d395..000000000 --- a/build/platformclientv2/bulkupdateshifttradestateresult.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Bulkupdateshifttradestateresult -type Bulkupdateshifttradestateresult struct { - // Entities - Entities *[]Bulkupdateshifttradestateresultitem `json:"entities,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Bulkupdateshifttradestateresult) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/bulkupdateshifttradestateresultitem.go b/build/platformclientv2/bulkupdateshifttradestateresultitem.go deleted file mode 100644 index 4ff24002c..000000000 --- a/build/platformclientv2/bulkupdateshifttradestateresultitem.go +++ /dev/null @@ -1,38 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Bulkupdateshifttradestateresultitem -type Bulkupdateshifttradestateresultitem struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // State - The state of the shift trade after the update request is processed - State *string `json:"state,omitempty"` - - - // ReviewedBy - The user who reviewed the request, if applicable - ReviewedBy *Userreference `json:"reviewedBy,omitempty"` - - - // ReviewedDate - The date the request was reviewed, if applicable. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ReviewedDate *time.Time `json:"reviewedDate,omitempty"` - - - // FailureReason - The reason the update failed, if applicable - FailureReason *string `json:"failureReason,omitempty"` - - - // Metadata - Version metadata for the shift trade - Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Bulkupdateshifttradestateresultitem) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/bullseye.go b/build/platformclientv2/bullseye.go deleted file mode 100644 index f4a7ae39a..000000000 --- a/build/platformclientv2/bullseye.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Bullseye -type Bullseye struct { - // Rings - Rings *[]Ring `json:"rings,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Bullseye) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/bumanagementunitschedulesummary.go b/build/platformclientv2/bumanagementunitschedulesummary.go deleted file mode 100644 index 0641910f3..000000000 --- a/build/platformclientv2/bumanagementunitschedulesummary.go +++ /dev/null @@ -1,34 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Bumanagementunitschedulesummary -type Bumanagementunitschedulesummary struct { - // ManagementUnit - The management unit to which this summary applies - ManagementUnit *Managementunitreference `json:"managementUnit,omitempty"` - - - // AgentCount - The number of agents from this management unit that are in the schedule - AgentCount *int `json:"agentCount,omitempty"` - - - // StartDate - The start of the schedule change in the management unit. Only populated in schedule update notifications. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartDate *time.Time `json:"startDate,omitempty"` - - - // EndDate - The end of the schedule change in the management unit. Only populated in schedule update notifications. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - EndDate *time.Time `json:"endDate,omitempty"` - - - // Agents - The agents in the management unit who are part of this schedule, or in schedule change notifications, the agents that were changed. Note this will come back as an empty list unless the appropriate expand query parameter is passed - Agents *[]Userreference `json:"agents,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Bumanagementunitschedulesummary) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/buplanninggroupheadcountforecast.go b/build/platformclientv2/buplanninggroupheadcountforecast.go deleted file mode 100644 index 9b5dca370..000000000 --- a/build/platformclientv2/buplanninggroupheadcountforecast.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Buplanninggroupheadcountforecast -type Buplanninggroupheadcountforecast struct { - // PlanningGroup - The planning group to which this portion of the headcount forecast applies - PlanningGroup *Planninggroupreference `json:"planningGroup,omitempty"` - - - // RequiredPerInterval - Required headcount per interval, referenced against the reference start date - RequiredPerInterval *[]float64 `json:"requiredPerInterval,omitempty"` - - - // RequiredWithoutShrinkagePerInterval - Required headcount per interval without accounting for shrinkage, referenced against the reference start date - RequiredWithoutShrinkagePerInterval *[]float64 `json:"requiredWithoutShrinkagePerInterval,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Buplanninggroupheadcountforecast) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/buqueryagentschedulesrequest.go b/build/platformclientv2/buqueryagentschedulesrequest.go deleted file mode 100644 index 45757ae4f..000000000 --- a/build/platformclientv2/buqueryagentschedulesrequest.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Buqueryagentschedulesrequest -type Buqueryagentschedulesrequest struct { - // ManagementUnitId - The ID of the management unit to query - ManagementUnitId *string `json:"managementUnitId,omitempty"` - - - // UserIds - The IDs of the users to query. Omit to query all user schedules in the management unit. Note: If teamIds is also specified, only schedules for users in the requested teams will be returned - UserIds *[]string `json:"userIds,omitempty"` - - - // TeamIds - The teamIds to report on. If null or not set, results will be queried for requested users if applicable or otherwise all users in the management unit - TeamIds *[]string `json:"teamIds,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Buqueryagentschedulesrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/burescheduleagentscheduleresult.go b/build/platformclientv2/burescheduleagentscheduleresult.go deleted file mode 100644 index c1bac6ecb..000000000 --- a/build/platformclientv2/burescheduleagentscheduleresult.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Burescheduleagentscheduleresult -type Burescheduleagentscheduleresult struct { - // ManagementUnit - The management unit to which this part of the result applies - ManagementUnit *Managementunitreference `json:"managementUnit,omitempty"` - - - // DownloadResult - The agent schedules. Result will always come via the downloadUrl; however the schema is included for documentation - DownloadResult *Murescheduleresultwrapper `json:"downloadResult,omitempty"` - - - // DownloadUrl - The download URL from which to fetch the result - DownloadUrl *string `json:"downloadUrl,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Burescheduleagentscheduleresult) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/bureschedulerequest.go b/build/platformclientv2/bureschedulerequest.go deleted file mode 100644 index 0d5e810f7..000000000 --- a/build/platformclientv2/bureschedulerequest.go +++ /dev/null @@ -1,50 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Bureschedulerequest -type Bureschedulerequest struct { - // StartDate - The start of the range to reschedule. Defaults to the beginning of the schedule. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartDate *time.Time `json:"startDate,omitempty"` - - - // EndDate - The end of the range to reschedule. Defaults the the end of the schedule. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - EndDate *time.Time `json:"endDate,omitempty"` - - - // AgentIds - The IDs of the agents to consider for rescheduling. Omit to consider all agents in the specified management units.Agents not in the specified management units will be ignored - AgentIds *[]string `json:"agentIds,omitempty"` - - - // ActivityCodeIds - The IDs of the activity codes to consider for rescheduling. Omit to consider all activity codes - ActivityCodeIds *[]string `json:"activityCodeIds,omitempty"` - - - // ManagementUnitIds - The IDs of the management units to reschedule - ManagementUnitIds *[]string `json:"managementUnitIds,omitempty"` - - - // DoNotChangeWeeklyPaidTime - Instructs the scheduler whether it is allowed to change weekly paid time - DoNotChangeWeeklyPaidTime *bool `json:"doNotChangeWeeklyPaidTime,omitempty"` - - - // DoNotChangeDailyPaidTime - Instructs the scheduler whether it is allowed to change daily paid time - DoNotChangeDailyPaidTime *bool `json:"doNotChangeDailyPaidTime,omitempty"` - - - // DoNotChangeShiftStartTimes - Instructs the scheduler whether it is allowed to change shift start times - DoNotChangeShiftStartTimes *bool `json:"doNotChangeShiftStartTimes,omitempty"` - - - // DoNotChangeManuallyEditedShifts - Instructs the scheduler whether it is allowed to change manually edited shifts - DoNotChangeManuallyEditedShifts *bool `json:"doNotChangeManuallyEditedShifts,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Bureschedulerequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/burescheduleresult.go b/build/platformclientv2/burescheduleresult.go deleted file mode 100644 index 2aad40624..000000000 --- a/build/platformclientv2/burescheduleresult.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Burescheduleresult -type Burescheduleresult struct { - // GenerationResults - The generation results. Note the result will always be delivered via the downloadUrl; however the schema is included for documentation - GenerationResults *Schedulegenerationresult `json:"generationResults,omitempty"` - - - // GenerationResultsDownloadUrl - The download URL from which to fetch the generation results for the rescheduling run - GenerationResultsDownloadUrl *string `json:"generationResultsDownloadUrl,omitempty"` - - - // HeadcountForecast - The headcount forecast. Note the result will always be delivered via the downloadUrl; however the schema is included for documentation - HeadcountForecast *Buheadcountforecast `json:"headcountForecast,omitempty"` - - - // HeadcountForecastDownloadUrl - The download URL from which to fetch the headcount forecast for the rescheduling run - HeadcountForecastDownloadUrl *string `json:"headcountForecastDownloadUrl,omitempty"` - - - // AgentSchedules - List of download links for agent schedules produced by the rescheduling run - AgentSchedules *[]Burescheduleagentscheduleresult `json:"agentSchedules,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Burescheduleresult) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/buschedulelisting.go b/build/platformclientv2/buschedulelisting.go deleted file mode 100644 index 57717ef28..000000000 --- a/build/platformclientv2/buschedulelisting.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Buschedulelisting -type Buschedulelisting struct { - // Entities - Entities *[]Buschedulelistitem `json:"entities,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Buschedulelisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/buschedulelistitem.go b/build/platformclientv2/buschedulelistitem.go deleted file mode 100644 index a3bab0292..000000000 --- a/build/platformclientv2/buschedulelistitem.go +++ /dev/null @@ -1,50 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Buschedulelistitem -type Buschedulelistitem struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // WeekDate - The start week date for this schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd - WeekDate *time.Time `json:"weekDate,omitempty"` - - - // WeekCount - The number of weeks spanned by this schedule - WeekCount *int `json:"weekCount,omitempty"` - - - // Description - The description of this schedule - Description *string `json:"description,omitempty"` - - - // Published - Whether this schedule is published - Published *bool `json:"published,omitempty"` - - - // ShortTermForecast - The forecast used for this schedule, if applicable - ShortTermForecast *Bushorttermforecastreference `json:"shortTermForecast,omitempty"` - - - // GenerationResults - Generation result summary for this schedule, if applicable - GenerationResults *Schedulegenerationresultsummary `json:"generationResults,omitempty"` - - - // Metadata - Version metadata for this schedule - Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Buschedulelistitem) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/buschedulemetadata.go b/build/platformclientv2/buschedulemetadata.go deleted file mode 100644 index 7c59d71ef..000000000 --- a/build/platformclientv2/buschedulemetadata.go +++ /dev/null @@ -1,54 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Buschedulemetadata -type Buschedulemetadata struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // WeekDate - The start week date for this schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd - WeekDate *time.Time `json:"weekDate,omitempty"` - - - // WeekCount - The number of weeks spanned by this schedule - WeekCount *int `json:"weekCount,omitempty"` - - - // Description - The description of this schedule - Description *string `json:"description,omitempty"` - - - // Published - Whether this schedule is published - Published *bool `json:"published,omitempty"` - - - // ShortTermForecast - The forecast used for this schedule, if applicable - ShortTermForecast *Bushorttermforecastreference `json:"shortTermForecast,omitempty"` - - - // GenerationResults - Generation result summary for this schedule, if applicable - GenerationResults *Schedulegenerationresultsummary `json:"generationResults,omitempty"` - - - // Metadata - Version metadata for this schedule - Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"` - - - // ManagementUnits - High level per-management unit schedule metadata - ManagementUnits *[]Bumanagementunitschedulesummary `json:"managementUnits,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Buschedulemetadata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/buschedulereference.go b/build/platformclientv2/buschedulereference.go deleted file mode 100644 index d602da078..000000000 --- a/build/platformclientv2/buschedulereference.go +++ /dev/null @@ -1,26 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Buschedulereference -type Buschedulereference struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // WeekDate - The start week date for this schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd - WeekDate *time.Time `json:"weekDate,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Buschedulereference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/buschedulereferenceformuroute.go b/build/platformclientv2/buschedulereferenceformuroute.go deleted file mode 100644 index 346ce7f9d..000000000 --- a/build/platformclientv2/buschedulereferenceformuroute.go +++ /dev/null @@ -1,30 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Buschedulereferenceformuroute -type Buschedulereferenceformuroute struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // WeekDate - The start week date for this schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd - WeekDate *time.Time `json:"weekDate,omitempty"` - - - // BusinessUnit - The start week date for this schedule - BusinessUnit *Businessunitreference `json:"businessUnit,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Buschedulereferenceformuroute) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/buschedulerun.go b/build/platformclientv2/buschedulerun.go deleted file mode 100644 index 88ccd3eeb..000000000 --- a/build/platformclientv2/buschedulerun.go +++ /dev/null @@ -1,82 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Buschedulerun -type Buschedulerun struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // SchedulerRunId - The scheduler run ID. Reference this value for support - SchedulerRunId *string `json:"schedulerRunId,omitempty"` - - - // IntradayRescheduling - Whether this is an intraday rescheduling run - IntradayRescheduling *bool `json:"intradayRescheduling,omitempty"` - - - // State - The state of the generation run - State *string `json:"state,omitempty"` - - - // WeekCount - The number of weeks spanned by the schedule - WeekCount *int `json:"weekCount,omitempty"` - - - // PercentComplete - Percent completion of the schedule run - PercentComplete *float64 `json:"percentComplete,omitempty"` - - - // TargetWeek - The start date of the target week. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd - TargetWeek *time.Time `json:"targetWeek,omitempty"` - - - // Schedule - The generated schedule. Null unless the schedule run is complete - Schedule *Buschedulereference `json:"schedule,omitempty"` - - - // ScheduleDescription - The description of the generated schedule - ScheduleDescription *string `json:"scheduleDescription,omitempty"` - - - // SchedulingStartTime - When the schedule generation run started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - SchedulingStartTime *time.Time `json:"schedulingStartTime,omitempty"` - - - // SchedulingStartedBy - The user who started the scheduling run - SchedulingStartedBy *Userreference `json:"schedulingStartedBy,omitempty"` - - - // SchedulingCanceledBy - The user who canceled the scheduling run, if applicable - SchedulingCanceledBy *Userreference `json:"schedulingCanceledBy,omitempty"` - - - // SchedulingCompletedTime - When the scheduling run was completed, if applicable. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - SchedulingCompletedTime *time.Time `json:"schedulingCompletedTime,omitempty"` - - - // MessageCount - The number of schedule generation messages for this schedule generation run - MessageCount *int `json:"messageCount,omitempty"` - - - // ReschedulingOptions - Rescheduling options for this run. Null unless intradayRescheduling is true - ReschedulingOptions *Reschedulingoptionsrunresponse `json:"reschedulingOptions,omitempty"` - - - // ReschedulingResultExpiration - When the reschedule result will expire. Null unless intradayRescheduling is true. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ReschedulingResultExpiration *time.Time `json:"reschedulingResultExpiration,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Buschedulerun) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/buschedulerunlisting.go b/build/platformclientv2/buschedulerunlisting.go deleted file mode 100644 index 4fdcc09df..000000000 --- a/build/platformclientv2/buschedulerunlisting.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Buschedulerunlisting -type Buschedulerunlisting struct { - // Entities - Entities *[]Buschedulerun `json:"entities,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Buschedulerunlisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/busearchagentschedulesrequest.go b/build/platformclientv2/busearchagentschedulesrequest.go deleted file mode 100644 index e0f7296e4..000000000 --- a/build/platformclientv2/busearchagentschedulesrequest.go +++ /dev/null @@ -1,26 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Busearchagentschedulesrequest -type Busearchagentschedulesrequest struct { - // StartDate - Start date of the range to search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartDate *time.Time `json:"startDate,omitempty"` - - - // EndDate - End date of the range to search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - EndDate *time.Time `json:"endDate,omitempty"` - - - // UserIds - IDs of the users for whose schedules to search - UserIds *[]string `json:"userIds,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Busearchagentschedulesrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/buservicelevel.go b/build/platformclientv2/buservicelevel.go deleted file mode 100644 index 1701c5d89..000000000 --- a/build/platformclientv2/buservicelevel.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Buservicelevel - Service goal service level configuration -type Buservicelevel struct { - // Include - Whether to include service level targets in the associated configuration - Include *bool `json:"include,omitempty"` - - - // Percent - Service level target percent answered. Required if include == true - Percent *int `json:"percent,omitempty"` - - - // Seconds - Service level target answer time. Required if include == true - Seconds *int `json:"seconds,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Buservicelevel) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/bushorttermforecast.go b/build/platformclientv2/bushorttermforecast.go deleted file mode 100644 index da72fa9f6..000000000 --- a/build/platformclientv2/bushorttermforecast.go +++ /dev/null @@ -1,74 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Bushorttermforecast -type Bushorttermforecast struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // WeekDate - The start week date of this forecast in yyyy-MM-dd. Must fall on the start day of week for the associated business unit. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd - WeekDate *time.Time `json:"weekDate,omitempty"` - - - // WeekCount - The number of weeks this forecast covers - WeekCount *int `json:"weekCount,omitempty"` - - - // CreationMethod - The method by which this forecast was created - CreationMethod *string `json:"creationMethod,omitempty"` - - - // Description - The description of this forecast - Description *string `json:"description,omitempty"` - - - // Legacy - Whether this forecast contains modifications on legacy metrics - Legacy *bool `json:"legacy,omitempty"` - - - // Metadata - Metadata for this forecast - Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"` - - - // ReferenceStartDate - The reference start date for interval-based data for this forecast. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ReferenceStartDate *time.Time `json:"referenceStartDate,omitempty"` - - - // SourceDays - The source day pointers for this forecast - SourceDays *[]Forecastsourcedaypointer `json:"sourceDays,omitempty"` - - - // Modifications - Any manual modifications applied to this forecast - Modifications *[]Buforecastmodification `json:"modifications,omitempty"` - - - // GenerationResults - Generation result metadata - GenerationResults *Buforecastgenerationresult `json:"generationResults,omitempty"` - - - // TimeZone - The time zone for this forecast - TimeZone *string `json:"timeZone,omitempty"` - - - // PlanningGroupsVersion - The version of the planning groups that was used for this forecast - PlanningGroupsVersion *int `json:"planningGroupsVersion,omitempty"` - - - // PlanningGroups - A snapshot of the planning groups used for this forecast as of the version number indicated - PlanningGroups *Forecastplanninggroupsresponse `json:"planningGroups,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Bushorttermforecast) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/bushorttermforecastingsettings.go b/build/platformclientv2/bushorttermforecastingsettings.go deleted file mode 100644 index 628139cef..000000000 --- a/build/platformclientv2/bushorttermforecastingsettings.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Bushorttermforecastingsettings -type Bushorttermforecastingsettings struct { - // DefaultHistoryWeeks - The number of historical weeks to consider when creating a forecast. This setting is only used for legacy weighted average forecasts - DefaultHistoryWeeks *int `json:"defaultHistoryWeeks,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Bushorttermforecastingsettings) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/bushorttermforecastlisting.go b/build/platformclientv2/bushorttermforecastlisting.go deleted file mode 100644 index cc46103cf..000000000 --- a/build/platformclientv2/bushorttermforecastlisting.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Bushorttermforecastlisting -type Bushorttermforecastlisting struct { - // Entities - Entities *[]Bushorttermforecastlistitem `json:"entities,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Bushorttermforecastlisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/bushorttermforecastlistitem.go b/build/platformclientv2/bushorttermforecastlistitem.go deleted file mode 100644 index 4db14672c..000000000 --- a/build/platformclientv2/bushorttermforecastlistitem.go +++ /dev/null @@ -1,46 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Bushorttermforecastlistitem -type Bushorttermforecastlistitem struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // WeekDate - The start week date of this forecast in yyyy-MM-dd. Must fall on the start day of week for the associated business unit. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd - WeekDate *time.Time `json:"weekDate,omitempty"` - - - // WeekCount - The number of weeks this forecast covers - WeekCount *int `json:"weekCount,omitempty"` - - - // CreationMethod - The method by which this forecast was created - CreationMethod *string `json:"creationMethod,omitempty"` - - - // Description - The description of this forecast - Description *string `json:"description,omitempty"` - - - // Legacy - Whether this forecast contains modifications on legacy metrics - Legacy *bool `json:"legacy,omitempty"` - - - // Metadata - Metadata for this forecast - Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Bushorttermforecastlistitem) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/bushorttermforecastreference.go b/build/platformclientv2/bushorttermforecastreference.go deleted file mode 100644 index 7f82d444a..000000000 --- a/build/platformclientv2/bushorttermforecastreference.go +++ /dev/null @@ -1,30 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Bushorttermforecastreference - A pointer to a short term forecast -type Bushorttermforecastreference struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // WeekDate - The weekDate of the short term forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd - WeekDate *time.Time `json:"weekDate,omitempty"` - - - // Description - The description of the short term forecast - Description *string `json:"description,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Bushorttermforecastreference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/businessunit.go b/build/platformclientv2/businessunit.go deleted file mode 100644 index 6cdd94e07..000000000 --- a/build/platformclientv2/businessunit.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Businessunit -type Businessunit struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Division - The division to which this entity belongs. - Division *Division `json:"division,omitempty"` - - - // Settings - Settings for this business unit - Settings *Businessunitsettings `json:"settings,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Businessunit) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/businessunitactivitycode.go b/build/platformclientv2/businessunitactivitycode.go deleted file mode 100644 index 1259bf487..000000000 --- a/build/platformclientv2/businessunitactivitycode.go +++ /dev/null @@ -1,57 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Businessunitactivitycode - Activity code data -type Businessunitactivitycode struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Active - Whether this activity code is active or has been deleted - Active *bool `json:"active,omitempty"` - - - // DefaultCode - Whether this is a default activity code - DefaultCode *bool `json:"defaultCode,omitempty"` - - - // Category - The category of the activity code - Category *string `json:"category,omitempty"` - - - // LengthInMinutes - The default length of the activity in minutes - LengthInMinutes *int `json:"lengthInMinutes,omitempty"` - - - // CountsAsPaidTime - Whether an agent is paid while performing this activity - CountsAsPaidTime *bool `json:"countsAsPaidTime,omitempty"` - - - // CountsAsWorkTime - Indicates whether or not the activity should be counted as contiguous work time for calculating daily constraints - CountsAsWorkTime *bool `json:"countsAsWorkTime,omitempty"` - - - // AgentTimeOffSelectable - Whether an agent can select this activity code when creating or editing a time off request. Null if the activity's category is not time off. - AgentTimeOffSelectable *bool `json:"agentTimeOffSelectable,omitempty"` - - - // Metadata - Version metadata of this activity code - Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Businessunitactivitycode) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/businessunitactivitycodelisting.go b/build/platformclientv2/businessunitactivitycodelisting.go deleted file mode 100644 index 64566f470..000000000 --- a/build/platformclientv2/businessunitactivitycodelisting.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Businessunitactivitycodelisting - List of BusinessUnitActivityCode -type Businessunitactivitycodelisting struct { - // Entities - Entities *[]Businessunitactivitycode `json:"entities,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Businessunitactivitycodelisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/businessunitlisting.go b/build/platformclientv2/businessunitlisting.go deleted file mode 100644 index 9d9208bcd..000000000 --- a/build/platformclientv2/businessunitlisting.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Businessunitlisting -type Businessunitlisting struct { - // Entities - Entities *[]Businessunitlistitem `json:"entities,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Businessunitlisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/businessunitlistitem.go b/build/platformclientv2/businessunitlistitem.go deleted file mode 100644 index 02ae4e834..000000000 --- a/build/platformclientv2/businessunitlistitem.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Businessunitlistitem -type Businessunitlistitem struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Division - The division to which this entity belongs. - Division *Division `json:"division,omitempty"` - - - // Authorized - Whether the user has authorization to interact with this business unit - Authorized *bool `json:"authorized,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Businessunitlistitem) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/businessunitreference.go b/build/platformclientv2/businessunitreference.go deleted file mode 100644 index c8bc6cbad..000000000 --- a/build/platformclientv2/businessunitreference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Businessunitreference -type Businessunitreference struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Businessunitreference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/businessunitsettings.go b/build/platformclientv2/businessunitsettings.go deleted file mode 100644 index dc2f63e55..000000000 --- a/build/platformclientv2/businessunitsettings.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Businessunitsettings -type Businessunitsettings struct { - // StartDayOfWeek - The start day of week for this business unit - StartDayOfWeek *string `json:"startDayOfWeek,omitempty"` - - - // TimeZone - The time zone for this business unit, using the Olsen tz database format - TimeZone *string `json:"timeZone,omitempty"` - - - // ShortTermForecasting - Short term forecasting settings - ShortTermForecasting *Bushorttermforecastingsettings `json:"shortTermForecasting,omitempty"` - - - // Metadata - Version metadata for this business unit - Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Businessunitsettings) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/buttoncomponent.go b/build/platformclientv2/buttoncomponent.go deleted file mode 100644 index ec402f731..000000000 --- a/build/platformclientv2/buttoncomponent.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Buttoncomponent - Structured template button object -type Buttoncomponent struct { - // Id - An ID assigned to this component - Id *string `json:"id,omitempty"` - - - // Text - Deprecated - Use title instead - Text *string `json:"text,omitempty"` - - - // Title - Text to show inside the button - Title *string `json:"title,omitempty"` - - - // Actions - User actions available on the content. All actions are optional and all actions are executed simultaneously. - Actions *Contentactions `json:"actions,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Buttoncomponent) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/calibration.go b/build/platformclientv2/calibration.go deleted file mode 100644 index 08cf84118..000000000 --- a/build/platformclientv2/calibration.go +++ /dev/null @@ -1,78 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Calibration -type Calibration struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Calibrator - Calibrator *User `json:"calibrator,omitempty"` - - - // Agent - Agent *User `json:"agent,omitempty"` - - - // Conversation - Conversation *Conversation `json:"conversation,omitempty"` - - - // EvaluationForm - EvaluationForm *Evaluationform `json:"evaluationForm,omitempty"` - - - // ContextId - ContextId *string `json:"contextId,omitempty"` - - - // AverageScore - AverageScore *int `json:"averageScore,omitempty"` - - - // HighScore - HighScore *int `json:"highScore,omitempty"` - - - // LowScore - LowScore *int `json:"lowScore,omitempty"` - - - // CreatedDate - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - CreatedDate *time.Time `json:"createdDate,omitempty"` - - - // Evaluations - Evaluations *[]Evaluation `json:"evaluations,omitempty"` - - - // Evaluators - Evaluators *[]User `json:"evaluators,omitempty"` - - - // ScoringIndex - ScoringIndex **Evaluation `json:"scoringIndex,omitempty"` - - - // ExpertEvaluator - ExpertEvaluator *User `json:"expertEvaluator,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Calibration) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/calibrationassignment.go b/build/platformclientv2/calibrationassignment.go deleted file mode 100644 index 74c95fae6..000000000 --- a/build/platformclientv2/calibrationassignment.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Calibrationassignment -type Calibrationassignment struct { - // Calibrator - Calibrator *User `json:"calibrator,omitempty"` - - - // Evaluators - Evaluators *[]User `json:"evaluators,omitempty"` - - - // EvaluationForm - EvaluationForm *Evaluationform `json:"evaluationForm,omitempty"` - - - // ExpertEvaluator - ExpertEvaluator *User `json:"expertEvaluator,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Calibrationassignment) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/calibrationcreate.go b/build/platformclientv2/calibrationcreate.go deleted file mode 100644 index d2137ac17..000000000 --- a/build/platformclientv2/calibrationcreate.go +++ /dev/null @@ -1,78 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Calibrationcreate -type Calibrationcreate struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Calibrator - Calibrator *User `json:"calibrator,omitempty"` - - - // Agent - Agent *User `json:"agent,omitempty"` - - - // Conversation - The conversation to use for the calibration. - Conversation *Conversation `json:"conversation,omitempty"` - - - // EvaluationForm - EvaluationForm *Evaluationform `json:"evaluationForm,omitempty"` - - - // ContextId - ContextId *string `json:"contextId,omitempty"` - - - // AverageScore - AverageScore *int `json:"averageScore,omitempty"` - - - // HighScore - HighScore *int `json:"highScore,omitempty"` - - - // LowScore - LowScore *int `json:"lowScore,omitempty"` - - - // CreatedDate - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - CreatedDate *time.Time `json:"createdDate,omitempty"` - - - // Evaluations - Evaluations *[]Evaluation `json:"evaluations,omitempty"` - - - // Evaluators - Evaluators *[]User `json:"evaluators,omitempty"` - - - // ScoringIndex - ScoringIndex *Evaluation `json:"scoringIndex,omitempty"` - - - // ExpertEvaluator - ExpertEvaluator *User `json:"expertEvaluator,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Calibrationcreate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/calibrationentitylisting.go b/build/platformclientv2/calibrationentitylisting.go deleted file mode 100644 index 7e745fb38..000000000 --- a/build/platformclientv2/calibrationentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Calibrationentitylisting -type Calibrationentitylisting struct { - // Entities - Entities *[]Calibration `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Calibrationentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/call.go b/build/platformclientv2/call.go deleted file mode 100644 index 625841417..000000000 --- a/build/platformclientv2/call.go +++ /dev/null @@ -1,130 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Call -type Call struct { - // State - The connection state of this communication. - State *string `json:"state,omitempty"` - - - // Id - A globally unique identifier for this communication. - Id *string `json:"id,omitempty"` - - - // Direction - The direction of the call - Direction *string `json:"direction,omitempty"` - - - // Recording - True if this call is being recorded. - Recording *bool `json:"recording,omitempty"` - - - // RecordingState - State of recording on this call. - RecordingState *string `json:"recordingState,omitempty"` - - - // Muted - True if this call is muted so that remote participants can't hear any audio from this end. - Muted *bool `json:"muted,omitempty"` - - - // Confined - True if this call is held and the person on this side hears hold music. - Confined *bool `json:"confined,omitempty"` - - - // Held - True if this call is held and the person on this side hears silence. - Held *bool `json:"held,omitempty"` - - - // RecordingId - A globally unique identifier for the recording associated with this call. - RecordingId *string `json:"recordingId,omitempty"` - - - // Segments - The time line of the participant's call, divided into activity segments. - Segments *[]Segment `json:"segments,omitempty"` - - - // ErrorInfo - ErrorInfo *Errorinfo `json:"errorInfo,omitempty"` - - - // DisconnectType - System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects. - DisconnectType *string `json:"disconnectType,omitempty"` - - - // StartHoldTime - The timestamp the call was placed on hold in the cloud clock if the call is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartHoldTime *time.Time `json:"startHoldTime,omitempty"` - - - // DocumentId - If call is an outbound fax of a document from content management, then this is the id in content management. - DocumentId *string `json:"documentId,omitempty"` - - - // StartAlertingTime - The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartAlertingTime *time.Time `json:"startAlertingTime,omitempty"` - - - // ConnectedTime - The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // DisconnectedTime - The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"` - - - // DisconnectReasons - List of reasons that this call was disconnected. This will be set once the call disconnects. - DisconnectReasons *[]Disconnectreason `json:"disconnectReasons,omitempty"` - - - // FaxStatus - Extra information on fax transmission. - FaxStatus *Faxstatus `json:"faxStatus,omitempty"` - - - // Provider - The source provider for the call. - Provider *string `json:"provider,omitempty"` - - - // ScriptId - The UUID of the script to use. - ScriptId *string `json:"scriptId,omitempty"` - - - // PeerId - The id of the peer communication corresponding to a matching leg for this communication. - PeerId *string `json:"peerId,omitempty"` - - - // UuiData - User to User Information (UUI) data managed by SIP session application. - UuiData *string `json:"uuiData,omitempty"` - - - // Self - Address and name data for a call endpoint. - Self *Address `json:"self,omitempty"` - - - // Other - Address and name data for a call endpoint. - Other *Address `json:"other,omitempty"` - - - // Wrapup - Call wrap up or disposition data. - Wrapup *Wrapup `json:"wrapup,omitempty"` - - - // AfterCallWork - After-call work for the communication. - AfterCallWork *Aftercallwork `json:"afterCallWork,omitempty"` - - - // AfterCallWorkRequired - Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested. - AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"` - - - // AgentAssistantId - UUID of virtual agent assistant that provide suggestions to the agent participant during the conversation. - AgentAssistantId *string `json:"agentAssistantId,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Call) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/callablecontactsdiagnostic.go b/build/platformclientv2/callablecontactsdiagnostic.go deleted file mode 100644 index b5c9c1f9d..000000000 --- a/build/platformclientv2/callablecontactsdiagnostic.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Callablecontactsdiagnostic -type Callablecontactsdiagnostic struct { - // AttemptLimits - Attempt limits for the campaign's contact list - AttemptLimits *Domainentityref `json:"attemptLimits,omitempty"` - - - // DncLists - Do not call lists for the campaign - DncLists *[]Domainentityref `json:"dncLists,omitempty"` - - - // CallableTimeSet - Callable time sets for the campaign - CallableTimeSet *Domainentityref `json:"callableTimeSet,omitempty"` - - - // RuleSets - Rule sets for the campaign - RuleSets *[]Domainentityref `json:"ruleSets,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Callablecontactsdiagnostic) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/callabletime.go b/build/platformclientv2/callabletime.go deleted file mode 100644 index 80a790829..000000000 --- a/build/platformclientv2/callabletime.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Callabletime -type Callabletime struct { - // TimeSlots - The time intervals for which it is acceptable to place outbound calls. - TimeSlots *[]Campaigntimeslot `json:"timeSlots,omitempty"` - - - // TimeZoneId - The time zone for the time slots; for example, Africa/Abidjan - TimeZoneId *string `json:"timeZoneId,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Callabletime) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/callabletimeset.go b/build/platformclientv2/callabletimeset.go deleted file mode 100644 index 7af1a2e67..000000000 --- a/build/platformclientv2/callabletimeset.go +++ /dev/null @@ -1,42 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Callabletimeset -type Callabletimeset struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the CallableTimeSet. - Name *string `json:"name,omitempty"` - - - // DateCreated - Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // Version - Required for updates, must match the version number of the most recent update - Version *int `json:"version,omitempty"` - - - // CallableTimes - The list of CallableTimes for which it is acceptable to place outbound calls. - CallableTimes *[]Callabletime `json:"callableTimes,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Callabletimeset) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/callabletimesetentitylisting.go b/build/platformclientv2/callabletimesetentitylisting.go deleted file mode 100644 index 7ac2ac865..000000000 --- a/build/platformclientv2/callabletimesetentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Callabletimesetentitylisting -type Callabletimesetentitylisting struct { - // Entities - Entities *[]Callabletimeset `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Callabletimesetentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/callablewindow.go b/build/platformclientv2/callablewindow.go deleted file mode 100644 index a116b20dc..000000000 --- a/build/platformclientv2/callablewindow.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Callablewindow -type Callablewindow struct { - // Mapped - The time interval to place outbound calls, for contacts that can be mapped to a time zone. - Mapped *Atzmtimeslot `json:"mapped,omitempty"` - - - // Unmapped - The time interval and time zone to place outbound calls, for contacts that cannot be mapped to a time zone. - Unmapped *Atzmtimeslotwithtimezone `json:"unmapped,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Callablewindow) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/callback.go b/build/platformclientv2/callback.go deleted file mode 100644 index dcf38b551..000000000 --- a/build/platformclientv2/callback.go +++ /dev/null @@ -1,114 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Callback -type Callback struct { - // State - The connection state of this communication. - State *string `json:"state,omitempty"` - - - // Id - A globally unique identifier for this communication. - Id *string `json:"id,omitempty"` - - - // Segments - The time line of the participant's callback, divided into activity segments. - Segments *[]Segment `json:"segments,omitempty"` - - - // Direction - The direction of the call - Direction *string `json:"direction,omitempty"` - - - // Held - True if this call is held and the person on this side hears silence. - Held *bool `json:"held,omitempty"` - - - // DisconnectType - System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects. - DisconnectType *string `json:"disconnectType,omitempty"` - - - // StartHoldTime - The timestamp the callback was placed on hold in the cloud clock if the callback is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartHoldTime *time.Time `json:"startHoldTime,omitempty"` - - - // DialerPreview - The preview data to be used when this callback is a Preview. - DialerPreview *Dialerpreview `json:"dialerPreview,omitempty"` - - - // Voicemail - The voicemail data to be used when this callback is an ACD voicemail. - Voicemail *Voicemail `json:"voicemail,omitempty"` - - - // CallbackNumbers - The phone number(s) to use to place the callback. - CallbackNumbers *[]string `json:"callbackNumbers,omitempty"` - - - // CallbackUserName - The name of the user requesting a callback. - CallbackUserName *string `json:"callbackUserName,omitempty"` - - - // ScriptId - The UUID of the script to use. - ScriptId *string `json:"scriptId,omitempty"` - - - // ExternalCampaign - True if the call for the callback uses external dialing. - ExternalCampaign *bool `json:"externalCampaign,omitempty"` - - - // SkipEnabled - True if the ability to skip a callback should be enabled. - SkipEnabled *bool `json:"skipEnabled,omitempty"` - - - // TimeoutSeconds - The number of seconds before the system automatically places a call for a callback. 0 means the automatic placement is disabled. - TimeoutSeconds *int `json:"timeoutSeconds,omitempty"` - - - // StartAlertingTime - The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartAlertingTime *time.Time `json:"startAlertingTime,omitempty"` - - - // ConnectedTime - The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // DisconnectedTime - The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"` - - - // CallbackScheduledTime - The timestamp when this communication is scheduled in the provider clock. If this value is missing it indicates the callback will be placed immediately. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - CallbackScheduledTime *time.Time `json:"callbackScheduledTime,omitempty"` - - - // AutomatedCallbackConfigId - The id of the config for automatically placing the callback (and handling the disposition). If null, the callback will not be placed automatically but routed to an agent as per normal. - AutomatedCallbackConfigId *string `json:"automatedCallbackConfigId,omitempty"` - - - // Provider - The source provider for the callback. - Provider *string `json:"provider,omitempty"` - - - // PeerId - The id of the peer communication corresponding to a matching leg for this communication. - PeerId *string `json:"peerId,omitempty"` - - - // Wrapup - Call wrap up or disposition data. - Wrapup *Wrapup `json:"wrapup,omitempty"` - - - // AfterCallWork - After-call work for the communication. - AfterCallWork *Aftercallwork `json:"afterCallWork,omitempty"` - - - // AfterCallWorkRequired - Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested. - AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Callback) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/callbackbasic.go b/build/platformclientv2/callbackbasic.go deleted file mode 100644 index 95cd5c31c..000000000 --- a/build/platformclientv2/callbackbasic.go +++ /dev/null @@ -1,114 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Callbackbasic -type Callbackbasic struct { - // State - The connection state of this communication. - State *string `json:"state,omitempty"` - - - // Id - A globally unique identifier for this communication. - Id *string `json:"id,omitempty"` - - - // Segments - The time line of the participant's callback, divided into activity segments. - Segments *[]Segment `json:"segments,omitempty"` - - - // Direction - The direction of the call - Direction *string `json:"direction,omitempty"` - - - // Held - True if this call is held and the person on this side hears silence. - Held *bool `json:"held,omitempty"` - - - // DisconnectType - System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects. - DisconnectType *string `json:"disconnectType,omitempty"` - - - // StartHoldTime - The timestamp the callback was placed on hold in the cloud clock if the callback is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartHoldTime *time.Time `json:"startHoldTime,omitempty"` - - - // DialerPreview - The preview data to be used when this callback is a Preview. - DialerPreview *Dialerpreview `json:"dialerPreview,omitempty"` - - - // Voicemail - The voicemail data to be used when this callback is an ACD voicemail. - Voicemail *Voicemail `json:"voicemail,omitempty"` - - - // CallbackNumbers - The phone number(s) to use to place the callback. - CallbackNumbers *[]string `json:"callbackNumbers,omitempty"` - - - // CallbackUserName - The name of the user requesting a callback. - CallbackUserName *string `json:"callbackUserName,omitempty"` - - - // ScriptId - The UUID of the script to use. - ScriptId *string `json:"scriptId,omitempty"` - - - // ExternalCampaign - True if the call for the callback uses external dialing. - ExternalCampaign *bool `json:"externalCampaign,omitempty"` - - - // SkipEnabled - True if the ability to skip a callback should be enabled. - SkipEnabled *bool `json:"skipEnabled,omitempty"` - - - // TimeoutSeconds - The number of seconds before the system automatically places a call for a callback. 0 means the automatic placement is disabled. - TimeoutSeconds *int `json:"timeoutSeconds,omitempty"` - - - // StartAlertingTime - The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartAlertingTime *time.Time `json:"startAlertingTime,omitempty"` - - - // ConnectedTime - The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // DisconnectedTime - The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"` - - - // CallbackScheduledTime - The timestamp when this communication is scheduled in the provider clock. If this value is missing it indicates the callback will be placed immediately. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - CallbackScheduledTime *time.Time `json:"callbackScheduledTime,omitempty"` - - - // AutomatedCallbackConfigId - The id of the config for automatically placing the callback (and handling the disposition). If null, the callback will not be placed automatically but routed to an agent as per normal. - AutomatedCallbackConfigId *string `json:"automatedCallbackConfigId,omitempty"` - - - // Provider - The source provider for the callback. - Provider *string `json:"provider,omitempty"` - - - // PeerId - The id of the peer communication corresponding to a matching leg for this communication. - PeerId *string `json:"peerId,omitempty"` - - - // Wrapup - Call wrap up or disposition data. - Wrapup *Wrapup `json:"wrapup,omitempty"` - - - // AfterCallWork - After-call work for the communication. - AfterCallWork *Aftercallwork `json:"afterCallWork,omitempty"` - - - // AfterCallWorkRequired - Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested. - AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Callbackbasic) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/callbackconversation.go b/build/platformclientv2/callbackconversation.go deleted file mode 100644 index 7ea4b1f3a..000000000 --- a/build/platformclientv2/callbackconversation.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Callbackconversation -type Callbackconversation struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Participants - The list of participants involved in the conversation. - Participants *[]Callbackmediaparticipant `json:"participants,omitempty"` - - - // OtherMediaUris - The list of other media channels involved in the conversation. - OtherMediaUris *[]string `json:"otherMediaUris,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Callbackconversation) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/callbackconversationentitylisting.go b/build/platformclientv2/callbackconversationentitylisting.go deleted file mode 100644 index 1f8bc36ef..000000000 --- a/build/platformclientv2/callbackconversationentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Callbackconversationentitylisting -type Callbackconversationentitylisting struct { - // Entities - Entities *[]Callbackconversation `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Callbackconversationentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/callbackidentifier.go b/build/platformclientv2/callbackidentifier.go deleted file mode 100644 index 655d687d4..000000000 --- a/build/platformclientv2/callbackidentifier.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Callbackidentifier -type Callbackidentifier struct { - // VarType - The type of the associated callback participant - VarType *string `json:"type,omitempty"` - - - // Id - The identifier of the callback - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Callbackidentifier) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/callbackmediaparticipant.go b/build/platformclientv2/callbackmediaparticipant.go deleted file mode 100644 index 78f1b08d9..000000000 --- a/build/platformclientv2/callbackmediaparticipant.go +++ /dev/null @@ -1,182 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Callbackmediaparticipant -type Callbackmediaparticipant struct { - // Id - The unique participant ID. - Id *string `json:"id,omitempty"` - - - // Name - The display friendly name of the participant. - Name *string `json:"name,omitempty"` - - - // Address - The participant address. - Address *string `json:"address,omitempty"` - - - // StartTime - The time when this participant first joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartTime *time.Time `json:"startTime,omitempty"` - - - // ConnectedTime - The time when this participant went connected for this media (eg: video connected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // EndTime - The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - EndTime *time.Time `json:"endTime,omitempty"` - - - // StartHoldTime - The time when this participant's hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartHoldTime *time.Time `json:"startHoldTime,omitempty"` - - - // Purpose - The participant's purpose. Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr - Purpose *string `json:"purpose,omitempty"` - - - // State - The participant's state. Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting - State *string `json:"state,omitempty"` - - - // Direction - The participant's direction. Values can be: 'inbound' or 'outbound' - Direction *string `json:"direction,omitempty"` - - - // DisconnectType - The reason the participant was disconnected from the conversation. - DisconnectType *string `json:"disconnectType,omitempty"` - - - // Held - Value is true when the participant is on hold. - Held *bool `json:"held,omitempty"` - - - // WrapupRequired - Value is true when the participant requires wrap-up. - WrapupRequired *bool `json:"wrapupRequired,omitempty"` - - - // WrapupPrompt - The wrap-up prompt indicating the type of wrap-up to be performed. - WrapupPrompt *string `json:"wrapupPrompt,omitempty"` - - - // User - The PureCloud user for this participant. - User *Domainentityref `json:"user,omitempty"` - - - // Queue - The PureCloud queue for this participant. - Queue *Domainentityref `json:"queue,omitempty"` - - - // Team - The PureCloud team for this participant. - Team *Domainentityref `json:"team,omitempty"` - - - // Attributes - A list of ad-hoc attributes for the participant. - Attributes *map[string]string `json:"attributes,omitempty"` - - - // ErrorInfo - If the conversation ends in error, contains additional error details. - ErrorInfo *Errorinfo `json:"errorInfo,omitempty"` - - - // Script - The Engage script that should be used by this participant. - Script *Domainentityref `json:"script,omitempty"` - - - // WrapupTimeoutMs - The amount of time the participant has to complete wrap-up. - WrapupTimeoutMs *int `json:"wrapupTimeoutMs,omitempty"` - - - // WrapupSkipped - Value is true when the participant has skipped wrap-up. - WrapupSkipped *bool `json:"wrapupSkipped,omitempty"` - - - // AlertingTimeoutMs - Specifies how long the agent has to answer an interaction before being marked as not responding. - AlertingTimeoutMs *int `json:"alertingTimeoutMs,omitempty"` - - - // Provider - The source provider for the communication. - Provider *string `json:"provider,omitempty"` - - - // ExternalContact - If this participant represents an external contact, then this will be the reference for the external contact. - ExternalContact *Domainentityref `json:"externalContact,omitempty"` - - - // ExternalOrganization - If this participant represents an external org, then this will be the reference for the external org. - ExternalOrganization *Domainentityref `json:"externalOrganization,omitempty"` - - - // Wrapup - Wrapup for this participant, if it has been applied. - Wrapup *Wrapup `json:"wrapup,omitempty"` - - - // Peer - The peer communication corresponding to a matching leg for this communication. - Peer *string `json:"peer,omitempty"` - - - // FlaggedReason - The reason specifying why participant flagged the conversation. - FlaggedReason *string `json:"flaggedReason,omitempty"` - - - // JourneyContext - Journey System data/context that is applicable to this communication. When used for historical purposes, the context should be immutable. When null, there is no applicable Journey System context. - JourneyContext *Journeycontext `json:"journeyContext,omitempty"` - - - // ConversationRoutingData - Information on how a communication should be routed to an agent. - ConversationRoutingData *Conversationroutingdata `json:"conversationRoutingData,omitempty"` - - - // StartAcwTime - The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartAcwTime *time.Time `json:"startAcwTime,omitempty"` - - - // EndAcwTime - The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - EndAcwTime *time.Time `json:"endAcwTime,omitempty"` - - - // OutboundPreview - The outbound preview associated with this callback. - OutboundPreview *Dialerpreview `json:"outboundPreview,omitempty"` - - - // Voicemail - The voicemail associated with this callback. - Voicemail *Voicemail `json:"voicemail,omitempty"` - - - // CallbackNumbers - The list of phone number to use for this callback. - CallbackNumbers *[]string `json:"callbackNumbers,omitempty"` - - - // CallbackUserName - The name of the callback target. - CallbackUserName *string `json:"callbackUserName,omitempty"` - - - // ExternalCampaign - True if the call for the callback uses external dialing. - ExternalCampaign *bool `json:"externalCampaign,omitempty"` - - - // SkipEnabled - If true, the callback can be skipped. - SkipEnabled *bool `json:"skipEnabled,omitempty"` - - - // TimeoutSeconds - Duration in seconds before the callback will be auto-dialed. - TimeoutSeconds *int `json:"timeoutSeconds,omitempty"` - - - // AutomatedCallbackConfigId - The id of the config for automatically placing the callback (and handling the disposition). If absent, the callback will not be placed automatically but routed to an agent as per normal. - AutomatedCallbackConfigId *string `json:"automatedCallbackConfigId,omitempty"` - - - // CallbackScheduledTime - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - CallbackScheduledTime *time.Time `json:"callbackScheduledTime,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Callbackmediaparticipant) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/callbasic.go b/build/platformclientv2/callbasic.go deleted file mode 100644 index 0fc3156e2..000000000 --- a/build/platformclientv2/callbasic.go +++ /dev/null @@ -1,130 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Callbasic -type Callbasic struct { - // State - The connection state of this communication. - State *string `json:"state,omitempty"` - - - // Id - A globally unique identifier for this communication. - Id *string `json:"id,omitempty"` - - - // Direction - The direction of the call - Direction *string `json:"direction,omitempty"` - - - // Recording - True if this call is being recorded. - Recording *bool `json:"recording,omitempty"` - - - // RecordingState - State of recording on this call. - RecordingState *string `json:"recordingState,omitempty"` - - - // Muted - True if this call is muted so that remote participants can't hear any audio from this end. - Muted *bool `json:"muted,omitempty"` - - - // Confined - True if this call is held and the person on this side hears hold music. - Confined *bool `json:"confined,omitempty"` - - - // Held - True if this call is held and the person on this side hears silence. - Held *bool `json:"held,omitempty"` - - - // RecordingId - A globally unique identifier for the recording associated with this call. - RecordingId *string `json:"recordingId,omitempty"` - - - // Segments - The time line of the participant's call, divided into activity segments. - Segments *[]Segment `json:"segments,omitempty"` - - - // ErrorInfo - ErrorInfo *Errorinfo `json:"errorInfo,omitempty"` - - - // DisconnectType - System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects. - DisconnectType *string `json:"disconnectType,omitempty"` - - - // StartHoldTime - The timestamp the call was placed on hold in the cloud clock if the call is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartHoldTime *time.Time `json:"startHoldTime,omitempty"` - - - // DocumentId - If call is an outbound fax of a document from content management, then this is the id in content management. - DocumentId *string `json:"documentId,omitempty"` - - - // StartAlertingTime - The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartAlertingTime *time.Time `json:"startAlertingTime,omitempty"` - - - // ConnectedTime - The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // DisconnectedTime - The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"` - - - // DisconnectReasons - List of reasons that this call was disconnected. This will be set once the call disconnects. - DisconnectReasons *[]Disconnectreason `json:"disconnectReasons,omitempty"` - - - // FaxStatus - Extra information on fax transmission. - FaxStatus *Faxstatus `json:"faxStatus,omitempty"` - - - // Provider - The source provider for the call. - Provider *string `json:"provider,omitempty"` - - - // ScriptId - The UUID of the script to use. - ScriptId *string `json:"scriptId,omitempty"` - - - // PeerId - The id of the peer communication corresponding to a matching leg for this communication. - PeerId *string `json:"peerId,omitempty"` - - - // UuiData - User to User Information (UUI) data managed by SIP session application. - UuiData *string `json:"uuiData,omitempty"` - - - // Self - Address and name data for a call endpoint. - Self *Address `json:"self,omitempty"` - - - // Other - Address and name data for a call endpoint. - Other *Address `json:"other,omitempty"` - - - // Wrapup - Call wrap up or disposition data. - Wrapup *Wrapup `json:"wrapup,omitempty"` - - - // AfterCallWork - After-call work for the communication. - AfterCallWork *Aftercallwork `json:"afterCallWork,omitempty"` - - - // AfterCallWorkRequired - Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested. - AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"` - - - // AgentAssistantId - UUID of virtual agent assistant that provide suggestions to the agent participant during the conversation. - AgentAssistantId *string `json:"agentAssistantId,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Callbasic) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/callcommand.go b/build/platformclientv2/callcommand.go deleted file mode 100644 index d8218c06c..000000000 --- a/build/platformclientv2/callcommand.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Callcommand -type Callcommand struct { - // CallNumber - The phone number to dial for this call. - CallNumber *string `json:"callNumber,omitempty"` - - - // PhoneColumn - For a dialer preview or scheduled callback, the phone column associated with the phone number - PhoneColumn *string `json:"phoneColumn,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Callcommand) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/callconversation.go b/build/platformclientv2/callconversation.go deleted file mode 100644 index 7d6bf72f5..000000000 --- a/build/platformclientv2/callconversation.go +++ /dev/null @@ -1,41 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Callconversation -type Callconversation struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Participants - The list of participants involved in the conversation. - Participants *[]Callmediaparticipant `json:"participants,omitempty"` - - - // OtherMediaUris - The list of other media channels involved in the conversation. - OtherMediaUris *[]string `json:"otherMediaUris,omitempty"` - - - // RecordingState - RecordingState *string `json:"recordingState,omitempty"` - - - // MaxParticipants - If this is a conference conversation, then this field indicates the maximum number of participants allowed to participant in the conference. - MaxParticipants *int `json:"maxParticipants,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Callconversation) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/callconversationentitylisting.go b/build/platformclientv2/callconversationentitylisting.go deleted file mode 100644 index 7bd55b956..000000000 --- a/build/platformclientv2/callconversationentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Callconversationentitylisting -type Callconversationentitylisting struct { - // Entities - Entities *[]Callconversation `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Callconversationentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/callforwarding.go b/build/platformclientv2/callforwarding.go deleted file mode 100644 index 5d6e322a4..000000000 --- a/build/platformclientv2/callforwarding.go +++ /dev/null @@ -1,50 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Callforwarding -type Callforwarding struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // User - User *User `json:"user,omitempty"` - - - // Enabled - Whether or not CallForwarding is enabled - Enabled *bool `json:"enabled,omitempty"` - - - // PhoneNumber - This property is deprecated. Please use the calls property - PhoneNumber *string `json:"phoneNumber,omitempty"` - - - // Calls - An ordered list of CallRoutes to be executed when CallForwarding is enabled - Calls *[]Callroute `json:"calls,omitempty"` - - - // Voicemail - The type of voicemail to use with the callForwarding configuration - Voicemail *string `json:"voicemail,omitempty"` - - - // ModifiedDate - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ModifiedDate *time.Time `json:"modifiedDate,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Callforwarding) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/callforwardingeventcall.go b/build/platformclientv2/callforwardingeventcall.go deleted file mode 100644 index b017116ad..000000000 --- a/build/platformclientv2/callforwardingeventcall.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Callforwardingeventcall -type Callforwardingeventcall struct { - // Targets - Targets *[]Callforwardingeventtarget `json:"targets,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Callforwardingeventcall) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/callforwardingeventcallforwarding.go b/build/platformclientv2/callforwardingeventcallforwarding.go deleted file mode 100644 index b57e5eb18..000000000 --- a/build/platformclientv2/callforwardingeventcallforwarding.go +++ /dev/null @@ -1,34 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Callforwardingeventcallforwarding -type Callforwardingeventcallforwarding struct { - // User - User *Callforwardingeventuser `json:"user,omitempty"` - - - // Enabled - Enabled *bool `json:"enabled,omitempty"` - - - // Calls - Calls *[]Callforwardingeventcall `json:"calls,omitempty"` - - - // Voicemail - Voicemail *string `json:"voicemail,omitempty"` - - - // ModifiedDate - ModifiedDate *time.Time `json:"modifiedDate,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Callforwardingeventcallforwarding) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/callforwardingeventtarget.go b/build/platformclientv2/callforwardingeventtarget.go deleted file mode 100644 index ad77febfb..000000000 --- a/build/platformclientv2/callforwardingeventtarget.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Callforwardingeventtarget -type Callforwardingeventtarget struct { - // VarType - VarType *string `json:"type,omitempty"` - - - // Value - Value *string `json:"value,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Callforwardingeventtarget) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/callforwardingeventuser.go b/build/platformclientv2/callforwardingeventuser.go deleted file mode 100644 index 2795a4527..000000000 --- a/build/platformclientv2/callforwardingeventuser.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Callforwardingeventuser -type Callforwardingeventuser struct { - // Id - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Callforwardingeventuser) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/callhistoryconversation.go b/build/platformclientv2/callhistoryconversation.go deleted file mode 100644 index 77c2bb8c5..000000000 --- a/build/platformclientv2/callhistoryconversation.go +++ /dev/null @@ -1,66 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Callhistoryconversation -type Callhistoryconversation struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Participants - The list of participants involved in the conversation. - Participants *[]Callhistoryparticipant `json:"participants,omitempty"` - - - // Direction - The direction of the call relating to the current user - Direction *string `json:"direction,omitempty"` - - - // WentToVoicemail - Did the call end in the current user's voicemail - WentToVoicemail *bool `json:"wentToVoicemail,omitempty"` - - - // MissedCall - Did the user not answer this conversation - MissedCall *bool `json:"missedCall,omitempty"` - - - // StartTime - The time the user joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartTime *time.Time `json:"startTime,omitempty"` - - - // WasConference - Was this conversation a conference - WasConference *bool `json:"wasConference,omitempty"` - - - // WasCallback - Was this conversation a callback - WasCallback *bool `json:"wasCallback,omitempty"` - - - // HadScreenShare - Did this conversation have a screen share session - HadScreenShare *bool `json:"hadScreenShare,omitempty"` - - - // HadCobrowse - Did this conversation have a cobrowse session - HadCobrowse *bool `json:"hadCobrowse,omitempty"` - - - // WasOutboundCampaign - Was this conversation associated with an outbound campaign - WasOutboundCampaign *bool `json:"wasOutboundCampaign,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Callhistoryconversation) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/callhistoryconversationentitylisting.go b/build/platformclientv2/callhistoryconversationentitylisting.go deleted file mode 100644 index afe6fc523..000000000 --- a/build/platformclientv2/callhistoryconversationentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Callhistoryconversationentitylisting -type Callhistoryconversationentitylisting struct { - // Entities - Entities *[]Callhistoryconversation `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Callhistoryconversationentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/callhistoryparticipant.go b/build/platformclientv2/callhistoryparticipant.go deleted file mode 100644 index bd428340d..000000000 --- a/build/platformclientv2/callhistoryparticipant.go +++ /dev/null @@ -1,90 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Callhistoryparticipant -type Callhistoryparticipant struct { - // Id - The unique participant ID. - Id *string `json:"id,omitempty"` - - - // Name - The display friendly name of the participant. - Name *string `json:"name,omitempty"` - - - // Address - The participant address. - Address *string `json:"address,omitempty"` - - - // StartTime - The time when this participant first joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartTime *time.Time `json:"startTime,omitempty"` - - - // EndTime - The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - EndTime *time.Time `json:"endTime,omitempty"` - - - // Purpose - The participant's purpose. Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr - Purpose *string `json:"purpose,omitempty"` - - - // Direction - The participant's direction. Values can be: 'inbound' or 'outbound' - Direction *string `json:"direction,omitempty"` - - - // Ani - The call ANI. - Ani *string `json:"ani,omitempty"` - - - // Dnis - The call DNIS. - Dnis *string `json:"dnis,omitempty"` - - - // User - The PureCloud user for this participant. - User *User `json:"user,omitempty"` - - - // Queue - The PureCloud queue for this participant. - Queue *Queue `json:"queue,omitempty"` - - - // Group - The group involved in the group ring call. - Group *Group `json:"group,omitempty"` - - - // DisconnectType - The reason the participant was disconnected from the conversation. - DisconnectType *string `json:"disconnectType,omitempty"` - - - // ExternalContact - The PureCloud external contact - ExternalContact *Externalcontact `json:"externalContact,omitempty"` - - - // ExternalOrganization - The PureCloud external organization - ExternalOrganization *Externalorganization `json:"externalOrganization,omitempty"` - - - // DidInteract - Indicates whether the contact ever connected - DidInteract *bool `json:"didInteract,omitempty"` - - - // SipResponseCodes - Indicates SIP Response codes associated with the participant - SipResponseCodes *[]int `json:"sipResponseCodes,omitempty"` - - - // FlaggedReason - The reason specifying why participant flagged the conversation. - FlaggedReason *string `json:"flaggedReason,omitempty"` - - - // OutboundCampaign - The outbound campaign associated with the participant - OutboundCampaign *Campaign `json:"outboundCampaign,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Callhistoryparticipant) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/callmediaparticipant.go b/build/platformclientv2/callmediaparticipant.go deleted file mode 100644 index cd4e26128..000000000 --- a/build/platformclientv2/callmediaparticipant.go +++ /dev/null @@ -1,194 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Callmediaparticipant -type Callmediaparticipant struct { - // Id - The unique participant ID. - Id *string `json:"id,omitempty"` - - - // Name - The display friendly name of the participant. - Name *string `json:"name,omitempty"` - - - // Address - The participant address. - Address *string `json:"address,omitempty"` - - - // StartTime - The time when this participant first joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartTime *time.Time `json:"startTime,omitempty"` - - - // ConnectedTime - The time when this participant went connected for this media (eg: video connected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // EndTime - The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - EndTime *time.Time `json:"endTime,omitempty"` - - - // StartHoldTime - The time when this participant's hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartHoldTime *time.Time `json:"startHoldTime,omitempty"` - - - // Purpose - The participant's purpose. Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr - Purpose *string `json:"purpose,omitempty"` - - - // State - The participant's state. Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting - State *string `json:"state,omitempty"` - - - // Direction - The participant's direction. Values can be: 'inbound' or 'outbound' - Direction *string `json:"direction,omitempty"` - - - // DisconnectType - The reason the participant was disconnected from the conversation. - DisconnectType *string `json:"disconnectType,omitempty"` - - - // Held - Value is true when the participant is on hold. - Held *bool `json:"held,omitempty"` - - - // WrapupRequired - Value is true when the participant requires wrap-up. - WrapupRequired *bool `json:"wrapupRequired,omitempty"` - - - // WrapupPrompt - The wrap-up prompt indicating the type of wrap-up to be performed. - WrapupPrompt *string `json:"wrapupPrompt,omitempty"` - - - // User - The PureCloud user for this participant. - User *Domainentityref `json:"user,omitempty"` - - - // Queue - The PureCloud queue for this participant. - Queue *Domainentityref `json:"queue,omitempty"` - - - // Team - The PureCloud team for this participant. - Team *Domainentityref `json:"team,omitempty"` - - - // Attributes - A list of ad-hoc attributes for the participant. - Attributes *map[string]string `json:"attributes,omitempty"` - - - // ErrorInfo - If the conversation ends in error, contains additional error details. - ErrorInfo *Errorinfo `json:"errorInfo,omitempty"` - - - // Script - The Engage script that should be used by this participant. - Script *Domainentityref `json:"script,omitempty"` - - - // WrapupTimeoutMs - The amount of time the participant has to complete wrap-up. - WrapupTimeoutMs *int `json:"wrapupTimeoutMs,omitempty"` - - - // WrapupSkipped - Value is true when the participant has skipped wrap-up. - WrapupSkipped *bool `json:"wrapupSkipped,omitempty"` - - - // AlertingTimeoutMs - Specifies how long the agent has to answer an interaction before being marked as not responding. - AlertingTimeoutMs *int `json:"alertingTimeoutMs,omitempty"` - - - // Provider - The source provider for the communication. - Provider *string `json:"provider,omitempty"` - - - // ExternalContact - If this participant represents an external contact, then this will be the reference for the external contact. - ExternalContact *Domainentityref `json:"externalContact,omitempty"` - - - // ExternalOrganization - If this participant represents an external org, then this will be the reference for the external org. - ExternalOrganization *Domainentityref `json:"externalOrganization,omitempty"` - - - // Wrapup - Wrapup for this participant, if it has been applied. - Wrapup *Wrapup `json:"wrapup,omitempty"` - - - // Peer - The peer communication corresponding to a matching leg for this communication. - Peer *string `json:"peer,omitempty"` - - - // FlaggedReason - The reason specifying why participant flagged the conversation. - FlaggedReason *string `json:"flaggedReason,omitempty"` - - - // JourneyContext - Journey System data/context that is applicable to this communication. When used for historical purposes, the context should be immutable. When null, there is no applicable Journey System context. - JourneyContext *Journeycontext `json:"journeyContext,omitempty"` - - - // ConversationRoutingData - Information on how a communication should be routed to an agent. - ConversationRoutingData *Conversationroutingdata `json:"conversationRoutingData,omitempty"` - - - // StartAcwTime - The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartAcwTime *time.Time `json:"startAcwTime,omitempty"` - - - // EndAcwTime - The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - EndAcwTime *time.Time `json:"endAcwTime,omitempty"` - - - // Muted - Value is true when the call is muted. - Muted *bool `json:"muted,omitempty"` - - - // Confined - Value is true when the call is confined. - Confined *bool `json:"confined,omitempty"` - - - // Recording - Value is true when the call is being recorded. - Recording *bool `json:"recording,omitempty"` - - - // RecordingState - The state of the call recording. - RecordingState *string `json:"recordingState,omitempty"` - - - // Group - The group involved in the group ring call. - Group *Domainentityref `json:"group,omitempty"` - - - // Ani - The call ANI. - Ani *string `json:"ani,omitempty"` - - - // Dnis - The call DNIS. - Dnis *string `json:"dnis,omitempty"` - - - // DocumentId - The ID of the Content Management document if the call is a fax. - DocumentId *string `json:"documentId,omitempty"` - - - // FaxStatus - Extra fax information if the call is a fax. - FaxStatus *Faxstatus `json:"faxStatus,omitempty"` - - - // MonitoredParticipantId - The ID of the participant being monitored when performing a call monitor. - MonitoredParticipantId *string `json:"monitoredParticipantId,omitempty"` - - - // ConsultParticipantId - The ID of the consult transfer target participant when performing a consult transfer. - ConsultParticipantId *string `json:"consultParticipantId,omitempty"` - - - // UuiData - User-to-User information which maps to a SIP header field defined in RFC7433. UUI data is used in the Public Switched Telephone Network (PSTN) for use cases described in RFC6567. - UuiData *string `json:"uuiData,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Callmediaparticipant) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/callmediapolicy.go b/build/platformclientv2/callmediapolicy.go deleted file mode 100644 index c1a7bff64..000000000 --- a/build/platformclientv2/callmediapolicy.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Callmediapolicy -type Callmediapolicy struct { - // Actions - Actions applied when specified conditions are met - Actions *Policyactions `json:"actions,omitempty"` - - - // Conditions - Conditions for when actions should be applied - Conditions *Callmediapolicyconditions `json:"conditions,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Callmediapolicy) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/callmediapolicyconditions.go b/build/platformclientv2/callmediapolicyconditions.go deleted file mode 100644 index d0da6f828..000000000 --- a/build/platformclientv2/callmediapolicyconditions.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Callmediapolicyconditions -type Callmediapolicyconditions struct { - // ForUsers - ForUsers *[]User `json:"forUsers,omitempty"` - - - // DateRanges - DateRanges *[]string `json:"dateRanges,omitempty"` - - - // ForQueues - ForQueues *[]Queue `json:"forQueues,omitempty"` - - - // WrapupCodes - WrapupCodes *[]Wrapupcode `json:"wrapupCodes,omitempty"` - - - // Languages - Languages *[]Language `json:"languages,omitempty"` - - - // TimeAllowed - TimeAllowed *Timeallowed `json:"timeAllowed,omitempty"` - - - // Directions - Directions *[]string `json:"directions,omitempty"` - - - // Duration - Duration *Durationcondition `json:"duration,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Callmediapolicyconditions) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/callrecord.go b/build/platformclientv2/callrecord.go deleted file mode 100644 index b0a064bfa..000000000 --- a/build/platformclientv2/callrecord.go +++ /dev/null @@ -1,22 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Callrecord -type Callrecord struct { - // LastAttempt - Timestamp of the last attempt to reach this number. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - LastAttempt *time.Time `json:"lastAttempt,omitempty"` - - - // LastResult - Result of the last attempt to reach this number - LastResult *string `json:"lastResult,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Callrecord) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/callroute.go b/build/platformclientv2/callroute.go deleted file mode 100644 index 6cc3f9b40..000000000 --- a/build/platformclientv2/callroute.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Callroute -type Callroute struct { - // Targets - A list of CallTargets to be called when the CallRoute is executed - Targets *[]Calltarget `json:"targets,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Callroute) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/calltarget.go b/build/platformclientv2/calltarget.go deleted file mode 100644 index 7e05eab9f..000000000 --- a/build/platformclientv2/calltarget.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Calltarget -type Calltarget struct { - // VarType - The type of call - VarType *string `json:"type,omitempty"` - - - // Value - The id of the station or an E.164 formatted phone number - Value *string `json:"value,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Calltarget) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/calltoaction.go b/build/platformclientv2/calltoaction.go deleted file mode 100644 index f3b0723ab..000000000 --- a/build/platformclientv2/calltoaction.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Calltoaction -type Calltoaction struct { - // Text - Text displayed on the call to action button. - Text *string `json:"text,omitempty"` - - - // Url - URL to open when user clicks on the call to action button. - Url *string `json:"url,omitempty"` - - - // Target - Where the URL should be opened when the user clicks on the call to action button. - Target *string `json:"target,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Calltoaction) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/campaign.go b/build/platformclientv2/campaign.go deleted file mode 100644 index f61b251fa..000000000 --- a/build/platformclientv2/campaign.go +++ /dev/null @@ -1,146 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Campaign -type Campaign struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the Campaign. - Name *string `json:"name,omitempty"` - - - // DateCreated - Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // Version - Required for updates, must match the version number of the most recent update - Version *int `json:"version,omitempty"` - - - // ContactList - The ContactList for this Campaign to dial. - ContactList *Domainentityref `json:"contactList,omitempty"` - - - // Queue - The Queue for this Campaign to route calls to. Required for all dialing modes except agentless. - Queue *Domainentityref `json:"queue,omitempty"` - - - // DialingMode - The strategy this Campaign will use for dialing. - DialingMode *string `json:"dialingMode,omitempty"` - - - // Script - The Script to be displayed to agents that are handling outbound calls. Required for all dialing modes except agentless. - Script *Domainentityref `json:"script,omitempty"` - - - // EdgeGroup - The EdgeGroup that will place the calls. Required for all dialing modes except preview. - EdgeGroup *Domainentityref `json:"edgeGroup,omitempty"` - - - // Site - The identifier of the site to be used for dialing; can be set in place of an edge group. - Site *Domainentityref `json:"site,omitempty"` - - - // CampaignStatus - The current status of the Campaign. A Campaign may be turned 'on' or 'off'. Required for updates. - CampaignStatus *string `json:"campaignStatus,omitempty"` - - - // PhoneColumns - The ContactPhoneNumberColumns on the ContactList that this Campaign should dial. - PhoneColumns *[]Phonecolumn `json:"phoneColumns,omitempty"` - - - // AbandonRate - The targeted abandon rate percentage. Required for progressive, power, and predictive campaigns. - AbandonRate *float64 `json:"abandonRate,omitempty"` - - - // DncLists - DncLists for this Campaign to check before placing a call. - DncLists *[]Domainentityref `json:"dncLists,omitempty"` - - - // CallableTimeSet - The callable time set for this campaign to check before placing a call. - CallableTimeSet *Domainentityref `json:"callableTimeSet,omitempty"` - - - // CallAnalysisResponseSet - The call analysis response set to handle call analysis results from the edge. Required for all dialing modes except preview. - CallAnalysisResponseSet *Domainentityref `json:"callAnalysisResponseSet,omitempty"` - - - // Errors - A list of current error conditions associated with the campaign. - Errors *[]Resterrordetail `json:"errors,omitempty"` - - - // CallerName - The caller id name to be displayed on the outbound call. - CallerName *string `json:"callerName,omitempty"` - - - // CallerAddress - The caller id phone number to be displayed on the outbound call. - CallerAddress *string `json:"callerAddress,omitempty"` - - - // OutboundLineCount - The number of outbound lines to be concurrently dialed. Only applicable to non-preview campaigns; only required for agentless. - OutboundLineCount *int `json:"outboundLineCount,omitempty"` - - - // RuleSets - Rule sets to be applied while this campaign is dialing. - RuleSets *[]Domainentityref `json:"ruleSets,omitempty"` - - - // SkipPreviewDisabled - Whether or not agents can skip previews without placing a call. Only applicable for preview campaigns. - SkipPreviewDisabled *bool `json:"skipPreviewDisabled,omitempty"` - - - // PreviewTimeOutSeconds - The number of seconds before a call will be automatically placed on a preview. A value of 0 indicates no automatic placement of calls. Only applicable to preview campaigns. - PreviewTimeOutSeconds *int `json:"previewTimeOutSeconds,omitempty"` - - - // AlwaysRunning - Indicates (when true) that the campaign will remain on after contacts are depleted, allowing additional contacts to be appended/added to the contact list and processed by the still-running campaign. The campaign can still be turned off manually. - AlwaysRunning *bool `json:"alwaysRunning,omitempty"` - - - // ContactSort - The order in which to sort contacts for dialing, based on a column. - ContactSort *Contactsort `json:"contactSort,omitempty"` - - - // ContactSorts - The order in which to sort contacts for dialing, based on up to four columns. - ContactSorts *[]Contactsort `json:"contactSorts,omitempty"` - - - // NoAnswerTimeout - How long to wait before dispositioning a call as 'no-answer'. Default 30 seconds. Only applicable to non-preview campaigns. - NoAnswerTimeout *int `json:"noAnswerTimeout,omitempty"` - - - // CallAnalysisLanguage - The language the edge will use to analyze the call. - CallAnalysisLanguage *string `json:"callAnalysisLanguage,omitempty"` - - - // Priority - The priority of this campaign relative to other campaigns that are running on the same queue. 5 is the highest priority, 1 the lowest. - Priority *int `json:"priority,omitempty"` - - - // ContactListFilters - Filter to apply to the contact list before dialing. Currently a campaign can only have one filter applied. - ContactListFilters *[]Domainentityref `json:"contactListFilters,omitempty"` - - - // Division - The division this campaign belongs to. - Division *Domainentityref `json:"division,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Campaign) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/campaigndiagnostics.go b/build/platformclientv2/campaigndiagnostics.go deleted file mode 100644 index 5decb230e..000000000 --- a/build/platformclientv2/campaigndiagnostics.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Campaigndiagnostics -type Campaigndiagnostics struct { - // CallableContacts - Campaign properties that can impact which contacts are callable - CallableContacts *Callablecontactsdiagnostic `json:"callableContacts,omitempty"` - - - // QueueUtilizationDiagnostic - Information regarding the campaign's queue - QueueUtilizationDiagnostic *Queueutilizationdiagnostic `json:"queueUtilizationDiagnostic,omitempty"` - - - // RuleSetDiagnostics - Information regarding the campaign's rule sets - RuleSetDiagnostics *[]Rulesetdiagnostic `json:"ruleSetDiagnostics,omitempty"` - - - // OutstandingInteractionsCount - Current number of outstanding interactions on the campaign - OutstandingInteractionsCount *int `json:"outstandingInteractionsCount,omitempty"` - - - // ScheduledInteractionsCount - Current number of scheduled interactions on the campaign - ScheduledInteractionsCount *int `json:"scheduledInteractionsCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Campaigndiagnostics) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/campaigndivisionview.go b/build/platformclientv2/campaigndivisionview.go deleted file mode 100644 index 2a50b7642..000000000 --- a/build/platformclientv2/campaigndivisionview.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Campaigndivisionview -type Campaigndivisionview struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Division - The division to which this entity belongs. - Division *Division `json:"division,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Campaigndivisionview) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/campaigndivisionviewlisting.go b/build/platformclientv2/campaigndivisionviewlisting.go deleted file mode 100644 index 7e0e2ff2a..000000000 --- a/build/platformclientv2/campaigndivisionviewlisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Campaigndivisionviewlisting -type Campaigndivisionviewlisting struct { - // Entities - Entities *[]Campaigndivisionview `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Campaigndivisionviewlisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/campaignentitylisting.go b/build/platformclientv2/campaignentitylisting.go deleted file mode 100644 index ba81f8d31..000000000 --- a/build/platformclientv2/campaignentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Campaignentitylisting -type Campaignentitylisting struct { - // Entities - Entities *[]Campaign `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Campaignentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/campaigninteraction.go b/build/platformclientv2/campaigninteraction.go deleted file mode 100644 index 45c16008e..000000000 --- a/build/platformclientv2/campaigninteraction.go +++ /dev/null @@ -1,98 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Campaigninteraction -type Campaigninteraction struct { - // Id - Id *string `json:"id,omitempty"` - - - // Campaign - Campaign *Domainentityref `json:"campaign,omitempty"` - - - // Agent - Agent *Domainentityref `json:"agent,omitempty"` - - - // Contact - Contact *Domainentityref `json:"contact,omitempty"` - - - // DestinationAddress - DestinationAddress *string `json:"destinationAddress,omitempty"` - - - // ActivePreviewCall - Boolean value if there is an active preview call on the interaction - ActivePreviewCall *bool `json:"activePreviewCall,omitempty"` - - - // LastActivePreviewWrapupTime - The time when the last preview of the interaction was wrapped up. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - LastActivePreviewWrapupTime *time.Time `json:"lastActivePreviewWrapupTime,omitempty"` - - - // CreationTime - The time when dialer created the interaction. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - CreationTime *time.Time `json:"creationTime,omitempty"` - - - // CallPlacedTime - The time when the agent or system places the call. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - CallPlacedTime *time.Time `json:"callPlacedTime,omitempty"` - - - // CallRoutedTime - The time when the agent was connected to the call. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - CallRoutedTime *time.Time `json:"callRoutedTime,omitempty"` - - - // PreviewConnectedTime - The time when the customer and routing participant are connected. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - PreviewConnectedTime *time.Time `json:"previewConnectedTime,omitempty"` - - - // Queue - Queue *Domainentityref `json:"queue,omitempty"` - - - // Script - Script *Domainentityref `json:"script,omitempty"` - - - // Disposition - Describes what happened with call analysis for instance: disposition.classification.callable.person, disposition.classification.callable.noanswer - Disposition *string `json:"disposition,omitempty"` - - - // CallerName - CallerName *string `json:"callerName,omitempty"` - - - // CallerAddress - CallerAddress *string `json:"callerAddress,omitempty"` - - - // PreviewPopDeliveredTime - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - PreviewPopDeliveredTime *time.Time `json:"previewPopDeliveredTime,omitempty"` - - - // Conversation - Conversation *Conversationbasic `json:"conversation,omitempty"` - - - // DialerSystemParticipantId - conversation participant id that is the dialer system participant to monitor the call from dialer perspective - DialerSystemParticipantId *string `json:"dialerSystemParticipantId,omitempty"` - - - // DialingMode - DialingMode *string `json:"dialingMode,omitempty"` - - - // Skills - Any skills that are attached to the call for routing - Skills *[]Domainentityref `json:"skills,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Campaigninteraction) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/campaigninteractions.go b/build/platformclientv2/campaigninteractions.go deleted file mode 100644 index 4f3afe62d..000000000 --- a/build/platformclientv2/campaigninteractions.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Campaigninteractions -type Campaigninteractions struct { - // Campaign - Campaign *Domainentityref `json:"campaign,omitempty"` - - - // PendingInteractions - PendingInteractions *[]Campaigninteraction `json:"pendingInteractions,omitempty"` - - - // ProceedingInteractions - ProceedingInteractions *[]Campaigninteraction `json:"proceedingInteractions,omitempty"` - - - // PreviewingInteractions - PreviewingInteractions *[]Campaigninteraction `json:"previewingInteractions,omitempty"` - - - // InteractingInteractions - InteractingInteractions *[]Campaigninteraction `json:"interactingInteractions,omitempty"` - - - // ScheduledInteractions - ScheduledInteractions *[]Campaigninteraction `json:"scheduledInteractions,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Campaigninteractions) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/campaignprogress.go b/build/platformclientv2/campaignprogress.go deleted file mode 100644 index 720fa8d44..000000000 --- a/build/platformclientv2/campaignprogress.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Campaignprogress -type Campaignprogress struct { - // Campaign - Identifier of the campaign - Campaign *Domainentityref `json:"campaign,omitempty"` - - - // ContactList - Identifier of the contact list - ContactList *Domainentityref `json:"contactList,omitempty"` - - - // NumberOfContactsCalled - Number of contacts called during the campaign - NumberOfContactsCalled *int `json:"numberOfContactsCalled,omitempty"` - - - // NumberOfContactsMessaged - Number of contacts messaged during the campaign - NumberOfContactsMessaged *int `json:"numberOfContactsMessaged,omitempty"` - - - // TotalNumberOfContacts - Total number of contacts in the campaign - TotalNumberOfContacts *int `json:"totalNumberOfContacts,omitempty"` - - - // Percentage - Percentage of contacts processed during the campaign - Percentage *int `json:"percentage,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Campaignprogress) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/campaignrule.go b/build/platformclientv2/campaignrule.go deleted file mode 100644 index 8a8d8bf17..000000000 --- a/build/platformclientv2/campaignrule.go +++ /dev/null @@ -1,58 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Campaignrule -type Campaignrule struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the CampaignRule. - Name *string `json:"name,omitempty"` - - - // DateCreated - Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // Version - Required for updates, must match the version number of the most recent update - Version *int `json:"version,omitempty"` - - - // CampaignRuleEntities - The list of entities that this CampaignRule monitors. - CampaignRuleEntities *Campaignruleentities `json:"campaignRuleEntities,omitempty"` - - - // CampaignRuleConditions - The list of conditions that are evaluated on the entities. - CampaignRuleConditions *[]Campaignrulecondition `json:"campaignRuleConditions,omitempty"` - - - // CampaignRuleActions - The list of actions that are executed if the conditions are satisfied. - CampaignRuleActions *[]Campaignruleaction `json:"campaignRuleActions,omitempty"` - - - // MatchAnyConditions - MatchAnyConditions *bool `json:"matchAnyConditions,omitempty"` - - - // Enabled - Whether or not this CampaignRule is currently enabled. Required on updates. - Enabled *bool `json:"enabled,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Campaignrule) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/campaignruleaction.go b/build/platformclientv2/campaignruleaction.go deleted file mode 100644 index efc63aa48..000000000 --- a/build/platformclientv2/campaignruleaction.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Campaignruleaction -type Campaignruleaction struct { - // Id - Id *string `json:"id,omitempty"` - - - // Parameters - The parameters for the CampaignRuleAction. Required for certain actionTypes. - Parameters *Campaignruleparameters `json:"parameters,omitempty"` - - - // ActionType - The action to take on the campaignRuleActionEntities. - ActionType *string `json:"actionType,omitempty"` - - - // CampaignRuleActionEntities - The list of entities that this action will apply to. - CampaignRuleActionEntities *Campaignruleactionentities `json:"campaignRuleActionEntities,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Campaignruleaction) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/campaignruleactionentities.go b/build/platformclientv2/campaignruleactionentities.go deleted file mode 100644 index d488e9c43..000000000 --- a/build/platformclientv2/campaignruleactionentities.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Campaignruleactionentities -type Campaignruleactionentities struct { - // Campaigns - The list of campaigns for a CampaignRule to monitor. Required if the CampaignRule has any conditions that run on a campaign. - Campaigns *[]Domainentityref `json:"campaigns,omitempty"` - - - // Sequences - The list of sequences for a CampaignRule to monitor. Required if the CampaignRule has any conditions that run on a sequence. - Sequences *[]Domainentityref `json:"sequences,omitempty"` - - - // UseTriggeringEntity - If true, the CampaignRuleAction will apply to the same entity that triggered the CampaignRuleCondition. - UseTriggeringEntity *bool `json:"useTriggeringEntity,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Campaignruleactionentities) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/campaignrulecondition.go b/build/platformclientv2/campaignrulecondition.go deleted file mode 100644 index 90df581b6..000000000 --- a/build/platformclientv2/campaignrulecondition.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Campaignrulecondition -type Campaignrulecondition struct { - // Id - Id *string `json:"id,omitempty"` - - - // Parameters - The parameters for the CampaignRuleCondition. - Parameters *Campaignruleparameters `json:"parameters,omitempty"` - - - // ConditionType - The type of condition to evaluate. - ConditionType *string `json:"conditionType,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Campaignrulecondition) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/campaignruleentities.go b/build/platformclientv2/campaignruleentities.go deleted file mode 100644 index 20c62f5e6..000000000 --- a/build/platformclientv2/campaignruleentities.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Campaignruleentities -type Campaignruleentities struct { - // Campaigns - The list of campaigns for a CampaignRule to monitor. Required if the CampaignRule has any conditions that run on a campaign. - Campaigns *[]Domainentityref `json:"campaigns,omitempty"` - - - // Sequences - The list of sequences for a CampaignRule to monitor. Required if the CampaignRule has any conditions that run on a sequence. - Sequences *[]Domainentityref `json:"sequences,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Campaignruleentities) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/campaignruleentitylisting.go b/build/platformclientv2/campaignruleentitylisting.go deleted file mode 100644 index 5e14d9ff5..000000000 --- a/build/platformclientv2/campaignruleentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Campaignruleentitylisting -type Campaignruleentitylisting struct { - // Entities - Entities *[]Campaignrule `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Campaignruleentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/campaignruleparameters.go b/build/platformclientv2/campaignruleparameters.go deleted file mode 100644 index 3306845ea..000000000 --- a/build/platformclientv2/campaignruleparameters.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Campaignruleparameters -type Campaignruleparameters struct { - // Operator - The operator for comparison. Required for a CampaignRuleCondition. - Operator *string `json:"operator,omitempty"` - - - // Value - The value for comparison. Required for a CampaignRuleCondition. - Value *string `json:"value,omitempty"` - - - // Priority - The priority to set a campaign to. Required for the 'setCampaignPriority' action. - Priority *string `json:"priority,omitempty"` - - - // DialingMode - The dialing mode to set a campaign to. Required for the 'setCampaignDialingMode' action. - DialingMode *string `json:"dialingMode,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Campaignruleparameters) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/campaignschedule.go b/build/platformclientv2/campaignschedule.go deleted file mode 100644 index 5e1897953..000000000 --- a/build/platformclientv2/campaignschedule.go +++ /dev/null @@ -1,50 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Campaignschedule -type Campaignschedule struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // DateCreated - Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // Version - Required for updates, must match the version number of the most recent update - Version *int `json:"version,omitempty"` - - - // Intervals - A list of intervals during which to run the associated Campaign. - Intervals *[]Scheduleinterval `json:"intervals,omitempty"` - - - // TimeZone - The time zone for this CampaignSchedule. For example, Africa/Abidjan. - TimeZone *string `json:"timeZone,omitempty"` - - - // Campaign - The Campaign that this CampaignSchedule is for. - Campaign *Domainentityref `json:"campaign,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Campaignschedule) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/campaignsequence.go b/build/platformclientv2/campaignsequence.go deleted file mode 100644 index ae03d6790..000000000 --- a/build/platformclientv2/campaignsequence.go +++ /dev/null @@ -1,58 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Campaignsequence -type Campaignsequence struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // DateCreated - Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // Version - Required for updates, must match the version number of the most recent update - Version *int `json:"version,omitempty"` - - - // Campaigns - The ordered list of Campaigns that this CampaignSequence will run. - Campaigns *[]Domainentityref `json:"campaigns,omitempty"` - - - // CurrentCampaign - A zero-based index indicating which Campaign this CampaignSequence is currently on. - CurrentCampaign *int `json:"currentCampaign,omitempty"` - - - // Status - The current status of the CampaignSequence. A CampaignSequence can be turned 'on' or 'off'. - Status *string `json:"status,omitempty"` - - - // StopMessage - A message indicating if and why a CampaignSequence has stopped unexpectedly. - StopMessage *string `json:"stopMessage,omitempty"` - - - // Repeat - Indicates if a sequence should repeat from the beginning after the last campaign completes. Default is false. - Repeat *bool `json:"repeat,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Campaignsequence) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/campaignsequenceentitylisting.go b/build/platformclientv2/campaignsequenceentitylisting.go deleted file mode 100644 index 8fc1b0a65..000000000 --- a/build/platformclientv2/campaignsequenceentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Campaignsequenceentitylisting -type Campaignsequenceentitylisting struct { - // Entities - Entities *[]Campaignsequence `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Campaignsequenceentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/campaignstats.go b/build/platformclientv2/campaignstats.go deleted file mode 100644 index 32a3e69a5..000000000 --- a/build/platformclientv2/campaignstats.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Campaignstats -type Campaignstats struct { - // ContactRate - Information regarding the campaign's connect rate - ContactRate *Connectrate `json:"contactRate,omitempty"` - - - // IdleAgents - Number of available agents not currently being utilized - IdleAgents *int `json:"idleAgents,omitempty"` - - - // EffectiveIdleAgents - Number of effective available agents not currently being utilized - EffectiveIdleAgents *float64 `json:"effectiveIdleAgents,omitempty"` - - - // AdjustedCallsPerAgent - Calls per agent adjusted by pace - AdjustedCallsPerAgent *float64 `json:"adjustedCallsPerAgent,omitempty"` - - - // OutstandingCalls - Number of campaign calls currently ongoing - OutstandingCalls *int `json:"outstandingCalls,omitempty"` - - - // ScheduledCalls - Number of campaign calls currently scheduled - ScheduledCalls *int `json:"scheduledCalls,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Campaignstats) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/campaigntimeslot.go b/build/platformclientv2/campaigntimeslot.go deleted file mode 100644 index 046330b0f..000000000 --- a/build/platformclientv2/campaigntimeslot.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Campaigntimeslot -type Campaigntimeslot struct { - // StartTime - The start time of the interval as an ISO-8601 string, i.e. HH:mm:ss - StartTime *string `json:"startTime,omitempty"` - - - // StopTime - The end time of the interval as an ISO-8601 string, i.e. HH:mm:ss - StopTime *string `json:"stopTime,omitempty"` - - - // Day - The day of the interval. Valid values: [1-7], representing Monday through Sunday - Day *int `json:"day,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Campaigntimeslot) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/category.go b/build/platformclientv2/category.go deleted file mode 100644 index 849d0c2b9..000000000 --- a/build/platformclientv2/category.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Category - List of available Action categories. -type Category struct { - // Name - Category name - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Category) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/categorylisting.go b/build/platformclientv2/categorylisting.go deleted file mode 100644 index fb777b294..000000000 --- a/build/platformclientv2/categorylisting.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Categorylisting -type Categorylisting struct { - // Entities - Entities *[]Knowledgecategory `json:"entities,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Categorylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/certificate.go b/build/platformclientv2/certificate.go deleted file mode 100644 index 15eee2a88..000000000 --- a/build/platformclientv2/certificate.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Certificate - Represents a certificate to parse. -type Certificate struct { - // Certificate - The certificate to parse. - Certificate *string `json:"certificate,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Certificate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/certificateauthorityentitylisting.go b/build/platformclientv2/certificateauthorityentitylisting.go deleted file mode 100644 index f2e04a7e2..000000000 --- a/build/platformclientv2/certificateauthorityentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Certificateauthorityentitylisting -type Certificateauthorityentitylisting struct { - // Entities - Entities *[]Domaincertificateauthority `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Certificateauthorityentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/certificatedetails.go b/build/platformclientv2/certificatedetails.go deleted file mode 100644 index 3f013df1b..000000000 --- a/build/platformclientv2/certificatedetails.go +++ /dev/null @@ -1,42 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Certificatedetails - Represents the details of a parsed certificate. -type Certificatedetails struct { - // Issuer - Information about the issuer of the certificate. The value of this property is a comma separated key=value format. Each key is one of the attribute names supported by X.500. - Issuer *string `json:"issuer,omitempty"` - - - // Subject - Information about the subject of the certificate. The value of this property is a comma separated key=value format. Each key is one of the attribute names supported by X.500. - Subject *string `json:"subject,omitempty"` - - - // ExpirationDate - The expiration date of the certificate. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ExpirationDate *time.Time `json:"expirationDate,omitempty"` - - - // IssueDate - The issue date of the certificate. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - IssueDate *time.Time `json:"issueDate,omitempty"` - - - // Expired - True if the certificate is expired, false otherwise. - Expired *bool `json:"expired,omitempty"` - - - // SignatureValid - SignatureValid *bool `json:"signatureValid,omitempty"` - - - // Valid - Valid *bool `json:"valid,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Certificatedetails) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/change.go b/build/platformclientv2/change.go deleted file mode 100644 index 34dee2c6c..000000000 --- a/build/platformclientv2/change.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Change -type Change struct { - // Entity - Entity *Auditentity `json:"entity,omitempty"` - - - // Property - The property that was changed - Property *string `json:"property,omitempty"` - - - // OldValues - The old values which were modified and/or removed by this action. - OldValues *[]string `json:"oldValues,omitempty"` - - - // NewValues - The new values which were modified and/or added by this action. - NewValues *[]string `json:"newValues,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Change) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/changemypasswordrequest.go b/build/platformclientv2/changemypasswordrequest.go deleted file mode 100644 index ade750cea..000000000 --- a/build/platformclientv2/changemypasswordrequest.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Changemypasswordrequest -type Changemypasswordrequest struct { - // NewPassword - The new password - NewPassword *string `json:"newPassword,omitempty"` - - - // OldPassword - Your current password - OldPassword *string `json:"oldPassword,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Changemypasswordrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/changepasswordrequest.go b/build/platformclientv2/changepasswordrequest.go deleted file mode 100644 index 47a95f7b9..000000000 --- a/build/platformclientv2/changepasswordrequest.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Changepasswordrequest -type Changepasswordrequest struct { - // NewPassword - The new password - NewPassword *string `json:"newPassword,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Changepasswordrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/channel.go b/build/platformclientv2/channel.go deleted file mode 100644 index 4aaa9963a..000000000 --- a/build/platformclientv2/channel.go +++ /dev/null @@ -1,26 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Channel -type Channel struct { - // ConnectUri - ConnectUri *string `json:"connectUri,omitempty"` - - - // Id - Id *string `json:"id,omitempty"` - - - // Expires - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - Expires *time.Time `json:"expires,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Channel) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/channelentitylisting.go b/build/platformclientv2/channelentitylisting.go deleted file mode 100644 index e159c652c..000000000 --- a/build/platformclientv2/channelentitylisting.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Channelentitylisting -type Channelentitylisting struct { - // Entities - Entities *[]Channel `json:"entities,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Channelentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/channeltopic.go b/build/platformclientv2/channeltopic.go deleted file mode 100644 index f2d5d4be7..000000000 --- a/build/platformclientv2/channeltopic.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Channeltopic -type Channeltopic struct { - // Id - Id *string `json:"id,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Channeltopic) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/channeltopicentitylisting.go b/build/platformclientv2/channeltopicentitylisting.go deleted file mode 100644 index 11df5060e..000000000 --- a/build/platformclientv2/channeltopicentitylisting.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Channeltopicentitylisting -type Channeltopicentitylisting struct { - // Entities - Entities *[]Channeltopic `json:"entities,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Channeltopicentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/chat.go b/build/platformclientv2/chat.go deleted file mode 100644 index 8e0e07ba2..000000000 --- a/build/platformclientv2/chat.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Chat -type Chat struct { - // JabberId - JabberId *string `json:"jabberId,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Chat) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/chatapi.go b/build/platformclientv2/chatapi.go deleted file mode 100644 index d44618865..000000000 --- a/build/platformclientv2/chatapi.go +++ /dev/null @@ -1,237 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "encoding/json" -) - -// ChatApi provides functions for API endpoints -type ChatApi struct { - Configuration *Configuration -} - -// NewChatApi creates an API instance using the default configuration -func NewChatApi() *ChatApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating ChatApi with base path: %s", strings.ToLower(config.BasePath))) - return &ChatApi{ - Configuration: config, - } -} - -// NewChatApiWithConfig creates an API instance using the provided configuration -func NewChatApiWithConfig(config *Configuration) *ChatApi { - config.Debugf("Creating ChatApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &ChatApi{ - Configuration: config, - } -} - -// GetChatSettings invokes GET /api/v2/chat/settings -// -// Get Chat Settings. -// -// -func (a ChatApi) GetChatSettings() (*Chatsettings, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/chat/settings" - defaultReturn := new(Chatsettings) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Chatsettings - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchChatSettings invokes PATCH /api/v2/chat/settings -// -// Patch Chat Settings. -// -// -func (a ChatApi) PatchChatSettings(body Chatsettings) (*Chatsettings, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/chat/settings" - defaultReturn := new(Chatsettings) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ChatApi->PatchChatSettings") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Chatsettings - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutChatSettings invokes PUT /api/v2/chat/settings -// -// Update Chat Settings. -// -// -func (a ChatApi) PutChatSettings(body Chatsettings) (*Chatsettings, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/chat/settings" - defaultReturn := new(Chatsettings) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ChatApi->PutChatSettings") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Chatsettings - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/chatbadgetopicbadgeentity.go b/build/platformclientv2/chatbadgetopicbadgeentity.go deleted file mode 100644 index 596deadc7..000000000 --- a/build/platformclientv2/chatbadgetopicbadgeentity.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Chatbadgetopicbadgeentity -type Chatbadgetopicbadgeentity struct { - // JabberId - JabberId *string `json:"jabberId,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Chatbadgetopicbadgeentity) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/chatbadgetopicchatbadge.go b/build/platformclientv2/chatbadgetopicchatbadge.go deleted file mode 100644 index c17cf7b08..000000000 --- a/build/platformclientv2/chatbadgetopicchatbadge.go +++ /dev/null @@ -1,26 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Chatbadgetopicchatbadge -type Chatbadgetopicchatbadge struct { - // Entity - Entity *Chatbadgetopicbadgeentity `json:"entity,omitempty"` - - - // UnreadCount - UnreadCount *int `json:"unreadCount,omitempty"` - - - // LastUnreadNotificationDate - LastUnreadNotificationDate *time.Time `json:"lastUnreadNotificationDate,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Chatbadgetopicchatbadge) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/chatconversation.go b/build/platformclientv2/chatconversation.go deleted file mode 100644 index a8249b1b8..000000000 --- a/build/platformclientv2/chatconversation.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Chatconversation -type Chatconversation struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Participants - The list of participants involved in the conversation. - Participants *[]Chatmediaparticipant `json:"participants,omitempty"` - - - // OtherMediaUris - The list of other media channels involved in the conversation. - OtherMediaUris *[]string `json:"otherMediaUris,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Chatconversation) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/chatconversationentitylisting.go b/build/platformclientv2/chatconversationentitylisting.go deleted file mode 100644 index 13a156c0c..000000000 --- a/build/platformclientv2/chatconversationentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Chatconversationentitylisting -type Chatconversationentitylisting struct { - // Entities - Entities *[]Chatconversation `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Chatconversationentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/chatmediaparticipant.go b/build/platformclientv2/chatmediaparticipant.go deleted file mode 100644 index 494f0a26a..000000000 --- a/build/platformclientv2/chatmediaparticipant.go +++ /dev/null @@ -1,154 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Chatmediaparticipant -type Chatmediaparticipant struct { - // Id - The unique participant ID. - Id *string `json:"id,omitempty"` - - - // Name - The display friendly name of the participant. - Name *string `json:"name,omitempty"` - - - // Address - The participant address. - Address *string `json:"address,omitempty"` - - - // StartTime - The time when this participant first joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartTime *time.Time `json:"startTime,omitempty"` - - - // ConnectedTime - The time when this participant went connected for this media (eg: video connected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // EndTime - The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - EndTime *time.Time `json:"endTime,omitempty"` - - - // StartHoldTime - The time when this participant's hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartHoldTime *time.Time `json:"startHoldTime,omitempty"` - - - // Purpose - The participant's purpose. Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr - Purpose *string `json:"purpose,omitempty"` - - - // State - The participant's state. Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting - State *string `json:"state,omitempty"` - - - // Direction - The participant's direction. Values can be: 'inbound' or 'outbound' - Direction *string `json:"direction,omitempty"` - - - // DisconnectType - The reason the participant was disconnected from the conversation. - DisconnectType *string `json:"disconnectType,omitempty"` - - - // Held - Value is true when the participant is on hold. - Held *bool `json:"held,omitempty"` - - - // WrapupRequired - Value is true when the participant requires wrap-up. - WrapupRequired *bool `json:"wrapupRequired,omitempty"` - - - // WrapupPrompt - The wrap-up prompt indicating the type of wrap-up to be performed. - WrapupPrompt *string `json:"wrapupPrompt,omitempty"` - - - // User - The PureCloud user for this participant. - User *Domainentityref `json:"user,omitempty"` - - - // Queue - The PureCloud queue for this participant. - Queue *Domainentityref `json:"queue,omitempty"` - - - // Team - The PureCloud team for this participant. - Team *Domainentityref `json:"team,omitempty"` - - - // Attributes - A list of ad-hoc attributes for the participant. - Attributes *map[string]string `json:"attributes,omitempty"` - - - // ErrorInfo - If the conversation ends in error, contains additional error details. - ErrorInfo *Errorinfo `json:"errorInfo,omitempty"` - - - // Script - The Engage script that should be used by this participant. - Script *Domainentityref `json:"script,omitempty"` - - - // WrapupTimeoutMs - The amount of time the participant has to complete wrap-up. - WrapupTimeoutMs *int `json:"wrapupTimeoutMs,omitempty"` - - - // WrapupSkipped - Value is true when the participant has skipped wrap-up. - WrapupSkipped *bool `json:"wrapupSkipped,omitempty"` - - - // AlertingTimeoutMs - Specifies how long the agent has to answer an interaction before being marked as not responding. - AlertingTimeoutMs *int `json:"alertingTimeoutMs,omitempty"` - - - // Provider - The source provider for the communication. - Provider *string `json:"provider,omitempty"` - - - // ExternalContact - If this participant represents an external contact, then this will be the reference for the external contact. - ExternalContact *Domainentityref `json:"externalContact,omitempty"` - - - // ExternalOrganization - If this participant represents an external org, then this will be the reference for the external org. - ExternalOrganization *Domainentityref `json:"externalOrganization,omitempty"` - - - // Wrapup - Wrapup for this participant, if it has been applied. - Wrapup *Wrapup `json:"wrapup,omitempty"` - - - // Peer - The peer communication corresponding to a matching leg for this communication. - Peer *string `json:"peer,omitempty"` - - - // FlaggedReason - The reason specifying why participant flagged the conversation. - FlaggedReason *string `json:"flaggedReason,omitempty"` - - - // JourneyContext - Journey System data/context that is applicable to this communication. When used for historical purposes, the context should be immutable. When null, there is no applicable Journey System context. - JourneyContext *Journeycontext `json:"journeyContext,omitempty"` - - - // ConversationRoutingData - Information on how a communication should be routed to an agent. - ConversationRoutingData *Conversationroutingdata `json:"conversationRoutingData,omitempty"` - - - // StartAcwTime - The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartAcwTime *time.Time `json:"startAcwTime,omitempty"` - - - // EndAcwTime - The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - EndAcwTime *time.Time `json:"endAcwTime,omitempty"` - - - // RoomId - The ID of the chat room. - RoomId *string `json:"roomId,omitempty"` - - - // AvatarImageUrl - If available, the URI to the avatar image of this communication. - AvatarImageUrl *string `json:"avatarImageUrl,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Chatmediaparticipant) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/chatmediapolicy.go b/build/platformclientv2/chatmediapolicy.go deleted file mode 100644 index 73bd1b0bd..000000000 --- a/build/platformclientv2/chatmediapolicy.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Chatmediapolicy -type Chatmediapolicy struct { - // Actions - Actions applied when specified conditions are met - Actions *Policyactions `json:"actions,omitempty"` - - - // Conditions - Conditions for when actions should be applied - Conditions *Chatmediapolicyconditions `json:"conditions,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Chatmediapolicy) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/chatmediapolicyconditions.go b/build/platformclientv2/chatmediapolicyconditions.go deleted file mode 100644 index 0994c73fa..000000000 --- a/build/platformclientv2/chatmediapolicyconditions.go +++ /dev/null @@ -1,41 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Chatmediapolicyconditions -type Chatmediapolicyconditions struct { - // ForUsers - ForUsers *[]User `json:"forUsers,omitempty"` - - - // DateRanges - DateRanges *[]string `json:"dateRanges,omitempty"` - - - // ForQueues - ForQueues *[]Queue `json:"forQueues,omitempty"` - - - // WrapupCodes - WrapupCodes *[]Wrapupcode `json:"wrapupCodes,omitempty"` - - - // Languages - Languages *[]Language `json:"languages,omitempty"` - - - // TimeAllowed - TimeAllowed *Timeallowed `json:"timeAllowed,omitempty"` - - - // Duration - Duration *Durationcondition `json:"duration,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Chatmediapolicyconditions) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/chatmessage.go b/build/platformclientv2/chatmessage.go deleted file mode 100644 index dba09bce2..000000000 --- a/build/platformclientv2/chatmessage.go +++ /dev/null @@ -1,61 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Chatmessage -type Chatmessage struct { - // Body - The message body - Body *string `json:"body,omitempty"` - - - // Id - Id *string `json:"id,omitempty"` - - - // To - The message recipient - To *string `json:"to,omitempty"` - - - // From - The message sender - From *string `json:"from,omitempty"` - - - // Utc - Utc *string `json:"utc,omitempty"` - - - // Chat - The interaction id (if available) - Chat *string `json:"chat,omitempty"` - - - // Message - The message id - Message *string `json:"message,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - - - // BodyType - Type of the message body (v2 chats only) - BodyType *string `json:"bodyType,omitempty"` - - - // SenderCommunicationId - Communication of sender (v2 chats only) - SenderCommunicationId *string `json:"senderCommunicationId,omitempty"` - - - // ParticipantPurpose - Participant purpose of sender (v2 chats only) - ParticipantPurpose *string `json:"participantPurpose,omitempty"` - - - // User - The user information for the sender (if available) - User *Chatmessageuser `json:"user,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Chatmessage) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/chatmessageuser.go b/build/platformclientv2/chatmessageuser.go deleted file mode 100644 index d318c057b..000000000 --- a/build/platformclientv2/chatmessageuser.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Chatmessageuser -type Chatmessageuser struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // DisplayName - DisplayName *string `json:"displayName,omitempty"` - - - // Username - Username *string `json:"username,omitempty"` - - - // Images - Images *[]Userimage `json:"images,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Chatmessageuser) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/chatsettings.go b/build/platformclientv2/chatsettings.go deleted file mode 100644 index a5b7f7419..000000000 --- a/build/platformclientv2/chatsettings.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Chatsettings -type Chatsettings struct { - // MessageRetentionPeriodDays - Retention time for messages in days - MessageRetentionPeriodDays *int `json:"messageRetentionPeriodDays,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Chatsettings) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/clientapp.go b/build/platformclientv2/clientapp.go deleted file mode 100644 index dc971fe6a..000000000 --- a/build/platformclientv2/clientapp.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Clientapp - Details for a ClientApp -type Clientapp struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the integration, used to distinguish this integration from others of the same type. - Name *string `json:"name,omitempty"` - - - // IntegrationType - Type of the integration - IntegrationType *Integrationtype `json:"integrationType,omitempty"` - - - // Notes - Notes about the integration. - Notes *string `json:"notes,omitempty"` - - - // IntendedState - Configured state of the integration. - IntendedState *string `json:"intendedState,omitempty"` - - - // Config - Configuration information for the integration. - Config *Clientappconfigurationinfo `json:"config,omitempty"` - - - // ReportedState - Last reported status of the integration. - ReportedState *Integrationstatusinfo `json:"reportedState,omitempty"` - - - // Attributes - Read-only attributes for the integration. - Attributes *map[string]string `json:"attributes,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Clientapp) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/clientappconfigurationinfo.go b/build/platformclientv2/clientappconfigurationinfo.go deleted file mode 100644 index 379da4228..000000000 --- a/build/platformclientv2/clientappconfigurationinfo.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Clientappconfigurationinfo - Configuration information for the integration -type Clientappconfigurationinfo struct { - // Current - The current, active configuration for the integration. - Current *Integrationconfiguration `json:"current,omitempty"` - - - // Effective - The effective configuration for the app, containing the integration specific configuration along with overrides specified in the integration type. - Effective *Effectiveconfiguration `json:"effective,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Clientappconfigurationinfo) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/clientappentitylisting.go b/build/platformclientv2/clientappentitylisting.go deleted file mode 100644 index 542411088..000000000 --- a/build/platformclientv2/clientappentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Clientappentitylisting -type Clientappentitylisting struct { - // Entities - Entities *[]Clientapp `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Clientappentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/closebuttonstyleproperties.go b/build/platformclientv2/closebuttonstyleproperties.go deleted file mode 100644 index a37cbc3da..000000000 --- a/build/platformclientv2/closebuttonstyleproperties.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Closebuttonstyleproperties -type Closebuttonstyleproperties struct { - // Color - Color of button. (eg. #FF0000) - Color *string `json:"color,omitempty"` - - - // Opacity - Opacity of button. - Opacity *float32 `json:"opacity,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Closebuttonstyleproperties) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/coachingannotation.go b/build/platformclientv2/coachingannotation.go deleted file mode 100644 index 0569b79b2..000000000 --- a/build/platformclientv2/coachingannotation.go +++ /dev/null @@ -1,50 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Coachingannotation -type Coachingannotation struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // CreatedBy - The user who created the annotation. - CreatedBy *Userreference `json:"createdBy,omitempty"` - - - // DateCreated - The date/time the annotation was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // ModifiedBy - The last user to modify the annotation. - ModifiedBy *Userreference `json:"modifiedBy,omitempty"` - - - // DateModified - The date/time the annotation was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // Text - The text of the annotation. - Text *string `json:"text,omitempty"` - - - // IsDeleted - Flag indicating whether the annotation is deleted. - IsDeleted *bool `json:"isDeleted,omitempty"` - - - // AccessType - Determines the permissions required to view this item. - AccessType *string `json:"accessType,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Coachingannotation) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/coachingannotationcreaterequest.go b/build/platformclientv2/coachingannotationcreaterequest.go deleted file mode 100644 index 00246b80f..000000000 --- a/build/platformclientv2/coachingannotationcreaterequest.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Coachingannotationcreaterequest -type Coachingannotationcreaterequest struct { - // Text - The text of the annotation. - Text *string `json:"text,omitempty"` - - - // AccessType - Determines the permissions required to view this item. - AccessType *string `json:"accessType,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Coachingannotationcreaterequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/coachingannotationlist.go b/build/platformclientv2/coachingannotationlist.go deleted file mode 100644 index 30b62c17e..000000000 --- a/build/platformclientv2/coachingannotationlist.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Coachingannotationlist -type Coachingannotationlist struct { - // Entities - Entities *[]Coachingannotation `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Coachingannotationlist) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/coachingapi.go b/build/platformclientv2/coachingapi.go deleted file mode 100644 index d1164c2f2..000000000 --- a/build/platformclientv2/coachingapi.go +++ /dev/null @@ -1,1664 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "encoding/json" -) - -// CoachingApi provides functions for API endpoints -type CoachingApi struct { - Configuration *Configuration -} - -// NewCoachingApi creates an API instance using the default configuration -func NewCoachingApi() *CoachingApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating CoachingApi with base path: %s", strings.ToLower(config.BasePath))) - return &CoachingApi{ - Configuration: config, - } -} - -// NewCoachingApiWithConfig creates an API instance using the provided configuration -func NewCoachingApiWithConfig(config *Configuration) *CoachingApi { - config.Debugf("Creating CoachingApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &CoachingApi{ - Configuration: config, - } -} - -// DeleteCoachingAppointment invokes DELETE /api/v2/coaching/appointments/{appointmentId} -// -// Delete an existing appointment -// -// Permission not required if you are the creator of the appointment -func (a CoachingApi) DeleteCoachingAppointment(appointmentId string) (*Coachingappointmentreference, *APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/coaching/appointments/{appointmentId}" - path = strings.Replace(path, "{appointmentId}", fmt.Sprintf("%v", appointmentId), -1) - defaultReturn := new(Coachingappointmentreference) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'appointmentId' is set - if &appointmentId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'appointmentId' when calling CoachingApi->DeleteCoachingAppointment") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Coachingappointmentreference - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// DeleteCoachingAppointmentAnnotation invokes DELETE /api/v2/coaching/appointments/{appointmentId}/annotations/{annotationId} -// -// 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 -func (a CoachingApi) DeleteCoachingAppointmentAnnotation(appointmentId string, annotationId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/coaching/appointments/{appointmentId}/annotations/{annotationId}" - path = strings.Replace(path, "{appointmentId}", fmt.Sprintf("%v", appointmentId), -1) - path = strings.Replace(path, "{annotationId}", fmt.Sprintf("%v", annotationId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'appointmentId' is set - if &appointmentId == nil { - // - return nil, errors.New("Missing required parameter 'appointmentId' when calling CoachingApi->DeleteCoachingAppointmentAnnotation") - } - // verify the required parameter 'annotationId' is set - if &annotationId == nil { - // - return nil, errors.New("Missing required parameter 'annotationId' when calling CoachingApi->DeleteCoachingAppointmentAnnotation") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// GetCoachingAppointment invokes GET /api/v2/coaching/appointments/{appointmentId} -// -// Retrieve an appointment -// -// Permission not required if you are the attendee, creator or facilitator of the appointment -func (a CoachingApi) GetCoachingAppointment(appointmentId string) (*Coachingappointmentresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/coaching/appointments/{appointmentId}" - path = strings.Replace(path, "{appointmentId}", fmt.Sprintf("%v", appointmentId), -1) - defaultReturn := new(Coachingappointmentresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'appointmentId' is set - if &appointmentId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'appointmentId' when calling CoachingApi->GetCoachingAppointment") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Coachingappointmentresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetCoachingAppointmentAnnotation invokes GET /api/v2/coaching/appointments/{appointmentId}/annotations/{annotationId} -// -// 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). -func (a CoachingApi) GetCoachingAppointmentAnnotation(appointmentId string, annotationId string) (*Coachingannotation, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/coaching/appointments/{appointmentId}/annotations/{annotationId}" - path = strings.Replace(path, "{appointmentId}", fmt.Sprintf("%v", appointmentId), -1) - path = strings.Replace(path, "{annotationId}", fmt.Sprintf("%v", annotationId), -1) - defaultReturn := new(Coachingannotation) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'appointmentId' is set - if &appointmentId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'appointmentId' when calling CoachingApi->GetCoachingAppointmentAnnotation") - } - // verify the required parameter 'annotationId' is set - if &annotationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'annotationId' when calling CoachingApi->GetCoachingAppointmentAnnotation") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Coachingannotation - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetCoachingAppointmentAnnotations invokes GET /api/v2/coaching/appointments/{appointmentId}/annotations -// -// 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). -func (a CoachingApi) GetCoachingAppointmentAnnotations(appointmentId string, pageNumber int, pageSize int) (*Coachingannotationlist, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/coaching/appointments/{appointmentId}/annotations" - path = strings.Replace(path, "{appointmentId}", fmt.Sprintf("%v", appointmentId), -1) - defaultReturn := new(Coachingannotationlist) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'appointmentId' is set - if &appointmentId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'appointmentId' when calling CoachingApi->GetCoachingAppointmentAnnotations") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Coachingannotationlist - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetCoachingAppointmentStatuses invokes GET /api/v2/coaching/appointments/{appointmentId}/statuses -// -// Get the list of status changes for a coaching appointment. -// -// Permission not required if you are an attendee, creator or facilitator of the appointment -func (a CoachingApi) GetCoachingAppointmentStatuses(appointmentId string, pageNumber int, pageSize int) (*Coachingappointmentstatusresponselist, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/coaching/appointments/{appointmentId}/statuses" - path = strings.Replace(path, "{appointmentId}", fmt.Sprintf("%v", appointmentId), -1) - defaultReturn := new(Coachingappointmentstatusresponselist) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'appointmentId' is set - if &appointmentId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'appointmentId' when calling CoachingApi->GetCoachingAppointmentStatuses") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Coachingappointmentstatusresponselist - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetCoachingAppointments invokes GET /api/v2/coaching/appointments -// -// Get appointments for users and optional date range -// -// -func (a CoachingApi) GetCoachingAppointments(userIds []string, interval string, pageNumber int, pageSize int, statuses []string, facilitatorIds []string, sortOrder string, relationships []string, completionInterval string, overdue string) (*Coachingappointmentresponselist, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/coaching/appointments" - defaultReturn := new(Coachingappointmentresponselist) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userIds' is set - if &userIds == nil { - // true - return defaultReturn, nil, errors.New("Missing required parameter 'userIds' when calling CoachingApi->GetCoachingAppointments") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range userIds { - queryParams["userIds"] = value - } - } else { - queryParams["userIds"] = a.Configuration.APIClient.ParameterToString(userIds, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(interval).(string); ok { - if str != "" { - queryParams["interval"] = a.Configuration.APIClient.ParameterToString(interval, collectionFormat) - } - } else { - queryParams["interval"] = a.Configuration.APIClient.ParameterToString(interval, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range statuses { - queryParams["statuses"] = value - } - } else { - queryParams["statuses"] = a.Configuration.APIClient.ParameterToString(statuses, collectionFormat) - } - - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range facilitatorIds { - queryParams["facilitatorIds"] = value - } - } else { - queryParams["facilitatorIds"] = a.Configuration.APIClient.ParameterToString(facilitatorIds, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range relationships { - queryParams["relationships"] = value - } - } else { - queryParams["relationships"] = a.Configuration.APIClient.ParameterToString(relationships, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(completionInterval).(string); ok { - if str != "" { - queryParams["completionInterval"] = a.Configuration.APIClient.ParameterToString(completionInterval, collectionFormat) - } - } else { - queryParams["completionInterval"] = a.Configuration.APIClient.ParameterToString(completionInterval, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(overdue).(string); ok { - if str != "" { - queryParams["overdue"] = a.Configuration.APIClient.ParameterToString(overdue, collectionFormat) - } - } else { - queryParams["overdue"] = a.Configuration.APIClient.ParameterToString(overdue, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Coachingappointmentresponselist - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetCoachingAppointmentsMe invokes GET /api/v2/coaching/appointments/me -// -// Get my appointments for a given date range -// -// -func (a CoachingApi) GetCoachingAppointmentsMe(interval string, pageNumber int, pageSize int, statuses []string, facilitatorIds []string, sortOrder string, relationships []string, completionInterval string, overdue string) (*Coachingappointmentresponselist, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/coaching/appointments/me" - defaultReturn := new(Coachingappointmentresponselist) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(interval).(string); ok { - if str != "" { - queryParams["interval"] = a.Configuration.APIClient.ParameterToString(interval, collectionFormat) - } - } else { - queryParams["interval"] = a.Configuration.APIClient.ParameterToString(interval, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range statuses { - queryParams["statuses"] = value - } - } else { - queryParams["statuses"] = a.Configuration.APIClient.ParameterToString(statuses, collectionFormat) - } - - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range facilitatorIds { - queryParams["facilitatorIds"] = value - } - } else { - queryParams["facilitatorIds"] = a.Configuration.APIClient.ParameterToString(facilitatorIds, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range relationships { - queryParams["relationships"] = value - } - } else { - queryParams["relationships"] = a.Configuration.APIClient.ParameterToString(relationships, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(completionInterval).(string); ok { - if str != "" { - queryParams["completionInterval"] = a.Configuration.APIClient.ParameterToString(completionInterval, collectionFormat) - } - } else { - queryParams["completionInterval"] = a.Configuration.APIClient.ParameterToString(completionInterval, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(overdue).(string); ok { - if str != "" { - queryParams["overdue"] = a.Configuration.APIClient.ParameterToString(overdue, collectionFormat) - } - } else { - queryParams["overdue"] = a.Configuration.APIClient.ParameterToString(overdue, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Coachingappointmentresponselist - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetCoachingNotification invokes GET /api/v2/coaching/notifications/{notificationId} -// -// Get an existing notification -// -// Permission not required if you are the owner of the notification. -func (a CoachingApi) GetCoachingNotification(notificationId string, expand []string) (*Coachingnotification, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/coaching/notifications/{notificationId}" - path = strings.Replace(path, "{notificationId}", fmt.Sprintf("%v", notificationId), -1) - defaultReturn := new(Coachingnotification) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'notificationId' is set - if ¬ificationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'notificationId' when calling CoachingApi->GetCoachingNotification") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Coachingnotification - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetCoachingNotifications invokes GET /api/v2/coaching/notifications -// -// Retrieve the list of your notifications. -// -// -func (a CoachingApi) GetCoachingNotifications(pageNumber int, pageSize int, expand []string) (*Coachingnotificationlist, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/coaching/notifications" - defaultReturn := new(Coachingnotificationlist) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Coachingnotificationlist - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchCoachingAppointment invokes PATCH /api/v2/coaching/appointments/{appointmentId} -// -// Update an existing appointment -// -// Permission not required if you are the creator or facilitator of the appointment -func (a CoachingApi) PatchCoachingAppointment(appointmentId string, body Updatecoachingappointmentrequest) (*Coachingappointmentresponse, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/coaching/appointments/{appointmentId}" - path = strings.Replace(path, "{appointmentId}", fmt.Sprintf("%v", appointmentId), -1) - defaultReturn := new(Coachingappointmentresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'appointmentId' is set - if &appointmentId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'appointmentId' when calling CoachingApi->PatchCoachingAppointment") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling CoachingApi->PatchCoachingAppointment") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Coachingappointmentresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchCoachingAppointmentAnnotation invokes PATCH /api/v2/coaching/appointments/{appointmentId}/annotations/{annotationId} -// -// 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 -func (a CoachingApi) PatchCoachingAppointmentAnnotation(appointmentId string, annotationId string, body Coachingannotation) (*Coachingannotation, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/coaching/appointments/{appointmentId}/annotations/{annotationId}" - path = strings.Replace(path, "{appointmentId}", fmt.Sprintf("%v", appointmentId), -1) - path = strings.Replace(path, "{annotationId}", fmt.Sprintf("%v", annotationId), -1) - defaultReturn := new(Coachingannotation) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'appointmentId' is set - if &appointmentId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'appointmentId' when calling CoachingApi->PatchCoachingAppointmentAnnotation") - } - // verify the required parameter 'annotationId' is set - if &annotationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'annotationId' when calling CoachingApi->PatchCoachingAppointmentAnnotation") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling CoachingApi->PatchCoachingAppointmentAnnotation") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Coachingannotation - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchCoachingAppointmentStatus invokes PATCH /api/v2/coaching/appointments/{appointmentId}/status -// -// Update the status of a coaching appointment -// -// Permission not required if you are an attendee, creator or facilitator of the appointment -func (a CoachingApi) PatchCoachingAppointmentStatus(appointmentId string, body Coachingappointmentstatusrequest) (*Coachingappointmentstatusresponse, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/coaching/appointments/{appointmentId}/status" - path = strings.Replace(path, "{appointmentId}", fmt.Sprintf("%v", appointmentId), -1) - defaultReturn := new(Coachingappointmentstatusresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'appointmentId' is set - if &appointmentId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'appointmentId' when calling CoachingApi->PatchCoachingAppointmentStatus") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling CoachingApi->PatchCoachingAppointmentStatus") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Coachingappointmentstatusresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchCoachingNotification invokes PATCH /api/v2/coaching/notifications/{notificationId} -// -// Update an existing notification. -// -// Can only update your own notifications. -func (a CoachingApi) PatchCoachingNotification(notificationId string, body Coachingnotification) (*Coachingnotification, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/coaching/notifications/{notificationId}" - path = strings.Replace(path, "{notificationId}", fmt.Sprintf("%v", notificationId), -1) - defaultReturn := new(Coachingnotification) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'notificationId' is set - if ¬ificationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'notificationId' when calling CoachingApi->PatchCoachingNotification") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling CoachingApi->PatchCoachingNotification") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Coachingnotification - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostCoachingAppointmentAnnotations invokes POST /api/v2/coaching/appointments/{appointmentId}/annotations -// -// 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). -func (a CoachingApi) PostCoachingAppointmentAnnotations(appointmentId string, body Coachingannotationcreaterequest) (*Coachingannotation, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/coaching/appointments/{appointmentId}/annotations" - path = strings.Replace(path, "{appointmentId}", fmt.Sprintf("%v", appointmentId), -1) - defaultReturn := new(Coachingannotation) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'appointmentId' is set - if &appointmentId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'appointmentId' when calling CoachingApi->PostCoachingAppointmentAnnotations") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling CoachingApi->PostCoachingAppointmentAnnotations") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Coachingannotation - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostCoachingAppointmentConversations invokes POST /api/v2/coaching/appointments/{appointmentId}/conversations -// -// Add a conversation to an appointment -// -// Permission not required if you are the creator or facilitator of the appointment -func (a CoachingApi) PostCoachingAppointmentConversations(appointmentId string, body Addconversationrequest) (*Addconversationresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/coaching/appointments/{appointmentId}/conversations" - path = strings.Replace(path, "{appointmentId}", fmt.Sprintf("%v", appointmentId), -1) - defaultReturn := new(Addconversationresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'appointmentId' is set - if &appointmentId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'appointmentId' when calling CoachingApi->PostCoachingAppointmentConversations") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling CoachingApi->PostCoachingAppointmentConversations") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Addconversationresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostCoachingAppointments invokes POST /api/v2/coaching/appointments -// -// Create a new appointment -// -// -func (a CoachingApi) PostCoachingAppointments(body Createcoachingappointmentrequest) (*Coachingappointmentresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/coaching/appointments" - defaultReturn := new(Coachingappointmentresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling CoachingApi->PostCoachingAppointments") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Coachingappointmentresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostCoachingAppointmentsAggregatesQuery invokes POST /api/v2/coaching/appointments/aggregates/query -// -// Retrieve aggregated appointment data -// -// -func (a CoachingApi) PostCoachingAppointmentsAggregatesQuery(body Coachingappointmentaggregaterequest) (*Coachingappointmentaggregateresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/coaching/appointments/aggregates/query" - defaultReturn := new(Coachingappointmentaggregateresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling CoachingApi->PostCoachingAppointmentsAggregatesQuery") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Coachingappointmentaggregateresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/coachingappointmentaggregaterequest.go b/build/platformclientv2/coachingappointmentaggregaterequest.go deleted file mode 100644 index f1fc6641c..000000000 --- a/build/platformclientv2/coachingappointmentaggregaterequest.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Coachingappointmentaggregaterequest -type Coachingappointmentaggregaterequest struct { - // Interval - Interval to aggregate across. 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 - Interval *string `json:"interval,omitempty"` - - - // Metrics - A list of metrics to aggregate. If omitted, all metrics are returned. - Metrics *[]string `json:"metrics,omitempty"` - - - // GroupBy - An optional list of items by which to group the result data. - GroupBy *[]string `json:"groupBy,omitempty"` - - - // Filter - The filter applied to the data - Filter *Queryrequestfilter `json:"filter,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Coachingappointmentaggregaterequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/coachingappointmentaggregateresponse.go b/build/platformclientv2/coachingappointmentaggregateresponse.go deleted file mode 100644 index 9c9f7d274..000000000 --- a/build/platformclientv2/coachingappointmentaggregateresponse.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Coachingappointmentaggregateresponse -type Coachingappointmentaggregateresponse struct { - // Results - The results of the query - Results *[]Queryresponsegroupeddata `json:"results,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Coachingappointmentaggregateresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/coachingappointmentreference.go b/build/platformclientv2/coachingappointmentreference.go deleted file mode 100644 index cfde355e5..000000000 --- a/build/platformclientv2/coachingappointmentreference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Coachingappointmentreference -type Coachingappointmentreference struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Coachingappointmentreference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/coachingappointmentresponse.go b/build/platformclientv2/coachingappointmentresponse.go deleted file mode 100644 index cd67087ee..000000000 --- a/build/platformclientv2/coachingappointmentresponse.go +++ /dev/null @@ -1,78 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Coachingappointmentresponse - Coaching appointment response -type Coachingappointmentresponse struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of coaching appointment - Name *string `json:"name,omitempty"` - - - // Description - The description of coaching appointment - Description *string `json:"description,omitempty"` - - - // DateStart - The date/time the coaching appointment starts. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateStart *time.Time `json:"dateStart,omitempty"` - - - // LengthInMinutes - The duration of coaching appointment in minutes - LengthInMinutes *int `json:"lengthInMinutes,omitempty"` - - - // Status - The status of coaching appointment - Status *string `json:"status,omitempty"` - - - // Facilitator - The facilitator of coaching appointment - Facilitator *Userreference `json:"facilitator,omitempty"` - - - // Attendees - The list of attendees attending the coaching - Attendees *[]Userreference `json:"attendees,omitempty"` - - - // CreatedBy - The user who created the coaching appointment - CreatedBy *Userreference `json:"createdBy,omitempty"` - - - // DateCreated - The date/time the coaching appointment was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // ModifiedBy - The last user to modify the coaching appointment - ModifiedBy *Userreference `json:"modifiedBy,omitempty"` - - - // DateModified - The date/time the coaching appointment was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // Conversations - The list of conversations associated with coaching appointment. - Conversations *[]Conversationreference `json:"conversations,omitempty"` - - - // Documents - The list of documents associated with coaching appointment. - Documents *[]Documentreference `json:"documents,omitempty"` - - - // IsOverdue - Whether the appointment is overdue. - IsOverdue *bool `json:"isOverdue,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Coachingappointmentresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/coachingappointmentresponselist.go b/build/platformclientv2/coachingappointmentresponselist.go deleted file mode 100644 index 4f985fe9f..000000000 --- a/build/platformclientv2/coachingappointmentresponselist.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Coachingappointmentresponselist -type Coachingappointmentresponselist struct { - // Entities - Entities *[]Coachingappointmentresponse `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Coachingappointmentresponselist) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/coachingappointmentstatusrequest.go b/build/platformclientv2/coachingappointmentstatusrequest.go deleted file mode 100644 index e7d1324ea..000000000 --- a/build/platformclientv2/coachingappointmentstatusrequest.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Coachingappointmentstatusrequest -type Coachingappointmentstatusrequest struct { - // Status - The status of the coaching appointment - Status *string `json:"status,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Coachingappointmentstatusrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/coachingappointmentstatusresponse.go b/build/platformclientv2/coachingappointmentstatusresponse.go deleted file mode 100644 index 0cedb48b6..000000000 --- a/build/platformclientv2/coachingappointmentstatusresponse.go +++ /dev/null @@ -1,30 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Coachingappointmentstatusresponse -type Coachingappointmentstatusresponse struct { - // Appointment - The coaching appointment this status belongs to - Appointment *Coachingappointmentreference `json:"appointment,omitempty"` - - - // CreatedBy - User who updated the status - CreatedBy *Userreference `json:"createdBy,omitempty"` - - - // DateCreated - Creation time of the status. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // Status - The status of the coaching appointment - Status *string `json:"status,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Coachingappointmentstatusresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/coachingappointmentstatusresponselist.go b/build/platformclientv2/coachingappointmentstatusresponselist.go deleted file mode 100644 index 6b852ef6a..000000000 --- a/build/platformclientv2/coachingappointmentstatusresponselist.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Coachingappointmentstatusresponselist -type Coachingappointmentstatusresponselist struct { - // Entities - Entities *[]Coachingappointmentstatusresponse `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Coachingappointmentstatusresponselist) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/coachingnotification.go b/build/platformclientv2/coachingnotification.go deleted file mode 100644 index 00e444a4e..000000000 --- a/build/platformclientv2/coachingnotification.go +++ /dev/null @@ -1,58 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Coachingnotification -type Coachingnotification struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the appointment for this notification. - Name *string `json:"name,omitempty"` - - - // MarkedAsRead - Indicates if notification is read or unread - MarkedAsRead *bool `json:"markedAsRead,omitempty"` - - - // ActionType - Action causing the notification. - ActionType *string `json:"actionType,omitempty"` - - - // Relationship - The relationship of this user to this notification's appointment - Relationship *string `json:"relationship,omitempty"` - - - // DateStart - The start time of the appointment relating to this notification. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateStart *time.Time `json:"dateStart,omitempty"` - - - // LengthInMinutes - The duration of the appointment on this notification - LengthInMinutes *int `json:"lengthInMinutes,omitempty"` - - - // Status - The status of the appointment for this notification - Status *string `json:"status,omitempty"` - - - // User - The user of this notification - User *Userreference `json:"user,omitempty"` - - - // Appointment - The appointment - Appointment *Coachingappointmentresponse `json:"appointment,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Coachingnotification) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/coachingnotificationlist.go b/build/platformclientv2/coachingnotificationlist.go deleted file mode 100644 index e40f08daa..000000000 --- a/build/platformclientv2/coachingnotificationlist.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Coachingnotificationlist -type Coachingnotificationlist struct { - // Entities - Entities *[]Coachingnotification `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Coachingnotificationlist) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/cobrowseconversation.go b/build/platformclientv2/cobrowseconversation.go deleted file mode 100644 index b9f8222ac..000000000 --- a/build/platformclientv2/cobrowseconversation.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Cobrowseconversation -type Cobrowseconversation struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Participants - The list of participants involved in the conversation. - Participants *[]Cobrowsemediaparticipant `json:"participants,omitempty"` - - - // OtherMediaUris - The list of other media channels involved in the conversation. - OtherMediaUris *[]string `json:"otherMediaUris,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Cobrowseconversation) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/cobrowseconversationentitylisting.go b/build/platformclientv2/cobrowseconversationentitylisting.go deleted file mode 100644 index 9ae1f884d..000000000 --- a/build/platformclientv2/cobrowseconversationentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Cobrowseconversationentitylisting -type Cobrowseconversationentitylisting struct { - // Entities - Entities *[]Cobrowseconversation `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Cobrowseconversationentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/cobrowsemediaparticipant.go b/build/platformclientv2/cobrowsemediaparticipant.go deleted file mode 100644 index e55d7f3cd..000000000 --- a/build/platformclientv2/cobrowsemediaparticipant.go +++ /dev/null @@ -1,166 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Cobrowsemediaparticipant -type Cobrowsemediaparticipant struct { - // Id - The unique participant ID. - Id *string `json:"id,omitempty"` - - - // Name - The display friendly name of the participant. - Name *string `json:"name,omitempty"` - - - // Address - The participant address. - Address *string `json:"address,omitempty"` - - - // StartTime - The time when this participant first joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartTime *time.Time `json:"startTime,omitempty"` - - - // ConnectedTime - The time when this participant went connected for this media (eg: video connected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // EndTime - The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - EndTime *time.Time `json:"endTime,omitempty"` - - - // StartHoldTime - The time when this participant's hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartHoldTime *time.Time `json:"startHoldTime,omitempty"` - - - // Purpose - The participant's purpose. Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr - Purpose *string `json:"purpose,omitempty"` - - - // State - The participant's state. Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting - State *string `json:"state,omitempty"` - - - // Direction - The participant's direction. Values can be: 'inbound' or 'outbound' - Direction *string `json:"direction,omitempty"` - - - // DisconnectType - The reason the participant was disconnected from the conversation. - DisconnectType *string `json:"disconnectType,omitempty"` - - - // Held - Value is true when the participant is on hold. - Held *bool `json:"held,omitempty"` - - - // WrapupRequired - Value is true when the participant requires wrap-up. - WrapupRequired *bool `json:"wrapupRequired,omitempty"` - - - // WrapupPrompt - The wrap-up prompt indicating the type of wrap-up to be performed. - WrapupPrompt *string `json:"wrapupPrompt,omitempty"` - - - // User - The PureCloud user for this participant. - User *Domainentityref `json:"user,omitempty"` - - - // Queue - The PureCloud queue for this participant. - Queue *Domainentityref `json:"queue,omitempty"` - - - // Team - The PureCloud team for this participant. - Team *Domainentityref `json:"team,omitempty"` - - - // Attributes - A list of ad-hoc attributes for the participant. - Attributes *map[string]string `json:"attributes,omitempty"` - - - // ErrorInfo - If the conversation ends in error, contains additional error details. - ErrorInfo *Errorinfo `json:"errorInfo,omitempty"` - - - // Script - The Engage script that should be used by this participant. - Script *Domainentityref `json:"script,omitempty"` - - - // WrapupTimeoutMs - The amount of time the participant has to complete wrap-up. - WrapupTimeoutMs *int `json:"wrapupTimeoutMs,omitempty"` - - - // WrapupSkipped - Value is true when the participant has skipped wrap-up. - WrapupSkipped *bool `json:"wrapupSkipped,omitempty"` - - - // AlertingTimeoutMs - Specifies how long the agent has to answer an interaction before being marked as not responding. - AlertingTimeoutMs *int `json:"alertingTimeoutMs,omitempty"` - - - // Provider - The source provider for the communication. - Provider *string `json:"provider,omitempty"` - - - // ExternalContact - If this participant represents an external contact, then this will be the reference for the external contact. - ExternalContact *Domainentityref `json:"externalContact,omitempty"` - - - // ExternalOrganization - If this participant represents an external org, then this will be the reference for the external org. - ExternalOrganization *Domainentityref `json:"externalOrganization,omitempty"` - - - // Wrapup - Wrapup for this participant, if it has been applied. - Wrapup *Wrapup `json:"wrapup,omitempty"` - - - // Peer - The peer communication corresponding to a matching leg for this communication. - Peer *string `json:"peer,omitempty"` - - - // FlaggedReason - The reason specifying why participant flagged the conversation. - FlaggedReason *string `json:"flaggedReason,omitempty"` - - - // JourneyContext - Journey System data/context that is applicable to this communication. When used for historical purposes, the context should be immutable. When null, there is no applicable Journey System context. - JourneyContext *Journeycontext `json:"journeyContext,omitempty"` - - - // ConversationRoutingData - Information on how a communication should be routed to an agent. - ConversationRoutingData *Conversationroutingdata `json:"conversationRoutingData,omitempty"` - - - // StartAcwTime - The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartAcwTime *time.Time `json:"startAcwTime,omitempty"` - - - // EndAcwTime - The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - EndAcwTime *time.Time `json:"endAcwTime,omitempty"` - - - // CobrowseSessionId - The co-browse session ID. - CobrowseSessionId *string `json:"cobrowseSessionId,omitempty"` - - - // CobrowseRole - This value identifies the role of the co-browse client within the co-browse session (a client is a sharer or a viewer). - CobrowseRole *string `json:"cobrowseRole,omitempty"` - - - // Controlling - ID of co-browse participants for which this client has been granted control (list is empty if this client cannot control any shared pages). - Controlling *[]string `json:"controlling,omitempty"` - - - // ViewerUrl - The URL that can be used to open co-browse session in web browser. - ViewerUrl *string `json:"viewerUrl,omitempty"` - - - // ProviderEventTime - The time when the provider event which triggered this conversation update happened in the corrected provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ProviderEventTime *time.Time `json:"providerEventTime,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Cobrowsemediaparticipant) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/cobrowsesession.go b/build/platformclientv2/cobrowsesession.go deleted file mode 100644 index 2efce1bdc..000000000 --- a/build/platformclientv2/cobrowsesession.go +++ /dev/null @@ -1,86 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Cobrowsesession -type Cobrowsesession struct { - // State - The connection state of this communication. - State *string `json:"state,omitempty"` - - - // Id - A globally unique identifier for this communication. - Id *string `json:"id,omitempty"` - - - // DisconnectType - System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects. - DisconnectType *string `json:"disconnectType,omitempty"` - - - // Self - Address and name data for a call endpoint. - Self *Address `json:"self,omitempty"` - - - // CobrowseSessionId - The co-browse session ID. - CobrowseSessionId *string `json:"cobrowseSessionId,omitempty"` - - - // CobrowseRole - This value identifies the role of the co-browse client within the co-browse session (a client is a sharer or a viewer). - CobrowseRole *string `json:"cobrowseRole,omitempty"` - - - // Controlling - ID of co-browse participants for which this client has been granted control (list is empty if this client cannot control any shared pages). - Controlling *[]string `json:"controlling,omitempty"` - - - // ViewerUrl - The URL that can be used to open co-browse session in web browser. - ViewerUrl *string `json:"viewerUrl,omitempty"` - - - // ProviderEventTime - The time when the provider event which triggered this conversation update happened in the corrected provider clock (milliseconds since 1970-01-01 00:00:00 UTC). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ProviderEventTime *time.Time `json:"providerEventTime,omitempty"` - - - // StartAlertingTime - The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartAlertingTime *time.Time `json:"startAlertingTime,omitempty"` - - - // ConnectedTime - The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // DisconnectedTime - The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"` - - - // Provider - The source provider for the co-browse session. - Provider *string `json:"provider,omitempty"` - - - // PeerId - The id of the peer communication corresponding to a matching leg for this communication. - PeerId *string `json:"peerId,omitempty"` - - - // Segments - The time line of the participant's call, divided into activity segments. - Segments *[]Segment `json:"segments,omitempty"` - - - // Wrapup - Call wrap up or disposition data. - Wrapup *Wrapup `json:"wrapup,omitempty"` - - - // AfterCallWork - After-call work for the communication. - AfterCallWork *Aftercallwork `json:"afterCallWork,omitempty"` - - - // AfterCallWorkRequired - Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested. - AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Cobrowsesession) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/commandstatus.go b/build/platformclientv2/commandstatus.go deleted file mode 100644 index 4a84bad04..000000000 --- a/build/platformclientv2/commandstatus.go +++ /dev/null @@ -1,46 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Commandstatus -type Commandstatus struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Expiration - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - Expiration *time.Time `json:"expiration,omitempty"` - - - // UserId - UserId *string `json:"userId,omitempty"` - - - // StatusCode - StatusCode *string `json:"statusCode,omitempty"` - - - // CommandType - CommandType *string `json:"commandType,omitempty"` - - - // Document - Document *Document `json:"document,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Commandstatus) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/commandstatusentitylisting.go b/build/platformclientv2/commandstatusentitylisting.go deleted file mode 100644 index d28d2c905..000000000 --- a/build/platformclientv2/commandstatusentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Commandstatusentitylisting -type Commandstatusentitylisting struct { - // Entities - Entities *[]Commandstatus `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Commandstatusentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/commoncampaign.go b/build/platformclientv2/commoncampaign.go deleted file mode 100644 index afbd72451..000000000 --- a/build/platformclientv2/commoncampaign.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Commoncampaign -type Commoncampaign struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the Campaign. - Name *string `json:"name,omitempty"` - - - // Division - The division to which this entity belongs. - Division *Division `json:"division,omitempty"` - - - // MediaType - The media type used for this campaign. - MediaType *string `json:"mediaType,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Commoncampaign) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/commoncampaigndivisionview.go b/build/platformclientv2/commoncampaigndivisionview.go deleted file mode 100644 index 69cf48614..000000000 --- a/build/platformclientv2/commoncampaigndivisionview.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Commoncampaigndivisionview -type Commoncampaigndivisionview struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the Campaign. - Name *string `json:"name,omitempty"` - - - // Division - The division to which this entity belongs. - Division *Division `json:"division,omitempty"` - - - // MediaType - The media type used for this campaign. - MediaType *string `json:"mediaType,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Commoncampaigndivisionview) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/commoncampaigndivisionviewentitylisting.go b/build/platformclientv2/commoncampaigndivisionviewentitylisting.go deleted file mode 100644 index 99b96a110..000000000 --- a/build/platformclientv2/commoncampaigndivisionviewentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Commoncampaigndivisionviewentitylisting -type Commoncampaigndivisionviewentitylisting struct { - // Entities - Entities *[]Commoncampaigndivisionview `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Commoncampaigndivisionviewentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/commoncampaignentitylisting.go b/build/platformclientv2/commoncampaignentitylisting.go deleted file mode 100644 index 2a7714bda..000000000 --- a/build/platformclientv2/commoncampaignentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Commoncampaignentitylisting -type Commoncampaignentitylisting struct { - // Entities - Entities *[]Commoncampaign `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Commoncampaignentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/condition.go b/build/platformclientv2/condition.go deleted file mode 100644 index af97b391d..000000000 --- a/build/platformclientv2/condition.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Condition -type Condition struct { - // VarType - The type of the condition. - VarType *string `json:"type,omitempty"` - - - // Inverted - If true, inverts the result of evaluating this Condition. Default is false. - Inverted *bool `json:"inverted,omitempty"` - - - // AttributeName - An attribute name associated with this Condition. Required for a contactAttributeCondition. - AttributeName *string `json:"attributeName,omitempty"` - - - // Value - A value associated with this Condition. This could be text, a number, or a relative time. Not used for a DataActionCondition. - Value *string `json:"value,omitempty"` - - - // ValueType - The type of the value associated with this Condition. Not used for a DataActionCondition. - ValueType *string `json:"valueType,omitempty"` - - - // Operator - An operation with which to evaluate the Condition. Not used for a DataActionCondition. - Operator *string `json:"operator,omitempty"` - - - // Codes - List of wrap-up code identifiers. Required for a wrapupCondition. - Codes *[]string `json:"codes,omitempty"` - - - // Property - A value associated with the property type of this Condition. Required for a contactPropertyCondition. - Property *string `json:"property,omitempty"` - - - // PropertyType - The type of the property associated with this Condition. Required for a contactPropertyCondition. - PropertyType *string `json:"propertyType,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Condition) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/configuration.go b/build/platformclientv2/configuration.go deleted file mode 100644 index 64f470887..000000000 --- a/build/platformclientv2/configuration.go +++ /dev/null @@ -1,271 +0,0 @@ -package platformclientv2 - -import ( - "encoding/base64" - "encoding/json" - "fmt" - "net/http" - "net/url" - "regexp" - "sync" - "time" -) - -// Configuration has settings to configure the SDK -type Configuration struct { - UserName string `json:"userName,omitempty"` - Password string `json:"password,omitempty"` - APIKeyPrefix map[string]string `json:"APIKeyPrefix,omitempty"` - APIKey map[string]string `json:"APIKey,omitempty"` - debug bool `json:"debug,omitempty"` - DebugFile string `json:"debugFile,omitempty"` - OAuthToken string `json:"oAuthToken,omitempty"` - Timeout int `json:"timeout,omitempty"` - BasePath string `json:"basePath,omitempty"` - Host string `json:"host,omitempty"` - Scheme string `json:"scheme,omitempty"` - AccessToken string `json:"accessToken,omitempty"` - RefreshToken string `json:"refreshToken,omitempty"` - ClientID string `json:"clientId,omitempty"` - ClientSecret string `json:"clientSecret,omitempty"` - ShouldRefreshAccessToken bool `json:"shouldRefreshAccessToken,omitempty"` - RefreshInProgress int64 `json:"refreshInProgress,omitempty"` - RefreshTokenWaitTime int `json:"refreshTokenWaitTime,omitempty"` - DefaultHeader map[string]string `json:"defaultHeader,omitempty"` - UserAgent string `json:"userAgent,omitempty"` - APIClient APIClient `json:"APIClient,omitempty"` - RetryConfiguration *RetryConfiguration `json:"retryConfiguration,omitempty"` -} - -const ( - USEast1 = "https://api.mypurecloud.com" - EUWest1 = "https://api.mypurecloud.ie" - APSoutheast2 = "https://api.mypurecloud.com.au" - APNortheast1 = "https://api.mypurecloud.jp" - EUCentral1 = "https://api.mypurecloud.de" - USWest2 = "https://api.usw2.pure.cloud" - CACentral1 = "https://api.cac1.pure.cloud" - APNortheast2 = "https://api.apne2.pure.cloud" - EUWest2 = "https://api.euw2.pure.cloud" - APSouth1 = "https://api.aps1.pure.cloud" -) - -type RetryConfiguration struct { - RetryWaitMin time.Duration `json:"retry_wait_min,omitempty"` - RetryWaitMax time.Duration `json:"retry_wait_max,omitempty"` - RetryMax int `json:"retry_max,omitempty"` - RequestLogHook RequestLogHook `json:"request_log_hook,omitempty"` -} - -type RequestLogHook func(*http.Request, int) - -// AuthResponse contains the access token to use in future requests -type AuthResponse struct { - AccessToken string `json:"access_token,omitempty"` - RefreshToken string `json:"refresh_token,omitempty"` - TokenType string `json:"token_type,omitempty"` - ExpiresIn int `json:"expires_in,omitempty"` -} - -// AuthErrorResponse gives you some intel when authorization goes boom -type AuthErrorResponse struct { - Error string `json:"error,omitempty"` - Description string `json:"description,omitempty"` - ErrorDescription string `json:"error_description,omitempty"` -} - -var once sync.Once -var instance *Configuration - -// GetDefaultConfiguration returns the shared default configuration instance -func GetDefaultConfiguration() *Configuration { - once.Do(func() { - instance = NewConfiguration() - }) - return instance -} - -// NewConfiguration returns a new Configuration instance -func NewConfiguration() *Configuration { - c := &Configuration{ - BasePath: "https://api.mypurecloud.com", - UserName: "", - debug: false, - ShouldRefreshAccessToken: true, - RefreshTokenWaitTime: 10, - DefaultHeader: make(map[string]string), - APIKey: make(map[string]string), - APIKeyPrefix: make(map[string]string), - UserAgent: "PureCloud SDK", - } - c.APIClient = NewAPIClient(c) - return c -} - -// AuthorizeClientCredentials authorizes this Configuration instance using client credentials. -// The access token will be set automatically and API instances using this configuration object can now make authorized requests. -func (c *Configuration) AuthorizeClientCredentials(clientID string, clientSecret string) error { - authHostRegex := regexp.MustCompile(`(?i)\/\/api\.`) - authHost := authHostRegex.ReplaceAllString(c.BasePath, "//login.") - headerParams := make(map[string]string) - headerParams["Authorization"] = "Basic " + base64.StdEncoding.EncodeToString([]byte(clientID+":"+clientSecret)) - formParams := url.Values{} - formParams["grant_type"] = []string{"client_credentials"} - response, err := c.APIClient.CallAPI(authHost+"/oauth/token", "POST", nil, headerParams, nil, formParams, "", nil) - if err != nil { - fmt.Println(err) - return err - } - - if response.StatusCode != 200 { - var authErrorResponse *AuthErrorResponse - err = json.Unmarshal([]byte(response.RawBody), &authErrorResponse) - if err != nil { - return err - } - return fmt.Errorf("Auth Error: %v (%v - %v)", authErrorResponse.Description, authErrorResponse.Error, authErrorResponse.ErrorDescription) - } - - var authResponse *AuthResponse - err = json.Unmarshal([]byte(response.RawBody), &authResponse) - if err != nil { - return err - } - c.AccessToken = authResponse.AccessToken - if c.AccessToken == "" { - return fmt.Errorf("Auth Error: No access token found") - } - c.Debugf("Token exipres in %v seconds\n", authResponse.ExpiresIn) - return nil -} - -// AuthorizeCodeGrant authorizes this Configuration instance using an authorization code grant. -// The access and refresh tokens will be set automatically and API instances using this configuration object can now make authorized requests. -func (c *Configuration) AuthorizeCodeGrant(clientID string, clientSecret string, authCode string, redirectUri string) (*AuthResponse, error) { - c.ClientID = clientID - c.ClientSecret = clientSecret - authHostRegex := regexp.MustCompile(`(?i)\/\/api\.`) - authHost := authHostRegex.ReplaceAllString(c.BasePath, "//login.") - headerParams := make(map[string]string) - headerParams["Authorization"] = "Basic " + base64.StdEncoding.EncodeToString([]byte(clientID+":"+clientSecret)) - headerParams["Content-Type"] = "application/x-www-form-urlencoded" - formParams := url.Values{} - formParams["grant_type"] = []string{"authorization_code"} - formParams["code"] = []string{authCode} - formParams["redirect_uri"] = []string{redirectUri} - response, err := c.APIClient.CallAPI(authHost+"/oauth/token", "POST", nil, headerParams, nil, formParams, "", nil) - if err != nil { - fmt.Println(err) - return nil, err - } - - if response.StatusCode != 200 { - var authErrorResponse *AuthErrorResponse - err = json.Unmarshal([]byte(response.RawBody), &authErrorResponse) - if err != nil { - return nil, err - } - return nil, fmt.Errorf("Auth Error: %v (%v - %v)", authErrorResponse.Description, authErrorResponse.Error, authErrorResponse.ErrorDescription) - } - - var authResponse *AuthResponse - err = json.Unmarshal([]byte(response.RawBody), &authResponse) - if err != nil { - return nil, err - } - c.AccessToken = authResponse.AccessToken - if c.AccessToken == "" { - return nil, fmt.Errorf("Auth Error: No access token found") - } - c.RefreshToken = authResponse.RefreshToken - if c.RefreshToken == "" { - return nil, fmt.Errorf("Auth Error: No refresh token found") - } - c.Debugf("Token exipres in %v seconds\n", authResponse.ExpiresIn) - - return authResponse, nil -} - -// RefreshAuthorizationCodeGrant requests a new access token for the authorization code grant. -// The access and refresh tokens will be set automatically and API instances using this configuration object can continue to make authorized requests. -func (c *Configuration) RefreshAuthorizationCodeGrant(clientID string, clientSecret string, refreshToken string) (*AuthResponse, error) { - authHostRegex := regexp.MustCompile(`(?i)\/\/api\.`) - authHost := authHostRegex.ReplaceAllString(c.BasePath, "//login.") - headerParams := make(map[string]string) - headerParams["Authorization"] = "Basic " + base64.StdEncoding.EncodeToString([]byte(clientID+":"+clientSecret)) - headerParams["Content-Type"] = "application/x-www-form-urlencoded" - formParams := url.Values{} - formParams["grant_type"] = []string{"refresh_token"} - formParams["refresh_token"] = []string{refreshToken} - response, err := c.APIClient.CallAPI(authHost+"/oauth/token", "POST", nil, headerParams, nil, formParams, "", nil) - if err != nil { - fmt.Println(err) - return nil, err - } - - if response.StatusCode != 200 { - var authErrorResponse *AuthErrorResponse - err = json.Unmarshal([]byte(response.RawBody), &authErrorResponse) - if err != nil { - return nil, err - } - return nil, fmt.Errorf("Auth Error: %v (%v - %v)", authErrorResponse.Description, authErrorResponse.Error, authErrorResponse.ErrorDescription) - } - - var authResponse *AuthResponse - err = json.Unmarshal([]byte(response.RawBody), &authResponse) - if err != nil { - return nil, err - } - c.AccessToken = authResponse.AccessToken - if c.AccessToken == "" { - return nil, fmt.Errorf("Auth Error: No access token found") - } - c.RefreshToken = authResponse.RefreshToken - if c.RefreshToken == "" { - return nil, fmt.Errorf("Auth Error: No refresh token found") - } - c.Debugf("Token exipres in %v seconds\n", authResponse.ExpiresIn) - - return authResponse, nil -} - -// AddDefaultHeader sets a header that will be set on every request -func (c *Configuration) AddDefaultHeader(key string, value string) { - c.DefaultHeader[key] = value -} - -// GetAPIKeyWithPrefix appends a prefix to the API key -func (c *Configuration) GetAPIKeyWithPrefix(APIKeyIdentifier string) string { - if c.APIKeyPrefix[APIKeyIdentifier] != "" { - return c.APIKeyPrefix[APIKeyIdentifier] + " " + c.APIKey[APIKeyIdentifier] - } - - return c.APIKey[APIKeyIdentifier] -} - -// SetDebug enables debug tracing for HTTP requests, and probably some other stuff -func (c *Configuration) SetDebug(enable bool) { - c.debug = enable -} - -// GetDebug tells you the value of the debug setting in case you forgot -func (c *Configuration) GetDebug() bool { - return c.debug -} - -// Debug prints the provided message using Println if debug tracing is enabled -func (c *Configuration) Debug(msg interface{}) { - if !c.debug { - return - } - fmt.Println(msg) -} - -// Debugf prints the provided formatted message using Printf if debug tracing is enabled -func (c *Configuration) Debugf(msg string, params ...interface{}) { - if !c.debug { - return - } - fmt.Printf(msg, params...) -} diff --git a/build/platformclientv2/connectrate.go b/build/platformclientv2/connectrate.go deleted file mode 100644 index f7f1308b2..000000000 --- a/build/platformclientv2/connectrate.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Connectrate -type Connectrate struct { - // Attempts - Number of call attempts made - Attempts *int `json:"attempts,omitempty"` - - - // Connects - Number of calls with a live voice detected - Connects *int `json:"connects,omitempty"` - - - // ConnectRatio - Ratio of connects to attempts - ConnectRatio *float64 `json:"connectRatio,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Connectrate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/constraintconflictmessage.go b/build/platformclientv2/constraintconflictmessage.go deleted file mode 100644 index cdecce917..000000000 --- a/build/platformclientv2/constraintconflictmessage.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Constraintconflictmessage -type Constraintconflictmessage struct { - // Message - Message for how to resolve a set of conflicted work plan constraints - Message *Workplanconstraintconflictmessage `json:"message,omitempty"` - - - // ConflictedConstraintMessages - Messages for the set of conflicted work plan constraints. Each element indicates the message of a work plan constraint that is conflicted in the set - ConflictedConstraintMessages *[]Workplanconstraintmessage `json:"conflictedConstraintMessages,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Constraintconflictmessage) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/consulttransfer.go b/build/platformclientv2/consulttransfer.go deleted file mode 100644 index 1952884e2..000000000 --- a/build/platformclientv2/consulttransfer.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Consulttransfer -type Consulttransfer struct { - // SpeakTo - Determines to whom the initiating participant is speaking. Defaults to DESTINATION - SpeakTo *string `json:"speakTo,omitempty"` - - - // Destination - Destination phone number and name. - Destination *Destination `json:"destination,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Consulttransfer) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/consulttransferresponse.go b/build/platformclientv2/consulttransferresponse.go deleted file mode 100644 index d8b7cf1a4..000000000 --- a/build/platformclientv2/consulttransferresponse.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Consulttransferresponse -type Consulttransferresponse struct { - // DestinationParticipantId - Participant ID to whom the call is being transferred. - DestinationParticipantId *string `json:"destinationParticipantId,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Consulttransferresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/consulttransferupdate.go b/build/platformclientv2/consulttransferupdate.go deleted file mode 100644 index 483d510d0..000000000 --- a/build/platformclientv2/consulttransferupdate.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Consulttransferupdate -type Consulttransferupdate struct { - // SpeakTo - Determines to whom the initiating participant is speaking. - SpeakTo *string `json:"speakTo,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Consulttransferupdate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/consumedresourcesentitylisting.go b/build/platformclientv2/consumedresourcesentitylisting.go deleted file mode 100644 index 246ff43a5..000000000 --- a/build/platformclientv2/consumedresourcesentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Consumedresourcesentitylisting -type Consumedresourcesentitylisting struct { - // Entities - Entities *[]Dependency `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Consumedresourcesentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/consumingresourcesentitylisting.go b/build/platformclientv2/consumingresourcesentitylisting.go deleted file mode 100644 index 1ce7db9f4..000000000 --- a/build/platformclientv2/consumingresourcesentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Consumingresourcesentitylisting -type Consumingresourcesentitylisting struct { - // Entities - Entities *[]Dependency `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Consumingresourcesentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/contact.go b/build/platformclientv2/contact.go deleted file mode 100644 index 8785382aa..000000000 --- a/build/platformclientv2/contact.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Contact -type Contact struct { - // Address - Email address or phone number for this contact type - Address *string `json:"address,omitempty"` - - - // Display - Formatted version of the address property - Display *string `json:"display,omitempty"` - - - // MediaType - MediaType *string `json:"mediaType,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - - - // Extension - Use internal extension instead of address. Mutually exclusive with the address field. - Extension *string `json:"extension,omitempty"` - - - // CountryCode - CountryCode *string `json:"countryCode,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Contact) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/contactaddress.go b/build/platformclientv2/contactaddress.go deleted file mode 100644 index e89843a51..000000000 --- a/build/platformclientv2/contactaddress.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Contactaddress -type Contactaddress struct { - // Address1 - Address1 *string `json:"address1,omitempty"` - - - // Address2 - Address2 *string `json:"address2,omitempty"` - - - // City - City *string `json:"city,omitempty"` - - - // State - State *string `json:"state,omitempty"` - - - // PostalCode - PostalCode *string `json:"postalCode,omitempty"` - - - // CountryCode - CountryCode *string `json:"countryCode,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Contactaddress) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/contactcallbackrequest.go b/build/platformclientv2/contactcallbackrequest.go deleted file mode 100644 index eb8f5b756..000000000 --- a/build/platformclientv2/contactcallbackrequest.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Contactcallbackrequest -type Contactcallbackrequest struct { - // CampaignId - Campaign identifier - CampaignId *string `json:"campaignId,omitempty"` - - - // ContactListId - Contact list identifier - ContactListId *string `json:"contactListId,omitempty"` - - - // ContactId - Contact identifier - ContactId *string `json:"contactId,omitempty"` - - - // PhoneColumn - Name of the phone column containing the number to be called - PhoneColumn *string `json:"phoneColumn,omitempty"` - - - // Schedule - The scheduled time for the callback as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ\", example = \"2016-01-02T16:59:59\" - Schedule *string `json:"schedule,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Contactcallbackrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/contactcentersettings.go b/build/platformclientv2/contactcentersettings.go deleted file mode 100644 index 9c7bd5d37..000000000 --- a/build/platformclientv2/contactcentersettings.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Contactcentersettings -type Contactcentersettings struct { - // RemoveSkillsFromBlindTransfer - Strip skills from transfer - RemoveSkillsFromBlindTransfer *bool `json:"removeSkillsFromBlindTransfer,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Contactcentersettings) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/contactcolumntimezone.go b/build/platformclientv2/contactcolumntimezone.go deleted file mode 100644 index aededc398..000000000 --- a/build/platformclientv2/contactcolumntimezone.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Contactcolumntimezone -type Contactcolumntimezone struct { - // TimeZone - Time zone that the column matched to. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London - TimeZone *string `json:"timeZone,omitempty"` - - - // ColumnType - Column Type will be either PHONE or ZIP - ColumnType *string `json:"columnType,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Contactcolumntimezone) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/contactcolumntodataactionfieldmapping.go b/build/platformclientv2/contactcolumntodataactionfieldmapping.go deleted file mode 100644 index f57a31487..000000000 --- a/build/platformclientv2/contactcolumntodataactionfieldmapping.go +++ /dev/null @@ -1,13 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Contactcolumntodataactionfieldmapping -type Contactcolumntodataactionfieldmapping struct { } - -// String returns a JSON representation of the model -func (o *Contactcolumntodataactionfieldmapping) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/contactlist.go b/build/platformclientv2/contactlist.go deleted file mode 100644 index 8c8aae42c..000000000 --- a/build/platformclientv2/contactlist.go +++ /dev/null @@ -1,78 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Contactlist -type Contactlist struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // DateCreated - Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // Version - Required for updates, must match the version number of the most recent update - Version *int `json:"version,omitempty"` - - - // Division - The division this entity belongs to. - Division *Domainentityref `json:"division,omitempty"` - - - // ColumnNames - The names of the contact data columns. - ColumnNames *[]string `json:"columnNames,omitempty"` - - - // PhoneColumns - Indicates which columns are phone numbers. - PhoneColumns *[]Contactphonenumbercolumn `json:"phoneColumns,omitempty"` - - - // ImportStatus - The status of the import process. - ImportStatus *Importstatus `json:"importStatus,omitempty"` - - - // PreviewModeColumnName - A column to check if a contact should always be dialed in preview mode. - PreviewModeColumnName *string `json:"previewModeColumnName,omitempty"` - - - // PreviewModeAcceptedValues - The values in the previewModeColumnName column that indicate a contact should always be dialed in preview mode. - PreviewModeAcceptedValues *[]string `json:"previewModeAcceptedValues,omitempty"` - - - // Size - The number of contacts in the ContactList. - Size *int `json:"size,omitempty"` - - - // AttemptLimits - AttemptLimits for this ContactList. - AttemptLimits *Domainentityref `json:"attemptLimits,omitempty"` - - - // AutomaticTimeZoneMapping - Indicates if automatic time zone mapping is to be used for this ContactList. - AutomaticTimeZoneMapping *bool `json:"automaticTimeZoneMapping,omitempty"` - - - // ZipCodeColumnName - The name of contact list column containing the zip code for use with automatic time zone mapping. Only allowed if 'automaticTimeZoneMapping' is set to true. - ZipCodeColumnName *string `json:"zipCodeColumnName,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Contactlist) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/contactlistdivisionview.go b/build/platformclientv2/contactlistdivisionview.go deleted file mode 100644 index 984b89cb4..000000000 --- a/build/platformclientv2/contactlistdivisionview.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Contactlistdivisionview -type Contactlistdivisionview struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Division - The division to which this entity belongs. - Division *Division `json:"division,omitempty"` - - - // ColumnNames - The names of the contact data columns. - ColumnNames *[]string `json:"columnNames,omitempty"` - - - // PhoneColumns - Indicates which columns are phone numbers. - PhoneColumns *[]Contactphonenumbercolumn `json:"phoneColumns,omitempty"` - - - // ImportStatus - The status of the import process. - ImportStatus *Importstatus `json:"importStatus,omitempty"` - - - // Size - The number of contacts in the ContactList. - Size *int `json:"size,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Contactlistdivisionview) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/contactlistdivisionviewlisting.go b/build/platformclientv2/contactlistdivisionviewlisting.go deleted file mode 100644 index 47ecb8810..000000000 --- a/build/platformclientv2/contactlistdivisionviewlisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Contactlistdivisionviewlisting -type Contactlistdivisionviewlisting struct { - // Entities - Entities *[]Contactlistdivisionview `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Contactlistdivisionviewlisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/contactlistdownloadreadyexporturi.go b/build/platformclientv2/contactlistdownloadreadyexporturi.go deleted file mode 100644 index 9332a74a3..000000000 --- a/build/platformclientv2/contactlistdownloadreadyexporturi.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Contactlistdownloadreadyexporturi -type Contactlistdownloadreadyexporturi struct { - // Uri - Uri *string `json:"uri,omitempty"` - - - // ExportTimestamp - ExportTimestamp *string `json:"exportTimestamp,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Contactlistdownloadreadyexporturi) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/contactlistentitylisting.go b/build/platformclientv2/contactlistentitylisting.go deleted file mode 100644 index 56517e8d7..000000000 --- a/build/platformclientv2/contactlistentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Contactlistentitylisting -type Contactlistentitylisting struct { - // Entities - Entities *[]Contactlist `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Contactlistentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/contactlistfilter.go b/build/platformclientv2/contactlistfilter.go deleted file mode 100644 index b03d43271..000000000 --- a/build/platformclientv2/contactlistfilter.go +++ /dev/null @@ -1,50 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Contactlistfilter -type Contactlistfilter struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the list. - Name *string `json:"name,omitempty"` - - - // DateCreated - Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // Version - Required for updates, must match the version number of the most recent update - Version *int `json:"version,omitempty"` - - - // ContactList - The contact list the filter is based on. - ContactList *Domainentityref `json:"contactList,omitempty"` - - - // Clauses - Groups of conditions to filter the contacts by. - Clauses *[]Contactlistfilterclause `json:"clauses,omitempty"` - - - // FilterType - How to join clauses together. - FilterType *string `json:"filterType,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Contactlistfilter) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/contactlistfilterclause.go b/build/platformclientv2/contactlistfilterclause.go deleted file mode 100644 index 5dfc6eb7a..000000000 --- a/build/platformclientv2/contactlistfilterclause.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Contactlistfilterclause -type Contactlistfilterclause struct { - // FilterType - How to join predicates together. - FilterType *string `json:"filterType,omitempty"` - - - // Predicates - Conditions to filter the contacts by. - Predicates *[]Contactlistfilterpredicate `json:"predicates,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Contactlistfilterclause) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/contactlistfilterentitylisting.go b/build/platformclientv2/contactlistfilterentitylisting.go deleted file mode 100644 index e42fdf85b..000000000 --- a/build/platformclientv2/contactlistfilterentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Contactlistfilterentitylisting -type Contactlistfilterentitylisting struct { - // Entities - Entities *[]Contactlistfilter `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Contactlistfilterentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/contactlistfilterpredicate.go b/build/platformclientv2/contactlistfilterpredicate.go deleted file mode 100644 index edc41d41b..000000000 --- a/build/platformclientv2/contactlistfilterpredicate.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Contactlistfilterpredicate -type Contactlistfilterpredicate struct { - // Column - Contact list column from the ContactListFilter's contactList. - Column *string `json:"column,omitempty"` - - - // ColumnType - The type of data in the contact column. - ColumnType *string `json:"columnType,omitempty"` - - - // Operator - The operator for this ContactListFilterPredicate. - Operator *string `json:"operator,omitempty"` - - - // Value - Value with which to compare the contact's data. This could be text, a number, or a relative time. A value for relative time should follow the format PxxDTyyHzzM, where xx, yy, and zz specify the days, hours and minutes. For example, a value of P01DT08H30M corresponds to 1 day, 8 hours, and 30 minutes from now. To specify a time in the past, include a negative sign before each numeric value. For example, a value of P-01DT-08H-30M corresponds to 1 day, 8 hours, and 30 minutes in the past. You can also do things like P01DT00H-30M, which would correspond to 23 hours and 30 minutes from now (1 day - 30 minutes). - Value *string `json:"value,omitempty"` - - - // VarRange - A range of values. Required for operators BETWEEN and IN. - VarRange *Contactlistfilterrange `json:"range,omitempty"` - - - // Inverted - Inverts the result of the predicate (i.e., if the predicate returns true, inverting it will return false). - Inverted *bool `json:"inverted,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Contactlistfilterpredicate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/contactlistfilterrange.go b/build/platformclientv2/contactlistfilterrange.go deleted file mode 100644 index 546f359c9..000000000 --- a/build/platformclientv2/contactlistfilterrange.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Contactlistfilterrange -type Contactlistfilterrange struct { - // Min - The minimum value of the range. Required for the operator BETWEEN. - Min *string `json:"min,omitempty"` - - - // Max - The maximum value of the range. Required for the operator BETWEEN. - Max *string `json:"max,omitempty"` - - - // MinInclusive - Whether or not to include the minimum in the range. - MinInclusive *bool `json:"minInclusive,omitempty"` - - - // MaxInclusive - Whether or not to include the maximum in the range. - MaxInclusive *bool `json:"maxInclusive,omitempty"` - - - // InSet - A set of values that the contact data should be in. Required for the IN operator. - InSet *[]string `json:"inSet,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Contactlistfilterrange) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/contactlistimportstatusimportstatus.go b/build/platformclientv2/contactlistimportstatusimportstatus.go deleted file mode 100644 index 89bd40b96..000000000 --- a/build/platformclientv2/contactlistimportstatusimportstatus.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Contactlistimportstatusimportstatus -type Contactlistimportstatusimportstatus struct { - // ImportState - ImportState *string `json:"importState,omitempty"` - - - // TotalRecords - TotalRecords *int `json:"totalRecords,omitempty"` - - - // CompletedRecords - CompletedRecords *int `json:"completedRecords,omitempty"` - - - // PercentageComplete - PercentageComplete *int `json:"percentageComplete,omitempty"` - - - // FailureReason - FailureReason *string `json:"failureReason,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Contactlistimportstatusimportstatus) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/contactlisting.go b/build/platformclientv2/contactlisting.go deleted file mode 100644 index a9040c750..000000000 --- a/build/platformclientv2/contactlisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Contactlisting -type Contactlisting struct { - // Entities - Entities *[]Externalcontact `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Contactlisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/contactphonenumbercolumn.go b/build/platformclientv2/contactphonenumbercolumn.go deleted file mode 100644 index 9cd88cbee..000000000 --- a/build/platformclientv2/contactphonenumbercolumn.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Contactphonenumbercolumn -type Contactphonenumbercolumn struct { - // ColumnName - The name of the phone column. - ColumnName *string `json:"columnName,omitempty"` - - - // VarType - Indicates the type of the phone column. For example, 'cell' or 'home'. - VarType *string `json:"type,omitempty"` - - - // CallableTimeColumn - A column that indicates the timezone to use for a given contact when checking callable times. Not allowed if 'automaticTimeZoneMapping' is set to true. - CallableTimeColumn *string `json:"callableTimeColumn,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Contactphonenumbercolumn) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/contactsort.go b/build/platformclientv2/contactsort.go deleted file mode 100644 index f543a8570..000000000 --- a/build/platformclientv2/contactsort.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Contactsort -type Contactsort struct { - // FieldName - FieldName *string `json:"fieldName,omitempty"` - - - // Direction - The direction in which to sort contacts. - Direction *string `json:"direction,omitempty"` - - - // Numeric - Whether or not the column contains numeric data. - Numeric *bool `json:"numeric,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Contactsort) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/contentactions.go b/build/platformclientv2/contentactions.go deleted file mode 100644 index 5f41aeeea..000000000 --- a/build/platformclientv2/contentactions.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Contentactions - User actions available on the content. All actions are optional and all actions are executed simultaneously. -type Contentactions struct { - // Url - A URL for a web page to redirect the user to - Url *string `json:"url,omitempty"` - - - // UrlTarget - The target window or tab within the URL's web page. If empty will open a blank page or tab. - UrlTarget *string `json:"urlTarget,omitempty"` - - - // Textback - Text to be sent back in reply when a list item is selected - Textback *string `json:"textback,omitempty"` - - - // CommandName - Execute an organization's specific command - CommandName *string `json:"commandName,omitempty"` - - - // Context - Additional context for the command - Context *map[string]interface{} `json:"context,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Contentactions) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/contentattachment.go b/build/platformclientv2/contentattachment.go deleted file mode 100644 index fdead12e1..000000000 --- a/build/platformclientv2/contentattachment.go +++ /dev/null @@ -1,41 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Contentattachment - Attachment object -type Contentattachment struct { - // Id - Vendor specific ID for media. For example, a LINE sticker ID - Id *string `json:"id,omitempty"` - - - // MediaType - The type of media this instance represents - MediaType *string `json:"mediaType,omitempty"` - - - // Url - Content element url - Url *string `json:"url,omitempty"` - - - // Mime - Content mime type from https://www.iana.org/assignments/media-types/media-types.xhtml - Mime *string `json:"mime,omitempty"` - - - // Text - Text message associated with media element: e.g. caption in case of image. - Text *string `json:"text,omitempty"` - - - // Sha256 - Secure hash of the media content - Sha256 *string `json:"sha256,omitempty"` - - - // Filename - Suggested file name for media file - Filename *string `json:"filename,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Contentattachment) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/contentattributefilteritem.go b/build/platformclientv2/contentattributefilteritem.go deleted file mode 100644 index 963c2d361..000000000 --- a/build/platformclientv2/contentattributefilteritem.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Contentattributefilteritem -type Contentattributefilteritem struct { - // Id - Id *string `json:"id,omitempty"` - - - // Operator - Operator *string `json:"operator,omitempty"` - - - // Values - Values *[]string `json:"values,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Contentattributefilteritem) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/contentfacetfilteritem.go b/build/platformclientv2/contentfacetfilteritem.go deleted file mode 100644 index c9d9fc81c..000000000 --- a/build/platformclientv2/contentfacetfilteritem.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Contentfacetfilteritem -type Contentfacetfilteritem struct { - // Name - Name *string `json:"name,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - - - // Operator - Operator *string `json:"operator,omitempty"` - - - // Values - Values *[]string `json:"values,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Contentfacetfilteritem) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/contentfilteritem.go b/build/platformclientv2/contentfilteritem.go deleted file mode 100644 index 77a819847..000000000 --- a/build/platformclientv2/contentfilteritem.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Contentfilteritem -type Contentfilteritem struct { - // Name - Name *string `json:"name,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - - - // Operator - Operator *string `json:"operator,omitempty"` - - - // Values - Values *[]string `json:"values,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Contentfilteritem) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/contentgeneric.go b/build/platformclientv2/contentgeneric.go deleted file mode 100644 index 3ae09f2e4..000000000 --- a/build/platformclientv2/contentgeneric.go +++ /dev/null @@ -1,41 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Contentgeneric - Generic content object -type Contentgeneric struct { - // Id - An ID assigned to this rich message content. Each instance inside the content array has a unique ID. - Id *string `json:"id,omitempty"` - - - // Title - Text to show in the title row - Title *string `json:"title,omitempty"` - - - // Description - Text to show in the description row. This is immediately below the title - Description *string `json:"description,omitempty"` - - - // Image - Path or URI to an image file - Image *string `json:"image,omitempty"` - - - // Video - Path or URI to a video file - Video *string `json:"video,omitempty"` - - - // Actions - User actions available on the content. All actions are optional and all actions are executed simultaneously. - Actions *Contentactions `json:"actions,omitempty"` - - - // Components - An array of component objects - Components *[]Buttoncomponent `json:"components,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Contentgeneric) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/contentlist.go b/build/platformclientv2/contentlist.go deleted file mode 100644 index adca61f1d..000000000 --- a/build/platformclientv2/contentlist.go +++ /dev/null @@ -1,41 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Contentlist - List content object -type Contentlist struct { - // Id - An ID assigned to this rich message content. Each instance inside the content array has a unique ID. - Id *string `json:"id,omitempty"` - - - // ListType - The type of list this instance represents - ListType *string `json:"listType,omitempty"` - - - // Title - Text to show in the title row - Title *string `json:"title,omitempty"` - - - // Description - Text to show in the description row. This is immediately below the title - Description *string `json:"description,omitempty"` - - - // SubmitLabel - Label for Submit button - SubmitLabel *string `json:"submitLabel,omitempty"` - - - // Actions - User actions available on the content. All actions are optional and all actions are executed simultaneously. - Actions *Contentactions `json:"actions,omitempty"` - - - // Components - An array of component objects - Components *[]Listitemcomponent `json:"components,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Contentlist) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/contentlocation.go b/build/platformclientv2/contentlocation.go deleted file mode 100644 index e30aba580..000000000 --- a/build/platformclientv2/contentlocation.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Contentlocation - Location object -type Contentlocation struct { - // Url - Location map url - Url *string `json:"url,omitempty"` - - - // Address - Location postal address - Address *string `json:"address,omitempty"` - - - // Text - Location name - Text *string `json:"text,omitempty"` - - - // Latitude - Latitude of the location - Latitude *float64 `json:"latitude,omitempty"` - - - // Longitude - Longitude of the location - Longitude *float64 `json:"longitude,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Contentlocation) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/contentmanagementapi.go b/build/platformclientv2/contentmanagementapi.go deleted file mode 100644 index c87e68a90..000000000 --- a/build/platformclientv2/contentmanagementapi.go +++ /dev/null @@ -1,3496 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "encoding/json" -) - -// ContentManagementApi provides functions for API endpoints -type ContentManagementApi struct { - Configuration *Configuration -} - -// NewContentManagementApi creates an API instance using the default configuration -func NewContentManagementApi() *ContentManagementApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating ContentManagementApi with base path: %s", strings.ToLower(config.BasePath))) - return &ContentManagementApi{ - Configuration: config, - } -} - -// NewContentManagementApiWithConfig creates an API instance using the provided configuration -func NewContentManagementApiWithConfig(config *Configuration) *ContentManagementApi { - config.Debugf("Creating ContentManagementApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &ContentManagementApi{ - Configuration: config, - } -} - -// DeleteContentmanagementDocument invokes DELETE /api/v2/contentmanagement/documents/{documentId} -// -// Delete a document. -// -// -func (a ContentManagementApi) DeleteContentmanagementDocument(documentId string, override bool) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/contentmanagement/documents/{documentId}" - path = strings.Replace(path, "{documentId}", fmt.Sprintf("%v", documentId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'documentId' is set - if &documentId == nil { - // - return nil, errors.New("Missing required parameter 'documentId' when calling ContentManagementApi->DeleteContentmanagementDocument") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(override).(string); ok { - if str != "" { - queryParams["override"] = a.Configuration.APIClient.ParameterToString(override, collectionFormat) - } - } else { - queryParams["override"] = a.Configuration.APIClient.ParameterToString(override, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteContentmanagementShare invokes DELETE /api/v2/contentmanagement/shares/{shareId} -// -// Deletes an existing share. -// -// This revokes sharing rights specified in the share record -func (a ContentManagementApi) DeleteContentmanagementShare(shareId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/contentmanagement/shares/{shareId}" - path = strings.Replace(path, "{shareId}", fmt.Sprintf("%v", shareId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'shareId' is set - if &shareId == nil { - // - return nil, errors.New("Missing required parameter 'shareId' when calling ContentManagementApi->DeleteContentmanagementShare") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteContentmanagementStatusStatusId invokes DELETE /api/v2/contentmanagement/status/{statusId} -// -// Cancel the command for this status -// -// -func (a ContentManagementApi) DeleteContentmanagementStatusStatusId(statusId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/contentmanagement/status/{statusId}" - path = strings.Replace(path, "{statusId}", fmt.Sprintf("%v", statusId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'statusId' is set - if &statusId == nil { - // - return nil, errors.New("Missing required parameter 'statusId' when calling ContentManagementApi->DeleteContentmanagementStatusStatusId") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteContentmanagementWorkspace invokes DELETE /api/v2/contentmanagement/workspaces/{workspaceId} -// -// Delete a workspace -// -// -func (a ContentManagementApi) DeleteContentmanagementWorkspace(workspaceId string, moveChildrenToWorkspaceId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/contentmanagement/workspaces/{workspaceId}" - path = strings.Replace(path, "{workspaceId}", fmt.Sprintf("%v", workspaceId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'workspaceId' is set - if &workspaceId == nil { - // - return nil, errors.New("Missing required parameter 'workspaceId' when calling ContentManagementApi->DeleteContentmanagementWorkspace") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(moveChildrenToWorkspaceId).(string); ok { - if str != "" { - queryParams["moveChildrenToWorkspaceId"] = a.Configuration.APIClient.ParameterToString(moveChildrenToWorkspaceId, collectionFormat) - } - } else { - queryParams["moveChildrenToWorkspaceId"] = a.Configuration.APIClient.ParameterToString(moveChildrenToWorkspaceId, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteContentmanagementWorkspaceMember invokes DELETE /api/v2/contentmanagement/workspaces/{workspaceId}/members/{memberId} -// -// Delete a member from a workspace -// -// -func (a ContentManagementApi) DeleteContentmanagementWorkspaceMember(workspaceId string, memberId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/contentmanagement/workspaces/{workspaceId}/members/{memberId}" - path = strings.Replace(path, "{workspaceId}", fmt.Sprintf("%v", workspaceId), -1) - path = strings.Replace(path, "{memberId}", fmt.Sprintf("%v", memberId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'workspaceId' is set - if &workspaceId == nil { - // - return nil, errors.New("Missing required parameter 'workspaceId' when calling ContentManagementApi->DeleteContentmanagementWorkspaceMember") - } - // verify the required parameter 'memberId' is set - if &memberId == nil { - // - return nil, errors.New("Missing required parameter 'memberId' when calling ContentManagementApi->DeleteContentmanagementWorkspaceMember") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteContentmanagementWorkspaceTagvalue invokes DELETE /api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId} -// -// Delete workspace tag -// -// Delete a tag from a workspace. Will remove this tag from all documents. -func (a ContentManagementApi) DeleteContentmanagementWorkspaceTagvalue(workspaceId string, tagId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId}" - path = strings.Replace(path, "{workspaceId}", fmt.Sprintf("%v", workspaceId), -1) - path = strings.Replace(path, "{tagId}", fmt.Sprintf("%v", tagId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'workspaceId' is set - if &workspaceId == nil { - // - return nil, errors.New("Missing required parameter 'workspaceId' when calling ContentManagementApi->DeleteContentmanagementWorkspaceTagvalue") - } - // verify the required parameter 'tagId' is set - if &tagId == nil { - // - return nil, errors.New("Missing required parameter 'tagId' when calling ContentManagementApi->DeleteContentmanagementWorkspaceTagvalue") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// GetContentmanagementDocument invokes GET /api/v2/contentmanagement/documents/{documentId} -// -// Get a document. -// -// -func (a ContentManagementApi) GetContentmanagementDocument(documentId string, expand []string) (*Document, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/contentmanagement/documents/{documentId}" - path = strings.Replace(path, "{documentId}", fmt.Sprintf("%v", documentId), -1) - defaultReturn := new(Document) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'documentId' is set - if &documentId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'documentId' when calling ContentManagementApi->GetContentmanagementDocument") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Document - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetContentmanagementDocumentAudits invokes GET /api/v2/contentmanagement/documents/{documentId}/audits -// -// Get a list of audits for a document. -// -// -func (a ContentManagementApi) GetContentmanagementDocumentAudits(documentId string, pageSize int, pageNumber int, transactionFilter string, level string, sortBy string, sortOrder string) (*Documentauditentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/contentmanagement/documents/{documentId}/audits" - path = strings.Replace(path, "{documentId}", fmt.Sprintf("%v", documentId), -1) - defaultReturn := new(Documentauditentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'documentId' is set - if &documentId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'documentId' when calling ContentManagementApi->GetContentmanagementDocumentAudits") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(transactionFilter).(string); ok { - if str != "" { - queryParams["transactionFilter"] = a.Configuration.APIClient.ParameterToString(transactionFilter, collectionFormat) - } - } else { - queryParams["transactionFilter"] = a.Configuration.APIClient.ParameterToString(transactionFilter, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(level).(string); ok { - if str != "" { - queryParams["level"] = a.Configuration.APIClient.ParameterToString(level, collectionFormat) - } - } else { - queryParams["level"] = a.Configuration.APIClient.ParameterToString(level, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Documentauditentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetContentmanagementDocumentContent invokes GET /api/v2/contentmanagement/documents/{documentId}/content -// -// Download a document. -// -// -func (a ContentManagementApi) GetContentmanagementDocumentContent(documentId string, disposition string, contentType string) (*Downloadresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/contentmanagement/documents/{documentId}/content" - path = strings.Replace(path, "{documentId}", fmt.Sprintf("%v", documentId), -1) - defaultReturn := new(Downloadresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'documentId' is set - if &documentId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'documentId' when calling ContentManagementApi->GetContentmanagementDocumentContent") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(disposition).(string); ok { - if str != "" { - queryParams["disposition"] = a.Configuration.APIClient.ParameterToString(disposition, collectionFormat) - } - } else { - queryParams["disposition"] = a.Configuration.APIClient.ParameterToString(disposition, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(contentType).(string); ok { - if str != "" { - queryParams["contentType"] = a.Configuration.APIClient.ParameterToString(contentType, collectionFormat) - } - } else { - queryParams["contentType"] = a.Configuration.APIClient.ParameterToString(contentType, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Downloadresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetContentmanagementDocuments invokes GET /api/v2/contentmanagement/documents -// -// Get a list of documents. -// -// -func (a ContentManagementApi) GetContentmanagementDocuments(workspaceId string, name string, expand []string, pageSize int, pageNumber int, sortBy string, sortOrder string) (*Documententitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/contentmanagement/documents" - defaultReturn := new(Documententitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'workspaceId' is set - if &workspaceId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'workspaceId' when calling ContentManagementApi->GetContentmanagementDocuments") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(workspaceId).(string); ok { - if str != "" { - queryParams["workspaceId"] = a.Configuration.APIClient.ParameterToString(workspaceId, collectionFormat) - } - } else { - queryParams["workspaceId"] = a.Configuration.APIClient.ParameterToString(workspaceId, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Documententitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetContentmanagementQuery invokes GET /api/v2/contentmanagement/query -// -// Query content -// -// -func (a ContentManagementApi) GetContentmanagementQuery(queryPhrase string, pageSize int, pageNumber int, sortBy string, sortOrder string, expand []string) (*Queryresults, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/contentmanagement/query" - defaultReturn := new(Queryresults) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'queryPhrase' is set - if &queryPhrase == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'queryPhrase' when calling ContentManagementApi->GetContentmanagementQuery") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(queryPhrase).(string); ok { - if str != "" { - queryParams["queryPhrase"] = a.Configuration.APIClient.ParameterToString(queryPhrase, collectionFormat) - } - } else { - queryParams["queryPhrase"] = a.Configuration.APIClient.ParameterToString(queryPhrase, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Queryresults - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetContentmanagementSecurityprofile invokes GET /api/v2/contentmanagement/securityprofiles/{securityProfileId} -// -// Get a Security Profile -// -// -func (a ContentManagementApi) GetContentmanagementSecurityprofile(securityProfileId string) (*Securityprofile, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/contentmanagement/securityprofiles/{securityProfileId}" - path = strings.Replace(path, "{securityProfileId}", fmt.Sprintf("%v", securityProfileId), -1) - defaultReturn := new(Securityprofile) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'securityProfileId' is set - if &securityProfileId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'securityProfileId' when calling ContentManagementApi->GetContentmanagementSecurityprofile") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Securityprofile - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetContentmanagementSecurityprofiles invokes GET /api/v2/contentmanagement/securityprofiles -// -// Get a List of Security Profiles -// -// -func (a ContentManagementApi) GetContentmanagementSecurityprofiles() (*Securityprofileentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/contentmanagement/securityprofiles" - defaultReturn := new(Securityprofileentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Securityprofileentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetContentmanagementShare invokes GET /api/v2/contentmanagement/shares/{shareId} -// -// Retrieve details about an existing share. -// -// -func (a ContentManagementApi) GetContentmanagementShare(shareId string, expand []string) (*Share, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/contentmanagement/shares/{shareId}" - path = strings.Replace(path, "{shareId}", fmt.Sprintf("%v", shareId), -1) - defaultReturn := new(Share) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'shareId' is set - if &shareId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'shareId' when calling ContentManagementApi->GetContentmanagementShare") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Share - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetContentmanagementSharedSharedId invokes GET /api/v2/contentmanagement/shared/{sharedId} -// -// Get shared documents. Securely download a shared document. -// -// This method requires the download sharing URI obtained in the get document response (downloadSharingUri). Documents may be shared between users in the same workspace. Documents may also be shared between any user by creating a content management share. -func (a ContentManagementApi) GetContentmanagementSharedSharedId(sharedId string, redirect bool, disposition string, contentType string, expand string) (*Sharedresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/contentmanagement/shared/{sharedId}" - path = strings.Replace(path, "{sharedId}", fmt.Sprintf("%v", sharedId), -1) - defaultReturn := new(Sharedresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'sharedId' is set - if &sharedId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'sharedId' when calling ContentManagementApi->GetContentmanagementSharedSharedId") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(redirect).(string); ok { - if str != "" { - queryParams["redirect"] = a.Configuration.APIClient.ParameterToString(redirect, collectionFormat) - } - } else { - queryParams["redirect"] = a.Configuration.APIClient.ParameterToString(redirect, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(disposition).(string); ok { - if str != "" { - queryParams["disposition"] = a.Configuration.APIClient.ParameterToString(disposition, collectionFormat) - } - } else { - queryParams["disposition"] = a.Configuration.APIClient.ParameterToString(disposition, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(contentType).(string); ok { - if str != "" { - queryParams["contentType"] = a.Configuration.APIClient.ParameterToString(contentType, collectionFormat) - } - } else { - queryParams["contentType"] = a.Configuration.APIClient.ParameterToString(contentType, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(expand).(string); ok { - if str != "" { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Sharedresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetContentmanagementShares invokes GET /api/v2/contentmanagement/shares -// -// Gets a list of shares. You must specify at least one filter (e.g. entityId). -// -// Failing to specify a filter will return 400. -func (a ContentManagementApi) GetContentmanagementShares(entityId string, expand []string, pageSize int, pageNumber int) (*Shareentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/contentmanagement/shares" - defaultReturn := new(Shareentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(entityId).(string); ok { - if str != "" { - queryParams["entityId"] = a.Configuration.APIClient.ParameterToString(entityId, collectionFormat) - } - } else { - queryParams["entityId"] = a.Configuration.APIClient.ParameterToString(entityId, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Shareentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetContentmanagementStatus invokes GET /api/v2/contentmanagement/status -// -// Get a list of statuses for pending operations -// -// -func (a ContentManagementApi) GetContentmanagementStatus(pageSize int, pageNumber int) (*Commandstatusentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/contentmanagement/status" - defaultReturn := new(Commandstatusentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Commandstatusentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetContentmanagementStatusStatusId invokes GET /api/v2/contentmanagement/status/{statusId} -// -// Get a status. -// -// -func (a ContentManagementApi) GetContentmanagementStatusStatusId(statusId string) (*Commandstatus, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/contentmanagement/status/{statusId}" - path = strings.Replace(path, "{statusId}", fmt.Sprintf("%v", statusId), -1) - defaultReturn := new(Commandstatus) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'statusId' is set - if &statusId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'statusId' when calling ContentManagementApi->GetContentmanagementStatusStatusId") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Commandstatus - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetContentmanagementUsage invokes GET /api/v2/contentmanagement/usage -// -// Get usage details. -// -// -func (a ContentManagementApi) GetContentmanagementUsage() (*Usage, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/contentmanagement/usage" - defaultReturn := new(Usage) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Usage - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetContentmanagementWorkspace invokes GET /api/v2/contentmanagement/workspaces/{workspaceId} -// -// Get a workspace. -// -// -func (a ContentManagementApi) GetContentmanagementWorkspace(workspaceId string, expand []string) (*Workspace, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/contentmanagement/workspaces/{workspaceId}" - path = strings.Replace(path, "{workspaceId}", fmt.Sprintf("%v", workspaceId), -1) - defaultReturn := new(Workspace) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'workspaceId' is set - if &workspaceId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'workspaceId' when calling ContentManagementApi->GetContentmanagementWorkspace") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Workspace - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetContentmanagementWorkspaceDocuments invokes GET /api/v2/contentmanagement/workspaces/{workspaceId}/documents -// -// Get a list of documents. -// -// -func (a ContentManagementApi) GetContentmanagementWorkspaceDocuments(workspaceId string, expand []string, pageSize int, pageNumber int, sortBy string, sortOrder string) (*Documententitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/contentmanagement/workspaces/{workspaceId}/documents" - path = strings.Replace(path, "{workspaceId}", fmt.Sprintf("%v", workspaceId), -1) - defaultReturn := new(Documententitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'workspaceId' is set - if &workspaceId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'workspaceId' when calling ContentManagementApi->GetContentmanagementWorkspaceDocuments") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Documententitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetContentmanagementWorkspaceMember invokes GET /api/v2/contentmanagement/workspaces/{workspaceId}/members/{memberId} -// -// Get a workspace member -// -// -func (a ContentManagementApi) GetContentmanagementWorkspaceMember(workspaceId string, memberId string, expand []string) (*Workspacemember, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/contentmanagement/workspaces/{workspaceId}/members/{memberId}" - path = strings.Replace(path, "{workspaceId}", fmt.Sprintf("%v", workspaceId), -1) - path = strings.Replace(path, "{memberId}", fmt.Sprintf("%v", memberId), -1) - defaultReturn := new(Workspacemember) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'workspaceId' is set - if &workspaceId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'workspaceId' when calling ContentManagementApi->GetContentmanagementWorkspaceMember") - } - // verify the required parameter 'memberId' is set - if &memberId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'memberId' when calling ContentManagementApi->GetContentmanagementWorkspaceMember") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Workspacemember - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetContentmanagementWorkspaceMembers invokes GET /api/v2/contentmanagement/workspaces/{workspaceId}/members -// -// Get a list workspace members -// -// -func (a ContentManagementApi) GetContentmanagementWorkspaceMembers(workspaceId string, pageSize int, pageNumber int, expand []string) (*Workspacememberentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/contentmanagement/workspaces/{workspaceId}/members" - path = strings.Replace(path, "{workspaceId}", fmt.Sprintf("%v", workspaceId), -1) - defaultReturn := new(Workspacememberentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'workspaceId' is set - if &workspaceId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'workspaceId' when calling ContentManagementApi->GetContentmanagementWorkspaceMembers") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Workspacememberentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetContentmanagementWorkspaceTagvalue invokes GET /api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId} -// -// Get a workspace tag -// -// -func (a ContentManagementApi) GetContentmanagementWorkspaceTagvalue(workspaceId string, tagId string, expand []string) (*Tagvalue, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId}" - path = strings.Replace(path, "{workspaceId}", fmt.Sprintf("%v", workspaceId), -1) - path = strings.Replace(path, "{tagId}", fmt.Sprintf("%v", tagId), -1) - defaultReturn := new(Tagvalue) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'workspaceId' is set - if &workspaceId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'workspaceId' when calling ContentManagementApi->GetContentmanagementWorkspaceTagvalue") - } - // verify the required parameter 'tagId' is set - if &tagId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'tagId' when calling ContentManagementApi->GetContentmanagementWorkspaceTagvalue") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Tagvalue - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetContentmanagementWorkspaceTagvalues invokes GET /api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues -// -// Get a list of workspace tags -// -// -func (a ContentManagementApi) GetContentmanagementWorkspaceTagvalues(workspaceId string, value string, pageSize int, pageNumber int, expand []string) (*Tagvalueentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues" - path = strings.Replace(path, "{workspaceId}", fmt.Sprintf("%v", workspaceId), -1) - defaultReturn := new(Tagvalueentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'workspaceId' is set - if &workspaceId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'workspaceId' when calling ContentManagementApi->GetContentmanagementWorkspaceTagvalues") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(value).(string); ok { - if str != "" { - queryParams["value"] = a.Configuration.APIClient.ParameterToString(value, collectionFormat) - } - } else { - queryParams["value"] = a.Configuration.APIClient.ParameterToString(value, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Tagvalueentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetContentmanagementWorkspaces invokes GET /api/v2/contentmanagement/workspaces -// -// Get a list of workspaces. -// -// Specifying 'content' access will return all workspaces the user has document access to, while 'admin' access will return all group workspaces the user has administrative rights to. -func (a ContentManagementApi) GetContentmanagementWorkspaces(pageSize int, pageNumber int, access []string, expand []string) (*Workspaceentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/contentmanagement/workspaces" - defaultReturn := new(Workspaceentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range access { - queryParams["access"] = value - } - } else { - queryParams["access"] = a.Configuration.APIClient.ParameterToString(access, collectionFormat) - } - - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Workspaceentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostContentmanagementAuditquery invokes POST /api/v2/contentmanagement/auditquery -// -// Query audits -// -// -func (a ContentManagementApi) PostContentmanagementAuditquery(body Contentqueryrequest) (*Queryresults, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/contentmanagement/auditquery" - defaultReturn := new(Queryresults) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ContentManagementApi->PostContentmanagementAuditquery") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Queryresults - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostContentmanagementDocument invokes POST /api/v2/contentmanagement/documents/{documentId} -// -// Update a document. -// -// -func (a ContentManagementApi) PostContentmanagementDocument(documentId string, body Documentupdate, expand string, override bool) (*Document, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/contentmanagement/documents/{documentId}" - path = strings.Replace(path, "{documentId}", fmt.Sprintf("%v", documentId), -1) - defaultReturn := new(Document) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'documentId' is set - if &documentId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'documentId' when calling ContentManagementApi->PostContentmanagementDocument") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ContentManagementApi->PostContentmanagementDocument") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(expand).(string); ok { - if str != "" { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(override).(string); ok { - if str != "" { - queryParams["override"] = a.Configuration.APIClient.ParameterToString(override, collectionFormat) - } - } else { - queryParams["override"] = a.Configuration.APIClient.ParameterToString(override, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Document - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostContentmanagementDocumentContent invokes POST /api/v2/contentmanagement/documents/{documentId}/content -// -// Replace the contents of a document. -// -// -func (a ContentManagementApi) PostContentmanagementDocumentContent(documentId string, body Replacerequest, override bool) (*Replaceresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/contentmanagement/documents/{documentId}/content" - path = strings.Replace(path, "{documentId}", fmt.Sprintf("%v", documentId), -1) - defaultReturn := new(Replaceresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'documentId' is set - if &documentId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'documentId' when calling ContentManagementApi->PostContentmanagementDocumentContent") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ContentManagementApi->PostContentmanagementDocumentContent") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(override).(string); ok { - if str != "" { - queryParams["override"] = a.Configuration.APIClient.ParameterToString(override, collectionFormat) - } - } else { - queryParams["override"] = a.Configuration.APIClient.ParameterToString(override, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Replaceresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostContentmanagementDocuments invokes POST /api/v2/contentmanagement/documents -// -// Add a document. -// -// -func (a ContentManagementApi) PostContentmanagementDocuments(body Documentupload, copySource string, moveSource string, override bool) (*Document, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/contentmanagement/documents" - defaultReturn := new(Document) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ContentManagementApi->PostContentmanagementDocuments") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(copySource).(string); ok { - if str != "" { - queryParams["copySource"] = a.Configuration.APIClient.ParameterToString(copySource, collectionFormat) - } - } else { - queryParams["copySource"] = a.Configuration.APIClient.ParameterToString(copySource, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(moveSource).(string); ok { - if str != "" { - queryParams["moveSource"] = a.Configuration.APIClient.ParameterToString(moveSource, collectionFormat) - } - } else { - queryParams["moveSource"] = a.Configuration.APIClient.ParameterToString(moveSource, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(override).(string); ok { - if str != "" { - queryParams["override"] = a.Configuration.APIClient.ParameterToString(override, collectionFormat) - } - } else { - queryParams["override"] = a.Configuration.APIClient.ParameterToString(override, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Document - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostContentmanagementQuery invokes POST /api/v2/contentmanagement/query -// -// Query content -// -// -func (a ContentManagementApi) PostContentmanagementQuery(body Queryrequest, expand string) (*Queryresults, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/contentmanagement/query" - defaultReturn := new(Queryresults) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ContentManagementApi->PostContentmanagementQuery") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(expand).(string); ok { - if str != "" { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Queryresults - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostContentmanagementShares invokes POST /api/v2/contentmanagement/shares -// -// Creates a new share or updates an existing share if the entity has already been shared -// -// -func (a ContentManagementApi) PostContentmanagementShares(body Createsharerequest) (*Createshareresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/contentmanagement/shares" - defaultReturn := new(Createshareresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ContentManagementApi->PostContentmanagementShares") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Createshareresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostContentmanagementWorkspaceTagvalues invokes POST /api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues -// -// Create a workspace tag -// -// -func (a ContentManagementApi) PostContentmanagementWorkspaceTagvalues(workspaceId string, body Tagvalue) (*Tagvalue, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues" - path = strings.Replace(path, "{workspaceId}", fmt.Sprintf("%v", workspaceId), -1) - defaultReturn := new(Tagvalue) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'workspaceId' is set - if &workspaceId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'workspaceId' when calling ContentManagementApi->PostContentmanagementWorkspaceTagvalues") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ContentManagementApi->PostContentmanagementWorkspaceTagvalues") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Tagvalue - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostContentmanagementWorkspaceTagvaluesQuery invokes POST /api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/query -// -// Perform a prefix query on tags in the workspace -// -// -func (a ContentManagementApi) PostContentmanagementWorkspaceTagvaluesQuery(workspaceId string, body Tagqueryrequest, expand []string) (*Tagvalueentitylisting, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/query" - path = strings.Replace(path, "{workspaceId}", fmt.Sprintf("%v", workspaceId), -1) - defaultReturn := new(Tagvalueentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'workspaceId' is set - if &workspaceId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'workspaceId' when calling ContentManagementApi->PostContentmanagementWorkspaceTagvaluesQuery") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ContentManagementApi->PostContentmanagementWorkspaceTagvaluesQuery") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Tagvalueentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostContentmanagementWorkspaces invokes POST /api/v2/contentmanagement/workspaces -// -// Create a group workspace -// -// -func (a ContentManagementApi) PostContentmanagementWorkspaces(body Workspacecreate) (*Workspace, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/contentmanagement/workspaces" - defaultReturn := new(Workspace) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ContentManagementApi->PostContentmanagementWorkspaces") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Workspace - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutContentmanagementWorkspace invokes PUT /api/v2/contentmanagement/workspaces/{workspaceId} -// -// Update a workspace -// -// -func (a ContentManagementApi) PutContentmanagementWorkspace(workspaceId string, body Workspace) (*Workspace, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/contentmanagement/workspaces/{workspaceId}" - path = strings.Replace(path, "{workspaceId}", fmt.Sprintf("%v", workspaceId), -1) - defaultReturn := new(Workspace) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'workspaceId' is set - if &workspaceId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'workspaceId' when calling ContentManagementApi->PutContentmanagementWorkspace") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ContentManagementApi->PutContentmanagementWorkspace") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Workspace - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutContentmanagementWorkspaceMember invokes PUT /api/v2/contentmanagement/workspaces/{workspaceId}/members/{memberId} -// -// Add a member to a workspace -// -// -func (a ContentManagementApi) PutContentmanagementWorkspaceMember(workspaceId string, memberId string, body Workspacemember) (*Workspacemember, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/contentmanagement/workspaces/{workspaceId}/members/{memberId}" - path = strings.Replace(path, "{workspaceId}", fmt.Sprintf("%v", workspaceId), -1) - path = strings.Replace(path, "{memberId}", fmt.Sprintf("%v", memberId), -1) - defaultReturn := new(Workspacemember) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'workspaceId' is set - if &workspaceId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'workspaceId' when calling ContentManagementApi->PutContentmanagementWorkspaceMember") - } - // verify the required parameter 'memberId' is set - if &memberId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'memberId' when calling ContentManagementApi->PutContentmanagementWorkspaceMember") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ContentManagementApi->PutContentmanagementWorkspaceMember") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Workspacemember - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutContentmanagementWorkspaceTagvalue invokes PUT /api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId} -// -// Update a workspace tag. Will update all documents with the new tag value. -// -// -func (a ContentManagementApi) PutContentmanagementWorkspaceTagvalue(workspaceId string, tagId string, body Tagvalue) (*Tagvalue, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId}" - path = strings.Replace(path, "{workspaceId}", fmt.Sprintf("%v", workspaceId), -1) - path = strings.Replace(path, "{tagId}", fmt.Sprintf("%v", tagId), -1) - defaultReturn := new(Tagvalue) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'workspaceId' is set - if &workspaceId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'workspaceId' when calling ContentManagementApi->PutContentmanagementWorkspaceTagvalue") - } - // verify the required parameter 'tagId' is set - if &tagId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'tagId' when calling ContentManagementApi->PutContentmanagementWorkspaceTagvalue") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ContentManagementApi->PutContentmanagementWorkspaceTagvalue") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Tagvalue - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/contentmanagementsingledocumenttopicdocumentdatav2.go b/build/platformclientv2/contentmanagementsingledocumenttopicdocumentdatav2.go deleted file mode 100644 index 098890412..000000000 --- a/build/platformclientv2/contentmanagementsingledocumenttopicdocumentdatav2.go +++ /dev/null @@ -1,70 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Contentmanagementsingledocumenttopicdocumentdatav2 -type Contentmanagementsingledocumenttopicdocumentdatav2 struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // DateCreated - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - DateModified *time.Time `json:"dateModified,omitempty"` - - - // Workspace - Workspace *Contentmanagementsingledocumenttopicworkspacedata `json:"workspace,omitempty"` - - - // CreatedBy - CreatedBy *Contentmanagementsingledocumenttopicuserdata `json:"createdBy,omitempty"` - - - // ContentType - ContentType *string `json:"contentType,omitempty"` - - - // ContentLength - ContentLength *int `json:"contentLength,omitempty"` - - - // Filename - Filename *string `json:"filename,omitempty"` - - - // ChangeNumber - ChangeNumber *int `json:"changeNumber,omitempty"` - - - // DateUploaded - DateUploaded *time.Time `json:"dateUploaded,omitempty"` - - - // UploadedBy - UploadedBy *Contentmanagementsingledocumenttopicuserdata `json:"uploadedBy,omitempty"` - - - // LockInfo - LockInfo *Contentmanagementsingledocumenttopiclockdata `json:"lockInfo,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Contentmanagementsingledocumenttopicdocumentdatav2) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/contentmanagementsingledocumenttopiclockdata.go b/build/platformclientv2/contentmanagementsingledocumenttopiclockdata.go deleted file mode 100644 index 02812aff7..000000000 --- a/build/platformclientv2/contentmanagementsingledocumenttopiclockdata.go +++ /dev/null @@ -1,26 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Contentmanagementsingledocumenttopiclockdata -type Contentmanagementsingledocumenttopiclockdata struct { - // LockedBy - LockedBy *Contentmanagementsingledocumenttopicuserdata `json:"lockedBy,omitempty"` - - - // DateCreated - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateExpires - DateExpires *time.Time `json:"dateExpires,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Contentmanagementsingledocumenttopiclockdata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/contentmanagementsingledocumenttopicuserdata.go b/build/platformclientv2/contentmanagementsingledocumenttopicuserdata.go deleted file mode 100644 index ffe0d104b..000000000 --- a/build/platformclientv2/contentmanagementsingledocumenttopicuserdata.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Contentmanagementsingledocumenttopicuserdata -type Contentmanagementsingledocumenttopicuserdata struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Contentmanagementsingledocumenttopicuserdata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/contentmanagementsingledocumenttopicworkspacedata.go b/build/platformclientv2/contentmanagementsingledocumenttopicworkspacedata.go deleted file mode 100644 index 963683b97..000000000 --- a/build/platformclientv2/contentmanagementsingledocumenttopicworkspacedata.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Contentmanagementsingledocumenttopicworkspacedata -type Contentmanagementsingledocumenttopicworkspacedata struct { - // Id - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Contentmanagementsingledocumenttopicworkspacedata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/contentmanagementworkspacedocumentstopicdocumentdatav2.go b/build/platformclientv2/contentmanagementworkspacedocumentstopicdocumentdatav2.go deleted file mode 100644 index 5f1057d5a..000000000 --- a/build/platformclientv2/contentmanagementworkspacedocumentstopicdocumentdatav2.go +++ /dev/null @@ -1,70 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Contentmanagementworkspacedocumentstopicdocumentdatav2 -type Contentmanagementworkspacedocumentstopicdocumentdatav2 struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // DateCreated - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - DateModified *time.Time `json:"dateModified,omitempty"` - - - // Workspace - Workspace *Contentmanagementworkspacedocumentstopicworkspacedata `json:"workspace,omitempty"` - - - // CreatedBy - CreatedBy *Contentmanagementworkspacedocumentstopicuserdata `json:"createdBy,omitempty"` - - - // ContentType - ContentType *string `json:"contentType,omitempty"` - - - // ContentLength - ContentLength *int `json:"contentLength,omitempty"` - - - // Filename - Filename *string `json:"filename,omitempty"` - - - // ChangeNumber - ChangeNumber *int `json:"changeNumber,omitempty"` - - - // DateUploaded - DateUploaded *time.Time `json:"dateUploaded,omitempty"` - - - // UploadedBy - UploadedBy *Contentmanagementworkspacedocumentstopicuserdata `json:"uploadedBy,omitempty"` - - - // LockInfo - LockInfo *Contentmanagementworkspacedocumentstopiclockdata `json:"lockInfo,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Contentmanagementworkspacedocumentstopicdocumentdatav2) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/contentmanagementworkspacedocumentstopiclockdata.go b/build/platformclientv2/contentmanagementworkspacedocumentstopiclockdata.go deleted file mode 100644 index 009f20ab9..000000000 --- a/build/platformclientv2/contentmanagementworkspacedocumentstopiclockdata.go +++ /dev/null @@ -1,26 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Contentmanagementworkspacedocumentstopiclockdata -type Contentmanagementworkspacedocumentstopiclockdata struct { - // LockedBy - LockedBy *Contentmanagementworkspacedocumentstopicuserdata `json:"lockedBy,omitempty"` - - - // DateCreated - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateExpires - DateExpires *time.Time `json:"dateExpires,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Contentmanagementworkspacedocumentstopiclockdata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/contentmanagementworkspacedocumentstopicuserdata.go b/build/platformclientv2/contentmanagementworkspacedocumentstopicuserdata.go deleted file mode 100644 index 4da7c1bb6..000000000 --- a/build/platformclientv2/contentmanagementworkspacedocumentstopicuserdata.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Contentmanagementworkspacedocumentstopicuserdata -type Contentmanagementworkspacedocumentstopicuserdata struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Contentmanagementworkspacedocumentstopicuserdata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/contentmanagementworkspacedocumentstopicworkspacedata.go b/build/platformclientv2/contentmanagementworkspacedocumentstopicworkspacedata.go deleted file mode 100644 index af001c80b..000000000 --- a/build/platformclientv2/contentmanagementworkspacedocumentstopicworkspacedata.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Contentmanagementworkspacedocumentstopicworkspacedata -type Contentmanagementworkspacedocumentstopicworkspacedata struct { - // Id - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Contentmanagementworkspacedocumentstopicworkspacedata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/contentnotificationtemplate.go b/build/platformclientv2/contentnotificationtemplate.go deleted file mode 100644 index 8de77942a..000000000 --- a/build/platformclientv2/contentnotificationtemplate.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Contentnotificationtemplate - Template notification object -type Contentnotificationtemplate struct { - // Id - The messaging channel template id. For WhatsApp, 'namespace@name' - Id *string `json:"id,omitempty"` - - - // Language - Template language - Language *string `json:"language,omitempty"` - - - // Header - Template header object - Header *Notificationtemplateheader `json:"header,omitempty"` - - - // Body - Template body object - Body *Notificationtemplatebody `json:"body,omitempty"` - - - // Footer - Template footer object - Footer *Notificationtemplatefooter `json:"footer,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Contentnotificationtemplate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/contentoffer.go b/build/platformclientv2/contentoffer.go deleted file mode 100644 index 74e74508d..000000000 --- a/build/platformclientv2/contentoffer.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Contentoffer -type Contentoffer struct { - // ImageUrl - URL for image displayed to the customer when displaying content offer. - ImageUrl *string `json:"imageUrl,omitempty"` - - - // DisplayMode - The display mode of Genesys Widgets when displaying content offer. - DisplayMode *string `json:"displayMode,omitempty"` - - - // LayoutMode - The layout mode of the text shown to the user when displaying content offer. - LayoutMode *string `json:"layoutMode,omitempty"` - - - // Title - Title used in the header of the content offer. - Title *string `json:"title,omitempty"` - - - // Headline - Headline displayed above the body text of the content offer. - Headline *string `json:"headline,omitempty"` - - - // Body - Body text of the content offer. - Body *string `json:"body,omitempty"` - - - // CallToAction - Properties customizing the call to action button on the content offer. - CallToAction *Calltoaction `json:"callToAction,omitempty"` - - - // Style - Properties customizing the styling of the content offer. - Style *Contentofferstylingconfiguration `json:"style,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Contentoffer) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/contentofferstyleproperties.go b/build/platformclientv2/contentofferstyleproperties.go deleted file mode 100644 index 93526135b..000000000 --- a/build/platformclientv2/contentofferstyleproperties.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Contentofferstyleproperties -type Contentofferstyleproperties struct { - // Padding - Padding of the offer. (eg. 10px) - Padding *string `json:"padding,omitempty"` - - - // Color - Text color of the offer. (eg. #FF0000) - Color *string `json:"color,omitempty"` - - - // BackgroundColor - Background color of the offer. (eg. #000000) - BackgroundColor *string `json:"backgroundColor,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Contentofferstyleproperties) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/contentofferstylingconfiguration.go b/build/platformclientv2/contentofferstylingconfiguration.go deleted file mode 100644 index 6c18b4f51..000000000 --- a/build/platformclientv2/contentofferstylingconfiguration.go +++ /dev/null @@ -1,41 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Contentofferstylingconfiguration -type Contentofferstylingconfiguration struct { - // Position - Properties for customizing the positioning of the content offer. - Position *Contentpositionproperties `json:"position,omitempty"` - - - // Offer - Properties for customizing the appearance of the content offer. - Offer *Contentofferstyleproperties `json:"offer,omitempty"` - - - // CloseButton - Properties for customizing the appearance of the close button. - CloseButton *Closebuttonstyleproperties `json:"closeButton,omitempty"` - - - // CtaButton - Properties for customizing the appearance of the CTA button. - CtaButton *Ctabuttonstyleproperties `json:"ctaButton,omitempty"` - - - // Title - Properties for customizing the appearance of the title text. - Title *Textstyleproperties `json:"title,omitempty"` - - - // Headline - Properties for customizing the appearance of the headline text. - Headline *Textstyleproperties `json:"headline,omitempty"` - - - // Body - Properties for customizing the appearance of the body text. - Body *Textstyleproperties `json:"body,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Contentofferstylingconfiguration) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/contentpositionproperties.go b/build/platformclientv2/contentpositionproperties.go deleted file mode 100644 index c3d65ab5c..000000000 --- a/build/platformclientv2/contentpositionproperties.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Contentpositionproperties -type Contentpositionproperties struct { - // Top - Top positioning offset. - Top *string `json:"top,omitempty"` - - - // Bottom - Bottom positioning offset. - Bottom *string `json:"bottom,omitempty"` - - - // Left - Left positioning offset. - Left *string `json:"left,omitempty"` - - - // Right - Right positioning offset. - Right *string `json:"right,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Contentpositionproperties) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/contentpostback.go b/build/platformclientv2/contentpostback.go deleted file mode 100644 index b8e8b80af..000000000 --- a/build/platformclientv2/contentpostback.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Contentpostback - The postback object result of a user clicking in a button -type Contentpostback struct { - // Id - An ID assigned to the postback reply. Each object inside the content array has a unique ID. - Id *string `json:"id,omitempty"` - - - // Text - The text inside the button clicked (in the structured message template) - Text *string `json:"text,omitempty"` - - - // Payload - Content of the textback payload after clicking a quick reply - Payload *string `json:"payload,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Contentpostback) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/contentqueryrequest.go b/build/platformclientv2/contentqueryrequest.go deleted file mode 100644 index 9c388c83a..000000000 --- a/build/platformclientv2/contentqueryrequest.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Contentqueryrequest -type Contentqueryrequest struct { - // QueryPhrase - QueryPhrase *string `json:"queryPhrase,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // FacetNameRequests - FacetNameRequests *[]string `json:"facetNameRequests,omitempty"` - - - // Sort - Sort *[]Contentsortitem `json:"sort,omitempty"` - - - // Filters - Filters *[]Contentfacetfilteritem `json:"filters,omitempty"` - - - // AttributeFilters - AttributeFilters *[]Contentattributefilteritem `json:"attributeFilters,omitempty"` - - - // IncludeShares - IncludeShares *bool `json:"includeShares,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Contentqueryrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/contentquickreply.go b/build/platformclientv2/contentquickreply.go deleted file mode 100644 index b7c41ed52..000000000 --- a/build/platformclientv2/contentquickreply.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Contentquickreply - Quick reply object -type Contentquickreply struct { - // Id - An ID assigned to the quick reply. Each object inside the content array has a unique ID. - Id *string `json:"id,omitempty"` - - - // Text - Text to show inside the quick reply. This is also used as the response text after clicking on the quick reply. - Text *string `json:"text,omitempty"` - - - // Payload - Content of the textback payload after clicking a quick reply - Payload *string `json:"payload,omitempty"` - - - // Image - Image associated with quick reply - Image *string `json:"image,omitempty"` - - - // Action - Specifies the type of action that is triggered upon clicking the quick reply. Currently, the only supported action is \"Message\" which sends a message using the quick reply text. - Action *string `json:"action,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Contentquickreply) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/contentreaction.go b/build/platformclientv2/contentreaction.go deleted file mode 100644 index a16d72993..000000000 --- a/build/platformclientv2/contentreaction.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Contentreaction - User reaction to public message -type Contentreaction struct { - // ReactionType - Type of reaction - ReactionType *string `json:"reactionType,omitempty"` - - - // Count - Number of users that reacted this way to this public message - Count *int `json:"count,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Contentreaction) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/contentsortitem.go b/build/platformclientv2/contentsortitem.go deleted file mode 100644 index 83f8b5151..000000000 --- a/build/platformclientv2/contentsortitem.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Contentsortitem -type Contentsortitem struct { - // Name - Name *string `json:"name,omitempty"` - - - // Ascending - Ascending *bool `json:"ascending,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Contentsortitem) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/context.go b/build/platformclientv2/context.go deleted file mode 100644 index 0b61b237b..000000000 --- a/build/platformclientv2/context.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Context -type Context struct { - // Patterns - A list of one or more patterns to match. - Patterns *[]Contextpattern `json:"patterns,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Context) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/contextentity.go b/build/platformclientv2/contextentity.go deleted file mode 100644 index 5eec22884..000000000 --- a/build/platformclientv2/contextentity.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Contextentity -type Contextentity struct { - // Name - The name of the entity. - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Contextentity) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/contextintent.go b/build/platformclientv2/contextintent.go deleted file mode 100644 index da61f3b69..000000000 --- a/build/platformclientv2/contextintent.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Contextintent -type Contextintent struct { - // Name - The name of the intent. - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Contextintent) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/contextpattern.go b/build/platformclientv2/contextpattern.go deleted file mode 100644 index 1a5cd8ff8..000000000 --- a/build/platformclientv2/contextpattern.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Contextpattern -type Contextpattern struct { - // Criteria - A list of one or more criteria to satisfy. - Criteria *[]Entitytypecriteria `json:"criteria,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Contextpattern) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversation.go b/build/platformclientv2/conversation.go deleted file mode 100644 index c842cd9d8..000000000 --- a/build/platformclientv2/conversation.go +++ /dev/null @@ -1,62 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Conversation -type Conversation struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // StartTime - The time when the conversation started. This will be the time when the first participant joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartTime *time.Time `json:"startTime,omitempty"` - - - // EndTime - The time when the conversation ended. This will be the time when the last participant left the conversation, or null when the conversation is still active. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - EndTime *time.Time `json:"endTime,omitempty"` - - - // Address - The address of the conversation as seen from an external participant. For phone calls this will be the DNIS for inbound calls and the ANI for outbound calls. For other media types this will be the address of the destination participant for inbound and the address of the initiating participant for outbound. - Address *string `json:"address,omitempty"` - - - // Participants - The list of all participants in the conversation. - Participants *[]Participant `json:"participants,omitempty"` - - - // ConversationIds - A list of conversations to merge into this conversation to create a conference. This field is null except when being used to create a conference. - ConversationIds *[]string `json:"conversationIds,omitempty"` - - - // MaxParticipants - If this is a conference conversation, then this field indicates the maximum number of participants allowed to participant in the conference. - MaxParticipants *int `json:"maxParticipants,omitempty"` - - - // RecordingState - On update, 'paused' initiates a secure pause, 'active' resumes any paused recordings; otherwise indicates state of conversation recording. - RecordingState *string `json:"recordingState,omitempty"` - - - // State - The conversation's state - State *string `json:"state,omitempty"` - - - // Divisions - Identifiers of divisions associated with this conversation - Divisions *[]Conversationdivisionmembership `json:"divisions,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversation) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationaggregatedatacontainer.go b/build/platformclientv2/conversationaggregatedatacontainer.go deleted file mode 100644 index ae65733da..000000000 --- a/build/platformclientv2/conversationaggregatedatacontainer.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationaggregatedatacontainer -type Conversationaggregatedatacontainer struct { - // Group - A mapping from dimension to value - Group *map[string]string `json:"group,omitempty"` - - - // Data - Data *[]Statisticalresponse `json:"data,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationaggregatedatacontainer) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationaggregatequeryclause.go b/build/platformclientv2/conversationaggregatequeryclause.go deleted file mode 100644 index b048dc6cd..000000000 --- a/build/platformclientv2/conversationaggregatequeryclause.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationaggregatequeryclause -type Conversationaggregatequeryclause struct { - // VarType - Boolean operation to apply to the provided predicates - VarType *string `json:"type,omitempty"` - - - // Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value). - Predicates *[]Conversationaggregatequerypredicate `json:"predicates,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationaggregatequeryclause) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationaggregatequeryfilter.go b/build/platformclientv2/conversationaggregatequeryfilter.go deleted file mode 100644 index 531ca4d13..000000000 --- a/build/platformclientv2/conversationaggregatequeryfilter.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationaggregatequeryfilter -type Conversationaggregatequeryfilter struct { - // VarType - Boolean operation to apply to the provided predicates and clauses - VarType *string `json:"type,omitempty"` - - - // Clauses - Boolean 'and/or' logic with up to two-levels of nesting - Clauses *[]Conversationaggregatequeryclause `json:"clauses,omitempty"` - - - // Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value). - Predicates *[]Conversationaggregatequerypredicate `json:"predicates,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationaggregatequeryfilter) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationaggregatequerypredicate.go b/build/platformclientv2/conversationaggregatequerypredicate.go deleted file mode 100644 index 4455b46af..000000000 --- a/build/platformclientv2/conversationaggregatequerypredicate.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationaggregatequerypredicate -type Conversationaggregatequerypredicate struct { - // VarType - Optional type, can usually be inferred - VarType *string `json:"type,omitempty"` - - - // Dimension - Left hand side for dimension predicates - Dimension *string `json:"dimension,omitempty"` - - - // Operator - Optional operator, default is matches - Operator *string `json:"operator,omitempty"` - - - // Value - Right hand side for dimension predicates - Value *string `json:"value,omitempty"` - - - // VarRange - Right hand side for dimension predicates - VarRange *Numericrange `json:"range,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationaggregatequerypredicate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationaggregatequeryresponse.go b/build/platformclientv2/conversationaggregatequeryresponse.go deleted file mode 100644 index 1dfe5c4b6..000000000 --- a/build/platformclientv2/conversationaggregatequeryresponse.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationaggregatequeryresponse -type Conversationaggregatequeryresponse struct { - // Results - Results *[]Conversationaggregatedatacontainer `json:"results,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationaggregatequeryresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationaggregationquery.go b/build/platformclientv2/conversationaggregationquery.go deleted file mode 100644 index b1bd3901b..000000000 --- a/build/platformclientv2/conversationaggregationquery.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationaggregationquery -type Conversationaggregationquery struct { - // Interval - Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss - Interval *string `json:"interval,omitempty"` - - - // Granularity - Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H - Granularity *string `json:"granularity,omitempty"` - - - // TimeZone - Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London - TimeZone *string `json:"timeZone,omitempty"` - - - // GroupBy - Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group. - GroupBy *[]string `json:"groupBy,omitempty"` - - - // Filter - Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters - Filter *Conversationaggregatequeryfilter `json:"filter,omitempty"` - - - // Metrics - Behaves like a SQL SELECT clause. Only named metrics will be retrieved. - Metrics *[]string `json:"metrics,omitempty"` - - - // FlattenMultivaluedDimensions - Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c') - FlattenMultivaluedDimensions *bool `json:"flattenMultivaluedDimensions,omitempty"` - - - // Views - Custom derived metric views - Views *[]Conversationaggregationview `json:"views,omitempty"` - - - // AlternateTimeDimension - Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event. - AlternateTimeDimension *string `json:"alternateTimeDimension,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationaggregationquery) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationaggregationview.go b/build/platformclientv2/conversationaggregationview.go deleted file mode 100644 index b195053c0..000000000 --- a/build/platformclientv2/conversationaggregationview.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationaggregationview -type Conversationaggregationview struct { - // Target - Target metric name - Target *string `json:"target,omitempty"` - - - // Name - A unique name for this view. Must be distinct from other views and built-in metric names. - Name *string `json:"name,omitempty"` - - - // Function - Type of view you wish to create - Function *string `json:"function,omitempty"` - - - // VarRange - Range of numbers for slicing up data - VarRange *Aggregationrange `json:"range,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationaggregationview) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationassociation.go b/build/platformclientv2/conversationassociation.go deleted file mode 100644 index 47236e32c..000000000 --- a/build/platformclientv2/conversationassociation.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationassociation -type Conversationassociation struct { - // ExternalContactId - An external contact ID. If not supplied, implies the conversation should be disassociated with any external contact. - ExternalContactId *string `json:"externalContactId,omitempty"` - - - // ConversationId - Conversation ID - ConversationId *string `json:"conversationId,omitempty"` - - - // CommunicationId - Communication ID - CommunicationId *string `json:"communicationId,omitempty"` - - - // MediaType - Media type - MediaType *string `json:"mediaType,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationassociation) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationbasic.go b/build/platformclientv2/conversationbasic.go deleted file mode 100644 index 034f007ca..000000000 --- a/build/platformclientv2/conversationbasic.go +++ /dev/null @@ -1,42 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Conversationbasic -type Conversationbasic struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // StartTime - The time when the conversation started. This will be the time when the first participant joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartTime *time.Time `json:"startTime,omitempty"` - - - // EndTime - The time when the conversation ended. This will be the time when the last participant left the conversation, or null when the conversation is still active. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - EndTime *time.Time `json:"endTime,omitempty"` - - - // Divisions - Identifiers of divisions associated with this conversation - Divisions *[]Conversationdivisionmembership `json:"divisions,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - - - // Participants - Participants *[]Participantbasic `json:"participants,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationbasic) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationcallbackeventtopiccallbackconversation.go b/build/platformclientv2/conversationcallbackeventtopiccallbackconversation.go deleted file mode 100644 index c22a0a6ae..000000000 --- a/build/platformclientv2/conversationcallbackeventtopiccallbackconversation.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationcallbackeventtopiccallbackconversation -type Conversationcallbackeventtopiccallbackconversation struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Participants - Participants *[]Conversationcallbackeventtopiccallbackmediaparticipant `json:"participants,omitempty"` - - - // OtherMediaUris - OtherMediaUris *[]string `json:"otherMediaUris,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationcallbackeventtopiccallbackconversation) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationcallbackeventtopiccallbackmediaparticipant.go b/build/platformclientv2/conversationcallbackeventtopiccallbackmediaparticipant.go deleted file mode 100644 index 05ba942ac..000000000 --- a/build/platformclientv2/conversationcallbackeventtopiccallbackmediaparticipant.go +++ /dev/null @@ -1,186 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Conversationcallbackeventtopiccallbackmediaparticipant -type Conversationcallbackeventtopiccallbackmediaparticipant struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Address - Address *string `json:"address,omitempty"` - - - // StartTime - StartTime *time.Time `json:"startTime,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // EndTime - EndTime *time.Time `json:"endTime,omitempty"` - - - // StartHoldTime - StartHoldTime *time.Time `json:"startHoldTime,omitempty"` - - - // Purpose - Purpose *string `json:"purpose,omitempty"` - - - // State - State *string `json:"state,omitempty"` - - - // Direction - Direction *string `json:"direction,omitempty"` - - - // DisconnectType - DisconnectType *string `json:"disconnectType,omitempty"` - - - // Held - Held *bool `json:"held,omitempty"` - - - // WrapupRequired - WrapupRequired *bool `json:"wrapupRequired,omitempty"` - - - // WrapupPrompt - WrapupPrompt *string `json:"wrapupPrompt,omitempty"` - - - // User - User *Conversationcallbackeventtopicurireference `json:"user,omitempty"` - - - // Queue - Queue *Conversationcallbackeventtopicurireference `json:"queue,omitempty"` - - - // Team - Team *Conversationcallbackeventtopicurireference `json:"team,omitempty"` - - - // Attributes - Attributes *map[string]string `json:"attributes,omitempty"` - - - // ErrorInfo - ErrorInfo *Conversationcallbackeventtopicerrorbody `json:"errorInfo,omitempty"` - - - // Script - Script *Conversationcallbackeventtopicurireference `json:"script,omitempty"` - - - // WrapupTimeoutMs - WrapupTimeoutMs *int `json:"wrapupTimeoutMs,omitempty"` - - - // WrapupSkipped - WrapupSkipped *bool `json:"wrapupSkipped,omitempty"` - - - // AlertingTimeoutMs - AlertingTimeoutMs *int `json:"alertingTimeoutMs,omitempty"` - - - // Provider - Provider *string `json:"provider,omitempty"` - - - // ExternalContact - ExternalContact *Conversationcallbackeventtopicurireference `json:"externalContact,omitempty"` - - - // ExternalOrganization - ExternalOrganization *Conversationcallbackeventtopicurireference `json:"externalOrganization,omitempty"` - - - // Wrapup - Wrapup *Conversationcallbackeventtopicwrapup `json:"wrapup,omitempty"` - - - // ConversationRoutingData - ConversationRoutingData *Conversationcallbackeventtopicconversationroutingdata `json:"conversationRoutingData,omitempty"` - - - // Peer - Peer *string `json:"peer,omitempty"` - - - // ScreenRecordingState - ScreenRecordingState *string `json:"screenRecordingState,omitempty"` - - - // FlaggedReason - FlaggedReason *string `json:"flaggedReason,omitempty"` - - - // JourneyContext - JourneyContext *Conversationcallbackeventtopicjourneycontext `json:"journeyContext,omitempty"` - - - // StartAcwTime - StartAcwTime *time.Time `json:"startAcwTime,omitempty"` - - - // EndAcwTime - EndAcwTime *time.Time `json:"endAcwTime,omitempty"` - - - // OutboundPreview - OutboundPreview *Conversationcallbackeventtopicdialerpreview `json:"outboundPreview,omitempty"` - - - // Voicemail - Voicemail *Conversationcallbackeventtopicvoicemail `json:"voicemail,omitempty"` - - - // CallbackNumbers - CallbackNumbers *[]string `json:"callbackNumbers,omitempty"` - - - // CallbackUserName - CallbackUserName *string `json:"callbackUserName,omitempty"` - - - // SkipEnabled - SkipEnabled *bool `json:"skipEnabled,omitempty"` - - - // ExternalCampaign - ExternalCampaign *bool `json:"externalCampaign,omitempty"` - - - // TimeoutSeconds - TimeoutSeconds *int `json:"timeoutSeconds,omitempty"` - - - // CallbackScheduledTime - CallbackScheduledTime *time.Time `json:"callbackScheduledTime,omitempty"` - - - // AutomatedCallbackConfigId - AutomatedCallbackConfigId *string `json:"automatedCallbackConfigId,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationcallbackeventtopiccallbackmediaparticipant) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationcallbackeventtopicconversationroutingdata.go b/build/platformclientv2/conversationcallbackeventtopicconversationroutingdata.go deleted file mode 100644 index 65d3cde40..000000000 --- a/build/platformclientv2/conversationcallbackeventtopicconversationroutingdata.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationcallbackeventtopicconversationroutingdata -type Conversationcallbackeventtopicconversationroutingdata struct { - // Queue - Queue *Conversationcallbackeventtopicurireference `json:"queue,omitempty"` - - - // Language - Language *Conversationcallbackeventtopicurireference `json:"language,omitempty"` - - - // Priority - Priority *int `json:"priority,omitempty"` - - - // Skills - Skills *[]Conversationcallbackeventtopicurireference `json:"skills,omitempty"` - - - // ScoredAgents - ScoredAgents *[]Conversationcallbackeventtopicscoredagent `json:"scoredAgents,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationcallbackeventtopicconversationroutingdata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationcallbackeventtopicdetail.go b/build/platformclientv2/conversationcallbackeventtopicdetail.go deleted file mode 100644 index 01d88e378..000000000 --- a/build/platformclientv2/conversationcallbackeventtopicdetail.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationcallbackeventtopicdetail -type Conversationcallbackeventtopicdetail struct { - // ErrorCode - ErrorCode *string `json:"errorCode,omitempty"` - - - // FieldName - FieldName *string `json:"fieldName,omitempty"` - - - // EntityId - EntityId *string `json:"entityId,omitempty"` - - - // EntityName - EntityName *string `json:"entityName,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationcallbackeventtopicdetail) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationcallbackeventtopicdialerpreview.go b/build/platformclientv2/conversationcallbackeventtopicdialerpreview.go deleted file mode 100644 index 1cfdf5d12..000000000 --- a/build/platformclientv2/conversationcallbackeventtopicdialerpreview.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationcallbackeventtopicdialerpreview -type Conversationcallbackeventtopicdialerpreview struct { - // Id - Id *string `json:"id,omitempty"` - - - // ContactId - ContactId *string `json:"contactId,omitempty"` - - - // ContactListId - ContactListId *string `json:"contactListId,omitempty"` - - - // CampaignId - CampaignId *string `json:"campaignId,omitempty"` - - - // PhoneNumberColumns - PhoneNumberColumns *[]Conversationcallbackeventtopicphonenumbercolumn `json:"phoneNumberColumns,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationcallbackeventtopicdialerpreview) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationcallbackeventtopicerrorbody.go b/build/platformclientv2/conversationcallbackeventtopicerrorbody.go deleted file mode 100644 index 931aab885..000000000 --- a/build/platformclientv2/conversationcallbackeventtopicerrorbody.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationcallbackeventtopicerrorbody -type Conversationcallbackeventtopicerrorbody struct { - // Status - Status *int `json:"status,omitempty"` - - - // Code - Code *string `json:"code,omitempty"` - - - // EntityId - EntityId *string `json:"entityId,omitempty"` - - - // EntityName - EntityName *string `json:"entityName,omitempty"` - - - // Message - Message *string `json:"message,omitempty"` - - - // MessageWithParams - MessageWithParams *string `json:"messageWithParams,omitempty"` - - - // MessageParams - MessageParams *map[string]string `json:"messageParams,omitempty"` - - - // ContextId - ContextId *string `json:"contextId,omitempty"` - - - // Details - Details *[]Conversationcallbackeventtopicdetail `json:"details,omitempty"` - - - // Errors - Errors *[]Conversationcallbackeventtopicerrorbody `json:"errors,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationcallbackeventtopicerrorbody) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationcallbackeventtopicjourneyaction.go b/build/platformclientv2/conversationcallbackeventtopicjourneyaction.go deleted file mode 100644 index ad334847b..000000000 --- a/build/platformclientv2/conversationcallbackeventtopicjourneyaction.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationcallbackeventtopicjourneyaction -type Conversationcallbackeventtopicjourneyaction struct { - // Id - Id *string `json:"id,omitempty"` - - - // ActionMap - ActionMap *Conversationcallbackeventtopicjourneyactionmap `json:"actionMap,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationcallbackeventtopicjourneyaction) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationcallbackeventtopicjourneyactionmap.go b/build/platformclientv2/conversationcallbackeventtopicjourneyactionmap.go deleted file mode 100644 index 44401ff3d..000000000 --- a/build/platformclientv2/conversationcallbackeventtopicjourneyactionmap.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationcallbackeventtopicjourneyactionmap -type Conversationcallbackeventtopicjourneyactionmap struct { - // Id - Id *string `json:"id,omitempty"` - - - // Version - Version *int `json:"version,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationcallbackeventtopicjourneyactionmap) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationcallbackeventtopicjourneycontext.go b/build/platformclientv2/conversationcallbackeventtopicjourneycontext.go deleted file mode 100644 index a6ad9bbe0..000000000 --- a/build/platformclientv2/conversationcallbackeventtopicjourneycontext.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationcallbackeventtopicjourneycontext -type Conversationcallbackeventtopicjourneycontext struct { - // Customer - Customer *Conversationcallbackeventtopicjourneycustomer `json:"customer,omitempty"` - - - // CustomerSession - CustomerSession *Conversationcallbackeventtopicjourneycustomersession `json:"customerSession,omitempty"` - - - // TriggeringAction - TriggeringAction *Conversationcallbackeventtopicjourneyaction `json:"triggeringAction,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationcallbackeventtopicjourneycontext) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationcallbackeventtopicjourneycustomer.go b/build/platformclientv2/conversationcallbackeventtopicjourneycustomer.go deleted file mode 100644 index eeeb55638..000000000 --- a/build/platformclientv2/conversationcallbackeventtopicjourneycustomer.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationcallbackeventtopicjourneycustomer -type Conversationcallbackeventtopicjourneycustomer struct { - // Id - Id *string `json:"id,omitempty"` - - - // IdType - IdType *string `json:"idType,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationcallbackeventtopicjourneycustomer) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationcallbackeventtopicjourneycustomersession.go b/build/platformclientv2/conversationcallbackeventtopicjourneycustomersession.go deleted file mode 100644 index 179ee2f5b..000000000 --- a/build/platformclientv2/conversationcallbackeventtopicjourneycustomersession.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationcallbackeventtopicjourneycustomersession -type Conversationcallbackeventtopicjourneycustomersession struct { - // Id - Id *string `json:"id,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationcallbackeventtopicjourneycustomersession) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationcallbackeventtopicphonenumbercolumn.go b/build/platformclientv2/conversationcallbackeventtopicphonenumbercolumn.go deleted file mode 100644 index 806c4e6ec..000000000 --- a/build/platformclientv2/conversationcallbackeventtopicphonenumbercolumn.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationcallbackeventtopicphonenumbercolumn -type Conversationcallbackeventtopicphonenumbercolumn struct { - // ColumnName - ColumnName *string `json:"columnName,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationcallbackeventtopicphonenumbercolumn) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationcallbackeventtopicscoredagent.go b/build/platformclientv2/conversationcallbackeventtopicscoredagent.go deleted file mode 100644 index 71bfc8230..000000000 --- a/build/platformclientv2/conversationcallbackeventtopicscoredagent.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationcallbackeventtopicscoredagent -type Conversationcallbackeventtopicscoredagent struct { - // Agent - Agent *Conversationcallbackeventtopicurireference `json:"agent,omitempty"` - - - // Score - Score *int `json:"score,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationcallbackeventtopicscoredagent) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationcallbackeventtopicurireference.go b/build/platformclientv2/conversationcallbackeventtopicurireference.go deleted file mode 100644 index 3ed77da7f..000000000 --- a/build/platformclientv2/conversationcallbackeventtopicurireference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationcallbackeventtopicurireference -type Conversationcallbackeventtopicurireference struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationcallbackeventtopicurireference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationcallbackeventtopicvoicemail.go b/build/platformclientv2/conversationcallbackeventtopicvoicemail.go deleted file mode 100644 index 295d530ef..000000000 --- a/build/platformclientv2/conversationcallbackeventtopicvoicemail.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationcallbackeventtopicvoicemail -type Conversationcallbackeventtopicvoicemail struct { - // Id - Id *string `json:"id,omitempty"` - - - // UploadStatus - UploadStatus *string `json:"uploadStatus,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationcallbackeventtopicvoicemail) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationcallbackeventtopicwrapup.go b/build/platformclientv2/conversationcallbackeventtopicwrapup.go deleted file mode 100644 index 0e2372ac8..000000000 --- a/build/platformclientv2/conversationcallbackeventtopicwrapup.go +++ /dev/null @@ -1,38 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Conversationcallbackeventtopicwrapup -type Conversationcallbackeventtopicwrapup struct { - // Code - Code *string `json:"code,omitempty"` - - - // Notes - Notes *string `json:"notes,omitempty"` - - - // Tags - Tags *[]string `json:"tags,omitempty"` - - - // DurationSeconds - DurationSeconds *int `json:"durationSeconds,omitempty"` - - - // EndTime - EndTime *time.Time `json:"endTime,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationcallbackeventtopicwrapup) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationcalleventtopiccallconversation.go b/build/platformclientv2/conversationcalleventtopiccallconversation.go deleted file mode 100644 index 97aeb4cf4..000000000 --- a/build/platformclientv2/conversationcalleventtopiccallconversation.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationcalleventtopiccallconversation -type Conversationcalleventtopiccallconversation struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Participants - Participants *[]Conversationcalleventtopiccallmediaparticipant `json:"participants,omitempty"` - - - // OtherMediaUris - OtherMediaUris *[]string `json:"otherMediaUris,omitempty"` - - - // RecordingState - RecordingState *string `json:"recordingState,omitempty"` - - - // MaxParticipants - MaxParticipants *int `json:"maxParticipants,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationcalleventtopiccallconversation) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationcalleventtopiccallmediaparticipant.go b/build/platformclientv2/conversationcalleventtopiccallmediaparticipant.go deleted file mode 100644 index 162b756e4..000000000 --- a/build/platformclientv2/conversationcalleventtopiccallmediaparticipant.go +++ /dev/null @@ -1,194 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Conversationcalleventtopiccallmediaparticipant -type Conversationcalleventtopiccallmediaparticipant struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Address - Address *string `json:"address,omitempty"` - - - // StartTime - StartTime *time.Time `json:"startTime,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // EndTime - EndTime *time.Time `json:"endTime,omitempty"` - - - // StartHoldTime - StartHoldTime *time.Time `json:"startHoldTime,omitempty"` - - - // Purpose - Purpose *string `json:"purpose,omitempty"` - - - // State - State *string `json:"state,omitempty"` - - - // Direction - Direction *string `json:"direction,omitempty"` - - - // DisconnectType - DisconnectType *string `json:"disconnectType,omitempty"` - - - // Held - Held *bool `json:"held,omitempty"` - - - // WrapupRequired - WrapupRequired *bool `json:"wrapupRequired,omitempty"` - - - // WrapupPrompt - WrapupPrompt *string `json:"wrapupPrompt,omitempty"` - - - // User - User *Conversationcalleventtopicurireference `json:"user,omitempty"` - - - // Queue - Queue *Conversationcalleventtopicurireference `json:"queue,omitempty"` - - - // Team - Team *Conversationcalleventtopicurireference `json:"team,omitempty"` - - - // Attributes - Attributes *map[string]string `json:"attributes,omitempty"` - - - // ErrorInfo - ErrorInfo *Conversationcalleventtopicerrorbody `json:"errorInfo,omitempty"` - - - // Script - Script *Conversationcalleventtopicurireference `json:"script,omitempty"` - - - // WrapupTimeoutMs - WrapupTimeoutMs *int `json:"wrapupTimeoutMs,omitempty"` - - - // WrapupSkipped - WrapupSkipped *bool `json:"wrapupSkipped,omitempty"` - - - // AlertingTimeoutMs - AlertingTimeoutMs *int `json:"alertingTimeoutMs,omitempty"` - - - // Provider - Provider *string `json:"provider,omitempty"` - - - // ExternalContact - ExternalContact *Conversationcalleventtopicurireference `json:"externalContact,omitempty"` - - - // ExternalOrganization - ExternalOrganization *Conversationcalleventtopicurireference `json:"externalOrganization,omitempty"` - - - // Wrapup - Wrapup *Conversationcalleventtopicwrapup `json:"wrapup,omitempty"` - - - // ConversationRoutingData - ConversationRoutingData *Conversationcalleventtopicconversationroutingdata `json:"conversationRoutingData,omitempty"` - - - // Peer - Peer *string `json:"peer,omitempty"` - - - // ScreenRecordingState - ScreenRecordingState *string `json:"screenRecordingState,omitempty"` - - - // FlaggedReason - FlaggedReason *string `json:"flaggedReason,omitempty"` - - - // JourneyContext - JourneyContext *Conversationcalleventtopicjourneycontext `json:"journeyContext,omitempty"` - - - // StartAcwTime - StartAcwTime *time.Time `json:"startAcwTime,omitempty"` - - - // EndAcwTime - EndAcwTime *time.Time `json:"endAcwTime,omitempty"` - - - // Muted - Muted *bool `json:"muted,omitempty"` - - - // Confined - Confined *bool `json:"confined,omitempty"` - - - // Recording - Recording *bool `json:"recording,omitempty"` - - - // RecordingState - RecordingState *string `json:"recordingState,omitempty"` - - - // Group - Group *Conversationcalleventtopicurireference `json:"group,omitempty"` - - - // Ani - Ani *string `json:"ani,omitempty"` - - - // Dnis - Dnis *string `json:"dnis,omitempty"` - - - // DocumentId - DocumentId *string `json:"documentId,omitempty"` - - - // MonitoredParticipantId - MonitoredParticipantId *string `json:"monitoredParticipantId,omitempty"` - - - // ConsultParticipantId - ConsultParticipantId *string `json:"consultParticipantId,omitempty"` - - - // FaxStatus - FaxStatus *Conversationcalleventtopicfaxstatus `json:"faxStatus,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationcalleventtopiccallmediaparticipant) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationcalleventtopicconversationroutingdata.go b/build/platformclientv2/conversationcalleventtopicconversationroutingdata.go deleted file mode 100644 index ac7d2135e..000000000 --- a/build/platformclientv2/conversationcalleventtopicconversationroutingdata.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationcalleventtopicconversationroutingdata -type Conversationcalleventtopicconversationroutingdata struct { - // Queue - Queue *Conversationcalleventtopicurireference `json:"queue,omitempty"` - - - // Language - Language *Conversationcalleventtopicurireference `json:"language,omitempty"` - - - // Priority - Priority *int `json:"priority,omitempty"` - - - // Skills - Skills *[]Conversationcalleventtopicurireference `json:"skills,omitempty"` - - - // ScoredAgents - ScoredAgents *[]Conversationcalleventtopicscoredagent `json:"scoredAgents,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationcalleventtopicconversationroutingdata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationcalleventtopicdetail.go b/build/platformclientv2/conversationcalleventtopicdetail.go deleted file mode 100644 index d42fda7d1..000000000 --- a/build/platformclientv2/conversationcalleventtopicdetail.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationcalleventtopicdetail -type Conversationcalleventtopicdetail struct { - // ErrorCode - ErrorCode *string `json:"errorCode,omitempty"` - - - // FieldName - FieldName *string `json:"fieldName,omitempty"` - - - // EntityId - EntityId *string `json:"entityId,omitempty"` - - - // EntityName - EntityName *string `json:"entityName,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationcalleventtopicdetail) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationcalleventtopicerrorbody.go b/build/platformclientv2/conversationcalleventtopicerrorbody.go deleted file mode 100644 index e5a99c174..000000000 --- a/build/platformclientv2/conversationcalleventtopicerrorbody.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationcalleventtopicerrorbody -type Conversationcalleventtopicerrorbody struct { - // Status - Status *int `json:"status,omitempty"` - - - // Code - Code *string `json:"code,omitempty"` - - - // EntityId - EntityId *string `json:"entityId,omitempty"` - - - // EntityName - EntityName *string `json:"entityName,omitempty"` - - - // Message - Message *string `json:"message,omitempty"` - - - // MessageWithParams - MessageWithParams *string `json:"messageWithParams,omitempty"` - - - // MessageParams - MessageParams *map[string]string `json:"messageParams,omitempty"` - - - // ContextId - ContextId *string `json:"contextId,omitempty"` - - - // Details - Details *[]Conversationcalleventtopicdetail `json:"details,omitempty"` - - - // Errors - Errors *[]Conversationcalleventtopicerrorbody `json:"errors,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationcalleventtopicerrorbody) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationcalleventtopicfaxstatus.go b/build/platformclientv2/conversationcalleventtopicfaxstatus.go deleted file mode 100644 index 90702989f..000000000 --- a/build/platformclientv2/conversationcalleventtopicfaxstatus.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationcalleventtopicfaxstatus -type Conversationcalleventtopicfaxstatus struct { - // Direction - Direction *string `json:"direction,omitempty"` - - - // ExpectedPages - ExpectedPages *int `json:"expectedPages,omitempty"` - - - // ActivePage - ActivePage *int `json:"activePage,omitempty"` - - - // LinesTransmitted - LinesTransmitted *int `json:"linesTransmitted,omitempty"` - - - // BytesTransmitted - BytesTransmitted *int `json:"bytesTransmitted,omitempty"` - - - // DataRate - DataRate *int `json:"dataRate,omitempty"` - - - // PageErrors - PageErrors *int `json:"pageErrors,omitempty"` - - - // LineErrors - LineErrors *int `json:"lineErrors,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationcalleventtopicfaxstatus) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationcalleventtopicjourneyaction.go b/build/platformclientv2/conversationcalleventtopicjourneyaction.go deleted file mode 100644 index b98fedf65..000000000 --- a/build/platformclientv2/conversationcalleventtopicjourneyaction.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationcalleventtopicjourneyaction -type Conversationcalleventtopicjourneyaction struct { - // Id - Id *string `json:"id,omitempty"` - - - // ActionMap - ActionMap *Conversationcalleventtopicjourneyactionmap `json:"actionMap,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationcalleventtopicjourneyaction) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationcalleventtopicjourneyactionmap.go b/build/platformclientv2/conversationcalleventtopicjourneyactionmap.go deleted file mode 100644 index 410d2ff86..000000000 --- a/build/platformclientv2/conversationcalleventtopicjourneyactionmap.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationcalleventtopicjourneyactionmap -type Conversationcalleventtopicjourneyactionmap struct { - // Id - Id *string `json:"id,omitempty"` - - - // Version - Version *int `json:"version,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationcalleventtopicjourneyactionmap) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationcalleventtopicjourneycontext.go b/build/platformclientv2/conversationcalleventtopicjourneycontext.go deleted file mode 100644 index 945b9642f..000000000 --- a/build/platformclientv2/conversationcalleventtopicjourneycontext.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationcalleventtopicjourneycontext -type Conversationcalleventtopicjourneycontext struct { - // Customer - Customer *Conversationcalleventtopicjourneycustomer `json:"customer,omitempty"` - - - // CustomerSession - CustomerSession *Conversationcalleventtopicjourneycustomersession `json:"customerSession,omitempty"` - - - // TriggeringAction - TriggeringAction *Conversationcalleventtopicjourneyaction `json:"triggeringAction,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationcalleventtopicjourneycontext) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationcalleventtopicjourneycustomer.go b/build/platformclientv2/conversationcalleventtopicjourneycustomer.go deleted file mode 100644 index d5f020120..000000000 --- a/build/platformclientv2/conversationcalleventtopicjourneycustomer.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationcalleventtopicjourneycustomer -type Conversationcalleventtopicjourneycustomer struct { - // Id - Id *string `json:"id,omitempty"` - - - // IdType - IdType *string `json:"idType,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationcalleventtopicjourneycustomer) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationcalleventtopicjourneycustomersession.go b/build/platformclientv2/conversationcalleventtopicjourneycustomersession.go deleted file mode 100644 index ce608dd11..000000000 --- a/build/platformclientv2/conversationcalleventtopicjourneycustomersession.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationcalleventtopicjourneycustomersession -type Conversationcalleventtopicjourneycustomersession struct { - // Id - Id *string `json:"id,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationcalleventtopicjourneycustomersession) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationcalleventtopicscoredagent.go b/build/platformclientv2/conversationcalleventtopicscoredagent.go deleted file mode 100644 index a78604acd..000000000 --- a/build/platformclientv2/conversationcalleventtopicscoredagent.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationcalleventtopicscoredagent -type Conversationcalleventtopicscoredagent struct { - // Agent - Agent *Conversationcalleventtopicurireference `json:"agent,omitempty"` - - - // Score - Score *int `json:"score,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationcalleventtopicscoredagent) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationcalleventtopicurireference.go b/build/platformclientv2/conversationcalleventtopicurireference.go deleted file mode 100644 index 2eb41a158..000000000 --- a/build/platformclientv2/conversationcalleventtopicurireference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationcalleventtopicurireference -type Conversationcalleventtopicurireference struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationcalleventtopicurireference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationcalleventtopicwrapup.go b/build/platformclientv2/conversationcalleventtopicwrapup.go deleted file mode 100644 index 60fbb2cd4..000000000 --- a/build/platformclientv2/conversationcalleventtopicwrapup.go +++ /dev/null @@ -1,38 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Conversationcalleventtopicwrapup -type Conversationcalleventtopicwrapup struct { - // Code - Code *string `json:"code,omitempty"` - - - // Notes - Notes *string `json:"notes,omitempty"` - - - // Tags - Tags *[]string `json:"tags,omitempty"` - - - // DurationSeconds - DurationSeconds *int `json:"durationSeconds,omitempty"` - - - // EndTime - EndTime *time.Time `json:"endTime,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationcalleventtopicwrapup) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationchat.go b/build/platformclientv2/conversationchat.go deleted file mode 100644 index 3d667cac9..000000000 --- a/build/platformclientv2/conversationchat.go +++ /dev/null @@ -1,94 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Conversationchat -type Conversationchat struct { - // State - The connection state of this communication. - State *string `json:"state,omitempty"` - - - // Id - A globally unique identifier for this communication. - Id *string `json:"id,omitempty"` - - - // RoomId - The room id for the chat. - RoomId *string `json:"roomId,omitempty"` - - - // RecordingId - A globally unique identifier for the recording associated with this chat. - RecordingId *string `json:"recordingId,omitempty"` - - - // Segments - The time line of the participant's chat, divided into activity segments. - Segments *[]Segment `json:"segments,omitempty"` - - - // Held - True if this call is held and the person on this side hears silence. - Held *bool `json:"held,omitempty"` - - - // Direction - The direction of the chat - Direction *string `json:"direction,omitempty"` - - - // DisconnectType - System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects. - DisconnectType *string `json:"disconnectType,omitempty"` - - - // StartHoldTime - The timestamp the chat was placed on hold in the cloud clock if the chat is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartHoldTime *time.Time `json:"startHoldTime,omitempty"` - - - // StartAlertingTime - The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartAlertingTime *time.Time `json:"startAlertingTime,omitempty"` - - - // ConnectedTime - The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // DisconnectedTime - The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"` - - - // Provider - The source provider for the email. - Provider *string `json:"provider,omitempty"` - - - // ScriptId - The UUID of the script to use. - ScriptId *string `json:"scriptId,omitempty"` - - - // PeerId - The id of the peer communication corresponding to a matching leg for this communication. - PeerId *string `json:"peerId,omitempty"` - - - // AvatarImageUrl - If available, the URI to the avatar image of this communication. - AvatarImageUrl *string `json:"avatarImageUrl,omitempty"` - - - // JourneyContext - A subset of the Journey System's data relevant to a part of a conversation (for external linkage and internal usage/context). - JourneyContext *Journeycontext `json:"journeyContext,omitempty"` - - - // Wrapup - Call wrap up or disposition data. - Wrapup *Wrapup `json:"wrapup,omitempty"` - - - // AfterCallWork - After-call work for the communication. - AfterCallWork *Aftercallwork `json:"afterCallWork,omitempty"` - - - // AfterCallWorkRequired - Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested. - AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationchat) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationchateventtopicchatconversation.go b/build/platformclientv2/conversationchateventtopicchatconversation.go deleted file mode 100644 index 50b43e94f..000000000 --- a/build/platformclientv2/conversationchateventtopicchatconversation.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationchateventtopicchatconversation -type Conversationchateventtopicchatconversation struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Participants - Participants *[]Conversationchateventtopicchatmediaparticipant `json:"participants,omitempty"` - - - // OtherMediaUris - OtherMediaUris *[]string `json:"otherMediaUris,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationchateventtopicchatconversation) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationchateventtopicchatmediaparticipant.go b/build/platformclientv2/conversationchateventtopicchatmediaparticipant.go deleted file mode 100644 index 39ac3aea8..000000000 --- a/build/platformclientv2/conversationchateventtopicchatmediaparticipant.go +++ /dev/null @@ -1,158 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Conversationchateventtopicchatmediaparticipant -type Conversationchateventtopicchatmediaparticipant struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Address - Address *string `json:"address,omitempty"` - - - // StartTime - StartTime *time.Time `json:"startTime,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // EndTime - EndTime *time.Time `json:"endTime,omitempty"` - - - // StartHoldTime - StartHoldTime *time.Time `json:"startHoldTime,omitempty"` - - - // Purpose - Purpose *string `json:"purpose,omitempty"` - - - // State - State *string `json:"state,omitempty"` - - - // Direction - Direction *string `json:"direction,omitempty"` - - - // DisconnectType - DisconnectType *string `json:"disconnectType,omitempty"` - - - // Held - Held *bool `json:"held,omitempty"` - - - // WrapupRequired - WrapupRequired *bool `json:"wrapupRequired,omitempty"` - - - // WrapupPrompt - WrapupPrompt *string `json:"wrapupPrompt,omitempty"` - - - // User - User *Conversationchateventtopicurireference `json:"user,omitempty"` - - - // Queue - Queue *Conversationchateventtopicurireference `json:"queue,omitempty"` - - - // Team - Team *Conversationchateventtopicurireference `json:"team,omitempty"` - - - // Attributes - Attributes *map[string]string `json:"attributes,omitempty"` - - - // ErrorInfo - ErrorInfo *Conversationchateventtopicerrorbody `json:"errorInfo,omitempty"` - - - // Script - Script *Conversationchateventtopicurireference `json:"script,omitempty"` - - - // WrapupTimeoutMs - WrapupTimeoutMs *int `json:"wrapupTimeoutMs,omitempty"` - - - // WrapupSkipped - WrapupSkipped *bool `json:"wrapupSkipped,omitempty"` - - - // AlertingTimeoutMs - AlertingTimeoutMs *int `json:"alertingTimeoutMs,omitempty"` - - - // Provider - Provider *string `json:"provider,omitempty"` - - - // ExternalContact - ExternalContact *Conversationchateventtopicurireference `json:"externalContact,omitempty"` - - - // ExternalOrganization - ExternalOrganization *Conversationchateventtopicurireference `json:"externalOrganization,omitempty"` - - - // Wrapup - Wrapup *Conversationchateventtopicwrapup `json:"wrapup,omitempty"` - - - // ConversationRoutingData - ConversationRoutingData *Conversationchateventtopicconversationroutingdata `json:"conversationRoutingData,omitempty"` - - - // Peer - Peer *string `json:"peer,omitempty"` - - - // ScreenRecordingState - ScreenRecordingState *string `json:"screenRecordingState,omitempty"` - - - // FlaggedReason - FlaggedReason *string `json:"flaggedReason,omitempty"` - - - // JourneyContext - JourneyContext *Conversationchateventtopicjourneycontext `json:"journeyContext,omitempty"` - - - // StartAcwTime - StartAcwTime *time.Time `json:"startAcwTime,omitempty"` - - - // EndAcwTime - EndAcwTime *time.Time `json:"endAcwTime,omitempty"` - - - // RoomId - RoomId *string `json:"roomId,omitempty"` - - - // AvatarImageUrl - AvatarImageUrl *string `json:"avatarImageUrl,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationchateventtopicchatmediaparticipant) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationchateventtopicconversationroutingdata.go b/build/platformclientv2/conversationchateventtopicconversationroutingdata.go deleted file mode 100644 index 4894dd0de..000000000 --- a/build/platformclientv2/conversationchateventtopicconversationroutingdata.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationchateventtopicconversationroutingdata -type Conversationchateventtopicconversationroutingdata struct { - // Queue - Queue *Conversationchateventtopicurireference `json:"queue,omitempty"` - - - // Language - Language *Conversationchateventtopicurireference `json:"language,omitempty"` - - - // Priority - Priority *int `json:"priority,omitempty"` - - - // Skills - Skills *[]Conversationchateventtopicurireference `json:"skills,omitempty"` - - - // ScoredAgents - ScoredAgents *[]Conversationchateventtopicscoredagent `json:"scoredAgents,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationchateventtopicconversationroutingdata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationchateventtopicdetail.go b/build/platformclientv2/conversationchateventtopicdetail.go deleted file mode 100644 index 9e792801e..000000000 --- a/build/platformclientv2/conversationchateventtopicdetail.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationchateventtopicdetail -type Conversationchateventtopicdetail struct { - // ErrorCode - ErrorCode *string `json:"errorCode,omitempty"` - - - // FieldName - FieldName *string `json:"fieldName,omitempty"` - - - // EntityId - EntityId *string `json:"entityId,omitempty"` - - - // EntityName - EntityName *string `json:"entityName,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationchateventtopicdetail) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationchateventtopicerrorbody.go b/build/platformclientv2/conversationchateventtopicerrorbody.go deleted file mode 100644 index bde50e200..000000000 --- a/build/platformclientv2/conversationchateventtopicerrorbody.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationchateventtopicerrorbody -type Conversationchateventtopicerrorbody struct { - // Status - Status *int `json:"status,omitempty"` - - - // Code - Code *string `json:"code,omitempty"` - - - // EntityId - EntityId *string `json:"entityId,omitempty"` - - - // EntityName - EntityName *string `json:"entityName,omitempty"` - - - // Message - Message *string `json:"message,omitempty"` - - - // MessageWithParams - MessageWithParams *string `json:"messageWithParams,omitempty"` - - - // MessageParams - MessageParams *map[string]string `json:"messageParams,omitempty"` - - - // ContextId - ContextId *string `json:"contextId,omitempty"` - - - // Details - Details *[]Conversationchateventtopicdetail `json:"details,omitempty"` - - - // Errors - Errors *[]Conversationchateventtopicerrorbody `json:"errors,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationchateventtopicerrorbody) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationchateventtopicjourneyaction.go b/build/platformclientv2/conversationchateventtopicjourneyaction.go deleted file mode 100644 index 7bd146c57..000000000 --- a/build/platformclientv2/conversationchateventtopicjourneyaction.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationchateventtopicjourneyaction -type Conversationchateventtopicjourneyaction struct { - // Id - Id *string `json:"id,omitempty"` - - - // ActionMap - ActionMap *Conversationchateventtopicjourneyactionmap `json:"actionMap,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationchateventtopicjourneyaction) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationchateventtopicjourneyactionmap.go b/build/platformclientv2/conversationchateventtopicjourneyactionmap.go deleted file mode 100644 index e04929ef3..000000000 --- a/build/platformclientv2/conversationchateventtopicjourneyactionmap.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationchateventtopicjourneyactionmap -type Conversationchateventtopicjourneyactionmap struct { - // Id - Id *string `json:"id,omitempty"` - - - // Version - Version *int `json:"version,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationchateventtopicjourneyactionmap) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationchateventtopicjourneycontext.go b/build/platformclientv2/conversationchateventtopicjourneycontext.go deleted file mode 100644 index 78c4ad60e..000000000 --- a/build/platformclientv2/conversationchateventtopicjourneycontext.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationchateventtopicjourneycontext -type Conversationchateventtopicjourneycontext struct { - // Customer - Customer *Conversationchateventtopicjourneycustomer `json:"customer,omitempty"` - - - // CustomerSession - CustomerSession *Conversationchateventtopicjourneycustomersession `json:"customerSession,omitempty"` - - - // TriggeringAction - TriggeringAction *Conversationchateventtopicjourneyaction `json:"triggeringAction,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationchateventtopicjourneycontext) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationchateventtopicjourneycustomer.go b/build/platformclientv2/conversationchateventtopicjourneycustomer.go deleted file mode 100644 index 68ac07742..000000000 --- a/build/platformclientv2/conversationchateventtopicjourneycustomer.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationchateventtopicjourneycustomer -type Conversationchateventtopicjourneycustomer struct { - // Id - Id *string `json:"id,omitempty"` - - - // IdType - IdType *string `json:"idType,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationchateventtopicjourneycustomer) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationchateventtopicjourneycustomersession.go b/build/platformclientv2/conversationchateventtopicjourneycustomersession.go deleted file mode 100644 index 585a60f3b..000000000 --- a/build/platformclientv2/conversationchateventtopicjourneycustomersession.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationchateventtopicjourneycustomersession -type Conversationchateventtopicjourneycustomersession struct { - // Id - Id *string `json:"id,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationchateventtopicjourneycustomersession) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationchateventtopicscoredagent.go b/build/platformclientv2/conversationchateventtopicscoredagent.go deleted file mode 100644 index 2c9723bce..000000000 --- a/build/platformclientv2/conversationchateventtopicscoredagent.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationchateventtopicscoredagent -type Conversationchateventtopicscoredagent struct { - // Agent - Agent *Conversationchateventtopicurireference `json:"agent,omitempty"` - - - // Score - Score *int `json:"score,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationchateventtopicscoredagent) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationchateventtopicurireference.go b/build/platformclientv2/conversationchateventtopicurireference.go deleted file mode 100644 index 95bc8ab0d..000000000 --- a/build/platformclientv2/conversationchateventtopicurireference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationchateventtopicurireference -type Conversationchateventtopicurireference struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationchateventtopicurireference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationchateventtopicwrapup.go b/build/platformclientv2/conversationchateventtopicwrapup.go deleted file mode 100644 index 749160b28..000000000 --- a/build/platformclientv2/conversationchateventtopicwrapup.go +++ /dev/null @@ -1,38 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Conversationchateventtopicwrapup -type Conversationchateventtopicwrapup struct { - // Code - Code *string `json:"code,omitempty"` - - - // Notes - Notes *string `json:"notes,omitempty"` - - - // Tags - Tags *[]string `json:"tags,omitempty"` - - - // DurationSeconds - DurationSeconds *int `json:"durationSeconds,omitempty"` - - - // EndTime - EndTime *time.Time `json:"endTime,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationchateventtopicwrapup) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationcobrowseeventtopiccobrowseconversation.go b/build/platformclientv2/conversationcobrowseeventtopiccobrowseconversation.go deleted file mode 100644 index 581b33c7c..000000000 --- a/build/platformclientv2/conversationcobrowseeventtopiccobrowseconversation.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationcobrowseeventtopiccobrowseconversation -type Conversationcobrowseeventtopiccobrowseconversation struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Participants - Participants *[]Conversationcobrowseeventtopiccobrowsemediaparticipant `json:"participants,omitempty"` - - - // OtherMediaUris - OtherMediaUris *[]string `json:"otherMediaUris,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationcobrowseeventtopiccobrowseconversation) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationcobrowseeventtopiccobrowsemediaparticipant.go b/build/platformclientv2/conversationcobrowseeventtopiccobrowsemediaparticipant.go deleted file mode 100644 index 742629c64..000000000 --- a/build/platformclientv2/conversationcobrowseeventtopiccobrowsemediaparticipant.go +++ /dev/null @@ -1,170 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Conversationcobrowseeventtopiccobrowsemediaparticipant -type Conversationcobrowseeventtopiccobrowsemediaparticipant struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Address - Address *string `json:"address,omitempty"` - - - // StartTime - StartTime *time.Time `json:"startTime,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // EndTime - EndTime *time.Time `json:"endTime,omitempty"` - - - // StartHoldTime - StartHoldTime *time.Time `json:"startHoldTime,omitempty"` - - - // Purpose - Purpose *string `json:"purpose,omitempty"` - - - // State - State *string `json:"state,omitempty"` - - - // Direction - Direction *string `json:"direction,omitempty"` - - - // DisconnectType - DisconnectType *string `json:"disconnectType,omitempty"` - - - // Held - Held *bool `json:"held,omitempty"` - - - // WrapupRequired - WrapupRequired *bool `json:"wrapupRequired,omitempty"` - - - // WrapupPrompt - WrapupPrompt *string `json:"wrapupPrompt,omitempty"` - - - // User - User *Conversationcobrowseeventtopicurireference `json:"user,omitempty"` - - - // Queue - Queue *Conversationcobrowseeventtopicurireference `json:"queue,omitempty"` - - - // Team - Team *Conversationcobrowseeventtopicurireference `json:"team,omitempty"` - - - // Attributes - Attributes *map[string]string `json:"attributes,omitempty"` - - - // ErrorInfo - ErrorInfo *Conversationcobrowseeventtopicerrorbody `json:"errorInfo,omitempty"` - - - // Script - Script *Conversationcobrowseeventtopicurireference `json:"script,omitempty"` - - - // WrapupTimeoutMs - WrapupTimeoutMs *int `json:"wrapupTimeoutMs,omitempty"` - - - // WrapupSkipped - WrapupSkipped *bool `json:"wrapupSkipped,omitempty"` - - - // AlertingTimeoutMs - AlertingTimeoutMs *int `json:"alertingTimeoutMs,omitempty"` - - - // Provider - Provider *string `json:"provider,omitempty"` - - - // ExternalContact - ExternalContact *Conversationcobrowseeventtopicurireference `json:"externalContact,omitempty"` - - - // ExternalOrganization - ExternalOrganization *Conversationcobrowseeventtopicurireference `json:"externalOrganization,omitempty"` - - - // Wrapup - Wrapup *Conversationcobrowseeventtopicwrapup `json:"wrapup,omitempty"` - - - // ConversationRoutingData - ConversationRoutingData *Conversationcobrowseeventtopicconversationroutingdata `json:"conversationRoutingData,omitempty"` - - - // Peer - Peer *string `json:"peer,omitempty"` - - - // ScreenRecordingState - ScreenRecordingState *string `json:"screenRecordingState,omitempty"` - - - // FlaggedReason - FlaggedReason *string `json:"flaggedReason,omitempty"` - - - // JourneyContext - JourneyContext *Conversationcobrowseeventtopicjourneycontext `json:"journeyContext,omitempty"` - - - // StartAcwTime - StartAcwTime *time.Time `json:"startAcwTime,omitempty"` - - - // EndAcwTime - EndAcwTime *time.Time `json:"endAcwTime,omitempty"` - - - // CobrowseSessionId - CobrowseSessionId *string `json:"cobrowseSessionId,omitempty"` - - - // CobrowseRole - CobrowseRole *string `json:"cobrowseRole,omitempty"` - - - // ViewerUrl - ViewerUrl *string `json:"viewerUrl,omitempty"` - - - // ProviderEventTime - ProviderEventTime *time.Time `json:"providerEventTime,omitempty"` - - - // Controlling - Controlling *[]string `json:"controlling,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationcobrowseeventtopiccobrowsemediaparticipant) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationcobrowseeventtopicconversationroutingdata.go b/build/platformclientv2/conversationcobrowseeventtopicconversationroutingdata.go deleted file mode 100644 index 8ea2c98d1..000000000 --- a/build/platformclientv2/conversationcobrowseeventtopicconversationroutingdata.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationcobrowseeventtopicconversationroutingdata -type Conversationcobrowseeventtopicconversationroutingdata struct { - // Queue - Queue *Conversationcobrowseeventtopicurireference `json:"queue,omitempty"` - - - // Language - Language *Conversationcobrowseeventtopicurireference `json:"language,omitempty"` - - - // Priority - Priority *int `json:"priority,omitempty"` - - - // Skills - Skills *[]Conversationcobrowseeventtopicurireference `json:"skills,omitempty"` - - - // ScoredAgents - ScoredAgents *[]Conversationcobrowseeventtopicscoredagent `json:"scoredAgents,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationcobrowseeventtopicconversationroutingdata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationcobrowseeventtopicdetail.go b/build/platformclientv2/conversationcobrowseeventtopicdetail.go deleted file mode 100644 index 04460b13d..000000000 --- a/build/platformclientv2/conversationcobrowseeventtopicdetail.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationcobrowseeventtopicdetail -type Conversationcobrowseeventtopicdetail struct { - // ErrorCode - ErrorCode *string `json:"errorCode,omitempty"` - - - // FieldName - FieldName *string `json:"fieldName,omitempty"` - - - // EntityId - EntityId *string `json:"entityId,omitempty"` - - - // EntityName - EntityName *string `json:"entityName,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationcobrowseeventtopicdetail) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationcobrowseeventtopicerrorbody.go b/build/platformclientv2/conversationcobrowseeventtopicerrorbody.go deleted file mode 100644 index 1ca552b05..000000000 --- a/build/platformclientv2/conversationcobrowseeventtopicerrorbody.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationcobrowseeventtopicerrorbody -type Conversationcobrowseeventtopicerrorbody struct { - // Status - Status *int `json:"status,omitempty"` - - - // Code - Code *string `json:"code,omitempty"` - - - // EntityId - EntityId *string `json:"entityId,omitempty"` - - - // EntityName - EntityName *string `json:"entityName,omitempty"` - - - // Message - Message *string `json:"message,omitempty"` - - - // MessageWithParams - MessageWithParams *string `json:"messageWithParams,omitempty"` - - - // MessageParams - MessageParams *map[string]string `json:"messageParams,omitempty"` - - - // ContextId - ContextId *string `json:"contextId,omitempty"` - - - // Details - Details *[]Conversationcobrowseeventtopicdetail `json:"details,omitempty"` - - - // Errors - Errors *[]Conversationcobrowseeventtopicerrorbody `json:"errors,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationcobrowseeventtopicerrorbody) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationcobrowseeventtopicjourneyaction.go b/build/platformclientv2/conversationcobrowseeventtopicjourneyaction.go deleted file mode 100644 index b7850392a..000000000 --- a/build/platformclientv2/conversationcobrowseeventtopicjourneyaction.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationcobrowseeventtopicjourneyaction -type Conversationcobrowseeventtopicjourneyaction struct { - // Id - Id *string `json:"id,omitempty"` - - - // ActionMap - ActionMap *Conversationcobrowseeventtopicjourneyactionmap `json:"actionMap,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationcobrowseeventtopicjourneyaction) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationcobrowseeventtopicjourneyactionmap.go b/build/platformclientv2/conversationcobrowseeventtopicjourneyactionmap.go deleted file mode 100644 index 2750c6077..000000000 --- a/build/platformclientv2/conversationcobrowseeventtopicjourneyactionmap.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationcobrowseeventtopicjourneyactionmap -type Conversationcobrowseeventtopicjourneyactionmap struct { - // Id - Id *string `json:"id,omitempty"` - - - // Version - Version *int `json:"version,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationcobrowseeventtopicjourneyactionmap) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationcobrowseeventtopicjourneycontext.go b/build/platformclientv2/conversationcobrowseeventtopicjourneycontext.go deleted file mode 100644 index 6c834c818..000000000 --- a/build/platformclientv2/conversationcobrowseeventtopicjourneycontext.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationcobrowseeventtopicjourneycontext -type Conversationcobrowseeventtopicjourneycontext struct { - // Customer - Customer *Conversationcobrowseeventtopicjourneycustomer `json:"customer,omitempty"` - - - // CustomerSession - CustomerSession *Conversationcobrowseeventtopicjourneycustomersession `json:"customerSession,omitempty"` - - - // TriggeringAction - TriggeringAction *Conversationcobrowseeventtopicjourneyaction `json:"triggeringAction,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationcobrowseeventtopicjourneycontext) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationcobrowseeventtopicjourneycustomer.go b/build/platformclientv2/conversationcobrowseeventtopicjourneycustomer.go deleted file mode 100644 index 9b0fa2acc..000000000 --- a/build/platformclientv2/conversationcobrowseeventtopicjourneycustomer.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationcobrowseeventtopicjourneycustomer -type Conversationcobrowseeventtopicjourneycustomer struct { - // Id - Id *string `json:"id,omitempty"` - - - // IdType - IdType *string `json:"idType,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationcobrowseeventtopicjourneycustomer) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationcobrowseeventtopicjourneycustomersession.go b/build/platformclientv2/conversationcobrowseeventtopicjourneycustomersession.go deleted file mode 100644 index a8b4df11e..000000000 --- a/build/platformclientv2/conversationcobrowseeventtopicjourneycustomersession.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationcobrowseeventtopicjourneycustomersession -type Conversationcobrowseeventtopicjourneycustomersession struct { - // Id - Id *string `json:"id,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationcobrowseeventtopicjourneycustomersession) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationcobrowseeventtopicscoredagent.go b/build/platformclientv2/conversationcobrowseeventtopicscoredagent.go deleted file mode 100644 index d91480e0f..000000000 --- a/build/platformclientv2/conversationcobrowseeventtopicscoredagent.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationcobrowseeventtopicscoredagent -type Conversationcobrowseeventtopicscoredagent struct { - // Agent - Agent *Conversationcobrowseeventtopicurireference `json:"agent,omitempty"` - - - // Score - Score *int `json:"score,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationcobrowseeventtopicscoredagent) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationcobrowseeventtopicurireference.go b/build/platformclientv2/conversationcobrowseeventtopicurireference.go deleted file mode 100644 index 14b4b28c1..000000000 --- a/build/platformclientv2/conversationcobrowseeventtopicurireference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationcobrowseeventtopicurireference -type Conversationcobrowseeventtopicurireference struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationcobrowseeventtopicurireference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationcobrowseeventtopicwrapup.go b/build/platformclientv2/conversationcobrowseeventtopicwrapup.go deleted file mode 100644 index d75d68b1b..000000000 --- a/build/platformclientv2/conversationcobrowseeventtopicwrapup.go +++ /dev/null @@ -1,38 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Conversationcobrowseeventtopicwrapup -type Conversationcobrowseeventtopicwrapup struct { - // Code - Code *string `json:"code,omitempty"` - - - // Notes - Notes *string `json:"notes,omitempty"` - - - // Tags - Tags *[]string `json:"tags,omitempty"` - - - // DurationSeconds - DurationSeconds *int `json:"durationSeconds,omitempty"` - - - // EndTime - EndTime *time.Time `json:"endTime,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationcobrowseeventtopicwrapup) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationdeletionprotectionquery.go b/build/platformclientv2/conversationdeletionprotectionquery.go deleted file mode 100644 index eb7be5cb9..000000000 --- a/build/platformclientv2/conversationdeletionprotectionquery.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationdeletionprotectionquery -type Conversationdeletionprotectionquery struct { - // ConversationIds - This is a list of ConversationIds. The list cannot exceed 100 conversationids. - ConversationIds *[]string `json:"conversationIds,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationdeletionprotectionquery) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationdetailqueryclause.go b/build/platformclientv2/conversationdetailqueryclause.go deleted file mode 100644 index 4b52be483..000000000 --- a/build/platformclientv2/conversationdetailqueryclause.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationdetailqueryclause -type Conversationdetailqueryclause struct { - // VarType - Boolean operation to apply to the provided predicates - VarType *string `json:"type,omitempty"` - - - // Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value). - Predicates *[]Conversationdetailquerypredicate `json:"predicates,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationdetailqueryclause) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationdetailqueryfilter.go b/build/platformclientv2/conversationdetailqueryfilter.go deleted file mode 100644 index cf0320fd8..000000000 --- a/build/platformclientv2/conversationdetailqueryfilter.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationdetailqueryfilter -type Conversationdetailqueryfilter struct { - // VarType - Boolean operation to apply to the provided predicates and clauses - VarType *string `json:"type,omitempty"` - - - // Clauses - Boolean 'and/or' logic with up to two-levels of nesting - Clauses *[]Conversationdetailqueryclause `json:"clauses,omitempty"` - - - // Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value). - Predicates *[]Conversationdetailquerypredicate `json:"predicates,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationdetailqueryfilter) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationdetailquerypredicate.go b/build/platformclientv2/conversationdetailquerypredicate.go deleted file mode 100644 index 2f361d64d..000000000 --- a/build/platformclientv2/conversationdetailquerypredicate.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationdetailquerypredicate -type Conversationdetailquerypredicate struct { - // VarType - Optional type, can usually be inferred - VarType *string `json:"type,omitempty"` - - - // Dimension - Left hand side for dimension predicates - Dimension *string `json:"dimension,omitempty"` - - - // Metric - Left hand side for metric predicates - Metric *string `json:"metric,omitempty"` - - - // Operator - Optional operator, default is matches - Operator *string `json:"operator,omitempty"` - - - // Value - Right hand side for dimension or metric predicates - Value *string `json:"value,omitempty"` - - - // VarRange - Right hand side for dimension or metric predicates - VarRange *Numericrange `json:"range,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationdetailquerypredicate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationdetailsdatalakeavailabilitytopicdataavailabilitychangenotification.go b/build/platformclientv2/conversationdetailsdatalakeavailabilitytopicdataavailabilitychangenotification.go deleted file mode 100644 index 516b81340..000000000 --- a/build/platformclientv2/conversationdetailsdatalakeavailabilitytopicdataavailabilitychangenotification.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationdetailsdatalakeavailabilitytopicdataavailabilitychangenotification -type Conversationdetailsdatalakeavailabilitytopicdataavailabilitychangenotification struct { - // DataAvailabilityDate - DataAvailabilityDate *Conversationdetailsdatalakeavailabilitytopicdatetime `json:"dataAvailabilityDate,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationdetailsdatalakeavailabilitytopicdataavailabilitychangenotification) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationdetailsdatalakeavailabilitytopicdatetime.go b/build/platformclientv2/conversationdetailsdatalakeavailabilitytopicdatetime.go deleted file mode 100644 index abe3acd74..000000000 --- a/build/platformclientv2/conversationdetailsdatalakeavailabilitytopicdatetime.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationdetailsdatalakeavailabilitytopicdatetime -type Conversationdetailsdatalakeavailabilitytopicdatetime struct { - // IMillis - IMillis *int `json:"iMillis,omitempty"` - - - // BeforeNow - BeforeNow *bool `json:"beforeNow,omitempty"` - - - // EqualNow - EqualNow *bool `json:"equalNow,omitempty"` - - - // AfterNow - AfterNow *bool `json:"afterNow,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationdetailsdatalakeavailabilitytopicdatetime) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationdivisionmembership.go b/build/platformclientv2/conversationdivisionmembership.go deleted file mode 100644 index 68a80ce23..000000000 --- a/build/platformclientv2/conversationdivisionmembership.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationdivisionmembership -type Conversationdivisionmembership struct { - // Division - A division the conversation belongs to. - Division *Domainentityref `json:"division,omitempty"` - - - // Entities - The entities on the conversation within the division. These are the users, queues, work flows, etc. that can be on conversations and and be assigned to different divisions. - Entities *[]Domainentityref `json:"entities,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationdivisionmembership) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationemaileventtopicattachment.go b/build/platformclientv2/conversationemaileventtopicattachment.go deleted file mode 100644 index cc00be633..000000000 --- a/build/platformclientv2/conversationemaileventtopicattachment.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationemaileventtopicattachment -type Conversationemaileventtopicattachment struct { - // AttachmentId - AttachmentId *string `json:"attachmentId,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // ContentUri - ContentUri *string `json:"contentUri,omitempty"` - - - // ContentType - ContentType *string `json:"contentType,omitempty"` - - - // ContentLength - ContentLength *int `json:"contentLength,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationemaileventtopicattachment) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationemaileventtopicconversationroutingdata.go b/build/platformclientv2/conversationemaileventtopicconversationroutingdata.go deleted file mode 100644 index 5b010b958..000000000 --- a/build/platformclientv2/conversationemaileventtopicconversationroutingdata.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationemaileventtopicconversationroutingdata -type Conversationemaileventtopicconversationroutingdata struct { - // Queue - Queue *Conversationemaileventtopicurireference `json:"queue,omitempty"` - - - // Language - Language *Conversationemaileventtopicurireference `json:"language,omitempty"` - - - // Priority - Priority *int `json:"priority,omitempty"` - - - // Skills - Skills *[]Conversationemaileventtopicurireference `json:"skills,omitempty"` - - - // ScoredAgents - ScoredAgents *[]Conversationemaileventtopicscoredagent `json:"scoredAgents,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationemaileventtopicconversationroutingdata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationemaileventtopicdetail.go b/build/platformclientv2/conversationemaileventtopicdetail.go deleted file mode 100644 index ec7ef574d..000000000 --- a/build/platformclientv2/conversationemaileventtopicdetail.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationemaileventtopicdetail -type Conversationemaileventtopicdetail struct { - // ErrorCode - ErrorCode *string `json:"errorCode,omitempty"` - - - // FieldName - FieldName *string `json:"fieldName,omitempty"` - - - // EntityId - EntityId *string `json:"entityId,omitempty"` - - - // EntityName - EntityName *string `json:"entityName,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationemaileventtopicdetail) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationemaileventtopicemailconversation.go b/build/platformclientv2/conversationemaileventtopicemailconversation.go deleted file mode 100644 index 68cb14b1a..000000000 --- a/build/platformclientv2/conversationemaileventtopicemailconversation.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationemaileventtopicemailconversation -type Conversationemaileventtopicemailconversation struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Participants - Participants *[]Conversationemaileventtopicemailmediaparticipant `json:"participants,omitempty"` - - - // OtherMediaUris - OtherMediaUris *[]string `json:"otherMediaUris,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationemaileventtopicemailconversation) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationemaileventtopicemailmediaparticipant.go b/build/platformclientv2/conversationemaileventtopicemailmediaparticipant.go deleted file mode 100644 index 9d2b854fa..000000000 --- a/build/platformclientv2/conversationemaileventtopicemailmediaparticipant.go +++ /dev/null @@ -1,174 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Conversationemaileventtopicemailmediaparticipant -type Conversationemaileventtopicemailmediaparticipant struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Address - Address *string `json:"address,omitempty"` - - - // StartTime - StartTime *time.Time `json:"startTime,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // EndTime - EndTime *time.Time `json:"endTime,omitempty"` - - - // StartHoldTime - StartHoldTime *time.Time `json:"startHoldTime,omitempty"` - - - // Purpose - Purpose *string `json:"purpose,omitempty"` - - - // State - State *string `json:"state,omitempty"` - - - // Direction - Direction *string `json:"direction,omitempty"` - - - // DisconnectType - DisconnectType *string `json:"disconnectType,omitempty"` - - - // Held - Held *bool `json:"held,omitempty"` - - - // WrapupRequired - WrapupRequired *bool `json:"wrapupRequired,omitempty"` - - - // WrapupPrompt - WrapupPrompt *string `json:"wrapupPrompt,omitempty"` - - - // User - User *Conversationemaileventtopicurireference `json:"user,omitempty"` - - - // Queue - Queue *Conversationemaileventtopicurireference `json:"queue,omitempty"` - - - // Team - Team *Conversationemaileventtopicurireference `json:"team,omitempty"` - - - // Attributes - Attributes *map[string]string `json:"attributes,omitempty"` - - - // ErrorInfo - ErrorInfo *Conversationemaileventtopicerrorbody `json:"errorInfo,omitempty"` - - - // Script - Script *Conversationemaileventtopicurireference `json:"script,omitempty"` - - - // WrapupTimeoutMs - WrapupTimeoutMs *int `json:"wrapupTimeoutMs,omitempty"` - - - // WrapupSkipped - WrapupSkipped *bool `json:"wrapupSkipped,omitempty"` - - - // AlertingTimeoutMs - AlertingTimeoutMs *int `json:"alertingTimeoutMs,omitempty"` - - - // Provider - Provider *string `json:"provider,omitempty"` - - - // ExternalContact - ExternalContact *Conversationemaileventtopicurireference `json:"externalContact,omitempty"` - - - // ExternalOrganization - ExternalOrganization *Conversationemaileventtopicurireference `json:"externalOrganization,omitempty"` - - - // Wrapup - Wrapup *Conversationemaileventtopicwrapup `json:"wrapup,omitempty"` - - - // ConversationRoutingData - ConversationRoutingData *Conversationemaileventtopicconversationroutingdata `json:"conversationRoutingData,omitempty"` - - - // Peer - Peer *string `json:"peer,omitempty"` - - - // ScreenRecordingState - ScreenRecordingState *string `json:"screenRecordingState,omitempty"` - - - // FlaggedReason - FlaggedReason *string `json:"flaggedReason,omitempty"` - - - // JourneyContext - JourneyContext *Conversationemaileventtopicjourneycontext `json:"journeyContext,omitempty"` - - - // StartAcwTime - StartAcwTime *time.Time `json:"startAcwTime,omitempty"` - - - // EndAcwTime - EndAcwTime *time.Time `json:"endAcwTime,omitempty"` - - - // Subject - Subject *string `json:"subject,omitempty"` - - - // MessagesSent - MessagesSent *int `json:"messagesSent,omitempty"` - - - // AutoGenerated - AutoGenerated *bool `json:"autoGenerated,omitempty"` - - - // MessageId - MessageId *string `json:"messageId,omitempty"` - - - // DraftAttachments - DraftAttachments *[]Conversationemaileventtopicattachment `json:"draftAttachments,omitempty"` - - - // Spam - Spam *bool `json:"spam,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationemaileventtopicemailmediaparticipant) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationemaileventtopicerrorbody.go b/build/platformclientv2/conversationemaileventtopicerrorbody.go deleted file mode 100644 index ae7d02adf..000000000 --- a/build/platformclientv2/conversationemaileventtopicerrorbody.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationemaileventtopicerrorbody -type Conversationemaileventtopicerrorbody struct { - // Status - Status *int `json:"status,omitempty"` - - - // Code - Code *string `json:"code,omitempty"` - - - // EntityId - EntityId *string `json:"entityId,omitempty"` - - - // EntityName - EntityName *string `json:"entityName,omitempty"` - - - // Message - Message *string `json:"message,omitempty"` - - - // MessageWithParams - MessageWithParams *string `json:"messageWithParams,omitempty"` - - - // MessageParams - MessageParams *map[string]string `json:"messageParams,omitempty"` - - - // ContextId - ContextId *string `json:"contextId,omitempty"` - - - // Details - Details *[]Conversationemaileventtopicdetail `json:"details,omitempty"` - - - // Errors - Errors *[]Conversationemaileventtopicerrorbody `json:"errors,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationemaileventtopicerrorbody) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationemaileventtopicjourneyaction.go b/build/platformclientv2/conversationemaileventtopicjourneyaction.go deleted file mode 100644 index aa9000a83..000000000 --- a/build/platformclientv2/conversationemaileventtopicjourneyaction.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationemaileventtopicjourneyaction -type Conversationemaileventtopicjourneyaction struct { - // Id - Id *string `json:"id,omitempty"` - - - // ActionMap - ActionMap *Conversationemaileventtopicjourneyactionmap `json:"actionMap,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationemaileventtopicjourneyaction) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationemaileventtopicjourneyactionmap.go b/build/platformclientv2/conversationemaileventtopicjourneyactionmap.go deleted file mode 100644 index b92d03e1e..000000000 --- a/build/platformclientv2/conversationemaileventtopicjourneyactionmap.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationemaileventtopicjourneyactionmap -type Conversationemaileventtopicjourneyactionmap struct { - // Id - Id *string `json:"id,omitempty"` - - - // Version - Version *int `json:"version,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationemaileventtopicjourneyactionmap) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationemaileventtopicjourneycontext.go b/build/platformclientv2/conversationemaileventtopicjourneycontext.go deleted file mode 100644 index 4a9ec72dd..000000000 --- a/build/platformclientv2/conversationemaileventtopicjourneycontext.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationemaileventtopicjourneycontext -type Conversationemaileventtopicjourneycontext struct { - // Customer - Customer *Conversationemaileventtopicjourneycustomer `json:"customer,omitempty"` - - - // CustomerSession - CustomerSession *Conversationemaileventtopicjourneycustomersession `json:"customerSession,omitempty"` - - - // TriggeringAction - TriggeringAction *Conversationemaileventtopicjourneyaction `json:"triggeringAction,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationemaileventtopicjourneycontext) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationemaileventtopicjourneycustomer.go b/build/platformclientv2/conversationemaileventtopicjourneycustomer.go deleted file mode 100644 index e84039e91..000000000 --- a/build/platformclientv2/conversationemaileventtopicjourneycustomer.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationemaileventtopicjourneycustomer -type Conversationemaileventtopicjourneycustomer struct { - // Id - Id *string `json:"id,omitempty"` - - - // IdType - IdType *string `json:"idType,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationemaileventtopicjourneycustomer) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationemaileventtopicjourneycustomersession.go b/build/platformclientv2/conversationemaileventtopicjourneycustomersession.go deleted file mode 100644 index 6d80182c7..000000000 --- a/build/platformclientv2/conversationemaileventtopicjourneycustomersession.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationemaileventtopicjourneycustomersession -type Conversationemaileventtopicjourneycustomersession struct { - // Id - Id *string `json:"id,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationemaileventtopicjourneycustomersession) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationemaileventtopicscoredagent.go b/build/platformclientv2/conversationemaileventtopicscoredagent.go deleted file mode 100644 index 26d3f8732..000000000 --- a/build/platformclientv2/conversationemaileventtopicscoredagent.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationemaileventtopicscoredagent -type Conversationemaileventtopicscoredagent struct { - // Agent - Agent *Conversationemaileventtopicurireference `json:"agent,omitempty"` - - - // Score - Score *int `json:"score,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationemaileventtopicscoredagent) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationemaileventtopicurireference.go b/build/platformclientv2/conversationemaileventtopicurireference.go deleted file mode 100644 index 6845f5ce2..000000000 --- a/build/platformclientv2/conversationemaileventtopicurireference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationemaileventtopicurireference -type Conversationemaileventtopicurireference struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationemaileventtopicurireference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationemaileventtopicwrapup.go b/build/platformclientv2/conversationemaileventtopicwrapup.go deleted file mode 100644 index 3bf3f5849..000000000 --- a/build/platformclientv2/conversationemaileventtopicwrapup.go +++ /dev/null @@ -1,38 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Conversationemaileventtopicwrapup -type Conversationemaileventtopicwrapup struct { - // Code - Code *string `json:"code,omitempty"` - - - // Notes - Notes *string `json:"notes,omitempty"` - - - // Tags - Tags *[]string `json:"tags,omitempty"` - - - // DurationSeconds - DurationSeconds *int `json:"durationSeconds,omitempty"` - - - // EndTime - EndTime *time.Time `json:"endTime,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationemaileventtopicwrapup) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationentitylisting.go b/build/platformclientv2/conversationentitylisting.go deleted file mode 100644 index 186dcbd4f..000000000 --- a/build/platformclientv2/conversationentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationentitylisting -type Conversationentitylisting struct { - // Entities - Entities *[]Conversation `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationeventtopicaddress.go b/build/platformclientv2/conversationeventtopicaddress.go deleted file mode 100644 index a4a42d0d6..000000000 --- a/build/platformclientv2/conversationeventtopicaddress.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationeventtopicaddress -type Conversationeventtopicaddress struct { - // Name - Name *string `json:"name,omitempty"` - - - // NameRaw - NameRaw *string `json:"nameRaw,omitempty"` - - - // AddressNormalized - AddressNormalized *string `json:"addressNormalized,omitempty"` - - - // AddressRaw - AddressRaw *string `json:"addressRaw,omitempty"` - - - // AddressDisplayable - AddressDisplayable *string `json:"addressDisplayable,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationeventtopicaddress) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationeventtopicaftercallwork.go b/build/platformclientv2/conversationeventtopicaftercallwork.go deleted file mode 100644 index 727e42919..000000000 --- a/build/platformclientv2/conversationeventtopicaftercallwork.go +++ /dev/null @@ -1,26 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Conversationeventtopicaftercallwork -type Conversationeventtopicaftercallwork struct { - // State - State *string `json:"state,omitempty"` - - - // StartTime - StartTime *time.Time `json:"startTime,omitempty"` - - - // EndTime - EndTime *time.Time `json:"endTime,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationeventtopicaftercallwork) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationeventtopicattachment.go b/build/platformclientv2/conversationeventtopicattachment.go deleted file mode 100644 index 126da0720..000000000 --- a/build/platformclientv2/conversationeventtopicattachment.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationeventtopicattachment -type Conversationeventtopicattachment struct { - // AttachmentId - AttachmentId *string `json:"attachmentId,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // ContentUri - ContentUri *string `json:"contentUri,omitempty"` - - - // ContentType - ContentType *string `json:"contentType,omitempty"` - - - // ContentLength - ContentLength *int `json:"contentLength,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationeventtopicattachment) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationeventtopiccall.go b/build/platformclientv2/conversationeventtopiccall.go deleted file mode 100644 index 41541ccc5..000000000 --- a/build/platformclientv2/conversationeventtopiccall.go +++ /dev/null @@ -1,122 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Conversationeventtopiccall -type Conversationeventtopiccall struct { - // Id - Id *string `json:"id,omitempty"` - - - // State - State *string `json:"state,omitempty"` - - - // Recording - Recording *bool `json:"recording,omitempty"` - - - // RecordingState - RecordingState *string `json:"recordingState,omitempty"` - - - // Muted - Muted *bool `json:"muted,omitempty"` - - - // Confined - Confined *bool `json:"confined,omitempty"` - - - // Held - Held *bool `json:"held,omitempty"` - - - // ErrorInfo - ErrorInfo *Conversationeventtopicerrordetails `json:"errorInfo,omitempty"` - - - // DisconnectType - DisconnectType *string `json:"disconnectType,omitempty"` - - - // StartHoldTime - StartHoldTime *time.Time `json:"startHoldTime,omitempty"` - - - // Direction - Direction *string `json:"direction,omitempty"` - - - // DocumentId - DocumentId *string `json:"documentId,omitempty"` - - - // Self - Self *Conversationeventtopicaddress `json:"self,omitempty"` - - - // Other - Other *Conversationeventtopicaddress `json:"other,omitempty"` - - - // Provider - Provider *string `json:"provider,omitempty"` - - - // ScriptId - ScriptId *string `json:"scriptId,omitempty"` - - - // PeerId - PeerId *string `json:"peerId,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // DisconnectedTime - DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"` - - - // DisconnectReasons - DisconnectReasons *[]Conversationeventtopicdisconnectreason `json:"disconnectReasons,omitempty"` - - - // FaxStatus - FaxStatus *Conversationeventtopicfaxstatus `json:"faxStatus,omitempty"` - - - // UuiData - UuiData *string `json:"uuiData,omitempty"` - - - // Wrapup - Wrapup *Conversationeventtopicwrapup `json:"wrapup,omitempty"` - - - // AfterCallWork - AfterCallWork *Conversationeventtopicaftercallwork `json:"afterCallWork,omitempty"` - - - // AfterCallWorkRequired - AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"` - - - // AgentAssistantId - AgentAssistantId *string `json:"agentAssistantId,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationeventtopiccall) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationeventtopiccallback.go b/build/platformclientv2/conversationeventtopiccallback.go deleted file mode 100644 index bfb21fec6..000000000 --- a/build/platformclientv2/conversationeventtopiccallback.go +++ /dev/null @@ -1,110 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Conversationeventtopiccallback -type Conversationeventtopiccallback struct { - // State - State *string `json:"state,omitempty"` - - - // Id - Id *string `json:"id,omitempty"` - - - // Direction - Direction *string `json:"direction,omitempty"` - - - // Held - Held *bool `json:"held,omitempty"` - - - // DisconnectType - DisconnectType *string `json:"disconnectType,omitempty"` - - - // StartHoldTime - StartHoldTime *time.Time `json:"startHoldTime,omitempty"` - - - // DialerPreview - DialerPreview *Conversationeventtopicdialerpreview `json:"dialerPreview,omitempty"` - - - // Voicemail - Voicemail *Conversationeventtopicvoicemail `json:"voicemail,omitempty"` - - - // CallbackNumbers - CallbackNumbers *[]string `json:"callbackNumbers,omitempty"` - - - // CallbackUserName - CallbackUserName *string `json:"callbackUserName,omitempty"` - - - // ScriptId - ScriptId *string `json:"scriptId,omitempty"` - - - // PeerId - PeerId *string `json:"peerId,omitempty"` - - - // ExternalCampaign - ExternalCampaign *bool `json:"externalCampaign,omitempty"` - - - // SkipEnabled - SkipEnabled *bool `json:"skipEnabled,omitempty"` - - - // Provider - Provider *string `json:"provider,omitempty"` - - - // TimeoutSeconds - TimeoutSeconds *int `json:"timeoutSeconds,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // DisconnectedTime - DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"` - - - // CallbackScheduledTime - CallbackScheduledTime *time.Time `json:"callbackScheduledTime,omitempty"` - - - // AutomatedCallbackConfigId - AutomatedCallbackConfigId *string `json:"automatedCallbackConfigId,omitempty"` - - - // Wrapup - Wrapup *Conversationeventtopicwrapup `json:"wrapup,omitempty"` - - - // AfterCallWork - AfterCallWork *Conversationeventtopicaftercallwork `json:"afterCallWork,omitempty"` - - - // AfterCallWorkRequired - AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationeventtopiccallback) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationeventtopicchat.go b/build/platformclientv2/conversationeventtopicchat.go deleted file mode 100644 index cc766c3de..000000000 --- a/build/platformclientv2/conversationeventtopicchat.go +++ /dev/null @@ -1,82 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Conversationeventtopicchat -type Conversationeventtopicchat struct { - // State - State *string `json:"state,omitempty"` - - - // Id - Id *string `json:"id,omitempty"` - - - // Provider - Provider *string `json:"provider,omitempty"` - - - // ScriptId - ScriptId *string `json:"scriptId,omitempty"` - - - // PeerId - PeerId *string `json:"peerId,omitempty"` - - - // RoomId - RoomId *string `json:"roomId,omitempty"` - - - // AvatarImageUrl - AvatarImageUrl *string `json:"avatarImageUrl,omitempty"` - - - // Held - Held *bool `json:"held,omitempty"` - - - // DisconnectType - DisconnectType *string `json:"disconnectType,omitempty"` - - - // StartHoldTime - StartHoldTime *time.Time `json:"startHoldTime,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // DisconnectedTime - DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"` - - - // JourneyContext - JourneyContext *Conversationeventtopicjourneycontext `json:"journeyContext,omitempty"` - - - // Wrapup - Wrapup *Conversationeventtopicwrapup `json:"wrapup,omitempty"` - - - // AfterCallWork - AfterCallWork *Conversationeventtopicaftercallwork `json:"afterCallWork,omitempty"` - - - // AfterCallWorkRequired - AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationeventtopicchat) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationeventtopiccobrowse.go b/build/platformclientv2/conversationeventtopiccobrowse.go deleted file mode 100644 index f89c66506..000000000 --- a/build/platformclientv2/conversationeventtopiccobrowse.go +++ /dev/null @@ -1,90 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Conversationeventtopiccobrowse -type Conversationeventtopiccobrowse struct { - // State - State *string `json:"state,omitempty"` - - - // DisconnectType - DisconnectType *string `json:"disconnectType,omitempty"` - - - // Id - Id *string `json:"id,omitempty"` - - - // Self - Self *Conversationeventtopicaddress `json:"self,omitempty"` - - - // RoomId - RoomId *string `json:"roomId,omitempty"` - - - // CobrowseSessionId - CobrowseSessionId *string `json:"cobrowseSessionId,omitempty"` - - - // CobrowseRole - CobrowseRole *string `json:"cobrowseRole,omitempty"` - - - // Controlling - Controlling *[]string `json:"controlling,omitempty"` - - - // ViewerUrl - ViewerUrl *string `json:"viewerUrl,omitempty"` - - - // Provider - Provider *string `json:"provider,omitempty"` - - - // ScriptId - ScriptId *string `json:"scriptId,omitempty"` - - - // PeerId - PeerId *string `json:"peerId,omitempty"` - - - // ProviderEventTime - ProviderEventTime *time.Time `json:"providerEventTime,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // DisconnectedTime - DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"` - - - // Wrapup - Wrapup *Conversationeventtopicwrapup `json:"wrapup,omitempty"` - - - // AfterCallWork - AfterCallWork *Conversationeventtopicaftercallwork `json:"afterCallWork,omitempty"` - - - // AfterCallWorkRequired - AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationeventtopiccobrowse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationeventtopicconversation.go b/build/platformclientv2/conversationeventtopicconversation.go deleted file mode 100644 index 80d534dae..000000000 --- a/build/platformclientv2/conversationeventtopicconversation.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationeventtopicconversation -type Conversationeventtopicconversation struct { - // Id - Id *string `json:"id,omitempty"` - - - // MaxParticipants - MaxParticipants *int `json:"maxParticipants,omitempty"` - - - // Participants - Participants *[]Conversationeventtopicparticipant `json:"participants,omitempty"` - - - // RecordingState - RecordingState *string `json:"recordingState,omitempty"` - - - // Address - Address *string `json:"address,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationeventtopicconversation) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationeventtopicconversationroutingdata.go b/build/platformclientv2/conversationeventtopicconversationroutingdata.go deleted file mode 100644 index 16c84049c..000000000 --- a/build/platformclientv2/conversationeventtopicconversationroutingdata.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationeventtopicconversationroutingdata -type Conversationeventtopicconversationroutingdata struct { - // Queue - Queue *Conversationeventtopicurireference `json:"queue,omitempty"` - - - // Language - Language *Conversationeventtopicurireference `json:"language,omitempty"` - - - // Priority - Priority *int `json:"priority,omitempty"` - - - // Skills - Skills *[]Conversationeventtopicurireference `json:"skills,omitempty"` - - - // ScoredAgents - ScoredAgents *[]Conversationeventtopicscoredagent `json:"scoredAgents,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationeventtopicconversationroutingdata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationeventtopicdialerpreview.go b/build/platformclientv2/conversationeventtopicdialerpreview.go deleted file mode 100644 index 01efa1ef7..000000000 --- a/build/platformclientv2/conversationeventtopicdialerpreview.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationeventtopicdialerpreview -type Conversationeventtopicdialerpreview struct { - // Id - Id *string `json:"id,omitempty"` - - - // ContactId - ContactId *string `json:"contactId,omitempty"` - - - // ContactListId - ContactListId *string `json:"contactListId,omitempty"` - - - // CampaignId - CampaignId *string `json:"campaignId,omitempty"` - - - // PhoneNumberColumns - PhoneNumberColumns *[]Conversationeventtopicphonenumbercolumn `json:"phoneNumberColumns,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationeventtopicdialerpreview) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationeventtopicdisconnectreason.go b/build/platformclientv2/conversationeventtopicdisconnectreason.go deleted file mode 100644 index 54a63fd77..000000000 --- a/build/platformclientv2/conversationeventtopicdisconnectreason.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationeventtopicdisconnectreason -type Conversationeventtopicdisconnectreason struct { - // VarType - VarType *string `json:"type,omitempty"` - - - // Code - Code *int `json:"code,omitempty"` - - - // Phrase - Phrase *string `json:"phrase,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationeventtopicdisconnectreason) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationeventtopicemail.go b/build/platformclientv2/conversationeventtopicemail.go deleted file mode 100644 index d0f681966..000000000 --- a/build/platformclientv2/conversationeventtopicemail.go +++ /dev/null @@ -1,102 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Conversationeventtopicemail -type Conversationeventtopicemail struct { - // Id - Id *string `json:"id,omitempty"` - - - // State - State *string `json:"state,omitempty"` - - - // Held - Held *bool `json:"held,omitempty"` - - - // AutoGenerated - AutoGenerated *bool `json:"autoGenerated,omitempty"` - - - // Subject - Subject *string `json:"subject,omitempty"` - - - // Provider - Provider *string `json:"provider,omitempty"` - - - // ScriptId - ScriptId *string `json:"scriptId,omitempty"` - - - // PeerId - PeerId *string `json:"peerId,omitempty"` - - - // MessagesSent - MessagesSent *int `json:"messagesSent,omitempty"` - - - // ErrorInfo - ErrorInfo *Conversationeventtopicerrordetails `json:"errorInfo,omitempty"` - - - // DisconnectType - DisconnectType *string `json:"disconnectType,omitempty"` - - - // StartHoldTime - StartHoldTime *time.Time `json:"startHoldTime,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // DisconnectedTime - DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"` - - - // MessageId - MessageId *string `json:"messageId,omitempty"` - - - // Direction - Direction *string `json:"direction,omitempty"` - - - // DraftAttachments - DraftAttachments *[]Conversationeventtopicattachment `json:"draftAttachments,omitempty"` - - - // Spam - Spam *bool `json:"spam,omitempty"` - - - // Wrapup - Wrapup *Conversationeventtopicwrapup `json:"wrapup,omitempty"` - - - // AfterCallWork - AfterCallWork *Conversationeventtopicaftercallwork `json:"afterCallWork,omitempty"` - - - // AfterCallWorkRequired - AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationeventtopicemail) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationeventtopicerrordetails.go b/build/platformclientv2/conversationeventtopicerrordetails.go deleted file mode 100644 index f48e30f1d..000000000 --- a/build/platformclientv2/conversationeventtopicerrordetails.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationeventtopicerrordetails -type Conversationeventtopicerrordetails struct { - // Status - Status *int `json:"status,omitempty"` - - - // Code - Code *string `json:"code,omitempty"` - - - // Message - Message *string `json:"message,omitempty"` - - - // MessageWithParams - MessageWithParams *string `json:"messageWithParams,omitempty"` - - - // MessageParams - MessageParams *map[string]string `json:"messageParams,omitempty"` - - - // ContextId - ContextId *string `json:"contextId,omitempty"` - - - // Uri - Uri *string `json:"uri,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationeventtopicerrordetails) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationeventtopicfaxstatus.go b/build/platformclientv2/conversationeventtopicfaxstatus.go deleted file mode 100644 index e5b6d45d7..000000000 --- a/build/platformclientv2/conversationeventtopicfaxstatus.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationeventtopicfaxstatus -type Conversationeventtopicfaxstatus struct { - // Direction - Direction *string `json:"direction,omitempty"` - - - // ExpectedPages - ExpectedPages *int `json:"expectedPages,omitempty"` - - - // ActivePage - ActivePage *int `json:"activePage,omitempty"` - - - // LinesTransmitted - LinesTransmitted *int `json:"linesTransmitted,omitempty"` - - - // BytesTransmitted - BytesTransmitted *int `json:"bytesTransmitted,omitempty"` - - - // BaudRate - BaudRate *int `json:"baudRate,omitempty"` - - - // PageErrors - PageErrors *int `json:"pageErrors,omitempty"` - - - // LineErrors - LineErrors *int `json:"lineErrors,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationeventtopicfaxstatus) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationeventtopicjourneyaction.go b/build/platformclientv2/conversationeventtopicjourneyaction.go deleted file mode 100644 index ae014a20d..000000000 --- a/build/platformclientv2/conversationeventtopicjourneyaction.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationeventtopicjourneyaction -type Conversationeventtopicjourneyaction struct { - // Id - Id *string `json:"id,omitempty"` - - - // ActionMap - ActionMap *Conversationeventtopicjourneyactionmap `json:"actionMap,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationeventtopicjourneyaction) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationeventtopicjourneyactionmap.go b/build/platformclientv2/conversationeventtopicjourneyactionmap.go deleted file mode 100644 index f57dd3d16..000000000 --- a/build/platformclientv2/conversationeventtopicjourneyactionmap.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationeventtopicjourneyactionmap -type Conversationeventtopicjourneyactionmap struct { - // Id - Id *string `json:"id,omitempty"` - - - // Version - Version *int `json:"version,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationeventtopicjourneyactionmap) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationeventtopicjourneycontext.go b/build/platformclientv2/conversationeventtopicjourneycontext.go deleted file mode 100644 index 92fdf989c..000000000 --- a/build/platformclientv2/conversationeventtopicjourneycontext.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationeventtopicjourneycontext -type Conversationeventtopicjourneycontext struct { - // Customer - Customer *Conversationeventtopicjourneycustomer `json:"customer,omitempty"` - - - // CustomerSession - CustomerSession *Conversationeventtopicjourneycustomersession `json:"customerSession,omitempty"` - - - // TriggeringAction - TriggeringAction *Conversationeventtopicjourneyaction `json:"triggeringAction,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationeventtopicjourneycontext) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationeventtopicjourneycustomer.go b/build/platformclientv2/conversationeventtopicjourneycustomer.go deleted file mode 100644 index d57c9f6c6..000000000 --- a/build/platformclientv2/conversationeventtopicjourneycustomer.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationeventtopicjourneycustomer -type Conversationeventtopicjourneycustomer struct { - // Id - Id *string `json:"id,omitempty"` - - - // IdType - IdType *string `json:"idType,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationeventtopicjourneycustomer) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationeventtopicjourneycustomersession.go b/build/platformclientv2/conversationeventtopicjourneycustomersession.go deleted file mode 100644 index d18e87eaa..000000000 --- a/build/platformclientv2/conversationeventtopicjourneycustomersession.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationeventtopicjourneycustomersession -type Conversationeventtopicjourneycustomersession struct { - // Id - Id *string `json:"id,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationeventtopicjourneycustomersession) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationeventtopicmessage.go b/build/platformclientv2/conversationeventtopicmessage.go deleted file mode 100644 index e9ca752d5..000000000 --- a/build/platformclientv2/conversationeventtopicmessage.go +++ /dev/null @@ -1,106 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Conversationeventtopicmessage -type Conversationeventtopicmessage struct { - // Id - Id *string `json:"id,omitempty"` - - - // State - State *string `json:"state,omitempty"` - - - // Held - Held *bool `json:"held,omitempty"` - - - // ErrorInfo - ErrorInfo *Conversationeventtopicerrordetails `json:"errorInfo,omitempty"` - - - // Provider - Provider *string `json:"provider,omitempty"` - - - // ScriptId - ScriptId *string `json:"scriptId,omitempty"` - - - // PeerId - PeerId *string `json:"peerId,omitempty"` - - - // DisconnectType - DisconnectType *string `json:"disconnectType,omitempty"` - - - // StartHoldTime - StartHoldTime *time.Time `json:"startHoldTime,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // DisconnectedTime - DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"` - - - // ToAddress - ToAddress *Conversationeventtopicaddress `json:"toAddress,omitempty"` - - - // FromAddress - FromAddress *Conversationeventtopicaddress `json:"fromAddress,omitempty"` - - - // Messages - Messages *[]Conversationeventtopicmessagedetails `json:"messages,omitempty"` - - - // MessagesTranscriptUri - MessagesTranscriptUri *string `json:"messagesTranscriptUri,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - - - // RecipientCountry - RecipientCountry *string `json:"recipientCountry,omitempty"` - - - // RecipientType - RecipientType *string `json:"recipientType,omitempty"` - - - // JourneyContext - JourneyContext *Conversationeventtopicjourneycontext `json:"journeyContext,omitempty"` - - - // Wrapup - Wrapup *Conversationeventtopicwrapup `json:"wrapup,omitempty"` - - - // AfterCallWork - AfterCallWork *Conversationeventtopicaftercallwork `json:"afterCallWork,omitempty"` - - - // AfterCallWorkRequired - AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationeventtopicmessage) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationeventtopicmessagedetails.go b/build/platformclientv2/conversationeventtopicmessagedetails.go deleted file mode 100644 index 7fd431c13..000000000 --- a/build/platformclientv2/conversationeventtopicmessagedetails.go +++ /dev/null @@ -1,38 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Conversationeventtopicmessagedetails -type Conversationeventtopicmessagedetails struct { - // MessageId - MessageId *string `json:"messageId,omitempty"` - - - // MessageTime - MessageTime *time.Time `json:"messageTime,omitempty"` - - - // MessageStatus - MessageStatus *string `json:"messageStatus,omitempty"` - - - // MessageSegmentCount - MessageSegmentCount *int `json:"messageSegmentCount,omitempty"` - - - // Media - Media *[]Conversationeventtopicmessagemedia `json:"media,omitempty"` - - - // Stickers - Stickers *[]Conversationeventtopicmessagesticker `json:"stickers,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationeventtopicmessagedetails) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationeventtopicmessagemedia.go b/build/platformclientv2/conversationeventtopicmessagemedia.go deleted file mode 100644 index fc14c2492..000000000 --- a/build/platformclientv2/conversationeventtopicmessagemedia.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationeventtopicmessagemedia -type Conversationeventtopicmessagemedia struct { - // Url - Url *string `json:"url,omitempty"` - - - // MediaType - MediaType *string `json:"mediaType,omitempty"` - - - // ContentLengthBytes - ContentLengthBytes *int `json:"contentLengthBytes,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Id - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationeventtopicmessagemedia) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationeventtopicmessagesticker.go b/build/platformclientv2/conversationeventtopicmessagesticker.go deleted file mode 100644 index b0a862ab7..000000000 --- a/build/platformclientv2/conversationeventtopicmessagesticker.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationeventtopicmessagesticker -type Conversationeventtopicmessagesticker struct { - // Url - Url *string `json:"url,omitempty"` - - - // Id - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationeventtopicmessagesticker) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationeventtopicparticipant.go b/build/platformclientv2/conversationeventtopicparticipant.go deleted file mode 100644 index 0e2e49e0b..000000000 --- a/build/platformclientv2/conversationeventtopicparticipant.go +++ /dev/null @@ -1,162 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Conversationeventtopicparticipant -type Conversationeventtopicparticipant struct { - // Id - Id *string `json:"id,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // EndTime - EndTime *time.Time `json:"endTime,omitempty"` - - - // UserId - UserId *string `json:"userId,omitempty"` - - - // ExternalContactId - ExternalContactId *string `json:"externalContactId,omitempty"` - - - // ExternalOrganizationId - ExternalOrganizationId *string `json:"externalOrganizationId,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // QueueId - QueueId *string `json:"queueId,omitempty"` - - - // GroupId - GroupId *string `json:"groupId,omitempty"` - - - // TeamId - TeamId *string `json:"teamId,omitempty"` - - - // Purpose - Purpose *string `json:"purpose,omitempty"` - - - // ConsultParticipantId - ConsultParticipantId *string `json:"consultParticipantId,omitempty"` - - - // Address - Address *string `json:"address,omitempty"` - - - // WrapupRequired - WrapupRequired *bool `json:"wrapupRequired,omitempty"` - - - // WrapupExpected - WrapupExpected *bool `json:"wrapupExpected,omitempty"` - - - // WrapupPrompt - WrapupPrompt *string `json:"wrapupPrompt,omitempty"` - - - // WrapupTimeoutMs - WrapupTimeoutMs *int `json:"wrapupTimeoutMs,omitempty"` - - - // Wrapup - Wrapup *Conversationeventtopicwrapup `json:"wrapup,omitempty"` - - - // StartAcwTime - StartAcwTime *time.Time `json:"startAcwTime,omitempty"` - - - // EndAcwTime - EndAcwTime *time.Time `json:"endAcwTime,omitempty"` - - - // ConversationRoutingData - ConversationRoutingData *Conversationeventtopicconversationroutingdata `json:"conversationRoutingData,omitempty"` - - - // AlertingTimeoutMs - AlertingTimeoutMs *int `json:"alertingTimeoutMs,omitempty"` - - - // MonitoredParticipantId - MonitoredParticipantId *string `json:"monitoredParticipantId,omitempty"` - - - // CoachedParticipantId - CoachedParticipantId *string `json:"coachedParticipantId,omitempty"` - - - // ScreenRecordingState - ScreenRecordingState *string `json:"screenRecordingState,omitempty"` - - - // FlaggedReason - FlaggedReason *string `json:"flaggedReason,omitempty"` - - - // Attributes - Attributes *map[string]string `json:"attributes,omitempty"` - - - // Calls - Calls *[]Conversationeventtopiccall `json:"calls,omitempty"` - - - // Callbacks - Callbacks *[]Conversationeventtopiccallback `json:"callbacks,omitempty"` - - - // Chats - Chats *[]Conversationeventtopicchat `json:"chats,omitempty"` - - - // Cobrowsesessions - Cobrowsesessions *[]Conversationeventtopiccobrowse `json:"cobrowsesessions,omitempty"` - - - // Emails - Emails *[]Conversationeventtopicemail `json:"emails,omitempty"` - - - // Messages - Messages *[]Conversationeventtopicmessage `json:"messages,omitempty"` - - - // Screenshares - Screenshares *[]Conversationeventtopicscreenshare `json:"screenshares,omitempty"` - - - // SocialExpressions - SocialExpressions *[]Conversationeventtopicsocialexpression `json:"socialExpressions,omitempty"` - - - // Videos - Videos *[]Conversationeventtopicvideo `json:"videos,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationeventtopicparticipant) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationeventtopicphonenumbercolumn.go b/build/platformclientv2/conversationeventtopicphonenumbercolumn.go deleted file mode 100644 index ecf1774c0..000000000 --- a/build/platformclientv2/conversationeventtopicphonenumbercolumn.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationeventtopicphonenumbercolumn -type Conversationeventtopicphonenumbercolumn struct { - // ColumnName - ColumnName *string `json:"columnName,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationeventtopicphonenumbercolumn) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationeventtopicscoredagent.go b/build/platformclientv2/conversationeventtopicscoredagent.go deleted file mode 100644 index eabbbe4a5..000000000 --- a/build/platformclientv2/conversationeventtopicscoredagent.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationeventtopicscoredagent -type Conversationeventtopicscoredagent struct { - // Agent - Agent *Conversationeventtopicurireference `json:"agent,omitempty"` - - - // Score - Score *int `json:"score,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationeventtopicscoredagent) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationeventtopicscreenshare.go b/build/platformclientv2/conversationeventtopicscreenshare.go deleted file mode 100644 index c8c4869f9..000000000 --- a/build/platformclientv2/conversationeventtopicscreenshare.go +++ /dev/null @@ -1,74 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Conversationeventtopicscreenshare -type Conversationeventtopicscreenshare struct { - // State - State *string `json:"state,omitempty"` - - - // Self - Self *Conversationeventtopicaddress `json:"self,omitempty"` - - - // Id - Id *string `json:"id,omitempty"` - - - // Context - Context *string `json:"context,omitempty"` - - - // Sharing - Sharing *bool `json:"sharing,omitempty"` - - - // Provider - Provider *string `json:"provider,omitempty"` - - - // ScriptId - ScriptId *string `json:"scriptId,omitempty"` - - - // PeerId - PeerId *string `json:"peerId,omitempty"` - - - // DisconnectType - DisconnectType *string `json:"disconnectType,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // DisconnectedTime - DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"` - - - // Wrapup - Wrapup *Conversationeventtopicwrapup `json:"wrapup,omitempty"` - - - // AfterCallWork - AfterCallWork *Conversationeventtopicaftercallwork `json:"afterCallWork,omitempty"` - - - // AfterCallWorkRequired - AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationeventtopicscreenshare) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationeventtopicsocialexpression.go b/build/platformclientv2/conversationeventtopicsocialexpression.go deleted file mode 100644 index 7344b455a..000000000 --- a/build/platformclientv2/conversationeventtopicsocialexpression.go +++ /dev/null @@ -1,90 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Conversationeventtopicsocialexpression -type Conversationeventtopicsocialexpression struct { - // State - State *string `json:"state,omitempty"` - - - // Id - Id *string `json:"id,omitempty"` - - - // SocialMediaId - SocialMediaId *string `json:"socialMediaId,omitempty"` - - - // SocialMediaHub - SocialMediaHub *string `json:"socialMediaHub,omitempty"` - - - // SocialUserName - SocialUserName *string `json:"socialUserName,omitempty"` - - - // PreviewText - PreviewText *string `json:"previewText,omitempty"` - - - // RecordingId - RecordingId *string `json:"recordingId,omitempty"` - - - // Held - Held *bool `json:"held,omitempty"` - - - // Provider - Provider *string `json:"provider,omitempty"` - - - // ScriptId - ScriptId *string `json:"scriptId,omitempty"` - - - // PeerId - PeerId *string `json:"peerId,omitempty"` - - - // DisconnectType - DisconnectType *string `json:"disconnectType,omitempty"` - - - // StartHoldTime - StartHoldTime *time.Time `json:"startHoldTime,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // DisconnectedTime - DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"` - - - // Wrapup - Wrapup *Conversationeventtopicwrapup `json:"wrapup,omitempty"` - - - // AfterCallWork - AfterCallWork *Conversationeventtopicaftercallwork `json:"afterCallWork,omitempty"` - - - // AfterCallWorkRequired - AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationeventtopicsocialexpression) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationeventtopicurireference.go b/build/platformclientv2/conversationeventtopicurireference.go deleted file mode 100644 index c86f6c5ce..000000000 --- a/build/platformclientv2/conversationeventtopicurireference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationeventtopicurireference -type Conversationeventtopicurireference struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationeventtopicurireference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationeventtopicvideo.go b/build/platformclientv2/conversationeventtopicvideo.go deleted file mode 100644 index 96345e87d..000000000 --- a/build/platformclientv2/conversationeventtopicvideo.go +++ /dev/null @@ -1,86 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Conversationeventtopicvideo -type Conversationeventtopicvideo struct { - // State - State *string `json:"state,omitempty"` - - - // Self - Self *Conversationeventtopicaddress `json:"self,omitempty"` - - - // Id - Id *string `json:"id,omitempty"` - - - // Context - Context *string `json:"context,omitempty"` - - - // AudioMuted - AudioMuted *bool `json:"audioMuted,omitempty"` - - - // VideoMuted - VideoMuted *bool `json:"videoMuted,omitempty"` - - - // SharingScreen - SharingScreen *bool `json:"sharingScreen,omitempty"` - - - // Provider - Provider *string `json:"provider,omitempty"` - - - // ScriptId - ScriptId *string `json:"scriptId,omitempty"` - - - // PeerId - PeerId *string `json:"peerId,omitempty"` - - - // DisconnectType - DisconnectType *string `json:"disconnectType,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // DisconnectedTime - DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"` - - - // Msids - Msids *[]string `json:"msids,omitempty"` - - - // Wrapup - Wrapup *Conversationeventtopicwrapup `json:"wrapup,omitempty"` - - - // AfterCallWork - AfterCallWork *Conversationeventtopicaftercallwork `json:"afterCallWork,omitempty"` - - - // AfterCallWorkRequired - AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationeventtopicvideo) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationeventtopicvoicemail.go b/build/platformclientv2/conversationeventtopicvoicemail.go deleted file mode 100644 index 9f5b10e2e..000000000 --- a/build/platformclientv2/conversationeventtopicvoicemail.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationeventtopicvoicemail -type Conversationeventtopicvoicemail struct { - // Id - Id *string `json:"id,omitempty"` - - - // UploadStatus - UploadStatus *string `json:"uploadStatus,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationeventtopicvoicemail) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationeventtopicwrapup.go b/build/platformclientv2/conversationeventtopicwrapup.go deleted file mode 100644 index b8936c658..000000000 --- a/build/platformclientv2/conversationeventtopicwrapup.go +++ /dev/null @@ -1,38 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Conversationeventtopicwrapup -type Conversationeventtopicwrapup struct { - // Code - Code *string `json:"code,omitempty"` - - - // Notes - Notes *string `json:"notes,omitempty"` - - - // Tags - Tags *[]string `json:"tags,omitempty"` - - - // DurationSeconds - DurationSeconds *int `json:"durationSeconds,omitempty"` - - - // EndTime - EndTime *time.Time `json:"endTime,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationeventtopicwrapup) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationmessageeventtopicconversationroutingdata.go b/build/platformclientv2/conversationmessageeventtopicconversationroutingdata.go deleted file mode 100644 index 90897378c..000000000 --- a/build/platformclientv2/conversationmessageeventtopicconversationroutingdata.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationmessageeventtopicconversationroutingdata -type Conversationmessageeventtopicconversationroutingdata struct { - // Queue - Queue *Conversationmessageeventtopicurireference `json:"queue,omitempty"` - - - // Language - Language *Conversationmessageeventtopicurireference `json:"language,omitempty"` - - - // Priority - Priority *int `json:"priority,omitempty"` - - - // Skills - Skills *[]Conversationmessageeventtopicurireference `json:"skills,omitempty"` - - - // ScoredAgents - ScoredAgents *[]Conversationmessageeventtopicscoredagent `json:"scoredAgents,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationmessageeventtopicconversationroutingdata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationmessageeventtopicdetail.go b/build/platformclientv2/conversationmessageeventtopicdetail.go deleted file mode 100644 index dd89f5e70..000000000 --- a/build/platformclientv2/conversationmessageeventtopicdetail.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationmessageeventtopicdetail -type Conversationmessageeventtopicdetail struct { - // ErrorCode - ErrorCode *string `json:"errorCode,omitempty"` - - - // FieldName - FieldName *string `json:"fieldName,omitempty"` - - - // EntityId - EntityId *string `json:"entityId,omitempty"` - - - // EntityName - EntityName *string `json:"entityName,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationmessageeventtopicdetail) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationmessageeventtopicerrorbody.go b/build/platformclientv2/conversationmessageeventtopicerrorbody.go deleted file mode 100644 index c69a9bb24..000000000 --- a/build/platformclientv2/conversationmessageeventtopicerrorbody.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationmessageeventtopicerrorbody -type Conversationmessageeventtopicerrorbody struct { - // Status - Status *int `json:"status,omitempty"` - - - // Code - Code *string `json:"code,omitempty"` - - - // EntityId - EntityId *string `json:"entityId,omitempty"` - - - // EntityName - EntityName *string `json:"entityName,omitempty"` - - - // Message - Message *string `json:"message,omitempty"` - - - // MessageWithParams - MessageWithParams *string `json:"messageWithParams,omitempty"` - - - // MessageParams - MessageParams *map[string]string `json:"messageParams,omitempty"` - - - // ContextId - ContextId *string `json:"contextId,omitempty"` - - - // Details - Details *[]Conversationmessageeventtopicdetail `json:"details,omitempty"` - - - // Errors - Errors *[]Conversationmessageeventtopicerrorbody `json:"errors,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationmessageeventtopicerrorbody) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationmessageeventtopicjourneyaction.go b/build/platformclientv2/conversationmessageeventtopicjourneyaction.go deleted file mode 100644 index 515001cde..000000000 --- a/build/platformclientv2/conversationmessageeventtopicjourneyaction.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationmessageeventtopicjourneyaction -type Conversationmessageeventtopicjourneyaction struct { - // Id - Id *string `json:"id,omitempty"` - - - // ActionMap - ActionMap *Conversationmessageeventtopicjourneyactionmap `json:"actionMap,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationmessageeventtopicjourneyaction) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationmessageeventtopicjourneyactionmap.go b/build/platformclientv2/conversationmessageeventtopicjourneyactionmap.go deleted file mode 100644 index d6db6b47d..000000000 --- a/build/platformclientv2/conversationmessageeventtopicjourneyactionmap.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationmessageeventtopicjourneyactionmap -type Conversationmessageeventtopicjourneyactionmap struct { - // Id - Id *string `json:"id,omitempty"` - - - // Version - Version *int `json:"version,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationmessageeventtopicjourneyactionmap) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationmessageeventtopicjourneycontext.go b/build/platformclientv2/conversationmessageeventtopicjourneycontext.go deleted file mode 100644 index 56f4872f0..000000000 --- a/build/platformclientv2/conversationmessageeventtopicjourneycontext.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationmessageeventtopicjourneycontext -type Conversationmessageeventtopicjourneycontext struct { - // Customer - Customer *Conversationmessageeventtopicjourneycustomer `json:"customer,omitempty"` - - - // CustomerSession - CustomerSession *Conversationmessageeventtopicjourneycustomersession `json:"customerSession,omitempty"` - - - // TriggeringAction - TriggeringAction *Conversationmessageeventtopicjourneyaction `json:"triggeringAction,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationmessageeventtopicjourneycontext) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationmessageeventtopicjourneycustomer.go b/build/platformclientv2/conversationmessageeventtopicjourneycustomer.go deleted file mode 100644 index 8d30edb8d..000000000 --- a/build/platformclientv2/conversationmessageeventtopicjourneycustomer.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationmessageeventtopicjourneycustomer -type Conversationmessageeventtopicjourneycustomer struct { - // Id - Id *string `json:"id,omitempty"` - - - // IdType - IdType *string `json:"idType,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationmessageeventtopicjourneycustomer) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationmessageeventtopicjourneycustomersession.go b/build/platformclientv2/conversationmessageeventtopicjourneycustomersession.go deleted file mode 100644 index 71ee97f85..000000000 --- a/build/platformclientv2/conversationmessageeventtopicjourneycustomersession.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationmessageeventtopicjourneycustomersession -type Conversationmessageeventtopicjourneycustomersession struct { - // Id - Id *string `json:"id,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationmessageeventtopicjourneycustomersession) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationmessageeventtopicmessageconversation.go b/build/platformclientv2/conversationmessageeventtopicmessageconversation.go deleted file mode 100644 index 557d3576d..000000000 --- a/build/platformclientv2/conversationmessageeventtopicmessageconversation.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationmessageeventtopicmessageconversation -type Conversationmessageeventtopicmessageconversation struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Participants - Participants *[]Conversationmessageeventtopicmessagemediaparticipant `json:"participants,omitempty"` - - - // OtherMediaUris - OtherMediaUris *[]string `json:"otherMediaUris,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationmessageeventtopicmessageconversation) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationmessageeventtopicmessagedetails.go b/build/platformclientv2/conversationmessageeventtopicmessagedetails.go deleted file mode 100644 index 4b5914193..000000000 --- a/build/platformclientv2/conversationmessageeventtopicmessagedetails.go +++ /dev/null @@ -1,38 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Conversationmessageeventtopicmessagedetails -type Conversationmessageeventtopicmessagedetails struct { - // Message - Message *Conversationmessageeventtopicurireference `json:"message,omitempty"` - - - // MessageTime - MessageTime *time.Time `json:"messageTime,omitempty"` - - - // MessageSegmentCount - MessageSegmentCount *int `json:"messageSegmentCount,omitempty"` - - - // MessageStatus - MessageStatus *string `json:"messageStatus,omitempty"` - - - // Media - Media *[]Conversationmessageeventtopicmessagemedia `json:"media,omitempty"` - - - // Stickers - Stickers *[]Conversationmessageeventtopicmessagesticker `json:"stickers,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationmessageeventtopicmessagedetails) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationmessageeventtopicmessagemedia.go b/build/platformclientv2/conversationmessageeventtopicmessagemedia.go deleted file mode 100644 index 04d92ad8c..000000000 --- a/build/platformclientv2/conversationmessageeventtopicmessagemedia.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationmessageeventtopicmessagemedia -type Conversationmessageeventtopicmessagemedia struct { - // Url - Url *string `json:"url,omitempty"` - - - // MediaType - MediaType *string `json:"mediaType,omitempty"` - - - // ContentLengthBytes - ContentLengthBytes *int `json:"contentLengthBytes,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Id - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationmessageeventtopicmessagemedia) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationmessageeventtopicmessagemediaparticipant.go b/build/platformclientv2/conversationmessageeventtopicmessagemediaparticipant.go deleted file mode 100644 index 9c03b7be1..000000000 --- a/build/platformclientv2/conversationmessageeventtopicmessagemediaparticipant.go +++ /dev/null @@ -1,166 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Conversationmessageeventtopicmessagemediaparticipant -type Conversationmessageeventtopicmessagemediaparticipant struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Address - Address *string `json:"address,omitempty"` - - - // StartTime - StartTime *time.Time `json:"startTime,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // EndTime - EndTime *time.Time `json:"endTime,omitempty"` - - - // StartHoldTime - StartHoldTime *time.Time `json:"startHoldTime,omitempty"` - - - // Purpose - Purpose *string `json:"purpose,omitempty"` - - - // State - State *string `json:"state,omitempty"` - - - // Direction - Direction *string `json:"direction,omitempty"` - - - // DisconnectType - DisconnectType *string `json:"disconnectType,omitempty"` - - - // Held - Held *bool `json:"held,omitempty"` - - - // WrapupRequired - WrapupRequired *bool `json:"wrapupRequired,omitempty"` - - - // WrapupPrompt - WrapupPrompt *string `json:"wrapupPrompt,omitempty"` - - - // User - User *Conversationmessageeventtopicurireference `json:"user,omitempty"` - - - // Queue - Queue *Conversationmessageeventtopicurireference `json:"queue,omitempty"` - - - // Team - Team *Conversationmessageeventtopicurireference `json:"team,omitempty"` - - - // Attributes - Attributes *map[string]string `json:"attributes,omitempty"` - - - // ErrorInfo - ErrorInfo *Conversationmessageeventtopicerrorbody `json:"errorInfo,omitempty"` - - - // Script - Script *Conversationmessageeventtopicurireference `json:"script,omitempty"` - - - // WrapupTimeoutMs - WrapupTimeoutMs *int `json:"wrapupTimeoutMs,omitempty"` - - - // WrapupSkipped - WrapupSkipped *bool `json:"wrapupSkipped,omitempty"` - - - // AlertingTimeoutMs - AlertingTimeoutMs *int `json:"alertingTimeoutMs,omitempty"` - - - // Provider - Provider *string `json:"provider,omitempty"` - - - // ExternalContact - ExternalContact *Conversationmessageeventtopicurireference `json:"externalContact,omitempty"` - - - // ExternalOrganization - ExternalOrganization *Conversationmessageeventtopicurireference `json:"externalOrganization,omitempty"` - - - // Wrapup - Wrapup *Conversationmessageeventtopicwrapup `json:"wrapup,omitempty"` - - - // ConversationRoutingData - ConversationRoutingData *Conversationmessageeventtopicconversationroutingdata `json:"conversationRoutingData,omitempty"` - - - // Peer - Peer *string `json:"peer,omitempty"` - - - // ScreenRecordingState - ScreenRecordingState *string `json:"screenRecordingState,omitempty"` - - - // FlaggedReason - FlaggedReason *string `json:"flaggedReason,omitempty"` - - - // JourneyContext - JourneyContext *Conversationmessageeventtopicjourneycontext `json:"journeyContext,omitempty"` - - - // StartAcwTime - StartAcwTime *time.Time `json:"startAcwTime,omitempty"` - - - // EndAcwTime - EndAcwTime *time.Time `json:"endAcwTime,omitempty"` - - - // Messages - Messages *[]Conversationmessageeventtopicmessagedetails `json:"messages,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - - - // RecipientCountry - RecipientCountry *string `json:"recipientCountry,omitempty"` - - - // RecipientType - RecipientType *string `json:"recipientType,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationmessageeventtopicmessagemediaparticipant) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationmessageeventtopicmessagesticker.go b/build/platformclientv2/conversationmessageeventtopicmessagesticker.go deleted file mode 100644 index aae29e682..000000000 --- a/build/platformclientv2/conversationmessageeventtopicmessagesticker.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationmessageeventtopicmessagesticker -type Conversationmessageeventtopicmessagesticker struct { - // Url - Url *string `json:"url,omitempty"` - - - // Id - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationmessageeventtopicmessagesticker) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationmessageeventtopicscoredagent.go b/build/platformclientv2/conversationmessageeventtopicscoredagent.go deleted file mode 100644 index 29ee03543..000000000 --- a/build/platformclientv2/conversationmessageeventtopicscoredagent.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationmessageeventtopicscoredagent -type Conversationmessageeventtopicscoredagent struct { - // Agent - Agent *Conversationmessageeventtopicurireference `json:"agent,omitempty"` - - - // Score - Score *int `json:"score,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationmessageeventtopicscoredagent) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationmessageeventtopicurireference.go b/build/platformclientv2/conversationmessageeventtopicurireference.go deleted file mode 100644 index 013fcc108..000000000 --- a/build/platformclientv2/conversationmessageeventtopicurireference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationmessageeventtopicurireference -type Conversationmessageeventtopicurireference struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationmessageeventtopicurireference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationmessageeventtopicwrapup.go b/build/platformclientv2/conversationmessageeventtopicwrapup.go deleted file mode 100644 index 1339ae328..000000000 --- a/build/platformclientv2/conversationmessageeventtopicwrapup.go +++ /dev/null @@ -1,38 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Conversationmessageeventtopicwrapup -type Conversationmessageeventtopicwrapup struct { - // Code - Code *string `json:"code,omitempty"` - - - // Notes - Notes *string `json:"notes,omitempty"` - - - // Tags - Tags *[]string `json:"tags,omitempty"` - - - // DurationSeconds - DurationSeconds *int `json:"durationSeconds,omitempty"` - - - // EndTime - EndTime *time.Time `json:"endTime,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationmessageeventtopicwrapup) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationmetrics.go b/build/platformclientv2/conversationmetrics.go deleted file mode 100644 index aff27af5c..000000000 --- a/build/platformclientv2/conversationmetrics.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationmetrics -type Conversationmetrics struct { - // Conversation - The Conversation Reference - Conversation *Addressableentityref `json:"conversation,omitempty"` - - - // SentimentScore - The Sentiment Score - SentimentScore *float64 `json:"sentimentScore,omitempty"` - - - // SentimentTrend - The Sentiment Trend - SentimentTrend *float64 `json:"sentimentTrend,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationmetrics) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationproperties.go b/build/platformclientv2/conversationproperties.go deleted file mode 100644 index 431296cf9..000000000 --- a/build/platformclientv2/conversationproperties.go +++ /dev/null @@ -1,57 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationproperties -type Conversationproperties struct { - // IsWaiting - Indicates filtering for waiting - IsWaiting *bool `json:"isWaiting,omitempty"` - - - // IsActive - Indicates filtering for active - IsActive *bool `json:"isActive,omitempty"` - - - // IsAcd - Indicates filtering for Acd - IsAcd *bool `json:"isAcd,omitempty"` - - - // IsPreferred - Indicates filtering for Preferred Agent Routing - IsPreferred *bool `json:"isPreferred,omitempty"` - - - // IsScreenshare - Indicates filtering for screenshare - IsScreenshare *bool `json:"isScreenshare,omitempty"` - - - // IsCobrowse - Indicates filtering for Cobrowse - IsCobrowse *bool `json:"isCobrowse,omitempty"` - - - // IsVoicemail - Indicates filtering for Voice mail - IsVoicemail *bool `json:"isVoicemail,omitempty"` - - - // IsFlagged - Indicates filtering for flagged - IsFlagged *bool `json:"isFlagged,omitempty"` - - - // IsMonitored - Indicates filtering for monitored - IsMonitored *bool `json:"isMonitored,omitempty"` - - - // FilterWrapUpNotes - Indicates filtering for WrapUpNotes - FilterWrapUpNotes *bool `json:"filterWrapUpNotes,omitempty"` - - - // MatchAll - Indicates comparison operation, TRUE indicates filters will use AND logic, FALSE indicates OR logic - MatchAll *bool `json:"matchAll,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationproperties) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationquery.go b/build/platformclientv2/conversationquery.go deleted file mode 100644 index 7d91db808..000000000 --- a/build/platformclientv2/conversationquery.go +++ /dev/null @@ -1,57 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationquery -type Conversationquery struct { - // ConversationFilters - Filters that target conversation-level data - ConversationFilters *[]Conversationdetailqueryfilter `json:"conversationFilters,omitempty"` - - - // SegmentFilters - Filters that target individual segments within a conversation - SegmentFilters *[]Segmentdetailqueryfilter `json:"segmentFilters,omitempty"` - - - // EvaluationFilters - Filters that target evaluations - EvaluationFilters *[]Evaluationdetailqueryfilter `json:"evaluationFilters,omitempty"` - - - // MediaEndpointStatFilters - Filters that target mediaEndpointStats - MediaEndpointStatFilters *[]Mediaendpointstatdetailqueryfilter `json:"mediaEndpointStatFilters,omitempty"` - - - // SurveyFilters - Filters that target surveys - SurveyFilters *[]Surveydetailqueryfilter `json:"surveyFilters,omitempty"` - - - // ResolutionFilters - Filters that target resolutions - ResolutionFilters *[]Resolutiondetailqueryfilter `json:"resolutionFilters,omitempty"` - - - // Order - Sort the result set in ascending/descending order. Default is ascending - Order *string `json:"order,omitempty"` - - - // OrderBy - Specify which data element within the result set to use for sorting. The options to use as a basis for sorting the results: conversationStart, segmentStart, and segmentEnd. If not specified, the default is conversationStart - OrderBy *string `json:"orderBy,omitempty"` - - - // Interval - Specifies the date and time range of data being queried. Results will only include conversations that started on a day touched by the interval. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss - Interval *string `json:"interval,omitempty"` - - - // Aggregations - Include faceted search and aggregate roll-ups describing your search results. This does not function as a filter, but rather, summary data about the data matching your filters - Aggregations *[]Analyticsqueryaggregation `json:"aggregations,omitempty"` - - - // Paging - Page size and number to control iterating through large result sets. Default page size is 25 - Paging *Pagingspec `json:"paging,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationquery) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationreference.go b/build/platformclientv2/conversationreference.go deleted file mode 100644 index 4b9c274e7..000000000 --- a/build/platformclientv2/conversationreference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationreference -type Conversationreference struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationreference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationroutingdata.go b/build/platformclientv2/conversationroutingdata.go deleted file mode 100644 index 35534371d..000000000 --- a/build/platformclientv2/conversationroutingdata.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationroutingdata -type Conversationroutingdata struct { - // Queue - The queue to use for routing decisions - Queue *Addressableentityref `json:"queue,omitempty"` - - - // Language - The language to use for routing decisions - Language *Addressableentityref `json:"language,omitempty"` - - - // Priority - The priority of the conversation to use for routing decisions - Priority *int `json:"priority,omitempty"` - - - // Skills - The skills to use for routing decisions - Skills *[]Addressableentityref `json:"skills,omitempty"` - - - // ScoredAgents - A collection of agents and their assigned scores for this conversation (0 - 100, higher being better), for use in routing to preferred agents - ScoredAgents *[]Scoredagent `json:"scoredAgents,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationroutingdata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationsapi.go b/build/platformclientv2/conversationsapi.go deleted file mode 100644 index 3ca6b688c..000000000 --- a/build/platformclientv2/conversationsapi.go +++ /dev/null @@ -1,10673 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "encoding/json" -) - -// ConversationsApi provides functions for API endpoints -type ConversationsApi struct { - Configuration *Configuration -} - -// NewConversationsApi creates an API instance using the default configuration -func NewConversationsApi() *ConversationsApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating ConversationsApi with base path: %s", strings.ToLower(config.BasePath))) - return &ConversationsApi{ - Configuration: config, - } -} - -// NewConversationsApiWithConfig creates an API instance using the provided configuration -func NewConversationsApiWithConfig(config *Configuration) *ConversationsApi { - config.Debugf("Creating ConversationsApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &ConversationsApi{ - Configuration: config, - } -} - -// DeleteAnalyticsConversationsDetailsJob invokes DELETE /api/v2/analytics/conversations/details/jobs/{jobId} -// -// Delete/cancel an async request -// -// -func (a ConversationsApi) DeleteAnalyticsConversationsDetailsJob(jobId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/conversations/details/jobs/{jobId}" - path = strings.Replace(path, "{jobId}", fmt.Sprintf("%v", jobId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'jobId' is set - if &jobId == nil { - // - return nil, errors.New("Missing required parameter 'jobId' when calling ConversationsApi->DeleteAnalyticsConversationsDetailsJob") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteConversationParticipantCode invokes DELETE /api/v2/conversations/{conversationId}/participants/{participantId}/codes/{addCommunicationCode} -// -// Delete a code used to add a communication to this participant -// -// -func (a ConversationsApi) DeleteConversationParticipantCode(conversationId string, participantId string, addCommunicationCode string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/{conversationId}/participants/{participantId}/codes/{addCommunicationCode}" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - path = strings.Replace(path, "{addCommunicationCode}", fmt.Sprintf("%v", addCommunicationCode), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->DeleteConversationParticipantCode") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->DeleteConversationParticipantCode") - } - // verify the required parameter 'addCommunicationCode' is set - if &addCommunicationCode == nil { - // - return nil, errors.New("Missing required parameter 'addCommunicationCode' when calling ConversationsApi->DeleteConversationParticipantCode") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteConversationParticipantFlaggedreason invokes DELETE /api/v2/conversations/{conversationId}/participants/{participantId}/flaggedreason -// -// Remove flagged reason from conversation participant. -// -// -func (a ConversationsApi) DeleteConversationParticipantFlaggedreason(conversationId string, participantId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/{conversationId}/participants/{participantId}/flaggedreason" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->DeleteConversationParticipantFlaggedreason") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->DeleteConversationParticipantFlaggedreason") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteConversationsCallParticipantConsult invokes DELETE /api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult -// -// Cancel the transfer -// -// -func (a ConversationsApi) DeleteConversationsCallParticipantConsult(conversationId string, participantId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->DeleteConversationsCallParticipantConsult") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->DeleteConversationsCallParticipantConsult") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteConversationsEmailMessagesDraftAttachment invokes DELETE /api/v2/conversations/emails/{conversationId}/messages/draft/attachments/{attachmentId} -// -// Delete attachment from draft -// -// -func (a ConversationsApi) DeleteConversationsEmailMessagesDraftAttachment(conversationId string, attachmentId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/emails/{conversationId}/messages/draft/attachments/{attachmentId}" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{attachmentId}", fmt.Sprintf("%v", attachmentId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->DeleteConversationsEmailMessagesDraftAttachment") - } - // verify the required parameter 'attachmentId' is set - if &attachmentId == nil { - // - return nil, errors.New("Missing required parameter 'attachmentId' when calling ConversationsApi->DeleteConversationsEmailMessagesDraftAttachment") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteConversationsMessagingIntegrationsFacebookIntegrationId invokes DELETE /api/v2/conversations/messaging/integrations/facebook/{integrationId} -// -// Delete a Facebook messaging integration -// -// -func (a ConversationsApi) DeleteConversationsMessagingIntegrationsFacebookIntegrationId(integrationId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/messaging/integrations/facebook/{integrationId}" - path = strings.Replace(path, "{integrationId}", fmt.Sprintf("%v", integrationId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'integrationId' is set - if &integrationId == nil { - // - return nil, errors.New("Missing required parameter 'integrationId' when calling ConversationsApi->DeleteConversationsMessagingIntegrationsFacebookIntegrationId") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteConversationsMessagingIntegrationsLineIntegrationId invokes DELETE /api/v2/conversations/messaging/integrations/line/{integrationId} -// -// Delete a LINE messenger integration -// -// -func (a ConversationsApi) DeleteConversationsMessagingIntegrationsLineIntegrationId(integrationId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/messaging/integrations/line/{integrationId}" - path = strings.Replace(path, "{integrationId}", fmt.Sprintf("%v", integrationId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'integrationId' is set - if &integrationId == nil { - // - return nil, errors.New("Missing required parameter 'integrationId' when calling ConversationsApi->DeleteConversationsMessagingIntegrationsLineIntegrationId") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteConversationsMessagingIntegrationsTwitterIntegrationId invokes DELETE /api/v2/conversations/messaging/integrations/twitter/{integrationId} -// -// Delete a Twitter messaging integration -// -// -func (a ConversationsApi) DeleteConversationsMessagingIntegrationsTwitterIntegrationId(integrationId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/messaging/integrations/twitter/{integrationId}" - path = strings.Replace(path, "{integrationId}", fmt.Sprintf("%v", integrationId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'integrationId' is set - if &integrationId == nil { - // - return nil, errors.New("Missing required parameter 'integrationId' when calling ConversationsApi->DeleteConversationsMessagingIntegrationsTwitterIntegrationId") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteConversationsMessagingIntegrationsWhatsappIntegrationId invokes DELETE /api/v2/conversations/messaging/integrations/whatsapp/{integrationId} -// -// Delete a WhatsApp messaging integration -// -// -func (a ConversationsApi) DeleteConversationsMessagingIntegrationsWhatsappIntegrationId(integrationId string) (*Whatsappintegration, *APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/messaging/integrations/whatsapp/{integrationId}" - path = strings.Replace(path, "{integrationId}", fmt.Sprintf("%v", integrationId), -1) - defaultReturn := new(Whatsappintegration) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'integrationId' is set - if &integrationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'integrationId' when calling ConversationsApi->DeleteConversationsMessagingIntegrationsWhatsappIntegrationId") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Whatsappintegration - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAnalyticsConversationDetails invokes GET /api/v2/analytics/conversations/{conversationId}/details -// -// Get a conversation by id -// -// -func (a ConversationsApi) GetAnalyticsConversationDetails(conversationId string) (*Analyticsconversationwithoutattributes, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/conversations/{conversationId}/details" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - defaultReturn := new(Analyticsconversationwithoutattributes) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->GetAnalyticsConversationDetails") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Analyticsconversationwithoutattributes - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAnalyticsConversationsDetails invokes GET /api/v2/analytics/conversations/details -// -// Gets multiple conversations by id -// -// -func (a ConversationsApi) GetAnalyticsConversationsDetails(id []string) (*Analyticsconversationwithoutattributesmultigetresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/conversations/details" - defaultReturn := new(Analyticsconversationwithoutattributesmultigetresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range id { - queryParams["id"] = value - } - } else { - queryParams["id"] = a.Configuration.APIClient.ParameterToString(id, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Analyticsconversationwithoutattributesmultigetresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAnalyticsConversationsDetailsJob invokes GET /api/v2/analytics/conversations/details/jobs/{jobId} -// -// Get status for async query for conversation details -// -// -func (a ConversationsApi) GetAnalyticsConversationsDetailsJob(jobId string) (*Asyncquerystatus, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/conversations/details/jobs/{jobId}" - path = strings.Replace(path, "{jobId}", fmt.Sprintf("%v", jobId), -1) - defaultReturn := new(Asyncquerystatus) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'jobId' is set - if &jobId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'jobId' when calling ConversationsApi->GetAnalyticsConversationsDetailsJob") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Asyncquerystatus - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAnalyticsConversationsDetailsJobResults invokes GET /api/v2/analytics/conversations/details/jobs/{jobId}/results -// -// Fetch a page of results for an async query -// -// -func (a ConversationsApi) GetAnalyticsConversationsDetailsJobResults(jobId string, cursor string, pageSize int) (*Analyticsconversationasyncqueryresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/conversations/details/jobs/{jobId}/results" - path = strings.Replace(path, "{jobId}", fmt.Sprintf("%v", jobId), -1) - defaultReturn := new(Analyticsconversationasyncqueryresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'jobId' is set - if &jobId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'jobId' when calling ConversationsApi->GetAnalyticsConversationsDetailsJobResults") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(cursor).(string); ok { - if str != "" { - queryParams["cursor"] = a.Configuration.APIClient.ParameterToString(cursor, collectionFormat) - } - } else { - queryParams["cursor"] = a.Configuration.APIClient.ParameterToString(cursor, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Analyticsconversationasyncqueryresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAnalyticsConversationsDetailsJobsAvailability invokes GET /api/v2/analytics/conversations/details/jobs/availability -// -// Lookup the datalake availability date and time -// -// -func (a ConversationsApi) GetAnalyticsConversationsDetailsJobsAvailability() (*Dataavailabilityresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/conversations/details/jobs/availability" - defaultReturn := new(Dataavailabilityresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Dataavailabilityresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversation invokes GET /api/v2/conversations/{conversationId} -// -// Get conversation -// -// -func (a ConversationsApi) GetConversation(conversationId string) (*Conversation, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/{conversationId}" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - defaultReturn := new(Conversation) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->GetConversation") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Conversation - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversationParticipantSecureivrsession invokes GET /api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions/{secureSessionId} -// -// Fetch info on a secure session -// -// -func (a ConversationsApi) GetConversationParticipantSecureivrsession(conversationId string, participantId string, secureSessionId string) (*Securesession, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions/{secureSessionId}" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - path = strings.Replace(path, "{secureSessionId}", fmt.Sprintf("%v", secureSessionId), -1) - defaultReturn := new(Securesession) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->GetConversationParticipantSecureivrsession") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->GetConversationParticipantSecureivrsession") - } - // verify the required parameter 'secureSessionId' is set - if &secureSessionId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'secureSessionId' when calling ConversationsApi->GetConversationParticipantSecureivrsession") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Securesession - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversationParticipantSecureivrsessions invokes GET /api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions -// -// Get a list of secure sessions for this participant. -// -// -func (a ConversationsApi) GetConversationParticipantSecureivrsessions(conversationId string, participantId string) (*Securesessionentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - defaultReturn := new(Securesessionentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->GetConversationParticipantSecureivrsessions") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->GetConversationParticipantSecureivrsessions") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Securesessionentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversationParticipantWrapup invokes GET /api/v2/conversations/{conversationId}/participants/{participantId}/wrapup -// -// Get the wrap-up for this conversation participant. -// -// -func (a ConversationsApi) GetConversationParticipantWrapup(conversationId string, participantId string, provisional bool) (*Assignedwrapupcode, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/{conversationId}/participants/{participantId}/wrapup" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - defaultReturn := new(Assignedwrapupcode) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->GetConversationParticipantWrapup") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->GetConversationParticipantWrapup") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(provisional).(string); ok { - if str != "" { - queryParams["provisional"] = a.Configuration.APIClient.ParameterToString(provisional, collectionFormat) - } - } else { - queryParams["provisional"] = a.Configuration.APIClient.ParameterToString(provisional, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Assignedwrapupcode - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversationParticipantWrapupcodes invokes GET /api/v2/conversations/{conversationId}/participants/{participantId}/wrapupcodes -// -// Get list of wrapup codes for this conversation participant -// -// -func (a ConversationsApi) GetConversationParticipantWrapupcodes(conversationId string, participantId string) ([]Wrapupcode, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/{conversationId}/participants/{participantId}/wrapupcodes" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - defaultReturn := make([]Wrapupcode, 0) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->GetConversationParticipantWrapupcodes") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->GetConversationParticipantWrapupcodes") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload []Wrapupcode - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversations invokes GET /api/v2/conversations -// -// Get active conversations for the logged in user -// -// -func (a ConversationsApi) GetConversations(communicationType string) (*Conversationentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations" - defaultReturn := new(Conversationentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(communicationType).(string); ok { - if str != "" { - queryParams["communicationType"] = a.Configuration.APIClient.ParameterToString(communicationType, collectionFormat) - } - } else { - queryParams["communicationType"] = a.Configuration.APIClient.ParameterToString(communicationType, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Conversationentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversationsCall invokes GET /api/v2/conversations/calls/{conversationId} -// -// Get call conversation -// -// -func (a ConversationsApi) GetConversationsCall(conversationId string) (*Callconversation, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/calls/{conversationId}" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - defaultReturn := new(Callconversation) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->GetConversationsCall") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Callconversation - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversationsCallParticipantWrapup invokes GET /api/v2/conversations/calls/{conversationId}/participants/{participantId}/wrapup -// -// Get the wrap-up for this conversation participant. -// -// -func (a ConversationsApi) GetConversationsCallParticipantWrapup(conversationId string, participantId string, provisional bool) (*Assignedwrapupcode, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/calls/{conversationId}/participants/{participantId}/wrapup" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - defaultReturn := new(Assignedwrapupcode) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->GetConversationsCallParticipantWrapup") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->GetConversationsCallParticipantWrapup") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(provisional).(string); ok { - if str != "" { - queryParams["provisional"] = a.Configuration.APIClient.ParameterToString(provisional, collectionFormat) - } - } else { - queryParams["provisional"] = a.Configuration.APIClient.ParameterToString(provisional, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Assignedwrapupcode - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversationsCallParticipantWrapupcodes invokes GET /api/v2/conversations/calls/{conversationId}/participants/{participantId}/wrapupcodes -// -// Get list of wrapup codes for this conversation participant -// -// -func (a ConversationsApi) GetConversationsCallParticipantWrapupcodes(conversationId string, participantId string) ([]Wrapupcode, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/calls/{conversationId}/participants/{participantId}/wrapupcodes" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - defaultReturn := make([]Wrapupcode, 0) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->GetConversationsCallParticipantWrapupcodes") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->GetConversationsCallParticipantWrapupcodes") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload []Wrapupcode - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversationsCallback invokes GET /api/v2/conversations/callbacks/{conversationId} -// -// Get callback conversation -// -// -func (a ConversationsApi) GetConversationsCallback(conversationId string) (*Callbackconversation, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/callbacks/{conversationId}" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - defaultReturn := new(Callbackconversation) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->GetConversationsCallback") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Callbackconversation - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversationsCallbackParticipantWrapup invokes GET /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/wrapup -// -// Get the wrap-up for this conversation participant. -// -// -func (a ConversationsApi) GetConversationsCallbackParticipantWrapup(conversationId string, participantId string, provisional bool) (*Assignedwrapupcode, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/wrapup" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - defaultReturn := new(Assignedwrapupcode) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->GetConversationsCallbackParticipantWrapup") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->GetConversationsCallbackParticipantWrapup") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(provisional).(string); ok { - if str != "" { - queryParams["provisional"] = a.Configuration.APIClient.ParameterToString(provisional, collectionFormat) - } - } else { - queryParams["provisional"] = a.Configuration.APIClient.ParameterToString(provisional, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Assignedwrapupcode - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversationsCallbackParticipantWrapupcodes invokes GET /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/wrapupcodes -// -// Get list of wrapup codes for this conversation participant -// -// -func (a ConversationsApi) GetConversationsCallbackParticipantWrapupcodes(conversationId string, participantId string) ([]Wrapupcode, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/wrapupcodes" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - defaultReturn := make([]Wrapupcode, 0) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->GetConversationsCallbackParticipantWrapupcodes") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->GetConversationsCallbackParticipantWrapupcodes") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload []Wrapupcode - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversationsCallbacks invokes GET /api/v2/conversations/callbacks -// -// Get active callback conversations for the logged in user -// -// -func (a ConversationsApi) GetConversationsCallbacks() (*Callbackconversationentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/callbacks" - defaultReturn := new(Callbackconversationentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Callbackconversationentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversationsCalls invokes GET /api/v2/conversations/calls -// -// Get active call conversations for the logged in user -// -// -func (a ConversationsApi) GetConversationsCalls() (*Callconversationentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/calls" - defaultReturn := new(Callconversationentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Callconversationentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversationsCallsHistory invokes GET /api/v2/conversations/calls/history -// -// Get call history -// -// -func (a ConversationsApi) GetConversationsCallsHistory(pageSize int, pageNumber int, interval string, expand []string) (*Callhistoryconversationentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/calls/history" - defaultReturn := new(Callhistoryconversationentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(interval).(string); ok { - if str != "" { - queryParams["interval"] = a.Configuration.APIClient.ParameterToString(interval, collectionFormat) - } - } else { - queryParams["interval"] = a.Configuration.APIClient.ParameterToString(interval, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Callhistoryconversationentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversationsCallsMaximumconferenceparties invokes GET /api/v2/conversations/calls/maximumconferenceparties -// -// Get the maximum number of participants that this user can have on a conference -// -// -func (a ConversationsApi) GetConversationsCallsMaximumconferenceparties() (*Maxparticipants, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/calls/maximumconferenceparties" - defaultReturn := new(Maxparticipants) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Maxparticipants - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversationsChat invokes GET /api/v2/conversations/chats/{conversationId} -// -// Get chat conversation -// -// -func (a ConversationsApi) GetConversationsChat(conversationId string) (*Chatconversation, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/chats/{conversationId}" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - defaultReturn := new(Chatconversation) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->GetConversationsChat") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Chatconversation - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversationsChatMessage invokes GET /api/v2/conversations/chats/{conversationId}/messages/{messageId} -// -// Get a web chat conversation message -// -// The current user must be involved with the conversation to get its messages. -func (a ConversationsApi) GetConversationsChatMessage(conversationId string, messageId string) (*Webchatmessage, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/chats/{conversationId}/messages/{messageId}" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{messageId}", fmt.Sprintf("%v", messageId), -1) - defaultReturn := new(Webchatmessage) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->GetConversationsChatMessage") - } - // verify the required parameter 'messageId' is set - if &messageId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'messageId' when calling ConversationsApi->GetConversationsChatMessage") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Webchatmessage - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversationsChatMessages invokes GET /api/v2/conversations/chats/{conversationId}/messages -// -// Get the messages of a chat conversation. -// -// The current user must be involved with the conversation to get its messages. -func (a ConversationsApi) GetConversationsChatMessages(conversationId string, after string, before string, sortOrder string, maxResults int) (*Webchatmessageentitylist, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/chats/{conversationId}/messages" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - defaultReturn := new(Webchatmessageentitylist) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->GetConversationsChatMessages") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(after).(string); ok { - if str != "" { - queryParams["after"] = a.Configuration.APIClient.ParameterToString(after, collectionFormat) - } - } else { - queryParams["after"] = a.Configuration.APIClient.ParameterToString(after, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(before).(string); ok { - if str != "" { - queryParams["before"] = a.Configuration.APIClient.ParameterToString(before, collectionFormat) - } - } else { - queryParams["before"] = a.Configuration.APIClient.ParameterToString(before, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(maxResults).(string); ok { - if str != "" { - queryParams["maxResults"] = a.Configuration.APIClient.ParameterToString(maxResults, collectionFormat) - } - } else { - queryParams["maxResults"] = a.Configuration.APIClient.ParameterToString(maxResults, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Webchatmessageentitylist - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversationsChatParticipantWrapup invokes GET /api/v2/conversations/chats/{conversationId}/participants/{participantId}/wrapup -// -// Get the wrap-up for this conversation participant. -// -// -func (a ConversationsApi) GetConversationsChatParticipantWrapup(conversationId string, participantId string, provisional bool) (*Assignedwrapupcode, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/chats/{conversationId}/participants/{participantId}/wrapup" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - defaultReturn := new(Assignedwrapupcode) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->GetConversationsChatParticipantWrapup") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->GetConversationsChatParticipantWrapup") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(provisional).(string); ok { - if str != "" { - queryParams["provisional"] = a.Configuration.APIClient.ParameterToString(provisional, collectionFormat) - } - } else { - queryParams["provisional"] = a.Configuration.APIClient.ParameterToString(provisional, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Assignedwrapupcode - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversationsChatParticipantWrapupcodes invokes GET /api/v2/conversations/chats/{conversationId}/participants/{participantId}/wrapupcodes -// -// Get list of wrapup codes for this conversation participant -// -// -func (a ConversationsApi) GetConversationsChatParticipantWrapupcodes(conversationId string, participantId string) ([]Wrapupcode, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/chats/{conversationId}/participants/{participantId}/wrapupcodes" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - defaultReturn := make([]Wrapupcode, 0) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->GetConversationsChatParticipantWrapupcodes") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->GetConversationsChatParticipantWrapupcodes") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload []Wrapupcode - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversationsChats invokes GET /api/v2/conversations/chats -// -// Get active chat conversations for the logged in user -// -// -func (a ConversationsApi) GetConversationsChats() (*Chatconversationentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/chats" - defaultReturn := new(Chatconversationentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Chatconversationentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversationsCobrowsesession invokes GET /api/v2/conversations/cobrowsesessions/{conversationId} -// -// Get cobrowse conversation -// -// -func (a ConversationsApi) GetConversationsCobrowsesession(conversationId string) (*Cobrowseconversation, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/cobrowsesessions/{conversationId}" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - defaultReturn := new(Cobrowseconversation) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->GetConversationsCobrowsesession") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Cobrowseconversation - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversationsCobrowsesessionParticipantWrapup invokes GET /api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/wrapup -// -// Get the wrap-up for this conversation participant. -// -// -func (a ConversationsApi) GetConversationsCobrowsesessionParticipantWrapup(conversationId string, participantId string, provisional bool) (*Assignedwrapupcode, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/wrapup" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - defaultReturn := new(Assignedwrapupcode) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->GetConversationsCobrowsesessionParticipantWrapup") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->GetConversationsCobrowsesessionParticipantWrapup") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(provisional).(string); ok { - if str != "" { - queryParams["provisional"] = a.Configuration.APIClient.ParameterToString(provisional, collectionFormat) - } - } else { - queryParams["provisional"] = a.Configuration.APIClient.ParameterToString(provisional, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Assignedwrapupcode - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversationsCobrowsesessionParticipantWrapupcodes invokes GET /api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/wrapupcodes -// -// Get list of wrapup codes for this conversation participant -// -// -func (a ConversationsApi) GetConversationsCobrowsesessionParticipantWrapupcodes(conversationId string, participantId string) ([]Wrapupcode, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/wrapupcodes" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - defaultReturn := make([]Wrapupcode, 0) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->GetConversationsCobrowsesessionParticipantWrapupcodes") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->GetConversationsCobrowsesessionParticipantWrapupcodes") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload []Wrapupcode - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversationsCobrowsesessions invokes GET /api/v2/conversations/cobrowsesessions -// -// Get active cobrowse conversations for the logged in user -// -// -func (a ConversationsApi) GetConversationsCobrowsesessions() (*Cobrowseconversationentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/cobrowsesessions" - defaultReturn := new(Cobrowseconversationentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Cobrowseconversationentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversationsEmail invokes GET /api/v2/conversations/emails/{conversationId} -// -// Get email conversation -// -// -func (a ConversationsApi) GetConversationsEmail(conversationId string) (*Emailconversation, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/emails/{conversationId}" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - defaultReturn := new(Emailconversation) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->GetConversationsEmail") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Emailconversation - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversationsEmailMessage invokes GET /api/v2/conversations/emails/{conversationId}/messages/{messageId} -// -// Get conversation message -// -// -func (a ConversationsApi) GetConversationsEmailMessage(conversationId string, messageId string) (*Emailmessage, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/emails/{conversationId}/messages/{messageId}" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{messageId}", fmt.Sprintf("%v", messageId), -1) - defaultReturn := new(Emailmessage) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->GetConversationsEmailMessage") - } - // verify the required parameter 'messageId' is set - if &messageId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'messageId' when calling ConversationsApi->GetConversationsEmailMessage") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Emailmessage - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversationsEmailMessages invokes GET /api/v2/conversations/emails/{conversationId}/messages -// -// Get conversation messages -// -// -func (a ConversationsApi) GetConversationsEmailMessages(conversationId string) (*Emailmessagelisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/emails/{conversationId}/messages" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - defaultReturn := new(Emailmessagelisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->GetConversationsEmailMessages") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Emailmessagelisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversationsEmailMessagesDraft invokes GET /api/v2/conversations/emails/{conversationId}/messages/draft -// -// Get conversation draft reply -// -// -func (a ConversationsApi) GetConversationsEmailMessagesDraft(conversationId string) (*Emailmessage, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/emails/{conversationId}/messages/draft" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - defaultReturn := new(Emailmessage) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->GetConversationsEmailMessagesDraft") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Emailmessage - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversationsEmailParticipantWrapup invokes GET /api/v2/conversations/emails/{conversationId}/participants/{participantId}/wrapup -// -// Get the wrap-up for this conversation participant. -// -// -func (a ConversationsApi) GetConversationsEmailParticipantWrapup(conversationId string, participantId string, provisional bool) (*Assignedwrapupcode, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/emails/{conversationId}/participants/{participantId}/wrapup" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - defaultReturn := new(Assignedwrapupcode) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->GetConversationsEmailParticipantWrapup") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->GetConversationsEmailParticipantWrapup") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(provisional).(string); ok { - if str != "" { - queryParams["provisional"] = a.Configuration.APIClient.ParameterToString(provisional, collectionFormat) - } - } else { - queryParams["provisional"] = a.Configuration.APIClient.ParameterToString(provisional, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Assignedwrapupcode - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversationsEmailParticipantWrapupcodes invokes GET /api/v2/conversations/emails/{conversationId}/participants/{participantId}/wrapupcodes -// -// Get list of wrapup codes for this conversation participant -// -// -func (a ConversationsApi) GetConversationsEmailParticipantWrapupcodes(conversationId string, participantId string) ([]Wrapupcode, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/emails/{conversationId}/participants/{participantId}/wrapupcodes" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - defaultReturn := make([]Wrapupcode, 0) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->GetConversationsEmailParticipantWrapupcodes") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->GetConversationsEmailParticipantWrapupcodes") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload []Wrapupcode - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversationsEmails invokes GET /api/v2/conversations/emails -// -// Get active email conversations for the logged in user -// -// -func (a ConversationsApi) GetConversationsEmails() (*Emailconversationentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/emails" - defaultReturn := new(Emailconversationentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Emailconversationentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversationsMessage invokes GET /api/v2/conversations/messages/{conversationId} -// -// Get message conversation -// -// -func (a ConversationsApi) GetConversationsMessage(conversationId string) (*Messageconversation, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/messages/{conversationId}" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - defaultReturn := new(Messageconversation) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->GetConversationsMessage") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Messageconversation - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversationsMessageCommunicationMessagesMediaMediaId invokes GET /api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages/media/{mediaId} -// -// Get media -// -// -func (a ConversationsApi) GetConversationsMessageCommunicationMessagesMediaMediaId(conversationId string, communicationId string, mediaId string) (*Messagemediadata, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages/media/{mediaId}" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{communicationId}", fmt.Sprintf("%v", communicationId), -1) - path = strings.Replace(path, "{mediaId}", fmt.Sprintf("%v", mediaId), -1) - defaultReturn := new(Messagemediadata) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->GetConversationsMessageCommunicationMessagesMediaMediaId") - } - // verify the required parameter 'communicationId' is set - if &communicationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'communicationId' when calling ConversationsApi->GetConversationsMessageCommunicationMessagesMediaMediaId") - } - // verify the required parameter 'mediaId' is set - if &mediaId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'mediaId' when calling ConversationsApi->GetConversationsMessageCommunicationMessagesMediaMediaId") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Messagemediadata - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversationsMessageMessage invokes GET /api/v2/conversations/messages/{conversationId}/messages/{messageId} -// -// Get message -// -// -func (a ConversationsApi) GetConversationsMessageMessage(conversationId string, messageId string) (*Messagedata, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/messages/{conversationId}/messages/{messageId}" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{messageId}", fmt.Sprintf("%v", messageId), -1) - defaultReturn := new(Messagedata) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->GetConversationsMessageMessage") - } - // verify the required parameter 'messageId' is set - if &messageId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'messageId' when calling ConversationsApi->GetConversationsMessageMessage") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Messagedata - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversationsMessageParticipantWrapup invokes GET /api/v2/conversations/messages/{conversationId}/participants/{participantId}/wrapup -// -// Get the wrap-up for this conversation participant. -// -// -func (a ConversationsApi) GetConversationsMessageParticipantWrapup(conversationId string, participantId string, provisional bool) (*Assignedwrapupcode, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/messages/{conversationId}/participants/{participantId}/wrapup" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - defaultReturn := new(Assignedwrapupcode) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->GetConversationsMessageParticipantWrapup") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->GetConversationsMessageParticipantWrapup") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(provisional).(string); ok { - if str != "" { - queryParams["provisional"] = a.Configuration.APIClient.ParameterToString(provisional, collectionFormat) - } - } else { - queryParams["provisional"] = a.Configuration.APIClient.ParameterToString(provisional, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Assignedwrapupcode - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversationsMessageParticipantWrapupcodes invokes GET /api/v2/conversations/messages/{conversationId}/participants/{participantId}/wrapupcodes -// -// Get list of wrapup codes for this conversation participant -// -// -func (a ConversationsApi) GetConversationsMessageParticipantWrapupcodes(conversationId string, participantId string) ([]Wrapupcode, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/messages/{conversationId}/participants/{participantId}/wrapupcodes" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - defaultReturn := make([]Wrapupcode, 0) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->GetConversationsMessageParticipantWrapupcodes") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->GetConversationsMessageParticipantWrapupcodes") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload []Wrapupcode - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversationsMessages invokes GET /api/v2/conversations/messages -// -// Get active message conversations for the logged in user -// -// -func (a ConversationsApi) GetConversationsMessages() (*Messageconversationentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/messages" - defaultReturn := new(Messageconversationentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Messageconversationentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversationsMessagingFacebookApp invokes GET /api/v2/conversations/messaging/facebook/app -// -// Get Genesys Facebook App Id -// -// -func (a ConversationsApi) GetConversationsMessagingFacebookApp() (*Facebookappcredentials, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/messaging/facebook/app" - defaultReturn := new(Facebookappcredentials) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Facebookappcredentials - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversationsMessagingIntegrations invokes GET /api/v2/conversations/messaging/integrations -// -// Get a list of Integrations -// -// -func (a ConversationsApi) GetConversationsMessagingIntegrations(pageSize int, pageNumber int) (*Messagingintegrationentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/messaging/integrations" - defaultReturn := new(Messagingintegrationentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Messagingintegrationentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversationsMessagingIntegrationsFacebook invokes GET /api/v2/conversations/messaging/integrations/facebook -// -// Get a list of Facebook Integrations -// -// -func (a ConversationsApi) GetConversationsMessagingIntegrationsFacebook(pageSize int, pageNumber int) (*Facebookintegrationentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/messaging/integrations/facebook" - defaultReturn := new(Facebookintegrationentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Facebookintegrationentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversationsMessagingIntegrationsFacebookIntegrationId invokes GET /api/v2/conversations/messaging/integrations/facebook/{integrationId} -// -// Get a Facebook messaging integration -// -// -func (a ConversationsApi) GetConversationsMessagingIntegrationsFacebookIntegrationId(integrationId string) (*Facebookintegration, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/messaging/integrations/facebook/{integrationId}" - path = strings.Replace(path, "{integrationId}", fmt.Sprintf("%v", integrationId), -1) - defaultReturn := new(Facebookintegration) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'integrationId' is set - if &integrationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'integrationId' when calling ConversationsApi->GetConversationsMessagingIntegrationsFacebookIntegrationId") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Facebookintegration - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversationsMessagingIntegrationsLine invokes GET /api/v2/conversations/messaging/integrations/line -// -// Get a list of LINE messenger Integrations -// -// -func (a ConversationsApi) GetConversationsMessagingIntegrationsLine(pageSize int, pageNumber int) (*Lineintegrationentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/messaging/integrations/line" - defaultReturn := new(Lineintegrationentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Lineintegrationentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversationsMessagingIntegrationsLineIntegrationId invokes GET /api/v2/conversations/messaging/integrations/line/{integrationId} -// -// Get a LINE messenger integration -// -// -func (a ConversationsApi) GetConversationsMessagingIntegrationsLineIntegrationId(integrationId string) (*Lineintegration, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/messaging/integrations/line/{integrationId}" - path = strings.Replace(path, "{integrationId}", fmt.Sprintf("%v", integrationId), -1) - defaultReturn := new(Lineintegration) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'integrationId' is set - if &integrationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'integrationId' when calling ConversationsApi->GetConversationsMessagingIntegrationsLineIntegrationId") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Lineintegration - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversationsMessagingIntegrationsTwitter invokes GET /api/v2/conversations/messaging/integrations/twitter -// -// Get a list of Twitter Integrations -// -// -func (a ConversationsApi) GetConversationsMessagingIntegrationsTwitter(pageSize int, pageNumber int) (*Twitterintegrationentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/messaging/integrations/twitter" - defaultReturn := new(Twitterintegrationentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Twitterintegrationentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversationsMessagingIntegrationsTwitterIntegrationId invokes GET /api/v2/conversations/messaging/integrations/twitter/{integrationId} -// -// Get a Twitter messaging integration -// -// -func (a ConversationsApi) GetConversationsMessagingIntegrationsTwitterIntegrationId(integrationId string) (*Twitterintegration, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/messaging/integrations/twitter/{integrationId}" - path = strings.Replace(path, "{integrationId}", fmt.Sprintf("%v", integrationId), -1) - defaultReturn := new(Twitterintegration) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'integrationId' is set - if &integrationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'integrationId' when calling ConversationsApi->GetConversationsMessagingIntegrationsTwitterIntegrationId") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Twitterintegration - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversationsMessagingIntegrationsWhatsapp invokes GET /api/v2/conversations/messaging/integrations/whatsapp -// -// Get a list of WhatsApp Integrations -// -// -func (a ConversationsApi) GetConversationsMessagingIntegrationsWhatsapp(pageSize int, pageNumber int) (*Whatsappintegrationentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/messaging/integrations/whatsapp" - defaultReturn := new(Whatsappintegrationentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Whatsappintegrationentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversationsMessagingIntegrationsWhatsappIntegrationId invokes GET /api/v2/conversations/messaging/integrations/whatsapp/{integrationId} -// -// Get a WhatsApp messaging integration -// -// -func (a ConversationsApi) GetConversationsMessagingIntegrationsWhatsappIntegrationId(integrationId string) (*Whatsappintegration, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/messaging/integrations/whatsapp/{integrationId}" - path = strings.Replace(path, "{integrationId}", fmt.Sprintf("%v", integrationId), -1) - defaultReturn := new(Whatsappintegration) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'integrationId' is set - if &integrationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'integrationId' when calling ConversationsApi->GetConversationsMessagingIntegrationsWhatsappIntegrationId") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Whatsappintegration - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversationsMessagingSticker invokes GET /api/v2/conversations/messaging/stickers/{messengerType} -// -// Get a list of Messaging Stickers -// -// -func (a ConversationsApi) GetConversationsMessagingSticker(messengerType string, pageSize int, pageNumber int) (*Messagingstickerentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/messaging/stickers/{messengerType}" - path = strings.Replace(path, "{messengerType}", fmt.Sprintf("%v", messengerType), -1) - defaultReturn := new(Messagingstickerentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'messengerType' is set - if &messengerType == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'messengerType' when calling ConversationsApi->GetConversationsMessagingSticker") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Messagingstickerentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchConversationParticipant invokes PATCH /api/v2/conversations/{conversationId}/participants/{participantId} -// -// Update a participant. -// -// Update conversation participant. -func (a ConversationsApi) PatchConversationParticipant(conversationId string, participantId string, body Mediaparticipantrequest) (*APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/{conversationId}/participants/{participantId}" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PatchConversationParticipant") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->PatchConversationParticipant") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PatchConversationParticipant") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// PatchConversationParticipantAttributes invokes PATCH /api/v2/conversations/{conversationId}/participants/{participantId}/attributes -// -// Update the attributes on a conversation participant. -// -// -func (a ConversationsApi) PatchConversationParticipantAttributes(conversationId string, participantId string, body Participantattributes) (*APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/{conversationId}/participants/{participantId}/attributes" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PatchConversationParticipantAttributes") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->PatchConversationParticipantAttributes") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PatchConversationParticipantAttributes") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// PatchConversationsCall invokes PATCH /api/v2/conversations/calls/{conversationId} -// -// Update a conversation by setting it's recording state, merging in other conversations to create a conference, or disconnecting all of the participants -// -// -func (a ConversationsApi) PatchConversationsCall(conversationId string, body Conversation) (*Conversation, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/calls/{conversationId}" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - defaultReturn := new(Conversation) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PatchConversationsCall") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PatchConversationsCall") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Conversation - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchConversationsCallParticipant invokes PATCH /api/v2/conversations/calls/{conversationId}/participants/{participantId} -// -// Update conversation participant -// -// -func (a ConversationsApi) PatchConversationsCallParticipant(conversationId string, participantId string, body Mediaparticipantrequest) (*APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/calls/{conversationId}/participants/{participantId}" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PatchConversationsCallParticipant") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->PatchConversationsCallParticipant") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PatchConversationsCallParticipant") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// PatchConversationsCallParticipantAttributes invokes PATCH /api/v2/conversations/calls/{conversationId}/participants/{participantId}/attributes -// -// Update the attributes on a conversation participant. -// -// -func (a ConversationsApi) PatchConversationsCallParticipantAttributes(conversationId string, participantId string, body Participantattributes) (*APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/calls/{conversationId}/participants/{participantId}/attributes" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PatchConversationsCallParticipantAttributes") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->PatchConversationsCallParticipantAttributes") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PatchConversationsCallParticipantAttributes") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// PatchConversationsCallParticipantCommunication invokes PATCH /api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId} -// -// Update conversation participant's communication by disconnecting it. -// -// -func (a ConversationsApi) PatchConversationsCallParticipantCommunication(conversationId string, participantId string, communicationId string, body Mediaparticipantrequest) (*Empty, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - path = strings.Replace(path, "{communicationId}", fmt.Sprintf("%v", communicationId), -1) - defaultReturn := new(Empty) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PatchConversationsCallParticipantCommunication") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->PatchConversationsCallParticipantCommunication") - } - // verify the required parameter 'communicationId' is set - if &communicationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'communicationId' when calling ConversationsApi->PatchConversationsCallParticipantCommunication") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PatchConversationsCallParticipantCommunication") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Empty - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchConversationsCallParticipantConsult invokes PATCH /api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult -// -// Change who can speak -// -// -func (a ConversationsApi) PatchConversationsCallParticipantConsult(conversationId string, participantId string, body Consulttransferupdate) (*Consulttransferresponse, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - defaultReturn := new(Consulttransferresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PatchConversationsCallParticipantConsult") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->PatchConversationsCallParticipantConsult") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PatchConversationsCallParticipantConsult") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Consulttransferresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchConversationsCallback invokes PATCH /api/v2/conversations/callbacks/{conversationId} -// -// Update a conversation by disconnecting all of the participants -// -// -func (a ConversationsApi) PatchConversationsCallback(conversationId string, body Conversation) (*Conversation, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/callbacks/{conversationId}" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - defaultReturn := new(Conversation) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PatchConversationsCallback") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PatchConversationsCallback") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Conversation - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchConversationsCallbackParticipant invokes PATCH /api/v2/conversations/callbacks/{conversationId}/participants/{participantId} -// -// Update conversation participant -// -// -func (a ConversationsApi) PatchConversationsCallbackParticipant(conversationId string, participantId string, body Mediaparticipantrequest) (*APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PatchConversationsCallbackParticipant") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->PatchConversationsCallbackParticipant") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PatchConversationsCallbackParticipant") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// PatchConversationsCallbackParticipantAttributes invokes PATCH /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/attributes -// -// Update the attributes on a conversation participant. -// -// -func (a ConversationsApi) PatchConversationsCallbackParticipantAttributes(conversationId string, participantId string, body Participantattributes) (*APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/attributes" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PatchConversationsCallbackParticipantAttributes") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->PatchConversationsCallbackParticipantAttributes") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PatchConversationsCallbackParticipantAttributes") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// PatchConversationsCallbackParticipantCommunication invokes PATCH /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/communications/{communicationId} -// -// Update conversation participant's communication by disconnecting it. -// -// -func (a ConversationsApi) PatchConversationsCallbackParticipantCommunication(conversationId string, participantId string, communicationId string, body Mediaparticipantrequest) (*Empty, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/communications/{communicationId}" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - path = strings.Replace(path, "{communicationId}", fmt.Sprintf("%v", communicationId), -1) - defaultReturn := new(Empty) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PatchConversationsCallbackParticipantCommunication") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->PatchConversationsCallbackParticipantCommunication") - } - // verify the required parameter 'communicationId' is set - if &communicationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'communicationId' when calling ConversationsApi->PatchConversationsCallbackParticipantCommunication") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PatchConversationsCallbackParticipantCommunication") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Empty - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchConversationsChat invokes PATCH /api/v2/conversations/chats/{conversationId} -// -// Update a conversation by disconnecting all of the participants -// -// -func (a ConversationsApi) PatchConversationsChat(conversationId string, body Conversation) (*Conversation, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/chats/{conversationId}" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - defaultReturn := new(Conversation) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PatchConversationsChat") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PatchConversationsChat") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Conversation - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchConversationsChatParticipant invokes PATCH /api/v2/conversations/chats/{conversationId}/participants/{participantId} -// -// Update conversation participant -// -// -func (a ConversationsApi) PatchConversationsChatParticipant(conversationId string, participantId string, body Mediaparticipantrequest) (*APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/chats/{conversationId}/participants/{participantId}" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PatchConversationsChatParticipant") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->PatchConversationsChatParticipant") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PatchConversationsChatParticipant") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// PatchConversationsChatParticipantAttributes invokes PATCH /api/v2/conversations/chats/{conversationId}/participants/{participantId}/attributes -// -// Update the attributes on a conversation participant. -// -// -func (a ConversationsApi) PatchConversationsChatParticipantAttributes(conversationId string, participantId string, body Participantattributes) (*APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/chats/{conversationId}/participants/{participantId}/attributes" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PatchConversationsChatParticipantAttributes") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->PatchConversationsChatParticipantAttributes") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PatchConversationsChatParticipantAttributes") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// PatchConversationsChatParticipantCommunication invokes PATCH /api/v2/conversations/chats/{conversationId}/participants/{participantId}/communications/{communicationId} -// -// Update conversation participant's communication by disconnecting it. -// -// -func (a ConversationsApi) PatchConversationsChatParticipantCommunication(conversationId string, participantId string, communicationId string, body Mediaparticipantrequest) (*Empty, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/chats/{conversationId}/participants/{participantId}/communications/{communicationId}" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - path = strings.Replace(path, "{communicationId}", fmt.Sprintf("%v", communicationId), -1) - defaultReturn := new(Empty) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PatchConversationsChatParticipantCommunication") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->PatchConversationsChatParticipantCommunication") - } - // verify the required parameter 'communicationId' is set - if &communicationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'communicationId' when calling ConversationsApi->PatchConversationsChatParticipantCommunication") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PatchConversationsChatParticipantCommunication") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Empty - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchConversationsCobrowsesession invokes PATCH /api/v2/conversations/cobrowsesessions/{conversationId} -// -// Update a conversation by disconnecting all of the participants -// -// -func (a ConversationsApi) PatchConversationsCobrowsesession(conversationId string, body Conversation) (*Conversation, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/cobrowsesessions/{conversationId}" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - defaultReturn := new(Conversation) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PatchConversationsCobrowsesession") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PatchConversationsCobrowsesession") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Conversation - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchConversationsCobrowsesessionParticipant invokes PATCH /api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId} -// -// Update conversation participant -// -// -func (a ConversationsApi) PatchConversationsCobrowsesessionParticipant(conversationId string, participantId string, body Mediaparticipantrequest) (*APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PatchConversationsCobrowsesessionParticipant") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->PatchConversationsCobrowsesessionParticipant") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// PatchConversationsCobrowsesessionParticipantAttributes invokes PATCH /api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/attributes -// -// Update the attributes on a conversation participant. -// -// -func (a ConversationsApi) PatchConversationsCobrowsesessionParticipantAttributes(conversationId string, participantId string, body Participantattributes) (*APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/attributes" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PatchConversationsCobrowsesessionParticipantAttributes") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->PatchConversationsCobrowsesessionParticipantAttributes") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// PatchConversationsCobrowsesessionParticipantCommunication invokes PATCH /api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/communications/{communicationId} -// -// Update conversation participant's communication by disconnecting it. -// -// -func (a ConversationsApi) PatchConversationsCobrowsesessionParticipantCommunication(conversationId string, participantId string, communicationId string, body Mediaparticipantrequest) (*Empty, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/communications/{communicationId}" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - path = strings.Replace(path, "{communicationId}", fmt.Sprintf("%v", communicationId), -1) - defaultReturn := new(Empty) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PatchConversationsCobrowsesessionParticipantCommunication") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->PatchConversationsCobrowsesessionParticipantCommunication") - } - // verify the required parameter 'communicationId' is set - if &communicationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'communicationId' when calling ConversationsApi->PatchConversationsCobrowsesessionParticipantCommunication") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PatchConversationsCobrowsesessionParticipantCommunication") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Empty - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchConversationsEmail invokes PATCH /api/v2/conversations/emails/{conversationId} -// -// Update a conversation by disconnecting all of the participants -// -// -func (a ConversationsApi) PatchConversationsEmail(conversationId string, body Conversation) (*Conversation, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/emails/{conversationId}" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - defaultReturn := new(Conversation) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PatchConversationsEmail") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PatchConversationsEmail") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Conversation - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchConversationsEmailParticipant invokes PATCH /api/v2/conversations/emails/{conversationId}/participants/{participantId} -// -// Update conversation participant -// -// -func (a ConversationsApi) PatchConversationsEmailParticipant(conversationId string, participantId string, body Mediaparticipantrequest) (*APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/emails/{conversationId}/participants/{participantId}" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PatchConversationsEmailParticipant") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->PatchConversationsEmailParticipant") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PatchConversationsEmailParticipant") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// PatchConversationsEmailParticipantAttributes invokes PATCH /api/v2/conversations/emails/{conversationId}/participants/{participantId}/attributes -// -// Update the attributes on a conversation participant. -// -// -func (a ConversationsApi) PatchConversationsEmailParticipantAttributes(conversationId string, participantId string, body Participantattributes) (*APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/emails/{conversationId}/participants/{participantId}/attributes" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PatchConversationsEmailParticipantAttributes") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->PatchConversationsEmailParticipantAttributes") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PatchConversationsEmailParticipantAttributes") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// PatchConversationsEmailParticipantCommunication invokes PATCH /api/v2/conversations/emails/{conversationId}/participants/{participantId}/communications/{communicationId} -// -// Update conversation participant's communication by disconnecting it. -// -// -func (a ConversationsApi) PatchConversationsEmailParticipantCommunication(conversationId string, participantId string, communicationId string, body Mediaparticipantrequest) (*Empty, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/emails/{conversationId}/participants/{participantId}/communications/{communicationId}" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - path = strings.Replace(path, "{communicationId}", fmt.Sprintf("%v", communicationId), -1) - defaultReturn := new(Empty) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PatchConversationsEmailParticipantCommunication") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->PatchConversationsEmailParticipantCommunication") - } - // verify the required parameter 'communicationId' is set - if &communicationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'communicationId' when calling ConversationsApi->PatchConversationsEmailParticipantCommunication") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PatchConversationsEmailParticipantCommunication") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Empty - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchConversationsMessage invokes PATCH /api/v2/conversations/messages/{conversationId} -// -// Update a conversation by disconnecting all of the participants -// -// -func (a ConversationsApi) PatchConversationsMessage(conversationId string, body Conversation) (*Conversation, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/messages/{conversationId}" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - defaultReturn := new(Conversation) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PatchConversationsMessage") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PatchConversationsMessage") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Conversation - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchConversationsMessageParticipant invokes PATCH /api/v2/conversations/messages/{conversationId}/participants/{participantId} -// -// Update conversation participant -// -// -func (a ConversationsApi) PatchConversationsMessageParticipant(conversationId string, participantId string, body Mediaparticipantrequest) (*APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/messages/{conversationId}/participants/{participantId}" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PatchConversationsMessageParticipant") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->PatchConversationsMessageParticipant") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// PatchConversationsMessageParticipantAttributes invokes PATCH /api/v2/conversations/messages/{conversationId}/participants/{participantId}/attributes -// -// Update the attributes on a conversation participant. -// -// -func (a ConversationsApi) PatchConversationsMessageParticipantAttributes(conversationId string, participantId string, body Participantattributes) (*APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/messages/{conversationId}/participants/{participantId}/attributes" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PatchConversationsMessageParticipantAttributes") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->PatchConversationsMessageParticipantAttributes") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// PatchConversationsMessageParticipantCommunication invokes PATCH /api/v2/conversations/messages/{conversationId}/participants/{participantId}/communications/{communicationId} -// -// Update conversation participant's communication by disconnecting it. -// -// -func (a ConversationsApi) PatchConversationsMessageParticipantCommunication(conversationId string, participantId string, communicationId string, body Mediaparticipantrequest) (*Empty, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/messages/{conversationId}/participants/{participantId}/communications/{communicationId}" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - path = strings.Replace(path, "{communicationId}", fmt.Sprintf("%v", communicationId), -1) - defaultReturn := new(Empty) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PatchConversationsMessageParticipantCommunication") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->PatchConversationsMessageParticipantCommunication") - } - // verify the required parameter 'communicationId' is set - if &communicationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'communicationId' when calling ConversationsApi->PatchConversationsMessageParticipantCommunication") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PatchConversationsMessageParticipantCommunication") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Empty - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchConversationsMessagingIntegrationsFacebookIntegrationId invokes PATCH /api/v2/conversations/messaging/integrations/facebook/{integrationId} -// -// Update Facebook messaging integration -// -// -func (a ConversationsApi) PatchConversationsMessagingIntegrationsFacebookIntegrationId(integrationId string, body Facebookintegrationupdaterequest) (*Facebookintegration, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/messaging/integrations/facebook/{integrationId}" - path = strings.Replace(path, "{integrationId}", fmt.Sprintf("%v", integrationId), -1) - defaultReturn := new(Facebookintegration) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'integrationId' is set - if &integrationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'integrationId' when calling ConversationsApi->PatchConversationsMessagingIntegrationsFacebookIntegrationId") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PatchConversationsMessagingIntegrationsFacebookIntegrationId") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Facebookintegration - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchConversationsMessagingIntegrationsTwitterIntegrationId invokes PATCH /api/v2/conversations/messaging/integrations/twitter/{integrationId} -// -// Update Twitter messaging integration -// -// -func (a ConversationsApi) PatchConversationsMessagingIntegrationsTwitterIntegrationId(integrationId string, body Twitterintegrationrequest) (*Twitterintegration, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/messaging/integrations/twitter/{integrationId}" - path = strings.Replace(path, "{integrationId}", fmt.Sprintf("%v", integrationId), -1) - defaultReturn := new(Twitterintegration) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'integrationId' is set - if &integrationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'integrationId' when calling ConversationsApi->PatchConversationsMessagingIntegrationsTwitterIntegrationId") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PatchConversationsMessagingIntegrationsTwitterIntegrationId") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Twitterintegration - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchConversationsMessagingIntegrationsWhatsappIntegrationId invokes PATCH /api/v2/conversations/messaging/integrations/whatsapp/{integrationId} -// -// Update or activate a WhatsApp messaging integration. -// -// The following steps are required in order to fully activate a Whatsapp Integration: Initially, you will need to get an activation code by sending: an action set to Activate, and an authenticationMethod choosing from Sms or Voice. Finally, once you have been informed of an activation code on selected authenticationMethod, you will need to confirm the code by sending: an action set to Confirm, and the confirmationCode you have received from Whatsapp. -func (a ConversationsApi) PatchConversationsMessagingIntegrationsWhatsappIntegrationId(integrationId string, body Whatsappintegrationupdaterequest) (*Whatsappintegration, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/messaging/integrations/whatsapp/{integrationId}" - path = strings.Replace(path, "{integrationId}", fmt.Sprintf("%v", integrationId), -1) - defaultReturn := new(Whatsappintegration) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'integrationId' is set - if &integrationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'integrationId' when calling ConversationsApi->PatchConversationsMessagingIntegrationsWhatsappIntegrationId") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PatchConversationsMessagingIntegrationsWhatsappIntegrationId") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Whatsappintegration - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostAnalyticsConversationDetailsProperties invokes POST /api/v2/analytics/conversations/{conversationId}/details/properties -// -// Index conversation properties -// -// -func (a ConversationsApi) PostAnalyticsConversationDetailsProperties(conversationId string, body Propertyindexrequest) (*Propertyindexrequest, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/conversations/{conversationId}/details/properties" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - defaultReturn := new(Propertyindexrequest) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PostAnalyticsConversationDetailsProperties") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PostAnalyticsConversationDetailsProperties") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Propertyindexrequest - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostAnalyticsConversationsAggregatesQuery invokes POST /api/v2/analytics/conversations/aggregates/query -// -// Query for conversation aggregates -// -// -func (a ConversationsApi) PostAnalyticsConversationsAggregatesQuery(body Conversationaggregationquery) (*Conversationaggregatequeryresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/conversations/aggregates/query" - defaultReturn := new(Conversationaggregatequeryresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PostAnalyticsConversationsAggregatesQuery") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Conversationaggregatequeryresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostAnalyticsConversationsDetailsJobs invokes POST /api/v2/analytics/conversations/details/jobs -// -// Query for conversation details asynchronously -// -// -func (a ConversationsApi) PostAnalyticsConversationsDetailsJobs(body Asyncconversationquery) (*Asyncqueryresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/conversations/details/jobs" - defaultReturn := new(Asyncqueryresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PostAnalyticsConversationsDetailsJobs") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Asyncqueryresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostAnalyticsConversationsDetailsQuery invokes POST /api/v2/analytics/conversations/details/query -// -// Query for conversation details -// -// -func (a ConversationsApi) PostAnalyticsConversationsDetailsQuery(body Conversationquery) (*Analyticsconversationqueryresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/conversations/details/query" - defaultReturn := new(Analyticsconversationqueryresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PostAnalyticsConversationsDetailsQuery") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Analyticsconversationqueryresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostConversationAssign invokes POST /api/v2/conversations/{conversationId}/assign -// -// Attempts to manually assign a specified conversation to a specified agent. Ignores bullseye ring, PAR score, skills, and languages. -// -// -func (a ConversationsApi) PostConversationAssign(conversationId string, body Conversationuser) (*string, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/{conversationId}/assign" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - defaultReturn := new(string) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PostConversationAssign") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PostConversationAssign") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *string - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostConversationDisconnect invokes POST /api/v2/conversations/{conversationId}/disconnect -// -// Performs a full conversation teardown. Issues disconnect requests for any connected media. Applies a system wrap-up code to any participants that are pending wrap-up. This is not intended to be the normal way of ending interactions but is available in the event of problems with the application to allow a resynchronization of state across all components. It is recommended that users submit a support case if they are relying on this endpoint systematically as there is likely something that needs investigation. -// -// -func (a ConversationsApi) PostConversationDisconnect(conversationId string) (*string, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/{conversationId}/disconnect" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - defaultReturn := new(string) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PostConversationDisconnect") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *string - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostConversationParticipantCallbacks invokes POST /api/v2/conversations/{conversationId}/participants/{participantId}/callbacks -// -// Create a new callback for the specified participant on the conversation. -// -// -func (a ConversationsApi) PostConversationParticipantCallbacks(conversationId string, participantId string, body Createcallbackonconversationcommand) (*APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/{conversationId}/participants/{participantId}/callbacks" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PostConversationParticipantCallbacks") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->PostConversationParticipantCallbacks") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// PostConversationParticipantDigits invokes POST /api/v2/conversations/{conversationId}/participants/{participantId}/digits -// -// Sends DTMF to the participant -// -// -func (a ConversationsApi) PostConversationParticipantDigits(conversationId string, participantId string, body Digits) (*APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/{conversationId}/participants/{participantId}/digits" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PostConversationParticipantDigits") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->PostConversationParticipantDigits") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// PostConversationParticipantReplace invokes POST /api/v2/conversations/{conversationId}/participants/{participantId}/replace -// -// Replace this participant with the specified user and/or address -// -// -func (a ConversationsApi) PostConversationParticipantReplace(conversationId string, participantId string, body Transferrequest) (*APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/{conversationId}/participants/{participantId}/replace" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PostConversationParticipantReplace") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->PostConversationParticipantReplace") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PostConversationParticipantReplace") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// PostConversationParticipantSecureivrsessions invokes POST /api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions -// -// Create secure IVR session. Only a participant in the conversation can invoke a secure IVR. -// -// -func (a ConversationsApi) PostConversationParticipantSecureivrsessions(conversationId string, participantId string, body Createsecuresession) (*Securesession, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - defaultReturn := new(Securesession) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PostConversationParticipantSecureivrsessions") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->PostConversationParticipantSecureivrsessions") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Securesession - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostConversationsCall invokes POST /api/v2/conversations/calls/{conversationId} -// -// Place a new call as part of a callback conversation. -// -// -func (a ConversationsApi) PostConversationsCall(conversationId string, body Callcommand) (*Conversation, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/calls/{conversationId}" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - defaultReturn := new(Conversation) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PostConversationsCall") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PostConversationsCall") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Conversation - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostConversationsCallParticipantCoach invokes POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/coach -// -// Listen in on the conversation from the point of view of a given participant while speaking to just the given participant. -// -// -func (a ConversationsApi) PostConversationsCallParticipantCoach(conversationId string, participantId string) (*APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/calls/{conversationId}/participants/{participantId}/coach" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PostConversationsCallParticipantCoach") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->PostConversationsCallParticipantCoach") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// PostConversationsCallParticipantConsult invokes POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult -// -// Initiate and update consult transfer -// -// -func (a ConversationsApi) PostConversationsCallParticipantConsult(conversationId string, participantId string, body Consulttransfer) (*Consulttransferresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - defaultReturn := new(Consulttransferresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PostConversationsCallParticipantConsult") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->PostConversationsCallParticipantConsult") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PostConversationsCallParticipantConsult") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Consulttransferresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostConversationsCallParticipantMonitor invokes POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/monitor -// -// Listen in on the conversation from the point of view of a given participant. -// -// -func (a ConversationsApi) PostConversationsCallParticipantMonitor(conversationId string, participantId string) (*APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/calls/{conversationId}/participants/{participantId}/monitor" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PostConversationsCallParticipantMonitor") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->PostConversationsCallParticipantMonitor") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// PostConversationsCallParticipantReplace invokes POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/replace -// -// Replace this participant with the specified user and/or address -// -// -func (a ConversationsApi) PostConversationsCallParticipantReplace(conversationId string, participantId string, body Transferrequest) (*APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/calls/{conversationId}/participants/{participantId}/replace" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PostConversationsCallParticipantReplace") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->PostConversationsCallParticipantReplace") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PostConversationsCallParticipantReplace") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// PostConversationsCallParticipants invokes POST /api/v2/conversations/calls/{conversationId}/participants -// -// Add participants to a conversation -// -// -func (a ConversationsApi) PostConversationsCallParticipants(conversationId string, body Conversation) (*Conversation, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/calls/{conversationId}/participants" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - defaultReturn := new(Conversation) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PostConversationsCallParticipants") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PostConversationsCallParticipants") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Conversation - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostConversationsCallbackParticipantReplace invokes POST /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/replace -// -// Replace this participant with the specified user and/or address -// -// -func (a ConversationsApi) PostConversationsCallbackParticipantReplace(conversationId string, participantId string, body Transferrequest) (*APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/replace" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PostConversationsCallbackParticipantReplace") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->PostConversationsCallbackParticipantReplace") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PostConversationsCallbackParticipantReplace") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// PostConversationsCallbacks invokes POST /api/v2/conversations/callbacks -// -// Create a Callback -// -// -func (a ConversationsApi) PostConversationsCallbacks(body Createcallbackcommand) (*Createcallbackresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/callbacks" - defaultReturn := new(Createcallbackresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PostConversationsCallbacks") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Createcallbackresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostConversationsCalls invokes POST /api/v2/conversations/calls -// -// Create a call conversation -// -// -func (a ConversationsApi) PostConversationsCalls(body Createcallrequest) (*Createcallresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/calls" - defaultReturn := new(Createcallresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PostConversationsCalls") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Createcallresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostConversationsChatCommunicationMessages invokes POST /api/v2/conversations/chats/{conversationId}/communications/{communicationId}/messages -// -// Send a message on behalf of a communication in a chat conversation. -// -// -func (a ConversationsApi) PostConversationsChatCommunicationMessages(conversationId string, communicationId string, body Createwebchatmessagerequest) (*Webchatmessage, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/chats/{conversationId}/communications/{communicationId}/messages" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{communicationId}", fmt.Sprintf("%v", communicationId), -1) - defaultReturn := new(Webchatmessage) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PostConversationsChatCommunicationMessages") - } - // verify the required parameter 'communicationId' is set - if &communicationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'communicationId' when calling ConversationsApi->PostConversationsChatCommunicationMessages") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PostConversationsChatCommunicationMessages") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Webchatmessage - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostConversationsChatCommunicationTyping invokes POST /api/v2/conversations/chats/{conversationId}/communications/{communicationId}/typing -// -// Send a typing-indicator on behalf of a communication in a chat conversation. -// -// -func (a ConversationsApi) PostConversationsChatCommunicationTyping(conversationId string, communicationId string) (*Webchattyping, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/chats/{conversationId}/communications/{communicationId}/typing" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{communicationId}", fmt.Sprintf("%v", communicationId), -1) - defaultReturn := new(Webchattyping) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PostConversationsChatCommunicationTyping") - } - // verify the required parameter 'communicationId' is set - if &communicationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'communicationId' when calling ConversationsApi->PostConversationsChatCommunicationTyping") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Webchattyping - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostConversationsChatParticipantReplace invokes POST /api/v2/conversations/chats/{conversationId}/participants/{participantId}/replace -// -// Replace this participant with the specified user and/or address -// -// -func (a ConversationsApi) PostConversationsChatParticipantReplace(conversationId string, participantId string, body Transferrequest) (*APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/chats/{conversationId}/participants/{participantId}/replace" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PostConversationsChatParticipantReplace") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->PostConversationsChatParticipantReplace") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PostConversationsChatParticipantReplace") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// PostConversationsChats invokes POST /api/v2/conversations/chats -// -// Create a web chat conversation -// -// -func (a ConversationsApi) PostConversationsChats(body Createwebchatrequest) (*Chatconversation, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/chats" - defaultReturn := new(Chatconversation) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PostConversationsChats") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Chatconversation - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostConversationsCobrowsesessionParticipantReplace invokes POST /api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/replace -// -// Replace this participant with the specified user and/or address -// -// -func (a ConversationsApi) PostConversationsCobrowsesessionParticipantReplace(conversationId string, participantId string, body Transferrequest) (*APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/replace" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PostConversationsCobrowsesessionParticipantReplace") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->PostConversationsCobrowsesessionParticipantReplace") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// PostConversationsEmailInboundmessages invokes POST /api/v2/conversations/emails/{conversationId}/inboundmessages -// -// Send an email to an external conversation. An external conversation is one where the provider is not PureCloud based. This endpoint allows the sender of the external email to reply or send a new message to the existing conversation. The new message will be treated as part of the existing conversation and chained to it. -// -// -func (a ConversationsApi) PostConversationsEmailInboundmessages(conversationId string, body Inboundmessagerequest) (*Emailconversation, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/emails/{conversationId}/inboundmessages" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - defaultReturn := new(Emailconversation) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PostConversationsEmailInboundmessages") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PostConversationsEmailInboundmessages") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Emailconversation - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostConversationsEmailMessages invokes POST /api/v2/conversations/emails/{conversationId}/messages -// -// Send an email reply -// -// -func (a ConversationsApi) PostConversationsEmailMessages(conversationId string, body Emailmessage) (*Emailmessage, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/emails/{conversationId}/messages" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - defaultReturn := new(Emailmessage) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PostConversationsEmailMessages") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PostConversationsEmailMessages") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Emailmessage - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostConversationsEmailMessagesDraftAttachmentsCopy invokes POST /api/v2/conversations/emails/{conversationId}/messages/draft/attachments/copy -// -// Copy attachments from an email message to the current draft. -// -// -func (a ConversationsApi) PostConversationsEmailMessagesDraftAttachmentsCopy(conversationId string, body Copyattachmentsrequest) (*Emailmessage, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/emails/{conversationId}/messages/draft/attachments/copy" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - defaultReturn := new(Emailmessage) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PostConversationsEmailMessagesDraftAttachmentsCopy") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PostConversationsEmailMessagesDraftAttachmentsCopy") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Emailmessage - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostConversationsEmailParticipantReplace invokes POST /api/v2/conversations/emails/{conversationId}/participants/{participantId}/replace -// -// Replace this participant with the specified user and/or address -// -// -func (a ConversationsApi) PostConversationsEmailParticipantReplace(conversationId string, participantId string, body Transferrequest) (*APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/emails/{conversationId}/participants/{participantId}/replace" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PostConversationsEmailParticipantReplace") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->PostConversationsEmailParticipantReplace") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PostConversationsEmailParticipantReplace") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// PostConversationsEmails invokes POST /api/v2/conversations/emails -// -// Create an email conversation -// -// If the direction of the request is INBOUND, this will create an external conversation with a third party provider. If the direction of the the request is OUTBOUND, this will create a conversation to send outbound emails on behalf of a queue. -func (a ConversationsApi) PostConversationsEmails(body Createemailrequest) (*Emailconversation, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/emails" - defaultReturn := new(Emailconversation) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PostConversationsEmails") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Emailconversation - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostConversationsFaxes invokes POST /api/v2/conversations/faxes -// -// Create Fax Conversation -// -// -func (a ConversationsApi) PostConversationsFaxes(body Faxsendrequest) (*Faxsendresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/faxes" - defaultReturn := new(Faxsendresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PostConversationsFaxes") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Faxsendresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostConversationsMessageCommunicationMessages invokes POST /api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages -// -// Send message -// -// Send message on existing conversation/communication. Only one message body field can be accepted, per request. Example: 1 textBody, 1 mediaId, 1 stickerId, or 1 messageTemplate. -func (a ConversationsApi) PostConversationsMessageCommunicationMessages(conversationId string, communicationId string, body Additionalmessage) (*Messagedata, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{communicationId}", fmt.Sprintf("%v", communicationId), -1) - defaultReturn := new(Messagedata) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PostConversationsMessageCommunicationMessages") - } - // verify the required parameter 'communicationId' is set - if &communicationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'communicationId' when calling ConversationsApi->PostConversationsMessageCommunicationMessages") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PostConversationsMessageCommunicationMessages") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Messagedata - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostConversationsMessageCommunicationMessagesMedia invokes POST /api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages/media -// -// Create media -// -// -func (a ConversationsApi) PostConversationsMessageCommunicationMessagesMedia(conversationId string, communicationId string) (*Messagemediadata, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages/media" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{communicationId}", fmt.Sprintf("%v", communicationId), -1) - defaultReturn := new(Messagemediadata) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PostConversationsMessageCommunicationMessagesMedia") - } - // verify the required parameter 'communicationId' is set - if &communicationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'communicationId' when calling ConversationsApi->PostConversationsMessageCommunicationMessagesMedia") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Messagemediadata - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostConversationsMessageMessagesBulk invokes POST /api/v2/conversations/messages/{conversationId}/messages/bulk -// -// Get messages in batch -// -// The path parameter [conversationId] should contain the conversationId of the conversation being filtered. The body should contain the messageId(s) of messages being requested. For example: [\"a3069a33b-bbb1-4703-9d68-061d9e9db96e\", \"55bc6be3-078c-4a49-a4e6-1e05776ed7e8\"] -func (a ConversationsApi) PostConversationsMessageMessagesBulk(conversationId string, body []string) (*Textmessagelisting, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/messages/{conversationId}/messages/bulk" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - defaultReturn := new(Textmessagelisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PostConversationsMessageMessagesBulk") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Textmessagelisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostConversationsMessageParticipantReplace invokes POST /api/v2/conversations/messages/{conversationId}/participants/{participantId}/replace -// -// Replace this participant with the specified user and/or address -// -// -func (a ConversationsApi) PostConversationsMessageParticipantReplace(conversationId string, participantId string, body Transferrequest) (*APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/messages/{conversationId}/participants/{participantId}/replace" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PostConversationsMessageParticipantReplace") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->PostConversationsMessageParticipantReplace") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PostConversationsMessageParticipantReplace") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// PostConversationsMessages invokes POST /api/v2/conversations/messages -// -// Create an outbound messaging conversation. -// -// If there is an existing conversation between the remote address and the address associated with the queue specified in createOutboundRequest then the result of this request depends on the state of that conversation and the useExistingConversation field of createOutboundRequest. If the existing conversation is in alerting or connected state, then the request will fail. If the existing conversation is disconnected but still within the conversation window then the request will fail unless useExistingConversation is set to true. -func (a ConversationsApi) PostConversationsMessages(body Createoutboundmessagingconversationrequest) (*Messageconversation, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/messages" - defaultReturn := new(Messageconversation) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PostConversationsMessages") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Messageconversation - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostConversationsMessagesAgentless invokes POST /api/v2/conversations/messages/agentless -// -// Send an agentless outbound message -// -// Send an agentlesss (api participant) outbound message using a client credential grant. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will generate a new Conversation, if there is an existing active Conversation between the fromAddress and toAddress already, then this POST will fail. -func (a ConversationsApi) PostConversationsMessagesAgentless(body Sendagentlessoutboundmessagerequest) (*Sendagentlessoutboundmessageresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/messages/agentless" - defaultReturn := new(Sendagentlessoutboundmessageresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PostConversationsMessagesAgentless") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Sendagentlessoutboundmessageresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostConversationsMessagingIntegrationsFacebook invokes POST /api/v2/conversations/messaging/integrations/facebook -// -// Create a Facebook Integration -// -// -func (a ConversationsApi) PostConversationsMessagingIntegrationsFacebook(body Facebookintegrationrequest, async bool) (*Facebookintegration, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/messaging/integrations/facebook" - defaultReturn := new(Facebookintegration) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PostConversationsMessagingIntegrationsFacebook") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(async).(string); ok { - if str != "" { - queryParams["async"] = a.Configuration.APIClient.ParameterToString(async, collectionFormat) - } - } else { - queryParams["async"] = a.Configuration.APIClient.ParameterToString(async, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Facebookintegration - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostConversationsMessagingIntegrationsLine invokes POST /api/v2/conversations/messaging/integrations/line -// -// Create a LINE messenger Integration -// -// -func (a ConversationsApi) PostConversationsMessagingIntegrationsLine(body Lineintegrationrequest, async bool) (*Lineintegration, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/messaging/integrations/line" - defaultReturn := new(Lineintegration) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PostConversationsMessagingIntegrationsLine") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(async).(string); ok { - if str != "" { - queryParams["async"] = a.Configuration.APIClient.ParameterToString(async, collectionFormat) - } - } else { - queryParams["async"] = a.Configuration.APIClient.ParameterToString(async, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Lineintegration - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostConversationsMessagingIntegrationsTwitter invokes POST /api/v2/conversations/messaging/integrations/twitter -// -// Create a Twitter Integration -// -// -func (a ConversationsApi) PostConversationsMessagingIntegrationsTwitter(body Twitterintegrationrequest, async bool) (*Twitterintegration, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/messaging/integrations/twitter" - defaultReturn := new(Twitterintegration) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PostConversationsMessagingIntegrationsTwitter") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(async).(string); ok { - if str != "" { - queryParams["async"] = a.Configuration.APIClient.ParameterToString(async, collectionFormat) - } - } else { - queryParams["async"] = a.Configuration.APIClient.ParameterToString(async, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Twitterintegration - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostConversationsMessagingIntegrationsWhatsapp invokes POST /api/v2/conversations/messaging/integrations/whatsapp -// -// Create a WhatsApp Integration -// -// You must be approved by WhatsApp to use this feature. Your approved e164-formatted phone number and valid WhatsApp certificate for your number are required. Your WhatsApp certificate must have valid base64 encoding. Please paste carefully and do not add any leading or trailing spaces. Do not alter any characters. An integration must be activated within 7 days of certificate generation. If you cannot complete the addition and activation of the number within 7 days, please obtain a new certificate before creating the integration. Integrations created with an invalid number or certificate may immediately incur additional integration fees. Please carefully enter your number and certificate as described. -func (a ConversationsApi) PostConversationsMessagingIntegrationsWhatsapp(body Whatsappintegrationrequest, async bool) (*Whatsappintegration, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/messaging/integrations/whatsapp" - defaultReturn := new(Whatsappintegration) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PostConversationsMessagingIntegrationsWhatsapp") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(async).(string); ok { - if str != "" { - queryParams["async"] = a.Configuration.APIClient.ParameterToString(async, collectionFormat) - } - } else { - queryParams["async"] = a.Configuration.APIClient.ParameterToString(async, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Whatsappintegration - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutConversationParticipantFlaggedreason invokes PUT /api/v2/conversations/{conversationId}/participants/{participantId}/flaggedreason -// -// Set flagged reason on conversation participant to indicate bad conversation quality. -// -// -func (a ConversationsApi) PutConversationParticipantFlaggedreason(conversationId string, participantId string) (*APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/{conversationId}/participants/{participantId}/flaggedreason" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PutConversationParticipantFlaggedreason") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->PutConversationParticipantFlaggedreason") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// PutConversationsCallParticipantCommunicationUuidata invokes PUT /api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}/uuidata -// -// Set uuiData to be sent on future commands. -// -// -func (a ConversationsApi) PutConversationsCallParticipantCommunicationUuidata(conversationId string, participantId string, communicationId string, body Setuuidatarequest) (*Empty, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}/uuidata" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{participantId}", fmt.Sprintf("%v", participantId), -1) - path = strings.Replace(path, "{communicationId}", fmt.Sprintf("%v", communicationId), -1) - defaultReturn := new(Empty) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PutConversationsCallParticipantCommunicationUuidata") - } - // verify the required parameter 'participantId' is set - if &participantId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'participantId' when calling ConversationsApi->PutConversationsCallParticipantCommunicationUuidata") - } - // verify the required parameter 'communicationId' is set - if &communicationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'communicationId' when calling ConversationsApi->PutConversationsCallParticipantCommunicationUuidata") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PutConversationsCallParticipantCommunicationUuidata") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Empty - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutConversationsEmailMessagesDraft invokes PUT /api/v2/conversations/emails/{conversationId}/messages/draft -// -// Update conversation draft reply -// -// -func (a ConversationsApi) PutConversationsEmailMessagesDraft(conversationId string, body Emailmessage) (*Emailmessage, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/emails/{conversationId}/messages/draft" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - defaultReturn := new(Emailmessage) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling ConversationsApi->PutConversationsEmailMessagesDraft") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PutConversationsEmailMessagesDraft") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Emailmessage - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutConversationsMessagingIntegrationsLineIntegrationId invokes PUT /api/v2/conversations/messaging/integrations/line/{integrationId} -// -// Update a LINE messenger integration -// -// -func (a ConversationsApi) PutConversationsMessagingIntegrationsLineIntegrationId(integrationId string, body Lineintegrationrequest) (*Lineintegration, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/messaging/integrations/line/{integrationId}" - path = strings.Replace(path, "{integrationId}", fmt.Sprintf("%v", integrationId), -1) - defaultReturn := new(Lineintegration) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'integrationId' is set - if &integrationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'integrationId' when calling ConversationsApi->PutConversationsMessagingIntegrationsLineIntegrationId") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ConversationsApi->PutConversationsMessagingIntegrationsLineIntegrationId") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Lineintegration - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/conversationscreenshareeventtopicconversationroutingdata.go b/build/platformclientv2/conversationscreenshareeventtopicconversationroutingdata.go deleted file mode 100644 index 4bf460cff..000000000 --- a/build/platformclientv2/conversationscreenshareeventtopicconversationroutingdata.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationscreenshareeventtopicconversationroutingdata -type Conversationscreenshareeventtopicconversationroutingdata struct { - // Queue - Queue *Conversationscreenshareeventtopicurireference `json:"queue,omitempty"` - - - // Language - Language *Conversationscreenshareeventtopicurireference `json:"language,omitempty"` - - - // Priority - Priority *int `json:"priority,omitempty"` - - - // Skills - Skills *[]Conversationscreenshareeventtopicurireference `json:"skills,omitempty"` - - - // ScoredAgents - ScoredAgents *[]Conversationscreenshareeventtopicscoredagent `json:"scoredAgents,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationscreenshareeventtopicconversationroutingdata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationscreenshareeventtopicdetail.go b/build/platformclientv2/conversationscreenshareeventtopicdetail.go deleted file mode 100644 index 05990733b..000000000 --- a/build/platformclientv2/conversationscreenshareeventtopicdetail.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationscreenshareeventtopicdetail -type Conversationscreenshareeventtopicdetail struct { - // ErrorCode - ErrorCode *string `json:"errorCode,omitempty"` - - - // FieldName - FieldName *string `json:"fieldName,omitempty"` - - - // EntityId - EntityId *string `json:"entityId,omitempty"` - - - // EntityName - EntityName *string `json:"entityName,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationscreenshareeventtopicdetail) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationscreenshareeventtopicerrorbody.go b/build/platformclientv2/conversationscreenshareeventtopicerrorbody.go deleted file mode 100644 index 1a28406e0..000000000 --- a/build/platformclientv2/conversationscreenshareeventtopicerrorbody.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationscreenshareeventtopicerrorbody -type Conversationscreenshareeventtopicerrorbody struct { - // Status - Status *int `json:"status,omitempty"` - - - // Code - Code *string `json:"code,omitempty"` - - - // EntityId - EntityId *string `json:"entityId,omitempty"` - - - // EntityName - EntityName *string `json:"entityName,omitempty"` - - - // Message - Message *string `json:"message,omitempty"` - - - // MessageWithParams - MessageWithParams *string `json:"messageWithParams,omitempty"` - - - // MessageParams - MessageParams *map[string]string `json:"messageParams,omitempty"` - - - // ContextId - ContextId *string `json:"contextId,omitempty"` - - - // Details - Details *[]Conversationscreenshareeventtopicdetail `json:"details,omitempty"` - - - // Errors - Errors *[]Conversationscreenshareeventtopicerrorbody `json:"errors,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationscreenshareeventtopicerrorbody) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationscreenshareeventtopicjourneyaction.go b/build/platformclientv2/conversationscreenshareeventtopicjourneyaction.go deleted file mode 100644 index 9cccebed9..000000000 --- a/build/platformclientv2/conversationscreenshareeventtopicjourneyaction.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationscreenshareeventtopicjourneyaction -type Conversationscreenshareeventtopicjourneyaction struct { - // Id - Id *string `json:"id,omitempty"` - - - // ActionMap - ActionMap *Conversationscreenshareeventtopicjourneyactionmap `json:"actionMap,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationscreenshareeventtopicjourneyaction) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationscreenshareeventtopicjourneyactionmap.go b/build/platformclientv2/conversationscreenshareeventtopicjourneyactionmap.go deleted file mode 100644 index bb55f4b08..000000000 --- a/build/platformclientv2/conversationscreenshareeventtopicjourneyactionmap.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationscreenshareeventtopicjourneyactionmap -type Conversationscreenshareeventtopicjourneyactionmap struct { - // Id - Id *string `json:"id,omitempty"` - - - // Version - Version *int `json:"version,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationscreenshareeventtopicjourneyactionmap) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationscreenshareeventtopicjourneycontext.go b/build/platformclientv2/conversationscreenshareeventtopicjourneycontext.go deleted file mode 100644 index becf15614..000000000 --- a/build/platformclientv2/conversationscreenshareeventtopicjourneycontext.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationscreenshareeventtopicjourneycontext -type Conversationscreenshareeventtopicjourneycontext struct { - // Customer - Customer *Conversationscreenshareeventtopicjourneycustomer `json:"customer,omitempty"` - - - // CustomerSession - CustomerSession *Conversationscreenshareeventtopicjourneycustomersession `json:"customerSession,omitempty"` - - - // TriggeringAction - TriggeringAction *Conversationscreenshareeventtopicjourneyaction `json:"triggeringAction,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationscreenshareeventtopicjourneycontext) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationscreenshareeventtopicjourneycustomer.go b/build/platformclientv2/conversationscreenshareeventtopicjourneycustomer.go deleted file mode 100644 index 2333b85d5..000000000 --- a/build/platformclientv2/conversationscreenshareeventtopicjourneycustomer.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationscreenshareeventtopicjourneycustomer -type Conversationscreenshareeventtopicjourneycustomer struct { - // Id - Id *string `json:"id,omitempty"` - - - // IdType - IdType *string `json:"idType,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationscreenshareeventtopicjourneycustomer) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationscreenshareeventtopicjourneycustomersession.go b/build/platformclientv2/conversationscreenshareeventtopicjourneycustomersession.go deleted file mode 100644 index 9cf8a3991..000000000 --- a/build/platformclientv2/conversationscreenshareeventtopicjourneycustomersession.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationscreenshareeventtopicjourneycustomersession -type Conversationscreenshareeventtopicjourneycustomersession struct { - // Id - Id *string `json:"id,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationscreenshareeventtopicjourneycustomersession) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationscreenshareeventtopicscoredagent.go b/build/platformclientv2/conversationscreenshareeventtopicscoredagent.go deleted file mode 100644 index f27b77962..000000000 --- a/build/platformclientv2/conversationscreenshareeventtopicscoredagent.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationscreenshareeventtopicscoredagent -type Conversationscreenshareeventtopicscoredagent struct { - // Agent - Agent *Conversationscreenshareeventtopicurireference `json:"agent,omitempty"` - - - // Score - Score *int `json:"score,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationscreenshareeventtopicscoredagent) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationscreenshareeventtopicscreenshareconversation.go b/build/platformclientv2/conversationscreenshareeventtopicscreenshareconversation.go deleted file mode 100644 index 82a28d1b5..000000000 --- a/build/platformclientv2/conversationscreenshareeventtopicscreenshareconversation.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationscreenshareeventtopicscreenshareconversation -type Conversationscreenshareeventtopicscreenshareconversation struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Participants - Participants *[]Conversationscreenshareeventtopicscreensharemediaparticipant `json:"participants,omitempty"` - - - // OtherMediaUris - OtherMediaUris *[]string `json:"otherMediaUris,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationscreenshareeventtopicscreenshareconversation) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationscreenshareeventtopicscreensharemediaparticipant.go b/build/platformclientv2/conversationscreenshareeventtopicscreensharemediaparticipant.go deleted file mode 100644 index f450abb39..000000000 --- a/build/platformclientv2/conversationscreenshareeventtopicscreensharemediaparticipant.go +++ /dev/null @@ -1,162 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Conversationscreenshareeventtopicscreensharemediaparticipant -type Conversationscreenshareeventtopicscreensharemediaparticipant struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Address - Address *string `json:"address,omitempty"` - - - // StartTime - StartTime *time.Time `json:"startTime,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // EndTime - EndTime *time.Time `json:"endTime,omitempty"` - - - // StartHoldTime - StartHoldTime *time.Time `json:"startHoldTime,omitempty"` - - - // Purpose - Purpose *string `json:"purpose,omitempty"` - - - // State - State *string `json:"state,omitempty"` - - - // Direction - Direction *string `json:"direction,omitempty"` - - - // DisconnectType - DisconnectType *string `json:"disconnectType,omitempty"` - - - // Held - Held *bool `json:"held,omitempty"` - - - // WrapupRequired - WrapupRequired *bool `json:"wrapupRequired,omitempty"` - - - // WrapupPrompt - WrapupPrompt *string `json:"wrapupPrompt,omitempty"` - - - // User - User *Conversationscreenshareeventtopicurireference `json:"user,omitempty"` - - - // Queue - Queue *Conversationscreenshareeventtopicurireference `json:"queue,omitempty"` - - - // Team - Team *Conversationscreenshareeventtopicurireference `json:"team,omitempty"` - - - // Attributes - Attributes *map[string]string `json:"attributes,omitempty"` - - - // ErrorInfo - ErrorInfo *Conversationscreenshareeventtopicerrorbody `json:"errorInfo,omitempty"` - - - // Script - Script *Conversationscreenshareeventtopicurireference `json:"script,omitempty"` - - - // WrapupTimeoutMs - WrapupTimeoutMs *int `json:"wrapupTimeoutMs,omitempty"` - - - // WrapupSkipped - WrapupSkipped *bool `json:"wrapupSkipped,omitempty"` - - - // AlertingTimeoutMs - AlertingTimeoutMs *int `json:"alertingTimeoutMs,omitempty"` - - - // Provider - Provider *string `json:"provider,omitempty"` - - - // ExternalContact - ExternalContact *Conversationscreenshareeventtopicurireference `json:"externalContact,omitempty"` - - - // ExternalOrganization - ExternalOrganization *Conversationscreenshareeventtopicurireference `json:"externalOrganization,omitempty"` - - - // Wrapup - Wrapup *Conversationscreenshareeventtopicwrapup `json:"wrapup,omitempty"` - - - // ConversationRoutingData - ConversationRoutingData *Conversationscreenshareeventtopicconversationroutingdata `json:"conversationRoutingData,omitempty"` - - - // Peer - Peer *string `json:"peer,omitempty"` - - - // ScreenRecordingState - ScreenRecordingState *string `json:"screenRecordingState,omitempty"` - - - // FlaggedReason - FlaggedReason *string `json:"flaggedReason,omitempty"` - - - // JourneyContext - JourneyContext *Conversationscreenshareeventtopicjourneycontext `json:"journeyContext,omitempty"` - - - // StartAcwTime - StartAcwTime *time.Time `json:"startAcwTime,omitempty"` - - - // EndAcwTime - EndAcwTime *time.Time `json:"endAcwTime,omitempty"` - - - // Context - Context *string `json:"context,omitempty"` - - - // PeerCount - PeerCount *int `json:"peerCount,omitempty"` - - - // Sharing - Sharing *bool `json:"sharing,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationscreenshareeventtopicscreensharemediaparticipant) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationscreenshareeventtopicurireference.go b/build/platformclientv2/conversationscreenshareeventtopicurireference.go deleted file mode 100644 index 90d9af2c4..000000000 --- a/build/platformclientv2/conversationscreenshareeventtopicurireference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationscreenshareeventtopicurireference -type Conversationscreenshareeventtopicurireference struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationscreenshareeventtopicurireference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationscreenshareeventtopicwrapup.go b/build/platformclientv2/conversationscreenshareeventtopicwrapup.go deleted file mode 100644 index f2f9dfce3..000000000 --- a/build/platformclientv2/conversationscreenshareeventtopicwrapup.go +++ /dev/null @@ -1,38 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Conversationscreenshareeventtopicwrapup -type Conversationscreenshareeventtopicwrapup struct { - // Code - Code *string `json:"code,omitempty"` - - - // Notes - Notes *string `json:"notes,omitempty"` - - - // Tags - Tags *[]string `json:"tags,omitempty"` - - - // DurationSeconds - DurationSeconds *int `json:"durationSeconds,omitempty"` - - - // EndTime - EndTime *time.Time `json:"endTime,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationscreenshareeventtopicwrapup) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationsocialexpressioneventtopicconversationroutingdata.go b/build/platformclientv2/conversationsocialexpressioneventtopicconversationroutingdata.go deleted file mode 100644 index 5de63bfb2..000000000 --- a/build/platformclientv2/conversationsocialexpressioneventtopicconversationroutingdata.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationsocialexpressioneventtopicconversationroutingdata -type Conversationsocialexpressioneventtopicconversationroutingdata struct { - // Queue - Queue *Conversationsocialexpressioneventtopicurireference `json:"queue,omitempty"` - - - // Language - Language *Conversationsocialexpressioneventtopicurireference `json:"language,omitempty"` - - - // Priority - Priority *int `json:"priority,omitempty"` - - - // Skills - Skills *[]Conversationsocialexpressioneventtopicurireference `json:"skills,omitempty"` - - - // ScoredAgents - ScoredAgents *[]Conversationsocialexpressioneventtopicscoredagent `json:"scoredAgents,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationsocialexpressioneventtopicconversationroutingdata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationsocialexpressioneventtopicdetail.go b/build/platformclientv2/conversationsocialexpressioneventtopicdetail.go deleted file mode 100644 index 58b511f8c..000000000 --- a/build/platformclientv2/conversationsocialexpressioneventtopicdetail.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationsocialexpressioneventtopicdetail -type Conversationsocialexpressioneventtopicdetail struct { - // ErrorCode - ErrorCode *string `json:"errorCode,omitempty"` - - - // FieldName - FieldName *string `json:"fieldName,omitempty"` - - - // EntityId - EntityId *string `json:"entityId,omitempty"` - - - // EntityName - EntityName *string `json:"entityName,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationsocialexpressioneventtopicdetail) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationsocialexpressioneventtopicerrorbody.go b/build/platformclientv2/conversationsocialexpressioneventtopicerrorbody.go deleted file mode 100644 index 11a89ca23..000000000 --- a/build/platformclientv2/conversationsocialexpressioneventtopicerrorbody.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationsocialexpressioneventtopicerrorbody -type Conversationsocialexpressioneventtopicerrorbody struct { - // Status - Status *int `json:"status,omitempty"` - - - // Code - Code *string `json:"code,omitempty"` - - - // EntityId - EntityId *string `json:"entityId,omitempty"` - - - // EntityName - EntityName *string `json:"entityName,omitempty"` - - - // Message - Message *string `json:"message,omitempty"` - - - // MessageWithParams - MessageWithParams *string `json:"messageWithParams,omitempty"` - - - // MessageParams - MessageParams *map[string]string `json:"messageParams,omitempty"` - - - // ContextId - ContextId *string `json:"contextId,omitempty"` - - - // Details - Details *[]Conversationsocialexpressioneventtopicdetail `json:"details,omitempty"` - - - // Errors - Errors *[]Conversationsocialexpressioneventtopicerrorbody `json:"errors,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationsocialexpressioneventtopicerrorbody) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationsocialexpressioneventtopicjourneyaction.go b/build/platformclientv2/conversationsocialexpressioneventtopicjourneyaction.go deleted file mode 100644 index 1d74224f2..000000000 --- a/build/platformclientv2/conversationsocialexpressioneventtopicjourneyaction.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationsocialexpressioneventtopicjourneyaction -type Conversationsocialexpressioneventtopicjourneyaction struct { - // Id - Id *string `json:"id,omitempty"` - - - // ActionMap - ActionMap *Conversationsocialexpressioneventtopicjourneyactionmap `json:"actionMap,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationsocialexpressioneventtopicjourneyaction) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationsocialexpressioneventtopicjourneyactionmap.go b/build/platformclientv2/conversationsocialexpressioneventtopicjourneyactionmap.go deleted file mode 100644 index 5ba59e0c8..000000000 --- a/build/platformclientv2/conversationsocialexpressioneventtopicjourneyactionmap.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationsocialexpressioneventtopicjourneyactionmap -type Conversationsocialexpressioneventtopicjourneyactionmap struct { - // Id - Id *string `json:"id,omitempty"` - - - // Version - Version *int `json:"version,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationsocialexpressioneventtopicjourneyactionmap) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationsocialexpressioneventtopicjourneycontext.go b/build/platformclientv2/conversationsocialexpressioneventtopicjourneycontext.go deleted file mode 100644 index c4e676383..000000000 --- a/build/platformclientv2/conversationsocialexpressioneventtopicjourneycontext.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationsocialexpressioneventtopicjourneycontext -type Conversationsocialexpressioneventtopicjourneycontext struct { - // Customer - Customer *Conversationsocialexpressioneventtopicjourneycustomer `json:"customer,omitempty"` - - - // CustomerSession - CustomerSession *Conversationsocialexpressioneventtopicjourneycustomersession `json:"customerSession,omitempty"` - - - // TriggeringAction - TriggeringAction *Conversationsocialexpressioneventtopicjourneyaction `json:"triggeringAction,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationsocialexpressioneventtopicjourneycontext) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationsocialexpressioneventtopicjourneycustomer.go b/build/platformclientv2/conversationsocialexpressioneventtopicjourneycustomer.go deleted file mode 100644 index 6d7b038e1..000000000 --- a/build/platformclientv2/conversationsocialexpressioneventtopicjourneycustomer.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationsocialexpressioneventtopicjourneycustomer -type Conversationsocialexpressioneventtopicjourneycustomer struct { - // Id - Id *string `json:"id,omitempty"` - - - // IdType - IdType *string `json:"idType,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationsocialexpressioneventtopicjourneycustomer) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationsocialexpressioneventtopicjourneycustomersession.go b/build/platformclientv2/conversationsocialexpressioneventtopicjourneycustomersession.go deleted file mode 100644 index 8c9faab05..000000000 --- a/build/platformclientv2/conversationsocialexpressioneventtopicjourneycustomersession.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationsocialexpressioneventtopicjourneycustomersession -type Conversationsocialexpressioneventtopicjourneycustomersession struct { - // Id - Id *string `json:"id,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationsocialexpressioneventtopicjourneycustomersession) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationsocialexpressioneventtopicscoredagent.go b/build/platformclientv2/conversationsocialexpressioneventtopicscoredagent.go deleted file mode 100644 index 5c6634b87..000000000 --- a/build/platformclientv2/conversationsocialexpressioneventtopicscoredagent.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationsocialexpressioneventtopicscoredagent -type Conversationsocialexpressioneventtopicscoredagent struct { - // Agent - Agent *Conversationsocialexpressioneventtopicurireference `json:"agent,omitempty"` - - - // Score - Score *int `json:"score,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationsocialexpressioneventtopicscoredagent) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationsocialexpressioneventtopicsocialconversation.go b/build/platformclientv2/conversationsocialexpressioneventtopicsocialconversation.go deleted file mode 100644 index 22ce884c6..000000000 --- a/build/platformclientv2/conversationsocialexpressioneventtopicsocialconversation.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationsocialexpressioneventtopicsocialconversation -type Conversationsocialexpressioneventtopicsocialconversation struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Participants - Participants *[]Conversationsocialexpressioneventtopicsocialmediaparticipant `json:"participants,omitempty"` - - - // OtherMediaUris - OtherMediaUris *[]string `json:"otherMediaUris,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationsocialexpressioneventtopicsocialconversation) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationsocialexpressioneventtopicsocialmediaparticipant.go b/build/platformclientv2/conversationsocialexpressioneventtopicsocialmediaparticipant.go deleted file mode 100644 index 99d7b6ee4..000000000 --- a/build/platformclientv2/conversationsocialexpressioneventtopicsocialmediaparticipant.go +++ /dev/null @@ -1,166 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Conversationsocialexpressioneventtopicsocialmediaparticipant -type Conversationsocialexpressioneventtopicsocialmediaparticipant struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Address - Address *string `json:"address,omitempty"` - - - // StartTime - StartTime *time.Time `json:"startTime,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // EndTime - EndTime *time.Time `json:"endTime,omitempty"` - - - // StartHoldTime - StartHoldTime *time.Time `json:"startHoldTime,omitempty"` - - - // Purpose - Purpose *string `json:"purpose,omitempty"` - - - // State - State *string `json:"state,omitempty"` - - - // Direction - Direction *string `json:"direction,omitempty"` - - - // DisconnectType - DisconnectType *string `json:"disconnectType,omitempty"` - - - // Held - Held *bool `json:"held,omitempty"` - - - // WrapupRequired - WrapupRequired *bool `json:"wrapupRequired,omitempty"` - - - // WrapupPrompt - WrapupPrompt *string `json:"wrapupPrompt,omitempty"` - - - // User - User *Conversationsocialexpressioneventtopicurireference `json:"user,omitempty"` - - - // Queue - Queue *Conversationsocialexpressioneventtopicurireference `json:"queue,omitempty"` - - - // Team - Team *Conversationsocialexpressioneventtopicurireference `json:"team,omitempty"` - - - // Attributes - Attributes *map[string]string `json:"attributes,omitempty"` - - - // ErrorInfo - ErrorInfo *Conversationsocialexpressioneventtopicerrorbody `json:"errorInfo,omitempty"` - - - // Script - Script *Conversationsocialexpressioneventtopicurireference `json:"script,omitempty"` - - - // WrapupTimeoutMs - WrapupTimeoutMs *int `json:"wrapupTimeoutMs,omitempty"` - - - // WrapupSkipped - WrapupSkipped *bool `json:"wrapupSkipped,omitempty"` - - - // AlertingTimeoutMs - AlertingTimeoutMs *int `json:"alertingTimeoutMs,omitempty"` - - - // Provider - Provider *string `json:"provider,omitempty"` - - - // ExternalContact - ExternalContact *Conversationsocialexpressioneventtopicurireference `json:"externalContact,omitempty"` - - - // ExternalOrganization - ExternalOrganization *Conversationsocialexpressioneventtopicurireference `json:"externalOrganization,omitempty"` - - - // Wrapup - Wrapup *Conversationsocialexpressioneventtopicwrapup `json:"wrapup,omitempty"` - - - // ConversationRoutingData - ConversationRoutingData *Conversationsocialexpressioneventtopicconversationroutingdata `json:"conversationRoutingData,omitempty"` - - - // Peer - Peer *string `json:"peer,omitempty"` - - - // ScreenRecordingState - ScreenRecordingState *string `json:"screenRecordingState,omitempty"` - - - // FlaggedReason - FlaggedReason *string `json:"flaggedReason,omitempty"` - - - // JourneyContext - JourneyContext *Conversationsocialexpressioneventtopicjourneycontext `json:"journeyContext,omitempty"` - - - // StartAcwTime - StartAcwTime *time.Time `json:"startAcwTime,omitempty"` - - - // EndAcwTime - EndAcwTime *time.Time `json:"endAcwTime,omitempty"` - - - // SocialMediaId - SocialMediaId *string `json:"socialMediaId,omitempty"` - - - // SocialMediaHub - SocialMediaHub *string `json:"socialMediaHub,omitempty"` - - - // SocialUserName - SocialUserName *string `json:"socialUserName,omitempty"` - - - // PreviewText - PreviewText *string `json:"previewText,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationsocialexpressioneventtopicsocialmediaparticipant) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationsocialexpressioneventtopicurireference.go b/build/platformclientv2/conversationsocialexpressioneventtopicurireference.go deleted file mode 100644 index 8ba2537ae..000000000 --- a/build/platformclientv2/conversationsocialexpressioneventtopicurireference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationsocialexpressioneventtopicurireference -type Conversationsocialexpressioneventtopicurireference struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationsocialexpressioneventtopicurireference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationsocialexpressioneventtopicwrapup.go b/build/platformclientv2/conversationsocialexpressioneventtopicwrapup.go deleted file mode 100644 index 24ec85376..000000000 --- a/build/platformclientv2/conversationsocialexpressioneventtopicwrapup.go +++ /dev/null @@ -1,38 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Conversationsocialexpressioneventtopicwrapup -type Conversationsocialexpressioneventtopicwrapup struct { - // Code - Code *string `json:"code,omitempty"` - - - // Notes - Notes *string `json:"notes,omitempty"` - - - // Tags - Tags *[]string `json:"tags,omitempty"` - - - // DurationSeconds - DurationSeconds *int `json:"durationSeconds,omitempty"` - - - // EndTime - EndTime *time.Time `json:"endTime,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationsocialexpressioneventtopicwrapup) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationuser.go b/build/platformclientv2/conversationuser.go deleted file mode 100644 index 82234f193..000000000 --- a/build/platformclientv2/conversationuser.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationuser -type Conversationuser struct { - // Id - The globally unique identifier for this user. - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationuser) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationvideoeventtopicconversationroutingdata.go b/build/platformclientv2/conversationvideoeventtopicconversationroutingdata.go deleted file mode 100644 index d89c72e93..000000000 --- a/build/platformclientv2/conversationvideoeventtopicconversationroutingdata.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationvideoeventtopicconversationroutingdata -type Conversationvideoeventtopicconversationroutingdata struct { - // Queue - Queue *Conversationvideoeventtopicurireference `json:"queue,omitempty"` - - - // Language - Language *Conversationvideoeventtopicurireference `json:"language,omitempty"` - - - // Priority - Priority *int `json:"priority,omitempty"` - - - // Skills - Skills *[]Conversationvideoeventtopicurireference `json:"skills,omitempty"` - - - // ScoredAgents - ScoredAgents *[]Conversationvideoeventtopicscoredagent `json:"scoredAgents,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationvideoeventtopicconversationroutingdata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationvideoeventtopicdetail.go b/build/platformclientv2/conversationvideoeventtopicdetail.go deleted file mode 100644 index f4203397c..000000000 --- a/build/platformclientv2/conversationvideoeventtopicdetail.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationvideoeventtopicdetail -type Conversationvideoeventtopicdetail struct { - // ErrorCode - ErrorCode *string `json:"errorCode,omitempty"` - - - // FieldName - FieldName *string `json:"fieldName,omitempty"` - - - // EntityId - EntityId *string `json:"entityId,omitempty"` - - - // EntityName - EntityName *string `json:"entityName,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationvideoeventtopicdetail) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationvideoeventtopicerrorbody.go b/build/platformclientv2/conversationvideoeventtopicerrorbody.go deleted file mode 100644 index 2df5e16f1..000000000 --- a/build/platformclientv2/conversationvideoeventtopicerrorbody.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationvideoeventtopicerrorbody -type Conversationvideoeventtopicerrorbody struct { - // Status - Status *int `json:"status,omitempty"` - - - // Code - Code *string `json:"code,omitempty"` - - - // EntityId - EntityId *string `json:"entityId,omitempty"` - - - // EntityName - EntityName *string `json:"entityName,omitempty"` - - - // Message - Message *string `json:"message,omitempty"` - - - // MessageWithParams - MessageWithParams *string `json:"messageWithParams,omitempty"` - - - // MessageParams - MessageParams *map[string]string `json:"messageParams,omitempty"` - - - // ContextId - ContextId *string `json:"contextId,omitempty"` - - - // Details - Details *[]Conversationvideoeventtopicdetail `json:"details,omitempty"` - - - // Errors - Errors *[]Conversationvideoeventtopicerrorbody `json:"errors,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationvideoeventtopicerrorbody) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationvideoeventtopicjourneyaction.go b/build/platformclientv2/conversationvideoeventtopicjourneyaction.go deleted file mode 100644 index dafaf9973..000000000 --- a/build/platformclientv2/conversationvideoeventtopicjourneyaction.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationvideoeventtopicjourneyaction -type Conversationvideoeventtopicjourneyaction struct { - // Id - Id *string `json:"id,omitempty"` - - - // ActionMap - ActionMap *Conversationvideoeventtopicjourneyactionmap `json:"actionMap,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationvideoeventtopicjourneyaction) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationvideoeventtopicjourneyactionmap.go b/build/platformclientv2/conversationvideoeventtopicjourneyactionmap.go deleted file mode 100644 index 6453ccd5b..000000000 --- a/build/platformclientv2/conversationvideoeventtopicjourneyactionmap.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationvideoeventtopicjourneyactionmap -type Conversationvideoeventtopicjourneyactionmap struct { - // Id - Id *string `json:"id,omitempty"` - - - // Version - Version *int `json:"version,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationvideoeventtopicjourneyactionmap) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationvideoeventtopicjourneycontext.go b/build/platformclientv2/conversationvideoeventtopicjourneycontext.go deleted file mode 100644 index e47ae1aa1..000000000 --- a/build/platformclientv2/conversationvideoeventtopicjourneycontext.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationvideoeventtopicjourneycontext -type Conversationvideoeventtopicjourneycontext struct { - // Customer - Customer *Conversationvideoeventtopicjourneycustomer `json:"customer,omitempty"` - - - // CustomerSession - CustomerSession *Conversationvideoeventtopicjourneycustomersession `json:"customerSession,omitempty"` - - - // TriggeringAction - TriggeringAction *Conversationvideoeventtopicjourneyaction `json:"triggeringAction,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationvideoeventtopicjourneycontext) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationvideoeventtopicjourneycustomer.go b/build/platformclientv2/conversationvideoeventtopicjourneycustomer.go deleted file mode 100644 index 4f40af35c..000000000 --- a/build/platformclientv2/conversationvideoeventtopicjourneycustomer.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationvideoeventtopicjourneycustomer -type Conversationvideoeventtopicjourneycustomer struct { - // Id - Id *string `json:"id,omitempty"` - - - // IdType - IdType *string `json:"idType,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationvideoeventtopicjourneycustomer) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationvideoeventtopicjourneycustomersession.go b/build/platformclientv2/conversationvideoeventtopicjourneycustomersession.go deleted file mode 100644 index f4fda2bc6..000000000 --- a/build/platformclientv2/conversationvideoeventtopicjourneycustomersession.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationvideoeventtopicjourneycustomersession -type Conversationvideoeventtopicjourneycustomersession struct { - // Id - Id *string `json:"id,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationvideoeventtopicjourneycustomersession) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationvideoeventtopicscoredagent.go b/build/platformclientv2/conversationvideoeventtopicscoredagent.go deleted file mode 100644 index 1b352c897..000000000 --- a/build/platformclientv2/conversationvideoeventtopicscoredagent.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationvideoeventtopicscoredagent -type Conversationvideoeventtopicscoredagent struct { - // Agent - Agent *Conversationvideoeventtopicurireference `json:"agent,omitempty"` - - - // Score - Score *int `json:"score,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationvideoeventtopicscoredagent) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationvideoeventtopicurireference.go b/build/platformclientv2/conversationvideoeventtopicurireference.go deleted file mode 100644 index a66718ee7..000000000 --- a/build/platformclientv2/conversationvideoeventtopicurireference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationvideoeventtopicurireference -type Conversationvideoeventtopicurireference struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationvideoeventtopicurireference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationvideoeventtopicvideoconversation.go b/build/platformclientv2/conversationvideoeventtopicvideoconversation.go deleted file mode 100644 index 697134e39..000000000 --- a/build/platformclientv2/conversationvideoeventtopicvideoconversation.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Conversationvideoeventtopicvideoconversation -type Conversationvideoeventtopicvideoconversation struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Participants - Participants *[]Conversationvideoeventtopicvideomediaparticipant `json:"participants,omitempty"` - - - // OtherMediaUris - OtherMediaUris *[]string `json:"otherMediaUris,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationvideoeventtopicvideoconversation) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationvideoeventtopicvideomediaparticipant.go b/build/platformclientv2/conversationvideoeventtopicvideomediaparticipant.go deleted file mode 100644 index b85273e77..000000000 --- a/build/platformclientv2/conversationvideoeventtopicvideomediaparticipant.go +++ /dev/null @@ -1,174 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Conversationvideoeventtopicvideomediaparticipant -type Conversationvideoeventtopicvideomediaparticipant struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Address - Address *string `json:"address,omitempty"` - - - // StartTime - StartTime *time.Time `json:"startTime,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // EndTime - EndTime *time.Time `json:"endTime,omitempty"` - - - // StartHoldTime - StartHoldTime *time.Time `json:"startHoldTime,omitempty"` - - - // Purpose - Purpose *string `json:"purpose,omitempty"` - - - // State - State *string `json:"state,omitempty"` - - - // Direction - Direction *string `json:"direction,omitempty"` - - - // DisconnectType - DisconnectType *string `json:"disconnectType,omitempty"` - - - // Held - Held *bool `json:"held,omitempty"` - - - // WrapupRequired - WrapupRequired *bool `json:"wrapupRequired,omitempty"` - - - // WrapupPrompt - WrapupPrompt *string `json:"wrapupPrompt,omitempty"` - - - // User - User *Conversationvideoeventtopicurireference `json:"user,omitempty"` - - - // Queue - Queue *Conversationvideoeventtopicurireference `json:"queue,omitempty"` - - - // Team - Team *Conversationvideoeventtopicurireference `json:"team,omitempty"` - - - // Attributes - Attributes *map[string]string `json:"attributes,omitempty"` - - - // ErrorInfo - ErrorInfo *Conversationvideoeventtopicerrorbody `json:"errorInfo,omitempty"` - - - // Script - Script *Conversationvideoeventtopicurireference `json:"script,omitempty"` - - - // WrapupTimeoutMs - WrapupTimeoutMs *int `json:"wrapupTimeoutMs,omitempty"` - - - // WrapupSkipped - WrapupSkipped *bool `json:"wrapupSkipped,omitempty"` - - - // AlertingTimeoutMs - AlertingTimeoutMs *int `json:"alertingTimeoutMs,omitempty"` - - - // Provider - Provider *string `json:"provider,omitempty"` - - - // ExternalContact - ExternalContact *Conversationvideoeventtopicurireference `json:"externalContact,omitempty"` - - - // ExternalOrganization - ExternalOrganization *Conversationvideoeventtopicurireference `json:"externalOrganization,omitempty"` - - - // Wrapup - Wrapup *Conversationvideoeventtopicwrapup `json:"wrapup,omitempty"` - - - // ConversationRoutingData - ConversationRoutingData *Conversationvideoeventtopicconversationroutingdata `json:"conversationRoutingData,omitempty"` - - - // Peer - Peer *string `json:"peer,omitempty"` - - - // ScreenRecordingState - ScreenRecordingState *string `json:"screenRecordingState,omitempty"` - - - // FlaggedReason - FlaggedReason *string `json:"flaggedReason,omitempty"` - - - // JourneyContext - JourneyContext *Conversationvideoeventtopicjourneycontext `json:"journeyContext,omitempty"` - - - // StartAcwTime - StartAcwTime *time.Time `json:"startAcwTime,omitempty"` - - - // EndAcwTime - EndAcwTime *time.Time `json:"endAcwTime,omitempty"` - - - // AudioMuted - AudioMuted *bool `json:"audioMuted,omitempty"` - - - // VideoMuted - VideoMuted *bool `json:"videoMuted,omitempty"` - - - // SharingScreen - SharingScreen *bool `json:"sharingScreen,omitempty"` - - - // PeerCount - PeerCount *int `json:"peerCount,omitempty"` - - - // Context - Context *string `json:"context,omitempty"` - - - // Msids - Msids *[]string `json:"msids,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationvideoeventtopicvideomediaparticipant) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/conversationvideoeventtopicwrapup.go b/build/platformclientv2/conversationvideoeventtopicwrapup.go deleted file mode 100644 index 891f1fb56..000000000 --- a/build/platformclientv2/conversationvideoeventtopicwrapup.go +++ /dev/null @@ -1,38 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Conversationvideoeventtopicwrapup -type Conversationvideoeventtopicwrapup struct { - // Code - Code *string `json:"code,omitempty"` - - - // Notes - Notes *string `json:"notes,omitempty"` - - - // Tags - Tags *[]string `json:"tags,omitempty"` - - - // DurationSeconds - DurationSeconds *int `json:"durationSeconds,omitempty"` - - - // EndTime - EndTime *time.Time `json:"endTime,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Conversationvideoeventtopicwrapup) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/copyattachmentsrequest.go b/build/platformclientv2/copyattachmentsrequest.go deleted file mode 100644 index c4fde06cb..000000000 --- a/build/platformclientv2/copyattachmentsrequest.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Copyattachmentsrequest -type Copyattachmentsrequest struct { - // SourceMessage - A reference to the email message within the current conversation that owns the attachments to be copied - SourceMessage *Domainentityref `json:"sourceMessage,omitempty"` - - - // Attachments - A list of attachments that will be copied from the source message to the current draft - Attachments *[]Attachment `json:"attachments,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Copyattachmentsrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/copybuforecastrequest.go b/build/platformclientv2/copybuforecastrequest.go deleted file mode 100644 index 75a4c746c..000000000 --- a/build/platformclientv2/copybuforecastrequest.go +++ /dev/null @@ -1,22 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Copybuforecastrequest -type Copybuforecastrequest struct { - // Description - The description for the forecast - Description *string `json:"description,omitempty"` - - - // WeekDate - The start date of the new forecast to create from the existing forecast. Must correspond to the start day of week for the business unit. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd - WeekDate *time.Time `json:"weekDate,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Copybuforecastrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/copyvoicemailmessage.go b/build/platformclientv2/copyvoicemailmessage.go deleted file mode 100644 index d24a613e5..000000000 --- a/build/platformclientv2/copyvoicemailmessage.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Copyvoicemailmessage - Used to copy a VoicemailMessage to either a User or a Group -type Copyvoicemailmessage struct { - // VoicemailMessageId - The id of the VoicemailMessage to copy - VoicemailMessageId *string `json:"voicemailMessageId,omitempty"` - - - // UserId - The id of the User to copy the VoicemailMessage to - UserId *string `json:"userId,omitempty"` - - - // GroupId - The id of the Group to copy the VoicemailMessage to - GroupId *string `json:"groupId,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Copyvoicemailmessage) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/copyworkplan.go b/build/platformclientv2/copyworkplan.go deleted file mode 100644 index dab847262..000000000 --- a/build/platformclientv2/copyworkplan.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Copyworkplan - Information associated with a work plan thats created as a copy -type Copyworkplan struct { - // Name - Name of the copied work plan - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Copyworkplan) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/copyworkplanrotationrequest.go b/build/platformclientv2/copyworkplanrotationrequest.go deleted file mode 100644 index 958584443..000000000 --- a/build/platformclientv2/copyworkplanrotationrequest.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Copyworkplanrotationrequest -type Copyworkplanrotationrequest struct { - // Name - Name to apply to the new copy of the work plan rotation - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Copyworkplanrotationrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/coretype.go b/build/platformclientv2/coretype.go deleted file mode 100644 index 54ec48d10..000000000 --- a/build/platformclientv2/coretype.go +++ /dev/null @@ -1,58 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Coretype -type Coretype struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Version - A positive integer denoting the core type's version - Version *int `json:"version,omitempty"` - - - // DateCreated - The date the core type was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // Schema - The core type's built-in schema - Schema *Schema `json:"schema,omitempty"` - - - // Current - A boolean indicating if the core type's version is the current one in use by the system - Current *bool `json:"current,omitempty"` - - - // ValidationFields - An array of strings naming the fields of the core type subject to validation. Validation constraints are specified by a schema author using the core type. - ValidationFields *[]string `json:"validationFields,omitempty"` - - - // ValidationLimits - A structure denoting the system-imposed minimum and maximum string length (for text-based core types) or numeric values (for number-based) core types. For example, the validationLimits for a text-based core type specify the min/max values for a minimum string length (minLength) constraint supplied by a schemaauthor on a text field. Similarly, the maxLength's min/max specifies maximum string length constraint supplied by a schema author for the same field. - ValidationLimits *Validationlimits `json:"validationLimits,omitempty"` - - - // ItemValidationFields - Specific to the \"tag\" core type, this is an array of strings naming the tag item fields of the core type subject to validation - ItemValidationFields *[]string `json:"itemValidationFields,omitempty"` - - - // ItemValidationLimits - A structure denoting the system-imposed minimum and maximum string length for string-array based core types such as \"tag\" and \"enum\". Forexample, the validationLimits for a schema field using a tag core type specify the min/max values for a minimum string length (minLength) constraint supplied by a schema author on individual tags. Similarly, the maxLength's min/max specifies maximum string length constraint supplied by a schema author for the same field's tags. - ItemValidationLimits *Itemvalidationlimits `json:"itemValidationLimits,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Coretype) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/coretypelisting.go b/build/platformclientv2/coretypelisting.go deleted file mode 100644 index 23d942fee..000000000 --- a/build/platformclientv2/coretypelisting.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Coretypelisting -type Coretypelisting struct { - // Total - Total *int `json:"total,omitempty"` - - - // Entities - Entities *[]Coretype `json:"entities,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Coretypelisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/coversheet.go b/build/platformclientv2/coversheet.go deleted file mode 100644 index dadad2c34..000000000 --- a/build/platformclientv2/coversheet.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Coversheet -type Coversheet struct { - // Notes - Text to be added to the coversheet - Notes *string `json:"notes,omitempty"` - - - // Locale - Locale, e.g. = en-US - Locale *string `json:"locale,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Coversheet) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/createactivitycoderequest.go b/build/platformclientv2/createactivitycoderequest.go deleted file mode 100644 index c81fa7326..000000000 --- a/build/platformclientv2/createactivitycoderequest.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Createactivitycoderequest - Activity Code -type Createactivitycoderequest struct { - // Name - The name of the activity code - Name *string `json:"name,omitempty"` - - - // Category - The activity code's category - Category *string `json:"category,omitempty"` - - - // LengthInMinutes - The default length of the activity in minutes - LengthInMinutes *int `json:"lengthInMinutes,omitempty"` - - - // CountsAsPaidTime - Whether an agent is paid while performing this activity - CountsAsPaidTime *bool `json:"countsAsPaidTime,omitempty"` - - - // CountsAsWorkTime - Indicates whether or not the activity should be counted as work time - CountsAsWorkTime *bool `json:"countsAsWorkTime,omitempty"` - - - // AgentTimeOffSelectable - Whether an agent can select this activity code when creating or editing a time off request - AgentTimeOffSelectable *bool `json:"agentTimeOffSelectable,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Createactivitycoderequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/createadmintimeoffrequest.go b/build/platformclientv2/createadmintimeoffrequest.go deleted file mode 100644 index 4b003128e..000000000 --- a/build/platformclientv2/createadmintimeoffrequest.go +++ /dev/null @@ -1,42 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Createadmintimeoffrequest -type Createadmintimeoffrequest struct { - // Status - The status of this time off request - Status *string `json:"status,omitempty"` - - - // Users - A set of IDs for users to associate with this time off request - Users *[]Userreference `json:"users,omitempty"` - - - // ActivityCodeId - The ID of the activity code associated with this time off request. Activity code must be of the TimeOff category - ActivityCodeId *string `json:"activityCodeId,omitempty"` - - - // Notes - Notes about the time off request - Notes *string `json:"notes,omitempty"` - - - // FullDayManagementUnitDates - A set of dates in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone. - FullDayManagementUnitDates *[]string `json:"fullDayManagementUnitDates,omitempty"` - - - // PartialDayStartDateTimes - A set of start date-times in ISO-8601 format for partial day requests. - PartialDayStartDateTimes *[]time.Time `json:"partialDayStartDateTimes,omitempty"` - - - // DailyDurationMinutes - The daily duration of this time off request in minutes - DailyDurationMinutes *int `json:"dailyDurationMinutes,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Createadmintimeoffrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/createagenttimeoffrequest.go b/build/platformclientv2/createagenttimeoffrequest.go deleted file mode 100644 index 59e263abd..000000000 --- a/build/platformclientv2/createagenttimeoffrequest.go +++ /dev/null @@ -1,34 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Createagenttimeoffrequest -type Createagenttimeoffrequest struct { - // ActivityCodeId - The ID of the activity code associated with this time off request. Activity code must be of the TimeOff category - ActivityCodeId *string `json:"activityCodeId,omitempty"` - - - // Notes - Notes about the time off request - Notes *string `json:"notes,omitempty"` - - - // FullDayManagementUnitDates - A set of dates in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone. - FullDayManagementUnitDates *[]string `json:"fullDayManagementUnitDates,omitempty"` - - - // PartialDayStartDateTimes - A set of start date-times in ISO-8601 format for partial day requests. - PartialDayStartDateTimes *[]time.Time `json:"partialDayStartDateTimes,omitempty"` - - - // DailyDurationMinutes - The daily duration of this time off request in minutes - DailyDurationMinutes *int `json:"dailyDurationMinutes,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Createagenttimeoffrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/createbusinessunitrequest.go b/build/platformclientv2/createbusinessunitrequest.go deleted file mode 100644 index c391d8c07..000000000 --- a/build/platformclientv2/createbusinessunitrequest.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Createbusinessunitrequest -type Createbusinessunitrequest struct { - // Name - The name of the business unit - Name *string `json:"name,omitempty"` - - - // DivisionId - The ID of the division to which the business unit should be added - DivisionId *string `json:"divisionId,omitempty"` - - - // Settings - Configuration for the business unit - Settings *Createbusinessunitsettings `json:"settings,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Createbusinessunitrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/createbusinessunitsettings.go b/build/platformclientv2/createbusinessunitsettings.go deleted file mode 100644 index 18786bba6..000000000 --- a/build/platformclientv2/createbusinessunitsettings.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Createbusinessunitsettings -type Createbusinessunitsettings struct { - // StartDayOfWeek - The start day of week for this business unit - StartDayOfWeek *string `json:"startDayOfWeek,omitempty"` - - - // TimeZone - The time zone for this business unit, using the Olsen tz database format - TimeZone *string `json:"timeZone,omitempty"` - - - // ShortTermForecasting - Short term forecasting settings - ShortTermForecasting *Bushorttermforecastingsettings `json:"shortTermForecasting,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Createbusinessunitsettings) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/createcallbackcommand.go b/build/platformclientv2/createcallbackcommand.go deleted file mode 100644 index d7b20ce06..000000000 --- a/build/platformclientv2/createcallbackcommand.go +++ /dev/null @@ -1,50 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Createcallbackcommand -type Createcallbackcommand struct { - // ScriptId - The identifier of the script to be used for the callback - ScriptId *string `json:"scriptId,omitempty"` - - - // QueueId - The identifier of the queue to be used for the callback. Either queueId or routingData is required. - QueueId *string `json:"queueId,omitempty"` - - - // RoutingData - The routing data to be used for the callback. Either queueId or routingData is required. - RoutingData *Routingdata `json:"routingData,omitempty"` - - - // CallbackUserName - The name of the party to be called back. - CallbackUserName *string `json:"callbackUserName,omitempty"` - - - // CallbackNumbers - A list of phone numbers for the callback. - CallbackNumbers *[]string `json:"callbackNumbers,omitempty"` - - - // CallbackScheduledTime - The scheduled date-time for the callback as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ - CallbackScheduledTime *time.Time `json:"callbackScheduledTime,omitempty"` - - - // CountryCode - The country code to be associated with the callback numbers. - CountryCode *string `json:"countryCode,omitempty"` - - - // ValidateCallbackNumbers - Whether or not to validate the callback numbers for phone number format. - ValidateCallbackNumbers *bool `json:"validateCallbackNumbers,omitempty"` - - - // Data - A map of key-value pairs containing additional data that can be associated to the callback. These values will appear in the attributes property on the conversation participant. Example: { \"notes\": \"ready to close the deal!\", \"customerPreferredName\": \"Doc\" } - Data *map[string]string `json:"data,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Createcallbackcommand) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/createcallbackonconversationcommand.go b/build/platformclientv2/createcallbackonconversationcommand.go deleted file mode 100644 index 5bfd4066d..000000000 --- a/build/platformclientv2/createcallbackonconversationcommand.go +++ /dev/null @@ -1,50 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Createcallbackonconversationcommand -type Createcallbackonconversationcommand struct { - // ScriptId - The identifier of the script to be used for the callback - ScriptId *string `json:"scriptId,omitempty"` - - - // QueueId - The identifier of the queue to be used for the callback. Either queueId or routingData is required. - QueueId *string `json:"queueId,omitempty"` - - - // RoutingData - The routing data to be used for the callback. Either queueId or routingData is required. - RoutingData *Routingdata `json:"routingData,omitempty"` - - - // CallbackUserName - The name of the party to be called back. - CallbackUserName *string `json:"callbackUserName,omitempty"` - - - // CallbackNumbers - A list of phone numbers for the callback. - CallbackNumbers *[]string `json:"callbackNumbers,omitempty"` - - - // CallbackScheduledTime - The scheduled date-time for the callback as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ - CallbackScheduledTime *time.Time `json:"callbackScheduledTime,omitempty"` - - - // CountryCode - The country code to be associated with the callback numbers. - CountryCode *string `json:"countryCode,omitempty"` - - - // ValidateCallbackNumbers - Whether or not to validate the callback numbers for phone number format. - ValidateCallbackNumbers *bool `json:"validateCallbackNumbers,omitempty"` - - - // Data - A map of key-value pairs containing additional data that can be associated to the callback. These values will appear in the attributes property on the conversation participant. Example: { \"notes\": \"ready to close the deal!\", \"customerPreferredName\": \"Doc\" } - Data *map[string]string `json:"data,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Createcallbackonconversationcommand) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/createcallbackresponse.go b/build/platformclientv2/createcallbackresponse.go deleted file mode 100644 index 3f3431ced..000000000 --- a/build/platformclientv2/createcallbackresponse.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Createcallbackresponse -type Createcallbackresponse struct { - // Conversation - The conversation associated with the callback - Conversation *Domainentityref `json:"conversation,omitempty"` - - - // CallbackIdentifiers - The list of communication identifiers for the callback participants - CallbackIdentifiers *[]Callbackidentifier `json:"callbackIdentifiers,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Createcallbackresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/createcallrequest.go b/build/platformclientv2/createcallrequest.go deleted file mode 100644 index 51ccbb942..000000000 --- a/build/platformclientv2/createcallrequest.go +++ /dev/null @@ -1,61 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Createcallrequest -type Createcallrequest struct { - // PhoneNumber - The phone number to dial. - PhoneNumber *string `json:"phoneNumber,omitempty"` - - - // CallerId - The caller id phone number for this outbound call. - CallerId *string `json:"callerId,omitempty"` - - - // CallerIdName - The caller id name for this outbound call. - CallerIdName *string `json:"callerIdName,omitempty"` - - - // CallFromQueueId - The queue ID to call on behalf of. - CallFromQueueId *string `json:"callFromQueueId,omitempty"` - - - // CallQueueId - The queue ID to call. - CallQueueId *string `json:"callQueueId,omitempty"` - - - // CallUserId - The user ID to call. - CallUserId *string `json:"callUserId,omitempty"` - - - // Priority - The priority to assign to this call (if calling a queue). - Priority *int `json:"priority,omitempty"` - - - // LanguageId - The language skill ID to use for routing this call (if calling a queue). - LanguageId *string `json:"languageId,omitempty"` - - - // RoutingSkillsIds - The skill ID's to use for routing this call (if calling a queue). - RoutingSkillsIds *[]string `json:"routingSkillsIds,omitempty"` - - - // ConversationIds - The list of existing call conversations to merge into a new ad-hoc conference. - ConversationIds *[]string `json:"conversationIds,omitempty"` - - - // Participants - The list of participants to call to create a new ad-hoc conference. - Participants *[]Destination `json:"participants,omitempty"` - - - // UuiData - User to User Information (UUI) data managed by SIP session application. - UuiData *string `json:"uuiData,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Createcallrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/createcallresponse.go b/build/platformclientv2/createcallresponse.go deleted file mode 100644 index fbc55d330..000000000 --- a/build/platformclientv2/createcallresponse.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Createcallresponse -type Createcallresponse struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Createcallresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/createcoachingappointmentrequest.go b/build/platformclientv2/createcoachingappointmentrequest.go deleted file mode 100644 index 54bebf7bc..000000000 --- a/build/platformclientv2/createcoachingappointmentrequest.go +++ /dev/null @@ -1,46 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Createcoachingappointmentrequest - Create coaching appointment request -type Createcoachingappointmentrequest struct { - // Name - The name of coaching appointment. - Name *string `json:"name,omitempty"` - - - // Description - The description of coaching appointment. - Description *string `json:"description,omitempty"` - - - // DateStart - The date/time the coaching appointment starts. Times will be rounded down to the minute. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateStart *time.Time `json:"dateStart,omitempty"` - - - // LengthInMinutes - The duration of coaching appointment in minutes. - LengthInMinutes *int `json:"lengthInMinutes,omitempty"` - - - // FacilitatorId - The facilitator ID of coaching appointment. - FacilitatorId *string `json:"facilitatorId,omitempty"` - - - // AttendeeIds - IDs of attendees in the coaching appointment. - AttendeeIds *[]string `json:"attendeeIds,omitempty"` - - - // ConversationIds - IDs of conversations associated with this coaching appointment. - ConversationIds *[]string `json:"conversationIds,omitempty"` - - - // DocumentIds - IDs of documents associated with this coaching appointment. - DocumentIds *[]string `json:"documentIds,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Createcoachingappointmentrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/createemailrequest.go b/build/platformclientv2/createemailrequest.go deleted file mode 100644 index 84659314f..000000000 --- a/build/platformclientv2/createemailrequest.go +++ /dev/null @@ -1,73 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Createemailrequest -type Createemailrequest struct { - // QueueId - The ID of the queue to use for routing the email conversation. This field is mutually exclusive with flowId - QueueId *string `json:"queueId,omitempty"` - - - // FlowId - The ID of the flow to use for routing email conversation. This field is mutually exclusive with queueId - FlowId *string `json:"flowId,omitempty"` - - - // Provider - The name of the provider that is sourcing the emails. The Provider \"PureCloud Email\" is reserved for native emails. - Provider *string `json:"provider,omitempty"` - - - // SkillIds - The list of skill ID's to use for routing. - SkillIds *[]string `json:"skillIds,omitempty"` - - - // LanguageId - The ID of the language to use for routing. - LanguageId *string `json:"languageId,omitempty"` - - - // Priority - The priority to assign to the conversation for routing. - Priority *int `json:"priority,omitempty"` - - - // Attributes - The list of attributes to associate with the customer participant. - Attributes *map[string]string `json:"attributes,omitempty"` - - - // ToAddress - The email address of the recipient of the email. - ToAddress *string `json:"toAddress,omitempty"` - - - // ToName - The name of the recipient of the email. - ToName *string `json:"toName,omitempty"` - - - // FromAddress - The email address of the sender of the email. - FromAddress *string `json:"fromAddress,omitempty"` - - - // FromName - The name of the sender of the email. - FromName *string `json:"fromName,omitempty"` - - - // Subject - The subject of the email - Subject *string `json:"subject,omitempty"` - - - // Direction - Specify OUTBOUND to send an email on behalf of a queue, or INBOUND to create an external conversation. An external conversation is one where the provider is not PureCloud based. - Direction *string `json:"direction,omitempty"` - - - // HtmlBody - An HTML body content of the email. - HtmlBody *string `json:"htmlBody,omitempty"` - - - // TextBody - A text body content of the email. - TextBody *string `json:"textBody,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Createemailrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/createintegrationrequest.go b/build/platformclientv2/createintegrationrequest.go deleted file mode 100644 index b8c1b8898..000000000 --- a/build/platformclientv2/createintegrationrequest.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Createintegrationrequest - Details for an Integration -type Createintegrationrequest struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the integration, used to distinguish this integration from others of the same type. - Name *string `json:"name,omitempty"` - - - // IntegrationType - Type of the integration to create. - IntegrationType *Integrationtype `json:"integrationType,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Createintegrationrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/createmanagementunitapirequest.go b/build/platformclientv2/createmanagementunitapirequest.go deleted file mode 100644 index 9e2a58631..000000000 --- a/build/platformclientv2/createmanagementunitapirequest.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Createmanagementunitapirequest - Create Management Unit -type Createmanagementunitapirequest struct { - // Name - The name of the management unit - Name *string `json:"name,omitempty"` - - - // TimeZone - The default time zone to use for this management unit. Moving to Business Unit - TimeZone *string `json:"timeZone,omitempty"` - - - // StartDayOfWeek - The configured first day of the week for scheduling and forecasting purposes. Moving to Business Unit - StartDayOfWeek *string `json:"startDayOfWeek,omitempty"` - - - // Settings - The configuration for the management unit. If omitted, reasonable defaults will be assigned - Settings *Createmanagementunitsettingsrequest `json:"settings,omitempty"` - - - // DivisionId - The id of the division to which this management unit belongs. Defaults to home division ID - DivisionId *string `json:"divisionId,omitempty"` - - - // BusinessUnitId - The id of the business unit to which this management unit belongs. Required after business unit launch - BusinessUnitId *string `json:"businessUnitId,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Createmanagementunitapirequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/createmanagementunitsettingsrequest.go b/build/platformclientv2/createmanagementunitsettingsrequest.go deleted file mode 100644 index fae42b9be..000000000 --- a/build/platformclientv2/createmanagementunitsettingsrequest.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Createmanagementunitsettingsrequest - Management Unit Settings -type Createmanagementunitsettingsrequest struct { - // Adherence - Adherence settings for this management unit - Adherence *Adherencesettings `json:"adherence,omitempty"` - - - // ShortTermForecasting - Short term forecasting settings for this management unit. Moving to Business Unit - ShortTermForecasting *Shorttermforecastingsettings `json:"shortTermForecasting,omitempty"` - - - // TimeOff - Time off request settings for this management unit - TimeOff *Timeoffrequestsettings `json:"timeOff,omitempty"` - - - // Scheduling - Scheduling settings for this management unit - Scheduling *Schedulingsettingsrequest `json:"scheduling,omitempty"` - - - // ShiftTrading - Shift trade settings for this management unit - ShiftTrading *Shifttradesettings `json:"shiftTrading,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Createmanagementunitsettingsrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/createoutboundmessagingconversationrequest.go b/build/platformclientv2/createoutboundmessagingconversationrequest.go deleted file mode 100644 index 56be356d4..000000000 --- a/build/platformclientv2/createoutboundmessagingconversationrequest.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Createoutboundmessagingconversationrequest -type Createoutboundmessagingconversationrequest struct { - // QueueId - The ID of the queue to be associated with the message. This will determine the fromAddress of the message. - QueueId *string `json:"queueId,omitempty"` - - - // ToAddress - The messaging address of the recipient of the message. For an SMS messenger type, the phone number address must be in E.164 format. E.g. +13175555555 or +34234234234 - ToAddress *string `json:"toAddress,omitempty"` - - - // ToAddressMessengerType - The messaging address messenger type. - ToAddressMessengerType *string `json:"toAddressMessengerType,omitempty"` - - - // UseExistingConversation - An override to use an existing conversation. If set to true, an existing conversation will be used if there is one within the conversation window. If set to false, create request fails if there is a conversation within the conversation window. - UseExistingConversation *bool `json:"useExistingConversation,omitempty"` - - - // ExternalContactId - The external contact Id of the recipient of the message. - ExternalContactId *string `json:"externalContactId,omitempty"` - - - // ExternalOrganizationId - The external organization Id of the recipient of the message. - ExternalOrganizationId *string `json:"externalOrganizationId,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Createoutboundmessagingconversationrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/createplanninggrouprequest.go b/build/platformclientv2/createplanninggrouprequest.go deleted file mode 100644 index 8d38ed183..000000000 --- a/build/platformclientv2/createplanninggrouprequest.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Createplanninggrouprequest -type Createplanninggrouprequest struct { - // Name - The name of the planning group - Name *string `json:"name,omitempty"` - - - // RoutePaths - Set of route paths to associate with the planning group - RoutePaths *[]Routepathrequest `json:"routePaths,omitempty"` - - - // ServiceGoalTemplateId - The ID of the service goal template to associate with this planning group - ServiceGoalTemplateId *string `json:"serviceGoalTemplateId,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Createplanninggrouprequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/createqueuerequest.go b/build/platformclientv2/createqueuerequest.go deleted file mode 100644 index 861251ff0..000000000 --- a/build/platformclientv2/createqueuerequest.go +++ /dev/null @@ -1,118 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Createqueuerequest -type Createqueuerequest struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The queue name - Name *string `json:"name,omitempty"` - - - // Division - The division to which this entity belongs. - Division *Writabledivision `json:"division,omitempty"` - - - // Description - The queue description. - Description *string `json:"description,omitempty"` - - - // DateCreated - The date the queue was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - The date of the last modification to the queue. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // ModifiedBy - The ID of the user that last modified the queue. - ModifiedBy *string `json:"modifiedBy,omitempty"` - - - // CreatedBy - The ID of the user that created the queue. - CreatedBy *string `json:"createdBy,omitempty"` - - - // MemberCount - The number of users in the queue. - MemberCount *int `json:"memberCount,omitempty"` - - - // MediaSettings - The media settings for the queue. Valid key values: CALL, CALLBACK, CHAT, EMAIL, MESSAGE, SOCIAL_EXPRESSION, VIDEO_COMM - MediaSettings *map[string]Mediasetting `json:"mediaSettings,omitempty"` - - - // RoutingRules - The routing rules for the queue, used for routing to known or preferred agents. - RoutingRules *[]Routingrule `json:"routingRules,omitempty"` - - - // Bullseye - The bulls-eye settings for the queue. - Bullseye *Bullseye `json:"bullseye,omitempty"` - - - // AcwSettings - The ACW settings for the queue. - AcwSettings *Acwsettings `json:"acwSettings,omitempty"` - - - // SkillEvaluationMethod - The skill evaluation method to use when routing conversations. - SkillEvaluationMethod *string `json:"skillEvaluationMethod,omitempty"` - - - // QueueFlow - The in-queue flow to use for conversations waiting in queue. - QueueFlow *Domainentityref `json:"queueFlow,omitempty"` - - - // WhisperPrompt - The prompt used for whisper on the queue, if configured. - WhisperPrompt *Domainentityref `json:"whisperPrompt,omitempty"` - - - // AutoAnswerOnly - Specifies whether the configured whisper should play for all ACD calls, or only for those which are auto-answered. - AutoAnswerOnly *bool `json:"autoAnswerOnly,omitempty"` - - - // EnableTranscription - Indicates whether voice transcription is enabled for this queue. - EnableTranscription *bool `json:"enableTranscription,omitempty"` - - - // EnableManualAssignment - Indicates whether manual assignment is enabled for this queue. - EnableManualAssignment *bool `json:"enableManualAssignment,omitempty"` - - - // CallingPartyName - The name to use for caller identification for outbound calls from this queue. - CallingPartyName *string `json:"callingPartyName,omitempty"` - - - // CallingPartyNumber - The phone number to use for caller identification for outbound calls from this queue. - CallingPartyNumber *string `json:"callingPartyNumber,omitempty"` - - - // DefaultScripts - The default script Ids for the communication types. - DefaultScripts *map[string]Script `json:"defaultScripts,omitempty"` - - - // OutboundMessagingAddresses - The messaging addresses for the queue. - OutboundMessagingAddresses *Queuemessagingaddresses `json:"outboundMessagingAddresses,omitempty"` - - - // OutboundEmailAddress - OutboundEmailAddress *Queueemailaddress `json:"outboundEmailAddress,omitempty"` - - - // SourceQueueId - The id of an existing queue to copy the settings from when creating a new queue. - SourceQueueId *string `json:"sourceQueueId,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Createqueuerequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/createsecuresession.go b/build/platformclientv2/createsecuresession.go deleted file mode 100644 index 9d1166867..000000000 --- a/build/platformclientv2/createsecuresession.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Createsecuresession -type Createsecuresession struct { - // SourceParticipantId - requesting participant - SourceParticipantId *string `json:"sourceParticipantId,omitempty"` - - - // FlowId - the flow id to execute in the secure session - FlowId *string `json:"flowId,omitempty"` - - - // UserData - user data for the secure session - UserData *string `json:"userData,omitempty"` - - - // Disconnect - if true, disconnect the agent after creating the session - Disconnect *bool `json:"disconnect,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Createsecuresession) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/createservicegoaltemplate.go b/build/platformclientv2/createservicegoaltemplate.go deleted file mode 100644 index 274f70ce9..000000000 --- a/build/platformclientv2/createservicegoaltemplate.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Createservicegoaltemplate -type Createservicegoaltemplate struct { - // Name - The name of the service goal template. - Name *string `json:"name,omitempty"` - - - // ServiceLevel - Service level targets for this service goal template - ServiceLevel *Buservicelevel `json:"serviceLevel,omitempty"` - - - // AverageSpeedOfAnswer - Average speed of answer targets for this service goal template - AverageSpeedOfAnswer *Buaveragespeedofanswer `json:"averageSpeedOfAnswer,omitempty"` - - - // AbandonRate - Abandon rate targets for this service goal template - AbandonRate *Buabandonrate `json:"abandonRate,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Createservicegoaltemplate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/createsharerequest.go b/build/platformclientv2/createsharerequest.go deleted file mode 100644 index 7ee83807b..000000000 --- a/build/platformclientv2/createsharerequest.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Createsharerequest -type Createsharerequest struct { - // SharedEntityType - The share entity type - SharedEntityType *string `json:"sharedEntityType,omitempty"` - - - // SharedEntity - The entity that will be shared - SharedEntity *Sharedentity `json:"sharedEntity,omitempty"` - - - // MemberType - MemberType *string `json:"memberType,omitempty"` - - - // Member - The member that will have access to this share. Only required if a list of members is not provided. - Member *Sharedentity `json:"member,omitempty"` - - - // Members - Members *[]Createsharerequestmember `json:"members,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Createsharerequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/createsharerequestmember.go b/build/platformclientv2/createsharerequestmember.go deleted file mode 100644 index fc05c0762..000000000 --- a/build/platformclientv2/createsharerequestmember.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Createsharerequestmember -type Createsharerequestmember struct { - // MemberType - MemberType *string `json:"memberType,omitempty"` - - - // Member - Member *Memberentity `json:"member,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Createsharerequestmember) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/createshareresponse.go b/build/platformclientv2/createshareresponse.go deleted file mode 100644 index 88e0124ea..000000000 --- a/build/platformclientv2/createshareresponse.go +++ /dev/null @@ -1,57 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Createshareresponse -type Createshareresponse struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // SharedEntityType - SharedEntityType *string `json:"sharedEntityType,omitempty"` - - - // SharedEntity - SharedEntity *Domainentityref `json:"sharedEntity,omitempty"` - - - // MemberType - MemberType *string `json:"memberType,omitempty"` - - - // Member - Member *Domainentityref `json:"member,omitempty"` - - - // SharedBy - SharedBy *Domainentityref `json:"sharedBy,omitempty"` - - - // Workspace - Workspace *Domainentityref `json:"workspace,omitempty"` - - - // Succeeded - Succeeded *[]Share `json:"succeeded,omitempty"` - - - // Failed - Failed *[]Share `json:"failed,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Createshareresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/createuser.go b/build/platformclientv2/createuser.go deleted file mode 100644 index 08618e29a..000000000 --- a/build/platformclientv2/createuser.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Createuser -type Createuser struct { - // Name - User's full name - Name *string `json:"name,omitempty"` - - - // Department - Department *string `json:"department,omitempty"` - - - // Email - User's email and username - Email *string `json:"email,omitempty"` - - - // Addresses - Email addresses and phone numbers for this user - Addresses *[]Contact `json:"addresses,omitempty"` - - - // Title - Title *string `json:"title,omitempty"` - - - // Password - User's password - Password *string `json:"password,omitempty"` - - - // DivisionId - The division to which this user will belong - DivisionId *string `json:"divisionId,omitempty"` - - - // State - Optional initialized state of the user. If not specified, state will be Active if invites are sent, otherwise Inactive. - State *string `json:"state,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Createuser) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/createwebchatconversationrequest.go b/build/platformclientv2/createwebchatconversationrequest.go deleted file mode 100644 index 218edd249..000000000 --- a/build/platformclientv2/createwebchatconversationrequest.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Createwebchatconversationrequest -type Createwebchatconversationrequest struct { - // OrganizationId - The organization identifier. - OrganizationId *string `json:"organizationId,omitempty"` - - - // DeploymentId - The web chat Deployment ID which contains the appropriate settings for this chat conversation. - DeploymentId *string `json:"deploymentId,omitempty"` - - - // RoutingTarget - The routing information to use for the new chat conversation. - RoutingTarget *Webchatroutingtarget `json:"routingTarget,omitempty"` - - - // MemberInfo - The guest member info to use for the new chat conversation. - MemberInfo *Guestmemberinfo `json:"memberInfo,omitempty"` - - - // MemberAuthToken - If the guest member is an authenticated member (ie, not anonymous) his JWT is provided here. The token will have been previously generated with the \"POST /api/v2/signeddata\" resource. - MemberAuthToken *string `json:"memberAuthToken,omitempty"` - - - // JourneyContext - A subset of the Journey System's data relevant to this conversation/session request (for external linkage and internal usage/context). - JourneyContext *Journeycontext `json:"journeyContext,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Createwebchatconversationrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/createwebchatconversationresponse.go b/build/platformclientv2/createwebchatconversationresponse.go deleted file mode 100644 index 4d8780875..000000000 --- a/build/platformclientv2/createwebchatconversationresponse.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Createwebchatconversationresponse -type Createwebchatconversationresponse struct { - // Id - Chat Conversation identifier - Id *string `json:"id,omitempty"` - - - // Jwt - The JWT that you can use to identify subsequent calls on this conversation - Jwt *string `json:"jwt,omitempty"` - - - // EventStreamUri - The URI which provides the conversation event stream. - EventStreamUri *string `json:"eventStreamUri,omitempty"` - - - // Member - Chat Member - Member *Webchatmemberinfo `json:"member,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Createwebchatconversationresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/createwebchatmessagerequest.go b/build/platformclientv2/createwebchatmessagerequest.go deleted file mode 100644 index 06b201da7..000000000 --- a/build/platformclientv2/createwebchatmessagerequest.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Createwebchatmessagerequest -type Createwebchatmessagerequest struct { - // Body - The message body. Note that message bodies are limited to 4,000 characters. - Body *string `json:"body,omitempty"` - - - // BodyType - The purpose of the message within the conversation, such as a standard text entry versus a greeting. - BodyType *string `json:"bodyType,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Createwebchatmessagerequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/createwebchatrequest.go b/build/platformclientv2/createwebchatrequest.go deleted file mode 100644 index 88686bd6d..000000000 --- a/build/platformclientv2/createwebchatrequest.go +++ /dev/null @@ -1,41 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Createwebchatrequest -type Createwebchatrequest struct { - // QueueId - The ID of the queue to use for routing the chat conversation. - QueueId *string `json:"queueId,omitempty"` - - - // Provider - The name of the provider that is sourcing the web chat. - Provider *string `json:"provider,omitempty"` - - - // SkillIds - The list of skill ID's to use for routing. - SkillIds *[]string `json:"skillIds,omitempty"` - - - // LanguageId - The ID of the langauge to use for routing. - LanguageId *string `json:"languageId,omitempty"` - - - // Priority - The priority to assign to the conversation for routing. - Priority *int `json:"priority,omitempty"` - - - // Attributes - The list of attributes to associate with the customer participant. - Attributes *map[string]string `json:"attributes,omitempty"` - - - // CustomerName - The name of the customer participating in the web chat. - CustomerName *string `json:"customerName,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Createwebchatrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/createworkplan.go b/build/platformclientv2/createworkplan.go deleted file mode 100644 index 6154afe16..000000000 --- a/build/platformclientv2/createworkplan.go +++ /dev/null @@ -1,81 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Createworkplan - Work plan information -type Createworkplan struct { - // Name - Name of this work plan - Name *string `json:"name,omitempty"` - - - // Enabled - Whether the work plan is enabled for scheduling - Enabled *bool `json:"enabled,omitempty"` - - - // ConstrainWeeklyPaidTime - Whether the weekly paid time constraint is enabled for this work plan - ConstrainWeeklyPaidTime *bool `json:"constrainWeeklyPaidTime,omitempty"` - - - // FlexibleWeeklyPaidTime - Whether the weekly paid time constraint is flexible for this work plan - FlexibleWeeklyPaidTime *bool `json:"flexibleWeeklyPaidTime,omitempty"` - - - // WeeklyExactPaidMinutes - Exact weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == false - WeeklyExactPaidMinutes *int `json:"weeklyExactPaidMinutes,omitempty"` - - - // WeeklyMinimumPaidMinutes - Minimum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true - WeeklyMinimumPaidMinutes *int `json:"weeklyMinimumPaidMinutes,omitempty"` - - - // WeeklyMaximumPaidMinutes - Maximum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true - WeeklyMaximumPaidMinutes *int `json:"weeklyMaximumPaidMinutes,omitempty"` - - - // ConstrainPaidTimeGranularity - Whether paid time granularity should be constrained for this workplan - ConstrainPaidTimeGranularity *bool `json:"constrainPaidTimeGranularity,omitempty"` - - - // PaidTimeGranularityMinutes - Granularity in minutes allowed for shift paid time in this work plan. Used if constrainPaidTimeGranularity == true - PaidTimeGranularityMinutes *int `json:"paidTimeGranularityMinutes,omitempty"` - - - // ConstrainMinimumTimeBetweenShifts - Whether the minimum time between shifts constraint is enabled for this work plan - ConstrainMinimumTimeBetweenShifts *bool `json:"constrainMinimumTimeBetweenShifts,omitempty"` - - - // MinimumTimeBetweenShiftsMinutes - Minimum time between shifts in minutes defined in this work plan. Used if constrainMinimumTimeBetweenShifts == true - MinimumTimeBetweenShiftsMinutes *int `json:"minimumTimeBetweenShiftsMinutes,omitempty"` - - - // MaximumDays - Maximum number days in a week allowed to be scheduled for this work plan - MaximumDays *int `json:"maximumDays,omitempty"` - - - // MinimumWorkingDaysPerWeek - The minimum number of days that agents assigned to a work plan must work per week - MinimumWorkingDaysPerWeek *int `json:"minimumWorkingDaysPerWeek,omitempty"` - - - // OptionalDays - Optional days to schedule for this work plan - OptionalDays *Setwrapperdayofweek `json:"optionalDays,omitempty"` - - - // ShiftStartVariances - Variance in minutes among start times of shifts in this work plan - ShiftStartVariances *Listwrappershiftstartvariance `json:"shiftStartVariances,omitempty"` - - - // Shifts - Shifts in this work plan - Shifts *[]Createworkplanshift `json:"shifts,omitempty"` - - - // Agents - Agents in this work plan - Agents *[]Userreference `json:"agents,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Createworkplan) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/createworkplanactivity.go b/build/platformclientv2/createworkplanactivity.go deleted file mode 100644 index 56e98caa9..000000000 --- a/build/platformclientv2/createworkplanactivity.go +++ /dev/null @@ -1,57 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Createworkplanactivity - Activity configured for shift in work plan -type Createworkplanactivity struct { - // ActivityCodeId - ID of the activity code associated with this activity - ActivityCodeId *string `json:"activityCodeId,omitempty"` - - - // Description - Description of the activity - Description *string `json:"description,omitempty"` - - - // LengthMinutes - Length of the activity in minutes - LengthMinutes *int `json:"lengthMinutes,omitempty"` - - - // StartTimeIsRelativeToShiftStart - Whether the start time of the activity is relative to the start time of the shift it belongs to - StartTimeIsRelativeToShiftStart *bool `json:"startTimeIsRelativeToShiftStart,omitempty"` - - - // FlexibleStartTime - Whether the start time of the activity is flexible - FlexibleStartTime *bool `json:"flexibleStartTime,omitempty"` - - - // EarliestStartTimeMinutes - Earliest activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == true - EarliestStartTimeMinutes *int `json:"earliestStartTimeMinutes,omitempty"` - - - // LatestStartTimeMinutes - Latest activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == true - LatestStartTimeMinutes *int `json:"latestStartTimeMinutes,omitempty"` - - - // ExactStartTimeMinutes - Exact activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == false - ExactStartTimeMinutes *int `json:"exactStartTimeMinutes,omitempty"` - - - // StartTimeIncrementMinutes - Increment in offset minutes that would contribute to different possible start times for the activity - StartTimeIncrementMinutes *int `json:"startTimeIncrementMinutes,omitempty"` - - - // CountsAsPaidTime - Whether the activity is paid - CountsAsPaidTime *bool `json:"countsAsPaidTime,omitempty"` - - - // CountsAsContiguousWorkTime - Whether the activity duration is counted towards contiguous work time - CountsAsContiguousWorkTime *bool `json:"countsAsContiguousWorkTime,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Createworkplanactivity) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/createworkplanshift.go b/build/platformclientv2/createworkplanshift.go deleted file mode 100644 index aac5c05ef..000000000 --- a/build/platformclientv2/createworkplanshift.go +++ /dev/null @@ -1,85 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Createworkplanshift - Shift in a work plan -type Createworkplanshift struct { - // Name - Name of the shift - Name *string `json:"name,omitempty"` - - - // Days - Days of the week applicable for this shift - Days *Setwrapperdayofweek `json:"days,omitempty"` - - - // FlexibleStartTime - Whether the start time of the shift is flexible - FlexibleStartTime *bool `json:"flexibleStartTime,omitempty"` - - - // ExactStartTimeMinutesFromMidnight - Exact start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == false - ExactStartTimeMinutesFromMidnight *int `json:"exactStartTimeMinutesFromMidnight,omitempty"` - - - // EarliestStartTimeMinutesFromMidnight - Earliest start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == true - EarliestStartTimeMinutesFromMidnight *int `json:"earliestStartTimeMinutesFromMidnight,omitempty"` - - - // LatestStartTimeMinutesFromMidnight - Latest start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == true - LatestStartTimeMinutesFromMidnight *int `json:"latestStartTimeMinutesFromMidnight,omitempty"` - - - // ConstrainStopTime - Whether the latest stop time constraint for the shift is enabled. Deprecated, use constrainLatestStopTime instead - ConstrainStopTime *bool `json:"constrainStopTime,omitempty"` - - - // ConstrainLatestStopTime - Whether the latest stop time constraint for the shift is enabled - ConstrainLatestStopTime *bool `json:"constrainLatestStopTime,omitempty"` - - - // LatestStopTimeMinutesFromMidnight - Latest stop time of the shift defined as offset minutes from midnight. Used if constrainStopTime == true - LatestStopTimeMinutesFromMidnight *int `json:"latestStopTimeMinutesFromMidnight,omitempty"` - - - // StartIncrementMinutes - Increment in offset minutes that would contribute to different possible start times for the shift. Used if flexibleStartTime == true - StartIncrementMinutes *int `json:"startIncrementMinutes,omitempty"` - - - // FlexiblePaidTime - Whether the paid time setting for the shift is flexible - FlexiblePaidTime *bool `json:"flexiblePaidTime,omitempty"` - - - // ExactPaidTimeMinutes - Exact paid time in minutes configured for the shift. Used if flexiblePaidTime == false - ExactPaidTimeMinutes *int `json:"exactPaidTimeMinutes,omitempty"` - - - // MinimumPaidTimeMinutes - Minimum paid time in minutes configured for the shift. Used if flexiblePaidTime == true - MinimumPaidTimeMinutes *int `json:"minimumPaidTimeMinutes,omitempty"` - - - // MaximumPaidTimeMinutes - Maximum paid time in minutes configured for the shift. Used if flexiblePaidTime == true - MaximumPaidTimeMinutes *int `json:"maximumPaidTimeMinutes,omitempty"` - - - // ConstrainContiguousWorkTime - Whether the contiguous time constraint for the shift is enabled - ConstrainContiguousWorkTime *bool `json:"constrainContiguousWorkTime,omitempty"` - - - // MinimumContiguousWorkTimeMinutes - Minimum contiguous time in minutes configured for the shift. Used if constrainContiguousWorkTime == true - MinimumContiguousWorkTimeMinutes *int `json:"minimumContiguousWorkTimeMinutes,omitempty"` - - - // MaximumContiguousWorkTimeMinutes - Maximum contiguous time in minutes configured for the shift. Used if constrainContiguousWorkTime == true - MaximumContiguousWorkTimeMinutes *int `json:"maximumContiguousWorkTimeMinutes,omitempty"` - - - // Activities - Activities configured for this shift - Activities *[]Createworkplanactivity `json:"activities,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Createworkplanshift) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/credential.go b/build/platformclientv2/credential.go deleted file mode 100644 index f2258354b..000000000 --- a/build/platformclientv2/credential.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Credential -type Credential struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // VarType - The type of credential. - VarType *Credentialtype `json:"type,omitempty"` - - - // CredentialFields - CredentialFields *map[string]string `json:"credentialFields,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Credential) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/credentialinfo.go b/build/platformclientv2/credentialinfo.go deleted file mode 100644 index 6bc4ebe75..000000000 --- a/build/platformclientv2/credentialinfo.go +++ /dev/null @@ -1,38 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Credentialinfo -type Credentialinfo struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // CreatedDate - Date the credentials were created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - CreatedDate *time.Time `json:"createdDate,omitempty"` - - - // ModifiedDate - Date credentials were last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ModifiedDate *time.Time `json:"modifiedDate,omitempty"` - - - // VarType - Type of the credentials. - VarType *Credentialtype `json:"type,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Credentialinfo) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/credentialinfolisting.go b/build/platformclientv2/credentialinfolisting.go deleted file mode 100644 index 7b39eb277..000000000 --- a/build/platformclientv2/credentialinfolisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Credentialinfolisting -type Credentialinfolisting struct { - // Entities - Entities *[]Credentialinfo `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Credentialinfolisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/credentialspecification.go b/build/platformclientv2/credentialspecification.go deleted file mode 100644 index 50806d65b..000000000 --- a/build/platformclientv2/credentialspecification.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Credentialspecification - Specifies the requirements for a credential that can be provided for configuring an integration -type Credentialspecification struct { - // Required - Indicates if the credential must be provided in order for the integration configuration to be valid. - Required *bool `json:"required,omitempty"` - - - // Title - Title describing the usage for this credential. - Title *string `json:"title,omitempty"` - - - // CredentialTypes - List of acceptable credential types that can be provided for this credential. - CredentialTypes *[]string `json:"credentialTypes,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Credentialspecification) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/credentialtype.go b/build/platformclientv2/credentialtype.go deleted file mode 100644 index 2a2073dde..000000000 --- a/build/platformclientv2/credentialtype.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Credentialtype -type Credentialtype struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Properties - Properties describing credentials of this type. - Properties *map[string]interface{} `json:"properties,omitempty"` - - - // DisplayOrder - Order in which properties should be displayed in the UI. - DisplayOrder *[]string `json:"displayOrder,omitempty"` - - - // Required - Properties that are required fields. - Required *[]string `json:"required,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Credentialtype) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/credentialtypelisting.go b/build/platformclientv2/credentialtypelisting.go deleted file mode 100644 index 3714f5c71..000000000 --- a/build/platformclientv2/credentialtypelisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Credentialtypelisting -type Credentialtypelisting struct { - // Entities - Entities *[]Credentialtype `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Credentialtypelisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/criteria.go b/build/platformclientv2/criteria.go deleted file mode 100644 index 7b14a373b..000000000 --- a/build/platformclientv2/criteria.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Criteria -type Criteria struct { - // Key - The criteria key. - Key *string `json:"key,omitempty"` - - - // Values - The criteria values. - Values *[]string `json:"values,omitempty"` - - - // ShouldIgnoreCase - Should criteria be case insensitive. - ShouldIgnoreCase *bool `json:"shouldIgnoreCase,omitempty"` - - - // Operator - The comparison operator. - Operator *string `json:"operator,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Criteria) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/crossplatformcallmediapolicy.go b/build/platformclientv2/crossplatformcallmediapolicy.go deleted file mode 100644 index 271697ef7..000000000 --- a/build/platformclientv2/crossplatformcallmediapolicy.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Crossplatformcallmediapolicy -type Crossplatformcallmediapolicy struct { - // Actions - Actions applied when specified conditions are met - Actions *Crossplatformpolicyactions `json:"actions,omitempty"` - - - // Conditions - Conditions for when actions should be applied - Conditions *Callmediapolicyconditions `json:"conditions,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Crossplatformcallmediapolicy) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/crossplatformchatmediapolicy.go b/build/platformclientv2/crossplatformchatmediapolicy.go deleted file mode 100644 index 2b62f91fa..000000000 --- a/build/platformclientv2/crossplatformchatmediapolicy.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Crossplatformchatmediapolicy -type Crossplatformchatmediapolicy struct { - // Actions - Actions applied when specified conditions are met - Actions *Crossplatformpolicyactions `json:"actions,omitempty"` - - - // Conditions - Conditions for when actions should be applied - Conditions *Chatmediapolicyconditions `json:"conditions,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Crossplatformchatmediapolicy) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/crossplatformemailmediapolicy.go b/build/platformclientv2/crossplatformemailmediapolicy.go deleted file mode 100644 index a66270cd0..000000000 --- a/build/platformclientv2/crossplatformemailmediapolicy.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Crossplatformemailmediapolicy -type Crossplatformemailmediapolicy struct { - // Actions - Actions applied when specified conditions are met - Actions *Crossplatformpolicyactions `json:"actions,omitempty"` - - - // Conditions - Conditions for when actions should be applied - Conditions *Emailmediapolicyconditions `json:"conditions,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Crossplatformemailmediapolicy) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/crossplatformmediapolicies.go b/build/platformclientv2/crossplatformmediapolicies.go deleted file mode 100644 index b3e98fdcc..000000000 --- a/build/platformclientv2/crossplatformmediapolicies.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Crossplatformmediapolicies -type Crossplatformmediapolicies struct { - // CallPolicy - Conditions and actions for calls - CallPolicy *Crossplatformcallmediapolicy `json:"callPolicy,omitempty"` - - - // ChatPolicy - Conditions and actions for chats - ChatPolicy *Crossplatformchatmediapolicy `json:"chatPolicy,omitempty"` - - - // EmailPolicy - Conditions and actions for emails - EmailPolicy *Crossplatformemailmediapolicy `json:"emailPolicy,omitempty"` - - - // MessagePolicy - Conditions and actions for messages - MessagePolicy *Crossplatformmessagemediapolicy `json:"messagePolicy,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Crossplatformmediapolicies) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/crossplatformmessagemediapolicy.go b/build/platformclientv2/crossplatformmessagemediapolicy.go deleted file mode 100644 index a4d232b88..000000000 --- a/build/platformclientv2/crossplatformmessagemediapolicy.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Crossplatformmessagemediapolicy -type Crossplatformmessagemediapolicy struct { - // Actions - Actions applied when specified conditions are met - Actions *Crossplatformpolicyactions `json:"actions,omitempty"` - - - // Conditions - Conditions for when actions should be applied - Conditions *Messagemediapolicyconditions `json:"conditions,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Crossplatformmessagemediapolicy) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/crossplatformpolicy.go b/build/platformclientv2/crossplatformpolicy.go deleted file mode 100644 index 043678a49..000000000 --- a/build/platformclientv2/crossplatformpolicy.go +++ /dev/null @@ -1,62 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Crossplatformpolicy -type Crossplatformpolicy struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // ModifiedDate - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ModifiedDate *time.Time `json:"modifiedDate,omitempty"` - - - // CreatedDate - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - CreatedDate *time.Time `json:"createdDate,omitempty"` - - - // Order - Order *int `json:"order,omitempty"` - - - // Description - Description *string `json:"description,omitempty"` - - - // Enabled - Enabled *bool `json:"enabled,omitempty"` - - - // MediaPolicies - Conditions and actions per media type - MediaPolicies *Crossplatformmediapolicies `json:"mediaPolicies,omitempty"` - - - // Conditions - Conditions - Conditions *Policyconditions `json:"conditions,omitempty"` - - - // Actions - Actions - Actions *Crossplatformpolicyactions `json:"actions,omitempty"` - - - // PolicyErrors - PolicyErrors *Policyerrors `json:"policyErrors,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Crossplatformpolicy) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/crossplatformpolicyactions.go b/build/platformclientv2/crossplatformpolicyactions.go deleted file mode 100644 index a819ed5be..000000000 --- a/build/platformclientv2/crossplatformpolicyactions.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Crossplatformpolicyactions -type Crossplatformpolicyactions struct { - // RetainRecording - true to retain the recording associated with the conversation. Default = true - RetainRecording *bool `json:"retainRecording,omitempty"` - - - // DeleteRecording - true to delete the recording associated with the conversation. If retainRecording = true, this will be ignored. Default = false - DeleteRecording *bool `json:"deleteRecording,omitempty"` - - - // AlwaysDelete - true to delete the recording associated with the conversation regardless of the values of retainRecording or deleteRecording. Default = false - AlwaysDelete *bool `json:"alwaysDelete,omitempty"` - - - // AssignEvaluations - AssignEvaluations *[]Evaluationassignment `json:"assignEvaluations,omitempty"` - - - // AssignMeteredEvaluations - AssignMeteredEvaluations *[]Meteredevaluationassignment `json:"assignMeteredEvaluations,omitempty"` - - - // AssignMeteredAssignmentByAgent - AssignMeteredAssignmentByAgent *[]Meteredassignmentbyagent `json:"assignMeteredAssignmentByAgent,omitempty"` - - - // AssignCalibrations - AssignCalibrations *[]Calibrationassignment `json:"assignCalibrations,omitempty"` - - - // RetentionDuration - RetentionDuration *Retentionduration `json:"retentionDuration,omitempty"` - - - // MediaTranscriptions - MediaTranscriptions *[]Mediatranscription `json:"mediaTranscriptions,omitempty"` - - - // IntegrationExport - Policy action for exporting recordings using an integration to 3rd party s3. - IntegrationExport *Integrationexport `json:"integrationExport,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Crossplatformpolicyactions) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/crossplatformpolicycreate.go b/build/platformclientv2/crossplatformpolicycreate.go deleted file mode 100644 index a50742118..000000000 --- a/build/platformclientv2/crossplatformpolicycreate.go +++ /dev/null @@ -1,62 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Crossplatformpolicycreate -type Crossplatformpolicycreate struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The policy name. - Name *string `json:"name,omitempty"` - - - // ModifiedDate - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ModifiedDate *time.Time `json:"modifiedDate,omitempty"` - - - // CreatedDate - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - CreatedDate *time.Time `json:"createdDate,omitempty"` - - - // Order - Order *int `json:"order,omitempty"` - - - // Description - Description *string `json:"description,omitempty"` - - - // Enabled - Enabled *bool `json:"enabled,omitempty"` - - - // MediaPolicies - Conditions and actions per media type - MediaPolicies *Crossplatformmediapolicies `json:"mediaPolicies,omitempty"` - - - // Conditions - Conditions - Conditions *Policyconditions `json:"conditions,omitempty"` - - - // Actions - Actions - Actions *Crossplatformpolicyactions `json:"actions,omitempty"` - - - // PolicyErrors - PolicyErrors *Policyerrors `json:"policyErrors,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Crossplatformpolicycreate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/ctabuttonstyleproperties.go b/build/platformclientv2/ctabuttonstyleproperties.go deleted file mode 100644 index 5b90ff1ea..000000000 --- a/build/platformclientv2/ctabuttonstyleproperties.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Ctabuttonstyleproperties -type Ctabuttonstyleproperties struct { - // Color - Color of the text. (eg. #FFFFFF) - Color *string `json:"color,omitempty"` - - - // Font - Font of the text. (eg. Helvetica) - Font *string `json:"font,omitempty"` - - - // FontSize - Font size of the text. (eg. '12') - FontSize *string `json:"fontSize,omitempty"` - - - // TextAlign - Text alignment. - TextAlign *string `json:"textAlign,omitempty"` - - - // BackgroundColor - Background color of the CTA button. (eg. #FF0000) - BackgroundColor *string `json:"backgroundColor,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Ctabuttonstyleproperties) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/currentuserschedulerequestbody.go b/build/platformclientv2/currentuserschedulerequestbody.go deleted file mode 100644 index ef3d9b02a..000000000 --- a/build/platformclientv2/currentuserschedulerequestbody.go +++ /dev/null @@ -1,26 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Currentuserschedulerequestbody - POST request body for fetching the current user's schedule over a given range -type Currentuserschedulerequestbody struct { - // StartDate - Beginning of the range of schedules to fetch, in ISO-8601 format - StartDate *time.Time `json:"startDate,omitempty"` - - - // EndDate - End of the range of schedules to fetch, in ISO-8601 format - EndDate *time.Time `json:"endDate,omitempty"` - - - // LoadFullWeeks - Whether to load the full week's schedule (for the current user) of any week overlapping the start/end date query parameters, defaults to false - LoadFullWeeks *bool `json:"loadFullWeeks,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Currentuserschedulerequestbody) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/cursorcontactlisting.go b/build/platformclientv2/cursorcontactlisting.go deleted file mode 100644 index 2f0ff4f32..000000000 --- a/build/platformclientv2/cursorcontactlisting.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Cursorcontactlisting -type Cursorcontactlisting struct { - // Entities - Entities *[]Externalcontact `json:"entities,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Cursorcontactlisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/cursornotelisting.go b/build/platformclientv2/cursornotelisting.go deleted file mode 100644 index 9cd243640..000000000 --- a/build/platformclientv2/cursornotelisting.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Cursornotelisting -type Cursornotelisting struct { - // Entities - Entities *[]Note `json:"entities,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Cursornotelisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/cursororganizationlisting.go b/build/platformclientv2/cursororganizationlisting.go deleted file mode 100644 index fa8c4bb78..000000000 --- a/build/platformclientv2/cursororganizationlisting.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Cursororganizationlisting -type Cursororganizationlisting struct { - // Entities - Entities *[]Externalorganization `json:"entities,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Cursororganizationlisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/cursorrelationshiplisting.go b/build/platformclientv2/cursorrelationshiplisting.go deleted file mode 100644 index 3f7c669fe..000000000 --- a/build/platformclientv2/cursorrelationshiplisting.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Cursorrelationshiplisting -type Cursorrelationshiplisting struct { - // Entities - Entities *[]Relationship `json:"entities,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Cursorrelationshiplisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/cursors.go b/build/platformclientv2/cursors.go deleted file mode 100644 index af1197400..000000000 --- a/build/platformclientv2/cursors.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Cursors -type Cursors struct { - // Before - Before *string `json:"before,omitempty"` - - - // After - After *string `json:"after,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Cursors) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/customerinteractioncenter.go b/build/platformclientv2/customerinteractioncenter.go deleted file mode 100644 index 5fd48c1ef..000000000 --- a/build/platformclientv2/customerinteractioncenter.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Customerinteractioncenter -type Customerinteractioncenter struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Disabled - Disabled *bool `json:"disabled,omitempty"` - - - // IssuerURI - IssuerURI *string `json:"issuerURI,omitempty"` - - - // SsoTargetURI - SsoTargetURI *string `json:"ssoTargetURI,omitempty"` - - - // Certificate - Certificate *string `json:"certificate,omitempty"` - - - // Certificates - Certificates *[]string `json:"certificates,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Customerinteractioncenter) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dataactionconditionpredicate.go b/build/platformclientv2/dataactionconditionpredicate.go deleted file mode 100644 index bb78083ca..000000000 --- a/build/platformclientv2/dataactionconditionpredicate.go +++ /dev/null @@ -1,13 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dataactionconditionpredicate -type Dataactionconditionpredicate struct { } - -// String returns a JSON representation of the model -func (o *Dataactionconditionpredicate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dataavailabilityresponse.go b/build/platformclientv2/dataavailabilityresponse.go deleted file mode 100644 index 1d35cf8e0..000000000 --- a/build/platformclientv2/dataavailabilityresponse.go +++ /dev/null @@ -1,18 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Dataavailabilityresponse -type Dataavailabilityresponse struct { - // DataAvailabilityDate - Date and time before which data is guaranteed to be available in the datalake. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DataAvailabilityDate *time.Time `json:"dataAvailabilityDate,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dataavailabilityresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dataextensionsapi.go b/build/platformclientv2/dataextensionsapi.go deleted file mode 100644 index 52df163ed..000000000 --- a/build/platformclientv2/dataextensionsapi.go +++ /dev/null @@ -1,227 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "encoding/json" -) - -// DataExtensionsApi provides functions for API endpoints -type DataExtensionsApi struct { - Configuration *Configuration -} - -// NewDataExtensionsApi creates an API instance using the default configuration -func NewDataExtensionsApi() *DataExtensionsApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating DataExtensionsApi with base path: %s", strings.ToLower(config.BasePath))) - return &DataExtensionsApi{ - Configuration: config, - } -} - -// NewDataExtensionsApiWithConfig creates an API instance using the provided configuration -func NewDataExtensionsApiWithConfig(config *Configuration) *DataExtensionsApi { - config.Debugf("Creating DataExtensionsApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &DataExtensionsApi{ - Configuration: config, - } -} - -// GetDataextensionsCoretype invokes GET /api/v2/dataextensions/coretypes/{coretypeName} -// -// Get a specific named core type. -// -// -func (a DataExtensionsApi) GetDataextensionsCoretype(coretypeName string) (*Coretype, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/dataextensions/coretypes/{coretypeName}" - path = strings.Replace(path, "{coretypeName}", fmt.Sprintf("%v", coretypeName), -1) - defaultReturn := new(Coretype) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'coretypeName' is set - if &coretypeName == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'coretypeName' when calling DataExtensionsApi->GetDataextensionsCoretype") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Coretype - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetDataextensionsCoretypes invokes GET /api/v2/dataextensions/coretypes -// -// Get the core types from which all schemas are built. -// -// -func (a DataExtensionsApi) GetDataextensionsCoretypes() (*Coretypelisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/dataextensions/coretypes" - defaultReturn := new(Coretypelisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Coretypelisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetDataextensionsLimits invokes GET /api/v2/dataextensions/limits -// -// Get quantitative limits on schemas -// -// -func (a DataExtensionsApi) GetDataextensionsLimits() (*Schemaquantitylimits, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/dataextensions/limits" - defaultReturn := new(Schemaquantitylimits) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Schemaquantitylimits - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/dataschema.go b/build/platformclientv2/dataschema.go deleted file mode 100644 index 008bc4483..000000000 --- a/build/platformclientv2/dataschema.go +++ /dev/null @@ -1,50 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Dataschema -type Dataschema struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Version - The schema's version, a positive integer. Required for updates. - Version *int `json:"version,omitempty"` - - - // AppliesTo - One of \"CONTACT\" or \"EXTERNAL_ORGANIZATION\". Indicates the built-in entity type to which this schema applies. - AppliesTo *[]string `json:"appliesTo,omitempty"` - - - // Enabled - The schema's enabled/disabled status. A disabled schema cannot be assigned to any other entities, but the data on those entities from the schema still exists. - Enabled *bool `json:"enabled,omitempty"` - - - // CreatedBy - The URI of the user that created this schema. - CreatedBy *Domainentityref `json:"createdBy,omitempty"` - - - // DateCreated - The date and time this schema was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // JsonSchema - A JSON schema defining the extension to the built-in entity type. - JsonSchema *Jsonschemadocument `json:"jsonSchema,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dataschema) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dataschemalisting.go b/build/platformclientv2/dataschemalisting.go deleted file mode 100644 index 01292d7c1..000000000 --- a/build/platformclientv2/dataschemalisting.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dataschemalisting -type Dataschemalisting struct { - // Total - Total *int `json:"total,omitempty"` - - - // Entities - Entities *[]Dataschema `json:"entities,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dataschemalisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/datatable.go b/build/platformclientv2/datatable.go deleted file mode 100644 index c6ab42515..000000000 --- a/build/platformclientv2/datatable.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Datatable - Contains a metadata representation for a JSON schema stored in DataTables along with an optional field for the schema itself -type Datatable struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Description - The description from the JSON schema (equates to the Description field on the JSON schema.) - Description *string `json:"description,omitempty"` - - - // Schema - the schema as stored in the system. - Schema *Jsonschemadocument `json:"schema,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Datatable) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/datatableexportjob.go b/build/platformclientv2/datatableexportjob.go deleted file mode 100644 index 13c8e9e24..000000000 --- a/build/platformclientv2/datatableexportjob.go +++ /dev/null @@ -1,54 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Datatableexportjob - State information for an export job of rows from a datatable -type Datatableexportjob struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Owner - The PureCloud user who started the export job - Owner *Addressableentityref `json:"owner,omitempty"` - - - // Status - The status of the export job - Status *string `json:"status,omitempty"` - - - // DateCreated - The timestamp of when the export began. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateCompleted - The timestamp of when the export stopped (either successfully or unsuccessfully). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCompleted *time.Time `json:"dateCompleted,omitempty"` - - - // DownloadURI - The URL of the location at which the caller can download the export file, when available - DownloadURI *string `json:"downloadURI,omitempty"` - - - // ErrorInformation - Any error information, or null of the processing is not in an error state - ErrorInformation *Errorbody `json:"errorInformation,omitempty"` - - - // CountRecordsProcessed - The current count of the number of records processed - CountRecordsProcessed *int `json:"countRecordsProcessed,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Datatableexportjob) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/datatableimportjob.go b/build/platformclientv2/datatableimportjob.go deleted file mode 100644 index 07623caa8..000000000 --- a/build/platformclientv2/datatableimportjob.go +++ /dev/null @@ -1,66 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Datatableimportjob - State information for an import job of rows to a datatable -type Datatableimportjob struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Owner - The PureCloud user who started the import job - Owner *Addressableentityref `json:"owner,omitempty"` - - - // Status - The status of the import job - Status *string `json:"status,omitempty"` - - - // DateCreated - The timestamp of when the import began. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateCompleted - The timestamp of when the import stopped (either successfully or unsuccessfully). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCompleted *time.Time `json:"dateCompleted,omitempty"` - - - // UploadURI - The URL of the location at which the caller can upload the file to be imported - UploadURI *string `json:"uploadURI,omitempty"` - - - // ImportMode - The indication of whether the processing should remove rows that don't appear in the import file - ImportMode *string `json:"importMode,omitempty"` - - - // ErrorInformation - Any error information, or null of the processing is not in an error state - ErrorInformation *Errorbody `json:"errorInformation,omitempty"` - - - // CountRecordsUpdated - The current count of the number of records processed - CountRecordsUpdated *int `json:"countRecordsUpdated,omitempty"` - - - // CountRecordsDeleted - The current count of the number of records deleted - CountRecordsDeleted *int `json:"countRecordsDeleted,omitempty"` - - - // CountRecordsFailed - The current count of the number of records that failed to import - CountRecordsFailed *int `json:"countRecordsFailed,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Datatableimportjob) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/datatablerowentitylisting.go b/build/platformclientv2/datatablerowentitylisting.go deleted file mode 100644 index 9253a64f9..000000000 --- a/build/platformclientv2/datatablerowentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Datatablerowentitylisting -type Datatablerowentitylisting struct { - // Entities - Entities *[]map[string]interface{} `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Datatablerowentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/datatablesdomainentitylisting.go b/build/platformclientv2/datatablesdomainentitylisting.go deleted file mode 100644 index 399201883..000000000 --- a/build/platformclientv2/datatablesdomainentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Datatablesdomainentitylisting -type Datatablesdomainentitylisting struct { - // Entities - Entities *[]Datatable `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Datatablesdomainentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/daterange.go b/build/platformclientv2/daterange.go deleted file mode 100644 index c11dddcef..000000000 --- a/build/platformclientv2/daterange.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Daterange -type Daterange struct { - // StartDate - The inclusive start of a date range in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone. - StartDate *string `json:"startDate,omitempty"` - - - // EndDate - The inclusive end of a date range in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone. - EndDate *string `json:"endDate,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Daterange) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/daterangewithoptionalend.go b/build/platformclientv2/daterangewithoptionalend.go deleted file mode 100644 index 3b970df3f..000000000 --- a/build/platformclientv2/daterangewithoptionalend.go +++ /dev/null @@ -1,22 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Daterangewithoptionalend -type Daterangewithoptionalend struct { - // StartBusinessUnitDate - The start date for work plan rotation or an agent, interpreted in the business unit's time zone. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd - StartBusinessUnitDate *time.Time `json:"startBusinessUnitDate,omitempty"` - - - // EndBusinessUnitDate - The end date for work plan rotation or an agent, interpreted in the business unit's time zone. Null denotes open ended date range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd - EndBusinessUnitDate *time.Time `json:"endBusinessUnitDate,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Daterangewithoptionalend) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/defaultgreetinglist.go b/build/platformclientv2/defaultgreetinglist.go deleted file mode 100644 index 18536af6a..000000000 --- a/build/platformclientv2/defaultgreetinglist.go +++ /dev/null @@ -1,54 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Defaultgreetinglist -type Defaultgreetinglist struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Owner - Owner *Greetingowner `json:"owner,omitempty"` - - - // OwnerType - OwnerType *string `json:"ownerType,omitempty"` - - - // Greetings - Greetings *map[string]Greeting `json:"greetings,omitempty"` - - - // CreatedDate - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - CreatedDate *time.Time `json:"createdDate,omitempty"` - - - // CreatedBy - CreatedBy *string `json:"createdBy,omitempty"` - - - // ModifiedDate - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ModifiedDate *time.Time `json:"modifiedDate,omitempty"` - - - // ModifiedBy - ModifiedBy *string `json:"modifiedBy,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Defaultgreetinglist) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/deletableuserreference.go b/build/platformclientv2/deletableuserreference.go deleted file mode 100644 index fccff60b5..000000000 --- a/build/platformclientv2/deletableuserreference.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Deletableuserreference - User reference with delete flag to remove the user from an associated entity -type Deletableuserreference struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Delete - If marked true, the user will be removed an associated entity - Delete *bool `json:"delete,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Deletableuserreference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/deleteretention.go b/build/platformclientv2/deleteretention.go deleted file mode 100644 index f34b8e69f..000000000 --- a/build/platformclientv2/deleteretention.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Deleteretention -type Deleteretention struct { - // Days - Days *int `json:"days,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Deleteretention) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dependency.go b/build/platformclientv2/dependency.go deleted file mode 100644 index 28f168206..000000000 --- a/build/platformclientv2/dependency.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dependency -type Dependency struct { - // Id - The dependency identifier - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Version - Version *string `json:"version,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - - - // Deleted - Deleted *bool `json:"deleted,omitempty"` - - - // Updated - Updated *bool `json:"updated,omitempty"` - - - // StateUnknown - StateUnknown *bool `json:"stateUnknown,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dependency) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dependencyobject.go b/build/platformclientv2/dependencyobject.go deleted file mode 100644 index 0d6d992cf..000000000 --- a/build/platformclientv2/dependencyobject.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dependencyobject -type Dependencyobject struct { - // Id - The dependency identifier - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Version - Version *string `json:"version,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - - - // Deleted - Deleted *bool `json:"deleted,omitempty"` - - - // Updated - Updated *bool `json:"updated,omitempty"` - - - // StateUnknown - StateUnknown *bool `json:"stateUnknown,omitempty"` - - - // ConsumedResources - ConsumedResources *[]Dependency `json:"consumedResources,omitempty"` - - - // ConsumingResources - ConsumingResources *[]Dependency `json:"consumingResources,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dependencyobject) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dependencyobjectentitylisting.go b/build/platformclientv2/dependencyobjectentitylisting.go deleted file mode 100644 index 8327dd135..000000000 --- a/build/platformclientv2/dependencyobjectentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dependencyobjectentitylisting -type Dependencyobjectentitylisting struct { - // Entities - Entities *[]Dependencyobject `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dependencyobjectentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dependencystatus.go b/build/platformclientv2/dependencystatus.go deleted file mode 100644 index 234b2fe9c..000000000 --- a/build/platformclientv2/dependencystatus.go +++ /dev/null @@ -1,54 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Dependencystatus -type Dependencystatus struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // User - User that initiated the build. - User *User `json:"user,omitempty"` - - - // Client - OAuth client that initiated the build. - Client *Domainentityref `json:"client,omitempty"` - - - // BuildId - BuildId *string `json:"buildId,omitempty"` - - - // DateStarted - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateStarted *time.Time `json:"dateStarted,omitempty"` - - - // DateCompleted - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCompleted *time.Time `json:"dateCompleted,omitempty"` - - - // Status - Status *string `json:"status,omitempty"` - - - // FailedObjects - FailedObjects *[]Failedobject `json:"failedObjects,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dependencystatus) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dependencytype.go b/build/platformclientv2/dependencytype.go deleted file mode 100644 index 3a74fc2d1..000000000 --- a/build/platformclientv2/dependencytype.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dependencytype -type Dependencytype struct { - // Id - The dependency type identifier - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Versioned - Versioned *bool `json:"versioned,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dependencytype) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dependencytypeentitylisting.go b/build/platformclientv2/dependencytypeentitylisting.go deleted file mode 100644 index 9a8739d20..000000000 --- a/build/platformclientv2/dependencytypeentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dependencytypeentitylisting -type Dependencytypeentitylisting struct { - // Entities - Entities *[]Dependencytype `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dependencytypeentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/destination.go b/build/platformclientv2/destination.go deleted file mode 100644 index 991a67672..000000000 --- a/build/platformclientv2/destination.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Destination -type Destination struct { - // Address - Address or phone number. - Address *string `json:"address,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // UserId - UserId *string `json:"userId,omitempty"` - - - // QueueId - QueueId *string `json:"queueId,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Destination) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/detail.go b/build/platformclientv2/detail.go deleted file mode 100644 index 6e3c52efc..000000000 --- a/build/platformclientv2/detail.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Detail -type Detail struct { - // ErrorCode - ErrorCode *string `json:"errorCode,omitempty"` - - - // FieldName - FieldName *string `json:"fieldName,omitempty"` - - - // EntityId - EntityId *string `json:"entityId,omitempty"` - - - // EntityName - EntityName *string `json:"entityName,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Detail) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/detecteddialogact.go b/build/platformclientv2/detecteddialogact.go deleted file mode 100644 index 4b2e8d16a..000000000 --- a/build/platformclientv2/detecteddialogact.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Detecteddialogact -type Detecteddialogact struct { - // Name - The name of the detected dialog act. - Name *string `json:"name,omitempty"` - - - // Probability - The probability of the detected dialog act. - Probability *float64 `json:"probability,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Detecteddialogact) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/detectedintent.go b/build/platformclientv2/detectedintent.go deleted file mode 100644 index 08f53cbc6..000000000 --- a/build/platformclientv2/detectedintent.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Detectedintent -type Detectedintent struct { - // Name - The name of the detected intent. - Name *string `json:"name,omitempty"` - - - // Probability - The probability of the detected intent. - Probability *float64 `json:"probability,omitempty"` - - - // Entities - The collection of named entities detected. - Entities *[]Detectednamedentity `json:"entities,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Detectedintent) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/detectednamedentity.go b/build/platformclientv2/detectednamedentity.go deleted file mode 100644 index 5a481931a..000000000 --- a/build/platformclientv2/detectednamedentity.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Detectednamedentity -type Detectednamedentity struct { - // Name - The name of the detected named entity. - Name *string `json:"name,omitempty"` - - - // EntityType - The type of the detected named entity. - EntityType *string `json:"entityType,omitempty"` - - - // Probability - The probability of the detected named entity. - Probability *float64 `json:"probability,omitempty"` - - - // Value - The value of the detected named entity. - Value *Detectednamedentityvalue `json:"value,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Detectednamedentity) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/detectednamedentityvalue.go b/build/platformclientv2/detectednamedentityvalue.go deleted file mode 100644 index 3edce2f99..000000000 --- a/build/platformclientv2/detectednamedentityvalue.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Detectednamedentityvalue -type Detectednamedentityvalue struct { - // Raw - The raw value of the detected named entity. - Raw *string `json:"raw,omitempty"` - - - // Resolved - The resolved value of the detected named entity. - Resolved *string `json:"resolved,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Detectednamedentityvalue) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/developmentactivity.go b/build/platformclientv2/developmentactivity.go deleted file mode 100644 index d3699d962..000000000 --- a/build/platformclientv2/developmentactivity.go +++ /dev/null @@ -1,62 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Developmentactivity - Development Activity object -type Developmentactivity struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // DateCompleted - Date that activity was completed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCompleted *time.Time `json:"dateCompleted,omitempty"` - - - // CreatedBy - User that created activity - CreatedBy *Userreference `json:"createdBy,omitempty"` - - - // DateCreated - Date activity was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - - - // Name - The name of the activity - Name *string `json:"name,omitempty"` - - - // VarType - The type of activity - VarType *string `json:"type,omitempty"` - - - // Status - The status of the activity - Status *string `json:"status,omitempty"` - - - // DateDue - Due date for completion of the activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateDue *time.Time `json:"dateDue,omitempty"` - - - // Facilitator - Facilitator of the activity - Facilitator *Userreference `json:"facilitator,omitempty"` - - - // Attendees - List of users attending the activity - Attendees *[]Userreference `json:"attendees,omitempty"` - - - // IsOverdue - Indicates if the activity is overdue - IsOverdue *bool `json:"isOverdue,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Developmentactivity) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/developmentactivityaggregateparam.go b/build/platformclientv2/developmentactivityaggregateparam.go deleted file mode 100644 index a31aac2f4..000000000 --- a/build/platformclientv2/developmentactivityaggregateparam.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Developmentactivityaggregateparam -type Developmentactivityaggregateparam struct { - // Interval - Specifies the range of due dates to be used for filtering. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. 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 - Interval *string `json:"interval,omitempty"` - - - // Metrics - The list of metrics to be returned. If omitted, all metrics are returned. - Metrics *[]string `json:"metrics,omitempty"` - - - // GroupBy - Specifies if the aggregated data is combined into a single set of metrics (groupBy is empty or not specified), or contains an element per attendeeId (groupBy is \"attendeeId\") - GroupBy *[]string `json:"groupBy,omitempty"` - - - // Filter - The filter applied to the data. This is ANDed with the interval parameter. - Filter *Developmentactivityaggregatequeryrequestfilter `json:"filter,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Developmentactivityaggregateparam) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/developmentactivityaggregatequeryrequestclause.go b/build/platformclientv2/developmentactivityaggregatequeryrequestclause.go deleted file mode 100644 index fe0db3225..000000000 --- a/build/platformclientv2/developmentactivityaggregatequeryrequestclause.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Developmentactivityaggregatequeryrequestclause -type Developmentactivityaggregatequeryrequestclause struct { - // VarType - The logic used to combine the predicates - VarType *string `json:"type,omitempty"` - - - // Predicates - The list of predicates used to filter the data - Predicates *[]Developmentactivityaggregatequeryrequestpredicate `json:"predicates,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Developmentactivityaggregatequeryrequestclause) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/developmentactivityaggregatequeryrequestfilter.go b/build/platformclientv2/developmentactivityaggregatequeryrequestfilter.go deleted file mode 100644 index 50726c308..000000000 --- a/build/platformclientv2/developmentactivityaggregatequeryrequestfilter.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Developmentactivityaggregatequeryrequestfilter -type Developmentactivityaggregatequeryrequestfilter struct { - // VarType - The logic used to combine the clauses - VarType *string `json:"type,omitempty"` - - - // Clauses - The list of clauses used to filter the data. Note that clauses must filter by attendeeId and a maximum of 100 user IDs are allowed - Clauses *[]Developmentactivityaggregatequeryrequestclause `json:"clauses,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Developmentactivityaggregatequeryrequestfilter) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/developmentactivityaggregatequeryrequestpredicate.go b/build/platformclientv2/developmentactivityaggregatequeryrequestpredicate.go deleted file mode 100644 index 5a33183cc..000000000 --- a/build/platformclientv2/developmentactivityaggregatequeryrequestpredicate.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Developmentactivityaggregatequeryrequestpredicate -type Developmentactivityaggregatequeryrequestpredicate struct { - // Dimension - Each predicates specifies a dimension. - Dimension *string `json:"dimension,omitempty"` - - - // Value - Corresponding value for dimensions in predicates. If the dimensions is type, Valid Values: Informational, Coaching - Value *string `json:"value,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Developmentactivityaggregatequeryrequestpredicate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/developmentactivityaggregatequeryresponsedata.go b/build/platformclientv2/developmentactivityaggregatequeryresponsedata.go deleted file mode 100644 index e13d1229c..000000000 --- a/build/platformclientv2/developmentactivityaggregatequeryresponsedata.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Developmentactivityaggregatequeryresponsedata -type Developmentactivityaggregatequeryresponsedata struct { - // Interval - Specifies the range of due dates to be used for filtering. A maximum of 1 year can be specified in the range. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss - Interval *string `json:"interval,omitempty"` - - - // Metrics - The list of aggregated metrics - Metrics *[]Developmentactivityaggregatequeryresponsemetric `json:"metrics,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Developmentactivityaggregatequeryresponsedata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/developmentactivityaggregatequeryresponsegroupeddata.go b/build/platformclientv2/developmentactivityaggregatequeryresponsegroupeddata.go deleted file mode 100644 index 1049bacbc..000000000 --- a/build/platformclientv2/developmentactivityaggregatequeryresponsegroupeddata.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Developmentactivityaggregatequeryresponsegroupeddata -type Developmentactivityaggregatequeryresponsegroupeddata struct { - // Group - The group values for this data - Group *map[string]string `json:"group,omitempty"` - - - // Data - The metrics in this group - Data *[]Developmentactivityaggregatequeryresponsedata `json:"data,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Developmentactivityaggregatequeryresponsegroupeddata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/developmentactivityaggregatequeryresponsemetric.go b/build/platformclientv2/developmentactivityaggregatequeryresponsemetric.go deleted file mode 100644 index 9cd136f35..000000000 --- a/build/platformclientv2/developmentactivityaggregatequeryresponsemetric.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Developmentactivityaggregatequeryresponsemetric -type Developmentactivityaggregatequeryresponsemetric struct { - // Metric - The metric this applies to - Metric *string `json:"metric,omitempty"` - - - // Stats - The aggregated values for this metric - Stats *Developmentactivityaggregatequeryresponsestatistics `json:"stats,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Developmentactivityaggregatequeryresponsemetric) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/developmentactivityaggregatequeryresponsestatistics.go b/build/platformclientv2/developmentactivityaggregatequeryresponsestatistics.go deleted file mode 100644 index aa65133be..000000000 --- a/build/platformclientv2/developmentactivityaggregatequeryresponsestatistics.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Developmentactivityaggregatequeryresponsestatistics -type Developmentactivityaggregatequeryresponsestatistics struct { - // Count - The count for this metric - Count *int `json:"count,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Developmentactivityaggregatequeryresponsestatistics) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/developmentactivityaggregateresponse.go b/build/platformclientv2/developmentactivityaggregateresponse.go deleted file mode 100644 index d3d3c1f27..000000000 --- a/build/platformclientv2/developmentactivityaggregateresponse.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Developmentactivityaggregateresponse -type Developmentactivityaggregateresponse struct { - // Results - The results of the query - Results *[]Developmentactivityaggregatequeryresponsegroupeddata `json:"results,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Developmentactivityaggregateresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/developmentactivitylisting.go b/build/platformclientv2/developmentactivitylisting.go deleted file mode 100644 index 213971fbd..000000000 --- a/build/platformclientv2/developmentactivitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Developmentactivitylisting -type Developmentactivitylisting struct { - // Entities - Entities *[]Developmentactivity `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Developmentactivitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialeraction.go b/build/platformclientv2/dialeraction.go deleted file mode 100644 index a0c8a72a1..000000000 --- a/build/platformclientv2/dialeraction.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dialeraction -type Dialeraction struct { - // VarType - The type of this DialerAction. - VarType *string `json:"type,omitempty"` - - - // ActionTypeName - Additional type specification for this DialerAction. - ActionTypeName *string `json:"actionTypeName,omitempty"` - - - // UpdateOption - Specifies how a contact attribute should be updated. Required for MODIFY_CONTACT_ATTRIBUTE. - UpdateOption *string `json:"updateOption,omitempty"` - - - // Properties - A map of key-value pairs pertinent to the DialerAction. Different types of DialerActions require different properties. MODIFY_CONTACT_ATTRIBUTE with an updateOption of SET takes a contact column as the key and accepts any value. SCHEDULE_CALLBACK takes a key 'callbackOffset' that specifies how far in the future the callback should be scheduled, in minutes. SET_CALLER_ID takes two keys: 'callerAddress', which should be the caller id phone number, and 'callerName'. For either key, you can also specify a column on the contact to get the value from. To do this, specify 'contact.Column', where 'Column' is the name of the contact column from which to get the value. SET_SKILLS takes a key 'skills' with an array of skill ids wrapped into a string (Example: {'skills': '['skillIdHere']'} ). - Properties *map[string]string `json:"properties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialeraction) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialerattemptlimitsconfigchangeattemptlimits.go b/build/platformclientv2/dialerattemptlimitsconfigchangeattemptlimits.go deleted file mode 100644 index c5d910e3e..000000000 --- a/build/platformclientv2/dialerattemptlimitsconfigchangeattemptlimits.go +++ /dev/null @@ -1,62 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Dialerattemptlimitsconfigchangeattemptlimits -type Dialerattemptlimitsconfigchangeattemptlimits struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // DateCreated - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - DateModified *time.Time `json:"dateModified,omitempty"` - - - // Version - Version *int `json:"version,omitempty"` - - - // MaxAttemptsPerContact - MaxAttemptsPerContact *int `json:"maxAttemptsPerContact,omitempty"` - - - // MaxAttemptsPerNumber - MaxAttemptsPerNumber *int `json:"maxAttemptsPerNumber,omitempty"` - - - // TimeZoneId - TimeZoneId *string `json:"timeZoneId,omitempty"` - - - // ResetPeriod - ResetPeriod *string `json:"resetPeriod,omitempty"` - - - // RecallEntries - RecallEntries *map[string]Dialerattemptlimitsconfigchangerecallentry `json:"recallEntries,omitempty"` - - - // BreadthFirstRecalls - BreadthFirstRecalls *bool `json:"breadthFirstRecalls,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialerattemptlimitsconfigchangeattemptlimits) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialerattemptlimitsconfigchangerecallentry.go b/build/platformclientv2/dialerattemptlimitsconfigchangerecallentry.go deleted file mode 100644 index a05673c03..000000000 --- a/build/platformclientv2/dialerattemptlimitsconfigchangerecallentry.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dialerattemptlimitsconfigchangerecallentry -type Dialerattemptlimitsconfigchangerecallentry struct { - // NbrAttempts - NbrAttempts *int `json:"nbrAttempts,omitempty"` - - - // MinutesBetweenAttempts - MinutesBetweenAttempts *int `json:"minutesBetweenAttempts,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialerattemptlimitsconfigchangerecallentry) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialerauditrequest.go b/build/platformclientv2/dialerauditrequest.go deleted file mode 100644 index d8e36c618..000000000 --- a/build/platformclientv2/dialerauditrequest.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dialerauditrequest -type Dialerauditrequest struct { - // QueryPhrase - The word or words to search for. - QueryPhrase *string `json:"queryPhrase,omitempty"` - - - // QueryFields - The fields in which to search for the queryPhrase. - QueryFields *[]string `json:"queryFields,omitempty"` - - - // Facets - The fields to facet on. - Facets *[]Auditfacet `json:"facets,omitempty"` - - - // Filters - The fields to filter on. - Filters *[]Auditfilter `json:"filters,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialerauditrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialercallabletimesetconfigchangecallabletime.go b/build/platformclientv2/dialercallabletimesetconfigchangecallabletime.go deleted file mode 100644 index 70c589f2a..000000000 --- a/build/platformclientv2/dialercallabletimesetconfigchangecallabletime.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dialercallabletimesetconfigchangecallabletime -type Dialercallabletimesetconfigchangecallabletime struct { - // TimeSlots - TimeSlots *[]Dialercallabletimesetconfigchangetimeslot `json:"timeSlots,omitempty"` - - - // TimeZoneId - TimeZoneId *string `json:"timeZoneId,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialercallabletimesetconfigchangecallabletime) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialercallabletimesetconfigchangecallabletimeset.go b/build/platformclientv2/dialercallabletimesetconfigchangecallabletimeset.go deleted file mode 100644 index 024ce0cec..000000000 --- a/build/platformclientv2/dialercallabletimesetconfigchangecallabletimeset.go +++ /dev/null @@ -1,42 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Dialercallabletimesetconfigchangecallabletimeset -type Dialercallabletimesetconfigchangecallabletimeset struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // DateCreated - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - DateModified *time.Time `json:"dateModified,omitempty"` - - - // Version - Version *int `json:"version,omitempty"` - - - // CallableTimes - CallableTimes *[]Dialercallabletimesetconfigchangecallabletime `json:"callableTimes,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialercallabletimesetconfigchangecallabletimeset) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialercallabletimesetconfigchangetimeslot.go b/build/platformclientv2/dialercallabletimesetconfigchangetimeslot.go deleted file mode 100644 index 8c0baf9fb..000000000 --- a/build/platformclientv2/dialercallabletimesetconfigchangetimeslot.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dialercallabletimesetconfigchangetimeslot -type Dialercallabletimesetconfigchangetimeslot struct { - // StartTime - StartTime *string `json:"startTime,omitempty"` - - - // StopTime - StopTime *string `json:"stopTime,omitempty"` - - - // Day - Day *int `json:"day,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialercallabletimesetconfigchangetimeslot) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialercampaignconfigchangecampaign.go b/build/platformclientv2/dialercampaignconfigchangecampaign.go deleted file mode 100644 index 14424bd2a..000000000 --- a/build/platformclientv2/dialercampaignconfigchangecampaign.go +++ /dev/null @@ -1,150 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Dialercampaignconfigchangecampaign -type Dialercampaignconfigchangecampaign struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // DateCreated - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - DateModified *time.Time `json:"dateModified,omitempty"` - - - // Version - Version *int `json:"version,omitempty"` - - - // ContactList - ContactList *Dialercampaignconfigchangeurireference `json:"contactList,omitempty"` - - - // Queue - Queue *Dialercampaignconfigchangeurireference `json:"queue,omitempty"` - - - // DialingMode - DialingMode *string `json:"dialingMode,omitempty"` - - - // Script - Script *Dialercampaignconfigchangeurireference `json:"script,omitempty"` - - - // EdgeGroup - EdgeGroup *Dialercampaignconfigchangeurireference `json:"edgeGroup,omitempty"` - - - // Site - Site *Dialercampaignconfigchangeurireference `json:"site,omitempty"` - - - // CampaignStatus - CampaignStatus *string `json:"campaignStatus,omitempty"` - - - // PhoneColumns - PhoneColumns *[]Dialercampaignconfigchangephonecolumn `json:"phoneColumns,omitempty"` - - - // AbandonRate - AbandonRate *float32 `json:"abandonRate,omitempty"` - - - // DncLists - DncLists *[]Dialercampaignconfigchangeurireference `json:"dncLists,omitempty"` - - - // CallableTimeSet - CallableTimeSet *Dialercampaignconfigchangeurireference `json:"callableTimeSet,omitempty"` - - - // CallAnalysisResponseSet - CallAnalysisResponseSet *Dialercampaignconfigchangeurireference `json:"callAnalysisResponseSet,omitempty"` - - - // CallerName - CallerName *string `json:"callerName,omitempty"` - - - // CallerAddress - CallerAddress *string `json:"callerAddress,omitempty"` - - - // OutboundLineCount - OutboundLineCount *int `json:"outboundLineCount,omitempty"` - - - // Errors - Errors *[]Dialercampaignconfigchangeresterrordetail `json:"errors,omitempty"` - - - // RuleSets - RuleSets *[]Dialercampaignconfigchangeurireference `json:"ruleSets,omitempty"` - - - // SkipPreviewDisabled - SkipPreviewDisabled *bool `json:"skipPreviewDisabled,omitempty"` - - - // PreviewTimeOutSeconds - PreviewTimeOutSeconds *int `json:"previewTimeOutSeconds,omitempty"` - - - // SingleNumberPreview - SingleNumberPreview *bool `json:"singleNumberPreview,omitempty"` - - - // ContactSort - ContactSort *Dialercampaignconfigchangecontactsort `json:"contactSort,omitempty"` - - - // ContactSorts - ContactSorts *[]Dialercampaignconfigchangecontactsort `json:"contactSorts,omitempty"` - - - // NoAnswerTimeout - NoAnswerTimeout *int `json:"noAnswerTimeout,omitempty"` - - - // CallAnalysisLanguage - CallAnalysisLanguage *string `json:"callAnalysisLanguage,omitempty"` - - - // Priority - Priority *int `json:"priority,omitempty"` - - - // ContactListFilters - ContactListFilters *[]Dialercampaignconfigchangeurireference `json:"contactListFilters,omitempty"` - - - // Division - Division *Dialercampaignconfigchangeurireference `json:"division,omitempty"` - - - // AgentOwnedColumn - AgentOwnedColumn *string `json:"agentOwnedColumn,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialercampaignconfigchangecampaign) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialercampaignconfigchangecontactsort.go b/build/platformclientv2/dialercampaignconfigchangecontactsort.go deleted file mode 100644 index e438a6889..000000000 --- a/build/platformclientv2/dialercampaignconfigchangecontactsort.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dialercampaignconfigchangecontactsort -type Dialercampaignconfigchangecontactsort struct { - // FieldName - FieldName *string `json:"fieldName,omitempty"` - - - // Direction - Direction *string `json:"direction,omitempty"` - - - // Numeric - Numeric *bool `json:"numeric,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialercampaignconfigchangecontactsort) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialercampaignconfigchangephonecolumn.go b/build/platformclientv2/dialercampaignconfigchangephonecolumn.go deleted file mode 100644 index 810a5c7cd..000000000 --- a/build/platformclientv2/dialercampaignconfigchangephonecolumn.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dialercampaignconfigchangephonecolumn -type Dialercampaignconfigchangephonecolumn struct { - // ColumnName - ColumnName *string `json:"columnName,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialercampaignconfigchangephonecolumn) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialercampaignconfigchangeresterrordetail.go b/build/platformclientv2/dialercampaignconfigchangeresterrordetail.go deleted file mode 100644 index 273a60aa4..000000000 --- a/build/platformclientv2/dialercampaignconfigchangeresterrordetail.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dialercampaignconfigchangeresterrordetail -type Dialercampaignconfigchangeresterrordetail struct { - // VarError - VarError *string `json:"error,omitempty"` - - - // Details - Details *string `json:"details,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialercampaignconfigchangeresterrordetail) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialercampaignconfigchangeurireference.go b/build/platformclientv2/dialercampaignconfigchangeurireference.go deleted file mode 100644 index 2322ebb61..000000000 --- a/build/platformclientv2/dialercampaignconfigchangeurireference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dialercampaignconfigchangeurireference -type Dialercampaignconfigchangeurireference struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialercampaignconfigchangeurireference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialercampaignprogresseventcampaignprogress.go b/build/platformclientv2/dialercampaignprogresseventcampaignprogress.go deleted file mode 100644 index db9614c69..000000000 --- a/build/platformclientv2/dialercampaignprogresseventcampaignprogress.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dialercampaignprogresseventcampaignprogress -type Dialercampaignprogresseventcampaignprogress struct { - // Campaign - Campaign *Dialercampaignprogresseventurireference `json:"campaign,omitempty"` - - - // NumberOfContactsCalled - NumberOfContactsCalled *float32 `json:"numberOfContactsCalled,omitempty"` - - - // NumberOfContactsMessaged - NumberOfContactsMessaged *float32 `json:"numberOfContactsMessaged,omitempty"` - - - // TotalNumberOfContacts - TotalNumberOfContacts *float32 `json:"totalNumberOfContacts,omitempty"` - - - // Percentage - Percentage *int `json:"percentage,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialercampaignprogresseventcampaignprogress) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialercampaignprogresseventurireference.go b/build/platformclientv2/dialercampaignprogresseventurireference.go deleted file mode 100644 index 8d6c23943..000000000 --- a/build/platformclientv2/dialercampaignprogresseventurireference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dialercampaignprogresseventurireference -type Dialercampaignprogresseventurireference struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialercampaignprogresseventurireference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialercampaignruleconfigchangecampaignrule.go b/build/platformclientv2/dialercampaignruleconfigchangecampaignrule.go deleted file mode 100644 index 3066a67bc..000000000 --- a/build/platformclientv2/dialercampaignruleconfigchangecampaignrule.go +++ /dev/null @@ -1,58 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Dialercampaignruleconfigchangecampaignrule -type Dialercampaignruleconfigchangecampaignrule struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // DateCreated - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - DateModified *time.Time `json:"dateModified,omitempty"` - - - // Version - Version *int `json:"version,omitempty"` - - - // CampaignRuleEntities - CampaignRuleEntities *Dialercampaignruleconfigchangecampaignruleentities `json:"campaignRuleEntities,omitempty"` - - - // CampaignRuleConditions - CampaignRuleConditions *[]Dialercampaignruleconfigchangecampaignrulecondition `json:"campaignRuleConditions,omitempty"` - - - // CampaignRuleActions - CampaignRuleActions *[]Dialercampaignruleconfigchangecampaignruleaction `json:"campaignRuleActions,omitempty"` - - - // MatchAnyConditions - MatchAnyConditions *bool `json:"matchAnyConditions,omitempty"` - - - // Enabled - Enabled *bool `json:"enabled,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialercampaignruleconfigchangecampaignrule) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialercampaignruleconfigchangecampaignruleaction.go b/build/platformclientv2/dialercampaignruleconfigchangecampaignruleaction.go deleted file mode 100644 index 817013385..000000000 --- a/build/platformclientv2/dialercampaignruleconfigchangecampaignruleaction.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dialercampaignruleconfigchangecampaignruleaction -type Dialercampaignruleconfigchangecampaignruleaction struct { - // Id - Id *string `json:"id,omitempty"` - - - // Parameters - Parameters *map[string]string `json:"parameters,omitempty"` - - - // ActionType - ActionType *string `json:"actionType,omitempty"` - - - // CampaignRuleActionEntities - CampaignRuleActionEntities *Dialercampaignruleconfigchangecampaignruleactionentities `json:"campaignRuleActionEntities,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialercampaignruleconfigchangecampaignruleaction) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialercampaignruleconfigchangecampaignruleactionentities.go b/build/platformclientv2/dialercampaignruleconfigchangecampaignruleactionentities.go deleted file mode 100644 index 0b23fcf70..000000000 --- a/build/platformclientv2/dialercampaignruleconfigchangecampaignruleactionentities.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dialercampaignruleconfigchangecampaignruleactionentities -type Dialercampaignruleconfigchangecampaignruleactionentities struct { - // Campaigns - Campaigns *[]Dialercampaignruleconfigchangeurireference `json:"campaigns,omitempty"` - - - // Sequences - Sequences *[]Dialercampaignruleconfigchangeurireference `json:"sequences,omitempty"` - - - // UseTriggeringEntity - UseTriggeringEntity *bool `json:"useTriggeringEntity,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialercampaignruleconfigchangecampaignruleactionentities) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialercampaignruleconfigchangecampaignrulecondition.go b/build/platformclientv2/dialercampaignruleconfigchangecampaignrulecondition.go deleted file mode 100644 index 30671da89..000000000 --- a/build/platformclientv2/dialercampaignruleconfigchangecampaignrulecondition.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dialercampaignruleconfigchangecampaignrulecondition -type Dialercampaignruleconfigchangecampaignrulecondition struct { - // Id - Id *string `json:"id,omitempty"` - - - // Parameters - Parameters *map[string]string `json:"parameters,omitempty"` - - - // ConditionType - ConditionType *string `json:"conditionType,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialercampaignruleconfigchangecampaignrulecondition) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialercampaignruleconfigchangecampaignruleentities.go b/build/platformclientv2/dialercampaignruleconfigchangecampaignruleentities.go deleted file mode 100644 index 72bdc3e72..000000000 --- a/build/platformclientv2/dialercampaignruleconfigchangecampaignruleentities.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dialercampaignruleconfigchangecampaignruleentities -type Dialercampaignruleconfigchangecampaignruleentities struct { - // Campaigns - Campaigns *[]Dialercampaignruleconfigchangeurireference `json:"campaigns,omitempty"` - - - // Sequences - Sequences *[]Dialercampaignruleconfigchangeurireference `json:"sequences,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialercampaignruleconfigchangecampaignruleentities) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialercampaignruleconfigchangeurireference.go b/build/platformclientv2/dialercampaignruleconfigchangeurireference.go deleted file mode 100644 index 7f9e3733e..000000000 --- a/build/platformclientv2/dialercampaignruleconfigchangeurireference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dialercampaignruleconfigchangeurireference -type Dialercampaignruleconfigchangeurireference struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialercampaignruleconfigchangeurireference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialercampaignscheduleconfigchangecampaignschedule.go b/build/platformclientv2/dialercampaignscheduleconfigchangecampaignschedule.go deleted file mode 100644 index 87f4ebb3e..000000000 --- a/build/platformclientv2/dialercampaignscheduleconfigchangecampaignschedule.go +++ /dev/null @@ -1,50 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Dialercampaignscheduleconfigchangecampaignschedule -type Dialercampaignscheduleconfigchangecampaignschedule struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // DateCreated - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - DateModified *time.Time `json:"dateModified,omitempty"` - - - // Version - Version *int `json:"version,omitempty"` - - - // Intervals - Intervals *[]Dialercampaignscheduleconfigchangescheduleinterval `json:"intervals,omitempty"` - - - // TimeZone - TimeZone *string `json:"timeZone,omitempty"` - - - // Campaign - Campaign *Dialercampaignscheduleconfigchangeurireference `json:"campaign,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialercampaignscheduleconfigchangecampaignschedule) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialercampaignscheduleconfigchangescheduleinterval.go b/build/platformclientv2/dialercampaignscheduleconfigchangescheduleinterval.go deleted file mode 100644 index c09b3b368..000000000 --- a/build/platformclientv2/dialercampaignscheduleconfigchangescheduleinterval.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dialercampaignscheduleconfigchangescheduleinterval -type Dialercampaignscheduleconfigchangescheduleinterval struct { - // Start - Start *string `json:"start,omitempty"` - - - // End - End *string `json:"end,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialercampaignscheduleconfigchangescheduleinterval) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialercampaignscheduleconfigchangeurireference.go b/build/platformclientv2/dialercampaignscheduleconfigchangeurireference.go deleted file mode 100644 index db8d26b90..000000000 --- a/build/platformclientv2/dialercampaignscheduleconfigchangeurireference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dialercampaignscheduleconfigchangeurireference -type Dialercampaignscheduleconfigchangeurireference struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialercampaignscheduleconfigchangeurireference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialercontact.go b/build/platformclientv2/dialercontact.go deleted file mode 100644 index d7e8c3d14..000000000 --- a/build/platformclientv2/dialercontact.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dialercontact -type Dialercontact struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // ContactListId - The identifier of the contact list containing this contact. - ContactListId *string `json:"contactListId,omitempty"` - - - // Data - An ordered map of the contact's columns and corresponding values. - Data *map[string]interface{} `json:"data,omitempty"` - - - // CallRecords - A map of call records for the contact phone columns. - CallRecords *map[string]Callrecord `json:"callRecords,omitempty"` - - - // Callable - Indicates whether or not the contact can be called. - Callable *bool `json:"callable,omitempty"` - - - // PhoneNumberStatus - A map of phone number columns to PhoneNumberStatuses, which indicate if the phone number is callable or not. - PhoneNumberStatus *map[string]Phonenumberstatus `json:"phoneNumberStatus,omitempty"` - - - // ContactColumnTimeZones - Map containing data about the timezone the contact is mapped to. This will only be populated if the contact list has automatic timezone mapping turned on. The key is the column name. The value is the timezone it mapped to and the type of column: Phone or Zip - ContactColumnTimeZones *map[string]Contactcolumntimezone `json:"contactColumnTimeZones,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialercontact) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialercontactid.go b/build/platformclientv2/dialercontactid.go deleted file mode 100644 index 53a74c248..000000000 --- a/build/platformclientv2/dialercontactid.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dialercontactid -type Dialercontactid struct { - // Id - Id *string `json:"id,omitempty"` - - - // ContactListId - ContactListId *string `json:"contactListId,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialercontactid) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialercontactlistconfigchangecontactlist.go b/build/platformclientv2/dialercontactlistconfigchangecontactlist.go deleted file mode 100644 index 83efb5958..000000000 --- a/build/platformclientv2/dialercontactlistconfigchangecontactlist.go +++ /dev/null @@ -1,78 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Dialercontactlistconfigchangecontactlist -type Dialercontactlistconfigchangecontactlist struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // DateCreated - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - DateModified *time.Time `json:"dateModified,omitempty"` - - - // Version - Version *int `json:"version,omitempty"` - - - // ColumnNames - ColumnNames *[]string `json:"columnNames,omitempty"` - - - // PhoneColumns - PhoneColumns *[]Dialercontactlistconfigchangecontactphonenumbercolumn `json:"phoneColumns,omitempty"` - - - // ImportStatus - ImportStatus *Dialercontactlistconfigchangeimportstatus `json:"importStatus,omitempty"` - - - // PreviewModeColumnName - PreviewModeColumnName *string `json:"previewModeColumnName,omitempty"` - - - // PreviewModeAcceptedValues - PreviewModeAcceptedValues *[]string `json:"previewModeAcceptedValues,omitempty"` - - - // Size - Size *int `json:"size,omitempty"` - - - // AttemptLimits - AttemptLimits *Dialercontactlistconfigchangeurireference `json:"attemptLimits,omitempty"` - - - // AutomaticTimeZoneMapping - AutomaticTimeZoneMapping *bool `json:"automaticTimeZoneMapping,omitempty"` - - - // ZipCodeColumnName - ZipCodeColumnName *string `json:"zipCodeColumnName,omitempty"` - - - // Division - Division *Dialercontactlistconfigchangeurireference `json:"division,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialercontactlistconfigchangecontactlist) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialercontactlistconfigchangecontactphonenumbercolumn.go b/build/platformclientv2/dialercontactlistconfigchangecontactphonenumbercolumn.go deleted file mode 100644 index eca930a9b..000000000 --- a/build/platformclientv2/dialercontactlistconfigchangecontactphonenumbercolumn.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dialercontactlistconfigchangecontactphonenumbercolumn -type Dialercontactlistconfigchangecontactphonenumbercolumn struct { - // ColumnName - ColumnName *string `json:"columnName,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - - - // CallableTimeColumn - CallableTimeColumn *string `json:"callableTimeColumn,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialercontactlistconfigchangecontactphonenumbercolumn) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialercontactlistconfigchangeimportstatus.go b/build/platformclientv2/dialercontactlistconfigchangeimportstatus.go deleted file mode 100644 index f30d7e4b2..000000000 --- a/build/platformclientv2/dialercontactlistconfigchangeimportstatus.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dialercontactlistconfigchangeimportstatus -type Dialercontactlistconfigchangeimportstatus struct { - // ImportState - ImportState *string `json:"importState,omitempty"` - - - // TotalRecords - TotalRecords *int `json:"totalRecords,omitempty"` - - - // CompletedRecords - CompletedRecords *int `json:"completedRecords,omitempty"` - - - // PercentageComplete - PercentageComplete *int `json:"percentageComplete,omitempty"` - - - // FailureReason - FailureReason *string `json:"failureReason,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialercontactlistconfigchangeimportstatus) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialercontactlistconfigchangeurireference.go b/build/platformclientv2/dialercontactlistconfigchangeurireference.go deleted file mode 100644 index 51882c259..000000000 --- a/build/platformclientv2/dialercontactlistconfigchangeurireference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dialercontactlistconfigchangeurireference -type Dialercontactlistconfigchangeurireference struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialercontactlistconfigchangeurireference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialercontactlistfilterconfigchangecontactlistfilter.go b/build/platformclientv2/dialercontactlistfilterconfigchangecontactlistfilter.go deleted file mode 100644 index b98a957e5..000000000 --- a/build/platformclientv2/dialercontactlistfilterconfigchangecontactlistfilter.go +++ /dev/null @@ -1,54 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Dialercontactlistfilterconfigchangecontactlistfilter -type Dialercontactlistfilterconfigchangecontactlistfilter struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // DateCreated - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - DateModified *time.Time `json:"dateModified,omitempty"` - - - // Version - Version *int `json:"version,omitempty"` - - - // ContactList - ContactList *Dialercontactlistfilterconfigchangeurireference `json:"contactList,omitempty"` - - - // ContactListColumns - ContactListColumns *[]string `json:"contactListColumns,omitempty"` - - - // Clauses - Clauses *[]Dialercontactlistfilterconfigchangefilterclause `json:"clauses,omitempty"` - - - // FilterType - FilterType *string `json:"filterType,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialercontactlistfilterconfigchangecontactlistfilter) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialercontactlistfilterconfigchangefilterclause.go b/build/platformclientv2/dialercontactlistfilterconfigchangefilterclause.go deleted file mode 100644 index 6dccb1490..000000000 --- a/build/platformclientv2/dialercontactlistfilterconfigchangefilterclause.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dialercontactlistfilterconfigchangefilterclause -type Dialercontactlistfilterconfigchangefilterclause struct { - // FilterType - FilterType *string `json:"filterType,omitempty"` - - - // Predicates - Predicates *[]Dialercontactlistfilterconfigchangefilterpredicate `json:"predicates,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialercontactlistfilterconfigchangefilterclause) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialercontactlistfilterconfigchangefilterpredicate.go b/build/platformclientv2/dialercontactlistfilterconfigchangefilterpredicate.go deleted file mode 100644 index abd8c1308..000000000 --- a/build/platformclientv2/dialercontactlistfilterconfigchangefilterpredicate.go +++ /dev/null @@ -1,41 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dialercontactlistfilterconfigchangefilterpredicate -type Dialercontactlistfilterconfigchangefilterpredicate struct { - // Column - Column *string `json:"column,omitempty"` - - - // ColumnType - ColumnType *string `json:"columnType,omitempty"` - - - // Operator - Operator *string `json:"operator,omitempty"` - - - // Value - Value *string `json:"value,omitempty"` - - - // VarRange - VarRange *Dialercontactlistfilterconfigchangerange `json:"range,omitempty"` - - - // Inverted - Inverted *bool `json:"inverted,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialercontactlistfilterconfigchangefilterpredicate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialercontactlistfilterconfigchangerange.go b/build/platformclientv2/dialercontactlistfilterconfigchangerange.go deleted file mode 100644 index 609637d84..000000000 --- a/build/platformclientv2/dialercontactlistfilterconfigchangerange.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dialercontactlistfilterconfigchangerange -type Dialercontactlistfilterconfigchangerange struct { - // Min - Min *string `json:"min,omitempty"` - - - // Max - Max *string `json:"max,omitempty"` - - - // MinInclusive - MinInclusive *bool `json:"minInclusive,omitempty"` - - - // MaxInclusive - MaxInclusive *bool `json:"maxInclusive,omitempty"` - - - // InSet - InSet *[]string `json:"inSet,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialercontactlistfilterconfigchangerange) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialercontactlistfilterconfigchangeurireference.go b/build/platformclientv2/dialercontactlistfilterconfigchangeurireference.go deleted file mode 100644 index bc330839d..000000000 --- a/build/platformclientv2/dialercontactlistfilterconfigchangeurireference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dialercontactlistfilterconfigchangeurireference -type Dialercontactlistfilterconfigchangeurireference struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialercontactlistfilterconfigchangeurireference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialerdnclistconfigchangednclist.go b/build/platformclientv2/dialerdnclistconfigchangednclist.go deleted file mode 100644 index 09d292d58..000000000 --- a/build/platformclientv2/dialerdnclistconfigchangednclist.go +++ /dev/null @@ -1,66 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Dialerdnclistconfigchangednclist -type Dialerdnclistconfigchangednclist struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // DateCreated - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - DateModified *time.Time `json:"dateModified,omitempty"` - - - // Version - Version *int `json:"version,omitempty"` - - - // ImportStatus - ImportStatus *Dialerdnclistconfigchangeimportstatus `json:"importStatus,omitempty"` - - - // Size - Size *int `json:"size,omitempty"` - - - // DncSourceType - DncSourceType *string `json:"dncSourceType,omitempty"` - - - // LoginId - LoginId *string `json:"loginId,omitempty"` - - - // DncCodes - DncCodes *[]string `json:"dncCodes,omitempty"` - - - // LicenseId - LicenseId *string `json:"licenseId,omitempty"` - - - // Division - Division *Dialerdnclistconfigchangeurireference `json:"division,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialerdnclistconfigchangednclist) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialerdnclistconfigchangeimportstatus.go b/build/platformclientv2/dialerdnclistconfigchangeimportstatus.go deleted file mode 100644 index 49a40c05e..000000000 --- a/build/platformclientv2/dialerdnclistconfigchangeimportstatus.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dialerdnclistconfigchangeimportstatus -type Dialerdnclistconfigchangeimportstatus struct { - // ImportState - ImportState *string `json:"importState,omitempty"` - - - // TotalRecords - TotalRecords *int `json:"totalRecords,omitempty"` - - - // CompletedRecords - CompletedRecords *int `json:"completedRecords,omitempty"` - - - // PercentageComplete - PercentageComplete *int `json:"percentageComplete,omitempty"` - - - // FailureReason - FailureReason *string `json:"failureReason,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialerdnclistconfigchangeimportstatus) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialerdnclistconfigchangeurireference.go b/build/platformclientv2/dialerdnclistconfigchangeurireference.go deleted file mode 100644 index c2337e8b4..000000000 --- a/build/platformclientv2/dialerdnclistconfigchangeurireference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dialerdnclistconfigchangeurireference -type Dialerdnclistconfigchangeurireference struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialerdnclistconfigchangeurireference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialerevententitylisting.go b/build/platformclientv2/dialerevententitylisting.go deleted file mode 100644 index a56f51583..000000000 --- a/build/platformclientv2/dialerevententitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dialerevententitylisting -type Dialerevententitylisting struct { - // Entities - Entities *[]Eventlog `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialerevententitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialeroutboundsettingsconfigchangeatzmtimeslot.go b/build/platformclientv2/dialeroutboundsettingsconfigchangeatzmtimeslot.go deleted file mode 100644 index 4416149da..000000000 --- a/build/platformclientv2/dialeroutboundsettingsconfigchangeatzmtimeslot.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dialeroutboundsettingsconfigchangeatzmtimeslot -type Dialeroutboundsettingsconfigchangeatzmtimeslot struct { - // EarliestCallableTime - EarliestCallableTime *string `json:"earliestCallableTime,omitempty"` - - - // LatestCallableTime - LatestCallableTime *string `json:"latestCallableTime,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialeroutboundsettingsconfigchangeatzmtimeslot) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialeroutboundsettingsconfigchangeatzmtimeslotwithtimezone.go b/build/platformclientv2/dialeroutboundsettingsconfigchangeatzmtimeslotwithtimezone.go deleted file mode 100644 index 84a47b440..000000000 --- a/build/platformclientv2/dialeroutboundsettingsconfigchangeatzmtimeslotwithtimezone.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dialeroutboundsettingsconfigchangeatzmtimeslotwithtimezone -type Dialeroutboundsettingsconfigchangeatzmtimeslotwithtimezone struct { - // EarliestCallableTime - EarliestCallableTime *string `json:"earliestCallableTime,omitempty"` - - - // LatestCallableTime - LatestCallableTime *string `json:"latestCallableTime,omitempty"` - - - // TimeZoneId - TimeZoneId *string `json:"timeZoneId,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialeroutboundsettingsconfigchangeatzmtimeslotwithtimezone) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialeroutboundsettingsconfigchangeautomatictimezonemappingsettings.go b/build/platformclientv2/dialeroutboundsettingsconfigchangeautomatictimezonemappingsettings.go deleted file mode 100644 index 1d8a6f2ca..000000000 --- a/build/platformclientv2/dialeroutboundsettingsconfigchangeautomatictimezonemappingsettings.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dialeroutboundsettingsconfigchangeautomatictimezonemappingsettings -type Dialeroutboundsettingsconfigchangeautomatictimezonemappingsettings struct { - // CallableWindows - CallableWindows *[]Dialeroutboundsettingsconfigchangecallablewindow `json:"callableWindows,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialeroutboundsettingsconfigchangeautomatictimezonemappingsettings) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialeroutboundsettingsconfigchangecallablewindow.go b/build/platformclientv2/dialeroutboundsettingsconfigchangecallablewindow.go deleted file mode 100644 index 53aab002a..000000000 --- a/build/platformclientv2/dialeroutboundsettingsconfigchangecallablewindow.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dialeroutboundsettingsconfigchangecallablewindow -type Dialeroutboundsettingsconfigchangecallablewindow struct { - // Mapped - Mapped *Dialeroutboundsettingsconfigchangeatzmtimeslot `json:"mapped,omitempty"` - - - // Unmapped - Unmapped *Dialeroutboundsettingsconfigchangeatzmtimeslotwithtimezone `json:"unmapped,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialeroutboundsettingsconfigchangecallablewindow) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialeroutboundsettingsconfigchangeoutboundsettings.go b/build/platformclientv2/dialeroutboundsettingsconfigchangeoutboundsettings.go deleted file mode 100644 index 496b72aa1..000000000 --- a/build/platformclientv2/dialeroutboundsettingsconfigchangeoutboundsettings.go +++ /dev/null @@ -1,54 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Dialeroutboundsettingsconfigchangeoutboundsettings -type Dialeroutboundsettingsconfigchangeoutboundsettings struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // DateCreated - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - DateModified *time.Time `json:"dateModified,omitempty"` - - - // Version - Version *int `json:"version,omitempty"` - - - // MaxCallsPerAgent - MaxCallsPerAgent *int `json:"maxCallsPerAgent,omitempty"` - - - // MaxLineUtilization - MaxLineUtilization *float32 `json:"maxLineUtilization,omitempty"` - - - // AbandonSeconds - AbandonSeconds *float32 `json:"abandonSeconds,omitempty"` - - - // ComplianceAbandonRateDenominator - ComplianceAbandonRateDenominator *string `json:"complianceAbandonRateDenominator,omitempty"` - - - // AutomaticTimeZoneMapping - AutomaticTimeZoneMapping *Dialeroutboundsettingsconfigchangeautomatictimezonemappingsettings `json:"automaticTimeZoneMapping,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialeroutboundsettingsconfigchangeoutboundsettings) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialerpreview.go b/build/platformclientv2/dialerpreview.go deleted file mode 100644 index 946f8c613..000000000 --- a/build/platformclientv2/dialerpreview.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dialerpreview -type Dialerpreview struct { - // Id - Id *string `json:"id,omitempty"` - - - // ContactId - The contact associated with this preview data pop - ContactId *string `json:"contactId,omitempty"` - - - // ContactListId - The contactList associated with this preview data pop. - ContactListId *string `json:"contactListId,omitempty"` - - - // CampaignId - The campaignId associated with this preview data pop. - CampaignId *string `json:"campaignId,omitempty"` - - - // PhoneNumberColumns - The phone number columns associated with this campaign - PhoneNumberColumns *[]Phonenumbercolumn `json:"phoneNumberColumns,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialerpreview) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialerresponsesetconfigchangereaction.go b/build/platformclientv2/dialerresponsesetconfigchangereaction.go deleted file mode 100644 index 61a22330a..000000000 --- a/build/platformclientv2/dialerresponsesetconfigchangereaction.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dialerresponsesetconfigchangereaction -type Dialerresponsesetconfigchangereaction struct { - // Data - Data *string `json:"data,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // ReactionType - ReactionType *string `json:"reactionType,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialerresponsesetconfigchangereaction) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialerresponsesetconfigchangeresponseset.go b/build/platformclientv2/dialerresponsesetconfigchangeresponseset.go deleted file mode 100644 index 3e0890ad4..000000000 --- a/build/platformclientv2/dialerresponsesetconfigchangeresponseset.go +++ /dev/null @@ -1,46 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Dialerresponsesetconfigchangeresponseset -type Dialerresponsesetconfigchangeresponseset struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // DateCreated - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - DateModified *time.Time `json:"dateModified,omitempty"` - - - // Version - Version *int `json:"version,omitempty"` - - - // Responses - Responses *map[string]Dialerresponsesetconfigchangereaction `json:"responses,omitempty"` - - - // BeepDetectionEnabled - BeepDetectionEnabled *bool `json:"beepDetectionEnabled,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialerresponsesetconfigchangeresponseset) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialerrule.go b/build/platformclientv2/dialerrule.go deleted file mode 100644 index ada8dc8a6..000000000 --- a/build/platformclientv2/dialerrule.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dialerrule -type Dialerrule struct { - // Id - The identifier of the rule. - Id *string `json:"id,omitempty"` - - - // Name - The name of the rule. - Name *string `json:"name,omitempty"` - - - // Order - The ranked order of the rule. Rules are processed from lowest number to highest. - Order *int `json:"order,omitempty"` - - - // Category - The category of the rule. - Category *string `json:"category,omitempty"` - - - // Conditions - A list of Conditions. All of the Conditions must evaluate to true to trigger the actions. - Conditions *[]Condition `json:"conditions,omitempty"` - - - // Actions - The list of actions to be taken if the conditions are true. - Actions *[]Dialeraction `json:"actions,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialerrule) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialerrulesetconfigchangeaction.go b/build/platformclientv2/dialerrulesetconfigchangeaction.go deleted file mode 100644 index 1f733c0df..000000000 --- a/build/platformclientv2/dialerrulesetconfigchangeaction.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dialerrulesetconfigchangeaction -type Dialerrulesetconfigchangeaction struct { - // VarType - VarType *string `json:"type,omitempty"` - - - // ActionTypeName - ActionTypeName *string `json:"actionTypeName,omitempty"` - - - // UpdateOption - UpdateOption *string `json:"updateOption,omitempty"` - - - // Properties - Properties *map[string]string `json:"properties,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialerrulesetconfigchangeaction) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialerrulesetconfigchangecondition.go b/build/platformclientv2/dialerrulesetconfigchangecondition.go deleted file mode 100644 index db9c9aa32..000000000 --- a/build/platformclientv2/dialerrulesetconfigchangecondition.go +++ /dev/null @@ -1,81 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dialerrulesetconfigchangecondition -type Dialerrulesetconfigchangecondition struct { - // VarType - VarType *string `json:"type,omitempty"` - - - // Inverted - Inverted *bool `json:"inverted,omitempty"` - - - // AttributeName - AttributeName *string `json:"attributeName,omitempty"` - - - // Value - Value *string `json:"value,omitempty"` - - - // ValueType - ValueType *string `json:"valueType,omitempty"` - - - // Operator - Operator *string `json:"operator,omitempty"` - - - // Codes - Codes *[]string `json:"codes,omitempty"` - - - // PropertyType - PropertyType *string `json:"propertyType,omitempty"` - - - // Property - Property *string `json:"property,omitempty"` - - - // DataNotFoundResolution - DataNotFoundResolution *bool `json:"dataNotFoundResolution,omitempty"` - - - // ContactIdField - ContactIdField *string `json:"contactIdField,omitempty"` - - - // CallAnalysisResultField - CallAnalysisResultField *string `json:"callAnalysisResultField,omitempty"` - - - // AgentWrapupField - AgentWrapupField *string `json:"agentWrapupField,omitempty"` - - - // ContactColumnToDataActionFieldMappings - ContactColumnToDataActionFieldMappings *[]Dialerrulesetconfigchangecontactcolumntodataactionfieldmapping `json:"contactColumnToDataActionFieldMappings,omitempty"` - - - // Predicates - Predicates *[]Dialerrulesetconfigchangedataactionconditionpredicate `json:"predicates,omitempty"` - - - // DataAction - DataAction *Dialerrulesetconfigchangeurireference `json:"dataAction,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialerrulesetconfigchangecondition) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialerrulesetconfigchangecontactcolumntodataactionfieldmapping.go b/build/platformclientv2/dialerrulesetconfigchangecontactcolumntodataactionfieldmapping.go deleted file mode 100644 index 9dd690f43..000000000 --- a/build/platformclientv2/dialerrulesetconfigchangecontactcolumntodataactionfieldmapping.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dialerrulesetconfigchangecontactcolumntodataactionfieldmapping -type Dialerrulesetconfigchangecontactcolumntodataactionfieldmapping struct { - // ContactColumnName - ContactColumnName *string `json:"contactColumnName,omitempty"` - - - // DataActionField - DataActionField *string `json:"dataActionField,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialerrulesetconfigchangecontactcolumntodataactionfieldmapping) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialerrulesetconfigchangedataactionconditionpredicate.go b/build/platformclientv2/dialerrulesetconfigchangedataactionconditionpredicate.go deleted file mode 100644 index 9a0f45241..000000000 --- a/build/platformclientv2/dialerrulesetconfigchangedataactionconditionpredicate.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dialerrulesetconfigchangedataactionconditionpredicate -type Dialerrulesetconfigchangedataactionconditionpredicate struct { - // OutputField - OutputField *string `json:"outputField,omitempty"` - - - // OutputOperator - OutputOperator *string `json:"outputOperator,omitempty"` - - - // ComparisonValue - ComparisonValue *string `json:"comparisonValue,omitempty"` - - - // OutputFieldMissingResolution - OutputFieldMissingResolution *bool `json:"outputFieldMissingResolution,omitempty"` - - - // Inverted - Inverted *bool `json:"inverted,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialerrulesetconfigchangedataactionconditionpredicate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialerrulesetconfigchangerule.go b/build/platformclientv2/dialerrulesetconfigchangerule.go deleted file mode 100644 index 180f676d6..000000000 --- a/build/platformclientv2/dialerrulesetconfigchangerule.go +++ /dev/null @@ -1,41 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dialerrulesetconfigchangerule -type Dialerrulesetconfigchangerule struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Order - Order *int `json:"order,omitempty"` - - - // Category - Category *string `json:"category,omitempty"` - - - // Actions - Actions *[]Dialerrulesetconfigchangeaction `json:"actions,omitempty"` - - - // Conditions - Conditions *[]Dialerrulesetconfigchangecondition `json:"conditions,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialerrulesetconfigchangerule) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialerrulesetconfigchangeruleset.go b/build/platformclientv2/dialerrulesetconfigchangeruleset.go deleted file mode 100644 index 168e6213e..000000000 --- a/build/platformclientv2/dialerrulesetconfigchangeruleset.go +++ /dev/null @@ -1,50 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Dialerrulesetconfigchangeruleset -type Dialerrulesetconfigchangeruleset struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // DateCreated - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - DateModified *time.Time `json:"dateModified,omitempty"` - - - // Version - Version *int `json:"version,omitempty"` - - - // ContactList - ContactList *Dialerrulesetconfigchangeurireference `json:"contactList,omitempty"` - - - // Queue - Queue *Dialerrulesetconfigchangeurireference `json:"queue,omitempty"` - - - // Rules - Rules *[]Dialerrulesetconfigchangerule `json:"rules,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialerrulesetconfigchangeruleset) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialerrulesetconfigchangeurireference.go b/build/platformclientv2/dialerrulesetconfigchangeurireference.go deleted file mode 100644 index d22593a36..000000000 --- a/build/platformclientv2/dialerrulesetconfigchangeurireference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dialerrulesetconfigchangeurireference -type Dialerrulesetconfigchangeurireference struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialerrulesetconfigchangeurireference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialersequenceconfigchangecampaignsequence.go b/build/platformclientv2/dialersequenceconfigchangecampaignsequence.go deleted file mode 100644 index 5b194589f..000000000 --- a/build/platformclientv2/dialersequenceconfigchangecampaignsequence.go +++ /dev/null @@ -1,58 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Dialersequenceconfigchangecampaignsequence -type Dialersequenceconfigchangecampaignsequence struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // DateCreated - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - DateModified *time.Time `json:"dateModified,omitempty"` - - - // Version - Version *int `json:"version,omitempty"` - - - // Campaigns - Campaigns *[]Dialersequenceconfigchangeurireference `json:"campaigns,omitempty"` - - - // CurrentCampaign - CurrentCampaign *int `json:"currentCampaign,omitempty"` - - - // Status - Status *string `json:"status,omitempty"` - - - // StopMessage - StopMessage *string `json:"stopMessage,omitempty"` - - - // Repeat - Repeat *bool `json:"repeat,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialersequenceconfigchangecampaignsequence) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialersequenceconfigchangeurireference.go b/build/platformclientv2/dialersequenceconfigchangeurireference.go deleted file mode 100644 index 366f6225b..000000000 --- a/build/platformclientv2/dialersequenceconfigchangeurireference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dialersequenceconfigchangeurireference -type Dialersequenceconfigchangeurireference struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialersequenceconfigchangeurireference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialersequencescheduleconfigchangescheduleinterval.go b/build/platformclientv2/dialersequencescheduleconfigchangescheduleinterval.go deleted file mode 100644 index 576fab4e0..000000000 --- a/build/platformclientv2/dialersequencescheduleconfigchangescheduleinterval.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dialersequencescheduleconfigchangescheduleinterval -type Dialersequencescheduleconfigchangescheduleinterval struct { - // Start - Start *string `json:"start,omitempty"` - - - // End - End *string `json:"end,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialersequencescheduleconfigchangescheduleinterval) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialersequencescheduleconfigchangesequenceschedule.go b/build/platformclientv2/dialersequencescheduleconfigchangesequenceschedule.go deleted file mode 100644 index 51aecfa4f..000000000 --- a/build/platformclientv2/dialersequencescheduleconfigchangesequenceschedule.go +++ /dev/null @@ -1,50 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Dialersequencescheduleconfigchangesequenceschedule -type Dialersequencescheduleconfigchangesequenceschedule struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // DateCreated - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - DateModified *time.Time `json:"dateModified,omitempty"` - - - // Version - Version *int `json:"version,omitempty"` - - - // Intervals - Intervals *[]Dialersequencescheduleconfigchangescheduleinterval `json:"intervals,omitempty"` - - - // TimeZone - TimeZone *string `json:"timeZone,omitempty"` - - - // Sequence - Sequence *Dialersequencescheduleconfigchangeurireference `json:"sequence,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialersequencescheduleconfigchangesequenceschedule) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialersequencescheduleconfigchangeurireference.go b/build/platformclientv2/dialersequencescheduleconfigchangeurireference.go deleted file mode 100644 index e038b5622..000000000 --- a/build/platformclientv2/dialersequencescheduleconfigchangeurireference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dialersequencescheduleconfigchangeurireference -type Dialersequencescheduleconfigchangeurireference struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialersequencescheduleconfigchangeurireference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialerwrapupcodemappingconfigchangewrapupcodemapping.go b/build/platformclientv2/dialerwrapupcodemappingconfigchangewrapupcodemapping.go deleted file mode 100644 index 8c4fa5dbe..000000000 --- a/build/platformclientv2/dialerwrapupcodemappingconfigchangewrapupcodemapping.go +++ /dev/null @@ -1,42 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Dialerwrapupcodemappingconfigchangewrapupcodemapping -type Dialerwrapupcodemappingconfigchangewrapupcodemapping struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // DateCreated - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - DateModified *time.Time `json:"dateModified,omitempty"` - - - // Version - Version *int `json:"version,omitempty"` - - - // DefaultSet - DefaultSet *[]string `json:"defaultSet,omitempty"` - - - // Mapping - Mapping *map[string][]string `json:"mapping,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialerwrapupcodemappingconfigchangewrapupcodemapping) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialogflowagent.go b/build/platformclientv2/dialogflowagent.go deleted file mode 100644 index 4b9836b56..000000000 --- a/build/platformclientv2/dialogflowagent.go +++ /dev/null @@ -1,41 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dialogflowagent -type Dialogflowagent struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Project - The project this Dialogflow agent belongs to - Project *Dialogflowproject `json:"project,omitempty"` - - - // Languages - The supported languages of the Dialogflow agent - Languages *[]string `json:"languages,omitempty"` - - - // Intents - An array of Intents associated with this agent - Intents *[]Dialogflowintent `json:"intents,omitempty"` - - - // Environments - Available environments for this agent - Environments *[]string `json:"environments,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialogflowagent) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialogflowagentsummary.go b/build/platformclientv2/dialogflowagentsummary.go deleted file mode 100644 index 75b4c9784..000000000 --- a/build/platformclientv2/dialogflowagentsummary.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dialogflowagentsummary -type Dialogflowagentsummary struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Project - The project this Dialogflow agent belongs to - Project *Dialogflowproject `json:"project,omitempty"` - - - // Description - A description of the Dialogflow agent - Description *string `json:"description,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialogflowagentsummary) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialogflowagentsummaryentitylisting.go b/build/platformclientv2/dialogflowagentsummaryentitylisting.go deleted file mode 100644 index f87272143..000000000 --- a/build/platformclientv2/dialogflowagentsummaryentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dialogflowagentsummaryentitylisting -type Dialogflowagentsummaryentitylisting struct { - // Entities - Entities *[]Dialogflowagentsummary `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialogflowagentsummaryentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialogflowintent.go b/build/platformclientv2/dialogflowintent.go deleted file mode 100644 index 70a9c238b..000000000 --- a/build/platformclientv2/dialogflowintent.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dialogflowintent -type Dialogflowintent struct { - // Name - The intent name - Name *string `json:"name,omitempty"` - - - // Parameters - An object mapping parameter names to Parameter objects - Parameters *map[string]Dialogflowparameter `json:"parameters,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialogflowintent) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialogflowparameter.go b/build/platformclientv2/dialogflowparameter.go deleted file mode 100644 index 6fc908110..000000000 --- a/build/platformclientv2/dialogflowparameter.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dialogflowparameter -type Dialogflowparameter struct { - // Name - The parameter name - Name *string `json:"name,omitempty"` - - - // VarType - The parameter type - VarType *string `json:"type,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialogflowparameter) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dialogflowproject.go b/build/platformclientv2/dialogflowproject.go deleted file mode 100644 index 78e46b95f..000000000 --- a/build/platformclientv2/dialogflowproject.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dialogflowproject -type Dialogflowproject struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dialogflowproject) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/did.go b/build/platformclientv2/did.go deleted file mode 100644 index 6018d463d..000000000 --- a/build/platformclientv2/did.go +++ /dev/null @@ -1,78 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Did -type Did struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the entity. - Name *string `json:"name,omitempty"` - - - // Description - The resource's description. - Description *string `json:"description,omitempty"` - - - // Version - The current version of the resource. - Version *int `json:"version,omitempty"` - - - // DateCreated - The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // ModifiedBy - The ID of the user that last modified the resource. - ModifiedBy *string `json:"modifiedBy,omitempty"` - - - // CreatedBy - The ID of the user that created the resource. - CreatedBy *string `json:"createdBy,omitempty"` - - - // State - Indicates if the resource is active, inactive, or deleted. - State *string `json:"state,omitempty"` - - - // ModifiedByApp - The application that last modified the resource. - ModifiedByApp *string `json:"modifiedByApp,omitempty"` - - - // CreatedByApp - The application that created the resource. - CreatedByApp *string `json:"createdByApp,omitempty"` - - - // PhoneNumber - PhoneNumber *string `json:"phoneNumber,omitempty"` - - - // DidPool - DidPool *Domainentityref `json:"didPool,omitempty"` - - - // Owner - A Uri reference to the owner of this DID, which is either a User or an IVR - Owner *Domainentityref `json:"owner,omitempty"` - - - // OwnerType - OwnerType *string `json:"ownerType,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Did) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/didentitylisting.go b/build/platformclientv2/didentitylisting.go deleted file mode 100644 index 6acf5e140..000000000 --- a/build/platformclientv2/didentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Didentitylisting -type Didentitylisting struct { - // Entities - Entities *[]Did `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Didentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/didnumber.go b/build/platformclientv2/didnumber.go deleted file mode 100644 index 581bc3a27..000000000 --- a/build/platformclientv2/didnumber.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Didnumber - Represents an unassigned or assigned DID in a DID Pool. -type Didnumber struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Number - The number of the DID formatted as E164. - Number *string `json:"number,omitempty"` - - - // Assigned - True if this DID is assigned to an entity. False otherwise. - Assigned *bool `json:"assigned,omitempty"` - - - // DidPool - A Uri reference to the DID Pool this DID is a part of. - DidPool *Addressableentityref `json:"didPool,omitempty"` - - - // Owner - A Uri reference to the owner of this DID. The owner's type can be found in ownerType. If the DID is unassigned, this will be NULL. - Owner *Domainentityref `json:"owner,omitempty"` - - - // OwnerType - The type of the entity that owns this DID. If the DID is unassigned, this will be NULL. - OwnerType *string `json:"ownerType,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Didnumber) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/didnumberentitylisting.go b/build/platformclientv2/didnumberentitylisting.go deleted file mode 100644 index d2e9b8b09..000000000 --- a/build/platformclientv2/didnumberentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Didnumberentitylisting -type Didnumberentitylisting struct { - // Entities - Entities *[]Didnumber `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Didnumberentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/didpool.go b/build/platformclientv2/didpool.go deleted file mode 100644 index 8e01e1c34..000000000 --- a/build/platformclientv2/didpool.go +++ /dev/null @@ -1,78 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Didpool -type Didpool struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the entity. - Name *string `json:"name,omitempty"` - - - // Description - The resource's description. - Description *string `json:"description,omitempty"` - - - // Version - The current version of the resource. - Version *int `json:"version,omitempty"` - - - // DateCreated - The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // ModifiedBy - The ID of the user that last modified the resource. - ModifiedBy *string `json:"modifiedBy,omitempty"` - - - // CreatedBy - The ID of the user that created the resource. - CreatedBy *string `json:"createdBy,omitempty"` - - - // State - Indicates if the resource is active, inactive, or deleted. - State *string `json:"state,omitempty"` - - - // ModifiedByApp - The application that last modified the resource. - ModifiedByApp *string `json:"modifiedByApp,omitempty"` - - - // CreatedByApp - The application that created the resource. - CreatedByApp *string `json:"createdByApp,omitempty"` - - - // StartPhoneNumber - The starting phone number for the range of this DID pool. Must be in E.164 format - StartPhoneNumber *string `json:"startPhoneNumber,omitempty"` - - - // EndPhoneNumber - The ending phone number for the range of this DID pool. Must be in E.164 format - EndPhoneNumber *string `json:"endPhoneNumber,omitempty"` - - - // Comments - Comments *string `json:"comments,omitempty"` - - - // Provider - The provider for this DID pool - Provider *string `json:"provider,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Didpool) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/didpoolentitylisting.go b/build/platformclientv2/didpoolentitylisting.go deleted file mode 100644 index a292ea03d..000000000 --- a/build/platformclientv2/didpoolentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Didpoolentitylisting -type Didpoolentitylisting struct { - // Entities - Entities *[]Didpool `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Didpoolentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/digitlength.go b/build/platformclientv2/digitlength.go deleted file mode 100644 index e2b2114e9..000000000 --- a/build/platformclientv2/digitlength.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Digitlength -type Digitlength struct { - // Start - Start *string `json:"start,omitempty"` - - - // End - End *string `json:"end,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Digitlength) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/digits.go b/build/platformclientv2/digits.go deleted file mode 100644 index 6369b20ad..000000000 --- a/build/platformclientv2/digits.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Digits -type Digits struct { - // Digits - A string representing the digits pressed on phone. - Digits *string `json:"digits,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Digits) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/directoryuserdeviceslisting.go b/build/platformclientv2/directoryuserdeviceslisting.go deleted file mode 100644 index b43fb4409..000000000 --- a/build/platformclientv2/directoryuserdeviceslisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Directoryuserdeviceslisting -type Directoryuserdeviceslisting struct { - // Entities - Entities *[]Userdevice `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Directoryuserdeviceslisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/disconnectreason.go b/build/platformclientv2/disconnectreason.go deleted file mode 100644 index c62f2ea44..000000000 --- a/build/platformclientv2/disconnectreason.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Disconnectreason -type Disconnectreason struct { - // VarType - Disconnect reason protocol type. - VarType *string `json:"type,omitempty"` - - - // Code - Protocol specific reason code. See the Q.850 and SIP specs. - Code *int `json:"code,omitempty"` - - - // Phrase - Human readable English description of the disconnect reason. - Phrase *string `json:"phrase,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Disconnectreason) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/divspermittedentitylisting.go b/build/platformclientv2/divspermittedentitylisting.go deleted file mode 100644 index 0309a096b..000000000 --- a/build/platformclientv2/divspermittedentitylisting.go +++ /dev/null @@ -1,57 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Divspermittedentitylisting -type Divspermittedentitylisting struct { - // Entities - Entities *[]Authzdivision `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // AllDivsPermitted - AllDivsPermitted *bool `json:"allDivsPermitted,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Divspermittedentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dnclist.go b/build/platformclientv2/dnclist.go deleted file mode 100644 index 82460986b..000000000 --- a/build/platformclientv2/dnclist.go +++ /dev/null @@ -1,66 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Dnclist -type Dnclist struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the DncList. - Name *string `json:"name,omitempty"` - - - // DateCreated - Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // Version - Required for updates, must match the version number of the most recent update - Version *int `json:"version,omitempty"` - - - // ImportStatus - The status of the import process - ImportStatus *Importstatus `json:"importStatus,omitempty"` - - - // Size - The total number of phone numbers in the DncList. - Size *int `json:"size,omitempty"` - - - // DncSourceType - The type of the DncList. - DncSourceType *string `json:"dncSourceType,omitempty"` - - - // LoginId - A dnc.com loginId. Required if the dncSourceType is dnc.com. - LoginId *string `json:"loginId,omitempty"` - - - // DncCodes - The list of dnc.com codes to be treated as DNC. Required if the dncSourceType is dnc.com. - DncCodes *[]string `json:"dncCodes,omitempty"` - - - // LicenseId - A gryphon license number. Required if the dncSourceType is gryphon. - LicenseId *string `json:"licenseId,omitempty"` - - - // Division - The division this DncList belongs to. - Division *Domainentityref `json:"division,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dnclist) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dnclistcreate.go b/build/platformclientv2/dnclistcreate.go deleted file mode 100644 index d746182ae..000000000 --- a/build/platformclientv2/dnclistcreate.go +++ /dev/null @@ -1,66 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Dnclistcreate -type Dnclistcreate struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the DncList. - Name *string `json:"name,omitempty"` - - - // DateCreated - Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // Version - Required for updates, must match the version number of the most recent update - Version *int `json:"version,omitempty"` - - - // ImportStatus - The status of the import process - ImportStatus *Importstatus `json:"importStatus,omitempty"` - - - // Size - The total number of phone numbers in the DncList. - Size *int `json:"size,omitempty"` - - - // DncSourceType - The type of the DncList. - DncSourceType *string `json:"dncSourceType,omitempty"` - - - // LoginId - A dnc.com loginId. Required if the dncSourceType is dnc.com. - LoginId *string `json:"loginId,omitempty"` - - - // DncCodes - The list of dnc.com codes to be treated as DNC. Required if the dncSourceType is dnc.com. - DncCodes *[]string `json:"dncCodes,omitempty"` - - - // LicenseId - A gryphon license number. Required if the dncSourceType is gryphon. - LicenseId *string `json:"licenseId,omitempty"` - - - // Division - The division this DncList belongs to. - Division *Domainentityref `json:"division,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dnclistcreate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dnclistdivisionview.go b/build/platformclientv2/dnclistdivisionview.go deleted file mode 100644 index d3e6b491c..000000000 --- a/build/platformclientv2/dnclistdivisionview.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dnclistdivisionview -type Dnclistdivisionview struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Division - The division to which this entity belongs. - Division *Division `json:"division,omitempty"` - - - // ImportStatus - The status of the import process. - ImportStatus *Importstatus `json:"importStatus,omitempty"` - - - // Size - The number of contacts in the ContactList. - Size *int `json:"size,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dnclistdivisionview) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dnclistdivisionviewlisting.go b/build/platformclientv2/dnclistdivisionviewlisting.go deleted file mode 100644 index 63113fa0d..000000000 --- a/build/platformclientv2/dnclistdivisionviewlisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dnclistdivisionviewlisting -type Dnclistdivisionviewlisting struct { - // Entities - Entities *[]Dnclistdivisionview `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dnclistdivisionviewlisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dnclistdownloadreadyexporturi.go b/build/platformclientv2/dnclistdownloadreadyexporturi.go deleted file mode 100644 index 464442764..000000000 --- a/build/platformclientv2/dnclistdownloadreadyexporturi.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dnclistdownloadreadyexporturi -type Dnclistdownloadreadyexporturi struct { - // Uri - Uri *string `json:"uri,omitempty"` - - - // ExportTimestamp - ExportTimestamp *string `json:"exportTimestamp,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dnclistdownloadreadyexporturi) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dnclistentitylisting.go b/build/platformclientv2/dnclistentitylisting.go deleted file mode 100644 index 9a9c67e4c..000000000 --- a/build/platformclientv2/dnclistentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dnclistentitylisting -type Dnclistentitylisting struct { - // Entities - Entities *[]Dnclist `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dnclistentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/dnclistimportstatusimportstatus.go b/build/platformclientv2/dnclistimportstatusimportstatus.go deleted file mode 100644 index c1410f3f2..000000000 --- a/build/platformclientv2/dnclistimportstatusimportstatus.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Dnclistimportstatusimportstatus -type Dnclistimportstatusimportstatus struct { - // ImportState - ImportState *string `json:"importState,omitempty"` - - - // TotalRecords - TotalRecords *int `json:"totalRecords,omitempty"` - - - // CompletedRecords - CompletedRecords *int `json:"completedRecords,omitempty"` - - - // PercentageComplete - PercentageComplete *int `json:"percentageComplete,omitempty"` - - - // FailureReason - FailureReason *string `json:"failureReason,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Dnclistimportstatusimportstatus) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/document.go b/build/platformclientv2/document.go deleted file mode 100644 index 9ef369975..000000000 --- a/build/platformclientv2/document.go +++ /dev/null @@ -1,138 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Document -type Document struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // ChangeNumber - ChangeNumber *int `json:"changeNumber,omitempty"` - - - // DateCreated - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // DateUploaded - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateUploaded *time.Time `json:"dateUploaded,omitempty"` - - - // ContentUri - ContentUri *string `json:"contentUri,omitempty"` - - - // Workspace - Workspace *Domainentityref `json:"workspace,omitempty"` - - - // CreatedBy - CreatedBy *Domainentityref `json:"createdBy,omitempty"` - - - // UploadedBy - UploadedBy *Domainentityref `json:"uploadedBy,omitempty"` - - - // ContentType - ContentType *string `json:"contentType,omitempty"` - - - // ContentLength - ContentLength *int `json:"contentLength,omitempty"` - - - // SystemType - SystemType *string `json:"systemType,omitempty"` - - - // Filename - Filename *string `json:"filename,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - - - // Read - Read *bool `json:"read,omitempty"` - - - // CallerAddress - CallerAddress *string `json:"callerAddress,omitempty"` - - - // ReceiverAddress - ReceiverAddress *string `json:"receiverAddress,omitempty"` - - - // Tags - Tags *[]string `json:"tags,omitempty"` - - - // TagValues - TagValues *[]Tagvalue `json:"tagValues,omitempty"` - - - // Attributes - Attributes *[]Documentattribute `json:"attributes,omitempty"` - - - // Thumbnails - Thumbnails *[]Documentthumbnail `json:"thumbnails,omitempty"` - - - // UploadStatus - UploadStatus *Domainentityref `json:"uploadStatus,omitempty"` - - - // UploadDestinationUri - UploadDestinationUri *string `json:"uploadDestinationUri,omitempty"` - - - // UploadMethod - UploadMethod *string `json:"uploadMethod,omitempty"` - - - // LockInfo - LockInfo *Lockinfo `json:"lockInfo,omitempty"` - - - // Acl - A list of permitted action rights for the user making the request - Acl *[]string `json:"acl,omitempty"` - - - // SharingStatus - SharingStatus *string `json:"sharingStatus,omitempty"` - - - // SharingUri - SharingUri *string `json:"sharingUri,omitempty"` - - - // DownloadSharingUri - DownloadSharingUri *string `json:"downloadSharingUri,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Document) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/documentationresult.go b/build/platformclientv2/documentationresult.go deleted file mode 100644 index bb0030478..000000000 --- a/build/platformclientv2/documentationresult.go +++ /dev/null @@ -1,94 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Documentationresult -type Documentationresult struct { - // Id - The globally unique identifier for the object. - Id *int `json:"id,omitempty"` - - - // Categories - The category of the documentation entity. Will be returned in responses for certain entities. - Categories *[]int `json:"categories,omitempty"` - - - // Description - The description of the documentation entity. Will be returned in responses for certain entities. - Description *string `json:"description,omitempty"` - - - // Content - The text or html content for the documentation entity. Will be returned in responses for certain entities. - Content *string `json:"content,omitempty"` - - - // Excerpt - The excerpt of the documentation entity. Will be returned in responses for certain entities. - Excerpt *string `json:"excerpt,omitempty"` - - - // Link - URL link for the documentation entity. Will be returned in responses for certain entities. - Link *string `json:"link,omitempty"` - - - // Modified - The modified date for the documentation entity. Will be returned in responses for certain entities. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - Modified *time.Time `json:"modified,omitempty"` - - - // Name - The name of the documentation entity. Will be returned in responses for certain entities. - Name *string `json:"name,omitempty"` - - - // Service - The service of the documentation entity. Will be returned in responses for certain entities. - Service *[]int `json:"service,omitempty"` - - - // Slug - The slug of the documentation entity. Will be returned in responses for certain entities. - Slug *string `json:"slug,omitempty"` - - - // Title - The title of the documentation entity. Will be returned in responses for certain entities. - Title *string `json:"title,omitempty"` - - - // GetType - The search type. Will be returned in responses for certain entities. - GetType *string `json:"get_type,omitempty"` - - - // FacetFeature - The facet feature of the documentation entity. Will be returned in responses for certain entities. - FacetFeature *[]int `json:"facet_feature,omitempty"` - - - // FacetRole - The facet role of the documentation entity. Will be returned in responses for certain entities. - FacetRole *[]int `json:"facet_role,omitempty"` - - - // FacetService - The facet service of the documentation entity. Will be returned in responses for certain entities. - FacetService *[]int `json:"facet_service,omitempty"` - - - // FaqCategories - The faq categories of the documentation entity. Will be returned in responses for certain entities. - FaqCategories *[]int `json:"faq_categories,omitempty"` - - - // ReleasenoteCategory - The releasenote category of the documentation entity. Will be returned in responses for certain entities. - ReleasenoteCategory *[]int `json:"releasenote_category,omitempty"` - - - // ReleasenoteTag - The releasenote tag of the documentation entity. Will be returned in responses for certain entities. - ReleasenoteTag *[]int `json:"releasenote_tag,omitempty"` - - - // ServiceArea - The service area of the documentation entity. Will be returned in responses for certain entities. - ServiceArea *[]int `json:"service-area,omitempty"` - - - // VideoCategories - The video categories of the documentation entity. Will be returned in responses for certain entities. - VideoCategories *[]int `json:"video_categories,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Documentationresult) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/documentationsearchcriteria.go b/build/platformclientv2/documentationsearchcriteria.go deleted file mode 100644 index ec398fb26..000000000 --- a/build/platformclientv2/documentationsearchcriteria.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Documentationsearchcriteria -type Documentationsearchcriteria struct { - // EndValue - The end value of the range. This field is used for range search types. - EndValue *string `json:"endValue,omitempty"` - - - // Values - A list of values for the search to match against - Values *[]string `json:"values,omitempty"` - - - // StartValue - The start value of the range. This field is used for range search types. - StartValue *string `json:"startValue,omitempty"` - - - // Fields - Field names to search against - Fields *[]string `json:"fields,omitempty"` - - - // Value - A value for the search to match against - Value *string `json:"value,omitempty"` - - - // Operator - How to apply this search criteria against other criteria - Operator *string `json:"operator,omitempty"` - - - // Group - Groups multiple conditions - Group *[]Documentationsearchcriteria `json:"group,omitempty"` - - - // DateFormat - Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX. - DateFormat *string `json:"dateFormat,omitempty"` - - - // VarType - Search Type - VarType *string `json:"type,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Documentationsearchcriteria) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/documentationsearchrequest.go b/build/platformclientv2/documentationsearchrequest.go deleted file mode 100644 index b37c418d4..000000000 --- a/build/platformclientv2/documentationsearchrequest.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Documentationsearchrequest -type Documentationsearchrequest struct { - // SortOrder - The sort order for results - SortOrder *string `json:"sortOrder,omitempty"` - - - // SortBy - The field in the resource that you want to sort the results by - SortBy *string `json:"sortBy,omitempty"` - - - // PageSize - The number of results per page - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - The page of resources you want to retrieve - PageNumber *int `json:"pageNumber,omitempty"` - - - // Sort - Multi-value sort order, list of multiple sort values - Sort *[]Searchsort `json:"sort,omitempty"` - - - // Query - Query *[]Documentationsearchcriteria `json:"query,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Documentationsearchrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/documentationsearchresponse.go b/build/platformclientv2/documentationsearchresponse.go deleted file mode 100644 index cd0f02ff1..000000000 --- a/build/platformclientv2/documentationsearchresponse.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Documentationsearchresponse -type Documentationsearchresponse struct { - // Total - The total number of results found - Total *int `json:"total,omitempty"` - - - // PageCount - The total number of pages - PageCount *int `json:"pageCount,omitempty"` - - - // PageSize - The current page size - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - The current page number - PageNumber *int `json:"pageNumber,omitempty"` - - - // PreviousPage - Q64 value for the previous page of results - PreviousPage *string `json:"previousPage,omitempty"` - - - // CurrentPage - Q64 value for the current page of results - CurrentPage *string `json:"currentPage,omitempty"` - - - // NextPage - Q64 value for the next page of results - NextPage *string `json:"nextPage,omitempty"` - - - // Types - Resource types the search was performed against - Types *[]string `json:"types,omitempty"` - - - // Results - Search results - Results *[]Documentationresult `json:"results,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Documentationsearchresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/documentattribute.go b/build/platformclientv2/documentattribute.go deleted file mode 100644 index d03847d2c..000000000 --- a/build/platformclientv2/documentattribute.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Documentattribute -type Documentattribute struct { - // Attribute - Attribute *Attribute `json:"attribute,omitempty"` - - - // Values - Values *[]string `json:"values,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Documentattribute) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/documentaudit.go b/build/platformclientv2/documentaudit.go deleted file mode 100644 index ce4f75968..000000000 --- a/build/platformclientv2/documentaudit.go +++ /dev/null @@ -1,78 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Documentaudit -type Documentaudit struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // User - User *Domainentityref `json:"user,omitempty"` - - - // Workspace - Workspace *Domainentityref `json:"workspace,omitempty"` - - - // TransactionId - TransactionId *string `json:"transactionId,omitempty"` - - - // TransactionInitiator - TransactionInitiator *bool `json:"transactionInitiator,omitempty"` - - - // Application - Application *string `json:"application,omitempty"` - - - // ServiceName - ServiceName *string `json:"serviceName,omitempty"` - - - // Level - Level *string `json:"level,omitempty"` - - - // Timestamp - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - Timestamp *time.Time `json:"timestamp,omitempty"` - - - // Status - Status *string `json:"status,omitempty"` - - - // ActionContext - ActionContext *string `json:"actionContext,omitempty"` - - - // Action - Action *string `json:"action,omitempty"` - - - // Entity - Entity *Auditentityreference `json:"entity,omitempty"` - - - // Changes - Changes *[]Auditchange `json:"changes,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Documentaudit) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/documentauditentitylisting.go b/build/platformclientv2/documentauditentitylisting.go deleted file mode 100644 index 8021db18e..000000000 --- a/build/platformclientv2/documentauditentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Documentauditentitylisting -type Documentauditentitylisting struct { - // Entities - Entities *[]Documentaudit `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Documentauditentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/documentcategoryinput.go b/build/platformclientv2/documentcategoryinput.go deleted file mode 100644 index 0f58e591a..000000000 --- a/build/platformclientv2/documentcategoryinput.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Documentcategoryinput -type Documentcategoryinput struct { - // Id - KnowledgeBase Category ID - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Documentcategoryinput) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/documententitylisting.go b/build/platformclientv2/documententitylisting.go deleted file mode 100644 index e8618e744..000000000 --- a/build/platformclientv2/documententitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Documententitylisting -type Documententitylisting struct { - // Entities - Entities *[]Document `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Documententitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/documentfaq.go b/build/platformclientv2/documentfaq.go deleted file mode 100644 index e488ec6e6..000000000 --- a/build/platformclientv2/documentfaq.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Documentfaq -type Documentfaq struct { - // Question - The question for this FAQ - Question *string `json:"question,omitempty"` - - - // Answer - The answer for this FAQ - Answer *string `json:"answer,omitempty"` - - - // Alternatives - List of Alternative questions related to the answer which helps in improving the likelihood of a match to user query - Alternatives *[]string `json:"alternatives,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Documentfaq) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/documentlisting.go b/build/platformclientv2/documentlisting.go deleted file mode 100644 index eedf73ef0..000000000 --- a/build/platformclientv2/documentlisting.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Documentlisting -type Documentlisting struct { - // Entities - Entities *[]Knowledgedocument `json:"entities,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Documentlisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/documentreference.go b/build/platformclientv2/documentreference.go deleted file mode 100644 index 2510ecdc6..000000000 --- a/build/platformclientv2/documentreference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Documentreference -type Documentreference struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Documentreference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/documentthumbnail.go b/build/platformclientv2/documentthumbnail.go deleted file mode 100644 index 4ced3f61f..000000000 --- a/build/platformclientv2/documentthumbnail.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Documentthumbnail -type Documentthumbnail struct { - // Resolution - Resolution *string `json:"resolution,omitempty"` - - - // ImageUri - ImageUri *string `json:"imageUri,omitempty"` - - - // Height - Height *int `json:"height,omitempty"` - - - // Width - Width *int `json:"width,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Documentthumbnail) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/documentupdate.go b/build/platformclientv2/documentupdate.go deleted file mode 100644 index 30ead1805..000000000 --- a/build/platformclientv2/documentupdate.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Documentupdate -type Documentupdate struct { - // ChangeNumber - ChangeNumber *int `json:"changeNumber,omitempty"` - - - // Name - The name of the document - Name *string `json:"name,omitempty"` - - - // Read - Read *bool `json:"read,omitempty"` - - - // AddTags - AddTags *[]string `json:"addTags,omitempty"` - - - // RemoveTags - RemoveTags *[]string `json:"removeTags,omitempty"` - - - // AddTagIds - AddTagIds *[]string `json:"addTagIds,omitempty"` - - - // RemoveTagIds - RemoveTagIds *[]string `json:"removeTagIds,omitempty"` - - - // UpdateAttributes - UpdateAttributes *[]Documentattribute `json:"updateAttributes,omitempty"` - - - // RemoveAttributes - RemoveAttributes *[]string `json:"removeAttributes,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Documentupdate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/documentupload.go b/build/platformclientv2/documentupload.go deleted file mode 100644 index f3c5ab667..000000000 --- a/build/platformclientv2/documentupload.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Documentupload -type Documentupload struct { - // Name - The name of the document - Name *string `json:"name,omitempty"` - - - // Workspace - The workspace the document will be uploaded to - Workspace *Domainentityref `json:"workspace,omitempty"` - - - // Tags - Tags *[]string `json:"tags,omitempty"` - - - // TagIds - TagIds *[]string `json:"tagIds,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Documentupload) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/domaincapabilities.go b/build/platformclientv2/domaincapabilities.go deleted file mode 100644 index 28a305b38..000000000 --- a/build/platformclientv2/domaincapabilities.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Domaincapabilities -type Domaincapabilities struct { - // Enabled - True if this address family on the interface is enabled. - Enabled *bool `json:"enabled,omitempty"` - - - // Dhcp - True if this address family on the interface is using DHCP. - Dhcp *bool `json:"dhcp,omitempty"` - - - // Metric - The metric being used for the address family on this interface. Lower values will have a higher priority. If autoMetric is true, this value will be the automatically calculated metric. To set this value be sure autoMetric is false. If no value is returned, metric configuration is not supported on this Edge. - Metric *int `json:"metric,omitempty"` - - - // AutoMetric - True if the metric is being calculated automatically for the address family on this interface. - AutoMetric *bool `json:"autoMetric,omitempty"` - - - // SupportsMetric - True if metric configuration is supported. - SupportsMetric *bool `json:"supportsMetric,omitempty"` - - - // PingEnabled - Set to true to enable this address family on this interface to respond to ping requests. - PingEnabled *bool `json:"pingEnabled,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Domaincapabilities) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/domaincertificateauthority.go b/build/platformclientv2/domaincertificateauthority.go deleted file mode 100644 index a680a21ae..000000000 --- a/build/platformclientv2/domaincertificateauthority.go +++ /dev/null @@ -1,78 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Domaincertificateauthority - A certificate authority represents an organization that has issued a digital certificate for making secure connections with an edge device. -type Domaincertificateauthority struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the entity. - Name *string `json:"name,omitempty"` - - - // Description - The resource's description. - Description *string `json:"description,omitempty"` - - - // Version - The current version of the resource. - Version *int `json:"version,omitempty"` - - - // DateCreated - The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // ModifiedBy - The ID of the user that last modified the resource. - ModifiedBy *string `json:"modifiedBy,omitempty"` - - - // CreatedBy - The ID of the user that created the resource. - CreatedBy *string `json:"createdBy,omitempty"` - - - // State - Indicates if the resource is active, inactive, or deleted. - State *string `json:"state,omitempty"` - - - // ModifiedByApp - The application that last modified the resource. - ModifiedByApp *string `json:"modifiedByApp,omitempty"` - - - // CreatedByApp - The application that created the resource. - CreatedByApp *string `json:"createdByApp,omitempty"` - - - // Certificate - The authorities signed X509 PEM encoded certificate. - Certificate *string `json:"certificate,omitempty"` - - - // VarType - The certificate authorities type. Managed certificate authorities are generated and maintained by Interactive Intelligence. These are read-only and not modifiable by clients. Remote authorities are customer managed. - VarType *string `json:"type,omitempty"` - - - // Services - The service(s) that the authority can be used to authenticate. - Services *[]string `json:"services,omitempty"` - - - // CertificateDetails - The details of the parsed certificate(s). - CertificateDetails *[]Certificatedetails `json:"certificateDetails,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Domaincertificateauthority) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/domainedgesoftwareupdatedto.go b/build/platformclientv2/domainedgesoftwareupdatedto.go deleted file mode 100644 index e5e9a9ffd..000000000 --- a/build/platformclientv2/domainedgesoftwareupdatedto.go +++ /dev/null @@ -1,54 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Domainedgesoftwareupdatedto -type Domainedgesoftwareupdatedto struct { - // Version - Version - Version *Domainedgesoftwareversiondto `json:"version,omitempty"` - - - // MaxDownloadRate - MaxDownloadRate *int `json:"maxDownloadRate,omitempty"` - - - // DownloadStartTime - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DownloadStartTime *time.Time `json:"downloadStartTime,omitempty"` - - - // ExecuteStartTime - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ExecuteStartTime *time.Time `json:"executeStartTime,omitempty"` - - - // ExecuteStopTime - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ExecuteStopTime *time.Time `json:"executeStopTime,omitempty"` - - - // ExecuteOnIdle - ExecuteOnIdle *bool `json:"executeOnIdle,omitempty"` - - - // Status - Status *string `json:"status,omitempty"` - - - // EdgeUri - EdgeUri *string `json:"edgeUri,omitempty"` - - - // CallDrainingWaitTimeSeconds - CallDrainingWaitTimeSeconds *int `json:"callDrainingWaitTimeSeconds,omitempty"` - - - // Current - Current *bool `json:"current,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Domainedgesoftwareupdatedto) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/domainedgesoftwareversiondto.go b/build/platformclientv2/domainedgesoftwareversiondto.go deleted file mode 100644 index e039382e5..000000000 --- a/build/platformclientv2/domainedgesoftwareversiondto.go +++ /dev/null @@ -1,46 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Domainedgesoftwareversiondto -type Domainedgesoftwareversiondto struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // EdgeVersion - EdgeVersion *string `json:"edgeVersion,omitempty"` - - - // PublishDate - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - PublishDate *time.Time `json:"publishDate,omitempty"` - - - // EdgeUri - EdgeUri *string `json:"edgeUri,omitempty"` - - - // LatestRelease - LatestRelease *bool `json:"latestRelease,omitempty"` - - - // Current - Current *bool `json:"current,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Domainedgesoftwareversiondto) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/domainedgesoftwareversiondtoentitylisting.go b/build/platformclientv2/domainedgesoftwareversiondtoentitylisting.go deleted file mode 100644 index dc88f4041..000000000 --- a/build/platformclientv2/domainedgesoftwareversiondtoentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Domainedgesoftwareversiondtoentitylisting -type Domainedgesoftwareversiondtoentitylisting struct { - // Entities - Entities *[]Domainedgesoftwareversiondto `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Domainedgesoftwareversiondtoentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/domainentity.go b/build/platformclientv2/domainentity.go deleted file mode 100644 index b5c0ba0a1..000000000 --- a/build/platformclientv2/domainentity.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Domainentity -type Domainentity struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Domainentity) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/domainentitylisting.go b/build/platformclientv2/domainentitylisting.go deleted file mode 100644 index dbe76e1d3..000000000 --- a/build/platformclientv2/domainentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Domainentitylisting -type Domainentitylisting struct { - // Entities - Entities *[]Domainentity `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Domainentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/domainentitylistingevaluationform.go b/build/platformclientv2/domainentitylistingevaluationform.go deleted file mode 100644 index 262f4a845..000000000 --- a/build/platformclientv2/domainentitylistingevaluationform.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Domainentitylistingevaluationform -type Domainentitylistingevaluationform struct { - // Entities - Entities *[]Evaluationform `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Domainentitylistingevaluationform) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/domainentitylistingqueryresult.go b/build/platformclientv2/domainentitylistingqueryresult.go deleted file mode 100644 index 31404728d..000000000 --- a/build/platformclientv2/domainentitylistingqueryresult.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Domainentitylistingqueryresult -type Domainentitylistingqueryresult struct { - // Entities - Entities *[]Queryresult `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Domainentitylistingqueryresult) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/domainentitylistingsurveyform.go b/build/platformclientv2/domainentitylistingsurveyform.go deleted file mode 100644 index dfc2100c4..000000000 --- a/build/platformclientv2/domainentitylistingsurveyform.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Domainentitylistingsurveyform -type Domainentitylistingsurveyform struct { - // Entities - Entities *[]Surveyform `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Domainentitylistingsurveyform) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/domainentityref.go b/build/platformclientv2/domainentityref.go deleted file mode 100644 index 5e116f7e7..000000000 --- a/build/platformclientv2/domainentityref.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Domainentityref -type Domainentityref struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Domainentityref) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/domainlogicalinterface.go b/build/platformclientv2/domainlogicalinterface.go deleted file mode 100644 index 5495a40c7..000000000 --- a/build/platformclientv2/domainlogicalinterface.go +++ /dev/null @@ -1,178 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Domainlogicalinterface -type Domainlogicalinterface struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the entity. - Name *string `json:"name,omitempty"` - - - // Description - The resource's description. - Description *string `json:"description,omitempty"` - - - // Version - The current version of the resource. - Version *int `json:"version,omitempty"` - - - // DateCreated - The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // ModifiedBy - The ID of the user that last modified the resource. - ModifiedBy *string `json:"modifiedBy,omitempty"` - - - // CreatedBy - The ID of the user that created the resource. - CreatedBy *string `json:"createdBy,omitempty"` - - - // State - Indicates if the resource is active, inactive, or deleted. - State *string `json:"state,omitempty"` - - - // ModifiedByApp - The application that last modified the resource. - ModifiedByApp *string `json:"modifiedByApp,omitempty"` - - - // CreatedByApp - The application that created the resource. - CreatedByApp *string `json:"createdByApp,omitempty"` - - - // EdgeUri - EdgeUri *string `json:"edgeUri,omitempty"` - - - // EdgeAssignedId - EdgeAssignedId *string `json:"edgeAssignedId,omitempty"` - - - // FriendlyName - Friendly Name - FriendlyName *string `json:"friendlyName,omitempty"` - - - // VlanTagId - VlanTagId *int `json:"vlanTagId,omitempty"` - - - // HardwareAddress - Hardware Address - HardwareAddress *string `json:"hardwareAddress,omitempty"` - - - // PhysicalAdapterId - Physical Adapter Id - PhysicalAdapterId *string `json:"physicalAdapterId,omitempty"` - - - // IfStatus - IfStatus *string `json:"ifStatus,omitempty"` - - - // InterfaceType - The type of this network interface. - InterfaceType *string `json:"interfaceType,omitempty"` - - - // PublicNatAddressIpV4 - IPv4 NENT IP Address - PublicNatAddressIpV4 *string `json:"publicNatAddressIpV4,omitempty"` - - - // PublicNatAddressIpV6 - IPv6 NENT IP Address - PublicNatAddressIpV6 *string `json:"publicNatAddressIpV6,omitempty"` - - - // Routes - The list of routes assigned to this interface. - Routes *[]Domainnetworkroute `json:"routes,omitempty"` - - - // Addresses - The list of IP addresses on this interface. Priority of dns addresses are based on order in the list. - Addresses *[]Domainnetworkaddress `json:"addresses,omitempty"` - - - // Ipv4Capabilities - IPv4 interface settings. - Ipv4Capabilities *Domaincapabilities `json:"ipv4Capabilities,omitempty"` - - - // Ipv6Capabilities - IPv6 interface settings. - Ipv6Capabilities *Domaincapabilities `json:"ipv6Capabilities,omitempty"` - - - // CurrentState - CurrentState *string `json:"currentState,omitempty"` - - - // LastModifiedUserId - LastModifiedUserId *string `json:"lastModifiedUserId,omitempty"` - - - // LastModifiedCorrelationId - LastModifiedCorrelationId *string `json:"lastModifiedCorrelationId,omitempty"` - - - // CommandResponses - CommandResponses *[]Domainnetworkcommandresponse `json:"commandResponses,omitempty"` - - - // InheritPhoneTrunkBasesIPv4 - The IPv4 phone trunk base assignment will be inherited from the Edge Group. - InheritPhoneTrunkBasesIPv4 *bool `json:"inheritPhoneTrunkBasesIPv4,omitempty"` - - - // InheritPhoneTrunkBasesIPv6 - The IPv6 phone trunk base assignment will be inherited from the Edge Group. - InheritPhoneTrunkBasesIPv6 *bool `json:"inheritPhoneTrunkBasesIPv6,omitempty"` - - - // UseForInternalEdgeCommunication - This interface will be used for all internal edge-to-edge communication using settings from the edgeTrunkBaseAssignment on the Edge Group. - UseForInternalEdgeCommunication *bool `json:"useForInternalEdgeCommunication,omitempty"` - - - // UseForIndirectEdgeCommunication - Site Interconnects using the \"Indirect\" method will communicate using the Public IP Address specified on the interface. Use this option when a NAT enabled firewall is between the Edge and the far end. - UseForIndirectEdgeCommunication *bool `json:"useForIndirectEdgeCommunication,omitempty"` - - - // UseForCloudProxyEdgeCommunication - Site Interconnects using the \"Cloud Proxy\" method will broker the connection between them with a Cloud Proxy. This method is required for connections between one or more Sites using Cloud Media, but can optionally be used between two premises Sites if Direct or Indirect are not an option. - UseForCloudProxyEdgeCommunication *bool `json:"useForCloudProxyEdgeCommunication,omitempty"` - - - // UseForWanInterface - This interface will be used for all communication with the internet. - UseForWanInterface *bool `json:"useForWanInterface,omitempty"` - - - // ExternalTrunkBaseAssignments - External trunk base settings to use for external communication from this interface. - ExternalTrunkBaseAssignments *[]Trunkbaseassignment `json:"externalTrunkBaseAssignments,omitempty"` - - - // PhoneTrunkBaseAssignments - Phone trunk base settings to use for phone communication from this interface. These settings will be ignored when \"inheritPhoneTrunkBases\" is true. - PhoneTrunkBaseAssignments *[]Trunkbaseassignment `json:"phoneTrunkBaseAssignments,omitempty"` - - - // TraceEnabled - TraceEnabled *bool `json:"traceEnabled,omitempty"` - - - // StartDate - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartDate *time.Time `json:"startDate,omitempty"` - - - // EndDate - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - EndDate *time.Time `json:"endDate,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Domainlogicalinterface) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/domainnetworkaddress.go b/build/platformclientv2/domainnetworkaddress.go deleted file mode 100644 index eb0aa37ed..000000000 --- a/build/platformclientv2/domainnetworkaddress.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Domainnetworkaddress -type Domainnetworkaddress struct { - // VarType - The type of address. - VarType *string `json:"type,omitempty"` - - - // Address - An IPv4 or IPv6 IP address. When specifying an address of type \"ip\", use CIDR format for the subnet mask. - Address *string `json:"address,omitempty"` - - - // Persistent - True if this address will persist on Edge restart. Addresses assigned by DHCP will be returned as false. - Persistent *bool `json:"persistent,omitempty"` - - - // Family - The address family for this address. - Family *int `json:"family,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Domainnetworkaddress) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/domainnetworkcommandresponse.go b/build/platformclientv2/domainnetworkcommandresponse.go deleted file mode 100644 index 42a2dc015..000000000 --- a/build/platformclientv2/domainnetworkcommandresponse.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Domainnetworkcommandresponse -type Domainnetworkcommandresponse struct { - // CorrelationId - CorrelationId *string `json:"correlationId,omitempty"` - - - // CommandName - CommandName *string `json:"commandName,omitempty"` - - - // Acknowledged - Acknowledged *bool `json:"acknowledged,omitempty"` - - - // ErrorInfo - ErrorInfo **Errordetails `json:"errorInfo,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Domainnetworkcommandresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/domainnetworkroute.go b/build/platformclientv2/domainnetworkroute.go deleted file mode 100644 index 5be7a88ce..000000000 --- a/build/platformclientv2/domainnetworkroute.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Domainnetworkroute -type Domainnetworkroute struct { - // Prefix - The IPv4 or IPv6 route prefix in CIDR notation. - Prefix *string `json:"prefix,omitempty"` - - - // Nexthop - The IPv4 or IPv6 nexthop IP address. - Nexthop *string `json:"nexthop,omitempty"` - - - // Persistent - True if this route will persist on Edge restart. Routes assigned by DHCP will be returned as false. - Persistent *bool `json:"persistent,omitempty"` - - - // Metric - The metric being used for route. Lower values will have a higher priority. - Metric *int `json:"metric,omitempty"` - - - // Family - The address family for this route. - Family *int `json:"family,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Domainnetworkroute) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/domainorganizationproduct.go b/build/platformclientv2/domainorganizationproduct.go deleted file mode 100644 index 68f15af7f..000000000 --- a/build/platformclientv2/domainorganizationproduct.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Domainorganizationproduct -type Domainorganizationproduct struct { - // Id - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Domainorganizationproduct) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/domainorganizationrole.go b/build/platformclientv2/domainorganizationrole.go deleted file mode 100644 index beabad7a4..000000000 --- a/build/platformclientv2/domainorganizationrole.go +++ /dev/null @@ -1,61 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Domainorganizationrole -type Domainorganizationrole struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Description - Description *string `json:"description,omitempty"` - - - // DefaultRoleId - DefaultRoleId *string `json:"defaultRoleId,omitempty"` - - - // Permissions - Permissions *[]string `json:"permissions,omitempty"` - - - // UnusedPermissions - A collection of the permissions the role is not using - UnusedPermissions *[]string `json:"unusedPermissions,omitempty"` - - - // PermissionPolicies - PermissionPolicies *[]Domainpermissionpolicy `json:"permissionPolicies,omitempty"` - - - // UserCount - UserCount *int `json:"userCount,omitempty"` - - - // RoleNeedsUpdate - Optional unless patch operation. - RoleNeedsUpdate *bool `json:"roleNeedsUpdate,omitempty"` - - - // Base - Base *bool `json:"base,omitempty"` - - - // VarDefault - VarDefault *bool `json:"default,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Domainorganizationrole) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/domainorganizationrolecreate.go b/build/platformclientv2/domainorganizationrolecreate.go deleted file mode 100644 index d0926ff92..000000000 --- a/build/platformclientv2/domainorganizationrolecreate.go +++ /dev/null @@ -1,61 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Domainorganizationrolecreate -type Domainorganizationrolecreate struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The role name - Name *string `json:"name,omitempty"` - - - // Description - Description *string `json:"description,omitempty"` - - - // DefaultRoleId - DefaultRoleId *string `json:"defaultRoleId,omitempty"` - - - // Permissions - Permissions *[]string `json:"permissions,omitempty"` - - - // UnusedPermissions - A collection of the permissions the role is not using - UnusedPermissions *[]string `json:"unusedPermissions,omitempty"` - - - // PermissionPolicies - PermissionPolicies *[]Domainpermissionpolicy `json:"permissionPolicies,omitempty"` - - - // UserCount - UserCount *int `json:"userCount,omitempty"` - - - // RoleNeedsUpdate - Optional unless patch operation. - RoleNeedsUpdate *bool `json:"roleNeedsUpdate,omitempty"` - - - // Base - Base *bool `json:"base,omitempty"` - - - // VarDefault - VarDefault *bool `json:"default,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Domainorganizationrolecreate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/domainorganizationroleupdate.go b/build/platformclientv2/domainorganizationroleupdate.go deleted file mode 100644 index 94d5f3617..000000000 --- a/build/platformclientv2/domainorganizationroleupdate.go +++ /dev/null @@ -1,61 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Domainorganizationroleupdate -type Domainorganizationroleupdate struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the role - Name *string `json:"name,omitempty"` - - - // Description - Description *string `json:"description,omitempty"` - - - // DefaultRoleId - DefaultRoleId *string `json:"defaultRoleId,omitempty"` - - - // Permissions - Permissions *[]string `json:"permissions,omitempty"` - - - // UnusedPermissions - A collection of the permissions the role is not using - UnusedPermissions *[]string `json:"unusedPermissions,omitempty"` - - - // PermissionPolicies - PermissionPolicies *[]Domainpermissionpolicy `json:"permissionPolicies,omitempty"` - - - // UserCount - UserCount *int `json:"userCount,omitempty"` - - - // RoleNeedsUpdate - Optional unless patch operation. - RoleNeedsUpdate *bool `json:"roleNeedsUpdate,omitempty"` - - - // Base - Base *bool `json:"base,omitempty"` - - - // VarDefault - VarDefault *bool `json:"default,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Domainorganizationroleupdate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/domainorgroledifference.go b/build/platformclientv2/domainorgroledifference.go deleted file mode 100644 index 5e9e7d28f..000000000 --- a/build/platformclientv2/domainorgroledifference.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Domainorgroledifference -type Domainorgroledifference struct { - // RemovedPermissionPolicies - RemovedPermissionPolicies *[]Domainpermissionpolicy `json:"removedPermissionPolicies,omitempty"` - - - // AddedPermissionPolicies - AddedPermissionPolicies *[]Domainpermissionpolicy `json:"addedPermissionPolicies,omitempty"` - - - // SamePermissionPolicies - SamePermissionPolicies *[]Domainpermissionpolicy `json:"samePermissionPolicies,omitempty"` - - - // UserOrgRole - UserOrgRole *Domainorganizationrole `json:"userOrgRole,omitempty"` - - - // RoleFromDefault - RoleFromDefault *Domainorganizationrole `json:"roleFromDefault,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Domainorgroledifference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/domainpermission.go b/build/platformclientv2/domainpermission.go deleted file mode 100644 index a09d43396..000000000 --- a/build/platformclientv2/domainpermission.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Domainpermission -type Domainpermission struct { - // Domain - Domain *string `json:"domain,omitempty"` - - - // EntityType - EntityType *string `json:"entityType,omitempty"` - - - // Action - Action *string `json:"action,omitempty"` - - - // Label - Label *string `json:"label,omitempty"` - - - // AllowsConditions - AllowsConditions *bool `json:"allowsConditions,omitempty"` - - - // DivisionAware - DivisionAware *bool `json:"divisionAware,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Domainpermission) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/domainpermissioncollection.go b/build/platformclientv2/domainpermissioncollection.go deleted file mode 100644 index feec2edd7..000000000 --- a/build/platformclientv2/domainpermissioncollection.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Domainpermissioncollection -type Domainpermissioncollection struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Domain - Domain *string `json:"domain,omitempty"` - - - // PermissionMap - PermissionMap *map[string][]Domainpermission `json:"permissionMap,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Domainpermissioncollection) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/domainpermissionpolicy.go b/build/platformclientv2/domainpermissionpolicy.go deleted file mode 100644 index 9a86fd56d..000000000 --- a/build/platformclientv2/domainpermissionpolicy.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Domainpermissionpolicy -type Domainpermissionpolicy struct { - // Domain - Domain *string `json:"domain,omitempty"` - - - // EntityName - EntityName *string `json:"entityName,omitempty"` - - - // PolicyName - PolicyName *string `json:"policyName,omitempty"` - - - // PolicyDescription - PolicyDescription *string `json:"policyDescription,omitempty"` - - - // ActionSet - ActionSet *[]string `json:"actionSet,omitempty"` - - - // NamedResources - NamedResources *[]string `json:"namedResources,omitempty"` - - - // AllowConditions - AllowConditions *bool `json:"allowConditions,omitempty"` - - - // ResourceConditionNode - ResourceConditionNode *Domainresourceconditionnode `json:"resourceConditionNode,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Domainpermissionpolicy) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/domainphysicalcapabilities.go b/build/platformclientv2/domainphysicalcapabilities.go deleted file mode 100644 index 9788374ab..000000000 --- a/build/platformclientv2/domainphysicalcapabilities.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Domainphysicalcapabilities -type Domainphysicalcapabilities struct { - // Vlan - Vlan *bool `json:"vlan,omitempty"` - - - // Team - Team *bool `json:"team,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Domainphysicalcapabilities) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/domainphysicalinterface.go b/build/platformclientv2/domainphysicalinterface.go deleted file mode 100644 index 9cd55f5e5..000000000 --- a/build/platformclientv2/domainphysicalinterface.go +++ /dev/null @@ -1,82 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Domainphysicalinterface -type Domainphysicalinterface struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the entity. - Name *string `json:"name,omitempty"` - - - // Description - The resource's description. - Description *string `json:"description,omitempty"` - - - // Version - The current version of the resource. - Version *int `json:"version,omitempty"` - - - // DateCreated - The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // ModifiedBy - The ID of the user that last modified the resource. - ModifiedBy *string `json:"modifiedBy,omitempty"` - - - // CreatedBy - The ID of the user that created the resource. - CreatedBy *string `json:"createdBy,omitempty"` - - - // State - Indicates if the resource is active, inactive, or deleted. - State *string `json:"state,omitempty"` - - - // ModifiedByApp - The application that last modified the resource. - ModifiedByApp *string `json:"modifiedByApp,omitempty"` - - - // CreatedByApp - The application that created the resource. - CreatedByApp *string `json:"createdByApp,omitempty"` - - - // EdgeUri - EdgeUri *string `json:"edgeUri,omitempty"` - - - // FriendlyName - FriendlyName *string `json:"friendlyName,omitempty"` - - - // HardwareAddress - HardwareAddress *string `json:"hardwareAddress,omitempty"` - - - // PortLabel - PortLabel *string `json:"portLabel,omitempty"` - - - // PhysicalCapabilities - PhysicalCapabilities *Domainphysicalcapabilities `json:"physicalCapabilities,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Domainphysicalinterface) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/domainresourceconditionnode.go b/build/platformclientv2/domainresourceconditionnode.go deleted file mode 100644 index cf516d806..000000000 --- a/build/platformclientv2/domainresourceconditionnode.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Domainresourceconditionnode -type Domainresourceconditionnode struct { - // VariableName - VariableName *string `json:"variableName,omitempty"` - - - // Operator - Operator *string `json:"operator,omitempty"` - - - // Operands - Operands *[]Domainresourceconditionvalue `json:"operands,omitempty"` - - - // Conjunction - Conjunction *string `json:"conjunction,omitempty"` - - - // Terms - Terms *[]Domainresourceconditionnode `json:"terms,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Domainresourceconditionnode) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/domainresourceconditionvalue.go b/build/platformclientv2/domainresourceconditionvalue.go deleted file mode 100644 index a014af5cb..000000000 --- a/build/platformclientv2/domainresourceconditionvalue.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Domainresourceconditionvalue -type Domainresourceconditionvalue struct { - // User - User *User `json:"user,omitempty"` - - - // Queue - Queue *Queue `json:"queue,omitempty"` - - - // Value - Value *string `json:"value,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Domainresourceconditionvalue) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/domainrole.go b/build/platformclientv2/domainrole.go deleted file mode 100644 index 8f6785faf..000000000 --- a/build/platformclientv2/domainrole.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Domainrole -type Domainrole struct { - // Id - The ID of the role - Id *string `json:"id,omitempty"` - - - // Name - The name of the role - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Domainrole) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/domainschemareference.go b/build/platformclientv2/domainschemareference.go deleted file mode 100644 index 521b19f08..000000000 --- a/build/platformclientv2/domainschemareference.go +++ /dev/null @@ -1,62 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Domainschemareference -type Domainschemareference struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the entity. - Name *string `json:"name,omitempty"` - - - // Description - The resource's description. - Description *string `json:"description,omitempty"` - - - // Version - The current version of the resource. - Version *int `json:"version,omitempty"` - - - // DateCreated - The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // ModifiedBy - The ID of the user that last modified the resource. - ModifiedBy *string `json:"modifiedBy,omitempty"` - - - // CreatedBy - The ID of the user that created the resource. - CreatedBy *string `json:"createdBy,omitempty"` - - - // State - Indicates if the resource is active, inactive, or deleted. - State *string `json:"state,omitempty"` - - - // ModifiedByApp - The application that last modified the resource. - ModifiedByApp *string `json:"modifiedByApp,omitempty"` - - - // CreatedByApp - The application that created the resource. - CreatedByApp *string `json:"createdByApp,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Domainschemareference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/downloadresponse.go b/build/platformclientv2/downloadresponse.go deleted file mode 100644 index 62cbe69b5..000000000 --- a/build/platformclientv2/downloadresponse.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Downloadresponse -type Downloadresponse struct { - // ContentLocationUri - ContentLocationUri *string `json:"contentLocationUri,omitempty"` - - - // ImageUri - ImageUri *string `json:"imageUri,omitempty"` - - - // Thumbnails - Thumbnails *[]Documentthumbnail `json:"thumbnails,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Downloadresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/draftvalidationresult.go b/build/platformclientv2/draftvalidationresult.go deleted file mode 100644 index da0abfd93..000000000 --- a/build/platformclientv2/draftvalidationresult.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Draftvalidationresult - Validation results -type Draftvalidationresult struct { - // Valid - Indicates if configuration is valid - Valid *bool `json:"valid,omitempty"` - - - // Errors - List of errors causing validation failure - Errors *[]Errorbody `json:"errors,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Draftvalidationresult) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/durationcondition.go b/build/platformclientv2/durationcondition.go deleted file mode 100644 index 0d81e815c..000000000 --- a/build/platformclientv2/durationcondition.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Durationcondition -type Durationcondition struct { - // DurationTarget - DurationTarget *string `json:"durationTarget,omitempty"` - - - // DurationOperator - DurationOperator *string `json:"durationOperator,omitempty"` - - - // DurationRange - DurationRange *string `json:"durationRange,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Durationcondition) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/edge.go b/build/platformclientv2/edge.go deleted file mode 100644 index 2af21a8f4..000000000 --- a/build/platformclientv2/edge.go +++ /dev/null @@ -1,178 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Edge -type Edge struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the entity. - Name *string `json:"name,omitempty"` - - - // Description - The resource's description. - Description *string `json:"description,omitempty"` - - - // Version - The current version of the resource. - Version *int `json:"version,omitempty"` - - - // DateCreated - The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // ModifiedBy - The ID of the user that last modified the resource. - ModifiedBy *string `json:"modifiedBy,omitempty"` - - - // CreatedBy - The ID of the user that created the resource. - CreatedBy *string `json:"createdBy,omitempty"` - - - // State - Indicates if the resource is active, inactive, or deleted. - State *string `json:"state,omitempty"` - - - // ModifiedByApp - The application that last modified the resource. - ModifiedByApp *string `json:"modifiedByApp,omitempty"` - - - // CreatedByApp - The application that created the resource. - CreatedByApp *string `json:"createdByApp,omitempty"` - - - // Interfaces - The list of interfaces for the edge. (Deprecated) Replaced by configuring trunks/ip info on the logical interface instead - Interfaces *[]Edgeinterface `json:"interfaces,omitempty"` - - - // Make - Make *string `json:"make,omitempty"` - - - // Model - Model *string `json:"model,omitempty"` - - - // ApiVersion - ApiVersion *string `json:"apiVersion,omitempty"` - - - // SoftwareVersion - SoftwareVersion *string `json:"softwareVersion,omitempty"` - - - // SoftwareVersionTimestamp - SoftwareVersionTimestamp *string `json:"softwareVersionTimestamp,omitempty"` - - - // SoftwareVersionPlatform - SoftwareVersionPlatform *string `json:"softwareVersionPlatform,omitempty"` - - - // SoftwareVersionConfiguration - SoftwareVersionConfiguration *string `json:"softwareVersionConfiguration,omitempty"` - - - // FullSoftwareVersion - FullSoftwareVersion *string `json:"fullSoftwareVersion,omitempty"` - - - // PairingId - The pairing Id for a hardware Edge in the format: 00000-00000-00000-00000-00000. This field is only required when creating an Edge with a deployment type of HARDWARE. - PairingId *string `json:"pairingId,omitempty"` - - - // Fingerprint - Fingerprint *string `json:"fingerprint,omitempty"` - - - // FingerprintHint - FingerprintHint *string `json:"fingerprintHint,omitempty"` - - - // CurrentVersion - CurrentVersion *string `json:"currentVersion,omitempty"` - - - // StagedVersion - StagedVersion *string `json:"stagedVersion,omitempty"` - - - // Patch - Patch *string `json:"patch,omitempty"` - - - // StatusCode - The current status of the Edge. - StatusCode *string `json:"statusCode,omitempty"` - - - // EdgeGroup - EdgeGroup *Edgegroup `json:"edgeGroup,omitempty"` - - - // Site - The Site to which the Edge is assigned. - Site *Site `json:"site,omitempty"` - - - // SoftwareStatus - Details about an in-progress or recently in-progress Edge software upgrade. This node appears only if a software upgrade was recently initiated for this Edge. - SoftwareStatus *Domainedgesoftwareupdatedto `json:"softwareStatus,omitempty"` - - - // OnlineStatus - OnlineStatus *string `json:"onlineStatus,omitempty"` - - - // SerialNumber - SerialNumber *string `json:"serialNumber,omitempty"` - - - // PhysicalEdge - PhysicalEdge *bool `json:"physicalEdge,omitempty"` - - - // Managed - Managed *bool `json:"managed,omitempty"` - - - // EdgeDeploymentType - EdgeDeploymentType *string `json:"edgeDeploymentType,omitempty"` - - - // CallDrainingState - The current state of the Edge's call draining process before it can be safely rebooted or updated. - CallDrainingState *string `json:"callDrainingState,omitempty"` - - - // ConversationCount - The remaining number of conversations the Edge has to drain before it can be safely rebooted or updated. When an Edge is not draining conversations, this will be NULL or 0. - ConversationCount *int `json:"conversationCount,omitempty"` - - - // Proxy - Edge HTTP proxy configuration for the WAN port. The field can be a hostname, FQDN, IPv4 or IPv6 address. If port is not included, port 80 is assumed. - Proxy *string `json:"proxy,omitempty"` - - - // OfflineConfigCalled - True if the offline edge configuration endpoint has been called for this edge. - OfflineConfigCalled *bool `json:"offlineConfigCalled,omitempty"` - - - // OsName - The name provided by the operating system of the Edge. - OsName *string `json:"osName,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Edge) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/edgeautoupdateconfig.go b/build/platformclientv2/edgeautoupdateconfig.go deleted file mode 100644 index b08ef98b6..000000000 --- a/build/platformclientv2/edgeautoupdateconfig.go +++ /dev/null @@ -1,30 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Edgeautoupdateconfig -type Edgeautoupdateconfig struct { - // TimeZone - TimeZone *string `json:"timeZone,omitempty"` - - - // Rrule - Rrule *string `json:"rrule,omitempty"` - - - // Start - Date time is represented as an ISO-8601 string without a timezone. For example: yyyy-MM-ddTHH:mm:ss.SSS - Start *time.Time `json:"start,omitempty"` - - - // End - Date time is represented as an ISO-8601 string without a timezone. For example: yyyy-MM-ddTHH:mm:ss.SSS - End *time.Time `json:"end,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Edgeautoupdateconfig) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/edgechangetopicedge.go b/build/platformclientv2/edgechangetopicedge.go deleted file mode 100644 index b486ada30..000000000 --- a/build/platformclientv2/edgechangetopicedge.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Edgechangetopicedge -type Edgechangetopicedge struct { - // Id - Id *string `json:"id,omitempty"` - - - // OnlineStatus - OnlineStatus *string `json:"onlineStatus,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Edgechangetopicedge) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/edgeentitylisting.go b/build/platformclientv2/edgeentitylisting.go deleted file mode 100644 index 0ebb0985b..000000000 --- a/build/platformclientv2/edgeentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Edgeentitylisting -type Edgeentitylisting struct { - // Entities - Entities *[]Edge `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Edgeentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/edgegroup.go b/build/platformclientv2/edgegroup.go deleted file mode 100644 index e2e8e6195..000000000 --- a/build/platformclientv2/edgegroup.go +++ /dev/null @@ -1,78 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Edgegroup -type Edgegroup struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the entity. - Name *string `json:"name,omitempty"` - - - // Description - The resource's description. - Description *string `json:"description,omitempty"` - - - // Version - The current version of the resource. - Version *int `json:"version,omitempty"` - - - // DateCreated - The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // ModifiedBy - The ID of the user that last modified the resource. - ModifiedBy *string `json:"modifiedBy,omitempty"` - - - // CreatedBy - The ID of the user that created the resource. - CreatedBy *string `json:"createdBy,omitempty"` - - - // State - Indicates if the resource is active, inactive, or deleted. - State *string `json:"state,omitempty"` - - - // ModifiedByApp - The application that last modified the resource. - ModifiedByApp *string `json:"modifiedByApp,omitempty"` - - - // CreatedByApp - The application that created the resource. - CreatedByApp *string `json:"createdByApp,omitempty"` - - - // Managed - Is this edge group being managed remotely. - Managed *bool `json:"managed,omitempty"` - - - // Hybrid - Is this edge group hybrid. - Hybrid *bool `json:"hybrid,omitempty"` - - - // EdgeTrunkBaseAssignment - A trunk base settings assignment of trunkType \"EDGE\" to use for edge-to-edge communication. - EdgeTrunkBaseAssignment *Trunkbaseassignment `json:"edgeTrunkBaseAssignment,omitempty"` - - - // PhoneTrunkBases - Trunk base settings of trunkType \"PHONE\" to inherit to edge logical interface for phone communication. - PhoneTrunkBases *[]Trunkbase `json:"phoneTrunkBases,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Edgegroup) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/edgegroupentitylisting.go b/build/platformclientv2/edgegroupentitylisting.go deleted file mode 100644 index f203a48fc..000000000 --- a/build/platformclientv2/edgegroupentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Edgegroupentitylisting -type Edgegroupentitylisting struct { - // Entities - Entities *[]Edgegroup `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Edgegroupentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/edgeinterface.go b/build/platformclientv2/edgeinterface.go deleted file mode 100644 index 9921a4123..000000000 --- a/build/platformclientv2/edgeinterface.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Edgeinterface -type Edgeinterface struct { - // VarType - VarType *string `json:"type,omitempty"` - - - // IpAddress - IpAddress *string `json:"ipAddress,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // MacAddress - MacAddress *string `json:"macAddress,omitempty"` - - - // IfName - IfName *string `json:"ifName,omitempty"` - - - // Endpoints - Endpoints *[]Domainentityref `json:"endpoints,omitempty"` - - - // LineTypes - LineTypes *[]string `json:"lineTypes,omitempty"` - - - // AddressFamilyId - AddressFamilyId *string `json:"addressFamilyId,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Edgeinterface) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/edgeline.go b/build/platformclientv2/edgeline.go deleted file mode 100644 index 6c9105244..000000000 --- a/build/platformclientv2/edgeline.go +++ /dev/null @@ -1,94 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Edgeline -type Edgeline struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the entity. - Name *string `json:"name,omitempty"` - - - // Description - The resource's description. - Description *string `json:"description,omitempty"` - - - // Version - The current version of the resource. - Version *int `json:"version,omitempty"` - - - // DateCreated - The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // ModifiedBy - The ID of the user that last modified the resource. - ModifiedBy *string `json:"modifiedBy,omitempty"` - - - // CreatedBy - The ID of the user that created the resource. - CreatedBy *string `json:"createdBy,omitempty"` - - - // State - Indicates if the resource is active, inactive, or deleted. - State *string `json:"state,omitempty"` - - - // ModifiedByApp - The application that last modified the resource. - ModifiedByApp *string `json:"modifiedByApp,omitempty"` - - - // CreatedByApp - The application that created the resource. - CreatedByApp *string `json:"createdByApp,omitempty"` - - - // Schema - Schema *Domainentityref `json:"schema,omitempty"` - - - // Properties - Properties *map[string]interface{} `json:"properties,omitempty"` - - - // Edge - Edge *Edge `json:"edge,omitempty"` - - - // EdgeGroup - EdgeGroup *Edgegroup `json:"edgeGroup,omitempty"` - - - // LineType - LineType *string `json:"lineType,omitempty"` - - - // Endpoint - Endpoint *Endpoint `json:"endpoint,omitempty"` - - - // IpAddress - IpAddress *string `json:"ipAddress,omitempty"` - - - // LogicalInterfaceId - LogicalInterfaceId *string `json:"logicalInterfaceId,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Edgeline) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/edgelineentitylisting.go b/build/platformclientv2/edgelineentitylisting.go deleted file mode 100644 index 6c6d63382..000000000 --- a/build/platformclientv2/edgelineentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Edgelineentitylisting -type Edgelineentitylisting struct { - // Entities - Entities *[]Edgeline `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Edgelineentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/edgelogicalinterfaceschangetopicdomainlogicalinterfacechange.go b/build/platformclientv2/edgelogicalinterfaceschangetopicdomainlogicalinterfacechange.go deleted file mode 100644 index 9d5247616..000000000 --- a/build/platformclientv2/edgelogicalinterfaceschangetopicdomainlogicalinterfacechange.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Edgelogicalinterfaceschangetopicdomainlogicalinterfacechange -type Edgelogicalinterfaceschangetopicdomainlogicalinterfacechange struct { - // Id - Id *string `json:"id,omitempty"` - - - // ErrorInfo - ErrorInfo *Edgelogicalinterfaceschangetopicerrorinfo `json:"errorInfo,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Edgelogicalinterfaceschangetopicdomainlogicalinterfacechange) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/edgelogicalinterfaceschangetopicerrorinfo.go b/build/platformclientv2/edgelogicalinterfaceschangetopicerrorinfo.go deleted file mode 100644 index b7d4f74ff..000000000 --- a/build/platformclientv2/edgelogicalinterfaceschangetopicerrorinfo.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Edgelogicalinterfaceschangetopicerrorinfo -type Edgelogicalinterfaceschangetopicerrorinfo struct { - // Message - Message *string `json:"message,omitempty"` - - - // MessageWithParams - MessageWithParams *string `json:"messageWithParams,omitempty"` - - - // MessageParams - MessageParams *map[string]string `json:"messageParams,omitempty"` - - - // Code - Code *string `json:"code,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Edgelogicalinterfaceschangetopicerrorinfo) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/edgelogsjob.go b/build/platformclientv2/edgelogsjob.go deleted file mode 100644 index d9539e448..000000000 --- a/build/platformclientv2/edgelogsjob.go +++ /dev/null @@ -1,66 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Edgelogsjob -type Edgelogsjob struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the entity. - Name *string `json:"name,omitempty"` - - - // Description - The resource's description. - Description *string `json:"description,omitempty"` - - - // Version - The current version of the resource. - Version *int `json:"version,omitempty"` - - - // DateCreated - The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // ModifiedBy - The ID of the user that last modified the resource. - ModifiedBy *string `json:"modifiedBy,omitempty"` - - - // CreatedBy - The ID of the user that created the resource. - CreatedBy *string `json:"createdBy,omitempty"` - - - // State - Indicates if the resource is active, inactive, or deleted. - State *string `json:"state,omitempty"` - - - // ModifiedByApp - The application that last modified the resource. - ModifiedByApp *string `json:"modifiedByApp,omitempty"` - - - // CreatedByApp - The application that created the resource. - CreatedByApp *string `json:"createdByApp,omitempty"` - - - // Files - The files available to upload from the Edge to the cloud. - Files *[]Edgelogsjobfile `json:"files,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Edgelogsjob) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/edgelogsjobfile.go b/build/platformclientv2/edgelogsjobfile.go deleted file mode 100644 index 53498dd4a..000000000 --- a/build/platformclientv2/edgelogsjobfile.go +++ /dev/null @@ -1,86 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Edgelogsjobfile -type Edgelogsjobfile struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the entity. - Name *string `json:"name,omitempty"` - - - // Description - The resource's description. - Description *string `json:"description,omitempty"` - - - // Version - The current version of the resource. - Version *int `json:"version,omitempty"` - - - // DateCreated - The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // ModifiedBy - The ID of the user that last modified the resource. - ModifiedBy *string `json:"modifiedBy,omitempty"` - - - // CreatedBy - The ID of the user that created the resource. - CreatedBy *string `json:"createdBy,omitempty"` - - - // State - Indicates if the resource is active, inactive, or deleted. - State *string `json:"state,omitempty"` - - - // ModifiedByApp - The application that last modified the resource. - ModifiedByApp *string `json:"modifiedByApp,omitempty"` - - - // CreatedByApp - The application that created the resource. - CreatedByApp *string `json:"createdByApp,omitempty"` - - - // TimeCreated - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - TimeCreated *time.Time `json:"timeCreated,omitempty"` - - - // TimeModified - The time this log file was last modified on the Edge. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - TimeModified *time.Time `json:"timeModified,omitempty"` - - - // SizeBytes - The size of this file in bytes. - SizeBytes *float64 `json:"sizeBytes,omitempty"` - - - // UploadStatus - The status of the upload of this file from the Edge to the cloud. Use /upload to start an upload. - UploadStatus *string `json:"uploadStatus,omitempty"` - - - // EdgePath - The path of this file on the Edge. - EdgePath *string `json:"edgePath,omitempty"` - - - // DownloadId - The download ID to use with the downloads API. - DownloadId *string `json:"downloadId,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Edgelogsjobfile) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/edgelogsjobrequest.go b/build/platformclientv2/edgelogsjobrequest.go deleted file mode 100644 index f08e0c1db..000000000 --- a/build/platformclientv2/edgelogsjobrequest.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Edgelogsjobrequest -type Edgelogsjobrequest struct { - // Path - A relative directory to the root Edge log folder to query from. - Path *string `json:"path,omitempty"` - - - // Query - The pattern to use when searching for logs, which may include the wildcards {*, ?}. Multiple search patterns may be combined using a pipe '|' as a delimiter. - Query *string `json:"query,omitempty"` - - - // Recurse - Boolean whether or not to recurse into directories. - Recurse *bool `json:"recurse,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Edgelogsjobrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/edgelogsjobresponse.go b/build/platformclientv2/edgelogsjobresponse.go deleted file mode 100644 index a380f8fb9..000000000 --- a/build/platformclientv2/edgelogsjobresponse.go +++ /dev/null @@ -1,62 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Edgelogsjobresponse -type Edgelogsjobresponse struct { - // Id - The created job id. - Id *string `json:"id,omitempty"` - - - // Name - The name of the entity. - Name *string `json:"name,omitempty"` - - - // Description - The resource's description. - Description *string `json:"description,omitempty"` - - - // Version - The current version of the resource. - Version *int `json:"version,omitempty"` - - - // DateCreated - The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // ModifiedBy - The ID of the user that last modified the resource. - ModifiedBy *string `json:"modifiedBy,omitempty"` - - - // CreatedBy - The ID of the user that created the resource. - CreatedBy *string `json:"createdBy,omitempty"` - - - // State - Indicates if the resource is active, inactive, or deleted. - State *string `json:"state,omitempty"` - - - // ModifiedByApp - The application that last modified the resource. - ModifiedByApp *string `json:"modifiedByApp,omitempty"` - - - // CreatedByApp - The application that created the resource. - CreatedByApp *string `json:"createdByApp,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Edgelogsjobresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/edgelogsjobuploadrequest.go b/build/platformclientv2/edgelogsjobuploadrequest.go deleted file mode 100644 index c20755f5b..000000000 --- a/build/platformclientv2/edgelogsjobuploadrequest.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Edgelogsjobuploadrequest -type Edgelogsjobuploadrequest struct { - // FileIds - A list of file ids to upload. - FileIds *[]string `json:"fileIds,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Edgelogsjobuploadrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/edgemetrics.go b/build/platformclientv2/edgemetrics.go deleted file mode 100644 index 40856aa2c..000000000 --- a/build/platformclientv2/edgemetrics.go +++ /dev/null @@ -1,46 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Edgemetrics -type Edgemetrics struct { - // Edge - Edge *Domainentityref `json:"edge,omitempty"` - - - // EventTime - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - EventTime *time.Time `json:"eventTime,omitempty"` - - - // UpTimeMsec - UpTimeMsec *int `json:"upTimeMsec,omitempty"` - - - // Processors - Processors *[]Edgemetricsprocessor `json:"processors,omitempty"` - - - // Memory - Memory *[]Edgemetricsmemory `json:"memory,omitempty"` - - - // Disks - Disks *[]Edgemetricsdisk `json:"disks,omitempty"` - - - // Subsystems - Subsystems *[]Edgemetricssubsystem `json:"subsystems,omitempty"` - - - // Networks - Networks *[]Edgemetricsnetwork `json:"networks,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Edgemetrics) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/edgemetricsdisk.go b/build/platformclientv2/edgemetricsdisk.go deleted file mode 100644 index a1b600b21..000000000 --- a/build/platformclientv2/edgemetricsdisk.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Edgemetricsdisk -type Edgemetricsdisk struct { - // AvailableBytes - Available memory in bytes. - AvailableBytes *float64 `json:"availableBytes,omitempty"` - - - // PartitionName - Disk partition name. - PartitionName *string `json:"partitionName,omitempty"` - - - // TotalBytes - Total memory in bytes. - TotalBytes *float64 `json:"totalBytes,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Edgemetricsdisk) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/edgemetricsmemory.go b/build/platformclientv2/edgemetricsmemory.go deleted file mode 100644 index 7778a48c0..000000000 --- a/build/platformclientv2/edgemetricsmemory.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Edgemetricsmemory -type Edgemetricsmemory struct { - // AvailableBytes - Available memory in bytes. - AvailableBytes *float64 `json:"availableBytes,omitempty"` - - - // VarType - Type of memory. Virtual or physical. - VarType *string `json:"type,omitempty"` - - - // TotalBytes - Total memory in bytes. - TotalBytes *float64 `json:"totalBytes,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Edgemetricsmemory) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/edgemetricsnetwork.go b/build/platformclientv2/edgemetricsnetwork.go deleted file mode 100644 index 7ac35c8ec..000000000 --- a/build/platformclientv2/edgemetricsnetwork.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Edgemetricsnetwork -type Edgemetricsnetwork struct { - // Ifname - Identifier for the network adapter. - Ifname *string `json:"ifname,omitempty"` - - - // SentBytesPerSec - Number of byes sent per second. - SentBytesPerSec *int `json:"sentBytesPerSec,omitempty"` - - - // ReceivedBytesPerSec - Number of byes received per second. - ReceivedBytesPerSec *int `json:"receivedBytesPerSec,omitempty"` - - - // BandwidthBitsPerSec - Total bandwidth of the adapter in bits per second. - BandwidthBitsPerSec *float64 `json:"bandwidthBitsPerSec,omitempty"` - - - // UtilizationPct - Percent utilization of the network adapter. - UtilizationPct *float64 `json:"utilizationPct,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Edgemetricsnetwork) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/edgemetricsprocessor.go b/build/platformclientv2/edgemetricsprocessor.go deleted file mode 100644 index a77d63d34..000000000 --- a/build/platformclientv2/edgemetricsprocessor.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Edgemetricsprocessor -type Edgemetricsprocessor struct { - // ActiveTimePct - Percent time processor was active. - ActiveTimePct *float64 `json:"activeTimePct,omitempty"` - - - // CpuId - Machine CPU identifier. 'total' will always be included in the array and is the total of all CPU resources. - CpuId *string `json:"cpuId,omitempty"` - - - // IdleTimePct - Percent time processor was idle. - IdleTimePct *float64 `json:"idleTimePct,omitempty"` - - - // PrivilegedTimePct - Percent time processor spent in privileged mode. - PrivilegedTimePct *float64 `json:"privilegedTimePct,omitempty"` - - - // UserTimePct - Percent time processor spent in user mode. - UserTimePct *float64 `json:"userTimePct,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Edgemetricsprocessor) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/edgemetricssubsystem.go b/build/platformclientv2/edgemetricssubsystem.go deleted file mode 100644 index 0cc037735..000000000 --- a/build/platformclientv2/edgemetricssubsystem.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Edgemetricssubsystem -type Edgemetricssubsystem struct { - // DelayMs - Delay in milliseconds. - DelayMs *int `json:"delayMs,omitempty"` - - - // ProcessName - Name of the Edge process. - ProcessName *string `json:"processName,omitempty"` - - - // MediaSubsystem - Subsystem for an Edge device. - MediaSubsystem **Edgemetricssubsystem `json:"mediaSubsystem,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Edgemetricssubsystem) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/edgemetricstopicedgemetricdisk.go b/build/platformclientv2/edgemetricstopicedgemetricdisk.go deleted file mode 100644 index ff1d01036..000000000 --- a/build/platformclientv2/edgemetricstopicedgemetricdisk.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Edgemetricstopicedgemetricdisk -type Edgemetricstopicedgemetricdisk struct { - // PartitionName - PartitionName *string `json:"partitionName,omitempty"` - - - // AvailableBytes - AvailableBytes *int `json:"availableBytes,omitempty"` - - - // TotalBytes - TotalBytes *int `json:"totalBytes,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Edgemetricstopicedgemetricdisk) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/edgemetricstopicedgemetricmemory.go b/build/platformclientv2/edgemetricstopicedgemetricmemory.go deleted file mode 100644 index b71685832..000000000 --- a/build/platformclientv2/edgemetricstopicedgemetricmemory.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Edgemetricstopicedgemetricmemory -type Edgemetricstopicedgemetricmemory struct { - // VarType - VarType *string `json:"type,omitempty"` - - - // AvailableBytes - AvailableBytes *int `json:"availableBytes,omitempty"` - - - // TotalBytes - TotalBytes *int `json:"totalBytes,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Edgemetricstopicedgemetricmemory) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/edgemetricstopicedgemetricnetworks.go b/build/platformclientv2/edgemetricstopicedgemetricnetworks.go deleted file mode 100644 index 9a96a57ab..000000000 --- a/build/platformclientv2/edgemetricstopicedgemetricnetworks.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Edgemetricstopicedgemetricnetworks -type Edgemetricstopicedgemetricnetworks struct { - // Ifname - Ifname *string `json:"ifname,omitempty"` - - - // SentBytesPerSec - SentBytesPerSec *int `json:"sentBytesPerSec,omitempty"` - - - // ReceivedBytesPerSec - ReceivedBytesPerSec *int `json:"receivedBytesPerSec,omitempty"` - - - // BandwidthBitsPerSec - BandwidthBitsPerSec *int `json:"bandwidthBitsPerSec,omitempty"` - - - // UtilizationPct - UtilizationPct *float32 `json:"utilizationPct,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Edgemetricstopicedgemetricnetworks) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/edgemetricstopicedgemetricprocessor.go b/build/platformclientv2/edgemetricstopicedgemetricprocessor.go deleted file mode 100644 index b3756543d..000000000 --- a/build/platformclientv2/edgemetricstopicedgemetricprocessor.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Edgemetricstopicedgemetricprocessor -type Edgemetricstopicedgemetricprocessor struct { - // CpuId - CpuId *string `json:"cpuId,omitempty"` - - - // IdleTimePct - IdleTimePct *int `json:"idleTimePct,omitempty"` - - - // ActiveTimePct - ActiveTimePct *int `json:"activeTimePct,omitempty"` - - - // PrivilegedTimePct - PrivilegedTimePct *int `json:"privilegedTimePct,omitempty"` - - - // UserTimePct - UserTimePct *int `json:"userTimePct,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Edgemetricstopicedgemetricprocessor) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/edgemetricstopicedgemetrics.go b/build/platformclientv2/edgemetricstopicedgemetrics.go deleted file mode 100644 index 85859a86e..000000000 --- a/build/platformclientv2/edgemetricstopicedgemetrics.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Edgemetricstopicedgemetrics -type Edgemetricstopicedgemetrics struct { - // Edge - Edge *Edgemetricstopicurireference `json:"edge,omitempty"` - - - // EventTime - EventTime *Edgemetricstopicoffsetdatetime `json:"eventTime,omitempty"` - - - // UpTimeMsec - UpTimeMsec *int `json:"upTimeMsec,omitempty"` - - - // Processors - Processors *[]Edgemetricstopicedgemetricprocessor `json:"processors,omitempty"` - - - // Memory - Memory *[]Edgemetricstopicedgemetricmemory `json:"memory,omitempty"` - - - // Disks - Disks *[]Edgemetricstopicedgemetricdisk `json:"disks,omitempty"` - - - // Subsystems - Subsystems *[]Edgemetricstopicedgemetricsubsystem `json:"subsystems,omitempty"` - - - // Networks - Networks *[]Edgemetricstopicedgemetricnetworks `json:"networks,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Edgemetricstopicedgemetrics) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/edgemetricstopicedgemetricsubsystem.go b/build/platformclientv2/edgemetricstopicedgemetricsubsystem.go deleted file mode 100644 index 519ddaf21..000000000 --- a/build/platformclientv2/edgemetricstopicedgemetricsubsystem.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Edgemetricstopicedgemetricsubsystem -type Edgemetricstopicedgemetricsubsystem struct { - // ProcessName - ProcessName *string `json:"processName,omitempty"` - - - // DelayMs - DelayMs *int `json:"delayMs,omitempty"` - - - // MediaSubsystem - MediaSubsystem *Edgemetricstopicedgemetricsubsystemmedia `json:"mediaSubsystem,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Edgemetricstopicedgemetricsubsystem) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/edgemetricstopicedgemetricsubsystemmedia.go b/build/platformclientv2/edgemetricstopicedgemetricsubsystemmedia.go deleted file mode 100644 index 3dce0ce61..000000000 --- a/build/platformclientv2/edgemetricstopicedgemetricsubsystemmedia.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Edgemetricstopicedgemetricsubsystemmedia -type Edgemetricstopicedgemetricsubsystemmedia struct { - // ProcessName - ProcessName *string `json:"processName,omitempty"` - - - // DelayMs - DelayMs *int `json:"delayMs,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Edgemetricstopicedgemetricsubsystemmedia) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/edgemetricstopiclocaldate.go b/build/platformclientv2/edgemetricstopiclocaldate.go deleted file mode 100644 index 994ba6f44..000000000 --- a/build/platformclientv2/edgemetricstopiclocaldate.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Edgemetricstopiclocaldate -type Edgemetricstopiclocaldate struct { - // Year - Year *int `json:"year,omitempty"` - - - // Month - Month *int `json:"month,omitempty"` - - - // Day - Day *int `json:"day,omitempty"` - - - // LeapYear - LeapYear *bool `json:"leapYear,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Edgemetricstopiclocaldate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/edgemetricstopiclocaldatetime.go b/build/platformclientv2/edgemetricstopiclocaldatetime.go deleted file mode 100644 index 053574345..000000000 --- a/build/platformclientv2/edgemetricstopiclocaldatetime.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Edgemetricstopiclocaldatetime -type Edgemetricstopiclocaldatetime struct { - // Date - Date *Edgemetricstopiclocaldate `json:"date,omitempty"` - - - // Time - Time *Edgemetricstopiclocaltime `json:"time,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Edgemetricstopiclocaldatetime) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/edgemetricstopiclocaltime.go b/build/platformclientv2/edgemetricstopiclocaltime.go deleted file mode 100644 index 9feeb9b2f..000000000 --- a/build/platformclientv2/edgemetricstopiclocaltime.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Edgemetricstopiclocaltime -type Edgemetricstopiclocaltime struct { - // Hour - Hour *int `json:"hour,omitempty"` - - - // Minute - Minute *int `json:"minute,omitempty"` - - - // Second - Second *int `json:"second,omitempty"` - - - // Nano - Nano *int `json:"nano,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Edgemetricstopiclocaltime) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/edgemetricstopicoffsetdatetime.go b/build/platformclientv2/edgemetricstopicoffsetdatetime.go deleted file mode 100644 index 5c7ac061a..000000000 --- a/build/platformclientv2/edgemetricstopicoffsetdatetime.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Edgemetricstopicoffsetdatetime -type Edgemetricstopicoffsetdatetime struct { - // DateTime - DateTime *Edgemetricstopiclocaldatetime `json:"dateTime,omitempty"` - - - // Offset - Offset *Edgemetricstopiczoneoffset `json:"offset,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Edgemetricstopicoffsetdatetime) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/edgemetricstopicurireference.go b/build/platformclientv2/edgemetricstopicurireference.go deleted file mode 100644 index b7f10e4c9..000000000 --- a/build/platformclientv2/edgemetricstopicurireference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Edgemetricstopicurireference -type Edgemetricstopicurireference struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Edgemetricstopicurireference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/edgemetricstopiczoneoffset.go b/build/platformclientv2/edgemetricstopiczoneoffset.go deleted file mode 100644 index 59ececb7a..000000000 --- a/build/platformclientv2/edgemetricstopiczoneoffset.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Edgemetricstopiczoneoffset -type Edgemetricstopiczoneoffset struct { - // TotalSeconds - TotalSeconds *int `json:"totalSeconds,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Edgemetricstopiczoneoffset) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/edgenetworkdiagnostic.go b/build/platformclientv2/edgenetworkdiagnostic.go deleted file mode 100644 index 86dfd7ead..000000000 --- a/build/platformclientv2/edgenetworkdiagnostic.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Edgenetworkdiagnostic -type Edgenetworkdiagnostic struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Edgenetworkdiagnostic) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/edgenetworkdiagnosticrequest.go b/build/platformclientv2/edgenetworkdiagnosticrequest.go deleted file mode 100644 index b11b89adc..000000000 --- a/build/platformclientv2/edgenetworkdiagnosticrequest.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Edgenetworkdiagnosticrequest -type Edgenetworkdiagnosticrequest struct { - // Host - IPv4/6 address or host to be probed for connectivity. No port allowed. - Host *string `json:"host,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Edgenetworkdiagnosticrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/edgenetworkdiagnosticresponse.go b/build/platformclientv2/edgenetworkdiagnosticresponse.go deleted file mode 100644 index 663588867..000000000 --- a/build/platformclientv2/edgenetworkdiagnosticresponse.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Edgenetworkdiagnosticresponse -type Edgenetworkdiagnosticresponse struct { - // CommandCorrelationId - UUID of each executed command on edge - CommandCorrelationId *string `json:"commandCorrelationId,omitempty"` - - - // Diagnostics - Response string of executed command from edge - Diagnostics *string `json:"diagnostics,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Edgenetworkdiagnosticresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/edgerebootparameters.go b/build/platformclientv2/edgerebootparameters.go deleted file mode 100644 index c193a85aa..000000000 --- a/build/platformclientv2/edgerebootparameters.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Edgerebootparameters -type Edgerebootparameters struct { - // CallDrainingWaitTimeSeconds - The number of seconds to wait for call draining to complete before initiating the reboot. A value of 0 will prevent call draining and all calls will disconnect immediately. - CallDrainingWaitTimeSeconds *int `json:"callDrainingWaitTimeSeconds,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Edgerebootparameters) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/edgeservicestaterequest.go b/build/platformclientv2/edgeservicestaterequest.go deleted file mode 100644 index 2cc57dc0b..000000000 --- a/build/platformclientv2/edgeservicestaterequest.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Edgeservicestaterequest -type Edgeservicestaterequest struct { - // InService - A boolean that sets the Edge in-service or out-of-service. - InService *bool `json:"inService,omitempty"` - - - // CallDrainingWaitTimeSeconds - The number of seconds to wait for call draining to complete before initiating the reboot. A value of 0 will prevent call draining and all calls will disconnect immediately. - CallDrainingWaitTimeSeconds *int `json:"callDrainingWaitTimeSeconds,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Edgeservicestaterequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/edgesoftwareupdatetopicdomainedgesoftwareupdate.go b/build/platformclientv2/edgesoftwareupdatetopicdomainedgesoftwareupdate.go deleted file mode 100644 index 1d0a11ff0..000000000 --- a/build/platformclientv2/edgesoftwareupdatetopicdomainedgesoftwareupdate.go +++ /dev/null @@ -1,34 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Edgesoftwareupdatetopicdomainedgesoftwareupdate -type Edgesoftwareupdatetopicdomainedgesoftwareupdate struct { - // Id - Id *string `json:"id,omitempty"` - - - // Status - Status *string `json:"status,omitempty"` - - - // DownloadStartTime - DownloadStartTime *time.Time `json:"downloadStartTime,omitempty"` - - - // ExecuteStartTime - ExecuteStartTime *time.Time `json:"executeStartTime,omitempty"` - - - // ExecuteStopTime - ExecuteStopTime *time.Time `json:"executeStopTime,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Edgesoftwareupdatetopicdomainedgesoftwareupdate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/edgetrunkbase.go b/build/platformclientv2/edgetrunkbase.go deleted file mode 100644 index 28514c87a..000000000 --- a/build/platformclientv2/edgetrunkbase.go +++ /dev/null @@ -1,74 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Edgetrunkbase -type Edgetrunkbase struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the entity. - Name *string `json:"name,omitempty"` - - - // Description - The resource's description. - Description *string `json:"description,omitempty"` - - - // Version - The current version of the resource. - Version *int `json:"version,omitempty"` - - - // DateCreated - The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // ModifiedBy - The ID of the user that last modified the resource. - ModifiedBy *string `json:"modifiedBy,omitempty"` - - - // CreatedBy - The ID of the user that created the resource. - CreatedBy *string `json:"createdBy,omitempty"` - - - // State - Indicates if the resource is active, inactive, or deleted. - State *string `json:"state,omitempty"` - - - // ModifiedByApp - The application that last modified the resource. - ModifiedByApp *string `json:"modifiedByApp,omitempty"` - - - // CreatedByApp - The application that created the resource. - CreatedByApp *string `json:"createdByApp,omitempty"` - - - // TrunkMetabase - The meta-base this trunk is based on. - TrunkMetabase *Domainentityref `json:"trunkMetabase,omitempty"` - - - // Properties - Properties *map[string]interface{} `json:"properties,omitempty"` - - - // TrunkType - The type of this trunk base. - TrunkType *string `json:"trunkType,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Edgetrunkbase) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/edgeversioninformation.go b/build/platformclientv2/edgeversioninformation.go deleted file mode 100644 index aa178ddec..000000000 --- a/build/platformclientv2/edgeversioninformation.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Edgeversioninformation -type Edgeversioninformation struct { - // SoftwareVersion - SoftwareVersion *string `json:"softwareVersion,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Edgeversioninformation) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/edgeversionreport.go b/build/platformclientv2/edgeversionreport.go deleted file mode 100644 index b142a29b0..000000000 --- a/build/platformclientv2/edgeversionreport.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Edgeversionreport -type Edgeversionreport struct { - // OldestVersion - OldestVersion *Edgeversioninformation `json:"oldestVersion,omitempty"` - - - // NewestVersion - NewestVersion *Edgeversioninformation `json:"newestVersion,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Edgeversionreport) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/education.go b/build/platformclientv2/education.go deleted file mode 100644 index ae05778c7..000000000 --- a/build/platformclientv2/education.go +++ /dev/null @@ -1,34 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Education -type Education struct { - // School - School *string `json:"school,omitempty"` - - - // FieldOfStudy - FieldOfStudy *string `json:"fieldOfStudy,omitempty"` - - - // Notes - Notes about education has a 2000 character limit - Notes *string `json:"notes,omitempty"` - - - // DateStart - Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd - DateStart *time.Time `json:"dateStart,omitempty"` - - - // DateEnd - Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd - DateEnd *time.Time `json:"dateEnd,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Education) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/effectiveconfiguration.go b/build/platformclientv2/effectiveconfiguration.go deleted file mode 100644 index 665c3bec4..000000000 --- a/build/platformclientv2/effectiveconfiguration.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Effectiveconfiguration - Effective Configuration for an ClientApp. This is comprised of the integration specific configuration along with overrides specified in the integration type. -type Effectiveconfiguration struct { - // Properties - Key-value configuration settings described by the schema in the propertiesSchemaUri field. - Properties *map[string]interface{} `json:"properties,omitempty"` - - - // Advanced - Advanced configuration described by the schema in the advancedSchemaUri field. - Advanced *map[string]interface{} `json:"advanced,omitempty"` - - - // Name - The name of the integration, used to distinguish this integration from others of the same type. - Name *string `json:"name,omitempty"` - - - // Notes - Notes about the integration. - Notes *string `json:"notes,omitempty"` - - - // Credentials - Credentials required by the integration. The required keys are indicated in the credentials property of the Integration Type - Credentials *map[string]Credentialinfo `json:"credentials,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Effectiveconfiguration) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/email.go b/build/platformclientv2/email.go deleted file mode 100644 index 24a983481..000000000 --- a/build/platformclientv2/email.go +++ /dev/null @@ -1,110 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Email -type Email struct { - // State - The connection state of this communication. - State *string `json:"state,omitempty"` - - - // Id - A globally unique identifier for this communication. - Id *string `json:"id,omitempty"` - - - // Held - True if this call is held and the person on this side hears silence. - Held *bool `json:"held,omitempty"` - - - // Subject - The subject for the initial email that started this conversation. - Subject *string `json:"subject,omitempty"` - - - // MessagesSent - The number of email messages sent by this participant. - MessagesSent *int `json:"messagesSent,omitempty"` - - - // Segments - The time line of the participant's email, divided into activity segments. - Segments *[]Segment `json:"segments,omitempty"` - - - // Direction - The direction of the email - Direction *string `json:"direction,omitempty"` - - - // RecordingId - A globally unique identifier for the recording associated with this call. - RecordingId *string `json:"recordingId,omitempty"` - - - // ErrorInfo - ErrorInfo *Errorbody `json:"errorInfo,omitempty"` - - - // DisconnectType - System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects. - DisconnectType *string `json:"disconnectType,omitempty"` - - - // StartHoldTime - The timestamp the email was placed on hold in the cloud clock if the email is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartHoldTime *time.Time `json:"startHoldTime,omitempty"` - - - // StartAlertingTime - The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartAlertingTime *time.Time `json:"startAlertingTime,omitempty"` - - - // ConnectedTime - The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // DisconnectedTime - The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"` - - - // AutoGenerated - Indicates that the email was auto-generated like an Out of Office reply. - AutoGenerated *bool `json:"autoGenerated,omitempty"` - - - // Provider - The source provider for the email. - Provider *string `json:"provider,omitempty"` - - - // ScriptId - The UUID of the script to use. - ScriptId *string `json:"scriptId,omitempty"` - - - // PeerId - The id of the peer communication corresponding to a matching leg for this communication. - PeerId *string `json:"peerId,omitempty"` - - - // MessageId - A globally unique identifier for the stored content of this communication. - MessageId *string `json:"messageId,omitempty"` - - - // DraftAttachments - A list of uploaded attachments on the email draft. - DraftAttachments *[]Attachment `json:"draftAttachments,omitempty"` - - - // Spam - Indicates if the inbound email was marked as spam. - Spam *bool `json:"spam,omitempty"` - - - // Wrapup - Call wrap up or disposition data. - Wrapup *Wrapup `json:"wrapup,omitempty"` - - - // AfterCallWork - After-call work for the communication. - AfterCallWork *Aftercallwork `json:"afterCallWork,omitempty"` - - - // AfterCallWorkRequired - Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested. - AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Email) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/emailaddress.go b/build/platformclientv2/emailaddress.go deleted file mode 100644 index 8301feb3c..000000000 --- a/build/platformclientv2/emailaddress.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Emailaddress -type Emailaddress struct { - // Email - Email *string `json:"email,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Emailaddress) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/emailattachment.go b/build/platformclientv2/emailattachment.go deleted file mode 100644 index 01202abab..000000000 --- a/build/platformclientv2/emailattachment.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Emailattachment -type Emailattachment struct { - // Name - Name *string `json:"name,omitempty"` - - - // ContentPath - ContentPath *string `json:"contentPath,omitempty"` - - - // ContentType - ContentType *string `json:"contentType,omitempty"` - - - // AttachmentId - AttachmentId *string `json:"attachmentId,omitempty"` - - - // ContentLength - ContentLength *int `json:"contentLength,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Emailattachment) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/emailconversation.go b/build/platformclientv2/emailconversation.go deleted file mode 100644 index 29a115785..000000000 --- a/build/platformclientv2/emailconversation.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Emailconversation -type Emailconversation struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Participants - The list of participants involved in the conversation. - Participants *[]Emailmediaparticipant `json:"participants,omitempty"` - - - // OtherMediaUris - The list of other media channels involved in the conversation. - OtherMediaUris *[]string `json:"otherMediaUris,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Emailconversation) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/emailconversationentitylisting.go b/build/platformclientv2/emailconversationentitylisting.go deleted file mode 100644 index 1a5013e09..000000000 --- a/build/platformclientv2/emailconversationentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Emailconversationentitylisting -type Emailconversationentitylisting struct { - // Entities - Entities *[]Emailconversation `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Emailconversationentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/emailmediaparticipant.go b/build/platformclientv2/emailmediaparticipant.go deleted file mode 100644 index 8e3b69c31..000000000 --- a/build/platformclientv2/emailmediaparticipant.go +++ /dev/null @@ -1,170 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Emailmediaparticipant -type Emailmediaparticipant struct { - // Id - The unique participant ID. - Id *string `json:"id,omitempty"` - - - // Name - The display friendly name of the participant. - Name *string `json:"name,omitempty"` - - - // Address - The participant address. - Address *string `json:"address,omitempty"` - - - // StartTime - The time when this participant first joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartTime *time.Time `json:"startTime,omitempty"` - - - // ConnectedTime - The time when this participant went connected for this media (eg: video connected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // EndTime - The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - EndTime *time.Time `json:"endTime,omitempty"` - - - // StartHoldTime - The time when this participant's hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartHoldTime *time.Time `json:"startHoldTime,omitempty"` - - - // Purpose - The participant's purpose. Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr - Purpose *string `json:"purpose,omitempty"` - - - // State - The participant's state. Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting - State *string `json:"state,omitempty"` - - - // Direction - The participant's direction. Values can be: 'inbound' or 'outbound' - Direction *string `json:"direction,omitempty"` - - - // DisconnectType - The reason the participant was disconnected from the conversation. - DisconnectType *string `json:"disconnectType,omitempty"` - - - // Held - Value is true when the participant is on hold. - Held *bool `json:"held,omitempty"` - - - // WrapupRequired - Value is true when the participant requires wrap-up. - WrapupRequired *bool `json:"wrapupRequired,omitempty"` - - - // WrapupPrompt - The wrap-up prompt indicating the type of wrap-up to be performed. - WrapupPrompt *string `json:"wrapupPrompt,omitempty"` - - - // User - The PureCloud user for this participant. - User *Domainentityref `json:"user,omitempty"` - - - // Queue - The PureCloud queue for this participant. - Queue *Domainentityref `json:"queue,omitempty"` - - - // Team - The PureCloud team for this participant. - Team *Domainentityref `json:"team,omitempty"` - - - // Attributes - A list of ad-hoc attributes for the participant. - Attributes *map[string]string `json:"attributes,omitempty"` - - - // ErrorInfo - If the conversation ends in error, contains additional error details. - ErrorInfo *Errorinfo `json:"errorInfo,omitempty"` - - - // Script - The Engage script that should be used by this participant. - Script *Domainentityref `json:"script,omitempty"` - - - // WrapupTimeoutMs - The amount of time the participant has to complete wrap-up. - WrapupTimeoutMs *int `json:"wrapupTimeoutMs,omitempty"` - - - // WrapupSkipped - Value is true when the participant has skipped wrap-up. - WrapupSkipped *bool `json:"wrapupSkipped,omitempty"` - - - // AlertingTimeoutMs - Specifies how long the agent has to answer an interaction before being marked as not responding. - AlertingTimeoutMs *int `json:"alertingTimeoutMs,omitempty"` - - - // Provider - The source provider for the communication. - Provider *string `json:"provider,omitempty"` - - - // ExternalContact - If this participant represents an external contact, then this will be the reference for the external contact. - ExternalContact *Domainentityref `json:"externalContact,omitempty"` - - - // ExternalOrganization - If this participant represents an external org, then this will be the reference for the external org. - ExternalOrganization *Domainentityref `json:"externalOrganization,omitempty"` - - - // Wrapup - Wrapup for this participant, if it has been applied. - Wrapup *Wrapup `json:"wrapup,omitempty"` - - - // Peer - The peer communication corresponding to a matching leg for this communication. - Peer *string `json:"peer,omitempty"` - - - // FlaggedReason - The reason specifying why participant flagged the conversation. - FlaggedReason *string `json:"flaggedReason,omitempty"` - - - // JourneyContext - Journey System data/context that is applicable to this communication. When used for historical purposes, the context should be immutable. When null, there is no applicable Journey System context. - JourneyContext *Journeycontext `json:"journeyContext,omitempty"` - - - // ConversationRoutingData - Information on how a communication should be routed to an agent. - ConversationRoutingData *Conversationroutingdata `json:"conversationRoutingData,omitempty"` - - - // StartAcwTime - The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartAcwTime *time.Time `json:"startAcwTime,omitempty"` - - - // EndAcwTime - The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - EndAcwTime *time.Time `json:"endAcwTime,omitempty"` - - - // Subject - The subject of the email. - Subject *string `json:"subject,omitempty"` - - - // MessagesSent - The number of messages that have been sent in this email conversation. - MessagesSent *int `json:"messagesSent,omitempty"` - - - // AutoGenerated - Indicates that the email was auto-generated like an Out of Office reply. - AutoGenerated *bool `json:"autoGenerated,omitempty"` - - - // DraftAttachments - A list of uploaded attachments on the email draft. - DraftAttachments *[]Attachment `json:"draftAttachments,omitempty"` - - - // Spam - Indicates if the inbound email was marked as spam. - Spam *bool `json:"spam,omitempty"` - - - // MessageId - A globally unique identifier for the stored content of this communication. - MessageId *string `json:"messageId,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Emailmediaparticipant) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/emailmediapolicy.go b/build/platformclientv2/emailmediapolicy.go deleted file mode 100644 index 44a408150..000000000 --- a/build/platformclientv2/emailmediapolicy.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Emailmediapolicy -type Emailmediapolicy struct { - // Actions - Actions applied when specified conditions are met - Actions *Policyactions `json:"actions,omitempty"` - - - // Conditions - Conditions for when actions should be applied - Conditions *Emailmediapolicyconditions `json:"conditions,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Emailmediapolicy) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/emailmediapolicyconditions.go b/build/platformclientv2/emailmediapolicyconditions.go deleted file mode 100644 index 80bc3c64d..000000000 --- a/build/platformclientv2/emailmediapolicyconditions.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Emailmediapolicyconditions -type Emailmediapolicyconditions struct { - // ForUsers - ForUsers *[]User `json:"forUsers,omitempty"` - - - // DateRanges - DateRanges *[]string `json:"dateRanges,omitempty"` - - - // ForQueues - ForQueues *[]Queue `json:"forQueues,omitempty"` - - - // WrapupCodes - WrapupCodes *[]Wrapupcode `json:"wrapupCodes,omitempty"` - - - // Languages - Languages *[]Language `json:"languages,omitempty"` - - - // TimeAllowed - TimeAllowed *Timeallowed `json:"timeAllowed,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Emailmediapolicyconditions) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/emailmessage.go b/build/platformclientv2/emailmessage.go deleted file mode 100644 index bf4b0f8b7..000000000 --- a/build/platformclientv2/emailmessage.go +++ /dev/null @@ -1,66 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Emailmessage -type Emailmessage struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // To - The recipients of the email message. - To *[]Emailaddress `json:"to,omitempty"` - - - // Cc - The recipients that were copied on the email message. - Cc *[]Emailaddress `json:"cc,omitempty"` - - - // Bcc - The recipients that were blind copied on the email message. - Bcc *[]Emailaddress `json:"bcc,omitempty"` - - - // From - The sender of the email message. - From *Emailaddress `json:"from,omitempty"` - - - // Subject - The subject of the email message. - Subject *string `json:"subject,omitempty"` - - - // Attachments - The attachments of the email message. - Attachments *[]Attachment `json:"attachments,omitempty"` - - - // TextBody - The text body of the email message. - TextBody *string `json:"textBody,omitempty"` - - - // HtmlBody - The html body of the email message. - HtmlBody *string `json:"htmlBody,omitempty"` - - - // Time - The time when the message was received or sent. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - Time *time.Time `json:"time,omitempty"` - - - // HistoryIncluded - Indicates whether the history of previous emails of the conversation is included within the email bodies of this message. - HistoryIncluded *bool `json:"historyIncluded,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Emailmessage) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/emailmessagelisting.go b/build/platformclientv2/emailmessagelisting.go deleted file mode 100644 index 95df8fffe..000000000 --- a/build/platformclientv2/emailmessagelisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Emailmessagelisting -type Emailmessagelisting struct { - // Entities - Entities *[]Emailmessage `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Emailmessagelisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/emailsetup.go b/build/platformclientv2/emailsetup.go deleted file mode 100644 index 417080c30..000000000 --- a/build/platformclientv2/emailsetup.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Emailsetup -type Emailsetup struct { - // RootDomain - The root PureCloud domain that all sub-domains are created from. - RootDomain *string `json:"rootDomain,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Emailsetup) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/embeddedintegration.go b/build/platformclientv2/embeddedintegration.go deleted file mode 100644 index 2a05203c5..000000000 --- a/build/platformclientv2/embeddedintegration.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Embeddedintegration -type Embeddedintegration struct { - // EnableWhitelist - EnableWhitelist *bool `json:"enableWhitelist,omitempty"` - - - // DomainWhitelist - DomainWhitelist *[]string `json:"domainWhitelist,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Embeddedintegration) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/emergencycallflow.go b/build/platformclientv2/emergencycallflow.go deleted file mode 100644 index 7c243082b..000000000 --- a/build/platformclientv2/emergencycallflow.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Emergencycallflow - An emergency flow associates a call flow to use in an emergency with the ivr(s) to route to it. -type Emergencycallflow struct { - // EmergencyFlow - The call flow to execute in an emergency. - EmergencyFlow *Domainentityref `json:"emergencyFlow,omitempty"` - - - // Ivrs - The IVR(s) to route to the call flow during an emergency. - Ivrs *[]Domainentityref `json:"ivrs,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Emergencycallflow) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/emergencygroup.go b/build/platformclientv2/emergencygroup.go deleted file mode 100644 index 7043f05fa..000000000 --- a/build/platformclientv2/emergencygroup.go +++ /dev/null @@ -1,70 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Emergencygroup - A group of emergency call flows to use in an emergency. -type Emergencygroup struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the entity. - Name *string `json:"name,omitempty"` - - - // Description - The resource's description. - Description *string `json:"description,omitempty"` - - - // Version - The current version of the resource. - Version *int `json:"version,omitempty"` - - - // DateCreated - The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // ModifiedBy - The ID of the user that last modified the resource. - ModifiedBy *string `json:"modifiedBy,omitempty"` - - - // CreatedBy - The ID of the user that created the resource. - CreatedBy *string `json:"createdBy,omitempty"` - - - // State - Indicates if the resource is active, inactive, or deleted. - State *string `json:"state,omitempty"` - - - // ModifiedByApp - The application that last modified the resource. - ModifiedByApp *string `json:"modifiedByApp,omitempty"` - - - // CreatedByApp - The application that created the resource. - CreatedByApp *string `json:"createdByApp,omitempty"` - - - // Enabled - True if an emergency is occurring and the associated emergency call flow(s) should be used. False otherwise. - Enabled *bool `json:"enabled,omitempty"` - - - // EmergencyCallFlows - The emergency call flow(s) to use during an emergency. - EmergencyCallFlows *[]Emergencycallflow `json:"emergencyCallFlows,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Emergencygroup) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/emergencygrouplisting.go b/build/platformclientv2/emergencygrouplisting.go deleted file mode 100644 index ccd93e4fd..000000000 --- a/build/platformclientv2/emergencygrouplisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Emergencygrouplisting -type Emergencygrouplisting struct { - // Entities - Entities *[]Emergencygroup `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Emergencygrouplisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/employerinfo.go b/build/platformclientv2/employerinfo.go deleted file mode 100644 index 65eee3fdc..000000000 --- a/build/platformclientv2/employerinfo.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Employerinfo -type Employerinfo struct { - // OfficialName - OfficialName *string `json:"officialName,omitempty"` - - - // EmployeeId - EmployeeId *string `json:"employeeId,omitempty"` - - - // EmployeeType - EmployeeType *string `json:"employeeType,omitempty"` - - - // DateHire - DateHire *string `json:"dateHire,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Employerinfo) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/empty.go b/build/platformclientv2/empty.go deleted file mode 100644 index 6931b39b3..000000000 --- a/build/platformclientv2/empty.go +++ /dev/null @@ -1,13 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Empty -type Empty struct { } - -// String returns a JSON representation of the model -func (o *Empty) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/encryptionkey.go b/build/platformclientv2/encryptionkey.go deleted file mode 100644 index cfcf685dc..000000000 --- a/build/platformclientv2/encryptionkey.go +++ /dev/null @@ -1,42 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Encryptionkey -type Encryptionkey struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // CreateDate - create date of the key pair. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - CreateDate *time.Time `json:"createDate,omitempty"` - - - // KeydataSummary - key data summary (base 64 encoded public key) - KeydataSummary *string `json:"keydataSummary,omitempty"` - - - // User - user that requested generation of public key - User *User `json:"user,omitempty"` - - - // LocalEncryptionConfiguration - Local configuration - LocalEncryptionConfiguration *Localencryptionconfiguration `json:"localEncryptionConfiguration,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Encryptionkey) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/encryptionkeyentitylisting.go b/build/platformclientv2/encryptionkeyentitylisting.go deleted file mode 100644 index 4055beec9..000000000 --- a/build/platformclientv2/encryptionkeyentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Encryptionkeyentitylisting -type Encryptionkeyentitylisting struct { - // Entities - Entities *[]Encryptionkey `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Encryptionkeyentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/endpoint.go b/build/platformclientv2/endpoint.go deleted file mode 100644 index 7ba8b6c35..000000000 --- a/build/platformclientv2/endpoint.go +++ /dev/null @@ -1,86 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Endpoint -type Endpoint struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name - Name *string `json:"name,omitempty"` - - - // Description - The resource's description. - Description *string `json:"description,omitempty"` - - - // Version - The current version of the resource. - Version *int `json:"version,omitempty"` - - - // DateCreated - The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // ModifiedBy - The ID of the user that last modified the resource. - ModifiedBy *string `json:"modifiedBy,omitempty"` - - - // CreatedBy - The ID of the user that created the resource. - CreatedBy *string `json:"createdBy,omitempty"` - - - // State - Indicates if the resource is active, inactive, or deleted. - State *string `json:"state,omitempty"` - - - // ModifiedByApp - The application that last modified the resource. - ModifiedByApp *string `json:"modifiedByApp,omitempty"` - - - // CreatedByApp - The application that created the resource. - CreatedByApp *string `json:"createdByApp,omitempty"` - - - // Count - Count *int `json:"count,omitempty"` - - - // Properties - Properties *map[string]interface{} `json:"properties,omitempty"` - - - // Schema - Schema - Schema *Domainentityref `json:"schema,omitempty"` - - - // Enabled - Enabled *bool `json:"enabled,omitempty"` - - - // Site - Site *Domainentityref `json:"site,omitempty"` - - - // Dids - Dids *[]string `json:"dids,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Endpoint) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/entity.go b/build/platformclientv2/entity.go deleted file mode 100644 index 277fbf428..000000000 --- a/build/platformclientv2/entity.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Entity -type Entity struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Entity) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/entitytypecriteria.go b/build/platformclientv2/entitytypecriteria.go deleted file mode 100644 index 11419c981..000000000 --- a/build/platformclientv2/entitytypecriteria.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Entitytypecriteria -type Entitytypecriteria struct { - // Key - The criteria key. - Key *string `json:"key,omitempty"` - - - // Values - The criteria values. - Values *[]string `json:"values,omitempty"` - - - // ShouldIgnoreCase - Should criteria be case insensitive. - ShouldIgnoreCase *bool `json:"shouldIgnoreCase,omitempty"` - - - // Operator - The comparison operator. - Operator *string `json:"operator,omitempty"` - - - // EntityType - The entity to match the pattern against. - EntityType *string `json:"entityType,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Entitytypecriteria) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/entry.go b/build/platformclientv2/entry.go deleted file mode 100644 index c4c0c8b8d..000000000 --- a/build/platformclientv2/entry.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Entry -type Entry struct { - // Value - A value included in this facet. - Value *string `json:"value,omitempty"` - - - // Count - The number of results with this value. - Count *int `json:"count,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Entry) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/errorbody.go b/build/platformclientv2/errorbody.go deleted file mode 100644 index 99e177d35..000000000 --- a/build/platformclientv2/errorbody.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Errorbody -type Errorbody struct { - // Message - Message *string `json:"message,omitempty"` - - - // Code - Code *string `json:"code,omitempty"` - - - // Status - Status *int `json:"status,omitempty"` - - - // EntityId - EntityId *string `json:"entityId,omitempty"` - - - // EntityName - EntityName *string `json:"entityName,omitempty"` - - - // MessageWithParams - MessageWithParams *string `json:"messageWithParams,omitempty"` - - - // MessageParams - MessageParams *map[string]string `json:"messageParams,omitempty"` - - - // ContextId - ContextId *string `json:"contextId,omitempty"` - - - // Details - Details *[]Detail `json:"details,omitempty"` - - - // Errors - Errors *[]Errorbody `json:"errors,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Errorbody) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/errordetails.go b/build/platformclientv2/errordetails.go deleted file mode 100644 index a26f733e0..000000000 --- a/build/platformclientv2/errordetails.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Errordetails -type Errordetails struct { - // Status - Status *int `json:"status,omitempty"` - - - // Message - Message *string `json:"message,omitempty"` - - - // MessageWithParams - MessageWithParams *string `json:"messageWithParams,omitempty"` - - - // MessageParams - MessageParams *map[string]string `json:"messageParams,omitempty"` - - - // Code - Code *string `json:"code,omitempty"` - - - // ContextId - ContextId *string `json:"contextId,omitempty"` - - - // Nested - Nested **Errordetails `json:"nested,omitempty"` - - - // Details - Details *string `json:"details,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Errordetails) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/errorinfo.go b/build/platformclientv2/errorinfo.go deleted file mode 100644 index c142a7e6f..000000000 --- a/build/platformclientv2/errorinfo.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Errorinfo -type Errorinfo struct { - // Message - Message *string `json:"message,omitempty"` - - - // Code - Code *string `json:"code,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Errorinfo) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/estimatedwaittimepredictions.go b/build/platformclientv2/estimatedwaittimepredictions.go deleted file mode 100644 index 5faac08b0..000000000 --- a/build/platformclientv2/estimatedwaittimepredictions.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Estimatedwaittimepredictions -type Estimatedwaittimepredictions struct { - // Results - Returned upon a successful estimated wait time request. - Results *[]Predictionresults `json:"results,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Estimatedwaittimepredictions) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/evaluation.go b/build/platformclientv2/evaluation.go deleted file mode 100644 index d9d8d2761..000000000 --- a/build/platformclientv2/evaluation.go +++ /dev/null @@ -1,110 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Evaluation -type Evaluation struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Conversation - Conversation *Conversation `json:"conversation,omitempty"` - - - // EvaluationForm - Evaluation form used for evaluation. - EvaluationForm *Evaluationform `json:"evaluationForm,omitempty"` - - - // Evaluator - Evaluator *User `json:"evaluator,omitempty"` - - - // Agent - Agent *User `json:"agent,omitempty"` - - - // Calibration - Calibration *Calibration `json:"calibration,omitempty"` - - - // Status - Status *string `json:"status,omitempty"` - - - // Answers - Answers *Evaluationscoringset `json:"answers,omitempty"` - - - // AgentHasRead - AgentHasRead *bool `json:"agentHasRead,omitempty"` - - - // ReleaseDate - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ReleaseDate *time.Time `json:"releaseDate,omitempty"` - - - // AssignedDate - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - AssignedDate *time.Time `json:"assignedDate,omitempty"` - - - // ChangedDate - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ChangedDate *time.Time `json:"changedDate,omitempty"` - - - // Queue - Queue *Queue `json:"queue,omitempty"` - - - // MediaType - List of different communication types used in conversation. - MediaType *[]string `json:"mediaType,omitempty"` - - - // Rescore - Is only true when evaluation is re-scored. - Rescore *bool `json:"rescore,omitempty"` - - - // ConversationDate - Date of conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ConversationDate *time.Time `json:"conversationDate,omitempty"` - - - // ConversationEndDate - End date of conversation if it had completed before evaluation creation. Null if created before the conversation ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ConversationEndDate *time.Time `json:"conversationEndDate,omitempty"` - - - // NeverRelease - Signifies if the evaluation is never to be released. This cannot be set true if release date is also set. - NeverRelease *bool `json:"neverRelease,omitempty"` - - - // ResourceId - Only used for email evaluations. Will be null for all other evaluations. - ResourceId *string `json:"resourceId,omitempty"` - - - // ResourceType - The type of resource. Only used for email evaluations. Will be null for evaluations on all other resources. - ResourceType *string `json:"resourceType,omitempty"` - - - // Redacted - Is only true when the user making the request does not have sufficient permissions to see evaluation - Redacted *bool `json:"redacted,omitempty"` - - - // IsScoringIndex - IsScoringIndex *bool `json:"isScoringIndex,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Evaluation) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/evaluationaggregatedatacontainer.go b/build/platformclientv2/evaluationaggregatedatacontainer.go deleted file mode 100644 index 7981558f7..000000000 --- a/build/platformclientv2/evaluationaggregatedatacontainer.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Evaluationaggregatedatacontainer -type Evaluationaggregatedatacontainer struct { - // Group - A mapping from dimension to value - Group *map[string]string `json:"group,omitempty"` - - - // Data - Data *[]Statisticalresponse `json:"data,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Evaluationaggregatedatacontainer) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/evaluationaggregatequeryclause.go b/build/platformclientv2/evaluationaggregatequeryclause.go deleted file mode 100644 index 9630c31e4..000000000 --- a/build/platformclientv2/evaluationaggregatequeryclause.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Evaluationaggregatequeryclause -type Evaluationaggregatequeryclause struct { - // VarType - Boolean operation to apply to the provided predicates - VarType *string `json:"type,omitempty"` - - - // Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value). - Predicates *[]Evaluationaggregatequerypredicate `json:"predicates,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Evaluationaggregatequeryclause) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/evaluationaggregatequeryfilter.go b/build/platformclientv2/evaluationaggregatequeryfilter.go deleted file mode 100644 index 77c11afcf..000000000 --- a/build/platformclientv2/evaluationaggregatequeryfilter.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Evaluationaggregatequeryfilter -type Evaluationaggregatequeryfilter struct { - // VarType - Boolean operation to apply to the provided predicates and clauses - VarType *string `json:"type,omitempty"` - - - // Clauses - Boolean 'and/or' logic with up to two-levels of nesting - Clauses *[]Evaluationaggregatequeryclause `json:"clauses,omitempty"` - - - // Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value). - Predicates *[]Evaluationaggregatequerypredicate `json:"predicates,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Evaluationaggregatequeryfilter) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/evaluationaggregatequerypredicate.go b/build/platformclientv2/evaluationaggregatequerypredicate.go deleted file mode 100644 index 0908939b4..000000000 --- a/build/platformclientv2/evaluationaggregatequerypredicate.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Evaluationaggregatequerypredicate -type Evaluationaggregatequerypredicate struct { - // VarType - Optional type, can usually be inferred - VarType *string `json:"type,omitempty"` - - - // Dimension - Left hand side for dimension predicates - Dimension *string `json:"dimension,omitempty"` - - - // Operator - Optional operator, default is matches - Operator *string `json:"operator,omitempty"` - - - // Value - Right hand side for dimension predicates - Value *string `json:"value,omitempty"` - - - // VarRange - Right hand side for dimension predicates - VarRange *Numericrange `json:"range,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Evaluationaggregatequerypredicate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/evaluationaggregatequeryresponse.go b/build/platformclientv2/evaluationaggregatequeryresponse.go deleted file mode 100644 index ca86485dc..000000000 --- a/build/platformclientv2/evaluationaggregatequeryresponse.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Evaluationaggregatequeryresponse -type Evaluationaggregatequeryresponse struct { - // Results - Results *[]Evaluationaggregatedatacontainer `json:"results,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Evaluationaggregatequeryresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/evaluationaggregationquery.go b/build/platformclientv2/evaluationaggregationquery.go deleted file mode 100644 index 5cd086130..000000000 --- a/build/platformclientv2/evaluationaggregationquery.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Evaluationaggregationquery -type Evaluationaggregationquery struct { - // Interval - Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss - Interval *string `json:"interval,omitempty"` - - - // Granularity - Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H - Granularity *string `json:"granularity,omitempty"` - - - // TimeZone - Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London - TimeZone *string `json:"timeZone,omitempty"` - - - // GroupBy - Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group. - GroupBy *[]string `json:"groupBy,omitempty"` - - - // Filter - Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters - Filter *Evaluationaggregatequeryfilter `json:"filter,omitempty"` - - - // Metrics - Behaves like a SQL SELECT clause. Only named metrics will be retrieved. - Metrics *[]string `json:"metrics,omitempty"` - - - // FlattenMultivaluedDimensions - Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c') - FlattenMultivaluedDimensions *bool `json:"flattenMultivaluedDimensions,omitempty"` - - - // Views - Custom derived metric views - Views *[]Evaluationaggregationview `json:"views,omitempty"` - - - // AlternateTimeDimension - Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event. - AlternateTimeDimension *string `json:"alternateTimeDimension,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Evaluationaggregationquery) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/evaluationaggregationview.go b/build/platformclientv2/evaluationaggregationview.go deleted file mode 100644 index d9774b7b5..000000000 --- a/build/platformclientv2/evaluationaggregationview.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Evaluationaggregationview -type Evaluationaggregationview struct { - // Target - Target metric name - Target *string `json:"target,omitempty"` - - - // Name - A unique name for this view. Must be distinct from other views and built-in metric names. - Name *string `json:"name,omitempty"` - - - // Function - Type of view you wish to create - Function *string `json:"function,omitempty"` - - - // VarRange - Range of numbers for slicing up data - VarRange *Aggregationrange `json:"range,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Evaluationaggregationview) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/evaluationassignment.go b/build/platformclientv2/evaluationassignment.go deleted file mode 100644 index a8ec9ea67..000000000 --- a/build/platformclientv2/evaluationassignment.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Evaluationassignment -type Evaluationassignment struct { - // EvaluationForm - EvaluationForm *Evaluationform `json:"evaluationForm,omitempty"` - - - // User - User *User `json:"user,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Evaluationassignment) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/evaluationdetailqueryclause.go b/build/platformclientv2/evaluationdetailqueryclause.go deleted file mode 100644 index c8306233c..000000000 --- a/build/platformclientv2/evaluationdetailqueryclause.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Evaluationdetailqueryclause -type Evaluationdetailqueryclause struct { - // VarType - Boolean operation to apply to the provided predicates - VarType *string `json:"type,omitempty"` - - - // Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value). - Predicates *[]Evaluationdetailquerypredicate `json:"predicates,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Evaluationdetailqueryclause) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/evaluationdetailqueryfilter.go b/build/platformclientv2/evaluationdetailqueryfilter.go deleted file mode 100644 index 1dffada0d..000000000 --- a/build/platformclientv2/evaluationdetailqueryfilter.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Evaluationdetailqueryfilter -type Evaluationdetailqueryfilter struct { - // VarType - Boolean operation to apply to the provided predicates and clauses - VarType *string `json:"type,omitempty"` - - - // Clauses - Boolean 'and/or' logic with up to two-levels of nesting - Clauses *[]Evaluationdetailqueryclause `json:"clauses,omitempty"` - - - // Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value). - Predicates *[]Evaluationdetailquerypredicate `json:"predicates,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Evaluationdetailqueryfilter) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/evaluationdetailquerypredicate.go b/build/platformclientv2/evaluationdetailquerypredicate.go deleted file mode 100644 index 7c772d061..000000000 --- a/build/platformclientv2/evaluationdetailquerypredicate.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Evaluationdetailquerypredicate -type Evaluationdetailquerypredicate struct { - // VarType - Optional type, can usually be inferred - VarType *string `json:"type,omitempty"` - - - // Dimension - Left hand side for dimension predicates - Dimension *string `json:"dimension,omitempty"` - - - // Metric - Left hand side for metric predicates - Metric *string `json:"metric,omitempty"` - - - // Operator - Optional operator, default is matches - Operator *string `json:"operator,omitempty"` - - - // Value - Right hand side for dimension or metric predicates - Value *string `json:"value,omitempty"` - - - // VarRange - Right hand side for dimension or metric predicates - VarRange *Numericrange `json:"range,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Evaluationdetailquerypredicate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/evaluationentitylisting.go b/build/platformclientv2/evaluationentitylisting.go deleted file mode 100644 index 29c1ee481..000000000 --- a/build/platformclientv2/evaluationentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Evaluationentitylisting -type Evaluationentitylisting struct { - // Entities - Entities *[]Evaluation `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Evaluationentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/evaluationform.go b/build/platformclientv2/evaluationform.go deleted file mode 100644 index 740665cf5..000000000 --- a/build/platformclientv2/evaluationform.go +++ /dev/null @@ -1,46 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Evaluationform -type Evaluationform struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The evaluation form name - Name *string `json:"name,omitempty"` - - - // ModifiedDate - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ModifiedDate *time.Time `json:"modifiedDate,omitempty"` - - - // Published - Published *bool `json:"published,omitempty"` - - - // ContextId - ContextId *string `json:"contextId,omitempty"` - - - // QuestionGroups - A list of question groups - QuestionGroups *[]Evaluationquestiongroup `json:"questionGroups,omitempty"` - - - // PublishedVersions - PublishedVersions *Domainentitylistingevaluationform `json:"publishedVersions,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Evaluationform) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/evaluationformandscoringset.go b/build/platformclientv2/evaluationformandscoringset.go deleted file mode 100644 index 6df05f186..000000000 --- a/build/platformclientv2/evaluationformandscoringset.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Evaluationformandscoringset -type Evaluationformandscoringset struct { - // EvaluationForm - EvaluationForm *Evaluationform `json:"evaluationForm,omitempty"` - - - // Answers - Answers *Evaluationscoringset `json:"answers,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Evaluationformandscoringset) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/evaluationformentitylisting.go b/build/platformclientv2/evaluationformentitylisting.go deleted file mode 100644 index 77356c1f1..000000000 --- a/build/platformclientv2/evaluationformentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Evaluationformentitylisting -type Evaluationformentitylisting struct { - // Entities - Entities *[]Evaluationform `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Evaluationformentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/evaluationqualityv2topicevaluationscoringset.go b/build/platformclientv2/evaluationqualityv2topicevaluationscoringset.go deleted file mode 100644 index 21500c237..000000000 --- a/build/platformclientv2/evaluationqualityv2topicevaluationscoringset.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Evaluationqualityv2topicevaluationscoringset -type Evaluationqualityv2topicevaluationscoringset struct { - // TotalScore - TotalScore *int `json:"totalScore,omitempty"` - - - // TotalCriticalScore - TotalCriticalScore *int `json:"totalCriticalScore,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Evaluationqualityv2topicevaluationscoringset) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/evaluationqualityv2topicevaluationv2.go b/build/platformclientv2/evaluationqualityv2topicevaluationv2.go deleted file mode 100644 index 14641942f..000000000 --- a/build/platformclientv2/evaluationqualityv2topicevaluationv2.go +++ /dev/null @@ -1,98 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Evaluationqualityv2topicevaluationv2 -type Evaluationqualityv2topicevaluationv2 struct { - // Id - Id *string `json:"id,omitempty"` - - - // ConversationId - ConversationId *string `json:"conversationId,omitempty"` - - - // Agent - Agent *Evaluationqualityv2topicuser `json:"agent,omitempty"` - - - // Evaluator - Evaluator *Evaluationqualityv2topicuser `json:"evaluator,omitempty"` - - - // EventTime - EventTime *time.Time `json:"eventTime,omitempty"` - - - // EvaluationFormId - EvaluationFormId *string `json:"evaluationFormId,omitempty"` - - - // FormName - FormName *string `json:"formName,omitempty"` - - - // ScoringSet - ScoringSet *Evaluationqualityv2topicevaluationscoringset `json:"scoringSet,omitempty"` - - - // ContextId - ContextId *string `json:"contextId,omitempty"` - - - // Status - Status *string `json:"status,omitempty"` - - - // AgentHasRead - AgentHasRead *bool `json:"agentHasRead,omitempty"` - - - // ReleaseDate - ReleaseDate *time.Time `json:"releaseDate,omitempty"` - - - // AssignedDate - AssignedDate *time.Time `json:"assignedDate,omitempty"` - - - // ChangedDate - ChangedDate *time.Time `json:"changedDate,omitempty"` - - - // EventType - EventType *string `json:"eventType,omitempty"` - - - // ResourceId - ResourceId *string `json:"resourceId,omitempty"` - - - // ResourceType - ResourceType *string `json:"resourceType,omitempty"` - - - // DivisionIds - DivisionIds *[]string `json:"divisionIds,omitempty"` - - - // Rescore - Rescore *bool `json:"rescore,omitempty"` - - - // ConversationDate - ConversationDate *time.Time `json:"conversationDate,omitempty"` - - - // MediaType - MediaType *[]string `json:"mediaType,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Evaluationqualityv2topicevaluationv2) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/evaluationqualityv2topicuser.go b/build/platformclientv2/evaluationqualityv2topicuser.go deleted file mode 100644 index 13530cd17..000000000 --- a/build/platformclientv2/evaluationqualityv2topicuser.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Evaluationqualityv2topicuser -type Evaluationqualityv2topicuser struct { - // Id - Id *string `json:"id,omitempty"` - - - // DisplayName - DisplayName *string `json:"displayName,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Evaluationqualityv2topicuser) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/evaluationquestion.go b/build/platformclientv2/evaluationquestion.go deleted file mode 100644 index 79f9550a1..000000000 --- a/build/platformclientv2/evaluationquestion.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Evaluationquestion -type Evaluationquestion struct { - // Id - Id *string `json:"id,omitempty"` - - - // Text - Text *string `json:"text,omitempty"` - - - // HelpText - HelpText *string `json:"helpText,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - - - // NaEnabled - NaEnabled *bool `json:"naEnabled,omitempty"` - - - // CommentsRequired - CommentsRequired *bool `json:"commentsRequired,omitempty"` - - - // VisibilityCondition - VisibilityCondition *Visibilitycondition `json:"visibilityCondition,omitempty"` - - - // AnswerOptions - Options from which to choose an answer for this question. Only used by Multiple Choice type questions. - AnswerOptions *[]Answeroption `json:"answerOptions,omitempty"` - - - // IsKill - IsKill *bool `json:"isKill,omitempty"` - - - // IsCritical - IsCritical *bool `json:"isCritical,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Evaluationquestion) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/evaluationquestiongroup.go b/build/platformclientv2/evaluationquestiongroup.go deleted file mode 100644 index cae42a1f2..000000000 --- a/build/platformclientv2/evaluationquestiongroup.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Evaluationquestiongroup -type Evaluationquestiongroup struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - - - // DefaultAnswersToHighest - DefaultAnswersToHighest *bool `json:"defaultAnswersToHighest,omitempty"` - - - // DefaultAnswersToNA - DefaultAnswersToNA *bool `json:"defaultAnswersToNA,omitempty"` - - - // NaEnabled - NaEnabled *bool `json:"naEnabled,omitempty"` - - - // Weight - Weight *float32 `json:"weight,omitempty"` - - - // ManualWeight - ManualWeight *bool `json:"manualWeight,omitempty"` - - - // Questions - Questions *[]Evaluationquestion `json:"questions,omitempty"` - - - // VisibilityCondition - VisibilityCondition *Visibilitycondition `json:"visibilityCondition,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Evaluationquestiongroup) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/evaluationquestiongroupscore.go b/build/platformclientv2/evaluationquestiongroupscore.go deleted file mode 100644 index e19c00409..000000000 --- a/build/platformclientv2/evaluationquestiongroupscore.go +++ /dev/null @@ -1,73 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Evaluationquestiongroupscore -type Evaluationquestiongroupscore struct { - // QuestionGroupId - QuestionGroupId *string `json:"questionGroupId,omitempty"` - - - // TotalScore - TotalScore *float32 `json:"totalScore,omitempty"` - - - // MaxTotalScore - MaxTotalScore *float32 `json:"maxTotalScore,omitempty"` - - - // MarkedNA - MarkedNA *bool `json:"markedNA,omitempty"` - - - // TotalCriticalScore - TotalCriticalScore *float32 `json:"totalCriticalScore,omitempty"` - - - // MaxTotalCriticalScore - MaxTotalCriticalScore *float32 `json:"maxTotalCriticalScore,omitempty"` - - - // TotalNonCriticalScore - TotalNonCriticalScore *float32 `json:"totalNonCriticalScore,omitempty"` - - - // MaxTotalNonCriticalScore - MaxTotalNonCriticalScore *float32 `json:"maxTotalNonCriticalScore,omitempty"` - - - // TotalScoreUnweighted - TotalScoreUnweighted *float32 `json:"totalScoreUnweighted,omitempty"` - - - // MaxTotalScoreUnweighted - MaxTotalScoreUnweighted *float32 `json:"maxTotalScoreUnweighted,omitempty"` - - - // TotalCriticalScoreUnweighted - TotalCriticalScoreUnweighted *float32 `json:"totalCriticalScoreUnweighted,omitempty"` - - - // MaxTotalCriticalScoreUnweighted - MaxTotalCriticalScoreUnweighted *float32 `json:"maxTotalCriticalScoreUnweighted,omitempty"` - - - // TotalNonCriticalScoreUnweighted - TotalNonCriticalScoreUnweighted *float32 `json:"totalNonCriticalScoreUnweighted,omitempty"` - - - // MaxTotalNonCriticalScoreUnweighted - MaxTotalNonCriticalScoreUnweighted *float32 `json:"maxTotalNonCriticalScoreUnweighted,omitempty"` - - - // QuestionScores - QuestionScores *[]Evaluationquestionscore `json:"questionScores,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Evaluationquestiongroupscore) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/evaluationquestionscore.go b/build/platformclientv2/evaluationquestionscore.go deleted file mode 100644 index b101a67f6..000000000 --- a/build/platformclientv2/evaluationquestionscore.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Evaluationquestionscore -type Evaluationquestionscore struct { - // QuestionId - QuestionId *string `json:"questionId,omitempty"` - - - // AnswerId - AnswerId *string `json:"answerId,omitempty"` - - - // Score - Score *int `json:"score,omitempty"` - - - // MarkedNA - MarkedNA *bool `json:"markedNA,omitempty"` - - - // FailedKillQuestion - FailedKillQuestion *bool `json:"failedKillQuestion,omitempty"` - - - // Comments - Comments *string `json:"comments,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Evaluationquestionscore) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/evaluationscoringset.go b/build/platformclientv2/evaluationscoringset.go deleted file mode 100644 index c144a4483..000000000 --- a/build/platformclientv2/evaluationscoringset.go +++ /dev/null @@ -1,41 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Evaluationscoringset -type Evaluationscoringset struct { - // TotalScore - TotalScore *float32 `json:"totalScore,omitempty"` - - - // TotalCriticalScore - TotalCriticalScore *float32 `json:"totalCriticalScore,omitempty"` - - - // TotalNonCriticalScore - TotalNonCriticalScore *float32 `json:"totalNonCriticalScore,omitempty"` - - - // QuestionGroupScores - QuestionGroupScores *[]Evaluationquestiongroupscore `json:"questionGroupScores,omitempty"` - - - // AnyFailedKillQuestions - AnyFailedKillQuestions *bool `json:"anyFailedKillQuestions,omitempty"` - - - // Comments - Comments *string `json:"comments,omitempty"` - - - // AgentComments - AgentComments *string `json:"agentComments,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Evaluationscoringset) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/evaluatoractivity.go b/build/platformclientv2/evaluatoractivity.go deleted file mode 100644 index c5d5c74ba..000000000 --- a/build/platformclientv2/evaluatoractivity.go +++ /dev/null @@ -1,57 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Evaluatoractivity -type Evaluatoractivity struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Evaluator - Evaluator *User `json:"evaluator,omitempty"` - - - // NumEvaluationsAssigned - NumEvaluationsAssigned *int `json:"numEvaluationsAssigned,omitempty"` - - - // NumEvaluationsStarted - NumEvaluationsStarted *int `json:"numEvaluationsStarted,omitempty"` - - - // NumEvaluationsCompleted - NumEvaluationsCompleted *int `json:"numEvaluationsCompleted,omitempty"` - - - // NumCalibrationsAssigned - NumCalibrationsAssigned *int `json:"numCalibrationsAssigned,omitempty"` - - - // NumCalibrationsStarted - NumCalibrationsStarted *int `json:"numCalibrationsStarted,omitempty"` - - - // NumCalibrationsCompleted - NumCalibrationsCompleted *int `json:"numCalibrationsCompleted,omitempty"` - - - // NumEvaluationsWithoutViewPermission - NumEvaluationsWithoutViewPermission *int `json:"numEvaluationsWithoutViewPermission,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Evaluatoractivity) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/evaluatoractivityentitylisting.go b/build/platformclientv2/evaluatoractivityentitylisting.go deleted file mode 100644 index 8e9fb3466..000000000 --- a/build/platformclientv2/evaluatoractivityentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Evaluatoractivityentitylisting -type Evaluatoractivityentitylisting struct { - // Entities - Entities *[]Evaluatoractivity `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Evaluatoractivityentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/eventcondition.go b/build/platformclientv2/eventcondition.go deleted file mode 100644 index b26ddc759..000000000 --- a/build/platformclientv2/eventcondition.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Eventcondition -type Eventcondition struct { - // Key - The event key. - Key *string `json:"key,omitempty"` - - - // Values - The event values. - Values *[]string `json:"values,omitempty"` - - - // Operator - The comparison operator. - Operator *string `json:"operator,omitempty"` - - - // StreamType - The stream type for which this condition can be satisfied. - StreamType *string `json:"streamType,omitempty"` - - - // SessionType - The session type for which this condition can be satisfied. - SessionType *string `json:"sessionType,omitempty"` - - - // EventName - The name of the event for which this condition can be satisfied. - EventName *string `json:"eventName,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Eventcondition) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/evententity.go b/build/platformclientv2/evententity.go deleted file mode 100644 index 2202b2deb..000000000 --- a/build/platformclientv2/evententity.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Evententity -type Evententity struct { - // EntityType - Type of entity the event pertains to. e.g. integration - EntityType *string `json:"entityType,omitempty"` - - - // Id - ID of the entity the event pertains to. - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Evententity) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/eventlog.go b/build/platformclientv2/eventlog.go deleted file mode 100644 index 4b57373c2..000000000 --- a/build/platformclientv2/eventlog.go +++ /dev/null @@ -1,54 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Eventlog -type Eventlog struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // ErrorEntity - ErrorEntity *Domainentityref `json:"errorEntity,omitempty"` - - - // RelatedEntity - RelatedEntity *Domainentityref `json:"relatedEntity,omitempty"` - - - // Timestamp - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - Timestamp *time.Time `json:"timestamp,omitempty"` - - - // Level - Level *string `json:"level,omitempty"` - - - // Category - Category *string `json:"category,omitempty"` - - - // CorrelationId - CorrelationId *string `json:"correlationId,omitempty"` - - - // EventMessage - EventMessage *Eventmessage `json:"eventMessage,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Eventlog) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/eventmessage.go b/build/platformclientv2/eventmessage.go deleted file mode 100644 index c3cb48bbd..000000000 --- a/build/platformclientv2/eventmessage.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Eventmessage -type Eventmessage struct { - // Code - Code *string `json:"code,omitempty"` - - - // Message - Message *string `json:"message,omitempty"` - - - // MessageWithParams - MessageWithParams *string `json:"messageWithParams,omitempty"` - - - // MessageParams - MessageParams *map[string]interface{} `json:"messageParams,omitempty"` - - - // DocumentationUri - DocumentationUri *string `json:"documentationUri,omitempty"` - - - // ResourceURIs - ResourceURIs *[]string `json:"resourceURIs,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Eventmessage) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/executerecordingjobsquery.go b/build/platformclientv2/executerecordingjobsquery.go deleted file mode 100644 index 0d7335703..000000000 --- a/build/platformclientv2/executerecordingjobsquery.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Executerecordingjobsquery -type Executerecordingjobsquery struct { - // State - The desired state for the job to be set to. - State *string `json:"state,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Executerecordingjobsquery) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/expansioncriterium.go b/build/platformclientv2/expansioncriterium.go deleted file mode 100644 index 43b6e5182..000000000 --- a/build/platformclientv2/expansioncriterium.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Expansioncriterium -type Expansioncriterium struct { - // VarType - VarType *string `json:"type,omitempty"` - - - // Threshold - Threshold *float64 `json:"threshold,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Expansioncriterium) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/exportscriptrequest.go b/build/platformclientv2/exportscriptrequest.go deleted file mode 100644 index a2ac473de..000000000 --- a/build/platformclientv2/exportscriptrequest.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Exportscriptrequest - Creating an exported script via Download Service -type Exportscriptrequest struct { - // FileName - The final file name (no extension) of the script download: .script - FileName *string `json:"fileName,omitempty"` - - - // VersionId - The UUID version of the script to be exported. Defaults to the current editable version. - VersionId *string `json:"versionId,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Exportscriptrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/exportscriptresponse.go b/build/platformclientv2/exportscriptresponse.go deleted file mode 100644 index bd43e0bd5..000000000 --- a/build/platformclientv2/exportscriptresponse.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Exportscriptresponse -type Exportscriptresponse struct { - // Url - Url *string `json:"url,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Exportscriptresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/exporturi.go b/build/platformclientv2/exporturi.go deleted file mode 100644 index 73d862567..000000000 --- a/build/platformclientv2/exporturi.go +++ /dev/null @@ -1,22 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Exporturi -type Exporturi struct { - // Uri - Uri *string `json:"uri,omitempty"` - - - // ExportTimestamp - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ExportTimestamp *time.Time `json:"exportTimestamp,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Exporturi) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/extension.go b/build/platformclientv2/extension.go deleted file mode 100644 index 46ce27a74..000000000 --- a/build/platformclientv2/extension.go +++ /dev/null @@ -1,78 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Extension -type Extension struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the entity. - Name *string `json:"name,omitempty"` - - - // Description - The resource's description. - Description *string `json:"description,omitempty"` - - - // Version - The current version of the resource. - Version *int `json:"version,omitempty"` - - - // DateCreated - The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // ModifiedBy - The ID of the user that last modified the resource. - ModifiedBy *string `json:"modifiedBy,omitempty"` - - - // CreatedBy - The ID of the user that created the resource. - CreatedBy *string `json:"createdBy,omitempty"` - - - // State - Indicates if the resource is active, inactive, or deleted. - State *string `json:"state,omitempty"` - - - // ModifiedByApp - The application that last modified the resource. - ModifiedByApp *string `json:"modifiedByApp,omitempty"` - - - // CreatedByApp - The application that created the resource. - CreatedByApp *string `json:"createdByApp,omitempty"` - - - // Number - Number *string `json:"number,omitempty"` - - - // Owner - A Uri reference to the owner of this extension, which is either a User or an IVR - Owner *Domainentityref `json:"owner,omitempty"` - - - // ExtensionPool - ExtensionPool *Domainentityref `json:"extensionPool,omitempty"` - - - // OwnerType - OwnerType *string `json:"ownerType,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Extension) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/extensionentitylisting.go b/build/platformclientv2/extensionentitylisting.go deleted file mode 100644 index 12bccd82c..000000000 --- a/build/platformclientv2/extensionentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Extensionentitylisting -type Extensionentitylisting struct { - // Entities - Entities *[]Extension `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Extensionentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/extensionpool.go b/build/platformclientv2/extensionpool.go deleted file mode 100644 index 66dd7e55b..000000000 --- a/build/platformclientv2/extensionpool.go +++ /dev/null @@ -1,70 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Extensionpool -type Extensionpool struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the entity. - Name *string `json:"name,omitempty"` - - - // Description - The resource's description. - Description *string `json:"description,omitempty"` - - - // Version - The current version of the resource. - Version *int `json:"version,omitempty"` - - - // DateCreated - The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // ModifiedBy - The ID of the user that last modified the resource. - ModifiedBy *string `json:"modifiedBy,omitempty"` - - - // CreatedBy - The ID of the user that created the resource. - CreatedBy *string `json:"createdBy,omitempty"` - - - // State - Indicates if the resource is active, inactive, or deleted. - State *string `json:"state,omitempty"` - - - // ModifiedByApp - The application that last modified the resource. - ModifiedByApp *string `json:"modifiedByApp,omitempty"` - - - // CreatedByApp - The application that created the resource. - CreatedByApp *string `json:"createdByApp,omitempty"` - - - // StartNumber - The starting phone number for the range of this Extension pool. Must be in E.164 format - StartNumber *string `json:"startNumber,omitempty"` - - - // EndNumber - The ending phone number for the range of this Extension pool. Must be in E.164 format - EndNumber *string `json:"endNumber,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Extensionpool) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/extensionpoolentitylisting.go b/build/platformclientv2/extensionpoolentitylisting.go deleted file mode 100644 index 561aab50e..000000000 --- a/build/platformclientv2/extensionpoolentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Extensionpoolentitylisting -type Extensionpoolentitylisting struct { - // Entities - Entities *[]Extensionpool `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Extensionpoolentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/externalcontact.go b/build/platformclientv2/externalcontact.go deleted file mode 100644 index 20f0eae40..000000000 --- a/build/platformclientv2/externalcontact.go +++ /dev/null @@ -1,122 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Externalcontact -type Externalcontact struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // FirstName - The first name of the contact. - FirstName *string `json:"firstName,omitempty"` - - - // MiddleName - MiddleName *string `json:"middleName,omitempty"` - - - // LastName - The last name of the contact. - LastName *string `json:"lastName,omitempty"` - - - // Salutation - Salutation *string `json:"salutation,omitempty"` - - - // Title - Title *string `json:"title,omitempty"` - - - // WorkPhone - WorkPhone *Phonenumber `json:"workPhone,omitempty"` - - - // CellPhone - CellPhone *Phonenumber `json:"cellPhone,omitempty"` - - - // HomePhone - HomePhone *Phonenumber `json:"homePhone,omitempty"` - - - // OtherPhone - OtherPhone *Phonenumber `json:"otherPhone,omitempty"` - - - // WorkEmail - WorkEmail *string `json:"workEmail,omitempty"` - - - // PersonalEmail - PersonalEmail *string `json:"personalEmail,omitempty"` - - - // OtherEmail - OtherEmail *string `json:"otherEmail,omitempty"` - - - // Address - Address *Contactaddress `json:"address,omitempty"` - - - // TwitterId - TwitterId *Twitterid `json:"twitterId,omitempty"` - - - // LineId - LineId *Lineid `json:"lineId,omitempty"` - - - // WhatsAppId - WhatsAppId *Whatsappid `json:"whatsAppId,omitempty"` - - - // FacebookId - FacebookId *Facebookid `json:"facebookId,omitempty"` - - - // ModifyDate - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ModifyDate *time.Time `json:"modifyDate,omitempty"` - - - // CreateDate - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - CreateDate *time.Time `json:"createDate,omitempty"` - - - // ExternalOrganization - ExternalOrganization *Externalorganization `json:"externalOrganization,omitempty"` - - - // SurveyOptOut - SurveyOptOut *bool `json:"surveyOptOut,omitempty"` - - - // ExternalSystemUrl - A string that identifies an external system-of-record resource that may have more detailed information on the contact. It should be a valid URL (including the http/https protocol, port, and path [if any]). The value is automatically trimmed of any leading and trailing whitespace. - ExternalSystemUrl *string `json:"externalSystemUrl,omitempty"` - - - // Schema - The schema defining custom fields for this contact - Schema *Dataschema `json:"schema,omitempty"` - - - // CustomFields - Custom fields defined in the schema referenced by schemaId and schemaVersion. - CustomFields *map[string]interface{} `json:"customFields,omitempty"` - - - // ExternalDataSources - Links to the sources of data (e.g. one source might be a CRM) that contributed data to this record. Read-only, and only populated when requested via expand param. - ExternalDataSources *[]Externaldatasource `json:"externalDataSources,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Externalcontact) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/externalcontactsapi.go b/build/platformclientv2/externalcontactsapi.go deleted file mode 100644 index 51a5c3438..000000000 --- a/build/platformclientv2/externalcontactsapi.go +++ /dev/null @@ -1,3933 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "encoding/json" -) - -// ExternalContactsApi provides functions for API endpoints -type ExternalContactsApi struct { - Configuration *Configuration -} - -// NewExternalContactsApi creates an API instance using the default configuration -func NewExternalContactsApi() *ExternalContactsApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating ExternalContactsApi with base path: %s", strings.ToLower(config.BasePath))) - return &ExternalContactsApi{ - Configuration: config, - } -} - -// NewExternalContactsApiWithConfig creates an API instance using the provided configuration -func NewExternalContactsApiWithConfig(config *Configuration) *ExternalContactsApi { - config.Debugf("Creating ExternalContactsApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &ExternalContactsApi{ - Configuration: config, - } -} - -// DeleteExternalcontactsContact invokes DELETE /api/v2/externalcontacts/contacts/{contactId} -// -// Delete an external contact -// -// -func (a ExternalContactsApi) DeleteExternalcontactsContact(contactId string) (*Empty, *APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/externalcontacts/contacts/{contactId}" - path = strings.Replace(path, "{contactId}", fmt.Sprintf("%v", contactId), -1) - defaultReturn := new(Empty) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'contactId' is set - if &contactId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'contactId' when calling ExternalContactsApi->DeleteExternalcontactsContact") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Empty - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// DeleteExternalcontactsContactNote invokes DELETE /api/v2/externalcontacts/contacts/{contactId}/notes/{noteId} -// -// Delete a note for an external contact -// -// -func (a ExternalContactsApi) DeleteExternalcontactsContactNote(contactId string, noteId string) (*Empty, *APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/externalcontacts/contacts/{contactId}/notes/{noteId}" - path = strings.Replace(path, "{contactId}", fmt.Sprintf("%v", contactId), -1) - path = strings.Replace(path, "{noteId}", fmt.Sprintf("%v", noteId), -1) - defaultReturn := new(Empty) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'contactId' is set - if &contactId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'contactId' when calling ExternalContactsApi->DeleteExternalcontactsContactNote") - } - // verify the required parameter 'noteId' is set - if ¬eId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'noteId' when calling ExternalContactsApi->DeleteExternalcontactsContactNote") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Empty - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// DeleteExternalcontactsContactsSchema invokes DELETE /api/v2/externalcontacts/contacts/schemas/{schemaId} -// -// Delete a schema -// -// -func (a ExternalContactsApi) DeleteExternalcontactsContactsSchema(schemaId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/externalcontacts/contacts/schemas/{schemaId}" - path = strings.Replace(path, "{schemaId}", fmt.Sprintf("%v", schemaId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'schemaId' is set - if &schemaId == nil { - // - return nil, errors.New("Missing required parameter 'schemaId' when calling ExternalContactsApi->DeleteExternalcontactsContactsSchema") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteExternalcontactsOrganization invokes DELETE /api/v2/externalcontacts/organizations/{externalOrganizationId} -// -// Delete an external organization -// -// -func (a ExternalContactsApi) DeleteExternalcontactsOrganization(externalOrganizationId string) (*Empty, *APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/externalcontacts/organizations/{externalOrganizationId}" - path = strings.Replace(path, "{externalOrganizationId}", fmt.Sprintf("%v", externalOrganizationId), -1) - defaultReturn := new(Empty) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'externalOrganizationId' is set - if &externalOrganizationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'externalOrganizationId' when calling ExternalContactsApi->DeleteExternalcontactsOrganization") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Empty - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// DeleteExternalcontactsOrganizationNote invokes DELETE /api/v2/externalcontacts/organizations/{externalOrganizationId}/notes/{noteId} -// -// Delete a note for an external organization -// -// -func (a ExternalContactsApi) DeleteExternalcontactsOrganizationNote(externalOrganizationId string, noteId string) (*Empty, *APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/externalcontacts/organizations/{externalOrganizationId}/notes/{noteId}" - path = strings.Replace(path, "{externalOrganizationId}", fmt.Sprintf("%v", externalOrganizationId), -1) - path = strings.Replace(path, "{noteId}", fmt.Sprintf("%v", noteId), -1) - defaultReturn := new(Empty) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'externalOrganizationId' is set - if &externalOrganizationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'externalOrganizationId' when calling ExternalContactsApi->DeleteExternalcontactsOrganizationNote") - } - // verify the required parameter 'noteId' is set - if ¬eId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'noteId' when calling ExternalContactsApi->DeleteExternalcontactsOrganizationNote") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Empty - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// DeleteExternalcontactsOrganizationTrustor invokes DELETE /api/v2/externalcontacts/organizations/{externalOrganizationId}/trustor -// -// Unlink the Trustor for this External Organization -// -// -func (a ExternalContactsApi) DeleteExternalcontactsOrganizationTrustor(externalOrganizationId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/externalcontacts/organizations/{externalOrganizationId}/trustor" - path = strings.Replace(path, "{externalOrganizationId}", fmt.Sprintf("%v", externalOrganizationId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'externalOrganizationId' is set - if &externalOrganizationId == nil { - // - return nil, errors.New("Missing required parameter 'externalOrganizationId' when calling ExternalContactsApi->DeleteExternalcontactsOrganizationTrustor") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteExternalcontactsRelationship invokes DELETE /api/v2/externalcontacts/relationships/{relationshipId} -// -// Delete a relationship -// -// -func (a ExternalContactsApi) DeleteExternalcontactsRelationship(relationshipId string) (*Empty, *APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/externalcontacts/relationships/{relationshipId}" - path = strings.Replace(path, "{relationshipId}", fmt.Sprintf("%v", relationshipId), -1) - defaultReturn := new(Empty) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'relationshipId' is set - if &relationshipId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'relationshipId' when calling ExternalContactsApi->DeleteExternalcontactsRelationship") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Empty - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetExternalcontactsContact invokes GET /api/v2/externalcontacts/contacts/{contactId} -// -// Fetch an external contact -// -// -func (a ExternalContactsApi) GetExternalcontactsContact(contactId string, expand []string) (*Externalcontact, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/externalcontacts/contacts/{contactId}" - path = strings.Replace(path, "{contactId}", fmt.Sprintf("%v", contactId), -1) - defaultReturn := new(Externalcontact) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'contactId' is set - if &contactId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'contactId' when calling ExternalContactsApi->GetExternalcontactsContact") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Externalcontact - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetExternalcontactsContactNote invokes GET /api/v2/externalcontacts/contacts/{contactId}/notes/{noteId} -// -// Fetch a note for an external contact -// -// -func (a ExternalContactsApi) GetExternalcontactsContactNote(contactId string, noteId string, expand []string) (*Note, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/externalcontacts/contacts/{contactId}/notes/{noteId}" - path = strings.Replace(path, "{contactId}", fmt.Sprintf("%v", contactId), -1) - path = strings.Replace(path, "{noteId}", fmt.Sprintf("%v", noteId), -1) - defaultReturn := new(Note) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'contactId' is set - if &contactId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'contactId' when calling ExternalContactsApi->GetExternalcontactsContactNote") - } - // verify the required parameter 'noteId' is set - if ¬eId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'noteId' when calling ExternalContactsApi->GetExternalcontactsContactNote") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Note - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetExternalcontactsContactNotes invokes GET /api/v2/externalcontacts/contacts/{contactId}/notes -// -// List notes for an external contact -// -// -func (a ExternalContactsApi) GetExternalcontactsContactNotes(contactId string, pageSize int, pageNumber int, sortOrder string, expand []string) (*Notelisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/externalcontacts/contacts/{contactId}/notes" - path = strings.Replace(path, "{contactId}", fmt.Sprintf("%v", contactId), -1) - defaultReturn := new(Notelisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'contactId' is set - if &contactId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'contactId' when calling ExternalContactsApi->GetExternalcontactsContactNotes") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Notelisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetExternalcontactsContacts invokes GET /api/v2/externalcontacts/contacts -// -// Search for external contacts -// -// -func (a ExternalContactsApi) GetExternalcontactsContacts(pageSize int, pageNumber int, q string, sortOrder string, expand []string) (*Contactlisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/externalcontacts/contacts" - defaultReturn := new(Contactlisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(q).(string); ok { - if str != "" { - queryParams["q"] = a.Configuration.APIClient.ParameterToString(q, collectionFormat) - } - } else { - queryParams["q"] = a.Configuration.APIClient.ParameterToString(q, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Contactlisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetExternalcontactsContactsSchema invokes GET /api/v2/externalcontacts/contacts/schemas/{schemaId} -// -// Get a schema -// -// -func (a ExternalContactsApi) GetExternalcontactsContactsSchema(schemaId string) (*Dataschema, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/externalcontacts/contacts/schemas/{schemaId}" - path = strings.Replace(path, "{schemaId}", fmt.Sprintf("%v", schemaId), -1) - defaultReturn := new(Dataschema) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'schemaId' is set - if &schemaId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'schemaId' when calling ExternalContactsApi->GetExternalcontactsContactsSchema") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Dataschema - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetExternalcontactsContactsSchemaVersion invokes GET /api/v2/externalcontacts/contacts/schemas/{schemaId}/versions/{versionId} -// -// Get a specific version of a schema -// -// -func (a ExternalContactsApi) GetExternalcontactsContactsSchemaVersion(schemaId string, versionId string) (*Dataschema, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/externalcontacts/contacts/schemas/{schemaId}/versions/{versionId}" - path = strings.Replace(path, "{schemaId}", fmt.Sprintf("%v", schemaId), -1) - path = strings.Replace(path, "{versionId}", fmt.Sprintf("%v", versionId), -1) - defaultReturn := new(Dataschema) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'schemaId' is set - if &schemaId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'schemaId' when calling ExternalContactsApi->GetExternalcontactsContactsSchemaVersion") - } - // verify the required parameter 'versionId' is set - if &versionId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'versionId' when calling ExternalContactsApi->GetExternalcontactsContactsSchemaVersion") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Dataschema - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetExternalcontactsContactsSchemaVersions invokes GET /api/v2/externalcontacts/contacts/schemas/{schemaId}/versions -// -// Get all versions of an external contact's schema -// -// -func (a ExternalContactsApi) GetExternalcontactsContactsSchemaVersions(schemaId string) (*Dataschema, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/externalcontacts/contacts/schemas/{schemaId}/versions" - path = strings.Replace(path, "{schemaId}", fmt.Sprintf("%v", schemaId), -1) - defaultReturn := new(Dataschema) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'schemaId' is set - if &schemaId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'schemaId' when calling ExternalContactsApi->GetExternalcontactsContactsSchemaVersions") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Dataschema - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetExternalcontactsContactsSchemas invokes GET /api/v2/externalcontacts/contacts/schemas -// -// Get a list of schemas. -// -// -func (a ExternalContactsApi) GetExternalcontactsContactsSchemas() (*Dataschemalisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/externalcontacts/contacts/schemas" - defaultReturn := new(Dataschemalisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Dataschemalisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetExternalcontactsOrganization invokes GET /api/v2/externalcontacts/organizations/{externalOrganizationId} -// -// Fetch an external organization -// -// -func (a ExternalContactsApi) GetExternalcontactsOrganization(externalOrganizationId string, expand string, includeTrustors bool) (*Externalorganization, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/externalcontacts/organizations/{externalOrganizationId}" - path = strings.Replace(path, "{externalOrganizationId}", fmt.Sprintf("%v", externalOrganizationId), -1) - defaultReturn := new(Externalorganization) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'externalOrganizationId' is set - if &externalOrganizationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'externalOrganizationId' when calling ExternalContactsApi->GetExternalcontactsOrganization") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(expand).(string); ok { - if str != "" { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(includeTrustors).(string); ok { - if str != "" { - queryParams["includeTrustors"] = a.Configuration.APIClient.ParameterToString(includeTrustors, collectionFormat) - } - } else { - queryParams["includeTrustors"] = a.Configuration.APIClient.ParameterToString(includeTrustors, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Externalorganization - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetExternalcontactsOrganizationContacts invokes GET /api/v2/externalcontacts/organizations/{externalOrganizationId}/contacts -// -// Search for external contacts in an external organization -// -// -func (a ExternalContactsApi) GetExternalcontactsOrganizationContacts(externalOrganizationId string, pageSize int, pageNumber int, q string, sortOrder string, expand []string) (*Contactlisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/externalcontacts/organizations/{externalOrganizationId}/contacts" - path = strings.Replace(path, "{externalOrganizationId}", fmt.Sprintf("%v", externalOrganizationId), -1) - defaultReturn := new(Contactlisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'externalOrganizationId' is set - if &externalOrganizationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'externalOrganizationId' when calling ExternalContactsApi->GetExternalcontactsOrganizationContacts") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(q).(string); ok { - if str != "" { - queryParams["q"] = a.Configuration.APIClient.ParameterToString(q, collectionFormat) - } - } else { - queryParams["q"] = a.Configuration.APIClient.ParameterToString(q, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Contactlisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetExternalcontactsOrganizationNote invokes GET /api/v2/externalcontacts/organizations/{externalOrganizationId}/notes/{noteId} -// -// Fetch a note for an external organization -// -// -func (a ExternalContactsApi) GetExternalcontactsOrganizationNote(externalOrganizationId string, noteId string, expand []string) (*Note, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/externalcontacts/organizations/{externalOrganizationId}/notes/{noteId}" - path = strings.Replace(path, "{externalOrganizationId}", fmt.Sprintf("%v", externalOrganizationId), -1) - path = strings.Replace(path, "{noteId}", fmt.Sprintf("%v", noteId), -1) - defaultReturn := new(Note) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'externalOrganizationId' is set - if &externalOrganizationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'externalOrganizationId' when calling ExternalContactsApi->GetExternalcontactsOrganizationNote") - } - // verify the required parameter 'noteId' is set - if ¬eId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'noteId' when calling ExternalContactsApi->GetExternalcontactsOrganizationNote") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Note - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetExternalcontactsOrganizationNotes invokes GET /api/v2/externalcontacts/organizations/{externalOrganizationId}/notes -// -// List notes for an external organization -// -// -func (a ExternalContactsApi) GetExternalcontactsOrganizationNotes(externalOrganizationId string, pageSize int, pageNumber int, sortOrder string, expand []string) (*Notelisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/externalcontacts/organizations/{externalOrganizationId}/notes" - path = strings.Replace(path, "{externalOrganizationId}", fmt.Sprintf("%v", externalOrganizationId), -1) - defaultReturn := new(Notelisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'externalOrganizationId' is set - if &externalOrganizationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'externalOrganizationId' when calling ExternalContactsApi->GetExternalcontactsOrganizationNotes") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Notelisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetExternalcontactsOrganizationRelationships invokes GET /api/v2/externalcontacts/organizations/{externalOrganizationId}/relationships -// -// Fetch a relationship for an external organization -// -// -func (a ExternalContactsApi) GetExternalcontactsOrganizationRelationships(externalOrganizationId string, pageSize int, pageNumber int, expand string, sortOrder string) (*Relationshiplisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/externalcontacts/organizations/{externalOrganizationId}/relationships" - path = strings.Replace(path, "{externalOrganizationId}", fmt.Sprintf("%v", externalOrganizationId), -1) - defaultReturn := new(Relationshiplisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'externalOrganizationId' is set - if &externalOrganizationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'externalOrganizationId' when calling ExternalContactsApi->GetExternalcontactsOrganizationRelationships") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(expand).(string); ok { - if str != "" { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Relationshiplisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetExternalcontactsOrganizations invokes GET /api/v2/externalcontacts/organizations -// -// Search for external organizations -// -// -func (a ExternalContactsApi) GetExternalcontactsOrganizations(pageSize int, pageNumber int, q string, trustorId []string, sortOrder string, expand []string, includeTrustors bool) (*Externalorganizationlisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/externalcontacts/organizations" - defaultReturn := new(Externalorganizationlisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(q).(string); ok { - if str != "" { - queryParams["q"] = a.Configuration.APIClient.ParameterToString(q, collectionFormat) - } - } else { - queryParams["q"] = a.Configuration.APIClient.ParameterToString(q, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range trustorId { - queryParams["trustorId"] = value - } - } else { - queryParams["trustorId"] = a.Configuration.APIClient.ParameterToString(trustorId, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(includeTrustors).(string); ok { - if str != "" { - queryParams["includeTrustors"] = a.Configuration.APIClient.ParameterToString(includeTrustors, collectionFormat) - } - } else { - queryParams["includeTrustors"] = a.Configuration.APIClient.ParameterToString(includeTrustors, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Externalorganizationlisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetExternalcontactsOrganizationsSchema invokes GET /api/v2/externalcontacts/organizations/schemas/{schemaId} -// -// Get a schema -// -// -func (a ExternalContactsApi) GetExternalcontactsOrganizationsSchema(schemaId string) (*Dataschema, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/externalcontacts/organizations/schemas/{schemaId}" - path = strings.Replace(path, "{schemaId}", fmt.Sprintf("%v", schemaId), -1) - defaultReturn := new(Dataschema) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'schemaId' is set - if &schemaId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'schemaId' when calling ExternalContactsApi->GetExternalcontactsOrganizationsSchema") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Dataschema - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetExternalcontactsOrganizationsSchemaVersion invokes GET /api/v2/externalcontacts/organizations/schemas/{schemaId}/versions/{versionId} -// -// Get a specific version of a schema -// -// -func (a ExternalContactsApi) GetExternalcontactsOrganizationsSchemaVersion(schemaId string, versionId string) (*Dataschema, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/externalcontacts/organizations/schemas/{schemaId}/versions/{versionId}" - path = strings.Replace(path, "{schemaId}", fmt.Sprintf("%v", schemaId), -1) - path = strings.Replace(path, "{versionId}", fmt.Sprintf("%v", versionId), -1) - defaultReturn := new(Dataschema) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'schemaId' is set - if &schemaId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'schemaId' when calling ExternalContactsApi->GetExternalcontactsOrganizationsSchemaVersion") - } - // verify the required parameter 'versionId' is set - if &versionId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'versionId' when calling ExternalContactsApi->GetExternalcontactsOrganizationsSchemaVersion") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Dataschema - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetExternalcontactsOrganizationsSchemaVersions invokes GET /api/v2/externalcontacts/organizations/schemas/{schemaId}/versions -// -// Get all versions of an external organization's schema -// -// -func (a ExternalContactsApi) GetExternalcontactsOrganizationsSchemaVersions(schemaId string) (*Dataschema, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/externalcontacts/organizations/schemas/{schemaId}/versions" - path = strings.Replace(path, "{schemaId}", fmt.Sprintf("%v", schemaId), -1) - defaultReturn := new(Dataschema) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'schemaId' is set - if &schemaId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'schemaId' when calling ExternalContactsApi->GetExternalcontactsOrganizationsSchemaVersions") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Dataschema - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetExternalcontactsOrganizationsSchemas invokes GET /api/v2/externalcontacts/organizations/schemas -// -// Get a list of schemas. -// -// -func (a ExternalContactsApi) GetExternalcontactsOrganizationsSchemas() (*Dataschemalisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/externalcontacts/organizations/schemas" - defaultReturn := new(Dataschemalisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Dataschemalisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetExternalcontactsRelationship invokes GET /api/v2/externalcontacts/relationships/{relationshipId} -// -// Fetch a relationship -// -// -func (a ExternalContactsApi) GetExternalcontactsRelationship(relationshipId string, expand string) (*Relationship, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/externalcontacts/relationships/{relationshipId}" - path = strings.Replace(path, "{relationshipId}", fmt.Sprintf("%v", relationshipId), -1) - defaultReturn := new(Relationship) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'relationshipId' is set - if &relationshipId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'relationshipId' when calling ExternalContactsApi->GetExternalcontactsRelationship") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(expand).(string); ok { - if str != "" { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Relationship - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetExternalcontactsReversewhitepageslookup invokes GET /api/v2/externalcontacts/reversewhitepageslookup -// -// Look up contacts and externalOrganizations based on an attribute. Maximum of 25 values returned. -// -// -func (a ExternalContactsApi) GetExternalcontactsReversewhitepageslookup(lookupVal string, expand []string) (*Reversewhitepageslookupresult, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/externalcontacts/reversewhitepageslookup" - defaultReturn := new(Reversewhitepageslookupresult) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'lookupVal' is set - if &lookupVal == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'lookupVal' when calling ExternalContactsApi->GetExternalcontactsReversewhitepageslookup") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(lookupVal).(string); ok { - if str != "" { - queryParams["lookupVal"] = a.Configuration.APIClient.ParameterToString(lookupVal, collectionFormat) - } - } else { - queryParams["lookupVal"] = a.Configuration.APIClient.ParameterToString(lookupVal, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Reversewhitepageslookupresult - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetExternalcontactsScanContacts invokes GET /api/v2/externalcontacts/scan/contacts -// -// Scan for external contacts using paging -// -// -func (a ExternalContactsApi) GetExternalcontactsScanContacts(limit int, cursor string) (*Cursorcontactlisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/externalcontacts/scan/contacts" - defaultReturn := new(Cursorcontactlisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(limit).(string); ok { - if str != "" { - queryParams["limit"] = a.Configuration.APIClient.ParameterToString(limit, collectionFormat) - } - } else { - queryParams["limit"] = a.Configuration.APIClient.ParameterToString(limit, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(cursor).(string); ok { - if str != "" { - queryParams["cursor"] = a.Configuration.APIClient.ParameterToString(cursor, collectionFormat) - } - } else { - queryParams["cursor"] = a.Configuration.APIClient.ParameterToString(cursor, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Cursorcontactlisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetExternalcontactsScanNotes invokes GET /api/v2/externalcontacts/scan/notes -// -// Scan for notes using paging -// -// -func (a ExternalContactsApi) GetExternalcontactsScanNotes(limit int, cursor string) (*Cursornotelisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/externalcontacts/scan/notes" - defaultReturn := new(Cursornotelisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(limit).(string); ok { - if str != "" { - queryParams["limit"] = a.Configuration.APIClient.ParameterToString(limit, collectionFormat) - } - } else { - queryParams["limit"] = a.Configuration.APIClient.ParameterToString(limit, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(cursor).(string); ok { - if str != "" { - queryParams["cursor"] = a.Configuration.APIClient.ParameterToString(cursor, collectionFormat) - } - } else { - queryParams["cursor"] = a.Configuration.APIClient.ParameterToString(cursor, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Cursornotelisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetExternalcontactsScanOrganizations invokes GET /api/v2/externalcontacts/scan/organizations -// -// Scan for external organizations using paging -// -// -func (a ExternalContactsApi) GetExternalcontactsScanOrganizations(limit int, cursor string) (*Cursororganizationlisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/externalcontacts/scan/organizations" - defaultReturn := new(Cursororganizationlisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(limit).(string); ok { - if str != "" { - queryParams["limit"] = a.Configuration.APIClient.ParameterToString(limit, collectionFormat) - } - } else { - queryParams["limit"] = a.Configuration.APIClient.ParameterToString(limit, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(cursor).(string); ok { - if str != "" { - queryParams["cursor"] = a.Configuration.APIClient.ParameterToString(cursor, collectionFormat) - } - } else { - queryParams["cursor"] = a.Configuration.APIClient.ParameterToString(cursor, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Cursororganizationlisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetExternalcontactsScanRelationships invokes GET /api/v2/externalcontacts/scan/relationships -// -// Scan for relationships -// -// -func (a ExternalContactsApi) GetExternalcontactsScanRelationships(limit int, cursor string) (*Cursorrelationshiplisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/externalcontacts/scan/relationships" - defaultReturn := new(Cursorrelationshiplisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(limit).(string); ok { - if str != "" { - queryParams["limit"] = a.Configuration.APIClient.ParameterToString(limit, collectionFormat) - } - } else { - queryParams["limit"] = a.Configuration.APIClient.ParameterToString(limit, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(cursor).(string); ok { - if str != "" { - queryParams["cursor"] = a.Configuration.APIClient.ParameterToString(cursor, collectionFormat) - } - } else { - queryParams["cursor"] = a.Configuration.APIClient.ParameterToString(cursor, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Cursorrelationshiplisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostExternalcontactsContactNotes invokes POST /api/v2/externalcontacts/contacts/{contactId}/notes -// -// Create a note for an external contact -// -// -func (a ExternalContactsApi) PostExternalcontactsContactNotes(contactId string, body Note) (*Note, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/externalcontacts/contacts/{contactId}/notes" - path = strings.Replace(path, "{contactId}", fmt.Sprintf("%v", contactId), -1) - defaultReturn := new(Note) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'contactId' is set - if &contactId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'contactId' when calling ExternalContactsApi->PostExternalcontactsContactNotes") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ExternalContactsApi->PostExternalcontactsContactNotes") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Note - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostExternalcontactsContacts invokes POST /api/v2/externalcontacts/contacts -// -// Create an external contact -// -// -func (a ExternalContactsApi) PostExternalcontactsContacts(body Externalcontact) (*Externalcontact, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/externalcontacts/contacts" - defaultReturn := new(Externalcontact) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ExternalContactsApi->PostExternalcontactsContacts") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Externalcontact - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostExternalcontactsContactsSchemas invokes POST /api/v2/externalcontacts/contacts/schemas -// -// Create a schema -// -// -func (a ExternalContactsApi) PostExternalcontactsContactsSchemas(body Dataschema) (*Dataschema, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/externalcontacts/contacts/schemas" - defaultReturn := new(Dataschema) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ExternalContactsApi->PostExternalcontactsContactsSchemas") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Dataschema - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostExternalcontactsOrganizationNotes invokes POST /api/v2/externalcontacts/organizations/{externalOrganizationId}/notes -// -// Create a note for an external organization -// -// -func (a ExternalContactsApi) PostExternalcontactsOrganizationNotes(externalOrganizationId string, body Note) (*Note, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/externalcontacts/organizations/{externalOrganizationId}/notes" - path = strings.Replace(path, "{externalOrganizationId}", fmt.Sprintf("%v", externalOrganizationId), -1) - defaultReturn := new(Note) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'externalOrganizationId' is set - if &externalOrganizationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'externalOrganizationId' when calling ExternalContactsApi->PostExternalcontactsOrganizationNotes") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ExternalContactsApi->PostExternalcontactsOrganizationNotes") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Note - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostExternalcontactsOrganizations invokes POST /api/v2/externalcontacts/organizations -// -// Create an external organization -// -// -func (a ExternalContactsApi) PostExternalcontactsOrganizations(body Externalorganization) (*Externalorganization, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/externalcontacts/organizations" - defaultReturn := new(Externalorganization) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ExternalContactsApi->PostExternalcontactsOrganizations") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Externalorganization - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostExternalcontactsOrganizationsSchemas invokes POST /api/v2/externalcontacts/organizations/schemas -// -// Create a schema -// -// -func (a ExternalContactsApi) PostExternalcontactsOrganizationsSchemas(body Dataschema) (*Dataschema, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/externalcontacts/organizations/schemas" - defaultReturn := new(Dataschema) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ExternalContactsApi->PostExternalcontactsOrganizationsSchemas") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Dataschema - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostExternalcontactsRelationships invokes POST /api/v2/externalcontacts/relationships -// -// Create a relationship -// -// -func (a ExternalContactsApi) PostExternalcontactsRelationships(body Relationship) (*Relationship, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/externalcontacts/relationships" - defaultReturn := new(Relationship) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ExternalContactsApi->PostExternalcontactsRelationships") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Relationship - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutExternalcontactsContact invokes PUT /api/v2/externalcontacts/contacts/{contactId} -// -// Update an external contact -// -// -func (a ExternalContactsApi) PutExternalcontactsContact(contactId string, body Externalcontact) (*Externalcontact, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/externalcontacts/contacts/{contactId}" - path = strings.Replace(path, "{contactId}", fmt.Sprintf("%v", contactId), -1) - defaultReturn := new(Externalcontact) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'contactId' is set - if &contactId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'contactId' when calling ExternalContactsApi->PutExternalcontactsContact") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ExternalContactsApi->PutExternalcontactsContact") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Externalcontact - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutExternalcontactsContactNote invokes PUT /api/v2/externalcontacts/contacts/{contactId}/notes/{noteId} -// -// Update a note for an external contact -// -// -func (a ExternalContactsApi) PutExternalcontactsContactNote(contactId string, noteId string, body Note) (*Note, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/externalcontacts/contacts/{contactId}/notes/{noteId}" - path = strings.Replace(path, "{contactId}", fmt.Sprintf("%v", contactId), -1) - path = strings.Replace(path, "{noteId}", fmt.Sprintf("%v", noteId), -1) - defaultReturn := new(Note) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'contactId' is set - if &contactId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'contactId' when calling ExternalContactsApi->PutExternalcontactsContactNote") - } - // verify the required parameter 'noteId' is set - if ¬eId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'noteId' when calling ExternalContactsApi->PutExternalcontactsContactNote") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ExternalContactsApi->PutExternalcontactsContactNote") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Note - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutExternalcontactsContactsSchema invokes PUT /api/v2/externalcontacts/contacts/schemas/{schemaId} -// -// Update a schema -// -// -func (a ExternalContactsApi) PutExternalcontactsContactsSchema(schemaId string, body Dataschema) (*Dataschema, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/externalcontacts/contacts/schemas/{schemaId}" - path = strings.Replace(path, "{schemaId}", fmt.Sprintf("%v", schemaId), -1) - defaultReturn := new(Dataschema) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'schemaId' is set - if &schemaId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'schemaId' when calling ExternalContactsApi->PutExternalcontactsContactsSchema") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ExternalContactsApi->PutExternalcontactsContactsSchema") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Dataschema - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutExternalcontactsConversation invokes PUT /api/v2/externalcontacts/conversations/{conversationId} -// -// Associate/disassociate an external contact with a conversation -// -// To associate, supply a value for the externalContactId. To disassociate, do not include the property at all. -func (a ExternalContactsApi) PutExternalcontactsConversation(body Conversationassociation, conversationId string) (*APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/externalcontacts/conversations/{conversationId}" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return nil, errors.New("Missing required parameter 'body' when calling ExternalContactsApi->PutExternalcontactsConversation") - } - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return nil, errors.New("Missing required parameter 'conversationId' when calling ExternalContactsApi->PutExternalcontactsConversation") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// PutExternalcontactsOrganization invokes PUT /api/v2/externalcontacts/organizations/{externalOrganizationId} -// -// Update an external organization -// -// -func (a ExternalContactsApi) PutExternalcontactsOrganization(externalOrganizationId string, body Externalorganization) (*Externalorganization, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/externalcontacts/organizations/{externalOrganizationId}" - path = strings.Replace(path, "{externalOrganizationId}", fmt.Sprintf("%v", externalOrganizationId), -1) - defaultReturn := new(Externalorganization) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'externalOrganizationId' is set - if &externalOrganizationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'externalOrganizationId' when calling ExternalContactsApi->PutExternalcontactsOrganization") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ExternalContactsApi->PutExternalcontactsOrganization") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Externalorganization - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutExternalcontactsOrganizationNote invokes PUT /api/v2/externalcontacts/organizations/{externalOrganizationId}/notes/{noteId} -// -// Update a note for an external organization -// -// -func (a ExternalContactsApi) PutExternalcontactsOrganizationNote(externalOrganizationId string, noteId string, body Note) (*Note, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/externalcontacts/organizations/{externalOrganizationId}/notes/{noteId}" - path = strings.Replace(path, "{externalOrganizationId}", fmt.Sprintf("%v", externalOrganizationId), -1) - path = strings.Replace(path, "{noteId}", fmt.Sprintf("%v", noteId), -1) - defaultReturn := new(Note) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'externalOrganizationId' is set - if &externalOrganizationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'externalOrganizationId' when calling ExternalContactsApi->PutExternalcontactsOrganizationNote") - } - // verify the required parameter 'noteId' is set - if ¬eId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'noteId' when calling ExternalContactsApi->PutExternalcontactsOrganizationNote") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ExternalContactsApi->PutExternalcontactsOrganizationNote") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Note - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutExternalcontactsOrganizationTrustorTrustorId invokes PUT /api/v2/externalcontacts/organizations/{externalOrganizationId}/trustor/{trustorId} -// -// Links a Trustor with an External Organization -// -// -func (a ExternalContactsApi) PutExternalcontactsOrganizationTrustorTrustorId(externalOrganizationId string, trustorId string) (*Externalorganizationtrustorlink, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/externalcontacts/organizations/{externalOrganizationId}/trustor/{trustorId}" - path = strings.Replace(path, "{externalOrganizationId}", fmt.Sprintf("%v", externalOrganizationId), -1) - path = strings.Replace(path, "{trustorId}", fmt.Sprintf("%v", trustorId), -1) - defaultReturn := new(Externalorganizationtrustorlink) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'externalOrganizationId' is set - if &externalOrganizationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'externalOrganizationId' when calling ExternalContactsApi->PutExternalcontactsOrganizationTrustorTrustorId") - } - // verify the required parameter 'trustorId' is set - if &trustorId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'trustorId' when calling ExternalContactsApi->PutExternalcontactsOrganizationTrustorTrustorId") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Externalorganizationtrustorlink - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutExternalcontactsOrganizationsSchema invokes PUT /api/v2/externalcontacts/organizations/schemas/{schemaId} -// -// Update a schema -// -// -func (a ExternalContactsApi) PutExternalcontactsOrganizationsSchema(schemaId string, body Dataschema) (*Dataschema, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/externalcontacts/organizations/schemas/{schemaId}" - path = strings.Replace(path, "{schemaId}", fmt.Sprintf("%v", schemaId), -1) - defaultReturn := new(Dataschema) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'schemaId' is set - if &schemaId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'schemaId' when calling ExternalContactsApi->PutExternalcontactsOrganizationsSchema") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ExternalContactsApi->PutExternalcontactsOrganizationsSchema") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Dataschema - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutExternalcontactsRelationship invokes PUT /api/v2/externalcontacts/relationships/{relationshipId} -// -// Update a relationship -// -// -func (a ExternalContactsApi) PutExternalcontactsRelationship(relationshipId string, body Relationship) (*Relationship, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/externalcontacts/relationships/{relationshipId}" - path = strings.Replace(path, "{relationshipId}", fmt.Sprintf("%v", relationshipId), -1) - defaultReturn := new(Relationship) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'relationshipId' is set - if &relationshipId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'relationshipId' when calling ExternalContactsApi->PutExternalcontactsRelationship") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ExternalContactsApi->PutExternalcontactsRelationship") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Relationship - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/externaldatasource.go b/build/platformclientv2/externaldatasource.go deleted file mode 100644 index fe5c9e555..000000000 --- a/build/platformclientv2/externaldatasource.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Externaldatasource - Describes a link to a record in an external system that contributed data to a Relate record -type Externaldatasource struct { - // Platform - The platform that was the source of the data. Example: a CRM like SALESFORCE. - Platform *string `json:"platform,omitempty"` - - - // Url - An URL that links to the source record that contributed data to the associated entity. - Url *string `json:"url,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Externaldatasource) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/externalorganization.go b/build/platformclientv2/externalorganization.go deleted file mode 100644 index 4bd2b9e6c..000000000 --- a/build/platformclientv2/externalorganization.go +++ /dev/null @@ -1,102 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Externalorganization -type Externalorganization struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the company. - Name *string `json:"name,omitempty"` - - - // CompanyType - CompanyType *string `json:"companyType,omitempty"` - - - // Industry - Industry *string `json:"industry,omitempty"` - - - // PrimaryContactId - PrimaryContactId *string `json:"primaryContactId,omitempty"` - - - // Address - Address *Contactaddress `json:"address,omitempty"` - - - // PhoneNumber - PhoneNumber *Phonenumber `json:"phoneNumber,omitempty"` - - - // FaxNumber - FaxNumber *Phonenumber `json:"faxNumber,omitempty"` - - - // EmployeeCount - EmployeeCount *int `json:"employeeCount,omitempty"` - - - // Revenue - Revenue *int `json:"revenue,omitempty"` - - - // Tags - Tags *[]string `json:"tags,omitempty"` - - - // Websites - Websites *[]string `json:"websites,omitempty"` - - - // Tickers - Tickers *[]Ticker `json:"tickers,omitempty"` - - - // TwitterId - TwitterId *Twitterid `json:"twitterId,omitempty"` - - - // ExternalSystemUrl - A string that identifies an external system-of-record resource that may have more detailed information on the organization. It should be a valid URL (including the http/https protocol, port, and path [if any]). The value is automatically trimmed of any leading and trailing whitespace. - ExternalSystemUrl *string `json:"externalSystemUrl,omitempty"` - - - // ModifyDate - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ModifyDate *time.Time `json:"modifyDate,omitempty"` - - - // CreateDate - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - CreateDate *time.Time `json:"createDate,omitempty"` - - - // Trustor - Trustor *Trustor `json:"trustor,omitempty"` - - - // Schema - The schema defining custom fields for this contact - Schema *Dataschema `json:"schema,omitempty"` - - - // CustomFields - Custom fields defined in the schema referenced by schemaId and schemaVersion. - CustomFields *map[string]interface{} `json:"customFields,omitempty"` - - - // ExternalDataSources - Links to the sources of data (e.g. one source might be a CRM) that contributed data to this record. Read-only, and only populated when requested via expand param. - ExternalDataSources *[]Externaldatasource `json:"externalDataSources,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Externalorganization) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/externalorganizationlisting.go b/build/platformclientv2/externalorganizationlisting.go deleted file mode 100644 index 5dd15836c..000000000 --- a/build/platformclientv2/externalorganizationlisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Externalorganizationlisting -type Externalorganizationlisting struct { - // Entities - Entities *[]Externalorganization `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Externalorganizationlisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/externalorganizationtrustorlink.go b/build/platformclientv2/externalorganizationtrustorlink.go deleted file mode 100644 index 22471e629..000000000 --- a/build/platformclientv2/externalorganizationtrustorlink.go +++ /dev/null @@ -1,30 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Externalorganizationtrustorlink -type Externalorganizationtrustorlink struct { - // ExternalOrganizationId - The id of a PureCloud External Organization entity in the External Contacts system that will be used to represent the trustor org - ExternalOrganizationId *string `json:"externalOrganizationId,omitempty"` - - - // TrustorOrgId - The id of a PureCloud organization that has granted trust to this PureCloud organization - TrustorOrgId *string `json:"trustorOrgId,omitempty"` - - - // DateCreated - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // ExternalOrganizationUri - The URI for the External Organization that is linked to the trustor org - ExternalOrganizationUri *string `json:"externalOrganizationUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Externalorganizationtrustorlink) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/facebookappcredentials.go b/build/platformclientv2/facebookappcredentials.go deleted file mode 100644 index b617ef9aa..000000000 --- a/build/platformclientv2/facebookappcredentials.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Facebookappcredentials -type Facebookappcredentials struct { - // Id - Genesys Cloud Facebook App Id - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Facebookappcredentials) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/facebookid.go b/build/platformclientv2/facebookid.go deleted file mode 100644 index b9a768433..000000000 --- a/build/platformclientv2/facebookid.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Facebookid - User information for a Facebook user interacting with a page or app -type Facebookid struct { - // Ids - The set of scopedIds that this person has. Each scopedId is specific to a page or app that the user interacts with. - Ids *[]Facebookscopedid `json:"ids,omitempty"` - - - // DisplayName - The displayName of this person's Facebook account. Roughly translates to user.first_name + ' ' + user.last_name in the Facebook API. - DisplayName *string `json:"displayName,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Facebookid) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/facebookintegration.go b/build/platformclientv2/facebookintegration.go deleted file mode 100644 index 770afe174..000000000 --- a/build/platformclientv2/facebookintegration.go +++ /dev/null @@ -1,70 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Facebookintegration -type Facebookintegration struct { - // Id - A unique Integration Id. - Id *string `json:"id,omitempty"` - - - // Name - The name of the Facebook Integration - Name *string `json:"name,omitempty"` - - - // AppId - The App Id from Facebook messenger - AppId *string `json:"appId,omitempty"` - - - // PageId - The Page Id from Facebook messenger - PageId *string `json:"pageId,omitempty"` - - - // Status - The status of the Facebook Integration - Status *string `json:"status,omitempty"` - - - // Recipient - The recipient reference associated to the Facebook Integration. This recipient is used to associate a flow to an integration - Recipient *Domainentityref `json:"recipient,omitempty"` - - - // DateCreated - Date this Integration was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - Date this Integration was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // CreatedBy - User reference that created this Integration - CreatedBy *Domainentityref `json:"createdBy,omitempty"` - - - // ModifiedBy - User reference that last modified this Integration - ModifiedBy *Domainentityref `json:"modifiedBy,omitempty"` - - - // Version - Version number required for updates. - Version *int `json:"version,omitempty"` - - - // CreateStatus - Status of asynchronous create operation - CreateStatus *string `json:"createStatus,omitempty"` - - - // CreateError - Error information returned, if createStatus is set to Error - CreateError *Errorbody `json:"createError,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Facebookintegration) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/facebookintegrationentitylisting.go b/build/platformclientv2/facebookintegrationentitylisting.go deleted file mode 100644 index dc678679c..000000000 --- a/build/platformclientv2/facebookintegrationentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Facebookintegrationentitylisting -type Facebookintegrationentitylisting struct { - // Entities - Entities *[]Facebookintegration `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Facebookintegrationentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/facebookintegrationrequest.go b/build/platformclientv2/facebookintegrationrequest.go deleted file mode 100644 index 7759b2352..000000000 --- a/build/platformclientv2/facebookintegrationrequest.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Facebookintegrationrequest -type Facebookintegrationrequest struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the Facebook Integration - Name *string `json:"name,omitempty"` - - - // PageAccessToken - The long-lived Page Access Token of a facebook page. See https://developers.facebook.com/docs/facebook-login/access-tokens. When a pageAccessToken is provided, pageId and userAccessToken are not required. - PageAccessToken *string `json:"pageAccessToken,omitempty"` - - - // UserAccessToken - The short-lived User Access Token of the facebook user logged into the facebook app. See https://developers.facebook.com/docs/facebook-login/access-tokens. When userAccessToken is provided, pageId is mandatory. When userAccessToken/pageId combination is provided, pageAccessToken is not required. - UserAccessToken *string `json:"userAccessToken,omitempty"` - - - // PageId - The page Id of a facebook page. The pageId is required when userAccessToken is provided. - PageId *string `json:"pageId,omitempty"` - - - // AppId - The app Id of a facebook app. The appId is required when a customer wants to use their own approved facebook app. - AppId *string `json:"appId,omitempty"` - - - // AppSecret - The app Secret of a facebook app. The appSecret is required when appId is provided. - AppSecret *string `json:"appSecret,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Facebookintegrationrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/facebookintegrationupdaterequest.go b/build/platformclientv2/facebookintegrationupdaterequest.go deleted file mode 100644 index 7cb757a29..000000000 --- a/build/platformclientv2/facebookintegrationupdaterequest.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Facebookintegrationupdaterequest -type Facebookintegrationupdaterequest struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the Facebook Integration - Name *string `json:"name,omitempty"` - - - // PageAccessToken - The long-lived Page Access Token of a facebook page. See https://developers.facebook.com/docs/facebook-login/access-tokens. Either pageAccessToken or userAccessToken should be provided. - PageAccessToken *string `json:"pageAccessToken,omitempty"` - - - // UserAccessToken - The short-lived User Access Token of the facebook user logged into the facebook app. See https://developers.facebook.com/docs/facebook-login/access-tokens. Either pageAccessToken or userAccessToken should be provided. - UserAccessToken *string `json:"userAccessToken,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Facebookintegrationupdaterequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/facebookscopedid.go b/build/platformclientv2/facebookscopedid.go deleted file mode 100644 index 9bc624ccd..000000000 --- a/build/platformclientv2/facebookscopedid.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Facebookscopedid - Scoped ID for a Facebook user interacting with a page or app -type Facebookscopedid struct { - // ScopedId - The unique page/app-specific scopedId for the user - ScopedId *string `json:"scopedId,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Facebookscopedid) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/facet.go b/build/platformclientv2/facet.go deleted file mode 100644 index feae9f078..000000000 --- a/build/platformclientv2/facet.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Facet -type Facet struct { - // Name - The name of the field on which to facet. - Name *string `json:"name,omitempty"` - - - // VarType - The type of the facet, DATE or STRING. - VarType *string `json:"type,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Facet) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/facetentry.go b/build/platformclientv2/facetentry.go deleted file mode 100644 index 249f3e0a8..000000000 --- a/build/platformclientv2/facetentry.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Facetentry -type Facetentry struct { - // Attribute - Attribute *Termattribute `json:"attribute,omitempty"` - - - // Statistics - Statistics *Facetstatistics `json:"statistics,omitempty"` - - - // Other - Other *int `json:"other,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // Missing - Missing *int `json:"missing,omitempty"` - - - // TermCount - TermCount *int `json:"termCount,omitempty"` - - - // TermType - TermType *string `json:"termType,omitempty"` - - - // Terms - Terms *[]Facetterm `json:"terms,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Facetentry) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/facetinfo.go b/build/platformclientv2/facetinfo.go deleted file mode 100644 index 1ca76be70..000000000 --- a/build/platformclientv2/facetinfo.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Facetinfo -type Facetinfo struct { - // Name - The name of the field that was faceted on. - Name *string `json:"name,omitempty"` - - - // Entries - The entries resulting from this facet. - Entries *[]Entry `json:"entries,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Facetinfo) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/facetkeyattribute.go b/build/platformclientv2/facetkeyattribute.go deleted file mode 100644 index 65a87570b..000000000 --- a/build/platformclientv2/facetkeyattribute.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Facetkeyattribute -type Facetkeyattribute struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Count - Count *int `json:"count,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Facetkeyattribute) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/facetstatistics.go b/build/platformclientv2/facetstatistics.go deleted file mode 100644 index b4a83e251..000000000 --- a/build/platformclientv2/facetstatistics.go +++ /dev/null @@ -1,42 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Facetstatistics -type Facetstatistics struct { - // Count - Count *int `json:"count,omitempty"` - - - // Min - Min *float64 `json:"min,omitempty"` - - - // Max - Max *float64 `json:"max,omitempty"` - - - // Mean - Mean *float64 `json:"mean,omitempty"` - - - // StdDeviation - StdDeviation *float64 `json:"stdDeviation,omitempty"` - - - // DateMin - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateMin *time.Time `json:"dateMin,omitempty"` - - - // DateMax - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateMax *time.Time `json:"dateMax,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Facetstatistics) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/facetterm.go b/build/platformclientv2/facetterm.go deleted file mode 100644 index fa2a69e21..000000000 --- a/build/platformclientv2/facetterm.go +++ /dev/null @@ -1,38 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Facetterm -type Facetterm struct { - // Term - Term *string `json:"term,omitempty"` - - - // Key - Key *int `json:"key,omitempty"` - - - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Count - Count *int `json:"count,omitempty"` - - - // Time - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - Time *time.Time `json:"time,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Facetterm) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/failedobject.go b/build/platformclientv2/failedobject.go deleted file mode 100644 index 80ae9bad3..000000000 --- a/build/platformclientv2/failedobject.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Failedobject -type Failedobject struct { - // Id - Id *string `json:"id,omitempty"` - - - // Version - Version *string `json:"version,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // ErrorCode - ErrorCode *string `json:"errorCode,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Failedobject) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/faxapi.go b/build/platformclientv2/faxapi.go deleted file mode 100644 index 1c841096f..000000000 --- a/build/platformclientv2/faxapi.go +++ /dev/null @@ -1,465 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "encoding/json" -) - -// FaxApi provides functions for API endpoints -type FaxApi struct { - Configuration *Configuration -} - -// NewFaxApi creates an API instance using the default configuration -func NewFaxApi() *FaxApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating FaxApi with base path: %s", strings.ToLower(config.BasePath))) - return &FaxApi{ - Configuration: config, - } -} - -// NewFaxApiWithConfig creates an API instance using the provided configuration -func NewFaxApiWithConfig(config *Configuration) *FaxApi { - config.Debugf("Creating FaxApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &FaxApi{ - Configuration: config, - } -} - -// DeleteFaxDocument invokes DELETE /api/v2/fax/documents/{documentId} -// -// Delete a fax document. -// -// -func (a FaxApi) DeleteFaxDocument(documentId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/fax/documents/{documentId}" - path = strings.Replace(path, "{documentId}", fmt.Sprintf("%v", documentId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'documentId' is set - if &documentId == nil { - // - return nil, errors.New("Missing required parameter 'documentId' when calling FaxApi->DeleteFaxDocument") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// GetFaxDocument invokes GET /api/v2/fax/documents/{documentId} -// -// Get a document. -// -// -func (a FaxApi) GetFaxDocument(documentId string) (*Faxdocument, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/fax/documents/{documentId}" - path = strings.Replace(path, "{documentId}", fmt.Sprintf("%v", documentId), -1) - defaultReturn := new(Faxdocument) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'documentId' is set - if &documentId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'documentId' when calling FaxApi->GetFaxDocument") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Faxdocument - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetFaxDocumentContent invokes GET /api/v2/fax/documents/{documentId}/content -// -// Download a fax document. -// -// -func (a FaxApi) GetFaxDocumentContent(documentId string) (*Downloadresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/fax/documents/{documentId}/content" - path = strings.Replace(path, "{documentId}", fmt.Sprintf("%v", documentId), -1) - defaultReturn := new(Downloadresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'documentId' is set - if &documentId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'documentId' when calling FaxApi->GetFaxDocumentContent") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Downloadresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetFaxDocuments invokes GET /api/v2/fax/documents -// -// Get a list of fax documents. -// -// -func (a FaxApi) GetFaxDocuments(pageSize int, pageNumber int) (*Faxdocumententitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/fax/documents" - defaultReturn := new(Faxdocumententitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Faxdocumententitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetFaxSummary invokes GET /api/v2/fax/summary -// -// Get fax summary -// -// -func (a FaxApi) GetFaxSummary() (*Faxsummary, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/fax/summary" - defaultReturn := new(Faxsummary) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Faxsummary - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutFaxDocument invokes PUT /api/v2/fax/documents/{documentId} -// -// Update a fax document. -// -// -func (a FaxApi) PutFaxDocument(documentId string, body Faxdocument) (*Faxdocument, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/fax/documents/{documentId}" - path = strings.Replace(path, "{documentId}", fmt.Sprintf("%v", documentId), -1) - defaultReturn := new(Faxdocument) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'documentId' is set - if &documentId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'documentId' when calling FaxApi->PutFaxDocument") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling FaxApi->PutFaxDocument") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Faxdocument - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/faxdocument.go b/build/platformclientv2/faxdocument.go deleted file mode 100644 index 78df2e44a..000000000 --- a/build/platformclientv2/faxdocument.go +++ /dev/null @@ -1,86 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Faxdocument -type Faxdocument struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // DateCreated - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // ContentUri - ContentUri *string `json:"contentUri,omitempty"` - - - // Workspace - Workspace *Domainentityref `json:"workspace,omitempty"` - - - // CreatedBy - CreatedBy *Domainentityref `json:"createdBy,omitempty"` - - - // ContentType - ContentType *string `json:"contentType,omitempty"` - - - // ContentLength - ContentLength *int `json:"contentLength,omitempty"` - - - // Filename - Filename *string `json:"filename,omitempty"` - - - // Read - Read *bool `json:"read,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - - - // CallerAddress - CallerAddress *string `json:"callerAddress,omitempty"` - - - // ReceiverAddress - ReceiverAddress *string `json:"receiverAddress,omitempty"` - - - // Thumbnails - Thumbnails *[]Documentthumbnail `json:"thumbnails,omitempty"` - - - // SharingUri - SharingUri *string `json:"sharingUri,omitempty"` - - - // DownloadSharingUri - DownloadSharingUri *string `json:"downloadSharingUri,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Faxdocument) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/faxdocumententitylisting.go b/build/platformclientv2/faxdocumententitylisting.go deleted file mode 100644 index 16d87cbc5..000000000 --- a/build/platformclientv2/faxdocumententitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Faxdocumententitylisting -type Faxdocumententitylisting struct { - // Entities - Entities *[]Faxdocument `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Faxdocumententitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/faxsendrequest.go b/build/platformclientv2/faxsendrequest.go deleted file mode 100644 index 38206aa8d..000000000 --- a/build/platformclientv2/faxsendrequest.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Faxsendrequest -type Faxsendrequest struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Addresses - A list of outbound fax dialing addresses. E.g. +13175555555 or 3175555555 - Addresses *[]string `json:"addresses,omitempty"` - - - // DocumentId - DocumentId of Content Management artifact. If Content Management document is not used for faxing, documentId should be null - DocumentId *string `json:"documentId,omitempty"` - - - // ContentType - The content type that is going to be uploaded. If Content Management document is used for faxing, contentType will be ignored - ContentType *string `json:"contentType,omitempty"` - - - // Workspace - Workspace in which the document should be stored. If Content Management document is used for faxing, workspace will be ignored - Workspace *Workspace `json:"workspace,omitempty"` - - - // CoverSheet - Data for coversheet generation. - CoverSheet *Coversheet `json:"coverSheet,omitempty"` - - - // TimeZoneOffsetMinutes - Time zone offset minutes from GMT - TimeZoneOffsetMinutes *int `json:"timeZoneOffsetMinutes,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Faxsendrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/faxsendresponse.go b/build/platformclientv2/faxsendresponse.go deleted file mode 100644 index dbc111833..000000000 --- a/build/platformclientv2/faxsendresponse.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Faxsendresponse -type Faxsendresponse struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // UploadDestinationUri - UploadDestinationUri *string `json:"uploadDestinationUri,omitempty"` - - - // UploadMethodType - UploadMethodType *string `json:"uploadMethodType,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Faxsendresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/faxstatus.go b/build/platformclientv2/faxstatus.go deleted file mode 100644 index 3e53c0ee6..000000000 --- a/build/platformclientv2/faxstatus.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Faxstatus -type Faxstatus struct { - // Direction - The fax direction, either \"send\" or \"receive\". - Direction *string `json:"direction,omitempty"` - - - // ExpectedPages - Total number of expected pages, if known. - ExpectedPages *int `json:"expectedPages,omitempty"` - - - // ActivePage - Active page of the transmission. - ActivePage *int `json:"activePage,omitempty"` - - - // LinesTransmitted - Number of lines that have completed transmission. - LinesTransmitted *int `json:"linesTransmitted,omitempty"` - - - // BytesTransmitted - Number of bytes that have competed transmission. - BytesTransmitted *int `json:"bytesTransmitted,omitempty"` - - - // BaudRate - Current signaling rate of transmission, baud rate. - BaudRate *int `json:"baudRate,omitempty"` - - - // PageErrors - Number of page errors. - PageErrors *int `json:"pageErrors,omitempty"` - - - // LineErrors - Number of line errors. - LineErrors *int `json:"lineErrors,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Faxstatus) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/faxsummary.go b/build/platformclientv2/faxsummary.go deleted file mode 100644 index b7a52339d..000000000 --- a/build/platformclientv2/faxsummary.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Faxsummary -type Faxsummary struct { - // ReadCount - ReadCount *int `json:"readCount,omitempty"` - - - // UnreadCount - UnreadCount *int `json:"unreadCount,omitempty"` - - - // TotalCount - TotalCount *int `json:"totalCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Faxsummary) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/faxtopicfaxdatav2.go b/build/platformclientv2/faxtopicfaxdatav2.go deleted file mode 100644 index ef19b8520..000000000 --- a/build/platformclientv2/faxtopicfaxdatav2.go +++ /dev/null @@ -1,82 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Faxtopicfaxdatav2 -type Faxtopicfaxdatav2 struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // DateCreated - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - DateModified *time.Time `json:"dateModified,omitempty"` - - - // Workspace - Workspace *Faxtopicworkspacedata `json:"workspace,omitempty"` - - - // CreatedBy - CreatedBy *Faxtopicuserdata `json:"createdBy,omitempty"` - - - // ContentType - ContentType *string `json:"contentType,omitempty"` - - - // ContentLength - ContentLength *int `json:"contentLength,omitempty"` - - - // Filename - Filename *string `json:"filename,omitempty"` - - - // ChangeNumber - ChangeNumber *int `json:"changeNumber,omitempty"` - - - // DateUploaded - DateUploaded *time.Time `json:"dateUploaded,omitempty"` - - - // UploadedBy - UploadedBy *Faxtopicuserdata `json:"uploadedBy,omitempty"` - - - // LockInfo - LockInfo *Faxtopiclockdata `json:"lockInfo,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // CallerAddress - CallerAddress *string `json:"callerAddress,omitempty"` - - - // ReceiverAddress - ReceiverAddress *string `json:"receiverAddress,omitempty"` - - - // Read - Read *bool `json:"read,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Faxtopicfaxdatav2) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/faxtopiclockdata.go b/build/platformclientv2/faxtopiclockdata.go deleted file mode 100644 index 3393ba150..000000000 --- a/build/platformclientv2/faxtopiclockdata.go +++ /dev/null @@ -1,26 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Faxtopiclockdata -type Faxtopiclockdata struct { - // LockedBy - LockedBy *Faxtopicuserdata `json:"lockedBy,omitempty"` - - - // DateCreated - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateExpires - DateExpires *time.Time `json:"dateExpires,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Faxtopiclockdata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/faxtopicuserdata.go b/build/platformclientv2/faxtopicuserdata.go deleted file mode 100644 index 2af74a3d5..000000000 --- a/build/platformclientv2/faxtopicuserdata.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Faxtopicuserdata -type Faxtopicuserdata struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Faxtopicuserdata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/faxtopicworkspacedata.go b/build/platformclientv2/faxtopicworkspacedata.go deleted file mode 100644 index c33289127..000000000 --- a/build/platformclientv2/faxtopicworkspacedata.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Faxtopicworkspacedata -type Faxtopicworkspacedata struct { - // Id - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Faxtopicworkspacedata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/featurestate.go b/build/platformclientv2/featurestate.go deleted file mode 100644 index 749e60299..000000000 --- a/build/platformclientv2/featurestate.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Featurestate -type Featurestate struct { - // Enabled - Enabled *bool `json:"enabled,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Featurestate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/fieldconfig.go b/build/platformclientv2/fieldconfig.go deleted file mode 100644 index ca9863d5e..000000000 --- a/build/platformclientv2/fieldconfig.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Fieldconfig -type Fieldconfig struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // EntityType - EntityType *string `json:"entityType,omitempty"` - - - // State - State *string `json:"state,omitempty"` - - - // Sections - Sections *[]Section `json:"sections,omitempty"` - - - // Version - Version *string `json:"version,omitempty"` - - - // SchemaVersion - SchemaVersion *string `json:"schemaVersion,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Fieldconfig) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/fieldconfigs.go b/build/platformclientv2/fieldconfigs.go deleted file mode 100644 index 3761868e9..000000000 --- a/build/platformclientv2/fieldconfigs.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Fieldconfigs -type Fieldconfigs struct { - // Org - Org *Fieldconfig `json:"org,omitempty"` - - - // Person - Person *Fieldconfig `json:"person,omitempty"` - - - // Group - Group *Fieldconfig `json:"group,omitempty"` - - - // ExternalContact - ExternalContact *Fieldconfig `json:"externalContact,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Fieldconfigs) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/fieldlist.go b/build/platformclientv2/fieldlist.go deleted file mode 100644 index 359b9fbad..000000000 --- a/build/platformclientv2/fieldlist.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Fieldlist -type Fieldlist struct { - // CustomLabels - CustomLabels *bool `json:"customLabels,omitempty"` - - - // InstructionText - InstructionText *string `json:"instructionText,omitempty"` - - - // Key - Key *string `json:"key,omitempty"` - - - // LabelKeys - LabelKeys *[]string `json:"labelKeys,omitempty"` - - - // Params - Params *map[string]interface{} `json:"params,omitempty"` - - - // Repeatable - Repeatable *bool `json:"repeatable,omitempty"` - - - // State - State *string `json:"state,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - - - // Required - Required *bool `json:"required,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Fieldlist) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/filter.go b/build/platformclientv2/filter.go deleted file mode 100644 index 3f469af7c..000000000 --- a/build/platformclientv2/filter.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Filter -type Filter struct { - // Name - The name of the field by which to filter. - Name *string `json:"name,omitempty"` - - - // VarType - The type of the filter, DATE or STRING. - VarType *string `json:"type,omitempty"` - - - // Operator - The operation that the filter performs. - Operator *string `json:"operator,omitempty"` - - - // Values - The values to make the filter comparison against. - Values *[]string `json:"values,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Filter) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/filterpreviewresponse.go b/build/platformclientv2/filterpreviewresponse.go deleted file mode 100644 index 72191d445..000000000 --- a/build/platformclientv2/filterpreviewresponse.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Filterpreviewresponse -type Filterpreviewresponse struct { - // FilteredContacts - FilteredContacts *int `json:"filteredContacts,omitempty"` - - - // TotalContacts - TotalContacts *int `json:"totalContacts,omitempty"` - - - // Preview - Preview *[]Dialercontact `json:"preview,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Filterpreviewresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/flow.go b/build/platformclientv2/flow.go deleted file mode 100644 index 0040cf1b9..000000000 --- a/build/platformclientv2/flow.go +++ /dev/null @@ -1,97 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Flow -type Flow struct { - // Id - The flow identifier - Id *string `json:"id,omitempty"` - - - // Name - The flow name - Name *string `json:"name,omitempty"` - - - // Division - The division to which this entity belongs. - Division *Writabledivision `json:"division,omitempty"` - - - // Description - Description *string `json:"description,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - - - // LockedUser - User that has the flow locked. - LockedUser *User `json:"lockedUser,omitempty"` - - - // LockedClient - OAuth client that has the flow locked. - LockedClient *Domainentityref `json:"lockedClient,omitempty"` - - - // Active - Active *bool `json:"active,omitempty"` - - - // System - System *bool `json:"system,omitempty"` - - - // Deleted - Deleted *bool `json:"deleted,omitempty"` - - - // PublishedVersion - PublishedVersion *Flowversion `json:"publishedVersion,omitempty"` - - - // SavedVersion - SavedVersion *Flowversion `json:"savedVersion,omitempty"` - - - // InputSchema - json schema describing the inputs for the flow - InputSchema *map[string]interface{} `json:"inputSchema,omitempty"` - - - // OutputSchema - json schema describing the outputs for the flow - OutputSchema *map[string]interface{} `json:"outputSchema,omitempty"` - - - // CheckedInVersion - CheckedInVersion *Flowversion `json:"checkedInVersion,omitempty"` - - - // DebugVersion - DebugVersion *Flowversion `json:"debugVersion,omitempty"` - - - // PublishedBy - PublishedBy *User `json:"publishedBy,omitempty"` - - - // CurrentOperation - CurrentOperation *Operation `json:"currentOperation,omitempty"` - - - // NluInfo - Information about the natural language understanding configuration for the published version of the flow - NluInfo *Nluinfo `json:"nluInfo,omitempty"` - - - // SupportedLanguages - List of supported languages for the published version of the flow. - SupportedLanguages *[]Supportedlanguage `json:"supportedLanguages,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Flow) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/flowaggregatedatacontainer.go b/build/platformclientv2/flowaggregatedatacontainer.go deleted file mode 100644 index 24266a858..000000000 --- a/build/platformclientv2/flowaggregatedatacontainer.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Flowaggregatedatacontainer -type Flowaggregatedatacontainer struct { - // Group - A mapping from dimension to value - Group *map[string]string `json:"group,omitempty"` - - - // Data - Data *[]Statisticalresponse `json:"data,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Flowaggregatedatacontainer) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/flowaggregatequeryclause.go b/build/platformclientv2/flowaggregatequeryclause.go deleted file mode 100644 index 4e3058661..000000000 --- a/build/platformclientv2/flowaggregatequeryclause.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Flowaggregatequeryclause -type Flowaggregatequeryclause struct { - // VarType - Boolean operation to apply to the provided predicates - VarType *string `json:"type,omitempty"` - - - // Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value). - Predicates *[]Flowaggregatequerypredicate `json:"predicates,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Flowaggregatequeryclause) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/flowaggregatequeryfilter.go b/build/platformclientv2/flowaggregatequeryfilter.go deleted file mode 100644 index cd356d614..000000000 --- a/build/platformclientv2/flowaggregatequeryfilter.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Flowaggregatequeryfilter -type Flowaggregatequeryfilter struct { - // VarType - Boolean operation to apply to the provided predicates and clauses - VarType *string `json:"type,omitempty"` - - - // Clauses - Boolean 'and/or' logic with up to two-levels of nesting - Clauses *[]Flowaggregatequeryclause `json:"clauses,omitempty"` - - - // Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value). - Predicates *[]Flowaggregatequerypredicate `json:"predicates,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Flowaggregatequeryfilter) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/flowaggregatequerypredicate.go b/build/platformclientv2/flowaggregatequerypredicate.go deleted file mode 100644 index 041ca3776..000000000 --- a/build/platformclientv2/flowaggregatequerypredicate.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Flowaggregatequerypredicate -type Flowaggregatequerypredicate struct { - // VarType - Optional type, can usually be inferred - VarType *string `json:"type,omitempty"` - - - // Dimension - Left hand side for dimension predicates - Dimension *string `json:"dimension,omitempty"` - - - // Operator - Optional operator, default is matches - Operator *string `json:"operator,omitempty"` - - - // Value - Right hand side for dimension predicates - Value *string `json:"value,omitempty"` - - - // VarRange - Right hand side for dimension predicates - VarRange *Numericrange `json:"range,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Flowaggregatequerypredicate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/flowaggregatequeryresponse.go b/build/platformclientv2/flowaggregatequeryresponse.go deleted file mode 100644 index c293c84e2..000000000 --- a/build/platformclientv2/flowaggregatequeryresponse.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Flowaggregatequeryresponse -type Flowaggregatequeryresponse struct { - // Results - Results *[]Flowaggregatedatacontainer `json:"results,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Flowaggregatequeryresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/flowaggregationquery.go b/build/platformclientv2/flowaggregationquery.go deleted file mode 100644 index 0f34d3ab8..000000000 --- a/build/platformclientv2/flowaggregationquery.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Flowaggregationquery -type Flowaggregationquery struct { - // Interval - Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss - Interval *string `json:"interval,omitempty"` - - - // Granularity - Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H - Granularity *string `json:"granularity,omitempty"` - - - // TimeZone - Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London - TimeZone *string `json:"timeZone,omitempty"` - - - // GroupBy - Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group. - GroupBy *[]string `json:"groupBy,omitempty"` - - - // Filter - Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters - Filter *Flowaggregatequeryfilter `json:"filter,omitempty"` - - - // Metrics - Behaves like a SQL SELECT clause. Only named metrics will be retrieved. - Metrics *[]string `json:"metrics,omitempty"` - - - // FlattenMultivaluedDimensions - Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c') - FlattenMultivaluedDimensions *bool `json:"flattenMultivaluedDimensions,omitempty"` - - - // Views - Custom derived metric views - Views *[]Flowaggregationview `json:"views,omitempty"` - - - // AlternateTimeDimension - Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event. - AlternateTimeDimension *string `json:"alternateTimeDimension,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Flowaggregationquery) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/flowaggregationview.go b/build/platformclientv2/flowaggregationview.go deleted file mode 100644 index 018a4db0a..000000000 --- a/build/platformclientv2/flowaggregationview.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Flowaggregationview -type Flowaggregationview struct { - // Target - Target metric name - Target *string `json:"target,omitempty"` - - - // Name - A unique name for this view. Must be distinct from other views and built-in metric names. - Name *string `json:"name,omitempty"` - - - // Function - Type of view you wish to create - Function *string `json:"function,omitempty"` - - - // VarRange - Range of numbers for slicing up data - VarRange *Aggregationrange `json:"range,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Flowaggregationview) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/flowdiagnosticinfo.go b/build/platformclientv2/flowdiagnosticinfo.go deleted file mode 100644 index 34c0555ec..000000000 --- a/build/platformclientv2/flowdiagnosticinfo.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Flowdiagnosticinfo -type Flowdiagnosticinfo struct { - // LastActionId - The step number of the survey invite flow where the error occurred. - LastActionId *int `json:"lastActionId,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Flowdiagnosticinfo) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/flowdivisionview.go b/build/platformclientv2/flowdivisionview.go deleted file mode 100644 index c129d5f53..000000000 --- a/build/platformclientv2/flowdivisionview.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Flowdivisionview -type Flowdivisionview struct { - // Id - The flow identifier - Id *string `json:"id,omitempty"` - - - // Name - The flow name - Name *string `json:"name,omitempty"` - - - // Division - The division to which this entity belongs. - Division *Writabledivision `json:"division,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - - - // InputSchema - json schema describing the inputs for the flow - InputSchema *Jsonschemadocument `json:"inputSchema,omitempty"` - - - // OutputSchema - json schema describing the outputs for the flow - OutputSchema *Jsonschemadocument `json:"outputSchema,omitempty"` - - - // PublishedVersion - published version information if there is a published version - PublishedVersion *Flowversion `json:"publishedVersion,omitempty"` - - - // DebugVersion - debug version information if there is a debug version - DebugVersion *Flowversion `json:"debugVersion,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Flowdivisionview) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/flowdivisionviewentitylisting.go b/build/platformclientv2/flowdivisionviewentitylisting.go deleted file mode 100644 index 587c8ba02..000000000 --- a/build/platformclientv2/flowdivisionviewentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Flowdivisionviewentitylisting -type Flowdivisionviewentitylisting struct { - // Entities - Entities *[]Flowdivisionview `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Flowdivisionviewentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/flowentitylisting.go b/build/platformclientv2/flowentitylisting.go deleted file mode 100644 index 86d92fc17..000000000 --- a/build/platformclientv2/flowentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Flowentitylisting -type Flowentitylisting struct { - // Entities - Entities *[]Flow `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Flowentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/flowexecutionlaunchrequest.go b/build/platformclientv2/flowexecutionlaunchrequest.go deleted file mode 100644 index 07495d71b..000000000 --- a/build/platformclientv2/flowexecutionlaunchrequest.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Flowexecutionlaunchrequest - Parameters for launching a flow. -type Flowexecutionlaunchrequest struct { - // FlowId - ID of the flow to launch. - FlowId *string `json:"flowId,omitempty"` - - - // FlowVersion - The version of the flow to launch. Omit this value (or supply null/empty) to use the latest published version. - FlowVersion *string `json:"flowVersion,omitempty"` - - - // InputData - Input values to the flow. Valid values are defined by a flow's input JSON schema. - InputData *map[string]interface{} `json:"inputData,omitempty"` - - - // Name - A displayable name to assign to the new flow execution - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Flowexecutionlaunchrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/flowexecutionlaunchresponse.go b/build/platformclientv2/flowexecutionlaunchresponse.go deleted file mode 100644 index d73f3de8b..000000000 --- a/build/platformclientv2/flowexecutionlaunchresponse.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Flowexecutionlaunchresponse - Response object from launching a flow. -type Flowexecutionlaunchresponse struct { - // Id - The flow execution ID - Id *string `json:"id,omitempty"` - - - // Name - The flow execution name. - Name *string `json:"name,omitempty"` - - - // FlowVersion - The version of the flow that launched - FlowVersion *Domainentityref `json:"flowVersion,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Flowexecutionlaunchresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/flowmilestone.go b/build/platformclientv2/flowmilestone.go deleted file mode 100644 index 0a3637e2b..000000000 --- a/build/platformclientv2/flowmilestone.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Flowmilestone -type Flowmilestone struct { - // Id - The flow milestone identifier - Id *string `json:"id,omitempty"` - - - // Name - The flow milestone name. - Name *string `json:"name,omitempty"` - - - // Description - The flow milestone description. - Description *string `json:"description,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Flowmilestone) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/flowmilestonelisting.go b/build/platformclientv2/flowmilestonelisting.go deleted file mode 100644 index 15a30ffa0..000000000 --- a/build/platformclientv2/flowmilestonelisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Flowmilestonelisting -type Flowmilestonelisting struct { - // Entities - Entities *[]Flowmilestone `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Flowmilestonelisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/flowobservationdatacontainer.go b/build/platformclientv2/flowobservationdatacontainer.go deleted file mode 100644 index 5ee054e4d..000000000 --- a/build/platformclientv2/flowobservationdatacontainer.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Flowobservationdatacontainer -type Flowobservationdatacontainer struct { - // Group - A mapping from dimension to value - Group *map[string]string `json:"group,omitempty"` - - - // Data - Data *[]Observationmetricdata `json:"data,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Flowobservationdatacontainer) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/flowobservationquery.go b/build/platformclientv2/flowobservationquery.go deleted file mode 100644 index 38f1fee2d..000000000 --- a/build/platformclientv2/flowobservationquery.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Flowobservationquery -type Flowobservationquery struct { - // Filter - Filter to return a subset of observations. Expresses boolean logical predicates as well as dimensional filters - Filter *Flowobservationqueryfilter `json:"filter,omitempty"` - - - // Metrics - Behaves like a SQL SELECT clause. Only named metrics will be retrieved. - Metrics *[]string `json:"metrics,omitempty"` - - - // DetailMetrics - Metrics for which to include additional detailed observations - DetailMetrics *[]string `json:"detailMetrics,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Flowobservationquery) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/flowobservationqueryclause.go b/build/platformclientv2/flowobservationqueryclause.go deleted file mode 100644 index c9901ec58..000000000 --- a/build/platformclientv2/flowobservationqueryclause.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Flowobservationqueryclause -type Flowobservationqueryclause struct { - // VarType - Boolean operation to apply to the provided predicates - VarType *string `json:"type,omitempty"` - - - // Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value). - Predicates *[]Flowobservationquerypredicate `json:"predicates,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Flowobservationqueryclause) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/flowobservationqueryfilter.go b/build/platformclientv2/flowobservationqueryfilter.go deleted file mode 100644 index 25b5d9316..000000000 --- a/build/platformclientv2/flowobservationqueryfilter.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Flowobservationqueryfilter -type Flowobservationqueryfilter struct { - // VarType - Boolean operation to apply to the provided predicates and clauses - VarType *string `json:"type,omitempty"` - - - // Clauses - Boolean 'and/or' logic with up to two-levels of nesting - Clauses *[]Flowobservationqueryclause `json:"clauses,omitempty"` - - - // Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value). - Predicates *[]Flowobservationquerypredicate `json:"predicates,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Flowobservationqueryfilter) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/flowobservationquerypredicate.go b/build/platformclientv2/flowobservationquerypredicate.go deleted file mode 100644 index a90e71ede..000000000 --- a/build/platformclientv2/flowobservationquerypredicate.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Flowobservationquerypredicate -type Flowobservationquerypredicate struct { - // VarType - Optional type, can usually be inferred - VarType *string `json:"type,omitempty"` - - - // Dimension - Left hand side for dimension predicates - Dimension *string `json:"dimension,omitempty"` - - - // Operator - Optional operator, default is matches - Operator *string `json:"operator,omitempty"` - - - // Value - Right hand side for dimension predicates - Value *string `json:"value,omitempty"` - - - // VarRange - Right hand side for dimension predicates - VarRange *Numericrange `json:"range,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Flowobservationquerypredicate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/flowobservationqueryresponse.go b/build/platformclientv2/flowobservationqueryresponse.go deleted file mode 100644 index b11c1a7a2..000000000 --- a/build/platformclientv2/flowobservationqueryresponse.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Flowobservationqueryresponse -type Flowobservationqueryresponse struct { - // Results - Results *[]Flowobservationdatacontainer `json:"results,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Flowobservationqueryresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/flowoutcome.go b/build/platformclientv2/flowoutcome.go deleted file mode 100644 index 79c31f0dc..000000000 --- a/build/platformclientv2/flowoutcome.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Flowoutcome -type Flowoutcome struct { - // Id - The flow outcome identifier - Id *string `json:"id,omitempty"` - - - // Name - The flow outcome name. - Name *string `json:"name,omitempty"` - - - // Description - Description *string `json:"description,omitempty"` - - - // CurrentOperation - CurrentOperation *Operation `json:"currentOperation,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Flowoutcome) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/flowoutcomelisting.go b/build/platformclientv2/flowoutcomelisting.go deleted file mode 100644 index 6eadb206a..000000000 --- a/build/platformclientv2/flowoutcomelisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Flowoutcomelisting -type Flowoutcomelisting struct { - // Entities - Entities *[]Flowoutcome `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Flowoutcomelisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/flowruntimeexecution.go b/build/platformclientv2/flowruntimeexecution.go deleted file mode 100644 index 26d3fa483..000000000 --- a/build/platformclientv2/flowruntimeexecution.go +++ /dev/null @@ -1,58 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Flowruntimeexecution - Details about the current state of a Flow execution -type Flowruntimeexecution struct { - // Id - The flow execution ID - Id *string `json:"id,omitempty"` - - - // Name - The flow execution name. - Name *string `json:"name,omitempty"` - - - // FlowVersion - The Version of the flow definition of the flow execution. - FlowVersion *Flowversion `json:"flowVersion,omitempty"` - - - // DateLaunched - The time the flow was launched. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateLaunched *time.Time `json:"dateLaunched,omitempty"` - - - // Status - The flow's running status, which indicates whether the flow is running normally or completed, etc. - Status *string `json:"status,omitempty"` - - - // DateCompleted - The time the flow completed, if applicable. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCompleted *time.Time `json:"dateCompleted,omitempty"` - - - // CompletionReason - The completion reason set at the flow completion time, if applicable. - CompletionReason *string `json:"completionReason,omitempty"` - - - // FlowErrorInfo - Additional information if the flow is in error - FlowErrorInfo *Errorbody `json:"flowErrorInfo,omitempty"` - - - // OutputData - List of the flow's output variables, if any. Output variables are only supplied for Completed flows. - OutputData *map[string]interface{} `json:"outputData,omitempty"` - - - // Conversation - The conversation to which this Flow execution is related - Conversation *Domainentityref `json:"conversation,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Flowruntimeexecution) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/flowsapi.go b/build/platformclientv2/flowsapi.go deleted file mode 100644 index e4143e634..000000000 --- a/build/platformclientv2/flowsapi.go +++ /dev/null @@ -1,174 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "encoding/json" -) - -// FlowsApi provides functions for API endpoints -type FlowsApi struct { - Configuration *Configuration -} - -// NewFlowsApi creates an API instance using the default configuration -func NewFlowsApi() *FlowsApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating FlowsApi with base path: %s", strings.ToLower(config.BasePath))) - return &FlowsApi{ - Configuration: config, - } -} - -// NewFlowsApiWithConfig creates an API instance using the provided configuration -func NewFlowsApiWithConfig(config *Configuration) *FlowsApi { - config.Debugf("Creating FlowsApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &FlowsApi{ - Configuration: config, - } -} - -// PostAnalyticsFlowsAggregatesQuery invokes POST /api/v2/analytics/flows/aggregates/query -// -// Query for flow aggregates -// -// -func (a FlowsApi) PostAnalyticsFlowsAggregatesQuery(body Flowaggregationquery) (*Flowaggregatequeryresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/flows/aggregates/query" - defaultReturn := new(Flowaggregatequeryresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling FlowsApi->PostAnalyticsFlowsAggregatesQuery") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Flowaggregatequeryresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostAnalyticsFlowsObservationsQuery invokes POST /api/v2/analytics/flows/observations/query -// -// Query for flow observations -// -// -func (a FlowsApi) PostAnalyticsFlowsObservationsQuery(body Flowobservationquery) (*Flowobservationqueryresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/flows/observations/query" - defaultReturn := new(Flowobservationqueryresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling FlowsApi->PostAnalyticsFlowsObservationsQuery") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Flowobservationqueryresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/flowversion.go b/build/platformclientv2/flowversion.go deleted file mode 100644 index 0d23b4506..000000000 --- a/build/platformclientv2/flowversion.go +++ /dev/null @@ -1,85 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Flowversion -type Flowversion struct { - // Id - The flow version identifier - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // CommitVersion - CommitVersion *string `json:"commitVersion,omitempty"` - - - // ConfigurationVersion - ConfigurationVersion *string `json:"configurationVersion,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - - - // Secure - Secure *bool `json:"secure,omitempty"` - - - // Debug - Debug *bool `json:"debug,omitempty"` - - - // CreatedBy - CreatedBy *User `json:"createdBy,omitempty"` - - - // CreatedByClient - CreatedByClient *Domainentityref `json:"createdByClient,omitempty"` - - - // ConfigurationUri - ConfigurationUri *string `json:"configurationUri,omitempty"` - - - // DateCreated - DateCreated *int `json:"dateCreated,omitempty"` - - - // GenerationId - GenerationId *string `json:"generationId,omitempty"` - - - // PublishResultUri - PublishResultUri *string `json:"publishResultUri,omitempty"` - - - // InputSchema - InputSchema *Jsonschemadocument `json:"inputSchema,omitempty"` - - - // OutputSchema - OutputSchema *Jsonschemadocument `json:"outputSchema,omitempty"` - - - // NluInfo - Information about the natural language understanding configuration for the flow version - NluInfo *Nluinfo `json:"nluInfo,omitempty"` - - - // SupportedLanguages - List of supported languages for this version of the flow - SupportedLanguages *[]Supportedlanguage `json:"supportedLanguages,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Flowversion) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/flowversionentitylisting.go b/build/platformclientv2/flowversionentitylisting.go deleted file mode 100644 index ee688c234..000000000 --- a/build/platformclientv2/flowversionentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Flowversionentitylisting -type Flowversionentitylisting struct { - // Entities - Entities *[]Flowversion `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Flowversionentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/forecastabandonrateresponse.go b/build/platformclientv2/forecastabandonrateresponse.go deleted file mode 100644 index 65b60c7d2..000000000 --- a/build/platformclientv2/forecastabandonrateresponse.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Forecastabandonrateresponse -type Forecastabandonrateresponse struct { - // Percent - The target percent abandon rate goal - Percent *int `json:"percent,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Forecastabandonrateresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/forecastaveragespeedofanswerresponse.go b/build/platformclientv2/forecastaveragespeedofanswerresponse.go deleted file mode 100644 index 82b449e9d..000000000 --- a/build/platformclientv2/forecastaveragespeedofanswerresponse.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Forecastaveragespeedofanswerresponse -type Forecastaveragespeedofanswerresponse struct { - // Seconds - the average speed of answer goal in seconds - Seconds *int `json:"seconds,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Forecastaveragespeedofanswerresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/forecastplanninggroupdata.go b/build/platformclientv2/forecastplanninggroupdata.go deleted file mode 100644 index 2ea8856df..000000000 --- a/build/platformclientv2/forecastplanninggroupdata.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Forecastplanninggroupdata -type Forecastplanninggroupdata struct { - // PlanningGroupId - The ID of the planning group to which this data applies. Note this is a snapshot of the planning group at the time of forecast creation and may not correspond to the current configuration - PlanningGroupId *string `json:"planningGroupId,omitempty"` - - - // OfferedPerInterval - Forecast offered counts per interval for this week of the forecast - OfferedPerInterval *[]float64 `json:"offeredPerInterval,omitempty"` - - - // AverageHandleTimeSecondsPerInterval - Forecast average handle time per interval in seconds - AverageHandleTimeSecondsPerInterval *[]float64 `json:"averageHandleTimeSecondsPerInterval,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Forecastplanninggroupdata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/forecastplanninggroupresponse.go b/build/platformclientv2/forecastplanninggroupresponse.go deleted file mode 100644 index 9b17df010..000000000 --- a/build/platformclientv2/forecastplanninggroupresponse.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Forecastplanninggroupresponse -type Forecastplanninggroupresponse struct { - // Id - The ID of the planning group - Id *string `json:"id,omitempty"` - - - // Name - The name of the planning group - Name *string `json:"name,omitempty"` - - - // RoutePaths - Route path configuration for this planning group - RoutePaths *[]Routepathresponse `json:"routePaths,omitempty"` - - - // ServiceGoalTemplate - Service goals for this planning group - ServiceGoalTemplate *Forecastservicegoaltemplateresponse `json:"serviceGoalTemplate,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Forecastplanninggroupresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/forecastplanninggroupsresponse.go b/build/platformclientv2/forecastplanninggroupsresponse.go deleted file mode 100644 index 1bc065517..000000000 --- a/build/platformclientv2/forecastplanninggroupsresponse.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Forecastplanninggroupsresponse -type Forecastplanninggroupsresponse struct { - // Entities - Entities *[]Forecastplanninggroupresponse `json:"entities,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Forecastplanninggroupsresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/forecastservicegoaltemplateresponse.go b/build/platformclientv2/forecastservicegoaltemplateresponse.go deleted file mode 100644 index bd5d5a936..000000000 --- a/build/platformclientv2/forecastservicegoaltemplateresponse.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Forecastservicegoaltemplateresponse -type Forecastservicegoaltemplateresponse struct { - // ServiceLevel - The service level goal for this forecast - ServiceLevel *Forecastservicelevelresponse `json:"serviceLevel,omitempty"` - - - // AverageSpeedOfAnswer - The average speed of answer goal for this forecast - AverageSpeedOfAnswer *Forecastaveragespeedofanswerresponse `json:"averageSpeedOfAnswer,omitempty"` - - - // AbandonRate - The abandon rate goal for this forecast - AbandonRate *Forecastabandonrateresponse `json:"abandonRate,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Forecastservicegoaltemplateresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/forecastservicelevelresponse.go b/build/platformclientv2/forecastservicelevelresponse.go deleted file mode 100644 index 5cb4c72df..000000000 --- a/build/platformclientv2/forecastservicelevelresponse.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Forecastservicelevelresponse -type Forecastservicelevelresponse struct { - // Percent - The percent of calls to answer in the number of seconds defined - Percent *int `json:"percent,omitempty"` - - - // Seconds - The number of seconds to define for the percent of calls to be answered - Seconds *int `json:"seconds,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Forecastservicelevelresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/forecastsourcedaypointer.go b/build/platformclientv2/forecastsourcedaypointer.go deleted file mode 100644 index b6c01c54c..000000000 --- a/build/platformclientv2/forecastsourcedaypointer.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Forecastsourcedaypointer - Pointer to look up source data for a short term forecast -type Forecastsourcedaypointer struct { - // DayOfWeek - The forecast day of week for this source data - DayOfWeek *string `json:"dayOfWeek,omitempty"` - - - // Weight - The relative weight to apply to this source data item for weighted averages - Weight *int `json:"weight,omitempty"` - - - // Date - The date this source data represents, in yyyy-MM-dd format - Date *string `json:"date,omitempty"` - - - // FileName - The name of the source file this data came from if it originated from a data import - FileName *string `json:"fileName,omitempty"` - - - // DataKey - The key to look up the forecast source data for this source day - DataKey *string `json:"dataKey,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Forecastsourcedaypointer) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/freeseatingconfiguration.go b/build/platformclientv2/freeseatingconfiguration.go deleted file mode 100644 index df5cef6f2..000000000 --- a/build/platformclientv2/freeseatingconfiguration.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Freeseatingconfiguration -type Freeseatingconfiguration struct { - // FreeSeatingState - The FreeSeatingState for FreeSeatingConfiguration. Can be ON, OFF, or PARTIAL. ON meaning disassociate the user after the ttl expires, OFF meaning never disassociate the user, and PARTIAL meaning only disassociate when a user explicitly clicks log out. - FreeSeatingState *string `json:"freeSeatingState,omitempty"` - - - // TtlMinutes - The amount of time in minutes until an offline user is disassociated from their station - TtlMinutes *int `json:"ttlMinutes,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Freeseatingconfiguration) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/gdprjourneycustomer.go b/build/platformclientv2/gdprjourneycustomer.go deleted file mode 100644 index bc16f14bd..000000000 --- a/build/platformclientv2/gdprjourneycustomer.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Gdprjourneycustomer -type Gdprjourneycustomer struct { - // VarType - The type of the customerId within the Journey System (e.g. cookie). Required if `id` is defined. - VarType *string `json:"type,omitempty"` - - - // Id - An ID of a customer within the Journey System at a point-in-time. Required if `type` is defined. - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Gdprjourneycustomer) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/gdprrequest.go b/build/platformclientv2/gdprrequest.go deleted file mode 100644 index 86402cbc3..000000000 --- a/build/platformclientv2/gdprrequest.go +++ /dev/null @@ -1,54 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Gdprrequest -type Gdprrequest struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // CreatedBy - The user that created this request - CreatedBy *Domainentityref `json:"createdBy,omitempty"` - - - // ReplacementTerms - The replacement terms for the provided search terms, in the case of a GDPR_UPDATE request - ReplacementTerms *[]Replacementterm `json:"replacementTerms,omitempty"` - - - // RequestType - The type of GDPR request - RequestType *string `json:"requestType,omitempty"` - - - // CreatedDate - When the request was submitted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - CreatedDate *time.Time `json:"createdDate,omitempty"` - - - // Status - The status of the request - Status *string `json:"status,omitempty"` - - - // Subject - The subject of the GDPR request - Subject *Gdprsubject `json:"subject,omitempty"` - - - // ResultsUrl - The location where the results of the request can be retrieved - ResultsUrl *string `json:"resultsUrl,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Gdprrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/gdprrequestentitylisting.go b/build/platformclientv2/gdprrequestentitylisting.go deleted file mode 100644 index ce6ad2f2a..000000000 --- a/build/platformclientv2/gdprrequestentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Gdprrequestentitylisting -type Gdprrequestentitylisting struct { - // Entities - Entities *[]Gdprrequest `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Gdprrequestentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/gdprsubject.go b/build/platformclientv2/gdprsubject.go deleted file mode 100644 index 1aef10f3b..000000000 --- a/build/platformclientv2/gdprsubject.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Gdprsubject -type Gdprsubject struct { - // Name - Name *string `json:"name,omitempty"` - - - // UserId - UserId *string `json:"userId,omitempty"` - - - // ExternalContactId - ExternalContactId *string `json:"externalContactId,omitempty"` - - - // DialerContactId - DialerContactId *Dialercontactid `json:"dialerContactId,omitempty"` - - - // JourneyCustomer - JourneyCustomer *Gdprjourneycustomer `json:"journeyCustomer,omitempty"` - - - // SocialHandle - SocialHandle *Socialhandle `json:"socialHandle,omitempty"` - - - // Addresses - Addresses *[]string `json:"addresses,omitempty"` - - - // PhoneNumbers - PhoneNumbers *[]string `json:"phoneNumbers,omitempty"` - - - // EmailAddresses - EmailAddresses *[]string `json:"emailAddresses,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Gdprsubject) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/gdprsubjectentitylisting.go b/build/platformclientv2/gdprsubjectentitylisting.go deleted file mode 100644 index 938c1b3aa..000000000 --- a/build/platformclientv2/gdprsubjectentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Gdprsubjectentitylisting -type Gdprsubjectentitylisting struct { - // Entities - Entities *[]Gdprsubject `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Gdprsubjectentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/generaldataprotectionregulationapi.go b/build/platformclientv2/generaldataprotectionregulationapi.go deleted file mode 100644 index 03b35080e..000000000 --- a/build/platformclientv2/generaldataprotectionregulationapi.go +++ /dev/null @@ -1,374 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "encoding/json" -) - -// GeneralDataProtectionRegulationApi provides functions for API endpoints -type GeneralDataProtectionRegulationApi struct { - Configuration *Configuration -} - -// NewGeneralDataProtectionRegulationApi creates an API instance using the default configuration -func NewGeneralDataProtectionRegulationApi() *GeneralDataProtectionRegulationApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating GeneralDataProtectionRegulationApi with base path: %s", strings.ToLower(config.BasePath))) - return &GeneralDataProtectionRegulationApi{ - Configuration: config, - } -} - -// NewGeneralDataProtectionRegulationApiWithConfig creates an API instance using the provided configuration -func NewGeneralDataProtectionRegulationApiWithConfig(config *Configuration) *GeneralDataProtectionRegulationApi { - config.Debugf("Creating GeneralDataProtectionRegulationApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &GeneralDataProtectionRegulationApi{ - Configuration: config, - } -} - -// GetGdprRequest invokes GET /api/v2/gdpr/requests/{requestId} -// -// Get an existing GDPR request -// -// -func (a GeneralDataProtectionRegulationApi) GetGdprRequest(requestId string) (*Gdprrequest, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/gdpr/requests/{requestId}" - path = strings.Replace(path, "{requestId}", fmt.Sprintf("%v", requestId), -1) - defaultReturn := new(Gdprrequest) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'requestId' is set - if &requestId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'requestId' when calling GeneralDataProtectionRegulationApi->GetGdprRequest") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Gdprrequest - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetGdprRequests invokes GET /api/v2/gdpr/requests -// -// Get all GDPR requests -// -// -func (a GeneralDataProtectionRegulationApi) GetGdprRequests(pageSize int, pageNumber int) (*Gdprrequestentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/gdpr/requests" - defaultReturn := new(Gdprrequestentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Gdprrequestentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetGdprSubjects invokes GET /api/v2/gdpr/subjects -// -// Get GDPR subjects -// -// -func (a GeneralDataProtectionRegulationApi) GetGdprSubjects(searchType string, searchValue string) (*Gdprsubjectentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/gdpr/subjects" - defaultReturn := new(Gdprsubjectentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'searchType' is set - if &searchType == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'searchType' when calling GeneralDataProtectionRegulationApi->GetGdprSubjects") - } - // verify the required parameter 'searchValue' is set - if &searchValue == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'searchValue' when calling GeneralDataProtectionRegulationApi->GetGdprSubjects") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(searchType).(string); ok { - if str != "" { - queryParams["searchType"] = a.Configuration.APIClient.ParameterToString(searchType, collectionFormat) - } - } else { - queryParams["searchType"] = a.Configuration.APIClient.ParameterToString(searchType, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(searchValue).(string); ok { - if str != "" { - queryParams["searchValue"] = a.Configuration.APIClient.ParameterToString(searchValue, collectionFormat) - } - } else { - queryParams["searchValue"] = a.Configuration.APIClient.ParameterToString(searchValue, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Gdprsubjectentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostGdprRequests invokes POST /api/v2/gdpr/requests -// -// Submit a new GDPR request -// -// -func (a GeneralDataProtectionRegulationApi) PostGdprRequests(body Gdprrequest, deleteConfirmed bool) (*Gdprrequest, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/gdpr/requests" - defaultReturn := new(Gdprrequest) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling GeneralDataProtectionRegulationApi->PostGdprRequests") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(deleteConfirmed).(string); ok { - if str != "" { - queryParams["deleteConfirmed"] = a.Configuration.APIClient.ParameterToString(deleteConfirmed, collectionFormat) - } - } else { - queryParams["deleteConfirmed"] = a.Configuration.APIClient.ParameterToString(deleteConfirmed, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Gdprrequest - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/generatebuforecastrequest.go b/build/platformclientv2/generatebuforecastrequest.go deleted file mode 100644 index 2bff9d530..000000000 --- a/build/platformclientv2/generatebuforecastrequest.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Generatebuforecastrequest -type Generatebuforecastrequest struct { - // Description - The description for the forecast - Description *string `json:"description,omitempty"` - - - // WeekCount - The number of weeks this forecast covers - WeekCount *int `json:"weekCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Generatebuforecastrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/genericsaml.go b/build/platformclientv2/genericsaml.go deleted file mode 100644 index 02dc903e4..000000000 --- a/build/platformclientv2/genericsaml.go +++ /dev/null @@ -1,61 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Genericsaml -type Genericsaml struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Disabled - Disabled *bool `json:"disabled,omitempty"` - - - // IssuerURI - IssuerURI *string `json:"issuerURI,omitempty"` - - - // SsoTargetURI - SsoTargetURI *string `json:"ssoTargetURI,omitempty"` - - - // Certificate - Certificate *string `json:"certificate,omitempty"` - - - // Certificates - Certificates *[]string `json:"certificates,omitempty"` - - - // RelyingPartyIdentifier - RelyingPartyIdentifier *string `json:"relyingPartyIdentifier,omitempty"` - - - // LogoImageData - LogoImageData *string `json:"logoImageData,omitempty"` - - - // EndpointCompression - EndpointCompression *bool `json:"endpointCompression,omitempty"` - - - // NameIdentifierFormat - NameIdentifierFormat *string `json:"nameIdentifierFormat,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Genericsaml) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/genesysbotconnector.go b/build/platformclientv2/genesysbotconnector.go deleted file mode 100644 index 7cf07379a..000000000 --- a/build/platformclientv2/genesysbotconnector.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Genesysbotconnector -type Genesysbotconnector struct { - // QueryParameters - User defined name/value parameters passed to the BotConnector bot. - QueryParameters *map[string]string `json:"queryParameters,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Genesysbotconnector) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/geolocation.go b/build/platformclientv2/geolocation.go deleted file mode 100644 index 33fdc182f..000000000 --- a/build/platformclientv2/geolocation.go +++ /dev/null @@ -1,57 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Geolocation -type Geolocation struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // VarType - A string used to describe the type of client the geolocation is being updated from e.g. ios, android, web, etc. - VarType *string `json:"type,omitempty"` - - - // Primary - A boolean used to tell whether or not to set this geolocation client as the primary on a PATCH - Primary *bool `json:"primary,omitempty"` - - - // Latitude - Latitude *float64 `json:"latitude,omitempty"` - - - // Longitude - Longitude *float64 `json:"longitude,omitempty"` - - - // Country - Country *string `json:"country,omitempty"` - - - // Region - Region *string `json:"region,omitempty"` - - - // City - City *string `json:"city,omitempty"` - - - // Locations - Locations *[]Locationdefinition `json:"locations,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Geolocation) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/geolocationapi.go b/build/platformclientv2/geolocationapi.go deleted file mode 100644 index 4e2d2ecfb..000000000 --- a/build/platformclientv2/geolocationapi.go +++ /dev/null @@ -1,324 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "encoding/json" -) - -// GeolocationApi provides functions for API endpoints -type GeolocationApi struct { - Configuration *Configuration -} - -// NewGeolocationApi creates an API instance using the default configuration -func NewGeolocationApi() *GeolocationApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating GeolocationApi with base path: %s", strings.ToLower(config.BasePath))) - return &GeolocationApi{ - Configuration: config, - } -} - -// NewGeolocationApiWithConfig creates an API instance using the provided configuration -func NewGeolocationApiWithConfig(config *Configuration) *GeolocationApi { - config.Debugf("Creating GeolocationApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &GeolocationApi{ - Configuration: config, - } -} - -// GetGeolocationsSettings invokes GET /api/v2/geolocations/settings -// -// Get a organization's GeolocationSettings -// -// -func (a GeolocationApi) GetGeolocationsSettings() (*Geolocationsettings, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/geolocations/settings" - defaultReturn := new(Geolocationsettings) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Geolocationsettings - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetUserGeolocation invokes GET /api/v2/users/{userId}/geolocations/{clientId} -// -// Get a user's Geolocation -// -// -func (a GeolocationApi) GetUserGeolocation(userId string, clientId string) (*Geolocation, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/geolocations/{clientId}" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - path = strings.Replace(path, "{clientId}", fmt.Sprintf("%v", clientId), -1) - defaultReturn := new(Geolocation) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling GeolocationApi->GetUserGeolocation") - } - // verify the required parameter 'clientId' is set - if &clientId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'clientId' when calling GeolocationApi->GetUserGeolocation") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Geolocation - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchGeolocationsSettings invokes PATCH /api/v2/geolocations/settings -// -// Patch a organization's GeolocationSettings -// -// -func (a GeolocationApi) PatchGeolocationsSettings(body Geolocationsettings) (*Geolocationsettings, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/geolocations/settings" - defaultReturn := new(Geolocationsettings) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling GeolocationApi->PatchGeolocationsSettings") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Geolocationsettings - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchUserGeolocation invokes PATCH /api/v2/users/{userId}/geolocations/{clientId} -// -// Patch a user's Geolocation -// -// The geolocation object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the client as the user's primary geolocation source. Option 2: Provide the 'latitude' and 'longitude' values. This will enqueue an asynchronous update of the 'city', 'region', and 'country', generating a notification. A subsequent GET operation will include the new values for 'city', 'region' and 'country'. Option 3: Provide the 'city', 'region', 'country' values. Option 1 can be combined with Option 2 or Option 3. For example, update the client as primary and provide latitude and longitude values. -func (a GeolocationApi) PatchUserGeolocation(userId string, clientId string, body Geolocation) (*Geolocation, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/geolocations/{clientId}" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - path = strings.Replace(path, "{clientId}", fmt.Sprintf("%v", clientId), -1) - defaultReturn := new(Geolocation) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling GeolocationApi->PatchUserGeolocation") - } - // verify the required parameter 'clientId' is set - if &clientId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'clientId' when calling GeolocationApi->PatchUserGeolocation") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling GeolocationApi->PatchUserGeolocation") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Geolocation - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/geolocationeventgeolocation.go b/build/platformclientv2/geolocationeventgeolocation.go deleted file mode 100644 index f5d400b34..000000000 --- a/build/platformclientv2/geolocationeventgeolocation.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Geolocationeventgeolocation -type Geolocationeventgeolocation struct { - // UserId - UserId *string `json:"userId,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - - - // Country - Country *string `json:"country,omitempty"` - - - // Region - Region *string `json:"region,omitempty"` - - - // City - City *string `json:"city,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Geolocationeventgeolocation) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/geolocationsettings.go b/build/platformclientv2/geolocationsettings.go deleted file mode 100644 index eae61efa6..000000000 --- a/build/platformclientv2/geolocationsettings.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Geolocationsettings -type Geolocationsettings struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Enabled - Enabled *bool `json:"enabled,omitempty"` - - - // MapboxKey - MapboxKey *string `json:"mapboxKey,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Geolocationsettings) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/gkndocumentationresult.go b/build/platformclientv2/gkndocumentationresult.go deleted file mode 100644 index 549143121..000000000 --- a/build/platformclientv2/gkndocumentationresult.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Gkndocumentationresult -type Gkndocumentationresult struct { - // Content - The text or html content for the documentation entity. Will be returned in responses for certain entities. - Content *string `json:"content,omitempty"` - - - // Link - URL link for the documentation entity. Will be returned in responses for certain entities. - Link *string `json:"link,omitempty"` - - - // Title - The title of the documentation entity. Will be returned in responses for certain entities. - Title *string `json:"title,omitempty"` - - - // VarType - The search type. Will be returned in responses for certain entities. - VarType *string `json:"_type,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Gkndocumentationresult) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/gkndocumentationsearchcriteria.go b/build/platformclientv2/gkndocumentationsearchcriteria.go deleted file mode 100644 index 0e64fc020..000000000 --- a/build/platformclientv2/gkndocumentationsearchcriteria.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Gkndocumentationsearchcriteria -type Gkndocumentationsearchcriteria struct { - // EndValue - The end value of the range. This field is used for range search types. - EndValue *string `json:"endValue,omitempty"` - - - // Values - A list of values for the search to match against - Values *[]string `json:"values,omitempty"` - - - // StartValue - The start value of the range. This field is used for range search types. - StartValue *string `json:"startValue,omitempty"` - - - // Fields - Field names to search against - Fields *[]string `json:"fields,omitempty"` - - - // Value - A value for the search to match against - Value *string `json:"value,omitempty"` - - - // Operator - How to apply this search criteria against other criteria - Operator *string `json:"operator,omitempty"` - - - // Group - Groups multiple conditions - Group *[]Gkndocumentationsearchcriteria `json:"group,omitempty"` - - - // DateFormat - Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX. - DateFormat *string `json:"dateFormat,omitempty"` - - - // VarType - Search Type - VarType *string `json:"type,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Gkndocumentationsearchcriteria) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/gkndocumentationsearchrequest.go b/build/platformclientv2/gkndocumentationsearchrequest.go deleted file mode 100644 index 9f647e57d..000000000 --- a/build/platformclientv2/gkndocumentationsearchrequest.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Gkndocumentationsearchrequest -type Gkndocumentationsearchrequest struct { - // SortOrder - The sort order for results - SortOrder *string `json:"sortOrder,omitempty"` - - - // SortBy - The field in the resource that you want to sort the results by - SortBy *string `json:"sortBy,omitempty"` - - - // PageSize - The number of results per page - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - The page of resources you want to retrieve - PageNumber *int `json:"pageNumber,omitempty"` - - - // Sort - Multi-value sort order, list of multiple sort values - Sort *[]Searchsort `json:"sort,omitempty"` - - - // Query - Query *[]Gkndocumentationsearchcriteria `json:"query,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Gkndocumentationsearchrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/gkndocumentationsearchresponse.go b/build/platformclientv2/gkndocumentationsearchresponse.go deleted file mode 100644 index a69a24122..000000000 --- a/build/platformclientv2/gkndocumentationsearchresponse.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Gkndocumentationsearchresponse -type Gkndocumentationsearchresponse struct { - // Total - The total number of results found - Total *int `json:"total,omitempty"` - - - // PageCount - The total number of pages - PageCount *int `json:"pageCount,omitempty"` - - - // PageSize - The current page size - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - The current page number - PageNumber *int `json:"pageNumber,omitempty"` - - - // PreviousPage - Q64 value for the previous page of results - PreviousPage *string `json:"previousPage,omitempty"` - - - // CurrentPage - Q64 value for the current page of results - CurrentPage *string `json:"currentPage,omitempty"` - - - // NextPage - Q64 value for the next page of results - NextPage *string `json:"nextPage,omitempty"` - - - // Types - Resource types the search was performed against - Types *[]string `json:"types,omitempty"` - - - // Results - Search results - Results *[]Gkndocumentationresult `json:"results,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Gkndocumentationsearchresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/googledialogflowcustomsettings.go b/build/platformclientv2/googledialogflowcustomsettings.go deleted file mode 100644 index 90a10f75d..000000000 --- a/build/platformclientv2/googledialogflowcustomsettings.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Googledialogflowcustomsettings -type Googledialogflowcustomsettings struct { - // Environment - If set this environment will be used to initiate the dialogflow bot, otherwise the default configuration will be used. See https://cloud.google.com/dialogflow/docs/agents-versions - Environment *string `json:"environment,omitempty"` - - - // EventName - If set this eventName will be used to initiate the dialogflow bot rather than language processing on the input text. See https://cloud.google.com/dialogflow/es/docs/events-overview - EventName *string `json:"eventName,omitempty"` - - - // WebhookQueryParameters - Parameters passed to the fulfillment webhook of the bot (if any). - WebhookQueryParameters *map[string]string `json:"webhookQueryParameters,omitempty"` - - - // EventInputParameters - Parameters passed to the event input of the bot. - EventInputParameters *map[string]string `json:"eventInputParameters,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Googledialogflowcustomsettings) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/greeting.go b/build/platformclientv2/greeting.go deleted file mode 100644 index 5391d36f4..000000000 --- a/build/platformclientv2/greeting.go +++ /dev/null @@ -1,62 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Greeting -type Greeting struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // VarType - Greeting type - VarType *string `json:"type,omitempty"` - - - // OwnerType - Greeting owner type - OwnerType *string `json:"ownerType,omitempty"` - - - // Owner - Greeting owner - Owner *Domainentity `json:"owner,omitempty"` - - - // AudioFile - AudioFile *Greetingaudiofile `json:"audioFile,omitempty"` - - - // AudioTTS - AudioTTS *string `json:"audioTTS,omitempty"` - - - // CreatedDate - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - CreatedDate *time.Time `json:"createdDate,omitempty"` - - - // CreatedBy - CreatedBy *string `json:"createdBy,omitempty"` - - - // ModifiedDate - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ModifiedDate *time.Time `json:"modifiedDate,omitempty"` - - - // ModifiedBy - ModifiedBy *string `json:"modifiedBy,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Greeting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/greetingaudiofile.go b/build/platformclientv2/greetingaudiofile.go deleted file mode 100644 index 3c7bb110e..000000000 --- a/build/platformclientv2/greetingaudiofile.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Greetingaudiofile -type Greetingaudiofile struct { - // DurationMilliseconds - DurationMilliseconds *int `json:"durationMilliseconds,omitempty"` - - - // SizeBytes - SizeBytes *int `json:"sizeBytes,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Greetingaudiofile) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/greetinglisting.go b/build/platformclientv2/greetinglisting.go deleted file mode 100644 index d5ee8f6fd..000000000 --- a/build/platformclientv2/greetinglisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Greetinglisting -type Greetinglisting struct { - // Entities - Entities *[]Greeting `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Greetinglisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/greetingmediainfo.go b/build/platformclientv2/greetingmediainfo.go deleted file mode 100644 index d6b0ce2cd..000000000 --- a/build/platformclientv2/greetingmediainfo.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Greetingmediainfo -type Greetingmediainfo struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // MediaFileUri - MediaFileUri *string `json:"mediaFileUri,omitempty"` - - - // MediaImageUri - MediaImageUri *string `json:"mediaImageUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Greetingmediainfo) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/greetingowner.go b/build/platformclientv2/greetingowner.go deleted file mode 100644 index 81373c591..000000000 --- a/build/platformclientv2/greetingowner.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Greetingowner -type Greetingowner struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Greetingowner) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/greetingsapi.go b/build/platformclientv2/greetingsapi.go deleted file mode 100644 index 10c111c15..000000000 --- a/build/platformclientv2/greetingsapi.go +++ /dev/null @@ -1,1257 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "encoding/json" -) - -// GreetingsApi provides functions for API endpoints -type GreetingsApi struct { - Configuration *Configuration -} - -// NewGreetingsApi creates an API instance using the default configuration -func NewGreetingsApi() *GreetingsApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating GreetingsApi with base path: %s", strings.ToLower(config.BasePath))) - return &GreetingsApi{ - Configuration: config, - } -} - -// NewGreetingsApiWithConfig creates an API instance using the provided configuration -func NewGreetingsApiWithConfig(config *Configuration) *GreetingsApi { - config.Debugf("Creating GreetingsApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &GreetingsApi{ - Configuration: config, - } -} - -// DeleteGreeting invokes DELETE /api/v2/greetings/{greetingId} -// -// Deletes a Greeting with the given GreetingId -// -// -func (a GreetingsApi) DeleteGreeting(greetingId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/greetings/{greetingId}" - path = strings.Replace(path, "{greetingId}", fmt.Sprintf("%v", greetingId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'greetingId' is set - if &greetingId == nil { - // - return nil, errors.New("Missing required parameter 'greetingId' when calling GreetingsApi->DeleteGreeting") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// GetGreeting invokes GET /api/v2/greetings/{greetingId} -// -// Get a Greeting with the given GreetingId -// -// -func (a GreetingsApi) GetGreeting(greetingId string) (*Greeting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/greetings/{greetingId}" - path = strings.Replace(path, "{greetingId}", fmt.Sprintf("%v", greetingId), -1) - defaultReturn := new(Greeting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'greetingId' is set - if &greetingId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'greetingId' when calling GreetingsApi->GetGreeting") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Greeting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetGreetingMedia invokes GET /api/v2/greetings/{greetingId}/media -// -// Get media playback URI for this greeting -// -// -func (a GreetingsApi) GetGreetingMedia(greetingId string, formatId string) (*Greetingmediainfo, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/greetings/{greetingId}/media" - path = strings.Replace(path, "{greetingId}", fmt.Sprintf("%v", greetingId), -1) - defaultReturn := new(Greetingmediainfo) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'greetingId' is set - if &greetingId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'greetingId' when calling GreetingsApi->GetGreetingMedia") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(formatId).(string); ok { - if str != "" { - queryParams["formatId"] = a.Configuration.APIClient.ParameterToString(formatId, collectionFormat) - } - } else { - queryParams["formatId"] = a.Configuration.APIClient.ParameterToString(formatId, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Greetingmediainfo - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetGreetings invokes GET /api/v2/greetings -// -// Gets an Organization's Greetings -// -// -func (a GreetingsApi) GetGreetings(pageSize int, pageNumber int) (*Domainentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/greetings" - defaultReturn := new(Domainentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Domainentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetGreetingsDefaults invokes GET /api/v2/greetings/defaults -// -// Get an Organization's DefaultGreetingList -// -// -func (a GreetingsApi) GetGreetingsDefaults() (*Defaultgreetinglist, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/greetings/defaults" - defaultReturn := new(Defaultgreetinglist) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Defaultgreetinglist - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetGroupGreetings invokes GET /api/v2/groups/{groupId}/greetings -// -// Get a list of the Group's Greetings -// -// -func (a GreetingsApi) GetGroupGreetings(groupId string, pageSize int, pageNumber int) (*Greetinglisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/groups/{groupId}/greetings" - path = strings.Replace(path, "{groupId}", fmt.Sprintf("%v", groupId), -1) - defaultReturn := new(Greetinglisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'groupId' is set - if &groupId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'groupId' when calling GreetingsApi->GetGroupGreetings") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Greetinglisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetGroupGreetingsDefaults invokes GET /api/v2/groups/{groupId}/greetings/defaults -// -// Grabs the list of Default Greetings given a Group's ID -// -// -func (a GreetingsApi) GetGroupGreetingsDefaults(groupId string) (*Defaultgreetinglist, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/groups/{groupId}/greetings/defaults" - path = strings.Replace(path, "{groupId}", fmt.Sprintf("%v", groupId), -1) - defaultReturn := new(Defaultgreetinglist) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'groupId' is set - if &groupId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'groupId' when calling GreetingsApi->GetGroupGreetingsDefaults") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Defaultgreetinglist - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetUserGreetings invokes GET /api/v2/users/{userId}/greetings -// -// Get a list of the User's Greetings -// -// -func (a GreetingsApi) GetUserGreetings(userId string, pageSize int, pageNumber int) (*Domainentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/greetings" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Domainentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling GreetingsApi->GetUserGreetings") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Domainentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetUserGreetingsDefaults invokes GET /api/v2/users/{userId}/greetings/defaults -// -// Grabs the list of Default Greetings given a User's ID -// -// -func (a GreetingsApi) GetUserGreetingsDefaults(userId string) (*Defaultgreetinglist, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/greetings/defaults" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Defaultgreetinglist) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling GreetingsApi->GetUserGreetingsDefaults") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Defaultgreetinglist - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostGreetings invokes POST /api/v2/greetings -// -// Create a Greeting for an Organization -// -// -func (a GreetingsApi) PostGreetings(body Greeting) (*Greeting, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/greetings" - defaultReturn := new(Greeting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling GreetingsApi->PostGreetings") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Greeting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostGroupGreetings invokes POST /api/v2/groups/{groupId}/greetings -// -// Creates a Greeting for a Group -// -// -func (a GreetingsApi) PostGroupGreetings(groupId string, body Greeting) (*Greeting, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/groups/{groupId}/greetings" - path = strings.Replace(path, "{groupId}", fmt.Sprintf("%v", groupId), -1) - defaultReturn := new(Greeting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'groupId' is set - if &groupId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'groupId' when calling GreetingsApi->PostGroupGreetings") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling GreetingsApi->PostGroupGreetings") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Greeting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostUserGreetings invokes POST /api/v2/users/{userId}/greetings -// -// Creates a Greeting for a User -// -// -func (a GreetingsApi) PostUserGreetings(userId string, body Greeting) (*Greeting, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/greetings" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Greeting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling GreetingsApi->PostUserGreetings") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling GreetingsApi->PostUserGreetings") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Greeting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutGreeting invokes PUT /api/v2/greetings/{greetingId} -// -// Updates the Greeting with the given GreetingId -// -// -func (a GreetingsApi) PutGreeting(greetingId string, body Greeting) (*Greeting, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/greetings/{greetingId}" - path = strings.Replace(path, "{greetingId}", fmt.Sprintf("%v", greetingId), -1) - defaultReturn := new(Greeting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'greetingId' is set - if &greetingId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'greetingId' when calling GreetingsApi->PutGreeting") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling GreetingsApi->PutGreeting") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Greeting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutGreetingsDefaults invokes PUT /api/v2/greetings/defaults -// -// Update an Organization's DefaultGreetingList -// -// -func (a GreetingsApi) PutGreetingsDefaults(body Defaultgreetinglist) (*Defaultgreetinglist, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/greetings/defaults" - defaultReturn := new(Defaultgreetinglist) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling GreetingsApi->PutGreetingsDefaults") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Defaultgreetinglist - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutGroupGreetingsDefaults invokes PUT /api/v2/groups/{groupId}/greetings/defaults -// -// Updates the DefaultGreetingList of the specified Group -// -// -func (a GreetingsApi) PutGroupGreetingsDefaults(groupId string, body Defaultgreetinglist) (*Defaultgreetinglist, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/groups/{groupId}/greetings/defaults" - path = strings.Replace(path, "{groupId}", fmt.Sprintf("%v", groupId), -1) - defaultReturn := new(Defaultgreetinglist) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'groupId' is set - if &groupId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'groupId' when calling GreetingsApi->PutGroupGreetingsDefaults") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling GreetingsApi->PutGroupGreetingsDefaults") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Defaultgreetinglist - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutUserGreetingsDefaults invokes PUT /api/v2/users/{userId}/greetings/defaults -// -// Updates the DefaultGreetingList of the specified User -// -// -func (a GreetingsApi) PutUserGreetingsDefaults(userId string, body Defaultgreetinglist) (*Defaultgreetinglist, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/greetings/defaults" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Defaultgreetinglist) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling GreetingsApi->PutUserGreetingsDefaults") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling GreetingsApi->PutUserGreetingsDefaults") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Defaultgreetinglist - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/group.go b/build/platformclientv2/group.go deleted file mode 100644 index 68627ac41..000000000 --- a/build/platformclientv2/group.go +++ /dev/null @@ -1,70 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Group -type Group struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The group name. - Name *string `json:"name,omitempty"` - - - // Description - Description *string `json:"description,omitempty"` - - - // DateModified - Last modified date/time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // MemberCount - Number of members. - MemberCount *int `json:"memberCount,omitempty"` - - - // State - Active, inactive, or deleted state. - State *string `json:"state,omitempty"` - - - // Version - Current version for this resource. - Version *int `json:"version,omitempty"` - - - // VarType - Type of group. - VarType *string `json:"type,omitempty"` - - - // Images - Images *[]Userimage `json:"images,omitempty"` - - - // Addresses - Addresses *[]Groupcontact `json:"addresses,omitempty"` - - - // RulesVisible - Are membership rules visible to the person requesting to view the group - RulesVisible *bool `json:"rulesVisible,omitempty"` - - - // Visibility - Who can view this group - Visibility *string `json:"visibility,omitempty"` - - - // Owners - Owners of the group - Owners *[]User `json:"owners,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Group) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/groupcontact.go b/build/platformclientv2/groupcontact.go deleted file mode 100644 index 78c04c609..000000000 --- a/build/platformclientv2/groupcontact.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Groupcontact -type Groupcontact struct { - // Address - Phone number for this contact type - Address *string `json:"address,omitempty"` - - - // Extension - Extension is set if the number is e164 valid - Extension *string `json:"extension,omitempty"` - - - // Display - Formatted version of the address property - Display *string `json:"display,omitempty"` - - - // VarType - Contact type of the address - VarType *string `json:"type,omitempty"` - - - // MediaType - Media type of the address - MediaType *string `json:"mediaType,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Groupcontact) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/groupcreate.go b/build/platformclientv2/groupcreate.go deleted file mode 100644 index 411b5ba18..000000000 --- a/build/platformclientv2/groupcreate.go +++ /dev/null @@ -1,70 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Groupcreate -type Groupcreate struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The group name. - Name *string `json:"name,omitempty"` - - - // Description - Description *string `json:"description,omitempty"` - - - // DateModified - Last modified date/time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // MemberCount - Number of members. - MemberCount *int `json:"memberCount,omitempty"` - - - // State - Active, inactive, or deleted state. - State *string `json:"state,omitempty"` - - - // Version - Current version for this resource. - Version *int `json:"version,omitempty"` - - - // VarType - Type of group. - VarType *string `json:"type,omitempty"` - - - // Images - Images *[]Userimage `json:"images,omitempty"` - - - // Addresses - Addresses *[]Groupcontact `json:"addresses,omitempty"` - - - // RulesVisible - Are membership rules visible to the person requesting to view the group - RulesVisible *bool `json:"rulesVisible,omitempty"` - - - // Visibility - Who can view this group - Visibility *string `json:"visibility,omitempty"` - - - // OwnerIds - Owners of the group - OwnerIds *[]string `json:"ownerIds,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Groupcreate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/groupentitylisting.go b/build/platformclientv2/groupentitylisting.go deleted file mode 100644 index 6cc7d0ade..000000000 --- a/build/platformclientv2/groupentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Groupentitylisting -type Groupentitylisting struct { - // Entities - Entities *[]Group `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Groupentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/groupgreetingeventgreeting.go b/build/platformclientv2/groupgreetingeventgreeting.go deleted file mode 100644 index 81bb7f50e..000000000 --- a/build/platformclientv2/groupgreetingeventgreeting.go +++ /dev/null @@ -1,41 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Groupgreetingeventgreeting -type Groupgreetingeventgreeting struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - - - // OwnerType - OwnerType *string `json:"ownerType,omitempty"` - - - // Owner - Owner *Groupgreetingeventgreetingowner `json:"owner,omitempty"` - - - // GreetingAudioFile - GreetingAudioFile *Groupgreetingeventgreetingaudiofile `json:"greetingAudioFile,omitempty"` - - - // AudioTTS - AudioTTS *string `json:"audioTTS,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Groupgreetingeventgreeting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/groupgreetingeventgreetingaudiofile.go b/build/platformclientv2/groupgreetingeventgreetingaudiofile.go deleted file mode 100644 index aac19d936..000000000 --- a/build/platformclientv2/groupgreetingeventgreetingaudiofile.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Groupgreetingeventgreetingaudiofile -type Groupgreetingeventgreetingaudiofile struct { - // DurationMilliseconds - DurationMilliseconds *int `json:"durationMilliseconds,omitempty"` - - - // SizeBytes - SizeBytes *int `json:"sizeBytes,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Groupgreetingeventgreetingaudiofile) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/groupgreetingeventgreetingowner.go b/build/platformclientv2/groupgreetingeventgreetingowner.go deleted file mode 100644 index 2c7df691e..000000000 --- a/build/platformclientv2/groupgreetingeventgreetingowner.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Groupgreetingeventgreetingowner -type Groupgreetingeventgreetingowner struct { - // Id - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Groupgreetingeventgreetingowner) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/groupmembersupdate.go b/build/platformclientv2/groupmembersupdate.go deleted file mode 100644 index 8efdc83b3..000000000 --- a/build/platformclientv2/groupmembersupdate.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Groupmembersupdate -type Groupmembersupdate struct { - // MemberIds - A list of the ids of the members to add. - MemberIds *[]string `json:"memberIds,omitempty"` - - - // Version - The current group version. - Version *int `json:"version,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Groupmembersupdate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/groupprofile.go b/build/platformclientv2/groupprofile.go deleted file mode 100644 index 616afed4d..000000000 --- a/build/platformclientv2/groupprofile.go +++ /dev/null @@ -1,38 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Groupprofile -type Groupprofile struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // State - The state of the user resource - State *string `json:"state,omitempty"` - - - // DateModified - Datetime of the last modification. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // Version - The version of the group resource - Version *int `json:"version,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Groupprofile) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/groupprofileentitylisting.go b/build/platformclientv2/groupprofileentitylisting.go deleted file mode 100644 index f8b6eb9a4..000000000 --- a/build/platformclientv2/groupprofileentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Groupprofileentitylisting -type Groupprofileentitylisting struct { - // Entities - Entities *[]Groupprofile `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Groupprofileentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/groupsapi.go b/build/platformclientv2/groupsapi.go deleted file mode 100644 index e0281d74e..000000000 --- a/build/platformclientv2/groupsapi.go +++ /dev/null @@ -1,1231 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "encoding/json" -) - -// GroupsApi provides functions for API endpoints -type GroupsApi struct { - Configuration *Configuration -} - -// NewGroupsApi creates an API instance using the default configuration -func NewGroupsApi() *GroupsApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating GroupsApi with base path: %s", strings.ToLower(config.BasePath))) - return &GroupsApi{ - Configuration: config, - } -} - -// NewGroupsApiWithConfig creates an API instance using the provided configuration -func NewGroupsApiWithConfig(config *Configuration) *GroupsApi { - config.Debugf("Creating GroupsApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &GroupsApi{ - Configuration: config, - } -} - -// DeleteGroup invokes DELETE /api/v2/groups/{groupId} -// -// Delete group -// -// -func (a GroupsApi) DeleteGroup(groupId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/groups/{groupId}" - path = strings.Replace(path, "{groupId}", fmt.Sprintf("%v", groupId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'groupId' is set - if &groupId == nil { - // - return nil, errors.New("Missing required parameter 'groupId' when calling GroupsApi->DeleteGroup") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteGroupMembers invokes DELETE /api/v2/groups/{groupId}/members -// -// Remove members -// -// -func (a GroupsApi) DeleteGroupMembers(groupId string, ids string) (*Empty, *APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/groups/{groupId}/members" - path = strings.Replace(path, "{groupId}", fmt.Sprintf("%v", groupId), -1) - defaultReturn := new(Empty) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'groupId' is set - if &groupId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'groupId' when calling GroupsApi->DeleteGroupMembers") - } - // verify the required parameter 'ids' is set - if &ids == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'ids' when calling GroupsApi->DeleteGroupMembers") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(ids).(string); ok { - if str != "" { - queryParams["ids"] = a.Configuration.APIClient.ParameterToString(ids, collectionFormat) - } - } else { - queryParams["ids"] = a.Configuration.APIClient.ParameterToString(ids, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Empty - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetFieldconfig invokes GET /api/v2/fieldconfig -// -// Fetch field config for an entity type -// -// -func (a GroupsApi) GetFieldconfig(varType string) (*Fieldconfig, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/fieldconfig" - defaultReturn := new(Fieldconfig) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'varType' is set - if &varType == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'varType' when calling GroupsApi->GetFieldconfig") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(varType).(string); ok { - if str != "" { - queryParams["varType"] = a.Configuration.APIClient.ParameterToString(varType, collectionFormat) - } - } else { - queryParams["varType"] = a.Configuration.APIClient.ParameterToString(varType, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Fieldconfig - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetGroup invokes GET /api/v2/groups/{groupId} -// -// Get group -// -// -func (a GroupsApi) GetGroup(groupId string) (*Group, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/groups/{groupId}" - path = strings.Replace(path, "{groupId}", fmt.Sprintf("%v", groupId), -1) - defaultReturn := new(Group) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'groupId' is set - if &groupId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'groupId' when calling GroupsApi->GetGroup") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Group - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetGroupIndividuals invokes GET /api/v2/groups/{groupId}/individuals -// -// Get all individuals associated with the group -// -// -func (a GroupsApi) GetGroupIndividuals(groupId string) (*Userentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/groups/{groupId}/individuals" - path = strings.Replace(path, "{groupId}", fmt.Sprintf("%v", groupId), -1) - defaultReturn := new(Userentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'groupId' is set - if &groupId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'groupId' when calling GroupsApi->GetGroupIndividuals") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Userentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetGroupMembers invokes GET /api/v2/groups/{groupId}/members -// -// Get group members, includes individuals, owners, and dynamically included people -// -// -func (a GroupsApi) GetGroupMembers(groupId string, pageSize int, pageNumber int, sortOrder string, expand []string) (*Userentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/groups/{groupId}/members" - path = strings.Replace(path, "{groupId}", fmt.Sprintf("%v", groupId), -1) - defaultReturn := new(Userentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'groupId' is set - if &groupId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'groupId' when calling GroupsApi->GetGroupMembers") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Userentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetGroupProfile invokes GET /api/v2/groups/{groupId}/profile -// -// Get group profile -// -// This api is deprecated. Use /api/v2/groups instead -func (a GroupsApi) GetGroupProfile(groupId string, fields string) (*Groupprofile, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/groups/{groupId}/profile" - path = strings.Replace(path, "{groupId}", fmt.Sprintf("%v", groupId), -1) - defaultReturn := new(Groupprofile) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'groupId' is set - if &groupId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'groupId' when calling GroupsApi->GetGroupProfile") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(fields).(string); ok { - if str != "" { - queryParams["fields"] = a.Configuration.APIClient.ParameterToString(fields, collectionFormat) - } - } else { - queryParams["fields"] = a.Configuration.APIClient.ParameterToString(fields, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Groupprofile - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetGroups invokes GET /api/v2/groups -// -// Get a group list -// -// -func (a GroupsApi) GetGroups(pageSize int, pageNumber int, id []string, jabberId []string, sortOrder string) (*Groupentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/groups" - defaultReturn := new(Groupentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range id { - queryParams["id"] = value - } - } else { - queryParams["id"] = a.Configuration.APIClient.ParameterToString(id, collectionFormat) - } - - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range jabberId { - queryParams["jabberId"] = value - } - } else { - queryParams["jabberId"] = a.Configuration.APIClient.ParameterToString(jabberId, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Groupentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetGroupsSearch invokes GET /api/v2/groups/search -// -// Search groups using the q64 value returned from a previous search -// -// -func (a GroupsApi) GetGroupsSearch(q64 string, expand []string) (*Groupssearchresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/groups/search" - defaultReturn := new(Groupssearchresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'q64' is set - if &q64 == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'q64' when calling GroupsApi->GetGroupsSearch") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(q64).(string); ok { - if str != "" { - queryParams["q64"] = a.Configuration.APIClient.ParameterToString(q64, collectionFormat) - } - } else { - queryParams["q64"] = a.Configuration.APIClient.ParameterToString(q64, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Groupssearchresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetProfilesGroups invokes GET /api/v2/profiles/groups -// -// Get group profile listing -// -// This api is deprecated. Use /api/v2/groups instead. -func (a GroupsApi) GetProfilesGroups(pageSize int, pageNumber int, id []string, sortOrder string) (*Groupprofileentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/profiles/groups" - defaultReturn := new(Groupprofileentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range id { - queryParams["id"] = value - } - } else { - queryParams["id"] = a.Configuration.APIClient.ParameterToString(id, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Groupprofileentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostGroupMembers invokes POST /api/v2/groups/{groupId}/members -// -// Add members -// -// -func (a GroupsApi) PostGroupMembers(groupId string, body Groupmembersupdate) (*Empty, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/groups/{groupId}/members" - path = strings.Replace(path, "{groupId}", fmt.Sprintf("%v", groupId), -1) - defaultReturn := new(Empty) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'groupId' is set - if &groupId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'groupId' when calling GroupsApi->PostGroupMembers") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling GroupsApi->PostGroupMembers") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Empty - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostGroups invokes POST /api/v2/groups -// -// Create a group -// -// -func (a GroupsApi) PostGroups(body Groupcreate) (*Group, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/groups" - defaultReturn := new(Group) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling GroupsApi->PostGroups") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Group - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostGroupsSearch invokes POST /api/v2/groups/search -// -// Search groups -// -// -func (a GroupsApi) PostGroupsSearch(body Groupsearchrequest) (*Groupssearchresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/groups/search" - defaultReturn := new(Groupssearchresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling GroupsApi->PostGroupsSearch") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Groupssearchresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutGroup invokes PUT /api/v2/groups/{groupId} -// -// Update group -// -// -func (a GroupsApi) PutGroup(groupId string, body Groupupdate) (*Group, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/groups/{groupId}" - path = strings.Replace(path, "{groupId}", fmt.Sprintf("%v", groupId), -1) - defaultReturn := new(Group) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'groupId' is set - if &groupId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'groupId' when calling GroupsApi->PutGroup") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Group - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/groupsearchcriteria.go b/build/platformclientv2/groupsearchcriteria.go deleted file mode 100644 index 6c85ab105..000000000 --- a/build/platformclientv2/groupsearchcriteria.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Groupsearchcriteria -type Groupsearchcriteria struct { - // EndValue - The end value of the range. This field is used for range search types. - EndValue *string `json:"endValue,omitempty"` - - - // Values - A list of values for the search to match against - Values *[]string `json:"values,omitempty"` - - - // StartValue - The start value of the range. This field is used for range search types. - StartValue *string `json:"startValue,omitempty"` - - - // Fields - Field names to search against - Fields *[]string `json:"fields,omitempty"` - - - // Value - A value for the search to match against - Value *string `json:"value,omitempty"` - - - // Operator - How to apply this search criteria against other criteria - Operator *string `json:"operator,omitempty"` - - - // Group - Groups multiple conditions - Group *[]Groupsearchcriteria `json:"group,omitempty"` - - - // DateFormat - Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX. - DateFormat *string `json:"dateFormat,omitempty"` - - - // VarType - Search Type - VarType *string `json:"type,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Groupsearchcriteria) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/groupsearchrequest.go b/build/platformclientv2/groupsearchrequest.go deleted file mode 100644 index 2f9b3e7a4..000000000 --- a/build/platformclientv2/groupsearchrequest.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Groupsearchrequest -type Groupsearchrequest struct { - // SortOrder - The sort order for results - SortOrder *string `json:"sortOrder,omitempty"` - - - // SortBy - The field in the resource that you want to sort the results by - SortBy *string `json:"sortBy,omitempty"` - - - // PageSize - The number of results per page - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - The page of resources you want to retrieve - PageNumber *int `json:"pageNumber,omitempty"` - - - // Sort - Multi-value sort order, list of multiple sort values - Sort *[]Searchsort `json:"sort,omitempty"` - - - // Query - Query *[]Groupsearchcriteria `json:"query,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Groupsearchrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/groupssearchresponse.go b/build/platformclientv2/groupssearchresponse.go deleted file mode 100644 index 0d1302302..000000000 --- a/build/platformclientv2/groupssearchresponse.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Groupssearchresponse -type Groupssearchresponse struct { - // Total - The total number of results found - Total *int `json:"total,omitempty"` - - - // PageCount - The total number of pages - PageCount *int `json:"pageCount,omitempty"` - - - // PageSize - The current page size - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - The current page number - PageNumber *int `json:"pageNumber,omitempty"` - - - // PreviousPage - Q64 value for the previous page of results - PreviousPage *string `json:"previousPage,omitempty"` - - - // CurrentPage - Q64 value for the current page of results - CurrentPage *string `json:"currentPage,omitempty"` - - - // NextPage - Q64 value for the next page of results - NextPage *string `json:"nextPage,omitempty"` - - - // Types - Resource types the search was performed against - Types *[]string `json:"types,omitempty"` - - - // Results - Search results - Results *[]Group `json:"results,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Groupssearchresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/groupupdate.go b/build/platformclientv2/groupupdate.go deleted file mode 100644 index 3be2b607c..000000000 --- a/build/platformclientv2/groupupdate.go +++ /dev/null @@ -1,57 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Groupupdate -type Groupupdate struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The group name. - Name *string `json:"name,omitempty"` - - - // Description - Description *string `json:"description,omitempty"` - - - // State - State of the group. - State *string `json:"state,omitempty"` - - - // Version - Current version for this resource. - Version *int `json:"version,omitempty"` - - - // Images - Images *[]Userimage `json:"images,omitempty"` - - - // Addresses - Addresses *[]Groupcontact `json:"addresses,omitempty"` - - - // RulesVisible - Are membership rules visible to the person requesting to view the group - RulesVisible *bool `json:"rulesVisible,omitempty"` - - - // Visibility - Who can view this group - Visibility *string `json:"visibility,omitempty"` - - - // OwnerIds - Owners of the group - OwnerIds *[]string `json:"ownerIds,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Groupupdate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/gsuite.go b/build/platformclientv2/gsuite.go deleted file mode 100644 index 630581889..000000000 --- a/build/platformclientv2/gsuite.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Gsuite -type Gsuite struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Disabled - Disabled *bool `json:"disabled,omitempty"` - - - // IssuerURI - IssuerURI *string `json:"issuerURI,omitempty"` - - - // SsoTargetURI - SsoTargetURI *string `json:"ssoTargetURI,omitempty"` - - - // Certificate - Certificate *string `json:"certificate,omitempty"` - - - // Certificates - Certificates *[]string `json:"certificates,omitempty"` - - - // RelyingPartyIdentifier - RelyingPartyIdentifier *string `json:"relyingPartyIdentifier,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Gsuite) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/guestmemberinfo.go b/build/platformclientv2/guestmemberinfo.go deleted file mode 100644 index fde9a67c0..000000000 --- a/build/platformclientv2/guestmemberinfo.go +++ /dev/null @@ -1,41 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Guestmemberinfo -type Guestmemberinfo struct { - // DisplayName - The display name to use for the guest member in the conversation. - DisplayName *string `json:"displayName,omitempty"` - - - // FirstName - The first name to use for the guest member in the conversation. - FirstName *string `json:"firstName,omitempty"` - - - // LastName - The last name to use for the guest member in the conversation. - LastName *string `json:"lastName,omitempty"` - - - // Email - The email address to use for the guest member in the conversation. - Email *string `json:"email,omitempty"` - - - // PhoneNumber - The phone number to use for the guest member in the conversation. - PhoneNumber *string `json:"phoneNumber,omitempty"` - - - // AvatarImageUrl - The URL to the avatar image to use for the guest member in the conversation, if any. - AvatarImageUrl *string `json:"avatarImageUrl,omitempty"` - - - // CustomFields - Any custom fields of information, in key-value format, to attach to the guest member in the conversation. - CustomFields *map[string]string `json:"customFields,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Guestmemberinfo) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/headcountforecast.go b/build/platformclientv2/headcountforecast.go deleted file mode 100644 index 548865ec0..000000000 --- a/build/platformclientv2/headcountforecast.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Headcountforecast - Headcount interval information for schedule -type Headcountforecast struct { - // Required - Headcount information with shrinkage - Required *[]Headcountinterval `json:"required,omitempty"` - - - // RequiredWithoutShrinkage - Headcount information without shrinkage - RequiredWithoutShrinkage *[]Headcountinterval `json:"requiredWithoutShrinkage,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Headcountforecast) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/headcountinterval.go b/build/platformclientv2/headcountinterval.go deleted file mode 100644 index 51b854dd8..000000000 --- a/build/platformclientv2/headcountinterval.go +++ /dev/null @@ -1,22 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Headcountinterval - Headcount interval information for schedule -type Headcountinterval struct { - // Interval - The start date-time for this headcount interval in ISO-8601 format, must be within the 8 day schedule - Interval *time.Time `json:"interval,omitempty"` - - - // Value - Headcount value for this interval - Value *float64 `json:"value,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Headcountinterval) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/helplink.go b/build/platformclientv2/helplink.go deleted file mode 100644 index 0cfe69085..000000000 --- a/build/platformclientv2/helplink.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Helplink - Link to a help or support resource -type Helplink struct { - // Uri - URI of the help resource - Uri *string `json:"uri,omitempty"` - - - // Title - Link text of the resource - Title *string `json:"title,omitempty"` - - - // Description - Description of the document or resource - Description *string `json:"description,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Helplink) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/historicaladherenceactuals.go b/build/platformclientv2/historicaladherenceactuals.go deleted file mode 100644 index 35314b953..000000000 --- a/build/platformclientv2/historicaladherenceactuals.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Historicaladherenceactuals -type Historicaladherenceactuals struct { - // ActualActivityCategory - Activity in which the user is actually engaged - ActualActivityCategory *string `json:"actualActivityCategory,omitempty"` - - - // StartOffsetSeconds - Actual start offset in seconds relative to query start time - StartOffsetSeconds *int `json:"startOffsetSeconds,omitempty"` - - - // EndOffsetSeconds - Actual end offset in seconds relative to query start time - EndOffsetSeconds *int `json:"endOffsetSeconds,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Historicaladherenceactuals) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/historicaladherencedaymetrics.go b/build/platformclientv2/historicaladherencedaymetrics.go deleted file mode 100644 index e70f74424..000000000 --- a/build/platformclientv2/historicaladherencedaymetrics.go +++ /dev/null @@ -1,57 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Historicaladherencedaymetrics -type Historicaladherencedaymetrics struct { - // DayStartOffsetSecs - Start of day offset in seconds relative to query start time - DayStartOffsetSecs *int `json:"dayStartOffsetSecs,omitempty"` - - - // AdherenceScheduleSecs - Duration of schedule in seconds included for adherence percentage calculation - AdherenceScheduleSecs *int `json:"adherenceScheduleSecs,omitempty"` - - - // ConformanceScheduleSecs - Total scheduled duration in seconds for OnQueue activities - ConformanceScheduleSecs *int `json:"conformanceScheduleSecs,omitempty"` - - - // ConformanceActualSecs - Total actually worked duration in seconds for OnQueue activities - ConformanceActualSecs *int `json:"conformanceActualSecs,omitempty"` - - - // ExceptionCount - Total number of adherence exceptions for this user - ExceptionCount *int `json:"exceptionCount,omitempty"` - - - // ExceptionDurationSecs - Total duration in seconds of adherence exceptions for this user - ExceptionDurationSecs *int `json:"exceptionDurationSecs,omitempty"` - - - // ImpactSeconds - The impact duration in seconds of current adherence state for this user - ImpactSeconds *int `json:"impactSeconds,omitempty"` - - - // ScheduleLengthSecs - Total duration in seconds for all scheduled activities - ScheduleLengthSecs *int `json:"scheduleLengthSecs,omitempty"` - - - // ActualLengthSecs - Total duration in seconds for all actually worked activities - ActualLengthSecs *int `json:"actualLengthSecs,omitempty"` - - - // AdherencePercentage - Total adherence percentage for this user, in the scale of 0 - 100 - AdherencePercentage *float64 `json:"adherencePercentage,omitempty"` - - - // ConformancePercentage - Total conformance percentage for this user, in the scale of 0 - 100. Conformance percentage can be greater than 100 when the actual on queue time is greater than the scheduled on queue time for the same period. - ConformancePercentage *float64 `json:"conformancePercentage,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Historicaladherencedaymetrics) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/historicaladherenceexceptioninfo.go b/build/platformclientv2/historicaladherenceexceptioninfo.go deleted file mode 100644 index 65a111c4d..000000000 --- a/build/platformclientv2/historicaladherenceexceptioninfo.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Historicaladherenceexceptioninfo -type Historicaladherenceexceptioninfo struct { - // StartOffsetSeconds - Exception start offset in seconds relative to query start time - StartOffsetSeconds *int `json:"startOffsetSeconds,omitempty"` - - - // EndOffsetSeconds - Exception end offset in seconds relative to query start time - EndOffsetSeconds *int `json:"endOffsetSeconds,omitempty"` - - - // ScheduledActivityCodeId - The ID of the scheduled activity for this user - ScheduledActivityCodeId *string `json:"scheduledActivityCodeId,omitempty"` - - - // ScheduledActivityCategory - Activity for which the user is scheduled - ScheduledActivityCategory *string `json:"scheduledActivityCategory,omitempty"` - - - // ActualActivityCategory - Activity for which the user is actually engaged - ActualActivityCategory *string `json:"actualActivityCategory,omitempty"` - - - // SystemPresence - Actual underlying system presence value - SystemPresence *string `json:"systemPresence,omitempty"` - - - // RoutingStatus - Actual underlying routing status, used to determine whether a user is actually in adherence when OnQueue - RoutingStatus *Routingstatus `json:"routingStatus,omitempty"` - - - // Impact - The impact of the current adherence state for this user - Impact *string `json:"impact,omitempty"` - - - // SecondaryPresenceLookupId - The lookup ID used to retrieve secondary status from map of lookup ID to corresponding secondary presence ID - SecondaryPresenceLookupId *string `json:"secondaryPresenceLookupId,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Historicaladherenceexceptioninfo) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/historicaladherencequeryresult.go b/build/platformclientv2/historicaladherencequeryresult.go deleted file mode 100644 index bb9d40124..000000000 --- a/build/platformclientv2/historicaladherencequeryresult.go +++ /dev/null @@ -1,50 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Historicaladherencequeryresult -type Historicaladherencequeryresult struct { - // UserId - The ID of the user for whom the adherence is queried - UserId *string `json:"userId,omitempty"` - - - // StartDate - Beginning of the date range that was queried, in ISO-8601 format - StartDate *time.Time `json:"startDate,omitempty"` - - - // EndDate - End of the date range that was queried, in ISO-8601 format. If it was not set, end date will be set to the queried time - EndDate *time.Time `json:"endDate,omitempty"` - - - // AdherencePercentage - Adherence percentage for this user, in the scale of 0 - 100 - AdherencePercentage *float64 `json:"adherencePercentage,omitempty"` - - - // ConformancePercentage - Conformance percentage for this user, in the scale of 0 - 100. Conformance percentage can be greater than 100 when the actual on queue time is greater than the scheduled on queue time for the same period. - ConformancePercentage *float64 `json:"conformancePercentage,omitempty"` - - - // Impact - The impact of the current adherence state for this user - Impact *string `json:"impact,omitempty"` - - - // ExceptionInfo - List of adherence exceptions for this user - ExceptionInfo *[]Historicaladherenceexceptioninfo `json:"exceptionInfo,omitempty"` - - - // DayMetrics - Adherence and conformance metrics for days in query range - DayMetrics *[]Historicaladherencedaymetrics `json:"dayMetrics,omitempty"` - - - // Actuals - List of actual activity with offset for this user - Actuals *[]Historicaladherenceactuals `json:"actuals,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Historicaladherencequeryresult) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/historyentry.go b/build/platformclientv2/historyentry.go deleted file mode 100644 index 1431acd91..000000000 --- a/build/platformclientv2/historyentry.go +++ /dev/null @@ -1,42 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Historyentry -type Historyentry struct { - // Action - The action performed - Action *string `json:"action,omitempty"` - - - // Resource - For actions performed not on the item itself, but on a sub-item, this field identifies the sub-item by name. For example, for actions performed on prompt resources, this will be the prompt resource name. - Resource *string `json:"resource,omitempty"` - - - // Timestamp - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - Timestamp *time.Time `json:"timestamp,omitempty"` - - - // User - User associated with this entry. - User *User `json:"user,omitempty"` - - - // Client - OAuth client associated with this entry. - Client *Domainentityref `json:"client,omitempty"` - - - // Version - Version *string `json:"version,omitempty"` - - - // Secure - Secure *bool `json:"secure,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Historyentry) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/historylisting.go b/build/platformclientv2/historylisting.go deleted file mode 100644 index bac0ec77e..000000000 --- a/build/platformclientv2/historylisting.go +++ /dev/null @@ -1,94 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Historylisting -type Historylisting struct { - // Id - Id *string `json:"id,omitempty"` - - - // Complete - Complete *bool `json:"complete,omitempty"` - - - // User - User *User `json:"user,omitempty"` - - - // Client - Client *Domainentityref `json:"client,omitempty"` - - - // ErrorMessage - ErrorMessage *string `json:"errorMessage,omitempty"` - - - // ErrorCode - ErrorCode *string `json:"errorCode,omitempty"` - - - // ErrorDetails - ErrorDetails *[]Detail `json:"errorDetails,omitempty"` - - - // ErrorMessageParams - ErrorMessageParams *map[string]string `json:"errorMessageParams,omitempty"` - - - // ActionName - Action name - ActionName *string `json:"actionName,omitempty"` - - - // ActionStatus - Action status - ActionStatus *string `json:"actionStatus,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Description - Description *string `json:"description,omitempty"` - - - // System - System *bool `json:"system,omitempty"` - - - // Started - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - Started *time.Time `json:"started,omitempty"` - - - // Completed - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - Completed *time.Time `json:"completed,omitempty"` - - - // Entities - Entities *[]Historyentry `json:"entities,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Historylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/homerrecord.go b/build/platformclientv2/homerrecord.go deleted file mode 100644 index dea3aa1b8..000000000 --- a/build/platformclientv2/homerrecord.go +++ /dev/null @@ -1,218 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Homerrecord -type Homerrecord struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Date - metadata associated to the SIP calls. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - Date *time.Time `json:"date,omitempty"` - - - // MilliTs - metadata associated to the SIP calls - MilliTs *string `json:"milliTs,omitempty"` - - - // MicroTs - metadata associated to the SIP calls - MicroTs *string `json:"microTs,omitempty"` - - - // Method - metadata associated to the SIP calls - Method *string `json:"method,omitempty"` - - - // ReplyReason - metadata associated to the SIP calls - ReplyReason *string `json:"replyReason,omitempty"` - - - // Ruri - metadata associated to the SIP calls - Ruri *string `json:"ruri,omitempty"` - - - // RuriUser - metadata associated to the SIP calls - RuriUser *string `json:"ruriUser,omitempty"` - - - // RuriDomain - metadata associated to the SIP calls - RuriDomain *string `json:"ruriDomain,omitempty"` - - - // FromUser - metadata associated to the SIP calls - FromUser *string `json:"fromUser,omitempty"` - - - // FromDomain - metadata associated to the SIP calls - FromDomain *string `json:"fromDomain,omitempty"` - - - // FromTag - metadata associated to the SIP calls - FromTag *string `json:"fromTag,omitempty"` - - - // ToUser - metadata associated to the SIP calls - ToUser *string `json:"toUser,omitempty"` - - - // ToDomain - metadata associated to the SIP calls - ToDomain *string `json:"toDomain,omitempty"` - - - // ToTag - metadata associated to the SIP calls - ToTag *string `json:"toTag,omitempty"` - - - // PidUser - metadata associated to the SIP calls - PidUser *string `json:"pidUser,omitempty"` - - - // ContactUser - metadata associated to the SIP calls - ContactUser *string `json:"contactUser,omitempty"` - - - // AuthUser - metadata associated to the SIP calls - AuthUser *string `json:"authUser,omitempty"` - - - // Callid - metadata associated to the SIP calls - Callid *string `json:"callid,omitempty"` - - - // CallidAleg - metadata associated to the SIP calls - CallidAleg *string `json:"callidAleg,omitempty"` - - - // Via1 - metadata associated to the SIP calls - Via1 *string `json:"via1,omitempty"` - - - // Via1Branch - metadata associated to the SIP calls - Via1Branch *string `json:"via1Branch,omitempty"` - - - // Cseq - metadata associated to the SIP calls - Cseq *string `json:"cseq,omitempty"` - - - // Diversion - metadata associated to the SIP calls - Diversion *string `json:"diversion,omitempty"` - - - // Reason - metadata associated to the SIP calls - Reason *string `json:"reason,omitempty"` - - - // ContentType - metadata associated to the SIP calls - ContentType *string `json:"contentType,omitempty"` - - - // Auth - metadata associated to the SIP calls - Auth *string `json:"auth,omitempty"` - - - // UserAgent - metadata associated to the SIP calls - UserAgent *string `json:"userAgent,omitempty"` - - - // SourceIp - metadata associated to the SIP calls - SourceIp *string `json:"sourceIp,omitempty"` - - - // SourcePort - metadata associated to the SIP calls - SourcePort *string `json:"sourcePort,omitempty"` - - - // DestinationIp - metadata associated to the SIP calls - DestinationIp *string `json:"destinationIp,omitempty"` - - - // DestinationPort - metadata associated to the SIP calls - DestinationPort *string `json:"destinationPort,omitempty"` - - - // ContactIp - metadata associated to the SIP calls - ContactIp *string `json:"contactIp,omitempty"` - - - // ContactPort - metadata associated to the SIP calls - ContactPort *string `json:"contactPort,omitempty"` - - - // OriginatorIp - metadata associated to the SIP calls - OriginatorIp *string `json:"originatorIp,omitempty"` - - - // OriginatorPort - metadata associated to the SIP calls - OriginatorPort *string `json:"originatorPort,omitempty"` - - - // CorrelationId - metadata associated to the SIP calls - CorrelationId *string `json:"correlationId,omitempty"` - - - // Proto - metadata associated to the SIP calls - Proto *string `json:"proto,omitempty"` - - - // Family - metadata associated to the SIP calls - Family *string `json:"family,omitempty"` - - - // RtpStat - metadata associated to the SIP calls - RtpStat *string `json:"rtpStat,omitempty"` - - - // VarType - metadata associated to the SIP calls - VarType *string `json:"type,omitempty"` - - - // Node - metadata associated to the SIP calls - Node *string `json:"node,omitempty"` - - - // Trans - metadata associated to the SIP calls - Trans *string `json:"trans,omitempty"` - - - // Dbnode - metadata associated to the SIP calls - Dbnode *string `json:"dbnode,omitempty"` - - - // Msg - metadata associated to the SIP calls - Msg *string `json:"msg,omitempty"` - - - // SourceAlias - metadata associated to the SIP calls - SourceAlias *string `json:"sourceAlias,omitempty"` - - - // DestinationAlias - metadata associated to the SIP calls - DestinationAlias *string `json:"destinationAlias,omitempty"` - - - // ConversationId - metadata associated to the SIP calls - ConversationId *string `json:"conversationId,omitempty"` - - - // ParticipantId - metadata associated to the SIP calls - ParticipantId *string `json:"participantId,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Homerrecord) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/identitynow.go b/build/platformclientv2/identitynow.go deleted file mode 100644 index c31cc9cf2..000000000 --- a/build/platformclientv2/identitynow.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Identitynow -type Identitynow struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Disabled - Disabled *bool `json:"disabled,omitempty"` - - - // IssuerURI - IssuerURI *string `json:"issuerURI,omitempty"` - - - // SsoTargetURI - SsoTargetURI *string `json:"ssoTargetURI,omitempty"` - - - // Certificate - Certificate *string `json:"certificate,omitempty"` - - - // Certificates - Certificates *[]string `json:"certificates,omitempty"` - - - // RelyingPartyIdentifier - RelyingPartyIdentifier *string `json:"relyingPartyIdentifier,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Identitynow) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/identityproviderapi.go b/build/platformclientv2/identityproviderapi.go deleted file mode 100644 index 2943e0c42..000000000 --- a/build/platformclientv2/identityproviderapi.go +++ /dev/null @@ -1,2262 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "encoding/json" -) - -// IdentityProviderApi provides functions for API endpoints -type IdentityProviderApi struct { - Configuration *Configuration -} - -// NewIdentityProviderApi creates an API instance using the default configuration -func NewIdentityProviderApi() *IdentityProviderApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating IdentityProviderApi with base path: %s", strings.ToLower(config.BasePath))) - return &IdentityProviderApi{ - Configuration: config, - } -} - -// NewIdentityProviderApiWithConfig creates an API instance using the provided configuration -func NewIdentityProviderApiWithConfig(config *Configuration) *IdentityProviderApi { - config.Debugf("Creating IdentityProviderApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &IdentityProviderApi{ - Configuration: config, - } -} - -// DeleteIdentityprovidersAdfs invokes DELETE /api/v2/identityproviders/adfs -// -// Delete ADFS Identity Provider -// -// -func (a IdentityProviderApi) DeleteIdentityprovidersAdfs() (*Empty, *APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/identityproviders/adfs" - defaultReturn := new(Empty) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Empty - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// DeleteIdentityprovidersCic invokes DELETE /api/v2/identityproviders/cic -// -// Delete Customer Interaction Center (CIC) Identity Provider -// -// -func (a IdentityProviderApi) DeleteIdentityprovidersCic() (*Empty, *APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/identityproviders/cic" - defaultReturn := new(Empty) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Empty - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// DeleteIdentityprovidersGeneric invokes DELETE /api/v2/identityproviders/generic -// -// Delete Generic SAML Identity Provider -// -// -func (a IdentityProviderApi) DeleteIdentityprovidersGeneric() (*Empty, *APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/identityproviders/generic" - defaultReturn := new(Empty) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Empty - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// DeleteIdentityprovidersGsuite invokes DELETE /api/v2/identityproviders/gsuite -// -// Delete G Suite Identity Provider -// -// -func (a IdentityProviderApi) DeleteIdentityprovidersGsuite() (*Empty, *APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/identityproviders/gsuite" - defaultReturn := new(Empty) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Empty - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// DeleteIdentityprovidersIdentitynow invokes DELETE /api/v2/identityproviders/identitynow -// -// Delete IdentityNow Provider -// -// -func (a IdentityProviderApi) DeleteIdentityprovidersIdentitynow() (*Empty, *APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/identityproviders/identitynow" - defaultReturn := new(Empty) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Empty - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// DeleteIdentityprovidersOkta invokes DELETE /api/v2/identityproviders/okta -// -// Delete Okta Identity Provider -// -// -func (a IdentityProviderApi) DeleteIdentityprovidersOkta() (*Empty, *APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/identityproviders/okta" - defaultReturn := new(Empty) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Empty - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// DeleteIdentityprovidersOnelogin invokes DELETE /api/v2/identityproviders/onelogin -// -// Delete OneLogin Identity Provider -// -// -func (a IdentityProviderApi) DeleteIdentityprovidersOnelogin() (*Empty, *APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/identityproviders/onelogin" - defaultReturn := new(Empty) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Empty - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// DeleteIdentityprovidersPing invokes DELETE /api/v2/identityproviders/ping -// -// Delete Ping Identity Provider -// -// -func (a IdentityProviderApi) DeleteIdentityprovidersPing() (*Empty, *APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/identityproviders/ping" - defaultReturn := new(Empty) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Empty - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// DeleteIdentityprovidersPurecloud invokes DELETE /api/v2/identityproviders/purecloud -// -// Delete PureCloud Identity Provider -// -// -func (a IdentityProviderApi) DeleteIdentityprovidersPurecloud() (*Empty, *APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/identityproviders/purecloud" - defaultReturn := new(Empty) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Empty - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// DeleteIdentityprovidersPureengage invokes DELETE /api/v2/identityproviders/pureengage -// -// Delete PureEngage Identity Provider -// -// -func (a IdentityProviderApi) DeleteIdentityprovidersPureengage() (*Empty, *APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/identityproviders/pureengage" - defaultReturn := new(Empty) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Empty - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// DeleteIdentityprovidersSalesforce invokes DELETE /api/v2/identityproviders/salesforce -// -// Delete Salesforce Identity Provider -// -// -func (a IdentityProviderApi) DeleteIdentityprovidersSalesforce() (*Empty, *APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/identityproviders/salesforce" - defaultReturn := new(Empty) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Empty - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetIdentityproviders invokes GET /api/v2/identityproviders -// -// The list of identity providers -// -// -func (a IdentityProviderApi) GetIdentityproviders() (*Oauthproviderentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/identityproviders" - defaultReturn := new(Oauthproviderentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Oauthproviderentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetIdentityprovidersAdfs invokes GET /api/v2/identityproviders/adfs -// -// Get ADFS Identity Provider -// -// -func (a IdentityProviderApi) GetIdentityprovidersAdfs() (*Adfs, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/identityproviders/adfs" - defaultReturn := new(Adfs) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Adfs - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetIdentityprovidersCic invokes GET /api/v2/identityproviders/cic -// -// Get Customer Interaction Center (CIC) Identity Provider -// -// -func (a IdentityProviderApi) GetIdentityprovidersCic() (*Customerinteractioncenter, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/identityproviders/cic" - defaultReturn := new(Customerinteractioncenter) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Customerinteractioncenter - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetIdentityprovidersGeneric invokes GET /api/v2/identityproviders/generic -// -// Get Generic SAML Identity Provider -// -// -func (a IdentityProviderApi) GetIdentityprovidersGeneric() (*Genericsaml, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/identityproviders/generic" - defaultReturn := new(Genericsaml) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Genericsaml - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetIdentityprovidersGsuite invokes GET /api/v2/identityproviders/gsuite -// -// Get G Suite Identity Provider -// -// -func (a IdentityProviderApi) GetIdentityprovidersGsuite() (*Gsuite, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/identityproviders/gsuite" - defaultReturn := new(Gsuite) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Gsuite - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetIdentityprovidersIdentitynow invokes GET /api/v2/identityproviders/identitynow -// -// Get IdentityNow Provider -// -// -func (a IdentityProviderApi) GetIdentityprovidersIdentitynow() (*Identitynow, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/identityproviders/identitynow" - defaultReturn := new(Identitynow) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Identitynow - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetIdentityprovidersOkta invokes GET /api/v2/identityproviders/okta -// -// Get Okta Identity Provider -// -// -func (a IdentityProviderApi) GetIdentityprovidersOkta() (*Okta, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/identityproviders/okta" - defaultReturn := new(Okta) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Okta - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetIdentityprovidersOnelogin invokes GET /api/v2/identityproviders/onelogin -// -// Get OneLogin Identity Provider -// -// -func (a IdentityProviderApi) GetIdentityprovidersOnelogin() (*Onelogin, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/identityproviders/onelogin" - defaultReturn := new(Onelogin) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Onelogin - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetIdentityprovidersPing invokes GET /api/v2/identityproviders/ping -// -// Get Ping Identity Provider -// -// -func (a IdentityProviderApi) GetIdentityprovidersPing() (*Pingidentity, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/identityproviders/ping" - defaultReturn := new(Pingidentity) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Pingidentity - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetIdentityprovidersPurecloud invokes GET /api/v2/identityproviders/purecloud -// -// Get PureCloud Identity Provider -// -// -func (a IdentityProviderApi) GetIdentityprovidersPurecloud() (*Purecloud, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/identityproviders/purecloud" - defaultReturn := new(Purecloud) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Purecloud - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetIdentityprovidersPureengage invokes GET /api/v2/identityproviders/pureengage -// -// Get PureEngage Identity Provider -// -// -func (a IdentityProviderApi) GetIdentityprovidersPureengage() (*Pureengage, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/identityproviders/pureengage" - defaultReturn := new(Pureengage) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Pureengage - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetIdentityprovidersSalesforce invokes GET /api/v2/identityproviders/salesforce -// -// Get Salesforce Identity Provider -// -// -func (a IdentityProviderApi) GetIdentityprovidersSalesforce() (*Salesforce, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/identityproviders/salesforce" - defaultReturn := new(Salesforce) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Salesforce - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutIdentityprovidersAdfs invokes PUT /api/v2/identityproviders/adfs -// -// Update/Create ADFS Identity Provider -// -// -func (a IdentityProviderApi) PutIdentityprovidersAdfs(body Adfs) (*Oauthprovider, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/identityproviders/adfs" - defaultReturn := new(Oauthprovider) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling IdentityProviderApi->PutIdentityprovidersAdfs") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Oauthprovider - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutIdentityprovidersCic invokes PUT /api/v2/identityproviders/cic -// -// Update/Create Customer Interaction Center (CIC) Identity Provider -// -// -func (a IdentityProviderApi) PutIdentityprovidersCic(body Customerinteractioncenter) (*Oauthprovider, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/identityproviders/cic" - defaultReturn := new(Oauthprovider) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling IdentityProviderApi->PutIdentityprovidersCic") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Oauthprovider - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutIdentityprovidersGeneric invokes PUT /api/v2/identityproviders/generic -// -// Update/Create Generic SAML Identity Provider -// -// -func (a IdentityProviderApi) PutIdentityprovidersGeneric(body Genericsaml) (*Oauthprovider, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/identityproviders/generic" - defaultReturn := new(Oauthprovider) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling IdentityProviderApi->PutIdentityprovidersGeneric") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Oauthprovider - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutIdentityprovidersGsuite invokes PUT /api/v2/identityproviders/gsuite -// -// Update/Create G Suite Identity Provider -// -// -func (a IdentityProviderApi) PutIdentityprovidersGsuite(body Gsuite) (*Oauthprovider, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/identityproviders/gsuite" - defaultReturn := new(Oauthprovider) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling IdentityProviderApi->PutIdentityprovidersGsuite") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Oauthprovider - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutIdentityprovidersIdentitynow invokes PUT /api/v2/identityproviders/identitynow -// -// Update/Create IdentityNow Provider -// -// -func (a IdentityProviderApi) PutIdentityprovidersIdentitynow(body Identitynow) (*Identitynow, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/identityproviders/identitynow" - defaultReturn := new(Identitynow) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling IdentityProviderApi->PutIdentityprovidersIdentitynow") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Identitynow - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutIdentityprovidersOkta invokes PUT /api/v2/identityproviders/okta -// -// Update/Create Okta Identity Provider -// -// -func (a IdentityProviderApi) PutIdentityprovidersOkta(body Okta) (*Oauthprovider, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/identityproviders/okta" - defaultReturn := new(Oauthprovider) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling IdentityProviderApi->PutIdentityprovidersOkta") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Oauthprovider - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutIdentityprovidersOnelogin invokes PUT /api/v2/identityproviders/onelogin -// -// Update/Create OneLogin Identity Provider -// -// -func (a IdentityProviderApi) PutIdentityprovidersOnelogin(body Onelogin) (*Oauthprovider, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/identityproviders/onelogin" - defaultReturn := new(Oauthprovider) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling IdentityProviderApi->PutIdentityprovidersOnelogin") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Oauthprovider - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutIdentityprovidersPing invokes PUT /api/v2/identityproviders/ping -// -// Update/Create Ping Identity Provider -// -// -func (a IdentityProviderApi) PutIdentityprovidersPing(body Pingidentity) (*Oauthprovider, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/identityproviders/ping" - defaultReturn := new(Oauthprovider) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling IdentityProviderApi->PutIdentityprovidersPing") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Oauthprovider - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutIdentityprovidersPurecloud invokes PUT /api/v2/identityproviders/purecloud -// -// Update/Create PureCloud Identity Provider -// -// -func (a IdentityProviderApi) PutIdentityprovidersPurecloud(body Purecloud) (*Oauthprovider, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/identityproviders/purecloud" - defaultReturn := new(Oauthprovider) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling IdentityProviderApi->PutIdentityprovidersPurecloud") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Oauthprovider - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutIdentityprovidersPureengage invokes PUT /api/v2/identityproviders/pureengage -// -// Update/Create PureEngage Identity Provider -// -// -func (a IdentityProviderApi) PutIdentityprovidersPureengage(body Pureengage) (*Oauthprovider, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/identityproviders/pureengage" - defaultReturn := new(Oauthprovider) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling IdentityProviderApi->PutIdentityprovidersPureengage") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Oauthprovider - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutIdentityprovidersSalesforce invokes PUT /api/v2/identityproviders/salesforce -// -// Update/Create Salesforce Identity Provider -// -// -func (a IdentityProviderApi) PutIdentityprovidersSalesforce(body Salesforce) (*Oauthprovider, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/identityproviders/salesforce" - defaultReturn := new(Oauthprovider) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling IdentityProviderApi->PutIdentityprovidersSalesforce") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Oauthprovider - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/ignoredactivitycategories.go b/build/platformclientv2/ignoredactivitycategories.go deleted file mode 100644 index 330bb15ae..000000000 --- a/build/platformclientv2/ignoredactivitycategories.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Ignoredactivitycategories -type Ignoredactivitycategories struct { - // Values - Activity categories list - Values *[]string `json:"values,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Ignoredactivitycategories) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/importscriptstatusresponse.go b/build/platformclientv2/importscriptstatusresponse.go deleted file mode 100644 index 7c4a20b96..000000000 --- a/build/platformclientv2/importscriptstatusresponse.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Importscriptstatusresponse -type Importscriptstatusresponse struct { - // Url - Url *string `json:"url,omitempty"` - - - // Succeeded - Succeeded *bool `json:"succeeded,omitempty"` - - - // Message - Message *string `json:"message,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Importscriptstatusresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/importstatus.go b/build/platformclientv2/importstatus.go deleted file mode 100644 index 19ea6c558..000000000 --- a/build/platformclientv2/importstatus.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Importstatus -type Importstatus struct { - // State - current status of the import - State *string `json:"state,omitempty"` - - - // TotalRecords - total number of records to be imported - TotalRecords *int `json:"totalRecords,omitempty"` - - - // CompletedRecords - number of records finished importing - CompletedRecords *int `json:"completedRecords,omitempty"` - - - // PercentComplete - percentage of records finished importing - PercentComplete *int `json:"percentComplete,omitempty"` - - - // FailureReason - if the import has failed, the reason for the failure - FailureReason *string `json:"failureReason,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Importstatus) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/inbounddomain.go b/build/platformclientv2/inbounddomain.go deleted file mode 100644 index a18d9ecf4..000000000 --- a/build/platformclientv2/inbounddomain.go +++ /dev/null @@ -1,41 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Inbounddomain -type Inbounddomain struct { - // Id - Unique Id of the domain such as: example.com - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // MxRecordStatus - Mx Record Status - MxRecordStatus *string `json:"mxRecordStatus,omitempty"` - - - // SubDomain - Indicates if this a PureCloud sub-domain. If true, then the appropriate DNS records are created for sending/receiving email. - SubDomain *bool `json:"subDomain,omitempty"` - - - // MailFromSettings - The DNS settings if the inbound domain is using a custom Mail From. These settings can only be used on InboundDomains where subDomain is false. - MailFromSettings *Mailfromresult `json:"mailFromSettings,omitempty"` - - - // CustomSMTPServer - The custom SMTP server integration to use when sending outbound emails from this domain. - CustomSMTPServer *Domainentityref `json:"customSMTPServer,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Inbounddomain) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/inbounddomainentitylisting.go b/build/platformclientv2/inbounddomainentitylisting.go deleted file mode 100644 index 545839c58..000000000 --- a/build/platformclientv2/inbounddomainentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Inbounddomainentitylisting -type Inbounddomainentitylisting struct { - // Entities - Entities *[]Inbounddomain `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Inbounddomainentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/inbounddomainpatchrequest.go b/build/platformclientv2/inbounddomainpatchrequest.go deleted file mode 100644 index 76eed1330..000000000 --- a/build/platformclientv2/inbounddomainpatchrequest.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Inbounddomainpatchrequest -type Inbounddomainpatchrequest struct { - // MailFromSettings - The DNS settings if the inbound domain is using a custom Mail From. These settings can only be used on InboundDomains where subDomain is false. - MailFromSettings *Mailfromresult `json:"mailFromSettings,omitempty"` - - - // CustomSMTPServer - The custom SMTP server integration to use when sending outbound emails from this domain. - CustomSMTPServer *Domainentityref `json:"customSMTPServer,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Inbounddomainpatchrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/inboundmessagerequest.go b/build/platformclientv2/inboundmessagerequest.go deleted file mode 100644 index 214fd104f..000000000 --- a/build/platformclientv2/inboundmessagerequest.go +++ /dev/null @@ -1,61 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Inboundmessagerequest -type Inboundmessagerequest struct { - // QueueId - The ID of the queue to use for routing the email conversation. This field is mutually exclusive with flowId - QueueId *string `json:"queueId,omitempty"` - - - // FlowId - The ID of the flow to use for routing email conversation. This field is mutually exclusive with queueId - FlowId *string `json:"flowId,omitempty"` - - - // Provider - The name of the provider that is sourcing the email such as Oracle, Salesforce, etc. - Provider *string `json:"provider,omitempty"` - - - // SkillIds - The list of skill ID's to use for routing. - SkillIds *[]string `json:"skillIds,omitempty"` - - - // LanguageId - The ID of the language to use for routing. - LanguageId *string `json:"languageId,omitempty"` - - - // Priority - The priority to assign to the conversation for routing. - Priority *int `json:"priority,omitempty"` - - - // Attributes - The list of attributes to associate with the customer participant. - Attributes *map[string]string `json:"attributes,omitempty"` - - - // ToAddress - The email address of the recipient of the email. - ToAddress *string `json:"toAddress,omitempty"` - - - // ToName - The name of the recipient of the email. - ToName *string `json:"toName,omitempty"` - - - // FromAddress - The email address of the sender of the email. - FromAddress *string `json:"fromAddress,omitempty"` - - - // FromName - The name of the sender of the email. - FromName *string `json:"fromName,omitempty"` - - - // Subject - The subject of the email - Subject *string `json:"subject,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Inboundmessagerequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/inboundroute.go b/build/platformclientv2/inboundroute.go deleted file mode 100644 index 47ab86b5a..000000000 --- a/build/platformclientv2/inboundroute.go +++ /dev/null @@ -1,69 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Inboundroute -type Inboundroute struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Pattern - The search pattern that the mailbox name should match. - Pattern *string `json:"pattern,omitempty"` - - - // Queue - The queue to route the emails to. - Queue *Domainentityref `json:"queue,omitempty"` - - - // Priority - The priority to use for routing. - Priority *int `json:"priority,omitempty"` - - - // Skills - The skills to use for routing. - Skills *[]Domainentityref `json:"skills,omitempty"` - - - // Language - The language to use for routing. - Language *Domainentityref `json:"language,omitempty"` - - - // FromName - The sender name to use for outgoing replies. - FromName *string `json:"fromName,omitempty"` - - - // FromEmail - The sender email to use for outgoing replies. - FromEmail *string `json:"fromEmail,omitempty"` - - - // Flow - The flow to use for processing the email. - Flow *Domainentityref `json:"flow,omitempty"` - - - // ReplyEmailAddress - The route to use for email replies. - ReplyEmailAddress **Queueemailaddress `json:"replyEmailAddress,omitempty"` - - - // AutoBcc - The recipients that should be automatically blind copied on outbound emails associated with this InboundRoute. - AutoBcc *[]Emailaddress `json:"autoBcc,omitempty"` - - - // SpamFlow - The flow to use for processing inbound emails that have been marked as spam. - SpamFlow *Domainentityref `json:"spamFlow,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Inboundroute) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/inboundrouteentitylisting.go b/build/platformclientv2/inboundrouteentitylisting.go deleted file mode 100644 index d36bb4dbf..000000000 --- a/build/platformclientv2/inboundrouteentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Inboundrouteentitylisting -type Inboundrouteentitylisting struct { - // Entities - Entities *[]Inboundroute `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Inboundrouteentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/initiatescreenrecording.go b/build/platformclientv2/initiatescreenrecording.go deleted file mode 100644 index b4bfc116a..000000000 --- a/build/platformclientv2/initiatescreenrecording.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Initiatescreenrecording -type Initiatescreenrecording struct { - // RecordACW - RecordACW *bool `json:"recordACW,omitempty"` - - - // ArchiveRetention - ArchiveRetention *Archiveretention `json:"archiveRetention,omitempty"` - - - // DeleteRetention - DeleteRetention *Deleteretention `json:"deleteRetention,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Initiatescreenrecording) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/integration.go b/build/platformclientv2/integration.go deleted file mode 100644 index 6eeebf934..000000000 --- a/build/platformclientv2/integration.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Integration - Details for an Integration -type Integration struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the integration, used to distinguish this integration from others of the same type. - Name *string `json:"name,omitempty"` - - - // IntegrationType - Type of the integration - IntegrationType *Integrationtype `json:"integrationType,omitempty"` - - - // Notes - Notes about the integration. - Notes *string `json:"notes,omitempty"` - - - // IntendedState - Configured state of the integration. - IntendedState *string `json:"intendedState,omitempty"` - - - // Config - Configuration information for the integration. - Config *Integrationconfigurationinfo `json:"config,omitempty"` - - - // ReportedState - Last reported status of the integration. - ReportedState *Integrationstatusinfo `json:"reportedState,omitempty"` - - - // Attributes - Read-only attributes for the integration. - Attributes *map[string]string `json:"attributes,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Integration) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/integrationaction.go b/build/platformclientv2/integrationaction.go deleted file mode 100644 index c0563eb1f..000000000 --- a/build/platformclientv2/integrationaction.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Integrationaction -type Integrationaction struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Integrationaction) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/integrationactionfields.go b/build/platformclientv2/integrationactionfields.go deleted file mode 100644 index ac0eedf6e..000000000 --- a/build/platformclientv2/integrationactionfields.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Integrationactionfields -type Integrationactionfields struct { - // IntegrationAction - Reference to the Integration Action to be used when integrationAction type is qualified - IntegrationAction *Integrationaction `json:"integrationAction,omitempty"` - - - // RequestMappings - Collection of Request Mappings to use - RequestMappings *[]Requestmapping `json:"requestMappings,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Integrationactionfields) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/integrationconfiguration.go b/build/platformclientv2/integrationconfiguration.go deleted file mode 100644 index 2db7f3c61..000000000 --- a/build/platformclientv2/integrationconfiguration.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Integrationconfiguration - Configuration for an Integration -type Integrationconfiguration struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the integration, used to distinguish this integration from others of the same type. - Name *string `json:"name,omitempty"` - - - // Version - Version number required for updates. - Version *int `json:"version,omitempty"` - - - // Properties - Key-value configuration settings described by the schema in the propertiesSchemaUri field. - Properties *map[string]interface{} `json:"properties,omitempty"` - - - // Advanced - Advanced configuration described by the schema in the advancedSchemaUri field. - Advanced *map[string]interface{} `json:"advanced,omitempty"` - - - // Notes - Notes about the integration. - Notes *string `json:"notes,omitempty"` - - - // Credentials - Credentials required by the integration. The required keys are indicated in the credentials property of the Integration Type - Credentials *map[string]Credentialinfo `json:"credentials,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Integrationconfiguration) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/integrationconfigurationinfo.go b/build/platformclientv2/integrationconfigurationinfo.go deleted file mode 100644 index 73ee0e732..000000000 --- a/build/platformclientv2/integrationconfigurationinfo.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Integrationconfigurationinfo - Configuration information for the integration -type Integrationconfigurationinfo struct { - // Current - The current, active configuration for the integration. - Current *Integrationconfiguration `json:"current,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Integrationconfigurationinfo) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/integrationentitylisting.go b/build/platformclientv2/integrationentitylisting.go deleted file mode 100644 index 648e2142c..000000000 --- a/build/platformclientv2/integrationentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Integrationentitylisting -type Integrationentitylisting struct { - // Entities - Entities *[]Integration `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Integrationentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/integrationevent.go b/build/platformclientv2/integrationevent.go deleted file mode 100644 index 3c7f91ecf..000000000 --- a/build/platformclientv2/integrationevent.go +++ /dev/null @@ -1,58 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Integrationevent - Describes an event that has happened related to an integration -type Integrationevent struct { - // Id - Unique ID for this event - Id *string `json:"id,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - - - // CorrelationId - Correlation ID for the event - CorrelationId *string `json:"correlationId,omitempty"` - - - // Timestamp - Time the event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - Timestamp *time.Time `json:"timestamp,omitempty"` - - - // Level - Indicates the severity of the event. - Level *string `json:"level,omitempty"` - - - // EventCode - A classification for the event. Suitable for programmatic searching, sorting, or filtering - EventCode *string `json:"eventCode,omitempty"` - - - // Message - Message indicating what happened - Message *Messageinfo `json:"message,omitempty"` - - - // Entities - Collection of entities affected by or pertaining to the event (e.g. a list of Integrations or Bridge connectors) - Entities *[]Evententity `json:"entities,omitempty"` - - - // ContextAttributes - Map of context attributes specific to this event. - ContextAttributes *map[string]string `json:"contextAttributes,omitempty"` - - - // DetailMessage - Message with additional details about the event. (e.g. an exception cause.) - DetailMessage *Messageinfo `json:"detailMessage,omitempty"` - - - // User - User that took an action that resulted in the event. - User *User `json:"user,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Integrationevent) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/integrationevententitylisting.go b/build/platformclientv2/integrationevententitylisting.go deleted file mode 100644 index 69aaff843..000000000 --- a/build/platformclientv2/integrationevententitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Integrationevententitylisting -type Integrationevententitylisting struct { - // Entities - Entities *[]Integrationevent `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Integrationevententitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/integrationexport.go b/build/platformclientv2/integrationexport.go deleted file mode 100644 index d1345f61b..000000000 --- a/build/platformclientv2/integrationexport.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Integrationexport -type Integrationexport struct { - // Integration - The aws-s3-recording-bulk-actions-integration that the policy uses for exports. - Integration *Domainentityref `json:"integration,omitempty"` - - - // ShouldExportScreenRecordings - True if the policy should export screen recordings in addition to the other conversation media. Default = true - ShouldExportScreenRecordings *bool `json:"shouldExportScreenRecordings,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Integrationexport) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/integrationsapi.go b/build/platformclientv2/integrationsapi.go deleted file mode 100644 index c95b233dc..000000000 --- a/build/platformclientv2/integrationsapi.go +++ /dev/null @@ -1,4840 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "encoding/json" -) - -// IntegrationsApi provides functions for API endpoints -type IntegrationsApi struct { - Configuration *Configuration -} - -// NewIntegrationsApi creates an API instance using the default configuration -func NewIntegrationsApi() *IntegrationsApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating IntegrationsApi with base path: %s", strings.ToLower(config.BasePath))) - return &IntegrationsApi{ - Configuration: config, - } -} - -// NewIntegrationsApiWithConfig creates an API instance using the provided configuration -func NewIntegrationsApiWithConfig(config *Configuration) *IntegrationsApi { - config.Debugf("Creating IntegrationsApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &IntegrationsApi{ - Configuration: config, - } -} - -// DeleteIntegration invokes DELETE /api/v2/integrations/{integrationId} -// -// Delete integration. -// -// -func (a IntegrationsApi) DeleteIntegration(integrationId string) (*Integration, *APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/integrations/{integrationId}" - path = strings.Replace(path, "{integrationId}", fmt.Sprintf("%v", integrationId), -1) - defaultReturn := new(Integration) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'integrationId' is set - if &integrationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'integrationId' when calling IntegrationsApi->DeleteIntegration") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Integration - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// DeleteIntegrationsAction invokes DELETE /api/v2/integrations/actions/{actionId} -// -// Delete an Action -// -// -func (a IntegrationsApi) DeleteIntegrationsAction(actionId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/integrations/actions/{actionId}" - path = strings.Replace(path, "{actionId}", fmt.Sprintf("%v", actionId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'actionId' is set - if &actionId == nil { - // - return nil, errors.New("Missing required parameter 'actionId' when calling IntegrationsApi->DeleteIntegrationsAction") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteIntegrationsActionDraft invokes DELETE /api/v2/integrations/actions/{actionId}/draft -// -// Delete a Draft -// -// -func (a IntegrationsApi) DeleteIntegrationsActionDraft(actionId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/integrations/actions/{actionId}/draft" - path = strings.Replace(path, "{actionId}", fmt.Sprintf("%v", actionId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'actionId' is set - if &actionId == nil { - // - return nil, errors.New("Missing required parameter 'actionId' when calling IntegrationsApi->DeleteIntegrationsActionDraft") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteIntegrationsCredential invokes DELETE /api/v2/integrations/credentials/{credentialId} -// -// Delete a set of credentials -// -// -func (a IntegrationsApi) DeleteIntegrationsCredential(credentialId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/integrations/credentials/{credentialId}" - path = strings.Replace(path, "{credentialId}", fmt.Sprintf("%v", credentialId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'credentialId' is set - if &credentialId == nil { - // - return nil, errors.New("Missing required parameter 'credentialId' when calling IntegrationsApi->DeleteIntegrationsCredential") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// GetIntegration invokes GET /api/v2/integrations/{integrationId} -// -// Get integration. -// -// -func (a IntegrationsApi) GetIntegration(integrationId string, pageSize int, pageNumber int, sortBy string, expand []string, nextPage string, previousPage string) (*Integration, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/integrations/{integrationId}" - path = strings.Replace(path, "{integrationId}", fmt.Sprintf("%v", integrationId), -1) - defaultReturn := new(Integration) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'integrationId' is set - if &integrationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'integrationId' when calling IntegrationsApi->GetIntegration") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(nextPage).(string); ok { - if str != "" { - queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) - } - } else { - queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(previousPage).(string); ok { - if str != "" { - queryParams["previousPage"] = a.Configuration.APIClient.ParameterToString(previousPage, collectionFormat) - } - } else { - queryParams["previousPage"] = a.Configuration.APIClient.ParameterToString(previousPage, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Integration - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetIntegrationConfigCurrent invokes GET /api/v2/integrations/{integrationId}/config/current -// -// Get integration configuration. -// -// -func (a IntegrationsApi) GetIntegrationConfigCurrent(integrationId string) (*Integrationconfiguration, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/integrations/{integrationId}/config/current" - path = strings.Replace(path, "{integrationId}", fmt.Sprintf("%v", integrationId), -1) - defaultReturn := new(Integrationconfiguration) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'integrationId' is set - if &integrationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'integrationId' when calling IntegrationsApi->GetIntegrationConfigCurrent") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Integrationconfiguration - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetIntegrations invokes GET /api/v2/integrations -// -// List integrations -// -// -func (a IntegrationsApi) GetIntegrations(pageSize int, pageNumber int, sortBy string, expand []string, nextPage string, previousPage string) (*Integrationentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/integrations" - defaultReturn := new(Integrationentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(nextPage).(string); ok { - if str != "" { - queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) - } - } else { - queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(previousPage).(string); ok { - if str != "" { - queryParams["previousPage"] = a.Configuration.APIClient.ParameterToString(previousPage, collectionFormat) - } - } else { - queryParams["previousPage"] = a.Configuration.APIClient.ParameterToString(previousPage, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Integrationentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetIntegrationsAction invokes GET /api/v2/integrations/actions/{actionId} -// -// Retrieves a single Action matching id. -// -// -func (a IntegrationsApi) GetIntegrationsAction(actionId string, expand string, includeConfig bool) (*Action, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/integrations/actions/{actionId}" - path = strings.Replace(path, "{actionId}", fmt.Sprintf("%v", actionId), -1) - defaultReturn := new(Action) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'actionId' is set - if &actionId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'actionId' when calling IntegrationsApi->GetIntegrationsAction") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(expand).(string); ok { - if str != "" { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(includeConfig).(string); ok { - if str != "" { - queryParams["includeConfig"] = a.Configuration.APIClient.ParameterToString(includeConfig, collectionFormat) - } - } else { - queryParams["includeConfig"] = a.Configuration.APIClient.ParameterToString(includeConfig, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Action - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetIntegrationsActionDraft invokes GET /api/v2/integrations/actions/{actionId}/draft -// -// Retrieve a Draft -// -// -func (a IntegrationsApi) GetIntegrationsActionDraft(actionId string, expand string, includeConfig bool) (*Action, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/integrations/actions/{actionId}/draft" - path = strings.Replace(path, "{actionId}", fmt.Sprintf("%v", actionId), -1) - defaultReturn := new(Action) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'actionId' is set - if &actionId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'actionId' when calling IntegrationsApi->GetIntegrationsActionDraft") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(expand).(string); ok { - if str != "" { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(includeConfig).(string); ok { - if str != "" { - queryParams["includeConfig"] = a.Configuration.APIClient.ParameterToString(includeConfig, collectionFormat) - } - } else { - queryParams["includeConfig"] = a.Configuration.APIClient.ParameterToString(includeConfig, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Action - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetIntegrationsActionDraftSchema invokes GET /api/v2/integrations/actions/{actionId}/draft/schemas/{fileName} -// -// Retrieve schema for a Draft based on filename. -// -// -func (a IntegrationsApi) GetIntegrationsActionDraftSchema(actionId string, fileName string) (*Jsonschemadocument, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/integrations/actions/{actionId}/draft/schemas/{fileName}" - path = strings.Replace(path, "{actionId}", fmt.Sprintf("%v", actionId), -1) - path = strings.Replace(path, "{fileName}", fmt.Sprintf("%v", fileName), -1) - defaultReturn := new(Jsonschemadocument) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'actionId' is set - if &actionId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'actionId' when calling IntegrationsApi->GetIntegrationsActionDraftSchema") - } - // verify the required parameter 'fileName' is set - if &fileName == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'fileName' when calling IntegrationsApi->GetIntegrationsActionDraftSchema") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Jsonschemadocument - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetIntegrationsActionDraftTemplate invokes GET /api/v2/integrations/actions/{actionId}/draft/templates/{fileName} -// -// Retrieve templates for a Draft based on filename. -// -// -func (a IntegrationsApi) GetIntegrationsActionDraftTemplate(actionId string, fileName string) (*string, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/integrations/actions/{actionId}/draft/templates/{fileName}" - path = strings.Replace(path, "{actionId}", fmt.Sprintf("%v", actionId), -1) - path = strings.Replace(path, "{fileName}", fmt.Sprintf("%v", fileName), -1) - defaultReturn := new(string) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'actionId' is set - if &actionId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'actionId' when calling IntegrationsApi->GetIntegrationsActionDraftTemplate") - } - // verify the required parameter 'fileName' is set - if &fileName == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'fileName' when calling IntegrationsApi->GetIntegrationsActionDraftTemplate") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "text/plain", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *string - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetIntegrationsActionDraftValidation invokes GET /api/v2/integrations/actions/{actionId}/draft/validation -// -// Validate current Draft configuration. -// -// -func (a IntegrationsApi) GetIntegrationsActionDraftValidation(actionId string) (*Draftvalidationresult, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/integrations/actions/{actionId}/draft/validation" - path = strings.Replace(path, "{actionId}", fmt.Sprintf("%v", actionId), -1) - defaultReturn := new(Draftvalidationresult) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'actionId' is set - if &actionId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'actionId' when calling IntegrationsApi->GetIntegrationsActionDraftValidation") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Draftvalidationresult - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetIntegrationsActionSchema invokes GET /api/v2/integrations/actions/{actionId}/schemas/{fileName} -// -// Retrieve schema for an action based on filename. -// -// -func (a IntegrationsApi) GetIntegrationsActionSchema(actionId string, fileName string) (*Jsonschemadocument, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/integrations/actions/{actionId}/schemas/{fileName}" - path = strings.Replace(path, "{actionId}", fmt.Sprintf("%v", actionId), -1) - path = strings.Replace(path, "{fileName}", fmt.Sprintf("%v", fileName), -1) - defaultReturn := new(Jsonschemadocument) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'actionId' is set - if &actionId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'actionId' when calling IntegrationsApi->GetIntegrationsActionSchema") - } - // verify the required parameter 'fileName' is set - if &fileName == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'fileName' when calling IntegrationsApi->GetIntegrationsActionSchema") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Jsonschemadocument - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetIntegrationsActionTemplate invokes GET /api/v2/integrations/actions/{actionId}/templates/{fileName} -// -// Retrieve text of templates for an action based on filename. -// -// -func (a IntegrationsApi) GetIntegrationsActionTemplate(actionId string, fileName string) (*string, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/integrations/actions/{actionId}/templates/{fileName}" - path = strings.Replace(path, "{actionId}", fmt.Sprintf("%v", actionId), -1) - path = strings.Replace(path, "{fileName}", fmt.Sprintf("%v", fileName), -1) - defaultReturn := new(string) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'actionId' is set - if &actionId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'actionId' when calling IntegrationsApi->GetIntegrationsActionTemplate") - } - // verify the required parameter 'fileName' is set - if &fileName == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'fileName' when calling IntegrationsApi->GetIntegrationsActionTemplate") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "text/plain", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *string - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetIntegrationsActions invokes GET /api/v2/integrations/actions -// -// Retrieves all actions associated with filters passed in via query param. -// -// -func (a IntegrationsApi) GetIntegrationsActions(pageSize int, pageNumber int, nextPage string, previousPage string, sortBy string, sortOrder string, category string, name string, secure string, includeAuthActions string) (*Actionentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/integrations/actions" - defaultReturn := new(Actionentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(nextPage).(string); ok { - if str != "" { - queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) - } - } else { - queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(previousPage).(string); ok { - if str != "" { - queryParams["previousPage"] = a.Configuration.APIClient.ParameterToString(previousPage, collectionFormat) - } - } else { - queryParams["previousPage"] = a.Configuration.APIClient.ParameterToString(previousPage, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(category).(string); ok { - if str != "" { - queryParams["category"] = a.Configuration.APIClient.ParameterToString(category, collectionFormat) - } - } else { - queryParams["category"] = a.Configuration.APIClient.ParameterToString(category, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(secure).(string); ok { - if str != "" { - queryParams["secure"] = a.Configuration.APIClient.ParameterToString(secure, collectionFormat) - } - } else { - queryParams["secure"] = a.Configuration.APIClient.ParameterToString(secure, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(includeAuthActions).(string); ok { - if str != "" { - queryParams["includeAuthActions"] = a.Configuration.APIClient.ParameterToString(includeAuthActions, collectionFormat) - } - } else { - queryParams["includeAuthActions"] = a.Configuration.APIClient.ParameterToString(includeAuthActions, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Actionentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetIntegrationsActionsCategories invokes GET /api/v2/integrations/actions/categories -// -// Retrieves all categories of available Actions -// -// -func (a IntegrationsApi) GetIntegrationsActionsCategories(pageSize int, pageNumber int, nextPage string, previousPage string, sortBy string, sortOrder string, secure string) (*Categoryentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/integrations/actions/categories" - defaultReturn := new(Categoryentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(nextPage).(string); ok { - if str != "" { - queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) - } - } else { - queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(previousPage).(string); ok { - if str != "" { - queryParams["previousPage"] = a.Configuration.APIClient.ParameterToString(previousPage, collectionFormat) - } - } else { - queryParams["previousPage"] = a.Configuration.APIClient.ParameterToString(previousPage, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(secure).(string); ok { - if str != "" { - queryParams["secure"] = a.Configuration.APIClient.ParameterToString(secure, collectionFormat) - } - } else { - queryParams["secure"] = a.Configuration.APIClient.ParameterToString(secure, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Categoryentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetIntegrationsActionsDrafts invokes GET /api/v2/integrations/actions/drafts -// -// Retrieves all action drafts associated with the filters passed in via query param. -// -// -func (a IntegrationsApi) GetIntegrationsActionsDrafts(pageSize int, pageNumber int, nextPage string, previousPage string, sortBy string, sortOrder string, category string, name string, secure string, includeAuthActions string) (*Actionentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/integrations/actions/drafts" - defaultReturn := new(Actionentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(nextPage).(string); ok { - if str != "" { - queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) - } - } else { - queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(previousPage).(string); ok { - if str != "" { - queryParams["previousPage"] = a.Configuration.APIClient.ParameterToString(previousPage, collectionFormat) - } - } else { - queryParams["previousPage"] = a.Configuration.APIClient.ParameterToString(previousPage, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(category).(string); ok { - if str != "" { - queryParams["category"] = a.Configuration.APIClient.ParameterToString(category, collectionFormat) - } - } else { - queryParams["category"] = a.Configuration.APIClient.ParameterToString(category, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(secure).(string); ok { - if str != "" { - queryParams["secure"] = a.Configuration.APIClient.ParameterToString(secure, collectionFormat) - } - } else { - queryParams["secure"] = a.Configuration.APIClient.ParameterToString(secure, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(includeAuthActions).(string); ok { - if str != "" { - queryParams["includeAuthActions"] = a.Configuration.APIClient.ParameterToString(includeAuthActions, collectionFormat) - } - } else { - queryParams["includeAuthActions"] = a.Configuration.APIClient.ParameterToString(includeAuthActions, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Actionentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetIntegrationsClientapps invokes GET /api/v2/integrations/clientapps -// -// List permitted client app integrations for the logged in user -// -// -func (a IntegrationsApi) GetIntegrationsClientapps(pageSize int, pageNumber int, sortBy string, expand []string, nextPage string, previousPage string) (*Clientappentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/integrations/clientapps" - defaultReturn := new(Clientappentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(nextPage).(string); ok { - if str != "" { - queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) - } - } else { - queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(previousPage).(string); ok { - if str != "" { - queryParams["previousPage"] = a.Configuration.APIClient.ParameterToString(previousPage, collectionFormat) - } - } else { - queryParams["previousPage"] = a.Configuration.APIClient.ParameterToString(previousPage, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Clientappentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetIntegrationsCredential invokes GET /api/v2/integrations/credentials/{credentialId} -// -// Get a single credential with sensitive fields redacted -// -// -func (a IntegrationsApi) GetIntegrationsCredential(credentialId string) (*Credential, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/integrations/credentials/{credentialId}" - path = strings.Replace(path, "{credentialId}", fmt.Sprintf("%v", credentialId), -1) - defaultReturn := new(Credential) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'credentialId' is set - if &credentialId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'credentialId' when calling IntegrationsApi->GetIntegrationsCredential") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Credential - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetIntegrationsCredentials invokes GET /api/v2/integrations/credentials -// -// List multiple sets of credentials -// -// -func (a IntegrationsApi) GetIntegrationsCredentials(pageNumber int, pageSize int) (*Credentialinfolisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/integrations/credentials" - defaultReturn := new(Credentialinfolisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Credentialinfolisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetIntegrationsCredentialsTypes invokes GET /api/v2/integrations/credentials/types -// -// List all credential types -// -// -func (a IntegrationsApi) GetIntegrationsCredentialsTypes() (*Credentialtypelisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/integrations/credentials/types" - defaultReturn := new(Credentialtypelisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Credentialtypelisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetIntegrationsEventlog invokes GET /api/v2/integrations/eventlog -// -// List all events -// -// -func (a IntegrationsApi) GetIntegrationsEventlog(pageSize int, pageNumber int, sortBy string, sortOrder string, entityId string) (*Integrationevententitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/integrations/eventlog" - defaultReturn := new(Integrationevententitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(entityId).(string); ok { - if str != "" { - queryParams["entityId"] = a.Configuration.APIClient.ParameterToString(entityId, collectionFormat) - } - } else { - queryParams["entityId"] = a.Configuration.APIClient.ParameterToString(entityId, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Integrationevententitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetIntegrationsEventlogEventId invokes GET /api/v2/integrations/eventlog/{eventId} -// -// Get a single event -// -// -func (a IntegrationsApi) GetIntegrationsEventlogEventId(eventId string) (*Integrationevent, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/integrations/eventlog/{eventId}" - path = strings.Replace(path, "{eventId}", fmt.Sprintf("%v", eventId), -1) - defaultReturn := new(Integrationevent) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'eventId' is set - if &eventId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'eventId' when calling IntegrationsApi->GetIntegrationsEventlogEventId") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Integrationevent - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetIntegrationsSpeechDialogflowAgent invokes GET /api/v2/integrations/speech/dialogflow/agents/{agentId} -// -// Get details about a Dialogflow agent -// -// -func (a IntegrationsApi) GetIntegrationsSpeechDialogflowAgent(agentId string) (*Dialogflowagent, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/integrations/speech/dialogflow/agents/{agentId}" - path = strings.Replace(path, "{agentId}", fmt.Sprintf("%v", agentId), -1) - defaultReturn := new(Dialogflowagent) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'agentId' is set - if &agentId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'agentId' when calling IntegrationsApi->GetIntegrationsSpeechDialogflowAgent") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Dialogflowagent - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetIntegrationsSpeechDialogflowAgents invokes GET /api/v2/integrations/speech/dialogflow/agents -// -// Get a list of Dialogflow agents in the customers' Google accounts -// -// -func (a IntegrationsApi) GetIntegrationsSpeechDialogflowAgents(pageNumber int, pageSize int, name string) (*Dialogflowagentsummaryentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/integrations/speech/dialogflow/agents" - defaultReturn := new(Dialogflowagentsummaryentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Dialogflowagentsummaryentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetIntegrationsSpeechLexBotAlias invokes GET /api/v2/integrations/speech/lex/bot/alias/{aliasId} -// -// Get details about a Lex bot alias -// -// -func (a IntegrationsApi) GetIntegrationsSpeechLexBotAlias(aliasId string) (*Lexbotalias, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/integrations/speech/lex/bot/alias/{aliasId}" - path = strings.Replace(path, "{aliasId}", fmt.Sprintf("%v", aliasId), -1) - defaultReturn := new(Lexbotalias) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'aliasId' is set - if &aliasId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'aliasId' when calling IntegrationsApi->GetIntegrationsSpeechLexBotAlias") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Lexbotalias - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetIntegrationsSpeechLexBotBotIdAliases invokes GET /api/v2/integrations/speech/lex/bot/{botId}/aliases -// -// Get a list of aliases for a bot in the customer's AWS accounts -// -// -func (a IntegrationsApi) GetIntegrationsSpeechLexBotBotIdAliases(botId string, pageNumber int, pageSize int, status string, name string) (*Lexbotaliasentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/integrations/speech/lex/bot/{botId}/aliases" - path = strings.Replace(path, "{botId}", fmt.Sprintf("%v", botId), -1) - defaultReturn := new(Lexbotaliasentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'botId' is set - if &botId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'botId' when calling IntegrationsApi->GetIntegrationsSpeechLexBotBotIdAliases") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(status).(string); ok { - if str != "" { - queryParams["status"] = a.Configuration.APIClient.ParameterToString(status, collectionFormat) - } - } else { - queryParams["status"] = a.Configuration.APIClient.ParameterToString(status, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Lexbotaliasentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetIntegrationsSpeechLexBots invokes GET /api/v2/integrations/speech/lex/bots -// -// Get a list of Lex bots in the customers' AWS accounts -// -// -func (a IntegrationsApi) GetIntegrationsSpeechLexBots(pageNumber int, pageSize int, name string) (*Lexbotentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/integrations/speech/lex/bots" - defaultReturn := new(Lexbotentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Lexbotentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetIntegrationsSpeechTtsEngine invokes GET /api/v2/integrations/speech/tts/engines/{engineId} -// -// Get details about a TTS engine -// -// -func (a IntegrationsApi) GetIntegrationsSpeechTtsEngine(engineId string, includeVoices bool) (*Ttsengineentity, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/integrations/speech/tts/engines/{engineId}" - path = strings.Replace(path, "{engineId}", fmt.Sprintf("%v", engineId), -1) - defaultReturn := new(Ttsengineentity) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'engineId' is set - if &engineId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'engineId' when calling IntegrationsApi->GetIntegrationsSpeechTtsEngine") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(includeVoices).(string); ok { - if str != "" { - queryParams["includeVoices"] = a.Configuration.APIClient.ParameterToString(includeVoices, collectionFormat) - } - } else { - queryParams["includeVoices"] = a.Configuration.APIClient.ParameterToString(includeVoices, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Ttsengineentity - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetIntegrationsSpeechTtsEngineVoice invokes GET /api/v2/integrations/speech/tts/engines/{engineId}/voices/{voiceId} -// -// Get details about a specific voice for a TTS engine -// -// -func (a IntegrationsApi) GetIntegrationsSpeechTtsEngineVoice(engineId string, voiceId string) (*Ttsvoiceentity, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/integrations/speech/tts/engines/{engineId}/voices/{voiceId}" - path = strings.Replace(path, "{engineId}", fmt.Sprintf("%v", engineId), -1) - path = strings.Replace(path, "{voiceId}", fmt.Sprintf("%v", voiceId), -1) - defaultReturn := new(Ttsvoiceentity) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'engineId' is set - if &engineId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'engineId' when calling IntegrationsApi->GetIntegrationsSpeechTtsEngineVoice") - } - // verify the required parameter 'voiceId' is set - if &voiceId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'voiceId' when calling IntegrationsApi->GetIntegrationsSpeechTtsEngineVoice") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Ttsvoiceentity - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetIntegrationsSpeechTtsEngineVoices invokes GET /api/v2/integrations/speech/tts/engines/{engineId}/voices -// -// Get a list of voices for a TTS engine -// -// -func (a IntegrationsApi) GetIntegrationsSpeechTtsEngineVoices(engineId string, pageNumber int, pageSize int) (*Ttsvoiceentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/integrations/speech/tts/engines/{engineId}/voices" - path = strings.Replace(path, "{engineId}", fmt.Sprintf("%v", engineId), -1) - defaultReturn := new(Ttsvoiceentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'engineId' is set - if &engineId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'engineId' when calling IntegrationsApi->GetIntegrationsSpeechTtsEngineVoices") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Ttsvoiceentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetIntegrationsSpeechTtsEngines invokes GET /api/v2/integrations/speech/tts/engines -// -// Get a list of TTS engines enabled for org -// -// -func (a IntegrationsApi) GetIntegrationsSpeechTtsEngines(pageNumber int, pageSize int, includeVoices bool, name string, language string) (*Ttsengineentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/integrations/speech/tts/engines" - defaultReturn := new(Ttsengineentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(includeVoices).(string); ok { - if str != "" { - queryParams["includeVoices"] = a.Configuration.APIClient.ParameterToString(includeVoices, collectionFormat) - } - } else { - queryParams["includeVoices"] = a.Configuration.APIClient.ParameterToString(includeVoices, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(language).(string); ok { - if str != "" { - queryParams["language"] = a.Configuration.APIClient.ParameterToString(language, collectionFormat) - } - } else { - queryParams["language"] = a.Configuration.APIClient.ParameterToString(language, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Ttsengineentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetIntegrationsSpeechTtsSettings invokes GET /api/v2/integrations/speech/tts/settings -// -// Get TTS settings for an org -// -// -func (a IntegrationsApi) GetIntegrationsSpeechTtsSettings() (*Ttssettings, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/integrations/speech/tts/settings" - defaultReturn := new(Ttssettings) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Ttssettings - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetIntegrationsType invokes GET /api/v2/integrations/types/{typeId} -// -// Get integration type. -// -// -func (a IntegrationsApi) GetIntegrationsType(typeId string) (*Integrationtype, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/integrations/types/{typeId}" - path = strings.Replace(path, "{typeId}", fmt.Sprintf("%v", typeId), -1) - defaultReturn := new(Integrationtype) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'typeId' is set - if &typeId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'typeId' when calling IntegrationsApi->GetIntegrationsType") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Integrationtype - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetIntegrationsTypeConfigschema invokes GET /api/v2/integrations/types/{typeId}/configschemas/{configType} -// -// Get properties config schema for an integration type. -// -// -func (a IntegrationsApi) GetIntegrationsTypeConfigschema(typeId string, configType string) (*Jsonschemadocument, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/integrations/types/{typeId}/configschemas/{configType}" - path = strings.Replace(path, "{typeId}", fmt.Sprintf("%v", typeId), -1) - path = strings.Replace(path, "{configType}", fmt.Sprintf("%v", configType), -1) - defaultReturn := new(Jsonschemadocument) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'typeId' is set - if &typeId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'typeId' when calling IntegrationsApi->GetIntegrationsTypeConfigschema") - } - // verify the required parameter 'configType' is set - if &configType == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'configType' when calling IntegrationsApi->GetIntegrationsTypeConfigschema") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Jsonschemadocument - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetIntegrationsTypes invokes GET /api/v2/integrations/types -// -// List integration types -// -// -func (a IntegrationsApi) GetIntegrationsTypes(pageSize int, pageNumber int, sortBy string, expand []string, nextPage string, previousPage string) (*Integrationtypeentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/integrations/types" - defaultReturn := new(Integrationtypeentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(nextPage).(string); ok { - if str != "" { - queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) - } - } else { - queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(previousPage).(string); ok { - if str != "" { - queryParams["previousPage"] = a.Configuration.APIClient.ParameterToString(previousPage, collectionFormat) - } - } else { - queryParams["previousPage"] = a.Configuration.APIClient.ParameterToString(previousPage, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Integrationtypeentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetIntegrationsUserapps invokes GET /api/v2/integrations/userapps -// -// List permitted user app integrations for the logged in user -// -// -func (a IntegrationsApi) GetIntegrationsUserapps(pageSize int, pageNumber int, sortBy string, expand []string, nextPage string, previousPage string, appHost string) (*Userappentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/integrations/userapps" - defaultReturn := new(Userappentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(nextPage).(string); ok { - if str != "" { - queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) - } - } else { - queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(previousPage).(string); ok { - if str != "" { - queryParams["previousPage"] = a.Configuration.APIClient.ParameterToString(previousPage, collectionFormat) - } - } else { - queryParams["previousPage"] = a.Configuration.APIClient.ParameterToString(previousPage, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(appHost).(string); ok { - if str != "" { - queryParams["appHost"] = a.Configuration.APIClient.ParameterToString(appHost, collectionFormat) - } - } else { - queryParams["appHost"] = a.Configuration.APIClient.ParameterToString(appHost, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Userappentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchIntegration invokes PATCH /api/v2/integrations/{integrationId} -// -// Update an integration. -// -// -func (a IntegrationsApi) PatchIntegration(integrationId string, body Integration, pageSize int, pageNumber int, sortBy string, expand []string, nextPage string, previousPage string) (*Integration, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/integrations/{integrationId}" - path = strings.Replace(path, "{integrationId}", fmt.Sprintf("%v", integrationId), -1) - defaultReturn := new(Integration) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'integrationId' is set - if &integrationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'integrationId' when calling IntegrationsApi->PatchIntegration") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(nextPage).(string); ok { - if str != "" { - queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) - } - } else { - queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(previousPage).(string); ok { - if str != "" { - queryParams["previousPage"] = a.Configuration.APIClient.ParameterToString(previousPage, collectionFormat) - } - } else { - queryParams["previousPage"] = a.Configuration.APIClient.ParameterToString(previousPage, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Integration - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchIntegrationsAction invokes PATCH /api/v2/integrations/actions/{actionId} -// -// Patch an Action -// -// -func (a IntegrationsApi) PatchIntegrationsAction(actionId string, body Updateactioninput) (*Action, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/integrations/actions/{actionId}" - path = strings.Replace(path, "{actionId}", fmt.Sprintf("%v", actionId), -1) - defaultReturn := new(Action) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'actionId' is set - if &actionId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'actionId' when calling IntegrationsApi->PatchIntegrationsAction") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling IntegrationsApi->PatchIntegrationsAction") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Action - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchIntegrationsActionDraft invokes PATCH /api/v2/integrations/actions/{actionId}/draft -// -// Update an existing Draft -// -// -func (a IntegrationsApi) PatchIntegrationsActionDraft(actionId string, body Updatedraftinput) (*Action, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/integrations/actions/{actionId}/draft" - path = strings.Replace(path, "{actionId}", fmt.Sprintf("%v", actionId), -1) - defaultReturn := new(Action) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'actionId' is set - if &actionId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'actionId' when calling IntegrationsApi->PatchIntegrationsActionDraft") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling IntegrationsApi->PatchIntegrationsActionDraft") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Action - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostIntegrations invokes POST /api/v2/integrations -// -// Create an integration. -// -// -func (a IntegrationsApi) PostIntegrations(body Createintegrationrequest) (*Integration, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/integrations" - defaultReturn := new(Integration) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Integration - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostIntegrationsActionDraft invokes POST /api/v2/integrations/actions/{actionId}/draft -// -// Create a new Draft from existing Action -// -// -func (a IntegrationsApi) PostIntegrationsActionDraft(actionId string) (*Action, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/integrations/actions/{actionId}/draft" - path = strings.Replace(path, "{actionId}", fmt.Sprintf("%v", actionId), -1) - defaultReturn := new(Action) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'actionId' is set - if &actionId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'actionId' when calling IntegrationsApi->PostIntegrationsActionDraft") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Action - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostIntegrationsActionDraftPublish invokes POST /api/v2/integrations/actions/{actionId}/draft/publish -// -// Publish a Draft and make it the active Action configuration -// -// -func (a IntegrationsApi) PostIntegrationsActionDraftPublish(actionId string, body Publishdraftinput) (*Action, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/integrations/actions/{actionId}/draft/publish" - path = strings.Replace(path, "{actionId}", fmt.Sprintf("%v", actionId), -1) - defaultReturn := new(Action) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'actionId' is set - if &actionId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'actionId' when calling IntegrationsApi->PostIntegrationsActionDraftPublish") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling IntegrationsApi->PostIntegrationsActionDraftPublish") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Action - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostIntegrationsActionDraftTest invokes POST /api/v2/integrations/actions/{actionId}/draft/test -// -// Test the execution of a draft. Responses will show execution steps broken out with intermediate results to help in debugging. -// -// -func (a IntegrationsApi) PostIntegrationsActionDraftTest(actionId string, body map[string]interface{}) (*Testexecutionresult, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/integrations/actions/{actionId}/draft/test" - path = strings.Replace(path, "{actionId}", fmt.Sprintf("%v", actionId), -1) - defaultReturn := new(Testexecutionresult) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'actionId' is set - if &actionId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'actionId' when calling IntegrationsApi->PostIntegrationsActionDraftTest") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling IntegrationsApi->PostIntegrationsActionDraftTest") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Testexecutionresult - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostIntegrationsActionExecute invokes POST /api/v2/integrations/actions/{actionId}/execute -// -// Execute Action and return response from 3rd party. Responses will follow the schemas defined on the Action for success and error. -// -// -func (a IntegrationsApi) PostIntegrationsActionExecute(actionId string, body map[string]interface{}) (*map[string]interface{}, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/integrations/actions/{actionId}/execute" - path = strings.Replace(path, "{actionId}", fmt.Sprintf("%v", actionId), -1) - defaultReturn := new(map[string]interface{}) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'actionId' is set - if &actionId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'actionId' when calling IntegrationsApi->PostIntegrationsActionExecute") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling IntegrationsApi->PostIntegrationsActionExecute") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *map[string]interface{} - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostIntegrationsActionTest invokes POST /api/v2/integrations/actions/{actionId}/test -// -// Test the execution of an action. Responses will show execution steps broken out with intermediate results to help in debugging. -// -// -func (a IntegrationsApi) PostIntegrationsActionTest(actionId string, body map[string]interface{}) (*Testexecutionresult, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/integrations/actions/{actionId}/test" - path = strings.Replace(path, "{actionId}", fmt.Sprintf("%v", actionId), -1) - defaultReturn := new(Testexecutionresult) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'actionId' is set - if &actionId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'actionId' when calling IntegrationsApi->PostIntegrationsActionTest") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling IntegrationsApi->PostIntegrationsActionTest") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Testexecutionresult - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostIntegrationsActions invokes POST /api/v2/integrations/actions -// -// Create a new Action -// -// -func (a IntegrationsApi) PostIntegrationsActions(body Postactioninput) (*Action, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/integrations/actions" - defaultReturn := new(Action) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling IntegrationsApi->PostIntegrationsActions") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Action - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostIntegrationsActionsDrafts invokes POST /api/v2/integrations/actions/drafts -// -// Create a new Draft -// -// -func (a IntegrationsApi) PostIntegrationsActionsDrafts(body Postactioninput) (*Action, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/integrations/actions/drafts" - defaultReturn := new(Action) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling IntegrationsApi->PostIntegrationsActionsDrafts") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Action - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostIntegrationsCredentials invokes POST /api/v2/integrations/credentials -// -// Create a set of credentials -// -// -func (a IntegrationsApi) PostIntegrationsCredentials(body Credential) (*Credentialinfo, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/integrations/credentials" - defaultReturn := new(Credentialinfo) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Credentialinfo - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostIntegrationsWorkforcemanagementVendorconnection invokes POST /api/v2/integrations/workforcemanagement/vendorconnection -// -// Add a vendor connection -// -// -func (a IntegrationsApi) PostIntegrationsWorkforcemanagementVendorconnection(body Vendorconnectionrequest) (*Useractioncategoryentitylisting, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/integrations/workforcemanagement/vendorconnection" - defaultReturn := new(Useractioncategoryentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Useractioncategoryentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutIntegrationConfigCurrent invokes PUT /api/v2/integrations/{integrationId}/config/current -// -// Update integration configuration. -// -// -func (a IntegrationsApi) PutIntegrationConfigCurrent(integrationId string, body Integrationconfiguration) (*Integrationconfiguration, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/integrations/{integrationId}/config/current" - path = strings.Replace(path, "{integrationId}", fmt.Sprintf("%v", integrationId), -1) - defaultReturn := new(Integrationconfiguration) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'integrationId' is set - if &integrationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'integrationId' when calling IntegrationsApi->PutIntegrationConfigCurrent") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Integrationconfiguration - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutIntegrationsCredential invokes PUT /api/v2/integrations/credentials/{credentialId} -// -// Update a set of credentials -// -// -func (a IntegrationsApi) PutIntegrationsCredential(credentialId string, body Credential) (*Credentialinfo, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/integrations/credentials/{credentialId}" - path = strings.Replace(path, "{credentialId}", fmt.Sprintf("%v", credentialId), -1) - defaultReturn := new(Credentialinfo) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'credentialId' is set - if &credentialId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'credentialId' when calling IntegrationsApi->PutIntegrationsCredential") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Credentialinfo - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutIntegrationsSpeechTtsSettings invokes PUT /api/v2/integrations/speech/tts/settings -// -// Update TTS settings for an org -// -// -func (a IntegrationsApi) PutIntegrationsSpeechTtsSettings(body Ttssettings) (*Ttssettings, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/integrations/speech/tts/settings" - defaultReturn := new(Ttssettings) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling IntegrationsApi->PutIntegrationsSpeechTtsSettings") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Ttssettings - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/integrationstatusinfo.go b/build/platformclientv2/integrationstatusinfo.go deleted file mode 100644 index aef660eea..000000000 --- a/build/platformclientv2/integrationstatusinfo.go +++ /dev/null @@ -1,30 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Integrationstatusinfo - Status information for an Integration. -type Integrationstatusinfo struct { - // Code - Machine-readable status as reported by the integration. - Code *string `json:"code,omitempty"` - - - // Effective - Localized, human-readable, effective status of the integration. - Effective *string `json:"effective,omitempty"` - - - // Detail - Localizable status details for the integration. - Detail *Messageinfo `json:"detail,omitempty"` - - - // LastUpdated - Date and time (in UTC) when the integration status (i.e. the code field) was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - LastUpdated *time.Time `json:"lastUpdated,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Integrationstatusinfo) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/integrationtype.go b/build/platformclientv2/integrationtype.go deleted file mode 100644 index 18a6ce6f1..000000000 --- a/build/platformclientv2/integrationtype.go +++ /dev/null @@ -1,109 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Integrationtype - Descriptor for a type of Integration. -type Integrationtype struct { - // Id - The ID of the integration type. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Description - Description of the integration type. - Description *string `json:"description,omitempty"` - - - // Provider - PureCloud provider of the integration type. - Provider *string `json:"provider,omitempty"` - - - // Category - Category describing the integration type. - Category *string `json:"category,omitempty"` - - - // Images - Collection of logos. - Images *[]Userimage `json:"images,omitempty"` - - - // ConfigPropertiesSchemaUri - URI of the schema describing the key-value properties needed to configure an integration of this type. - ConfigPropertiesSchemaUri *string `json:"configPropertiesSchemaUri,omitempty"` - - - // ConfigAdvancedSchemaUri - URI of the schema describing the advanced JSON document needed to configure an integration of this type. - ConfigAdvancedSchemaUri *string `json:"configAdvancedSchemaUri,omitempty"` - - - // HelpUri - URI of a page with more information about the integration type - HelpUri *string `json:"helpUri,omitempty"` - - - // TermsOfServiceUri - URI of a page with terms and conditions for the integration type - TermsOfServiceUri *string `json:"termsOfServiceUri,omitempty"` - - - // VendorName - Name of the vendor of this integration type - VendorName *string `json:"vendorName,omitempty"` - - - // VendorWebsiteUri - URI of the vendor's website - VendorWebsiteUri *string `json:"vendorWebsiteUri,omitempty"` - - - // MarketplaceUri - URI of the marketplace listing for this integration type - MarketplaceUri *string `json:"marketplaceUri,omitempty"` - - - // FaqUri - URI of frequently asked questions about the integration type - FaqUri *string `json:"faqUri,omitempty"` - - - // PrivacyPolicyUri - URI of a privacy policy for users of the integration type - PrivacyPolicyUri *string `json:"privacyPolicyUri,omitempty"` - - - // SupportContactUri - URI for vendor support - SupportContactUri *string `json:"supportContactUri,omitempty"` - - - // SalesContactUri - URI for vendor sales information - SalesContactUri *string `json:"salesContactUri,omitempty"` - - - // HelpLinks - List of links to additional help resources - HelpLinks *[]Helplink `json:"helpLinks,omitempty"` - - - // Credentials - Map of credentials for integrations of this type. The key is the name of a credential that can be provided in the credentials property of the integration configuration. - Credentials *map[string]Credentialspecification `json:"credentials,omitempty"` - - - // NonInstallable - Indicates if the integration type is installable or not. - NonInstallable *bool `json:"nonInstallable,omitempty"` - - - // MaxInstances - The maximum number of integration instances allowable for this integration type - MaxInstances *int `json:"maxInstances,omitempty"` - - - // UserPermissions - List of permissions required to permit user access to the integration type. - UserPermissions *[]string `json:"userPermissions,omitempty"` - - - // VendorOAuthClientIds - List of OAuth Client IDs that must be authorized when the integration is created. - VendorOAuthClientIds *[]string `json:"vendorOAuthClientIds,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Integrationtype) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/integrationtypeentitylisting.go b/build/platformclientv2/integrationtypeentitylisting.go deleted file mode 100644 index 9ad540204..000000000 --- a/build/platformclientv2/integrationtypeentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Integrationtypeentitylisting -type Integrationtypeentitylisting struct { - // Entities - Entities *[]Integrationtype `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Integrationtypeentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/intentdefinition.go b/build/platformclientv2/intentdefinition.go deleted file mode 100644 index 195c96e50..000000000 --- a/build/platformclientv2/intentdefinition.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Intentdefinition -type Intentdefinition struct { - // Name - The name of the intent. - Name *string `json:"name,omitempty"` - - - // EntityTypeBindings - The bindings for the named entity types used in this intent. - EntityTypeBindings *[]Namedentitytypebinding `json:"entityTypeBindings,omitempty"` - - - // Utterances - The utterances that act as training phrases for the intent. - Utterances *[]Nluutterance `json:"utterances,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Intentdefinition) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/intentfeedback.go b/build/platformclientv2/intentfeedback.go deleted file mode 100644 index a239124ce..000000000 --- a/build/platformclientv2/intentfeedback.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Intentfeedback -type Intentfeedback struct { - // Name - The name of the detected intent. - Name *string `json:"name,omitempty"` - - - // Probability - The probability of the detected intent. - Probability *float64 `json:"probability,omitempty"` - - - // Entities - The collection of named entities detected. - Entities *[]Detectednamedentity `json:"entities,omitempty"` - - - // Assessment - The assessment on the detection for feedback text. - Assessment *string `json:"assessment,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Intentfeedback) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/interactionstatsalert.go b/build/platformclientv2/interactionstatsalert.go deleted file mode 100644 index 4d07ad5ac..000000000 --- a/build/platformclientv2/interactionstatsalert.go +++ /dev/null @@ -1,82 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Interactionstatsalert -type Interactionstatsalert struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name of the rule that generated the alert - Name *string `json:"name,omitempty"` - - - // Dimension - The dimension of concern. - Dimension *string `json:"dimension,omitempty"` - - - // DimensionValue - The value of the dimension. - DimensionValue *string `json:"dimensionValue,omitempty"` - - - // Metric - The metric to be assessed. - Metric *string `json:"metric,omitempty"` - - - // MediaType - The media type. - MediaType *string `json:"mediaType,omitempty"` - - - // NumericRange - The comparison descriptor used against the metric's value. - NumericRange *string `json:"numericRange,omitempty"` - - - // Statistic - The statistic of concern for the metric. - Statistic *string `json:"statistic,omitempty"` - - - // Value - The threshold value. - Value *float64 `json:"value,omitempty"` - - - // RuleId - The id of the rule. - RuleId *string `json:"ruleId,omitempty"` - - - // Unread - Indicates if the alert has been read. - Unread *bool `json:"unread,omitempty"` - - - // StartDate - The date/time the alert was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartDate *time.Time `json:"startDate,omitempty"` - - - // EndDate - The date/time the owning rule exiting in alarm status. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - EndDate *time.Time `json:"endDate,omitempty"` - - - // NotificationUsers - The ids of users who were notified of alarm state change. - NotificationUsers *[]User `json:"notificationUsers,omitempty"` - - - // AlertTypes - A collection of notification methods. - AlertTypes *[]string `json:"alertTypes,omitempty"` - - - // RuleUri - RuleUri *string `json:"ruleUri,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Interactionstatsalert) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/interactionstatsalertcontainer.go b/build/platformclientv2/interactionstatsalertcontainer.go deleted file mode 100644 index 3935016dc..000000000 --- a/build/platformclientv2/interactionstatsalertcontainer.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Interactionstatsalertcontainer -type Interactionstatsalertcontainer struct { - // Entities - Entities *[]Interactionstatsalert `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Interactionstatsalertcontainer) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/interactionstatsrule.go b/build/platformclientv2/interactionstatsrule.go deleted file mode 100644 index 930900f70..000000000 --- a/build/platformclientv2/interactionstatsrule.go +++ /dev/null @@ -1,69 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Interactionstatsrule -type Interactionstatsrule struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name of the rule - Name *string `json:"name,omitempty"` - - - // Dimension - The dimension of concern. - Dimension *string `json:"dimension,omitempty"` - - - // DimensionValue - The value of the dimension. - DimensionValue *string `json:"dimensionValue,omitempty"` - - - // Metric - The metric to be assessed. - Metric *string `json:"metric,omitempty"` - - - // MediaType - The media type. - MediaType *string `json:"mediaType,omitempty"` - - - // NumericRange - The comparison descriptor used against the metric's value. - NumericRange *string `json:"numericRange,omitempty"` - - - // Statistic - The statistic of concern for the metric. - Statistic *string `json:"statistic,omitempty"` - - - // Value - The threshold value. - Value *float64 `json:"value,omitempty"` - - - // Enabled - Indicates if the rule is enabled. - Enabled *bool `json:"enabled,omitempty"` - - - // InAlarm - Indicates if the rule is in alarm state. - InAlarm *bool `json:"inAlarm,omitempty"` - - - // NotificationUsers - The ids of users who will be notified of alarm state change. - NotificationUsers *[]User `json:"notificationUsers,omitempty"` - - - // AlertTypes - A collection of notification methods. - AlertTypes *[]string `json:"alertTypes,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Interactionstatsrule) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/interactionstatsrulecontainer.go b/build/platformclientv2/interactionstatsrulecontainer.go deleted file mode 100644 index 8dac6df0e..000000000 --- a/build/platformclientv2/interactionstatsrulecontainer.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Interactionstatsrulecontainer -type Interactionstatsrulecontainer struct { - // Entities - Entities *[]Interactionstatsrule `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Interactionstatsrulecontainer) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/intradayperformancepredictiondata.go b/build/platformclientv2/intradayperformancepredictiondata.go deleted file mode 100644 index 48d09c007..000000000 --- a/build/platformclientv2/intradayperformancepredictiondata.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Intradayperformancepredictiondata -type Intradayperformancepredictiondata struct { - // ServiceLevelPercent - Percentage of interactions that meets service level target as defined in the matching service goal templates - ServiceLevelPercent *float64 `json:"serviceLevelPercent,omitempty"` - - - // AverageSpeedOfAnswerSeconds - Predicted average time in seconds it takes to answer an interaction once the interaction becomes available to be routed - AverageSpeedOfAnswerSeconds *float64 `json:"averageSpeedOfAnswerSeconds,omitempty"` - - - // OccupancyPercent - Percentage of on-queue time for all agents in this group that are occupied handling interactions - OccupancyPercent *float64 `json:"occupancyPercent,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Intradayperformancepredictiondata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/intradayplanninggrouprequest.go b/build/platformclientv2/intradayplanninggrouprequest.go deleted file mode 100644 index 76f694540..000000000 --- a/build/platformclientv2/intradayplanninggrouprequest.go +++ /dev/null @@ -1,30 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Intradayplanninggrouprequest -type Intradayplanninggrouprequest struct { - // BusinessUnitDate - Requested date in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd - BusinessUnitDate *time.Time `json:"businessUnitDate,omitempty"` - - - // Categories - The metric categories - Categories *[]string `json:"categories,omitempty"` - - - // PlanningGroupIds - The IDs of the planning groups for which to fetch data. Omitting or passing an empty list will return all available planning groups - PlanningGroupIds *[]string `json:"planningGroupIds,omitempty"` - - - // IntervalLengthMinutes - The period/interval in minutes for which to aggregate the data. Required, defaults to 15 - IntervalLengthMinutes *int `json:"intervalLengthMinutes,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Intradayplanninggrouprequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/ipaddressauthentication.go b/build/platformclientv2/ipaddressauthentication.go deleted file mode 100644 index cd77672d1..000000000 --- a/build/platformclientv2/ipaddressauthentication.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Ipaddressauthentication -type Ipaddressauthentication struct { - // NetworkWhitelist - NetworkWhitelist *[]string `json:"networkWhitelist,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Ipaddressauthentication) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/ipaddressrange.go b/build/platformclientv2/ipaddressrange.go deleted file mode 100644 index 10f408584..000000000 --- a/build/platformclientv2/ipaddressrange.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Ipaddressrange -type Ipaddressrange struct { - // Cidr - Cidr *string `json:"cidr,omitempty"` - - - // Service - Service *string `json:"service,omitempty"` - - - // Region - Region *string `json:"region,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Ipaddressrange) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/ipaddressrangelisting.go b/build/platformclientv2/ipaddressrangelisting.go deleted file mode 100644 index 3fb73113b..000000000 --- a/build/platformclientv2/ipaddressrangelisting.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Ipaddressrangelisting -type Ipaddressrangelisting struct { - // Entities - Entities *[]Ipaddressrange `json:"entities,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Ipaddressrangelisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/items.go b/build/platformclientv2/items.go deleted file mode 100644 index 7f27bf9c9..000000000 --- a/build/platformclientv2/items.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Items -type Items struct { - // VarType - VarType *string `json:"type,omitempty"` - - - // Pattern - Pattern *string `json:"pattern,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Items) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/itemvalidationlimits.go b/build/platformclientv2/itemvalidationlimits.go deleted file mode 100644 index 9b17645f3..000000000 --- a/build/platformclientv2/itemvalidationlimits.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Itemvalidationlimits -type Itemvalidationlimits struct { - // MinLength - A structure denoting the system-imposed minimum string length (for text-based core types) or numeric values (for number-based) core types. For example, the validationLimits for a text-based core type specify the min/max values for a minimum string length (minLength) constraint supplied by a schemaauthor on a text field. Similarly, the maxLength's min/max specifies maximum string length constraint supplied by a schema author for the same field. - MinLength *Minlength `json:"minLength,omitempty"` - - - // MaxLength - A structure denoting the system-imposed minimum and maximum string length (for text-based core types) or numeric values (for number-based) core types. For example, the validationLimits for a text-based core type specify the min/max values for a minimum string length (minLength) constraint supplied by a schemaauthor on a text field. Similarly, the maxLength's min/max specifies maximum string length constraint supplied by a schema author for the same field. - MaxLength *Maxlength `json:"maxLength,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Itemvalidationlimits) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/ivr.go b/build/platformclientv2/ivr.go deleted file mode 100644 index 4cfef3337..000000000 --- a/build/platformclientv2/ivr.go +++ /dev/null @@ -1,82 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Ivr - Defines the phone numbers, operating hours, and the Architect flows to execute for an IVR. -type Ivr struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the entity. - Name *string `json:"name,omitempty"` - - - // Description - The resource's description. - Description *string `json:"description,omitempty"` - - - // Version - The current version of the resource. - Version *int `json:"version,omitempty"` - - - // DateCreated - The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // ModifiedBy - The ID of the user that last modified the resource. - ModifiedBy *string `json:"modifiedBy,omitempty"` - - - // CreatedBy - The ID of the user that created the resource. - CreatedBy *string `json:"createdBy,omitempty"` - - - // State - Indicates if the resource is active, inactive, or deleted. - State *string `json:"state,omitempty"` - - - // ModifiedByApp - The application that last modified the resource. - ModifiedByApp *string `json:"modifiedByApp,omitempty"` - - - // CreatedByApp - The application that created the resource. - CreatedByApp *string `json:"createdByApp,omitempty"` - - - // Dnis - The phone number(s) to contact the IVR by. Each phone number must be unique and not in use by another resource. For example, a user and an iVR cannot have the same phone number. - Dnis *[]string `json:"dnis,omitempty"` - - - // OpenHoursFlow - The Architect flow to execute during the hours an organization is open. - OpenHoursFlow *Domainentityref `json:"openHoursFlow,omitempty"` - - - // ClosedHoursFlow - The Architect flow to execute during the hours an organization is closed. - ClosedHoursFlow *Domainentityref `json:"closedHoursFlow,omitempty"` - - - // HolidayHoursFlow - The Architect flow to execute during an organization's holiday hours. - HolidayHoursFlow *Domainentityref `json:"holidayHoursFlow,omitempty"` - - - // ScheduleGroup - The schedule group defining the open and closed hours for an organization. If this is provided, an open flow and a closed flow must be specified as well. - ScheduleGroup *Domainentityref `json:"scheduleGroup,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Ivr) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/ivrentitylisting.go b/build/platformclientv2/ivrentitylisting.go deleted file mode 100644 index 43f71abd4..000000000 --- a/build/platformclientv2/ivrentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Ivrentitylisting -type Ivrentitylisting struct { - // Entities - Entities *[]Ivr `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Ivrentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/journey.go b/build/platformclientv2/journey.go deleted file mode 100644 index d3241da2a..000000000 --- a/build/platformclientv2/journey.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Journey -type Journey struct { - // Patterns - A list of zero or more patterns to match. - Patterns *[]Journeypattern `json:"patterns,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Journey) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/journeyaction.go b/build/platformclientv2/journeyaction.go deleted file mode 100644 index cc598b5b8..000000000 --- a/build/platformclientv2/journeyaction.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Journeyaction -type Journeyaction struct { - // Id - The ID of an action from the Journey System (an action is spawned from an actionMap) - Id *string `json:"id,omitempty"` - - - // ActionMap - Details about the action map from the Journey System which triggered this action - ActionMap *Journeyactionmap `json:"actionMap,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Journeyaction) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/journeyactionmap.go b/build/platformclientv2/journeyactionmap.go deleted file mode 100644 index 73bd2f7b4..000000000 --- a/build/platformclientv2/journeyactionmap.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Journeyactionmap -type Journeyactionmap struct { - // Id - The ID of the actionMap in the Journey System which triggered this action - Id *string `json:"id,omitempty"` - - - // Version - The version number of the actionMap in the Journey System at the time this action was triggered - Version *int `json:"version,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Journeyactionmap) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/journeyaggregatedatacontainer.go b/build/platformclientv2/journeyaggregatedatacontainer.go deleted file mode 100644 index 860940843..000000000 --- a/build/platformclientv2/journeyaggregatedatacontainer.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Journeyaggregatedatacontainer -type Journeyaggregatedatacontainer struct { - // Group - A mapping from dimension to value - Group *map[string]string `json:"group,omitempty"` - - - // Data - Data *[]Statisticalresponse `json:"data,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Journeyaggregatedatacontainer) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/journeyaggregatequeryclause.go b/build/platformclientv2/journeyaggregatequeryclause.go deleted file mode 100644 index 9e78533c5..000000000 --- a/build/platformclientv2/journeyaggregatequeryclause.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Journeyaggregatequeryclause -type Journeyaggregatequeryclause struct { - // VarType - Boolean operation to apply to the provided predicates - VarType *string `json:"type,omitempty"` - - - // Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value). - Predicates *[]Journeyaggregatequerypredicate `json:"predicates,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Journeyaggregatequeryclause) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/journeyaggregatequeryfilter.go b/build/platformclientv2/journeyaggregatequeryfilter.go deleted file mode 100644 index d208e4081..000000000 --- a/build/platformclientv2/journeyaggregatequeryfilter.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Journeyaggregatequeryfilter -type Journeyaggregatequeryfilter struct { - // VarType - Boolean operation to apply to the provided predicates and clauses - VarType *string `json:"type,omitempty"` - - - // Clauses - Boolean 'and/or' logic with up to two-levels of nesting - Clauses *[]Journeyaggregatequeryclause `json:"clauses,omitempty"` - - - // Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value). - Predicates *[]Journeyaggregatequerypredicate `json:"predicates,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Journeyaggregatequeryfilter) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/journeyaggregatequerypredicate.go b/build/platformclientv2/journeyaggregatequerypredicate.go deleted file mode 100644 index 3aeb26fb2..000000000 --- a/build/platformclientv2/journeyaggregatequerypredicate.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Journeyaggregatequerypredicate -type Journeyaggregatequerypredicate struct { - // VarType - Optional type, can usually be inferred - VarType *string `json:"type,omitempty"` - - - // Dimension - Left hand side for dimension predicates - Dimension *string `json:"dimension,omitempty"` - - - // Operator - Optional operator, default is matches - Operator *string `json:"operator,omitempty"` - - - // Value - Right hand side for dimension predicates - Value *string `json:"value,omitempty"` - - - // VarRange - Right hand side for dimension predicates - VarRange *Numericrange `json:"range,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Journeyaggregatequerypredicate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/journeyaggregatequeryresponse.go b/build/platformclientv2/journeyaggregatequeryresponse.go deleted file mode 100644 index 5308efeb9..000000000 --- a/build/platformclientv2/journeyaggregatequeryresponse.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Journeyaggregatequeryresponse -type Journeyaggregatequeryresponse struct { - // Results - Results *[]Journeyaggregatedatacontainer `json:"results,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Journeyaggregatequeryresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/journeyaggregationquery.go b/build/platformclientv2/journeyaggregationquery.go deleted file mode 100644 index fb89b466d..000000000 --- a/build/platformclientv2/journeyaggregationquery.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Journeyaggregationquery -type Journeyaggregationquery struct { - // Interval - Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss - Interval *string `json:"interval,omitempty"` - - - // Granularity - Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H - Granularity *string `json:"granularity,omitempty"` - - - // TimeZone - Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London - TimeZone *string `json:"timeZone,omitempty"` - - - // GroupBy - Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group. - GroupBy *[]string `json:"groupBy,omitempty"` - - - // Filter - Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters - Filter *Journeyaggregatequeryfilter `json:"filter,omitempty"` - - - // Metrics - Behaves like a SQL SELECT clause. Only named metrics will be retrieved. - Metrics *[]string `json:"metrics,omitempty"` - - - // FlattenMultivaluedDimensions - Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c') - FlattenMultivaluedDimensions *bool `json:"flattenMultivaluedDimensions,omitempty"` - - - // Views - Custom derived metric views - Views *[]Journeyaggregationview `json:"views,omitempty"` - - - // AlternateTimeDimension - Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event. - AlternateTimeDimension *string `json:"alternateTimeDimension,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Journeyaggregationquery) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/journeyaggregationview.go b/build/platformclientv2/journeyaggregationview.go deleted file mode 100644 index 8cf574417..000000000 --- a/build/platformclientv2/journeyaggregationview.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Journeyaggregationview -type Journeyaggregationview struct { - // Target - Target metric name - Target *string `json:"target,omitempty"` - - - // Name - A unique name for this view. Must be distinct from other views and built-in metric names. - Name *string `json:"name,omitempty"` - - - // Function - Type of view you wish to create - Function *string `json:"function,omitempty"` - - - // VarRange - Range of numbers for slicing up data - VarRange *Aggregationrange `json:"range,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Journeyaggregationview) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/journeyapi.go b/build/platformclientv2/journeyapi.go deleted file mode 100644 index 5b75e170a..000000000 --- a/build/platformclientv2/journeyapi.go +++ /dev/null @@ -1,1939 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "encoding/json" -) - -// JourneyApi provides functions for API endpoints -type JourneyApi struct { - Configuration *Configuration -} - -// NewJourneyApi creates an API instance using the default configuration -func NewJourneyApi() *JourneyApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating JourneyApi with base path: %s", strings.ToLower(config.BasePath))) - return &JourneyApi{ - Configuration: config, - } -} - -// NewJourneyApiWithConfig creates an API instance using the provided configuration -func NewJourneyApiWithConfig(config *Configuration) *JourneyApi { - config.Debugf("Creating JourneyApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &JourneyApi{ - Configuration: config, - } -} - -// DeleteJourneyActionmap invokes DELETE /api/v2/journey/actionmaps/{actionMapId} -// -// Delete single action map. -// -// -func (a JourneyApi) DeleteJourneyActionmap(actionMapId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/journey/actionmaps/{actionMapId}" - path = strings.Replace(path, "{actionMapId}", fmt.Sprintf("%v", actionMapId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'actionMapId' is set - if &actionMapId == nil { - // - return nil, errors.New("Missing required parameter 'actionMapId' when calling JourneyApi->DeleteJourneyActionmap") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteJourneyActiontemplate invokes DELETE /api/v2/journey/actiontemplates/{actionTemplateId} -// -// Delete a single action template. -// -// -func (a JourneyApi) DeleteJourneyActiontemplate(actionTemplateId string, hardDelete bool) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/journey/actiontemplates/{actionTemplateId}" - path = strings.Replace(path, "{actionTemplateId}", fmt.Sprintf("%v", actionTemplateId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'actionTemplateId' is set - if &actionTemplateId == nil { - // - return nil, errors.New("Missing required parameter 'actionTemplateId' when calling JourneyApi->DeleteJourneyActiontemplate") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(hardDelete).(string); ok { - if str != "" { - queryParams["hardDelete"] = a.Configuration.APIClient.ParameterToString(hardDelete, collectionFormat) - } - } else { - queryParams["hardDelete"] = a.Configuration.APIClient.ParameterToString(hardDelete, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteJourneyOutcome invokes DELETE /api/v2/journey/outcomes/{outcomeId} -// -// Delete an outcome. -// -// -func (a JourneyApi) DeleteJourneyOutcome(outcomeId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/journey/outcomes/{outcomeId}" - path = strings.Replace(path, "{outcomeId}", fmt.Sprintf("%v", outcomeId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'outcomeId' is set - if &outcomeId == nil { - // - return nil, errors.New("Missing required parameter 'outcomeId' when calling JourneyApi->DeleteJourneyOutcome") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteJourneySegment invokes DELETE /api/v2/journey/segments/{segmentId} -// -// Delete a segment. -// -// -func (a JourneyApi) DeleteJourneySegment(segmentId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/journey/segments/{segmentId}" - path = strings.Replace(path, "{segmentId}", fmt.Sprintf("%v", segmentId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'segmentId' is set - if &segmentId == nil { - // - return nil, errors.New("Missing required parameter 'segmentId' when calling JourneyApi->DeleteJourneySegment") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// GetJourneyActionmap invokes GET /api/v2/journey/actionmaps/{actionMapId} -// -// Retrieve a single action map. -// -// -func (a JourneyApi) GetJourneyActionmap(actionMapId string) (*Actionmap, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/journey/actionmaps/{actionMapId}" - path = strings.Replace(path, "{actionMapId}", fmt.Sprintf("%v", actionMapId), -1) - defaultReturn := new(Actionmap) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'actionMapId' is set - if &actionMapId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'actionMapId' when calling JourneyApi->GetJourneyActionmap") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Actionmap - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetJourneyActionmaps invokes GET /api/v2/journey/actionmaps -// -// Retrieve all action maps. -// -// -func (a JourneyApi) GetJourneyActionmaps(pageNumber int, pageSize int, sortBy string, filterField string, filterValue string, actionMapIds []string) (*Actionmaplisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/journey/actionmaps" - defaultReturn := new(Actionmaplisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(filterField).(string); ok { - if str != "" { - queryParams["filterField"] = a.Configuration.APIClient.ParameterToString(filterField, collectionFormat) - } - } else { - queryParams["filterField"] = a.Configuration.APIClient.ParameterToString(filterField, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(filterValue).(string); ok { - if str != "" { - queryParams["filterValue"] = a.Configuration.APIClient.ParameterToString(filterValue, collectionFormat) - } - } else { - queryParams["filterValue"] = a.Configuration.APIClient.ParameterToString(filterValue, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range actionMapIds { - queryParams["actionMapIds"] = value - } - } else { - queryParams["actionMapIds"] = a.Configuration.APIClient.ParameterToString(actionMapIds, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Actionmaplisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetJourneyActiontarget invokes GET /api/v2/journey/actiontargets/{actionTargetId} -// -// Retrieve a single action target. -// -// -func (a JourneyApi) GetJourneyActiontarget(actionTargetId string) (*Actiontarget, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/journey/actiontargets/{actionTargetId}" - path = strings.Replace(path, "{actionTargetId}", fmt.Sprintf("%v", actionTargetId), -1) - defaultReturn := new(Actiontarget) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'actionTargetId' is set - if &actionTargetId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'actionTargetId' when calling JourneyApi->GetJourneyActiontarget") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Actiontarget - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetJourneyActiontargets invokes GET /api/v2/journey/actiontargets -// -// Retrieve all action targets. -// -// -func (a JourneyApi) GetJourneyActiontargets(pageNumber int, pageSize int) (*Actiontargetlisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/journey/actiontargets" - defaultReturn := new(Actiontargetlisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Actiontargetlisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetJourneyActiontemplate invokes GET /api/v2/journey/actiontemplates/{actionTemplateId} -// -// Retrieve a single action template. -// -// -func (a JourneyApi) GetJourneyActiontemplate(actionTemplateId string) (*Actiontemplate, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/journey/actiontemplates/{actionTemplateId}" - path = strings.Replace(path, "{actionTemplateId}", fmt.Sprintf("%v", actionTemplateId), -1) - defaultReturn := new(Actiontemplate) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'actionTemplateId' is set - if &actionTemplateId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'actionTemplateId' when calling JourneyApi->GetJourneyActiontemplate") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Actiontemplate - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetJourneyActiontemplates invokes GET /api/v2/journey/actiontemplates -// -// Retrieve all action templates. -// -// -func (a JourneyApi) GetJourneyActiontemplates(pageNumber int, pageSize int, sortBy string, mediaType string, state string) (*Actiontemplatelisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/journey/actiontemplates" - defaultReturn := new(Actiontemplatelisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(mediaType).(string); ok { - if str != "" { - queryParams["mediaType"] = a.Configuration.APIClient.ParameterToString(mediaType, collectionFormat) - } - } else { - queryParams["mediaType"] = a.Configuration.APIClient.ParameterToString(mediaType, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(state).(string); ok { - if str != "" { - queryParams["state"] = a.Configuration.APIClient.ParameterToString(state, collectionFormat) - } - } else { - queryParams["state"] = a.Configuration.APIClient.ParameterToString(state, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Actiontemplatelisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetJourneyOutcome invokes GET /api/v2/journey/outcomes/{outcomeId} -// -// Retrieve a single outcome. -// -// -func (a JourneyApi) GetJourneyOutcome(outcomeId string) (*Outcome, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/journey/outcomes/{outcomeId}" - path = strings.Replace(path, "{outcomeId}", fmt.Sprintf("%v", outcomeId), -1) - defaultReturn := new(Outcome) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'outcomeId' is set - if &outcomeId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'outcomeId' when calling JourneyApi->GetJourneyOutcome") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Outcome - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetJourneyOutcomes invokes GET /api/v2/journey/outcomes -// -// Retrieve all outcomes. -// -// -func (a JourneyApi) GetJourneyOutcomes(pageNumber int, pageSize int, sortBy string, outcomeIds []string) (*Outcomelisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/journey/outcomes" - defaultReturn := new(Outcomelisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range outcomeIds { - queryParams["outcomeIds"] = value - } - } else { - queryParams["outcomeIds"] = a.Configuration.APIClient.ParameterToString(outcomeIds, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Outcomelisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetJourneySegment invokes GET /api/v2/journey/segments/{segmentId} -// -// Retrieve a single segment. -// -// -func (a JourneyApi) GetJourneySegment(segmentId string) (*Journeysegment, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/journey/segments/{segmentId}" - path = strings.Replace(path, "{segmentId}", fmt.Sprintf("%v", segmentId), -1) - defaultReturn := new(Journeysegment) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'segmentId' is set - if &segmentId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'segmentId' when calling JourneyApi->GetJourneySegment") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Journeysegment - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetJourneySegments invokes GET /api/v2/journey/segments -// -// Retrieve all segments. -// -// -func (a JourneyApi) GetJourneySegments(sortBy string, pageSize int, pageNumber int, isActive bool, segmentIds []string) (*Segmentlisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/journey/segments" - defaultReturn := new(Segmentlisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(isActive).(string); ok { - if str != "" { - queryParams["isActive"] = a.Configuration.APIClient.ParameterToString(isActive, collectionFormat) - } - } else { - queryParams["isActive"] = a.Configuration.APIClient.ParameterToString(isActive, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range segmentIds { - queryParams["segmentIds"] = value - } - } else { - queryParams["segmentIds"] = a.Configuration.APIClient.ParameterToString(segmentIds, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Segmentlisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchJourneyActionmap invokes PATCH /api/v2/journey/actionmaps/{actionMapId} -// -// Update single action map. -// -// -func (a JourneyApi) PatchJourneyActionmap(actionMapId string, body Patchactionmap) (*Actionmap, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/journey/actionmaps/{actionMapId}" - path = strings.Replace(path, "{actionMapId}", fmt.Sprintf("%v", actionMapId), -1) - defaultReturn := new(Actionmap) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'actionMapId' is set - if &actionMapId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'actionMapId' when calling JourneyApi->PatchJourneyActionmap") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Actionmap - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchJourneyActiontarget invokes PATCH /api/v2/journey/actiontargets/{actionTargetId} -// -// Update a single action target. -// -// -func (a JourneyApi) PatchJourneyActiontarget(actionTargetId string, body Patchactiontarget) (*Actiontarget, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/journey/actiontargets/{actionTargetId}" - path = strings.Replace(path, "{actionTargetId}", fmt.Sprintf("%v", actionTargetId), -1) - defaultReturn := new(Actiontarget) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'actionTargetId' is set - if &actionTargetId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'actionTargetId' when calling JourneyApi->PatchJourneyActiontarget") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Actiontarget - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchJourneyActiontemplate invokes PATCH /api/v2/journey/actiontemplates/{actionTemplateId} -// -// Update a single action template. -// -// -func (a JourneyApi) PatchJourneyActiontemplate(actionTemplateId string, body Patchactiontemplate) (*Actiontemplate, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/journey/actiontemplates/{actionTemplateId}" - path = strings.Replace(path, "{actionTemplateId}", fmt.Sprintf("%v", actionTemplateId), -1) - defaultReturn := new(Actiontemplate) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'actionTemplateId' is set - if &actionTemplateId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'actionTemplateId' when calling JourneyApi->PatchJourneyActiontemplate") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Actiontemplate - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchJourneyOutcome invokes PATCH /api/v2/journey/outcomes/{outcomeId} -// -// Update an outcome. -// -// -func (a JourneyApi) PatchJourneyOutcome(outcomeId string, body Patchoutcome) (*Outcome, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/journey/outcomes/{outcomeId}" - path = strings.Replace(path, "{outcomeId}", fmt.Sprintf("%v", outcomeId), -1) - defaultReturn := new(Outcome) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'outcomeId' is set - if &outcomeId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'outcomeId' when calling JourneyApi->PatchJourneyOutcome") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Outcome - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchJourneySegment invokes PATCH /api/v2/journey/segments/{segmentId} -// -// Update a segment. -// -// -func (a JourneyApi) PatchJourneySegment(segmentId string, body Patchsegment) (*Journeysegment, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/journey/segments/{segmentId}" - path = strings.Replace(path, "{segmentId}", fmt.Sprintf("%v", segmentId), -1) - defaultReturn := new(Journeysegment) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'segmentId' is set - if &segmentId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'segmentId' when calling JourneyApi->PatchJourneySegment") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Journeysegment - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostAnalyticsJourneysAggregatesQuery invokes POST /api/v2/analytics/journeys/aggregates/query -// -// Query for journey aggregates -// -// -func (a JourneyApi) PostAnalyticsJourneysAggregatesQuery(body Journeyaggregationquery) (*Journeyaggregatequeryresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/journeys/aggregates/query" - defaultReturn := new(Journeyaggregatequeryresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling JourneyApi->PostAnalyticsJourneysAggregatesQuery") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Journeyaggregatequeryresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostJourneyActionmaps invokes POST /api/v2/journey/actionmaps -// -// Create an action map. -// -// -func (a JourneyApi) PostJourneyActionmaps(body Actionmap) (*Actionmap, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/journey/actionmaps" - defaultReturn := new(Actionmap) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Actionmap - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostJourneyActiontemplates invokes POST /api/v2/journey/actiontemplates -// -// Create a single action template. -// -// -func (a JourneyApi) PostJourneyActiontemplates(body Actiontemplate) (*Actiontemplate, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/journey/actiontemplates" - defaultReturn := new(Actiontemplate) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Actiontemplate - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostJourneyOutcomes invokes POST /api/v2/journey/outcomes -// -// Create an outcome. -// -// -func (a JourneyApi) PostJourneyOutcomes(body Outcome) (*Outcome, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/journey/outcomes" - defaultReturn := new(Outcome) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Outcome - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostJourneySegments invokes POST /api/v2/journey/segments -// -// Create a segment. -// -// -func (a JourneyApi) PostJourneySegments(body Journeysegment) (*Journeysegment, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/journey/segments" - defaultReturn := new(Journeysegment) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Journeysegment - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/journeycontext.go b/build/platformclientv2/journeycontext.go deleted file mode 100644 index f6d7f3dd8..000000000 --- a/build/platformclientv2/journeycontext.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Journeycontext -type Journeycontext struct { - // Customer - A subset of the Journey System's customer data at a point-in-time (for external linkage and internal usage/context) - Customer *Journeycustomer `json:"customer,omitempty"` - - - // CustomerSession - A subset of the Journey System's tracked customer session data at a point-in-time (for external linkage and internal usage/context) - CustomerSession *Journeycustomersession `json:"customerSession,omitempty"` - - - // TriggeringAction - A subset of the Journey System's action data relevant to a part of a conversation (for external linkage and internal usage/context) - TriggeringAction *Journeyaction `json:"triggeringAction,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Journeycontext) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/journeycustomer.go b/build/platformclientv2/journeycustomer.go deleted file mode 100644 index 0f53127db..000000000 --- a/build/platformclientv2/journeycustomer.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Journeycustomer -type Journeycustomer struct { - // Id - An ID of a customer within the Journey System at a point-in-time. Note that a customer entity can have multiple customerIds based on the stitching process. Depending on the context within the PureCloud conversation, this may or may not be mutable. - Id *string `json:"id,omitempty"` - - - // IdType - The type of the customerId within the Journey System (e.g. cookie). - IdType *string `json:"idType,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Journeycustomer) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/journeycustomersession.go b/build/platformclientv2/journeycustomersession.go deleted file mode 100644 index c5c320e27..000000000 --- a/build/platformclientv2/journeycustomersession.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Journeycustomersession -type Journeycustomersession struct { - // Id - An ID of a Customer/User's session within the Journey System at a point-in-time - Id *string `json:"id,omitempty"` - - - // VarType - The type of the Customer/User's session within the Journey System (e.g. web, app) - VarType *string `json:"type,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Journeycustomersession) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/journeypattern.go b/build/platformclientv2/journeypattern.go deleted file mode 100644 index 7dc644e5e..000000000 --- a/build/platformclientv2/journeypattern.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Journeypattern -type Journeypattern struct { - // Criteria - A list of one or more criteria to satisfy. - Criteria *[]Criteria `json:"criteria,omitempty"` - - - // Count - The number of times the pattern must match. - Count *int `json:"count,omitempty"` - - - // StreamType - The stream type for which this pattern can be matched on. - StreamType *string `json:"streamType,omitempty"` - - - // SessionType - The session type for which this pattern can be matched on. - SessionType *string `json:"sessionType,omitempty"` - - - // EventName - The name of the event for which this pattern can be matched on. - EventName *string `json:"eventName,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Journeypattern) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/journeysegment.go b/build/platformclientv2/journeysegment.go deleted file mode 100644 index 4d62b5bc0..000000000 --- a/build/platformclientv2/journeysegment.go +++ /dev/null @@ -1,70 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Journeysegment -type Journeysegment struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // IsActive - Whether or not the segment is active. - IsActive *bool `json:"isActive,omitempty"` - - - // DisplayName - The display name of the segment. - DisplayName *string `json:"displayName,omitempty"` - - - // Version - The version of the segment. - Version *int `json:"version,omitempty"` - - - // Description - A description of the segment. - Description *string `json:"description,omitempty"` - - - // Color - The hexadecimal color value of the segment. - Color *string `json:"color,omitempty"` - - - // Scope - The target entity that a segment applies to. - Scope *string `json:"scope,omitempty"` - - - // ShouldDisplayToAgent - Whether or not the segment should be displayed to agent/supervisor users. - ShouldDisplayToAgent *bool `json:"shouldDisplayToAgent,omitempty"` - - - // Context - The context of the segment. - Context *Context `json:"context,omitempty"` - - - // Journey - The pattern of rules defining the segment. - Journey *Journey `json:"journey,omitempty"` - - - // AssignmentExpirationDays - Time, in days, from when the segment is assigned until it is automatically unassigned. - AssignmentExpirationDays *int `json:"assignmentExpirationDays,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - - - // CreatedDate - Timestamp indicating when the segment was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - CreatedDate *time.Time `json:"createdDate,omitempty"` - - - // ModifiedDate - Timestamp indicating when the the segment was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ModifiedDate *time.Time `json:"modifiedDate,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Journeysegment) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/journeysurveyquestion.go b/build/platformclientv2/journeysurveyquestion.go deleted file mode 100644 index ea64babb2..000000000 --- a/build/platformclientv2/journeysurveyquestion.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Journeysurveyquestion -type Journeysurveyquestion struct { - // VarType - Type of survey question. - VarType *string `json:"type,omitempty"` - - - // Label - Label of question. - Label *string `json:"label,omitempty"` - - - // CustomerProperty - The customer property that the answer maps to. - CustomerProperty *string `json:"customerProperty,omitempty"` - - - // Choices - Choices available to user. - Choices *[]string `json:"choices,omitempty"` - - - // IsMandatory - Whether answering this question is mandatory. - IsMandatory *bool `json:"isMandatory,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Journeysurveyquestion) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/jsonnode.go b/build/platformclientv2/jsonnode.go deleted file mode 100644 index 9df0a646c..000000000 --- a/build/platformclientv2/jsonnode.go +++ /dev/null @@ -1,97 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Jsonnode -type Jsonnode struct { - // NodeType - NodeType *string `json:"nodeType,omitempty"` - - - // Float - Float *bool `json:"float,omitempty"` - - - // Number - Number *bool `json:"number,omitempty"` - - - // Boolean - Boolean *bool `json:"boolean,omitempty"` - - - // Object - Object *bool `json:"object,omitempty"` - - - // ValueNode - ValueNode *bool `json:"valueNode,omitempty"` - - - // ContainerNode - ContainerNode *bool `json:"containerNode,omitempty"` - - - // FloatingPointNumber - FloatingPointNumber *bool `json:"floatingPointNumber,omitempty"` - - - // Pojo - Pojo *bool `json:"pojo,omitempty"` - - - // IntegralNumber - IntegralNumber *bool `json:"integralNumber,omitempty"` - - - // Short - Short *bool `json:"short,omitempty"` - - - // Int - Int *bool `json:"int,omitempty"` - - - // Long - Long *bool `json:"long,omitempty"` - - - // Double - Double *bool `json:"double,omitempty"` - - - // BigDecimal - BigDecimal *bool `json:"bigDecimal,omitempty"` - - - // BigInteger - BigInteger *bool `json:"bigInteger,omitempty"` - - - // Textual - Textual *bool `json:"textual,omitempty"` - - - // Binary - Binary *bool `json:"binary,omitempty"` - - - // MissingNode - MissingNode *bool `json:"missingNode,omitempty"` - - - // Array - Array *bool `json:"array,omitempty"` - - - // Null - Null *bool `json:"null,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Jsonnode) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/jsonnodesearchresponse.go b/build/platformclientv2/jsonnodesearchresponse.go deleted file mode 100644 index 3aae65bac..000000000 --- a/build/platformclientv2/jsonnodesearchresponse.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Jsonnodesearchresponse -type Jsonnodesearchresponse struct { - // Total - The total number of results found - Total *int `json:"total,omitempty"` - - - // PageCount - The total number of pages - PageCount *int `json:"pageCount,omitempty"` - - - // PageSize - The current page size - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - The current page number - PageNumber *int `json:"pageNumber,omitempty"` - - - // PreviousPage - Q64 value for the previous page of results - PreviousPage *string `json:"previousPage,omitempty"` - - - // CurrentPage - Q64 value for the current page of results - CurrentPage *string `json:"currentPage,omitempty"` - - - // NextPage - Q64 value for the next page of results - NextPage *string `json:"nextPage,omitempty"` - - - // Types - Resource types the search was performed against - Types *[]string `json:"types,omitempty"` - - - // Results - Search results - Results *Arraynode `json:"results,omitempty"` - - - // Aggregations - Aggregations *Arraynode `json:"aggregations,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Jsonnodesearchresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/jsonschemadocument.go b/build/platformclientv2/jsonschemadocument.go deleted file mode 100644 index 229bfbf8f..000000000 --- a/build/platformclientv2/jsonschemadocument.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Jsonschemadocument - A JSON Schema document. -type Jsonschemadocument struct { - // Id - Id *string `json:"id,omitempty"` - - - // Schema - Schema *string `json:"$schema,omitempty"` - - - // Title - Title *string `json:"title,omitempty"` - - - // Description - Description *string `json:"description,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - - - // Required - Required *[]string `json:"required,omitempty"` - - - // Properties - Properties *map[string]interface{} `json:"properties,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Jsonschemadocument) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/jsonsearchresponse.go b/build/platformclientv2/jsonsearchresponse.go deleted file mode 100644 index bc458dcd0..000000000 --- a/build/platformclientv2/jsonsearchresponse.go +++ /dev/null @@ -1,41 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Jsonsearchresponse -type Jsonsearchresponse struct { - // Total - The total number of results found - Total *int `json:"total,omitempty"` - - - // PageCount - The total number of pages - PageCount *int `json:"pageCount,omitempty"` - - - // PageSize - The current page size - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - The current page number - PageNumber *int `json:"pageNumber,omitempty"` - - - // Types - Resource types the search was performed against - Types *[]string `json:"types,omitempty"` - - - // Results - Search results - Results *Arraynode `json:"results,omitempty"` - - - // Aggregations - Aggregations *Arraynode `json:"aggregations,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Jsonsearchresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/keyrotationschedule.go b/build/platformclientv2/keyrotationschedule.go deleted file mode 100644 index 7e27a1b1d..000000000 --- a/build/platformclientv2/keyrotationschedule.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Keyrotationschedule -type Keyrotationschedule struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Period - Value to set schedule to - Period *string `json:"period,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Keyrotationschedule) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/keyvalue.go b/build/platformclientv2/keyvalue.go deleted file mode 100644 index 5fd50c5ca..000000000 --- a/build/platformclientv2/keyvalue.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Keyvalue -type Keyvalue struct { - // Key - Key for free-form data. - Key *string `json:"key,omitempty"` - - - // Value - Value for free-form data. - Value *string `json:"value,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Keyvalue) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/keyword.go b/build/platformclientv2/keyword.go deleted file mode 100644 index 17249e2c3..000000000 --- a/build/platformclientv2/keyword.go +++ /dev/null @@ -1,65 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Keyword -type Keyword struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Phrase - The word or phrase which is being looked for with speech recognition. - Phrase *string `json:"phrase,omitempty"` - - - // Confidence - A sensitivity threshold that can be increased to lower false positives or decreased to reduce false negatives. - Confidence *int `json:"confidence,omitempty"` - - - // AgentScoreModifier - A modifier to the evaluation score when the phrase is spotted in the agent channel - AgentScoreModifier *int `json:"agentScoreModifier,omitempty"` - - - // CustomerScoreModifier - A modifier to the evaluation score when the phrase is spotted in the customer channel - CustomerScoreModifier *int `json:"customerScoreModifier,omitempty"` - - - // AlternateSpellings - Other spellings of the phrase that can be added to reduce missed spots (false negatives). - AlternateSpellings *[]string `json:"alternateSpellings,omitempty"` - - - // Pronunciations - The phonetic spellings for the phrase and alternate spellings. - Pronunciations *[]string `json:"pronunciations,omitempty"` - - - // AntiWords - Words that are similar to the phrase but not desired. Added to reduce incorrect spots (false positives). - AntiWords *[]string `json:"antiWords,omitempty"` - - - // AntiPronunciations - The phonetic spellings for the antiWords. - AntiPronunciations *[]string `json:"antiPronunciations,omitempty"` - - - // SpotabilityIndex - A prediction of how easy it is to unambiguously spot the keyword within its language based on spelling. - SpotabilityIndex *float64 `json:"spotabilityIndex,omitempty"` - - - // MarginOfError - MarginOfError *float64 `json:"marginOfError,omitempty"` - - - // Pronunciation - Pronunciation *string `json:"pronunciation,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Keyword) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/keywordset.go b/build/platformclientv2/keywordset.go deleted file mode 100644 index bbc8bcac8..000000000 --- a/build/platformclientv2/keywordset.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Keywordset -type Keywordset struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Description - Description *string `json:"description,omitempty"` - - - // Queues - Queues *[]Queue `json:"queues,omitempty"` - - - // Language - Language code, such as 'en-US' - Language *string `json:"language,omitempty"` - - - // Agents - Agents *[]User `json:"agents,omitempty"` - - - // Keywords - The list of keywords to be used for keyword spotting. - Keywords *[]Keyword `json:"keywords,omitempty"` - - - // ParticipantPurposes - The types of participants to use keyword spotting on. - ParticipantPurposes *[]string `json:"participantPurposes,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Keywordset) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/keywordsetentitylisting.go b/build/platformclientv2/keywordsetentitylisting.go deleted file mode 100644 index cea0035ae..000000000 --- a/build/platformclientv2/keywordsetentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Keywordsetentitylisting -type Keywordsetentitylisting struct { - // Entities - Entities *[]Keywordset `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Keywordsetentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/klaxonheartbeatalertstopicheartbeatalert.go b/build/platformclientv2/klaxonheartbeatalertstopicheartbeatalert.go deleted file mode 100644 index ed1584c36..000000000 --- a/build/platformclientv2/klaxonheartbeatalertstopicheartbeatalert.go +++ /dev/null @@ -1,54 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Klaxonheartbeatalertstopicheartbeatalert -type Klaxonheartbeatalertstopicheartbeatalert struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // SenderId - SenderId *string `json:"senderId,omitempty"` - - - // HeartBeatTimeoutInMinutes - HeartBeatTimeoutInMinutes *float32 `json:"heartBeatTimeoutInMinutes,omitempty"` - - - // RuleId - RuleId *string `json:"ruleId,omitempty"` - - - // StartDate - StartDate *time.Time `json:"startDate,omitempty"` - - - // EndDate - EndDate *time.Time `json:"endDate,omitempty"` - - - // NotificationUsers - NotificationUsers *[]Klaxonheartbeatalertstopicnotificationuser `json:"notificationUsers,omitempty"` - - - // AlertTypes - AlertTypes *[]string `json:"alertTypes,omitempty"` - - - // RuleType - RuleType *string `json:"ruleType,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Klaxonheartbeatalertstopicheartbeatalert) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/klaxonheartbeatalertstopicnotificationuser.go b/build/platformclientv2/klaxonheartbeatalertstopicnotificationuser.go deleted file mode 100644 index ab5ff127f..000000000 --- a/build/platformclientv2/klaxonheartbeatalertstopicnotificationuser.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Klaxonheartbeatalertstopicnotificationuser -type Klaxonheartbeatalertstopicnotificationuser struct { - // Id - Id *string `json:"id,omitempty"` - - - // DisplayName - DisplayName *string `json:"displayName,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Klaxonheartbeatalertstopicnotificationuser) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/klaxonheartbeatrulestopicheartbeatrule.go b/build/platformclientv2/klaxonheartbeatrulestopicheartbeatrule.go deleted file mode 100644 index 655b68355..000000000 --- a/build/platformclientv2/klaxonheartbeatrulestopicheartbeatrule.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Klaxonheartbeatrulestopicheartbeatrule -type Klaxonheartbeatrulestopicheartbeatrule struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // SenderId - SenderId *string `json:"senderId,omitempty"` - - - // HeartBeatTimeoutInMinutes - HeartBeatTimeoutInMinutes *float32 `json:"heartBeatTimeoutInMinutes,omitempty"` - - - // Enabled - Enabled *bool `json:"enabled,omitempty"` - - - // InAlarm - InAlarm *bool `json:"inAlarm,omitempty"` - - - // NotificationUsers - NotificationUsers *[]Klaxonheartbeatrulestopicnotificationuser `json:"notificationUsers,omitempty"` - - - // AlertTypes - AlertTypes *[]string `json:"alertTypes,omitempty"` - - - // RuleType - RuleType *string `json:"ruleType,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Klaxonheartbeatrulestopicheartbeatrule) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/klaxonheartbeatrulestopicnotificationuser.go b/build/platformclientv2/klaxonheartbeatrulestopicnotificationuser.go deleted file mode 100644 index 6a36a373c..000000000 --- a/build/platformclientv2/klaxonheartbeatrulestopicnotificationuser.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Klaxonheartbeatrulestopicnotificationuser -type Klaxonheartbeatrulestopicnotificationuser struct { - // Id - Id *string `json:"id,omitempty"` - - - // DisplayName - DisplayName *string `json:"displayName,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Klaxonheartbeatrulestopicnotificationuser) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/klaxoninteractionstatsalertstopicinteractionstatalert.go b/build/platformclientv2/klaxoninteractionstatsalertstopicinteractionstatalert.go deleted file mode 100644 index 3c1312188..000000000 --- a/build/platformclientv2/klaxoninteractionstatsalertstopicinteractionstatalert.go +++ /dev/null @@ -1,78 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Klaxoninteractionstatsalertstopicinteractionstatalert -type Klaxoninteractionstatsalertstopicinteractionstatalert struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // RuleId - RuleId *string `json:"ruleId,omitempty"` - - - // Dimension - Dimension *string `json:"dimension,omitempty"` - - - // DimensionValue - DimensionValue *string `json:"dimensionValue,omitempty"` - - - // DimensionValueName - DimensionValueName *string `json:"dimensionValueName,omitempty"` - - - // Metric - Metric *string `json:"metric,omitempty"` - - - // MediaType - MediaType *string `json:"mediaType,omitempty"` - - - // NumericRange - NumericRange *string `json:"numericRange,omitempty"` - - - // Statistic - Statistic *string `json:"statistic,omitempty"` - - - // Value - Value *float32 `json:"value,omitempty"` - - - // Unread - Unread *bool `json:"unread,omitempty"` - - - // StartDate - StartDate *time.Time `json:"startDate,omitempty"` - - - // EndDate - EndDate *time.Time `json:"endDate,omitempty"` - - - // NotificationUsers - NotificationUsers *[]Klaxoninteractionstatsalertstopicnotificationuser `json:"notificationUsers,omitempty"` - - - // AlertTypes - AlertTypes *[]string `json:"alertTypes,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Klaxoninteractionstatsalertstopicinteractionstatalert) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/klaxoninteractionstatsalertstopicnotificationuser.go b/build/platformclientv2/klaxoninteractionstatsalertstopicnotificationuser.go deleted file mode 100644 index b644d6eff..000000000 --- a/build/platformclientv2/klaxoninteractionstatsalertstopicnotificationuser.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Klaxoninteractionstatsalertstopicnotificationuser -type Klaxoninteractionstatsalertstopicnotificationuser struct { - // Id - Id *string `json:"id,omitempty"` - - - // DisplayName - DisplayName *string `json:"displayName,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Klaxoninteractionstatsalertstopicnotificationuser) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/klaxoninteractionstatsrulestopicinteractionstatrule.go b/build/platformclientv2/klaxoninteractionstatsrulestopicinteractionstatrule.go deleted file mode 100644 index 84b9a11f4..000000000 --- a/build/platformclientv2/klaxoninteractionstatsrulestopicinteractionstatrule.go +++ /dev/null @@ -1,69 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Klaxoninteractionstatsrulestopicinteractionstatrule -type Klaxoninteractionstatsrulestopicinteractionstatrule struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Dimension - Dimension *string `json:"dimension,omitempty"` - - - // DimensionValue - DimensionValue *string `json:"dimensionValue,omitempty"` - - - // DimensionValueName - DimensionValueName *string `json:"dimensionValueName,omitempty"` - - - // Metric - Metric *string `json:"metric,omitempty"` - - - // MediaType - MediaType *string `json:"mediaType,omitempty"` - - - // NumericRange - NumericRange *string `json:"numericRange,omitempty"` - - - // Statistic - Statistic *string `json:"statistic,omitempty"` - - - // Value - Value *float32 `json:"value,omitempty"` - - - // InAlarm - InAlarm *bool `json:"inAlarm,omitempty"` - - - // Enabled - Enabled *bool `json:"enabled,omitempty"` - - - // NotificationUsers - NotificationUsers *[]Klaxoninteractionstatsrulestopicnotificationuser `json:"notificationUsers,omitempty"` - - - // AlertTypes - AlertTypes *[]string `json:"alertTypes,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Klaxoninteractionstatsrulestopicinteractionstatrule) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/klaxoninteractionstatsrulestopicnotificationuser.go b/build/platformclientv2/klaxoninteractionstatsrulestopicnotificationuser.go deleted file mode 100644 index 02f51735e..000000000 --- a/build/platformclientv2/klaxoninteractionstatsrulestopicnotificationuser.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Klaxoninteractionstatsrulestopicnotificationuser -type Klaxoninteractionstatsrulestopicnotificationuser struct { - // Id - Id *string `json:"id,omitempty"` - - - // DisplayName - DisplayName *string `json:"displayName,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Klaxoninteractionstatsrulestopicnotificationuser) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/knowledgeapi.go b/build/platformclientv2/knowledgeapi.go deleted file mode 100644 index 397201df1..000000000 --- a/build/platformclientv2/knowledgeapi.go +++ /dev/null @@ -1,1926 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "encoding/json" -) - -// KnowledgeApi provides functions for API endpoints -type KnowledgeApi struct { - Configuration *Configuration -} - -// NewKnowledgeApi creates an API instance using the default configuration -func NewKnowledgeApi() *KnowledgeApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating KnowledgeApi with base path: %s", strings.ToLower(config.BasePath))) - return &KnowledgeApi{ - Configuration: config, - } -} - -// NewKnowledgeApiWithConfig creates an API instance using the provided configuration -func NewKnowledgeApiWithConfig(config *Configuration) *KnowledgeApi { - config.Debugf("Creating KnowledgeApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &KnowledgeApi{ - Configuration: config, - } -} - -// DeleteKnowledgeKnowledgebase invokes DELETE /api/v2/knowledge/knowledgebases/{knowledgeBaseId} -// -// Delete knowledge base -// -// -func (a KnowledgeApi) DeleteKnowledgeKnowledgebase(knowledgeBaseId string) (*Knowledgebase, *APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/knowledge/knowledgebases/{knowledgeBaseId}" - path = strings.Replace(path, "{knowledgeBaseId}", fmt.Sprintf("%v", knowledgeBaseId), -1) - defaultReturn := new(Knowledgebase) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'knowledgeBaseId' is set - if &knowledgeBaseId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'knowledgeBaseId' when calling KnowledgeApi->DeleteKnowledgeKnowledgebase") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Knowledgebase - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// DeleteKnowledgeKnowledgebaseLanguageCategory invokes DELETE /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories/{categoryId} -// -// Delete category -// -// -func (a KnowledgeApi) DeleteKnowledgeKnowledgebaseLanguageCategory(categoryId string, knowledgeBaseId string, languageCode string) (*Knowledgecategory, *APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories/{categoryId}" - path = strings.Replace(path, "{categoryId}", fmt.Sprintf("%v", categoryId), -1) - path = strings.Replace(path, "{knowledgeBaseId}", fmt.Sprintf("%v", knowledgeBaseId), -1) - path = strings.Replace(path, "{languageCode}", fmt.Sprintf("%v", languageCode), -1) - defaultReturn := new(Knowledgecategory) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'categoryId' is set - if &categoryId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'categoryId' when calling KnowledgeApi->DeleteKnowledgeKnowledgebaseLanguageCategory") - } - // verify the required parameter 'knowledgeBaseId' is set - if &knowledgeBaseId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'knowledgeBaseId' when calling KnowledgeApi->DeleteKnowledgeKnowledgebaseLanguageCategory") - } - // verify the required parameter 'languageCode' is set - if &languageCode == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'languageCode' when calling KnowledgeApi->DeleteKnowledgeKnowledgebaseLanguageCategory") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Knowledgecategory - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// DeleteKnowledgeKnowledgebaseLanguageDocument invokes DELETE /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId} -// -// Delete document -// -// -func (a KnowledgeApi) DeleteKnowledgeKnowledgebaseLanguageDocument(documentId string, knowledgeBaseId string, languageCode string) (*Knowledgedocument, *APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}" - path = strings.Replace(path, "{documentId}", fmt.Sprintf("%v", documentId), -1) - path = strings.Replace(path, "{knowledgeBaseId}", fmt.Sprintf("%v", knowledgeBaseId), -1) - path = strings.Replace(path, "{languageCode}", fmt.Sprintf("%v", languageCode), -1) - defaultReturn := new(Knowledgedocument) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'documentId' is set - if &documentId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'documentId' when calling KnowledgeApi->DeleteKnowledgeKnowledgebaseLanguageDocument") - } - // verify the required parameter 'knowledgeBaseId' is set - if &knowledgeBaseId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'knowledgeBaseId' when calling KnowledgeApi->DeleteKnowledgeKnowledgebaseLanguageDocument") - } - // verify the required parameter 'languageCode' is set - if &languageCode == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'languageCode' when calling KnowledgeApi->DeleteKnowledgeKnowledgebaseLanguageDocument") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Knowledgedocument - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetKnowledgeKnowledgebase invokes GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId} -// -// Get knowledge base -// -// -func (a KnowledgeApi) GetKnowledgeKnowledgebase(knowledgeBaseId string) (*Knowledgebase, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/knowledge/knowledgebases/{knowledgeBaseId}" - path = strings.Replace(path, "{knowledgeBaseId}", fmt.Sprintf("%v", knowledgeBaseId), -1) - defaultReturn := new(Knowledgebase) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'knowledgeBaseId' is set - if &knowledgeBaseId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'knowledgeBaseId' when calling KnowledgeApi->GetKnowledgeKnowledgebase") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Knowledgebase - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetKnowledgeKnowledgebaseLanguageCategories invokes GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories -// -// Get categories -// -// -func (a KnowledgeApi) GetKnowledgeKnowledgebaseLanguageCategories(knowledgeBaseId string, languageCode string, before string, after string, limit string, pageSize string, name string) (*Categorylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories" - path = strings.Replace(path, "{knowledgeBaseId}", fmt.Sprintf("%v", knowledgeBaseId), -1) - path = strings.Replace(path, "{languageCode}", fmt.Sprintf("%v", languageCode), -1) - defaultReturn := new(Categorylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'knowledgeBaseId' is set - if &knowledgeBaseId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'knowledgeBaseId' when calling KnowledgeApi->GetKnowledgeKnowledgebaseLanguageCategories") - } - // verify the required parameter 'languageCode' is set - if &languageCode == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'languageCode' when calling KnowledgeApi->GetKnowledgeKnowledgebaseLanguageCategories") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(before).(string); ok { - if str != "" { - queryParams["before"] = a.Configuration.APIClient.ParameterToString(before, collectionFormat) - } - } else { - queryParams["before"] = a.Configuration.APIClient.ParameterToString(before, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(after).(string); ok { - if str != "" { - queryParams["after"] = a.Configuration.APIClient.ParameterToString(after, collectionFormat) - } - } else { - queryParams["after"] = a.Configuration.APIClient.ParameterToString(after, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(limit).(string); ok { - if str != "" { - queryParams["limit"] = a.Configuration.APIClient.ParameterToString(limit, collectionFormat) - } - } else { - queryParams["limit"] = a.Configuration.APIClient.ParameterToString(limit, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Categorylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetKnowledgeKnowledgebaseLanguageCategory invokes GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories/{categoryId} -// -// Get category -// -// -func (a KnowledgeApi) GetKnowledgeKnowledgebaseLanguageCategory(categoryId string, knowledgeBaseId string, languageCode string) (*Knowledgeextendedcategory, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories/{categoryId}" - path = strings.Replace(path, "{categoryId}", fmt.Sprintf("%v", categoryId), -1) - path = strings.Replace(path, "{knowledgeBaseId}", fmt.Sprintf("%v", knowledgeBaseId), -1) - path = strings.Replace(path, "{languageCode}", fmt.Sprintf("%v", languageCode), -1) - defaultReturn := new(Knowledgeextendedcategory) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'categoryId' is set - if &categoryId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'categoryId' when calling KnowledgeApi->GetKnowledgeKnowledgebaseLanguageCategory") - } - // verify the required parameter 'knowledgeBaseId' is set - if &knowledgeBaseId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'knowledgeBaseId' when calling KnowledgeApi->GetKnowledgeKnowledgebaseLanguageCategory") - } - // verify the required parameter 'languageCode' is set - if &languageCode == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'languageCode' when calling KnowledgeApi->GetKnowledgeKnowledgebaseLanguageCategory") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Knowledgeextendedcategory - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetKnowledgeKnowledgebaseLanguageDocument invokes GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId} -// -// Get document -// -// -func (a KnowledgeApi) GetKnowledgeKnowledgebaseLanguageDocument(documentId string, knowledgeBaseId string, languageCode string) (*Knowledgedocument, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}" - path = strings.Replace(path, "{documentId}", fmt.Sprintf("%v", documentId), -1) - path = strings.Replace(path, "{knowledgeBaseId}", fmt.Sprintf("%v", knowledgeBaseId), -1) - path = strings.Replace(path, "{languageCode}", fmt.Sprintf("%v", languageCode), -1) - defaultReturn := new(Knowledgedocument) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'documentId' is set - if &documentId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'documentId' when calling KnowledgeApi->GetKnowledgeKnowledgebaseLanguageDocument") - } - // verify the required parameter 'knowledgeBaseId' is set - if &knowledgeBaseId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'knowledgeBaseId' when calling KnowledgeApi->GetKnowledgeKnowledgebaseLanguageDocument") - } - // verify the required parameter 'languageCode' is set - if &languageCode == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'languageCode' when calling KnowledgeApi->GetKnowledgeKnowledgebaseLanguageDocument") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Knowledgedocument - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetKnowledgeKnowledgebaseLanguageDocuments invokes GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents -// -// Get documents -// -// -func (a KnowledgeApi) GetKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId string, languageCode string, before string, after string, limit string, pageSize string, categories string, title string) (*Documentlisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents" - path = strings.Replace(path, "{knowledgeBaseId}", fmt.Sprintf("%v", knowledgeBaseId), -1) - path = strings.Replace(path, "{languageCode}", fmt.Sprintf("%v", languageCode), -1) - defaultReturn := new(Documentlisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'knowledgeBaseId' is set - if &knowledgeBaseId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'knowledgeBaseId' when calling KnowledgeApi->GetKnowledgeKnowledgebaseLanguageDocuments") - } - // verify the required parameter 'languageCode' is set - if &languageCode == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'languageCode' when calling KnowledgeApi->GetKnowledgeKnowledgebaseLanguageDocuments") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(before).(string); ok { - if str != "" { - queryParams["before"] = a.Configuration.APIClient.ParameterToString(before, collectionFormat) - } - } else { - queryParams["before"] = a.Configuration.APIClient.ParameterToString(before, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(after).(string); ok { - if str != "" { - queryParams["after"] = a.Configuration.APIClient.ParameterToString(after, collectionFormat) - } - } else { - queryParams["after"] = a.Configuration.APIClient.ParameterToString(after, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(limit).(string); ok { - if str != "" { - queryParams["limit"] = a.Configuration.APIClient.ParameterToString(limit, collectionFormat) - } - } else { - queryParams["limit"] = a.Configuration.APIClient.ParameterToString(limit, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(categories).(string); ok { - if str != "" { - queryParams["categories"] = a.Configuration.APIClient.ParameterToString(categories, collectionFormat) - } - } else { - queryParams["categories"] = a.Configuration.APIClient.ParameterToString(categories, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(title).(string); ok { - if str != "" { - queryParams["title"] = a.Configuration.APIClient.ParameterToString(title, collectionFormat) - } - } else { - queryParams["title"] = a.Configuration.APIClient.ParameterToString(title, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Documentlisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetKnowledgeKnowledgebaseLanguageTraining invokes GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings/{trainingId} -// -// Get training detail -// -// -func (a KnowledgeApi) GetKnowledgeKnowledgebaseLanguageTraining(knowledgeBaseId string, languageCode string, trainingId string) (*Knowledgetraining, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings/{trainingId}" - path = strings.Replace(path, "{knowledgeBaseId}", fmt.Sprintf("%v", knowledgeBaseId), -1) - path = strings.Replace(path, "{languageCode}", fmt.Sprintf("%v", languageCode), -1) - path = strings.Replace(path, "{trainingId}", fmt.Sprintf("%v", trainingId), -1) - defaultReturn := new(Knowledgetraining) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'knowledgeBaseId' is set - if &knowledgeBaseId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'knowledgeBaseId' when calling KnowledgeApi->GetKnowledgeKnowledgebaseLanguageTraining") - } - // verify the required parameter 'languageCode' is set - if &languageCode == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'languageCode' when calling KnowledgeApi->GetKnowledgeKnowledgebaseLanguageTraining") - } - // verify the required parameter 'trainingId' is set - if &trainingId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'trainingId' when calling KnowledgeApi->GetKnowledgeKnowledgebaseLanguageTraining") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Knowledgetraining - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetKnowledgeKnowledgebaseLanguageTrainings invokes GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings -// -// Get all trainings information for a knowledgebase -// -// -func (a KnowledgeApi) GetKnowledgeKnowledgebaseLanguageTrainings(knowledgeBaseId string, languageCode string, before string, after string, limit string, pageSize string, knowledgeDocumentsState string) (*Traininglisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings" - path = strings.Replace(path, "{knowledgeBaseId}", fmt.Sprintf("%v", knowledgeBaseId), -1) - path = strings.Replace(path, "{languageCode}", fmt.Sprintf("%v", languageCode), -1) - defaultReturn := new(Traininglisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'knowledgeBaseId' is set - if &knowledgeBaseId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'knowledgeBaseId' when calling KnowledgeApi->GetKnowledgeKnowledgebaseLanguageTrainings") - } - // verify the required parameter 'languageCode' is set - if &languageCode == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'languageCode' when calling KnowledgeApi->GetKnowledgeKnowledgebaseLanguageTrainings") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(before).(string); ok { - if str != "" { - queryParams["before"] = a.Configuration.APIClient.ParameterToString(before, collectionFormat) - } - } else { - queryParams["before"] = a.Configuration.APIClient.ParameterToString(before, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(after).(string); ok { - if str != "" { - queryParams["after"] = a.Configuration.APIClient.ParameterToString(after, collectionFormat) - } - } else { - queryParams["after"] = a.Configuration.APIClient.ParameterToString(after, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(limit).(string); ok { - if str != "" { - queryParams["limit"] = a.Configuration.APIClient.ParameterToString(limit, collectionFormat) - } - } else { - queryParams["limit"] = a.Configuration.APIClient.ParameterToString(limit, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(knowledgeDocumentsState).(string); ok { - if str != "" { - queryParams["knowledgeDocumentsState"] = a.Configuration.APIClient.ParameterToString(knowledgeDocumentsState, collectionFormat) - } - } else { - queryParams["knowledgeDocumentsState"] = a.Configuration.APIClient.ParameterToString(knowledgeDocumentsState, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Traininglisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetKnowledgeKnowledgebases invokes GET /api/v2/knowledge/knowledgebases -// -// Get knowledge bases -// -// -func (a KnowledgeApi) GetKnowledgeKnowledgebases(before string, after string, limit string, pageSize string, name string) (*Knowledgebaselisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/knowledge/knowledgebases" - defaultReturn := new(Knowledgebaselisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(before).(string); ok { - if str != "" { - queryParams["before"] = a.Configuration.APIClient.ParameterToString(before, collectionFormat) - } - } else { - queryParams["before"] = a.Configuration.APIClient.ParameterToString(before, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(after).(string); ok { - if str != "" { - queryParams["after"] = a.Configuration.APIClient.ParameterToString(after, collectionFormat) - } - } else { - queryParams["after"] = a.Configuration.APIClient.ParameterToString(after, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(limit).(string); ok { - if str != "" { - queryParams["limit"] = a.Configuration.APIClient.ParameterToString(limit, collectionFormat) - } - } else { - queryParams["limit"] = a.Configuration.APIClient.ParameterToString(limit, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Knowledgebaselisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchKnowledgeKnowledgebase invokes PATCH /api/v2/knowledge/knowledgebases/{knowledgeBaseId} -// -// Update knowledge base -// -// -func (a KnowledgeApi) PatchKnowledgeKnowledgebase(knowledgeBaseId string, body Knowledgebase) (*Knowledgebase, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/knowledge/knowledgebases/{knowledgeBaseId}" - path = strings.Replace(path, "{knowledgeBaseId}", fmt.Sprintf("%v", knowledgeBaseId), -1) - defaultReturn := new(Knowledgebase) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'knowledgeBaseId' is set - if &knowledgeBaseId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'knowledgeBaseId' when calling KnowledgeApi->PatchKnowledgeKnowledgebase") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling KnowledgeApi->PatchKnowledgeKnowledgebase") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Knowledgebase - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchKnowledgeKnowledgebaseLanguageCategory invokes PATCH /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories/{categoryId} -// -// Update category -// -// -func (a KnowledgeApi) PatchKnowledgeKnowledgebaseLanguageCategory(categoryId string, knowledgeBaseId string, languageCode string, body Knowledgecategoryrequest) (*Knowledgeextendedcategory, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories/{categoryId}" - path = strings.Replace(path, "{categoryId}", fmt.Sprintf("%v", categoryId), -1) - path = strings.Replace(path, "{knowledgeBaseId}", fmt.Sprintf("%v", knowledgeBaseId), -1) - path = strings.Replace(path, "{languageCode}", fmt.Sprintf("%v", languageCode), -1) - defaultReturn := new(Knowledgeextendedcategory) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'categoryId' is set - if &categoryId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'categoryId' when calling KnowledgeApi->PatchKnowledgeKnowledgebaseLanguageCategory") - } - // verify the required parameter 'knowledgeBaseId' is set - if &knowledgeBaseId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'knowledgeBaseId' when calling KnowledgeApi->PatchKnowledgeKnowledgebaseLanguageCategory") - } - // verify the required parameter 'languageCode' is set - if &languageCode == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'languageCode' when calling KnowledgeApi->PatchKnowledgeKnowledgebaseLanguageCategory") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling KnowledgeApi->PatchKnowledgeKnowledgebaseLanguageCategory") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Knowledgeextendedcategory - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchKnowledgeKnowledgebaseLanguageDocument invokes PATCH /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId} -// -// Update document -// -// -func (a KnowledgeApi) PatchKnowledgeKnowledgebaseLanguageDocument(documentId string, knowledgeBaseId string, languageCode string, body Knowledgedocumentrequest) (*Knowledgedocument, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}" - path = strings.Replace(path, "{documentId}", fmt.Sprintf("%v", documentId), -1) - path = strings.Replace(path, "{knowledgeBaseId}", fmt.Sprintf("%v", knowledgeBaseId), -1) - path = strings.Replace(path, "{languageCode}", fmt.Sprintf("%v", languageCode), -1) - defaultReturn := new(Knowledgedocument) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'documentId' is set - if &documentId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'documentId' when calling KnowledgeApi->PatchKnowledgeKnowledgebaseLanguageDocument") - } - // verify the required parameter 'knowledgeBaseId' is set - if &knowledgeBaseId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'knowledgeBaseId' when calling KnowledgeApi->PatchKnowledgeKnowledgebaseLanguageDocument") - } - // verify the required parameter 'languageCode' is set - if &languageCode == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'languageCode' when calling KnowledgeApi->PatchKnowledgeKnowledgebaseLanguageDocument") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling KnowledgeApi->PatchKnowledgeKnowledgebaseLanguageDocument") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Knowledgedocument - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchKnowledgeKnowledgebaseLanguageDocuments invokes PATCH /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents -// -// Update documents collection -// -// -func (a KnowledgeApi) PatchKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId string, languageCode string, body []Knowledgedocumentbulkrequest) (*Documentlisting, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents" - path = strings.Replace(path, "{knowledgeBaseId}", fmt.Sprintf("%v", knowledgeBaseId), -1) - path = strings.Replace(path, "{languageCode}", fmt.Sprintf("%v", languageCode), -1) - defaultReturn := new(Documentlisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'knowledgeBaseId' is set - if &knowledgeBaseId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'knowledgeBaseId' when calling KnowledgeApi->PatchKnowledgeKnowledgebaseLanguageDocuments") - } - // verify the required parameter 'languageCode' is set - if &languageCode == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'languageCode' when calling KnowledgeApi->PatchKnowledgeKnowledgebaseLanguageDocuments") - } - // verify the required parameter 'body' is set - if &body == nil { - // true - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling KnowledgeApi->PatchKnowledgeKnowledgebaseLanguageDocuments") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Documentlisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostKnowledgeKnowledgebaseLanguageCategories invokes POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories -// -// Create new category -// -// -func (a KnowledgeApi) PostKnowledgeKnowledgebaseLanguageCategories(knowledgeBaseId string, languageCode string, body Knowledgecategoryrequest) (*Knowledgeextendedcategory, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories" - path = strings.Replace(path, "{knowledgeBaseId}", fmt.Sprintf("%v", knowledgeBaseId), -1) - path = strings.Replace(path, "{languageCode}", fmt.Sprintf("%v", languageCode), -1) - defaultReturn := new(Knowledgeextendedcategory) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'knowledgeBaseId' is set - if &knowledgeBaseId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'knowledgeBaseId' when calling KnowledgeApi->PostKnowledgeKnowledgebaseLanguageCategories") - } - // verify the required parameter 'languageCode' is set - if &languageCode == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'languageCode' when calling KnowledgeApi->PostKnowledgeKnowledgebaseLanguageCategories") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling KnowledgeApi->PostKnowledgeKnowledgebaseLanguageCategories") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Knowledgeextendedcategory - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostKnowledgeKnowledgebaseLanguageDocuments invokes POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents -// -// Create document -// -// -func (a KnowledgeApi) PostKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId string, languageCode string, body Knowledgedocumentrequest) (*Knowledgedocument, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents" - path = strings.Replace(path, "{knowledgeBaseId}", fmt.Sprintf("%v", knowledgeBaseId), -1) - path = strings.Replace(path, "{languageCode}", fmt.Sprintf("%v", languageCode), -1) - defaultReturn := new(Knowledgedocument) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'knowledgeBaseId' is set - if &knowledgeBaseId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'knowledgeBaseId' when calling KnowledgeApi->PostKnowledgeKnowledgebaseLanguageDocuments") - } - // verify the required parameter 'languageCode' is set - if &languageCode == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'languageCode' when calling KnowledgeApi->PostKnowledgeKnowledgebaseLanguageDocuments") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling KnowledgeApi->PostKnowledgeKnowledgebaseLanguageDocuments") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Knowledgedocument - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostKnowledgeKnowledgebaseLanguageTrainingPromote invokes POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings/{trainingId}/promote -// -// Promote trained documents from draft state to active. -// -// -func (a KnowledgeApi) PostKnowledgeKnowledgebaseLanguageTrainingPromote(knowledgeBaseId string, languageCode string, trainingId string) (*Knowledgetraining, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings/{trainingId}/promote" - path = strings.Replace(path, "{knowledgeBaseId}", fmt.Sprintf("%v", knowledgeBaseId), -1) - path = strings.Replace(path, "{languageCode}", fmt.Sprintf("%v", languageCode), -1) - path = strings.Replace(path, "{trainingId}", fmt.Sprintf("%v", trainingId), -1) - defaultReturn := new(Knowledgetraining) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'knowledgeBaseId' is set - if &knowledgeBaseId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'knowledgeBaseId' when calling KnowledgeApi->PostKnowledgeKnowledgebaseLanguageTrainingPromote") - } - // verify the required parameter 'languageCode' is set - if &languageCode == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'languageCode' when calling KnowledgeApi->PostKnowledgeKnowledgebaseLanguageTrainingPromote") - } - // verify the required parameter 'trainingId' is set - if &trainingId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'trainingId' when calling KnowledgeApi->PostKnowledgeKnowledgebaseLanguageTrainingPromote") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Knowledgetraining - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostKnowledgeKnowledgebaseLanguageTrainings invokes POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings -// -// Trigger training -// -// -func (a KnowledgeApi) PostKnowledgeKnowledgebaseLanguageTrainings(knowledgeBaseId string, languageCode string) (*Knowledgetraining, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings" - path = strings.Replace(path, "{knowledgeBaseId}", fmt.Sprintf("%v", knowledgeBaseId), -1) - path = strings.Replace(path, "{languageCode}", fmt.Sprintf("%v", languageCode), -1) - defaultReturn := new(Knowledgetraining) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'knowledgeBaseId' is set - if &knowledgeBaseId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'knowledgeBaseId' when calling KnowledgeApi->PostKnowledgeKnowledgebaseLanguageTrainings") - } - // verify the required parameter 'languageCode' is set - if &languageCode == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'languageCode' when calling KnowledgeApi->PostKnowledgeKnowledgebaseLanguageTrainings") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Knowledgetraining - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostKnowledgeKnowledgebaseSearch invokes POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/search -// -// Search Documents -// -// -func (a KnowledgeApi) PostKnowledgeKnowledgebaseSearch(knowledgeBaseId string, body Knowledgesearchrequest) (*Knowledgesearchresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/search" - path = strings.Replace(path, "{knowledgeBaseId}", fmt.Sprintf("%v", knowledgeBaseId), -1) - defaultReturn := new(Knowledgesearchresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'knowledgeBaseId' is set - if &knowledgeBaseId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'knowledgeBaseId' when calling KnowledgeApi->PostKnowledgeKnowledgebaseSearch") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Knowledgesearchresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostKnowledgeKnowledgebases invokes POST /api/v2/knowledge/knowledgebases -// -// Create new knowledge base -// -// -func (a KnowledgeApi) PostKnowledgeKnowledgebases(body Knowledgebase) (*Knowledgebase, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/knowledge/knowledgebases" - defaultReturn := new(Knowledgebase) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling KnowledgeApi->PostKnowledgeKnowledgebases") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Knowledgebase - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/knowledgebase.go b/build/platformclientv2/knowledgebase.go deleted file mode 100644 index 38541dbd2..000000000 --- a/build/platformclientv2/knowledgebase.go +++ /dev/null @@ -1,50 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Knowledgebase -type Knowledgebase struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Description - Knowledge base description - Description *string `json:"description,omitempty"` - - - // CoreLanguage - Core language for knowledge base in which initial content must be created first - CoreLanguage *string `json:"coreLanguage,omitempty"` - - - // DateCreated - Knowledge base creation date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - Knowledge base last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // FaqCount - The count representing the number of documents of type FAQ per KnowledgeBase - FaqCount *int `json:"faqCount,omitempty"` - - - // DateDocumentLastModified - The date representing when the last document is modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateDocumentLastModified *time.Time `json:"dateDocumentLastModified,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Knowledgebase) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/knowledgebaselisting.go b/build/platformclientv2/knowledgebaselisting.go deleted file mode 100644 index 2ae04250a..000000000 --- a/build/platformclientv2/knowledgebaselisting.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Knowledgebaselisting -type Knowledgebaselisting struct { - // Entities - Entities *[]Knowledgebase `json:"entities,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Knowledgebaselisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/knowledgecategory.go b/build/platformclientv2/knowledgecategory.go deleted file mode 100644 index 867fbd015..000000000 --- a/build/platformclientv2/knowledgecategory.go +++ /dev/null @@ -1,46 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Knowledgecategory -type Knowledgecategory struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Category name - Name *string `json:"name,omitempty"` - - - // Description - Category description - Description *string `json:"description,omitempty"` - - - // KnowledgeBase - Knowledge base which category does belong to - KnowledgeBase *Knowledgebase `json:"knowledgeBase,omitempty"` - - - // LanguageCode - Actual language of the category - LanguageCode *string `json:"languageCode,omitempty"` - - - // DateCreated - Category creation date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - Category last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Knowledgecategory) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/knowledgecategoryrequest.go b/build/platformclientv2/knowledgecategoryrequest.go deleted file mode 100644 index 805193ef6..000000000 --- a/build/platformclientv2/knowledgecategoryrequest.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Knowledgecategoryrequest -type Knowledgecategoryrequest struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Category name - Name *string `json:"name,omitempty"` - - - // Description - Category description - Description *string `json:"description,omitempty"` - - - // Parent - Category parent - Parent *Documentcategoryinput `json:"parent,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Knowledgecategoryrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/knowledgedocument.go b/build/platformclientv2/knowledgedocument.go deleted file mode 100644 index 4ef73de04..000000000 --- a/build/platformclientv2/knowledgedocument.go +++ /dev/null @@ -1,58 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Knowledgedocument -type Knowledgedocument struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // LanguageCode - Language of the document - LanguageCode *string `json:"languageCode,omitempty"` - - - // VarType - Document type - VarType *string `json:"type,omitempty"` - - - // Faq - FAQ document details - Faq *Documentfaq `json:"faq,omitempty"` - - - // DateCreated - Document creation date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - Document last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // Categories - Document categories - Categories *[]Knowledgecategory `json:"categories,omitempty"` - - - // KnowledgeBase - Knowledge base which document does belong to - KnowledgeBase *Knowledgebase `json:"knowledgeBase,omitempty"` - - - // ExternalUrl - External URL to the document - ExternalUrl *string `json:"externalUrl,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Knowledgedocument) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/knowledgedocumentbulkrequest.go b/build/platformclientv2/knowledgedocumentbulkrequest.go deleted file mode 100644 index e31d41fe3..000000000 --- a/build/platformclientv2/knowledgedocumentbulkrequest.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Knowledgedocumentbulkrequest -type Knowledgedocumentbulkrequest struct { - // VarType - Document type according to assigned template - VarType *string `json:"type,omitempty"` - - - // ExternalUrl - External Url to the document - ExternalUrl *string `json:"externalUrl,omitempty"` - - - // Faq - Faq document details - Faq *Documentfaq `json:"faq,omitempty"` - - - // Categories - Document categories - Categories *[]Documentcategoryinput `json:"categories,omitempty"` - - - // Id - Identifier of document for update. Omit for create new Document. - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Knowledgedocumentbulkrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/knowledgedocumentrequest.go b/build/platformclientv2/knowledgedocumentrequest.go deleted file mode 100644 index 2a4fdb5dc..000000000 --- a/build/platformclientv2/knowledgedocumentrequest.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Knowledgedocumentrequest -type Knowledgedocumentrequest struct { - // VarType - Document type according to assigned template - VarType *string `json:"type,omitempty"` - - - // ExternalUrl - External Url to the document - ExternalUrl *string `json:"externalUrl,omitempty"` - - - // Faq - Faq document details - Faq *Documentfaq `json:"faq,omitempty"` - - - // Categories - Document categories - Categories *[]Documentcategoryinput `json:"categories,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Knowledgedocumentrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/knowledgeextendedcategory.go b/build/platformclientv2/knowledgeextendedcategory.go deleted file mode 100644 index ec5faf847..000000000 --- a/build/platformclientv2/knowledgeextendedcategory.go +++ /dev/null @@ -1,54 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Knowledgeextendedcategory -type Knowledgeextendedcategory struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Category name - Name *string `json:"name,omitempty"` - - - // Description - Category description - Description *string `json:"description,omitempty"` - - - // KnowledgeBase - Knowledge base which category does belong to - KnowledgeBase *Knowledgebase `json:"knowledgeBase,omitempty"` - - - // LanguageCode - Actual language of the category - LanguageCode *string `json:"languageCode,omitempty"` - - - // DateCreated - Category creation date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - Category last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // Parent - Category parent - Parent *Knowledgecategory `json:"parent,omitempty"` - - - // Children - Category children - Children *[]Knowledgecategory `json:"children,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Knowledgeextendedcategory) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/knowledgesearchdocument.go b/build/platformclientv2/knowledgesearchdocument.go deleted file mode 100644 index e45303246..000000000 --- a/build/platformclientv2/knowledgesearchdocument.go +++ /dev/null @@ -1,62 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Knowledgesearchdocument -type Knowledgesearchdocument struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // LanguageCode - Language of the document - LanguageCode *string `json:"languageCode,omitempty"` - - - // VarType - Document type - VarType *string `json:"type,omitempty"` - - - // Faq - FAQ document details - Faq *Documentfaq `json:"faq,omitempty"` - - - // DateCreated - Document creation date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - Document last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // Categories - Document categories - Categories *[]Knowledgecategory `json:"categories,omitempty"` - - - // KnowledgeBase - Knowledge base which document does belong to - KnowledgeBase *Knowledgebase `json:"knowledgeBase,omitempty"` - - - // ExternalUrl - External URL to the document - ExternalUrl *string `json:"externalUrl,omitempty"` - - - // Confidence - The confidence associated with a document with respect to a search query - Confidence *float64 `json:"confidence,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Knowledgesearchdocument) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/knowledgesearchrequest.go b/build/platformclientv2/knowledgesearchrequest.go deleted file mode 100644 index a178acf5f..000000000 --- a/build/platformclientv2/knowledgesearchrequest.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Knowledgesearchrequest -type Knowledgesearchrequest struct { - // Query - Input query to search content in the knowledge base - Query *string `json:"query,omitempty"` - - - // PageSize - Page size of the returned results - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - Page number of the returned results - PageNumber *int `json:"pageNumber,omitempty"` - - - // DocumentType - Document type to be used while searching - DocumentType *string `json:"documentType,omitempty"` - - - // LanguageCode - query search for specific languageCode - LanguageCode *string `json:"languageCode,omitempty"` - - - // SearchOnDraftDocuments - If true the search query will be executed on draft documents, else it will be on active documents - SearchOnDraftDocuments *bool `json:"searchOnDraftDocuments,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Knowledgesearchrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/knowledgesearchresponse.go b/build/platformclientv2/knowledgesearchresponse.go deleted file mode 100644 index dc994c7ee..000000000 --- a/build/platformclientv2/knowledgesearchresponse.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Knowledgesearchresponse -type Knowledgesearchresponse struct { - // SearchId - Search Id - SearchId *string `json:"searchId,omitempty"` - - - // Total - Total number of records returned - Total *int `json:"total,omitempty"` - - - // PageCount - Number of pages returned in the result calculated according to the pageSize and the total - PageCount *int `json:"pageCount,omitempty"` - - - // PageSize - Number of records according to the page size - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - Current page number for the returned records - PageNumber *int `json:"pageNumber,omitempty"` - - - // Results - Results associated to the search response - Results *[]Knowledgesearchdocument `json:"results,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Knowledgesearchresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/knowledgetraining.go b/build/platformclientv2/knowledgetraining.go deleted file mode 100644 index 3aee278c6..000000000 --- a/build/platformclientv2/knowledgetraining.go +++ /dev/null @@ -1,54 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Knowledgetraining -type Knowledgetraining struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // DateTriggered - Trigger date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateTriggered *time.Time `json:"dateTriggered,omitempty"` - - - // DateCompleted - Training completed date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCompleted *time.Time `json:"dateCompleted,omitempty"` - - - // Status - Training status. - Status *string `json:"status,omitempty"` - - - // LanguageCode - Language of the documents that are trained. - LanguageCode *string `json:"languageCode,omitempty"` - - - // KnowledgeBase - Knowledge Base that the training belongs to. - KnowledgeBase *Knowledgebase `json:"knowledgeBase,omitempty"` - - - // ErrorMessage - Any error message during the Training or Promote action. - ErrorMessage *string `json:"errorMessage,omitempty"` - - - // KnowledgeDocumentsState - State of the Trained Documents, which can be one of these Draft, Active, Discarded, Archived. - KnowledgeDocumentsState *string `json:"knowledgeDocumentsState,omitempty"` - - - // DatePromoted - Trained Documents Promoted date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DatePromoted *time.Time `json:"datePromoted,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Knowledgetraining) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/languageentitylisting.go b/build/platformclientv2/languageentitylisting.go deleted file mode 100644 index 366c972e8..000000000 --- a/build/platformclientv2/languageentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Languageentitylisting -type Languageentitylisting struct { - // Entities - Entities *[]Language `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Languageentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/languageoverride.go b/build/platformclientv2/languageoverride.go deleted file mode 100644 index ac150a838..000000000 --- a/build/platformclientv2/languageoverride.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Languageoverride -type Languageoverride struct { - // Language - The language code of the language being overridden - Language *string `json:"language,omitempty"` - - - // Engine - The ID of the TTS engine to use for this language override - Engine *string `json:"engine,omitempty"` - - - // Voice - The ID of the voice to use for this language override. The voice must be supported by the chosen engine. - Voice *string `json:"voice,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Languageoverride) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/languagereference.go b/build/platformclientv2/languagereference.go deleted file mode 100644 index abebd60dc..000000000 --- a/build/platformclientv2/languagereference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Languagereference -type Languagereference struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Languagereference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/languagesapi.go b/build/platformclientv2/languagesapi.go deleted file mode 100644 index 56878d1ba..000000000 --- a/build/platformclientv2/languagesapi.go +++ /dev/null @@ -1,782 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "encoding/json" -) - -// LanguagesApi provides functions for API endpoints -type LanguagesApi struct { - Configuration *Configuration -} - -// NewLanguagesApi creates an API instance using the default configuration -func NewLanguagesApi() *LanguagesApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating LanguagesApi with base path: %s", strings.ToLower(config.BasePath))) - return &LanguagesApi{ - Configuration: config, - } -} - -// NewLanguagesApiWithConfig creates an API instance using the provided configuration -func NewLanguagesApiWithConfig(config *Configuration) *LanguagesApi { - config.Debugf("Creating LanguagesApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &LanguagesApi{ - Configuration: config, - } -} - -// DeleteLanguage invokes DELETE /api/v2/languages/{languageId} -// -// Delete Language (Deprecated) -// -// This endpoint is deprecated. It has been moved to /routing/languages/{languageId} -func (a LanguagesApi) DeleteLanguage(languageId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/languages/{languageId}" - path = strings.Replace(path, "{languageId}", fmt.Sprintf("%v", languageId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'languageId' is set - if &languageId == nil { - // - return nil, errors.New("Missing required parameter 'languageId' when calling LanguagesApi->DeleteLanguage") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteRoutingLanguage invokes DELETE /api/v2/routing/languages/{languageId} -// -// Delete Language -// -// -func (a LanguagesApi) DeleteRoutingLanguage(languageId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/languages/{languageId}" - path = strings.Replace(path, "{languageId}", fmt.Sprintf("%v", languageId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'languageId' is set - if &languageId == nil { - // - return nil, errors.New("Missing required parameter 'languageId' when calling LanguagesApi->DeleteRoutingLanguage") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// GetLanguage invokes GET /api/v2/languages/{languageId} -// -// Get language (Deprecated) -// -// This endpoint is deprecated. It has been moved to /routing/languages/{languageId} -func (a LanguagesApi) GetLanguage(languageId string) (*Language, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/languages/{languageId}" - path = strings.Replace(path, "{languageId}", fmt.Sprintf("%v", languageId), -1) - defaultReturn := new(Language) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'languageId' is set - if &languageId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'languageId' when calling LanguagesApi->GetLanguage") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Language - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetLanguages invokes GET /api/v2/languages -// -// Get the list of supported languages. (Deprecated) -// -// This endpoint is deprecated. It has been moved to /routing/languages -func (a LanguagesApi) GetLanguages(pageSize int, pageNumber int, sortOrder string, name string) (*Languageentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/languages" - defaultReturn := new(Languageentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Languageentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetLanguagesTranslations invokes GET /api/v2/languages/translations -// -// Get all available languages for translation -// -// -func (a LanguagesApi) GetLanguagesTranslations() (*Availabletranslations, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/languages/translations" - defaultReturn := new(Availabletranslations) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Availabletranslations - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetLanguagesTranslationsBuiltin invokes GET /api/v2/languages/translations/builtin -// -// Get the builtin translation for a language -// -// -func (a LanguagesApi) GetLanguagesTranslationsBuiltin(language string) (*map[string]interface{}, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/languages/translations/builtin" - defaultReturn := new(map[string]interface{}) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'language' is set - if &language == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'language' when calling LanguagesApi->GetLanguagesTranslationsBuiltin") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(language).(string); ok { - if str != "" { - queryParams["language"] = a.Configuration.APIClient.ParameterToString(language, collectionFormat) - } - } else { - queryParams["language"] = a.Configuration.APIClient.ParameterToString(language, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *map[string]interface{} - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetLanguagesTranslationsOrganization invokes GET /api/v2/languages/translations/organization -// -// Get effective translation for an organization by language -// -// -func (a LanguagesApi) GetLanguagesTranslationsOrganization(language string) (*map[string]interface{}, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/languages/translations/organization" - defaultReturn := new(map[string]interface{}) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'language' is set - if &language == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'language' when calling LanguagesApi->GetLanguagesTranslationsOrganization") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(language).(string); ok { - if str != "" { - queryParams["language"] = a.Configuration.APIClient.ParameterToString(language, collectionFormat) - } - } else { - queryParams["language"] = a.Configuration.APIClient.ParameterToString(language, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *map[string]interface{} - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetLanguagesTranslationsUser invokes GET /api/v2/languages/translations/users/{userId} -// -// Get effective language translation for a user -// -// -func (a LanguagesApi) GetLanguagesTranslationsUser(userId string) (*map[string]interface{}, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/languages/translations/users/{userId}" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(map[string]interface{}) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling LanguagesApi->GetLanguagesTranslationsUser") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *map[string]interface{} - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetRoutingLanguage invokes GET /api/v2/routing/languages/{languageId} -// -// Get language -// -// -func (a LanguagesApi) GetRoutingLanguage(languageId string) (*Language, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/languages/{languageId}" - path = strings.Replace(path, "{languageId}", fmt.Sprintf("%v", languageId), -1) - defaultReturn := new(Language) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'languageId' is set - if &languageId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'languageId' when calling LanguagesApi->GetRoutingLanguage") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Language - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostLanguages invokes POST /api/v2/languages -// -// Create Language (Deprecated) -// -// This endpoint is deprecated. It has been moved to /routing/languages -func (a LanguagesApi) PostLanguages(body Language) (*Language, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/languages" - defaultReturn := new(Language) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling LanguagesApi->PostLanguages") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Language - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/languageunderstandingapi.go b/build/platformclientv2/languageunderstandingapi.go deleted file mode 100644 index 7c828e228..000000000 --- a/build/platformclientv2/languageunderstandingapi.go +++ /dev/null @@ -1,1570 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "time" -"encoding/json" -) - -// LanguageUnderstandingApi provides functions for API endpoints -type LanguageUnderstandingApi struct { - Configuration *Configuration -} - -// NewLanguageUnderstandingApi creates an API instance using the default configuration -func NewLanguageUnderstandingApi() *LanguageUnderstandingApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating LanguageUnderstandingApi with base path: %s", strings.ToLower(config.BasePath))) - return &LanguageUnderstandingApi{ - Configuration: config, - } -} - -// NewLanguageUnderstandingApiWithConfig creates an API instance using the provided configuration -func NewLanguageUnderstandingApiWithConfig(config *Configuration) *LanguageUnderstandingApi { - config.Debugf("Creating LanguageUnderstandingApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &LanguageUnderstandingApi{ - Configuration: config, - } -} - -// DeleteLanguageunderstandingDomain invokes DELETE /api/v2/languageunderstanding/domains/{domainId} -// -// Delete an NLU Domain. -// -// -func (a LanguageUnderstandingApi) DeleteLanguageunderstandingDomain(domainId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/languageunderstanding/domains/{domainId}" - path = strings.Replace(path, "{domainId}", fmt.Sprintf("%v", domainId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'domainId' is set - if &domainId == nil { - // - return nil, errors.New("Missing required parameter 'domainId' when calling LanguageUnderstandingApi->DeleteLanguageunderstandingDomain") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteLanguageunderstandingDomainFeedbackFeedbackId invokes DELETE /api/v2/languageunderstanding/domains/{domainId}/feedback/{feedbackId} -// -// Delete the feedback on the NLU Domain Version. -// -// -func (a LanguageUnderstandingApi) DeleteLanguageunderstandingDomainFeedbackFeedbackId(domainId string, feedbackId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/languageunderstanding/domains/{domainId}/feedback/{feedbackId}" - path = strings.Replace(path, "{domainId}", fmt.Sprintf("%v", domainId), -1) - path = strings.Replace(path, "{feedbackId}", fmt.Sprintf("%v", feedbackId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'domainId' is set - if &domainId == nil { - // - return nil, errors.New("Missing required parameter 'domainId' when calling LanguageUnderstandingApi->DeleteLanguageunderstandingDomainFeedbackFeedbackId") - } - // verify the required parameter 'feedbackId' is set - if &feedbackId == nil { - // - return nil, errors.New("Missing required parameter 'feedbackId' when calling LanguageUnderstandingApi->DeleteLanguageunderstandingDomainFeedbackFeedbackId") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteLanguageunderstandingDomainVersion invokes DELETE /api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId} -// -// Delete an NLU Domain Version -// -// -func (a LanguageUnderstandingApi) DeleteLanguageunderstandingDomainVersion(domainId string, domainVersionId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}" - path = strings.Replace(path, "{domainId}", fmt.Sprintf("%v", domainId), -1) - path = strings.Replace(path, "{domainVersionId}", fmt.Sprintf("%v", domainVersionId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'domainId' is set - if &domainId == nil { - // - return nil, errors.New("Missing required parameter 'domainId' when calling LanguageUnderstandingApi->DeleteLanguageunderstandingDomainVersion") - } - // verify the required parameter 'domainVersionId' is set - if &domainVersionId == nil { - // - return nil, errors.New("Missing required parameter 'domainVersionId' when calling LanguageUnderstandingApi->DeleteLanguageunderstandingDomainVersion") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// GetLanguageunderstandingDomain invokes GET /api/v2/languageunderstanding/domains/{domainId} -// -// Find an NLU Domain. -// -// -func (a LanguageUnderstandingApi) GetLanguageunderstandingDomain(domainId string) (*Nludomain, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/languageunderstanding/domains/{domainId}" - path = strings.Replace(path, "{domainId}", fmt.Sprintf("%v", domainId), -1) - defaultReturn := new(Nludomain) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'domainId' is set - if &domainId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'domainId' when calling LanguageUnderstandingApi->GetLanguageunderstandingDomain") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Nludomain - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetLanguageunderstandingDomainFeedback invokes GET /api/v2/languageunderstanding/domains/{domainId}/feedback -// -// Get all feedback in the given NLU Domain Version. -// -// -func (a LanguageUnderstandingApi) GetLanguageunderstandingDomainFeedback(domainId string, intentName string, assessment string, dateStart time.Time, dateEnd time.Time, includeDeleted bool, pageNumber int, pageSize int, enableCursorPagination bool, after string, fields []string) (*Nlufeedbacklisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/languageunderstanding/domains/{domainId}/feedback" - path = strings.Replace(path, "{domainId}", fmt.Sprintf("%v", domainId), -1) - defaultReturn := new(Nlufeedbacklisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'domainId' is set - if &domainId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'domainId' when calling LanguageUnderstandingApi->GetLanguageunderstandingDomainFeedback") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(intentName).(string); ok { - if str != "" { - queryParams["intentName"] = a.Configuration.APIClient.ParameterToString(intentName, collectionFormat) - } - } else { - queryParams["intentName"] = a.Configuration.APIClient.ParameterToString(intentName, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(assessment).(string); ok { - if str != "" { - queryParams["assessment"] = a.Configuration.APIClient.ParameterToString(assessment, collectionFormat) - } - } else { - queryParams["assessment"] = a.Configuration.APIClient.ParameterToString(assessment, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(dateStart).(string); ok { - if str != "" { - queryParams["dateStart"] = a.Configuration.APIClient.ParameterToString(dateStart, collectionFormat) - } - } else { - queryParams["dateStart"] = a.Configuration.APIClient.ParameterToString(dateStart, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(dateEnd).(string); ok { - if str != "" { - queryParams["dateEnd"] = a.Configuration.APIClient.ParameterToString(dateEnd, collectionFormat) - } - } else { - queryParams["dateEnd"] = a.Configuration.APIClient.ParameterToString(dateEnd, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(includeDeleted).(string); ok { - if str != "" { - queryParams["includeDeleted"] = a.Configuration.APIClient.ParameterToString(includeDeleted, collectionFormat) - } - } else { - queryParams["includeDeleted"] = a.Configuration.APIClient.ParameterToString(includeDeleted, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(enableCursorPagination).(string); ok { - if str != "" { - queryParams["enableCursorPagination"] = a.Configuration.APIClient.ParameterToString(enableCursorPagination, collectionFormat) - } - } else { - queryParams["enableCursorPagination"] = a.Configuration.APIClient.ParameterToString(enableCursorPagination, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(after).(string); ok { - if str != "" { - queryParams["after"] = a.Configuration.APIClient.ParameterToString(after, collectionFormat) - } - } else { - queryParams["after"] = a.Configuration.APIClient.ParameterToString(after, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range fields { - queryParams["fields"] = value - } - } else { - queryParams["fields"] = a.Configuration.APIClient.ParameterToString(fields, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Nlufeedbacklisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetLanguageunderstandingDomainFeedbackFeedbackId invokes GET /api/v2/languageunderstanding/domains/{domainId}/feedback/{feedbackId} -// -// Find a Feedback -// -// -func (a LanguageUnderstandingApi) GetLanguageunderstandingDomainFeedbackFeedbackId(domainId string, feedbackId string, fields []string) (*Nlufeedbackresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/languageunderstanding/domains/{domainId}/feedback/{feedbackId}" - path = strings.Replace(path, "{domainId}", fmt.Sprintf("%v", domainId), -1) - path = strings.Replace(path, "{feedbackId}", fmt.Sprintf("%v", feedbackId), -1) - defaultReturn := new(Nlufeedbackresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'domainId' is set - if &domainId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'domainId' when calling LanguageUnderstandingApi->GetLanguageunderstandingDomainFeedbackFeedbackId") - } - // verify the required parameter 'feedbackId' is set - if &feedbackId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'feedbackId' when calling LanguageUnderstandingApi->GetLanguageunderstandingDomainFeedbackFeedbackId") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range fields { - queryParams["fields"] = value - } - } else { - queryParams["fields"] = a.Configuration.APIClient.ParameterToString(fields, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Nlufeedbackresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetLanguageunderstandingDomainVersion invokes GET /api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId} -// -// Find an NLU Domain Version. -// -// -func (a LanguageUnderstandingApi) GetLanguageunderstandingDomainVersion(domainId string, domainVersionId string, includeUtterances bool) (*Nludomainversion, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}" - path = strings.Replace(path, "{domainId}", fmt.Sprintf("%v", domainId), -1) - path = strings.Replace(path, "{domainVersionId}", fmt.Sprintf("%v", domainVersionId), -1) - defaultReturn := new(Nludomainversion) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'domainId' is set - if &domainId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'domainId' when calling LanguageUnderstandingApi->GetLanguageunderstandingDomainVersion") - } - // verify the required parameter 'domainVersionId' is set - if &domainVersionId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'domainVersionId' when calling LanguageUnderstandingApi->GetLanguageunderstandingDomainVersion") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(includeUtterances).(string); ok { - if str != "" { - queryParams["includeUtterances"] = a.Configuration.APIClient.ParameterToString(includeUtterances, collectionFormat) - } - } else { - queryParams["includeUtterances"] = a.Configuration.APIClient.ParameterToString(includeUtterances, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Nludomainversion - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetLanguageunderstandingDomainVersionReport invokes GET /api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/report -// -// Retrieved quality report for the specified NLU Domain Version -// -// -func (a LanguageUnderstandingApi) GetLanguageunderstandingDomainVersionReport(domainId string, domainVersionId string) (*Nludomainversionqualityreport, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/report" - path = strings.Replace(path, "{domainId}", fmt.Sprintf("%v", domainId), -1) - path = strings.Replace(path, "{domainVersionId}", fmt.Sprintf("%v", domainVersionId), -1) - defaultReturn := new(Nludomainversionqualityreport) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'domainId' is set - if &domainId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'domainId' when calling LanguageUnderstandingApi->GetLanguageunderstandingDomainVersionReport") - } - // verify the required parameter 'domainVersionId' is set - if &domainVersionId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'domainVersionId' when calling LanguageUnderstandingApi->GetLanguageunderstandingDomainVersionReport") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Nludomainversionqualityreport - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetLanguageunderstandingDomainVersions invokes GET /api/v2/languageunderstanding/domains/{domainId}/versions -// -// Get all NLU Domain Versions for a given Domain. -// -// -func (a LanguageUnderstandingApi) GetLanguageunderstandingDomainVersions(domainId string, includeUtterances bool, pageNumber int, pageSize int) (*Nludomainversionlisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/languageunderstanding/domains/{domainId}/versions" - path = strings.Replace(path, "{domainId}", fmt.Sprintf("%v", domainId), -1) - defaultReturn := new(Nludomainversionlisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'domainId' is set - if &domainId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'domainId' when calling LanguageUnderstandingApi->GetLanguageunderstandingDomainVersions") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(includeUtterances).(string); ok { - if str != "" { - queryParams["includeUtterances"] = a.Configuration.APIClient.ParameterToString(includeUtterances, collectionFormat) - } - } else { - queryParams["includeUtterances"] = a.Configuration.APIClient.ParameterToString(includeUtterances, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Nludomainversionlisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetLanguageunderstandingDomains invokes GET /api/v2/languageunderstanding/domains -// -// Get all NLU Domains. -// -// -func (a LanguageUnderstandingApi) GetLanguageunderstandingDomains(pageNumber int, pageSize int) (*Nludomainlisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/languageunderstanding/domains" - defaultReturn := new(Nludomainlisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Nludomainlisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchLanguageunderstandingDomain invokes PATCH /api/v2/languageunderstanding/domains/{domainId} -// -// Update an NLU Domain. -// -// -func (a LanguageUnderstandingApi) PatchLanguageunderstandingDomain(domainId string, body Nludomain) (*Nludomain, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/languageunderstanding/domains/{domainId}" - path = strings.Replace(path, "{domainId}", fmt.Sprintf("%v", domainId), -1) - defaultReturn := new(Nludomain) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'domainId' is set - if &domainId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'domainId' when calling LanguageUnderstandingApi->PatchLanguageunderstandingDomain") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling LanguageUnderstandingApi->PatchLanguageunderstandingDomain") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Nludomain - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostLanguageunderstandingDomainFeedback invokes POST /api/v2/languageunderstanding/domains/{domainId}/feedback -// -// Create feedback for the NLU Domain Version. -// -// -func (a LanguageUnderstandingApi) PostLanguageunderstandingDomainFeedback(domainId string, body Nlufeedbackrequest) (*Nlufeedbackresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/languageunderstanding/domains/{domainId}/feedback" - path = strings.Replace(path, "{domainId}", fmt.Sprintf("%v", domainId), -1) - defaultReturn := new(Nlufeedbackresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'domainId' is set - if &domainId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'domainId' when calling LanguageUnderstandingApi->PostLanguageunderstandingDomainFeedback") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling LanguageUnderstandingApi->PostLanguageunderstandingDomainFeedback") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Nlufeedbackresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostLanguageunderstandingDomainVersionDetect invokes POST /api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/detect -// -// Detect intent, entities, etc. in the submitted text using the specified NLU domain version. -// -// -func (a LanguageUnderstandingApi) PostLanguageunderstandingDomainVersionDetect(domainId string, domainVersionId string, body Nludetectionrequest) (*Nludetectionresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/detect" - path = strings.Replace(path, "{domainId}", fmt.Sprintf("%v", domainId), -1) - path = strings.Replace(path, "{domainVersionId}", fmt.Sprintf("%v", domainVersionId), -1) - defaultReturn := new(Nludetectionresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'domainId' is set - if &domainId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'domainId' when calling LanguageUnderstandingApi->PostLanguageunderstandingDomainVersionDetect") - } - // verify the required parameter 'domainVersionId' is set - if &domainVersionId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'domainVersionId' when calling LanguageUnderstandingApi->PostLanguageunderstandingDomainVersionDetect") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling LanguageUnderstandingApi->PostLanguageunderstandingDomainVersionDetect") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Nludetectionresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostLanguageunderstandingDomainVersionPublish invokes POST /api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/publish -// -// Publish the draft NLU Domain Version. -// -// -func (a LanguageUnderstandingApi) PostLanguageunderstandingDomainVersionPublish(domainId string, domainVersionId string) (*Nludomainversion, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/publish" - path = strings.Replace(path, "{domainId}", fmt.Sprintf("%v", domainId), -1) - path = strings.Replace(path, "{domainVersionId}", fmt.Sprintf("%v", domainVersionId), -1) - defaultReturn := new(Nludomainversion) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'domainId' is set - if &domainId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'domainId' when calling LanguageUnderstandingApi->PostLanguageunderstandingDomainVersionPublish") - } - // verify the required parameter 'domainVersionId' is set - if &domainVersionId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'domainVersionId' when calling LanguageUnderstandingApi->PostLanguageunderstandingDomainVersionPublish") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Nludomainversion - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostLanguageunderstandingDomainVersionTrain invokes POST /api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/train -// -// Train the draft NLU Domain Version. -// -// -func (a LanguageUnderstandingApi) PostLanguageunderstandingDomainVersionTrain(domainId string, domainVersionId string) (*Nludomainversiontrainingresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/train" - path = strings.Replace(path, "{domainId}", fmt.Sprintf("%v", domainId), -1) - path = strings.Replace(path, "{domainVersionId}", fmt.Sprintf("%v", domainVersionId), -1) - defaultReturn := new(Nludomainversiontrainingresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'domainId' is set - if &domainId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'domainId' when calling LanguageUnderstandingApi->PostLanguageunderstandingDomainVersionTrain") - } - // verify the required parameter 'domainVersionId' is set - if &domainVersionId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'domainVersionId' when calling LanguageUnderstandingApi->PostLanguageunderstandingDomainVersionTrain") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Nludomainversiontrainingresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostLanguageunderstandingDomainVersions invokes POST /api/v2/languageunderstanding/domains/{domainId}/versions -// -// Create an NLU Domain Version. -// -// -func (a LanguageUnderstandingApi) PostLanguageunderstandingDomainVersions(domainId string, body Nludomainversion) (*Nludomainversion, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/languageunderstanding/domains/{domainId}/versions" - path = strings.Replace(path, "{domainId}", fmt.Sprintf("%v", domainId), -1) - defaultReturn := new(Nludomainversion) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'domainId' is set - if &domainId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'domainId' when calling LanguageUnderstandingApi->PostLanguageunderstandingDomainVersions") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling LanguageUnderstandingApi->PostLanguageunderstandingDomainVersions") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Nludomainversion - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostLanguageunderstandingDomains invokes POST /api/v2/languageunderstanding/domains -// -// Create an NLU Domain. -// -// -func (a LanguageUnderstandingApi) PostLanguageunderstandingDomains(body Nludomain) (*Nludomain, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/languageunderstanding/domains" - defaultReturn := new(Nludomain) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling LanguageUnderstandingApi->PostLanguageunderstandingDomains") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Nludomain - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutLanguageunderstandingDomainVersion invokes PUT /api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId} -// -// Update an NLU Domain Version. -// -// -func (a LanguageUnderstandingApi) PutLanguageunderstandingDomainVersion(domainId string, domainVersionId string, body Nludomainversion) (*Nludomainversion, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}" - path = strings.Replace(path, "{domainId}", fmt.Sprintf("%v", domainId), -1) - path = strings.Replace(path, "{domainVersionId}", fmt.Sprintf("%v", domainVersionId), -1) - defaultReturn := new(Nludomainversion) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'domainId' is set - if &domainId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'domainId' when calling LanguageUnderstandingApi->PutLanguageunderstandingDomainVersion") - } - // verify the required parameter 'domainVersionId' is set - if &domainVersionId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'domainVersionId' when calling LanguageUnderstandingApi->PutLanguageunderstandingDomainVersion") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling LanguageUnderstandingApi->PutLanguageunderstandingDomainVersion") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Nludomainversion - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/lexbot.go b/build/platformclientv2/lexbot.go deleted file mode 100644 index eeee3d8c2..000000000 --- a/build/platformclientv2/lexbot.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Lexbot -type Lexbot struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Description - A description of the Lex bot - Description *string `json:"description,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Lexbot) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/lexbotalias.go b/build/platformclientv2/lexbotalias.go deleted file mode 100644 index d04a8ce34..000000000 --- a/build/platformclientv2/lexbotalias.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Lexbotalias -type Lexbotalias struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Bot - The Lex bot this is an alias for - Bot *Lexbot `json:"bot,omitempty"` - - - // BotVersion - The version of the Lex bot this alias points at - BotVersion *string `json:"botVersion,omitempty"` - - - // Status - The status of the Lex bot alias - Status *string `json:"status,omitempty"` - - - // FailureReason - If the status is FAILED, Amazon Lex explains why it failed to build the bot - FailureReason *string `json:"failureReason,omitempty"` - - - // Language - The target language of the Lex bot - Language *string `json:"language,omitempty"` - - - // Intents - An array of Intents associated with this bot alias - Intents *[]Lexintent `json:"intents,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Lexbotalias) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/lexbotaliasentitylisting.go b/build/platformclientv2/lexbotaliasentitylisting.go deleted file mode 100644 index 8f57ee464..000000000 --- a/build/platformclientv2/lexbotaliasentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Lexbotaliasentitylisting -type Lexbotaliasentitylisting struct { - // Entities - Entities *[]Lexbotalias `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Lexbotaliasentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/lexbotentitylisting.go b/build/platformclientv2/lexbotentitylisting.go deleted file mode 100644 index 9fe7c95e9..000000000 --- a/build/platformclientv2/lexbotentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Lexbotentitylisting -type Lexbotentitylisting struct { - // Entities - Entities *[]Lexbot `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Lexbotentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/lexintent.go b/build/platformclientv2/lexintent.go deleted file mode 100644 index 50490cf30..000000000 --- a/build/platformclientv2/lexintent.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Lexintent -type Lexintent struct { - // Name - The intent name - Name *string `json:"name,omitempty"` - - - // Description - A description of the intent - Description *string `json:"description,omitempty"` - - - // Slots - An object mapping slot names to Slot objects - Slots *map[string]Lexslot `json:"slots,omitempty"` - - - // Version - The intent version - Version *string `json:"version,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Lexintent) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/lexslot.go b/build/platformclientv2/lexslot.go deleted file mode 100644 index a148afc5b..000000000 --- a/build/platformclientv2/lexslot.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Lexslot -type Lexslot struct { - // Name - The slot name - Name *string `json:"name,omitempty"` - - - // Description - The slot description - Description *string `json:"description,omitempty"` - - - // VarType - The slot type - VarType *string `json:"type,omitempty"` - - - // Priority - The priority of the slot - Priority *int `json:"priority,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Lexslot) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/library.go b/build/platformclientv2/library.go deleted file mode 100644 index aa10f1606..000000000 --- a/build/platformclientv2/library.go +++ /dev/null @@ -1,42 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Library -type Library struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The library name. - Name *string `json:"name,omitempty"` - - - // Version - Current version for this resource. - Version *int `json:"version,omitempty"` - - - // CreatedBy - User that created the library. - CreatedBy *User `json:"createdBy,omitempty"` - - - // DateCreated - The date and time the response was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // ResponseType - This value is deprecated. Responses representing message templates may be added to any library. - ResponseType *string `json:"responseType,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Library) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/libraryentitylisting.go b/build/platformclientv2/libraryentitylisting.go deleted file mode 100644 index 3212185e1..000000000 --- a/build/platformclientv2/libraryentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Libraryentitylisting -type Libraryentitylisting struct { - // Entities - Entities *[]Library `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Libraryentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/licenseapi.go b/build/platformclientv2/licenseapi.go deleted file mode 100644 index 641943aa4..000000000 --- a/build/platformclientv2/licenseapi.go +++ /dev/null @@ -1,658 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "encoding/json" -) - -// LicenseApi provides functions for API endpoints -type LicenseApi struct { - Configuration *Configuration -} - -// NewLicenseApi creates an API instance using the default configuration -func NewLicenseApi() *LicenseApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating LicenseApi with base path: %s", strings.ToLower(config.BasePath))) - return &LicenseApi{ - Configuration: config, - } -} - -// NewLicenseApiWithConfig creates an API instance using the provided configuration -func NewLicenseApiWithConfig(config *Configuration) *LicenseApi { - config.Debugf("Creating LicenseApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &LicenseApi{ - Configuration: config, - } -} - -// GetLicenseDefinition invokes GET /api/v2/license/definitions/{licenseId} -// -// Get PureCloud license definition. -// -// -func (a LicenseApi) GetLicenseDefinition(licenseId string) (*Licensedefinition, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/license/definitions/{licenseId}" - path = strings.Replace(path, "{licenseId}", fmt.Sprintf("%v", licenseId), -1) - defaultReturn := new(Licensedefinition) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'licenseId' is set - if &licenseId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'licenseId' when calling LicenseApi->GetLicenseDefinition") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Licensedefinition - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetLicenseDefinitions invokes GET /api/v2/license/definitions -// -// Get all PureCloud license definitions available for the organization. -// -// -func (a LicenseApi) GetLicenseDefinitions() ([]Licensedefinition, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/license/definitions" - defaultReturn := make([]Licensedefinition, 0) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload []Licensedefinition - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetLicenseToggle invokes GET /api/v2/license/toggles/{featureName} -// -// Get PureCloud license feature toggle value. -// -// -func (a LicenseApi) GetLicenseToggle(featureName string) (*Licenseorgtoggle, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/license/toggles/{featureName}" - path = strings.Replace(path, "{featureName}", fmt.Sprintf("%v", featureName), -1) - defaultReturn := new(Licenseorgtoggle) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'featureName' is set - if &featureName == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'featureName' when calling LicenseApi->GetLicenseToggle") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Licenseorgtoggle - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetLicenseUser invokes GET /api/v2/license/users/{userId} -// -// Get licenses for specified user. -// -// -func (a LicenseApi) GetLicenseUser(userId string) (*Licenseuser, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/license/users/{userId}" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Licenseuser) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling LicenseApi->GetLicenseUser") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Licenseuser - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetLicenseUsers invokes GET /api/v2/license/users -// -// Get a page of users and their licenses -// -// Retrieve a page of users in an organization along with the licenses they possess. -func (a LicenseApi) GetLicenseUsers(pageSize int, pageNumber int) (*Userlicensesentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/license/users" - defaultReturn := new(Userlicensesentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Userlicensesentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostLicenseInfer invokes POST /api/v2/license/infer -// -// Get a list of licenses inferred based on a list of roleIds -// -// -func (a LicenseApi) PostLicenseInfer(body []string) ([]string, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/license/infer" - defaultReturn := make([]string, 0) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload []string - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostLicenseOrganization invokes POST /api/v2/license/organization -// -// Update the organization's license assignments in a batch. -// -// -func (a LicenseApi) PostLicenseOrganization(body Licensebatchassignmentrequest) ([]Licenseupdatestatus, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/license/organization" - defaultReturn := make([]Licenseupdatestatus, 0) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload []Licenseupdatestatus - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostLicenseToggle invokes POST /api/v2/license/toggles/{featureName} -// -// Switch PureCloud license feature toggle value. -// -// -func (a LicenseApi) PostLicenseToggle(featureName string) (*Licenseorgtoggle, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/license/toggles/{featureName}" - path = strings.Replace(path, "{featureName}", fmt.Sprintf("%v", featureName), -1) - defaultReturn := new(Licenseorgtoggle) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'featureName' is set - if &featureName == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'featureName' when calling LicenseApi->PostLicenseToggle") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Licenseorgtoggle - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostLicenseUsers invokes POST /api/v2/license/users -// -// Fetch user licenses in a batch. -// -// -func (a LicenseApi) PostLicenseUsers(body []string) (*map[string]interface{}, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/license/users" - defaultReturn := new(map[string]interface{}) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *map[string]interface{} - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/licenseassignmentrequest.go b/build/platformclientv2/licenseassignmentrequest.go deleted file mode 100644 index 83efdabec..000000000 --- a/build/platformclientv2/licenseassignmentrequest.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Licenseassignmentrequest -type Licenseassignmentrequest struct { - // LicenseId - The id of the license to assign/unassign. - LicenseId *string `json:"licenseId,omitempty"` - - - // UserIdsAdd - The ids of users to assign this license to. - UserIdsAdd *[]string `json:"userIdsAdd,omitempty"` - - - // UserIdsRemove - The ids of users to unassign this license from. - UserIdsRemove *[]string `json:"userIdsRemove,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Licenseassignmentrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/licensebatchassignmentrequest.go b/build/platformclientv2/licensebatchassignmentrequest.go deleted file mode 100644 index 6beeffe26..000000000 --- a/build/platformclientv2/licensebatchassignmentrequest.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Licensebatchassignmentrequest -type Licensebatchassignmentrequest struct { - // Assignments - The list of license assignment updates to make. - Assignments *[]Licenseassignmentrequest `json:"assignments,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Licensebatchassignmentrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/licensedefinition.go b/build/platformclientv2/licensedefinition.go deleted file mode 100644 index a20dc7c61..000000000 --- a/build/platformclientv2/licensedefinition.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Licensedefinition -type Licensedefinition struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Description - Description *string `json:"description,omitempty"` - - - // Permissions - Permissions *Permissions `json:"permissions,omitempty"` - - - // Prerequisites - Prerequisites *[]Addressablelicensedefinition `json:"prerequisites,omitempty"` - - - // Comprises - Comprises *[]Licensedefinition `json:"comprises,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Licensedefinition) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/licenseorgtoggle.go b/build/platformclientv2/licenseorgtoggle.go deleted file mode 100644 index 74af53c5d..000000000 --- a/build/platformclientv2/licenseorgtoggle.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Licenseorgtoggle -type Licenseorgtoggle struct { - // FeatureName - FeatureName *string `json:"featureName,omitempty"` - - - // Enabled - Enabled *bool `json:"enabled,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Licenseorgtoggle) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/licenseupdatestatus.go b/build/platformclientv2/licenseupdatestatus.go deleted file mode 100644 index 729fe06d5..000000000 --- a/build/platformclientv2/licenseupdatestatus.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Licenseupdatestatus -type Licenseupdatestatus struct { - // UserId - UserId *string `json:"userId,omitempty"` - - - // LicenseId - LicenseId *string `json:"licenseId,omitempty"` - - - // Result - Result *string `json:"result,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Licenseupdatestatus) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/licenseuser.go b/build/platformclientv2/licenseuser.go deleted file mode 100644 index 7e94d5f0a..000000000 --- a/build/platformclientv2/licenseuser.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Licenseuser -type Licenseuser struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Licenses - Licenses *[]Licensedefinition `json:"licenses,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Licenseuser) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/line.go b/build/platformclientv2/line.go deleted file mode 100644 index 632fe57f9..000000000 --- a/build/platformclientv2/line.go +++ /dev/null @@ -1,98 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Line -type Line struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the entity. - Name *string `json:"name,omitempty"` - - - // Description - The resource's description. - Description *string `json:"description,omitempty"` - - - // Version - The current version of the resource. - Version *int `json:"version,omitempty"` - - - // DateCreated - The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // ModifiedBy - The ID of the user that last modified the resource. - ModifiedBy *string `json:"modifiedBy,omitempty"` - - - // CreatedBy - The ID of the user that created the resource. - CreatedBy *string `json:"createdBy,omitempty"` - - - // State - Indicates if the resource is active, inactive, or deleted. - State *string `json:"state,omitempty"` - - - // ModifiedByApp - The application that last modified the resource. - ModifiedByApp *string `json:"modifiedByApp,omitempty"` - - - // CreatedByApp - The application that created the resource. - CreatedByApp *string `json:"createdByApp,omitempty"` - - - // Properties - Properties *map[string]interface{} `json:"properties,omitempty"` - - - // EdgeGroup - EdgeGroup *Domainentityref `json:"edgeGroup,omitempty"` - - - // Template - Template *Domainentityref `json:"template,omitempty"` - - - // Site - Site *Domainentityref `json:"site,omitempty"` - - - // LineBaseSettings - LineBaseSettings *Domainentityref `json:"lineBaseSettings,omitempty"` - - - // PrimaryEdge - The primary edge associated to the line. (Deprecated) - PrimaryEdge *Edge `json:"primaryEdge,omitempty"` - - - // SecondaryEdge - The secondary edge associated to the line. (Deprecated) - SecondaryEdge *Edge `json:"secondaryEdge,omitempty"` - - - // LoggedInUser - LoggedInUser *Domainentityref `json:"loggedInUser,omitempty"` - - - // DefaultForUser - DefaultForUser *Domainentityref `json:"defaultForUser,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Line) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/linebase.go b/build/platformclientv2/linebase.go deleted file mode 100644 index 69cea2621..000000000 --- a/build/platformclientv2/linebase.go +++ /dev/null @@ -1,70 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Linebase -type Linebase struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the entity. - Name *string `json:"name,omitempty"` - - - // Description - The resource's description. - Description *string `json:"description,omitempty"` - - - // Version - The current version of the resource. - Version *int `json:"version,omitempty"` - - - // DateCreated - The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // ModifiedBy - The ID of the user that last modified the resource. - ModifiedBy *string `json:"modifiedBy,omitempty"` - - - // CreatedBy - The ID of the user that created the resource. - CreatedBy *string `json:"createdBy,omitempty"` - - - // State - Indicates if the resource is active, inactive, or deleted. - State *string `json:"state,omitempty"` - - - // ModifiedByApp - The application that last modified the resource. - ModifiedByApp *string `json:"modifiedByApp,omitempty"` - - - // CreatedByApp - The application that created the resource. - CreatedByApp *string `json:"createdByApp,omitempty"` - - - // LineMetaBase - LineMetaBase *Domainentityref `json:"lineMetaBase,omitempty"` - - - // Properties - Properties *map[string]interface{} `json:"properties,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Linebase) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/linebaseentitylisting.go b/build/platformclientv2/linebaseentitylisting.go deleted file mode 100644 index d3e01c105..000000000 --- a/build/platformclientv2/linebaseentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Linebaseentitylisting -type Linebaseentitylisting struct { - // Entities - Entities *[]Linebase `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Linebaseentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/lineentitylisting.go b/build/platformclientv2/lineentitylisting.go deleted file mode 100644 index 450c6a0cb..000000000 --- a/build/platformclientv2/lineentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Lineentitylisting -type Lineentitylisting struct { - // Entities - Entities *[]Line `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Lineentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/lineid.go b/build/platformclientv2/lineid.go deleted file mode 100644 index 9bca050fc..000000000 --- a/build/platformclientv2/lineid.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Lineid - User information for a Line account -type Lineid struct { - // Ids - The set of Line userIds that this person has. Each userId is specific to the Line channel that the user interacts with. - Ids *[]Lineuserid `json:"ids,omitempty"` - - - // DisplayName - The displayName of this person's account in Line - DisplayName *string `json:"displayName,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Lineid) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/lineintegration.go b/build/platformclientv2/lineintegration.go deleted file mode 100644 index 3ecfa95bf..000000000 --- a/build/platformclientv2/lineintegration.go +++ /dev/null @@ -1,70 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Lineintegration -type Lineintegration struct { - // Id - A unique Integration Id - Id *string `json:"id,omitempty"` - - - // Name - The name of the LINE Integration - Name *string `json:"name,omitempty"` - - - // ChannelId - The Channel Id from LINE messenger - ChannelId *string `json:"channelId,omitempty"` - - - // WebhookUri - The Webhook URI to be updated in LINE platform - WebhookUri *string `json:"webhookUri,omitempty"` - - - // Status - The status of the LINE Integration - Status *string `json:"status,omitempty"` - - - // Recipient - The recipient associated to the Line Integration. This recipient is used to associate a flow to an integration - Recipient *Domainentityref `json:"recipient,omitempty"` - - - // DateCreated - Date this Integration was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - Date this Integration was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // CreatedBy - User reference that created this Integration - CreatedBy *Domainentityref `json:"createdBy,omitempty"` - - - // ModifiedBy - User reference that last modified this Integration - ModifiedBy *Domainentityref `json:"modifiedBy,omitempty"` - - - // Version - Version number required for updates. - Version *int `json:"version,omitempty"` - - - // CreateStatus - Status of asynchronous create operation - CreateStatus *string `json:"createStatus,omitempty"` - - - // CreateError - Error information returned, if createStatus is set to Error - CreateError *Errorbody `json:"createError,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Lineintegration) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/lineintegrationentitylisting.go b/build/platformclientv2/lineintegrationentitylisting.go deleted file mode 100644 index 2be8db816..000000000 --- a/build/platformclientv2/lineintegrationentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Lineintegrationentitylisting -type Lineintegrationentitylisting struct { - // Entities - Entities *[]Lineintegration `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Lineintegrationentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/lineintegrationrequest.go b/build/platformclientv2/lineintegrationrequest.go deleted file mode 100644 index cd4fd39c2..000000000 --- a/build/platformclientv2/lineintegrationrequest.go +++ /dev/null @@ -1,41 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Lineintegrationrequest -type Lineintegrationrequest struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the LINE Integration - Name *string `json:"name,omitempty"` - - - // ChannelId - The Channel Id from LINE messenger. New Official LINE account: To create a new official account, LINE requires a Webhook URL. It can be created without specifying Channel Id & Channel Secret. Once the Official account is created by LINE, use the update LINE Integration API to update Channel Id and Channel Secret. All other accounts: Channel Id is mandatory. (NOTE: ChannelId can only be updated if the integration is set to inactive) - ChannelId *string `json:"channelId,omitempty"` - - - // ChannelSecret - The Channel Secret from LINE messenger. New Official LINE account: To create a new official account, LINE requires a Webhook URL. It can be created without specifying Channel Id & Channel Secret. Once the Official account is created by LINE, use the update LINE Integration API to update Channel Id and Channel Secret. All other accounts: Channel Secret is mandatory. (NOTE: ChannelSecret can only be updated if the integration is set to inactive) - ChannelSecret *string `json:"channelSecret,omitempty"` - - - // SwitcherSecret - The Switcher Secret from LINE messenger. Some line official accounts are switcher functionality enabled. If the LINE account used for this integration is switcher enabled, then switcher secret is a required field. This secret can be found in your create documentation provided by LINE - SwitcherSecret *string `json:"switcherSecret,omitempty"` - - - // ServiceCode - The Service Code from LINE messenger. Only applicable to LINE Enterprise accounts. This service code can be found in your create documentation provided by LINE - ServiceCode *string `json:"serviceCode,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Lineintegrationrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/linestatus.go b/build/platformclientv2/linestatus.go deleted file mode 100644 index 1810dae71..000000000 --- a/build/platformclientv2/linestatus.go +++ /dev/null @@ -1,34 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Linestatus -type Linestatus struct { - // Id - The id of this line - Id *string `json:"id,omitempty"` - - - // Reachable - Indicates whether the edge can reach the line. - Reachable *bool `json:"reachable,omitempty"` - - - // AddressOfRecord - The line's address of record. - AddressOfRecord *string `json:"addressOfRecord,omitempty"` - - - // ContactAddresses - The addresses used to contact the line. - ContactAddresses *[]string `json:"contactAddresses,omitempty"` - - - // ReachableStateTime - The time the line entered its current reachable state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ReachableStateTime *time.Time `json:"reachableStateTime,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Linestatus) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/lineuserid.go b/build/platformclientv2/lineuserid.go deleted file mode 100644 index 2e2445a7d..000000000 --- a/build/platformclientv2/lineuserid.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Lineuserid - Channel-specific User ID for Line accounts -type Lineuserid struct { - // UserId - The unique channel-specific userId for the user - UserId *string `json:"userId,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Lineuserid) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/listitemcomponent.go b/build/platformclientv2/listitemcomponent.go deleted file mode 100644 index e1ec1e957..000000000 --- a/build/platformclientv2/listitemcomponent.go +++ /dev/null @@ -1,41 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Listitemcomponent - An entry in List template -type Listitemcomponent struct { - // Id - An ID assigned to this component - Id *string `json:"id,omitempty"` - - - // Rmid - An ID of the rich message instance - Rmid *string `json:"rmid,omitempty"` - - - // VarType - The type of component to render - VarType *string `json:"type,omitempty"` - - - // Image - Path or URI to an image file - Image *string `json:"image,omitempty"` - - - // Title - The main headline of the list item - Title *string `json:"title,omitempty"` - - - // Description - Text to show in the description row - Description *string `json:"description,omitempty"` - - - // Actions - User actions available on the content. All actions are optional and all actions are executed simultaneously. - Actions *Contentactions `json:"actions,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Listitemcomponent) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/listwrapperinterval.go b/build/platformclientv2/listwrapperinterval.go deleted file mode 100644 index 1f3dd27d8..000000000 --- a/build/platformclientv2/listwrapperinterval.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Listwrapperinterval -type Listwrapperinterval struct { - // Values - Values *[]string `json:"values,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Listwrapperinterval) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/listwrappershiftstartvariance.go b/build/platformclientv2/listwrappershiftstartvariance.go deleted file mode 100644 index a0b33be18..000000000 --- a/build/platformclientv2/listwrappershiftstartvariance.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Listwrappershiftstartvariance -type Listwrappershiftstartvariance struct { - // Values - Values *[]Shiftstartvariance `json:"values,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Listwrappershiftstartvariance) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/localencryptionconfiguration.go b/build/platformclientv2/localencryptionconfiguration.go deleted file mode 100644 index 73a922d55..000000000 --- a/build/platformclientv2/localencryptionconfiguration.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Localencryptionconfiguration -type Localencryptionconfiguration struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Url - The url for decryption. This must specify the path to where Purecloud can requests decryption - Url *string `json:"url,omitempty"` - - - // ApiId - The api id for Hawk Authentication. - ApiId *string `json:"apiId,omitempty"` - - - // ApiKey - The api shared symmetric key used for hawk authentication - ApiKey *string `json:"apiKey,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Localencryptionconfiguration) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/localencryptionconfigurationlisting.go b/build/platformclientv2/localencryptionconfigurationlisting.go deleted file mode 100644 index d8baac278..000000000 --- a/build/platformclientv2/localencryptionconfigurationlisting.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Localencryptionconfigurationlisting -type Localencryptionconfigurationlisting struct { - // Total - Total *int `json:"total,omitempty"` - - - // Entities - Entities *[]Localencryptionconfiguration `json:"entities,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Localencryptionconfigurationlisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/localencryptionkeyrequest.go b/build/platformclientv2/localencryptionkeyrequest.go deleted file mode 100644 index 2c55854e4..000000000 --- a/build/platformclientv2/localencryptionkeyrequest.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Localencryptionkeyrequest -type Localencryptionkeyrequest struct { - // ConfigId - The local configuration id that contains metadata on private local service - ConfigId *string `json:"configId,omitempty"` - - - // PublicKey - Base 64 encoded public key, generated by the local service. - PublicKey *string `json:"publicKey,omitempty"` - - - // KeypairId - The key pair id from the local service. - KeypairId *string `json:"keypairId,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Localencryptionkeyrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/location.go b/build/platformclientv2/location.go deleted file mode 100644 index 629565f34..000000000 --- a/build/platformclientv2/location.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Location -type Location struct { - // Id - Unique identifier for the location - Id *string `json:"id,omitempty"` - - - // FloorplanId - Unique identifier for the location floorplan image - FloorplanId *string `json:"floorplanId,omitempty"` - - - // Coordinates - Users coordinates on the floorplan. Only used when floorplanImage is set - Coordinates *map[string]float64 `json:"coordinates,omitempty"` - - - // Notes - Optional description on the users location - Notes *string `json:"notes,omitempty"` - - - // LocationDefinition - LocationDefinition *Locationdefinition `json:"locationDefinition,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Location) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/locationaddress.go b/build/platformclientv2/locationaddress.go deleted file mode 100644 index 848573d60..000000000 --- a/build/platformclientv2/locationaddress.go +++ /dev/null @@ -1,41 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Locationaddress -type Locationaddress struct { - // City - City *string `json:"city,omitempty"` - - - // Country - Country *string `json:"country,omitempty"` - - - // CountryName - CountryName *string `json:"countryName,omitempty"` - - - // State - State *string `json:"state,omitempty"` - - - // Street1 - Street1 *string `json:"street1,omitempty"` - - - // Street2 - Street2 *string `json:"street2,omitempty"` - - - // Zipcode - Zipcode *string `json:"zipcode,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Locationaddress) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/locationaddressverificationdetails.go b/build/platformclientv2/locationaddressverificationdetails.go deleted file mode 100644 index 11052c7f9..000000000 --- a/build/platformclientv2/locationaddressverificationdetails.go +++ /dev/null @@ -1,30 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Locationaddressverificationdetails -type Locationaddressverificationdetails struct { - // Status - Status of address verification process - Status *string `json:"status,omitempty"` - - - // DateFinished - Finished time of address verification process. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateFinished *time.Time `json:"dateFinished,omitempty"` - - - // DateStarted - Time started of address verification process. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateStarted *time.Time `json:"dateStarted,omitempty"` - - - // Service - Third party service used for address verification - Service *string `json:"service,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Locationaddressverificationdetails) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/locationcreatedefinition.go b/build/platformclientv2/locationcreatedefinition.go deleted file mode 100644 index e64b85fe4..000000000 --- a/build/platformclientv2/locationcreatedefinition.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Locationcreatedefinition -type Locationcreatedefinition struct { - // Name - The name of the Location. Required for creates, not required for updates - Name *string `json:"name,omitempty"` - - - // Version - Current version of the location - Version *int `json:"version,omitempty"` - - - // State - Current activity status of the location. - State *string `json:"state,omitempty"` - - - // Path - A list of ancestor ids - Path *[]string `json:"path,omitempty"` - - - // Notes - Notes for the location - Notes *string `json:"notes,omitempty"` - - - // ContactUser - The user id of the location contact - ContactUser *string `json:"contactUser,omitempty"` - - - // EmergencyNumber - Emergency number for the location - EmergencyNumber *Locationemergencynumber `json:"emergencyNumber,omitempty"` - - - // Address - Address of the location - Address *Locationaddress `json:"address,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Locationcreatedefinition) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/locationdefinition.go b/build/platformclientv2/locationdefinition.go deleted file mode 100644 index e78eb9566..000000000 --- a/build/platformclientv2/locationdefinition.go +++ /dev/null @@ -1,77 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Locationdefinition -type Locationdefinition struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // ContactUser - Site contact for the location entity - ContactUser *Addressableentityref `json:"contactUser,omitempty"` - - - // EmergencyNumber - Emergency number for the location entity - EmergencyNumber *Locationemergencynumber `json:"emergencyNumber,omitempty"` - - - // Address - Address *Locationaddress `json:"address,omitempty"` - - - // State - Current state of the location entity - State *string `json:"state,omitempty"` - - - // Notes - Notes for the location entity - Notes *string `json:"notes,omitempty"` - - - // Version - Current version of the location entity, value to be supplied should be retrieved by a GET or on create/update response - Version *int `json:"version,omitempty"` - - - // Path - A list of ancestor IDs in order - Path *[]string `json:"path,omitempty"` - - - // ProfileImage - Profile image of the location entity, retrieved with ?expand=images query parameter - ProfileImage *[]Locationimage `json:"profileImage,omitempty"` - - - // FloorplanImage - Floorplan images of the location entity, retrieved with ?expand=images query parameter - FloorplanImage *[]Locationimage `json:"floorplanImage,omitempty"` - - - // AddressVerificationDetails - Address verification information, retrieve dwith the ?expand=addressVerificationDetails query parameter - AddressVerificationDetails *Locationaddressverificationdetails `json:"addressVerificationDetails,omitempty"` - - - // AddressVerified - Boolean field which states if the address has been verified as an actual address - AddressVerified *bool `json:"addressVerified,omitempty"` - - - // AddressStored - Boolean field which states if the address has been stored for E911 - AddressStored *bool `json:"addressStored,omitempty"` - - - // Images - Images *string `json:"images,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Locationdefinition) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/locationemergencynumber.go b/build/platformclientv2/locationemergencynumber.go deleted file mode 100644 index 47a462deb..000000000 --- a/build/platformclientv2/locationemergencynumber.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Locationemergencynumber -type Locationemergencynumber struct { - // E164 - E164 *string `json:"e164,omitempty"` - - - // Number - Number *string `json:"number,omitempty"` - - - // VarType - The type of emergency number. - VarType *string `json:"type,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Locationemergencynumber) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/locationentitylisting.go b/build/platformclientv2/locationentitylisting.go deleted file mode 100644 index 4bd2b7743..000000000 --- a/build/platformclientv2/locationentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Locationentitylisting -type Locationentitylisting struct { - // Entities - Entities *[]Locationdefinition `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Locationentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/locationimage.go b/build/platformclientv2/locationimage.go deleted file mode 100644 index a6ee13636..000000000 --- a/build/platformclientv2/locationimage.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Locationimage -type Locationimage struct { - // Resolution - Height and/or width of image. ex: 640x480 or x128 - Resolution *string `json:"resolution,omitempty"` - - - // ImageUri - ImageUri *string `json:"imageUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Locationimage) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/locationsapi.go b/build/platformclientv2/locationsapi.go deleted file mode 100644 index c7ac9d5c8..000000000 --- a/build/platformclientv2/locationsapi.go +++ /dev/null @@ -1,676 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "encoding/json" -) - -// LocationsApi provides functions for API endpoints -type LocationsApi struct { - Configuration *Configuration -} - -// NewLocationsApi creates an API instance using the default configuration -func NewLocationsApi() *LocationsApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating LocationsApi with base path: %s", strings.ToLower(config.BasePath))) - return &LocationsApi{ - Configuration: config, - } -} - -// NewLocationsApiWithConfig creates an API instance using the provided configuration -func NewLocationsApiWithConfig(config *Configuration) *LocationsApi { - config.Debugf("Creating LocationsApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &LocationsApi{ - Configuration: config, - } -} - -// DeleteLocation invokes DELETE /api/v2/locations/{locationId} -// -// Delete a location -// -// -func (a LocationsApi) DeleteLocation(locationId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/locations/{locationId}" - path = strings.Replace(path, "{locationId}", fmt.Sprintf("%v", locationId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'locationId' is set - if &locationId == nil { - // - return nil, errors.New("Missing required parameter 'locationId' when calling LocationsApi->DeleteLocation") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// GetLocation invokes GET /api/v2/locations/{locationId} -// -// Get Location by ID. -// -// -func (a LocationsApi) GetLocation(locationId string, expand []string) (*Locationdefinition, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/locations/{locationId}" - path = strings.Replace(path, "{locationId}", fmt.Sprintf("%v", locationId), -1) - defaultReturn := new(Locationdefinition) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'locationId' is set - if &locationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'locationId' when calling LocationsApi->GetLocation") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Locationdefinition - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetLocationSublocations invokes GET /api/v2/locations/{locationId}/sublocations -// -// Get sublocations for location ID. -// -// -func (a LocationsApi) GetLocationSublocations(locationId string) (*Locationentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/locations/{locationId}/sublocations" - path = strings.Replace(path, "{locationId}", fmt.Sprintf("%v", locationId), -1) - defaultReturn := new(Locationentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'locationId' is set - if &locationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'locationId' when calling LocationsApi->GetLocationSublocations") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Locationentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetLocations invokes GET /api/v2/locations -// -// Get a list of all locations. -// -// -func (a LocationsApi) GetLocations(pageSize int, pageNumber int, id []string, sortOrder string) (*Locationentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/locations" - defaultReturn := new(Locationentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range id { - queryParams["id"] = value - } - } else { - queryParams["id"] = a.Configuration.APIClient.ParameterToString(id, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Locationentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetLocationsSearch invokes GET /api/v2/locations/search -// -// Search locations using the q64 value returned from a previous search -// -// -func (a LocationsApi) GetLocationsSearch(q64 string, expand []string) (*Locationssearchresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/locations/search" - defaultReturn := new(Locationssearchresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'q64' is set - if &q64 == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'q64' when calling LocationsApi->GetLocationsSearch") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(q64).(string); ok { - if str != "" { - queryParams["q64"] = a.Configuration.APIClient.ParameterToString(q64, collectionFormat) - } - } else { - queryParams["q64"] = a.Configuration.APIClient.ParameterToString(q64, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Locationssearchresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchLocation invokes PATCH /api/v2/locations/{locationId} -// -// Update a location -// -// -func (a LocationsApi) PatchLocation(locationId string, body Locationupdatedefinition) (*Locationdefinition, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/locations/{locationId}" - path = strings.Replace(path, "{locationId}", fmt.Sprintf("%v", locationId), -1) - defaultReturn := new(Locationdefinition) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'locationId' is set - if &locationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'locationId' when calling LocationsApi->PatchLocation") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling LocationsApi->PatchLocation") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Locationdefinition - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostLocations invokes POST /api/v2/locations -// -// Create a location -// -// -func (a LocationsApi) PostLocations(body Locationcreatedefinition) (*Locationdefinition, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/locations" - defaultReturn := new(Locationdefinition) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling LocationsApi->PostLocations") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Locationdefinition - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostLocationsSearch invokes POST /api/v2/locations/search -// -// Search locations -// -// -func (a LocationsApi) PostLocationsSearch(body Locationsearchrequest) (*Locationssearchresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/locations/search" - defaultReturn := new(Locationssearchresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling LocationsApi->PostLocationsSearch") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Locationssearchresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/locationsearchcriteria.go b/build/platformclientv2/locationsearchcriteria.go deleted file mode 100644 index eabf9309b..000000000 --- a/build/platformclientv2/locationsearchcriteria.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Locationsearchcriteria -type Locationsearchcriteria struct { - // EndValue - The end value of the range. This field is used for range search types. - EndValue *string `json:"endValue,omitempty"` - - - // Values - A list of values for the search to match against - Values *[]string `json:"values,omitempty"` - - - // StartValue - The start value of the range. This field is used for range search types. - StartValue *string `json:"startValue,omitempty"` - - - // Fields - Field names to search against - Fields *[]string `json:"fields,omitempty"` - - - // Value - A value for the search to match against - Value *string `json:"value,omitempty"` - - - // Operator - How to apply this search criteria against other criteria - Operator *string `json:"operator,omitempty"` - - - // Group - Groups multiple conditions - Group *[]Locationsearchcriteria `json:"group,omitempty"` - - - // DateFormat - Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX. - DateFormat *string `json:"dateFormat,omitempty"` - - - // VarType - Search Type - VarType *string `json:"type,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Locationsearchcriteria) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/locationsearchrequest.go b/build/platformclientv2/locationsearchrequest.go deleted file mode 100644 index 0873a3907..000000000 --- a/build/platformclientv2/locationsearchrequest.go +++ /dev/null @@ -1,41 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Locationsearchrequest -type Locationsearchrequest struct { - // SortOrder - The sort order for results - SortOrder *string `json:"sortOrder,omitempty"` - - - // SortBy - The field in the resource that you want to sort the results by - SortBy *string `json:"sortBy,omitempty"` - - - // PageSize - The number of results per page - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - The page of resources you want to retrieve - PageNumber *int `json:"pageNumber,omitempty"` - - - // Sort - Multi-value sort order, list of multiple sort values - Sort *[]Searchsort `json:"sort,omitempty"` - - - // Expand - Provides more details about a specified resource - Expand *[]string `json:"expand,omitempty"` - - - // Query - Query *[]Locationsearchcriteria `json:"query,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Locationsearchrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/locationssearchresponse.go b/build/platformclientv2/locationssearchresponse.go deleted file mode 100644 index 6d4fd59a1..000000000 --- a/build/platformclientv2/locationssearchresponse.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Locationssearchresponse -type Locationssearchresponse struct { - // Total - The total number of results found - Total *int `json:"total,omitempty"` - - - // PageCount - The total number of pages - PageCount *int `json:"pageCount,omitempty"` - - - // PageSize - The current page size - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - The current page number - PageNumber *int `json:"pageNumber,omitempty"` - - - // PreviousPage - Q64 value for the previous page of results - PreviousPage *string `json:"previousPage,omitempty"` - - - // CurrentPage - Q64 value for the current page of results - CurrentPage *string `json:"currentPage,omitempty"` - - - // NextPage - Q64 value for the next page of results - NextPage *string `json:"nextPage,omitempty"` - - - // Types - Resource types the search was performed against - Types *[]string `json:"types,omitempty"` - - - // Results - Search results - Results *[]Locationdefinition `json:"results,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Locationssearchresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/locationupdatedefinition.go b/build/platformclientv2/locationupdatedefinition.go deleted file mode 100644 index 8dbce9c6d..000000000 --- a/build/platformclientv2/locationupdatedefinition.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Locationupdatedefinition -type Locationupdatedefinition struct { - // Name - The name of the Location. Required for creates, not required for updates - Name *string `json:"name,omitempty"` - - - // Version - Current version of the location - Version *int `json:"version,omitempty"` - - - // State - Current activity status of the location. - State *string `json:"state,omitempty"` - - - // Path - A list of ancestor ids - Path *[]string `json:"path,omitempty"` - - - // Notes - Notes for the location - Notes *string `json:"notes,omitempty"` - - - // ContactUser - The user id of the location contact - ContactUser *string `json:"contactUser,omitempty"` - - - // EmergencyNumber - Emergency number for the location - EmergencyNumber *Locationemergencynumber `json:"emergencyNumber,omitempty"` - - - // Address - Address of the location - Address *Locationaddress `json:"address,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Locationupdatedefinition) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/lockinfo.go b/build/platformclientv2/lockinfo.go deleted file mode 100644 index 8131e9106..000000000 --- a/build/platformclientv2/lockinfo.go +++ /dev/null @@ -1,30 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Lockinfo -type Lockinfo struct { - // LockedBy - LockedBy *Domainentityref `json:"lockedBy,omitempty"` - - - // DateCreated - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateExpires - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateExpires *time.Time `json:"dateExpires,omitempty"` - - - // Action - Action *string `json:"action,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Lockinfo) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/logcaptureuserconfiguration.go b/build/platformclientv2/logcaptureuserconfiguration.go deleted file mode 100644 index dc6015c9e..000000000 --- a/build/platformclientv2/logcaptureuserconfiguration.go +++ /dev/null @@ -1,26 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Logcaptureuserconfiguration -type Logcaptureuserconfiguration struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // DateExpired - Indicates when log capture will be turned off for the user. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateExpired *time.Time `json:"dateExpired,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Logcaptureuserconfiguration) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/logicalinterfaceentitylisting.go b/build/platformclientv2/logicalinterfaceentitylisting.go deleted file mode 100644 index ed8207f8a..000000000 --- a/build/platformclientv2/logicalinterfaceentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Logicalinterfaceentitylisting -type Logicalinterfaceentitylisting struct { - // Entities - Entities *[]Domainlogicalinterface `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Logicalinterfaceentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/mailfromresult.go b/build/platformclientv2/mailfromresult.go deleted file mode 100644 index 7c00c5e9a..000000000 --- a/build/platformclientv2/mailfromresult.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Mailfromresult -type Mailfromresult struct { - // Status - The verification status. - Status *string `json:"status,omitempty"` - - - // Records - The list of DNS records that pertain that need to exist for verification. - Records *[]Record `json:"records,omitempty"` - - - // MailFromDomain - The custom MAIL FROM domain. - MailFromDomain *string `json:"mailFromDomain,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Mailfromresult) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/managementunit.go b/build/platformclientv2/managementunit.go deleted file mode 100644 index 5df8d923e..000000000 --- a/build/platformclientv2/managementunit.go +++ /dev/null @@ -1,58 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Managementunit - Management Unit object for Workforce Management -type Managementunit struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Division - The division to which this entity belongs. - Division *Division `json:"division,omitempty"` - - - // StartDayOfWeek - Start day of week for scheduling and forecasting purposes. Moving to Business Unit - StartDayOfWeek *string `json:"startDayOfWeek,omitempty"` - - - // TimeZone - The time zone for the management unit in standard Olson format. Moving to Business Unit - TimeZone *string `json:"timeZone,omitempty"` - - - // Settings - The configuration settings for this management unit - Settings *Managementunitsettingsresponse `json:"settings,omitempty"` - - - // Metadata - Version info metadata for this management unit. Deprecated, use settings.metadata - Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"` - - - // Version - The version of the underlying entity. Deprecated, use field from settings.metadata instead - Version *int `json:"version,omitempty"` - - - // DateModified - The date and time at which this entity was last modified. Deprecated, use field from settings.metadata instead. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // ModifiedBy - The user who last modified this entity. Deprecated, use field from settings.metadata instead - ModifiedBy *Userreference `json:"modifiedBy,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Managementunit) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/managementunitlisting.go b/build/platformclientv2/managementunitlisting.go deleted file mode 100644 index 1b5296a4d..000000000 --- a/build/platformclientv2/managementunitlisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Managementunitlisting -type Managementunitlisting struct { - // Entities - Entities *[]Managementunit `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Managementunitlisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/managementunitreference.go b/build/platformclientv2/managementunitreference.go deleted file mode 100644 index 85268083f..000000000 --- a/build/platformclientv2/managementunitreference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Managementunitreference - Management unit reference object for Workforce Management (ID/selfUri only) -type Managementunitreference struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Managementunitreference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/managementunitsettingsrequest.go b/build/platformclientv2/managementunitsettingsrequest.go deleted file mode 100644 index 158aaf8d1..000000000 --- a/build/platformclientv2/managementunitsettingsrequest.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Managementunitsettingsrequest - Management Unit Settings -type Managementunitsettingsrequest struct { - // Adherence - Adherence settings for this management unit - Adherence *Adherencesettings `json:"adherence,omitempty"` - - - // ShortTermForecasting - Short term forecasting settings for this management unit. Moving to Business Unit - ShortTermForecasting *Shorttermforecastingsettings `json:"shortTermForecasting,omitempty"` - - - // TimeOff - Time off request settings for this management unit - TimeOff *Timeoffrequestsettings `json:"timeOff,omitempty"` - - - // Scheduling - Scheduling settings for this management unit - Scheduling *Schedulingsettingsrequest `json:"scheduling,omitempty"` - - - // ShiftTrading - Shift trade settings for this management unit - ShiftTrading *Shifttradesettings `json:"shiftTrading,omitempty"` - - - // Metadata - Version info metadata for the associated management unit - Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Managementunitsettingsrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/managementunitsettingsresponse.go b/build/platformclientv2/managementunitsettingsresponse.go deleted file mode 100644 index c3cd74962..000000000 --- a/build/platformclientv2/managementunitsettingsresponse.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Managementunitsettingsresponse -type Managementunitsettingsresponse struct { - // Adherence - Adherence settings for this management unit - Adherence *Adherencesettings `json:"adherence,omitempty"` - - - // ShortTermForecasting - Short term forecasting settings for this management unit - ShortTermForecasting *Shorttermforecastingsettings `json:"shortTermForecasting,omitempty"` - - - // TimeOff - Time off request settings for this management unit - TimeOff *Timeoffrequestsettings `json:"timeOff,omitempty"` - - - // Scheduling - Scheduling settings for this management unit - Scheduling *Schedulingsettingsresponse `json:"scheduling,omitempty"` - - - // ShiftTrading - Shift trade settings for this management unit - ShiftTrading *Shifttradesettings `json:"shiftTrading,omitempty"` - - - // Metadata - Version info metadata for the associated management unit - Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Managementunitsettingsresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/manager.go b/build/platformclientv2/manager.go deleted file mode 100644 index d99cde7a8..000000000 --- a/build/platformclientv2/manager.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Manager - Defines a SCIM manager. -type Manager struct { - // Value - The ID of the manager. - Value *string `json:"value,omitempty"` - - - // Ref - The reference URI of the manager's user record. - Ref *string `json:"$ref,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Manager) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/matchshifttraderequest.go b/build/platformclientv2/matchshifttraderequest.go deleted file mode 100644 index 346e5f6cb..000000000 --- a/build/platformclientv2/matchshifttraderequest.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Matchshifttraderequest -type Matchshifttraderequest struct { - // ReceivingScheduleId - The ID of the schedule with which the shift trade is associated - ReceivingScheduleId *string `json:"receivingScheduleId,omitempty"` - - - // ReceivingShiftId - The ID of the shift the receiving user is giving up in trade, if applicable - ReceivingShiftId *string `json:"receivingShiftId,omitempty"` - - - // Metadata - Version metadata for the shift trade - Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Matchshifttraderequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/matchshifttraderesponse.go b/build/platformclientv2/matchshifttraderesponse.go deleted file mode 100644 index e6731711c..000000000 --- a/build/platformclientv2/matchshifttraderesponse.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Matchshifttraderesponse -type Matchshifttraderesponse struct { - // Trade - The associated shift trade - Trade *Shifttraderesponse `json:"trade,omitempty"` - - - // Violations - Constraint violations which disallow this shift trade - Violations *[]Shifttradematchviolation `json:"violations,omitempty"` - - - // AdminReviewViolations - Constraint violations for this shift trade which require shift trade administrator review - AdminReviewViolations *[]Shifttradematchviolation `json:"adminReviewViolations,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Matchshifttraderesponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/maxlength.go b/build/platformclientv2/maxlength.go deleted file mode 100644 index 70eea4c2b..000000000 --- a/build/platformclientv2/maxlength.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Maxlength -type Maxlength struct { - // Min - A non-negative integer for a text-based schema field denoting the minimum largest length string the field can contain for a schema instance. - Min *int `json:"min,omitempty"` - - - // Max - A non-negative integer for a text-based schema field denoting the maximum largest string the field can contain for a schema instance. - Max *int `json:"max,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Maxlength) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/maxparticipants.go b/build/platformclientv2/maxparticipants.go deleted file mode 100644 index 6dae04c1f..000000000 --- a/build/platformclientv2/maxparticipants.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Maxparticipants -type Maxparticipants struct { - // MaxParticipants - The maximum number of participants that are allowed on a conversation. - MaxParticipants *int `json:"maxParticipants,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Maxparticipants) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/mediaendpointstatdetailqueryclause.go b/build/platformclientv2/mediaendpointstatdetailqueryclause.go deleted file mode 100644 index 07d1a9445..000000000 --- a/build/platformclientv2/mediaendpointstatdetailqueryclause.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Mediaendpointstatdetailqueryclause -type Mediaendpointstatdetailqueryclause struct { - // VarType - Boolean operation to apply to the provided predicates - VarType *string `json:"type,omitempty"` - - - // Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value). - Predicates *[]Mediaendpointstatdetailquerypredicate `json:"predicates,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Mediaendpointstatdetailqueryclause) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/mediaendpointstatdetailqueryfilter.go b/build/platformclientv2/mediaendpointstatdetailqueryfilter.go deleted file mode 100644 index 2438ebe75..000000000 --- a/build/platformclientv2/mediaendpointstatdetailqueryfilter.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Mediaendpointstatdetailqueryfilter -type Mediaendpointstatdetailqueryfilter struct { - // VarType - Boolean operation to apply to the provided predicates and clauses - VarType *string `json:"type,omitempty"` - - - // Clauses - Boolean 'and/or' logic with up to two-levels of nesting - Clauses *[]Mediaendpointstatdetailqueryclause `json:"clauses,omitempty"` - - - // Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value). - Predicates *[]Mediaendpointstatdetailquerypredicate `json:"predicates,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Mediaendpointstatdetailqueryfilter) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/mediaendpointstatdetailquerypredicate.go b/build/platformclientv2/mediaendpointstatdetailquerypredicate.go deleted file mode 100644 index fa5acb2ce..000000000 --- a/build/platformclientv2/mediaendpointstatdetailquerypredicate.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Mediaendpointstatdetailquerypredicate -type Mediaendpointstatdetailquerypredicate struct { - // VarType - Optional type, can usually be inferred - VarType *string `json:"type,omitempty"` - - - // Dimension - Left hand side for dimension predicates - Dimension *string `json:"dimension,omitempty"` - - - // Operator - Optional operator, default is matches - Operator *string `json:"operator,omitempty"` - - - // Value - Right hand side for dimension predicates - Value *string `json:"value,omitempty"` - - - // VarRange - Right hand side for dimension predicates - VarRange *Numericrange `json:"range,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Mediaendpointstatdetailquerypredicate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/mediaparticipantrequest.go b/build/platformclientv2/mediaparticipantrequest.go deleted file mode 100644 index 1d003aa9d..000000000 --- a/build/platformclientv2/mediaparticipantrequest.go +++ /dev/null @@ -1,41 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Mediaparticipantrequest -type Mediaparticipantrequest struct { - // Wrapup - Wrap-up to assign to this participant. - Wrapup *Wrapup `json:"wrapup,omitempty"` - - - // State - The state to update to set for this participant's communications. Possible values are: 'connected' and 'disconnected'. - State *string `json:"state,omitempty"` - - - // Recording - True to enable recording of this participant, otherwise false to disable recording. - Recording *bool `json:"recording,omitempty"` - - - // Muted - True to mute this conversation participant. - Muted *bool `json:"muted,omitempty"` - - - // Confined - True to confine this conversation participant. Should only be used for ad-hoc conferences - Confined *bool `json:"confined,omitempty"` - - - // Held - True to hold this conversation participant. - Held *bool `json:"held,omitempty"` - - - // WrapupSkipped - True to skip wrap-up for this participant. - WrapupSkipped *bool `json:"wrapupSkipped,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Mediaparticipantrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/mediapolicies.go b/build/platformclientv2/mediapolicies.go deleted file mode 100644 index afd2a370a..000000000 --- a/build/platformclientv2/mediapolicies.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Mediapolicies -type Mediapolicies struct { - // CallPolicy - Conditions and actions for calls - CallPolicy *Callmediapolicy `json:"callPolicy,omitempty"` - - - // ChatPolicy - Conditions and actions for chats - ChatPolicy *Chatmediapolicy `json:"chatPolicy,omitempty"` - - - // EmailPolicy - Conditions and actions for emails - EmailPolicy *Emailmediapolicy `json:"emailPolicy,omitempty"` - - - // MessagePolicy - Conditions and actions for messages - MessagePolicy *Messagemediapolicy `json:"messagePolicy,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Mediapolicies) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/mediaresult.go b/build/platformclientv2/mediaresult.go deleted file mode 100644 index b483b87a6..000000000 --- a/build/platformclientv2/mediaresult.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Mediaresult -type Mediaresult struct { - // MediaUri - MediaUri *string `json:"mediaUri,omitempty"` - - - // WaveformData - WaveformData *[]float32 `json:"waveformData,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Mediaresult) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/mediasetting.go b/build/platformclientv2/mediasetting.go deleted file mode 100644 index ce3636173..000000000 --- a/build/platformclientv2/mediasetting.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Mediasetting -type Mediasetting struct { - // AlertingTimeoutSeconds - AlertingTimeoutSeconds *int `json:"alertingTimeoutSeconds,omitempty"` - - - // ServiceLevel - ServiceLevel *Servicelevel `json:"serviceLevel,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Mediasetting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/mediasummary.go b/build/platformclientv2/mediasummary.go deleted file mode 100644 index fbc30e1ad..000000000 --- a/build/platformclientv2/mediasummary.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Mediasummary -type Mediasummary struct { - // ContactCenter - ContactCenter *Mediasummarydetail `json:"contactCenter,omitempty"` - - - // Enterprise - Enterprise *Mediasummarydetail `json:"enterprise,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Mediasummary) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/mediasummarydetail.go b/build/platformclientv2/mediasummarydetail.go deleted file mode 100644 index bd9337b09..000000000 --- a/build/platformclientv2/mediasummarydetail.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Mediasummarydetail -type Mediasummarydetail struct { - // Active - Active *int `json:"active,omitempty"` - - - // Acw - Acw *int `json:"acw,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Mediasummarydetail) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/mediatranscription.go b/build/platformclientv2/mediatranscription.go deleted file mode 100644 index e0814c619..000000000 --- a/build/platformclientv2/mediatranscription.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Mediatranscription -type Mediatranscription struct { - // DisplayName - DisplayName *string `json:"displayName,omitempty"` - - - // TranscriptionProvider - TranscriptionProvider *string `json:"transcriptionProvider,omitempty"` - - - // IntegrationId - IntegrationId *string `json:"integrationId,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Mediatranscription) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/mediatype.go b/build/platformclientv2/mediatype.go deleted file mode 100644 index 4fc5b7773..000000000 --- a/build/platformclientv2/mediatype.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Mediatype - Media type definition -type Mediatype struct { - // VarType - The media type string as defined by RFC 2046. You can define specific types such as 'image/jpeg', 'video/mpeg', or specify wild cards for a range of types, 'image/*', or all types '*/*'. See https://www.iana.org/assignments/media-types/media-types.xhtml for a list of registered media types. - VarType *string `json:"type,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Mediatype) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/mediatypeaccess.go b/build/platformclientv2/mediatypeaccess.go deleted file mode 100644 index d1385e147..000000000 --- a/build/platformclientv2/mediatypeaccess.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Mediatypeaccess - Media type access definitions -type Mediatypeaccess struct { - // Inbound - List of media types allowed for inbound messages from customers. If inbound messages from a customer contain media that is not in this list, the media will be dropped from the outbound message. - Inbound *[]Mediatype `json:"inbound,omitempty"` - - - // Outbound - List of media types allowed for outbound messages to customers. If an outbound message is sent that contains media that is not in this list, the message will not be sent. - Outbound *[]Mediatype `json:"outbound,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Mediatypeaccess) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/mediatypes.go b/build/platformclientv2/mediatypes.go deleted file mode 100644 index d1ce60867..000000000 --- a/build/platformclientv2/mediatypes.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Mediatypes - Media types -type Mediatypes struct { - // Allow - Specify allowed media types for inbound and outbound messages. If this field is empty, all inbound and outbound media will be blocked. - Allow *Mediatypeaccess `json:"allow,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Mediatypes) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/mediautilization.go b/build/platformclientv2/mediautilization.go deleted file mode 100644 index 4de7f6559..000000000 --- a/build/platformclientv2/mediautilization.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Mediautilization -type Mediautilization struct { - // MaximumCapacity - Defines the maximum number of conversations of this type that an agent can handle at one time. - MaximumCapacity *int `json:"maximumCapacity,omitempty"` - - - // InterruptableMediaTypes - Defines the list of other media types that can interrupt a conversation of this media type. Values include call, chat, email, callback, and message. - InterruptableMediaTypes *[]string `json:"interruptableMediaTypes,omitempty"` - - - // IncludeNonAcd - If true, then track non-ACD conversations against utilization - IncludeNonAcd *bool `json:"includeNonAcd,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Mediautilization) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/memberentity.go b/build/platformclientv2/memberentity.go deleted file mode 100644 index 051d3cae7..000000000 --- a/build/platformclientv2/memberentity.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Memberentity -type Memberentity struct { - // Id - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Memberentity) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/message.go b/build/platformclientv2/message.go deleted file mode 100644 index a9086be1b..000000000 --- a/build/platformclientv2/message.go +++ /dev/null @@ -1,114 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Message -type Message struct { - // State - The connection state of this communication. - State *string `json:"state,omitempty"` - - - // Id - A globally unique identifier for this communication. - Id *string `json:"id,omitempty"` - - - // Held - True if this call is held and the person on this side hears silence. - Held *bool `json:"held,omitempty"` - - - // Segments - The time line of the participant's message, divided into activity segments. - Segments *[]Segment `json:"segments,omitempty"` - - - // Direction - The direction of the message. - Direction *string `json:"direction,omitempty"` - - - // RecordingId - A globally unique identifier for the recording associated with this message. - RecordingId *string `json:"recordingId,omitempty"` - - - // ErrorInfo - ErrorInfo *Errorbody `json:"errorInfo,omitempty"` - - - // DisconnectType - System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects. - DisconnectType *string `json:"disconnectType,omitempty"` - - - // StartHoldTime - The timestamp the message was placed on hold in the cloud clock if the message is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartHoldTime *time.Time `json:"startHoldTime,omitempty"` - - - // StartAlertingTime - The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartAlertingTime *time.Time `json:"startAlertingTime,omitempty"` - - - // ConnectedTime - The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // DisconnectedTime - The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"` - - - // Provider - The source provider for the message. - Provider *string `json:"provider,omitempty"` - - - // VarType - Indicates the type of message platform from which the message originated. - VarType *string `json:"type,omitempty"` - - - // RecipientCountry - Indicates the country where the recipient is associated in ISO 3166-1 alpha-2 format. - RecipientCountry *string `json:"recipientCountry,omitempty"` - - - // RecipientType - The type of the recipient. Eg: Provisioned phoneNumber is the recipient for sms message type. - RecipientType *string `json:"recipientType,omitempty"` - - - // ScriptId - The UUID of the script to use. - ScriptId *string `json:"scriptId,omitempty"` - - - // PeerId - The id of the peer communication corresponding to a matching leg for this communication. - PeerId *string `json:"peerId,omitempty"` - - - // ToAddress - Address and name data for a call endpoint. - ToAddress *Address `json:"toAddress,omitempty"` - - - // FromAddress - Address and name data for a call endpoint. - FromAddress *Address `json:"fromAddress,omitempty"` - - - // Messages - The messages sent on this communication channel. - Messages *[]Messagedetails `json:"messages,omitempty"` - - - // JourneyContext - A subset of the Journey System's data relevant to a part of a conversation (for external linkage and internal usage/context). - JourneyContext *Journeycontext `json:"journeyContext,omitempty"` - - - // Wrapup - Call wrap up or disposition data. - Wrapup *Wrapup `json:"wrapup,omitempty"` - - - // AfterCallWork - After-call work for the communication. - AfterCallWork *Aftercallwork `json:"afterCallWork,omitempty"` - - - // AfterCallWorkRequired - Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested. - AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Message) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/messagecontent.go b/build/platformclientv2/messagecontent.go deleted file mode 100644 index 7c5cf1247..000000000 --- a/build/platformclientv2/messagecontent.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Messagecontent - Message content element -type Messagecontent struct { - // ContentType - Type of this content element. If contentType = \"Attachment\" only one item is allowed. - ContentType *string `json:"contentType,omitempty"` - - - // Location - Location object - Location *Contentlocation `json:"location,omitempty"` - - - // Attachment - Attachment object - Attachment *Contentattachment `json:"attachment,omitempty"` - - - // QuickReply - Quick reply object - QuickReply *Contentquickreply `json:"quickReply,omitempty"` - - - // Generic - Generic content object - Generic *Contentgeneric `json:"generic,omitempty"` - - - // List - List content object - List *Contentlist `json:"list,omitempty"` - - - // Template - Template notification object - Template *Contentnotificationtemplate `json:"template,omitempty"` - - - // Reactions - A list of reactions - Reactions *[]Contentreaction `json:"reactions,omitempty"` - - - // Mention - This is used to identify who the message is sent to, as well as who it was sent from. This information is channel specific - depends on capabilities to describe party by the platform - Mention *Messagingrecipient `json:"mention,omitempty"` - - - // Postback - The postback object result of a user clicking in a button - Postback *Contentpostback `json:"postback,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Messagecontent) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/messageconversation.go b/build/platformclientv2/messageconversation.go deleted file mode 100644 index 12ebf1a81..000000000 --- a/build/platformclientv2/messageconversation.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Messageconversation -type Messageconversation struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Participants - The list of participants involved in the conversation. - Participants *[]Messagemediaparticipant `json:"participants,omitempty"` - - - // OtherMediaUris - The list of other media channels involved in the conversation. - OtherMediaUris *[]string `json:"otherMediaUris,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Messageconversation) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/messageconversationentitylisting.go b/build/platformclientv2/messageconversationentitylisting.go deleted file mode 100644 index f4f047f82..000000000 --- a/build/platformclientv2/messageconversationentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Messageconversationentitylisting -type Messageconversationentitylisting struct { - // Entities - Entities *[]Emailconversation `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Messageconversationentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/messagedata.go b/build/platformclientv2/messagedata.go deleted file mode 100644 index d82d0ec5f..000000000 --- a/build/platformclientv2/messagedata.go +++ /dev/null @@ -1,70 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Messagedata -type Messagedata struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // ProviderMessageId - The unique identifier of the message from provider - ProviderMessageId *string `json:"providerMessageId,omitempty"` - - - // Timestamp - The time when the message was received or sent. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - Timestamp *time.Time `json:"timestamp,omitempty"` - - - // FromAddress - The sender of the text message. - FromAddress *string `json:"fromAddress,omitempty"` - - - // ToAddress - The recipient of the text message. - ToAddress *string `json:"toAddress,omitempty"` - - - // Direction - The direction of the message. - Direction *string `json:"direction,omitempty"` - - - // MessengerType - Type of text messenger. - MessengerType *string `json:"messengerType,omitempty"` - - - // TextBody - The body of the text message. - TextBody *string `json:"textBody,omitempty"` - - - // Status - The status of the message. - Status *string `json:"status,omitempty"` - - - // Media - The media details associated to a message. - Media *[]Messagemedia `json:"media,omitempty"` - - - // Stickers - The sticker details associated to a message. - Stickers *[]Messagesticker `json:"stickers,omitempty"` - - - // CreatedBy - User who sent this message. - CreatedBy *User `json:"createdBy,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Messagedata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/messagedetails.go b/build/platformclientv2/messagedetails.go deleted file mode 100644 index 15b5e5e84..000000000 --- a/build/platformclientv2/messagedetails.go +++ /dev/null @@ -1,42 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Messagedetails -type Messagedetails struct { - // MessageId - UUID identifying the message media. - MessageId *string `json:"messageId,omitempty"` - - - // MessageURI - A URI for this message entity. - MessageURI *string `json:"messageURI,omitempty"` - - - // MessageStatus - Indicates the delivery status of the message. - MessageStatus *string `json:"messageStatus,omitempty"` - - - // MessageSegmentCount - The message segment count, greater than 1 if the message content was split into multiple parts for this message type, e.g. SMS character limits. - MessageSegmentCount *int `json:"messageSegmentCount,omitempty"` - - - // MessageTime - The time when the message was sent or received. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - MessageTime *time.Time `json:"messageTime,omitempty"` - - - // Media - The media (images, files, etc) associated with this message, if any - Media *[]Messagemedia `json:"media,omitempty"` - - - // Stickers - One or more stickers associated with this message, if any - Stickers *[]Messagesticker `json:"stickers,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Messagedetails) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/messageevaluation.go b/build/platformclientv2/messageevaluation.go deleted file mode 100644 index db8e05e2e..000000000 --- a/build/platformclientv2/messageevaluation.go +++ /dev/null @@ -1,30 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Messageevaluation -type Messageevaluation struct { - // ContactColumn - ContactColumn *string `json:"contactColumn,omitempty"` - - - // ContactAddress - ContactAddress *string `json:"contactAddress,omitempty"` - - - // WrapupCodeId - WrapupCodeId *string `json:"wrapupCodeId,omitempty"` - - - // Timestamp - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - Timestamp *time.Time `json:"timestamp,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Messageevaluation) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/messageinfo.go b/build/platformclientv2/messageinfo.go deleted file mode 100644 index 6413b7d9e..000000000 --- a/build/platformclientv2/messageinfo.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Messageinfo -type Messageinfo struct { - // LocalizableMessageCode - Key that can be used to localize the message. - LocalizableMessageCode *string `json:"localizableMessageCode,omitempty"` - - - // Message - Description of the message. - Message *string `json:"message,omitempty"` - - - // MessageWithParams - Message with template fields for variable replacement. - MessageWithParams *string `json:"messageWithParams,omitempty"` - - - // MessageParams - Map with fields for variable replacement. - MessageParams *map[string]string `json:"messageParams,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Messageinfo) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/messagemedia.go b/build/platformclientv2/messagemedia.go deleted file mode 100644 index 5cd6a7572..000000000 --- a/build/platformclientv2/messagemedia.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Messagemedia -type Messagemedia struct { - // Url - The location of the media, useful for retrieving it - Url *string `json:"url,omitempty"` - - - // MediaType - The optional internet media type of the the media object. If null then the media type should be dictated by the url - MediaType *string `json:"mediaType,omitempty"` - - - // ContentLengthBytes - The optional content length of the the media object, in bytes. - ContentLengthBytes *int `json:"contentLengthBytes,omitempty"` - - - // Name - The optional name of the the media object. - Name *string `json:"name,omitempty"` - - - // Id - The optional id of the the media object. - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Messagemedia) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/messagemediaattachment.go b/build/platformclientv2/messagemediaattachment.go deleted file mode 100644 index 7968c53d7..000000000 --- a/build/platformclientv2/messagemediaattachment.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Messagemediaattachment -type Messagemediaattachment struct { - // Url - The location of the media, useful for retrieving it - Url *string `json:"url,omitempty"` - - - // MediaType - The optional internet media type of the the media object.If null then the media type should be dictated by the url. - MediaType *string `json:"mediaType,omitempty"` - - - // ContentLength - The optional content length of the the media object, in bytes. - ContentLength *int `json:"contentLength,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Id - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Messagemediaattachment) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/messagemediadata.go b/build/platformclientv2/messagemediadata.go deleted file mode 100644 index 7e7f1d5f3..000000000 --- a/build/platformclientv2/messagemediadata.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Messagemediadata -type Messagemediadata struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Url - The location of the media, useful for retrieving it - Url *string `json:"url,omitempty"` - - - // MediaType - The detected internet media type of the the media object. If null then the media type should be dictated by the url. - MediaType *string `json:"mediaType,omitempty"` - - - // ContentLengthBytes - The optional content length of the the media object, in bytes. - ContentLengthBytes *int `json:"contentLengthBytes,omitempty"` - - - // UploadUrl - The URL returned to upload an attachment - UploadUrl *string `json:"uploadUrl,omitempty"` - - - // Status - The status of the media, indicates if the media is in the process of uploading. If the upload fails, the media becomes invalid - Status *string `json:"status,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Messagemediadata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/messagemediaparticipant.go b/build/platformclientv2/messagemediaparticipant.go deleted file mode 100644 index cd20c32c3..000000000 --- a/build/platformclientv2/messagemediaparticipant.go +++ /dev/null @@ -1,170 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Messagemediaparticipant -type Messagemediaparticipant struct { - // Id - The unique participant ID. - Id *string `json:"id,omitempty"` - - - // Name - The display friendly name of the participant. - Name *string `json:"name,omitempty"` - - - // Address - The participant address. - Address *string `json:"address,omitempty"` - - - // StartTime - The time when this participant first joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartTime *time.Time `json:"startTime,omitempty"` - - - // ConnectedTime - The time when this participant went connected for this media (eg: video connected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // EndTime - The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - EndTime *time.Time `json:"endTime,omitempty"` - - - // StartHoldTime - The time when this participant's hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartHoldTime *time.Time `json:"startHoldTime,omitempty"` - - - // Purpose - The participant's purpose. Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr - Purpose *string `json:"purpose,omitempty"` - - - // State - The participant's state. Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting - State *string `json:"state,omitempty"` - - - // Direction - The participant's direction. Values can be: 'inbound' or 'outbound' - Direction *string `json:"direction,omitempty"` - - - // DisconnectType - The reason the participant was disconnected from the conversation. - DisconnectType *string `json:"disconnectType,omitempty"` - - - // Held - Value is true when the participant is on hold. - Held *bool `json:"held,omitempty"` - - - // WrapupRequired - Value is true when the participant requires wrap-up. - WrapupRequired *bool `json:"wrapupRequired,omitempty"` - - - // WrapupPrompt - The wrap-up prompt indicating the type of wrap-up to be performed. - WrapupPrompt *string `json:"wrapupPrompt,omitempty"` - - - // User - The PureCloud user for this participant. - User *Domainentityref `json:"user,omitempty"` - - - // Queue - The PureCloud queue for this participant. - Queue *Domainentityref `json:"queue,omitempty"` - - - // Team - The PureCloud team for this participant. - Team *Domainentityref `json:"team,omitempty"` - - - // Attributes - A list of ad-hoc attributes for the participant. - Attributes *map[string]string `json:"attributes,omitempty"` - - - // ErrorInfo - If the conversation ends in error, contains additional error details. - ErrorInfo *Errorinfo `json:"errorInfo,omitempty"` - - - // Script - The Engage script that should be used by this participant. - Script *Domainentityref `json:"script,omitempty"` - - - // WrapupTimeoutMs - The amount of time the participant has to complete wrap-up. - WrapupTimeoutMs *int `json:"wrapupTimeoutMs,omitempty"` - - - // WrapupSkipped - Value is true when the participant has skipped wrap-up. - WrapupSkipped *bool `json:"wrapupSkipped,omitempty"` - - - // AlertingTimeoutMs - Specifies how long the agent has to answer an interaction before being marked as not responding. - AlertingTimeoutMs *int `json:"alertingTimeoutMs,omitempty"` - - - // Provider - The source provider for the communication. - Provider *string `json:"provider,omitempty"` - - - // ExternalContact - If this participant represents an external contact, then this will be the reference for the external contact. - ExternalContact *Domainentityref `json:"externalContact,omitempty"` - - - // ExternalOrganization - If this participant represents an external org, then this will be the reference for the external org. - ExternalOrganization *Domainentityref `json:"externalOrganization,omitempty"` - - - // Wrapup - Wrapup for this participant, if it has been applied. - Wrapup *Wrapup `json:"wrapup,omitempty"` - - - // Peer - The peer communication corresponding to a matching leg for this communication. - Peer *string `json:"peer,omitempty"` - - - // FlaggedReason - The reason specifying why participant flagged the conversation. - FlaggedReason *string `json:"flaggedReason,omitempty"` - - - // JourneyContext - Journey System data/context that is applicable to this communication. When used for historical purposes, the context should be immutable. When null, there is no applicable Journey System context. - JourneyContext *Journeycontext `json:"journeyContext,omitempty"` - - - // ConversationRoutingData - Information on how a communication should be routed to an agent. - ConversationRoutingData *Conversationroutingdata `json:"conversationRoutingData,omitempty"` - - - // StartAcwTime - The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartAcwTime *time.Time `json:"startAcwTime,omitempty"` - - - // EndAcwTime - The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - EndAcwTime *time.Time `json:"endAcwTime,omitempty"` - - - // ToAddress - Address for the participant on receiving side of the message conversation. If the address is a phone number, E.164 format is recommended. - ToAddress *Address `json:"toAddress,omitempty"` - - - // FromAddress - Address for the participant on the sending side of the message conversation. If the address is a phone number, E.164 format is recommended. - FromAddress *Address `json:"fromAddress,omitempty"` - - - // Messages - Message instance details on the communication. - Messages *[]Messagedetails `json:"messages,omitempty"` - - - // VarType - Indicates the type of message platform from which the message originated. - VarType *string `json:"type,omitempty"` - - - // RecipientCountry - Indicates the country where the recipient is associated in ISO 3166-1 alpha-2 format. - RecipientCountry *string `json:"recipientCountry,omitempty"` - - - // RecipientType - The type of the recipient. Eg: Provisioned phoneNumber is the recipient for sms message type. - RecipientType *string `json:"recipientType,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Messagemediaparticipant) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/messagemediapolicy.go b/build/platformclientv2/messagemediapolicy.go deleted file mode 100644 index 936467fab..000000000 --- a/build/platformclientv2/messagemediapolicy.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Messagemediapolicy -type Messagemediapolicy struct { - // Actions - Actions applied when specified conditions are met - Actions *Policyactions `json:"actions,omitempty"` - - - // Conditions - Conditions for when actions should be applied - Conditions *Messagemediapolicyconditions `json:"conditions,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Messagemediapolicy) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/messagemediapolicyconditions.go b/build/platformclientv2/messagemediapolicyconditions.go deleted file mode 100644 index 1e8b21c09..000000000 --- a/build/platformclientv2/messagemediapolicyconditions.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Messagemediapolicyconditions -type Messagemediapolicyconditions struct { - // ForUsers - ForUsers *[]User `json:"forUsers,omitempty"` - - - // DateRanges - DateRanges *[]string `json:"dateRanges,omitempty"` - - - // ForQueues - ForQueues *[]Queue `json:"forQueues,omitempty"` - - - // WrapupCodes - WrapupCodes *[]Wrapupcode `json:"wrapupCodes,omitempty"` - - - // Languages - Languages *[]Language `json:"languages,omitempty"` - - - // TimeAllowed - TimeAllowed *Timeallowed `json:"timeAllowed,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Messagemediapolicyconditions) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/messagesticker.go b/build/platformclientv2/messagesticker.go deleted file mode 100644 index 42e49111a..000000000 --- a/build/platformclientv2/messagesticker.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Messagesticker -type Messagesticker struct { - // Url - The location of the sticker, useful for retrieving it - Url *string `json:"url,omitempty"` - - - // Id - The unique id of the the sticker object. - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Messagesticker) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/messagestickerattachment.go b/build/platformclientv2/messagestickerattachment.go deleted file mode 100644 index 2e8808998..000000000 --- a/build/platformclientv2/messagestickerattachment.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Messagestickerattachment -type Messagestickerattachment struct { - // Url - The location of the media, useful for retrieving it - Url *string `json:"url,omitempty"` - - - // Id - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Messagestickerattachment) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/messagingcampaign.go b/build/platformclientv2/messagingcampaign.go deleted file mode 100644 index 538953adf..000000000 --- a/build/platformclientv2/messagingcampaign.go +++ /dev/null @@ -1,78 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Messagingcampaign -type Messagingcampaign struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // DateCreated - Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // Version - Required for updates, must match the version number of the most recent update - Version *int `json:"version,omitempty"` - - - // Division - The division this entity belongs to. - Division *Domainentityref `json:"division,omitempty"` - - - // CampaignStatus - The current status of the messaging campaign. A messaging campaign may be turned 'on' or 'off'. - CampaignStatus *string `json:"campaignStatus,omitempty"` - - - // CallableTimeSet - The callable time set for this messaging campaign. - CallableTimeSet *Domainentityref `json:"callableTimeSet,omitempty"` - - - // ContactList - The contact list that this messaging campaign will send messages for. - ContactList *Domainentityref `json:"contactList,omitempty"` - - - // DncLists - The dnc lists to check before sending a message for this messaging campaign. - DncLists *[]Domainentityref `json:"dncLists,omitempty"` - - - // AlwaysRunning - Whether this messaging campaign is always running - AlwaysRunning *bool `json:"alwaysRunning,omitempty"` - - - // ContactSorts - The order in which to sort contacts for dialing, based on up to four columns. - ContactSorts *[]Contactsort `json:"contactSorts,omitempty"` - - - // MessagesPerMinute - How many messages this messaging campaign will send per minute. - MessagesPerMinute *int `json:"messagesPerMinute,omitempty"` - - - // Errors - A list of current error conditions associated with this messaging campaign. - Errors *[]Resterrordetail `json:"errors,omitempty"` - - - // SmsConfig - Configuration for this messaging campaign to send SMS messages. - SmsConfig *Smsconfig `json:"smsConfig,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Messagingcampaign) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/messagingcampaigndivisionview.go b/build/platformclientv2/messagingcampaigndivisionview.go deleted file mode 100644 index 83fc74723..000000000 --- a/build/platformclientv2/messagingcampaigndivisionview.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Messagingcampaigndivisionview -type Messagingcampaigndivisionview struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Division - The division to which this entity belongs. - Division *Division `json:"division,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Messagingcampaigndivisionview) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/messagingcampaigndivisionviewentitylisting.go b/build/platformclientv2/messagingcampaigndivisionviewentitylisting.go deleted file mode 100644 index 24d872b16..000000000 --- a/build/platformclientv2/messagingcampaigndivisionviewentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Messagingcampaigndivisionviewentitylisting -type Messagingcampaigndivisionviewentitylisting struct { - // Entities - Entities *[]Messagingcampaigndivisionview `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Messagingcampaigndivisionviewentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/messagingcampaignentitylisting.go b/build/platformclientv2/messagingcampaignentitylisting.go deleted file mode 100644 index e715ff29a..000000000 --- a/build/platformclientv2/messagingcampaignentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Messagingcampaignentitylisting -type Messagingcampaignentitylisting struct { - // Entities - Entities *[]Messagingcampaign `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Messagingcampaignentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/messagingintegration.go b/build/platformclientv2/messagingintegration.go deleted file mode 100644 index cb4e3ce2b..000000000 --- a/build/platformclientv2/messagingintegration.go +++ /dev/null @@ -1,58 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Messagingintegration -type Messagingintegration struct { - // Id - A unique Integration Id - Id *string `json:"id,omitempty"` - - - // Name - The name of the Integration - Name *string `json:"name,omitempty"` - - - // Status - The status of the Integration - Status *string `json:"status,omitempty"` - - - // MessengerType - The type of Messaging Integration - MessengerType *string `json:"messengerType,omitempty"` - - - // Recipient - The recipient associated to the Integration. This recipient is used to associate a flow to an integration - Recipient *Domainentityref `json:"recipient,omitempty"` - - - // DateCreated - Date this Integration was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - Date this Integration was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // CreatedBy - User reference that created this Integration - CreatedBy *Domainentityref `json:"createdBy,omitempty"` - - - // ModifiedBy - User reference that last modified this Integration - ModifiedBy *Domainentityref `json:"modifiedBy,omitempty"` - - - // Version - Version number required for updates. - Version *int `json:"version,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Messagingintegration) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/messagingintegrationentitylisting.go b/build/platformclientv2/messagingintegrationentitylisting.go deleted file mode 100644 index e6dd363a5..000000000 --- a/build/platformclientv2/messagingintegrationentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Messagingintegrationentitylisting -type Messagingintegrationentitylisting struct { - // Entities - Entities *[]Messagingintegration `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Messagingintegrationentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/messagingrecipient.go b/build/platformclientv2/messagingrecipient.go deleted file mode 100644 index 16eefcf5b..000000000 --- a/build/platformclientv2/messagingrecipient.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Messagingrecipient - This is used to identify who the message is sent to, as well as who it was sent from. This information is channel specific - depends on capabilities to describe party by the platform -type Messagingrecipient struct { - // Nickname - Nickname/user name - Nickname *string `json:"nickname,omitempty"` - - - // Id - The recipient identifier specific for particular channel/integration. This is required when sending a message. - Id *string `json:"id,omitempty"` - - - // Image - Avatar image - Image *string `json:"image,omitempty"` - - - // FirstName - Sender's first name - FirstName *string `json:"firstName,omitempty"` - - - // LastName - Sender's last name - LastName *string `json:"lastName,omitempty"` - - - // Email - Sender's email address - Email *string `json:"email,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Messagingrecipient) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/messagingsticker.go b/build/platformclientv2/messagingsticker.go deleted file mode 100644 index da9515f86..000000000 --- a/build/platformclientv2/messagingsticker.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Messagingsticker -type Messagingsticker struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // ProviderStickerId - The sticker Id of the sticker, assigned by the sticker provider. - ProviderStickerId *int `json:"providerStickerId,omitempty"` - - - // ProviderPackageId - The package Id of the sticker, assigned by the sticker provider. - ProviderPackageId *int `json:"providerPackageId,omitempty"` - - - // PackageName - The package name of the sticker, assigned by the sticker provider. - PackageName *string `json:"packageName,omitempty"` - - - // MessengerType - The type of the messenger provider. - MessengerType *string `json:"messengerType,omitempty"` - - - // StickerType - The type of the sticker. - StickerType *string `json:"stickerType,omitempty"` - - - // ProviderVersion - The version of the sticker, assigned by the provider. - ProviderVersion *int `json:"providerVersion,omitempty"` - - - // UriLocation - UriLocation *string `json:"uriLocation,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Messagingsticker) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/messagingstickerentitylisting.go b/build/platformclientv2/messagingstickerentitylisting.go deleted file mode 100644 index fe5fd9ce5..000000000 --- a/build/platformclientv2/messagingstickerentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Messagingstickerentitylisting -type Messagingstickerentitylisting struct { - // Entities - Entities *[]Messagingsticker `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Messagingstickerentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/messagingtemplate.go b/build/platformclientv2/messagingtemplate.go deleted file mode 100644 index f3c6ac724..000000000 --- a/build/platformclientv2/messagingtemplate.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Messagingtemplate - The messaging template identifies a structured message templates supported by a messaging channel. -type Messagingtemplate struct { - // WhatsApp - Defines a messaging template for a WhatsApp messaging channel - WhatsApp *Whatsappdefinition `json:"whatsApp,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Messagingtemplate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/messagingtemplaterequest.go b/build/platformclientv2/messagingtemplaterequest.go deleted file mode 100644 index 208050e0b..000000000 --- a/build/platformclientv2/messagingtemplaterequest.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Messagingtemplaterequest -type Messagingtemplaterequest struct { - // ResponseId - A Response Management response identifier for a messaging template defined response - ResponseId *string `json:"responseId,omitempty"` - - - // Parameters - A list of Response Management response substitutions for the response's messaging template - Parameters *[]Templateparameter `json:"parameters,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Messagingtemplaterequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/metabase.go b/build/platformclientv2/metabase.go deleted file mode 100644 index a1d601222..000000000 --- a/build/platformclientv2/metabase.go +++ /dev/null @@ -1,66 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Metabase -type Metabase struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the entity. - Name *string `json:"name,omitempty"` - - - // Description - Description *string `json:"description,omitempty"` - - - // Version - The current version of the resource. - Version *int `json:"version,omitempty"` - - - // DateCreated - The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // ModifiedBy - The ID of the user that last modified the resource. - ModifiedBy *string `json:"modifiedBy,omitempty"` - - - // CreatedBy - The ID of the user that created the resource. - CreatedBy *string `json:"createdBy,omitempty"` - - - // State - Indicates if the resource is active, inactive, or deleted. - State *string `json:"state,omitempty"` - - - // ModifiedByApp - The application that last modified the resource. - ModifiedByApp *string `json:"modifiedByApp,omitempty"` - - - // CreatedByApp - The application that created the resource. - CreatedByApp *string `json:"createdByApp,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Metabase) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/metadata.go b/build/platformclientv2/metadata.go deleted file mode 100644 index 4ae07708e..000000000 --- a/build/platformclientv2/metadata.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Metadata -type Metadata struct { - // PairingToken - PairingToken *string `json:"pairing-token,omitempty"` - - - // PairingTrust - PairingTrust *[]string `json:"pairing-trust,omitempty"` - - - // PairingUrl - PairingUrl *string `json:"pairing-url,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Metadata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/meteredassignmentbyagent.go b/build/platformclientv2/meteredassignmentbyagent.go deleted file mode 100644 index 3d926845c..000000000 --- a/build/platformclientv2/meteredassignmentbyagent.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Meteredassignmentbyagent -type Meteredassignmentbyagent struct { - // EvaluationContextId - EvaluationContextId *string `json:"evaluationContextId,omitempty"` - - - // Evaluators - Evaluators *[]User `json:"evaluators,omitempty"` - - - // MaxNumberEvaluations - MaxNumberEvaluations *int `json:"maxNumberEvaluations,omitempty"` - - - // EvaluationForm - EvaluationForm *Evaluationform `json:"evaluationForm,omitempty"` - - - // TimeInterval - TimeInterval *Timeinterval `json:"timeInterval,omitempty"` - - - // TimeZone - TimeZone *string `json:"timeZone,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Meteredassignmentbyagent) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/meteredevaluationassignment.go b/build/platformclientv2/meteredevaluationassignment.go deleted file mode 100644 index 8757c3d45..000000000 --- a/build/platformclientv2/meteredevaluationassignment.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Meteredevaluationassignment -type Meteredevaluationassignment struct { - // EvaluationContextId - EvaluationContextId *string `json:"evaluationContextId,omitempty"` - - - // Evaluators - Evaluators *[]User `json:"evaluators,omitempty"` - - - // MaxNumberEvaluations - MaxNumberEvaluations *int `json:"maxNumberEvaluations,omitempty"` - - - // EvaluationForm - EvaluationForm *Evaluationform `json:"evaluationForm,omitempty"` - - - // AssignToActiveUser - AssignToActiveUser *bool `json:"assignToActiveUser,omitempty"` - - - // TimeInterval - TimeInterval *Timeinterval `json:"timeInterval,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Meteredevaluationassignment) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/minlength.go b/build/platformclientv2/minlength.go deleted file mode 100644 index 5ae5161e5..000000000 --- a/build/platformclientv2/minlength.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Minlength -type Minlength struct { - // Min - A non-negative integer for a text-based schema field denoting the minimum smallest length a string field can contain for a schema instance. - Min *int `json:"min,omitempty"` - - - // Max - A non-negative integer for a text-based schema field denoting the maximum smallest length string the field can contain for a schema instance. - Max *int `json:"max,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Minlength) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/mobiledevicesapi.go b/build/platformclientv2/mobiledevicesapi.go deleted file mode 100644 index a05049035..000000000 --- a/build/platformclientv2/mobiledevicesapi.go +++ /dev/null @@ -1,411 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "encoding/json" -) - -// MobileDevicesApi provides functions for API endpoints -type MobileDevicesApi struct { - Configuration *Configuration -} - -// NewMobileDevicesApi creates an API instance using the default configuration -func NewMobileDevicesApi() *MobileDevicesApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating MobileDevicesApi with base path: %s", strings.ToLower(config.BasePath))) - return &MobileDevicesApi{ - Configuration: config, - } -} - -// NewMobileDevicesApiWithConfig creates an API instance using the provided configuration -func NewMobileDevicesApiWithConfig(config *Configuration) *MobileDevicesApi { - config.Debugf("Creating MobileDevicesApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &MobileDevicesApi{ - Configuration: config, - } -} - -// DeleteMobiledevice invokes DELETE /api/v2/mobiledevices/{deviceId} -// -// Delete device -// -// -func (a MobileDevicesApi) DeleteMobiledevice(deviceId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/mobiledevices/{deviceId}" - path = strings.Replace(path, "{deviceId}", fmt.Sprintf("%v", deviceId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'deviceId' is set - if &deviceId == nil { - // - return nil, errors.New("Missing required parameter 'deviceId' when calling MobileDevicesApi->DeleteMobiledevice") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// GetMobiledevice invokes GET /api/v2/mobiledevices/{deviceId} -// -// Get device -// -// -func (a MobileDevicesApi) GetMobiledevice(deviceId string) (*Userdevice, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/mobiledevices/{deviceId}" - path = strings.Replace(path, "{deviceId}", fmt.Sprintf("%v", deviceId), -1) - defaultReturn := new(Userdevice) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'deviceId' is set - if &deviceId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'deviceId' when calling MobileDevicesApi->GetMobiledevice") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Userdevice - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetMobiledevices invokes GET /api/v2/mobiledevices -// -// Get a list of all devices. -// -// -func (a MobileDevicesApi) GetMobiledevices(pageSize int, pageNumber int, sortOrder string) (*Directoryuserdeviceslisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/mobiledevices" - defaultReturn := new(Directoryuserdeviceslisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Directoryuserdeviceslisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostMobiledevices invokes POST /api/v2/mobiledevices -// -// Create User device -// -// -func (a MobileDevicesApi) PostMobiledevices(body Userdevice) (*Userdevice, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/mobiledevices" - defaultReturn := new(Userdevice) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling MobileDevicesApi->PostMobiledevices") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Userdevice - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutMobiledevice invokes PUT /api/v2/mobiledevices/{deviceId} -// -// Update device -// -// -func (a MobileDevicesApi) PutMobiledevice(deviceId string, body Userdevice) (*Userdevice, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/mobiledevices/{deviceId}" - path = strings.Replace(path, "{deviceId}", fmt.Sprintf("%v", deviceId), -1) - defaultReturn := new(Userdevice) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'deviceId' is set - if &deviceId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'deviceId' when calling MobileDevicesApi->PutMobiledevice") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Userdevice - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/modelingprocessingerror.go b/build/platformclientv2/modelingprocessingerror.go deleted file mode 100644 index 431e5def4..000000000 --- a/build/platformclientv2/modelingprocessingerror.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Modelingprocessingerror -type Modelingprocessingerror struct { - // InternalErrorCode - An internal code representing the type of error. ModelInputMissing for 'Model Builder inputs not found.' ModelInputInvalid for 'Model Builder inputs are invalid. Ensure the input data format is correct.' ModelFailed for 'An error occured while building the model with the given input.' - InternalErrorCode *string `json:"internalErrorCode,omitempty"` - - - // Description - A text description of the error - Description *string `json:"description,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Modelingprocessingerror) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/modelingstatusresponse.go b/build/platformclientv2/modelingstatusresponse.go deleted file mode 100644 index 31af8bd79..000000000 --- a/build/platformclientv2/modelingstatusresponse.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Modelingstatusresponse -type Modelingstatusresponse struct { - // Id - The ID generated for the modeling job. Use to GET result when job is completed. - Id *string `json:"id,omitempty"` - - - // Status - The status of the modeling job. - Status *string `json:"status,omitempty"` - - - // ErrorDetails - If the request could not be properly processed, error details will be given here. - ErrorDetails *[]Modelingprocessingerror `json:"errorDetails,omitempty"` - - - // ModelingResultUri - The uri of the modeling result. It has a value if the status is either 'Success', 'PartialFailure', or 'Failed'. - ModelingResultUri *string `json:"modelingResultUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Modelingstatusresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/movemanagementunitrequest.go b/build/platformclientv2/movemanagementunitrequest.go deleted file mode 100644 index 043033fc0..000000000 --- a/build/platformclientv2/movemanagementunitrequest.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Movemanagementunitrequest -type Movemanagementunitrequest struct { - // BusinessUnitId - The ID of the business unit to which to move the management unit - BusinessUnitId *string `json:"businessUnitId,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Movemanagementunitrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/movemanagementunitresponse.go b/build/platformclientv2/movemanagementunitresponse.go deleted file mode 100644 index 76e33e23c..000000000 --- a/build/platformclientv2/movemanagementunitresponse.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Movemanagementunitresponse -type Movemanagementunitresponse struct { - // BusinessUnit - The new business unit - BusinessUnit *Businessunitreference `json:"businessUnit,omitempty"` - - - // Status - The status of the move. Will always be 'Processing' unless the Management Unit is already in the requested Business Unit in which case it will be 'Complete' - Status *string `json:"status,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Movemanagementunitresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/murescheduleresultwrapper.go b/build/platformclientv2/murescheduleresultwrapper.go deleted file mode 100644 index 34b7596b7..000000000 --- a/build/platformclientv2/murescheduleresultwrapper.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Murescheduleresultwrapper -type Murescheduleresultwrapper struct { - // AgentSchedules - The list of agent schedules - AgentSchedules *[]Buagentschedulerescheduleresponse `json:"agentSchedules,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Murescheduleresultwrapper) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/namedentity.go b/build/platformclientv2/namedentity.go deleted file mode 100644 index a057c19a3..000000000 --- a/build/platformclientv2/namedentity.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Namedentity -type Namedentity struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the object. - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Namedentity) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/namedentityannotation.go b/build/platformclientv2/namedentityannotation.go deleted file mode 100644 index 019e4b1c6..000000000 --- a/build/platformclientv2/namedentityannotation.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Namedentityannotation -type Namedentityannotation struct { - // Name - The name of the annotated named entity. - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Namedentityannotation) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/namedentitytypebinding.go b/build/platformclientv2/namedentitytypebinding.go deleted file mode 100644 index 39197e5b9..000000000 --- a/build/platformclientv2/namedentitytypebinding.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Namedentitytypebinding -type Namedentitytypebinding struct { - // EntityType - The named entity type of the binding. It can be a built-in one such as builtin:number or a custom entity type such as BeverageType. - EntityType *string `json:"entityType,omitempty"` - - - // EntityName - The name that this named entity type is bound to. - EntityName *string `json:"entityName,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Namedentitytypebinding) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/namedentitytypedefinition.go b/build/platformclientv2/namedentitytypedefinition.go deleted file mode 100644 index ae5cce756..000000000 --- a/build/platformclientv2/namedentitytypedefinition.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Namedentitytypedefinition -type Namedentitytypedefinition struct { - // Name - The name of the entity type. - Name *string `json:"name,omitempty"` - - - // Description - Description of the of the named entity type. - Description *string `json:"description,omitempty"` - - - // Mechanism - The mechanism enabling detection of the named entity type. - Mechanism *Namedentitytypemechanism `json:"mechanism,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Namedentitytypedefinition) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/namedentitytypeitem.go b/build/platformclientv2/namedentitytypeitem.go deleted file mode 100644 index 41662cc3a..000000000 --- a/build/platformclientv2/namedentitytypeitem.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Namedentitytypeitem -type Namedentitytypeitem struct { - // Value - A value for an named entity type definition. - Value *string `json:"value,omitempty"` - - - // Synonyms - Synonyms for the given named entity value. - Synonyms *[]string `json:"synonyms,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Namedentitytypeitem) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/namedentitytypemechanism.go b/build/platformclientv2/namedentitytypemechanism.go deleted file mode 100644 index aa68053ee..000000000 --- a/build/platformclientv2/namedentitytypemechanism.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Namedentitytypemechanism -type Namedentitytypemechanism struct { - // Items - The items that define the named entity type. - Items *[]Namedentitytypeitem `json:"items,omitempty"` - - - // Restricted - Whether the named entity type is restricted to the items provided. Default: false - Restricted *bool `json:"restricted,omitempty"` - - - // VarType - The type of the mechanism. - VarType *string `json:"type,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Namedentitytypemechanism) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/nluconfusionmatrixcolumn.go b/build/platformclientv2/nluconfusionmatrixcolumn.go deleted file mode 100644 index 8f8277b58..000000000 --- a/build/platformclientv2/nluconfusionmatrixcolumn.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Nluconfusionmatrixcolumn -type Nluconfusionmatrixcolumn struct { - // Name - The name of the intent for the column. - Name *string `json:"name,omitempty"` - - - // Value - The confusion value between the intents - Value *float32 `json:"value,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Nluconfusionmatrixcolumn) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/nluconfusionmatrixrow.go b/build/platformclientv2/nluconfusionmatrixrow.go deleted file mode 100644 index d86592f9a..000000000 --- a/build/platformclientv2/nluconfusionmatrixrow.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Nluconfusionmatrixrow -type Nluconfusionmatrixrow struct { - // Name - The name of the intent for the row. - Name *string `json:"name,omitempty"` - - - // Columns - The columns of confusion matrix for the intent - Columns *[]Nluconfusionmatrixcolumn `json:"columns,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Nluconfusionmatrixrow) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/nludetectioncontext.go b/build/platformclientv2/nludetectioncontext.go deleted file mode 100644 index 8945c399e..000000000 --- a/build/platformclientv2/nludetectioncontext.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Nludetectioncontext -type Nludetectioncontext struct { - // Intent - Restrict detection to this intent. - Intent *Contextintent `json:"intent,omitempty"` - - - // Entity - Use this entity to restrict detection. - Entity *Contextentity `json:"entity,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Nludetectioncontext) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/nludetectioninput.go b/build/platformclientv2/nludetectioninput.go deleted file mode 100644 index 3dec34ec3..000000000 --- a/build/platformclientv2/nludetectioninput.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Nludetectioninput -type Nludetectioninput struct { - // Text - The text to perform NLU detection on. - Text *string `json:"text,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Nludetectioninput) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/nludetectionoutput.go b/build/platformclientv2/nludetectionoutput.go deleted file mode 100644 index 9878a15d6..000000000 --- a/build/platformclientv2/nludetectionoutput.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Nludetectionoutput -type Nludetectionoutput struct { - // Intents - The detected intents. - Intents *[]Detectedintent `json:"intents,omitempty"` - - - // DialogActs - The detected dialog acts. - DialogActs *[]Detecteddialogact `json:"dialogActs,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Nludetectionoutput) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/nludetectionrequest.go b/build/platformclientv2/nludetectionrequest.go deleted file mode 100644 index 0430ba1f7..000000000 --- a/build/platformclientv2/nludetectionrequest.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Nludetectionrequest -type Nludetectionrequest struct { - // Input - The input subject to NLU detection. - Input *Nludetectioninput `json:"input,omitempty"` - - - // Context - The context for the input to NLU detection. - Context *Nludetectioncontext `json:"context,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Nludetectionrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/nludetectionresponse.go b/build/platformclientv2/nludetectionresponse.go deleted file mode 100644 index a92fe7d45..000000000 --- a/build/platformclientv2/nludetectionresponse.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Nludetectionresponse -type Nludetectionresponse struct { - // Version - The NLU domain version which performed the detection. - Version *Nludomainversion `json:"version,omitempty"` - - - // Output - Output *Nludetectionoutput `json:"output,omitempty"` - - - // Input - Input *Nludetectioninput `json:"input,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Nludetectionresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/nludomain.go b/build/platformclientv2/nludomain.go deleted file mode 100644 index 6b5737cde..000000000 --- a/build/platformclientv2/nludomain.go +++ /dev/null @@ -1,46 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Nludomain -type Nludomain struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the NLU domain. - Name *string `json:"name,omitempty"` - - - // Language - The language culture of the NLU domain, e.g. `en-us`, `de-de`. - Language *string `json:"language,omitempty"` - - - // DraftVersion - The draft version of that NLU domain. - DraftVersion *Nludomainversion `json:"draftVersion,omitempty"` - - - // LastPublishedVersion - The last published version of that NLU domain. - LastPublishedVersion *Nludomainversion `json:"lastPublishedVersion,omitempty"` - - - // DateCreated - The date when the NLU domain was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - The date when the NLU domain was updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Nludomain) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/nludomainlisting.go b/build/platformclientv2/nludomainlisting.go deleted file mode 100644 index 0a9723d39..000000000 --- a/build/platformclientv2/nludomainlisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Nludomainlisting -type Nludomainlisting struct { - // Entities - Entities *[]Nludomain `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Nludomainlisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/nludomainversion.go b/build/platformclientv2/nludomainversion.go deleted file mode 100644 index a209f7e90..000000000 --- a/build/platformclientv2/nludomainversion.go +++ /dev/null @@ -1,70 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Nludomainversion -type Nludomainversion struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Domain - The NLU domain of the version. - Domain **Nludomain `json:"domain,omitempty"` - - - // Description - The description of the NLU domain version. - Description *string `json:"description,omitempty"` - - - // Language - The language that the NLU domain version supports. - Language *string `json:"language,omitempty"` - - - // Published - Whether this NLU domain version has been published. - Published *bool `json:"published,omitempty"` - - - // DateCreated - The date when the NLU domain version was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - The date when the NLU domain version was updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // DateTrained - The date when the NLU domain version was trained. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateTrained *time.Time `json:"dateTrained,omitempty"` - - - // DatePublished - The date when the NLU domain version was published. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DatePublished *time.Time `json:"datePublished,omitempty"` - - - // TrainingStatus - The training status of the NLU domain version. - TrainingStatus *string `json:"trainingStatus,omitempty"` - - - // EvaluationStatus - The evaluation status of the NLU domain version. - EvaluationStatus *string `json:"evaluationStatus,omitempty"` - - - // Intents - The intents defined for this NLU domain version. - Intents *[]Intentdefinition `json:"intents,omitempty"` - - - // EntityTypes - The entity types defined for this NLU domain version. - EntityTypes *[]Namedentitytypedefinition `json:"entityTypes,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Nludomainversion) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/nludomainversionlisting.go b/build/platformclientv2/nludomainversionlisting.go deleted file mode 100644 index 186f974f7..000000000 --- a/build/platformclientv2/nludomainversionlisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Nludomainversionlisting -type Nludomainversionlisting struct { - // Entities - Entities *[]Nludomainversion `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Nludomainversionlisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/nludomainversionqualityreport.go b/build/platformclientv2/nludomainversionqualityreport.go deleted file mode 100644 index 08f4d5108..000000000 --- a/build/platformclientv2/nludomainversionqualityreport.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Nludomainversionqualityreport -type Nludomainversionqualityreport struct { - // Version - The domain and version details of the quality report - Version *Nludomainversion `json:"version,omitempty"` - - - // ConfusionMatrix - The confusion matrix for the Domain Version - ConfusionMatrix *[]Nluconfusionmatrixrow `json:"confusionMatrix,omitempty"` - - - // Summary - The quality report summary for the Domain Version - Summary *Nluqualityreportsummary `json:"summary,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Nludomainversionqualityreport) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/nludomainversiontrainingresponse.go b/build/platformclientv2/nludomainversiontrainingresponse.go deleted file mode 100644 index 438476628..000000000 --- a/build/platformclientv2/nludomainversiontrainingresponse.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Nludomainversiontrainingresponse -type Nludomainversiontrainingresponse struct { - // Message - A message indicating result of the action. - Message *string `json:"message,omitempty"` - - - // Version - Version *Nludomainversion `json:"version,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Nludomainversiontrainingresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/nlufeedbacklisting.go b/build/platformclientv2/nlufeedbacklisting.go deleted file mode 100644 index 4d040ebd2..000000000 --- a/build/platformclientv2/nlufeedbacklisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Nlufeedbacklisting -type Nlufeedbacklisting struct { - // Entities - Entities *[]Nlufeedbackresponse `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Nlufeedbacklisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/nlufeedbackrequest.go b/build/platformclientv2/nlufeedbackrequest.go deleted file mode 100644 index 200f0f5b7..000000000 --- a/build/platformclientv2/nlufeedbackrequest.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Nlufeedbackrequest -type Nlufeedbackrequest struct { - // Text - The feedback text. - Text *string `json:"text,omitempty"` - - - // Intents - Detected intent of the utterance - Intents *[]Intentfeedback `json:"intents,omitempty"` - - - // VersionId - The domain version ID of the feedback. - VersionId *string `json:"versionId,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Nlufeedbackrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/nlufeedbackresponse.go b/build/platformclientv2/nlufeedbackresponse.go deleted file mode 100644 index ae75abe60..000000000 --- a/build/platformclientv2/nlufeedbackresponse.go +++ /dev/null @@ -1,38 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Nlufeedbackresponse -type Nlufeedbackresponse struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Text - The feedback text. - Text *string `json:"text,omitempty"` - - - // Intents - Detected intent of the utterance - Intents *[]Intentfeedback `json:"intents,omitempty"` - - - // Version - The domain version of the feedback. - Version **Nludomainversion `json:"version,omitempty"` - - - // DateCreated - The date when the feedback was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Nlufeedbackresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/nluinfo.go b/build/platformclientv2/nluinfo.go deleted file mode 100644 index deee59ae1..000000000 --- a/build/platformclientv2/nluinfo.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Nluinfo -type Nluinfo struct { - // Intents - Intents *[]Intent `json:"intents,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Nluinfo) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/nluqualityreportsummary.go b/build/platformclientv2/nluqualityreportsummary.go deleted file mode 100644 index 0809b7496..000000000 --- a/build/platformclientv2/nluqualityreportsummary.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Nluqualityreportsummary -type Nluqualityreportsummary struct { - // Metrics - The list of metrics in the summary - Metrics *[]Nluqualityreportsummarymetric `json:"metrics,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Nluqualityreportsummary) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/nluqualityreportsummarymetric.go b/build/platformclientv2/nluqualityreportsummarymetric.go deleted file mode 100644 index fbb947511..000000000 --- a/build/platformclientv2/nluqualityreportsummarymetric.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Nluqualityreportsummarymetric -type Nluqualityreportsummarymetric struct { - // Name - The name of the metric. e.g. recall, f1_score - Name *string `json:"name,omitempty"` - - - // Value - The value of the metric - Value *float32 `json:"value,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Nluqualityreportsummarymetric) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/nluutterance.go b/build/platformclientv2/nluutterance.go deleted file mode 100644 index 4b8a894cc..000000000 --- a/build/platformclientv2/nluutterance.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Nluutterance -type Nluutterance struct { - // Segments - The list of segments that that constitute this utterance for the given intent. - Segments *[]Nluutterancesegment `json:"segments,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Nluutterance) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/nluutterancesegment.go b/build/platformclientv2/nluutterancesegment.go deleted file mode 100644 index a373332f1..000000000 --- a/build/platformclientv2/nluutterancesegment.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Nluutterancesegment -type Nluutterancesegment struct { - // Text - The text of the segment. - Text *string `json:"text,omitempty"` - - - // Entity - The entity annotation of the segment. - Entity *Namedentityannotation `json:"entity,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Nluutterancesegment) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/note.go b/build/platformclientv2/note.go deleted file mode 100644 index 1ec5a09c4..000000000 --- a/build/platformclientv2/note.go +++ /dev/null @@ -1,46 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Note -type Note struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // NoteText - NoteText *string `json:"noteText,omitempty"` - - - // ModifyDate - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ModifyDate *time.Time `json:"modifyDate,omitempty"` - - - // CreateDate - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - CreateDate *time.Time `json:"createDate,omitempty"` - - - // CreatedBy - The author of this note - CreatedBy *User `json:"createdBy,omitempty"` - - - // ExternalDataSources - Links to the sources of data (e.g. one source might be a CRM) that contributed data to this record. Read-only, and only populated when requested via expand param. - ExternalDataSources *[]Externaldatasource `json:"externalDataSources,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Note) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/notelisting.go b/build/platformclientv2/notelisting.go deleted file mode 100644 index bf2b5e7fd..000000000 --- a/build/platformclientv2/notelisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Notelisting -type Notelisting struct { - // Entities - Entities *[]Note `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Notelisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/notificationsapi.go b/build/platformclientv2/notificationsapi.go deleted file mode 100644 index 1b8f83f5a..000000000 --- a/build/platformclientv2/notificationsapi.go +++ /dev/null @@ -1,550 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "encoding/json" -) - -// NotificationsApi provides functions for API endpoints -type NotificationsApi struct { - Configuration *Configuration -} - -// NewNotificationsApi creates an API instance using the default configuration -func NewNotificationsApi() *NotificationsApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating NotificationsApi with base path: %s", strings.ToLower(config.BasePath))) - return &NotificationsApi{ - Configuration: config, - } -} - -// NewNotificationsApiWithConfig creates an API instance using the provided configuration -func NewNotificationsApiWithConfig(config *Configuration) *NotificationsApi { - config.Debugf("Creating NotificationsApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &NotificationsApi{ - Configuration: config, - } -} - -// DeleteNotificationsChannelSubscriptions invokes DELETE /api/v2/notifications/channels/{channelId}/subscriptions -// -// Remove all subscriptions -// -// -func (a NotificationsApi) DeleteNotificationsChannelSubscriptions(channelId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/notifications/channels/{channelId}/subscriptions" - path = strings.Replace(path, "{channelId}", fmt.Sprintf("%v", channelId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'channelId' is set - if &channelId == nil { - // - return nil, errors.New("Missing required parameter 'channelId' when calling NotificationsApi->DeleteNotificationsChannelSubscriptions") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// GetNotificationsAvailabletopics invokes GET /api/v2/notifications/availabletopics -// -// Get available notification topics. -// -// -func (a NotificationsApi) GetNotificationsAvailabletopics(expand []string, includePreview bool) (*Availabletopicentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/notifications/availabletopics" - defaultReturn := new(Availabletopicentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(includePreview).(string); ok { - if str != "" { - queryParams["includePreview"] = a.Configuration.APIClient.ParameterToString(includePreview, collectionFormat) - } - } else { - queryParams["includePreview"] = a.Configuration.APIClient.ParameterToString(includePreview, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Availabletopicentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetNotificationsChannelSubscriptions invokes GET /api/v2/notifications/channels/{channelId}/subscriptions -// -// The list of all subscriptions for this channel -// -// -func (a NotificationsApi) GetNotificationsChannelSubscriptions(channelId string) (*Channeltopicentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/notifications/channels/{channelId}/subscriptions" - path = strings.Replace(path, "{channelId}", fmt.Sprintf("%v", channelId), -1) - defaultReturn := new(Channeltopicentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'channelId' is set - if &channelId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'channelId' when calling NotificationsApi->GetNotificationsChannelSubscriptions") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Channeltopicentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetNotificationsChannels invokes GET /api/v2/notifications/channels -// -// The list of existing channels -// -// -func (a NotificationsApi) GetNotificationsChannels(includechannels string) (*Channelentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/notifications/channels" - defaultReturn := new(Channelentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(includechannels).(string); ok { - if str != "" { - queryParams["includechannels"] = a.Configuration.APIClient.ParameterToString(includechannels, collectionFormat) - } - } else { - queryParams["includechannels"] = a.Configuration.APIClient.ParameterToString(includechannels, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Channelentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostNotificationsChannelSubscriptions invokes POST /api/v2/notifications/channels/{channelId}/subscriptions -// -// Add a list of subscriptions to the existing list of subscriptions -// -// -func (a NotificationsApi) PostNotificationsChannelSubscriptions(channelId string, body []Channeltopic) (*Channeltopicentitylisting, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/notifications/channels/{channelId}/subscriptions" - path = strings.Replace(path, "{channelId}", fmt.Sprintf("%v", channelId), -1) - defaultReturn := new(Channeltopicentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'channelId' is set - if &channelId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'channelId' when calling NotificationsApi->PostNotificationsChannelSubscriptions") - } - // verify the required parameter 'body' is set - if &body == nil { - // true - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling NotificationsApi->PostNotificationsChannelSubscriptions") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Channeltopicentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostNotificationsChannels invokes POST /api/v2/notifications/channels -// -// Create a new channel -// -// There is a limit of 20 channels per user/app combination. Creating a 21st channel will remove the channel with oldest last used date. Channels without an active connection will be removed first. -func (a NotificationsApi) PostNotificationsChannels() (*Channel, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/notifications/channels" - defaultReturn := new(Channel) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Channel - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutNotificationsChannelSubscriptions invokes PUT /api/v2/notifications/channels/{channelId}/subscriptions -// -// Replace the current list of subscriptions with a new list. -// -// -func (a NotificationsApi) PutNotificationsChannelSubscriptions(channelId string, body []Channeltopic) (*Channeltopicentitylisting, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/notifications/channels/{channelId}/subscriptions" - path = strings.Replace(path, "{channelId}", fmt.Sprintf("%v", channelId), -1) - defaultReturn := new(Channeltopicentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'channelId' is set - if &channelId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'channelId' when calling NotificationsApi->PutNotificationsChannelSubscriptions") - } - // verify the required parameter 'body' is set - if &body == nil { - // true - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling NotificationsApi->PutNotificationsChannelSubscriptions") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Channeltopicentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/notificationsresponse.go b/build/platformclientv2/notificationsresponse.go deleted file mode 100644 index 46c10802a..000000000 --- a/build/platformclientv2/notificationsresponse.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Notificationsresponse -type Notificationsresponse struct { - // Entities - Entities *[]Wfmusernotification `json:"entities,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Notificationsresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/notificationtemplatebody.go b/build/platformclientv2/notificationtemplatebody.go deleted file mode 100644 index 66f0546db..000000000 --- a/build/platformclientv2/notificationtemplatebody.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Notificationtemplatebody - Template body object -type Notificationtemplatebody struct { - // Text - Body text. For WhatsApp, ignored - Text *string `json:"text,omitempty"` - - - // Parameters - Template parameters for placeholders in template - Parameters *[]Notificationtemplateparameter `json:"parameters,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Notificationtemplatebody) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/notificationtemplatefooter.go b/build/platformclientv2/notificationtemplatefooter.go deleted file mode 100644 index 19ef190ea..000000000 --- a/build/platformclientv2/notificationtemplatefooter.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Notificationtemplatefooter - Template footer object -type Notificationtemplatefooter struct { - // Text - Footer text. For WhatsApp, ignored - Text *string `json:"text,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Notificationtemplatefooter) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/notificationtemplateheader.go b/build/platformclientv2/notificationtemplateheader.go deleted file mode 100644 index 312cf1e18..000000000 --- a/build/platformclientv2/notificationtemplateheader.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Notificationtemplateheader - Template header object -type Notificationtemplateheader struct { - // VarType - Template header type - VarType *string `json:"type,omitempty"` - - - // Text - Header text. For WhatsApp, ignored - Text *string `json:"text,omitempty"` - - - // Media - Attachment object - Media *Contentattachment `json:"media,omitempty"` - - - // Parameters - Template parameters for placeholders in template - Parameters *[]Notificationtemplateparameter `json:"parameters,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Notificationtemplateheader) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/notificationtemplateparameter.go b/build/platformclientv2/notificationtemplateparameter.go deleted file mode 100644 index a7f2ebe2c..000000000 --- a/build/platformclientv2/notificationtemplateparameter.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Notificationtemplateparameter - Parameters for placeholders in template -type Notificationtemplateparameter struct { - // Name - Parameter name - Name *string `json:"name,omitempty"` - - - // Text - Parameter text value - Text *string `json:"text,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Notificationtemplateparameter) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/ntpsettings.go b/build/platformclientv2/ntpsettings.go deleted file mode 100644 index b0cb7fe61..000000000 --- a/build/platformclientv2/ntpsettings.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Ntpsettings -type Ntpsettings struct { - // Servers - List of NTP servers, in priority order - Servers *[]string `json:"servers,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Ntpsettings) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/number.go b/build/platformclientv2/number.go deleted file mode 100644 index bb4c5c552..000000000 --- a/build/platformclientv2/number.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Number -type Number struct { - // Start - Start *string `json:"start,omitempty"` - - - // End - End *string `json:"end,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Number) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/numberplan.go b/build/platformclientv2/numberplan.go deleted file mode 100644 index e9e1f2edc..000000000 --- a/build/platformclientv2/numberplan.go +++ /dev/null @@ -1,90 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Numberplan -type Numberplan struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the entity. - Name *string `json:"name,omitempty"` - - - // Description - The resource's description. - Description *string `json:"description,omitempty"` - - - // Version - The current version of the resource. - Version *int `json:"version,omitempty"` - - - // DateCreated - The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // ModifiedBy - The ID of the user that last modified the resource. - ModifiedBy *string `json:"modifiedBy,omitempty"` - - - // CreatedBy - The ID of the user that created the resource. - CreatedBy *string `json:"createdBy,omitempty"` - - - // State - Indicates if the resource is active, inactive, or deleted. - State *string `json:"state,omitempty"` - - - // ModifiedByApp - The application that last modified the resource. - ModifiedByApp *string `json:"modifiedByApp,omitempty"` - - - // CreatedByApp - The application that created the resource. - CreatedByApp *string `json:"createdByApp,omitempty"` - - - // Match - Match *string `json:"match,omitempty"` - - - // NormalizedFormat - NormalizedFormat *string `json:"normalizedFormat,omitempty"` - - - // Priority - Priority *int `json:"priority,omitempty"` - - - // Numbers - Numbers *[]Number `json:"numbers,omitempty"` - - - // DigitLength - DigitLength *Digitlength `json:"digitLength,omitempty"` - - - // Classification - Classification *string `json:"classification,omitempty"` - - - // MatchType - MatchType *string `json:"matchType,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Numberplan) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/numericrange.go b/build/platformclientv2/numericrange.go deleted file mode 100644 index e3a80ac01..000000000 --- a/build/platformclientv2/numericrange.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Numericrange -type Numericrange struct { - // Gt - Greater than - Gt *float32 `json:"gt,omitempty"` - - - // Gte - Greater than or equal to - Gte *float32 `json:"gte,omitempty"` - - - // Lt - Less than - Lt *float32 `json:"lt,omitempty"` - - - // Lte - Less than or equal to - Lte *float32 `json:"lte,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Numericrange) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/oauthapi.go b/build/platformclientv2/oauthapi.go deleted file mode 100644 index 975673a48..000000000 --- a/build/platformclientv2/oauthapi.go +++ /dev/null @@ -1,954 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "encoding/json" -) - -// OAuthApi provides functions for API endpoints -type OAuthApi struct { - Configuration *Configuration -} - -// NewOAuthApi creates an API instance using the default configuration -func NewOAuthApi() *OAuthApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating OAuthApi with base path: %s", strings.ToLower(config.BasePath))) - return &OAuthApi{ - Configuration: config, - } -} - -// NewOAuthApiWithConfig creates an API instance using the provided configuration -func NewOAuthApiWithConfig(config *Configuration) *OAuthApi { - config.Debugf("Creating OAuthApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &OAuthApi{ - Configuration: config, - } -} - -// DeleteOauthClient invokes DELETE /api/v2/oauth/clients/{clientId} -// -// Delete OAuth Client -// -// -func (a OAuthApi) DeleteOauthClient(clientId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/oauth/clients/{clientId}" - path = strings.Replace(path, "{clientId}", fmt.Sprintf("%v", clientId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'clientId' is set - if &clientId == nil { - // - return nil, errors.New("Missing required parameter 'clientId' when calling OAuthApi->DeleteOauthClient") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// GetOauthAuthorization invokes GET /api/v2/oauth/authorizations/{clientId} -// -// Get a client that is authorized by the resource owner -// -// -func (a OAuthApi) GetOauthAuthorization(clientId string) (*Oauthauthorization, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/oauth/authorizations/{clientId}" - path = strings.Replace(path, "{clientId}", fmt.Sprintf("%v", clientId), -1) - defaultReturn := new(Oauthauthorization) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'clientId' is set - if &clientId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'clientId' when calling OAuthApi->GetOauthAuthorization") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Oauthauthorization - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOauthAuthorizations invokes GET /api/v2/oauth/authorizations -// -// List clients that are authorized by the resource owner -// -// -func (a OAuthApi) GetOauthAuthorizations() (*Oauthauthorizationlisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/oauth/authorizations" - defaultReturn := new(Oauthauthorizationlisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Oauthauthorizationlisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOauthClient invokes GET /api/v2/oauth/clients/{clientId} -// -// Get OAuth Client -// -// -func (a OAuthApi) GetOauthClient(clientId string) (*Oauthclient, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/oauth/clients/{clientId}" - path = strings.Replace(path, "{clientId}", fmt.Sprintf("%v", clientId), -1) - defaultReturn := new(Oauthclient) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'clientId' is set - if &clientId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'clientId' when calling OAuthApi->GetOauthClient") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Oauthclient - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOauthClientUsageQueryResult invokes GET /api/v2/oauth/clients/{clientId}/usage/query/results/{executionId} -// -// Get the results of a usage query -// -// -func (a OAuthApi) GetOauthClientUsageQueryResult(executionId string, clientId string) (*Apiusagequeryresult, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/oauth/clients/{clientId}/usage/query/results/{executionId}" - path = strings.Replace(path, "{executionId}", fmt.Sprintf("%v", executionId), -1) - path = strings.Replace(path, "{clientId}", fmt.Sprintf("%v", clientId), -1) - defaultReturn := new(Apiusagequeryresult) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'executionId' is set - if &executionId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'executionId' when calling OAuthApi->GetOauthClientUsageQueryResult") - } - // verify the required parameter 'clientId' is set - if &clientId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'clientId' when calling OAuthApi->GetOauthClientUsageQueryResult") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Apiusagequeryresult - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOauthClientUsageSummary invokes GET /api/v2/oauth/clients/{clientId}/usage/summary -// -// Get a summary of OAuth client API usage -// -// After calling this method, you will then need to poll for the query results based on the returned execution Id -func (a OAuthApi) GetOauthClientUsageSummary(clientId string, days string) (*Usageexecutionresult, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/oauth/clients/{clientId}/usage/summary" - path = strings.Replace(path, "{clientId}", fmt.Sprintf("%v", clientId), -1) - defaultReturn := new(Usageexecutionresult) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'clientId' is set - if &clientId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'clientId' when calling OAuthApi->GetOauthClientUsageSummary") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(days).(string); ok { - if str != "" { - queryParams["days"] = a.Configuration.APIClient.ParameterToString(days, collectionFormat) - } - } else { - queryParams["days"] = a.Configuration.APIClient.ParameterToString(days, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Usageexecutionresult - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOauthClients invokes GET /api/v2/oauth/clients -// -// The list of OAuth clients -// -// -func (a OAuthApi) GetOauthClients() (*Oauthcliententitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/oauth/clients" - defaultReturn := new(Oauthcliententitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Oauthcliententitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOauthScope invokes GET /api/v2/oauth/scopes/{scopeId} -// -// An OAuth scope -// -// -func (a OAuthApi) GetOauthScope(scopeId string, acceptLanguage string) (*Oauthscope, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/oauth/scopes/{scopeId}" - path = strings.Replace(path, "{scopeId}", fmt.Sprintf("%v", scopeId), -1) - defaultReturn := new(Oauthscope) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'scopeId' is set - if &scopeId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'scopeId' when calling OAuthApi->GetOauthScope") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - // header params "Accept-Language" - headerParams["Accept-Language"] = acceptLanguage - - var successPayload *Oauthscope - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOauthScopes invokes GET /api/v2/oauth/scopes -// -// The list of OAuth scopes -// -// -func (a OAuthApi) GetOauthScopes(acceptLanguage string) (*Oauthscopelisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/oauth/scopes" - defaultReturn := new(Oauthscopelisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - // header params "Accept-Language" - headerParams["Accept-Language"] = acceptLanguage - - var successPayload *Oauthscopelisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostOauthClientSecret invokes POST /api/v2/oauth/clients/{clientId}/secret -// -// Regenerate Client Secret -// -// This operation will set the client secret to a randomly generated cryptographically random value. All clients must be updated with the new secret. This operation should be used with caution. -func (a OAuthApi) PostOauthClientSecret(clientId string) (*Oauthclient, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/oauth/clients/{clientId}/secret" - path = strings.Replace(path, "{clientId}", fmt.Sprintf("%v", clientId), -1) - defaultReturn := new(Oauthclient) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'clientId' is set - if &clientId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'clientId' when calling OAuthApi->PostOauthClientSecret") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Oauthclient - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostOauthClientUsageQuery invokes POST /api/v2/oauth/clients/{clientId}/usage/query -// -// Query for OAuth client API usage -// -// After calling this method, you will then need to poll for the query results based on the returned execution Id -func (a OAuthApi) PostOauthClientUsageQuery(clientId string, body Apiusagequery) (*Usageexecutionresult, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/oauth/clients/{clientId}/usage/query" - path = strings.Replace(path, "{clientId}", fmt.Sprintf("%v", clientId), -1) - defaultReturn := new(Usageexecutionresult) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'clientId' is set - if &clientId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'clientId' when calling OAuthApi->PostOauthClientUsageQuery") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling OAuthApi->PostOauthClientUsageQuery") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Usageexecutionresult - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostOauthClients invokes POST /api/v2/oauth/clients -// -// Create OAuth client -// -// The OAuth Grant/Client is required in order to create an authentication token and gain access to PureCloud. The preferred authorizedGrantTypes is 'CODE' which requires applications to send a client ID and client secret. This is typically a web server. If OAuth PKCE attributes will be used for a code grant, the grant type CODE_PKCE should be used. This will require PKCE challenge and verifier for authentication. If the client is unable to secure the client secret then the 'TOKEN' grant type aka IMPLICIT should be used. This is would be for browser or mobile apps. If a client is to be used outside of the context of a user then the 'CLIENT-CREDENTIALS' grant may be used. In this case the client must be granted roles via the 'roleIds' field. -func (a OAuthApi) PostOauthClients(body Oauthclientrequest) (*Oauthclient, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/oauth/clients" - defaultReturn := new(Oauthclient) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling OAuthApi->PostOauthClients") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Oauthclient - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutOauthClient invokes PUT /api/v2/oauth/clients/{clientId} -// -// Update OAuth Client -// -// -func (a OAuthApi) PutOauthClient(clientId string, body Oauthclientrequest) (*Oauthclient, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/oauth/clients/{clientId}" - path = strings.Replace(path, "{clientId}", fmt.Sprintf("%v", clientId), -1) - defaultReturn := new(Oauthclient) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'clientId' is set - if &clientId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'clientId' when calling OAuthApi->PutOauthClient") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling OAuthApi->PutOauthClient") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Oauthclient - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/oauthauthorization.go b/build/platformclientv2/oauthauthorization.go deleted file mode 100644 index 4d1613c6d..000000000 --- a/build/platformclientv2/oauthauthorization.go +++ /dev/null @@ -1,50 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Oauthauthorization -type Oauthauthorization struct { - // Client - Client *Oauthclient `json:"client,omitempty"` - - - // Scope - Scope *[]string `json:"scope,omitempty"` - - - // ResourceOwner - ResourceOwner *Domainentityref `json:"resourceOwner,omitempty"` - - - // DateCreated - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // CreatedBy - CreatedBy *Domainentityref `json:"createdBy,omitempty"` - - - // ModifiedBy - ModifiedBy *Domainentityref `json:"modifiedBy,omitempty"` - - - // Pending - Pending *bool `json:"pending,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Oauthauthorization) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/oauthauthorizationlisting.go b/build/platformclientv2/oauthauthorizationlisting.go deleted file mode 100644 index d9476ca89..000000000 --- a/build/platformclientv2/oauthauthorizationlisting.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Oauthauthorizationlisting -type Oauthauthorizationlisting struct { - // Total - Total *int `json:"total,omitempty"` - - - // Entities - Entities *[]Oauthauthorization `json:"entities,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Oauthauthorizationlisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/oauthclient.go b/build/platformclientv2/oauthclient.go deleted file mode 100644 index d22115403..000000000 --- a/build/platformclientv2/oauthclient.go +++ /dev/null @@ -1,82 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Oauthclient -type Oauthclient struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the OAuth client. - Name *string `json:"name,omitempty"` - - - // AccessTokenValiditySeconds - The number of seconds, between 5mins and 48hrs, until tokens created with this client expire. If this field is omitted, a default of 24 hours will be applied. - AccessTokenValiditySeconds *int `json:"accessTokenValiditySeconds,omitempty"` - - - // Description - Description *string `json:"description,omitempty"` - - - // RegisteredRedirectUri - List of allowed callbacks for this client. For example: https://myap.example.com/auth/callback - RegisteredRedirectUri *[]string `json:"registeredRedirectUri,omitempty"` - - - // Secret - System created secret assigned to this client. Secrets are required for code authorization and client credential grants. - Secret *string `json:"secret,omitempty"` - - - // RoleIds - Deprecated. Use roleDivisions instead. - RoleIds *[]string `json:"roleIds,omitempty"` - - - // DateCreated - Date this client was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - Date this client was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // CreatedBy - User that created this client - CreatedBy *Domainentityref `json:"createdBy,omitempty"` - - - // ModifiedBy - User that last modified this client - ModifiedBy *Domainentityref `json:"modifiedBy,omitempty"` - - - // AuthorizedGrantType - The OAuth Grant/Client type supported by this client. Code Authorization Grant/Client type - Preferred client type where the Client ID and Secret are required to create tokens. Used where the secret can be secured. PKCE-Enabled Code Authorization grant type - Code grant type which requires PKCE challenge and verifier to create tokens. Used in public clients for increased security. Implicit grant type - Client ID only is required to create tokens. Used in browser and mobile apps where the secret can not be secured. SAML2-Bearer extension grant type - SAML2 assertion provider for user authentication at the token endpoint. Client Credential grant type - Used to created access tokens that are tied only to the client. - AuthorizedGrantType *string `json:"authorizedGrantType,omitempty"` - - - // Scope - The scope requested by this client. Scopes only apply to clients not using the client_credential grant - Scope *[]string `json:"scope,omitempty"` - - - // RoleDivisions - Set of roles and their corresponding divisions associated with this client. Roles and divisions only apply to clients using the client_credential grant - RoleDivisions *[]Roledivision `json:"roleDivisions,omitempty"` - - - // State - The state of the OAuth client. Active: The OAuth client can be used to create access tokens. This is the default state. Disabled: Access tokens created by the client are invalid and new ones cannot be created. Inactive: Access tokens cannot be created with this OAuth client and it will be deleted. - State *string `json:"state,omitempty"` - - - // DateToDelete - The time at which this client will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateToDelete *time.Time `json:"dateToDelete,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Oauthclient) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/oauthcliententitylisting.go b/build/platformclientv2/oauthcliententitylisting.go deleted file mode 100644 index 221579c2b..000000000 --- a/build/platformclientv2/oauthcliententitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Oauthcliententitylisting -type Oauthcliententitylisting struct { - // Entities - Entities *[]Oauthclientlisting `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Oauthcliententitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/oauthclientlisting.go b/build/platformclientv2/oauthclientlisting.go deleted file mode 100644 index 156000b07..000000000 --- a/build/platformclientv2/oauthclientlisting.go +++ /dev/null @@ -1,78 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Oauthclientlisting -type Oauthclientlisting struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the OAuth client. - Name *string `json:"name,omitempty"` - - - // AccessTokenValiditySeconds - The number of seconds, between 5mins and 48hrs, until tokens created with this client expire. If this field is omitted, a default of 24 hours will be applied. - AccessTokenValiditySeconds *int `json:"accessTokenValiditySeconds,omitempty"` - - - // Description - Description *string `json:"description,omitempty"` - - - // RegisteredRedirectUri - List of allowed callbacks for this client. For example: https://myap.example.com/auth/callback - RegisteredRedirectUri *[]string `json:"registeredRedirectUri,omitempty"` - - - // Secret - System created secret assigned to this client. Secrets are required for code authorization and client credential grants. - Secret *string `json:"secret,omitempty"` - - - // RoleIds - Deprecated. Use roleDivisions instead. - RoleIds *[]string `json:"roleIds,omitempty"` - - - // DateCreated - Date this client was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - Date this client was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // CreatedBy - User that created this client - CreatedBy *Domainentityref `json:"createdBy,omitempty"` - - - // ModifiedBy - User that last modified this client - ModifiedBy *Domainentityref `json:"modifiedBy,omitempty"` - - - // Scope - The scope requested by this client. Scopes only apply to clients not using the client_credential grant - Scope *[]string `json:"scope,omitempty"` - - - // RoleDivisions - Set of roles and their corresponding divisions associated with this client. Roles and divisions only apply to clients using the client_credential grant - RoleDivisions *[]Roledivision `json:"roleDivisions,omitempty"` - - - // State - The state of the OAuth client. Active: The OAuth client can be used to create access tokens. This is the default state. Disabled: Access tokens created by the client are invalid and new ones cannot be created. Inactive: Access tokens cannot be created with this OAuth client and it will be deleted. - State *string `json:"state,omitempty"` - - - // DateToDelete - The time at which this client will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateToDelete *time.Time `json:"dateToDelete,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Oauthclientlisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/oauthclientrequest.go b/build/platformclientv2/oauthclientrequest.go deleted file mode 100644 index b06dc2c4b..000000000 --- a/build/platformclientv2/oauthclientrequest.go +++ /dev/null @@ -1,54 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Oauthclientrequest -type Oauthclientrequest struct { - // Name - The name of the OAuth client. - Name *string `json:"name,omitempty"` - - - // AccessTokenValiditySeconds - The number of seconds, between 5mins and 48hrs, until tokens created with this client expire. If this field is omitted, a default of 24 hours will be applied. - AccessTokenValiditySeconds *int `json:"accessTokenValiditySeconds,omitempty"` - - - // Description - Description *string `json:"description,omitempty"` - - - // RegisteredRedirectUri - List of allowed callbacks for this client. For example: https://myap.example.com/auth/callback - RegisteredRedirectUri *[]string `json:"registeredRedirectUri,omitempty"` - - - // RoleIds - Deprecated. Use roleDivisions instead. - RoleIds *[]string `json:"roleIds,omitempty"` - - - // AuthorizedGrantType - The OAuth Grant/Client type supported by this client. Code Authorization Grant/Client type - Preferred client type where the Client ID and Secret are required to create tokens. Used where the secret can be secured. PKCE-Enabled Code Authorization grant type - Code grant type which requires PKCE challenge and verifier to create tokens. Used in public clients for increased security. Implicit grant type - Client ID only is required to create tokens. Used in browser and mobile apps where the secret can not be secured. SAML2-Bearer extension grant type - SAML2 assertion provider for user authentication at the token endpoint. Client Credential grant type - Used to created access tokens that are tied only to the client. - AuthorizedGrantType *string `json:"authorizedGrantType,omitempty"` - - - // Scope - The scope requested by this client. Scopes only apply to clients not using the client_credential grant - Scope *[]string `json:"scope,omitempty"` - - - // RoleDivisions - Set of roles and their corresponding divisions associated with this client. Roles and divisions only apply to clients using the client_credential grant - RoleDivisions *[]Roledivision `json:"roleDivisions,omitempty"` - - - // State - The state of the OAuth client. Active: The OAuth client can be used to create access tokens. This is the default state. Disabled: Access tokens created by the client are invalid and new ones cannot be created. Inactive: Access tokens cannot be created with this OAuth client and it will be deleted. - State *string `json:"state,omitempty"` - - - // DateToDelete - The time at which this client will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateToDelete *time.Time `json:"dateToDelete,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Oauthclientrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/oauthlasttokenissued.go b/build/platformclientv2/oauthlasttokenissued.go deleted file mode 100644 index 24d6e4807..000000000 --- a/build/platformclientv2/oauthlasttokenissued.go +++ /dev/null @@ -1,18 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Oauthlasttokenissued -type Oauthlasttokenissued struct { - // DateIssued - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateIssued *time.Time `json:"dateIssued,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Oauthlasttokenissued) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/oauthprovider.go b/build/platformclientv2/oauthprovider.go deleted file mode 100644 index d1ce70672..000000000 --- a/build/platformclientv2/oauthprovider.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Oauthprovider -type Oauthprovider struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Disabled - Disabled *bool `json:"disabled,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Oauthprovider) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/oauthproviderentitylisting.go b/build/platformclientv2/oauthproviderentitylisting.go deleted file mode 100644 index f8438e191..000000000 --- a/build/platformclientv2/oauthproviderentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Oauthproviderentitylisting -type Oauthproviderentitylisting struct { - // Entities - Entities *[]Oauthprovider `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Oauthproviderentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/oauthscope.go b/build/platformclientv2/oauthscope.go deleted file mode 100644 index aa1fdd07f..000000000 --- a/build/platformclientv2/oauthscope.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Oauthscope -type Oauthscope struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Description - Description *string `json:"description,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Oauthscope) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/oauthscopelisting.go b/build/platformclientv2/oauthscopelisting.go deleted file mode 100644 index 3591aed0c..000000000 --- a/build/platformclientv2/oauthscopelisting.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Oauthscopelisting -type Oauthscopelisting struct { - // Total - Total *int `json:"total,omitempty"` - - - // Entities - Entities *[]Oauthscope `json:"entities,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Oauthscopelisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/objectsapi.go b/build/platformclientv2/objectsapi.go deleted file mode 100644 index f84ba24ce..000000000 --- a/build/platformclientv2/objectsapi.go +++ /dev/null @@ -1,722 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "encoding/json" -) - -// ObjectsApi provides functions for API endpoints -type ObjectsApi struct { - Configuration *Configuration -} - -// NewObjectsApi creates an API instance using the default configuration -func NewObjectsApi() *ObjectsApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating ObjectsApi with base path: %s", strings.ToLower(config.BasePath))) - return &ObjectsApi{ - Configuration: config, - } -} - -// NewObjectsApiWithConfig creates an API instance using the provided configuration -func NewObjectsApiWithConfig(config *Configuration) *ObjectsApi { - config.Debugf("Creating ObjectsApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &ObjectsApi{ - Configuration: config, - } -} - -// DeleteAuthorizationDivision invokes DELETE /api/v2/authorization/divisions/{divisionId} -// -// Delete a division. -// -// -func (a ObjectsApi) DeleteAuthorizationDivision(divisionId string, force bool) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/authorization/divisions/{divisionId}" - path = strings.Replace(path, "{divisionId}", fmt.Sprintf("%v", divisionId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'divisionId' is set - if &divisionId == nil { - // - return nil, errors.New("Missing required parameter 'divisionId' when calling ObjectsApi->DeleteAuthorizationDivision") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(force).(string); ok { - if str != "" { - queryParams["force"] = a.Configuration.APIClient.ParameterToString(force, collectionFormat) - } - } else { - queryParams["force"] = a.Configuration.APIClient.ParameterToString(force, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// GetAuthorizationDivision invokes GET /api/v2/authorization/divisions/{divisionId} -// -// Returns an authorization division. -// -// -func (a ObjectsApi) GetAuthorizationDivision(divisionId string, objectCount bool) (*Authzdivision, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/authorization/divisions/{divisionId}" - path = strings.Replace(path, "{divisionId}", fmt.Sprintf("%v", divisionId), -1) - defaultReturn := new(Authzdivision) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'divisionId' is set - if &divisionId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'divisionId' when calling ObjectsApi->GetAuthorizationDivision") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(objectCount).(string); ok { - if str != "" { - queryParams["objectCount"] = a.Configuration.APIClient.ParameterToString(objectCount, collectionFormat) - } - } else { - queryParams["objectCount"] = a.Configuration.APIClient.ParameterToString(objectCount, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Authzdivision - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAuthorizationDivisions invokes GET /api/v2/authorization/divisions -// -// Retrieve a list of all divisions defined for the organization -// -// Request specific divisions by id using a query param \"id\", e.g. ?id=5f777167-63be-4c24-ad41-374155d9e28b&id=72e9fb25-c484-488d-9312-7acba82435b3 -func (a ObjectsApi) GetAuthorizationDivisions(pageSize int, pageNumber int, sortBy string, expand []string, nextPage string, previousPage string, objectCount bool, id []string, name string) (*Authzdivisionentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/authorization/divisions" - defaultReturn := new(Authzdivisionentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(nextPage).(string); ok { - if str != "" { - queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) - } - } else { - queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(previousPage).(string); ok { - if str != "" { - queryParams["previousPage"] = a.Configuration.APIClient.ParameterToString(previousPage, collectionFormat) - } - } else { - queryParams["previousPage"] = a.Configuration.APIClient.ParameterToString(previousPage, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(objectCount).(string); ok { - if str != "" { - queryParams["objectCount"] = a.Configuration.APIClient.ParameterToString(objectCount, collectionFormat) - } - } else { - queryParams["objectCount"] = a.Configuration.APIClient.ParameterToString(objectCount, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range id { - queryParams["id"] = value - } - } else { - queryParams["id"] = a.Configuration.APIClient.ParameterToString(id, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Authzdivisionentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAuthorizationDivisionsHome invokes GET /api/v2/authorization/divisions/home -// -// Retrieve the home division for the organization. -// -// Will not include object counts. -func (a ObjectsApi) GetAuthorizationDivisionsHome() (*Authzdivision, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/authorization/divisions/home" - defaultReturn := new(Authzdivision) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Authzdivision - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAuthorizationDivisionsLimit invokes GET /api/v2/authorization/divisions/limit -// -// Returns the maximum allowed number of divisions. -// -// -func (a ObjectsApi) GetAuthorizationDivisionsLimit() (*int, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/authorization/divisions/limit" - defaultReturn := new(int) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *int - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostAuthorizationDivisionObject invokes POST /api/v2/authorization/divisions/{divisionId}/objects/{objectType} -// -// Assign a list of objects to a division -// -// Set the division of a specified list of objects. The objects must all be of the same type, one of: CAMPAIGN, MANAGEMENTUNIT, FLOW, QUEUE, or USER. The body of the request is a list of object IDs, which are expected to be GUIDs, e.g. [\"206ce31f-61ec-40ed-a8b1-be6f06303998\",\"250a754e-f5e4-4f51-800f-a92f09d3bf8c\"] -func (a ObjectsApi) PostAuthorizationDivisionObject(divisionId string, objectType string, body []string) (*APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/authorization/divisions/{divisionId}/objects/{objectType}" - path = strings.Replace(path, "{divisionId}", fmt.Sprintf("%v", divisionId), -1) - path = strings.Replace(path, "{objectType}", fmt.Sprintf("%v", objectType), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'divisionId' is set - if &divisionId == nil { - // - return nil, errors.New("Missing required parameter 'divisionId' when calling ObjectsApi->PostAuthorizationDivisionObject") - } - // verify the required parameter 'objectType' is set - if &objectType == nil { - // - return nil, errors.New("Missing required parameter 'objectType' when calling ObjectsApi->PostAuthorizationDivisionObject") - } - // verify the required parameter 'body' is set - if &body == nil { - // true - return nil, errors.New("Missing required parameter 'body' when calling ObjectsApi->PostAuthorizationDivisionObject") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// PostAuthorizationDivisions invokes POST /api/v2/authorization/divisions -// -// Create a division. -// -// -func (a ObjectsApi) PostAuthorizationDivisions(body Authzdivision) (*Authzdivision, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/authorization/divisions" - defaultReturn := new(Authzdivision) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ObjectsApi->PostAuthorizationDivisions") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Authzdivision - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutAuthorizationDivision invokes PUT /api/v2/authorization/divisions/{divisionId} -// -// Update a division. -// -// -func (a ObjectsApi) PutAuthorizationDivision(divisionId string, body Authzdivision) (*Authzdivision, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/authorization/divisions/{divisionId}" - path = strings.Replace(path, "{divisionId}", fmt.Sprintf("%v", divisionId), -1) - defaultReturn := new(Authzdivision) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'divisionId' is set - if &divisionId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'divisionId' when calling ObjectsApi->PutAuthorizationDivision") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ObjectsApi->PutAuthorizationDivision") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Authzdivision - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/observationmetricdata.go b/build/platformclientv2/observationmetricdata.go deleted file mode 100644 index d6d36ffbf..000000000 --- a/build/platformclientv2/observationmetricdata.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Observationmetricdata -type Observationmetricdata struct { - // Metric - Metric *string `json:"metric,omitempty"` - - - // Qualifier - Qualifier *string `json:"qualifier,omitempty"` - - - // Stats - Stats *Statisticalsummary `json:"stats,omitempty"` - - - // Truncated - Flag for a truncated list of observations. If truncated, the first half of the list of observations will contain the oldest observations and the second half the newest observations. - Truncated *bool `json:"truncated,omitempty"` - - - // Observations - List of observations sorted by timestamp in ascending order. This list may be truncated. - Observations *[]Observationvalue `json:"observations,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Observationmetricdata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/observationvalue.go b/build/platformclientv2/observationvalue.go deleted file mode 100644 index d8107b549..000000000 --- a/build/platformclientv2/observationvalue.go +++ /dev/null @@ -1,90 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Observationvalue -type Observationvalue struct { - // ObservationDate - The time at which the observation occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ObservationDate *time.Time `json:"observationDate,omitempty"` - - - // ConversationId - Unique identifier for the conversation - ConversationId *string `json:"conversationId,omitempty"` - - - // SessionId - The unique identifier of this session - SessionId *string `json:"sessionId,omitempty"` - - - // RequestedRoutingSkillIds - Unique identifier for a skill requested for an interaction - RequestedRoutingSkillIds *[]string `json:"requestedRoutingSkillIds,omitempty"` - - - // RequestedLanguageId - Unique identifier for the language requested for an interaction - RequestedLanguageId *string `json:"requestedLanguageId,omitempty"` - - - // RoutingPriority - Routing priority for the current interaction - RoutingPriority *int `json:"routingPriority,omitempty"` - - - // ParticipantName - A human readable name identifying the participant - ParticipantName *string `json:"participantName,omitempty"` - - - // UserId - Unique identifier for the user - UserId *string `json:"userId,omitempty"` - - - // Direction - The direction of the communication - Direction *string `json:"direction,omitempty"` - - - // ConvertedFrom - Session media type that was converted from in case of a media type conversion - ConvertedFrom *string `json:"convertedFrom,omitempty"` - - - // ConvertedTo - Session media type that was converted to in case of a media type conversion - ConvertedTo *string `json:"convertedTo,omitempty"` - - - // AddressFrom - The address that initiated an action - AddressFrom *string `json:"addressFrom,omitempty"` - - - // AddressTo - The address receiving an action - AddressTo *string `json:"addressTo,omitempty"` - - - // Ani - Automatic Number Identification (caller's number) - Ani *string `json:"ani,omitempty"` - - - // Dnis - Dialed number identification service (number dialed by the calling party) - Dnis *string `json:"dnis,omitempty"` - - - // TeamId - The team id the user is a member of - TeamId *string `json:"teamId,omitempty"` - - - // RequestedRoutings - All routing types for requested/attempted routing methods - RequestedRoutings *[]string `json:"requestedRoutings,omitempty"` - - - // UsedRouting - Complete routing method - UsedRouting *string `json:"usedRouting,omitempty"` - - - // ScoredAgents - ScoredAgents *[]Analyticsscoredagent `json:"scoredAgents,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Observationvalue) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/okta.go b/build/platformclientv2/okta.go deleted file mode 100644 index 0558a9834..000000000 --- a/build/platformclientv2/okta.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Okta -type Okta struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Disabled - Disabled *bool `json:"disabled,omitempty"` - - - // IssuerURI - IssuerURI *string `json:"issuerURI,omitempty"` - - - // SsoTargetURI - SsoTargetURI *string `json:"ssoTargetURI,omitempty"` - - - // Certificate - Certificate *string `json:"certificate,omitempty"` - - - // Certificates - Certificates *[]string `json:"certificates,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Okta) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/onelogin.go b/build/platformclientv2/onelogin.go deleted file mode 100644 index c490d721f..000000000 --- a/build/platformclientv2/onelogin.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Onelogin -type Onelogin struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Disabled - Disabled *bool `json:"disabled,omitempty"` - - - // IssuerURI - IssuerURI *string `json:"issuerURI,omitempty"` - - - // SsoTargetURI - SsoTargetURI *string `json:"ssoTargetURI,omitempty"` - - - // Certificate - Certificate *string `json:"certificate,omitempty"` - - - // Certificates - Certificates *[]string `json:"certificates,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Onelogin) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/operation.go b/build/platformclientv2/operation.go deleted file mode 100644 index 579094306..000000000 --- a/build/platformclientv2/operation.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Operation -type Operation struct { - // Id - Id *string `json:"id,omitempty"` - - - // Complete - Complete *bool `json:"complete,omitempty"` - - - // User - User *User `json:"user,omitempty"` - - - // Client - Client *Domainentityref `json:"client,omitempty"` - - - // ErrorMessage - ErrorMessage *string `json:"errorMessage,omitempty"` - - - // ErrorCode - ErrorCode *string `json:"errorCode,omitempty"` - - - // ErrorDetails - ErrorDetails *[]Detail `json:"errorDetails,omitempty"` - - - // ErrorMessageParams - ErrorMessageParams *map[string]string `json:"errorMessageParams,omitempty"` - - - // ActionName - Action name - ActionName *string `json:"actionName,omitempty"` - - - // ActionStatus - Action status - ActionStatus *string `json:"actionStatus,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Operation) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/organization.go b/build/platformclientv2/organization.go deleted file mode 100644 index 67bcd0079..000000000 --- a/build/platformclientv2/organization.go +++ /dev/null @@ -1,73 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Organization -type Organization struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // DefaultLanguage - The default language for this organization. Example: 'en' - DefaultLanguage *string `json:"defaultLanguage,omitempty"` - - - // DefaultCountryCode - The default country code for this organization. Example: 'US' - DefaultCountryCode *string `json:"defaultCountryCode,omitempty"` - - - // ThirdPartyOrgName - The short name for the organization. This field is globally unique and cannot be changed. - ThirdPartyOrgName *string `json:"thirdPartyOrgName,omitempty"` - - - // ThirdPartyURI - ThirdPartyURI *string `json:"thirdPartyURI,omitempty"` - - - // Domain - Domain *string `json:"domain,omitempty"` - - - // Version - The current version of the organization. - Version *int `json:"version,omitempty"` - - - // State - The current state. Examples are active, inactive, deleted. - State *string `json:"state,omitempty"` - - - // DefaultSiteId - DefaultSiteId *string `json:"defaultSiteId,omitempty"` - - - // SupportURI - Email address where support tickets are sent to. - SupportURI *string `json:"supportURI,omitempty"` - - - // VoicemailEnabled - VoicemailEnabled *bool `json:"voicemailEnabled,omitempty"` - - - // ProductPlatform - Organizations Originating Platform. - ProductPlatform *string `json:"productPlatform,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - - - // Features - The state of features available for the organization. - Features *map[string]bool `json:"features,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Organization) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/organizationapi.go b/build/platformclientv2/organizationapi.go deleted file mode 100644 index ce1d7c614..000000000 --- a/build/platformclientv2/organizationapi.go +++ /dev/null @@ -1,722 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "encoding/json" -) - -// OrganizationApi provides functions for API endpoints -type OrganizationApi struct { - Configuration *Configuration -} - -// NewOrganizationApi creates an API instance using the default configuration -func NewOrganizationApi() *OrganizationApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating OrganizationApi with base path: %s", strings.ToLower(config.BasePath))) - return &OrganizationApi{ - Configuration: config, - } -} - -// NewOrganizationApiWithConfig creates an API instance using the provided configuration -func NewOrganizationApiWithConfig(config *Configuration) *OrganizationApi { - config.Debugf("Creating OrganizationApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &OrganizationApi{ - Configuration: config, - } -} - -// GetFieldconfig invokes GET /api/v2/fieldconfig -// -// Fetch field config for an entity type -// -// -func (a OrganizationApi) GetFieldconfig(varType string) (*Fieldconfig, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/fieldconfig" - defaultReturn := new(Fieldconfig) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'varType' is set - if &varType == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'varType' when calling OrganizationApi->GetFieldconfig") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(varType).(string); ok { - if str != "" { - queryParams["varType"] = a.Configuration.APIClient.ParameterToString(varType, collectionFormat) - } - } else { - queryParams["varType"] = a.Configuration.APIClient.ParameterToString(varType, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Fieldconfig - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOrganizationsEmbeddedintegration invokes GET /api/v2/organizations/embeddedintegration -// -// Get the list of domains that will be allowed to embed PureCloud applications -// -// -func (a OrganizationApi) GetOrganizationsEmbeddedintegration() (*Embeddedintegration, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/organizations/embeddedintegration" - defaultReturn := new(Embeddedintegration) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Embeddedintegration - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOrganizationsIpaddressauthentication invokes GET /api/v2/organizations/ipaddressauthentication -// -// Get organization IP address whitelist settings -// -// -func (a OrganizationApi) GetOrganizationsIpaddressauthentication() (*Ipaddressauthentication, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/organizations/ipaddressauthentication" - defaultReturn := new(Ipaddressauthentication) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Ipaddressauthentication - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOrganizationsMe invokes GET /api/v2/organizations/me -// -// Get organization. -// -// -func (a OrganizationApi) GetOrganizationsMe() (*Organization, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/organizations/me" - defaultReturn := new(Organization) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Organization - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOrganizationsWhitelist invokes GET /api/v2/organizations/whitelist -// -// Use PUT /api/v2/organizations/embeddedintegration instead -// -// -func (a OrganizationApi) GetOrganizationsWhitelist() (*Orgwhitelistsettings, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/organizations/whitelist" - defaultReturn := new(Orgwhitelistsettings) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Orgwhitelistsettings - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchOrganizationsFeature invokes PATCH /api/v2/organizations/features/{featureName} -// -// Update organization -// -// -func (a OrganizationApi) PatchOrganizationsFeature(featureName string, enabled Featurestate) (*Organizationfeatures, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/organizations/features/{featureName}" - path = strings.Replace(path, "{featureName}", fmt.Sprintf("%v", featureName), -1) - defaultReturn := new(Organizationfeatures) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'featureName' is set - if &featureName == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'featureName' when calling OrganizationApi->PatchOrganizationsFeature") - } - // verify the required parameter 'enabled' is set - if &enabled == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'enabled' when calling OrganizationApi->PatchOrganizationsFeature") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &enabled - - var successPayload *Organizationfeatures - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutOrganizationsEmbeddedintegration invokes PUT /api/v2/organizations/embeddedintegration -// -// Update the list of domains that will be allowed to embed PureCloud applications -// -// -func (a OrganizationApi) PutOrganizationsEmbeddedintegration(body Embeddedintegration) (*Embeddedintegration, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/organizations/embeddedintegration" - defaultReturn := new(Embeddedintegration) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling OrganizationApi->PutOrganizationsEmbeddedintegration") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Embeddedintegration - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutOrganizationsIpaddressauthentication invokes PUT /api/v2/organizations/ipaddressauthentication -// -// Update organization IP address whitelist settings -// -// -func (a OrganizationApi) PutOrganizationsIpaddressauthentication(body Ipaddressauthentication) (*Ipaddressauthentication, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/organizations/ipaddressauthentication" - defaultReturn := new(Ipaddressauthentication) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling OrganizationApi->PutOrganizationsIpaddressauthentication") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Ipaddressauthentication - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutOrganizationsMe invokes PUT /api/v2/organizations/me -// -// Update organization. -// -// -func (a OrganizationApi) PutOrganizationsMe(body Organization) (*Organization, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/organizations/me" - defaultReturn := new(Organization) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Organization - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutOrganizationsWhitelist invokes PUT /api/v2/organizations/whitelist -// -// Use PUT /api/v2/organizations/embeddedintegration instead -// -// -func (a OrganizationApi) PutOrganizationsWhitelist(body Orgwhitelistsettings) (*Orgwhitelistsettings, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/organizations/whitelist" - defaultReturn := new(Orgwhitelistsettings) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling OrganizationApi->PutOrganizationsWhitelist") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Orgwhitelistsettings - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/organizationauthorizationapi.go b/build/platformclientv2/organizationauthorizationapi.go deleted file mode 100644 index 7ddfef576..000000000 --- a/build/platformclientv2/organizationauthorizationapi.go +++ /dev/null @@ -1,1959 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "encoding/json" -) - -// OrganizationAuthorizationApi provides functions for API endpoints -type OrganizationAuthorizationApi struct { - Configuration *Configuration -} - -// NewOrganizationAuthorizationApi creates an API instance using the default configuration -func NewOrganizationAuthorizationApi() *OrganizationAuthorizationApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating OrganizationAuthorizationApi with base path: %s", strings.ToLower(config.BasePath))) - return &OrganizationAuthorizationApi{ - Configuration: config, - } -} - -// NewOrganizationAuthorizationApiWithConfig creates an API instance using the provided configuration -func NewOrganizationAuthorizationApiWithConfig(config *Configuration) *OrganizationAuthorizationApi { - config.Debugf("Creating OrganizationAuthorizationApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &OrganizationAuthorizationApi{ - Configuration: config, - } -} - -// DeleteOrgauthorizationTrustee invokes DELETE /api/v2/orgauthorization/trustees/{trusteeOrgId} -// -// Delete Org Trust -// -// -func (a OrganizationAuthorizationApi) DeleteOrgauthorizationTrustee(trusteeOrgId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/orgauthorization/trustees/{trusteeOrgId}" - path = strings.Replace(path, "{trusteeOrgId}", fmt.Sprintf("%v", trusteeOrgId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'trusteeOrgId' is set - if &trusteeOrgId == nil { - // - return nil, errors.New("Missing required parameter 'trusteeOrgId' when calling OrganizationAuthorizationApi->DeleteOrgauthorizationTrustee") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteOrgauthorizationTrusteeUser invokes DELETE /api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId} -// -// Delete Trustee User -// -// -func (a OrganizationAuthorizationApi) DeleteOrgauthorizationTrusteeUser(trusteeOrgId string, trusteeUserId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}" - path = strings.Replace(path, "{trusteeOrgId}", fmt.Sprintf("%v", trusteeOrgId), -1) - path = strings.Replace(path, "{trusteeUserId}", fmt.Sprintf("%v", trusteeUserId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'trusteeOrgId' is set - if &trusteeOrgId == nil { - // - return nil, errors.New("Missing required parameter 'trusteeOrgId' when calling OrganizationAuthorizationApi->DeleteOrgauthorizationTrusteeUser") - } - // verify the required parameter 'trusteeUserId' is set - if &trusteeUserId == nil { - // - return nil, errors.New("Missing required parameter 'trusteeUserId' when calling OrganizationAuthorizationApi->DeleteOrgauthorizationTrusteeUser") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteOrgauthorizationTrusteeUserRoles invokes DELETE /api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}/roles -// -// Delete Trustee User Roles -// -// -func (a OrganizationAuthorizationApi) DeleteOrgauthorizationTrusteeUserRoles(trusteeOrgId string, trusteeUserId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}/roles" - path = strings.Replace(path, "{trusteeOrgId}", fmt.Sprintf("%v", trusteeOrgId), -1) - path = strings.Replace(path, "{trusteeUserId}", fmt.Sprintf("%v", trusteeUserId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'trusteeOrgId' is set - if &trusteeOrgId == nil { - // - return nil, errors.New("Missing required parameter 'trusteeOrgId' when calling OrganizationAuthorizationApi->DeleteOrgauthorizationTrusteeUserRoles") - } - // verify the required parameter 'trusteeUserId' is set - if &trusteeUserId == nil { - // - return nil, errors.New("Missing required parameter 'trusteeUserId' when calling OrganizationAuthorizationApi->DeleteOrgauthorizationTrusteeUserRoles") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteOrgauthorizationTrustor invokes DELETE /api/v2/orgauthorization/trustors/{trustorOrgId} -// -// Delete Org Trust -// -// -func (a OrganizationAuthorizationApi) DeleteOrgauthorizationTrustor(trustorOrgId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/orgauthorization/trustors/{trustorOrgId}" - path = strings.Replace(path, "{trustorOrgId}", fmt.Sprintf("%v", trustorOrgId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'trustorOrgId' is set - if &trustorOrgId == nil { - // - return nil, errors.New("Missing required parameter 'trustorOrgId' when calling OrganizationAuthorizationApi->DeleteOrgauthorizationTrustor") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteOrgauthorizationTrustorUser invokes DELETE /api/v2/orgauthorization/trustors/{trustorOrgId}/users/{trusteeUserId} -// -// Delete Trustee User -// -// -func (a OrganizationAuthorizationApi) DeleteOrgauthorizationTrustorUser(trustorOrgId string, trusteeUserId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/orgauthorization/trustors/{trustorOrgId}/users/{trusteeUserId}" - path = strings.Replace(path, "{trustorOrgId}", fmt.Sprintf("%v", trustorOrgId), -1) - path = strings.Replace(path, "{trusteeUserId}", fmt.Sprintf("%v", trusteeUserId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'trustorOrgId' is set - if &trustorOrgId == nil { - // - return nil, errors.New("Missing required parameter 'trustorOrgId' when calling OrganizationAuthorizationApi->DeleteOrgauthorizationTrustorUser") - } - // verify the required parameter 'trusteeUserId' is set - if &trusteeUserId == nil { - // - return nil, errors.New("Missing required parameter 'trusteeUserId' when calling OrganizationAuthorizationApi->DeleteOrgauthorizationTrustorUser") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// GetOrgauthorizationPairing invokes GET /api/v2/orgauthorization/pairings/{pairingId} -// -// Get Pairing Info -// -// -func (a OrganizationAuthorizationApi) GetOrgauthorizationPairing(pairingId string) (*Trustrequest, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/orgauthorization/pairings/{pairingId}" - path = strings.Replace(path, "{pairingId}", fmt.Sprintf("%v", pairingId), -1) - defaultReturn := new(Trustrequest) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'pairingId' is set - if &pairingId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'pairingId' when calling OrganizationAuthorizationApi->GetOrgauthorizationPairing") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Trustrequest - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOrgauthorizationTrustee invokes GET /api/v2/orgauthorization/trustees/{trusteeOrgId} -// -// Get Org Trust -// -// -func (a OrganizationAuthorizationApi) GetOrgauthorizationTrustee(trusteeOrgId string) (*Trustee, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/orgauthorization/trustees/{trusteeOrgId}" - path = strings.Replace(path, "{trusteeOrgId}", fmt.Sprintf("%v", trusteeOrgId), -1) - defaultReturn := new(Trustee) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'trusteeOrgId' is set - if &trusteeOrgId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'trusteeOrgId' when calling OrganizationAuthorizationApi->GetOrgauthorizationTrustee") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Trustee - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOrgauthorizationTrusteeUser invokes GET /api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId} -// -// Get Trustee User -// -// -func (a OrganizationAuthorizationApi) GetOrgauthorizationTrusteeUser(trusteeOrgId string, trusteeUserId string) (*Trustuser, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}" - path = strings.Replace(path, "{trusteeOrgId}", fmt.Sprintf("%v", trusteeOrgId), -1) - path = strings.Replace(path, "{trusteeUserId}", fmt.Sprintf("%v", trusteeUserId), -1) - defaultReturn := new(Trustuser) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'trusteeOrgId' is set - if &trusteeOrgId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'trusteeOrgId' when calling OrganizationAuthorizationApi->GetOrgauthorizationTrusteeUser") - } - // verify the required parameter 'trusteeUserId' is set - if &trusteeUserId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'trusteeUserId' when calling OrganizationAuthorizationApi->GetOrgauthorizationTrusteeUser") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Trustuser - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOrgauthorizationTrusteeUserRoles invokes GET /api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}/roles -// -// Get Trustee User Roles -// -// -func (a OrganizationAuthorizationApi) GetOrgauthorizationTrusteeUserRoles(trusteeOrgId string, trusteeUserId string) (*Userauthorization, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}/roles" - path = strings.Replace(path, "{trusteeOrgId}", fmt.Sprintf("%v", trusteeOrgId), -1) - path = strings.Replace(path, "{trusteeUserId}", fmt.Sprintf("%v", trusteeUserId), -1) - defaultReturn := new(Userauthorization) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'trusteeOrgId' is set - if &trusteeOrgId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'trusteeOrgId' when calling OrganizationAuthorizationApi->GetOrgauthorizationTrusteeUserRoles") - } - // verify the required parameter 'trusteeUserId' is set - if &trusteeUserId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'trusteeUserId' when calling OrganizationAuthorizationApi->GetOrgauthorizationTrusteeUserRoles") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Userauthorization - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOrgauthorizationTrusteeUsers invokes GET /api/v2/orgauthorization/trustees/{trusteeOrgId}/users -// -// The list of trustee users for this organization (i.e. users granted access to this organization). -// -// -func (a OrganizationAuthorizationApi) GetOrgauthorizationTrusteeUsers(trusteeOrgId string, pageSize int, pageNumber int) (*Trustuserentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/orgauthorization/trustees/{trusteeOrgId}/users" - path = strings.Replace(path, "{trusteeOrgId}", fmt.Sprintf("%v", trusteeOrgId), -1) - defaultReturn := new(Trustuserentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'trusteeOrgId' is set - if &trusteeOrgId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'trusteeOrgId' when calling OrganizationAuthorizationApi->GetOrgauthorizationTrusteeUsers") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Trustuserentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOrgauthorizationTrustees invokes GET /api/v2/orgauthorization/trustees -// -// The list of trustees for this organization (i.e. organizations granted access to this organization). -// -// -func (a OrganizationAuthorizationApi) GetOrgauthorizationTrustees(pageSize int, pageNumber int) (*Trustentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/orgauthorization/trustees" - defaultReturn := new(Trustentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Trustentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOrgauthorizationTrustor invokes GET /api/v2/orgauthorization/trustors/{trustorOrgId} -// -// Get Org Trust -// -// -func (a OrganizationAuthorizationApi) GetOrgauthorizationTrustor(trustorOrgId string) (*Trustor, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/orgauthorization/trustors/{trustorOrgId}" - path = strings.Replace(path, "{trustorOrgId}", fmt.Sprintf("%v", trustorOrgId), -1) - defaultReturn := new(Trustor) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'trustorOrgId' is set - if &trustorOrgId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'trustorOrgId' when calling OrganizationAuthorizationApi->GetOrgauthorizationTrustor") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Trustor - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOrgauthorizationTrustorUser invokes GET /api/v2/orgauthorization/trustors/{trustorOrgId}/users/{trusteeUserId} -// -// Get Trustee User -// -// -func (a OrganizationAuthorizationApi) GetOrgauthorizationTrustorUser(trustorOrgId string, trusteeUserId string) (*Trustuser, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/orgauthorization/trustors/{trustorOrgId}/users/{trusteeUserId}" - path = strings.Replace(path, "{trustorOrgId}", fmt.Sprintf("%v", trustorOrgId), -1) - path = strings.Replace(path, "{trusteeUserId}", fmt.Sprintf("%v", trusteeUserId), -1) - defaultReturn := new(Trustuser) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'trustorOrgId' is set - if &trustorOrgId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'trustorOrgId' when calling OrganizationAuthorizationApi->GetOrgauthorizationTrustorUser") - } - // verify the required parameter 'trusteeUserId' is set - if &trusteeUserId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'trusteeUserId' when calling OrganizationAuthorizationApi->GetOrgauthorizationTrustorUser") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Trustuser - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOrgauthorizationTrustorUsers invokes GET /api/v2/orgauthorization/trustors/{trustorOrgId}/users -// -// The list of users in the trustor organization (i.e. users granted access). -// -// -func (a OrganizationAuthorizationApi) GetOrgauthorizationTrustorUsers(trustorOrgId string, pageSize int, pageNumber int) (*Trustuserentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/orgauthorization/trustors/{trustorOrgId}/users" - path = strings.Replace(path, "{trustorOrgId}", fmt.Sprintf("%v", trustorOrgId), -1) - defaultReturn := new(Trustuserentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'trustorOrgId' is set - if &trustorOrgId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'trustorOrgId' when calling OrganizationAuthorizationApi->GetOrgauthorizationTrustorUsers") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Trustuserentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOrgauthorizationTrustors invokes GET /api/v2/orgauthorization/trustors -// -// The list of organizations that have authorized/trusted your organization. -// -// -func (a OrganizationAuthorizationApi) GetOrgauthorizationTrustors(pageSize int, pageNumber int) (*Trustorentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/orgauthorization/trustors" - defaultReturn := new(Trustorentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Trustorentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostOrgauthorizationPairings invokes POST /api/v2/orgauthorization/pairings -// -// A pairing id is created by the trustee and given to the trustor to create a trust. -// -// -func (a OrganizationAuthorizationApi) PostOrgauthorizationPairings(body Trustrequestcreate) (*Trustrequest, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/orgauthorization/pairings" - defaultReturn := new(Trustrequest) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling OrganizationAuthorizationApi->PostOrgauthorizationPairings") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Trustrequest - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostOrgauthorizationTrusteeUsers invokes POST /api/v2/orgauthorization/trustees/{trusteeOrgId}/users -// -// Add a user to the trust. -// -// -func (a OrganizationAuthorizationApi) PostOrgauthorizationTrusteeUsers(trusteeOrgId string, body Trustmembercreate) (*Trustuser, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/orgauthorization/trustees/{trusteeOrgId}/users" - path = strings.Replace(path, "{trusteeOrgId}", fmt.Sprintf("%v", trusteeOrgId), -1) - defaultReturn := new(Trustuser) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'trusteeOrgId' is set - if &trusteeOrgId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'trusteeOrgId' when calling OrganizationAuthorizationApi->PostOrgauthorizationTrusteeUsers") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling OrganizationAuthorizationApi->PostOrgauthorizationTrusteeUsers") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Trustuser - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostOrgauthorizationTrustees invokes POST /api/v2/orgauthorization/trustees -// -// Create a new organization authorization trust. This is required to grant other organizations access to your organization. -// -// -func (a OrganizationAuthorizationApi) PostOrgauthorizationTrustees(body Trustcreate) (*Trustee, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/orgauthorization/trustees" - defaultReturn := new(Trustee) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling OrganizationAuthorizationApi->PostOrgauthorizationTrustees") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Trustee - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostOrgauthorizationTrusteesAudits invokes POST /api/v2/orgauthorization/trustees/audits -// -// Get Org Trustee Audits -// -// -func (a OrganizationAuthorizationApi) PostOrgauthorizationTrusteesAudits(body Trusteeauditqueryrequest, pageSize int, pageNumber int, sortBy string, sortOrder string) (*Auditqueryresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/orgauthorization/trustees/audits" - defaultReturn := new(Auditqueryresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling OrganizationAuthorizationApi->PostOrgauthorizationTrusteesAudits") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Auditqueryresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostOrgauthorizationTrustorAudits invokes POST /api/v2/orgauthorization/trustor/audits -// -// Get Org Trustor Audits -// -// -func (a OrganizationAuthorizationApi) PostOrgauthorizationTrustorAudits(body Trustorauditqueryrequest, pageSize int, pageNumber int, sortBy string, sortOrder string) (*Auditqueryresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/orgauthorization/trustor/audits" - defaultReturn := new(Auditqueryresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling OrganizationAuthorizationApi->PostOrgauthorizationTrustorAudits") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Auditqueryresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutOrgauthorizationTrustee invokes PUT /api/v2/orgauthorization/trustees/{trusteeOrgId} -// -// Update Org Trust -// -// -func (a OrganizationAuthorizationApi) PutOrgauthorizationTrustee(trusteeOrgId string, body Trustee) (*Trustee, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/orgauthorization/trustees/{trusteeOrgId}" - path = strings.Replace(path, "{trusteeOrgId}", fmt.Sprintf("%v", trusteeOrgId), -1) - defaultReturn := new(Trustee) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'trusteeOrgId' is set - if &trusteeOrgId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'trusteeOrgId' when calling OrganizationAuthorizationApi->PutOrgauthorizationTrustee") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling OrganizationAuthorizationApi->PutOrgauthorizationTrustee") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Trustee - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutOrgauthorizationTrusteeUserRoledivisions invokes PUT /api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}/roledivisions -// -// Update Trustee User Roles -// -// -func (a OrganizationAuthorizationApi) PutOrgauthorizationTrusteeUserRoledivisions(trusteeOrgId string, trusteeUserId string, body Roledivisiongrants) (*Userauthorization, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}/roledivisions" - path = strings.Replace(path, "{trusteeOrgId}", fmt.Sprintf("%v", trusteeOrgId), -1) - path = strings.Replace(path, "{trusteeUserId}", fmt.Sprintf("%v", trusteeUserId), -1) - defaultReturn := new(Userauthorization) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'trusteeOrgId' is set - if &trusteeOrgId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'trusteeOrgId' when calling OrganizationAuthorizationApi->PutOrgauthorizationTrusteeUserRoledivisions") - } - // verify the required parameter 'trusteeUserId' is set - if &trusteeUserId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'trusteeUserId' when calling OrganizationAuthorizationApi->PutOrgauthorizationTrusteeUserRoledivisions") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling OrganizationAuthorizationApi->PutOrgauthorizationTrusteeUserRoledivisions") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Userauthorization - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutOrgauthorizationTrusteeUserRoles invokes PUT /api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}/roles -// -// Update Trustee User Roles -// -// -func (a OrganizationAuthorizationApi) PutOrgauthorizationTrusteeUserRoles(trusteeOrgId string, trusteeUserId string, body []string) (*Userauthorization, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}/roles" - path = strings.Replace(path, "{trusteeOrgId}", fmt.Sprintf("%v", trusteeOrgId), -1) - path = strings.Replace(path, "{trusteeUserId}", fmt.Sprintf("%v", trusteeUserId), -1) - defaultReturn := new(Userauthorization) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'trusteeOrgId' is set - if &trusteeOrgId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'trusteeOrgId' when calling OrganizationAuthorizationApi->PutOrgauthorizationTrusteeUserRoles") - } - // verify the required parameter 'trusteeUserId' is set - if &trusteeUserId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'trusteeUserId' when calling OrganizationAuthorizationApi->PutOrgauthorizationTrusteeUserRoles") - } - // verify the required parameter 'body' is set - if &body == nil { - // true - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling OrganizationAuthorizationApi->PutOrgauthorizationTrusteeUserRoles") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Userauthorization - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutOrgauthorizationTrustorUser invokes PUT /api/v2/orgauthorization/trustors/{trustorOrgId}/users/{trusteeUserId} -// -// Add a Trustee user to the trust. -// -// -func (a OrganizationAuthorizationApi) PutOrgauthorizationTrustorUser(trustorOrgId string, trusteeUserId string) (*Trustuser, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/orgauthorization/trustors/{trustorOrgId}/users/{trusteeUserId}" - path = strings.Replace(path, "{trustorOrgId}", fmt.Sprintf("%v", trustorOrgId), -1) - path = strings.Replace(path, "{trusteeUserId}", fmt.Sprintf("%v", trusteeUserId), -1) - defaultReturn := new(Trustuser) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'trustorOrgId' is set - if &trustorOrgId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'trustorOrgId' when calling OrganizationAuthorizationApi->PutOrgauthorizationTrustorUser") - } - // verify the required parameter 'trusteeUserId' is set - if &trusteeUserId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'trusteeUserId' when calling OrganizationAuthorizationApi->PutOrgauthorizationTrustorUser") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Trustuser - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/organizationfeatures.go b/build/platformclientv2/organizationfeatures.go deleted file mode 100644 index 8bcd75c3b..000000000 --- a/build/platformclientv2/organizationfeatures.go +++ /dev/null @@ -1,65 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Organizationfeatures -type Organizationfeatures struct { - // RealtimeCIC - RealtimeCIC *bool `json:"realtimeCIC,omitempty"` - - - // Purecloud - Purecloud *bool `json:"purecloud,omitempty"` - - - // Hipaa - Hipaa *bool `json:"hipaa,omitempty"` - - - // UcEnabled - UcEnabled *bool `json:"ucEnabled,omitempty"` - - - // Pci - Pci *bool `json:"pci,omitempty"` - - - // PurecloudVoice - PurecloudVoice *bool `json:"purecloudVoice,omitempty"` - - - // XmppFederation - XmppFederation *bool `json:"xmppFederation,omitempty"` - - - // Chat - Chat *bool `json:"chat,omitempty"` - - - // InformalPhotos - InformalPhotos *bool `json:"informalPhotos,omitempty"` - - - // Directory - Directory *bool `json:"directory,omitempty"` - - - // ContactCenter - ContactCenter *bool `json:"contactCenter,omitempty"` - - - // UnifiedCommunications - UnifiedCommunications *bool `json:"unifiedCommunications,omitempty"` - - - // Custserv - Custserv *bool `json:"custserv,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Organizationfeatures) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/organizationpresence.go b/build/platformclientv2/organizationpresence.go deleted file mode 100644 index a0302301d..000000000 --- a/build/platformclientv2/organizationpresence.go +++ /dev/null @@ -1,58 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Organizationpresence -type Organizationpresence struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // LanguageLabels - The label used for the system presence in each specified language - LanguageLabels *map[string]string `json:"languageLabels,omitempty"` - - - // SystemPresence - SystemPresence *string `json:"systemPresence,omitempty"` - - - // Deactivated - Deactivated *bool `json:"deactivated,omitempty"` - - - // Primary - Primary *bool `json:"primary,omitempty"` - - - // CreatedBy - CreatedBy *User `json:"createdBy,omitempty"` - - - // CreatedDate - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - CreatedDate *time.Time `json:"createdDate,omitempty"` - - - // ModifiedBy - ModifiedBy *User `json:"modifiedBy,omitempty"` - - - // ModifiedDate - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ModifiedDate *time.Time `json:"modifiedDate,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Organizationpresence) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/organizationpresenceentitylisting.go b/build/platformclientv2/organizationpresenceentitylisting.go deleted file mode 100644 index c9e2cfa98..000000000 --- a/build/platformclientv2/organizationpresenceentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Organizationpresenceentitylisting -type Organizationpresenceentitylisting struct { - // Entities - Entities *[]Organizationpresence `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Organizationpresenceentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/organizationproductentitylisting.go b/build/platformclientv2/organizationproductentitylisting.go deleted file mode 100644 index dfc7c63b7..000000000 --- a/build/platformclientv2/organizationproductentitylisting.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Organizationproductentitylisting -type Organizationproductentitylisting struct { - // Entities - Entities *[]Domainorganizationproduct `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Organizationproductentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/organizationroleentitylisting.go b/build/platformclientv2/organizationroleentitylisting.go deleted file mode 100644 index e65744294..000000000 --- a/build/platformclientv2/organizationroleentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Organizationroleentitylisting -type Organizationroleentitylisting struct { - // Entities - Entities *[]Domainorganizationrole `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Organizationroleentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/orgoauthclient.go b/build/platformclientv2/orgoauthclient.go deleted file mode 100644 index 5b16d2850..000000000 --- a/build/platformclientv2/orgoauthclient.go +++ /dev/null @@ -1,62 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Orgoauthclient -type Orgoauthclient struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the OAuth client. - Name *string `json:"name,omitempty"` - - - // DateCreated - Date this client was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - Date this client was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // CreatedBy - User that created this client - CreatedBy *Domainentityref `json:"createdBy,omitempty"` - - - // ModifiedBy - User that last modified this client - ModifiedBy *Domainentityref `json:"modifiedBy,omitempty"` - - - // AuthorizedGrantType - The OAuth Grant/Client type supported by this client. Code Authorization Grant/Client type - Preferred client type where the Client ID and Secret are required to create tokens. Used where the secret can be secured. PKCE-Enabled Code Authorization grant type - Code grant type which requires PKCE challenge and verifier to create tokens. Used in public clients for increased security. Implicit grant type - Client ID only is required to create tokens. Used in browser and mobile apps where the secret can not be secured. SAML2-Bearer extension grant type - SAML2 assertion provider for user authentication at the token endpoint. Client Credential grant type - Used to created access tokens that are tied only to the client. - AuthorizedGrantType *string `json:"authorizedGrantType,omitempty"` - - - // Scope - The scope requested by this client. Scopes only apply to clients not using the client_credential grant - Scope *[]string `json:"scope,omitempty"` - - - // RoleDivisions - Set of roles and their corresponding divisions associated with this client. Roles and divisions only apply to clients using the client_credential grant - RoleDivisions *[]Roledivision `json:"roleDivisions,omitempty"` - - - // State - The state of the OAuth client. Active: The OAuth client can be used to create access tokens. This is the default state. Disabled: Access tokens created by the client are invalid and new ones cannot be created. Inactive: Access tokens cannot be created with this OAuth client and it will be deleted. - State *string `json:"state,omitempty"` - - - // DateToDelete - The time at which this client will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateToDelete *time.Time `json:"dateToDelete,omitempty"` - - - // Organization - The oauth client's organization. - Organization *Namedentity `json:"organization,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Orgoauthclient) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/orguser.go b/build/platformclientv2/orguser.go deleted file mode 100644 index bd5047e4a..000000000 --- a/build/platformclientv2/orguser.go +++ /dev/null @@ -1,149 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Orguser -type Orguser struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Division - The division to which this entity belongs. - Division *Division `json:"division,omitempty"` - - - // Chat - Chat *Chat `json:"chat,omitempty"` - - - // Department - Department *string `json:"department,omitempty"` - - - // Email - Email *string `json:"email,omitempty"` - - - // PrimaryContactInfo - Auto populated from addresses. - PrimaryContactInfo *[]Contact `json:"primaryContactInfo,omitempty"` - - - // Addresses - Email addresses and phone numbers for this user - Addresses *[]Contact `json:"addresses,omitempty"` - - - // State - The current state for this user. - State *string `json:"state,omitempty"` - - - // Title - Title *string `json:"title,omitempty"` - - - // Username - Username *string `json:"username,omitempty"` - - - // Manager - Manager **User `json:"manager,omitempty"` - - - // Images - Images *[]Userimage `json:"images,omitempty"` - - - // Version - Required when updating a user, this value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH. - Version *int `json:"version,omitempty"` - - - // Certifications - Certifications *[]string `json:"certifications,omitempty"` - - - // Biography - Biography *Biography `json:"biography,omitempty"` - - - // EmployerInfo - EmployerInfo *Employerinfo `json:"employerInfo,omitempty"` - - - // RoutingStatus - ACD routing status - RoutingStatus *Routingstatus `json:"routingStatus,omitempty"` - - - // Presence - Active presence - Presence *Userpresence `json:"presence,omitempty"` - - - // ConversationSummary - Summary of conversion statistics for conversation types. - ConversationSummary *Userconversationsummary `json:"conversationSummary,omitempty"` - - - // OutOfOffice - Determine if out of office is enabled - OutOfOffice *Outofoffice `json:"outOfOffice,omitempty"` - - - // Geolocation - Current geolocation position - Geolocation *Geolocation `json:"geolocation,omitempty"` - - - // Station - Effective, default, and last station information - Station *Userstations `json:"station,omitempty"` - - - // Authorization - Roles and permissions assigned to the user - Authorization *Userauthorization `json:"authorization,omitempty"` - - - // ProfileSkills - Profile skills possessed by the user - ProfileSkills *[]string `json:"profileSkills,omitempty"` - - - // Locations - The user placement at each site location. - Locations *[]Location `json:"locations,omitempty"` - - - // Groups - The groups the user is a member of - Groups *[]Group `json:"groups,omitempty"` - - - // Team - The team the user is a member of - Team *Team `json:"team,omitempty"` - - - // Skills - Routing (ACD) skills possessed by the user - Skills *[]Userroutingskill `json:"skills,omitempty"` - - - // Languages - Routing (ACD) languages possessed by the user - Languages *[]Userroutinglanguage `json:"languages,omitempty"` - - - // AcdAutoAnswer - acd auto answer - AcdAutoAnswer *bool `json:"acdAutoAnswer,omitempty"` - - - // LanguagePreference - preferred language by the user - LanguagePreference *string `json:"languagePreference,omitempty"` - - - // LastTokenIssued - LastTokenIssued *Oauthlasttokenissued `json:"lastTokenIssued,omitempty"` - - - // Organization - Organization *Organization `json:"organization,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Orguser) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/orgwhitelistsettings.go b/build/platformclientv2/orgwhitelistsettings.go deleted file mode 100644 index 323ecb026..000000000 --- a/build/platformclientv2/orgwhitelistsettings.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Orgwhitelistsettings -type Orgwhitelistsettings struct { - // EnableWhitelist - EnableWhitelist *bool `json:"enableWhitelist,omitempty"` - - - // DomainWhitelist - DomainWhitelist *[]string `json:"domainWhitelist,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Orgwhitelistsettings) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/orphanrecording.go b/build/platformclientv2/orphanrecording.go deleted file mode 100644 index b09ba33dc..000000000 --- a/build/platformclientv2/orphanrecording.go +++ /dev/null @@ -1,66 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Orphanrecording -type Orphanrecording struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // CreatedTime - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - CreatedTime *time.Time `json:"createdTime,omitempty"` - - - // RecoveredTime - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - RecoveredTime *time.Time `json:"recoveredTime,omitempty"` - - - // ProviderType - ProviderType *string `json:"providerType,omitempty"` - - - // MediaSizeBytes - MediaSizeBytes *int `json:"mediaSizeBytes,omitempty"` - - - // MediaType - MediaType *string `json:"mediaType,omitempty"` - - - // FileState - FileState *string `json:"fileState,omitempty"` - - - // ProviderEndpoint - ProviderEndpoint *Endpoint `json:"providerEndpoint,omitempty"` - - - // Recording - Recording *Recording `json:"recording,omitempty"` - - - // OrphanStatus - The status of the orphaned recording's conversation. - OrphanStatus *string `json:"orphanStatus,omitempty"` - - - // SourceOrphaningId - An identifier used during recovery operations by the supplying hybrid platform to track back and determine which interaction this recording is associated with - SourceOrphaningId *string `json:"sourceOrphaningId,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Orphanrecording) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/orphanrecordinglisting.go b/build/platformclientv2/orphanrecordinglisting.go deleted file mode 100644 index c71abe801..000000000 --- a/build/platformclientv2/orphanrecordinglisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Orphanrecordinglisting -type Orphanrecordinglisting struct { - // Entities - Entities *[]Orphanrecording `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Orphanrecordinglisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/orphanupdaterequest.go b/build/platformclientv2/orphanupdaterequest.go deleted file mode 100644 index b832d80b4..000000000 --- a/build/platformclientv2/orphanupdaterequest.go +++ /dev/null @@ -1,26 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Orphanupdaterequest -type Orphanupdaterequest struct { - // ArchiveDate - The orphan recording's archive date. Must be greater than 1 day from now if set. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ArchiveDate *time.Time `json:"archiveDate,omitempty"` - - - // DeleteDate - The orphan recording's delete date. Must be greater than archiveDate if set, otherwise one day from now. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DeleteDate *time.Time `json:"deleteDate,omitempty"` - - - // ConversationId - A conversation Id that this orphan's recording is to be attached to. If not present, the conversationId will be deduced from the recording media. - ConversationId *string `json:"conversationId,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Orphanupdaterequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/outboundapi.go b/build/platformclientv2/outboundapi.go deleted file mode 100644 index 3d3b3348a..000000000 --- a/build/platformclientv2/outboundapi.go +++ /dev/null @@ -1,9569 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "encoding/json" -) - -// OutboundApi provides functions for API endpoints -type OutboundApi struct { - Configuration *Configuration -} - -// NewOutboundApi creates an API instance using the default configuration -func NewOutboundApi() *OutboundApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating OutboundApi with base path: %s", strings.ToLower(config.BasePath))) - return &OutboundApi{ - Configuration: config, - } -} - -// NewOutboundApiWithConfig creates an API instance using the provided configuration -func NewOutboundApiWithConfig(config *Configuration) *OutboundApi { - config.Debugf("Creating OutboundApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &OutboundApi{ - Configuration: config, - } -} - -// DeleteOutboundAttemptlimit invokes DELETE /api/v2/outbound/attemptlimits/{attemptLimitsId} -// -// Delete attempt limits -// -// -func (a OutboundApi) DeleteOutboundAttemptlimit(attemptLimitsId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/attemptlimits/{attemptLimitsId}" - path = strings.Replace(path, "{attemptLimitsId}", fmt.Sprintf("%v", attemptLimitsId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'attemptLimitsId' is set - if &attemptLimitsId == nil { - // - return nil, errors.New("Missing required parameter 'attemptLimitsId' when calling OutboundApi->DeleteOutboundAttemptlimit") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteOutboundCallabletimeset invokes DELETE /api/v2/outbound/callabletimesets/{callableTimeSetId} -// -// Delete callable time set -// -// -func (a OutboundApi) DeleteOutboundCallabletimeset(callableTimeSetId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/callabletimesets/{callableTimeSetId}" - path = strings.Replace(path, "{callableTimeSetId}", fmt.Sprintf("%v", callableTimeSetId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'callableTimeSetId' is set - if &callableTimeSetId == nil { - // - return nil, errors.New("Missing required parameter 'callableTimeSetId' when calling OutboundApi->DeleteOutboundCallabletimeset") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteOutboundCallanalysisresponseset invokes DELETE /api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId} -// -// Delete a dialer call analysis response set. -// -// -func (a OutboundApi) DeleteOutboundCallanalysisresponseset(callAnalysisSetId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId}" - path = strings.Replace(path, "{callAnalysisSetId}", fmt.Sprintf("%v", callAnalysisSetId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'callAnalysisSetId' is set - if &callAnalysisSetId == nil { - // - return nil, errors.New("Missing required parameter 'callAnalysisSetId' when calling OutboundApi->DeleteOutboundCallanalysisresponseset") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteOutboundCampaign invokes DELETE /api/v2/outbound/campaigns/{campaignId} -// -// Delete a campaign. -// -// -func (a OutboundApi) DeleteOutboundCampaign(campaignId string) (*Campaign, *APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/campaigns/{campaignId}" - path = strings.Replace(path, "{campaignId}", fmt.Sprintf("%v", campaignId), -1) - defaultReturn := new(Campaign) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'campaignId' is set - if &campaignId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'campaignId' when calling OutboundApi->DeleteOutboundCampaign") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Campaign - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// DeleteOutboundCampaignProgress invokes DELETE /api/v2/outbound/campaigns/{campaignId}/progress -// -// Reset campaign progress and recycle the campaign -// -// -func (a OutboundApi) DeleteOutboundCampaignProgress(campaignId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/campaigns/{campaignId}/progress" - path = strings.Replace(path, "{campaignId}", fmt.Sprintf("%v", campaignId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'campaignId' is set - if &campaignId == nil { - // - return nil, errors.New("Missing required parameter 'campaignId' when calling OutboundApi->DeleteOutboundCampaignProgress") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteOutboundCampaignrule invokes DELETE /api/v2/outbound/campaignrules/{campaignRuleId} -// -// Delete Campaign Rule -// -// -func (a OutboundApi) DeleteOutboundCampaignrule(campaignRuleId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/campaignrules/{campaignRuleId}" - path = strings.Replace(path, "{campaignRuleId}", fmt.Sprintf("%v", campaignRuleId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'campaignRuleId' is set - if &campaignRuleId == nil { - // - return nil, errors.New("Missing required parameter 'campaignRuleId' when calling OutboundApi->DeleteOutboundCampaignrule") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteOutboundContactlist invokes DELETE /api/v2/outbound/contactlists/{contactListId} -// -// Delete a contact list. -// -// -func (a OutboundApi) DeleteOutboundContactlist(contactListId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/contactlists/{contactListId}" - path = strings.Replace(path, "{contactListId}", fmt.Sprintf("%v", contactListId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'contactListId' is set - if &contactListId == nil { - // - return nil, errors.New("Missing required parameter 'contactListId' when calling OutboundApi->DeleteOutboundContactlist") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteOutboundContactlistContact invokes DELETE /api/v2/outbound/contactlists/{contactListId}/contacts/{contactId} -// -// Delete a contact. -// -// -func (a OutboundApi) DeleteOutboundContactlistContact(contactListId string, contactId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/contactlists/{contactListId}/contacts/{contactId}" - path = strings.Replace(path, "{contactListId}", fmt.Sprintf("%v", contactListId), -1) - path = strings.Replace(path, "{contactId}", fmt.Sprintf("%v", contactId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'contactListId' is set - if &contactListId == nil { - // - return nil, errors.New("Missing required parameter 'contactListId' when calling OutboundApi->DeleteOutboundContactlistContact") - } - // verify the required parameter 'contactId' is set - if &contactId == nil { - // - return nil, errors.New("Missing required parameter 'contactId' when calling OutboundApi->DeleteOutboundContactlistContact") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteOutboundContactlistContacts invokes DELETE /api/v2/outbound/contactlists/{contactListId}/contacts -// -// Delete contacts from a contact list. -// -// -func (a OutboundApi) DeleteOutboundContactlistContacts(contactListId string, contactIds []string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/contactlists/{contactListId}/contacts" - path = strings.Replace(path, "{contactListId}", fmt.Sprintf("%v", contactListId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'contactListId' is set - if &contactListId == nil { - // - return nil, errors.New("Missing required parameter 'contactListId' when calling OutboundApi->DeleteOutboundContactlistContacts") - } - // verify the required parameter 'contactIds' is set - if &contactIds == nil { - // true - return nil, errors.New("Missing required parameter 'contactIds' when calling OutboundApi->DeleteOutboundContactlistContacts") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range contactIds { - queryParams["contactIds"] = value - } - } else { - queryParams["contactIds"] = a.Configuration.APIClient.ParameterToString(contactIds, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteOutboundContactlistfilter invokes DELETE /api/v2/outbound/contactlistfilters/{contactListFilterId} -// -// Delete Contact List Filter -// -// -func (a OutboundApi) DeleteOutboundContactlistfilter(contactListFilterId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/contactlistfilters/{contactListFilterId}" - path = strings.Replace(path, "{contactListFilterId}", fmt.Sprintf("%v", contactListFilterId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'contactListFilterId' is set - if &contactListFilterId == nil { - // - return nil, errors.New("Missing required parameter 'contactListFilterId' when calling OutboundApi->DeleteOutboundContactlistfilter") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteOutboundContactlists invokes DELETE /api/v2/outbound/contactlists -// -// Delete multiple contact lists. -// -// -func (a OutboundApi) DeleteOutboundContactlists(id []string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/contactlists" - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'id' is set - if &id == nil { - // true - return nil, errors.New("Missing required parameter 'id' when calling OutboundApi->DeleteOutboundContactlists") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range id { - queryParams["id"] = value - } - } else { - queryParams["id"] = a.Configuration.APIClient.ParameterToString(id, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteOutboundDnclist invokes DELETE /api/v2/outbound/dnclists/{dncListId} -// -// Delete dialer DNC list -// -// -func (a OutboundApi) DeleteOutboundDnclist(dncListId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/dnclists/{dncListId}" - path = strings.Replace(path, "{dncListId}", fmt.Sprintf("%v", dncListId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'dncListId' is set - if &dncListId == nil { - // - return nil, errors.New("Missing required parameter 'dncListId' when calling OutboundApi->DeleteOutboundDnclist") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteOutboundMessagingcampaign invokes DELETE /api/v2/outbound/messagingcampaigns/{messagingCampaignId} -// -// Delete an Outbound Messaging Campaign -// -// -func (a OutboundApi) DeleteOutboundMessagingcampaign(messagingCampaignId string) (*Messagingcampaign, *APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/messagingcampaigns/{messagingCampaignId}" - path = strings.Replace(path, "{messagingCampaignId}", fmt.Sprintf("%v", messagingCampaignId), -1) - defaultReturn := new(Messagingcampaign) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'messagingCampaignId' is set - if &messagingCampaignId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'messagingCampaignId' when calling OutboundApi->DeleteOutboundMessagingcampaign") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Messagingcampaign - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// DeleteOutboundRuleset invokes DELETE /api/v2/outbound/rulesets/{ruleSetId} -// -// Delete a Rule set. -// -// -func (a OutboundApi) DeleteOutboundRuleset(ruleSetId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/rulesets/{ruleSetId}" - path = strings.Replace(path, "{ruleSetId}", fmt.Sprintf("%v", ruleSetId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'ruleSetId' is set - if &ruleSetId == nil { - // - return nil, errors.New("Missing required parameter 'ruleSetId' when calling OutboundApi->DeleteOutboundRuleset") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteOutboundSchedulesCampaign invokes DELETE /api/v2/outbound/schedules/campaigns/{campaignId} -// -// Delete a dialer campaign schedule. -// -// -func (a OutboundApi) DeleteOutboundSchedulesCampaign(campaignId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/schedules/campaigns/{campaignId}" - path = strings.Replace(path, "{campaignId}", fmt.Sprintf("%v", campaignId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'campaignId' is set - if &campaignId == nil { - // - return nil, errors.New("Missing required parameter 'campaignId' when calling OutboundApi->DeleteOutboundSchedulesCampaign") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteOutboundSchedulesSequence invokes DELETE /api/v2/outbound/schedules/sequences/{sequenceId} -// -// Delete a dialer sequence schedule. -// -// -func (a OutboundApi) DeleteOutboundSchedulesSequence(sequenceId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/schedules/sequences/{sequenceId}" - path = strings.Replace(path, "{sequenceId}", fmt.Sprintf("%v", sequenceId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'sequenceId' is set - if &sequenceId == nil { - // - return nil, errors.New("Missing required parameter 'sequenceId' when calling OutboundApi->DeleteOutboundSchedulesSequence") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteOutboundSequence invokes DELETE /api/v2/outbound/sequences/{sequenceId} -// -// Delete a dialer campaign sequence. -// -// -func (a OutboundApi) DeleteOutboundSequence(sequenceId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/sequences/{sequenceId}" - path = strings.Replace(path, "{sequenceId}", fmt.Sprintf("%v", sequenceId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'sequenceId' is set - if &sequenceId == nil { - // - return nil, errors.New("Missing required parameter 'sequenceId' when calling OutboundApi->DeleteOutboundSequence") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// GetOutboundAttemptlimit invokes GET /api/v2/outbound/attemptlimits/{attemptLimitsId} -// -// Get attempt limits -// -// -func (a OutboundApi) GetOutboundAttemptlimit(attemptLimitsId string) (*Attemptlimits, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/attemptlimits/{attemptLimitsId}" - path = strings.Replace(path, "{attemptLimitsId}", fmt.Sprintf("%v", attemptLimitsId), -1) - defaultReturn := new(Attemptlimits) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'attemptLimitsId' is set - if &attemptLimitsId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'attemptLimitsId' when calling OutboundApi->GetOutboundAttemptlimit") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Attemptlimits - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOutboundAttemptlimits invokes GET /api/v2/outbound/attemptlimits -// -// Query attempt limits list -// -// -func (a OutboundApi) GetOutboundAttemptlimits(pageSize int, pageNumber int, allowEmptyResult bool, filterType string, name string, sortBy string, sortOrder string) (*Attemptlimitsentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/attemptlimits" - defaultReturn := new(Attemptlimitsentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(allowEmptyResult).(string); ok { - if str != "" { - queryParams["allowEmptyResult"] = a.Configuration.APIClient.ParameterToString(allowEmptyResult, collectionFormat) - } - } else { - queryParams["allowEmptyResult"] = a.Configuration.APIClient.ParameterToString(allowEmptyResult, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(filterType).(string); ok { - if str != "" { - queryParams["filterType"] = a.Configuration.APIClient.ParameterToString(filterType, collectionFormat) - } - } else { - queryParams["filterType"] = a.Configuration.APIClient.ParameterToString(filterType, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Attemptlimitsentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOutboundCallabletimeset invokes GET /api/v2/outbound/callabletimesets/{callableTimeSetId} -// -// Get callable time set -// -// -func (a OutboundApi) GetOutboundCallabletimeset(callableTimeSetId string) (*Callabletimeset, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/callabletimesets/{callableTimeSetId}" - path = strings.Replace(path, "{callableTimeSetId}", fmt.Sprintf("%v", callableTimeSetId), -1) - defaultReturn := new(Callabletimeset) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'callableTimeSetId' is set - if &callableTimeSetId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'callableTimeSetId' when calling OutboundApi->GetOutboundCallabletimeset") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Callabletimeset - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOutboundCallabletimesets invokes GET /api/v2/outbound/callabletimesets -// -// Query callable time set list -// -// -func (a OutboundApi) GetOutboundCallabletimesets(pageSize int, pageNumber int, allowEmptyResult bool, filterType string, name string, sortBy string, sortOrder string) (*Callabletimesetentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/callabletimesets" - defaultReturn := new(Callabletimesetentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(allowEmptyResult).(string); ok { - if str != "" { - queryParams["allowEmptyResult"] = a.Configuration.APIClient.ParameterToString(allowEmptyResult, collectionFormat) - } - } else { - queryParams["allowEmptyResult"] = a.Configuration.APIClient.ParameterToString(allowEmptyResult, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(filterType).(string); ok { - if str != "" { - queryParams["filterType"] = a.Configuration.APIClient.ParameterToString(filterType, collectionFormat) - } - } else { - queryParams["filterType"] = a.Configuration.APIClient.ParameterToString(filterType, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Callabletimesetentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOutboundCallanalysisresponseset invokes GET /api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId} -// -// Get a dialer call analysis response set. -// -// -func (a OutboundApi) GetOutboundCallanalysisresponseset(callAnalysisSetId string) (*Responseset, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId}" - path = strings.Replace(path, "{callAnalysisSetId}", fmt.Sprintf("%v", callAnalysisSetId), -1) - defaultReturn := new(Responseset) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'callAnalysisSetId' is set - if &callAnalysisSetId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'callAnalysisSetId' when calling OutboundApi->GetOutboundCallanalysisresponseset") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Responseset - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOutboundCallanalysisresponsesets invokes GET /api/v2/outbound/callanalysisresponsesets -// -// Query a list of dialer call analysis response sets. -// -// -func (a OutboundApi) GetOutboundCallanalysisresponsesets(pageSize int, pageNumber int, allowEmptyResult bool, filterType string, name string, sortBy string, sortOrder string) (*Responsesetentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/callanalysisresponsesets" - defaultReturn := new(Responsesetentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(allowEmptyResult).(string); ok { - if str != "" { - queryParams["allowEmptyResult"] = a.Configuration.APIClient.ParameterToString(allowEmptyResult, collectionFormat) - } - } else { - queryParams["allowEmptyResult"] = a.Configuration.APIClient.ParameterToString(allowEmptyResult, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(filterType).(string); ok { - if str != "" { - queryParams["filterType"] = a.Configuration.APIClient.ParameterToString(filterType, collectionFormat) - } - } else { - queryParams["filterType"] = a.Configuration.APIClient.ParameterToString(filterType, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Responsesetentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOutboundCampaign invokes GET /api/v2/outbound/campaigns/{campaignId} -// -// Get dialer campaign. -// -// -func (a OutboundApi) GetOutboundCampaign(campaignId string) (*Campaign, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/campaigns/{campaignId}" - path = strings.Replace(path, "{campaignId}", fmt.Sprintf("%v", campaignId), -1) - defaultReturn := new(Campaign) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'campaignId' is set - if &campaignId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'campaignId' when calling OutboundApi->GetOutboundCampaign") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Campaign - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOutboundCampaignDiagnostics invokes GET /api/v2/outbound/campaigns/{campaignId}/diagnostics -// -// Get campaign diagnostics -// -// -func (a OutboundApi) GetOutboundCampaignDiagnostics(campaignId string) (*Campaigndiagnostics, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/campaigns/{campaignId}/diagnostics" - path = strings.Replace(path, "{campaignId}", fmt.Sprintf("%v", campaignId), -1) - defaultReturn := new(Campaigndiagnostics) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'campaignId' is set - if &campaignId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'campaignId' when calling OutboundApi->GetOutboundCampaignDiagnostics") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Campaigndiagnostics - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOutboundCampaignInteractions invokes GET /api/v2/outbound/campaigns/{campaignId}/interactions -// -// Get dialer campaign interactions. -// -// -func (a OutboundApi) GetOutboundCampaignInteractions(campaignId string) (*Campaigninteractions, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/campaigns/{campaignId}/interactions" - path = strings.Replace(path, "{campaignId}", fmt.Sprintf("%v", campaignId), -1) - defaultReturn := new(Campaigninteractions) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'campaignId' is set - if &campaignId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'campaignId' when calling OutboundApi->GetOutboundCampaignInteractions") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Campaigninteractions - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOutboundCampaignProgress invokes GET /api/v2/outbound/campaigns/{campaignId}/progress -// -// Get campaign progress -// -// -func (a OutboundApi) GetOutboundCampaignProgress(campaignId string) (*Campaignprogress, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/campaigns/{campaignId}/progress" - path = strings.Replace(path, "{campaignId}", fmt.Sprintf("%v", campaignId), -1) - defaultReturn := new(Campaignprogress) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'campaignId' is set - if &campaignId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'campaignId' when calling OutboundApi->GetOutboundCampaignProgress") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Campaignprogress - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOutboundCampaignStats invokes GET /api/v2/outbound/campaigns/{campaignId}/stats -// -// Get statistics about a Dialer Campaign -// -// -func (a OutboundApi) GetOutboundCampaignStats(campaignId string) (*Campaignstats, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/campaigns/{campaignId}/stats" - path = strings.Replace(path, "{campaignId}", fmt.Sprintf("%v", campaignId), -1) - defaultReturn := new(Campaignstats) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'campaignId' is set - if &campaignId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'campaignId' when calling OutboundApi->GetOutboundCampaignStats") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Campaignstats - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOutboundCampaignrule invokes GET /api/v2/outbound/campaignrules/{campaignRuleId} -// -// Get Campaign Rule -// -// -func (a OutboundApi) GetOutboundCampaignrule(campaignRuleId string) (*Campaignrule, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/campaignrules/{campaignRuleId}" - path = strings.Replace(path, "{campaignRuleId}", fmt.Sprintf("%v", campaignRuleId), -1) - defaultReturn := new(Campaignrule) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'campaignRuleId' is set - if &campaignRuleId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'campaignRuleId' when calling OutboundApi->GetOutboundCampaignrule") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Campaignrule - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOutboundCampaignrules invokes GET /api/v2/outbound/campaignrules -// -// Query Campaign Rule list -// -// -func (a OutboundApi) GetOutboundCampaignrules(pageSize int, pageNumber int, allowEmptyResult bool, filterType string, name string, sortBy string, sortOrder string) (*Campaignruleentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/campaignrules" - defaultReturn := new(Campaignruleentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(allowEmptyResult).(string); ok { - if str != "" { - queryParams["allowEmptyResult"] = a.Configuration.APIClient.ParameterToString(allowEmptyResult, collectionFormat) - } - } else { - queryParams["allowEmptyResult"] = a.Configuration.APIClient.ParameterToString(allowEmptyResult, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(filterType).(string); ok { - if str != "" { - queryParams["filterType"] = a.Configuration.APIClient.ParameterToString(filterType, collectionFormat) - } - } else { - queryParams["filterType"] = a.Configuration.APIClient.ParameterToString(filterType, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Campaignruleentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOutboundCampaigns invokes GET /api/v2/outbound/campaigns -// -// Query a list of dialer campaigns. -// -// -func (a OutboundApi) GetOutboundCampaigns(pageSize int, pageNumber int, filterType string, name string, id []string, contactListId string, dncListIds string, distributionQueueId string, edgeGroupId string, callAnalysisResponseSetId string, divisionId []string, sortBy string, sortOrder string) (*Campaignentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/campaigns" - defaultReturn := new(Campaignentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(filterType).(string); ok { - if str != "" { - queryParams["filterType"] = a.Configuration.APIClient.ParameterToString(filterType, collectionFormat) - } - } else { - queryParams["filterType"] = a.Configuration.APIClient.ParameterToString(filterType, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range id { - queryParams["id"] = value - } - } else { - queryParams["id"] = a.Configuration.APIClient.ParameterToString(id, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(contactListId).(string); ok { - if str != "" { - queryParams["contactListId"] = a.Configuration.APIClient.ParameterToString(contactListId, collectionFormat) - } - } else { - queryParams["contactListId"] = a.Configuration.APIClient.ParameterToString(contactListId, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(dncListIds).(string); ok { - if str != "" { - queryParams["dncListIds"] = a.Configuration.APIClient.ParameterToString(dncListIds, collectionFormat) - } - } else { - queryParams["dncListIds"] = a.Configuration.APIClient.ParameterToString(dncListIds, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(distributionQueueId).(string); ok { - if str != "" { - queryParams["distributionQueueId"] = a.Configuration.APIClient.ParameterToString(distributionQueueId, collectionFormat) - } - } else { - queryParams["distributionQueueId"] = a.Configuration.APIClient.ParameterToString(distributionQueueId, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(edgeGroupId).(string); ok { - if str != "" { - queryParams["edgeGroupId"] = a.Configuration.APIClient.ParameterToString(edgeGroupId, collectionFormat) - } - } else { - queryParams["edgeGroupId"] = a.Configuration.APIClient.ParameterToString(edgeGroupId, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(callAnalysisResponseSetId).(string); ok { - if str != "" { - queryParams["callAnalysisResponseSetId"] = a.Configuration.APIClient.ParameterToString(callAnalysisResponseSetId, collectionFormat) - } - } else { - queryParams["callAnalysisResponseSetId"] = a.Configuration.APIClient.ParameterToString(callAnalysisResponseSetId, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range divisionId { - queryParams["divisionId"] = value - } - } else { - queryParams["divisionId"] = a.Configuration.APIClient.ParameterToString(divisionId, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Campaignentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOutboundCampaignsAll invokes GET /api/v2/outbound/campaigns/all -// -// Query across all types of campaigns by division -// -// -func (a OutboundApi) GetOutboundCampaignsAll(pageSize int, pageNumber int, id []string, name string, divisionId []string, mediaType []string, sortOrder string) (*Commoncampaignentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/campaigns/all" - defaultReturn := new(Commoncampaignentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range id { - queryParams["id"] = value - } - } else { - queryParams["id"] = a.Configuration.APIClient.ParameterToString(id, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range divisionId { - queryParams["divisionId"] = value - } - } else { - queryParams["divisionId"] = a.Configuration.APIClient.ParameterToString(divisionId, collectionFormat) - } - - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range mediaType { - queryParams["mediaType"] = value - } - } else { - queryParams["mediaType"] = a.Configuration.APIClient.ParameterToString(mediaType, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Commoncampaignentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOutboundCampaignsAllDivisionviews invokes GET /api/v2/outbound/campaigns/all/divisionviews -// -// Query across all types of campaigns -// -// -func (a OutboundApi) GetOutboundCampaignsAllDivisionviews(pageSize int, pageNumber int, id []string, name string, divisionId []string, mediaType []string, sortOrder string) (*Commoncampaigndivisionviewentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/campaigns/all/divisionviews" - defaultReturn := new(Commoncampaigndivisionviewentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range id { - queryParams["id"] = value - } - } else { - queryParams["id"] = a.Configuration.APIClient.ParameterToString(id, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range divisionId { - queryParams["divisionId"] = value - } - } else { - queryParams["divisionId"] = a.Configuration.APIClient.ParameterToString(divisionId, collectionFormat) - } - - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range mediaType { - queryParams["mediaType"] = value - } - } else { - queryParams["mediaType"] = a.Configuration.APIClient.ParameterToString(mediaType, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Commoncampaigndivisionviewentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOutboundCampaignsDivisionview invokes GET /api/v2/outbound/campaigns/divisionviews/{campaignId} -// -// Get a basic Campaign information object -// -// This returns a simplified version of a Campaign, consisting of name and division. -func (a OutboundApi) GetOutboundCampaignsDivisionview(campaignId string) (*Campaigndivisionview, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/campaigns/divisionviews/{campaignId}" - path = strings.Replace(path, "{campaignId}", fmt.Sprintf("%v", campaignId), -1) - defaultReturn := new(Campaigndivisionview) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'campaignId' is set - if &campaignId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'campaignId' when calling OutboundApi->GetOutboundCampaignsDivisionview") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Campaigndivisionview - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOutboundCampaignsDivisionviews invokes GET /api/v2/outbound/campaigns/divisionviews -// -// Query a list of basic Campaign information objects -// -// This returns a simplified version of a Campaign, consisting of name and division. -func (a OutboundApi) GetOutboundCampaignsDivisionviews(pageSize int, pageNumber int, filterType string, name string, id []string, sortBy string, sortOrder string) (*Campaigndivisionviewlisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/campaigns/divisionviews" - defaultReturn := new(Campaigndivisionviewlisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(filterType).(string); ok { - if str != "" { - queryParams["filterType"] = a.Configuration.APIClient.ParameterToString(filterType, collectionFormat) - } - } else { - queryParams["filterType"] = a.Configuration.APIClient.ParameterToString(filterType, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range id { - queryParams["id"] = value - } - } else { - queryParams["id"] = a.Configuration.APIClient.ParameterToString(id, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Campaigndivisionviewlisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOutboundContactlist invokes GET /api/v2/outbound/contactlists/{contactListId} -// -// Get a dialer contact list. -// -// -func (a OutboundApi) GetOutboundContactlist(contactListId string, includeImportStatus bool, includeSize bool) (*Contactlist, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/contactlists/{contactListId}" - path = strings.Replace(path, "{contactListId}", fmt.Sprintf("%v", contactListId), -1) - defaultReturn := new(Contactlist) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'contactListId' is set - if &contactListId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'contactListId' when calling OutboundApi->GetOutboundContactlist") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(includeImportStatus).(string); ok { - if str != "" { - queryParams["includeImportStatus"] = a.Configuration.APIClient.ParameterToString(includeImportStatus, collectionFormat) - } - } else { - queryParams["includeImportStatus"] = a.Configuration.APIClient.ParameterToString(includeImportStatus, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(includeSize).(string); ok { - if str != "" { - queryParams["includeSize"] = a.Configuration.APIClient.ParameterToString(includeSize, collectionFormat) - } - } else { - queryParams["includeSize"] = a.Configuration.APIClient.ParameterToString(includeSize, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Contactlist - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOutboundContactlistContact invokes GET /api/v2/outbound/contactlists/{contactListId}/contacts/{contactId} -// -// Get a contact. -// -// -func (a OutboundApi) GetOutboundContactlistContact(contactListId string, contactId string) (*Dialercontact, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/contactlists/{contactListId}/contacts/{contactId}" - path = strings.Replace(path, "{contactListId}", fmt.Sprintf("%v", contactListId), -1) - path = strings.Replace(path, "{contactId}", fmt.Sprintf("%v", contactId), -1) - defaultReturn := new(Dialercontact) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'contactListId' is set - if &contactListId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'contactListId' when calling OutboundApi->GetOutboundContactlistContact") - } - // verify the required parameter 'contactId' is set - if &contactId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'contactId' when calling OutboundApi->GetOutboundContactlistContact") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Dialercontact - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOutboundContactlistExport invokes GET /api/v2/outbound/contactlists/{contactListId}/export -// -// Get the URI of a contact list export. -// -// -func (a OutboundApi) GetOutboundContactlistExport(contactListId string, download string) (*Exporturi, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/contactlists/{contactListId}/export" - path = strings.Replace(path, "{contactListId}", fmt.Sprintf("%v", contactListId), -1) - defaultReturn := new(Exporturi) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'contactListId' is set - if &contactListId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'contactListId' when calling OutboundApi->GetOutboundContactlistExport") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(download).(string); ok { - if str != "" { - queryParams["download"] = a.Configuration.APIClient.ParameterToString(download, collectionFormat) - } - } else { - queryParams["download"] = a.Configuration.APIClient.ParameterToString(download, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Exporturi - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOutboundContactlistImportstatus invokes GET /api/v2/outbound/contactlists/{contactListId}/importstatus -// -// Get dialer contactList import status. -// -// -func (a OutboundApi) GetOutboundContactlistImportstatus(contactListId string) (*Importstatus, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/contactlists/{contactListId}/importstatus" - path = strings.Replace(path, "{contactListId}", fmt.Sprintf("%v", contactListId), -1) - defaultReturn := new(Importstatus) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'contactListId' is set - if &contactListId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'contactListId' when calling OutboundApi->GetOutboundContactlistImportstatus") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Importstatus - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOutboundContactlistTimezonemappingpreview invokes GET /api/v2/outbound/contactlists/{contactListId}/timezonemappingpreview -// -// Preview the result of applying Automatic Time Zone Mapping to a contact list -// -// -func (a OutboundApi) GetOutboundContactlistTimezonemappingpreview(contactListId string) (*Timezonemappingpreview, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/contactlists/{contactListId}/timezonemappingpreview" - path = strings.Replace(path, "{contactListId}", fmt.Sprintf("%v", contactListId), -1) - defaultReturn := new(Timezonemappingpreview) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'contactListId' is set - if &contactListId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'contactListId' when calling OutboundApi->GetOutboundContactlistTimezonemappingpreview") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Timezonemappingpreview - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOutboundContactlistfilter invokes GET /api/v2/outbound/contactlistfilters/{contactListFilterId} -// -// Get Contact list filter -// -// -func (a OutboundApi) GetOutboundContactlistfilter(contactListFilterId string) (*Contactlistfilter, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/contactlistfilters/{contactListFilterId}" - path = strings.Replace(path, "{contactListFilterId}", fmt.Sprintf("%v", contactListFilterId), -1) - defaultReturn := new(Contactlistfilter) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'contactListFilterId' is set - if &contactListFilterId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'contactListFilterId' when calling OutboundApi->GetOutboundContactlistfilter") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Contactlistfilter - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOutboundContactlistfilters invokes GET /api/v2/outbound/contactlistfilters -// -// Query Contact list filters -// -// -func (a OutboundApi) GetOutboundContactlistfilters(pageSize int, pageNumber int, allowEmptyResult bool, filterType string, name string, sortBy string, sortOrder string, contactListId string) (*Contactlistfilterentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/contactlistfilters" - defaultReturn := new(Contactlistfilterentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(allowEmptyResult).(string); ok { - if str != "" { - queryParams["allowEmptyResult"] = a.Configuration.APIClient.ParameterToString(allowEmptyResult, collectionFormat) - } - } else { - queryParams["allowEmptyResult"] = a.Configuration.APIClient.ParameterToString(allowEmptyResult, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(filterType).(string); ok { - if str != "" { - queryParams["filterType"] = a.Configuration.APIClient.ParameterToString(filterType, collectionFormat) - } - } else { - queryParams["filterType"] = a.Configuration.APIClient.ParameterToString(filterType, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(contactListId).(string); ok { - if str != "" { - queryParams["contactListId"] = a.Configuration.APIClient.ParameterToString(contactListId, collectionFormat) - } - } else { - queryParams["contactListId"] = a.Configuration.APIClient.ParameterToString(contactListId, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Contactlistfilterentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOutboundContactlists invokes GET /api/v2/outbound/contactlists -// -// Query a list of contact lists. -// -// -func (a OutboundApi) GetOutboundContactlists(includeImportStatus bool, includeSize bool, pageSize int, pageNumber int, allowEmptyResult bool, filterType string, name string, id []string, divisionId []string, sortBy string, sortOrder string) (*Contactlistentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/contactlists" - defaultReturn := new(Contactlistentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(includeImportStatus).(string); ok { - if str != "" { - queryParams["includeImportStatus"] = a.Configuration.APIClient.ParameterToString(includeImportStatus, collectionFormat) - } - } else { - queryParams["includeImportStatus"] = a.Configuration.APIClient.ParameterToString(includeImportStatus, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(includeSize).(string); ok { - if str != "" { - queryParams["includeSize"] = a.Configuration.APIClient.ParameterToString(includeSize, collectionFormat) - } - } else { - queryParams["includeSize"] = a.Configuration.APIClient.ParameterToString(includeSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(allowEmptyResult).(string); ok { - if str != "" { - queryParams["allowEmptyResult"] = a.Configuration.APIClient.ParameterToString(allowEmptyResult, collectionFormat) - } - } else { - queryParams["allowEmptyResult"] = a.Configuration.APIClient.ParameterToString(allowEmptyResult, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(filterType).(string); ok { - if str != "" { - queryParams["filterType"] = a.Configuration.APIClient.ParameterToString(filterType, collectionFormat) - } - } else { - queryParams["filterType"] = a.Configuration.APIClient.ParameterToString(filterType, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range id { - queryParams["id"] = value - } - } else { - queryParams["id"] = a.Configuration.APIClient.ParameterToString(id, collectionFormat) - } - - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range divisionId { - queryParams["divisionId"] = value - } - } else { - queryParams["divisionId"] = a.Configuration.APIClient.ParameterToString(divisionId, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Contactlistentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOutboundContactlistsDivisionview invokes GET /api/v2/outbound/contactlists/divisionviews/{contactListId} -// -// Get a basic ContactList information object -// -// This returns a simplified version of a ContactList, consisting of the name, division, column names, phone columns, import status, and size. -func (a OutboundApi) GetOutboundContactlistsDivisionview(contactListId string, includeImportStatus bool, includeSize bool) (*Contactlistdivisionview, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/contactlists/divisionviews/{contactListId}" - path = strings.Replace(path, "{contactListId}", fmt.Sprintf("%v", contactListId), -1) - defaultReturn := new(Contactlistdivisionview) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'contactListId' is set - if &contactListId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'contactListId' when calling OutboundApi->GetOutboundContactlistsDivisionview") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(includeImportStatus).(string); ok { - if str != "" { - queryParams["includeImportStatus"] = a.Configuration.APIClient.ParameterToString(includeImportStatus, collectionFormat) - } - } else { - queryParams["includeImportStatus"] = a.Configuration.APIClient.ParameterToString(includeImportStatus, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(includeSize).(string); ok { - if str != "" { - queryParams["includeSize"] = a.Configuration.APIClient.ParameterToString(includeSize, collectionFormat) - } - } else { - queryParams["includeSize"] = a.Configuration.APIClient.ParameterToString(includeSize, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Contactlistdivisionview - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOutboundContactlistsDivisionviews invokes GET /api/v2/outbound/contactlists/divisionviews -// -// Query a list of simplified contact list objects. -// -// This return a simplified version of contact lists, consisting of the name, division, column names, phone columns, import status, and size. -func (a OutboundApi) GetOutboundContactlistsDivisionviews(includeImportStatus bool, includeSize bool, pageSize int, pageNumber int, filterType string, name string, id []string, sortBy string, sortOrder string) (*Contactlistdivisionviewlisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/contactlists/divisionviews" - defaultReturn := new(Contactlistdivisionviewlisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(includeImportStatus).(string); ok { - if str != "" { - queryParams["includeImportStatus"] = a.Configuration.APIClient.ParameterToString(includeImportStatus, collectionFormat) - } - } else { - queryParams["includeImportStatus"] = a.Configuration.APIClient.ParameterToString(includeImportStatus, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(includeSize).(string); ok { - if str != "" { - queryParams["includeSize"] = a.Configuration.APIClient.ParameterToString(includeSize, collectionFormat) - } - } else { - queryParams["includeSize"] = a.Configuration.APIClient.ParameterToString(includeSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(filterType).(string); ok { - if str != "" { - queryParams["filterType"] = a.Configuration.APIClient.ParameterToString(filterType, collectionFormat) - } - } else { - queryParams["filterType"] = a.Configuration.APIClient.ParameterToString(filterType, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range id { - queryParams["id"] = value - } - } else { - queryParams["id"] = a.Configuration.APIClient.ParameterToString(id, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Contactlistdivisionviewlisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOutboundDnclist invokes GET /api/v2/outbound/dnclists/{dncListId} -// -// Get dialer DNC list -// -// -func (a OutboundApi) GetOutboundDnclist(dncListId string, includeImportStatus bool, includeSize bool) (*Dnclist, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/dnclists/{dncListId}" - path = strings.Replace(path, "{dncListId}", fmt.Sprintf("%v", dncListId), -1) - defaultReturn := new(Dnclist) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'dncListId' is set - if &dncListId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'dncListId' when calling OutboundApi->GetOutboundDnclist") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(includeImportStatus).(string); ok { - if str != "" { - queryParams["includeImportStatus"] = a.Configuration.APIClient.ParameterToString(includeImportStatus, collectionFormat) - } - } else { - queryParams["includeImportStatus"] = a.Configuration.APIClient.ParameterToString(includeImportStatus, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(includeSize).(string); ok { - if str != "" { - queryParams["includeSize"] = a.Configuration.APIClient.ParameterToString(includeSize, collectionFormat) - } - } else { - queryParams["includeSize"] = a.Configuration.APIClient.ParameterToString(includeSize, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Dnclist - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOutboundDnclistExport invokes GET /api/v2/outbound/dnclists/{dncListId}/export -// -// Get the URI of a DNC list export. -// -// -func (a OutboundApi) GetOutboundDnclistExport(dncListId string, download string) (*Exporturi, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/dnclists/{dncListId}/export" - path = strings.Replace(path, "{dncListId}", fmt.Sprintf("%v", dncListId), -1) - defaultReturn := new(Exporturi) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'dncListId' is set - if &dncListId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'dncListId' when calling OutboundApi->GetOutboundDnclistExport") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(download).(string); ok { - if str != "" { - queryParams["download"] = a.Configuration.APIClient.ParameterToString(download, collectionFormat) - } - } else { - queryParams["download"] = a.Configuration.APIClient.ParameterToString(download, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Exporturi - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOutboundDnclistImportstatus invokes GET /api/v2/outbound/dnclists/{dncListId}/importstatus -// -// Get dialer dncList import status. -// -// -func (a OutboundApi) GetOutboundDnclistImportstatus(dncListId string) (*Importstatus, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/dnclists/{dncListId}/importstatus" - path = strings.Replace(path, "{dncListId}", fmt.Sprintf("%v", dncListId), -1) - defaultReturn := new(Importstatus) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'dncListId' is set - if &dncListId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'dncListId' when calling OutboundApi->GetOutboundDnclistImportstatus") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Importstatus - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOutboundDnclists invokes GET /api/v2/outbound/dnclists -// -// Query dialer DNC lists -// -// -func (a OutboundApi) GetOutboundDnclists(includeImportStatus bool, includeSize bool, pageSize int, pageNumber int, allowEmptyResult bool, filterType string, name string, dncSourceType string, divisionId []string, sortBy string, sortOrder string) (*Dnclistentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/dnclists" - defaultReturn := new(Dnclistentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(includeImportStatus).(string); ok { - if str != "" { - queryParams["includeImportStatus"] = a.Configuration.APIClient.ParameterToString(includeImportStatus, collectionFormat) - } - } else { - queryParams["includeImportStatus"] = a.Configuration.APIClient.ParameterToString(includeImportStatus, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(includeSize).(string); ok { - if str != "" { - queryParams["includeSize"] = a.Configuration.APIClient.ParameterToString(includeSize, collectionFormat) - } - } else { - queryParams["includeSize"] = a.Configuration.APIClient.ParameterToString(includeSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(allowEmptyResult).(string); ok { - if str != "" { - queryParams["allowEmptyResult"] = a.Configuration.APIClient.ParameterToString(allowEmptyResult, collectionFormat) - } - } else { - queryParams["allowEmptyResult"] = a.Configuration.APIClient.ParameterToString(allowEmptyResult, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(filterType).(string); ok { - if str != "" { - queryParams["filterType"] = a.Configuration.APIClient.ParameterToString(filterType, collectionFormat) - } - } else { - queryParams["filterType"] = a.Configuration.APIClient.ParameterToString(filterType, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(dncSourceType).(string); ok { - if str != "" { - queryParams["dncSourceType"] = a.Configuration.APIClient.ParameterToString(dncSourceType, collectionFormat) - } - } else { - queryParams["dncSourceType"] = a.Configuration.APIClient.ParameterToString(dncSourceType, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range divisionId { - queryParams["divisionId"] = value - } - } else { - queryParams["divisionId"] = a.Configuration.APIClient.ParameterToString(divisionId, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Dnclistentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOutboundDnclistsDivisionview invokes GET /api/v2/outbound/dnclists/divisionviews/{dncListId} -// -// Get a basic DncList information object -// -// This returns a simplified version of a DncList, consisting of the name, division, import status, and size. -func (a OutboundApi) GetOutboundDnclistsDivisionview(dncListId string, includeImportStatus bool, includeSize bool) (*Dnclistdivisionview, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/dnclists/divisionviews/{dncListId}" - path = strings.Replace(path, "{dncListId}", fmt.Sprintf("%v", dncListId), -1) - defaultReturn := new(Dnclistdivisionview) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'dncListId' is set - if &dncListId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'dncListId' when calling OutboundApi->GetOutboundDnclistsDivisionview") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(includeImportStatus).(string); ok { - if str != "" { - queryParams["includeImportStatus"] = a.Configuration.APIClient.ParameterToString(includeImportStatus, collectionFormat) - } - } else { - queryParams["includeImportStatus"] = a.Configuration.APIClient.ParameterToString(includeImportStatus, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(includeSize).(string); ok { - if str != "" { - queryParams["includeSize"] = a.Configuration.APIClient.ParameterToString(includeSize, collectionFormat) - } - } else { - queryParams["includeSize"] = a.Configuration.APIClient.ParameterToString(includeSize, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Dnclistdivisionview - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOutboundDnclistsDivisionviews invokes GET /api/v2/outbound/dnclists/divisionviews -// -// Query a list of simplified dnc list objects. -// -// This return a simplified version of dnc lists, consisting of the name, division, import status, and size. -func (a OutboundApi) GetOutboundDnclistsDivisionviews(includeImportStatus bool, includeSize bool, pageSize int, pageNumber int, filterType string, name string, id []string, sortBy string, sortOrder string) (*Dnclistdivisionviewlisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/dnclists/divisionviews" - defaultReturn := new(Dnclistdivisionviewlisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(includeImportStatus).(string); ok { - if str != "" { - queryParams["includeImportStatus"] = a.Configuration.APIClient.ParameterToString(includeImportStatus, collectionFormat) - } - } else { - queryParams["includeImportStatus"] = a.Configuration.APIClient.ParameterToString(includeImportStatus, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(includeSize).(string); ok { - if str != "" { - queryParams["includeSize"] = a.Configuration.APIClient.ParameterToString(includeSize, collectionFormat) - } - } else { - queryParams["includeSize"] = a.Configuration.APIClient.ParameterToString(includeSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(filterType).(string); ok { - if str != "" { - queryParams["filterType"] = a.Configuration.APIClient.ParameterToString(filterType, collectionFormat) - } - } else { - queryParams["filterType"] = a.Configuration.APIClient.ParameterToString(filterType, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range id { - queryParams["id"] = value - } - } else { - queryParams["id"] = a.Configuration.APIClient.ParameterToString(id, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Dnclistdivisionviewlisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOutboundEvent invokes GET /api/v2/outbound/events/{eventId} -// -// Get Dialer Event -// -// -func (a OutboundApi) GetOutboundEvent(eventId string) (*Eventlog, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/events/{eventId}" - path = strings.Replace(path, "{eventId}", fmt.Sprintf("%v", eventId), -1) - defaultReturn := new(Eventlog) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'eventId' is set - if &eventId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'eventId' when calling OutboundApi->GetOutboundEvent") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Eventlog - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOutboundEvents invokes GET /api/v2/outbound/events -// -// Query Event Logs -// -// -func (a OutboundApi) GetOutboundEvents(pageSize int, pageNumber int, filterType string, category string, level string, sortBy string, sortOrder string) (*Dialerevententitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/events" - defaultReturn := new(Dialerevententitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(filterType).(string); ok { - if str != "" { - queryParams["filterType"] = a.Configuration.APIClient.ParameterToString(filterType, collectionFormat) - } - } else { - queryParams["filterType"] = a.Configuration.APIClient.ParameterToString(filterType, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(category).(string); ok { - if str != "" { - queryParams["category"] = a.Configuration.APIClient.ParameterToString(category, collectionFormat) - } - } else { - queryParams["category"] = a.Configuration.APIClient.ParameterToString(category, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(level).(string); ok { - if str != "" { - queryParams["level"] = a.Configuration.APIClient.ParameterToString(level, collectionFormat) - } - } else { - queryParams["level"] = a.Configuration.APIClient.ParameterToString(level, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Dialerevententitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOutboundMessagingcampaign invokes GET /api/v2/outbound/messagingcampaigns/{messagingCampaignId} -// -// Get an Outbound Messaging Campaign -// -// -func (a OutboundApi) GetOutboundMessagingcampaign(messagingCampaignId string) (*Messagingcampaign, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/messagingcampaigns/{messagingCampaignId}" - path = strings.Replace(path, "{messagingCampaignId}", fmt.Sprintf("%v", messagingCampaignId), -1) - defaultReturn := new(Messagingcampaign) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'messagingCampaignId' is set - if &messagingCampaignId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'messagingCampaignId' when calling OutboundApi->GetOutboundMessagingcampaign") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Messagingcampaign - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOutboundMessagingcampaignProgress invokes GET /api/v2/outbound/messagingcampaigns/{messagingCampaignId}/progress -// -// Get messaging campaign's progress -// -// -func (a OutboundApi) GetOutboundMessagingcampaignProgress(messagingCampaignId string) (*Campaignprogress, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/progress" - path = strings.Replace(path, "{messagingCampaignId}", fmt.Sprintf("%v", messagingCampaignId), -1) - defaultReturn := new(Campaignprogress) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'messagingCampaignId' is set - if &messagingCampaignId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'messagingCampaignId' when calling OutboundApi->GetOutboundMessagingcampaignProgress") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Campaignprogress - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOutboundMessagingcampaigns invokes GET /api/v2/outbound/messagingcampaigns -// -// Query a list of Messaging Campaigns -// -// -func (a OutboundApi) GetOutboundMessagingcampaigns(pageSize int, pageNumber int, sortBy string, sortOrder string, name string, contactListId string, divisionId []string, varType string, senderSmsPhoneNumber string, id []string) (*Messagingcampaignentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/messagingcampaigns" - defaultReturn := new(Messagingcampaignentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(contactListId).(string); ok { - if str != "" { - queryParams["contactListId"] = a.Configuration.APIClient.ParameterToString(contactListId, collectionFormat) - } - } else { - queryParams["contactListId"] = a.Configuration.APIClient.ParameterToString(contactListId, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range divisionId { - queryParams["divisionId"] = value - } - } else { - queryParams["divisionId"] = a.Configuration.APIClient.ParameterToString(divisionId, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(varType).(string); ok { - if str != "" { - queryParams["varType"] = a.Configuration.APIClient.ParameterToString(varType, collectionFormat) - } - } else { - queryParams["varType"] = a.Configuration.APIClient.ParameterToString(varType, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(senderSmsPhoneNumber).(string); ok { - if str != "" { - queryParams["senderSmsPhoneNumber"] = a.Configuration.APIClient.ParameterToString(senderSmsPhoneNumber, collectionFormat) - } - } else { - queryParams["senderSmsPhoneNumber"] = a.Configuration.APIClient.ParameterToString(senderSmsPhoneNumber, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range id { - queryParams["id"] = value - } - } else { - queryParams["id"] = a.Configuration.APIClient.ParameterToString(id, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Messagingcampaignentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOutboundMessagingcampaignsDivisionview invokes GET /api/v2/outbound/messagingcampaigns/divisionviews/{messagingCampaignId} -// -// Get a basic Messaging Campaign information object -// -// This returns a simplified version of a Messaging Campaign, consisting of id, name, and division. -func (a OutboundApi) GetOutboundMessagingcampaignsDivisionview(messagingCampaignId string) (*Messagingcampaigndivisionview, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/messagingcampaigns/divisionviews/{messagingCampaignId}" - path = strings.Replace(path, "{messagingCampaignId}", fmt.Sprintf("%v", messagingCampaignId), -1) - defaultReturn := new(Messagingcampaigndivisionview) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'messagingCampaignId' is set - if &messagingCampaignId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'messagingCampaignId' when calling OutboundApi->GetOutboundMessagingcampaignsDivisionview") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Messagingcampaigndivisionview - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOutboundMessagingcampaignsDivisionviews invokes GET /api/v2/outbound/messagingcampaigns/divisionviews -// -// Query a list of basic Messaging Campaign information objects -// -// This returns a listing of simplified Messaging Campaigns, each consisting of id, name, and division. -func (a OutboundApi) GetOutboundMessagingcampaignsDivisionviews(pageSize int, pageNumber int, sortOrder string, name string, id []string, senderSmsPhoneNumber string) (*Messagingcampaigndivisionviewentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/messagingcampaigns/divisionviews" - defaultReturn := new(Messagingcampaigndivisionviewentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range id { - queryParams["id"] = value - } - } else { - queryParams["id"] = a.Configuration.APIClient.ParameterToString(id, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(senderSmsPhoneNumber).(string); ok { - if str != "" { - queryParams["senderSmsPhoneNumber"] = a.Configuration.APIClient.ParameterToString(senderSmsPhoneNumber, collectionFormat) - } - } else { - queryParams["senderSmsPhoneNumber"] = a.Configuration.APIClient.ParameterToString(senderSmsPhoneNumber, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Messagingcampaigndivisionviewentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOutboundRuleset invokes GET /api/v2/outbound/rulesets/{ruleSetId} -// -// Get a Rule Set by ID. -// -// -func (a OutboundApi) GetOutboundRuleset(ruleSetId string) (*Ruleset, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/rulesets/{ruleSetId}" - path = strings.Replace(path, "{ruleSetId}", fmt.Sprintf("%v", ruleSetId), -1) - defaultReturn := new(Ruleset) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'ruleSetId' is set - if &ruleSetId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'ruleSetId' when calling OutboundApi->GetOutboundRuleset") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Ruleset - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOutboundRulesets invokes GET /api/v2/outbound/rulesets -// -// Query a list of Rule Sets. -// -// -func (a OutboundApi) GetOutboundRulesets(pageSize int, pageNumber int, allowEmptyResult bool, filterType string, name string, sortBy string, sortOrder string) (*Rulesetentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/rulesets" - defaultReturn := new(Rulesetentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(allowEmptyResult).(string); ok { - if str != "" { - queryParams["allowEmptyResult"] = a.Configuration.APIClient.ParameterToString(allowEmptyResult, collectionFormat) - } - } else { - queryParams["allowEmptyResult"] = a.Configuration.APIClient.ParameterToString(allowEmptyResult, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(filterType).(string); ok { - if str != "" { - queryParams["filterType"] = a.Configuration.APIClient.ParameterToString(filterType, collectionFormat) - } - } else { - queryParams["filterType"] = a.Configuration.APIClient.ParameterToString(filterType, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Rulesetentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOutboundSchedulesCampaign invokes GET /api/v2/outbound/schedules/campaigns/{campaignId} -// -// Get a dialer campaign schedule. -// -// -func (a OutboundApi) GetOutboundSchedulesCampaign(campaignId string) (*Campaignschedule, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/schedules/campaigns/{campaignId}" - path = strings.Replace(path, "{campaignId}", fmt.Sprintf("%v", campaignId), -1) - defaultReturn := new(Campaignschedule) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'campaignId' is set - if &campaignId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'campaignId' when calling OutboundApi->GetOutboundSchedulesCampaign") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Campaignschedule - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOutboundSchedulesCampaigns invokes GET /api/v2/outbound/schedules/campaigns -// -// Query for a list of dialer campaign schedules. -// -// -func (a OutboundApi) GetOutboundSchedulesCampaigns() ([]Campaignschedule, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/schedules/campaigns" - defaultReturn := make([]Campaignschedule, 0) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload []Campaignschedule - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOutboundSchedulesSequence invokes GET /api/v2/outbound/schedules/sequences/{sequenceId} -// -// Get a dialer sequence schedule. -// -// -func (a OutboundApi) GetOutboundSchedulesSequence(sequenceId string) (*Sequenceschedule, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/schedules/sequences/{sequenceId}" - path = strings.Replace(path, "{sequenceId}", fmt.Sprintf("%v", sequenceId), -1) - defaultReturn := new(Sequenceschedule) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'sequenceId' is set - if &sequenceId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'sequenceId' when calling OutboundApi->GetOutboundSchedulesSequence") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Sequenceschedule - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOutboundSchedulesSequences invokes GET /api/v2/outbound/schedules/sequences -// -// Query for a list of dialer sequence schedules. -// -// -func (a OutboundApi) GetOutboundSchedulesSequences() ([]Sequenceschedule, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/schedules/sequences" - defaultReturn := make([]Sequenceschedule, 0) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload []Sequenceschedule - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOutboundSequence invokes GET /api/v2/outbound/sequences/{sequenceId} -// -// Get a dialer campaign sequence. -// -// -func (a OutboundApi) GetOutboundSequence(sequenceId string) (*Campaignsequence, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/sequences/{sequenceId}" - path = strings.Replace(path, "{sequenceId}", fmt.Sprintf("%v", sequenceId), -1) - defaultReturn := new(Campaignsequence) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'sequenceId' is set - if &sequenceId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'sequenceId' when calling OutboundApi->GetOutboundSequence") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Campaignsequence - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOutboundSequences invokes GET /api/v2/outbound/sequences -// -// Query a list of dialer campaign sequences. -// -// -func (a OutboundApi) GetOutboundSequences(pageSize int, pageNumber int, allowEmptyResult bool, filterType string, name string, sortBy string, sortOrder string) (*Campaignsequenceentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/sequences" - defaultReturn := new(Campaignsequenceentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(allowEmptyResult).(string); ok { - if str != "" { - queryParams["allowEmptyResult"] = a.Configuration.APIClient.ParameterToString(allowEmptyResult, collectionFormat) - } - } else { - queryParams["allowEmptyResult"] = a.Configuration.APIClient.ParameterToString(allowEmptyResult, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(filterType).(string); ok { - if str != "" { - queryParams["filterType"] = a.Configuration.APIClient.ParameterToString(filterType, collectionFormat) - } - } else { - queryParams["filterType"] = a.Configuration.APIClient.ParameterToString(filterType, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Campaignsequenceentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOutboundSettings invokes GET /api/v2/outbound/settings -// -// Get the outbound settings for this organization -// -// -func (a OutboundApi) GetOutboundSettings() (*Outboundsettings, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/settings" - defaultReturn := new(Outboundsettings) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Outboundsettings - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOutboundWrapupcodemappings invokes GET /api/v2/outbound/wrapupcodemappings -// -// Get the Dialer wrap up code mapping. -// -// -func (a OutboundApi) GetOutboundWrapupcodemappings() (*Wrapupcodemapping, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/wrapupcodemappings" - defaultReturn := new(Wrapupcodemapping) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Wrapupcodemapping - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchOutboundSettings invokes PATCH /api/v2/outbound/settings -// -// Update the outbound settings for this organization -// -// -func (a OutboundApi) PatchOutboundSettings(body Outboundsettings) (*APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/settings" - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return nil, errors.New("Missing required parameter 'body' when calling OutboundApi->PatchOutboundSettings") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// PostOutboundAttemptlimits invokes POST /api/v2/outbound/attemptlimits -// -// Create attempt limits -// -// -func (a OutboundApi) PostOutboundAttemptlimits(body Attemptlimits) (*Attemptlimits, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/attemptlimits" - defaultReturn := new(Attemptlimits) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling OutboundApi->PostOutboundAttemptlimits") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Attemptlimits - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostOutboundAudits invokes POST /api/v2/outbound/audits -// -// Retrieves audits for dialer. -// -// -func (a OutboundApi) PostOutboundAudits(body Dialerauditrequest, pageSize int, pageNumber int, sortBy string, sortOrder string, facetsOnly bool) (*Auditsearchresult, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/audits" - defaultReturn := new(Auditsearchresult) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling OutboundApi->PostOutboundAudits") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(facetsOnly).(string); ok { - if str != "" { - queryParams["facetsOnly"] = a.Configuration.APIClient.ParameterToString(facetsOnly, collectionFormat) - } - } else { - queryParams["facetsOnly"] = a.Configuration.APIClient.ParameterToString(facetsOnly, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Auditsearchresult - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostOutboundCallabletimesets invokes POST /api/v2/outbound/callabletimesets -// -// Create callable time set -// -// -func (a OutboundApi) PostOutboundCallabletimesets(body Callabletimeset) (*Callabletimeset, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/callabletimesets" - defaultReturn := new(Callabletimeset) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling OutboundApi->PostOutboundCallabletimesets") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Callabletimeset - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostOutboundCallanalysisresponsesets invokes POST /api/v2/outbound/callanalysisresponsesets -// -// Create a dialer call analysis response set. -// -// -func (a OutboundApi) PostOutboundCallanalysisresponsesets(body Responseset) (*Responseset, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/callanalysisresponsesets" - defaultReturn := new(Responseset) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling OutboundApi->PostOutboundCallanalysisresponsesets") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Responseset - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostOutboundCampaignCallbackSchedule invokes POST /api/v2/outbound/campaigns/{campaignId}/callback/schedule -// -// Schedule a Callback for a Dialer Campaign (Deprecated) -// -// This endpoint is deprecated and may have unexpected results. Please use \"/conversations/{conversationId}/participants/{participantId}/callbacks instead.\" -func (a OutboundApi) PostOutboundCampaignCallbackSchedule(campaignId string, body Contactcallbackrequest) (*Contactcallbackrequest, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/campaigns/{campaignId}/callback/schedule" - path = strings.Replace(path, "{campaignId}", fmt.Sprintf("%v", campaignId), -1) - defaultReturn := new(Contactcallbackrequest) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'campaignId' is set - if &campaignId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'campaignId' when calling OutboundApi->PostOutboundCampaignCallbackSchedule") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling OutboundApi->PostOutboundCampaignCallbackSchedule") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Contactcallbackrequest - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostOutboundCampaignrules invokes POST /api/v2/outbound/campaignrules -// -// Create Campaign Rule -// -// -func (a OutboundApi) PostOutboundCampaignrules(body Campaignrule) (*Campaignrule, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/campaignrules" - defaultReturn := new(Campaignrule) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling OutboundApi->PostOutboundCampaignrules") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Campaignrule - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostOutboundCampaigns invokes POST /api/v2/outbound/campaigns -// -// Create a campaign. -// -// -func (a OutboundApi) PostOutboundCampaigns(body Campaign) (*Campaign, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/campaigns" - defaultReturn := new(Campaign) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling OutboundApi->PostOutboundCampaigns") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Campaign - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostOutboundCampaignsProgress invokes POST /api/v2/outbound/campaigns/progress -// -// Get progress for a list of campaigns -// -// -func (a OutboundApi) PostOutboundCampaignsProgress(body []string) ([]Campaignprogress, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/campaigns/progress" - defaultReturn := make([]Campaignprogress, 0) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // true - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling OutboundApi->PostOutboundCampaignsProgress") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload []Campaignprogress - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostOutboundContactlistClear invokes POST /api/v2/outbound/contactlists/{contactListId}/clear -// -// Deletes all contacts out of a list. All outstanding recalls or rule-scheduled callbacks for non-preview campaigns configured with the contactlist will be cancelled. -// -// -func (a OutboundApi) PostOutboundContactlistClear(contactListId string) (*APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/contactlists/{contactListId}/clear" - path = strings.Replace(path, "{contactListId}", fmt.Sprintf("%v", contactListId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'contactListId' is set - if &contactListId == nil { - // - return nil, errors.New("Missing required parameter 'contactListId' when calling OutboundApi->PostOutboundContactlistClear") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// PostOutboundContactlistContacts invokes POST /api/v2/outbound/contactlists/{contactListId}/contacts -// -// Add contacts to a contact list. -// -// -func (a OutboundApi) PostOutboundContactlistContacts(contactListId string, body []Writabledialercontact, priority bool, clearSystemData bool, doNotQueue bool) ([]Dialercontact, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/contactlists/{contactListId}/contacts" - path = strings.Replace(path, "{contactListId}", fmt.Sprintf("%v", contactListId), -1) - defaultReturn := make([]Dialercontact, 0) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'contactListId' is set - if &contactListId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'contactListId' when calling OutboundApi->PostOutboundContactlistContacts") - } - // verify the required parameter 'body' is set - if &body == nil { - // true - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling OutboundApi->PostOutboundContactlistContacts") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(priority).(string); ok { - if str != "" { - queryParams["priority"] = a.Configuration.APIClient.ParameterToString(priority, collectionFormat) - } - } else { - queryParams["priority"] = a.Configuration.APIClient.ParameterToString(priority, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(clearSystemData).(string); ok { - if str != "" { - queryParams["clearSystemData"] = a.Configuration.APIClient.ParameterToString(clearSystemData, collectionFormat) - } - } else { - queryParams["clearSystemData"] = a.Configuration.APIClient.ParameterToString(clearSystemData, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(doNotQueue).(string); ok { - if str != "" { - queryParams["doNotQueue"] = a.Configuration.APIClient.ParameterToString(doNotQueue, collectionFormat) - } - } else { - queryParams["doNotQueue"] = a.Configuration.APIClient.ParameterToString(doNotQueue, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload []Dialercontact - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostOutboundContactlistContactsBulk invokes POST /api/v2/outbound/contactlists/{contactListId}/contacts/bulk -// -// Get contacts from a contact list. -// -// -func (a OutboundApi) PostOutboundContactlistContactsBulk(contactListId string, body []string) ([]Dialercontact, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/contactlists/{contactListId}/contacts/bulk" - path = strings.Replace(path, "{contactListId}", fmt.Sprintf("%v", contactListId), -1) - defaultReturn := make([]Dialercontact, 0) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'contactListId' is set - if &contactListId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'contactListId' when calling OutboundApi->PostOutboundContactlistContactsBulk") - } - // verify the required parameter 'body' is set - if &body == nil { - // true - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling OutboundApi->PostOutboundContactlistContactsBulk") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload []Dialercontact - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostOutboundContactlistExport invokes POST /api/v2/outbound/contactlists/{contactListId}/export -// -// Initiate the export of a contact list. -// -// Returns 200 if received OK. -func (a OutboundApi) PostOutboundContactlistExport(contactListId string) (*Domainentityref, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/contactlists/{contactListId}/export" - path = strings.Replace(path, "{contactListId}", fmt.Sprintf("%v", contactListId), -1) - defaultReturn := new(Domainentityref) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'contactListId' is set - if &contactListId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'contactListId' when calling OutboundApi->PostOutboundContactlistExport") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Domainentityref - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostOutboundContactlistfilters invokes POST /api/v2/outbound/contactlistfilters -// -// Create Contact List Filter -// -// -func (a OutboundApi) PostOutboundContactlistfilters(body Contactlistfilter) (*Contactlistfilter, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/contactlistfilters" - defaultReturn := new(Contactlistfilter) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling OutboundApi->PostOutboundContactlistfilters") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Contactlistfilter - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostOutboundContactlistfiltersPreview invokes POST /api/v2/outbound/contactlistfilters/preview -// -// Get a preview of the output of a contact list filter -// -// -func (a OutboundApi) PostOutboundContactlistfiltersPreview(body Contactlistfilter) (*Filterpreviewresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/contactlistfilters/preview" - defaultReturn := new(Filterpreviewresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling OutboundApi->PostOutboundContactlistfiltersPreview") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Filterpreviewresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostOutboundContactlists invokes POST /api/v2/outbound/contactlists -// -// Create a contact List. -// -// -func (a OutboundApi) PostOutboundContactlists(body Contactlist) (*Contactlist, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/contactlists" - defaultReturn := new(Contactlist) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling OutboundApi->PostOutboundContactlists") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Contactlist - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostOutboundConversationDnc invokes POST /api/v2/outbound/conversations/{conversationId}/dnc -// -// Add phone numbers to a Dialer DNC list. -// -// -func (a OutboundApi) PostOutboundConversationDnc(conversationId string) (*APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/conversations/{conversationId}/dnc" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return nil, errors.New("Missing required parameter 'conversationId' when calling OutboundApi->PostOutboundConversationDnc") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// PostOutboundDnclistExport invokes POST /api/v2/outbound/dnclists/{dncListId}/export -// -// Initiate the export of a dnc list. -// -// Returns 200 if received OK. -func (a OutboundApi) PostOutboundDnclistExport(dncListId string) (*Domainentityref, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/dnclists/{dncListId}/export" - path = strings.Replace(path, "{dncListId}", fmt.Sprintf("%v", dncListId), -1) - defaultReturn := new(Domainentityref) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'dncListId' is set - if &dncListId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'dncListId' when calling OutboundApi->PostOutboundDnclistExport") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Domainentityref - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostOutboundDnclistPhonenumbers invokes POST /api/v2/outbound/dnclists/{dncListId}/phonenumbers -// -// Add phone numbers to a Dialer DNC list. -// -// Only Internal DNC lists may be appended to -func (a OutboundApi) PostOutboundDnclistPhonenumbers(dncListId string, body []string) (*APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/dnclists/{dncListId}/phonenumbers" - path = strings.Replace(path, "{dncListId}", fmt.Sprintf("%v", dncListId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'dncListId' is set - if &dncListId == nil { - // - return nil, errors.New("Missing required parameter 'dncListId' when calling OutboundApi->PostOutboundDnclistPhonenumbers") - } - // verify the required parameter 'body' is set - if &body == nil { - // true - return nil, errors.New("Missing required parameter 'body' when calling OutboundApi->PostOutboundDnclistPhonenumbers") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// PostOutboundDnclists invokes POST /api/v2/outbound/dnclists -// -// Create dialer DNC list -// -// -func (a OutboundApi) PostOutboundDnclists(body Dnclistcreate) (*Dnclist, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/dnclists" - defaultReturn := new(Dnclist) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling OutboundApi->PostOutboundDnclists") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Dnclist - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostOutboundMessagingcampaigns invokes POST /api/v2/outbound/messagingcampaigns -// -// Create a Messaging Campaign -// -// -func (a OutboundApi) PostOutboundMessagingcampaigns(body Messagingcampaign) (*Messagingcampaign, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/messagingcampaigns" - defaultReturn := new(Messagingcampaign) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling OutboundApi->PostOutboundMessagingcampaigns") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Messagingcampaign - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostOutboundMessagingcampaignsProgress invokes POST /api/v2/outbound/messagingcampaigns/progress -// -// Get progress for a list of messaging campaigns -// -// -func (a OutboundApi) PostOutboundMessagingcampaignsProgress(body []string) ([]Campaignprogress, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/messagingcampaigns/progress" - defaultReturn := make([]Campaignprogress, 0) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // true - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling OutboundApi->PostOutboundMessagingcampaignsProgress") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload []Campaignprogress - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostOutboundRulesets invokes POST /api/v2/outbound/rulesets -// -// Create a Dialer Call Analysis Response Set. -// -// -func (a OutboundApi) PostOutboundRulesets(body Ruleset) (*Ruleset, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/rulesets" - defaultReturn := new(Ruleset) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling OutboundApi->PostOutboundRulesets") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Ruleset - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostOutboundSequences invokes POST /api/v2/outbound/sequences -// -// Create a new campaign sequence. -// -// -func (a OutboundApi) PostOutboundSequences(body Campaignsequence) (*Campaignsequence, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/sequences" - defaultReturn := new(Campaignsequence) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling OutboundApi->PostOutboundSequences") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Campaignsequence - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutOutboundAttemptlimit invokes PUT /api/v2/outbound/attemptlimits/{attemptLimitsId} -// -// Update attempt limits -// -// -func (a OutboundApi) PutOutboundAttemptlimit(attemptLimitsId string, body Attemptlimits) (*Attemptlimits, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/attemptlimits/{attemptLimitsId}" - path = strings.Replace(path, "{attemptLimitsId}", fmt.Sprintf("%v", attemptLimitsId), -1) - defaultReturn := new(Attemptlimits) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'attemptLimitsId' is set - if &attemptLimitsId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'attemptLimitsId' when calling OutboundApi->PutOutboundAttemptlimit") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling OutboundApi->PutOutboundAttemptlimit") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Attemptlimits - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutOutboundCallabletimeset invokes PUT /api/v2/outbound/callabletimesets/{callableTimeSetId} -// -// Update callable time set -// -// -func (a OutboundApi) PutOutboundCallabletimeset(callableTimeSetId string, body Callabletimeset) (*Callabletimeset, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/callabletimesets/{callableTimeSetId}" - path = strings.Replace(path, "{callableTimeSetId}", fmt.Sprintf("%v", callableTimeSetId), -1) - defaultReturn := new(Callabletimeset) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'callableTimeSetId' is set - if &callableTimeSetId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'callableTimeSetId' when calling OutboundApi->PutOutboundCallabletimeset") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling OutboundApi->PutOutboundCallabletimeset") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Callabletimeset - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutOutboundCallanalysisresponseset invokes PUT /api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId} -// -// Update a dialer call analysis response set. -// -// -func (a OutboundApi) PutOutboundCallanalysisresponseset(callAnalysisSetId string, body Responseset) (*Responseset, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId}" - path = strings.Replace(path, "{callAnalysisSetId}", fmt.Sprintf("%v", callAnalysisSetId), -1) - defaultReturn := new(Responseset) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'callAnalysisSetId' is set - if &callAnalysisSetId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'callAnalysisSetId' when calling OutboundApi->PutOutboundCallanalysisresponseset") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling OutboundApi->PutOutboundCallanalysisresponseset") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Responseset - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutOutboundCampaign invokes PUT /api/v2/outbound/campaigns/{campaignId} -// -// Update a campaign. -// -// -func (a OutboundApi) PutOutboundCampaign(campaignId string, body Campaign) (*Campaign, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/campaigns/{campaignId}" - path = strings.Replace(path, "{campaignId}", fmt.Sprintf("%v", campaignId), -1) - defaultReturn := new(Campaign) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'campaignId' is set - if &campaignId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'campaignId' when calling OutboundApi->PutOutboundCampaign") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling OutboundApi->PutOutboundCampaign") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Campaign - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutOutboundCampaignAgent invokes PUT /api/v2/outbound/campaigns/{campaignId}/agents/{userId} -// -// Send notification that an agent's state changed -// -// New agent state. -func (a OutboundApi) PutOutboundCampaignAgent(campaignId string, userId string, body Agent) (*string, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/campaigns/{campaignId}/agents/{userId}" - path = strings.Replace(path, "{campaignId}", fmt.Sprintf("%v", campaignId), -1) - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(string) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'campaignId' is set - if &campaignId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'campaignId' when calling OutboundApi->PutOutboundCampaignAgent") - } - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling OutboundApi->PutOutboundCampaignAgent") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling OutboundApi->PutOutboundCampaignAgent") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *string - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutOutboundCampaignrule invokes PUT /api/v2/outbound/campaignrules/{campaignRuleId} -// -// Update Campaign Rule -// -// -func (a OutboundApi) PutOutboundCampaignrule(campaignRuleId string, body Campaignrule) (*Campaignrule, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/campaignrules/{campaignRuleId}" - path = strings.Replace(path, "{campaignRuleId}", fmt.Sprintf("%v", campaignRuleId), -1) - defaultReturn := new(Campaignrule) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'campaignRuleId' is set - if &campaignRuleId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'campaignRuleId' when calling OutboundApi->PutOutboundCampaignrule") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling OutboundApi->PutOutboundCampaignrule") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Campaignrule - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutOutboundContactlist invokes PUT /api/v2/outbound/contactlists/{contactListId} -// -// Update a contact list. -// -// -func (a OutboundApi) PutOutboundContactlist(contactListId string, body Contactlist) (*Contactlist, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/contactlists/{contactListId}" - path = strings.Replace(path, "{contactListId}", fmt.Sprintf("%v", contactListId), -1) - defaultReturn := new(Contactlist) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'contactListId' is set - if &contactListId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'contactListId' when calling OutboundApi->PutOutboundContactlist") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling OutboundApi->PutOutboundContactlist") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Contactlist - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutOutboundContactlistContact invokes PUT /api/v2/outbound/contactlists/{contactListId}/contacts/{contactId} -// -// Update a contact. -// -// -func (a OutboundApi) PutOutboundContactlistContact(contactListId string, contactId string, body Dialercontact) (*Dialercontact, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/contactlists/{contactListId}/contacts/{contactId}" - path = strings.Replace(path, "{contactListId}", fmt.Sprintf("%v", contactListId), -1) - path = strings.Replace(path, "{contactId}", fmt.Sprintf("%v", contactId), -1) - defaultReturn := new(Dialercontact) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'contactListId' is set - if &contactListId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'contactListId' when calling OutboundApi->PutOutboundContactlistContact") - } - // verify the required parameter 'contactId' is set - if &contactId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'contactId' when calling OutboundApi->PutOutboundContactlistContact") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling OutboundApi->PutOutboundContactlistContact") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Dialercontact - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutOutboundContactlistfilter invokes PUT /api/v2/outbound/contactlistfilters/{contactListFilterId} -// -// Update Contact List Filter -// -// -func (a OutboundApi) PutOutboundContactlistfilter(contactListFilterId string, body Contactlistfilter) (*Contactlistfilter, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/contactlistfilters/{contactListFilterId}" - path = strings.Replace(path, "{contactListFilterId}", fmt.Sprintf("%v", contactListFilterId), -1) - defaultReturn := new(Contactlistfilter) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'contactListFilterId' is set - if &contactListFilterId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'contactListFilterId' when calling OutboundApi->PutOutboundContactlistfilter") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling OutboundApi->PutOutboundContactlistfilter") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Contactlistfilter - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutOutboundDnclist invokes PUT /api/v2/outbound/dnclists/{dncListId} -// -// Update dialer DNC list -// -// -func (a OutboundApi) PutOutboundDnclist(dncListId string, body Dnclist) (*Dnclist, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/dnclists/{dncListId}" - path = strings.Replace(path, "{dncListId}", fmt.Sprintf("%v", dncListId), -1) - defaultReturn := new(Dnclist) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'dncListId' is set - if &dncListId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'dncListId' when calling OutboundApi->PutOutboundDnclist") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling OutboundApi->PutOutboundDnclist") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Dnclist - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutOutboundMessagingcampaign invokes PUT /api/v2/outbound/messagingcampaigns/{messagingCampaignId} -// -// Update an Outbound Messaging Campaign -// -// -func (a OutboundApi) PutOutboundMessagingcampaign(messagingCampaignId string, body Messagingcampaign) (*Messagingcampaign, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/messagingcampaigns/{messagingCampaignId}" - path = strings.Replace(path, "{messagingCampaignId}", fmt.Sprintf("%v", messagingCampaignId), -1) - defaultReturn := new(Messagingcampaign) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'messagingCampaignId' is set - if &messagingCampaignId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'messagingCampaignId' when calling OutboundApi->PutOutboundMessagingcampaign") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling OutboundApi->PutOutboundMessagingcampaign") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Messagingcampaign - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutOutboundRuleset invokes PUT /api/v2/outbound/rulesets/{ruleSetId} -// -// Update a RuleSet. -// -// -func (a OutboundApi) PutOutboundRuleset(ruleSetId string, body Ruleset) (*Ruleset, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/rulesets/{ruleSetId}" - path = strings.Replace(path, "{ruleSetId}", fmt.Sprintf("%v", ruleSetId), -1) - defaultReturn := new(Ruleset) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'ruleSetId' is set - if &ruleSetId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'ruleSetId' when calling OutboundApi->PutOutboundRuleset") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling OutboundApi->PutOutboundRuleset") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Ruleset - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutOutboundSchedulesCampaign invokes PUT /api/v2/outbound/schedules/campaigns/{campaignId} -// -// Update a new campaign schedule. -// -// -func (a OutboundApi) PutOutboundSchedulesCampaign(campaignId string, body Campaignschedule) (*Campaignschedule, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/schedules/campaigns/{campaignId}" - path = strings.Replace(path, "{campaignId}", fmt.Sprintf("%v", campaignId), -1) - defaultReturn := new(Campaignschedule) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'campaignId' is set - if &campaignId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'campaignId' when calling OutboundApi->PutOutboundSchedulesCampaign") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling OutboundApi->PutOutboundSchedulesCampaign") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Campaignschedule - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutOutboundSchedulesSequence invokes PUT /api/v2/outbound/schedules/sequences/{sequenceId} -// -// Update a new sequence schedule. -// -// -func (a OutboundApi) PutOutboundSchedulesSequence(sequenceId string, body Sequenceschedule) (*Sequenceschedule, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/schedules/sequences/{sequenceId}" - path = strings.Replace(path, "{sequenceId}", fmt.Sprintf("%v", sequenceId), -1) - defaultReturn := new(Sequenceschedule) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'sequenceId' is set - if &sequenceId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'sequenceId' when calling OutboundApi->PutOutboundSchedulesSequence") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling OutboundApi->PutOutboundSchedulesSequence") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Sequenceschedule - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutOutboundSequence invokes PUT /api/v2/outbound/sequences/{sequenceId} -// -// Update a new campaign sequence. -// -// -func (a OutboundApi) PutOutboundSequence(sequenceId string, body Campaignsequence) (*Campaignsequence, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/sequences/{sequenceId}" - path = strings.Replace(path, "{sequenceId}", fmt.Sprintf("%v", sequenceId), -1) - defaultReturn := new(Campaignsequence) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'sequenceId' is set - if &sequenceId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'sequenceId' when calling OutboundApi->PutOutboundSequence") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling OutboundApi->PutOutboundSequence") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Campaignsequence - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutOutboundWrapupcodemappings invokes PUT /api/v2/outbound/wrapupcodemappings -// -// Update the Dialer wrap up code mapping. -// -// -func (a OutboundApi) PutOutboundWrapupcodemappings(body Wrapupcodemapping) (*Wrapupcodemapping, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/outbound/wrapupcodemappings" - defaultReturn := new(Wrapupcodemapping) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling OutboundApi->PutOutboundWrapupcodemappings") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Wrapupcodemapping - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/outboundmessagingmessagingcampaignconfigchangecontactsort.go b/build/platformclientv2/outboundmessagingmessagingcampaignconfigchangecontactsort.go deleted file mode 100644 index 69b21f44b..000000000 --- a/build/platformclientv2/outboundmessagingmessagingcampaignconfigchangecontactsort.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Outboundmessagingmessagingcampaignconfigchangecontactsort -type Outboundmessagingmessagingcampaignconfigchangecontactsort struct { - // FieldName - FieldName *string `json:"fieldName,omitempty"` - - - // Direction - Direction *string `json:"direction,omitempty"` - - - // Numeric - Numeric *bool `json:"numeric,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Outboundmessagingmessagingcampaignconfigchangecontactsort) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/outboundmessagingmessagingcampaignconfigchangeerrordetail.go b/build/platformclientv2/outboundmessagingmessagingcampaignconfigchangeerrordetail.go deleted file mode 100644 index 8c2335e53..000000000 --- a/build/platformclientv2/outboundmessagingmessagingcampaignconfigchangeerrordetail.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Outboundmessagingmessagingcampaignconfigchangeerrordetail -type Outboundmessagingmessagingcampaignconfigchangeerrordetail struct { - // VarError - VarError *string `json:"error,omitempty"` - - - // Details - Details *string `json:"details,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Outboundmessagingmessagingcampaignconfigchangeerrordetail) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/outboundmessagingmessagingcampaignconfigchangemessagingcampaign.go b/build/platformclientv2/outboundmessagingmessagingcampaignconfigchangemessagingcampaign.go deleted file mode 100644 index bb55c3477..000000000 --- a/build/platformclientv2/outboundmessagingmessagingcampaignconfigchangemessagingcampaign.go +++ /dev/null @@ -1,78 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Outboundmessagingmessagingcampaignconfigchangemessagingcampaign -type Outboundmessagingmessagingcampaignconfigchangemessagingcampaign struct { - // Id - Id *string `json:"id,omitempty"` - - - // Division - Division *Outboundmessagingmessagingcampaignconfigchangeurireference `json:"division,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // DateCreated - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - DateModified *time.Time `json:"dateModified,omitempty"` - - - // Version - Version *int `json:"version,omitempty"` - - - // CampaignStatus - CampaignStatus *string `json:"campaignStatus,omitempty"` - - - // CallableTimeSet - CallableTimeSet *Outboundmessagingmessagingcampaignconfigchangeurireference `json:"callableTimeSet,omitempty"` - - - // ContactList - ContactList *Outboundmessagingmessagingcampaignconfigchangeurireference `json:"contactList,omitempty"` - - - // DncLists - DncLists *[]Outboundmessagingmessagingcampaignconfigchangeurireference `json:"dncLists,omitempty"` - - - // ContactListFilters - ContactListFilters *[]Outboundmessagingmessagingcampaignconfigchangeurireference `json:"contactListFilters,omitempty"` - - - // AlwaysRunning - AlwaysRunning *bool `json:"alwaysRunning,omitempty"` - - - // ContactSorts - ContactSorts *[]Outboundmessagingmessagingcampaignconfigchangecontactsort `json:"contactSorts,omitempty"` - - - // MessagesPerMinute - MessagesPerMinute *int `json:"messagesPerMinute,omitempty"` - - - // SmsConfig - SmsConfig *Outboundmessagingmessagingcampaignconfigchangesmsconfig `json:"smsConfig,omitempty"` - - - // Errors - Errors *[]Outboundmessagingmessagingcampaignconfigchangeerrordetail `json:"errors,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Outboundmessagingmessagingcampaignconfigchangemessagingcampaign) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/outboundmessagingmessagingcampaignconfigchangeresponseref.go b/build/platformclientv2/outboundmessagingmessagingcampaignconfigchangeresponseref.go deleted file mode 100644 index e9550c361..000000000 --- a/build/platformclientv2/outboundmessagingmessagingcampaignconfigchangeresponseref.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Outboundmessagingmessagingcampaignconfigchangeresponseref -type Outboundmessagingmessagingcampaignconfigchangeresponseref struct { - // Id - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Outboundmessagingmessagingcampaignconfigchangeresponseref) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/outboundmessagingmessagingcampaignconfigchangesmsconfig.go b/build/platformclientv2/outboundmessagingmessagingcampaignconfigchangesmsconfig.go deleted file mode 100644 index cb2331c7f..000000000 --- a/build/platformclientv2/outboundmessagingmessagingcampaignconfigchangesmsconfig.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Outboundmessagingmessagingcampaignconfigchangesmsconfig -type Outboundmessagingmessagingcampaignconfigchangesmsconfig struct { - // MessageColumn - MessageColumn *string `json:"messageColumn,omitempty"` - - - // PhoneColumn - PhoneColumn *string `json:"phoneColumn,omitempty"` - - - // SenderSmsPhoneNumber - SenderSmsPhoneNumber *Outboundmessagingmessagingcampaignconfigchangesmsphonenumberref `json:"senderSmsPhoneNumber,omitempty"` - - - // ContentTemplate - ContentTemplate *Outboundmessagingmessagingcampaignconfigchangeresponseref `json:"contentTemplate,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Outboundmessagingmessagingcampaignconfigchangesmsconfig) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/outboundmessagingmessagingcampaignconfigchangesmsphonenumberref.go b/build/platformclientv2/outboundmessagingmessagingcampaignconfigchangesmsphonenumberref.go deleted file mode 100644 index 08906021c..000000000 --- a/build/platformclientv2/outboundmessagingmessagingcampaignconfigchangesmsphonenumberref.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Outboundmessagingmessagingcampaignconfigchangesmsphonenumberref -type Outboundmessagingmessagingcampaignconfigchangesmsphonenumberref struct { - // PhoneNumber - PhoneNumber *string `json:"phoneNumber,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Outboundmessagingmessagingcampaignconfigchangesmsphonenumberref) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/outboundmessagingmessagingcampaignconfigchangeurireference.go b/build/platformclientv2/outboundmessagingmessagingcampaignconfigchangeurireference.go deleted file mode 100644 index bbb8bb398..000000000 --- a/build/platformclientv2/outboundmessagingmessagingcampaignconfigchangeurireference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Outboundmessagingmessagingcampaignconfigchangeurireference -type Outboundmessagingmessagingcampaignconfigchangeurireference struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Outboundmessagingmessagingcampaignconfigchangeurireference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/outboundmessagingmessagingcampaignprogresseventcampaignprogress.go b/build/platformclientv2/outboundmessagingmessagingcampaignprogresseventcampaignprogress.go deleted file mode 100644 index 74bf26b93..000000000 --- a/build/platformclientv2/outboundmessagingmessagingcampaignprogresseventcampaignprogress.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Outboundmessagingmessagingcampaignprogresseventcampaignprogress -type Outboundmessagingmessagingcampaignprogresseventcampaignprogress struct { - // Campaign - Campaign *Outboundmessagingmessagingcampaignprogresseventurireference `json:"campaign,omitempty"` - - - // NumberOfContactsCalled - NumberOfContactsCalled *float32 `json:"numberOfContactsCalled,omitempty"` - - - // NumberOfContactsMessaged - NumberOfContactsMessaged *float32 `json:"numberOfContactsMessaged,omitempty"` - - - // TotalNumberOfContacts - TotalNumberOfContacts *float32 `json:"totalNumberOfContacts,omitempty"` - - - // Percentage - Percentage *int `json:"percentage,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Outboundmessagingmessagingcampaignprogresseventcampaignprogress) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/outboundmessagingmessagingcampaignprogresseventurireference.go b/build/platformclientv2/outboundmessagingmessagingcampaignprogresseventurireference.go deleted file mode 100644 index 27d893485..000000000 --- a/build/platformclientv2/outboundmessagingmessagingcampaignprogresseventurireference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Outboundmessagingmessagingcampaignprogresseventurireference -type Outboundmessagingmessagingcampaignprogresseventurireference struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Outboundmessagingmessagingcampaignprogresseventurireference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/outboundroute.go b/build/platformclientv2/outboundroute.go deleted file mode 100644 index fdbbd5c1c..000000000 --- a/build/platformclientv2/outboundroute.go +++ /dev/null @@ -1,86 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Outboundroute -type Outboundroute struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the entity. - Name *string `json:"name,omitempty"` - - - // Description - The resource's description. - Description *string `json:"description,omitempty"` - - - // Version - The current version of the resource. - Version *int `json:"version,omitempty"` - - - // DateCreated - The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // ModifiedBy - The ID of the user that last modified the resource. - ModifiedBy *string `json:"modifiedBy,omitempty"` - - - // CreatedBy - The ID of the user that created the resource. - CreatedBy *string `json:"createdBy,omitempty"` - - - // State - Indicates if the resource is active, inactive, or deleted. - State *string `json:"state,omitempty"` - - - // ModifiedByApp - The application that last modified the resource. - ModifiedByApp *string `json:"modifiedByApp,omitempty"` - - - // CreatedByApp - The application that created the resource. - CreatedByApp *string `json:"createdByApp,omitempty"` - - - // ClassificationTypes - The site associated to the outbound route. - ClassificationTypes *[]string `json:"classificationTypes,omitempty"` - - - // Enabled - Enabled *bool `json:"enabled,omitempty"` - - - // Distribution - Distribution *string `json:"distribution,omitempty"` - - - // ExternalTrunkBases - Trunk base settings of trunkType \"EXTERNAL\". This base must also be set on an edge logical interface for correct routing. - ExternalTrunkBases *[]Domainentityref `json:"externalTrunkBases,omitempty"` - - - // Site - The site associated to the outbound route. - Site *Site `json:"site,omitempty"` - - - // Managed - Is this outbound route being managed remotely. - Managed *bool `json:"managed,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Outboundroute) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/outboundroutebase.go b/build/platformclientv2/outboundroutebase.go deleted file mode 100644 index 9ff6269f6..000000000 --- a/build/platformclientv2/outboundroutebase.go +++ /dev/null @@ -1,78 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Outboundroutebase -type Outboundroutebase struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the entity. - Name *string `json:"name,omitempty"` - - - // Description - The resource's description. - Description *string `json:"description,omitempty"` - - - // Version - The current version of the resource. - Version *int `json:"version,omitempty"` - - - // DateCreated - The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // ModifiedBy - The ID of the user that last modified the resource. - ModifiedBy *string `json:"modifiedBy,omitempty"` - - - // CreatedBy - The ID of the user that created the resource. - CreatedBy *string `json:"createdBy,omitempty"` - - - // State - Indicates if the resource is active, inactive, or deleted. - State *string `json:"state,omitempty"` - - - // ModifiedByApp - The application that last modified the resource. - ModifiedByApp *string `json:"modifiedByApp,omitempty"` - - - // CreatedByApp - The application that created the resource. - CreatedByApp *string `json:"createdByApp,omitempty"` - - - // ClassificationTypes - The site associated to the outbound route. - ClassificationTypes *[]string `json:"classificationTypes,omitempty"` - - - // Enabled - Enabled *bool `json:"enabled,omitempty"` - - - // Distribution - Distribution *string `json:"distribution,omitempty"` - - - // ExternalTrunkBases - Trunk base settings of trunkType \"EXTERNAL\". This base must also be set on an edge logical interface for correct routing. - ExternalTrunkBases *[]Domainentityref `json:"externalTrunkBases,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Outboundroutebase) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/outboundroutebaseentitylisting.go b/build/platformclientv2/outboundroutebaseentitylisting.go deleted file mode 100644 index 8049c75a4..000000000 --- a/build/platformclientv2/outboundroutebaseentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Outboundroutebaseentitylisting -type Outboundroutebaseentitylisting struct { - // Entities - Entities *[]Outboundroutebase `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Outboundroutebaseentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/outboundrouteentitylisting.go b/build/platformclientv2/outboundrouteentitylisting.go deleted file mode 100644 index 42c63f17e..000000000 --- a/build/platformclientv2/outboundrouteentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Outboundrouteentitylisting -type Outboundrouteentitylisting struct { - // Entities - Entities *[]Outboundroute `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Outboundrouteentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/outboundsettings.go b/build/platformclientv2/outboundsettings.go deleted file mode 100644 index 864af13bb..000000000 --- a/build/platformclientv2/outboundsettings.go +++ /dev/null @@ -1,58 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Outboundsettings -type Outboundsettings struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // DateCreated - Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // Version - Required for updates, must match the version number of the most recent update - Version *int `json:"version,omitempty"` - - - // MaxCallsPerAgent - The maximum number of calls that can be placed per agent on any campaign - MaxCallsPerAgent *int `json:"maxCallsPerAgent,omitempty"` - - - // MaxConfigurableCallsPerAgent - The maximum number of calls that can be configured to be placed per agent on any campaign - MaxConfigurableCallsPerAgent *int `json:"maxConfigurableCallsPerAgent,omitempty"` - - - // MaxLineUtilization - The maximum percentage of lines that should be used for Outbound, expressed as a decimal in the range [0.0, 1.0] - MaxLineUtilization *float64 `json:"maxLineUtilization,omitempty"` - - - // AbandonSeconds - The number of seconds used to determine if a call is abandoned - AbandonSeconds *float64 `json:"abandonSeconds,omitempty"` - - - // ComplianceAbandonRateDenominator - The denominator to be used in determining the compliance abandon rate - ComplianceAbandonRateDenominator *string `json:"complianceAbandonRateDenominator,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Outboundsettings) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/outcome.go b/build/platformclientv2/outcome.go deleted file mode 100644 index 75fc361b3..000000000 --- a/build/platformclientv2/outcome.go +++ /dev/null @@ -1,58 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Outcome -type Outcome struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // IsActive - Whether or not the outcome is active. - IsActive *bool `json:"isActive,omitempty"` - - - // DisplayName - The display name of the outcome. - DisplayName *string `json:"displayName,omitempty"` - - - // Version - The version of the outcome. - Version *int `json:"version,omitempty"` - - - // Description - A description of the outcome. - Description *string `json:"description,omitempty"` - - - // IsPositive - Whether or not the outcome is positive. - IsPositive *bool `json:"isPositive,omitempty"` - - - // Context - The context of the outcome. - Context *Context `json:"context,omitempty"` - - - // Journey - The pattern of rules defining the filter of the outcome. - Journey *Journey `json:"journey,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - - - // CreatedDate - Timestamp indicating when the outcome was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - CreatedDate *time.Time `json:"createdDate,omitempty"` - - - // ModifiedDate - Timestamp indicating when the outcome was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ModifiedDate *time.Time `json:"modifiedDate,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Outcome) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/outcomelisting.go b/build/platformclientv2/outcomelisting.go deleted file mode 100644 index 16113880c..000000000 --- a/build/platformclientv2/outcomelisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Outcomelisting -type Outcomelisting struct { - // Entities - Entities *[]Outcome `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Outcomelisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/outcomeprobabilitycondition.go b/build/platformclientv2/outcomeprobabilitycondition.go deleted file mode 100644 index be5910166..000000000 --- a/build/platformclientv2/outcomeprobabilitycondition.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Outcomeprobabilitycondition -type Outcomeprobabilitycondition struct { - // OutcomeId - The outcome ID. - OutcomeId *string `json:"outcomeId,omitempty"` - - - // MaximumProbability - Probability value for the selected outcome at or above which the action map will trigger. - MaximumProbability *float32 `json:"maximumProbability,omitempty"` - - - // Probability - Additional probability condition, where if set, the action map will trigger if the current outcome probability is lower or equal to the value. - Probability *float32 `json:"probability,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Outcomeprobabilitycondition) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/outofoffice.go b/build/platformclientv2/outofoffice.go deleted file mode 100644 index 5f76e736e..000000000 --- a/build/platformclientv2/outofoffice.go +++ /dev/null @@ -1,46 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Outofoffice -type Outofoffice struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // User - User **User `json:"user,omitempty"` - - - // StartDate - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartDate *time.Time `json:"startDate,omitempty"` - - - // EndDate - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - EndDate *time.Time `json:"endDate,omitempty"` - - - // Active - Active *bool `json:"active,omitempty"` - - - // Indefinite - Indefinite *bool `json:"indefinite,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Outofoffice) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/outofofficeeventoutofoffice.go b/build/platformclientv2/outofofficeeventoutofoffice.go deleted file mode 100644 index 4b27c5d73..000000000 --- a/build/platformclientv2/outofofficeeventoutofoffice.go +++ /dev/null @@ -1,34 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Outofofficeeventoutofoffice -type Outofofficeeventoutofoffice struct { - // User - User *Outofofficeeventuser `json:"user,omitempty"` - - - // Active - Active *bool `json:"active,omitempty"` - - - // Indefinite - Indefinite *bool `json:"indefinite,omitempty"` - - - // StartDate - StartDate *time.Time `json:"startDate,omitempty"` - - - // EndDate - EndDate *time.Time `json:"endDate,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Outofofficeeventoutofoffice) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/outofofficeeventuser.go b/build/platformclientv2/outofofficeeventuser.go deleted file mode 100644 index 9d8769c0e..000000000 --- a/build/platformclientv2/outofofficeeventuser.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Outofofficeeventuser -type Outofofficeeventuser struct { - // Id - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Outofofficeeventuser) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/page.go b/build/platformclientv2/page.go deleted file mode 100644 index c7c0eece8..000000000 --- a/build/platformclientv2/page.go +++ /dev/null @@ -1,46 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Page -type Page struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // VersionId - VersionId *string `json:"versionId,omitempty"` - - - // CreatedDate - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - CreatedDate *time.Time `json:"createdDate,omitempty"` - - - // ModifiedDate - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ModifiedDate *time.Time `json:"modifiedDate,omitempty"` - - - // RootContainer - RootContainer *map[string]interface{} `json:"rootContainer,omitempty"` - - - // Properties - Properties *map[string]interface{} `json:"properties,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Page) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/pagingspec.go b/build/platformclientv2/pagingspec.go deleted file mode 100644 index e22f6a119..000000000 --- a/build/platformclientv2/pagingspec.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Pagingspec -type Pagingspec struct { - // PageSize - How many results per page - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - How many pages in - PageNumber *int `json:"pageNumber,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Pagingspec) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/parameter.go b/build/platformclientv2/parameter.go deleted file mode 100644 index 3a14260f6..000000000 --- a/build/platformclientv2/parameter.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Parameter -type Parameter struct { - // Name - Name *string `json:"name,omitempty"` - - - // ParameterType - ParameterType *string `json:"parameterType,omitempty"` - - - // Domain - Domain *string `json:"domain,omitempty"` - - - // Required - Required *bool `json:"required,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Parameter) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/parsedcertificate.go b/build/platformclientv2/parsedcertificate.go deleted file mode 100644 index eca549588..000000000 --- a/build/platformclientv2/parsedcertificate.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Parsedcertificate - Represents the parsed certificate information. -type Parsedcertificate struct { - // CertificateDetails - The details of the certificates that were parsed correctly. - CertificateDetails *[]Certificatedetails `json:"certificateDetails,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Parsedcertificate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/participant.go b/build/platformclientv2/participant.go deleted file mode 100644 index ef585c384..000000000 --- a/build/platformclientv2/participant.go +++ /dev/null @@ -1,194 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Participant -type Participant struct { - // Id - A globally unique identifier for this conversation. - Id *string `json:"id,omitempty"` - - - // StartTime - The timestamp when this participant joined the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartTime *time.Time `json:"startTime,omitempty"` - - - // EndTime - The timestamp when this participant disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - EndTime *time.Time `json:"endTime,omitempty"` - - - // ConnectedTime - The timestamp when this participant was connected to the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // Name - A human readable name identifying the participant. - Name *string `json:"name,omitempty"` - - - // UserUri - If this participant represents a user, then this will be an URI that can be used to fetch the user. - UserUri *string `json:"userUri,omitempty"` - - - // UserId - If this participant represents a user, then this will be the globally unique identifier for the user. - UserId *string `json:"userId,omitempty"` - - - // ExternalContactId - If this participant represents an external contact, then this will be the globally unique identifier for the external contact. - ExternalContactId *string `json:"externalContactId,omitempty"` - - - // ExternalOrganizationId - If this participant represents an external org, then this will be the globally unique identifier for the external org. - ExternalOrganizationId *string `json:"externalOrganizationId,omitempty"` - - - // QueueId - If present, the queue id that the communication channel came in on. - QueueId *string `json:"queueId,omitempty"` - - - // GroupId - If present, group of users the participant represents. - GroupId *string `json:"groupId,omitempty"` - - - // TeamId - The team id that this participant is a member of when added to the conversation. - TeamId *string `json:"teamId,omitempty"` - - - // QueueName - If present, the queue name that the communication channel came in on. - QueueName *string `json:"queueName,omitempty"` - - - // Purpose - A well known string that specifies the purpose of this participant. - Purpose *string `json:"purpose,omitempty"` - - - // ParticipantType - A well known string that specifies the type of this participant. - ParticipantType *string `json:"participantType,omitempty"` - - - // ConsultParticipantId - If this participant is part of a consult transfer, then this will be the participant id of the participant being transferred. - ConsultParticipantId *string `json:"consultParticipantId,omitempty"` - - - // Address - The address for the this participant. For a phone call this will be the ANI. - Address *string `json:"address,omitempty"` - - - // Ani - The address for the this participant. For a phone call this will be the ANI. - Ani *string `json:"ani,omitempty"` - - - // AniName - The ani-based name for this participant. - AniName *string `json:"aniName,omitempty"` - - - // Dnis - The address for the this participant. For a phone call this will be the ANI. - Dnis *string `json:"dnis,omitempty"` - - - // Locale - An ISO 639 language code specifying the locale for this participant - Locale *string `json:"locale,omitempty"` - - - // WrapupRequired - True iff this participant is required to enter wrapup for this conversation. - WrapupRequired *bool `json:"wrapupRequired,omitempty"` - - - // WrapupPrompt - This field controls how the UI prompts the agent for a wrapup. - WrapupPrompt *string `json:"wrapupPrompt,omitempty"` - - - // WrapupTimeoutMs - Specifies how long a timed ACW session will last. - WrapupTimeoutMs *int `json:"wrapupTimeoutMs,omitempty"` - - - // WrapupSkipped - The UI sets this field when the agent chooses to skip entering a wrapup for this participant. - WrapupSkipped *bool `json:"wrapupSkipped,omitempty"` - - - // Wrapup - Call wrap up or disposition data. - Wrapup *Wrapup `json:"wrapup,omitempty"` - - - // ConversationRoutingData - Information on how a communication should be routed to an agent. - ConversationRoutingData *Conversationroutingdata `json:"conversationRoutingData,omitempty"` - - - // AlertingTimeoutMs - Specifies how long the agent has to answer an interaction before being marked as not responding. - AlertingTimeoutMs *int `json:"alertingTimeoutMs,omitempty"` - - - // MonitoredParticipantId - If this participant is a monitor, then this will be the id of the participant that is being monitored. - MonitoredParticipantId *string `json:"monitoredParticipantId,omitempty"` - - - // CoachedParticipantId - If this participant is a coach, then this will be the id of the participant that is being coached. - CoachedParticipantId *string `json:"coachedParticipantId,omitempty"` - - - // Attributes - Additional participant attributes - Attributes *map[string]string `json:"attributes,omitempty"` - - - // Calls - Calls *[]Call `json:"calls,omitempty"` - - - // Callbacks - Callbacks *[]Callback `json:"callbacks,omitempty"` - - - // Chats - Chats *[]Conversationchat `json:"chats,omitempty"` - - - // Cobrowsesessions - Cobrowsesessions *[]Cobrowsesession `json:"cobrowsesessions,omitempty"` - - - // Emails - Emails *[]Email `json:"emails,omitempty"` - - - // Messages - Messages *[]Message `json:"messages,omitempty"` - - - // Screenshares - Screenshares *[]Screenshare `json:"screenshares,omitempty"` - - - // SocialExpressions - SocialExpressions *[]Socialexpression `json:"socialExpressions,omitempty"` - - - // Videos - Videos *[]Video `json:"videos,omitempty"` - - - // Evaluations - Evaluations *[]Evaluation `json:"evaluations,omitempty"` - - - // ScreenRecordingState - The current screen recording state for this participant. - ScreenRecordingState *string `json:"screenRecordingState,omitempty"` - - - // FlaggedReason - The reason specifying why participant flagged the conversation. - FlaggedReason *string `json:"flaggedReason,omitempty"` - - - // StartAcwTime - The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartAcwTime *time.Time `json:"startAcwTime,omitempty"` - - - // EndAcwTime - The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - EndAcwTime *time.Time `json:"endAcwTime,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Participant) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/participantattributes.go b/build/platformclientv2/participantattributes.go deleted file mode 100644 index 477a3ff9e..000000000 --- a/build/platformclientv2/participantattributes.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Participantattributes -type Participantattributes struct { - // Attributes - The map of attribute keys to values. - Attributes *map[string]string `json:"attributes,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Participantattributes) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/participantbasic.go b/build/platformclientv2/participantbasic.go deleted file mode 100644 index 61ba0a478..000000000 --- a/build/platformclientv2/participantbasic.go +++ /dev/null @@ -1,194 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Participantbasic -type Participantbasic struct { - // Id - A globally unique identifier for this conversation. - Id *string `json:"id,omitempty"` - - - // StartTime - The timestamp when this participant joined the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartTime *time.Time `json:"startTime,omitempty"` - - - // EndTime - The timestamp when this participant disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - EndTime *time.Time `json:"endTime,omitempty"` - - - // ConnectedTime - The timestamp when this participant was connected to the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // Name - A human readable name identifying the participant. - Name *string `json:"name,omitempty"` - - - // UserUri - If this participant represents a user, then this will be an URI that can be used to fetch the user. - UserUri *string `json:"userUri,omitempty"` - - - // UserId - If this participant represents a user, then this will be the globally unique identifier for the user. - UserId *string `json:"userId,omitempty"` - - - // ExternalContactId - If this participant represents an external contact, then this will be the globally unique identifier for the external contact. - ExternalContactId *string `json:"externalContactId,omitempty"` - - - // ExternalOrganizationId - If this participant represents an external org, then this will be the globally unique identifier for the external org. - ExternalOrganizationId *string `json:"externalOrganizationId,omitempty"` - - - // QueueId - If present, the queue id that the communication channel came in on. - QueueId *string `json:"queueId,omitempty"` - - - // GroupId - If present, group of users the participant represents. - GroupId *string `json:"groupId,omitempty"` - - - // TeamId - The team id that this participant is a member of when added to the conversation. - TeamId *string `json:"teamId,omitempty"` - - - // QueueName - If present, the queue name that the communication channel came in on. - QueueName *string `json:"queueName,omitempty"` - - - // Purpose - A well known string that specifies the purpose of this participant. - Purpose *string `json:"purpose,omitempty"` - - - // ParticipantType - A well known string that specifies the type of this participant. - ParticipantType *string `json:"participantType,omitempty"` - - - // ConsultParticipantId - If this participant is part of a consult transfer, then this will be the participant id of the participant being transferred. - ConsultParticipantId *string `json:"consultParticipantId,omitempty"` - - - // Address - The address for the this participant. For a phone call this will be the ANI. - Address *string `json:"address,omitempty"` - - - // Ani - The address for the this participant. For a phone call this will be the ANI. - Ani *string `json:"ani,omitempty"` - - - // AniName - The ani-based name for this participant. - AniName *string `json:"aniName,omitempty"` - - - // Dnis - The address for the this participant. For a phone call this will be the ANI. - Dnis *string `json:"dnis,omitempty"` - - - // Locale - An ISO 639 language code specifying the locale for this participant - Locale *string `json:"locale,omitempty"` - - - // WrapupRequired - True iff this participant is required to enter wrapup for this conversation. - WrapupRequired *bool `json:"wrapupRequired,omitempty"` - - - // WrapupPrompt - This field controls how the UI prompts the agent for a wrapup. - WrapupPrompt *string `json:"wrapupPrompt,omitempty"` - - - // WrapupTimeoutMs - Specifies how long a timed ACW session will last. - WrapupTimeoutMs *int `json:"wrapupTimeoutMs,omitempty"` - - - // WrapupSkipped - The UI sets this field when the agent chooses to skip entering a wrapup for this participant. - WrapupSkipped *bool `json:"wrapupSkipped,omitempty"` - - - // Wrapup - Call wrap up or disposition data. - Wrapup *Wrapup `json:"wrapup,omitempty"` - - - // ConversationRoutingData - Information on how a communication should be routed to an agent. - ConversationRoutingData *Conversationroutingdata `json:"conversationRoutingData,omitempty"` - - - // AlertingTimeoutMs - Specifies how long the agent has to answer an interaction before being marked as not responding. - AlertingTimeoutMs *int `json:"alertingTimeoutMs,omitempty"` - - - // MonitoredParticipantId - If this participant is a monitor, then this will be the id of the participant that is being monitored. - MonitoredParticipantId *string `json:"monitoredParticipantId,omitempty"` - - - // CoachedParticipantId - If this participant is a coach, then this will be the id of the participant that is being coached. - CoachedParticipantId *string `json:"coachedParticipantId,omitempty"` - - - // Attributes - Additional participant attributes - Attributes *map[string]string `json:"attributes,omitempty"` - - - // Calls - Calls *[]Callbasic `json:"calls,omitempty"` - - - // Callbacks - Callbacks *[]Callbackbasic `json:"callbacks,omitempty"` - - - // Chats - Chats *[]Conversationchat `json:"chats,omitempty"` - - - // Cobrowsesessions - Cobrowsesessions *[]Cobrowsesession `json:"cobrowsesessions,omitempty"` - - - // Emails - Emails *[]Email `json:"emails,omitempty"` - - - // Messages - Messages *[]Message `json:"messages,omitempty"` - - - // Screenshares - Screenshares *[]Screenshare `json:"screenshares,omitempty"` - - - // SocialExpressions - SocialExpressions *[]Socialexpression `json:"socialExpressions,omitempty"` - - - // Videos - Videos *[]Video `json:"videos,omitempty"` - - - // Evaluations - Evaluations *[]Evaluation `json:"evaluations,omitempty"` - - - // ScreenRecordingState - The current screen recording state for this participant. - ScreenRecordingState *string `json:"screenRecordingState,omitempty"` - - - // FlaggedReason - The reason specifying why participant flagged the conversation. - FlaggedReason *string `json:"flaggedReason,omitempty"` - - - // StartAcwTime - The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartAcwTime *time.Time `json:"startAcwTime,omitempty"` - - - // EndAcwTime - The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - EndAcwTime *time.Time `json:"endAcwTime,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Participantbasic) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/participantmetrics.go b/build/platformclientv2/participantmetrics.go deleted file mode 100644 index f7d8bf5ab..000000000 --- a/build/platformclientv2/participantmetrics.go +++ /dev/null @@ -1,13 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Participantmetrics -type Participantmetrics struct { } - -// String returns a JSON representation of the model -func (o *Participantmetrics) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/patchaction.go b/build/platformclientv2/patchaction.go deleted file mode 100644 index 449c08e7a..000000000 --- a/build/platformclientv2/patchaction.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Patchaction -type Patchaction struct { - // MediaType - Media type of action. - MediaType *string `json:"mediaType,omitempty"` - - - // ActionTemplate - Action template associated with the action map. - ActionTemplate *Actionmapactiontemplate `json:"actionTemplate,omitempty"` - - - // ArchitectFlowFields - Architect Flow Id and input contract. - ArchitectFlowFields *Architectflowfields `json:"architectFlowFields,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Patchaction) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/patchactionmap.go b/build/platformclientv2/patchactionmap.go deleted file mode 100644 index b0d097fd7..000000000 --- a/build/platformclientv2/patchactionmap.go +++ /dev/null @@ -1,86 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Patchactionmap -type Patchactionmap struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Version - The version of the action map. - Version *int `json:"version,omitempty"` - - - // IsActive - Whether the action map is active. - IsActive *bool `json:"isActive,omitempty"` - - - // DisplayName - Display name of the action map. - DisplayName *string `json:"displayName,omitempty"` - - - // TriggerWithSegments - Trigger action map if any segment in the list is assigned to a given customer. - TriggerWithSegments *[]string `json:"triggerWithSegments,omitempty"` - - - // TriggerWithEventConditions - List of event conditions that must be satisfied to trigger the action map. - TriggerWithEventConditions *[]Eventcondition `json:"triggerWithEventConditions,omitempty"` - - - // TriggerWithOutcomeProbabilityConditions - Probability conditions for outcomes that must be satisfied to trigger the action map. - TriggerWithOutcomeProbabilityConditions *[]Outcomeprobabilitycondition `json:"triggerWithOutcomeProbabilityConditions,omitempty"` - - - // PageUrlConditions - URL conditions that a page must match for web actions to be displayable. - PageUrlConditions *[]Urlcondition `json:"pageUrlConditions,omitempty"` - - - // Activation - Type of activation. - Activation *Activation `json:"activation,omitempty"` - - - // Weight - Weight of the action map with higher number denoting higher weight. - Weight *int `json:"weight,omitempty"` - - - // Action - The action that will be executed if this action map is triggered. - Action *Patchaction `json:"action,omitempty"` - - - // ActionMapScheduleGroups - The action map's associated schedule groups. - ActionMapScheduleGroups *Patchactionmapschedulegroups `json:"actionMapScheduleGroups,omitempty"` - - - // IgnoreFrequencyCap - Override organization-level frequency cap and always offer web engagements from this action map. - IgnoreFrequencyCap *bool `json:"ignoreFrequencyCap,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - - - // CreatedDate - Timestamp indicating when the action map was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - CreatedDate *time.Time `json:"createdDate,omitempty"` - - - // ModifiedDate - Timestamp indicating when the action map was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ModifiedDate *time.Time `json:"modifiedDate,omitempty"` - - - // StartDate - Timestamp at which the action map is scheduled to start firing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartDate *time.Time `json:"startDate,omitempty"` - - - // EndDate - Timestamp at which the action map is scheduled to stop firing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - EndDate *time.Time `json:"endDate,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Patchactionmap) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/patchactionmapschedulegroups.go b/build/platformclientv2/patchactionmapschedulegroups.go deleted file mode 100644 index 7e6d3a3f4..000000000 --- a/build/platformclientv2/patchactionmapschedulegroups.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Patchactionmapschedulegroups -type Patchactionmapschedulegroups struct { - // ActionMapScheduleGroup - The actions map's associated schedule group. - ActionMapScheduleGroup *Actionmapschedulegroup `json:"actionMapScheduleGroup,omitempty"` - - - // EmergencyActionMapScheduleGroup - The action map's associated emergency schedule group. - EmergencyActionMapScheduleGroup *Actionmapschedulegroup `json:"emergencyActionMapScheduleGroup,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Patchactionmapschedulegroups) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/patchactionproperties.go b/build/platformclientv2/patchactionproperties.go deleted file mode 100644 index 31e75f356..000000000 --- a/build/platformclientv2/patchactionproperties.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Patchactionproperties -type Patchactionproperties struct { - // WebchatPrompt - Prompt message shown to user, used for webchat type action. - WebchatPrompt *string `json:"webchatPrompt,omitempty"` - - - // WebchatTitleText - Title shown to the user, used for webchat type action. - WebchatTitleText *string `json:"webchatTitleText,omitempty"` - - - // WebchatAcceptText - Accept button text shown to user, used for webchat type action. - WebchatAcceptText *string `json:"webchatAcceptText,omitempty"` - - - // WebchatDeclineText - Decline button text shown to user, used for webchat type action. - WebchatDeclineText *string `json:"webchatDeclineText,omitempty"` - - - // WebchatSurvey - Survey provided to the user, used for webchat type action. - WebchatSurvey *Patchactionsurvey `json:"webchatSurvey,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Patchactionproperties) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/patchactionsurvey.go b/build/platformclientv2/patchactionsurvey.go deleted file mode 100644 index 76764838f..000000000 --- a/build/platformclientv2/patchactionsurvey.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Patchactionsurvey -type Patchactionsurvey struct { - // Questions - Questions shown to the user. - Questions *[]Patchsurveyquestion `json:"questions,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Patchactionsurvey) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/patchactiontarget.go b/build/platformclientv2/patchactiontarget.go deleted file mode 100644 index de43d23b6..000000000 --- a/build/platformclientv2/patchactiontarget.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Patchactiontarget -type Patchactiontarget struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // ServiceLevel - Service Level of the action target. Chat offers for the target will be throttled with the aim of achieving this service level. - ServiceLevel *Servicelevel `json:"serviceLevel,omitempty"` - - - // ShortAbandonThreshold - Indicates the non-default short abandon threshold - ShortAbandonThreshold *int `json:"shortAbandonThreshold,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Patchactiontarget) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/patchactiontemplate.go b/build/platformclientv2/patchactiontemplate.go deleted file mode 100644 index c52c3a2b3..000000000 --- a/build/platformclientv2/patchactiontemplate.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Patchactiontemplate -type Patchactiontemplate struct { - // Name - Name of the action template. - Name *string `json:"name,omitempty"` - - - // Description - Description of the action template's functionality. - Description *string `json:"description,omitempty"` - - - // MediaType - Media type of action described by the action template. - MediaType *string `json:"mediaType,omitempty"` - - - // State - Whether the action template is currently active, inactive or deleted. - State *string `json:"state,omitempty"` - - - // ContentOffer - Properties used to configure an action of type content offer - ContentOffer *Patchcontentoffer `json:"contentOffer,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Patchactiontemplate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/patchbureschedulingoptionsmanagementunitrequest.go b/build/platformclientv2/patchbureschedulingoptionsmanagementunitrequest.go deleted file mode 100644 index ee0a30f29..000000000 --- a/build/platformclientv2/patchbureschedulingoptionsmanagementunitrequest.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Patchbureschedulingoptionsmanagementunitrequest -type Patchbureschedulingoptionsmanagementunitrequest struct { - // ManagementUnitId - The management unit portion of the rescheduling run to update - ManagementUnitId *string `json:"managementUnitId,omitempty"` - - - // Applied - Whether to mark the run as applied. Only applies to reschedule runs. Once applied, a run cannot be un-marked as applied - Applied *bool `json:"applied,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Patchbureschedulingoptionsmanagementunitrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/patchbureschedulingoptionsrequest.go b/build/platformclientv2/patchbureschedulingoptionsrequest.go deleted file mode 100644 index f39fc9f18..000000000 --- a/build/platformclientv2/patchbureschedulingoptionsrequest.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Patchbureschedulingoptionsrequest -type Patchbureschedulingoptionsrequest struct { - // ManagementUnits - Per-management unit rescheduling options to update - ManagementUnits *[]Patchbureschedulingoptionsmanagementunitrequest `json:"managementUnits,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Patchbureschedulingoptionsrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/patchbuschedulerunrequest.go b/build/platformclientv2/patchbuschedulerunrequest.go deleted file mode 100644 index 4d535a25f..000000000 --- a/build/platformclientv2/patchbuschedulerunrequest.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Patchbuschedulerunrequest -type Patchbuschedulerunrequest struct { - // ReschedulingOptions - The rescheduling options to update - ReschedulingOptions *Patchbureschedulingoptionsrequest `json:"reschedulingOptions,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Patchbuschedulerunrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/patchcalltoaction.go b/build/platformclientv2/patchcalltoaction.go deleted file mode 100644 index 628ac14e3..000000000 --- a/build/platformclientv2/patchcalltoaction.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Patchcalltoaction -type Patchcalltoaction struct { - // Text - Text displayed on the call to action button. - Text *string `json:"text,omitempty"` - - - // Url - URL to open when user clicks on the call to action button. - Url *string `json:"url,omitempty"` - - - // Target - Where the URL should be opened when the user clicks on the call to action button. - Target *string `json:"target,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Patchcalltoaction) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/patchclosebuttonstyleproperties.go b/build/platformclientv2/patchclosebuttonstyleproperties.go deleted file mode 100644 index 20197d5a9..000000000 --- a/build/platformclientv2/patchclosebuttonstyleproperties.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Patchclosebuttonstyleproperties -type Patchclosebuttonstyleproperties struct { - // Color - Color of button. (eg. #FF0000) - Color *string `json:"color,omitempty"` - - - // Opacity - Opacity of button. - Opacity *float32 `json:"opacity,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Patchclosebuttonstyleproperties) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/patchcontentoffer.go b/build/platformclientv2/patchcontentoffer.go deleted file mode 100644 index f0db70f13..000000000 --- a/build/platformclientv2/patchcontentoffer.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Patchcontentoffer -type Patchcontentoffer struct { - // ImageUrl - URL for image displayed to the customer when displaying content offer. - ImageUrl *string `json:"imageUrl,omitempty"` - - - // DisplayMode - The display mode of Genesys Widgets when displaying content offer. - DisplayMode *string `json:"displayMode,omitempty"` - - - // LayoutMode - The layout mode of the text shown to the user when displaying content offer. - LayoutMode *string `json:"layoutMode,omitempty"` - - - // Title - Title used in the header of the content offer. - Title *string `json:"title,omitempty"` - - - // Headline - Headline displayed above the body text of the content offer. - Headline *string `json:"headline,omitempty"` - - - // Body - Body text of the content offer. - Body *string `json:"body,omitempty"` - - - // CallToAction - Properties customizing the call to action button on the content offer. - CallToAction *Patchcalltoaction `json:"callToAction,omitempty"` - - - // Style - Properties customizing the styling of the content offer. - Style *Patchcontentofferstylingconfiguration `json:"style,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Patchcontentoffer) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/patchcontentofferstyleproperties.go b/build/platformclientv2/patchcontentofferstyleproperties.go deleted file mode 100644 index 594f91600..000000000 --- a/build/platformclientv2/patchcontentofferstyleproperties.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Patchcontentofferstyleproperties -type Patchcontentofferstyleproperties struct { - // Padding - Padding of the offer. (eg. 10px) - Padding *string `json:"padding,omitempty"` - - - // Color - Text color of the offer. (eg. #FF0000) - Color *string `json:"color,omitempty"` - - - // BackgroundColor - Background color of the offer. (eg. #000000) - BackgroundColor *string `json:"backgroundColor,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Patchcontentofferstyleproperties) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/patchcontentofferstylingconfiguration.go b/build/platformclientv2/patchcontentofferstylingconfiguration.go deleted file mode 100644 index b7d98ce48..000000000 --- a/build/platformclientv2/patchcontentofferstylingconfiguration.go +++ /dev/null @@ -1,41 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Patchcontentofferstylingconfiguration -type Patchcontentofferstylingconfiguration struct { - // Position - Properties for customizing the positioning of the content offer. - Position *Patchcontentpositionproperties `json:"position,omitempty"` - - - // Offer - Properties for customizing the appearance of the content offer. - Offer *Patchcontentofferstyleproperties `json:"offer,omitempty"` - - - // CloseButton - Properties for customizing the appearance of the close button. - CloseButton *Patchclosebuttonstyleproperties `json:"closeButton,omitempty"` - - - // CtaButton - Properties for customizing the appearance of the CTA button. - CtaButton *Patchctabuttonstyleproperties `json:"ctaButton,omitempty"` - - - // Title - Properties for customizing the appearance of the title text. - Title *Patchtextstyleproperties `json:"title,omitempty"` - - - // Headline - Properties for customizing the appearance of the headline text. - Headline *Patchtextstyleproperties `json:"headline,omitempty"` - - - // Body - Properties for customizing the appearance of the body text. - Body *Patchtextstyleproperties `json:"body,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Patchcontentofferstylingconfiguration) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/patchcontentpositionproperties.go b/build/platformclientv2/patchcontentpositionproperties.go deleted file mode 100644 index 8814aa618..000000000 --- a/build/platformclientv2/patchcontentpositionproperties.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Patchcontentpositionproperties -type Patchcontentpositionproperties struct { - // Top - Top positioning offset. - Top *string `json:"top,omitempty"` - - - // Bottom - Bottom positioning offset. - Bottom *string `json:"bottom,omitempty"` - - - // Left - Left positioning offset. - Left *string `json:"left,omitempty"` - - - // Right - Right positioning offset. - Right *string `json:"right,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Patchcontentpositionproperties) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/patchctabuttonstyleproperties.go b/build/platformclientv2/patchctabuttonstyleproperties.go deleted file mode 100644 index 57a713303..000000000 --- a/build/platformclientv2/patchctabuttonstyleproperties.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Patchctabuttonstyleproperties -type Patchctabuttonstyleproperties struct { - // Color - Color of the text. (eg. #FFFFFF) - Color *string `json:"color,omitempty"` - - - // Font - Font of the text. (eg. Helvetica) - Font *string `json:"font,omitempty"` - - - // FontSize - Font size of the text. (eg. '12') - FontSize *string `json:"fontSize,omitempty"` - - - // TextAlign - Text alignment. - TextAlign *string `json:"textAlign,omitempty"` - - - // BackgroundColor - Background color of the CTA button. (eg. #A04033) - BackgroundColor *string `json:"backgroundColor,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Patchctabuttonstyleproperties) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/patchintegrationaction.go b/build/platformclientv2/patchintegrationaction.go deleted file mode 100644 index 8c9b118d3..000000000 --- a/build/platformclientv2/patchintegrationaction.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Patchintegrationaction -type Patchintegrationaction struct { - // Id - ID of the integration action to be invoked. - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Patchintegrationaction) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/patchintegrationactionfields.go b/build/platformclientv2/patchintegrationactionfields.go deleted file mode 100644 index e05c402bc..000000000 --- a/build/platformclientv2/patchintegrationactionfields.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Patchintegrationactionfields -type Patchintegrationactionfields struct { - // IntegrationAction - Reference to the Integration Action to be used when integrationAction type is qualified - IntegrationAction *Patchintegrationaction `json:"integrationAction,omitempty"` - - - // RequestMappings - Collection of Request Mappings to use - RequestMappings *[]Requestmapping `json:"requestMappings,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Patchintegrationactionfields) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/patchoutcome.go b/build/platformclientv2/patchoutcome.go deleted file mode 100644 index 46751116e..000000000 --- a/build/platformclientv2/patchoutcome.go +++ /dev/null @@ -1,58 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Patchoutcome -type Patchoutcome struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // IsActive - Whether or not the outcome is active. - IsActive *bool `json:"isActive,omitempty"` - - - // DisplayName - The display name of the outcome. - DisplayName *string `json:"displayName,omitempty"` - - - // Version - The version of the outcome. - Version *int `json:"version,omitempty"` - - - // Description - A description of the outcome. - Description *string `json:"description,omitempty"` - - - // IsPositive - Whether or not the outcome is positive. - IsPositive *bool `json:"isPositive,omitempty"` - - - // Context - The context of the outcome. - Context *Context `json:"context,omitempty"` - - - // Journey - The pattern of rules defining the filter of the outcome. - Journey *Journey `json:"journey,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - - - // CreatedDate - Timestamp indicating when the outcome was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - CreatedDate *time.Time `json:"createdDate,omitempty"` - - - // ModifiedDate - Timestamp indicating when the outcome was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ModifiedDate *time.Time `json:"modifiedDate,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Patchoutcome) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/patchsegment.go b/build/platformclientv2/patchsegment.go deleted file mode 100644 index 04d5d8649..000000000 --- a/build/platformclientv2/patchsegment.go +++ /dev/null @@ -1,66 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Patchsegment -type Patchsegment struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // IsActive - Whether or not the segment is active. - IsActive *bool `json:"isActive,omitempty"` - - - // DisplayName - The display name of the segment. - DisplayName *string `json:"displayName,omitempty"` - - - // Version - The version of the segment. - Version *int `json:"version,omitempty"` - - - // Description - A description of the segment. - Description *string `json:"description,omitempty"` - - - // Color - The hexadecimal color value of the segment. - Color *string `json:"color,omitempty"` - - - // ShouldDisplayToAgent - Whether or not the segment should be displayed to agent/supervisor users. - ShouldDisplayToAgent *bool `json:"shouldDisplayToAgent,omitempty"` - - - // Context - The context of the segment. - Context *Context `json:"context,omitempty"` - - - // Journey - The pattern of rules defining the segment. - Journey *Journey `json:"journey,omitempty"` - - - // AssignmentExpirationDays - Time, in days, from when the segment is assigned until it is automatically unassigned. - AssignmentExpirationDays *int `json:"assignmentExpirationDays,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - - - // CreatedDate - Timestamp indicating when the segment was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - CreatedDate *time.Time `json:"createdDate,omitempty"` - - - // ModifiedDate - Timestamp indicating when the the segment was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ModifiedDate *time.Time `json:"modifiedDate,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Patchsegment) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/patchshifttraderequest.go b/build/platformclientv2/patchshifttraderequest.go deleted file mode 100644 index f63bc28f6..000000000 --- a/build/platformclientv2/patchshifttraderequest.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Patchshifttraderequest -type Patchshifttraderequest struct { - // ReceivingUserId - Update the ID of the receiving user to direct the request at a specific user, or set the wrapped id to null to open up a trade to be matched by any user. - ReceivingUserId *Valuewrapperstring `json:"receivingUserId,omitempty"` - - - // Expiration - Update the expiration time for this shift trade. - Expiration *Valuewrapperdate `json:"expiration,omitempty"` - - - // AcceptableIntervals - Update the acceptable intervals the initiating user is willing to accept in trade. Setting the enclosed list to empty will make this a one sided trade request - AcceptableIntervals *Listwrapperinterval `json:"acceptableIntervals,omitempty"` - - - // Metadata - Version metadata - Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Patchshifttraderequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/patchsurveyquestion.go b/build/platformclientv2/patchsurveyquestion.go deleted file mode 100644 index 9a95635c5..000000000 --- a/build/platformclientv2/patchsurveyquestion.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Patchsurveyquestion -type Patchsurveyquestion struct { - // VarType - Type of survey question. - VarType *string `json:"type,omitempty"` - - - // Label - Label of question. - Label *string `json:"label,omitempty"` - - - // CustomerProperty - The customer property that the answer maps to. - CustomerProperty *string `json:"customerProperty,omitempty"` - - - // Choices - Choices available to user. - Choices *[]string `json:"choices,omitempty"` - - - // IsMandatory - Whether answering this question is mandatory. - IsMandatory *bool `json:"isMandatory,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Patchsurveyquestion) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/patchtextstyleproperties.go b/build/platformclientv2/patchtextstyleproperties.go deleted file mode 100644 index 7b7455c68..000000000 --- a/build/platformclientv2/patchtextstyleproperties.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Patchtextstyleproperties -type Patchtextstyleproperties struct { - // Color - Color of the text. (eg. #FFFFFF) - Color *string `json:"color,omitempty"` - - - // Font - Font of the text. (eg. Helvetica) - Font *string `json:"font,omitempty"` - - - // FontSize - Font size of the text. (eg. '12') - FontSize *string `json:"fontSize,omitempty"` - - - // TextAlign - Text alignment. - TextAlign *string `json:"textAlign,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Patchtextstyleproperties) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/patchuser.go b/build/platformclientv2/patchuser.go deleted file mode 100644 index 0770264ad..000000000 --- a/build/platformclientv2/patchuser.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Patchuser -type Patchuser struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // AcdAutoAnswer - The value that denotes if acdAutoAnswer is set on the user - AcdAutoAnswer *bool `json:"acdAutoAnswer,omitempty"` - - - // Certifications - Certifications *[]string `json:"certifications,omitempty"` - - - // Biography - Biography *Biography `json:"biography,omitempty"` - - - // EmployerInfo - EmployerInfo *Employerinfo `json:"employerInfo,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Patchuser) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/permissioncollectionentitylisting.go b/build/platformclientv2/permissioncollectionentitylisting.go deleted file mode 100644 index 7d484d928..000000000 --- a/build/platformclientv2/permissioncollectionentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Permissioncollectionentitylisting -type Permissioncollectionentitylisting struct { - // Entities - Entities *[]Domainpermissioncollection `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Permissioncollectionentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/permissions.go b/build/platformclientv2/permissions.go deleted file mode 100644 index ba4049315..000000000 --- a/build/platformclientv2/permissions.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Permissions -type Permissions struct { - // Ids - List of permission ids. - Ids *[]string `json:"ids,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Permissions) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/phone.go b/build/platformclientv2/phone.go deleted file mode 100644 index 86b9f8d7e..000000000 --- a/build/platformclientv2/phone.go +++ /dev/null @@ -1,114 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Phone -type Phone struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the entity. - Name *string `json:"name,omitempty"` - - - // Description - The resource's description. - Description *string `json:"description,omitempty"` - - - // Version - The current version of the resource. - Version *int `json:"version,omitempty"` - - - // DateCreated - The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // ModifiedBy - The ID of the user that last modified the resource. - ModifiedBy *string `json:"modifiedBy,omitempty"` - - - // CreatedBy - The ID of the user that created the resource. - CreatedBy *string `json:"createdBy,omitempty"` - - - // State - Indicates if the resource is active, inactive, or deleted. - State *string `json:"state,omitempty"` - - - // ModifiedByApp - The application that last modified the resource. - ModifiedByApp *string `json:"modifiedByApp,omitempty"` - - - // CreatedByApp - The application that created the resource. - CreatedByApp *string `json:"createdByApp,omitempty"` - - - // Site - The site associated to the phone. - Site *Domainentityref `json:"site,omitempty"` - - - // PhoneBaseSettings - Phone Base Settings - PhoneBaseSettings *Domainentityref `json:"phoneBaseSettings,omitempty"` - - - // LineBaseSettings - LineBaseSettings *Domainentityref `json:"lineBaseSettings,omitempty"` - - - // PhoneMetaBase - PhoneMetaBase *Domainentityref `json:"phoneMetaBase,omitempty"` - - - // Lines - Lines - Lines *[]Line `json:"lines,omitempty"` - - - // Status - The status of the phone and lines from the primary Edge. - Status *Phonestatus `json:"status,omitempty"` - - - // SecondaryStatus - The status of the phone and lines from the secondary Edge. - SecondaryStatus *Phonestatus `json:"secondaryStatus,omitempty"` - - - // UserAgentInfo - User Agent Information for this phone. This includes model, firmware version, and manufacturer. - UserAgentInfo *Useragentinfo `json:"userAgentInfo,omitempty"` - - - // Properties - Properties *map[string]interface{} `json:"properties,omitempty"` - - - // Capabilities - Capabilities *Phonecapabilities `json:"capabilities,omitempty"` - - - // WebRtcUser - This is the user associated with a WebRTC type phone. It is required for all WebRTC phones. - WebRtcUser *Domainentityref `json:"webRtcUser,omitempty"` - - - // PrimaryEdge - PrimaryEdge *Edge `json:"primaryEdge,omitempty"` - - - // SecondaryEdge - SecondaryEdge *Edge `json:"secondaryEdge,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Phone) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/phonebase.go b/build/platformclientv2/phonebase.go deleted file mode 100644 index e323d0d78..000000000 --- a/build/platformclientv2/phonebase.go +++ /dev/null @@ -1,78 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Phonebase -type Phonebase struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the entity. - Name *string `json:"name,omitempty"` - - - // Description - The resource's description. - Description *string `json:"description,omitempty"` - - - // Version - The current version of the resource. - Version *int `json:"version,omitempty"` - - - // DateCreated - The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // ModifiedBy - The ID of the user that last modified the resource. - ModifiedBy *string `json:"modifiedBy,omitempty"` - - - // CreatedBy - The ID of the user that created the resource. - CreatedBy *string `json:"createdBy,omitempty"` - - - // State - Indicates if the resource is active, inactive, or deleted. - State *string `json:"state,omitempty"` - - - // ModifiedByApp - The application that last modified the resource. - ModifiedByApp *string `json:"modifiedByApp,omitempty"` - - - // CreatedByApp - The application that created the resource. - CreatedByApp *string `json:"createdByApp,omitempty"` - - - // PhoneMetaBase - A phone metabase is essentially a database for storing phone configuration settings, which simplifies the configuration process. - PhoneMetaBase *Domainentityref `json:"phoneMetaBase,omitempty"` - - - // Lines - The list of linebases associated with the phone base. - Lines *[]Linebase `json:"lines,omitempty"` - - - // Properties - Properties *map[string]interface{} `json:"properties,omitempty"` - - - // Capabilities - Capabilities *Phonecapabilities `json:"capabilities,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Phonebase) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/phonebaseentitylisting.go b/build/platformclientv2/phonebaseentitylisting.go deleted file mode 100644 index c62698f99..000000000 --- a/build/platformclientv2/phonebaseentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Phonebaseentitylisting -type Phonebaseentitylisting struct { - // Entities - Entities *[]Phonebase `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Phonebaseentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/phonecapabilities.go b/build/platformclientv2/phonecapabilities.go deleted file mode 100644 index 37b238e02..000000000 --- a/build/platformclientv2/phonecapabilities.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Phonecapabilities -type Phonecapabilities struct { - // Provisions - Provisions *bool `json:"provisions,omitempty"` - - - // Registers - Registers *bool `json:"registers,omitempty"` - - - // DualRegisters - DualRegisters *bool `json:"dualRegisters,omitempty"` - - - // HardwareIdType - HardwareIdType *string `json:"hardwareIdType,omitempty"` - - - // AllowReboot - AllowReboot *bool `json:"allowReboot,omitempty"` - - - // NoRebalance - NoRebalance *bool `json:"noRebalance,omitempty"` - - - // NoCloudProvisioning - NoCloudProvisioning *bool `json:"noCloudProvisioning,omitempty"` - - - // MediaCodecs - MediaCodecs *[]string `json:"mediaCodecs,omitempty"` - - - // Cdm - Cdm *bool `json:"cdm,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Phonecapabilities) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/phonechangetopicedgereference.go b/build/platformclientv2/phonechangetopicedgereference.go deleted file mode 100644 index 9a17d845a..000000000 --- a/build/platformclientv2/phonechangetopicedgereference.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Phonechangetopicedgereference -type Phonechangetopicedgereference struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Phonechangetopicedgereference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/phonechangetopiclinestatus.go b/build/platformclientv2/phonechangetopiclinestatus.go deleted file mode 100644 index 6eba607d5..000000000 --- a/build/platformclientv2/phonechangetopiclinestatus.go +++ /dev/null @@ -1,34 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Phonechangetopiclinestatus -type Phonechangetopiclinestatus struct { - // Id - Id *string `json:"id,omitempty"` - - - // Reachable - Reachable *bool `json:"reachable,omitempty"` - - - // AddressOfRecord - AddressOfRecord *string `json:"addressOfRecord,omitempty"` - - - // ContactAddresses - ContactAddresses *[]string `json:"contactAddresses,omitempty"` - - - // ReachableStateTime - ReachableStateTime *time.Time `json:"reachableStateTime,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Phonechangetopiclinestatus) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/phonechangetopiclocaldate.go b/build/platformclientv2/phonechangetopiclocaldate.go deleted file mode 100644 index a0b5e4f4d..000000000 --- a/build/platformclientv2/phonechangetopiclocaldate.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Phonechangetopiclocaldate -type Phonechangetopiclocaldate struct { - // Year - Year *int `json:"year,omitempty"` - - - // Month - Month *int `json:"month,omitempty"` - - - // Day - Day *int `json:"day,omitempty"` - - - // LeapYear - LeapYear *bool `json:"leapYear,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Phonechangetopiclocaldate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/phonechangetopiclocaldatetime.go b/build/platformclientv2/phonechangetopiclocaldatetime.go deleted file mode 100644 index a3bc3fc47..000000000 --- a/build/platformclientv2/phonechangetopiclocaldatetime.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Phonechangetopiclocaldatetime -type Phonechangetopiclocaldatetime struct { - // Date - Date *Phonechangetopiclocaldate `json:"date,omitempty"` - - - // Time - Time *Phonechangetopiclocaltime `json:"time,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Phonechangetopiclocaldatetime) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/phonechangetopiclocaltime.go b/build/platformclientv2/phonechangetopiclocaltime.go deleted file mode 100644 index b8e3d58f2..000000000 --- a/build/platformclientv2/phonechangetopiclocaltime.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Phonechangetopiclocaltime -type Phonechangetopiclocaltime struct { - // Hour - Hour *int `json:"hour,omitempty"` - - - // Minute - Minute *int `json:"minute,omitempty"` - - - // Second - Second *int `json:"second,omitempty"` - - - // Nano - Nano *int `json:"nano,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Phonechangetopiclocaltime) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/phonechangetopicoffsetdatetime.go b/build/platformclientv2/phonechangetopicoffsetdatetime.go deleted file mode 100644 index 258382815..000000000 --- a/build/platformclientv2/phonechangetopicoffsetdatetime.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Phonechangetopicoffsetdatetime -type Phonechangetopicoffsetdatetime struct { - // DateTime - DateTime *Phonechangetopiclocaldatetime `json:"dateTime,omitempty"` - - - // Offset - Offset *Phonechangetopiczoneoffset `json:"offset,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Phonechangetopicoffsetdatetime) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/phonechangetopicphone.go b/build/platformclientv2/phonechangetopicphone.go deleted file mode 100644 index a2fca3373..000000000 --- a/build/platformclientv2/phonechangetopicphone.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Phonechangetopicphone -type Phonechangetopicphone struct { - // UserAgentInfo - UserAgentInfo *Phonechangetopicuseragentinfo `json:"userAgentInfo,omitempty"` - - - // Id - Id *string `json:"id,omitempty"` - - - // Status - Status *Phonechangetopicphonestatus `json:"status,omitempty"` - - - // SecondaryStatus - SecondaryStatus *Phonechangetopicphonestatus `json:"secondaryStatus,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Phonechangetopicphone) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/phonechangetopicphonestatus.go b/build/platformclientv2/phonechangetopicphonestatus.go deleted file mode 100644 index 6ba8ace25..000000000 --- a/build/platformclientv2/phonechangetopicphonestatus.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Phonechangetopicphonestatus -type Phonechangetopicphonestatus struct { - // Id - Id *string `json:"id,omitempty"` - - - // OperationalStatus - OperationalStatus *string `json:"operationalStatus,omitempty"` - - - // Edge - Edge *Phonechangetopicedgereference `json:"edge,omitempty"` - - - // Provision - Provision *Phonechangetopicprovisioninfo `json:"provision,omitempty"` - - - // LineStatuses - LineStatuses *[]Phonechangetopiclinestatus `json:"lineStatuses,omitempty"` - - - // EventCreationTime - EventCreationTime *Phonechangetopicoffsetdatetime `json:"eventCreationTime,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Phonechangetopicphonestatus) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/phonechangetopicprovisioninfo.go b/build/platformclientv2/phonechangetopicprovisioninfo.go deleted file mode 100644 index 7b5e158be..000000000 --- a/build/platformclientv2/phonechangetopicprovisioninfo.go +++ /dev/null @@ -1,26 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Phonechangetopicprovisioninfo -type Phonechangetopicprovisioninfo struct { - // Time - Time *time.Time `json:"time,omitempty"` - - - // Source - Source *string `json:"source,omitempty"` - - - // ErrorInfo - ErrorInfo *string `json:"errorInfo,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Phonechangetopicprovisioninfo) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/phonechangetopicuseragentinfo.go b/build/platformclientv2/phonechangetopicuseragentinfo.go deleted file mode 100644 index 14e3fb34e..000000000 --- a/build/platformclientv2/phonechangetopicuseragentinfo.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Phonechangetopicuseragentinfo -type Phonechangetopicuseragentinfo struct { - // FirmwareVersion - FirmwareVersion *string `json:"firmwareVersion,omitempty"` - - - // Manufacturer - Manufacturer *string `json:"manufacturer,omitempty"` - - - // Model - Model *string `json:"model,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Phonechangetopicuseragentinfo) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/phonechangetopiczoneoffset.go b/build/platformclientv2/phonechangetopiczoneoffset.go deleted file mode 100644 index a8dabd9da..000000000 --- a/build/platformclientv2/phonechangetopiczoneoffset.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Phonechangetopiczoneoffset -type Phonechangetopiczoneoffset struct { - // TotalSeconds - TotalSeconds *int `json:"totalSeconds,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Phonechangetopiczoneoffset) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/phonecolumn.go b/build/platformclientv2/phonecolumn.go deleted file mode 100644 index acdea1da1..000000000 --- a/build/platformclientv2/phonecolumn.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Phonecolumn -type Phonecolumn struct { - // ColumnName - The name of the phone column. - ColumnName *string `json:"columnName,omitempty"` - - - // VarType - The type of the phone column. For example, 'cell' or 'home'. - VarType *string `json:"type,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Phonecolumn) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/phoneentitylisting.go b/build/platformclientv2/phoneentitylisting.go deleted file mode 100644 index d563370a1..000000000 --- a/build/platformclientv2/phoneentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Phoneentitylisting -type Phoneentitylisting struct { - // Entities - Entities *[]Phone `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Phoneentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/phonemetabaseentitylisting.go b/build/platformclientv2/phonemetabaseentitylisting.go deleted file mode 100644 index 4a542bf3d..000000000 --- a/build/platformclientv2/phonemetabaseentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Phonemetabaseentitylisting -type Phonemetabaseentitylisting struct { - // Entities - Entities *[]Metabase `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Phonemetabaseentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/phonenumber.go b/build/platformclientv2/phonenumber.go deleted file mode 100644 index 212e99cde..000000000 --- a/build/platformclientv2/phonenumber.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Phonenumber -type Phonenumber struct { - // Display - Display *string `json:"display,omitempty"` - - - // Extension - Extension *int `json:"extension,omitempty"` - - - // AcceptsSMS - AcceptsSMS *bool `json:"acceptsSMS,omitempty"` - - - // UserInput - UserInput *string `json:"userInput,omitempty"` - - - // E164 - E164 *string `json:"e164,omitempty"` - - - // CountryCode - CountryCode *string `json:"countryCode,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Phonenumber) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/phonenumbercolumn.go b/build/platformclientv2/phonenumbercolumn.go deleted file mode 100644 index 4fccf0530..000000000 --- a/build/platformclientv2/phonenumbercolumn.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Phonenumbercolumn -type Phonenumbercolumn struct { - // ColumnName - ColumnName *string `json:"columnName,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Phonenumbercolumn) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/phonenumberstatus.go b/build/platformclientv2/phonenumberstatus.go deleted file mode 100644 index 56d39e5f1..000000000 --- a/build/platformclientv2/phonenumberstatus.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Phonenumberstatus -type Phonenumberstatus struct { - // Callable - Indicates whether or not a phone number is callable. - Callable *bool `json:"callable,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Phonenumberstatus) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/phonesreboot.go b/build/platformclientv2/phonesreboot.go deleted file mode 100644 index 5c6fe724e..000000000 --- a/build/platformclientv2/phonesreboot.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Phonesreboot -type Phonesreboot struct { - // PhoneIds - The list of phone Ids to reboot. - PhoneIds *[]string `json:"phoneIds,omitempty"` - - - // SiteId - ID of the site for which to reboot all phones at that site. no.active.edge and phone.cannot.resolve errors are ignored. - SiteId *string `json:"siteId,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Phonesreboot) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/phonestatus.go b/build/platformclientv2/phonestatus.go deleted file mode 100644 index d489d9962..000000000 --- a/build/platformclientv2/phonestatus.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Phonestatus -type Phonestatus struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // OperationalStatus - The Operational Status of this phone - OperationalStatus *string `json:"operationalStatus,omitempty"` - - - // EdgesStatus - The status of the primary or secondary Edges assigned to the phone lines. - EdgesStatus *string `json:"edgesStatus,omitempty"` - - - // EventCreationTime - Event Creation Time represents an ISO-8601 string. For example: UTC, UTC+01:00, or Europe/London - EventCreationTime *string `json:"eventCreationTime,omitempty"` - - - // Provision - Provision information for this phone - Provision *Provisioninfo `json:"provision,omitempty"` - - - // LineStatuses - A list of LineStatus information for each of the lines of this phone - LineStatuses *[]Linestatus `json:"lineStatuses,omitempty"` - - - // PhoneAssignmentToEdgeType - The phone status's edge assignment type. - PhoneAssignmentToEdgeType *string `json:"phoneAssignmentToEdgeType,omitempty"` - - - // Edge - The URI of the edge that provided this status information. - Edge *Domainentityref `json:"edge,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Phonestatus) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/physicalinterfaceentitylisting.go b/build/platformclientv2/physicalinterfaceentitylisting.go deleted file mode 100644 index 963233205..000000000 --- a/build/platformclientv2/physicalinterfaceentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Physicalinterfaceentitylisting -type Physicalinterfaceentitylisting struct { - // Entities - Entities *[]Domainphysicalinterface `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Physicalinterfaceentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/pinconfiguration.go b/build/platformclientv2/pinconfiguration.go deleted file mode 100644 index 9fafe1929..000000000 --- a/build/platformclientv2/pinconfiguration.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Pinconfiguration -type Pinconfiguration struct { - // MinimumLength - MinimumLength *int `json:"minimumLength,omitempty"` - - - // MaximumLength - MaximumLength *int `json:"maximumLength,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Pinconfiguration) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/pingidentity.go b/build/platformclientv2/pingidentity.go deleted file mode 100644 index 3e0d3d307..000000000 --- a/build/platformclientv2/pingidentity.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Pingidentity -type Pingidentity struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Disabled - Disabled *bool `json:"disabled,omitempty"` - - - // IssuerURI - IssuerURI *string `json:"issuerURI,omitempty"` - - - // SsoTargetURI - SsoTargetURI *string `json:"ssoTargetURI,omitempty"` - - - // Certificate - Certificate *string `json:"certificate,omitempty"` - - - // Certificates - Certificates *[]string `json:"certificates,omitempty"` - - - // RelyingPartyIdentifier - RelyingPartyIdentifier *string `json:"relyingPartyIdentifier,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Pingidentity) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/planninggroup.go b/build/platformclientv2/planninggroup.go deleted file mode 100644 index 85b1a06aa..000000000 --- a/build/platformclientv2/planninggroup.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Planninggroup - Planning Group -type Planninggroup struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // ServiceGoalTemplate - The ID of the service goal template associated with this planning group - ServiceGoalTemplate *Servicegoaltemplatereference `json:"serviceGoalTemplate,omitempty"` - - - // RoutePaths - Set of route paths associated with the planning group - RoutePaths *[]Routepathresponse `json:"routePaths,omitempty"` - - - // Metadata - Version metadata for the planning group - Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Planninggroup) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/planninggrouplist.go b/build/platformclientv2/planninggrouplist.go deleted file mode 100644 index 356bf848c..000000000 --- a/build/platformclientv2/planninggrouplist.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Planninggrouplist - List of planning groups -type Planninggrouplist struct { - // Entities - Entities *[]Planninggroup `json:"entities,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Planninggrouplist) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/planninggroupreference.go b/build/platformclientv2/planninggroupreference.go deleted file mode 100644 index 0777c0af2..000000000 --- a/build/platformclientv2/planninggroupreference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Planninggroupreference - Planning Group -type Planninggroupreference struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Planninggroupreference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/planningperiodsettings.go b/build/platformclientv2/planningperiodsettings.go deleted file mode 100644 index 55414d281..000000000 --- a/build/platformclientv2/planningperiodsettings.go +++ /dev/null @@ -1,22 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Planningperiodsettings -type Planningperiodsettings struct { - // WeekCount - Planning period length in weeks - WeekCount *int `json:"weekCount,omitempty"` - - - // StartDate - Start date of the planning period in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd - StartDate *time.Time `json:"startDate,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Planningperiodsettings) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/platformclientv2_test.go b/build/platformclientv2/platformclientv2_test.go deleted file mode 100644 index ca9b38a3f..000000000 --- a/build/platformclientv2/platformclientv2_test.go +++ /dev/null @@ -1,292 +0,0 @@ -package platformclientv2 - -import ( - "encoding/json" - "fmt" - "os" - "reflect" - "testing" - - "github.com/google/uuid" -) - -type testConfig struct { - environment string - clientID string - clientSecret string - debug bool - userEmail string - usersAPI *UsersApi - userID string - userName string - userDepartment string - userProfileSkill string - busyPresenceID string - availablePresenceID string -} - -type testSerializationStruct struct { - IntProp int `json:"int,omitempty"` - IntPropArr []int `json:"intArr,omitempty"` - IntPropPtr *int `json:"intPtr,omitempty"` - IntPropArrPtr *[]int `json:"intArrPtr,omitempty"` - StringProp string `json:"string,omitempty"` - StringPropArr []string `json:"stringArr,omitempty"` - StringPropPtr *string `json:"stringPtr,omitempty"` - StringPropArrPtr *[]string `json:"stringArrPtr,omitempty"` - BoolProp bool `json:"bool,omitempty"` - BoolPropArr []bool `json:"boolArr,omitempty"` - BoolPropPtr *bool `json:"boolPtr,omitempty"` - BoolPropArrPtr *[]bool `json:"boolArrPtr,omitempty"` -} - -var config testConfig - -func TestEnvVars(t *testing.T) { - // Get - config = testConfig{ - environment: "https://api." + os.Getenv("PURECLOUD_ENVIRONMENT"), - clientID: os.Getenv("PURECLOUD_CLIENT_ID"), - clientSecret: os.Getenv("PURECLOUD_CLIENT_SECRET"), - userName: "GO SDK Tester", - userDepartment: "Ministry of Testing", - userProfileSkill: "Testmaster", - busyPresenceID: "31fe3bac-dea6-44b7-bed7-47f91660a1a0", - availablePresenceID: "6a3af858-942f-489d-9700-5f9bcdcdae9b", - debug: false, - } - config.userEmail = fmt.Sprintf("%v@%v", uuid.New().String(), config.environment[12:]) - - // Check - if config.environment == "" { - t.Error("Not set: PURECLOUD_ENVIRONMENT") - } - if config.clientID == "" { - t.Error("Not set: PURECLOUD_CLIENT_ID") - } - if config.clientSecret == "" { - t.Error("Not set: PURECLOUD_CLIENT_SECRET") - } - if config.userEmail == "@"+config.environment[12:] { - t.Error("Invalid user email") - } - - // Setup - GetDefaultConfiguration().BasePath = config.environment - GetDefaultConfiguration().SetDebug(config.debug) - config.usersAPI = NewUsersApi() - - // Log - t.Logf("Enviornment: %v", config.environment) - t.Logf("clientID: %v", config.clientID) - t.Logf("userEmail: %v", config.userEmail) -} - -func TestDefaultValueSerialization(t *testing.T) { - expected := `{"intPtr":0,"intArrPtr":[],"stringPtr":"","stringArrPtr":[],"boolPtr":false,"boolArrPtr":[]}` - intPropArrPtr := make([]int, 0) - stringPropArrPtr := make([]string, 0) - boolPropArrPtr := make([]bool, 0) - intProp := 0 - v := testSerializationStruct{ - IntProp: intProp, - IntPropArr: make([]int, 0), - IntPropPtr: &intProp, - IntPropArrPtr: &intPropArrPtr, - StringProp: "", - StringPropArr: make([]string, 0), - StringPropPtr: String(""), - StringPropArrPtr: &stringPropArrPtr, - BoolProp: false, - BoolPropArr: make([]bool, 0), - BoolPropPtr: Bool(false), - BoolPropArrPtr: &boolPropArrPtr, - } - j, _ := json.Marshal(v) - s := string(j) - if s != expected { - t.Log("testSerializationStruct did not serialize correctly") - t.Logf("Expected: %v", expected) - t.Logf("Actual: %v", s) - t.FailNow() - } -} - -func TestValueSerialization(t *testing.T) { - expected := `{"int":10,"intArr":[0,0],"intPtr":10,"intArrPtr":[0,0],"string":"asdf","stringArr":["",""],"stringPtr":"asdf","stringArrPtr":["",""],"bool":true,"boolArr":[false,false],"boolPtr":true,"boolArrPtr":[false,false]}` - intPropArrPtr := make([]int, 2) - stringPropArrPtr := make([]string, 2) - boolPropArrPtr := make([]bool, 2) - intProp := 10 - v := testSerializationStruct{ - IntProp: 10, - IntPropArr: make([]int, 2), - IntPropPtr: &intProp, - IntPropArrPtr: &intPropArrPtr, - StringProp: "asdf", - StringPropArr: make([]string, 2), - StringPropPtr: String("asdf"), - StringPropArrPtr: &stringPropArrPtr, - BoolProp: true, - BoolPropArr: make([]bool, 2), - BoolPropPtr: Bool(true), - BoolPropArrPtr: &boolPropArrPtr, - } - j, _ := json.Marshal(v) - s := string(j) - if s != expected { - t.Log("testSerializationStruct did not serialize correctly") - t.Logf("Expected: %v", expected) - t.Logf("Actual: %v", s) - t.FailNow() - } -} - -func TestAuthentication(t *testing.T) { - err := GetDefaultConfiguration().AuthorizeClientCredentials(config.clientID, config.clientSecret) - if err != nil { - t.Error(err) - } -} - -func TestCreateUser(t *testing.T) { - // Create user - password := uuid.New().String() + "!@#$1234asdfASDF" - newUser := Createuser{Name: &config.userName, Email: &config.userEmail, Password: &password} - - user, response, err := config.usersAPI.PostUsers(newUser) - if err != nil { - t.Error(err) - } else if response != nil && response.Error != nil { - t.Error(response.Error) - } else { - // Validate response - if *user.Name != config.userName { - t.Error("Data mismatch: user.Name") - } - if *user.Email != config.userEmail { - t.Error("Data mismatch: user.Email") - } - - // Store user ID - config.userID = *user.Id - t.Logf("New user's ID: %v", *user.Id) - } -} - -func TestUpdateUser(t *testing.T) { - // Update user - version := 1 - updateUser := Updateuser{Department: &config.userDepartment, Version: &version} - - user, response, err := config.usersAPI.PatchUser(config.userID, updateUser) - if err != nil { - t.Error(err) - } else if response != nil && response.Error != nil { - t.Error(response.Error) - } else { - // Validate response - if *user.Name != config.userName { - t.Error("Data mismatch: user.Name") - } - if *user.Email != config.userEmail { - t.Error("Data mismatch: user.Email") - } - if *user.Department != config.userDepartment { - t.Error("Data mismatch: user.Department") - } - } -} - -func TestSetProfileSkills(t *testing.T) { - // Update user - skills, response, err := config.usersAPI.PutUserProfileskills(config.userID, []string{config.userProfileSkill}) - if err != nil { - t.Error(err) - } else if response != nil && response.Error != nil { - t.Error(response.Error) - } else { - // Validate response - if len(skills) != 1 { - t.Errorf("Skills array contained the wrong number of elements. Expected 1: %v", skills) - } else if skills[0] != config.userProfileSkill { - t.Errorf("Skill did not match. Expected %v, actual: %v", config.userProfileSkill, skills[0]) - } - } -} - -func TestGetUser(t *testing.T) { - // Get user - user, response, err := config.usersAPI.GetUser(config.userID, []string{"profileSkills"}, "", "") - if err != nil { - t.Error(err) - } else if response != nil && response.Error != nil { - t.Error(response.Error) - } else { - // Validate response - if *user.Name != config.userName { - t.Error("Data mismatch: user.Name") - } - if *user.Email != config.userEmail { - t.Error("Data mismatch: user.Email") - } - if *user.Department != config.userDepartment { - t.Error("Data mismatch: user.Department") - } - if user.ProfileSkills == nil || len(*user.ProfileSkills) != 1 || (*user.ProfileSkills)[0] != config.userProfileSkill { - t.Error("Data mismatch: user.ProfileSkills") - } - } -} - -func TestDeleteUser(t *testing.T) { - // Delete user - _, response, err := config.usersAPI.DeleteUser(config.userID) - if err != nil { - t.Error(err) - } else if response != nil && response.Error != nil { - t.Error(response.Error) - } -} - -func Example_authorizeDefaultConfiguration() { - // Use the default config instance and retrieve settings from env vars - config := GetDefaultConfiguration() - config.BasePath = "https://api." + os.Getenv("PURECLOUD_ENVIRONMENT") // e.g. PURECLOUD_ENVIRONMENT=mypurecloud.com - clientID := os.Getenv("PURECLOUD_CLIENT_ID") - clientSecret := os.Getenv("PURECLOUD_CLIENT_SECRET") - - // Authorize the configuration - err := config.AuthorizeClientCredentials(clientID, clientSecret) - if err != nil { - panic(err) - } - - // Create an API instance using the default config - usersAPI := NewUsersApi() - fmt.Printf("Users API type: %v", reflect.TypeOf(usersAPI).String()) - // Output: Users API type: UsersAPI - - // Make requests using usersAPI -} - -func Example_authorizeNewConfiguration() { - // Create a new config instance and retrieve settings from env vars - config := NewConfiguration() - config.BasePath = "https://api." + os.Getenv("PURECLOUD_ENVIRONMENT") // e.g. PURECLOUD_ENVIRONMENT=mypurecloud.com - clientID := os.Getenv("PURECLOUD_CLIENT_ID") - clientSecret := os.Getenv("PURECLOUD_CLIENT_SECRET") - - // Authorize the configuration - err := config.AuthorizeClientCredentials(clientID, clientSecret) - if err != nil { - panic(err) - } - - // Create an API instance using the config instance - usersAPI := NewUsersApiWithConfig(config) - fmt.Printf("Users API type: %v", reflect.TypeOf(usersAPI).String()) - // Output: Users API type: UsersAPI - - // Make requests using usersAPI -} diff --git a/build/platformclientv2/policy.go b/build/platformclientv2/policy.go deleted file mode 100644 index 9f4fa30eb..000000000 --- a/build/platformclientv2/policy.go +++ /dev/null @@ -1,62 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Policy -type Policy struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // ModifiedDate - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ModifiedDate *time.Time `json:"modifiedDate,omitempty"` - - - // CreatedDate - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - CreatedDate *time.Time `json:"createdDate,omitempty"` - - - // Order - Order *int `json:"order,omitempty"` - - - // Description - Description *string `json:"description,omitempty"` - - - // Enabled - Enabled *bool `json:"enabled,omitempty"` - - - // MediaPolicies - Conditions and actions per media type - MediaPolicies *Mediapolicies `json:"mediaPolicies,omitempty"` - - - // Conditions - Conditions - Conditions *Policyconditions `json:"conditions,omitempty"` - - - // Actions - Actions - Actions *Policyactions `json:"actions,omitempty"` - - - // PolicyErrors - PolicyErrors *Policyerrors `json:"policyErrors,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Policy) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/policyactions.go b/build/platformclientv2/policyactions.go deleted file mode 100644 index 242a6935f..000000000 --- a/build/platformclientv2/policyactions.go +++ /dev/null @@ -1,61 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Policyactions -type Policyactions struct { - // RetainRecording - true to retain the recording associated with the conversation. Default = true - RetainRecording *bool `json:"retainRecording,omitempty"` - - - // DeleteRecording - true to delete the recording associated with the conversation. If retainRecording = true, this will be ignored. Default = false - DeleteRecording *bool `json:"deleteRecording,omitempty"` - - - // AlwaysDelete - true to delete the recording associated with the conversation regardless of the values of retainRecording or deleteRecording. Default = false - AlwaysDelete *bool `json:"alwaysDelete,omitempty"` - - - // AssignEvaluations - AssignEvaluations *[]Evaluationassignment `json:"assignEvaluations,omitempty"` - - - // AssignMeteredEvaluations - AssignMeteredEvaluations *[]Meteredevaluationassignment `json:"assignMeteredEvaluations,omitempty"` - - - // AssignMeteredAssignmentByAgent - AssignMeteredAssignmentByAgent *[]Meteredassignmentbyagent `json:"assignMeteredAssignmentByAgent,omitempty"` - - - // AssignCalibrations - AssignCalibrations *[]Calibrationassignment `json:"assignCalibrations,omitempty"` - - - // AssignSurveys - AssignSurveys *[]Surveyassignment `json:"assignSurveys,omitempty"` - - - // RetentionDuration - RetentionDuration *Retentionduration `json:"retentionDuration,omitempty"` - - - // InitiateScreenRecording - InitiateScreenRecording *Initiatescreenrecording `json:"initiateScreenRecording,omitempty"` - - - // MediaTranscriptions - MediaTranscriptions *[]Mediatranscription `json:"mediaTranscriptions,omitempty"` - - - // IntegrationExport - Policy action for exporting recordings using an integration to 3rd party s3. - IntegrationExport *Integrationexport `json:"integrationExport,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Policyactions) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/policyconditions.go b/build/platformclientv2/policyconditions.go deleted file mode 100644 index 3cb196601..000000000 --- a/build/platformclientv2/policyconditions.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Policyconditions -type Policyconditions struct { - // ForUsers - ForUsers *[]User `json:"forUsers,omitempty"` - - - // Directions - Directions *[]string `json:"directions,omitempty"` - - - // DateRanges - DateRanges *[]string `json:"dateRanges,omitempty"` - - - // MediaTypes - MediaTypes *[]string `json:"mediaTypes,omitempty"` - - - // ForQueues - ForQueues *[]Queue `json:"forQueues,omitempty"` - - - // Duration - Duration *Durationcondition `json:"duration,omitempty"` - - - // WrapupCodes - WrapupCodes *[]Wrapupcode `json:"wrapupCodes,omitempty"` - - - // TimeAllowed - TimeAllowed *Timeallowed `json:"timeAllowed,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Policyconditions) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/policycreate.go b/build/platformclientv2/policycreate.go deleted file mode 100644 index 52bcdd959..000000000 --- a/build/platformclientv2/policycreate.go +++ /dev/null @@ -1,62 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Policycreate -type Policycreate struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The policy name. - Name *string `json:"name,omitempty"` - - - // ModifiedDate - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ModifiedDate *time.Time `json:"modifiedDate,omitempty"` - - - // CreatedDate - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - CreatedDate *time.Time `json:"createdDate,omitempty"` - - - // Order - Order *int `json:"order,omitempty"` - - - // Description - Description *string `json:"description,omitempty"` - - - // Enabled - Enabled *bool `json:"enabled,omitempty"` - - - // MediaPolicies - Conditions and actions per media type - MediaPolicies *Mediapolicies `json:"mediaPolicies,omitempty"` - - - // Conditions - Conditions - Conditions *Policyconditions `json:"conditions,omitempty"` - - - // Actions - Actions - Actions *Policyactions `json:"actions,omitempty"` - - - // PolicyErrors - PolicyErrors *Policyerrors `json:"policyErrors,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Policycreate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/policyentitylisting.go b/build/platformclientv2/policyentitylisting.go deleted file mode 100644 index ea95c37cc..000000000 --- a/build/platformclientv2/policyentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Policyentitylisting -type Policyentitylisting struct { - // Entities - Entities *[]Policy `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Policyentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/policyerrormessage.go b/build/platformclientv2/policyerrormessage.go deleted file mode 100644 index 8e4da6644..000000000 --- a/build/platformclientv2/policyerrormessage.go +++ /dev/null @@ -1,42 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Policyerrormessage -type Policyerrormessage struct { - // StatusCode - StatusCode *int `json:"statusCode,omitempty"` - - - // UserMessage - UserMessage *map[string]interface{} `json:"userMessage,omitempty"` - - - // UserParamsMessage - UserParamsMessage *string `json:"userParamsMessage,omitempty"` - - - // ErrorCode - ErrorCode *string `json:"errorCode,omitempty"` - - - // CorrelationId - CorrelationId *string `json:"correlationId,omitempty"` - - - // UserParams - UserParams *[]Userparam `json:"userParams,omitempty"` - - - // InsertDate - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - InsertDate *time.Time `json:"insertDate,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Policyerrormessage) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/policyerrors.go b/build/platformclientv2/policyerrors.go deleted file mode 100644 index 87dfe57bb..000000000 --- a/build/platformclientv2/policyerrors.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Policyerrors -type Policyerrors struct { - // PolicyErrorMessages - PolicyErrorMessages *[]Policyerrormessage `json:"policyErrorMessages,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Policyerrors) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/postactioninput.go b/build/platformclientv2/postactioninput.go deleted file mode 100644 index 5f4073fc3..000000000 --- a/build/platformclientv2/postactioninput.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Postactioninput - Definition of an Action to be created or updated. -type Postactioninput struct { - // Category - Category of action, Can be up to 256 characters long - Category *string `json:"category,omitempty"` - - - // Name - Name of action, Can be up to 256 characters long - Name *string `json:"name,omitempty"` - - - // IntegrationId - The ID of the integration this action is associated to - IntegrationId *string `json:"integrationId,omitempty"` - - - // Config - Configuration to support request and response processing - Config *Actionconfig `json:"config,omitempty"` - - - // Contract - Action contract - Contract *Actioncontractinput `json:"contract,omitempty"` - - - // Secure - Indication of whether or not the action is designed to accept sensitive data - Secure *bool `json:"secure,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Postactioninput) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/postinputcontract.go b/build/platformclientv2/postinputcontract.go deleted file mode 100644 index 2f743c7ed..000000000 --- a/build/platformclientv2/postinputcontract.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Postinputcontract - The schemas defining all of the expected requests/inputs. -type Postinputcontract struct { - // InputSchema - JSON Schema that defines the body of the request that the client (edge/architect/postman) is sending to the service, on the /execute path. - InputSchema *Jsonschemadocument `json:"inputSchema,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Postinputcontract) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/postoutputcontract.go b/build/platformclientv2/postoutputcontract.go deleted file mode 100644 index 4d471d594..000000000 --- a/build/platformclientv2/postoutputcontract.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Postoutputcontract - The schemas defining all of the expected responses/outputs. -type Postoutputcontract struct { - // SuccessSchema - JSON schema that defines the transformed, successful result that will be sent back to the caller. - SuccessSchema *Jsonschemadocument `json:"successSchema,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Postoutputcontract) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/posttextmessage.go b/build/platformclientv2/posttextmessage.go deleted file mode 100644 index 029b35600..000000000 --- a/build/platformclientv2/posttextmessage.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Posttextmessage -type Posttextmessage struct { - // VarType - Message type - VarType *string `json:"type,omitempty"` - - - // Text - Message text. If type is structured, used as fallback for clients that do not support particular structured content - Text *string `json:"text,omitempty"` - - - // Content - A list of content elements in message - Content *[]Messagecontent `json:"content,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Posttextmessage) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/posttextrequest.go b/build/platformclientv2/posttextrequest.go deleted file mode 100644 index 9d1b260bc..000000000 --- a/build/platformclientv2/posttextrequest.go +++ /dev/null @@ -1,65 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Posttextrequest -type Posttextrequest struct { - // BotId - ID of the bot to send the text to. - BotId *string `json:"botId,omitempty"` - - - // BotAlias - Alias/Version of the bot - BotAlias *string `json:"botAlias,omitempty"` - - - // IntegrationId - the integration service id for the bot's credentials - IntegrationId *string `json:"integrationId,omitempty"` - - - // BotSessionId - GUID for this bot's session - BotSessionId *string `json:"botSessionId,omitempty"` - - - // PostTextMessage - Message to send to the bot - PostTextMessage *Posttextmessage `json:"postTextMessage,omitempty"` - - - // LanguageCode - The launguage code the bot will run under - LanguageCode *string `json:"languageCode,omitempty"` - - - // BotSessionTimeoutMinutes - Override timeout for the bot session. This should be greater than 10 minutes. - BotSessionTimeoutMinutes *int `json:"botSessionTimeoutMinutes,omitempty"` - - - // BotChannels - The channels this bot is utilizing - BotChannels *[]string `json:"botChannels,omitempty"` - - - // BotCorrelationId - Id for tracking the activity - this will be returned in the response - BotCorrelationId *string `json:"botCorrelationId,omitempty"` - - - // MessagingPlatformType - If the channels list contains a 'Messaging' item and the messaging platform is known, include it here to get accurate analytics - MessagingPlatformType *string `json:"messagingPlatformType,omitempty"` - - - // AmazonLexRequest - AmazonLexRequest *Amazonlexrequest `json:"amazonLexRequest,omitempty"` - - - // GoogleDialogflow - GoogleDialogflow *Googledialogflowcustomsettings `json:"googleDialogflow,omitempty"` - - - // GenesysBotConnector - GenesysBotConnector *Genesysbotconnector `json:"genesysBotConnector,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Posttextrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/posttextresponse.go b/build/platformclientv2/posttextresponse.go deleted file mode 100644 index 9f3092931..000000000 --- a/build/platformclientv2/posttextresponse.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Posttextresponse -type Posttextresponse struct { - // BotState - The state of the bot after completion of the request - BotState *string `json:"botState,omitempty"` - - - // ReplyMessages - The list of messages to respond with, if any - ReplyMessages *[]Posttextmessage `json:"replyMessages,omitempty"` - - - // IntentName - The name of the intent the bot is either processing or has processed, this will be blank if no intent could be detected. - IntentName *string `json:"intentName,omitempty"` - - - // Slots - Data parameters detected and filled by the bot. - Slots *map[string]string `json:"slots,omitempty"` - - - // BotCorrelationId - The optional ID specified in the request - BotCorrelationId *string `json:"botCorrelationId,omitempty"` - - - // AmazonLex - Raw data response from AWS (if called) - AmazonLex *map[string]interface{} `json:"amazonLex,omitempty"` - - - // GoogleDialogFlow - Raw data response from Google Dialogflow (if called) - GoogleDialogFlow *map[string]interface{} `json:"googleDialogFlow,omitempty"` - - - // GenesysDialogEngine - Raw data response from Genesys' Dialogengine (if called) - GenesysDialogEngine *map[string]interface{} `json:"genesysDialogEngine,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Posttextresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/predictionresults.go b/build/platformclientv2/predictionresults.go deleted file mode 100644 index 35bbc809d..000000000 --- a/build/platformclientv2/predictionresults.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Predictionresults -type Predictionresults struct { - // Intent - Indicates the media type scope of this estimated wait time - Intent *string `json:"intent,omitempty"` - - - // Formula - Indicates the estimated wait time Formula - Formula *string `json:"formula,omitempty"` - - - // EstimatedWaitTimeSeconds - Estimated wait time in seconds - EstimatedWaitTimeSeconds *int `json:"estimatedWaitTimeSeconds,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Predictionresults) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/presenceapi.go b/build/platformclientv2/presenceapi.go deleted file mode 100644 index a0acc1dc7..000000000 --- a/build/platformclientv2/presenceapi.go +++ /dev/null @@ -1,949 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "encoding/json" -) - -// PresenceApi provides functions for API endpoints -type PresenceApi struct { - Configuration *Configuration -} - -// NewPresenceApi creates an API instance using the default configuration -func NewPresenceApi() *PresenceApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating PresenceApi with base path: %s", strings.ToLower(config.BasePath))) - return &PresenceApi{ - Configuration: config, - } -} - -// NewPresenceApiWithConfig creates an API instance using the provided configuration -func NewPresenceApiWithConfig(config *Configuration) *PresenceApi { - config.Debugf("Creating PresenceApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &PresenceApi{ - Configuration: config, - } -} - -// DeletePresencedefinition invokes DELETE /api/v2/presencedefinitions/{presenceId} -// -// Delete a Presence Definition -// -// -func (a PresenceApi) DeletePresencedefinition(presenceId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/presencedefinitions/{presenceId}" - path = strings.Replace(path, "{presenceId}", fmt.Sprintf("%v", presenceId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'presenceId' is set - if &presenceId == nil { - // - return nil, errors.New("Missing required parameter 'presenceId' when calling PresenceApi->DeletePresencedefinition") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// GetPresencedefinition invokes GET /api/v2/presencedefinitions/{presenceId} -// -// Get a Presence Definition -// -// -func (a PresenceApi) GetPresencedefinition(presenceId string, localeCode string) (*Organizationpresence, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/presencedefinitions/{presenceId}" - path = strings.Replace(path, "{presenceId}", fmt.Sprintf("%v", presenceId), -1) - defaultReturn := new(Organizationpresence) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'presenceId' is set - if &presenceId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'presenceId' when calling PresenceApi->GetPresencedefinition") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(localeCode).(string); ok { - if str != "" { - queryParams["localeCode"] = a.Configuration.APIClient.ParameterToString(localeCode, collectionFormat) - } - } else { - queryParams["localeCode"] = a.Configuration.APIClient.ParameterToString(localeCode, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Organizationpresence - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetPresencedefinitions invokes GET /api/v2/presencedefinitions -// -// Get an Organization's list of Presence Definitions -// -// -func (a PresenceApi) GetPresencedefinitions(pageNumber int, pageSize int, deleted string, localeCode string) (*Organizationpresenceentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/presencedefinitions" - defaultReturn := new(Organizationpresenceentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(deleted).(string); ok { - if str != "" { - queryParams["deleted"] = a.Configuration.APIClient.ParameterToString(deleted, collectionFormat) - } - } else { - queryParams["deleted"] = a.Configuration.APIClient.ParameterToString(deleted, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(localeCode).(string); ok { - if str != "" { - queryParams["localeCode"] = a.Configuration.APIClient.ParameterToString(localeCode, collectionFormat) - } - } else { - queryParams["localeCode"] = a.Configuration.APIClient.ParameterToString(localeCode, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Organizationpresenceentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetSystempresences invokes GET /api/v2/systempresences -// -// Get the list of SystemPresences -// -// -func (a PresenceApi) GetSystempresences() ([]Systempresence, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/systempresences" - defaultReturn := make([]Systempresence, 0) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload []Systempresence - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetUserPresence invokes GET /api/v2/users/{userId}/presences/{sourceId} -// -// Get a user's Presence -// -// Get a user's presence for the specified source that is not specifically listed. Used to support custom presence sources. -func (a PresenceApi) GetUserPresence(userId string, sourceId string) (*Userpresence, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/presences/{sourceId}" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - path = strings.Replace(path, "{sourceId}", fmt.Sprintf("%v", sourceId), -1) - defaultReturn := new(Userpresence) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling PresenceApi->GetUserPresence") - } - // verify the required parameter 'sourceId' is set - if &sourceId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'sourceId' when calling PresenceApi->GetUserPresence") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Userpresence - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetUserPresencesMicrosoftteams invokes GET /api/v2/users/{userId}/presences/microsoftteams -// -// Get a user's Microsoft Teams presence. -// -// Gets the presence for a Microsoft Teams user. This will return the Microsoft Teams presence mapped to Genesys Cloud presence with additional activity details in the message field. This presence source is read-only. -func (a PresenceApi) GetUserPresencesMicrosoftteams(userId string) (*Presenceexpand, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/presences/microsoftteams" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Presenceexpand) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling PresenceApi->GetUserPresencesMicrosoftteams") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Presenceexpand - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetUserPresencesPurecloud invokes GET /api/v2/users/{userId}/presences/purecloud -// -// Get a user's Genesys Cloud presence. -// -// Get the default Genesys Cloud user presence source PURECLOUD -func (a PresenceApi) GetUserPresencesPurecloud(userId string) (*Userpresence, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/presences/purecloud" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Userpresence) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling PresenceApi->GetUserPresencesPurecloud") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Userpresence - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchUserPresence invokes PATCH /api/v2/users/{userId}/presences/{sourceId} -// -// Patch a user's Presence -// -// Patch a user's presence for the specified source that is not specifically listed. The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the 'source' defined in the path as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3. -func (a PresenceApi) PatchUserPresence(userId string, sourceId string, body Userpresence) (*Userpresence, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/presences/{sourceId}" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - path = strings.Replace(path, "{sourceId}", fmt.Sprintf("%v", sourceId), -1) - defaultReturn := new(Userpresence) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling PresenceApi->PatchUserPresence") - } - // verify the required parameter 'sourceId' is set - if &sourceId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'sourceId' when calling PresenceApi->PatchUserPresence") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling PresenceApi->PatchUserPresence") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Userpresence - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchUserPresencesPurecloud invokes PATCH /api/v2/users/{userId}/presences/purecloud -// -// Patch a Genesys Cloud user's presence -// -// The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the PURECLOUD source as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3. -func (a PresenceApi) PatchUserPresencesPurecloud(userId string, body Userpresence) (*Userpresence, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/presences/purecloud" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Userpresence) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling PresenceApi->PatchUserPresencesPurecloud") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling PresenceApi->PatchUserPresencesPurecloud") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Userpresence - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostPresencedefinitions invokes POST /api/v2/presencedefinitions -// -// Create a Presence Definition -// -// -func (a PresenceApi) PostPresencedefinitions(body Organizationpresence) (*Organizationpresence, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/presencedefinitions" - defaultReturn := new(Organizationpresence) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling PresenceApi->PostPresencedefinitions") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Organizationpresence - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutPresencedefinition invokes PUT /api/v2/presencedefinitions/{presenceId} -// -// Update a Presence Definition -// -// -func (a PresenceApi) PutPresencedefinition(presenceId string, body Organizationpresence) (*Organizationpresence, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/presencedefinitions/{presenceId}" - path = strings.Replace(path, "{presenceId}", fmt.Sprintf("%v", presenceId), -1) - defaultReturn := new(Organizationpresence) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'presenceId' is set - if &presenceId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'presenceId' when calling PresenceApi->PutPresencedefinition") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling PresenceApi->PutPresencedefinition") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Organizationpresence - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutUsersPresencesBulk invokes PUT /api/v2/users/presences/bulk -// -// Update bulk user Presences -// -// -func (a PresenceApi) PutUsersPresencesBulk(body []Userpresence) ([]Userpresence, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/presences/bulk" - defaultReturn := make([]Userpresence, 0) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // true - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling PresenceApi->PutUsersPresencesBulk") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload []Userpresence - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/presencedefinition.go b/build/platformclientv2/presencedefinition.go deleted file mode 100644 index aa56f5eed..000000000 --- a/build/platformclientv2/presencedefinition.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Presencedefinition -type Presencedefinition struct { - // Id - description - Id *string `json:"id,omitempty"` - - - // SystemPresence - SystemPresence *string `json:"systemPresence,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Presencedefinition) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/presencedetailqueryclause.go b/build/platformclientv2/presencedetailqueryclause.go deleted file mode 100644 index a35619ec4..000000000 --- a/build/platformclientv2/presencedetailqueryclause.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Presencedetailqueryclause -type Presencedetailqueryclause struct { - // VarType - Boolean operation to apply to the provided predicates - VarType *string `json:"type,omitempty"` - - - // Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value). - Predicates *[]Presencedetailquerypredicate `json:"predicates,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Presencedetailqueryclause) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/presencedetailqueryfilter.go b/build/platformclientv2/presencedetailqueryfilter.go deleted file mode 100644 index 52c9d9e3a..000000000 --- a/build/platformclientv2/presencedetailqueryfilter.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Presencedetailqueryfilter -type Presencedetailqueryfilter struct { - // VarType - Boolean operation to apply to the provided predicates and clauses - VarType *string `json:"type,omitempty"` - - - // Clauses - Boolean 'and/or' logic with up to two-levels of nesting - Clauses *[]Presencedetailqueryclause `json:"clauses,omitempty"` - - - // Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value). - Predicates *[]Presencedetailquerypredicate `json:"predicates,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Presencedetailqueryfilter) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/presencedetailquerypredicate.go b/build/platformclientv2/presencedetailquerypredicate.go deleted file mode 100644 index 12b6086c9..000000000 --- a/build/platformclientv2/presencedetailquerypredicate.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Presencedetailquerypredicate -type Presencedetailquerypredicate struct { - // VarType - Optional type, can usually be inferred - VarType *string `json:"type,omitempty"` - - - // Dimension - Left hand side for dimension predicates - Dimension *string `json:"dimension,omitempty"` - - - // Operator - Optional operator, default is matches - Operator *string `json:"operator,omitempty"` - - - // Value - Right hand side for dimension predicates - Value *string `json:"value,omitempty"` - - - // VarRange - Right hand side for dimension predicates - VarRange *Numericrange `json:"range,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Presencedetailquerypredicate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/presenceeventorganizationpresence.go b/build/platformclientv2/presenceeventorganizationpresence.go deleted file mode 100644 index 8339d185f..000000000 --- a/build/platformclientv2/presenceeventorganizationpresence.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Presenceeventorganizationpresence -type Presenceeventorganizationpresence struct { - // Id - Id *string `json:"id,omitempty"` - - - // SystemPresence - SystemPresence *string `json:"systemPresence,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Presenceeventorganizationpresence) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/presenceeventuserpresence.go b/build/platformclientv2/presenceeventuserpresence.go deleted file mode 100644 index c76b6fcbf..000000000 --- a/build/platformclientv2/presenceeventuserpresence.go +++ /dev/null @@ -1,34 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Presenceeventuserpresence -type Presenceeventuserpresence struct { - // Source - Source *string `json:"source,omitempty"` - - - // PresenceDefinition - PresenceDefinition *Presenceeventorganizationpresence `json:"presenceDefinition,omitempty"` - - - // Primary - Primary *bool `json:"primary,omitempty"` - - - // Message - Message *string `json:"message,omitempty"` - - - // ModifiedDate - ModifiedDate *time.Time `json:"modifiedDate,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Presenceeventuserpresence) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/presenceexpand.go b/build/platformclientv2/presenceexpand.go deleted file mode 100644 index 279ef24db..000000000 --- a/build/platformclientv2/presenceexpand.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Presenceexpand -type Presenceexpand struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Presences - An array of user presences - Presences *[]Userpresence `json:"presences,omitempty"` - - - // OutOfOffices - An array of out of office statuses - OutOfOffices *[]Outofoffice `json:"outOfOffices,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Presenceexpand) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/prompt.go b/build/platformclientv2/prompt.go deleted file mode 100644 index dd66caaa9..000000000 --- a/build/platformclientv2/prompt.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Prompt -type Prompt struct { - // Id - The prompt identifier - Id *string `json:"id,omitempty"` - - - // Name - The prompt name. - Name *string `json:"name,omitempty"` - - - // Description - Description *string `json:"description,omitempty"` - - - // Resources - List of resources associated with this prompt - Resources *[]Promptasset `json:"resources,omitempty"` - - - // CurrentOperation - Current prompt operation status - CurrentOperation *Operation `json:"currentOperation,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Prompt) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/promptasset.go b/build/platformclientv2/promptasset.go deleted file mode 100644 index 8f067a36c..000000000 --- a/build/platformclientv2/promptasset.go +++ /dev/null @@ -1,65 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Promptasset -type Promptasset struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // PromptId - Associated prompt ID - PromptId *string `json:"promptId,omitempty"` - - - // Language - Prompt resource language - Language *string `json:"language,omitempty"` - - - // MediaUri - URI of the resource audio - MediaUri *string `json:"mediaUri,omitempty"` - - - // TtsString - Text to speech of the resource - TtsString *string `json:"ttsString,omitempty"` - - - // Text - Text of the resource - Text *string `json:"text,omitempty"` - - - // UploadStatus - Audio upload status - UploadStatus *string `json:"uploadStatus,omitempty"` - - - // UploadUri - Upload URI for the resource audio - UploadUri *string `json:"uploadUri,omitempty"` - - - // LanguageDefault - Whether or not this resource locale is the default for the language - LanguageDefault *bool `json:"languageDefault,omitempty"` - - - // Tags - Tags *map[string][]string `json:"tags,omitempty"` - - - // DurationSeconds - DurationSeconds *float64 `json:"durationSeconds,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Promptasset) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/promptassetcreate.go b/build/platformclientv2/promptassetcreate.go deleted file mode 100644 index 66bf917d2..000000000 --- a/build/platformclientv2/promptassetcreate.go +++ /dev/null @@ -1,65 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Promptassetcreate -type Promptassetcreate struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // PromptId - Associated prompt ID - PromptId *string `json:"promptId,omitempty"` - - - // Language - The prompt language. - Language *string `json:"language,omitempty"` - - - // MediaUri - URI of the resource audio - MediaUri *string `json:"mediaUri,omitempty"` - - - // TtsString - Text to speech of the resource - TtsString *string `json:"ttsString,omitempty"` - - - // Text - Text of the resource - Text *string `json:"text,omitempty"` - - - // UploadStatus - Audio upload status - UploadStatus *string `json:"uploadStatus,omitempty"` - - - // UploadUri - Upload URI for the resource audio - UploadUri *string `json:"uploadUri,omitempty"` - - - // LanguageDefault - Whether or not this resource locale is the default for the language - LanguageDefault *bool `json:"languageDefault,omitempty"` - - - // Tags - Tags *map[string][]string `json:"tags,omitempty"` - - - // DurationSeconds - DurationSeconds *float64 `json:"durationSeconds,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Promptassetcreate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/promptassetentitylisting.go b/build/platformclientv2/promptassetentitylisting.go deleted file mode 100644 index 0d39be8a0..000000000 --- a/build/platformclientv2/promptassetentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Promptassetentitylisting -type Promptassetentitylisting struct { - // Entities - Entities *[]Promptasset `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Promptassetentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/promptentitylisting.go b/build/platformclientv2/promptentitylisting.go deleted file mode 100644 index d2cffe2e1..000000000 --- a/build/platformclientv2/promptentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Promptentitylisting -type Promptentitylisting struct { - // Entities - Entities *[]Prompt `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Promptentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/propertychange.go b/build/platformclientv2/propertychange.go deleted file mode 100644 index 95cb45c60..000000000 --- a/build/platformclientv2/propertychange.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Propertychange -type Propertychange struct { - // Property - The property that was changed - Property *string `json:"property,omitempty"` - - - // OldValues - Previous values for the property. - OldValues *[]string `json:"oldValues,omitempty"` - - - // NewValues - New values for the property. - NewValues *[]string `json:"newValues,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Propertychange) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/propertyindexrequest.go b/build/platformclientv2/propertyindexrequest.go deleted file mode 100644 index 5de808a49..000000000 --- a/build/platformclientv2/propertyindexrequest.go +++ /dev/null @@ -1,26 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Propertyindexrequest -type Propertyindexrequest struct { - // SessionId - Attach properties to a segment in the indicated session - SessionId *string `json:"sessionId,omitempty"` - - - // TargetDate - Attach properties to a segment covering a specific point in time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - TargetDate *time.Time `json:"targetDate,omitempty"` - - - // Properties - The list of properties to index - Properties *[]Analyticsproperty `json:"properties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Propertyindexrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/provisioninfo.go b/build/platformclientv2/provisioninfo.go deleted file mode 100644 index 878257324..000000000 --- a/build/platformclientv2/provisioninfo.go +++ /dev/null @@ -1,26 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Provisioninfo -type Provisioninfo struct { - // Time - The time at which this phone was provisioned. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - Time *time.Time `json:"time,omitempty"` - - - // Source - The source of the provisioning - Source *string `json:"source,omitempty"` - - - // ErrorInfo - The error information from the provision process, if any - ErrorInfo *string `json:"errorInfo,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Provisioninfo) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/publishdraftinput.go b/build/platformclientv2/publishdraftinput.go deleted file mode 100644 index 677b52ce3..000000000 --- a/build/platformclientv2/publishdraftinput.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Publishdraftinput - Draft to be published -type Publishdraftinput struct { - // Version - The current draft version. - Version *int `json:"version,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Publishdraftinput) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/publishedsurveyformreference.go b/build/platformclientv2/publishedsurveyformreference.go deleted file mode 100644 index cef1d0f68..000000000 --- a/build/platformclientv2/publishedsurveyformreference.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Publishedsurveyformreference -type Publishedsurveyformreference struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // ContextId - The context id of this form. - ContextId *string `json:"contextId,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Publishedsurveyformreference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/publishform.go b/build/platformclientv2/publishform.go deleted file mode 100644 index 2fee6b07a..000000000 --- a/build/platformclientv2/publishform.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Publishform -type Publishform struct { - // Published - Is this form published - Published *bool `json:"published,omitempty"` - - - // Id - Unique Id for this version of this form - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Publishform) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/publishprogrampublishjob.go b/build/platformclientv2/publishprogrampublishjob.go deleted file mode 100644 index 7dcc5c2a1..000000000 --- a/build/platformclientv2/publishprogrampublishjob.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Publishprogrampublishjob -type Publishprogrampublishjob struct { - // Id - Id *string `json:"id,omitempty"` - - - // State - State *string `json:"state,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Publishprogrampublishjob) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/publishtopicpublishjob.go b/build/platformclientv2/publishtopicpublishjob.go deleted file mode 100644 index 39a036b62..000000000 --- a/build/platformclientv2/publishtopicpublishjob.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Publishtopicpublishjob -type Publishtopicpublishjob struct { - // Id - Id *string `json:"id,omitempty"` - - - // State - State *string `json:"state,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Publishtopicpublishjob) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/purecloud.go b/build/platformclientv2/purecloud.go deleted file mode 100644 index 94bbadf8a..000000000 --- a/build/platformclientv2/purecloud.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Purecloud -type Purecloud struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Disabled - Disabled *bool `json:"disabled,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Purecloud) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/pureengage.go b/build/platformclientv2/pureengage.go deleted file mode 100644 index 1117217a5..000000000 --- a/build/platformclientv2/pureengage.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Pureengage -type Pureengage struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Disabled - Disabled *bool `json:"disabled,omitempty"` - - - // IssuerURI - IssuerURI *string `json:"issuerURI,omitempty"` - - - // SsoTargetURI - SsoTargetURI *string `json:"ssoTargetURI,omitempty"` - - - // Certificate - Certificate *string `json:"certificate,omitempty"` - - - // Certificates - Certificates *[]string `json:"certificates,omitempty"` - - - // AutoProvisionUsers - AutoProvisionUsers *bool `json:"autoProvisionUsers,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Pureengage) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/qualityapi.go b/build/platformclientv2/qualityapi.go deleted file mode 100644 index 2748b251f..000000000 --- a/build/platformclientv2/qualityapi.go +++ /dev/null @@ -1,5635 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "time" -"encoding/json" -) - -// QualityApi provides functions for API endpoints -type QualityApi struct { - Configuration *Configuration -} - -// NewQualityApi creates an API instance using the default configuration -func NewQualityApi() *QualityApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating QualityApi with base path: %s", strings.ToLower(config.BasePath))) - return &QualityApi{ - Configuration: config, - } -} - -// NewQualityApiWithConfig creates an API instance using the provided configuration -func NewQualityApiWithConfig(config *Configuration) *QualityApi { - config.Debugf("Creating QualityApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &QualityApi{ - Configuration: config, - } -} - -// DeleteQualityCalibration invokes DELETE /api/v2/quality/calibrations/{calibrationId} -// -// Delete a calibration by id. -// -// -func (a QualityApi) DeleteQualityCalibration(calibrationId string, calibratorId string) (*Calibration, *APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/calibrations/{calibrationId}" - path = strings.Replace(path, "{calibrationId}", fmt.Sprintf("%v", calibrationId), -1) - defaultReturn := new(Calibration) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'calibrationId' is set - if &calibrationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'calibrationId' when calling QualityApi->DeleteQualityCalibration") - } - // verify the required parameter 'calibratorId' is set - if &calibratorId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'calibratorId' when calling QualityApi->DeleteQualityCalibration") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(calibratorId).(string); ok { - if str != "" { - queryParams["calibratorId"] = a.Configuration.APIClient.ParameterToString(calibratorId, collectionFormat) - } - } else { - queryParams["calibratorId"] = a.Configuration.APIClient.ParameterToString(calibratorId, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Calibration - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// DeleteQualityConversationEvaluation invokes DELETE /api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId} -// -// Delete an evaluation -// -// -func (a QualityApi) DeleteQualityConversationEvaluation(conversationId string, evaluationId string, expand string) (*Evaluation, *APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId}" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{evaluationId}", fmt.Sprintf("%v", evaluationId), -1) - defaultReturn := new(Evaluation) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling QualityApi->DeleteQualityConversationEvaluation") - } - // verify the required parameter 'evaluationId' is set - if &evaluationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'evaluationId' when calling QualityApi->DeleteQualityConversationEvaluation") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(expand).(string); ok { - if str != "" { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Evaluation - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// DeleteQualityForm invokes DELETE /api/v2/quality/forms/{formId} -// -// Delete an evaluation form. -// -// -func (a QualityApi) DeleteQualityForm(formId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/forms/{formId}" - path = strings.Replace(path, "{formId}", fmt.Sprintf("%v", formId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'formId' is set - if &formId == nil { - // - return nil, errors.New("Missing required parameter 'formId' when calling QualityApi->DeleteQualityForm") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteQualityFormsEvaluation invokes DELETE /api/v2/quality/forms/evaluations/{formId} -// -// Delete an evaluation form. -// -// -func (a QualityApi) DeleteQualityFormsEvaluation(formId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/forms/evaluations/{formId}" - path = strings.Replace(path, "{formId}", fmt.Sprintf("%v", formId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'formId' is set - if &formId == nil { - // - return nil, errors.New("Missing required parameter 'formId' when calling QualityApi->DeleteQualityFormsEvaluation") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteQualityFormsSurvey invokes DELETE /api/v2/quality/forms/surveys/{formId} -// -// Delete a survey form. -// -// -func (a QualityApi) DeleteQualityFormsSurvey(formId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/forms/surveys/{formId}" - path = strings.Replace(path, "{formId}", fmt.Sprintf("%v", formId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'formId' is set - if &formId == nil { - // - return nil, errors.New("Missing required parameter 'formId' when calling QualityApi->DeleteQualityFormsSurvey") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteQualityKeywordset invokes DELETE /api/v2/quality/keywordsets/{keywordSetId} -// -// Delete a keywordSet by id. -// -// -func (a QualityApi) DeleteQualityKeywordset(keywordSetId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/keywordsets/{keywordSetId}" - path = strings.Replace(path, "{keywordSetId}", fmt.Sprintf("%v", keywordSetId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'keywordSetId' is set - if &keywordSetId == nil { - // - return nil, errors.New("Missing required parameter 'keywordSetId' when calling QualityApi->DeleteQualityKeywordset") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteQualityKeywordsets invokes DELETE /api/v2/quality/keywordsets -// -// Delete keyword sets -// -// Bulk delete of keyword sets; this will only delete the keyword sets that match the ids specified in the query param. -func (a QualityApi) DeleteQualityKeywordsets(ids string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/keywordsets" - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'ids' is set - if &ids == nil { - // - return nil, errors.New("Missing required parameter 'ids' when calling QualityApi->DeleteQualityKeywordsets") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(ids).(string); ok { - if str != "" { - queryParams["ids"] = a.Configuration.APIClient.ParameterToString(ids, collectionFormat) - } - } else { - queryParams["ids"] = a.Configuration.APIClient.ParameterToString(ids, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// GetQualityAgentsActivity invokes GET /api/v2/quality/agents/activity -// -// Gets a list of Agent Activities -// -// Including the number of evaluations and average evaluation score -func (a QualityApi) GetQualityAgentsActivity(pageSize int, pageNumber int, sortBy string, expand []string, nextPage string, previousPage string, startTime time.Time, endTime time.Time, agentUserId []string, evaluatorUserId string, name string, group string) (*Agentactivityentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/agents/activity" - defaultReturn := new(Agentactivityentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(nextPage).(string); ok { - if str != "" { - queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) - } - } else { - queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(previousPage).(string); ok { - if str != "" { - queryParams["previousPage"] = a.Configuration.APIClient.ParameterToString(previousPage, collectionFormat) - } - } else { - queryParams["previousPage"] = a.Configuration.APIClient.ParameterToString(previousPage, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(startTime).(string); ok { - if str != "" { - queryParams["startTime"] = a.Configuration.APIClient.ParameterToString(startTime, collectionFormat) - } - } else { - queryParams["startTime"] = a.Configuration.APIClient.ParameterToString(startTime, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(endTime).(string); ok { - if str != "" { - queryParams["endTime"] = a.Configuration.APIClient.ParameterToString(endTime, collectionFormat) - } - } else { - queryParams["endTime"] = a.Configuration.APIClient.ParameterToString(endTime, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range agentUserId { - queryParams["agentUserId"] = value - } - } else { - queryParams["agentUserId"] = a.Configuration.APIClient.ParameterToString(agentUserId, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(evaluatorUserId).(string); ok { - if str != "" { - queryParams["evaluatorUserId"] = a.Configuration.APIClient.ParameterToString(evaluatorUserId, collectionFormat) - } - } else { - queryParams["evaluatorUserId"] = a.Configuration.APIClient.ParameterToString(evaluatorUserId, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(group).(string); ok { - if str != "" { - queryParams["group"] = a.Configuration.APIClient.ParameterToString(group, collectionFormat) - } - } else { - queryParams["group"] = a.Configuration.APIClient.ParameterToString(group, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Agentactivityentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetQualityCalibration invokes GET /api/v2/quality/calibrations/{calibrationId} -// -// Get a calibration by id. Requires either calibrator id or conversation id -// -// -func (a QualityApi) GetQualityCalibration(calibrationId string, calibratorId string, conversationId string) (*Calibration, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/calibrations/{calibrationId}" - path = strings.Replace(path, "{calibrationId}", fmt.Sprintf("%v", calibrationId), -1) - defaultReturn := new(Calibration) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'calibrationId' is set - if &calibrationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'calibrationId' when calling QualityApi->GetQualityCalibration") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(calibratorId).(string); ok { - if str != "" { - queryParams["calibratorId"] = a.Configuration.APIClient.ParameterToString(calibratorId, collectionFormat) - } - } else { - queryParams["calibratorId"] = a.Configuration.APIClient.ParameterToString(calibratorId, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(conversationId).(string); ok { - if str != "" { - queryParams["conversationId"] = a.Configuration.APIClient.ParameterToString(conversationId, collectionFormat) - } - } else { - queryParams["conversationId"] = a.Configuration.APIClient.ParameterToString(conversationId, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Calibration - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetQualityCalibrations invokes GET /api/v2/quality/calibrations -// -// Get the list of calibrations -// -// -func (a QualityApi) GetQualityCalibrations(calibratorId string, pageSize int, pageNumber int, sortBy string, expand []string, nextPage string, previousPage string, conversationId string, startTime time.Time, endTime time.Time) (*Calibrationentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/calibrations" - defaultReturn := new(Calibrationentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'calibratorId' is set - if &calibratorId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'calibratorId' when calling QualityApi->GetQualityCalibrations") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(nextPage).(string); ok { - if str != "" { - queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) - } - } else { - queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(previousPage).(string); ok { - if str != "" { - queryParams["previousPage"] = a.Configuration.APIClient.ParameterToString(previousPage, collectionFormat) - } - } else { - queryParams["previousPage"] = a.Configuration.APIClient.ParameterToString(previousPage, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(conversationId).(string); ok { - if str != "" { - queryParams["conversationId"] = a.Configuration.APIClient.ParameterToString(conversationId, collectionFormat) - } - } else { - queryParams["conversationId"] = a.Configuration.APIClient.ParameterToString(conversationId, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(startTime).(string); ok { - if str != "" { - queryParams["startTime"] = a.Configuration.APIClient.ParameterToString(startTime, collectionFormat) - } - } else { - queryParams["startTime"] = a.Configuration.APIClient.ParameterToString(startTime, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(endTime).(string); ok { - if str != "" { - queryParams["endTime"] = a.Configuration.APIClient.ParameterToString(endTime, collectionFormat) - } - } else { - queryParams["endTime"] = a.Configuration.APIClient.ParameterToString(endTime, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(calibratorId).(string); ok { - if str != "" { - queryParams["calibratorId"] = a.Configuration.APIClient.ParameterToString(calibratorId, collectionFormat) - } - } else { - queryParams["calibratorId"] = a.Configuration.APIClient.ParameterToString(calibratorId, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Calibrationentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetQualityConversationAudits invokes GET /api/v2/quality/conversations/{conversationId}/audits -// -// Get audits for conversation or recording -// -// Different permissions are required for viewing different resource audit entries. The quality:evaluation:viewAudit permission is required to view evaluation audits, the recording:recording:viewAudit permission is required to view recording audits, and so on. -func (a QualityApi) GetQualityConversationAudits(conversationId string, pageSize int, pageNumber int, sortBy string, expand []string, nextPage string, previousPage string, recordingId string, entityType string) (*Qualityauditpage, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/conversations/{conversationId}/audits" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - defaultReturn := new(Qualityauditpage) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling QualityApi->GetQualityConversationAudits") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(nextPage).(string); ok { - if str != "" { - queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) - } - } else { - queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(previousPage).(string); ok { - if str != "" { - queryParams["previousPage"] = a.Configuration.APIClient.ParameterToString(previousPage, collectionFormat) - } - } else { - queryParams["previousPage"] = a.Configuration.APIClient.ParameterToString(previousPage, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(recordingId).(string); ok { - if str != "" { - queryParams["recordingId"] = a.Configuration.APIClient.ParameterToString(recordingId, collectionFormat) - } - } else { - queryParams["recordingId"] = a.Configuration.APIClient.ParameterToString(recordingId, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(entityType).(string); ok { - if str != "" { - queryParams["entityType"] = a.Configuration.APIClient.ParameterToString(entityType, collectionFormat) - } - } else { - queryParams["entityType"] = a.Configuration.APIClient.ParameterToString(entityType, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Qualityauditpage - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetQualityConversationEvaluation invokes GET /api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId} -// -// Get an evaluation -// -// -func (a QualityApi) GetQualityConversationEvaluation(conversationId string, evaluationId string, expand string) (*Evaluation, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId}" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{evaluationId}", fmt.Sprintf("%v", evaluationId), -1) - defaultReturn := new(Evaluation) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling QualityApi->GetQualityConversationEvaluation") - } - // verify the required parameter 'evaluationId' is set - if &evaluationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'evaluationId' when calling QualityApi->GetQualityConversationEvaluation") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(expand).(string); ok { - if str != "" { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Evaluation - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetQualityConversationSurveys invokes GET /api/v2/quality/conversations/{conversationId}/surveys -// -// Get the surveys for a conversation -// -// -func (a QualityApi) GetQualityConversationSurveys(conversationId string) ([]Survey, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/conversations/{conversationId}/surveys" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - defaultReturn := make([]Survey, 0) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling QualityApi->GetQualityConversationSurveys") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload []Survey - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetQualityEvaluationsQuery invokes GET /api/v2/quality/evaluations/query -// -// Queries Evaluations and returns a paged list -// -// Query params must include one of conversationId, evaluatorUserId, or agentUserId -func (a QualityApi) GetQualityEvaluationsQuery(pageSize int, pageNumber int, sortBy string, expand []string, nextPage string, previousPage string, conversationId string, agentUserId string, evaluatorUserId string, queueId string, startTime string, endTime string, evaluationState []string, isReleased bool, agentHasRead bool, expandAnswerTotalScores bool, maximum int, sortOrder string) (*Evaluationentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/evaluations/query" - defaultReturn := new(Evaluationentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(nextPage).(string); ok { - if str != "" { - queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) - } - } else { - queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(previousPage).(string); ok { - if str != "" { - queryParams["previousPage"] = a.Configuration.APIClient.ParameterToString(previousPage, collectionFormat) - } - } else { - queryParams["previousPage"] = a.Configuration.APIClient.ParameterToString(previousPage, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(conversationId).(string); ok { - if str != "" { - queryParams["conversationId"] = a.Configuration.APIClient.ParameterToString(conversationId, collectionFormat) - } - } else { - queryParams["conversationId"] = a.Configuration.APIClient.ParameterToString(conversationId, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(agentUserId).(string); ok { - if str != "" { - queryParams["agentUserId"] = a.Configuration.APIClient.ParameterToString(agentUserId, collectionFormat) - } - } else { - queryParams["agentUserId"] = a.Configuration.APIClient.ParameterToString(agentUserId, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(evaluatorUserId).(string); ok { - if str != "" { - queryParams["evaluatorUserId"] = a.Configuration.APIClient.ParameterToString(evaluatorUserId, collectionFormat) - } - } else { - queryParams["evaluatorUserId"] = a.Configuration.APIClient.ParameterToString(evaluatorUserId, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(queueId).(string); ok { - if str != "" { - queryParams["queueId"] = a.Configuration.APIClient.ParameterToString(queueId, collectionFormat) - } - } else { - queryParams["queueId"] = a.Configuration.APIClient.ParameterToString(queueId, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(startTime).(string); ok { - if str != "" { - queryParams["startTime"] = a.Configuration.APIClient.ParameterToString(startTime, collectionFormat) - } - } else { - queryParams["startTime"] = a.Configuration.APIClient.ParameterToString(startTime, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(endTime).(string); ok { - if str != "" { - queryParams["endTime"] = a.Configuration.APIClient.ParameterToString(endTime, collectionFormat) - } - } else { - queryParams["endTime"] = a.Configuration.APIClient.ParameterToString(endTime, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range evaluationState { - queryParams["evaluationState"] = value - } - } else { - queryParams["evaluationState"] = a.Configuration.APIClient.ParameterToString(evaluationState, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(isReleased).(string); ok { - if str != "" { - queryParams["isReleased"] = a.Configuration.APIClient.ParameterToString(isReleased, collectionFormat) - } - } else { - queryParams["isReleased"] = a.Configuration.APIClient.ParameterToString(isReleased, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(agentHasRead).(string); ok { - if str != "" { - queryParams["agentHasRead"] = a.Configuration.APIClient.ParameterToString(agentHasRead, collectionFormat) - } - } else { - queryParams["agentHasRead"] = a.Configuration.APIClient.ParameterToString(agentHasRead, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(expandAnswerTotalScores).(string); ok { - if str != "" { - queryParams["expandAnswerTotalScores"] = a.Configuration.APIClient.ParameterToString(expandAnswerTotalScores, collectionFormat) - } - } else { - queryParams["expandAnswerTotalScores"] = a.Configuration.APIClient.ParameterToString(expandAnswerTotalScores, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(maximum).(string); ok { - if str != "" { - queryParams["maximum"] = a.Configuration.APIClient.ParameterToString(maximum, collectionFormat) - } - } else { - queryParams["maximum"] = a.Configuration.APIClient.ParameterToString(maximum, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Evaluationentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetQualityEvaluatorsActivity invokes GET /api/v2/quality/evaluators/activity -// -// Get an evaluator activity -// -// -func (a QualityApi) GetQualityEvaluatorsActivity(pageSize int, pageNumber int, sortBy string, expand []string, nextPage string, previousPage string, startTime time.Time, endTime time.Time, name string, permission []string, group string) (*Evaluatoractivityentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/evaluators/activity" - defaultReturn := new(Evaluatoractivityentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(nextPage).(string); ok { - if str != "" { - queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) - } - } else { - queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(previousPage).(string); ok { - if str != "" { - queryParams["previousPage"] = a.Configuration.APIClient.ParameterToString(previousPage, collectionFormat) - } - } else { - queryParams["previousPage"] = a.Configuration.APIClient.ParameterToString(previousPage, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(startTime).(string); ok { - if str != "" { - queryParams["startTime"] = a.Configuration.APIClient.ParameterToString(startTime, collectionFormat) - } - } else { - queryParams["startTime"] = a.Configuration.APIClient.ParameterToString(startTime, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(endTime).(string); ok { - if str != "" { - queryParams["endTime"] = a.Configuration.APIClient.ParameterToString(endTime, collectionFormat) - } - } else { - queryParams["endTime"] = a.Configuration.APIClient.ParameterToString(endTime, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range permission { - queryParams["permission"] = value - } - } else { - queryParams["permission"] = a.Configuration.APIClient.ParameterToString(permission, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(group).(string); ok { - if str != "" { - queryParams["group"] = a.Configuration.APIClient.ParameterToString(group, collectionFormat) - } - } else { - queryParams["group"] = a.Configuration.APIClient.ParameterToString(group, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Evaluatoractivityentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetQualityForm invokes GET /api/v2/quality/forms/{formId} -// -// Get an evaluation form -// -// -func (a QualityApi) GetQualityForm(formId string) (*Evaluationform, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/forms/{formId}" - path = strings.Replace(path, "{formId}", fmt.Sprintf("%v", formId), -1) - defaultReturn := new(Evaluationform) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'formId' is set - if &formId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'formId' when calling QualityApi->GetQualityForm") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Evaluationform - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetQualityFormVersions invokes GET /api/v2/quality/forms/{formId}/versions -// -// Gets all the revisions for a specific evaluation. -// -// -func (a QualityApi) GetQualityFormVersions(formId string, pageSize int, pageNumber int) (*Evaluationformentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/forms/{formId}/versions" - path = strings.Replace(path, "{formId}", fmt.Sprintf("%v", formId), -1) - defaultReturn := new(Evaluationformentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'formId' is set - if &formId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'formId' when calling QualityApi->GetQualityFormVersions") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Evaluationformentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetQualityForms invokes GET /api/v2/quality/forms -// -// Get the list of evaluation forms -// -// -func (a QualityApi) GetQualityForms(pageSize int, pageNumber int, sortBy string, nextPage string, previousPage string, expand string, name string, sortOrder string) (*Evaluationformentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/forms" - defaultReturn := new(Evaluationformentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(nextPage).(string); ok { - if str != "" { - queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) - } - } else { - queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(previousPage).(string); ok { - if str != "" { - queryParams["previousPage"] = a.Configuration.APIClient.ParameterToString(previousPage, collectionFormat) - } - } else { - queryParams["previousPage"] = a.Configuration.APIClient.ParameterToString(previousPage, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(expand).(string); ok { - if str != "" { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Evaluationformentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetQualityFormsEvaluation invokes GET /api/v2/quality/forms/evaluations/{formId} -// -// Get an evaluation form -// -// -func (a QualityApi) GetQualityFormsEvaluation(formId string) (*Evaluationform, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/forms/evaluations/{formId}" - path = strings.Replace(path, "{formId}", fmt.Sprintf("%v", formId), -1) - defaultReturn := new(Evaluationform) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'formId' is set - if &formId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'formId' when calling QualityApi->GetQualityFormsEvaluation") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Evaluationform - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetQualityFormsEvaluationVersions invokes GET /api/v2/quality/forms/evaluations/{formId}/versions -// -// Gets all the revisions for a specific evaluation. -// -// -func (a QualityApi) GetQualityFormsEvaluationVersions(formId string, pageSize int, pageNumber int, sortOrder string) (*Evaluationformentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/forms/evaluations/{formId}/versions" - path = strings.Replace(path, "{formId}", fmt.Sprintf("%v", formId), -1) - defaultReturn := new(Evaluationformentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'formId' is set - if &formId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'formId' when calling QualityApi->GetQualityFormsEvaluationVersions") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Evaluationformentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetQualityFormsEvaluations invokes GET /api/v2/quality/forms/evaluations -// -// Get the list of evaluation forms -// -// -func (a QualityApi) GetQualityFormsEvaluations(pageSize int, pageNumber int, sortBy string, nextPage string, previousPage string, expand string, name string, sortOrder string) (*Evaluationformentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/forms/evaluations" - defaultReturn := new(Evaluationformentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(nextPage).(string); ok { - if str != "" { - queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) - } - } else { - queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(previousPage).(string); ok { - if str != "" { - queryParams["previousPage"] = a.Configuration.APIClient.ParameterToString(previousPage, collectionFormat) - } - } else { - queryParams["previousPage"] = a.Configuration.APIClient.ParameterToString(previousPage, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(expand).(string); ok { - if str != "" { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Evaluationformentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetQualityFormsSurvey invokes GET /api/v2/quality/forms/surveys/{formId} -// -// Get a survey form -// -// -func (a QualityApi) GetQualityFormsSurvey(formId string) (*Surveyform, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/forms/surveys/{formId}" - path = strings.Replace(path, "{formId}", fmt.Sprintf("%v", formId), -1) - defaultReturn := new(Surveyform) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'formId' is set - if &formId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'formId' when calling QualityApi->GetQualityFormsSurvey") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Surveyform - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetQualityFormsSurveyVersions invokes GET /api/v2/quality/forms/surveys/{formId}/versions -// -// Gets all the revisions for a specific survey. -// -// -func (a QualityApi) GetQualityFormsSurveyVersions(formId string, pageSize int, pageNumber int) (*Surveyformentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/forms/surveys/{formId}/versions" - path = strings.Replace(path, "{formId}", fmt.Sprintf("%v", formId), -1) - defaultReturn := new(Surveyformentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'formId' is set - if &formId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'formId' when calling QualityApi->GetQualityFormsSurveyVersions") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Surveyformentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetQualityFormsSurveys invokes GET /api/v2/quality/forms/surveys -// -// Get the list of survey forms -// -// -func (a QualityApi) GetQualityFormsSurveys(pageSize int, pageNumber int, sortBy string, nextPage string, previousPage string, expand string, name string, sortOrder string) (*Surveyformentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/forms/surveys" - defaultReturn := new(Surveyformentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(nextPage).(string); ok { - if str != "" { - queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) - } - } else { - queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(previousPage).(string); ok { - if str != "" { - queryParams["previousPage"] = a.Configuration.APIClient.ParameterToString(previousPage, collectionFormat) - } - } else { - queryParams["previousPage"] = a.Configuration.APIClient.ParameterToString(previousPage, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(expand).(string); ok { - if str != "" { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Surveyformentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetQualityFormsSurveysBulk invokes GET /api/v2/quality/forms/surveys/bulk -// -// Retrieve a list of survey forms by their ids -// -// -func (a QualityApi) GetQualityFormsSurveysBulk(id []string) (*Surveyformentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/forms/surveys/bulk" - defaultReturn := new(Surveyformentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'id' is set - if &id == nil { - // true - return defaultReturn, nil, errors.New("Missing required parameter 'id' when calling QualityApi->GetQualityFormsSurveysBulk") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range id { - queryParams["id"] = value - } - } else { - queryParams["id"] = a.Configuration.APIClient.ParameterToString(id, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Surveyformentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetQualityFormsSurveysBulkContexts invokes GET /api/v2/quality/forms/surveys/bulk/contexts -// -// Retrieve a list of the latest form versions by context ids -// -// -func (a QualityApi) GetQualityFormsSurveysBulkContexts(contextId []string, published bool) (*Surveyformentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/forms/surveys/bulk/contexts" - defaultReturn := new(Surveyformentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'contextId' is set - if &contextId == nil { - // true - return defaultReturn, nil, errors.New("Missing required parameter 'contextId' when calling QualityApi->GetQualityFormsSurveysBulkContexts") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range contextId { - queryParams["contextId"] = value - } - } else { - queryParams["contextId"] = a.Configuration.APIClient.ParameterToString(contextId, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(published).(string); ok { - if str != "" { - queryParams["published"] = a.Configuration.APIClient.ParameterToString(published, collectionFormat) - } - } else { - queryParams["published"] = a.Configuration.APIClient.ParameterToString(published, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Surveyformentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetQualityKeywordset invokes GET /api/v2/quality/keywordsets/{keywordSetId} -// -// Get a keywordSet by id. -// -// -func (a QualityApi) GetQualityKeywordset(keywordSetId string) (*Keywordset, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/keywordsets/{keywordSetId}" - path = strings.Replace(path, "{keywordSetId}", fmt.Sprintf("%v", keywordSetId), -1) - defaultReturn := new(Keywordset) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'keywordSetId' is set - if &keywordSetId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'keywordSetId' when calling QualityApi->GetQualityKeywordset") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Keywordset - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetQualityKeywordsets invokes GET /api/v2/quality/keywordsets -// -// Get the list of keyword sets -// -// -func (a QualityApi) GetQualityKeywordsets(pageSize int, pageNumber int, sortBy string, expand []string, nextPage string, previousPage string, name string, queueId string, agentId string, operator string) (*Keywordsetentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/keywordsets" - defaultReturn := new(Keywordsetentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(nextPage).(string); ok { - if str != "" { - queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) - } - } else { - queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(previousPage).(string); ok { - if str != "" { - queryParams["previousPage"] = a.Configuration.APIClient.ParameterToString(previousPage, collectionFormat) - } - } else { - queryParams["previousPage"] = a.Configuration.APIClient.ParameterToString(previousPage, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(queueId).(string); ok { - if str != "" { - queryParams["queueId"] = a.Configuration.APIClient.ParameterToString(queueId, collectionFormat) - } - } else { - queryParams["queueId"] = a.Configuration.APIClient.ParameterToString(queueId, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(agentId).(string); ok { - if str != "" { - queryParams["agentId"] = a.Configuration.APIClient.ParameterToString(agentId, collectionFormat) - } - } else { - queryParams["agentId"] = a.Configuration.APIClient.ParameterToString(agentId, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(operator).(string); ok { - if str != "" { - queryParams["operator"] = a.Configuration.APIClient.ParameterToString(operator, collectionFormat) - } - } else { - queryParams["operator"] = a.Configuration.APIClient.ParameterToString(operator, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Keywordsetentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetQualityPublishedform invokes GET /api/v2/quality/publishedforms/{formId} -// -// Get the published evaluation forms. -// -// -func (a QualityApi) GetQualityPublishedform(formId string) (*Evaluationform, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/publishedforms/{formId}" - path = strings.Replace(path, "{formId}", fmt.Sprintf("%v", formId), -1) - defaultReturn := new(Evaluationform) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'formId' is set - if &formId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'formId' when calling QualityApi->GetQualityPublishedform") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Evaluationform - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetQualityPublishedforms invokes GET /api/v2/quality/publishedforms -// -// Get the published evaluation forms. -// -// -func (a QualityApi) GetQualityPublishedforms(pageSize int, pageNumber int, name string, onlyLatestPerContext bool) (*Evaluationformentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/publishedforms" - defaultReturn := new(Evaluationformentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(onlyLatestPerContext).(string); ok { - if str != "" { - queryParams["onlyLatestPerContext"] = a.Configuration.APIClient.ParameterToString(onlyLatestPerContext, collectionFormat) - } - } else { - queryParams["onlyLatestPerContext"] = a.Configuration.APIClient.ParameterToString(onlyLatestPerContext, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Evaluationformentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetQualityPublishedformsEvaluation invokes GET /api/v2/quality/publishedforms/evaluations/{formId} -// -// Get the most recent published version of an evaluation form. -// -// -func (a QualityApi) GetQualityPublishedformsEvaluation(formId string) (*Evaluationform, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/publishedforms/evaluations/{formId}" - path = strings.Replace(path, "{formId}", fmt.Sprintf("%v", formId), -1) - defaultReturn := new(Evaluationform) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'formId' is set - if &formId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'formId' when calling QualityApi->GetQualityPublishedformsEvaluation") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Evaluationform - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetQualityPublishedformsEvaluations invokes GET /api/v2/quality/publishedforms/evaluations -// -// Get the published evaluation forms. -// -// -func (a QualityApi) GetQualityPublishedformsEvaluations(pageSize int, pageNumber int, name string, onlyLatestPerContext bool) (*Evaluationformentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/publishedforms/evaluations" - defaultReturn := new(Evaluationformentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(onlyLatestPerContext).(string); ok { - if str != "" { - queryParams["onlyLatestPerContext"] = a.Configuration.APIClient.ParameterToString(onlyLatestPerContext, collectionFormat) - } - } else { - queryParams["onlyLatestPerContext"] = a.Configuration.APIClient.ParameterToString(onlyLatestPerContext, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Evaluationformentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetQualityPublishedformsSurvey invokes GET /api/v2/quality/publishedforms/surveys/{formId} -// -// Get the most recent published version of a survey form. -// -// -func (a QualityApi) GetQualityPublishedformsSurvey(formId string) (*Surveyform, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/publishedforms/surveys/{formId}" - path = strings.Replace(path, "{formId}", fmt.Sprintf("%v", formId), -1) - defaultReturn := new(Surveyform) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'formId' is set - if &formId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'formId' when calling QualityApi->GetQualityPublishedformsSurvey") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Surveyform - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetQualityPublishedformsSurveys invokes GET /api/v2/quality/publishedforms/surveys -// -// Get the published survey forms. -// -// -func (a QualityApi) GetQualityPublishedformsSurveys(pageSize int, pageNumber int, name string, onlyLatestEnabledPerContext bool) (*Surveyformentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/publishedforms/surveys" - defaultReturn := new(Surveyformentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(onlyLatestEnabledPerContext).(string); ok { - if str != "" { - queryParams["onlyLatestEnabledPerContext"] = a.Configuration.APIClient.ParameterToString(onlyLatestEnabledPerContext, collectionFormat) - } - } else { - queryParams["onlyLatestEnabledPerContext"] = a.Configuration.APIClient.ParameterToString(onlyLatestEnabledPerContext, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Surveyformentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetQualitySurvey invokes GET /api/v2/quality/surveys/{surveyId} -// -// Get a survey for a conversation -// -// -func (a QualityApi) GetQualitySurvey(surveyId string) (*Survey, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/surveys/{surveyId}" - path = strings.Replace(path, "{surveyId}", fmt.Sprintf("%v", surveyId), -1) - defaultReturn := new(Survey) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'surveyId' is set - if &surveyId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'surveyId' when calling QualityApi->GetQualitySurvey") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Survey - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetQualitySurveysScorable invokes GET /api/v2/quality/surveys/scorable -// -// Get a survey as an end-customer, for the purposes of scoring it. -// -// -func (a QualityApi) GetQualitySurveysScorable(customerSurveyUrl string) (*Scorablesurvey, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/surveys/scorable" - defaultReturn := new(Scorablesurvey) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'customerSurveyUrl' is set - if &customerSurveyUrl == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'customerSurveyUrl' when calling QualityApi->GetQualitySurveysScorable") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(customerSurveyUrl).(string); ok { - if str != "" { - queryParams["customerSurveyUrl"] = a.Configuration.APIClient.ParameterToString(customerSurveyUrl, collectionFormat) - } - } else { - queryParams["customerSurveyUrl"] = a.Configuration.APIClient.ParameterToString(customerSurveyUrl, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Scorablesurvey - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchQualityFormsSurvey invokes PATCH /api/v2/quality/forms/surveys/{formId} -// -// Disable a particular version of a survey form and invalidates any invitations that have already been sent to customers using this version of the form. -// -// -func (a QualityApi) PatchQualityFormsSurvey(formId string, body Surveyform) (*Surveyform, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/forms/surveys/{formId}" - path = strings.Replace(path, "{formId}", fmt.Sprintf("%v", formId), -1) - defaultReturn := new(Surveyform) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'formId' is set - if &formId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'formId' when calling QualityApi->PatchQualityFormsSurvey") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling QualityApi->PatchQualityFormsSurvey") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Surveyform - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostAnalyticsEvaluationsAggregatesQuery invokes POST /api/v2/analytics/evaluations/aggregates/query -// -// Query for evaluation aggregates -// -// -func (a QualityApi) PostAnalyticsEvaluationsAggregatesQuery(body Evaluationaggregationquery) (*Evaluationaggregatequeryresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/evaluations/aggregates/query" - defaultReturn := new(Evaluationaggregatequeryresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling QualityApi->PostAnalyticsEvaluationsAggregatesQuery") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Evaluationaggregatequeryresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostAnalyticsSurveysAggregatesQuery invokes POST /api/v2/analytics/surveys/aggregates/query -// -// Query for survey aggregates -// -// -func (a QualityApi) PostAnalyticsSurveysAggregatesQuery(body Surveyaggregationquery) (*Surveyaggregatequeryresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/surveys/aggregates/query" - defaultReturn := new(Surveyaggregatequeryresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling QualityApi->PostAnalyticsSurveysAggregatesQuery") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Surveyaggregatequeryresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostQualityCalibrations invokes POST /api/v2/quality/calibrations -// -// Create a calibration -// -// -func (a QualityApi) PostQualityCalibrations(body Calibrationcreate, expand string) (*Calibration, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/calibrations" - defaultReturn := new(Calibration) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling QualityApi->PostQualityCalibrations") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(expand).(string); ok { - if str != "" { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Calibration - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostQualityConversationEvaluations invokes POST /api/v2/quality/conversations/{conversationId}/evaluations -// -// Create an evaluation -// -// -func (a QualityApi) PostQualityConversationEvaluations(conversationId string, body Evaluation, expand string) (*Evaluation, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/conversations/{conversationId}/evaluations" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - defaultReturn := new(Evaluation) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling QualityApi->PostQualityConversationEvaluations") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling QualityApi->PostQualityConversationEvaluations") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(expand).(string); ok { - if str != "" { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Evaluation - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostQualityEvaluationsScoring invokes POST /api/v2/quality/evaluations/scoring -// -// Score evaluation -// -// -func (a QualityApi) PostQualityEvaluationsScoring(body Evaluationformandscoringset) (*Evaluationscoringset, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/evaluations/scoring" - defaultReturn := new(Evaluationscoringset) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling QualityApi->PostQualityEvaluationsScoring") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Evaluationscoringset - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostQualityForms invokes POST /api/v2/quality/forms -// -// Create an evaluation form. -// -// -func (a QualityApi) PostQualityForms(body Evaluationform) (*Evaluationform, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/forms" - defaultReturn := new(Evaluationform) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling QualityApi->PostQualityForms") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Evaluationform - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostQualityFormsEvaluations invokes POST /api/v2/quality/forms/evaluations -// -// Create an evaluation form. -// -// -func (a QualityApi) PostQualityFormsEvaluations(body Evaluationform) (*Evaluationform, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/forms/evaluations" - defaultReturn := new(Evaluationform) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling QualityApi->PostQualityFormsEvaluations") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Evaluationform - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostQualityFormsSurveys invokes POST /api/v2/quality/forms/surveys -// -// Create a survey form. -// -// -func (a QualityApi) PostQualityFormsSurveys(body Surveyform) (*Surveyform, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/forms/surveys" - defaultReturn := new(Surveyform) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling QualityApi->PostQualityFormsSurveys") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Surveyform - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostQualityKeywordsets invokes POST /api/v2/quality/keywordsets -// -// Create a Keyword Set -// -// -func (a QualityApi) PostQualityKeywordsets(body Keywordset, expand string) (*Keywordset, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/keywordsets" - defaultReturn := new(Keywordset) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling QualityApi->PostQualityKeywordsets") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(expand).(string); ok { - if str != "" { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Keywordset - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostQualityPublishedforms invokes POST /api/v2/quality/publishedforms -// -// Publish an evaluation form. -// -// -func (a QualityApi) PostQualityPublishedforms(body Publishform) (*Evaluationform, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/publishedforms" - defaultReturn := new(Evaluationform) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling QualityApi->PostQualityPublishedforms") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Evaluationform - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostQualityPublishedformsEvaluations invokes POST /api/v2/quality/publishedforms/evaluations -// -// Publish an evaluation form. -// -// -func (a QualityApi) PostQualityPublishedformsEvaluations(body Publishform) (*Evaluationform, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/publishedforms/evaluations" - defaultReturn := new(Evaluationform) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling QualityApi->PostQualityPublishedformsEvaluations") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Evaluationform - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostQualityPublishedformsSurveys invokes POST /api/v2/quality/publishedforms/surveys -// -// Publish a survey form. -// -// -func (a QualityApi) PostQualityPublishedformsSurveys(body Publishform) (*Surveyform, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/publishedforms/surveys" - defaultReturn := new(Surveyform) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling QualityApi->PostQualityPublishedformsSurveys") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Surveyform - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostQualitySpotability invokes POST /api/v2/quality/spotability -// -// Retrieve the spotability statistic -// -// -func (a QualityApi) PostQualitySpotability(body Keywordset) (*Keywordset, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/spotability" - defaultReturn := new(Keywordset) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Keywordset - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostQualitySurveysScoring invokes POST /api/v2/quality/surveys/scoring -// -// Score survey -// -// -func (a QualityApi) PostQualitySurveysScoring(body Surveyformandscoringset) (*Surveyscoringset, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/surveys/scoring" - defaultReturn := new(Surveyscoringset) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling QualityApi->PostQualitySurveysScoring") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Surveyscoringset - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutQualityCalibration invokes PUT /api/v2/quality/calibrations/{calibrationId} -// -// Update a calibration to the specified calibration via PUT. Editable fields include: evaluators, expertEvaluator, and scoringIndex -// -// -func (a QualityApi) PutQualityCalibration(calibrationId string, body Calibration) (*Calibration, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/calibrations/{calibrationId}" - path = strings.Replace(path, "{calibrationId}", fmt.Sprintf("%v", calibrationId), -1) - defaultReturn := new(Calibration) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'calibrationId' is set - if &calibrationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'calibrationId' when calling QualityApi->PutQualityCalibration") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling QualityApi->PutQualityCalibration") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Calibration - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutQualityConversationEvaluation invokes PUT /api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId} -// -// Update an evaluation -// -// The quality:evaluation:edit permission allows modification of most fields, while the quality:evaluation:editScore permission allows an evaluator to change just the question scores, and the quality:evaluation:editAgentSignoff permission allows an agent to change the agent comments and sign off on the evaluation. -func (a QualityApi) PutQualityConversationEvaluation(conversationId string, evaluationId string, body Evaluation, expand string) (*Evaluation, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId}" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{evaluationId}", fmt.Sprintf("%v", evaluationId), -1) - defaultReturn := new(Evaluation) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling QualityApi->PutQualityConversationEvaluation") - } - // verify the required parameter 'evaluationId' is set - if &evaluationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'evaluationId' when calling QualityApi->PutQualityConversationEvaluation") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling QualityApi->PutQualityConversationEvaluation") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(expand).(string); ok { - if str != "" { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Evaluation - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutQualityForm invokes PUT /api/v2/quality/forms/{formId} -// -// Update an evaluation form. -// -// -func (a QualityApi) PutQualityForm(formId string, body Evaluationform) (*Evaluationform, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/forms/{formId}" - path = strings.Replace(path, "{formId}", fmt.Sprintf("%v", formId), -1) - defaultReturn := new(Evaluationform) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'formId' is set - if &formId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'formId' when calling QualityApi->PutQualityForm") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling QualityApi->PutQualityForm") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Evaluationform - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutQualityFormsEvaluation invokes PUT /api/v2/quality/forms/evaluations/{formId} -// -// Update an evaluation form. -// -// -func (a QualityApi) PutQualityFormsEvaluation(formId string, body Evaluationform) (*Evaluationform, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/forms/evaluations/{formId}" - path = strings.Replace(path, "{formId}", fmt.Sprintf("%v", formId), -1) - defaultReturn := new(Evaluationform) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'formId' is set - if &formId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'formId' when calling QualityApi->PutQualityFormsEvaluation") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling QualityApi->PutQualityFormsEvaluation") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Evaluationform - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutQualityFormsSurvey invokes PUT /api/v2/quality/forms/surveys/{formId} -// -// Update a survey form. -// -// -func (a QualityApi) PutQualityFormsSurvey(formId string, body Surveyform) (*Surveyform, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/forms/surveys/{formId}" - path = strings.Replace(path, "{formId}", fmt.Sprintf("%v", formId), -1) - defaultReturn := new(Surveyform) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'formId' is set - if &formId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'formId' when calling QualityApi->PutQualityFormsSurvey") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling QualityApi->PutQualityFormsSurvey") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Surveyform - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutQualityKeywordset invokes PUT /api/v2/quality/keywordsets/{keywordSetId} -// -// Update a keywordSet to the specified keywordSet via PUT. -// -// -func (a QualityApi) PutQualityKeywordset(keywordSetId string, body Keywordset) (*Keywordset, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/keywordsets/{keywordSetId}" - path = strings.Replace(path, "{keywordSetId}", fmt.Sprintf("%v", keywordSetId), -1) - defaultReturn := new(Keywordset) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'keywordSetId' is set - if &keywordSetId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'keywordSetId' when calling QualityApi->PutQualityKeywordset") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling QualityApi->PutQualityKeywordset") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Keywordset - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutQualitySurveysScorable invokes PUT /api/v2/quality/surveys/scorable -// -// Update a survey as an end-customer, for the purposes of scoring it. -// -// -func (a QualityApi) PutQualitySurveysScorable(body Scorablesurvey, customerSurveyUrl string) (*Scorablesurvey, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/quality/surveys/scorable" - defaultReturn := new(Scorablesurvey) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling QualityApi->PutQualitySurveysScorable") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(customerSurveyUrl).(string); ok { - if str != "" { - queryParams["customerSurveyUrl"] = a.Configuration.APIClient.ParameterToString(customerSurveyUrl, collectionFormat) - } - } else { - queryParams["customerSurveyUrl"] = a.Configuration.APIClient.ParameterToString(customerSurveyUrl, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Scorablesurvey - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/qualityaudit.go b/build/platformclientv2/qualityaudit.go deleted file mode 100644 index 49ae90b5c..000000000 --- a/build/platformclientv2/qualityaudit.go +++ /dev/null @@ -1,61 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Qualityaudit -type Qualityaudit struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // User - User *User `json:"user,omitempty"` - - - // JobId - JobId *string `json:"jobId,omitempty"` - - - // Level - Level *string `json:"level,omitempty"` - - - // Entity - Entity *Auditentity `json:"entity,omitempty"` - - - // Timestamp - Timestamp *string `json:"timestamp,omitempty"` - - - // Action - Action *string `json:"action,omitempty"` - - - // Status - Status *string `json:"status,omitempty"` - - - // Changes - Changes *[]Change `json:"changes,omitempty"` - - - // EntityType - EntityType *string `json:"entityType,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Qualityaudit) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/qualityauditpage.go b/build/platformclientv2/qualityauditpage.go deleted file mode 100644 index 4b5227efb..000000000 --- a/build/platformclientv2/qualityauditpage.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Qualityauditpage -type Qualityauditpage struct { - // Entities - Entities *[]Qualityaudit `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Qualityauditpage) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/querydivision.go b/build/platformclientv2/querydivision.go deleted file mode 100644 index 2b314bf66..000000000 --- a/build/platformclientv2/querydivision.go +++ /dev/null @@ -1,13 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Querydivision -type Querydivision struct { } - -// String returns a JSON representation of the model -func (o *Querydivision) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queryfacetinfo.go b/build/platformclientv2/queryfacetinfo.go deleted file mode 100644 index 40b9c0488..000000000 --- a/build/platformclientv2/queryfacetinfo.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queryfacetinfo -type Queryfacetinfo struct { - // Attributes - Attributes *[]Facetkeyattribute `json:"attributes,omitempty"` - - - // Facets - Facets *[]Facetentry `json:"facets,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queryfacetinfo) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queryrequest.go b/build/platformclientv2/queryrequest.go deleted file mode 100644 index 3684a8e01..000000000 --- a/build/platformclientv2/queryrequest.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queryrequest -type Queryrequest struct { - // QueryPhrase - QueryPhrase *string `json:"queryPhrase,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // FacetNameRequests - FacetNameRequests *[]string `json:"facetNameRequests,omitempty"` - - - // Sort - Sort *[]Sortitem `json:"sort,omitempty"` - - - // Filters - Filters *[]Contentfilteritem `json:"filters,omitempty"` - - - // AttributeFilters - AttributeFilters *[]Attributefilteritem `json:"attributeFilters,omitempty"` - - - // IncludeShares - IncludeShares *bool `json:"includeShares,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queryrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queryrequestclause.go b/build/platformclientv2/queryrequestclause.go deleted file mode 100644 index 15559de56..000000000 --- a/build/platformclientv2/queryrequestclause.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queryrequestclause -type Queryrequestclause struct { - // VarType - The logic used to combine the predicates - VarType *string `json:"type,omitempty"` - - - // Predicates - The list of predicates used to filter the data - Predicates *[]Queryrequestpredicate `json:"predicates,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queryrequestclause) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queryrequestfilter.go b/build/platformclientv2/queryrequestfilter.go deleted file mode 100644 index 928677d50..000000000 --- a/build/platformclientv2/queryrequestfilter.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queryrequestfilter -type Queryrequestfilter struct { - // VarType - The logic used to combine the clauses - VarType *string `json:"type,omitempty"` - - - // Clauses - The list of clauses used to filter the data - Clauses *[]Queryrequestclause `json:"clauses,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queryrequestfilter) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queryrequestpredicate.go b/build/platformclientv2/queryrequestpredicate.go deleted file mode 100644 index 3cf7f4753..000000000 --- a/build/platformclientv2/queryrequestpredicate.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queryrequestpredicate -type Queryrequestpredicate struct { - // Dimension - The dimension to be filtered - Dimension *string `json:"dimension,omitempty"` - - - // Value - The value to filter by - Value *string `json:"value,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queryrequestpredicate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queryresponsedata.go b/build/platformclientv2/queryresponsedata.go deleted file mode 100644 index a130ec391..000000000 --- a/build/platformclientv2/queryresponsedata.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queryresponsedata -type Queryresponsedata struct { - // Interval - Interval with start and end represented as ISO-8601 string. i.e: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'/yyyy-MM-dd'T'HH:mm:ss.SSS'Z' - Interval *string `json:"interval,omitempty"` - - - // Metrics - A list of aggregated metrics - Metrics *[]Queryresponsemetric `json:"metrics,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queryresponsedata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queryresponsegroupeddata.go b/build/platformclientv2/queryresponsegroupeddata.go deleted file mode 100644 index cb9695dbe..000000000 --- a/build/platformclientv2/queryresponsegroupeddata.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queryresponsegroupeddata -type Queryresponsegroupeddata struct { - // Group - The group values for this data - Group *map[string]string `json:"group,omitempty"` - - - // Data - The metrics in this group - Data *[]Queryresponsedata `json:"data,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queryresponsegroupeddata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queryresponsemetric.go b/build/platformclientv2/queryresponsemetric.go deleted file mode 100644 index 62da47c7f..000000000 --- a/build/platformclientv2/queryresponsemetric.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queryresponsemetric -type Queryresponsemetric struct { - // Metric - The metric this applies to - Metric *string `json:"metric,omitempty"` - - - // Stats - The aggregated values for this metric - Stats *Queryresponsestats `json:"stats,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queryresponsemetric) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queryresponsestats.go b/build/platformclientv2/queryresponsestats.go deleted file mode 100644 index 895da1aac..000000000 --- a/build/platformclientv2/queryresponsestats.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queryresponsestats -type Queryresponsestats struct { - // Count - The count for this metric - Count *int `json:"count,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queryresponsestats) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queryresult.go b/build/platformclientv2/queryresult.go deleted file mode 100644 index bfd3938d2..000000000 --- a/build/platformclientv2/queryresult.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queryresult -type Queryresult struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Body - Body *Domainentity `json:"body,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queryresult) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queryresults.go b/build/platformclientv2/queryresults.go deleted file mode 100644 index 954bb87df..000000000 --- a/build/platformclientv2/queryresults.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queryresults -type Queryresults struct { - // Results - Results *Domainentitylistingqueryresult `json:"results,omitempty"` - - - // FacetInfo - FacetInfo *Queryfacetinfo `json:"facetInfo,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queryresults) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queue.go b/build/platformclientv2/queue.go deleted file mode 100644 index 34c85c004..000000000 --- a/build/platformclientv2/queue.go +++ /dev/null @@ -1,114 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queue -type Queue struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Division - The division to which this entity belongs. - Division *Division `json:"division,omitempty"` - - - // Description - The queue description. - Description *string `json:"description,omitempty"` - - - // DateCreated - The date the queue was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - The date of the last modification to the queue. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // ModifiedBy - The ID of the user that last modified the queue. - ModifiedBy *string `json:"modifiedBy,omitempty"` - - - // CreatedBy - The ID of the user that created the queue. - CreatedBy *string `json:"createdBy,omitempty"` - - - // MemberCount - The number of users in the queue. - MemberCount *int `json:"memberCount,omitempty"` - - - // MediaSettings - The media settings for the queue. Valid key values: CALL, CALLBACK, CHAT, EMAIL, MESSAGE, SOCIAL_EXPRESSION, VIDEO_COMM - MediaSettings *map[string]Mediasetting `json:"mediaSettings,omitempty"` - - - // RoutingRules - The routing rules for the queue, used for routing to known or preferred agents. - RoutingRules *[]Routingrule `json:"routingRules,omitempty"` - - - // Bullseye - The bulls-eye settings for the queue. - Bullseye *Bullseye `json:"bullseye,omitempty"` - - - // AcwSettings - The ACW settings for the queue. - AcwSettings *Acwsettings `json:"acwSettings,omitempty"` - - - // SkillEvaluationMethod - The skill evaluation method to use when routing conversations. - SkillEvaluationMethod *string `json:"skillEvaluationMethod,omitempty"` - - - // QueueFlow - The in-queue flow to use for conversations waiting in queue. - QueueFlow *Domainentityref `json:"queueFlow,omitempty"` - - - // WhisperPrompt - The prompt used for whisper on the queue, if configured. - WhisperPrompt *Domainentityref `json:"whisperPrompt,omitempty"` - - - // AutoAnswerOnly - Specifies whether the configured whisper should play for all ACD calls, or only for those which are auto-answered. - AutoAnswerOnly *bool `json:"autoAnswerOnly,omitempty"` - - - // EnableTranscription - Indicates whether voice transcription is enabled for this queue. - EnableTranscription *bool `json:"enableTranscription,omitempty"` - - - // EnableManualAssignment - Indicates whether manual assignment is enabled for this queue. - EnableManualAssignment *bool `json:"enableManualAssignment,omitempty"` - - - // CallingPartyName - The name to use for caller identification for outbound calls from this queue. - CallingPartyName *string `json:"callingPartyName,omitempty"` - - - // CallingPartyNumber - The phone number to use for caller identification for outbound calls from this queue. - CallingPartyNumber *string `json:"callingPartyNumber,omitempty"` - - - // DefaultScripts - The default script Ids for the communication types. - DefaultScripts *map[string]Script `json:"defaultScripts,omitempty"` - - - // OutboundMessagingAddresses - The messaging addresses for the queue. - OutboundMessagingAddresses *Queuemessagingaddresses `json:"outboundMessagingAddresses,omitempty"` - - - // OutboundEmailAddress - OutboundEmailAddress *Queueemailaddress `json:"outboundEmailAddress,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queue) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationcallbackeventtopiccallbackconversation.go b/build/platformclientv2/queueconversationcallbackeventtopiccallbackconversation.go deleted file mode 100644 index 0b51ce0f1..000000000 --- a/build/platformclientv2/queueconversationcallbackeventtopiccallbackconversation.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationcallbackeventtopiccallbackconversation -type Queueconversationcallbackeventtopiccallbackconversation struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Participants - Participants *[]Queueconversationcallbackeventtopiccallbackmediaparticipant `json:"participants,omitempty"` - - - // OtherMediaUris - OtherMediaUris *[]string `json:"otherMediaUris,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationcallbackeventtopiccallbackconversation) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationcallbackeventtopiccallbackmediaparticipant.go b/build/platformclientv2/queueconversationcallbackeventtopiccallbackmediaparticipant.go deleted file mode 100644 index e70b658f4..000000000 --- a/build/platformclientv2/queueconversationcallbackeventtopiccallbackmediaparticipant.go +++ /dev/null @@ -1,186 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queueconversationcallbackeventtopiccallbackmediaparticipant -type Queueconversationcallbackeventtopiccallbackmediaparticipant struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Address - Address *string `json:"address,omitempty"` - - - // StartTime - StartTime *time.Time `json:"startTime,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // EndTime - EndTime *time.Time `json:"endTime,omitempty"` - - - // StartHoldTime - StartHoldTime *time.Time `json:"startHoldTime,omitempty"` - - - // Purpose - Purpose *string `json:"purpose,omitempty"` - - - // State - State *string `json:"state,omitempty"` - - - // Direction - Direction *string `json:"direction,omitempty"` - - - // DisconnectType - DisconnectType *string `json:"disconnectType,omitempty"` - - - // Held - Held *bool `json:"held,omitempty"` - - - // WrapupRequired - WrapupRequired *bool `json:"wrapupRequired,omitempty"` - - - // WrapupPrompt - WrapupPrompt *string `json:"wrapupPrompt,omitempty"` - - - // User - User *Queueconversationcallbackeventtopicurireference `json:"user,omitempty"` - - - // Queue - Queue *Queueconversationcallbackeventtopicurireference `json:"queue,omitempty"` - - - // Team - Team *Queueconversationcallbackeventtopicurireference `json:"team,omitempty"` - - - // Attributes - Attributes *map[string]string `json:"attributes,omitempty"` - - - // ErrorInfo - ErrorInfo *Queueconversationcallbackeventtopicerrorbody `json:"errorInfo,omitempty"` - - - // Script - Script *Queueconversationcallbackeventtopicurireference `json:"script,omitempty"` - - - // WrapupTimeoutMs - WrapupTimeoutMs *int `json:"wrapupTimeoutMs,omitempty"` - - - // WrapupSkipped - WrapupSkipped *bool `json:"wrapupSkipped,omitempty"` - - - // AlertingTimeoutMs - AlertingTimeoutMs *int `json:"alertingTimeoutMs,omitempty"` - - - // Provider - Provider *string `json:"provider,omitempty"` - - - // ExternalContact - ExternalContact *Queueconversationcallbackeventtopicurireference `json:"externalContact,omitempty"` - - - // ExternalOrganization - ExternalOrganization *Queueconversationcallbackeventtopicurireference `json:"externalOrganization,omitempty"` - - - // Wrapup - Wrapup *Queueconversationcallbackeventtopicwrapup `json:"wrapup,omitempty"` - - - // ConversationRoutingData - ConversationRoutingData *Queueconversationcallbackeventtopicconversationroutingdata `json:"conversationRoutingData,omitempty"` - - - // Peer - Peer *string `json:"peer,omitempty"` - - - // ScreenRecordingState - ScreenRecordingState *string `json:"screenRecordingState,omitempty"` - - - // FlaggedReason - FlaggedReason *string `json:"flaggedReason,omitempty"` - - - // JourneyContext - JourneyContext *Queueconversationcallbackeventtopicjourneycontext `json:"journeyContext,omitempty"` - - - // StartAcwTime - StartAcwTime *time.Time `json:"startAcwTime,omitempty"` - - - // EndAcwTime - EndAcwTime *time.Time `json:"endAcwTime,omitempty"` - - - // OutboundPreview - OutboundPreview *Queueconversationcallbackeventtopicdialerpreview `json:"outboundPreview,omitempty"` - - - // Voicemail - Voicemail *Queueconversationcallbackeventtopicvoicemail `json:"voicemail,omitempty"` - - - // CallbackNumbers - CallbackNumbers *[]string `json:"callbackNumbers,omitempty"` - - - // CallbackUserName - CallbackUserName *string `json:"callbackUserName,omitempty"` - - - // SkipEnabled - SkipEnabled *bool `json:"skipEnabled,omitempty"` - - - // ExternalCampaign - ExternalCampaign *bool `json:"externalCampaign,omitempty"` - - - // TimeoutSeconds - TimeoutSeconds *int `json:"timeoutSeconds,omitempty"` - - - // CallbackScheduledTime - CallbackScheduledTime *time.Time `json:"callbackScheduledTime,omitempty"` - - - // AutomatedCallbackConfigId - AutomatedCallbackConfigId *string `json:"automatedCallbackConfigId,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationcallbackeventtopiccallbackmediaparticipant) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationcallbackeventtopicconversationroutingdata.go b/build/platformclientv2/queueconversationcallbackeventtopicconversationroutingdata.go deleted file mode 100644 index 4c041dfe1..000000000 --- a/build/platformclientv2/queueconversationcallbackeventtopicconversationroutingdata.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationcallbackeventtopicconversationroutingdata -type Queueconversationcallbackeventtopicconversationroutingdata struct { - // Queue - Queue *Queueconversationcallbackeventtopicurireference `json:"queue,omitempty"` - - - // Language - Language *Queueconversationcallbackeventtopicurireference `json:"language,omitempty"` - - - // Priority - Priority *int `json:"priority,omitempty"` - - - // Skills - Skills *[]Queueconversationcallbackeventtopicurireference `json:"skills,omitempty"` - - - // ScoredAgents - ScoredAgents *[]Queueconversationcallbackeventtopicscoredagent `json:"scoredAgents,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationcallbackeventtopicconversationroutingdata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationcallbackeventtopicdetail.go b/build/platformclientv2/queueconversationcallbackeventtopicdetail.go deleted file mode 100644 index b5e95004d..000000000 --- a/build/platformclientv2/queueconversationcallbackeventtopicdetail.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationcallbackeventtopicdetail -type Queueconversationcallbackeventtopicdetail struct { - // ErrorCode - ErrorCode *string `json:"errorCode,omitempty"` - - - // FieldName - FieldName *string `json:"fieldName,omitempty"` - - - // EntityId - EntityId *string `json:"entityId,omitempty"` - - - // EntityName - EntityName *string `json:"entityName,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationcallbackeventtopicdetail) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationcallbackeventtopicdialerpreview.go b/build/platformclientv2/queueconversationcallbackeventtopicdialerpreview.go deleted file mode 100644 index fcd005fdd..000000000 --- a/build/platformclientv2/queueconversationcallbackeventtopicdialerpreview.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationcallbackeventtopicdialerpreview -type Queueconversationcallbackeventtopicdialerpreview struct { - // Id - Id *string `json:"id,omitempty"` - - - // ContactId - ContactId *string `json:"contactId,omitempty"` - - - // ContactListId - ContactListId *string `json:"contactListId,omitempty"` - - - // CampaignId - CampaignId *string `json:"campaignId,omitempty"` - - - // PhoneNumberColumns - PhoneNumberColumns *[]Queueconversationcallbackeventtopicphonenumbercolumn `json:"phoneNumberColumns,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationcallbackeventtopicdialerpreview) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationcallbackeventtopicerrorbody.go b/build/platformclientv2/queueconversationcallbackeventtopicerrorbody.go deleted file mode 100644 index ee95153b6..000000000 --- a/build/platformclientv2/queueconversationcallbackeventtopicerrorbody.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationcallbackeventtopicerrorbody -type Queueconversationcallbackeventtopicerrorbody struct { - // Status - Status *int `json:"status,omitempty"` - - - // Code - Code *string `json:"code,omitempty"` - - - // EntityId - EntityId *string `json:"entityId,omitempty"` - - - // EntityName - EntityName *string `json:"entityName,omitempty"` - - - // Message - Message *string `json:"message,omitempty"` - - - // MessageWithParams - MessageWithParams *string `json:"messageWithParams,omitempty"` - - - // MessageParams - MessageParams *map[string]string `json:"messageParams,omitempty"` - - - // ContextId - ContextId *string `json:"contextId,omitempty"` - - - // Details - Details *[]Queueconversationcallbackeventtopicdetail `json:"details,omitempty"` - - - // Errors - Errors *[]Queueconversationcallbackeventtopicerrorbody `json:"errors,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationcallbackeventtopicerrorbody) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationcallbackeventtopicjourneyaction.go b/build/platformclientv2/queueconversationcallbackeventtopicjourneyaction.go deleted file mode 100644 index 7d98d5e7c..000000000 --- a/build/platformclientv2/queueconversationcallbackeventtopicjourneyaction.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationcallbackeventtopicjourneyaction -type Queueconversationcallbackeventtopicjourneyaction struct { - // Id - Id *string `json:"id,omitempty"` - - - // ActionMap - ActionMap *Queueconversationcallbackeventtopicjourneyactionmap `json:"actionMap,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationcallbackeventtopicjourneyaction) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationcallbackeventtopicjourneyactionmap.go b/build/platformclientv2/queueconversationcallbackeventtopicjourneyactionmap.go deleted file mode 100644 index 0978ea3ee..000000000 --- a/build/platformclientv2/queueconversationcallbackeventtopicjourneyactionmap.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationcallbackeventtopicjourneyactionmap -type Queueconversationcallbackeventtopicjourneyactionmap struct { - // Id - Id *string `json:"id,omitempty"` - - - // Version - Version *int `json:"version,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationcallbackeventtopicjourneyactionmap) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationcallbackeventtopicjourneycontext.go b/build/platformclientv2/queueconversationcallbackeventtopicjourneycontext.go deleted file mode 100644 index ab093999d..000000000 --- a/build/platformclientv2/queueconversationcallbackeventtopicjourneycontext.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationcallbackeventtopicjourneycontext -type Queueconversationcallbackeventtopicjourneycontext struct { - // Customer - Customer *Queueconversationcallbackeventtopicjourneycustomer `json:"customer,omitempty"` - - - // CustomerSession - CustomerSession *Queueconversationcallbackeventtopicjourneycustomersession `json:"customerSession,omitempty"` - - - // TriggeringAction - TriggeringAction *Queueconversationcallbackeventtopicjourneyaction `json:"triggeringAction,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationcallbackeventtopicjourneycontext) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationcallbackeventtopicjourneycustomer.go b/build/platformclientv2/queueconversationcallbackeventtopicjourneycustomer.go deleted file mode 100644 index 69ebabdfe..000000000 --- a/build/platformclientv2/queueconversationcallbackeventtopicjourneycustomer.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationcallbackeventtopicjourneycustomer -type Queueconversationcallbackeventtopicjourneycustomer struct { - // Id - Id *string `json:"id,omitempty"` - - - // IdType - IdType *string `json:"idType,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationcallbackeventtopicjourneycustomer) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationcallbackeventtopicjourneycustomersession.go b/build/platformclientv2/queueconversationcallbackeventtopicjourneycustomersession.go deleted file mode 100644 index 0d1f22f35..000000000 --- a/build/platformclientv2/queueconversationcallbackeventtopicjourneycustomersession.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationcallbackeventtopicjourneycustomersession -type Queueconversationcallbackeventtopicjourneycustomersession struct { - // Id - Id *string `json:"id,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationcallbackeventtopicjourneycustomersession) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationcallbackeventtopicphonenumbercolumn.go b/build/platformclientv2/queueconversationcallbackeventtopicphonenumbercolumn.go deleted file mode 100644 index be46021f6..000000000 --- a/build/platformclientv2/queueconversationcallbackeventtopicphonenumbercolumn.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationcallbackeventtopicphonenumbercolumn -type Queueconversationcallbackeventtopicphonenumbercolumn struct { - // ColumnName - ColumnName *string `json:"columnName,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationcallbackeventtopicphonenumbercolumn) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationcallbackeventtopicscoredagent.go b/build/platformclientv2/queueconversationcallbackeventtopicscoredagent.go deleted file mode 100644 index 0c9722b12..000000000 --- a/build/platformclientv2/queueconversationcallbackeventtopicscoredagent.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationcallbackeventtopicscoredagent -type Queueconversationcallbackeventtopicscoredagent struct { - // Agent - Agent *Queueconversationcallbackeventtopicurireference `json:"agent,omitempty"` - - - // Score - Score *int `json:"score,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationcallbackeventtopicscoredagent) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationcallbackeventtopicurireference.go b/build/platformclientv2/queueconversationcallbackeventtopicurireference.go deleted file mode 100644 index f082f55c3..000000000 --- a/build/platformclientv2/queueconversationcallbackeventtopicurireference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationcallbackeventtopicurireference -type Queueconversationcallbackeventtopicurireference struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationcallbackeventtopicurireference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationcallbackeventtopicvoicemail.go b/build/platformclientv2/queueconversationcallbackeventtopicvoicemail.go deleted file mode 100644 index 2770ba45a..000000000 --- a/build/platformclientv2/queueconversationcallbackeventtopicvoicemail.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationcallbackeventtopicvoicemail -type Queueconversationcallbackeventtopicvoicemail struct { - // Id - Id *string `json:"id,omitempty"` - - - // UploadStatus - UploadStatus *string `json:"uploadStatus,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationcallbackeventtopicvoicemail) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationcallbackeventtopicwrapup.go b/build/platformclientv2/queueconversationcallbackeventtopicwrapup.go deleted file mode 100644 index 3a1efc05e..000000000 --- a/build/platformclientv2/queueconversationcallbackeventtopicwrapup.go +++ /dev/null @@ -1,38 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queueconversationcallbackeventtopicwrapup -type Queueconversationcallbackeventtopicwrapup struct { - // Code - Code *string `json:"code,omitempty"` - - - // Notes - Notes *string `json:"notes,omitempty"` - - - // Tags - Tags *[]string `json:"tags,omitempty"` - - - // DurationSeconds - DurationSeconds *int `json:"durationSeconds,omitempty"` - - - // EndTime - EndTime *time.Time `json:"endTime,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationcallbackeventtopicwrapup) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationcalleventtopiccallconversation.go b/build/platformclientv2/queueconversationcalleventtopiccallconversation.go deleted file mode 100644 index 6ba7914b1..000000000 --- a/build/platformclientv2/queueconversationcalleventtopiccallconversation.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationcalleventtopiccallconversation -type Queueconversationcalleventtopiccallconversation struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Participants - Participants *[]Queueconversationcalleventtopiccallmediaparticipant `json:"participants,omitempty"` - - - // OtherMediaUris - OtherMediaUris *[]string `json:"otherMediaUris,omitempty"` - - - // RecordingState - RecordingState *string `json:"recordingState,omitempty"` - - - // MaxParticipants - MaxParticipants *int `json:"maxParticipants,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationcalleventtopiccallconversation) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationcalleventtopiccallmediaparticipant.go b/build/platformclientv2/queueconversationcalleventtopiccallmediaparticipant.go deleted file mode 100644 index 585bc611f..000000000 --- a/build/platformclientv2/queueconversationcalleventtopiccallmediaparticipant.go +++ /dev/null @@ -1,194 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queueconversationcalleventtopiccallmediaparticipant -type Queueconversationcalleventtopiccallmediaparticipant struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Address - Address *string `json:"address,omitempty"` - - - // StartTime - StartTime *time.Time `json:"startTime,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // EndTime - EndTime *time.Time `json:"endTime,omitempty"` - - - // StartHoldTime - StartHoldTime *time.Time `json:"startHoldTime,omitempty"` - - - // Purpose - Purpose *string `json:"purpose,omitempty"` - - - // State - State *string `json:"state,omitempty"` - - - // Direction - Direction *string `json:"direction,omitempty"` - - - // DisconnectType - DisconnectType *string `json:"disconnectType,omitempty"` - - - // Held - Held *bool `json:"held,omitempty"` - - - // WrapupRequired - WrapupRequired *bool `json:"wrapupRequired,omitempty"` - - - // WrapupPrompt - WrapupPrompt *string `json:"wrapupPrompt,omitempty"` - - - // User - User *Queueconversationcalleventtopicurireference `json:"user,omitempty"` - - - // Queue - Queue *Queueconversationcalleventtopicurireference `json:"queue,omitempty"` - - - // Team - Team *Queueconversationcalleventtopicurireference `json:"team,omitempty"` - - - // Attributes - Attributes *map[string]string `json:"attributes,omitempty"` - - - // ErrorInfo - ErrorInfo *Queueconversationcalleventtopicerrorbody `json:"errorInfo,omitempty"` - - - // Script - Script *Queueconversationcalleventtopicurireference `json:"script,omitempty"` - - - // WrapupTimeoutMs - WrapupTimeoutMs *int `json:"wrapupTimeoutMs,omitempty"` - - - // WrapupSkipped - WrapupSkipped *bool `json:"wrapupSkipped,omitempty"` - - - // AlertingTimeoutMs - AlertingTimeoutMs *int `json:"alertingTimeoutMs,omitempty"` - - - // Provider - Provider *string `json:"provider,omitempty"` - - - // ExternalContact - ExternalContact *Queueconversationcalleventtopicurireference `json:"externalContact,omitempty"` - - - // ExternalOrganization - ExternalOrganization *Queueconversationcalleventtopicurireference `json:"externalOrganization,omitempty"` - - - // Wrapup - Wrapup *Queueconversationcalleventtopicwrapup `json:"wrapup,omitempty"` - - - // ConversationRoutingData - ConversationRoutingData *Queueconversationcalleventtopicconversationroutingdata `json:"conversationRoutingData,omitempty"` - - - // Peer - Peer *string `json:"peer,omitempty"` - - - // ScreenRecordingState - ScreenRecordingState *string `json:"screenRecordingState,omitempty"` - - - // FlaggedReason - FlaggedReason *string `json:"flaggedReason,omitempty"` - - - // JourneyContext - JourneyContext *Queueconversationcalleventtopicjourneycontext `json:"journeyContext,omitempty"` - - - // StartAcwTime - StartAcwTime *time.Time `json:"startAcwTime,omitempty"` - - - // EndAcwTime - EndAcwTime *time.Time `json:"endAcwTime,omitempty"` - - - // Muted - Muted *bool `json:"muted,omitempty"` - - - // Confined - Confined *bool `json:"confined,omitempty"` - - - // Recording - Recording *bool `json:"recording,omitempty"` - - - // RecordingState - RecordingState *string `json:"recordingState,omitempty"` - - - // Group - Group *Queueconversationcalleventtopicurireference `json:"group,omitempty"` - - - // Ani - Ani *string `json:"ani,omitempty"` - - - // Dnis - Dnis *string `json:"dnis,omitempty"` - - - // DocumentId - DocumentId *string `json:"documentId,omitempty"` - - - // MonitoredParticipantId - MonitoredParticipantId *string `json:"monitoredParticipantId,omitempty"` - - - // ConsultParticipantId - ConsultParticipantId *string `json:"consultParticipantId,omitempty"` - - - // FaxStatus - FaxStatus *Queueconversationcalleventtopicfaxstatus `json:"faxStatus,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationcalleventtopiccallmediaparticipant) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationcalleventtopicconversationroutingdata.go b/build/platformclientv2/queueconversationcalleventtopicconversationroutingdata.go deleted file mode 100644 index 532fce270..000000000 --- a/build/platformclientv2/queueconversationcalleventtopicconversationroutingdata.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationcalleventtopicconversationroutingdata -type Queueconversationcalleventtopicconversationroutingdata struct { - // Queue - Queue *Queueconversationcalleventtopicurireference `json:"queue,omitempty"` - - - // Language - Language *Queueconversationcalleventtopicurireference `json:"language,omitempty"` - - - // Priority - Priority *int `json:"priority,omitempty"` - - - // Skills - Skills *[]Queueconversationcalleventtopicurireference `json:"skills,omitempty"` - - - // ScoredAgents - ScoredAgents *[]Queueconversationcalleventtopicscoredagent `json:"scoredAgents,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationcalleventtopicconversationroutingdata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationcalleventtopicdetail.go b/build/platformclientv2/queueconversationcalleventtopicdetail.go deleted file mode 100644 index e3ab7a659..000000000 --- a/build/platformclientv2/queueconversationcalleventtopicdetail.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationcalleventtopicdetail -type Queueconversationcalleventtopicdetail struct { - // ErrorCode - ErrorCode *string `json:"errorCode,omitempty"` - - - // FieldName - FieldName *string `json:"fieldName,omitempty"` - - - // EntityId - EntityId *string `json:"entityId,omitempty"` - - - // EntityName - EntityName *string `json:"entityName,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationcalleventtopicdetail) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationcalleventtopicerrorbody.go b/build/platformclientv2/queueconversationcalleventtopicerrorbody.go deleted file mode 100644 index 87dc85385..000000000 --- a/build/platformclientv2/queueconversationcalleventtopicerrorbody.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationcalleventtopicerrorbody -type Queueconversationcalleventtopicerrorbody struct { - // Status - Status *int `json:"status,omitempty"` - - - // Code - Code *string `json:"code,omitempty"` - - - // EntityId - EntityId *string `json:"entityId,omitempty"` - - - // EntityName - EntityName *string `json:"entityName,omitempty"` - - - // Message - Message *string `json:"message,omitempty"` - - - // MessageWithParams - MessageWithParams *string `json:"messageWithParams,omitempty"` - - - // MessageParams - MessageParams *map[string]string `json:"messageParams,omitempty"` - - - // ContextId - ContextId *string `json:"contextId,omitempty"` - - - // Details - Details *[]Queueconversationcalleventtopicdetail `json:"details,omitempty"` - - - // Errors - Errors *[]Queueconversationcalleventtopicerrorbody `json:"errors,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationcalleventtopicerrorbody) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationcalleventtopicfaxstatus.go b/build/platformclientv2/queueconversationcalleventtopicfaxstatus.go deleted file mode 100644 index 6eb4c25c4..000000000 --- a/build/platformclientv2/queueconversationcalleventtopicfaxstatus.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationcalleventtopicfaxstatus -type Queueconversationcalleventtopicfaxstatus struct { - // Direction - Direction *string `json:"direction,omitempty"` - - - // ExpectedPages - ExpectedPages *int `json:"expectedPages,omitempty"` - - - // ActivePage - ActivePage *int `json:"activePage,omitempty"` - - - // LinesTransmitted - LinesTransmitted *int `json:"linesTransmitted,omitempty"` - - - // BytesTransmitted - BytesTransmitted *int `json:"bytesTransmitted,omitempty"` - - - // DataRate - DataRate *int `json:"dataRate,omitempty"` - - - // PageErrors - PageErrors *int `json:"pageErrors,omitempty"` - - - // LineErrors - LineErrors *int `json:"lineErrors,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationcalleventtopicfaxstatus) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationcalleventtopicjourneyaction.go b/build/platformclientv2/queueconversationcalleventtopicjourneyaction.go deleted file mode 100644 index 59d2d71cf..000000000 --- a/build/platformclientv2/queueconversationcalleventtopicjourneyaction.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationcalleventtopicjourneyaction -type Queueconversationcalleventtopicjourneyaction struct { - // Id - Id *string `json:"id,omitempty"` - - - // ActionMap - ActionMap *Queueconversationcalleventtopicjourneyactionmap `json:"actionMap,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationcalleventtopicjourneyaction) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationcalleventtopicjourneyactionmap.go b/build/platformclientv2/queueconversationcalleventtopicjourneyactionmap.go deleted file mode 100644 index 1e975313c..000000000 --- a/build/platformclientv2/queueconversationcalleventtopicjourneyactionmap.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationcalleventtopicjourneyactionmap -type Queueconversationcalleventtopicjourneyactionmap struct { - // Id - Id *string `json:"id,omitempty"` - - - // Version - Version *int `json:"version,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationcalleventtopicjourneyactionmap) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationcalleventtopicjourneycontext.go b/build/platformclientv2/queueconversationcalleventtopicjourneycontext.go deleted file mode 100644 index e54bae322..000000000 --- a/build/platformclientv2/queueconversationcalleventtopicjourneycontext.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationcalleventtopicjourneycontext -type Queueconversationcalleventtopicjourneycontext struct { - // Customer - Customer *Queueconversationcalleventtopicjourneycustomer `json:"customer,omitempty"` - - - // CustomerSession - CustomerSession *Queueconversationcalleventtopicjourneycustomersession `json:"customerSession,omitempty"` - - - // TriggeringAction - TriggeringAction *Queueconversationcalleventtopicjourneyaction `json:"triggeringAction,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationcalleventtopicjourneycontext) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationcalleventtopicjourneycustomer.go b/build/platformclientv2/queueconversationcalleventtopicjourneycustomer.go deleted file mode 100644 index 0230e4c58..000000000 --- a/build/platformclientv2/queueconversationcalleventtopicjourneycustomer.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationcalleventtopicjourneycustomer -type Queueconversationcalleventtopicjourneycustomer struct { - // Id - Id *string `json:"id,omitempty"` - - - // IdType - IdType *string `json:"idType,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationcalleventtopicjourneycustomer) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationcalleventtopicjourneycustomersession.go b/build/platformclientv2/queueconversationcalleventtopicjourneycustomersession.go deleted file mode 100644 index 97535d8fe..000000000 --- a/build/platformclientv2/queueconversationcalleventtopicjourneycustomersession.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationcalleventtopicjourneycustomersession -type Queueconversationcalleventtopicjourneycustomersession struct { - // Id - Id *string `json:"id,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationcalleventtopicjourneycustomersession) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationcalleventtopicscoredagent.go b/build/platformclientv2/queueconversationcalleventtopicscoredagent.go deleted file mode 100644 index 11287f5e8..000000000 --- a/build/platformclientv2/queueconversationcalleventtopicscoredagent.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationcalleventtopicscoredagent -type Queueconversationcalleventtopicscoredagent struct { - // Agent - Agent *Queueconversationcalleventtopicurireference `json:"agent,omitempty"` - - - // Score - Score *int `json:"score,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationcalleventtopicscoredagent) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationcalleventtopicurireference.go b/build/platformclientv2/queueconversationcalleventtopicurireference.go deleted file mode 100644 index bc20f5fbd..000000000 --- a/build/platformclientv2/queueconversationcalleventtopicurireference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationcalleventtopicurireference -type Queueconversationcalleventtopicurireference struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationcalleventtopicurireference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationcalleventtopicwrapup.go b/build/platformclientv2/queueconversationcalleventtopicwrapup.go deleted file mode 100644 index 384c9662e..000000000 --- a/build/platformclientv2/queueconversationcalleventtopicwrapup.go +++ /dev/null @@ -1,38 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queueconversationcalleventtopicwrapup -type Queueconversationcalleventtopicwrapup struct { - // Code - Code *string `json:"code,omitempty"` - - - // Notes - Notes *string `json:"notes,omitempty"` - - - // Tags - Tags *[]string `json:"tags,omitempty"` - - - // DurationSeconds - DurationSeconds *int `json:"durationSeconds,omitempty"` - - - // EndTime - EndTime *time.Time `json:"endTime,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationcalleventtopicwrapup) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationchateventtopicchatconversation.go b/build/platformclientv2/queueconversationchateventtopicchatconversation.go deleted file mode 100644 index 59662e35e..000000000 --- a/build/platformclientv2/queueconversationchateventtopicchatconversation.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationchateventtopicchatconversation -type Queueconversationchateventtopicchatconversation struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Participants - Participants *[]Queueconversationchateventtopicchatmediaparticipant `json:"participants,omitempty"` - - - // OtherMediaUris - OtherMediaUris *[]string `json:"otherMediaUris,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationchateventtopicchatconversation) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationchateventtopicchatmediaparticipant.go b/build/platformclientv2/queueconversationchateventtopicchatmediaparticipant.go deleted file mode 100644 index eb30ce825..000000000 --- a/build/platformclientv2/queueconversationchateventtopicchatmediaparticipant.go +++ /dev/null @@ -1,158 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queueconversationchateventtopicchatmediaparticipant -type Queueconversationchateventtopicchatmediaparticipant struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Address - Address *string `json:"address,omitempty"` - - - // StartTime - StartTime *time.Time `json:"startTime,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // EndTime - EndTime *time.Time `json:"endTime,omitempty"` - - - // StartHoldTime - StartHoldTime *time.Time `json:"startHoldTime,omitempty"` - - - // Purpose - Purpose *string `json:"purpose,omitempty"` - - - // State - State *string `json:"state,omitempty"` - - - // Direction - Direction *string `json:"direction,omitempty"` - - - // DisconnectType - DisconnectType *string `json:"disconnectType,omitempty"` - - - // Held - Held *bool `json:"held,omitempty"` - - - // WrapupRequired - WrapupRequired *bool `json:"wrapupRequired,omitempty"` - - - // WrapupPrompt - WrapupPrompt *string `json:"wrapupPrompt,omitempty"` - - - // User - User *Queueconversationchateventtopicurireference `json:"user,omitempty"` - - - // Queue - Queue *Queueconversationchateventtopicurireference `json:"queue,omitempty"` - - - // Team - Team *Queueconversationchateventtopicurireference `json:"team,omitempty"` - - - // Attributes - Attributes *map[string]string `json:"attributes,omitempty"` - - - // ErrorInfo - ErrorInfo *Queueconversationchateventtopicerrorbody `json:"errorInfo,omitempty"` - - - // Script - Script *Queueconversationchateventtopicurireference `json:"script,omitempty"` - - - // WrapupTimeoutMs - WrapupTimeoutMs *int `json:"wrapupTimeoutMs,omitempty"` - - - // WrapupSkipped - WrapupSkipped *bool `json:"wrapupSkipped,omitempty"` - - - // AlertingTimeoutMs - AlertingTimeoutMs *int `json:"alertingTimeoutMs,omitempty"` - - - // Provider - Provider *string `json:"provider,omitempty"` - - - // ExternalContact - ExternalContact *Queueconversationchateventtopicurireference `json:"externalContact,omitempty"` - - - // ExternalOrganization - ExternalOrganization *Queueconversationchateventtopicurireference `json:"externalOrganization,omitempty"` - - - // Wrapup - Wrapup *Queueconversationchateventtopicwrapup `json:"wrapup,omitempty"` - - - // ConversationRoutingData - ConversationRoutingData *Queueconversationchateventtopicconversationroutingdata `json:"conversationRoutingData,omitempty"` - - - // Peer - Peer *string `json:"peer,omitempty"` - - - // ScreenRecordingState - ScreenRecordingState *string `json:"screenRecordingState,omitempty"` - - - // FlaggedReason - FlaggedReason *string `json:"flaggedReason,omitempty"` - - - // JourneyContext - JourneyContext *Queueconversationchateventtopicjourneycontext `json:"journeyContext,omitempty"` - - - // StartAcwTime - StartAcwTime *time.Time `json:"startAcwTime,omitempty"` - - - // EndAcwTime - EndAcwTime *time.Time `json:"endAcwTime,omitempty"` - - - // RoomId - RoomId *string `json:"roomId,omitempty"` - - - // AvatarImageUrl - AvatarImageUrl *string `json:"avatarImageUrl,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationchateventtopicchatmediaparticipant) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationchateventtopicconversationroutingdata.go b/build/platformclientv2/queueconversationchateventtopicconversationroutingdata.go deleted file mode 100644 index c09190f34..000000000 --- a/build/platformclientv2/queueconversationchateventtopicconversationroutingdata.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationchateventtopicconversationroutingdata -type Queueconversationchateventtopicconversationroutingdata struct { - // Queue - Queue *Queueconversationchateventtopicurireference `json:"queue,omitempty"` - - - // Language - Language *Queueconversationchateventtopicurireference `json:"language,omitempty"` - - - // Priority - Priority *int `json:"priority,omitempty"` - - - // Skills - Skills *[]Queueconversationchateventtopicurireference `json:"skills,omitempty"` - - - // ScoredAgents - ScoredAgents *[]Queueconversationchateventtopicscoredagent `json:"scoredAgents,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationchateventtopicconversationroutingdata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationchateventtopicdetail.go b/build/platformclientv2/queueconversationchateventtopicdetail.go deleted file mode 100644 index 004128f0b..000000000 --- a/build/platformclientv2/queueconversationchateventtopicdetail.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationchateventtopicdetail -type Queueconversationchateventtopicdetail struct { - // ErrorCode - ErrorCode *string `json:"errorCode,omitempty"` - - - // FieldName - FieldName *string `json:"fieldName,omitempty"` - - - // EntityId - EntityId *string `json:"entityId,omitempty"` - - - // EntityName - EntityName *string `json:"entityName,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationchateventtopicdetail) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationchateventtopicerrorbody.go b/build/platformclientv2/queueconversationchateventtopicerrorbody.go deleted file mode 100644 index 0a354c76c..000000000 --- a/build/platformclientv2/queueconversationchateventtopicerrorbody.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationchateventtopicerrorbody -type Queueconversationchateventtopicerrorbody struct { - // Status - Status *int `json:"status,omitempty"` - - - // Code - Code *string `json:"code,omitempty"` - - - // EntityId - EntityId *string `json:"entityId,omitempty"` - - - // EntityName - EntityName *string `json:"entityName,omitempty"` - - - // Message - Message *string `json:"message,omitempty"` - - - // MessageWithParams - MessageWithParams *string `json:"messageWithParams,omitempty"` - - - // MessageParams - MessageParams *map[string]string `json:"messageParams,omitempty"` - - - // ContextId - ContextId *string `json:"contextId,omitempty"` - - - // Details - Details *[]Queueconversationchateventtopicdetail `json:"details,omitempty"` - - - // Errors - Errors *[]Queueconversationchateventtopicerrorbody `json:"errors,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationchateventtopicerrorbody) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationchateventtopicjourneyaction.go b/build/platformclientv2/queueconversationchateventtopicjourneyaction.go deleted file mode 100644 index 9de675412..000000000 --- a/build/platformclientv2/queueconversationchateventtopicjourneyaction.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationchateventtopicjourneyaction -type Queueconversationchateventtopicjourneyaction struct { - // Id - Id *string `json:"id,omitempty"` - - - // ActionMap - ActionMap *Queueconversationchateventtopicjourneyactionmap `json:"actionMap,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationchateventtopicjourneyaction) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationchateventtopicjourneyactionmap.go b/build/platformclientv2/queueconversationchateventtopicjourneyactionmap.go deleted file mode 100644 index 7a8a2b124..000000000 --- a/build/platformclientv2/queueconversationchateventtopicjourneyactionmap.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationchateventtopicjourneyactionmap -type Queueconversationchateventtopicjourneyactionmap struct { - // Id - Id *string `json:"id,omitempty"` - - - // Version - Version *int `json:"version,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationchateventtopicjourneyactionmap) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationchateventtopicjourneycontext.go b/build/platformclientv2/queueconversationchateventtopicjourneycontext.go deleted file mode 100644 index 68baf1af3..000000000 --- a/build/platformclientv2/queueconversationchateventtopicjourneycontext.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationchateventtopicjourneycontext -type Queueconversationchateventtopicjourneycontext struct { - // Customer - Customer *Queueconversationchateventtopicjourneycustomer `json:"customer,omitempty"` - - - // CustomerSession - CustomerSession *Queueconversationchateventtopicjourneycustomersession `json:"customerSession,omitempty"` - - - // TriggeringAction - TriggeringAction *Queueconversationchateventtopicjourneyaction `json:"triggeringAction,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationchateventtopicjourneycontext) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationchateventtopicjourneycustomer.go b/build/platformclientv2/queueconversationchateventtopicjourneycustomer.go deleted file mode 100644 index 233b3c61d..000000000 --- a/build/platformclientv2/queueconversationchateventtopicjourneycustomer.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationchateventtopicjourneycustomer -type Queueconversationchateventtopicjourneycustomer struct { - // Id - Id *string `json:"id,omitempty"` - - - // IdType - IdType *string `json:"idType,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationchateventtopicjourneycustomer) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationchateventtopicjourneycustomersession.go b/build/platformclientv2/queueconversationchateventtopicjourneycustomersession.go deleted file mode 100644 index 74a3a4a99..000000000 --- a/build/platformclientv2/queueconversationchateventtopicjourneycustomersession.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationchateventtopicjourneycustomersession -type Queueconversationchateventtopicjourneycustomersession struct { - // Id - Id *string `json:"id,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationchateventtopicjourneycustomersession) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationchateventtopicscoredagent.go b/build/platformclientv2/queueconversationchateventtopicscoredagent.go deleted file mode 100644 index a7333bd17..000000000 --- a/build/platformclientv2/queueconversationchateventtopicscoredagent.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationchateventtopicscoredagent -type Queueconversationchateventtopicscoredagent struct { - // Agent - Agent *Queueconversationchateventtopicurireference `json:"agent,omitempty"` - - - // Score - Score *int `json:"score,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationchateventtopicscoredagent) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationchateventtopicurireference.go b/build/platformclientv2/queueconversationchateventtopicurireference.go deleted file mode 100644 index 577d6bf7b..000000000 --- a/build/platformclientv2/queueconversationchateventtopicurireference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationchateventtopicurireference -type Queueconversationchateventtopicurireference struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationchateventtopicurireference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationchateventtopicwrapup.go b/build/platformclientv2/queueconversationchateventtopicwrapup.go deleted file mode 100644 index d119a7d58..000000000 --- a/build/platformclientv2/queueconversationchateventtopicwrapup.go +++ /dev/null @@ -1,38 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queueconversationchateventtopicwrapup -type Queueconversationchateventtopicwrapup struct { - // Code - Code *string `json:"code,omitempty"` - - - // Notes - Notes *string `json:"notes,omitempty"` - - - // Tags - Tags *[]string `json:"tags,omitempty"` - - - // DurationSeconds - DurationSeconds *int `json:"durationSeconds,omitempty"` - - - // EndTime - EndTime *time.Time `json:"endTime,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationchateventtopicwrapup) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationcobrowseeventtopiccobrowseconversation.go b/build/platformclientv2/queueconversationcobrowseeventtopiccobrowseconversation.go deleted file mode 100644 index 4bbb2abf8..000000000 --- a/build/platformclientv2/queueconversationcobrowseeventtopiccobrowseconversation.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationcobrowseeventtopiccobrowseconversation -type Queueconversationcobrowseeventtopiccobrowseconversation struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Participants - Participants *[]Queueconversationcobrowseeventtopiccobrowsemediaparticipant `json:"participants,omitempty"` - - - // OtherMediaUris - OtherMediaUris *[]string `json:"otherMediaUris,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationcobrowseeventtopiccobrowseconversation) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationcobrowseeventtopiccobrowsemediaparticipant.go b/build/platformclientv2/queueconversationcobrowseeventtopiccobrowsemediaparticipant.go deleted file mode 100644 index ec400129a..000000000 --- a/build/platformclientv2/queueconversationcobrowseeventtopiccobrowsemediaparticipant.go +++ /dev/null @@ -1,170 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queueconversationcobrowseeventtopiccobrowsemediaparticipant -type Queueconversationcobrowseeventtopiccobrowsemediaparticipant struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Address - Address *string `json:"address,omitempty"` - - - // StartTime - StartTime *time.Time `json:"startTime,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // EndTime - EndTime *time.Time `json:"endTime,omitempty"` - - - // StartHoldTime - StartHoldTime *time.Time `json:"startHoldTime,omitempty"` - - - // Purpose - Purpose *string `json:"purpose,omitempty"` - - - // State - State *string `json:"state,omitempty"` - - - // Direction - Direction *string `json:"direction,omitempty"` - - - // DisconnectType - DisconnectType *string `json:"disconnectType,omitempty"` - - - // Held - Held *bool `json:"held,omitempty"` - - - // WrapupRequired - WrapupRequired *bool `json:"wrapupRequired,omitempty"` - - - // WrapupPrompt - WrapupPrompt *string `json:"wrapupPrompt,omitempty"` - - - // User - User *Queueconversationcobrowseeventtopicurireference `json:"user,omitempty"` - - - // Queue - Queue *Queueconversationcobrowseeventtopicurireference `json:"queue,omitempty"` - - - // Team - Team *Queueconversationcobrowseeventtopicurireference `json:"team,omitempty"` - - - // Attributes - Attributes *map[string]string `json:"attributes,omitempty"` - - - // ErrorInfo - ErrorInfo *Queueconversationcobrowseeventtopicerrorbody `json:"errorInfo,omitempty"` - - - // Script - Script *Queueconversationcobrowseeventtopicurireference `json:"script,omitempty"` - - - // WrapupTimeoutMs - WrapupTimeoutMs *int `json:"wrapupTimeoutMs,omitempty"` - - - // WrapupSkipped - WrapupSkipped *bool `json:"wrapupSkipped,omitempty"` - - - // AlertingTimeoutMs - AlertingTimeoutMs *int `json:"alertingTimeoutMs,omitempty"` - - - // Provider - Provider *string `json:"provider,omitempty"` - - - // ExternalContact - ExternalContact *Queueconversationcobrowseeventtopicurireference `json:"externalContact,omitempty"` - - - // ExternalOrganization - ExternalOrganization *Queueconversationcobrowseeventtopicurireference `json:"externalOrganization,omitempty"` - - - // Wrapup - Wrapup *Queueconversationcobrowseeventtopicwrapup `json:"wrapup,omitempty"` - - - // ConversationRoutingData - ConversationRoutingData *Queueconversationcobrowseeventtopicconversationroutingdata `json:"conversationRoutingData,omitempty"` - - - // Peer - Peer *string `json:"peer,omitempty"` - - - // ScreenRecordingState - ScreenRecordingState *string `json:"screenRecordingState,omitempty"` - - - // FlaggedReason - FlaggedReason *string `json:"flaggedReason,omitempty"` - - - // JourneyContext - JourneyContext *Queueconversationcobrowseeventtopicjourneycontext `json:"journeyContext,omitempty"` - - - // StartAcwTime - StartAcwTime *time.Time `json:"startAcwTime,omitempty"` - - - // EndAcwTime - EndAcwTime *time.Time `json:"endAcwTime,omitempty"` - - - // CobrowseSessionId - CobrowseSessionId *string `json:"cobrowseSessionId,omitempty"` - - - // CobrowseRole - CobrowseRole *string `json:"cobrowseRole,omitempty"` - - - // ViewerUrl - ViewerUrl *string `json:"viewerUrl,omitempty"` - - - // ProviderEventTime - ProviderEventTime *time.Time `json:"providerEventTime,omitempty"` - - - // Controlling - Controlling *[]string `json:"controlling,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationcobrowseeventtopiccobrowsemediaparticipant) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationcobrowseeventtopicconversationroutingdata.go b/build/platformclientv2/queueconversationcobrowseeventtopicconversationroutingdata.go deleted file mode 100644 index 2bcf7a078..000000000 --- a/build/platformclientv2/queueconversationcobrowseeventtopicconversationroutingdata.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationcobrowseeventtopicconversationroutingdata -type Queueconversationcobrowseeventtopicconversationroutingdata struct { - // Queue - Queue *Queueconversationcobrowseeventtopicurireference `json:"queue,omitempty"` - - - // Language - Language *Queueconversationcobrowseeventtopicurireference `json:"language,omitempty"` - - - // Priority - Priority *int `json:"priority,omitempty"` - - - // Skills - Skills *[]Queueconversationcobrowseeventtopicurireference `json:"skills,omitempty"` - - - // ScoredAgents - ScoredAgents *[]Queueconversationcobrowseeventtopicscoredagent `json:"scoredAgents,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationcobrowseeventtopicconversationroutingdata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationcobrowseeventtopicdetail.go b/build/platformclientv2/queueconversationcobrowseeventtopicdetail.go deleted file mode 100644 index 769e69526..000000000 --- a/build/platformclientv2/queueconversationcobrowseeventtopicdetail.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationcobrowseeventtopicdetail -type Queueconversationcobrowseeventtopicdetail struct { - // ErrorCode - ErrorCode *string `json:"errorCode,omitempty"` - - - // FieldName - FieldName *string `json:"fieldName,omitempty"` - - - // EntityId - EntityId *string `json:"entityId,omitempty"` - - - // EntityName - EntityName *string `json:"entityName,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationcobrowseeventtopicdetail) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationcobrowseeventtopicerrorbody.go b/build/platformclientv2/queueconversationcobrowseeventtopicerrorbody.go deleted file mode 100644 index 518d25d30..000000000 --- a/build/platformclientv2/queueconversationcobrowseeventtopicerrorbody.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationcobrowseeventtopicerrorbody -type Queueconversationcobrowseeventtopicerrorbody struct { - // Status - Status *int `json:"status,omitempty"` - - - // Code - Code *string `json:"code,omitempty"` - - - // EntityId - EntityId *string `json:"entityId,omitempty"` - - - // EntityName - EntityName *string `json:"entityName,omitempty"` - - - // Message - Message *string `json:"message,omitempty"` - - - // MessageWithParams - MessageWithParams *string `json:"messageWithParams,omitempty"` - - - // MessageParams - MessageParams *map[string]string `json:"messageParams,omitempty"` - - - // ContextId - ContextId *string `json:"contextId,omitempty"` - - - // Details - Details *[]Queueconversationcobrowseeventtopicdetail `json:"details,omitempty"` - - - // Errors - Errors *[]Queueconversationcobrowseeventtopicerrorbody `json:"errors,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationcobrowseeventtopicerrorbody) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationcobrowseeventtopicjourneyaction.go b/build/platformclientv2/queueconversationcobrowseeventtopicjourneyaction.go deleted file mode 100644 index eb24652f9..000000000 --- a/build/platformclientv2/queueconversationcobrowseeventtopicjourneyaction.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationcobrowseeventtopicjourneyaction -type Queueconversationcobrowseeventtopicjourneyaction struct { - // Id - Id *string `json:"id,omitempty"` - - - // ActionMap - ActionMap *Queueconversationcobrowseeventtopicjourneyactionmap `json:"actionMap,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationcobrowseeventtopicjourneyaction) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationcobrowseeventtopicjourneyactionmap.go b/build/platformclientv2/queueconversationcobrowseeventtopicjourneyactionmap.go deleted file mode 100644 index 10691c742..000000000 --- a/build/platformclientv2/queueconversationcobrowseeventtopicjourneyactionmap.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationcobrowseeventtopicjourneyactionmap -type Queueconversationcobrowseeventtopicjourneyactionmap struct { - // Id - Id *string `json:"id,omitempty"` - - - // Version - Version *int `json:"version,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationcobrowseeventtopicjourneyactionmap) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationcobrowseeventtopicjourneycontext.go b/build/platformclientv2/queueconversationcobrowseeventtopicjourneycontext.go deleted file mode 100644 index 42407f975..000000000 --- a/build/platformclientv2/queueconversationcobrowseeventtopicjourneycontext.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationcobrowseeventtopicjourneycontext -type Queueconversationcobrowseeventtopicjourneycontext struct { - // Customer - Customer *Queueconversationcobrowseeventtopicjourneycustomer `json:"customer,omitempty"` - - - // CustomerSession - CustomerSession *Queueconversationcobrowseeventtopicjourneycustomersession `json:"customerSession,omitempty"` - - - // TriggeringAction - TriggeringAction *Queueconversationcobrowseeventtopicjourneyaction `json:"triggeringAction,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationcobrowseeventtopicjourneycontext) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationcobrowseeventtopicjourneycustomer.go b/build/platformclientv2/queueconversationcobrowseeventtopicjourneycustomer.go deleted file mode 100644 index 9f0ab145c..000000000 --- a/build/platformclientv2/queueconversationcobrowseeventtopicjourneycustomer.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationcobrowseeventtopicjourneycustomer -type Queueconversationcobrowseeventtopicjourneycustomer struct { - // Id - Id *string `json:"id,omitempty"` - - - // IdType - IdType *string `json:"idType,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationcobrowseeventtopicjourneycustomer) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationcobrowseeventtopicjourneycustomersession.go b/build/platformclientv2/queueconversationcobrowseeventtopicjourneycustomersession.go deleted file mode 100644 index cdaf41172..000000000 --- a/build/platformclientv2/queueconversationcobrowseeventtopicjourneycustomersession.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationcobrowseeventtopicjourneycustomersession -type Queueconversationcobrowseeventtopicjourneycustomersession struct { - // Id - Id *string `json:"id,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationcobrowseeventtopicjourneycustomersession) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationcobrowseeventtopicscoredagent.go b/build/platformclientv2/queueconversationcobrowseeventtopicscoredagent.go deleted file mode 100644 index 8269775c9..000000000 --- a/build/platformclientv2/queueconversationcobrowseeventtopicscoredagent.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationcobrowseeventtopicscoredagent -type Queueconversationcobrowseeventtopicscoredagent struct { - // Agent - Agent *Queueconversationcobrowseeventtopicurireference `json:"agent,omitempty"` - - - // Score - Score *int `json:"score,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationcobrowseeventtopicscoredagent) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationcobrowseeventtopicurireference.go b/build/platformclientv2/queueconversationcobrowseeventtopicurireference.go deleted file mode 100644 index df0477ef4..000000000 --- a/build/platformclientv2/queueconversationcobrowseeventtopicurireference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationcobrowseeventtopicurireference -type Queueconversationcobrowseeventtopicurireference struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationcobrowseeventtopicurireference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationcobrowseeventtopicwrapup.go b/build/platformclientv2/queueconversationcobrowseeventtopicwrapup.go deleted file mode 100644 index 3e31b77a5..000000000 --- a/build/platformclientv2/queueconversationcobrowseeventtopicwrapup.go +++ /dev/null @@ -1,38 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queueconversationcobrowseeventtopicwrapup -type Queueconversationcobrowseeventtopicwrapup struct { - // Code - Code *string `json:"code,omitempty"` - - - // Notes - Notes *string `json:"notes,omitempty"` - - - // Tags - Tags *[]string `json:"tags,omitempty"` - - - // DurationSeconds - DurationSeconds *int `json:"durationSeconds,omitempty"` - - - // EndTime - EndTime *time.Time `json:"endTime,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationcobrowseeventtopicwrapup) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationemaileventtopicattachment.go b/build/platformclientv2/queueconversationemaileventtopicattachment.go deleted file mode 100644 index dab87ada6..000000000 --- a/build/platformclientv2/queueconversationemaileventtopicattachment.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationemaileventtopicattachment -type Queueconversationemaileventtopicattachment struct { - // AttachmentId - AttachmentId *string `json:"attachmentId,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // ContentUri - ContentUri *string `json:"contentUri,omitempty"` - - - // ContentType - ContentType *string `json:"contentType,omitempty"` - - - // ContentLength - ContentLength *int `json:"contentLength,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationemaileventtopicattachment) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationemaileventtopicconversationroutingdata.go b/build/platformclientv2/queueconversationemaileventtopicconversationroutingdata.go deleted file mode 100644 index 6ddd173bc..000000000 --- a/build/platformclientv2/queueconversationemaileventtopicconversationroutingdata.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationemaileventtopicconversationroutingdata -type Queueconversationemaileventtopicconversationroutingdata struct { - // Queue - Queue *Queueconversationemaileventtopicurireference `json:"queue,omitempty"` - - - // Language - Language *Queueconversationemaileventtopicurireference `json:"language,omitempty"` - - - // Priority - Priority *int `json:"priority,omitempty"` - - - // Skills - Skills *[]Queueconversationemaileventtopicurireference `json:"skills,omitempty"` - - - // ScoredAgents - ScoredAgents *[]Queueconversationemaileventtopicscoredagent `json:"scoredAgents,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationemaileventtopicconversationroutingdata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationemaileventtopicdetail.go b/build/platformclientv2/queueconversationemaileventtopicdetail.go deleted file mode 100644 index fc0f46ba4..000000000 --- a/build/platformclientv2/queueconversationemaileventtopicdetail.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationemaileventtopicdetail -type Queueconversationemaileventtopicdetail struct { - // ErrorCode - ErrorCode *string `json:"errorCode,omitempty"` - - - // FieldName - FieldName *string `json:"fieldName,omitempty"` - - - // EntityId - EntityId *string `json:"entityId,omitempty"` - - - // EntityName - EntityName *string `json:"entityName,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationemaileventtopicdetail) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationemaileventtopicemailconversation.go b/build/platformclientv2/queueconversationemaileventtopicemailconversation.go deleted file mode 100644 index 0181a38c0..000000000 --- a/build/platformclientv2/queueconversationemaileventtopicemailconversation.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationemaileventtopicemailconversation -type Queueconversationemaileventtopicemailconversation struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Participants - Participants *[]Queueconversationemaileventtopicemailmediaparticipant `json:"participants,omitempty"` - - - // OtherMediaUris - OtherMediaUris *[]string `json:"otherMediaUris,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationemaileventtopicemailconversation) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationemaileventtopicemailmediaparticipant.go b/build/platformclientv2/queueconversationemaileventtopicemailmediaparticipant.go deleted file mode 100644 index c7248520f..000000000 --- a/build/platformclientv2/queueconversationemaileventtopicemailmediaparticipant.go +++ /dev/null @@ -1,174 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queueconversationemaileventtopicemailmediaparticipant -type Queueconversationemaileventtopicemailmediaparticipant struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Address - Address *string `json:"address,omitempty"` - - - // StartTime - StartTime *time.Time `json:"startTime,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // EndTime - EndTime *time.Time `json:"endTime,omitempty"` - - - // StartHoldTime - StartHoldTime *time.Time `json:"startHoldTime,omitempty"` - - - // Purpose - Purpose *string `json:"purpose,omitempty"` - - - // State - State *string `json:"state,omitempty"` - - - // Direction - Direction *string `json:"direction,omitempty"` - - - // DisconnectType - DisconnectType *string `json:"disconnectType,omitempty"` - - - // Held - Held *bool `json:"held,omitempty"` - - - // WrapupRequired - WrapupRequired *bool `json:"wrapupRequired,omitempty"` - - - // WrapupPrompt - WrapupPrompt *string `json:"wrapupPrompt,omitempty"` - - - // User - User *Queueconversationemaileventtopicurireference `json:"user,omitempty"` - - - // Queue - Queue *Queueconversationemaileventtopicurireference `json:"queue,omitempty"` - - - // Team - Team *Queueconversationemaileventtopicurireference `json:"team,omitempty"` - - - // Attributes - Attributes *map[string]string `json:"attributes,omitempty"` - - - // ErrorInfo - ErrorInfo *Queueconversationemaileventtopicerrorbody `json:"errorInfo,omitempty"` - - - // Script - Script *Queueconversationemaileventtopicurireference `json:"script,omitempty"` - - - // WrapupTimeoutMs - WrapupTimeoutMs *int `json:"wrapupTimeoutMs,omitempty"` - - - // WrapupSkipped - WrapupSkipped *bool `json:"wrapupSkipped,omitempty"` - - - // AlertingTimeoutMs - AlertingTimeoutMs *int `json:"alertingTimeoutMs,omitempty"` - - - // Provider - Provider *string `json:"provider,omitempty"` - - - // ExternalContact - ExternalContact *Queueconversationemaileventtopicurireference `json:"externalContact,omitempty"` - - - // ExternalOrganization - ExternalOrganization *Queueconversationemaileventtopicurireference `json:"externalOrganization,omitempty"` - - - // Wrapup - Wrapup *Queueconversationemaileventtopicwrapup `json:"wrapup,omitempty"` - - - // ConversationRoutingData - ConversationRoutingData *Queueconversationemaileventtopicconversationroutingdata `json:"conversationRoutingData,omitempty"` - - - // Peer - Peer *string `json:"peer,omitempty"` - - - // ScreenRecordingState - ScreenRecordingState *string `json:"screenRecordingState,omitempty"` - - - // FlaggedReason - FlaggedReason *string `json:"flaggedReason,omitempty"` - - - // JourneyContext - JourneyContext *Queueconversationemaileventtopicjourneycontext `json:"journeyContext,omitempty"` - - - // StartAcwTime - StartAcwTime *time.Time `json:"startAcwTime,omitempty"` - - - // EndAcwTime - EndAcwTime *time.Time `json:"endAcwTime,omitempty"` - - - // Subject - Subject *string `json:"subject,omitempty"` - - - // MessagesSent - MessagesSent *int `json:"messagesSent,omitempty"` - - - // AutoGenerated - AutoGenerated *bool `json:"autoGenerated,omitempty"` - - - // MessageId - MessageId *string `json:"messageId,omitempty"` - - - // DraftAttachments - DraftAttachments *[]Queueconversationemaileventtopicattachment `json:"draftAttachments,omitempty"` - - - // Spam - Spam *bool `json:"spam,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationemaileventtopicemailmediaparticipant) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationemaileventtopicerrorbody.go b/build/platformclientv2/queueconversationemaileventtopicerrorbody.go deleted file mode 100644 index e8930eeff..000000000 --- a/build/platformclientv2/queueconversationemaileventtopicerrorbody.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationemaileventtopicerrorbody -type Queueconversationemaileventtopicerrorbody struct { - // Status - Status *int `json:"status,omitempty"` - - - // Code - Code *string `json:"code,omitempty"` - - - // EntityId - EntityId *string `json:"entityId,omitempty"` - - - // EntityName - EntityName *string `json:"entityName,omitempty"` - - - // Message - Message *string `json:"message,omitempty"` - - - // MessageWithParams - MessageWithParams *string `json:"messageWithParams,omitempty"` - - - // MessageParams - MessageParams *map[string]string `json:"messageParams,omitempty"` - - - // ContextId - ContextId *string `json:"contextId,omitempty"` - - - // Details - Details *[]Queueconversationemaileventtopicdetail `json:"details,omitempty"` - - - // Errors - Errors *[]Queueconversationemaileventtopicerrorbody `json:"errors,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationemaileventtopicerrorbody) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationemaileventtopicjourneyaction.go b/build/platformclientv2/queueconversationemaileventtopicjourneyaction.go deleted file mode 100644 index 5a494f88b..000000000 --- a/build/platformclientv2/queueconversationemaileventtopicjourneyaction.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationemaileventtopicjourneyaction -type Queueconversationemaileventtopicjourneyaction struct { - // Id - Id *string `json:"id,omitempty"` - - - // ActionMap - ActionMap *Queueconversationemaileventtopicjourneyactionmap `json:"actionMap,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationemaileventtopicjourneyaction) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationemaileventtopicjourneyactionmap.go b/build/platformclientv2/queueconversationemaileventtopicjourneyactionmap.go deleted file mode 100644 index b61b151e4..000000000 --- a/build/platformclientv2/queueconversationemaileventtopicjourneyactionmap.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationemaileventtopicjourneyactionmap -type Queueconversationemaileventtopicjourneyactionmap struct { - // Id - Id *string `json:"id,omitempty"` - - - // Version - Version *int `json:"version,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationemaileventtopicjourneyactionmap) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationemaileventtopicjourneycontext.go b/build/platformclientv2/queueconversationemaileventtopicjourneycontext.go deleted file mode 100644 index 72c879ee6..000000000 --- a/build/platformclientv2/queueconversationemaileventtopicjourneycontext.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationemaileventtopicjourneycontext -type Queueconversationemaileventtopicjourneycontext struct { - // Customer - Customer *Queueconversationemaileventtopicjourneycustomer `json:"customer,omitempty"` - - - // CustomerSession - CustomerSession *Queueconversationemaileventtopicjourneycustomersession `json:"customerSession,omitempty"` - - - // TriggeringAction - TriggeringAction *Queueconversationemaileventtopicjourneyaction `json:"triggeringAction,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationemaileventtopicjourneycontext) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationemaileventtopicjourneycustomer.go b/build/platformclientv2/queueconversationemaileventtopicjourneycustomer.go deleted file mode 100644 index 97c0fe818..000000000 --- a/build/platformclientv2/queueconversationemaileventtopicjourneycustomer.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationemaileventtopicjourneycustomer -type Queueconversationemaileventtopicjourneycustomer struct { - // Id - Id *string `json:"id,omitempty"` - - - // IdType - IdType *string `json:"idType,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationemaileventtopicjourneycustomer) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationemaileventtopicjourneycustomersession.go b/build/platformclientv2/queueconversationemaileventtopicjourneycustomersession.go deleted file mode 100644 index ceec6054f..000000000 --- a/build/platformclientv2/queueconversationemaileventtopicjourneycustomersession.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationemaileventtopicjourneycustomersession -type Queueconversationemaileventtopicjourneycustomersession struct { - // Id - Id *string `json:"id,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationemaileventtopicjourneycustomersession) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationemaileventtopicscoredagent.go b/build/platformclientv2/queueconversationemaileventtopicscoredagent.go deleted file mode 100644 index 50e2e1d44..000000000 --- a/build/platformclientv2/queueconversationemaileventtopicscoredagent.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationemaileventtopicscoredagent -type Queueconversationemaileventtopicscoredagent struct { - // Agent - Agent *Queueconversationemaileventtopicurireference `json:"agent,omitempty"` - - - // Score - Score *int `json:"score,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationemaileventtopicscoredagent) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationemaileventtopicurireference.go b/build/platformclientv2/queueconversationemaileventtopicurireference.go deleted file mode 100644 index 5be46dea1..000000000 --- a/build/platformclientv2/queueconversationemaileventtopicurireference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationemaileventtopicurireference -type Queueconversationemaileventtopicurireference struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationemaileventtopicurireference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationemaileventtopicwrapup.go b/build/platformclientv2/queueconversationemaileventtopicwrapup.go deleted file mode 100644 index fa99db4e5..000000000 --- a/build/platformclientv2/queueconversationemaileventtopicwrapup.go +++ /dev/null @@ -1,38 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queueconversationemaileventtopicwrapup -type Queueconversationemaileventtopicwrapup struct { - // Code - Code *string `json:"code,omitempty"` - - - // Notes - Notes *string `json:"notes,omitempty"` - - - // Tags - Tags *[]string `json:"tags,omitempty"` - - - // DurationSeconds - DurationSeconds *int `json:"durationSeconds,omitempty"` - - - // EndTime - EndTime *time.Time `json:"endTime,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationemaileventtopicwrapup) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationeventtopicaddress.go b/build/platformclientv2/queueconversationeventtopicaddress.go deleted file mode 100644 index e98fec2da..000000000 --- a/build/platformclientv2/queueconversationeventtopicaddress.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationeventtopicaddress -type Queueconversationeventtopicaddress struct { - // Name - Name *string `json:"name,omitempty"` - - - // NameRaw - NameRaw *string `json:"nameRaw,omitempty"` - - - // AddressNormalized - AddressNormalized *string `json:"addressNormalized,omitempty"` - - - // AddressRaw - AddressRaw *string `json:"addressRaw,omitempty"` - - - // AddressDisplayable - AddressDisplayable *string `json:"addressDisplayable,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationeventtopicaddress) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationeventtopicaftercallwork.go b/build/platformclientv2/queueconversationeventtopicaftercallwork.go deleted file mode 100644 index 1d431acff..000000000 --- a/build/platformclientv2/queueconversationeventtopicaftercallwork.go +++ /dev/null @@ -1,26 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queueconversationeventtopicaftercallwork -type Queueconversationeventtopicaftercallwork struct { - // State - State *string `json:"state,omitempty"` - - - // StartTime - StartTime *time.Time `json:"startTime,omitempty"` - - - // EndTime - EndTime *time.Time `json:"endTime,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationeventtopicaftercallwork) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationeventtopicattachment.go b/build/platformclientv2/queueconversationeventtopicattachment.go deleted file mode 100644 index 7c7b6f76d..000000000 --- a/build/platformclientv2/queueconversationeventtopicattachment.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationeventtopicattachment -type Queueconversationeventtopicattachment struct { - // AttachmentId - AttachmentId *string `json:"attachmentId,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // ContentUri - ContentUri *string `json:"contentUri,omitempty"` - - - // ContentType - ContentType *string `json:"contentType,omitempty"` - - - // ContentLength - ContentLength *int `json:"contentLength,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationeventtopicattachment) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationeventtopiccall.go b/build/platformclientv2/queueconversationeventtopiccall.go deleted file mode 100644 index 22466d7d4..000000000 --- a/build/platformclientv2/queueconversationeventtopiccall.go +++ /dev/null @@ -1,122 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queueconversationeventtopiccall -type Queueconversationeventtopiccall struct { - // Id - Id *string `json:"id,omitempty"` - - - // State - State *string `json:"state,omitempty"` - - - // Recording - Recording *bool `json:"recording,omitempty"` - - - // RecordingState - RecordingState *string `json:"recordingState,omitempty"` - - - // Muted - Muted *bool `json:"muted,omitempty"` - - - // Confined - Confined *bool `json:"confined,omitempty"` - - - // Held - Held *bool `json:"held,omitempty"` - - - // ErrorInfo - ErrorInfo *Queueconversationeventtopicerrordetails `json:"errorInfo,omitempty"` - - - // DisconnectType - DisconnectType *string `json:"disconnectType,omitempty"` - - - // StartHoldTime - StartHoldTime *time.Time `json:"startHoldTime,omitempty"` - - - // Direction - Direction *string `json:"direction,omitempty"` - - - // DocumentId - DocumentId *string `json:"documentId,omitempty"` - - - // Self - Self *Queueconversationeventtopicaddress `json:"self,omitempty"` - - - // Other - Other *Queueconversationeventtopicaddress `json:"other,omitempty"` - - - // Provider - Provider *string `json:"provider,omitempty"` - - - // ScriptId - ScriptId *string `json:"scriptId,omitempty"` - - - // PeerId - PeerId *string `json:"peerId,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // DisconnectedTime - DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"` - - - // DisconnectReasons - DisconnectReasons *[]Queueconversationeventtopicdisconnectreason `json:"disconnectReasons,omitempty"` - - - // FaxStatus - FaxStatus *Queueconversationeventtopicfaxstatus `json:"faxStatus,omitempty"` - - - // UuiData - UuiData *string `json:"uuiData,omitempty"` - - - // Wrapup - Wrapup *Queueconversationeventtopicwrapup `json:"wrapup,omitempty"` - - - // AfterCallWork - AfterCallWork *Queueconversationeventtopicaftercallwork `json:"afterCallWork,omitempty"` - - - // AfterCallWorkRequired - AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"` - - - // AgentAssistantId - AgentAssistantId *string `json:"agentAssistantId,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationeventtopiccall) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationeventtopiccallback.go b/build/platformclientv2/queueconversationeventtopiccallback.go deleted file mode 100644 index e0e601671..000000000 --- a/build/platformclientv2/queueconversationeventtopiccallback.go +++ /dev/null @@ -1,110 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queueconversationeventtopiccallback -type Queueconversationeventtopiccallback struct { - // State - State *string `json:"state,omitempty"` - - - // Id - Id *string `json:"id,omitempty"` - - - // Direction - Direction *string `json:"direction,omitempty"` - - - // Held - Held *bool `json:"held,omitempty"` - - - // DisconnectType - DisconnectType *string `json:"disconnectType,omitempty"` - - - // StartHoldTime - StartHoldTime *time.Time `json:"startHoldTime,omitempty"` - - - // DialerPreview - DialerPreview *Queueconversationeventtopicdialerpreview `json:"dialerPreview,omitempty"` - - - // Voicemail - Voicemail *Queueconversationeventtopicvoicemail `json:"voicemail,omitempty"` - - - // CallbackNumbers - CallbackNumbers *[]string `json:"callbackNumbers,omitempty"` - - - // CallbackUserName - CallbackUserName *string `json:"callbackUserName,omitempty"` - - - // ScriptId - ScriptId *string `json:"scriptId,omitempty"` - - - // PeerId - PeerId *string `json:"peerId,omitempty"` - - - // ExternalCampaign - ExternalCampaign *bool `json:"externalCampaign,omitempty"` - - - // SkipEnabled - SkipEnabled *bool `json:"skipEnabled,omitempty"` - - - // Provider - Provider *string `json:"provider,omitempty"` - - - // TimeoutSeconds - TimeoutSeconds *int `json:"timeoutSeconds,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // DisconnectedTime - DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"` - - - // CallbackScheduledTime - CallbackScheduledTime *time.Time `json:"callbackScheduledTime,omitempty"` - - - // AutomatedCallbackConfigId - AutomatedCallbackConfigId *string `json:"automatedCallbackConfigId,omitempty"` - - - // Wrapup - Wrapup *Queueconversationeventtopicwrapup `json:"wrapup,omitempty"` - - - // AfterCallWork - AfterCallWork *Queueconversationeventtopicaftercallwork `json:"afterCallWork,omitempty"` - - - // AfterCallWorkRequired - AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationeventtopiccallback) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationeventtopicchat.go b/build/platformclientv2/queueconversationeventtopicchat.go deleted file mode 100644 index fbf9fdfba..000000000 --- a/build/platformclientv2/queueconversationeventtopicchat.go +++ /dev/null @@ -1,82 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queueconversationeventtopicchat -type Queueconversationeventtopicchat struct { - // State - State *string `json:"state,omitempty"` - - - // Id - Id *string `json:"id,omitempty"` - - - // Provider - Provider *string `json:"provider,omitempty"` - - - // ScriptId - ScriptId *string `json:"scriptId,omitempty"` - - - // PeerId - PeerId *string `json:"peerId,omitempty"` - - - // RoomId - RoomId *string `json:"roomId,omitempty"` - - - // AvatarImageUrl - AvatarImageUrl *string `json:"avatarImageUrl,omitempty"` - - - // Held - Held *bool `json:"held,omitempty"` - - - // DisconnectType - DisconnectType *string `json:"disconnectType,omitempty"` - - - // StartHoldTime - StartHoldTime *time.Time `json:"startHoldTime,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // DisconnectedTime - DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"` - - - // JourneyContext - JourneyContext *Queueconversationeventtopicjourneycontext `json:"journeyContext,omitempty"` - - - // Wrapup - Wrapup *Queueconversationeventtopicwrapup `json:"wrapup,omitempty"` - - - // AfterCallWork - AfterCallWork *Queueconversationeventtopicaftercallwork `json:"afterCallWork,omitempty"` - - - // AfterCallWorkRequired - AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationeventtopicchat) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationeventtopiccobrowse.go b/build/platformclientv2/queueconversationeventtopiccobrowse.go deleted file mode 100644 index 7e0cbaf37..000000000 --- a/build/platformclientv2/queueconversationeventtopiccobrowse.go +++ /dev/null @@ -1,90 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queueconversationeventtopiccobrowse -type Queueconversationeventtopiccobrowse struct { - // State - State *string `json:"state,omitempty"` - - - // DisconnectType - DisconnectType *string `json:"disconnectType,omitempty"` - - - // Id - Id *string `json:"id,omitempty"` - - - // Self - Self *Queueconversationeventtopicaddress `json:"self,omitempty"` - - - // RoomId - RoomId *string `json:"roomId,omitempty"` - - - // CobrowseSessionId - CobrowseSessionId *string `json:"cobrowseSessionId,omitempty"` - - - // CobrowseRole - CobrowseRole *string `json:"cobrowseRole,omitempty"` - - - // Controlling - Controlling *[]string `json:"controlling,omitempty"` - - - // ViewerUrl - ViewerUrl *string `json:"viewerUrl,omitempty"` - - - // Provider - Provider *string `json:"provider,omitempty"` - - - // ScriptId - ScriptId *string `json:"scriptId,omitempty"` - - - // PeerId - PeerId *string `json:"peerId,omitempty"` - - - // ProviderEventTime - ProviderEventTime *time.Time `json:"providerEventTime,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // DisconnectedTime - DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"` - - - // Wrapup - Wrapup *Queueconversationeventtopicwrapup `json:"wrapup,omitempty"` - - - // AfterCallWork - AfterCallWork *Queueconversationeventtopicaftercallwork `json:"afterCallWork,omitempty"` - - - // AfterCallWorkRequired - AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationeventtopiccobrowse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationeventtopicconversation.go b/build/platformclientv2/queueconversationeventtopicconversation.go deleted file mode 100644 index 6a0beaa8f..000000000 --- a/build/platformclientv2/queueconversationeventtopicconversation.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationeventtopicconversation -type Queueconversationeventtopicconversation struct { - // Id - Id *string `json:"id,omitempty"` - - - // MaxParticipants - MaxParticipants *int `json:"maxParticipants,omitempty"` - - - // Participants - Participants *[]Queueconversationeventtopicparticipant `json:"participants,omitempty"` - - - // RecordingState - RecordingState *string `json:"recordingState,omitempty"` - - - // Address - Address *string `json:"address,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationeventtopicconversation) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationeventtopicconversationroutingdata.go b/build/platformclientv2/queueconversationeventtopicconversationroutingdata.go deleted file mode 100644 index 6172b79df..000000000 --- a/build/platformclientv2/queueconversationeventtopicconversationroutingdata.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationeventtopicconversationroutingdata -type Queueconversationeventtopicconversationroutingdata struct { - // Queue - Queue *Queueconversationeventtopicurireference `json:"queue,omitempty"` - - - // Language - Language *Queueconversationeventtopicurireference `json:"language,omitempty"` - - - // Priority - Priority *int `json:"priority,omitempty"` - - - // Skills - Skills *[]Queueconversationeventtopicurireference `json:"skills,omitempty"` - - - // ScoredAgents - ScoredAgents *[]Queueconversationeventtopicscoredagent `json:"scoredAgents,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationeventtopicconversationroutingdata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationeventtopicdialerpreview.go b/build/platformclientv2/queueconversationeventtopicdialerpreview.go deleted file mode 100644 index 2fc6b0ca6..000000000 --- a/build/platformclientv2/queueconversationeventtopicdialerpreview.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationeventtopicdialerpreview -type Queueconversationeventtopicdialerpreview struct { - // Id - Id *string `json:"id,omitempty"` - - - // ContactId - ContactId *string `json:"contactId,omitempty"` - - - // ContactListId - ContactListId *string `json:"contactListId,omitempty"` - - - // CampaignId - CampaignId *string `json:"campaignId,omitempty"` - - - // PhoneNumberColumns - PhoneNumberColumns *[]Queueconversationeventtopicphonenumbercolumn `json:"phoneNumberColumns,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationeventtopicdialerpreview) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationeventtopicdisconnectreason.go b/build/platformclientv2/queueconversationeventtopicdisconnectreason.go deleted file mode 100644 index 88b42c7c8..000000000 --- a/build/platformclientv2/queueconversationeventtopicdisconnectreason.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationeventtopicdisconnectreason -type Queueconversationeventtopicdisconnectreason struct { - // VarType - VarType *string `json:"type,omitempty"` - - - // Code - Code *int `json:"code,omitempty"` - - - // Phrase - Phrase *string `json:"phrase,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationeventtopicdisconnectreason) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationeventtopicemail.go b/build/platformclientv2/queueconversationeventtopicemail.go deleted file mode 100644 index b31c617a2..000000000 --- a/build/platformclientv2/queueconversationeventtopicemail.go +++ /dev/null @@ -1,102 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queueconversationeventtopicemail -type Queueconversationeventtopicemail struct { - // Id - Id *string `json:"id,omitempty"` - - - // State - State *string `json:"state,omitempty"` - - - // Held - Held *bool `json:"held,omitempty"` - - - // AutoGenerated - AutoGenerated *bool `json:"autoGenerated,omitempty"` - - - // Subject - Subject *string `json:"subject,omitempty"` - - - // Provider - Provider *string `json:"provider,omitempty"` - - - // ScriptId - ScriptId *string `json:"scriptId,omitempty"` - - - // PeerId - PeerId *string `json:"peerId,omitempty"` - - - // MessagesSent - MessagesSent *int `json:"messagesSent,omitempty"` - - - // ErrorInfo - ErrorInfo *Queueconversationeventtopicerrordetails `json:"errorInfo,omitempty"` - - - // DisconnectType - DisconnectType *string `json:"disconnectType,omitempty"` - - - // StartHoldTime - StartHoldTime *time.Time `json:"startHoldTime,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // DisconnectedTime - DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"` - - - // MessageId - MessageId *string `json:"messageId,omitempty"` - - - // Direction - Direction *string `json:"direction,omitempty"` - - - // DraftAttachments - DraftAttachments *[]Queueconversationeventtopicattachment `json:"draftAttachments,omitempty"` - - - // Spam - Spam *bool `json:"spam,omitempty"` - - - // Wrapup - Wrapup *Queueconversationeventtopicwrapup `json:"wrapup,omitempty"` - - - // AfterCallWork - AfterCallWork *Queueconversationeventtopicaftercallwork `json:"afterCallWork,omitempty"` - - - // AfterCallWorkRequired - AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationeventtopicemail) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationeventtopicerrordetails.go b/build/platformclientv2/queueconversationeventtopicerrordetails.go deleted file mode 100644 index 226cd8d67..000000000 --- a/build/platformclientv2/queueconversationeventtopicerrordetails.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationeventtopicerrordetails -type Queueconversationeventtopicerrordetails struct { - // Status - Status *int `json:"status,omitempty"` - - - // Code - Code *string `json:"code,omitempty"` - - - // Message - Message *string `json:"message,omitempty"` - - - // MessageWithParams - MessageWithParams *string `json:"messageWithParams,omitempty"` - - - // MessageParams - MessageParams *map[string]string `json:"messageParams,omitempty"` - - - // ContextId - ContextId *string `json:"contextId,omitempty"` - - - // Uri - Uri *string `json:"uri,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationeventtopicerrordetails) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationeventtopicfaxstatus.go b/build/platformclientv2/queueconversationeventtopicfaxstatus.go deleted file mode 100644 index c25f0099e..000000000 --- a/build/platformclientv2/queueconversationeventtopicfaxstatus.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationeventtopicfaxstatus -type Queueconversationeventtopicfaxstatus struct { - // Direction - Direction *string `json:"direction,omitempty"` - - - // ExpectedPages - ExpectedPages *int `json:"expectedPages,omitempty"` - - - // ActivePage - ActivePage *int `json:"activePage,omitempty"` - - - // LinesTransmitted - LinesTransmitted *int `json:"linesTransmitted,omitempty"` - - - // BytesTransmitted - BytesTransmitted *int `json:"bytesTransmitted,omitempty"` - - - // BaudRate - BaudRate *int `json:"baudRate,omitempty"` - - - // PageErrors - PageErrors *int `json:"pageErrors,omitempty"` - - - // LineErrors - LineErrors *int `json:"lineErrors,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationeventtopicfaxstatus) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationeventtopicjourneyaction.go b/build/platformclientv2/queueconversationeventtopicjourneyaction.go deleted file mode 100644 index 3c1462d59..000000000 --- a/build/platformclientv2/queueconversationeventtopicjourneyaction.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationeventtopicjourneyaction -type Queueconversationeventtopicjourneyaction struct { - // Id - Id *string `json:"id,omitempty"` - - - // ActionMap - ActionMap *Queueconversationeventtopicjourneyactionmap `json:"actionMap,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationeventtopicjourneyaction) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationeventtopicjourneyactionmap.go b/build/platformclientv2/queueconversationeventtopicjourneyactionmap.go deleted file mode 100644 index 194eef210..000000000 --- a/build/platformclientv2/queueconversationeventtopicjourneyactionmap.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationeventtopicjourneyactionmap -type Queueconversationeventtopicjourneyactionmap struct { - // Id - Id *string `json:"id,omitempty"` - - - // Version - Version *int `json:"version,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationeventtopicjourneyactionmap) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationeventtopicjourneycontext.go b/build/platformclientv2/queueconversationeventtopicjourneycontext.go deleted file mode 100644 index 0895cc74e..000000000 --- a/build/platformclientv2/queueconversationeventtopicjourneycontext.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationeventtopicjourneycontext -type Queueconversationeventtopicjourneycontext struct { - // Customer - Customer *Queueconversationeventtopicjourneycustomer `json:"customer,omitempty"` - - - // CustomerSession - CustomerSession *Queueconversationeventtopicjourneycustomersession `json:"customerSession,omitempty"` - - - // TriggeringAction - TriggeringAction *Queueconversationeventtopicjourneyaction `json:"triggeringAction,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationeventtopicjourneycontext) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationeventtopicjourneycustomer.go b/build/platformclientv2/queueconversationeventtopicjourneycustomer.go deleted file mode 100644 index 64ff870be..000000000 --- a/build/platformclientv2/queueconversationeventtopicjourneycustomer.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationeventtopicjourneycustomer -type Queueconversationeventtopicjourneycustomer struct { - // Id - Id *string `json:"id,omitempty"` - - - // IdType - IdType *string `json:"idType,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationeventtopicjourneycustomer) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationeventtopicjourneycustomersession.go b/build/platformclientv2/queueconversationeventtopicjourneycustomersession.go deleted file mode 100644 index e985dcff1..000000000 --- a/build/platformclientv2/queueconversationeventtopicjourneycustomersession.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationeventtopicjourneycustomersession -type Queueconversationeventtopicjourneycustomersession struct { - // Id - Id *string `json:"id,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationeventtopicjourneycustomersession) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationeventtopicmessage.go b/build/platformclientv2/queueconversationeventtopicmessage.go deleted file mode 100644 index d3a7c205d..000000000 --- a/build/platformclientv2/queueconversationeventtopicmessage.go +++ /dev/null @@ -1,106 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queueconversationeventtopicmessage -type Queueconversationeventtopicmessage struct { - // Id - Id *string `json:"id,omitempty"` - - - // State - State *string `json:"state,omitempty"` - - - // Held - Held *bool `json:"held,omitempty"` - - - // ErrorInfo - ErrorInfo *Queueconversationeventtopicerrordetails `json:"errorInfo,omitempty"` - - - // Provider - Provider *string `json:"provider,omitempty"` - - - // ScriptId - ScriptId *string `json:"scriptId,omitempty"` - - - // PeerId - PeerId *string `json:"peerId,omitempty"` - - - // DisconnectType - DisconnectType *string `json:"disconnectType,omitempty"` - - - // StartHoldTime - StartHoldTime *time.Time `json:"startHoldTime,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // DisconnectedTime - DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"` - - - // ToAddress - ToAddress *Queueconversationeventtopicaddress `json:"toAddress,omitempty"` - - - // FromAddress - FromAddress *Queueconversationeventtopicaddress `json:"fromAddress,omitempty"` - - - // Messages - Messages *[]Queueconversationeventtopicmessagedetails `json:"messages,omitempty"` - - - // MessagesTranscriptUri - MessagesTranscriptUri *string `json:"messagesTranscriptUri,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - - - // RecipientCountry - RecipientCountry *string `json:"recipientCountry,omitempty"` - - - // RecipientType - RecipientType *string `json:"recipientType,omitempty"` - - - // JourneyContext - JourneyContext *Queueconversationeventtopicjourneycontext `json:"journeyContext,omitempty"` - - - // Wrapup - Wrapup *Queueconversationeventtopicwrapup `json:"wrapup,omitempty"` - - - // AfterCallWork - AfterCallWork *Queueconversationeventtopicaftercallwork `json:"afterCallWork,omitempty"` - - - // AfterCallWorkRequired - AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationeventtopicmessage) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationeventtopicmessagedetails.go b/build/platformclientv2/queueconversationeventtopicmessagedetails.go deleted file mode 100644 index f612d7530..000000000 --- a/build/platformclientv2/queueconversationeventtopicmessagedetails.go +++ /dev/null @@ -1,38 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queueconversationeventtopicmessagedetails -type Queueconversationeventtopicmessagedetails struct { - // MessageId - MessageId *string `json:"messageId,omitempty"` - - - // MessageTime - MessageTime *time.Time `json:"messageTime,omitempty"` - - - // MessageStatus - MessageStatus *string `json:"messageStatus,omitempty"` - - - // MessageSegmentCount - MessageSegmentCount *int `json:"messageSegmentCount,omitempty"` - - - // Media - Media *[]Queueconversationeventtopicmessagemedia `json:"media,omitempty"` - - - // Stickers - Stickers *[]Queueconversationeventtopicmessagesticker `json:"stickers,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationeventtopicmessagedetails) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationeventtopicmessagemedia.go b/build/platformclientv2/queueconversationeventtopicmessagemedia.go deleted file mode 100644 index 1760b1f6d..000000000 --- a/build/platformclientv2/queueconversationeventtopicmessagemedia.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationeventtopicmessagemedia -type Queueconversationeventtopicmessagemedia struct { - // Url - Url *string `json:"url,omitempty"` - - - // MediaType - MediaType *string `json:"mediaType,omitempty"` - - - // ContentLengthBytes - ContentLengthBytes *int `json:"contentLengthBytes,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Id - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationeventtopicmessagemedia) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationeventtopicmessagesticker.go b/build/platformclientv2/queueconversationeventtopicmessagesticker.go deleted file mode 100644 index 41d15f622..000000000 --- a/build/platformclientv2/queueconversationeventtopicmessagesticker.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationeventtopicmessagesticker -type Queueconversationeventtopicmessagesticker struct { - // Url - Url *string `json:"url,omitempty"` - - - // Id - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationeventtopicmessagesticker) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationeventtopicparticipant.go b/build/platformclientv2/queueconversationeventtopicparticipant.go deleted file mode 100644 index f330bb987..000000000 --- a/build/platformclientv2/queueconversationeventtopicparticipant.go +++ /dev/null @@ -1,162 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queueconversationeventtopicparticipant -type Queueconversationeventtopicparticipant struct { - // Id - Id *string `json:"id,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // EndTime - EndTime *time.Time `json:"endTime,omitempty"` - - - // UserId - UserId *string `json:"userId,omitempty"` - - - // ExternalContactId - ExternalContactId *string `json:"externalContactId,omitempty"` - - - // ExternalOrganizationId - ExternalOrganizationId *string `json:"externalOrganizationId,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // QueueId - QueueId *string `json:"queueId,omitempty"` - - - // GroupId - GroupId *string `json:"groupId,omitempty"` - - - // TeamId - TeamId *string `json:"teamId,omitempty"` - - - // Purpose - Purpose *string `json:"purpose,omitempty"` - - - // ConsultParticipantId - ConsultParticipantId *string `json:"consultParticipantId,omitempty"` - - - // Address - Address *string `json:"address,omitempty"` - - - // WrapupRequired - WrapupRequired *bool `json:"wrapupRequired,omitempty"` - - - // WrapupExpected - WrapupExpected *bool `json:"wrapupExpected,omitempty"` - - - // WrapupPrompt - WrapupPrompt *string `json:"wrapupPrompt,omitempty"` - - - // WrapupTimeoutMs - WrapupTimeoutMs *int `json:"wrapupTimeoutMs,omitempty"` - - - // Wrapup - Wrapup *Queueconversationeventtopicwrapup `json:"wrapup,omitempty"` - - - // StartAcwTime - StartAcwTime *time.Time `json:"startAcwTime,omitempty"` - - - // EndAcwTime - EndAcwTime *time.Time `json:"endAcwTime,omitempty"` - - - // ConversationRoutingData - ConversationRoutingData *Queueconversationeventtopicconversationroutingdata `json:"conversationRoutingData,omitempty"` - - - // AlertingTimeoutMs - AlertingTimeoutMs *int `json:"alertingTimeoutMs,omitempty"` - - - // MonitoredParticipantId - MonitoredParticipantId *string `json:"monitoredParticipantId,omitempty"` - - - // CoachedParticipantId - CoachedParticipantId *string `json:"coachedParticipantId,omitempty"` - - - // ScreenRecordingState - ScreenRecordingState *string `json:"screenRecordingState,omitempty"` - - - // FlaggedReason - FlaggedReason *string `json:"flaggedReason,omitempty"` - - - // Attributes - Attributes *map[string]string `json:"attributes,omitempty"` - - - // Calls - Calls *[]Queueconversationeventtopiccall `json:"calls,omitempty"` - - - // Callbacks - Callbacks *[]Queueconversationeventtopiccallback `json:"callbacks,omitempty"` - - - // Chats - Chats *[]Queueconversationeventtopicchat `json:"chats,omitempty"` - - - // Cobrowsesessions - Cobrowsesessions *[]Queueconversationeventtopiccobrowse `json:"cobrowsesessions,omitempty"` - - - // Emails - Emails *[]Queueconversationeventtopicemail `json:"emails,omitempty"` - - - // Messages - Messages *[]Queueconversationeventtopicmessage `json:"messages,omitempty"` - - - // Screenshares - Screenshares *[]Queueconversationeventtopicscreenshare `json:"screenshares,omitempty"` - - - // SocialExpressions - SocialExpressions *[]Queueconversationeventtopicsocialexpression `json:"socialExpressions,omitempty"` - - - // Videos - Videos *[]Queueconversationeventtopicvideo `json:"videos,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationeventtopicparticipant) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationeventtopicphonenumbercolumn.go b/build/platformclientv2/queueconversationeventtopicphonenumbercolumn.go deleted file mode 100644 index c535c4092..000000000 --- a/build/platformclientv2/queueconversationeventtopicphonenumbercolumn.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationeventtopicphonenumbercolumn -type Queueconversationeventtopicphonenumbercolumn struct { - // ColumnName - ColumnName *string `json:"columnName,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationeventtopicphonenumbercolumn) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationeventtopicscoredagent.go b/build/platformclientv2/queueconversationeventtopicscoredagent.go deleted file mode 100644 index 0f39a1c80..000000000 --- a/build/platformclientv2/queueconversationeventtopicscoredagent.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationeventtopicscoredagent -type Queueconversationeventtopicscoredagent struct { - // Agent - Agent *Queueconversationeventtopicurireference `json:"agent,omitempty"` - - - // Score - Score *int `json:"score,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationeventtopicscoredagent) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationeventtopicscreenshare.go b/build/platformclientv2/queueconversationeventtopicscreenshare.go deleted file mode 100644 index d80807833..000000000 --- a/build/platformclientv2/queueconversationeventtopicscreenshare.go +++ /dev/null @@ -1,74 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queueconversationeventtopicscreenshare -type Queueconversationeventtopicscreenshare struct { - // State - State *string `json:"state,omitempty"` - - - // Self - Self *Queueconversationeventtopicaddress `json:"self,omitempty"` - - - // Id - Id *string `json:"id,omitempty"` - - - // Context - Context *string `json:"context,omitempty"` - - - // Sharing - Sharing *bool `json:"sharing,omitempty"` - - - // Provider - Provider *string `json:"provider,omitempty"` - - - // ScriptId - ScriptId *string `json:"scriptId,omitempty"` - - - // PeerId - PeerId *string `json:"peerId,omitempty"` - - - // DisconnectType - DisconnectType *string `json:"disconnectType,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // DisconnectedTime - DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"` - - - // Wrapup - Wrapup *Queueconversationeventtopicwrapup `json:"wrapup,omitempty"` - - - // AfterCallWork - AfterCallWork *Queueconversationeventtopicaftercallwork `json:"afterCallWork,omitempty"` - - - // AfterCallWorkRequired - AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationeventtopicscreenshare) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationeventtopicsocialexpression.go b/build/platformclientv2/queueconversationeventtopicsocialexpression.go deleted file mode 100644 index 3170fce9e..000000000 --- a/build/platformclientv2/queueconversationeventtopicsocialexpression.go +++ /dev/null @@ -1,90 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queueconversationeventtopicsocialexpression -type Queueconversationeventtopicsocialexpression struct { - // State - State *string `json:"state,omitempty"` - - - // Id - Id *string `json:"id,omitempty"` - - - // SocialMediaId - SocialMediaId *string `json:"socialMediaId,omitempty"` - - - // SocialMediaHub - SocialMediaHub *string `json:"socialMediaHub,omitempty"` - - - // SocialUserName - SocialUserName *string `json:"socialUserName,omitempty"` - - - // PreviewText - PreviewText *string `json:"previewText,omitempty"` - - - // RecordingId - RecordingId *string `json:"recordingId,omitempty"` - - - // Held - Held *bool `json:"held,omitempty"` - - - // Provider - Provider *string `json:"provider,omitempty"` - - - // ScriptId - ScriptId *string `json:"scriptId,omitempty"` - - - // PeerId - PeerId *string `json:"peerId,omitempty"` - - - // DisconnectType - DisconnectType *string `json:"disconnectType,omitempty"` - - - // StartHoldTime - StartHoldTime *time.Time `json:"startHoldTime,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // DisconnectedTime - DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"` - - - // Wrapup - Wrapup *Queueconversationeventtopicwrapup `json:"wrapup,omitempty"` - - - // AfterCallWork - AfterCallWork *Queueconversationeventtopicaftercallwork `json:"afterCallWork,omitempty"` - - - // AfterCallWorkRequired - AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationeventtopicsocialexpression) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationeventtopicurireference.go b/build/platformclientv2/queueconversationeventtopicurireference.go deleted file mode 100644 index 9508e0186..000000000 --- a/build/platformclientv2/queueconversationeventtopicurireference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationeventtopicurireference -type Queueconversationeventtopicurireference struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationeventtopicurireference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationeventtopicvideo.go b/build/platformclientv2/queueconversationeventtopicvideo.go deleted file mode 100644 index c03acc872..000000000 --- a/build/platformclientv2/queueconversationeventtopicvideo.go +++ /dev/null @@ -1,86 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queueconversationeventtopicvideo -type Queueconversationeventtopicvideo struct { - // State - State *string `json:"state,omitempty"` - - - // Self - Self *Queueconversationeventtopicaddress `json:"self,omitempty"` - - - // Id - Id *string `json:"id,omitempty"` - - - // Context - Context *string `json:"context,omitempty"` - - - // AudioMuted - AudioMuted *bool `json:"audioMuted,omitempty"` - - - // VideoMuted - VideoMuted *bool `json:"videoMuted,omitempty"` - - - // SharingScreen - SharingScreen *bool `json:"sharingScreen,omitempty"` - - - // Provider - Provider *string `json:"provider,omitempty"` - - - // ScriptId - ScriptId *string `json:"scriptId,omitempty"` - - - // PeerId - PeerId *string `json:"peerId,omitempty"` - - - // DisconnectType - DisconnectType *string `json:"disconnectType,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // DisconnectedTime - DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"` - - - // Msids - Msids *[]string `json:"msids,omitempty"` - - - // Wrapup - Wrapup *Queueconversationeventtopicwrapup `json:"wrapup,omitempty"` - - - // AfterCallWork - AfterCallWork *Queueconversationeventtopicaftercallwork `json:"afterCallWork,omitempty"` - - - // AfterCallWorkRequired - AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationeventtopicvideo) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationeventtopicvoicemail.go b/build/platformclientv2/queueconversationeventtopicvoicemail.go deleted file mode 100644 index aacd3f26d..000000000 --- a/build/platformclientv2/queueconversationeventtopicvoicemail.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationeventtopicvoicemail -type Queueconversationeventtopicvoicemail struct { - // Id - Id *string `json:"id,omitempty"` - - - // UploadStatus - UploadStatus *string `json:"uploadStatus,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationeventtopicvoicemail) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationeventtopicwrapup.go b/build/platformclientv2/queueconversationeventtopicwrapup.go deleted file mode 100644 index c75c4b006..000000000 --- a/build/platformclientv2/queueconversationeventtopicwrapup.go +++ /dev/null @@ -1,38 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queueconversationeventtopicwrapup -type Queueconversationeventtopicwrapup struct { - // Code - Code *string `json:"code,omitempty"` - - - // Notes - Notes *string `json:"notes,omitempty"` - - - // Tags - Tags *[]string `json:"tags,omitempty"` - - - // DurationSeconds - DurationSeconds *int `json:"durationSeconds,omitempty"` - - - // EndTime - EndTime *time.Time `json:"endTime,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationeventtopicwrapup) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationmessageeventtopicconversationroutingdata.go b/build/platformclientv2/queueconversationmessageeventtopicconversationroutingdata.go deleted file mode 100644 index c4bd38b63..000000000 --- a/build/platformclientv2/queueconversationmessageeventtopicconversationroutingdata.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationmessageeventtopicconversationroutingdata -type Queueconversationmessageeventtopicconversationroutingdata struct { - // Queue - Queue *Queueconversationmessageeventtopicurireference `json:"queue,omitempty"` - - - // Language - Language *Queueconversationmessageeventtopicurireference `json:"language,omitempty"` - - - // Priority - Priority *int `json:"priority,omitempty"` - - - // Skills - Skills *[]Queueconversationmessageeventtopicurireference `json:"skills,omitempty"` - - - // ScoredAgents - ScoredAgents *[]Queueconversationmessageeventtopicscoredagent `json:"scoredAgents,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationmessageeventtopicconversationroutingdata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationmessageeventtopicdetail.go b/build/platformclientv2/queueconversationmessageeventtopicdetail.go deleted file mode 100644 index 082f643f1..000000000 --- a/build/platformclientv2/queueconversationmessageeventtopicdetail.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationmessageeventtopicdetail -type Queueconversationmessageeventtopicdetail struct { - // ErrorCode - ErrorCode *string `json:"errorCode,omitempty"` - - - // FieldName - FieldName *string `json:"fieldName,omitempty"` - - - // EntityId - EntityId *string `json:"entityId,omitempty"` - - - // EntityName - EntityName *string `json:"entityName,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationmessageeventtopicdetail) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationmessageeventtopicerrorbody.go b/build/platformclientv2/queueconversationmessageeventtopicerrorbody.go deleted file mode 100644 index 28cfe97d6..000000000 --- a/build/platformclientv2/queueconversationmessageeventtopicerrorbody.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationmessageeventtopicerrorbody -type Queueconversationmessageeventtopicerrorbody struct { - // Status - Status *int `json:"status,omitempty"` - - - // Code - Code *string `json:"code,omitempty"` - - - // EntityId - EntityId *string `json:"entityId,omitempty"` - - - // EntityName - EntityName *string `json:"entityName,omitempty"` - - - // Message - Message *string `json:"message,omitempty"` - - - // MessageWithParams - MessageWithParams *string `json:"messageWithParams,omitempty"` - - - // MessageParams - MessageParams *map[string]string `json:"messageParams,omitempty"` - - - // ContextId - ContextId *string `json:"contextId,omitempty"` - - - // Details - Details *[]Queueconversationmessageeventtopicdetail `json:"details,omitempty"` - - - // Errors - Errors *[]Queueconversationmessageeventtopicerrorbody `json:"errors,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationmessageeventtopicerrorbody) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationmessageeventtopicjourneyaction.go b/build/platformclientv2/queueconversationmessageeventtopicjourneyaction.go deleted file mode 100644 index 31b16bdfa..000000000 --- a/build/platformclientv2/queueconversationmessageeventtopicjourneyaction.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationmessageeventtopicjourneyaction -type Queueconversationmessageeventtopicjourneyaction struct { - // Id - Id *string `json:"id,omitempty"` - - - // ActionMap - ActionMap *Queueconversationmessageeventtopicjourneyactionmap `json:"actionMap,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationmessageeventtopicjourneyaction) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationmessageeventtopicjourneyactionmap.go b/build/platformclientv2/queueconversationmessageeventtopicjourneyactionmap.go deleted file mode 100644 index 44ce0b491..000000000 --- a/build/platformclientv2/queueconversationmessageeventtopicjourneyactionmap.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationmessageeventtopicjourneyactionmap -type Queueconversationmessageeventtopicjourneyactionmap struct { - // Id - Id *string `json:"id,omitempty"` - - - // Version - Version *int `json:"version,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationmessageeventtopicjourneyactionmap) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationmessageeventtopicjourneycontext.go b/build/platformclientv2/queueconversationmessageeventtopicjourneycontext.go deleted file mode 100644 index a0d557560..000000000 --- a/build/platformclientv2/queueconversationmessageeventtopicjourneycontext.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationmessageeventtopicjourneycontext -type Queueconversationmessageeventtopicjourneycontext struct { - // Customer - Customer *Queueconversationmessageeventtopicjourneycustomer `json:"customer,omitempty"` - - - // CustomerSession - CustomerSession *Queueconversationmessageeventtopicjourneycustomersession `json:"customerSession,omitempty"` - - - // TriggeringAction - TriggeringAction *Queueconversationmessageeventtopicjourneyaction `json:"triggeringAction,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationmessageeventtopicjourneycontext) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationmessageeventtopicjourneycustomer.go b/build/platformclientv2/queueconversationmessageeventtopicjourneycustomer.go deleted file mode 100644 index f911e5cf2..000000000 --- a/build/platformclientv2/queueconversationmessageeventtopicjourneycustomer.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationmessageeventtopicjourneycustomer -type Queueconversationmessageeventtopicjourneycustomer struct { - // Id - Id *string `json:"id,omitempty"` - - - // IdType - IdType *string `json:"idType,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationmessageeventtopicjourneycustomer) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationmessageeventtopicjourneycustomersession.go b/build/platformclientv2/queueconversationmessageeventtopicjourneycustomersession.go deleted file mode 100644 index b16d06796..000000000 --- a/build/platformclientv2/queueconversationmessageeventtopicjourneycustomersession.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationmessageeventtopicjourneycustomersession -type Queueconversationmessageeventtopicjourneycustomersession struct { - // Id - Id *string `json:"id,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationmessageeventtopicjourneycustomersession) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationmessageeventtopicmessageconversation.go b/build/platformclientv2/queueconversationmessageeventtopicmessageconversation.go deleted file mode 100644 index e32c8b691..000000000 --- a/build/platformclientv2/queueconversationmessageeventtopicmessageconversation.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationmessageeventtopicmessageconversation -type Queueconversationmessageeventtopicmessageconversation struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Participants - Participants *[]Queueconversationmessageeventtopicmessagemediaparticipant `json:"participants,omitempty"` - - - // OtherMediaUris - OtherMediaUris *[]string `json:"otherMediaUris,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationmessageeventtopicmessageconversation) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationmessageeventtopicmessagedetails.go b/build/platformclientv2/queueconversationmessageeventtopicmessagedetails.go deleted file mode 100644 index 63d3fbf08..000000000 --- a/build/platformclientv2/queueconversationmessageeventtopicmessagedetails.go +++ /dev/null @@ -1,38 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queueconversationmessageeventtopicmessagedetails -type Queueconversationmessageeventtopicmessagedetails struct { - // Message - Message *Queueconversationmessageeventtopicurireference `json:"message,omitempty"` - - - // MessageTime - MessageTime *time.Time `json:"messageTime,omitempty"` - - - // MessageSegmentCount - MessageSegmentCount *int `json:"messageSegmentCount,omitempty"` - - - // MessageStatus - MessageStatus *string `json:"messageStatus,omitempty"` - - - // Media - Media *[]Queueconversationmessageeventtopicmessagemedia `json:"media,omitempty"` - - - // Stickers - Stickers *[]Queueconversationmessageeventtopicmessagesticker `json:"stickers,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationmessageeventtopicmessagedetails) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationmessageeventtopicmessagemedia.go b/build/platformclientv2/queueconversationmessageeventtopicmessagemedia.go deleted file mode 100644 index d61e0e834..000000000 --- a/build/platformclientv2/queueconversationmessageeventtopicmessagemedia.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationmessageeventtopicmessagemedia -type Queueconversationmessageeventtopicmessagemedia struct { - // Url - Url *string `json:"url,omitempty"` - - - // MediaType - MediaType *string `json:"mediaType,omitempty"` - - - // ContentLengthBytes - ContentLengthBytes *int `json:"contentLengthBytes,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Id - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationmessageeventtopicmessagemedia) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationmessageeventtopicmessagemediaparticipant.go b/build/platformclientv2/queueconversationmessageeventtopicmessagemediaparticipant.go deleted file mode 100644 index e552bcb00..000000000 --- a/build/platformclientv2/queueconversationmessageeventtopicmessagemediaparticipant.go +++ /dev/null @@ -1,166 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queueconversationmessageeventtopicmessagemediaparticipant -type Queueconversationmessageeventtopicmessagemediaparticipant struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Address - Address *string `json:"address,omitempty"` - - - // StartTime - StartTime *time.Time `json:"startTime,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // EndTime - EndTime *time.Time `json:"endTime,omitempty"` - - - // StartHoldTime - StartHoldTime *time.Time `json:"startHoldTime,omitempty"` - - - // Purpose - Purpose *string `json:"purpose,omitempty"` - - - // State - State *string `json:"state,omitempty"` - - - // Direction - Direction *string `json:"direction,omitempty"` - - - // DisconnectType - DisconnectType *string `json:"disconnectType,omitempty"` - - - // Held - Held *bool `json:"held,omitempty"` - - - // WrapupRequired - WrapupRequired *bool `json:"wrapupRequired,omitempty"` - - - // WrapupPrompt - WrapupPrompt *string `json:"wrapupPrompt,omitempty"` - - - // User - User *Queueconversationmessageeventtopicurireference `json:"user,omitempty"` - - - // Queue - Queue *Queueconversationmessageeventtopicurireference `json:"queue,omitempty"` - - - // Team - Team *Queueconversationmessageeventtopicurireference `json:"team,omitempty"` - - - // Attributes - Attributes *map[string]string `json:"attributes,omitempty"` - - - // ErrorInfo - ErrorInfo *Queueconversationmessageeventtopicerrorbody `json:"errorInfo,omitempty"` - - - // Script - Script *Queueconversationmessageeventtopicurireference `json:"script,omitempty"` - - - // WrapupTimeoutMs - WrapupTimeoutMs *int `json:"wrapupTimeoutMs,omitempty"` - - - // WrapupSkipped - WrapupSkipped *bool `json:"wrapupSkipped,omitempty"` - - - // AlertingTimeoutMs - AlertingTimeoutMs *int `json:"alertingTimeoutMs,omitempty"` - - - // Provider - Provider *string `json:"provider,omitempty"` - - - // ExternalContact - ExternalContact *Queueconversationmessageeventtopicurireference `json:"externalContact,omitempty"` - - - // ExternalOrganization - ExternalOrganization *Queueconversationmessageeventtopicurireference `json:"externalOrganization,omitempty"` - - - // Wrapup - Wrapup *Queueconversationmessageeventtopicwrapup `json:"wrapup,omitempty"` - - - // ConversationRoutingData - ConversationRoutingData *Queueconversationmessageeventtopicconversationroutingdata `json:"conversationRoutingData,omitempty"` - - - // Peer - Peer *string `json:"peer,omitempty"` - - - // ScreenRecordingState - ScreenRecordingState *string `json:"screenRecordingState,omitempty"` - - - // FlaggedReason - FlaggedReason *string `json:"flaggedReason,omitempty"` - - - // JourneyContext - JourneyContext *Queueconversationmessageeventtopicjourneycontext `json:"journeyContext,omitempty"` - - - // StartAcwTime - StartAcwTime *time.Time `json:"startAcwTime,omitempty"` - - - // EndAcwTime - EndAcwTime *time.Time `json:"endAcwTime,omitempty"` - - - // Messages - Messages *[]Queueconversationmessageeventtopicmessagedetails `json:"messages,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - - - // RecipientCountry - RecipientCountry *string `json:"recipientCountry,omitempty"` - - - // RecipientType - RecipientType *string `json:"recipientType,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationmessageeventtopicmessagemediaparticipant) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationmessageeventtopicmessagesticker.go b/build/platformclientv2/queueconversationmessageeventtopicmessagesticker.go deleted file mode 100644 index bb67c59d9..000000000 --- a/build/platformclientv2/queueconversationmessageeventtopicmessagesticker.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationmessageeventtopicmessagesticker -type Queueconversationmessageeventtopicmessagesticker struct { - // Url - Url *string `json:"url,omitempty"` - - - // Id - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationmessageeventtopicmessagesticker) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationmessageeventtopicscoredagent.go b/build/platformclientv2/queueconversationmessageeventtopicscoredagent.go deleted file mode 100644 index fca66ffe7..000000000 --- a/build/platformclientv2/queueconversationmessageeventtopicscoredagent.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationmessageeventtopicscoredagent -type Queueconversationmessageeventtopicscoredagent struct { - // Agent - Agent *Queueconversationmessageeventtopicurireference `json:"agent,omitempty"` - - - // Score - Score *int `json:"score,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationmessageeventtopicscoredagent) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationmessageeventtopicurireference.go b/build/platformclientv2/queueconversationmessageeventtopicurireference.go deleted file mode 100644 index 2f38f7867..000000000 --- a/build/platformclientv2/queueconversationmessageeventtopicurireference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationmessageeventtopicurireference -type Queueconversationmessageeventtopicurireference struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationmessageeventtopicurireference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationmessageeventtopicwrapup.go b/build/platformclientv2/queueconversationmessageeventtopicwrapup.go deleted file mode 100644 index f4627f7cb..000000000 --- a/build/platformclientv2/queueconversationmessageeventtopicwrapup.go +++ /dev/null @@ -1,38 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queueconversationmessageeventtopicwrapup -type Queueconversationmessageeventtopicwrapup struct { - // Code - Code *string `json:"code,omitempty"` - - - // Notes - Notes *string `json:"notes,omitempty"` - - - // Tags - Tags *[]string `json:"tags,omitempty"` - - - // DurationSeconds - DurationSeconds *int `json:"durationSeconds,omitempty"` - - - // EndTime - EndTime *time.Time `json:"endTime,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationmessageeventtopicwrapup) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationscreenshareeventtopicconversationroutingdata.go b/build/platformclientv2/queueconversationscreenshareeventtopicconversationroutingdata.go deleted file mode 100644 index bb005153a..000000000 --- a/build/platformclientv2/queueconversationscreenshareeventtopicconversationroutingdata.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationscreenshareeventtopicconversationroutingdata -type Queueconversationscreenshareeventtopicconversationroutingdata struct { - // Queue - Queue *Queueconversationscreenshareeventtopicurireference `json:"queue,omitempty"` - - - // Language - Language *Queueconversationscreenshareeventtopicurireference `json:"language,omitempty"` - - - // Priority - Priority *int `json:"priority,omitempty"` - - - // Skills - Skills *[]Queueconversationscreenshareeventtopicurireference `json:"skills,omitempty"` - - - // ScoredAgents - ScoredAgents *[]Queueconversationscreenshareeventtopicscoredagent `json:"scoredAgents,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationscreenshareeventtopicconversationroutingdata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationscreenshareeventtopicdetail.go b/build/platformclientv2/queueconversationscreenshareeventtopicdetail.go deleted file mode 100644 index ee63a92eb..000000000 --- a/build/platformclientv2/queueconversationscreenshareeventtopicdetail.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationscreenshareeventtopicdetail -type Queueconversationscreenshareeventtopicdetail struct { - // ErrorCode - ErrorCode *string `json:"errorCode,omitempty"` - - - // FieldName - FieldName *string `json:"fieldName,omitempty"` - - - // EntityId - EntityId *string `json:"entityId,omitempty"` - - - // EntityName - EntityName *string `json:"entityName,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationscreenshareeventtopicdetail) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationscreenshareeventtopicerrorbody.go b/build/platformclientv2/queueconversationscreenshareeventtopicerrorbody.go deleted file mode 100644 index a46f5872a..000000000 --- a/build/platformclientv2/queueconversationscreenshareeventtopicerrorbody.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationscreenshareeventtopicerrorbody -type Queueconversationscreenshareeventtopicerrorbody struct { - // Status - Status *int `json:"status,omitempty"` - - - // Code - Code *string `json:"code,omitempty"` - - - // EntityId - EntityId *string `json:"entityId,omitempty"` - - - // EntityName - EntityName *string `json:"entityName,omitempty"` - - - // Message - Message *string `json:"message,omitempty"` - - - // MessageWithParams - MessageWithParams *string `json:"messageWithParams,omitempty"` - - - // MessageParams - MessageParams *map[string]string `json:"messageParams,omitempty"` - - - // ContextId - ContextId *string `json:"contextId,omitempty"` - - - // Details - Details *[]Queueconversationscreenshareeventtopicdetail `json:"details,omitempty"` - - - // Errors - Errors *[]Queueconversationscreenshareeventtopicerrorbody `json:"errors,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationscreenshareeventtopicerrorbody) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationscreenshareeventtopicjourneyaction.go b/build/platformclientv2/queueconversationscreenshareeventtopicjourneyaction.go deleted file mode 100644 index d80b2ac66..000000000 --- a/build/platformclientv2/queueconversationscreenshareeventtopicjourneyaction.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationscreenshareeventtopicjourneyaction -type Queueconversationscreenshareeventtopicjourneyaction struct { - // Id - Id *string `json:"id,omitempty"` - - - // ActionMap - ActionMap *Queueconversationscreenshareeventtopicjourneyactionmap `json:"actionMap,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationscreenshareeventtopicjourneyaction) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationscreenshareeventtopicjourneyactionmap.go b/build/platformclientv2/queueconversationscreenshareeventtopicjourneyactionmap.go deleted file mode 100644 index 667bd119d..000000000 --- a/build/platformclientv2/queueconversationscreenshareeventtopicjourneyactionmap.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationscreenshareeventtopicjourneyactionmap -type Queueconversationscreenshareeventtopicjourneyactionmap struct { - // Id - Id *string `json:"id,omitempty"` - - - // Version - Version *int `json:"version,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationscreenshareeventtopicjourneyactionmap) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationscreenshareeventtopicjourneycontext.go b/build/platformclientv2/queueconversationscreenshareeventtopicjourneycontext.go deleted file mode 100644 index e756505ec..000000000 --- a/build/platformclientv2/queueconversationscreenshareeventtopicjourneycontext.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationscreenshareeventtopicjourneycontext -type Queueconversationscreenshareeventtopicjourneycontext struct { - // Customer - Customer *Queueconversationscreenshareeventtopicjourneycustomer `json:"customer,omitempty"` - - - // CustomerSession - CustomerSession *Queueconversationscreenshareeventtopicjourneycustomersession `json:"customerSession,omitempty"` - - - // TriggeringAction - TriggeringAction *Queueconversationscreenshareeventtopicjourneyaction `json:"triggeringAction,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationscreenshareeventtopicjourneycontext) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationscreenshareeventtopicjourneycustomer.go b/build/platformclientv2/queueconversationscreenshareeventtopicjourneycustomer.go deleted file mode 100644 index 316bc4211..000000000 --- a/build/platformclientv2/queueconversationscreenshareeventtopicjourneycustomer.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationscreenshareeventtopicjourneycustomer -type Queueconversationscreenshareeventtopicjourneycustomer struct { - // Id - Id *string `json:"id,omitempty"` - - - // IdType - IdType *string `json:"idType,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationscreenshareeventtopicjourneycustomer) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationscreenshareeventtopicjourneycustomersession.go b/build/platformclientv2/queueconversationscreenshareeventtopicjourneycustomersession.go deleted file mode 100644 index 4526ddd0a..000000000 --- a/build/platformclientv2/queueconversationscreenshareeventtopicjourneycustomersession.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationscreenshareeventtopicjourneycustomersession -type Queueconversationscreenshareeventtopicjourneycustomersession struct { - // Id - Id *string `json:"id,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationscreenshareeventtopicjourneycustomersession) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationscreenshareeventtopicscoredagent.go b/build/platformclientv2/queueconversationscreenshareeventtopicscoredagent.go deleted file mode 100644 index c29e4764e..000000000 --- a/build/platformclientv2/queueconversationscreenshareeventtopicscoredagent.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationscreenshareeventtopicscoredagent -type Queueconversationscreenshareeventtopicscoredagent struct { - // Agent - Agent *Queueconversationscreenshareeventtopicurireference `json:"agent,omitempty"` - - - // Score - Score *int `json:"score,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationscreenshareeventtopicscoredagent) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationscreenshareeventtopicscreenshareconversation.go b/build/platformclientv2/queueconversationscreenshareeventtopicscreenshareconversation.go deleted file mode 100644 index 130ac2644..000000000 --- a/build/platformclientv2/queueconversationscreenshareeventtopicscreenshareconversation.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationscreenshareeventtopicscreenshareconversation -type Queueconversationscreenshareeventtopicscreenshareconversation struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Participants - Participants *[]Queueconversationscreenshareeventtopicscreensharemediaparticipant `json:"participants,omitempty"` - - - // OtherMediaUris - OtherMediaUris *[]string `json:"otherMediaUris,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationscreenshareeventtopicscreenshareconversation) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationscreenshareeventtopicscreensharemediaparticipant.go b/build/platformclientv2/queueconversationscreenshareeventtopicscreensharemediaparticipant.go deleted file mode 100644 index 8e9d0c64f..000000000 --- a/build/platformclientv2/queueconversationscreenshareeventtopicscreensharemediaparticipant.go +++ /dev/null @@ -1,162 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queueconversationscreenshareeventtopicscreensharemediaparticipant -type Queueconversationscreenshareeventtopicscreensharemediaparticipant struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Address - Address *string `json:"address,omitempty"` - - - // StartTime - StartTime *time.Time `json:"startTime,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // EndTime - EndTime *time.Time `json:"endTime,omitempty"` - - - // StartHoldTime - StartHoldTime *time.Time `json:"startHoldTime,omitempty"` - - - // Purpose - Purpose *string `json:"purpose,omitempty"` - - - // State - State *string `json:"state,omitempty"` - - - // Direction - Direction *string `json:"direction,omitempty"` - - - // DisconnectType - DisconnectType *string `json:"disconnectType,omitempty"` - - - // Held - Held *bool `json:"held,omitempty"` - - - // WrapupRequired - WrapupRequired *bool `json:"wrapupRequired,omitempty"` - - - // WrapupPrompt - WrapupPrompt *string `json:"wrapupPrompt,omitempty"` - - - // User - User *Queueconversationscreenshareeventtopicurireference `json:"user,omitempty"` - - - // Queue - Queue *Queueconversationscreenshareeventtopicurireference `json:"queue,omitempty"` - - - // Team - Team *Queueconversationscreenshareeventtopicurireference `json:"team,omitempty"` - - - // Attributes - Attributes *map[string]string `json:"attributes,omitempty"` - - - // ErrorInfo - ErrorInfo *Queueconversationscreenshareeventtopicerrorbody `json:"errorInfo,omitempty"` - - - // Script - Script *Queueconversationscreenshareeventtopicurireference `json:"script,omitempty"` - - - // WrapupTimeoutMs - WrapupTimeoutMs *int `json:"wrapupTimeoutMs,omitempty"` - - - // WrapupSkipped - WrapupSkipped *bool `json:"wrapupSkipped,omitempty"` - - - // AlertingTimeoutMs - AlertingTimeoutMs *int `json:"alertingTimeoutMs,omitempty"` - - - // Provider - Provider *string `json:"provider,omitempty"` - - - // ExternalContact - ExternalContact *Queueconversationscreenshareeventtopicurireference `json:"externalContact,omitempty"` - - - // ExternalOrganization - ExternalOrganization *Queueconversationscreenshareeventtopicurireference `json:"externalOrganization,omitempty"` - - - // Wrapup - Wrapup *Queueconversationscreenshareeventtopicwrapup `json:"wrapup,omitempty"` - - - // ConversationRoutingData - ConversationRoutingData *Queueconversationscreenshareeventtopicconversationroutingdata `json:"conversationRoutingData,omitempty"` - - - // Peer - Peer *string `json:"peer,omitempty"` - - - // ScreenRecordingState - ScreenRecordingState *string `json:"screenRecordingState,omitempty"` - - - // FlaggedReason - FlaggedReason *string `json:"flaggedReason,omitempty"` - - - // JourneyContext - JourneyContext *Queueconversationscreenshareeventtopicjourneycontext `json:"journeyContext,omitempty"` - - - // StartAcwTime - StartAcwTime *time.Time `json:"startAcwTime,omitempty"` - - - // EndAcwTime - EndAcwTime *time.Time `json:"endAcwTime,omitempty"` - - - // Context - Context *string `json:"context,omitempty"` - - - // PeerCount - PeerCount *int `json:"peerCount,omitempty"` - - - // Sharing - Sharing *bool `json:"sharing,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationscreenshareeventtopicscreensharemediaparticipant) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationscreenshareeventtopicurireference.go b/build/platformclientv2/queueconversationscreenshareeventtopicurireference.go deleted file mode 100644 index 924d8ff22..000000000 --- a/build/platformclientv2/queueconversationscreenshareeventtopicurireference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationscreenshareeventtopicurireference -type Queueconversationscreenshareeventtopicurireference struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationscreenshareeventtopicurireference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationscreenshareeventtopicwrapup.go b/build/platformclientv2/queueconversationscreenshareeventtopicwrapup.go deleted file mode 100644 index a9c2eaafe..000000000 --- a/build/platformclientv2/queueconversationscreenshareeventtopicwrapup.go +++ /dev/null @@ -1,38 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queueconversationscreenshareeventtopicwrapup -type Queueconversationscreenshareeventtopicwrapup struct { - // Code - Code *string `json:"code,omitempty"` - - - // Notes - Notes *string `json:"notes,omitempty"` - - - // Tags - Tags *[]string `json:"tags,omitempty"` - - - // DurationSeconds - DurationSeconds *int `json:"durationSeconds,omitempty"` - - - // EndTime - EndTime *time.Time `json:"endTime,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationscreenshareeventtopicwrapup) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationsocialexpressioneventtopicaddress.go b/build/platformclientv2/queueconversationsocialexpressioneventtopicaddress.go deleted file mode 100644 index 7e14e7757..000000000 --- a/build/platformclientv2/queueconversationsocialexpressioneventtopicaddress.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationsocialexpressioneventtopicaddress -type Queueconversationsocialexpressioneventtopicaddress struct { - // Name - Name *string `json:"name,omitempty"` - - - // NameRaw - NameRaw *string `json:"nameRaw,omitempty"` - - - // AddressNormalized - AddressNormalized *string `json:"addressNormalized,omitempty"` - - - // AddressRaw - AddressRaw *string `json:"addressRaw,omitempty"` - - - // AddressDisplayable - AddressDisplayable *string `json:"addressDisplayable,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationsocialexpressioneventtopicaddress) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationsocialexpressioneventtopicaftercallwork.go b/build/platformclientv2/queueconversationsocialexpressioneventtopicaftercallwork.go deleted file mode 100644 index 93b8f54ec..000000000 --- a/build/platformclientv2/queueconversationsocialexpressioneventtopicaftercallwork.go +++ /dev/null @@ -1,26 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queueconversationsocialexpressioneventtopicaftercallwork -type Queueconversationsocialexpressioneventtopicaftercallwork struct { - // State - State *string `json:"state,omitempty"` - - - // StartTime - StartTime *time.Time `json:"startTime,omitempty"` - - - // EndTime - EndTime *time.Time `json:"endTime,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationsocialexpressioneventtopicaftercallwork) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationsocialexpressioneventtopicattachment.go b/build/platformclientv2/queueconversationsocialexpressioneventtopicattachment.go deleted file mode 100644 index a23b668bc..000000000 --- a/build/platformclientv2/queueconversationsocialexpressioneventtopicattachment.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationsocialexpressioneventtopicattachment -type Queueconversationsocialexpressioneventtopicattachment struct { - // AttachmentId - AttachmentId *string `json:"attachmentId,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // ContentUri - ContentUri *string `json:"contentUri,omitempty"` - - - // ContentType - ContentType *string `json:"contentType,omitempty"` - - - // ContentLength - ContentLength *int `json:"contentLength,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationsocialexpressioneventtopicattachment) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationsocialexpressioneventtopiccall.go b/build/platformclientv2/queueconversationsocialexpressioneventtopiccall.go deleted file mode 100644 index 702a7a368..000000000 --- a/build/platformclientv2/queueconversationsocialexpressioneventtopiccall.go +++ /dev/null @@ -1,122 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queueconversationsocialexpressioneventtopiccall -type Queueconversationsocialexpressioneventtopiccall struct { - // Id - Id *string `json:"id,omitempty"` - - - // State - State *string `json:"state,omitempty"` - - - // Recording - Recording *bool `json:"recording,omitempty"` - - - // RecordingState - RecordingState *string `json:"recordingState,omitempty"` - - - // Muted - Muted *bool `json:"muted,omitempty"` - - - // Confined - Confined *bool `json:"confined,omitempty"` - - - // Held - Held *bool `json:"held,omitempty"` - - - // ErrorInfo - ErrorInfo *Queueconversationsocialexpressioneventtopicerrordetails `json:"errorInfo,omitempty"` - - - // DisconnectType - DisconnectType *string `json:"disconnectType,omitempty"` - - - // StartHoldTime - StartHoldTime *time.Time `json:"startHoldTime,omitempty"` - - - // Direction - Direction *string `json:"direction,omitempty"` - - - // DocumentId - DocumentId *string `json:"documentId,omitempty"` - - - // Self - Self *Queueconversationsocialexpressioneventtopicaddress `json:"self,omitempty"` - - - // Other - Other *Queueconversationsocialexpressioneventtopicaddress `json:"other,omitempty"` - - - // Provider - Provider *string `json:"provider,omitempty"` - - - // ScriptId - ScriptId *string `json:"scriptId,omitempty"` - - - // PeerId - PeerId *string `json:"peerId,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // DisconnectedTime - DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"` - - - // DisconnectReasons - DisconnectReasons *[]Queueconversationsocialexpressioneventtopicdisconnectreason `json:"disconnectReasons,omitempty"` - - - // FaxStatus - FaxStatus *Queueconversationsocialexpressioneventtopicfaxstatus `json:"faxStatus,omitempty"` - - - // UuiData - UuiData *string `json:"uuiData,omitempty"` - - - // Wrapup - Wrapup *Queueconversationsocialexpressioneventtopicwrapup `json:"wrapup,omitempty"` - - - // AfterCallWork - AfterCallWork *Queueconversationsocialexpressioneventtopicaftercallwork `json:"afterCallWork,omitempty"` - - - // AfterCallWorkRequired - AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"` - - - // AgentAssistantId - AgentAssistantId *string `json:"agentAssistantId,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationsocialexpressioneventtopiccall) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationsocialexpressioneventtopiccallback.go b/build/platformclientv2/queueconversationsocialexpressioneventtopiccallback.go deleted file mode 100644 index b7ba73250..000000000 --- a/build/platformclientv2/queueconversationsocialexpressioneventtopiccallback.go +++ /dev/null @@ -1,110 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queueconversationsocialexpressioneventtopiccallback -type Queueconversationsocialexpressioneventtopiccallback struct { - // State - State *string `json:"state,omitempty"` - - - // Id - Id *string `json:"id,omitempty"` - - - // Direction - Direction *string `json:"direction,omitempty"` - - - // Held - Held *bool `json:"held,omitempty"` - - - // DisconnectType - DisconnectType *string `json:"disconnectType,omitempty"` - - - // StartHoldTime - StartHoldTime *time.Time `json:"startHoldTime,omitempty"` - - - // DialerPreview - DialerPreview *Queueconversationsocialexpressioneventtopicdialerpreview `json:"dialerPreview,omitempty"` - - - // Voicemail - Voicemail *Queueconversationsocialexpressioneventtopicvoicemail `json:"voicemail,omitempty"` - - - // CallbackNumbers - CallbackNumbers *[]string `json:"callbackNumbers,omitempty"` - - - // CallbackUserName - CallbackUserName *string `json:"callbackUserName,omitempty"` - - - // ScriptId - ScriptId *string `json:"scriptId,omitempty"` - - - // PeerId - PeerId *string `json:"peerId,omitempty"` - - - // ExternalCampaign - ExternalCampaign *bool `json:"externalCampaign,omitempty"` - - - // SkipEnabled - SkipEnabled *bool `json:"skipEnabled,omitempty"` - - - // Provider - Provider *string `json:"provider,omitempty"` - - - // TimeoutSeconds - TimeoutSeconds *int `json:"timeoutSeconds,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // DisconnectedTime - DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"` - - - // CallbackScheduledTime - CallbackScheduledTime *time.Time `json:"callbackScheduledTime,omitempty"` - - - // AutomatedCallbackConfigId - AutomatedCallbackConfigId *string `json:"automatedCallbackConfigId,omitempty"` - - - // Wrapup - Wrapup *Queueconversationsocialexpressioneventtopicwrapup `json:"wrapup,omitempty"` - - - // AfterCallWork - AfterCallWork *Queueconversationsocialexpressioneventtopicaftercallwork `json:"afterCallWork,omitempty"` - - - // AfterCallWorkRequired - AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationsocialexpressioneventtopiccallback) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationsocialexpressioneventtopicchat.go b/build/platformclientv2/queueconversationsocialexpressioneventtopicchat.go deleted file mode 100644 index a9c2a7e5c..000000000 --- a/build/platformclientv2/queueconversationsocialexpressioneventtopicchat.go +++ /dev/null @@ -1,82 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queueconversationsocialexpressioneventtopicchat -type Queueconversationsocialexpressioneventtopicchat struct { - // State - State *string `json:"state,omitempty"` - - - // Id - Id *string `json:"id,omitempty"` - - - // Provider - Provider *string `json:"provider,omitempty"` - - - // ScriptId - ScriptId *string `json:"scriptId,omitempty"` - - - // PeerId - PeerId *string `json:"peerId,omitempty"` - - - // RoomId - RoomId *string `json:"roomId,omitempty"` - - - // AvatarImageUrl - AvatarImageUrl *string `json:"avatarImageUrl,omitempty"` - - - // Held - Held *bool `json:"held,omitempty"` - - - // DisconnectType - DisconnectType *string `json:"disconnectType,omitempty"` - - - // StartHoldTime - StartHoldTime *time.Time `json:"startHoldTime,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // DisconnectedTime - DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"` - - - // JourneyContext - JourneyContext *Queueconversationsocialexpressioneventtopicjourneycontext `json:"journeyContext,omitempty"` - - - // Wrapup - Wrapup *Queueconversationsocialexpressioneventtopicwrapup `json:"wrapup,omitempty"` - - - // AfterCallWork - AfterCallWork *Queueconversationsocialexpressioneventtopicaftercallwork `json:"afterCallWork,omitempty"` - - - // AfterCallWorkRequired - AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationsocialexpressioneventtopicchat) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationsocialexpressioneventtopiccobrowse.go b/build/platformclientv2/queueconversationsocialexpressioneventtopiccobrowse.go deleted file mode 100644 index 93161f6c7..000000000 --- a/build/platformclientv2/queueconversationsocialexpressioneventtopiccobrowse.go +++ /dev/null @@ -1,90 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queueconversationsocialexpressioneventtopiccobrowse -type Queueconversationsocialexpressioneventtopiccobrowse struct { - // State - State *string `json:"state,omitempty"` - - - // DisconnectType - DisconnectType *string `json:"disconnectType,omitempty"` - - - // Id - Id *string `json:"id,omitempty"` - - - // Self - Self *Queueconversationsocialexpressioneventtopicaddress `json:"self,omitempty"` - - - // RoomId - RoomId *string `json:"roomId,omitempty"` - - - // CobrowseSessionId - CobrowseSessionId *string `json:"cobrowseSessionId,omitempty"` - - - // CobrowseRole - CobrowseRole *string `json:"cobrowseRole,omitempty"` - - - // Controlling - Controlling *[]string `json:"controlling,omitempty"` - - - // ViewerUrl - ViewerUrl *string `json:"viewerUrl,omitempty"` - - - // Provider - Provider *string `json:"provider,omitempty"` - - - // ScriptId - ScriptId *string `json:"scriptId,omitempty"` - - - // PeerId - PeerId *string `json:"peerId,omitempty"` - - - // ProviderEventTime - ProviderEventTime *time.Time `json:"providerEventTime,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // DisconnectedTime - DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"` - - - // Wrapup - Wrapup *Queueconversationsocialexpressioneventtopicwrapup `json:"wrapup,omitempty"` - - - // AfterCallWork - AfterCallWork *Queueconversationsocialexpressioneventtopicaftercallwork `json:"afterCallWork,omitempty"` - - - // AfterCallWorkRequired - AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationsocialexpressioneventtopiccobrowse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationsocialexpressioneventtopicconversation.go b/build/platformclientv2/queueconversationsocialexpressioneventtopicconversation.go deleted file mode 100644 index 2de837244..000000000 --- a/build/platformclientv2/queueconversationsocialexpressioneventtopicconversation.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationsocialexpressioneventtopicconversation -type Queueconversationsocialexpressioneventtopicconversation struct { - // Id - Id *string `json:"id,omitempty"` - - - // MaxParticipants - MaxParticipants *int `json:"maxParticipants,omitempty"` - - - // Participants - Participants *[]Queueconversationsocialexpressioneventtopicparticipant `json:"participants,omitempty"` - - - // RecordingState - RecordingState *string `json:"recordingState,omitempty"` - - - // Address - Address *string `json:"address,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationsocialexpressioneventtopicconversation) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationsocialexpressioneventtopicconversationroutingdata.go b/build/platformclientv2/queueconversationsocialexpressioneventtopicconversationroutingdata.go deleted file mode 100644 index 37517f830..000000000 --- a/build/platformclientv2/queueconversationsocialexpressioneventtopicconversationroutingdata.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationsocialexpressioneventtopicconversationroutingdata -type Queueconversationsocialexpressioneventtopicconversationroutingdata struct { - // Queue - Queue *Queueconversationsocialexpressioneventtopicurireference `json:"queue,omitempty"` - - - // Language - Language *Queueconversationsocialexpressioneventtopicurireference `json:"language,omitempty"` - - - // Priority - Priority *int `json:"priority,omitempty"` - - - // Skills - Skills *[]Queueconversationsocialexpressioneventtopicurireference `json:"skills,omitempty"` - - - // ScoredAgents - ScoredAgents *[]Queueconversationsocialexpressioneventtopicscoredagent `json:"scoredAgents,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationsocialexpressioneventtopicconversationroutingdata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationsocialexpressioneventtopicdialerpreview.go b/build/platformclientv2/queueconversationsocialexpressioneventtopicdialerpreview.go deleted file mode 100644 index a55bc5497..000000000 --- a/build/platformclientv2/queueconversationsocialexpressioneventtopicdialerpreview.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationsocialexpressioneventtopicdialerpreview -type Queueconversationsocialexpressioneventtopicdialerpreview struct { - // Id - Id *string `json:"id,omitempty"` - - - // ContactId - ContactId *string `json:"contactId,omitempty"` - - - // ContactListId - ContactListId *string `json:"contactListId,omitempty"` - - - // CampaignId - CampaignId *string `json:"campaignId,omitempty"` - - - // PhoneNumberColumns - PhoneNumberColumns *[]Queueconversationsocialexpressioneventtopicphonenumbercolumn `json:"phoneNumberColumns,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationsocialexpressioneventtopicdialerpreview) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationsocialexpressioneventtopicdisconnectreason.go b/build/platformclientv2/queueconversationsocialexpressioneventtopicdisconnectreason.go deleted file mode 100644 index 74d5a9257..000000000 --- a/build/platformclientv2/queueconversationsocialexpressioneventtopicdisconnectreason.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationsocialexpressioneventtopicdisconnectreason -type Queueconversationsocialexpressioneventtopicdisconnectreason struct { - // VarType - VarType *string `json:"type,omitempty"` - - - // Code - Code *int `json:"code,omitempty"` - - - // Phrase - Phrase *string `json:"phrase,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationsocialexpressioneventtopicdisconnectreason) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationsocialexpressioneventtopicemail.go b/build/platformclientv2/queueconversationsocialexpressioneventtopicemail.go deleted file mode 100644 index 9b4c69f33..000000000 --- a/build/platformclientv2/queueconversationsocialexpressioneventtopicemail.go +++ /dev/null @@ -1,102 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queueconversationsocialexpressioneventtopicemail -type Queueconversationsocialexpressioneventtopicemail struct { - // Id - Id *string `json:"id,omitempty"` - - - // State - State *string `json:"state,omitempty"` - - - // Held - Held *bool `json:"held,omitempty"` - - - // AutoGenerated - AutoGenerated *bool `json:"autoGenerated,omitempty"` - - - // Subject - Subject *string `json:"subject,omitempty"` - - - // Provider - Provider *string `json:"provider,omitempty"` - - - // ScriptId - ScriptId *string `json:"scriptId,omitempty"` - - - // PeerId - PeerId *string `json:"peerId,omitempty"` - - - // MessagesSent - MessagesSent *int `json:"messagesSent,omitempty"` - - - // ErrorInfo - ErrorInfo *Queueconversationsocialexpressioneventtopicerrordetails `json:"errorInfo,omitempty"` - - - // DisconnectType - DisconnectType *string `json:"disconnectType,omitempty"` - - - // StartHoldTime - StartHoldTime *time.Time `json:"startHoldTime,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // DisconnectedTime - DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"` - - - // MessageId - MessageId *string `json:"messageId,omitempty"` - - - // Direction - Direction *string `json:"direction,omitempty"` - - - // DraftAttachments - DraftAttachments *[]Queueconversationsocialexpressioneventtopicattachment `json:"draftAttachments,omitempty"` - - - // Spam - Spam *bool `json:"spam,omitempty"` - - - // Wrapup - Wrapup *Queueconversationsocialexpressioneventtopicwrapup `json:"wrapup,omitempty"` - - - // AfterCallWork - AfterCallWork *Queueconversationsocialexpressioneventtopicaftercallwork `json:"afterCallWork,omitempty"` - - - // AfterCallWorkRequired - AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationsocialexpressioneventtopicemail) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationsocialexpressioneventtopicerrordetails.go b/build/platformclientv2/queueconversationsocialexpressioneventtopicerrordetails.go deleted file mode 100644 index 971e2b754..000000000 --- a/build/platformclientv2/queueconversationsocialexpressioneventtopicerrordetails.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationsocialexpressioneventtopicerrordetails -type Queueconversationsocialexpressioneventtopicerrordetails struct { - // Status - Status *int `json:"status,omitempty"` - - - // Code - Code *string `json:"code,omitempty"` - - - // Message - Message *string `json:"message,omitempty"` - - - // MessageWithParams - MessageWithParams *string `json:"messageWithParams,omitempty"` - - - // MessageParams - MessageParams *map[string]string `json:"messageParams,omitempty"` - - - // ContextId - ContextId *string `json:"contextId,omitempty"` - - - // Uri - Uri *string `json:"uri,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationsocialexpressioneventtopicerrordetails) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationsocialexpressioneventtopicfaxstatus.go b/build/platformclientv2/queueconversationsocialexpressioneventtopicfaxstatus.go deleted file mode 100644 index 58dc8156f..000000000 --- a/build/platformclientv2/queueconversationsocialexpressioneventtopicfaxstatus.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationsocialexpressioneventtopicfaxstatus -type Queueconversationsocialexpressioneventtopicfaxstatus struct { - // Direction - Direction *string `json:"direction,omitempty"` - - - // ExpectedPages - ExpectedPages *int `json:"expectedPages,omitempty"` - - - // ActivePage - ActivePage *int `json:"activePage,omitempty"` - - - // LinesTransmitted - LinesTransmitted *int `json:"linesTransmitted,omitempty"` - - - // BytesTransmitted - BytesTransmitted *int `json:"bytesTransmitted,omitempty"` - - - // BaudRate - BaudRate *int `json:"baudRate,omitempty"` - - - // PageErrors - PageErrors *int `json:"pageErrors,omitempty"` - - - // LineErrors - LineErrors *int `json:"lineErrors,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationsocialexpressioneventtopicfaxstatus) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationsocialexpressioneventtopicjourneyaction.go b/build/platformclientv2/queueconversationsocialexpressioneventtopicjourneyaction.go deleted file mode 100644 index 236165b53..000000000 --- a/build/platformclientv2/queueconversationsocialexpressioneventtopicjourneyaction.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationsocialexpressioneventtopicjourneyaction -type Queueconversationsocialexpressioneventtopicjourneyaction struct { - // Id - Id *string `json:"id,omitempty"` - - - // ActionMap - ActionMap *Queueconversationsocialexpressioneventtopicjourneyactionmap `json:"actionMap,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationsocialexpressioneventtopicjourneyaction) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationsocialexpressioneventtopicjourneyactionmap.go b/build/platformclientv2/queueconversationsocialexpressioneventtopicjourneyactionmap.go deleted file mode 100644 index 1d3d62323..000000000 --- a/build/platformclientv2/queueconversationsocialexpressioneventtopicjourneyactionmap.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationsocialexpressioneventtopicjourneyactionmap -type Queueconversationsocialexpressioneventtopicjourneyactionmap struct { - // Id - Id *string `json:"id,omitempty"` - - - // Version - Version *int `json:"version,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationsocialexpressioneventtopicjourneyactionmap) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationsocialexpressioneventtopicjourneycontext.go b/build/platformclientv2/queueconversationsocialexpressioneventtopicjourneycontext.go deleted file mode 100644 index b57e96d3b..000000000 --- a/build/platformclientv2/queueconversationsocialexpressioneventtopicjourneycontext.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationsocialexpressioneventtopicjourneycontext -type Queueconversationsocialexpressioneventtopicjourneycontext struct { - // Customer - Customer *Queueconversationsocialexpressioneventtopicjourneycustomer `json:"customer,omitempty"` - - - // CustomerSession - CustomerSession *Queueconversationsocialexpressioneventtopicjourneycustomersession `json:"customerSession,omitempty"` - - - // TriggeringAction - TriggeringAction *Queueconversationsocialexpressioneventtopicjourneyaction `json:"triggeringAction,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationsocialexpressioneventtopicjourneycontext) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationsocialexpressioneventtopicjourneycustomer.go b/build/platformclientv2/queueconversationsocialexpressioneventtopicjourneycustomer.go deleted file mode 100644 index 724676815..000000000 --- a/build/platformclientv2/queueconversationsocialexpressioneventtopicjourneycustomer.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationsocialexpressioneventtopicjourneycustomer -type Queueconversationsocialexpressioneventtopicjourneycustomer struct { - // Id - Id *string `json:"id,omitempty"` - - - // IdType - IdType *string `json:"idType,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationsocialexpressioneventtopicjourneycustomer) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationsocialexpressioneventtopicjourneycustomersession.go b/build/platformclientv2/queueconversationsocialexpressioneventtopicjourneycustomersession.go deleted file mode 100644 index b984995d1..000000000 --- a/build/platformclientv2/queueconversationsocialexpressioneventtopicjourneycustomersession.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationsocialexpressioneventtopicjourneycustomersession -type Queueconversationsocialexpressioneventtopicjourneycustomersession struct { - // Id - Id *string `json:"id,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationsocialexpressioneventtopicjourneycustomersession) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationsocialexpressioneventtopicmessage.go b/build/platformclientv2/queueconversationsocialexpressioneventtopicmessage.go deleted file mode 100644 index 01fcf6ac8..000000000 --- a/build/platformclientv2/queueconversationsocialexpressioneventtopicmessage.go +++ /dev/null @@ -1,106 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queueconversationsocialexpressioneventtopicmessage -type Queueconversationsocialexpressioneventtopicmessage struct { - // Id - Id *string `json:"id,omitempty"` - - - // State - State *string `json:"state,omitempty"` - - - // Held - Held *bool `json:"held,omitempty"` - - - // ErrorInfo - ErrorInfo *Queueconversationsocialexpressioneventtopicerrordetails `json:"errorInfo,omitempty"` - - - // Provider - Provider *string `json:"provider,omitempty"` - - - // ScriptId - ScriptId *string `json:"scriptId,omitempty"` - - - // PeerId - PeerId *string `json:"peerId,omitempty"` - - - // DisconnectType - DisconnectType *string `json:"disconnectType,omitempty"` - - - // StartHoldTime - StartHoldTime *time.Time `json:"startHoldTime,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // DisconnectedTime - DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"` - - - // ToAddress - ToAddress *Queueconversationsocialexpressioneventtopicaddress `json:"toAddress,omitempty"` - - - // FromAddress - FromAddress *Queueconversationsocialexpressioneventtopicaddress `json:"fromAddress,omitempty"` - - - // Messages - Messages *[]Queueconversationsocialexpressioneventtopicmessagedetails `json:"messages,omitempty"` - - - // MessagesTranscriptUri - MessagesTranscriptUri *string `json:"messagesTranscriptUri,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - - - // RecipientCountry - RecipientCountry *string `json:"recipientCountry,omitempty"` - - - // RecipientType - RecipientType *string `json:"recipientType,omitempty"` - - - // JourneyContext - JourneyContext *Queueconversationsocialexpressioneventtopicjourneycontext `json:"journeyContext,omitempty"` - - - // Wrapup - Wrapup *Queueconversationsocialexpressioneventtopicwrapup `json:"wrapup,omitempty"` - - - // AfterCallWork - AfterCallWork *Queueconversationsocialexpressioneventtopicaftercallwork `json:"afterCallWork,omitempty"` - - - // AfterCallWorkRequired - AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationsocialexpressioneventtopicmessage) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationsocialexpressioneventtopicmessagedetails.go b/build/platformclientv2/queueconversationsocialexpressioneventtopicmessagedetails.go deleted file mode 100644 index 52f72faea..000000000 --- a/build/platformclientv2/queueconversationsocialexpressioneventtopicmessagedetails.go +++ /dev/null @@ -1,38 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queueconversationsocialexpressioneventtopicmessagedetails -type Queueconversationsocialexpressioneventtopicmessagedetails struct { - // MessageId - MessageId *string `json:"messageId,omitempty"` - - - // MessageTime - MessageTime *time.Time `json:"messageTime,omitempty"` - - - // MessageStatus - MessageStatus *string `json:"messageStatus,omitempty"` - - - // MessageSegmentCount - MessageSegmentCount *int `json:"messageSegmentCount,omitempty"` - - - // Media - Media *[]Queueconversationsocialexpressioneventtopicmessagemedia `json:"media,omitempty"` - - - // Stickers - Stickers *[]Queueconversationsocialexpressioneventtopicmessagesticker `json:"stickers,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationsocialexpressioneventtopicmessagedetails) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationsocialexpressioneventtopicmessagemedia.go b/build/platformclientv2/queueconversationsocialexpressioneventtopicmessagemedia.go deleted file mode 100644 index 0f292a052..000000000 --- a/build/platformclientv2/queueconversationsocialexpressioneventtopicmessagemedia.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationsocialexpressioneventtopicmessagemedia -type Queueconversationsocialexpressioneventtopicmessagemedia struct { - // Url - Url *string `json:"url,omitempty"` - - - // MediaType - MediaType *string `json:"mediaType,omitempty"` - - - // ContentLengthBytes - ContentLengthBytes *int `json:"contentLengthBytes,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Id - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationsocialexpressioneventtopicmessagemedia) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationsocialexpressioneventtopicmessagesticker.go b/build/platformclientv2/queueconversationsocialexpressioneventtopicmessagesticker.go deleted file mode 100644 index f9db00a15..000000000 --- a/build/platformclientv2/queueconversationsocialexpressioneventtopicmessagesticker.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationsocialexpressioneventtopicmessagesticker -type Queueconversationsocialexpressioneventtopicmessagesticker struct { - // Url - Url *string `json:"url,omitempty"` - - - // Id - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationsocialexpressioneventtopicmessagesticker) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationsocialexpressioneventtopicparticipant.go b/build/platformclientv2/queueconversationsocialexpressioneventtopicparticipant.go deleted file mode 100644 index 54d3f673f..000000000 --- a/build/platformclientv2/queueconversationsocialexpressioneventtopicparticipant.go +++ /dev/null @@ -1,162 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queueconversationsocialexpressioneventtopicparticipant -type Queueconversationsocialexpressioneventtopicparticipant struct { - // Id - Id *string `json:"id,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // EndTime - EndTime *time.Time `json:"endTime,omitempty"` - - - // UserId - UserId *string `json:"userId,omitempty"` - - - // ExternalContactId - ExternalContactId *string `json:"externalContactId,omitempty"` - - - // ExternalOrganizationId - ExternalOrganizationId *string `json:"externalOrganizationId,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // QueueId - QueueId *string `json:"queueId,omitempty"` - - - // GroupId - GroupId *string `json:"groupId,omitempty"` - - - // TeamId - TeamId *string `json:"teamId,omitempty"` - - - // Purpose - Purpose *string `json:"purpose,omitempty"` - - - // ConsultParticipantId - ConsultParticipantId *string `json:"consultParticipantId,omitempty"` - - - // Address - Address *string `json:"address,omitempty"` - - - // WrapupRequired - WrapupRequired *bool `json:"wrapupRequired,omitempty"` - - - // WrapupExpected - WrapupExpected *bool `json:"wrapupExpected,omitempty"` - - - // WrapupPrompt - WrapupPrompt *string `json:"wrapupPrompt,omitempty"` - - - // WrapupTimeoutMs - WrapupTimeoutMs *int `json:"wrapupTimeoutMs,omitempty"` - - - // Wrapup - Wrapup *Queueconversationsocialexpressioneventtopicwrapup `json:"wrapup,omitempty"` - - - // StartAcwTime - StartAcwTime *time.Time `json:"startAcwTime,omitempty"` - - - // EndAcwTime - EndAcwTime *time.Time `json:"endAcwTime,omitempty"` - - - // ConversationRoutingData - ConversationRoutingData *Queueconversationsocialexpressioneventtopicconversationroutingdata `json:"conversationRoutingData,omitempty"` - - - // AlertingTimeoutMs - AlertingTimeoutMs *int `json:"alertingTimeoutMs,omitempty"` - - - // MonitoredParticipantId - MonitoredParticipantId *string `json:"monitoredParticipantId,omitempty"` - - - // CoachedParticipantId - CoachedParticipantId *string `json:"coachedParticipantId,omitempty"` - - - // ScreenRecordingState - ScreenRecordingState *string `json:"screenRecordingState,omitempty"` - - - // FlaggedReason - FlaggedReason *string `json:"flaggedReason,omitempty"` - - - // Attributes - Attributes *map[string]string `json:"attributes,omitempty"` - - - // Calls - Calls *[]Queueconversationsocialexpressioneventtopiccall `json:"calls,omitempty"` - - - // Callbacks - Callbacks *[]Queueconversationsocialexpressioneventtopiccallback `json:"callbacks,omitempty"` - - - // Chats - Chats *[]Queueconversationsocialexpressioneventtopicchat `json:"chats,omitempty"` - - - // Cobrowsesessions - Cobrowsesessions *[]Queueconversationsocialexpressioneventtopiccobrowse `json:"cobrowsesessions,omitempty"` - - - // Emails - Emails *[]Queueconversationsocialexpressioneventtopicemail `json:"emails,omitempty"` - - - // Messages - Messages *[]Queueconversationsocialexpressioneventtopicmessage `json:"messages,omitempty"` - - - // Screenshares - Screenshares *[]Queueconversationsocialexpressioneventtopicscreenshare `json:"screenshares,omitempty"` - - - // SocialExpressions - SocialExpressions *[]Queueconversationsocialexpressioneventtopicsocialexpression `json:"socialExpressions,omitempty"` - - - // Videos - Videos *[]Queueconversationsocialexpressioneventtopicvideo `json:"videos,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationsocialexpressioneventtopicparticipant) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationsocialexpressioneventtopicphonenumbercolumn.go b/build/platformclientv2/queueconversationsocialexpressioneventtopicphonenumbercolumn.go deleted file mode 100644 index 4f981153d..000000000 --- a/build/platformclientv2/queueconversationsocialexpressioneventtopicphonenumbercolumn.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationsocialexpressioneventtopicphonenumbercolumn -type Queueconversationsocialexpressioneventtopicphonenumbercolumn struct { - // ColumnName - ColumnName *string `json:"columnName,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationsocialexpressioneventtopicphonenumbercolumn) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationsocialexpressioneventtopicscoredagent.go b/build/platformclientv2/queueconversationsocialexpressioneventtopicscoredagent.go deleted file mode 100644 index 44d7af445..000000000 --- a/build/platformclientv2/queueconversationsocialexpressioneventtopicscoredagent.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationsocialexpressioneventtopicscoredagent -type Queueconversationsocialexpressioneventtopicscoredagent struct { - // Agent - Agent *Queueconversationsocialexpressioneventtopicurireference `json:"agent,omitempty"` - - - // Score - Score *int `json:"score,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationsocialexpressioneventtopicscoredagent) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationsocialexpressioneventtopicscreenshare.go b/build/platformclientv2/queueconversationsocialexpressioneventtopicscreenshare.go deleted file mode 100644 index a3929d7a9..000000000 --- a/build/platformclientv2/queueconversationsocialexpressioneventtopicscreenshare.go +++ /dev/null @@ -1,74 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queueconversationsocialexpressioneventtopicscreenshare -type Queueconversationsocialexpressioneventtopicscreenshare struct { - // State - State *string `json:"state,omitempty"` - - - // Self - Self *Queueconversationsocialexpressioneventtopicaddress `json:"self,omitempty"` - - - // Id - Id *string `json:"id,omitempty"` - - - // Context - Context *string `json:"context,omitempty"` - - - // Sharing - Sharing *bool `json:"sharing,omitempty"` - - - // Provider - Provider *string `json:"provider,omitempty"` - - - // ScriptId - ScriptId *string `json:"scriptId,omitempty"` - - - // PeerId - PeerId *string `json:"peerId,omitempty"` - - - // DisconnectType - DisconnectType *string `json:"disconnectType,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // DisconnectedTime - DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"` - - - // Wrapup - Wrapup *Queueconversationsocialexpressioneventtopicwrapup `json:"wrapup,omitempty"` - - - // AfterCallWork - AfterCallWork *Queueconversationsocialexpressioneventtopicaftercallwork `json:"afterCallWork,omitempty"` - - - // AfterCallWorkRequired - AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationsocialexpressioneventtopicscreenshare) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationsocialexpressioneventtopicsocialexpression.go b/build/platformclientv2/queueconversationsocialexpressioneventtopicsocialexpression.go deleted file mode 100644 index fbf38d766..000000000 --- a/build/platformclientv2/queueconversationsocialexpressioneventtopicsocialexpression.go +++ /dev/null @@ -1,90 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queueconversationsocialexpressioneventtopicsocialexpression -type Queueconversationsocialexpressioneventtopicsocialexpression struct { - // State - State *string `json:"state,omitempty"` - - - // Id - Id *string `json:"id,omitempty"` - - - // SocialMediaId - SocialMediaId *string `json:"socialMediaId,omitempty"` - - - // SocialMediaHub - SocialMediaHub *string `json:"socialMediaHub,omitempty"` - - - // SocialUserName - SocialUserName *string `json:"socialUserName,omitempty"` - - - // PreviewText - PreviewText *string `json:"previewText,omitempty"` - - - // RecordingId - RecordingId *string `json:"recordingId,omitempty"` - - - // Held - Held *bool `json:"held,omitempty"` - - - // Provider - Provider *string `json:"provider,omitempty"` - - - // ScriptId - ScriptId *string `json:"scriptId,omitempty"` - - - // PeerId - PeerId *string `json:"peerId,omitempty"` - - - // DisconnectType - DisconnectType *string `json:"disconnectType,omitempty"` - - - // StartHoldTime - StartHoldTime *time.Time `json:"startHoldTime,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // DisconnectedTime - DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"` - - - // Wrapup - Wrapup *Queueconversationsocialexpressioneventtopicwrapup `json:"wrapup,omitempty"` - - - // AfterCallWork - AfterCallWork *Queueconversationsocialexpressioneventtopicaftercallwork `json:"afterCallWork,omitempty"` - - - // AfterCallWorkRequired - AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationsocialexpressioneventtopicsocialexpression) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationsocialexpressioneventtopicurireference.go b/build/platformclientv2/queueconversationsocialexpressioneventtopicurireference.go deleted file mode 100644 index 089607d2b..000000000 --- a/build/platformclientv2/queueconversationsocialexpressioneventtopicurireference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationsocialexpressioneventtopicurireference -type Queueconversationsocialexpressioneventtopicurireference struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationsocialexpressioneventtopicurireference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationsocialexpressioneventtopicvideo.go b/build/platformclientv2/queueconversationsocialexpressioneventtopicvideo.go deleted file mode 100644 index e38b15c89..000000000 --- a/build/platformclientv2/queueconversationsocialexpressioneventtopicvideo.go +++ /dev/null @@ -1,86 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queueconversationsocialexpressioneventtopicvideo -type Queueconversationsocialexpressioneventtopicvideo struct { - // State - State *string `json:"state,omitempty"` - - - // Self - Self *Queueconversationsocialexpressioneventtopicaddress `json:"self,omitempty"` - - - // Id - Id *string `json:"id,omitempty"` - - - // Context - Context *string `json:"context,omitempty"` - - - // AudioMuted - AudioMuted *bool `json:"audioMuted,omitempty"` - - - // VideoMuted - VideoMuted *bool `json:"videoMuted,omitempty"` - - - // SharingScreen - SharingScreen *bool `json:"sharingScreen,omitempty"` - - - // Provider - Provider *string `json:"provider,omitempty"` - - - // ScriptId - ScriptId *string `json:"scriptId,omitempty"` - - - // PeerId - PeerId *string `json:"peerId,omitempty"` - - - // DisconnectType - DisconnectType *string `json:"disconnectType,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // DisconnectedTime - DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"` - - - // Msids - Msids *[]string `json:"msids,omitempty"` - - - // Wrapup - Wrapup *Queueconversationsocialexpressioneventtopicwrapup `json:"wrapup,omitempty"` - - - // AfterCallWork - AfterCallWork *Queueconversationsocialexpressioneventtopicaftercallwork `json:"afterCallWork,omitempty"` - - - // AfterCallWorkRequired - AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationsocialexpressioneventtopicvideo) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationsocialexpressioneventtopicvoicemail.go b/build/platformclientv2/queueconversationsocialexpressioneventtopicvoicemail.go deleted file mode 100644 index 21de8b8e6..000000000 --- a/build/platformclientv2/queueconversationsocialexpressioneventtopicvoicemail.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationsocialexpressioneventtopicvoicemail -type Queueconversationsocialexpressioneventtopicvoicemail struct { - // Id - Id *string `json:"id,omitempty"` - - - // UploadStatus - UploadStatus *string `json:"uploadStatus,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationsocialexpressioneventtopicvoicemail) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationsocialexpressioneventtopicwrapup.go b/build/platformclientv2/queueconversationsocialexpressioneventtopicwrapup.go deleted file mode 100644 index b2174e5c0..000000000 --- a/build/platformclientv2/queueconversationsocialexpressioneventtopicwrapup.go +++ /dev/null @@ -1,38 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queueconversationsocialexpressioneventtopicwrapup -type Queueconversationsocialexpressioneventtopicwrapup struct { - // Code - Code *string `json:"code,omitempty"` - - - // Notes - Notes *string `json:"notes,omitempty"` - - - // Tags - Tags *[]string `json:"tags,omitempty"` - - - // DurationSeconds - DurationSeconds *int `json:"durationSeconds,omitempty"` - - - // EndTime - EndTime *time.Time `json:"endTime,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationsocialexpressioneventtopicwrapup) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationvideoeventtopicaddress.go b/build/platformclientv2/queueconversationvideoeventtopicaddress.go deleted file mode 100644 index 8b8d1dd59..000000000 --- a/build/platformclientv2/queueconversationvideoeventtopicaddress.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationvideoeventtopicaddress -type Queueconversationvideoeventtopicaddress struct { - // Name - Name *string `json:"name,omitempty"` - - - // NameRaw - NameRaw *string `json:"nameRaw,omitempty"` - - - // AddressNormalized - AddressNormalized *string `json:"addressNormalized,omitempty"` - - - // AddressRaw - AddressRaw *string `json:"addressRaw,omitempty"` - - - // AddressDisplayable - AddressDisplayable *string `json:"addressDisplayable,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationvideoeventtopicaddress) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationvideoeventtopicaftercallwork.go b/build/platformclientv2/queueconversationvideoeventtopicaftercallwork.go deleted file mode 100644 index fd26ac8c0..000000000 --- a/build/platformclientv2/queueconversationvideoeventtopicaftercallwork.go +++ /dev/null @@ -1,26 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queueconversationvideoeventtopicaftercallwork -type Queueconversationvideoeventtopicaftercallwork struct { - // State - State *string `json:"state,omitempty"` - - - // StartTime - StartTime *time.Time `json:"startTime,omitempty"` - - - // EndTime - EndTime *time.Time `json:"endTime,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationvideoeventtopicaftercallwork) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationvideoeventtopicattachment.go b/build/platformclientv2/queueconversationvideoeventtopicattachment.go deleted file mode 100644 index 1b18bec25..000000000 --- a/build/platformclientv2/queueconversationvideoeventtopicattachment.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationvideoeventtopicattachment -type Queueconversationvideoeventtopicattachment struct { - // AttachmentId - AttachmentId *string `json:"attachmentId,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // ContentUri - ContentUri *string `json:"contentUri,omitempty"` - - - // ContentType - ContentType *string `json:"contentType,omitempty"` - - - // ContentLength - ContentLength *int `json:"contentLength,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationvideoeventtopicattachment) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationvideoeventtopiccall.go b/build/platformclientv2/queueconversationvideoeventtopiccall.go deleted file mode 100644 index 3cf8fae96..000000000 --- a/build/platformclientv2/queueconversationvideoeventtopiccall.go +++ /dev/null @@ -1,122 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queueconversationvideoeventtopiccall -type Queueconversationvideoeventtopiccall struct { - // Id - Id *string `json:"id,omitempty"` - - - // State - State *string `json:"state,omitempty"` - - - // Recording - Recording *bool `json:"recording,omitempty"` - - - // RecordingState - RecordingState *string `json:"recordingState,omitempty"` - - - // Muted - Muted *bool `json:"muted,omitempty"` - - - // Confined - Confined *bool `json:"confined,omitempty"` - - - // Held - Held *bool `json:"held,omitempty"` - - - // ErrorInfo - ErrorInfo *Queueconversationvideoeventtopicerrordetails `json:"errorInfo,omitempty"` - - - // DisconnectType - DisconnectType *string `json:"disconnectType,omitempty"` - - - // StartHoldTime - StartHoldTime *time.Time `json:"startHoldTime,omitempty"` - - - // Direction - Direction *string `json:"direction,omitempty"` - - - // DocumentId - DocumentId *string `json:"documentId,omitempty"` - - - // Self - Self *Queueconversationvideoeventtopicaddress `json:"self,omitempty"` - - - // Other - Other *Queueconversationvideoeventtopicaddress `json:"other,omitempty"` - - - // Provider - Provider *string `json:"provider,omitempty"` - - - // ScriptId - ScriptId *string `json:"scriptId,omitempty"` - - - // PeerId - PeerId *string `json:"peerId,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // DisconnectedTime - DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"` - - - // DisconnectReasons - DisconnectReasons *[]Queueconversationvideoeventtopicdisconnectreason `json:"disconnectReasons,omitempty"` - - - // FaxStatus - FaxStatus *Queueconversationvideoeventtopicfaxstatus `json:"faxStatus,omitempty"` - - - // UuiData - UuiData *string `json:"uuiData,omitempty"` - - - // Wrapup - Wrapup *Queueconversationvideoeventtopicwrapup `json:"wrapup,omitempty"` - - - // AfterCallWork - AfterCallWork *Queueconversationvideoeventtopicaftercallwork `json:"afterCallWork,omitempty"` - - - // AfterCallWorkRequired - AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"` - - - // AgentAssistantId - AgentAssistantId *string `json:"agentAssistantId,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationvideoeventtopiccall) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationvideoeventtopiccallback.go b/build/platformclientv2/queueconversationvideoeventtopiccallback.go deleted file mode 100644 index 11aacfd34..000000000 --- a/build/platformclientv2/queueconversationvideoeventtopiccallback.go +++ /dev/null @@ -1,110 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queueconversationvideoeventtopiccallback -type Queueconversationvideoeventtopiccallback struct { - // State - State *string `json:"state,omitempty"` - - - // Id - Id *string `json:"id,omitempty"` - - - // Direction - Direction *string `json:"direction,omitempty"` - - - // Held - Held *bool `json:"held,omitempty"` - - - // DisconnectType - DisconnectType *string `json:"disconnectType,omitempty"` - - - // StartHoldTime - StartHoldTime *time.Time `json:"startHoldTime,omitempty"` - - - // DialerPreview - DialerPreview *Queueconversationvideoeventtopicdialerpreview `json:"dialerPreview,omitempty"` - - - // Voicemail - Voicemail *Queueconversationvideoeventtopicvoicemail `json:"voicemail,omitempty"` - - - // CallbackNumbers - CallbackNumbers *[]string `json:"callbackNumbers,omitempty"` - - - // CallbackUserName - CallbackUserName *string `json:"callbackUserName,omitempty"` - - - // ScriptId - ScriptId *string `json:"scriptId,omitempty"` - - - // PeerId - PeerId *string `json:"peerId,omitempty"` - - - // ExternalCampaign - ExternalCampaign *bool `json:"externalCampaign,omitempty"` - - - // SkipEnabled - SkipEnabled *bool `json:"skipEnabled,omitempty"` - - - // Provider - Provider *string `json:"provider,omitempty"` - - - // TimeoutSeconds - TimeoutSeconds *int `json:"timeoutSeconds,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // DisconnectedTime - DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"` - - - // CallbackScheduledTime - CallbackScheduledTime *time.Time `json:"callbackScheduledTime,omitempty"` - - - // AutomatedCallbackConfigId - AutomatedCallbackConfigId *string `json:"automatedCallbackConfigId,omitempty"` - - - // Wrapup - Wrapup *Queueconversationvideoeventtopicwrapup `json:"wrapup,omitempty"` - - - // AfterCallWork - AfterCallWork *Queueconversationvideoeventtopicaftercallwork `json:"afterCallWork,omitempty"` - - - // AfterCallWorkRequired - AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationvideoeventtopiccallback) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationvideoeventtopicchat.go b/build/platformclientv2/queueconversationvideoeventtopicchat.go deleted file mode 100644 index 54a274187..000000000 --- a/build/platformclientv2/queueconversationvideoeventtopicchat.go +++ /dev/null @@ -1,82 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queueconversationvideoeventtopicchat -type Queueconversationvideoeventtopicchat struct { - // State - State *string `json:"state,omitempty"` - - - // Id - Id *string `json:"id,omitempty"` - - - // Provider - Provider *string `json:"provider,omitempty"` - - - // ScriptId - ScriptId *string `json:"scriptId,omitempty"` - - - // PeerId - PeerId *string `json:"peerId,omitempty"` - - - // RoomId - RoomId *string `json:"roomId,omitempty"` - - - // AvatarImageUrl - AvatarImageUrl *string `json:"avatarImageUrl,omitempty"` - - - // Held - Held *bool `json:"held,omitempty"` - - - // DisconnectType - DisconnectType *string `json:"disconnectType,omitempty"` - - - // StartHoldTime - StartHoldTime *time.Time `json:"startHoldTime,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // DisconnectedTime - DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"` - - - // JourneyContext - JourneyContext *Queueconversationvideoeventtopicjourneycontext `json:"journeyContext,omitempty"` - - - // Wrapup - Wrapup *Queueconversationvideoeventtopicwrapup `json:"wrapup,omitempty"` - - - // AfterCallWork - AfterCallWork *Queueconversationvideoeventtopicaftercallwork `json:"afterCallWork,omitempty"` - - - // AfterCallWorkRequired - AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationvideoeventtopicchat) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationvideoeventtopiccobrowse.go b/build/platformclientv2/queueconversationvideoeventtopiccobrowse.go deleted file mode 100644 index f853bc3f1..000000000 --- a/build/platformclientv2/queueconversationvideoeventtopiccobrowse.go +++ /dev/null @@ -1,90 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queueconversationvideoeventtopiccobrowse -type Queueconversationvideoeventtopiccobrowse struct { - // State - State *string `json:"state,omitempty"` - - - // DisconnectType - DisconnectType *string `json:"disconnectType,omitempty"` - - - // Id - Id *string `json:"id,omitempty"` - - - // Self - Self *Queueconversationvideoeventtopicaddress `json:"self,omitempty"` - - - // RoomId - RoomId *string `json:"roomId,omitempty"` - - - // CobrowseSessionId - CobrowseSessionId *string `json:"cobrowseSessionId,omitempty"` - - - // CobrowseRole - CobrowseRole *string `json:"cobrowseRole,omitempty"` - - - // Controlling - Controlling *[]string `json:"controlling,omitempty"` - - - // ViewerUrl - ViewerUrl *string `json:"viewerUrl,omitempty"` - - - // Provider - Provider *string `json:"provider,omitempty"` - - - // ScriptId - ScriptId *string `json:"scriptId,omitempty"` - - - // PeerId - PeerId *string `json:"peerId,omitempty"` - - - // ProviderEventTime - ProviderEventTime *time.Time `json:"providerEventTime,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // DisconnectedTime - DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"` - - - // Wrapup - Wrapup *Queueconversationvideoeventtopicwrapup `json:"wrapup,omitempty"` - - - // AfterCallWork - AfterCallWork *Queueconversationvideoeventtopicaftercallwork `json:"afterCallWork,omitempty"` - - - // AfterCallWorkRequired - AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationvideoeventtopiccobrowse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationvideoeventtopicconversation.go b/build/platformclientv2/queueconversationvideoeventtopicconversation.go deleted file mode 100644 index a30dd0a65..000000000 --- a/build/platformclientv2/queueconversationvideoeventtopicconversation.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationvideoeventtopicconversation -type Queueconversationvideoeventtopicconversation struct { - // Id - Id *string `json:"id,omitempty"` - - - // MaxParticipants - MaxParticipants *int `json:"maxParticipants,omitempty"` - - - // Participants - Participants *[]Queueconversationvideoeventtopicparticipant `json:"participants,omitempty"` - - - // RecordingState - RecordingState *string `json:"recordingState,omitempty"` - - - // Address - Address *string `json:"address,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationvideoeventtopicconversation) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationvideoeventtopicconversationroutingdata.go b/build/platformclientv2/queueconversationvideoeventtopicconversationroutingdata.go deleted file mode 100644 index 00e330d16..000000000 --- a/build/platformclientv2/queueconversationvideoeventtopicconversationroutingdata.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationvideoeventtopicconversationroutingdata -type Queueconversationvideoeventtopicconversationroutingdata struct { - // Queue - Queue *Queueconversationvideoeventtopicurireference `json:"queue,omitempty"` - - - // Language - Language *Queueconversationvideoeventtopicurireference `json:"language,omitempty"` - - - // Priority - Priority *int `json:"priority,omitempty"` - - - // Skills - Skills *[]Queueconversationvideoeventtopicurireference `json:"skills,omitempty"` - - - // ScoredAgents - ScoredAgents *[]Queueconversationvideoeventtopicscoredagent `json:"scoredAgents,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationvideoeventtopicconversationroutingdata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationvideoeventtopicdialerpreview.go b/build/platformclientv2/queueconversationvideoeventtopicdialerpreview.go deleted file mode 100644 index 374047fc7..000000000 --- a/build/platformclientv2/queueconversationvideoeventtopicdialerpreview.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationvideoeventtopicdialerpreview -type Queueconversationvideoeventtopicdialerpreview struct { - // Id - Id *string `json:"id,omitempty"` - - - // ContactId - ContactId *string `json:"contactId,omitempty"` - - - // ContactListId - ContactListId *string `json:"contactListId,omitempty"` - - - // CampaignId - CampaignId *string `json:"campaignId,omitempty"` - - - // PhoneNumberColumns - PhoneNumberColumns *[]Queueconversationvideoeventtopicphonenumbercolumn `json:"phoneNumberColumns,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationvideoeventtopicdialerpreview) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationvideoeventtopicdisconnectreason.go b/build/platformclientv2/queueconversationvideoeventtopicdisconnectreason.go deleted file mode 100644 index 8c2c10a3e..000000000 --- a/build/platformclientv2/queueconversationvideoeventtopicdisconnectreason.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationvideoeventtopicdisconnectreason -type Queueconversationvideoeventtopicdisconnectreason struct { - // VarType - VarType *string `json:"type,omitempty"` - - - // Code - Code *int `json:"code,omitempty"` - - - // Phrase - Phrase *string `json:"phrase,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationvideoeventtopicdisconnectreason) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationvideoeventtopicemail.go b/build/platformclientv2/queueconversationvideoeventtopicemail.go deleted file mode 100644 index b42e5db83..000000000 --- a/build/platformclientv2/queueconversationvideoeventtopicemail.go +++ /dev/null @@ -1,102 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queueconversationvideoeventtopicemail -type Queueconversationvideoeventtopicemail struct { - // Id - Id *string `json:"id,omitempty"` - - - // State - State *string `json:"state,omitempty"` - - - // Held - Held *bool `json:"held,omitempty"` - - - // AutoGenerated - AutoGenerated *bool `json:"autoGenerated,omitempty"` - - - // Subject - Subject *string `json:"subject,omitempty"` - - - // Provider - Provider *string `json:"provider,omitempty"` - - - // ScriptId - ScriptId *string `json:"scriptId,omitempty"` - - - // PeerId - PeerId *string `json:"peerId,omitempty"` - - - // MessagesSent - MessagesSent *int `json:"messagesSent,omitempty"` - - - // ErrorInfo - ErrorInfo *Queueconversationvideoeventtopicerrordetails `json:"errorInfo,omitempty"` - - - // DisconnectType - DisconnectType *string `json:"disconnectType,omitempty"` - - - // StartHoldTime - StartHoldTime *time.Time `json:"startHoldTime,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // DisconnectedTime - DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"` - - - // MessageId - MessageId *string `json:"messageId,omitempty"` - - - // Direction - Direction *string `json:"direction,omitempty"` - - - // DraftAttachments - DraftAttachments *[]Queueconversationvideoeventtopicattachment `json:"draftAttachments,omitempty"` - - - // Spam - Spam *bool `json:"spam,omitempty"` - - - // Wrapup - Wrapup *Queueconversationvideoeventtopicwrapup `json:"wrapup,omitempty"` - - - // AfterCallWork - AfterCallWork *Queueconversationvideoeventtopicaftercallwork `json:"afterCallWork,omitempty"` - - - // AfterCallWorkRequired - AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationvideoeventtopicemail) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationvideoeventtopicerrordetails.go b/build/platformclientv2/queueconversationvideoeventtopicerrordetails.go deleted file mode 100644 index 2d8cf4876..000000000 --- a/build/platformclientv2/queueconversationvideoeventtopicerrordetails.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationvideoeventtopicerrordetails -type Queueconversationvideoeventtopicerrordetails struct { - // Status - Status *int `json:"status,omitempty"` - - - // Code - Code *string `json:"code,omitempty"` - - - // Message - Message *string `json:"message,omitempty"` - - - // MessageWithParams - MessageWithParams *string `json:"messageWithParams,omitempty"` - - - // MessageParams - MessageParams *map[string]string `json:"messageParams,omitempty"` - - - // ContextId - ContextId *string `json:"contextId,omitempty"` - - - // Uri - Uri *string `json:"uri,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationvideoeventtopicerrordetails) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationvideoeventtopicfaxstatus.go b/build/platformclientv2/queueconversationvideoeventtopicfaxstatus.go deleted file mode 100644 index 49655e7e9..000000000 --- a/build/platformclientv2/queueconversationvideoeventtopicfaxstatus.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationvideoeventtopicfaxstatus -type Queueconversationvideoeventtopicfaxstatus struct { - // Direction - Direction *string `json:"direction,omitempty"` - - - // ExpectedPages - ExpectedPages *int `json:"expectedPages,omitempty"` - - - // ActivePage - ActivePage *int `json:"activePage,omitempty"` - - - // LinesTransmitted - LinesTransmitted *int `json:"linesTransmitted,omitempty"` - - - // BytesTransmitted - BytesTransmitted *int `json:"bytesTransmitted,omitempty"` - - - // BaudRate - BaudRate *int `json:"baudRate,omitempty"` - - - // PageErrors - PageErrors *int `json:"pageErrors,omitempty"` - - - // LineErrors - LineErrors *int `json:"lineErrors,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationvideoeventtopicfaxstatus) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationvideoeventtopicjourneyaction.go b/build/platformclientv2/queueconversationvideoeventtopicjourneyaction.go deleted file mode 100644 index fab41a3a0..000000000 --- a/build/platformclientv2/queueconversationvideoeventtopicjourneyaction.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationvideoeventtopicjourneyaction -type Queueconversationvideoeventtopicjourneyaction struct { - // Id - Id *string `json:"id,omitempty"` - - - // ActionMap - ActionMap *Queueconversationvideoeventtopicjourneyactionmap `json:"actionMap,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationvideoeventtopicjourneyaction) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationvideoeventtopicjourneyactionmap.go b/build/platformclientv2/queueconversationvideoeventtopicjourneyactionmap.go deleted file mode 100644 index 6f6a60d96..000000000 --- a/build/platformclientv2/queueconversationvideoeventtopicjourneyactionmap.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationvideoeventtopicjourneyactionmap -type Queueconversationvideoeventtopicjourneyactionmap struct { - // Id - Id *string `json:"id,omitempty"` - - - // Version - Version *int `json:"version,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationvideoeventtopicjourneyactionmap) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationvideoeventtopicjourneycontext.go b/build/platformclientv2/queueconversationvideoeventtopicjourneycontext.go deleted file mode 100644 index 5dd111675..000000000 --- a/build/platformclientv2/queueconversationvideoeventtopicjourneycontext.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationvideoeventtopicjourneycontext -type Queueconversationvideoeventtopicjourneycontext struct { - // Customer - Customer *Queueconversationvideoeventtopicjourneycustomer `json:"customer,omitempty"` - - - // CustomerSession - CustomerSession *Queueconversationvideoeventtopicjourneycustomersession `json:"customerSession,omitempty"` - - - // TriggeringAction - TriggeringAction *Queueconversationvideoeventtopicjourneyaction `json:"triggeringAction,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationvideoeventtopicjourneycontext) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationvideoeventtopicjourneycustomer.go b/build/platformclientv2/queueconversationvideoeventtopicjourneycustomer.go deleted file mode 100644 index 9460cc1a1..000000000 --- a/build/platformclientv2/queueconversationvideoeventtopicjourneycustomer.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationvideoeventtopicjourneycustomer -type Queueconversationvideoeventtopicjourneycustomer struct { - // Id - Id *string `json:"id,omitempty"` - - - // IdType - IdType *string `json:"idType,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationvideoeventtopicjourneycustomer) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationvideoeventtopicjourneycustomersession.go b/build/platformclientv2/queueconversationvideoeventtopicjourneycustomersession.go deleted file mode 100644 index 004e8eb58..000000000 --- a/build/platformclientv2/queueconversationvideoeventtopicjourneycustomersession.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationvideoeventtopicjourneycustomersession -type Queueconversationvideoeventtopicjourneycustomersession struct { - // Id - Id *string `json:"id,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationvideoeventtopicjourneycustomersession) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationvideoeventtopicmessage.go b/build/platformclientv2/queueconversationvideoeventtopicmessage.go deleted file mode 100644 index 4a0693099..000000000 --- a/build/platformclientv2/queueconversationvideoeventtopicmessage.go +++ /dev/null @@ -1,106 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queueconversationvideoeventtopicmessage -type Queueconversationvideoeventtopicmessage struct { - // Id - Id *string `json:"id,omitempty"` - - - // State - State *string `json:"state,omitempty"` - - - // Held - Held *bool `json:"held,omitempty"` - - - // ErrorInfo - ErrorInfo *Queueconversationvideoeventtopicerrordetails `json:"errorInfo,omitempty"` - - - // Provider - Provider *string `json:"provider,omitempty"` - - - // ScriptId - ScriptId *string `json:"scriptId,omitempty"` - - - // PeerId - PeerId *string `json:"peerId,omitempty"` - - - // DisconnectType - DisconnectType *string `json:"disconnectType,omitempty"` - - - // StartHoldTime - StartHoldTime *time.Time `json:"startHoldTime,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // DisconnectedTime - DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"` - - - // ToAddress - ToAddress *Queueconversationvideoeventtopicaddress `json:"toAddress,omitempty"` - - - // FromAddress - FromAddress *Queueconversationvideoeventtopicaddress `json:"fromAddress,omitempty"` - - - // Messages - Messages *[]Queueconversationvideoeventtopicmessagedetails `json:"messages,omitempty"` - - - // MessagesTranscriptUri - MessagesTranscriptUri *string `json:"messagesTranscriptUri,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - - - // RecipientCountry - RecipientCountry *string `json:"recipientCountry,omitempty"` - - - // RecipientType - RecipientType *string `json:"recipientType,omitempty"` - - - // JourneyContext - JourneyContext *Queueconversationvideoeventtopicjourneycontext `json:"journeyContext,omitempty"` - - - // Wrapup - Wrapup *Queueconversationvideoeventtopicwrapup `json:"wrapup,omitempty"` - - - // AfterCallWork - AfterCallWork *Queueconversationvideoeventtopicaftercallwork `json:"afterCallWork,omitempty"` - - - // AfterCallWorkRequired - AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationvideoeventtopicmessage) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationvideoeventtopicmessagedetails.go b/build/platformclientv2/queueconversationvideoeventtopicmessagedetails.go deleted file mode 100644 index 31bf5c1e1..000000000 --- a/build/platformclientv2/queueconversationvideoeventtopicmessagedetails.go +++ /dev/null @@ -1,38 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queueconversationvideoeventtopicmessagedetails -type Queueconversationvideoeventtopicmessagedetails struct { - // MessageId - MessageId *string `json:"messageId,omitempty"` - - - // MessageTime - MessageTime *time.Time `json:"messageTime,omitempty"` - - - // MessageStatus - MessageStatus *string `json:"messageStatus,omitempty"` - - - // MessageSegmentCount - MessageSegmentCount *int `json:"messageSegmentCount,omitempty"` - - - // Media - Media *[]Queueconversationvideoeventtopicmessagemedia `json:"media,omitempty"` - - - // Stickers - Stickers *[]Queueconversationvideoeventtopicmessagesticker `json:"stickers,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationvideoeventtopicmessagedetails) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationvideoeventtopicmessagemedia.go b/build/platformclientv2/queueconversationvideoeventtopicmessagemedia.go deleted file mode 100644 index eb43c4572..000000000 --- a/build/platformclientv2/queueconversationvideoeventtopicmessagemedia.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationvideoeventtopicmessagemedia -type Queueconversationvideoeventtopicmessagemedia struct { - // Url - Url *string `json:"url,omitempty"` - - - // MediaType - MediaType *string `json:"mediaType,omitempty"` - - - // ContentLengthBytes - ContentLengthBytes *int `json:"contentLengthBytes,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Id - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationvideoeventtopicmessagemedia) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationvideoeventtopicmessagesticker.go b/build/platformclientv2/queueconversationvideoeventtopicmessagesticker.go deleted file mode 100644 index e9fba7f58..000000000 --- a/build/platformclientv2/queueconversationvideoeventtopicmessagesticker.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationvideoeventtopicmessagesticker -type Queueconversationvideoeventtopicmessagesticker struct { - // Url - Url *string `json:"url,omitempty"` - - - // Id - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationvideoeventtopicmessagesticker) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationvideoeventtopicparticipant.go b/build/platformclientv2/queueconversationvideoeventtopicparticipant.go deleted file mode 100644 index c10244d4f..000000000 --- a/build/platformclientv2/queueconversationvideoeventtopicparticipant.go +++ /dev/null @@ -1,162 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queueconversationvideoeventtopicparticipant -type Queueconversationvideoeventtopicparticipant struct { - // Id - Id *string `json:"id,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // EndTime - EndTime *time.Time `json:"endTime,omitempty"` - - - // UserId - UserId *string `json:"userId,omitempty"` - - - // ExternalContactId - ExternalContactId *string `json:"externalContactId,omitempty"` - - - // ExternalOrganizationId - ExternalOrganizationId *string `json:"externalOrganizationId,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // QueueId - QueueId *string `json:"queueId,omitempty"` - - - // GroupId - GroupId *string `json:"groupId,omitempty"` - - - // TeamId - TeamId *string `json:"teamId,omitempty"` - - - // Purpose - Purpose *string `json:"purpose,omitempty"` - - - // ConsultParticipantId - ConsultParticipantId *string `json:"consultParticipantId,omitempty"` - - - // Address - Address *string `json:"address,omitempty"` - - - // WrapupRequired - WrapupRequired *bool `json:"wrapupRequired,omitempty"` - - - // WrapupExpected - WrapupExpected *bool `json:"wrapupExpected,omitempty"` - - - // WrapupPrompt - WrapupPrompt *string `json:"wrapupPrompt,omitempty"` - - - // WrapupTimeoutMs - WrapupTimeoutMs *int `json:"wrapupTimeoutMs,omitempty"` - - - // Wrapup - Wrapup *Queueconversationvideoeventtopicwrapup `json:"wrapup,omitempty"` - - - // StartAcwTime - StartAcwTime *time.Time `json:"startAcwTime,omitempty"` - - - // EndAcwTime - EndAcwTime *time.Time `json:"endAcwTime,omitempty"` - - - // ConversationRoutingData - ConversationRoutingData *Queueconversationvideoeventtopicconversationroutingdata `json:"conversationRoutingData,omitempty"` - - - // AlertingTimeoutMs - AlertingTimeoutMs *int `json:"alertingTimeoutMs,omitempty"` - - - // MonitoredParticipantId - MonitoredParticipantId *string `json:"monitoredParticipantId,omitempty"` - - - // CoachedParticipantId - CoachedParticipantId *string `json:"coachedParticipantId,omitempty"` - - - // ScreenRecordingState - ScreenRecordingState *string `json:"screenRecordingState,omitempty"` - - - // FlaggedReason - FlaggedReason *string `json:"flaggedReason,omitempty"` - - - // Attributes - Attributes *map[string]string `json:"attributes,omitempty"` - - - // Calls - Calls *[]Queueconversationvideoeventtopiccall `json:"calls,omitempty"` - - - // Callbacks - Callbacks *[]Queueconversationvideoeventtopiccallback `json:"callbacks,omitempty"` - - - // Chats - Chats *[]Queueconversationvideoeventtopicchat `json:"chats,omitempty"` - - - // Cobrowsesessions - Cobrowsesessions *[]Queueconversationvideoeventtopiccobrowse `json:"cobrowsesessions,omitempty"` - - - // Emails - Emails *[]Queueconversationvideoeventtopicemail `json:"emails,omitempty"` - - - // Messages - Messages *[]Queueconversationvideoeventtopicmessage `json:"messages,omitempty"` - - - // Screenshares - Screenshares *[]Queueconversationvideoeventtopicscreenshare `json:"screenshares,omitempty"` - - - // SocialExpressions - SocialExpressions *[]Queueconversationvideoeventtopicsocialexpression `json:"socialExpressions,omitempty"` - - - // Videos - Videos *[]Queueconversationvideoeventtopicvideo `json:"videos,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationvideoeventtopicparticipant) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationvideoeventtopicphonenumbercolumn.go b/build/platformclientv2/queueconversationvideoeventtopicphonenumbercolumn.go deleted file mode 100644 index c3749e92c..000000000 --- a/build/platformclientv2/queueconversationvideoeventtopicphonenumbercolumn.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationvideoeventtopicphonenumbercolumn -type Queueconversationvideoeventtopicphonenumbercolumn struct { - // ColumnName - ColumnName *string `json:"columnName,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationvideoeventtopicphonenumbercolumn) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationvideoeventtopicscoredagent.go b/build/platformclientv2/queueconversationvideoeventtopicscoredagent.go deleted file mode 100644 index ee90fb1e1..000000000 --- a/build/platformclientv2/queueconversationvideoeventtopicscoredagent.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationvideoeventtopicscoredagent -type Queueconversationvideoeventtopicscoredagent struct { - // Agent - Agent *Queueconversationvideoeventtopicurireference `json:"agent,omitempty"` - - - // Score - Score *int `json:"score,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationvideoeventtopicscoredagent) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationvideoeventtopicscreenshare.go b/build/platformclientv2/queueconversationvideoeventtopicscreenshare.go deleted file mode 100644 index 73e4f3132..000000000 --- a/build/platformclientv2/queueconversationvideoeventtopicscreenshare.go +++ /dev/null @@ -1,74 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queueconversationvideoeventtopicscreenshare -type Queueconversationvideoeventtopicscreenshare struct { - // State - State *string `json:"state,omitempty"` - - - // Self - Self *Queueconversationvideoeventtopicaddress `json:"self,omitempty"` - - - // Id - Id *string `json:"id,omitempty"` - - - // Context - Context *string `json:"context,omitempty"` - - - // Sharing - Sharing *bool `json:"sharing,omitempty"` - - - // Provider - Provider *string `json:"provider,omitempty"` - - - // ScriptId - ScriptId *string `json:"scriptId,omitempty"` - - - // PeerId - PeerId *string `json:"peerId,omitempty"` - - - // DisconnectType - DisconnectType *string `json:"disconnectType,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // DisconnectedTime - DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"` - - - // Wrapup - Wrapup *Queueconversationvideoeventtopicwrapup `json:"wrapup,omitempty"` - - - // AfterCallWork - AfterCallWork *Queueconversationvideoeventtopicaftercallwork `json:"afterCallWork,omitempty"` - - - // AfterCallWorkRequired - AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationvideoeventtopicscreenshare) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationvideoeventtopicsocialexpression.go b/build/platformclientv2/queueconversationvideoeventtopicsocialexpression.go deleted file mode 100644 index 4a7c2d728..000000000 --- a/build/platformclientv2/queueconversationvideoeventtopicsocialexpression.go +++ /dev/null @@ -1,90 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queueconversationvideoeventtopicsocialexpression -type Queueconversationvideoeventtopicsocialexpression struct { - // State - State *string `json:"state,omitempty"` - - - // Id - Id *string `json:"id,omitempty"` - - - // SocialMediaId - SocialMediaId *string `json:"socialMediaId,omitempty"` - - - // SocialMediaHub - SocialMediaHub *string `json:"socialMediaHub,omitempty"` - - - // SocialUserName - SocialUserName *string `json:"socialUserName,omitempty"` - - - // PreviewText - PreviewText *string `json:"previewText,omitempty"` - - - // RecordingId - RecordingId *string `json:"recordingId,omitempty"` - - - // Held - Held *bool `json:"held,omitempty"` - - - // Provider - Provider *string `json:"provider,omitempty"` - - - // ScriptId - ScriptId *string `json:"scriptId,omitempty"` - - - // PeerId - PeerId *string `json:"peerId,omitempty"` - - - // DisconnectType - DisconnectType *string `json:"disconnectType,omitempty"` - - - // StartHoldTime - StartHoldTime *time.Time `json:"startHoldTime,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // DisconnectedTime - DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"` - - - // Wrapup - Wrapup *Queueconversationvideoeventtopicwrapup `json:"wrapup,omitempty"` - - - // AfterCallWork - AfterCallWork *Queueconversationvideoeventtopicaftercallwork `json:"afterCallWork,omitempty"` - - - // AfterCallWorkRequired - AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationvideoeventtopicsocialexpression) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationvideoeventtopicurireference.go b/build/platformclientv2/queueconversationvideoeventtopicurireference.go deleted file mode 100644 index 332e99c46..000000000 --- a/build/platformclientv2/queueconversationvideoeventtopicurireference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationvideoeventtopicurireference -type Queueconversationvideoeventtopicurireference struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationvideoeventtopicurireference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationvideoeventtopicvideo.go b/build/platformclientv2/queueconversationvideoeventtopicvideo.go deleted file mode 100644 index b9915a68b..000000000 --- a/build/platformclientv2/queueconversationvideoeventtopicvideo.go +++ /dev/null @@ -1,86 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queueconversationvideoeventtopicvideo -type Queueconversationvideoeventtopicvideo struct { - // State - State *string `json:"state,omitempty"` - - - // Self - Self *Queueconversationvideoeventtopicaddress `json:"self,omitempty"` - - - // Id - Id *string `json:"id,omitempty"` - - - // Context - Context *string `json:"context,omitempty"` - - - // AudioMuted - AudioMuted *bool `json:"audioMuted,omitempty"` - - - // VideoMuted - VideoMuted *bool `json:"videoMuted,omitempty"` - - - // SharingScreen - SharingScreen *bool `json:"sharingScreen,omitempty"` - - - // Provider - Provider *string `json:"provider,omitempty"` - - - // ScriptId - ScriptId *string `json:"scriptId,omitempty"` - - - // PeerId - PeerId *string `json:"peerId,omitempty"` - - - // DisconnectType - DisconnectType *string `json:"disconnectType,omitempty"` - - - // ConnectedTime - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // DisconnectedTime - DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"` - - - // Msids - Msids *[]string `json:"msids,omitempty"` - - - // Wrapup - Wrapup *Queueconversationvideoeventtopicwrapup `json:"wrapup,omitempty"` - - - // AfterCallWork - AfterCallWork *Queueconversationvideoeventtopicaftercallwork `json:"afterCallWork,omitempty"` - - - // AfterCallWorkRequired - AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationvideoeventtopicvideo) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationvideoeventtopicvoicemail.go b/build/platformclientv2/queueconversationvideoeventtopicvoicemail.go deleted file mode 100644 index 4b69889e6..000000000 --- a/build/platformclientv2/queueconversationvideoeventtopicvoicemail.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueconversationvideoeventtopicvoicemail -type Queueconversationvideoeventtopicvoicemail struct { - // Id - Id *string `json:"id,omitempty"` - - - // UploadStatus - UploadStatus *string `json:"uploadStatus,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationvideoeventtopicvoicemail) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueconversationvideoeventtopicwrapup.go b/build/platformclientv2/queueconversationvideoeventtopicwrapup.go deleted file mode 100644 index f5e2aa978..000000000 --- a/build/platformclientv2/queueconversationvideoeventtopicwrapup.go +++ /dev/null @@ -1,38 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queueconversationvideoeventtopicwrapup -type Queueconversationvideoeventtopicwrapup struct { - // Code - Code *string `json:"code,omitempty"` - - - // Notes - Notes *string `json:"notes,omitempty"` - - - // Tags - Tags *[]string `json:"tags,omitempty"` - - - // DurationSeconds - DurationSeconds *int `json:"durationSeconds,omitempty"` - - - // EndTime - EndTime *time.Time `json:"endTime,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueconversationvideoeventtopicwrapup) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueemailaddress.go b/build/platformclientv2/queueemailaddress.go deleted file mode 100644 index 2102310e1..000000000 --- a/build/platformclientv2/queueemailaddress.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueemailaddress -type Queueemailaddress struct { - // Domain - Domain *Domainentityref `json:"domain,omitempty"` - - - // Route - Route *Inboundroute `json:"route,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueemailaddress) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueentitylisting.go b/build/platformclientv2/queueentitylisting.go deleted file mode 100644 index 4d25f3c5b..000000000 --- a/build/platformclientv2/queueentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueentitylisting -type Queueentitylisting struct { - // Entities - Entities *[]Queue `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queuemember.go b/build/platformclientv2/queuemember.go deleted file mode 100644 index 4c4d6ddc4..000000000 --- a/build/platformclientv2/queuemember.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queuemember -type Queuemember struct { - // Id - The queue member's id. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // User - User *User `json:"user,omitempty"` - - - // RingNumber - RingNumber *int `json:"ringNumber,omitempty"` - - - // Joined - Joined *bool `json:"joined,omitempty"` - - - // MemberBy - MemberBy *string `json:"memberBy,omitempty"` - - - // RoutingStatus - RoutingStatus *Routingstatus `json:"routingStatus,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queuemember) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queuememberentitylisting.go b/build/platformclientv2/queuememberentitylisting.go deleted file mode 100644 index 289f6b568..000000000 --- a/build/platformclientv2/queuememberentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queuememberentitylisting -type Queuememberentitylisting struct { - // Entities - Entities *[]Queuemember `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queuememberentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queuemessagingaddresses.go b/build/platformclientv2/queuemessagingaddresses.go deleted file mode 100644 index 128ed7841..000000000 --- a/build/platformclientv2/queuemessagingaddresses.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queuemessagingaddresses -type Queuemessagingaddresses struct { - // SmsAddress - SmsAddress *Domainentityref `json:"smsAddress,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queuemessagingaddresses) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueobservationdatacontainer.go b/build/platformclientv2/queueobservationdatacontainer.go deleted file mode 100644 index 248d43f73..000000000 --- a/build/platformclientv2/queueobservationdatacontainer.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueobservationdatacontainer -type Queueobservationdatacontainer struct { - // Group - A mapping from dimension to value - Group *map[string]string `json:"group,omitempty"` - - - // Data - Data *[]Observationmetricdata `json:"data,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueobservationdatacontainer) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueobservationquery.go b/build/platformclientv2/queueobservationquery.go deleted file mode 100644 index 147d07e33..000000000 --- a/build/platformclientv2/queueobservationquery.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueobservationquery -type Queueobservationquery struct { - // Filter - Filter to return a subset of observations. Expresses boolean logical predicates as well as dimensional filters - Filter *Queueobservationqueryfilter `json:"filter,omitempty"` - - - // Metrics - Behaves like a SQL SELECT clause. Only named metrics will be retrieved. - Metrics *[]string `json:"metrics,omitempty"` - - - // DetailMetrics - Metrics for which to include additional detailed observations - DetailMetrics *[]string `json:"detailMetrics,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueobservationquery) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueobservationqueryclause.go b/build/platformclientv2/queueobservationqueryclause.go deleted file mode 100644 index 76da9a48a..000000000 --- a/build/platformclientv2/queueobservationqueryclause.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueobservationqueryclause -type Queueobservationqueryclause struct { - // VarType - Boolean operation to apply to the provided predicates - VarType *string `json:"type,omitempty"` - - - // Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value). - Predicates *[]Queueobservationquerypredicate `json:"predicates,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueobservationqueryclause) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueobservationqueryfilter.go b/build/platformclientv2/queueobservationqueryfilter.go deleted file mode 100644 index a951e8281..000000000 --- a/build/platformclientv2/queueobservationqueryfilter.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueobservationqueryfilter -type Queueobservationqueryfilter struct { - // VarType - Boolean operation to apply to the provided predicates and clauses - VarType *string `json:"type,omitempty"` - - - // Clauses - Boolean 'and/or' logic with up to two-levels of nesting - Clauses *[]Queueobservationqueryclause `json:"clauses,omitempty"` - - - // Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value). - Predicates *[]Queueobservationquerypredicate `json:"predicates,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueobservationqueryfilter) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueobservationquerypredicate.go b/build/platformclientv2/queueobservationquerypredicate.go deleted file mode 100644 index 6e711855c..000000000 --- a/build/platformclientv2/queueobservationquerypredicate.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueobservationquerypredicate -type Queueobservationquerypredicate struct { - // VarType - Optional type, can usually be inferred - VarType *string `json:"type,omitempty"` - - - // Dimension - Left hand side for dimension predicates - Dimension *string `json:"dimension,omitempty"` - - - // Operator - Optional operator, default is matches - Operator *string `json:"operator,omitempty"` - - - // Value - Right hand side for dimension predicates - Value *string `json:"value,omitempty"` - - - // VarRange - Right hand side for dimension predicates - VarRange *Numericrange `json:"range,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueobservationquerypredicate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueobservationqueryresponse.go b/build/platformclientv2/queueobservationqueryresponse.go deleted file mode 100644 index da3669faf..000000000 --- a/build/platformclientv2/queueobservationqueryresponse.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueobservationqueryresponse -type Queueobservationqueryresponse struct { - // SystemToOrganizationMappings - A mapping from system presence to a list of organization presence ids - SystemToOrganizationMappings *map[string][]string `json:"systemToOrganizationMappings,omitempty"` - - - // Results - Results *[]Queueobservationdatacontainer `json:"results,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueobservationqueryresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queuereference.go b/build/platformclientv2/queuereference.go deleted file mode 100644 index b58f99b9b..000000000 --- a/build/platformclientv2/queuereference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queuereference -type Queuereference struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queuereference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queuerequest.go b/build/platformclientv2/queuerequest.go deleted file mode 100644 index 7d3964a78..000000000 --- a/build/platformclientv2/queuerequest.go +++ /dev/null @@ -1,114 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Queuerequest -type Queuerequest struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The queue name - Name *string `json:"name,omitempty"` - - - // Division - The division to which this entity belongs. - Division *Writabledivision `json:"division,omitempty"` - - - // Description - The queue description. - Description *string `json:"description,omitempty"` - - - // DateCreated - The date the queue was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - The date of the last modification to the queue. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // ModifiedBy - The ID of the user that last modified the queue. - ModifiedBy *string `json:"modifiedBy,omitempty"` - - - // CreatedBy - The ID of the user that created the queue. - CreatedBy *string `json:"createdBy,omitempty"` - - - // MemberCount - The number of users in the queue. - MemberCount *int `json:"memberCount,omitempty"` - - - // MediaSettings - The media settings for the queue. Valid key values: CALL, CALLBACK, CHAT, EMAIL, MESSAGE, SOCIAL_EXPRESSION, VIDEO_COMM - MediaSettings *map[string]Mediasetting `json:"mediaSettings,omitempty"` - - - // RoutingRules - The routing rules for the queue, used for routing to known or preferred agents. - RoutingRules *[]Routingrule `json:"routingRules,omitempty"` - - - // Bullseye - The bulls-eye settings for the queue. - Bullseye *Bullseye `json:"bullseye,omitempty"` - - - // AcwSettings - The ACW settings for the queue. - AcwSettings *Acwsettings `json:"acwSettings,omitempty"` - - - // SkillEvaluationMethod - The skill evaluation method to use when routing conversations. - SkillEvaluationMethod *string `json:"skillEvaluationMethod,omitempty"` - - - // QueueFlow - The in-queue flow to use for conversations waiting in queue. - QueueFlow *Domainentityref `json:"queueFlow,omitempty"` - - - // WhisperPrompt - The prompt used for whisper on the queue, if configured. - WhisperPrompt *Domainentityref `json:"whisperPrompt,omitempty"` - - - // AutoAnswerOnly - Specifies whether the configured whisper should play for all ACD calls, or only for those which are auto-answered. - AutoAnswerOnly *bool `json:"autoAnswerOnly,omitempty"` - - - // EnableTranscription - Indicates whether voice transcription is enabled for this queue. - EnableTranscription *bool `json:"enableTranscription,omitempty"` - - - // EnableManualAssignment - Indicates whether manual assignment is enabled for this queue. - EnableManualAssignment *bool `json:"enableManualAssignment,omitempty"` - - - // CallingPartyName - The name to use for caller identification for outbound calls from this queue. - CallingPartyName *string `json:"callingPartyName,omitempty"` - - - // CallingPartyNumber - The phone number to use for caller identification for outbound calls from this queue. - CallingPartyNumber *string `json:"callingPartyNumber,omitempty"` - - - // DefaultScripts - The default script Ids for the communication types. - DefaultScripts *map[string]Script `json:"defaultScripts,omitempty"` - - - // OutboundMessagingAddresses - The messaging addresses for the queue. - OutboundMessagingAddresses *Queuemessagingaddresses `json:"outboundMessagingAddresses,omitempty"` - - - // OutboundEmailAddress - OutboundEmailAddress *Queueemailaddress `json:"outboundEmailAddress,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queuerequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueusereventtopicqueuemember.go b/build/platformclientv2/queueusereventtopicqueuemember.go deleted file mode 100644 index cd4612201..000000000 --- a/build/platformclientv2/queueusereventtopicqueuemember.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueusereventtopicqueuemember -type Queueusereventtopicqueuemember struct { - // Id - Id *string `json:"id,omitempty"` - - - // User - User *Queueusereventtopicuserreference `json:"user,omitempty"` - - - // QueueId - QueueId *string `json:"queueId,omitempty"` - - - // Joined - Joined *bool `json:"joined,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueusereventtopicqueuemember) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueusereventtopicuserreference.go b/build/platformclientv2/queueusereventtopicuserreference.go deleted file mode 100644 index 03049e2dd..000000000 --- a/build/platformclientv2/queueusereventtopicuserreference.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueusereventtopicuserreference -type Queueusereventtopicuserreference struct { - // Id - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueusereventtopicuserreference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/queueutilizationdiagnostic.go b/build/platformclientv2/queueutilizationdiagnostic.go deleted file mode 100644 index f4bbf8f95..000000000 --- a/build/platformclientv2/queueutilizationdiagnostic.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Queueutilizationdiagnostic -type Queueutilizationdiagnostic struct { - // Queue - Identifier of the queue - Queue *Domainentityref `json:"queue,omitempty"` - - - // UsersInQueue - The number of users joined to the queue - UsersInQueue *int `json:"usersInQueue,omitempty"` - - - // ActiveUsersInQueue - The number of users active on the queue - ActiveUsersInQueue *int `json:"activeUsersInQueue,omitempty"` - - - // UsersOnQueue - The number of users with a status of on-queue - UsersOnQueue *int `json:"usersOnQueue,omitempty"` - - - // UsersNotUtilized - The number of users in the queue currently not engaged - UsersNotUtilized *int `json:"usersNotUtilized,omitempty"` - - - // UsersOnQueueWithStation - The number of users in the queue with a station - UsersOnQueueWithStation *int `json:"usersOnQueueWithStation,omitempty"` - - - // UsersOnACampaignCall - The number of users currently engaged in a campaign call - UsersOnACampaignCall *int `json:"usersOnACampaignCall,omitempty"` - - - // UsersOnDifferentEdgeGroup - The number of users whose station is homed to an edge different from the campaign - UsersOnDifferentEdgeGroup *int `json:"usersOnDifferentEdgeGroup,omitempty"` - - - // UsersOnANonCampaignCall - The number of users currently engaged in a communication that is not part of the campaign - UsersOnANonCampaignCall *int `json:"usersOnANonCampaignCall,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Queueutilizationdiagnostic) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/reaction.go b/build/platformclientv2/reaction.go deleted file mode 100644 index 49b6569f2..000000000 --- a/build/platformclientv2/reaction.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Reaction -type Reaction struct { - // Data - Parameter for this reaction. For transfer_flow, this would be the outbound flow id. - Data *string `json:"data,omitempty"` - - - // Name - Name of the parameter for this reaction. For transfer_flow, this would be the outbound flow name. - Name *string `json:"name,omitempty"` - - - // ReactionType - The reaction to take for a given call analysis result. - ReactionType *string `json:"reactionType,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Reaction) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/recallentry.go b/build/platformclientv2/recallentry.go deleted file mode 100644 index efa31ae78..000000000 --- a/build/platformclientv2/recallentry.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Recallentry -type Recallentry struct { - // NbrAttempts - NbrAttempts *int `json:"nbrAttempts,omitempty"` - - - // MinutesBetweenAttempts - MinutesBetweenAttempts *int `json:"minutesBetweenAttempts,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Recallentry) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/recipient.go b/build/platformclientv2/recipient.go deleted file mode 100644 index dc0da9b55..000000000 --- a/build/platformclientv2/recipient.go +++ /dev/null @@ -1,50 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Recipient -type Recipient struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Flow - An automate flow object which defines the set of actions to be taken, when a message is received by this provisioned phone number. - Flow *Flow `json:"flow,omitempty"` - - - // DateCreated - Date this recipient was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - Date this recipient was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // CreatedBy - User that created this recipient - CreatedBy *User `json:"createdBy,omitempty"` - - - // ModifiedBy - User that modified this recipient - ModifiedBy *User `json:"modifiedBy,omitempty"` - - - // MessengerType - The messenger type for this recipient - MessengerType *string `json:"messengerType,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Recipient) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/recipientlisting.go b/build/platformclientv2/recipientlisting.go deleted file mode 100644 index 37abc9267..000000000 --- a/build/platformclientv2/recipientlisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Recipientlisting -type Recipientlisting struct { - // Entities - Entities *[]Recipient `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Recipientlisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/record.go b/build/platformclientv2/record.go deleted file mode 100644 index 25f76e452..000000000 --- a/build/platformclientv2/record.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Record -type Record struct { - // Name - The name of the record. - Name *string `json:"name,omitempty"` - - - // VarType - The type of the record. (Example values: MX, TXT, CNAME) - VarType *string `json:"type,omitempty"` - - - // Value - The value of the record. - Value *string `json:"value,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Record) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/recording.go b/build/platformclientv2/recording.go deleted file mode 100644 index 021e14d28..000000000 --- a/build/platformclientv2/recording.go +++ /dev/null @@ -1,130 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Recording -type Recording struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // ConversationId - ConversationId *string `json:"conversationId,omitempty"` - - - // Path - Path *string `json:"path,omitempty"` - - - // StartTime - The start time of the recording. Null when there is no playable media. - StartTime *string `json:"startTime,omitempty"` - - - // EndTime - The end time of the recording. Null when there is no playable media. - EndTime *string `json:"endTime,omitempty"` - - - // Media - The type of media that the recording is. At the moment that could be audio, chat, or email. - Media *string `json:"media,omitempty"` - - - // Annotations - Annotations that belong to the recording. - Annotations *[]Annotation `json:"annotations,omitempty"` - - - // Transcript - Represents a chat transcript - Transcript *[]Chatmessage `json:"transcript,omitempty"` - - - // EmailTranscript - Represents an email transcript - EmailTranscript *[]Recordingemailmessage `json:"emailTranscript,omitempty"` - - - // MessagingTranscript - Represents a messaging transcript - MessagingTranscript *[]Recordingmessagingmessage `json:"messagingTranscript,omitempty"` - - - // FileState - Represents the current file state for a recording. Examples: Uploading, Archived, etc - FileState *string `json:"fileState,omitempty"` - - - // RestoreExpirationTime - The amount of time a restored recording will remain restored before being archived again. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - RestoreExpirationTime *time.Time `json:"restoreExpirationTime,omitempty"` - - - // MediaUris - The different mediaUris for the recording. Null when there is no playable media. - MediaUris *map[string]Mediaresult `json:"mediaUris,omitempty"` - - - // EstimatedTranscodeTimeMs - EstimatedTranscodeTimeMs *int `json:"estimatedTranscodeTimeMs,omitempty"` - - - // ActualTranscodeTimeMs - ActualTranscodeTimeMs *int `json:"actualTranscodeTimeMs,omitempty"` - - - // ArchiveDate - The date the recording will be archived. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ArchiveDate *time.Time `json:"archiveDate,omitempty"` - - - // ArchiveMedium - The type of archive medium used. Example: CloudArchive - ArchiveMedium *string `json:"archiveMedium,omitempty"` - - - // DeleteDate - The date the recording will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DeleteDate *time.Time `json:"deleteDate,omitempty"` - - - // ExportDate - The date the recording will be exported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ExportDate *time.Time `json:"exportDate,omitempty"` - - - // ExportedDate - The date the recording was exported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ExportedDate *time.Time `json:"exportedDate,omitempty"` - - - // OutputDurationMs - Duration of transcoded media in milliseconds - OutputDurationMs *int `json:"outputDurationMs,omitempty"` - - - // OutputSizeInBytes - Size of transcoded media in bytes. 0 if there is no transcoded media. - OutputSizeInBytes *int `json:"outputSizeInBytes,omitempty"` - - - // MaxAllowedRestorationsForOrg - How many archive restorations the organization is allowed to have. - MaxAllowedRestorationsForOrg *int `json:"maxAllowedRestorationsForOrg,omitempty"` - - - // RemainingRestorationsAllowedForOrg - The remaining archive restorations the organization has. - RemainingRestorationsAllowedForOrg *int `json:"remainingRestorationsAllowedForOrg,omitempty"` - - - // SessionId - The session id represents an external resource id, such as email, call, chat, etc - SessionId *string `json:"sessionId,omitempty"` - - - // Users - The users participating in the conversation - Users *[]User `json:"users,omitempty"` - - - // RecordingFileRole - Role of the file recording. It can be either customer_experience or adhoc. - RecordingFileRole *string `json:"recordingFileRole,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Recording) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/recordingapi.go b/build/platformclientv2/recordingapi.go deleted file mode 100644 index d70575de0..000000000 --- a/build/platformclientv2/recordingapi.go +++ /dev/null @@ -1,4346 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "encoding/json" -) - -// RecordingApi provides functions for API endpoints -type RecordingApi struct { - Configuration *Configuration -} - -// NewRecordingApi creates an API instance using the default configuration -func NewRecordingApi() *RecordingApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating RecordingApi with base path: %s", strings.ToLower(config.BasePath))) - return &RecordingApi{ - Configuration: config, - } -} - -// NewRecordingApiWithConfig creates an API instance using the provided configuration -func NewRecordingApiWithConfig(config *Configuration) *RecordingApi { - config.Debugf("Creating RecordingApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &RecordingApi{ - Configuration: config, - } -} - -// DeleteConversationRecordingAnnotation invokes DELETE /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId} -// -// Delete annotation -// -// -func (a RecordingApi) DeleteConversationRecordingAnnotation(conversationId string, recordingId string, annotationId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId}" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{recordingId}", fmt.Sprintf("%v", recordingId), -1) - path = strings.Replace(path, "{annotationId}", fmt.Sprintf("%v", annotationId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return nil, errors.New("Missing required parameter 'conversationId' when calling RecordingApi->DeleteConversationRecordingAnnotation") - } - // verify the required parameter 'recordingId' is set - if &recordingId == nil { - // - return nil, errors.New("Missing required parameter 'recordingId' when calling RecordingApi->DeleteConversationRecordingAnnotation") - } - // verify the required parameter 'annotationId' is set - if &annotationId == nil { - // - return nil, errors.New("Missing required parameter 'annotationId' when calling RecordingApi->DeleteConversationRecordingAnnotation") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteOrphanrecording invokes DELETE /api/v2/orphanrecordings/{orphanId} -// -// Deletes a single orphan recording -// -// -func (a RecordingApi) DeleteOrphanrecording(orphanId string) (*Orphanrecording, *APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/orphanrecordings/{orphanId}" - path = strings.Replace(path, "{orphanId}", fmt.Sprintf("%v", orphanId), -1) - defaultReturn := new(Orphanrecording) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'orphanId' is set - if &orphanId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'orphanId' when calling RecordingApi->DeleteOrphanrecording") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Orphanrecording - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// DeleteRecordingCrossplatformMediaretentionpolicies invokes DELETE /api/v2/recording/crossplatform/mediaretentionpolicies -// -// Delete media retention policies -// -// Bulk delete of media retention policies, this will only delete the polices that match the ids specified in the query param. -func (a RecordingApi) DeleteRecordingCrossplatformMediaretentionpolicies(ids string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/recording/crossplatform/mediaretentionpolicies" - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'ids' is set - if &ids == nil { - // - return nil, errors.New("Missing required parameter 'ids' when calling RecordingApi->DeleteRecordingCrossplatformMediaretentionpolicies") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(ids).(string); ok { - if str != "" { - queryParams["ids"] = a.Configuration.APIClient.ParameterToString(ids, collectionFormat) - } - } else { - queryParams["ids"] = a.Configuration.APIClient.ParameterToString(ids, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteRecordingCrossplatformMediaretentionpolicy invokes DELETE /api/v2/recording/crossplatform/mediaretentionpolicies/{policyId} -// -// Delete a media retention policy -// -// -func (a RecordingApi) DeleteRecordingCrossplatformMediaretentionpolicy(policyId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/recording/crossplatform/mediaretentionpolicies/{policyId}" - path = strings.Replace(path, "{policyId}", fmt.Sprintf("%v", policyId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'policyId' is set - if &policyId == nil { - // - return nil, errors.New("Missing required parameter 'policyId' when calling RecordingApi->DeleteRecordingCrossplatformMediaretentionpolicy") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteRecordingJob invokes DELETE /api/v2/recording/jobs/{jobId} -// -// Delete the recording bulk job -// -// -func (a RecordingApi) DeleteRecordingJob(jobId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/recording/jobs/{jobId}" - path = strings.Replace(path, "{jobId}", fmt.Sprintf("%v", jobId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'jobId' is set - if &jobId == nil { - // - return nil, errors.New("Missing required parameter 'jobId' when calling RecordingApi->DeleteRecordingJob") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteRecordingMediaretentionpolicies invokes DELETE /api/v2/recording/mediaretentionpolicies -// -// Delete media retention policies -// -// Bulk delete of media retention policies, this will only delete the polices that match the ids specified in the query param. -func (a RecordingApi) DeleteRecordingMediaretentionpolicies(ids string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/recording/mediaretentionpolicies" - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'ids' is set - if &ids == nil { - // - return nil, errors.New("Missing required parameter 'ids' when calling RecordingApi->DeleteRecordingMediaretentionpolicies") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(ids).(string); ok { - if str != "" { - queryParams["ids"] = a.Configuration.APIClient.ParameterToString(ids, collectionFormat) - } - } else { - queryParams["ids"] = a.Configuration.APIClient.ParameterToString(ids, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteRecordingMediaretentionpolicy invokes DELETE /api/v2/recording/mediaretentionpolicies/{policyId} -// -// Delete a media retention policy -// -// -func (a RecordingApi) DeleteRecordingMediaretentionpolicy(policyId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/recording/mediaretentionpolicies/{policyId}" - path = strings.Replace(path, "{policyId}", fmt.Sprintf("%v", policyId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'policyId' is set - if &policyId == nil { - // - return nil, errors.New("Missing required parameter 'policyId' when calling RecordingApi->DeleteRecordingMediaretentionpolicy") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// GetConversationRecording invokes GET /api/v2/conversations/{conversationId}/recordings/{recordingId} -// -// Gets a specific recording. -// -// -func (a RecordingApi) GetConversationRecording(conversationId string, recordingId string, formatId string, emailFormatId string, chatFormatId string, messageFormatId string, download bool, fileName string, locale string) (*Recording, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/{conversationId}/recordings/{recordingId}" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{recordingId}", fmt.Sprintf("%v", recordingId), -1) - defaultReturn := new(Recording) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling RecordingApi->GetConversationRecording") - } - // verify the required parameter 'recordingId' is set - if &recordingId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'recordingId' when calling RecordingApi->GetConversationRecording") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(formatId).(string); ok { - if str != "" { - queryParams["formatId"] = a.Configuration.APIClient.ParameterToString(formatId, collectionFormat) - } - } else { - queryParams["formatId"] = a.Configuration.APIClient.ParameterToString(formatId, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(emailFormatId).(string); ok { - if str != "" { - queryParams["emailFormatId"] = a.Configuration.APIClient.ParameterToString(emailFormatId, collectionFormat) - } - } else { - queryParams["emailFormatId"] = a.Configuration.APIClient.ParameterToString(emailFormatId, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(chatFormatId).(string); ok { - if str != "" { - queryParams["chatFormatId"] = a.Configuration.APIClient.ParameterToString(chatFormatId, collectionFormat) - } - } else { - queryParams["chatFormatId"] = a.Configuration.APIClient.ParameterToString(chatFormatId, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(messageFormatId).(string); ok { - if str != "" { - queryParams["messageFormatId"] = a.Configuration.APIClient.ParameterToString(messageFormatId, collectionFormat) - } - } else { - queryParams["messageFormatId"] = a.Configuration.APIClient.ParameterToString(messageFormatId, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(download).(string); ok { - if str != "" { - queryParams["download"] = a.Configuration.APIClient.ParameterToString(download, collectionFormat) - } - } else { - queryParams["download"] = a.Configuration.APIClient.ParameterToString(download, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(fileName).(string); ok { - if str != "" { - queryParams["fileName"] = a.Configuration.APIClient.ParameterToString(fileName, collectionFormat) - } - } else { - queryParams["fileName"] = a.Configuration.APIClient.ParameterToString(fileName, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(locale).(string); ok { - if str != "" { - queryParams["locale"] = a.Configuration.APIClient.ParameterToString(locale, collectionFormat) - } - } else { - queryParams["locale"] = a.Configuration.APIClient.ParameterToString(locale, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Recording - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversationRecordingAnnotation invokes GET /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId} -// -// Get annotation -// -// -func (a RecordingApi) GetConversationRecordingAnnotation(conversationId string, recordingId string, annotationId string) (*Annotation, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId}" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{recordingId}", fmt.Sprintf("%v", recordingId), -1) - path = strings.Replace(path, "{annotationId}", fmt.Sprintf("%v", annotationId), -1) - defaultReturn := new(Annotation) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling RecordingApi->GetConversationRecordingAnnotation") - } - // verify the required parameter 'recordingId' is set - if &recordingId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'recordingId' when calling RecordingApi->GetConversationRecordingAnnotation") - } - // verify the required parameter 'annotationId' is set - if &annotationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'annotationId' when calling RecordingApi->GetConversationRecordingAnnotation") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Annotation - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversationRecordingAnnotations invokes GET /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations -// -// Get annotations for recording -// -// -func (a RecordingApi) GetConversationRecordingAnnotations(conversationId string, recordingId string) ([]Annotation, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{recordingId}", fmt.Sprintf("%v", recordingId), -1) - defaultReturn := make([]Annotation, 0) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling RecordingApi->GetConversationRecordingAnnotations") - } - // verify the required parameter 'recordingId' is set - if &recordingId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'recordingId' when calling RecordingApi->GetConversationRecordingAnnotations") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload []Annotation - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversationRecordingmetadata invokes GET /api/v2/conversations/{conversationId}/recordingmetadata -// -// Get recording metadata for a conversation. Does not return playable media. -// -// -func (a RecordingApi) GetConversationRecordingmetadata(conversationId string) ([]Recordingmetadata, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/{conversationId}/recordingmetadata" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - defaultReturn := make([]Recordingmetadata, 0) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling RecordingApi->GetConversationRecordingmetadata") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload []Recordingmetadata - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversationRecordingmetadataRecordingId invokes GET /api/v2/conversations/{conversationId}/recordingmetadata/{recordingId} -// -// Get metadata for a specific recording. Does not return playable media. -// -// -func (a RecordingApi) GetConversationRecordingmetadataRecordingId(conversationId string, recordingId string) (*Recordingmetadata, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/{conversationId}/recordingmetadata/{recordingId}" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{recordingId}", fmt.Sprintf("%v", recordingId), -1) - defaultReturn := new(Recordingmetadata) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling RecordingApi->GetConversationRecordingmetadataRecordingId") - } - // verify the required parameter 'recordingId' is set - if &recordingId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'recordingId' when calling RecordingApi->GetConversationRecordingmetadataRecordingId") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Recordingmetadata - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConversationRecordings invokes GET /api/v2/conversations/{conversationId}/recordings -// -// Get all of a Conversation's Recordings. -// -// -func (a RecordingApi) GetConversationRecordings(conversationId string, maxWaitMs int, formatId string) ([]Recording, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/{conversationId}/recordings" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - defaultReturn := make([]Recording, 0) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling RecordingApi->GetConversationRecordings") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(maxWaitMs).(string); ok { - if str != "" { - queryParams["maxWaitMs"] = a.Configuration.APIClient.ParameterToString(maxWaitMs, collectionFormat) - } - } else { - queryParams["maxWaitMs"] = a.Configuration.APIClient.ParameterToString(maxWaitMs, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(formatId).(string); ok { - if str != "" { - queryParams["formatId"] = a.Configuration.APIClient.ParameterToString(formatId, collectionFormat) - } - } else { - queryParams["formatId"] = a.Configuration.APIClient.ParameterToString(formatId, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload []Recording - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOrphanrecording invokes GET /api/v2/orphanrecordings/{orphanId} -// -// Gets a single orphan recording -// -// -func (a RecordingApi) GetOrphanrecording(orphanId string) (*Orphanrecording, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/orphanrecordings/{orphanId}" - path = strings.Replace(path, "{orphanId}", fmt.Sprintf("%v", orphanId), -1) - defaultReturn := new(Orphanrecording) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'orphanId' is set - if &orphanId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'orphanId' when calling RecordingApi->GetOrphanrecording") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Orphanrecording - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOrphanrecordingMedia invokes GET /api/v2/orphanrecordings/{orphanId}/media -// -// Gets the media of a single orphan recording -// -// A 202 response means the orphaned media is currently transcoding and will be available shortly.A 200 response denotes the transcoded orphan media is available now and is contained in the response body. -func (a RecordingApi) GetOrphanrecordingMedia(orphanId string, formatId string, emailFormatId string, chatFormatId string, messageFormatId string, download bool, fileName string, locale string) (*Recording, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/orphanrecordings/{orphanId}/media" - path = strings.Replace(path, "{orphanId}", fmt.Sprintf("%v", orphanId), -1) - defaultReturn := new(Recording) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'orphanId' is set - if &orphanId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'orphanId' when calling RecordingApi->GetOrphanrecordingMedia") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(formatId).(string); ok { - if str != "" { - queryParams["formatId"] = a.Configuration.APIClient.ParameterToString(formatId, collectionFormat) - } - } else { - queryParams["formatId"] = a.Configuration.APIClient.ParameterToString(formatId, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(emailFormatId).(string); ok { - if str != "" { - queryParams["emailFormatId"] = a.Configuration.APIClient.ParameterToString(emailFormatId, collectionFormat) - } - } else { - queryParams["emailFormatId"] = a.Configuration.APIClient.ParameterToString(emailFormatId, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(chatFormatId).(string); ok { - if str != "" { - queryParams["chatFormatId"] = a.Configuration.APIClient.ParameterToString(chatFormatId, collectionFormat) - } - } else { - queryParams["chatFormatId"] = a.Configuration.APIClient.ParameterToString(chatFormatId, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(messageFormatId).(string); ok { - if str != "" { - queryParams["messageFormatId"] = a.Configuration.APIClient.ParameterToString(messageFormatId, collectionFormat) - } - } else { - queryParams["messageFormatId"] = a.Configuration.APIClient.ParameterToString(messageFormatId, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(download).(string); ok { - if str != "" { - queryParams["download"] = a.Configuration.APIClient.ParameterToString(download, collectionFormat) - } - } else { - queryParams["download"] = a.Configuration.APIClient.ParameterToString(download, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(fileName).(string); ok { - if str != "" { - queryParams["fileName"] = a.Configuration.APIClient.ParameterToString(fileName, collectionFormat) - } - } else { - queryParams["fileName"] = a.Configuration.APIClient.ParameterToString(fileName, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(locale).(string); ok { - if str != "" { - queryParams["locale"] = a.Configuration.APIClient.ParameterToString(locale, collectionFormat) - } - } else { - queryParams["locale"] = a.Configuration.APIClient.ParameterToString(locale, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Recording - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetOrphanrecordings invokes GET /api/v2/orphanrecordings -// -// Gets all orphan recordings -// -// -func (a RecordingApi) GetOrphanrecordings(pageSize int, pageNumber int, sortBy string, expand []string, nextPage string, previousPage string, hasConversation bool, media string) (*Orphanrecordinglisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/orphanrecordings" - defaultReturn := new(Orphanrecordinglisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(nextPage).(string); ok { - if str != "" { - queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) - } - } else { - queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(previousPage).(string); ok { - if str != "" { - queryParams["previousPage"] = a.Configuration.APIClient.ParameterToString(previousPage, collectionFormat) - } - } else { - queryParams["previousPage"] = a.Configuration.APIClient.ParameterToString(previousPage, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(hasConversation).(string); ok { - if str != "" { - queryParams["hasConversation"] = a.Configuration.APIClient.ParameterToString(hasConversation, collectionFormat) - } - } else { - queryParams["hasConversation"] = a.Configuration.APIClient.ParameterToString(hasConversation, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(media).(string); ok { - if str != "" { - queryParams["media"] = a.Configuration.APIClient.ParameterToString(media, collectionFormat) - } - } else { - queryParams["media"] = a.Configuration.APIClient.ParameterToString(media, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Orphanrecordinglisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetRecordingBatchrequest invokes GET /api/v2/recording/batchrequests/{jobId} -// -// Get the status and results for a batch request job, only the user that submitted the job may retrieve results -// -// -func (a RecordingApi) GetRecordingBatchrequest(jobId string) (*Batchdownloadjobstatusresult, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/recording/batchrequests/{jobId}" - path = strings.Replace(path, "{jobId}", fmt.Sprintf("%v", jobId), -1) - defaultReturn := new(Batchdownloadjobstatusresult) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'jobId' is set - if &jobId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'jobId' when calling RecordingApi->GetRecordingBatchrequest") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Batchdownloadjobstatusresult - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetRecordingCrossplatformMediaretentionpolicies invokes GET /api/v2/recording/crossplatform/mediaretentionpolicies -// -// Gets media retention policy list with query options to filter on name and enabled. -// -// for a less verbose response, add summary=true to this endpoint -func (a RecordingApi) GetRecordingCrossplatformMediaretentionpolicies(pageSize int, pageNumber int, sortBy string, expand []string, nextPage string, previousPage string, name string, enabled bool, summary bool, hasErrors bool) (*Policyentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/recording/crossplatform/mediaretentionpolicies" - defaultReturn := new(Policyentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(nextPage).(string); ok { - if str != "" { - queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) - } - } else { - queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(previousPage).(string); ok { - if str != "" { - queryParams["previousPage"] = a.Configuration.APIClient.ParameterToString(previousPage, collectionFormat) - } - } else { - queryParams["previousPage"] = a.Configuration.APIClient.ParameterToString(previousPage, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(enabled).(string); ok { - if str != "" { - queryParams["enabled"] = a.Configuration.APIClient.ParameterToString(enabled, collectionFormat) - } - } else { - queryParams["enabled"] = a.Configuration.APIClient.ParameterToString(enabled, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(summary).(string); ok { - if str != "" { - queryParams["summary"] = a.Configuration.APIClient.ParameterToString(summary, collectionFormat) - } - } else { - queryParams["summary"] = a.Configuration.APIClient.ParameterToString(summary, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(hasErrors).(string); ok { - if str != "" { - queryParams["hasErrors"] = a.Configuration.APIClient.ParameterToString(hasErrors, collectionFormat) - } - } else { - queryParams["hasErrors"] = a.Configuration.APIClient.ParameterToString(hasErrors, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Policyentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetRecordingCrossplatformMediaretentionpolicy invokes GET /api/v2/recording/crossplatform/mediaretentionpolicies/{policyId} -// -// Get a media retention policy -// -// -func (a RecordingApi) GetRecordingCrossplatformMediaretentionpolicy(policyId string) (*Crossplatformpolicy, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/recording/crossplatform/mediaretentionpolicies/{policyId}" - path = strings.Replace(path, "{policyId}", fmt.Sprintf("%v", policyId), -1) - defaultReturn := new(Crossplatformpolicy) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'policyId' is set - if &policyId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'policyId' when calling RecordingApi->GetRecordingCrossplatformMediaretentionpolicy") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Crossplatformpolicy - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetRecordingJob invokes GET /api/v2/recording/jobs/{jobId} -// -// Get the status of the job associated with the job id. -// -// -func (a RecordingApi) GetRecordingJob(jobId string) (*Recordingjob, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/recording/jobs/{jobId}" - path = strings.Replace(path, "{jobId}", fmt.Sprintf("%v", jobId), -1) - defaultReturn := new(Recordingjob) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'jobId' is set - if &jobId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'jobId' when calling RecordingApi->GetRecordingJob") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Recordingjob - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetRecordingJobs invokes GET /api/v2/recording/jobs -// -// Get the status of all jobs within the user's organization -// -// -func (a RecordingApi) GetRecordingJobs(pageSize int, pageNumber int, sortBy string, state string, showOnlyMyJobs bool, jobType string) (*Recordingjobentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/recording/jobs" - defaultReturn := new(Recordingjobentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(state).(string); ok { - if str != "" { - queryParams["state"] = a.Configuration.APIClient.ParameterToString(state, collectionFormat) - } - } else { - queryParams["state"] = a.Configuration.APIClient.ParameterToString(state, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(showOnlyMyJobs).(string); ok { - if str != "" { - queryParams["showOnlyMyJobs"] = a.Configuration.APIClient.ParameterToString(showOnlyMyJobs, collectionFormat) - } - } else { - queryParams["showOnlyMyJobs"] = a.Configuration.APIClient.ParameterToString(showOnlyMyJobs, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(jobType).(string); ok { - if str != "" { - queryParams["jobType"] = a.Configuration.APIClient.ParameterToString(jobType, collectionFormat) - } - } else { - queryParams["jobType"] = a.Configuration.APIClient.ParameterToString(jobType, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Recordingjobentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetRecordingLocalkeysSetting invokes GET /api/v2/recording/localkeys/settings/{settingsId} -// -// Get the local encryption settings -// -// -func (a RecordingApi) GetRecordingLocalkeysSetting(settingsId string) (*Localencryptionconfiguration, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/recording/localkeys/settings/{settingsId}" - path = strings.Replace(path, "{settingsId}", fmt.Sprintf("%v", settingsId), -1) - defaultReturn := new(Localencryptionconfiguration) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'settingsId' is set - if &settingsId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'settingsId' when calling RecordingApi->GetRecordingLocalkeysSetting") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Localencryptionconfiguration - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetRecordingLocalkeysSettings invokes GET /api/v2/recording/localkeys/settings -// -// gets a list local key settings data -// -// -func (a RecordingApi) GetRecordingLocalkeysSettings() (*Localencryptionconfigurationlisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/recording/localkeys/settings" - defaultReturn := new(Localencryptionconfigurationlisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Localencryptionconfigurationlisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetRecordingMediaretentionpolicies invokes GET /api/v2/recording/mediaretentionpolicies -// -// Gets media retention policy list with query options to filter on name and enabled. -// -// for a less verbose response, add summary=true to this endpoint -func (a RecordingApi) GetRecordingMediaretentionpolicies(pageSize int, pageNumber int, sortBy string, expand []string, nextPage string, previousPage string, name string, enabled bool, summary bool, hasErrors bool) (*Policyentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/recording/mediaretentionpolicies" - defaultReturn := new(Policyentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(nextPage).(string); ok { - if str != "" { - queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) - } - } else { - queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(previousPage).(string); ok { - if str != "" { - queryParams["previousPage"] = a.Configuration.APIClient.ParameterToString(previousPage, collectionFormat) - } - } else { - queryParams["previousPage"] = a.Configuration.APIClient.ParameterToString(previousPage, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(enabled).(string); ok { - if str != "" { - queryParams["enabled"] = a.Configuration.APIClient.ParameterToString(enabled, collectionFormat) - } - } else { - queryParams["enabled"] = a.Configuration.APIClient.ParameterToString(enabled, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(summary).(string); ok { - if str != "" { - queryParams["summary"] = a.Configuration.APIClient.ParameterToString(summary, collectionFormat) - } - } else { - queryParams["summary"] = a.Configuration.APIClient.ParameterToString(summary, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(hasErrors).(string); ok { - if str != "" { - queryParams["hasErrors"] = a.Configuration.APIClient.ParameterToString(hasErrors, collectionFormat) - } - } else { - queryParams["hasErrors"] = a.Configuration.APIClient.ParameterToString(hasErrors, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Policyentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetRecordingMediaretentionpolicy invokes GET /api/v2/recording/mediaretentionpolicies/{policyId} -// -// Get a media retention policy -// -// -func (a RecordingApi) GetRecordingMediaretentionpolicy(policyId string) (*Policy, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/recording/mediaretentionpolicies/{policyId}" - path = strings.Replace(path, "{policyId}", fmt.Sprintf("%v", policyId), -1) - defaultReturn := new(Policy) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'policyId' is set - if &policyId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'policyId' when calling RecordingApi->GetRecordingMediaretentionpolicy") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Policy - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetRecordingRecordingkeys invokes GET /api/v2/recording/recordingkeys -// -// Get encryption key list -// -// -func (a RecordingApi) GetRecordingRecordingkeys(pageSize int, pageNumber int) (*Encryptionkeyentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/recording/recordingkeys" - defaultReturn := new(Encryptionkeyentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Encryptionkeyentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetRecordingRecordingkeysRotationschedule invokes GET /api/v2/recording/recordingkeys/rotationschedule -// -// Get key rotation schedule -// -// -func (a RecordingApi) GetRecordingRecordingkeysRotationschedule() (*Keyrotationschedule, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/recording/recordingkeys/rotationschedule" - defaultReturn := new(Keyrotationschedule) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Keyrotationschedule - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetRecordingSettings invokes GET /api/v2/recording/settings -// -// Get the Recording Settings for the Organization -// -// -func (a RecordingApi) GetRecordingSettings(createDefault bool) (*Recordingsettings, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/recording/settings" - defaultReturn := new(Recordingsettings) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(createDefault).(string); ok { - if str != "" { - queryParams["createDefault"] = a.Configuration.APIClient.ParameterToString(createDefault, collectionFormat) - } - } else { - queryParams["createDefault"] = a.Configuration.APIClient.ParameterToString(createDefault, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Recordingsettings - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetRecordingsScreensessions invokes GET /api/v2/recordings/screensessions -// -// Retrieves a paged listing of screen recording sessions -// -// -func (a RecordingApi) GetRecordingsScreensessions(pageSize int, pageNumber int) (*Screenrecordingsessionlisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/recordings/screensessions" - defaultReturn := new(Screenrecordingsessionlisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Screenrecordingsessionlisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchRecordingCrossplatformMediaretentionpolicy invokes PATCH /api/v2/recording/crossplatform/mediaretentionpolicies/{policyId} -// -// Patch a media retention policy -// -// -func (a RecordingApi) PatchRecordingCrossplatformMediaretentionpolicy(policyId string, body Crossplatformpolicy) (*Crossplatformpolicy, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/recording/crossplatform/mediaretentionpolicies/{policyId}" - path = strings.Replace(path, "{policyId}", fmt.Sprintf("%v", policyId), -1) - defaultReturn := new(Crossplatformpolicy) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'policyId' is set - if &policyId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'policyId' when calling RecordingApi->PatchRecordingCrossplatformMediaretentionpolicy") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RecordingApi->PatchRecordingCrossplatformMediaretentionpolicy") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Crossplatformpolicy - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchRecordingMediaretentionpolicy invokes PATCH /api/v2/recording/mediaretentionpolicies/{policyId} -// -// Patch a media retention policy -// -// -func (a RecordingApi) PatchRecordingMediaretentionpolicy(policyId string, body Policy) (*Policy, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/recording/mediaretentionpolicies/{policyId}" - path = strings.Replace(path, "{policyId}", fmt.Sprintf("%v", policyId), -1) - defaultReturn := new(Policy) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'policyId' is set - if &policyId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'policyId' when calling RecordingApi->PatchRecordingMediaretentionpolicy") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RecordingApi->PatchRecordingMediaretentionpolicy") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Policy - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchRecordingsScreensession invokes PATCH /api/v2/recordings/screensessions/{recordingSessionId} -// -// Update a screen recording session -// -// -func (a RecordingApi) PatchRecordingsScreensession(recordingSessionId string, body Screenrecordingsessionrequest) (*APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/recordings/screensessions/{recordingSessionId}" - path = strings.Replace(path, "{recordingSessionId}", fmt.Sprintf("%v", recordingSessionId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'recordingSessionId' is set - if &recordingSessionId == nil { - // - return nil, errors.New("Missing required parameter 'recordingSessionId' when calling RecordingApi->PatchRecordingsScreensession") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// PostConversationRecordingAnnotations invokes POST /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations -// -// Create annotation -// -// -func (a RecordingApi) PostConversationRecordingAnnotations(conversationId string, recordingId string, body Annotation) (*Annotation, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{recordingId}", fmt.Sprintf("%v", recordingId), -1) - defaultReturn := new(Annotation) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling RecordingApi->PostConversationRecordingAnnotations") - } - // verify the required parameter 'recordingId' is set - if &recordingId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'recordingId' when calling RecordingApi->PostConversationRecordingAnnotations") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RecordingApi->PostConversationRecordingAnnotations") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Annotation - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostRecordingBatchrequests invokes POST /api/v2/recording/batchrequests -// -// Submit a batch download request for recordings. Recordings in response will be in their original format/codec - configured in the Trunk configuration. -// -// -func (a RecordingApi) PostRecordingBatchrequests(body Batchdownloadjobsubmission) (*Batchdownloadjobsubmissionresult, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/recording/batchrequests" - defaultReturn := new(Batchdownloadjobsubmissionresult) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RecordingApi->PostRecordingBatchrequests") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Batchdownloadjobsubmissionresult - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostRecordingCrossplatformMediaretentionpolicies invokes POST /api/v2/recording/crossplatform/mediaretentionpolicies -// -// Create media retention policy -// -// -func (a RecordingApi) PostRecordingCrossplatformMediaretentionpolicies(body Crossplatformpolicycreate) (*Crossplatformpolicy, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/recording/crossplatform/mediaretentionpolicies" - defaultReturn := new(Crossplatformpolicy) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RecordingApi->PostRecordingCrossplatformMediaretentionpolicies") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Crossplatformpolicy - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostRecordingJobs invokes POST /api/v2/recording/jobs -// -// Create a recording bulk job -// -// -func (a RecordingApi) PostRecordingJobs(body Recordingjobsquery) (*Recordingjob, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/recording/jobs" - defaultReturn := new(Recordingjob) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RecordingApi->PostRecordingJobs") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Recordingjob - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostRecordingLocalkeys invokes POST /api/v2/recording/localkeys -// -// create a local recording key -// -// -func (a RecordingApi) PostRecordingLocalkeys(body Localencryptionkeyrequest) (*Encryptionkey, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/recording/localkeys" - defaultReturn := new(Encryptionkey) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RecordingApi->PostRecordingLocalkeys") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Encryptionkey - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostRecordingLocalkeysSettings invokes POST /api/v2/recording/localkeys/settings -// -// create settings for local key creation -// -// -func (a RecordingApi) PostRecordingLocalkeysSettings(body Localencryptionconfiguration) (*Localencryptionconfiguration, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/recording/localkeys/settings" - defaultReturn := new(Localencryptionconfiguration) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RecordingApi->PostRecordingLocalkeysSettings") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Localencryptionconfiguration - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostRecordingMediaretentionpolicies invokes POST /api/v2/recording/mediaretentionpolicies -// -// Create media retention policy -// -// -func (a RecordingApi) PostRecordingMediaretentionpolicies(body Policycreate) (*Policy, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/recording/mediaretentionpolicies" - defaultReturn := new(Policy) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RecordingApi->PostRecordingMediaretentionpolicies") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Policy - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostRecordingRecordingkeys invokes POST /api/v2/recording/recordingkeys -// -// Create encryption key -// -// -func (a RecordingApi) PostRecordingRecordingkeys() (*Encryptionkey, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/recording/recordingkeys" - defaultReturn := new(Encryptionkey) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Encryptionkey - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostRecordingsDeletionprotection invokes POST /api/v2/recordings/deletionprotection -// -// Get a list of conversations with protected recordings -// -// -func (a RecordingApi) PostRecordingsDeletionprotection(body Conversationdeletionprotectionquery) ([]Addressableentityref, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/recordings/deletionprotection" - defaultReturn := make([]Addressableentityref, 0) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RecordingApi->PostRecordingsDeletionprotection") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload []Addressableentityref - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutConversationRecording invokes PUT /api/v2/conversations/{conversationId}/recordings/{recordingId} -// -// Updates the retention records on a recording. -// -// Currently supports updating and removing both archive and delete dates for eligible recordings. A request to change the archival date of an archived recording will result in a restoration of the recording until the new date set. The recording:recording:view permission is required for the recording, as well as either the recording:recording:editRetention or recording:screenRecording:editRetention permissions depending on the type of recording. -func (a RecordingApi) PutConversationRecording(conversationId string, recordingId string, body Recording) (*Recording, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/{conversationId}/recordings/{recordingId}" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{recordingId}", fmt.Sprintf("%v", recordingId), -1) - defaultReturn := new(Recording) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling RecordingApi->PutConversationRecording") - } - // verify the required parameter 'recordingId' is set - if &recordingId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'recordingId' when calling RecordingApi->PutConversationRecording") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RecordingApi->PutConversationRecording") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Recording - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutConversationRecordingAnnotation invokes PUT /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId} -// -// Update annotation -// -// -func (a RecordingApi) PutConversationRecordingAnnotation(conversationId string, recordingId string, annotationId string, body Annotation) (*Annotation, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId}" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{recordingId}", fmt.Sprintf("%v", recordingId), -1) - path = strings.Replace(path, "{annotationId}", fmt.Sprintf("%v", annotationId), -1) - defaultReturn := new(Annotation) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling RecordingApi->PutConversationRecordingAnnotation") - } - // verify the required parameter 'recordingId' is set - if &recordingId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'recordingId' when calling RecordingApi->PutConversationRecordingAnnotation") - } - // verify the required parameter 'annotationId' is set - if &annotationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'annotationId' when calling RecordingApi->PutConversationRecordingAnnotation") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RecordingApi->PutConversationRecordingAnnotation") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Annotation - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutOrphanrecording invokes PUT /api/v2/orphanrecordings/{orphanId} -// -// Updates an orphan recording to a regular recording with retention values -// -// If this operation is successful the orphan will no longer exist. It will be replaced by the resulting recording in the response. This replacement recording is accessible by the normal Recording api. -func (a RecordingApi) PutOrphanrecording(orphanId string, body Orphanupdaterequest) (*Recording, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/orphanrecordings/{orphanId}" - path = strings.Replace(path, "{orphanId}", fmt.Sprintf("%v", orphanId), -1) - defaultReturn := new(Recording) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'orphanId' is set - if &orphanId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'orphanId' when calling RecordingApi->PutOrphanrecording") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Recording - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutRecordingCrossplatformMediaretentionpolicy invokes PUT /api/v2/recording/crossplatform/mediaretentionpolicies/{policyId} -// -// Update a media retention policy -// -// -func (a RecordingApi) PutRecordingCrossplatformMediaretentionpolicy(policyId string, body Crossplatformpolicy) (*Crossplatformpolicy, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/recording/crossplatform/mediaretentionpolicies/{policyId}" - path = strings.Replace(path, "{policyId}", fmt.Sprintf("%v", policyId), -1) - defaultReturn := new(Crossplatformpolicy) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'policyId' is set - if &policyId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'policyId' when calling RecordingApi->PutRecordingCrossplatformMediaretentionpolicy") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RecordingApi->PutRecordingCrossplatformMediaretentionpolicy") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Crossplatformpolicy - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutRecordingJob invokes PUT /api/v2/recording/jobs/{jobId} -// -// Execute the recording bulk job. -// -// A job must be executed by the same user whom originally created the job. In addition, the user must have permission to update the recording's retention. -func (a RecordingApi) PutRecordingJob(jobId string, body Executerecordingjobsquery) (*Recordingjob, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/recording/jobs/{jobId}" - path = strings.Replace(path, "{jobId}", fmt.Sprintf("%v", jobId), -1) - defaultReturn := new(Recordingjob) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'jobId' is set - if &jobId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'jobId' when calling RecordingApi->PutRecordingJob") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RecordingApi->PutRecordingJob") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Recordingjob - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutRecordingLocalkeysSetting invokes PUT /api/v2/recording/localkeys/settings/{settingsId} -// -// Update the local encryption settings -// -// -func (a RecordingApi) PutRecordingLocalkeysSetting(settingsId string, body Localencryptionconfiguration) (*Localencryptionconfiguration, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/recording/localkeys/settings/{settingsId}" - path = strings.Replace(path, "{settingsId}", fmt.Sprintf("%v", settingsId), -1) - defaultReturn := new(Localencryptionconfiguration) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'settingsId' is set - if &settingsId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'settingsId' when calling RecordingApi->PutRecordingLocalkeysSetting") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RecordingApi->PutRecordingLocalkeysSetting") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Localencryptionconfiguration - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutRecordingMediaretentionpolicy invokes PUT /api/v2/recording/mediaretentionpolicies/{policyId} -// -// Update a media retention policy -// -// -func (a RecordingApi) PutRecordingMediaretentionpolicy(policyId string, body Policy) (*Policy, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/recording/mediaretentionpolicies/{policyId}" - path = strings.Replace(path, "{policyId}", fmt.Sprintf("%v", policyId), -1) - defaultReturn := new(Policy) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'policyId' is set - if &policyId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'policyId' when calling RecordingApi->PutRecordingMediaretentionpolicy") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RecordingApi->PutRecordingMediaretentionpolicy") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Policy - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutRecordingRecordingkeysRotationschedule invokes PUT /api/v2/recording/recordingkeys/rotationschedule -// -// Update key rotation schedule -// -// -func (a RecordingApi) PutRecordingRecordingkeysRotationschedule(body Keyrotationschedule) (*Keyrotationschedule, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/recording/recordingkeys/rotationschedule" - defaultReturn := new(Keyrotationschedule) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RecordingApi->PutRecordingRecordingkeysRotationschedule") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Keyrotationschedule - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutRecordingSettings invokes PUT /api/v2/recording/settings -// -// Update the Recording Settings for the Organization -// -// -func (a RecordingApi) PutRecordingSettings(body Recordingsettings) (*Recordingsettings, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/recording/settings" - defaultReturn := new(Recordingsettings) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RecordingApi->PutRecordingSettings") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Recordingsettings - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutRecordingsDeletionprotection invokes PUT /api/v2/recordings/deletionprotection -// -// Apply or revoke recording protection for conversations -// -// -func (a RecordingApi) PutRecordingsDeletionprotection(protect bool, body Conversationdeletionprotectionquery) (*APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/recordings/deletionprotection" - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(protect).(string); ok { - if str != "" { - queryParams["protect"] = a.Configuration.APIClient.ParameterToString(protect, collectionFormat) - } - } else { - queryParams["protect"] = a.Configuration.APIClient.ParameterToString(protect, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - diff --git a/build/platformclientv2/recordingarchiverestoretopicmediaresult.go b/build/platformclientv2/recordingarchiverestoretopicmediaresult.go deleted file mode 100644 index cae2cf214..000000000 --- a/build/platformclientv2/recordingarchiverestoretopicmediaresult.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Recordingarchiverestoretopicmediaresult -type Recordingarchiverestoretopicmediaresult struct { - // ChannelId - ChannelId *string `json:"channelId,omitempty"` - - - // WaveUri - WaveUri *string `json:"waveUri,omitempty"` - - - // MediaUri - MediaUri *string `json:"mediaUri,omitempty"` - - - // WaveformData - WaveformData *[]float32 `json:"waveformData,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Recordingarchiverestoretopicmediaresult) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/recordingarchiverestoretopicrecording.go b/build/platformclientv2/recordingarchiverestoretopicrecording.go deleted file mode 100644 index f0d248c2d..000000000 --- a/build/platformclientv2/recordingarchiverestoretopicrecording.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Recordingarchiverestoretopicrecording -type Recordingarchiverestoretopicrecording struct { - // Id - Id *string `json:"id,omitempty"` - - - // ConversationId - ConversationId *string `json:"conversationId,omitempty"` - - - // FileState - FileState *string `json:"fileState,omitempty"` - - - // MediaUris - MediaUris *[]Recordingarchiverestoretopicmediaresult `json:"mediaUris,omitempty"` - - - // EstimatedTranscodeTimeMs - EstimatedTranscodeTimeMs *float32 `json:"estimatedTranscodeTimeMs,omitempty"` - - - // ActualTranscodeTimeMs - ActualTranscodeTimeMs *float32 `json:"actualTranscodeTimeMs,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Recordingarchiverestoretopicrecording) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/recordingemailmessage.go b/build/platformclientv2/recordingemailmessage.go deleted file mode 100644 index 3cd5836f1..000000000 --- a/build/platformclientv2/recordingemailmessage.go +++ /dev/null @@ -1,54 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Recordingemailmessage -type Recordingemailmessage struct { - // HtmlBody - HtmlBody *string `json:"htmlBody,omitempty"` - - - // TextBody - TextBody *string `json:"textBody,omitempty"` - - - // Id - Id *string `json:"id,omitempty"` - - - // To - To *[]Emailaddress `json:"to,omitempty"` - - - // Cc - Cc *[]Emailaddress `json:"cc,omitempty"` - - - // Bcc - Bcc *[]Emailaddress `json:"bcc,omitempty"` - - - // From - From *Emailaddress `json:"from,omitempty"` - - - // Subject - Subject *string `json:"subject,omitempty"` - - - // Attachments - Attachments *[]Emailattachment `json:"attachments,omitempty"` - - - // Time - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - Time *time.Time `json:"time,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Recordingemailmessage) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/recordingeventmediaresult.go b/build/platformclientv2/recordingeventmediaresult.go deleted file mode 100644 index 539daa30b..000000000 --- a/build/platformclientv2/recordingeventmediaresult.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Recordingeventmediaresult -type Recordingeventmediaresult struct { - // ChannelId - ChannelId *string `json:"channelId,omitempty"` - - - // WaveUri - WaveUri *string `json:"waveUri,omitempty"` - - - // MediaUri - MediaUri *string `json:"mediaUri,omitempty"` - - - // WaveformData - WaveformData *[]float32 `json:"waveformData,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Recordingeventmediaresult) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/recordingeventrecording.go b/build/platformclientv2/recordingeventrecording.go deleted file mode 100644 index 34b349899..000000000 --- a/build/platformclientv2/recordingeventrecording.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Recordingeventrecording -type Recordingeventrecording struct { - // Id - Id *string `json:"id,omitempty"` - - - // ConversationId - ConversationId *string `json:"conversationId,omitempty"` - - - // FileState - FileState *string `json:"fileState,omitempty"` - - - // MediaUris - MediaUris *[]Recordingeventmediaresult `json:"mediaUris,omitempty"` - - - // EstimatedTranscodeTimeMs - EstimatedTranscodeTimeMs *float32 `json:"estimatedTranscodeTimeMs,omitempty"` - - - // ActualTranscodeTimeMs - ActualTranscodeTimeMs *float32 `json:"actualTranscodeTimeMs,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Recordingeventrecording) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/recordingjob.go b/build/platformclientv2/recordingjob.go deleted file mode 100644 index 6c30c9c51..000000000 --- a/build/platformclientv2/recordingjob.go +++ /dev/null @@ -1,58 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Recordingjob -type Recordingjob struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // State - The current state of the job. - State *string `json:"state,omitempty"` - - - // RecordingJobsQuery - Original query of the job. - RecordingJobsQuery *Recordingjobsquery `json:"recordingJobsQuery,omitempty"` - - - // DateCreated - Date when the job was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // TotalConversations - Total number of conversations affected. - TotalConversations *int `json:"totalConversations,omitempty"` - - - // TotalRecordings - Total number of recordings affected. - TotalRecordings *int `json:"totalRecordings,omitempty"` - - - // TotalProcessedRecordings - Total number of recordings have been processed. - TotalProcessedRecordings *int `json:"totalProcessedRecordings,omitempty"` - - - // PercentProgress - Progress in percentage based on the number of recordings - PercentProgress *int `json:"percentProgress,omitempty"` - - - // ErrorMessage - Error occurred during the job execution - ErrorMessage *string `json:"errorMessage,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - - - // User - Details of the user created the job - User *Addressableentityref `json:"user,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Recordingjob) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/recordingjobentitylisting.go b/build/platformclientv2/recordingjobentitylisting.go deleted file mode 100644 index a7f471bf9..000000000 --- a/build/platformclientv2/recordingjobentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Recordingjobentitylisting -type Recordingjobentitylisting struct { - // Entities - Entities *[]Recordingjob `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Recordingjobentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/recordingjobsquery.go b/build/platformclientv2/recordingjobsquery.go deleted file mode 100644 index a5e07ee47..000000000 --- a/build/platformclientv2/recordingjobsquery.go +++ /dev/null @@ -1,34 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Recordingjobsquery -type Recordingjobsquery struct { - // Action - Operation to perform bulk task - Action *string `json:"action,omitempty"` - - - // ActionDate - The date when the action will be performed. If the operation will cause the delete date of a recording to be older than the export date, the export date will be adjusted to the delete date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ActionDate *time.Time `json:"actionDate,omitempty"` - - - // IntegrationId - IntegrationId to Access AWS S3 bucket for bulk recording exports. This field is required and used only for EXPORT action. - IntegrationId *string `json:"integrationId,omitempty"` - - - // IncludeScreenRecordings - Include Screen recordings for export action, default value = true - IncludeScreenRecordings *bool `json:"includeScreenRecordings,omitempty"` - - - // ConversationQuery - Conversation Query. Note: After the recording is created, it might take up to 48 hours for the recording to be included in the submitted job query. - ConversationQuery *Asyncconversationquery `json:"conversationQuery,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Recordingjobsquery) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/recordingmessagingmessage.go b/build/platformclientv2/recordingmessagingmessage.go deleted file mode 100644 index c650f590f..000000000 --- a/build/platformclientv2/recordingmessagingmessage.go +++ /dev/null @@ -1,50 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Recordingmessagingmessage -type Recordingmessagingmessage struct { - // From - From *string `json:"from,omitempty"` - - - // FromUser - FromUser *User `json:"fromUser,omitempty"` - - - // FromExternalContact - FromExternalContact *Externalcontact `json:"fromExternalContact,omitempty"` - - - // To - To *string `json:"to,omitempty"` - - - // Timestamp - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - Timestamp *time.Time `json:"timestamp,omitempty"` - - - // Id - Id *string `json:"id,omitempty"` - - - // MessageText - MessageText *string `json:"messageText,omitempty"` - - - // MessageMediaAttachments - MessageMediaAttachments *[]Messagemediaattachment `json:"messageMediaAttachments,omitempty"` - - - // MessageStickerAttachments - MessageStickerAttachments *[]Messagestickerattachment `json:"messageStickerAttachments,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Recordingmessagingmessage) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/recordingmetadata.go b/build/platformclientv2/recordingmetadata.go deleted file mode 100644 index 1c18d39c6..000000000 --- a/build/platformclientv2/recordingmetadata.go +++ /dev/null @@ -1,90 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Recordingmetadata -type Recordingmetadata struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // ConversationId - ConversationId *string `json:"conversationId,omitempty"` - - - // Path - Path *string `json:"path,omitempty"` - - - // StartTime - The start time of the recording for screen recordings. Null for other types. - StartTime *string `json:"startTime,omitempty"` - - - // EndTime - EndTime *string `json:"endTime,omitempty"` - - - // Media - The type of media that the recording is. At the moment that could be audio, chat, email, or message. - Media *string `json:"media,omitempty"` - - - // Annotations - Annotations that belong to the recording. Populated when recording filestate is AVAILABLE. - Annotations *[]Annotation `json:"annotations,omitempty"` - - - // FileState - Represents the current file state for a recording. Examples: Uploading, Archived, etc - FileState *string `json:"fileState,omitempty"` - - - // RestoreExpirationTime - The amount of time a restored recording will remain restored before being archived again. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - RestoreExpirationTime *time.Time `json:"restoreExpirationTime,omitempty"` - - - // ArchiveDate - The date the recording will be archived. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ArchiveDate *time.Time `json:"archiveDate,omitempty"` - - - // ArchiveMedium - The type of archive medium used. Example: CloudArchive - ArchiveMedium *string `json:"archiveMedium,omitempty"` - - - // DeleteDate - The date the recording will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DeleteDate *time.Time `json:"deleteDate,omitempty"` - - - // ExportDate - The date the recording will be exported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ExportDate *time.Time `json:"exportDate,omitempty"` - - - // ExportedDate - The date the recording was exported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ExportedDate *time.Time `json:"exportedDate,omitempty"` - - - // MaxAllowedRestorationsForOrg - How many archive restorations the organization is allowed to have. - MaxAllowedRestorationsForOrg *int `json:"maxAllowedRestorationsForOrg,omitempty"` - - - // RemainingRestorationsAllowedForOrg - The remaining archive restorations the organization has. - RemainingRestorationsAllowedForOrg *int `json:"remainingRestorationsAllowedForOrg,omitempty"` - - - // SessionId - The session id represents an external resource id, such as email, call, chat, etc - SessionId *string `json:"sessionId,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Recordingmetadata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/recordingsettings.go b/build/platformclientv2/recordingsettings.go deleted file mode 100644 index f91a371a6..000000000 --- a/build/platformclientv2/recordingsettings.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Recordingsettings -type Recordingsettings struct { - // MaxSimultaneousStreams - Maximum number of simultaneous screen recording streams - MaxSimultaneousStreams *int `json:"maxSimultaneousStreams,omitempty"` - - - // MaxConfigurableScreenRecordingStreams - Upper limit that maxSimultaneousStreams can be configured - MaxConfigurableScreenRecordingStreams *int `json:"maxConfigurableScreenRecordingStreams,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Recordingsettings) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/recordingtranscodecompletetopicmediaresult.go b/build/platformclientv2/recordingtranscodecompletetopicmediaresult.go deleted file mode 100644 index 9b27bfb56..000000000 --- a/build/platformclientv2/recordingtranscodecompletetopicmediaresult.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Recordingtranscodecompletetopicmediaresult -type Recordingtranscodecompletetopicmediaresult struct { - // ChannelId - ChannelId *string `json:"channelId,omitempty"` - - - // WaveUri - WaveUri *string `json:"waveUri,omitempty"` - - - // MediaUri - MediaUri *string `json:"mediaUri,omitempty"` - - - // WaveformData - WaveformData *[]float32 `json:"waveformData,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Recordingtranscodecompletetopicmediaresult) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/recordingtranscodecompletetopicrecording.go b/build/platformclientv2/recordingtranscodecompletetopicrecording.go deleted file mode 100644 index 8965d1e3f..000000000 --- a/build/platformclientv2/recordingtranscodecompletetopicrecording.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Recordingtranscodecompletetopicrecording -type Recordingtranscodecompletetopicrecording struct { - // Id - Id *string `json:"id,omitempty"` - - - // ConversationId - ConversationId *string `json:"conversationId,omitempty"` - - - // FileState - FileState *string `json:"fileState,omitempty"` - - - // MediaUris - MediaUris *[]Recordingtranscodecompletetopicmediaresult `json:"mediaUris,omitempty"` - - - // EstimatedTranscodeTimeMs - EstimatedTranscodeTimeMs *float32 `json:"estimatedTranscodeTimeMs,omitempty"` - - - // ActualTranscodeTimeMs - ActualTranscodeTimeMs *float32 `json:"actualTranscodeTimeMs,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Recordingtranscodecompletetopicrecording) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/regiontimezone.go b/build/platformclientv2/regiontimezone.go deleted file mode 100644 index 18fa90d52..000000000 --- a/build/platformclientv2/regiontimezone.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Regiontimezone -type Regiontimezone struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Offset - Offset *int `json:"offset,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Regiontimezone) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/relationship.go b/build/platformclientv2/relationship.go deleted file mode 100644 index 324506b0c..000000000 --- a/build/platformclientv2/relationship.go +++ /dev/null @@ -1,41 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Relationship -type Relationship struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // User - The user associated with the external organization - User *User `json:"user,omitempty"` - - - // ExternalOrganization - The external organization this relationship is attached to - ExternalOrganization *Externalorganization `json:"externalOrganization,omitempty"` - - - // Relationship - The relationship or role of the user to this external organization.Examples: Account Manager, Sales Engineer, Implementation Consultant - Relationship *string `json:"relationship,omitempty"` - - - // ExternalDataSources - Links to the sources of data (e.g. one source might be a CRM) that contributed data to this record. Read-only, and only populated when requested via expand param. - ExternalDataSources *[]Externaldatasource `json:"externalDataSources,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Relationship) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/relationshiplisting.go b/build/platformclientv2/relationshiplisting.go deleted file mode 100644 index 1b34e2891..000000000 --- a/build/platformclientv2/relationshiplisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Relationshiplisting -type Relationshiplisting struct { - // Entities - Entities *[]Relationship `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Relationshiplisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/replacementterm.go b/build/platformclientv2/replacementterm.go deleted file mode 100644 index b9b32aa27..000000000 --- a/build/platformclientv2/replacementterm.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Replacementterm -type Replacementterm struct { - // VarType - VarType *string `json:"type,omitempty"` - - - // ExistingValue - ExistingValue *string `json:"existingValue,omitempty"` - - - // UpdatedValue - UpdatedValue *string `json:"updatedValue,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Replacementterm) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/replacerequest.go b/build/platformclientv2/replacerequest.go deleted file mode 100644 index 979c65273..000000000 --- a/build/platformclientv2/replacerequest.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Replacerequest -type Replacerequest struct { - // ChangeNumber - ChangeNumber *int `json:"changeNumber,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // AuthToken - AuthToken *string `json:"authToken,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Replacerequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/replaceresponse.go b/build/platformclientv2/replaceresponse.go deleted file mode 100644 index 5b89b91f9..000000000 --- a/build/platformclientv2/replaceresponse.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Replaceresponse -type Replaceresponse struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // ChangeNumber - ChangeNumber *int `json:"changeNumber,omitempty"` - - - // UploadStatus - UploadStatus *Domainentityref `json:"uploadStatus,omitempty"` - - - // UploadDestinationUri - UploadDestinationUri *string `json:"uploadDestinationUri,omitempty"` - - - // UploadMethod - UploadMethod *string `json:"uploadMethod,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Replaceresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/reportingdataexporttopicdataexportnotification.go b/build/platformclientv2/reportingdataexporttopicdataexportnotification.go deleted file mode 100644 index b4309a06d..000000000 --- a/build/platformclientv2/reportingdataexporttopicdataexportnotification.go +++ /dev/null @@ -1,74 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Reportingdataexporttopicdataexportnotification -type Reportingdataexporttopicdataexportnotification struct { - // Id - Id *string `json:"id,omitempty"` - - - // RunId - RunId *string `json:"runId,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Status - Status *string `json:"status,omitempty"` - - - // ExportFormat - ExportFormat *string `json:"exportFormat,omitempty"` - - - // DownloadUrl - DownloadUrl *string `json:"downloadUrl,omitempty"` - - - // ViewType - ViewType *string `json:"viewType,omitempty"` - - - // ExportErrorMessagesType - ExportErrorMessagesType *string `json:"exportErrorMessagesType,omitempty"` - - - // Read - Read *bool `json:"read,omitempty"` - - - // CreatedDateTime - CreatedDateTime *time.Time `json:"createdDateTime,omitempty"` - - - // ModifiedDateTime - ModifiedDateTime *time.Time `json:"modifiedDateTime,omitempty"` - - - // PercentageComplete - PercentageComplete *float32 `json:"percentageComplete,omitempty"` - - - // EmailStatuses - EmailStatuses *map[string]string `json:"emailStatuses,omitempty"` - - - // EmailErrorDescription - EmailErrorDescription *string `json:"emailErrorDescription,omitempty"` - - - // ScheduleExpression - ScheduleExpression *string `json:"scheduleExpression,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Reportingdataexporttopicdataexportnotification) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/reportingexportjoblisting.go b/build/platformclientv2/reportingexportjoblisting.go deleted file mode 100644 index 454272488..000000000 --- a/build/platformclientv2/reportingexportjoblisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Reportingexportjoblisting -type Reportingexportjoblisting struct { - // Entities - Entities *[]Reportingexportjobresponse `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Reportingexportjoblisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/reportingexportjobrequest.go b/build/platformclientv2/reportingexportjobrequest.go deleted file mode 100644 index 3e5da55b3..000000000 --- a/build/platformclientv2/reportingexportjobrequest.go +++ /dev/null @@ -1,85 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Reportingexportjobrequest -type Reportingexportjobrequest struct { - // Name - The user supplied name of the export request - Name *string `json:"name,omitempty"` - - - // TimeZone - The requested timezone of the exported data. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London - TimeZone *string `json:"timeZone,omitempty"` - - - // ExportFormat - The requested format of the exported data - ExportFormat *string `json:"exportFormat,omitempty"` - - - // Interval - The time period used to limit the the exported data. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss - Interval *string `json:"interval,omitempty"` - - - // Period - The Period of the request in which to break down the intervals. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H - Period *string `json:"period,omitempty"` - - - // ViewType - The type of view export job to be created - ViewType *string `json:"viewType,omitempty"` - - - // Filter - Filters to apply to create the view - Filter *Viewfilter `json:"filter,omitempty"` - - - // Read - Indicates if the request has been marked as read - Read *bool `json:"read,omitempty"` - - - // Locale - The locale use for localization of the exported data, i.e. en-us, es-mx - Locale *string `json:"locale,omitempty"` - - - // HasFormatDurations - Indicates if durations are formatted in hh:mm:ss format instead of ms - HasFormatDurations *bool `json:"hasFormatDurations,omitempty"` - - - // HasSplitFilters - Indicates if filters will be split in aggregate detail exports - HasSplitFilters *bool `json:"hasSplitFilters,omitempty"` - - - // ExcludeEmptyRows - Excludes empty rows from the exports - ExcludeEmptyRows *bool `json:"excludeEmptyRows,omitempty"` - - - // HasSplitByMedia - Indicates if media type will be split in aggregate detail exports - HasSplitByMedia *bool `json:"hasSplitByMedia,omitempty"` - - - // HasSummaryRow - Indicates if summary row needs to be present in exports - HasSummaryRow *bool `json:"hasSummaryRow,omitempty"` - - - // CsvDelimiter - The user supplied csv delimiter string value either of type 'comma' or 'semicolon' permitted for the export request - CsvDelimiter *string `json:"csvDelimiter,omitempty"` - - - // SelectedColumns - The list of ordered selected columns from the export view by the user - SelectedColumns *[]Selectedcolumns `json:"selectedColumns,omitempty"` - - - // HasCustomParticipantAttributes - Indicates if custom participant attributes will be exported - HasCustomParticipantAttributes *bool `json:"hasCustomParticipantAttributes,omitempty"` - - - // RecipientEmails - The list of email recipients for the exports - RecipientEmails *[]string `json:"recipientEmails,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Reportingexportjobrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/reportingexportjobresponse.go b/build/platformclientv2/reportingexportjobresponse.go deleted file mode 100644 index b41571ff0..000000000 --- a/build/platformclientv2/reportingexportjobresponse.go +++ /dev/null @@ -1,134 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Reportingexportjobresponse -type Reportingexportjobresponse struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // RunId - The unique run id of the export schedule execute - RunId *string `json:"runId,omitempty"` - - - // Status - The current status of the export request - Status *string `json:"status,omitempty"` - - - // TimeZone - The requested timezone of the exported data. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London - TimeZone *string `json:"timeZone,omitempty"` - - - // ExportFormat - The requested format of the exported data - ExportFormat *string `json:"exportFormat,omitempty"` - - - // Interval - The time period used to limit the the exported data. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss - Interval *string `json:"interval,omitempty"` - - - // DownloadUrl - The url to download the request if it's status is completed - DownloadUrl *string `json:"downloadUrl,omitempty"` - - - // ViewType - The type of view export job to be created - ViewType *string `json:"viewType,omitempty"` - - - // ExportErrorMessagesType - The error message in case the export request failed - ExportErrorMessagesType *string `json:"exportErrorMessagesType,omitempty"` - - - // Period - The Period of the request in which to break down the intervals. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H - Period *string `json:"period,omitempty"` - - - // Filter - Filters to apply to create the view - Filter *Viewfilter `json:"filter,omitempty"` - - - // Read - Indicates if the request has been marked as read - Read *bool `json:"read,omitempty"` - - - // CreatedDateTime - The created date/time of the request. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - CreatedDateTime *time.Time `json:"createdDateTime,omitempty"` - - - // ModifiedDateTime - The last modified date/time of the request. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ModifiedDateTime *time.Time `json:"modifiedDateTime,omitempty"` - - - // Locale - The locale use for localization of the exported data, i.e. en-us, es-mx - Locale *string `json:"locale,omitempty"` - - - // PercentageComplete - The percentage of the job that has completed processing - PercentageComplete *float64 `json:"percentageComplete,omitempty"` - - - // HasFormatDurations - Indicates if durations are formatted in hh:mm:ss format instead of ms - HasFormatDurations *bool `json:"hasFormatDurations,omitempty"` - - - // HasSplitFilters - Indicates if filters will be split in aggregate detail exports - HasSplitFilters *bool `json:"hasSplitFilters,omitempty"` - - - // ExcludeEmptyRows - Excludes empty rows from the exports - ExcludeEmptyRows *bool `json:"excludeEmptyRows,omitempty"` - - - // HasSplitByMedia - Indicates if media type will be split in aggregate detail exports - HasSplitByMedia *bool `json:"hasSplitByMedia,omitempty"` - - - // HasSummaryRow - Indicates if summary row needs to be present in exports - HasSummaryRow *bool `json:"hasSummaryRow,omitempty"` - - - // CsvDelimiter - The user supplied csv delimiter string value either of type 'comma' or 'semicolon' permitted for the export request - CsvDelimiter *string `json:"csvDelimiter,omitempty"` - - - // SelectedColumns - The list of ordered selected columns from the export view by the user - SelectedColumns *[]Selectedcolumns `json:"selectedColumns,omitempty"` - - - // HasCustomParticipantAttributes - Indicates if custom participant attributes will be exported - HasCustomParticipantAttributes *bool `json:"hasCustomParticipantAttributes,omitempty"` - - - // RecipientEmails - The list of email recipients for the exports - RecipientEmails *[]string `json:"recipientEmails,omitempty"` - - - // EmailStatuses - The status of individual email addresses as a map - EmailStatuses *map[string]string `json:"emailStatuses,omitempty"` - - - // EmailErrorDescription - The optional error message in case the export fail to email - EmailErrorDescription *string `json:"emailErrorDescription,omitempty"` - - - // Enabled - Enabled *bool `json:"enabled,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Reportingexportjobresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/reportingexportmetadatajoblisting.go b/build/platformclientv2/reportingexportmetadatajoblisting.go deleted file mode 100644 index 1bd14bb7f..000000000 --- a/build/platformclientv2/reportingexportmetadatajoblisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Reportingexportmetadatajoblisting -type Reportingexportmetadatajoblisting struct { - // Entities - Entities *[]Reportingexportmetadatajobresponse `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Reportingexportmetadatajoblisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/reportingexportmetadatajobresponse.go b/build/platformclientv2/reportingexportmetadatajobresponse.go deleted file mode 100644 index 8758aeea8..000000000 --- a/build/platformclientv2/reportingexportmetadatajobresponse.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Reportingexportmetadatajobresponse -type Reportingexportmetadatajobresponse struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // ViewType - The view type of the export metadata - ViewType *string `json:"viewType,omitempty"` - - - // DateLimitations - The date limitations of the export metadata - DateLimitations *string `json:"dateLimitations,omitempty"` - - - // RequiredFilters - The list of required filters for the export metadata - RequiredFilters *[]string `json:"requiredFilters,omitempty"` - - - // SupportedFilters - The list of supported filters for the export metadata - SupportedFilters *[]string `json:"supportedFilters,omitempty"` - - - // RequiredColumnIds - The list of required column ids for the export metadata - RequiredColumnIds *[]string `json:"requiredColumnIds,omitempty"` - - - // DependentColumnIds - The list of dependent column ids for the export metadata - DependentColumnIds *map[string][]string `json:"dependentColumnIds,omitempty"` - - - // AvailableColumnIds - The list of available column ids for the export metadata - AvailableColumnIds *[]string `json:"availableColumnIds,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Reportingexportmetadatajobresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/reportmetadata.go b/build/platformclientv2/reportmetadata.go deleted file mode 100644 index 25a8d08a3..000000000 --- a/build/platformclientv2/reportmetadata.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Reportmetadata -type Reportmetadata struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Title - Title *string `json:"title,omitempty"` - - - // Description - Description *string `json:"description,omitempty"` - - - // Keywords - Keywords *[]string `json:"keywords,omitempty"` - - - // AvailableLocales - AvailableLocales *[]string `json:"availableLocales,omitempty"` - - - // Parameters - Parameters *[]Parameter `json:"parameters,omitempty"` - - - // ExampleUrl - ExampleUrl *string `json:"exampleUrl,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Reportmetadata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/reportmetadataentitylisting.go b/build/platformclientv2/reportmetadataentitylisting.go deleted file mode 100644 index 3d2ad103a..000000000 --- a/build/platformclientv2/reportmetadataentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Reportmetadataentitylisting -type Reportmetadataentitylisting struct { - // Entities - Entities *[]Reportmetadata `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Reportmetadataentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/reportrunentry.go b/build/platformclientv2/reportrunentry.go deleted file mode 100644 index 24a38633d..000000000 --- a/build/platformclientv2/reportrunentry.go +++ /dev/null @@ -1,58 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Reportrunentry -type Reportrunentry struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // ReportId - ReportId *string `json:"reportId,omitempty"` - - - // RunTime - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - RunTime *time.Time `json:"runTime,omitempty"` - - - // RunStatus - RunStatus *string `json:"runStatus,omitempty"` - - - // ErrorMessage - ErrorMessage *string `json:"errorMessage,omitempty"` - - - // RunDurationMsec - RunDurationMsec *int `json:"runDurationMsec,omitempty"` - - - // ReportUrl - ReportUrl *string `json:"reportUrl,omitempty"` - - - // ReportFormat - ReportFormat *string `json:"reportFormat,omitempty"` - - - // ScheduleUri - ScheduleUri *string `json:"scheduleUri,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Reportrunentry) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/reportrunentryentitydomainlisting.go b/build/platformclientv2/reportrunentryentitydomainlisting.go deleted file mode 100644 index 3afbc090b..000000000 --- a/build/platformclientv2/reportrunentryentitydomainlisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Reportrunentryentitydomainlisting -type Reportrunentryentitydomainlisting struct { - // Entities - Entities *[]Reportrunentry `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Reportrunentryentitydomainlisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/reportschedule.go b/build/platformclientv2/reportschedule.go deleted file mode 100644 index d05e51394..000000000 --- a/build/platformclientv2/reportschedule.go +++ /dev/null @@ -1,82 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Reportschedule -type Reportschedule struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // QuartzCronExpression - Quartz Cron Expression - QuartzCronExpression *string `json:"quartzCronExpression,omitempty"` - - - // NextFireTime - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - NextFireTime *time.Time `json:"nextFireTime,omitempty"` - - - // DateCreated - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // Description - Description *string `json:"description,omitempty"` - - - // TimeZone - TimeZone *string `json:"timeZone,omitempty"` - - - // TimePeriod - TimePeriod *string `json:"timePeriod,omitempty"` - - - // Interval - Interval. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss - Interval *string `json:"interval,omitempty"` - - - // ReportFormat - ReportFormat *string `json:"reportFormat,omitempty"` - - - // Locale - Locale *string `json:"locale,omitempty"` - - - // Enabled - Enabled *bool `json:"enabled,omitempty"` - - - // ReportId - Report ID - ReportId *string `json:"reportId,omitempty"` - - - // Parameters - Parameters *map[string]interface{} `json:"parameters,omitempty"` - - - // LastRun - LastRun *Reportrunentry `json:"lastRun,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Reportschedule) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/reportscheduleentitylisting.go b/build/platformclientv2/reportscheduleentitylisting.go deleted file mode 100644 index 430b0d198..000000000 --- a/build/platformclientv2/reportscheduleentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Reportscheduleentitylisting -type Reportscheduleentitylisting struct { - // Entities - Entities *[]Reportschedule `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Reportscheduleentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/requestconfig.go b/build/platformclientv2/requestconfig.go deleted file mode 100644 index 461dd8ada..000000000 --- a/build/platformclientv2/requestconfig.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Requestconfig - Defines response components of the Action Request. -type Requestconfig struct { - // RequestUrlTemplate - URL that may include placeholders for requests to 3rd party service - RequestUrlTemplate *string `json:"requestUrlTemplate,omitempty"` - - - // RequestTemplate - Velocity template to define request body sent to 3rd party service. - RequestTemplate *string `json:"requestTemplate,omitempty"` - - - // RequestTemplateUri - URI to retrieve requestTemplate - RequestTemplateUri *string `json:"requestTemplateUri,omitempty"` - - - // RequestType - HTTP method to use for request - RequestType *string `json:"requestType,omitempty"` - - - // Headers - Headers to include in request in (Header Name, Value) pairs. - Headers *map[string]string `json:"headers,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Requestconfig) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/requestmapping.go b/build/platformclientv2/requestmapping.go deleted file mode 100644 index 662cb6275..000000000 --- a/build/platformclientv2/requestmapping.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Requestmapping -type Requestmapping struct { - // Name - Name of the Integration Action Attribute to supply the value for - Name *string `json:"name,omitempty"` - - - // AttributeType - Type of the value supplied - AttributeType *string `json:"attributeType,omitempty"` - - - // MappingType - Method of finding value to use with Attribute - MappingType *string `json:"mappingType,omitempty"` - - - // Value - Value to supply for the specified Attribute - Value *string `json:"value,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Requestmapping) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/reschedulingmanagementunitresponse.go b/build/platformclientv2/reschedulingmanagementunitresponse.go deleted file mode 100644 index 409e53c89..000000000 --- a/build/platformclientv2/reschedulingmanagementunitresponse.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Reschedulingmanagementunitresponse -type Reschedulingmanagementunitresponse struct { - // ManagementUnit - The management unit - ManagementUnit *Managementunitreference `json:"managementUnit,omitempty"` - - - // Applied - Whether the rescheduling run is applied for the given management unit - Applied *bool `json:"applied,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Reschedulingmanagementunitresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/reschedulingoptionsrunresponse.go b/build/platformclientv2/reschedulingoptionsrunresponse.go deleted file mode 100644 index 0609859dc..000000000 --- a/build/platformclientv2/reschedulingoptionsrunresponse.go +++ /dev/null @@ -1,54 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Reschedulingoptionsrunresponse -type Reschedulingoptionsrunresponse struct { - // ExistingSchedule - The existing schedule to which this reschedule run applies - ExistingSchedule *Buschedulereference `json:"existingSchedule,omitempty"` - - - // StartDate - The start date of the period to reschedule. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartDate *time.Time `json:"startDate,omitempty"` - - - // EndDate - The end date of the period to reschedule. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - EndDate *time.Time `json:"endDate,omitempty"` - - - // ManagementUnits - Per-management unit rescheduling options - ManagementUnits *[]Reschedulingmanagementunitresponse `json:"managementUnits,omitempty"` - - - // AgentCount - The number of agents to be considered in the reschedule - AgentCount *int `json:"agentCount,omitempty"` - - - // ActivityCodeIds - The IDs of the activity codes being considered for reschedule - ActivityCodeIds *[]string `json:"activityCodeIds,omitempty"` - - - // DoNotChangeWeeklyPaidTime - Whether weekly paid time is allowed to be changed - DoNotChangeWeeklyPaidTime *bool `json:"doNotChangeWeeklyPaidTime,omitempty"` - - - // DoNotChangeDailyPaidTime - Whether daily paid time is allowed to be changed - DoNotChangeDailyPaidTime *bool `json:"doNotChangeDailyPaidTime,omitempty"` - - - // DoNotChangeShiftStartTimes - Whether shift start times are allowed to be changed - DoNotChangeShiftStartTimes *bool `json:"doNotChangeShiftStartTimes,omitempty"` - - - // DoNotChangeManuallyEditedShifts - Whether manually edited shifts are allowed to be changed - DoNotChangeManuallyEditedShifts *bool `json:"doNotChangeManuallyEditedShifts,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Reschedulingoptionsrunresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/resolutiondetailqueryclause.go b/build/platformclientv2/resolutiondetailqueryclause.go deleted file mode 100644 index 4790b7ed2..000000000 --- a/build/platformclientv2/resolutiondetailqueryclause.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Resolutiondetailqueryclause -type Resolutiondetailqueryclause struct { - // VarType - Boolean operation to apply to the provided predicates - VarType *string `json:"type,omitempty"` - - - // Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value). - Predicates *[]Resolutiondetailquerypredicate `json:"predicates,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Resolutiondetailqueryclause) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/resolutiondetailqueryfilter.go b/build/platformclientv2/resolutiondetailqueryfilter.go deleted file mode 100644 index 9a02129a1..000000000 --- a/build/platformclientv2/resolutiondetailqueryfilter.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Resolutiondetailqueryfilter -type Resolutiondetailqueryfilter struct { - // VarType - Boolean operation to apply to the provided predicates and clauses - VarType *string `json:"type,omitempty"` - - - // Clauses - Boolean 'and/or' logic with up to two-levels of nesting - Clauses *[]Resolutiondetailqueryclause `json:"clauses,omitempty"` - - - // Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value). - Predicates *[]Resolutiondetailquerypredicate `json:"predicates,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Resolutiondetailqueryfilter) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/resolutiondetailquerypredicate.go b/build/platformclientv2/resolutiondetailquerypredicate.go deleted file mode 100644 index b50e8749c..000000000 --- a/build/platformclientv2/resolutiondetailquerypredicate.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Resolutiondetailquerypredicate -type Resolutiondetailquerypredicate struct { - // VarType - Optional type, can usually be inferred - VarType *string `json:"type,omitempty"` - - - // Metric - Left hand side for metric predicates - Metric *string `json:"metric,omitempty"` - - - // Operator - Optional operator, default is matches - Operator *string `json:"operator,omitempty"` - - - // Value - Right hand side for metric predicates - Value *string `json:"value,omitempty"` - - - // VarRange - Right hand side for metric predicates - VarRange *Numericrange `json:"range,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Resolutiondetailquerypredicate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/resourceconditionnode.go b/build/platformclientv2/resourceconditionnode.go deleted file mode 100644 index 079f8151f..000000000 --- a/build/platformclientv2/resourceconditionnode.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Resourceconditionnode -type Resourceconditionnode struct { - // VariableName - VariableName *string `json:"variableName,omitempty"` - - - // Conjunction - Conjunction *string `json:"conjunction,omitempty"` - - - // Operator - Operator *string `json:"operator,omitempty"` - - - // Operands - Operands *[]Resourceconditionvalue `json:"operands,omitempty"` - - - // Terms - Terms *[]Resourceconditionnode `json:"terms,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Resourceconditionnode) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/resourceconditionvalue.go b/build/platformclientv2/resourceconditionvalue.go deleted file mode 100644 index a9e3b862f..000000000 --- a/build/platformclientv2/resourceconditionvalue.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Resourceconditionvalue -type Resourceconditionvalue struct { - // VarType - VarType *string `json:"type,omitempty"` - - - // Value - Value *string `json:"value,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Resourceconditionvalue) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/resourcepermissionpolicy.go b/build/platformclientv2/resourcepermissionpolicy.go deleted file mode 100644 index 5be3ebc0f..000000000 --- a/build/platformclientv2/resourcepermissionpolicy.go +++ /dev/null @@ -1,57 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Resourcepermissionpolicy -type Resourcepermissionpolicy struct { - // Id - Id *string `json:"id,omitempty"` - - - // Domain - Domain *string `json:"domain,omitempty"` - - - // EntityName - EntityName *string `json:"entityName,omitempty"` - - - // PolicyName - PolicyName *string `json:"policyName,omitempty"` - - - // PolicyDescription - PolicyDescription *string `json:"policyDescription,omitempty"` - - - // ActionSetKey - ActionSetKey *string `json:"actionSetKey,omitempty"` - - - // AllowConditions - AllowConditions *bool `json:"allowConditions,omitempty"` - - - // ResourceConditionNode - ResourceConditionNode *Resourceconditionnode `json:"resourceConditionNode,omitempty"` - - - // NamedResources - NamedResources *[]string `json:"namedResources,omitempty"` - - - // ResourceCondition - ResourceCondition *string `json:"resourceCondition,omitempty"` - - - // ActionSet - ActionSet *[]string `json:"actionSet,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Resourcepermissionpolicy) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/response.go b/build/platformclientv2/response.go deleted file mode 100644 index d139f3abc..000000000 --- a/build/platformclientv2/response.go +++ /dev/null @@ -1,66 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Response - Contains information about a response. -type Response struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Version - Version number required for updates. - Version *int `json:"version,omitempty"` - - - // Libraries - One or more libraries response is associated with. - Libraries *[]Domainentityref `json:"libraries,omitempty"` - - - // Texts - One or more texts associated with the response. - Texts *[]Responsetext `json:"texts,omitempty"` - - - // CreatedBy - User that created the response - CreatedBy *User `json:"createdBy,omitempty"` - - - // DateCreated - The date and time the response was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // InteractionType - The interaction type for this response. - InteractionType *string `json:"interactionType,omitempty"` - - - // Substitutions - Details about any text substitutions used in the texts for this response. - Substitutions *[]Responsesubstitution `json:"substitutions,omitempty"` - - - // SubstitutionsSchema - Metadata about the text substitutions in json schema format. - SubstitutionsSchema *Jsonschemadocument `json:"substitutionsSchema,omitempty"` - - - // ResponseType - The response type represented by the response. - ResponseType *string `json:"responseType,omitempty"` - - - // MessagingTemplate - An optional messaging template definition for responseType.MessagingTemplate. - MessagingTemplate *Messagingtemplate `json:"messagingTemplate,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Response) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/responseconfig.go b/build/platformclientv2/responseconfig.go deleted file mode 100644 index 042164c54..000000000 --- a/build/platformclientv2/responseconfig.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Responseconfig - Defines response components of the Action Request. -type Responseconfig struct { - // TranslationMap - Map 'attribute name' and 'JSON path' pairs used to extract data from REST response. - TranslationMap *map[string]string `json:"translationMap,omitempty"` - - - // TranslationMapDefaults - Map 'attribute name' and 'default value' pairs used as fallback values if JSON path extraction fails for specified key. - TranslationMapDefaults *map[string]string `json:"translationMapDefaults,omitempty"` - - - // SuccessTemplate - Velocity template to build response to return from Action. - SuccessTemplate *string `json:"successTemplate,omitempty"` - - - // SuccessTemplateUri - URI to retrieve success template. - SuccessTemplateUri *string `json:"successTemplateUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Responseconfig) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/responseentitylist.go b/build/platformclientv2/responseentitylist.go deleted file mode 100644 index 7bf2d633d..000000000 --- a/build/platformclientv2/responseentitylist.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Responseentitylist - Query result list -type Responseentitylist struct { - // Entities - Entities *[]Response `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Responseentitylist) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/responseentitylisting.go b/build/platformclientv2/responseentitylisting.go deleted file mode 100644 index b73262a5a..000000000 --- a/build/platformclientv2/responseentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Responseentitylisting -type Responseentitylisting struct { - // Entities - Entities *[]Response `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Responseentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/responsefilter.go b/build/platformclientv2/responsefilter.go deleted file mode 100644 index a6091cb5a..000000000 --- a/build/platformclientv2/responsefilter.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Responsefilter - Used to filter response queries -type Responsefilter struct { - // Name - Field to filter on. Allowed values are 'name' and 'libraryId. - Name *string `json:"name,omitempty"` - - - // Operator - Filter operation: IN, EQUALS, NOTEQUALS. - Operator *string `json:"operator,omitempty"` - - - // Values - Values to filter on. - Values *[]string `json:"values,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Responsefilter) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/responsemanagementapi.go b/build/platformclientv2/responsemanagementapi.go deleted file mode 100644 index 35fc93f23..000000000 --- a/build/platformclientv2/responsemanagementapi.go +++ /dev/null @@ -1,930 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "encoding/json" -) - -// ResponseManagementApi provides functions for API endpoints -type ResponseManagementApi struct { - Configuration *Configuration -} - -// NewResponseManagementApi creates an API instance using the default configuration -func NewResponseManagementApi() *ResponseManagementApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating ResponseManagementApi with base path: %s", strings.ToLower(config.BasePath))) - return &ResponseManagementApi{ - Configuration: config, - } -} - -// NewResponseManagementApiWithConfig creates an API instance using the provided configuration -func NewResponseManagementApiWithConfig(config *Configuration) *ResponseManagementApi { - config.Debugf("Creating ResponseManagementApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &ResponseManagementApi{ - Configuration: config, - } -} - -// DeleteResponsemanagementLibrary invokes DELETE /api/v2/responsemanagement/libraries/{libraryId} -// -// Delete an existing response library. -// -// This will remove any responses associated with the library. -func (a ResponseManagementApi) DeleteResponsemanagementLibrary(libraryId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/responsemanagement/libraries/{libraryId}" - path = strings.Replace(path, "{libraryId}", fmt.Sprintf("%v", libraryId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'libraryId' is set - if &libraryId == nil { - // - return nil, errors.New("Missing required parameter 'libraryId' when calling ResponseManagementApi->DeleteResponsemanagementLibrary") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteResponsemanagementResponse invokes DELETE /api/v2/responsemanagement/responses/{responseId} -// -// Delete an existing response. -// -// This will remove the response from any libraries associated with it. -func (a ResponseManagementApi) DeleteResponsemanagementResponse(responseId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/responsemanagement/responses/{responseId}" - path = strings.Replace(path, "{responseId}", fmt.Sprintf("%v", responseId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'responseId' is set - if &responseId == nil { - // - return nil, errors.New("Missing required parameter 'responseId' when calling ResponseManagementApi->DeleteResponsemanagementResponse") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// GetResponsemanagementLibraries invokes GET /api/v2/responsemanagement/libraries -// -// Gets a list of existing response libraries. -// -// -func (a ResponseManagementApi) GetResponsemanagementLibraries(pageNumber int, pageSize int, messagingTemplateFilter string) (*Libraryentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/responsemanagement/libraries" - defaultReturn := new(Libraryentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(messagingTemplateFilter).(string); ok { - if str != "" { - queryParams["messagingTemplateFilter"] = a.Configuration.APIClient.ParameterToString(messagingTemplateFilter, collectionFormat) - } - } else { - queryParams["messagingTemplateFilter"] = a.Configuration.APIClient.ParameterToString(messagingTemplateFilter, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Libraryentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetResponsemanagementLibrary invokes GET /api/v2/responsemanagement/libraries/{libraryId} -// -// Get details about an existing response library. -// -// -func (a ResponseManagementApi) GetResponsemanagementLibrary(libraryId string) (*Library, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/responsemanagement/libraries/{libraryId}" - path = strings.Replace(path, "{libraryId}", fmt.Sprintf("%v", libraryId), -1) - defaultReturn := new(Library) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'libraryId' is set - if &libraryId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'libraryId' when calling ResponseManagementApi->GetResponsemanagementLibrary") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Library - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetResponsemanagementResponse invokes GET /api/v2/responsemanagement/responses/{responseId} -// -// Get details about an existing response. -// -// -func (a ResponseManagementApi) GetResponsemanagementResponse(responseId string, expand string) (*Response, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/responsemanagement/responses/{responseId}" - path = strings.Replace(path, "{responseId}", fmt.Sprintf("%v", responseId), -1) - defaultReturn := new(Response) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'responseId' is set - if &responseId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'responseId' when calling ResponseManagementApi->GetResponsemanagementResponse") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(expand).(string); ok { - if str != "" { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Response - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetResponsemanagementResponses invokes GET /api/v2/responsemanagement/responses -// -// Gets a list of existing responses. -// -// -func (a ResponseManagementApi) GetResponsemanagementResponses(libraryId string, pageNumber int, pageSize int, expand string) (*Responseentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/responsemanagement/responses" - defaultReturn := new(Responseentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'libraryId' is set - if &libraryId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'libraryId' when calling ResponseManagementApi->GetResponsemanagementResponses") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(libraryId).(string); ok { - if str != "" { - queryParams["libraryId"] = a.Configuration.APIClient.ParameterToString(libraryId, collectionFormat) - } - } else { - queryParams["libraryId"] = a.Configuration.APIClient.ParameterToString(libraryId, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(expand).(string); ok { - if str != "" { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Responseentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostResponsemanagementLibraries invokes POST /api/v2/responsemanagement/libraries -// -// Create a response library. -// -// -func (a ResponseManagementApi) PostResponsemanagementLibraries(body Library) (*Library, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/responsemanagement/libraries" - defaultReturn := new(Library) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ResponseManagementApi->PostResponsemanagementLibraries") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Library - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostResponsemanagementResponses invokes POST /api/v2/responsemanagement/responses -// -// Create a response. -// -// -func (a ResponseManagementApi) PostResponsemanagementResponses(body Response, expand string) (*Response, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/responsemanagement/responses" - defaultReturn := new(Response) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ResponseManagementApi->PostResponsemanagementResponses") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(expand).(string); ok { - if str != "" { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Response - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostResponsemanagementResponsesQuery invokes POST /api/v2/responsemanagement/responses/query -// -// Query responses -// -// -func (a ResponseManagementApi) PostResponsemanagementResponsesQuery(body Responsequeryrequest) (*Responsequeryresults, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/responsemanagement/responses/query" - defaultReturn := new(Responsequeryresults) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ResponseManagementApi->PostResponsemanagementResponsesQuery") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Responsequeryresults - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutResponsemanagementLibrary invokes PUT /api/v2/responsemanagement/libraries/{libraryId} -// -// Update an existing response library. -// -// Fields that can be updated: name. The most recent version is required for updates. -func (a ResponseManagementApi) PutResponsemanagementLibrary(libraryId string, body Library) (*Library, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/responsemanagement/libraries/{libraryId}" - path = strings.Replace(path, "{libraryId}", fmt.Sprintf("%v", libraryId), -1) - defaultReturn := new(Library) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'libraryId' is set - if &libraryId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'libraryId' when calling ResponseManagementApi->PutResponsemanagementLibrary") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ResponseManagementApi->PutResponsemanagementLibrary") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Library - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutResponsemanagementResponse invokes PUT /api/v2/responsemanagement/responses/{responseId} -// -// Update an existing response. -// -// Fields that can be updated: name, libraries, and texts. The most recent version is required for updates. -func (a ResponseManagementApi) PutResponsemanagementResponse(responseId string, body Response, expand string) (*Response, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/responsemanagement/responses/{responseId}" - path = strings.Replace(path, "{responseId}", fmt.Sprintf("%v", responseId), -1) - defaultReturn := new(Response) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'responseId' is set - if &responseId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'responseId' when calling ResponseManagementApi->PutResponsemanagementResponse") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling ResponseManagementApi->PutResponsemanagementResponse") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(expand).(string); ok { - if str != "" { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Response - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/responsequeryrequest.go b/build/platformclientv2/responsequeryrequest.go deleted file mode 100644 index 417e42bde..000000000 --- a/build/platformclientv2/responsequeryrequest.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Responsequeryrequest - Used to query for responses -type Responsequeryrequest struct { - // QueryPhrase - Query phrase to search response text and name. If not set will match all. - QueryPhrase *string `json:"queryPhrase,omitempty"` - - - // PageSize - The maximum number of hits to return. Default: 25, Maximum: 500. - PageSize *int `json:"pageSize,omitempty"` - - - // Filters - Filter the query results. - Filters *[]Responsefilter `json:"filters,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Responsequeryrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/responsequeryresults.go b/build/platformclientv2/responsequeryresults.go deleted file mode 100644 index e4a8753d5..000000000 --- a/build/platformclientv2/responsequeryresults.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Responsequeryresults - Used to return response query results -type Responsequeryresults struct { - // Results - Contains the query results - Results *Responseentitylist `json:"results,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Responsequeryresults) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/responseset.go b/build/platformclientv2/responseset.go deleted file mode 100644 index 7474c0d6a..000000000 --- a/build/platformclientv2/responseset.go +++ /dev/null @@ -1,42 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Responseset -type Responseset struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the ResponseSet. - Name *string `json:"name,omitempty"` - - - // DateCreated - Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // Version - Required for updates, must match the version number of the most recent update - Version *int `json:"version,omitempty"` - - - // Responses - Map of disposition identifiers to reactions. For example: {\"disposition.classification.callable.person\": {\"reactionType\": \"transfer\"}}. - Responses *map[string]Reaction `json:"responses,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Responseset) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/responsesetentitylisting.go b/build/platformclientv2/responsesetentitylisting.go deleted file mode 100644 index 4ac40e44f..000000000 --- a/build/platformclientv2/responsesetentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Responsesetentitylisting -type Responsesetentitylisting struct { - // Entities - Entities *[]Responseset `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Responsesetentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/responsesubstitution.go b/build/platformclientv2/responsesubstitution.go deleted file mode 100644 index e5ba8431e..000000000 --- a/build/platformclientv2/responsesubstitution.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Responsesubstitution - Contains information about the substitutions associated with a response. -type Responsesubstitution struct { - // Id - Response substitution identifier. - Id *string `json:"id,omitempty"` - - - // Description - Response substitution description. - Description *string `json:"description,omitempty"` - - - // DefaultValue - Response substitution default value. - DefaultValue *string `json:"defaultValue,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Responsesubstitution) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/responsetext.go b/build/platformclientv2/responsetext.go deleted file mode 100644 index 64fd1801c..000000000 --- a/build/platformclientv2/responsetext.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Responsetext - Contains information about the text associated with a response. -type Responsetext struct { - // Content - Response text content. - Content *string `json:"content,omitempty"` - - - // ContentType - Response text content type. - ContentType *string `json:"contentType,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Responsetext) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/resterrordetail.go b/build/platformclientv2/resterrordetail.go deleted file mode 100644 index 8aac6578e..000000000 --- a/build/platformclientv2/resterrordetail.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Resterrordetail -type Resterrordetail struct { - // VarError - name of the error - VarError *string `json:"error,omitempty"` - - - // Details - additional information regarding the error - Details *string `json:"details,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Resterrordetail) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/retentionduration.go b/build/platformclientv2/retentionduration.go deleted file mode 100644 index 871cad382..000000000 --- a/build/platformclientv2/retentionduration.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Retentionduration -type Retentionduration struct { - // ArchiveRetention - ArchiveRetention *Archiveretention `json:"archiveRetention,omitempty"` - - - // DeleteRetention - DeleteRetention *Deleteretention `json:"deleteRetention,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Retentionduration) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/reversewhitepageslookupresult.go b/build/platformclientv2/reversewhitepageslookupresult.go deleted file mode 100644 index 2b7b09690..000000000 --- a/build/platformclientv2/reversewhitepageslookupresult.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Reversewhitepageslookupresult -type Reversewhitepageslookupresult struct { - // Contacts - Contacts *[]Externalcontact `json:"contacts,omitempty"` - - - // ExternalOrganizations - ExternalOrganizations *[]Externalorganization `json:"externalOrganizations,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Reversewhitepageslookupresult) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/ring.go b/build/platformclientv2/ring.go deleted file mode 100644 index 840149481..000000000 --- a/build/platformclientv2/ring.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Ring -type Ring struct { - // ExpansionCriteria - ExpansionCriteria *[]Expansioncriterium `json:"expansionCriteria,omitempty"` - - - // Actions - Actions *Actions `json:"actions,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Ring) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/roledivision.go b/build/platformclientv2/roledivision.go deleted file mode 100644 index 7000408c4..000000000 --- a/build/platformclientv2/roledivision.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Roledivision -type Roledivision struct { - // RoleId - Role to be associated with the given division which forms a grant - RoleId *string `json:"roleId,omitempty"` - - - // DivisionId - Division associated with the given role which forms a grant - DivisionId *string `json:"divisionId,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Roledivision) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/roledivisiongrants.go b/build/platformclientv2/roledivisiongrants.go deleted file mode 100644 index cd71e5d86..000000000 --- a/build/platformclientv2/roledivisiongrants.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Roledivisiongrants -type Roledivisiongrants struct { - // Grants - A list containing pairs of role and division IDs - Grants *[]Roledivisionpair `json:"grants,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Roledivisiongrants) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/roledivisionpair.go b/build/platformclientv2/roledivisionpair.go deleted file mode 100644 index b59159ed4..000000000 --- a/build/platformclientv2/roledivisionpair.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Roledivisionpair -type Roledivisionpair struct { - // RoleId - The ID of the role - RoleId *string `json:"roleId,omitempty"` - - - // DivisionId - The ID of the division - DivisionId *string `json:"divisionId,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Roledivisionpair) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/routepathrequest.go b/build/platformclientv2/routepathrequest.go deleted file mode 100644 index ad87cb077..000000000 --- a/build/platformclientv2/routepathrequest.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Routepathrequest - Route path configuration -type Routepathrequest struct { - // QueueId - The ID of the queue to associate with the route path - QueueId *string `json:"queueId,omitempty"` - - - // MediaType - The media type of the given queue to associate with the route path - MediaType *string `json:"mediaType,omitempty"` - - - // LanguageId - The ID of the language to associate with the route path - LanguageId *string `json:"languageId,omitempty"` - - - // SkillIds - The set of skill IDs to associate with the route path - SkillIds *[]string `json:"skillIds,omitempty"` - - - // SourcePlanningGroup - The planning group from which to copy route paths - SourcePlanningGroup *Sourceplanninggrouprequest `json:"sourcePlanningGroup,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Routepathrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/routepathresponse.go b/build/platformclientv2/routepathresponse.go deleted file mode 100644 index c52f7a6f2..000000000 --- a/build/platformclientv2/routepathresponse.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Routepathresponse - Route path configuration -type Routepathresponse struct { - // Queue - The ID of the queue associated with the route path - Queue *Queuereference `json:"queue,omitempty"` - - - // MediaType - The media type of the given queue associated with the route path - MediaType *string `json:"mediaType,omitempty"` - - - // Language - The ID of the language associated with the route path - Language *Languagereference `json:"language,omitempty"` - - - // Skills - The set of skills associated with the route path - Skills *[]Routingskillreference `json:"skills,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Routepathresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/routingapi.go b/build/platformclientv2/routingapi.go deleted file mode 100644 index e948ade51..000000000 --- a/build/platformclientv2/routingapi.go +++ /dev/null @@ -1,7449 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "encoding/json" -) - -// RoutingApi provides functions for API endpoints -type RoutingApi struct { - Configuration *Configuration -} - -// NewRoutingApi creates an API instance using the default configuration -func NewRoutingApi() *RoutingApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating RoutingApi with base path: %s", strings.ToLower(config.BasePath))) - return &RoutingApi{ - Configuration: config, - } -} - -// NewRoutingApiWithConfig creates an API instance using the provided configuration -func NewRoutingApiWithConfig(config *Configuration) *RoutingApi { - config.Debugf("Creating RoutingApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &RoutingApi{ - Configuration: config, - } -} - -// DeleteRoutingEmailDomain invokes DELETE /api/v2/routing/email/domains/{domainId} -// -// Delete a domain -// -// -func (a RoutingApi) DeleteRoutingEmailDomain(domainId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/email/domains/{domainId}" - path = strings.Replace(path, "{domainId}", fmt.Sprintf("%v", domainId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'domainId' is set - if &domainId == nil { - // - return nil, errors.New("Missing required parameter 'domainId' when calling RoutingApi->DeleteRoutingEmailDomain") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteRoutingEmailDomainRoute invokes DELETE /api/v2/routing/email/domains/{domainName}/routes/{routeId} -// -// Delete a route -// -// -func (a RoutingApi) DeleteRoutingEmailDomainRoute(domainName string, routeId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/email/domains/{domainName}/routes/{routeId}" - path = strings.Replace(path, "{domainName}", fmt.Sprintf("%v", domainName), -1) - path = strings.Replace(path, "{routeId}", fmt.Sprintf("%v", routeId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'domainName' is set - if &domainName == nil { - // - return nil, errors.New("Missing required parameter 'domainName' when calling RoutingApi->DeleteRoutingEmailDomainRoute") - } - // verify the required parameter 'routeId' is set - if &routeId == nil { - // - return nil, errors.New("Missing required parameter 'routeId' when calling RoutingApi->DeleteRoutingEmailDomainRoute") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteRoutingQueue invokes DELETE /api/v2/routing/queues/{queueId} -// -// Delete a queue -// -// -func (a RoutingApi) DeleteRoutingQueue(queueId string, forceDelete bool) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/queues/{queueId}" - path = strings.Replace(path, "{queueId}", fmt.Sprintf("%v", queueId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'queueId' is set - if &queueId == nil { - // - return nil, errors.New("Missing required parameter 'queueId' when calling RoutingApi->DeleteRoutingQueue") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(forceDelete).(string); ok { - if str != "" { - queryParams["forceDelete"] = a.Configuration.APIClient.ParameterToString(forceDelete, collectionFormat) - } - } else { - queryParams["forceDelete"] = a.Configuration.APIClient.ParameterToString(forceDelete, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteRoutingQueueMember invokes DELETE /api/v2/routing/queues/{queueId}/members/{memberId} -// -// Delete a queue member. -// -// -func (a RoutingApi) DeleteRoutingQueueMember(queueId string, memberId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/queues/{queueId}/members/{memberId}" - path = strings.Replace(path, "{queueId}", fmt.Sprintf("%v", queueId), -1) - path = strings.Replace(path, "{memberId}", fmt.Sprintf("%v", memberId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'queueId' is set - if &queueId == nil { - // - return nil, errors.New("Missing required parameter 'queueId' when calling RoutingApi->DeleteRoutingQueueMember") - } - // verify the required parameter 'memberId' is set - if &memberId == nil { - // - return nil, errors.New("Missing required parameter 'memberId' when calling RoutingApi->DeleteRoutingQueueMember") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteRoutingQueueUser invokes DELETE /api/v2/routing/queues/{queueId}/users/{memberId} -// -// DEPRECATED: use DELETE /routing/queues/{queueId}/members/{memberId}. Delete queue member. -// -// -func (a RoutingApi) DeleteRoutingQueueUser(queueId string, memberId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/queues/{queueId}/users/{memberId}" - path = strings.Replace(path, "{queueId}", fmt.Sprintf("%v", queueId), -1) - path = strings.Replace(path, "{memberId}", fmt.Sprintf("%v", memberId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'queueId' is set - if &queueId == nil { - // - return nil, errors.New("Missing required parameter 'queueId' when calling RoutingApi->DeleteRoutingQueueUser") - } - // verify the required parameter 'memberId' is set - if &memberId == nil { - // - return nil, errors.New("Missing required parameter 'memberId' when calling RoutingApi->DeleteRoutingQueueUser") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteRoutingQueueWrapupcode invokes DELETE /api/v2/routing/queues/{queueId}/wrapupcodes/{codeId} -// -// Delete a wrap-up code from a queue -// -// -func (a RoutingApi) DeleteRoutingQueueWrapupcode(queueId string, codeId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/queues/{queueId}/wrapupcodes/{codeId}" - path = strings.Replace(path, "{queueId}", fmt.Sprintf("%v", queueId), -1) - path = strings.Replace(path, "{codeId}", fmt.Sprintf("%v", codeId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'queueId' is set - if &queueId == nil { - // - return nil, errors.New("Missing required parameter 'queueId' when calling RoutingApi->DeleteRoutingQueueWrapupcode") - } - // verify the required parameter 'codeId' is set - if &codeId == nil { - // - return nil, errors.New("Missing required parameter 'codeId' when calling RoutingApi->DeleteRoutingQueueWrapupcode") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteRoutingSettings invokes DELETE /api/v2/routing/settings -// -// Delete an organization's routing settings -// -// -func (a RoutingApi) DeleteRoutingSettings() (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/settings" - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteRoutingSkill invokes DELETE /api/v2/routing/skills/{skillId} -// -// Delete Routing Skill -// -// -func (a RoutingApi) DeleteRoutingSkill(skillId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/skills/{skillId}" - path = strings.Replace(path, "{skillId}", fmt.Sprintf("%v", skillId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'skillId' is set - if &skillId == nil { - // - return nil, errors.New("Missing required parameter 'skillId' when calling RoutingApi->DeleteRoutingSkill") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteRoutingSmsAddress invokes DELETE /api/v2/routing/sms/addresses/{addressId} -// -// Delete an Address by Id for SMS -// -// -func (a RoutingApi) DeleteRoutingSmsAddress(addressId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/sms/addresses/{addressId}" - path = strings.Replace(path, "{addressId}", fmt.Sprintf("%v", addressId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'addressId' is set - if &addressId == nil { - // - return nil, errors.New("Missing required parameter 'addressId' when calling RoutingApi->DeleteRoutingSmsAddress") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteRoutingSmsPhonenumber invokes DELETE /api/v2/routing/sms/phonenumbers/{addressId} -// -// Delete a phone number provisioned for SMS. -// -// -func (a RoutingApi) DeleteRoutingSmsPhonenumber(addressId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/sms/phonenumbers/{addressId}" - path = strings.Replace(path, "{addressId}", fmt.Sprintf("%v", addressId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'addressId' is set - if &addressId == nil { - // - return nil, errors.New("Missing required parameter 'addressId' when calling RoutingApi->DeleteRoutingSmsPhonenumber") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteRoutingUserUtilization invokes DELETE /api/v2/routing/users/{userId}/utilization -// -// Delete the user's max utilization settings and revert to the organization-wide default. -// -// -func (a RoutingApi) DeleteRoutingUserUtilization(userId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/users/{userId}/utilization" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return nil, errors.New("Missing required parameter 'userId' when calling RoutingApi->DeleteRoutingUserUtilization") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteRoutingUtilization invokes DELETE /api/v2/routing/utilization -// -// Delete the organization-wide max utilization settings and revert to the system default. -// -// -func (a RoutingApi) DeleteRoutingUtilization() (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/utilization" - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteRoutingWrapupcode invokes DELETE /api/v2/routing/wrapupcodes/{codeId} -// -// Delete wrap-up code -// -// -func (a RoutingApi) DeleteRoutingWrapupcode(codeId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/wrapupcodes/{codeId}" - path = strings.Replace(path, "{codeId}", fmt.Sprintf("%v", codeId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'codeId' is set - if &codeId == nil { - // - return nil, errors.New("Missing required parameter 'codeId' when calling RoutingApi->DeleteRoutingWrapupcode") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteUserRoutinglanguage invokes DELETE /api/v2/users/{userId}/routinglanguages/{languageId} -// -// Remove routing language from user -// -// -func (a RoutingApi) DeleteUserRoutinglanguage(userId string, languageId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/routinglanguages/{languageId}" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - path = strings.Replace(path, "{languageId}", fmt.Sprintf("%v", languageId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return nil, errors.New("Missing required parameter 'userId' when calling RoutingApi->DeleteUserRoutinglanguage") - } - // verify the required parameter 'languageId' is set - if &languageId == nil { - // - return nil, errors.New("Missing required parameter 'languageId' when calling RoutingApi->DeleteUserRoutinglanguage") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteUserRoutingskill invokes DELETE /api/v2/users/{userId}/routingskills/{skillId} -// -// Remove routing skill from user -// -// -func (a RoutingApi) DeleteUserRoutingskill(userId string, skillId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/routingskills/{skillId}" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - path = strings.Replace(path, "{skillId}", fmt.Sprintf("%v", skillId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return nil, errors.New("Missing required parameter 'userId' when calling RoutingApi->DeleteUserRoutingskill") - } - // verify the required parameter 'skillId' is set - if &skillId == nil { - // - return nil, errors.New("Missing required parameter 'skillId' when calling RoutingApi->DeleteUserRoutingskill") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// GetRoutingEmailDomain invokes GET /api/v2/routing/email/domains/{domainId} -// -// Get domain -// -// -func (a RoutingApi) GetRoutingEmailDomain(domainId string) (*Inbounddomain, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/email/domains/{domainId}" - path = strings.Replace(path, "{domainId}", fmt.Sprintf("%v", domainId), -1) - defaultReturn := new(Inbounddomain) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'domainId' is set - if &domainId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'domainId' when calling RoutingApi->GetRoutingEmailDomain") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Inbounddomain - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetRoutingEmailDomainRoute invokes GET /api/v2/routing/email/domains/{domainName}/routes/{routeId} -// -// Get a route -// -// -func (a RoutingApi) GetRoutingEmailDomainRoute(domainName string, routeId string) (*Inboundroute, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/email/domains/{domainName}/routes/{routeId}" - path = strings.Replace(path, "{domainName}", fmt.Sprintf("%v", domainName), -1) - path = strings.Replace(path, "{routeId}", fmt.Sprintf("%v", routeId), -1) - defaultReturn := new(Inboundroute) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'domainName' is set - if &domainName == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'domainName' when calling RoutingApi->GetRoutingEmailDomainRoute") - } - // verify the required parameter 'routeId' is set - if &routeId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'routeId' when calling RoutingApi->GetRoutingEmailDomainRoute") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Inboundroute - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetRoutingEmailDomainRoutes invokes GET /api/v2/routing/email/domains/{domainName}/routes -// -// Get routes -// -// -func (a RoutingApi) GetRoutingEmailDomainRoutes(domainName string, pageSize int, pageNumber int, pattern string) (*Inboundrouteentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/email/domains/{domainName}/routes" - path = strings.Replace(path, "{domainName}", fmt.Sprintf("%v", domainName), -1) - defaultReturn := new(Inboundrouteentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'domainName' is set - if &domainName == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'domainName' when calling RoutingApi->GetRoutingEmailDomainRoutes") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pattern).(string); ok { - if str != "" { - queryParams["pattern"] = a.Configuration.APIClient.ParameterToString(pattern, collectionFormat) - } - } else { - queryParams["pattern"] = a.Configuration.APIClient.ParameterToString(pattern, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Inboundrouteentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetRoutingEmailDomains invokes GET /api/v2/routing/email/domains -// -// Get domains -// -// -func (a RoutingApi) GetRoutingEmailDomains() (*Inbounddomainentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/email/domains" - defaultReturn := new(Inbounddomainentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Inbounddomainentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetRoutingEmailSetup invokes GET /api/v2/routing/email/setup -// -// Get email setup -// -// -func (a RoutingApi) GetRoutingEmailSetup() (*Emailsetup, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/email/setup" - defaultReturn := new(Emailsetup) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Emailsetup - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetRoutingLanguages invokes GET /api/v2/routing/languages -// -// Get the list of supported languages. -// -// -func (a RoutingApi) GetRoutingLanguages(pageSize int, pageNumber int, sortOrder string, name string, id []string) (*Languageentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/languages" - defaultReturn := new(Languageentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range id { - queryParams["id"] = value - } - } else { - queryParams["id"] = a.Configuration.APIClient.ParameterToString(id, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Languageentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetRoutingMessageRecipient invokes GET /api/v2/routing/message/recipients/{recipientId} -// -// Get a recipient -// -// -func (a RoutingApi) GetRoutingMessageRecipient(recipientId string) (*Recipient, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/message/recipients/{recipientId}" - path = strings.Replace(path, "{recipientId}", fmt.Sprintf("%v", recipientId), -1) - defaultReturn := new(Recipient) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'recipientId' is set - if &recipientId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'recipientId' when calling RoutingApi->GetRoutingMessageRecipient") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Recipient - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetRoutingMessageRecipients invokes GET /api/v2/routing/message/recipients -// -// Get recipients -// -// -func (a RoutingApi) GetRoutingMessageRecipients(messengerType string, pageSize int, pageNumber int) (*Recipientlisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/message/recipients" - defaultReturn := new(Recipientlisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(messengerType).(string); ok { - if str != "" { - queryParams["messengerType"] = a.Configuration.APIClient.ParameterToString(messengerType, collectionFormat) - } - } else { - queryParams["messengerType"] = a.Configuration.APIClient.ParameterToString(messengerType, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Recipientlisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetRoutingQueue invokes GET /api/v2/routing/queues/{queueId} -// -// Get details about this queue. -// -// -func (a RoutingApi) GetRoutingQueue(queueId string) (*Queue, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/queues/{queueId}" - path = strings.Replace(path, "{queueId}", fmt.Sprintf("%v", queueId), -1) - defaultReturn := new(Queue) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'queueId' is set - if &queueId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'queueId' when calling RoutingApi->GetRoutingQueue") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Queue - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetRoutingQueueEstimatedwaittime invokes GET /api/v2/routing/queues/{queueId}/estimatedwaittime -// -// Get Estimated Wait Time -// -// -func (a RoutingApi) GetRoutingQueueEstimatedwaittime(queueId string, conversationId string) (*Estimatedwaittimepredictions, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/queues/{queueId}/estimatedwaittime" - path = strings.Replace(path, "{queueId}", fmt.Sprintf("%v", queueId), -1) - defaultReturn := new(Estimatedwaittimepredictions) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'queueId' is set - if &queueId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'queueId' when calling RoutingApi->GetRoutingQueueEstimatedwaittime") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(conversationId).(string); ok { - if str != "" { - queryParams["conversationId"] = a.Configuration.APIClient.ParameterToString(conversationId, collectionFormat) - } - } else { - queryParams["conversationId"] = a.Configuration.APIClient.ParameterToString(conversationId, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Estimatedwaittimepredictions - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetRoutingQueueMediatypeEstimatedwaittime invokes GET /api/v2/routing/queues/{queueId}/mediatypes/{mediaType}/estimatedwaittime -// -// Get Estimated Wait Time -// -// -func (a RoutingApi) GetRoutingQueueMediatypeEstimatedwaittime(queueId string, mediaType string) (*Estimatedwaittimepredictions, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/queues/{queueId}/mediatypes/{mediaType}/estimatedwaittime" - path = strings.Replace(path, "{queueId}", fmt.Sprintf("%v", queueId), -1) - path = strings.Replace(path, "{mediaType}", fmt.Sprintf("%v", mediaType), -1) - defaultReturn := new(Estimatedwaittimepredictions) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'queueId' is set - if &queueId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'queueId' when calling RoutingApi->GetRoutingQueueMediatypeEstimatedwaittime") - } - // verify the required parameter 'mediaType' is set - if &mediaType == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'mediaType' when calling RoutingApi->GetRoutingQueueMediatypeEstimatedwaittime") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Estimatedwaittimepredictions - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetRoutingQueueMembers invokes GET /api/v2/routing/queues/{queueId}/members -// -// Get the members of this queue. -// -// -func (a RoutingApi) GetRoutingQueueMembers(queueId string, pageSize int, pageNumber int, sortBy string, expand []string, joined bool, name string, profileSkills []string, skills []string, languages []string, routingStatus []string, presence []string) (*Queuememberentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/queues/{queueId}/members" - path = strings.Replace(path, "{queueId}", fmt.Sprintf("%v", queueId), -1) - defaultReturn := new(Queuememberentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'queueId' is set - if &queueId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'queueId' when calling RoutingApi->GetRoutingQueueMembers") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(joined).(string); ok { - if str != "" { - queryParams["joined"] = a.Configuration.APIClient.ParameterToString(joined, collectionFormat) - } - } else { - queryParams["joined"] = a.Configuration.APIClient.ParameterToString(joined, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range profileSkills { - queryParams["profileSkills"] = value - } - } else { - queryParams["profileSkills"] = a.Configuration.APIClient.ParameterToString(profileSkills, collectionFormat) - } - - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range skills { - queryParams["skills"] = value - } - } else { - queryParams["skills"] = a.Configuration.APIClient.ParameterToString(skills, collectionFormat) - } - - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range languages { - queryParams["languages"] = value - } - } else { - queryParams["languages"] = a.Configuration.APIClient.ParameterToString(languages, collectionFormat) - } - - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range routingStatus { - queryParams["routingStatus"] = value - } - } else { - queryParams["routingStatus"] = a.Configuration.APIClient.ParameterToString(routingStatus, collectionFormat) - } - - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range presence { - queryParams["presence"] = value - } - } else { - queryParams["presence"] = a.Configuration.APIClient.ParameterToString(presence, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Queuememberentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetRoutingQueueUsers invokes GET /api/v2/routing/queues/{queueId}/users -// -// DEPRECATED: use GET /routing/queues/{queueId}/members. Get the members of this queue. -// -// -func (a RoutingApi) GetRoutingQueueUsers(queueId string, pageSize int, pageNumber int, sortBy string, expand []string, joined bool, name string, profileSkills []string, skills []string, languages []string, routingStatus []string, presence []string) (*Queuememberentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/queues/{queueId}/users" - path = strings.Replace(path, "{queueId}", fmt.Sprintf("%v", queueId), -1) - defaultReturn := new(Queuememberentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'queueId' is set - if &queueId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'queueId' when calling RoutingApi->GetRoutingQueueUsers") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(joined).(string); ok { - if str != "" { - queryParams["joined"] = a.Configuration.APIClient.ParameterToString(joined, collectionFormat) - } - } else { - queryParams["joined"] = a.Configuration.APIClient.ParameterToString(joined, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range profileSkills { - queryParams["profileSkills"] = value - } - } else { - queryParams["profileSkills"] = a.Configuration.APIClient.ParameterToString(profileSkills, collectionFormat) - } - - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range skills { - queryParams["skills"] = value - } - } else { - queryParams["skills"] = a.Configuration.APIClient.ParameterToString(skills, collectionFormat) - } - - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range languages { - queryParams["languages"] = value - } - } else { - queryParams["languages"] = a.Configuration.APIClient.ParameterToString(languages, collectionFormat) - } - - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range routingStatus { - queryParams["routingStatus"] = value - } - } else { - queryParams["routingStatus"] = a.Configuration.APIClient.ParameterToString(routingStatus, collectionFormat) - } - - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range presence { - queryParams["presence"] = value - } - } else { - queryParams["presence"] = a.Configuration.APIClient.ParameterToString(presence, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Queuememberentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetRoutingQueueWrapupcodes invokes GET /api/v2/routing/queues/{queueId}/wrapupcodes -// -// Get the wrap-up codes for a queue -// -// -func (a RoutingApi) GetRoutingQueueWrapupcodes(queueId string, pageSize int, pageNumber int) (*Wrapupcodeentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/queues/{queueId}/wrapupcodes" - path = strings.Replace(path, "{queueId}", fmt.Sprintf("%v", queueId), -1) - defaultReturn := new(Wrapupcodeentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'queueId' is set - if &queueId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'queueId' when calling RoutingApi->GetRoutingQueueWrapupcodes") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Wrapupcodeentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetRoutingQueues invokes GET /api/v2/routing/queues -// -// Get list of queues. -// -// -func (a RoutingApi) GetRoutingQueues(pageSize int, pageNumber int, sortBy string, name string, id []string, divisionId []string) (*Queueentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/queues" - defaultReturn := new(Queueentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range id { - queryParams["id"] = value - } - } else { - queryParams["id"] = a.Configuration.APIClient.ParameterToString(id, collectionFormat) - } - - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range divisionId { - queryParams["divisionId"] = value - } - } else { - queryParams["divisionId"] = a.Configuration.APIClient.ParameterToString(divisionId, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Queueentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetRoutingQueuesDivisionviews invokes GET /api/v2/routing/queues/divisionviews -// -// Get a paged listing of simplified queue objects, filterable by name, queue ID(s), or division ID(s). -// -// -func (a RoutingApi) GetRoutingQueuesDivisionviews(pageSize int, pageNumber int, sortBy string, sortOrder string, name string, id []string, divisionId []string) (*Queueentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/queues/divisionviews" - defaultReturn := new(Queueentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range id { - queryParams["id"] = value - } - } else { - queryParams["id"] = a.Configuration.APIClient.ParameterToString(id, collectionFormat) - } - - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range divisionId { - queryParams["divisionId"] = value - } - } else { - queryParams["divisionId"] = a.Configuration.APIClient.ParameterToString(divisionId, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Queueentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetRoutingQueuesDivisionviewsAll invokes GET /api/v2/routing/queues/divisionviews/all -// -// Get a paged listing of simplified queue objects. Can be used to get a digest of all queues in an organization. -// -// -func (a RoutingApi) GetRoutingQueuesDivisionviewsAll(pageSize int, pageNumber int, sortBy string, sortOrder string) (*Queueentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/queues/divisionviews/all" - defaultReturn := new(Queueentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Queueentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetRoutingQueuesMe invokes GET /api/v2/routing/queues/me -// -// Get a paged listing of queues the user is a member of. -// -// -func (a RoutingApi) GetRoutingQueuesMe(joined bool, pageSize int, pageNumber int, sortBy string, sortOrder string) (*Userqueueentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/queues/me" - defaultReturn := new(Userqueueentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(joined).(string); ok { - if str != "" { - queryParams["joined"] = a.Configuration.APIClient.ParameterToString(joined, collectionFormat) - } - } else { - queryParams["joined"] = a.Configuration.APIClient.ParameterToString(joined, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Userqueueentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetRoutingSettings invokes GET /api/v2/routing/settings -// -// Get an organization's routing settings -// -// -func (a RoutingApi) GetRoutingSettings() (*Routingsettings, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/settings" - defaultReturn := new(Routingsettings) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Routingsettings - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetRoutingSettingsContactcenter invokes GET /api/v2/routing/settings/contactcenter -// -// Get Contact Center Settings -// -// -func (a RoutingApi) GetRoutingSettingsContactcenter() (*Contactcentersettings, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/settings/contactcenter" - defaultReturn := new(Contactcentersettings) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Contactcentersettings - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetRoutingSettingsTranscription invokes GET /api/v2/routing/settings/transcription -// -// Get Transcription Settings -// -// -func (a RoutingApi) GetRoutingSettingsTranscription() (*Transcriptionsettings, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/settings/transcription" - defaultReturn := new(Transcriptionsettings) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Transcriptionsettings - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetRoutingSkill invokes GET /api/v2/routing/skills/{skillId} -// -// Get Routing Skill -// -// -func (a RoutingApi) GetRoutingSkill(skillId string) (*Routingskill, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/skills/{skillId}" - path = strings.Replace(path, "{skillId}", fmt.Sprintf("%v", skillId), -1) - defaultReturn := new(Routingskill) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'skillId' is set - if &skillId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'skillId' when calling RoutingApi->GetRoutingSkill") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Routingskill - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetRoutingSkills invokes GET /api/v2/routing/skills -// -// Get the list of routing skills. -// -// -func (a RoutingApi) GetRoutingSkills(pageSize int, pageNumber int, name string, id []string) (*Skillentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/skills" - defaultReturn := new(Skillentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range id { - queryParams["id"] = value - } - } else { - queryParams["id"] = a.Configuration.APIClient.ParameterToString(id, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Skillentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetRoutingSmsAddress invokes GET /api/v2/routing/sms/addresses/{addressId} -// -// Get an Address by Id for SMS -// -// -func (a RoutingApi) GetRoutingSmsAddress(addressId string) (*Smsaddress, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/sms/addresses/{addressId}" - path = strings.Replace(path, "{addressId}", fmt.Sprintf("%v", addressId), -1) - defaultReturn := new(Smsaddress) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'addressId' is set - if &addressId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'addressId' when calling RoutingApi->GetRoutingSmsAddress") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Smsaddress - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetRoutingSmsAddresses invokes GET /api/v2/routing/sms/addresses -// -// Get a list of Addresses for SMS -// -// -func (a RoutingApi) GetRoutingSmsAddresses(pageSize int, pageNumber int) (*Smsaddressentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/sms/addresses" - defaultReturn := new(Smsaddressentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Smsaddressentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetRoutingSmsAvailablephonenumbers invokes GET /api/v2/routing/sms/availablephonenumbers -// -// Get a list of available phone numbers for SMS provisioning. -// -// This request will return up to 30 random phone numbers matching the criteria specified. To get additional phone numbers repeat the request. -func (a RoutingApi) GetRoutingSmsAvailablephonenumbers(countryCode string, phoneNumberType string, region string, city string, areaCode string, pattern string, addressRequirement string) (*Smsavailablephonenumberentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/sms/availablephonenumbers" - defaultReturn := new(Smsavailablephonenumberentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'countryCode' is set - if &countryCode == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'countryCode' when calling RoutingApi->GetRoutingSmsAvailablephonenumbers") - } - // verify the required parameter 'phoneNumberType' is set - if &phoneNumberType == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'phoneNumberType' when calling RoutingApi->GetRoutingSmsAvailablephonenumbers") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(countryCode).(string); ok { - if str != "" { - queryParams["countryCode"] = a.Configuration.APIClient.ParameterToString(countryCode, collectionFormat) - } - } else { - queryParams["countryCode"] = a.Configuration.APIClient.ParameterToString(countryCode, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(region).(string); ok { - if str != "" { - queryParams["region"] = a.Configuration.APIClient.ParameterToString(region, collectionFormat) - } - } else { - queryParams["region"] = a.Configuration.APIClient.ParameterToString(region, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(city).(string); ok { - if str != "" { - queryParams["city"] = a.Configuration.APIClient.ParameterToString(city, collectionFormat) - } - } else { - queryParams["city"] = a.Configuration.APIClient.ParameterToString(city, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(areaCode).(string); ok { - if str != "" { - queryParams["areaCode"] = a.Configuration.APIClient.ParameterToString(areaCode, collectionFormat) - } - } else { - queryParams["areaCode"] = a.Configuration.APIClient.ParameterToString(areaCode, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(phoneNumberType).(string); ok { - if str != "" { - queryParams["phoneNumberType"] = a.Configuration.APIClient.ParameterToString(phoneNumberType, collectionFormat) - } - } else { - queryParams["phoneNumberType"] = a.Configuration.APIClient.ParameterToString(phoneNumberType, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pattern).(string); ok { - if str != "" { - queryParams["pattern"] = a.Configuration.APIClient.ParameterToString(pattern, collectionFormat) - } - } else { - queryParams["pattern"] = a.Configuration.APIClient.ParameterToString(pattern, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(addressRequirement).(string); ok { - if str != "" { - queryParams["addressRequirement"] = a.Configuration.APIClient.ParameterToString(addressRequirement, collectionFormat) - } - } else { - queryParams["addressRequirement"] = a.Configuration.APIClient.ParameterToString(addressRequirement, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Smsavailablephonenumberentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetRoutingSmsPhonenumber invokes GET /api/v2/routing/sms/phonenumbers/{addressId} -// -// Get a phone number provisioned for SMS. -// -// -func (a RoutingApi) GetRoutingSmsPhonenumber(addressId string) (*Smsphonenumber, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/sms/phonenumbers/{addressId}" - path = strings.Replace(path, "{addressId}", fmt.Sprintf("%v", addressId), -1) - defaultReturn := new(Smsphonenumber) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'addressId' is set - if &addressId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'addressId' when calling RoutingApi->GetRoutingSmsPhonenumber") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Smsphonenumber - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetRoutingSmsPhonenumbers invokes GET /api/v2/routing/sms/phonenumbers -// -// Get a list of provisioned phone numbers. -// -// -func (a RoutingApi) GetRoutingSmsPhonenumbers(phoneNumber string, phoneNumberType string, phoneNumberStatus string, pageSize int, pageNumber int) (*Smsphonenumberentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/sms/phonenumbers" - defaultReturn := new(Smsphonenumberentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(phoneNumber).(string); ok { - if str != "" { - queryParams["phoneNumber"] = a.Configuration.APIClient.ParameterToString(phoneNumber, collectionFormat) - } - } else { - queryParams["phoneNumber"] = a.Configuration.APIClient.ParameterToString(phoneNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(phoneNumberType).(string); ok { - if str != "" { - queryParams["phoneNumberType"] = a.Configuration.APIClient.ParameterToString(phoneNumberType, collectionFormat) - } - } else { - queryParams["phoneNumberType"] = a.Configuration.APIClient.ParameterToString(phoneNumberType, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(phoneNumberStatus).(string); ok { - if str != "" { - queryParams["phoneNumberStatus"] = a.Configuration.APIClient.ParameterToString(phoneNumberStatus, collectionFormat) - } - } else { - queryParams["phoneNumberStatus"] = a.Configuration.APIClient.ParameterToString(phoneNumberStatus, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Smsphonenumberentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetRoutingUserUtilization invokes GET /api/v2/routing/users/{userId}/utilization -// -// Get the user's max utilization settings. If not configured, the organization-wide default is returned. -// -// -func (a RoutingApi) GetRoutingUserUtilization(userId string) (*Utilization, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/users/{userId}/utilization" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Utilization) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling RoutingApi->GetRoutingUserUtilization") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Utilization - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetRoutingUtilization invokes GET /api/v2/routing/utilization -// -// Get the organization-wide max utilization settings. -// -// -func (a RoutingApi) GetRoutingUtilization() (*Utilization, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/utilization" - defaultReturn := new(Utilization) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Utilization - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetRoutingWrapupcode invokes GET /api/v2/routing/wrapupcodes/{codeId} -// -// Get details about this wrap-up code. -// -// -func (a RoutingApi) GetRoutingWrapupcode(codeId string) (*Wrapupcode, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/wrapupcodes/{codeId}" - path = strings.Replace(path, "{codeId}", fmt.Sprintf("%v", codeId), -1) - defaultReturn := new(Wrapupcode) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'codeId' is set - if &codeId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'codeId' when calling RoutingApi->GetRoutingWrapupcode") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Wrapupcode - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetRoutingWrapupcodes invokes GET /api/v2/routing/wrapupcodes -// -// Get list of wrapup codes. -// -// -func (a RoutingApi) GetRoutingWrapupcodes(pageSize int, pageNumber int, sortBy string, sortOrder string, name string) (*Wrapupcodeentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/wrapupcodes" - defaultReturn := new(Wrapupcodeentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Wrapupcodeentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetUserQueues invokes GET /api/v2/users/{userId}/queues -// -// Get queues for user -// -// -func (a RoutingApi) GetUserQueues(userId string, pageSize int, pageNumber int, joined bool, divisionId []string) (*Userqueueentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/queues" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Userqueueentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling RoutingApi->GetUserQueues") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(joined).(string); ok { - if str != "" { - queryParams["joined"] = a.Configuration.APIClient.ParameterToString(joined, collectionFormat) - } - } else { - queryParams["joined"] = a.Configuration.APIClient.ParameterToString(joined, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range divisionId { - queryParams["divisionId"] = value - } - } else { - queryParams["divisionId"] = a.Configuration.APIClient.ParameterToString(divisionId, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Userqueueentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetUserRoutinglanguages invokes GET /api/v2/users/{userId}/routinglanguages -// -// List routing language for user -// -// -func (a RoutingApi) GetUserRoutinglanguages(userId string, pageSize int, pageNumber int, sortOrder string) (*Userlanguageentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/routinglanguages" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Userlanguageentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling RoutingApi->GetUserRoutinglanguages") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Userlanguageentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetUserRoutingskills invokes GET /api/v2/users/{userId}/routingskills -// -// List routing skills for user -// -// -func (a RoutingApi) GetUserRoutingskills(userId string, pageSize int, pageNumber int, sortOrder string) (*Userskillentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/routingskills" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Userskillentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling RoutingApi->GetUserRoutingskills") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Userskillentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchRoutingEmailDomain invokes PATCH /api/v2/routing/email/domains/{domainId} -// -// Update domain settings -// -// -func (a RoutingApi) PatchRoutingEmailDomain(domainId string, body Inbounddomainpatchrequest) (*Inbounddomain, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/email/domains/{domainId}" - path = strings.Replace(path, "{domainId}", fmt.Sprintf("%v", domainId), -1) - defaultReturn := new(Inbounddomain) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'domainId' is set - if &domainId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'domainId' when calling RoutingApi->PatchRoutingEmailDomain") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RoutingApi->PatchRoutingEmailDomain") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Inbounddomain - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchRoutingEmailDomainValidate invokes PATCH /api/v2/routing/email/domains/{domainId}/validate -// -// Validate domain settings -// -// -func (a RoutingApi) PatchRoutingEmailDomainValidate(domainId string, body Inbounddomainpatchrequest) (*Inbounddomain, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/email/domains/{domainId}/validate" - path = strings.Replace(path, "{domainId}", fmt.Sprintf("%v", domainId), -1) - defaultReturn := new(Inbounddomain) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'domainId' is set - if &domainId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'domainId' when calling RoutingApi->PatchRoutingEmailDomainValidate") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RoutingApi->PatchRoutingEmailDomainValidate") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Inbounddomain - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchRoutingQueueMember invokes PATCH /api/v2/routing/queues/{queueId}/members/{memberId} -// -// Update the ring number OR joined status for a queue member. -// -// -func (a RoutingApi) PatchRoutingQueueMember(queueId string, memberId string, body Queuemember) (*Queuemember, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/queues/{queueId}/members/{memberId}" - path = strings.Replace(path, "{queueId}", fmt.Sprintf("%v", queueId), -1) - path = strings.Replace(path, "{memberId}", fmt.Sprintf("%v", memberId), -1) - defaultReturn := new(Queuemember) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'queueId' is set - if &queueId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'queueId' when calling RoutingApi->PatchRoutingQueueMember") - } - // verify the required parameter 'memberId' is set - if &memberId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'memberId' when calling RoutingApi->PatchRoutingQueueMember") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RoutingApi->PatchRoutingQueueMember") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Queuemember - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchRoutingQueueMembers invokes PATCH /api/v2/routing/queues/{queueId}/members -// -// Join or unjoin a set of users for a queue -// -// -func (a RoutingApi) PatchRoutingQueueMembers(queueId string, body []Queuemember) (*Queuememberentitylisting, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/queues/{queueId}/members" - path = strings.Replace(path, "{queueId}", fmt.Sprintf("%v", queueId), -1) - defaultReturn := new(Queuememberentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'queueId' is set - if &queueId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'queueId' when calling RoutingApi->PatchRoutingQueueMembers") - } - // verify the required parameter 'body' is set - if &body == nil { - // true - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RoutingApi->PatchRoutingQueueMembers") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Queuememberentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchRoutingQueueUser invokes PATCH /api/v2/routing/queues/{queueId}/users/{memberId} -// -// DEPRECATED: use PATCH /routing/queues/{queueId}/members/{memberId}. Update the ring number OR joined status for a User in a Queue. -// -// -func (a RoutingApi) PatchRoutingQueueUser(queueId string, memberId string, body Queuemember) (*Queuemember, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/queues/{queueId}/users/{memberId}" - path = strings.Replace(path, "{queueId}", fmt.Sprintf("%v", queueId), -1) - path = strings.Replace(path, "{memberId}", fmt.Sprintf("%v", memberId), -1) - defaultReturn := new(Queuemember) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'queueId' is set - if &queueId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'queueId' when calling RoutingApi->PatchRoutingQueueUser") - } - // verify the required parameter 'memberId' is set - if &memberId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'memberId' when calling RoutingApi->PatchRoutingQueueUser") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RoutingApi->PatchRoutingQueueUser") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Queuemember - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchRoutingQueueUsers invokes PATCH /api/v2/routing/queues/{queueId}/users -// -// DEPRECATED: use PATCH /routing/queues/{queueId}/members. Join or unjoin a set of users for a queue. -// -// -func (a RoutingApi) PatchRoutingQueueUsers(queueId string, body []Queuemember) (*Queuememberentitylisting, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/queues/{queueId}/users" - path = strings.Replace(path, "{queueId}", fmt.Sprintf("%v", queueId), -1) - defaultReturn := new(Queuememberentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'queueId' is set - if &queueId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'queueId' when calling RoutingApi->PatchRoutingQueueUsers") - } - // verify the required parameter 'body' is set - if &body == nil { - // true - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RoutingApi->PatchRoutingQueueUsers") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Queuememberentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchRoutingSettingsContactcenter invokes PATCH /api/v2/routing/settings/contactcenter -// -// Update Contact Center Settings -// -// -func (a RoutingApi) PatchRoutingSettingsContactcenter(body Contactcentersettings) (*APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/settings/contactcenter" - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return nil, errors.New("Missing required parameter 'body' when calling RoutingApi->PatchRoutingSettingsContactcenter") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// PatchUserQueue invokes PATCH /api/v2/users/{userId}/queues/{queueId} -// -// Join or unjoin a queue for a user -// -// -func (a RoutingApi) PatchUserQueue(queueId string, userId string, body Userqueue) (*Userqueue, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/queues/{queueId}" - path = strings.Replace(path, "{queueId}", fmt.Sprintf("%v", queueId), -1) - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Userqueue) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'queueId' is set - if &queueId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'queueId' when calling RoutingApi->PatchUserQueue") - } - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling RoutingApi->PatchUserQueue") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RoutingApi->PatchUserQueue") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Userqueue - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchUserQueues invokes PATCH /api/v2/users/{userId}/queues -// -// Join or unjoin a set of queues for a user -// -// -func (a RoutingApi) PatchUserQueues(userId string, body []Userqueue, divisionId []string) (*Userqueueentitylisting, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/queues" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Userqueueentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling RoutingApi->PatchUserQueues") - } - // verify the required parameter 'body' is set - if &body == nil { - // true - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RoutingApi->PatchUserQueues") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range divisionId { - queryParams["divisionId"] = value - } - } else { - queryParams["divisionId"] = a.Configuration.APIClient.ParameterToString(divisionId, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Userqueueentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchUserRoutinglanguage invokes PATCH /api/v2/users/{userId}/routinglanguages/{languageId} -// -// Update routing language proficiency or state. -// -// -func (a RoutingApi) PatchUserRoutinglanguage(userId string, languageId string, body Userroutinglanguage) (*Userroutinglanguage, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/routinglanguages/{languageId}" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - path = strings.Replace(path, "{languageId}", fmt.Sprintf("%v", languageId), -1) - defaultReturn := new(Userroutinglanguage) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling RoutingApi->PatchUserRoutinglanguage") - } - // verify the required parameter 'languageId' is set - if &languageId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'languageId' when calling RoutingApi->PatchUserRoutinglanguage") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RoutingApi->PatchUserRoutinglanguage") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Userroutinglanguage - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchUserRoutinglanguagesBulk invokes PATCH /api/v2/users/{userId}/routinglanguages/bulk -// -// Add bulk routing language to user. Max limit 50 languages -// -// -func (a RoutingApi) PatchUserRoutinglanguagesBulk(userId string, body []Userroutinglanguagepost) (*Userlanguageentitylisting, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/routinglanguages/bulk" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Userlanguageentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling RoutingApi->PatchUserRoutinglanguagesBulk") - } - // verify the required parameter 'body' is set - if &body == nil { - // true - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RoutingApi->PatchUserRoutinglanguagesBulk") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Userlanguageentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchUserRoutingskillsBulk invokes PATCH /api/v2/users/{userId}/routingskills/bulk -// -// Bulk add routing skills to user -// -// -func (a RoutingApi) PatchUserRoutingskillsBulk(userId string, body []Userroutingskillpost) (*Userskillentitylisting, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/routingskills/bulk" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Userskillentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling RoutingApi->PatchUserRoutingskillsBulk") - } - // verify the required parameter 'body' is set - if &body == nil { - // true - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RoutingApi->PatchUserRoutingskillsBulk") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Userskillentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostAnalyticsQueuesObservationsQuery invokes POST /api/v2/analytics/queues/observations/query -// -// Query for queue observations -// -// -func (a RoutingApi) PostAnalyticsQueuesObservationsQuery(body Queueobservationquery) (*Queueobservationqueryresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/queues/observations/query" - defaultReturn := new(Queueobservationqueryresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RoutingApi->PostAnalyticsQueuesObservationsQuery") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Queueobservationqueryresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostRoutingEmailDomainRoutes invokes POST /api/v2/routing/email/domains/{domainName}/routes -// -// Create a route -// -// -func (a RoutingApi) PostRoutingEmailDomainRoutes(domainName string, body Inboundroute) (*Inboundroute, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/email/domains/{domainName}/routes" - path = strings.Replace(path, "{domainName}", fmt.Sprintf("%v", domainName), -1) - defaultReturn := new(Inboundroute) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'domainName' is set - if &domainName == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'domainName' when calling RoutingApi->PostRoutingEmailDomainRoutes") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RoutingApi->PostRoutingEmailDomainRoutes") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Inboundroute - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostRoutingEmailDomainTestconnection invokes POST /api/v2/routing/email/domains/{domainId}/testconnection -// -// Tests the custom SMTP server integration connection set on this domain -// -// The request body is optional. If omitted, this endpoint will just test the connection of the Custom SMTP Server. If the body is specified, there will be an attempt to send an email message to the server. -func (a RoutingApi) PostRoutingEmailDomainTestconnection(domainId string, body Testmessage) (*Testmessage, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/email/domains/{domainId}/testconnection" - path = strings.Replace(path, "{domainId}", fmt.Sprintf("%v", domainId), -1) - defaultReturn := new(Testmessage) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'domainId' is set - if &domainId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'domainId' when calling RoutingApi->PostRoutingEmailDomainTestconnection") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Testmessage - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostRoutingEmailDomains invokes POST /api/v2/routing/email/domains -// -// Create a domain -// -// -func (a RoutingApi) PostRoutingEmailDomains(body Inbounddomain) (*Inbounddomain, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/email/domains" - defaultReturn := new(Inbounddomain) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RoutingApi->PostRoutingEmailDomains") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Inbounddomain - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostRoutingLanguages invokes POST /api/v2/routing/languages -// -// Create Language -// -// -func (a RoutingApi) PostRoutingLanguages(body Language) (*Language, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/languages" - defaultReturn := new(Language) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RoutingApi->PostRoutingLanguages") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Language - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostRoutingQueueMembers invokes POST /api/v2/routing/queues/{queueId}/members -// -// Bulk add or delete up to 100 queue members -// -// -func (a RoutingApi) PostRoutingQueueMembers(queueId string, body []Writableentity, delete bool) (*string, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/queues/{queueId}/members" - path = strings.Replace(path, "{queueId}", fmt.Sprintf("%v", queueId), -1) - defaultReturn := new(string) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'queueId' is set - if &queueId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'queueId' when calling RoutingApi->PostRoutingQueueMembers") - } - // verify the required parameter 'body' is set - if &body == nil { - // true - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RoutingApi->PostRoutingQueueMembers") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(delete).(string); ok { - if str != "" { - queryParams["delete"] = a.Configuration.APIClient.ParameterToString(delete, collectionFormat) - } - } else { - queryParams["delete"] = a.Configuration.APIClient.ParameterToString(delete, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *string - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostRoutingQueueUsers invokes POST /api/v2/routing/queues/{queueId}/users -// -// DEPRECATED: use POST /routing/queues/{queueId}/members. Bulk add or delete up to 100 queue members. -// -// -func (a RoutingApi) PostRoutingQueueUsers(queueId string, body []Writableentity, delete bool) (*string, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/queues/{queueId}/users" - path = strings.Replace(path, "{queueId}", fmt.Sprintf("%v", queueId), -1) - defaultReturn := new(string) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'queueId' is set - if &queueId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'queueId' when calling RoutingApi->PostRoutingQueueUsers") - } - // verify the required parameter 'body' is set - if &body == nil { - // true - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RoutingApi->PostRoutingQueueUsers") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(delete).(string); ok { - if str != "" { - queryParams["delete"] = a.Configuration.APIClient.ParameterToString(delete, collectionFormat) - } - } else { - queryParams["delete"] = a.Configuration.APIClient.ParameterToString(delete, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *string - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostRoutingQueueWrapupcodes invokes POST /api/v2/routing/queues/{queueId}/wrapupcodes -// -// Add up to 100 wrap-up codes to a queue -// -// -func (a RoutingApi) PostRoutingQueueWrapupcodes(queueId string, body []Wrapupcodereference) ([]Wrapupcode, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/queues/{queueId}/wrapupcodes" - path = strings.Replace(path, "{queueId}", fmt.Sprintf("%v", queueId), -1) - defaultReturn := make([]Wrapupcode, 0) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'queueId' is set - if &queueId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'queueId' when calling RoutingApi->PostRoutingQueueWrapupcodes") - } - // verify the required parameter 'body' is set - if &body == nil { - // true - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RoutingApi->PostRoutingQueueWrapupcodes") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload []Wrapupcode - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostRoutingQueues invokes POST /api/v2/routing/queues -// -// Create a queue -// -// -func (a RoutingApi) PostRoutingQueues(body Createqueuerequest) (*Queue, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/queues" - defaultReturn := new(Queue) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RoutingApi->PostRoutingQueues") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Queue - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostRoutingSkills invokes POST /api/v2/routing/skills -// -// Create Skill -// -// -func (a RoutingApi) PostRoutingSkills(body Routingskill) (*Routingskill, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/skills" - defaultReturn := new(Routingskill) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RoutingApi->PostRoutingSkills") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Routingskill - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostRoutingSmsAddresses invokes POST /api/v2/routing/sms/addresses -// -// Provision an Address for SMS -// -// -func (a RoutingApi) PostRoutingSmsAddresses(body Smsaddressprovision) (*Smsaddress, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/sms/addresses" - defaultReturn := new(Smsaddress) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RoutingApi->PostRoutingSmsAddresses") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Smsaddress - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostRoutingSmsPhonenumbers invokes POST /api/v2/routing/sms/phonenumbers -// -// Provision a phone number for SMS -// -// -func (a RoutingApi) PostRoutingSmsPhonenumbers(body Smsphonenumberprovision) (*Smsphonenumber, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/sms/phonenumbers" - defaultReturn := new(Smsphonenumber) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RoutingApi->PostRoutingSmsPhonenumbers") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Smsphonenumber - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostRoutingWrapupcodes invokes POST /api/v2/routing/wrapupcodes -// -// Create a wrap-up code -// -// -func (a RoutingApi) PostRoutingWrapupcodes(body Wrapupcode) (*Wrapupcode, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/wrapupcodes" - defaultReturn := new(Wrapupcode) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RoutingApi->PostRoutingWrapupcodes") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Wrapupcode - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostUserRoutinglanguages invokes POST /api/v2/users/{userId}/routinglanguages -// -// Add routing language to user -// -// -func (a RoutingApi) PostUserRoutinglanguages(userId string, body Userroutinglanguagepost) (*Userroutinglanguage, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/routinglanguages" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Userroutinglanguage) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling RoutingApi->PostUserRoutinglanguages") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RoutingApi->PostUserRoutinglanguages") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Userroutinglanguage - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostUserRoutingskills invokes POST /api/v2/users/{userId}/routingskills -// -// Add routing skill to user -// -// -func (a RoutingApi) PostUserRoutingskills(userId string, body Userroutingskillpost) (*Userroutingskill, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/routingskills" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Userroutingskill) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling RoutingApi->PostUserRoutingskills") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RoutingApi->PostUserRoutingskills") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Userroutingskill - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutRoutingEmailDomainRoute invokes PUT /api/v2/routing/email/domains/{domainName}/routes/{routeId} -// -// Update a route -// -// -func (a RoutingApi) PutRoutingEmailDomainRoute(domainName string, routeId string, body Inboundroute) (*Inboundroute, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/email/domains/{domainName}/routes/{routeId}" - path = strings.Replace(path, "{domainName}", fmt.Sprintf("%v", domainName), -1) - path = strings.Replace(path, "{routeId}", fmt.Sprintf("%v", routeId), -1) - defaultReturn := new(Inboundroute) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'domainName' is set - if &domainName == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'domainName' when calling RoutingApi->PutRoutingEmailDomainRoute") - } - // verify the required parameter 'routeId' is set - if &routeId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'routeId' when calling RoutingApi->PutRoutingEmailDomainRoute") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RoutingApi->PutRoutingEmailDomainRoute") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Inboundroute - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutRoutingMessageRecipient invokes PUT /api/v2/routing/message/recipients/{recipientId} -// -// Update a recipient -// -// -func (a RoutingApi) PutRoutingMessageRecipient(recipientId string, body Recipient) (*Recipient, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/message/recipients/{recipientId}" - path = strings.Replace(path, "{recipientId}", fmt.Sprintf("%v", recipientId), -1) - defaultReturn := new(Recipient) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'recipientId' is set - if &recipientId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'recipientId' when calling RoutingApi->PutRoutingMessageRecipient") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RoutingApi->PutRoutingMessageRecipient") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Recipient - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutRoutingQueue invokes PUT /api/v2/routing/queues/{queueId} -// -// Update a queue -// -// -func (a RoutingApi) PutRoutingQueue(queueId string, body Queuerequest) (*Queue, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/queues/{queueId}" - path = strings.Replace(path, "{queueId}", fmt.Sprintf("%v", queueId), -1) - defaultReturn := new(Queue) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'queueId' is set - if &queueId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'queueId' when calling RoutingApi->PutRoutingQueue") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RoutingApi->PutRoutingQueue") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Queue - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutRoutingSettings invokes PUT /api/v2/routing/settings -// -// Update an organization's routing settings -// -// -func (a RoutingApi) PutRoutingSettings(body Routingsettings) (*Routingsettings, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/settings" - defaultReturn := new(Routingsettings) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RoutingApi->PutRoutingSettings") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Routingsettings - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutRoutingSettingsTranscription invokes PUT /api/v2/routing/settings/transcription -// -// Update Transcription Settings -// -// -func (a RoutingApi) PutRoutingSettingsTranscription(body Transcriptionsettings) (*Transcriptionsettings, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/settings/transcription" - defaultReturn := new(Transcriptionsettings) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RoutingApi->PutRoutingSettingsTranscription") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Transcriptionsettings - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutRoutingSmsPhonenumber invokes PUT /api/v2/routing/sms/phonenumbers/{addressId} -// -// Update a phone number provisioned for SMS. -// -// -func (a RoutingApi) PutRoutingSmsPhonenumber(addressId string, body Smsphonenumber) (*Smsphonenumber, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/sms/phonenumbers/{addressId}" - path = strings.Replace(path, "{addressId}", fmt.Sprintf("%v", addressId), -1) - defaultReturn := new(Smsphonenumber) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'addressId' is set - if &addressId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'addressId' when calling RoutingApi->PutRoutingSmsPhonenumber") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RoutingApi->PutRoutingSmsPhonenumber") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Smsphonenumber - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutRoutingUserUtilization invokes PUT /api/v2/routing/users/{userId}/utilization -// -// Update the user's max utilization settings. Include only those media types requiring custom configuration. -// -// -func (a RoutingApi) PutRoutingUserUtilization(userId string, body Utilization) (*Utilization, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/users/{userId}/utilization" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Utilization) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling RoutingApi->PutRoutingUserUtilization") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RoutingApi->PutRoutingUserUtilization") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Utilization - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutRoutingUtilization invokes PUT /api/v2/routing/utilization -// -// Update the organization-wide max utilization settings. Include only those media types requiring custom configuration. -// -// -func (a RoutingApi) PutRoutingUtilization(body Utilization) (*Utilization, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/utilization" - defaultReturn := new(Utilization) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RoutingApi->PutRoutingUtilization") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Utilization - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutRoutingWrapupcode invokes PUT /api/v2/routing/wrapupcodes/{codeId} -// -// Update wrap-up code -// -// -func (a RoutingApi) PutRoutingWrapupcode(codeId string, body Wrapupcode) (*Wrapupcode, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/wrapupcodes/{codeId}" - path = strings.Replace(path, "{codeId}", fmt.Sprintf("%v", codeId), -1) - defaultReturn := new(Wrapupcode) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'codeId' is set - if &codeId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'codeId' when calling RoutingApi->PutRoutingWrapupcode") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RoutingApi->PutRoutingWrapupcode") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Wrapupcode - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutUserRoutingskill invokes PUT /api/v2/users/{userId}/routingskills/{skillId} -// -// Update routing skill proficiency or state. -// -// -func (a RoutingApi) PutUserRoutingskill(userId string, skillId string, body Userroutingskill) (*Userroutingskill, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/routingskills/{skillId}" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - path = strings.Replace(path, "{skillId}", fmt.Sprintf("%v", skillId), -1) - defaultReturn := new(Userroutingskill) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling RoutingApi->PutUserRoutingskill") - } - // verify the required parameter 'skillId' is set - if &skillId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'skillId' when calling RoutingApi->PutUserRoutingskill") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RoutingApi->PutUserRoutingskill") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Userroutingskill - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutUserRoutingskillsBulk invokes PUT /api/v2/users/{userId}/routingskills/bulk -// -// Replace all routing skills assigned to a user -// -// -func (a RoutingApi) PutUserRoutingskillsBulk(userId string, body []Userroutingskillpost) (*Userskillentitylisting, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/routingskills/bulk" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Userskillentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling RoutingApi->PutUserRoutingskillsBulk") - } - // verify the required parameter 'body' is set - if &body == nil { - // true - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RoutingApi->PutUserRoutingskillsBulk") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Userskillentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/routingdata.go b/build/platformclientv2/routingdata.go deleted file mode 100644 index 8d004a14c..000000000 --- a/build/platformclientv2/routingdata.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Routingdata -type Routingdata struct { - // QueueId - The identifier of the routing queue - QueueId *string `json:"queueId,omitempty"` - - - // LanguageId - The identifier of a language to be considered in routing - LanguageId *string `json:"languageId,omitempty"` - - - // Priority - The priority for routing - Priority *int `json:"priority,omitempty"` - - - // SkillIds - A list of skill identifiers to be considered in routing - SkillIds *[]string `json:"skillIds,omitempty"` - - - // PreferredAgentIds - A list of agents to be preferred in routing - PreferredAgentIds *[]string `json:"preferredAgentIds,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Routingdata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/routingrule.go b/build/platformclientv2/routingrule.go deleted file mode 100644 index 7a8af2a72..000000000 --- a/build/platformclientv2/routingrule.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Routingrule -type Routingrule struct { - // Operator - matching operator. MEETS_THRESHOLD matches any agent with a score at or above the rule's threshold. ANY matches all specified agents, regardless of score. - Operator *string `json:"operator,omitempty"` - - - // Threshold - threshold required for routing attempt (generally an agent score). may be null for operator ANY. - Threshold *int `json:"threshold,omitempty"` - - - // WaitSeconds - seconds to wait in this rule before moving to the next - WaitSeconds *float64 `json:"waitSeconds,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Routingrule) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/routingsettings.go b/build/platformclientv2/routingsettings.go deleted file mode 100644 index 072c6deeb..000000000 --- a/build/platformclientv2/routingsettings.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Routingsettings -type Routingsettings struct { - // ResetAgentScoreOnPresenceChange - Reset agent score when agent presence changes from off-queue to on-queue - ResetAgentScoreOnPresenceChange *bool `json:"resetAgentScoreOnPresenceChange,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Routingsettings) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/routingskill.go b/build/platformclientv2/routingskill.go deleted file mode 100644 index 45e2b97a2..000000000 --- a/build/platformclientv2/routingskill.go +++ /dev/null @@ -1,38 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Routingskill -type Routingskill struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the skill. - Name *string `json:"name,omitempty"` - - - // DateModified - Date last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // State - The current state for this skill. - State *string `json:"state,omitempty"` - - - // Version - Required when updating. Version must be the current version. Only the system can assign version. - Version *string `json:"version,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Routingskill) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/routingskillreference.go b/build/platformclientv2/routingskillreference.go deleted file mode 100644 index 8dfaea03c..000000000 --- a/build/platformclientv2/routingskillreference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Routingskillreference -type Routingskillreference struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Routingskillreference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/routingstatus.go b/build/platformclientv2/routingstatus.go deleted file mode 100644 index 83d402a98..000000000 --- a/build/platformclientv2/routingstatus.go +++ /dev/null @@ -1,26 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Routingstatus -type Routingstatus struct { - // UserId - The userId of the agent - UserId *string `json:"userId,omitempty"` - - - // Status - Indicates the Routing State of the agent. A value of OFF_QUEUE will be returned if the specified user does not exist. - Status *string `json:"status,omitempty"` - - - // StartTime - The timestamp when the agent went into this state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartTime *time.Time `json:"startTime,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Routingstatus) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/routingstatusdetailqueryclause.go b/build/platformclientv2/routingstatusdetailqueryclause.go deleted file mode 100644 index d69046652..000000000 --- a/build/platformclientv2/routingstatusdetailqueryclause.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Routingstatusdetailqueryclause -type Routingstatusdetailqueryclause struct { - // VarType - Boolean operation to apply to the provided predicates - VarType *string `json:"type,omitempty"` - - - // Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value). - Predicates *[]Routingstatusdetailquerypredicate `json:"predicates,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Routingstatusdetailqueryclause) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/routingstatusdetailqueryfilter.go b/build/platformclientv2/routingstatusdetailqueryfilter.go deleted file mode 100644 index 947939323..000000000 --- a/build/platformclientv2/routingstatusdetailqueryfilter.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Routingstatusdetailqueryfilter -type Routingstatusdetailqueryfilter struct { - // VarType - Boolean operation to apply to the provided predicates and clauses - VarType *string `json:"type,omitempty"` - - - // Clauses - Boolean 'and/or' logic with up to two-levels of nesting - Clauses *[]Routingstatusdetailqueryclause `json:"clauses,omitempty"` - - - // Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value). - Predicates *[]Routingstatusdetailquerypredicate `json:"predicates,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Routingstatusdetailqueryfilter) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/routingstatusdetailquerypredicate.go b/build/platformclientv2/routingstatusdetailquerypredicate.go deleted file mode 100644 index 2a627700f..000000000 --- a/build/platformclientv2/routingstatusdetailquerypredicate.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Routingstatusdetailquerypredicate -type Routingstatusdetailquerypredicate struct { - // VarType - Optional type, can usually be inferred - VarType *string `json:"type,omitempty"` - - - // Dimension - Left hand side for dimension predicates - Dimension *string `json:"dimension,omitempty"` - - - // Operator - Optional operator, default is matches - Operator *string `json:"operator,omitempty"` - - - // Value - Right hand side for dimension predicates - Value *string `json:"value,omitempty"` - - - // VarRange - Right hand side for dimension predicates - VarRange *Numericrange `json:"range,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Routingstatusdetailquerypredicate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/ruleset.go b/build/platformclientv2/ruleset.go deleted file mode 100644 index b9c6bb304..000000000 --- a/build/platformclientv2/ruleset.go +++ /dev/null @@ -1,50 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Ruleset -type Ruleset struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the RuleSet. - Name *string `json:"name,omitempty"` - - - // DateCreated - Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // Version - Required for updates, must match the version number of the most recent update - Version *int `json:"version,omitempty"` - - - // ContactList - A ContactList to provide user-interface suggestions for contact columns on relevant conditions and actions. - ContactList *Domainentityref `json:"contactList,omitempty"` - - - // Queue - A Queue to provide user-interface suggestions for wrap-up codes on relevant conditions and actions. - Queue *Domainentityref `json:"queue,omitempty"` - - - // Rules - The list of rules. - Rules *[]Dialerrule `json:"rules,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Ruleset) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/rulesetdiagnostic.go b/build/platformclientv2/rulesetdiagnostic.go deleted file mode 100644 index 5d5a66e04..000000000 --- a/build/platformclientv2/rulesetdiagnostic.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Rulesetdiagnostic -type Rulesetdiagnostic struct { - // RuleSet - A campaign rule set - RuleSet *Domainentityref `json:"ruleSet,omitempty"` - - - // Warnings - Diagnostic warnings for the rule set - Warnings *[]string `json:"warnings,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Rulesetdiagnostic) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/rulesetentitylisting.go b/build/platformclientv2/rulesetentitylisting.go deleted file mode 100644 index c6a8b38a1..000000000 --- a/build/platformclientv2/rulesetentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Rulesetentitylisting -type Rulesetentitylisting struct { - // Entities - Entities *[]Ruleset `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Rulesetentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/salesforce.go b/build/platformclientv2/salesforce.go deleted file mode 100644 index c5c7cefff..000000000 --- a/build/platformclientv2/salesforce.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Salesforce -type Salesforce struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Disabled - Disabled *bool `json:"disabled,omitempty"` - - - // IssuerURI - IssuerURI *string `json:"issuerURI,omitempty"` - - - // SsoTargetURI - SsoTargetURI *string `json:"ssoTargetURI,omitempty"` - - - // Certificate - Certificate *string `json:"certificate,omitempty"` - - - // Certificates - Certificates *[]string `json:"certificates,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Salesforce) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/schedule.go b/build/platformclientv2/schedule.go deleted file mode 100644 index c2c2e0f4c..000000000 --- a/build/platformclientv2/schedule.go +++ /dev/null @@ -1,74 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Schedule - Defines a period of time to perform a specific action. Each schedule must be associated with one or more schedule groups to be used. -type Schedule struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the entity. - Name *string `json:"name,omitempty"` - - - // Description - The resource's description. - Description *string `json:"description,omitempty"` - - - // Version - The current version of the resource. - Version *int `json:"version,omitempty"` - - - // DateCreated - The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // ModifiedBy - The ID of the user that last modified the resource. - ModifiedBy *string `json:"modifiedBy,omitempty"` - - - // CreatedBy - The ID of the user that created the resource. - CreatedBy *string `json:"createdBy,omitempty"` - - - // State - Indicates if the resource is active, inactive, or deleted. - State *string `json:"state,omitempty"` - - - // ModifiedByApp - The application that last modified the resource. - ModifiedByApp *string `json:"modifiedByApp,omitempty"` - - - // CreatedByApp - The application that created the resource. - CreatedByApp *string `json:"createdByApp,omitempty"` - - - // Start - Date time is represented as an ISO-8601 string without a timezone. For example: yyyy-MM-ddTHH:mm:ss.SSS - Start *time.Time `json:"start,omitempty"` - - - // End - Date time is represented as an ISO-8601 string without a timezone. For example: yyyy-MM-ddTHH:mm:ss.SSS - End *time.Time `json:"end,omitempty"` - - - // Rrule - An iCal Recurrence Rule (RRULE) string. - Rrule *string `json:"rrule,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Schedule) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/scheduleentitylisting.go b/build/platformclientv2/scheduleentitylisting.go deleted file mode 100644 index 19fbc19dd..000000000 --- a/build/platformclientv2/scheduleentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Scheduleentitylisting -type Scheduleentitylisting struct { - // Entities - Entities *[]Schedule `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Scheduleentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/schedulegenerationmessage.go b/build/platformclientv2/schedulegenerationmessage.go deleted file mode 100644 index e5e76e39b..000000000 --- a/build/platformclientv2/schedulegenerationmessage.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Schedulegenerationmessage -type Schedulegenerationmessage struct { - // VarType - The type of the message - VarType *string `json:"type,omitempty"` - - - // Arguments - The arguments describing the message - Arguments *[]Schedulermessageargument `json:"arguments,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Schedulegenerationmessage) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/schedulegenerationresult.go b/build/platformclientv2/schedulegenerationresult.go deleted file mode 100644 index 805559391..000000000 --- a/build/platformclientv2/schedulegenerationresult.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Schedulegenerationresult -type Schedulegenerationresult struct { - // Failed - Whether the schedule generation run failed - Failed *bool `json:"failed,omitempty"` - - - // RunId - The run ID for the schedule generation. Reference this when requesting support - RunId *string `json:"runId,omitempty"` - - - // MessageCount - The number of schedule generation messages for this schedule generation run - MessageCount *int `json:"messageCount,omitempty"` - - - // Messages - User facing messages related to the schedule generation run - Messages *[]Schedulegenerationmessage `json:"messages,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Schedulegenerationresult) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/schedulegenerationresultsummary.go b/build/platformclientv2/schedulegenerationresultsummary.go deleted file mode 100644 index 8adb9e724..000000000 --- a/build/platformclientv2/schedulegenerationresultsummary.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Schedulegenerationresultsummary -type Schedulegenerationresultsummary struct { - // Failed - Whether the schedule generation run failed - Failed *bool `json:"failed,omitempty"` - - - // RunId - The run ID for the schedule generation. Reference this when requesting support - RunId *string `json:"runId,omitempty"` - - - // MessageCount - The number of schedule generation messages for this schedule generation run - MessageCount *int `json:"messageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Schedulegenerationresultsummary) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/schedulegenerationwarning.go b/build/platformclientv2/schedulegenerationwarning.go deleted file mode 100644 index 7c023d6c0..000000000 --- a/build/platformclientv2/schedulegenerationwarning.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Schedulegenerationwarning - Schedule generation warning -type Schedulegenerationwarning struct { - // UserId - ID of the user in the warning - UserId *string `json:"userId,omitempty"` - - - // UserNotLicensed - Whether the user does not have the appropriate license to be scheduled - UserNotLicensed *bool `json:"userNotLicensed,omitempty"` - - - // UnableToMeetMaxDays - Whether the number of scheduled days exceeded the maximum days to schedule defined in the agent work plan - UnableToMeetMaxDays *bool `json:"unableToMeetMaxDays,omitempty"` - - - // UnableToScheduleRequiredDays - Days indicated as required to work in agent work plan where no viable shift was found to schedule - UnableToScheduleRequiredDays *[]string `json:"unableToScheduleRequiredDays,omitempty"` - - - // UnableToMeetMinPaidForTheWeek - Whether the schedule did not meet the minimum paid time for the week defined in the agent work plan - UnableToMeetMinPaidForTheWeek *bool `json:"unableToMeetMinPaidForTheWeek,omitempty"` - - - // UnableToMeetMaxPaidForTheWeek - Whether the schedule exceeded the maximum paid time for the week defined in the agent work plan - UnableToMeetMaxPaidForTheWeek *bool `json:"unableToMeetMaxPaidForTheWeek,omitempty"` - - - // NoNeedDays - Days agent was scheduled but there was no need to meet. The scheduled days have no effect on service levels - NoNeedDays *[]string `json:"noNeedDays,omitempty"` - - - // ShiftsTooCloseTogether - Whether the schedule did not meet the minimum time between shifts defined in the agent work plan - ShiftsTooCloseTogether *bool `json:"shiftsTooCloseTogether,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Schedulegenerationwarning) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/schedulegroup.go b/build/platformclientv2/schedulegroup.go deleted file mode 100644 index 852d7a2b4..000000000 --- a/build/platformclientv2/schedulegroup.go +++ /dev/null @@ -1,78 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Schedulegroup - A group of schedules that define the operating hours of an organization. -type Schedulegroup struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the entity. - Name *string `json:"name,omitempty"` - - - // Description - The resource's description. - Description *string `json:"description,omitempty"` - - - // Version - The current version of the resource. - Version *int `json:"version,omitempty"` - - - // DateCreated - The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // ModifiedBy - The ID of the user that last modified the resource. - ModifiedBy *string `json:"modifiedBy,omitempty"` - - - // CreatedBy - The ID of the user that created the resource. - CreatedBy *string `json:"createdBy,omitempty"` - - - // State - Indicates if the resource is active, inactive, or deleted. - State *string `json:"state,omitempty"` - - - // ModifiedByApp - The application that last modified the resource. - ModifiedByApp *string `json:"modifiedByApp,omitempty"` - - - // CreatedByApp - The application that created the resource. - CreatedByApp *string `json:"createdByApp,omitempty"` - - - // TimeZone - The timezone the schedules are a part of. This is not a schedule property to allow a schedule to be used in multiple timezones. - TimeZone *string `json:"timeZone,omitempty"` - - - // OpenSchedules - The schedules defining the hours an organization is open. - OpenSchedules *[]Domainentityref `json:"openSchedules,omitempty"` - - - // ClosedSchedules - The schedules defining the hours an organization is closed. - ClosedSchedules *[]Domainentityref `json:"closedSchedules,omitempty"` - - - // HolidaySchedules - The schedules defining the hours an organization is closed for the holidays. - HolidaySchedules *[]Domainentityref `json:"holidaySchedules,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Schedulegroup) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/schedulegroupentitylisting.go b/build/platformclientv2/schedulegroupentitylisting.go deleted file mode 100644 index 1c49e0f9d..000000000 --- a/build/platformclientv2/schedulegroupentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Schedulegroupentitylisting -type Schedulegroupentitylisting struct { - // Entities - Entities *[]Schedulegroup `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Schedulegroupentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/scheduleinterval.go b/build/platformclientv2/scheduleinterval.go deleted file mode 100644 index 3b103718e..000000000 --- a/build/platformclientv2/scheduleinterval.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Scheduleinterval -type Scheduleinterval struct { - // Start - The scheduled start time as an ISO-8601 string, i.e yyyy-MM-ddTHH:mm:ss.SSSZ - Start *string `json:"start,omitempty"` - - - // End - The scheduled end time as an ISO-8601 string, i.e. yyyy-MM-ddTHH:mm:ss.SSSZ - End *string `json:"end,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Scheduleinterval) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/schedulermessageargument.go b/build/platformclientv2/schedulermessageargument.go deleted file mode 100644 index c1580d260..000000000 --- a/build/platformclientv2/schedulermessageargument.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Schedulermessageargument -type Schedulermessageargument struct { - // VarType - The type of this message parameter - VarType *string `json:"type,omitempty"` - - - // Value - The value of this message parameter - Value *string `json:"value,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Schedulermessageargument) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/schedulingprocessingerror.go b/build/platformclientv2/schedulingprocessingerror.go deleted file mode 100644 index d843f30c7..000000000 --- a/build/platformclientv2/schedulingprocessingerror.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Schedulingprocessingerror -type Schedulingprocessingerror struct { - // InternalErrorCode - An internal code representing the type of error. BadJson for 'Unable to parse json.' NotFound for 'Resource not found.' Fail for 'An unexpected server error occured.' - InternalErrorCode *string `json:"internalErrorCode,omitempty"` - - - // Description - A text description of the error - Description *string `json:"description,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Schedulingprocessingerror) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/schedulingsettingsrequest.go b/build/platformclientv2/schedulingsettingsrequest.go deleted file mode 100644 index 2fb1fd4ed..000000000 --- a/build/platformclientv2/schedulingsettingsrequest.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Schedulingsettingsrequest - Scheduling Settings -type Schedulingsettingsrequest struct { - // MaxOccupancyPercentForDeferredWork - Max occupancy percent for deferred work - MaxOccupancyPercentForDeferredWork *int `json:"maxOccupancyPercentForDeferredWork,omitempty"` - - - // DefaultShrinkagePercent - Default shrinkage percent for scheduling - DefaultShrinkagePercent *float64 `json:"defaultShrinkagePercent,omitempty"` - - - // ShrinkageOverrides - Shrinkage overrides for scheduling - ShrinkageOverrides *Shrinkageoverrides `json:"shrinkageOverrides,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Schedulingsettingsrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/schedulingsettingsresponse.go b/build/platformclientv2/schedulingsettingsresponse.go deleted file mode 100644 index 8487e03e3..000000000 --- a/build/platformclientv2/schedulingsettingsresponse.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Schedulingsettingsresponse - Scheduling Settings -type Schedulingsettingsresponse struct { - // MaxOccupancyPercentForDeferredWork - Max occupancy percent for deferred work - MaxOccupancyPercentForDeferredWork *int `json:"maxOccupancyPercentForDeferredWork,omitempty"` - - - // DefaultShrinkagePercent - Default shrinkage percent for scheduling - DefaultShrinkagePercent *float64 `json:"defaultShrinkagePercent,omitempty"` - - - // ShrinkageOverrides - Shrinkage overrides for scheduling - ShrinkageOverrides *Shrinkageoverrides `json:"shrinkageOverrides,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Schedulingsettingsresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/schedulingstatusresponse.go b/build/platformclientv2/schedulingstatusresponse.go deleted file mode 100644 index 0a902ee1d..000000000 --- a/build/platformclientv2/schedulingstatusresponse.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Schedulingstatusresponse -type Schedulingstatusresponse struct { - // Id - The ID generated for the scheduling job. Use to GET result when job is completed. - Id *string `json:"id,omitempty"` - - - // Status - The status of the scheduling job. - Status *string `json:"status,omitempty"` - - - // ErrorDetails - If the request could not be properly processed, error details will be given here. - ErrorDetails *[]Schedulingprocessingerror `json:"errorDetails,omitempty"` - - - // SchedulingResultUri - The uri of the scheduling result. It has a value if the status is 'Success'. - SchedulingResultUri *string `json:"schedulingResultUri,omitempty"` - - - // PercentComplete - The percentage of the job that is complete. - PercentComplete *int `json:"percentComplete,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Schedulingstatusresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/schedulingtestingoptionsrequest.go b/build/platformclientv2/schedulingtestingoptionsrequest.go deleted file mode 100644 index 76c0a6f5f..000000000 --- a/build/platformclientv2/schedulingtestingoptionsrequest.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Schedulingtestingoptionsrequest -type Schedulingtestingoptionsrequest struct { - // FastScheduling - Whether to enable fast scheduling - FastScheduling *bool `json:"fastScheduling,omitempty"` - - - // DelayScheduling - Whether to force delayed scheduling - DelayScheduling *bool `json:"delayScheduling,omitempty"` - - - // FailScheduling - Whether to force scheduling to fail - FailScheduling *bool `json:"failScheduling,omitempty"` - - - // PopulateWarnings - Whether to populate warnings in the generated schedule - PopulateWarnings *bool `json:"populateWarnings,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Schedulingtestingoptionsrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/schema.go b/build/platformclientv2/schema.go deleted file mode 100644 index 3b258aee7..000000000 --- a/build/platformclientv2/schema.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Schema -type Schema struct { - // Title - A core type's title - Title *string `json:"title,omitempty"` - - - // Description - A core type's description - Description *string `json:"description,omitempty"` - - - // VarType - An array of fundamental JSON Schema primitive types on which the core type is based - VarType *[]string `json:"type,omitempty"` - - - // Items - Denotes the type and pattern of the items in an enum core type - Items *Items `json:"items,omitempty"` - - - // Pattern - For the \"date\" and \"datetime\" core types, denotes the regex prescribing the allowable date/datetime format - Pattern *string `json:"pattern,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Schema) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/schemacategory.go b/build/platformclientv2/schemacategory.go deleted file mode 100644 index 978d8ba5a..000000000 --- a/build/platformclientv2/schemacategory.go +++ /dev/null @@ -1,62 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Schemacategory -type Schemacategory struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the entity. - Name *string `json:"name,omitempty"` - - - // Description - The resource's description. - Description *string `json:"description,omitempty"` - - - // Version - The current version of the resource. - Version *int `json:"version,omitempty"` - - - // DateCreated - The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // ModifiedBy - The ID of the user that last modified the resource. - ModifiedBy *string `json:"modifiedBy,omitempty"` - - - // CreatedBy - The ID of the user that created the resource. - CreatedBy *string `json:"createdBy,omitempty"` - - - // State - Indicates if the resource is active, inactive, or deleted. - State *string `json:"state,omitempty"` - - - // ModifiedByApp - The application that last modified the resource. - ModifiedByApp *string `json:"modifiedByApp,omitempty"` - - - // CreatedByApp - The application that created the resource. - CreatedByApp *string `json:"createdByApp,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Schemacategory) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/schemacategoryentitylisting.go b/build/platformclientv2/schemacategoryentitylisting.go deleted file mode 100644 index ebb20f3bf..000000000 --- a/build/platformclientv2/schemacategoryentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Schemacategoryentitylisting -type Schemacategoryentitylisting struct { - // Entities - Entities *[]Schemacategory `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Schemacategoryentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/schemaquantitylimits.go b/build/platformclientv2/schemaquantitylimits.go deleted file mode 100644 index d633f2d4f..000000000 --- a/build/platformclientv2/schemaquantitylimits.go +++ /dev/null @@ -1,69 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Schemaquantitylimits -type Schemaquantitylimits struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // MinFieldNameCharacters - The minimum number of schema field name characters allowed. - MinFieldNameCharacters *int `json:"minFieldNameCharacters,omitempty"` - - - // MaxFieldNameCharacters - The maximum number of schema field name characters allowed. - MaxFieldNameCharacters *int `json:"maxFieldNameCharacters,omitempty"` - - - // MinFieldDescriptionCharacters - The minimum number of schema field description characters allowed. - MinFieldDescriptionCharacters *int `json:"minFieldDescriptionCharacters,omitempty"` - - - // MaxFieldDescriptionCharacters - The maximum number of schema field description characters allowed. - MaxFieldDescriptionCharacters *int `json:"maxFieldDescriptionCharacters,omitempty"` - - - // MinSchemaNameCharacters - The minimum number of schema name characters allowed. - MinSchemaNameCharacters *int `json:"minSchemaNameCharacters,omitempty"` - - - // MaxSchemaNameCharacters - The maximum number of schema name characters allowed. - MaxSchemaNameCharacters *int `json:"maxSchemaNameCharacters,omitempty"` - - - // MinSchemaDescriptionCharacters - The minimum number of schema description characters allowed. - MinSchemaDescriptionCharacters *int `json:"minSchemaDescriptionCharacters,omitempty"` - - - // MaxSchemaDescriptionCharacters - The maximum number of schema description characters allowed. - MaxSchemaDescriptionCharacters *int `json:"maxSchemaDescriptionCharacters,omitempty"` - - - // MaxNumberOfSchemasPerOrg - The maximum number of schema allowed per org. - MaxNumberOfSchemasPerOrg *int `json:"maxNumberOfSchemasPerOrg,omitempty"` - - - // MaxNumberOfFieldsPerSchema - The maximum number of schema fields allowed per schema. - MaxNumberOfFieldsPerSchema *int `json:"maxNumberOfFieldsPerSchema,omitempty"` - - - // MaxNumberOfFieldsPerOrg - The maximum number of schema fields allowed per organization across all of their schemas. - MaxNumberOfFieldsPerOrg *int `json:"maxNumberOfFieldsPerOrg,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Schemaquantitylimits) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/schemareferenceentitylisting.go b/build/platformclientv2/schemareferenceentitylisting.go deleted file mode 100644 index 82c09e7cb..000000000 --- a/build/platformclientv2/schemareferenceentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Schemareferenceentitylisting -type Schemareferenceentitylisting struct { - // Entities - Entities *[]Domainschemareference `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Schemareferenceentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/scimapi.go b/build/platformclientv2/scimapi.go deleted file mode 100644 index 47458370c..000000000 --- a/build/platformclientv2/scimapi.go +++ /dev/null @@ -1,2589 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "encoding/json" -) - -// SCIMApi provides functions for API endpoints -type SCIMApi struct { - Configuration *Configuration -} - -// NewSCIMApi creates an API instance using the default configuration -func NewSCIMApi() *SCIMApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating SCIMApi with base path: %s", strings.ToLower(config.BasePath))) - return &SCIMApi{ - Configuration: config, - } -} - -// NewSCIMApiWithConfig creates an API instance using the provided configuration -func NewSCIMApiWithConfig(config *Configuration) *SCIMApi { - config.Debugf("Creating SCIMApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &SCIMApi{ - Configuration: config, - } -} - -// DeleteScimUser invokes DELETE /api/v2/scim/users/{userId} -// -// Delete a user -// -// -func (a SCIMApi) DeleteScimUser(userId string, ifMatch string) (*Empty, *APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/scim/users/{userId}" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Empty) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling SCIMApi->DeleteScimUser") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", "application/scim+json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", -"application/scim+json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - // header params "If-Match" - headerParams["If-Match"] = ifMatch - - var successPayload *Empty - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// DeleteScimV2User invokes DELETE /api/v2/scim/v2/users/{userId} -// -// Delete a user -// -// -func (a SCIMApi) DeleteScimV2User(userId string, ifMatch string) (*Empty, *APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/scim/v2/users/{userId}" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Empty) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling SCIMApi->DeleteScimV2User") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", "application/scim+json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", -"application/scim+json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - // header params "If-Match" - headerParams["If-Match"] = ifMatch - - var successPayload *Empty - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetScimGroup invokes GET /api/v2/scim/groups/{groupId} -// -// Get a group -// -// -func (a SCIMApi) GetScimGroup(groupId string, attributes []string, excludedAttributes []string, ifNoneMatch string) (*Scimv2group, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/scim/groups/{groupId}" - path = strings.Replace(path, "{groupId}", fmt.Sprintf("%v", groupId), -1) - defaultReturn := new(Scimv2group) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'groupId' is set - if &groupId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'groupId' when calling SCIMApi->GetScimGroup") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range attributes { - queryParams["attributes"] = value - } - } else { - queryParams["attributes"] = a.Configuration.APIClient.ParameterToString(attributes, collectionFormat) - } - - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range excludedAttributes { - queryParams["excludedAttributes"] = value - } - } else { - queryParams["excludedAttributes"] = a.Configuration.APIClient.ParameterToString(excludedAttributes, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", "application/scim+json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", -"application/scim+json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - // header params "If-None-Match" - headerParams["If-None-Match"] = ifNoneMatch - - var successPayload *Scimv2group - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetScimGroups invokes GET /api/v2/scim/groups -// -// Get a list of groups -// -// -func (a SCIMApi) GetScimGroups(startIndex int, count int, attributes []string, excludedAttributes []string, filter string) (*Scimgrouplistresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/scim/groups" - defaultReturn := new(Scimgrouplistresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(startIndex).(string); ok { - if str != "" { - queryParams["startIndex"] = a.Configuration.APIClient.ParameterToString(startIndex, collectionFormat) - } - } else { - queryParams["startIndex"] = a.Configuration.APIClient.ParameterToString(startIndex, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(count).(string); ok { - if str != "" { - queryParams["count"] = a.Configuration.APIClient.ParameterToString(count, collectionFormat) - } - } else { - queryParams["count"] = a.Configuration.APIClient.ParameterToString(count, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range attributes { - queryParams["attributes"] = value - } - } else { - queryParams["attributes"] = a.Configuration.APIClient.ParameterToString(attributes, collectionFormat) - } - - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range excludedAttributes { - queryParams["excludedAttributes"] = value - } - } else { - queryParams["excludedAttributes"] = a.Configuration.APIClient.ParameterToString(excludedAttributes, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(filter).(string); ok { - if str != "" { - queryParams["filter"] = a.Configuration.APIClient.ParameterToString(filter, collectionFormat) - } - } else { - queryParams["filter"] = a.Configuration.APIClient.ParameterToString(filter, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", "application/scim+json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", -"application/scim+json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Scimgrouplistresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetScimResourcetype invokes GET /api/v2/scim/resourcetypes/{resourceType} -// -// Get a resource type -// -// -func (a SCIMApi) GetScimResourcetype(resourceType string) (*Scimconfigresourcetype, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/scim/resourcetypes/{resourceType}" - path = strings.Replace(path, "{resourceType}", fmt.Sprintf("%v", resourceType), -1) - defaultReturn := new(Scimconfigresourcetype) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'resourceType' is set - if &resourceType == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'resourceType' when calling SCIMApi->GetScimResourcetype") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", "application/scim+json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", -"application/scim+json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Scimconfigresourcetype - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetScimResourcetypes invokes GET /api/v2/scim/resourcetypes -// -// Get a list of resource types -// -// -func (a SCIMApi) GetScimResourcetypes() (*Scimconfigresourcetypeslistresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/scim/resourcetypes" - defaultReturn := new(Scimconfigresourcetypeslistresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", "application/scim+json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", -"application/scim+json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Scimconfigresourcetypeslistresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetScimSchema invokes GET /api/v2/scim/schemas/{schemaId} -// -// Get a SCIM schema -// -// -func (a SCIMApi) GetScimSchema(schemaId string) (*Scimv2schemadefinition, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/scim/schemas/{schemaId}" - path = strings.Replace(path, "{schemaId}", fmt.Sprintf("%v", schemaId), -1) - defaultReturn := new(Scimv2schemadefinition) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'schemaId' is set - if &schemaId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'schemaId' when calling SCIMApi->GetScimSchema") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", "application/scim+json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", -"application/scim+json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Scimv2schemadefinition - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetScimSchemas invokes GET /api/v2/scim/schemas -// -// Get a list of SCIM schemas -// -// -func (a SCIMApi) GetScimSchemas(filter string) (*Scimv2schemalistresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/scim/schemas" - defaultReturn := new(Scimv2schemalistresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(filter).(string); ok { - if str != "" { - queryParams["filter"] = a.Configuration.APIClient.ParameterToString(filter, collectionFormat) - } - } else { - queryParams["filter"] = a.Configuration.APIClient.ParameterToString(filter, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", "application/scim+json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", -"application/scim+json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Scimv2schemalistresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetScimServiceproviderconfig invokes GET /api/v2/scim/serviceproviderconfig -// -// Get a service provider's configuration -// -// -func (a SCIMApi) GetScimServiceproviderconfig(ifNoneMatch string) (*Scimserviceproviderconfig, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/scim/serviceproviderconfig" - defaultReturn := new(Scimserviceproviderconfig) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", "application/scim+json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", -"application/scim+json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - // header params "If-None-Match" - headerParams["If-None-Match"] = ifNoneMatch - - var successPayload *Scimserviceproviderconfig - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetScimUser invokes GET /api/v2/scim/users/{userId} -// -// Get a user -// -// -func (a SCIMApi) GetScimUser(userId string, attributes []string, excludedAttributes []string, ifNoneMatch string) (*Scimv2user, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/scim/users/{userId}" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Scimv2user) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling SCIMApi->GetScimUser") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range attributes { - queryParams["attributes"] = value - } - } else { - queryParams["attributes"] = a.Configuration.APIClient.ParameterToString(attributes, collectionFormat) - } - - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range excludedAttributes { - queryParams["excludedAttributes"] = value - } - } else { - queryParams["excludedAttributes"] = a.Configuration.APIClient.ParameterToString(excludedAttributes, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", "application/scim+json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", -"application/scim+json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - // header params "If-None-Match" - headerParams["If-None-Match"] = ifNoneMatch - - var successPayload *Scimv2user - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetScimUsers invokes GET /api/v2/scim/users -// -// Get a list of users -// -// To return all active users, do not use the filter parameter. To return inactive users, set the filter parameter to \"active eq false\". By default, returns SCIM attributes \"externalId\", \"enterprise-user:manager\", and \"roles\". To exclude these attributes, set the attributes parameter to \"id,active\" or the excludeAttributes parameter to \"externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\". -func (a SCIMApi) GetScimUsers(startIndex int, count int, attributes []string, excludedAttributes []string, filter string) (*Scimuserlistresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/scim/users" - defaultReturn := new(Scimuserlistresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(startIndex).(string); ok { - if str != "" { - queryParams["startIndex"] = a.Configuration.APIClient.ParameterToString(startIndex, collectionFormat) - } - } else { - queryParams["startIndex"] = a.Configuration.APIClient.ParameterToString(startIndex, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(count).(string); ok { - if str != "" { - queryParams["count"] = a.Configuration.APIClient.ParameterToString(count, collectionFormat) - } - } else { - queryParams["count"] = a.Configuration.APIClient.ParameterToString(count, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range attributes { - queryParams["attributes"] = value - } - } else { - queryParams["attributes"] = a.Configuration.APIClient.ParameterToString(attributes, collectionFormat) - } - - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range excludedAttributes { - queryParams["excludedAttributes"] = value - } - } else { - queryParams["excludedAttributes"] = a.Configuration.APIClient.ParameterToString(excludedAttributes, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(filter).(string); ok { - if str != "" { - queryParams["filter"] = a.Configuration.APIClient.ParameterToString(filter, collectionFormat) - } - } else { - queryParams["filter"] = a.Configuration.APIClient.ParameterToString(filter, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", "application/scim+json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", -"application/scim+json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Scimuserlistresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetScimV2Group invokes GET /api/v2/scim/v2/groups/{groupId} -// -// Get a group -// -// -func (a SCIMApi) GetScimV2Group(groupId string, attributes []string, excludedAttributes []string, ifNoneMatch string) (*Scimv2group, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/scim/v2/groups/{groupId}" - path = strings.Replace(path, "{groupId}", fmt.Sprintf("%v", groupId), -1) - defaultReturn := new(Scimv2group) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'groupId' is set - if &groupId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'groupId' when calling SCIMApi->GetScimV2Group") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range attributes { - queryParams["attributes"] = value - } - } else { - queryParams["attributes"] = a.Configuration.APIClient.ParameterToString(attributes, collectionFormat) - } - - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range excludedAttributes { - queryParams["excludedAttributes"] = value - } - } else { - queryParams["excludedAttributes"] = a.Configuration.APIClient.ParameterToString(excludedAttributes, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", "application/scim+json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", -"application/scim+json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - // header params "If-None-Match" - headerParams["If-None-Match"] = ifNoneMatch - - var successPayload *Scimv2group - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetScimV2Groups invokes GET /api/v2/scim/v2/groups -// -// Get a list of groups -// -// -func (a SCIMApi) GetScimV2Groups(filter string, startIndex int, count int, attributes []string, excludedAttributes []string) (*Scimgrouplistresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/scim/v2/groups" - defaultReturn := new(Scimgrouplistresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'filter' is set - if &filter == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'filter' when calling SCIMApi->GetScimV2Groups") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(startIndex).(string); ok { - if str != "" { - queryParams["startIndex"] = a.Configuration.APIClient.ParameterToString(startIndex, collectionFormat) - } - } else { - queryParams["startIndex"] = a.Configuration.APIClient.ParameterToString(startIndex, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(count).(string); ok { - if str != "" { - queryParams["count"] = a.Configuration.APIClient.ParameterToString(count, collectionFormat) - } - } else { - queryParams["count"] = a.Configuration.APIClient.ParameterToString(count, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range attributes { - queryParams["attributes"] = value - } - } else { - queryParams["attributes"] = a.Configuration.APIClient.ParameterToString(attributes, collectionFormat) - } - - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range excludedAttributes { - queryParams["excludedAttributes"] = value - } - } else { - queryParams["excludedAttributes"] = a.Configuration.APIClient.ParameterToString(excludedAttributes, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(filter).(string); ok { - if str != "" { - queryParams["filter"] = a.Configuration.APIClient.ParameterToString(filter, collectionFormat) - } - } else { - queryParams["filter"] = a.Configuration.APIClient.ParameterToString(filter, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", "application/scim+json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", -"application/scim+json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Scimgrouplistresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetScimV2Resourcetype invokes GET /api/v2/scim/v2/resourcetypes/{resourceType} -// -// Get a resource type -// -// -func (a SCIMApi) GetScimV2Resourcetype(resourceType string) (*Scimconfigresourcetype, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/scim/v2/resourcetypes/{resourceType}" - path = strings.Replace(path, "{resourceType}", fmt.Sprintf("%v", resourceType), -1) - defaultReturn := new(Scimconfigresourcetype) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'resourceType' is set - if &resourceType == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'resourceType' when calling SCIMApi->GetScimV2Resourcetype") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", "application/scim+json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", -"application/scim+json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Scimconfigresourcetype - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetScimV2Resourcetypes invokes GET /api/v2/scim/v2/resourcetypes -// -// Get a list of resource types -// -// -func (a SCIMApi) GetScimV2Resourcetypes() (*Scimconfigresourcetypeslistresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/scim/v2/resourcetypes" - defaultReturn := new(Scimconfigresourcetypeslistresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", "application/scim+json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", -"application/scim+json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Scimconfigresourcetypeslistresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetScimV2Schema invokes GET /api/v2/scim/v2/schemas/{schemaId} -// -// Get a SCIM schema -// -// -func (a SCIMApi) GetScimV2Schema(schemaId string) (*Scimv2schemadefinition, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/scim/v2/schemas/{schemaId}" - path = strings.Replace(path, "{schemaId}", fmt.Sprintf("%v", schemaId), -1) - defaultReturn := new(Scimv2schemadefinition) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'schemaId' is set - if &schemaId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'schemaId' when calling SCIMApi->GetScimV2Schema") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", "application/scim+json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", -"application/scim+json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Scimv2schemadefinition - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetScimV2Schemas invokes GET /api/v2/scim/v2/schemas -// -// Get a list of SCIM schemas -// -// -func (a SCIMApi) GetScimV2Schemas(filter string) (*Scimv2schemalistresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/scim/v2/schemas" - defaultReturn := new(Scimv2schemalistresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(filter).(string); ok { - if str != "" { - queryParams["filter"] = a.Configuration.APIClient.ParameterToString(filter, collectionFormat) - } - } else { - queryParams["filter"] = a.Configuration.APIClient.ParameterToString(filter, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", "application/scim+json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", -"application/scim+json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Scimv2schemalistresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetScimV2Serviceproviderconfig invokes GET /api/v2/scim/v2/serviceproviderconfig -// -// Get a service provider's configuration -// -// -func (a SCIMApi) GetScimV2Serviceproviderconfig(ifNoneMatch string) (*Scimserviceproviderconfig, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/scim/v2/serviceproviderconfig" - defaultReturn := new(Scimserviceproviderconfig) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", "application/scim+json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", -"application/scim+json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - // header params "If-None-Match" - headerParams["If-None-Match"] = ifNoneMatch - - var successPayload *Scimserviceproviderconfig - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetScimV2User invokes GET /api/v2/scim/v2/users/{userId} -// -// Get a user -// -// -func (a SCIMApi) GetScimV2User(userId string, attributes []string, excludedAttributes []string, ifNoneMatch string) (*Scimv2user, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/scim/v2/users/{userId}" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Scimv2user) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling SCIMApi->GetScimV2User") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range attributes { - queryParams["attributes"] = value - } - } else { - queryParams["attributes"] = a.Configuration.APIClient.ParameterToString(attributes, collectionFormat) - } - - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range excludedAttributes { - queryParams["excludedAttributes"] = value - } - } else { - queryParams["excludedAttributes"] = a.Configuration.APIClient.ParameterToString(excludedAttributes, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", "application/scim+json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", -"application/scim+json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - // header params "If-None-Match" - headerParams["If-None-Match"] = ifNoneMatch - - var successPayload *Scimv2user - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetScimV2Users invokes GET /api/v2/scim/v2/users -// -// Get a list of users -// -// To return all active users, do not use the filter parameter. To return inactive users, set the filter parameter to \"active eq false\". By default, returns SCIM attributes \"externalId\", \"enterprise-user:manager\", and \"roles\". To exclude these attributes, set the attributes parameter to \"id,active\" or the excludeAttributes parameter to \"externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\". -func (a SCIMApi) GetScimV2Users(startIndex int, count int, attributes []string, excludedAttributes []string, filter string) (*Scimuserlistresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/scim/v2/users" - defaultReturn := new(Scimuserlistresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(startIndex).(string); ok { - if str != "" { - queryParams["startIndex"] = a.Configuration.APIClient.ParameterToString(startIndex, collectionFormat) - } - } else { - queryParams["startIndex"] = a.Configuration.APIClient.ParameterToString(startIndex, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(count).(string); ok { - if str != "" { - queryParams["count"] = a.Configuration.APIClient.ParameterToString(count, collectionFormat) - } - } else { - queryParams["count"] = a.Configuration.APIClient.ParameterToString(count, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range attributes { - queryParams["attributes"] = value - } - } else { - queryParams["attributes"] = a.Configuration.APIClient.ParameterToString(attributes, collectionFormat) - } - - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range excludedAttributes { - queryParams["excludedAttributes"] = value - } - } else { - queryParams["excludedAttributes"] = a.Configuration.APIClient.ParameterToString(excludedAttributes, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(filter).(string); ok { - if str != "" { - queryParams["filter"] = a.Configuration.APIClient.ParameterToString(filter, collectionFormat) - } - } else { - queryParams["filter"] = a.Configuration.APIClient.ParameterToString(filter, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", "application/scim+json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", -"application/scim+json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Scimuserlistresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchScimGroup invokes PATCH /api/v2/scim/groups/{groupId} -// -// Modify a group -// -// -func (a SCIMApi) PatchScimGroup(groupId string, body Scimv2patchrequest, ifMatch string) (*Scimv2group, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/scim/groups/{groupId}" - path = strings.Replace(path, "{groupId}", fmt.Sprintf("%v", groupId), -1) - defaultReturn := new(Scimv2group) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'groupId' is set - if &groupId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'groupId' when calling SCIMApi->PatchScimGroup") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling SCIMApi->PatchScimGroup") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", "application/scim+json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", -"application/scim+json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - // header params "If-Match" - headerParams["If-Match"] = ifMatch - - // body params - postBody = &body - - var successPayload *Scimv2group - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchScimUser invokes PATCH /api/v2/scim/users/{userId} -// -// Modify a user -// -// -func (a SCIMApi) PatchScimUser(userId string, body Scimv2patchrequest, ifMatch string) (*Scimv2user, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/scim/users/{userId}" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Scimv2user) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling SCIMApi->PatchScimUser") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling SCIMApi->PatchScimUser") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", "application/scim+json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", -"application/scim+json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - // header params "If-Match" - headerParams["If-Match"] = ifMatch - - // body params - postBody = &body - - var successPayload *Scimv2user - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchScimV2Group invokes PATCH /api/v2/scim/v2/groups/{groupId} -// -// Modify a group -// -// -func (a SCIMApi) PatchScimV2Group(groupId string, body Scimv2patchrequest, ifMatch string) (*Scimv2group, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/scim/v2/groups/{groupId}" - path = strings.Replace(path, "{groupId}", fmt.Sprintf("%v", groupId), -1) - defaultReturn := new(Scimv2group) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'groupId' is set - if &groupId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'groupId' when calling SCIMApi->PatchScimV2Group") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling SCIMApi->PatchScimV2Group") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", "application/scim+json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", -"application/scim+json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - // header params "If-Match" - headerParams["If-Match"] = ifMatch - - // body params - postBody = &body - - var successPayload *Scimv2group - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchScimV2User invokes PATCH /api/v2/scim/v2/users/{userId} -// -// Modify a user -// -// -func (a SCIMApi) PatchScimV2User(userId string, body Scimv2patchrequest, ifMatch string) (*Scimv2user, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/scim/v2/users/{userId}" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Scimv2user) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling SCIMApi->PatchScimV2User") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling SCIMApi->PatchScimV2User") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", "application/scim+json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", -"application/scim+json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - // header params "If-Match" - headerParams["If-Match"] = ifMatch - - // body params - postBody = &body - - var successPayload *Scimv2user - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostScimUsers invokes POST /api/v2/scim/users -// -// Create a user -// -// -func (a SCIMApi) PostScimUsers(body Scimv2createuser) (*Scimv2user, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/scim/users" - defaultReturn := new(Scimv2user) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling SCIMApi->PostScimUsers") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", "application/scim+json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", -"application/scim+json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Scimv2user - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostScimV2Users invokes POST /api/v2/scim/v2/users -// -// Create a user -// -// -func (a SCIMApi) PostScimV2Users(body Scimv2createuser) (*Scimv2user, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/scim/v2/users" - defaultReturn := new(Scimv2user) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling SCIMApi->PostScimV2Users") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", "application/scim+json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", -"application/scim+json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Scimv2user - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutScimGroup invokes PUT /api/v2/scim/groups/{groupId} -// -// Replace a group -// -// -func (a SCIMApi) PutScimGroup(groupId string, body Scimv2group, ifMatch string) (*Scimv2group, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/scim/groups/{groupId}" - path = strings.Replace(path, "{groupId}", fmt.Sprintf("%v", groupId), -1) - defaultReturn := new(Scimv2group) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'groupId' is set - if &groupId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'groupId' when calling SCIMApi->PutScimGroup") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling SCIMApi->PutScimGroup") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", "application/scim+json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", -"application/scim+json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - // header params "If-Match" - headerParams["If-Match"] = ifMatch - - // body params - postBody = &body - - var successPayload *Scimv2group - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutScimUser invokes PUT /api/v2/scim/users/{userId} -// -// Replace a user -// -// -func (a SCIMApi) PutScimUser(userId string, body Scimv2user, ifMatch string) (*Scimv2user, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/scim/users/{userId}" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Scimv2user) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling SCIMApi->PutScimUser") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling SCIMApi->PutScimUser") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", "application/scim+json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", -"application/scim+json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - // header params "If-Match" - headerParams["If-Match"] = ifMatch - - // body params - postBody = &body - - var successPayload *Scimv2user - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutScimV2Group invokes PUT /api/v2/scim/v2/groups/{groupId} -// -// Replace a group -// -// -func (a SCIMApi) PutScimV2Group(groupId string, body Scimv2group, ifMatch string) (*Scimv2group, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/scim/v2/groups/{groupId}" - path = strings.Replace(path, "{groupId}", fmt.Sprintf("%v", groupId), -1) - defaultReturn := new(Scimv2group) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'groupId' is set - if &groupId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'groupId' when calling SCIMApi->PutScimV2Group") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling SCIMApi->PutScimV2Group") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", "application/scim+json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", -"application/scim+json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - // header params "If-Match" - headerParams["If-Match"] = ifMatch - - // body params - postBody = &body - - var successPayload *Scimv2group - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutScimV2User invokes PUT /api/v2/scim/v2/users/{userId} -// -// Replace a user -// -// -func (a SCIMApi) PutScimV2User(userId string, body Scimv2user, ifMatch string) (*Scimv2user, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/scim/v2/users/{userId}" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Scimv2user) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling SCIMApi->PutScimV2User") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling SCIMApi->PutScimV2User") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", "application/scim+json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", -"application/scim+json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - // header params "If-Match" - headerParams["If-Match"] = ifMatch - - // body params - postBody = &body - - var successPayload *Scimv2user - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/scimconfigresourcetype.go b/build/platformclientv2/scimconfigresourcetype.go deleted file mode 100644 index 8ab7fb899..000000000 --- a/build/platformclientv2/scimconfigresourcetype.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Scimconfigresourcetype - Defines a SCIM resource. -type Scimconfigresourcetype struct { - // Id - The ID of the SCIM resource. Set by the service provider. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readOnly\". \"returned\" is set to \"always\". - Id *string `json:"id,omitempty"` - - - // Schemas - The list of supported schemas. - Schemas *[]string `json:"schemas,omitempty"` - - - // Name - The name of the resource type. - Name *string `json:"name,omitempty"` - - - // Description - The description of the resource type. - Description *string `json:"description,omitempty"` - - - // Schema - The URI of the primary or base schema for the resource type. - Schema *string `json:"schema,omitempty"` - - - // SchemaExtensions - The list of schema extensions for the resource type. - SchemaExtensions *[]Scimconfigresourcetypeschemaextension `json:"schemaExtensions,omitempty"` - - - // Endpoint - The HTTP-addressable endpoint of the resource type. Appears after the base URL. - Endpoint *string `json:"endpoint,omitempty"` - - - // Meta - The metadata of the SCIM resource. Only \"location\" and \"resourceType\" are set for \"ResourceType\" resources. - Meta *Scimmetadata `json:"meta,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Scimconfigresourcetype) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/scimconfigresourcetypeschemaextension.go b/build/platformclientv2/scimconfigresourcetypeschemaextension.go deleted file mode 100644 index 8e6f0c687..000000000 --- a/build/platformclientv2/scimconfigresourcetypeschemaextension.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Scimconfigresourcetypeschemaextension - Defines a SCIM resource type's schema extension. -type Scimconfigresourcetypeschemaextension struct { - // Schema - The URI of an extended schema, for example, \"urn:edu:2.0:Staff\". Must be equal to the \"id\" attribute of a schema. - Schema *string `json:"schema,omitempty"` - - - // Required - Indicates whether a schema extension is required. - Required *bool `json:"required,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Scimconfigresourcetypeschemaextension) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/scimconfigresourcetypeslistresponse.go b/build/platformclientv2/scimconfigresourcetypeslistresponse.go deleted file mode 100644 index 6b6180881..000000000 --- a/build/platformclientv2/scimconfigresourcetypeslistresponse.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Scimconfigresourcetypeslistresponse - Defines a response for a list of SCIM resource types. -type Scimconfigresourcetypeslistresponse struct { - // TotalResults - The total number of results. - TotalResults *int `json:"totalResults,omitempty"` - - - // StartIndex - The 1-based index of the first result returned by this request. Add this to \"itemsPerPage\" when requesting the next page of results. - StartIndex *int `json:"startIndex,omitempty"` - - - // ItemsPerPage - The number of resources returned per page. - ItemsPerPage *int `json:"itemsPerPage,omitempty"` - - - // Resources - The list of requested resources. - Resources *[]Scimconfigresourcetype `json:"Resources,omitempty"` - - - // Schemas - The list of supported schemas. - Schemas *[]string `json:"schemas,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Scimconfigresourcetypeslistresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/scimemail.go b/build/platformclientv2/scimemail.go deleted file mode 100644 index 66b989a19..000000000 --- a/build/platformclientv2/scimemail.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Scimemail - Defines a SCIM email address. -type Scimemail struct { - // Value - The email address. Is immutable if \"type\" is set to \"other\". - Value *string `json:"value,omitempty"` - - - // VarType - The type of email address. \"value\" is immutable if \"type\" is set to \"other\". - VarType *string `json:"type,omitempty"` - - - // Primary - Indicates whether the email address is the primary email address. - Primary *bool `json:"primary,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Scimemail) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/scimerror.go b/build/platformclientv2/scimerror.go deleted file mode 100644 index dc0ef2e21..000000000 --- a/build/platformclientv2/scimerror.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Scimerror - Defines a SCIM error. -type Scimerror struct { - // Status - The HTTP status code returned for the SCIM error. - Status *string `json:"status,omitempty"` - - - // ScimType - The type of SCIM error when httpStatus is a \"400\" error. - ScimType *string `json:"scimType,omitempty"` - - - // Detail - The detailed description of the SCIM error. - Detail *string `json:"detail,omitempty"` - - - // Schemas - The list of schemas for the SCIM error. - Schemas *[]string `json:"schemas,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Scimerror) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/scimgenesysuserexternalid.go b/build/platformclientv2/scimgenesysuserexternalid.go deleted file mode 100644 index 9bae7e62e..000000000 --- a/build/platformclientv2/scimgenesysuserexternalid.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Scimgenesysuserexternalid - External Identifiers of user. The external identifier must be unique within the organization and the 'authority' -type Scimgenesysuserexternalid struct { - // Authority - Authority, or scope, of \"externalId\". Allows multiple external identifiers to be defined. Represents the source of the external identifier. - Authority *string `json:"authority,omitempty"` - - - // Value - Identifier of the user in an external system. - Value *string `json:"value,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Scimgenesysuserexternalid) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/scimgrouplistresponse.go b/build/platformclientv2/scimgrouplistresponse.go deleted file mode 100644 index b5f1f6fcf..000000000 --- a/build/platformclientv2/scimgrouplistresponse.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Scimgrouplistresponse - Defines a response for a list of SCIM groups. -type Scimgrouplistresponse struct { - // TotalResults - The total number of results. - TotalResults *int `json:"totalResults,omitempty"` - - - // StartIndex - The 1-based index of the first result returned by this request. Add this to \"itemsPerPage\" when requesting the next page of results. - StartIndex *int `json:"startIndex,omitempty"` - - - // ItemsPerPage - The number of resources returned per page. - ItemsPerPage *int `json:"itemsPerPage,omitempty"` - - - // Resources - The list of requested resources. If \"count\" is 0, then the list will be empty. - Resources *[]Scimv2group `json:"Resources,omitempty"` - - - // Schemas - The list of supported schemas. - Schemas *[]string `json:"schemas,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Scimgrouplistresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/scimmetadata.go b/build/platformclientv2/scimmetadata.go deleted file mode 100644 index 5d8540509..000000000 --- a/build/platformclientv2/scimmetadata.go +++ /dev/null @@ -1,30 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Scimmetadata - Defines the SCIM metadata. -type Scimmetadata struct { - // ResourceType - The type of SCIM resource. - ResourceType *string `json:"resourceType,omitempty"` - - - // LastModified - The last time that the resource was modified. Date time is represented as an \"ISO-8601 string\", for example, yyyy-MM-ddTHH:mm:ss.SSSZ. Not included with \"Schema\" and \"ResourceType\" resources. - LastModified *time.Time `json:"lastModified,omitempty"` - - - // Location - The URI of the resource. - Location *string `json:"location,omitempty"` - - - // Version - The version of the resource. Matches the ETag HTTP response header. Not included with \"Schema\" and \"ResourceType\" resources. - Version *string `json:"version,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Scimmetadata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/scimphonenumber.go b/build/platformclientv2/scimphonenumber.go deleted file mode 100644 index 42164dbc3..000000000 --- a/build/platformclientv2/scimphonenumber.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Scimphonenumber - Defines a SCIM phone number. -type Scimphonenumber struct { - // Value - The phone number in E.164 or tel URI format, for example, tel:+nnnnnnnn; ext=xxxxx. - Value *string `json:"value,omitempty"` - - - // VarType - The type of phone number. - VarType *string `json:"type,omitempty"` - - - // Primary - Indicates whether the phone number is the primary phone number. - Primary *bool `json:"primary,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Scimphonenumber) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/scimserviceproviderconfig.go b/build/platformclientv2/scimserviceproviderconfig.go deleted file mode 100644 index 2369fbccc..000000000 --- a/build/platformclientv2/scimserviceproviderconfig.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Scimserviceproviderconfig - Defines a SCIM service provider's configuration. -type Scimserviceproviderconfig struct { - // Schemas - The list of supported schemas. - Schemas *[]string `json:"schemas,omitempty"` - - - // DocumentationUri - The HTTP-addressable URL that points to the service provider's documentation. - DocumentationUri *string `json:"documentationUri,omitempty"` - - - // Patch - The \"patch\" configuration options. - Patch *Scimserviceproviderconfigsimplefeature `json:"patch,omitempty"` - - - // Filter - The \"filter\" configuration options. - Filter *Scimserviceproviderconfigfilterfeature `json:"filter,omitempty"` - - - // Etag - The \"etag\" configuration options. - Etag *Scimserviceproviderconfigsimplefeature `json:"etag,omitempty"` - - - // Sort - The \"sort\" configuration options. - Sort *Scimserviceproviderconfigsimplefeature `json:"sort,omitempty"` - - - // Bulk - The \"bulk\" configuration options. - Bulk *Scimserviceproviderconfigbulkfeature `json:"bulk,omitempty"` - - - // ChangePassword - The \"changePassword\" configuration options. - ChangePassword *Scimserviceproviderconfigsimplefeature `json:"changePassword,omitempty"` - - - // AuthenticationSchemes - The list of supported authentication schemes. - AuthenticationSchemes *[]Scimserviceproviderconfigauthenticationscheme `json:"authenticationSchemes,omitempty"` - - - // Meta - The metadata of the SCIM resource. - Meta *Scimmetadata `json:"meta,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Scimserviceproviderconfig) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/scimserviceproviderconfigauthenticationscheme.go b/build/platformclientv2/scimserviceproviderconfigauthenticationscheme.go deleted file mode 100644 index 5ba4e6ca1..000000000 --- a/build/platformclientv2/scimserviceproviderconfigauthenticationscheme.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Scimserviceproviderconfigauthenticationscheme - Defines an authentication scheme in the SCIM service provider's configuration. -type Scimserviceproviderconfigauthenticationscheme struct { - // Name - The name of the authentication scheme, for example, HTTP Basic. - Name *string `json:"name,omitempty"` - - - // Description - The description of the authentication scheme. - Description *string `json:"description,omitempty"` - - - // SpecUri - The HTTP-addressable URL that points to the authentication scheme's specification. - SpecUri *string `json:"specUri,omitempty"` - - - // DocumentationUri - The HTTP-addressable URL that points to the authentication scheme's usage documentation. - DocumentationUri *string `json:"documentationUri,omitempty"` - - - // VarType - The type of authentication scheme. - VarType *string `json:"type,omitempty"` - - - // Primary - Indicates whether this authentication scheme is the primary method of authentication. - Primary *bool `json:"primary,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Scimserviceproviderconfigauthenticationscheme) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/scimserviceproviderconfigbulkfeature.go b/build/platformclientv2/scimserviceproviderconfigbulkfeature.go deleted file mode 100644 index 906294df5..000000000 --- a/build/platformclientv2/scimserviceproviderconfigbulkfeature.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Scimserviceproviderconfigbulkfeature - Defines a \"bulk\" request in the SCIM service provider's configuration. -type Scimserviceproviderconfigbulkfeature struct { - // Supported - Indicates whether configuration options are supported. - Supported *bool `json:"supported,omitempty"` - - - // MaxOperations - The maximum number of operations for each bulk request. - MaxOperations *int `json:"maxOperations,omitempty"` - - - // MaxPayloadSize - The maximum payload size. - MaxPayloadSize *int `json:"maxPayloadSize,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Scimserviceproviderconfigbulkfeature) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/scimserviceproviderconfigfilterfeature.go b/build/platformclientv2/scimserviceproviderconfigfilterfeature.go deleted file mode 100644 index 4225a31b9..000000000 --- a/build/platformclientv2/scimserviceproviderconfigfilterfeature.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Scimserviceproviderconfigfilterfeature - Defines a \"filter\" request in the SCIM service provider's configuration. -type Scimserviceproviderconfigfilterfeature struct { - // Supported - Indicates whether configuration options are supported. - Supported *bool `json:"supported,omitempty"` - - - // MaxResults - The maximum number of results returned from a filtered query. - MaxResults *int `json:"maxResults,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Scimserviceproviderconfigfilterfeature) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/scimserviceproviderconfigsimplefeature.go b/build/platformclientv2/scimserviceproviderconfigsimplefeature.go deleted file mode 100644 index b32495a1a..000000000 --- a/build/platformclientv2/scimserviceproviderconfigsimplefeature.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Scimserviceproviderconfigsimplefeature - Defines a request in the SCIM service provider's configuration. -type Scimserviceproviderconfigsimplefeature struct { - // Supported - Indicates whether configuration options are supported. - Supported *bool `json:"supported,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Scimserviceproviderconfigsimplefeature) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/scimuserextensions.go b/build/platformclientv2/scimuserextensions.go deleted file mode 100644 index c0c19a0a0..000000000 --- a/build/platformclientv2/scimuserextensions.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Scimuserextensions - Genesys Cloud user extensions to SCIM RFC. -type Scimuserextensions struct { - // RoutingSkills - The list of routing skills assigned to a user. Maximum 50 skills. - RoutingSkills *[]Scimuserroutingskill `json:"routingSkills,omitempty"` - - - // RoutingLanguages - The list of routing languages assigned to a user. Maximum 50 languages. - RoutingLanguages *[]Scimuserroutinglanguage `json:"routingLanguages,omitempty"` - - - // ExternalIds - The list of external identifiers assigned to user. Always includes an immutable SCIM authority prefixed with \"x-pc:scimv2:v1\". - ExternalIds *[]Scimgenesysuserexternalid `json:"externalIds,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Scimuserextensions) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/scimuserlistresponse.go b/build/platformclientv2/scimuserlistresponse.go deleted file mode 100644 index 455eca79d..000000000 --- a/build/platformclientv2/scimuserlistresponse.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Scimuserlistresponse - Defines a response for a list of SCIM users. -type Scimuserlistresponse struct { - // TotalResults - The total number of results. - TotalResults *int `json:"totalResults,omitempty"` - - - // StartIndex - The 1-based index of the first result returned by this request. Add this to \"itemsPerPage\" when requesting the next page of results. - StartIndex *int `json:"startIndex,omitempty"` - - - // ItemsPerPage - The number of resources returned per page. - ItemsPerPage *int `json:"itemsPerPage,omitempty"` - - - // Resources - The list of requested resources. If \"count\" is 0, then the list will be empty. - Resources *[]Scimv2user `json:"Resources,omitempty"` - - - // Schemas - The list of supported schemas. - Schemas *[]string `json:"schemas,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Scimuserlistresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/scimuserrole.go b/build/platformclientv2/scimuserrole.go deleted file mode 100644 index 24e06cf19..000000000 --- a/build/platformclientv2/scimuserrole.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Scimuserrole - Defines a user role. -type Scimuserrole struct { - // Value - The role of the Genesys Cloud user. - Value *string `json:"value,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Scimuserrole) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/scimuserroutinglanguage.go b/build/platformclientv2/scimuserroutinglanguage.go deleted file mode 100644 index b46f4d780..000000000 --- a/build/platformclientv2/scimuserroutinglanguage.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Scimuserroutinglanguage - The routing language assigned to a user. -type Scimuserroutinglanguage struct { - // Name - The case-sensitive name of a routing language configured in Genesys Cloud. - Name *string `json:"name,omitempty"` - - - // Proficiency - A rating from 0.0 to 5.0 that indicates how fluent an agent is in a particular language. ACD interactions are routed to agents with higher proficiency ratings. - Proficiency *float64 `json:"proficiency,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Scimuserroutinglanguage) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/scimuserroutingskill.go b/build/platformclientv2/scimuserroutingskill.go deleted file mode 100644 index 5c213db3a..000000000 --- a/build/platformclientv2/scimuserroutingskill.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Scimuserroutingskill - The routing skill assigned to a user. -type Scimuserroutingskill struct { - // Name - The case-sensitive name of a routing skill configured in Genesys Cloud. - Name *string `json:"name,omitempty"` - - - // Proficiency - A rating from 0.0 to 5.0 that indicates how adept an agent is at a particular skill. When \"Best available skills\" is enabled for a queue in Genesys Cloud, ACD interactions in that queue are routed to agents with higher proficiency ratings. - Proficiency *float64 `json:"proficiency,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Scimuserroutingskill) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/scimv2createuser.go b/build/platformclientv2/scimv2createuser.go deleted file mode 100644 index 83c959168..000000000 --- a/build/platformclientv2/scimv2createuser.go +++ /dev/null @@ -1,65 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Scimv2createuser - Defines the creation of a SCIM user. -type Scimv2createuser struct { - // Schemas - The list of supported schemas. - Schemas *[]string `json:"schemas,omitempty"` - - - // Active - Indicates whether the user's administrative status is active. - Active *bool `json:"active,omitempty"` - - - // UserName - The user's Genesys Cloud email address. Must be unique. - UserName *string `json:"userName,omitempty"` - - - // DisplayName - The display name of the user. - DisplayName *string `json:"displayName,omitempty"` - - - // Password - The new password for the Genesys Cloud user. Does not return an existing password. When creating a user, if a password is not supplied, then a password will be randomly generated that is 40 characters in length and contains five characters from each of the password policy groups. - Password *string `json:"password,omitempty"` - - - // Title - The user's title. - Title *string `json:"title,omitempty"` - - - // PhoneNumbers - The list of the user's phone numbers. - PhoneNumbers *[]Scimphonenumber `json:"phoneNumbers,omitempty"` - - - // Emails - The list of the user's email addresses. - Emails *[]Scimemail `json:"emails,omitempty"` - - - // ExternalId - The external ID of the user. Set by the provisioning client. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readWrite\". - ExternalId *string `json:"externalId,omitempty"` - - - // Groups - The list of groups that the user is a member of. - Groups *[]Scimv2groupreference `json:"groups,omitempty"` - - - // Roles - The list of roles assigned to the user. - Roles *[]Scimuserrole `json:"roles,omitempty"` - - - // UrnIetfParamsScimSchemasExtensionEnterprise20User - The URI of the schema for the enterprise user. - UrnIetfParamsScimSchemasExtensionEnterprise20User *Scimv2enterpriseuser `json:"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User,omitempty"` - - - // UrnIetfParamsScimSchemasExtensionGenesysPurecloud20User - The URI of the schema for the Genesys Cloud user. - UrnIetfParamsScimSchemasExtensionGenesysPurecloud20User *Scimuserextensions `json:"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Scimv2createuser) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/scimv2enterpriseuser.go b/build/platformclientv2/scimv2enterpriseuser.go deleted file mode 100644 index a1fd43dea..000000000 --- a/build/platformclientv2/scimv2enterpriseuser.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Scimv2enterpriseuser - Defines a SCIM enterprise user. -type Scimv2enterpriseuser struct { - // Division - The division that the user belongs to. - Division *string `json:"division,omitempty"` - - - // Department - The department that the user belongs to. - Department *string `json:"department,omitempty"` - - - // Manager - The user's manager. - Manager *Manager `json:"manager,omitempty"` - - - // EmployeeNumber - The user's employee number. - EmployeeNumber *string `json:"employeeNumber,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Scimv2enterpriseuser) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/scimv2group.go b/build/platformclientv2/scimv2group.go deleted file mode 100644 index a8db45cde..000000000 --- a/build/platformclientv2/scimv2group.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Scimv2group - Defines a SCIM group. -type Scimv2group struct { - // Id - The ID of the SCIM resource. Set by the service provider. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readOnly\". \"returned\" is set to \"always\". - Id *string `json:"id,omitempty"` - - - // Schemas - The list of supported schemas. - Schemas *[]string `json:"schemas,omitempty"` - - - // DisplayName - The display name of the group. - DisplayName *string `json:"displayName,omitempty"` - - - // ExternalId - The external ID of the group. Set by the provisioning client. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readWrite\". - ExternalId *string `json:"externalId,omitempty"` - - - // Members - The list of members in the group. - Members *[]Scimv2memberreference `json:"members,omitempty"` - - - // Meta - The metadata of the SCIM resource. - Meta *Scimmetadata `json:"meta,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Scimv2group) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/scimv2groupreference.go b/build/platformclientv2/scimv2groupreference.go deleted file mode 100644 index 712a49405..000000000 --- a/build/platformclientv2/scimv2groupreference.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Scimv2groupreference - Defines a reference to SCIM groups. -type Scimv2groupreference struct { - // VarType - The type of SCIM resource. - VarType *string `json:"type,omitempty"` - - - // Value - The ID of the group member. Can be \"userId\" or \"groupId\". - Value *string `json:"value,omitempty"` - - - // Ref - The reference URI of the SCIM resource. - Ref *string `json:"$ref,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Scimv2groupreference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/scimv2memberreference.go b/build/platformclientv2/scimv2memberreference.go deleted file mode 100644 index f73a48441..000000000 --- a/build/platformclientv2/scimv2memberreference.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Scimv2memberreference - Defines a reference to SCIM group members. -type Scimv2memberreference struct { - // VarType - The type of SCIM resource. - VarType *string `json:"type,omitempty"` - - - // Value - The ID of the group member. Can be \"userId\" or \"groupId\". - Value *string `json:"value,omitempty"` - - - // Ref - The reference URI of the SCIM resource. - Ref *string `json:"$ref,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Scimv2memberreference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/scimv2patchoperation.go b/build/platformclientv2/scimv2patchoperation.go deleted file mode 100644 index e0f63d02b..000000000 --- a/build/platformclientv2/scimv2patchoperation.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Scimv2patchoperation - Defines a SCIM PATCH operation. The path and value follow very specific rules based on operation types. See section 3.5.2 \"Modifying with PATCH\" in RFC 7644 for details. -type Scimv2patchoperation struct { - // Op - The PATCH operation to perform. - Op *string `json:"op,omitempty"` - - - // Path - The attribute path that describes the target of the operation. Required for a \"remove\" operation. - Path *string `json:"path,omitempty"` - - - // Value - The value to set in the path. - Value *Jsonnode `json:"value,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Scimv2patchoperation) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/scimv2patchrequest.go b/build/platformclientv2/scimv2patchrequest.go deleted file mode 100644 index 5b9a3b080..000000000 --- a/build/platformclientv2/scimv2patchrequest.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Scimv2patchrequest - Defines a SCIM PATCH request. See section 3.5.2 \"Modifying with PATCH\" in RFC 7644 for details. -type Scimv2patchrequest struct { - // Schemas - The list of schemas used in the PATCH request. - Schemas *[]string `json:"schemas,omitempty"` - - - // Operations - The list of operations to perform for the PATCH request. - Operations *[]Scimv2patchoperation `json:"Operations,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Scimv2patchrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/scimv2schemaattribute.go b/build/platformclientv2/scimv2schemaattribute.go deleted file mode 100644 index 007b3ab4b..000000000 --- a/build/platformclientv2/scimv2schemaattribute.go +++ /dev/null @@ -1,61 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Scimv2schemaattribute - A complex type that defines service provider attributes or subattributes and their qualities. -type Scimv2schemaattribute struct { - // Name - The name of the attribute. - Name *string `json:"name,omitempty"` - - - // VarType - The data type of the attribute. - VarType *string `json:"type,omitempty"` - - - // SubAttributes - The list of subattributes for an attribute of the type \"complex\". Uses the same schema as \"attributes\". - SubAttributes *[]Scimv2schemaattribute `json:"subAttributes,omitempty"` - - - // MultiValued - Indicates whether an attribute contains multiple values. - MultiValued *bool `json:"multiValued,omitempty"` - - - // Description - The description of the attribute. - Description *string `json:"description,omitempty"` - - - // Required - Indicates whether an attribute is required. - Required *bool `json:"required,omitempty"` - - - // CanonicalValues - The list of standard values that service providers may use. Service providers may ignore unsupported values. - CanonicalValues *[]string `json:"canonicalValues,omitempty"` - - - // CaseExact - Indicates whether a string attribute is case-sensitive. If set to \"true\", the server preserves case sensitivity. If set to \"false\", the server may change the case. The server also uses case sensitivity when evaluating filters. See section 3.4.2.2 \"Filtering\" in RFC 7644 for details. - CaseExact *bool `json:"caseExact,omitempty"` - - - // Mutability - The circumstances under which an attribute can be defined or redefined. The default is \"readWrite\". - Mutability *string `json:"mutability,omitempty"` - - - // Returned - The circumstances under which an attribute and its values are returned in response to a GET, PUT, POST, or PATCH request. - Returned *string `json:"returned,omitempty"` - - - // Uniqueness - The method by which the service provider enforces the uniqueness of an attribute value. A server can reject a value by returning the HTTP response code 400 (Bad Request). A client can enforce uniqueness to a greater degree than the server provider enforces. For example, a client could make a value unique even though the server has \"uniqueness\" set to \"none\". - Uniqueness *string `json:"uniqueness,omitempty"` - - - // ReferenceTypes - The list of SCIM resource types that may be referenced. Only applies when \"type\" is set to \"reference\". - ReferenceTypes *[]string `json:"referenceTypes,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Scimv2schemaattribute) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/scimv2schemadefinition.go b/build/platformclientv2/scimv2schemadefinition.go deleted file mode 100644 index 24a313f01..000000000 --- a/build/platformclientv2/scimv2schemadefinition.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Scimv2schemadefinition - Defines a SCIM schema. -type Scimv2schemadefinition struct { - // Id - The ID of the SCIM resource. Set by the service provider. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readOnly\". \"returned\" is set to \"always\". - Id *string `json:"id,omitempty"` - - - // Name - The name of the schema. - Name *string `json:"name,omitempty"` - - - // Description - The description of the schema. - Description *string `json:"description,omitempty"` - - - // Attributes - The list of service provider attributes. - Attributes *[]Scimv2schemaattribute `json:"attributes,omitempty"` - - - // Meta - The metadata of the SCIM resource. Only \"location\" and \"resourceType\" are set for \"Schema\" resources. - Meta *Scimmetadata `json:"meta,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Scimv2schemadefinition) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/scimv2schemalistresponse.go b/build/platformclientv2/scimv2schemalistresponse.go deleted file mode 100644 index bb8d9e93d..000000000 --- a/build/platformclientv2/scimv2schemalistresponse.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Scimv2schemalistresponse - Defines the list response for SCIM resource types. -type Scimv2schemalistresponse struct { - // TotalResults - The total number of results. - TotalResults *int `json:"totalResults,omitempty"` - - - // StartIndex - The 1-based index of the first result returned by this request. Add this to \"itemsPerPage\" when requesting the next page of results. - StartIndex *int `json:"startIndex,omitempty"` - - - // ItemsPerPage - The number of resources returned per page. - ItemsPerPage *int `json:"itemsPerPage,omitempty"` - - - // Resources - The list of requested resources. - Resources *[]Scimv2schemadefinition `json:"Resources,omitempty"` - - - // Schemas - The list of supported schemas. - Schemas *[]string `json:"schemas,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Scimv2schemalistresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/scimv2user.go b/build/platformclientv2/scimv2user.go deleted file mode 100644 index d9b3f73e9..000000000 --- a/build/platformclientv2/scimv2user.go +++ /dev/null @@ -1,73 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Scimv2user - Defines a SCIM user. -type Scimv2user struct { - // Id - The ID of the SCIM resource. Set by the service provider. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readOnly\". \"returned\" is set to \"always\". - Id *string `json:"id,omitempty"` - - - // Schemas - The list of supported schemas. - Schemas *[]string `json:"schemas,omitempty"` - - - // Active - Indicates whether the user's administrative status is active. - Active *bool `json:"active,omitempty"` - - - // UserName - The user's Genesys Cloud email address. Must be unique. - UserName *string `json:"userName,omitempty"` - - - // DisplayName - The display name of the user. - DisplayName *string `json:"displayName,omitempty"` - - - // Password - The new password for the Genesys Cloud user. Does not return an existing password. When creating a user, if a password is not supplied, then a password will be randomly generated that is 40 characters in length and contains five characters from each of the password policy groups. - Password *string `json:"password,omitempty"` - - - // Title - The user's title. - Title *string `json:"title,omitempty"` - - - // PhoneNumbers - The list of the user's phone numbers. - PhoneNumbers *[]Scimphonenumber `json:"phoneNumbers,omitempty"` - - - // Emails - The list of the user's email addresses. - Emails *[]Scimemail `json:"emails,omitempty"` - - - // ExternalId - The external ID of the user. Set by the provisioning client. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readWrite\". - ExternalId *string `json:"externalId,omitempty"` - - - // Groups - The list of groups that the user is a member of. - Groups *[]Scimv2groupreference `json:"groups,omitempty"` - - - // Roles - The list of roles assigned to the user. - Roles *[]Scimuserrole `json:"roles,omitempty"` - - - // UrnIetfParamsScimSchemasExtensionEnterprise20User - The URI of the schema for the enterprise user. - UrnIetfParamsScimSchemasExtensionEnterprise20User *Scimv2enterpriseuser `json:"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User,omitempty"` - - - // UrnIetfParamsScimSchemasExtensionGenesysPurecloud20User - The URI of the schema for the Genesys Cloud user. - UrnIetfParamsScimSchemasExtensionGenesysPurecloud20User *Scimuserextensions `json:"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User,omitempty"` - - - // Meta - The metadata of the SCIM resource. - Meta *Scimmetadata `json:"meta,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Scimv2user) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/scorablesurvey.go b/build/platformclientv2/scorablesurvey.go deleted file mode 100644 index 8e278dfc5..000000000 --- a/build/platformclientv2/scorablesurvey.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Scorablesurvey -type Scorablesurvey struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // SurveyForm - Survey form used for this survey. - SurveyForm *Surveyform `json:"surveyForm,omitempty"` - - - // Status - Status *string `json:"status,omitempty"` - - - // Answers - Answers *Surveyscoringset `json:"answers,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Scorablesurvey) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/scoredagent.go b/build/platformclientv2/scoredagent.go deleted file mode 100644 index 980083232..000000000 --- a/build/platformclientv2/scoredagent.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Scoredagent -type Scoredagent struct { - // Agent - The agent - Agent *Addressableentityref `json:"agent,omitempty"` - - - // Score - Agent's score for the current conversation, from 0 - 100, higher being better - Score *int `json:"score,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Scoredagent) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/screenrecordingsession.go b/build/platformclientv2/screenrecordingsession.go deleted file mode 100644 index 4089c0424..000000000 --- a/build/platformclientv2/screenrecordingsession.go +++ /dev/null @@ -1,42 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Screenrecordingsession -type Screenrecordingsession struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // User - User *User `json:"user,omitempty"` - - - // CommunicationId - The id of the communication that is being recorded on the conversation - CommunicationId *string `json:"communicationId,omitempty"` - - - // Conversation - Conversation *Conversation `json:"conversation,omitempty"` - - - // StartTime - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartTime *time.Time `json:"startTime,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Screenrecordingsession) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/screenrecordingsessionlisting.go b/build/platformclientv2/screenrecordingsessionlisting.go deleted file mode 100644 index fd4bc5f2e..000000000 --- a/build/platformclientv2/screenrecordingsessionlisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Screenrecordingsessionlisting -type Screenrecordingsessionlisting struct { - // Entities - Entities *[]Screenrecordingsession `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Screenrecordingsessionlisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/screenrecordingsessionrequest.go b/build/platformclientv2/screenrecordingsessionrequest.go deleted file mode 100644 index 761a1e90d..000000000 --- a/build/platformclientv2/screenrecordingsessionrequest.go +++ /dev/null @@ -1,26 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Screenrecordingsessionrequest -type Screenrecordingsessionrequest struct { - // State - The screen recording session's state. Values can be: 'stopped' - State *string `json:"state,omitempty"` - - - // ArchiveDate - The screen recording session's archive date. Must be greater than 1 day from now if set. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ArchiveDate *time.Time `json:"archiveDate,omitempty"` - - - // DeleteDate - The screen recording session's delete date. Must be greater than archiveDate if set, otherwise one day from now. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DeleteDate *time.Time `json:"deleteDate,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Screenrecordingsessionrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/screenshare.go b/build/platformclientv2/screenshare.go deleted file mode 100644 index d7e8f1432..000000000 --- a/build/platformclientv2/screenshare.go +++ /dev/null @@ -1,74 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Screenshare -type Screenshare struct { - // State - The connection state of this communication. - State *string `json:"state,omitempty"` - - - // Id - A globally unique identifier for this communication. - Id *string `json:"id,omitempty"` - - - // Context - The room id context (xmpp jid) for the conference session. - Context *string `json:"context,omitempty"` - - - // Sharing - Indicates whether this participant is sharing their screen. - Sharing *bool `json:"sharing,omitempty"` - - - // PeerCount - The number of peer participants from the perspective of the participant in the conference. - PeerCount *int `json:"peerCount,omitempty"` - - - // DisconnectType - System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects. - DisconnectType *string `json:"disconnectType,omitempty"` - - - // StartAlertingTime - The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartAlertingTime *time.Time `json:"startAlertingTime,omitempty"` - - - // ConnectedTime - The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // DisconnectedTime - The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"` - - - // Provider - The source provider for the screen share. - Provider *string `json:"provider,omitempty"` - - - // PeerId - The id of the peer communication corresponding to a matching leg for this communication. - PeerId *string `json:"peerId,omitempty"` - - - // Segments - The time line of the participant's call, divided into activity segments. - Segments *[]Segment `json:"segments,omitempty"` - - - // Wrapup - Call wrap up or disposition data. - Wrapup *Wrapup `json:"wrapup,omitempty"` - - - // AfterCallWork - After-call work for the communication. - AfterCallWork *Aftercallwork `json:"afterCallWork,omitempty"` - - - // AfterCallWorkRequired - Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested. - AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Screenshare) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/script.go b/build/platformclientv2/script.go deleted file mode 100644 index cc6f92677..000000000 --- a/build/platformclientv2/script.go +++ /dev/null @@ -1,70 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Script -type Script struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // VersionId - VersionId *string `json:"versionId,omitempty"` - - - // CreatedDate - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - CreatedDate *time.Time `json:"createdDate,omitempty"` - - - // ModifiedDate - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ModifiedDate *time.Time `json:"modifiedDate,omitempty"` - - - // PublishedDate - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - PublishedDate *time.Time `json:"publishedDate,omitempty"` - - - // VersionDate - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - VersionDate *time.Time `json:"versionDate,omitempty"` - - - // StartPageId - StartPageId *string `json:"startPageId,omitempty"` - - - // StartPageName - StartPageName *string `json:"startPageName,omitempty"` - - - // Features - Features *map[string]interface{} `json:"features,omitempty"` - - - // Variables - Variables *map[string]interface{} `json:"variables,omitempty"` - - - // CustomActions - CustomActions *map[string]interface{} `json:"customActions,omitempty"` - - - // Pages - Pages *[]Page `json:"pages,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Script) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/scriptentitylisting.go b/build/platformclientv2/scriptentitylisting.go deleted file mode 100644 index ceef8fc34..000000000 --- a/build/platformclientv2/scriptentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Scriptentitylisting -type Scriptentitylisting struct { - // Entities - Entities *[]Script `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Scriptentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/scriptsapi.go b/build/platformclientv2/scriptsapi.go deleted file mode 100644 index c3f8a49bb..000000000 --- a/build/platformclientv2/scriptsapi.go +++ /dev/null @@ -1,1124 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "encoding/json" -) - -// ScriptsApi provides functions for API endpoints -type ScriptsApi struct { - Configuration *Configuration -} - -// NewScriptsApi creates an API instance using the default configuration -func NewScriptsApi() *ScriptsApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating ScriptsApi with base path: %s", strings.ToLower(config.BasePath))) - return &ScriptsApi{ - Configuration: config, - } -} - -// NewScriptsApiWithConfig creates an API instance using the provided configuration -func NewScriptsApiWithConfig(config *Configuration) *ScriptsApi { - config.Debugf("Creating ScriptsApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &ScriptsApi{ - Configuration: config, - } -} - -// GetScript invokes GET /api/v2/scripts/{scriptId} -// -// Get a script -// -// -func (a ScriptsApi) GetScript(scriptId string) (*Script, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/scripts/{scriptId}" - path = strings.Replace(path, "{scriptId}", fmt.Sprintf("%v", scriptId), -1) - defaultReturn := new(Script) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'scriptId' is set - if &scriptId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'scriptId' when calling ScriptsApi->GetScript") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Script - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetScriptPage invokes GET /api/v2/scripts/{scriptId}/pages/{pageId} -// -// Get a page -// -// -func (a ScriptsApi) GetScriptPage(scriptId string, pageId string, scriptDataVersion string) (*Page, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/scripts/{scriptId}/pages/{pageId}" - path = strings.Replace(path, "{scriptId}", fmt.Sprintf("%v", scriptId), -1) - path = strings.Replace(path, "{pageId}", fmt.Sprintf("%v", pageId), -1) - defaultReturn := new(Page) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'scriptId' is set - if &scriptId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'scriptId' when calling ScriptsApi->GetScriptPage") - } - // verify the required parameter 'pageId' is set - if &pageId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'pageId' when calling ScriptsApi->GetScriptPage") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(scriptDataVersion).(string); ok { - if str != "" { - queryParams["scriptDataVersion"] = a.Configuration.APIClient.ParameterToString(scriptDataVersion, collectionFormat) - } - } else { - queryParams["scriptDataVersion"] = a.Configuration.APIClient.ParameterToString(scriptDataVersion, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Page - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetScriptPages invokes GET /api/v2/scripts/{scriptId}/pages -// -// Get the list of pages -// -// -func (a ScriptsApi) GetScriptPages(scriptId string, scriptDataVersion string) ([]Page, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/scripts/{scriptId}/pages" - path = strings.Replace(path, "{scriptId}", fmt.Sprintf("%v", scriptId), -1) - defaultReturn := make([]Page, 0) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'scriptId' is set - if &scriptId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'scriptId' when calling ScriptsApi->GetScriptPages") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(scriptDataVersion).(string); ok { - if str != "" { - queryParams["scriptDataVersion"] = a.Configuration.APIClient.ParameterToString(scriptDataVersion, collectionFormat) - } - } else { - queryParams["scriptDataVersion"] = a.Configuration.APIClient.ParameterToString(scriptDataVersion, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload []Page - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetScripts invokes GET /api/v2/scripts -// -// Get the list of scripts -// -// -func (a ScriptsApi) GetScripts(pageSize int, pageNumber int, expand string, name string, feature string, flowId string, sortBy string, sortOrder string, scriptDataVersion string) (*Scriptentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/scripts" - defaultReturn := new(Scriptentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(expand).(string); ok { - if str != "" { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(feature).(string); ok { - if str != "" { - queryParams["feature"] = a.Configuration.APIClient.ParameterToString(feature, collectionFormat) - } - } else { - queryParams["feature"] = a.Configuration.APIClient.ParameterToString(feature, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(flowId).(string); ok { - if str != "" { - queryParams["flowId"] = a.Configuration.APIClient.ParameterToString(flowId, collectionFormat) - } - } else { - queryParams["flowId"] = a.Configuration.APIClient.ParameterToString(flowId, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(scriptDataVersion).(string); ok { - if str != "" { - queryParams["scriptDataVersion"] = a.Configuration.APIClient.ParameterToString(scriptDataVersion, collectionFormat) - } - } else { - queryParams["scriptDataVersion"] = a.Configuration.APIClient.ParameterToString(scriptDataVersion, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Scriptentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetScriptsPublished invokes GET /api/v2/scripts/published -// -// Get the published scripts. -// -// -func (a ScriptsApi) GetScriptsPublished(pageSize int, pageNumber int, expand string, name string, feature string, flowId string, scriptDataVersion string) (*Scriptentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/scripts/published" - defaultReturn := new(Scriptentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(expand).(string); ok { - if str != "" { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(feature).(string); ok { - if str != "" { - queryParams["feature"] = a.Configuration.APIClient.ParameterToString(feature, collectionFormat) - } - } else { - queryParams["feature"] = a.Configuration.APIClient.ParameterToString(feature, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(flowId).(string); ok { - if str != "" { - queryParams["flowId"] = a.Configuration.APIClient.ParameterToString(flowId, collectionFormat) - } - } else { - queryParams["flowId"] = a.Configuration.APIClient.ParameterToString(flowId, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(scriptDataVersion).(string); ok { - if str != "" { - queryParams["scriptDataVersion"] = a.Configuration.APIClient.ParameterToString(scriptDataVersion, collectionFormat) - } - } else { - queryParams["scriptDataVersion"] = a.Configuration.APIClient.ParameterToString(scriptDataVersion, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Scriptentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetScriptsPublishedScriptId invokes GET /api/v2/scripts/published/{scriptId} -// -// Get the published script. -// -// -func (a ScriptsApi) GetScriptsPublishedScriptId(scriptId string, scriptDataVersion string) (*Script, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/scripts/published/{scriptId}" - path = strings.Replace(path, "{scriptId}", fmt.Sprintf("%v", scriptId), -1) - defaultReturn := new(Script) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'scriptId' is set - if &scriptId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'scriptId' when calling ScriptsApi->GetScriptsPublishedScriptId") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(scriptDataVersion).(string); ok { - if str != "" { - queryParams["scriptDataVersion"] = a.Configuration.APIClient.ParameterToString(scriptDataVersion, collectionFormat) - } - } else { - queryParams["scriptDataVersion"] = a.Configuration.APIClient.ParameterToString(scriptDataVersion, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Script - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetScriptsPublishedScriptIdPage invokes GET /api/v2/scripts/published/{scriptId}/pages/{pageId} -// -// Get the published page. -// -// -func (a ScriptsApi) GetScriptsPublishedScriptIdPage(scriptId string, pageId string, scriptDataVersion string) (*Page, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/scripts/published/{scriptId}/pages/{pageId}" - path = strings.Replace(path, "{scriptId}", fmt.Sprintf("%v", scriptId), -1) - path = strings.Replace(path, "{pageId}", fmt.Sprintf("%v", pageId), -1) - defaultReturn := new(Page) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'scriptId' is set - if &scriptId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'scriptId' when calling ScriptsApi->GetScriptsPublishedScriptIdPage") - } - // verify the required parameter 'pageId' is set - if &pageId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'pageId' when calling ScriptsApi->GetScriptsPublishedScriptIdPage") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(scriptDataVersion).(string); ok { - if str != "" { - queryParams["scriptDataVersion"] = a.Configuration.APIClient.ParameterToString(scriptDataVersion, collectionFormat) - } - } else { - queryParams["scriptDataVersion"] = a.Configuration.APIClient.ParameterToString(scriptDataVersion, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Page - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetScriptsPublishedScriptIdPages invokes GET /api/v2/scripts/published/{scriptId}/pages -// -// Get the list of published pages -// -// -func (a ScriptsApi) GetScriptsPublishedScriptIdPages(scriptId string, scriptDataVersion string) ([]Page, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/scripts/published/{scriptId}/pages" - path = strings.Replace(path, "{scriptId}", fmt.Sprintf("%v", scriptId), -1) - defaultReturn := make([]Page, 0) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'scriptId' is set - if &scriptId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'scriptId' when calling ScriptsApi->GetScriptsPublishedScriptIdPages") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(scriptDataVersion).(string); ok { - if str != "" { - queryParams["scriptDataVersion"] = a.Configuration.APIClient.ParameterToString(scriptDataVersion, collectionFormat) - } - } else { - queryParams["scriptDataVersion"] = a.Configuration.APIClient.ParameterToString(scriptDataVersion, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload []Page - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetScriptsPublishedScriptIdVariables invokes GET /api/v2/scripts/published/{scriptId}/variables -// -// Get the published variables -// -// -func (a ScriptsApi) GetScriptsPublishedScriptIdVariables(scriptId string, input string, output string, varType string, scriptDataVersion string) (*map[string]interface{}, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/scripts/published/{scriptId}/variables" - path = strings.Replace(path, "{scriptId}", fmt.Sprintf("%v", scriptId), -1) - defaultReturn := new(map[string]interface{}) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'scriptId' is set - if &scriptId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'scriptId' when calling ScriptsApi->GetScriptsPublishedScriptIdVariables") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(input).(string); ok { - if str != "" { - queryParams["input"] = a.Configuration.APIClient.ParameterToString(input, collectionFormat) - } - } else { - queryParams["input"] = a.Configuration.APIClient.ParameterToString(input, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(output).(string); ok { - if str != "" { - queryParams["output"] = a.Configuration.APIClient.ParameterToString(output, collectionFormat) - } - } else { - queryParams["output"] = a.Configuration.APIClient.ParameterToString(output, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(varType).(string); ok { - if str != "" { - queryParams["varType"] = a.Configuration.APIClient.ParameterToString(varType, collectionFormat) - } - } else { - queryParams["varType"] = a.Configuration.APIClient.ParameterToString(varType, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(scriptDataVersion).(string); ok { - if str != "" { - queryParams["scriptDataVersion"] = a.Configuration.APIClient.ParameterToString(scriptDataVersion, collectionFormat) - } - } else { - queryParams["scriptDataVersion"] = a.Configuration.APIClient.ParameterToString(scriptDataVersion, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *map[string]interface{} - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetScriptsUploadStatus invokes GET /api/v2/scripts/uploads/{uploadId}/status -// -// Get the upload status of an imported script -// -// -func (a ScriptsApi) GetScriptsUploadStatus(uploadId string, longPoll bool) (*Importscriptstatusresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/scripts/uploads/{uploadId}/status" - path = strings.Replace(path, "{uploadId}", fmt.Sprintf("%v", uploadId), -1) - defaultReturn := new(Importscriptstatusresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'uploadId' is set - if &uploadId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'uploadId' when calling ScriptsApi->GetScriptsUploadStatus") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(longPoll).(string); ok { - if str != "" { - queryParams["longPoll"] = a.Configuration.APIClient.ParameterToString(longPoll, collectionFormat) - } - } else { - queryParams["longPoll"] = a.Configuration.APIClient.ParameterToString(longPoll, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Importscriptstatusresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostScriptExport invokes POST /api/v2/scripts/{scriptId}/export -// -// Export a script via download service. -// -// -func (a ScriptsApi) PostScriptExport(scriptId string, body Exportscriptrequest) (*Exportscriptresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/scripts/{scriptId}/export" - path = strings.Replace(path, "{scriptId}", fmt.Sprintf("%v", scriptId), -1) - defaultReturn := new(Exportscriptresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'scriptId' is set - if &scriptId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'scriptId' when calling ScriptsApi->PostScriptExport") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Exportscriptresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/searchaggregation.go b/build/platformclientv2/searchaggregation.go deleted file mode 100644 index 1de1e6b35..000000000 --- a/build/platformclientv2/searchaggregation.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Searchaggregation -type Searchaggregation struct { - // Field - The field used for aggregation - Field *string `json:"field,omitempty"` - - - // Name - The name of the aggregation. The response aggregation uses this name. - Name *string `json:"name,omitempty"` - - - // VarType - The type of aggregation to perform - VarType *string `json:"type,omitempty"` - - - // Value - A value to use for aggregation - Value *string `json:"value,omitempty"` - - - // Size - The number aggregations results to return out of the entire result set - Size *int `json:"size,omitempty"` - - - // Order - The order in which aggregation results are sorted - Order *[]string `json:"order,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Searchaggregation) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/searchapi.go b/build/platformclientv2/searchapi.go deleted file mode 100644 index f50fa2d6b..000000000 --- a/build/platformclientv2/searchapi.go +++ /dev/null @@ -1,1586 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "encoding/json" -) - -// SearchApi provides functions for API endpoints -type SearchApi struct { - Configuration *Configuration -} - -// NewSearchApi creates an API instance using the default configuration -func NewSearchApi() *SearchApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating SearchApi with base path: %s", strings.ToLower(config.BasePath))) - return &SearchApi{ - Configuration: config, - } -} - -// NewSearchApiWithConfig creates an API instance using the provided configuration -func NewSearchApiWithConfig(config *Configuration) *SearchApi { - config.Debugf("Creating SearchApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &SearchApi{ - Configuration: config, - } -} - -// GetDocumentationGknSearch invokes GET /api/v2/documentation/gkn/search -// -// Search gkn documentation using the q64 value returned from a previous search -// -// -func (a SearchApi) GetDocumentationGknSearch(q64 string) (*Gkndocumentationsearchresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/documentation/gkn/search" - defaultReturn := new(Gkndocumentationsearchresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'q64' is set - if &q64 == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'q64' when calling SearchApi->GetDocumentationGknSearch") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(q64).(string); ok { - if str != "" { - queryParams["q64"] = a.Configuration.APIClient.ParameterToString(q64, collectionFormat) - } - } else { - queryParams["q64"] = a.Configuration.APIClient.ParameterToString(q64, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Gkndocumentationsearchresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetDocumentationSearch invokes GET /api/v2/documentation/search -// -// Search documentation using the q64 value returned from a previous search -// -// -func (a SearchApi) GetDocumentationSearch(q64 string) (*Documentationsearchresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/documentation/search" - defaultReturn := new(Documentationsearchresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'q64' is set - if &q64 == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'q64' when calling SearchApi->GetDocumentationSearch") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(q64).(string); ok { - if str != "" { - queryParams["q64"] = a.Configuration.APIClient.ParameterToString(q64, collectionFormat) - } - } else { - queryParams["q64"] = a.Configuration.APIClient.ParameterToString(q64, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Documentationsearchresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetGroupsSearch invokes GET /api/v2/groups/search -// -// Search groups using the q64 value returned from a previous search -// -// -func (a SearchApi) GetGroupsSearch(q64 string, expand []string) (*Groupssearchresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/groups/search" - defaultReturn := new(Groupssearchresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'q64' is set - if &q64 == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'q64' when calling SearchApi->GetGroupsSearch") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(q64).(string); ok { - if str != "" { - queryParams["q64"] = a.Configuration.APIClient.ParameterToString(q64, collectionFormat) - } - } else { - queryParams["q64"] = a.Configuration.APIClient.ParameterToString(q64, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Groupssearchresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetLocationsSearch invokes GET /api/v2/locations/search -// -// Search locations using the q64 value returned from a previous search -// -// -func (a SearchApi) GetLocationsSearch(q64 string, expand []string) (*Locationssearchresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/locations/search" - defaultReturn := new(Locationssearchresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'q64' is set - if &q64 == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'q64' when calling SearchApi->GetLocationsSearch") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(q64).(string); ok { - if str != "" { - queryParams["q64"] = a.Configuration.APIClient.ParameterToString(q64, collectionFormat) - } - } else { - queryParams["q64"] = a.Configuration.APIClient.ParameterToString(q64, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Locationssearchresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetSearch invokes GET /api/v2/search -// -// Search using the q64 value returned from a previous search. -// -// -func (a SearchApi) GetSearch(q64 string, expand []string, profile bool) (*Jsonnodesearchresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/search" - defaultReturn := new(Jsonnodesearchresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'q64' is set - if &q64 == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'q64' when calling SearchApi->GetSearch") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(q64).(string); ok { - if str != "" { - queryParams["q64"] = a.Configuration.APIClient.ParameterToString(q64, collectionFormat) - } - } else { - queryParams["q64"] = a.Configuration.APIClient.ParameterToString(q64, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(profile).(string); ok { - if str != "" { - queryParams["profile"] = a.Configuration.APIClient.ParameterToString(profile, collectionFormat) - } - } else { - queryParams["profile"] = a.Configuration.APIClient.ParameterToString(profile, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Jsonnodesearchresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetSearchSuggest invokes GET /api/v2/search/suggest -// -// Suggest resources using the q64 value returned from a previous suggest query. -// -// -func (a SearchApi) GetSearchSuggest(q64 string, expand []string, profile bool) (*Jsonnodesearchresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/search/suggest" - defaultReturn := new(Jsonnodesearchresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'q64' is set - if &q64 == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'q64' when calling SearchApi->GetSearchSuggest") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(q64).(string); ok { - if str != "" { - queryParams["q64"] = a.Configuration.APIClient.ParameterToString(q64, collectionFormat) - } - } else { - queryParams["q64"] = a.Configuration.APIClient.ParameterToString(q64, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(profile).(string); ok { - if str != "" { - queryParams["profile"] = a.Configuration.APIClient.ParameterToString(profile, collectionFormat) - } - } else { - queryParams["profile"] = a.Configuration.APIClient.ParameterToString(profile, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Jsonnodesearchresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetUsersSearch invokes GET /api/v2/users/search -// -// Search users using the q64 value returned from a previous search -// -// -func (a SearchApi) GetUsersSearch(q64 string, expand []string, integrationPresenceSource string) (*Userssearchresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/search" - defaultReturn := new(Userssearchresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'q64' is set - if &q64 == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'q64' when calling SearchApi->GetUsersSearch") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(q64).(string); ok { - if str != "" { - queryParams["q64"] = a.Configuration.APIClient.ParameterToString(q64, collectionFormat) - } - } else { - queryParams["q64"] = a.Configuration.APIClient.ParameterToString(q64, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(integrationPresenceSource).(string); ok { - if str != "" { - queryParams["integrationPresenceSource"] = a.Configuration.APIClient.ParameterToString(integrationPresenceSource, collectionFormat) - } - } else { - queryParams["integrationPresenceSource"] = a.Configuration.APIClient.ParameterToString(integrationPresenceSource, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Userssearchresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetVoicemailSearch invokes GET /api/v2/voicemail/search -// -// Search voicemails using the q64 value returned from a previous search -// -// -func (a SearchApi) GetVoicemailSearch(q64 string, expand []string) (*Voicemailssearchresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/voicemail/search" - defaultReturn := new(Voicemailssearchresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'q64' is set - if &q64 == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'q64' when calling SearchApi->GetVoicemailSearch") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(q64).(string); ok { - if str != "" { - queryParams["q64"] = a.Configuration.APIClient.ParameterToString(q64, collectionFormat) - } - } else { - queryParams["q64"] = a.Configuration.APIClient.ParameterToString(q64, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Voicemailssearchresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostAnalyticsConversationsTranscriptsQuery invokes POST /api/v2/analytics/conversations/transcripts/query -// -// Search resources. -// -// -func (a SearchApi) PostAnalyticsConversationsTranscriptsQuery(body Transcriptconversationdetailsearchrequest) (*Analyticsconversationwithoutattributesmultigetresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/conversations/transcripts/query" - defaultReturn := new(Analyticsconversationwithoutattributesmultigetresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling SearchApi->PostAnalyticsConversationsTranscriptsQuery") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Analyticsconversationwithoutattributesmultigetresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostDocumentationGknSearch invokes POST /api/v2/documentation/gkn/search -// -// Search gkn documentation -// -// -func (a SearchApi) PostDocumentationGknSearch(body Gkndocumentationsearchrequest) (*Gkndocumentationsearchresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/documentation/gkn/search" - defaultReturn := new(Gkndocumentationsearchresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling SearchApi->PostDocumentationGknSearch") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Gkndocumentationsearchresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostDocumentationSearch invokes POST /api/v2/documentation/search -// -// Search documentation -// -// -func (a SearchApi) PostDocumentationSearch(body Documentationsearchrequest) (*Documentationsearchresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/documentation/search" - defaultReturn := new(Documentationsearchresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling SearchApi->PostDocumentationSearch") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Documentationsearchresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostGroupsSearch invokes POST /api/v2/groups/search -// -// Search groups -// -// -func (a SearchApi) PostGroupsSearch(body Groupsearchrequest) (*Groupssearchresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/groups/search" - defaultReturn := new(Groupssearchresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling SearchApi->PostGroupsSearch") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Groupssearchresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostKnowledgeKnowledgebaseSearch invokes POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/search -// -// Search Documents -// -// -func (a SearchApi) PostKnowledgeKnowledgebaseSearch(knowledgeBaseId string, body Knowledgesearchrequest) (*Knowledgesearchresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/search" - path = strings.Replace(path, "{knowledgeBaseId}", fmt.Sprintf("%v", knowledgeBaseId), -1) - defaultReturn := new(Knowledgesearchresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'knowledgeBaseId' is set - if &knowledgeBaseId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'knowledgeBaseId' when calling SearchApi->PostKnowledgeKnowledgebaseSearch") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Knowledgesearchresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostLocationsSearch invokes POST /api/v2/locations/search -// -// Search locations -// -// -func (a SearchApi) PostLocationsSearch(body Locationsearchrequest) (*Locationssearchresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/locations/search" - defaultReturn := new(Locationssearchresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling SearchApi->PostLocationsSearch") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Locationssearchresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostSearch invokes POST /api/v2/search -// -// Search resources. -// -// -func (a SearchApi) PostSearch(body Searchrequest, profile bool) (*Jsonnodesearchresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/search" - defaultReturn := new(Jsonnodesearchresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling SearchApi->PostSearch") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(profile).(string); ok { - if str != "" { - queryParams["profile"] = a.Configuration.APIClient.ParameterToString(profile, collectionFormat) - } - } else { - queryParams["profile"] = a.Configuration.APIClient.ParameterToString(profile, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Jsonnodesearchresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostSearchSuggest invokes POST /api/v2/search/suggest -// -// Suggest resources. -// -// -func (a SearchApi) PostSearchSuggest(body Suggestsearchrequest, profile bool) (*Jsonnodesearchresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/search/suggest" - defaultReturn := new(Jsonnodesearchresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling SearchApi->PostSearchSuggest") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(profile).(string); ok { - if str != "" { - queryParams["profile"] = a.Configuration.APIClient.ParameterToString(profile, collectionFormat) - } - } else { - queryParams["profile"] = a.Configuration.APIClient.ParameterToString(profile, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Jsonnodesearchresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostSpeechandtextanalyticsTranscriptsSearch invokes POST /api/v2/speechandtextanalytics/transcripts/search -// -// Search resources. -// -// -func (a SearchApi) PostSpeechandtextanalyticsTranscriptsSearch(body Transcriptsearchrequest) (*Jsonsearchresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/speechandtextanalytics/transcripts/search" - defaultReturn := new(Jsonsearchresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling SearchApi->PostSpeechandtextanalyticsTranscriptsSearch") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Jsonsearchresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostUsersSearch invokes POST /api/v2/users/search -// -// Search users -// -// -func (a SearchApi) PostUsersSearch(body Usersearchrequest) (*Userssearchresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/search" - defaultReturn := new(Userssearchresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling SearchApi->PostUsersSearch") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Userssearchresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostVoicemailSearch invokes POST /api/v2/voicemail/search -// -// Search voicemails -// -// -func (a SearchApi) PostVoicemailSearch(body Voicemailsearchrequest) (*Voicemailssearchresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/voicemail/search" - defaultReturn := new(Voicemailssearchresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling SearchApi->PostVoicemailSearch") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Voicemailssearchresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/searchcriteria.go b/build/platformclientv2/searchcriteria.go deleted file mode 100644 index a883f56fb..000000000 --- a/build/platformclientv2/searchcriteria.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Searchcriteria -type Searchcriteria struct { - // EndValue - The end value of the range. This field is used for range search types. - EndValue *string `json:"endValue,omitempty"` - - - // Values - A list of values for the search to match against - Values *[]string `json:"values,omitempty"` - - - // StartValue - The start value of the range. This field is used for range search types. - StartValue *string `json:"startValue,omitempty"` - - - // Fields - Field names to search against - Fields *[]string `json:"fields,omitempty"` - - - // Value - A value for the search to match against - Value *string `json:"value,omitempty"` - - - // Operator - How to apply this search criteria against other criteria - Operator *string `json:"operator,omitempty"` - - - // Group - Groups multiple conditions - Group *[]Searchcriteria `json:"group,omitempty"` - - - // DateFormat - Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX. - DateFormat *string `json:"dateFormat,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Searchcriteria) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/searchrequest.go b/build/platformclientv2/searchrequest.go deleted file mode 100644 index 91aff916b..000000000 --- a/build/platformclientv2/searchrequest.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Searchrequest -type Searchrequest struct { - // SortOrder - The sort order for results - SortOrder *string `json:"sortOrder,omitempty"` - - - // SortBy - The field in the resource that you want to sort the results by - SortBy *string `json:"sortBy,omitempty"` - - - // PageSize - The number of results per page - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - The page of resources you want to retrieve - PageNumber *int `json:"pageNumber,omitempty"` - - - // Sort - Multi-value sort order, list of multiple sort values - Sort *[]Searchsort `json:"sort,omitempty"` - - - // ReturnFields - A List of strings. Possible values are any field in the resource you are searching on. The other option is to use ALL_FIELDS, when this is provided all fields in the resource will be returned in the search results. - ReturnFields *[]string `json:"returnFields,omitempty"` - - - // Expand - Provides more details about a specified resource - Expand *[]string `json:"expand,omitempty"` - - - // Types - Resource domain type to search - Types *[]string `json:"types,omitempty"` - - - // Query - The search criteria - Query *[]Searchcriteria `json:"query,omitempty"` - - - // Aggregations - Aggregation criteria - Aggregations *[]Searchaggregation `json:"aggregations,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Searchrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/searchshifttraderesponse.go b/build/platformclientv2/searchshifttraderesponse.go deleted file mode 100644 index 7b8f0f0f8..000000000 --- a/build/platformclientv2/searchshifttraderesponse.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Searchshifttraderesponse -type Searchshifttraderesponse struct { - // Trade - A trade which matches search criteria - Trade *Shifttraderesponse `json:"trade,omitempty"` - - - // MatchingReceivingShiftIds - IDs of shifts which match the search criteria - MatchingReceivingShiftIds *[]string `json:"matchingReceivingShiftIds,omitempty"` - - - // Preview - A preview of what the shift trade would look like if matched - Preview *Shifttradepreviewresponse `json:"preview,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Searchshifttraderesponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/searchshifttradesrequest.go b/build/platformclientv2/searchshifttradesrequest.go deleted file mode 100644 index 124135409..000000000 --- a/build/platformclientv2/searchshifttradesrequest.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Searchshifttradesrequest -type Searchshifttradesrequest struct { - // ReceivingScheduleId - The ID of the schedule for which to search for available shift trades - ReceivingScheduleId *string `json:"receivingScheduleId,omitempty"` - - - // ReceivingShiftIds - The IDs of shifts that the receiving user would potentially be willing to trade. If empty, only returns one sided trades (pick up a shift) - ReceivingShiftIds *[]string `json:"receivingShiftIds,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Searchshifttradesrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/searchshifttradesresponse.go b/build/platformclientv2/searchshifttradesresponse.go deleted file mode 100644 index 5a2fd2f2c..000000000 --- a/build/platformclientv2/searchshifttradesresponse.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Searchshifttradesresponse -type Searchshifttradesresponse struct { - // Trades - The shift trades that match the search criteria - Trades *[]Searchshifttraderesponse `json:"trades,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Searchshifttradesresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/searchsort.go b/build/platformclientv2/searchsort.go deleted file mode 100644 index c43412ef4..000000000 --- a/build/platformclientv2/searchsort.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Searchsort -type Searchsort struct { - // SortOrder - The sort order for results - SortOrder *string `json:"sortOrder,omitempty"` - - - // SortBy - The field in the resource that you want to sort the results by - SortBy *string `json:"sortBy,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Searchsort) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/section.go b/build/platformclientv2/section.go deleted file mode 100644 index 43f611cae..000000000 --- a/build/platformclientv2/section.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Section -type Section struct { - // FieldList - FieldList *[]Fieldlist `json:"fieldList,omitempty"` - - - // InstructionText - InstructionText *string `json:"instructionText,omitempty"` - - - // Key - Key *string `json:"key,omitempty"` - - - // State - State *string `json:"state,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Section) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/securesession.go b/build/platformclientv2/securesession.go deleted file mode 100644 index c2670df86..000000000 --- a/build/platformclientv2/securesession.go +++ /dev/null @@ -1,41 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Securesession -type Securesession struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Flow - The flow to execute securely - Flow *Domainentityref `json:"flow,omitempty"` - - - // UserData - Customer-provided data - UserData *string `json:"userData,omitempty"` - - - // State - The current state of a secure session - State *string `json:"state,omitempty"` - - - // SourceParticipantId - Unique identifier for the participant initiating the secure session. - SourceParticipantId *string `json:"sourceParticipantId,omitempty"` - - - // Disconnect - If true, disconnect the agent after creating the session - Disconnect *bool `json:"disconnect,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Securesession) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/securesessionentitylisting.go b/build/platformclientv2/securesessionentitylisting.go deleted file mode 100644 index 50eacf657..000000000 --- a/build/platformclientv2/securesessionentitylisting.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Securesessionentitylisting -type Securesessionentitylisting struct { - // Entities - Entities *[]Securesession `json:"entities,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Securesessionentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/securityprofile.go b/build/platformclientv2/securityprofile.go deleted file mode 100644 index 4c600d381..000000000 --- a/build/platformclientv2/securityprofile.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Securityprofile -type Securityprofile struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Permissions - Permissions *[]string `json:"permissions,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Securityprofile) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/securityprofileentitylisting.go b/build/platformclientv2/securityprofileentitylisting.go deleted file mode 100644 index cb658ada8..000000000 --- a/build/platformclientv2/securityprofileentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Securityprofileentitylisting -type Securityprofileentitylisting struct { - // Entities - Entities *[]Securityprofile `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Securityprofileentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/segment.go b/build/platformclientv2/segment.go deleted file mode 100644 index af3b85765..000000000 --- a/build/platformclientv2/segment.go +++ /dev/null @@ -1,34 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Segment -type Segment struct { - // StartTime - The timestamp when this segment began. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartTime *time.Time `json:"startTime,omitempty"` - - - // EndTime - The timestamp when this segment ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - EndTime *time.Time `json:"endTime,omitempty"` - - - // VarType - The activity taking place for the participant in the segment. - VarType *string `json:"type,omitempty"` - - - // HowEnded - A description of the event that ended the segment. - HowEnded *string `json:"howEnded,omitempty"` - - - // DisconnectType - A description of the event that disconnected the segment - DisconnectType *string `json:"disconnectType,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Segment) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/segmentdetailqueryclause.go b/build/platformclientv2/segmentdetailqueryclause.go deleted file mode 100644 index bcfa3288f..000000000 --- a/build/platformclientv2/segmentdetailqueryclause.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Segmentdetailqueryclause -type Segmentdetailqueryclause struct { - // VarType - Boolean operation to apply to the provided predicates - VarType *string `json:"type,omitempty"` - - - // Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value). - Predicates *[]Segmentdetailquerypredicate `json:"predicates,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Segmentdetailqueryclause) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/segmentdetailqueryfilter.go b/build/platformclientv2/segmentdetailqueryfilter.go deleted file mode 100644 index 328bfc42d..000000000 --- a/build/platformclientv2/segmentdetailqueryfilter.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Segmentdetailqueryfilter -type Segmentdetailqueryfilter struct { - // VarType - Boolean operation to apply to the provided predicates and clauses - VarType *string `json:"type,omitempty"` - - - // Clauses - Boolean 'and/or' logic with up to two-levels of nesting - Clauses *[]Segmentdetailqueryclause `json:"clauses,omitempty"` - - - // Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value). - Predicates *[]Segmentdetailquerypredicate `json:"predicates,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Segmentdetailqueryfilter) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/segmentdetailquerypredicate.go b/build/platformclientv2/segmentdetailquerypredicate.go deleted file mode 100644 index 71894432b..000000000 --- a/build/platformclientv2/segmentdetailquerypredicate.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Segmentdetailquerypredicate -type Segmentdetailquerypredicate struct { - // VarType - Optional type, can usually be inferred - VarType *string `json:"type,omitempty"` - - - // Dimension - Left hand side for dimension predicates - Dimension *string `json:"dimension,omitempty"` - - - // PropertyType - Left hand side for property predicates - PropertyType *string `json:"propertyType,omitempty"` - - - // Property - Left hand side for property predicates - Property *string `json:"property,omitempty"` - - - // Metric - Left hand side for metric predicates - Metric *string `json:"metric,omitempty"` - - - // Operator - Optional operator, default is matches - Operator *string `json:"operator,omitempty"` - - - // Value - Right hand side for dimension, metric, or property predicates - Value *string `json:"value,omitempty"` - - - // VarRange - Right hand side for dimension, metric, or property predicates - VarRange *Numericrange `json:"range,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Segmentdetailquerypredicate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/segmentlisting.go b/build/platformclientv2/segmentlisting.go deleted file mode 100644 index 0b058f0b1..000000000 --- a/build/platformclientv2/segmentlisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Segmentlisting -type Segmentlisting struct { - // Entities - Entities *[]Journeysegment `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Segmentlisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/selectedcolumns.go b/build/platformclientv2/selectedcolumns.go deleted file mode 100644 index 83e2c729f..000000000 --- a/build/platformclientv2/selectedcolumns.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Selectedcolumns -type Selectedcolumns struct { - // ColumnOrder - Indicates the order/position of the selected column - ColumnOrder *int `json:"columnOrder,omitempty"` - - - // ColumnName - Indicates enum name of the column from the export view - ColumnName *string `json:"columnName,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Selectedcolumns) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/sendagentlessoutboundmessagerequest.go b/build/platformclientv2/sendagentlessoutboundmessagerequest.go deleted file mode 100644 index 7da4799b7..000000000 --- a/build/platformclientv2/sendagentlessoutboundmessagerequest.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Sendagentlessoutboundmessagerequest -type Sendagentlessoutboundmessagerequest struct { - // FromAddress - The messaging address of the sender of the message. For an SMS messenger type, this must be a currently provisioned sms phone number. - FromAddress *string `json:"fromAddress,omitempty"` - - - // ToAddress - The messaging address of the recipient of the message. For an SMS messenger type, the phone number address must be in E.164 format. E.g. +13175555555 or +34234234234. - ToAddress *string `json:"toAddress,omitempty"` - - - // ToAddressMessengerType - The recipient messaging address messenger type. Currently SMS is the only supported type. - ToAddressMessengerType *string `json:"toAddressMessengerType,omitempty"` - - - // TextBody - The text of the message to send - TextBody *string `json:"textBody,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Sendagentlessoutboundmessagerequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/sendagentlessoutboundmessageresponse.go b/build/platformclientv2/sendagentlessoutboundmessageresponse.go deleted file mode 100644 index 2b5e9bf98..000000000 --- a/build/platformclientv2/sendagentlessoutboundmessageresponse.go +++ /dev/null @@ -1,50 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Sendagentlessoutboundmessageresponse -type Sendagentlessoutboundmessageresponse struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // ConversationId - The identifier of the conversation. - ConversationId *string `json:"conversationId,omitempty"` - - - // FromAddress - The sender of the text message. - FromAddress *string `json:"fromAddress,omitempty"` - - - // ToAddress - The recipient of the text message. - ToAddress *string `json:"toAddress,omitempty"` - - - // MessengerType - Type of text messenger. - MessengerType *string `json:"messengerType,omitempty"` - - - // TextBody - The body of the text message. - TextBody *string `json:"textBody,omitempty"` - - - // Timestamp - The time when the message was sent. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - Timestamp *time.Time `json:"timestamp,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - - - // User - Details of the user created the job - User *Addressableentityref `json:"user,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Sendagentlessoutboundmessageresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/sequenceschedule.go b/build/platformclientv2/sequenceschedule.go deleted file mode 100644 index cf15bded1..000000000 --- a/build/platformclientv2/sequenceschedule.go +++ /dev/null @@ -1,50 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Sequenceschedule -type Sequenceschedule struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // DateCreated - Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // Version - Required for updates, must match the version number of the most recent update - Version *int `json:"version,omitempty"` - - - // Intervals - A list of intervals during which to run the associated CampaignSequence. - Intervals *[]Scheduleinterval `json:"intervals,omitempty"` - - - // TimeZone - The time zone for this SequenceSchedule. For example, Africa/Abidjan. - TimeZone *string `json:"timeZone,omitempty"` - - - // Sequence - The CampaignSequence that this SequenceSchedule is for. - Sequence *Domainentityref `json:"sequence,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Sequenceschedule) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/serverdate.go b/build/platformclientv2/serverdate.go deleted file mode 100644 index 07d23329e..000000000 --- a/build/platformclientv2/serverdate.go +++ /dev/null @@ -1,18 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Serverdate -type Serverdate struct { - // CurrentDate - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - CurrentDate *time.Time `json:"currentDate,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Serverdate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/servicecontext.go b/build/platformclientv2/servicecontext.go deleted file mode 100644 index 7d0ff3f41..000000000 --- a/build/platformclientv2/servicecontext.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Servicecontext -type Servicecontext struct { - // Name - Unused field for the purpose of ensuring a Swagger definition is created for a class with only @JsonIgnore members. - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Servicecontext) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/servicegoaltemplate.go b/build/platformclientv2/servicegoaltemplate.go deleted file mode 100644 index 006ca16fc..000000000 --- a/build/platformclientv2/servicegoaltemplate.go +++ /dev/null @@ -1,41 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Servicegoaltemplate - Service Goal Template -type Servicegoaltemplate struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // ServiceLevel - Service level targets for this service goal template - ServiceLevel *Buservicelevel `json:"serviceLevel,omitempty"` - - - // AverageSpeedOfAnswer - Average speed of answer targets for this service goal template - AverageSpeedOfAnswer *Buaveragespeedofanswer `json:"averageSpeedOfAnswer,omitempty"` - - - // AbandonRate - Abandon rate targets for this service goal template - AbandonRate *Buabandonrate `json:"abandonRate,omitempty"` - - - // Metadata - Version metadata for the service goal template - Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Servicegoaltemplate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/servicegoaltemplatelist.go b/build/platformclientv2/servicegoaltemplatelist.go deleted file mode 100644 index 69cf4b7c7..000000000 --- a/build/platformclientv2/servicegoaltemplatelist.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Servicegoaltemplatelist - List of service goal templates -type Servicegoaltemplatelist struct { - // Entities - Entities *[]Servicegoaltemplate `json:"entities,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Servicegoaltemplatelist) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/servicegoaltemplatereference.go b/build/platformclientv2/servicegoaltemplatereference.go deleted file mode 100644 index 8cbbffbfe..000000000 --- a/build/platformclientv2/servicegoaltemplatereference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Servicegoaltemplatereference -type Servicegoaltemplatereference struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Servicegoaltemplatereference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/servicelevel.go b/build/platformclientv2/servicelevel.go deleted file mode 100644 index 5e6196cc6..000000000 --- a/build/platformclientv2/servicelevel.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Servicelevel -type Servicelevel struct { - // Percentage - The desired Service Level. A value between 0 and 1. - Percentage *float64 `json:"percentage,omitempty"` - - - // DurationMs - Service Level target in milliseconds. - DurationMs *int `json:"durationMs,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Servicelevel) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/setuuidatarequest.go b/build/platformclientv2/setuuidatarequest.go deleted file mode 100644 index a9a05b2d9..000000000 --- a/build/platformclientv2/setuuidatarequest.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Setuuidatarequest -type Setuuidatarequest struct { - // UuiData - The value of the uuiData to set. - UuiData *string `json:"uuiData,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Setuuidatarequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/setwrapperdayofweek.go b/build/platformclientv2/setwrapperdayofweek.go deleted file mode 100644 index f9485e4dc..000000000 --- a/build/platformclientv2/setwrapperdayofweek.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Setwrapperdayofweek -type Setwrapperdayofweek struct { - // Values - Values *[]string `json:"values,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Setwrapperdayofweek) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/setwrapperroutepathrequest.go b/build/platformclientv2/setwrapperroutepathrequest.go deleted file mode 100644 index f95f94e2e..000000000 --- a/build/platformclientv2/setwrapperroutepathrequest.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Setwrapperroutepathrequest -type Setwrapperroutepathrequest struct { - // Values - Values *[]Routepathrequest `json:"values,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Setwrapperroutepathrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/share.go b/build/platformclientv2/share.go deleted file mode 100644 index 649be53db..000000000 --- a/build/platformclientv2/share.go +++ /dev/null @@ -1,57 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Share -type Share struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // SharedEntityType - SharedEntityType *string `json:"sharedEntityType,omitempty"` - - - // SharedEntity - SharedEntity *Domainentityref `json:"sharedEntity,omitempty"` - - - // MemberType - MemberType *string `json:"memberType,omitempty"` - - - // Member - Member *Domainentityref `json:"member,omitempty"` - - - // SharedBy - SharedBy *Domainentityref `json:"sharedBy,omitempty"` - - - // Workspace - Workspace *Domainentityref `json:"workspace,omitempty"` - - - // User - User *User `json:"user,omitempty"` - - - // Group - Group *Group `json:"group,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Share) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/sharedentity.go b/build/platformclientv2/sharedentity.go deleted file mode 100644 index 8553f7d1f..000000000 --- a/build/platformclientv2/sharedentity.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Sharedentity -type Sharedentity struct { - // Id - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Sharedentity) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/sharedresponse.go b/build/platformclientv2/sharedresponse.go deleted file mode 100644 index 452eacf87..000000000 --- a/build/platformclientv2/sharedresponse.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Sharedresponse -type Sharedresponse struct { - // Id - Id *string `json:"id,omitempty"` - - - // DownloadUri - DownloadUri *string `json:"downloadUri,omitempty"` - - - // ViewUri - ViewUri *string `json:"viewUri,omitempty"` - - - // Document - Document *Document `json:"document,omitempty"` - - - // Share - Share *Share `json:"share,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Sharedresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/shareentitylisting.go b/build/platformclientv2/shareentitylisting.go deleted file mode 100644 index cae864eed..000000000 --- a/build/platformclientv2/shareentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Shareentitylisting -type Shareentitylisting struct { - // Entities - Entities *[]Share `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Shareentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/shiftstartvariance.go b/build/platformclientv2/shiftstartvariance.go deleted file mode 100644 index 196f31277..000000000 --- a/build/platformclientv2/shiftstartvariance.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Shiftstartvariance - Variance in minutes among start times of shifts in work plan -type Shiftstartvariance struct { - // ApplicableDays - Days for which shift start variance is configured - ApplicableDays *[]string `json:"applicableDays,omitempty"` - - - // MaxShiftStartVarianceMinutes - Maximum variance in minutes across shift starts - MaxShiftStartVarianceMinutes *int `json:"maxShiftStartVarianceMinutes,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Shiftstartvariance) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/shifttradeactivitypreviewresponse.go b/build/platformclientv2/shifttradeactivitypreviewresponse.go deleted file mode 100644 index 26ff7c7d7..000000000 --- a/build/platformclientv2/shifttradeactivitypreviewresponse.go +++ /dev/null @@ -1,30 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Shifttradeactivitypreviewresponse -type Shifttradeactivitypreviewresponse struct { - // StartDate - The start date and time of this activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartDate *time.Time `json:"startDate,omitempty"` - - - // LengthMinutes - The length in minutes of this activity - LengthMinutes *int `json:"lengthMinutes,omitempty"` - - - // ActivityCodeId - The ID of the activity code for this activity - ActivityCodeId *string `json:"activityCodeId,omitempty"` - - - // CountsAsPaidTime - Whether this activity counts as paid time - CountsAsPaidTime *bool `json:"countsAsPaidTime,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Shifttradeactivitypreviewresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/shifttradeactivityrule.go b/build/platformclientv2/shifttradeactivityrule.go deleted file mode 100644 index 9ebb29816..000000000 --- a/build/platformclientv2/shifttradeactivityrule.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Shifttradeactivityrule -type Shifttradeactivityrule struct { - // ActivityCategory - The activity category to which to apply this rule - ActivityCategory *string `json:"activityCategory,omitempty"` - - - // Action - The action this rule invokes - Action *string `json:"action,omitempty"` - - - // ActivityCodeIdReplacement - The activity code ID with which to replace activities belonging to the original category if applicable (required if action == Replace, must be a default activity code ID) - ActivityCodeIdReplacement *string `json:"activityCodeIdReplacement,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Shifttradeactivityrule) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/shifttradelistresponse.go b/build/platformclientv2/shifttradelistresponse.go deleted file mode 100644 index d2f9af6cc..000000000 --- a/build/platformclientv2/shifttradelistresponse.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Shifttradelistresponse -type Shifttradelistresponse struct { - // Entities - Entities *[]Shifttraderesponse `json:"entities,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Shifttradelistresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/shifttradematchessummaryresponse.go b/build/platformclientv2/shifttradematchessummaryresponse.go deleted file mode 100644 index c1c2c4b3a..000000000 --- a/build/platformclientv2/shifttradematchessummaryresponse.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Shifttradematchessummaryresponse -type Shifttradematchessummaryresponse struct { - // Entities - Entities *[]Weekshifttradematchessummaryresponse `json:"entities,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Shifttradematchessummaryresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/shifttradematchreviewresponse.go b/build/platformclientv2/shifttradematchreviewresponse.go deleted file mode 100644 index 16053665b..000000000 --- a/build/platformclientv2/shifttradematchreviewresponse.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Shifttradematchreviewresponse -type Shifttradematchreviewresponse struct { - // InitiatingUser - Details for the initiatingUser side of the shift trade - InitiatingUser *Shifttradematchreviewuserresponse `json:"initiatingUser,omitempty"` - - - // ReceivingUser - Details for the receivingUser side of the shift trade - ReceivingUser *Shifttradematchreviewuserresponse `json:"receivingUser,omitempty"` - - - // Violations - Constraint violations introduced after being matched that would normally disallow a trade, but which can still be overridden by the shift trade administrator - Violations *[]Shifttradematchviolation `json:"violations,omitempty"` - - - // AdminReviewViolations - Constraint violations associated with this shift trade which require shift trade administrator review - AdminReviewViolations *[]Shifttradematchviolation `json:"adminReviewViolations,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Shifttradematchreviewresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/shifttradematchreviewuserresponse.go b/build/platformclientv2/shifttradematchreviewuserresponse.go deleted file mode 100644 index 7d068f9f6..000000000 --- a/build/platformclientv2/shifttradematchreviewuserresponse.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Shifttradematchreviewuserresponse -type Shifttradematchreviewuserresponse struct { - // WeeklyMinimumPaidMinutes - The minimum weekly paid minutes for this user per the work plan tied to the agent schedule - WeeklyMinimumPaidMinutes *int `json:"weeklyMinimumPaidMinutes,omitempty"` - - - // WeeklyMaximumPaidMinutes - The maximum weekly paid minutes for this user per the work plan tied to the agent schedule - WeeklyMaximumPaidMinutes *int `json:"weeklyMaximumPaidMinutes,omitempty"` - - - // PreTradeSchedulePaidMinutes - The paid minutes on the week schedule for this user prior to the shift trade - PreTradeSchedulePaidMinutes *int `json:"preTradeSchedulePaidMinutes,omitempty"` - - - // PostTradeSchedulePaidMinutes - The paid minutes on the week schedule for this user if the shift trade is approved - PostTradeSchedulePaidMinutes *int `json:"postTradeSchedulePaidMinutes,omitempty"` - - - // PostTradeNewShift - Preview of what the shift will look like for the opposite side of this trade after the match is approved - PostTradeNewShift *Shifttradepreviewresponse `json:"postTradeNewShift,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Shifttradematchreviewuserresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/shifttradematchviolation.go b/build/platformclientv2/shifttradematchviolation.go deleted file mode 100644 index fe312c8c6..000000000 --- a/build/platformclientv2/shifttradematchviolation.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Shifttradematchviolation -type Shifttradematchviolation struct { - // VarType - The type of constraint violation - VarType *string `json:"type,omitempty"` - - - // Params - Clarifying user params for constructing helpful error messages - Params *map[string]string `json:"params,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Shifttradematchviolation) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/shifttradenotification.go b/build/platformclientv2/shifttradenotification.go deleted file mode 100644 index 87ed9e647..000000000 --- a/build/platformclientv2/shifttradenotification.go +++ /dev/null @@ -1,46 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Shifttradenotification -type Shifttradenotification struct { - // WeekDate - The start date of the schedule with which this trade is associated - WeekDate *string `json:"weekDate,omitempty"` - - - // TradeId - The ID of the shift trade - TradeId *string `json:"tradeId,omitempty"` - - - // OneSided - Whether this is a one sided shift trade - OneSided *bool `json:"oneSided,omitempty"` - - - // NewState - The new state of the shift trade, null if there was no change - NewState *string `json:"newState,omitempty"` - - - // InitiatingUser - The user who initiated the shift trade - InitiatingUser *Userreference `json:"initiatingUser,omitempty"` - - - // InitiatingShiftDate - The start date and time of the initiating shift. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - InitiatingShiftDate *time.Time `json:"initiatingShiftDate,omitempty"` - - - // ReceivingUser - The user on the receiving side of this shift trade (null if not matched) - ReceivingUser *Userreference `json:"receivingUser,omitempty"` - - - // ReceivingShiftDate - The start date and time of the receiving shift (null if not matched or if one-sided. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ReceivingShiftDate *time.Time `json:"receivingShiftDate,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Shifttradenotification) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/shifttradepreviewresponse.go b/build/platformclientv2/shifttradepreviewresponse.go deleted file mode 100644 index 72b0bb0b3..000000000 --- a/build/platformclientv2/shifttradepreviewresponse.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Shifttradepreviewresponse -type Shifttradepreviewresponse struct { - // Activities - List of activities that will make up the new shift if this shift trade is approved - Activities *[]Shifttradeactivitypreviewresponse `json:"activities,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Shifttradepreviewresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/shifttraderesponse.go b/build/platformclientv2/shifttraderesponse.go deleted file mode 100644 index 528bb6a4c..000000000 --- a/build/platformclientv2/shifttraderesponse.go +++ /dev/null @@ -1,86 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Shifttraderesponse -type Shifttraderesponse struct { - // Id - The ID of this shift trade - Id *string `json:"id,omitempty"` - - - // WeekDate - The start week date of the associated schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd - WeekDate *time.Time `json:"weekDate,omitempty"` - - - // Schedule - A reference to the associated schedule - Schedule *Buschedulereferenceformuroute `json:"schedule,omitempty"` - - - // State - The state of this shift trade - State *string `json:"state,omitempty"` - - - // InitiatingUser - The user who initiated this trade - InitiatingUser *Userreference `json:"initiatingUser,omitempty"` - - - // InitiatingShiftId - The ID of the shift offered for trade by the initiating user - InitiatingShiftId *string `json:"initiatingShiftId,omitempty"` - - - // InitiatingShiftStart - The start date/time of the shift being offered for trade. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - InitiatingShiftStart *time.Time `json:"initiatingShiftStart,omitempty"` - - - // InitiatingShiftEnd - The end date/time of the shift being offered for trade. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - InitiatingShiftEnd *time.Time `json:"initiatingShiftEnd,omitempty"` - - - // ReceivingUser - The user matching the trade, or if the state is not Matched, the user to whom the trade request was sent - ReceivingUser *Userreference `json:"receivingUser,omitempty"` - - - // ReceivingShiftId - The ID of the shift being exchanged for the initiating shift, null if the receiving user is picking up a shift - ReceivingShiftId *string `json:"receivingShiftId,omitempty"` - - - // ReceivingShiftStart - The start date/time of the receiving shift. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ReceivingShiftStart *time.Time `json:"receivingShiftStart,omitempty"` - - - // ReceivingShiftEnd - The end date/time of the receiving shift. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ReceivingShiftEnd *time.Time `json:"receivingShiftEnd,omitempty"` - - - // Expiration - When this shift trade offer will expire if not matched or approved. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - Expiration *time.Time `json:"expiration,omitempty"` - - - // OneSided - Whether this is a one-sided shift trade (e.g. the initiating user is not asking for a shift in return) - OneSided *bool `json:"oneSided,omitempty"` - - - // AcceptableIntervals - AcceptableIntervals *[]string `json:"acceptableIntervals,omitempty"` - - - // ReviewedBy - The user who reviewed this shift trade - ReviewedBy *Userreference `json:"reviewedBy,omitempty"` - - - // ReviewedDate - The timestamp when this shift trade was reviewed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ReviewedDate *time.Time `json:"reviewedDate,omitempty"` - - - // Metadata - Version data for this trade - Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Shifttraderesponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/shifttradesettings.go b/build/platformclientv2/shifttradesettings.go deleted file mode 100644 index ad4cc09db..000000000 --- a/build/platformclientv2/shifttradesettings.go +++ /dev/null @@ -1,65 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Shifttradesettings -type Shifttradesettings struct { - // Enabled - Whether shift trading is enabled for this management unit - Enabled *bool `json:"enabled,omitempty"` - - - // AutoReview - Whether automatic shift trade review is enabled according to the rules defined in for this management unit - AutoReview *bool `json:"autoReview,omitempty"` - - - // AllowDirectTrades - Whether direct shift trades between agents are allowed - AllowDirectTrades *bool `json:"allowDirectTrades,omitempty"` - - - // MinHoursInFuture - The minimum number of hours in the future shift trades are allowed - MinHoursInFuture *int `json:"minHoursInFuture,omitempty"` - - - // UnequalPaid - How to handle shift trades which involve unequal paid times - UnequalPaid *string `json:"unequalPaid,omitempty"` - - - // OneSided - How to handle one-sided shift trades - OneSided *string `json:"oneSided,omitempty"` - - - // WeeklyMinPaidViolations - How to handle shift trades which result in violations of weekly minimum paid time constraint - WeeklyMinPaidViolations *string `json:"weeklyMinPaidViolations,omitempty"` - - - // WeeklyMaxPaidViolations - How to handle shift trades which result in violations of weekly maximum paid time constraint - WeeklyMaxPaidViolations *string `json:"weeklyMaxPaidViolations,omitempty"` - - - // RequiresMatchingQueues - Whether to constrain shift trades to agents with matching queues - RequiresMatchingQueues *bool `json:"requiresMatchingQueues,omitempty"` - - - // RequiresMatchingLanguages - Whether to constrain shift trades to agents with matching languages - RequiresMatchingLanguages *bool `json:"requiresMatchingLanguages,omitempty"` - - - // RequiresMatchingSkills - Whether to constrain shift trades to agents with matching skills - RequiresMatchingSkills *bool `json:"requiresMatchingSkills,omitempty"` - - - // RequiresMatchingPlanningGroups - Whether to constrain shift trades to agents with matching planning groups - RequiresMatchingPlanningGroups *bool `json:"requiresMatchingPlanningGroups,omitempty"` - - - // ActivityCategoryRules - Rules that specify what to do with activity categories that are part of a shift defined in a trade - ActivityCategoryRules *[]Shifttradeactivityrule `json:"activityCategoryRules,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Shifttradesettings) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/shorttermforecastingsettings.go b/build/platformclientv2/shorttermforecastingsettings.go deleted file mode 100644 index 411442978..000000000 --- a/build/platformclientv2/shorttermforecastingsettings.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Shorttermforecastingsettings - Short Term Forecasting Settings -type Shorttermforecastingsettings struct { - // DefaultHistoryWeeks - The number of weeks to consider by default when generating a volume forecast - DefaultHistoryWeeks *int `json:"defaultHistoryWeeks,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Shorttermforecastingsettings) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/shorttermforecastreference.go b/build/platformclientv2/shorttermforecastreference.go deleted file mode 100644 index 9598aefd0..000000000 --- a/build/platformclientv2/shorttermforecastreference.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Shorttermforecastreference - A pointer to a short term forecast -type Shorttermforecastreference struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - - - // WeekDate - The weekDate of the short term forecast in yyyy-MM-dd format - WeekDate *string `json:"weekDate,omitempty"` - - - // Description - The description of the short term forecast - Description *string `json:"description,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Shorttermforecastreference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/shrinkageoverride.go b/build/platformclientv2/shrinkageoverride.go deleted file mode 100644 index 819b2c2b4..000000000 --- a/build/platformclientv2/shrinkageoverride.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Shrinkageoverride -type Shrinkageoverride struct { - // IntervalIndex - Index of shrinkage override interval. Starting index is 0 and indexes are based on 15 minute intervals for a 7 day week - IntervalIndex *int `json:"intervalIndex,omitempty"` - - - // ShrinkagePercent - Shrinkage override percent. Setting a null value will reset the interval to the default - ShrinkagePercent *float64 `json:"shrinkagePercent,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Shrinkageoverride) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/shrinkageoverrides.go b/build/platformclientv2/shrinkageoverrides.go deleted file mode 100644 index 55355b73c..000000000 --- a/build/platformclientv2/shrinkageoverrides.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Shrinkageoverrides -type Shrinkageoverrides struct { - // Clear - Set true to clear the shrinkage interval overrides - Clear *bool `json:"clear,omitempty"` - - - // Values - List of interval shrinkage overrides - Values *[]Shrinkageoverride `json:"values,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Shrinkageoverrides) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/signedurlresponse.go b/build/platformclientv2/signedurlresponse.go deleted file mode 100644 index f660a5121..000000000 --- a/build/platformclientv2/signedurlresponse.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Signedurlresponse -type Signedurlresponse struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Url - Url of the downloaded pcap file - Url *string `json:"url,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Signedurlresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/sipdownloadresponse.go b/build/platformclientv2/sipdownloadresponse.go deleted file mode 100644 index d66980623..000000000 --- a/build/platformclientv2/sipdownloadresponse.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Sipdownloadresponse -type Sipdownloadresponse struct { - // DownloadId - unique id of the downloaded file - DownloadId *string `json:"downloadId,omitempty"` - - - // DocumentId - Document id of pcap file - DocumentId *string `json:"documentId,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Sipdownloadresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/sipsearchpublicrequest.go b/build/platformclientv2/sipsearchpublicrequest.go deleted file mode 100644 index ab94cb192..000000000 --- a/build/platformclientv2/sipsearchpublicrequest.go +++ /dev/null @@ -1,54 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Sipsearchpublicrequest -type Sipsearchpublicrequest struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // CallId - unique identification of the placed call - CallId *string `json:"callId,omitempty"` - - - // ToUser - SIP user to who the call was placed - ToUser *string `json:"toUser,omitempty"` - - - // FromUser - SIP user who placed the call - FromUser *string `json:"fromUser,omitempty"` - - - // ConversationId - Unique identification of the conversation - ConversationId *string `json:"conversationId,omitempty"` - - - // ParticipantId - Unique identification of the participant - ParticipantId *string `json:"participantId,omitempty"` - - - // DateStart - Start date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateStart *time.Time `json:"dateStart,omitempty"` - - - // DateEnd - End date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateEnd *time.Time `json:"dateEnd,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Sipsearchpublicrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/sipsearchresult.go b/build/platformclientv2/sipsearchresult.go deleted file mode 100644 index 8fb4209a8..000000000 --- a/build/platformclientv2/sipsearchresult.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Sipsearchresult -type Sipsearchresult struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Status - Status of the search request - Status *int `json:"status,omitempty"` - - - // Sid - Session id associated to the search request - Sid *string `json:"sid,omitempty"` - - - // Auth - Auth token used for this search request - Auth *string `json:"auth,omitempty"` - - - // Message - Any messages returned from homer as part of the response - Message *string `json:"message,omitempty"` - - - // Data - Homer search data that is returned - Data *[]Homerrecord `json:"data,omitempty"` - - - // Count - Number of records returned - Count *int `json:"count,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Sipsearchresult) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/site.go b/build/platformclientv2/site.go deleted file mode 100644 index 862fb304e..000000000 --- a/build/platformclientv2/site.go +++ /dev/null @@ -1,114 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Site -type Site struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the entity. - Name *string `json:"name,omitempty"` - - - // Description - The resource's description. - Description *string `json:"description,omitempty"` - - - // Version - The current version of the resource. - Version *int `json:"version,omitempty"` - - - // DateCreated - The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // ModifiedBy - The ID of the user that last modified the resource. - ModifiedBy *string `json:"modifiedBy,omitempty"` - - - // CreatedBy - The ID of the user that created the resource. - CreatedBy *string `json:"createdBy,omitempty"` - - - // State - Indicates if the resource is active, inactive, or deleted. - State *string `json:"state,omitempty"` - - - // ModifiedByApp - The application that last modified the resource. - ModifiedByApp *string `json:"modifiedByApp,omitempty"` - - - // CreatedByApp - The application that created the resource. - CreatedByApp *string `json:"createdByApp,omitempty"` - - - // PrimarySites - PrimarySites *[]Domainentityref `json:"primarySites,omitempty"` - - - // SecondarySites - SecondarySites *[]Domainentityref `json:"secondarySites,omitempty"` - - - // PrimaryEdges - PrimaryEdges *[]Edge `json:"primaryEdges,omitempty"` - - - // SecondaryEdges - SecondaryEdges *[]Edge `json:"secondaryEdges,omitempty"` - - - // Addresses - Addresses *[]Contact `json:"addresses,omitempty"` - - - // Edges - Edges *[]Edge `json:"edges,omitempty"` - - - // EdgeAutoUpdateConfig - Recurrance rule, time zone, and start/end settings for automatic edge updates for this site - EdgeAutoUpdateConfig *Edgeautoupdateconfig `json:"edgeAutoUpdateConfig,omitempty"` - - - // MediaRegionsUseLatencyBased - MediaRegionsUseLatencyBased *bool `json:"mediaRegionsUseLatencyBased,omitempty"` - - - // Location - Location - Location *Locationdefinition `json:"location,omitempty"` - - - // Managed - Managed *bool `json:"managed,omitempty"` - - - // NtpSettings - Network Time Protocol settings for the site - NtpSettings *Ntpsettings `json:"ntpSettings,omitempty"` - - - // MediaModel - Media model for the site - MediaModel *string `json:"mediaModel,omitempty"` - - - // CoreSite - The core site - CoreSite *bool `json:"coreSite,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Site) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/siteentitylisting.go b/build/platformclientv2/siteentitylisting.go deleted file mode 100644 index c6897cfb7..000000000 --- a/build/platformclientv2/siteentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Siteentitylisting -type Siteentitylisting struct { - // Entities - Entities *[]Site `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Siteentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/skillentitylisting.go b/build/platformclientv2/skillentitylisting.go deleted file mode 100644 index eaaee662c..000000000 --- a/build/platformclientv2/skillentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Skillentitylisting -type Skillentitylisting struct { - // Entities - Entities *[]Routingskill `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Skillentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/skillstoremove.go b/build/platformclientv2/skillstoremove.go deleted file mode 100644 index c3779f0fc..000000000 --- a/build/platformclientv2/skillstoremove.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Skillstoremove -type Skillstoremove struct { - // Name - Name *string `json:"name,omitempty"` - - - // Id - Id *string `json:"id,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Skillstoremove) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/smsaddress.go b/build/platformclientv2/smsaddress.go deleted file mode 100644 index 5afc682e1..000000000 --- a/build/platformclientv2/smsaddress.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Smsaddress -type Smsaddress struct { - // Id - The id of this address. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Street - The number and street address where this address is located. - Street *string `json:"street,omitempty"` - - - // City - The city in which this address is in - City *string `json:"city,omitempty"` - - - // Region - The state or region this address is in - Region *string `json:"region,omitempty"` - - - // PostalCode - The postal code this address is in - PostalCode *string `json:"postalCode,omitempty"` - - - // CountryCode - The ISO country code of this address - CountryCode *string `json:"countryCode,omitempty"` - - - // Validated - In some countries, addresses are validated to comply with local regulation. In those countries, if the address you provide does not pass validation, it will not be accepted as an Address. This value will be true if the Address has been validated, or false for countries that don't require validation or if the Address is non-compliant. - Validated *bool `json:"validated,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Smsaddress) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/smsaddressentitylisting.go b/build/platformclientv2/smsaddressentitylisting.go deleted file mode 100644 index ad37f7ae0..000000000 --- a/build/platformclientv2/smsaddressentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Smsaddressentitylisting -type Smsaddressentitylisting struct { - // Entities - Entities *[]Smsaddress `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Smsaddressentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/smsaddressprovision.go b/build/platformclientv2/smsaddressprovision.go deleted file mode 100644 index 1fd727a9b..000000000 --- a/build/platformclientv2/smsaddressprovision.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Smsaddressprovision -type Smsaddressprovision struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name associated with this address - Name *string `json:"name,omitempty"` - - - // Street - The number and street address where this address is located. - Street *string `json:"street,omitempty"` - - - // City - The city in which this address is in - City *string `json:"city,omitempty"` - - - // Region - The state or region this address is in - Region *string `json:"region,omitempty"` - - - // PostalCode - The postal code this address is in - PostalCode *string `json:"postalCode,omitempty"` - - - // CountryCode - The ISO country code of this address - CountryCode *string `json:"countryCode,omitempty"` - - - // AutoCorrectAddress - This is used when the address is created. If the value is not set or true, then the system will, if necessary, auto-correct the address you provide. Set this value to false if the system should not auto-correct the address. - AutoCorrectAddress *bool `json:"autoCorrectAddress,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Smsaddressprovision) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/smsavailablephonenumber.go b/build/platformclientv2/smsavailablephonenumber.go deleted file mode 100644 index 0ce135ef7..000000000 --- a/build/platformclientv2/smsavailablephonenumber.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Smsavailablephonenumber -type Smsavailablephonenumber struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // PhoneNumber - A phone number available for provisioning in E.164 format. E.g. +13175555555 or +34234234234 - PhoneNumber *string `json:"phoneNumber,omitempty"` - - - // CountryCode - The ISO 3166-1 alpha-2 country code of the country this phone number is associated with. - CountryCode *string `json:"countryCode,omitempty"` - - - // Region - The region/province/state the phone number is associated with. - Region *string `json:"region,omitempty"` - - - // City - The city the phone number is associated with. - City *string `json:"city,omitempty"` - - - // Capabilities - The capabilities of the phone number available for provisioning. - Capabilities *[]string `json:"capabilities,omitempty"` - - - // PhoneNumberType - The type of phone number available for provisioning. - PhoneNumberType *string `json:"phoneNumberType,omitempty"` - - - // AddressRequirement - The address requirement needed for provisioning this number. If there is a requirement, the address must be the residence or place of business of the individual or entity using the phone number. - AddressRequirement *string `json:"addressRequirement,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Smsavailablephonenumber) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/smsavailablephonenumberentitylisting.go b/build/platformclientv2/smsavailablephonenumberentitylisting.go deleted file mode 100644 index a787023b9..000000000 --- a/build/platformclientv2/smsavailablephonenumberentitylisting.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Smsavailablephonenumberentitylisting -type Smsavailablephonenumberentitylisting struct { - // Entities - Entities *[]Smsavailablephonenumber `json:"entities,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Smsavailablephonenumberentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/smsconfig.go b/build/platformclientv2/smsconfig.go deleted file mode 100644 index 1dc99713c..000000000 --- a/build/platformclientv2/smsconfig.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Smsconfig -type Smsconfig struct { - // MessageColumn - The Contact List column specifying the message to send to the contact. - MessageColumn *string `json:"messageColumn,omitempty"` - - - // PhoneColumn - The Contact List column specifying the phone number to send a message to. - PhoneColumn *string `json:"phoneColumn,omitempty"` - - - // SenderSmsPhoneNumber - A reference to the SMS Phone Number that will be used as the sender of a message. - SenderSmsPhoneNumber *Smsphonenumberref `json:"senderSmsPhoneNumber,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Smsconfig) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/smsphonenumber.go b/build/platformclientv2/smsphonenumber.go deleted file mode 100644 index ae7ea1559..000000000 --- a/build/platformclientv2/smsphonenumber.go +++ /dev/null @@ -1,94 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Smsphonenumber -type Smsphonenumber struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // PhoneNumber - A phone number provisioned for SMS communications in E.164 format. E.g. +13175555555 or +34234234234 - PhoneNumber *string `json:"phoneNumber,omitempty"` - - - // PhoneNumberType - Type of the phone number provisioned. - PhoneNumberType *string `json:"phoneNumberType,omitempty"` - - - // ProvisionedThroughPureCloud - Is set to false, if the phone number is provisioned through a SMS provider, outside of PureCloud - ProvisionedThroughPureCloud *bool `json:"provisionedThroughPureCloud,omitempty"` - - - // PhoneNumberStatus - Status of the provisioned phone number. - PhoneNumberStatus *string `json:"phoneNumberStatus,omitempty"` - - - // Capabilities - The capabilities of the phone number available for provisioning. - Capabilities *[]string `json:"capabilities,omitempty"` - - - // CountryCode - The ISO 3166-1 alpha-2 country code of the country this phone number is associated with. - CountryCode *string `json:"countryCode,omitempty"` - - - // DateCreated - Date this phone number was provisioned. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - Date this phone number was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // CreatedBy - User that provisioned this phone number - CreatedBy *User `json:"createdBy,omitempty"` - - - // ModifiedBy - User that last modified this phone number - ModifiedBy *User `json:"modifiedBy,omitempty"` - - - // Version - Version number required for updates. - Version *int `json:"version,omitempty"` - - - // PurchaseDate - Date this phone number was purchased, if the phoneNumberType is shortcode. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - PurchaseDate *time.Time `json:"purchaseDate,omitempty"` - - - // CancellationDate - Contract end date of this phone number, if the phoneNumberType is shortcode. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - CancellationDate *time.Time `json:"cancellationDate,omitempty"` - - - // RenewalDate - Contract renewal date of this phone number, if the phoneNumberType is shortcode. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - RenewalDate *time.Time `json:"renewalDate,omitempty"` - - - // AutoRenewable - Renewal time period of this phone number, if the phoneNumberType is shortcode. - AutoRenewable *string `json:"autoRenewable,omitempty"` - - - // AddressId - The id of an address attached to this phone number. - AddressId *Smsaddress `json:"addressId,omitempty"` - - - // ShortCodeBillingType - BillingType of this phone number, if the phoneNumberType is shortcode. - ShortCodeBillingType *string `json:"shortCodeBillingType,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Smsphonenumber) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/smsphonenumberentitylisting.go b/build/platformclientv2/smsphonenumberentitylisting.go deleted file mode 100644 index 00a0cabab..000000000 --- a/build/platformclientv2/smsphonenumberentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Smsphonenumberentitylisting -type Smsphonenumberentitylisting struct { - // Entities - Entities *[]Smsphonenumber `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Smsphonenumberentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/smsphonenumberprovision.go b/build/platformclientv2/smsphonenumberprovision.go deleted file mode 100644 index 5a0f81890..000000000 --- a/build/platformclientv2/smsphonenumberprovision.go +++ /dev/null @@ -1,41 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Smsphonenumberprovision -type Smsphonenumberprovision struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // PhoneNumber - A phone number to be used for SMS communications. E.g. +13175555555 or +34234234234 - PhoneNumber *string `json:"phoneNumber,omitempty"` - - - // PhoneNumberType - Type of the phone number provisioned. - PhoneNumberType *string `json:"phoneNumberType,omitempty"` - - - // CountryCode - The ISO 3166-1 alpha-2 country code of the country this phone number is associated with. - CountryCode *string `json:"countryCode,omitempty"` - - - // AddressId - The id of an address added on your account. Due to regulatory requirements in some countries, an address may be required when provisioning a sms number. In those cases you should provide the provisioned sms address id here - AddressId *string `json:"addressId,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Smsphonenumberprovision) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/smsphonenumberref.go b/build/platformclientv2/smsphonenumberref.go deleted file mode 100644 index f48fe3cdf..000000000 --- a/build/platformclientv2/smsphonenumberref.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Smsphonenumberref -type Smsphonenumberref struct { - // PhoneNumber - A phone number provisioned for SMS communications in E.164 format. E.g. +13175555555 or +34234234234 - PhoneNumber *string `json:"phoneNumber,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Smsphonenumberref) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/socialexpression.go b/build/platformclientv2/socialexpression.go deleted file mode 100644 index 7c76dc85b..000000000 --- a/build/platformclientv2/socialexpression.go +++ /dev/null @@ -1,94 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Socialexpression -type Socialexpression struct { - // State - The connection state of this communication. - State *string `json:"state,omitempty"` - - - // Id - A globally unique identifier for this communication. - Id *string `json:"id,omitempty"` - - - // SocialMediaId - A globally unique identifier for the social media. - SocialMediaId *string `json:"socialMediaId,omitempty"` - - - // SocialMediaHub - The social network of the communication - SocialMediaHub *string `json:"socialMediaHub,omitempty"` - - - // SocialUserName - The user name for the communication. - SocialUserName *string `json:"socialUserName,omitempty"` - - - // PreviewText - The text preview of the communication contents - PreviewText *string `json:"previewText,omitempty"` - - - // RecordingId - A globally unique identifier for the recording associated with this chat. - RecordingId *string `json:"recordingId,omitempty"` - - - // Segments - The time line of the participant's chat, divided into activity segments. - Segments *[]Segment `json:"segments,omitempty"` - - - // Held - True if this call is held and the person on this side hears silence. - Held *bool `json:"held,omitempty"` - - - // DisconnectType - System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects. - DisconnectType *string `json:"disconnectType,omitempty"` - - - // StartHoldTime - The timestamp the chat was placed on hold in the cloud clock if the chat is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartHoldTime *time.Time `json:"startHoldTime,omitempty"` - - - // StartAlertingTime - The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartAlertingTime *time.Time `json:"startAlertingTime,omitempty"` - - - // ConnectedTime - The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // DisconnectedTime - The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"` - - - // Provider - The source provider for the social expression. - Provider *string `json:"provider,omitempty"` - - - // ScriptId - The UUID of the script to use. - ScriptId *string `json:"scriptId,omitempty"` - - - // PeerId - The id of the peer communication corresponding to a matching leg for this communication. - PeerId *string `json:"peerId,omitempty"` - - - // Wrapup - Call wrap up or disposition data. - Wrapup *Wrapup `json:"wrapup,omitempty"` - - - // AfterCallWork - After-call work for the communication. - AfterCallWork *Aftercallwork `json:"afterCallWork,omitempty"` - - - // AfterCallWorkRequired - Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested. - AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Socialexpression) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/socialhandle.go b/build/platformclientv2/socialhandle.go deleted file mode 100644 index 20e3b540c..000000000 --- a/build/platformclientv2/socialhandle.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Socialhandle -type Socialhandle struct { - // VarType - VarType *string `json:"type,omitempty"` - - - // Value - Value *string `json:"value,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Socialhandle) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/sortitem.go b/build/platformclientv2/sortitem.go deleted file mode 100644 index 51c5b84f7..000000000 --- a/build/platformclientv2/sortitem.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Sortitem -type Sortitem struct { - // Name - Name *string `json:"name,omitempty"` - - - // Ascending - Ascending *bool `json:"ascending,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Sortitem) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/sourceplanninggrouprequest.go b/build/platformclientv2/sourceplanninggrouprequest.go deleted file mode 100644 index 44d95bb4f..000000000 --- a/build/platformclientv2/sourceplanninggrouprequest.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Sourceplanninggrouprequest - Source planning group -type Sourceplanninggrouprequest struct { - // Id - The ID of the planning group - Id *string `json:"id,omitempty"` - - - // Metadata - Version metadata for the planning group - Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Sourceplanninggrouprequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/speechtextanalyticsapi.go b/build/platformclientv2/speechtextanalyticsapi.go deleted file mode 100644 index 184a35d29..000000000 --- a/build/platformclientv2/speechtextanalyticsapi.go +++ /dev/null @@ -1,381 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "encoding/json" -) - -// SpeechTextAnalyticsApi provides functions for API endpoints -type SpeechTextAnalyticsApi struct { - Configuration *Configuration -} - -// NewSpeechTextAnalyticsApi creates an API instance using the default configuration -func NewSpeechTextAnalyticsApi() *SpeechTextAnalyticsApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating SpeechTextAnalyticsApi with base path: %s", strings.ToLower(config.BasePath))) - return &SpeechTextAnalyticsApi{ - Configuration: config, - } -} - -// NewSpeechTextAnalyticsApiWithConfig creates an API instance using the provided configuration -func NewSpeechTextAnalyticsApiWithConfig(config *Configuration) *SpeechTextAnalyticsApi { - config.Debugf("Creating SpeechTextAnalyticsApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &SpeechTextAnalyticsApi{ - Configuration: config, - } -} - -// GetSpeechandtextanalyticsConversation invokes GET /api/v2/speechandtextanalytics/conversations/{conversationId} -// -// Get Speech and Text Analytics for a specific conversation -// -// -func (a SpeechTextAnalyticsApi) GetSpeechandtextanalyticsConversation(conversationId string) (*Conversationmetrics, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/speechandtextanalytics/conversations/{conversationId}" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - defaultReturn := new(Conversationmetrics) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling SpeechTextAnalyticsApi->GetSpeechandtextanalyticsConversation") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Conversationmetrics - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetSpeechandtextanalyticsConversationCommunicationTranscripturl invokes GET /api/v2/speechandtextanalytics/conversations/{conversationId}/communications/{communicationId}/transcripturl -// -// Get the pre-signed S3 URL for the transcript of a specific communication of a conversation -// -// -func (a SpeechTextAnalyticsApi) GetSpeechandtextanalyticsConversationCommunicationTranscripturl(conversationId string, communicationId string) (*Transcripturl, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/speechandtextanalytics/conversations/{conversationId}/communications/{communicationId}/transcripturl" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{communicationId}", fmt.Sprintf("%v", communicationId), -1) - defaultReturn := new(Transcripturl) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling SpeechTextAnalyticsApi->GetSpeechandtextanalyticsConversationCommunicationTranscripturl") - } - // verify the required parameter 'communicationId' is set - if &communicationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'communicationId' when calling SpeechTextAnalyticsApi->GetSpeechandtextanalyticsConversationCommunicationTranscripturl") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Transcripturl - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetSpeechandtextanalyticsSettings invokes GET /api/v2/speechandtextanalytics/settings -// -// Get Speech And Text Analytics Settings -// -// -func (a SpeechTextAnalyticsApi) GetSpeechandtextanalyticsSettings() (*Speechtextanalyticssettingsresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/speechandtextanalytics/settings" - defaultReturn := new(Speechtextanalyticssettingsresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Speechtextanalyticssettingsresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchSpeechandtextanalyticsSettings invokes PATCH /api/v2/speechandtextanalytics/settings -// -// Patch Speech And Text Analytics Settings -// -// -func (a SpeechTextAnalyticsApi) PatchSpeechandtextanalyticsSettings(body Speechtextanalyticssettingsrequest) (*Speechtextanalyticssettingsresponse, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/speechandtextanalytics/settings" - defaultReturn := new(Speechtextanalyticssettingsresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling SpeechTextAnalyticsApi->PatchSpeechandtextanalyticsSettings") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Speechtextanalyticssettingsresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostSpeechandtextanalyticsTranscriptsSearch invokes POST /api/v2/speechandtextanalytics/transcripts/search -// -// Search resources. -// -// -func (a SpeechTextAnalyticsApi) PostSpeechandtextanalyticsTranscriptsSearch(body Transcriptsearchrequest) (*Jsonsearchresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/speechandtextanalytics/transcripts/search" - defaultReturn := new(Jsonsearchresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling SpeechTextAnalyticsApi->PostSpeechandtextanalyticsTranscriptsSearch") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Jsonsearchresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/speechtextanalyticssettingsrequest.go b/build/platformclientv2/speechtextanalyticssettingsrequest.go deleted file mode 100644 index 64692a09b..000000000 --- a/build/platformclientv2/speechtextanalyticssettingsrequest.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Speechtextanalyticssettingsrequest -type Speechtextanalyticssettingsrequest struct { - // DefaultProgramId - Setting to choose name for the default program for topic detection - DefaultProgramId *string `json:"defaultProgramId,omitempty"` - - - // ExpectedDialects - Setting to choose expected dialects - ExpectedDialects *[]string `json:"expectedDialects,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Speechtextanalyticssettingsrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/speechtextanalyticssettingsresponse.go b/build/platformclientv2/speechtextanalyticssettingsresponse.go deleted file mode 100644 index 57f8a70f5..000000000 --- a/build/platformclientv2/speechtextanalyticssettingsresponse.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Speechtextanalyticssettingsresponse -type Speechtextanalyticssettingsresponse struct { - // DefaultProgram - Setting to choose name for the default program for topic detection - DefaultProgram *Addressableentityref `json:"defaultProgram,omitempty"` - - - // ExpectedDialects - Setting to choose expected dialects - ExpectedDialects *[]string `json:"expectedDialects,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Speechtextanalyticssettingsresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/stateventcampaigntopicdatum.go b/build/platformclientv2/stateventcampaigntopicdatum.go deleted file mode 100644 index 0b29e4cf2..000000000 --- a/build/platformclientv2/stateventcampaigntopicdatum.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Stateventcampaigntopicdatum -type Stateventcampaigntopicdatum struct { - // Interval - Interval *string `json:"interval,omitempty"` - - - // Metrics - Metrics *[]Stateventcampaigntopicmetric `json:"metrics,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Stateventcampaigntopicdatum) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/stateventcampaigntopicmetric.go b/build/platformclientv2/stateventcampaigntopicmetric.go deleted file mode 100644 index 281c51a4c..000000000 --- a/build/platformclientv2/stateventcampaigntopicmetric.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Stateventcampaigntopicmetric -type Stateventcampaigntopicmetric struct { - // Metric - Metric *string `json:"metric,omitempty"` - - - // Qualifier - Qualifier *string `json:"qualifier,omitempty"` - - - // Stats - Stats *map[string]float32 `json:"stats,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Stateventcampaigntopicmetric) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/stateventcampaigntopicstatsnotification.go b/build/platformclientv2/stateventcampaigntopicstatsnotification.go deleted file mode 100644 index b9d7d0d2e..000000000 --- a/build/platformclientv2/stateventcampaigntopicstatsnotification.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Stateventcampaigntopicstatsnotification -type Stateventcampaigntopicstatsnotification struct { - // Group - Group *map[string]string `json:"group,omitempty"` - - - // Data - Data *[]Stateventcampaigntopicdatum `json:"data,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Stateventcampaigntopicstatsnotification) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/stateventflowoutcometopicdatum.go b/build/platformclientv2/stateventflowoutcometopicdatum.go deleted file mode 100644 index 794faebac..000000000 --- a/build/platformclientv2/stateventflowoutcometopicdatum.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Stateventflowoutcometopicdatum -type Stateventflowoutcometopicdatum struct { - // Interval - Interval *string `json:"interval,omitempty"` - - - // Metrics - Metrics *[]Stateventflowoutcometopicmetric `json:"metrics,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Stateventflowoutcometopicdatum) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/stateventflowoutcometopicmetric.go b/build/platformclientv2/stateventflowoutcometopicmetric.go deleted file mode 100644 index 3d1eddce4..000000000 --- a/build/platformclientv2/stateventflowoutcometopicmetric.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Stateventflowoutcometopicmetric -type Stateventflowoutcometopicmetric struct { - // Metric - Metric *string `json:"metric,omitempty"` - - - // Qualifier - Qualifier *string `json:"qualifier,omitempty"` - - - // Stats - Stats *map[string]float32 `json:"stats,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Stateventflowoutcometopicmetric) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/stateventflowoutcometopicstatsnotification.go b/build/platformclientv2/stateventflowoutcometopicstatsnotification.go deleted file mode 100644 index 0a56b1cfc..000000000 --- a/build/platformclientv2/stateventflowoutcometopicstatsnotification.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Stateventflowoutcometopicstatsnotification -type Stateventflowoutcometopicstatsnotification struct { - // Group - Group *map[string]string `json:"group,omitempty"` - - - // Data - Data *[]Stateventflowoutcometopicdatum `json:"data,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Stateventflowoutcometopicstatsnotification) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/stateventflowtopicdatum.go b/build/platformclientv2/stateventflowtopicdatum.go deleted file mode 100644 index 336d08472..000000000 --- a/build/platformclientv2/stateventflowtopicdatum.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Stateventflowtopicdatum -type Stateventflowtopicdatum struct { - // Interval - Interval *string `json:"interval,omitempty"` - - - // Metrics - Metrics *[]Stateventflowtopicmetric `json:"metrics,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Stateventflowtopicdatum) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/stateventflowtopicmetric.go b/build/platformclientv2/stateventflowtopicmetric.go deleted file mode 100644 index f9a494a45..000000000 --- a/build/platformclientv2/stateventflowtopicmetric.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Stateventflowtopicmetric -type Stateventflowtopicmetric struct { - // Metric - Metric *string `json:"metric,omitempty"` - - - // Qualifier - Qualifier *string `json:"qualifier,omitempty"` - - - // Stats - Stats *map[string]float32 `json:"stats,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Stateventflowtopicmetric) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/stateventflowtopicstatsnotification.go b/build/platformclientv2/stateventflowtopicstatsnotification.go deleted file mode 100644 index 366d05365..000000000 --- a/build/platformclientv2/stateventflowtopicstatsnotification.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Stateventflowtopicstatsnotification -type Stateventflowtopicstatsnotification struct { - // Group - Group *map[string]string `json:"group,omitempty"` - - - // Data - Data *[]Stateventflowtopicdatum `json:"data,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Stateventflowtopicstatsnotification) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/stateventqueuetopicdatum.go b/build/platformclientv2/stateventqueuetopicdatum.go deleted file mode 100644 index 2dc419d92..000000000 --- a/build/platformclientv2/stateventqueuetopicdatum.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Stateventqueuetopicdatum -type Stateventqueuetopicdatum struct { - // Interval - Interval *string `json:"interval,omitempty"` - - - // Metrics - Metrics *[]Stateventqueuetopicmetric `json:"metrics,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Stateventqueuetopicdatum) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/stateventqueuetopicmetric.go b/build/platformclientv2/stateventqueuetopicmetric.go deleted file mode 100644 index 4de6efd60..000000000 --- a/build/platformclientv2/stateventqueuetopicmetric.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Stateventqueuetopicmetric -type Stateventqueuetopicmetric struct { - // Metric - Metric *string `json:"metric,omitempty"` - - - // Qualifier - Qualifier *string `json:"qualifier,omitempty"` - - - // Stats - Stats *map[string]float32 `json:"stats,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Stateventqueuetopicmetric) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/stateventqueuetopicstatsnotification.go b/build/platformclientv2/stateventqueuetopicstatsnotification.go deleted file mode 100644 index cce84beb8..000000000 --- a/build/platformclientv2/stateventqueuetopicstatsnotification.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Stateventqueuetopicstatsnotification -type Stateventqueuetopicstatsnotification struct { - // Group - Group *map[string]string `json:"group,omitempty"` - - - // Data - Data *[]Stateventqueuetopicdatum `json:"data,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Stateventqueuetopicstatsnotification) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/stateventusertopicdatum.go b/build/platformclientv2/stateventusertopicdatum.go deleted file mode 100644 index f384e2182..000000000 --- a/build/platformclientv2/stateventusertopicdatum.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Stateventusertopicdatum -type Stateventusertopicdatum struct { - // Interval - Interval *string `json:"interval,omitempty"` - - - // Metrics - Metrics *[]Stateventusertopicmetric `json:"metrics,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Stateventusertopicdatum) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/stateventusertopicmetric.go b/build/platformclientv2/stateventusertopicmetric.go deleted file mode 100644 index 872bfc4e0..000000000 --- a/build/platformclientv2/stateventusertopicmetric.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Stateventusertopicmetric -type Stateventusertopicmetric struct { - // Metric - Metric *string `json:"metric,omitempty"` - - - // Qualifier - Qualifier *string `json:"qualifier,omitempty"` - - - // Stats - Stats *map[string]float32 `json:"stats,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Stateventusertopicmetric) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/stateventusertopicstatsnotification.go b/build/platformclientv2/stateventusertopicstatsnotification.go deleted file mode 100644 index c32d0a91f..000000000 --- a/build/platformclientv2/stateventusertopicstatsnotification.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Stateventusertopicstatsnotification -type Stateventusertopicstatsnotification struct { - // Group - Group *map[string]string `json:"group,omitempty"` - - - // Data - Data *[]Stateventusertopicdatum `json:"data,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Stateventusertopicstatsnotification) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/stateventwrapupcodetopicdatum.go b/build/platformclientv2/stateventwrapupcodetopicdatum.go deleted file mode 100644 index c6005e55a..000000000 --- a/build/platformclientv2/stateventwrapupcodetopicdatum.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Stateventwrapupcodetopicdatum -type Stateventwrapupcodetopicdatum struct { - // Interval - Interval *string `json:"interval,omitempty"` - - - // Metrics - Metrics *[]Stateventwrapupcodetopicmetric `json:"metrics,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Stateventwrapupcodetopicdatum) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/stateventwrapupcodetopicmetric.go b/build/platformclientv2/stateventwrapupcodetopicmetric.go deleted file mode 100644 index e892d301c..000000000 --- a/build/platformclientv2/stateventwrapupcodetopicmetric.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Stateventwrapupcodetopicmetric -type Stateventwrapupcodetopicmetric struct { - // Metric - Metric *string `json:"metric,omitempty"` - - - // Qualifier - Qualifier *string `json:"qualifier,omitempty"` - - - // Stats - Stats *map[string]float32 `json:"stats,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Stateventwrapupcodetopicmetric) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/stateventwrapupcodetopicstatsnotification.go b/build/platformclientv2/stateventwrapupcodetopicstatsnotification.go deleted file mode 100644 index fa79ab632..000000000 --- a/build/platformclientv2/stateventwrapupcodetopicstatsnotification.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Stateventwrapupcodetopicstatsnotification -type Stateventwrapupcodetopicstatsnotification struct { - // Group - Group *map[string]string `json:"group,omitempty"` - - - // Data - Data *[]Stateventwrapupcodetopicdatum `json:"data,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Stateventwrapupcodetopicstatsnotification) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/station.go b/build/platformclientv2/station.go deleted file mode 100644 index a3a08e124..000000000 --- a/build/platformclientv2/station.go +++ /dev/null @@ -1,69 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Station -type Station struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Description - Description *string `json:"description,omitempty"` - - - // Status - Status *string `json:"status,omitempty"` - - - // UserId - The Id of the user currently logged in and associated with the station. - UserId *string `json:"userId,omitempty"` - - - // WebRtcUserId - The Id of the user configured for the station if it is of type inin_webrtc_softphone. Empty if station type is not inin_webrtc_softphone. - WebRtcUserId *string `json:"webRtcUserId,omitempty"` - - - // PrimaryEdge - PrimaryEdge *Domainentityref `json:"primaryEdge,omitempty"` - - - // SecondaryEdge - SecondaryEdge *Domainentityref `json:"secondaryEdge,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - - - // LineAppearanceId - LineAppearanceId *string `json:"lineAppearanceId,omitempty"` - - - // WebRtcMediaDscp - The default or configured value of media dscp for the station. Empty if station type is not inin_webrtc_softphone. - WebRtcMediaDscp *int `json:"webRtcMediaDscp,omitempty"` - - - // WebRtcPersistentEnabled - The default or configured value of persistent connection setting for the station. Empty if station type is not inin_webrtc_softphone. - WebRtcPersistentEnabled *bool `json:"webRtcPersistentEnabled,omitempty"` - - - // WebRtcForceTurn - Whether the station is configured to require TURN for routing WebRTC calls. Empty if station type is not inin_webrtc_softphone. - WebRtcForceTurn *bool `json:"webRtcForceTurn,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Station) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/stationentitylisting.go b/build/platformclientv2/stationentitylisting.go deleted file mode 100644 index 576eeb649..000000000 --- a/build/platformclientv2/stationentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Stationentitylisting -type Stationentitylisting struct { - // Entities - Entities *[]Station `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Stationentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/stationsapi.go b/build/platformclientv2/stationsapi.go deleted file mode 100644 index 98232e1e4..000000000 --- a/build/platformclientv2/stationsapi.go +++ /dev/null @@ -1,462 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "encoding/json" -) - -// StationsApi provides functions for API endpoints -type StationsApi struct { - Configuration *Configuration -} - -// NewStationsApi creates an API instance using the default configuration -func NewStationsApi() *StationsApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating StationsApi with base path: %s", strings.ToLower(config.BasePath))) - return &StationsApi{ - Configuration: config, - } -} - -// NewStationsApiWithConfig creates an API instance using the provided configuration -func NewStationsApiWithConfig(config *Configuration) *StationsApi { - config.Debugf("Creating StationsApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &StationsApi{ - Configuration: config, - } -} - -// DeleteStationAssociateduser invokes DELETE /api/v2/stations/{stationId}/associateduser -// -// Unassigns the user assigned to this station -// -// -func (a StationsApi) DeleteStationAssociateduser(stationId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/stations/{stationId}/associateduser" - path = strings.Replace(path, "{stationId}", fmt.Sprintf("%v", stationId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'stationId' is set - if &stationId == nil { - // - return nil, errors.New("Missing required parameter 'stationId' when calling StationsApi->DeleteStationAssociateduser") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// GetStation invokes GET /api/v2/stations/{stationId} -// -// Get station. -// -// -func (a StationsApi) GetStation(stationId string) (*Station, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/stations/{stationId}" - path = strings.Replace(path, "{stationId}", fmt.Sprintf("%v", stationId), -1) - defaultReturn := new(Station) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'stationId' is set - if &stationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'stationId' when calling StationsApi->GetStation") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Station - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetStations invokes GET /api/v2/stations -// -// Get the list of available stations. -// -// -func (a StationsApi) GetStations(pageSize int, pageNumber int, sortBy string, name string, userSelectable string, webRtcUserId string, id string, lineAppearanceId string) (*Stationentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/stations" - defaultReturn := new(Stationentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(userSelectable).(string); ok { - if str != "" { - queryParams["userSelectable"] = a.Configuration.APIClient.ParameterToString(userSelectable, collectionFormat) - } - } else { - queryParams["userSelectable"] = a.Configuration.APIClient.ParameterToString(userSelectable, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(webRtcUserId).(string); ok { - if str != "" { - queryParams["webRtcUserId"] = a.Configuration.APIClient.ParameterToString(webRtcUserId, collectionFormat) - } - } else { - queryParams["webRtcUserId"] = a.Configuration.APIClient.ParameterToString(webRtcUserId, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(id).(string); ok { - if str != "" { - queryParams["id"] = a.Configuration.APIClient.ParameterToString(id, collectionFormat) - } - } else { - queryParams["id"] = a.Configuration.APIClient.ParameterToString(id, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(lineAppearanceId).(string); ok { - if str != "" { - queryParams["lineAppearanceId"] = a.Configuration.APIClient.ParameterToString(lineAppearanceId, collectionFormat) - } - } else { - queryParams["lineAppearanceId"] = a.Configuration.APIClient.ParameterToString(lineAppearanceId, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Stationentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetStationsSettings invokes GET /api/v2/stations/settings -// -// Get an organization's StationSettings -// -// -func (a StationsApi) GetStationsSettings() (*Stationsettings, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/stations/settings" - defaultReturn := new(Stationsettings) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Stationsettings - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchStationsSettings invokes PATCH /api/v2/stations/settings -// -// Patch an organization's StationSettings -// -// -func (a StationsApi) PatchStationsSettings(body Stationsettings) (*Stationsettings, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/stations/settings" - defaultReturn := new(Stationsettings) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling StationsApi->PatchStationsSettings") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Stationsettings - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/stationsettings.go b/build/platformclientv2/stationsettings.go deleted file mode 100644 index a7978ec0a..000000000 --- a/build/platformclientv2/stationsettings.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Stationsettings - Organization settings for stations -type Stationsettings struct { - // FreeSeatingConfiguration - Configuration options for free-seating - FreeSeatingConfiguration *Freeseatingconfiguration `json:"freeSeatingConfiguration,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Stationsettings) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/statisticalresponse.go b/build/platformclientv2/statisticalresponse.go deleted file mode 100644 index 51be29bdd..000000000 --- a/build/platformclientv2/statisticalresponse.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Statisticalresponse -type Statisticalresponse struct { - // Interval - Interval *string `json:"interval,omitempty"` - - - // Metrics - Metrics *[]Aggregatemetricdata `json:"metrics,omitempty"` - - - // Views - Views *[]Aggregateviewdata `json:"views,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Statisticalresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/statisticalsummary.go b/build/platformclientv2/statisticalsummary.go deleted file mode 100644 index e2af5911a..000000000 --- a/build/platformclientv2/statisticalsummary.go +++ /dev/null @@ -1,57 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Statisticalsummary -type Statisticalsummary struct { - // Max - Max *float32 `json:"max,omitempty"` - - - // Min - Min *float32 `json:"min,omitempty"` - - - // Count - Count *int `json:"count,omitempty"` - - - // CountNegative - CountNegative *int `json:"countNegative,omitempty"` - - - // CountPositive - CountPositive *int `json:"countPositive,omitempty"` - - - // Sum - Sum *float32 `json:"sum,omitempty"` - - - // Current - Current *float32 `json:"current,omitempty"` - - - // Ratio - Ratio *float32 `json:"ratio,omitempty"` - - - // Numerator - Numerator *float32 `json:"numerator,omitempty"` - - - // Denominator - Denominator *float32 `json:"denominator,omitempty"` - - - // Target - Target *float32 `json:"target,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Statisticalsummary) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/streetaddress.go b/build/platformclientv2/streetaddress.go deleted file mode 100644 index 44f5567c7..000000000 --- a/build/platformclientv2/streetaddress.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Streetaddress -type Streetaddress struct { - // Country - 2 Letter Country code, like US or GB - Country *string `json:"country,omitempty"` - - - // A1 - State or Province - A1 *string `json:"A1,omitempty"` - - - // A3 - City or township - A3 *string `json:"A3,omitempty"` - - - // RD - RD *string `json:"RD,omitempty"` - - - // HNO - HNO *string `json:"HNO,omitempty"` - - - // LOC - LOC *string `json:"LOC,omitempty"` - - - // NAM - NAM *string `json:"NAM,omitempty"` - - - // PC - PC *string `json:"PC,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Streetaddress) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/subjectdivisiongrants.go b/build/platformclientv2/subjectdivisiongrants.go deleted file mode 100644 index 9b56e12e1..000000000 --- a/build/platformclientv2/subjectdivisiongrants.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Subjectdivisiongrants -type Subjectdivisiongrants struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Divisions - Divisions *[]Division `json:"divisions,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Subjectdivisiongrants) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/subjectdivisiongrantsentitylisting.go b/build/platformclientv2/subjectdivisiongrantsentitylisting.go deleted file mode 100644 index 506f0baab..000000000 --- a/build/platformclientv2/subjectdivisiongrantsentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Subjectdivisiongrantsentitylisting -type Subjectdivisiongrantsentitylisting struct { - // Entities - Entities *[]Subjectdivisiongrants `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Subjectdivisiongrantsentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/subjectdivisions.go b/build/platformclientv2/subjectdivisions.go deleted file mode 100644 index bec5f38ab..000000000 --- a/build/platformclientv2/subjectdivisions.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Subjectdivisions -type Subjectdivisions struct { - // SubjectIds - A collection of subject IDs to associate with the given divisions - SubjectIds *[]string `json:"subjectIds,omitempty"` - - - // DivisionIds - A collection of division IDs to associate with the given subjects - DivisionIds *[]string `json:"divisionIds,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Subjectdivisions) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/subscriberresponse.go b/build/platformclientv2/subscriberresponse.go deleted file mode 100644 index d7a8f5055..000000000 --- a/build/platformclientv2/subscriberresponse.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Subscriberresponse -type Subscriberresponse struct { - // MessageReturned - Suggested valid addresses - MessageReturned *[]string `json:"messageReturned,omitempty"` - - - // Status - http status - Status *string `json:"status,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Subscriberresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/subscriptionoverviewusage.go b/build/platformclientv2/subscriptionoverviewusage.go deleted file mode 100644 index f7a18727c..000000000 --- a/build/platformclientv2/subscriptionoverviewusage.go +++ /dev/null @@ -1,61 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Subscriptionoverviewusage -type Subscriptionoverviewusage struct { - // Name - Product charge name - Name *string `json:"name,omitempty"` - - - // PartNumber - Product part number - PartNumber *string `json:"partNumber,omitempty"` - - - // Grouping - UI grouping key - Grouping *string `json:"grouping,omitempty"` - - - // UnitOfMeasureType - UI unit of measure - UnitOfMeasureType *string `json:"unitOfMeasureType,omitempty"` - - - // UsageQuantity - Usage count for specified period - UsageQuantity *string `json:"usageQuantity,omitempty"` - - - // OveragePrice - Price for usage / overage charge - OveragePrice *string `json:"overagePrice,omitempty"` - - - // PrepayQuantity - Items prepaid for specified period - PrepayQuantity *string `json:"prepayQuantity,omitempty"` - - - // PrepayPrice - Price for prepay charge - PrepayPrice *string `json:"prepayPrice,omitempty"` - - - // UsageNotes - Notes about the usage/charge item - UsageNotes *string `json:"usageNotes,omitempty"` - - - // IsCancellable - Indicates whether the item is cancellable - IsCancellable *bool `json:"isCancellable,omitempty"` - - - // BundleQuantity - Quantity multiplier for this charge - BundleQuantity *string `json:"bundleQuantity,omitempty"` - - - // IsThirdParty - A charge from a third party entity - IsThirdParty *bool `json:"isThirdParty,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Subscriptionoverviewusage) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/suggestapi.go b/build/platformclientv2/suggestapi.go deleted file mode 100644 index c870cc7ff..000000000 --- a/build/platformclientv2/suggestapi.go +++ /dev/null @@ -1,414 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "encoding/json" -) - -// SuggestApi provides functions for API endpoints -type SuggestApi struct { - Configuration *Configuration -} - -// NewSuggestApi creates an API instance using the default configuration -func NewSuggestApi() *SuggestApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating SuggestApi with base path: %s", strings.ToLower(config.BasePath))) - return &SuggestApi{ - Configuration: config, - } -} - -// NewSuggestApiWithConfig creates an API instance using the provided configuration -func NewSuggestApiWithConfig(config *Configuration) *SuggestApi { - config.Debugf("Creating SuggestApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &SuggestApi{ - Configuration: config, - } -} - -// GetSearch invokes GET /api/v2/search -// -// Search using the q64 value returned from a previous search. -// -// -func (a SuggestApi) GetSearch(q64 string, expand []string, profile bool) (*Jsonnodesearchresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/search" - defaultReturn := new(Jsonnodesearchresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'q64' is set - if &q64 == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'q64' when calling SuggestApi->GetSearch") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(q64).(string); ok { - if str != "" { - queryParams["q64"] = a.Configuration.APIClient.ParameterToString(q64, collectionFormat) - } - } else { - queryParams["q64"] = a.Configuration.APIClient.ParameterToString(q64, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(profile).(string); ok { - if str != "" { - queryParams["profile"] = a.Configuration.APIClient.ParameterToString(profile, collectionFormat) - } - } else { - queryParams["profile"] = a.Configuration.APIClient.ParameterToString(profile, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Jsonnodesearchresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetSearchSuggest invokes GET /api/v2/search/suggest -// -// Suggest resources using the q64 value returned from a previous suggest query. -// -// -func (a SuggestApi) GetSearchSuggest(q64 string, expand []string, profile bool) (*Jsonnodesearchresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/search/suggest" - defaultReturn := new(Jsonnodesearchresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'q64' is set - if &q64 == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'q64' when calling SuggestApi->GetSearchSuggest") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(q64).(string); ok { - if str != "" { - queryParams["q64"] = a.Configuration.APIClient.ParameterToString(q64, collectionFormat) - } - } else { - queryParams["q64"] = a.Configuration.APIClient.ParameterToString(q64, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(profile).(string); ok { - if str != "" { - queryParams["profile"] = a.Configuration.APIClient.ParameterToString(profile, collectionFormat) - } - } else { - queryParams["profile"] = a.Configuration.APIClient.ParameterToString(profile, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Jsonnodesearchresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostSearch invokes POST /api/v2/search -// -// Search resources. -// -// -func (a SuggestApi) PostSearch(body Searchrequest, profile bool) (*Jsonnodesearchresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/search" - defaultReturn := new(Jsonnodesearchresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling SuggestApi->PostSearch") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(profile).(string); ok { - if str != "" { - queryParams["profile"] = a.Configuration.APIClient.ParameterToString(profile, collectionFormat) - } - } else { - queryParams["profile"] = a.Configuration.APIClient.ParameterToString(profile, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Jsonnodesearchresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostSearchSuggest invokes POST /api/v2/search/suggest -// -// Suggest resources. -// -// -func (a SuggestApi) PostSearchSuggest(body Suggestsearchrequest, profile bool) (*Jsonnodesearchresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/search/suggest" - defaultReturn := new(Jsonnodesearchresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling SuggestApi->PostSearchSuggest") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(profile).(string); ok { - if str != "" { - queryParams["profile"] = a.Configuration.APIClient.ParameterToString(profile, collectionFormat) - } - } else { - queryParams["profile"] = a.Configuration.APIClient.ParameterToString(profile, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Jsonnodesearchresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/suggestsearchcriteria.go b/build/platformclientv2/suggestsearchcriteria.go deleted file mode 100644 index f2352f3c3..000000000 --- a/build/platformclientv2/suggestsearchcriteria.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Suggestsearchcriteria -type Suggestsearchcriteria struct { - // EndValue - The end value of the range. This field is used for range search types. - EndValue *string `json:"endValue,omitempty"` - - - // Values - A list of values for the search to match against - Values *[]string `json:"values,omitempty"` - - - // StartValue - The start value of the range. This field is used for range search types. - StartValue *string `json:"startValue,omitempty"` - - - // Fields - Field names to search against - Fields *[]string `json:"fields,omitempty"` - - - // Value - A value for the search to match against - Value *string `json:"value,omitempty"` - - - // Operator - How to apply this search criteria against other criteria - Operator *string `json:"operator,omitempty"` - - - // Group - Groups multiple conditions - Group *[]Suggestsearchcriteria `json:"group,omitempty"` - - - // DateFormat - Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX. - DateFormat *string `json:"dateFormat,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Suggestsearchcriteria) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/suggestsearchrequest.go b/build/platformclientv2/suggestsearchrequest.go deleted file mode 100644 index 17b6d9654..000000000 --- a/build/platformclientv2/suggestsearchrequest.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Suggestsearchrequest -type Suggestsearchrequest struct { - // Expand - Provides more details about a specified resource - Expand *[]string `json:"expand,omitempty"` - - - // Types - Resource domain type to search - Types *[]string `json:"types,omitempty"` - - - // Query - Suggest query - Query *[]Suggestsearchcriteria `json:"query,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Suggestsearchrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/supportedcontent.go b/build/platformclientv2/supportedcontent.go deleted file mode 100644 index 5ca9d9feb..000000000 --- a/build/platformclientv2/supportedcontent.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Supportedcontent - Supported content for inbound and outbound messages -type Supportedcontent struct { - // MediaTypes - Defines the allowable media that may be accepted for an inbound message or to be sent in an outbound message. The following is an example of allowing all inbound media, and for outbound all images and only mpeg video: { \"mediaTypes\": { \"allow\": { \"inbound\": [{\"type\": \"*/*\"}], \"outbound\": [{\"type\": \"image/*\"}, {\"type\": \"video/mpeg\"}] } } } - MediaTypes *Mediatypes `json:"mediaTypes,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Supportedcontent) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/supportedlanguage.go b/build/platformclientv2/supportedlanguage.go deleted file mode 100644 index 848a117b8..000000000 --- a/build/platformclientv2/supportedlanguage.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Supportedlanguage -type Supportedlanguage struct { - // Language - Architect supported language tag, e.g. en-us, es-us - Language *string `json:"language,omitempty"` - - - // IsDefault - Whether or not this language is the default language - IsDefault *bool `json:"isDefault,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Supportedlanguage) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/survey.go b/build/platformclientv2/survey.go deleted file mode 100644 index adc5ecdef..000000000 --- a/build/platformclientv2/survey.go +++ /dev/null @@ -1,58 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Survey -type Survey struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Conversation - Conversation *Conversation `json:"conversation,omitempty"` - - - // SurveyForm - Survey form used for this survey. - SurveyForm *Surveyform `json:"surveyForm,omitempty"` - - - // Agent - Agent *Domainentityref `json:"agent,omitempty"` - - - // Status - Status *string `json:"status,omitempty"` - - - // Queue - Queue *Queuereference `json:"queue,omitempty"` - - - // Answers - Answers *Surveyscoringset `json:"answers,omitempty"` - - - // CompletedDate - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - CompletedDate *time.Time `json:"completedDate,omitempty"` - - - // SurveyErrorDetails - Additional information about what happened when the survey is in Error status. - SurveyErrorDetails *Surveyerrordetails `json:"surveyErrorDetails,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Survey) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/surveyaggregatedatacontainer.go b/build/platformclientv2/surveyaggregatedatacontainer.go deleted file mode 100644 index e5130785a..000000000 --- a/build/platformclientv2/surveyaggregatedatacontainer.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Surveyaggregatedatacontainer -type Surveyaggregatedatacontainer struct { - // Group - A mapping from dimension to value - Group *map[string]string `json:"group,omitempty"` - - - // Data - Data *[]Statisticalresponse `json:"data,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Surveyaggregatedatacontainer) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/surveyaggregatequeryclause.go b/build/platformclientv2/surveyaggregatequeryclause.go deleted file mode 100644 index 3097f9cc9..000000000 --- a/build/platformclientv2/surveyaggregatequeryclause.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Surveyaggregatequeryclause -type Surveyaggregatequeryclause struct { - // VarType - Boolean operation to apply to the provided predicates - VarType *string `json:"type,omitempty"` - - - // Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value). - Predicates *[]Surveyaggregatequerypredicate `json:"predicates,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Surveyaggregatequeryclause) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/surveyaggregatequeryfilter.go b/build/platformclientv2/surveyaggregatequeryfilter.go deleted file mode 100644 index da5fe3957..000000000 --- a/build/platformclientv2/surveyaggregatequeryfilter.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Surveyaggregatequeryfilter -type Surveyaggregatequeryfilter struct { - // VarType - Boolean operation to apply to the provided predicates and clauses - VarType *string `json:"type,omitempty"` - - - // Clauses - Boolean 'and/or' logic with up to two-levels of nesting - Clauses *[]Surveyaggregatequeryclause `json:"clauses,omitempty"` - - - // Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value). - Predicates *[]Surveyaggregatequerypredicate `json:"predicates,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Surveyaggregatequeryfilter) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/surveyaggregatequerypredicate.go b/build/platformclientv2/surveyaggregatequerypredicate.go deleted file mode 100644 index 285a654af..000000000 --- a/build/platformclientv2/surveyaggregatequerypredicate.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Surveyaggregatequerypredicate -type Surveyaggregatequerypredicate struct { - // VarType - Optional type, can usually be inferred - VarType *string `json:"type,omitempty"` - - - // Dimension - Left hand side for dimension predicates - Dimension *string `json:"dimension,omitempty"` - - - // Operator - Optional operator, default is matches - Operator *string `json:"operator,omitempty"` - - - // Value - Right hand side for dimension predicates - Value *string `json:"value,omitempty"` - - - // VarRange - Right hand side for dimension predicates - VarRange *Numericrange `json:"range,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Surveyaggregatequerypredicate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/surveyaggregatequeryresponse.go b/build/platformclientv2/surveyaggregatequeryresponse.go deleted file mode 100644 index 32704305b..000000000 --- a/build/platformclientv2/surveyaggregatequeryresponse.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Surveyaggregatequeryresponse -type Surveyaggregatequeryresponse struct { - // Results - Results *[]Surveyaggregatedatacontainer `json:"results,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Surveyaggregatequeryresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/surveyaggregationquery.go b/build/platformclientv2/surveyaggregationquery.go deleted file mode 100644 index b3667f091..000000000 --- a/build/platformclientv2/surveyaggregationquery.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Surveyaggregationquery -type Surveyaggregationquery struct { - // Interval - Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss - Interval *string `json:"interval,omitempty"` - - - // Granularity - Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H - Granularity *string `json:"granularity,omitempty"` - - - // TimeZone - Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London - TimeZone *string `json:"timeZone,omitempty"` - - - // GroupBy - Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group. - GroupBy *[]string `json:"groupBy,omitempty"` - - - // Filter - Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters - Filter *Surveyaggregatequeryfilter `json:"filter,omitempty"` - - - // Metrics - Behaves like a SQL SELECT clause. Only named metrics will be retrieved. - Metrics *[]string `json:"metrics,omitempty"` - - - // FlattenMultivaluedDimensions - Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c') - FlattenMultivaluedDimensions *bool `json:"flattenMultivaluedDimensions,omitempty"` - - - // Views - Custom derived metric views - Views *[]Surveyaggregationview `json:"views,omitempty"` - - - // AlternateTimeDimension - Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event. - AlternateTimeDimension *string `json:"alternateTimeDimension,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Surveyaggregationquery) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/surveyaggregationview.go b/build/platformclientv2/surveyaggregationview.go deleted file mode 100644 index 0330586c0..000000000 --- a/build/platformclientv2/surveyaggregationview.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Surveyaggregationview -type Surveyaggregationview struct { - // Target - Target metric name - Target *string `json:"target,omitempty"` - - - // Name - A unique name for this view. Must be distinct from other views and built-in metric names. - Name *string `json:"name,omitempty"` - - - // Function - Type of view you wish to create - Function *string `json:"function,omitempty"` - - - // VarRange - Range of numbers for slicing up data - VarRange *Aggregationrange `json:"range,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Surveyaggregationview) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/surveyassignment.go b/build/platformclientv2/surveyassignment.go deleted file mode 100644 index ed23d6774..000000000 --- a/build/platformclientv2/surveyassignment.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Surveyassignment -type Surveyassignment struct { - // SurveyForm - The survey form used for this survey. - SurveyForm *Publishedsurveyformreference `json:"surveyForm,omitempty"` - - - // Flow - The URI reference to the flow associated with this survey. - Flow *Domainentityref `json:"flow,omitempty"` - - - // InviteTimeInterval - An ISO 8601 repeated interval consisting of the number of repetitions, the start datetime, and the interval (e.g. R2/2018-03-01T13:00:00Z/P1M10DT2H30M). Total duration must not exceed 90 days. - InviteTimeInterval *string `json:"inviteTimeInterval,omitempty"` - - - // SendingUser - User together with sendingDomain used to send email, null to use no-reply - SendingUser *string `json:"sendingUser,omitempty"` - - - // SendingDomain - Validated email domain, required - SendingDomain *string `json:"sendingDomain,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Surveyassignment) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/surveydetailqueryclause.go b/build/platformclientv2/surveydetailqueryclause.go deleted file mode 100644 index 4c3ddd043..000000000 --- a/build/platformclientv2/surveydetailqueryclause.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Surveydetailqueryclause -type Surveydetailqueryclause struct { - // VarType - Boolean operation to apply to the provided predicates - VarType *string `json:"type,omitempty"` - - - // Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value). - Predicates *[]Surveydetailquerypredicate `json:"predicates,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Surveydetailqueryclause) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/surveydetailqueryfilter.go b/build/platformclientv2/surveydetailqueryfilter.go deleted file mode 100644 index 2218c4066..000000000 --- a/build/platformclientv2/surveydetailqueryfilter.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Surveydetailqueryfilter -type Surveydetailqueryfilter struct { - // VarType - Boolean operation to apply to the provided predicates and clauses - VarType *string `json:"type,omitempty"` - - - // Clauses - Boolean 'and/or' logic with up to two-levels of nesting - Clauses *[]Surveydetailqueryclause `json:"clauses,omitempty"` - - - // Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value). - Predicates *[]Surveydetailquerypredicate `json:"predicates,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Surveydetailqueryfilter) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/surveydetailquerypredicate.go b/build/platformclientv2/surveydetailquerypredicate.go deleted file mode 100644 index 66e41f25d..000000000 --- a/build/platformclientv2/surveydetailquerypredicate.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Surveydetailquerypredicate -type Surveydetailquerypredicate struct { - // VarType - Optional type, can usually be inferred - VarType *string `json:"type,omitempty"` - - - // Dimension - Left hand side for dimension predicates - Dimension *string `json:"dimension,omitempty"` - - - // Metric - Left hand side for metric predicates - Metric *string `json:"metric,omitempty"` - - - // Operator - Optional operator, default is matches - Operator *string `json:"operator,omitempty"` - - - // Value - Right hand side for dimension or metric predicates - Value *string `json:"value,omitempty"` - - - // VarRange - Right hand side for dimension or metric predicates - VarRange *Numericrange `json:"range,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Surveydetailquerypredicate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/surveyerrordetails.go b/build/platformclientv2/surveyerrordetails.go deleted file mode 100644 index 7399be2e2..000000000 --- a/build/platformclientv2/surveyerrordetails.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Surveyerrordetails -type Surveyerrordetails struct { - // FlowDiagnosticInfo - Additional information about any errors that occurred in the survey invite flow. - FlowDiagnosticInfo *Flowdiagnosticinfo `json:"flowDiagnosticInfo,omitempty"` - - - // SurveyErrorReason - An error code indicating the reason for the survey failure. - SurveyErrorReason *string `json:"surveyErrorReason,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Surveyerrordetails) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/surveyform.go b/build/platformclientv2/surveyform.go deleted file mode 100644 index 1eb4a5b43..000000000 --- a/build/platformclientv2/surveyform.go +++ /dev/null @@ -1,62 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Surveyform -type Surveyform struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The survey form name - Name *string `json:"name,omitempty"` - - - // ModifiedDate - Last modified date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ModifiedDate *time.Time `json:"modifiedDate,omitempty"` - - - // Published - Is this form published - Published *bool `json:"published,omitempty"` - - - // Disabled - Is this form disabled - Disabled *bool `json:"disabled,omitempty"` - - - // ContextId - Unique Id for all versions of this form - ContextId *string `json:"contextId,omitempty"` - - - // Language - Language for survey viewer localization. Currently localized languages: da, de, en-US, es, fi, fr, it, ja, ko, nl, no, pl, pt-BR, sv, th, tr, zh-CH, zh-TW - Language *string `json:"language,omitempty"` - - - // Header - Markdown text for the top of the form. - Header *string `json:"header,omitempty"` - - - // Footer - Markdown text for the bottom of the form. - Footer *string `json:"footer,omitempty"` - - - // QuestionGroups - A list of question groups - QuestionGroups *[]Surveyquestiongroup `json:"questionGroups,omitempty"` - - - // PublishedVersions - List of published version of this form - PublishedVersions *Domainentitylistingsurveyform `json:"publishedVersions,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Surveyform) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/surveyformandscoringset.go b/build/platformclientv2/surveyformandscoringset.go deleted file mode 100644 index 697e619d9..000000000 --- a/build/platformclientv2/surveyformandscoringset.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Surveyformandscoringset -type Surveyformandscoringset struct { - // SurveyForm - SurveyForm *Surveyform `json:"surveyForm,omitempty"` - - - // Answers - Answers *Surveyscoringset `json:"answers,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Surveyformandscoringset) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/surveyformentitylisting.go b/build/platformclientv2/surveyformentitylisting.go deleted file mode 100644 index 5f7fc2d46..000000000 --- a/build/platformclientv2/surveyformentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Surveyformentitylisting -type Surveyformentitylisting struct { - // Entities - Entities *[]Surveyform `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Surveyformentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/surveyquestion.go b/build/platformclientv2/surveyquestion.go deleted file mode 100644 index 599d65962..000000000 --- a/build/platformclientv2/surveyquestion.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Surveyquestion -type Surveyquestion struct { - // Id - Id *string `json:"id,omitempty"` - - - // Text - Text *string `json:"text,omitempty"` - - - // HelpText - HelpText *string `json:"helpText,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - - - // NaEnabled - NaEnabled *bool `json:"naEnabled,omitempty"` - - - // VisibilityCondition - VisibilityCondition *Visibilitycondition `json:"visibilityCondition,omitempty"` - - - // AnswerOptions - Options from which to choose an answer for this question. Only used by Multiple Choice type questions. - AnswerOptions *[]Answeroption `json:"answerOptions,omitempty"` - - - // MaxResponseCharacters - How many characters are allowed in the text response to this question. Used by NPS and Free Text question types. - MaxResponseCharacters *int `json:"maxResponseCharacters,omitempty"` - - - // ExplanationPrompt - Prompt for details explaining the chosen NPS score. Used by NPS questions. - ExplanationPrompt *string `json:"explanationPrompt,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Surveyquestion) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/surveyquestiongroup.go b/build/platformclientv2/surveyquestiongroup.go deleted file mode 100644 index a39c45710..000000000 --- a/build/platformclientv2/surveyquestiongroup.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Surveyquestiongroup -type Surveyquestiongroup struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - - - // NaEnabled - NaEnabled *bool `json:"naEnabled,omitempty"` - - - // Questions - Questions *[]Surveyquestion `json:"questions,omitempty"` - - - // VisibilityCondition - VisibilityCondition *Visibilitycondition `json:"visibilityCondition,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Surveyquestiongroup) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/surveyquestiongroupscore.go b/build/platformclientv2/surveyquestiongroupscore.go deleted file mode 100644 index 32a81eec2..000000000 --- a/build/platformclientv2/surveyquestiongroupscore.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Surveyquestiongroupscore -type Surveyquestiongroupscore struct { - // QuestionGroupId - QuestionGroupId *string `json:"questionGroupId,omitempty"` - - - // TotalScore - TotalScore *float32 `json:"totalScore,omitempty"` - - - // MaxTotalScore - MaxTotalScore *float32 `json:"maxTotalScore,omitempty"` - - - // MarkedNA - MarkedNA *bool `json:"markedNA,omitempty"` - - - // QuestionScores - QuestionScores *[]Surveyquestionscore `json:"questionScores,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Surveyquestiongroupscore) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/surveyquestionscore.go b/build/platformclientv2/surveyquestionscore.go deleted file mode 100644 index 791dc275e..000000000 --- a/build/platformclientv2/surveyquestionscore.go +++ /dev/null @@ -1,41 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Surveyquestionscore -type Surveyquestionscore struct { - // QuestionId - QuestionId *string `json:"questionId,omitempty"` - - - // AnswerId - AnswerId *string `json:"answerId,omitempty"` - - - // Score - Score *int `json:"score,omitempty"` - - - // MarkedNA - MarkedNA *bool `json:"markedNA,omitempty"` - - - // NpsScore - NpsScore *int `json:"npsScore,omitempty"` - - - // NpsTextAnswer - NpsTextAnswer *string `json:"npsTextAnswer,omitempty"` - - - // FreeTextAnswer - FreeTextAnswer *string `json:"freeTextAnswer,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Surveyquestionscore) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/surveyscoringset.go b/build/platformclientv2/surveyscoringset.go deleted file mode 100644 index cfb64aa3f..000000000 --- a/build/platformclientv2/surveyscoringset.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Surveyscoringset -type Surveyscoringset struct { - // TotalScore - TotalScore *float32 `json:"totalScore,omitempty"` - - - // NpsScore - NpsScore *int `json:"npsScore,omitempty"` - - - // QuestionGroupScores - QuestionGroupScores *[]Surveyquestiongroupscore `json:"questionGroupScores,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Surveyscoringset) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/systemmessagesystemmessage.go b/build/platformclientv2/systemmessagesystemmessage.go deleted file mode 100644 index cf8834880..000000000 --- a/build/platformclientv2/systemmessagesystemmessage.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Systemmessagesystemmessage -type Systemmessagesystemmessage struct { - // ChannelId - ChannelId *string `json:"channelId,omitempty"` - - - // SystemTopicType - SystemTopicType *string `json:"systemTopicType,omitempty"` - - - // CorrelationId - CorrelationId *string `json:"correlationId,omitempty"` - - - // OrganizationId - OrganizationId *string `json:"organizationId,omitempty"` - - - // UserId - UserId *string `json:"userId,omitempty"` - - - // OauthClientId - OauthClientId *string `json:"oauthClientId,omitempty"` - - - // Reason - Reason *string `json:"reason,omitempty"` - - - // Message - Message *string `json:"message,omitempty"` - - - // Data - Data *map[string]interface{} `json:"data,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Systemmessagesystemmessage) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/systempresence.go b/build/platformclientv2/systempresence.go deleted file mode 100644 index ee91c56f4..000000000 --- a/build/platformclientv2/systempresence.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Systempresence -type Systempresence struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Systempresence) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/systemprompt.go b/build/platformclientv2/systemprompt.go deleted file mode 100644 index 1293ed427..000000000 --- a/build/platformclientv2/systemprompt.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Systemprompt -type Systemprompt struct { - // Id - The system prompt identifier - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Description - Description *string `json:"description,omitempty"` - - - // Resources - Resources *[]Systempromptasset `json:"resources,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Systemprompt) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/systempromptasset.go b/build/platformclientv2/systempromptasset.go deleted file mode 100644 index be058294e..000000000 --- a/build/platformclientv2/systempromptasset.go +++ /dev/null @@ -1,69 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Systempromptasset -type Systempromptasset struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // PromptId - PromptId *string `json:"promptId,omitempty"` - - - // Language - The asset resource language - Language *string `json:"language,omitempty"` - - - // DurationSeconds - DurationSeconds *float64 `json:"durationSeconds,omitempty"` - - - // MediaUri - MediaUri *string `json:"mediaUri,omitempty"` - - - // TtsString - TtsString *string `json:"ttsString,omitempty"` - - - // Text - Text *string `json:"text,omitempty"` - - - // UploadUri - UploadUri *string `json:"uploadUri,omitempty"` - - - // UploadStatus - UploadStatus *string `json:"uploadStatus,omitempty"` - - - // HasDefault - HasDefault *bool `json:"hasDefault,omitempty"` - - - // LanguageDefault - LanguageDefault *bool `json:"languageDefault,omitempty"` - - - // Tags - Tags *map[string][]string `json:"tags,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Systempromptasset) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/systempromptassetentitylisting.go b/build/platformclientv2/systempromptassetentitylisting.go deleted file mode 100644 index a24d932c3..000000000 --- a/build/platformclientv2/systempromptassetentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Systempromptassetentitylisting -type Systempromptassetentitylisting struct { - // Entities - Entities *[]Systempromptasset `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Systempromptassetentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/systempromptentitylisting.go b/build/platformclientv2/systempromptentitylisting.go deleted file mode 100644 index 08c88d26a..000000000 --- a/build/platformclientv2/systempromptentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Systempromptentitylisting -type Systempromptentitylisting struct { - // Entities - Entities *[]Systemprompt `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Systempromptentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/tagqueryrequest.go b/build/platformclientv2/tagqueryrequest.go deleted file mode 100644 index 65e21698a..000000000 --- a/build/platformclientv2/tagqueryrequest.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Tagqueryrequest -type Tagqueryrequest struct { - // Query - Query *string `json:"query,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Tagqueryrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/tagvalue.go b/build/platformclientv2/tagvalue.go deleted file mode 100644 index 9904f1695..000000000 --- a/build/platformclientv2/tagvalue.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Tagvalue -type Tagvalue struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The workspace tag name. - Name *string `json:"name,omitempty"` - - - // InUse - InUse *bool `json:"inUse,omitempty"` - - - // Acl - Acl *[]string `json:"acl,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Tagvalue) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/tagvalueentitylisting.go b/build/platformclientv2/tagvalueentitylisting.go deleted file mode 100644 index b8101da6e..000000000 --- a/build/platformclientv2/tagvalueentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Tagvalueentitylisting -type Tagvalueentitylisting struct { - // Entities - Entities *[]Tagvalue `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Tagvalueentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/telephonyapi.go b/build/platformclientv2/telephonyapi.go deleted file mode 100644 index 0dac4f29b..000000000 --- a/build/platformclientv2/telephonyapi.go +++ /dev/null @@ -1,320 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "time" -"encoding/json" -) - -// TelephonyApi provides functions for API endpoints -type TelephonyApi struct { - Configuration *Configuration -} - -// NewTelephonyApi creates an API instance using the default configuration -func NewTelephonyApi() *TelephonyApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating TelephonyApi with base path: %s", strings.ToLower(config.BasePath))) - return &TelephonyApi{ - Configuration: config, - } -} - -// NewTelephonyApiWithConfig creates an API instance using the provided configuration -func NewTelephonyApiWithConfig(config *Configuration) *TelephonyApi { - config.Debugf("Creating TelephonyApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &TelephonyApi{ - Configuration: config, - } -} - -// GetTelephonySiptraces invokes GET /api/v2/telephony/siptraces -// -// Fetch SIP metadata -// -// Fetch SIP metadata that matches a given parameter. If exactMatch is passed as a parameter only sip records that have exactly that value will be returned. For example, some records contain conversationId but not all relevant records for that call may contain the conversationId so only a partial view of the call will be reflected -func (a TelephonyApi) GetTelephonySiptraces(dateStart time.Time, dateEnd time.Time, callId string, toUser string, fromUser string, conversationId string) (*Sipsearchresult, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/siptraces" - defaultReturn := new(Sipsearchresult) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'dateStart' is set - if &dateStart == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'dateStart' when calling TelephonyApi->GetTelephonySiptraces") - } - // verify the required parameter 'dateEnd' is set - if &dateEnd == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'dateEnd' when calling TelephonyApi->GetTelephonySiptraces") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(callId).(string); ok { - if str != "" { - queryParams["callId"] = a.Configuration.APIClient.ParameterToString(callId, collectionFormat) - } - } else { - queryParams["callId"] = a.Configuration.APIClient.ParameterToString(callId, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(toUser).(string); ok { - if str != "" { - queryParams["toUser"] = a.Configuration.APIClient.ParameterToString(toUser, collectionFormat) - } - } else { - queryParams["toUser"] = a.Configuration.APIClient.ParameterToString(toUser, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(fromUser).(string); ok { - if str != "" { - queryParams["fromUser"] = a.Configuration.APIClient.ParameterToString(fromUser, collectionFormat) - } - } else { - queryParams["fromUser"] = a.Configuration.APIClient.ParameterToString(fromUser, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(conversationId).(string); ok { - if str != "" { - queryParams["conversationId"] = a.Configuration.APIClient.ParameterToString(conversationId, collectionFormat) - } - } else { - queryParams["conversationId"] = a.Configuration.APIClient.ParameterToString(conversationId, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(dateStart).(string); ok { - if str != "" { - queryParams["dateStart"] = a.Configuration.APIClient.ParameterToString(dateStart, collectionFormat) - } - } else { - queryParams["dateStart"] = a.Configuration.APIClient.ParameterToString(dateStart, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(dateEnd).(string); ok { - if str != "" { - queryParams["dateEnd"] = a.Configuration.APIClient.ParameterToString(dateEnd, collectionFormat) - } - } else { - queryParams["dateEnd"] = a.Configuration.APIClient.ParameterToString(dateEnd, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Sipsearchresult - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonySiptracesDownloadDownloadId invokes GET /api/v2/telephony/siptraces/download/{downloadId} -// -// Get signed S3 URL for a pcap download -// -// -func (a TelephonyApi) GetTelephonySiptracesDownloadDownloadId(downloadId string) (*Signedurlresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/siptraces/download/{downloadId}" - path = strings.Replace(path, "{downloadId}", fmt.Sprintf("%v", downloadId), -1) - defaultReturn := new(Signedurlresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'downloadId' is set - if &downloadId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'downloadId' when calling TelephonyApi->GetTelephonySiptracesDownloadDownloadId") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Signedurlresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostTelephonySiptracesDownload invokes POST /api/v2/telephony/siptraces/download -// -// Request a download of a pcap file to S3 -// -// -func (a TelephonyApi) PostTelephonySiptracesDownload(sIPSearchPublicRequest Sipsearchpublicrequest) (*Sipdownloadresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/siptraces/download" - defaultReturn := new(Sipdownloadresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'sIPSearchPublicRequest' is set - if &sIPSearchPublicRequest == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'sIPSearchPublicRequest' when calling TelephonyApi->PostTelephonySiptracesDownload") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &sIPSearchPublicRequest - - var successPayload *Sipdownloadresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/telephonyprovidersedgeapi.go b/build/platformclientv2/telephonyprovidersedgeapi.go deleted file mode 100644 index 95586f8fb..000000000 --- a/build/platformclientv2/telephonyprovidersedgeapi.go +++ /dev/null @@ -1,10877 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "encoding/json" -) - -// TelephonyProvidersEdgeApi provides functions for API endpoints -type TelephonyProvidersEdgeApi struct { - Configuration *Configuration -} - -// NewTelephonyProvidersEdgeApi creates an API instance using the default configuration -func NewTelephonyProvidersEdgeApi() *TelephonyProvidersEdgeApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating TelephonyProvidersEdgeApi with base path: %s", strings.ToLower(config.BasePath))) - return &TelephonyProvidersEdgeApi{ - Configuration: config, - } -} - -// NewTelephonyProvidersEdgeApiWithConfig creates an API instance using the provided configuration -func NewTelephonyProvidersEdgeApiWithConfig(config *Configuration) *TelephonyProvidersEdgeApi { - config.Debugf("Creating TelephonyProvidersEdgeApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &TelephonyProvidersEdgeApi{ - Configuration: config, - } -} - -// DeleteTelephonyProvidersEdge invokes DELETE /api/v2/telephony/providers/edges/{edgeId} -// -// Delete a edge. -// -// -func (a TelephonyProvidersEdgeApi) DeleteTelephonyProvidersEdge(edgeId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/{edgeId}" - path = strings.Replace(path, "{edgeId}", fmt.Sprintf("%v", edgeId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'edgeId' is set - if &edgeId == nil { - // - return nil, errors.New("Missing required parameter 'edgeId' when calling TelephonyProvidersEdgeApi->DeleteTelephonyProvidersEdge") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteTelephonyProvidersEdgeLogicalinterface invokes DELETE /api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces/{interfaceId} -// -// Delete an edge logical interface -// -// -func (a TelephonyProvidersEdgeApi) DeleteTelephonyProvidersEdgeLogicalinterface(edgeId string, interfaceId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces/{interfaceId}" - path = strings.Replace(path, "{edgeId}", fmt.Sprintf("%v", edgeId), -1) - path = strings.Replace(path, "{interfaceId}", fmt.Sprintf("%v", interfaceId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'edgeId' is set - if &edgeId == nil { - // - return nil, errors.New("Missing required parameter 'edgeId' when calling TelephonyProvidersEdgeApi->DeleteTelephonyProvidersEdgeLogicalinterface") - } - // verify the required parameter 'interfaceId' is set - if &interfaceId == nil { - // - return nil, errors.New("Missing required parameter 'interfaceId' when calling TelephonyProvidersEdgeApi->DeleteTelephonyProvidersEdgeLogicalinterface") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteTelephonyProvidersEdgeSoftwareupdate invokes DELETE /api/v2/telephony/providers/edges/{edgeId}/softwareupdate -// -// Cancels any in-progress update for this edge. -// -// -func (a TelephonyProvidersEdgeApi) DeleteTelephonyProvidersEdgeSoftwareupdate(edgeId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/{edgeId}/softwareupdate" - path = strings.Replace(path, "{edgeId}", fmt.Sprintf("%v", edgeId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'edgeId' is set - if &edgeId == nil { - // - return nil, errors.New("Missing required parameter 'edgeId' when calling TelephonyProvidersEdgeApi->DeleteTelephonyProvidersEdgeSoftwareupdate") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteTelephonyProvidersEdgesCertificateauthority invokes DELETE /api/v2/telephony/providers/edges/certificateauthorities/{certificateId} -// -// Delete a certificate authority. -// -// -func (a TelephonyProvidersEdgeApi) DeleteTelephonyProvidersEdgesCertificateauthority(certificateId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/certificateauthorities/{certificateId}" - path = strings.Replace(path, "{certificateId}", fmt.Sprintf("%v", certificateId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'certificateId' is set - if &certificateId == nil { - // - return nil, errors.New("Missing required parameter 'certificateId' when calling TelephonyProvidersEdgeApi->DeleteTelephonyProvidersEdgesCertificateauthority") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteTelephonyProvidersEdgesDidpool invokes DELETE /api/v2/telephony/providers/edges/didpools/{didPoolId} -// -// Delete a DID Pool by ID. -// -// -func (a TelephonyProvidersEdgeApi) DeleteTelephonyProvidersEdgesDidpool(didPoolId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/didpools/{didPoolId}" - path = strings.Replace(path, "{didPoolId}", fmt.Sprintf("%v", didPoolId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'didPoolId' is set - if &didPoolId == nil { - // - return nil, errors.New("Missing required parameter 'didPoolId' when calling TelephonyProvidersEdgeApi->DeleteTelephonyProvidersEdgesDidpool") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteTelephonyProvidersEdgesEdgegroup invokes DELETE /api/v2/telephony/providers/edges/edgegroups/{edgeGroupId} -// -// Delete an edge group. -// -// -func (a TelephonyProvidersEdgeApi) DeleteTelephonyProvidersEdgesEdgegroup(edgeGroupId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/edgegroups/{edgeGroupId}" - path = strings.Replace(path, "{edgeGroupId}", fmt.Sprintf("%v", edgeGroupId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'edgeGroupId' is set - if &edgeGroupId == nil { - // - return nil, errors.New("Missing required parameter 'edgeGroupId' when calling TelephonyProvidersEdgeApi->DeleteTelephonyProvidersEdgesEdgegroup") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteTelephonyProvidersEdgesExtensionpool invokes DELETE /api/v2/telephony/providers/edges/extensionpools/{extensionPoolId} -// -// Delete an extension pool by ID -// -// -func (a TelephonyProvidersEdgeApi) DeleteTelephonyProvidersEdgesExtensionpool(extensionPoolId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/extensionpools/{extensionPoolId}" - path = strings.Replace(path, "{extensionPoolId}", fmt.Sprintf("%v", extensionPoolId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'extensionPoolId' is set - if &extensionPoolId == nil { - // - return nil, errors.New("Missing required parameter 'extensionPoolId' when calling TelephonyProvidersEdgeApi->DeleteTelephonyProvidersEdgesExtensionpool") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteTelephonyProvidersEdgesOutboundroute invokes DELETE /api/v2/telephony/providers/edges/outboundroutes/{outboundRouteId} -// -// Delete Outbound Route -// -// -func (a TelephonyProvidersEdgeApi) DeleteTelephonyProvidersEdgesOutboundroute(outboundRouteId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/outboundroutes/{outboundRouteId}" - path = strings.Replace(path, "{outboundRouteId}", fmt.Sprintf("%v", outboundRouteId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'outboundRouteId' is set - if &outboundRouteId == nil { - // - return nil, errors.New("Missing required parameter 'outboundRouteId' when calling TelephonyProvidersEdgeApi->DeleteTelephonyProvidersEdgesOutboundroute") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteTelephonyProvidersEdgesPhone invokes DELETE /api/v2/telephony/providers/edges/phones/{phoneId} -// -// Delete a Phone by ID -// -// -func (a TelephonyProvidersEdgeApi) DeleteTelephonyProvidersEdgesPhone(phoneId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/phones/{phoneId}" - path = strings.Replace(path, "{phoneId}", fmt.Sprintf("%v", phoneId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'phoneId' is set - if &phoneId == nil { - // - return nil, errors.New("Missing required parameter 'phoneId' when calling TelephonyProvidersEdgeApi->DeleteTelephonyProvidersEdgesPhone") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteTelephonyProvidersEdgesPhonebasesetting invokes DELETE /api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId} -// -// Delete a Phone Base Settings by ID -// -// -func (a TelephonyProvidersEdgeApi) DeleteTelephonyProvidersEdgesPhonebasesetting(phoneBaseId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId}" - path = strings.Replace(path, "{phoneBaseId}", fmt.Sprintf("%v", phoneBaseId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'phoneBaseId' is set - if &phoneBaseId == nil { - // - return nil, errors.New("Missing required parameter 'phoneBaseId' when calling TelephonyProvidersEdgeApi->DeleteTelephonyProvidersEdgesPhonebasesetting") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteTelephonyProvidersEdgesSite invokes DELETE /api/v2/telephony/providers/edges/sites/{siteId} -// -// Delete a Site by ID -// -// -func (a TelephonyProvidersEdgeApi) DeleteTelephonyProvidersEdgesSite(siteId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/sites/{siteId}" - path = strings.Replace(path, "{siteId}", fmt.Sprintf("%v", siteId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'siteId' is set - if &siteId == nil { - // - return nil, errors.New("Missing required parameter 'siteId' when calling TelephonyProvidersEdgeApi->DeleteTelephonyProvidersEdgesSite") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteTelephonyProvidersEdgesSiteOutboundroute invokes DELETE /api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId} -// -// Delete Outbound Route -// -// -func (a TelephonyProvidersEdgeApi) DeleteTelephonyProvidersEdgesSiteOutboundroute(siteId string, outboundRouteId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId}" - path = strings.Replace(path, "{siteId}", fmt.Sprintf("%v", siteId), -1) - path = strings.Replace(path, "{outboundRouteId}", fmt.Sprintf("%v", outboundRouteId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'siteId' is set - if &siteId == nil { - // - return nil, errors.New("Missing required parameter 'siteId' when calling TelephonyProvidersEdgeApi->DeleteTelephonyProvidersEdgesSiteOutboundroute") - } - // verify the required parameter 'outboundRouteId' is set - if &outboundRouteId == nil { - // - return nil, errors.New("Missing required parameter 'outboundRouteId' when calling TelephonyProvidersEdgeApi->DeleteTelephonyProvidersEdgesSiteOutboundroute") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteTelephonyProvidersEdgesTrunkbasesetting invokes DELETE /api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId} -// -// Delete a Trunk Base Settings object by ID -// -// -func (a TelephonyProvidersEdgeApi) DeleteTelephonyProvidersEdgesTrunkbasesetting(trunkBaseSettingsId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId}" - path = strings.Replace(path, "{trunkBaseSettingsId}", fmt.Sprintf("%v", trunkBaseSettingsId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'trunkBaseSettingsId' is set - if &trunkBaseSettingsId == nil { - // - return nil, errors.New("Missing required parameter 'trunkBaseSettingsId' when calling TelephonyProvidersEdgeApi->DeleteTelephonyProvidersEdgesTrunkbasesetting") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// GetConfigurationSchemasEdgesVnext invokes GET /api/v2/configuration/schemas/edges/vnext -// -// Lists available schema categories (Deprecated) -// -// -func (a TelephonyProvidersEdgeApi) GetConfigurationSchemasEdgesVnext(pageSize int, pageNumber int) (*Schemacategoryentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/configuration/schemas/edges/vnext" - defaultReturn := new(Schemacategoryentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Schemacategoryentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConfigurationSchemasEdgesVnextSchemaCategory invokes GET /api/v2/configuration/schemas/edges/vnext/{schemaCategory} -// -// List schemas of a specific category (Deprecated) -// -// -func (a TelephonyProvidersEdgeApi) GetConfigurationSchemasEdgesVnextSchemaCategory(schemaCategory string, pageSize int, pageNumber int) (*Schemareferenceentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/configuration/schemas/edges/vnext/{schemaCategory}" - path = strings.Replace(path, "{schemaCategory}", fmt.Sprintf("%v", schemaCategory), -1) - defaultReturn := new(Schemareferenceentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'schemaCategory' is set - if &schemaCategory == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'schemaCategory' when calling TelephonyProvidersEdgeApi->GetConfigurationSchemasEdgesVnextSchemaCategory") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Schemareferenceentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConfigurationSchemasEdgesVnextSchemaCategorySchemaType invokes GET /api/v2/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType} -// -// List schemas of a specific category (Deprecated) -// -// -func (a TelephonyProvidersEdgeApi) GetConfigurationSchemasEdgesVnextSchemaCategorySchemaType(schemaCategory string, schemaType string, pageSize int, pageNumber int) (*Schemareferenceentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType}" - path = strings.Replace(path, "{schemaCategory}", fmt.Sprintf("%v", schemaCategory), -1) - path = strings.Replace(path, "{schemaType}", fmt.Sprintf("%v", schemaType), -1) - defaultReturn := new(Schemareferenceentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'schemaCategory' is set - if &schemaCategory == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'schemaCategory' when calling TelephonyProvidersEdgeApi->GetConfigurationSchemasEdgesVnextSchemaCategorySchemaType") - } - // verify the required parameter 'schemaType' is set - if &schemaType == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'schemaType' when calling TelephonyProvidersEdgeApi->GetConfigurationSchemasEdgesVnextSchemaCategorySchemaType") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Schemareferenceentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConfigurationSchemasEdgesVnextSchemaCategorySchemaTypeSchemaId invokes GET /api/v2/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType}/{schemaId} -// -// Get a json schema (Deprecated) -// -// -func (a TelephonyProvidersEdgeApi) GetConfigurationSchemasEdgesVnextSchemaCategorySchemaTypeSchemaId(schemaCategory string, schemaType string, schemaId string) (*Organization, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType}/{schemaId}" - path = strings.Replace(path, "{schemaCategory}", fmt.Sprintf("%v", schemaCategory), -1) - path = strings.Replace(path, "{schemaType}", fmt.Sprintf("%v", schemaType), -1) - path = strings.Replace(path, "{schemaId}", fmt.Sprintf("%v", schemaId), -1) - defaultReturn := new(Organization) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'schemaCategory' is set - if &schemaCategory == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'schemaCategory' when calling TelephonyProvidersEdgeApi->GetConfigurationSchemasEdgesVnextSchemaCategorySchemaTypeSchemaId") - } - // verify the required parameter 'schemaType' is set - if &schemaType == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'schemaType' when calling TelephonyProvidersEdgeApi->GetConfigurationSchemasEdgesVnextSchemaCategorySchemaTypeSchemaId") - } - // verify the required parameter 'schemaId' is set - if &schemaId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'schemaId' when calling TelephonyProvidersEdgeApi->GetConfigurationSchemasEdgesVnextSchemaCategorySchemaTypeSchemaId") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Organization - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetConfigurationSchemasEdgesVnextSchemaCategorySchemaTypeSchemaIdExtensionTypeMetadataId invokes GET /api/v2/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType}/{schemaId}/{extensionType}/{metadataId} -// -// Get metadata for a schema (Deprecated) -// -// -func (a TelephonyProvidersEdgeApi) GetConfigurationSchemasEdgesVnextSchemaCategorySchemaTypeSchemaIdExtensionTypeMetadataId(schemaCategory string, schemaType string, schemaId string, extensionType string, metadataId string, varType string) (*Organization, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType}/{schemaId}/{extensionType}/{metadataId}" - path = strings.Replace(path, "{schemaCategory}", fmt.Sprintf("%v", schemaCategory), -1) - path = strings.Replace(path, "{schemaType}", fmt.Sprintf("%v", schemaType), -1) - path = strings.Replace(path, "{schemaId}", fmt.Sprintf("%v", schemaId), -1) - path = strings.Replace(path, "{extensionType}", fmt.Sprintf("%v", extensionType), -1) - path = strings.Replace(path, "{metadataId}", fmt.Sprintf("%v", metadataId), -1) - defaultReturn := new(Organization) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'schemaCategory' is set - if &schemaCategory == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'schemaCategory' when calling TelephonyProvidersEdgeApi->GetConfigurationSchemasEdgesVnextSchemaCategorySchemaTypeSchemaIdExtensionTypeMetadataId") - } - // verify the required parameter 'schemaType' is set - if &schemaType == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'schemaType' when calling TelephonyProvidersEdgeApi->GetConfigurationSchemasEdgesVnextSchemaCategorySchemaTypeSchemaIdExtensionTypeMetadataId") - } - // verify the required parameter 'schemaId' is set - if &schemaId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'schemaId' when calling TelephonyProvidersEdgeApi->GetConfigurationSchemasEdgesVnextSchemaCategorySchemaTypeSchemaIdExtensionTypeMetadataId") - } - // verify the required parameter 'extensionType' is set - if &extensionType == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'extensionType' when calling TelephonyProvidersEdgeApi->GetConfigurationSchemasEdgesVnextSchemaCategorySchemaTypeSchemaIdExtensionTypeMetadataId") - } - // verify the required parameter 'metadataId' is set - if &metadataId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'metadataId' when calling TelephonyProvidersEdgeApi->GetConfigurationSchemasEdgesVnextSchemaCategorySchemaTypeSchemaIdExtensionTypeMetadataId") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(varType).(string); ok { - if str != "" { - queryParams["varType"] = a.Configuration.APIClient.ParameterToString(varType, collectionFormat) - } - } else { - queryParams["varType"] = a.Configuration.APIClient.ParameterToString(varType, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Organization - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdge invokes GET /api/v2/telephony/providers/edges/{edgeId} -// -// Get edge. -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdge(edgeId string, expand []string) (*Edge, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/{edgeId}" - path = strings.Replace(path, "{edgeId}", fmt.Sprintf("%v", edgeId), -1) - defaultReturn := new(Edge) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'edgeId' is set - if &edgeId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'edgeId' when calling TelephonyProvidersEdgeApi->GetTelephonyProvidersEdge") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Edge - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgeDiagnosticNslookup invokes GET /api/v2/telephony/providers/edges/{edgeId}/diagnostic/nslookup -// -// Get networking-related information from an Edge for a target IP or host. -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgeDiagnosticNslookup(edgeId string) (*Edgenetworkdiagnosticresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/{edgeId}/diagnostic/nslookup" - path = strings.Replace(path, "{edgeId}", fmt.Sprintf("%v", edgeId), -1) - defaultReturn := new(Edgenetworkdiagnosticresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'edgeId' is set - if &edgeId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'edgeId' when calling TelephonyProvidersEdgeApi->GetTelephonyProvidersEdgeDiagnosticNslookup") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Edgenetworkdiagnosticresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgeDiagnosticPing invokes GET /api/v2/telephony/providers/edges/{edgeId}/diagnostic/ping -// -// Get networking-related information from an Edge for a target IP or host. -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgeDiagnosticPing(edgeId string) (*Edgenetworkdiagnosticresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/{edgeId}/diagnostic/ping" - path = strings.Replace(path, "{edgeId}", fmt.Sprintf("%v", edgeId), -1) - defaultReturn := new(Edgenetworkdiagnosticresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'edgeId' is set - if &edgeId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'edgeId' when calling TelephonyProvidersEdgeApi->GetTelephonyProvidersEdgeDiagnosticPing") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Edgenetworkdiagnosticresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgeDiagnosticRoute invokes GET /api/v2/telephony/providers/edges/{edgeId}/diagnostic/route -// -// Get networking-related information from an Edge for a target IP or host. -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgeDiagnosticRoute(edgeId string) (*Edgenetworkdiagnosticresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/{edgeId}/diagnostic/route" - path = strings.Replace(path, "{edgeId}", fmt.Sprintf("%v", edgeId), -1) - defaultReturn := new(Edgenetworkdiagnosticresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'edgeId' is set - if &edgeId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'edgeId' when calling TelephonyProvidersEdgeApi->GetTelephonyProvidersEdgeDiagnosticRoute") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Edgenetworkdiagnosticresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgeDiagnosticTracepath invokes GET /api/v2/telephony/providers/edges/{edgeId}/diagnostic/tracepath -// -// Get networking-related information from an Edge for a target IP or host. -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgeDiagnosticTracepath(edgeId string) (*Edgenetworkdiagnosticresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/{edgeId}/diagnostic/tracepath" - path = strings.Replace(path, "{edgeId}", fmt.Sprintf("%v", edgeId), -1) - defaultReturn := new(Edgenetworkdiagnosticresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'edgeId' is set - if &edgeId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'edgeId' when calling TelephonyProvidersEdgeApi->GetTelephonyProvidersEdgeDiagnosticTracepath") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Edgenetworkdiagnosticresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgeLine invokes GET /api/v2/telephony/providers/edges/{edgeId}/lines/{lineId} -// -// Get line -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgeLine(edgeId string, lineId string) (*Edgeline, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/{edgeId}/lines/{lineId}" - path = strings.Replace(path, "{edgeId}", fmt.Sprintf("%v", edgeId), -1) - path = strings.Replace(path, "{lineId}", fmt.Sprintf("%v", lineId), -1) - defaultReturn := new(Edgeline) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'edgeId' is set - if &edgeId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'edgeId' when calling TelephonyProvidersEdgeApi->GetTelephonyProvidersEdgeLine") - } - // verify the required parameter 'lineId' is set - if &lineId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'lineId' when calling TelephonyProvidersEdgeApi->GetTelephonyProvidersEdgeLine") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Edgeline - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgeLines invokes GET /api/v2/telephony/providers/edges/{edgeId}/lines -// -// Get the list of lines. -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgeLines(edgeId string, pageSize int, pageNumber int) (*Edgelineentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/{edgeId}/lines" - path = strings.Replace(path, "{edgeId}", fmt.Sprintf("%v", edgeId), -1) - defaultReturn := new(Edgelineentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'edgeId' is set - if &edgeId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'edgeId' when calling TelephonyProvidersEdgeApi->GetTelephonyProvidersEdgeLines") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Edgelineentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgeLogicalinterface invokes GET /api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces/{interfaceId} -// -// Get an edge logical interface -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgeLogicalinterface(edgeId string, interfaceId string, expand []string) (*Domainlogicalinterface, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces/{interfaceId}" - path = strings.Replace(path, "{edgeId}", fmt.Sprintf("%v", edgeId), -1) - path = strings.Replace(path, "{interfaceId}", fmt.Sprintf("%v", interfaceId), -1) - defaultReturn := new(Domainlogicalinterface) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'edgeId' is set - if &edgeId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'edgeId' when calling TelephonyProvidersEdgeApi->GetTelephonyProvidersEdgeLogicalinterface") - } - // verify the required parameter 'interfaceId' is set - if &interfaceId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'interfaceId' when calling TelephonyProvidersEdgeApi->GetTelephonyProvidersEdgeLogicalinterface") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Domainlogicalinterface - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgeLogicalinterfaces invokes GET /api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces -// -// Get edge logical interfaces. -// -// Retrieve a list of all configured logical interfaces from a specific edge. -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgeLogicalinterfaces(edgeId string, expand []string) (*Logicalinterfaceentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces" - path = strings.Replace(path, "{edgeId}", fmt.Sprintf("%v", edgeId), -1) - defaultReturn := new(Logicalinterfaceentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'edgeId' is set - if &edgeId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'edgeId' when calling TelephonyProvidersEdgeApi->GetTelephonyProvidersEdgeLogicalinterfaces") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Logicalinterfaceentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgeLogsJob invokes GET /api/v2/telephony/providers/edges/{edgeId}/logs/jobs/{jobId} -// -// Get an Edge logs job. -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgeLogsJob(edgeId string, jobId string) (*Edgelogsjob, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/{edgeId}/logs/jobs/{jobId}" - path = strings.Replace(path, "{edgeId}", fmt.Sprintf("%v", edgeId), -1) - path = strings.Replace(path, "{jobId}", fmt.Sprintf("%v", jobId), -1) - defaultReturn := new(Edgelogsjob) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'edgeId' is set - if &edgeId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'edgeId' when calling TelephonyProvidersEdgeApi->GetTelephonyProvidersEdgeLogsJob") - } - // verify the required parameter 'jobId' is set - if &jobId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'jobId' when calling TelephonyProvidersEdgeApi->GetTelephonyProvidersEdgeLogsJob") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Edgelogsjob - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgeMetrics invokes GET /api/v2/telephony/providers/edges/{edgeId}/metrics -// -// Get the edge metrics. -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgeMetrics(edgeId string) (*Edgemetrics, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/{edgeId}/metrics" - path = strings.Replace(path, "{edgeId}", fmt.Sprintf("%v", edgeId), -1) - defaultReturn := new(Edgemetrics) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'edgeId' is set - if &edgeId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'edgeId' when calling TelephonyProvidersEdgeApi->GetTelephonyProvidersEdgeMetrics") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Edgemetrics - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgePhysicalinterface invokes GET /api/v2/telephony/providers/edges/{edgeId}/physicalinterfaces/{interfaceId} -// -// Get edge physical interface. -// -// Retrieve a physical interface from a specific edge. -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgePhysicalinterface(edgeId string, interfaceId string) (*Domainphysicalinterface, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/{edgeId}/physicalinterfaces/{interfaceId}" - path = strings.Replace(path, "{edgeId}", fmt.Sprintf("%v", edgeId), -1) - path = strings.Replace(path, "{interfaceId}", fmt.Sprintf("%v", interfaceId), -1) - defaultReturn := new(Domainphysicalinterface) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'edgeId' is set - if &edgeId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'edgeId' when calling TelephonyProvidersEdgeApi->GetTelephonyProvidersEdgePhysicalinterface") - } - // verify the required parameter 'interfaceId' is set - if &interfaceId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'interfaceId' when calling TelephonyProvidersEdgeApi->GetTelephonyProvidersEdgePhysicalinterface") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Domainphysicalinterface - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgePhysicalinterfaces invokes GET /api/v2/telephony/providers/edges/{edgeId}/physicalinterfaces -// -// Retrieve a list of all configured physical interfaces from a specific edge. -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgePhysicalinterfaces(edgeId string) (*Physicalinterfaceentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/{edgeId}/physicalinterfaces" - path = strings.Replace(path, "{edgeId}", fmt.Sprintf("%v", edgeId), -1) - defaultReturn := new(Physicalinterfaceentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'edgeId' is set - if &edgeId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'edgeId' when calling TelephonyProvidersEdgeApi->GetTelephonyProvidersEdgePhysicalinterfaces") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Physicalinterfaceentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgeSetuppackage invokes GET /api/v2/telephony/providers/edges/{edgeId}/setuppackage -// -// Get the setup package for a locally deployed edge device. This is needed to complete the setup process for the virtual edge. -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgeSetuppackage(edgeId string) (*Vmpairinginfo, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/{edgeId}/setuppackage" - path = strings.Replace(path, "{edgeId}", fmt.Sprintf("%v", edgeId), -1) - defaultReturn := new(Vmpairinginfo) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'edgeId' is set - if &edgeId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'edgeId' when calling TelephonyProvidersEdgeApi->GetTelephonyProvidersEdgeSetuppackage") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Vmpairinginfo - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgeSoftwareupdate invokes GET /api/v2/telephony/providers/edges/{edgeId}/softwareupdate -// -// Gets software update status information about any edge. -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgeSoftwareupdate(edgeId string) (*Domainedgesoftwareupdatedto, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/{edgeId}/softwareupdate" - path = strings.Replace(path, "{edgeId}", fmt.Sprintf("%v", edgeId), -1) - defaultReturn := new(Domainedgesoftwareupdatedto) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'edgeId' is set - if &edgeId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'edgeId' when calling TelephonyProvidersEdgeApi->GetTelephonyProvidersEdgeSoftwareupdate") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Domainedgesoftwareupdatedto - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgeSoftwareversions invokes GET /api/v2/telephony/providers/edges/{edgeId}/softwareversions -// -// Gets all the available software versions for this edge. -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgeSoftwareversions(edgeId string) (*Domainedgesoftwareversiondtoentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/{edgeId}/softwareversions" - path = strings.Replace(path, "{edgeId}", fmt.Sprintf("%v", edgeId), -1) - defaultReturn := new(Domainedgesoftwareversiondtoentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'edgeId' is set - if &edgeId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'edgeId' when calling TelephonyProvidersEdgeApi->GetTelephonyProvidersEdgeSoftwareversions") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Domainedgesoftwareversiondtoentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgeTrunks invokes GET /api/v2/telephony/providers/edges/{edgeId}/trunks -// -// Get the list of available trunks for the given Edge. -// -// Trunks are created by assigning trunk base settings to an Edge or Edge Group. -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgeTrunks(edgeId string, pageNumber int, pageSize int, sortBy string, sortOrder string, trunkBaseId string, trunkType string) (*Trunkentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/{edgeId}/trunks" - path = strings.Replace(path, "{edgeId}", fmt.Sprintf("%v", edgeId), -1) - defaultReturn := new(Trunkentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'edgeId' is set - if &edgeId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'edgeId' when calling TelephonyProvidersEdgeApi->GetTelephonyProvidersEdgeTrunks") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(trunkBaseId).(string); ok { - if str != "" { - queryParams["trunkBaseId"] = a.Configuration.APIClient.ParameterToString(trunkBaseId, collectionFormat) - } - } else { - queryParams["trunkBaseId"] = a.Configuration.APIClient.ParameterToString(trunkBaseId, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(trunkType).(string); ok { - if str != "" { - queryParams["trunkType"] = a.Configuration.APIClient.ParameterToString(trunkType, collectionFormat) - } - } else { - queryParams["trunkType"] = a.Configuration.APIClient.ParameterToString(trunkType, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Trunkentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdges invokes GET /api/v2/telephony/providers/edges -// -// Get the list of edges. -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdges(pageSize int, pageNumber int, name string, siteId string, edgeGroupId string, sortBy string, managed bool) (*Edgeentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges" - defaultReturn := new(Edgeentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(siteId).(string); ok { - if str != "" { - queryParams["siteId"] = a.Configuration.APIClient.ParameterToString(siteId, collectionFormat) - } - } else { - queryParams["siteId"] = a.Configuration.APIClient.ParameterToString(siteId, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(edgeGroupId).(string); ok { - if str != "" { - queryParams["edgeGroupId"] = a.Configuration.APIClient.ParameterToString(edgeGroupId, collectionFormat) - } - } else { - queryParams["edgeGroupId"] = a.Configuration.APIClient.ParameterToString(edgeGroupId, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(managed).(string); ok { - if str != "" { - queryParams["managed"] = a.Configuration.APIClient.ParameterToString(managed, collectionFormat) - } - } else { - queryParams["managed"] = a.Configuration.APIClient.ParameterToString(managed, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Edgeentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgesAvailablelanguages invokes GET /api/v2/telephony/providers/edges/availablelanguages -// -// Get the list of available languages. -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesAvailablelanguages() (*Availablelanguagelist, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/availablelanguages" - defaultReturn := new(Availablelanguagelist) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Availablelanguagelist - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgesCertificateauthorities invokes GET /api/v2/telephony/providers/edges/certificateauthorities -// -// Get the list of certificate authorities. -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesCertificateauthorities() (*Certificateauthorityentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/certificateauthorities" - defaultReturn := new(Certificateauthorityentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Certificateauthorityentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgesCertificateauthority invokes GET /api/v2/telephony/providers/edges/certificateauthorities/{certificateId} -// -// Get a certificate authority. -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesCertificateauthority(certificateId string) (*Domaincertificateauthority, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/certificateauthorities/{certificateId}" - path = strings.Replace(path, "{certificateId}", fmt.Sprintf("%v", certificateId), -1) - defaultReturn := new(Domaincertificateauthority) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'certificateId' is set - if &certificateId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'certificateId' when calling TelephonyProvidersEdgeApi->GetTelephonyProvidersEdgesCertificateauthority") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Domaincertificateauthority - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgesDid invokes GET /api/v2/telephony/providers/edges/dids/{didId} -// -// Get a DID by ID. -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesDid(didId string) (*Did, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/dids/{didId}" - path = strings.Replace(path, "{didId}", fmt.Sprintf("%v", didId), -1) - defaultReturn := new(Did) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'didId' is set - if &didId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'didId' when calling TelephonyProvidersEdgeApi->GetTelephonyProvidersEdgesDid") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Did - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgesDidpool invokes GET /api/v2/telephony/providers/edges/didpools/{didPoolId} -// -// Get a DID Pool by ID. -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesDidpool(didPoolId string) (*Didpool, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/didpools/{didPoolId}" - path = strings.Replace(path, "{didPoolId}", fmt.Sprintf("%v", didPoolId), -1) - defaultReturn := new(Didpool) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'didPoolId' is set - if &didPoolId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'didPoolId' when calling TelephonyProvidersEdgeApi->GetTelephonyProvidersEdgesDidpool") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Didpool - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgesDidpools invokes GET /api/v2/telephony/providers/edges/didpools -// -// Get a listing of DID Pools -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesDidpools(pageSize int, pageNumber int, sortBy string, id []string) (*Didpoolentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/didpools" - defaultReturn := new(Didpoolentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range id { - queryParams["id"] = value - } - } else { - queryParams["id"] = a.Configuration.APIClient.ParameterToString(id, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Didpoolentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgesDidpoolsDids invokes GET /api/v2/telephony/providers/edges/didpools/dids -// -// Get a listing of unassigned and/or assigned numbers in a set of DID Pools. -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesDidpoolsDids(varType string, id []string, numberMatch string, pageSize int, pageNumber int, sortOrder string) (*Didnumberentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/didpools/dids" - defaultReturn := new(Didnumberentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'varType' is set - if &varType == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'varType' when calling TelephonyProvidersEdgeApi->GetTelephonyProvidersEdgesDidpoolsDids") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(varType).(string); ok { - if str != "" { - queryParams["varType"] = a.Configuration.APIClient.ParameterToString(varType, collectionFormat) - } - } else { - queryParams["varType"] = a.Configuration.APIClient.ParameterToString(varType, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range id { - queryParams["id"] = value - } - } else { - queryParams["id"] = a.Configuration.APIClient.ParameterToString(id, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(numberMatch).(string); ok { - if str != "" { - queryParams["numberMatch"] = a.Configuration.APIClient.ParameterToString(numberMatch, collectionFormat) - } - } else { - queryParams["numberMatch"] = a.Configuration.APIClient.ParameterToString(numberMatch, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Didnumberentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgesDids invokes GET /api/v2/telephony/providers/edges/dids -// -// Get a listing of DIDs -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesDids(pageSize int, pageNumber int, sortBy string, sortOrder string, phoneNumber string, ownerId string, didPoolId string, id []string) (*Didentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/dids" - defaultReturn := new(Didentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(phoneNumber).(string); ok { - if str != "" { - queryParams["phoneNumber"] = a.Configuration.APIClient.ParameterToString(phoneNumber, collectionFormat) - } - } else { - queryParams["phoneNumber"] = a.Configuration.APIClient.ParameterToString(phoneNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(ownerId).(string); ok { - if str != "" { - queryParams["ownerId"] = a.Configuration.APIClient.ParameterToString(ownerId, collectionFormat) - } - } else { - queryParams["ownerId"] = a.Configuration.APIClient.ParameterToString(ownerId, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(didPoolId).(string); ok { - if str != "" { - queryParams["didPoolId"] = a.Configuration.APIClient.ParameterToString(didPoolId, collectionFormat) - } - } else { - queryParams["didPoolId"] = a.Configuration.APIClient.ParameterToString(didPoolId, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range id { - queryParams["id"] = value - } - } else { - queryParams["id"] = a.Configuration.APIClient.ParameterToString(id, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Didentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgesEdgegroup invokes GET /api/v2/telephony/providers/edges/edgegroups/{edgeGroupId} -// -// Get edge group. -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesEdgegroup(edgeGroupId string, expand []string) (*Edgegroup, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/edgegroups/{edgeGroupId}" - path = strings.Replace(path, "{edgeGroupId}", fmt.Sprintf("%v", edgeGroupId), -1) - defaultReturn := new(Edgegroup) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'edgeGroupId' is set - if &edgeGroupId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'edgeGroupId' when calling TelephonyProvidersEdgeApi->GetTelephonyProvidersEdgesEdgegroup") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Edgegroup - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgesEdgegroupEdgetrunkbase invokes GET /api/v2/telephony/providers/edges/edgegroups/{edgegroupId}/edgetrunkbases/{edgetrunkbaseId} -// -// Gets the edge trunk base associated with the edge group -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesEdgegroupEdgetrunkbase(edgegroupId string, edgetrunkbaseId string) (*Edgetrunkbase, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/edgegroups/{edgegroupId}/edgetrunkbases/{edgetrunkbaseId}" - path = strings.Replace(path, "{edgegroupId}", fmt.Sprintf("%v", edgegroupId), -1) - path = strings.Replace(path, "{edgetrunkbaseId}", fmt.Sprintf("%v", edgetrunkbaseId), -1) - defaultReturn := new(Edgetrunkbase) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'edgegroupId' is set - if &edgegroupId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'edgegroupId' when calling TelephonyProvidersEdgeApi->GetTelephonyProvidersEdgesEdgegroupEdgetrunkbase") - } - // verify the required parameter 'edgetrunkbaseId' is set - if &edgetrunkbaseId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'edgetrunkbaseId' when calling TelephonyProvidersEdgeApi->GetTelephonyProvidersEdgesEdgegroupEdgetrunkbase") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Edgetrunkbase - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgesEdgegroups invokes GET /api/v2/telephony/providers/edges/edgegroups -// -// Get the list of edge groups. -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesEdgegroups(pageSize int, pageNumber int, name string, sortBy string, managed bool) (*Edgegroupentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/edgegroups" - defaultReturn := new(Edgegroupentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(managed).(string); ok { - if str != "" { - queryParams["managed"] = a.Configuration.APIClient.ParameterToString(managed, collectionFormat) - } - } else { - queryParams["managed"] = a.Configuration.APIClient.ParameterToString(managed, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Edgegroupentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgesEdgeversionreport invokes GET /api/v2/telephony/providers/edges/edgeversionreport -// -// Get the edge version report. -// -// The report will not have consistent data about the edge version(s) until all edges have been reset. -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesEdgeversionreport() (*Edgeversionreport, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/edgeversionreport" - defaultReturn := new(Edgeversionreport) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Edgeversionreport - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgesExtension invokes GET /api/v2/telephony/providers/edges/extensions/{extensionId} -// -// Get an extension by ID. -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesExtension(extensionId string) (*Extension, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/extensions/{extensionId}" - path = strings.Replace(path, "{extensionId}", fmt.Sprintf("%v", extensionId), -1) - defaultReturn := new(Extension) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'extensionId' is set - if &extensionId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'extensionId' when calling TelephonyProvidersEdgeApi->GetTelephonyProvidersEdgesExtension") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Extension - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgesExtensionpool invokes GET /api/v2/telephony/providers/edges/extensionpools/{extensionPoolId} -// -// Get an extension pool by ID -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesExtensionpool(extensionPoolId string) (*Extensionpool, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/extensionpools/{extensionPoolId}" - path = strings.Replace(path, "{extensionPoolId}", fmt.Sprintf("%v", extensionPoolId), -1) - defaultReturn := new(Extensionpool) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'extensionPoolId' is set - if &extensionPoolId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'extensionPoolId' when calling TelephonyProvidersEdgeApi->GetTelephonyProvidersEdgesExtensionpool") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Extensionpool - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgesExtensionpools invokes GET /api/v2/telephony/providers/edges/extensionpools -// -// Get a listing of extension pools -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesExtensionpools(pageSize int, pageNumber int, sortBy string, number string) (*Extensionpoolentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/extensionpools" - defaultReturn := new(Extensionpoolentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(number).(string); ok { - if str != "" { - queryParams["number"] = a.Configuration.APIClient.ParameterToString(number, collectionFormat) - } - } else { - queryParams["number"] = a.Configuration.APIClient.ParameterToString(number, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Extensionpoolentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgesExtensions invokes GET /api/v2/telephony/providers/edges/extensions -// -// Get a listing of extensions -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesExtensions(pageSize int, pageNumber int, sortBy string, sortOrder string, number string) (*Extensionentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/extensions" - defaultReturn := new(Extensionentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(number).(string); ok { - if str != "" { - queryParams["number"] = a.Configuration.APIClient.ParameterToString(number, collectionFormat) - } - } else { - queryParams["number"] = a.Configuration.APIClient.ParameterToString(number, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Extensionentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgesLine invokes GET /api/v2/telephony/providers/edges/lines/{lineId} -// -// Get a Line by ID -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesLine(lineId string) (*Line, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/lines/{lineId}" - path = strings.Replace(path, "{lineId}", fmt.Sprintf("%v", lineId), -1) - defaultReturn := new(Line) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'lineId' is set - if &lineId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'lineId' when calling TelephonyProvidersEdgeApi->GetTelephonyProvidersEdgesLine") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Line - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgesLinebasesetting invokes GET /api/v2/telephony/providers/edges/linebasesettings/{lineBaseId} -// -// Get a line base settings object by ID -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesLinebasesetting(lineBaseId string) (*Linebase, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/linebasesettings/{lineBaseId}" - path = strings.Replace(path, "{lineBaseId}", fmt.Sprintf("%v", lineBaseId), -1) - defaultReturn := new(Linebase) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'lineBaseId' is set - if &lineBaseId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'lineBaseId' when calling TelephonyProvidersEdgeApi->GetTelephonyProvidersEdgesLinebasesetting") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Linebase - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgesLinebasesettings invokes GET /api/v2/telephony/providers/edges/linebasesettings -// -// Get a listing of line base settings objects -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesLinebasesettings(pageNumber int, pageSize int, sortBy string, sortOrder string) (*Linebaseentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/linebasesettings" - defaultReturn := new(Linebaseentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Linebaseentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgesLines invokes GET /api/v2/telephony/providers/edges/lines -// -// Get a list of Lines -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesLines(pageSize int, pageNumber int, name string, sortBy string, expand []string) (*Lineentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/lines" - defaultReturn := new(Lineentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Lineentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgesLinesTemplate invokes GET /api/v2/telephony/providers/edges/lines/template -// -// Get a Line instance template based on a Line Base Settings object. This object can then be modified and saved as a new Line instance -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesLinesTemplate(lineBaseSettingsId string) (*Line, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/lines/template" - defaultReturn := new(Line) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'lineBaseSettingsId' is set - if &lineBaseSettingsId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'lineBaseSettingsId' when calling TelephonyProvidersEdgeApi->GetTelephonyProvidersEdgesLinesTemplate") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(lineBaseSettingsId).(string); ok { - if str != "" { - queryParams["lineBaseSettingsId"] = a.Configuration.APIClient.ParameterToString(lineBaseSettingsId, collectionFormat) - } - } else { - queryParams["lineBaseSettingsId"] = a.Configuration.APIClient.ParameterToString(lineBaseSettingsId, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Line - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgesLogicalinterfaces invokes GET /api/v2/telephony/providers/edges/logicalinterfaces -// -// Get edge logical interfaces. -// -// Retrieve the configured logical interfaces for a list edges. Only 100 edges can be requested at a time. -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesLogicalinterfaces(edgeIds string, expand []string) (*Logicalinterfaceentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/logicalinterfaces" - defaultReturn := new(Logicalinterfaceentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'edgeIds' is set - if &edgeIds == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'edgeIds' when calling TelephonyProvidersEdgeApi->GetTelephonyProvidersEdgesLogicalinterfaces") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(edgeIds).(string); ok { - if str != "" { - queryParams["edgeIds"] = a.Configuration.APIClient.ParameterToString(edgeIds, collectionFormat) - } - } else { - queryParams["edgeIds"] = a.Configuration.APIClient.ParameterToString(edgeIds, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Logicalinterfaceentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgesMetrics invokes GET /api/v2/telephony/providers/edges/metrics -// -// Get the metrics for a list of edges. -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesMetrics(edgeIds string) ([]Edgemetrics, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/metrics" - defaultReturn := make([]Edgemetrics, 0) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'edgeIds' is set - if &edgeIds == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'edgeIds' when calling TelephonyProvidersEdgeApi->GetTelephonyProvidersEdgesMetrics") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(edgeIds).(string); ok { - if str != "" { - queryParams["edgeIds"] = a.Configuration.APIClient.ParameterToString(edgeIds, collectionFormat) - } - } else { - queryParams["edgeIds"] = a.Configuration.APIClient.ParameterToString(edgeIds, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload []Edgemetrics - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgesOutboundroute invokes GET /api/v2/telephony/providers/edges/outboundroutes/{outboundRouteId} -// -// Get outbound route -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesOutboundroute(outboundRouteId string) (*Outboundroute, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/outboundroutes/{outboundRouteId}" - path = strings.Replace(path, "{outboundRouteId}", fmt.Sprintf("%v", outboundRouteId), -1) - defaultReturn := new(Outboundroute) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'outboundRouteId' is set - if &outboundRouteId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'outboundRouteId' when calling TelephonyProvidersEdgeApi->GetTelephonyProvidersEdgesOutboundroute") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Outboundroute - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgesOutboundroutes invokes GET /api/v2/telephony/providers/edges/outboundroutes -// -// Get outbound routes -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesOutboundroutes(pageSize int, pageNumber int, name string, siteId string, externalTrunkBasesIds string, sortBy string) (*Outboundrouteentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/outboundroutes" - defaultReturn := new(Outboundrouteentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(siteId).(string); ok { - if str != "" { - queryParams["siteId"] = a.Configuration.APIClient.ParameterToString(siteId, collectionFormat) - } - } else { - queryParams["siteId"] = a.Configuration.APIClient.ParameterToString(siteId, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(externalTrunkBasesIds).(string); ok { - if str != "" { - queryParams["externalTrunkBasesIds"] = a.Configuration.APIClient.ParameterToString(externalTrunkBasesIds, collectionFormat) - } - } else { - queryParams["externalTrunkBasesIds"] = a.Configuration.APIClient.ParameterToString(externalTrunkBasesIds, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Outboundrouteentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgesPhone invokes GET /api/v2/telephony/providers/edges/phones/{phoneId} -// -// Get a Phone by ID -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesPhone(phoneId string) (*Phone, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/phones/{phoneId}" - path = strings.Replace(path, "{phoneId}", fmt.Sprintf("%v", phoneId), -1) - defaultReturn := new(Phone) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'phoneId' is set - if &phoneId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'phoneId' when calling TelephonyProvidersEdgeApi->GetTelephonyProvidersEdgesPhone") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Phone - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgesPhonebasesetting invokes GET /api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId} -// -// Get a Phone Base Settings object by ID -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesPhonebasesetting(phoneBaseId string) (*Phonebase, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId}" - path = strings.Replace(path, "{phoneBaseId}", fmt.Sprintf("%v", phoneBaseId), -1) - defaultReturn := new(Phonebase) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'phoneBaseId' is set - if &phoneBaseId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'phoneBaseId' when calling TelephonyProvidersEdgeApi->GetTelephonyProvidersEdgesPhonebasesetting") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Phonebase - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgesPhonebasesettings invokes GET /api/v2/telephony/providers/edges/phonebasesettings -// -// Get a list of Phone Base Settings objects -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesPhonebasesettings(pageSize int, pageNumber int, sortBy string, sortOrder string, expand []string, name string) (*Phonebaseentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/phonebasesettings" - defaultReturn := new(Phonebaseentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Phonebaseentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgesPhonebasesettingsAvailablemetabases invokes GET /api/v2/telephony/providers/edges/phonebasesettings/availablemetabases -// -// Get a list of available makes and models to create a new Phone Base Settings -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesPhonebasesettingsAvailablemetabases(pageSize int, pageNumber int) (*Phonemetabaseentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/phonebasesettings/availablemetabases" - defaultReturn := new(Phonemetabaseentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Phonemetabaseentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgesPhonebasesettingsTemplate invokes GET /api/v2/telephony/providers/edges/phonebasesettings/template -// -// Get a Phone Base Settings instance template from a given make and model. This object can then be modified and saved as a new Phone Base Settings instance -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesPhonebasesettingsTemplate(phoneMetabaseId string) (*Phonebase, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/phonebasesettings/template" - defaultReturn := new(Phonebase) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'phoneMetabaseId' is set - if &phoneMetabaseId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'phoneMetabaseId' when calling TelephonyProvidersEdgeApi->GetTelephonyProvidersEdgesPhonebasesettingsTemplate") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(phoneMetabaseId).(string); ok { - if str != "" { - queryParams["phoneMetabaseId"] = a.Configuration.APIClient.ParameterToString(phoneMetabaseId, collectionFormat) - } - } else { - queryParams["phoneMetabaseId"] = a.Configuration.APIClient.ParameterToString(phoneMetabaseId, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Phonebase - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgesPhones invokes GET /api/v2/telephony/providers/edges/phones -// -// Get a list of Phone Instances -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesPhones(pageNumber int, pageSize int, sortBy string, sortOrder string, siteId string, webRtcUserId string, phoneBaseSettingsId string, linesLoggedInUserId string, linesDefaultForUserId string, phoneHardwareId string, linesId string, linesName string, name string, expand []string, fields []string) (*Phoneentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/phones" - defaultReturn := new(Phoneentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(siteId).(string); ok { - if str != "" { - queryParams["siteId"] = a.Configuration.APIClient.ParameterToString(siteId, collectionFormat) - } - } else { - queryParams["siteId"] = a.Configuration.APIClient.ParameterToString(siteId, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(webRtcUserId).(string); ok { - if str != "" { - queryParams["webRtcUserId"] = a.Configuration.APIClient.ParameterToString(webRtcUserId, collectionFormat) - } - } else { - queryParams["webRtcUserId"] = a.Configuration.APIClient.ParameterToString(webRtcUserId, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(phoneBaseSettingsId).(string); ok { - if str != "" { - queryParams["phoneBaseSettingsId"] = a.Configuration.APIClient.ParameterToString(phoneBaseSettingsId, collectionFormat) - } - } else { - queryParams["phoneBaseSettingsId"] = a.Configuration.APIClient.ParameterToString(phoneBaseSettingsId, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(linesLoggedInUserId).(string); ok { - if str != "" { - queryParams["linesLoggedInUserId"] = a.Configuration.APIClient.ParameterToString(linesLoggedInUserId, collectionFormat) - } - } else { - queryParams["linesLoggedInUserId"] = a.Configuration.APIClient.ParameterToString(linesLoggedInUserId, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(linesDefaultForUserId).(string); ok { - if str != "" { - queryParams["linesDefaultForUserId"] = a.Configuration.APIClient.ParameterToString(linesDefaultForUserId, collectionFormat) - } - } else { - queryParams["linesDefaultForUserId"] = a.Configuration.APIClient.ParameterToString(linesDefaultForUserId, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(phoneHardwareId).(string); ok { - if str != "" { - queryParams["phoneHardwareId"] = a.Configuration.APIClient.ParameterToString(phoneHardwareId, collectionFormat) - } - } else { - queryParams["phoneHardwareId"] = a.Configuration.APIClient.ParameterToString(phoneHardwareId, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(linesId).(string); ok { - if str != "" { - queryParams["linesId"] = a.Configuration.APIClient.ParameterToString(linesId, collectionFormat) - } - } else { - queryParams["linesId"] = a.Configuration.APIClient.ParameterToString(linesId, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(linesName).(string); ok { - if str != "" { - queryParams["linesName"] = a.Configuration.APIClient.ParameterToString(linesName, collectionFormat) - } - } else { - queryParams["linesName"] = a.Configuration.APIClient.ParameterToString(linesName, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range fields { - queryParams["fields"] = value - } - } else { - queryParams["fields"] = a.Configuration.APIClient.ParameterToString(fields, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Phoneentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgesPhonesTemplate invokes GET /api/v2/telephony/providers/edges/phones/template -// -// Get a Phone instance template based on a Phone Base Settings object. This object can then be modified and saved as a new Phone instance -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesPhonesTemplate(phoneBaseSettingsId string) (*Phone, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/phones/template" - defaultReturn := new(Phone) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'phoneBaseSettingsId' is set - if &phoneBaseSettingsId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'phoneBaseSettingsId' when calling TelephonyProvidersEdgeApi->GetTelephonyProvidersEdgesPhonesTemplate") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(phoneBaseSettingsId).(string); ok { - if str != "" { - queryParams["phoneBaseSettingsId"] = a.Configuration.APIClient.ParameterToString(phoneBaseSettingsId, collectionFormat) - } - } else { - queryParams["phoneBaseSettingsId"] = a.Configuration.APIClient.ParameterToString(phoneBaseSettingsId, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Phone - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgesPhysicalinterfaces invokes GET /api/v2/telephony/providers/edges/physicalinterfaces -// -// Get physical interfaces for edges. -// -// Retrieves a list of all configured physical interfaces for a list of edges. Only 100 edges can be requested at a time. -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesPhysicalinterfaces(edgeIds string) (*Physicalinterfaceentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/physicalinterfaces" - defaultReturn := new(Physicalinterfaceentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'edgeIds' is set - if &edgeIds == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'edgeIds' when calling TelephonyProvidersEdgeApi->GetTelephonyProvidersEdgesPhysicalinterfaces") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(edgeIds).(string); ok { - if str != "" { - queryParams["edgeIds"] = a.Configuration.APIClient.ParameterToString(edgeIds, collectionFormat) - } - } else { - queryParams["edgeIds"] = a.Configuration.APIClient.ParameterToString(edgeIds, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Physicalinterfaceentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgesSite invokes GET /api/v2/telephony/providers/edges/sites/{siteId} -// -// Get a Site by ID. -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesSite(siteId string) (*Site, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/sites/{siteId}" - path = strings.Replace(path, "{siteId}", fmt.Sprintf("%v", siteId), -1) - defaultReturn := new(Site) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'siteId' is set - if &siteId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'siteId' when calling TelephonyProvidersEdgeApi->GetTelephonyProvidersEdgesSite") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Site - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgesSiteNumberplan invokes GET /api/v2/telephony/providers/edges/sites/{siteId}/numberplans/{numberPlanId} -// -// Get a Number Plan by ID. -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesSiteNumberplan(siteId string, numberPlanId string) (*Numberplan, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/sites/{siteId}/numberplans/{numberPlanId}" - path = strings.Replace(path, "{siteId}", fmt.Sprintf("%v", siteId), -1) - path = strings.Replace(path, "{numberPlanId}", fmt.Sprintf("%v", numberPlanId), -1) - defaultReturn := new(Numberplan) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'siteId' is set - if &siteId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'siteId' when calling TelephonyProvidersEdgeApi->GetTelephonyProvidersEdgesSiteNumberplan") - } - // verify the required parameter 'numberPlanId' is set - if &numberPlanId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'numberPlanId' when calling TelephonyProvidersEdgeApi->GetTelephonyProvidersEdgesSiteNumberplan") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Numberplan - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgesSiteNumberplans invokes GET /api/v2/telephony/providers/edges/sites/{siteId}/numberplans -// -// Get the list of Number Plans for this Site. Only fetches the first 200 records. -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesSiteNumberplans(siteId string) ([]Numberplan, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/sites/{siteId}/numberplans" - path = strings.Replace(path, "{siteId}", fmt.Sprintf("%v", siteId), -1) - defaultReturn := make([]Numberplan, 0) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'siteId' is set - if &siteId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'siteId' when calling TelephonyProvidersEdgeApi->GetTelephonyProvidersEdgesSiteNumberplans") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload []Numberplan - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgesSiteNumberplansClassifications invokes GET /api/v2/telephony/providers/edges/sites/{siteId}/numberplans/classifications -// -// Get a list of Classifications for this Site -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesSiteNumberplansClassifications(siteId string, classification string) ([]string, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/sites/{siteId}/numberplans/classifications" - path = strings.Replace(path, "{siteId}", fmt.Sprintf("%v", siteId), -1) - defaultReturn := make([]string, 0) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'siteId' is set - if &siteId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'siteId' when calling TelephonyProvidersEdgeApi->GetTelephonyProvidersEdgesSiteNumberplansClassifications") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(classification).(string); ok { - if str != "" { - queryParams["classification"] = a.Configuration.APIClient.ParameterToString(classification, collectionFormat) - } - } else { - queryParams["classification"] = a.Configuration.APIClient.ParameterToString(classification, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload []string - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgesSiteOutboundroute invokes GET /api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId} -// -// Get an outbound route -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesSiteOutboundroute(siteId string, outboundRouteId string) (*Outboundroutebase, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId}" - path = strings.Replace(path, "{siteId}", fmt.Sprintf("%v", siteId), -1) - path = strings.Replace(path, "{outboundRouteId}", fmt.Sprintf("%v", outboundRouteId), -1) - defaultReturn := new(Outboundroutebase) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'siteId' is set - if &siteId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'siteId' when calling TelephonyProvidersEdgeApi->GetTelephonyProvidersEdgesSiteOutboundroute") - } - // verify the required parameter 'outboundRouteId' is set - if &outboundRouteId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'outboundRouteId' when calling TelephonyProvidersEdgeApi->GetTelephonyProvidersEdgesSiteOutboundroute") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Outboundroutebase - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgesSiteOutboundroutes invokes GET /api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes -// -// Get outbound routes -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesSiteOutboundroutes(siteId string, pageSize int, pageNumber int, name string, externalTrunkBasesIds string, sortBy string) (*Outboundroutebaseentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes" - path = strings.Replace(path, "{siteId}", fmt.Sprintf("%v", siteId), -1) - defaultReturn := new(Outboundroutebaseentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'siteId' is set - if &siteId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'siteId' when calling TelephonyProvidersEdgeApi->GetTelephonyProvidersEdgesSiteOutboundroutes") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(externalTrunkBasesIds).(string); ok { - if str != "" { - queryParams["externalTrunkBasesIds"] = a.Configuration.APIClient.ParameterToString(externalTrunkBasesIds, collectionFormat) - } - } else { - queryParams["externalTrunkBasesIds"] = a.Configuration.APIClient.ParameterToString(externalTrunkBasesIds, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Outboundroutebaseentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgesSites invokes GET /api/v2/telephony/providers/edges/sites -// -// Get the list of Sites. -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesSites(pageSize int, pageNumber int, sortBy string, sortOrder string, name string, locationId string, managed bool) (*Siteentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/sites" - defaultReturn := new(Siteentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(locationId).(string); ok { - if str != "" { - queryParams["locationId"] = a.Configuration.APIClient.ParameterToString(locationId, collectionFormat) - } - } else { - queryParams["locationId"] = a.Configuration.APIClient.ParameterToString(locationId, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(managed).(string); ok { - if str != "" { - queryParams["managed"] = a.Configuration.APIClient.ParameterToString(managed, collectionFormat) - } - } else { - queryParams["managed"] = a.Configuration.APIClient.ParameterToString(managed, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Siteentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgesTimezones invokes GET /api/v2/telephony/providers/edges/timezones -// -// Get a list of Edge-compatible time zones -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesTimezones(pageSize int, pageNumber int) (*Timezoneentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/timezones" - defaultReturn := new(Timezoneentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Timezoneentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgesTrunk invokes GET /api/v2/telephony/providers/edges/trunks/{trunkId} -// -// Get a Trunk by ID -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesTrunk(trunkId string) (*Trunk, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/trunks/{trunkId}" - path = strings.Replace(path, "{trunkId}", fmt.Sprintf("%v", trunkId), -1) - defaultReturn := new(Trunk) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'trunkId' is set - if &trunkId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'trunkId' when calling TelephonyProvidersEdgeApi->GetTelephonyProvidersEdgesTrunk") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Trunk - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgesTrunkMetrics invokes GET /api/v2/telephony/providers/edges/trunks/{trunkId}/metrics -// -// Get the trunk metrics. -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesTrunkMetrics(trunkId string) (*Trunkmetrics, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/trunks/{trunkId}/metrics" - path = strings.Replace(path, "{trunkId}", fmt.Sprintf("%v", trunkId), -1) - defaultReturn := new(Trunkmetrics) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'trunkId' is set - if &trunkId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'trunkId' when calling TelephonyProvidersEdgeApi->GetTelephonyProvidersEdgesTrunkMetrics") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Trunkmetrics - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgesTrunkbasesetting invokes GET /api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId} -// -// Get a Trunk Base Settings object by ID -// -// Managed properties will not be returned unless the user is assigned the internal:trunk:edit permission. -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesTrunkbasesetting(trunkBaseSettingsId string, ignoreHidden bool) (*Trunkbase, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId}" - path = strings.Replace(path, "{trunkBaseSettingsId}", fmt.Sprintf("%v", trunkBaseSettingsId), -1) - defaultReturn := new(Trunkbase) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'trunkBaseSettingsId' is set - if &trunkBaseSettingsId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'trunkBaseSettingsId' when calling TelephonyProvidersEdgeApi->GetTelephonyProvidersEdgesTrunkbasesetting") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(ignoreHidden).(string); ok { - if str != "" { - queryParams["ignoreHidden"] = a.Configuration.APIClient.ParameterToString(ignoreHidden, collectionFormat) - } - } else { - queryParams["ignoreHidden"] = a.Configuration.APIClient.ParameterToString(ignoreHidden, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Trunkbase - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgesTrunkbasesettings invokes GET /api/v2/telephony/providers/edges/trunkbasesettings -// -// Get Trunk Base Settings listing -// -// Managed properties will not be returned unless the user is assigned the internal:trunk:edit permission. -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesTrunkbasesettings(pageNumber int, pageSize int, sortBy string, sortOrder string, recordingEnabled bool, ignoreHidden bool, managed bool, expand []string, name string) (*Trunkbaseentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/trunkbasesettings" - defaultReturn := new(Trunkbaseentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(recordingEnabled).(string); ok { - if str != "" { - queryParams["recordingEnabled"] = a.Configuration.APIClient.ParameterToString(recordingEnabled, collectionFormat) - } - } else { - queryParams["recordingEnabled"] = a.Configuration.APIClient.ParameterToString(recordingEnabled, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(ignoreHidden).(string); ok { - if str != "" { - queryParams["ignoreHidden"] = a.Configuration.APIClient.ParameterToString(ignoreHidden, collectionFormat) - } - } else { - queryParams["ignoreHidden"] = a.Configuration.APIClient.ParameterToString(ignoreHidden, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(managed).(string); ok { - if str != "" { - queryParams["managed"] = a.Configuration.APIClient.ParameterToString(managed, collectionFormat) - } - } else { - queryParams["managed"] = a.Configuration.APIClient.ParameterToString(managed, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Trunkbaseentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgesTrunkbasesettingsAvailablemetabases invokes GET /api/v2/telephony/providers/edges/trunkbasesettings/availablemetabases -// -// Get a list of available makes and models to create a new Trunk Base Settings -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesTrunkbasesettingsAvailablemetabases(varType string, pageSize int, pageNumber int) (*Trunkmetabaseentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/trunkbasesettings/availablemetabases" - defaultReturn := new(Trunkmetabaseentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(varType).(string); ok { - if str != "" { - queryParams["varType"] = a.Configuration.APIClient.ParameterToString(varType, collectionFormat) - } - } else { - queryParams["varType"] = a.Configuration.APIClient.ParameterToString(varType, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Trunkmetabaseentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgesTrunkbasesettingsTemplate invokes GET /api/v2/telephony/providers/edges/trunkbasesettings/template -// -// Get a Trunk Base Settings instance template from a given make and model. This object can then be modified and saved as a new Trunk Base Settings instance -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesTrunkbasesettingsTemplate(trunkMetabaseId string) (*Trunkbase, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/trunkbasesettings/template" - defaultReturn := new(Trunkbase) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'trunkMetabaseId' is set - if &trunkMetabaseId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'trunkMetabaseId' when calling TelephonyProvidersEdgeApi->GetTelephonyProvidersEdgesTrunkbasesettingsTemplate") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(trunkMetabaseId).(string); ok { - if str != "" { - queryParams["trunkMetabaseId"] = a.Configuration.APIClient.ParameterToString(trunkMetabaseId, collectionFormat) - } - } else { - queryParams["trunkMetabaseId"] = a.Configuration.APIClient.ParameterToString(trunkMetabaseId, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Trunkbase - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgesTrunks invokes GET /api/v2/telephony/providers/edges/trunks -// -// Get the list of available trunks. -// -// Trunks are created by assigning trunk base settings to an Edge or Edge Group. -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesTrunks(pageNumber int, pageSize int, sortBy string, sortOrder string, edgeId string, trunkBaseId string, trunkType string) (*Trunkentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/trunks" - defaultReturn := new(Trunkentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortBy).(string); ok { - if str != "" { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - } else { - queryParams["sortBy"] = a.Configuration.APIClient.ParameterToString(sortBy, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(edgeId).(string); ok { - if str != "" { - queryParams["edgeId"] = a.Configuration.APIClient.ParameterToString(edgeId, collectionFormat) - } - } else { - queryParams["edgeId"] = a.Configuration.APIClient.ParameterToString(edgeId, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(trunkBaseId).(string); ok { - if str != "" { - queryParams["trunkBaseId"] = a.Configuration.APIClient.ParameterToString(trunkBaseId, collectionFormat) - } - } else { - queryParams["trunkBaseId"] = a.Configuration.APIClient.ParameterToString(trunkBaseId, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(trunkType).(string); ok { - if str != "" { - queryParams["trunkType"] = a.Configuration.APIClient.ParameterToString(trunkType, collectionFormat) - } - } else { - queryParams["trunkType"] = a.Configuration.APIClient.ParameterToString(trunkType, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Trunkentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgesTrunksMetrics invokes GET /api/v2/telephony/providers/edges/trunks/metrics -// -// Get the metrics for a list of trunks. -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesTrunksMetrics(trunkIds string) ([]Trunkmetrics, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/trunks/metrics" - defaultReturn := make([]Trunkmetrics, 0) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'trunkIds' is set - if &trunkIds == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'trunkIds' when calling TelephonyProvidersEdgeApi->GetTelephonyProvidersEdgesTrunksMetrics") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(trunkIds).(string); ok { - if str != "" { - queryParams["trunkIds"] = a.Configuration.APIClient.ParameterToString(trunkIds, collectionFormat) - } - } else { - queryParams["trunkIds"] = a.Configuration.APIClient.ParameterToString(trunkIds, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload []Trunkmetrics - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTelephonyProvidersEdgesTrunkswithrecording invokes GET /api/v2/telephony/providers/edges/trunkswithrecording -// -// Get Counts of trunks that have recording disabled or enabled -// -// -func (a TelephonyProvidersEdgeApi) GetTelephonyProvidersEdgesTrunkswithrecording(trunkType string) (*Trunkrecordingenabledcount, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/trunkswithrecording" - defaultReturn := new(Trunkrecordingenabledcount) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(trunkType).(string); ok { - if str != "" { - queryParams["trunkType"] = a.Configuration.APIClient.ParameterToString(trunkType, collectionFormat) - } - } else { - queryParams["trunkType"] = a.Configuration.APIClient.ParameterToString(trunkType, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Trunkrecordingenabledcount - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostTelephonyProvidersEdgeDiagnosticNslookup invokes POST /api/v2/telephony/providers/edges/{edgeId}/diagnostic/nslookup -// -// Nslookup request command to collect networking-related information from an Edge for a target IP or host. -// -// -func (a TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgeDiagnosticNslookup(edgeId string, body Edgenetworkdiagnosticrequest) (*Edgenetworkdiagnostic, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/{edgeId}/diagnostic/nslookup" - path = strings.Replace(path, "{edgeId}", fmt.Sprintf("%v", edgeId), -1) - defaultReturn := new(Edgenetworkdiagnostic) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'edgeId' is set - if &edgeId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'edgeId' when calling TelephonyProvidersEdgeApi->PostTelephonyProvidersEdgeDiagnosticNslookup") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling TelephonyProvidersEdgeApi->PostTelephonyProvidersEdgeDiagnosticNslookup") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Edgenetworkdiagnostic - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostTelephonyProvidersEdgeDiagnosticPing invokes POST /api/v2/telephony/providers/edges/{edgeId}/diagnostic/ping -// -// Ping Request command to collect networking-related information from an Edge for a target IP or host. -// -// -func (a TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgeDiagnosticPing(edgeId string, body Edgenetworkdiagnosticrequest) (*Edgenetworkdiagnostic, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/{edgeId}/diagnostic/ping" - path = strings.Replace(path, "{edgeId}", fmt.Sprintf("%v", edgeId), -1) - defaultReturn := new(Edgenetworkdiagnostic) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'edgeId' is set - if &edgeId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'edgeId' when calling TelephonyProvidersEdgeApi->PostTelephonyProvidersEdgeDiagnosticPing") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling TelephonyProvidersEdgeApi->PostTelephonyProvidersEdgeDiagnosticPing") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Edgenetworkdiagnostic - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostTelephonyProvidersEdgeDiagnosticRoute invokes POST /api/v2/telephony/providers/edges/{edgeId}/diagnostic/route -// -// Route request command to collect networking-related information from an Edge for a target IP or host. -// -// -func (a TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgeDiagnosticRoute(edgeId string, body Edgenetworkdiagnosticrequest) (*Edgenetworkdiagnostic, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/{edgeId}/diagnostic/route" - path = strings.Replace(path, "{edgeId}", fmt.Sprintf("%v", edgeId), -1) - defaultReturn := new(Edgenetworkdiagnostic) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'edgeId' is set - if &edgeId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'edgeId' when calling TelephonyProvidersEdgeApi->PostTelephonyProvidersEdgeDiagnosticRoute") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling TelephonyProvidersEdgeApi->PostTelephonyProvidersEdgeDiagnosticRoute") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Edgenetworkdiagnostic - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostTelephonyProvidersEdgeDiagnosticTracepath invokes POST /api/v2/telephony/providers/edges/{edgeId}/diagnostic/tracepath -// -// Tracepath request command to collect networking-related information from an Edge for a target IP or host. -// -// -func (a TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgeDiagnosticTracepath(edgeId string, body Edgenetworkdiagnosticrequest) (*Edgenetworkdiagnostic, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/{edgeId}/diagnostic/tracepath" - path = strings.Replace(path, "{edgeId}", fmt.Sprintf("%v", edgeId), -1) - defaultReturn := new(Edgenetworkdiagnostic) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'edgeId' is set - if &edgeId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'edgeId' when calling TelephonyProvidersEdgeApi->PostTelephonyProvidersEdgeDiagnosticTracepath") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling TelephonyProvidersEdgeApi->PostTelephonyProvidersEdgeDiagnosticTracepath") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Edgenetworkdiagnostic - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostTelephonyProvidersEdgeLogicalinterfaces invokes POST /api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces -// -// Create an edge logical interface. -// -// Create -func (a TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgeLogicalinterfaces(edgeId string, body Domainlogicalinterface) (*Domainlogicalinterface, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces" - path = strings.Replace(path, "{edgeId}", fmt.Sprintf("%v", edgeId), -1) - defaultReturn := new(Domainlogicalinterface) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'edgeId' is set - if &edgeId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'edgeId' when calling TelephonyProvidersEdgeApi->PostTelephonyProvidersEdgeLogicalinterfaces") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling TelephonyProvidersEdgeApi->PostTelephonyProvidersEdgeLogicalinterfaces") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Domainlogicalinterface - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostTelephonyProvidersEdgeLogsJobUpload invokes POST /api/v2/telephony/providers/edges/{edgeId}/logs/jobs/{jobId}/upload -// -// Request that the specified fileIds be uploaded from the Edge. -// -// -func (a TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgeLogsJobUpload(edgeId string, jobId string, body Edgelogsjobuploadrequest) (*APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/{edgeId}/logs/jobs/{jobId}/upload" - path = strings.Replace(path, "{edgeId}", fmt.Sprintf("%v", edgeId), -1) - path = strings.Replace(path, "{jobId}", fmt.Sprintf("%v", jobId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'edgeId' is set - if &edgeId == nil { - // - return nil, errors.New("Missing required parameter 'edgeId' when calling TelephonyProvidersEdgeApi->PostTelephonyProvidersEdgeLogsJobUpload") - } - // verify the required parameter 'jobId' is set - if &jobId == nil { - // - return nil, errors.New("Missing required parameter 'jobId' when calling TelephonyProvidersEdgeApi->PostTelephonyProvidersEdgeLogsJobUpload") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return nil, errors.New("Missing required parameter 'body' when calling TelephonyProvidersEdgeApi->PostTelephonyProvidersEdgeLogsJobUpload") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// PostTelephonyProvidersEdgeLogsJobs invokes POST /api/v2/telephony/providers/edges/{edgeId}/logs/jobs -// -// Create a job to upload a list of Edge logs. -// -// -func (a TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgeLogsJobs(edgeId string, body Edgelogsjobrequest) (*Edgelogsjobresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/{edgeId}/logs/jobs" - path = strings.Replace(path, "{edgeId}", fmt.Sprintf("%v", edgeId), -1) - defaultReturn := new(Edgelogsjobresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'edgeId' is set - if &edgeId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'edgeId' when calling TelephonyProvidersEdgeApi->PostTelephonyProvidersEdgeLogsJobs") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling TelephonyProvidersEdgeApi->PostTelephonyProvidersEdgeLogsJobs") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Edgelogsjobresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostTelephonyProvidersEdgeReboot invokes POST /api/v2/telephony/providers/edges/{edgeId}/reboot -// -// Reboot an Edge -// -// -func (a TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgeReboot(edgeId string, body Edgerebootparameters) (*string, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/{edgeId}/reboot" - path = strings.Replace(path, "{edgeId}", fmt.Sprintf("%v", edgeId), -1) - defaultReturn := new(string) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'edgeId' is set - if &edgeId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'edgeId' when calling TelephonyProvidersEdgeApi->PostTelephonyProvidersEdgeReboot") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *string - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostTelephonyProvidersEdgeSoftwareupdate invokes POST /api/v2/telephony/providers/edges/{edgeId}/softwareupdate -// -// Starts a software update for this edge. -// -// -func (a TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgeSoftwareupdate(edgeId string, body Domainedgesoftwareupdatedto) (*Domainedgesoftwareupdatedto, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/{edgeId}/softwareupdate" - path = strings.Replace(path, "{edgeId}", fmt.Sprintf("%v", edgeId), -1) - defaultReturn := new(Domainedgesoftwareupdatedto) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'edgeId' is set - if &edgeId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'edgeId' when calling TelephonyProvidersEdgeApi->PostTelephonyProvidersEdgeSoftwareupdate") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling TelephonyProvidersEdgeApi->PostTelephonyProvidersEdgeSoftwareupdate") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Domainedgesoftwareupdatedto - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostTelephonyProvidersEdgeStatuscode invokes POST /api/v2/telephony/providers/edges/{edgeId}/statuscode -// -// Take an Edge in or out of service -// -// -func (a TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgeStatuscode(edgeId string, body Edgeservicestaterequest) (*string, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/{edgeId}/statuscode" - path = strings.Replace(path, "{edgeId}", fmt.Sprintf("%v", edgeId), -1) - defaultReturn := new(string) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'edgeId' is set - if &edgeId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'edgeId' when calling TelephonyProvidersEdgeApi->PostTelephonyProvidersEdgeStatuscode") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *string - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostTelephonyProvidersEdgeUnpair invokes POST /api/v2/telephony/providers/edges/{edgeId}/unpair -// -// Unpair an Edge -// -// -func (a TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgeUnpair(edgeId string) (*string, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/{edgeId}/unpair" - path = strings.Replace(path, "{edgeId}", fmt.Sprintf("%v", edgeId), -1) - defaultReturn := new(string) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'edgeId' is set - if &edgeId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'edgeId' when calling TelephonyProvidersEdgeApi->PostTelephonyProvidersEdgeUnpair") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *string - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostTelephonyProvidersEdges invokes POST /api/v2/telephony/providers/edges -// -// Create an edge. -// -// -func (a TelephonyProvidersEdgeApi) PostTelephonyProvidersEdges(body Edge) (*Edge, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges" - defaultReturn := new(Edge) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling TelephonyProvidersEdgeApi->PostTelephonyProvidersEdges") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Edge - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostTelephonyProvidersEdgesAddressvalidation invokes POST /api/v2/telephony/providers/edges/addressvalidation -// -// Validates a street address -// -// -func (a TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgesAddressvalidation(body Validateaddressrequest) (*Validateaddressresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/addressvalidation" - defaultReturn := new(Validateaddressresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling TelephonyProvidersEdgeApi->PostTelephonyProvidersEdgesAddressvalidation") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Validateaddressresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostTelephonyProvidersEdgesCertificateauthorities invokes POST /api/v2/telephony/providers/edges/certificateauthorities -// -// Create a certificate authority. -// -// -func (a TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgesCertificateauthorities(body Domaincertificateauthority) (*Domaincertificateauthority, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/certificateauthorities" - defaultReturn := new(Domaincertificateauthority) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling TelephonyProvidersEdgeApi->PostTelephonyProvidersEdgesCertificateauthorities") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Domaincertificateauthority - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostTelephonyProvidersEdgesDidpools invokes POST /api/v2/telephony/providers/edges/didpools -// -// Create a new DID pool -// -// -func (a TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgesDidpools(body Didpool) (*Didpool, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/didpools" - defaultReturn := new(Didpool) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling TelephonyProvidersEdgeApi->PostTelephonyProvidersEdgesDidpools") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Didpool - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostTelephonyProvidersEdgesEdgegroups invokes POST /api/v2/telephony/providers/edges/edgegroups -// -// Create an edge group. -// -// -func (a TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgesEdgegroups(body Edgegroup) (*Edgegroup, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/edgegroups" - defaultReturn := new(Edgegroup) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling TelephonyProvidersEdgeApi->PostTelephonyProvidersEdgesEdgegroups") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Edgegroup - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostTelephonyProvidersEdgesExtensionpools invokes POST /api/v2/telephony/providers/edges/extensionpools -// -// Create a new extension pool -// -// -func (a TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgesExtensionpools(body Extensionpool) (*Extensionpool, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/extensionpools" - defaultReturn := new(Extensionpool) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling TelephonyProvidersEdgeApi->PostTelephonyProvidersEdgesExtensionpools") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Extensionpool - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostTelephonyProvidersEdgesOutboundroutes invokes POST /api/v2/telephony/providers/edges/outboundroutes -// -// Create outbound rule -// -// -func (a TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgesOutboundroutes(body Outboundroute) (*Outboundroute, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/outboundroutes" - defaultReturn := new(Outboundroute) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling TelephonyProvidersEdgeApi->PostTelephonyProvidersEdgesOutboundroutes") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Outboundroute - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostTelephonyProvidersEdgesPhoneReboot invokes POST /api/v2/telephony/providers/edges/phones/{phoneId}/reboot -// -// Reboot a Phone -// -// -func (a TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgesPhoneReboot(phoneId string) (*APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/phones/{phoneId}/reboot" - path = strings.Replace(path, "{phoneId}", fmt.Sprintf("%v", phoneId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'phoneId' is set - if &phoneId == nil { - // - return nil, errors.New("Missing required parameter 'phoneId' when calling TelephonyProvidersEdgeApi->PostTelephonyProvidersEdgesPhoneReboot") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// PostTelephonyProvidersEdgesPhonebasesettings invokes POST /api/v2/telephony/providers/edges/phonebasesettings -// -// Create a new Phone Base Settings object -// -// -func (a TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgesPhonebasesettings(body Phonebase) (*Phonebase, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/phonebasesettings" - defaultReturn := new(Phonebase) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling TelephonyProvidersEdgeApi->PostTelephonyProvidersEdgesPhonebasesettings") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Phonebase - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostTelephonyProvidersEdgesPhones invokes POST /api/v2/telephony/providers/edges/phones -// -// Create a new Phone -// -// -func (a TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgesPhones(body Phone) (*Phone, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/phones" - defaultReturn := new(Phone) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling TelephonyProvidersEdgeApi->PostTelephonyProvidersEdgesPhones") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Phone - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostTelephonyProvidersEdgesPhonesReboot invokes POST /api/v2/telephony/providers/edges/phones/reboot -// -// Reboot Multiple Phones -// -// -func (a TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgesPhonesReboot(body Phonesreboot) (*APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/phones/reboot" - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return nil, errors.New("Missing required parameter 'body' when calling TelephonyProvidersEdgeApi->PostTelephonyProvidersEdgesPhonesReboot") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// PostTelephonyProvidersEdgesSiteOutboundroutes invokes POST /api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes -// -// Create outbound route -// -// -func (a TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgesSiteOutboundroutes(siteId string, body Outboundroutebase) (*Outboundroutebase, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes" - path = strings.Replace(path, "{siteId}", fmt.Sprintf("%v", siteId), -1) - defaultReturn := new(Outboundroutebase) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'siteId' is set - if &siteId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'siteId' when calling TelephonyProvidersEdgeApi->PostTelephonyProvidersEdgesSiteOutboundroutes") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling TelephonyProvidersEdgeApi->PostTelephonyProvidersEdgesSiteOutboundroutes") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Outboundroutebase - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostTelephonyProvidersEdgesSiteRebalance invokes POST /api/v2/telephony/providers/edges/sites/{siteId}/rebalance -// -// Triggers the rebalance operation. -// -// -func (a TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgesSiteRebalance(siteId string) (*APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/sites/{siteId}/rebalance" - path = strings.Replace(path, "{siteId}", fmt.Sprintf("%v", siteId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'siteId' is set - if &siteId == nil { - // - return nil, errors.New("Missing required parameter 'siteId' when calling TelephonyProvidersEdgeApi->PostTelephonyProvidersEdgesSiteRebalance") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// PostTelephonyProvidersEdgesSites invokes POST /api/v2/telephony/providers/edges/sites -// -// Create a Site. -// -// -func (a TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgesSites(body Site) (*Site, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/sites" - defaultReturn := new(Site) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling TelephonyProvidersEdgeApi->PostTelephonyProvidersEdgesSites") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Site - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostTelephonyProvidersEdgesTrunkbasesettings invokes POST /api/v2/telephony/providers/edges/trunkbasesettings -// -// Create a Trunk Base Settings object -// -// -func (a TelephonyProvidersEdgeApi) PostTelephonyProvidersEdgesTrunkbasesettings(body Trunkbase) (*Trunkbase, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/trunkbasesettings" - defaultReturn := new(Trunkbase) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling TelephonyProvidersEdgeApi->PostTelephonyProvidersEdgesTrunkbasesettings") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Trunkbase - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutTelephonyProvidersEdge invokes PUT /api/v2/telephony/providers/edges/{edgeId} -// -// Update a edge. -// -// -func (a TelephonyProvidersEdgeApi) PutTelephonyProvidersEdge(edgeId string, body Edge) (*Edge, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/{edgeId}" - path = strings.Replace(path, "{edgeId}", fmt.Sprintf("%v", edgeId), -1) - defaultReturn := new(Edge) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'edgeId' is set - if &edgeId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'edgeId' when calling TelephonyProvidersEdgeApi->PutTelephonyProvidersEdge") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling TelephonyProvidersEdgeApi->PutTelephonyProvidersEdge") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Edge - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutTelephonyProvidersEdgeLine invokes PUT /api/v2/telephony/providers/edges/{edgeId}/lines/{lineId} -// -// Update a line. -// -// -func (a TelephonyProvidersEdgeApi) PutTelephonyProvidersEdgeLine(edgeId string, lineId string, body Edgeline) (*Edgeline, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/{edgeId}/lines/{lineId}" - path = strings.Replace(path, "{edgeId}", fmt.Sprintf("%v", edgeId), -1) - path = strings.Replace(path, "{lineId}", fmt.Sprintf("%v", lineId), -1) - defaultReturn := new(Edgeline) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'edgeId' is set - if &edgeId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'edgeId' when calling TelephonyProvidersEdgeApi->PutTelephonyProvidersEdgeLine") - } - // verify the required parameter 'lineId' is set - if &lineId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'lineId' when calling TelephonyProvidersEdgeApi->PutTelephonyProvidersEdgeLine") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling TelephonyProvidersEdgeApi->PutTelephonyProvidersEdgeLine") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Edgeline - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutTelephonyProvidersEdgeLogicalinterface invokes PUT /api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces/{interfaceId} -// -// Update an edge logical interface. -// -// -func (a TelephonyProvidersEdgeApi) PutTelephonyProvidersEdgeLogicalinterface(edgeId string, interfaceId string, body Domainlogicalinterface) (*Domainlogicalinterface, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces/{interfaceId}" - path = strings.Replace(path, "{edgeId}", fmt.Sprintf("%v", edgeId), -1) - path = strings.Replace(path, "{interfaceId}", fmt.Sprintf("%v", interfaceId), -1) - defaultReturn := new(Domainlogicalinterface) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'edgeId' is set - if &edgeId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'edgeId' when calling TelephonyProvidersEdgeApi->PutTelephonyProvidersEdgeLogicalinterface") - } - // verify the required parameter 'interfaceId' is set - if &interfaceId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'interfaceId' when calling TelephonyProvidersEdgeApi->PutTelephonyProvidersEdgeLogicalinterface") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling TelephonyProvidersEdgeApi->PutTelephonyProvidersEdgeLogicalinterface") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Domainlogicalinterface - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutTelephonyProvidersEdgesCertificateauthority invokes PUT /api/v2/telephony/providers/edges/certificateauthorities/{certificateId} -// -// Update a certificate authority. -// -// -func (a TelephonyProvidersEdgeApi) PutTelephonyProvidersEdgesCertificateauthority(certificateId string, body Domaincertificateauthority) (*Domaincertificateauthority, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/certificateauthorities/{certificateId}" - path = strings.Replace(path, "{certificateId}", fmt.Sprintf("%v", certificateId), -1) - defaultReturn := new(Domaincertificateauthority) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'certificateId' is set - if &certificateId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'certificateId' when calling TelephonyProvidersEdgeApi->PutTelephonyProvidersEdgesCertificateauthority") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling TelephonyProvidersEdgeApi->PutTelephonyProvidersEdgesCertificateauthority") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Domaincertificateauthority - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutTelephonyProvidersEdgesDid invokes PUT /api/v2/telephony/providers/edges/dids/{didId} -// -// Update a DID by ID. -// -// -func (a TelephonyProvidersEdgeApi) PutTelephonyProvidersEdgesDid(didId string, body Did) (*Did, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/dids/{didId}" - path = strings.Replace(path, "{didId}", fmt.Sprintf("%v", didId), -1) - defaultReturn := new(Did) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'didId' is set - if &didId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'didId' when calling TelephonyProvidersEdgeApi->PutTelephonyProvidersEdgesDid") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling TelephonyProvidersEdgeApi->PutTelephonyProvidersEdgesDid") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Did - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutTelephonyProvidersEdgesDidpool invokes PUT /api/v2/telephony/providers/edges/didpools/{didPoolId} -// -// Update a DID Pool by ID. -// -// -func (a TelephonyProvidersEdgeApi) PutTelephonyProvidersEdgesDidpool(didPoolId string, body Didpool) (*Didpool, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/didpools/{didPoolId}" - path = strings.Replace(path, "{didPoolId}", fmt.Sprintf("%v", didPoolId), -1) - defaultReturn := new(Didpool) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'didPoolId' is set - if &didPoolId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'didPoolId' when calling TelephonyProvidersEdgeApi->PutTelephonyProvidersEdgesDidpool") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling TelephonyProvidersEdgeApi->PutTelephonyProvidersEdgesDidpool") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Didpool - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutTelephonyProvidersEdgesEdgegroup invokes PUT /api/v2/telephony/providers/edges/edgegroups/{edgeGroupId} -// -// Update an edge group. -// -// -func (a TelephonyProvidersEdgeApi) PutTelephonyProvidersEdgesEdgegroup(edgeGroupId string, body Edgegroup) (*Edgegroup, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/edgegroups/{edgeGroupId}" - path = strings.Replace(path, "{edgeGroupId}", fmt.Sprintf("%v", edgeGroupId), -1) - defaultReturn := new(Edgegroup) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'edgeGroupId' is set - if &edgeGroupId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'edgeGroupId' when calling TelephonyProvidersEdgeApi->PutTelephonyProvidersEdgesEdgegroup") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling TelephonyProvidersEdgeApi->PutTelephonyProvidersEdgesEdgegroup") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Edgegroup - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutTelephonyProvidersEdgesEdgegroupEdgetrunkbase invokes PUT /api/v2/telephony/providers/edges/edgegroups/{edgegroupId}/edgetrunkbases/{edgetrunkbaseId} -// -// Update the edge trunk base associated with the edge group -// -// -func (a TelephonyProvidersEdgeApi) PutTelephonyProvidersEdgesEdgegroupEdgetrunkbase(edgegroupId string, edgetrunkbaseId string, body Edgetrunkbase) (*Edgetrunkbase, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/edgegroups/{edgegroupId}/edgetrunkbases/{edgetrunkbaseId}" - path = strings.Replace(path, "{edgegroupId}", fmt.Sprintf("%v", edgegroupId), -1) - path = strings.Replace(path, "{edgetrunkbaseId}", fmt.Sprintf("%v", edgetrunkbaseId), -1) - defaultReturn := new(Edgetrunkbase) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'edgegroupId' is set - if &edgegroupId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'edgegroupId' when calling TelephonyProvidersEdgeApi->PutTelephonyProvidersEdgesEdgegroupEdgetrunkbase") - } - // verify the required parameter 'edgetrunkbaseId' is set - if &edgetrunkbaseId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'edgetrunkbaseId' when calling TelephonyProvidersEdgeApi->PutTelephonyProvidersEdgesEdgegroupEdgetrunkbase") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling TelephonyProvidersEdgeApi->PutTelephonyProvidersEdgesEdgegroupEdgetrunkbase") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Edgetrunkbase - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutTelephonyProvidersEdgesExtension invokes PUT /api/v2/telephony/providers/edges/extensions/{extensionId} -// -// Update an extension by ID. -// -// -func (a TelephonyProvidersEdgeApi) PutTelephonyProvidersEdgesExtension(extensionId string, body Extension) (*Extension, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/extensions/{extensionId}" - path = strings.Replace(path, "{extensionId}", fmt.Sprintf("%v", extensionId), -1) - defaultReturn := new(Extension) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'extensionId' is set - if &extensionId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'extensionId' when calling TelephonyProvidersEdgeApi->PutTelephonyProvidersEdgesExtension") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling TelephonyProvidersEdgeApi->PutTelephonyProvidersEdgesExtension") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Extension - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutTelephonyProvidersEdgesExtensionpool invokes PUT /api/v2/telephony/providers/edges/extensionpools/{extensionPoolId} -// -// Update an extension pool by ID -// -// -func (a TelephonyProvidersEdgeApi) PutTelephonyProvidersEdgesExtensionpool(extensionPoolId string, body Extensionpool) (*Extensionpool, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/extensionpools/{extensionPoolId}" - path = strings.Replace(path, "{extensionPoolId}", fmt.Sprintf("%v", extensionPoolId), -1) - defaultReturn := new(Extensionpool) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'extensionPoolId' is set - if &extensionPoolId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'extensionPoolId' when calling TelephonyProvidersEdgeApi->PutTelephonyProvidersEdgesExtensionpool") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling TelephonyProvidersEdgeApi->PutTelephonyProvidersEdgesExtensionpool") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Extensionpool - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutTelephonyProvidersEdgesOutboundroute invokes PUT /api/v2/telephony/providers/edges/outboundroutes/{outboundRouteId} -// -// Update outbound route -// -// -func (a TelephonyProvidersEdgeApi) PutTelephonyProvidersEdgesOutboundroute(outboundRouteId string, body Outboundroute) (*Outboundroute, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/outboundroutes/{outboundRouteId}" - path = strings.Replace(path, "{outboundRouteId}", fmt.Sprintf("%v", outboundRouteId), -1) - defaultReturn := new(Outboundroute) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'outboundRouteId' is set - if &outboundRouteId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'outboundRouteId' when calling TelephonyProvidersEdgeApi->PutTelephonyProvidersEdgesOutboundroute") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling TelephonyProvidersEdgeApi->PutTelephonyProvidersEdgesOutboundroute") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Outboundroute - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutTelephonyProvidersEdgesPhone invokes PUT /api/v2/telephony/providers/edges/phones/{phoneId} -// -// Update a Phone by ID -// -// -func (a TelephonyProvidersEdgeApi) PutTelephonyProvidersEdgesPhone(phoneId string, body Phone) (*Phone, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/phones/{phoneId}" - path = strings.Replace(path, "{phoneId}", fmt.Sprintf("%v", phoneId), -1) - defaultReturn := new(Phone) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'phoneId' is set - if &phoneId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'phoneId' when calling TelephonyProvidersEdgeApi->PutTelephonyProvidersEdgesPhone") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling TelephonyProvidersEdgeApi->PutTelephonyProvidersEdgesPhone") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Phone - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutTelephonyProvidersEdgesPhonebasesetting invokes PUT /api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId} -// -// Update a Phone Base Settings by ID -// -// -func (a TelephonyProvidersEdgeApi) PutTelephonyProvidersEdgesPhonebasesetting(phoneBaseId string, body Phonebase) (*Phonebase, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId}" - path = strings.Replace(path, "{phoneBaseId}", fmt.Sprintf("%v", phoneBaseId), -1) - defaultReturn := new(Phonebase) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'phoneBaseId' is set - if &phoneBaseId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'phoneBaseId' when calling TelephonyProvidersEdgeApi->PutTelephonyProvidersEdgesPhonebasesetting") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling TelephonyProvidersEdgeApi->PutTelephonyProvidersEdgesPhonebasesetting") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Phonebase - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutTelephonyProvidersEdgesSite invokes PUT /api/v2/telephony/providers/edges/sites/{siteId} -// -// Update a Site by ID. -// -// -func (a TelephonyProvidersEdgeApi) PutTelephonyProvidersEdgesSite(siteId string, body Site) (*Site, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/sites/{siteId}" - path = strings.Replace(path, "{siteId}", fmt.Sprintf("%v", siteId), -1) - defaultReturn := new(Site) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'siteId' is set - if &siteId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'siteId' when calling TelephonyProvidersEdgeApi->PutTelephonyProvidersEdgesSite") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling TelephonyProvidersEdgeApi->PutTelephonyProvidersEdgesSite") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Site - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutTelephonyProvidersEdgesSiteNumberplans invokes PUT /api/v2/telephony/providers/edges/sites/{siteId}/numberplans -// -// Update the list of Number Plans. A user can update maximum 200 number plans at a time. -// -// -func (a TelephonyProvidersEdgeApi) PutTelephonyProvidersEdgesSiteNumberplans(siteId string, body []Numberplan) ([]Numberplan, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/sites/{siteId}/numberplans" - path = strings.Replace(path, "{siteId}", fmt.Sprintf("%v", siteId), -1) - defaultReturn := make([]Numberplan, 0) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'siteId' is set - if &siteId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'siteId' when calling TelephonyProvidersEdgeApi->PutTelephonyProvidersEdgesSiteNumberplans") - } - // verify the required parameter 'body' is set - if &body == nil { - // true - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling TelephonyProvidersEdgeApi->PutTelephonyProvidersEdgesSiteNumberplans") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload []Numberplan - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutTelephonyProvidersEdgesSiteOutboundroute invokes PUT /api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId} -// -// Update outbound route -// -// -func (a TelephonyProvidersEdgeApi) PutTelephonyProvidersEdgesSiteOutboundroute(siteId string, outboundRouteId string, body Outboundroutebase) (*Outboundroutebase, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId}" - path = strings.Replace(path, "{siteId}", fmt.Sprintf("%v", siteId), -1) - path = strings.Replace(path, "{outboundRouteId}", fmt.Sprintf("%v", outboundRouteId), -1) - defaultReturn := new(Outboundroutebase) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'siteId' is set - if &siteId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'siteId' when calling TelephonyProvidersEdgeApi->PutTelephonyProvidersEdgesSiteOutboundroute") - } - // verify the required parameter 'outboundRouteId' is set - if &outboundRouteId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'outboundRouteId' when calling TelephonyProvidersEdgeApi->PutTelephonyProvidersEdgesSiteOutboundroute") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling TelephonyProvidersEdgeApi->PutTelephonyProvidersEdgesSiteOutboundroute") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Outboundroutebase - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutTelephonyProvidersEdgesTrunkbasesetting invokes PUT /api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId} -// -// Update a Trunk Base Settings object by ID -// -// -func (a TelephonyProvidersEdgeApi) PutTelephonyProvidersEdgesTrunkbasesetting(trunkBaseSettingsId string, body Trunkbase) (*Trunkbase, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId}" - path = strings.Replace(path, "{trunkBaseSettingsId}", fmt.Sprintf("%v", trunkBaseSettingsId), -1) - defaultReturn := new(Trunkbase) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'trunkBaseSettingsId' is set - if &trunkBaseSettingsId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'trunkBaseSettingsId' when calling TelephonyProvidersEdgeApi->PutTelephonyProvidersEdgesTrunkbasesetting") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling TelephonyProvidersEdgeApi->PutTelephonyProvidersEdgesTrunkbasesetting") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Trunkbase - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/templateparameter.go b/build/platformclientv2/templateparameter.go deleted file mode 100644 index 99c29dcaf..000000000 --- a/build/platformclientv2/templateparameter.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Templateparameter -type Templateparameter struct { - // Id - Response substitution identifier - Id *string `json:"id,omitempty"` - - - // Value - Response substitution value - Value *string `json:"value,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Templateparameter) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/termattribute.go b/build/platformclientv2/termattribute.go deleted file mode 100644 index e3ca3cd99..000000000 --- a/build/platformclientv2/termattribute.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Termattribute -type Termattribute struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Termattribute) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/testexecutionoperationresult.go b/build/platformclientv2/testexecutionoperationresult.go deleted file mode 100644 index 8af7ce9b0..000000000 --- a/build/platformclientv2/testexecutionoperationresult.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Testexecutionoperationresult -type Testexecutionoperationresult struct { - // Step - The step number to indicate the order in which the operation was performed - Step *int `json:"step,omitempty"` - - - // Name - Name of the operation performed - Name *string `json:"name,omitempty"` - - - // Success - Indicated whether or not the operation was successful - Success *bool `json:"success,omitempty"` - - - // Result - The result of the operation - Result *map[string]interface{} `json:"result,omitempty"` - - - // VarError - Error that occurred during the operation - VarError *Errorbody `json:"error,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Testexecutionoperationresult) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/testexecutionresult.go b/build/platformclientv2/testexecutionresult.go deleted file mode 100644 index 219a9baf9..000000000 --- a/build/platformclientv2/testexecutionresult.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Testexecutionresult -type Testexecutionresult struct { - // Operations - Execution operations performed as part of the test - Operations *[]Testexecutionoperationresult `json:"operations,omitempty"` - - - // VarError - The final error encountered during the test that resulted in test failure - VarError *Errorbody `json:"error,omitempty"` - - - // FinalResult - The final result of the test. This is the response that would be returned during normal action execution - FinalResult *map[string]interface{} `json:"finalResult,omitempty"` - - - // Success - Indicates whether or not the test was a success - Success *bool `json:"success,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Testexecutionresult) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/testmessage.go b/build/platformclientv2/testmessage.go deleted file mode 100644 index 99b551a69..000000000 --- a/build/platformclientv2/testmessage.go +++ /dev/null @@ -1,42 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Testmessage -type Testmessage struct { - // Id - After the message has been sent, this is the value of the Message-ID email header. - Id *string `json:"id,omitempty"` - - - // To - The recipients of the email message. - To *[]Emailaddress `json:"to,omitempty"` - - - // From - The sender of the email message. - From *Emailaddress `json:"from,omitempty"` - - - // Subject - The subject of the email message. - Subject *string `json:"subject,omitempty"` - - - // TextBody - The text body of the email message. - TextBody *string `json:"textBody,omitempty"` - - - // HtmlBody - The html body of the email message - HtmlBody *string `json:"htmlBody,omitempty"` - - - // Time - The time when the message was sent. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - Time *time.Time `json:"time,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Testmessage) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/textbotsapi.go b/build/platformclientv2/textbotsapi.go deleted file mode 100644 index ea6a52a1a..000000000 --- a/build/platformclientv2/textbotsapi.go +++ /dev/null @@ -1,103 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "encoding/json" -) - -// TextbotsApi provides functions for API endpoints -type TextbotsApi struct { - Configuration *Configuration -} - -// NewTextbotsApi creates an API instance using the default configuration -func NewTextbotsApi() *TextbotsApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating TextbotsApi with base path: %s", strings.ToLower(config.BasePath))) - return &TextbotsApi{ - Configuration: config, - } -} - -// NewTextbotsApiWithConfig creates an API instance using the provided configuration -func NewTextbotsApiWithConfig(config *Configuration) *TextbotsApi { - config.Debugf("Creating TextbotsApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &TextbotsApi{ - Configuration: config, - } -} - -// PostTextbotsBotsExecute invokes POST /api/v2/textbots/bots/execute -// -// Send an intent to a bot to start a dialog/interact with it via text -// -// This will either start a bot with the given id or relay a communication to an existing bot session. -func (a TextbotsApi) PostTextbotsBotsExecute(postTextRequest Posttextrequest) (*Posttextresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/textbots/bots/execute" - defaultReturn := new(Posttextresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'postTextRequest' is set - if &postTextRequest == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'postTextRequest' when calling TextbotsApi->PostTextbotsBotsExecute") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &postTextRequest - - var successPayload *Posttextresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/textmessagelisting.go b/build/platformclientv2/textmessagelisting.go deleted file mode 100644 index 256efb016..000000000 --- a/build/platformclientv2/textmessagelisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Textmessagelisting -type Textmessagelisting struct { - // Entities - Entities *[]Messagedata `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Textmessagelisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/textstyleproperties.go b/build/platformclientv2/textstyleproperties.go deleted file mode 100644 index b75e0ea21..000000000 --- a/build/platformclientv2/textstyleproperties.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Textstyleproperties -type Textstyleproperties struct { - // Color - Color of the text. (eg. #FFFFFF) - Color *string `json:"color,omitempty"` - - - // Font - Font of the text. (eg. Helvetica) - Font *string `json:"font,omitempty"` - - - // FontSize - Font size of the text. (eg. '12') - FontSize *string `json:"fontSize,omitempty"` - - - // TextAlign - Text alignment. - TextAlign *string `json:"textAlign,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Textstyleproperties) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/ticker.go b/build/platformclientv2/ticker.go deleted file mode 100644 index 6df702e42..000000000 --- a/build/platformclientv2/ticker.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Ticker -type Ticker struct { - // Symbol - The ticker symbol for this organization. Example: ININ, AAPL, MSFT, etc. - Symbol *string `json:"symbol,omitempty"` - - - // Exchange - The exchange for this ticker symbol. Examples: NYSE, FTSE, NASDAQ, etc. - Exchange *string `json:"exchange,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Ticker) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/timeallowed.go b/build/platformclientv2/timeallowed.go deleted file mode 100644 index 75ee057b8..000000000 --- a/build/platformclientv2/timeallowed.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Timeallowed -type Timeallowed struct { - // TimeSlots - TimeSlots *[]Timeslot `json:"timeSlots,omitempty"` - - - // TimeZoneId - TimeZoneId *string `json:"timeZoneId,omitempty"` - - - // Empty - Empty *bool `json:"empty,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Timeallowed) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/timeinterval.go b/build/platformclientv2/timeinterval.go deleted file mode 100644 index 9fc43a9da..000000000 --- a/build/platformclientv2/timeinterval.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Timeinterval -type Timeinterval struct { - // Months - Months *int `json:"months,omitempty"` - - - // Weeks - Weeks *int `json:"weeks,omitempty"` - - - // Days - Days *int `json:"days,omitempty"` - - - // Hours - Hours *int `json:"hours,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Timeinterval) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/timeoffrequest.go b/build/platformclientv2/timeoffrequest.go deleted file mode 100644 index 908692672..000000000 --- a/build/platformclientv2/timeoffrequest.go +++ /dev/null @@ -1,78 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Timeoffrequest -type Timeoffrequest struct { - // Id - The id of the time off request - Id *string `json:"id,omitempty"` - - - // User - The user that the time off request belongs to - User *Userreference `json:"user,omitempty"` - - - // IsFullDayRequest - Whether this is a full day request (false means partial day) - IsFullDayRequest *bool `json:"isFullDayRequest,omitempty"` - - - // MarkedAsRead - Whether this request has been marked as read by the agent - MarkedAsRead *bool `json:"markedAsRead,omitempty"` - - - // ActivityCodeId - The ID of the activity code associated with this time off request. Activity code must be of the TimeOff category - ActivityCodeId *string `json:"activityCodeId,omitempty"` - - - // Status - The status of this time off request - Status *string `json:"status,omitempty"` - - - // PartialDayStartDateTimes - A set of start date-times in ISO-8601 format for partial day requests. Will be not empty if isFullDayRequest == false - PartialDayStartDateTimes *[]time.Time `json:"partialDayStartDateTimes,omitempty"` - - - // FullDayManagementUnitDates - A set of dates in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone. Will be not empty if isFullDayRequest == true - FullDayManagementUnitDates *[]string `json:"fullDayManagementUnitDates,omitempty"` - - - // DailyDurationMinutes - The daily duration of this time off request in minutes - DailyDurationMinutes *int `json:"dailyDurationMinutes,omitempty"` - - - // Notes - Notes about the time off request - Notes *string `json:"notes,omitempty"` - - - // SubmittedBy - The user who submitted this time off request - SubmittedBy *Userreference `json:"submittedBy,omitempty"` - - - // SubmittedDate - The timestamp when this request was submitted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - SubmittedDate *time.Time `json:"submittedDate,omitempty"` - - - // ReviewedBy - The user who reviewed this time off request - ReviewedBy *Userreference `json:"reviewedBy,omitempty"` - - - // ReviewedDate - The timestamp when this request was reviewed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ReviewedDate *time.Time `json:"reviewedDate,omitempty"` - - - // Metadata - The version metadata of the time off request - Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Timeoffrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/timeoffrequestlist.go b/build/platformclientv2/timeoffrequestlist.go deleted file mode 100644 index 55dd39dbb..000000000 --- a/build/platformclientv2/timeoffrequestlist.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Timeoffrequestlist -type Timeoffrequestlist struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // TimeOffRequests - TimeOffRequests *[]Timeoffrequestresponse `json:"timeOffRequests,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Timeoffrequestlist) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/timeoffrequestlisting.go b/build/platformclientv2/timeoffrequestlisting.go deleted file mode 100644 index 3edb0be88..000000000 --- a/build/platformclientv2/timeoffrequestlisting.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Timeoffrequestlisting -type Timeoffrequestlisting struct { - // Entities - List of time off request look up objects - Entities *[]Timeoffrequest `json:"entities,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Timeoffrequestlisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/timeoffrequestnotification.go b/build/platformclientv2/timeoffrequestnotification.go deleted file mode 100644 index 5b55bda22..000000000 --- a/build/platformclientv2/timeoffrequestnotification.go +++ /dev/null @@ -1,38 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Timeoffrequestnotification -type Timeoffrequestnotification struct { - // TimeOffRequestId - The ID of this time off request - TimeOffRequestId *string `json:"timeOffRequestId,omitempty"` - - - // User - The user associated with this time off request - User *Userreference `json:"user,omitempty"` - - - // IsFullDayRequest - Whether this is a full day request (false means partial day) - IsFullDayRequest *bool `json:"isFullDayRequest,omitempty"` - - - // Status - The status of this time off request - Status *string `json:"status,omitempty"` - - - // PartialDayStartDateTimes - A set of start date-times in ISO-8601 format for partial day requests. Will be not empty if isFullDayRequest == false - PartialDayStartDateTimes *[]time.Time `json:"partialDayStartDateTimes,omitempty"` - - - // FullDayManagementUnitDates - A set of dates in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone. Will be not empty if isFullDayRequest == true - FullDayManagementUnitDates *[]string `json:"fullDayManagementUnitDates,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Timeoffrequestnotification) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/timeoffrequestquerybody.go b/build/platformclientv2/timeoffrequestquerybody.go deleted file mode 100644 index 35435c950..000000000 --- a/build/platformclientv2/timeoffrequestquerybody.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Timeoffrequestquerybody -type Timeoffrequestquerybody struct { - // UserIds - The set of user ids to filter time off requests - UserIds *[]string `json:"userIds,omitempty"` - - - // Statuses - The set of statuses to filter time off requests - Statuses *[]string `json:"statuses,omitempty"` - - - // DateRange - The inclusive range of dates to filter time off requests - DateRange *Daterange `json:"dateRange,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Timeoffrequestquerybody) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/timeoffrequestresponse.go b/build/platformclientv2/timeoffrequestresponse.go deleted file mode 100644 index bc66c18bc..000000000 --- a/build/platformclientv2/timeoffrequestresponse.go +++ /dev/null @@ -1,86 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Timeoffrequestresponse -type Timeoffrequestresponse struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // User - The user associated with this time off request - User *Userreference `json:"user,omitempty"` - - - // IsFullDayRequest - Whether this is a full day request (false means partial day) - IsFullDayRequest *bool `json:"isFullDayRequest,omitempty"` - - - // MarkedAsRead - Whether this request has been marked as read by the agent - MarkedAsRead *bool `json:"markedAsRead,omitempty"` - - - // ActivityCodeId - The ID of the activity code associated with this time off request. Activity code must be of the TimeOff category - ActivityCodeId *string `json:"activityCodeId,omitempty"` - - - // Status - The status of this time off request - Status *string `json:"status,omitempty"` - - - // PartialDayStartDateTimes - A set of start date-times in ISO-8601 format for partial day requests. Will be not empty if isFullDayRequest == false - PartialDayStartDateTimes *[]time.Time `json:"partialDayStartDateTimes,omitempty"` - - - // FullDayManagementUnitDates - A set of dates in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone. Will be not empty if isFullDayRequest == true - FullDayManagementUnitDates *[]string `json:"fullDayManagementUnitDates,omitempty"` - - - // DailyDurationMinutes - The daily duration of this time off request in minutes - DailyDurationMinutes *int `json:"dailyDurationMinutes,omitempty"` - - - // Notes - Notes about the time off request - Notes *string `json:"notes,omitempty"` - - - // SubmittedBy - The user who submitted this time off request - SubmittedBy *Userreference `json:"submittedBy,omitempty"` - - - // SubmittedDate - The timestamp when this request was submitted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - SubmittedDate *time.Time `json:"submittedDate,omitempty"` - - - // ReviewedBy - The user who reviewed this time off request - ReviewedBy *Userreference `json:"reviewedBy,omitempty"` - - - // ReviewedDate - The timestamp when this request was reviewed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ReviewedDate *time.Time `json:"reviewedDate,omitempty"` - - - // ModifiedBy - The user who last modified this TimeOffRequestResponse - ModifiedBy *Userreference `json:"modifiedBy,omitempty"` - - - // ModifiedDate - The timestamp when this request was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ModifiedDate *time.Time `json:"modifiedDate,omitempty"` - - - // Metadata - The version metadata of the time off request - Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Timeoffrequestresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/timeoffrequestsettings.go b/build/platformclientv2/timeoffrequestsettings.go deleted file mode 100644 index 965777e7a..000000000 --- a/build/platformclientv2/timeoffrequestsettings.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Timeoffrequestsettings - Time Off Request Settings -type Timeoffrequestsettings struct { - // SubmissionRangeEnforced - Whether to enforce a submission range for agent time off requests - SubmissionRangeEnforced *bool `json:"submissionRangeEnforced,omitempty"` - - - // SubmissionEarliestDaysFromNow - The earliest number of days from now for which an agent can submit a time off request. Use negative numbers to indicate days in the past - SubmissionEarliestDaysFromNow *int `json:"submissionEarliestDaysFromNow,omitempty"` - - - // SubmissionLatestDaysFromNow - The latest number of days from now for which an agent can submit a time off request - SubmissionLatestDaysFromNow *int `json:"submissionLatestDaysFromNow,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Timeoffrequestsettings) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/timeslot.go b/build/platformclientv2/timeslot.go deleted file mode 100644 index b9654b4fc..000000000 --- a/build/platformclientv2/timeslot.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Timeslot -type Timeslot struct { - // StartTime - start time in xx:xx:xx.xxx format - StartTime *string `json:"startTime,omitempty"` - - - // StopTime - stop time in xx:xx:xx.xxx format - StopTime *string `json:"stopTime,omitempty"` - - - // Day - Day for this time slot, Monday = 1 ... Sunday = 7 - Day *int `json:"day,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Timeslot) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/timezoneentitylisting.go b/build/platformclientv2/timezoneentitylisting.go deleted file mode 100644 index dc8b794e7..000000000 --- a/build/platformclientv2/timezoneentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Timezoneentitylisting -type Timezoneentitylisting struct { - // Entities - Entities *[]Regiontimezone `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Timezoneentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/timezonemappingpreview.go b/build/platformclientv2/timezonemappingpreview.go deleted file mode 100644 index bda52a8ec..000000000 --- a/build/platformclientv2/timezonemappingpreview.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Timezonemappingpreview -type Timezonemappingpreview struct { - // ContactList - The associated ContactList - ContactList *Domainentityref `json:"contactList,omitempty"` - - - // ContactsPerTimeZone - The number of contacts per time zone that mapped to only that time zone - ContactsPerTimeZone *map[string]int `json:"contactsPerTimeZone,omitempty"` - - - // ContactsMappedUsingZipCode - The number of contacts per time zone that mapped to only that time zone and were mapped using the zip code column - ContactsMappedUsingZipCode *map[string]int `json:"contactsMappedUsingZipCode,omitempty"` - - - // ContactsMappedToASingleZone - The total number of contacts that mapped to a single time zone - ContactsMappedToASingleZone *int `json:"contactsMappedToASingleZone,omitempty"` - - - // ContactsMappedToASingleZoneUsingZipCode - The total number of contacts that mapped to a single time zone and were mapped using the zip code column - ContactsMappedToASingleZoneUsingZipCode *int `json:"contactsMappedToASingleZoneUsingZipCode,omitempty"` - - - // ContactsMappedToMultipleZones - The total number of contacts that mapped to multiple time zones - ContactsMappedToMultipleZones *int `json:"contactsMappedToMultipleZones,omitempty"` - - - // ContactsMappedToMultipleZonesUsingZipCode - The total number of contacts that mapped to multiple time zones and were mapped using the zip code column - ContactsMappedToMultipleZonesUsingZipCode *int `json:"contactsMappedToMultipleZonesUsingZipCode,omitempty"` - - - // ContactsInDefaultWindow - The total number of contacts that will be dialed during the default window - ContactsInDefaultWindow *int `json:"contactsInDefaultWindow,omitempty"` - - - // ContactListSize - The total number of contacts in the contact list - ContactListSize *int `json:"contactListSize,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Timezonemappingpreview) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/tokeninfo.go b/build/platformclientv2/tokeninfo.go deleted file mode 100644 index 04ced1791..000000000 --- a/build/platformclientv2/tokeninfo.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Tokeninfo -type Tokeninfo struct { - // Organization - The current organization - Organization *Namedentity `json:"organization,omitempty"` - - - // HomeOrganization - The token's home organization - HomeOrganization *Namedentity `json:"homeOrganization,omitempty"` - - - // AuthorizedScope - The list of scopes authorized for the OAuth client - AuthorizedScope *[]string `json:"authorizedScope,omitempty"` - - - // ClonedUser - Only present when a user is a clone of trustee user in the trustor org. - ClonedUser *Tokeninfocloneduser `json:"clonedUser,omitempty"` - - - // OAuthClient - OAuthClient *Orgoauthclient `json:"OAuthClient,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Tokeninfo) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/tokeninfocloneduser.go b/build/platformclientv2/tokeninfocloneduser.go deleted file mode 100644 index 673665b01..000000000 --- a/build/platformclientv2/tokeninfocloneduser.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Tokeninfocloneduser -type Tokeninfocloneduser struct { - // Id - User id of the original native user - Id *string `json:"id,omitempty"` - - - // Organization - Organization of the original native user - Organization *Entity `json:"organization,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Tokeninfocloneduser) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/tokensapi.go b/build/platformclientv2/tokensapi.go deleted file mode 100644 index 98a20aa22..000000000 --- a/build/platformclientv2/tokensapi.go +++ /dev/null @@ -1,221 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "encoding/json" -) - -// TokensApi provides functions for API endpoints -type TokensApi struct { - Configuration *Configuration -} - -// NewTokensApi creates an API instance using the default configuration -func NewTokensApi() *TokensApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating TokensApi with base path: %s", strings.ToLower(config.BasePath))) - return &TokensApi{ - Configuration: config, - } -} - -// NewTokensApiWithConfig creates an API instance using the provided configuration -func NewTokensApiWithConfig(config *Configuration) *TokensApi { - config.Debugf("Creating TokensApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &TokensApi{ - Configuration: config, - } -} - -// DeleteToken invokes DELETE /api/v2/tokens/{userId} -// -// Delete all auth tokens for the specified user. -// -// -func (a TokensApi) DeleteToken(userId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/tokens/{userId}" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return nil, errors.New("Missing required parameter 'userId' when calling TokensApi->DeleteToken") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteTokensMe invokes DELETE /api/v2/tokens/me -// -// Delete auth token used to make the request. -// -// -func (a TokensApi) DeleteTokensMe() (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/tokens/me" - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// GetTokensMe invokes GET /api/v2/tokens/me -// -// Fetch information about the current token -// -// -func (a TokensApi) GetTokensMe() (*Tokeninfo, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/tokens/me" - defaultReturn := new(Tokeninfo) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Tokeninfo - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/traininglisting.go b/build/platformclientv2/traininglisting.go deleted file mode 100644 index 9c6262761..000000000 --- a/build/platformclientv2/traininglisting.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Traininglisting -type Traininglisting struct { - // Entities - Entities *[]Knowledgetraining `json:"entities,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Traininglisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/transcriptaggregatedatacontainer.go b/build/platformclientv2/transcriptaggregatedatacontainer.go deleted file mode 100644 index eb986b123..000000000 --- a/build/platformclientv2/transcriptaggregatedatacontainer.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Transcriptaggregatedatacontainer -type Transcriptaggregatedatacontainer struct { - // Group - A mapping from dimension to value - Group *map[string]string `json:"group,omitempty"` - - - // Data - Data *[]Statisticalresponse `json:"data,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Transcriptaggregatedatacontainer) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/transcriptaggregatequeryclause.go b/build/platformclientv2/transcriptaggregatequeryclause.go deleted file mode 100644 index 5e6976292..000000000 --- a/build/platformclientv2/transcriptaggregatequeryclause.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Transcriptaggregatequeryclause -type Transcriptaggregatequeryclause struct { - // VarType - Boolean operation to apply to the provided predicates - VarType *string `json:"type,omitempty"` - - - // Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value). - Predicates *[]Transcriptaggregatequerypredicate `json:"predicates,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Transcriptaggregatequeryclause) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/transcriptaggregatequeryfilter.go b/build/platformclientv2/transcriptaggregatequeryfilter.go deleted file mode 100644 index a0b590213..000000000 --- a/build/platformclientv2/transcriptaggregatequeryfilter.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Transcriptaggregatequeryfilter -type Transcriptaggregatequeryfilter struct { - // VarType - Boolean operation to apply to the provided predicates and clauses - VarType *string `json:"type,omitempty"` - - - // Clauses - Boolean 'and/or' logic with up to two-levels of nesting - Clauses *[]Transcriptaggregatequeryclause `json:"clauses,omitempty"` - - - // Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value). - Predicates *[]Transcriptaggregatequerypredicate `json:"predicates,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Transcriptaggregatequeryfilter) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/transcriptaggregatequerypredicate.go b/build/platformclientv2/transcriptaggregatequerypredicate.go deleted file mode 100644 index 6a6bf507b..000000000 --- a/build/platformclientv2/transcriptaggregatequerypredicate.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Transcriptaggregatequerypredicate -type Transcriptaggregatequerypredicate struct { - // VarType - Optional type, can usually be inferred - VarType *string `json:"type,omitempty"` - - - // Dimension - Left hand side for dimension predicates - Dimension *string `json:"dimension,omitempty"` - - - // Operator - Optional operator, default is matches - Operator *string `json:"operator,omitempty"` - - - // Value - Right hand side for dimension predicates - Value *string `json:"value,omitempty"` - - - // VarRange - Right hand side for dimension predicates - VarRange *Numericrange `json:"range,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Transcriptaggregatequerypredicate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/transcriptaggregatequeryresponse.go b/build/platformclientv2/transcriptaggregatequeryresponse.go deleted file mode 100644 index 01bbdeece..000000000 --- a/build/platformclientv2/transcriptaggregatequeryresponse.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Transcriptaggregatequeryresponse -type Transcriptaggregatequeryresponse struct { - // Results - Results *[]Transcriptaggregatedatacontainer `json:"results,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Transcriptaggregatequeryresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/transcriptaggregationquery.go b/build/platformclientv2/transcriptaggregationquery.go deleted file mode 100644 index dc561c937..000000000 --- a/build/platformclientv2/transcriptaggregationquery.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Transcriptaggregationquery -type Transcriptaggregationquery struct { - // Interval - Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss - Interval *string `json:"interval,omitempty"` - - - // Granularity - Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H - Granularity *string `json:"granularity,omitempty"` - - - // TimeZone - Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London - TimeZone *string `json:"timeZone,omitempty"` - - - // GroupBy - Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group. - GroupBy *[]string `json:"groupBy,omitempty"` - - - // Filter - Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters - Filter *Transcriptaggregatequeryfilter `json:"filter,omitempty"` - - - // Metrics - Behaves like a SQL SELECT clause. Only named metrics will be retrieved. - Metrics *[]string `json:"metrics,omitempty"` - - - // FlattenMultivaluedDimensions - Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c') - FlattenMultivaluedDimensions *bool `json:"flattenMultivaluedDimensions,omitempty"` - - - // Views - Custom derived metric views - Views *[]Transcriptaggregationview `json:"views,omitempty"` - - - // AlternateTimeDimension - Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event. - AlternateTimeDimension *string `json:"alternateTimeDimension,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Transcriptaggregationquery) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/transcriptaggregationview.go b/build/platformclientv2/transcriptaggregationview.go deleted file mode 100644 index 5abfd73ca..000000000 --- a/build/platformclientv2/transcriptaggregationview.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Transcriptaggregationview -type Transcriptaggregationview struct { - // Target - Target metric name - Target *string `json:"target,omitempty"` - - - // Name - A unique name for this view. Must be distinct from other views and built-in metric names. - Name *string `json:"name,omitempty"` - - - // Function - Type of view you wish to create - Function *string `json:"function,omitempty"` - - - // VarRange - Range of numbers for slicing up data - VarRange *Aggregationrange `json:"range,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Transcriptaggregationview) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/transcriptconversationdetailsearchcriteria.go b/build/platformclientv2/transcriptconversationdetailsearchcriteria.go deleted file mode 100644 index 0b6c6b679..000000000 --- a/build/platformclientv2/transcriptconversationdetailsearchcriteria.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Transcriptconversationdetailsearchcriteria -type Transcriptconversationdetailsearchcriteria struct { - // EndValue - The end value of the range. This field is used for range search types. - EndValue *string `json:"endValue,omitempty"` - - - // Values - A list of values for the search to match against - Values *[]string `json:"values,omitempty"` - - - // StartValue - The start value of the range. This field is used for range search types. - StartValue *string `json:"startValue,omitempty"` - - - // Fields - Field names to search against - Fields *[]string `json:"fields,omitempty"` - - - // Value - A value for the search to match against - Value *string `json:"value,omitempty"` - - - // Operator - How to apply this search criteria against other criteria - Operator *string `json:"operator,omitempty"` - - - // Group - Groups multiple conditions - Group *[]Transcriptconversationdetailsearchcriteria `json:"group,omitempty"` - - - // DateFormat - Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX. - DateFormat *string `json:"dateFormat,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Transcriptconversationdetailsearchcriteria) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/transcriptconversationdetailsearchrequest.go b/build/platformclientv2/transcriptconversationdetailsearchrequest.go deleted file mode 100644 index 0fa7f516e..000000000 --- a/build/platformclientv2/transcriptconversationdetailsearchrequest.go +++ /dev/null @@ -1,41 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Transcriptconversationdetailsearchrequest -type Transcriptconversationdetailsearchrequest struct { - // SortOrder - The sort order for results - SortOrder *string `json:"sortOrder,omitempty"` - - - // SortBy - The field in the resource that you want to sort the results by - SortBy *string `json:"sortBy,omitempty"` - - - // PageSize - The number of results per page - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - The page of resources you want to retrieve - PageNumber *int `json:"pageNumber,omitempty"` - - - // Sort - Multi-value sort order, list of multiple sort values - Sort *[]Searchsort `json:"sort,omitempty"` - - - // Types - Resource domain type to search - Types *[]string `json:"types,omitempty"` - - - // Query - The search criteria - Query *[]Transcriptconversationdetailsearchcriteria `json:"query,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Transcriptconversationdetailsearchrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/transcriptionsettings.go b/build/platformclientv2/transcriptionsettings.go deleted file mode 100644 index 7ee206b26..000000000 --- a/build/platformclientv2/transcriptionsettings.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Transcriptionsettings -type Transcriptionsettings struct { - // Transcription - Setting to enable/disable transcription capability - Transcription *string `json:"transcription,omitempty"` - - - // TranscriptionConfidenceThreshold - Configure confidence threshold. The possible values are from 1 to 100. - TranscriptionConfidenceThreshold *int `json:"transcriptionConfidenceThreshold,omitempty"` - - - // ContentSearchEnabled - Setting to enable/disable content search - ContentSearchEnabled *bool `json:"contentSearchEnabled,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Transcriptionsettings) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/transcripts.go b/build/platformclientv2/transcripts.go deleted file mode 100644 index 3e50a8570..000000000 --- a/build/platformclientv2/transcripts.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Transcripts -type Transcripts struct { - // ExactMatch - List of transcript contents which needs to satisfy exact match criteria - ExactMatch *[]string `json:"exactMatch,omitempty"` - - - // Contains - List of transcript contents which needs to satisfy contains criteria - Contains *[]string `json:"contains,omitempty"` - - - // DoesNotContain - List of transcript contents which needs to satisfy does not contain criteria - DoesNotContain *[]string `json:"doesNotContain,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Transcripts) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/transcriptsearchcriteria.go b/build/platformclientv2/transcriptsearchcriteria.go deleted file mode 100644 index f945bab81..000000000 --- a/build/platformclientv2/transcriptsearchcriteria.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Transcriptsearchcriteria -type Transcriptsearchcriteria struct { - // EndValue - The end value of the range. This field is used for range search types. - EndValue *string `json:"endValue,omitempty"` - - - // Values - A list of values for the search to match against - Values *[]string `json:"values,omitempty"` - - - // StartValue - The start value of the range. This field is used for range search types. - StartValue *string `json:"startValue,omitempty"` - - - // Fields - Field names to search against - Fields *[]string `json:"fields,omitempty"` - - - // Value - A value for the search to match against - Value *string `json:"value,omitempty"` - - - // Operator - How to apply this search criteria against other criteria - Operator *string `json:"operator,omitempty"` - - - // Group - Groups multiple conditions - Group *[]Transcriptsearchcriteria `json:"group,omitempty"` - - - // DateFormat - Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX. - DateFormat *string `json:"dateFormat,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Transcriptsearchcriteria) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/transcriptsearchrequest.go b/build/platformclientv2/transcriptsearchrequest.go deleted file mode 100644 index dce7db2d2..000000000 --- a/build/platformclientv2/transcriptsearchrequest.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Transcriptsearchrequest -type Transcriptsearchrequest struct { - // SortOrder - The sort order for results - SortOrder *string `json:"sortOrder,omitempty"` - - - // SortBy - The field in the resource that you want to sort the results by - SortBy *string `json:"sortBy,omitempty"` - - - // PageSize - The number of results per page - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - The page of resources you want to retrieve - PageNumber *int `json:"pageNumber,omitempty"` - - - // Sort - Multi-value sort order, list of multiple sort values - Sort *[]Searchsort `json:"sort,omitempty"` - - - // ReturnFields - ReturnFields *[]string `json:"returnFields,omitempty"` - - - // Types - Resource domain type to search - Types *[]string `json:"types,omitempty"` - - - // Query - The search criteria - Query *[]Transcriptsearchcriteria `json:"query,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Transcriptsearchrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/transcripturl.go b/build/platformclientv2/transcripturl.go deleted file mode 100644 index 2cd3ea0ab..000000000 --- a/build/platformclientv2/transcripturl.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Transcripturl -type Transcripturl struct { - // Url - The pre-signed S3 URL of the transcript - Url *string `json:"url,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Transcripturl) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/transferrequest.go b/build/platformclientv2/transferrequest.go deleted file mode 100644 index 883b28c69..000000000 --- a/build/platformclientv2/transferrequest.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Transferrequest -type Transferrequest struct { - // UserId - The user ID of the transfer target. - UserId *string `json:"userId,omitempty"` - - - // Address - The phone number or address of the transfer target. - Address *string `json:"address,omitempty"` - - - // UserName - The user name of the transfer target. - UserName *string `json:"userName,omitempty"` - - - // QueueId - The queue ID of the transfer target. - QueueId *string `json:"queueId,omitempty"` - - - // Voicemail - If true, transfer to the voicemail inbox of the participant that is being replaced. - Voicemail *bool `json:"voicemail,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Transferrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/trunk.go b/build/platformclientv2/trunk.go deleted file mode 100644 index 2beecfb6c..000000000 --- a/build/platformclientv2/trunk.go +++ /dev/null @@ -1,126 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Trunk -type Trunk struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the entity. - Name *string `json:"name,omitempty"` - - - // Description - The resource's description. - Description *string `json:"description,omitempty"` - - - // Version - The current version of the resource. - Version *int `json:"version,omitempty"` - - - // DateCreated - The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // ModifiedBy - The ID of the user that last modified the resource. - ModifiedBy *string `json:"modifiedBy,omitempty"` - - - // CreatedBy - The ID of the user that created the resource. - CreatedBy *string `json:"createdBy,omitempty"` - - - // State - Indicates if the resource is active, inactive, or deleted. - State *string `json:"state,omitempty"` - - - // ModifiedByApp - The application that last modified the resource. - ModifiedByApp *string `json:"modifiedByApp,omitempty"` - - - // CreatedByApp - The application that created the resource. - CreatedByApp *string `json:"createdByApp,omitempty"` - - - // TrunkType - The type of this trunk. - TrunkType *string `json:"trunkType,omitempty"` - - - // Edge - The Edge using this trunk. - Edge *Domainentityref `json:"edge,omitempty"` - - - // TrunkBase - The trunk base configuration used on this trunk. - TrunkBase *Domainentityref `json:"trunkBase,omitempty"` - - - // TrunkMetabase - The metabase used to create this trunk. - TrunkMetabase *Domainentityref `json:"trunkMetabase,omitempty"` - - - // EdgeGroup - The edge group associated with this trunk. - EdgeGroup *Domainentityref `json:"edgeGroup,omitempty"` - - - // InService - True if this trunk is in-service. This comes from the trunk_enabled property of the referenced trunk base. - InService *bool `json:"inService,omitempty"` - - - // Enabled - True if the Edge used by this trunk is in-service - Enabled *bool `json:"enabled,omitempty"` - - - // LogicalInterface - The Logical Interface on the Edge to which the trunk is assigned. - LogicalInterface *Domainentityref `json:"logicalInterface,omitempty"` - - - // ConnectedStatus - The connected status of the trunk - ConnectedStatus *Trunkconnectedstatus `json:"connectedStatus,omitempty"` - - - // OptionsStatus - The trunk optionsStatus - OptionsStatus *[]Trunkmetricsoptions `json:"optionsStatus,omitempty"` - - - // RegistersStatus - The trunk registersStatus - RegistersStatus *[]Trunkmetricsregisters `json:"registersStatus,omitempty"` - - - // IpStatus - The trunk ipStatus - IpStatus *Trunkmetricsnetworktypeip `json:"ipStatus,omitempty"` - - - // OptionsEnabledStatus - Returns Enabled when the trunk base supports the availability interval and it has a value greater than 0. - OptionsEnabledStatus *string `json:"optionsEnabledStatus,omitempty"` - - - // RegistersEnabledStatus - Returns Enabled when the trunk base supports the registration interval and it has a value greater than 0. - RegistersEnabledStatus *string `json:"registersEnabledStatus,omitempty"` - - - // Family - The IP Network Family of the trunk - Family *int `json:"family,omitempty"` - - - // ProxyAddressList - The list of proxy addresses (ports if provided) for the trunk - ProxyAddressList *[]string `json:"proxyAddressList,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Trunk) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/trunkbase.go b/build/platformclientv2/trunkbase.go deleted file mode 100644 index 325ca635e..000000000 --- a/build/platformclientv2/trunkbase.go +++ /dev/null @@ -1,78 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Trunkbase -type Trunkbase struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the entity. - Name *string `json:"name,omitempty"` - - - // Description - The resource's description. - Description *string `json:"description,omitempty"` - - - // Version - The current version of the resource. - Version *int `json:"version,omitempty"` - - - // DateCreated - The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // ModifiedBy - The ID of the user that last modified the resource. - ModifiedBy *string `json:"modifiedBy,omitempty"` - - - // CreatedBy - The ID of the user that created the resource. - CreatedBy *string `json:"createdBy,omitempty"` - - - // State - Indicates if the resource is active, inactive, or deleted. - State *string `json:"state,omitempty"` - - - // ModifiedByApp - The application that last modified the resource. - ModifiedByApp *string `json:"modifiedByApp,omitempty"` - - - // CreatedByApp - The application that created the resource. - CreatedByApp *string `json:"createdByApp,omitempty"` - - - // TrunkMetabase - The meta-base this trunk is based on. - TrunkMetabase *Domainentityref `json:"trunkMetabase,omitempty"` - - - // Properties - Properties *map[string]interface{} `json:"properties,omitempty"` - - - // TrunkType - The type of this trunk base. - TrunkType *string `json:"trunkType,omitempty"` - - - // Managed - Is this trunk being managed remotely. This property is synchronized with the managed property of the Edge Group to which it is assigned. - Managed *bool `json:"managed,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Trunkbase) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/trunkbaseassignment.go b/build/platformclientv2/trunkbaseassignment.go deleted file mode 100644 index c3f9654e7..000000000 --- a/build/platformclientv2/trunkbaseassignment.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Trunkbaseassignment -type Trunkbaseassignment struct { - // Family - The address family to use with the trunk base settings. 2=IPv4, 23=IPv6 - Family *int `json:"family,omitempty"` - - - // TrunkBase - A trunk base settings reference. - TrunkBase *Trunkbase `json:"trunkBase,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Trunkbaseassignment) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/trunkbaseentitylisting.go b/build/platformclientv2/trunkbaseentitylisting.go deleted file mode 100644 index 6e3971f40..000000000 --- a/build/platformclientv2/trunkbaseentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Trunkbaseentitylisting -type Trunkbaseentitylisting struct { - // Entities - Entities *[]Trunkbase `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Trunkbaseentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/trunkconnectedstatus.go b/build/platformclientv2/trunkconnectedstatus.go deleted file mode 100644 index 545d45c9b..000000000 --- a/build/platformclientv2/trunkconnectedstatus.go +++ /dev/null @@ -1,22 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Trunkconnectedstatus -type Trunkconnectedstatus struct { - // Connected - Connected *bool `json:"connected,omitempty"` - - - // ConnectedStateTime - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ConnectedStateTime *time.Time `json:"connectedStateTime,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Trunkconnectedstatus) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/trunkentitylisting.go b/build/platformclientv2/trunkentitylisting.go deleted file mode 100644 index ba3674166..000000000 --- a/build/platformclientv2/trunkentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Trunkentitylisting -type Trunkentitylisting struct { - // Entities - Entities *[]Trunk `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Trunkentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/trunkerrorinfo.go b/build/platformclientv2/trunkerrorinfo.go deleted file mode 100644 index 93015be74..000000000 --- a/build/platformclientv2/trunkerrorinfo.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Trunkerrorinfo -type Trunkerrorinfo struct { - // Text - Text *string `json:"text,omitempty"` - - - // Code - Code *string `json:"code,omitempty"` - - - // Details - Details *Trunkerrorinfodetails `json:"details,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Trunkerrorinfo) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/trunkerrorinfodetails.go b/build/platformclientv2/trunkerrorinfodetails.go deleted file mode 100644 index 88866e94d..000000000 --- a/build/platformclientv2/trunkerrorinfodetails.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Trunkerrorinfodetails -type Trunkerrorinfodetails struct { - // Code - Code *string `json:"code,omitempty"` - - - // Message - Message *string `json:"message,omitempty"` - - - // Hostname - Hostname *string `json:"hostname,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Trunkerrorinfodetails) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/trunkinstancetopictrunk.go b/build/platformclientv2/trunkinstancetopictrunk.go deleted file mode 100644 index b34bcf44c..000000000 --- a/build/platformclientv2/trunkinstancetopictrunk.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Trunkinstancetopictrunk -type Trunkinstancetopictrunk struct { - // Id - Id *string `json:"id,omitempty"` - - - // ConnectedStatus - ConnectedStatus *Trunkinstancetopictrunkconnectedstatus `json:"connectedStatus,omitempty"` - - - // OptionsStatus - OptionsStatus *[]Trunkinstancetopictrunkmetricsoptions `json:"optionsStatus,omitempty"` - - - // RegistersStatus - RegistersStatus *[]Trunkinstancetopictrunkmetricsregisters `json:"registersStatus,omitempty"` - - - // IpStatus - IpStatus *Trunkinstancetopictrunkmetricsnetworktypeip `json:"ipStatus,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Trunkinstancetopictrunk) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/trunkinstancetopictrunkconnectedstatus.go b/build/platformclientv2/trunkinstancetopictrunkconnectedstatus.go deleted file mode 100644 index d151f42f7..000000000 --- a/build/platformclientv2/trunkinstancetopictrunkconnectedstatus.go +++ /dev/null @@ -1,22 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Trunkinstancetopictrunkconnectedstatus -type Trunkinstancetopictrunkconnectedstatus struct { - // Connected - Connected *bool `json:"connected,omitempty"` - - - // ConnectedStateTime - ConnectedStateTime *time.Time `json:"connectedStateTime,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Trunkinstancetopictrunkconnectedstatus) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/trunkinstancetopictrunkerrorinfo.go b/build/platformclientv2/trunkinstancetopictrunkerrorinfo.go deleted file mode 100644 index fa24eaa23..000000000 --- a/build/platformclientv2/trunkinstancetopictrunkerrorinfo.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Trunkinstancetopictrunkerrorinfo -type Trunkinstancetopictrunkerrorinfo struct { - // Text - Text *string `json:"text,omitempty"` - - - // Code - Code *string `json:"code,omitempty"` - - - // Details - Details *Trunkinstancetopictrunkerrorinfodetails `json:"details,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Trunkinstancetopictrunkerrorinfo) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/trunkinstancetopictrunkerrorinfodetails.go b/build/platformclientv2/trunkinstancetopictrunkerrorinfodetails.go deleted file mode 100644 index 1ba817f07..000000000 --- a/build/platformclientv2/trunkinstancetopictrunkerrorinfodetails.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Trunkinstancetopictrunkerrorinfodetails -type Trunkinstancetopictrunkerrorinfodetails struct { - // Code - Code *string `json:"code,omitempty"` - - - // Message - Message *string `json:"message,omitempty"` - - - // Hostname - Hostname *string `json:"hostname,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Trunkinstancetopictrunkerrorinfodetails) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/trunkinstancetopictrunkmetricsnetworktypeip.go b/build/platformclientv2/trunkinstancetopictrunkmetricsnetworktypeip.go deleted file mode 100644 index f156b2b8c..000000000 --- a/build/platformclientv2/trunkinstancetopictrunkmetricsnetworktypeip.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Trunkinstancetopictrunkmetricsnetworktypeip -type Trunkinstancetopictrunkmetricsnetworktypeip struct { - // Address - Address *string `json:"address,omitempty"` - - - // ErrorInfo - ErrorInfo *Trunkinstancetopictrunkerrorinfo `json:"errorInfo,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Trunkinstancetopictrunkmetricsnetworktypeip) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/trunkinstancetopictrunkmetricsoptions.go b/build/platformclientv2/trunkinstancetopictrunkmetricsoptions.go deleted file mode 100644 index fcac26eff..000000000 --- a/build/platformclientv2/trunkinstancetopictrunkmetricsoptions.go +++ /dev/null @@ -1,30 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Trunkinstancetopictrunkmetricsoptions -type Trunkinstancetopictrunkmetricsoptions struct { - // ProxyAddress - ProxyAddress *string `json:"proxyAddress,omitempty"` - - - // OptionState - OptionState *bool `json:"optionState,omitempty"` - - - // OptionStateTime - OptionStateTime *time.Time `json:"optionStateTime,omitempty"` - - - // ErrorInfo - ErrorInfo *Trunkinstancetopictrunkerrorinfo `json:"errorInfo,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Trunkinstancetopictrunkmetricsoptions) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/trunkinstancetopictrunkmetricsregisters.go b/build/platformclientv2/trunkinstancetopictrunkmetricsregisters.go deleted file mode 100644 index 16c25f268..000000000 --- a/build/platformclientv2/trunkinstancetopictrunkmetricsregisters.go +++ /dev/null @@ -1,30 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Trunkinstancetopictrunkmetricsregisters -type Trunkinstancetopictrunkmetricsregisters struct { - // ProxyAddress - ProxyAddress *string `json:"proxyAddress,omitempty"` - - - // RegisterState - RegisterState *bool `json:"registerState,omitempty"` - - - // RegisterStateTime - RegisterStateTime *time.Time `json:"registerStateTime,omitempty"` - - - // ErrorInfo - ErrorInfo *Trunkinstancetopictrunkerrorinfo `json:"errorInfo,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Trunkinstancetopictrunkmetricsregisters) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/trunkmetabaseentitylisting.go b/build/platformclientv2/trunkmetabaseentitylisting.go deleted file mode 100644 index 2ad6eb46d..000000000 --- a/build/platformclientv2/trunkmetabaseentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Trunkmetabaseentitylisting -type Trunkmetabaseentitylisting struct { - // Entities - Entities *[]Metabase `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Trunkmetabaseentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/trunkmetrics.go b/build/platformclientv2/trunkmetrics.go deleted file mode 100644 index 747c0db23..000000000 --- a/build/platformclientv2/trunkmetrics.go +++ /dev/null @@ -1,34 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Trunkmetrics -type Trunkmetrics struct { - // EventTime - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - EventTime *time.Time `json:"eventTime,omitempty"` - - - // LogicalInterface - LogicalInterface *Domainentityref `json:"logicalInterface,omitempty"` - - - // Trunk - Trunk *Domainentityref `json:"trunk,omitempty"` - - - // Calls - Calls *Trunkmetricscalls `json:"calls,omitempty"` - - - // Qos - Qos *Trunkmetricsqos `json:"qos,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Trunkmetrics) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/trunkmetricscalls.go b/build/platformclientv2/trunkmetricscalls.go deleted file mode 100644 index 87db6923b..000000000 --- a/build/platformclientv2/trunkmetricscalls.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Trunkmetricscalls -type Trunkmetricscalls struct { - // InboundCallCount - InboundCallCount *int `json:"inboundCallCount,omitempty"` - - - // OutboundCallCount - OutboundCallCount *int `json:"outboundCallCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Trunkmetricscalls) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/trunkmetricsnetworktypeip.go b/build/platformclientv2/trunkmetricsnetworktypeip.go deleted file mode 100644 index df0d8427b..000000000 --- a/build/platformclientv2/trunkmetricsnetworktypeip.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Trunkmetricsnetworktypeip -type Trunkmetricsnetworktypeip struct { - // Address - Assigned IP Address for the interface - Address *string `json:"address,omitempty"` - - - // ErrorInfo - Information about the error. - ErrorInfo *Trunkerrorinfo `json:"errorInfo,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Trunkmetricsnetworktypeip) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/trunkmetricsoptions.go b/build/platformclientv2/trunkmetricsoptions.go deleted file mode 100644 index 889997bcd..000000000 --- a/build/platformclientv2/trunkmetricsoptions.go +++ /dev/null @@ -1,30 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Trunkmetricsoptions -type Trunkmetricsoptions struct { - // ProxyAddress - Server proxy address that this options array element represents. - ProxyAddress *string `json:"proxyAddress,omitempty"` - - - // OptionState - OptionState *bool `json:"optionState,omitempty"` - - - // OptionStateTime - ISO 8601 format UTC absolute date & time of the last change of the option state. - OptionStateTime *time.Time `json:"optionStateTime,omitempty"` - - - // ErrorInfo - ErrorInfo *Trunkerrorinfo `json:"errorInfo,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Trunkmetricsoptions) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/trunkmetricsqos.go b/build/platformclientv2/trunkmetricsqos.go deleted file mode 100644 index 75464ff63..000000000 --- a/build/platformclientv2/trunkmetricsqos.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Trunkmetricsqos -type Trunkmetricsqos struct { - // MismatchCount - Total number of QoS mismatches over the course of the last 24-hour period (sliding window). - MismatchCount *int `json:"mismatchCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Trunkmetricsqos) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/trunkmetricsregisters.go b/build/platformclientv2/trunkmetricsregisters.go deleted file mode 100644 index 6b8f11b44..000000000 --- a/build/platformclientv2/trunkmetricsregisters.go +++ /dev/null @@ -1,30 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Trunkmetricsregisters -type Trunkmetricsregisters struct { - // ProxyAddress - Server proxy address that this registers array element represents. - ProxyAddress *string `json:"proxyAddress,omitempty"` - - - // RegisterState - True if last REGISTER message had positive response; false if error response or no response. - RegisterState *bool `json:"registerState,omitempty"` - - - // RegisterStateTime - ISO 8601 format UTC absolute date & time of the last change of the register state. - RegisterStateTime *time.Time `json:"registerStateTime,omitempty"` - - - // ErrorInfo - ErrorInfo *Trunkerrorinfo `json:"errorInfo,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Trunkmetricsregisters) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/trunkmetricstopiclocaldate.go b/build/platformclientv2/trunkmetricstopiclocaldate.go deleted file mode 100644 index 65bbf6b48..000000000 --- a/build/platformclientv2/trunkmetricstopiclocaldate.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Trunkmetricstopiclocaldate -type Trunkmetricstopiclocaldate struct { - // Year - Year *int `json:"year,omitempty"` - - - // Month - Month *int `json:"month,omitempty"` - - - // Day - Day *int `json:"day,omitempty"` - - - // LeapYear - LeapYear *bool `json:"leapYear,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Trunkmetricstopiclocaldate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/trunkmetricstopiclocaldatetime.go b/build/platformclientv2/trunkmetricstopiclocaldatetime.go deleted file mode 100644 index e6f88897d..000000000 --- a/build/platformclientv2/trunkmetricstopiclocaldatetime.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Trunkmetricstopiclocaldatetime -type Trunkmetricstopiclocaldatetime struct { - // Date - Date *Trunkmetricstopiclocaldate `json:"date,omitempty"` - - - // Time - Time *Trunkmetricstopiclocaltime `json:"time,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Trunkmetricstopiclocaldatetime) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/trunkmetricstopiclocaltime.go b/build/platformclientv2/trunkmetricstopiclocaltime.go deleted file mode 100644 index 5620e0b4f..000000000 --- a/build/platformclientv2/trunkmetricstopiclocaltime.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Trunkmetricstopiclocaltime -type Trunkmetricstopiclocaltime struct { - // Hour - Hour *int `json:"hour,omitempty"` - - - // Minute - Minute *int `json:"minute,omitempty"` - - - // Second - Second *int `json:"second,omitempty"` - - - // Nano - Nano *int `json:"nano,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Trunkmetricstopiclocaltime) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/trunkmetricstopicoffsetdatetime.go b/build/platformclientv2/trunkmetricstopicoffsetdatetime.go deleted file mode 100644 index 16394f1f6..000000000 --- a/build/platformclientv2/trunkmetricstopicoffsetdatetime.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Trunkmetricstopicoffsetdatetime -type Trunkmetricstopicoffsetdatetime struct { - // DateTime - DateTime *Trunkmetricstopiclocaldatetime `json:"dateTime,omitempty"` - - - // Offset - Offset *Trunkmetricstopiczoneoffset `json:"offset,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Trunkmetricstopicoffsetdatetime) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/trunkmetricstopictrunkmetrics.go b/build/platformclientv2/trunkmetricstopictrunkmetrics.go deleted file mode 100644 index 5e6743609..000000000 --- a/build/platformclientv2/trunkmetricstopictrunkmetrics.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Trunkmetricstopictrunkmetrics -type Trunkmetricstopictrunkmetrics struct { - // Calls - Calls *Trunkmetricstopictrunkmetricscalls `json:"calls,omitempty"` - - - // EventTime - EventTime *Trunkmetricstopicoffsetdatetime `json:"eventTime,omitempty"` - - - // Qos - Qos *Trunkmetricstopictrunkmetricsqos `json:"qos,omitempty"` - - - // Trunk - Trunk *Trunkmetricstopicurireference `json:"trunk,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Trunkmetricstopictrunkmetrics) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/trunkmetricstopictrunkmetricscalls.go b/build/platformclientv2/trunkmetricstopictrunkmetricscalls.go deleted file mode 100644 index 26069422c..000000000 --- a/build/platformclientv2/trunkmetricstopictrunkmetricscalls.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Trunkmetricstopictrunkmetricscalls -type Trunkmetricstopictrunkmetricscalls struct { - // InboundCallCount - InboundCallCount *int `json:"inboundCallCount,omitempty"` - - - // OutboundCallCount - OutboundCallCount *int `json:"outboundCallCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Trunkmetricstopictrunkmetricscalls) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/trunkmetricstopictrunkmetricsqos.go b/build/platformclientv2/trunkmetricstopictrunkmetricsqos.go deleted file mode 100644 index e46ed9ae5..000000000 --- a/build/platformclientv2/trunkmetricstopictrunkmetricsqos.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Trunkmetricstopictrunkmetricsqos -type Trunkmetricstopictrunkmetricsqos struct { - // MismatchCount - MismatchCount *int `json:"mismatchCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Trunkmetricstopictrunkmetricsqos) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/trunkmetricstopicurireference.go b/build/platformclientv2/trunkmetricstopicurireference.go deleted file mode 100644 index 6184212c3..000000000 --- a/build/platformclientv2/trunkmetricstopicurireference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Trunkmetricstopicurireference -type Trunkmetricstopicurireference struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Trunkmetricstopicurireference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/trunkmetricstopiczoneoffset.go b/build/platformclientv2/trunkmetricstopiczoneoffset.go deleted file mode 100644 index 5178184bb..000000000 --- a/build/platformclientv2/trunkmetricstopiczoneoffset.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Trunkmetricstopiczoneoffset -type Trunkmetricstopiczoneoffset struct { - // TotalSeconds - TotalSeconds *int `json:"totalSeconds,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Trunkmetricstopiczoneoffset) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/trunkrecordingenabledcount.go b/build/platformclientv2/trunkrecordingenabledcount.go deleted file mode 100644 index c4c4fc923..000000000 --- a/build/platformclientv2/trunkrecordingenabledcount.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Trunkrecordingenabledcount -type Trunkrecordingenabledcount struct { - // EnabledCount - The amount of trunks that have recording enabled - EnabledCount *int `json:"enabledCount,omitempty"` - - - // DisabledCount - The amount of trunks that do not have recording enabled - DisabledCount *int `json:"disabledCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Trunkrecordingenabledcount) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/trustcreate.go b/build/platformclientv2/trustcreate.go deleted file mode 100644 index b05e2e212..000000000 --- a/build/platformclientv2/trustcreate.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Trustcreate -type Trustcreate struct { - // PairingId - The pairing Id created by the trustee. This is required to prove that the trustee agrees to the relationship. - PairingId *string `json:"pairingId,omitempty"` - - - // Enabled - If disabled no trustee user will have access, even if they were previously added. - Enabled *bool `json:"enabled,omitempty"` - - - // Users - The list of users and their roles to which access will be granted. The users are from the trustee and the roles are from the trustor. If no users are specified, at least one group is required. - Users *[]Trustmembercreate `json:"users,omitempty"` - - - // Groups - The list of groups and their roles to which access will be granted. The groups are from the trustee and the roles are from the trustor. If no groups are specified, at least one user is required. - Groups *[]Trustmembercreate `json:"groups,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Trustcreate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/trustee.go b/build/platformclientv2/trustee.go deleted file mode 100644 index e5793401d..000000000 --- a/build/platformclientv2/trustee.go +++ /dev/null @@ -1,38 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Trustee -type Trustee struct { - // Id - Organization Id for this trust. - Id *string `json:"id,omitempty"` - - - // Enabled - If disabled no trustee user will have access, even if they were previously added. - Enabled *bool `json:"enabled,omitempty"` - - - // DateCreated - Date Trust was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // CreatedBy - User that created trust. - CreatedBy *Orguser `json:"createdBy,omitempty"` - - - // Organization - Organization associated with this trust. - Organization *Organization `json:"organization,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Trustee) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/trusteeauditqueryrequest.go b/build/platformclientv2/trusteeauditqueryrequest.go deleted file mode 100644 index ea0914f64..000000000 --- a/build/platformclientv2/trusteeauditqueryrequest.go +++ /dev/null @@ -1,42 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Trusteeauditqueryrequest -type Trusteeauditqueryrequest struct { - // TrusteeOrganizationIds - Limit returned audits to these trustee organizationIds. - TrusteeOrganizationIds *[]string `json:"trusteeOrganizationIds,omitempty"` - - - // TrusteeUserIds - Limit returned audits to these trustee userIds. - TrusteeUserIds *[]string `json:"trusteeUserIds,omitempty"` - - - // StartDate - Starting date/time for the audit search. ISO-8601 formatted date-time, UTC. - StartDate *time.Time `json:"startDate,omitempty"` - - - // EndDate - Ending date/time for the audit search. ISO-8601 formatted date-time, UTC. - EndDate *time.Time `json:"endDate,omitempty"` - - - // QueryPhrase - Word or phrase to look for in audit bodies. - QueryPhrase *string `json:"queryPhrase,omitempty"` - - - // Facets - Facet information to be returned with the query results. - Facets *[]Facet `json:"facets,omitempty"` - - - // Filters - Additional custom filters to be applied to the query. - Filters *[]Filter `json:"filters,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Trusteeauditqueryrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/trusteeauthorization.go b/build/platformclientv2/trusteeauthorization.go deleted file mode 100644 index 410e2a500..000000000 --- a/build/platformclientv2/trusteeauthorization.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Trusteeauthorization -type Trusteeauthorization struct { - // Permissions - Permissions that the trustee user has in the trustor organization - Permissions *[]string `json:"permissions,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Trusteeauthorization) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/trusteebillingoverview.go b/build/platformclientv2/trusteebillingoverview.go deleted file mode 100644 index de57c7b98..000000000 --- a/build/platformclientv2/trusteebillingoverview.go +++ /dev/null @@ -1,82 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Trusteebillingoverview -type Trusteebillingoverview struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Organization - Organization - Organization *Namedentity `json:"organization,omitempty"` - - - // Currency - The currency type. - Currency *string `json:"currency,omitempty"` - - - // EnabledProducts - The charge short names for products enabled during the specified period. - EnabledProducts *[]string `json:"enabledProducts,omitempty"` - - - // SubscriptionType - The subscription type. - SubscriptionType *string `json:"subscriptionType,omitempty"` - - - // RampPeriodStartDate - Date-time the ramp period starts. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - RampPeriodStartDate *time.Time `json:"rampPeriodStartDate,omitempty"` - - - // RampPeriodEndDate - Date-time the ramp period ends. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - RampPeriodEndDate *time.Time `json:"rampPeriodEndDate,omitempty"` - - - // BillingPeriodStartDate - Date-time the billing period started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - BillingPeriodStartDate *time.Time `json:"billingPeriodStartDate,omitempty"` - - - // BillingPeriodEndDate - Date-time the billing period ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - BillingPeriodEndDate *time.Time `json:"billingPeriodEndDate,omitempty"` - - - // Usages - Usages for the specified period. - Usages *[]Subscriptionoverviewusage `json:"usages,omitempty"` - - - // ContractAmendmentDate - Date-time the contract was last amended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ContractAmendmentDate *time.Time `json:"contractAmendmentDate,omitempty"` - - - // ContractEffectiveDate - Date-time the contract became effective. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ContractEffectiveDate *time.Time `json:"contractEffectiveDate,omitempty"` - - - // ContractEndDate - Date-time the contract ends. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ContractEndDate *time.Time `json:"contractEndDate,omitempty"` - - - // MinimumMonthlyAmount - Minimum amount that will be charged for the month - MinimumMonthlyAmount *string `json:"minimumMonthlyAmount,omitempty"` - - - // InRampPeriod - InRampPeriod *bool `json:"inRampPeriod,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Trusteebillingoverview) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/trustentitylisting.go b/build/platformclientv2/trustentitylisting.go deleted file mode 100644 index 6a748b4ce..000000000 --- a/build/platformclientv2/trustentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Trustentitylisting -type Trustentitylisting struct { - // Entities - Entities *[]Trustee `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Trustentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/trustgroup.go b/build/platformclientv2/trustgroup.go deleted file mode 100644 index 75c6becb8..000000000 --- a/build/platformclientv2/trustgroup.go +++ /dev/null @@ -1,74 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Trustgroup -type Trustgroup struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The group name. - Name *string `json:"name,omitempty"` - - - // Description - Description *string `json:"description,omitempty"` - - - // DateModified - Last modified date/time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // MemberCount - Number of members. - MemberCount *int `json:"memberCount,omitempty"` - - - // State - Active, inactive, or deleted state. - State *string `json:"state,omitempty"` - - - // Version - Current version for this resource. - Version *int `json:"version,omitempty"` - - - // VarType - Type of group. - VarType *string `json:"type,omitempty"` - - - // Images - Images *[]Userimage `json:"images,omitempty"` - - - // Addresses - Addresses *[]Groupcontact `json:"addresses,omitempty"` - - - // RulesVisible - Are membership rules visible to the person requesting to view the group - RulesVisible *bool `json:"rulesVisible,omitempty"` - - - // Visibility - Who can view this group - Visibility *string `json:"visibility,omitempty"` - - - // Owners - Owners of the group - Owners *[]User `json:"owners,omitempty"` - - - // DateCreated - The date on which the trusted group was added. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // CreatedBy - The user that added trusted group. - CreatedBy *Orguser `json:"createdBy,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Trustgroup) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/trustmembercreate.go b/build/platformclientv2/trustmembercreate.go deleted file mode 100644 index fbdc3b84f..000000000 --- a/build/platformclientv2/trustmembercreate.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Trustmembercreate -type Trustmembercreate struct { - // Id - Trustee User or Group Id - Id *string `json:"id,omitempty"` - - - // RoleIds - The list of roles to be granted to this user or group. Roles will be granted in all divisions. - RoleIds *[]string `json:"roleIds,omitempty"` - - - // RoleDivisions - The list of trustor organization roles granting this user or group access paired with the divisions for those roles. - RoleDivisions *Roledivisiongrants `json:"roleDivisions,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Trustmembercreate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/trustor.go b/build/platformclientv2/trustor.go deleted file mode 100644 index 8bab53e29..000000000 --- a/build/platformclientv2/trustor.go +++ /dev/null @@ -1,42 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Trustor -type Trustor struct { - // Id - Organization Id for this trust. - Id *string `json:"id,omitempty"` - - - // Enabled - If disabled no trustee user will have access, even if they were previously added. - Enabled *bool `json:"enabled,omitempty"` - - - // DateCreated - Date Trust was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // CreatedBy - User that created trust. - CreatedBy *Orguser `json:"createdBy,omitempty"` - - - // Organization - Organization associated with this trust. - Organization *Organization `json:"organization,omitempty"` - - - // Authorization - Authorization for the trustee user has in this trustor organization - Authorization *Trusteeauthorization `json:"authorization,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Trustor) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/trustorauditqueryrequest.go b/build/platformclientv2/trustorauditqueryrequest.go deleted file mode 100644 index f26ca034f..000000000 --- a/build/platformclientv2/trustorauditqueryrequest.go +++ /dev/null @@ -1,42 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Trustorauditqueryrequest -type Trustorauditqueryrequest struct { - // TrustorOrganizationId - Limit returned audits to this trustor organizationId. - TrustorOrganizationId *string `json:"trustorOrganizationId,omitempty"` - - - // TrusteeUserIds - Limit returned audits to these trustee userIds. - TrusteeUserIds *[]string `json:"trusteeUserIds,omitempty"` - - - // StartDate - Starting date/time for the audit search. ISO-8601 formatted date-time, UTC. - StartDate *time.Time `json:"startDate,omitempty"` - - - // EndDate - Ending date/time for the audit search. ISO-8601 formatted date-time, UTC. - EndDate *time.Time `json:"endDate,omitempty"` - - - // QueryPhrase - Word or phrase to look for in audit bodies. - QueryPhrase *string `json:"queryPhrase,omitempty"` - - - // Facets - Facet information to be returned with the query results. - Facets *[]Facet `json:"facets,omitempty"` - - - // Filters - Additional custom filters to be applied to the query. - Filters *[]Filter `json:"filters,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Trustorauditqueryrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/trustorentitylisting.go b/build/platformclientv2/trustorentitylisting.go deleted file mode 100644 index dfdc97a4e..000000000 --- a/build/platformclientv2/trustorentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Trustorentitylisting -type Trustorentitylisting struct { - // Entities - Entities *[]Trustor `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Trustorentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/trustrequest.go b/build/platformclientv2/trustrequest.go deleted file mode 100644 index 135fa1fe5..000000000 --- a/build/platformclientv2/trustrequest.go +++ /dev/null @@ -1,42 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Trustrequest -type Trustrequest struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // CreatedBy - User who created this request. - CreatedBy *Orguser `json:"createdBy,omitempty"` - - - // DateCreated - Date request was created. There is a 48 hour expiration on all requests. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // Trustee - Trustee organization who generated this request. - Trustee *Organization `json:"trustee,omitempty"` - - - // Users - The list of trustee users that are requesting access. - Users *[]Orguser `json:"users,omitempty"` - - - // Groups - The list of trustee groups that are requesting access. - Groups *[]Trustgroup `json:"groups,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Trustrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/trustrequestcreate.go b/build/platformclientv2/trustrequestcreate.go deleted file mode 100644 index aeb7de67c..000000000 --- a/build/platformclientv2/trustrequestcreate.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Trustrequestcreate -type Trustrequestcreate struct { - // UserIds - The list of trustee users that are requesting access. If no users are specified, at least one group is required. - UserIds *[]string `json:"userIds,omitempty"` - - - // GroupIds - The list of trustee groups that are requesting access. If no groups are specified, at least one user is required. - GroupIds *[]string `json:"groupIds,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Trustrequestcreate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/trustuser.go b/build/platformclientv2/trustuser.go deleted file mode 100644 index 648e6c2fd..000000000 --- a/build/platformclientv2/trustuser.go +++ /dev/null @@ -1,149 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Trustuser -type Trustuser struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Division - The division to which this entity belongs. - Division *Division `json:"division,omitempty"` - - - // Chat - Chat *Chat `json:"chat,omitempty"` - - - // Department - Department *string `json:"department,omitempty"` - - - // Email - Email *string `json:"email,omitempty"` - - - // PrimaryContactInfo - Auto populated from addresses. - PrimaryContactInfo *[]Contact `json:"primaryContactInfo,omitempty"` - - - // Addresses - Email addresses and phone numbers for this user - Addresses *[]Contact `json:"addresses,omitempty"` - - - // State - The current state for this user. - State *string `json:"state,omitempty"` - - - // Title - Title *string `json:"title,omitempty"` - - - // Username - Username *string `json:"username,omitempty"` - - - // Manager - Manager *User `json:"manager,omitempty"` - - - // Images - Images *[]Userimage `json:"images,omitempty"` - - - // Version - Required when updating a user, this value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH. - Version *int `json:"version,omitempty"` - - - // Certifications - Certifications *[]string `json:"certifications,omitempty"` - - - // Biography - Biography *Biography `json:"biography,omitempty"` - - - // EmployerInfo - EmployerInfo *Employerinfo `json:"employerInfo,omitempty"` - - - // RoutingStatus - ACD routing status - RoutingStatus *Routingstatus `json:"routingStatus,omitempty"` - - - // Presence - Active presence - Presence *Userpresence `json:"presence,omitempty"` - - - // ConversationSummary - Summary of conversion statistics for conversation types. - ConversationSummary *Userconversationsummary `json:"conversationSummary,omitempty"` - - - // OutOfOffice - Determine if out of office is enabled - OutOfOffice *Outofoffice `json:"outOfOffice,omitempty"` - - - // Geolocation - Current geolocation position - Geolocation *Geolocation `json:"geolocation,omitempty"` - - - // Station - Effective, default, and last station information - Station *Userstations `json:"station,omitempty"` - - - // Authorization - Roles and permissions assigned to the user - Authorization *Userauthorization `json:"authorization,omitempty"` - - - // ProfileSkills - Profile skills possessed by the user - ProfileSkills *[]string `json:"profileSkills,omitempty"` - - - // Locations - The user placement at each site location. - Locations *[]Location `json:"locations,omitempty"` - - - // Groups - The groups the user is a member of - Groups *[]Group `json:"groups,omitempty"` - - - // Team - The team the user is a member of - Team *Team `json:"team,omitempty"` - - - // Skills - Routing (ACD) skills possessed by the user - Skills *[]Userroutingskill `json:"skills,omitempty"` - - - // Languages - Routing (ACD) languages possessed by the user - Languages *[]Userroutinglanguage `json:"languages,omitempty"` - - - // AcdAutoAnswer - acd auto answer - AcdAutoAnswer *bool `json:"acdAutoAnswer,omitempty"` - - - // LanguagePreference - preferred language by the user - LanguagePreference *string `json:"languagePreference,omitempty"` - - - // LastTokenIssued - LastTokenIssued *Oauthlasttokenissued `json:"lastTokenIssued,omitempty"` - - - // TrustUserDetails - TrustUserDetails *Trustuserdetails `json:"trustUserDetails,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Trustuser) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/trustuserdetails.go b/build/platformclientv2/trustuserdetails.go deleted file mode 100644 index 0ac2fed74..000000000 --- a/build/platformclientv2/trustuserdetails.go +++ /dev/null @@ -1,22 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Trustuserdetails -type Trustuserdetails struct { - // DateCreated - Date Trust User was added. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // CreatedBy - User that added trusted user. - CreatedBy *Orguser `json:"createdBy,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Trustuserdetails) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/trustuserentitylisting.go b/build/platformclientv2/trustuserentitylisting.go deleted file mode 100644 index 376366ce6..000000000 --- a/build/platformclientv2/trustuserentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Trustuserentitylisting -type Trustuserentitylisting struct { - // Entities - Entities *[]Trustuser `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Trustuserentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/ttsengineentity.go b/build/platformclientv2/ttsengineentity.go deleted file mode 100644 index 3d0314f38..000000000 --- a/build/platformclientv2/ttsengineentity.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Ttsengineentity -type Ttsengineentity struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Languages - The set of languages the TTS engine supports - Languages *[]string `json:"languages,omitempty"` - - - // OutputFormats - The set of output formats the TTS engine can produce - OutputFormats *[]string `json:"outputFormats,omitempty"` - - - // Voices - The set of voices the TTS engine supports - Voices *[]Ttsvoiceentity `json:"voices,omitempty"` - - - // IsDefault - The TTS engine is the global default engine - IsDefault *bool `json:"isDefault,omitempty"` - - - // IsSecure - The TTS engine can be used in a secure call flow - IsSecure *bool `json:"isSecure,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Ttsengineentity) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/ttsengineentitylisting.go b/build/platformclientv2/ttsengineentitylisting.go deleted file mode 100644 index ffa87284a..000000000 --- a/build/platformclientv2/ttsengineentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Ttsengineentitylisting -type Ttsengineentitylisting struct { - // Entities - Entities *[]Ttsengineentity `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Ttsengineentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/ttssettings.go b/build/platformclientv2/ttssettings.go deleted file mode 100644 index 8f160796e..000000000 --- a/build/platformclientv2/ttssettings.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Ttssettings -type Ttssettings struct { - // DefaultEngine - ID of the global default TTS engine - DefaultEngine *string `json:"defaultEngine,omitempty"` - - - // LanguageOverrides - The list of default overrides for specific languages - LanguageOverrides *[]Languageoverride `json:"languageOverrides,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Ttssettings) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/ttsvoiceentity.go b/build/platformclientv2/ttsvoiceentity.go deleted file mode 100644 index ebf505f47..000000000 --- a/build/platformclientv2/ttsvoiceentity.go +++ /dev/null @@ -1,41 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Ttsvoiceentity -type Ttsvoiceentity struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Gender - The gender of the TTS voice - Gender *string `json:"gender,omitempty"` - - - // Language - The language supported by the TTS voice - Language *string `json:"language,omitempty"` - - - // Engine - Ths TTS engine this voice belongs to - Engine *Ttsengineentity `json:"engine,omitempty"` - - - // IsDefault - The voice is the default voice for its language - IsDefault *bool `json:"isDefault,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Ttsvoiceentity) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/ttsvoiceentitylisting.go b/build/platformclientv2/ttsvoiceentitylisting.go deleted file mode 100644 index f6ef6e4aa..000000000 --- a/build/platformclientv2/ttsvoiceentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Ttsvoiceentitylisting -type Ttsvoiceentitylisting struct { - // Entities - Entities *[]Ttsvoiceentity `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Ttsvoiceentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/twitterid.go b/build/platformclientv2/twitterid.go deleted file mode 100644 index 5decfc3de..000000000 --- a/build/platformclientv2/twitterid.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Twitterid - User information for a twitter account -type Twitterid struct { - // Id - twitter user.id_str - Id *string `json:"id,omitempty"` - - - // Name - twitter user.name - Name *string `json:"name,omitempty"` - - - // ScreenName - twitter user.screen_name - ScreenName *string `json:"screenName,omitempty"` - - - // Verified - whether this data has been verified using the twitter API - Verified *bool `json:"verified,omitempty"` - - - // ProfileUrl - url of user's twitter profile - ProfileUrl *string `json:"profileUrl,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Twitterid) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/twitterintegration.go b/build/platformclientv2/twitterintegration.go deleted file mode 100644 index f78111a6e..000000000 --- a/build/platformclientv2/twitterintegration.go +++ /dev/null @@ -1,86 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Twitterintegration -type Twitterintegration struct { - // Id - A unique Integration Id - Id *string `json:"id,omitempty"` - - - // Name - The name of the Twitter Integration - Name *string `json:"name,omitempty"` - - - // AccessTokenKey - The Access Token Key from Twitter messenger - AccessTokenKey *string `json:"accessTokenKey,omitempty"` - - - // ConsumerKey - The Consumer Key from Twitter messenger - ConsumerKey *string `json:"consumerKey,omitempty"` - - - // Username - The Username from Twitter - Username *string `json:"username,omitempty"` - - - // UserId - The UserId from Twitter - UserId *string `json:"userId,omitempty"` - - - // Status - The status of the Twitter Integration - Status *string `json:"status,omitempty"` - - - // Tier - The type of twitter account to be used for the integration - Tier *string `json:"tier,omitempty"` - - - // EnvName - The Twitter environment name, e.g.: env-beta (required for premium tier) - EnvName *string `json:"envName,omitempty"` - - - // Recipient - The recipient associated to the Twitter Integration. This recipient is used to associate a flow to an integration - Recipient *Domainentityref `json:"recipient,omitempty"` - - - // DateCreated - Date this Integration was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - Date this Integration was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // CreatedBy - User reference that created this Integration - CreatedBy *Domainentityref `json:"createdBy,omitempty"` - - - // ModifiedBy - User reference that last modified this Integration - ModifiedBy *Domainentityref `json:"modifiedBy,omitempty"` - - - // Version - Version number required for updates. - Version *int `json:"version,omitempty"` - - - // CreateStatus - Status of asynchronous create operation - CreateStatus *string `json:"createStatus,omitempty"` - - - // CreateError - Error information returned, if createStatus is set to Error - CreateError *Errorbody `json:"createError,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Twitterintegration) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/twitterintegrationentitylisting.go b/build/platformclientv2/twitterintegrationentitylisting.go deleted file mode 100644 index e860dcf73..000000000 --- a/build/platformclientv2/twitterintegrationentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Twitterintegrationentitylisting -type Twitterintegrationentitylisting struct { - // Entities - Entities *[]Twitterintegration `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Twitterintegrationentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/twitterintegrationrequest.go b/build/platformclientv2/twitterintegrationrequest.go deleted file mode 100644 index b916c2f40..000000000 --- a/build/platformclientv2/twitterintegrationrequest.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Twitterintegrationrequest -type Twitterintegrationrequest struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the Twitter Integration - Name *string `json:"name,omitempty"` - - - // AccessTokenKey - The Access Token Key from Twitter messenger - AccessTokenKey *string `json:"accessTokenKey,omitempty"` - - - // AccessTokenSecret - The Access Token Secret from Twitter messenger - AccessTokenSecret *string `json:"accessTokenSecret,omitempty"` - - - // ConsumerKey - The Consumer Key from Twitter messenger - ConsumerKey *string `json:"consumerKey,omitempty"` - - - // ConsumerSecret - The Consumer Secret from Twitter messenger - ConsumerSecret *string `json:"consumerSecret,omitempty"` - - - // Tier - The type of twitter account to be used for the integration - Tier *string `json:"tier,omitempty"` - - - // EnvName - The Twitter environment name, e.g.: env-beta (required for premium tier) - EnvName *string `json:"envName,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Twitterintegrationrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/unreadmetric.go b/build/platformclientv2/unreadmetric.go deleted file mode 100644 index 1ec68b0c2..000000000 --- a/build/platformclientv2/unreadmetric.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Unreadmetric -type Unreadmetric struct { - // Count - The count of unread alerts for a specific rule type. - Count *int `json:"count,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Unreadmetric) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/unreadstatus.go b/build/platformclientv2/unreadstatus.go deleted file mode 100644 index 2824d8867..000000000 --- a/build/platformclientv2/unreadstatus.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Unreadstatus -type Unreadstatus struct { - // Unread - Sets if the alert is read or unread. - Unread *bool `json:"unread,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Unreadstatus) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/updateactioninput.go b/build/platformclientv2/updateactioninput.go deleted file mode 100644 index c9a45b607..000000000 --- a/build/platformclientv2/updateactioninput.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Updateactioninput -type Updateactioninput struct { - // Category - Category of action, Can be up to 256 characters long - Category *string `json:"category,omitempty"` - - - // Name - Name of action, Can be up to 256 characters long - Name *string `json:"name,omitempty"` - - - // Config - Configuration to support request and response processing - Config *Actionconfig `json:"config,omitempty"` - - - // Version - Version of this action - Version *int `json:"version,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Updateactioninput) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/updateactivitycoderequest.go b/build/platformclientv2/updateactivitycoderequest.go deleted file mode 100644 index 890bed760..000000000 --- a/build/platformclientv2/updateactivitycoderequest.go +++ /dev/null @@ -1,41 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Updateactivitycoderequest - Activity Code -type Updateactivitycoderequest struct { - // Name - The name of the activity code - Name *string `json:"name,omitempty"` - - - // Category - The activity code's category. Attempting to change the category of a default activity code will return an error - Category *string `json:"category,omitempty"` - - - // LengthInMinutes - The default length of the activity in minutes - LengthInMinutes *int `json:"lengthInMinutes,omitempty"` - - - // CountsAsPaidTime - Whether an agent is paid while performing this activity - CountsAsPaidTime *bool `json:"countsAsPaidTime,omitempty"` - - - // CountsAsWorkTime - Indicates whether or not the activity should be counted as work time - CountsAsWorkTime *bool `json:"countsAsWorkTime,omitempty"` - - - // AgentTimeOffSelectable - Whether an agent can select this activity code when creating or editing a time off request - AgentTimeOffSelectable *bool `json:"agentTimeOffSelectable,omitempty"` - - - // Metadata - Version metadata for the associated business unit's list of activity codes - Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Updateactivitycoderequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/updatebusinessunitrequest.go b/build/platformclientv2/updatebusinessunitrequest.go deleted file mode 100644 index fe7647100..000000000 --- a/build/platformclientv2/updatebusinessunitrequest.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Updatebusinessunitrequest -type Updatebusinessunitrequest struct { - // Name - The name of the business unit - Name *string `json:"name,omitempty"` - - - // DivisionId - The ID of the division to which the business unit should be moved - DivisionId *string `json:"divisionId,omitempty"` - - - // Settings - Configuration for the business unit - Settings *Updatebusinessunitsettings `json:"settings,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Updatebusinessunitrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/updatebusinessunitsettings.go b/build/platformclientv2/updatebusinessunitsettings.go deleted file mode 100644 index dc6c822c1..000000000 --- a/build/platformclientv2/updatebusinessunitsettings.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Updatebusinessunitsettings -type Updatebusinessunitsettings struct { - // StartDayOfWeek - The start day of week for this business unit - StartDayOfWeek *string `json:"startDayOfWeek,omitempty"` - - - // TimeZone - The time zone for this business unit, using the Olsen tz database format - TimeZone *string `json:"timeZone,omitempty"` - - - // ShortTermForecasting - Short term forecasting settings - ShortTermForecasting *Bushorttermforecastingsettings `json:"shortTermForecasting,omitempty"` - - - // Metadata - Version metadata for this business unit - Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Updatebusinessunitsettings) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/updatecoachingappointmentrequest.go b/build/platformclientv2/updatecoachingappointmentrequest.go deleted file mode 100644 index 3fedb9e58..000000000 --- a/build/platformclientv2/updatecoachingappointmentrequest.go +++ /dev/null @@ -1,42 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Updatecoachingappointmentrequest - Update coaching appointment request -type Updatecoachingappointmentrequest struct { - // Name - The name of coaching appointment. - Name *string `json:"name,omitempty"` - - - // Description - The description of coaching appointment. - Description *string `json:"description,omitempty"` - - - // DateStart - The date/time the coaching appointment starts. Times will be rounded down to the minute. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateStart *time.Time `json:"dateStart,omitempty"` - - - // LengthInMinutes - The duration of coaching appointment in minutes. - LengthInMinutes *int `json:"lengthInMinutes,omitempty"` - - - // ConversationIds - IDs of conversations associated with this coaching appointment. - ConversationIds *[]string `json:"conversationIds,omitempty"` - - - // DocumentIds - IDs of documents associated with this coaching appointment. - DocumentIds *[]string `json:"documentIds,omitempty"` - - - // Status - The status of the coaching appointment. - Status *string `json:"status,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Updatecoachingappointmentrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/updatedraftinput.go b/build/platformclientv2/updatedraftinput.go deleted file mode 100644 index 145114734..000000000 --- a/build/platformclientv2/updatedraftinput.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Updatedraftinput - Definition of an Action Draft to be created or updated. -type Updatedraftinput struct { - // Category - Category of action, Can be up to 256 characters long - Category *string `json:"category,omitempty"` - - - // Name - Name of action, Can be up to 256 characters long - Name *string `json:"name,omitempty"` - - - // Config - Configuration to support request and response processing - Config *Actionconfig `json:"config,omitempty"` - - - // Contract - Action contract - Contract *Actioncontractinput `json:"contract,omitempty"` - - - // Secure - Indication of whether or not the action is designed to accept sensitive data - Secure *bool `json:"secure,omitempty"` - - - // Version - Version of current Draft - Version *int `json:"version,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Updatedraftinput) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/updatemanagementunitrequest.go b/build/platformclientv2/updatemanagementunitrequest.go deleted file mode 100644 index d30f5f0ec..000000000 --- a/build/platformclientv2/updatemanagementunitrequest.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Updatemanagementunitrequest -type Updatemanagementunitrequest struct { - // Name - The new name of the management unit - Name *string `json:"name,omitempty"` - - - // DivisionId - The new division id for the management unit - DivisionId *string `json:"divisionId,omitempty"` - - - // Settings - Updated settings for the management unit - Settings *Managementunitsettingsrequest `json:"settings,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Updatemanagementunitrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/updatenotificationresponse.go b/build/platformclientv2/updatenotificationresponse.go deleted file mode 100644 index 2ede37b87..000000000 --- a/build/platformclientv2/updatenotificationresponse.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Updatenotificationresponse -type Updatenotificationresponse struct { - // MutableGroupId - The mutableGroupId of the notification - MutableGroupId *string `json:"mutableGroupId,omitempty"` - - - // Id - The id of the notification for mapping the potentially new mutableGroupId - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Updatenotificationresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/updatenotificationsrequest.go b/build/platformclientv2/updatenotificationsrequest.go deleted file mode 100644 index 66e2395d5..000000000 --- a/build/platformclientv2/updatenotificationsrequest.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Updatenotificationsrequest -type Updatenotificationsrequest struct { - // Entities - The notifications to update - Entities *[]Wfmusernotification `json:"entities,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Updatenotificationsrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/updatenotificationsresponse.go b/build/platformclientv2/updatenotificationsresponse.go deleted file mode 100644 index ddd9ee7b4..000000000 --- a/build/platformclientv2/updatenotificationsresponse.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Updatenotificationsresponse -type Updatenotificationsresponse struct { - // Entities - Entities *[]Updatenotificationresponse `json:"entities,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Updatenotificationsresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/updateplanninggrouprequest.go b/build/platformclientv2/updateplanninggrouprequest.go deleted file mode 100644 index 99d631c2a..000000000 --- a/build/platformclientv2/updateplanninggrouprequest.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Updateplanninggrouprequest -type Updateplanninggrouprequest struct { - // Name - The name of the planning group - Name *string `json:"name,omitempty"` - - - // RoutePaths - Set of route paths to associate with the planning group - RoutePaths *Setwrapperroutepathrequest `json:"routePaths,omitempty"` - - - // ServiceGoalTemplateId - The ID of the service goal template to associate with this planning group - ServiceGoalTemplateId *string `json:"serviceGoalTemplateId,omitempty"` - - - // Metadata - Version metadata for the planning group - Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Updateplanninggrouprequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/updateservicegoaltemplate.go b/build/platformclientv2/updateservicegoaltemplate.go deleted file mode 100644 index e54d7c17d..000000000 --- a/build/platformclientv2/updateservicegoaltemplate.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Updateservicegoaltemplate -type Updateservicegoaltemplate struct { - // Name - The name of the service goal template. - Name *string `json:"name,omitempty"` - - - // ServiceLevel - Service level targets for this service goal template - ServiceLevel *Buservicelevel `json:"serviceLevel,omitempty"` - - - // AverageSpeedOfAnswer - Average speed of answer targets for this service goal template - AverageSpeedOfAnswer *Buaveragespeedofanswer `json:"averageSpeedOfAnswer,omitempty"` - - - // AbandonRate - Abandon rate targets for this service goal template - AbandonRate *Buabandonrate `json:"abandonRate,omitempty"` - - - // Metadata - Version metadata for the service goal template - Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Updateservicegoaltemplate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/updateuser.go b/build/platformclientv2/updateuser.go deleted file mode 100644 index 74ec47c68..000000000 --- a/build/platformclientv2/updateuser.go +++ /dev/null @@ -1,97 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Updateuser -type Updateuser struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Chat - Chat *Chat `json:"chat,omitempty"` - - - // Department - Department *string `json:"department,omitempty"` - - - // Email - Email *string `json:"email,omitempty"` - - - // PrimaryContactInfo - The address(s) used for primary contact. Updates to the corresponding address in the addresses list will be reflected here. - PrimaryContactInfo *[]Contact `json:"primaryContactInfo,omitempty"` - - - // Addresses - Email address, phone number, and/or extension for this user. One entry is allowed per media type - Addresses *[]Contact `json:"addresses,omitempty"` - - - // Title - Title *string `json:"title,omitempty"` - - - // Username - Username *string `json:"username,omitempty"` - - - // Manager - Manager *string `json:"manager,omitempty"` - - - // Images - Images *[]Userimage `json:"images,omitempty"` - - - // Version - This value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH. - Version *int `json:"version,omitempty"` - - - // ProfileSkills - Profile skills possessed by the user - ProfileSkills *[]string `json:"profileSkills,omitempty"` - - - // Locations - The user placement at each site location. - Locations *[]Location `json:"locations,omitempty"` - - - // Groups - The groups the user is a member of - Groups *[]Group `json:"groups,omitempty"` - - - // State - The state of the user. This property can be used to restore a deleted user or transition between active and inactive. If specified, it is the only modifiable field. - State *string `json:"state,omitempty"` - - - // AcdAutoAnswer - The value that denotes if acdAutoAnswer is set on the user - AcdAutoAnswer *bool `json:"acdAutoAnswer,omitempty"` - - - // Certifications - Certifications *[]string `json:"certifications,omitempty"` - - - // Biography - Biography *Biography `json:"biography,omitempty"` - - - // EmployerInfo - EmployerInfo *Employerinfo `json:"employerInfo,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Updateuser) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/updateworkplanrotationagentrequest.go b/build/platformclientv2/updateworkplanrotationagentrequest.go deleted file mode 100644 index 8fe4fbe93..000000000 --- a/build/platformclientv2/updateworkplanrotationagentrequest.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Updateworkplanrotationagentrequest -type Updateworkplanrotationagentrequest struct { - // UserId - The ID of an agent in this work plan rotation - UserId *string `json:"userId,omitempty"` - - - // DateRange - The date range to which this agent is effective in the work plan rotation - DateRange *Daterangewithoptionalend `json:"dateRange,omitempty"` - - - // Position - Start position of the work plan in the pattern for this agent in the work plan rotation. Position value starts from 0 - Position *int `json:"position,omitempty"` - - - // Delete - If marked true for this agent when updating, then this agent will be removed from this work plan rotation - Delete *bool `json:"delete,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Updateworkplanrotationagentrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/updateworkplanrotationrequest.go b/build/platformclientv2/updateworkplanrotationrequest.go deleted file mode 100644 index 6833e7be9..000000000 --- a/build/platformclientv2/updateworkplanrotationrequest.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Updateworkplanrotationrequest -type Updateworkplanrotationrequest struct { - // Name - Name of this work plan rotation - Name *string `json:"name,omitempty"` - - - // Enabled - Whether the work plan rotation is enabled for scheduling - Enabled *bool `json:"enabled,omitempty"` - - - // DateRange - The date range to which this work plan rotation applies - DateRange *Daterangewithoptionalend `json:"dateRange,omitempty"` - - - // Agents - Agents in this work plan rotation - Agents *[]Updateworkplanrotationagentrequest `json:"agents,omitempty"` - - - // Pattern - Pattern with list of work plan IDs that rotate on a weekly basis - Pattern *Workplanpatternrequest `json:"pattern,omitempty"` - - - // Metadata - Version metadata for this work plan rotation - Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Updateworkplanrotationrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/uploadsapi.go b/build/platformclientv2/uploadsapi.go deleted file mode 100644 index af989d5f5..000000000 --- a/build/platformclientv2/uploadsapi.go +++ /dev/null @@ -1,316 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "encoding/json" -) - -// UploadsApi provides functions for API endpoints -type UploadsApi struct { - Configuration *Configuration -} - -// NewUploadsApi creates an API instance using the default configuration -func NewUploadsApi() *UploadsApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating UploadsApi with base path: %s", strings.ToLower(config.BasePath))) - return &UploadsApi{ - Configuration: config, - } -} - -// NewUploadsApiWithConfig creates an API instance using the provided configuration -func NewUploadsApiWithConfig(config *Configuration) *UploadsApi { - config.Debugf("Creating UploadsApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &UploadsApi{ - Configuration: config, - } -} - -// PostUploadsPublicassetsImages invokes POST /api/v2/uploads/publicassets/images -// -// Creates presigned url for uploading a public asset image -// -// -func (a UploadsApi) PostUploadsPublicassetsImages(body Uploadurlrequest) (*Uploadurlresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/uploads/publicassets/images" - defaultReturn := new(Uploadurlresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling UploadsApi->PostUploadsPublicassetsImages") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Uploadurlresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostUploadsRecordings invokes POST /api/v2/uploads/recordings -// -// Creates presigned url for uploading a recording file -// -// -func (a UploadsApi) PostUploadsRecordings(body Uploadurlrequest) (*Uploadurlresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/uploads/recordings" - defaultReturn := new(Uploadurlresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling UploadsApi->PostUploadsRecordings") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Uploadurlresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostUploadsWorkforcemanagementHistoricaldataCsv invokes POST /api/v2/uploads/workforcemanagement/historicaldata/csv -// -// Creates presigned url for uploading WFM historical data file. Requires data in csv format. -// -// -func (a UploadsApi) PostUploadsWorkforcemanagementHistoricaldataCsv(body Uploadurlrequest) (*Uploadurlresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/uploads/workforcemanagement/historicaldata/csv" - defaultReturn := new(Uploadurlresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling UploadsApi->PostUploadsWorkforcemanagementHistoricaldataCsv") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Uploadurlresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostUploadsWorkforcemanagementHistoricaldataJson invokes POST /api/v2/uploads/workforcemanagement/historicaldata/json -// -// Creates presigned url for uploading WFM historical data file. Requires data in json format. -// -// -func (a UploadsApi) PostUploadsWorkforcemanagementHistoricaldataJson(body Uploadurlrequest) (*Uploadurlresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/uploads/workforcemanagement/historicaldata/json" - defaultReturn := new(Uploadurlresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling UploadsApi->PostUploadsWorkforcemanagementHistoricaldataJson") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Uploadurlresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/uploadurlrequest.go b/build/platformclientv2/uploadurlrequest.go deleted file mode 100644 index b7f1d8311..000000000 --- a/build/platformclientv2/uploadurlrequest.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Uploadurlrequest -type Uploadurlrequest struct { - // FileName - Name of the file to upload. It must not start with a dot and not end with a forward slash. Whitespace and the following characters are not allowed: \\{^}%`]\">[~<#| - FileName *string `json:"fileName,omitempty"` - - - // ContentMd5 - Content MD-5 of the file to upload - ContentMd5 *string `json:"contentMd5,omitempty"` - - - // SignedUrlTimeoutSeconds - The number of seconds the presigned URL is valid for (from 1 to 604800 seconds). If none provided, defaults to 600 seconds - SignedUrlTimeoutSeconds *int `json:"signedUrlTimeoutSeconds,omitempty"` - - - // ServerSideEncryption - ServerSideEncryption *string `json:"serverSideEncryption,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Uploadurlrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/uploadurlresponse.go b/build/platformclientv2/uploadurlresponse.go deleted file mode 100644 index b7b75d049..000000000 --- a/build/platformclientv2/uploadurlresponse.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Uploadurlresponse -type Uploadurlresponse struct { - // Url - Presigned URL to PUT the file to - Url *string `json:"url,omitempty"` - - - // UploadKey - Key that identifies the file in the storage including the file name - UploadKey *string `json:"uploadKey,omitempty"` - - - // Headers - Required headers when uploading a file through PUT request to the URL - Headers *map[string]string `json:"headers,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Uploadurlresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/urlcondition.go b/build/platformclientv2/urlcondition.go deleted file mode 100644 index 637afa1c7..000000000 --- a/build/platformclientv2/urlcondition.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Urlcondition -type Urlcondition struct { - // Values - The URL condition value. - Values *[]string `json:"values,omitempty"` - - - // Operator - The comparison operator. - Operator *string `json:"operator,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Urlcondition) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/usage.go b/build/platformclientv2/usage.go deleted file mode 100644 index 7eebafdfe..000000000 --- a/build/platformclientv2/usage.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Usage -type Usage struct { - // Types - Types *[]Usageitem `json:"types,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Usage) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/usageapi.go b/build/platformclientv2/usageapi.go deleted file mode 100644 index 17eac0c68..000000000 --- a/build/platformclientv2/usageapi.go +++ /dev/null @@ -1,172 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "encoding/json" -) - -// UsageApi provides functions for API endpoints -type UsageApi struct { - Configuration *Configuration -} - -// NewUsageApi creates an API instance using the default configuration -func NewUsageApi() *UsageApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating UsageApi with base path: %s", strings.ToLower(config.BasePath))) - return &UsageApi{ - Configuration: config, - } -} - -// NewUsageApiWithConfig creates an API instance using the provided configuration -func NewUsageApiWithConfig(config *Configuration) *UsageApi { - config.Debugf("Creating UsageApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &UsageApi{ - Configuration: config, - } -} - -// GetUsageQueryExecutionIdResults invokes GET /api/v2/usage/query/{executionId}/results -// -// Get the results of a usage query -// -// -func (a UsageApi) GetUsageQueryExecutionIdResults(executionId string) (*Apiusagequeryresult, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/usage/query/{executionId}/results" - path = strings.Replace(path, "{executionId}", fmt.Sprintf("%v", executionId), -1) - defaultReturn := new(Apiusagequeryresult) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'executionId' is set - if &executionId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'executionId' when calling UsageApi->GetUsageQueryExecutionIdResults") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Apiusagequeryresult - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostUsageQuery invokes POST /api/v2/usage/query -// -// Query organization API Usage - -// -// After calling this method, you will then need to poll for the query results based on the returned execution Id -func (a UsageApi) PostUsageQuery(body Apiusagequery) (*Usageexecutionresult, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/usage/query" - defaultReturn := new(Usageexecutionresult) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling UsageApi->PostUsageQuery") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Usageexecutionresult - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/usageexecutionresult.go b/build/platformclientv2/usageexecutionresult.go deleted file mode 100644 index 1e68d1433..000000000 --- a/build/platformclientv2/usageexecutionresult.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Usageexecutionresult -type Usageexecutionresult struct { - // ExecutionId - The id of the query execution - ExecutionId *string `json:"executionId,omitempty"` - - - // ResultsUri - URI where the query results can be retrieved - ResultsUri *string `json:"resultsUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Usageexecutionresult) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/usageitem.go b/build/platformclientv2/usageitem.go deleted file mode 100644 index d27a7a56c..000000000 --- a/build/platformclientv2/usageitem.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Usageitem -type Usageitem struct { - // VarType - VarType *string `json:"type,omitempty"` - - - // TotalDocumentByteCount - TotalDocumentByteCount *int `json:"totalDocumentByteCount,omitempty"` - - - // TotalDocumentCount - TotalDocumentCount *int `json:"totalDocumentCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Usageitem) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/user.go b/build/platformclientv2/user.go deleted file mode 100644 index 289593798..000000000 --- a/build/platformclientv2/user.go +++ /dev/null @@ -1,149 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// User -type User struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Division - The division to which this entity belongs. - Division *Division `json:"division,omitempty"` - - - // Chat - Chat *Chat `json:"chat,omitempty"` - - - // Department - Department *string `json:"department,omitempty"` - - - // Email - Email *string `json:"email,omitempty"` - - - // PrimaryContactInfo - Auto populated from addresses. - PrimaryContactInfo *[]Contact `json:"primaryContactInfo,omitempty"` - - - // Addresses - Email addresses and phone numbers for this user - Addresses *[]Contact `json:"addresses,omitempty"` - - - // State - The current state for this user. - State *string `json:"state,omitempty"` - - - // Title - Title *string `json:"title,omitempty"` - - - // Username - Username *string `json:"username,omitempty"` - - - // Manager - Manager **User `json:"manager,omitempty"` - - - // Images - Images *[]Userimage `json:"images,omitempty"` - - - // Version - Required when updating a user, this value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH. - Version *int `json:"version,omitempty"` - - - // Certifications - Certifications *[]string `json:"certifications,omitempty"` - - - // Biography - Biography *Biography `json:"biography,omitempty"` - - - // EmployerInfo - EmployerInfo *Employerinfo `json:"employerInfo,omitempty"` - - - // RoutingStatus - ACD routing status - RoutingStatus *Routingstatus `json:"routingStatus,omitempty"` - - - // Presence - Active presence - Presence *Userpresence `json:"presence,omitempty"` - - - // ConversationSummary - Summary of conversion statistics for conversation types. - ConversationSummary *Userconversationsummary `json:"conversationSummary,omitempty"` - - - // OutOfOffice - Determine if out of office is enabled - OutOfOffice **Outofoffice `json:"outOfOffice,omitempty"` - - - // Geolocation - Current geolocation position - Geolocation *Geolocation `json:"geolocation,omitempty"` - - - // Station - Effective, default, and last station information - Station **Userstations `json:"station,omitempty"` - - - // Authorization - Roles and permissions assigned to the user - Authorization *Userauthorization `json:"authorization,omitempty"` - - - // ProfileSkills - Profile skills possessed by the user - ProfileSkills *[]string `json:"profileSkills,omitempty"` - - - // Locations - The user placement at each site location. - Locations *[]Location `json:"locations,omitempty"` - - - // Groups - The groups the user is a member of - Groups *[]Group `json:"groups,omitempty"` - - - // Team - The team the user is a member of - Team *Team `json:"team,omitempty"` - - - // Skills - Routing (ACD) skills possessed by the user - Skills *[]Userroutingskill `json:"skills,omitempty"` - - - // Languages - Routing (ACD) languages possessed by the user - Languages *[]Userroutinglanguage `json:"languages,omitempty"` - - - // AcdAutoAnswer - acd auto answer - AcdAutoAnswer *bool `json:"acdAutoAnswer,omitempty"` - - - // LanguagePreference - preferred language by the user - LanguagePreference *string `json:"languagePreference,omitempty"` - - - // LastTokenIssued - LastTokenIssued *Oauthlasttokenissued `json:"lastTokenIssued,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *User) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/useractioncategory.go b/build/platformclientv2/useractioncategory.go deleted file mode 100644 index 354b24222..000000000 --- a/build/platformclientv2/useractioncategory.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Useractioncategory -type Useractioncategory struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Useractioncategory) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/useractioncategoryentitylisting.go b/build/platformclientv2/useractioncategoryentitylisting.go deleted file mode 100644 index c1f4e9f92..000000000 --- a/build/platformclientv2/useractioncategoryentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Useractioncategoryentitylisting -type Useractioncategoryentitylisting struct { - // Entities - Entities *[]Useractioncategory `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Useractioncategoryentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/useragentinfo.go b/build/platformclientv2/useragentinfo.go deleted file mode 100644 index b2db0e9c4..000000000 --- a/build/platformclientv2/useragentinfo.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Useragentinfo -type Useragentinfo struct { - // FirmwareVersion - The firmware version of the phone. - FirmwareVersion *string `json:"firmwareVersion,omitempty"` - - - // Manufacturer - The manufacturer of the phone. - Manufacturer *string `json:"manufacturer,omitempty"` - - - // Model - The model of the phone. - Model *string `json:"model,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Useragentinfo) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/useraggregatedatacontainer.go b/build/platformclientv2/useraggregatedatacontainer.go deleted file mode 100644 index b1f1da0b7..000000000 --- a/build/platformclientv2/useraggregatedatacontainer.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Useraggregatedatacontainer -type Useraggregatedatacontainer struct { - // Group - A mapping from dimension to value - Group *map[string]string `json:"group,omitempty"` - - - // Data - Data *[]Statisticalresponse `json:"data,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Useraggregatedatacontainer) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/useraggregatequeryclause.go b/build/platformclientv2/useraggregatequeryclause.go deleted file mode 100644 index b26ff693e..000000000 --- a/build/platformclientv2/useraggregatequeryclause.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Useraggregatequeryclause -type Useraggregatequeryclause struct { - // VarType - Boolean operation to apply to the provided predicates - VarType *string `json:"type,omitempty"` - - - // Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value). - Predicates *[]Useraggregatequerypredicate `json:"predicates,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Useraggregatequeryclause) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/useraggregatequeryfilter.go b/build/platformclientv2/useraggregatequeryfilter.go deleted file mode 100644 index 124f31d3e..000000000 --- a/build/platformclientv2/useraggregatequeryfilter.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Useraggregatequeryfilter -type Useraggregatequeryfilter struct { - // VarType - Boolean operation to apply to the provided predicates and clauses - VarType *string `json:"type,omitempty"` - - - // Clauses - Boolean 'and/or' logic with up to two-levels of nesting - Clauses *[]Useraggregatequeryclause `json:"clauses,omitempty"` - - - // Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value). - Predicates *[]Useraggregatequerypredicate `json:"predicates,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Useraggregatequeryfilter) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/useraggregatequerypredicate.go b/build/platformclientv2/useraggregatequerypredicate.go deleted file mode 100644 index ae1ba9703..000000000 --- a/build/platformclientv2/useraggregatequerypredicate.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Useraggregatequerypredicate -type Useraggregatequerypredicate struct { - // VarType - Optional type, can usually be inferred - VarType *string `json:"type,omitempty"` - - - // Dimension - Left hand side for dimension predicates - Dimension *string `json:"dimension,omitempty"` - - - // Operator - Optional operator, default is matches - Operator *string `json:"operator,omitempty"` - - - // Value - Right hand side for dimension predicates - Value *string `json:"value,omitempty"` - - - // VarRange - Right hand side for dimension predicates - VarRange *Numericrange `json:"range,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Useraggregatequerypredicate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/useraggregatequeryresponse.go b/build/platformclientv2/useraggregatequeryresponse.go deleted file mode 100644 index e091d1e0e..000000000 --- a/build/platformclientv2/useraggregatequeryresponse.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Useraggregatequeryresponse -type Useraggregatequeryresponse struct { - // SystemToOrganizationMappings - A mapping from system presence to a list of organization presence ids - SystemToOrganizationMappings *map[string][]string `json:"systemToOrganizationMappings,omitempty"` - - - // Results - Results *[]Useraggregatedatacontainer `json:"results,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Useraggregatequeryresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/useraggregationquery.go b/build/platformclientv2/useraggregationquery.go deleted file mode 100644 index faabe65e4..000000000 --- a/build/platformclientv2/useraggregationquery.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Useraggregationquery -type Useraggregationquery struct { - // Interval - Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss - Interval *string `json:"interval,omitempty"` - - - // Granularity - Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H - Granularity *string `json:"granularity,omitempty"` - - - // TimeZone - Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London - TimeZone *string `json:"timeZone,omitempty"` - - - // GroupBy - Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group. - GroupBy *[]string `json:"groupBy,omitempty"` - - - // Filter - Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters - Filter *Useraggregatequeryfilter `json:"filter,omitempty"` - - - // Metrics - Behaves like a SQL SELECT clause. Only named metrics will be retrieved. - Metrics *[]string `json:"metrics,omitempty"` - - - // FlattenMultivaluedDimensions - Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c') - FlattenMultivaluedDimensions *bool `json:"flattenMultivaluedDimensions,omitempty"` - - - // Views - Custom derived metric views - Views *[]Useraggregationview `json:"views,omitempty"` - - - // AlternateTimeDimension - Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event. - AlternateTimeDimension *string `json:"alternateTimeDimension,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Useraggregationquery) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/useraggregationview.go b/build/platformclientv2/useraggregationview.go deleted file mode 100644 index 892b01df1..000000000 --- a/build/platformclientv2/useraggregationview.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Useraggregationview -type Useraggregationview struct { - // Target - Target metric name - Target *string `json:"target,omitempty"` - - - // Name - A unique name for this view. Must be distinct from other views and built-in metric names. - Name *string `json:"name,omitempty"` - - - // Function - Type of view you wish to create - Function *string `json:"function,omitempty"` - - - // VarRange - Range of numbers for slicing up data - VarRange *Aggregationrange `json:"range,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Useraggregationview) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userapp.go b/build/platformclientv2/userapp.go deleted file mode 100644 index 5f2c8121c..000000000 --- a/build/platformclientv2/userapp.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Userapp - Details for a UserApp -type Userapp struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the userApp, used to distinguish this userApp from others of the same type. - Name *string `json:"name,omitempty"` - - - // IntegrationType - Integration Type for the userApp - IntegrationType *Integrationtype `json:"integrationType,omitempty"` - - - // Config - Config *Userappconfigurationinfo `json:"config,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userapp) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userappconfigurationinfo.go b/build/platformclientv2/userappconfigurationinfo.go deleted file mode 100644 index 1fc9a77fe..000000000 --- a/build/platformclientv2/userappconfigurationinfo.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Userappconfigurationinfo - Configuration information for the integration -type Userappconfigurationinfo struct { - // Current - The current, active configuration for the integration. - Current *Integrationconfiguration `json:"current,omitempty"` - - - // Effective - The effective configuration for the app, containing the integration specific configuration along with overrides specified in the integration type. - Effective *Effectiveconfiguration `json:"effective,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userappconfigurationinfo) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userappentitylisting.go b/build/platformclientv2/userappentitylisting.go deleted file mode 100644 index 98839a9c9..000000000 --- a/build/platformclientv2/userappentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Userappentitylisting -type Userappentitylisting struct { - // Entities - Entities *[]Userapp `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userappentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userauthorization.go b/build/platformclientv2/userauthorization.go deleted file mode 100644 index 1b69d7330..000000000 --- a/build/platformclientv2/userauthorization.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Userauthorization -type Userauthorization struct { - // Roles - Roles *[]Domainrole `json:"roles,omitempty"` - - - // UnusedRoles - A collection of the roles the user is not using - UnusedRoles *[]Domainrole `json:"unusedRoles,omitempty"` - - - // Permissions - A collection of the permissions granted by all assigned roles - Permissions *[]string `json:"permissions,omitempty"` - - - // PermissionPolicies - The policies configured for assigned permissions. - PermissionPolicies *[]Resourcepermissionpolicy `json:"permissionPolicies,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userauthorization) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userconversationseventmediasummary.go b/build/platformclientv2/userconversationseventmediasummary.go deleted file mode 100644 index 49220be03..000000000 --- a/build/platformclientv2/userconversationseventmediasummary.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Userconversationseventmediasummary -type Userconversationseventmediasummary struct { - // ContactCenter - ContactCenter *Userconversationseventmediasummarydetail `json:"contactCenter,omitempty"` - - - // Enterprise - Enterprise *Userconversationseventmediasummarydetail `json:"enterprise,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userconversationseventmediasummary) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userconversationseventmediasummarydetail.go b/build/platformclientv2/userconversationseventmediasummarydetail.go deleted file mode 100644 index e31efeec8..000000000 --- a/build/platformclientv2/userconversationseventmediasummarydetail.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Userconversationseventmediasummarydetail -type Userconversationseventmediasummarydetail struct { - // Active - Active *int `json:"active,omitempty"` - - - // Acw - Acw *int `json:"acw,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userconversationseventmediasummarydetail) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userconversationseventuserconversationsummary.go b/build/platformclientv2/userconversationseventuserconversationsummary.go deleted file mode 100644 index f42687271..000000000 --- a/build/platformclientv2/userconversationseventuserconversationsummary.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Userconversationseventuserconversationsummary -type Userconversationseventuserconversationsummary struct { - // UserId - UserId *string `json:"userId,omitempty"` - - - // Call - Call *Userconversationseventmediasummary `json:"call,omitempty"` - - - // Callback - Callback *Userconversationseventmediasummary `json:"callback,omitempty"` - - - // Email - Email *Userconversationseventmediasummary `json:"email,omitempty"` - - - // Message - Message *Userconversationseventmediasummary `json:"message,omitempty"` - - - // Chat - Chat *Userconversationseventmediasummary `json:"chat,omitempty"` - - - // SocialExpression - SocialExpression *Userconversationseventmediasummary `json:"socialExpression,omitempty"` - - - // Video - Video *Userconversationseventmediasummary `json:"video,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userconversationseventuserconversationsummary) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userconversationsummary.go b/build/platformclientv2/userconversationsummary.go deleted file mode 100644 index 5629af279..000000000 --- a/build/platformclientv2/userconversationsummary.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Userconversationsummary -type Userconversationsummary struct { - // UserId - UserId *string `json:"userId,omitempty"` - - - // Call - Call *Mediasummary `json:"call,omitempty"` - - - // Callback - Callback *Mediasummary `json:"callback,omitempty"` - - - // Email - Email *Mediasummary `json:"email,omitempty"` - - - // Message - Message *Mediasummary `json:"message,omitempty"` - - - // Chat - Chat *Mediasummary `json:"chat,omitempty"` - - - // SocialExpression - SocialExpression *Mediasummary `json:"socialExpression,omitempty"` - - - // Video - Video *Mediasummary `json:"video,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userconversationsummary) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userdetailqueryclause.go b/build/platformclientv2/userdetailqueryclause.go deleted file mode 100644 index 88409d605..000000000 --- a/build/platformclientv2/userdetailqueryclause.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Userdetailqueryclause -type Userdetailqueryclause struct { - // VarType - Boolean operation to apply to the provided predicates - VarType *string `json:"type,omitempty"` - - - // Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value). - Predicates *[]Userdetailquerypredicate `json:"predicates,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userdetailqueryclause) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userdetailqueryfilter.go b/build/platformclientv2/userdetailqueryfilter.go deleted file mode 100644 index 1ea98add5..000000000 --- a/build/platformclientv2/userdetailqueryfilter.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Userdetailqueryfilter -type Userdetailqueryfilter struct { - // VarType - Boolean operation to apply to the provided predicates and clauses - VarType *string `json:"type,omitempty"` - - - // Clauses - Boolean 'and/or' logic with up to two-levels of nesting - Clauses *[]Userdetailqueryclause `json:"clauses,omitempty"` - - - // Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value). - Predicates *[]Userdetailquerypredicate `json:"predicates,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userdetailqueryfilter) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userdetailquerypredicate.go b/build/platformclientv2/userdetailquerypredicate.go deleted file mode 100644 index bcce4c703..000000000 --- a/build/platformclientv2/userdetailquerypredicate.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Userdetailquerypredicate -type Userdetailquerypredicate struct { - // VarType - Optional type, can usually be inferred - VarType *string `json:"type,omitempty"` - - - // Dimension - Left hand side for dimension predicates - Dimension *string `json:"dimension,omitempty"` - - - // Operator - Optional operator, default is matches - Operator *string `json:"operator,omitempty"` - - - // Value - Right hand side for dimension predicates - Value *string `json:"value,omitempty"` - - - // VarRange - Right hand side for dimension predicates - VarRange *Numericrange `json:"range,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userdetailquerypredicate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userdetailsdatalakeavailabilitytopicdataavailabilitychangenotification.go b/build/platformclientv2/userdetailsdatalakeavailabilitytopicdataavailabilitychangenotification.go deleted file mode 100644 index 7dda0f5b5..000000000 --- a/build/platformclientv2/userdetailsdatalakeavailabilitytopicdataavailabilitychangenotification.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Userdetailsdatalakeavailabilitytopicdataavailabilitychangenotification -type Userdetailsdatalakeavailabilitytopicdataavailabilitychangenotification struct { - // DataAvailabilityDate - DataAvailabilityDate *Userdetailsdatalakeavailabilitytopicdatetime `json:"dataAvailabilityDate,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userdetailsdatalakeavailabilitytopicdataavailabilitychangenotification) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userdetailsdatalakeavailabilitytopicdatetime.go b/build/platformclientv2/userdetailsdatalakeavailabilitytopicdatetime.go deleted file mode 100644 index ec047f2f2..000000000 --- a/build/platformclientv2/userdetailsdatalakeavailabilitytopicdatetime.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Userdetailsdatalakeavailabilitytopicdatetime -type Userdetailsdatalakeavailabilitytopicdatetime struct { - // IMillis - IMillis *int `json:"iMillis,omitempty"` - - - // BeforeNow - BeforeNow *bool `json:"beforeNow,omitempty"` - - - // EqualNow - EqualNow *bool `json:"equalNow,omitempty"` - - - // AfterNow - AfterNow *bool `json:"afterNow,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userdetailsdatalakeavailabilitytopicdatetime) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userdetailsquery.go b/build/platformclientv2/userdetailsquery.go deleted file mode 100644 index a31fbb11b..000000000 --- a/build/platformclientv2/userdetailsquery.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Userdetailsquery -type Userdetailsquery struct { - // Interval - Specifies the date and time range of data being queried. Conversations MUST have started within this time range to potentially be included within the result set. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss - Interval *string `json:"interval,omitempty"` - - - // UserFilters - Filters that target the users to retrieve data for - UserFilters *[]Userdetailqueryfilter `json:"userFilters,omitempty"` - - - // PresenceFilters - Filters that target system and organization presence-level data - PresenceFilters *[]Presencedetailqueryfilter `json:"presenceFilters,omitempty"` - - - // RoutingStatusFilters - Filters that target agent routing status-level data - RoutingStatusFilters *[]Routingstatusdetailqueryfilter `json:"routingStatusFilters,omitempty"` - - - // Order - Sort the result set in ascending/descending order. Default is ascending - Order *string `json:"order,omitempty"` - - - // PresenceAggregations - Include faceted search and aggregate roll-ups of presence data in your search results. This does not function as a filter, but rather, summary data about the presence results matching your filters - PresenceAggregations *[]Analyticsqueryaggregation `json:"presenceAggregations,omitempty"` - - - // RoutingStatusAggregations - Include faceted search and aggregate roll-ups of agent routing status data in your search results. This does not function as a filter, but rather, summary data about the agent routing status results matching your filters - RoutingStatusAggregations *[]Analyticsqueryaggregation `json:"routingStatusAggregations,omitempty"` - - - // Paging - Page size and number to control iterating through large result sets. Default page size is 25 - Paging *Pagingspec `json:"paging,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userdetailsquery) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userdevice.go b/build/platformclientv2/userdevice.go deleted file mode 100644 index be72f9fa4..000000000 --- a/build/platformclientv2/userdevice.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Userdevice -type Userdevice struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // DeviceToken - device token sent by mobile clients. - DeviceToken *string `json:"deviceToken,omitempty"` - - - // NotificationId - notification id of the device. - NotificationId *string `json:"notificationId,omitempty"` - - - // Make - make of the device. - Make *string `json:"make,omitempty"` - - - // Model - Device model - Model *string `json:"model,omitempty"` - - - // AcceptNotifications - if the device accepts notifications - AcceptNotifications *bool `json:"acceptNotifications,omitempty"` - - - // VarType - type of the device; ios or android - VarType *string `json:"type,omitempty"` - - - // SessionHash - SessionHash *string `json:"sessionHash,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userdevice) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userentitylisting.go b/build/platformclientv2/userentitylisting.go deleted file mode 100644 index 192f21f72..000000000 --- a/build/platformclientv2/userentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Userentitylisting -type Userentitylisting struct { - // Entities - Entities *[]User `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userexpands.go b/build/platformclientv2/userexpands.go deleted file mode 100644 index bf720a299..000000000 --- a/build/platformclientv2/userexpands.go +++ /dev/null @@ -1,41 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Userexpands -type Userexpands struct { - // RoutingStatus - ACD routing status - RoutingStatus *Routingstatus `json:"routingStatus,omitempty"` - - - // Presence - Active presence - Presence *Userpresence `json:"presence,omitempty"` - - - // ConversationSummary - Summary of conversion statistics for conversation types. - ConversationSummary *Userconversationsummary `json:"conversationSummary,omitempty"` - - - // OutOfOffice - Determine if out of office is enabled - OutOfOffice *Outofoffice `json:"outOfOffice,omitempty"` - - - // Geolocation - Current geolocation position - Geolocation *Geolocation `json:"geolocation,omitempty"` - - - // Station - Effective, default, and last station information - Station *Userstations `json:"station,omitempty"` - - - // Authorization - Roles and permissions assigned to the user - Authorization *Userauthorization `json:"authorization,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userexpands) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/usergreetingeventgreeting.go b/build/platformclientv2/usergreetingeventgreeting.go deleted file mode 100644 index 7b3c7a6f1..000000000 --- a/build/platformclientv2/usergreetingeventgreeting.go +++ /dev/null @@ -1,41 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Usergreetingeventgreeting -type Usergreetingeventgreeting struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - - - // OwnerType - OwnerType *string `json:"ownerType,omitempty"` - - - // Owner - Owner *Usergreetingeventgreetingowner `json:"owner,omitempty"` - - - // GreetingAudioFile - GreetingAudioFile *Usergreetingeventgreetingaudiofile `json:"greetingAudioFile,omitempty"` - - - // AudioTTS - AudioTTS *string `json:"audioTTS,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Usergreetingeventgreeting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/usergreetingeventgreetingaudiofile.go b/build/platformclientv2/usergreetingeventgreetingaudiofile.go deleted file mode 100644 index e02d6790a..000000000 --- a/build/platformclientv2/usergreetingeventgreetingaudiofile.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Usergreetingeventgreetingaudiofile -type Usergreetingeventgreetingaudiofile struct { - // DurationMilliseconds - DurationMilliseconds *int `json:"durationMilliseconds,omitempty"` - - - // SizeBytes - SizeBytes *int `json:"sizeBytes,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Usergreetingeventgreetingaudiofile) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/usergreetingeventgreetingowner.go b/build/platformclientv2/usergreetingeventgreetingowner.go deleted file mode 100644 index 9b927561c..000000000 --- a/build/platformclientv2/usergreetingeventgreetingowner.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Usergreetingeventgreetingowner -type Usergreetingeventgreetingowner struct { - // Id - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Usergreetingeventgreetingowner) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userimage.go b/build/platformclientv2/userimage.go deleted file mode 100644 index 9ebecfbb1..000000000 --- a/build/platformclientv2/userimage.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Userimage -type Userimage struct { - // Resolution - Height and/or width of image. ex: 640x480 or x128 - Resolution *string `json:"resolution,omitempty"` - - - // ImageUri - ImageUri *string `json:"imageUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userimage) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userlanguageentitylisting.go b/build/platformclientv2/userlanguageentitylisting.go deleted file mode 100644 index 88729adcc..000000000 --- a/build/platformclientv2/userlanguageentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Userlanguageentitylisting -type Userlanguageentitylisting struct { - // Entities - Entities *[]Userroutinglanguage `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userlanguageentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userlicenses.go b/build/platformclientv2/userlicenses.go deleted file mode 100644 index 54fe918bd..000000000 --- a/build/platformclientv2/userlicenses.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Userlicenses -type Userlicenses struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Licenses - Licenses *[]string `json:"licenses,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userlicenses) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userlicensesentitylisting.go b/build/platformclientv2/userlicensesentitylisting.go deleted file mode 100644 index dc3ca81ed..000000000 --- a/build/platformclientv2/userlicensesentitylisting.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Userlicensesentitylisting -type Userlicensesentitylisting struct { - // Entities - Entities *[]Userlicenses `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userlicensesentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userlistschedulerequestbody.go b/build/platformclientv2/userlistschedulerequestbody.go deleted file mode 100644 index 0e5e10015..000000000 --- a/build/platformclientv2/userlistschedulerequestbody.go +++ /dev/null @@ -1,30 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Userlistschedulerequestbody - Request body for fetching the schedule for a group of users over a given time range -type Userlistschedulerequestbody struct { - // UserIds - The user ids for which to fetch schedules - UserIds *[]string `json:"userIds,omitempty"` - - - // StartDate - Beginning of the range of schedules to fetch, in ISO-8601 format - StartDate *time.Time `json:"startDate,omitempty"` - - - // EndDate - End of the range of schedules to fetch, in ISO-8601 format - EndDate *time.Time `json:"endDate,omitempty"` - - - // LoadFullWeeks - Whether to load the full week's schedule (for the requested users) of any week overlapping the start/end date query parameters, defaults to false - LoadFullWeeks *bool `json:"loadFullWeeks,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userlistschedulerequestbody) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userme.go b/build/platformclientv2/userme.go deleted file mode 100644 index 2395535d2..000000000 --- a/build/platformclientv2/userme.go +++ /dev/null @@ -1,209 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Userme -type Userme struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Division - The division to which this entity belongs. - Division *Division `json:"division,omitempty"` - - - // Chat - Chat *Chat `json:"chat,omitempty"` - - - // Department - Department *string `json:"department,omitempty"` - - - // Email - Email *string `json:"email,omitempty"` - - - // PrimaryContactInfo - Auto populated from addresses. - PrimaryContactInfo *[]Contact `json:"primaryContactInfo,omitempty"` - - - // Addresses - Email addresses and phone numbers for this user - Addresses *[]Contact `json:"addresses,omitempty"` - - - // State - The current state for this user. - State *string `json:"state,omitempty"` - - - // Title - Title *string `json:"title,omitempty"` - - - // Username - Username *string `json:"username,omitempty"` - - - // Manager - Manager *User `json:"manager,omitempty"` - - - // Images - Images *[]Userimage `json:"images,omitempty"` - - - // Version - Required when updating a user, this value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH. - Version *int `json:"version,omitempty"` - - - // Certifications - Certifications *[]string `json:"certifications,omitempty"` - - - // Biography - Biography *Biography `json:"biography,omitempty"` - - - // EmployerInfo - EmployerInfo *Employerinfo `json:"employerInfo,omitempty"` - - - // RoutingStatus - ACD routing status - RoutingStatus *Routingstatus `json:"routingStatus,omitempty"` - - - // Presence - Active presence - Presence *Userpresence `json:"presence,omitempty"` - - - // ConversationSummary - Summary of conversion statistics for conversation types. - ConversationSummary *Userconversationsummary `json:"conversationSummary,omitempty"` - - - // OutOfOffice - Determine if out of office is enabled - OutOfOffice *Outofoffice `json:"outOfOffice,omitempty"` - - - // Geolocation - Current geolocation position - Geolocation *Geolocation `json:"geolocation,omitempty"` - - - // Station - Effective, default, and last station information - Station *Userstations `json:"station,omitempty"` - - - // Authorization - Roles and permissions assigned to the user - Authorization *Userauthorization `json:"authorization,omitempty"` - - - // ProfileSkills - Profile skills possessed by the user - ProfileSkills *[]string `json:"profileSkills,omitempty"` - - - // Locations - The user placement at each site location. - Locations *[]Location `json:"locations,omitempty"` - - - // Groups - The groups the user is a member of - Groups *[]Group `json:"groups,omitempty"` - - - // Team - The team the user is a member of - Team *Team `json:"team,omitempty"` - - - // Skills - Routing (ACD) skills possessed by the user - Skills *[]Userroutingskill `json:"skills,omitempty"` - - - // Languages - Routing (ACD) languages possessed by the user - Languages *[]Userroutinglanguage `json:"languages,omitempty"` - - - // AcdAutoAnswer - acd auto answer - AcdAutoAnswer *bool `json:"acdAutoAnswer,omitempty"` - - - // LanguagePreference - preferred language by the user - LanguagePreference *string `json:"languagePreference,omitempty"` - - - // LastTokenIssued - LastTokenIssued *Oauthlasttokenissued `json:"lastTokenIssued,omitempty"` - - - // Date - The PureCloud system date time. - Date *Serverdate `json:"date,omitempty"` - - - // GeolocationSettings - Geolocation settings for user's organization. - GeolocationSettings *Geolocationsettings `json:"geolocationSettings,omitempty"` - - - // Organization - Organization details for this user. - Organization *Organization `json:"organization,omitempty"` - - - // PresenceDefinitions - The first 100 presence definitions for user's organization. - PresenceDefinitions *[]Organizationpresence `json:"presenceDefinitions,omitempty"` - - - // LocationDefinitions - The first 100 site locations for user's organization - LocationDefinitions *[]Locationdefinition `json:"locationDefinitions,omitempty"` - - - // OrgAuthorization - The first 100 organization roles, with applicable permission policies, for user's organization. - OrgAuthorization *[]Domainorganizationrole `json:"orgAuthorization,omitempty"` - - - // Favorites - The first 50 favorited users. - Favorites *[]User `json:"favorites,omitempty"` - - - // Superiors - The first 50 superiors of this user. - Superiors *[]User `json:"superiors,omitempty"` - - - // DirectReports - The first 50 direct reports to this user. - DirectReports *[]User `json:"directReports,omitempty"` - - - // Adjacents - The first 50 superiors, direct reports, and siblings of this user. Mutually exclusive with superiors and direct reports expands. - Adjacents *Adjacents `json:"adjacents,omitempty"` - - - // RoutingSkills - The first 50 routing skills for user's organizations - RoutingSkills *[]Routingskill `json:"routingSkills,omitempty"` - - - // FieldConfigs - The field config for all entities types of user's organization - FieldConfigs *Fieldconfigs `json:"fieldConfigs,omitempty"` - - - // Token - Information about the current token - Token *Tokeninfo `json:"token,omitempty"` - - - // Trustors - Organizations having this user as a trustee - Trustors *[]Trustor `json:"trustors,omitempty"` - - - // OrgProducts - Products enabled in this organization - OrgProducts *[]Domainorganizationproduct `json:"orgProducts,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userme) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userobservationdatacontainer.go b/build/platformclientv2/userobservationdatacontainer.go deleted file mode 100644 index 8329bc55c..000000000 --- a/build/platformclientv2/userobservationdatacontainer.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Userobservationdatacontainer -type Userobservationdatacontainer struct { - // Group - A mapping from dimension to value - Group *map[string]string `json:"group,omitempty"` - - - // Data - Data *[]Observationmetricdata `json:"data,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userobservationdatacontainer) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userobservationquery.go b/build/platformclientv2/userobservationquery.go deleted file mode 100644 index efbf01abe..000000000 --- a/build/platformclientv2/userobservationquery.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Userobservationquery -type Userobservationquery struct { - // Filter - Filter to return a subset of observations. Expresses boolean logical predicates as well as dimensional filters - Filter *Userobservationqueryfilter `json:"filter,omitempty"` - - - // Metrics - Behaves like a SQL SELECT clause. Only named metrics will be retrieved. - Metrics *[]string `json:"metrics,omitempty"` - - - // DetailMetrics - Metrics for which to include additional detailed observations - DetailMetrics *[]string `json:"detailMetrics,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userobservationquery) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userobservationqueryclause.go b/build/platformclientv2/userobservationqueryclause.go deleted file mode 100644 index 8376a0a27..000000000 --- a/build/platformclientv2/userobservationqueryclause.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Userobservationqueryclause -type Userobservationqueryclause struct { - // VarType - Boolean operation to apply to the provided predicates - VarType *string `json:"type,omitempty"` - - - // Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value). - Predicates *[]Userobservationquerypredicate `json:"predicates,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userobservationqueryclause) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userobservationqueryfilter.go b/build/platformclientv2/userobservationqueryfilter.go deleted file mode 100644 index 8ec3978ef..000000000 --- a/build/platformclientv2/userobservationqueryfilter.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Userobservationqueryfilter -type Userobservationqueryfilter struct { - // VarType - Boolean operation to apply to the provided predicates and clauses - VarType *string `json:"type,omitempty"` - - - // Clauses - Boolean 'and/or' logic with up to two-levels of nesting - Clauses *[]Userobservationqueryclause `json:"clauses,omitempty"` - - - // Predicates - Like a three-word sentence: (attribute-name) (operator) (target-value). - Predicates *[]Userobservationquerypredicate `json:"predicates,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userobservationqueryfilter) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userobservationquerypredicate.go b/build/platformclientv2/userobservationquerypredicate.go deleted file mode 100644 index 366d11bc0..000000000 --- a/build/platformclientv2/userobservationquerypredicate.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Userobservationquerypredicate -type Userobservationquerypredicate struct { - // VarType - Optional type, can usually be inferred - VarType *string `json:"type,omitempty"` - - - // Dimension - Left hand side for dimension predicates - Dimension *string `json:"dimension,omitempty"` - - - // Operator - Optional operator, default is matches - Operator *string `json:"operator,omitempty"` - - - // Value - Right hand side for dimension predicates - Value *string `json:"value,omitempty"` - - - // VarRange - Right hand side for dimension predicates - VarRange *Numericrange `json:"range,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userobservationquerypredicate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userobservationqueryresponse.go b/build/platformclientv2/userobservationqueryresponse.go deleted file mode 100644 index ae4579297..000000000 --- a/build/platformclientv2/userobservationqueryresponse.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Userobservationqueryresponse -type Userobservationqueryresponse struct { - // Results - Results *[]Userobservationdatacontainer `json:"results,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userobservationqueryresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userparam.go b/build/platformclientv2/userparam.go deleted file mode 100644 index 4cbf4053f..000000000 --- a/build/platformclientv2/userparam.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Userparam -type Userparam struct { - // Key - Key *string `json:"key,omitempty"` - - - // Value - Value *string `json:"value,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userparam) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userpresence.go b/build/platformclientv2/userpresence.go deleted file mode 100644 index 454f8a480..000000000 --- a/build/platformclientv2/userpresence.go +++ /dev/null @@ -1,46 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Userpresence -type Userpresence struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Source - Represents the source where the Presence was set. Some examples are: PURECLOUD, LYNC, OUTLOOK, etc. - Source *string `json:"source,omitempty"` - - - // Primary - A boolean used to tell whether or not to set this presence source as the primary on a PATCH - Primary *bool `json:"primary,omitempty"` - - - // PresenceDefinition - PresenceDefinition *Presencedefinition `json:"presenceDefinition,omitempty"` - - - // Message - Message *string `json:"message,omitempty"` - - - // ModifiedDate - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ModifiedDate *time.Time `json:"modifiedDate,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userpresence) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userprofile.go b/build/platformclientv2/userprofile.go deleted file mode 100644 index ef185de2b..000000000 --- a/build/platformclientv2/userprofile.go +++ /dev/null @@ -1,42 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Userprofile -type Userprofile struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // State - The state of the user resource - State *string `json:"state,omitempty"` - - - // DateModified - Datetime of the last modification. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // Version - The version of the group resource - Version *int `json:"version,omitempty"` - - - // Expands - User information expansions - Expands *Userexpands `json:"expands,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userprofile) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userprofileentitylisting.go b/build/platformclientv2/userprofileentitylisting.go deleted file mode 100644 index 098ae91d2..000000000 --- a/build/platformclientv2/userprofileentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Userprofileentitylisting -type Userprofileentitylisting struct { - // Entities - Entities *[]Userprofile `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userprofileentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userqueue.go b/build/platformclientv2/userqueue.go deleted file mode 100644 index 1c00607b0..000000000 --- a/build/platformclientv2/userqueue.go +++ /dev/null @@ -1,114 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Userqueue -type Userqueue struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Division - The division to which this entity belongs. - Division *Division `json:"division,omitempty"` - - - // Description - The queue description. - Description *string `json:"description,omitempty"` - - - // DateCreated - The date the queue was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - The date of the last modification to the queue. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // ModifiedBy - The ID of the user that last modified the queue. - ModifiedBy *string `json:"modifiedBy,omitempty"` - - - // CreatedBy - The ID of the user that created the queue. - CreatedBy *string `json:"createdBy,omitempty"` - - - // MemberCount - The number of users in the queue. - MemberCount *int `json:"memberCount,omitempty"` - - - // MediaSettings - The media settings for the queue. Valid key values: CALL, CALLBACK, CHAT, EMAIL, MESSAGE, SOCIAL_EXPRESSION, VIDEO_COMM - MediaSettings *map[string]Mediasetting `json:"mediaSettings,omitempty"` - - - // RoutingRules - The routing rules for the queue, used for routing to known or preferred agents. - RoutingRules *[]Routingrule `json:"routingRules,omitempty"` - - - // Bullseye - The bulls-eye settings for the queue. - Bullseye *Bullseye `json:"bullseye,omitempty"` - - - // AcwSettings - The ACW settings for the queue. - AcwSettings *Acwsettings `json:"acwSettings,omitempty"` - - - // SkillEvaluationMethod - The skill evaluation method to use when routing conversations. - SkillEvaluationMethod *string `json:"skillEvaluationMethod,omitempty"` - - - // QueueFlow - The in-queue flow to use for conversations waiting in queue. - QueueFlow *Domainentityref `json:"queueFlow,omitempty"` - - - // WhisperPrompt - The prompt used for whisper on the queue, if configured. - WhisperPrompt *Domainentityref `json:"whisperPrompt,omitempty"` - - - // EnableTranscription - Indicates whether voice transcription is enabled for this queue. - EnableTranscription *bool `json:"enableTranscription,omitempty"` - - - // EnableManualAssignment - Indicates whether manual assignment is enabled for this queue. - EnableManualAssignment *bool `json:"enableManualAssignment,omitempty"` - - - // CallingPartyName - The name to use for caller identification for outbound calls from this queue. - CallingPartyName *string `json:"callingPartyName,omitempty"` - - - // CallingPartyNumber - The phone number to use for caller identification for outbound calls from this queue. - CallingPartyNumber *string `json:"callingPartyNumber,omitempty"` - - - // DefaultScripts - The default script Ids for the communication types. - DefaultScripts *map[string]Script `json:"defaultScripts,omitempty"` - - - // OutboundMessagingAddresses - The messaging addresses for the queue. - OutboundMessagingAddresses *Queuemessagingaddresses `json:"outboundMessagingAddresses,omitempty"` - - - // OutboundEmailAddress - OutboundEmailAddress *Queueemailaddress `json:"outboundEmailAddress,omitempty"` - - - // Joined - Joined *bool `json:"joined,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userqueue) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userqueueentitylisting.go b/build/platformclientv2/userqueueentitylisting.go deleted file mode 100644 index 87015c27b..000000000 --- a/build/platformclientv2/userqueueentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Userqueueentitylisting -type Userqueueentitylisting struct { - // Entities - Entities *[]Userqueue `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userqueueentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userrecording.go b/build/platformclientv2/userrecording.go deleted file mode 100644 index 317733d7e..000000000 --- a/build/platformclientv2/userrecording.go +++ /dev/null @@ -1,66 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Userrecording -type Userrecording struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // DateCreated - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // ContentUri - ContentUri *string `json:"contentUri,omitempty"` - - - // Workspace - Workspace *Domainentityref `json:"workspace,omitempty"` - - - // CreatedBy - CreatedBy *Domainentityref `json:"createdBy,omitempty"` - - - // Conversation - Conversation *Conversation `json:"conversation,omitempty"` - - - // ContentLength - ContentLength *int `json:"contentLength,omitempty"` - - - // DurationMilliseconds - DurationMilliseconds *int `json:"durationMilliseconds,omitempty"` - - - // Thumbnails - Thumbnails *[]Documentthumbnail `json:"thumbnails,omitempty"` - - - // Read - Read *bool `json:"read,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userrecording) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userrecordingentitylisting.go b/build/platformclientv2/userrecordingentitylisting.go deleted file mode 100644 index 08e45aba1..000000000 --- a/build/platformclientv2/userrecordingentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Userrecordingentitylisting -type Userrecordingentitylisting struct { - // Entities - Entities *[]Userrecording `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userrecordingentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userrecordingsapi.go b/build/platformclientv2/userrecordingsapi.go deleted file mode 100644 index a8f372f71..000000000 --- a/build/platformclientv2/userrecordingsapi.go +++ /dev/null @@ -1,519 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "encoding/json" -) - -// UserRecordingsApi provides functions for API endpoints -type UserRecordingsApi struct { - Configuration *Configuration -} - -// NewUserRecordingsApi creates an API instance using the default configuration -func NewUserRecordingsApi() *UserRecordingsApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating UserRecordingsApi with base path: %s", strings.ToLower(config.BasePath))) - return &UserRecordingsApi{ - Configuration: config, - } -} - -// NewUserRecordingsApiWithConfig creates an API instance using the provided configuration -func NewUserRecordingsApiWithConfig(config *Configuration) *UserRecordingsApi { - config.Debugf("Creating UserRecordingsApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &UserRecordingsApi{ - Configuration: config, - } -} - -// DeleteUserrecording invokes DELETE /api/v2/userrecordings/{recordingId} -// -// Delete a user recording. -// -// -func (a UserRecordingsApi) DeleteUserrecording(recordingId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/userrecordings/{recordingId}" - path = strings.Replace(path, "{recordingId}", fmt.Sprintf("%v", recordingId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'recordingId' is set - if &recordingId == nil { - // - return nil, errors.New("Missing required parameter 'recordingId' when calling UserRecordingsApi->DeleteUserrecording") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// GetUserrecording invokes GET /api/v2/userrecordings/{recordingId} -// -// Get a user recording. -// -// -func (a UserRecordingsApi) GetUserrecording(recordingId string, expand []string) (*Userrecording, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/userrecordings/{recordingId}" - path = strings.Replace(path, "{recordingId}", fmt.Sprintf("%v", recordingId), -1) - defaultReturn := new(Userrecording) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'recordingId' is set - if &recordingId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'recordingId' when calling UserRecordingsApi->GetUserrecording") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Userrecording - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetUserrecordingMedia invokes GET /api/v2/userrecordings/{recordingId}/media -// -// Download a user recording. -// -// -func (a UserRecordingsApi) GetUserrecordingMedia(recordingId string, formatId string) (*Downloadresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/userrecordings/{recordingId}/media" - path = strings.Replace(path, "{recordingId}", fmt.Sprintf("%v", recordingId), -1) - defaultReturn := new(Downloadresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'recordingId' is set - if &recordingId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'recordingId' when calling UserRecordingsApi->GetUserrecordingMedia") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(formatId).(string); ok { - if str != "" { - queryParams["formatId"] = a.Configuration.APIClient.ParameterToString(formatId, collectionFormat) - } - } else { - queryParams["formatId"] = a.Configuration.APIClient.ParameterToString(formatId, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Downloadresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetUserrecordings invokes GET /api/v2/userrecordings -// -// Get a list of user recordings. -// -// -func (a UserRecordingsApi) GetUserrecordings(pageSize int, pageNumber int, expand []string) (*Userrecordingentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/userrecordings" - defaultReturn := new(Userrecordingentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Userrecordingentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetUserrecordingsSummary invokes GET /api/v2/userrecordings/summary -// -// Get user recording summary -// -// -func (a UserRecordingsApi) GetUserrecordingsSummary() (*Faxsummary, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/userrecordings/summary" - defaultReturn := new(Faxsummary) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Faxsummary - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutUserrecording invokes PUT /api/v2/userrecordings/{recordingId} -// -// Update a user recording. -// -// -func (a UserRecordingsApi) PutUserrecording(recordingId string, body Userrecording, expand []string) (*Userrecording, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/userrecordings/{recordingId}" - path = strings.Replace(path, "{recordingId}", fmt.Sprintf("%v", recordingId), -1) - defaultReturn := new(Userrecording) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'recordingId' is set - if &recordingId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'recordingId' when calling UserRecordingsApi->PutUserrecording") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling UserRecordingsApi->PutUserrecording") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Userrecording - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/userreference.go b/build/platformclientv2/userreference.go deleted file mode 100644 index 0fcc5e61e..000000000 --- a/build/platformclientv2/userreference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Userreference -type Userreference struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userreference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userroutinglanguage.go b/build/platformclientv2/userroutinglanguage.go deleted file mode 100644 index 1c2ac3dc6..000000000 --- a/build/platformclientv2/userroutinglanguage.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Userroutinglanguage - Represents an organization language assigned to a user. When assigning to a user specify the organization language id as the id. -type Userroutinglanguage struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Proficiency - A rating from 0.0 to 5.0 that indicates how fluent an agent is in a particular language. ACD interactions are routed to agents with higher proficiency ratings. - Proficiency *float64 `json:"proficiency,omitempty"` - - - // State - Activate or deactivate this routing language. - State *string `json:"state,omitempty"` - - - // LanguageUri - URI to the organization language used by this user language. - LanguageUri *string `json:"languageUri,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userroutinglanguage) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userroutinglanguagepost.go b/build/platformclientv2/userroutinglanguagepost.go deleted file mode 100644 index 2abe194a9..000000000 --- a/build/platformclientv2/userroutinglanguagepost.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Userroutinglanguagepost - Represents an organization language assigned to a user. When assigning to a user specify the organization langauge id as the id. -type Userroutinglanguagepost struct { - // Id - The id of the existing routing language to add to the user - Id *string `json:"id,omitempty"` - - - // Proficiency - Proficiency is a rating from 0.0 to 5.0 on how competent an agent is for a particular language. It is used when a queue is set to \"Best available language\" mode to allow acd interactions to target agents with higher proficiency ratings. - Proficiency *float64 `json:"proficiency,omitempty"` - - - // LanguageUri - URI to the organization language used by this user language. - LanguageUri *string `json:"languageUri,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userroutinglanguagepost) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userroutingskill.go b/build/platformclientv2/userroutingskill.go deleted file mode 100644 index 89a42781e..000000000 --- a/build/platformclientv2/userroutingskill.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Userroutingskill - Represents an organization skill assigned to a user. When assigning to a user specify the organization skill id as the id. -type Userroutingskill struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Proficiency - A rating from 0.0 to 5.0 that indicates how adept an agent is at a particular skill. When \"Best available skills\" is enabled for a queue in Genesys Cloud, ACD interactions in that queue are routed to agents with higher proficiency ratings. - Proficiency *float64 `json:"proficiency,omitempty"` - - - // State - Activate or deactivate this routing skill. - State *string `json:"state,omitempty"` - - - // SkillUri - URI to the organization skill used by this user skill. - SkillUri *string `json:"skillUri,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userroutingskill) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userroutingskillpost.go b/build/platformclientv2/userroutingskillpost.go deleted file mode 100644 index d4243e912..000000000 --- a/build/platformclientv2/userroutingskillpost.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Userroutingskillpost - Represents an organization skill assigned to a user. When assigning to a user specify the organization skill id as the id. -type Userroutingskillpost struct { - // Id - The id of the existing routing skill to add to the user - Id *string `json:"id,omitempty"` - - - // Proficiency - Proficiency is a rating from 0.0 to 5.0 on how competent an agent is for a particular skill. It is used when a queue is set to \"Best available skills\" mode to allow acd interactions to target agents with higher proficiency ratings. - Proficiency *float64 `json:"proficiency,omitempty"` - - - // SkillUri - URI to the organization skill used by this user skill. - SkillUri *string `json:"skillUri,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userroutingskillpost) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userroutingstatuserrorinfo.go b/build/platformclientv2/userroutingstatuserrorinfo.go deleted file mode 100644 index f8708dc46..000000000 --- a/build/platformclientv2/userroutingstatuserrorinfo.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Userroutingstatuserrorinfo -type Userroutingstatuserrorinfo struct { - // ErrorCode - ErrorCode *string `json:"errorCode,omitempty"` - - - // Status - Status *int `json:"status,omitempty"` - - - // CorrelationId - CorrelationId *string `json:"correlationId,omitempty"` - - - // UserMessage - UserMessage *string `json:"userMessage,omitempty"` - - - // UserParamsMessage - UserParamsMessage *string `json:"userParamsMessage,omitempty"` - - - // UserParams - UserParams *[]Userroutingstatususerparam `json:"userParams,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userroutingstatuserrorinfo) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userroutingstatusroutingstatus.go b/build/platformclientv2/userroutingstatusroutingstatus.go deleted file mode 100644 index 3b00aba93..000000000 --- a/build/platformclientv2/userroutingstatusroutingstatus.go +++ /dev/null @@ -1,22 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Userroutingstatusroutingstatus -type Userroutingstatusroutingstatus struct { - // Status - Status *string `json:"status,omitempty"` - - - // StartTime - StartTime *time.Time `json:"startTime,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userroutingstatusroutingstatus) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userroutingstatususerparam.go b/build/platformclientv2/userroutingstatususerparam.go deleted file mode 100644 index d6bc8adbe..000000000 --- a/build/platformclientv2/userroutingstatususerparam.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Userroutingstatususerparam -type Userroutingstatususerparam struct { - // Key - Key *string `json:"key,omitempty"` - - - // Value - Value *string `json:"value,omitempty"` - - - // AdditionalProperties - AdditionalProperties *map[string]interface{} `json:"additionalProperties,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userroutingstatususerparam) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userroutingstatususerroutingstatus.go b/build/platformclientv2/userroutingstatususerroutingstatus.go deleted file mode 100644 index 208277a04..000000000 --- a/build/platformclientv2/userroutingstatususerroutingstatus.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Userroutingstatususerroutingstatus -type Userroutingstatususerroutingstatus struct { - // RoutingStatus - RoutingStatus *Userroutingstatusroutingstatus `json:"routingStatus,omitempty"` - - - // ErrorInfo - ErrorInfo *Userroutingstatuserrorinfo `json:"errorInfo,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userroutingstatususerroutingstatus) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/usersapi.go b/build/platformclientv2/usersapi.go deleted file mode 100644 index faf88b7b2..000000000 --- a/build/platformclientv2/usersapi.go +++ /dev/null @@ -1,6483 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "encoding/json" -) - -// UsersApi provides functions for API endpoints -type UsersApi struct { - Configuration *Configuration -} - -// NewUsersApi creates an API instance using the default configuration -func NewUsersApi() *UsersApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating UsersApi with base path: %s", strings.ToLower(config.BasePath))) - return &UsersApi{ - Configuration: config, - } -} - -// NewUsersApiWithConfig creates an API instance using the provided configuration -func NewUsersApiWithConfig(config *Configuration) *UsersApi { - config.Debugf("Creating UsersApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &UsersApi{ - Configuration: config, - } -} - -// DeleteAnalyticsUsersDetailsJob invokes DELETE /api/v2/analytics/users/details/jobs/{jobId} -// -// Delete/cancel an async request -// -// -func (a UsersApi) DeleteAnalyticsUsersDetailsJob(jobId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/users/details/jobs/{jobId}" - path = strings.Replace(path, "{jobId}", fmt.Sprintf("%v", jobId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'jobId' is set - if &jobId == nil { - // - return nil, errors.New("Missing required parameter 'jobId' when calling UsersApi->DeleteAnalyticsUsersDetailsJob") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteAuthorizationSubjectDivisionRole invokes DELETE /api/v2/authorization/subjects/{subjectId}/divisions/{divisionId}/roles/{roleId} -// -// Delete a grant of a role in a division -// -// -func (a UsersApi) DeleteAuthorizationSubjectDivisionRole(subjectId string, divisionId string, roleId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/authorization/subjects/{subjectId}/divisions/{divisionId}/roles/{roleId}" - path = strings.Replace(path, "{subjectId}", fmt.Sprintf("%v", subjectId), -1) - path = strings.Replace(path, "{divisionId}", fmt.Sprintf("%v", divisionId), -1) - path = strings.Replace(path, "{roleId}", fmt.Sprintf("%v", roleId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'subjectId' is set - if &subjectId == nil { - // - return nil, errors.New("Missing required parameter 'subjectId' when calling UsersApi->DeleteAuthorizationSubjectDivisionRole") - } - // verify the required parameter 'divisionId' is set - if &divisionId == nil { - // - return nil, errors.New("Missing required parameter 'divisionId' when calling UsersApi->DeleteAuthorizationSubjectDivisionRole") - } - // verify the required parameter 'roleId' is set - if &roleId == nil { - // - return nil, errors.New("Missing required parameter 'roleId' when calling UsersApi->DeleteAuthorizationSubjectDivisionRole") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteRoutingUserUtilization invokes DELETE /api/v2/routing/users/{userId}/utilization -// -// Delete the user's max utilization settings and revert to the organization-wide default. -// -// -func (a UsersApi) DeleteRoutingUserUtilization(userId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/users/{userId}/utilization" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return nil, errors.New("Missing required parameter 'userId' when calling UsersApi->DeleteRoutingUserUtilization") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteUser invokes DELETE /api/v2/users/{userId} -// -// Delete user -// -// -func (a UsersApi) DeleteUser(userId string) (*Empty, *APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Empty) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling UsersApi->DeleteUser") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Empty - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// DeleteUserRoutinglanguage invokes DELETE /api/v2/users/{userId}/routinglanguages/{languageId} -// -// Remove routing language from user -// -// -func (a UsersApi) DeleteUserRoutinglanguage(userId string, languageId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/routinglanguages/{languageId}" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - path = strings.Replace(path, "{languageId}", fmt.Sprintf("%v", languageId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return nil, errors.New("Missing required parameter 'userId' when calling UsersApi->DeleteUserRoutinglanguage") - } - // verify the required parameter 'languageId' is set - if &languageId == nil { - // - return nil, errors.New("Missing required parameter 'languageId' when calling UsersApi->DeleteUserRoutinglanguage") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteUserRoutingskill invokes DELETE /api/v2/users/{userId}/routingskills/{skillId} -// -// Remove routing skill from user -// -// -func (a UsersApi) DeleteUserRoutingskill(userId string, skillId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/routingskills/{skillId}" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - path = strings.Replace(path, "{skillId}", fmt.Sprintf("%v", skillId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return nil, errors.New("Missing required parameter 'userId' when calling UsersApi->DeleteUserRoutingskill") - } - // verify the required parameter 'skillId' is set - if &skillId == nil { - // - return nil, errors.New("Missing required parameter 'skillId' when calling UsersApi->DeleteUserRoutingskill") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteUserStationAssociatedstation invokes DELETE /api/v2/users/{userId}/station/associatedstation -// -// Clear associated station -// -// -func (a UsersApi) DeleteUserStationAssociatedstation(userId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/station/associatedstation" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return nil, errors.New("Missing required parameter 'userId' when calling UsersApi->DeleteUserStationAssociatedstation") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteUserStationDefaultstation invokes DELETE /api/v2/users/{userId}/station/defaultstation -// -// Clear default station -// -// -func (a UsersApi) DeleteUserStationDefaultstation(userId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/station/defaultstation" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return nil, errors.New("Missing required parameter 'userId' when calling UsersApi->DeleteUserStationDefaultstation") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// GetAnalyticsUsersDetailsJob invokes GET /api/v2/analytics/users/details/jobs/{jobId} -// -// Get status for async query for user details -// -// -func (a UsersApi) GetAnalyticsUsersDetailsJob(jobId string) (*Asyncquerystatus, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/users/details/jobs/{jobId}" - path = strings.Replace(path, "{jobId}", fmt.Sprintf("%v", jobId), -1) - defaultReturn := new(Asyncquerystatus) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'jobId' is set - if &jobId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'jobId' when calling UsersApi->GetAnalyticsUsersDetailsJob") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Asyncquerystatus - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAnalyticsUsersDetailsJobResults invokes GET /api/v2/analytics/users/details/jobs/{jobId}/results -// -// Fetch a page of results for an async query -// -// -func (a UsersApi) GetAnalyticsUsersDetailsJobResults(jobId string, cursor string, pageSize int) (*Analyticsuserdetailsasyncqueryresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/users/details/jobs/{jobId}/results" - path = strings.Replace(path, "{jobId}", fmt.Sprintf("%v", jobId), -1) - defaultReturn := new(Analyticsuserdetailsasyncqueryresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'jobId' is set - if &jobId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'jobId' when calling UsersApi->GetAnalyticsUsersDetailsJobResults") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(cursor).(string); ok { - if str != "" { - queryParams["cursor"] = a.Configuration.APIClient.ParameterToString(cursor, collectionFormat) - } - } else { - queryParams["cursor"] = a.Configuration.APIClient.ParameterToString(cursor, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Analyticsuserdetailsasyncqueryresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAnalyticsUsersDetailsJobsAvailability invokes GET /api/v2/analytics/users/details/jobs/availability -// -// Lookup the datalake availability date and time -// -// -func (a UsersApi) GetAnalyticsUsersDetailsJobsAvailability() (*Dataavailabilityresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/users/details/jobs/availability" - defaultReturn := new(Dataavailabilityresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Dataavailabilityresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAuthorizationDivisionspermittedMe invokes GET /api/v2/authorization/divisionspermitted/me -// -// Returns which divisions the current user has the given permission in. -// -// This route is deprecated, use authorization/divisionspermitted/paged/me instead. -func (a UsersApi) GetAuthorizationDivisionspermittedMe(permission string, name string) ([]Authzdivision, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/authorization/divisionspermitted/me" - defaultReturn := make([]Authzdivision, 0) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'permission' is set - if &permission == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'permission' when calling UsersApi->GetAuthorizationDivisionspermittedMe") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(name).(string); ok { - if str != "" { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - } else { - queryParams["name"] = a.Configuration.APIClient.ParameterToString(name, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(permission).(string); ok { - if str != "" { - queryParams["permission"] = a.Configuration.APIClient.ParameterToString(permission, collectionFormat) - } - } else { - queryParams["permission"] = a.Configuration.APIClient.ParameterToString(permission, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload []Authzdivision - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAuthorizationDivisionspermittedPagedMe invokes GET /api/v2/authorization/divisionspermitted/paged/me -// -// Returns which divisions the current user has the given permission in. -// -// -func (a UsersApi) GetAuthorizationDivisionspermittedPagedMe(permission string, pageNumber int, pageSize int) (*Divspermittedentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/authorization/divisionspermitted/paged/me" - defaultReturn := new(Divspermittedentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'permission' is set - if &permission == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'permission' when calling UsersApi->GetAuthorizationDivisionspermittedPagedMe") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(permission).(string); ok { - if str != "" { - queryParams["permission"] = a.Configuration.APIClient.ParameterToString(permission, collectionFormat) - } - } else { - queryParams["permission"] = a.Configuration.APIClient.ParameterToString(permission, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Divspermittedentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAuthorizationDivisionspermittedPagedSubjectId invokes GET /api/v2/authorization/divisionspermitted/paged/{subjectId} -// -// Returns which divisions the specified user has the given permission in. -// -// This route is deprecated, use authorization/divisionspermitted/paged/me instead. -func (a UsersApi) GetAuthorizationDivisionspermittedPagedSubjectId(subjectId string, permission string, pageNumber int, pageSize int) (*Divspermittedentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/authorization/divisionspermitted/paged/{subjectId}" - path = strings.Replace(path, "{subjectId}", fmt.Sprintf("%v", subjectId), -1) - defaultReturn := new(Divspermittedentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'subjectId' is set - if &subjectId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'subjectId' when calling UsersApi->GetAuthorizationDivisionspermittedPagedSubjectId") - } - // verify the required parameter 'permission' is set - if &permission == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'permission' when calling UsersApi->GetAuthorizationDivisionspermittedPagedSubjectId") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(permission).(string); ok { - if str != "" { - queryParams["permission"] = a.Configuration.APIClient.ParameterToString(permission, collectionFormat) - } - } else { - queryParams["permission"] = a.Configuration.APIClient.ParameterToString(permission, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Divspermittedentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAuthorizationSubject invokes GET /api/v2/authorization/subjects/{subjectId} -// -// Returns a listing of roles and permissions for a user. -// -// -func (a UsersApi) GetAuthorizationSubject(subjectId string) (*Authzsubject, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/authorization/subjects/{subjectId}" - path = strings.Replace(path, "{subjectId}", fmt.Sprintf("%v", subjectId), -1) - defaultReturn := new(Authzsubject) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'subjectId' is set - if &subjectId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'subjectId' when calling UsersApi->GetAuthorizationSubject") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Authzsubject - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetAuthorizationSubjectsMe invokes GET /api/v2/authorization/subjects/me -// -// Returns a listing of roles and permissions for the currently authenticated user. -// -// -func (a UsersApi) GetAuthorizationSubjectsMe() (*Authzsubject, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/authorization/subjects/me" - defaultReturn := new(Authzsubject) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Authzsubject - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetFieldconfig invokes GET /api/v2/fieldconfig -// -// Fetch field config for an entity type -// -// -func (a UsersApi) GetFieldconfig(varType string) (*Fieldconfig, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/fieldconfig" - defaultReturn := new(Fieldconfig) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'varType' is set - if &varType == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'varType' when calling UsersApi->GetFieldconfig") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(varType).(string); ok { - if str != "" { - queryParams["varType"] = a.Configuration.APIClient.ParameterToString(varType, collectionFormat) - } - } else { - queryParams["varType"] = a.Configuration.APIClient.ParameterToString(varType, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Fieldconfig - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetProfilesUsers invokes GET /api/v2/profiles/users -// -// Get a user profile listing -// -// This api is deprecated. User /api/v2/users -func (a UsersApi) GetProfilesUsers(pageSize int, pageNumber int, id []string, jid []string, sortOrder string, expand []string, integrationPresenceSource string) (*Userprofileentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/profiles/users" - defaultReturn := new(Userprofileentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range id { - queryParams["id"] = value - } - } else { - queryParams["id"] = a.Configuration.APIClient.ParameterToString(id, collectionFormat) - } - - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range jid { - queryParams["jid"] = value - } - } else { - queryParams["jid"] = a.Configuration.APIClient.ParameterToString(jid, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(integrationPresenceSource).(string); ok { - if str != "" { - queryParams["integrationPresenceSource"] = a.Configuration.APIClient.ParameterToString(integrationPresenceSource, collectionFormat) - } - } else { - queryParams["integrationPresenceSource"] = a.Configuration.APIClient.ParameterToString(integrationPresenceSource, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Userprofileentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetRoutingUserUtilization invokes GET /api/v2/routing/users/{userId}/utilization -// -// Get the user's max utilization settings. If not configured, the organization-wide default is returned. -// -// -func (a UsersApi) GetRoutingUserUtilization(userId string) (*Utilization, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/users/{userId}/utilization" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Utilization) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling UsersApi->GetRoutingUserUtilization") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Utilization - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetUser invokes GET /api/v2/users/{userId} -// -// Get user. -// -// -func (a UsersApi) GetUser(userId string, expand []string, integrationPresenceSource string, state string) (*User, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(User) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling UsersApi->GetUser") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(integrationPresenceSource).(string); ok { - if str != "" { - queryParams["integrationPresenceSource"] = a.Configuration.APIClient.ParameterToString(integrationPresenceSource, collectionFormat) - } - } else { - queryParams["integrationPresenceSource"] = a.Configuration.APIClient.ParameterToString(integrationPresenceSource, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(state).(string); ok { - if str != "" { - queryParams["state"] = a.Configuration.APIClient.ParameterToString(state, collectionFormat) - } - } else { - queryParams["state"] = a.Configuration.APIClient.ParameterToString(state, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *User - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetUserAdjacents invokes GET /api/v2/users/{userId}/adjacents -// -// Get adjacents -// -// -func (a UsersApi) GetUserAdjacents(userId string, expand []string) (*Adjacents, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/adjacents" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Adjacents) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling UsersApi->GetUserAdjacents") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Adjacents - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetUserCallforwarding invokes GET /api/v2/users/{userId}/callforwarding -// -// Get a user's CallForwarding -// -// -func (a UsersApi) GetUserCallforwarding(userId string) (*Callforwarding, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/callforwarding" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Callforwarding) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling UsersApi->GetUserCallforwarding") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Callforwarding - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetUserDirectreports invokes GET /api/v2/users/{userId}/directreports -// -// Get direct reports -// -// -func (a UsersApi) GetUserDirectreports(userId string, expand []string) ([]User, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/directreports" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := make([]User, 0) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling UsersApi->GetUserDirectreports") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload []User - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetUserFavorites invokes GET /api/v2/users/{userId}/favorites -// -// Get favorites -// -// -func (a UsersApi) GetUserFavorites(userId string, pageSize int, pageNumber int, sortOrder string, expand []string) (*Userentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/favorites" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Userentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling UsersApi->GetUserFavorites") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Userentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetUserGeolocation invokes GET /api/v2/users/{userId}/geolocations/{clientId} -// -// Get a user's Geolocation -// -// -func (a UsersApi) GetUserGeolocation(userId string, clientId string) (*Geolocation, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/geolocations/{clientId}" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - path = strings.Replace(path, "{clientId}", fmt.Sprintf("%v", clientId), -1) - defaultReturn := new(Geolocation) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling UsersApi->GetUserGeolocation") - } - // verify the required parameter 'clientId' is set - if &clientId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'clientId' when calling UsersApi->GetUserGeolocation") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Geolocation - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetUserOutofoffice invokes GET /api/v2/users/{userId}/outofoffice -// -// Get a OutOfOffice -// -// -func (a UsersApi) GetUserOutofoffice(userId string) (*Outofoffice, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/outofoffice" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Outofoffice) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling UsersApi->GetUserOutofoffice") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Outofoffice - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetUserProfile invokes GET /api/v2/users/{userId}/profile -// -// Get user profile -// -// This api has been deprecated. Use api/v2/users instead -func (a UsersApi) GetUserProfile(userId string, expand []string, integrationPresenceSource string) (*Userprofile, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/profile" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Userprofile) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling UsersApi->GetUserProfile") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(integrationPresenceSource).(string); ok { - if str != "" { - queryParams["integrationPresenceSource"] = a.Configuration.APIClient.ParameterToString(integrationPresenceSource, collectionFormat) - } - } else { - queryParams["integrationPresenceSource"] = a.Configuration.APIClient.ParameterToString(integrationPresenceSource, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Userprofile - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetUserProfileskills invokes GET /api/v2/users/{userId}/profileskills -// -// List profile skills for a user -// -// -func (a UsersApi) GetUserProfileskills(userId string) ([]string, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/profileskills" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := make([]string, 0) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling UsersApi->GetUserProfileskills") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload []string - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetUserQueues invokes GET /api/v2/users/{userId}/queues -// -// Get queues for user -// -// -func (a UsersApi) GetUserQueues(userId string, pageSize int, pageNumber int, joined bool, divisionId []string) (*Userqueueentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/queues" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Userqueueentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling UsersApi->GetUserQueues") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(joined).(string); ok { - if str != "" { - queryParams["joined"] = a.Configuration.APIClient.ParameterToString(joined, collectionFormat) - } - } else { - queryParams["joined"] = a.Configuration.APIClient.ParameterToString(joined, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range divisionId { - queryParams["divisionId"] = value - } - } else { - queryParams["divisionId"] = a.Configuration.APIClient.ParameterToString(divisionId, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Userqueueentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetUserRoles invokes GET /api/v2/users/{userId}/roles -// -// Returns a listing of roles and permissions for a user. -// -// -func (a UsersApi) GetUserRoles(userId string) (*Userauthorization, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/roles" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Userauthorization) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling UsersApi->GetUserRoles") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Userauthorization - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetUserRoutinglanguages invokes GET /api/v2/users/{userId}/routinglanguages -// -// List routing language for user -// -// -func (a UsersApi) GetUserRoutinglanguages(userId string, pageSize int, pageNumber int, sortOrder string) (*Userlanguageentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/routinglanguages" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Userlanguageentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling UsersApi->GetUserRoutinglanguages") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Userlanguageentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetUserRoutingskills invokes GET /api/v2/users/{userId}/routingskills -// -// List routing skills for user -// -// -func (a UsersApi) GetUserRoutingskills(userId string, pageSize int, pageNumber int, sortOrder string) (*Userskillentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/routingskills" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Userskillentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling UsersApi->GetUserRoutingskills") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Userskillentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetUserRoutingstatus invokes GET /api/v2/users/{userId}/routingstatus -// -// Fetch the routing status of a user -// -// -func (a UsersApi) GetUserRoutingstatus(userId string) (*Routingstatus, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/routingstatus" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Routingstatus) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling UsersApi->GetUserRoutingstatus") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Routingstatus - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetUserStation invokes GET /api/v2/users/{userId}/station -// -// Get station information for user -// -// -func (a UsersApi) GetUserStation(userId string) (*Userstations, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/station" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Userstations) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling UsersApi->GetUserStation") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Userstations - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetUserSuperiors invokes GET /api/v2/users/{userId}/superiors -// -// Get superiors -// -// -func (a UsersApi) GetUserSuperiors(userId string, expand []string) ([]User, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/superiors" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := make([]User, 0) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling UsersApi->GetUserSuperiors") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload []User - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetUserTrustors invokes GET /api/v2/users/{userId}/trustors -// -// List the organizations that have authorized/trusted the user. -// -// -func (a UsersApi) GetUserTrustors(userId string, pageSize int, pageNumber int) (*Trustorentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/trustors" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Trustorentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling UsersApi->GetUserTrustors") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Trustorentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetUsers invokes GET /api/v2/users -// -// Get the list of available users. -// -// -func (a UsersApi) GetUsers(pageSize int, pageNumber int, id []string, jabberId []string, sortOrder string, expand []string, integrationPresenceSource string, state string) (*Userentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users" - defaultReturn := new(Userentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range id { - queryParams["id"] = value - } - } else { - queryParams["id"] = a.Configuration.APIClient.ParameterToString(id, collectionFormat) - } - - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range jabberId { - queryParams["jabberId"] = value - } - } else { - queryParams["jabberId"] = a.Configuration.APIClient.ParameterToString(jabberId, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(integrationPresenceSource).(string); ok { - if str != "" { - queryParams["integrationPresenceSource"] = a.Configuration.APIClient.ParameterToString(integrationPresenceSource, collectionFormat) - } - } else { - queryParams["integrationPresenceSource"] = a.Configuration.APIClient.ParameterToString(integrationPresenceSource, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(state).(string); ok { - if str != "" { - queryParams["state"] = a.Configuration.APIClient.ParameterToString(state, collectionFormat) - } - } else { - queryParams["state"] = a.Configuration.APIClient.ParameterToString(state, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Userentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetUsersDevelopmentActivities invokes GET /api/v2/users/development/activities -// -// Get list of Development Activities -// -// Either moduleId or userId is required. Results are filtered based on the applicable permissions. -func (a UsersApi) GetUsersDevelopmentActivities(userId []string, moduleId string, interval string, completionInterval string, overdue string, pageSize int, pageNumber int, sortOrder string, types []string, statuses []string, relationship []string) (*Developmentactivitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/development/activities" - defaultReturn := new(Developmentactivitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range userId { - queryParams["userId"] = value - } - } else { - queryParams["userId"] = a.Configuration.APIClient.ParameterToString(userId, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(moduleId).(string); ok { - if str != "" { - queryParams["moduleId"] = a.Configuration.APIClient.ParameterToString(moduleId, collectionFormat) - } - } else { - queryParams["moduleId"] = a.Configuration.APIClient.ParameterToString(moduleId, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(interval).(string); ok { - if str != "" { - queryParams["interval"] = a.Configuration.APIClient.ParameterToString(interval, collectionFormat) - } - } else { - queryParams["interval"] = a.Configuration.APIClient.ParameterToString(interval, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(completionInterval).(string); ok { - if str != "" { - queryParams["completionInterval"] = a.Configuration.APIClient.ParameterToString(completionInterval, collectionFormat) - } - } else { - queryParams["completionInterval"] = a.Configuration.APIClient.ParameterToString(completionInterval, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(overdue).(string); ok { - if str != "" { - queryParams["overdue"] = a.Configuration.APIClient.ParameterToString(overdue, collectionFormat) - } - } else { - queryParams["overdue"] = a.Configuration.APIClient.ParameterToString(overdue, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range types { - queryParams["types"] = value - } - } else { - queryParams["types"] = a.Configuration.APIClient.ParameterToString(types, collectionFormat) - } - - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range statuses { - queryParams["statuses"] = value - } - } else { - queryParams["statuses"] = a.Configuration.APIClient.ParameterToString(statuses, collectionFormat) - } - - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range relationship { - queryParams["relationship"] = value - } - } else { - queryParams["relationship"] = a.Configuration.APIClient.ParameterToString(relationship, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Developmentactivitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetUsersDevelopmentActivitiesMe invokes GET /api/v2/users/development/activities/me -// -// Get list of Development Activities for current user -// -// Results are filtered based on the applicable permissions. -func (a UsersApi) GetUsersDevelopmentActivitiesMe(moduleId string, interval string, completionInterval string, overdue string, pageSize int, pageNumber int, sortOrder string, types []string, statuses []string, relationship []string) (*Developmentactivitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/development/activities/me" - defaultReturn := new(Developmentactivitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(moduleId).(string); ok { - if str != "" { - queryParams["moduleId"] = a.Configuration.APIClient.ParameterToString(moduleId, collectionFormat) - } - } else { - queryParams["moduleId"] = a.Configuration.APIClient.ParameterToString(moduleId, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(interval).(string); ok { - if str != "" { - queryParams["interval"] = a.Configuration.APIClient.ParameterToString(interval, collectionFormat) - } - } else { - queryParams["interval"] = a.Configuration.APIClient.ParameterToString(interval, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(completionInterval).(string); ok { - if str != "" { - queryParams["completionInterval"] = a.Configuration.APIClient.ParameterToString(completionInterval, collectionFormat) - } - } else { - queryParams["completionInterval"] = a.Configuration.APIClient.ParameterToString(completionInterval, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(overdue).(string); ok { - if str != "" { - queryParams["overdue"] = a.Configuration.APIClient.ParameterToString(overdue, collectionFormat) - } - } else { - queryParams["overdue"] = a.Configuration.APIClient.ParameterToString(overdue, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range types { - queryParams["types"] = value - } - } else { - queryParams["types"] = a.Configuration.APIClient.ParameterToString(types, collectionFormat) - } - - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range statuses { - queryParams["statuses"] = value - } - } else { - queryParams["statuses"] = a.Configuration.APIClient.ParameterToString(statuses, collectionFormat) - } - - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range relationship { - queryParams["relationship"] = value - } - } else { - queryParams["relationship"] = a.Configuration.APIClient.ParameterToString(relationship, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Developmentactivitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetUsersDevelopmentActivity invokes GET /api/v2/users/development/activities/{activityId} -// -// Get a Development Activity -// -// Permission not required if you are the attendee, creator or facilitator of the coaching appointment or you are the assigned user of the learning assignment. -func (a UsersApi) GetUsersDevelopmentActivity(activityId string, varType string) (*Developmentactivity, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/development/activities/{activityId}" - path = strings.Replace(path, "{activityId}", fmt.Sprintf("%v", activityId), -1) - defaultReturn := new(Developmentactivity) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'activityId' is set - if &activityId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'activityId' when calling UsersApi->GetUsersDevelopmentActivity") - } - // verify the required parameter 'varType' is set - if &varType == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'varType' when calling UsersApi->GetUsersDevelopmentActivity") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(varType).(string); ok { - if str != "" { - queryParams["varType"] = a.Configuration.APIClient.ParameterToString(varType, collectionFormat) - } - } else { - queryParams["varType"] = a.Configuration.APIClient.ParameterToString(varType, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Developmentactivity - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetUsersMe invokes GET /api/v2/users/me -// -// Get current user details. -// -// This request is not valid when using the Client Credentials OAuth grant. -func (a UsersApi) GetUsersMe(expand []string, integrationPresenceSource string) (*Userme, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/me" - defaultReturn := new(Userme) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(integrationPresenceSource).(string); ok { - if str != "" { - queryParams["integrationPresenceSource"] = a.Configuration.APIClient.ParameterToString(integrationPresenceSource, collectionFormat) - } - } else { - queryParams["integrationPresenceSource"] = a.Configuration.APIClient.ParameterToString(integrationPresenceSource, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Userme - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetUsersSearch invokes GET /api/v2/users/search -// -// Search users using the q64 value returned from a previous search -// -// -func (a UsersApi) GetUsersSearch(q64 string, expand []string, integrationPresenceSource string) (*Userssearchresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/search" - defaultReturn := new(Userssearchresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'q64' is set - if &q64 == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'q64' when calling UsersApi->GetUsersSearch") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(q64).(string); ok { - if str != "" { - queryParams["q64"] = a.Configuration.APIClient.ParameterToString(q64, collectionFormat) - } - } else { - queryParams["q64"] = a.Configuration.APIClient.ParameterToString(q64, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - - collectionFormat = "" - if str, ok := interface{}(integrationPresenceSource).(string); ok { - if str != "" { - queryParams["integrationPresenceSource"] = a.Configuration.APIClient.ParameterToString(integrationPresenceSource, collectionFormat) - } - } else { - queryParams["integrationPresenceSource"] = a.Configuration.APIClient.ParameterToString(integrationPresenceSource, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Userssearchresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchUser invokes PATCH /api/v2/users/{userId} -// -// Update user -// -// -func (a UsersApi) PatchUser(userId string, body Updateuser) (*User, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(User) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling UsersApi->PatchUser") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling UsersApi->PatchUser") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *User - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchUserCallforwarding invokes PATCH /api/v2/users/{userId}/callforwarding -// -// Patch a user's CallForwarding -// -// -func (a UsersApi) PatchUserCallforwarding(userId string, body Callforwarding) (*Callforwarding, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/callforwarding" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Callforwarding) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling UsersApi->PatchUserCallforwarding") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling UsersApi->PatchUserCallforwarding") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Callforwarding - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchUserGeolocation invokes PATCH /api/v2/users/{userId}/geolocations/{clientId} -// -// Patch a user's Geolocation -// -// The geolocation object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the client as the user's primary geolocation source. Option 2: Provide the 'latitude' and 'longitude' values. This will enqueue an asynchronous update of the 'city', 'region', and 'country', generating a notification. A subsequent GET operation will include the new values for 'city', 'region' and 'country'. Option 3: Provide the 'city', 'region', 'country' values. Option 1 can be combined with Option 2 or Option 3. For example, update the client as primary and provide latitude and longitude values. -func (a UsersApi) PatchUserGeolocation(userId string, clientId string, body Geolocation) (*Geolocation, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/geolocations/{clientId}" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - path = strings.Replace(path, "{clientId}", fmt.Sprintf("%v", clientId), -1) - defaultReturn := new(Geolocation) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling UsersApi->PatchUserGeolocation") - } - // verify the required parameter 'clientId' is set - if &clientId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'clientId' when calling UsersApi->PatchUserGeolocation") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling UsersApi->PatchUserGeolocation") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Geolocation - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchUserQueue invokes PATCH /api/v2/users/{userId}/queues/{queueId} -// -// Join or unjoin a queue for a user -// -// -func (a UsersApi) PatchUserQueue(queueId string, userId string, body Userqueue) (*Userqueue, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/queues/{queueId}" - path = strings.Replace(path, "{queueId}", fmt.Sprintf("%v", queueId), -1) - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Userqueue) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'queueId' is set - if &queueId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'queueId' when calling UsersApi->PatchUserQueue") - } - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling UsersApi->PatchUserQueue") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling UsersApi->PatchUserQueue") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Userqueue - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchUserQueues invokes PATCH /api/v2/users/{userId}/queues -// -// Join or unjoin a set of queues for a user -// -// -func (a UsersApi) PatchUserQueues(userId string, body []Userqueue, divisionId []string) (*Userqueueentitylisting, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/queues" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Userqueueentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling UsersApi->PatchUserQueues") - } - // verify the required parameter 'body' is set - if &body == nil { - // true - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling UsersApi->PatchUserQueues") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range divisionId { - queryParams["divisionId"] = value - } - } else { - queryParams["divisionId"] = a.Configuration.APIClient.ParameterToString(divisionId, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Userqueueentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchUserRoutinglanguage invokes PATCH /api/v2/users/{userId}/routinglanguages/{languageId} -// -// Update routing language proficiency or state. -// -// -func (a UsersApi) PatchUserRoutinglanguage(userId string, languageId string, body Userroutinglanguage) (*Userroutinglanguage, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/routinglanguages/{languageId}" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - path = strings.Replace(path, "{languageId}", fmt.Sprintf("%v", languageId), -1) - defaultReturn := new(Userroutinglanguage) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling UsersApi->PatchUserRoutinglanguage") - } - // verify the required parameter 'languageId' is set - if &languageId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'languageId' when calling UsersApi->PatchUserRoutinglanguage") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling UsersApi->PatchUserRoutinglanguage") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Userroutinglanguage - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchUserRoutinglanguagesBulk invokes PATCH /api/v2/users/{userId}/routinglanguages/bulk -// -// Add bulk routing language to user. Max limit 50 languages -// -// -func (a UsersApi) PatchUserRoutinglanguagesBulk(userId string, body []Userroutinglanguagepost) (*Userlanguageentitylisting, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/routinglanguages/bulk" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Userlanguageentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling UsersApi->PatchUserRoutinglanguagesBulk") - } - // verify the required parameter 'body' is set - if &body == nil { - // true - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling UsersApi->PatchUserRoutinglanguagesBulk") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Userlanguageentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchUserRoutingskillsBulk invokes PATCH /api/v2/users/{userId}/routingskills/bulk -// -// Bulk add routing skills to user -// -// -func (a UsersApi) PatchUserRoutingskillsBulk(userId string, body []Userroutingskillpost) (*Userskillentitylisting, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/routingskills/bulk" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Userskillentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling UsersApi->PatchUserRoutingskillsBulk") - } - // verify the required parameter 'body' is set - if &body == nil { - // true - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling UsersApi->PatchUserRoutingskillsBulk") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Userskillentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchUsersBulk invokes PATCH /api/v2/users/bulk -// -// Update bulk acd autoanswer on users -// -// -func (a UsersApi) PatchUsersBulk(body []Patchuser) (*Userentitylisting, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/bulk" - defaultReturn := new(Userentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // true - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling UsersApi->PatchUsersBulk") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Userentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostAnalyticsUsersAggregatesQuery invokes POST /api/v2/analytics/users/aggregates/query -// -// Query for user aggregates -// -// -func (a UsersApi) PostAnalyticsUsersAggregatesQuery(body Useraggregationquery) (*Useraggregatequeryresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/users/aggregates/query" - defaultReturn := new(Useraggregatequeryresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling UsersApi->PostAnalyticsUsersAggregatesQuery") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Useraggregatequeryresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostAnalyticsUsersDetailsJobs invokes POST /api/v2/analytics/users/details/jobs -// -// Query for user details asynchronously -// -// -func (a UsersApi) PostAnalyticsUsersDetailsJobs(body Asyncuserdetailsquery) (*Asyncqueryresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/users/details/jobs" - defaultReturn := new(Asyncqueryresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling UsersApi->PostAnalyticsUsersDetailsJobs") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Asyncqueryresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostAnalyticsUsersDetailsQuery invokes POST /api/v2/analytics/users/details/query -// -// Query for user details -// -// -func (a UsersApi) PostAnalyticsUsersDetailsQuery(body Userdetailsquery) (*Analyticsuserdetailsqueryresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/users/details/query" - defaultReturn := new(Analyticsuserdetailsqueryresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling UsersApi->PostAnalyticsUsersDetailsQuery") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Analyticsuserdetailsqueryresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostAnalyticsUsersObservationsQuery invokes POST /api/v2/analytics/users/observations/query -// -// Query for user observations -// -// -func (a UsersApi) PostAnalyticsUsersObservationsQuery(body Userobservationquery) (*Userobservationqueryresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/analytics/users/observations/query" - defaultReturn := new(Userobservationqueryresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling UsersApi->PostAnalyticsUsersObservationsQuery") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Userobservationqueryresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostAuthorizationSubjectBulkadd invokes POST /api/v2/authorization/subjects/{subjectId}/bulkadd -// -// Bulk-grant roles and divisions to a subject. -// -// -func (a UsersApi) PostAuthorizationSubjectBulkadd(subjectId string, body Roledivisiongrants, subjectType string) (*APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/authorization/subjects/{subjectId}/bulkadd" - path = strings.Replace(path, "{subjectId}", fmt.Sprintf("%v", subjectId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'subjectId' is set - if &subjectId == nil { - // - return nil, errors.New("Missing required parameter 'subjectId' when calling UsersApi->PostAuthorizationSubjectBulkadd") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return nil, errors.New("Missing required parameter 'body' when calling UsersApi->PostAuthorizationSubjectBulkadd") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(subjectType).(string); ok { - if str != "" { - queryParams["subjectType"] = a.Configuration.APIClient.ParameterToString(subjectType, collectionFormat) - } - } else { - queryParams["subjectType"] = a.Configuration.APIClient.ParameterToString(subjectType, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// PostAuthorizationSubjectBulkremove invokes POST /api/v2/authorization/subjects/{subjectId}/bulkremove -// -// Bulk-remove grants from a subject. -// -// -func (a UsersApi) PostAuthorizationSubjectBulkremove(subjectId string, body Roledivisiongrants) (*APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/authorization/subjects/{subjectId}/bulkremove" - path = strings.Replace(path, "{subjectId}", fmt.Sprintf("%v", subjectId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'subjectId' is set - if &subjectId == nil { - // - return nil, errors.New("Missing required parameter 'subjectId' when calling UsersApi->PostAuthorizationSubjectBulkremove") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return nil, errors.New("Missing required parameter 'body' when calling UsersApi->PostAuthorizationSubjectBulkremove") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// PostAuthorizationSubjectDivisionRole invokes POST /api/v2/authorization/subjects/{subjectId}/divisions/{divisionId}/roles/{roleId} -// -// Make a grant of a role in a division -// -// -func (a UsersApi) PostAuthorizationSubjectDivisionRole(subjectId string, divisionId string, roleId string, subjectType string) (*APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/authorization/subjects/{subjectId}/divisions/{divisionId}/roles/{roleId}" - path = strings.Replace(path, "{subjectId}", fmt.Sprintf("%v", subjectId), -1) - path = strings.Replace(path, "{divisionId}", fmt.Sprintf("%v", divisionId), -1) - path = strings.Replace(path, "{roleId}", fmt.Sprintf("%v", roleId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'subjectId' is set - if &subjectId == nil { - // - return nil, errors.New("Missing required parameter 'subjectId' when calling UsersApi->PostAuthorizationSubjectDivisionRole") - } - // verify the required parameter 'divisionId' is set - if &divisionId == nil { - // - return nil, errors.New("Missing required parameter 'divisionId' when calling UsersApi->PostAuthorizationSubjectDivisionRole") - } - // verify the required parameter 'roleId' is set - if &roleId == nil { - // - return nil, errors.New("Missing required parameter 'roleId' when calling UsersApi->PostAuthorizationSubjectDivisionRole") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(subjectType).(string); ok { - if str != "" { - queryParams["subjectType"] = a.Configuration.APIClient.ParameterToString(subjectType, collectionFormat) - } - } else { - queryParams["subjectType"] = a.Configuration.APIClient.ParameterToString(subjectType, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// PostUserInvite invokes POST /api/v2/users/{userId}/invite -// -// Send an activation email to the user -// -// -func (a UsersApi) PostUserInvite(userId string, force bool) (*APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/invite" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return nil, errors.New("Missing required parameter 'userId' when calling UsersApi->PostUserInvite") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(force).(string); ok { - if str != "" { - queryParams["force"] = a.Configuration.APIClient.ParameterToString(force, collectionFormat) - } - } else { - queryParams["force"] = a.Configuration.APIClient.ParameterToString(force, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// PostUserPassword invokes POST /api/v2/users/{userId}/password -// -// Change a users password -// -// -func (a UsersApi) PostUserPassword(userId string, body Changepasswordrequest) (*APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/password" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return nil, errors.New("Missing required parameter 'userId' when calling UsersApi->PostUserPassword") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return nil, errors.New("Missing required parameter 'body' when calling UsersApi->PostUserPassword") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// PostUserRoutinglanguages invokes POST /api/v2/users/{userId}/routinglanguages -// -// Add routing language to user -// -// -func (a UsersApi) PostUserRoutinglanguages(userId string, body Userroutinglanguagepost) (*Userroutinglanguage, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/routinglanguages" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Userroutinglanguage) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling UsersApi->PostUserRoutinglanguages") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling UsersApi->PostUserRoutinglanguages") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Userroutinglanguage - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostUserRoutingskills invokes POST /api/v2/users/{userId}/routingskills -// -// Add routing skill to user -// -// -func (a UsersApi) PostUserRoutingskills(userId string, body Userroutingskillpost) (*Userroutingskill, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/routingskills" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Userroutingskill) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling UsersApi->PostUserRoutingskills") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling UsersApi->PostUserRoutingskills") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Userroutingskill - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostUsers invokes POST /api/v2/users -// -// Create user -// -// -func (a UsersApi) PostUsers(body Createuser) (*User, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users" - defaultReturn := new(User) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling UsersApi->PostUsers") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *User - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostUsersDevelopmentActivitiesAggregatesQuery invokes POST /api/v2/users/development/activities/aggregates/query -// -// Retrieve aggregated development activity data -// -// Results are filtered based on the applicable permissions. -func (a UsersApi) PostUsersDevelopmentActivitiesAggregatesQuery(body Developmentactivityaggregateparam) (*Developmentactivityaggregateresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/development/activities/aggregates/query" - defaultReturn := new(Developmentactivityaggregateresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling UsersApi->PostUsersDevelopmentActivitiesAggregatesQuery") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Developmentactivityaggregateresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostUsersMePassword invokes POST /api/v2/users/me/password -// -// Change your password -// -// -func (a UsersApi) PostUsersMePassword(body Changemypasswordrequest) (*APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/me/password" - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return nil, errors.New("Missing required parameter 'body' when calling UsersApi->PostUsersMePassword") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// PostUsersSearch invokes POST /api/v2/users/search -// -// Search users -// -// -func (a UsersApi) PostUsersSearch(body Usersearchrequest) (*Userssearchresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/search" - defaultReturn := new(Userssearchresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling UsersApi->PostUsersSearch") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Userssearchresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutRoutingUserUtilization invokes PUT /api/v2/routing/users/{userId}/utilization -// -// Update the user's max utilization settings. Include only those media types requiring custom configuration. -// -// -func (a UsersApi) PutRoutingUserUtilization(userId string, body Utilization) (*Utilization, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/routing/users/{userId}/utilization" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Utilization) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling UsersApi->PutRoutingUserUtilization") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling UsersApi->PutRoutingUserUtilization") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Utilization - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutUserCallforwarding invokes PUT /api/v2/users/{userId}/callforwarding -// -// Update a user's CallForwarding -// -// -func (a UsersApi) PutUserCallforwarding(userId string, body Callforwarding) (*Callforwarding, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/callforwarding" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Callforwarding) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling UsersApi->PutUserCallforwarding") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling UsersApi->PutUserCallforwarding") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Callforwarding - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutUserOutofoffice invokes PUT /api/v2/users/{userId}/outofoffice -// -// Update an OutOfOffice -// -// -func (a UsersApi) PutUserOutofoffice(userId string, body Outofoffice) (*Outofoffice, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/outofoffice" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Outofoffice) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling UsersApi->PutUserOutofoffice") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling UsersApi->PutUserOutofoffice") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Outofoffice - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutUserProfileskills invokes PUT /api/v2/users/{userId}/profileskills -// -// Update profile skills for a user -// -// -func (a UsersApi) PutUserProfileskills(userId string, body []string) ([]string, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/profileskills" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := make([]string, 0) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling UsersApi->PutUserProfileskills") - } - // verify the required parameter 'body' is set - if &body == nil { - // true - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling UsersApi->PutUserProfileskills") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload []string - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutUserRoles invokes PUT /api/v2/users/{userId}/roles -// -// Sets the user's roles -// -// -func (a UsersApi) PutUserRoles(userId string, body []string) (*Userauthorization, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/roles" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Userauthorization) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling UsersApi->PutUserRoles") - } - // verify the required parameter 'body' is set - if &body == nil { - // true - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling UsersApi->PutUserRoles") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Userauthorization - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutUserRoutingskill invokes PUT /api/v2/users/{userId}/routingskills/{skillId} -// -// Update routing skill proficiency or state. -// -// -func (a UsersApi) PutUserRoutingskill(userId string, skillId string, body Userroutingskill) (*Userroutingskill, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/routingskills/{skillId}" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - path = strings.Replace(path, "{skillId}", fmt.Sprintf("%v", skillId), -1) - defaultReturn := new(Userroutingskill) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling UsersApi->PutUserRoutingskill") - } - // verify the required parameter 'skillId' is set - if &skillId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'skillId' when calling UsersApi->PutUserRoutingskill") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling UsersApi->PutUserRoutingskill") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Userroutingskill - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutUserRoutingskillsBulk invokes PUT /api/v2/users/{userId}/routingskills/bulk -// -// Replace all routing skills assigned to a user -// -// -func (a UsersApi) PutUserRoutingskillsBulk(userId string, body []Userroutingskillpost) (*Userskillentitylisting, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/routingskills/bulk" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Userskillentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling UsersApi->PutUserRoutingskillsBulk") - } - // verify the required parameter 'body' is set - if &body == nil { - // true - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling UsersApi->PutUserRoutingskillsBulk") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Userskillentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutUserRoutingstatus invokes PUT /api/v2/users/{userId}/routingstatus -// -// Update the routing status of a user -// -// -func (a UsersApi) PutUserRoutingstatus(userId string, body Routingstatus) (*Routingstatus, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/routingstatus" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Routingstatus) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling UsersApi->PutUserRoutingstatus") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling UsersApi->PutUserRoutingstatus") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Routingstatus - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutUserStationAssociatedstationStationId invokes PUT /api/v2/users/{userId}/station/associatedstation/{stationId} -// -// Set associated station -// -// -func (a UsersApi) PutUserStationAssociatedstationStationId(userId string, stationId string) (*APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/station/associatedstation/{stationId}" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - path = strings.Replace(path, "{stationId}", fmt.Sprintf("%v", stationId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return nil, errors.New("Missing required parameter 'userId' when calling UsersApi->PutUserStationAssociatedstationStationId") - } - // verify the required parameter 'stationId' is set - if &stationId == nil { - // - return nil, errors.New("Missing required parameter 'stationId' when calling UsersApi->PutUserStationAssociatedstationStationId") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// PutUserStationDefaultstationStationId invokes PUT /api/v2/users/{userId}/station/defaultstation/{stationId} -// -// Set default station -// -// -func (a UsersApi) PutUserStationDefaultstationStationId(userId string, stationId string) (*APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/users/{userId}/station/defaultstation/{stationId}" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - path = strings.Replace(path, "{stationId}", fmt.Sprintf("%v", stationId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return nil, errors.New("Missing required parameter 'userId' when calling UsersApi->PutUserStationDefaultstationStationId") - } - // verify the required parameter 'stationId' is set - if &stationId == nil { - // - return nil, errors.New("Missing required parameter 'stationId' when calling UsersApi->PutUserStationDefaultstationStationId") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - diff --git a/build/platformclientv2/usersapi_test.go b/build/platformclientv2/usersapi_test.go deleted file mode 100644 index fb5b152e9..000000000 --- a/build/platformclientv2/usersapi_test.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 - -import ( - "fmt" - "os" -) - -func ExampleUsersApi_GetUsers() { - // Use the default config instance and retrieve settings from env vars - config := GetDefaultConfiguration() - config.SetDebug(false) - config.BasePath = "https://api." + os.Getenv("PURECLOUD_ENVIRONMENT") // e.g. PURECLOUD_ENVIRONMENT=mypurecloud.com - clientID := os.Getenv("PURECLOUD_CLIENT_ID") - clientSecret := os.Getenv("PURECLOUD_CLIENT_SECRET") - - // Authorize the configuration - err := config.AuthorizeClientCredentials(clientID, clientSecret) - if err != nil { - panic(err) - } - - // Create an API instance using the default config - usersAPI := NewUsersApi() - - // Invoke API - _, response, err := usersAPI.GetUsers(100, 1, make([]string, 0), make([]string, 0), "", make([]string, 0), "", "") - if err != nil { - fmt.Printf("Error calling GetUsers: %v\n", err) - } else { - fmt.Printf("Successfully retrieved user data with status code %v\n", response.StatusCode) - } - // Output: Successfully retrieved user data with status code 200 -} diff --git a/build/platformclientv2/userschedule.go b/build/platformclientv2/userschedule.go deleted file mode 100644 index 2605b68c9..000000000 --- a/build/platformclientv2/userschedule.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Userschedule - A schedule for a single user over a given time range -type Userschedule struct { - // Shifts - The shifts that belong to this schedule - Shifts *[]Userscheduleshift `json:"shifts,omitempty"` - - - // FullDayTimeOffMarkers - Markers to indicate a full day time off request, relative to the management unit time zone - FullDayTimeOffMarkers *[]Userschedulefulldaytimeoffmarker `json:"fullDayTimeOffMarkers,omitempty"` - - - // Delete - If marked true for updating an existing user schedule, it will be deleted - Delete *bool `json:"delete,omitempty"` - - - // Metadata - Version metadata for this schedule - Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"` - - - // WorkPlanId - ID of the work plan associated with the user during schedule creation - WorkPlanId *string `json:"workPlanId,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userschedule) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userscheduleactivity.go b/build/platformclientv2/userscheduleactivity.go deleted file mode 100644 index 6c6c8f554..000000000 --- a/build/platformclientv2/userscheduleactivity.go +++ /dev/null @@ -1,42 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Userscheduleactivity - Represents a single activity in a user's shift -type Userscheduleactivity struct { - // ActivityCodeId - The id for the activity code. Look up a map of activity codes with the activities route - ActivityCodeId *string `json:"activityCodeId,omitempty"` - - - // StartDate - Start time in UTC for this activity, in ISO-8601 format - StartDate *time.Time `json:"startDate,omitempty"` - - - // LengthInMinutes - Length in minutes for this activity - LengthInMinutes *int `json:"lengthInMinutes,omitempty"` - - - // Description - Description for this activity - Description *string `json:"description,omitempty"` - - - // CountsAsPaidTime - Whether this activity is paid - CountsAsPaidTime *bool `json:"countsAsPaidTime,omitempty"` - - - // IsDstFallback - Whether this activity spans a DST fallback - IsDstFallback *bool `json:"isDstFallback,omitempty"` - - - // TimeOffRequestId - Time off request id of this activity - TimeOffRequestId *string `json:"timeOffRequestId,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userscheduleactivity) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userscheduleadherence.go b/build/platformclientv2/userscheduleadherence.go deleted file mode 100644 index c15359b70..000000000 --- a/build/platformclientv2/userscheduleadherence.go +++ /dev/null @@ -1,90 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Userscheduleadherence -type Userscheduleadherence struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // User - The user for whom this status applies - User *Userreference `json:"user,omitempty"` - - - // ManagementUnit - The management unit to which this user belongs - ManagementUnit *Managementunit `json:"managementUnit,omitempty"` - - - // Team - The team to which this user belongs - Team *Team `json:"team,omitempty"` - - - // ScheduledActivityCategory - Activity for which the user is scheduled - ScheduledActivityCategory *string `json:"scheduledActivityCategory,omitempty"` - - - // SystemPresence - Actual underlying system presence value - SystemPresence *string `json:"systemPresence,omitempty"` - - - // OrganizationSecondaryPresenceId - Organization Secondary Presence Id. - OrganizationSecondaryPresenceId *string `json:"organizationSecondaryPresenceId,omitempty"` - - - // RoutingStatus - Actual underlying routing status, used to determine whether a user is actually in adherence when OnQueue - RoutingStatus *string `json:"routingStatus,omitempty"` - - - // ActualActivityCategory - Activity in which the user is actually engaged - ActualActivityCategory *string `json:"actualActivityCategory,omitempty"` - - - // IsOutOfOffice - Whether the user is marked OutOfOffice - IsOutOfOffice *bool `json:"isOutOfOffice,omitempty"` - - - // AdherenceState - The user's current adherence state - AdherenceState *string `json:"adherenceState,omitempty"` - - - // Impact - The impact of the user's current adherenceState - Impact *string `json:"impact,omitempty"` - - - // TimeOfAdherenceChange - Time when the user entered the current adherenceState in ISO-8601 format - TimeOfAdherenceChange *time.Time `json:"timeOfAdherenceChange,omitempty"` - - - // PresenceUpdateTime - Time when presence was last updated. Used to calculate time in current status. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - PresenceUpdateTime *time.Time `json:"presenceUpdateTime,omitempty"` - - - // ActiveQueues - The list of queues to which this user is joined - ActiveQueues *[]Queuereference `json:"activeQueues,omitempty"` - - - // ActiveQueuesModifiedTime - Time when the list of active queues for this user was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ActiveQueuesModifiedTime *time.Time `json:"activeQueuesModifiedTime,omitempty"` - - - // RemovedFromManagementUnit - For notification purposes. Used to indicate that a user was removed from the management unit - RemovedFromManagementUnit *bool `json:"removedFromManagementUnit,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userscheduleadherence) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userscheduleadherencelisting.go b/build/platformclientv2/userscheduleadherencelisting.go deleted file mode 100644 index 1bcdc73ba..000000000 --- a/build/platformclientv2/userscheduleadherencelisting.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Userscheduleadherencelisting -type Userscheduleadherencelisting struct { - // Entities - Entities *[]Userscheduleadherence `json:"entities,omitempty"` - - - // DownloadUrl - The downloadUrl if the response is too large to send directly via http response - DownloadUrl *string `json:"downloadUrl,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userscheduleadherencelisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userschedulecontainer.go b/build/platformclientv2/userschedulecontainer.go deleted file mode 100644 index 7a8c0b770..000000000 --- a/build/platformclientv2/userschedulecontainer.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Userschedulecontainer - Container object to hold a map of user schedules -type Userschedulecontainer struct { - // ManagementUnitTimeZone - The reference time zone used for the management unit - ManagementUnitTimeZone *string `json:"managementUnitTimeZone,omitempty"` - - - // PublishedSchedules - References to all published week schedules overlapping the start/end date query parameters - PublishedSchedules *[]Weekschedulereference `json:"publishedSchedules,omitempty"` - - - // UserSchedules - Map of user id to user schedule - UserSchedules *map[string]Userschedule `json:"userSchedules,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userschedulecontainer) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userschedulefulldaytimeoffmarker.go b/build/platformclientv2/userschedulefulldaytimeoffmarker.go deleted file mode 100644 index 9da1cdc94..000000000 --- a/build/platformclientv2/userschedulefulldaytimeoffmarker.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Userschedulefulldaytimeoffmarker - Marker to indicate an approved full day time off request -type Userschedulefulldaytimeoffmarker struct { - // ManagementUnitDate - The date associated with the time off request that this marker corresponds to. Date only, in ISO-8601 format. - ManagementUnitDate *string `json:"managementUnitDate,omitempty"` - - - // ActivityCodeId - The id for the activity code. Look up a map of activity codes with the activities route - ActivityCodeId *string `json:"activityCodeId,omitempty"` - - - // IsPaid - Whether this is paid time off - IsPaid *bool `json:"isPaid,omitempty"` - - - // LengthInMinutes - The length in minutes of this time off marker - LengthInMinutes *int `json:"lengthInMinutes,omitempty"` - - - // Description - The description associated with the time off request that this marker corresponds to - Description *string `json:"description,omitempty"` - - - // Delete - If marked true for updating an existing full day time off marker, it will be deleted - Delete *bool `json:"delete,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userschedulefulldaytimeoffmarker) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userscheduleshift.go b/build/platformclientv2/userscheduleshift.go deleted file mode 100644 index 687ecd5c1..000000000 --- a/build/platformclientv2/userscheduleshift.go +++ /dev/null @@ -1,42 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Userscheduleshift - Single shift in a user's schedule -type Userscheduleshift struct { - // WeekSchedule - The schedule to which this shift belongs - WeekSchedule *Weekschedulereference `json:"weekSchedule,omitempty"` - - - // Id - ID of the schedule shift. This is only for the case of updating and deleting an existing shift - Id *string `json:"id,omitempty"` - - - // StartDate - Start time in UTC for this shift. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartDate *time.Time `json:"startDate,omitempty"` - - - // LengthInMinutes - Length of this shift in minutes - LengthInMinutes *int `json:"lengthInMinutes,omitempty"` - - - // Activities - List of activities in this shift - Activities *[]Userscheduleactivity `json:"activities,omitempty"` - - - // Delete - If marked true for updating this schedule shift, it will be deleted - Delete *bool `json:"delete,omitempty"` - - - // ManuallyEdited - Whether the shift was set as manually edited - ManuallyEdited *bool `json:"manuallyEdited,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userscheduleshift) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/usersearchcriteria.go b/build/platformclientv2/usersearchcriteria.go deleted file mode 100644 index 49896f72c..000000000 --- a/build/platformclientv2/usersearchcriteria.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Usersearchcriteria -type Usersearchcriteria struct { - // EndValue - The end value of the range. This field is used for range search types. - EndValue *string `json:"endValue,omitempty"` - - - // Values - A list of values for the search to match against - Values *[]string `json:"values,omitempty"` - - - // StartValue - The start value of the range. This field is used for range search types. - StartValue *string `json:"startValue,omitempty"` - - - // Fields - Field names to search against - Fields *[]string `json:"fields,omitempty"` - - - // Value - A value for the search to match against - Value *string `json:"value,omitempty"` - - - // Operator - How to apply this search criteria against other criteria - Operator *string `json:"operator,omitempty"` - - - // Group - Groups multiple conditions - Group *[]Usersearchcriteria `json:"group,omitempty"` - - - // DateFormat - Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX. - DateFormat *string `json:"dateFormat,omitempty"` - - - // VarType - Search Type - VarType *string `json:"type,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Usersearchcriteria) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/usersearchrequest.go b/build/platformclientv2/usersearchrequest.go deleted file mode 100644 index 0d20cbb62..000000000 --- a/build/platformclientv2/usersearchrequest.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Usersearchrequest -type Usersearchrequest struct { - // SortOrder - The sort order for results - SortOrder *string `json:"sortOrder,omitempty"` - - - // SortBy - The field in the resource that you want to sort the results by - SortBy *string `json:"sortBy,omitempty"` - - - // PageSize - The number of results per page - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - The page of resources you want to retrieve - PageNumber *int `json:"pageNumber,omitempty"` - - - // Sort - Multi-value sort order, list of multiple sort values - Sort *[]Searchsort `json:"sort,omitempty"` - - - // Expand - Provides more details about a specified resource - Expand *[]string `json:"expand,omitempty"` - - - // Query - Query *[]Usersearchcriteria `json:"query,omitempty"` - - - // IntegrationPresenceSource - Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an \"expand\". When using this parameter the maximum number of users that can be returned is 10. - IntegrationPresenceSource *string `json:"integrationPresenceSource,omitempty"` - - - // EnforcePermissions - Enforce view permission on request - EnforcePermissions *bool `json:"enforcePermissions,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Usersearchrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userskillentitylisting.go b/build/platformclientv2/userskillentitylisting.go deleted file mode 100644 index 0ac23ddd6..000000000 --- a/build/platformclientv2/userskillentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Userskillentitylisting -type Userskillentitylisting struct { - // Entities - Entities *[]Userroutingskill `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userskillentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userssearchresponse.go b/build/platformclientv2/userssearchresponse.go deleted file mode 100644 index 6f241b447..000000000 --- a/build/platformclientv2/userssearchresponse.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Userssearchresponse -type Userssearchresponse struct { - // Total - The total number of results found - Total *int `json:"total,omitempty"` - - - // PageCount - The total number of pages - PageCount *int `json:"pageCount,omitempty"` - - - // PageSize - The current page size - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - The current page number - PageNumber *int `json:"pageNumber,omitempty"` - - - // PreviousPage - Q64 value for the previous page of results - PreviousPage *string `json:"previousPage,omitempty"` - - - // CurrentPage - Q64 value for the current page of results - CurrentPage *string `json:"currentPage,omitempty"` - - - // NextPage - Q64 value for the next page of results - NextPage *string `json:"nextPage,omitempty"` - - - // Types - Resource types the search was performed against - Types *[]string `json:"types,omitempty"` - - - // Results - Search results - Results *[]User `json:"results,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userssearchresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userstation.go b/build/platformclientv2/userstation.go deleted file mode 100644 index 1c9e6eb5b..000000000 --- a/build/platformclientv2/userstation.go +++ /dev/null @@ -1,42 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Userstation -type Userstation struct { - // Id - A globally unique identifier for this station - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - - - // AssociatedUser - AssociatedUser *User `json:"associatedUser,omitempty"` - - - // AssociatedDate - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - AssociatedDate *time.Time `json:"associatedDate,omitempty"` - - - // DefaultUser - DefaultUser *User `json:"defaultUser,omitempty"` - - - // ProviderInfo - Provider-specific info for this station, e.g. { \"edgeGroupId\": \"ffe7b15c-a9cc-4f4c-88f5-781327819a49\" } - ProviderInfo *map[string]string `json:"providerInfo,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userstation) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userstationchangetopicuser.go b/build/platformclientv2/userstationchangetopicuser.go deleted file mode 100644 index 60ee3f8bb..000000000 --- a/build/platformclientv2/userstationchangetopicuser.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Userstationchangetopicuser -type Userstationchangetopicuser struct { - // Id - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userstationchangetopicuser) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userstationchangetopicuserstation.go b/build/platformclientv2/userstationchangetopicuserstation.go deleted file mode 100644 index 68cb49280..000000000 --- a/build/platformclientv2/userstationchangetopicuserstation.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Userstationchangetopicuserstation -type Userstationchangetopicuserstation struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // AssociatedUser - AssociatedUser *Userstationchangetopicuser `json:"associatedUser,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userstationchangetopicuserstation) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userstationchangetopicuserstations.go b/build/platformclientv2/userstationchangetopicuserstations.go deleted file mode 100644 index 81088f21b..000000000 --- a/build/platformclientv2/userstationchangetopicuserstations.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Userstationchangetopicuserstations -type Userstationchangetopicuserstations struct { - // AssociatedStation - AssociatedStation *Userstationchangetopicuserstation `json:"associatedStation,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userstationchangetopicuserstations) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/userstations.go b/build/platformclientv2/userstations.go deleted file mode 100644 index 2b88fc077..000000000 --- a/build/platformclientv2/userstations.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Userstations -type Userstations struct { - // AssociatedStation - Current associated station for this user. - AssociatedStation *Userstation `json:"associatedStation,omitempty"` - - - // EffectiveStation - The station where the user can be reached based on their default and associated station. - EffectiveStation *Userstation `json:"effectiveStation,omitempty"` - - - // DefaultStation - Default station to be used if not associated with a station. - DefaultStation *Userstation `json:"defaultStation,omitempty"` - - - // LastAssociatedStation - Last associated station for this user. - LastAssociatedStation *Userstation `json:"lastAssociatedStation,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Userstations) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/usertokenstopictokennotification.go b/build/platformclientv2/usertokenstopictokennotification.go deleted file mode 100644 index 57d9787b2..000000000 --- a/build/platformclientv2/usertokenstopictokennotification.go +++ /dev/null @@ -1,41 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Usertokenstopictokennotification -type Usertokenstopictokennotification struct { - // User - User *Usertokenstopicurireference `json:"user,omitempty"` - - - // IpAddress - IpAddress *string `json:"ipAddress,omitempty"` - - - // DateCreated - DateCreated *string `json:"dateCreated,omitempty"` - - - // TokenExpirationDate - TokenExpirationDate *string `json:"tokenExpirationDate,omitempty"` - - - // SessionId - SessionId *string `json:"sessionId,omitempty"` - - - // ClientId - ClientId *string `json:"clientId,omitempty"` - - - // TokenHash - TokenHash *string `json:"tokenHash,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Usertokenstopictokennotification) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/usertokenstopicurireference.go b/build/platformclientv2/usertokenstopicurireference.go deleted file mode 100644 index e35630834..000000000 --- a/build/platformclientv2/usertokenstopicurireference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Usertokenstopicurireference -type Usertokenstopicurireference struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Usertokenstopicurireference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/utilitiesapi.go b/build/platformclientv2/utilitiesapi.go deleted file mode 100644 index 10a206535..000000000 --- a/build/platformclientv2/utilitiesapi.go +++ /dev/null @@ -1,318 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "encoding/json" -) - -// UtilitiesApi provides functions for API endpoints -type UtilitiesApi struct { - Configuration *Configuration -} - -// NewUtilitiesApi creates an API instance using the default configuration -func NewUtilitiesApi() *UtilitiesApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating UtilitiesApi with base path: %s", strings.ToLower(config.BasePath))) - return &UtilitiesApi{ - Configuration: config, - } -} - -// NewUtilitiesApiWithConfig creates an API instance using the provided configuration -func NewUtilitiesApiWithConfig(config *Configuration) *UtilitiesApi { - config.Debugf("Creating UtilitiesApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &UtilitiesApi{ - Configuration: config, - } -} - -// GetDate invokes GET /api/v2/date -// -// Get the current system date/time -// -// -func (a UtilitiesApi) GetDate() (*Serverdate, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/date" - defaultReturn := new(Serverdate) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Serverdate - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetIpranges invokes GET /api/v2/ipranges -// -// Get public ip address ranges for PureCloud -// -// -func (a UtilitiesApi) GetIpranges() (*Ipaddressrangelisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/ipranges" - defaultReturn := new(Ipaddressrangelisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Ipaddressrangelisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetTimezones invokes GET /api/v2/timezones -// -// Get time zones list -// -// -func (a UtilitiesApi) GetTimezones(pageSize int, pageNumber int) (*Timezoneentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/timezones" - defaultReturn := new(Timezoneentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Timezoneentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostCertificateDetails invokes POST /api/v2/certificate/details -// -// Returns the information about an X509 PEM encoded certificate or certificate chain. -// -// -func (a UtilitiesApi) PostCertificateDetails(body Certificate) (*Parsedcertificate, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/certificate/details" - defaultReturn := new(Parsedcertificate) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling UtilitiesApi->PostCertificateDetails") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Parsedcertificate - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/utilization.go b/build/platformclientv2/utilization.go deleted file mode 100644 index 3f22c1e12..000000000 --- a/build/platformclientv2/utilization.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Utilization -type Utilization struct { - // Utilization - Map of media type to utilization settings. Valid media types include call, callback, chat, email, and message. - Utilization *map[string]Mediautilization `json:"utilization,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Utilization) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/validateaddressrequest.go b/build/platformclientv2/validateaddressrequest.go deleted file mode 100644 index ef3e0e7c8..000000000 --- a/build/platformclientv2/validateaddressrequest.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Validateaddressrequest -type Validateaddressrequest struct { - // Address - Address schema - Address *Streetaddress `json:"address,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Validateaddressrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/validateaddressresponse.go b/build/platformclientv2/validateaddressresponse.go deleted file mode 100644 index 07a295eda..000000000 --- a/build/platformclientv2/validateaddressresponse.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Validateaddressresponse -type Validateaddressresponse struct { - // Valid - Was the passed in address valid - Valid *bool `json:"valid,omitempty"` - - - // Response - Subscriber schema - Response *Subscriberresponse `json:"response,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Validateaddressresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/validateworkplanmessages.go b/build/platformclientv2/validateworkplanmessages.go deleted file mode 100644 index ae04c7b27..000000000 --- a/build/platformclientv2/validateworkplanmessages.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Validateworkplanmessages -type Validateworkplanmessages struct { - // ViolationMessages - Messages for work plan violating some rules such as no shifts in a work plan - ViolationMessages *[]Workplanconfigurationviolationmessage `json:"violationMessages,omitempty"` - - - // ConstraintConflictMessage - This field is not null when there is a set of work plan constraints that conflict thus agent schedules cannot be generated - ConstraintConflictMessage *Constraintconflictmessage `json:"constraintConflictMessage,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Validateworkplanmessages) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/validateworkplanresponse.go b/build/platformclientv2/validateworkplanresponse.go deleted file mode 100644 index 181930d17..000000000 --- a/build/platformclientv2/validateworkplanresponse.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Validateworkplanresponse -type Validateworkplanresponse struct { - // WorkPlan - The work plan reference associated with this response - WorkPlan *Workplanreference `json:"workPlan,omitempty"` - - - // Valid - Whether the work plan is valid or not - Valid *bool `json:"valid,omitempty"` - - - // Messages - Validation messages for this work plan - Messages *Validateworkplanmessages `json:"messages,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Validateworkplanresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/validationlimits.go b/build/platformclientv2/validationlimits.go deleted file mode 100644 index f8217055a..000000000 --- a/build/platformclientv2/validationlimits.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Validationlimits -type Validationlimits struct { - // MinLength - MinLength *Minlength `json:"minLength,omitempty"` - - - // MaxLength - MaxLength *Maxlength `json:"maxLength,omitempty"` - - - // MinItems - MinItems *Minlength `json:"minItems,omitempty"` - - - // MaxItems - MaxItems *Maxlength `json:"maxItems,omitempty"` - - - // Minimum - Minimum *Minlength `json:"minimum,omitempty"` - - - // Maximum - Maximum *Maxlength `json:"maximum,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Validationlimits) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/valuewrapperdate.go b/build/platformclientv2/valuewrapperdate.go deleted file mode 100644 index 3d6be9195..000000000 --- a/build/platformclientv2/valuewrapperdate.go +++ /dev/null @@ -1,18 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Valuewrapperdate - An object to provide context to nullable fields in PATCH requests -type Valuewrapperdate struct { - // Value - The value for the associated field. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - Value *time.Time `json:"value,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Valuewrapperdate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/valuewrapperplanningperiodsettings.go b/build/platformclientv2/valuewrapperplanningperiodsettings.go deleted file mode 100644 index 1da160f3a..000000000 --- a/build/platformclientv2/valuewrapperplanningperiodsettings.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Valuewrapperplanningperiodsettings - An object to provide context to nullable fields in PATCH requests -type Valuewrapperplanningperiodsettings struct { - // Value - The value for the associated field - Value *Planningperiodsettings `json:"value,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Valuewrapperplanningperiodsettings) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/valuewrapperstring.go b/build/platformclientv2/valuewrapperstring.go deleted file mode 100644 index e0677da76..000000000 --- a/build/platformclientv2/valuewrapperstring.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Valuewrapperstring - An object to provide context to nullable fields in PATCH requests -type Valuewrapperstring struct { - // Value - The value for the associated field - Value *string `json:"value,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Valuewrapperstring) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/vendorconnectionrequest.go b/build/platformclientv2/vendorconnectionrequest.go deleted file mode 100644 index a828f8fe7..000000000 --- a/build/platformclientv2/vendorconnectionrequest.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Vendorconnectionrequest -type Vendorconnectionrequest struct { - // Publisher - Publisher of the integration or connector who registered the new connection. Typically, inin. - Publisher *string `json:"publisher,omitempty"` - - - // VarType - Integration or connector type that registered the new connection. Example, wfm-rta-integration - VarType *string `json:"type,omitempty"` - - - // Name - Name of the integration or connector instance that registered the new connection. Example, my-wfm - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Vendorconnectionrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/video.go b/build/platformclientv2/video.go deleted file mode 100644 index 2a4296168..000000000 --- a/build/platformclientv2/video.go +++ /dev/null @@ -1,86 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Video -type Video struct { - // State - The connection state of this communication. - State *string `json:"state,omitempty"` - - - // Id - A globally unique identifier for this communication. - Id *string `json:"id,omitempty"` - - - // Context - The room id context (xmpp jid) for the conference session. - Context *string `json:"context,omitempty"` - - - // AudioMuted - Indicates whether this participant has muted their outgoing audio. - AudioMuted *bool `json:"audioMuted,omitempty"` - - - // VideoMuted - Indicates whether this participant has muted/paused their outgoing video. - VideoMuted *bool `json:"videoMuted,omitempty"` - - - // SharingScreen - Indicates whether this participant is sharing their screen to the session. - SharingScreen *bool `json:"sharingScreen,omitempty"` - - - // PeerCount - The number of peer participants from the perspective of the participant in the conference. - PeerCount *int `json:"peerCount,omitempty"` - - - // DisconnectType - System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects. - DisconnectType *string `json:"disconnectType,omitempty"` - - - // StartAlertingTime - The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - StartAlertingTime *time.Time `json:"startAlertingTime,omitempty"` - - - // ConnectedTime - The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ConnectedTime *time.Time `json:"connectedTime,omitempty"` - - - // DisconnectedTime - The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DisconnectedTime *time.Time `json:"disconnectedTime,omitempty"` - - - // Provider - The source provider for the video. - Provider *string `json:"provider,omitempty"` - - - // PeerId - The id of the peer communication corresponding to a matching leg for this communication. - PeerId *string `json:"peerId,omitempty"` - - - // Msids - List of media stream ids - Msids *[]string `json:"msids,omitempty"` - - - // Self - Address and name data for a call endpoint. - Self *Address `json:"self,omitempty"` - - - // Wrapup - Call wrap up or disposition data. - Wrapup *Wrapup `json:"wrapup,omitempty"` - - - // AfterCallWork - After-call work for the communication. - AfterCallWork *Aftercallwork `json:"afterCallWork,omitempty"` - - - // AfterCallWorkRequired - Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested. - AfterCallWorkRequired *bool `json:"afterCallWorkRequired,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Video) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/viewfilter.go b/build/platformclientv2/viewfilter.go deleted file mode 100644 index 997c36160..000000000 --- a/build/platformclientv2/viewfilter.go +++ /dev/null @@ -1,409 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Viewfilter -type Viewfilter struct { - // MediaTypes - The media types are used to filter the view - MediaTypes *[]string `json:"mediaTypes,omitempty"` - - - // QueueIds - The queue ids are used to filter the view - QueueIds *[]string `json:"queueIds,omitempty"` - - - // SkillIds - The skill ids are used to filter the view - SkillIds *[]string `json:"skillIds,omitempty"` - - - // SkillGroups - The skill groups used to filter the view - SkillGroups *[]string `json:"skillGroups,omitempty"` - - - // LanguageIds - The language ids are used to filter the view - LanguageIds *[]string `json:"languageIds,omitempty"` - - - // LanguageGroups - The language groups used to filter the view - LanguageGroups *[]string `json:"languageGroups,omitempty"` - - - // Directions - The directions are used to filter the view - Directions *[]string `json:"directions,omitempty"` - - - // OriginatingDirections - The list of orginating directions used to filter the view - OriginatingDirections *[]string `json:"originatingDirections,omitempty"` - - - // WrapUpCodes - The wrap up codes are used to filter the view - WrapUpCodes *[]string `json:"wrapUpCodes,omitempty"` - - - // DnisList - The dnis list is used to filter the view - DnisList *[]string `json:"dnisList,omitempty"` - - - // SessionDnisList - The list of session dnis used to filter the view - SessionDnisList *[]string `json:"sessionDnisList,omitempty"` - - - // FilterQueuesByUserIds - The user ids are used to fetch associated queues for the view - FilterQueuesByUserIds *[]string `json:"filterQueuesByUserIds,omitempty"` - - - // FilterUsersByQueueIds - The queue ids are used to fetch associated users for the view - FilterUsersByQueueIds *[]string `json:"filterUsersByQueueIds,omitempty"` - - - // UserIds - The user ids are used to filter the view - UserIds *[]string `json:"userIds,omitempty"` - - - // AddressTos - The address To values are used to filter the view - AddressTos *[]string `json:"addressTos,omitempty"` - - - // AddressFroms - The address from values are used to filter the view - AddressFroms *[]string `json:"addressFroms,omitempty"` - - - // OutboundCampaignIds - The outbound campaign ids are used to filter the view - OutboundCampaignIds *[]string `json:"outboundCampaignIds,omitempty"` - - - // OutboundContactListIds - The outbound contact list ids are used to filter the view - OutboundContactListIds *[]string `json:"outboundContactListIds,omitempty"` - - - // ContactIds - The contact ids are used to filter the view - ContactIds *[]string `json:"contactIds,omitempty"` - - - // ExternalContactIds - The external contact ids are used to filter the view - ExternalContactIds *[]string `json:"externalContactIds,omitempty"` - - - // ExternalOrgIds - The external org ids are used to filter the view - ExternalOrgIds *[]string `json:"externalOrgIds,omitempty"` - - - // AniList - The ani list ids are used to filter the view - AniList *[]string `json:"aniList,omitempty"` - - - // DurationsMilliseconds - The durations in milliseconds used to filter the view - DurationsMilliseconds *[]Numericrange `json:"durationsMilliseconds,omitempty"` - - - // AcdDurationsMilliseconds - The acd durations in milliseconds used to filter the view - AcdDurationsMilliseconds *[]Numericrange `json:"acdDurationsMilliseconds,omitempty"` - - - // TalkDurationsMilliseconds - The talk durations in milliseconds used to filter the view - TalkDurationsMilliseconds *[]Numericrange `json:"talkDurationsMilliseconds,omitempty"` - - - // AcwDurationsMilliseconds - The acw durations in milliseconds used to filter the view - AcwDurationsMilliseconds *[]Numericrange `json:"acwDurationsMilliseconds,omitempty"` - - - // HandleDurationsMilliseconds - The handle durations in milliseconds used to filter the view - HandleDurationsMilliseconds *[]Numericrange `json:"handleDurationsMilliseconds,omitempty"` - - - // HoldDurationsMilliseconds - The hold durations in milliseconds used to filter the view - HoldDurationsMilliseconds *[]Numericrange `json:"holdDurationsMilliseconds,omitempty"` - - - // AbandonDurationsMilliseconds - The abandon durations in milliseconds used to filter the view - AbandonDurationsMilliseconds *[]Numericrange `json:"abandonDurationsMilliseconds,omitempty"` - - - // EvaluationScore - The evaluationScore is used to filter the view - EvaluationScore *Numericrange `json:"evaluationScore,omitempty"` - - - // EvaluationCriticalScore - The evaluationCriticalScore is used to filter the view - EvaluationCriticalScore *Numericrange `json:"evaluationCriticalScore,omitempty"` - - - // EvaluationFormIds - The evaluation form ids are used to filter the view - EvaluationFormIds *[]string `json:"evaluationFormIds,omitempty"` - - - // EvaluatedAgentIds - The evaluated agent ids are used to filter the view - EvaluatedAgentIds *[]string `json:"evaluatedAgentIds,omitempty"` - - - // EvaluatorIds - The evaluator ids are used to filter the view - EvaluatorIds *[]string `json:"evaluatorIds,omitempty"` - - - // Transferred - Indicates filtering for transfers - Transferred *bool `json:"transferred,omitempty"` - - - // Abandoned - Indicates filtering for abandons - Abandoned *bool `json:"abandoned,omitempty"` - - - // Answered - Indicates filtering for answered interactions - Answered *bool `json:"answered,omitempty"` - - - // MessageTypes - The message media types used to filter the view - MessageTypes *[]string `json:"messageTypes,omitempty"` - - - // DivisionIds - The divison Ids used to filter the view - DivisionIds *[]string `json:"divisionIds,omitempty"` - - - // SurveyFormIds - The survey form ids used to filter the view - SurveyFormIds *[]string `json:"surveyFormIds,omitempty"` - - - // SurveyTotalScore - The survey total score used to filter the view - SurveyTotalScore *Numericrange `json:"surveyTotalScore,omitempty"` - - - // SurveyNpsScore - The survey NPS score used to filter the view - SurveyNpsScore *Numericrange `json:"surveyNpsScore,omitempty"` - - - // Mos - The desired range for mos values - Mos *Numericrange `json:"mos,omitempty"` - - - // SurveyQuestionGroupScore - The survey question group score used to filter the view - SurveyQuestionGroupScore *Numericrange `json:"surveyQuestionGroupScore,omitempty"` - - - // SurveyPromoterScore - The survey promoter score used to filter the view - SurveyPromoterScore *Numericrange `json:"surveyPromoterScore,omitempty"` - - - // SurveyFormContextIds - The list of survey form context ids used to filter the view - SurveyFormContextIds *[]string `json:"surveyFormContextIds,omitempty"` - - - // ConversationIds - The list of conversation ids used to filter the view - ConversationIds *[]string `json:"conversationIds,omitempty"` - - - // SipCallIds - The list of SIP call ids used to filter the view - SipCallIds *[]string `json:"sipCallIds,omitempty"` - - - // IsEnded - Indicates filtering for ended - IsEnded *bool `json:"isEnded,omitempty"` - - - // IsSurveyed - Indicates filtering for survey - IsSurveyed *bool `json:"isSurveyed,omitempty"` - - - // SurveyScores - The list of survey score ranges used to filter the view - SurveyScores *[]Numericrange `json:"surveyScores,omitempty"` - - - // PromoterScores - The list of promoter score ranges used to filter the view - PromoterScores *[]Numericrange `json:"promoterScores,omitempty"` - - - // IsCampaign - Indicates filtering for campaign - IsCampaign *bool `json:"isCampaign,omitempty"` - - - // SurveyStatuses - The list of survey statuses used to filter the view - SurveyStatuses *[]string `json:"surveyStatuses,omitempty"` - - - // ConversationProperties - A grouping of conversation level filters - ConversationProperties *Conversationproperties `json:"conversationProperties,omitempty"` - - - // IsBlindTransferred - Indicates filtering for blind transferred - IsBlindTransferred *bool `json:"isBlindTransferred,omitempty"` - - - // IsConsulted - Indicates filtering for consulted - IsConsulted *bool `json:"isConsulted,omitempty"` - - - // IsConsultTransferred - Indicates filtering for consult transferred - IsConsultTransferred *bool `json:"isConsultTransferred,omitempty"` - - - // RemoteParticipants - The list of remote participants used to filter the view - RemoteParticipants *[]string `json:"remoteParticipants,omitempty"` - - - // FlowIds - The list of flow Ids - FlowIds *[]string `json:"flowIds,omitempty"` - - - // FlowOutcomeIds - A list of outcome ids of the flow - FlowOutcomeIds *[]string `json:"flowOutcomeIds,omitempty"` - - - // FlowOutcomeValues - A list of outcome values of the flow - FlowOutcomeValues *[]string `json:"flowOutcomeValues,omitempty"` - - - // FlowDestinationTypes - The list of destination types of the flow - FlowDestinationTypes *[]string `json:"flowDestinationTypes,omitempty"` - - - // FlowDisconnectReasons - The list of reasons for the flow to disconnect - FlowDisconnectReasons *[]string `json:"flowDisconnectReasons,omitempty"` - - - // FlowTypes - A list of types of the flow - FlowTypes *[]string `json:"flowTypes,omitempty"` - - - // FlowEntryTypes - A list of types of the flow entry - FlowEntryTypes *[]string `json:"flowEntryTypes,omitempty"` - - - // FlowEntryReasons - A list of reasons of flow entry - FlowEntryReasons *[]string `json:"flowEntryReasons,omitempty"` - - - // FlowVersions - A list of versions of a flow - FlowVersions *[]string `json:"flowVersions,omitempty"` - - - // GroupIds - A list of directory group ids - GroupIds *[]string `json:"groupIds,omitempty"` - - - // HasJourneyCustomerId - Indicates filtering for journey customer id - HasJourneyCustomerId *bool `json:"hasJourneyCustomerId,omitempty"` - - - // HasJourneyActionMapId - Indicates filtering for Journey action map id - HasJourneyActionMapId *bool `json:"hasJourneyActionMapId,omitempty"` - - - // HasJourneyVisitId - Indicates filtering for Journey visit id - HasJourneyVisitId *bool `json:"hasJourneyVisitId,omitempty"` - - - // HasMedia - Indicates filtering for presence of MMS media - HasMedia *bool `json:"hasMedia,omitempty"` - - - // RoleIds - The role Ids used to filter the view - RoleIds *[]string `json:"roleIds,omitempty"` - - - // ReportsTos - The report to user IDs used to filter the view - ReportsTos *[]string `json:"reportsTos,omitempty"` - - - // LocationIds - The location Ids used to filter the view - LocationIds *[]string `json:"locationIds,omitempty"` - - - // FlowOutTypes - A list of flow out types - FlowOutTypes *[]string `json:"flowOutTypes,omitempty"` - - - // ProviderList - A list of providers - ProviderList *[]string `json:"providerList,omitempty"` - - - // CallbackNumberList - A list of callback numbers or substrings of numbers (ex: [\"317\", \"13172222222\"]) - CallbackNumberList *[]string `json:"callbackNumberList,omitempty"` - - - // CallbackInterval - An interval of time to filter for scheduled callbacks. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss - CallbackInterval *string `json:"callbackInterval,omitempty"` - - - // UsedRoutingTypes - A list of routing types used - UsedRoutingTypes *[]string `json:"usedRoutingTypes,omitempty"` - - - // RequestedRoutingTypes - A list of routing types requested - RequestedRoutingTypes *[]string `json:"requestedRoutingTypes,omitempty"` - - - // HasAgentAssistId - Indicates filtering for agent assist id - HasAgentAssistId *bool `json:"hasAgentAssistId,omitempty"` - - - // Transcripts - A list of transcript contents requested - Transcripts *[]Transcripts `json:"transcripts,omitempty"` - - - // TranscriptLanguages - A list of transcript languages requested - TranscriptLanguages *[]string `json:"transcriptLanguages,omitempty"` - - - // ParticipantPurposes - A list of participant purpose requested - ParticipantPurposes *[]string `json:"participantPurposes,omitempty"` - - - // ShowFirstQueue - Indicates filtering for first queue data - ShowFirstQueue *bool `json:"showFirstQueue,omitempty"` - - - // TeamIds - The team ids used to filter the view data - TeamIds *[]string `json:"teamIds,omitempty"` - - - // FilterUsersByTeamIds - The team ids are used to fetch associated users for the view - FilterUsersByTeamIds *[]string `json:"filterUsersByTeamIds,omitempty"` - - - // JourneyActionMapIds - The journey action map ids are used to fetch action maps for the associated view - JourneyActionMapIds *[]string `json:"journeyActionMapIds,omitempty"` - - - // JourneyOutcomeIds - The journey outcome ids are used to fetch outcomes for the associated view - JourneyOutcomeIds *[]string `json:"journeyOutcomeIds,omitempty"` - - - // JourneySegmentIds - The journey segment ids are used to fetch segments for the associated view - JourneySegmentIds *[]string `json:"journeySegmentIds,omitempty"` - - - // JourneyActionMapTypes - The journey action map types are used to filter action map data for the associated view - JourneyActionMapTypes *[]string `json:"journeyActionMapTypes,omitempty"` - - - // DevelopmentRoleList - The list of development roles used to filter agent development view - DevelopmentRoleList *[]string `json:"developmentRoleList,omitempty"` - - - // DevelopmentTypeList - The list of development types used to filter agent development view - DevelopmentTypeList *[]string `json:"developmentTypeList,omitempty"` - - - // DevelopmentStatusList - The list of development status used to filter agent development view - DevelopmentStatusList *[]string `json:"developmentStatusList,omitempty"` - - - // DevelopmentModuleIds - The list of development moduleIds used to filter agent development view - DevelopmentModuleIds *[]string `json:"developmentModuleIds,omitempty"` - - - // DevelopmentKeyType - Represents due or completed to filter agent development view - DevelopmentKeyType *string `json:"developmentKeyType,omitempty"` - - - // DevelopmentActivityOverdue - Indicates filtering for development activities - DevelopmentActivityOverdue *bool `json:"developmentActivityOverdue,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Viewfilter) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/visibilitycondition.go b/build/platformclientv2/visibilitycondition.go deleted file mode 100644 index a8cae1e6c..000000000 --- a/build/platformclientv2/visibilitycondition.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Visibilitycondition -type Visibilitycondition struct { - // CombiningOperation - CombiningOperation *string `json:"combiningOperation,omitempty"` - - - // Predicates - A list of strings, each representing the location in the form of the Answer Option to depend on. In the format of \"/form/questionGroup/{questionGroupIndex}/question/{questionIndex}/answer/{answerIndex}\" or, to assume the current question group, \"../question/{questionIndex}/answer/{answerIndex}\". Note: Indexes are zero-based - Predicates *[]map[string]interface{} `json:"predicates,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Visibilitycondition) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/vmpairinginfo.go b/build/platformclientv2/vmpairinginfo.go deleted file mode 100644 index 874444995..000000000 --- a/build/platformclientv2/vmpairinginfo.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Vmpairinginfo -type Vmpairinginfo struct { - // MetaData - This is to be used to complete the setup process of a locally deployed virtual edge device. - MetaData *Metadata `json:"meta-data,omitempty"` - - - // EdgeId - EdgeId *string `json:"edge-id,omitempty"` - - - // AuthToken - AuthToken *string `json:"auth-token,omitempty"` - - - // OrgId - OrgId *string `json:"org-id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Vmpairinginfo) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/voicemail.go b/build/platformclientv2/voicemail.go deleted file mode 100644 index af847e846..000000000 --- a/build/platformclientv2/voicemail.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Voicemail -type Voicemail struct { - // Id - The voicemail id - Id *string `json:"id,omitempty"` - - - // UploadStatus - current state of the voicemail upload - UploadStatus *string `json:"uploadStatus,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Voicemail) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/voicemailapi.go b/build/platformclientv2/voicemailapi.go deleted file mode 100644 index 4c7a3ee67..000000000 --- a/build/platformclientv2/voicemailapi.go +++ /dev/null @@ -1,1832 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "encoding/json" -) - -// VoicemailApi provides functions for API endpoints -type VoicemailApi struct { - Configuration *Configuration -} - -// NewVoicemailApi creates an API instance using the default configuration -func NewVoicemailApi() *VoicemailApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating VoicemailApi with base path: %s", strings.ToLower(config.BasePath))) - return &VoicemailApi{ - Configuration: config, - } -} - -// NewVoicemailApiWithConfig creates an API instance using the provided configuration -func NewVoicemailApiWithConfig(config *Configuration) *VoicemailApi { - config.Debugf("Creating VoicemailApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &VoicemailApi{ - Configuration: config, - } -} - -// DeleteVoicemailMessage invokes DELETE /api/v2/voicemail/messages/{messageId} -// -// Delete a voicemail message. -// -// A user voicemail can only be deleted by its associated user. A group voicemail can only be deleted by a user that is a member of the group. A queue voicemail can only be deleted by a user with the acd voicemail delete permission. -func (a VoicemailApi) DeleteVoicemailMessage(messageId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/voicemail/messages/{messageId}" - path = strings.Replace(path, "{messageId}", fmt.Sprintf("%v", messageId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'messageId' is set - if &messageId == nil { - // - return nil, errors.New("Missing required parameter 'messageId' when calling VoicemailApi->DeleteVoicemailMessage") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteVoicemailMessages invokes DELETE /api/v2/voicemail/messages -// -// Delete all voicemail messages -// -// -func (a VoicemailApi) DeleteVoicemailMessages() (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/voicemail/messages" - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// GetVoicemailGroupMailbox invokes GET /api/v2/voicemail/groups/{groupId}/mailbox -// -// Get the group's mailbox information -// -// -func (a VoicemailApi) GetVoicemailGroupMailbox(groupId string) (*Voicemailmailboxinfo, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/voicemail/groups/{groupId}/mailbox" - path = strings.Replace(path, "{groupId}", fmt.Sprintf("%v", groupId), -1) - defaultReturn := new(Voicemailmailboxinfo) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'groupId' is set - if &groupId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'groupId' when calling VoicemailApi->GetVoicemailGroupMailbox") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Voicemailmailboxinfo - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetVoicemailGroupMessages invokes GET /api/v2/voicemail/groups/{groupId}/messages -// -// List voicemail messages -// -// -func (a VoicemailApi) GetVoicemailGroupMessages(groupId string, pageSize int, pageNumber int) (*Voicemailmessageentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/voicemail/groups/{groupId}/messages" - path = strings.Replace(path, "{groupId}", fmt.Sprintf("%v", groupId), -1) - defaultReturn := new(Voicemailmessageentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'groupId' is set - if &groupId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'groupId' when calling VoicemailApi->GetVoicemailGroupMessages") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Voicemailmessageentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetVoicemailGroupPolicy invokes GET /api/v2/voicemail/groups/{groupId}/policy -// -// Get a group's voicemail policy -// -// -func (a VoicemailApi) GetVoicemailGroupPolicy(groupId string) (*Voicemailgrouppolicy, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/voicemail/groups/{groupId}/policy" - path = strings.Replace(path, "{groupId}", fmt.Sprintf("%v", groupId), -1) - defaultReturn := new(Voicemailgrouppolicy) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'groupId' is set - if &groupId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'groupId' when calling VoicemailApi->GetVoicemailGroupPolicy") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Voicemailgrouppolicy - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetVoicemailMailbox invokes GET /api/v2/voicemail/mailbox -// -// Get the current user's mailbox information -// -// -func (a VoicemailApi) GetVoicemailMailbox() (*Voicemailmailboxinfo, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/voicemail/mailbox" - defaultReturn := new(Voicemailmailboxinfo) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Voicemailmailboxinfo - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetVoicemailMeMailbox invokes GET /api/v2/voicemail/me/mailbox -// -// Get the current user's mailbox information -// -// -func (a VoicemailApi) GetVoicemailMeMailbox() (*Voicemailmailboxinfo, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/voicemail/me/mailbox" - defaultReturn := new(Voicemailmailboxinfo) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Voicemailmailboxinfo - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetVoicemailMeMessages invokes GET /api/v2/voicemail/me/messages -// -// List voicemail messages -// -// -func (a VoicemailApi) GetVoicemailMeMessages(pageSize int, pageNumber int) (*Voicemailmessageentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/voicemail/me/messages" - defaultReturn := new(Voicemailmessageentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Voicemailmessageentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetVoicemailMePolicy invokes GET /api/v2/voicemail/me/policy -// -// Get the current user's voicemail policy -// -// -func (a VoicemailApi) GetVoicemailMePolicy() (*Voicemailuserpolicy, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/voicemail/me/policy" - defaultReturn := new(Voicemailuserpolicy) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Voicemailuserpolicy - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetVoicemailMessage invokes GET /api/v2/voicemail/messages/{messageId} -// -// Get a voicemail message -// -// -func (a VoicemailApi) GetVoicemailMessage(messageId string, expand []string) (*Voicemailmessage, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/voicemail/messages/{messageId}" - path = strings.Replace(path, "{messageId}", fmt.Sprintf("%v", messageId), -1) - defaultReturn := new(Voicemailmessage) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'messageId' is set - if &messageId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'messageId' when calling VoicemailApi->GetVoicemailMessage") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Voicemailmessage - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetVoicemailMessageMedia invokes GET /api/v2/voicemail/messages/{messageId}/media -// -// Get media playback URI for this voicemail message -// -// -func (a VoicemailApi) GetVoicemailMessageMedia(messageId string, formatId string) (*Voicemailmediainfo, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/voicemail/messages/{messageId}/media" - path = strings.Replace(path, "{messageId}", fmt.Sprintf("%v", messageId), -1) - defaultReturn := new(Voicemailmediainfo) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'messageId' is set - if &messageId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'messageId' when calling VoicemailApi->GetVoicemailMessageMedia") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(formatId).(string); ok { - if str != "" { - queryParams["formatId"] = a.Configuration.APIClient.ParameterToString(formatId, collectionFormat) - } - } else { - queryParams["formatId"] = a.Configuration.APIClient.ParameterToString(formatId, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Voicemailmediainfo - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetVoicemailMessages invokes GET /api/v2/voicemail/messages -// -// List voicemail messages -// -// -func (a VoicemailApi) GetVoicemailMessages(ids string, expand []string) (*Voicemailmessageentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/voicemail/messages" - defaultReturn := new(Voicemailmessageentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(ids).(string); ok { - if str != "" { - queryParams["ids"] = a.Configuration.APIClient.ParameterToString(ids, collectionFormat) - } - } else { - queryParams["ids"] = a.Configuration.APIClient.ParameterToString(ids, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Voicemailmessageentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetVoicemailPolicy invokes GET /api/v2/voicemail/policy -// -// Get a policy -// -// -func (a VoicemailApi) GetVoicemailPolicy() (*Voicemailorganizationpolicy, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/voicemail/policy" - defaultReturn := new(Voicemailorganizationpolicy) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Voicemailorganizationpolicy - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetVoicemailQueueMessages invokes GET /api/v2/voicemail/queues/{queueId}/messages -// -// List voicemail messages -// -// -func (a VoicemailApi) GetVoicemailQueueMessages(queueId string, pageSize int, pageNumber int) (*Voicemailmessageentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/voicemail/queues/{queueId}/messages" - path = strings.Replace(path, "{queueId}", fmt.Sprintf("%v", queueId), -1) - defaultReturn := new(Voicemailmessageentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'queueId' is set - if &queueId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'queueId' when calling VoicemailApi->GetVoicemailQueueMessages") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Voicemailmessageentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetVoicemailSearch invokes GET /api/v2/voicemail/search -// -// Search voicemails using the q64 value returned from a previous search -// -// -func (a VoicemailApi) GetVoicemailSearch(q64 string, expand []string) (*Voicemailssearchresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/voicemail/search" - defaultReturn := new(Voicemailssearchresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'q64' is set - if &q64 == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'q64' when calling VoicemailApi->GetVoicemailSearch") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(q64).(string); ok { - if str != "" { - queryParams["q64"] = a.Configuration.APIClient.ParameterToString(q64, collectionFormat) - } - } else { - queryParams["q64"] = a.Configuration.APIClient.ParameterToString(q64, collectionFormat) - } - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Voicemailssearchresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetVoicemailUserpolicy invokes GET /api/v2/voicemail/userpolicies/{userId} -// -// Get a user's voicemail policy -// -// -func (a VoicemailApi) GetVoicemailUserpolicy(userId string) (*Voicemailuserpolicy, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/voicemail/userpolicies/{userId}" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Voicemailuserpolicy) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling VoicemailApi->GetVoicemailUserpolicy") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Voicemailuserpolicy - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchVoicemailGroupPolicy invokes PATCH /api/v2/voicemail/groups/{groupId}/policy -// -// Update a group's voicemail policy -// -// -func (a VoicemailApi) PatchVoicemailGroupPolicy(groupId string, body Voicemailgrouppolicy) (*Voicemailgrouppolicy, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/voicemail/groups/{groupId}/policy" - path = strings.Replace(path, "{groupId}", fmt.Sprintf("%v", groupId), -1) - defaultReturn := new(Voicemailgrouppolicy) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'groupId' is set - if &groupId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'groupId' when calling VoicemailApi->PatchVoicemailGroupPolicy") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling VoicemailApi->PatchVoicemailGroupPolicy") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Voicemailgrouppolicy - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchVoicemailMePolicy invokes PATCH /api/v2/voicemail/me/policy -// -// Update the current user's voicemail policy -// -// -func (a VoicemailApi) PatchVoicemailMePolicy(body Voicemailuserpolicy) (*Voicemailuserpolicy, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/voicemail/me/policy" - defaultReturn := new(Voicemailuserpolicy) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling VoicemailApi->PatchVoicemailMePolicy") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Voicemailuserpolicy - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchVoicemailMessage invokes PATCH /api/v2/voicemail/messages/{messageId} -// -// Update a voicemail message -// -// A user voicemail can only be modified by its associated user. A group voicemail can only be modified by a user that is a member of the group. A queue voicemail can only be modified by a participant of the conversation the voicemail is associated with. -func (a VoicemailApi) PatchVoicemailMessage(messageId string, body Voicemailmessage) (*Voicemailmessage, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/voicemail/messages/{messageId}" - path = strings.Replace(path, "{messageId}", fmt.Sprintf("%v", messageId), -1) - defaultReturn := new(Voicemailmessage) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'messageId' is set - if &messageId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'messageId' when calling VoicemailApi->PatchVoicemailMessage") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling VoicemailApi->PatchVoicemailMessage") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Voicemailmessage - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchVoicemailUserpolicy invokes PATCH /api/v2/voicemail/userpolicies/{userId} -// -// Update a user's voicemail policy -// -// -func (a VoicemailApi) PatchVoicemailUserpolicy(userId string, body Voicemailuserpolicy) (*Voicemailuserpolicy, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/voicemail/userpolicies/{userId}" - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Voicemailuserpolicy) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling VoicemailApi->PatchVoicemailUserpolicy") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling VoicemailApi->PatchVoicemailUserpolicy") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Voicemailuserpolicy - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostVoicemailMessages invokes POST /api/v2/voicemail/messages -// -// Copy a voicemail message to a user or group -// -// -func (a VoicemailApi) PostVoicemailMessages(body Copyvoicemailmessage) (*Voicemailmessage, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/voicemail/messages" - defaultReturn := new(Voicemailmessage) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Voicemailmessage - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostVoicemailSearch invokes POST /api/v2/voicemail/search -// -// Search voicemails -// -// -func (a VoicemailApi) PostVoicemailSearch(body Voicemailsearchrequest) (*Voicemailssearchresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/voicemail/search" - defaultReturn := new(Voicemailssearchresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling VoicemailApi->PostVoicemailSearch") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Voicemailssearchresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutVoicemailMessage invokes PUT /api/v2/voicemail/messages/{messageId} -// -// Update a voicemail message -// -// A user voicemail can only be modified by its associated user. A group voicemail can only be modified by a user that is a member of the group. A queue voicemail can only be modified by a participant of the conversation the voicemail is associated with. -func (a VoicemailApi) PutVoicemailMessage(messageId string, body Voicemailmessage) (*Voicemailmessage, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/voicemail/messages/{messageId}" - path = strings.Replace(path, "{messageId}", fmt.Sprintf("%v", messageId), -1) - defaultReturn := new(Voicemailmessage) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'messageId' is set - if &messageId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'messageId' when calling VoicemailApi->PutVoicemailMessage") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling VoicemailApi->PutVoicemailMessage") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Voicemailmessage - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutVoicemailPolicy invokes PUT /api/v2/voicemail/policy -// -// Update a policy -// -// -func (a VoicemailApi) PutVoicemailPolicy(body Voicemailorganizationpolicy) (*Voicemailorganizationpolicy, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/voicemail/policy" - defaultReturn := new(Voicemailorganizationpolicy) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling VoicemailApi->PutVoicemailPolicy") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Voicemailorganizationpolicy - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/voicemailcopyrecord.go b/build/platformclientv2/voicemailcopyrecord.go deleted file mode 100644 index 9fe950b8f..000000000 --- a/build/platformclientv2/voicemailcopyrecord.go +++ /dev/null @@ -1,26 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Voicemailcopyrecord -type Voicemailcopyrecord struct { - // User - The user that the voicemail message was copied to/from - User *User `json:"user,omitempty"` - - - // Group - The group that the voicemail message was copied to/from - Group *Group `json:"group,omitempty"` - - - // Date - The date when the voicemail was copied. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - Date *time.Time `json:"date,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Voicemailcopyrecord) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/voicemailgrouppolicy.go b/build/platformclientv2/voicemailgrouppolicy.go deleted file mode 100644 index bd7845b3f..000000000 --- a/build/platformclientv2/voicemailgrouppolicy.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Voicemailgrouppolicy -type Voicemailgrouppolicy struct { - // Name - Name *string `json:"name,omitempty"` - - - // Group - The group associated with the policy - Group *Group `json:"group,omitempty"` - - - // Enabled - Whether voicemail is enabled for the group - Enabled *bool `json:"enabled,omitempty"` - - - // SendEmailNotifications - Whether email notifications are sent to group members when a new voicemail is received - SendEmailNotifications *bool `json:"sendEmailNotifications,omitempty"` - - - // RotateCallsSecs - How many seconds to ring before rotating to the next member in the group - RotateCallsSecs *int `json:"rotateCallsSecs,omitempty"` - - - // StopRingingAfterRotations - How many rotations to go through - StopRingingAfterRotations *int `json:"stopRingingAfterRotations,omitempty"` - - - // OverflowGroupId - A fallback group to contact when all of the members in this group did not answer the call. - OverflowGroupId *string `json:"overflowGroupId,omitempty"` - - - // GroupAlertType - Specifies if the members in this group should be contacted randomly, in a specific order, or by round-robin. - GroupAlertType *string `json:"groupAlertType,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Voicemailgrouppolicy) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/voicemailmailboxinfo.go b/build/platformclientv2/voicemailmailboxinfo.go deleted file mode 100644 index de512f2eb..000000000 --- a/build/platformclientv2/voicemailmailboxinfo.go +++ /dev/null @@ -1,38 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Voicemailmailboxinfo -type Voicemailmailboxinfo struct { - // UsageSizeBytes - The total number of bytes for all voicemail message audio recordings - UsageSizeBytes *int `json:"usageSizeBytes,omitempty"` - - - // TotalCount - The total number of voicemail messages - TotalCount *int `json:"totalCount,omitempty"` - - - // UnreadCount - The total number of voicemail messages marked as unread - UnreadCount *int `json:"unreadCount,omitempty"` - - - // DeletedCount - The total number of voicemail messages marked as deleted - DeletedCount *int `json:"deletedCount,omitempty"` - - - // CreatedDate - The date of the oldest voicemail message. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - CreatedDate *time.Time `json:"createdDate,omitempty"` - - - // ModifiedDate - The date of the most recent voicemail message. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ModifiedDate *time.Time `json:"modifiedDate,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Voicemailmailboxinfo) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/voicemailmediainfo.go b/build/platformclientv2/voicemailmediainfo.go deleted file mode 100644 index 16ac06da9..000000000 --- a/build/platformclientv2/voicemailmediainfo.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Voicemailmediainfo -type Voicemailmediainfo struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // MediaFileUri - MediaFileUri *string `json:"mediaFileUri,omitempty"` - - - // MediaImageUri - MediaImageUri *string `json:"mediaImageUri,omitempty"` - - - // WaveformData - WaveformData *[]float32 `json:"waveformData,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Voicemailmediainfo) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/voicemailmessage.go b/build/platformclientv2/voicemailmessage.go deleted file mode 100644 index 8b4ddbed1..000000000 --- a/build/platformclientv2/voicemailmessage.go +++ /dev/null @@ -1,94 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Voicemailmessage -type Voicemailmessage struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Conversation - The conversation that the voicemail message is associated with - Conversation *Conversation `json:"conversation,omitempty"` - - - // Read - Whether the voicemail message is marked as read - Read *bool `json:"read,omitempty"` - - - // AudioRecordingDurationSeconds - The voicemail message's audio recording duration in seconds - AudioRecordingDurationSeconds *int `json:"audioRecordingDurationSeconds,omitempty"` - - - // AudioRecordingSizeBytes - The voicemail message's audio recording size in bytes - AudioRecordingSizeBytes *int `json:"audioRecordingSizeBytes,omitempty"` - - - // CreatedDate - The date the voicemail message was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - CreatedDate *time.Time `json:"createdDate,omitempty"` - - - // ModifiedDate - The date the voicemail message was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ModifiedDate *time.Time `json:"modifiedDate,omitempty"` - - - // DeletedDate - The date the voicemail message deleted property was set to true. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DeletedDate *time.Time `json:"deletedDate,omitempty"` - - - // CallerAddress - The caller address - CallerAddress *string `json:"callerAddress,omitempty"` - - - // CallerName - Optionally the name of the caller that left the voicemail message if the caller was a known user - CallerName *string `json:"callerName,omitempty"` - - - // CallerUser - Optionally the user that left the voicemail message if the caller was a known user - CallerUser *User `json:"callerUser,omitempty"` - - - // Deleted - Whether the voicemail message has been marked as deleted - Deleted *bool `json:"deleted,omitempty"` - - - // Note - An optional note - Note *string `json:"note,omitempty"` - - - // User - The user that the voicemail message belongs to or null which means the voicemail message belongs to a group or queue - User *User `json:"user,omitempty"` - - - // Group - The group that the voicemail message belongs to or null which means the voicemail message belongs to a user or queue - Group *Group `json:"group,omitempty"` - - - // Queue - The queue that the voicemail message belongs to or null which means the voicemail message belongs to a user or group - Queue *Queue `json:"queue,omitempty"` - - - // CopiedFrom - Represents where this voicemail message was copied from - CopiedFrom *Voicemailcopyrecord `json:"copiedFrom,omitempty"` - - - // CopiedTo - Represents where this voicemail has been copied to - CopiedTo *[]Voicemailcopyrecord `json:"copiedTo,omitempty"` - - - // DeleteRetentionPolicy - The retention policy for this voicemail when deleted is set to true - DeleteRetentionPolicy *Voicemailretentionpolicy `json:"deleteRetentionPolicy,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Voicemailmessage) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/voicemailmessageentitylisting.go b/build/platformclientv2/voicemailmessageentitylisting.go deleted file mode 100644 index 32c53eff8..000000000 --- a/build/platformclientv2/voicemailmessageentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Voicemailmessageentitylisting -type Voicemailmessageentitylisting struct { - // Entities - Entities *[]Voicemailmessage `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Voicemailmessageentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/voicemailmessagestopicowner.go b/build/platformclientv2/voicemailmessagestopicowner.go deleted file mode 100644 index 07c8249de..000000000 --- a/build/platformclientv2/voicemailmessagestopicowner.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Voicemailmessagestopicowner -type Voicemailmessagestopicowner struct { - // Id - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Voicemailmessagestopicowner) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/voicemailmessagestopicvoicemailcopyrecord.go b/build/platformclientv2/voicemailmessagestopicvoicemailcopyrecord.go deleted file mode 100644 index 121333723..000000000 --- a/build/platformclientv2/voicemailmessagestopicvoicemailcopyrecord.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Voicemailmessagestopicvoicemailcopyrecord -type Voicemailmessagestopicvoicemailcopyrecord struct { - // User - User *Voicemailmessagestopicowner `json:"user,omitempty"` - - - // Group - Group *Voicemailmessagestopicowner `json:"group,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Voicemailmessagestopicvoicemailcopyrecord) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/voicemailmessagestopicvoicemailmessage.go b/build/platformclientv2/voicemailmessagestopicvoicemailmessage.go deleted file mode 100644 index baa96fce9..000000000 --- a/build/platformclientv2/voicemailmessagestopicvoicemailmessage.go +++ /dev/null @@ -1,70 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Voicemailmessagestopicvoicemailmessage -type Voicemailmessagestopicvoicemailmessage struct { - // Id - Id *string `json:"id,omitempty"` - - - // Read - Read *bool `json:"read,omitempty"` - - - // AudioRecordingDurationSeconds - AudioRecordingDurationSeconds *int `json:"audioRecordingDurationSeconds,omitempty"` - - - // AudioRecordingSizeBytes - AudioRecordingSizeBytes *int `json:"audioRecordingSizeBytes,omitempty"` - - - // CreatedDate - CreatedDate *time.Time `json:"createdDate,omitempty"` - - - // ModifiedDate - ModifiedDate *time.Time `json:"modifiedDate,omitempty"` - - - // CallerAddress - CallerAddress *string `json:"callerAddress,omitempty"` - - - // CallerName - CallerName *string `json:"callerName,omitempty"` - - - // Action - Action *string `json:"action,omitempty"` - - - // Note - Note *string `json:"note,omitempty"` - - - // Deleted - Deleted *bool `json:"deleted,omitempty"` - - - // ModifiedByUserId - ModifiedByUserId *string `json:"modifiedByUserId,omitempty"` - - - // CopiedTo - CopiedTo *[]Voicemailmessagestopicvoicemailcopyrecord `json:"copiedTo,omitempty"` - - - // CopiedFrom - CopiedFrom *Voicemailmessagestopicvoicemailcopyrecord `json:"copiedFrom,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Voicemailmessagestopicvoicemailmessage) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/voicemailorganizationpolicy.go b/build/platformclientv2/voicemailorganizationpolicy.go deleted file mode 100644 index b62745da3..000000000 --- a/build/platformclientv2/voicemailorganizationpolicy.go +++ /dev/null @@ -1,42 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Voicemailorganizationpolicy -type Voicemailorganizationpolicy struct { - // Enabled - Whether voicemail is enable for this organization - Enabled *bool `json:"enabled,omitempty"` - - - // AlertTimeoutSeconds - The organization's default number of seconds to ring a user's phone before a call is transfered to voicemail - AlertTimeoutSeconds *int `json:"alertTimeoutSeconds,omitempty"` - - - // PinConfiguration - The configuration for user PINs to access their voicemail from a phone - PinConfiguration *Pinconfiguration `json:"pinConfiguration,omitempty"` - - - // VoicemailExtension - The extension for voicemail retrieval. The default value is *86. - VoicemailExtension *string `json:"voicemailExtension,omitempty"` - - - // PinRequired - If this is true, a PIN is required when accessing a user's voicemail from a phone. - PinRequired *bool `json:"pinRequired,omitempty"` - - - // SendEmailNotifications - Whether email notifications are sent for new voicemails in the organization. If false, new voicemail email notifications are not be sent for the organization overriding any user or group setting. - SendEmailNotifications *bool `json:"sendEmailNotifications,omitempty"` - - - // ModifiedDate - The date the policy was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ModifiedDate *time.Time `json:"modifiedDate,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Voicemailorganizationpolicy) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/voicemailretentionpolicy.go b/build/platformclientv2/voicemailretentionpolicy.go deleted file mode 100644 index e1f3616a5..000000000 --- a/build/platformclientv2/voicemailretentionpolicy.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Voicemailretentionpolicy - Governs how the voicemail is retained -type Voicemailretentionpolicy struct { - // VoicemailRetentionPolicyType - The retention policy type - VoicemailRetentionPolicyType *string `json:"voicemailRetentionPolicyType,omitempty"` - - - // NumberOfDays - If retentionPolicyType == RETAIN_WITH_TTL, then this value represents the number of days for the TTL - NumberOfDays *int `json:"numberOfDays,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Voicemailretentionpolicy) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/voicemailsearchcriteria.go b/build/platformclientv2/voicemailsearchcriteria.go deleted file mode 100644 index 06f3337cb..000000000 --- a/build/platformclientv2/voicemailsearchcriteria.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Voicemailsearchcriteria -type Voicemailsearchcriteria struct { - // EndValue - The end value of the range. This field is used for range search types. - EndValue *string `json:"endValue,omitempty"` - - - // Values - A list of values for the search to match against - Values *[]string `json:"values,omitempty"` - - - // StartValue - The start value of the range. This field is used for range search types. - StartValue *string `json:"startValue,omitempty"` - - - // Fields - Field names to search against - Fields *[]string `json:"fields,omitempty"` - - - // Value - A value for the search to match against - Value *string `json:"value,omitempty"` - - - // Operator - How to apply this search criteria against other criteria - Operator *string `json:"operator,omitempty"` - - - // Group - Groups multiple conditions - Group *[]Voicemailsearchcriteria `json:"group,omitempty"` - - - // DateFormat - Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX. - DateFormat *string `json:"dateFormat,omitempty"` - - - // VarType - Search Type - VarType *string `json:"type,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Voicemailsearchcriteria) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/voicemailsearchrequest.go b/build/platformclientv2/voicemailsearchrequest.go deleted file mode 100644 index a2b224cbd..000000000 --- a/build/platformclientv2/voicemailsearchrequest.go +++ /dev/null @@ -1,41 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Voicemailsearchrequest -type Voicemailsearchrequest struct { - // SortOrder - The sort order for results - SortOrder *string `json:"sortOrder,omitempty"` - - - // SortBy - The field in the resource that you want to sort the results by - SortBy *string `json:"sortBy,omitempty"` - - - // PageSize - The number of results per page - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - The page of resources you want to retrieve - PageNumber *int `json:"pageNumber,omitempty"` - - - // Sort - Multi-value sort order, list of multiple sort values - Sort *[]Searchsort `json:"sort,omitempty"` - - - // Expand - Provides more details about a specified resource - Expand *[]string `json:"expand,omitempty"` - - - // Query - Query *[]Voicemailsearchcriteria `json:"query,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Voicemailsearchrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/voicemailssearchresponse.go b/build/platformclientv2/voicemailssearchresponse.go deleted file mode 100644 index 7f17edf1b..000000000 --- a/build/platformclientv2/voicemailssearchresponse.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Voicemailssearchresponse -type Voicemailssearchresponse struct { - // Total - The total number of results found - Total *int `json:"total,omitempty"` - - - // PageCount - The total number of pages - PageCount *int `json:"pageCount,omitempty"` - - - // PageSize - The current page size - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - The current page number - PageNumber *int `json:"pageNumber,omitempty"` - - - // PreviousPage - Q64 value for the previous page of results - PreviousPage *string `json:"previousPage,omitempty"` - - - // CurrentPage - Q64 value for the current page of results - CurrentPage *string `json:"currentPage,omitempty"` - - - // NextPage - Q64 value for the next page of results - NextPage *string `json:"nextPage,omitempty"` - - - // Types - Resource types the search was performed against - Types *[]string `json:"types,omitempty"` - - - // Results - Search results - Results *[]Voicemailmessage `json:"results,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Voicemailssearchresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/voicemailuserpolicy.go b/build/platformclientv2/voicemailuserpolicy.go deleted file mode 100644 index 04effd487..000000000 --- a/build/platformclientv2/voicemailuserpolicy.go +++ /dev/null @@ -1,34 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Voicemailuserpolicy -type Voicemailuserpolicy struct { - // Enabled - Whether the user has voicemail enabled - Enabled *bool `json:"enabled,omitempty"` - - - // AlertTimeoutSeconds - The number of seconds to ring the user's phone before a call is transfered to voicemail - AlertTimeoutSeconds *int `json:"alertTimeoutSeconds,omitempty"` - - - // Pin - The user's PIN to access their voicemail. This property is only used for updates and never provided otherwise to ensure security - Pin *string `json:"pin,omitempty"` - - - // ModifiedDate - The date the policy was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - ModifiedDate *time.Time `json:"modifiedDate,omitempty"` - - - // SendEmailNotifications - Whether email notifications are sent to the user when a new voicemail is received - SendEmailNotifications *bool `json:"sendEmailNotifications,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Voicemailuserpolicy) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/webchatapi.go b/build/platformclientv2/webchatapi.go deleted file mode 100644 index b058cddee..000000000 --- a/build/platformclientv2/webchatapi.go +++ /dev/null @@ -1,1461 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "encoding/json" -) - -// WebChatApi provides functions for API endpoints -type WebChatApi struct { - Configuration *Configuration -} - -// NewWebChatApi creates an API instance using the default configuration -func NewWebChatApi() *WebChatApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating WebChatApi with base path: %s", strings.ToLower(config.BasePath))) - return &WebChatApi{ - Configuration: config, - } -} - -// NewWebChatApiWithConfig creates an API instance using the provided configuration -func NewWebChatApiWithConfig(config *Configuration) *WebChatApi { - config.Debugf("Creating WebChatApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &WebChatApi{ - Configuration: config, - } -} - -// DeleteWebchatDeployment invokes DELETE /api/v2/webchat/deployments/{deploymentId} -// -// Delete a WebChat deployment -// -// -func (a WebChatApi) DeleteWebchatDeployment(deploymentId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/webchat/deployments/{deploymentId}" - path = strings.Replace(path, "{deploymentId}", fmt.Sprintf("%v", deploymentId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'deploymentId' is set - if &deploymentId == nil { - // - return nil, errors.New("Missing required parameter 'deploymentId' when calling WebChatApi->DeleteWebchatDeployment") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteWebchatGuestConversationMember invokes DELETE /api/v2/webchat/guest/conversations/{conversationId}/members/{memberId} -// -// Remove a member from a chat conversation -// -// -func (a WebChatApi) DeleteWebchatGuestConversationMember(conversationId string, memberId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{memberId}", fmt.Sprintf("%v", memberId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return nil, errors.New("Missing required parameter 'conversationId' when calling WebChatApi->DeleteWebchatGuestConversationMember") - } - // verify the required parameter 'memberId' is set - if &memberId == nil { - // - return nil, errors.New("Missing required parameter 'memberId' when calling WebChatApi->DeleteWebchatGuestConversationMember") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (Guest Chat JWT) required - - // set key with prefix in header - headerParams["Authorization"] = a.Configuration.GetAPIKeyWithPrefix("Authorization") - - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteWebchatSettings invokes DELETE /api/v2/webchat/settings -// -// Remove WebChat deployment settings -// -// -func (a WebChatApi) DeleteWebchatSettings() (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/webchat/settings" - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// GetWebchatDeployment invokes GET /api/v2/webchat/deployments/{deploymentId} -// -// Get a WebChat deployment -// -// -func (a WebChatApi) GetWebchatDeployment(deploymentId string) (*Webchatdeployment, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/webchat/deployments/{deploymentId}" - path = strings.Replace(path, "{deploymentId}", fmt.Sprintf("%v", deploymentId), -1) - defaultReturn := new(Webchatdeployment) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'deploymentId' is set - if &deploymentId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'deploymentId' when calling WebChatApi->GetWebchatDeployment") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Webchatdeployment - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWebchatDeployments invokes GET /api/v2/webchat/deployments -// -// List WebChat deployments -// -// -func (a WebChatApi) GetWebchatDeployments() (*Webchatdeploymententitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/webchat/deployments" - defaultReturn := new(Webchatdeploymententitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Webchatdeploymententitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWebchatGuestConversationMediarequest invokes GET /api/v2/webchat/guest/conversations/{conversationId}/mediarequests/{mediaRequestId} -// -// Get a media request in the conversation -// -// -func (a WebChatApi) GetWebchatGuestConversationMediarequest(conversationId string, mediaRequestId string) (*Webchatguestmediarequest, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/webchat/guest/conversations/{conversationId}/mediarequests/{mediaRequestId}" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{mediaRequestId}", fmt.Sprintf("%v", mediaRequestId), -1) - defaultReturn := new(Webchatguestmediarequest) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling WebChatApi->GetWebchatGuestConversationMediarequest") - } - // verify the required parameter 'mediaRequestId' is set - if &mediaRequestId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'mediaRequestId' when calling WebChatApi->GetWebchatGuestConversationMediarequest") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (Guest Chat JWT) required - - // set key with prefix in header - headerParams["Authorization"] = a.Configuration.GetAPIKeyWithPrefix("Authorization") - - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Webchatguestmediarequest - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWebchatGuestConversationMediarequests invokes GET /api/v2/webchat/guest/conversations/{conversationId}/mediarequests -// -// Get all media requests to the guest in the conversation -// -// -func (a WebChatApi) GetWebchatGuestConversationMediarequests(conversationId string) (*Webchatguestmediarequestentitylist, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/webchat/guest/conversations/{conversationId}/mediarequests" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - defaultReturn := new(Webchatguestmediarequestentitylist) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling WebChatApi->GetWebchatGuestConversationMediarequests") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (Guest Chat JWT) required - - // set key with prefix in header - headerParams["Authorization"] = a.Configuration.GetAPIKeyWithPrefix("Authorization") - - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Webchatguestmediarequestentitylist - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWebchatGuestConversationMember invokes GET /api/v2/webchat/guest/conversations/{conversationId}/members/{memberId} -// -// Get a web chat conversation member -// -// -func (a WebChatApi) GetWebchatGuestConversationMember(conversationId string, memberId string) (*Webchatmemberinfo, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{memberId}", fmt.Sprintf("%v", memberId), -1) - defaultReturn := new(Webchatmemberinfo) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling WebChatApi->GetWebchatGuestConversationMember") - } - // verify the required parameter 'memberId' is set - if &memberId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'memberId' when calling WebChatApi->GetWebchatGuestConversationMember") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (Guest Chat JWT) required - - // set key with prefix in header - headerParams["Authorization"] = a.Configuration.GetAPIKeyWithPrefix("Authorization") - - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Webchatmemberinfo - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWebchatGuestConversationMembers invokes GET /api/v2/webchat/guest/conversations/{conversationId}/members -// -// Get the members of a chat conversation. -// -// -func (a WebChatApi) GetWebchatGuestConversationMembers(conversationId string, pageSize int, pageNumber int, excludeDisconnectedMembers bool) (*Webchatmemberinfoentitylist, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/webchat/guest/conversations/{conversationId}/members" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - defaultReturn := new(Webchatmemberinfoentitylist) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling WebChatApi->GetWebchatGuestConversationMembers") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (Guest Chat JWT) required - - // set key with prefix in header - headerParams["Authorization"] = a.Configuration.GetAPIKeyWithPrefix("Authorization") - - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(excludeDisconnectedMembers).(string); ok { - if str != "" { - queryParams["excludeDisconnectedMembers"] = a.Configuration.APIClient.ParameterToString(excludeDisconnectedMembers, collectionFormat) - } - } else { - queryParams["excludeDisconnectedMembers"] = a.Configuration.APIClient.ParameterToString(excludeDisconnectedMembers, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Webchatmemberinfoentitylist - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWebchatGuestConversationMessage invokes GET /api/v2/webchat/guest/conversations/{conversationId}/messages/{messageId} -// -// Get a web chat conversation message -// -// -func (a WebChatApi) GetWebchatGuestConversationMessage(conversationId string, messageId string) (*Webchatmessage, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/webchat/guest/conversations/{conversationId}/messages/{messageId}" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{messageId}", fmt.Sprintf("%v", messageId), -1) - defaultReturn := new(Webchatmessage) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling WebChatApi->GetWebchatGuestConversationMessage") - } - // verify the required parameter 'messageId' is set - if &messageId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'messageId' when calling WebChatApi->GetWebchatGuestConversationMessage") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (Guest Chat JWT) required - - // set key with prefix in header - headerParams["Authorization"] = a.Configuration.GetAPIKeyWithPrefix("Authorization") - - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Webchatmessage - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWebchatGuestConversationMessages invokes GET /api/v2/webchat/guest/conversations/{conversationId}/messages -// -// Get the messages of a chat conversation. -// -// -func (a WebChatApi) GetWebchatGuestConversationMessages(conversationId string, after string, before string, sortOrder string, maxResults int) (*Webchatmessageentitylist, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/webchat/guest/conversations/{conversationId}/messages" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - defaultReturn := new(Webchatmessageentitylist) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling WebChatApi->GetWebchatGuestConversationMessages") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (Guest Chat JWT) required - - // set key with prefix in header - headerParams["Authorization"] = a.Configuration.GetAPIKeyWithPrefix("Authorization") - - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(after).(string); ok { - if str != "" { - queryParams["after"] = a.Configuration.APIClient.ParameterToString(after, collectionFormat) - } - } else { - queryParams["after"] = a.Configuration.APIClient.ParameterToString(after, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(before).(string); ok { - if str != "" { - queryParams["before"] = a.Configuration.APIClient.ParameterToString(before, collectionFormat) - } - } else { - queryParams["before"] = a.Configuration.APIClient.ParameterToString(before, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(sortOrder).(string); ok { - if str != "" { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - } else { - queryParams["sortOrder"] = a.Configuration.APIClient.ParameterToString(sortOrder, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(maxResults).(string); ok { - if str != "" { - queryParams["maxResults"] = a.Configuration.APIClient.ParameterToString(maxResults, collectionFormat) - } - } else { - queryParams["maxResults"] = a.Configuration.APIClient.ParameterToString(maxResults, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Webchatmessageentitylist - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWebchatSettings invokes GET /api/v2/webchat/settings -// -// Get WebChat deployment settings -// -// -func (a WebChatApi) GetWebchatSettings() (*Webchatsettings, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/webchat/settings" - defaultReturn := new(Webchatsettings) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Webchatsettings - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchWebchatGuestConversationMediarequest invokes PATCH /api/v2/webchat/guest/conversations/{conversationId}/mediarequests/{mediaRequestId} -// -// Update a media request in the conversation, setting the state to ACCEPTED/DECLINED/ERRORED -// -// -func (a WebChatApi) PatchWebchatGuestConversationMediarequest(conversationId string, mediaRequestId string, body Webchatguestmediarequest) (*Webchatguestmediarequest, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/webchat/guest/conversations/{conversationId}/mediarequests/{mediaRequestId}" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{mediaRequestId}", fmt.Sprintf("%v", mediaRequestId), -1) - defaultReturn := new(Webchatguestmediarequest) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling WebChatApi->PatchWebchatGuestConversationMediarequest") - } - // verify the required parameter 'mediaRequestId' is set - if &mediaRequestId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'mediaRequestId' when calling WebChatApi->PatchWebchatGuestConversationMediarequest") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling WebChatApi->PatchWebchatGuestConversationMediarequest") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (Guest Chat JWT) required - - // set key with prefix in header - headerParams["Authorization"] = a.Configuration.GetAPIKeyWithPrefix("Authorization") - - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Webchatguestmediarequest - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostWebchatDeployments invokes POST /api/v2/webchat/deployments -// -// Create WebChat deployment -// -// -func (a WebChatApi) PostWebchatDeployments(body Webchatdeployment) (*Webchatdeployment, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/webchat/deployments" - defaultReturn := new(Webchatdeployment) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling WebChatApi->PostWebchatDeployments") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Webchatdeployment - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostWebchatGuestConversationMemberMessages invokes POST /api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}/messages -// -// Send a message in a chat conversation. -// -// -func (a WebChatApi) PostWebchatGuestConversationMemberMessages(conversationId string, memberId string, body Createwebchatmessagerequest) (*Webchatmessage, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}/messages" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{memberId}", fmt.Sprintf("%v", memberId), -1) - defaultReturn := new(Webchatmessage) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling WebChatApi->PostWebchatGuestConversationMemberMessages") - } - // verify the required parameter 'memberId' is set - if &memberId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'memberId' when calling WebChatApi->PostWebchatGuestConversationMemberMessages") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling WebChatApi->PostWebchatGuestConversationMemberMessages") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (Guest Chat JWT) required - - // set key with prefix in header - headerParams["Authorization"] = a.Configuration.GetAPIKeyWithPrefix("Authorization") - - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Webchatmessage - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostWebchatGuestConversationMemberTyping invokes POST /api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}/typing -// -// Send a typing-indicator in a chat conversation. -// -// -func (a WebChatApi) PostWebchatGuestConversationMemberTyping(conversationId string, memberId string) (*Webchattyping, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}/typing" - path = strings.Replace(path, "{conversationId}", fmt.Sprintf("%v", conversationId), -1) - path = strings.Replace(path, "{memberId}", fmt.Sprintf("%v", memberId), -1) - defaultReturn := new(Webchattyping) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'conversationId' is set - if &conversationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'conversationId' when calling WebChatApi->PostWebchatGuestConversationMemberTyping") - } - // verify the required parameter 'memberId' is set - if &memberId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'memberId' when calling WebChatApi->PostWebchatGuestConversationMemberTyping") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (Guest Chat JWT) required - - // set key with prefix in header - headerParams["Authorization"] = a.Configuration.GetAPIKeyWithPrefix("Authorization") - - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Webchattyping - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostWebchatGuestConversations invokes POST /api/v2/webchat/guest/conversations -// -// Create an ACD chat conversation from an external customer. -// -// This endpoint will create a new ACD Chat conversation under the specified Chat Deployment. The conversation will begin with a guest member in it (with a role=CUSTOMER) according to the customer information that is supplied. If the guest member is authenticated, the 'memberAuthToken' field should include his JWT as generated by the 'POST /api/v2/signeddata' resource; if the guest member is anonymous (and the Deployment permits it) this field can be omitted. The returned data includes the IDs of the conversation created, along with a newly-create JWT token that you can supply to all future endpoints as authentication to perform operations against that conversation. After successfully creating a conversation, you should connect a websocket to the event stream named in the 'eventStreamUri' field of the response; the conversation is not routed until the event stream is attached. -func (a WebChatApi) PostWebchatGuestConversations(body Createwebchatconversationrequest) (*Createwebchatconversationresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/webchat/guest/conversations" - defaultReturn := new(Createwebchatconversationresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling WebChatApi->PostWebchatGuestConversations") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Createwebchatconversationresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutWebchatDeployment invokes PUT /api/v2/webchat/deployments/{deploymentId} -// -// Update a WebChat deployment -// -// -func (a WebChatApi) PutWebchatDeployment(deploymentId string, body Webchatdeployment) (*Webchatdeployment, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/webchat/deployments/{deploymentId}" - path = strings.Replace(path, "{deploymentId}", fmt.Sprintf("%v", deploymentId), -1) - defaultReturn := new(Webchatdeployment) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'deploymentId' is set - if &deploymentId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'deploymentId' when calling WebChatApi->PutWebchatDeployment") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling WebChatApi->PutWebchatDeployment") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Webchatdeployment - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutWebchatSettings invokes PUT /api/v2/webchat/settings -// -// Update WebChat deployment settings -// -// -func (a WebChatApi) PutWebchatSettings(body Webchatsettings) (*Webchatsettings, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/webchat/settings" - defaultReturn := new(Webchatsettings) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling WebChatApi->PutWebchatSettings") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Webchatsettings - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/webchatconfig.go b/build/platformclientv2/webchatconfig.go deleted file mode 100644 index 1fa0ba04f..000000000 --- a/build/platformclientv2/webchatconfig.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Webchatconfig -type Webchatconfig struct { - // WebChatSkin - css class to be applied to the web chat widget. - WebChatSkin *string `json:"webChatSkin,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Webchatconfig) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/webchatconversation.go b/build/platformclientv2/webchatconversation.go deleted file mode 100644 index 5846e3d98..000000000 --- a/build/platformclientv2/webchatconversation.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Webchatconversation -type Webchatconversation struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Member - Chat Member - Member *Webchatmemberinfo `json:"member,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Webchatconversation) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/webchatdeployment.go b/build/platformclientv2/webchatdeployment.go deleted file mode 100644 index 7e304ed2e..000000000 --- a/build/platformclientv2/webchatdeployment.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Webchatdeployment -type Webchatdeployment struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Description - Description *string `json:"description,omitempty"` - - - // AuthenticationRequired - AuthenticationRequired *bool `json:"authenticationRequired,omitempty"` - - - // AuthenticationUrl - URL for third party service authenticating web chat clients. See https://github.com/MyPureCloud/authenticated-web-chat-server-examples - AuthenticationUrl *string `json:"authenticationUrl,omitempty"` - - - // Disabled - Disabled *bool `json:"disabled,omitempty"` - - - // WebChatConfig - WebChatConfig *Webchatconfig `json:"webChatConfig,omitempty"` - - - // AllowedDomains - AllowedDomains *[]string `json:"allowedDomains,omitempty"` - - - // Flow - The URI of the Inbound Chat Flow to run when new chats are initiated under this Deployment. - Flow *Domainentityref `json:"flow,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Webchatdeployment) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/webchatdeploymententitylisting.go b/build/platformclientv2/webchatdeploymententitylisting.go deleted file mode 100644 index d372c1452..000000000 --- a/build/platformclientv2/webchatdeploymententitylisting.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Webchatdeploymententitylisting -type Webchatdeploymententitylisting struct { - // Total - Total *int `json:"total,omitempty"` - - - // Entities - Entities *[]Webchatdeployment `json:"entities,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Webchatdeploymententitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/webchatguestmediarequest.go b/build/platformclientv2/webchatguestmediarequest.go deleted file mode 100644 index 6af982132..000000000 --- a/build/platformclientv2/webchatguestmediarequest.go +++ /dev/null @@ -1,41 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Webchatguestmediarequest - Object representing the guest model of a media request of a chat conversation. -type Webchatguestmediarequest struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Types - The types of media being requested. - Types *[]string `json:"types,omitempty"` - - - // State - The state of the media request, one of PENDING|ACCEPTED|DECLINED|TIMEDOUT|CANCELLED|ERRORED. - State *string `json:"state,omitempty"` - - - // CommunicationId - The ID of the new media communication, if applicable. - CommunicationId *string `json:"communicationId,omitempty"` - - - // SecurityKey - The security information related to a media request. - SecurityKey *string `json:"securityKey,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Webchatguestmediarequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/webchatguestmediarequestentitylist.go b/build/platformclientv2/webchatguestmediarequestentitylist.go deleted file mode 100644 index 27003d9ff..000000000 --- a/build/platformclientv2/webchatguestmediarequestentitylist.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Webchatguestmediarequestentitylist -type Webchatguestmediarequestentitylist struct { - // Entities - Entities *[]Webchatguestmediarequest `json:"entities,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Webchatguestmediarequestentitylist) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/webchatmemberinfo.go b/build/platformclientv2/webchatmemberinfo.go deleted file mode 100644 index 2d5f2d19c..000000000 --- a/build/platformclientv2/webchatmemberinfo.go +++ /dev/null @@ -1,66 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Webchatmemberinfo -type Webchatmemberinfo struct { - // Id - The communicationId of this member. - Id *string `json:"id,omitempty"` - - - // DisplayName - The display name of the member. - DisplayName *string `json:"displayName,omitempty"` - - - // FirstName - The first name of the member. - FirstName *string `json:"firstName,omitempty"` - - - // LastName - The last name of the member. - LastName *string `json:"lastName,omitempty"` - - - // Email - The email address of the member. - Email *string `json:"email,omitempty"` - - - // PhoneNumber - The phone number of the member. - PhoneNumber *string `json:"phoneNumber,omitempty"` - - - // AvatarImageUrl - The url to the avatar image of the member. - AvatarImageUrl *string `json:"avatarImageUrl,omitempty"` - - - // Role - The role of the member, one of [agent, customer, acd, workflow] - Role *string `json:"role,omitempty"` - - - // JoinDate - The time the member joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - JoinDate *time.Time `json:"joinDate,omitempty"` - - - // LeaveDate - The time the member left the conversation, or null if the member is still active in the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - LeaveDate *time.Time `json:"leaveDate,omitempty"` - - - // AuthenticatedGuest - If true, the guest member is an authenticated guest. - AuthenticatedGuest *bool `json:"authenticatedGuest,omitempty"` - - - // CustomFields - Any custom fields of information pertaining to this member. - CustomFields *map[string]string `json:"customFields,omitempty"` - - - // State - The connection state of this member. - State *string `json:"state,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Webchatmemberinfo) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/webchatmemberinfoentitylist.go b/build/platformclientv2/webchatmemberinfoentitylist.go deleted file mode 100644 index 131932594..000000000 --- a/build/platformclientv2/webchatmemberinfoentitylist.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Webchatmemberinfoentitylist -type Webchatmemberinfoentitylist struct { - // Entities - Entities *[]Webchatmemberinfo `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Webchatmemberinfoentitylist) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/webchatmessage.go b/build/platformclientv2/webchatmessage.go deleted file mode 100644 index 0306f2de4..000000000 --- a/build/platformclientv2/webchatmessage.go +++ /dev/null @@ -1,46 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Webchatmessage -type Webchatmessage struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Conversation - The identifier of the conversation - Conversation *Webchatconversation `json:"conversation,omitempty"` - - - // Sender - The member who sent the message - Sender *Webchatmemberinfo `json:"sender,omitempty"` - - - // Body - The message body. - Body *string `json:"body,omitempty"` - - - // BodyType - The purpose of the message within the conversation, such as a standard text entry versus a greeting. - BodyType *string `json:"bodyType,omitempty"` - - - // Timestamp - The timestamp of the message, in ISO-8601 format - Timestamp *time.Time `json:"timestamp,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Webchatmessage) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/webchatmessageentitylist.go b/build/platformclientv2/webchatmessageentitylist.go deleted file mode 100644 index 9c06b2c2a..000000000 --- a/build/platformclientv2/webchatmessageentitylist.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Webchatmessageentitylist -type Webchatmessageentitylist struct { - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // Entities - Entities *[]Webchatmessage `json:"entities,omitempty"` - - - // PreviousPage - PreviousPage *string `json:"previousPage,omitempty"` - - - // Next - Next *string `json:"next,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Webchatmessageentitylist) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/webchatroutingtarget.go b/build/platformclientv2/webchatroutingtarget.go deleted file mode 100644 index 79055cee9..000000000 --- a/build/platformclientv2/webchatroutingtarget.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Webchatroutingtarget -type Webchatroutingtarget struct { - // TargetType - The target type of the routing target, such as 'QUEUE'. - TargetType *string `json:"targetType,omitempty"` - - - // TargetAddress - The target of the route, in the format appropriate given the 'targetType'. - TargetAddress *string `json:"targetAddress,omitempty"` - - - // Skills - The list of skill names to use for routing. - Skills *[]string `json:"skills,omitempty"` - - - // Language - The language name to use for routing. - Language *string `json:"language,omitempty"` - - - // Priority - The priority to assign to the conversation for routing. - Priority *int `json:"priority,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Webchatroutingtarget) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/webchatsettings.go b/build/platformclientv2/webchatsettings.go deleted file mode 100644 index c370eb032..000000000 --- a/build/platformclientv2/webchatsettings.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Webchatsettings -type Webchatsettings struct { - // RequireDeployment - RequireDeployment *bool `json:"requireDeployment,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Webchatsettings) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/webchattyping.go b/build/platformclientv2/webchattyping.go deleted file mode 100644 index d46ff4415..000000000 --- a/build/platformclientv2/webchattyping.go +++ /dev/null @@ -1,30 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Webchattyping -type Webchattyping struct { - // Id - The event identifier of this typing indicator event (useful to guard against event re-delivery - Id *string `json:"id,omitempty"` - - - // Conversation - The identifier of the conversation - Conversation *Webchatconversation `json:"conversation,omitempty"` - - - // Sender - The member who sent the message - Sender *Webchatmemberinfo `json:"sender,omitempty"` - - - // Timestamp - The timestamp of the message, in ISO-8601 format - Timestamp *time.Time `json:"timestamp,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Webchattyping) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/webdeploymentsconfigtopicwebmessagingconfigchangeeventbody.go b/build/platformclientv2/webdeploymentsconfigtopicwebmessagingconfigchangeeventbody.go deleted file mode 100644 index 0f3b7a9a6..000000000 --- a/build/platformclientv2/webdeploymentsconfigtopicwebmessagingconfigchangeeventbody.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Webdeploymentsconfigtopicwebmessagingconfigchangeeventbody -type Webdeploymentsconfigtopicwebmessagingconfigchangeeventbody struct { - // Id - Id *string `json:"id,omitempty"` - - - // Version - Version *string `json:"version,omitempty"` - - - // Status - Status *string `json:"status,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Webdeploymentsconfigtopicwebmessagingconfigchangeeventbody) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/webdeploymentsdeploymenttopicwebmessagingconfigchangeeventbody.go b/build/platformclientv2/webdeploymentsdeploymenttopicwebmessagingconfigchangeeventbody.go deleted file mode 100644 index f376ee4e0..000000000 --- a/build/platformclientv2/webdeploymentsdeploymenttopicwebmessagingconfigchangeeventbody.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Webdeploymentsdeploymenttopicwebmessagingconfigchangeeventbody -type Webdeploymentsdeploymenttopicwebmessagingconfigchangeeventbody struct { - // Id - Id *string `json:"id,omitempty"` - - - // Version - Version *string `json:"version,omitempty"` - - - // Status - Status *string `json:"status,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Webdeploymentsdeploymenttopicwebmessagingconfigchangeeventbody) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/webdeploymentsdeploymenttopicwebmessagingdeploymentchangeeventbody.go b/build/platformclientv2/webdeploymentsdeploymenttopicwebmessagingdeploymentchangeeventbody.go deleted file mode 100644 index a04ac5dc0..000000000 --- a/build/platformclientv2/webdeploymentsdeploymenttopicwebmessagingdeploymentchangeeventbody.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Webdeploymentsdeploymenttopicwebmessagingdeploymentchangeeventbody -type Webdeploymentsdeploymenttopicwebmessagingdeploymentchangeeventbody struct { - // Id - Id *string `json:"id,omitempty"` - - - // Configuration - Configuration *Webdeploymentsdeploymenttopicwebmessagingconfigchangeeventbody `json:"configuration,omitempty"` - - - // Status - Status *string `json:"status,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Webdeploymentsdeploymenttopicwebmessagingdeploymentchangeeventbody) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/weekschedule.go b/build/platformclientv2/weekschedule.go deleted file mode 100644 index fb48b3013..000000000 --- a/build/platformclientv2/weekschedule.go +++ /dev/null @@ -1,57 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Weekschedule - Week schedule information -type Weekschedule struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - - - // WeekDate - First day of this week schedule in yyyy-MM-dd format - WeekDate *string `json:"weekDate,omitempty"` - - - // Description - Description of the week schedule - Description *string `json:"description,omitempty"` - - - // Published - Whether the week schedule is published - Published *bool `json:"published,omitempty"` - - - // GenerationResults - Summary of the results from the schedule run - GenerationResults *Weekschedulegenerationresult `json:"generationResults,omitempty"` - - - // ShortTermForecast - Short term forecast associated with this schedule - ShortTermForecast *Shorttermforecastreference `json:"shortTermForecast,omitempty"` - - - // Metadata - Version metadata for this work plan - Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"` - - - // UserSchedules - User schedules in the week - UserSchedules *map[string]Userschedule `json:"userSchedules,omitempty"` - - - // HeadcountForecast - Headcount information for the week schedule - HeadcountForecast *Headcountforecast `json:"headcountForecast,omitempty"` - - - // AgentSchedulesVersion - Version of agent schedules in the week schedule - AgentSchedulesVersion *int `json:"agentSchedulesVersion,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Weekschedule) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/weekschedulegenerationresult.go b/build/platformclientv2/weekschedulegenerationresult.go deleted file mode 100644 index 39517cc61..000000000 --- a/build/platformclientv2/weekschedulegenerationresult.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Weekschedulegenerationresult -type Weekschedulegenerationresult struct { - // Failed - Whether the schedule generation failed - Failed *bool `json:"failed,omitempty"` - - - // RunId - ID of the schedule run - RunId *string `json:"runId,omitempty"` - - - // AgentWarnings - Warning messages from the schedule run. This will be available only when requesting information for a single week schedule - AgentWarnings *[]Schedulegenerationwarning `json:"agentWarnings,omitempty"` - - - // AgentWarningCount - Count of warning messages from the schedule run. This will be available only when requesting multiple week schedules - AgentWarningCount *int `json:"agentWarningCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Weekschedulegenerationresult) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/weekschedulelistitemresponse.go b/build/platformclientv2/weekschedulelistitemresponse.go deleted file mode 100644 index 7aeba6a89..000000000 --- a/build/platformclientv2/weekschedulelistitemresponse.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Weekschedulelistitemresponse -type Weekschedulelistitemresponse struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - - - // WeekDate - First day of this week schedule in yyyy-MM-dd format - WeekDate *string `json:"weekDate,omitempty"` - - - // Description - Description of the week schedule - Description *string `json:"description,omitempty"` - - - // Published - Whether the week schedule is published - Published *bool `json:"published,omitempty"` - - - // GenerationResults - Summary of the results from the schedule run - GenerationResults *Weekschedulegenerationresult `json:"generationResults,omitempty"` - - - // ShortTermForecast - Short term forecast associated with this schedule - ShortTermForecast *Shorttermforecastreference `json:"shortTermForecast,omitempty"` - - - // Metadata - Version metadata for this work plan - Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Weekschedulelistitemresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/weekschedulelistresponse.go b/build/platformclientv2/weekschedulelistresponse.go deleted file mode 100644 index d2bd5ade3..000000000 --- a/build/platformclientv2/weekschedulelistresponse.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Weekschedulelistresponse - Week schedule list -type Weekschedulelistresponse struct { - // Entities - Entities *[]Weekschedulelistitemresponse `json:"entities,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Weekschedulelistresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/weekschedulereference.go b/build/platformclientv2/weekschedulereference.go deleted file mode 100644 index 944241896..000000000 --- a/build/platformclientv2/weekschedulereference.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Weekschedulereference -type Weekschedulereference struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - - - // WeekDate - First day of this week schedule in yyyy-MM-dd format - WeekDate *string `json:"weekDate,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Weekschedulereference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/weekscheduleresponse.go b/build/platformclientv2/weekscheduleresponse.go deleted file mode 100644 index 004f38f4f..000000000 --- a/build/platformclientv2/weekscheduleresponse.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Weekscheduleresponse - Response for query for week schedule for a given week in management unit -type Weekscheduleresponse struct { - // Result - The result of the request. The value will be null if response is large - Result *Weekschedule `json:"result,omitempty"` - - - // DownloadUrl - The url to fetch the result for large responses. The value is null if result contains the data - DownloadUrl *string `json:"downloadUrl,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Weekscheduleresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/weekshifttradelistresponse.go b/build/platformclientv2/weekshifttradelistresponse.go deleted file mode 100644 index cc571690e..000000000 --- a/build/platformclientv2/weekshifttradelistresponse.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Weekshifttradelistresponse -type Weekshifttradelistresponse struct { - // Entities - Entities *[]Weekshifttraderesponse `json:"entities,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Weekshifttradelistresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/weekshifttradematchessummaryresponse.go b/build/platformclientv2/weekshifttradematchessummaryresponse.go deleted file mode 100644 index 33edc48db..000000000 --- a/build/platformclientv2/weekshifttradematchessummaryresponse.go +++ /dev/null @@ -1,22 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Weekshifttradematchessummaryresponse -type Weekshifttradematchessummaryresponse struct { - // WeekDate - The schedule week date in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd - WeekDate *time.Time `json:"weekDate,omitempty"` - - - // Count - The number of trades in the Matched state for the given week - Count *int `json:"count,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Weekshifttradematchessummaryresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/weekshifttraderesponse.go b/build/platformclientv2/weekshifttraderesponse.go deleted file mode 100644 index 59b87939c..000000000 --- a/build/platformclientv2/weekshifttraderesponse.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Weekshifttraderesponse -type Weekshifttraderesponse struct { - // Trade - The shift trade details - Trade *Shifttraderesponse `json:"trade,omitempty"` - - - // MatchReview - A preview of what the schedule would look like if the shift trade is approved plus any violations - MatchReview *Shifttradematchreviewresponse `json:"matchReview,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Weekshifttraderesponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wemcoachingappointmenttopiccoachingappointmentconversation.go b/build/platformclientv2/wemcoachingappointmenttopiccoachingappointmentconversation.go deleted file mode 100644 index 88f236cb2..000000000 --- a/build/platformclientv2/wemcoachingappointmenttopiccoachingappointmentconversation.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wemcoachingappointmenttopiccoachingappointmentconversation -type Wemcoachingappointmenttopiccoachingappointmentconversation struct { - // Id - Id *string `json:"id,omitempty"` - - - // Action - Action *string `json:"action,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wemcoachingappointmenttopiccoachingappointmentconversation) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wemcoachingappointmenttopiccoachingappointmentdocument.go b/build/platformclientv2/wemcoachingappointmenttopiccoachingappointmentdocument.go deleted file mode 100644 index dd4cf508d..000000000 --- a/build/platformclientv2/wemcoachingappointmenttopiccoachingappointmentdocument.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wemcoachingappointmenttopiccoachingappointmentdocument -type Wemcoachingappointmenttopiccoachingappointmentdocument struct { - // Id - Id *string `json:"id,omitempty"` - - - // Action - Action *string `json:"action,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wemcoachingappointmenttopiccoachingappointmentdocument) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wemcoachingappointmenttopiccoachingappointmentexternallink.go b/build/platformclientv2/wemcoachingappointmenttopiccoachingappointmentexternallink.go deleted file mode 100644 index e4e9813a5..000000000 --- a/build/platformclientv2/wemcoachingappointmenttopiccoachingappointmentexternallink.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wemcoachingappointmenttopiccoachingappointmentexternallink -type Wemcoachingappointmenttopiccoachingappointmentexternallink struct { - // ExternalLink - ExternalLink *string `json:"externalLink,omitempty"` - - - // Action - Action *string `json:"action,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wemcoachingappointmenttopiccoachingappointmentexternallink) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wemcoachingappointmenttopiccoachingappointmentnotification.go b/build/platformclientv2/wemcoachingappointmenttopiccoachingappointmentnotification.go deleted file mode 100644 index 77a0b2314..000000000 --- a/build/platformclientv2/wemcoachingappointmenttopiccoachingappointmentnotification.go +++ /dev/null @@ -1,78 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Wemcoachingappointmenttopiccoachingappointmentnotification -type Wemcoachingappointmenttopiccoachingappointmentnotification struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // DateStart - DateStart *time.Time `json:"dateStart,omitempty"` - - - // LengthInMinutes - LengthInMinutes *int `json:"lengthInMinutes,omitempty"` - - - // Status - Status *string `json:"status,omitempty"` - - - // Facilitator - Facilitator *Wemcoachingappointmenttopicuserreference `json:"facilitator,omitempty"` - - - // Attendees - Attendees *[]Wemcoachingappointmenttopicuserreference `json:"attendees,omitempty"` - - - // CreatedBy - CreatedBy *Wemcoachingappointmenttopicuserreference `json:"createdBy,omitempty"` - - - // DateCreated - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // ModifiedBy - ModifiedBy *Wemcoachingappointmenttopicuserreference `json:"modifiedBy,omitempty"` - - - // DateModified - DateModified *time.Time `json:"dateModified,omitempty"` - - - // Conversations - Conversations *[]Wemcoachingappointmenttopiccoachingappointmentconversation `json:"conversations,omitempty"` - - - // Documents - Documents *[]Wemcoachingappointmenttopiccoachingappointmentdocument `json:"documents,omitempty"` - - - // ChangeType - ChangeType *string `json:"changeType,omitempty"` - - - // DateCompleted - DateCompleted *time.Time `json:"dateCompleted,omitempty"` - - - // ExternalLinks - ExternalLinks *[]Wemcoachingappointmenttopiccoachingappointmentexternallink `json:"externalLinks,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wemcoachingappointmenttopiccoachingappointmentnotification) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wemcoachingappointmenttopicuserreference.go b/build/platformclientv2/wemcoachingappointmenttopicuserreference.go deleted file mode 100644 index d67c292b6..000000000 --- a/build/platformclientv2/wemcoachingappointmenttopicuserreference.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wemcoachingappointmenttopicuserreference -type Wemcoachingappointmenttopicuserreference struct { - // Id - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wemcoachingappointmenttopicuserreference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wemlearningassignmentruleruntopiclearningassignmentrulerunnotification.go b/build/platformclientv2/wemlearningassignmentruleruntopiclearningassignmentrulerunnotification.go deleted file mode 100644 index e640c092d..000000000 --- a/build/platformclientv2/wemlearningassignmentruleruntopiclearningassignmentrulerunnotification.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wemlearningassignmentruleruntopiclearningassignmentrulerunnotification -type Wemlearningassignmentruleruntopiclearningassignmentrulerunnotification struct { - // Entities - Entities *[]Wemlearningassignmentruleruntopicwemlearningassignmentscreated `json:"entities,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wemlearningassignmentruleruntopiclearningassignmentrulerunnotification) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wemlearningassignmentruleruntopiclearningmodulereference.go b/build/platformclientv2/wemlearningassignmentruleruntopiclearningmodulereference.go deleted file mode 100644 index ce9f32e6f..000000000 --- a/build/platformclientv2/wemlearningassignmentruleruntopiclearningmodulereference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wemlearningassignmentruleruntopiclearningmodulereference -type Wemlearningassignmentruleruntopiclearningmodulereference struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wemlearningassignmentruleruntopiclearningmodulereference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wemlearningassignmentruleruntopicwemlearningassignmentscreated.go b/build/platformclientv2/wemlearningassignmentruleruntopicwemlearningassignmentscreated.go deleted file mode 100644 index d505f8156..000000000 --- a/build/platformclientv2/wemlearningassignmentruleruntopicwemlearningassignmentscreated.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wemlearningassignmentruleruntopicwemlearningassignmentscreated -type Wemlearningassignmentruleruntopicwemlearningassignmentscreated struct { - // Module - Module *Wemlearningassignmentruleruntopiclearningmodulereference `json:"module,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wemlearningassignmentruleruntopicwemlearningassignmentscreated) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wemlearningassignmenttopiclearningassignmentnotification.go b/build/platformclientv2/wemlearningassignmenttopiclearningassignmentnotification.go deleted file mode 100644 index 59c1c3d67..000000000 --- a/build/platformclientv2/wemlearningassignmenttopiclearningassignmentnotification.go +++ /dev/null @@ -1,54 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Wemlearningassignmenttopiclearningassignmentnotification -type Wemlearningassignmenttopiclearningassignmentnotification struct { - // Id - Id *string `json:"id,omitempty"` - - - // User - User *Wemlearningassignmenttopicuserreference `json:"user,omitempty"` - - - // Module - Module *Wemlearningassignmenttopiclearningmodulereference `json:"module,omitempty"` - - - // Version - Version *int `json:"version,omitempty"` - - - // State - State *string `json:"state,omitempty"` - - - // DateRecommendedForCompletion - DateRecommendedForCompletion *time.Time `json:"dateRecommendedForCompletion,omitempty"` - - - // CreatedBy - CreatedBy *Wemlearningassignmenttopicuserreference `json:"createdBy,omitempty"` - - - // DateCreated - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // ModifiedBy - ModifiedBy *Wemlearningassignmenttopicuserreference `json:"modifiedBy,omitempty"` - - - // DateModified - DateModified *time.Time `json:"dateModified,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wemlearningassignmenttopiclearningassignmentnotification) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wemlearningassignmenttopiclearningmodulereference.go b/build/platformclientv2/wemlearningassignmenttopiclearningmodulereference.go deleted file mode 100644 index 8acf5a353..000000000 --- a/build/platformclientv2/wemlearningassignmenttopiclearningmodulereference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wemlearningassignmenttopiclearningmodulereference -type Wemlearningassignmenttopiclearningmodulereference struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wemlearningassignmenttopiclearningmodulereference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wemlearningassignmenttopicuserreference.go b/build/platformclientv2/wemlearningassignmenttopicuserreference.go deleted file mode 100644 index e63756f1f..000000000 --- a/build/platformclientv2/wemlearningassignmenttopicuserreference.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wemlearningassignmenttopicuserreference -type Wemlearningassignmenttopicuserreference struct { - // Id - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wemlearningassignmenttopicuserreference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmagent.go b/build/platformclientv2/wfmagent.go deleted file mode 100644 index 03bf2245c..000000000 --- a/build/platformclientv2/wfmagent.go +++ /dev/null @@ -1,57 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmagent - Workforce management agent data -type Wfmagent struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // User - The user associated with this data - User *Userreference `json:"user,omitempty"` - - - // WorkPlan - The work plan associated with this agent, if applicable - WorkPlan *Workplanreference `json:"workPlan,omitempty"` - - - // WorkPlanRotation - The work plan rotation associated with this agent, if applicable - WorkPlanRotation *Workplanrotationreference `json:"workPlanRotation,omitempty"` - - - // AcceptDirectShiftTrades - Whether the agent accepts direct shift trade requests - AcceptDirectShiftTrades *bool `json:"acceptDirectShiftTrades,omitempty"` - - - // Queues - List of queues to which this agent is capable of handling - Queues *[]Queuereference `json:"queues,omitempty"` - - - // Languages - The list of languages this agent is capable of handling - Languages *[]Languagereference `json:"languages,omitempty"` - - - // Skills - The list of skills this agent is capable of handling - Skills *[]Routingskillreference `json:"skills,omitempty"` - - - // Schedulable - Whether the agent has the permission to be included in schedule generation - Schedulable *bool `json:"schedulable,omitempty"` - - - // Metadata - Metadata for this agent - Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmagent) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmagentscheduleupdatetopicuserreference.go b/build/platformclientv2/wfmagentscheduleupdatetopicuserreference.go deleted file mode 100644 index 74467479b..000000000 --- a/build/platformclientv2/wfmagentscheduleupdatetopicuserreference.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmagentscheduleupdatetopicuserreference -type Wfmagentscheduleupdatetopicuserreference struct { - // Id - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmagentscheduleupdatetopicuserreference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmagentscheduleupdatetopicwfmagentscheduleupdate.go b/build/platformclientv2/wfmagentscheduleupdatetopicwfmagentscheduleupdate.go deleted file mode 100644 index 43d907f96..000000000 --- a/build/platformclientv2/wfmagentscheduleupdatetopicwfmagentscheduleupdate.go +++ /dev/null @@ -1,22 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Wfmagentscheduleupdatetopicwfmagentscheduleupdate -type Wfmagentscheduleupdatetopicwfmagentscheduleupdate struct { - // UpdateType - UpdateType *string `json:"updateType,omitempty"` - - - // ShiftStartDates - ShiftStartDates *[]time.Time `json:"shiftStartDates,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmagentscheduleupdatetopicwfmagentscheduleupdate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmagentscheduleupdatetopicwfmagentscheduleupdatenotification.go b/build/platformclientv2/wfmagentscheduleupdatetopicwfmagentscheduleupdatenotification.go deleted file mode 100644 index 0bd3a5ea5..000000000 --- a/build/platformclientv2/wfmagentscheduleupdatetopicwfmagentscheduleupdatenotification.go +++ /dev/null @@ -1,38 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Wfmagentscheduleupdatetopicwfmagentscheduleupdatenotification -type Wfmagentscheduleupdatetopicwfmagentscheduleupdatenotification struct { - // User - User *Wfmagentscheduleupdatetopicuserreference `json:"user,omitempty"` - - - // StartDate - StartDate *time.Time `json:"startDate,omitempty"` - - - // EndDate - EndDate *time.Time `json:"endDate,omitempty"` - - - // Shifts - Shifts *[]Wfmagentscheduleupdatetopicwfmscheduleshift `json:"shifts,omitempty"` - - - // FullDayTimeOffMarkers - FullDayTimeOffMarkers *[]Wfmagentscheduleupdatetopicwfmfulldaytimeoffmarker `json:"fullDayTimeOffMarkers,omitempty"` - - - // Updates - Updates *[]Wfmagentscheduleupdatetopicwfmagentscheduleupdate `json:"updates,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmagentscheduleupdatetopicwfmagentscheduleupdatenotification) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmagentscheduleupdatetopicwfmfulldaytimeoffmarker.go b/build/platformclientv2/wfmagentscheduleupdatetopicwfmfulldaytimeoffmarker.go deleted file mode 100644 index e842c1139..000000000 --- a/build/platformclientv2/wfmagentscheduleupdatetopicwfmfulldaytimeoffmarker.go +++ /dev/null @@ -1,41 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmagentscheduleupdatetopicwfmfulldaytimeoffmarker -type Wfmagentscheduleupdatetopicwfmfulldaytimeoffmarker struct { - // TimeOffRequestId - TimeOffRequestId *string `json:"timeOffRequestId,omitempty"` - - - // ManagementUnitDate - ManagementUnitDate *string `json:"managementUnitDate,omitempty"` - - - // ActivityCodeId - ActivityCodeId *string `json:"activityCodeId,omitempty"` - - - // IsPaid - IsPaid *bool `json:"isPaid,omitempty"` - - - // LengthInMinutes - LengthInMinutes *int `json:"lengthInMinutes,omitempty"` - - - // Description - Description *string `json:"description,omitempty"` - - - // Paid - Paid *bool `json:"paid,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmagentscheduleupdatetopicwfmfulldaytimeoffmarker) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmagentscheduleupdatetopicwfmscheduleactivity.go b/build/platformclientv2/wfmagentscheduleupdatetopicwfmscheduleactivity.go deleted file mode 100644 index 7d4963e6a..000000000 --- a/build/platformclientv2/wfmagentscheduleupdatetopicwfmscheduleactivity.go +++ /dev/null @@ -1,38 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Wfmagentscheduleupdatetopicwfmscheduleactivity -type Wfmagentscheduleupdatetopicwfmscheduleactivity struct { - // ActivityCodeId - ActivityCodeId *string `json:"activityCodeId,omitempty"` - - - // StartDate - StartDate *time.Time `json:"startDate,omitempty"` - - - // CountsAsPaidTime - CountsAsPaidTime *bool `json:"countsAsPaidTime,omitempty"` - - - // LengthInMinutes - LengthInMinutes *int `json:"lengthInMinutes,omitempty"` - - - // TimeOffRequestId - TimeOffRequestId *string `json:"timeOffRequestId,omitempty"` - - - // Description - Description *string `json:"description,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmagentscheduleupdatetopicwfmscheduleactivity) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmagentscheduleupdatetopicwfmscheduleshift.go b/build/platformclientv2/wfmagentscheduleupdatetopicwfmscheduleshift.go deleted file mode 100644 index 92e766b22..000000000 --- a/build/platformclientv2/wfmagentscheduleupdatetopicwfmscheduleshift.go +++ /dev/null @@ -1,38 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Wfmagentscheduleupdatetopicwfmscheduleshift -type Wfmagentscheduleupdatetopicwfmscheduleshift struct { - // WeekDate - WeekDate *string `json:"weekDate,omitempty"` - - - // WeekScheduleId - WeekScheduleId *string `json:"weekScheduleId,omitempty"` - - - // Id - Id *string `json:"id,omitempty"` - - - // StartDate - StartDate *time.Time `json:"startDate,omitempty"` - - - // LengthInMinutes - LengthInMinutes *int `json:"lengthInMinutes,omitempty"` - - - // Activities - Activities *[]Wfmagentscheduleupdatetopicwfmscheduleactivity `json:"activities,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmagentscheduleupdatetopicwfmscheduleshift) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbuintradaydataupdatetopicbuintradaydatagroup.go b/build/platformclientv2/wfmbuintradaydataupdatetopicbuintradaydatagroup.go deleted file mode 100644 index 4bb308d96..000000000 --- a/build/platformclientv2/wfmbuintradaydataupdatetopicbuintradaydatagroup.go +++ /dev/null @@ -1,41 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmbuintradaydataupdatetopicbuintradaydatagroup -type Wfmbuintradaydataupdatetopicbuintradaydatagroup struct { - // MediaType - MediaType *string `json:"mediaType,omitempty"` - - - // ForecastDataSummary - ForecastDataSummary *Wfmbuintradaydataupdatetopicbuintradayforecastdata `json:"forecastDataSummary,omitempty"` - - - // ForecastDataPerInterval - ForecastDataPerInterval *[]Wfmbuintradaydataupdatetopicbuintradayforecastdata `json:"forecastDataPerInterval,omitempty"` - - - // ScheduleDataSummary - ScheduleDataSummary *Wfmbuintradaydataupdatetopicbuintradayscheduledata `json:"scheduleDataSummary,omitempty"` - - - // ScheduleDataPerInterval - ScheduleDataPerInterval *[]Wfmbuintradaydataupdatetopicbuintradayscheduledata `json:"scheduleDataPerInterval,omitempty"` - - - // PerformancePredictionDataSummary - PerformancePredictionDataSummary *Wfmbuintradaydataupdatetopicintradayperformancepredictiondata `json:"performancePredictionDataSummary,omitempty"` - - - // PerformancePredictionDataPerInterval - PerformancePredictionDataPerInterval *[]Wfmbuintradaydataupdatetopicintradayperformancepredictiondata `json:"performancePredictionDataPerInterval,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbuintradaydataupdatetopicbuintradaydatagroup) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbuintradaydataupdatetopicbuintradayforecastdata.go b/build/platformclientv2/wfmbuintradaydataupdatetopicbuintradayforecastdata.go deleted file mode 100644 index 159683359..000000000 --- a/build/platformclientv2/wfmbuintradaydataupdatetopicbuintradayforecastdata.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmbuintradaydataupdatetopicbuintradayforecastdata -type Wfmbuintradaydataupdatetopicbuintradayforecastdata struct { - // Offered - Offered *float32 `json:"offered,omitempty"` - - - // AverageHandleTimeSeconds - AverageHandleTimeSeconds *float32 `json:"averageHandleTimeSeconds,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbuintradaydataupdatetopicbuintradayforecastdata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbuintradaydataupdatetopicbuintradaynotification.go b/build/platformclientv2/wfmbuintradaydataupdatetopicbuintradaynotification.go deleted file mode 100644 index 908b71578..000000000 --- a/build/platformclientv2/wfmbuintradaydataupdatetopicbuintradaynotification.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmbuintradaydataupdatetopicbuintradaynotification -type Wfmbuintradaydataupdatetopicbuintradaynotification struct { - // OperationId - OperationId *string `json:"operationId,omitempty"` - - - // Result - Result *Wfmbuintradaydataupdatetopicbuintradayresult `json:"result,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbuintradaydataupdatetopicbuintradaynotification) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbuintradaydataupdatetopicbuintradayresult.go b/build/platformclientv2/wfmbuintradaydataupdatetopicbuintradayresult.go deleted file mode 100644 index cb97c9e85..000000000 --- a/build/platformclientv2/wfmbuintradaydataupdatetopicbuintradayresult.go +++ /dev/null @@ -1,46 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Wfmbuintradaydataupdatetopicbuintradayresult -type Wfmbuintradaydataupdatetopicbuintradayresult struct { - // StartDate - StartDate *time.Time `json:"startDate,omitempty"` - - - // EndDate - EndDate *time.Time `json:"endDate,omitempty"` - - - // IntervalLengthMinutes - IntervalLengthMinutes *int `json:"intervalLengthMinutes,omitempty"` - - - // IntradayDataGroupings - IntradayDataGroupings *[]Wfmbuintradaydataupdatetopicbuintradaydatagroup `json:"intradayDataGroupings,omitempty"` - - - // Categories - Categories *[]string `json:"categories,omitempty"` - - - // NoDataReason - NoDataReason *string `json:"noDataReason,omitempty"` - - - // Schedule - Schedule *Wfmbuintradaydataupdatetopicbuschedulereference `json:"schedule,omitempty"` - - - // ShortTermForecast - ShortTermForecast *Wfmbuintradaydataupdatetopicbushorttermforecastreference `json:"shortTermForecast,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbuintradaydataupdatetopicbuintradayresult) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbuintradaydataupdatetopicbuintradayscheduledata.go b/build/platformclientv2/wfmbuintradaydataupdatetopicbuintradayscheduledata.go deleted file mode 100644 index f9f4bf1fa..000000000 --- a/build/platformclientv2/wfmbuintradaydataupdatetopicbuintradayscheduledata.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmbuintradaydataupdatetopicbuintradayscheduledata -type Wfmbuintradaydataupdatetopicbuintradayscheduledata struct { - // OnQueueTimeSeconds - OnQueueTimeSeconds *int `json:"onQueueTimeSeconds,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbuintradaydataupdatetopicbuintradayscheduledata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbuintradaydataupdatetopicbuschedulereference.go b/build/platformclientv2/wfmbuintradaydataupdatetopicbuschedulereference.go deleted file mode 100644 index dd8ad856c..000000000 --- a/build/platformclientv2/wfmbuintradaydataupdatetopicbuschedulereference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmbuintradaydataupdatetopicbuschedulereference -type Wfmbuintradaydataupdatetopicbuschedulereference struct { - // Id - Id *string `json:"id,omitempty"` - - - // WeekDate - WeekDate *Wfmbuintradaydataupdatetopiclocaldate `json:"weekDate,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbuintradaydataupdatetopicbuschedulereference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbuintradaydataupdatetopicbushorttermforecastreference.go b/build/platformclientv2/wfmbuintradaydataupdatetopicbushorttermforecastreference.go deleted file mode 100644 index 4ce8ea905..000000000 --- a/build/platformclientv2/wfmbuintradaydataupdatetopicbushorttermforecastreference.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmbuintradaydataupdatetopicbushorttermforecastreference -type Wfmbuintradaydataupdatetopicbushorttermforecastreference struct { - // Id - Id *string `json:"id,omitempty"` - - - // WeekDate - WeekDate *string `json:"weekDate,omitempty"` - - - // Description - Description *string `json:"description,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbuintradaydataupdatetopicbushorttermforecastreference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbuintradaydataupdatetopicintradayperformancepredictiondata.go b/build/platformclientv2/wfmbuintradaydataupdatetopicintradayperformancepredictiondata.go deleted file mode 100644 index 773b60d67..000000000 --- a/build/platformclientv2/wfmbuintradaydataupdatetopicintradayperformancepredictiondata.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmbuintradaydataupdatetopicintradayperformancepredictiondata -type Wfmbuintradaydataupdatetopicintradayperformancepredictiondata struct { - // ServiceLevelPercent - ServiceLevelPercent *float32 `json:"serviceLevelPercent,omitempty"` - - - // AverageSpeedOfAnswerSeconds - AverageSpeedOfAnswerSeconds *float32 `json:"averageSpeedOfAnswerSeconds,omitempty"` - - - // OccupancyPercent - OccupancyPercent *float32 `json:"occupancyPercent,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbuintradaydataupdatetopicintradayperformancepredictiondata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbuintradaydataupdatetopiclocaldate.go b/build/platformclientv2/wfmbuintradaydataupdatetopiclocaldate.go deleted file mode 100644 index f975265cb..000000000 --- a/build/platformclientv2/wfmbuintradaydataupdatetopiclocaldate.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmbuintradaydataupdatetopiclocaldate -type Wfmbuintradaydataupdatetopiclocaldate struct { - // Year - Year *int `json:"year,omitempty"` - - - // Month - Month *int `json:"month,omitempty"` - - - // Day - Day *int `json:"day,omitempty"` - - - // LeapYear - LeapYear *bool `json:"leapYear,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbuintradaydataupdatetopiclocaldate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbulkshifttradestateupdatenotificationtopicbulkshifttradestateupdatenotification.go b/build/platformclientv2/wfmbulkshifttradestateupdatenotificationtopicbulkshifttradestateupdatenotification.go deleted file mode 100644 index 1274fedf0..000000000 --- a/build/platformclientv2/wfmbulkshifttradestateupdatenotificationtopicbulkshifttradestateupdatenotification.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmbulkshifttradestateupdatenotificationtopicbulkshifttradestateupdatenotification -type Wfmbulkshifttradestateupdatenotificationtopicbulkshifttradestateupdatenotification struct { - // Status - Status *string `json:"status,omitempty"` - - - // OperationId - OperationId *string `json:"operationId,omitempty"` - - - // Result - Result *Wfmbulkshifttradestateupdatenotificationtopicbulkshifttradestateupdateresultlisting `json:"result,omitempty"` - - - // WeekDate - WeekDate *Wfmbulkshifttradestateupdatenotificationtopiclocaldate `json:"weekDate,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbulkshifttradestateupdatenotificationtopicbulkshifttradestateupdatenotification) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbulkshifttradestateupdatenotificationtopicbulkshifttradestateupdateresult.go b/build/platformclientv2/wfmbulkshifttradestateupdatenotificationtopicbulkshifttradestateupdateresult.go deleted file mode 100644 index de74c667b..000000000 --- a/build/platformclientv2/wfmbulkshifttradestateupdatenotificationtopicbulkshifttradestateupdateresult.go +++ /dev/null @@ -1,38 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Wfmbulkshifttradestateupdatenotificationtopicbulkshifttradestateupdateresult -type Wfmbulkshifttradestateupdatenotificationtopicbulkshifttradestateupdateresult struct { - // Id - Id *string `json:"id,omitempty"` - - - // State - State *string `json:"state,omitempty"` - - - // ReviewedBy - ReviewedBy *Wfmbulkshifttradestateupdatenotificationtopicuserreference `json:"reviewedBy,omitempty"` - - - // ReviewedDate - ReviewedDate *time.Time `json:"reviewedDate,omitempty"` - - - // FailureReason - FailureReason *string `json:"failureReason,omitempty"` - - - // Metadata - Metadata *Wfmbulkshifttradestateupdatenotificationtopicwfmversionedentitymetadata `json:"metadata,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbulkshifttradestateupdatenotificationtopicbulkshifttradestateupdateresult) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbulkshifttradestateupdatenotificationtopicbulkshifttradestateupdateresultlisting.go b/build/platformclientv2/wfmbulkshifttradestateupdatenotificationtopicbulkshifttradestateupdateresultlisting.go deleted file mode 100644 index bccfad1f9..000000000 --- a/build/platformclientv2/wfmbulkshifttradestateupdatenotificationtopicbulkshifttradestateupdateresultlisting.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmbulkshifttradestateupdatenotificationtopicbulkshifttradestateupdateresultlisting -type Wfmbulkshifttradestateupdatenotificationtopicbulkshifttradestateupdateresultlisting struct { - // Entities - Entities *[]Wfmbulkshifttradestateupdatenotificationtopicbulkshifttradestateupdateresult `json:"entities,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbulkshifttradestateupdatenotificationtopicbulkshifttradestateupdateresultlisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbulkshifttradestateupdatenotificationtopiclocaldate.go b/build/platformclientv2/wfmbulkshifttradestateupdatenotificationtopiclocaldate.go deleted file mode 100644 index 228f619c2..000000000 --- a/build/platformclientv2/wfmbulkshifttradestateupdatenotificationtopiclocaldate.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmbulkshifttradestateupdatenotificationtopiclocaldate -type Wfmbulkshifttradestateupdatenotificationtopiclocaldate struct { - // Year - Year *int `json:"year,omitempty"` - - - // Month - Month *int `json:"month,omitempty"` - - - // Day - Day *int `json:"day,omitempty"` - - - // LeapYear - LeapYear *bool `json:"leapYear,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbulkshifttradestateupdatenotificationtopiclocaldate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbulkshifttradestateupdatenotificationtopicuserreference.go b/build/platformclientv2/wfmbulkshifttradestateupdatenotificationtopicuserreference.go deleted file mode 100644 index 780bc8a08..000000000 --- a/build/platformclientv2/wfmbulkshifttradestateupdatenotificationtopicuserreference.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmbulkshifttradestateupdatenotificationtopicuserreference -type Wfmbulkshifttradestateupdatenotificationtopicuserreference struct { - // Id - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbulkshifttradestateupdatenotificationtopicuserreference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbulkshifttradestateupdatenotificationtopicwfmversionedentitymetadata.go b/build/platformclientv2/wfmbulkshifttradestateupdatenotificationtopicwfmversionedentitymetadata.go deleted file mode 100644 index 567e10e9a..000000000 --- a/build/platformclientv2/wfmbulkshifttradestateupdatenotificationtopicwfmversionedentitymetadata.go +++ /dev/null @@ -1,26 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Wfmbulkshifttradestateupdatenotificationtopicwfmversionedentitymetadata -type Wfmbulkshifttradestateupdatenotificationtopicwfmversionedentitymetadata struct { - // Version - Version *int `json:"version,omitempty"` - - - // ModifiedBy - ModifiedBy *Wfmbulkshifttradestateupdatenotificationtopicuserreference `json:"modifiedBy,omitempty"` - - - // DateModified - DateModified *time.Time `json:"dateModified,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbulkshifttradestateupdatenotificationtopicwfmversionedentitymetadata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbuschedulequeryresulttopicbuschedulesearchresultnotification.go b/build/platformclientv2/wfmbuschedulequeryresulttopicbuschedulesearchresultnotification.go deleted file mode 100644 index 7054e89d1..000000000 --- a/build/platformclientv2/wfmbuschedulequeryresulttopicbuschedulesearchresultnotification.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmbuschedulequeryresulttopicbuschedulesearchresultnotification -type Wfmbuschedulequeryresulttopicbuschedulesearchresultnotification struct { - // OperationId - OperationId *string `json:"operationId,omitempty"` - - - // BusinessUnitId - BusinessUnitId *string `json:"businessUnitId,omitempty"` - - - // DownloadUrl - DownloadUrl *string `json:"downloadUrl,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbuschedulequeryresulttopicbuschedulesearchresultnotification) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbuscheduleruntopicbuschedulereference.go b/build/platformclientv2/wfmbuscheduleruntopicbuschedulereference.go deleted file mode 100644 index aca3a48d3..000000000 --- a/build/platformclientv2/wfmbuscheduleruntopicbuschedulereference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmbuscheduleruntopicbuschedulereference -type Wfmbuscheduleruntopicbuschedulereference struct { - // Id - Id *string `json:"id,omitempty"` - - - // WeekDate - WeekDate *Wfmbuscheduleruntopiclocaldate `json:"weekDate,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbuscheduleruntopicbuschedulereference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbuscheduleruntopicbuschedulerun.go b/build/platformclientv2/wfmbuscheduleruntopicbuschedulerun.go deleted file mode 100644 index 924d32631..000000000 --- a/build/platformclientv2/wfmbuscheduleruntopicbuschedulerun.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmbuscheduleruntopicbuschedulerun -type Wfmbuscheduleruntopicbuschedulerun struct { - // Id - Id *string `json:"id,omitempty"` - - - // PercentComplete - PercentComplete *float32 `json:"percentComplete,omitempty"` - - - // IntradayRescheduling - IntradayRescheduling *bool `json:"intradayRescheduling,omitempty"` - - - // State - State *string `json:"state,omitempty"` - - - // WeekCount - WeekCount *int `json:"weekCount,omitempty"` - - - // Schedule - Schedule *Wfmbuscheduleruntopicbuschedulereference `json:"schedule,omitempty"` - - - // SchedulingCanceledBy - SchedulingCanceledBy *Wfmbuscheduleruntopicuserreference `json:"schedulingCanceledBy,omitempty"` - - - // SchedulingCompletedTime - SchedulingCompletedTime *string `json:"schedulingCompletedTime,omitempty"` - - - // MessageCount - MessageCount *int `json:"messageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbuscheduleruntopicbuschedulerun) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbuscheduleruntopicbuschedulingrunprogressnotification.go b/build/platformclientv2/wfmbuscheduleruntopicbuschedulingrunprogressnotification.go deleted file mode 100644 index ad70eb292..000000000 --- a/build/platformclientv2/wfmbuscheduleruntopicbuschedulingrunprogressnotification.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmbuscheduleruntopicbuschedulingrunprogressnotification -type Wfmbuscheduleruntopicbuschedulingrunprogressnotification struct { - // Status - Status *string `json:"status,omitempty"` - - - // OperationId - OperationId *string `json:"operationId,omitempty"` - - - // Result - Result *Wfmbuscheduleruntopicbuschedulerun `json:"result,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbuscheduleruntopicbuschedulingrunprogressnotification) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbuscheduleruntopiclocaldate.go b/build/platformclientv2/wfmbuscheduleruntopiclocaldate.go deleted file mode 100644 index 121e19d8b..000000000 --- a/build/platformclientv2/wfmbuscheduleruntopiclocaldate.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmbuscheduleruntopiclocaldate -type Wfmbuscheduleruntopiclocaldate struct { - // Year - Year *int `json:"year,omitempty"` - - - // Month - Month *int `json:"month,omitempty"` - - - // Day - Day *int `json:"day,omitempty"` - - - // LeapYear - LeapYear *bool `json:"leapYear,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbuscheduleruntopiclocaldate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbuscheduleruntopicuserreference.go b/build/platformclientv2/wfmbuscheduleruntopicuserreference.go deleted file mode 100644 index 495eb2709..000000000 --- a/build/platformclientv2/wfmbuscheduleruntopicuserreference.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmbuscheduleruntopicuserreference -type Wfmbuscheduleruntopicuserreference struct { - // Id - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbuscheduleruntopicuserreference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbuschedulesearchresulttopicbuschedulesearchresultnotification.go b/build/platformclientv2/wfmbuschedulesearchresulttopicbuschedulesearchresultnotification.go deleted file mode 100644 index a9d57ed28..000000000 --- a/build/platformclientv2/wfmbuschedulesearchresulttopicbuschedulesearchresultnotification.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmbuschedulesearchresulttopicbuschedulesearchresultnotification -type Wfmbuschedulesearchresulttopicbuschedulesearchresultnotification struct { - // OperationId - OperationId *string `json:"operationId,omitempty"` - - - // BusinessUnitId - BusinessUnitId *string `json:"businessUnitId,omitempty"` - - - // DownloadUrl - DownloadUrl *string `json:"downloadUrl,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbuschedulesearchresulttopicbuschedulesearchresultnotification) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbuscheduletopicbumanagementunitschedulesummary.go b/build/platformclientv2/wfmbuscheduletopicbumanagementunitschedulesummary.go deleted file mode 100644 index 2c8e8cb45..000000000 --- a/build/platformclientv2/wfmbuscheduletopicbumanagementunitschedulesummary.go +++ /dev/null @@ -1,34 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Wfmbuscheduletopicbumanagementunitschedulesummary -type Wfmbuscheduletopicbumanagementunitschedulesummary struct { - // ManagementUnit - ManagementUnit *Wfmbuscheduletopicmanagementunit `json:"managementUnit,omitempty"` - - - // StartDate - StartDate *time.Time `json:"startDate,omitempty"` - - - // EndDate - EndDate *time.Time `json:"endDate,omitempty"` - - - // Agents - Agents *[]Wfmbuscheduletopicuserreference `json:"agents,omitempty"` - - - // AgentCount - AgentCount *int `json:"agentCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbuscheduletopicbumanagementunitschedulesummary) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbuscheduletopicbuschedulegenerationresultsummary.go b/build/platformclientv2/wfmbuscheduletopicbuschedulegenerationresultsummary.go deleted file mode 100644 index b8bc64030..000000000 --- a/build/platformclientv2/wfmbuscheduletopicbuschedulegenerationresultsummary.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmbuscheduletopicbuschedulegenerationresultsummary -type Wfmbuscheduletopicbuschedulegenerationresultsummary struct { - // Failed - Failed *bool `json:"failed,omitempty"` - - - // RunId - RunId *string `json:"runId,omitempty"` - - - // MessageCount - MessageCount *int `json:"messageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbuscheduletopicbuschedulegenerationresultsummary) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbuscheduletopicbuschedulemetadata.go b/build/platformclientv2/wfmbuscheduletopicbuschedulemetadata.go deleted file mode 100644 index e0e3bd234..000000000 --- a/build/platformclientv2/wfmbuscheduletopicbuschedulemetadata.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmbuscheduletopicbuschedulemetadata -type Wfmbuscheduletopicbuschedulemetadata struct { - // Id - Id *string `json:"id,omitempty"` - - - // WeekDate - WeekDate *Wfmbuscheduletopiclocaldate `json:"weekDate,omitempty"` - - - // WeekCount - WeekCount *int `json:"weekCount,omitempty"` - - - // Description - Description *string `json:"description,omitempty"` - - - // Published - Published *bool `json:"published,omitempty"` - - - // ShortTermForecast - ShortTermForecast *Wfmbuscheduletopicbushorttermforecastreference `json:"shortTermForecast,omitempty"` - - - // ManagementUnits - ManagementUnits *[]Wfmbuscheduletopicbumanagementunitschedulesummary `json:"managementUnits,omitempty"` - - - // GenerationResults - GenerationResults *Wfmbuscheduletopicbuschedulegenerationresultsummary `json:"generationResults,omitempty"` - - - // Metadata - Metadata *Wfmbuscheduletopicwfmversionedentitymetadata `json:"metadata,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbuscheduletopicbuschedulemetadata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbuscheduletopicbuschedulenotification.go b/build/platformclientv2/wfmbuscheduletopicbuschedulenotification.go deleted file mode 100644 index fe33db9d5..000000000 --- a/build/platformclientv2/wfmbuscheduletopicbuschedulenotification.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmbuscheduletopicbuschedulenotification -type Wfmbuscheduletopicbuschedulenotification struct { - // Status - Status *string `json:"status,omitempty"` - - - // OperationId - OperationId *string `json:"operationId,omitempty"` - - - // EventType - EventType *string `json:"eventType,omitempty"` - - - // Result - Result *Wfmbuscheduletopicbuschedulemetadata `json:"result,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbuscheduletopicbuschedulenotification) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbuscheduletopicbushorttermforecastreference.go b/build/platformclientv2/wfmbuscheduletopicbushorttermforecastreference.go deleted file mode 100644 index b7eebc4ed..000000000 --- a/build/platformclientv2/wfmbuscheduletopicbushorttermforecastreference.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmbuscheduletopicbushorttermforecastreference -type Wfmbuscheduletopicbushorttermforecastreference struct { - // Id - Id *string `json:"id,omitempty"` - - - // WeekDate - WeekDate *string `json:"weekDate,omitempty"` - - - // Description - Description *string `json:"description,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbuscheduletopicbushorttermforecastreference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbuscheduletopiclocaldate.go b/build/platformclientv2/wfmbuscheduletopiclocaldate.go deleted file mode 100644 index 0b5284124..000000000 --- a/build/platformclientv2/wfmbuscheduletopiclocaldate.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmbuscheduletopiclocaldate -type Wfmbuscheduletopiclocaldate struct { - // Year - Year *int `json:"year,omitempty"` - - - // Month - Month *int `json:"month,omitempty"` - - - // Day - Day *int `json:"day,omitempty"` - - - // LeapYear - LeapYear *bool `json:"leapYear,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbuscheduletopiclocaldate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbuscheduletopicmanagementunit.go b/build/platformclientv2/wfmbuscheduletopicmanagementunit.go deleted file mode 100644 index af028a2eb..000000000 --- a/build/platformclientv2/wfmbuscheduletopicmanagementunit.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmbuscheduletopicmanagementunit -type Wfmbuscheduletopicmanagementunit struct { - // Id - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbuscheduletopicmanagementunit) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbuscheduletopicuserreference.go b/build/platformclientv2/wfmbuscheduletopicuserreference.go deleted file mode 100644 index 4dbdce04e..000000000 --- a/build/platformclientv2/wfmbuscheduletopicuserreference.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmbuscheduletopicuserreference -type Wfmbuscheduletopicuserreference struct { - // Id - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbuscheduletopicuserreference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbuscheduletopicwfmversionedentitymetadata.go b/build/platformclientv2/wfmbuscheduletopicwfmversionedentitymetadata.go deleted file mode 100644 index db909de16..000000000 --- a/build/platformclientv2/wfmbuscheduletopicwfmversionedentitymetadata.go +++ /dev/null @@ -1,26 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Wfmbuscheduletopicwfmversionedentitymetadata -type Wfmbuscheduletopicwfmversionedentitymetadata struct { - // Version - Version *int `json:"version,omitempty"` - - - // ModifiedBy - ModifiedBy *Wfmbuscheduletopicuserreference `json:"modifiedBy,omitempty"` - - - // DateModified - DateModified *time.Time `json:"dateModified,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbuscheduletopicwfmversionedentitymetadata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbushorttermforecastcopycompletetopicbuforecastmodification.go b/build/platformclientv2/wfmbushorttermforecastcopycompletetopicbuforecastmodification.go deleted file mode 100644 index 92d49f5d4..000000000 --- a/build/platformclientv2/wfmbushorttermforecastcopycompletetopicbuforecastmodification.go +++ /dev/null @@ -1,57 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmbushorttermforecastcopycompletetopicbuforecastmodification -type Wfmbushorttermforecastcopycompletetopicbuforecastmodification struct { - // VarType - VarType *string `json:"type,omitempty"` - - - // StartIntervalIndex - StartIntervalIndex *int `json:"startIntervalIndex,omitempty"` - - - // EndIntervalIndex - EndIntervalIndex *int `json:"endIntervalIndex,omitempty"` - - - // Metric - Metric *string `json:"metric,omitempty"` - - - // LegacyMetric - LegacyMetric *string `json:"legacyMetric,omitempty"` - - - // Value - Value *float32 `json:"value,omitempty"` - - - // Values - Values *[]Wfmbushorttermforecastcopycompletetopicmodificationintervaloffsetvalue `json:"values,omitempty"` - - - // Enabled - Enabled *bool `json:"enabled,omitempty"` - - - // Granularity - Granularity *string `json:"granularity,omitempty"` - - - // DisplayGranularity - DisplayGranularity *string `json:"displayGranularity,omitempty"` - - - // PlanningGroupIds - PlanningGroupIds *[]string `json:"planningGroupIds,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbushorttermforecastcopycompletetopicbuforecastmodification) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbushorttermforecastcopycompletetopicbushorttermforecast.go b/build/platformclientv2/wfmbushorttermforecastcopycompletetopicbushorttermforecast.go deleted file mode 100644 index d12fb6156..000000000 --- a/build/platformclientv2/wfmbushorttermforecastcopycompletetopicbushorttermforecast.go +++ /dev/null @@ -1,66 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Wfmbushorttermforecastcopycompletetopicbushorttermforecast -type Wfmbushorttermforecastcopycompletetopicbushorttermforecast struct { - // Id - Id *string `json:"id,omitempty"` - - - // WeekDate - WeekDate *string `json:"weekDate,omitempty"` - - - // CreationMethod - CreationMethod *string `json:"creationMethod,omitempty"` - - - // Description - Description *string `json:"description,omitempty"` - - - // Legacy - Legacy *bool `json:"legacy,omitempty"` - - - // ReferenceStartDate - ReferenceStartDate *time.Time `json:"referenceStartDate,omitempty"` - - - // SourceDays - SourceDays *[]Wfmbushorttermforecastcopycompletetopicforecastsourcedaypointer `json:"sourceDays,omitempty"` - - - // Modifications - Modifications *[]Wfmbushorttermforecastcopycompletetopicbuforecastmodification `json:"modifications,omitempty"` - - - // TimeZone - TimeZone *string `json:"timeZone,omitempty"` - - - // PlanningGroupsVersion - PlanningGroupsVersion *int `json:"planningGroupsVersion,omitempty"` - - - // WeekCount - WeekCount *int `json:"weekCount,omitempty"` - - - // Metadata - Metadata *Wfmbushorttermforecastcopycompletetopicwfmversionedentitymetadata `json:"metadata,omitempty"` - - - // CanUseForScheduling - CanUseForScheduling *bool `json:"canUseForScheduling,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbushorttermforecastcopycompletetopicbushorttermforecast) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbushorttermforecastcopycompletetopicbushorttermforecastnotification.go b/build/platformclientv2/wfmbushorttermforecastcopycompletetopicbushorttermforecastnotification.go deleted file mode 100644 index ddc2f19a2..000000000 --- a/build/platformclientv2/wfmbushorttermforecastcopycompletetopicbushorttermforecastnotification.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmbushorttermforecastcopycompletetopicbushorttermforecastnotification -type Wfmbushorttermforecastcopycompletetopicbushorttermforecastnotification struct { - // Status - Status *string `json:"status,omitempty"` - - - // Result - Result *Wfmbushorttermforecastcopycompletetopicbushorttermforecast `json:"result,omitempty"` - - - // OperationId - OperationId *string `json:"operationId,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbushorttermforecastcopycompletetopicbushorttermforecastnotification) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbushorttermforecastcopycompletetopicforecastsourcedaypointer.go b/build/platformclientv2/wfmbushorttermforecastcopycompletetopicforecastsourcedaypointer.go deleted file mode 100644 index 2c37cafba..000000000 --- a/build/platformclientv2/wfmbushorttermforecastcopycompletetopicforecastsourcedaypointer.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmbushorttermforecastcopycompletetopicforecastsourcedaypointer -type Wfmbushorttermforecastcopycompletetopicforecastsourcedaypointer struct { - // DayOfWeek - DayOfWeek *string `json:"dayOfWeek,omitempty"` - - - // Weight - Weight *int `json:"weight,omitempty"` - - - // Date - Date *string `json:"date,omitempty"` - - - // FileName - FileName *string `json:"fileName,omitempty"` - - - // DataKey - DataKey *string `json:"dataKey,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbushorttermforecastcopycompletetopicforecastsourcedaypointer) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbushorttermforecastcopycompletetopicmodificationintervaloffsetvalue.go b/build/platformclientv2/wfmbushorttermforecastcopycompletetopicmodificationintervaloffsetvalue.go deleted file mode 100644 index 38c7d4cc7..000000000 --- a/build/platformclientv2/wfmbushorttermforecastcopycompletetopicmodificationintervaloffsetvalue.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmbushorttermforecastcopycompletetopicmodificationintervaloffsetvalue -type Wfmbushorttermforecastcopycompletetopicmodificationintervaloffsetvalue struct { - // IntervalIndex - IntervalIndex *int `json:"intervalIndex,omitempty"` - - - // Value - Value *float32 `json:"value,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbushorttermforecastcopycompletetopicmodificationintervaloffsetvalue) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbushorttermforecastcopycompletetopicuserreference.go b/build/platformclientv2/wfmbushorttermforecastcopycompletetopicuserreference.go deleted file mode 100644 index 3fb2d3119..000000000 --- a/build/platformclientv2/wfmbushorttermforecastcopycompletetopicuserreference.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmbushorttermforecastcopycompletetopicuserreference -type Wfmbushorttermforecastcopycompletetopicuserreference struct { - // Id - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbushorttermforecastcopycompletetopicuserreference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbushorttermforecastcopycompletetopicwfmversionedentitymetadata.go b/build/platformclientv2/wfmbushorttermforecastcopycompletetopicwfmversionedentitymetadata.go deleted file mode 100644 index 05c96bdc2..000000000 --- a/build/platformclientv2/wfmbushorttermforecastcopycompletetopicwfmversionedentitymetadata.go +++ /dev/null @@ -1,26 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Wfmbushorttermforecastcopycompletetopicwfmversionedentitymetadata -type Wfmbushorttermforecastcopycompletetopicwfmversionedentitymetadata struct { - // Version - Version *int `json:"version,omitempty"` - - - // ModifiedBy - ModifiedBy *Wfmbushorttermforecastcopycompletetopicuserreference `json:"modifiedBy,omitempty"` - - - // DateModified - DateModified *time.Time `json:"dateModified,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbushorttermforecastcopycompletetopicwfmversionedentitymetadata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbushorttermforecastgenerateprogresstopicbuforecastmodification.go b/build/platformclientv2/wfmbushorttermforecastgenerateprogresstopicbuforecastmodification.go deleted file mode 100644 index fada96df2..000000000 --- a/build/platformclientv2/wfmbushorttermforecastgenerateprogresstopicbuforecastmodification.go +++ /dev/null @@ -1,57 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmbushorttermforecastgenerateprogresstopicbuforecastmodification -type Wfmbushorttermforecastgenerateprogresstopicbuforecastmodification struct { - // VarType - VarType *string `json:"type,omitempty"` - - - // StartIntervalIndex - StartIntervalIndex *int `json:"startIntervalIndex,omitempty"` - - - // EndIntervalIndex - EndIntervalIndex *int `json:"endIntervalIndex,omitempty"` - - - // Metric - Metric *string `json:"metric,omitempty"` - - - // LegacyMetric - LegacyMetric *string `json:"legacyMetric,omitempty"` - - - // Value - Value *float32 `json:"value,omitempty"` - - - // Values - Values *[]Wfmbushorttermforecastgenerateprogresstopicmodificationintervaloffsetvalue `json:"values,omitempty"` - - - // Enabled - Enabled *bool `json:"enabled,omitempty"` - - - // Granularity - Granularity *string `json:"granularity,omitempty"` - - - // DisplayGranularity - DisplayGranularity *string `json:"displayGranularity,omitempty"` - - - // PlanningGroupIds - PlanningGroupIds *[]string `json:"planningGroupIds,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbushorttermforecastgenerateprogresstopicbuforecastmodification) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbushorttermforecastgenerateprogresstopicbushorttermforecast.go b/build/platformclientv2/wfmbushorttermforecastgenerateprogresstopicbushorttermforecast.go deleted file mode 100644 index aefc0ed6c..000000000 --- a/build/platformclientv2/wfmbushorttermforecastgenerateprogresstopicbushorttermforecast.go +++ /dev/null @@ -1,66 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Wfmbushorttermforecastgenerateprogresstopicbushorttermforecast -type Wfmbushorttermforecastgenerateprogresstopicbushorttermforecast struct { - // Id - Id *string `json:"id,omitempty"` - - - // WeekDate - WeekDate *string `json:"weekDate,omitempty"` - - - // CreationMethod - CreationMethod *string `json:"creationMethod,omitempty"` - - - // Description - Description *string `json:"description,omitempty"` - - - // Legacy - Legacy *bool `json:"legacy,omitempty"` - - - // ReferenceStartDate - ReferenceStartDate *time.Time `json:"referenceStartDate,omitempty"` - - - // SourceDays - SourceDays *[]Wfmbushorttermforecastgenerateprogresstopicforecastsourcedaypointer `json:"sourceDays,omitempty"` - - - // Modifications - Modifications *[]Wfmbushorttermforecastgenerateprogresstopicbuforecastmodification `json:"modifications,omitempty"` - - - // TimeZone - TimeZone *string `json:"timeZone,omitempty"` - - - // PlanningGroupsVersion - PlanningGroupsVersion *int `json:"planningGroupsVersion,omitempty"` - - - // WeekCount - WeekCount *int `json:"weekCount,omitempty"` - - - // Metadata - Metadata *Wfmbushorttermforecastgenerateprogresstopicwfmversionedentitymetadata `json:"metadata,omitempty"` - - - // CanUseForScheduling - CanUseForScheduling *bool `json:"canUseForScheduling,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbushorttermforecastgenerateprogresstopicbushorttermforecast) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbushorttermforecastgenerateprogresstopicforecastsourcedaypointer.go b/build/platformclientv2/wfmbushorttermforecastgenerateprogresstopicforecastsourcedaypointer.go deleted file mode 100644 index 08bd09b7f..000000000 --- a/build/platformclientv2/wfmbushorttermforecastgenerateprogresstopicforecastsourcedaypointer.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmbushorttermforecastgenerateprogresstopicforecastsourcedaypointer -type Wfmbushorttermforecastgenerateprogresstopicforecastsourcedaypointer struct { - // DayOfWeek - DayOfWeek *string `json:"dayOfWeek,omitempty"` - - - // Weight - Weight *int `json:"weight,omitempty"` - - - // Date - Date *string `json:"date,omitempty"` - - - // FileName - FileName *string `json:"fileName,omitempty"` - - - // DataKey - DataKey *string `json:"dataKey,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbushorttermforecastgenerateprogresstopicforecastsourcedaypointer) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbushorttermforecastgenerateprogresstopicgeneratebushorttermforecastprogressnotification.go b/build/platformclientv2/wfmbushorttermforecastgenerateprogresstopicgeneratebushorttermforecastprogressnotification.go deleted file mode 100644 index 84d12be1a..000000000 --- a/build/platformclientv2/wfmbushorttermforecastgenerateprogresstopicgeneratebushorttermforecastprogressnotification.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmbushorttermforecastgenerateprogresstopicgeneratebushorttermforecastprogressnotification -type Wfmbushorttermforecastgenerateprogresstopicgeneratebushorttermforecastprogressnotification struct { - // Status - Status *string `json:"status,omitempty"` - - - // Result - Result *Wfmbushorttermforecastgenerateprogresstopicbushorttermforecast `json:"result,omitempty"` - - - // OperationId - OperationId *string `json:"operationId,omitempty"` - - - // Progress - Progress *int `json:"progress,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbushorttermforecastgenerateprogresstopicgeneratebushorttermforecastprogressnotification) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbushorttermforecastgenerateprogresstopicmodificationintervaloffsetvalue.go b/build/platformclientv2/wfmbushorttermforecastgenerateprogresstopicmodificationintervaloffsetvalue.go deleted file mode 100644 index c0f7cad70..000000000 --- a/build/platformclientv2/wfmbushorttermforecastgenerateprogresstopicmodificationintervaloffsetvalue.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmbushorttermforecastgenerateprogresstopicmodificationintervaloffsetvalue -type Wfmbushorttermforecastgenerateprogresstopicmodificationintervaloffsetvalue struct { - // IntervalIndex - IntervalIndex *int `json:"intervalIndex,omitempty"` - - - // Value - Value *float32 `json:"value,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbushorttermforecastgenerateprogresstopicmodificationintervaloffsetvalue) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbushorttermforecastgenerateprogresstopicuserreference.go b/build/platformclientv2/wfmbushorttermforecastgenerateprogresstopicuserreference.go deleted file mode 100644 index 6773c5ab7..000000000 --- a/build/platformclientv2/wfmbushorttermforecastgenerateprogresstopicuserreference.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmbushorttermforecastgenerateprogresstopicuserreference -type Wfmbushorttermforecastgenerateprogresstopicuserreference struct { - // Id - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbushorttermforecastgenerateprogresstopicuserreference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbushorttermforecastgenerateprogresstopicwfmversionedentitymetadata.go b/build/platformclientv2/wfmbushorttermforecastgenerateprogresstopicwfmversionedentitymetadata.go deleted file mode 100644 index 861537847..000000000 --- a/build/platformclientv2/wfmbushorttermforecastgenerateprogresstopicwfmversionedentitymetadata.go +++ /dev/null @@ -1,26 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Wfmbushorttermforecastgenerateprogresstopicwfmversionedentitymetadata -type Wfmbushorttermforecastgenerateprogresstopicwfmversionedentitymetadata struct { - // Version - Version *int `json:"version,omitempty"` - - - // ModifiedBy - ModifiedBy *Wfmbushorttermforecastgenerateprogresstopicuserreference `json:"modifiedBy,omitempty"` - - - // DateModified - DateModified *time.Time `json:"dateModified,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbushorttermforecastgenerateprogresstopicwfmversionedentitymetadata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbushorttermforecastimportcompletetopicbuforecastmodification.go b/build/platformclientv2/wfmbushorttermforecastimportcompletetopicbuforecastmodification.go deleted file mode 100644 index 78b7d9cea..000000000 --- a/build/platformclientv2/wfmbushorttermforecastimportcompletetopicbuforecastmodification.go +++ /dev/null @@ -1,57 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmbushorttermforecastimportcompletetopicbuforecastmodification -type Wfmbushorttermforecastimportcompletetopicbuforecastmodification struct { - // VarType - VarType *string `json:"type,omitempty"` - - - // StartIntervalIndex - StartIntervalIndex *int `json:"startIntervalIndex,omitempty"` - - - // EndIntervalIndex - EndIntervalIndex *int `json:"endIntervalIndex,omitempty"` - - - // Metric - Metric *string `json:"metric,omitempty"` - - - // LegacyMetric - LegacyMetric *string `json:"legacyMetric,omitempty"` - - - // Value - Value *float32 `json:"value,omitempty"` - - - // Values - Values *[]Wfmbushorttermforecastimportcompletetopicmodificationintervaloffsetvalue `json:"values,omitempty"` - - - // Enabled - Enabled *bool `json:"enabled,omitempty"` - - - // Granularity - Granularity *string `json:"granularity,omitempty"` - - - // DisplayGranularity - DisplayGranularity *string `json:"displayGranularity,omitempty"` - - - // PlanningGroupIds - PlanningGroupIds *[]string `json:"planningGroupIds,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbushorttermforecastimportcompletetopicbuforecastmodification) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbushorttermforecastimportcompletetopicbushorttermforecast.go b/build/platformclientv2/wfmbushorttermforecastimportcompletetopicbushorttermforecast.go deleted file mode 100644 index a7c828198..000000000 --- a/build/platformclientv2/wfmbushorttermforecastimportcompletetopicbushorttermforecast.go +++ /dev/null @@ -1,66 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Wfmbushorttermforecastimportcompletetopicbushorttermforecast -type Wfmbushorttermforecastimportcompletetopicbushorttermforecast struct { - // Id - Id *string `json:"id,omitempty"` - - - // WeekDate - WeekDate *string `json:"weekDate,omitempty"` - - - // CreationMethod - CreationMethod *string `json:"creationMethod,omitempty"` - - - // Description - Description *string `json:"description,omitempty"` - - - // Legacy - Legacy *bool `json:"legacy,omitempty"` - - - // ReferenceStartDate - ReferenceStartDate *time.Time `json:"referenceStartDate,omitempty"` - - - // SourceDays - SourceDays *[]Wfmbushorttermforecastimportcompletetopicforecastsourcedaypointer `json:"sourceDays,omitempty"` - - - // Modifications - Modifications *[]Wfmbushorttermforecastimportcompletetopicbuforecastmodification `json:"modifications,omitempty"` - - - // TimeZone - TimeZone *string `json:"timeZone,omitempty"` - - - // PlanningGroupsVersion - PlanningGroupsVersion *int `json:"planningGroupsVersion,omitempty"` - - - // WeekCount - WeekCount *int `json:"weekCount,omitempty"` - - - // Metadata - Metadata *Wfmbushorttermforecastimportcompletetopicwfmversionedentitymetadata `json:"metadata,omitempty"` - - - // CanUseForScheduling - CanUseForScheduling *bool `json:"canUseForScheduling,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbushorttermforecastimportcompletetopicbushorttermforecast) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbushorttermforecastimportcompletetopicbushorttermforecastnotification.go b/build/platformclientv2/wfmbushorttermforecastimportcompletetopicbushorttermforecastnotification.go deleted file mode 100644 index 2dac911bc..000000000 --- a/build/platformclientv2/wfmbushorttermforecastimportcompletetopicbushorttermforecastnotification.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmbushorttermforecastimportcompletetopicbushorttermforecastnotification -type Wfmbushorttermforecastimportcompletetopicbushorttermforecastnotification struct { - // Status - Status *string `json:"status,omitempty"` - - - // Result - Result *Wfmbushorttermforecastimportcompletetopicbushorttermforecast `json:"result,omitempty"` - - - // OperationId - OperationId *string `json:"operationId,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbushorttermforecastimportcompletetopicbushorttermforecastnotification) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbushorttermforecastimportcompletetopicforecastsourcedaypointer.go b/build/platformclientv2/wfmbushorttermforecastimportcompletetopicforecastsourcedaypointer.go deleted file mode 100644 index bdf5bee8b..000000000 --- a/build/platformclientv2/wfmbushorttermforecastimportcompletetopicforecastsourcedaypointer.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmbushorttermforecastimportcompletetopicforecastsourcedaypointer -type Wfmbushorttermforecastimportcompletetopicforecastsourcedaypointer struct { - // DayOfWeek - DayOfWeek *string `json:"dayOfWeek,omitempty"` - - - // Weight - Weight *int `json:"weight,omitempty"` - - - // Date - Date *string `json:"date,omitempty"` - - - // FileName - FileName *string `json:"fileName,omitempty"` - - - // DataKey - DataKey *string `json:"dataKey,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbushorttermforecastimportcompletetopicforecastsourcedaypointer) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbushorttermforecastimportcompletetopicmodificationintervaloffsetvalue.go b/build/platformclientv2/wfmbushorttermforecastimportcompletetopicmodificationintervaloffsetvalue.go deleted file mode 100644 index 71d508a57..000000000 --- a/build/platformclientv2/wfmbushorttermforecastimportcompletetopicmodificationintervaloffsetvalue.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmbushorttermforecastimportcompletetopicmodificationintervaloffsetvalue -type Wfmbushorttermforecastimportcompletetopicmodificationintervaloffsetvalue struct { - // IntervalIndex - IntervalIndex *int `json:"intervalIndex,omitempty"` - - - // Value - Value *float32 `json:"value,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbushorttermforecastimportcompletetopicmodificationintervaloffsetvalue) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbushorttermforecastimportcompletetopicuserreference.go b/build/platformclientv2/wfmbushorttermforecastimportcompletetopicuserreference.go deleted file mode 100644 index 5a1814e77..000000000 --- a/build/platformclientv2/wfmbushorttermforecastimportcompletetopicuserreference.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmbushorttermforecastimportcompletetopicuserreference -type Wfmbushorttermforecastimportcompletetopicuserreference struct { - // Id - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbushorttermforecastimportcompletetopicuserreference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbushorttermforecastimportcompletetopicwfmversionedentitymetadata.go b/build/platformclientv2/wfmbushorttermforecastimportcompletetopicwfmversionedentitymetadata.go deleted file mode 100644 index 55ba4617a..000000000 --- a/build/platformclientv2/wfmbushorttermforecastimportcompletetopicwfmversionedentitymetadata.go +++ /dev/null @@ -1,26 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Wfmbushorttermforecastimportcompletetopicwfmversionedentitymetadata -type Wfmbushorttermforecastimportcompletetopicwfmversionedentitymetadata struct { - // Version - Version *int `json:"version,omitempty"` - - - // ModifiedBy - ModifiedBy *Wfmbushorttermforecastimportcompletetopicuserreference `json:"modifiedBy,omitempty"` - - - // DateModified - DateModified *time.Time `json:"dateModified,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbushorttermforecastimportcompletetopicwfmversionedentitymetadata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbushorttermforecastupdatecompletetopicbuforecastmodification.go b/build/platformclientv2/wfmbushorttermforecastupdatecompletetopicbuforecastmodification.go deleted file mode 100644 index a45124852..000000000 --- a/build/platformclientv2/wfmbushorttermforecastupdatecompletetopicbuforecastmodification.go +++ /dev/null @@ -1,57 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmbushorttermforecastupdatecompletetopicbuforecastmodification -type Wfmbushorttermforecastupdatecompletetopicbuforecastmodification struct { - // VarType - VarType *string `json:"type,omitempty"` - - - // StartIntervalIndex - StartIntervalIndex *int `json:"startIntervalIndex,omitempty"` - - - // EndIntervalIndex - EndIntervalIndex *int `json:"endIntervalIndex,omitempty"` - - - // Metric - Metric *string `json:"metric,omitempty"` - - - // LegacyMetric - LegacyMetric *string `json:"legacyMetric,omitempty"` - - - // Value - Value *float32 `json:"value,omitempty"` - - - // Values - Values *[]Wfmbushorttermforecastupdatecompletetopicmodificationintervaloffsetvalue `json:"values,omitempty"` - - - // Enabled - Enabled *bool `json:"enabled,omitempty"` - - - // Granularity - Granularity *string `json:"granularity,omitempty"` - - - // DisplayGranularity - DisplayGranularity *string `json:"displayGranularity,omitempty"` - - - // PlanningGroupIds - PlanningGroupIds *[]string `json:"planningGroupIds,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbushorttermforecastupdatecompletetopicbuforecastmodification) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbushorttermforecastupdatecompletetopicbushorttermforecast.go b/build/platformclientv2/wfmbushorttermforecastupdatecompletetopicbushorttermforecast.go deleted file mode 100644 index 3a862a05a..000000000 --- a/build/platformclientv2/wfmbushorttermforecastupdatecompletetopicbushorttermforecast.go +++ /dev/null @@ -1,66 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Wfmbushorttermforecastupdatecompletetopicbushorttermforecast -type Wfmbushorttermforecastupdatecompletetopicbushorttermforecast struct { - // Id - Id *string `json:"id,omitempty"` - - - // WeekDate - WeekDate *string `json:"weekDate,omitempty"` - - - // CreationMethod - CreationMethod *string `json:"creationMethod,omitempty"` - - - // Description - Description *string `json:"description,omitempty"` - - - // Legacy - Legacy *bool `json:"legacy,omitempty"` - - - // ReferenceStartDate - ReferenceStartDate *time.Time `json:"referenceStartDate,omitempty"` - - - // SourceDays - SourceDays *[]Wfmbushorttermforecastupdatecompletetopicforecastsourcedaypointer `json:"sourceDays,omitempty"` - - - // Modifications - Modifications *[]Wfmbushorttermforecastupdatecompletetopicbuforecastmodification `json:"modifications,omitempty"` - - - // TimeZone - TimeZone *string `json:"timeZone,omitempty"` - - - // PlanningGroupsVersion - PlanningGroupsVersion *int `json:"planningGroupsVersion,omitempty"` - - - // WeekCount - WeekCount *int `json:"weekCount,omitempty"` - - - // Metadata - Metadata *Wfmbushorttermforecastupdatecompletetopicwfmversionedentitymetadata `json:"metadata,omitempty"` - - - // CanUseForScheduling - CanUseForScheduling *bool `json:"canUseForScheduling,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbushorttermforecastupdatecompletetopicbushorttermforecast) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbushorttermforecastupdatecompletetopicbushorttermforecastnotification.go b/build/platformclientv2/wfmbushorttermforecastupdatecompletetopicbushorttermforecastnotification.go deleted file mode 100644 index 417fb3871..000000000 --- a/build/platformclientv2/wfmbushorttermforecastupdatecompletetopicbushorttermforecastnotification.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmbushorttermforecastupdatecompletetopicbushorttermforecastnotification -type Wfmbushorttermforecastupdatecompletetopicbushorttermforecastnotification struct { - // Status - Status *string `json:"status,omitempty"` - - - // Result - Result *Wfmbushorttermforecastupdatecompletetopicbushorttermforecast `json:"result,omitempty"` - - - // OperationId - OperationId *string `json:"operationId,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbushorttermforecastupdatecompletetopicbushorttermforecastnotification) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbushorttermforecastupdatecompletetopicforecastsourcedaypointer.go b/build/platformclientv2/wfmbushorttermforecastupdatecompletetopicforecastsourcedaypointer.go deleted file mode 100644 index 7bccfbfc7..000000000 --- a/build/platformclientv2/wfmbushorttermforecastupdatecompletetopicforecastsourcedaypointer.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmbushorttermforecastupdatecompletetopicforecastsourcedaypointer -type Wfmbushorttermforecastupdatecompletetopicforecastsourcedaypointer struct { - // DayOfWeek - DayOfWeek *string `json:"dayOfWeek,omitempty"` - - - // Weight - Weight *int `json:"weight,omitempty"` - - - // Date - Date *string `json:"date,omitempty"` - - - // FileName - FileName *string `json:"fileName,omitempty"` - - - // DataKey - DataKey *string `json:"dataKey,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbushorttermforecastupdatecompletetopicforecastsourcedaypointer) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbushorttermforecastupdatecompletetopicmodificationintervaloffsetvalue.go b/build/platformclientv2/wfmbushorttermforecastupdatecompletetopicmodificationintervaloffsetvalue.go deleted file mode 100644 index e23307650..000000000 --- a/build/platformclientv2/wfmbushorttermforecastupdatecompletetopicmodificationintervaloffsetvalue.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmbushorttermforecastupdatecompletetopicmodificationintervaloffsetvalue -type Wfmbushorttermforecastupdatecompletetopicmodificationintervaloffsetvalue struct { - // IntervalIndex - IntervalIndex *int `json:"intervalIndex,omitempty"` - - - // Value - Value *float32 `json:"value,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbushorttermforecastupdatecompletetopicmodificationintervaloffsetvalue) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbushorttermforecastupdatecompletetopicuserreference.go b/build/platformclientv2/wfmbushorttermforecastupdatecompletetopicuserreference.go deleted file mode 100644 index d62c6f38d..000000000 --- a/build/platformclientv2/wfmbushorttermforecastupdatecompletetopicuserreference.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmbushorttermforecastupdatecompletetopicuserreference -type Wfmbushorttermforecastupdatecompletetopicuserreference struct { - // Id - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbushorttermforecastupdatecompletetopicuserreference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbushorttermforecastupdatecompletetopicwfmversionedentitymetadata.go b/build/platformclientv2/wfmbushorttermforecastupdatecompletetopicwfmversionedentitymetadata.go deleted file mode 100644 index 3df75cc95..000000000 --- a/build/platformclientv2/wfmbushorttermforecastupdatecompletetopicwfmversionedentitymetadata.go +++ /dev/null @@ -1,26 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Wfmbushorttermforecastupdatecompletetopicwfmversionedentitymetadata -type Wfmbushorttermforecastupdatecompletetopicwfmversionedentitymetadata struct { - // Version - Version *int `json:"version,omitempty"` - - - // ModifiedBy - ModifiedBy *Wfmbushorttermforecastupdatecompletetopicuserreference `json:"modifiedBy,omitempty"` - - - // DateModified - DateModified *time.Time `json:"dateModified,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbushorttermforecastupdatecompletetopicwfmversionedentitymetadata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmbusinessunitreference.go b/build/platformclientv2/wfmbusinessunitreference.go deleted file mode 100644 index b65223cd3..000000000 --- a/build/platformclientv2/wfmbusinessunitreference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmbusinessunitreference -type Wfmbusinessunitreference struct { - // Id - The ID of the business unit - Id *string `json:"id,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmbusinessunitreference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmforecastmodificationintervaloffsetvalue.go b/build/platformclientv2/wfmforecastmodificationintervaloffsetvalue.go deleted file mode 100644 index 1635c1c8c..000000000 --- a/build/platformclientv2/wfmforecastmodificationintervaloffsetvalue.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmforecastmodificationintervaloffsetvalue - Override the value of a single interval in a forecast -type Wfmforecastmodificationintervaloffsetvalue struct { - // IntervalIndex - The number of 15 minute intervals past referenceStartDate to which to apply this modification - IntervalIndex *int `json:"intervalIndex,omitempty"` - - - // Value - The value to set for the given interval - Value *float64 `json:"value,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmforecastmodificationintervaloffsetvalue) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmhistoricaladherencecalculationscompletetopicwfmhistoricaladherencecalculationscompletenotice.go b/build/platformclientv2/wfmhistoricaladherencecalculationscompletetopicwfmhistoricaladherencecalculationscompletenotice.go deleted file mode 100644 index e444eaa89..000000000 --- a/build/platformclientv2/wfmhistoricaladherencecalculationscompletetopicwfmhistoricaladherencecalculationscompletenotice.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmhistoricaladherencecalculationscompletetopicwfmhistoricaladherencecalculationscompletenotice -type Wfmhistoricaladherencecalculationscompletetopicwfmhistoricaladherencecalculationscompletenotice struct { - // Id - Id *string `json:"id,omitempty"` - - - // DownloadUrl - DownloadUrl *string `json:"downloadUrl,omitempty"` - - - // DownloadUrls - DownloadUrls *[]string `json:"downloadUrls,omitempty"` - - - // QueryState - QueryState *string `json:"queryState,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmhistoricaladherencecalculationscompletetopicwfmhistoricaladherencecalculationscompletenotice) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmhistoricaladherencequery.go b/build/platformclientv2/wfmhistoricaladherencequery.go deleted file mode 100644 index 2a931fc0f..000000000 --- a/build/platformclientv2/wfmhistoricaladherencequery.go +++ /dev/null @@ -1,38 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Wfmhistoricaladherencequery -type Wfmhistoricaladherencequery struct { - // StartDate - Beginning of the date range to query in ISO-8601 format - StartDate *time.Time `json:"startDate,omitempty"` - - - // EndDate - End of the date range to query in ISO-8601 format. If it is not set, end date will be set to current time - EndDate *time.Time `json:"endDate,omitempty"` - - - // TimeZone - The time zone to use for returned results in olson format. If it is not set, the business unit time zone will be used to compute adherence - TimeZone *string `json:"timeZone,omitempty"` - - - // UserIds - The userIds to report on. If null or not set, adherence will be computed for all the users in management unit or requested teamIds - UserIds *[]string `json:"userIds,omitempty"` - - - // IncludeExceptions - Whether user exceptions should be returned as part of the results - IncludeExceptions *bool `json:"includeExceptions,omitempty"` - - - // TeamIds - The teamIds to report on. If null or not set, adherence will be computed for requested users if applicable or otherwise all users in the management unit. Note: If teamIds is also specified, only adherence for users in the requested teams will be returned - TeamIds *[]string `json:"teamIds,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmhistoricaladherencequery) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmhistoricaladherencequeryforusers.go b/build/platformclientv2/wfmhistoricaladherencequeryforusers.go deleted file mode 100644 index 441e050c0..000000000 --- a/build/platformclientv2/wfmhistoricaladherencequeryforusers.go +++ /dev/null @@ -1,34 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Wfmhistoricaladherencequeryforusers -type Wfmhistoricaladherencequeryforusers struct { - // StartDate - Beginning of the date range to query in ISO-8601 format - StartDate *time.Time `json:"startDate,omitempty"` - - - // EndDate - End of the date range to query in ISO-8601 format. If it is not set, end date will be set to current time - EndDate *time.Time `json:"endDate,omitempty"` - - - // TimeZone - The time zone to use for returned results in olson format. If it is not set, the business unit time zone will be used to compute adherence - TimeZone *string `json:"timeZone,omitempty"` - - - // UserIds - The userIds to report on - UserIds *[]string `json:"userIds,omitempty"` - - - // IncludeExceptions - Whether user exceptions should be returned as part of the results - IncludeExceptions *bool `json:"includeExceptions,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmhistoricaladherencequeryforusers) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmhistoricaladherenceresponse.go b/build/platformclientv2/wfmhistoricaladherenceresponse.go deleted file mode 100644 index 0d7b649fe..000000000 --- a/build/platformclientv2/wfmhistoricaladherenceresponse.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmhistoricaladherenceresponse - Response for Historical Adherence Query, intended to tell the client what to listen for on a notification topic -type Wfmhistoricaladherenceresponse struct { - // Id - The query ID to listen for - Id *string `json:"id,omitempty"` - - - // DownloadUrl - Deprecated. Use downloadUrls instead. - DownloadUrl *string `json:"downloadUrl,omitempty"` - - - // DownloadResult - Result will always come via downloadUrls; however the schema is included for documentation - DownloadResult *Wfmhistoricaladherenceresultwrapper `json:"downloadResult,omitempty"` - - - // DownloadUrls - The uri list to GET the results of the Historical Adherence query. For notification purposes only - DownloadUrls *[]string `json:"downloadUrls,omitempty"` - - - // QueryState - The state of the adherence query - QueryState *string `json:"queryState,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmhistoricaladherenceresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmhistoricaladherenceresultwrapper.go b/build/platformclientv2/wfmhistoricaladherenceresultwrapper.go deleted file mode 100644 index dce82f2e9..000000000 --- a/build/platformclientv2/wfmhistoricaladherenceresultwrapper.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmhistoricaladherenceresultwrapper -type Wfmhistoricaladherenceresultwrapper struct { - // EntityId - The operation ID of the historical adherence query - EntityId *string `json:"entityId,omitempty"` - - - // Data - The list of historical adherence query results - Data *[]Historicaladherencequeryresult `json:"data,omitempty"` - - - // LookupIdToSecondaryPresenceId - Map of secondary presence lookup ID to corresponding secondary presence ID - LookupIdToSecondaryPresenceId *map[string]string `json:"lookupIdToSecondaryPresenceId,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmhistoricaladherenceresultwrapper) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmhistoricaldatauploadpurgerequeststatustopichistoricaldatauploadpurgerequestupdate.go b/build/platformclientv2/wfmhistoricaldatauploadpurgerequeststatustopichistoricaldatauploadpurgerequestupdate.go deleted file mode 100644 index fde7bad35..000000000 --- a/build/platformclientv2/wfmhistoricaldatauploadpurgerequeststatustopichistoricaldatauploadpurgerequestupdate.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmhistoricaldatauploadpurgerequeststatustopichistoricaldatauploadpurgerequestupdate -type Wfmhistoricaldatauploadpurgerequeststatustopichistoricaldatauploadpurgerequestupdate struct { - // Status - Status *string `json:"status,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmhistoricaldatauploadpurgerequeststatustopichistoricaldatauploadpurgerequestupdate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmhistoricaldatauploadrequeststatustopicdatetime.go b/build/platformclientv2/wfmhistoricaldatauploadrequeststatustopicdatetime.go deleted file mode 100644 index 70d86aeea..000000000 --- a/build/platformclientv2/wfmhistoricaldatauploadrequeststatustopicdatetime.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmhistoricaldatauploadrequeststatustopicdatetime -type Wfmhistoricaldatauploadrequeststatustopicdatetime struct { - // IMillis - IMillis *int `json:"iMillis,omitempty"` - - - // BeforeNow - BeforeNow *bool `json:"beforeNow,omitempty"` - - - // EqualNow - EqualNow *bool `json:"equalNow,omitempty"` - - - // AfterNow - AfterNow *bool `json:"afterNow,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmhistoricaldatauploadrequeststatustopicdatetime) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmhistoricaldatauploadrequeststatustopichistoricaldatauploadrequestupdate.go b/build/platformclientv2/wfmhistoricaldatauploadrequeststatustopichistoricaldatauploadrequestupdate.go deleted file mode 100644 index 5c82341ed..000000000 --- a/build/platformclientv2/wfmhistoricaldatauploadrequeststatustopichistoricaldatauploadrequestupdate.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmhistoricaldatauploadrequeststatustopichistoricaldatauploadrequestupdate -type Wfmhistoricaldatauploadrequeststatustopichistoricaldatauploadrequestupdate struct { - // RequestId - RequestId *string `json:"requestId,omitempty"` - - - // DateImportStarted - DateImportStarted *Wfmhistoricaldatauploadrequeststatustopicdatetime `json:"dateImportStarted,omitempty"` - - - // DateImportEnded - DateImportEnded *Wfmhistoricaldatauploadrequeststatustopicdatetime `json:"dateImportEnded,omitempty"` - - - // DateCreated - DateCreated *Wfmhistoricaldatauploadrequeststatustopicdatetime `json:"dateCreated,omitempty"` - - - // DateModified - DateModified *Wfmhistoricaldatauploadrequeststatustopicdatetime `json:"dateModified,omitempty"` - - - // Status - Status *string `json:"status,omitempty"` - - - // VarError - VarError *string `json:"error,omitempty"` - - - // Active - Active *bool `json:"active,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmhistoricaldatauploadrequeststatustopichistoricaldatauploadrequestupdate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmintradaydataupdatetopicintradaydatagroup.go b/build/platformclientv2/wfmintradaydataupdatetopicintradaydatagroup.go deleted file mode 100644 index 9b2c44c86..000000000 --- a/build/platformclientv2/wfmintradaydataupdatetopicintradaydatagroup.go +++ /dev/null @@ -1,41 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmintradaydataupdatetopicintradaydatagroup -type Wfmintradaydataupdatetopicintradaydatagroup struct { - // MediaType - MediaType *string `json:"mediaType,omitempty"` - - - // ForecastDataPerInterval - ForecastDataPerInterval *[]Wfmintradaydataupdatetopicintradayforecastdata `json:"forecastDataPerInterval,omitempty"` - - - // ScheduleDataPerInterval - ScheduleDataPerInterval *[]Wfmintradaydataupdatetopicintradayscheduledata `json:"scheduleDataPerInterval,omitempty"` - - - // HistoricalAgentDataPerInterval - HistoricalAgentDataPerInterval *[]Wfmintradaydataupdatetopicintradayhistoricalagentdata `json:"historicalAgentDataPerInterval,omitempty"` - - - // HistoricalQueueDataPerInterval - HistoricalQueueDataPerInterval *[]Wfmintradaydataupdatetopicintradayhistoricalqueuedata `json:"historicalQueueDataPerInterval,omitempty"` - - - // PerformancePredictionAgentDataPerInterval - PerformancePredictionAgentDataPerInterval *[]Wfmintradaydataupdatetopicintradayperformancepredictionagentdata `json:"performancePredictionAgentDataPerInterval,omitempty"` - - - // PerformancePredictionQueueDataPerInterval - PerformancePredictionQueueDataPerInterval *[]Wfmintradaydataupdatetopicintradayperformancepredictionqueuedata `json:"performancePredictionQueueDataPerInterval,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmintradaydataupdatetopicintradaydatagroup) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmintradaydataupdatetopicintradaydataupdate.go b/build/platformclientv2/wfmintradaydataupdatetopicintradaydataupdate.go deleted file mode 100644 index 8d19bc42c..000000000 --- a/build/platformclientv2/wfmintradaydataupdatetopicintradaydataupdate.go +++ /dev/null @@ -1,42 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Wfmintradaydataupdatetopicintradaydataupdate -type Wfmintradaydataupdatetopicintradaydataupdate struct { - // StartDate - StartDate *time.Time `json:"startDate,omitempty"` - - - // EndDate - EndDate *time.Time `json:"endDate,omitempty"` - - - // IntervalLengthMinutes - IntervalLengthMinutes *int `json:"intervalLengthMinutes,omitempty"` - - - // NumberOfIntervals - NumberOfIntervals *int `json:"numberOfIntervals,omitempty"` - - - // Metrics - Metrics *[]Wfmintradaydataupdatetopicintradaymetric `json:"metrics,omitempty"` - - - // QueueIds - QueueIds *[]string `json:"queueIds,omitempty"` - - - // IntradayDataGroupings - IntradayDataGroupings *[]Wfmintradaydataupdatetopicintradaydatagroup `json:"intradayDataGroupings,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmintradaydataupdatetopicintradaydataupdate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmintradaydataupdatetopicintradayforecastdata.go b/build/platformclientv2/wfmintradaydataupdatetopicintradayforecastdata.go deleted file mode 100644 index 418d07c88..000000000 --- a/build/platformclientv2/wfmintradaydataupdatetopicintradayforecastdata.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmintradaydataupdatetopicintradayforecastdata -type Wfmintradaydataupdatetopicintradayforecastdata struct { - // Offered - Offered *float32 `json:"offered,omitempty"` - - - // AverageTalkTimeSeconds - AverageTalkTimeSeconds *float32 `json:"averageTalkTimeSeconds,omitempty"` - - - // AverageAfterCallWorkSeconds - AverageAfterCallWorkSeconds *float32 `json:"averageAfterCallWorkSeconds,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmintradaydataupdatetopicintradayforecastdata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmintradaydataupdatetopicintradayhistoricalagentdata.go b/build/platformclientv2/wfmintradaydataupdatetopicintradayhistoricalagentdata.go deleted file mode 100644 index 0a77c529e..000000000 --- a/build/platformclientv2/wfmintradaydataupdatetopicintradayhistoricalagentdata.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmintradaydataupdatetopicintradayhistoricalagentdata -type Wfmintradaydataupdatetopicintradayhistoricalagentdata struct { - // OnQueueTimeSeconds - OnQueueTimeSeconds *float32 `json:"onQueueTimeSeconds,omitempty"` - - - // InteractingTimeSeconds - InteractingTimeSeconds *float32 `json:"interactingTimeSeconds,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmintradaydataupdatetopicintradayhistoricalagentdata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmintradaydataupdatetopicintradayhistoricalqueuedata.go b/build/platformclientv2/wfmintradaydataupdatetopicintradayhistoricalqueuedata.go deleted file mode 100644 index 4d8faa5ad..000000000 --- a/build/platformclientv2/wfmintradaydataupdatetopicintradayhistoricalqueuedata.go +++ /dev/null @@ -1,45 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmintradaydataupdatetopicintradayhistoricalqueuedata -type Wfmintradaydataupdatetopicintradayhistoricalqueuedata struct { - // Offered - Offered *int `json:"offered,omitempty"` - - - // Completed - Completed *int `json:"completed,omitempty"` - - - // Answered - Answered *int `json:"answered,omitempty"` - - - // Abandoned - Abandoned *int `json:"abandoned,omitempty"` - - - // AverageTalkTimeSeconds - AverageTalkTimeSeconds *float32 `json:"averageTalkTimeSeconds,omitempty"` - - - // AverageAfterCallWorkSeconds - AverageAfterCallWorkSeconds *float32 `json:"averageAfterCallWorkSeconds,omitempty"` - - - // ServiceLevelPercent - ServiceLevelPercent *float32 `json:"serviceLevelPercent,omitempty"` - - - // AverageSpeedOfAnswerSeconds - AverageSpeedOfAnswerSeconds *float32 `json:"averageSpeedOfAnswerSeconds,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmintradaydataupdatetopicintradayhistoricalqueuedata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmintradaydataupdatetopicintradaymetric.go b/build/platformclientv2/wfmintradaydataupdatetopicintradaymetric.go deleted file mode 100644 index 88a714adf..000000000 --- a/build/platformclientv2/wfmintradaydataupdatetopicintradaymetric.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmintradaydataupdatetopicintradaymetric -type Wfmintradaydataupdatetopicintradaymetric struct { - // Category - Category *string `json:"category,omitempty"` - - - // Version - Version *string `json:"version,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmintradaydataupdatetopicintradaymetric) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmintradaydataupdatetopicintradayperformancepredictionagentdata.go b/build/platformclientv2/wfmintradaydataupdatetopicintradayperformancepredictionagentdata.go deleted file mode 100644 index f73d59f37..000000000 --- a/build/platformclientv2/wfmintradaydataupdatetopicintradayperformancepredictionagentdata.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmintradaydataupdatetopicintradayperformancepredictionagentdata -type Wfmintradaydataupdatetopicintradayperformancepredictionagentdata struct { - // InteractingTimeSeconds - InteractingTimeSeconds *float32 `json:"interactingTimeSeconds,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmintradaydataupdatetopicintradayperformancepredictionagentdata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmintradaydataupdatetopicintradayperformancepredictionqueuedata.go b/build/platformclientv2/wfmintradaydataupdatetopicintradayperformancepredictionqueuedata.go deleted file mode 100644 index eee78c1cb..000000000 --- a/build/platformclientv2/wfmintradaydataupdatetopicintradayperformancepredictionqueuedata.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmintradaydataupdatetopicintradayperformancepredictionqueuedata -type Wfmintradaydataupdatetopicintradayperformancepredictionqueuedata struct { - // ServiceLevelPercent - ServiceLevelPercent *float32 `json:"serviceLevelPercent,omitempty"` - - - // AverageSpeedOfAnswerSeconds - AverageSpeedOfAnswerSeconds *float32 `json:"averageSpeedOfAnswerSeconds,omitempty"` - - - // NumberOfInteractions - NumberOfInteractions *float32 `json:"numberOfInteractions,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmintradaydataupdatetopicintradayperformancepredictionqueuedata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmintradaydataupdatetopicintradayscheduledata.go b/build/platformclientv2/wfmintradaydataupdatetopicintradayscheduledata.go deleted file mode 100644 index 041089da7..000000000 --- a/build/platformclientv2/wfmintradaydataupdatetopicintradayscheduledata.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmintradaydataupdatetopicintradayscheduledata -type Wfmintradaydataupdatetopicintradayscheduledata struct { - // OnQueueTimeSeconds - OnQueueTimeSeconds *int `json:"onQueueTimeSeconds,omitempty"` - - - // ScheduledTimeSeconds - ScheduledTimeSeconds *int `json:"scheduledTimeSeconds,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmintradaydataupdatetopicintradayscheduledata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmintradayplanninggrouplisting.go b/build/platformclientv2/wfmintradayplanninggrouplisting.go deleted file mode 100644 index f97019e14..000000000 --- a/build/platformclientv2/wfmintradayplanninggrouplisting.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmintradayplanninggrouplisting - A list of IntradayPlanningGroup objects -type Wfmintradayplanninggrouplisting struct { - // Entities - Entities *[]Forecastplanninggroupresponse `json:"entities,omitempty"` - - - // NoDataReason - The reason there was no data for the request - NoDataReason *string `json:"noDataReason,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmintradayplanninggrouplisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmmoveagentscompletetopicmanagementunit.go b/build/platformclientv2/wfmmoveagentscompletetopicmanagementunit.go deleted file mode 100644 index 229bcdf1f..000000000 --- a/build/platformclientv2/wfmmoveagentscompletetopicmanagementunit.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmmoveagentscompletetopicmanagementunit -type Wfmmoveagentscompletetopicmanagementunit struct { - // Id - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmmoveagentscompletetopicmanagementunit) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmmoveagentscompletetopicuserreference.go b/build/platformclientv2/wfmmoveagentscompletetopicuserreference.go deleted file mode 100644 index b5fd9a166..000000000 --- a/build/platformclientv2/wfmmoveagentscompletetopicuserreference.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmmoveagentscompletetopicuserreference -type Wfmmoveagentscompletetopicuserreference struct { - // Id - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmmoveagentscompletetopicuserreference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmmoveagentscompletetopicwfmmoveagentdata.go b/build/platformclientv2/wfmmoveagentscompletetopicwfmmoveagentdata.go deleted file mode 100644 index 1b9d77a5e..000000000 --- a/build/platformclientv2/wfmmoveagentscompletetopicwfmmoveagentdata.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmmoveagentscompletetopicwfmmoveagentdata -type Wfmmoveagentscompletetopicwfmmoveagentdata struct { - // User - User *Wfmmoveagentscompletetopicuserreference `json:"user,omitempty"` - - - // Result - Result *string `json:"result,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmmoveagentscompletetopicwfmmoveagentdata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmmoveagentscompletetopicwfmmoveagentscomplete.go b/build/platformclientv2/wfmmoveagentscompletetopicwfmmoveagentscomplete.go deleted file mode 100644 index 6bee5e94d..000000000 --- a/build/platformclientv2/wfmmoveagentscompletetopicwfmmoveagentscomplete.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmmoveagentscompletetopicwfmmoveagentscomplete -type Wfmmoveagentscompletetopicwfmmoveagentscomplete struct { - // RequestingUser - RequestingUser *Wfmmoveagentscompletetopicuserreference `json:"requestingUser,omitempty"` - - - // DestinationManagementUnit - DestinationManagementUnit *Wfmmoveagentscompletetopicmanagementunit `json:"destinationManagementUnit,omitempty"` - - - // Results - Results *[]Wfmmoveagentscompletetopicwfmmoveagentdata `json:"results,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmmoveagentscompletetopicwfmmoveagentscomplete) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmmovemanagementunittopicbusinessunit.go b/build/platformclientv2/wfmmovemanagementunittopicbusinessunit.go deleted file mode 100644 index 8ccb9b77a..000000000 --- a/build/platformclientv2/wfmmovemanagementunittopicbusinessunit.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmmovemanagementunittopicbusinessunit -type Wfmmovemanagementunittopicbusinessunit struct { - // Id - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmmovemanagementunittopicbusinessunit) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmmovemanagementunittopicmovemanagementunitnotification.go b/build/platformclientv2/wfmmovemanagementunittopicmovemanagementunitnotification.go deleted file mode 100644 index 5e74ae51b..000000000 --- a/build/platformclientv2/wfmmovemanagementunittopicmovemanagementunitnotification.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmmovemanagementunittopicmovemanagementunitnotification -type Wfmmovemanagementunittopicmovemanagementunitnotification struct { - // BusinessUnit - BusinessUnit *Wfmmovemanagementunittopicbusinessunit `json:"businessUnit,omitempty"` - - - // Status - Status *string `json:"status,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmmovemanagementunittopicmovemanagementunitnotification) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmschedulereference.go b/build/platformclientv2/wfmschedulereference.go deleted file mode 100644 index 424328d27..000000000 --- a/build/platformclientv2/wfmschedulereference.go +++ /dev/null @@ -1,30 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Wfmschedulereference -type Wfmschedulereference struct { - // Id - The ID of the WFM schedule - Id *string `json:"id,omitempty"` - - - // BusinessUnit - A reference to a Workforce Management Business Unit - BusinessUnit *Wfmbusinessunitreference `json:"businessUnit,omitempty"` - - - // WeekDate - The start week date for this schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd - WeekDate *time.Time `json:"weekDate,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmschedulereference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmscheduletopicwfmschedulenotification.go b/build/platformclientv2/wfmscheduletopicwfmschedulenotification.go deleted file mode 100644 index 1014f0243..000000000 --- a/build/platformclientv2/wfmscheduletopicwfmschedulenotification.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmscheduletopicwfmschedulenotification -type Wfmscheduletopicwfmschedulenotification struct { - // Status - Status *string `json:"status,omitempty"` - - - // OperationId - OperationId *string `json:"operationId,omitempty"` - - - // DownloadUrl - DownloadUrl *string `json:"downloadUrl,omitempty"` - - - // PercentComplete - PercentComplete *int `json:"percentComplete,omitempty"` - - - // EventType - EventType *string `json:"eventType,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmscheduletopicwfmschedulenotification) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmtimeoffrequestupdatetopictimeoffrequestupdate.go b/build/platformclientv2/wfmtimeoffrequestupdatetopictimeoffrequestupdate.go deleted file mode 100644 index d722b876f..000000000 --- a/build/platformclientv2/wfmtimeoffrequestupdatetopictimeoffrequestupdate.go +++ /dev/null @@ -1,77 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmtimeoffrequestupdatetopictimeoffrequestupdate -type Wfmtimeoffrequestupdatetopictimeoffrequestupdate struct { - // Id - Id *string `json:"id,omitempty"` - - - // User - User *Wfmtimeoffrequestupdatetopicuserreference `json:"user,omitempty"` - - - // IsFullDayRequest - IsFullDayRequest *bool `json:"isFullDayRequest,omitempty"` - - - // MarkedAsRead - MarkedAsRead *bool `json:"markedAsRead,omitempty"` - - - // ActivityCodeId - ActivityCodeId *string `json:"activityCodeId,omitempty"` - - - // Status - Status *string `json:"status,omitempty"` - - - // PartialDayStartDateTimes - PartialDayStartDateTimes *[]string `json:"partialDayStartDateTimes,omitempty"` - - - // FullDayManagementUnitDates - FullDayManagementUnitDates *[]string `json:"fullDayManagementUnitDates,omitempty"` - - - // DailyDurationMinutes - DailyDurationMinutes *int `json:"dailyDurationMinutes,omitempty"` - - - // Notes - Notes *string `json:"notes,omitempty"` - - - // ReviewedDate - ReviewedDate *string `json:"reviewedDate,omitempty"` - - - // ReviewedBy - ReviewedBy *string `json:"reviewedBy,omitempty"` - - - // SubmittedDate - SubmittedDate *string `json:"submittedDate,omitempty"` - - - // SubmittedBy - SubmittedBy *string `json:"submittedBy,omitempty"` - - - // ModifiedDate - ModifiedDate *string `json:"modifiedDate,omitempty"` - - - // ModifiedBy - ModifiedBy *string `json:"modifiedBy,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmtimeoffrequestupdatetopictimeoffrequestupdate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmtimeoffrequestupdatetopicuserreference.go b/build/platformclientv2/wfmtimeoffrequestupdatetopicuserreference.go deleted file mode 100644 index aae040004..000000000 --- a/build/platformclientv2/wfmtimeoffrequestupdatetopicuserreference.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmtimeoffrequestupdatetopicuserreference -type Wfmtimeoffrequestupdatetopicuserreference struct { - // Id - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmtimeoffrequestupdatetopicuserreference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmupdateagentdetailstopicwfmupdateagentdetailscomplete.go b/build/platformclientv2/wfmupdateagentdetailstopicwfmupdateagentdetailscomplete.go deleted file mode 100644 index 7d46e3e0b..000000000 --- a/build/platformclientv2/wfmupdateagentdetailstopicwfmupdateagentdetailscomplete.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmupdateagentdetailstopicwfmupdateagentdetailscomplete -type Wfmupdateagentdetailstopicwfmupdateagentdetailscomplete struct { - // Status - Status *string `json:"status,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmupdateagentdetailstopicwfmupdateagentdetailscomplete) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmuserentitylisting.go b/build/platformclientv2/wfmuserentitylisting.go deleted file mode 100644 index 9e45bdd5e..000000000 --- a/build/platformclientv2/wfmuserentitylisting.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmuserentitylisting -type Wfmuserentitylisting struct { - // Entities - Entities *[]User `json:"entities,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmuserentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmusernotification.go b/build/platformclientv2/wfmusernotification.go deleted file mode 100644 index 10142872e..000000000 --- a/build/platformclientv2/wfmusernotification.go +++ /dev/null @@ -1,50 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Wfmusernotification -type Wfmusernotification struct { - // Id - The immutable globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // MutableGroupId - The group ID of the notification (mutable, may change on update) - MutableGroupId *string `json:"mutableGroupId,omitempty"` - - - // Timestamp - The timestamp for this notification. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - Timestamp *time.Time `json:"timestamp,omitempty"` - - - // VarType - The type of this notification - VarType *string `json:"type,omitempty"` - - - // ShiftTrade - A shift trade notification. Only set if type == ShiftTrade - ShiftTrade *Shifttradenotification `json:"shiftTrade,omitempty"` - - - // TimeOffRequest - A time off request notification. Only set if type == TimeOffRequest - TimeOffRequest *Timeoffrequestnotification `json:"timeOffRequest,omitempty"` - - - // MarkedAsRead - Whether this notification has been marked \"read\" - MarkedAsRead *bool `json:"markedAsRead,omitempty"` - - - // AgentNotification - Whether this notification is for an agent - AgentNotification *bool `json:"agentNotification,omitempty"` - - - // OtherNotificationIdsInGroup - Other notification IDs in group. This field is only populated in real-time notifications - OtherNotificationIdsInGroup *[]string `json:"otherNotificationIdsInGroup,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmusernotification) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmusernotificationtopicshifttradenotification.go b/build/platformclientv2/wfmusernotificationtopicshifttradenotification.go deleted file mode 100644 index 0de4f342f..000000000 --- a/build/platformclientv2/wfmusernotificationtopicshifttradenotification.go +++ /dev/null @@ -1,46 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Wfmusernotificationtopicshifttradenotification -type Wfmusernotificationtopicshifttradenotification struct { - // WeekDate - WeekDate *string `json:"weekDate,omitempty"` - - - // TradeId - TradeId *string `json:"tradeId,omitempty"` - - - // OneSided - OneSided *bool `json:"oneSided,omitempty"` - - - // NewState - NewState *string `json:"newState,omitempty"` - - - // InitiatingUser - InitiatingUser *Wfmusernotificationtopicuserreference `json:"initiatingUser,omitempty"` - - - // InitiatingShiftDate - InitiatingShiftDate *time.Time `json:"initiatingShiftDate,omitempty"` - - - // ReceivingUser - ReceivingUser *Wfmusernotificationtopicuserreference `json:"receivingUser,omitempty"` - - - // ReceivingShiftDate - ReceivingShiftDate *time.Time `json:"receivingShiftDate,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmusernotificationtopicshifttradenotification) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmusernotificationtopictimeoffrequestnotification.go b/build/platformclientv2/wfmusernotificationtopictimeoffrequestnotification.go deleted file mode 100644 index 74a9278f4..000000000 --- a/build/platformclientv2/wfmusernotificationtopictimeoffrequestnotification.go +++ /dev/null @@ -1,38 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Wfmusernotificationtopictimeoffrequestnotification -type Wfmusernotificationtopictimeoffrequestnotification struct { - // TimeOffRequestId - TimeOffRequestId *string `json:"timeOffRequestId,omitempty"` - - - // User - User *Wfmusernotificationtopicuserreference `json:"user,omitempty"` - - - // IsFullDayRequest - IsFullDayRequest *bool `json:"isFullDayRequest,omitempty"` - - - // Status - Status *string `json:"status,omitempty"` - - - // PartialDayStartDateTimes - PartialDayStartDateTimes *[]time.Time `json:"partialDayStartDateTimes,omitempty"` - - - // FullDayManagementUnitDates - FullDayManagementUnitDates *[]string `json:"fullDayManagementUnitDates,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmusernotificationtopictimeoffrequestnotification) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmusernotificationtopicuserreference.go b/build/platformclientv2/wfmusernotificationtopicuserreference.go deleted file mode 100644 index 7bc8d9d9d..000000000 --- a/build/platformclientv2/wfmusernotificationtopicuserreference.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmusernotificationtopicuserreference -type Wfmusernotificationtopicuserreference struct { - // Id - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmusernotificationtopicuserreference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmusernotificationtopicwfmusernotification.go b/build/platformclientv2/wfmusernotificationtopicwfmusernotification.go deleted file mode 100644 index 44c283ac9..000000000 --- a/build/platformclientv2/wfmusernotificationtopicwfmusernotification.go +++ /dev/null @@ -1,50 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Wfmusernotificationtopicwfmusernotification -type Wfmusernotificationtopicwfmusernotification struct { - // Id - Id *string `json:"id,omitempty"` - - - // MutableGroupId - MutableGroupId *string `json:"mutableGroupId,omitempty"` - - - // Timestamp - Timestamp *time.Time `json:"timestamp,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - - - // ShiftTrade - ShiftTrade *Wfmusernotificationtopicshifttradenotification `json:"shiftTrade,omitempty"` - - - // TimeOffRequest - TimeOffRequest *Wfmusernotificationtopictimeoffrequestnotification `json:"timeOffRequest,omitempty"` - - - // AgentNotification - AgentNotification *bool `json:"agentNotification,omitempty"` - - - // OtherNotificationIdsInGroup - OtherNotificationIdsInGroup *[]string `json:"otherNotificationIdsInGroup,omitempty"` - - - // MarkedAsRead - MarkedAsRead *bool `json:"markedAsRead,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmusernotificationtopicwfmusernotification) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmuserscheduleadherenceupdatedmutopicqueuereference.go b/build/platformclientv2/wfmuserscheduleadherenceupdatedmutopicqueuereference.go deleted file mode 100644 index 4c820e931..000000000 --- a/build/platformclientv2/wfmuserscheduleadherenceupdatedmutopicqueuereference.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmuserscheduleadherenceupdatedmutopicqueuereference -type Wfmuserscheduleadherenceupdatedmutopicqueuereference struct { - // Id - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmuserscheduleadherenceupdatedmutopicqueuereference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmuserscheduleadherenceupdatedmutopicurireference.go b/build/platformclientv2/wfmuserscheduleadherenceupdatedmutopicurireference.go deleted file mode 100644 index 103decf06..000000000 --- a/build/platformclientv2/wfmuserscheduleadherenceupdatedmutopicurireference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmuserscheduleadherenceupdatedmutopicurireference -type Wfmuserscheduleadherenceupdatedmutopicurireference struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmuserscheduleadherenceupdatedmutopicurireference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmuserscheduleadherenceupdatedmutopicuserreference.go b/build/platformclientv2/wfmuserscheduleadherenceupdatedmutopicuserreference.go deleted file mode 100644 index b25314bec..000000000 --- a/build/platformclientv2/wfmuserscheduleadherenceupdatedmutopicuserreference.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmuserscheduleadherenceupdatedmutopicuserreference -type Wfmuserscheduleadherenceupdatedmutopicuserreference struct { - // Id - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmuserscheduleadherenceupdatedmutopicuserreference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmuserscheduleadherenceupdatedmutopicuserscheduleadherenceupdate.go b/build/platformclientv2/wfmuserscheduleadherenceupdatedmutopicuserscheduleadherenceupdate.go deleted file mode 100644 index f98b9eb1f..000000000 --- a/build/platformclientv2/wfmuserscheduleadherenceupdatedmutopicuserscheduleadherenceupdate.go +++ /dev/null @@ -1,78 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Wfmuserscheduleadherenceupdatedmutopicuserscheduleadherenceupdate -type Wfmuserscheduleadherenceupdatedmutopicuserscheduleadherenceupdate struct { - // User - User *Wfmuserscheduleadherenceupdatedmutopicuserreference `json:"user,omitempty"` - - - // ManagementUnitId - ManagementUnitId *string `json:"managementUnitId,omitempty"` - - - // Team - Team *Wfmuserscheduleadherenceupdatedmutopicurireference `json:"team,omitempty"` - - - // ScheduledActivityCategory - ScheduledActivityCategory *string `json:"scheduledActivityCategory,omitempty"` - - - // SystemPresence - SystemPresence *string `json:"systemPresence,omitempty"` - - - // OrganizationSecondaryPresenceId - OrganizationSecondaryPresenceId *string `json:"organizationSecondaryPresenceId,omitempty"` - - - // RoutingStatus - RoutingStatus *string `json:"routingStatus,omitempty"` - - - // ActualActivityCategory - ActualActivityCategory *string `json:"actualActivityCategory,omitempty"` - - - // IsOutOfOffice - IsOutOfOffice *bool `json:"isOutOfOffice,omitempty"` - - - // AdherenceState - AdherenceState *string `json:"adherenceState,omitempty"` - - - // Impact - Impact *string `json:"impact,omitempty"` - - - // AdherenceChangeTime - AdherenceChangeTime *time.Time `json:"adherenceChangeTime,omitempty"` - - - // PresenceUpdateTime - PresenceUpdateTime *time.Time `json:"presenceUpdateTime,omitempty"` - - - // ActiveQueues - ActiveQueues *[]Wfmuserscheduleadherenceupdatedmutopicqueuereference `json:"activeQueues,omitempty"` - - - // ActiveQueuesModifiedTime - ActiveQueuesModifiedTime *time.Time `json:"activeQueuesModifiedTime,omitempty"` - - - // RemovedFromManagementUnit - RemovedFromManagementUnit *bool `json:"removedFromManagementUnit,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmuserscheduleadherenceupdatedmutopicuserscheduleadherenceupdate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmuserscheduleadherenceupdatedteamtopicqueuereference.go b/build/platformclientv2/wfmuserscheduleadherenceupdatedteamtopicqueuereference.go deleted file mode 100644 index e99fd3cdc..000000000 --- a/build/platformclientv2/wfmuserscheduleadherenceupdatedteamtopicqueuereference.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmuserscheduleadherenceupdatedteamtopicqueuereference -type Wfmuserscheduleadherenceupdatedteamtopicqueuereference struct { - // Id - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmuserscheduleadherenceupdatedteamtopicqueuereference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmuserscheduleadherenceupdatedteamtopicurireference.go b/build/platformclientv2/wfmuserscheduleadherenceupdatedteamtopicurireference.go deleted file mode 100644 index 04bea3f4b..000000000 --- a/build/platformclientv2/wfmuserscheduleadherenceupdatedteamtopicurireference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmuserscheduleadherenceupdatedteamtopicurireference -type Wfmuserscheduleadherenceupdatedteamtopicurireference struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmuserscheduleadherenceupdatedteamtopicurireference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmuserscheduleadherenceupdatedteamtopicuserreference.go b/build/platformclientv2/wfmuserscheduleadherenceupdatedteamtopicuserreference.go deleted file mode 100644 index cea8e5c56..000000000 --- a/build/platformclientv2/wfmuserscheduleadherenceupdatedteamtopicuserreference.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmuserscheduleadherenceupdatedteamtopicuserreference -type Wfmuserscheduleadherenceupdatedteamtopicuserreference struct { - // Id - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmuserscheduleadherenceupdatedteamtopicuserreference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmuserscheduleadherenceupdatedteamtopicuserscheduleadherenceupdate.go b/build/platformclientv2/wfmuserscheduleadherenceupdatedteamtopicuserscheduleadherenceupdate.go deleted file mode 100644 index 9439e95cd..000000000 --- a/build/platformclientv2/wfmuserscheduleadherenceupdatedteamtopicuserscheduleadherenceupdate.go +++ /dev/null @@ -1,78 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Wfmuserscheduleadherenceupdatedteamtopicuserscheduleadherenceupdate -type Wfmuserscheduleadherenceupdatedteamtopicuserscheduleadherenceupdate struct { - // User - User *Wfmuserscheduleadherenceupdatedteamtopicuserreference `json:"user,omitempty"` - - - // ManagementUnitId - ManagementUnitId *string `json:"managementUnitId,omitempty"` - - - // Team - Team *Wfmuserscheduleadherenceupdatedteamtopicurireference `json:"team,omitempty"` - - - // ScheduledActivityCategory - ScheduledActivityCategory *string `json:"scheduledActivityCategory,omitempty"` - - - // SystemPresence - SystemPresence *string `json:"systemPresence,omitempty"` - - - // OrganizationSecondaryPresenceId - OrganizationSecondaryPresenceId *string `json:"organizationSecondaryPresenceId,omitempty"` - - - // RoutingStatus - RoutingStatus *string `json:"routingStatus,omitempty"` - - - // ActualActivityCategory - ActualActivityCategory *string `json:"actualActivityCategory,omitempty"` - - - // IsOutOfOffice - IsOutOfOffice *bool `json:"isOutOfOffice,omitempty"` - - - // AdherenceState - AdherenceState *string `json:"adherenceState,omitempty"` - - - // Impact - Impact *string `json:"impact,omitempty"` - - - // AdherenceChangeTime - AdherenceChangeTime *time.Time `json:"adherenceChangeTime,omitempty"` - - - // PresenceUpdateTime - PresenceUpdateTime *time.Time `json:"presenceUpdateTime,omitempty"` - - - // ActiveQueues - ActiveQueues *[]Wfmuserscheduleadherenceupdatedteamtopicqueuereference `json:"activeQueues,omitempty"` - - - // ActiveQueuesModifiedTime - ActiveQueuesModifiedTime *time.Time `json:"activeQueuesModifiedTime,omitempty"` - - - // RemovedFromManagementUnit - RemovedFromManagementUnit *bool `json:"removedFromManagementUnit,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmuserscheduleadherenceupdatedteamtopicuserscheduleadherenceupdate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmuserscheduleadherenceupdatedtopicqueuereference.go b/build/platformclientv2/wfmuserscheduleadherenceupdatedtopicqueuereference.go deleted file mode 100644 index ac6a5dd0e..000000000 --- a/build/platformclientv2/wfmuserscheduleadherenceupdatedtopicqueuereference.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmuserscheduleadherenceupdatedtopicqueuereference -type Wfmuserscheduleadherenceupdatedtopicqueuereference struct { - // Id - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmuserscheduleadherenceupdatedtopicqueuereference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmuserscheduleadherenceupdatedtopicurireference.go b/build/platformclientv2/wfmuserscheduleadherenceupdatedtopicurireference.go deleted file mode 100644 index 72e6608dd..000000000 --- a/build/platformclientv2/wfmuserscheduleadherenceupdatedtopicurireference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmuserscheduleadherenceupdatedtopicurireference -type Wfmuserscheduleadherenceupdatedtopicurireference struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmuserscheduleadherenceupdatedtopicurireference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmuserscheduleadherenceupdatedtopicuserreference.go b/build/platformclientv2/wfmuserscheduleadherenceupdatedtopicuserreference.go deleted file mode 100644 index 3684b3e94..000000000 --- a/build/platformclientv2/wfmuserscheduleadherenceupdatedtopicuserreference.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wfmuserscheduleadherenceupdatedtopicuserreference -type Wfmuserscheduleadherenceupdatedtopicuserreference struct { - // Id - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmuserscheduleadherenceupdatedtopicuserreference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmuserscheduleadherenceupdatedtopicuserscheduleadherenceupdate.go b/build/platformclientv2/wfmuserscheduleadherenceupdatedtopicuserscheduleadherenceupdate.go deleted file mode 100644 index ea50a9d9c..000000000 --- a/build/platformclientv2/wfmuserscheduleadherenceupdatedtopicuserscheduleadherenceupdate.go +++ /dev/null @@ -1,78 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Wfmuserscheduleadherenceupdatedtopicuserscheduleadherenceupdate -type Wfmuserscheduleadherenceupdatedtopicuserscheduleadherenceupdate struct { - // User - User *Wfmuserscheduleadherenceupdatedtopicuserreference `json:"user,omitempty"` - - - // ManagementUnitId - ManagementUnitId *string `json:"managementUnitId,omitempty"` - - - // Team - Team *Wfmuserscheduleadherenceupdatedtopicurireference `json:"team,omitempty"` - - - // ScheduledActivityCategory - ScheduledActivityCategory *string `json:"scheduledActivityCategory,omitempty"` - - - // SystemPresence - SystemPresence *string `json:"systemPresence,omitempty"` - - - // OrganizationSecondaryPresenceId - OrganizationSecondaryPresenceId *string `json:"organizationSecondaryPresenceId,omitempty"` - - - // RoutingStatus - RoutingStatus *string `json:"routingStatus,omitempty"` - - - // ActualActivityCategory - ActualActivityCategory *string `json:"actualActivityCategory,omitempty"` - - - // IsOutOfOffice - IsOutOfOffice *bool `json:"isOutOfOffice,omitempty"` - - - // AdherenceState - AdherenceState *string `json:"adherenceState,omitempty"` - - - // Impact - Impact *string `json:"impact,omitempty"` - - - // AdherenceChangeTime - AdherenceChangeTime *time.Time `json:"adherenceChangeTime,omitempty"` - - - // PresenceUpdateTime - PresenceUpdateTime *time.Time `json:"presenceUpdateTime,omitempty"` - - - // ActiveQueues - ActiveQueues *[]Wfmuserscheduleadherenceupdatedtopicqueuereference `json:"activeQueues,omitempty"` - - - // ActiveQueuesModifiedTime - ActiveQueuesModifiedTime *time.Time `json:"activeQueuesModifiedTime,omitempty"` - - - // RemovedFromManagementUnit - RemovedFromManagementUnit *bool `json:"removedFromManagementUnit,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmuserscheduleadherenceupdatedtopicuserscheduleadherenceupdate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wfmversionedentitymetadata.go b/build/platformclientv2/wfmversionedentitymetadata.go deleted file mode 100644 index 052ca0dde..000000000 --- a/build/platformclientv2/wfmversionedentitymetadata.go +++ /dev/null @@ -1,26 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Wfmversionedentitymetadata - Metadata to associate with a given entity -type Wfmversionedentitymetadata struct { - // Version - The version of the associated entity. Used to prevent conflicts on concurrent edits - Version *int `json:"version,omitempty"` - - - // ModifiedBy - The user who last modified the associated entity - ModifiedBy *Userreference `json:"modifiedBy,omitempty"` - - - // DateModified - The date the associated entity was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wfmversionedentitymetadata) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/whatsappdefinition.go b/build/platformclientv2/whatsappdefinition.go deleted file mode 100644 index 7bb3ce4ab..000000000 --- a/build/platformclientv2/whatsappdefinition.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Whatsappdefinition - A WhatsApp messaging template definition as defined in the WhatsApp Business Manager -type Whatsappdefinition struct { - // Name - The messaging template name. - Name *string `json:"name,omitempty"` - - - // Namespace - The messaging template namespace. - Namespace *string `json:"namespace,omitempty"` - - - // Language - The messaging template language configured for this template. This is a WhatsApp specific value. For example, 'en_US' - Language *string `json:"language,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Whatsappdefinition) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/whatsappid.go b/build/platformclientv2/whatsappid.go deleted file mode 100644 index 2fa51347d..000000000 --- a/build/platformclientv2/whatsappid.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Whatsappid - User information for a WhatsApp account -type Whatsappid struct { - // PhoneNumber - The phone number associated with this WhatsApp account - PhoneNumber *Phonenumber `json:"phoneNumber,omitempty"` - - - // DisplayName - The displayName of this person's account in WhatsApp - DisplayName *string `json:"displayName,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Whatsappid) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/whatsappintegration.go b/build/platformclientv2/whatsappintegration.go deleted file mode 100644 index 1549aec90..000000000 --- a/build/platformclientv2/whatsappintegration.go +++ /dev/null @@ -1,74 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Whatsappintegration -type Whatsappintegration struct { - // Id - A unique Integration Id. - Id *string `json:"id,omitempty"` - - - // Name - The name of the WhatsApp integration. - Name *string `json:"name,omitempty"` - - - // PhoneNumber - The phone number associated to the whatsApp integration. - PhoneNumber *string `json:"phoneNumber,omitempty"` - - - // Status - The status of the WhatsApp Integration - Status *string `json:"status,omitempty"` - - - // Recipient - The recipient associated to the WhatsApp Integration. This recipient is used to associate a flow to an integration - Recipient *Domainentityref `json:"recipient,omitempty"` - - - // DateCreated - Date this Integration was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - Date this Integration was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // CreatedBy - User reference that created this Integration - CreatedBy *Domainentityref `json:"createdBy,omitempty"` - - - // ModifiedBy - User reference that last modified this Integration - ModifiedBy *Domainentityref `json:"modifiedBy,omitempty"` - - - // Version - Version number required for updates. - Version *int `json:"version,omitempty"` - - - // ActivationStatusCode - The status code of WhatsApp Integration activation process - ActivationStatusCode *string `json:"activationStatusCode,omitempty"` - - - // ActivationErrorInfo - The error information of WhatsApp Integration activation process - ActivationErrorInfo *Errorbody `json:"activationErrorInfo,omitempty"` - - - // CreateStatus - Status of asynchronous create operation - CreateStatus *string `json:"createStatus,omitempty"` - - - // CreateError - Error information returned, if createStatus is set to Error - CreateError *Errorbody `json:"createError,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Whatsappintegration) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/whatsappintegrationentitylisting.go b/build/platformclientv2/whatsappintegrationentitylisting.go deleted file mode 100644 index f613bb84d..000000000 --- a/build/platformclientv2/whatsappintegrationentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Whatsappintegrationentitylisting -type Whatsappintegrationentitylisting struct { - // Entities - Entities *[]Whatsappintegration `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Whatsappintegrationentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/whatsappintegrationrequest.go b/build/platformclientv2/whatsappintegrationrequest.go deleted file mode 100644 index dd7141944..000000000 --- a/build/platformclientv2/whatsappintegrationrequest.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Whatsappintegrationrequest -type Whatsappintegrationrequest struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The name of the WhatsApp Integration - Name *string `json:"name,omitempty"` - - - // PhoneNumber - The phone number associated to the whatsApp integration - PhoneNumber *string `json:"phoneNumber,omitempty"` - - - // WabaCertificate - The waba(WhatsApp Business Manager) certificate associated to the WhatsApp integration phone number - WabaCertificate *string `json:"wabaCertificate,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Whatsappintegrationrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/whatsappintegrationupdaterequest.go b/build/platformclientv2/whatsappintegrationupdaterequest.go deleted file mode 100644 index a5764b03d..000000000 --- a/build/platformclientv2/whatsappintegrationupdaterequest.go +++ /dev/null @@ -1,37 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Whatsappintegrationupdaterequest -type Whatsappintegrationupdaterequest struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - WhatsApp Integration name - Name *string `json:"name,omitempty"` - - - // Action - The action used to activate and then confirm a WhatsApp Integration. - Action *string `json:"action,omitempty"` - - - // AuthenticationMethod - The authentication method used to confirm a WhatsApp Integration activation. If action is set to Activate, then authenticationMethod is a required field. - AuthenticationMethod *string `json:"authenticationMethod,omitempty"` - - - // ConfirmationCode - The confirmation code sent by Whatsapp to you during the activation step. If action is set to Confirm, then confirmationCode is a required field. - ConfirmationCode *string `json:"confirmationCode,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Whatsappintegrationupdaterequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/widgetclientconfig.go b/build/platformclientv2/widgetclientconfig.go deleted file mode 100644 index 2721a081c..000000000 --- a/build/platformclientv2/widgetclientconfig.go +++ /dev/null @@ -1,29 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Widgetclientconfig -type Widgetclientconfig struct { - // V1 - V1 *Widgetclientconfigv1 `json:"v1,omitempty"` - - - // V2 - V2 *Widgetclientconfigv2 `json:"v2,omitempty"` - - - // V1Http - V1Http *Widgetclientconfigv1http `json:"v1-http,omitempty"` - - - // ThirdParty - ThirdParty *Widgetclientconfigthirdparty `json:"third-party,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Widgetclientconfig) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/widgetclientconfigthirdparty.go b/build/platformclientv2/widgetclientconfigthirdparty.go deleted file mode 100644 index d475ec305..000000000 --- a/build/platformclientv2/widgetclientconfigthirdparty.go +++ /dev/null @@ -1,13 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Widgetclientconfigthirdparty -type Widgetclientconfigthirdparty struct { } - -// String returns a JSON representation of the model -func (o *Widgetclientconfigthirdparty) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/widgetclientconfigv1.go b/build/platformclientv2/widgetclientconfigv1.go deleted file mode 100644 index c5466cd6f..000000000 --- a/build/platformclientv2/widgetclientconfigv1.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Widgetclientconfigv1 -type Widgetclientconfigv1 struct { - // WebChatSkin - WebChatSkin *string `json:"webChatSkin,omitempty"` - - - // AuthenticationUrl - AuthenticationUrl *string `json:"authenticationUrl,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Widgetclientconfigv1) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/widgetclientconfigv1http.go b/build/platformclientv2/widgetclientconfigv1http.go deleted file mode 100644 index 2a0f00ca7..000000000 --- a/build/platformclientv2/widgetclientconfigv1http.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Widgetclientconfigv1http -type Widgetclientconfigv1http struct { - // WebChatSkin - WebChatSkin *string `json:"webChatSkin,omitempty"` - - - // AuthenticationUrl - AuthenticationUrl *string `json:"authenticationUrl,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Widgetclientconfigv1http) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/widgetclientconfigv2.go b/build/platformclientv2/widgetclientconfigv2.go deleted file mode 100644 index 8b2d15f69..000000000 --- a/build/platformclientv2/widgetclientconfigv2.go +++ /dev/null @@ -1,13 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Widgetclientconfigv2 -type Widgetclientconfigv2 struct { } - -// String returns a JSON representation of the model -func (o *Widgetclientconfigv2) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/widgetdeployment.go b/build/platformclientv2/widgetdeployment.go deleted file mode 100644 index 9ebe61cd9..000000000 --- a/build/platformclientv2/widgetdeployment.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Widgetdeployment -type Widgetdeployment struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Description - A human-readable description of this Deployment. - Description *string `json:"description,omitempty"` - - - // AuthenticationRequired - When true, the customer members starting a chat must be authenticated by supplying their JWT to the create operation. - AuthenticationRequired *bool `json:"authenticationRequired,omitempty"` - - - // Disabled - When true, all create chat operations using this Deployment will be rejected. - Disabled *bool `json:"disabled,omitempty"` - - - // Flow - The URI of the Inbound Chat Flow to run when new chats are initiated under this Deployment. - Flow *Domainentityref `json:"flow,omitempty"` - - - // AllowedDomains - The list of domains that are approved to use this Deployment; the list will be added to CORS headers for ease of web use. - AllowedDomains *[]string `json:"allowedDomains,omitempty"` - - - // ClientType - The type of display widget for which this Deployment is configured, which controls the administrator settings shown. - ClientType *string `json:"clientType,omitempty"` - - - // ClientConfig - The client configuration options that should be made available to the clients of this Deployment. - ClientConfig *Widgetclientconfig `json:"clientConfig,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Widgetdeployment) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/widgetdeploymententitylisting.go b/build/platformclientv2/widgetdeploymententitylisting.go deleted file mode 100644 index efb3694c1..000000000 --- a/build/platformclientv2/widgetdeploymententitylisting.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Widgetdeploymententitylisting -type Widgetdeploymententitylisting struct { - // Total - Total *int `json:"total,omitempty"` - - - // Entities - Entities *[]Widgetdeployment `json:"entities,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Widgetdeploymententitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/widgetsapi.go b/build/platformclientv2/widgetsapi.go deleted file mode 100644 index e668da287..000000000 --- a/build/platformclientv2/widgetsapi.go +++ /dev/null @@ -1,378 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "encoding/json" -) - -// WidgetsApi provides functions for API endpoints -type WidgetsApi struct { - Configuration *Configuration -} - -// NewWidgetsApi creates an API instance using the default configuration -func NewWidgetsApi() *WidgetsApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating WidgetsApi with base path: %s", strings.ToLower(config.BasePath))) - return &WidgetsApi{ - Configuration: config, - } -} - -// NewWidgetsApiWithConfig creates an API instance using the provided configuration -func NewWidgetsApiWithConfig(config *Configuration) *WidgetsApi { - config.Debugf("Creating WidgetsApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &WidgetsApi{ - Configuration: config, - } -} - -// DeleteWidgetsDeployment invokes DELETE /api/v2/widgets/deployments/{deploymentId} -// -// Delete a Widget deployment -// -// -func (a WidgetsApi) DeleteWidgetsDeployment(deploymentId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/widgets/deployments/{deploymentId}" - path = strings.Replace(path, "{deploymentId}", fmt.Sprintf("%v", deploymentId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'deploymentId' is set - if &deploymentId == nil { - // - return nil, errors.New("Missing required parameter 'deploymentId' when calling WidgetsApi->DeleteWidgetsDeployment") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// GetWidgetsDeployment invokes GET /api/v2/widgets/deployments/{deploymentId} -// -// Get a Widget deployment -// -// -func (a WidgetsApi) GetWidgetsDeployment(deploymentId string) (*Widgetdeployment, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/widgets/deployments/{deploymentId}" - path = strings.Replace(path, "{deploymentId}", fmt.Sprintf("%v", deploymentId), -1) - defaultReturn := new(Widgetdeployment) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'deploymentId' is set - if &deploymentId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'deploymentId' when calling WidgetsApi->GetWidgetsDeployment") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Widgetdeployment - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWidgetsDeployments invokes GET /api/v2/widgets/deployments -// -// List Widget deployments -// -// -func (a WidgetsApi) GetWidgetsDeployments() (*Widgetdeploymententitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/widgets/deployments" - defaultReturn := new(Widgetdeploymententitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Widgetdeploymententitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostWidgetsDeployments invokes POST /api/v2/widgets/deployments -// -// Create Widget deployment -// -// -func (a WidgetsApi) PostWidgetsDeployments(body Widgetdeployment) (*Widgetdeployment, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/widgets/deployments" - defaultReturn := new(Widgetdeployment) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling WidgetsApi->PostWidgetsDeployments") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Widgetdeployment - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PutWidgetsDeployment invokes PUT /api/v2/widgets/deployments/{deploymentId} -// -// Update a Widget deployment -// -// -func (a WidgetsApi) PutWidgetsDeployment(deploymentId string, body Widgetdeployment) (*Widgetdeployment, *APIResponse, error) { - var httpMethod = "PUT" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/widgets/deployments/{deploymentId}" - path = strings.Replace(path, "{deploymentId}", fmt.Sprintf("%v", deploymentId), -1) - defaultReturn := new(Widgetdeployment) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'deploymentId' is set - if &deploymentId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'deploymentId' when calling WidgetsApi->PutWidgetsDeployment") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling WidgetsApi->PutWidgetsDeployment") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Widgetdeployment - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/workforcemanagementapi.go b/build/platformclientv2/workforcemanagementapi.go deleted file mode 100644 index a9c9785aa..000000000 --- a/build/platformclientv2/workforcemanagementapi.go +++ /dev/null @@ -1,8473 +0,0 @@ -package platformclientv2 - -import ( - "strings" - "fmt" - "errors" - "net/url" - "time" -"encoding/json" -) - -// WorkforceManagementApi provides functions for API endpoints -type WorkforceManagementApi struct { - Configuration *Configuration -} - -// NewWorkforceManagementApi creates an API instance using the default configuration -func NewWorkforceManagementApi() *WorkforceManagementApi { - config := GetDefaultConfiguration() - config.Debug(fmt.Sprintf("Creating WorkforceManagementApi with base path: %s", strings.ToLower(config.BasePath))) - return &WorkforceManagementApi{ - Configuration: config, - } -} - -// NewWorkforceManagementApiWithConfig creates an API instance using the provided configuration -func NewWorkforceManagementApiWithConfig(config *Configuration) *WorkforceManagementApi { - config.Debugf("Creating WorkforceManagementApi with base path: %s\n", strings.ToLower(config.BasePath)) - return &WorkforceManagementApi{ - Configuration: config, - } -} - -// DeleteWorkforcemanagementBusinessunit invokes DELETE /api/v2/workforcemanagement/businessunits/{businessUnitId} -// -// Delete business unit -// -// A business unit cannot be deleted if it contains one or more management units -func (a WorkforceManagementApi) DeleteWorkforcemanagementBusinessunit(businessUnitId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/businessunits/{businessUnitId}" - path = strings.Replace(path, "{businessUnitId}", fmt.Sprintf("%v", businessUnitId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'businessUnitId' is set - if &businessUnitId == nil { - // - return nil, errors.New("Missing required parameter 'businessUnitId' when calling WorkforceManagementApi->DeleteWorkforcemanagementBusinessunit") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteWorkforcemanagementBusinessunitActivitycode invokes DELETE /api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes/{activityCodeId} -// -// Deletes an activity code -// -// -func (a WorkforceManagementApi) DeleteWorkforcemanagementBusinessunitActivitycode(businessUnitId string, activityCodeId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes/{activityCodeId}" - path = strings.Replace(path, "{businessUnitId}", fmt.Sprintf("%v", businessUnitId), -1) - path = strings.Replace(path, "{activityCodeId}", fmt.Sprintf("%v", activityCodeId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'businessUnitId' is set - if &businessUnitId == nil { - // - return nil, errors.New("Missing required parameter 'businessUnitId' when calling WorkforceManagementApi->DeleteWorkforcemanagementBusinessunitActivitycode") - } - // verify the required parameter 'activityCodeId' is set - if &activityCodeId == nil { - // - return nil, errors.New("Missing required parameter 'activityCodeId' when calling WorkforceManagementApi->DeleteWorkforcemanagementBusinessunitActivitycode") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteWorkforcemanagementBusinessunitPlanninggroup invokes DELETE /api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups/{planningGroupId} -// -// Deletes the planning group -// -// -func (a WorkforceManagementApi) DeleteWorkforcemanagementBusinessunitPlanninggroup(businessUnitId string, planningGroupId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups/{planningGroupId}" - path = strings.Replace(path, "{businessUnitId}", fmt.Sprintf("%v", businessUnitId), -1) - path = strings.Replace(path, "{planningGroupId}", fmt.Sprintf("%v", planningGroupId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'businessUnitId' is set - if &businessUnitId == nil { - // - return nil, errors.New("Missing required parameter 'businessUnitId' when calling WorkforceManagementApi->DeleteWorkforcemanagementBusinessunitPlanninggroup") - } - // verify the required parameter 'planningGroupId' is set - if &planningGroupId == nil { - // - return nil, errors.New("Missing required parameter 'planningGroupId' when calling WorkforceManagementApi->DeleteWorkforcemanagementBusinessunitPlanninggroup") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteWorkforcemanagementBusinessunitSchedulingRun invokes DELETE /api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId} -// -// Cancel a scheduling run -// -// -func (a WorkforceManagementApi) DeleteWorkforcemanagementBusinessunitSchedulingRun(businessUnitId string, runId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId}" - path = strings.Replace(path, "{businessUnitId}", fmt.Sprintf("%v", businessUnitId), -1) - path = strings.Replace(path, "{runId}", fmt.Sprintf("%v", runId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'businessUnitId' is set - if &businessUnitId == nil { - // - return nil, errors.New("Missing required parameter 'businessUnitId' when calling WorkforceManagementApi->DeleteWorkforcemanagementBusinessunitSchedulingRun") - } - // verify the required parameter 'runId' is set - if &runId == nil { - // - return nil, errors.New("Missing required parameter 'runId' when calling WorkforceManagementApi->DeleteWorkforcemanagementBusinessunitSchedulingRun") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteWorkforcemanagementBusinessunitServicegoaltemplate invokes DELETE /api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId} -// -// Delete a service goal template -// -// -func (a WorkforceManagementApi) DeleteWorkforcemanagementBusinessunitServicegoaltemplate(businessUnitId string, serviceGoalTemplateId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId}" - path = strings.Replace(path, "{businessUnitId}", fmt.Sprintf("%v", businessUnitId), -1) - path = strings.Replace(path, "{serviceGoalTemplateId}", fmt.Sprintf("%v", serviceGoalTemplateId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'businessUnitId' is set - if &businessUnitId == nil { - // - return nil, errors.New("Missing required parameter 'businessUnitId' when calling WorkforceManagementApi->DeleteWorkforcemanagementBusinessunitServicegoaltemplate") - } - // verify the required parameter 'serviceGoalTemplateId' is set - if &serviceGoalTemplateId == nil { - // - return nil, errors.New("Missing required parameter 'serviceGoalTemplateId' when calling WorkforceManagementApi->DeleteWorkforcemanagementBusinessunitServicegoaltemplate") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteWorkforcemanagementBusinessunitWeekSchedule invokes DELETE /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId} -// -// Delete a schedule -// -// -func (a WorkforceManagementApi) DeleteWorkforcemanagementBusinessunitWeekSchedule(businessUnitId string, weekId time.Time, scheduleId string) (*Buasyncscheduleresponse, *APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}" - path = strings.Replace(path, "{businessUnitId}", fmt.Sprintf("%v", businessUnitId), -1) - path = strings.Replace(path, "{weekId}", fmt.Sprintf("%v", weekId), -1) - path = strings.Replace(path, "{scheduleId}", fmt.Sprintf("%v", scheduleId), -1) - defaultReturn := new(Buasyncscheduleresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'businessUnitId' is set - if &businessUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'businessUnitId' when calling WorkforceManagementApi->DeleteWorkforcemanagementBusinessunitWeekSchedule") - } - // verify the required parameter 'weekId' is set - if &weekId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'weekId' when calling WorkforceManagementApi->DeleteWorkforcemanagementBusinessunitWeekSchedule") - } - // verify the required parameter 'scheduleId' is set - if &scheduleId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'scheduleId' when calling WorkforceManagementApi->DeleteWorkforcemanagementBusinessunitWeekSchedule") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Buasyncscheduleresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// DeleteWorkforcemanagementBusinessunitWeekShorttermforecast invokes DELETE /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId} -// -// Delete a short term forecast -// -// Must not be tied to any schedules -func (a WorkforceManagementApi) DeleteWorkforcemanagementBusinessunitWeekShorttermforecast(businessUnitId string, weekDateId time.Time, forecastId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}" - path = strings.Replace(path, "{businessUnitId}", fmt.Sprintf("%v", businessUnitId), -1) - path = strings.Replace(path, "{weekDateId}", fmt.Sprintf("%v", weekDateId), -1) - path = strings.Replace(path, "{forecastId}", fmt.Sprintf("%v", forecastId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'businessUnitId' is set - if &businessUnitId == nil { - // - return nil, errors.New("Missing required parameter 'businessUnitId' when calling WorkforceManagementApi->DeleteWorkforcemanagementBusinessunitWeekShorttermforecast") - } - // verify the required parameter 'weekDateId' is set - if &weekDateId == nil { - // - return nil, errors.New("Missing required parameter 'weekDateId' when calling WorkforceManagementApi->DeleteWorkforcemanagementBusinessunitWeekShorttermforecast") - } - // verify the required parameter 'forecastId' is set - if &forecastId == nil { - // - return nil, errors.New("Missing required parameter 'forecastId' when calling WorkforceManagementApi->DeleteWorkforcemanagementBusinessunitWeekShorttermforecast") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteWorkforcemanagementManagementunit invokes DELETE /api/v2/workforcemanagement/managementunits/{managementUnitId} -// -// Delete management unit -// -// -func (a WorkforceManagementApi) DeleteWorkforcemanagementManagementunit(managementUnitId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/managementunits/{managementUnitId}" - path = strings.Replace(path, "{managementUnitId}", fmt.Sprintf("%v", managementUnitId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'managementUnitId' is set - if &managementUnitId == nil { - // - return nil, errors.New("Missing required parameter 'managementUnitId' when calling WorkforceManagementApi->DeleteWorkforcemanagementManagementunit") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteWorkforcemanagementManagementunitWorkplan invokes DELETE /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId} -// -// Delete a work plan -// -// -func (a WorkforceManagementApi) DeleteWorkforcemanagementManagementunitWorkplan(managementUnitId string, workPlanId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}" - path = strings.Replace(path, "{managementUnitId}", fmt.Sprintf("%v", managementUnitId), -1) - path = strings.Replace(path, "{workPlanId}", fmt.Sprintf("%v", workPlanId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'managementUnitId' is set - if &managementUnitId == nil { - // - return nil, errors.New("Missing required parameter 'managementUnitId' when calling WorkforceManagementApi->DeleteWorkforcemanagementManagementunitWorkplan") - } - // verify the required parameter 'workPlanId' is set - if &workPlanId == nil { - // - return nil, errors.New("Missing required parameter 'workPlanId' when calling WorkforceManagementApi->DeleteWorkforcemanagementManagementunitWorkplan") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// DeleteWorkforcemanagementManagementunitWorkplanrotation invokes DELETE /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId} -// -// Delete a work plan rotation -// -// -func (a WorkforceManagementApi) DeleteWorkforcemanagementManagementunitWorkplanrotation(managementUnitId string, workPlanRotationId string) (*APIResponse, error) { - var httpMethod = "DELETE" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}" - path = strings.Replace(path, "{managementUnitId}", fmt.Sprintf("%v", managementUnitId), -1) - path = strings.Replace(path, "{workPlanRotationId}", fmt.Sprintf("%v", workPlanRotationId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'managementUnitId' is set - if &managementUnitId == nil { - // - return nil, errors.New("Missing required parameter 'managementUnitId' when calling WorkforceManagementApi->DeleteWorkforcemanagementManagementunitWorkplanrotation") - } - // verify the required parameter 'workPlanRotationId' is set - if &workPlanRotationId == nil { - // - return nil, errors.New("Missing required parameter 'workPlanRotationId' when calling WorkforceManagementApi->DeleteWorkforcemanagementManagementunitWorkplanrotation") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// GetWorkforcemanagementAdherence invokes GET /api/v2/workforcemanagement/adherence -// -// Get a list of UserScheduleAdherence records for the requested users -// -// -func (a WorkforceManagementApi) GetWorkforcemanagementAdherence(userId []string) ([]Userscheduleadherence, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/adherence" - defaultReturn := make([]Userscheduleadherence, 0) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'userId' is set - if &userId == nil { - // true - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling WorkforceManagementApi->GetWorkforcemanagementAdherence") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range userId { - queryParams["userId"] = value - } - } else { - queryParams["userId"] = a.Configuration.APIClient.ParameterToString(userId, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload []Userscheduleadherence - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWorkforcemanagementAdhocmodelingjob invokes GET /api/v2/workforcemanagement/adhocmodelingjobs/{jobId} -// -// Get status of the modeling job -// -// -func (a WorkforceManagementApi) GetWorkforcemanagementAdhocmodelingjob(jobId string) (*Modelingstatusresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/adhocmodelingjobs/{jobId}" - path = strings.Replace(path, "{jobId}", fmt.Sprintf("%v", jobId), -1) - defaultReturn := new(Modelingstatusresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'jobId' is set - if &jobId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'jobId' when calling WorkforceManagementApi->GetWorkforcemanagementAdhocmodelingjob") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Modelingstatusresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWorkforcemanagementBusinessunit invokes GET /api/v2/workforcemanagement/businessunits/{businessUnitId} -// -// Get business unit -// -// Expanding \"settings\" will retrieve all settings. All other expands will retrieve only the requested settings field(s). -func (a WorkforceManagementApi) GetWorkforcemanagementBusinessunit(businessUnitId string, expand []string) (*Businessunit, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/businessunits/{businessUnitId}" - path = strings.Replace(path, "{businessUnitId}", fmt.Sprintf("%v", businessUnitId), -1) - defaultReturn := new(Businessunit) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'businessUnitId' is set - if &businessUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'businessUnitId' when calling WorkforceManagementApi->GetWorkforcemanagementBusinessunit") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Businessunit - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWorkforcemanagementBusinessunitActivitycode invokes GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes/{activityCodeId} -// -// Get an activity code -// -// -func (a WorkforceManagementApi) GetWorkforcemanagementBusinessunitActivitycode(businessUnitId string, activityCodeId string) (*Businessunitactivitycode, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes/{activityCodeId}" - path = strings.Replace(path, "{businessUnitId}", fmt.Sprintf("%v", businessUnitId), -1) - path = strings.Replace(path, "{activityCodeId}", fmt.Sprintf("%v", activityCodeId), -1) - defaultReturn := new(Businessunitactivitycode) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'businessUnitId' is set - if &businessUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'businessUnitId' when calling WorkforceManagementApi->GetWorkforcemanagementBusinessunitActivitycode") - } - // verify the required parameter 'activityCodeId' is set - if &activityCodeId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'activityCodeId' when calling WorkforceManagementApi->GetWorkforcemanagementBusinessunitActivitycode") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Businessunitactivitycode - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWorkforcemanagementBusinessunitActivitycodes invokes GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes -// -// Get activity codes -// -// -func (a WorkforceManagementApi) GetWorkforcemanagementBusinessunitActivitycodes(businessUnitId string) (*Businessunitactivitycodelisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes" - path = strings.Replace(path, "{businessUnitId}", fmt.Sprintf("%v", businessUnitId), -1) - defaultReturn := new(Businessunitactivitycodelisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'businessUnitId' is set - if &businessUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'businessUnitId' when calling WorkforceManagementApi->GetWorkforcemanagementBusinessunitActivitycodes") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Businessunitactivitycodelisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWorkforcemanagementBusinessunitIntradayPlanninggroups invokes GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/intraday/planninggroups -// -// Get intraday planning groups for the given date -// -// -func (a WorkforceManagementApi) GetWorkforcemanagementBusinessunitIntradayPlanninggroups(businessUnitId string, date time.Time) (*Wfmintradayplanninggrouplisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/businessunits/{businessUnitId}/intraday/planninggroups" - path = strings.Replace(path, "{businessUnitId}", fmt.Sprintf("%v", businessUnitId), -1) - defaultReturn := new(Wfmintradayplanninggrouplisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'businessUnitId' is set - if &businessUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'businessUnitId' when calling WorkforceManagementApi->GetWorkforcemanagementBusinessunitIntradayPlanninggroups") - } - // verify the required parameter 'date' is set - if &date == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'date' when calling WorkforceManagementApi->GetWorkforcemanagementBusinessunitIntradayPlanninggroups") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(date).(string); ok { - if str != "" { - queryParams["date"] = a.Configuration.APIClient.ParameterToString(date, collectionFormat) - } - } else { - queryParams["date"] = a.Configuration.APIClient.ParameterToString(date, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Wfmintradayplanninggrouplisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWorkforcemanagementBusinessunitManagementunits invokes GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/managementunits -// -// Get all authorized management units in the business unit -// -// -func (a WorkforceManagementApi) GetWorkforcemanagementBusinessunitManagementunits(businessUnitId string, feature string, divisionId string) (*Managementunitlisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/businessunits/{businessUnitId}/managementunits" - path = strings.Replace(path, "{businessUnitId}", fmt.Sprintf("%v", businessUnitId), -1) - defaultReturn := new(Managementunitlisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'businessUnitId' is set - if &businessUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'businessUnitId' when calling WorkforceManagementApi->GetWorkforcemanagementBusinessunitManagementunits") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(feature).(string); ok { - if str != "" { - queryParams["feature"] = a.Configuration.APIClient.ParameterToString(feature, collectionFormat) - } - } else { - queryParams["feature"] = a.Configuration.APIClient.ParameterToString(feature, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(divisionId).(string); ok { - if str != "" { - queryParams["divisionId"] = a.Configuration.APIClient.ParameterToString(divisionId, collectionFormat) - } - } else { - queryParams["divisionId"] = a.Configuration.APIClient.ParameterToString(divisionId, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Managementunitlisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWorkforcemanagementBusinessunitPlanninggroup invokes GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups/{planningGroupId} -// -// Get a planning group -// -// -func (a WorkforceManagementApi) GetWorkforcemanagementBusinessunitPlanninggroup(businessUnitId string, planningGroupId string) (*Planninggroup, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups/{planningGroupId}" - path = strings.Replace(path, "{businessUnitId}", fmt.Sprintf("%v", businessUnitId), -1) - path = strings.Replace(path, "{planningGroupId}", fmt.Sprintf("%v", planningGroupId), -1) - defaultReturn := new(Planninggroup) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'businessUnitId' is set - if &businessUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'businessUnitId' when calling WorkforceManagementApi->GetWorkforcemanagementBusinessunitPlanninggroup") - } - // verify the required parameter 'planningGroupId' is set - if &planningGroupId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'planningGroupId' when calling WorkforceManagementApi->GetWorkforcemanagementBusinessunitPlanninggroup") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Planninggroup - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWorkforcemanagementBusinessunitPlanninggroups invokes GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups -// -// Gets list of planning groups -// -// -func (a WorkforceManagementApi) GetWorkforcemanagementBusinessunitPlanninggroups(businessUnitId string) (*Planninggrouplist, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups" - path = strings.Replace(path, "{businessUnitId}", fmt.Sprintf("%v", businessUnitId), -1) - defaultReturn := new(Planninggrouplist) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'businessUnitId' is set - if &businessUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'businessUnitId' when calling WorkforceManagementApi->GetWorkforcemanagementBusinessunitPlanninggroups") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Planninggrouplist - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWorkforcemanagementBusinessunitSchedulingRun invokes GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId} -// -// Get a scheduling run -// -// -func (a WorkforceManagementApi) GetWorkforcemanagementBusinessunitSchedulingRun(businessUnitId string, runId string) (*Buschedulerun, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId}" - path = strings.Replace(path, "{businessUnitId}", fmt.Sprintf("%v", businessUnitId), -1) - path = strings.Replace(path, "{runId}", fmt.Sprintf("%v", runId), -1) - defaultReturn := new(Buschedulerun) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'businessUnitId' is set - if &businessUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'businessUnitId' when calling WorkforceManagementApi->GetWorkforcemanagementBusinessunitSchedulingRun") - } - // verify the required parameter 'runId' is set - if &runId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'runId' when calling WorkforceManagementApi->GetWorkforcemanagementBusinessunitSchedulingRun") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Buschedulerun - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWorkforcemanagementBusinessunitSchedulingRunResult invokes GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId}/result -// -// Get the result of a rescheduling operation -// -// -func (a WorkforceManagementApi) GetWorkforcemanagementBusinessunitSchedulingRunResult(businessUnitId string, runId string, managementUnitIds []string, expand []string) (*Burescheduleresult, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId}/result" - path = strings.Replace(path, "{businessUnitId}", fmt.Sprintf("%v", businessUnitId), -1) - path = strings.Replace(path, "{runId}", fmt.Sprintf("%v", runId), -1) - defaultReturn := new(Burescheduleresult) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'businessUnitId' is set - if &businessUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'businessUnitId' when calling WorkforceManagementApi->GetWorkforcemanagementBusinessunitSchedulingRunResult") - } - // verify the required parameter 'runId' is set - if &runId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'runId' when calling WorkforceManagementApi->GetWorkforcemanagementBusinessunitSchedulingRunResult") - } - // verify the required parameter 'managementUnitIds' is set - if &managementUnitIds == nil { - // true - return defaultReturn, nil, errors.New("Missing required parameter 'managementUnitIds' when calling WorkforceManagementApi->GetWorkforcemanagementBusinessunitSchedulingRunResult") - } - // verify the required parameter 'expand' is set - if &expand == nil { - // true - return defaultReturn, nil, errors.New("Missing required parameter 'expand' when calling WorkforceManagementApi->GetWorkforcemanagementBusinessunitSchedulingRunResult") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range managementUnitIds { - queryParams["managementUnitIds"] = value - } - } else { - queryParams["managementUnitIds"] = a.Configuration.APIClient.ParameterToString(managementUnitIds, collectionFormat) - } - - - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Burescheduleresult - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWorkforcemanagementBusinessunitSchedulingRuns invokes GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs -// -// Get the list of scheduling runs -// -// -func (a WorkforceManagementApi) GetWorkforcemanagementBusinessunitSchedulingRuns(businessUnitId string) (*Buschedulerunlisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs" - path = strings.Replace(path, "{businessUnitId}", fmt.Sprintf("%v", businessUnitId), -1) - defaultReturn := new(Buschedulerunlisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'businessUnitId' is set - if &businessUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'businessUnitId' when calling WorkforceManagementApi->GetWorkforcemanagementBusinessunitSchedulingRuns") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Buschedulerunlisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWorkforcemanagementBusinessunitServicegoaltemplate invokes GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId} -// -// Get a service goal template -// -// -func (a WorkforceManagementApi) GetWorkforcemanagementBusinessunitServicegoaltemplate(businessUnitId string, serviceGoalTemplateId string) (*Servicegoaltemplate, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId}" - path = strings.Replace(path, "{businessUnitId}", fmt.Sprintf("%v", businessUnitId), -1) - path = strings.Replace(path, "{serviceGoalTemplateId}", fmt.Sprintf("%v", serviceGoalTemplateId), -1) - defaultReturn := new(Servicegoaltemplate) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'businessUnitId' is set - if &businessUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'businessUnitId' when calling WorkforceManagementApi->GetWorkforcemanagementBusinessunitServicegoaltemplate") - } - // verify the required parameter 'serviceGoalTemplateId' is set - if &serviceGoalTemplateId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'serviceGoalTemplateId' when calling WorkforceManagementApi->GetWorkforcemanagementBusinessunitServicegoaltemplate") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Servicegoaltemplate - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWorkforcemanagementBusinessunitServicegoaltemplates invokes GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates -// -// Gets list of service goal templates -// -// -func (a WorkforceManagementApi) GetWorkforcemanagementBusinessunitServicegoaltemplates(businessUnitId string) (*Servicegoaltemplatelist, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates" - path = strings.Replace(path, "{businessUnitId}", fmt.Sprintf("%v", businessUnitId), -1) - defaultReturn := new(Servicegoaltemplatelist) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'businessUnitId' is set - if &businessUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'businessUnitId' when calling WorkforceManagementApi->GetWorkforcemanagementBusinessunitServicegoaltemplates") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Servicegoaltemplatelist - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWorkforcemanagementBusinessunitWeekSchedule invokes GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId} -// -// Get the metadata for the schedule, describing which management units and agents are in the scheduleSchedule data can then be loaded with the query route -// -// -func (a WorkforceManagementApi) GetWorkforcemanagementBusinessunitWeekSchedule(businessUnitId string, weekId time.Time, scheduleId string, expand string) (*Buschedulemetadata, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}" - path = strings.Replace(path, "{businessUnitId}", fmt.Sprintf("%v", businessUnitId), -1) - path = strings.Replace(path, "{weekId}", fmt.Sprintf("%v", weekId), -1) - path = strings.Replace(path, "{scheduleId}", fmt.Sprintf("%v", scheduleId), -1) - defaultReturn := new(Buschedulemetadata) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'businessUnitId' is set - if &businessUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'businessUnitId' when calling WorkforceManagementApi->GetWorkforcemanagementBusinessunitWeekSchedule") - } - // verify the required parameter 'weekId' is set - if &weekId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'weekId' when calling WorkforceManagementApi->GetWorkforcemanagementBusinessunitWeekSchedule") - } - // verify the required parameter 'scheduleId' is set - if &scheduleId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'scheduleId' when calling WorkforceManagementApi->GetWorkforcemanagementBusinessunitWeekSchedule") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(expand).(string); ok { - if str != "" { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Buschedulemetadata - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWorkforcemanagementBusinessunitWeekScheduleGenerationresults invokes GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/generationresults -// -// Get the generation results for a generated schedule -// -// -func (a WorkforceManagementApi) GetWorkforcemanagementBusinessunitWeekScheduleGenerationresults(businessUnitId string, weekId time.Time, scheduleId string) (*Schedulegenerationresult, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/generationresults" - path = strings.Replace(path, "{businessUnitId}", fmt.Sprintf("%v", businessUnitId), -1) - path = strings.Replace(path, "{weekId}", fmt.Sprintf("%v", weekId), -1) - path = strings.Replace(path, "{scheduleId}", fmt.Sprintf("%v", scheduleId), -1) - defaultReturn := new(Schedulegenerationresult) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'businessUnitId' is set - if &businessUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'businessUnitId' when calling WorkforceManagementApi->GetWorkforcemanagementBusinessunitWeekScheduleGenerationresults") - } - // verify the required parameter 'weekId' is set - if &weekId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'weekId' when calling WorkforceManagementApi->GetWorkforcemanagementBusinessunitWeekScheduleGenerationresults") - } - // verify the required parameter 'scheduleId' is set - if &scheduleId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'scheduleId' when calling WorkforceManagementApi->GetWorkforcemanagementBusinessunitWeekScheduleGenerationresults") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Schedulegenerationresult - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWorkforcemanagementBusinessunitWeekScheduleHeadcountforecast invokes GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/headcountforecast -// -// Get the headcount forecast by planning group for the schedule -// -// -func (a WorkforceManagementApi) GetWorkforcemanagementBusinessunitWeekScheduleHeadcountforecast(businessUnitId string, weekId time.Time, scheduleId string, forceDownload bool) (*Buheadcountforecastresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/headcountforecast" - path = strings.Replace(path, "{businessUnitId}", fmt.Sprintf("%v", businessUnitId), -1) - path = strings.Replace(path, "{weekId}", fmt.Sprintf("%v", weekId), -1) - path = strings.Replace(path, "{scheduleId}", fmt.Sprintf("%v", scheduleId), -1) - defaultReturn := new(Buheadcountforecastresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'businessUnitId' is set - if &businessUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'businessUnitId' when calling WorkforceManagementApi->GetWorkforcemanagementBusinessunitWeekScheduleHeadcountforecast") - } - // verify the required parameter 'weekId' is set - if &weekId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'weekId' when calling WorkforceManagementApi->GetWorkforcemanagementBusinessunitWeekScheduleHeadcountforecast") - } - // verify the required parameter 'scheduleId' is set - if &scheduleId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'scheduleId' when calling WorkforceManagementApi->GetWorkforcemanagementBusinessunitWeekScheduleHeadcountforecast") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(forceDownload).(string); ok { - if str != "" { - queryParams["forceDownload"] = a.Configuration.APIClient.ParameterToString(forceDownload, collectionFormat) - } - } else { - queryParams["forceDownload"] = a.Configuration.APIClient.ParameterToString(forceDownload, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Buheadcountforecastresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWorkforcemanagementBusinessunitWeekScheduleHistoryAgent invokes GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/history/agents/{agentId} -// -// Loads agent's schedule history. -// -// -func (a WorkforceManagementApi) GetWorkforcemanagementBusinessunitWeekScheduleHistoryAgent(businessUnitId string, weekId time.Time, scheduleId string, agentId string) (*Buagentschedulehistoryresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/history/agents/{agentId}" - path = strings.Replace(path, "{businessUnitId}", fmt.Sprintf("%v", businessUnitId), -1) - path = strings.Replace(path, "{weekId}", fmt.Sprintf("%v", weekId), -1) - path = strings.Replace(path, "{scheduleId}", fmt.Sprintf("%v", scheduleId), -1) - path = strings.Replace(path, "{agentId}", fmt.Sprintf("%v", agentId), -1) - defaultReturn := new(Buagentschedulehistoryresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'businessUnitId' is set - if &businessUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'businessUnitId' when calling WorkforceManagementApi->GetWorkforcemanagementBusinessunitWeekScheduleHistoryAgent") - } - // verify the required parameter 'weekId' is set - if &weekId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'weekId' when calling WorkforceManagementApi->GetWorkforcemanagementBusinessunitWeekScheduleHistoryAgent") - } - // verify the required parameter 'scheduleId' is set - if &scheduleId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'scheduleId' when calling WorkforceManagementApi->GetWorkforcemanagementBusinessunitWeekScheduleHistoryAgent") - } - // verify the required parameter 'agentId' is set - if &agentId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'agentId' when calling WorkforceManagementApi->GetWorkforcemanagementBusinessunitWeekScheduleHistoryAgent") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Buagentschedulehistoryresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWorkforcemanagementBusinessunitWeekSchedules invokes GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules -// -// Get the list of week schedules for the specified week -// -// Use \"recent\" for the `weekId` path parameter to fetch all forecasts for +/- 26 weeks from the current date. Response will include any schedule which spans the specified week -func (a WorkforceManagementApi) GetWorkforcemanagementBusinessunitWeekSchedules(businessUnitId string, weekId string, includeOnlyPublished bool, expand string) (*Buschedulelisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules" - path = strings.Replace(path, "{businessUnitId}", fmt.Sprintf("%v", businessUnitId), -1) - path = strings.Replace(path, "{weekId}", fmt.Sprintf("%v", weekId), -1) - defaultReturn := new(Buschedulelisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'businessUnitId' is set - if &businessUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'businessUnitId' when calling WorkforceManagementApi->GetWorkforcemanagementBusinessunitWeekSchedules") - } - // verify the required parameter 'weekId' is set - if &weekId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'weekId' when calling WorkforceManagementApi->GetWorkforcemanagementBusinessunitWeekSchedules") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(includeOnlyPublished).(string); ok { - if str != "" { - queryParams["includeOnlyPublished"] = a.Configuration.APIClient.ParameterToString(includeOnlyPublished, collectionFormat) - } - } else { - queryParams["includeOnlyPublished"] = a.Configuration.APIClient.ParameterToString(includeOnlyPublished, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(expand).(string); ok { - if str != "" { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Buschedulelisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWorkforcemanagementBusinessunitWeekShorttermforecast invokes GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId} -// -// Get a short term forecast -// -// -func (a WorkforceManagementApi) GetWorkforcemanagementBusinessunitWeekShorttermforecast(businessUnitId string, weekDateId time.Time, forecastId string, expand []string) (*Bushorttermforecast, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}" - path = strings.Replace(path, "{businessUnitId}", fmt.Sprintf("%v", businessUnitId), -1) - path = strings.Replace(path, "{weekDateId}", fmt.Sprintf("%v", weekDateId), -1) - path = strings.Replace(path, "{forecastId}", fmt.Sprintf("%v", forecastId), -1) - defaultReturn := new(Bushorttermforecast) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'businessUnitId' is set - if &businessUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'businessUnitId' when calling WorkforceManagementApi->GetWorkforcemanagementBusinessunitWeekShorttermforecast") - } - // verify the required parameter 'weekDateId' is set - if &weekDateId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'weekDateId' when calling WorkforceManagementApi->GetWorkforcemanagementBusinessunitWeekShorttermforecast") - } - // verify the required parameter 'forecastId' is set - if &forecastId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'forecastId' when calling WorkforceManagementApi->GetWorkforcemanagementBusinessunitWeekShorttermforecast") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Bushorttermforecast - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWorkforcemanagementBusinessunitWeekShorttermforecastData invokes GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/data -// -// Get the result of a short term forecast calculation -// -// Includes modifications unless you pass the doNotApplyModifications query parameter -func (a WorkforceManagementApi) GetWorkforcemanagementBusinessunitWeekShorttermforecastData(businessUnitId string, weekDateId time.Time, forecastId string, weekNumber int, forceDownloadService bool) (*Buforecastresultresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/data" - path = strings.Replace(path, "{businessUnitId}", fmt.Sprintf("%v", businessUnitId), -1) - path = strings.Replace(path, "{weekDateId}", fmt.Sprintf("%v", weekDateId), -1) - path = strings.Replace(path, "{forecastId}", fmt.Sprintf("%v", forecastId), -1) - defaultReturn := new(Buforecastresultresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'businessUnitId' is set - if &businessUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'businessUnitId' when calling WorkforceManagementApi->GetWorkforcemanagementBusinessunitWeekShorttermforecastData") - } - // verify the required parameter 'weekDateId' is set - if &weekDateId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'weekDateId' when calling WorkforceManagementApi->GetWorkforcemanagementBusinessunitWeekShorttermforecastData") - } - // verify the required parameter 'forecastId' is set - if &forecastId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'forecastId' when calling WorkforceManagementApi->GetWorkforcemanagementBusinessunitWeekShorttermforecastData") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(weekNumber).(string); ok { - if str != "" { - queryParams["weekNumber"] = a.Configuration.APIClient.ParameterToString(weekNumber, collectionFormat) - } - } else { - queryParams["weekNumber"] = a.Configuration.APIClient.ParameterToString(weekNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(forceDownloadService).(string); ok { - if str != "" { - queryParams["forceDownloadService"] = a.Configuration.APIClient.ParameterToString(forceDownloadService, collectionFormat) - } - } else { - queryParams["forceDownloadService"] = a.Configuration.APIClient.ParameterToString(forceDownloadService, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Buforecastresultresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWorkforcemanagementBusinessunitWeekShorttermforecastGenerationresults invokes GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/generationresults -// -// Gets the forecast generation results -// -// -func (a WorkforceManagementApi) GetWorkforcemanagementBusinessunitWeekShorttermforecastGenerationresults(businessUnitId string, weekDateId time.Time, forecastId string) (*Buforecastgenerationresult, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/generationresults" - path = strings.Replace(path, "{businessUnitId}", fmt.Sprintf("%v", businessUnitId), -1) - path = strings.Replace(path, "{weekDateId}", fmt.Sprintf("%v", weekDateId), -1) - path = strings.Replace(path, "{forecastId}", fmt.Sprintf("%v", forecastId), -1) - defaultReturn := new(Buforecastgenerationresult) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'businessUnitId' is set - if &businessUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'businessUnitId' when calling WorkforceManagementApi->GetWorkforcemanagementBusinessunitWeekShorttermforecastGenerationresults") - } - // verify the required parameter 'weekDateId' is set - if &weekDateId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'weekDateId' when calling WorkforceManagementApi->GetWorkforcemanagementBusinessunitWeekShorttermforecastGenerationresults") - } - // verify the required parameter 'forecastId' is set - if &forecastId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'forecastId' when calling WorkforceManagementApi->GetWorkforcemanagementBusinessunitWeekShorttermforecastGenerationresults") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Buforecastgenerationresult - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroups invokes GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/planninggroups -// -// Gets the forecast planning group snapshot -// -// -func (a WorkforceManagementApi) GetWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroups(businessUnitId string, weekDateId time.Time, forecastId string) (*Forecastplanninggroupsresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/planninggroups" - path = strings.Replace(path, "{businessUnitId}", fmt.Sprintf("%v", businessUnitId), -1) - path = strings.Replace(path, "{weekDateId}", fmt.Sprintf("%v", weekDateId), -1) - path = strings.Replace(path, "{forecastId}", fmt.Sprintf("%v", forecastId), -1) - defaultReturn := new(Forecastplanninggroupsresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'businessUnitId' is set - if &businessUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'businessUnitId' when calling WorkforceManagementApi->GetWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroups") - } - // verify the required parameter 'weekDateId' is set - if &weekDateId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'weekDateId' when calling WorkforceManagementApi->GetWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroups") - } - // verify the required parameter 'forecastId' is set - if &forecastId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'forecastId' when calling WorkforceManagementApi->GetWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroups") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Forecastplanninggroupsresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWorkforcemanagementBusinessunitWeekShorttermforecasts invokes GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts -// -// Get short term forecasts -// -// Use \"recent\" for the `weekDateId` path parameter to fetch all forecasts for +/- 26 weeks from the current date. Response will include any forecast which spans the specified week -func (a WorkforceManagementApi) GetWorkforcemanagementBusinessunitWeekShorttermforecasts(businessUnitId string, weekDateId string) (*Bushorttermforecastlisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts" - path = strings.Replace(path, "{businessUnitId}", fmt.Sprintf("%v", businessUnitId), -1) - path = strings.Replace(path, "{weekDateId}", fmt.Sprintf("%v", weekDateId), -1) - defaultReturn := new(Bushorttermforecastlisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'businessUnitId' is set - if &businessUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'businessUnitId' when calling WorkforceManagementApi->GetWorkforcemanagementBusinessunitWeekShorttermforecasts") - } - // verify the required parameter 'weekDateId' is set - if &weekDateId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'weekDateId' when calling WorkforceManagementApi->GetWorkforcemanagementBusinessunitWeekShorttermforecasts") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Bushorttermforecastlisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWorkforcemanagementBusinessunits invokes GET /api/v2/workforcemanagement/businessunits -// -// Get business units -// -// -func (a WorkforceManagementApi) GetWorkforcemanagementBusinessunits(feature string, divisionId string) (*Businessunitlisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/businessunits" - defaultReturn := new(Businessunitlisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(feature).(string); ok { - if str != "" { - queryParams["feature"] = a.Configuration.APIClient.ParameterToString(feature, collectionFormat) - } - } else { - queryParams["feature"] = a.Configuration.APIClient.ParameterToString(feature, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(divisionId).(string); ok { - if str != "" { - queryParams["divisionId"] = a.Configuration.APIClient.ParameterToString(divisionId, collectionFormat) - } - } else { - queryParams["divisionId"] = a.Configuration.APIClient.ParameterToString(divisionId, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Businessunitlisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWorkforcemanagementBusinessunitsDivisionviews invokes GET /api/v2/workforcemanagement/businessunits/divisionviews -// -// Get business units across divisions -// -// -func (a WorkforceManagementApi) GetWorkforcemanagementBusinessunitsDivisionviews(divisionId []string) (*Businessunitlisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/businessunits/divisionviews" - defaultReturn := new(Businessunitlisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range divisionId { - queryParams["divisionId"] = value - } - } else { - queryParams["divisionId"] = a.Configuration.APIClient.ParameterToString(divisionId, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Businessunitlisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWorkforcemanagementManagementunit invokes GET /api/v2/workforcemanagement/managementunits/{managementUnitId} -// -// Get management unit -// -// -func (a WorkforceManagementApi) GetWorkforcemanagementManagementunit(managementUnitId string, expand []string) (*Managementunit, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/managementunits/{managementUnitId}" - path = strings.Replace(path, "{managementUnitId}", fmt.Sprintf("%v", managementUnitId), -1) - defaultReturn := new(Managementunit) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'managementUnitId' is set - if &managementUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'managementUnitId' when calling WorkforceManagementApi->GetWorkforcemanagementManagementunit") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Managementunit - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWorkforcemanagementManagementunitActivitycodes invokes GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/activitycodes -// -// Get activity codes -// -// -func (a WorkforceManagementApi) GetWorkforcemanagementManagementunitActivitycodes(managementUnitId string) (*Activitycodecontainer, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/managementunits/{managementUnitId}/activitycodes" - path = strings.Replace(path, "{managementUnitId}", fmt.Sprintf("%v", managementUnitId), -1) - defaultReturn := new(Activitycodecontainer) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'managementUnitId' is set - if &managementUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'managementUnitId' when calling WorkforceManagementApi->GetWorkforcemanagementManagementunitActivitycodes") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Activitycodecontainer - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWorkforcemanagementManagementunitAdherence invokes GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/adherence -// -// Get a list of user schedule adherence records for the requested management unit -// -// -func (a WorkforceManagementApi) GetWorkforcemanagementManagementunitAdherence(managementUnitId string, forceDownloadService bool) (*Userscheduleadherencelisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/managementunits/{managementUnitId}/adherence" - path = strings.Replace(path, "{managementUnitId}", fmt.Sprintf("%v", managementUnitId), -1) - defaultReturn := new(Userscheduleadherencelisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'managementUnitId' is set - if &managementUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'managementUnitId' when calling WorkforceManagementApi->GetWorkforcemanagementManagementunitAdherence") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(forceDownloadService).(string); ok { - if str != "" { - queryParams["forceDownloadService"] = a.Configuration.APIClient.ParameterToString(forceDownloadService, collectionFormat) - } - } else { - queryParams["forceDownloadService"] = a.Configuration.APIClient.ParameterToString(forceDownloadService, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Userscheduleadherencelisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWorkforcemanagementManagementunitAgent invokes GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/{agentId} -// -// Get data for agent in the management unit -// -// -func (a WorkforceManagementApi) GetWorkforcemanagementManagementunitAgent(managementUnitId string, agentId string, excludeCapabilities bool) (*Wfmagent, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/{agentId}" - path = strings.Replace(path, "{managementUnitId}", fmt.Sprintf("%v", managementUnitId), -1) - path = strings.Replace(path, "{agentId}", fmt.Sprintf("%v", agentId), -1) - defaultReturn := new(Wfmagent) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'managementUnitId' is set - if &managementUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'managementUnitId' when calling WorkforceManagementApi->GetWorkforcemanagementManagementunitAgent") - } - // verify the required parameter 'agentId' is set - if &agentId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'agentId' when calling WorkforceManagementApi->GetWorkforcemanagementManagementunitAgent") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(excludeCapabilities).(string); ok { - if str != "" { - queryParams["excludeCapabilities"] = a.Configuration.APIClient.ParameterToString(excludeCapabilities, collectionFormat) - } - } else { - queryParams["excludeCapabilities"] = a.Configuration.APIClient.ParameterToString(excludeCapabilities, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Wfmagent - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWorkforcemanagementManagementunitAgentShifttrades invokes GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/{agentId}/shifttrades -// -// Gets all the shift trades for a given agent -// -// -func (a WorkforceManagementApi) GetWorkforcemanagementManagementunitAgentShifttrades(managementUnitId string, agentId string) (*Shifttradelistresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/{agentId}/shifttrades" - path = strings.Replace(path, "{managementUnitId}", fmt.Sprintf("%v", managementUnitId), -1) - path = strings.Replace(path, "{agentId}", fmt.Sprintf("%v", agentId), -1) - defaultReturn := new(Shifttradelistresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'managementUnitId' is set - if &managementUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'managementUnitId' when calling WorkforceManagementApi->GetWorkforcemanagementManagementunitAgentShifttrades") - } - // verify the required parameter 'agentId' is set - if &agentId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'agentId' when calling WorkforceManagementApi->GetWorkforcemanagementManagementunitAgentShifttrades") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Shifttradelistresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWorkforcemanagementManagementunitShifttradesMatched invokes GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/shifttrades/matched -// -// Gets a summary of all shift trades in the matched state -// -// -func (a WorkforceManagementApi) GetWorkforcemanagementManagementunitShifttradesMatched(managementUnitId string) (*Shifttradematchessummaryresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/managementunits/{managementUnitId}/shifttrades/matched" - path = strings.Replace(path, "{managementUnitId}", fmt.Sprintf("%v", managementUnitId), -1) - defaultReturn := new(Shifttradematchessummaryresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'managementUnitId' is set - if &managementUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'managementUnitId' when calling WorkforceManagementApi->GetWorkforcemanagementManagementunitShifttradesMatched") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Shifttradematchessummaryresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWorkforcemanagementManagementunitShifttradesUsers invokes GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/shifttrades/users -// -// Gets list of users available for whom you can send direct shift trade requests -// -// -func (a WorkforceManagementApi) GetWorkforcemanagementManagementunitShifttradesUsers(managementUnitId string) (*Wfmuserentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/managementunits/{managementUnitId}/shifttrades/users" - path = strings.Replace(path, "{managementUnitId}", fmt.Sprintf("%v", managementUnitId), -1) - defaultReturn := new(Wfmuserentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'managementUnitId' is set - if &managementUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'managementUnitId' when calling WorkforceManagementApi->GetWorkforcemanagementManagementunitShifttradesUsers") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Wfmuserentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWorkforcemanagementManagementunitUserTimeoffrequest invokes GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId} -// -// Get a time off request -// -// -func (a WorkforceManagementApi) GetWorkforcemanagementManagementunitUserTimeoffrequest(managementUnitId string, userId string, timeOffRequestId string) (*Timeoffrequestresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}" - path = strings.Replace(path, "{managementUnitId}", fmt.Sprintf("%v", managementUnitId), -1) - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - path = strings.Replace(path, "{timeOffRequestId}", fmt.Sprintf("%v", timeOffRequestId), -1) - defaultReturn := new(Timeoffrequestresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'managementUnitId' is set - if &managementUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'managementUnitId' when calling WorkforceManagementApi->GetWorkforcemanagementManagementunitUserTimeoffrequest") - } - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling WorkforceManagementApi->GetWorkforcemanagementManagementunitUserTimeoffrequest") - } - // verify the required parameter 'timeOffRequestId' is set - if &timeOffRequestId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'timeOffRequestId' when calling WorkforceManagementApi->GetWorkforcemanagementManagementunitUserTimeoffrequest") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Timeoffrequestresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWorkforcemanagementManagementunitUserTimeoffrequests invokes GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests -// -// Get a list of time off requests for a given user -// -// -func (a WorkforceManagementApi) GetWorkforcemanagementManagementunitUserTimeoffrequests(managementUnitId string, userId string, recentlyReviewed bool) (*Timeoffrequestlist, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests" - path = strings.Replace(path, "{managementUnitId}", fmt.Sprintf("%v", managementUnitId), -1) - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - defaultReturn := new(Timeoffrequestlist) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'managementUnitId' is set - if &managementUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'managementUnitId' when calling WorkforceManagementApi->GetWorkforcemanagementManagementunitUserTimeoffrequests") - } - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling WorkforceManagementApi->GetWorkforcemanagementManagementunitUserTimeoffrequests") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(recentlyReviewed).(string); ok { - if str != "" { - queryParams["recentlyReviewed"] = a.Configuration.APIClient.ParameterToString(recentlyReviewed, collectionFormat) - } - } else { - queryParams["recentlyReviewed"] = a.Configuration.APIClient.ParameterToString(recentlyReviewed, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Timeoffrequestlist - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWorkforcemanagementManagementunitUsers invokes GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/users -// -// Get users in the management unit -// -// -func (a WorkforceManagementApi) GetWorkforcemanagementManagementunitUsers(managementUnitId string) (*Wfmuserentitylisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/managementunits/{managementUnitId}/users" - path = strings.Replace(path, "{managementUnitId}", fmt.Sprintf("%v", managementUnitId), -1) - defaultReturn := new(Wfmuserentitylisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'managementUnitId' is set - if &managementUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'managementUnitId' when calling WorkforceManagementApi->GetWorkforcemanagementManagementunitUsers") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Wfmuserentitylisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWorkforcemanagementManagementunitWeekSchedule invokes GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId} -// -// Deprecated. Use the equivalent business unit resource instead. Get a week schedule -// -// -func (a WorkforceManagementApi) GetWorkforcemanagementManagementunitWeekSchedule(managementUnitId string, weekId string, scheduleId string, expand string, forceDownloadService bool) (*Weekscheduleresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}" - path = strings.Replace(path, "{managementUnitId}", fmt.Sprintf("%v", managementUnitId), -1) - path = strings.Replace(path, "{weekId}", fmt.Sprintf("%v", weekId), -1) - path = strings.Replace(path, "{scheduleId}", fmt.Sprintf("%v", scheduleId), -1) - defaultReturn := new(Weekscheduleresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'managementUnitId' is set - if &managementUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'managementUnitId' when calling WorkforceManagementApi->GetWorkforcemanagementManagementunitWeekSchedule") - } - // verify the required parameter 'weekId' is set - if &weekId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'weekId' when calling WorkforceManagementApi->GetWorkforcemanagementManagementunitWeekSchedule") - } - // verify the required parameter 'scheduleId' is set - if &scheduleId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'scheduleId' when calling WorkforceManagementApi->GetWorkforcemanagementManagementunitWeekSchedule") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(expand).(string); ok { - if str != "" { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(forceDownloadService).(string); ok { - if str != "" { - queryParams["forceDownloadService"] = a.Configuration.APIClient.ParameterToString(forceDownloadService, collectionFormat) - } - } else { - queryParams["forceDownloadService"] = a.Configuration.APIClient.ParameterToString(forceDownloadService, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Weekscheduleresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWorkforcemanagementManagementunitWeekSchedules invokes GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules -// -// Deprecated. Use the equivalent business unit resource instead. Get the list of schedules in a week in management unit -// -// -func (a WorkforceManagementApi) GetWorkforcemanagementManagementunitWeekSchedules(managementUnitId string, weekId string, includeOnlyPublished bool, earliestWeekDate string, latestWeekDate string) (*Weekschedulelistresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules" - path = strings.Replace(path, "{managementUnitId}", fmt.Sprintf("%v", managementUnitId), -1) - path = strings.Replace(path, "{weekId}", fmt.Sprintf("%v", weekId), -1) - defaultReturn := new(Weekschedulelistresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'managementUnitId' is set - if &managementUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'managementUnitId' when calling WorkforceManagementApi->GetWorkforcemanagementManagementunitWeekSchedules") - } - // verify the required parameter 'weekId' is set - if &weekId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'weekId' when calling WorkforceManagementApi->GetWorkforcemanagementManagementunitWeekSchedules") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(includeOnlyPublished).(string); ok { - if str != "" { - queryParams["includeOnlyPublished"] = a.Configuration.APIClient.ParameterToString(includeOnlyPublished, collectionFormat) - } - } else { - queryParams["includeOnlyPublished"] = a.Configuration.APIClient.ParameterToString(includeOnlyPublished, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(earliestWeekDate).(string); ok { - if str != "" { - queryParams["earliestWeekDate"] = a.Configuration.APIClient.ParameterToString(earliestWeekDate, collectionFormat) - } - } else { - queryParams["earliestWeekDate"] = a.Configuration.APIClient.ParameterToString(earliestWeekDate, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(latestWeekDate).(string); ok { - if str != "" { - queryParams["latestWeekDate"] = a.Configuration.APIClient.ParameterToString(latestWeekDate, collectionFormat) - } - } else { - queryParams["latestWeekDate"] = a.Configuration.APIClient.ParameterToString(latestWeekDate, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Weekschedulelistresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWorkforcemanagementManagementunitWeekShifttrades invokes GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades -// -// Gets all the shift trades for a given week -// -// -func (a WorkforceManagementApi) GetWorkforcemanagementManagementunitWeekShifttrades(managementUnitId string, weekDateId time.Time, evaluateMatches bool) (*Weekshifttradelistresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades" - path = strings.Replace(path, "{managementUnitId}", fmt.Sprintf("%v", managementUnitId), -1) - path = strings.Replace(path, "{weekDateId}", fmt.Sprintf("%v", weekDateId), -1) - defaultReturn := new(Weekshifttradelistresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'managementUnitId' is set - if &managementUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'managementUnitId' when calling WorkforceManagementApi->GetWorkforcemanagementManagementunitWeekShifttrades") - } - // verify the required parameter 'weekDateId' is set - if &weekDateId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'weekDateId' when calling WorkforceManagementApi->GetWorkforcemanagementManagementunitWeekShifttrades") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(evaluateMatches).(string); ok { - if str != "" { - queryParams["evaluateMatches"] = a.Configuration.APIClient.ParameterToString(evaluateMatches, collectionFormat) - } - } else { - queryParams["evaluateMatches"] = a.Configuration.APIClient.ParameterToString(evaluateMatches, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Weekshifttradelistresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWorkforcemanagementManagementunitWorkplan invokes GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId} -// -// Get a work plan -// -// -func (a WorkforceManagementApi) GetWorkforcemanagementManagementunitWorkplan(managementUnitId string, workPlanId string) (*Workplan, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}" - path = strings.Replace(path, "{managementUnitId}", fmt.Sprintf("%v", managementUnitId), -1) - path = strings.Replace(path, "{workPlanId}", fmt.Sprintf("%v", workPlanId), -1) - defaultReturn := new(Workplan) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'managementUnitId' is set - if &managementUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'managementUnitId' when calling WorkforceManagementApi->GetWorkforcemanagementManagementunitWorkplan") - } - // verify the required parameter 'workPlanId' is set - if &workPlanId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'workPlanId' when calling WorkforceManagementApi->GetWorkforcemanagementManagementunitWorkplan") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Workplan - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWorkforcemanagementManagementunitWorkplanrotation invokes GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId} -// -// Get a work plan rotation -// -// -func (a WorkforceManagementApi) GetWorkforcemanagementManagementunitWorkplanrotation(managementUnitId string, workPlanRotationId string) (*Workplanrotationresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}" - path = strings.Replace(path, "{managementUnitId}", fmt.Sprintf("%v", managementUnitId), -1) - path = strings.Replace(path, "{workPlanRotationId}", fmt.Sprintf("%v", workPlanRotationId), -1) - defaultReturn := new(Workplanrotationresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'managementUnitId' is set - if &managementUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'managementUnitId' when calling WorkforceManagementApi->GetWorkforcemanagementManagementunitWorkplanrotation") - } - // verify the required parameter 'workPlanRotationId' is set - if &workPlanRotationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'workPlanRotationId' when calling WorkforceManagementApi->GetWorkforcemanagementManagementunitWorkplanrotation") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Workplanrotationresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWorkforcemanagementManagementunitWorkplanrotations invokes GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations -// -// Get work plan rotations -// -// -func (a WorkforceManagementApi) GetWorkforcemanagementManagementunitWorkplanrotations(managementUnitId string, expand []string) (*Workplanrotationlistresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations" - path = strings.Replace(path, "{managementUnitId}", fmt.Sprintf("%v", managementUnitId), -1) - defaultReturn := new(Workplanrotationlistresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'managementUnitId' is set - if &managementUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'managementUnitId' when calling WorkforceManagementApi->GetWorkforcemanagementManagementunitWorkplanrotations") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Workplanrotationlistresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWorkforcemanagementManagementunitWorkplans invokes GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans -// -// Get work plans -// -// -func (a WorkforceManagementApi) GetWorkforcemanagementManagementunitWorkplans(managementUnitId string, expand []string) (*Workplanlistresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans" - path = strings.Replace(path, "{managementUnitId}", fmt.Sprintf("%v", managementUnitId), -1) - defaultReturn := new(Workplanlistresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'managementUnitId' is set - if &managementUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'managementUnitId' when calling WorkforceManagementApi->GetWorkforcemanagementManagementunitWorkplans") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Workplanlistresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWorkforcemanagementManagementunits invokes GET /api/v2/workforcemanagement/managementunits -// -// Get management units -// -// -func (a WorkforceManagementApi) GetWorkforcemanagementManagementunits(pageSize int, pageNumber int, expand string, feature string, divisionId string) (*Managementunitlisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/managementunits" - defaultReturn := new(Managementunitlisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(pageSize).(string); ok { - if str != "" { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - } else { - queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(pageNumber).(string); ok { - if str != "" { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - } else { - queryParams["pageNumber"] = a.Configuration.APIClient.ParameterToString(pageNumber, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(expand).(string); ok { - if str != "" { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(feature).(string); ok { - if str != "" { - queryParams["feature"] = a.Configuration.APIClient.ParameterToString(feature, collectionFormat) - } - } else { - queryParams["feature"] = a.Configuration.APIClient.ParameterToString(feature, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(divisionId).(string); ok { - if str != "" { - queryParams["divisionId"] = a.Configuration.APIClient.ParameterToString(divisionId, collectionFormat) - } - } else { - queryParams["divisionId"] = a.Configuration.APIClient.ParameterToString(divisionId, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Managementunitlisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWorkforcemanagementManagementunitsDivisionviews invokes GET /api/v2/workforcemanagement/managementunits/divisionviews -// -// Get management units across divisions -// -// -func (a WorkforceManagementApi) GetWorkforcemanagementManagementunitsDivisionviews(divisionId []string) (*Managementunitlisting, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/managementunits/divisionviews" - defaultReturn := new(Managementunitlisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range divisionId { - queryParams["divisionId"] = value - } - } else { - queryParams["divisionId"] = a.Configuration.APIClient.ParameterToString(divisionId, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Managementunitlisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWorkforcemanagementNotifications invokes GET /api/v2/workforcemanagement/notifications -// -// Get a list of notifications for the current user -// -// -func (a WorkforceManagementApi) GetWorkforcemanagementNotifications() (*Notificationsresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/notifications" - defaultReturn := new(Notificationsresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Notificationsresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWorkforcemanagementSchedulingjob invokes GET /api/v2/workforcemanagement/schedulingjobs/{jobId} -// -// Get status of the scheduling job -// -// -func (a WorkforceManagementApi) GetWorkforcemanagementSchedulingjob(jobId string) (*Schedulingstatusresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/schedulingjobs/{jobId}" - path = strings.Replace(path, "{jobId}", fmt.Sprintf("%v", jobId), -1) - defaultReturn := new(Schedulingstatusresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'jobId' is set - if &jobId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'jobId' when calling WorkforceManagementApi->GetWorkforcemanagementSchedulingjob") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Schedulingstatusresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWorkforcemanagementShifttrades invokes GET /api/v2/workforcemanagement/shifttrades -// -// Gets all of my shift trades -// -// -func (a WorkforceManagementApi) GetWorkforcemanagementShifttrades() (*Shifttradelistresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/shifttrades" - defaultReturn := new(Shifttradelistresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Shifttradelistresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWorkforcemanagementTimeoffrequest invokes GET /api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId} -// -// Get a time off request for the current user -// -// -func (a WorkforceManagementApi) GetWorkforcemanagementTimeoffrequest(timeOffRequestId string) (*Timeoffrequestresponse, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}" - path = strings.Replace(path, "{timeOffRequestId}", fmt.Sprintf("%v", timeOffRequestId), -1) - defaultReturn := new(Timeoffrequestresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'timeOffRequestId' is set - if &timeOffRequestId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'timeOffRequestId' when calling WorkforceManagementApi->GetWorkforcemanagementTimeoffrequest") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Timeoffrequestresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// GetWorkforcemanagementTimeoffrequests invokes GET /api/v2/workforcemanagement/timeoffrequests -// -// Get a list of time off requests for the current user -// -// -func (a WorkforceManagementApi) GetWorkforcemanagementTimeoffrequests(recentlyReviewed bool) (*Timeoffrequestlist, *APIResponse, error) { - var httpMethod = "GET" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/timeoffrequests" - defaultReturn := new(Timeoffrequestlist) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(recentlyReviewed).(string); ok { - if str != "" { - queryParams["recentlyReviewed"] = a.Configuration.APIClient.ParameterToString(recentlyReviewed, collectionFormat) - } - } else { - queryParams["recentlyReviewed"] = a.Configuration.APIClient.ParameterToString(recentlyReviewed, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - var successPayload *Timeoffrequestlist - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchWorkforcemanagementBusinessunit invokes PATCH /api/v2/workforcemanagement/businessunits/{businessUnitId} -// -// Update business unit -// -// -func (a WorkforceManagementApi) PatchWorkforcemanagementBusinessunit(businessUnitId string, body Updatebusinessunitrequest) (*Businessunit, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/businessunits/{businessUnitId}" - path = strings.Replace(path, "{businessUnitId}", fmt.Sprintf("%v", businessUnitId), -1) - defaultReturn := new(Businessunit) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'businessUnitId' is set - if &businessUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'businessUnitId' when calling WorkforceManagementApi->PatchWorkforcemanagementBusinessunit") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Businessunit - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchWorkforcemanagementBusinessunitActivitycode invokes PATCH /api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes/{activityCodeId} -// -// Update an activity code -// -// -func (a WorkforceManagementApi) PatchWorkforcemanagementBusinessunitActivitycode(businessUnitId string, activityCodeId string, body Updateactivitycoderequest) (*Businessunitactivitycode, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes/{activityCodeId}" - path = strings.Replace(path, "{businessUnitId}", fmt.Sprintf("%v", businessUnitId), -1) - path = strings.Replace(path, "{activityCodeId}", fmt.Sprintf("%v", activityCodeId), -1) - defaultReturn := new(Businessunitactivitycode) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'businessUnitId' is set - if &businessUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'businessUnitId' when calling WorkforceManagementApi->PatchWorkforcemanagementBusinessunitActivitycode") - } - // verify the required parameter 'activityCodeId' is set - if &activityCodeId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'activityCodeId' when calling WorkforceManagementApi->PatchWorkforcemanagementBusinessunitActivitycode") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Businessunitactivitycode - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchWorkforcemanagementBusinessunitPlanninggroup invokes PATCH /api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups/{planningGroupId} -// -// Updates the planning group -// -// -func (a WorkforceManagementApi) PatchWorkforcemanagementBusinessunitPlanninggroup(businessUnitId string, planningGroupId string, body Updateplanninggrouprequest) (*Planninggroup, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups/{planningGroupId}" - path = strings.Replace(path, "{businessUnitId}", fmt.Sprintf("%v", businessUnitId), -1) - path = strings.Replace(path, "{planningGroupId}", fmt.Sprintf("%v", planningGroupId), -1) - defaultReturn := new(Planninggroup) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'businessUnitId' is set - if &businessUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'businessUnitId' when calling WorkforceManagementApi->PatchWorkforcemanagementBusinessunitPlanninggroup") - } - // verify the required parameter 'planningGroupId' is set - if &planningGroupId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'planningGroupId' when calling WorkforceManagementApi->PatchWorkforcemanagementBusinessunitPlanninggroup") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Planninggroup - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchWorkforcemanagementBusinessunitSchedulingRun invokes PATCH /api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId} -// -// Mark a schedule run as applied -// -// -func (a WorkforceManagementApi) PatchWorkforcemanagementBusinessunitSchedulingRun(businessUnitId string, runId string, body Patchbuschedulerunrequest) (*APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId}" - path = strings.Replace(path, "{businessUnitId}", fmt.Sprintf("%v", businessUnitId), -1) - path = strings.Replace(path, "{runId}", fmt.Sprintf("%v", runId), -1) - if true == false { - return nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'businessUnitId' is set - if &businessUnitId == nil { - // - return nil, errors.New("Missing required parameter 'businessUnitId' when calling WorkforceManagementApi->PatchWorkforcemanagementBusinessunitSchedulingRun") - } - // verify the required parameter 'runId' is set - if &runId == nil { - // - return nil, errors.New("Missing required parameter 'runId' when calling WorkforceManagementApi->PatchWorkforcemanagementBusinessunitSchedulingRun") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } - return response, err -} - -// PatchWorkforcemanagementBusinessunitServicegoaltemplate invokes PATCH /api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId} -// -// Updates a service goal template -// -// -func (a WorkforceManagementApi) PatchWorkforcemanagementBusinessunitServicegoaltemplate(businessUnitId string, serviceGoalTemplateId string, body Updateservicegoaltemplate) (*Servicegoaltemplate, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId}" - path = strings.Replace(path, "{businessUnitId}", fmt.Sprintf("%v", businessUnitId), -1) - path = strings.Replace(path, "{serviceGoalTemplateId}", fmt.Sprintf("%v", serviceGoalTemplateId), -1) - defaultReturn := new(Servicegoaltemplate) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'businessUnitId' is set - if &businessUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'businessUnitId' when calling WorkforceManagementApi->PatchWorkforcemanagementBusinessunitServicegoaltemplate") - } - // verify the required parameter 'serviceGoalTemplateId' is set - if &serviceGoalTemplateId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'serviceGoalTemplateId' when calling WorkforceManagementApi->PatchWorkforcemanagementBusinessunitServicegoaltemplate") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Servicegoaltemplate - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchWorkforcemanagementManagementunit invokes PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId} -// -// Update the requested management unit -// -// -func (a WorkforceManagementApi) PatchWorkforcemanagementManagementunit(managementUnitId string, body Updatemanagementunitrequest) (*Managementunit, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/managementunits/{managementUnitId}" - path = strings.Replace(path, "{managementUnitId}", fmt.Sprintf("%v", managementUnitId), -1) - defaultReturn := new(Managementunit) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'managementUnitId' is set - if &managementUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'managementUnitId' when calling WorkforceManagementApi->PatchWorkforcemanagementManagementunit") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Managementunit - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchWorkforcemanagementManagementunitUserTimeoffrequest invokes PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId} -// -// Update a time off request -// -// -func (a WorkforceManagementApi) PatchWorkforcemanagementManagementunitUserTimeoffrequest(managementUnitId string, userId string, timeOffRequestId string, body Admintimeoffrequestpatch) (*Timeoffrequestresponse, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}" - path = strings.Replace(path, "{managementUnitId}", fmt.Sprintf("%v", managementUnitId), -1) - path = strings.Replace(path, "{userId}", fmt.Sprintf("%v", userId), -1) - path = strings.Replace(path, "{timeOffRequestId}", fmt.Sprintf("%v", timeOffRequestId), -1) - defaultReturn := new(Timeoffrequestresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'managementUnitId' is set - if &managementUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'managementUnitId' when calling WorkforceManagementApi->PatchWorkforcemanagementManagementunitUserTimeoffrequest") - } - // verify the required parameter 'userId' is set - if &userId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'userId' when calling WorkforceManagementApi->PatchWorkforcemanagementManagementunitUserTimeoffrequest") - } - // verify the required parameter 'timeOffRequestId' is set - if &timeOffRequestId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'timeOffRequestId' when calling WorkforceManagementApi->PatchWorkforcemanagementManagementunitUserTimeoffrequest") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Timeoffrequestresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchWorkforcemanagementManagementunitWeekShifttrade invokes PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/{tradeId} -// -// Updates a shift trade. This route can only be called by the initiating agent -// -// -func (a WorkforceManagementApi) PatchWorkforcemanagementManagementunitWeekShifttrade(managementUnitId string, weekDateId time.Time, body Patchshifttraderequest, tradeId string) (*Shifttraderesponse, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/{tradeId}" - path = strings.Replace(path, "{managementUnitId}", fmt.Sprintf("%v", managementUnitId), -1) - path = strings.Replace(path, "{weekDateId}", fmt.Sprintf("%v", weekDateId), -1) - path = strings.Replace(path, "{tradeId}", fmt.Sprintf("%v", tradeId), -1) - defaultReturn := new(Shifttraderesponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'managementUnitId' is set - if &managementUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'managementUnitId' when calling WorkforceManagementApi->PatchWorkforcemanagementManagementunitWeekShifttrade") - } - // verify the required parameter 'weekDateId' is set - if &weekDateId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'weekDateId' when calling WorkforceManagementApi->PatchWorkforcemanagementManagementunitWeekShifttrade") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling WorkforceManagementApi->PatchWorkforcemanagementManagementunitWeekShifttrade") - } - // verify the required parameter 'tradeId' is set - if &tradeId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'tradeId' when calling WorkforceManagementApi->PatchWorkforcemanagementManagementunitWeekShifttrade") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Shifttraderesponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchWorkforcemanagementManagementunitWorkplan invokes PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId} -// -// Update a work plan -// -// -func (a WorkforceManagementApi) PatchWorkforcemanagementManagementunitWorkplan(managementUnitId string, workPlanId string, body Workplan, validationMode string) (*Workplan, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}" - path = strings.Replace(path, "{managementUnitId}", fmt.Sprintf("%v", managementUnitId), -1) - path = strings.Replace(path, "{workPlanId}", fmt.Sprintf("%v", workPlanId), -1) - defaultReturn := new(Workplan) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'managementUnitId' is set - if &managementUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'managementUnitId' when calling WorkforceManagementApi->PatchWorkforcemanagementManagementunitWorkplan") - } - // verify the required parameter 'workPlanId' is set - if &workPlanId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'workPlanId' when calling WorkforceManagementApi->PatchWorkforcemanagementManagementunitWorkplan") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(validationMode).(string); ok { - if str != "" { - queryParams["validationMode"] = a.Configuration.APIClient.ParameterToString(validationMode, collectionFormat) - } - } else { - queryParams["validationMode"] = a.Configuration.APIClient.ParameterToString(validationMode, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Workplan - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchWorkforcemanagementManagementunitWorkplanrotation invokes PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId} -// -// Update a work plan rotation -// -// -func (a WorkforceManagementApi) PatchWorkforcemanagementManagementunitWorkplanrotation(managementUnitId string, workPlanRotationId string, body Updateworkplanrotationrequest) (*Workplanrotationresponse, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}" - path = strings.Replace(path, "{managementUnitId}", fmt.Sprintf("%v", managementUnitId), -1) - path = strings.Replace(path, "{workPlanRotationId}", fmt.Sprintf("%v", workPlanRotationId), -1) - defaultReturn := new(Workplanrotationresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'managementUnitId' is set - if &managementUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'managementUnitId' when calling WorkforceManagementApi->PatchWorkforcemanagementManagementunitWorkplanrotation") - } - // verify the required parameter 'workPlanRotationId' is set - if &workPlanRotationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'workPlanRotationId' when calling WorkforceManagementApi->PatchWorkforcemanagementManagementunitWorkplanrotation") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Workplanrotationresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PatchWorkforcemanagementTimeoffrequest invokes PATCH /api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId} -// -// Update a time off request for the current user -// -// -func (a WorkforceManagementApi) PatchWorkforcemanagementTimeoffrequest(timeOffRequestId string, body Agenttimeoffrequestpatch) (*Timeoffrequestresponse, *APIResponse, error) { - var httpMethod = "PATCH" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}" - path = strings.Replace(path, "{timeOffRequestId}", fmt.Sprintf("%v", timeOffRequestId), -1) - defaultReturn := new(Timeoffrequestresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'timeOffRequestId' is set - if &timeOffRequestId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'timeOffRequestId' when calling WorkforceManagementApi->PatchWorkforcemanagementTimeoffrequest") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Timeoffrequestresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostWorkforcemanagementAdherenceHistorical invokes POST /api/v2/workforcemanagement/adherence/historical -// -// Request a historical adherence report for users across management units -// -// -func (a WorkforceManagementApi) PostWorkforcemanagementAdherenceHistorical(body Wfmhistoricaladherencequeryforusers) (*Wfmhistoricaladherenceresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/adherence/historical" - defaultReturn := new(Wfmhistoricaladherenceresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Wfmhistoricaladherenceresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostWorkforcemanagementAgentschedulesMine invokes POST /api/v2/workforcemanagement/agentschedules/mine -// -// Get published schedule for the current user -// -// -func (a WorkforceManagementApi) PostWorkforcemanagementAgentschedulesMine(body Bugetcurrentagentschedulerequest) (*Bucurrentagentschedulesearchresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/agentschedules/mine" - defaultReturn := new(Bucurrentagentschedulesearchresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Bucurrentagentschedulesearchresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostWorkforcemanagementBusinessunitActivitycodes invokes POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes -// -// Create a new activity code -// -// -func (a WorkforceManagementApi) PostWorkforcemanagementBusinessunitActivitycodes(businessUnitId string, body Createactivitycoderequest) (*Businessunitactivitycode, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes" - path = strings.Replace(path, "{businessUnitId}", fmt.Sprintf("%v", businessUnitId), -1) - defaultReturn := new(Businessunitactivitycode) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'businessUnitId' is set - if &businessUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'businessUnitId' when calling WorkforceManagementApi->PostWorkforcemanagementBusinessunitActivitycodes") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Businessunitactivitycode - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostWorkforcemanagementBusinessunitAgentschedulesSearch invokes POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/agentschedules/search -// -// Search published schedules -// -// -func (a WorkforceManagementApi) PostWorkforcemanagementBusinessunitAgentschedulesSearch(businessUnitId string, body Busearchagentschedulesrequest, forceAsync bool, forceDownloadService bool) (*Buasyncagentschedulessearchresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/businessunits/{businessUnitId}/agentschedules/search" - path = strings.Replace(path, "{businessUnitId}", fmt.Sprintf("%v", businessUnitId), -1) - defaultReturn := new(Buasyncagentschedulessearchresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'businessUnitId' is set - if &businessUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'businessUnitId' when calling WorkforceManagementApi->PostWorkforcemanagementBusinessunitAgentschedulesSearch") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(forceAsync).(string); ok { - if str != "" { - queryParams["forceAsync"] = a.Configuration.APIClient.ParameterToString(forceAsync, collectionFormat) - } - } else { - queryParams["forceAsync"] = a.Configuration.APIClient.ParameterToString(forceAsync, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(forceDownloadService).(string); ok { - if str != "" { - queryParams["forceDownloadService"] = a.Configuration.APIClient.ParameterToString(forceDownloadService, collectionFormat) - } - } else { - queryParams["forceDownloadService"] = a.Configuration.APIClient.ParameterToString(forceDownloadService, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Buasyncagentschedulessearchresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostWorkforcemanagementBusinessunitIntraday invokes POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/intraday -// -// Get intraday data for the given date for the requested planningGroupIds -// -// -func (a WorkforceManagementApi) PostWorkforcemanagementBusinessunitIntraday(businessUnitId string, forceAsync bool, body Intradayplanninggrouprequest) (*Asyncintradayresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/businessunits/{businessUnitId}/intraday" - path = strings.Replace(path, "{businessUnitId}", fmt.Sprintf("%v", businessUnitId), -1) - defaultReturn := new(Asyncintradayresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'businessUnitId' is set - if &businessUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'businessUnitId' when calling WorkforceManagementApi->PostWorkforcemanagementBusinessunitIntraday") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(forceAsync).(string); ok { - if str != "" { - queryParams["forceAsync"] = a.Configuration.APIClient.ParameterToString(forceAsync, collectionFormat) - } - } else { - queryParams["forceAsync"] = a.Configuration.APIClient.ParameterToString(forceAsync, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Asyncintradayresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostWorkforcemanagementBusinessunitPlanninggroups invokes POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups -// -// Adds a new planning group -// -// -func (a WorkforceManagementApi) PostWorkforcemanagementBusinessunitPlanninggroups(businessUnitId string, body Createplanninggrouprequest) (*Planninggroup, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups" - path = strings.Replace(path, "{businessUnitId}", fmt.Sprintf("%v", businessUnitId), -1) - defaultReturn := new(Planninggroup) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'businessUnitId' is set - if &businessUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'businessUnitId' when calling WorkforceManagementApi->PostWorkforcemanagementBusinessunitPlanninggroups") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Planninggroup - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostWorkforcemanagementBusinessunitServicegoaltemplates invokes POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates -// -// Adds a new service goal template -// -// -func (a WorkforceManagementApi) PostWorkforcemanagementBusinessunitServicegoaltemplates(businessUnitId string, body Createservicegoaltemplate) (*Servicegoaltemplate, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates" - path = strings.Replace(path, "{businessUnitId}", fmt.Sprintf("%v", businessUnitId), -1) - defaultReturn := new(Servicegoaltemplate) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'businessUnitId' is set - if &businessUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'businessUnitId' when calling WorkforceManagementApi->PostWorkforcemanagementBusinessunitServicegoaltemplates") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Servicegoaltemplate - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQuery invokes POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/agentschedules/query -// -// Loads agent schedule data from the schedule. Used in combination with the metadata route -// -// -func (a WorkforceManagementApi) PostWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQuery(businessUnitId string, weekId time.Time, scheduleId string, body Buqueryagentschedulesrequest, forceAsync bool, forceDownloadService bool) (*Buasyncagentschedulesqueryresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/agentschedules/query" - path = strings.Replace(path, "{businessUnitId}", fmt.Sprintf("%v", businessUnitId), -1) - path = strings.Replace(path, "{weekId}", fmt.Sprintf("%v", weekId), -1) - path = strings.Replace(path, "{scheduleId}", fmt.Sprintf("%v", scheduleId), -1) - defaultReturn := new(Buasyncagentschedulesqueryresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'businessUnitId' is set - if &businessUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'businessUnitId' when calling WorkforceManagementApi->PostWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQuery") - } - // verify the required parameter 'weekId' is set - if &weekId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'weekId' when calling WorkforceManagementApi->PostWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQuery") - } - // verify the required parameter 'scheduleId' is set - if &scheduleId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'scheduleId' when calling WorkforceManagementApi->PostWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQuery") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling WorkforceManagementApi->PostWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQuery") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(forceAsync).(string); ok { - if str != "" { - queryParams["forceAsync"] = a.Configuration.APIClient.ParameterToString(forceAsync, collectionFormat) - } - } else { - queryParams["forceAsync"] = a.Configuration.APIClient.ParameterToString(forceAsync, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(forceDownloadService).(string); ok { - if str != "" { - queryParams["forceDownloadService"] = a.Configuration.APIClient.ParameterToString(forceDownloadService, collectionFormat) - } - } else { - queryParams["forceDownloadService"] = a.Configuration.APIClient.ParameterToString(forceDownloadService, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Buasyncagentschedulesqueryresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostWorkforcemanagementBusinessunitWeekScheduleCopy invokes POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/copy -// -// Copy a schedule -// -// -func (a WorkforceManagementApi) PostWorkforcemanagementBusinessunitWeekScheduleCopy(businessUnitId string, weekId time.Time, scheduleId string, body Bucopyschedulerequest) (*Buasyncscheduleresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/copy" - path = strings.Replace(path, "{businessUnitId}", fmt.Sprintf("%v", businessUnitId), -1) - path = strings.Replace(path, "{weekId}", fmt.Sprintf("%v", weekId), -1) - path = strings.Replace(path, "{scheduleId}", fmt.Sprintf("%v", scheduleId), -1) - defaultReturn := new(Buasyncscheduleresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'businessUnitId' is set - if &businessUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'businessUnitId' when calling WorkforceManagementApi->PostWorkforcemanagementBusinessunitWeekScheduleCopy") - } - // verify the required parameter 'weekId' is set - if &weekId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'weekId' when calling WorkforceManagementApi->PostWorkforcemanagementBusinessunitWeekScheduleCopy") - } - // verify the required parameter 'scheduleId' is set - if &scheduleId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'scheduleId' when calling WorkforceManagementApi->PostWorkforcemanagementBusinessunitWeekScheduleCopy") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling WorkforceManagementApi->PostWorkforcemanagementBusinessunitWeekScheduleCopy") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Buasyncscheduleresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostWorkforcemanagementBusinessunitWeekScheduleReschedule invokes POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/reschedule -// -// Start a rescheduling run -// -// -func (a WorkforceManagementApi) PostWorkforcemanagementBusinessunitWeekScheduleReschedule(businessUnitId string, weekId time.Time, scheduleId string, body Bureschedulerequest) (*Buasyncschedulerunresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/reschedule" - path = strings.Replace(path, "{businessUnitId}", fmt.Sprintf("%v", businessUnitId), -1) - path = strings.Replace(path, "{weekId}", fmt.Sprintf("%v", weekId), -1) - path = strings.Replace(path, "{scheduleId}", fmt.Sprintf("%v", scheduleId), -1) - defaultReturn := new(Buasyncschedulerunresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'businessUnitId' is set - if &businessUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'businessUnitId' when calling WorkforceManagementApi->PostWorkforcemanagementBusinessunitWeekScheduleReschedule") - } - // verify the required parameter 'weekId' is set - if &weekId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'weekId' when calling WorkforceManagementApi->PostWorkforcemanagementBusinessunitWeekScheduleReschedule") - } - // verify the required parameter 'scheduleId' is set - if &scheduleId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'scheduleId' when calling WorkforceManagementApi->PostWorkforcemanagementBusinessunitWeekScheduleReschedule") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling WorkforceManagementApi->PostWorkforcemanagementBusinessunitWeekScheduleReschedule") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Buasyncschedulerunresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostWorkforcemanagementBusinessunitWeekSchedules invokes POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules -// -// Create a blank schedule -// -// -func (a WorkforceManagementApi) PostWorkforcemanagementBusinessunitWeekSchedules(businessUnitId string, weekId time.Time, body Bucreateblankschedulerequest) (*Buschedulemetadata, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules" - path = strings.Replace(path, "{businessUnitId}", fmt.Sprintf("%v", businessUnitId), -1) - path = strings.Replace(path, "{weekId}", fmt.Sprintf("%v", weekId), -1) - defaultReturn := new(Buschedulemetadata) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'businessUnitId' is set - if &businessUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'businessUnitId' when calling WorkforceManagementApi->PostWorkforcemanagementBusinessunitWeekSchedules") - } - // verify the required parameter 'weekId' is set - if &weekId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'weekId' when calling WorkforceManagementApi->PostWorkforcemanagementBusinessunitWeekSchedules") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling WorkforceManagementApi->PostWorkforcemanagementBusinessunitWeekSchedules") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Buschedulemetadata - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostWorkforcemanagementBusinessunitWeekSchedulesGenerate invokes POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/generate -// -// Generate a schedule -// -// -func (a WorkforceManagementApi) PostWorkforcemanagementBusinessunitWeekSchedulesGenerate(businessUnitId string, weekId time.Time, body Bugenerateschedulerequest) (*Buasyncschedulerunresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/generate" - path = strings.Replace(path, "{businessUnitId}", fmt.Sprintf("%v", businessUnitId), -1) - path = strings.Replace(path, "{weekId}", fmt.Sprintf("%v", weekId), -1) - defaultReturn := new(Buasyncschedulerunresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'businessUnitId' is set - if &businessUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'businessUnitId' when calling WorkforceManagementApi->PostWorkforcemanagementBusinessunitWeekSchedulesGenerate") - } - // verify the required parameter 'weekId' is set - if &weekId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'weekId' when calling WorkforceManagementApi->PostWorkforcemanagementBusinessunitWeekSchedulesGenerate") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling WorkforceManagementApi->PostWorkforcemanagementBusinessunitWeekSchedulesGenerate") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Buasyncschedulerunresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostWorkforcemanagementBusinessunitWeekShorttermforecastCopy invokes POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/copy -// -// Copy a short term forecast -// -// -func (a WorkforceManagementApi) PostWorkforcemanagementBusinessunitWeekShorttermforecastCopy(businessUnitId string, weekDateId time.Time, forecastId string, body Copybuforecastrequest, forceAsync bool) (*Asyncforecastoperationresult, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/copy" - path = strings.Replace(path, "{businessUnitId}", fmt.Sprintf("%v", businessUnitId), -1) - path = strings.Replace(path, "{weekDateId}", fmt.Sprintf("%v", weekDateId), -1) - path = strings.Replace(path, "{forecastId}", fmt.Sprintf("%v", forecastId), -1) - defaultReturn := new(Asyncforecastoperationresult) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'businessUnitId' is set - if &businessUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'businessUnitId' when calling WorkforceManagementApi->PostWorkforcemanagementBusinessunitWeekShorttermforecastCopy") - } - // verify the required parameter 'weekDateId' is set - if &weekDateId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'weekDateId' when calling WorkforceManagementApi->PostWorkforcemanagementBusinessunitWeekShorttermforecastCopy") - } - // verify the required parameter 'forecastId' is set - if &forecastId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'forecastId' when calling WorkforceManagementApi->PostWorkforcemanagementBusinessunitWeekShorttermforecastCopy") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling WorkforceManagementApi->PostWorkforcemanagementBusinessunitWeekShorttermforecastCopy") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(forceAsync).(string); ok { - if str != "" { - queryParams["forceAsync"] = a.Configuration.APIClient.ParameterToString(forceAsync, collectionFormat) - } - } else { - queryParams["forceAsync"] = a.Configuration.APIClient.ParameterToString(forceAsync, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Asyncforecastoperationresult - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostWorkforcemanagementBusinessunitWeekShorttermforecastsGenerate invokes POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/generate -// -// Generate a short term forecast -// -// -func (a WorkforceManagementApi) PostWorkforcemanagementBusinessunitWeekShorttermforecastsGenerate(businessUnitId string, weekDateId time.Time, body Generatebuforecastrequest, forceAsync bool) (*Asyncforecastoperationresult, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/generate" - path = strings.Replace(path, "{businessUnitId}", fmt.Sprintf("%v", businessUnitId), -1) - path = strings.Replace(path, "{weekDateId}", fmt.Sprintf("%v", weekDateId), -1) - defaultReturn := new(Asyncforecastoperationresult) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'businessUnitId' is set - if &businessUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'businessUnitId' when calling WorkforceManagementApi->PostWorkforcemanagementBusinessunitWeekShorttermforecastsGenerate") - } - // verify the required parameter 'weekDateId' is set - if &weekDateId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'weekDateId' when calling WorkforceManagementApi->PostWorkforcemanagementBusinessunitWeekShorttermforecastsGenerate") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling WorkforceManagementApi->PostWorkforcemanagementBusinessunitWeekShorttermforecastsGenerate") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(forceAsync).(string); ok { - if str != "" { - queryParams["forceAsync"] = a.Configuration.APIClient.ParameterToString(forceAsync, collectionFormat) - } - } else { - queryParams["forceAsync"] = a.Configuration.APIClient.ParameterToString(forceAsync, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Asyncforecastoperationresult - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostWorkforcemanagementBusinessunits invokes POST /api/v2/workforcemanagement/businessunits -// -// Add a new business unit -// -// It may take a minute or two for a new business unit to be available for api operations -func (a WorkforceManagementApi) PostWorkforcemanagementBusinessunits(body Createbusinessunitrequest) (*Businessunit, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/businessunits" - defaultReturn := new(Businessunit) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Businessunit - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostWorkforcemanagementManagementunitAgentschedulesSearch invokes POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/agentschedules/search -// -// Query published schedules for given given time range for set of users -// -// -func (a WorkforceManagementApi) PostWorkforcemanagementManagementunitAgentschedulesSearch(managementUnitId string, body Busearchagentschedulesrequest, forceAsync bool, forceDownloadService bool) (*Buasyncagentschedulessearchresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/managementunits/{managementUnitId}/agentschedules/search" - path = strings.Replace(path, "{managementUnitId}", fmt.Sprintf("%v", managementUnitId), -1) - defaultReturn := new(Buasyncagentschedulessearchresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'managementUnitId' is set - if &managementUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'managementUnitId' when calling WorkforceManagementApi->PostWorkforcemanagementManagementunitAgentschedulesSearch") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(forceAsync).(string); ok { - if str != "" { - queryParams["forceAsync"] = a.Configuration.APIClient.ParameterToString(forceAsync, collectionFormat) - } - } else { - queryParams["forceAsync"] = a.Configuration.APIClient.ParameterToString(forceAsync, collectionFormat) - } - - - - - collectionFormat = "" - if str, ok := interface{}(forceDownloadService).(string); ok { - if str != "" { - queryParams["forceDownloadService"] = a.Configuration.APIClient.ParameterToString(forceDownloadService, collectionFormat) - } - } else { - queryParams["forceDownloadService"] = a.Configuration.APIClient.ParameterToString(forceDownloadService, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Buasyncagentschedulessearchresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostWorkforcemanagementManagementunitHistoricaladherencequery invokes POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/historicaladherencequery -// -// Request a historical adherence report -// -// The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true -func (a WorkforceManagementApi) PostWorkforcemanagementManagementunitHistoricaladherencequery(managementUnitId string, body Wfmhistoricaladherencequery) (*Wfmhistoricaladherenceresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/managementunits/{managementUnitId}/historicaladherencequery" - path = strings.Replace(path, "{managementUnitId}", fmt.Sprintf("%v", managementUnitId), -1) - defaultReturn := new(Wfmhistoricaladherenceresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'managementUnitId' is set - if &managementUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'managementUnitId' when calling WorkforceManagementApi->PostWorkforcemanagementManagementunitHistoricaladherencequery") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Wfmhistoricaladherenceresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostWorkforcemanagementManagementunitMove invokes POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/move -// -// Move the requested management unit to a new business unit -// -// Returns status 200 if the management unit is already in the requested business unit -func (a WorkforceManagementApi) PostWorkforcemanagementManagementunitMove(managementUnitId string, body Movemanagementunitrequest) (*Movemanagementunitresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/managementunits/{managementUnitId}/move" - path = strings.Replace(path, "{managementUnitId}", fmt.Sprintf("%v", managementUnitId), -1) - defaultReturn := new(Movemanagementunitresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'managementUnitId' is set - if &managementUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'managementUnitId' when calling WorkforceManagementApi->PostWorkforcemanagementManagementunitMove") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Movemanagementunitresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostWorkforcemanagementManagementunitSchedulesSearch invokes POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/schedules/search -// -// Query published schedules for given given time range for set of users -// -// -func (a WorkforceManagementApi) PostWorkforcemanagementManagementunitSchedulesSearch(managementUnitId string, body Userlistschedulerequestbody) (*Userschedulecontainer, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/managementunits/{managementUnitId}/schedules/search" - path = strings.Replace(path, "{managementUnitId}", fmt.Sprintf("%v", managementUnitId), -1) - defaultReturn := new(Userschedulecontainer) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'managementUnitId' is set - if &managementUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'managementUnitId' when calling WorkforceManagementApi->PostWorkforcemanagementManagementunitSchedulesSearch") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Userschedulecontainer - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostWorkforcemanagementManagementunitTimeoffrequests invokes POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests -// -// Create a new time off request -// -// -func (a WorkforceManagementApi) PostWorkforcemanagementManagementunitTimeoffrequests(managementUnitId string, body Createadmintimeoffrequest) (*Timeoffrequestlist, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests" - path = strings.Replace(path, "{managementUnitId}", fmt.Sprintf("%v", managementUnitId), -1) - defaultReturn := new(Timeoffrequestlist) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'managementUnitId' is set - if &managementUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'managementUnitId' when calling WorkforceManagementApi->PostWorkforcemanagementManagementunitTimeoffrequests") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Timeoffrequestlist - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostWorkforcemanagementManagementunitTimeoffrequestsQuery invokes POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/query -// -// Gets the lookup ids to fetch the specified set of requests -// -// -func (a WorkforceManagementApi) PostWorkforcemanagementManagementunitTimeoffrequestsQuery(managementUnitId string, body Timeoffrequestquerybody) (*Timeoffrequestlisting, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/query" - path = strings.Replace(path, "{managementUnitId}", fmt.Sprintf("%v", managementUnitId), -1) - defaultReturn := new(Timeoffrequestlisting) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'managementUnitId' is set - if &managementUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'managementUnitId' when calling WorkforceManagementApi->PostWorkforcemanagementManagementunitTimeoffrequestsQuery") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Timeoffrequestlisting - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostWorkforcemanagementManagementunitWeekShifttradeMatch invokes POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/{tradeId}/match -// -// Matches a shift trade. This route can only be called by the receiving agent -// -// -func (a WorkforceManagementApi) PostWorkforcemanagementManagementunitWeekShifttradeMatch(managementUnitId string, weekDateId time.Time, body Matchshifttraderequest, tradeId string) (*Matchshifttraderesponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/{tradeId}/match" - path = strings.Replace(path, "{managementUnitId}", fmt.Sprintf("%v", managementUnitId), -1) - path = strings.Replace(path, "{weekDateId}", fmt.Sprintf("%v", weekDateId), -1) - path = strings.Replace(path, "{tradeId}", fmt.Sprintf("%v", tradeId), -1) - defaultReturn := new(Matchshifttraderesponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'managementUnitId' is set - if &managementUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'managementUnitId' when calling WorkforceManagementApi->PostWorkforcemanagementManagementunitWeekShifttradeMatch") - } - // verify the required parameter 'weekDateId' is set - if &weekDateId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'weekDateId' when calling WorkforceManagementApi->PostWorkforcemanagementManagementunitWeekShifttradeMatch") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling WorkforceManagementApi->PostWorkforcemanagementManagementunitWeekShifttradeMatch") - } - // verify the required parameter 'tradeId' is set - if &tradeId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'tradeId' when calling WorkforceManagementApi->PostWorkforcemanagementManagementunitWeekShifttradeMatch") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Matchshifttraderesponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostWorkforcemanagementManagementunitWeekShifttrades invokes POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades -// -// Adds a shift trade -// -// -func (a WorkforceManagementApi) PostWorkforcemanagementManagementunitWeekShifttrades(managementUnitId string, weekDateId time.Time, body Addshifttraderequest) (*Shifttraderesponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades" - path = strings.Replace(path, "{managementUnitId}", fmt.Sprintf("%v", managementUnitId), -1) - path = strings.Replace(path, "{weekDateId}", fmt.Sprintf("%v", weekDateId), -1) - defaultReturn := new(Shifttraderesponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'managementUnitId' is set - if &managementUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'managementUnitId' when calling WorkforceManagementApi->PostWorkforcemanagementManagementunitWeekShifttrades") - } - // verify the required parameter 'weekDateId' is set - if &weekDateId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'weekDateId' when calling WorkforceManagementApi->PostWorkforcemanagementManagementunitWeekShifttrades") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling WorkforceManagementApi->PostWorkforcemanagementManagementunitWeekShifttrades") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Shifttraderesponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostWorkforcemanagementManagementunitWeekShifttradesSearch invokes POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/search -// -// Searches for potential shift trade matches for the current agent -// -// -func (a WorkforceManagementApi) PostWorkforcemanagementManagementunitWeekShifttradesSearch(managementUnitId string, weekDateId time.Time, body Searchshifttradesrequest) (*Searchshifttradesresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/search" - path = strings.Replace(path, "{managementUnitId}", fmt.Sprintf("%v", managementUnitId), -1) - path = strings.Replace(path, "{weekDateId}", fmt.Sprintf("%v", weekDateId), -1) - defaultReturn := new(Searchshifttradesresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'managementUnitId' is set - if &managementUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'managementUnitId' when calling WorkforceManagementApi->PostWorkforcemanagementManagementunitWeekShifttradesSearch") - } - // verify the required parameter 'weekDateId' is set - if &weekDateId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'weekDateId' when calling WorkforceManagementApi->PostWorkforcemanagementManagementunitWeekShifttradesSearch") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling WorkforceManagementApi->PostWorkforcemanagementManagementunitWeekShifttradesSearch") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Searchshifttradesresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostWorkforcemanagementManagementunitWeekShifttradesStateBulk invokes POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/state/bulk -// -// Updates the state of a batch of shift trades -// -// Admin functionality is not supported with \"mine\". -func (a WorkforceManagementApi) PostWorkforcemanagementManagementunitWeekShifttradesStateBulk(managementUnitId string, weekDateId time.Time, body Bulkshifttradestateupdaterequest, forceAsync bool) (*Bulkupdateshifttradestateresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/state/bulk" - path = strings.Replace(path, "{managementUnitId}", fmt.Sprintf("%v", managementUnitId), -1) - path = strings.Replace(path, "{weekDateId}", fmt.Sprintf("%v", weekDateId), -1) - defaultReturn := new(Bulkupdateshifttradestateresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'managementUnitId' is set - if &managementUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'managementUnitId' when calling WorkforceManagementApi->PostWorkforcemanagementManagementunitWeekShifttradesStateBulk") - } - // verify the required parameter 'weekDateId' is set - if &weekDateId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'weekDateId' when calling WorkforceManagementApi->PostWorkforcemanagementManagementunitWeekShifttradesStateBulk") - } - // verify the required parameter 'body' is set - if &body == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling WorkforceManagementApi->PostWorkforcemanagementManagementunitWeekShifttradesStateBulk") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(forceAsync).(string); ok { - if str != "" { - queryParams["forceAsync"] = a.Configuration.APIClient.ParameterToString(forceAsync, collectionFormat) - } - } else { - queryParams["forceAsync"] = a.Configuration.APIClient.ParameterToString(forceAsync, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Bulkupdateshifttradestateresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostWorkforcemanagementManagementunitWorkplanCopy invokes POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/copy -// -// Create a copy of work plan -// -// -func (a WorkforceManagementApi) PostWorkforcemanagementManagementunitWorkplanCopy(managementUnitId string, workPlanId string, body Copyworkplan) (*Workplan, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/copy" - path = strings.Replace(path, "{managementUnitId}", fmt.Sprintf("%v", managementUnitId), -1) - path = strings.Replace(path, "{workPlanId}", fmt.Sprintf("%v", workPlanId), -1) - defaultReturn := new(Workplan) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'managementUnitId' is set - if &managementUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'managementUnitId' when calling WorkforceManagementApi->PostWorkforcemanagementManagementunitWorkplanCopy") - } - // verify the required parameter 'workPlanId' is set - if &workPlanId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'workPlanId' when calling WorkforceManagementApi->PostWorkforcemanagementManagementunitWorkplanCopy") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Workplan - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostWorkforcemanagementManagementunitWorkplanValidate invokes POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/validate -// -// Validate Work Plan -// -// -func (a WorkforceManagementApi) PostWorkforcemanagementManagementunitWorkplanValidate(managementUnitId string, workPlanId string, body Workplanvalidationrequest, expand []string) (*Validateworkplanresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/validate" - path = strings.Replace(path, "{managementUnitId}", fmt.Sprintf("%v", managementUnitId), -1) - path = strings.Replace(path, "{workPlanId}", fmt.Sprintf("%v", workPlanId), -1) - defaultReturn := new(Validateworkplanresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'managementUnitId' is set - if &managementUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'managementUnitId' when calling WorkforceManagementApi->PostWorkforcemanagementManagementunitWorkplanValidate") - } - // verify the required parameter 'workPlanId' is set - if &workPlanId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'workPlanId' when calling WorkforceManagementApi->PostWorkforcemanagementManagementunitWorkplanValidate") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - collectionFormat = "multi" - if collectionFormat == "multi" { - for _, value := range expand { - queryParams["expand"] = value - } - } else { - queryParams["expand"] = a.Configuration.APIClient.ParameterToString(expand, collectionFormat) - } - - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Validateworkplanresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostWorkforcemanagementManagementunitWorkplanrotationCopy invokes POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}/copy -// -// Create a copy of work plan rotation -// -// -func (a WorkforceManagementApi) PostWorkforcemanagementManagementunitWorkplanrotationCopy(managementUnitId string, workPlanRotationId string, body Copyworkplanrotationrequest) (*Workplanrotationresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}/copy" - path = strings.Replace(path, "{managementUnitId}", fmt.Sprintf("%v", managementUnitId), -1) - path = strings.Replace(path, "{workPlanRotationId}", fmt.Sprintf("%v", workPlanRotationId), -1) - defaultReturn := new(Workplanrotationresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'managementUnitId' is set - if &managementUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'managementUnitId' when calling WorkforceManagementApi->PostWorkforcemanagementManagementunitWorkplanrotationCopy") - } - // verify the required parameter 'workPlanRotationId' is set - if &workPlanRotationId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'workPlanRotationId' when calling WorkforceManagementApi->PostWorkforcemanagementManagementunitWorkplanrotationCopy") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Workplanrotationresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostWorkforcemanagementManagementunitWorkplanrotations invokes POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations -// -// Create a new work plan rotation -// -// -func (a WorkforceManagementApi) PostWorkforcemanagementManagementunitWorkplanrotations(managementUnitId string, body Addworkplanrotationrequest) (*Workplanrotationresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations" - path = strings.Replace(path, "{managementUnitId}", fmt.Sprintf("%v", managementUnitId), -1) - defaultReturn := new(Workplanrotationresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'managementUnitId' is set - if &managementUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'managementUnitId' when calling WorkforceManagementApi->PostWorkforcemanagementManagementunitWorkplanrotations") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Workplanrotationresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostWorkforcemanagementManagementunitWorkplans invokes POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans -// -// Create a new work plan -// -// -func (a WorkforceManagementApi) PostWorkforcemanagementManagementunitWorkplans(managementUnitId string, body Createworkplan, validationMode string) (*Workplan, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans" - path = strings.Replace(path, "{managementUnitId}", fmt.Sprintf("%v", managementUnitId), -1) - defaultReturn := new(Workplan) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - // verify the required parameter 'managementUnitId' is set - if &managementUnitId == nil { - // - return defaultReturn, nil, errors.New("Missing required parameter 'managementUnitId' when calling WorkforceManagementApi->PostWorkforcemanagementManagementunitWorkplans") - } - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(validationMode).(string); ok { - if str != "" { - queryParams["validationMode"] = a.Configuration.APIClient.ParameterToString(validationMode, collectionFormat) - } - } else { - queryParams["validationMode"] = a.Configuration.APIClient.ParameterToString(validationMode, collectionFormat) - } - - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Workplan - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostWorkforcemanagementManagementunits invokes POST /api/v2/workforcemanagement/managementunits -// -// Add a management unit -// -// It may take a minute or two for a new management unit to be available for api operations -func (a WorkforceManagementApi) PostWorkforcemanagementManagementunits(body Createmanagementunitapirequest) (*Managementunit, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/managementunits" - defaultReturn := new(Managementunit) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Managementunit - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostWorkforcemanagementNotificationsUpdate invokes POST /api/v2/workforcemanagement/notifications/update -// -// Mark a list of notifications as read or unread -// -// -func (a WorkforceManagementApi) PostWorkforcemanagementNotificationsUpdate(body Updatenotificationsrequest) (*Updatenotificationsresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/notifications/update" - defaultReturn := new(Updatenotificationsresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Updatenotificationsresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostWorkforcemanagementSchedules invokes POST /api/v2/workforcemanagement/schedules -// -// Get published schedule for the current user -// -// -func (a WorkforceManagementApi) PostWorkforcemanagementSchedules(body Currentuserschedulerequestbody) (*Userschedulecontainer, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/schedules" - defaultReturn := new(Userschedulecontainer) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Userschedulecontainer - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - -// PostWorkforcemanagementTimeoffrequests invokes POST /api/v2/workforcemanagement/timeoffrequests -// -// Create a time off request for the current user -// -// -func (a WorkforceManagementApi) PostWorkforcemanagementTimeoffrequests(body Createagenttimeoffrequest) (*Timeoffrequestresponse, *APIResponse, error) { - var httpMethod = "POST" - // create path and map variables - path := a.Configuration.BasePath + "/api/v2/workforcemanagement/timeoffrequests" - defaultReturn := new(Timeoffrequestresponse) - if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") - } - - - headerParams := make(map[string]string) - queryParams := make(map[string]string) - formParams := url.Values{} - var postBody interface{} - var postFileName string - var fileBytes []byte - // authentication (PureCloud OAuth) required - - // oauth required - if a.Configuration.AccessToken != ""{ - headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken - } - // add default headers if any - for key := range a.Configuration.DefaultHeader { - headerParams[key] = a.Configuration.DefaultHeader[key] - } - - - // to determine the Content-Type header - localVarHttpContentTypes := []string{ "application/json", } - - // set Content-Type header - localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) - if localVarHttpContentType != "" { - headerParams["Content-Type"] = localVarHttpContentType - } - // to determine the Accept header - localVarHttpHeaderAccepts := []string{ - "application/json", - } - - // set Accept header - localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) - if localVarHttpHeaderAccept != "" { - headerParams["Accept"] = localVarHttpHeaderAccept - } - // body params - postBody = &body - - var successPayload *Timeoffrequestresponse - response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) - if err != nil { - // Nothing special to do here, but do avoid processing the response - } else if err == nil && response.Error != nil { - err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) - } - return successPayload, response, err -} - diff --git a/build/platformclientv2/workplan.go b/build/platformclientv2/workplan.go deleted file mode 100644 index b2a2171ab..000000000 --- a/build/platformclientv2/workplan.go +++ /dev/null @@ -1,93 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Workplan - Work plan information -type Workplan struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Enabled - Whether the work plan is enabled for scheduling - Enabled *bool `json:"enabled,omitempty"` - - - // ConstrainWeeklyPaidTime - Whether the weekly paid time constraint is enabled for this work plan - ConstrainWeeklyPaidTime *bool `json:"constrainWeeklyPaidTime,omitempty"` - - - // FlexibleWeeklyPaidTime - Whether the weekly paid time constraint is flexible for this work plan - FlexibleWeeklyPaidTime *bool `json:"flexibleWeeklyPaidTime,omitempty"` - - - // WeeklyExactPaidMinutes - Exact weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == false - WeeklyExactPaidMinutes *int `json:"weeklyExactPaidMinutes,omitempty"` - - - // WeeklyMinimumPaidMinutes - Minimum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true - WeeklyMinimumPaidMinutes *int `json:"weeklyMinimumPaidMinutes,omitempty"` - - - // WeeklyMaximumPaidMinutes - Maximum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true - WeeklyMaximumPaidMinutes *int `json:"weeklyMaximumPaidMinutes,omitempty"` - - - // ConstrainPaidTimeGranularity - Whether paid time granularity is constrained for this workplan - ConstrainPaidTimeGranularity *bool `json:"constrainPaidTimeGranularity,omitempty"` - - - // PaidTimeGranularityMinutes - Granularity in minutes allowed for shift paid time in this work plan. Used if constrainPaidTimeGranularity == true - PaidTimeGranularityMinutes *int `json:"paidTimeGranularityMinutes,omitempty"` - - - // ConstrainMinimumTimeBetweenShifts - Whether the minimum time between shifts constraint is enabled for this work plan - ConstrainMinimumTimeBetweenShifts *bool `json:"constrainMinimumTimeBetweenShifts,omitempty"` - - - // MinimumTimeBetweenShiftsMinutes - Minimum time between shifts in minutes defined in this work plan. Used if constrainMinimumTimeBetweenShifts == true - MinimumTimeBetweenShiftsMinutes *int `json:"minimumTimeBetweenShiftsMinutes,omitempty"` - - - // MaximumDays - Maximum number days in a week allowed to be scheduled for this work plan - MaximumDays *int `json:"maximumDays,omitempty"` - - - // MinimumWorkingDaysPerWeek - The minimum number of days that agents assigned to a work plan must work per week - MinimumWorkingDaysPerWeek *int `json:"minimumWorkingDaysPerWeek,omitempty"` - - - // OptionalDays - Optional days to schedule for this work plan - OptionalDays *Setwrapperdayofweek `json:"optionalDays,omitempty"` - - - // ShiftStartVariances - Variance in minutes among start times of shifts in this work plan - ShiftStartVariances *Listwrappershiftstartvariance `json:"shiftStartVariances,omitempty"` - - - // Shifts - Shifts in this work plan - Shifts *[]Workplanshift `json:"shifts,omitempty"` - - - // Agents - Agents in this work plan - Agents *[]Deletableuserreference `json:"agents,omitempty"` - - - // Metadata - Version metadata for this work plan - Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Workplan) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/workplanactivity.go b/build/platformclientv2/workplanactivity.go deleted file mode 100644 index e104c4763..000000000 --- a/build/platformclientv2/workplanactivity.go +++ /dev/null @@ -1,65 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Workplanactivity - Activity configured for shift in work plan -type Workplanactivity struct { - // ActivityCodeId - ID of the activity code associated with this activity - ActivityCodeId *string `json:"activityCodeId,omitempty"` - - - // Description - Description of the activity - Description *string `json:"description,omitempty"` - - - // LengthMinutes - Length of the activity in minutes - LengthMinutes *int `json:"lengthMinutes,omitempty"` - - - // StartTimeIsRelativeToShiftStart - Whether the start time of the activity is relative to the start time of the shift it belongs to - StartTimeIsRelativeToShiftStart *bool `json:"startTimeIsRelativeToShiftStart,omitempty"` - - - // FlexibleStartTime - Whether the start time of the activity is flexible - FlexibleStartTime *bool `json:"flexibleStartTime,omitempty"` - - - // EarliestStartTimeMinutes - Earliest activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == true - EarliestStartTimeMinutes *int `json:"earliestStartTimeMinutes,omitempty"` - - - // LatestStartTimeMinutes - Latest activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == true - LatestStartTimeMinutes *int `json:"latestStartTimeMinutes,omitempty"` - - - // ExactStartTimeMinutes - Exact activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == false - ExactStartTimeMinutes *int `json:"exactStartTimeMinutes,omitempty"` - - - // StartTimeIncrementMinutes - Increment in offset minutes that would contribute to different possible start times for the activity - StartTimeIncrementMinutes *int `json:"startTimeIncrementMinutes,omitempty"` - - - // CountsAsPaidTime - Whether the activity is paid - CountsAsPaidTime *bool `json:"countsAsPaidTime,omitempty"` - - - // CountsAsContiguousWorkTime - Whether the activity duration is counted towards contiguous work time - CountsAsContiguousWorkTime *bool `json:"countsAsContiguousWorkTime,omitempty"` - - - // Id - ID of the activity. This is required only for the case of updating an existing activity - Id *string `json:"id,omitempty"` - - - // Delete - If marked true for updating an existing activity, the activity will be permanently deleted - Delete *bool `json:"delete,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Workplanactivity) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/workplanconfigurationviolationmessage.go b/build/platformclientv2/workplanconfigurationviolationmessage.go deleted file mode 100644 index 184781c90..000000000 --- a/build/platformclientv2/workplanconfigurationviolationmessage.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Workplanconfigurationviolationmessage -type Workplanconfigurationviolationmessage struct { - // VarType - Type of configuration violation message for this work plan - VarType *string `json:"type,omitempty"` - - - // Arguments - Arguments of the message that provide information about the misconfigured value or the threshold that is exceeded by the misconfigured value - Arguments *[]Workplanvalidationmessageargument `json:"arguments,omitempty"` - - - // Severity - Severity of the message. A message with Error severity indicates the scheduler won't be able to produce schedules and thus the work plan is invalid. - Severity *string `json:"severity,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Workplanconfigurationviolationmessage) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/workplanconstraintconflictmessage.go b/build/platformclientv2/workplanconstraintconflictmessage.go deleted file mode 100644 index d42f2666a..000000000 --- a/build/platformclientv2/workplanconstraintconflictmessage.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Workplanconstraintconflictmessage -type Workplanconstraintconflictmessage struct { - // VarType - Type of constraint conflict that can be resolved by clients in order to generate agent schedules - VarType *string `json:"type,omitempty"` - - - // Arguments - The arguments to the type of the message that can help clients resolve validation issues - Arguments *[]Workplanvalidationmessageargument `json:"arguments,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Workplanconstraintconflictmessage) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/workplanconstraintmessage.go b/build/platformclientv2/workplanconstraintmessage.go deleted file mode 100644 index ccfbea7d7..000000000 --- a/build/platformclientv2/workplanconstraintmessage.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Workplanconstraintmessage -type Workplanconstraintmessage struct { - // VarType - Type of the work plan constraint in this message - VarType *string `json:"type,omitempty"` - - - // Arguments - Arguments of the message that provide information about the constraint that is being conflicted with, such as the value of the constraint - Arguments *[]Workplanvalidationmessageargument `json:"arguments,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Workplanconstraintmessage) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/workplanlistitemresponse.go b/build/platformclientv2/workplanlistitemresponse.go deleted file mode 100644 index 2c3e7c4a4..000000000 --- a/build/platformclientv2/workplanlistitemresponse.go +++ /dev/null @@ -1,97 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Workplanlistitemresponse - Work plan information -type Workplanlistitemresponse struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Enabled - Whether the work plan is enabled for scheduling - Enabled *bool `json:"enabled,omitempty"` - - - // ConstrainWeeklyPaidTime - Whether the weekly paid time constraint is enabled for this work plan - ConstrainWeeklyPaidTime *bool `json:"constrainWeeklyPaidTime,omitempty"` - - - // FlexibleWeeklyPaidTime - Whether the weekly paid time constraint is flexible for this work plan - FlexibleWeeklyPaidTime *bool `json:"flexibleWeeklyPaidTime,omitempty"` - - - // WeeklyExactPaidMinutes - Exact weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == false - WeeklyExactPaidMinutes *int `json:"weeklyExactPaidMinutes,omitempty"` - - - // WeeklyMinimumPaidMinutes - Minimum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true - WeeklyMinimumPaidMinutes *int `json:"weeklyMinimumPaidMinutes,omitempty"` - - - // WeeklyMaximumPaidMinutes - Maximum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true - WeeklyMaximumPaidMinutes *int `json:"weeklyMaximumPaidMinutes,omitempty"` - - - // ConstrainPaidTimeGranularity - Whether paid time granularity is constrained for this workplan - ConstrainPaidTimeGranularity *bool `json:"constrainPaidTimeGranularity,omitempty"` - - - // PaidTimeGranularityMinutes - Granularity in minutes allowed for shift paid time in this work plan. Used if constrainPaidTimeGranularity == true - PaidTimeGranularityMinutes *int `json:"paidTimeGranularityMinutes,omitempty"` - - - // ConstrainMinimumTimeBetweenShifts - Whether the minimum time between shifts constraint is enabled for this work plan - ConstrainMinimumTimeBetweenShifts *bool `json:"constrainMinimumTimeBetweenShifts,omitempty"` - - - // MinimumTimeBetweenShiftsMinutes - Minimum time between shifts in minutes defined in this work plan. Used if constrainMinimumTimeBetweenShifts == true - MinimumTimeBetweenShiftsMinutes *int `json:"minimumTimeBetweenShiftsMinutes,omitempty"` - - - // MaximumDays - Maximum number days in a week allowed to be scheduled for this work plan - MaximumDays *int `json:"maximumDays,omitempty"` - - - // MinimumWorkingDaysPerWeek - The minimum number of days that agents assigned to a work plan must work per week - MinimumWorkingDaysPerWeek *int `json:"minimumWorkingDaysPerWeek,omitempty"` - - - // OptionalDays - Optional days to schedule for this work plan. Populate with expand=details - OptionalDays *Setwrapperdayofweek `json:"optionalDays,omitempty"` - - - // ShiftStartVariances - Variance in minutes among start times of shifts in this work plan. Populate with expand=details - ShiftStartVariances *Listwrappershiftstartvariance `json:"shiftStartVariances,omitempty"` - - - // Shifts - Shifts in this work plan. Populate with expand=details (defaults to empty list) - Shifts *[]Workplanshift `json:"shifts,omitempty"` - - - // Agents - Agents in this work plan. Populate with expand=details (defaults to empty list) - Agents *[]Deletableuserreference `json:"agents,omitempty"` - - - // Metadata - Version metadata for this work plan - Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"` - - - // AgentCount - Number of agents in this work plan. Populate with expand=agentCount - AgentCount *int `json:"agentCount,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Workplanlistitemresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/workplanlistresponse.go b/build/platformclientv2/workplanlistresponse.go deleted file mode 100644 index ae4281257..000000000 --- a/build/platformclientv2/workplanlistresponse.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Workplanlistresponse -type Workplanlistresponse struct { - // Entities - Entities *[]Workplanlistitemresponse `json:"entities,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Workplanlistresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/workplanpatternrequest.go b/build/platformclientv2/workplanpatternrequest.go deleted file mode 100644 index 22f67ed6a..000000000 --- a/build/platformclientv2/workplanpatternrequest.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Workplanpatternrequest -type Workplanpatternrequest struct { - // WorkPlanIds - List of work plan IDs in order of rotation on a weekly basis. Values in the list cannot be null or empty - WorkPlanIds *[]string `json:"workPlanIds,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Workplanpatternrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/workplanpatternresponse.go b/build/platformclientv2/workplanpatternresponse.go deleted file mode 100644 index 8f068b6bd..000000000 --- a/build/platformclientv2/workplanpatternresponse.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Workplanpatternresponse -type Workplanpatternresponse struct { - // WorkPlans - List of work plans in order of rotation on a weekly basis - WorkPlans *[]Workplanreference `json:"workPlans,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Workplanpatternresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/workplanreference.go b/build/platformclientv2/workplanreference.go deleted file mode 100644 index 9d85ff335..000000000 --- a/build/platformclientv2/workplanreference.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Workplanreference - Work plan information -type Workplanreference struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // ManagementUnit - The management unit to which this work plan belongs. Nullable in some routes - ManagementUnit *Managementunitreference `json:"managementUnit,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Workplanreference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/workplanrotationagentresponse.go b/build/platformclientv2/workplanrotationagentresponse.go deleted file mode 100644 index 957f5e809..000000000 --- a/build/platformclientv2/workplanrotationagentresponse.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Workplanrotationagentresponse -type Workplanrotationagentresponse struct { - // User - The user associated with this work plan rotation - User *Userreference `json:"user,omitempty"` - - - // DateRange - The date range to which this agent is effective in the work plan rotation - DateRange *Daterangewithoptionalend `json:"dateRange,omitempty"` - - - // Position - Start position of the work plan in the pattern for this agent in the work plan rotation. Position value starts from 0 - Position *int `json:"position,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Workplanrotationagentresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/workplanrotationlistresponse.go b/build/platformclientv2/workplanrotationlistresponse.go deleted file mode 100644 index 5110f6915..000000000 --- a/build/platformclientv2/workplanrotationlistresponse.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Workplanrotationlistresponse -type Workplanrotationlistresponse struct { - // Entities - Entities *[]Workplanrotationresponse `json:"entities,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Workplanrotationlistresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/workplanrotationreference.go b/build/platformclientv2/workplanrotationreference.go deleted file mode 100644 index 4b2b7a221..000000000 --- a/build/platformclientv2/workplanrotationreference.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Workplanrotationreference -type Workplanrotationreference struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Workplanrotationreference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/workplanrotationresponse.go b/build/platformclientv2/workplanrotationresponse.go deleted file mode 100644 index 615eb5048..000000000 --- a/build/platformclientv2/workplanrotationresponse.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Workplanrotationresponse -type Workplanrotationresponse struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Enabled - Whether the work plan rotation is enabled for scheduling - Enabled *bool `json:"enabled,omitempty"` - - - // DateRange - The date range to which this work plan rotation applies - DateRange *Daterangewithoptionalend `json:"dateRange,omitempty"` - - - // Pattern - Pattern with ordered list of work plans that rotate on a weekly basis - Pattern *Workplanpatternresponse `json:"pattern,omitempty"` - - - // AgentCount - Number of agents in this work plan rotation - AgentCount *int `json:"agentCount,omitempty"` - - - // Agents - Agents in this work plan rotation. Populate with expand=agents for GET WorkPlanRotationsList (defaults to empty list) - Agents *[]Workplanrotationagentresponse `json:"agents,omitempty"` - - - // Metadata - Version metadata for this work plan rotation - Metadata *Wfmversionedentitymetadata `json:"metadata,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Workplanrotationresponse) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/workplanshift.go b/build/platformclientv2/workplanshift.go deleted file mode 100644 index e8b90a397..000000000 --- a/build/platformclientv2/workplanshift.go +++ /dev/null @@ -1,93 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Workplanshift - Shift in a work plan -type Workplanshift struct { - // Name - Name of the shift - Name *string `json:"name,omitempty"` - - - // Days - Days of the week applicable for this shift - Days *Setwrapperdayofweek `json:"days,omitempty"` - - - // FlexibleStartTime - Whether the start time of the shift is flexible - FlexibleStartTime *bool `json:"flexibleStartTime,omitempty"` - - - // ExactStartTimeMinutesFromMidnight - Exact start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == false - ExactStartTimeMinutesFromMidnight *int `json:"exactStartTimeMinutesFromMidnight,omitempty"` - - - // EarliestStartTimeMinutesFromMidnight - Earliest start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == true - EarliestStartTimeMinutesFromMidnight *int `json:"earliestStartTimeMinutesFromMidnight,omitempty"` - - - // LatestStartTimeMinutesFromMidnight - Latest start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == true - LatestStartTimeMinutesFromMidnight *int `json:"latestStartTimeMinutesFromMidnight,omitempty"` - - - // ConstrainStopTime - Whether the latest stop time constraint for the shift is enabled. Deprecated, use constrainLatestStopTime instead - ConstrainStopTime *bool `json:"constrainStopTime,omitempty"` - - - // ConstrainLatestStopTime - Whether the latest stop time constraint for the shift is enabled - ConstrainLatestStopTime *bool `json:"constrainLatestStopTime,omitempty"` - - - // LatestStopTimeMinutesFromMidnight - Latest stop time of the shift defined as offset minutes from midnight. Used if constrainStopTime == true - LatestStopTimeMinutesFromMidnight *int `json:"latestStopTimeMinutesFromMidnight,omitempty"` - - - // StartIncrementMinutes - Increment in offset minutes that would contribute to different possible start times for the shift. Used if flexibleStartTime == true - StartIncrementMinutes *int `json:"startIncrementMinutes,omitempty"` - - - // FlexiblePaidTime - Whether the paid time setting for the shift is flexible - FlexiblePaidTime *bool `json:"flexiblePaidTime,omitempty"` - - - // ExactPaidTimeMinutes - Exact paid time in minutes configured for the shift. Used if flexiblePaidTime == false - ExactPaidTimeMinutes *int `json:"exactPaidTimeMinutes,omitempty"` - - - // MinimumPaidTimeMinutes - Minimum paid time in minutes configured for the shift. Used if flexiblePaidTime == true - MinimumPaidTimeMinutes *int `json:"minimumPaidTimeMinutes,omitempty"` - - - // MaximumPaidTimeMinutes - Maximum paid time in minutes configured for the shift. Used if flexiblePaidTime == true - MaximumPaidTimeMinutes *int `json:"maximumPaidTimeMinutes,omitempty"` - - - // ConstrainContiguousWorkTime - Whether the contiguous time constraint for the shift is enabled - ConstrainContiguousWorkTime *bool `json:"constrainContiguousWorkTime,omitempty"` - - - // MinimumContiguousWorkTimeMinutes - Minimum contiguous time in minutes configured for the shift. Used if constrainContiguousWorkTime == true - MinimumContiguousWorkTimeMinutes *int `json:"minimumContiguousWorkTimeMinutes,omitempty"` - - - // MaximumContiguousWorkTimeMinutes - Maximum contiguous time in minutes configured for the shift. Used if constrainContiguousWorkTime == true - MaximumContiguousWorkTimeMinutes *int `json:"maximumContiguousWorkTimeMinutes,omitempty"` - - - // Activities - Activities configured for this shift - Activities *[]Workplanactivity `json:"activities,omitempty"` - - - // Id - ID of the shift. This is required only for the case of updating an existing shift - Id *string `json:"id,omitempty"` - - - // Delete - If marked true for updating an existing shift, the shift will be permanently deleted - Delete *bool `json:"delete,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Workplanshift) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/workplanvalidationmessageargument.go b/build/platformclientv2/workplanvalidationmessageargument.go deleted file mode 100644 index 20d484886..000000000 --- a/build/platformclientv2/workplanvalidationmessageargument.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Workplanvalidationmessageargument -type Workplanvalidationmessageargument struct { - // VarType - The type of the argument associated with violation messages - VarType *string `json:"type,omitempty"` - - - // Value - The value of the argument - Value *string `json:"value,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Workplanvalidationmessageargument) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/workplanvalidationrequest.go b/build/platformclientv2/workplanvalidationrequest.go deleted file mode 100644 index b75a2597a..000000000 --- a/build/platformclientv2/workplanvalidationrequest.go +++ /dev/null @@ -1,89 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Workplanvalidationrequest - Work plan information -type Workplanvalidationrequest struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Enabled - Whether the work plan is enabled for scheduling - Enabled *bool `json:"enabled,omitempty"` - - - // ConstrainWeeklyPaidTime - Whether the weekly paid time constraint is enabled for this work plan - ConstrainWeeklyPaidTime *bool `json:"constrainWeeklyPaidTime,omitempty"` - - - // FlexibleWeeklyPaidTime - Whether the weekly paid time constraint is flexible for this work plan - FlexibleWeeklyPaidTime *bool `json:"flexibleWeeklyPaidTime,omitempty"` - - - // WeeklyExactPaidMinutes - Exact weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == false - WeeklyExactPaidMinutes *int `json:"weeklyExactPaidMinutes,omitempty"` - - - // WeeklyMinimumPaidMinutes - Minimum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true - WeeklyMinimumPaidMinutes *int `json:"weeklyMinimumPaidMinutes,omitempty"` - - - // WeeklyMaximumPaidMinutes - Maximum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true - WeeklyMaximumPaidMinutes *int `json:"weeklyMaximumPaidMinutes,omitempty"` - - - // ConstrainPaidTimeGranularity - Whether paid time granularity is constrained for this workplan - ConstrainPaidTimeGranularity *bool `json:"constrainPaidTimeGranularity,omitempty"` - - - // PaidTimeGranularityMinutes - Granularity in minutes allowed for shift paid time in this work plan. Used if constrainPaidTimeGranularity == true - PaidTimeGranularityMinutes *int `json:"paidTimeGranularityMinutes,omitempty"` - - - // ConstrainMinimumTimeBetweenShifts - Whether the minimum time between shifts constraint is enabled for this work plan - ConstrainMinimumTimeBetweenShifts *bool `json:"constrainMinimumTimeBetweenShifts,omitempty"` - - - // MinimumTimeBetweenShiftsMinutes - Minimum time between shifts in minutes defined in this work plan. Used if constrainMinimumTimeBetweenShifts == true - MinimumTimeBetweenShiftsMinutes *int `json:"minimumTimeBetweenShiftsMinutes,omitempty"` - - - // MaximumDays - Maximum number days in a week allowed to be scheduled for this work plan - MaximumDays *int `json:"maximumDays,omitempty"` - - - // MinimumWorkingDaysPerWeek - The minimum number of days that agents assigned to a work plan must work per week - MinimumWorkingDaysPerWeek *int `json:"minimumWorkingDaysPerWeek,omitempty"` - - - // OptionalDays - Optional days to schedule for this work plan - OptionalDays *Setwrapperdayofweek `json:"optionalDays,omitempty"` - - - // ShiftStartVariances - Variance in minutes among start times of shifts in this work plan - ShiftStartVariances *Listwrappershiftstartvariance `json:"shiftStartVariances,omitempty"` - - - // Shifts - Shifts in this work plan - Shifts *[]Workplanshift `json:"shifts,omitempty"` - - - // Agents - Agents in this work plan - Agents *[]Deletableuserreference `json:"agents,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Workplanvalidationrequest) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/workspace.go b/build/platformclientv2/workspace.go deleted file mode 100644 index 1c072417c..000000000 --- a/build/platformclientv2/workspace.go +++ /dev/null @@ -1,62 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Workspace -type Workspace struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - The current name of the workspace. - Name *string `json:"name,omitempty"` - - - // VarType - VarType *string `json:"type,omitempty"` - - - // IsCurrentUserWorkspace - IsCurrentUserWorkspace *bool `json:"isCurrentUserWorkspace,omitempty"` - - - // User - User *Domainentityref `json:"user,omitempty"` - - - // Bucket - Bucket *string `json:"bucket,omitempty"` - - - // DateCreated - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // Summary - Summary *Workspacesummary `json:"summary,omitempty"` - - - // Acl - Acl *[]string `json:"acl,omitempty"` - - - // Description - Description *string `json:"description,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Workspace) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/workspacecreate.go b/build/platformclientv2/workspacecreate.go deleted file mode 100644 index 450e9766a..000000000 --- a/build/platformclientv2/workspacecreate.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Workspacecreate -type Workspacecreate struct { - // Name - The workspace name - Name *string `json:"name,omitempty"` - - - // Bucket - Bucket *string `json:"bucket,omitempty"` - - - // Description - Description *string `json:"description,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Workspacecreate) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/workspaceentitylisting.go b/build/platformclientv2/workspaceentitylisting.go deleted file mode 100644 index 4c21f6e56..000000000 --- a/build/platformclientv2/workspaceentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Workspaceentitylisting -type Workspaceentitylisting struct { - // Entities - Entities *[]Workspace `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Workspaceentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/workspacemember.go b/build/platformclientv2/workspacemember.go deleted file mode 100644 index e6790c41e..000000000 --- a/build/platformclientv2/workspacemember.go +++ /dev/null @@ -1,49 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Workspacemember -type Workspacemember struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // Workspace - Workspace *Domainentityref `json:"workspace,omitempty"` - - - // MemberType - The workspace member type. - MemberType *string `json:"memberType,omitempty"` - - - // Member - Member *Domainentityref `json:"member,omitempty"` - - - // User - User *User `json:"user,omitempty"` - - - // Group - Group *Group `json:"group,omitempty"` - - - // SecurityProfile - SecurityProfile *Securityprofile `json:"securityProfile,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Workspacemember) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/workspacememberentitylisting.go b/build/platformclientv2/workspacememberentitylisting.go deleted file mode 100644 index d7a029ebd..000000000 --- a/build/platformclientv2/workspacememberentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Workspacememberentitylisting -type Workspacememberentitylisting struct { - // Entities - Entities *[]Workspacemember `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Workspacememberentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/workspacesummary.go b/build/platformclientv2/workspacesummary.go deleted file mode 100644 index 458b34739..000000000 --- a/build/platformclientv2/workspacesummary.go +++ /dev/null @@ -1,21 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Workspacesummary -type Workspacesummary struct { - // TotalDocumentCount - TotalDocumentCount *int `json:"totalDocumentCount,omitempty"` - - - // TotalDocumentByteCount - TotalDocumentByteCount *int `json:"totalDocumentByteCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Workspacesummary) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wrapup.go b/build/platformclientv2/wrapup.go deleted file mode 100644 index f62bf8923..000000000 --- a/build/platformclientv2/wrapup.go +++ /dev/null @@ -1,42 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Wrapup -type Wrapup struct { - // Code - The user configured wrap up code id. - Code *string `json:"code,omitempty"` - - - // Name - The user configured wrap up code name. - Name *string `json:"name,omitempty"` - - - // Notes - Text entered by the agent to describe the call or disposition. - Notes *string `json:"notes,omitempty"` - - - // Tags - List of tags selected by the agent to describe the call or disposition. - Tags *[]string `json:"tags,omitempty"` - - - // DurationSeconds - The length of time in seconds that the agent spent doing after call work. - DurationSeconds *int `json:"durationSeconds,omitempty"` - - - // EndTime - The timestamp when the wrapup was finished. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - EndTime *time.Time `json:"endTime,omitempty"` - - - // Provisional - Indicates if this is a pending save and should not require a code to be specified. This allows someone to save some temporary wrapup that will be used later. - Provisional *bool `json:"provisional,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wrapup) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wrapupcodeentitylisting.go b/build/platformclientv2/wrapupcodeentitylisting.go deleted file mode 100644 index ecb7d9628..000000000 --- a/build/platformclientv2/wrapupcodeentitylisting.go +++ /dev/null @@ -1,53 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wrapupcodeentitylisting -type Wrapupcodeentitylisting struct { - // Entities - Entities *[]Wrapupcode `json:"entities,omitempty"` - - - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` - - - // Total - Total *int `json:"total,omitempty"` - - - // FirstUri - FirstUri *string `json:"firstUri,omitempty"` - - - // SelfUri - SelfUri *string `json:"selfUri,omitempty"` - - - // NextUri - NextUri *string `json:"nextUri,omitempty"` - - - // LastUri - LastUri *string `json:"lastUri,omitempty"` - - - // PreviousUri - PreviousUri *string `json:"previousUri,omitempty"` - - - // PageCount - PageCount *int `json:"pageCount,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wrapupcodeentitylisting) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wrapupcodemapping.go b/build/platformclientv2/wrapupcodemapping.go deleted file mode 100644 index 9faa71c12..000000000 --- a/build/platformclientv2/wrapupcodemapping.go +++ /dev/null @@ -1,46 +0,0 @@ -package platformclientv2 -import ( - "time" - "encoding/json" -) - -// Wrapupcodemapping -type Wrapupcodemapping struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // DateCreated - Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` - - - // DateModified - Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` - - - // Version - Required for updates, must match the version number of the most recent update - Version *int `json:"version,omitempty"` - - - // DefaultSet - The default set of wrap-up flags. These will be used if there is no entry for a given wrap-up code in the mapping. - DefaultSet *[]string `json:"defaultSet,omitempty"` - - - // Mapping - A map from wrap-up code identifiers to a set of wrap-up flags. - Mapping *map[string][]string `json:"mapping,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wrapupcodemapping) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/wrapupcodereference.go b/build/platformclientv2/wrapupcodereference.go deleted file mode 100644 index 6d297a0dc..000000000 --- a/build/platformclientv2/wrapupcodereference.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Wrapupcodereference -type Wrapupcodereference struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Wrapupcodereference) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/writabledialercontact.go b/build/platformclientv2/writabledialercontact.go deleted file mode 100644 index 5be4bf685..000000000 --- a/build/platformclientv2/writabledialercontact.go +++ /dev/null @@ -1,33 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Writabledialercontact -type Writabledialercontact struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // ContactListId - The identifier of the contact list containing this contact. - ContactListId *string `json:"contactListId,omitempty"` - - - // Data - An ordered map of the contact's columns and corresponding values. - Data *map[string]interface{} `json:"data,omitempty"` - - - // Callable - Indicates whether or not the contact can be called. - Callable *bool `json:"callable,omitempty"` - - - // PhoneNumberStatus - A map of phone number columns to PhoneNumberStatuses, which indicate if the phone number is callable or not. - PhoneNumberStatus *map[string]Phonenumberstatus `json:"phoneNumberStatus,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Writabledialercontact) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/writabledivision.go b/build/platformclientv2/writabledivision.go deleted file mode 100644 index 85728585f..000000000 --- a/build/platformclientv2/writabledivision.go +++ /dev/null @@ -1,25 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Writabledivision -type Writabledivision struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - - - // Name - Name *string `json:"name,omitempty"` - - - // SelfUri - The URI for this object - SelfUri *string `json:"selfUri,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Writabledivision) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/build/platformclientv2/writableentity.go b/build/platformclientv2/writableentity.go deleted file mode 100644 index eb8f52b11..000000000 --- a/build/platformclientv2/writableentity.go +++ /dev/null @@ -1,17 +0,0 @@ -package platformclientv2 -import ( - "encoding/json" -) - -// Writableentity -type Writableentity struct { - // Id - The globally unique identifier for the object. - Id *string `json:"id,omitempty"` - -} - -// String returns a JSON representation of the model -func (o *Writableentity) String() string { - j, _ := json.Marshal(o) - return string(j) -} diff --git a/docs/index.md b/docs/index.md index 2ba3215c1..f856e77f4 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,7 +4,7 @@ title: Platform API Client SDK - Go A Go package to interface with the Genesys Cloud Platform API. View the documentation on the [pkg.go.dev](https://pkg.go.dev/github.com/MyPureCloud/platform-client-sdk-go/platformclientv2). Browse the source code on [Github](https://github.com/MyPureCloud/platform-client-sdk-go). -Latest version: 33.0.0 [![GitHub release](https://img.shields.io/github/release/mypurecloud/platform-client-sdk-go.svg)]() +Latest version: 34.0.0 [![GitHub release](https://img.shields.io/github/release/mypurecloud/platform-client-sdk-go.svg)]() [![Release Notes Badge](https://developer.mypurecloud.com/images/sdk-release-notes.png)](https://github.com/MyPureCloud/platform-client-sdk-go/blob/master/releaseNotes.md) ## Golang Version Dependency @@ -57,6 +57,27 @@ config := platformclientv2.NewConfiguration() usersAPI := platformclientv2.NewUsersApiWithConfig(config) ``` +#### Retrying and 429 and 5xx response codes and connection errors + +By default, the SDK does not retry 429 and 5xx response codes (except 501) and connection errors. To enable retries, create an instance of the `RetryConfiguration` object and set it on the `Configuration` instance. +The retry logic will respect the `retry-after` header for all 429 status codes. +The `RetryConfiguration` object has 3 properties that determine the retry behaviour and a RequestLogHook which can be used for debugging and tracing retried requests: +* `RetryWaitMin` determines the minimum time to wait +* `RetryWaitMax` determines the maximum time to wait +* `RetryMax` determines the maximum amount of retries +* `RequestLogHook` a callback called on each retried request + +```go +config.RetryConfiguration = &platformclientv2.RetryConfiguration{ + RetryWaitMin: 5 * time.Second, + RetryWaitMax: 60 * time.Second, + RetryMax: 20, + RequestLogHook: func(req *http.Request, retryNumber int) { + fmt.Printf("%v %v request failed. Retry count: %v\n", req.Method, req.URL, retryNumber) + }, +} +``` + #### Setting the environment To connect to regional Genesys Cloud instances, provide the Platform API's base path: @@ -65,6 +86,12 @@ To connect to regional Genesys Cloud instances, provide the Platform API's base config.BasePath = "https://api.mypurecloud.jp" ``` +Alternatively, use the enum mapping for Genesys Cloud regions to API base paths: + +```go +config.BasePath = platformclientv2.APNortheast1 +``` + #### Setting the access token If using a grant other than client credentials and code authorization, the access token can be set manually: diff --git a/docs/releaseNotes.md b/docs/releaseNotes.md index a033c4d37..c2d3c7fcc 100644 --- a/docs/releaseNotes.md +++ b/docs/releaseNotes.md @@ -1,472 +1,398 @@ -Platform API version: 4480 +Platform API version: 4513 -# Major Changes (11 changes) +# Major Changes (8 changes) -**DELETE /api/v2/routing/queues/{queueId}/users/{memberId}** (1 change) +**GET /api/v2/flows/datatables** (1 change) -* Has been deprecated - -**PATCH /api/v2/routing/queues/{queueId}/users/{memberId}** (1 change) - -* Has been deprecated - -**GET /api/v2/notifications/availabletopics** (1 change) - -* Parameter includePreview was added - -**GET /api/v2/routing/queues/{queueId}/users** (1 change) - -* Has been deprecated +* Parameter divisionId was added **POST /api/v2/routing/queues/{queueId}/users** (1 change) -* Has been deprecated +* Response 200 was removed -**PATCH /api/v2/routing/queues/{queueId}/users** (1 change) +**POST /api/v2/conversations/messaging/integrations/facebook** (1 change) -* Has been deprecated +* Parameter async was removed -**Edge** (2 changes) +**POST /api/v2/conversations/messaging/integrations/twitter** (1 change) -* callDrainingState has been made readonly -* conversationCount has been made readonly +* Parameter async was removed -**EntityListing** (1 change) +**POST /api/v2/conversations/messaging/integrations/whatsapp** (1 change) -* Property entities was changed from object[] to DataTableImportJob[] +* Parameter async was removed -**TranscriptAggregateQueryPredicate** (1 change) +**POST /api/v2/routing/queues/{queueId}/members** (1 change) -* Enum value topic was removed from property dimension +* Response 200 was removed -**TranscriptAggregationQuery** (1 change) +**POST /api/v2/conversations/messaging/integrations/line** (1 change) -* Enum value topic was removed from property groupBy +* Parameter async was removed +**SupportedContent** (1 change) -# Minor Changes (141 changes) +* Model SupportedContent was removed -**POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/generate** (1 change) -* Response 502 was added +# Minor Changes (142 changes) -**/api/v2/uploads/workforcemanagement/historicaldata/json** (2 changes) +**/api/v2/speechandtextanalytics/topics/general** (2 changes) * Path was added -* Operation POST was added +* Operation GET was added -**/api/v2/uploads/workforcemanagement/historicaldata/csv** (2 changes) +**/api/v2/speechandtextanalytics/topics/publishjobs/{jobId}** (2 changes) * Path was added -* Operation POST was added +* Operation GET was added -**/api/v2/journey/actiontemplates/{actionTemplateId}** (4 changes) +**/api/v2/speechandtextanalytics/programs/publishjobs/{jobId}** (2 changes) * Path was added * Operation GET was added -* Operation DELETE was added -* Operation PATCH was added -**/api/v2/uploads/recordings** (2 changes) +**/api/v2/speechandtextanalytics/topics** (3 changes) * Path was added +* Operation GET was added * Operation POST was added -**/api/v2/journey/outcomes/{outcomeId}** (4 changes) +**/api/v2/speechandtextanalytics/programs/general/jobs** (2 changes) * Path was added -* Operation GET was added -* Operation DELETE was added -* Operation PATCH was added +* Operation POST was added -**/api/v2/routing/email/domains/{domainId}/validate** (2 changes) +**POST /api/v2/routing/queues/{queueId}/users** (1 change) -* Path was added -* Operation PATCH was added +* Response default was added -**/api/v2/telephony/providers/edges/didpools/dids** (2 changes) +**/api/v2/speechandtextanalytics/programs/general/jobs/{jobId}** (2 changes) * Path was added * Operation GET was added -**GET /api/v2/scim/v2/users/{userId}** (1 change) +**POST /api/v2/routing/queues/{queueId}/members** (1 change) -* Response 409 was added +* Response default was added -**/api/v2/routing/queues/{queueId}/members** (4 changes) +**/api/v2/speechandtextanalytics/programs** (3 changes) * Path was added * Operation GET was added * Operation POST was added -* Operation PATCH was added - -**PUT /api/v2/outbound/schedules/sequences/{sequenceId}** (1 change) -* Response 409 was added +**/api/v2/speechandtextanalytics/dialects** (2 changes) -**POST /api/v2/integrations/actions/{actionId}/execute** (1 change) - -* Response 405 was added +* Path was added +* Operation GET was added -**/api/v2/routing/queues/{queueId}/members/{memberId}** (3 changes) +**/api/v2/speechandtextanalytics/programs/{programId}** (4 changes) * Path was added +* Operation GET was added +* Operation PUT was added * Operation DELETE was added -* Operation PATCH was added -**/api/v2/journey/actiontemplates** (3 changes) +**/api/v2/speechandtextanalytics/topics/publishjobs** (2 changes) * Path was added -* Operation GET was added * Operation POST was added -**/api/v2/journey/actionmaps/{actionMapId}** (4 changes) +**/api/v2/speechandtextanalytics/topics/{topicId}** (4 changes) * Path was added * Operation GET was added +* Operation PUT was added * Operation DELETE was added -* Operation PATCH was added -**/api/v2/journey/actionmaps** (3 changes) +**/api/v2/speechandtextanalytics/programs/publishjobs** (2 changes) * Path was added -* Operation GET was added * Operation POST was added -**/api/v2/journey/outcomes** (3 changes) +**/api/v2/speechandtextanalytics/programs/unpublished** (2 changes) * Path was added * Operation GET was added -* Operation POST was added - -**OrphanRecording** (2 changes) - -* Enum value PUREENGAGE was added to property providerType -* Enum value PURECONNECT was added to property providerType -**AgentActivity** (1 change) - -* Optional property numEvaluationsWithoutViewPermission was added - -**AgentEvaluatorActivity** (1 change) - -* Optional property numEvaluationsWithoutViewPermission was added - -**ReportingExportJobResponse** (4 changes) - -* Enum value AGENT_PERFORMANCE_ME_VIEW was added to property viewType -* Enum value AGENT_STATUS_ME_VIEW was added to property viewType -* Enum value AGENT_EVALUATION_ME_VIEW was added to property viewType -* Enum value NOT_AUTHORIZED_TO_VIEW_EXPORT was added to property exportErrorMessagesType - -**ViewFilter** (6 changes) - -* Optional property developmentRoleList was added -* Optional property developmentTypeList was added -* Optional property developmentStatusList was added -* Optional property developmentModuleIds was added -* Optional property developmentKeyType was added -* Optional property developmentActivityOverdue was added - -**ConversationDetailQueryPredicate** (2 changes) - -* Enum value tCallback was added to property metric -* Enum value tCallbackComplete was added to property metric - -**ReportingExportJobRequest** (3 changes) - -* Enum value AGENT_PERFORMANCE_ME_VIEW was added to property viewType -* Enum value AGENT_STATUS_ME_VIEW was added to property viewType -* Enum value AGENT_EVALUATION_ME_VIEW was added to property viewType - -**ActionTemplate** (1 change) +**SupportedContentReference** (1 change) * Model was added -**CallToAction** (1 change) +**GeneralTopic** (1 change) * Model was added -**CloseButtonStyleProperties** (1 change) +**GeneralTopicsEntityListing** (1 change) * Model was added -**ContentOffer** (1 change) +**DataTable** (1 change) -* Model was added +* Optional property division was added -**ContentOfferStyleProperties** (1 change) +**WorkPlanActivity** (2 changes) -* Model was added +* Optional property minimumLengthFromShiftStartMinutes was added +* Optional property minimumLengthFromShiftEndMinutes was added -**ContentOfferStylingConfiguration** (1 change) +**WorkPlanShift** (2 changes) -* Model was added +* Optional property constrainEarliestStopTime was added +* Optional property earliestStopTimeMinutesFromMidnight was added -**ContentPositionProperties** (1 change) +**WorkPlanValidationRequest** (11 changes) -* Model was added +* Optional property minimumConsecutiveNonWorkingMinutesPerWeek was added +* Optional property constrainMaximumConsecutiveWorkingWeekends was added +* Optional property maximumConsecutiveWorkingWeekends was added +* Optional property constrainMaximumConsecutiveWorkingDays was added +* Optional property maximumConsecutiveWorkingDays was added +* Optional property minimumShiftStartDistanceMinutes was added +* Optional property minimumDaysOffPerPlanningPeriod was added +* Optional property maximumDaysOffPerPlanningPeriod was added +* Optional property minimumPaidMinutesPerPlanningPeriod was added +* Optional property maximumPaidMinutesPerPlanningPeriod was added +* Optional property shiftStartVarianceType was added -**CtaButtonStyleProperties** (1 change) +**WorkPlan** (11 changes) -* Model was added +* Optional property minimumConsecutiveNonWorkingMinutesPerWeek was added +* Optional property constrainMaximumConsecutiveWorkingWeekends was added +* Optional property maximumConsecutiveWorkingWeekends was added +* Optional property constrainMaximumConsecutiveWorkingDays was added +* Optional property maximumConsecutiveWorkingDays was added +* Optional property minimumShiftStartDistanceMinutes was added +* Optional property minimumDaysOffPerPlanningPeriod was added +* Optional property maximumDaysOffPerPlanningPeriod was added +* Optional property minimumPaidMinutesPerPlanningPeriod was added +* Optional property maximumPaidMinutesPerPlanningPeriod was added +* Optional property shiftStartVarianceType was added -**IntegrationAction** (1 change) +**CreateWorkPlan** (11 changes) -* Model was added +* Optional property minimumConsecutiveNonWorkingMinutesPerWeek was added +* Optional property constrainMaximumConsecutiveWorkingWeekends was added +* Optional property maximumConsecutiveWorkingWeekends was added +* Optional property constrainMaximumConsecutiveWorkingDays was added +* Optional property maximumConsecutiveWorkingDays was added +* Optional property minimumShiftStartDistanceMinutes was added +* Optional property minimumDaysOffPerPlanningPeriod was added +* Optional property maximumDaysOffPerPlanningPeriod was added +* Optional property minimumPaidMinutesPerPlanningPeriod was added +* Optional property maximumPaidMinutesPerPlanningPeriod was added +* Optional property shiftStartVarianceType was added -**IntegrationActionFields** (1 change) +**CreateWorkPlanActivity** (2 changes) -* Model was added +* Optional property minimumLengthFromShiftStartMinutes was added +* Optional property minimumLengthFromShiftEndMinutes was added -**RequestMapping** (1 change) +**CreateWorkPlanShift** (2 changes) -* Model was added +* Optional property constrainEarliestStopTime was added +* Optional property earliestStopTimeMinutesFromMidnight was added -**TextStyleProperties** (1 change) +**WorkPlanListItemResponse** (11 changes) -* Model was added +* Optional property minimumConsecutiveNonWorkingMinutesPerWeek was added +* Optional property constrainMaximumConsecutiveWorkingWeekends was added +* Optional property maximumConsecutiveWorkingWeekends was added +* Optional property constrainMaximumConsecutiveWorkingDays was added +* Optional property maximumConsecutiveWorkingDays was added +* Optional property minimumShiftStartDistanceMinutes was added +* Optional property minimumDaysOffPerPlanningPeriod was added +* Optional property maximumDaysOffPerPlanningPeriod was added +* Optional property minimumPaidMinutesPerPlanningPeriod was added +* Optional property maximumPaidMinutesPerPlanningPeriod was added +* Optional property shiftStartVarianceType was added -**PatchActionTemplate** (1 change) +**ManagementUnit** (1 change) -* Model was added +* Optional property businessUnit was added -**PatchCallToAction** (1 change) +**SchedulingSettingsResponse** (2 changes) -* Model was added +* Optional property planningPeriod was added +* Optional property startDayOfWeekend was added -**PatchCloseButtonStyleProperties** (1 change) +**BaseTopicEntitiy** (1 change) * Model was added -**PatchContentOffer** (1 change) +**TopicJob** (1 change) * Model was added -**PatchContentOfferStyleProperties** (1 change) +**ExternalContact** (1 change) -* Model was added +* id is no longer readonly -**PatchContentOfferStylingConfiguration** (1 change) +**RoutingData** (1 change) -* Model was added +* Optional property scoredAgents was added -**PatchContentPositionProperties** (1 change) +**SchedulingSettingsRequest** (2 changes) -* Model was added +* Optional property planningPeriod was added +* Optional property startDayOfWeekend was added -**PatchCtaButtonStyleProperties** (1 change) +**AuditQueryExecutionStatusResponse** (1 change) -* Model was added +* Enum value Routing was added to property serviceName -**PatchIntegrationAction** (1 change) +**AuditQueryRequest** (1 change) -* Model was added +* Enum value Routing was added to property serviceName -**PatchIntegrationActionFields** (1 change) +**AuditLogMessage** (7 changes) -* Model was added +* Enum value Routing was added to property serviceName +* Enum value CampaignSchedule was added to property entityType +* Enum value SequenceSchedule was added to property entityType +* Enum value OrganizationProperties was added to property entityType +* Enum value WrapUpCodeMapping was added to property entityType +* Enum value MessagingCampaign was added to property entityType +* Enum value Predictor was added to property entityType -**PatchTextStyleProperties** (1 change) +**AuditRealtimeQueryRequest** (1 change) -* Model was added +* Enum value Routing was added to property serviceName -**OAuthClient** (1 change) +**AuditQueryEntity** (6 changes) -* Enum value CODE_PKCE was added to property authorizedGrantType +* Enum value CampaignSchedule was added to property name +* Enum value SequenceSchedule was added to property name +* Enum value OrganizationProperties was added to property name +* Enum value WrapUpCodeMapping was added to property name +* Enum value MessagingCampaign was added to property name +* Enum value Predictor was added to property name -**Outcome** (1 change) +**AuditQueryService** (1 change) -* Model was added +* Enum value Routing was added to property name -**GenesysBotConnector** (1 change) +**BaseProgramEntity** (1 change) * Model was added -**PostTextRequest** (1 change) - -* Optional property genesysBotConnector was added - -**ActionMap** (1 change) +**ProgramJob** (1 change) * Model was added -**ActionMapAction** (1 change) +**ListedTopic** (1 change) * Model was added -**ActionMapActionTemplate** (1 change) +**TopicsEntityListing** (1 change) * Model was added -**ActionMapScheduleGroup** (1 change) +**Phrase** (1 change) * Model was added -**ActionMapScheduleGroups** (1 change) +**Topic** (1 change) * Model was added -**ActionProperties** (1 change) +**TopicRequest** (1 change) * Model was added -**ActionSurvey** (1 change) +**ExternalSegment** (1 change) * Model was added -**Activation** (1 change) +**JourneySegment** (1 change) -* Model was added +* Optional property externalSegment was added -**ArchitectFlowFields** (1 change) +**PatchExternalSegment** (1 change) * Model was added -**EventCondition** (1 change) +**PatchSegment** (1 change) -* Model was added +* Optional property externalSegment was added -**JourneySurveyQuestion** (1 change) +**AvailableTopic** (1 change) -* Model was added +* Optional property permissionDetails was added -**OutcomeProbabilityCondition** (1 change) +**PermissionDetails** (1 change) * Model was added -**UrlCondition** (1 change) +**GeneralProgramJob** (1 change) * Model was added -**AnalyticsConversationSegment** (1 change) - -* Enum value callback was added to property segmentType - -**AvailableTopic** (3 changes) - -* Optional property requiresDivisionPermissions was added -* Optional property enforced was added -* Optional property visibility was added - -**PatchOutcome** (1 change) +**GeneralProgramJobRequest** (1 change) * Model was added -**OAuthClientRequest** (1 change) - -* Enum value CODE_PKCE was added to property authorizedGrantType - -**DIDNumber** (1 change) +**ListedProgram** (1 change) * Model was added -**DIDNumberEntityListing** (1 change) +**ProgramsEntityListing** (1 change) * Model was added -**EntityListing** (4 changes) - -* Optional property pageSize was added -* Optional property pageNumber was added -* Optional property total was added -* Optional property pageCount was added - -**OrgOAuthClient** (1 change) - -* Enum value CODE_PKCE was added to property authorizedGrantType - -**ReportingExportMetadataJobResponse** (3 changes) - -* Enum value AGENT_PERFORMANCE_ME_VIEW was added to property viewType -* Enum value AGENT_STATUS_ME_VIEW was added to property viewType -* Enum value AGENT_EVALUATION_ME_VIEW was added to property viewType - -**RecordingSettings** (1 change) - -* Optional property maxConfigurableScreenRecordingStreams was added - -**ActionTemplateListing** (1 change) +**Program** (1 change) * Model was added -**PatchAction** (1 change) +**ProgramRequest** (1 change) * Model was added -**PatchActionMap** (1 change) +**TranscriptAggregateQueryPredicate** (2 changes) -* Model was added +* Enum value flowVersion was added to property dimension +* Enum value topicId was added to property dimension -**PatchActionMapScheduleGroups** (1 change) +**TranscriptAggregationQuery** (2 changes) -* Model was added +* Enum value flowVersion was added to property groupBy +* Enum value topicId was added to property groupBy -**PatchActionProperties** (1 change) +**TopicJobRequest** (1 change) * Model was added -**PatchActionSurvey** (1 change) +**ProgramJobRequest** (1 change) * Model was added -**PatchSurveyQuestion** (1 change) +**UnpublishedProgramsEntityListing** (1 change) * Model was added -**ConversationAggregationQuery** (2 changes) - -* Enum value tCallback was added to property metrics -* Enum value tCallbackComplete was added to property metrics - -**ConversationAggregationView** (2 changes) - -* Enum value tCallback was added to property target -* Enum value tCallbackComplete was added to property target - -**AuditQueryExecutionStatusResponse** (1 change) - -* Enum value SpeechAndTextAnalytics was added to property serviceName - -**AuditLogMessage** (3 changes) - -* Enum value SpeechAndTextAnalytics was added to property serviceName -* Enum value TranscriptionSettings was added to property entityType -* Enum value SpeechTextAnalyticsSettings was added to property entityType - -**AuditQueryEntity** (2 changes) - -* Enum value TranscriptionSettings was added to property name -* Enum value SpeechTextAnalyticsSettings was added to property name -**AuditQueryService** (1 change) - -* Enum value SpeechAndTextAnalytics was added to property name +# Point Changes (7 changes) -**AuditQueryRequest** (1 change) +**GET /api/v2/workforcemanagement/managementunits** (3 changes) -* Enum value SpeechAndTextAnalytics was added to property serviceName +* Description was changed for parameter pageSize +* Description was changed for parameter pageNumber +* Description was changed for parameter expand -**AuditRealtimeQueryRequest** (1 change) +**GET /api/v2/workforcemanagement/managementunits/{managementUnitId}** (1 change) -* Enum value SpeechAndTextAnalytics was added to property serviceName - -**ActionMapListing** (1 change) - -* Model was added - -**EvaluatorActivity** (1 change) - -* Optional property numEvaluationsWithoutViewPermission was added +* Description was changed -**OutcomeListing** (1 change) +**POST /api/v2/authorization/divisions/{divisionId}/objects/{objectType}** (1 change) -* Model was added +* Description was changed +**GET /api/v2/users/development/activities** (1 change) -# Point Changes (1 change) +* Description was changed for parameter relationship -**POST /api/v2/oauth/clients** (1 change) +**GET /api/v2/users/development/activities/me** (1 change) -* Description was changed +* Description was changed for parameter relationship diff --git a/platformclientv2/analyticsevaluation.go b/platformclientv2/analyticsevaluation.go index 39452ff15..c42195649 100644 --- a/platformclientv2/analyticsevaluation.go +++ b/platformclientv2/analyticsevaluation.go @@ -50,13 +50,13 @@ type Analyticsevaluation struct { Deleted *bool `json:"deleted,omitempty"` - // OTotalScore - OTotalScore *int `json:"oTotalScore,omitempty"` - - // OTotalCriticalScore OTotalCriticalScore *int `json:"oTotalCriticalScore,omitempty"` + + // OTotalScore + OTotalScore *int `json:"oTotalScore,omitempty"` + } // String returns a JSON representation of the model diff --git a/platformclientv2/apiclient.go b/platformclientv2/apiclient.go index 101c9a6a0..c68264676 100644 --- a/platformclientv2/apiclient.go +++ b/platformclientv2/apiclient.go @@ -11,11 +11,13 @@ import ( "strings" "sync/atomic" "time" + + "github.com/hashicorp/go-retryablehttp" ) // APIClient provides functions for making API requests type APIClient struct { - client http.Client + client retryablehttp.Client configuration *Configuration } @@ -25,8 +27,13 @@ func NewAPIClient(c *Configuration) APIClient { if err != nil { panic(err) } + + client := retryablehttp.NewClient() + client.Logger = nil + client.HTTPClient.Timeout = timeout + return APIClient{ - client: http.Client{Timeout: timeout}, + client: *client, configuration: c, } } @@ -83,11 +90,14 @@ func (c *APIClient) CallAPI(path string, method string, if err != nil { return nil, err } - request := http.Request{ - URL: u, - Close: true, - Method: strings.ToUpper(method), - Header: make(map[string][]string), + + request := retryablehttp.Request{ + Request: &http.Request{ + URL: u, + Close: true, + Method: strings.ToUpper(method), + Header: make(map[string][]string), + }, } // Set default headers @@ -136,9 +146,27 @@ func (c *APIClient) CallAPI(path string, method string, c.configuration.Debug(request) } + if c.configuration.RetryConfiguration == nil { + c.client.RetryMax = 0 + c.client.RetryWaitMax = 0 + } else { + c.client.RetryWaitMax = c.configuration.RetryConfiguration.RetryWaitMax + c.client.RetryWaitMin = c.configuration.RetryConfiguration.RetryWaitMin + c.client.RetryMax = c.configuration.RetryConfiguration.RetryMax + if c.configuration.RetryConfiguration.RequestLogHook != nil { + c.client.RequestLogHook = func(_ retryablehttp.Logger, req *http.Request, retryNumber int) { + c.configuration.RetryConfiguration.RequestLogHook(req, retryNumber) + } + } + } + // Execute request reqStart := time.Now() res, err := c.client.Do(&request) + if err != nil { + return nil, err + } + reqEnd := time.Now() duration := reqEnd.Sub(reqStart) @@ -219,17 +247,15 @@ func (c *APIClient) handleExpiredAccessToken() error { // Wait maximum of RefreshTokenWaitTime seconds for other thread to complete refresh startTime := time.Now().Unix() sleepDuration := time.Millisecond * 200 - // Check if we've gone over the wait threshhold + // Check if we've gone over the wait threshold for time.Now().Unix() - startTime < int64(c.configuration.RefreshTokenWaitTime) { time.Sleep(sleepDuration) // Sleep for 200ms on every iteration if atomic.LoadInt64(&c.configuration.RefreshInProgress) == 0 { return nil } } - return fmt.Errorf("Token refresh took longer than %d seconds", c.configuration.RefreshTokenWaitTime) + return fmt.Errorf("token refresh took longer than %d seconds", c.configuration.RefreshTokenWaitTime) } - - return nil } // Int32 is an easy way to get a pointer diff --git a/platformclientv2/apiresponse.go b/platformclientv2/apiresponse.go index 0c5c1f057..91a259484 100644 --- a/platformclientv2/apiresponse.go +++ b/platformclientv2/apiresponse.go @@ -40,7 +40,8 @@ func (r *APIResponse) SetError(err *APIError) { type APIError struct { Status int `json:"status,omitempty"` Message string `json:"message,omitempty"` - MessageWithParams map[string]interface{} `json:"messageWithParams,omitempty"` + MessageWithParams string `json:"messageWithParams,omitempty"` + MessageParams map[string]interface{} `json:"messageParams,omitempty"` Code string `json:"code,omitempty"` ContextID string `json:"contextId,omitempty"` Details []string `json:"details,omitempty"` diff --git a/platformclientv2/architectapi.go b/platformclientv2/architectapi.go index 175c1fc83..6a6d846b9 100644 --- a/platformclientv2/architectapi.go +++ b/platformclientv2/architectapi.go @@ -5463,7 +5463,7 @@ func (a ArchitectApi) GetFlowsDatatableRows(datatableId string, pageNumber int, // Retrieve a list of datatables for the org // // Returns a metadata list of the datatables associated with this org, including datatableId, name and description. -func (a ArchitectApi) GetFlowsDatatables(expand string, pageNumber int, pageSize int, sortBy string, sortOrder string) (*Datatablesdomainentitylisting, *APIResponse, error) { +func (a ArchitectApi) GetFlowsDatatables(expand string, pageNumber int, pageSize int, sortBy string, sortOrder string, divisionId []string) (*Datatablesdomainentitylisting, *APIResponse, error) { var httpMethod = "GET" // create path and map variables path := a.Configuration.BasePath + "/api/v2/flows/datatables" @@ -5552,6 +5552,18 @@ func (a ArchitectApi) GetFlowsDatatables(expand string, pageNumber int, pageSize } + + collectionFormat = "multi" + if collectionFormat == "multi" { + for _, value := range divisionId { + queryParams["divisionId"] = value + } + } else { + queryParams["divisionId"] = a.Configuration.APIClient.ParameterToString(divisionId, collectionFormat) + } + + + // to determine the Content-Type header localVarHttpContentTypes := []string{ "application/json", } diff --git a/platformclientv2/arraynode.go b/platformclientv2/arraynode.go index c22def27e..3ace84aae 100644 --- a/platformclientv2/arraynode.go +++ b/platformclientv2/arraynode.go @@ -25,24 +25,24 @@ type Arraynode struct { Object *bool `json:"object,omitempty"` - // ValueNode - ValueNode *bool `json:"valueNode,omitempty"` + // FloatingPointNumber + FloatingPointNumber *bool `json:"floatingPointNumber,omitempty"` - // ContainerNode - ContainerNode *bool `json:"containerNode,omitempty"` + // IntegralNumber + IntegralNumber *bool `json:"integralNumber,omitempty"` - // FloatingPointNumber - FloatingPointNumber *bool `json:"floatingPointNumber,omitempty"` + // ValueNode + ValueNode *bool `json:"valueNode,omitempty"` - // Pojo - Pojo *bool `json:"pojo,omitempty"` + // MissingNode + MissingNode *bool `json:"missingNode,omitempty"` - // IntegralNumber - IntegralNumber *bool `json:"integralNumber,omitempty"` + // ContainerNode + ContainerNode *bool `json:"containerNode,omitempty"` // Short @@ -77,8 +77,8 @@ type Arraynode struct { Binary *bool `json:"binary,omitempty"` - // MissingNode - MissingNode *bool `json:"missingNode,omitempty"` + // Pojo + Pojo *bool `json:"pojo,omitempty"` // Array diff --git a/platformclientv2/authorizationapi.go b/platformclientv2/authorizationapi.go index 0cb674dcd..a7fd4e699 100644 --- a/platformclientv2/authorizationapi.go +++ b/platformclientv2/authorizationapi.go @@ -2171,7 +2171,7 @@ func (a AuthorizationApi) PatchAuthorizationRole(roleId string, body Domainorgan // // Assign a list of objects to a division // -// Set the division of a specified list of objects. The objects must all be of the same type, one of: CAMPAIGN, MANAGEMENTUNIT, FLOW, QUEUE, or USER. The body of the request is a list of object IDs, which are expected to be GUIDs, e.g. [\"206ce31f-61ec-40ed-a8b1-be6f06303998\",\"250a754e-f5e4-4f51-800f-a92f09d3bf8c\"] +// Set the division of a specified list of objects. The objects must all be of the same type, one of: CAMPAIGN, MANAGEMENTUNIT, FLOW, QUEUE, DATATABLES or USER. The body of the request is a list of object IDs, which are expected to be GUIDs, e.g. [\"206ce31f-61ec-40ed-a8b1-be6f06303998\",\"250a754e-f5e4-4f51-800f-a92f09d3bf8c\"] func (a AuthorizationApi) PostAuthorizationDivisionObject(divisionId string, objectType string, body []string) (*APIResponse, error) { var httpMethod = "POST" // create path and map variables diff --git a/platformclientv2/availabletopic.go b/platformclientv2/availabletopic.go index 14bcecf34..8b7c16580 100644 --- a/platformclientv2/availabletopic.go +++ b/platformclientv2/availabletopic.go @@ -13,6 +13,10 @@ type Availabletopic struct { Id *string `json:"id,omitempty"` + // PermissionDetails - Full detailed permissions required to subscribe to the topic + PermissionDetails *[]Permissiondetails `json:"permissionDetails,omitempty"` + + // RequiresPermissions - Permissions required to subscribe to the topic RequiresPermissions *[]string `json:"requiresPermissions,omitempty"` diff --git a/build/platformclientv2/division.go b/platformclientv2/baseprogramentity.go similarity index 79% rename from build/platformclientv2/division.go rename to platformclientv2/baseprogramentity.go index dc95a3494..c9f394d5b 100644 --- a/build/platformclientv2/division.go +++ b/platformclientv2/baseprogramentity.go @@ -3,8 +3,8 @@ import ( "encoding/json" ) -// Division -type Division struct { +// Baseprogramentity +type Baseprogramentity struct { // Id - The globally unique identifier for the object. Id *string `json:"id,omitempty"` @@ -19,7 +19,7 @@ type Division struct { } // String returns a JSON representation of the model -func (o *Division) String() string { +func (o *Baseprogramentity) String() string { j, _ := json.Marshal(o) return string(j) } diff --git a/build/platformclientv2/runnowresponse.go b/platformclientv2/basetopicentitiy.go similarity index 79% rename from build/platformclientv2/runnowresponse.go rename to platformclientv2/basetopicentitiy.go index 7b0417ae9..144d59013 100644 --- a/build/platformclientv2/runnowresponse.go +++ b/platformclientv2/basetopicentitiy.go @@ -3,8 +3,8 @@ import ( "encoding/json" ) -// Runnowresponse -type Runnowresponse struct { +// Basetopicentitiy +type Basetopicentitiy struct { // Id - The globally unique identifier for the object. Id *string `json:"id,omitempty"` @@ -19,7 +19,7 @@ type Runnowresponse struct { } // String returns a JSON representation of the model -func (o *Runnowresponse) String() string { +func (o *Basetopicentitiy) String() string { j, _ := json.Marshal(o) return string(j) } diff --git a/platformclientv2/configuration.go b/platformclientv2/configuration.go index 54a99e10b..64f470887 100644 --- a/platformclientv2/configuration.go +++ b/platformclientv2/configuration.go @@ -4,36 +4,61 @@ import ( "encoding/base64" "encoding/json" "fmt" + "net/http" "net/url" "regexp" "sync" + "time" ) // Configuration has settings to configure the SDK type Configuration struct { - UserName string `json:"userName,omitempty"` - Password string `json:"password,omitempty"` - APIKeyPrefix map[string]string `json:"APIKeyPrefix,omitempty"` - APIKey map[string]string `json:"APIKey,omitempty"` - debug bool `json:"debug,omitempty"` - DebugFile string `json:"debugFile,omitempty"` - OAuthToken string `json:"oAuthToken,omitempty"` - Timeout int `json:"timeout,omitempty"` - BasePath string `json:"basePath,omitempty"` - Host string `json:"host,omitempty"` - Scheme string `json:"scheme,omitempty"` - AccessToken string `json:"accessToken,omitempty"` - RefreshToken string `json:"refreshToken,omitempty"` - ClientID string `json:"clientId,omitempty"` - ClientSecret string `json:"clientSecret,omitempty"` - ShouldRefreshAccessToken bool `json:"shouldRefreshAccessToken,omitempty"` - RefreshInProgress int64 `json:"refreshInProgress,omitempty"` - RefreshTokenWaitTime int `json:"refreshTokenWaitTime,omitempty"` - DefaultHeader map[string]string `json:"defaultHeader,omitempty"` - UserAgent string `json:"userAgent,omitempty"` - APIClient APIClient `json:"APIClient,omitempty"` + UserName string `json:"userName,omitempty"` + Password string `json:"password,omitempty"` + APIKeyPrefix map[string]string `json:"APIKeyPrefix,omitempty"` + APIKey map[string]string `json:"APIKey,omitempty"` + debug bool `json:"debug,omitempty"` + DebugFile string `json:"debugFile,omitempty"` + OAuthToken string `json:"oAuthToken,omitempty"` + Timeout int `json:"timeout,omitempty"` + BasePath string `json:"basePath,omitempty"` + Host string `json:"host,omitempty"` + Scheme string `json:"scheme,omitempty"` + AccessToken string `json:"accessToken,omitempty"` + RefreshToken string `json:"refreshToken,omitempty"` + ClientID string `json:"clientId,omitempty"` + ClientSecret string `json:"clientSecret,omitempty"` + ShouldRefreshAccessToken bool `json:"shouldRefreshAccessToken,omitempty"` + RefreshInProgress int64 `json:"refreshInProgress,omitempty"` + RefreshTokenWaitTime int `json:"refreshTokenWaitTime,omitempty"` + DefaultHeader map[string]string `json:"defaultHeader,omitempty"` + UserAgent string `json:"userAgent,omitempty"` + APIClient APIClient `json:"APIClient,omitempty"` + RetryConfiguration *RetryConfiguration `json:"retryConfiguration,omitempty"` } +const ( + USEast1 = "https://api.mypurecloud.com" + EUWest1 = "https://api.mypurecloud.ie" + APSoutheast2 = "https://api.mypurecloud.com.au" + APNortheast1 = "https://api.mypurecloud.jp" + EUCentral1 = "https://api.mypurecloud.de" + USWest2 = "https://api.usw2.pure.cloud" + CACentral1 = "https://api.cac1.pure.cloud" + APNortheast2 = "https://api.apne2.pure.cloud" + EUWest2 = "https://api.euw2.pure.cloud" + APSouth1 = "https://api.aps1.pure.cloud" +) + +type RetryConfiguration struct { + RetryWaitMin time.Duration `json:"retry_wait_min,omitempty"` + RetryWaitMax time.Duration `json:"retry_wait_max,omitempty"` + RetryMax int `json:"retry_max,omitempty"` + RequestLogHook RequestLogHook `json:"request_log_hook,omitempty"` +} + +type RequestLogHook func(*http.Request, int) + // AuthResponse contains the access token to use in future requests type AuthResponse struct { AccessToken string `json:"access_token,omitempty"` diff --git a/platformclientv2/conversationsapi.go b/platformclientv2/conversationsapi.go index 3ca6b688c..f8b5f274c 100644 --- a/platformclientv2/conversationsapi.go +++ b/platformclientv2/conversationsapi.go @@ -10021,7 +10021,7 @@ func (a ConversationsApi) PostConversationsMessagesAgentless(body Sendagentlesso // Create a Facebook Integration // // -func (a ConversationsApi) PostConversationsMessagingIntegrationsFacebook(body Facebookintegrationrequest, async bool) (*Facebookintegration, *APIResponse, error) { +func (a ConversationsApi) PostConversationsMessagingIntegrationsFacebook(body Facebookintegrationrequest) (*Facebookintegration, *APIResponse, error) { var httpMethod = "POST" // create path and map variables path := a.Configuration.BasePath + "/api/v2/conversations/messaging/integrations/facebook" @@ -10053,20 +10053,6 @@ func (a ConversationsApi) PostConversationsMessagingIntegrationsFacebook(body Fa headerParams[key] = a.Configuration.DefaultHeader[key] } - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(async).(string); ok { - if str != "" { - queryParams["async"] = a.Configuration.APIClient.ParameterToString(async, collectionFormat) - } - } else { - queryParams["async"] = a.Configuration.APIClient.ParameterToString(async, collectionFormat) - } - - // to determine the Content-Type header localVarHttpContentTypes := []string{ "application/json", } @@ -10106,7 +10092,7 @@ func (a ConversationsApi) PostConversationsMessagingIntegrationsFacebook(body Fa // Create a LINE messenger Integration // // -func (a ConversationsApi) PostConversationsMessagingIntegrationsLine(body Lineintegrationrequest, async bool) (*Lineintegration, *APIResponse, error) { +func (a ConversationsApi) PostConversationsMessagingIntegrationsLine(body Lineintegrationrequest) (*Lineintegration, *APIResponse, error) { var httpMethod = "POST" // create path and map variables path := a.Configuration.BasePath + "/api/v2/conversations/messaging/integrations/line" @@ -10138,20 +10124,6 @@ func (a ConversationsApi) PostConversationsMessagingIntegrationsLine(body Linein headerParams[key] = a.Configuration.DefaultHeader[key] } - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(async).(string); ok { - if str != "" { - queryParams["async"] = a.Configuration.APIClient.ParameterToString(async, collectionFormat) - } - } else { - queryParams["async"] = a.Configuration.APIClient.ParameterToString(async, collectionFormat) - } - - // to determine the Content-Type header localVarHttpContentTypes := []string{ "application/json", } @@ -10191,7 +10163,7 @@ func (a ConversationsApi) PostConversationsMessagingIntegrationsLine(body Linein // Create a Twitter Integration // // -func (a ConversationsApi) PostConversationsMessagingIntegrationsTwitter(body Twitterintegrationrequest, async bool) (*Twitterintegration, *APIResponse, error) { +func (a ConversationsApi) PostConversationsMessagingIntegrationsTwitter(body Twitterintegrationrequest) (*Twitterintegration, *APIResponse, error) { var httpMethod = "POST" // create path and map variables path := a.Configuration.BasePath + "/api/v2/conversations/messaging/integrations/twitter" @@ -10223,20 +10195,6 @@ func (a ConversationsApi) PostConversationsMessagingIntegrationsTwitter(body Twi headerParams[key] = a.Configuration.DefaultHeader[key] } - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(async).(string); ok { - if str != "" { - queryParams["async"] = a.Configuration.APIClient.ParameterToString(async, collectionFormat) - } - } else { - queryParams["async"] = a.Configuration.APIClient.ParameterToString(async, collectionFormat) - } - - // to determine the Content-Type header localVarHttpContentTypes := []string{ "application/json", } @@ -10276,7 +10234,7 @@ func (a ConversationsApi) PostConversationsMessagingIntegrationsTwitter(body Twi // Create a WhatsApp Integration // // You must be approved by WhatsApp to use this feature. Your approved e164-formatted phone number and valid WhatsApp certificate for your number are required. Your WhatsApp certificate must have valid base64 encoding. Please paste carefully and do not add any leading or trailing spaces. Do not alter any characters. An integration must be activated within 7 days of certificate generation. If you cannot complete the addition and activation of the number within 7 days, please obtain a new certificate before creating the integration. Integrations created with an invalid number or certificate may immediately incur additional integration fees. Please carefully enter your number and certificate as described. -func (a ConversationsApi) PostConversationsMessagingIntegrationsWhatsapp(body Whatsappintegrationrequest, async bool) (*Whatsappintegration, *APIResponse, error) { +func (a ConversationsApi) PostConversationsMessagingIntegrationsWhatsapp(body Whatsappintegrationrequest) (*Whatsappintegration, *APIResponse, error) { var httpMethod = "POST" // create path and map variables path := a.Configuration.BasePath + "/api/v2/conversations/messaging/integrations/whatsapp" @@ -10308,20 +10266,6 @@ func (a ConversationsApi) PostConversationsMessagingIntegrationsWhatsapp(body Wh headerParams[key] = a.Configuration.DefaultHeader[key] } - var collectionFormat string - - - - collectionFormat = "" - if str, ok := interface{}(async).(string); ok { - if str != "" { - queryParams["async"] = a.Configuration.APIClient.ParameterToString(async, collectionFormat) - } - } else { - queryParams["async"] = a.Configuration.APIClient.ParameterToString(async, collectionFormat) - } - - // to determine the Content-Type header localVarHttpContentTypes := []string{ "application/json", } diff --git a/platformclientv2/createmanagementunitapirequest.go b/platformclientv2/createmanagementunitapirequest.go index 9e2a58631..e379e0d92 100644 --- a/platformclientv2/createmanagementunitapirequest.go +++ b/platformclientv2/createmanagementunitapirequest.go @@ -25,7 +25,7 @@ type Createmanagementunitapirequest struct { DivisionId *string `json:"divisionId,omitempty"` - // BusinessUnitId - The id of the business unit to which this management unit belongs. Required after business unit launch + // BusinessUnitId - The id of the business unit to which this management unit belongs BusinessUnitId *string `json:"businessUnitId,omitempty"` } diff --git a/platformclientv2/createworkplan.go b/platformclientv2/createworkplan.go index 6154afe16..5575843f9 100644 --- a/platformclientv2/createworkplan.go +++ b/platformclientv2/createworkplan.go @@ -53,14 +53,58 @@ type Createworkplan struct { MaximumDays *int `json:"maximumDays,omitempty"` + // MinimumConsecutiveNonWorkingMinutesPerWeek - Minimum amount of consecutive non working minutes per week that agents who are assigned this work plan are allowed to have off + MinimumConsecutiveNonWorkingMinutesPerWeek *int `json:"minimumConsecutiveNonWorkingMinutesPerWeek,omitempty"` + + + // ConstrainMaximumConsecutiveWorkingWeekends - Whether to constrain the maximum consecutive working weekends + ConstrainMaximumConsecutiveWorkingWeekends *bool `json:"constrainMaximumConsecutiveWorkingWeekends,omitempty"` + + + // MaximumConsecutiveWorkingWeekends - The maximum number of consecutive weekends that agents who are assigned to this work plan are allowed to work + MaximumConsecutiveWorkingWeekends *int `json:"maximumConsecutiveWorkingWeekends,omitempty"` + + // MinimumWorkingDaysPerWeek - The minimum number of days that agents assigned to a work plan must work per week MinimumWorkingDaysPerWeek *int `json:"minimumWorkingDaysPerWeek,omitempty"` + // ConstrainMaximumConsecutiveWorkingDays - Whether to constrain the maximum consecutive working days + ConstrainMaximumConsecutiveWorkingDays *bool `json:"constrainMaximumConsecutiveWorkingDays,omitempty"` + + + // MaximumConsecutiveWorkingDays - The maximum number of consecutive days that agents assigned to this work plan are allowed to work. Used if constrainMaximumConsecutiveWorkingDays == true + MaximumConsecutiveWorkingDays *int `json:"maximumConsecutiveWorkingDays,omitempty"` + + + // MinimumShiftStartDistanceMinutes - The time period in minutes for the duration between the start times of two consecutive working days + MinimumShiftStartDistanceMinutes *int `json:"minimumShiftStartDistanceMinutes,omitempty"` + + + // MinimumDaysOffPerPlanningPeriod - Minimum days off in the planning period + MinimumDaysOffPerPlanningPeriod *int `json:"minimumDaysOffPerPlanningPeriod,omitempty"` + + + // MaximumDaysOffPerPlanningPeriod - Maximum days off in the planning period + MaximumDaysOffPerPlanningPeriod *int `json:"maximumDaysOffPerPlanningPeriod,omitempty"` + + + // MinimumPaidMinutesPerPlanningPeriod - Minimum paid minutes in the planning period + MinimumPaidMinutesPerPlanningPeriod *int `json:"minimumPaidMinutesPerPlanningPeriod,omitempty"` + + + // MaximumPaidMinutesPerPlanningPeriod - Maximum paid minutes in the planning period + MaximumPaidMinutesPerPlanningPeriod *int `json:"maximumPaidMinutesPerPlanningPeriod,omitempty"` + + // OptionalDays - Optional days to schedule for this work plan OptionalDays *Setwrapperdayofweek `json:"optionalDays,omitempty"` + // ShiftStartVarianceType - This constraint ensures that an agent starts each workday within a user-defined time threshold + ShiftStartVarianceType *string `json:"shiftStartVarianceType,omitempty"` + + // ShiftStartVariances - Variance in minutes among start times of shifts in this work plan ShiftStartVariances *Listwrappershiftstartvariance `json:"shiftStartVariances,omitempty"` diff --git a/platformclientv2/createworkplanactivity.go b/platformclientv2/createworkplanactivity.go index 56e98caa9..34a31d84e 100644 --- a/platformclientv2/createworkplanactivity.go +++ b/platformclientv2/createworkplanactivity.go @@ -48,6 +48,14 @@ type Createworkplanactivity struct { // CountsAsContiguousWorkTime - Whether the activity duration is counted towards contiguous work time CountsAsContiguousWorkTime *bool `json:"countsAsContiguousWorkTime,omitempty"` + + // MinimumLengthFromShiftStartMinutes - The minimum duration between shift start and shift item (e.g., break or meal) start in minutes + MinimumLengthFromShiftStartMinutes *int `json:"minimumLengthFromShiftStartMinutes,omitempty"` + + + // MinimumLengthFromShiftEndMinutes - The minimum duration between shift item (e.g., break or meal) end and shift end in minutes + MinimumLengthFromShiftEndMinutes *int `json:"minimumLengthFromShiftEndMinutes,omitempty"` + } // String returns a JSON representation of the model diff --git a/platformclientv2/createworkplanshift.go b/platformclientv2/createworkplanshift.go index aac5c05ef..c7e117570 100644 --- a/platformclientv2/createworkplanshift.go +++ b/platformclientv2/createworkplanshift.go @@ -41,6 +41,14 @@ type Createworkplanshift struct { LatestStopTimeMinutesFromMidnight *int `json:"latestStopTimeMinutesFromMidnight,omitempty"` + // ConstrainEarliestStopTime - Whether the earliest stop time constraint for the shift is enabled + ConstrainEarliestStopTime *bool `json:"constrainEarliestStopTime,omitempty"` + + + // EarliestStopTimeMinutesFromMidnight - This is the earliest time a shift can end + EarliestStopTimeMinutesFromMidnight *int `json:"earliestStopTimeMinutesFromMidnight,omitempty"` + + // StartIncrementMinutes - Increment in offset minutes that would contribute to different possible start times for the shift. Used if flexibleStartTime == true StartIncrementMinutes *int `json:"startIncrementMinutes,omitempty"` diff --git a/platformclientv2/datatable.go b/platformclientv2/datatable.go index c6ab42515..a21cf02a2 100644 --- a/platformclientv2/datatable.go +++ b/platformclientv2/datatable.go @@ -13,6 +13,10 @@ type Datatable struct { Name *string `json:"name,omitempty"` + // Division - The division to which this entity belongs. + Division *Division `json:"division,omitempty"` + + // Description - The description from the JSON schema (equates to the Description field on the JSON schema.) Description *string `json:"description,omitempty"` diff --git a/platformclientv2/domainorganizationrole.go b/platformclientv2/domainorganizationrole.go index beabad7a4..8dcde86b6 100644 --- a/platformclientv2/domainorganizationrole.go +++ b/platformclientv2/domainorganizationrole.go @@ -41,14 +41,14 @@ type Domainorganizationrole struct { RoleNeedsUpdate *bool `json:"roleNeedsUpdate,omitempty"` - // Base - Base *bool `json:"base,omitempty"` - - // VarDefault VarDefault *bool `json:"default,omitempty"` + // Base + Base *bool `json:"base,omitempty"` + + // SelfUri - The URI for this object SelfUri *string `json:"selfUri,omitempty"` diff --git a/platformclientv2/domainorganizationrolecreate.go b/platformclientv2/domainorganizationrolecreate.go index d0926ff92..e03c643e8 100644 --- a/platformclientv2/domainorganizationrolecreate.go +++ b/platformclientv2/domainorganizationrolecreate.go @@ -41,14 +41,14 @@ type Domainorganizationrolecreate struct { RoleNeedsUpdate *bool `json:"roleNeedsUpdate,omitempty"` - // Base - Base *bool `json:"base,omitempty"` - - // VarDefault VarDefault *bool `json:"default,omitempty"` + // Base + Base *bool `json:"base,omitempty"` + + // SelfUri - The URI for this object SelfUri *string `json:"selfUri,omitempty"` diff --git a/platformclientv2/domainorganizationroleupdate.go b/platformclientv2/domainorganizationroleupdate.go index 94d5f3617..33e5622ed 100644 --- a/platformclientv2/domainorganizationroleupdate.go +++ b/platformclientv2/domainorganizationroleupdate.go @@ -41,14 +41,14 @@ type Domainorganizationroleupdate struct { RoleNeedsUpdate *bool `json:"roleNeedsUpdate,omitempty"` - // Base - Base *bool `json:"base,omitempty"` - - // VarDefault VarDefault *bool `json:"default,omitempty"` + // Base + Base *bool `json:"base,omitempty"` + + // SelfUri - The URI for this object SelfUri *string `json:"selfUri,omitempty"` diff --git a/platformclientv2/externalsegment.go b/platformclientv2/externalsegment.go new file mode 100644 index 000000000..992ae6a76 --- /dev/null +++ b/platformclientv2/externalsegment.go @@ -0,0 +1,25 @@ +package platformclientv2 +import ( + "encoding/json" +) + +// Externalsegment +type Externalsegment struct { + // Id - Identifier for the external segment in the system where it originates from. + Id *string `json:"id,omitempty"` + + + // Name - Name for the external segment in the system where it originates from. + Name *string `json:"name,omitempty"` + + + // Source - The external system where the segment originates from. + Source *string `json:"source,omitempty"` + +} + +// String returns a JSON representation of the model +func (o *Externalsegment) String() string { + j, _ := json.Marshal(o) + return string(j) +} diff --git a/build/platformclientv2/language.go b/platformclientv2/generalprogramjob.go similarity index 62% rename from build/platformclientv2/language.go rename to platformclientv2/generalprogramjob.go index 05d3c17cd..a186bb427 100644 --- a/build/platformclientv2/language.go +++ b/platformclientv2/generalprogramjob.go @@ -4,26 +4,26 @@ import ( "encoding/json" ) -// Language -type Language struct { +// Generalprogramjob +type Generalprogramjob struct { // Id - The globally unique identifier for the object. Id *string `json:"id,omitempty"` - // Name - The language name. - Name *string `json:"name,omitempty"` + // State + State *string `json:"state,omitempty"` - // DateModified - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` + // CreatedBy + CreatedBy *Addressableentityref `json:"createdBy,omitempty"` - // State - State *string `json:"state,omitempty"` + // DateCreated - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z + DateCreated *time.Time `json:"dateCreated,omitempty"` - // Version - Version *string `json:"version,omitempty"` + // DateModified - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z + DateModified *time.Time `json:"dateModified,omitempty"` // SelfUri - The URI for this object @@ -32,7 +32,7 @@ type Language struct { } // String returns a JSON representation of the model -func (o *Language) String() string { +func (o *Generalprogramjob) String() string { j, _ := json.Marshal(o) return string(j) } diff --git a/platformclientv2/generalprogramjobrequest.go b/platformclientv2/generalprogramjobrequest.go new file mode 100644 index 000000000..870cb2581 --- /dev/null +++ b/platformclientv2/generalprogramjobrequest.go @@ -0,0 +1,21 @@ +package platformclientv2 +import ( + "encoding/json" +) + +// Generalprogramjobrequest +type Generalprogramjobrequest struct { + // Dialect - The dialect of the topics to link with the general program, dialect format is {language}-{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard + Dialect *string `json:"dialect,omitempty"` + + + // Mode - The mode to use for the general program job, default value is Skip + Mode *string `json:"mode,omitempty"` + +} + +// String returns a JSON representation of the model +func (o *Generalprogramjobrequest) String() string { + j, _ := json.Marshal(o) + return string(j) +} diff --git a/build/platformclientv2/intent.go b/platformclientv2/generaltopic.go similarity index 70% rename from build/platformclientv2/intent.go rename to platformclientv2/generaltopic.go index 30b754947..2b9ce761c 100644 --- a/build/platformclientv2/intent.go +++ b/platformclientv2/generaltopic.go @@ -3,15 +3,15 @@ import ( "encoding/json" ) -// Intent -type Intent struct { +// Generaltopic +type Generaltopic struct { // Name Name *string `json:"name,omitempty"` } // String returns a JSON representation of the model -func (o *Intent) String() string { +func (o *Generaltopic) String() string { j, _ := json.Marshal(o) return string(j) } diff --git a/platformclientv2/generaltopicsentitylisting.go b/platformclientv2/generaltopicsentitylisting.go new file mode 100644 index 000000000..d3c1da0b8 --- /dev/null +++ b/platformclientv2/generaltopicsentitylisting.go @@ -0,0 +1,17 @@ +package platformclientv2 +import ( + "encoding/json" +) + +// Generaltopicsentitylisting +type Generaltopicsentitylisting struct { + // Entities + Entities *[]Generaltopic `json:"entities,omitempty"` + +} + +// String returns a JSON representation of the model +func (o *Generaltopicsentitylisting) String() string { + j, _ := json.Marshal(o) + return string(j) +} diff --git a/build/platformclientv2/go.mod b/platformclientv2/go.mod similarity index 100% rename from build/platformclientv2/go.mod rename to platformclientv2/go.mod diff --git a/build/platformclientv2/go.sum b/platformclientv2/go.sum similarity index 100% rename from build/platformclientv2/go.sum rename to platformclientv2/go.sum diff --git a/platformclientv2/historylisting.go b/platformclientv2/historylisting.go index bac0ec77e..4010e1011 100644 --- a/platformclientv2/historylisting.go +++ b/platformclientv2/historylisting.go @@ -74,14 +74,14 @@ type Historylisting struct { Total *int `json:"total,omitempty"` - // PageSize - PageSize *int `json:"pageSize,omitempty"` - - // PageNumber PageNumber *int `json:"pageNumber,omitempty"` + // PageSize + PageSize *int `json:"pageSize,omitempty"` + + // PageCount PageCount *int `json:"pageCount,omitempty"` diff --git a/platformclientv2/journeysegment.go b/platformclientv2/journeysegment.go index 4d62b5bc0..144c4b312 100644 --- a/platformclientv2/journeysegment.go +++ b/platformclientv2/journeysegment.go @@ -46,6 +46,10 @@ type Journeysegment struct { Journey *Journey `json:"journey,omitempty"` + // ExternalSegment - Details of an entity corresponding to this segment in an external system. + ExternalSegment *Externalsegment `json:"externalSegment,omitempty"` + + // AssignmentExpirationDays - Time, in days, from when the segment is assigned until it is automatically unassigned. AssignmentExpirationDays *int `json:"assignmentExpirationDays,omitempty"` diff --git a/platformclientv2/jsonnode.go b/platformclientv2/jsonnode.go index 9df0a646c..982a171c5 100644 --- a/platformclientv2/jsonnode.go +++ b/platformclientv2/jsonnode.go @@ -25,24 +25,24 @@ type Jsonnode struct { Object *bool `json:"object,omitempty"` - // ValueNode - ValueNode *bool `json:"valueNode,omitempty"` + // FloatingPointNumber + FloatingPointNumber *bool `json:"floatingPointNumber,omitempty"` - // ContainerNode - ContainerNode *bool `json:"containerNode,omitempty"` + // IntegralNumber + IntegralNumber *bool `json:"integralNumber,omitempty"` - // FloatingPointNumber - FloatingPointNumber *bool `json:"floatingPointNumber,omitempty"` + // ValueNode + ValueNode *bool `json:"valueNode,omitempty"` - // Pojo - Pojo *bool `json:"pojo,omitempty"` + // MissingNode + MissingNode *bool `json:"missingNode,omitempty"` - // IntegralNumber - IntegralNumber *bool `json:"integralNumber,omitempty"` + // ContainerNode + ContainerNode *bool `json:"containerNode,omitempty"` // Short @@ -77,8 +77,8 @@ type Jsonnode struct { Binary *bool `json:"binary,omitempty"` - // MissingNode - MissingNode *bool `json:"missingNode,omitempty"` + // Pojo + Pojo *bool `json:"pojo,omitempty"` // Array diff --git a/build/platformclientv2/team.go b/platformclientv2/listedprogram.go similarity index 50% rename from build/platformclientv2/team.go rename to platformclientv2/listedprogram.go index a65c2883c..fb4e62062 100644 --- a/build/platformclientv2/team.go +++ b/platformclientv2/listedprogram.go @@ -4,26 +4,38 @@ import ( "encoding/json" ) -// Team -type Team struct { +// Listedprogram +type Listedprogram struct { // Id - The globally unique identifier for the object. Id *string `json:"id,omitempty"` - // Name - The team name + // Name Name *string `json:"name,omitempty"` - // Description - Team information. + // Description Description *string `json:"description,omitempty"` - // DateModified - Last modified datetime. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` + // Published + Published *bool `json:"published,omitempty"` + + + // TopicsCount + TopicsCount *int `json:"topicsCount,omitempty"` + + // Tags + Tags *[]string `json:"tags,omitempty"` - // MemberCount - Number of members in a team - MemberCount *int `json:"memberCount,omitempty"` + + // ModifiedBy + ModifiedBy *Addressableentityref `json:"modifiedBy,omitempty"` + + + // DateModified - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z + DateModified *time.Time `json:"dateModified,omitempty"` // SelfUri - The URI for this object @@ -32,7 +44,7 @@ type Team struct { } // String returns a JSON representation of the model -func (o *Team) String() string { +func (o *Listedprogram) String() string { j, _ := json.Marshal(o) return string(j) } diff --git a/platformclientv2/listedtopic.go b/platformclientv2/listedtopic.go new file mode 100644 index 000000000..820e6ac9c --- /dev/null +++ b/platformclientv2/listedtopic.go @@ -0,0 +1,66 @@ +package platformclientv2 +import ( + "time" + "encoding/json" +) + +// Listedtopic +type Listedtopic struct { + // Id - The globally unique identifier for the object. + Id *string `json:"id,omitempty"` + + + // Name + Name *string `json:"name,omitempty"` + + + // Description + Description *string `json:"description,omitempty"` + + + // Published + Published *bool `json:"published,omitempty"` + + + // Strictness + Strictness *string `json:"strictness,omitempty"` + + + // ProgramsCount + ProgramsCount *int `json:"programsCount,omitempty"` + + + // Tags + Tags *[]string `json:"tags,omitempty"` + + + // Dialect + Dialect *string `json:"dialect,omitempty"` + + + // Participants + Participants *string `json:"participants,omitempty"` + + + // PhrasesCount + PhrasesCount *int `json:"phrasesCount,omitempty"` + + + // ModifiedBy + ModifiedBy *Addressableentityref `json:"modifiedBy,omitempty"` + + + // DateModified - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z + DateModified *time.Time `json:"dateModified,omitempty"` + + + // SelfUri - The URI for this object + SelfUri *string `json:"selfUri,omitempty"` + +} + +// String returns a JSON representation of the model +func (o *Listedtopic) String() string { + j, _ := json.Marshal(o) + return string(j) +} diff --git a/platformclientv2/managementunit.go b/platformclientv2/managementunit.go index 5df8d923e..c996cb1c0 100644 --- a/platformclientv2/managementunit.go +++ b/platformclientv2/managementunit.go @@ -18,6 +18,10 @@ type Managementunit struct { Division *Division `json:"division,omitempty"` + // BusinessUnit - The business unit to which this management unit belongs + BusinessUnit *Businessunitreference `json:"businessUnit,omitempty"` + + // StartDayOfWeek - Start day of week for scheduling and forecasting purposes. Moving to Business Unit StartDayOfWeek *string `json:"startDayOfWeek,omitempty"` diff --git a/platformclientv2/managementunitlisting.go b/platformclientv2/managementunitlisting.go index 1b5296a4d..2922db16f 100644 --- a/platformclientv2/managementunitlisting.go +++ b/platformclientv2/managementunitlisting.go @@ -9,35 +9,35 @@ type Managementunitlisting struct { Entities *[]Managementunit `json:"entities,omitempty"` - // PageSize + // PageSize - Deprecated, paging is not supported PageSize *int `json:"pageSize,omitempty"` - // PageNumber + // PageNumber - Deprecated, paging is not supported PageNumber *int `json:"pageNumber,omitempty"` - // Total + // Total - Deprecated, paging is not supported Total *int `json:"total,omitempty"` - // FirstUri + // FirstUri - Deprecated, paging is not supported FirstUri *string `json:"firstUri,omitempty"` - // NextUri + // NextUri - Deprecated, paging is not supported NextUri *string `json:"nextUri,omitempty"` - // PageCount + // PageCount - Deprecated, paging is not supported PageCount *int `json:"pageCount,omitempty"` - // LastUri + // LastUri - Deprecated, paging is not supported LastUri *string `json:"lastUri,omitempty"` - // PreviousUri + // PreviousUri - Deprecated, paging is not supported PreviousUri *string `json:"previousUri,omitempty"` diff --git a/platformclientv2/objectsapi.go b/platformclientv2/objectsapi.go index f84ba24ce..ca60bf544 100644 --- a/platformclientv2/objectsapi.go +++ b/platformclientv2/objectsapi.go @@ -496,7 +496,7 @@ func (a ObjectsApi) GetAuthorizationDivisionsLimit() (*int, *APIResponse, error) // // Assign a list of objects to a division // -// Set the division of a specified list of objects. The objects must all be of the same type, one of: CAMPAIGN, MANAGEMENTUNIT, FLOW, QUEUE, or USER. The body of the request is a list of object IDs, which are expected to be GUIDs, e.g. [\"206ce31f-61ec-40ed-a8b1-be6f06303998\",\"250a754e-f5e4-4f51-800f-a92f09d3bf8c\"] +// Set the division of a specified list of objects. The objects must all be of the same type, one of: CAMPAIGN, MANAGEMENTUNIT, FLOW, QUEUE, DATATABLES or USER. The body of the request is a list of object IDs, which are expected to be GUIDs, e.g. [\"206ce31f-61ec-40ed-a8b1-be6f06303998\",\"250a754e-f5e4-4f51-800f-a92f09d3bf8c\"] func (a ObjectsApi) PostAuthorizationDivisionObject(divisionId string, objectType string, body []string) (*APIResponse, error) { var httpMethod = "POST" // create path and map variables diff --git a/build/platformclientv2/adhocrecordingtopicuserdata.go b/platformclientv2/patchexternalsegment.go similarity index 50% rename from build/platformclientv2/adhocrecordingtopicuserdata.go rename to platformclientv2/patchexternalsegment.go index 4ac2ad791..b667c0f91 100644 --- a/build/platformclientv2/adhocrecordingtopicuserdata.go +++ b/platformclientv2/patchexternalsegment.go @@ -3,19 +3,15 @@ import ( "encoding/json" ) -// Adhocrecordingtopicuserdata -type Adhocrecordingtopicuserdata struct { - // Id - Id *string `json:"id,omitempty"` - - - // Name +// Patchexternalsegment +type Patchexternalsegment struct { + // Name - Name for the external segment in the system where it originates from. Name *string `json:"name,omitempty"` } // String returns a JSON representation of the model -func (o *Adhocrecordingtopicuserdata) String() string { +func (o *Patchexternalsegment) String() string { j, _ := json.Marshal(o) return string(j) } diff --git a/platformclientv2/patchsegment.go b/platformclientv2/patchsegment.go index 04d5d8649..855c576b0 100644 --- a/platformclientv2/patchsegment.go +++ b/platformclientv2/patchsegment.go @@ -42,6 +42,10 @@ type Patchsegment struct { Journey *Journey `json:"journey,omitempty"` + // ExternalSegment - Details of an entity corresponding to this segment in an external system. + ExternalSegment *Patchexternalsegment `json:"externalSegment,omitempty"` + + // AssignmentExpirationDays - Time, in days, from when the segment is assigned until it is automatically unassigned. AssignmentExpirationDays *int `json:"assignmentExpirationDays,omitempty"` diff --git a/platformclientv2/permissiondetails.go b/platformclientv2/permissiondetails.go new file mode 100644 index 000000000..64277891f --- /dev/null +++ b/platformclientv2/permissiondetails.go @@ -0,0 +1,29 @@ +package platformclientv2 +import ( + "encoding/json" +) + +// Permissiondetails +type Permissiondetails struct { + // VarType - The type of permission requirement + VarType *string `json:"type,omitempty"` + + + // Permissions - List of required permissions + Permissions *[]string `json:"permissions,omitempty"` + + + // AllowsCurrentUser - Whether the current user can subscribe, when division permissions are otherwise required + AllowsCurrentUser *bool `json:"allowsCurrentUser,omitempty"` + + + // Enforced - Whether or not this permission requirement is enforced + Enforced *bool `json:"enforced,omitempty"` + +} + +// String returns a JSON representation of the model +func (o *Permissiondetails) String() string { + j, _ := json.Marshal(o) + return string(j) +} diff --git a/platformclientv2/phrase.go b/platformclientv2/phrase.go new file mode 100644 index 000000000..72267efc9 --- /dev/null +++ b/platformclientv2/phrase.go @@ -0,0 +1,25 @@ +package platformclientv2 +import ( + "encoding/json" +) + +// Phrase +type Phrase struct { + // Text - The phrase text + Text *string `json:"text,omitempty"` + + + // Strictness - The phrase strictness, default value is null + Strictness *string `json:"strictness,omitempty"` + + + // Sentiment - The phrase sentiment, default value is Unspecified + Sentiment *string `json:"sentiment,omitempty"` + +} + +// String returns a JSON representation of the model +func (o *Phrase) String() string { + j, _ := json.Marshal(o) + return string(j) +} diff --git a/platformclientv2/program.go b/platformclientv2/program.go new file mode 100644 index 000000000..cf0f131c2 --- /dev/null +++ b/platformclientv2/program.go @@ -0,0 +1,58 @@ +package platformclientv2 +import ( + "time" + "encoding/json" +) + +// Program +type Program struct { + // Id - The globally unique identifier for the object. + Id *string `json:"id,omitempty"` + + + // Name + Name *string `json:"name,omitempty"` + + + // Description + Description *string `json:"description,omitempty"` + + + // Published + Published *bool `json:"published,omitempty"` + + + // Topics + Topics *[]Basetopicentitiy `json:"topics,omitempty"` + + + // Tags + Tags *[]string `json:"tags,omitempty"` + + + // ModifiedBy + ModifiedBy *Addressableentityref `json:"modifiedBy,omitempty"` + + + // DateModified - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z + DateModified *time.Time `json:"dateModified,omitempty"` + + + // PublishedBy + PublishedBy *Addressableentityref `json:"publishedBy,omitempty"` + + + // DatePublished - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z + DatePublished *time.Time `json:"datePublished,omitempty"` + + + // SelfUri - The URI for this object + SelfUri *string `json:"selfUri,omitempty"` + +} + +// String returns a JSON representation of the model +func (o *Program) String() string { + j, _ := json.Marshal(o) + return string(j) +} diff --git a/build/platformclientv2/wrapupcode.go b/platformclientv2/programjob.go similarity index 72% rename from build/platformclientv2/wrapupcode.go rename to platformclientv2/programjob.go index 00691de37..efff161cf 100644 --- a/build/platformclientv2/wrapupcode.go +++ b/platformclientv2/programjob.go @@ -4,30 +4,30 @@ import ( "encoding/json" ) -// Wrapupcode -type Wrapupcode struct { +// Programjob +type Programjob struct { // Id - The globally unique identifier for the object. Id *string `json:"id,omitempty"` - // Name - The wrap-up code name. - Name *string `json:"name,omitempty"` + // State + State *string `json:"state,omitempty"` - // DateCreated - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateCreated *time.Time `json:"dateCreated,omitempty"` + // Programs + Programs *[]Baseprogramentity `json:"programs,omitempty"` - // DateModified - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z - DateModified *time.Time `json:"dateModified,omitempty"` + // CreatedBy + CreatedBy *Addressableentityref `json:"createdBy,omitempty"` - // ModifiedBy - ModifiedBy *string `json:"modifiedBy,omitempty"` + // DateCreated - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z + DateCreated *time.Time `json:"dateCreated,omitempty"` - // CreatedBy - CreatedBy *string `json:"createdBy,omitempty"` + // DateModified - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z + DateModified *time.Time `json:"dateModified,omitempty"` // SelfUri - The URI for this object @@ -36,7 +36,7 @@ type Wrapupcode struct { } // String returns a JSON representation of the model -func (o *Wrapupcode) String() string { +func (o *Programjob) String() string { j, _ := json.Marshal(o) return string(j) } diff --git a/platformclientv2/programjobrequest.go b/platformclientv2/programjobrequest.go new file mode 100644 index 000000000..a861c9555 --- /dev/null +++ b/platformclientv2/programjobrequest.go @@ -0,0 +1,17 @@ +package platformclientv2 +import ( + "encoding/json" +) + +// Programjobrequest +type Programjobrequest struct { + // ProgramIds - The ids of the programs used for this job + ProgramIds *[]string `json:"programIds,omitempty"` + +} + +// String returns a JSON representation of the model +func (o *Programjobrequest) String() string { + j, _ := json.Marshal(o) + return string(j) +} diff --git a/platformclientv2/programrequest.go b/platformclientv2/programrequest.go new file mode 100644 index 000000000..01b7a08e7 --- /dev/null +++ b/platformclientv2/programrequest.go @@ -0,0 +1,29 @@ +package platformclientv2 +import ( + "encoding/json" +) + +// Programrequest +type Programrequest struct { + // Name - The program name + Name *string `json:"name,omitempty"` + + + // Description - The program description + Description *string `json:"description,omitempty"` + + + // TopicIds - The ids of topics associated to the program + TopicIds *[]string `json:"topicIds,omitempty"` + + + // Tags - The program tags + Tags *[]string `json:"tags,omitempty"` + +} + +// String returns a JSON representation of the model +func (o *Programrequest) String() string { + j, _ := json.Marshal(o) + return string(j) +} diff --git a/build/platformclientv2/entitylisting.go b/platformclientv2/programsentitylisting.go similarity index 51% rename from build/platformclientv2/entitylisting.go rename to platformclientv2/programsentitylisting.go index 2472bd08a..11c91550a 100644 --- a/build/platformclientv2/entitylisting.go +++ b/platformclientv2/programsentitylisting.go @@ -3,22 +3,22 @@ import ( "encoding/json" ) -// Entitylisting -type Entitylisting struct { +// Programsentitylisting +type Programsentitylisting struct { // Entities - Entities *[]Datatableimportjob `json:"entities,omitempty"` + Entities *[]Listedprogram `json:"entities,omitempty"` // PageSize PageSize *int `json:"pageSize,omitempty"` - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` + // SelfUri + SelfUri *string `json:"selfUri,omitempty"` - // Total - Total *int `json:"total,omitempty"` + // NextUri + NextUri *string `json:"nextUri,omitempty"` // PageCount @@ -27,7 +27,7 @@ type Entitylisting struct { } // String returns a JSON representation of the model -func (o *Entitylisting) String() string { +func (o *Programsentitylisting) String() string { j, _ := json.Marshal(o) return string(j) } diff --git a/build/platformclientv2/retry_test.go b/platformclientv2/retry_test.go similarity index 100% rename from build/platformclientv2/retry_test.go rename to platformclientv2/retry_test.go diff --git a/platformclientv2/routingapi.go b/platformclientv2/routingapi.go index e948ade51..1b3a50020 100644 --- a/platformclientv2/routingapi.go +++ b/platformclientv2/routingapi.go @@ -5843,25 +5843,24 @@ func (a RoutingApi) PostRoutingLanguages(body Language) (*Language, *APIResponse // Bulk add or delete up to 100 queue members // // -func (a RoutingApi) PostRoutingQueueMembers(queueId string, body []Writableentity, delete bool) (*string, *APIResponse, error) { +func (a RoutingApi) PostRoutingQueueMembers(queueId string, body []Writableentity, delete bool) (*APIResponse, error) { var httpMethod = "POST" // create path and map variables path := a.Configuration.BasePath + "/api/v2/routing/queues/{queueId}/members" path = strings.Replace(path, "{queueId}", fmt.Sprintf("%v", queueId), -1) - defaultReturn := new(string) if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") + return nil, errors.New("This message brought to you by the laws of physics being broken") } // verify the required parameter 'queueId' is set if &queueId == nil { // - return defaultReturn, nil, errors.New("Missing required parameter 'queueId' when calling RoutingApi->PostRoutingQueueMembers") + return nil, errors.New("Missing required parameter 'queueId' when calling RoutingApi->PostRoutingQueueMembers") } // verify the required parameter 'body' is set if &body == nil { // true - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RoutingApi->PostRoutingQueueMembers") + return nil, errors.New("Missing required parameter 'body' when calling RoutingApi->PostRoutingQueueMembers") } headerParams := make(map[string]string) @@ -5917,16 +5916,14 @@ func (a RoutingApi) PostRoutingQueueMembers(queueId string, body []Writableentit // body params postBody = &body - var successPayload *string + response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) if err != nil { // Nothing special to do here, but do avoid processing the response } else if err == nil && response.Error != nil { err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) } - return successPayload, response, err + return response, err } // PostRoutingQueueUsers invokes POST /api/v2/routing/queues/{queueId}/users @@ -5934,25 +5931,24 @@ func (a RoutingApi) PostRoutingQueueMembers(queueId string, body []Writableentit // DEPRECATED: use POST /routing/queues/{queueId}/members. Bulk add or delete up to 100 queue members. // // -func (a RoutingApi) PostRoutingQueueUsers(queueId string, body []Writableentity, delete bool) (*string, *APIResponse, error) { +func (a RoutingApi) PostRoutingQueueUsers(queueId string, body []Writableentity, delete bool) (*APIResponse, error) { var httpMethod = "POST" // create path and map variables path := a.Configuration.BasePath + "/api/v2/routing/queues/{queueId}/users" path = strings.Replace(path, "{queueId}", fmt.Sprintf("%v", queueId), -1) - defaultReturn := new(string) if true == false { - return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") + return nil, errors.New("This message brought to you by the laws of physics being broken") } // verify the required parameter 'queueId' is set if &queueId == nil { // - return defaultReturn, nil, errors.New("Missing required parameter 'queueId' when calling RoutingApi->PostRoutingQueueUsers") + return nil, errors.New("Missing required parameter 'queueId' when calling RoutingApi->PostRoutingQueueUsers") } // verify the required parameter 'body' is set if &body == nil { // true - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling RoutingApi->PostRoutingQueueUsers") + return nil, errors.New("Missing required parameter 'body' when calling RoutingApi->PostRoutingQueueUsers") } headerParams := make(map[string]string) @@ -6008,16 +6004,14 @@ func (a RoutingApi) PostRoutingQueueUsers(queueId string, body []Writableentity, // body params postBody = &body - var successPayload *string + response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) if err != nil { // Nothing special to do here, but do avoid processing the response } else if err == nil && response.Error != nil { err = errors.New(response.ErrorMessage) - } else { - err = json.Unmarshal([]byte(response.RawBody), &successPayload) } - return successPayload, response, err + return response, err } // PostRoutingQueueWrapupcodes invokes POST /api/v2/routing/queues/{queueId}/wrapupcodes diff --git a/platformclientv2/routingdata.go b/platformclientv2/routingdata.go index 8d004a14c..e00975274 100644 --- a/platformclientv2/routingdata.go +++ b/platformclientv2/routingdata.go @@ -24,6 +24,10 @@ type Routingdata struct { // PreferredAgentIds - A list of agents to be preferred in routing PreferredAgentIds *[]string `json:"preferredAgentIds,omitempty"` + + // ScoredAgents - A list of scored agents for routing decisions + ScoredAgents *[]Scoredagent `json:"scoredAgents,omitempty"` + } // String returns a JSON representation of the model diff --git a/platformclientv2/schedulingsettingsrequest.go b/platformclientv2/schedulingsettingsrequest.go index 2fb1fd4ed..51ee35d82 100644 --- a/platformclientv2/schedulingsettingsrequest.go +++ b/platformclientv2/schedulingsettingsrequest.go @@ -16,6 +16,14 @@ type Schedulingsettingsrequest struct { // ShrinkageOverrides - Shrinkage overrides for scheduling ShrinkageOverrides *Shrinkageoverrides `json:"shrinkageOverrides,omitempty"` + + // PlanningPeriod - Planning period settings for scheduling + PlanningPeriod *Valuewrapperplanningperiodsettings `json:"planningPeriod,omitempty"` + + + // StartDayOfWeekend - Start day of weekend for scheduling + StartDayOfWeekend *string `json:"startDayOfWeekend,omitempty"` + } // String returns a JSON representation of the model diff --git a/platformclientv2/schedulingsettingsresponse.go b/platformclientv2/schedulingsettingsresponse.go index 8487e03e3..b3347b7a2 100644 --- a/platformclientv2/schedulingsettingsresponse.go +++ b/platformclientv2/schedulingsettingsresponse.go @@ -16,6 +16,14 @@ type Schedulingsettingsresponse struct { // ShrinkageOverrides - Shrinkage overrides for scheduling ShrinkageOverrides *Shrinkageoverrides `json:"shrinkageOverrides,omitempty"` + + // PlanningPeriod - Planning period settings for scheduling + PlanningPeriod *Planningperiodsettings `json:"planningPeriod,omitempty"` + + + // StartDayOfWeekend - Start day of weekend for scheduling + StartDayOfWeekend *string `json:"startDayOfWeekend,omitempty"` + } // String returns a JSON representation of the model diff --git a/platformclientv2/speechtextanalyticsapi.go b/platformclientv2/speechtextanalyticsapi.go index 184a35d29..686f74e17 100644 --- a/platformclientv2/speechtextanalyticsapi.go +++ b/platformclientv2/speechtextanalyticsapi.go @@ -30,6 +30,152 @@ func NewSpeechTextAnalyticsApiWithConfig(config *Configuration) *SpeechTextAnaly } } +// DeleteSpeechandtextanalyticsProgram invokes DELETE /api/v2/speechandtextanalytics/programs/{programId} +// +// Delete a Speech & Text Analytics program by id +// +// +func (a SpeechTextAnalyticsApi) DeleteSpeechandtextanalyticsProgram(programId string, forceDelete bool) (*APIResponse, error) { + var httpMethod = "DELETE" + // create path and map variables + path := a.Configuration.BasePath + "/api/v2/speechandtextanalytics/programs/{programId}" + path = strings.Replace(path, "{programId}", fmt.Sprintf("%v", programId), -1) + if true == false { + return nil, errors.New("This message brought to you by the laws of physics being broken") + } + + // verify the required parameter 'programId' is set + if &programId == nil { + // + return nil, errors.New("Missing required parameter 'programId' when calling SpeechTextAnalyticsApi->DeleteSpeechandtextanalyticsProgram") + } + + headerParams := make(map[string]string) + queryParams := make(map[string]string) + formParams := url.Values{} + var postBody interface{} + var postFileName string + var fileBytes []byte + // authentication (PureCloud OAuth) required + + // oauth required + if a.Configuration.AccessToken != ""{ + headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken + } + // add default headers if any + for key := range a.Configuration.DefaultHeader { + headerParams[key] = a.Configuration.DefaultHeader[key] + } + + var collectionFormat string + + + + collectionFormat = "" + if str, ok := interface{}(forceDelete).(string); ok { + if str != "" { + queryParams["forceDelete"] = a.Configuration.APIClient.ParameterToString(forceDelete, collectionFormat) + } + } else { + queryParams["forceDelete"] = a.Configuration.APIClient.ParameterToString(forceDelete, collectionFormat) + } + + + + // to determine the Content-Type header + localVarHttpContentTypes := []string{ "application/json", } + + // set Content-Type header + localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) + if localVarHttpContentType != "" { + headerParams["Content-Type"] = localVarHttpContentType + } + // to determine the Accept header + localVarHttpHeaderAccepts := []string{ + "application/json", + } + + // set Accept header + localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) + if localVarHttpHeaderAccept != "" { + headerParams["Accept"] = localVarHttpHeaderAccept + } + + response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) + if err != nil { + // Nothing special to do here, but do avoid processing the response + } else if err == nil && response.Error != nil { + err = errors.New(response.ErrorMessage) + } + return response, err +} + +// DeleteSpeechandtextanalyticsTopic invokes DELETE /api/v2/speechandtextanalytics/topics/{topicId} +// +// Delete a Speech & Text Analytics topic by id +// +// +func (a SpeechTextAnalyticsApi) DeleteSpeechandtextanalyticsTopic(topicId string) (*APIResponse, error) { + var httpMethod = "DELETE" + // create path and map variables + path := a.Configuration.BasePath + "/api/v2/speechandtextanalytics/topics/{topicId}" + path = strings.Replace(path, "{topicId}", fmt.Sprintf("%v", topicId), -1) + if true == false { + return nil, errors.New("This message brought to you by the laws of physics being broken") + } + + // verify the required parameter 'topicId' is set + if &topicId == nil { + // + return nil, errors.New("Missing required parameter 'topicId' when calling SpeechTextAnalyticsApi->DeleteSpeechandtextanalyticsTopic") + } + + headerParams := make(map[string]string) + queryParams := make(map[string]string) + formParams := url.Values{} + var postBody interface{} + var postFileName string + var fileBytes []byte + // authentication (PureCloud OAuth) required + + // oauth required + if a.Configuration.AccessToken != ""{ + headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken + } + // add default headers if any + for key := range a.Configuration.DefaultHeader { + headerParams[key] = a.Configuration.DefaultHeader[key] + } + + + // to determine the Content-Type header + localVarHttpContentTypes := []string{ "application/json", } + + // set Content-Type header + localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) + if localVarHttpContentType != "" { + headerParams["Content-Type"] = localVarHttpContentType + } + // to determine the Accept header + localVarHttpHeaderAccepts := []string{ + "application/json", + } + + // set Accept header + localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) + if localVarHttpHeaderAccept != "" { + headerParams["Accept"] = localVarHttpHeaderAccept + } + + response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) + if err != nil { + // Nothing special to do here, but do avoid processing the response + } else if err == nil && response.Error != nil { + err = errors.New(response.ErrorMessage) + } + return response, err +} + // GetSpeechandtextanalyticsConversation invokes GET /api/v2/speechandtextanalytics/conversations/{conversationId} // // Get Speech and Text Analytics for a specific conversation @@ -174,16 +320,16 @@ func (a SpeechTextAnalyticsApi) GetSpeechandtextanalyticsConversationCommunicati return successPayload, response, err } -// GetSpeechandtextanalyticsSettings invokes GET /api/v2/speechandtextanalytics/settings +// GetSpeechandtextanalyticsDialects invokes GET /api/v2/speechandtextanalytics/dialects // -// Get Speech And Text Analytics Settings +// Get list of supported Speech & Text Analytics dialects // // -func (a SpeechTextAnalyticsApi) GetSpeechandtextanalyticsSettings() (*Speechtextanalyticssettingsresponse, *APIResponse, error) { +func (a SpeechTextAnalyticsApi) GetSpeechandtextanalyticsDialects() ([]map[string]interface{}, *APIResponse, error) { var httpMethod = "GET" // create path and map variables - path := a.Configuration.BasePath + "/api/v2/speechandtextanalytics/settings" - defaultReturn := new(Speechtextanalyticssettingsresponse) + path := a.Configuration.BasePath + "/api/v2/speechandtextanalytics/dialects" + defaultReturn := make([]map[string]interface{}, 0) if true == false { return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") } @@ -225,7 +371,7 @@ func (a SpeechTextAnalyticsApi) GetSpeechandtextanalyticsSettings() (*Speechtext if localVarHttpHeaderAccept != "" { headerParams["Accept"] = localVarHttpHeaderAccept } - var successPayload *Speechtextanalyticssettingsresponse + var successPayload []map[string]interface{} response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) if err != nil { // Nothing special to do here, but do avoid processing the response @@ -237,24 +383,25 @@ func (a SpeechTextAnalyticsApi) GetSpeechandtextanalyticsSettings() (*Speechtext return successPayload, response, err } -// PatchSpeechandtextanalyticsSettings invokes PATCH /api/v2/speechandtextanalytics/settings +// GetSpeechandtextanalyticsProgram invokes GET /api/v2/speechandtextanalytics/programs/{programId} // -// Patch Speech And Text Analytics Settings +// Get a Speech & Text Analytics program by id // // -func (a SpeechTextAnalyticsApi) PatchSpeechandtextanalyticsSettings(body Speechtextanalyticssettingsrequest) (*Speechtextanalyticssettingsresponse, *APIResponse, error) { - var httpMethod = "PATCH" +func (a SpeechTextAnalyticsApi) GetSpeechandtextanalyticsProgram(programId string) (*Program, *APIResponse, error) { + var httpMethod = "GET" // create path and map variables - path := a.Configuration.BasePath + "/api/v2/speechandtextanalytics/settings" - defaultReturn := new(Speechtextanalyticssettingsresponse) + path := a.Configuration.BasePath + "/api/v2/speechandtextanalytics/programs/{programId}" + path = strings.Replace(path, "{programId}", fmt.Sprintf("%v", programId), -1) + defaultReturn := new(Program) if true == false { return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") } - // verify the required parameter 'body' is set - if &body == nil { + // verify the required parameter 'programId' is set + if &programId == nil { // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling SpeechTextAnalyticsApi->PatchSpeechandtextanalyticsSettings") + return defaultReturn, nil, errors.New("Missing required parameter 'programId' when calling SpeechTextAnalyticsApi->GetSpeechandtextanalyticsProgram") } headerParams := make(map[string]string) @@ -293,10 +440,96 @@ func (a SpeechTextAnalyticsApi) PatchSpeechandtextanalyticsSettings(body Speecht if localVarHttpHeaderAccept != "" { headerParams["Accept"] = localVarHttpHeaderAccept } - // body params - postBody = &body + var successPayload *Program + response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) + if err != nil { + // Nothing special to do here, but do avoid processing the response + } else if err == nil && response.Error != nil { + err = errors.New(response.ErrorMessage) + } else { + err = json.Unmarshal([]byte(response.RawBody), &successPayload) + } + return successPayload, response, err +} - var successPayload *Speechtextanalyticssettingsresponse +// GetSpeechandtextanalyticsPrograms invokes GET /api/v2/speechandtextanalytics/programs +// +// Get the list of Speech & Text Analytics programs +// +// +func (a SpeechTextAnalyticsApi) GetSpeechandtextanalyticsPrograms(nextPage string, pageSize int) (*Programsentitylisting, *APIResponse, error) { + var httpMethod = "GET" + // create path and map variables + path := a.Configuration.BasePath + "/api/v2/speechandtextanalytics/programs" + defaultReturn := new(Programsentitylisting) + if true == false { + return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") + } + + + headerParams := make(map[string]string) + queryParams := make(map[string]string) + formParams := url.Values{} + var postBody interface{} + var postFileName string + var fileBytes []byte + // authentication (PureCloud OAuth) required + + // oauth required + if a.Configuration.AccessToken != ""{ + headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken + } + // add default headers if any + for key := range a.Configuration.DefaultHeader { + headerParams[key] = a.Configuration.DefaultHeader[key] + } + + var collectionFormat string + + + + collectionFormat = "" + if str, ok := interface{}(nextPage).(string); ok { + if str != "" { + queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) + } + } else { + queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) + } + + + + + collectionFormat = "" + if str, ok := interface{}(pageSize).(string); ok { + if str != "" { + queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) + } + } else { + queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) + } + + + + // to determine the Content-Type header + localVarHttpContentTypes := []string{ "application/json", } + + // set Content-Type header + localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) + if localVarHttpContentType != "" { + headerParams["Content-Type"] = localVarHttpContentType + } + // to determine the Accept header + localVarHttpHeaderAccepts := []string{ + "application/json", + } + + // set Accept header + localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) + if localVarHttpHeaderAccept != "" { + headerParams["Accept"] = localVarHttpHeaderAccept + } + var successPayload *Programsentitylisting response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) if err != nil { // Nothing special to do here, but do avoid processing the response @@ -308,24 +541,25 @@ func (a SpeechTextAnalyticsApi) PatchSpeechandtextanalyticsSettings(body Speecht return successPayload, response, err } -// PostSpeechandtextanalyticsTranscriptsSearch invokes POST /api/v2/speechandtextanalytics/transcripts/search +// GetSpeechandtextanalyticsProgramsGeneralJob invokes GET /api/v2/speechandtextanalytics/programs/general/jobs/{jobId} // -// Search resources. +// Get a Speech & Text Analytics general program job by id // // -func (a SpeechTextAnalyticsApi) PostSpeechandtextanalyticsTranscriptsSearch(body Transcriptsearchrequest) (*Jsonsearchresponse, *APIResponse, error) { - var httpMethod = "POST" +func (a SpeechTextAnalyticsApi) GetSpeechandtextanalyticsProgramsGeneralJob(jobId string) (*Generalprogramjob, *APIResponse, error) { + var httpMethod = "GET" // create path and map variables - path := a.Configuration.BasePath + "/api/v2/speechandtextanalytics/transcripts/search" - defaultReturn := new(Jsonsearchresponse) + path := a.Configuration.BasePath + "/api/v2/speechandtextanalytics/programs/general/jobs/{jobId}" + path = strings.Replace(path, "{jobId}", fmt.Sprintf("%v", jobId), -1) + defaultReturn := new(Generalprogramjob) if true == false { return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") } - // verify the required parameter 'body' is set - if &body == nil { + // verify the required parameter 'jobId' is set + if &jobId == nil { // - return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling SpeechTextAnalyticsApi->PostSpeechandtextanalyticsTranscriptsSearch") + return defaultReturn, nil, errors.New("Missing required parameter 'jobId' when calling SpeechTextAnalyticsApi->GetSpeechandtextanalyticsProgramsGeneralJob") } headerParams := make(map[string]string) @@ -364,10 +598,1183 @@ func (a SpeechTextAnalyticsApi) PostSpeechandtextanalyticsTranscriptsSearch(body if localVarHttpHeaderAccept != "" { headerParams["Accept"] = localVarHttpHeaderAccept } - // body params - postBody = &body + var successPayload *Generalprogramjob + response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) + if err != nil { + // Nothing special to do here, but do avoid processing the response + } else if err == nil && response.Error != nil { + err = errors.New(response.ErrorMessage) + } else { + err = json.Unmarshal([]byte(response.RawBody), &successPayload) + } + return successPayload, response, err +} - var successPayload *Jsonsearchresponse +// GetSpeechandtextanalyticsProgramsPublishjob invokes GET /api/v2/speechandtextanalytics/programs/publishjobs/{jobId} +// +// Get a Speech & Text Analytics publish programs job by id +// +// +func (a SpeechTextAnalyticsApi) GetSpeechandtextanalyticsProgramsPublishjob(jobId string) (*Programjob, *APIResponse, error) { + var httpMethod = "GET" + // create path and map variables + path := a.Configuration.BasePath + "/api/v2/speechandtextanalytics/programs/publishjobs/{jobId}" + path = strings.Replace(path, "{jobId}", fmt.Sprintf("%v", jobId), -1) + defaultReturn := new(Programjob) + if true == false { + return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") + } + + // verify the required parameter 'jobId' is set + if &jobId == nil { + // + return defaultReturn, nil, errors.New("Missing required parameter 'jobId' when calling SpeechTextAnalyticsApi->GetSpeechandtextanalyticsProgramsPublishjob") + } + + headerParams := make(map[string]string) + queryParams := make(map[string]string) + formParams := url.Values{} + var postBody interface{} + var postFileName string + var fileBytes []byte + // authentication (PureCloud OAuth) required + + // oauth required + if a.Configuration.AccessToken != ""{ + headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken + } + // add default headers if any + for key := range a.Configuration.DefaultHeader { + headerParams[key] = a.Configuration.DefaultHeader[key] + } + + + // to determine the Content-Type header + localVarHttpContentTypes := []string{ "application/json", } + + // set Content-Type header + localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) + if localVarHttpContentType != "" { + headerParams["Content-Type"] = localVarHttpContentType + } + // to determine the Accept header + localVarHttpHeaderAccepts := []string{ + "application/json", + } + + // set Accept header + localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) + if localVarHttpHeaderAccept != "" { + headerParams["Accept"] = localVarHttpHeaderAccept + } + var successPayload *Programjob + response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) + if err != nil { + // Nothing special to do here, but do avoid processing the response + } else if err == nil && response.Error != nil { + err = errors.New(response.ErrorMessage) + } else { + err = json.Unmarshal([]byte(response.RawBody), &successPayload) + } + return successPayload, response, err +} + +// GetSpeechandtextanalyticsProgramsUnpublished invokes GET /api/v2/speechandtextanalytics/programs/unpublished +// +// Get the list of Speech & Text Analytics unpublished programs +// +// +func (a SpeechTextAnalyticsApi) GetSpeechandtextanalyticsProgramsUnpublished(nextPage string, pageSize int) (*Unpublishedprogramsentitylisting, *APIResponse, error) { + var httpMethod = "GET" + // create path and map variables + path := a.Configuration.BasePath + "/api/v2/speechandtextanalytics/programs/unpublished" + defaultReturn := new(Unpublishedprogramsentitylisting) + if true == false { + return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") + } + + + headerParams := make(map[string]string) + queryParams := make(map[string]string) + formParams := url.Values{} + var postBody interface{} + var postFileName string + var fileBytes []byte + // authentication (PureCloud OAuth) required + + // oauth required + if a.Configuration.AccessToken != ""{ + headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken + } + // add default headers if any + for key := range a.Configuration.DefaultHeader { + headerParams[key] = a.Configuration.DefaultHeader[key] + } + + var collectionFormat string + + + + collectionFormat = "" + if str, ok := interface{}(nextPage).(string); ok { + if str != "" { + queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) + } + } else { + queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) + } + + + + + collectionFormat = "" + if str, ok := interface{}(pageSize).(string); ok { + if str != "" { + queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) + } + } else { + queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) + } + + + + // to determine the Content-Type header + localVarHttpContentTypes := []string{ "application/json", } + + // set Content-Type header + localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) + if localVarHttpContentType != "" { + headerParams["Content-Type"] = localVarHttpContentType + } + // to determine the Accept header + localVarHttpHeaderAccepts := []string{ + "application/json", + } + + // set Accept header + localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) + if localVarHttpHeaderAccept != "" { + headerParams["Accept"] = localVarHttpHeaderAccept + } + var successPayload *Unpublishedprogramsentitylisting + response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) + if err != nil { + // Nothing special to do here, but do avoid processing the response + } else if err == nil && response.Error != nil { + err = errors.New(response.ErrorMessage) + } else { + err = json.Unmarshal([]byte(response.RawBody), &successPayload) + } + return successPayload, response, err +} + +// GetSpeechandtextanalyticsSettings invokes GET /api/v2/speechandtextanalytics/settings +// +// Get Speech And Text Analytics Settings +// +// +func (a SpeechTextAnalyticsApi) GetSpeechandtextanalyticsSettings() (*Speechtextanalyticssettingsresponse, *APIResponse, error) { + var httpMethod = "GET" + // create path and map variables + path := a.Configuration.BasePath + "/api/v2/speechandtextanalytics/settings" + defaultReturn := new(Speechtextanalyticssettingsresponse) + if true == false { + return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") + } + + + headerParams := make(map[string]string) + queryParams := make(map[string]string) + formParams := url.Values{} + var postBody interface{} + var postFileName string + var fileBytes []byte + // authentication (PureCloud OAuth) required + + // oauth required + if a.Configuration.AccessToken != ""{ + headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken + } + // add default headers if any + for key := range a.Configuration.DefaultHeader { + headerParams[key] = a.Configuration.DefaultHeader[key] + } + + + // to determine the Content-Type header + localVarHttpContentTypes := []string{ "application/json", } + + // set Content-Type header + localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) + if localVarHttpContentType != "" { + headerParams["Content-Type"] = localVarHttpContentType + } + // to determine the Accept header + localVarHttpHeaderAccepts := []string{ + "application/json", + } + + // set Accept header + localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) + if localVarHttpHeaderAccept != "" { + headerParams["Accept"] = localVarHttpHeaderAccept + } + var successPayload *Speechtextanalyticssettingsresponse + response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) + if err != nil { + // Nothing special to do here, but do avoid processing the response + } else if err == nil && response.Error != nil { + err = errors.New(response.ErrorMessage) + } else { + err = json.Unmarshal([]byte(response.RawBody), &successPayload) + } + return successPayload, response, err +} + +// GetSpeechandtextanalyticsTopic invokes GET /api/v2/speechandtextanalytics/topics/{topicId} +// +// Get a Speech & Text Analytics topic by id +// +// +func (a SpeechTextAnalyticsApi) GetSpeechandtextanalyticsTopic(topicId string) (*Topic, *APIResponse, error) { + var httpMethod = "GET" + // create path and map variables + path := a.Configuration.BasePath + "/api/v2/speechandtextanalytics/topics/{topicId}" + path = strings.Replace(path, "{topicId}", fmt.Sprintf("%v", topicId), -1) + defaultReturn := new(Topic) + if true == false { + return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") + } + + // verify the required parameter 'topicId' is set + if &topicId == nil { + // + return defaultReturn, nil, errors.New("Missing required parameter 'topicId' when calling SpeechTextAnalyticsApi->GetSpeechandtextanalyticsTopic") + } + + headerParams := make(map[string]string) + queryParams := make(map[string]string) + formParams := url.Values{} + var postBody interface{} + var postFileName string + var fileBytes []byte + // authentication (PureCloud OAuth) required + + // oauth required + if a.Configuration.AccessToken != ""{ + headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken + } + // add default headers if any + for key := range a.Configuration.DefaultHeader { + headerParams[key] = a.Configuration.DefaultHeader[key] + } + + + // to determine the Content-Type header + localVarHttpContentTypes := []string{ "application/json", } + + // set Content-Type header + localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) + if localVarHttpContentType != "" { + headerParams["Content-Type"] = localVarHttpContentType + } + // to determine the Accept header + localVarHttpHeaderAccepts := []string{ + "application/json", + } + + // set Accept header + localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) + if localVarHttpHeaderAccept != "" { + headerParams["Accept"] = localVarHttpHeaderAccept + } + var successPayload *Topic + response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) + if err != nil { + // Nothing special to do here, but do avoid processing the response + } else if err == nil && response.Error != nil { + err = errors.New(response.ErrorMessage) + } else { + err = json.Unmarshal([]byte(response.RawBody), &successPayload) + } + return successPayload, response, err +} + +// GetSpeechandtextanalyticsTopics invokes GET /api/v2/speechandtextanalytics/topics +// +// Get the list of Speech & Text Analytics topics +// +// +func (a SpeechTextAnalyticsApi) GetSpeechandtextanalyticsTopics(nextPage string, pageSize int) (*Topicsentitylisting, *APIResponse, error) { + var httpMethod = "GET" + // create path and map variables + path := a.Configuration.BasePath + "/api/v2/speechandtextanalytics/topics" + defaultReturn := new(Topicsentitylisting) + if true == false { + return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") + } + + + headerParams := make(map[string]string) + queryParams := make(map[string]string) + formParams := url.Values{} + var postBody interface{} + var postFileName string + var fileBytes []byte + // authentication (PureCloud OAuth) required + + // oauth required + if a.Configuration.AccessToken != ""{ + headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken + } + // add default headers if any + for key := range a.Configuration.DefaultHeader { + headerParams[key] = a.Configuration.DefaultHeader[key] + } + + var collectionFormat string + + + + collectionFormat = "" + if str, ok := interface{}(nextPage).(string); ok { + if str != "" { + queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) + } + } else { + queryParams["nextPage"] = a.Configuration.APIClient.ParameterToString(nextPage, collectionFormat) + } + + + + + collectionFormat = "" + if str, ok := interface{}(pageSize).(string); ok { + if str != "" { + queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) + } + } else { + queryParams["pageSize"] = a.Configuration.APIClient.ParameterToString(pageSize, collectionFormat) + } + + + + // to determine the Content-Type header + localVarHttpContentTypes := []string{ "application/json", } + + // set Content-Type header + localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) + if localVarHttpContentType != "" { + headerParams["Content-Type"] = localVarHttpContentType + } + // to determine the Accept header + localVarHttpHeaderAccepts := []string{ + "application/json", + } + + // set Accept header + localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) + if localVarHttpHeaderAccept != "" { + headerParams["Accept"] = localVarHttpHeaderAccept + } + var successPayload *Topicsentitylisting + response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) + if err != nil { + // Nothing special to do here, but do avoid processing the response + } else if err == nil && response.Error != nil { + err = errors.New(response.ErrorMessage) + } else { + err = json.Unmarshal([]byte(response.RawBody), &successPayload) + } + return successPayload, response, err +} + +// GetSpeechandtextanalyticsTopicsGeneral invokes GET /api/v2/speechandtextanalytics/topics/general +// +// Get the Speech & Text Analytics general topics for a given dialect +// +// +func (a SpeechTextAnalyticsApi) GetSpeechandtextanalyticsTopicsGeneral(dialect string) (*Generaltopicsentitylisting, *APIResponse, error) { + var httpMethod = "GET" + // create path and map variables + path := a.Configuration.BasePath + "/api/v2/speechandtextanalytics/topics/general" + defaultReturn := new(Generaltopicsentitylisting) + if true == false { + return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") + } + + + headerParams := make(map[string]string) + queryParams := make(map[string]string) + formParams := url.Values{} + var postBody interface{} + var postFileName string + var fileBytes []byte + // authentication (PureCloud OAuth) required + + // oauth required + if a.Configuration.AccessToken != ""{ + headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken + } + // add default headers if any + for key := range a.Configuration.DefaultHeader { + headerParams[key] = a.Configuration.DefaultHeader[key] + } + + var collectionFormat string + + + + collectionFormat = "" + if str, ok := interface{}(dialect).(string); ok { + if str != "" { + queryParams["dialect"] = a.Configuration.APIClient.ParameterToString(dialect, collectionFormat) + } + } else { + queryParams["dialect"] = a.Configuration.APIClient.ParameterToString(dialect, collectionFormat) + } + + + + // to determine the Content-Type header + localVarHttpContentTypes := []string{ "application/json", } + + // set Content-Type header + localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) + if localVarHttpContentType != "" { + headerParams["Content-Type"] = localVarHttpContentType + } + // to determine the Accept header + localVarHttpHeaderAccepts := []string{ + "application/json", + } + + // set Accept header + localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) + if localVarHttpHeaderAccept != "" { + headerParams["Accept"] = localVarHttpHeaderAccept + } + var successPayload *Generaltopicsentitylisting + response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) + if err != nil { + // Nothing special to do here, but do avoid processing the response + } else if err == nil && response.Error != nil { + err = errors.New(response.ErrorMessage) + } else { + err = json.Unmarshal([]byte(response.RawBody), &successPayload) + } + return successPayload, response, err +} + +// GetSpeechandtextanalyticsTopicsPublishjob invokes GET /api/v2/speechandtextanalytics/topics/publishjobs/{jobId} +// +// Get a Speech & Text Analytics publish topics job by id +// +// +func (a SpeechTextAnalyticsApi) GetSpeechandtextanalyticsTopicsPublishjob(jobId string) (*Topicjob, *APIResponse, error) { + var httpMethod = "GET" + // create path and map variables + path := a.Configuration.BasePath + "/api/v2/speechandtextanalytics/topics/publishjobs/{jobId}" + path = strings.Replace(path, "{jobId}", fmt.Sprintf("%v", jobId), -1) + defaultReturn := new(Topicjob) + if true == false { + return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") + } + + // verify the required parameter 'jobId' is set + if &jobId == nil { + // + return defaultReturn, nil, errors.New("Missing required parameter 'jobId' when calling SpeechTextAnalyticsApi->GetSpeechandtextanalyticsTopicsPublishjob") + } + + headerParams := make(map[string]string) + queryParams := make(map[string]string) + formParams := url.Values{} + var postBody interface{} + var postFileName string + var fileBytes []byte + // authentication (PureCloud OAuth) required + + // oauth required + if a.Configuration.AccessToken != ""{ + headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken + } + // add default headers if any + for key := range a.Configuration.DefaultHeader { + headerParams[key] = a.Configuration.DefaultHeader[key] + } + + + // to determine the Content-Type header + localVarHttpContentTypes := []string{ "application/json", } + + // set Content-Type header + localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) + if localVarHttpContentType != "" { + headerParams["Content-Type"] = localVarHttpContentType + } + // to determine the Accept header + localVarHttpHeaderAccepts := []string{ + "application/json", + } + + // set Accept header + localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) + if localVarHttpHeaderAccept != "" { + headerParams["Accept"] = localVarHttpHeaderAccept + } + var successPayload *Topicjob + response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) + if err != nil { + // Nothing special to do here, but do avoid processing the response + } else if err == nil && response.Error != nil { + err = errors.New(response.ErrorMessage) + } else { + err = json.Unmarshal([]byte(response.RawBody), &successPayload) + } + return successPayload, response, err +} + +// PatchSpeechandtextanalyticsSettings invokes PATCH /api/v2/speechandtextanalytics/settings +// +// Patch Speech And Text Analytics Settings +// +// +func (a SpeechTextAnalyticsApi) PatchSpeechandtextanalyticsSettings(body Speechtextanalyticssettingsrequest) (*Speechtextanalyticssettingsresponse, *APIResponse, error) { + var httpMethod = "PATCH" + // create path and map variables + path := a.Configuration.BasePath + "/api/v2/speechandtextanalytics/settings" + defaultReturn := new(Speechtextanalyticssettingsresponse) + if true == false { + return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") + } + + // verify the required parameter 'body' is set + if &body == nil { + // + return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling SpeechTextAnalyticsApi->PatchSpeechandtextanalyticsSettings") + } + + headerParams := make(map[string]string) + queryParams := make(map[string]string) + formParams := url.Values{} + var postBody interface{} + var postFileName string + var fileBytes []byte + // authentication (PureCloud OAuth) required + + // oauth required + if a.Configuration.AccessToken != ""{ + headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken + } + // add default headers if any + for key := range a.Configuration.DefaultHeader { + headerParams[key] = a.Configuration.DefaultHeader[key] + } + + + // to determine the Content-Type header + localVarHttpContentTypes := []string{ "application/json", } + + // set Content-Type header + localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) + if localVarHttpContentType != "" { + headerParams["Content-Type"] = localVarHttpContentType + } + // to determine the Accept header + localVarHttpHeaderAccepts := []string{ + "application/json", + } + + // set Accept header + localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) + if localVarHttpHeaderAccept != "" { + headerParams["Accept"] = localVarHttpHeaderAccept + } + // body params + postBody = &body + + var successPayload *Speechtextanalyticssettingsresponse + response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) + if err != nil { + // Nothing special to do here, but do avoid processing the response + } else if err == nil && response.Error != nil { + err = errors.New(response.ErrorMessage) + } else { + err = json.Unmarshal([]byte(response.RawBody), &successPayload) + } + return successPayload, response, err +} + +// PostSpeechandtextanalyticsPrograms invokes POST /api/v2/speechandtextanalytics/programs +// +// Create new Speech & Text Analytics program +// +// +func (a SpeechTextAnalyticsApi) PostSpeechandtextanalyticsPrograms(body Programrequest) (*Program, *APIResponse, error) { + var httpMethod = "POST" + // create path and map variables + path := a.Configuration.BasePath + "/api/v2/speechandtextanalytics/programs" + defaultReturn := new(Program) + if true == false { + return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") + } + + // verify the required parameter 'body' is set + if &body == nil { + // + return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling SpeechTextAnalyticsApi->PostSpeechandtextanalyticsPrograms") + } + + headerParams := make(map[string]string) + queryParams := make(map[string]string) + formParams := url.Values{} + var postBody interface{} + var postFileName string + var fileBytes []byte + // authentication (PureCloud OAuth) required + + // oauth required + if a.Configuration.AccessToken != ""{ + headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken + } + // add default headers if any + for key := range a.Configuration.DefaultHeader { + headerParams[key] = a.Configuration.DefaultHeader[key] + } + + + // to determine the Content-Type header + localVarHttpContentTypes := []string{ "application/json", } + + // set Content-Type header + localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) + if localVarHttpContentType != "" { + headerParams["Content-Type"] = localVarHttpContentType + } + // to determine the Accept header + localVarHttpHeaderAccepts := []string{ + "application/json", + } + + // set Accept header + localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) + if localVarHttpHeaderAccept != "" { + headerParams["Accept"] = localVarHttpHeaderAccept + } + // body params + postBody = &body + + var successPayload *Program + response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) + if err != nil { + // Nothing special to do here, but do avoid processing the response + } else if err == nil && response.Error != nil { + err = errors.New(response.ErrorMessage) + } else { + err = json.Unmarshal([]byte(response.RawBody), &successPayload) + } + return successPayload, response, err +} + +// PostSpeechandtextanalyticsProgramsGeneralJobs invokes POST /api/v2/speechandtextanalytics/programs/general/jobs +// +// Create new Speech & Text Analytics general program job +// +// +func (a SpeechTextAnalyticsApi) PostSpeechandtextanalyticsProgramsGeneralJobs(body Generalprogramjobrequest) (*Generalprogramjob, *APIResponse, error) { + var httpMethod = "POST" + // create path and map variables + path := a.Configuration.BasePath + "/api/v2/speechandtextanalytics/programs/general/jobs" + defaultReturn := new(Generalprogramjob) + if true == false { + return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") + } + + // verify the required parameter 'body' is set + if &body == nil { + // + return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling SpeechTextAnalyticsApi->PostSpeechandtextanalyticsProgramsGeneralJobs") + } + + headerParams := make(map[string]string) + queryParams := make(map[string]string) + formParams := url.Values{} + var postBody interface{} + var postFileName string + var fileBytes []byte + // authentication (PureCloud OAuth) required + + // oauth required + if a.Configuration.AccessToken != ""{ + headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken + } + // add default headers if any + for key := range a.Configuration.DefaultHeader { + headerParams[key] = a.Configuration.DefaultHeader[key] + } + + + // to determine the Content-Type header + localVarHttpContentTypes := []string{ "application/json", } + + // set Content-Type header + localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) + if localVarHttpContentType != "" { + headerParams["Content-Type"] = localVarHttpContentType + } + // to determine the Accept header + localVarHttpHeaderAccepts := []string{ + "application/json", + } + + // set Accept header + localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) + if localVarHttpHeaderAccept != "" { + headerParams["Accept"] = localVarHttpHeaderAccept + } + // body params + postBody = &body + + var successPayload *Generalprogramjob + response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) + if err != nil { + // Nothing special to do here, but do avoid processing the response + } else if err == nil && response.Error != nil { + err = errors.New(response.ErrorMessage) + } else { + err = json.Unmarshal([]byte(response.RawBody), &successPayload) + } + return successPayload, response, err +} + +// PostSpeechandtextanalyticsProgramsPublishjobs invokes POST /api/v2/speechandtextanalytics/programs/publishjobs +// +// Create new Speech & Text Analytics publish programs job +// +// +func (a SpeechTextAnalyticsApi) PostSpeechandtextanalyticsProgramsPublishjobs(body Programjobrequest) (*Programjob, *APIResponse, error) { + var httpMethod = "POST" + // create path and map variables + path := a.Configuration.BasePath + "/api/v2/speechandtextanalytics/programs/publishjobs" + defaultReturn := new(Programjob) + if true == false { + return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") + } + + // verify the required parameter 'body' is set + if &body == nil { + // + return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling SpeechTextAnalyticsApi->PostSpeechandtextanalyticsProgramsPublishjobs") + } + + headerParams := make(map[string]string) + queryParams := make(map[string]string) + formParams := url.Values{} + var postBody interface{} + var postFileName string + var fileBytes []byte + // authentication (PureCloud OAuth) required + + // oauth required + if a.Configuration.AccessToken != ""{ + headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken + } + // add default headers if any + for key := range a.Configuration.DefaultHeader { + headerParams[key] = a.Configuration.DefaultHeader[key] + } + + + // to determine the Content-Type header + localVarHttpContentTypes := []string{ "application/json", } + + // set Content-Type header + localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) + if localVarHttpContentType != "" { + headerParams["Content-Type"] = localVarHttpContentType + } + // to determine the Accept header + localVarHttpHeaderAccepts := []string{ + "application/json", + } + + // set Accept header + localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) + if localVarHttpHeaderAccept != "" { + headerParams["Accept"] = localVarHttpHeaderAccept + } + // body params + postBody = &body + + var successPayload *Programjob + response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) + if err != nil { + // Nothing special to do here, but do avoid processing the response + } else if err == nil && response.Error != nil { + err = errors.New(response.ErrorMessage) + } else { + err = json.Unmarshal([]byte(response.RawBody), &successPayload) + } + return successPayload, response, err +} + +// PostSpeechandtextanalyticsTopics invokes POST /api/v2/speechandtextanalytics/topics +// +// Create new Speech & Text Analytics topic +// +// +func (a SpeechTextAnalyticsApi) PostSpeechandtextanalyticsTopics(body Topicrequest) (*Topic, *APIResponse, error) { + var httpMethod = "POST" + // create path and map variables + path := a.Configuration.BasePath + "/api/v2/speechandtextanalytics/topics" + defaultReturn := new(Topic) + if true == false { + return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") + } + + // verify the required parameter 'body' is set + if &body == nil { + // + return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling SpeechTextAnalyticsApi->PostSpeechandtextanalyticsTopics") + } + + headerParams := make(map[string]string) + queryParams := make(map[string]string) + formParams := url.Values{} + var postBody interface{} + var postFileName string + var fileBytes []byte + // authentication (PureCloud OAuth) required + + // oauth required + if a.Configuration.AccessToken != ""{ + headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken + } + // add default headers if any + for key := range a.Configuration.DefaultHeader { + headerParams[key] = a.Configuration.DefaultHeader[key] + } + + + // to determine the Content-Type header + localVarHttpContentTypes := []string{ "application/json", } + + // set Content-Type header + localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) + if localVarHttpContentType != "" { + headerParams["Content-Type"] = localVarHttpContentType + } + // to determine the Accept header + localVarHttpHeaderAccepts := []string{ + "application/json", + } + + // set Accept header + localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) + if localVarHttpHeaderAccept != "" { + headerParams["Accept"] = localVarHttpHeaderAccept + } + // body params + postBody = &body + + var successPayload *Topic + response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) + if err != nil { + // Nothing special to do here, but do avoid processing the response + } else if err == nil && response.Error != nil { + err = errors.New(response.ErrorMessage) + } else { + err = json.Unmarshal([]byte(response.RawBody), &successPayload) + } + return successPayload, response, err +} + +// PostSpeechandtextanalyticsTopicsPublishjobs invokes POST /api/v2/speechandtextanalytics/topics/publishjobs +// +// Create new Speech & Text Analytics publish topics job +// +// +func (a SpeechTextAnalyticsApi) PostSpeechandtextanalyticsTopicsPublishjobs(body Topicjobrequest) (*Topicjob, *APIResponse, error) { + var httpMethod = "POST" + // create path and map variables + path := a.Configuration.BasePath + "/api/v2/speechandtextanalytics/topics/publishjobs" + defaultReturn := new(Topicjob) + if true == false { + return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") + } + + // verify the required parameter 'body' is set + if &body == nil { + // + return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling SpeechTextAnalyticsApi->PostSpeechandtextanalyticsTopicsPublishjobs") + } + + headerParams := make(map[string]string) + queryParams := make(map[string]string) + formParams := url.Values{} + var postBody interface{} + var postFileName string + var fileBytes []byte + // authentication (PureCloud OAuth) required + + // oauth required + if a.Configuration.AccessToken != ""{ + headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken + } + // add default headers if any + for key := range a.Configuration.DefaultHeader { + headerParams[key] = a.Configuration.DefaultHeader[key] + } + + + // to determine the Content-Type header + localVarHttpContentTypes := []string{ "application/json", } + + // set Content-Type header + localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) + if localVarHttpContentType != "" { + headerParams["Content-Type"] = localVarHttpContentType + } + // to determine the Accept header + localVarHttpHeaderAccepts := []string{ + "application/json", + } + + // set Accept header + localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) + if localVarHttpHeaderAccept != "" { + headerParams["Accept"] = localVarHttpHeaderAccept + } + // body params + postBody = &body + + var successPayload *Topicjob + response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) + if err != nil { + // Nothing special to do here, but do avoid processing the response + } else if err == nil && response.Error != nil { + err = errors.New(response.ErrorMessage) + } else { + err = json.Unmarshal([]byte(response.RawBody), &successPayload) + } + return successPayload, response, err +} + +// PostSpeechandtextanalyticsTranscriptsSearch invokes POST /api/v2/speechandtextanalytics/transcripts/search +// +// Search resources. +// +// +func (a SpeechTextAnalyticsApi) PostSpeechandtextanalyticsTranscriptsSearch(body Transcriptsearchrequest) (*Jsonsearchresponse, *APIResponse, error) { + var httpMethod = "POST" + // create path and map variables + path := a.Configuration.BasePath + "/api/v2/speechandtextanalytics/transcripts/search" + defaultReturn := new(Jsonsearchresponse) + if true == false { + return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") + } + + // verify the required parameter 'body' is set + if &body == nil { + // + return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling SpeechTextAnalyticsApi->PostSpeechandtextanalyticsTranscriptsSearch") + } + + headerParams := make(map[string]string) + queryParams := make(map[string]string) + formParams := url.Values{} + var postBody interface{} + var postFileName string + var fileBytes []byte + // authentication (PureCloud OAuth) required + + // oauth required + if a.Configuration.AccessToken != ""{ + headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken + } + // add default headers if any + for key := range a.Configuration.DefaultHeader { + headerParams[key] = a.Configuration.DefaultHeader[key] + } + + + // to determine the Content-Type header + localVarHttpContentTypes := []string{ "application/json", } + + // set Content-Type header + localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) + if localVarHttpContentType != "" { + headerParams["Content-Type"] = localVarHttpContentType + } + // to determine the Accept header + localVarHttpHeaderAccepts := []string{ + "application/json", + } + + // set Accept header + localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) + if localVarHttpHeaderAccept != "" { + headerParams["Accept"] = localVarHttpHeaderAccept + } + // body params + postBody = &body + + var successPayload *Jsonsearchresponse + response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) + if err != nil { + // Nothing special to do here, but do avoid processing the response + } else if err == nil && response.Error != nil { + err = errors.New(response.ErrorMessage) + } else { + err = json.Unmarshal([]byte(response.RawBody), &successPayload) + } + return successPayload, response, err +} + +// PutSpeechandtextanalyticsProgram invokes PUT /api/v2/speechandtextanalytics/programs/{programId} +// +// Update existing Speech & Text Analytics program +// +// +func (a SpeechTextAnalyticsApi) PutSpeechandtextanalyticsProgram(programId string, body Programrequest) (*Program, *APIResponse, error) { + var httpMethod = "PUT" + // create path and map variables + path := a.Configuration.BasePath + "/api/v2/speechandtextanalytics/programs/{programId}" + path = strings.Replace(path, "{programId}", fmt.Sprintf("%v", programId), -1) + defaultReturn := new(Program) + if true == false { + return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") + } + + // verify the required parameter 'programId' is set + if &programId == nil { + // + return defaultReturn, nil, errors.New("Missing required parameter 'programId' when calling SpeechTextAnalyticsApi->PutSpeechandtextanalyticsProgram") + } + // verify the required parameter 'body' is set + if &body == nil { + // + return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling SpeechTextAnalyticsApi->PutSpeechandtextanalyticsProgram") + } + + headerParams := make(map[string]string) + queryParams := make(map[string]string) + formParams := url.Values{} + var postBody interface{} + var postFileName string + var fileBytes []byte + // authentication (PureCloud OAuth) required + + // oauth required + if a.Configuration.AccessToken != ""{ + headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken + } + // add default headers if any + for key := range a.Configuration.DefaultHeader { + headerParams[key] = a.Configuration.DefaultHeader[key] + } + + + // to determine the Content-Type header + localVarHttpContentTypes := []string{ "application/json", } + + // set Content-Type header + localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) + if localVarHttpContentType != "" { + headerParams["Content-Type"] = localVarHttpContentType + } + // to determine the Accept header + localVarHttpHeaderAccepts := []string{ + "application/json", + } + + // set Accept header + localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) + if localVarHttpHeaderAccept != "" { + headerParams["Accept"] = localVarHttpHeaderAccept + } + // body params + postBody = &body + + var successPayload *Program + response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) + if err != nil { + // Nothing special to do here, but do avoid processing the response + } else if err == nil && response.Error != nil { + err = errors.New(response.ErrorMessage) + } else { + err = json.Unmarshal([]byte(response.RawBody), &successPayload) + } + return successPayload, response, err +} + +// PutSpeechandtextanalyticsTopic invokes PUT /api/v2/speechandtextanalytics/topics/{topicId} +// +// Update existing Speech & Text Analytics topic +// +// +func (a SpeechTextAnalyticsApi) PutSpeechandtextanalyticsTopic(topicId string, body Topicrequest) (*Topic, *APIResponse, error) { + var httpMethod = "PUT" + // create path and map variables + path := a.Configuration.BasePath + "/api/v2/speechandtextanalytics/topics/{topicId}" + path = strings.Replace(path, "{topicId}", fmt.Sprintf("%v", topicId), -1) + defaultReturn := new(Topic) + if true == false { + return defaultReturn, nil, errors.New("This message brought to you by the laws of physics being broken") + } + + // verify the required parameter 'topicId' is set + if &topicId == nil { + // + return defaultReturn, nil, errors.New("Missing required parameter 'topicId' when calling SpeechTextAnalyticsApi->PutSpeechandtextanalyticsTopic") + } + // verify the required parameter 'body' is set + if &body == nil { + // + return defaultReturn, nil, errors.New("Missing required parameter 'body' when calling SpeechTextAnalyticsApi->PutSpeechandtextanalyticsTopic") + } + + headerParams := make(map[string]string) + queryParams := make(map[string]string) + formParams := url.Values{} + var postBody interface{} + var postFileName string + var fileBytes []byte + // authentication (PureCloud OAuth) required + + // oauth required + if a.Configuration.AccessToken != ""{ + headerParams["Authorization"] = "Bearer " + a.Configuration.AccessToken + } + // add default headers if any + for key := range a.Configuration.DefaultHeader { + headerParams[key] = a.Configuration.DefaultHeader[key] + } + + + // to determine the Content-Type header + localVarHttpContentTypes := []string{ "application/json", } + + // set Content-Type header + localVarHttpContentType := a.Configuration.APIClient.SelectHeaderContentType(localVarHttpContentTypes) + if localVarHttpContentType != "" { + headerParams["Content-Type"] = localVarHttpContentType + } + // to determine the Accept header + localVarHttpHeaderAccepts := []string{ + "application/json", + } + + // set Accept header + localVarHttpHeaderAccept := a.Configuration.APIClient.SelectHeaderAccept(localVarHttpHeaderAccepts) + if localVarHttpHeaderAccept != "" { + headerParams["Accept"] = localVarHttpHeaderAccept + } + // body params + postBody = &body + + var successPayload *Topic response, err := a.Configuration.APIClient.CallAPI(path, httpMethod, postBody, headerParams, queryParams, formParams, postFileName, fileBytes) if err != nil { // Nothing special to do here, but do avoid processing the response diff --git a/platformclientv2/supportedcontentreference.go b/platformclientv2/supportedcontentreference.go new file mode 100644 index 000000000..8219aeef8 --- /dev/null +++ b/platformclientv2/supportedcontentreference.go @@ -0,0 +1,29 @@ +package platformclientv2 +import ( + "encoding/json" +) + +// Supportedcontentreference - Reference to supported content profile associated with the integration +type Supportedcontentreference struct { + // Id - The SupportedContent unique identifier associated with this integration + Id *string `json:"id,omitempty"` + + + // Name - The SupportedContent profile name + Name *string `json:"name,omitempty"` + + + // SelfUri - The SupportedContent profile URI + SelfUri *string `json:"selfUri,omitempty"` + + + // MediaTypes - Media types definition for the supported content + MediaTypes *Mediatypes `json:"mediaTypes,omitempty"` + +} + +// String returns a JSON representation of the model +func (o *Supportedcontentreference) String() string { + j, _ := json.Marshal(o) + return string(j) +} diff --git a/platformclientv2/topic.go b/platformclientv2/topic.go new file mode 100644 index 000000000..36104cbc2 --- /dev/null +++ b/platformclientv2/topic.go @@ -0,0 +1,74 @@ +package platformclientv2 +import ( + "time" + "encoding/json" +) + +// Topic +type Topic struct { + // Id - The globally unique identifier for the object. + Id *string `json:"id,omitempty"` + + + // Name + Name *string `json:"name,omitempty"` + + + // Description + Description *string `json:"description,omitempty"` + + + // Published + Published *bool `json:"published,omitempty"` + + + // Strictness + Strictness *string `json:"strictness,omitempty"` + + + // Programs + Programs *[]Baseprogramentity `json:"programs,omitempty"` + + + // Tags + Tags *[]string `json:"tags,omitempty"` + + + // Dialect + Dialect *string `json:"dialect,omitempty"` + + + // Participants + Participants *string `json:"participants,omitempty"` + + + // Phrases + Phrases *[]Phrase `json:"phrases,omitempty"` + + + // ModifiedBy + ModifiedBy *Addressableentityref `json:"modifiedBy,omitempty"` + + + // DateModified - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z + DateModified *time.Time `json:"dateModified,omitempty"` + + + // PublishedBy + PublishedBy *Addressableentityref `json:"publishedBy,omitempty"` + + + // DatePublished - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z + DatePublished *time.Time `json:"datePublished,omitempty"` + + + // SelfUri - The URI for this object + SelfUri *string `json:"selfUri,omitempty"` + +} + +// String returns a JSON representation of the model +func (o *Topic) String() string { + j, _ := json.Marshal(o) + return string(j) +} diff --git a/build/platformclientv2/attribute.go b/platformclientv2/topicjob.go similarity index 63% rename from build/platformclientv2/attribute.go rename to platformclientv2/topicjob.go index d6aa1dd24..6d4d1ba9e 100644 --- a/build/platformclientv2/attribute.go +++ b/platformclientv2/topicjob.go @@ -4,36 +4,28 @@ import ( "encoding/json" ) -// Attribute -type Attribute struct { +// Topicjob +type Topicjob struct { // Id - The globally unique identifier for the object. Id *string `json:"id,omitempty"` - // Name - The attribute name. - Name *string `json:"name,omitempty"` + // State + State *string `json:"state,omitempty"` - // Version - Version *int `json:"version,omitempty"` - - - // Description - Description *string `json:"description,omitempty"` + // Topics + Topics *[]Basetopicentitiy `json:"topics,omitempty"` // CreatedBy - CreatedBy *Domainentityref `json:"createdBy,omitempty"` + CreatedBy *Addressableentityref `json:"createdBy,omitempty"` // DateCreated - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z DateCreated *time.Time `json:"dateCreated,omitempty"` - // ModifiedBy - ModifiedBy *Domainentityref `json:"modifiedBy,omitempty"` - - // DateModified - Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z DateModified *time.Time `json:"dateModified,omitempty"` @@ -44,7 +36,7 @@ type Attribute struct { } // String returns a JSON representation of the model -func (o *Attribute) String() string { +func (o *Topicjob) String() string { j, _ := json.Marshal(o) return string(j) } diff --git a/platformclientv2/topicjobrequest.go b/platformclientv2/topicjobrequest.go new file mode 100644 index 000000000..2c2aeb309 --- /dev/null +++ b/platformclientv2/topicjobrequest.go @@ -0,0 +1,17 @@ +package platformclientv2 +import ( + "encoding/json" +) + +// Topicjobrequest +type Topicjobrequest struct { + // TopicIds - The ids of the topics used for this job + TopicIds *[]string `json:"topicIds,omitempty"` + +} + +// String returns a JSON representation of the model +func (o *Topicjobrequest) String() string { + j, _ := json.Marshal(o) + return string(j) +} diff --git a/platformclientv2/topicrequest.go b/platformclientv2/topicrequest.go new file mode 100644 index 000000000..e7d409c68 --- /dev/null +++ b/platformclientv2/topicrequest.go @@ -0,0 +1,45 @@ +package platformclientv2 +import ( + "encoding/json" +) + +// Topicrequest +type Topicrequest struct { + // Name - The topic name + Name *string `json:"name,omitempty"` + + + // Description - The topic description + Description *string `json:"description,omitempty"` + + + // Strictness - The topic strictness, default value is 72 + Strictness *string `json:"strictness,omitempty"` + + + // ProgramIds - The ids of programs associated to the topic + ProgramIds *[]string `json:"programIds,omitempty"` + + + // Tags - The topic tags + Tags *[]string `json:"tags,omitempty"` + + + // Dialect - The topic dialect + Dialect *string `json:"dialect,omitempty"` + + + // Participants - The topic participants, default value is All + Participants *string `json:"participants,omitempty"` + + + // Phrases - The topic phrases + Phrases *[]Phrase `json:"phrases,omitempty"` + +} + +// String returns a JSON representation of the model +func (o *Topicrequest) String() string { + j, _ := json.Marshal(o) + return string(j) +} diff --git a/build/platformclientv2/categoryentitylisting.go b/platformclientv2/topicsentitylisting.go similarity index 51% rename from build/platformclientv2/categoryentitylisting.go rename to platformclientv2/topicsentitylisting.go index 13d49e76c..265a50835 100644 --- a/build/platformclientv2/categoryentitylisting.go +++ b/platformclientv2/topicsentitylisting.go @@ -3,22 +3,22 @@ import ( "encoding/json" ) -// Categoryentitylisting -type Categoryentitylisting struct { +// Topicsentitylisting +type Topicsentitylisting struct { // Entities - Entities *[]Category `json:"entities,omitempty"` + Entities *[]Listedtopic `json:"entities,omitempty"` // PageSize PageSize *int `json:"pageSize,omitempty"` - // PageNumber - PageNumber *int `json:"pageNumber,omitempty"` + // SelfUri + SelfUri *string `json:"selfUri,omitempty"` - // Total - Total *int `json:"total,omitempty"` + // NextUri + NextUri *string `json:"nextUri,omitempty"` // PageCount @@ -27,7 +27,7 @@ type Categoryentitylisting struct { } // String returns a JSON representation of the model -func (o *Categoryentitylisting) String() string { +func (o *Topicsentitylisting) String() string { j, _ := json.Marshal(o) return string(j) } diff --git a/platformclientv2/unpublishedprogramsentitylisting.go b/platformclientv2/unpublishedprogramsentitylisting.go new file mode 100644 index 000000000..2d702944d --- /dev/null +++ b/platformclientv2/unpublishedprogramsentitylisting.go @@ -0,0 +1,33 @@ +package platformclientv2 +import ( + "encoding/json" +) + +// Unpublishedprogramsentitylisting +type Unpublishedprogramsentitylisting struct { + // Entities + Entities *[]Program `json:"entities,omitempty"` + + + // PageSize + PageSize *int `json:"pageSize,omitempty"` + + + // SelfUri + SelfUri *string `json:"selfUri,omitempty"` + + + // NextUri + NextUri *string `json:"nextUri,omitempty"` + + + // PageCount + PageCount *int `json:"pageCount,omitempty"` + +} + +// String returns a JSON representation of the model +func (o *Unpublishedprogramsentitylisting) String() string { + j, _ := json.Marshal(o) + return string(j) +} diff --git a/platformclientv2/usersearchrequest.go b/platformclientv2/usersearchrequest.go index 0d20cbb62..d46ea6f30 100644 --- a/platformclientv2/usersearchrequest.go +++ b/platformclientv2/usersearchrequest.go @@ -37,7 +37,7 @@ type Usersearchrequest struct { IntegrationPresenceSource *string `json:"integrationPresenceSource,omitempty"` - // EnforcePermissions - Enforce view permission on request + // EnforcePermissions - When set to true add additional search criteria to filter users by directory:user:view EnforcePermissions *bool `json:"enforcePermissions,omitempty"` } diff --git a/platformclientv2/wemlearningassignmenttopiclearningassignmentnotification.go b/platformclientv2/wemlearningassignmenttopiclearningassignmentnotification.go index 59c1c3d67..3dd1d3031 100644 --- a/platformclientv2/wemlearningassignmenttopiclearningassignmentnotification.go +++ b/platformclientv2/wemlearningassignmenttopiclearningassignmentnotification.go @@ -45,6 +45,10 @@ type Wemlearningassignmenttopiclearningassignmentnotification struct { // DateModified DateModified *time.Time `json:"dateModified,omitempty"` + + // IsOverdue + IsOverdue *bool `json:"isOverdue,omitempty"` + } // String returns a JSON representation of the model diff --git a/platformclientv2/workforcemanagementapi.go b/platformclientv2/workforcemanagementapi.go index a9c9785aa..a8ce0f4e4 100644 --- a/platformclientv2/workforcemanagementapi.go +++ b/platformclientv2/workforcemanagementapi.go @@ -2926,7 +2926,7 @@ func (a WorkforceManagementApi) GetWorkforcemanagementBusinessunitsDivisionviews // // Get management unit // -// +// settings.shortTermForecasting is deprecated and now lives on the business unit func (a WorkforceManagementApi) GetWorkforcemanagementManagementunit(managementUnitId string, expand []string) (*Managementunit, *APIResponse, error) { var httpMethod = "GET" // create path and map variables diff --git a/platformclientv2/workplan.go b/platformclientv2/workplan.go index b2a2171ab..75dae18ae 100644 --- a/platformclientv2/workplan.go +++ b/platformclientv2/workplan.go @@ -37,7 +37,7 @@ type Workplan struct { WeeklyMaximumPaidMinutes *int `json:"weeklyMaximumPaidMinutes,omitempty"` - // ConstrainPaidTimeGranularity - Whether paid time granularity is constrained for this workplan + // ConstrainPaidTimeGranularity - Whether paid time granularity is constrained for this work plan ConstrainPaidTimeGranularity *bool `json:"constrainPaidTimeGranularity,omitempty"` @@ -57,14 +57,58 @@ type Workplan struct { MaximumDays *int `json:"maximumDays,omitempty"` + // MinimumConsecutiveNonWorkingMinutesPerWeek - Minimum amount of consecutive non working minutes per week that agents who are assigned this work plan are allowed to have off + MinimumConsecutiveNonWorkingMinutesPerWeek *int `json:"minimumConsecutiveNonWorkingMinutesPerWeek,omitempty"` + + + // ConstrainMaximumConsecutiveWorkingWeekends - Whether to constrain the maximum consecutive working weekends + ConstrainMaximumConsecutiveWorkingWeekends *bool `json:"constrainMaximumConsecutiveWorkingWeekends,omitempty"` + + + // MaximumConsecutiveWorkingWeekends - The maximum number of consecutive weekends that agents who are assigned to this work plan are allowed to work + MaximumConsecutiveWorkingWeekends *int `json:"maximumConsecutiveWorkingWeekends,omitempty"` + + // MinimumWorkingDaysPerWeek - The minimum number of days that agents assigned to a work plan must work per week MinimumWorkingDaysPerWeek *int `json:"minimumWorkingDaysPerWeek,omitempty"` + // ConstrainMaximumConsecutiveWorkingDays - Whether to constrain the maximum consecutive working days + ConstrainMaximumConsecutiveWorkingDays *bool `json:"constrainMaximumConsecutiveWorkingDays,omitempty"` + + + // MaximumConsecutiveWorkingDays - The maximum number of consecutive days that agents assigned to this work plan are allowed to work. Used if constrainMaximumConsecutiveWorkingDays == true + MaximumConsecutiveWorkingDays *int `json:"maximumConsecutiveWorkingDays,omitempty"` + + + // MinimumShiftStartDistanceMinutes - The time period in minutes for the duration between the start times of two consecutive working days + MinimumShiftStartDistanceMinutes *int `json:"minimumShiftStartDistanceMinutes,omitempty"` + + + // MinimumDaysOffPerPlanningPeriod - Minimum days off in the planning period + MinimumDaysOffPerPlanningPeriod *int `json:"minimumDaysOffPerPlanningPeriod,omitempty"` + + + // MaximumDaysOffPerPlanningPeriod - Maximum days off in the planning period + MaximumDaysOffPerPlanningPeriod *int `json:"maximumDaysOffPerPlanningPeriod,omitempty"` + + + // MinimumPaidMinutesPerPlanningPeriod - Minimum paid minutes in the planning period + MinimumPaidMinutesPerPlanningPeriod *int `json:"minimumPaidMinutesPerPlanningPeriod,omitempty"` + + + // MaximumPaidMinutesPerPlanningPeriod - Maximum paid minutes in the planning period + MaximumPaidMinutesPerPlanningPeriod *int `json:"maximumPaidMinutesPerPlanningPeriod,omitempty"` + + // OptionalDays - Optional days to schedule for this work plan OptionalDays *Setwrapperdayofweek `json:"optionalDays,omitempty"` + // ShiftStartVarianceType - This constraint ensures that an agent starts each workday within a user-defined time threshold + ShiftStartVarianceType *string `json:"shiftStartVarianceType,omitempty"` + + // ShiftStartVariances - Variance in minutes among start times of shifts in this work plan ShiftStartVariances *Listwrappershiftstartvariance `json:"shiftStartVariances,omitempty"` diff --git a/platformclientv2/workplanactivity.go b/platformclientv2/workplanactivity.go index e104c4763..edc84aa06 100644 --- a/platformclientv2/workplanactivity.go +++ b/platformclientv2/workplanactivity.go @@ -49,6 +49,14 @@ type Workplanactivity struct { CountsAsContiguousWorkTime *bool `json:"countsAsContiguousWorkTime,omitempty"` + // MinimumLengthFromShiftStartMinutes - The minimum duration between shift start and shift item (e.g., break or meal) start in minutes + MinimumLengthFromShiftStartMinutes *int `json:"minimumLengthFromShiftStartMinutes,omitempty"` + + + // MinimumLengthFromShiftEndMinutes - The minimum duration between shift item (e.g., break or meal) end and shift end in minutes + MinimumLengthFromShiftEndMinutes *int `json:"minimumLengthFromShiftEndMinutes,omitempty"` + + // Id - ID of the activity. This is required only for the case of updating an existing activity Id *string `json:"id,omitempty"` diff --git a/platformclientv2/workplanlistitemresponse.go b/platformclientv2/workplanlistitemresponse.go index 2c3e7c4a4..1fbb58307 100644 --- a/platformclientv2/workplanlistitemresponse.go +++ b/platformclientv2/workplanlistitemresponse.go @@ -37,7 +37,7 @@ type Workplanlistitemresponse struct { WeeklyMaximumPaidMinutes *int `json:"weeklyMaximumPaidMinutes,omitempty"` - // ConstrainPaidTimeGranularity - Whether paid time granularity is constrained for this workplan + // ConstrainPaidTimeGranularity - Whether paid time granularity is constrained for this work plan ConstrainPaidTimeGranularity *bool `json:"constrainPaidTimeGranularity,omitempty"` @@ -57,14 +57,58 @@ type Workplanlistitemresponse struct { MaximumDays *int `json:"maximumDays,omitempty"` + // MinimumConsecutiveNonWorkingMinutesPerWeek - Minimum amount of consecutive non working minutes per week that agents who are assigned this work plan are allowed to have off + MinimumConsecutiveNonWorkingMinutesPerWeek *int `json:"minimumConsecutiveNonWorkingMinutesPerWeek,omitempty"` + + + // ConstrainMaximumConsecutiveWorkingWeekends - Whether to constrain the maximum consecutive working weekends + ConstrainMaximumConsecutiveWorkingWeekends *bool `json:"constrainMaximumConsecutiveWorkingWeekends,omitempty"` + + + // MaximumConsecutiveWorkingWeekends - The maximum number of consecutive weekends that agents who are assigned to this work plan are allowed to work + MaximumConsecutiveWorkingWeekends *int `json:"maximumConsecutiveWorkingWeekends,omitempty"` + + // MinimumWorkingDaysPerWeek - The minimum number of days that agents assigned to a work plan must work per week MinimumWorkingDaysPerWeek *int `json:"minimumWorkingDaysPerWeek,omitempty"` + // ConstrainMaximumConsecutiveWorkingDays - Whether to constrain the maximum consecutive working days + ConstrainMaximumConsecutiveWorkingDays *bool `json:"constrainMaximumConsecutiveWorkingDays,omitempty"` + + + // MaximumConsecutiveWorkingDays - The maximum number of consecutive days that agents assigned to this work plan are allowed to work. Used if constrainMaximumConsecutiveWorkingDays == true + MaximumConsecutiveWorkingDays *int `json:"maximumConsecutiveWorkingDays,omitempty"` + + + // MinimumShiftStartDistanceMinutes - The time period in minutes for the duration between the start times of two consecutive working days + MinimumShiftStartDistanceMinutes *int `json:"minimumShiftStartDistanceMinutes,omitempty"` + + + // MinimumDaysOffPerPlanningPeriod - Minimum days off in the planning period + MinimumDaysOffPerPlanningPeriod *int `json:"minimumDaysOffPerPlanningPeriod,omitempty"` + + + // MaximumDaysOffPerPlanningPeriod - Maximum days off in the planning period + MaximumDaysOffPerPlanningPeriod *int `json:"maximumDaysOffPerPlanningPeriod,omitempty"` + + + // MinimumPaidMinutesPerPlanningPeriod - Minimum paid minutes in the planning period + MinimumPaidMinutesPerPlanningPeriod *int `json:"minimumPaidMinutesPerPlanningPeriod,omitempty"` + + + // MaximumPaidMinutesPerPlanningPeriod - Maximum paid minutes in the planning period + MaximumPaidMinutesPerPlanningPeriod *int `json:"maximumPaidMinutesPerPlanningPeriod,omitempty"` + + // OptionalDays - Optional days to schedule for this work plan. Populate with expand=details OptionalDays *Setwrapperdayofweek `json:"optionalDays,omitempty"` + // ShiftStartVarianceType - This constraint ensures that an agent starts each workday within a user-defined time threshold + ShiftStartVarianceType *string `json:"shiftStartVarianceType,omitempty"` + + // ShiftStartVariances - Variance in minutes among start times of shifts in this work plan. Populate with expand=details ShiftStartVariances *Listwrappershiftstartvariance `json:"shiftStartVariances,omitempty"` diff --git a/platformclientv2/workplanshift.go b/platformclientv2/workplanshift.go index e8b90a397..382591afa 100644 --- a/platformclientv2/workplanshift.go +++ b/platformclientv2/workplanshift.go @@ -41,6 +41,14 @@ type Workplanshift struct { LatestStopTimeMinutesFromMidnight *int `json:"latestStopTimeMinutesFromMidnight,omitempty"` + // ConstrainEarliestStopTime - Whether the earliest stop time constraint for the shift is enabled + ConstrainEarliestStopTime *bool `json:"constrainEarliestStopTime,omitempty"` + + + // EarliestStopTimeMinutesFromMidnight - This is the earliest time a shift can end + EarliestStopTimeMinutesFromMidnight *int `json:"earliestStopTimeMinutesFromMidnight,omitempty"` + + // StartIncrementMinutes - Increment in offset minutes that would contribute to different possible start times for the shift. Used if flexibleStartTime == true StartIncrementMinutes *int `json:"startIncrementMinutes,omitempty"` diff --git a/platformclientv2/workplanvalidationrequest.go b/platformclientv2/workplanvalidationrequest.go index b75a2597a..1af400a85 100644 --- a/platformclientv2/workplanvalidationrequest.go +++ b/platformclientv2/workplanvalidationrequest.go @@ -37,7 +37,7 @@ type Workplanvalidationrequest struct { WeeklyMaximumPaidMinutes *int `json:"weeklyMaximumPaidMinutes,omitempty"` - // ConstrainPaidTimeGranularity - Whether paid time granularity is constrained for this workplan + // ConstrainPaidTimeGranularity - Whether paid time granularity is constrained for this work plan ConstrainPaidTimeGranularity *bool `json:"constrainPaidTimeGranularity,omitempty"` @@ -57,14 +57,58 @@ type Workplanvalidationrequest struct { MaximumDays *int `json:"maximumDays,omitempty"` + // MinimumConsecutiveNonWorkingMinutesPerWeek - Minimum amount of consecutive non working minutes per week that agents who are assigned this work plan are allowed to have off + MinimumConsecutiveNonWorkingMinutesPerWeek *int `json:"minimumConsecutiveNonWorkingMinutesPerWeek,omitempty"` + + + // ConstrainMaximumConsecutiveWorkingWeekends - Whether to constrain the maximum consecutive working weekends + ConstrainMaximumConsecutiveWorkingWeekends *bool `json:"constrainMaximumConsecutiveWorkingWeekends,omitempty"` + + + // MaximumConsecutiveWorkingWeekends - The maximum number of consecutive weekends that agents who are assigned to this work plan are allowed to work + MaximumConsecutiveWorkingWeekends *int `json:"maximumConsecutiveWorkingWeekends,omitempty"` + + // MinimumWorkingDaysPerWeek - The minimum number of days that agents assigned to a work plan must work per week MinimumWorkingDaysPerWeek *int `json:"minimumWorkingDaysPerWeek,omitempty"` + // ConstrainMaximumConsecutiveWorkingDays - Whether to constrain the maximum consecutive working days + ConstrainMaximumConsecutiveWorkingDays *bool `json:"constrainMaximumConsecutiveWorkingDays,omitempty"` + + + // MaximumConsecutiveWorkingDays - The maximum number of consecutive days that agents assigned to this work plan are allowed to work. Used if constrainMaximumConsecutiveWorkingDays == true + MaximumConsecutiveWorkingDays *int `json:"maximumConsecutiveWorkingDays,omitempty"` + + + // MinimumShiftStartDistanceMinutes - The time period in minutes for the duration between the start times of two consecutive working days + MinimumShiftStartDistanceMinutes *int `json:"minimumShiftStartDistanceMinutes,omitempty"` + + + // MinimumDaysOffPerPlanningPeriod - Minimum days off in the planning period + MinimumDaysOffPerPlanningPeriod *int `json:"minimumDaysOffPerPlanningPeriod,omitempty"` + + + // MaximumDaysOffPerPlanningPeriod - Maximum days off in the planning period + MaximumDaysOffPerPlanningPeriod *int `json:"maximumDaysOffPerPlanningPeriod,omitempty"` + + + // MinimumPaidMinutesPerPlanningPeriod - Minimum paid minutes in the planning period + MinimumPaidMinutesPerPlanningPeriod *int `json:"minimumPaidMinutesPerPlanningPeriod,omitempty"` + + + // MaximumPaidMinutesPerPlanningPeriod - Maximum paid minutes in the planning period + MaximumPaidMinutesPerPlanningPeriod *int `json:"maximumPaidMinutesPerPlanningPeriod,omitempty"` + + // OptionalDays - Optional days to schedule for this work plan OptionalDays *Setwrapperdayofweek `json:"optionalDays,omitempty"` + // ShiftStartVarianceType - This constraint ensures that an agent starts each workday within a user-defined time threshold + ShiftStartVarianceType *string `json:"shiftStartVarianceType,omitempty"` + + // ShiftStartVariances - Variance in minutes among start times of shifts in this work plan ShiftStartVariances *Listwrappershiftstartvariance `json:"shiftStartVariances,omitempty"` diff --git a/releaseNotes.md b/releaseNotes.md index 2050a2b47..c2d3c7fcc 100644 --- a/releaseNotes.md +++ b/releaseNotes.md @@ -1,10 +1,398 @@ -Platform API version: 4480 +Platform API version: 4513 -# Major Changes (0 changes) +# Major Changes (8 changes) +**GET /api/v2/flows/datatables** (1 change) -# Minor Changes (0 changes) +* Parameter divisionId was added +**POST /api/v2/routing/queues/{queueId}/users** (1 change) -# Point Changes (0 changes) +* Response 200 was removed + +**POST /api/v2/conversations/messaging/integrations/facebook** (1 change) + +* Parameter async was removed + +**POST /api/v2/conversations/messaging/integrations/twitter** (1 change) + +* Parameter async was removed + +**POST /api/v2/conversations/messaging/integrations/whatsapp** (1 change) + +* Parameter async was removed + +**POST /api/v2/routing/queues/{queueId}/members** (1 change) + +* Response 200 was removed + +**POST /api/v2/conversations/messaging/integrations/line** (1 change) + +* Parameter async was removed + +**SupportedContent** (1 change) + +* Model SupportedContent was removed + + +# Minor Changes (142 changes) + +**/api/v2/speechandtextanalytics/topics/general** (2 changes) + +* Path was added +* Operation GET was added + +**/api/v2/speechandtextanalytics/topics/publishjobs/{jobId}** (2 changes) + +* Path was added +* Operation GET was added + +**/api/v2/speechandtextanalytics/programs/publishjobs/{jobId}** (2 changes) + +* Path was added +* Operation GET was added + +**/api/v2/speechandtextanalytics/topics** (3 changes) + +* Path was added +* Operation GET was added +* Operation POST was added + +**/api/v2/speechandtextanalytics/programs/general/jobs** (2 changes) + +* Path was added +* Operation POST was added + +**POST /api/v2/routing/queues/{queueId}/users** (1 change) + +* Response default was added + +**/api/v2/speechandtextanalytics/programs/general/jobs/{jobId}** (2 changes) + +* Path was added +* Operation GET was added + +**POST /api/v2/routing/queues/{queueId}/members** (1 change) + +* Response default was added + +**/api/v2/speechandtextanalytics/programs** (3 changes) + +* Path was added +* Operation GET was added +* Operation POST was added + +**/api/v2/speechandtextanalytics/dialects** (2 changes) + +* Path was added +* Operation GET was added + +**/api/v2/speechandtextanalytics/programs/{programId}** (4 changes) + +* Path was added +* Operation GET was added +* Operation PUT was added +* Operation DELETE was added + +**/api/v2/speechandtextanalytics/topics/publishjobs** (2 changes) + +* Path was added +* Operation POST was added + +**/api/v2/speechandtextanalytics/topics/{topicId}** (4 changes) + +* Path was added +* Operation GET was added +* Operation PUT was added +* Operation DELETE was added + +**/api/v2/speechandtextanalytics/programs/publishjobs** (2 changes) + +* Path was added +* Operation POST was added + +**/api/v2/speechandtextanalytics/programs/unpublished** (2 changes) + +* Path was added +* Operation GET was added + +**SupportedContentReference** (1 change) + +* Model was added + +**GeneralTopic** (1 change) + +* Model was added + +**GeneralTopicsEntityListing** (1 change) + +* Model was added + +**DataTable** (1 change) + +* Optional property division was added + +**WorkPlanActivity** (2 changes) + +* Optional property minimumLengthFromShiftStartMinutes was added +* Optional property minimumLengthFromShiftEndMinutes was added + +**WorkPlanShift** (2 changes) + +* Optional property constrainEarliestStopTime was added +* Optional property earliestStopTimeMinutesFromMidnight was added + +**WorkPlanValidationRequest** (11 changes) + +* Optional property minimumConsecutiveNonWorkingMinutesPerWeek was added +* Optional property constrainMaximumConsecutiveWorkingWeekends was added +* Optional property maximumConsecutiveWorkingWeekends was added +* Optional property constrainMaximumConsecutiveWorkingDays was added +* Optional property maximumConsecutiveWorkingDays was added +* Optional property minimumShiftStartDistanceMinutes was added +* Optional property minimumDaysOffPerPlanningPeriod was added +* Optional property maximumDaysOffPerPlanningPeriod was added +* Optional property minimumPaidMinutesPerPlanningPeriod was added +* Optional property maximumPaidMinutesPerPlanningPeriod was added +* Optional property shiftStartVarianceType was added + +**WorkPlan** (11 changes) + +* Optional property minimumConsecutiveNonWorkingMinutesPerWeek was added +* Optional property constrainMaximumConsecutiveWorkingWeekends was added +* Optional property maximumConsecutiveWorkingWeekends was added +* Optional property constrainMaximumConsecutiveWorkingDays was added +* Optional property maximumConsecutiveWorkingDays was added +* Optional property minimumShiftStartDistanceMinutes was added +* Optional property minimumDaysOffPerPlanningPeriod was added +* Optional property maximumDaysOffPerPlanningPeriod was added +* Optional property minimumPaidMinutesPerPlanningPeriod was added +* Optional property maximumPaidMinutesPerPlanningPeriod was added +* Optional property shiftStartVarianceType was added + +**CreateWorkPlan** (11 changes) + +* Optional property minimumConsecutiveNonWorkingMinutesPerWeek was added +* Optional property constrainMaximumConsecutiveWorkingWeekends was added +* Optional property maximumConsecutiveWorkingWeekends was added +* Optional property constrainMaximumConsecutiveWorkingDays was added +* Optional property maximumConsecutiveWorkingDays was added +* Optional property minimumShiftStartDistanceMinutes was added +* Optional property minimumDaysOffPerPlanningPeriod was added +* Optional property maximumDaysOffPerPlanningPeriod was added +* Optional property minimumPaidMinutesPerPlanningPeriod was added +* Optional property maximumPaidMinutesPerPlanningPeriod was added +* Optional property shiftStartVarianceType was added + +**CreateWorkPlanActivity** (2 changes) + +* Optional property minimumLengthFromShiftStartMinutes was added +* Optional property minimumLengthFromShiftEndMinutes was added + +**CreateWorkPlanShift** (2 changes) + +* Optional property constrainEarliestStopTime was added +* Optional property earliestStopTimeMinutesFromMidnight was added + +**WorkPlanListItemResponse** (11 changes) + +* Optional property minimumConsecutiveNonWorkingMinutesPerWeek was added +* Optional property constrainMaximumConsecutiveWorkingWeekends was added +* Optional property maximumConsecutiveWorkingWeekends was added +* Optional property constrainMaximumConsecutiveWorkingDays was added +* Optional property maximumConsecutiveWorkingDays was added +* Optional property minimumShiftStartDistanceMinutes was added +* Optional property minimumDaysOffPerPlanningPeriod was added +* Optional property maximumDaysOffPerPlanningPeriod was added +* Optional property minimumPaidMinutesPerPlanningPeriod was added +* Optional property maximumPaidMinutesPerPlanningPeriod was added +* Optional property shiftStartVarianceType was added + +**ManagementUnit** (1 change) + +* Optional property businessUnit was added + +**SchedulingSettingsResponse** (2 changes) + +* Optional property planningPeriod was added +* Optional property startDayOfWeekend was added + +**BaseTopicEntitiy** (1 change) + +* Model was added + +**TopicJob** (1 change) + +* Model was added + +**ExternalContact** (1 change) + +* id is no longer readonly + +**RoutingData** (1 change) + +* Optional property scoredAgents was added + +**SchedulingSettingsRequest** (2 changes) + +* Optional property planningPeriod was added +* Optional property startDayOfWeekend was added + +**AuditQueryExecutionStatusResponse** (1 change) + +* Enum value Routing was added to property serviceName + +**AuditQueryRequest** (1 change) + +* Enum value Routing was added to property serviceName + +**AuditLogMessage** (7 changes) + +* Enum value Routing was added to property serviceName +* Enum value CampaignSchedule was added to property entityType +* Enum value SequenceSchedule was added to property entityType +* Enum value OrganizationProperties was added to property entityType +* Enum value WrapUpCodeMapping was added to property entityType +* Enum value MessagingCampaign was added to property entityType +* Enum value Predictor was added to property entityType + +**AuditRealtimeQueryRequest** (1 change) + +* Enum value Routing was added to property serviceName + +**AuditQueryEntity** (6 changes) + +* Enum value CampaignSchedule was added to property name +* Enum value SequenceSchedule was added to property name +* Enum value OrganizationProperties was added to property name +* Enum value WrapUpCodeMapping was added to property name +* Enum value MessagingCampaign was added to property name +* Enum value Predictor was added to property name + +**AuditQueryService** (1 change) + +* Enum value Routing was added to property name + +**BaseProgramEntity** (1 change) + +* Model was added + +**ProgramJob** (1 change) + +* Model was added + +**ListedTopic** (1 change) + +* Model was added + +**TopicsEntityListing** (1 change) + +* Model was added + +**Phrase** (1 change) + +* Model was added + +**Topic** (1 change) + +* Model was added + +**TopicRequest** (1 change) + +* Model was added + +**ExternalSegment** (1 change) + +* Model was added + +**JourneySegment** (1 change) + +* Optional property externalSegment was added + +**PatchExternalSegment** (1 change) + +* Model was added + +**PatchSegment** (1 change) + +* Optional property externalSegment was added + +**AvailableTopic** (1 change) + +* Optional property permissionDetails was added + +**PermissionDetails** (1 change) + +* Model was added + +**GeneralProgramJob** (1 change) + +* Model was added + +**GeneralProgramJobRequest** (1 change) + +* Model was added + +**ListedProgram** (1 change) + +* Model was added + +**ProgramsEntityListing** (1 change) + +* Model was added + +**Program** (1 change) + +* Model was added + +**ProgramRequest** (1 change) + +* Model was added + +**TranscriptAggregateQueryPredicate** (2 changes) + +* Enum value flowVersion was added to property dimension +* Enum value topicId was added to property dimension + +**TranscriptAggregationQuery** (2 changes) + +* Enum value flowVersion was added to property groupBy +* Enum value topicId was added to property groupBy + +**TopicJobRequest** (1 change) + +* Model was added + +**ProgramJobRequest** (1 change) + +* Model was added + +**UnpublishedProgramsEntityListing** (1 change) + +* Model was added + + +# Point Changes (7 changes) + +**GET /api/v2/workforcemanagement/managementunits** (3 changes) + +* Description was changed for parameter pageSize +* Description was changed for parameter pageNumber +* Description was changed for parameter expand + +**GET /api/v2/workforcemanagement/managementunits/{managementUnitId}** (1 change) + +* Description was changed + +**POST /api/v2/authorization/divisions/{divisionId}/objects/{objectType}** (1 change) + +* Description was changed + +**GET /api/v2/users/development/activities** (1 change) + +* Description was changed for parameter relationship + +**GET /api/v2/users/development/activities/me** (1 change) + +* Description was changed for parameter relationship diff --git a/swagger.json b/swagger.json index 79fa7901a..8c75c221b 100644 --- a/swagger.json +++ b/swagger.json @@ -1 +1 @@ -{"swagger":"2.0","info":{"description":"With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.","version":"v2","title":"PureCloud Platform API","termsOfService":"https://help.mypurecloud.com/articles/terms-and-conditions/","contact":{"name":"PureCloud Developer Evangelists","url":"https://developer.mypurecloud.com","email":"DeveloperEvangelists@genesys.com"},"license":{"name":"UNLICENSED","url":"https://help.mypurecloud.com/articles/terms-and-conditions/"}},"host":"api.mypurecloud.com","tags":[{"name":"Alerting","description":"Rules and alerts","externalDocs":{"description":"Alerting Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/alerting/"}},{"name":"Analytics","description":"Analytics querying and reporting.","externalDocs":{"description":"Analytics Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/analytics/"}},{"name":"Architect","description":"Flows, Prompts, IVR schedules, Dependency Tracking","externalDocs":{"description":"Architect Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/architect/"}},{"name":"Audit","description":"","externalDocs":{"description":"Audit Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/audits/"}},{"name":"Authorization","description":"Roles and permissions","externalDocs":{"description":"Authorization Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/authorization/"}},{"name":"Billing","description":"","externalDocs":{"description":"billing Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/billing/"}},{"name":"Callbacks","description":""},{"name":"Calls","description":""},{"name":"Chat","description":""},{"name":"Coaching","description":"Schedule and manage coaching appointments","externalDocs":{"description":"Coaching","url":"https://developer.mypurecloud.com/api/rest/v2/coaching/index.html"}},{"name":"Configuration","description":"","externalDocs":{"description":"Configuration Documentation","url":""}},{"name":"Content Management","description":"","externalDocs":{"description":"Content Management Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/contentmanagement/"}},{"name":"Conversations","description":"","externalDocs":{"description":"Conversations Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/conversations/"}},{"name":"Data Extensions","description":"Data extensions","externalDocs":{"description":"Data Extensions","url":""}},{"name":"Directory Proxy","description":"Search, Suggest, and people"},{"name":"Emails","description":""},{"name":"External Contacts","description":"External Organizations, contacts, notes and relationships","externalDocs":{"description":"External Contacts","url":"https://developer.mypurecloud.com/api/rest/v2/externalcontacts/"}},{"name":"Fax","description":"","externalDocs":{"description":"Fax Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/fax/"}},{"name":"Flows","description":"IVR Flows","externalDocs":{"description":"Flow Aggregates Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/analytics/flow_aggregate.html"}},{"name":"General Data Protection Regulation","description":"Working with General Data Protection Regulation (GDPR) requests","externalDocs":{"description":"GDPR Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/generaldataprotectionregulation/"}},{"name":"Geolocation","description":"","externalDocs":{"description":"Geolocation Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/geolocation/"}},{"name":"Greetings","description":"","externalDocs":{"description":"Greetings Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/greetings/"}},{"name":"Groups","description":"Groups, members","externalDocs":{"description":"Groups Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/groups/"}},{"name":"Identity Provider","description":"Identity providers","externalDocs":{"description":"Identity Providers Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/identityprovider/"}},{"name":"Integrations","description":"","externalDocs":{"description":"Integrations Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/integrations/"}},{"name":"Journey","description":"Predictive Engagement, Customer Journey","externalDocs":{"description":"Journey documentation","url":""}},{"name":"Languages","description":"Available languages","externalDocs":{"description":"Languages Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/languages/"}},{"name":"Knowledge","description":"Knowledge administration and search"},{"name":"Language Understanding","description":"Language Understanding","externalDocs":{"description":"Language Understanding documentation","url":""}},{"name":"Licensing","description":""},{"name":"License","description":"Per-user platform license assignments","externalDocs":{"description":"License Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/license/"}},{"name":"Locations","description":"Physical locations","externalDocs":{"description":"Locations Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/locations/"}},{"name":"Mobile Devices","description":"Devices","externalDocs":{"description":"Devices Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/mobiledevices/"}},{"name":"Notifications","description":"Channels, subscriptions, topics, mobile push registration","externalDocs":{"description":"Notifications Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/notifications/"}},{"name":"OAuth","description":"OAuth clients, providers","externalDocs":{"description":"OAuth Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/oauth/"}},{"name":"Objects","description":"Access-controlled objects in the platform","externalDocs":{"description":"authorization docs","url":"https://developer.mypurecloud.com/api/rest/v2/authorization/"}},{"name":"Organization","description":"Organization","externalDocs":{"description":"Organization Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/organization/"}},{"name":"Organization Authorization","description":"Organization Authorization","externalDocs":{"description":"Organization Authorization Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/organizationauthorization/"}},{"name":"Outbound","description":"","externalDocs":{"description":"Outbound Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/outbound/"}},{"name":"Presence","description":"User and organization presences","externalDocs":{"description":"Presence Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/presence/"}},{"name":"Quality","description":"Evaluations, calibrations","externalDocs":{"description":"Quality Management Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/quality/"}},{"name":"Recording","description":"Recordings, policies, annotations, orphans","externalDocs":{"description":"Recording Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/recording/"}},{"name":"Response Management","description":"Responses, library, query","externalDocs":{"description":"Response Management Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/responsemanagement/"}},{"name":"Routing","description":"Queues, wrapup codes, skills, email & sms config, predictive routing","externalDocs":{"description":"Routing Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/routing/"}},{"name":"SCIM","description":"System for Cross-domain Identity Management","externalDocs":{"description":"System for Cross-domain Identity Management: Definitions, Overview, Concepts, and Requirements","url":"https://developer.mypurecloud.com/api/rest/v2/scim/scim-overview.html"}},{"name":"Scripts","description":"Agent-facing scripts for interactions","externalDocs":{"description":"Scripts Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/scripts/"}},{"name":"Search","description":"Search aggregate, users, groups","externalDocs":{"description":"Search Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/search/"}},{"name":"Speech & Text Analytics","description":""},{"name":"Stations","description":"Stations","externalDocs":{"description":"Stations Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/stations/"}},{"name":"Suggest","description":"Search suggest user, group, locations"},{"name":"Telephony","description":"Telephony providers and configuration","externalDocs":{"description":"Telephony Documentation","url":""}},{"name":"Telephony Providers Edge","description":"Edge phones, trunks, lines.","externalDocs":{"description":"telephony provider edge","url":"https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/"}},{"name":"Textbots","description":"Chatbot Interactions"},{"name":"Tokens","description":"Authentication Tokens","externalDocs":{"description":"Tokens Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/tokens/"}},{"name":"Uploads","description":"Presigned url generator for uploading files","externalDocs":{"description":"Upload Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/uploads/"}},{"name":"User Recordings","description":"Summary, media","externalDocs":{"description":"User Recordings Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/userrecordings/"}},{"name":"Users","description":"Me, routing, roles","externalDocs":{"description":"Users Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/users/"}},{"name":"Utilities","description":"","externalDocs":{"description":"Utilities Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/utilities/"}},{"name":"Videos","description":""},{"name":"Voicemail","description":"Mailbox, messages, policy","externalDocs":{"description":"Voicemail Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/voicemail/"}},{"name":"WebChat","description":"WebChat deployments","externalDocs":{"description":"WebChat Deployment Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/webchat/"}},{"name":"Widgets","description":"Widget deployments","externalDocs":{"description":"Widget Deployment Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/widgets/"}},{"name":"Usage","description":"View organizational level usage data"},{"name":"Workforce Management","description":"Adherence, Schedules, Forecasts, Intraday Monitoring, Time Off Requests, Configuration","externalDocs":{"description":"Workforce Management Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/workforcemanagement/"}}],"schemes":["https"],"consumes":["application/json"],"produces":["application/json"],"paths":{"/api/v2/gdpr/requests":{"get":{"tags":["General Data Protection Regulation"],"summary":"Get all GDPR requests","description":"","operationId":"getGdprRequests","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GDPRRequestEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gdpr","gdpr:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gdpr:request:view"]},"x-purecloud-method-name":"getGdprRequests"},"post":{"tags":["General Data Protection Regulation"],"summary":"Submit a new GDPR request","description":"","operationId":"postGdprRequests","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"GDPR request","required":true,"schema":{"$ref":"#/definitions/GDPRRequest"}},{"name":"deleteConfirmed","in":"query","description":"Confirm delete","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GDPRRequest"}},"202":{"description":"Accepted","schema":{"$ref":"#/definitions/GDPRRequest"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gdpr"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gdpr:request:add"]},"x-purecloud-method-name":"postGdprRequests"}},"/api/v2/orgauthorization/trustors/{trustorOrgId}/users":{"get":{"tags":["Organization Authorization"],"summary":"The list of users in the trustor organization (i.e. users granted access).","description":"","operationId":"getOrgauthorizationTrustorUsers","produces":["application/json"],"parameters":[{"name":"trustorOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustUserEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.trustor.permissions":"Missing required permission(s)","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:view"]},"x-purecloud-method-name":"getOrgauthorizationTrustorUsers"}},"/api/v2/contentmanagement/documents/{documentId}":{"get":{"tags":["Content Management"],"summary":"Get a document.","description":"","operationId":"getContentmanagementDocument","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["lockInfo","acl","workspace"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"lockInfo"},{"name":"acl"},{"name":"workspace"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Document"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"forbidden":"Forbidden from getting document","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementDocument"},"post":{"tags":["Content Management"],"summary":"Update a document.","description":"","operationId":"postContentmanagementDocument","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Document","required":true,"schema":{"$ref":"#/definitions/DocumentUpdate"}},{"name":"expand","in":"query","description":"Expand some document fields","required":false,"type":"string","enum":["acl"],"x-genesys-enum-members":[{"name":"acl"}]},{"name":"override","in":"query","description":"Override any lock on the document","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Document"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Resource conflict - Unexpected changeNumber was provided"},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"423":{"description":"Locked - The document is locked by another operation"},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"postContentmanagementDocument"},"delete":{"tags":["Content Management"],"summary":"Delete a document.","description":"","operationId":"deleteContentmanagementDocument","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"name":"override","in":"query","description":"Override any lock on the document","required":false,"type":"boolean"}],"responses":{"202":{"description":"Accepted - Processing Delete"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"423":{"description":"Locked - The document is locked by another operation"},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"deleteContentmanagementDocument"}},"/api/v2/license/definitions":{"get":{"tags":["License"],"summary":"Get all PureCloud license definitions available for the organization.","description":"","operationId":"getLicenseDefinitions","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/LicenseDefinition"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["license","license:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:add"]},"x-purecloud-method-name":"getLicenseDefinitions"}},"/api/v2/recording/localkeys":{"post":{"tags":["Recording"],"summary":"create a local recording key","description":"","operationId":"postRecordingLocalkeys","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Local Encryption body","required":true,"schema":{"$ref":"#/definitions/LocalEncryptionKeyRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EncryptionKey"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:encryptionKey:edit"]},"x-purecloud-method-name":"postRecordingLocalkeys"}},"/api/v2/speechandtextanalytics/conversations/{conversationId}":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get Speech and Text Analytics for a specific conversation","description":"","operationId":"getSpeechandtextanalyticsConversation","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConversationMetrics"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden from retrieving Speech and Text Analytics."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"Speech and Text Analytics Not found"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:recording:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsConversation"}},"/api/v2/outbound/wrapupcodemappings":{"get":{"tags":["Outbound"],"summary":"Get the Dialer wrap up code mapping.","description":"","operationId":"getOutboundWrapupcodemappings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapUpCodeMapping"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:wrapUpCodeMapping:view"]},"x-purecloud-method-name":"getOutboundWrapupcodemappings"},"put":{"tags":["Outbound"],"summary":"Update the Dialer wrap up code mapping.","description":"","operationId":"putOutboundWrapupcodemappings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"wrapUpCodeMapping","required":true,"schema":{"$ref":"#/definitions/WrapUpCodeMapping"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapUpCodeMapping"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update":"An attempt was made to update a wrap up code mapping in an invalid way","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.wrong.version":"Wrap up code mapping version does not match expected"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:wrapUpCodeMapping:edit"]},"x-purecloud-method-name":"putOutboundWrapupcodemappings"}},"/api/v2/voicemail/userpolicies/{userId}":{"get":{"tags":["Voicemail"],"summary":"Get a user's voicemail policy","description":"","operationId":"getVoicemailUserpolicy","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailUserPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"voicemailservice.user.usernotfound":"The specified voicemail user not found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-purecloud-method-name":"getVoicemailUserpolicy"},"patch":{"tags":["Voicemail"],"summary":"Update a user's voicemail policy","description":"","operationId":"patchVoicemailUserpolicy","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The user's voicemail policy","required":true,"schema":{"$ref":"#/definitions/VoicemailUserPolicy"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailUserPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail"]}],"x-purecloud-method-name":"patchVoicemailUserpolicy"}},"/api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId}":{"get":{"tags":["Quality"],"summary":"Get an evaluation","description":"","operationId":"getQualityConversationEvaluation","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"evaluationId","in":"path","description":"evaluationId","required":true,"type":"string"},{"name":"expand","in":"query","description":"agent, evaluator, evaluationForm","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Evaluation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","quality.evaluation.view.permission.check.failed":"Failed to check required view permission.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluation:view"]},"x-purecloud-method-name":"getQualityConversationEvaluation"},"put":{"tags":["Quality"],"summary":"Update an evaluation","description":"The quality:evaluation:edit permission allows modification of most fields, while the quality:evaluation:editScore permission allows an evaluator to change just the question scores, and the quality:evaluation:editAgentSignoff permission allows an agent to change the agent comments and sign off on the evaluation.","operationId":"putQualityConversationEvaluation","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"evaluationId","in":"path","description":"evaluationId","required":true,"type":"string"},{"in":"body","name":"body","description":"evaluation","required":true,"schema":{"$ref":"#/definitions/Evaluation"}},{"name":"expand","in":"query","description":"evaluatorId","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Evaluation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.evaluation.evaluator.doesnt.exist":"Evaluator doesn't exist","quality.scoring.unanswered.required.questions":"Submitted answers did not contain a response to a required question","quality.evaluation.cannot.change.evaluation.form":"Cannot change evaluation form","quality.evaluation.cannot.change.conversation":"Cannot change conversation","bad.request":"The request could not be understood by the server due to malformed syntax.","quality.scoring.question.not.in.evaluation.form":"Submitted answers contained reference to a question which is not in the evaluation form","quality.evaluation.cannot.change.evaluationid":"Cannot change evaluationId","quality.scoring.unanswered.required.comments":"Submitted answers did not contain a comment where it was required","qm.evaluation.create.error.no.agent":"Need an agent user on the conversation to create an evaluation","quality.evaluation.calibration.and.release.date.both.set":"Calibration and release date both set","quality.evaluation.invalid.state.non.pending.to.pending":"Invalid state, non pending to pending","quality.evaluation.cannot.change.calibration":"Cannot change calibration","quality.evaluation.agent.doesnt.exist":"Agent doesn't exist","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","quality.evaluation.required.answers.for.state":"Answers are required for state","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","quality.scoring.answer.not.in.evaluation.form":"Submitted answers contained reference to an answer which is not in the evaluation form","quality.evaluation.evaluator.not.quality.evaluator":"evaluator does not have edit score permission","quality.scoring.question.group.not.in.evaluation.form":"Submitted answers contained reference to a question group which is not in the evaluation form","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","quality.evaluation.too.old.to.score":"Evaluation is too old to score"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.evaluation.update.permission.check.failed":"Missing evaluation update permission","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.evaluation.no.answer.for.state":"No answers for state","quality.evaluation.form.doesnt.exist":"Evaluation form doesn't exist","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluation:edit","quality:evaluation:editScore","quality:evaluation:editAgentSignoff"]},"x-purecloud-method-name":"putQualityConversationEvaluation"},"delete":{"tags":["Quality"],"summary":"Delete an evaluation","description":"","operationId":"deleteQualityConversationEvaluation","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"evaluationId","in":"path","description":"evaluationId","required":true,"type":"string"},{"name":"expand","in":"query","description":"evaluatorId","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Evaluation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","quality.evaluation.delete.permission.check.failed":"Failed evaluation deletion permission check"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.evaluation.form.doesnt.exist":"Evaluation form doesn't exist","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluation:delete"]},"x-purecloud-method-name":"deleteQualityConversationEvaluation"}},"/api/v2/orphanrecordings/{orphanId}":{"get":{"tags":["Recording"],"summary":"Gets a single orphan recording","description":"","operationId":"getOrphanrecording","produces":["application/json"],"parameters":[{"name":"orphanId","in":"path","description":"Orphan ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrphanRecording"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:orphan:view"]},"x-purecloud-method-name":"getOrphanrecording"},"put":{"tags":["Recording"],"summary":"Updates an orphan recording to a regular recording with retention values","description":"If this operation is successful the orphan will no longer exist. It will be replaced by the resulting recording in the response. This replacement recording is accessible by the normal Recording api.","operationId":"putOrphanrecording","produces":["application/json"],"parameters":[{"name":"orphanId","in":"path","description":"Orphan ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/OrphanUpdateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Recording"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.orphan.retention.data.invalid":"The provided dates in the payload were invalid.","recording.orphan.unknown.conversation":"The provided conversation in the payload doesn't exist.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","recording.orphan.edit.permission.check.failed":"Requesting user lacks permission to perform this api operation."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:orphan:edit"]},"x-purecloud-method-name":"putOrphanrecording"},"delete":{"tags":["Recording"],"summary":"Deletes a single orphan recording","description":"","operationId":"deleteOrphanrecording","produces":["application/json"],"parameters":[{"name":"orphanId","in":"path","description":"Orphan ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrphanRecording"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:orphan:delete"]},"x-purecloud-method-name":"deleteOrphanrecording"}},"/api/v2/outbound/campaigns":{"get":{"tags":["Outbound"],"summary":"Query a list of dialer campaigns.","description":"","operationId":"getOutboundCampaigns","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"],"x-genesys-enum-members":[{"name":"Equals"},{"name":"RegEx"},{"name":"Contains"},{"name":"Prefix"},{"name":"LessThan"},{"name":"LessThanEqualTo"},{"name":"GreaterThan"},{"name":"GreaterThanEqualTo"},{"name":"BeginsWith"},{"name":"EndsWith"}]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"contactListId","in":"query","description":"Contact List ID","required":false,"type":"string"},{"name":"dncListIds","in":"query","description":"DNC list ID","required":false,"type":"string"},{"name":"distributionQueueId","in":"query","description":"Distribution queue ID","required":false,"type":"string"},{"name":"edgeGroupId","in":"query","description":"Edge group ID","required":false,"type":"string"},{"name":"callAnalysisResponseSetId","in":"query","description":"Call analysis response set ID","required":false,"type":"string"},{"name":"divisionId","in":"query","description":"Division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.bulk.retrieves":"Only 100 campaigns can be retrieved by id at a time","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:view"]},"x-purecloud-method-name":"getOutboundCampaigns"},"post":{"tags":["Outbound"],"summary":"Create a campaign.","description":"","operationId":"postOutboundCampaigns","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Campaign","required":true,"schema":{"$ref":"#/definitions/Campaign"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Campaign"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","invalid.campaign.outbound.line.count":"","invalid.priority":"The priority must be between 1 and 5 (inclusive)","name.length.exceeded":"The name length exceeds the limit of 64 characters.","too.many.queue.members":"The limit for number of queue members on a campaign configured for agent owned records has been exceeded. See details.","bad.request":"The request could not be understood by the server due to malformed syntax.","callable.time.set.not.found":"The callable time set could not be found.","duplicate.name":"The name already exists.","invalid.create":"","site.has.no.active.edges":"There are no active edges in the site","edge.group.not.found":"The edge group could not be found.","missing.caller.id.name":"No caller id name supplied","too.many.data.action.conditions":"There can be a maximum of 1 data action condition across all rule sets referenced by this campaign","contact.sorts.duplicate.field.names":"The same column name is used in separate contact sorts entries.","invalid.agent.owned.dialing.mode":"Agent owned records are only available for the Preview dialing mode.","contact.list.filter.does.not.match.contact.list":"The contact list on the contact list filter does not match the contact list on the campaign.","more.than.one.contact.list.filter":"Only one contact list filter is allowed per campaign.","managed.site.cannot.be.configured":"Managed Sites cannot be configured on a campaign.","invalid.campaign.preview.timeout.seconds":"The preview timeout seconds must be between 0 and 1200 (inclusive)","call.analysis.response.set.not.found":"The call analysis response set could not be found.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","script.not.found":"The script could not be found.","contact.list.filter.not.found":"The contact list filter could not be found.","site.and.edge.group.cannot.be.configured":"A single campaign cannot have both a site and an edge group configured","dnc.list.not.found":"A do not call list could not be found.","contact.sort.field.not.found":"The contact sort field is not a column on the contact list.","invalid.campaign.agent.owned.column":"The campaign agent owned column is not a valid contact list column.","contact.sorts.invalid.field.name":"A contact sorts field name is not a valid column name in the campaign's contact list.","missing.caller.id.address":"No caller id address supplied","external.calling.property.not.allowed":"Some properties cannot be set on an external calling campaign. See details","edge.group.has.no.active.edges":"There are no active edges in the edge group","rule.set.not.found":"A rule set could not be found.","managed.edge.group.cannot.be.configured":"Managed Edge Groups cannot be configured on a campaign.","property.not.allowed.for.external.calling":"Property is not allowed for external calling","max.entity.count.reached":"The maximum campaign count has been reached.","invalid.ani.address":"The caller id number is invalid.","invalid.campaign.phone.columns":"The campaign phone columns are invalid.","callable.time.set.conflicts.with.automatic.time.zone.mapping":"A callable time set cannot be included on the campaign when the campaign's contact list uses automatic time zone mapping.","contact.sorts.conflict":"The contact sort and contact sorts fields have conflicting values.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","edge.group.is.empty":"There are no edges in the edge group","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","missing.time.zone.in.contactlist":"When using a callable time set, the contact list must have at least one time zone column defined.","invalid.dialing.mode.update":"A campaign may not be updated to or from external dialing mode to any other dialing mode.","site.not.found":"The site could not be found","site.is.empty":"There are no edges in the site","queue.not.found":"The queue could not be found.","no.edge.group.for.site":"No edge group was found for the site"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:add"]},"x-purecloud-method-name":"postOutboundCampaigns"}},"/api/v2/quality/agents/activity":{"get":{"tags":["Quality"],"summary":"Gets a list of Agent Activities","description":"Including the number of evaluations and average evaluation score","operationId":"getQualityAgentsActivity","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"startTime","in":"query","description":"Start time of agent activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","required":false,"type":"string","format":"date-time"},{"name":"endTime","in":"query","description":"End time of agent activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","required":false,"type":"string","format":"date-time"},{"name":"agentUserId","in":"query","description":"user id of agent requested","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"evaluatorUserId","in":"query","description":"user id of the evaluator","required":false,"type":"string"},{"name":"name","in":"query","description":"name","required":false,"type":"string"},{"name":"group","in":"query","description":"group id","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AgentActivityEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","quality.evaluation.view.permission.check.failed":"Failed to check required view permission.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluation:view"]},"x-purecloud-method-name":"getQualityAgentsActivity"}},"/api/v2/workforcemanagement/schedules":{"post":{"tags":["Workforce Management"],"summary":"Get published schedule for the current user","description":"","operationId":"postWorkforcemanagementSchedules","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/CurrentUserScheduleRequestBody"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserScheduleContainer"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentSchedule:view"]},"x-purecloud-method-name":"postWorkforcemanagementSchedules"}},"/api/v2/telephony/providers/edges/{edgeId}/trunks":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of available trunks for the given Edge.","description":"Trunks are created by assigning trunk base settings to an Edge or Edge Group.","operationId":"getTelephonyProvidersEdgeTrunks","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Value by which to sort","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"trunkBase.id","in":"query","description":"Filter by Trunk Base Ids","required":false,"type":"string"},{"name":"trunkType","in":"query","description":"Filter by a Trunk type","required":false,"type":"string","enum":["EXTERNAL","PHONE","EDGE"],"x-genesys-enum-members":[{"name":"EXTERNAL"},{"name":"PHONE"},{"name":"EDGE"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.resource.not.found":"Specified edgeId not found.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgeTrunks"}},"/api/v2/externalcontacts/organizations/schemas":{"get":{"tags":["External Contacts"],"summary":"Get a list of schemas.","description":"","operationId":"getExternalcontactsOrganizationsSchemas","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchemaListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"Unable to expand the schema."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getExternalcontactsOrganizationsSchemas"},"post":{"tags":["External Contacts"],"summary":"Create a schema","description":"","operationId":"postExternalcontactsOrganizationsSchemas","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Schema","required":true,"schema":{"$ref":"#/definitions/DataSchema"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.limit.max.number.of.fields.per.org.would.be.exceeded":"The total number of fields defined for all schemas cannot exceed 500.","dynamic.schema.validation.limit.error":"The new JSON schema provided for update has a validation limit error.","dynamic.schema.limit.max.number.of.schemas.per.org.would.be.exceeded":"There cannot be more than 20 schemas.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","dynamic.schema.incompatible.json.schema.update":"The JSON schema provided for update is incompatible with the previous version.","dynamic.schema.limit.max.number.of.characters.for.field.name.would.be.exceeded":"A field name cannot exceed 100 characters","dynamic.schema.validation.limit.missing":"The new JSON schema provided for update is missing a validation limit.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","dynamic.schema.invalid.json.schema":"An invalid JSON schema was provided.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","dynamic.schema.limit.max.number.of.fields.per.schema.would.be.exceeded":"A schema cannot have more than 25 fields"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.version.conflict":"A valid version is required."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"Unable to expand the schema."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:add"]},"x-purecloud-method-name":"postExternalcontactsOrganizationsSchemas"}},"/api/v2/outbound/contactlists/{contactListId}/clear":{"post":{"tags":["Outbound"],"summary":"Deletes all contacts out of a list. All outstanding recalls or rule-scheduled callbacks for non-preview campaigns configured with the contactlist will be cancelled.","description":"","operationId":"postOutboundContactlistClear","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"}],"responses":{"204":{"description":"Contacts will be deleted."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.is.on.running.campaign":"The contacts cannot be removed from a contactlist that is on a campaign that is in state ON or STOPPING.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","contact.list.import.in.progress":"The contacts cannot be removed from a contactlist that is currently in progress of an import.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.error":"An internal server error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contact:delete"]},"x-purecloud-method-name":"postOutboundContactlistClear"}},"/api/v2/telephony/providers/edges/didpools/{didPoolId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a DID Pool by ID.","description":"","operationId":"getTelephonyProvidersEdgesDidpool","produces":["application/json"],"parameters":[{"name":"didPoolId","in":"path","description":"DID pool ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DIDPool"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The DID Pool was not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesDidpool"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a DID Pool by ID.","description":"","operationId":"putTelephonyProvidersEdgesDidpool","produces":["application/json"],"parameters":[{"name":"didPoolId","in":"path","description":"DID pool ID","required":true,"type":"string"},{"in":"body","name":"body","description":"DID pool","required":true,"schema":{"$ref":"#/definitions/DIDPool"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DIDPool"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The DID Pool was not found.","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be completed by the server due to a conflict."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesDidpool"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a DID Pool by ID.","description":"","operationId":"deleteTelephonyProvidersEdgesDidpool","produces":["application/json"],"parameters":[{"name":"didPoolId","in":"path","description":"DID pool ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Edge group was not found.","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be completed by the server due to a conflict."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdgesDidpool"}},"/api/v2/license/definitions/{licenseId}":{"get":{"tags":["License"],"summary":"Get PureCloud license definition.","description":"","operationId":"getLicenseDefinition","produces":["application/json"],"parameters":[{"name":"licenseId","in":"path","description":"ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LicenseDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["license","license:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:add"]},"x-purecloud-method-name":"getLicenseDefinition"}},"/api/v2/billing/trusteebillingoverview/{trustorOrgId}":{"get":{"tags":["Billing"],"summary":"Get the billing overview for an organization that is managed by a partner.","description":"Tax Disclaimer: Prices returned by this API do not include applicable taxes. It is the responsibility of the customer to pay all taxes that are appropriate in their jurisdiction. See the PureCloud API Documentation in the Developer Center for more information about this API: https://developer.mypurecloud.com/api/rest/v2/","operationId":"getBillingTrusteebillingoverviewTrustorOrgId","produces":["application/json"],"parameters":[{"name":"billingPeriodIndex","in":"query","description":"0 for active period (overview data may change until period closes). 1 for prior completed billing period. 2 for two billing cycles prior, and so on.","required":false,"type":"integer","default":0,"format":"int32"},{"name":"trustorOrgId","in":"path","description":"The organization ID of the trustor (customer) organization.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrusteeBillingOverview"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["billing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["affiliateOrganization:clientBilling:view"]},"x-purecloud-method-name":"getBillingTrusteebillingoverviewTrustorOrgId"}},"/api/v2/authorization/divisionspermitted/me":{"get":{"tags":["Authorization","Users"],"summary":"Returns which divisions the current user has the given permission in.","description":"This route is deprecated, use authorization/divisionspermitted/paged/me instead.","operationId":"getAuthorizationDivisionspermittedMe","produces":["application/json"],"parameters":[{"name":"name","in":"query","description":"Search term to filter by division name","required":false,"type":"string"},{"name":"permission","in":"query","description":"The permission string, including the object to access, e.g. routing:queue:view","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/AuthzDivision"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","missing.permission.param":"Missing required permission parameter","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getAuthorizationDivisionspermittedMe"}},"/api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get outbound routes","description":"","operationId":"getTelephonyProvidersEdgesSiteOutboundroutes","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"externalTrunkBases.ids","in":"query","description":"externalTrunkBases.ids","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutboundRouteBaseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesSiteOutboundroutes"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create outbound route","description":"","operationId":"postTelephonyProvidersEdgesSiteOutboundroutes","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"in":"body","name":"body","description":"OutboundRoute","required":true,"schema":{"$ref":"#/definitions/OutboundRouteBase"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutboundRouteBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"required.field.missing":"A required field is missing a value.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","number.plan.type.usage.must.be.unique":"The number plan type usage must be unique.","address.classification.type.does.not.exist\t":"The address classification does not exist.","duplicate.value":"An outbound route with this name already exists.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesSiteOutboundroutes"}},"/api/v2/analytics/evaluations/aggregates/query":{"post":{"tags":["Quality","Analytics"],"summary":"Query for evaluation aggregates","description":"","operationId":"postAnalyticsEvaluationsAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/EvaluationAggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:evaluationAggregate:view"]},"x-purecloud-method-name":"postAnalyticsEvaluationsAggregatesQuery"}},"/api/v2/outbound/sequences":{"get":{"tags":["Outbound"],"summary":"Query a list of dialer campaign sequences.","description":"","operationId":"getOutboundSequences","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"allowEmptyResult","in":"query","description":"Whether to return an empty page when there are no results for that page","required":false,"type":"boolean","default":false},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"],"x-genesys-enum-members":[{"name":"Equals"},{"name":"RegEx"},{"name":"Contains"},{"name":"Prefix"},{"name":"LessThan"},{"name":"LessThanEqualTo"},{"name":"GreaterThan"},{"name":"GreaterThanEqualTo"},{"name":"BeginsWith"},{"name":"EndsWith"}]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignSequenceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaignSequence:view"]},"x-purecloud-method-name":"getOutboundSequences"},"post":{"tags":["Outbound"],"summary":"Create a new campaign sequence.","description":"","operationId":"postOutboundSequences","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Organization","required":true,"schema":{"$ref":"#/definitions/CampaignSequence"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignSequence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"A campaign sequence with this name already exists.","invalid.create":"","campaign.sequence.missing.campaign":"The dialer campaign sequence is missing a campaign.","max.entity.count.reached":"The maximum campaign sequence count has been reached.","campaign.sequence.invalid.campaign":"At least one campaign is invalid","campaign.sequence.invalid.current.campaign":"Current campaign is invalid","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","campaign.sequence.is.empty":"The dialer campaign sequence is empty.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaignSequence:add"]},"x-purecloud-method-name":"postOutboundSequences"}},"/api/v2/externalcontacts/scan/notes":{"get":{"tags":["External Contacts"],"summary":"Scan for notes using paging","description":"","operationId":"getExternalcontactsScanNotes","produces":["application/json"],"parameters":[{"name":"limit","in":"query","description":"The number of notes per page; must be between 10 and 200, default is 100)","required":false,"type":"integer","format":"int32"},{"name":"cursor","in":"query","description":"Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CursorNoteListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or expired cursor","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too many requests in a given amount of time"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:view"]},"x-purecloud-method-name":"getExternalcontactsScanNotes"}},"/api/v2/architect/dependencytracking/types":{"get":{"tags":["Architect"],"summary":"Get Dependency Tracking types.","description":"","operationId":"getArchitectDependencytrackingTypes","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DependencyTypeEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:dependencyTracking:view"]},"x-purecloud-method-name":"getArchitectDependencytrackingTypes"}},"/api/v2/integrations/speech/tts/engines/{engineId}/voices/{voiceId}":{"get":{"tags":["Integrations"],"summary":"Get details about a specific voice for a TTS engine","description":"","operationId":"getIntegrationsSpeechTtsEngineVoice","produces":["application/json"],"parameters":[{"name":"engineId","in":"path","description":"The engine ID","required":true,"type":"string"},{"name":"voiceId","in":"path","description":"The voice ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TtsVoiceEntity"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechTtsEngineVoice"}},"/api/v2/recording/mediaretentionpolicies/{policyId}":{"get":{"tags":["Recording"],"summary":"Get a media retention policy","description":"","operationId":"getRecordingMediaretentionpolicy","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Policy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:retentionPolicy:view"]},"x-purecloud-method-name":"getRecordingMediaretentionpolicy"},"put":{"tags":["Recording"],"summary":"Update a media retention policy","description":"","operationId":"putRecordingMediaretentionpolicy","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Policy","required":true,"schema":{"$ref":"#/definitions/Policy"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Policy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.media.policy.invalid":"One of the configured actions or conditions was invalid.","bad.request":"The request could not be understood by the server due to malformed syntax.","recording.policy.assign.evaluation.evaluator.permission.check.failed":"evaluator permission failure for evaluation","recording.policy.assign.calibration.evaluator.permission.check.failed":"Calibrator permission failure","recording.policy.export.integration.invalid":"The specified export integration is not a valid integration.","recording.policy.assign.metered.evaluation.evaluator.permission.check.failed":"evaluator permission failure for metered evaluation","recording.policy.calibrator.permission.fail":"General calibrator permission failure","recording.policy.export.integration.disabled":"The specified export integration is not in active state.","recording.policy.invalid.queue":"The specified queues was invalid.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","recording.policy.name.required":"Recording policy named required.","recording.policy.assign.survey.sending.domain.does.not.exist":"Sending domain does not exist in the organization","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.internal.server.error":"Internal server error updating policy.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:retentionPolicy:edit"]},"x-purecloud-method-name":"putRecordingMediaretentionpolicy"},"delete":{"tags":["Recording"],"summary":"Delete a media retention policy","description":"","operationId":"deleteRecordingMediaretentionpolicy","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.policy.not.found":"The supplied policy was not found or is invalid","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:retentionPolicy:delete"]},"x-purecloud-method-name":"deleteRecordingMediaretentionpolicy"},"patch":{"tags":["Recording"],"summary":"Patch a media retention policy","description":"","operationId":"patchRecordingMediaretentionpolicy","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Policy","required":true,"schema":{"$ref":"#/definitions/Policy"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Policy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:retentionPolicy:edit"]},"x-purecloud-method-name":"patchRecordingMediaretentionpolicy"}},"/api/v2/routing/message/recipients/{recipientId}":{"get":{"tags":["Routing"],"summary":"Get a recipient","description":"","operationId":"getRoutingMessageRecipient","produces":["application/json"],"parameters":[{"name":"recipientId","in":"path","description":"Recipient ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Recipient"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:message:manage"]},"x-purecloud-method-name":"getRoutingMessageRecipient"},"put":{"tags":["Routing"],"summary":"Update a recipient","description":"","operationId":"putRoutingMessageRecipient","produces":["application/json"],"parameters":[{"name":"recipientId","in":"path","description":"Recipient ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Recipient","required":true,"schema":{"$ref":"#/definitions/Recipient"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Recipient"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:message:manage"]},"x-purecloud-method-name":"putRoutingMessageRecipient"}},"/api/v2/externalcontacts/contacts/schemas/{schemaId}":{"get":{"tags":["External Contacts"],"summary":"Get a schema","description":"","operationId":"getExternalcontactsContactsSchema","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getExternalcontactsContactsSchema"},"put":{"tags":["External Contacts"],"summary":"Update a schema","description":"","operationId":"putExternalcontactsContactsSchema","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Data Schema","required":true,"schema":{"$ref":"#/definitions/DataSchema"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.limit.max.number.of.fields.per.org.would.be.exceeded":"The total number of fields defined for all schemas cannot exceed 500.","dynamic.schema.validation.limit.error":"The JSON schema provided for update has a validation limit error.","dynamic.schema.limit.max.number.of.schemas.per.org.would.be.exceeded":"There cannot be more than 20 schemas.","bad.request":"The request could not be understood by the server due to malformed syntax. Check that all required schema fields are present.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","dynamic.schema.incompatible.json.schema.update":"The JSON schema provided for update is incompatible with the previous version.","dynamic.schema.limit.max.number.of.characters.for.field.name.would.be.exceeded":"A field name cannot exceed 100 characters","dynamic.schema.validation.limit.missing":"The new JSON schema provided for update is missing a validation limit.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","dynamic.schema.invalid.json.schema":"An invalid JSON schema was provided.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","dynamic.schema.limit.max.number.of.fields.per.schema.would.be.exceeded":"A schema cannot have more than 25 fields"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.version.conflict":"A valid version is required."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"Unable to expand the schema."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:edit"]},"x-purecloud-method-name":"putExternalcontactsContactsSchema"},"delete":{"tags":["External Contacts"],"summary":"Delete a schema","description":"","operationId":"deleteExternalcontactsContactsSchema","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","feature.forbidden":"Delete operation forbidden."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:edit"]},"x-purecloud-method-name":"deleteExternalcontactsContactsSchema"}},"/api/v2/outbound/events":{"get":{"tags":["Outbound"],"summary":"Query Event Logs","description":"","operationId":"getOutboundEvents","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"],"x-genesys-enum-members":[{"name":"Equals"},{"name":"RegEx"},{"name":"Contains"},{"name":"Prefix"},{"name":"LessThan"},{"name":"LessThanEqualTo"},{"name":"GreaterThan"},{"name":"GreaterThanEqualTo"},{"name":"BeginsWith"},{"name":"EndsWith"}]},{"name":"category","in":"query","description":"Category","required":false,"type":"string"},{"name":"level","in":"query","description":"Level","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DialerEventEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:eventLog:view"]},"x-purecloud-method-name":"getOutboundEvents"}},"/api/v2/quality/publishedforms/surveys/{formId}":{"get":{"tags":["Quality"],"summary":"Get the most recent published version of a survey form.","description":"","operationId":"getQualityPublishedformsSurvey","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:view"]},"x-purecloud-method-name":"getQualityPublishedformsSurvey"}},"/api/v2/contentmanagement/status/{statusId}":{"get":{"tags":["Content Management"],"summary":"Get a status.","description":"","operationId":"getContentmanagementStatusStatusId","produces":["application/json"],"parameters":[{"name":"statusId","in":"path","description":"Status ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CommandStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementStatusStatusId"},"delete":{"tags":["Content Management"],"summary":"Cancel the command for this status","description":"","operationId":"deleteContentmanagementStatusStatusId","produces":["application/json"],"parameters":[{"name":"statusId","in":"path","description":"Status ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"deleteContentmanagementStatusStatusId"}},"/api/v2/telephony/providers/edges/edgegroups/{edgegroupId}/edgetrunkbases/{edgetrunkbaseId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Gets the edge trunk base associated with the edge group","description":"","operationId":"getTelephonyProvidersEdgesEdgegroupEdgetrunkbase","produces":["application/json"],"parameters":[{"name":"edgegroupId","in":"path","description":"Edge Group ID","required":true,"type":"string"},{"name":"edgetrunkbaseId","in":"path","description":"Edge Trunk Base ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeTrunkBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesEdgegroupEdgetrunkbase"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update the edge trunk base associated with the edge group","description":"","operationId":"putTelephonyProvidersEdgesEdgegroupEdgetrunkbase","produces":["application/json"],"parameters":[{"name":"edgegroupId","in":"path","description":"Edge Group ID","required":true,"type":"string"},{"name":"edgetrunkbaseId","in":"path","description":"Edge Trunk Base ID","required":true,"type":"string"},{"in":"body","name":"body","description":"EdgeTrunkBase","required":true,"schema":{"$ref":"#/definitions/EdgeTrunkBase"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeTrunkBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesEdgegroupEdgetrunkbase"}},"/api/v2/flows/divisionviews":{"get":{"tags":["Architect"],"summary":"Get a pageable list of basic flow information objects filterable by query parameters.","description":"This returns a simplified version of /flow consisting of name and type. If one or more IDs are specified, the search will fetch flows that match the given ID(s) and not use any additional supplied query parameters in the search.","operationId":"getFlowsDivisionviews","produces":["application/json"],"parameters":[{"name":"type","in":"query","description":"Type","required":false,"type":"array","items":{"type":"string","enum":["bot","commonmodule","inboundcall","inboundchat","inboundemail","inboundshortmessage","outboundcall","inqueuecall","speech","securecall","surveyinvite","workflow"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"bot"},{"name":"commonmodule"},{"name":"inboundcall"},{"name":"inboundchat"},{"name":"inboundemail"},{"name":"inboundshortmessage"},{"name":"outboundcall"},{"name":"inqueuecall"},{"name":"speech"},{"name":"securecall"},{"name":"surveyinvite"},{"name":"workflow"}]},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"id"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc"},{"name":"id","in":"query","description":"ID","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"publishVersionId","in":"query","description":"Publish version ID","required":false,"type":"string"},{"name":"publishedAfter","in":"query","description":"Published after","required":false,"type":"string","x-example":"2015-01-01T12:00:00-0600, 2015-01-01T18:00:00Z, 2015-01-01T12:00:00.000-0600, 2015-01-01T18:00:00.000Z, 2015-01-01"},{"name":"publishedBefore","in":"query","description":"Published before","required":false,"type":"string","x-example":"2015-01-01T12:00:00-0600, 2015-01-01T18:00:00Z, 2015-01-01T12:00:00.000-0600, 2015-01-01T18:00:00.000Z, 2015-01-01"},{"name":"divisionId","in":"query","description":"division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"includeSchemas","in":"query","description":"Include variable schemas","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowDivisionViewEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.invalid.id":"An invalid flow Id was specified.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","architect.invalid.flow.type":"An invalid flow type was specified.","architect.division.invalid":"One or more of the division IDs are not valid","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","feature.forbidden":"This feature is not enabled for this organization.","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.inbound.short.message.flow.invalid.operation":"Cannot perform requested operation on an inbound short message flow.","architect.workflow.invalid.operation":"Cannot perform requested operation on a workflow.","architect.speech.flow.invalid.operation":"Cannot perform requested operation on a speech flow.","architect.bot.flow.invalid.operation":"Cannot perform requested operation on a bot flow."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"501":{"description":"Not Implemented","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.implemented":"Feature toggle is not enabled for this endpoint."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flow:search"]},"x-purecloud-method-name":"getFlowsDivisionviews"}},"/api/v2/integrations/speech/lex/bot/{botId}/aliases":{"get":{"tags":["Integrations"],"summary":"Get a list of aliases for a bot in the customer's AWS accounts","description":"","operationId":"getIntegrationsSpeechLexBotBotIdAliases","produces":["application/json"],"parameters":[{"name":"botId","in":"path","description":"The bot ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"status","in":"query","description":"Filter on alias status","required":false,"type":"string","enum":["READY","FAILED","BUILDING","NOT_BUILT"],"x-genesys-enum-members":[{"name":"READY"},{"name":"FAILED"},{"name":"BUILDING"},{"name":"NOT_BUILT"}]},{"name":"name","in":"query","description":"Filter on alias name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LexBotAliasEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechLexBotBotIdAliases"}},"/api/v2/widgets/deployments":{"get":{"tags":["Widgets"],"summary":"List Widget deployments","description":"","operationId":"getWidgetsDeployments","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WidgetDeploymentEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["widgets","widgets:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["widgets:deployment:view","webchat:deployment:read"]},"x-purecloud-method-name":"getWidgetsDeployments"},"post":{"tags":["Widgets"],"summary":"Create Widget deployment","description":"","operationId":"postWidgetsDeployments","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Deployment","required":true,"schema":{"$ref":"#/definitions/WidgetDeployment"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WidgetDeployment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.deployments":"Conflict caused by too many deployments","maximum.deployments.exceeded":"No more than 10 deployments allowed"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["widgets"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["widgets:deployment:add","webchat:deployment:create"]},"x-purecloud-method-name":"postWidgetsDeployments"}},"/api/v2/analytics/reporting/reportformats":{"get":{"tags":["Analytics"],"summary":"Get a list of report formats","description":"Get a list of report formats.","operationId":"getAnalyticsReportingReportformats","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"type":"string"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-purecloud-method-name":"getAnalyticsReportingReportformats"}},"/api/v2/integrations/actions":{"get":{"tags":["Integrations"],"summary":"Retrieves all actions associated with filters passed in via query param.","description":"","operationId":"getIntegrationsActions","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Root level field name to sort on.","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Direction to sort 'sortBy' field.","required":false,"type":"string","default":"asc","enum":["ASC","DESC"],"x-genesys-enum-members":[{"name":"ASC"},{"name":"DESC"}]},{"name":"category","in":"query","description":"Filter by category name","required":false,"type":"string"},{"name":"name","in":"query","description":"Filter by action name. Provide full or just the first part of name.","required":false,"type":"string"},{"name":"secure","in":"query","description":"Filter to only include secure actions. True will only include actions marked secured. False will include only unsecure actions. Do not use filter if you want all Actions.","required":false,"type":"string","enum":["true","false"],"x-genesys-enum-members":[{"name":"true"},{"name":"false"}]},{"name":"includeAuthActions","in":"query","description":"Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions.","required":false,"type":"string","default":"false","enum":["true","false"],"x-genesys-enum-members":[{"name":"true"},{"name":"false"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:view","bridge:actions:view"]},"x-purecloud-method-name":"getIntegrationsActions"},"post":{"tags":["Integrations"],"summary":"Create a new Action","description":"","operationId":"postIntegrationsActions","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Input used to create Action.","required":true,"schema":{"$ref":"#/definitions/PostActionInput"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Action"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.schema":"There is an error preventing a file from being read","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:add"]},"x-purecloud-method-name":"postIntegrationsActions"}},"/api/v2/analytics/reporting/schedules/{scheduleId}/history/latest":{"get":{"tags":["Analytics"],"summary":"Get most recently completed scheduled report job.","description":"","operationId":"getAnalyticsReportingScheduleHistoryLatest","produces":["application/json"],"parameters":[{"name":"scheduleId","in":"path","description":"Schedule ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportRunEntry"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-purecloud-method-name":"getAnalyticsReportingScheduleHistoryLatest"}},"/api/v2/analytics/reporting/schedules/{scheduleId}/history":{"get":{"tags":["Analytics"],"summary":"Get list of completed scheduled report jobs.","description":"","operationId":"getAnalyticsReportingScheduleHistory","produces":["application/json"],"parameters":[{"name":"scheduleId","in":"path","description":"Schedule ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportRunEntryEntityDomainListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-purecloud-method-name":"getAnalyticsReportingScheduleHistory"}},"/api/v2/alerting/alerts/active":{"get":{"tags":["Alerting"],"summary":"Gets active alert count for a user.","description":"","operationId":"getAlertingAlertsActive","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActiveAlertCount"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting","alerting:readonly"]}],"x-purecloud-method-name":"getAlertingAlertsActive"}},"/api/v2/recording/mediaretentionpolicies":{"get":{"tags":["Recording"],"summary":"Gets media retention policy list with query options to filter on name and enabled.","description":"for a less verbose response, add summary=true to this endpoint","operationId":"getRecordingMediaretentionpolicies","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"name","in":"query","description":"the policy name - used for filtering results in searches.","required":false,"type":"string"},{"name":"enabled","in":"query","description":"checks to see if policy is enabled - use enabled = true or enabled = false","required":false,"type":"boolean"},{"name":"summary","in":"query","description":"provides a less verbose response of policy lists.","required":false,"type":"boolean","default":false},{"name":"hasErrors","in":"query","description":"provides a way to fetch all policies with errors or policies that do not have errors","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PolicyEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:retentionPolicy:view"]},"x-purecloud-method-name":"getRecordingMediaretentionpolicies"},"post":{"tags":["Recording"],"summary":"Create media retention policy","description":"","operationId":"postRecordingMediaretentionpolicies","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Policy","required":true,"schema":{"$ref":"#/definitions/PolicyCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Policy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.media.policy.invalid":"One of the configured actions or conditions was invalid.","bad.request":"The request could not be understood by the server due to malformed syntax.","recording.policy.assign.evaluation.evaluator.permission.check.failed":"evaluator permission failure for evaluation","recording.policy.assign.calibration.evaluator.permission.check.failed":"Calibrator permission failure","recording.policy.export.integration.invalid":"The specified export integration is not a valid integration.","recording.policy.assign.metered.evaluation.evaluator.permission.check.failed":"evaluator permission failure for metered evaluation","recording.policy.calibrator.permission.fail":"General calibrator permission failure","recording.policy.export.integration.disabled":"The specified export integration is not in active state.","recording.policy.invalid.queue":"The specified queues was invalid.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","recording.policy.name.duplicate.name":"Policy name already exists, cannot duplicate.","recording.policy.description.exceeds.limit":"Policy description exceeds size limit.","recording.policy.assign.survey.sending.domain.does.not.exist":"Sending domain does not exist in the organization","recording.policy.name.exceeds.limit":"Policy named exceeds size limit.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:retentionPolicy:add"]},"x-purecloud-method-name":"postRecordingMediaretentionpolicies"},"delete":{"tags":["Recording"],"summary":"Delete media retention policies","description":"Bulk delete of media retention policies, this will only delete the polices that match the ids specified in the query param.","operationId":"deleteRecordingMediaretentionpolicies","produces":["application/json"],"parameters":[{"name":"ids","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:retentionPolicy:delete"]},"x-purecloud-method-name":"deleteRecordingMediaretentionpolicies"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings":{"get":{"tags":["Knowledge"],"summary":"Get all trainings information for a knowledgebase","description":"","operationId":"getKnowledgeKnowledgebaseLanguageTrainings","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","de-DE"],"x-genesys-enum-members":[{"name":"en-US"},{"name":"de-DE"}]},{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"limit","in":"query","description":"Number of entities to return. Maximum of 200. Deprecated in favour of pageSize.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"name":"knowledgeDocumentsState","in":"query","description":"Return the training with the specified state of the trained documents.","required":false,"type":"string","enum":["Draft","Active","Discarded","Archived"],"x-genesys-enum-members":[{"name":"Draft"},{"name":"Active"},{"name":"Discarded"},{"name":"Archived"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrainingListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:training:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseLanguageTrainings"},"post":{"tags":["Knowledge"],"summary":"Trigger training","description":"","operationId":"postKnowledgeKnowledgebaseLanguageTrainings","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","de-DE"],"x-genesys-enum-members":[{"name":"en-US"},{"name":"de-DE"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeTraining"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:training:create"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseLanguageTrainings"}},"/api/v2/conversations/{conversationId}/recordings/{recordingId}":{"get":{"tags":["Recording"],"summary":"Gets a specific recording.","description":"","operationId":"getConversationRecording","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"recordingId","in":"path","description":"Recording ID","required":true,"type":"string"},{"name":"formatId","in":"query","description":"The desired media format.","required":false,"type":"string","default":"WEBM","enum":["WAV","WEBM","WAV_ULAW","OGG_VORBIS","OGG_OPUS","MP3","NONE"],"x-genesys-enum-members":[{"name":"WAV"},{"name":"WEBM"},{"name":"WAV_ULAW"},{"name":"OGG_VORBIS"},{"name":"OGG_OPUS"},{"name":"MP3"},{"name":"NONE"}]},{"name":"emailFormatId","in":"query","description":"The desired media format when downloading an email recording.","required":false,"type":"string","default":"EML","enum":["EML","NONE"],"x-genesys-enum-members":[{"name":"EML"},{"name":"NONE"}]},{"name":"chatFormatId","in":"query","description":"The desired media format when downloading a chat recording.","required":false,"type":"string","default":"ZIP","enum":["ZIP","NONE"],"x-genesys-enum-members":[{"name":"ZIP"},{"name":"NONE"}]},{"name":"messageFormatId","in":"query","description":"The desired media format when downloading a message recording.","required":false,"type":"string","default":"ZIP","enum":["ZIP","NONE"],"x-genesys-enum-members":[{"name":"ZIP"},{"name":"NONE"}]},{"name":"download","in":"query","description":"requesting a download format of the recording","required":false,"type":"boolean","default":false,"enum":["true","false"],"x-genesys-enum-members":[{"name":"true"},{"name":"false"}]},{"name":"fileName","in":"query","description":"the name of the downloaded fileName","required":false,"type":"string"},{"name":"locale","in":"query","description":"The locale for the requested file when downloading, as an ISO 639-1 code","required":false,"type":"string"}],"responses":{"202":{"description":"Success - recording is transcoding","schema":{"$ref":"#/definitions/Recording"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.query.invalid.conversation":"The conversation query was invalid.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.recording.view.permission.check.failed":"Failed to verify recording view permission.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:recording:view"]},"x-purecloud-method-name":"getConversationRecording"},"put":{"tags":["Recording"],"summary":"Updates the retention records on a recording.","description":"Currently supports updating and removing both archive and delete dates for eligible recordings. A request to change the archival date of an archived recording will result in a restoration of the recording until the new date set. The recording:recording:view permission is required for the recording, as well as either the recording:recording:editRetention or recording:screenRecording:editRetention permissions depending on the type of recording.","operationId":"putConversationRecording","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"recordingId","in":"path","description":"Recording ID","required":true,"type":"string"},{"in":"body","name":"body","description":"recording","required":true,"schema":{"$ref":"#/definitions/Recording"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Recording"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","recording.not.archivable":"Recording has been deleted or is still uploading","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","recording.invalid.json":"Recording request contains invalid JSON","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","recording.recording.edit.retention.permission.check.failed":"Failed to verify recording edit retention permission.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","recording.recording.restore.permission.check.failed":"improper permissions found when attempting to restore recordings"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.not.archivable":"Recording is not achievable","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:recording:view","recording:recording:editRetention","recording:screenRecording:editRetention"]},"x-purecloud-method-name":"putConversationRecording"}},"/api/v2/routing/queues/{queueId}/users/{memberId}":{"delete":{"tags":["Routing"],"summary":"DEPRECATED: use DELETE /routing/queues/{queueId}/members/{memberId}. Delete queue member.","description":"","operationId":"deleteRoutingQueueUser","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"memberId","in":"path","description":"Member ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","missing.any.division.permissions":"At least one of the required division permissions is missing"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:edit","routing:queueMember:manage"]},"x-purecloud-method-name":"deleteRoutingQueueUser"},"patch":{"tags":["Routing"],"summary":"DEPRECATED: use PATCH /routing/queues/{queueId}/members/{memberId}. Update the ring number OR joined status for a User in a Queue.","description":"","operationId":"patchRoutingQueueUser","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"memberId","in":"path","description":"Member ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Queue Member","required":true,"schema":{"$ref":"#/definitions/QueueMember"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueMember"}},"202":{"description":"User update has been accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid request data. Make sure the joined OR ringNumber property is specified.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","missing.any.division.permissions":"At least one of the required division permissions is missing"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:edit","routing:queueMember:manage"]},"x-purecloud-method-name":"patchRoutingQueueUser"}},"/api/v2/voicemail/search":{"get":{"tags":["Search","Voicemail"],"summary":"Search voicemails using the q64 value returned from a previous search","description":"","operationId":"getVoicemailSearch","produces":["application/json"],"parameters":[{"name":"q64","in":"query","description":"q64","required":true,"type":"string"},{"name":"expand","in":"query","description":"expand","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailsSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-purecloud-method-name":"getVoicemailSearch"},"post":{"tags":["Search","Voicemail"],"summary":"Search voicemails","description":"","operationId":"postVoicemailSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/VoicemailSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailsSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-purecloud-method-name":"postVoicemailSearch"}},"/api/v2/outbound/schedules/campaigns":{"get":{"tags":["Outbound"],"summary":"Query for a list of dialer campaign schedules.","description":"","operationId":"getOutboundSchedulesCampaigns","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/CampaignSchedule"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:schedule:view"]},"x-purecloud-method-name":"getOutboundSchedulesCampaigns"}},"/api/v2/workforcemanagement/adherence":{"get":{"tags":["Workforce Management"],"summary":"Get a list of UserScheduleAdherence records for the requested users","description":"","operationId":"getWorkforcemanagementAdherence","produces":["application/json"],"parameters":[{"name":"userId","in":"query","description":"User Id(s) for which to fetch current schedule adherence information. Min 1, Max of 100 userIds per request","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/UserScheduleAdherence"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","no.user.ids.specified":"You must specify at least one userId","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","max.user.ids":"Only 100 users can be requested at a time"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"fail":"WFM Server Error","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:realtimeAdherence:view"]},"x-purecloud-method-name":"getWorkforcemanagementAdherence"}},"/api/v2/recording/jobs/{jobId}":{"get":{"tags":["Recording"],"summary":"Get the status of the job associated with the job id.","description":"","operationId":"getRecordingJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["recording:job:view"]},"x-purecloud-method-name":"getRecordingJob"},"put":{"tags":["Recording"],"summary":"Execute the recording bulk job.","description":"A job must be executed by the same user whom originally created the job. In addition, the user must have permission to update the recording's retention.","operationId":"putRecordingJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"},{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/ExecuteRecordingJobsQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["recording:job:edit","recording:recording:editRetention","recording:screenRecording:editRetention"]},"x-purecloud-method-name":"putRecordingJob"},"delete":{"tags":["Recording"],"summary":"Delete the recording bulk job","description":"","operationId":"deleteRecordingJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["recording:job:delete"]},"x-purecloud-method-name":"deleteRecordingJob"}},"/api/v2/responsemanagement/responses/{responseId}":{"get":{"tags":["Response Management"],"summary":"Get details about an existing response.","description":"","operationId":"getResponsemanagementResponse","produces":["application/json"],"parameters":[{"name":"responseId","in":"path","description":"Response ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand instructions for the return value.","required":false,"type":"string","enum":["substitutionsSchema"],"x-genesys-enum-members":[{"name":"substitutionsSchema"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Response"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","rms.response.not.found":"The response could not be found"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management","response-management:readonly"]}],"x-purecloud-method-name":"getResponsemanagementResponse"},"put":{"tags":["Response Management"],"summary":"Update an existing response.","description":"Fields that can be updated: name, libraries, and texts. The most recent version is required for updates.","operationId":"putResponsemanagementResponse","produces":["application/json"],"parameters":[{"name":"responseId","in":"path","description":"Response ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Response","required":true,"schema":{"$ref":"#/definitions/Response"}},{"name":"expand","in":"query","description":"Expand instructions for the return value.","required":false,"type":"string","enum":["substitutionsSchema"],"x-genesys-enum-members":[{"name":"substitutionsSchema"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Response"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Resource conflict - Unexpected version was provided"},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management"]}],"x-purecloud-method-name":"putResponsemanagementResponse"},"delete":{"tags":["Response Management"],"summary":"Delete an existing response.","description":"This will remove the response from any libraries associated with it.","operationId":"deleteResponsemanagementResponse","produces":["application/json"],"parameters":[{"name":"responseId","in":"path","description":"Response ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["response-management"]}],"x-purecloud-method-name":"deleteResponsemanagementResponse"}},"/api/v2/flows/{flowId}/versions":{"get":{"tags":["Architect"],"summary":"Get flow version list","description":"","operationId":"getFlowVersions","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"deleted","in":"query","description":"Include Deleted flows","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowVersionEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.flow.not.found":"Could not find flow with specified ID."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:view"]},"x-purecloud-method-name":"getFlowVersions"},"post":{"tags":["Architect"],"summary":"Create flow version","description":"","operationId":"postFlowVersions","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"type":"object","additionalProperties":{"type":"object"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowVersion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","architect.flow.data.missing":"Flow version data content is missing.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","architect.object.validate.failed":"Failed to validate object.","architect.flow.version.validate.failed.configuration.version":"Flow version object configuration version is missing or invalid.","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.flow.not.found":"Could not find flow with specified ID."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.debug.flow.invalid.operation":"Cannot perform requested operation on a debug flow."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.not.locked.by.user":"Flow is not locked by requesting user."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.save.failed":"Could not save flow data to permanent storage.","architect.object.update.failed":"The database update for the object failed.","architect.flow.data.invalid.format":"Flow version data content is in an invalid format.","architect.flow.serialize.failed":"Could not serialize flow data.","architect.external.user.query.error":"Failed querying backend service for information on user.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:edit"]},"x-purecloud-method-name":"postFlowVersions"}},"/api/v2/quality/publishedforms/{formId}":{"get":{"tags":["Quality"],"summary":"Get the published evaluation forms.","description":"","operationId":"getQualityPublishedform","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","evaluation.not.found":"Requested formId not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:view"]},"x-purecloud-method-name":"getQualityPublishedform"}},"/api/v2/authorization/roles/default":{"post":{"tags":["Authorization"],"summary":"Restores all default roles","description":"This endpoint serves several purposes. 1. It provides the org with default roles. This is important for default roles that will be added after go-live (they can retroactively add the new default-role). Note: When not using a query param of force=true, it only adds the default roles not configured for the org; it does not overwrite roles. 2. Using the query param force=true, you can restore all default roles. Note: This does not have an effect on custom roles.","operationId":"postAuthorizationRolesDefault","produces":["application/json"],"parameters":[{"name":"force","in":"query","description":"Restore default roles","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationRoleEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:edit"]},"x-purecloud-method-name":"postAuthorizationRolesDefault"},"put":{"tags":["Authorization"],"summary":"Restore specified default roles","description":"","operationId":"putAuthorizationRolesDefault","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Organization roles list","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/DomainOrganizationRole"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationRoleEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:edit"]},"x-purecloud-method-name":"putAuthorizationRolesDefault"}},"/api/v2/orgauthorization/trustees/audits":{"post":{"tags":["Organization Authorization"],"summary":"Get Org Trustee Audits","description":"","operationId":"postOrgauthorizationTrusteesAudits","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"timestamp"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"descending"},{"in":"body","name":"body","description":"Values to scope the request.","required":true,"schema":{"$ref":"#/definitions/TrusteeAuditQueryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuditQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:audit:view"]},"x-purecloud-method-name":"postOrgauthorizationTrusteesAudits"}},"/api/v2/webchat/deployments/{deploymentId}":{"get":{"tags":["WebChat"],"summary":"Get a WebChat deployment","description":"","operationId":"getWebchatDeployment","produces":["application/json"],"parameters":[{"name":"deploymentId","in":"path","description":"Deployment Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatDeployment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["web-chat","web-chat:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["webchat:deployment:read"]},"x-purecloud-method-name":"getWebchatDeployment"},"put":{"tags":["WebChat"],"summary":"Update a WebChat deployment","description":"","operationId":"putWebchatDeployment","produces":["application/json"],"parameters":[{"name":"deploymentId","in":"path","description":"Deployment Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Deployment","required":true,"schema":{"$ref":"#/definitions/WebChatDeployment"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatDeployment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["web-chat"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["webchat:deployment:update"]},"x-purecloud-method-name":"putWebchatDeployment"},"delete":{"tags":["WebChat"],"summary":"Delete a WebChat deployment","description":"","operationId":"deleteWebchatDeployment","produces":["application/json"],"parameters":[{"name":"deploymentId","in":"path","description":"Deployment Id","required":true,"type":"string"}],"responses":{"204":{"description":"Deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["web-chat"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["webchat:deployment:delete"]},"x-purecloud-method-name":"deleteWebchatDeployment"}},"/api/v2/quality/surveys/scorable":{"get":{"tags":["Quality"],"summary":"Get a survey as an end-customer, for the purposes of scoring it.","description":"","operationId":"getQualitySurveysScorable","produces":["application/json"],"parameters":[{"name":"customerSurveyUrl","in":"query","description":"customerSurveyUrl","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScorableSurvey"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.survey.form.context.doesnt.have.valid.published.version":"All published versions of this survey form have been disabled.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"getQualitySurveysScorable"},"put":{"tags":["Quality"],"summary":"Update a survey as an end-customer, for the purposes of scoring it.","description":"","operationId":"putQualitySurveysScorable","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"survey","required":true,"schema":{"$ref":"#/definitions/ScorableSurvey"}},{"name":"customerSurveyUrl","in":"query","description":"customerSurveyUrl","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScorableSurvey"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.survey.unauthenticated.already.finished":"The survey is already finished.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"putQualitySurveysScorable"}},"/api/v2/responsemanagement/libraries/{libraryId}":{"get":{"tags":["Response Management"],"summary":"Get details about an existing response library.","description":"","operationId":"getResponsemanagementLibrary","produces":["application/json"],"parameters":[{"name":"libraryId","in":"path","description":"Library ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Library"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"rms.library.not.found":"The response library could not be found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management","response-management:readonly"]}],"x-purecloud-method-name":"getResponsemanagementLibrary"},"put":{"tags":["Response Management"],"summary":"Update an existing response library.","description":"Fields that can be updated: name. The most recent version is required for updates.","operationId":"putResponsemanagementLibrary","produces":["application/json"],"parameters":[{"name":"libraryId","in":"path","description":"Library ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Library","required":true,"schema":{"$ref":"#/definitions/Library"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Library"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Resource conflict - Unexpected version was provided"},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management"]}],"x-purecloud-method-name":"putResponsemanagementLibrary"},"delete":{"tags":["Response Management"],"summary":"Delete an existing response library.","description":"This will remove any responses associated with the library.","operationId":"deleteResponsemanagementLibrary","produces":["application/json"],"parameters":[{"name":"libraryId","in":"path","description":"Library ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["response-management"]}],"x-purecloud-method-name":"deleteResponsemanagementLibrary"}},"/api/v2/integrations/speech/lex/bots":{"get":{"tags":["Integrations"],"summary":"Get a list of Lex bots in the customers' AWS accounts","description":"","operationId":"getIntegrationsSpeechLexBots","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"name","in":"query","description":"Filter on bot name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LexBotEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechLexBots"}},"/api/v2/quality/publishedforms/evaluations":{"get":{"tags":["Quality"],"summary":"Get the published evaluation forms.","description":"","operationId":"getQualityPublishedformsEvaluations","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"onlyLatestPerContext","in":"query","description":"onlyLatestPerContext","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:view"]},"x-purecloud-method-name":"getQualityPublishedformsEvaluations"},"post":{"tags":["Quality"],"summary":"Publish an evaluation form.","description":"","operationId":"postQualityPublishedformsEvaluations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Publish request containing id of form to publish","required":true,"schema":{"$ref":"#/definitions/PublishForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:add"]},"x-purecloud-method-name":"postQualityPublishedformsEvaluations"}},"/api/v2/telephony/providers/edges/trunkbasesettings/availablemetabases":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of available makes and models to create a new Trunk Base Settings","description":"","operationId":"getTelephonyProvidersEdgesTrunkbasesettingsAvailablemetabases","produces":["application/json"],"parameters":[{"name":"type","in":"query","required":false,"type":"string","enum":["EXTERNAL","PHONE","EDGE"],"x-genesys-enum-members":[{"name":"EXTERNAL"},{"name":"PHONE"},{"name":"EDGE"}]},{"name":"pageSize","in":"query","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkMetabaseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesTrunkbasesettingsAvailablemetabases"}},"/api/v2/coaching/notifications":{"get":{"tags":["Coaching"],"summary":"Retrieve the list of your notifications.","description":"","operationId":"getCoachingNotifications","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"expand","in":"query","description":"Indicates a field in the response which should be expanded.","required":false,"type":"array","items":{"type":"string","enum":["appointment"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"appointment"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CoachingNotificationList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","pagination.bad.request":"The page size or page number could not be parsed."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","coaching:readonly"]}],"x-purecloud-method-name":"getCoachingNotifications"}},"/api/v2/fax/summary":{"get":{"tags":["Fax"],"summary":"Get fax summary","description":"","operationId":"getFaxSummary","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxSummary"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["fax","fax:readonly"]}],"x-purecloud-method-name":"getFaxSummary"}},"/api/v2/quality/forms/evaluations/{formId}/versions":{"get":{"tags":["Quality"],"summary":"Gets all the revisions for a specific evaluation.","description":"","operationId":"getQualityFormsEvaluationVersions","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:view"]},"x-purecloud-method-name":"getQualityFormsEvaluationVersions"}},"/api/v2/search/suggest":{"get":{"tags":["Search","Suggest"],"summary":"Suggest resources using the q64 value returned from a previous suggest query.","description":"","operationId":"getSearchSuggest","produces":["application/json"],"parameters":[{"name":"q64","in":"query","description":"q64","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography","callerUser.routingStatus","callerUser.primaryPresence","callerUser.conversationSummary","callerUser.outOfOffice","callerUser.geolocation","images","addressVerificationDetails"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"routingStatus"},{"name":"presence"},{"name":"conversationSummary"},{"name":"outOfOffice"},{"name":"geolocation"},{"name":"station"},{"name":"authorization"},{"name":"lasttokenissued"},{"name":"authorization.unusedRoles"},{"name":"team"},{"name":"profileSkills"},{"name":"certifications"},{"name":"locations"},{"name":"groups"},{"name":"skills"},{"name":"languages"},{"name":"languagePreference"},{"name":"employerInfo"},{"name":"biography"},{"name":"callerUser.routingStatus"},{"name":"callerUser.primaryPresence"},{"name":"callerUser.conversationSummary"},{"name":"callerUser.outOfOffice"},{"name":"callerUser.geolocation"},{"name":"images"},{"name":"addressVerificationDetails"}]},{"name":"profile","in":"query","description":"profile","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JsonNodeSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["search:readonly"]}],"x-purecloud-method-name":"getSearchSuggest"},"post":{"tags":["Search","Suggest"],"summary":"Suggest resources.","description":"","operationId":"postSearchSuggest","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/SuggestSearchRequest"}},{"name":"profile","in":"query","description":"profile","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JsonNodeSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["search:readonly"]}],"x-purecloud-method-name":"postSearchSuggest"}},"/api/v2/search":{"get":{"tags":["Search","Suggest"],"summary":"Search using the q64 value returned from a previous search.","description":"","operationId":"getSearch","produces":["application/json"],"parameters":[{"name":"q64","in":"query","description":"q64","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography","callerUser.routingStatus","callerUser.primaryPresence","callerUser.conversationSummary","callerUser.outOfOffice","callerUser.geolocation","images","addressVerificationDetails"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"routingStatus"},{"name":"presence"},{"name":"conversationSummary"},{"name":"outOfOffice"},{"name":"geolocation"},{"name":"station"},{"name":"authorization"},{"name":"lasttokenissued"},{"name":"authorization.unusedRoles"},{"name":"team"},{"name":"profileSkills"},{"name":"certifications"},{"name":"locations"},{"name":"groups"},{"name":"skills"},{"name":"languages"},{"name":"languagePreference"},{"name":"employerInfo"},{"name":"biography"},{"name":"callerUser.routingStatus"},{"name":"callerUser.primaryPresence"},{"name":"callerUser.conversationSummary"},{"name":"callerUser.outOfOffice"},{"name":"callerUser.geolocation"},{"name":"images"},{"name":"addressVerificationDetails"}]},{"name":"profile","in":"query","description":"profile","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JsonNodeSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","too.many.search.requests":"Rate limit for search requests exceeded"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["search:readonly"]}],"x-purecloud-method-name":"getSearch"},"post":{"tags":["Search","Suggest"],"summary":"Search resources.","description":"","operationId":"postSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/SearchRequest"}},{"name":"profile","in":"query","description":"profile","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JsonNodeSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","user.not.in.organization":"User is not in organization.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","too.many.search.requests":"Rate limit for search requests exceeded"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["search:readonly"]}],"x-purecloud-method-name":"postSearch"}},"/api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Trunk Base Settings object by ID","description":"Managed properties will not be returned unless the user is assigned the internal:trunk:edit permission.","operationId":"getTelephonyProvidersEdgesTrunkbasesetting","produces":["application/json"],"parameters":[{"name":"trunkBaseSettingsId","in":"path","description":"Trunk Base ID","required":true,"type":"string"},{"name":"ignoreHidden","in":"query","description":"Set this to true to not receive trunk properties that are meant to be hidden or for internal system usage only.","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"The requested entity was not found.","general.resource.not.found":"Unable to find the trunk base settings with that id.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesTrunkbasesetting"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a Trunk Base Settings object by ID","description":"","operationId":"putTelephonyProvidersEdgesTrunkbasesetting","produces":["application/json"],"parameters":[{"name":"trunkBaseSettingsId","in":"path","description":"Trunk Base ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Trunk base settings","required":true,"schema":{"$ref":"#/definitions/TrunkBase"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"required.field.missing":"A required field is missing a value.","validation.error":"Error validating the data.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.value":"A trunk with that name already exists.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","general.access.denied":"The requested action is forbidden.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"The requested entity was not found.","general.resource.not.found":"The requested resource was not found.","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be made due to conflict with the server resources"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesTrunkbasesetting"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a Trunk Base Settings object by ID","description":"","operationId":"deleteTelephonyProvidersEdgesTrunkbasesetting","produces":["application/json"],"parameters":[{"name":"trunkBaseSettingsId","in":"path","description":"Trunk Base ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"delete.referenced.entity":"The trunk is being referenced.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","general.bad.request":"The request could not be understood by the server due to malformed syntax."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"The requested entity was not found.","general.resource.not.found":"Unable to delete trunk base settings with that id.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdgesTrunkbasesetting"}},"/api/v2/users/{userId}/callforwarding":{"get":{"tags":["Users"],"summary":"Get a user's CallForwarding","description":"","operationId":"getUserCallforwarding","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallForwarding"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","callforwarding.usernotpermitted":"User is not permitted to use call forwarding","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"424":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"externalservice.unexpectedresponsecode":"Unexpected response code from external service"}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getUserCallforwarding"},"put":{"tags":["Users"],"summary":"Update a user's CallForwarding","description":"","operationId":"putUserCallforwarding","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Call forwarding","required":true,"schema":{"$ref":"#/definitions/CallForwarding"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallForwarding"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"callforwarding.voicemaillastcallrequiresatleastonecalltoaphonenumber":"Setting voicemail 'lastcall' requires a call to a phone number","callforwarding.voicemailpurecloudrequiresatleastonecall":"Setting voicemail 'purecloud' cannot be used without a call","callforwarding.calltargetrequirestype":"A call target requires a type","callforwarding.enablednotallowedwhileonqueue":"Call forwarding is not allowed to be enabled while on queue","callforwarding.voicemaillastcallcannotusestation":"Setting voicemail 'lastcall' cannot be used with a station","callforwarding.enablednotallowedwithoutcalls":"Call forwarding is not allowed to be enabled without calls","callforwarding.webrtcstationmustbelongtouser":"WebRtc station must belong to the user","callforwarding.maxnumberofcallsexceeded":"The number of calls exceeds the limit","callforwarding.maxnumberofcalltargetsexceeded":"The number of targets per call exceeds the limit","callforwarding.invalidphonenumberformat":"Invalid E164 phone number","callforwarding.calltargetstationrequiresstation":"Call target with type of 'station' requires the value to be a valid station id","callforwarding.invalidextension":"Invalid extension","callforwarding.callrequiresatleastonetarget":"A call requires at least one target","callforwarding.enabledcannotbenull":"Enabled must be true or false","callforwarding.calltargetunknowntype":"A call target has unknown type","callforwarding.duplicatetargetnotallowed":"A phone number or station can only be used once","callforwarding.invalidtargettype":"Value for the target type is invalid","callforwarding.voicemailpermissionrequired":"Setting voicemail to 'purecloud' requires the user to have voicemail permission","callforwarding.calltargetphonenumberrequiresvalue":"Call target with type of 'phonenumber' requires the value to be a valid phone number or extension","callforwarding.voicemaillastcallmustbeanexternalphonenumber":"Setting voicemail to 'lastcall' requires the last call to use a single phone number to an external non-PureCloud operated number","callforwarding.calltargetrequiresvalue":"A call target requires a value","callforwarding.voicemaillastcallcannotuseextension":"Setting voicemail 'lastcall' cannot be used with an extension"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-purecloud-method-name":"putUserCallforwarding"},"patch":{"tags":["Users"],"summary":"Patch a user's CallForwarding","description":"","operationId":"patchUserCallforwarding","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Call forwarding","required":true,"schema":{"$ref":"#/definitions/CallForwarding"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallForwarding"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"callforwarding.voicemaillastcallrequiresatleastonecalltoaphonenumber":"Setting voicemail 'lastcall' requires a call to a phone number","callforwarding.voicemailpurecloudrequiresatleastonecall":"Setting voicemail 'purecloud' cannot be used without a call","callforwarding.calltargetrequirestype":"A call target requires a type","callforwarding.enablednotallowedwhileonqueue":"Call forwarding is not allowed to be enabled while on queue","callforwarding.voicemaillastcallcannotusestation":"Setting voicemail 'lastcall' cannot be used with a station","callforwarding.enablednotallowedwithoutcalls":"Call forwarding is not allowed to be enabled without calls","callforwarding.webrtcstationmustbelongtouser":"WebRtc station must belong to the user","callforwarding.maxnumberofcallsexceeded":"The number of calls exceeds the limit","callforwarding.maxnumberofcalltargetsexceeded":"The number of targets per call exceeds the limit","callforwarding.invalidphonenumberformat":"Invalid E164 phone number","callforwarding.calltargetstationrequiresstation":"Call target with type of 'station' requires the value to be a valid station id","callforwarding.invalidextension":"Invalid extension","callforwarding.callrequiresatleastonetarget":"A call requires at least one target","callforwarding.enabledcannotbenull":"Enabled must be true or false","callforwarding.calltargetunknowntype":"A call target has unknown type","callforwarding.duplicatetargetnotallowed":"A phone number or station can only be used once","callforwarding.invalidtargettype":"Value for the target type is invalid","callforwarding.voicemailpermissionrequired":"Setting voicemail to 'purecloud' requires the user to have voicemail permission","callforwarding.calltargetphonenumberrequiresvalue":"Call target with type of 'phonenumber' requires the value to be a valid phone number or extension","callforwarding.voicemaillastcallmustbeanexternalphonenumber":"Setting voicemail to 'lastcall' requires the last call to use a single phone number to an external non-PureCloud operated number","callforwarding.calltargetrequiresvalue":"A call target requires a value","callforwarding.voicemaillastcallcannotuseextension":"Setting voicemail 'lastcall' cannot be used with an extension"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-purecloud-method-name":"patchUserCallforwarding"}},"/api/v2/mobiledevices":{"get":{"tags":["Mobile Devices"],"summary":"Get a list of all devices.","description":"","operationId":"getMobiledevices","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ascending","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DirectoryUserDevicesListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["devices","devices:readonly"]}],"x-purecloud-method-name":"getMobiledevices"},"post":{"tags":["Mobile Devices"],"summary":"Create User device","description":"","operationId":"postMobiledevices","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Device","required":true,"schema":{"$ref":"#/definitions/UserDevice"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserDevice"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["devices"]}],"x-purecloud-method-name":"postMobiledevices"}},"/api/v2/voicemail/messages/{messageId}":{"get":{"tags":["Voicemail"],"summary":"Get a voicemail message","description":"","operationId":"getVoicemailMessage","produces":["application/json"],"parameters":[{"name":"messageId","in":"path","description":"Message ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"If the caller is a known user, which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["callerUser.routingStatus","callerUser.primaryPresence","callerUser.conversationSummary","callerUser.outOfOffice","callerUser.geolocation"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"callerUser.routingStatus"},{"name":"callerUser.primaryPresence"},{"name":"callerUser.conversationSummary"},{"name":"callerUser.outOfOffice"},{"name":"callerUser.geolocation"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","voicemail.not.authorized.voicemail.message":"You are not authorized to access the voicemail message.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-purecloud-method-name":"getVoicemailMessage"},"put":{"tags":["Voicemail"],"summary":"Update a voicemail message","description":"A user voicemail can only be modified by its associated user. A group voicemail can only be modified by a user that is a member of the group. A queue voicemail can only be modified by a participant of the conversation the voicemail is associated with.","operationId":"putVoicemailMessage","produces":["application/json"],"parameters":[{"name":"messageId","in":"path","description":"Message ID","required":true,"type":"string"},{"in":"body","name":"body","description":"VoicemailMessage","required":true,"schema":{"$ref":"#/definitions/VoicemailMessage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"voicemail.retention.policy.type.unknown":"The voicemail retention policy type is invalid","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","voicemail.retention.policy.number.of.days.required":"The retention policy's number of days is required for a voicemail with a retention policy type of RETAIN_WITH_TTL","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","voicemail.retention.policy.number.of.days.too.large":"The retention policy's number of days is too large","voicemail.retention.policy.type.required":"The voicemail retention policy type is required","voicemail.retention.policy.number.of.days.too.small":"The retention policy's number of days is too small","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","voicemail.not.authorized.voicemail.message":"You are not authorized to access the voicemail message.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","voicemail.not.authorized.voicemail.delete":"You are not authorized to delete the voicemail message."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"voicemail.notes.length.exceeded":"The voicemail message's note length was exceeded."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail"]}],"x-purecloud-method-name":"putVoicemailMessage"},"delete":{"tags":["Voicemail"],"summary":"Delete a voicemail message.","description":"A user voicemail can only be deleted by its associated user. A group voicemail can only be deleted by a user that is a member of the group. A queue voicemail can only be deleted by a user with the acd voicemail delete permission.","operationId":"deleteVoicemailMessage","produces":["application/json"],"parameters":[{"name":"messageId","in":"path","description":"Message ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","voicemail.not.authorized.voicemail.message":"You are not authorized to access the voicemail message.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail"]}],"x-purecloud-method-name":"deleteVoicemailMessage"},"patch":{"tags":["Voicemail"],"summary":"Update a voicemail message","description":"A user voicemail can only be modified by its associated user. A group voicemail can only be modified by a user that is a member of the group. A queue voicemail can only be modified by a participant of the conversation the voicemail is associated with.","operationId":"patchVoicemailMessage","produces":["application/json"],"parameters":[{"name":"messageId","in":"path","description":"Message ID","required":true,"type":"string"},{"in":"body","name":"body","description":"VoicemailMessage","required":true,"schema":{"$ref":"#/definitions/VoicemailMessage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"voicemail.retention.policy.type.unknown":"The voicemail retention policy type is invalid","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","voicemail.retention.policy.number.of.days.required":"The retention policy's number of days is required for a voicemail with a retention policy type of RETAIN_WITH_TTL","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","voicemail.retention.policy.number.of.days.too.large":"The retention policy's number of days is too large","voicemail.retention.policy.type.required":"The voicemail retention policy type is required","voicemail.retention.policy.number.of.days.too.small":"The retention policy's number of days is too small","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","voicemail.not.authorized.voicemail.message":"You are not authorized to access the voicemail message.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","voicemail.not.authorized.voicemail.delete":"You are not authorized to delete the voicemail message."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"voicemailservice.toomanyrequests":"Too many requests have been made in the given time","voicemail.notes.length.exceeded":"The voicemail message's note length was exceeded."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail"]}],"x-purecloud-method-name":"patchVoicemailMessage"}},"/api/v2/voicemail/messages/{messageId}/media":{"get":{"tags":["Voicemail"],"summary":"Get media playback URI for this voicemail message","description":"","operationId":"getVoicemailMessageMedia","produces":["application/json"],"parameters":[{"name":"messageId","in":"path","description":"Message ID","required":true,"type":"string"},{"name":"formatId","in":"query","description":"The desired media format.","required":false,"type":"string","default":"WEBM","enum":["WAV","WEBM","WAV_ULAW","OGG_VORBIS","OGG_OPUS","MP3","NONE"],"x-genesys-enum-members":[{"name":"WAV"},{"name":"WEBM"},{"name":"WAV_ULAW"},{"name":"OGG_VORBIS"},{"name":"OGG_OPUS"},{"name":"MP3"},{"name":"NONE"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMediaInfo"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","voicemail.not.authorized.voicemail.message":"You are not authorized to access the voicemail message.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-purecloud-method-name":"getVoicemailMessageMedia"}},"/api/v2/outbound/contactlists/{contactListId}/contacts":{"post":{"tags":["Outbound"],"summary":"Add contacts to a contact list.","description":"","operationId":"postOutboundContactlistContacts","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Contact","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/WritableDialerContact"}}},{"name":"priority","in":"query","description":"Contact priority. True means the contact(s) will be dialed next; false means the contact will go to the end of the contact queue.","required":false,"type":"boolean"},{"name":"clearSystemData","in":"query","description":"Clear system data. True means the system columns (attempts, callable status, etc) stored on the contact will be cleared if the contact already exists; false means they won't.","required":false,"type":"boolean"},{"name":"doNotQueue","in":"query","description":"Do not queue. True means that updated contacts will not have their positions in the queue altered, so contacts that have already been dialed will not be redialed. For new contacts, this parameter has no effect; False means that updated contacts will be re-queued, according to the 'priority' parameter.","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/DialerContact"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.contacts.added":"Too many contacts added, the limit is 1000 per request","uploads.black.listed":"This organization has been prohibited from uploading contacts. Please contact support.","contact.missing.columns":"The contact is missing columns from its contact list.","invalid.contact.columns":"The contact columns are invalid.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.create":"An attempt was made to create contacts in an invalid way","invalid.update":"An attempt was made to update contacts in an invalid way","invalid.contact.id":"The custom contactId field is not valid. It cannot contain special characters.","contact.column.length.limit.exceeded":"The length of each contact column must not exceed the limit.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","contact.missing.data":"The data field is required.","contact.columns.limit.exceeded":"Number of contact columns must not exceed the limit.","contact.datum.length.limit.exceeded":"The length of each piece of contact data must not exceed the limit.","contacts.per.org.limit.exceeded":"The organization has reached the limit on total contacts","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.error":"An internal service error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contact:add"]},"x-purecloud-method-name":"postOutboundContactlistContacts"},"delete":{"tags":["Outbound"],"summary":"Delete contacts from a contact list.","description":"","operationId":"deleteOutboundContactlistContacts","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"},{"name":"contactIds","in":"query","description":"ContactIds to delete.","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"Contacts Deleted."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.contacts.added":"There were too many contacts in the request, the limit is 250","invalid.contact.id":"One or more of the contacts was invalidly formed with non UTF-8 characters.","invalid.delete":"An attempt was made to delete contacts in an invalid way","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","no.contacts.specified":"There were no contacts specified in the request."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contact:delete"]},"x-purecloud-method-name":"deleteOutboundContactlistContacts"}},"/api/v2/orphanrecordings/{orphanId}/media":{"get":{"tags":["Recording"],"summary":"Gets the media of a single orphan recording","description":"A 202 response means the orphaned media is currently transcoding and will be available shortly.A 200 response denotes the transcoded orphan media is available now and is contained in the response body.","operationId":"getOrphanrecordingMedia","produces":["application/json"],"parameters":[{"name":"orphanId","in":"path","description":"Orphan ID","required":true,"type":"string"},{"name":"formatId","in":"query","description":"The desired media format.","required":false,"type":"string","default":"WEBM","enum":["WAV","WEBM","WAV_ULAW","OGG_VORBIS","OGG_OPUS","MP3","NONE"],"x-genesys-enum-members":[{"name":"WAV"},{"name":"WEBM"},{"name":"WAV_ULAW"},{"name":"OGG_VORBIS"},{"name":"OGG_OPUS"},{"name":"MP3"},{"name":"NONE"}]},{"name":"emailFormatId","in":"query","description":"The desired media format when downloading an email recording.","required":false,"type":"string","default":"EML","enum":["EML","NONE"],"x-genesys-enum-members":[{"name":"EML"},{"name":"NONE"}]},{"name":"chatFormatId","in":"query","description":"The desired media format when downloading a chat recording.","required":false,"type":"string","default":"ZIP","enum":["ZIP","NONE"],"x-genesys-enum-members":[{"name":"ZIP"},{"name":"NONE"}]},{"name":"messageFormatId","in":"query","description":"The desired media format when downloading a message recording.","required":false,"type":"string","default":"ZIP","enum":["ZIP","NONE"],"x-genesys-enum-members":[{"name":"ZIP"},{"name":"NONE"}]},{"name":"download","in":"query","description":"requesting a download format of the recording","required":false,"type":"boolean","default":false,"enum":["true","false"],"x-genesys-enum-members":[{"name":"true"},{"name":"false"}]},{"name":"fileName","in":"query","description":"the name of the downloaded fileName","required":false,"type":"string"},{"name":"locale","in":"query","description":"The locale for the requested file when downloading, as an ISO 639-1 code","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Recording"}},"202":{"description":"Accepted - Transcoding orphan media"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:orphan:view"]},"x-purecloud-method-name":"getOrphanrecordingMedia"}},"/api/v2/externalcontacts/scan/relationships":{"get":{"tags":["External Contacts"],"summary":"Scan for relationships","description":"","operationId":"getExternalcontactsScanRelationships","produces":["application/json"],"parameters":[{"name":"limit","in":"query","description":"The number of relationships per page; must be between 10 and 200, default is 100)","required":false,"type":"integer","format":"int32"},{"name":"cursor","in":"query","description":"Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CursorRelationshipListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or expired cursor","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too many requests in a given amount of time"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:view"]},"x-purecloud-method-name":"getExternalcontactsScanRelationships"}},"/api/v2/users/{userId}/trustors":{"get":{"tags":["Users"],"summary":"List the organizations that have authorized/trusted the user.","description":"","operationId":"getUserTrustors","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustorEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a user with that userId","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["authorization:orgTrustor:view"]},"x-purecloud-method-name":"getUserTrustors"}},"/api/v2/analytics/reporting/schedules/{scheduleId}/history/{runId}":{"get":{"tags":["Analytics"],"summary":"A completed scheduled report job","description":"A completed scheduled report job.","operationId":"getAnalyticsReportingScheduleHistoryRunId","produces":["application/json"],"parameters":[{"name":"runId","in":"path","description":"Run ID","required":true,"type":"string"},{"name":"scheduleId","in":"path","description":"Schedule ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportRunEntry"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-purecloud-method-name":"getAnalyticsReportingScheduleHistoryRunId"}},"/api/v2/users/{userId}/station/defaultstation/{stationId}":{"put":{"tags":["Users"],"summary":"Set default station","description":"","operationId":"putUserStationDefaultstationStationId","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"stationId","in":"path","description":"stationId","required":true,"type":"string"}],"responses":{"202":{"description":"Success"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"userservice.stationalreadyhasdefaultuser":"Station is already associated"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","userservice.toomanyrequests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all","telephony:phone:assign"]},"x-purecloud-method-name":"putUserStationDefaultstationStationId"}},"/api/v2/users/{userId}/station/defaultstation":{"delete":{"tags":["Users"],"summary":"Clear default station","description":"","operationId":"deleteUserStationDefaultstation","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"202":{"description":"Success"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all","telephony:phone:assign"]},"x-purecloud-method-name":"deleteUserStationDefaultstation"}},"/api/v2/users/{userId}/station/associatedstation":{"delete":{"tags":["Users"],"summary":"Clear associated station","description":"","operationId":"deleteUserStationAssociatedstation","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"202":{"description":"Success"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-purecloud-method-name":"deleteUserStationAssociatedstation"}},"/api/v2/users/{userId}/station/associatedstation/{stationId}":{"put":{"tags":["Users"],"summary":"Set associated station","description":"","operationId":"putUserStationAssociatedstationStationId","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"stationId","in":"path","description":"stationId","required":true,"type":"string"}],"responses":{"202":{"description":"Success"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","userservice.station.notfound":"Station is not found"}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"userservice.station.providerlocationmissing":"The location of the station could not be found","userservice.stationalreadyassociated":"Station is already associated","userservice.station.nothomed":"The station is incorrectly or not assigned"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"424":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"externalservice.unexpectedresponsecode":"Unexpected backend response code"}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-purecloud-method-name":"putUserStationAssociatedstationStationId"}},"/api/v2/users/{userId}/station":{"get":{"tags":["Users"],"summary":"Get station information for user","description":"","operationId":"getUserStation","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserStations"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"424":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"externalservice.unexpectedresponsecode":"Unexpected backend response code"}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getUserStation"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/generationresults":{"get":{"tags":["Workforce Management"],"summary":"Gets the forecast generation results","description":"","operationId":"getWorkforcemanagementBusinessunitWeekShorttermforecastGenerationresults","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The business unit ID of the business unit to which the forecast belongs","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"forecastId","in":"path","description":"The ID of the forecast","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuForecastGenerationResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:shortTermForecast:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWeekShorttermforecastGenerationresults"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts":{"get":{"tags":["Workforce Management"],"summary":"Get short term forecasts","description":"Use \"recent\" for the `weekDateId` path parameter to fetch all forecasts for +/- 26 weeks from the current date. Response will include any forecast which spans the specified week","operationId":"getWorkforcemanagementBusinessunitWeekShorttermforecasts","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The business unit ID of the business unit to which the forecast belongs","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The week start date of the forecast in yyyy-MM-dd format or 'recent' to fetch recent forecasts","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuShortTermForecastListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.too.many.requests":"Too many requests in a given amount of time","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:generate","wfm:shortTermForecast:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWeekShorttermforecasts"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/generate":{"post":{"tags":["Workforce Management"],"summary":"Generate a short term forecast","description":"","operationId":"postWorkforcemanagementBusinessunitWeekShorttermforecastsGenerate","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The business unit ID of the business unit to which the forecast belongs","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"forceAsync","in":"query","description":"Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes","required":false,"type":"boolean"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/GenerateBuForecastRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncForecastOperationResult"}},"201":{"description":"The forecast was successfully generated","schema":{"$ref":"#/definitions/AsyncForecastOperationResult"}},"202":{"description":"The request was accepted and the result will be sent asynchronously via notification","schema":{"$ref":"#/definitions/AsyncForecastOperationResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"502":{"description":"Bad Gateway","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.server.error":"WFM Server Error"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:shortTermForecast:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitWeekShorttermforecastsGenerate"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}":{"get":{"tags":["Workforce Management"],"summary":"Get a short term forecast","description":"","operationId":"getWorkforcemanagementBusinessunitWeekShorttermforecast","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The business unit ID of the business unit to which the forecast belongs","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"forecastId","in":"path","description":"The ID of the forecast","required":true,"type":"string"},{"name":"expand","in":"query","required":false,"type":"array","items":{"type":"string","enum":["planningGroups","generationResults"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"planningGroups"},{"name":"generationResults"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuShortTermForecast"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:shortTermForecast:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWeekShorttermforecast"},"delete":{"tags":["Workforce Management"],"summary":"Delete a short term forecast","description":"Must not be tied to any schedules","operationId":"deleteWorkforcemanagementBusinessunitWeekShorttermforecast","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The business unit ID of the business unit to which the forecast belongs","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"forecastId","in":"path","description":"The ID of the forecast","required":true,"type":"string"}],"responses":{"204":{"description":"The forecast was successfully deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:shortTermForecast:delete"]},"x-purecloud-method-name":"deleteWorkforcemanagementBusinessunitWeekShorttermforecast"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/planninggroups":{"get":{"tags":["Workforce Management"],"summary":"Gets the forecast planning group snapshot","description":"","operationId":"getWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroups","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The business unit ID of the business unit to which the forecast belongs","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"forecastId","in":"path","description":"The ID of the forecast","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ForecastPlanningGroupsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:shortTermForecast:view","wfm:schedule:view","wfm:publishedSchedule:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroups"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/data":{"get":{"tags":["Workforce Management"],"summary":"Get the result of a short term forecast calculation","description":"Includes modifications unless you pass the doNotApplyModifications query parameter","operationId":"getWorkforcemanagementBusinessunitWeekShorttermforecastData","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The business unit ID of the business unit to which the forecast belongs","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"forecastId","in":"path","description":"The ID of the forecast","required":true,"type":"string"},{"name":"weekNumber","in":"query","description":"The week number to fetch (for multi-week forecasts)","required":false,"type":"integer","format":"int32"},{"name":"forceDownloadService","in":"query","description":"Force the result of this operation to be sent via download service. For testing/app development purposes","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuForecastResultResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:shortTermForecast:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWeekShorttermforecastData"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/copy":{"post":{"tags":["Workforce Management"],"summary":"Copy a short term forecast","description":"","operationId":"postWorkforcemanagementBusinessunitWeekShorttermforecastCopy","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The business unit ID of the business unit to which the forecast belongs","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"forecastId","in":"path","description":"The ID of the forecast to copy","required":true,"type":"string"},{"name":"forceAsync","in":"query","description":"Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes","required":false,"type":"boolean"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/CopyBuForecastRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncForecastOperationResult"}},"201":{"description":"The forecast was created","schema":{"$ref":"#/definitions/AsyncForecastOperationResult"}},"202":{"description":"The request was accepted and the result will be sent asynchronously via notification","schema":{"$ref":"#/definitions/AsyncForecastOperationResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:shortTermForecast:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitWeekShorttermforecastCopy"}},"/api/v2/integrations/credentials":{"get":{"tags":["Integrations"],"summary":"List multiple sets of credentials","description":"","operationId":"getIntegrationsCredentials","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CredentialInfoListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-purecloud-method-name":"getIntegrationsCredentials"},"post":{"tags":["Integrations"],"summary":"Create a set of credentials","description":"","operationId":"postIntegrationsCredentials","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Credential","required":false,"schema":{"$ref":"#/definitions/Credential"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CredentialInfo"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-purecloud-method-name":"postIntegrationsCredentials"}},"/api/v2/uploads/workforcemanagement/historicaldata/json":{"post":{"tags":["Uploads"],"summary":"Creates presigned url for uploading WFM historical data file. Requires data in json format.","description":"","operationId":"postUploadsWorkforcemanagementHistoricaldataJson","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/UploadUrlRequest"}}],"responses":{"200":{"description":"Presigned url successfully created.","schema":{"$ref":"#/definitions/UploadUrlResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["upload"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["wfm:historicalData:upload"]},"x-purecloud-method-name":"postUploadsWorkforcemanagementHistoricaldataJson"}},"/api/v2/uploads/workforcemanagement/historicaldata/csv":{"post":{"tags":["Uploads"],"summary":"Creates presigned url for uploading WFM historical data file. Requires data in csv format.","description":"","operationId":"postUploadsWorkforcemanagementHistoricaldataCsv","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/UploadUrlRequest"}}],"responses":{"200":{"description":"Presigned url successfully created.","schema":{"$ref":"#/definitions/UploadUrlResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["upload"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["wfm:historicalData:upload"]},"x-purecloud-method-name":"postUploadsWorkforcemanagementHistoricaldataCsv"}},"/api/v2/telephony/providers/edges/logicalinterfaces":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get edge logical interfaces.","description":"Retrieve the configured logical interfaces for a list edges. Only 100 edges can be requested at a time.","operationId":"getTelephonyProvidersEdgesLogicalinterfaces","produces":["application/json"],"parameters":[{"name":"edgeIds","in":"query","description":"Comma separated list of Edge Id's","required":true,"type":"string"},{"name":"expand","in":"query","description":"Field to expand in the response","required":false,"type":"array","items":{"type":"string","enum":["externalTrunkBaseAssignments","phoneTrunkBaseAssignments"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"externalTrunkBaseAssignments"},{"name":"phoneTrunkBaseAssignments"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LogicalInterfaceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesLogicalinterfaces"}},"/api/v2/externalcontacts/conversations/{conversationId}":{"put":{"tags":["External Contacts"],"summary":"Associate/disassociate an external contact with a conversation","description":"To associate, supply a value for the externalContactId. To disassociate, do not include the property at all.","operationId":"putExternalcontactsConversation","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ConversationAssociation","required":true,"schema":{"$ref":"#/definitions/ConversationAssociation"}},{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"}],"responses":{"202":{"description":"Accepted - Processing association"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The JSON body of the request was not valid.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","eternal.contacts.invalid.entity.id":"The entity ID was invalid.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","conversation.association.communication.id.required":"The communication id is required"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"External contact is not found by conversation id.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:conversation:associate"]},"x-purecloud-method-name":"putExternalcontactsConversation"}},"/api/v2/authorization/divisionspermitted/paged/{subjectId}":{"get":{"tags":["Authorization","Users"],"summary":"Returns which divisions the specified user has the given permission in.","description":"This route is deprecated, use authorization/divisionspermitted/paged/me instead.","operationId":"getAuthorizationDivisionspermittedPagedSubjectId","produces":["application/json"],"parameters":[{"name":"subjectId","in":"path","description":"Subject ID (user or group)","required":true,"type":"string"},{"name":"permission","in":"query","description":"The permission string, including the object to access, e.g. routing:queue:view","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DivsPermittedEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","missing.permission.param":"Missing required permission parameter","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getAuthorizationDivisionspermittedPagedSubjectId"}},"/api/v2/routing/queues/divisionviews":{"get":{"tags":["Routing"],"summary":"Get a paged listing of simplified queue objects, filterable by name, queue ID(s), or division ID(s).","description":"","operationId":"getRoutingQueuesDivisionviews","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size [max value is 100]","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number [max value is 5]","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name","enum":["name","id","divisionId"],"x-genesys-enum-members":[{"name":"name"},{"name":"id"},{"name":"divisionId"}]},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc","enum":["asc","desc","score"],"x-genesys-enum-members":[{"name":"asc"},{"name":"desc"},{"name":"score"}]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"id","in":"query","description":"Queue ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"divisionId","in":"query","description":"Division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"Internal server error getting paged listing of queue objects."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:queue:search"]},"x-purecloud-method-name":"getRoutingQueuesDivisionviews"}},"/api/v2/scim/resourcetypes/{resourceType}":{"get":{"tags":["SCIM"],"summary":"Get a resource type","description":"","operationId":"getScimResourcetype","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"name":"resourceType","in":"path","description":"The type of resource. Returned with GET /api/v2/scim/resourcetypes.","required":true,"type":"string","enum":["User","Group","ServiceProviderConfig","ResourceType","Schema"],"x-genesys-enum-members":[{"name":"User"},{"name":"Group"},{"name":"ServiceProviderConfig"},{"name":"ResourceType"},{"name":"Schema"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimConfigResourceType"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimResourcetype"}},"/api/v2/scim/resourcetypes":{"get":{"tags":["SCIM"],"summary":"Get a list of resource types","description":"","operationId":"getScimResourcetypes","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimConfigResourceTypesListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimResourcetypes"}},"/api/v2/telephony/providers/edges/phones/{phoneId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Phone by ID","description":"","operationId":"getTelephonyProvidersEdgesPhone","produces":["application/json"],"parameters":[{"name":"phoneId","in":"path","description":"Phone ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Phone"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"Request is badly formed.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find the phone with that Id.","not.found":"The requested resource was not found."}},"408":{"description":"Request Timeout","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unknown":"Unspecified error find phone with that Id."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.rate.limit":"Request rate limit exceeded.","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesPhone"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a Phone by ID","description":"","operationId":"putTelephonyProvidersEdgesPhone","produces":["application/json"],"parameters":[{"name":"phoneId","in":"path","description":"Phone ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Phone","required":true,"schema":{"$ref":"#/definitions/Phone"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Phone"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","webrtc.user.required":"A webRtcUser is required.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to update Phone with that id.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesPhone"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a Phone by ID","description":"","operationId":"deleteTelephonyProvidersEdgesPhone","produces":["application/json"],"parameters":[{"name":"phoneId","in":"path","description":"Phone ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","general.bad.request":"The request could not be understood by the server due to malformed syntax."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to delete Phone with that id.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdgesPhone"}},"/api/v2/identityproviders/cic":{"get":{"tags":["Identity Provider"],"summary":"Get Customer Interaction Center (CIC) Identity Provider","description":"","operationId":"getIdentityprovidersCic","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CustomerInteractionCenter"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersCic"},"put":{"tags":["Identity Provider"],"summary":"Update/Create Customer Interaction Center (CIC) Identity Provider","description":"","operationId":"putIdentityprovidersCic","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/CustomerInteractionCenter"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.issuer.uri":"An issuer URI is required.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.target.url":"The target URL must be a valid HTTPS URL.","certificate.not.yet.valid":"The certificate is not yet valid.","certificate.invalid.base64":"Invalid base64 in certificate.","certificate.unparseable":"The certificate for provider cannot be parsed.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersCic"},"delete":{"tags":["Identity Provider"],"summary":"Delete Customer Interaction Center (CIC) Identity Provider","description":"","operationId":"deleteIdentityprovidersCic","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersCic"}},"/api/v2/identityproviders/onelogin":{"get":{"tags":["Identity Provider"],"summary":"Get OneLogin Identity Provider","description":"","operationId":"getIdentityprovidersOnelogin","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OneLogin"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersOnelogin"},"put":{"tags":["Identity Provider"],"summary":"Update/Create OneLogin Identity Provider","description":"","operationId":"putIdentityprovidersOnelogin","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/OneLogin"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.issuer.uri":"An issuer URI is required.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.target.url":"The target URL must be a valid HTTPS URL.","certificate.not.yet.valid":"The certificate is not yet valid.","certificate.invalid.base64":"Invalid base64 in certificate.","certificate.unparseable":"The certificate for provider cannot be parsed.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersOnelogin"},"delete":{"tags":["Identity Provider"],"summary":"Delete OneLogin Identity Provider","description":"","operationId":"deleteIdentityprovidersOnelogin","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersOnelogin"}},"/api/v2/telephony/providers/edges/{edgeId}/logs/jobs":{"post":{"tags":["Telephony Providers Edge"],"summary":"Create a job to upload a list of Edge logs.","description":"","operationId":"postTelephonyProvidersEdgeLogsJobs","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"in":"body","name":"body","description":"EdgeLogsJobRequest","required":true,"schema":{"$ref":"#/definitions/EdgeLogsJobRequest"}}],"responses":{"202":{"description":"Accepted - Job is being processed. The job ID is returned.","schema":{"$ref":"#/definitions/EdgeLogsJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgeLogsJobs"}},"/api/v2/groups/{groupId}/individuals":{"get":{"tags":["Groups"],"summary":"Get all individuals associated with the group","description":"","operationId":"getGroupIndividuals","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups","groups:readonly"]}],"x-purecloud-method-name":"getGroupIndividuals"}},"/api/v2/languageunderstanding/domains/{domainId}/feedback":{"get":{"tags":["Language Understanding"],"summary":"Get all feedback in the given NLU Domain Version.","description":"","operationId":"getLanguageunderstandingDomainFeedback","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"intentName","in":"query","description":"The top intent name to retrieve feedback for.","required":false,"type":"string"},{"name":"assessment","in":"query","description":"The top assessment to retrieve feedback for.","required":false,"type":"string","enum":["Incorrect","Correct","Unknown","Disabled"],"x-genesys-enum-members":[{"name":"Incorrect"},{"name":"Correct"},{"name":"Unknown"},{"name":"Disabled"}]},{"name":"dateStart","in":"query","description":"Begin of time window as ISO-8601 date.","required":false,"type":"string","format":"date"},{"name":"dateEnd","in":"query","description":"End of time window as ISO-8601 date.","required":false,"type":"string","format":"date"},{"name":"includeDeleted","in":"query","description":"Whether to include soft-deleted items in the result.","required":false,"type":"boolean"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"enableCursorPagination","in":"query","description":"Enable Cursor Pagination","required":false,"type":"boolean","default":false},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned. This is considered only when enableCursorPagination=true","required":false,"type":"string"},{"name":"fields","in":"query","description":"Fields and properties to get, comma-separated","required":false,"type":"array","items":{"type":"string","enum":["version","dateCreated","text","intents"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"version"},{"name":"dateCreated"},{"name":"text"},{"name":"intents"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluFeedbackListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","dialog:readonly","language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:feedback:view","dialog:bot:view"]},"x-purecloud-method-name":"getLanguageunderstandingDomainFeedback"},"post":{"tags":["Language Understanding"],"summary":"Create feedback for the NLU Domain Version.","description":"","operationId":"postLanguageunderstandingDomainFeedback","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"in":"body","name":"body","description":"The Feedback to create.","required":true,"schema":{"$ref":"#/definitions/NluFeedbackRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluFeedbackResponse"}},"201":{"description":"Feedback created successfully","schema":{"$ref":"#/definitions/NluFeedbackResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","language-understanding"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:feedback:add","dialog:bot:add"]},"x-purecloud-method-name":"postLanguageunderstandingDomainFeedback"}},"/api/v2/outbound/campaigns/{campaignId}/diagnostics":{"get":{"tags":["Outbound"],"summary":"Get campaign diagnostics","description":"","operationId":"getOutboundCampaignDiagnostics","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignDiagnostics"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The dialer campaign was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:view"]},"x-purecloud-method-name":"getOutboundCampaignDiagnostics"}},"/api/v2/outbound/campaigns/{campaignId}/progress":{"get":{"tags":["Outbound"],"summary":"Get campaign progress","description":"","operationId":"getOutboundCampaignProgress","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignProgress"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The dialer campaign was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:view"]},"x-purecloud-method-name":"getOutboundCampaignProgress"},"delete":{"tags":["Outbound"],"summary":"Reset campaign progress and recycle the campaign","description":"","operationId":"deleteOutboundCampaignProgress","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"202":{"description":"Accepted - the campaign will be recycled momentarily"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The dialer campaign was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","too.many.recycles":"A campaign can only be recycled once every 5 seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:edit"]},"x-purecloud-method-name":"deleteOutboundCampaignProgress"}},"/api/v2/outbound/campaigns/{campaignId}":{"get":{"tags":["Outbound"],"summary":"Get dialer campaign.","description":"","operationId":"getOutboundCampaign","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Campaign"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:view"]},"x-purecloud-method-name":"getOutboundCampaign"},"put":{"tags":["Outbound"],"summary":"Update a campaign.","description":"","operationId":"putOutboundCampaign","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Campaign","required":true,"schema":{"$ref":"#/definitions/Campaign"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Campaign"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.priority":"The priority must be between 1 and 5 (inclusive)","name.length.exceeded":"The name length exceeds the limit of 64 characters.","too.many.queue.members":"The limit for number of queue members on a campaign configured for agent owned records has been exceeded. See details.","duplicate.name":"The name already exists.","site.has.no.active.edges":"There are no active edges in the site","edge.group.not.found":"The edge group could not be found.","too.many.data.action.conditions":"There can be a maximum of 1 data action condition across all rule sets referenced by this campaign","contact.sorts.duplicate.field.names":"The same column name is used in separate contact sorts entries.","invalid.update":"","more.than.one.contact.list.filter":"Only one contact list filter is allowed per campaign.","managed.site.cannot.be.configured":"Managed Sites cannot be configured on a campaign.","invalid.campaign.preview.timeout.seconds":"The preview timeout seconds must be between 0 and 1200 (inclusive)","resources.in.use":"Resources are already in use.","invalid.update.bad.status.transition":"The status transition is invalid.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","contact.list.filter.not.found":"The contact list filter could not be found.","dnc.list.not.found":"A do not call list could not be found.","missing.caller.id.address":"No caller id address supplied","agent.owned.column.cannot.be.changed":"The agent owned column cannot be changed.","rule.set.not.found":"A rule set could not be found.","managed.edge.group.cannot.be.configured":"Managed Edge Groups cannot be configured on a campaign.","property.not.allowed.for.external.calling":"The following properties are not allowed to be configured on an external campaign: abandonRate, edgeGroup, site, callAnalysisResponseSet, callerName, callerAddress, outboundLineCount, ruleSets, previewTimeOutSeconds, noAnswerTimeout, and callAnalysisResponseSet.","invalid.campaign.phone.columns":"The campaign phone columns are invalid.","contact.sorts.conflict":"The contact sort and contact sorts fields have conflicting values.","invalid.update.campaign.active":"The campaign is already active","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","site.not.found":"The site could not be found","queue.not.found":"The queue could not be found.","no.edge.group.for.site":"No edge group was found for the site","name.cannot.be.blank":"A name must be provided.","invalid.campaign.outbound.line.count":"","bad.request":"The request could not be understood by the server due to malformed syntax.","callable.time.set.not.found":"The callable time set could not be found.","missing.caller.id.name":"No caller id name supplied","contact.list.filter.does.not.match.contact.list":"The contact list on the contact list filter does not match the contact list on the campaign.","call.analysis.response.set.not.found":"The call analysis response set could not be found.","agent.owned.queue.cannot.be.changed":"The queue cannot be changed on a campaign configured for agent owned records.","script.not.found":"The script could not be found.","site.and.edge.group.cannot.be.configured":"A single campaign cannot have both a site and an edge group configured","contact.sort.field.not.found":"The contact sort field is not a column on the contact list.","invalid.campaign.agent.owned.column":"The campaign agent owned column is not a valid contact list column.","contact.sorts.invalid.field.name":"A contact sorts field name is not a valid column name in the campaign's contact list.","external.calling.property.not.allowed":"Some properties cannot be set on an external calling campaign. See details","edge.group.has.no.active.edges":"There are no active edges in the edge group","invalid.call.analysis.response.set.for.agentless.campaign":"The call analysis response set is invalid for agentless campaigns.","invalid.ani.address":"The caller id number is invalid.","name.required":"A name must be provided.","callable.time.set.conflicts.with.automatic.time.zone.mapping":"A callable time set cannot be included on the campaign when the campaign's contact list uses automatic time zone mapping.","active.campaigns.limit.exceeded":"The maximum number of active campaigns has been reached. Please turn off at least one campaign and wait for it to stop before starting another one.","edge.group.is.empty":"There are no edges in the edge group","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","missing.time.zone.in.contactlist":"When using a callable time set, the contact list must have at least one time zone column defined.","invalid.dialing.mode.update":"Invalid dialing mode","site.is.empty":"There are no edges in the site","contact.list.import.in.progress":"The contact list on the camapign is still importing contacts."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","all.campaigns.black.listed":"This organization has been blacklisted from starting campaigns. Please contact support.","campaign.black.listed":"This campaign has been blacklisted. Please contact support."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"409":{"description":"Conflict.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.campaign.active":"The campaign is already active.","invalid.update.wrong.version":""}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:edit"]},"x-purecloud-method-name":"putOutboundCampaign"},"delete":{"tags":["Outbound"],"summary":"Delete a campaign.","description":"","operationId":"deleteOutboundCampaign","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Campaign"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","referential.integrity.error":"Could not delete the resource because it is referenced by another entity.","campaign.in.use":"The campaign is in use."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:delete"]},"x-purecloud-method-name":"deleteOutboundCampaign"}},"/api/v2/externalcontacts/organizations/schemas/{schemaId}/versions":{"get":{"tags":["External Contacts"],"summary":"Get all versions of an external organization's schema","description":"","operationId":"getExternalcontactsOrganizationsSchemaVersions","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"The schema to expand has parse errors"}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getExternalcontactsOrganizationsSchemaVersions"}},"/api/v2/telephony/providers/edges/trunkbasesettings":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get Trunk Base Settings listing","description":"Managed properties will not be returned unless the user is assigned the internal:trunk:edit permission.","operationId":"getTelephonyProvidersEdgesTrunkbasesettings","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Value by which to sort","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"recordingEnabled","in":"query","description":"Filter trunks by recording enabled","required":false,"type":"boolean"},{"name":"ignoreHidden","in":"query","description":"Set this to true to not receive trunk properties that are meant to be hidden or for internal system usage only.","required":false,"type":"boolean"},{"name":"managed","in":"query","description":"Filter by managed","required":false,"type":"boolean"},{"name":"expand","in":"query","description":"Fields to expand in the response, comma-separated","required":false,"type":"array","items":{"type":"string","enum":["properties"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"properties"}]},{"name":"name","in":"query","description":"Name of the TrunkBase to filter by","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkBaseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.resource.not.found":"Trunk base settings not found","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesTrunkbasesettings"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a Trunk Base Settings object","description":"","operationId":"postTelephonyProvidersEdgesTrunkbasesettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Trunk base settings","required":true,"schema":{"$ref":"#/definitions/TrunkBase"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"required.field.missing":"A required field is missing a value.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","trunk.metabase.required":"A metabase is required for this function.","duplicate.value":"A trunk with that name already exists.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","general.access.denied":"The requested action is forbidden.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be made due to conflict with the server resources"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesTrunkbasesettings"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/shifttrades/users":{"get":{"tags":["Workforce Management"],"summary":"Gets list of users available for whom you can send direct shift trade requests","description":"","operationId":"getWorkforcemanagementManagementunitShifttradesUsers","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WfmUserEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentShiftTradeRequest:participate"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitShifttradesUsers"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/shifttrades/matched":{"get":{"tags":["Workforce Management"],"summary":"Gets a summary of all shift trades in the matched state","description":"","operationId":"getWorkforcemanagementManagementunitShifttradesMatched","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ShiftTradeMatchesSummaryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:shiftTradeRequest:view","wfm:shiftTradeRequest:edit"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitShifttradesMatched"}},"/api/v2/identityproviders/generic":{"get":{"tags":["Identity Provider"],"summary":"Get Generic SAML Identity Provider","description":"","operationId":"getIdentityprovidersGeneric","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GenericSAML"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersGeneric"},"put":{"tags":["Identity Provider"],"summary":"Update/Create Generic SAML Identity Provider","description":"","operationId":"putIdentityprovidersGeneric","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/GenericSAML"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.provider.name":"The name for a generic SAML provider cannot be blank or empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","provider.logo.too.large":"The logo image size is greater than allowed value of 25kb.","invalid.target.url":"The target URL must be a valid HTTPS URL.","certificate.unparseable":"The certificate for provider cannot be parsed.","missing.issuer.uri":"An issuer URI is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","certificate.not.yet.valid":"The certificate is not yet valid.","invalid.nameid.format":"The name identifier format is invalid.","certificate.invalid.base64":"Invalid base64 in certificate.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersGeneric"},"delete":{"tags":["Identity Provider"],"summary":"Delete Generic SAML Identity Provider","description":"","operationId":"deleteIdentityprovidersGeneric","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersGeneric"}},"/api/v2/conversations/calls":{"get":{"tags":["Conversations"],"summary":"Get active call conversations for the logged in user","description":"","operationId":"getConversationsCalls","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallConversationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCalls"},"post":{"tags":["Conversations"],"summary":"Create a call conversation","description":"","operationId":"postConversationsCalls","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Call request","required":true,"schema":{"$ref":"#/definitions/CreateCallRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CreateCallResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.no.user.station":"A station is required to place a call.","too.many.create.conversation.parameters":"Only a single destination can be supplied in a create conversation request.","conversation.error.cannot.create.conference":"Unable to create a conference.","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","missing.create.conversation.destination.parameter":"At least one destination should be supplied in a create conversation request.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"providerapi.error.station.cannot.resolve":"Cannot resolve station.","providerapi.error.user.does.not.have.a.station":"User does not have a station.","conversation.error.media.failed":"The media request failed.","providerapi.error.edge.cannot.resolve":"Cannot resolve edge.","providerapi.error.ccxml.uri.not_found":"Failed to get CCXML URI from edge config.","providerapi.error.edge.no.active":"Could not find an active Edge in Site.","providerapi.error.phone.cannot.resolve":"Cannot resolve phone.","providerapi.error.phone.no.active.edge":"The phone is not assigned to active Edges."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"providerapi.error.station.no.active.edge":"Unable to place call. Could not find an Edge for this station.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","providerapi.error.no.station.for.edge":"Station assignment for station found, but no primary or secondary Edge id was assigned to it."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:conference:add"]},"x-purecloud-method-name":"postConversationsCalls"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/wrapupcodes":{"get":{"tags":["Conversations"],"summary":"Get list of wrapup codes for this conversation participant","description":"","operationId":"getConversationsCallParticipantWrapupcodes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCallParticipantWrapupcodes"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult":{"post":{"tags":["Conversations"],"summary":"Initiate and update consult transfer","description":"","operationId":"postConversationsCallParticipantConsult","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Destination address & initial speak to","required":true,"schema":{"$ref":"#/definitions/ConsultTransfer"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConsultTransferResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.consult.transfer.no.initiator":"The transfer request has no initiator.","conversation.error.cannot.transfer.to.self":"A user cannot transfer a call to their own number","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","conversation.error.cannot.transfer.conference":"Performing a consult transfer on a conference is not allowed.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","not.a.participant":"You are not a connected participant on the call","object.participant.id.required":"A connected object participant is required.","dest.address.not.specified":"The destination address was not specified.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","conversation.error.consult.transfer.no.destination":"The transfer request has no destination."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation.","conversation.error.consult.transfer.pending.not.found":"The pending consult transfer does not exist."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationsCallParticipantConsult"},"delete":{"tags":["Conversations"],"summary":"Cancel the transfer","description":"","operationId":"deleteConversationsCallParticipantConsult","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","conversation.error.consult.transfer.not.started":"The consult transfer can't be canceled since it hasn't started yet."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","conversation.error.consult.transfer.pending.not.found":"The pending consult transfer does not exist."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"deleteConversationsCallParticipantConsult"},"patch":{"tags":["Conversations"],"summary":"Change who can speak","description":"","operationId":"patchConversationsCallParticipantConsult","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"new speak to","required":true,"schema":{"$ref":"#/definitions/ConsultTransferUpdate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConsultTransferResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.cannot.transfer.to.self":"A user cannot transfer a call to their own number","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","not.a.participant":"You are not a connected participant on the call","object.participant.id.required":"A connected object participant is required.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","conversation.error.participant.no.active.conversations":"Participant has no active conversations"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","conversation.error.consult.transfer.pending.not.found":"The pending consult transfer does not exist."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsCallParticipantConsult"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/monitor":{"post":{"tags":["Conversations"],"summary":"Listen in on the conversation from the point of view of a given participant.","description":"","operationId":"postConversationsCallParticipantMonitor","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"}],"responses":{"201":{"description":"Created"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.monitor.own.conversation":"A user cannot monitor a conversation where they are an active participant.","conversation.error.no.user.station":"A station is required to place a call.","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:call:monitor"]},"x-purecloud-method-name":"postConversationsCallParticipantMonitor"}},"/api/v2/conversations/calls/history":{"get":{"tags":["Conversations"],"summary":"Get call history","description":"","operationId":"getConversationsCallsHistory","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size, maximum 50","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"interval","in":"query","description":"Interval string; format is ISO-8601. Separate start and end times with forward slash '/'","required":false,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["externalorganization","externalcontact","user","queue","group"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"externalorganization"},{"name":"externalcontact"},{"name":"user"},{"name":"queue"},{"name":"group"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallHistoryConversationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCallsHistory"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/attributes":{"patch":{"tags":["Conversations"],"summary":"Update the attributes on a conversation participant.","description":"","operationId":"patchConversationsCallParticipantAttributes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant attributes","required":true,"schema":{"$ref":"#/definitions/ParticipantAttributes"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsCallParticipantAttributes"}},"/api/v2/conversations/calls/{conversationId}":{"get":{"tags":["Conversations"],"summary":"Get call conversation","description":"","operationId":"getConversationsCall","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.no.common.user":"This conference can not be created because there is no common user among all the active participants.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.media.failed":"The media request failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","providerapi.error.no.station.for.edge":"Station assignment for station found, but no primary or secondary Edge id was assigned to it."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCall"},"post":{"tags":["Conversations"],"summary":"Place a new call as part of a callback conversation.","description":"","operationId":"postConversationsCall","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation","required":true,"schema":{"$ref":"#/definitions/CallCommand"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Conversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.no.user.station":"A station is required to place a call.","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","conversation.error.callback.call.cannot.be.placed":"An error occurred while trying to place the callback.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","conversation.error.participant.no.active.conversations":"The participant has no active conversation."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"providerapi.error.station.no.active.edge":"Unable to place call. Could not find an Edge for this station.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","providerapi.error.no.station.for.edge":"Station assignment for station found, but no primary or secondary Edge id was assigned to it."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationsCall"},"patch":{"tags":["Conversations"],"summary":"Update a conversation by setting it's recording state, merging in other conversations to create a conference, or disconnecting all of the participants","description":"","operationId":"patchConversationsCall","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation","required":true,"schema":{"$ref":"#/definitions/Conversation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Conversation"}},"202":{"description":"Accepted - when pausing or resuming recordings (Secure Pause)","schema":{"$ref":"#/definitions/Conversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.empty.conversation.list":"An empty list of conversations is invalid.","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","conversation.error.cannot.merge.alerting.conference":"A conference cannot be created from an alerting call.","conversation.error.call.disconnected":"Call is disconnected, cannot alter recordingState","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:disconnect"]},"x-purecloud-method-name":"patchConversationsCall"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation participant. ","description":"","operationId":"getConversationsCallParticipantWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCallParticipantWrapup"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/coach":{"post":{"tags":["Conversations"],"summary":"Listen in on the conversation from the point of view of a given participant while speaking to just the given participant.","description":"","operationId":"postConversationsCallParticipantCoach","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"}],"responses":{"201":{"description":"Created"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.no.user.station":"A station is required to place a call.","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:call:coach"]},"x-purecloud-method-name":"postConversationsCallParticipantCoach"}},"/api/v2/conversations/calls/maximumconferenceparties":{"get":{"tags":["Conversations"],"summary":"Get the maximum number of participants that this user can have on a conference","description":"","operationId":"getConversationsCallsMaximumconferenceparties","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MaxParticipants"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCallsMaximumconferenceparties"}},"/api/v2/conversations/calls/{conversationId}/participants":{"post":{"tags":["Conversations"],"summary":"Add participants to a conversation","description":"","operationId":"postConversationsCallParticipants","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation","required":true,"schema":{"$ref":"#/definitions/Conversation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Conversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","conversation.error.cannot.merge.alerting.conference":"A conference cannot be created from an alerting call.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"providerapi.error.station.no.active.edge":"Unable to place call. Could not find an Edge for this station.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationsCallParticipants"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}/uuidata":{"put":{"tags":["Conversations"],"summary":"Set uuiData to be sent on future commands.","description":"","operationId":"putConversationsCallParticipantCommunicationUuidata","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"UUIData Request","required":true,"schema":{"$ref":"#/definitions/SetUuiDataRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"204":{"description":"UuiData Applied"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"putConversationsCallParticipantCommunicationUuidata"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant's communication by disconnecting it.","description":"","operationId":"patchConversationsCallParticipantCommunication","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","communication.state.required":"Can only update a communication's state to disconnected.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsCallParticipantCommunication"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant","description":"","operationId":"patchConversationsCallParticipant","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant request","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","conversation.error.call.disconnected":"The call is already disconnected.","conversation.error.user.not.party":"The participant for this request does not belong to the user making the request.","conversation.error.wrapup.cannot.skip":"Wrap-up cannot be skipped for this participant.","conversation.error.participant.no.active.conversations":"The participant has no active conversation.","conversation.error.hold.alerting":"An alerting call cannot be placed on hold.","conversation.error.cannot.create.conference":"Unable to create a conference.","conversation.participant.update.invalid":"Failed to update all properties on conversation participant.","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","callback.error.answer.not.alerting":"Only alerting calls can be answered.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","conversation.error.cannot.confine.party":"The participant for this request cannot be confined.","conversation.error.wrapup.code.required":"Wrapup code is a required field and cannot be empty.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"Conversation not found.","not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.participant.update.failed":"Failed to update all properties on conversation participant.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsCallParticipant"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/replace":{"post":{"tags":["Conversations"],"summary":"Replace this participant with the specified user and/or address","description":"","operationId":"postConversationsCallParticipantReplace","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Transfer request","required":true,"schema":{"$ref":"#/definitions/TransferRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversations.error.transfer.same.party":"The target of the transfer cannot be the same as the destination.","conversations.error.transfer.acd.call.unattended":"An ACD call cannot be transferred unattended.","callback.error.user.id.queue.id":"In destination, exactly one of userId or queueId is required.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","conversations.error.queue.not.found":"Interaction cannot be transferred to a queue that does not exist.","conversations.error.transfer.not.connected":"You can only transfer conversations that are in the connected state.","conversations.error.transfer.usercall.voicemail":"Only personal calls can be transferred to voicemail.","callback.error.transfer.not.connected":"Only connected participants can be transferred.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationsCallParticipantReplace"}},"/api/v2/architect/dependencytracking":{"get":{"tags":["Architect"],"summary":"Get Dependency Tracking objects that have a given display name","description":"","operationId":"getArchitectDependencytracking","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"name","in":"query","description":"Object name to search for","required":true,"type":"string"},{"name":"objectType","in":"query","description":"Object type(s) to search for","required":false,"type":"array","items":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","BOTCONNECTORBOT","BOTCONNECTORBOTVERSION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GROUP","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","IVRCONFIGURATION","LANGUAGE","LEXBOT","LEXBOTALIAS","NLUDOMAIN","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","WIDGET","WORKFLOW"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"ACDLANGUAGE"},{"name":"ACDSKILL"},{"name":"ACDWRAPUPCODE"},{"name":"BOTCONNECTORBOT"},{"name":"BOTCONNECTORBOTVERSION"},{"name":"BOTFLOW"},{"name":"BRIDGEACTION"},{"name":"COMMONMODULEFLOW"},{"name":"COMPOSERSCRIPT"},{"name":"CONTACTLIST"},{"name":"DATAACTION"},{"name":"DATATABLE"},{"name":"DIALOGENGINEBOT"},{"name":"DIALOGENGINEBOTVERSION"},{"name":"DIALOGFLOWAGENT"},{"name":"EMAILROUTE"},{"name":"EMERGENCYGROUP"},{"name":"FLOWACTION"},{"name":"FLOWDATATYPE"},{"name":"FLOWMILESTONE"},{"name":"FLOWOUTCOME"},{"name":"GROUP"},{"name":"INBOUNDCALLFLOW"},{"name":"INBOUNDCHATFLOW"},{"name":"INBOUNDEMAILFLOW"},{"name":"INBOUNDSHORTMESSAGEFLOW"},{"name":"INQUEUECALLFLOW"},{"name":"IVRCONFIGURATION"},{"name":"LANGUAGE"},{"name":"LEXBOT"},{"name":"LEXBOTALIAS"},{"name":"NLUDOMAIN"},{"name":"OUTBOUNDCALLFLOW"},{"name":"QUEUE"},{"name":"RECORDINGPOLICY"},{"name":"RESPONSE"},{"name":"SCHEDULE"},{"name":"SCHEDULEGROUP"},{"name":"SECUREACTION"},{"name":"SECURECALLFLOW"},{"name":"SURVEYINVITEFLOW"},{"name":"SYSTEMPROMPT"},{"name":"TTSENGINE"},{"name":"TTSVOICE"},{"name":"USER"},{"name":"USERPROMPT"},{"name":"WIDGET"},{"name":"WORKFLOW"}]},{"name":"consumedResources","in":"query","description":"Include resources each result item consumes","required":false,"type":"boolean"},{"name":"consumingResources","in":"query","description":"Include resources that consume each result item","required":false,"type":"boolean"},{"name":"consumedResourceType","in":"query","description":"Types of consumed resources to return, if consumed resources are requested","required":false,"type":"array","items":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","BOTCONNECTORBOT","BOTCONNECTORBOTVERSION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GROUP","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","IVRCONFIGURATION","LANGUAGE","LEXBOT","LEXBOTALIAS","NLUDOMAIN","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","WIDGET","WORKFLOW"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"ACDLANGUAGE"},{"name":"ACDSKILL"},{"name":"ACDWRAPUPCODE"},{"name":"BOTCONNECTORBOT"},{"name":"BOTCONNECTORBOTVERSION"},{"name":"BOTFLOW"},{"name":"BRIDGEACTION"},{"name":"COMMONMODULEFLOW"},{"name":"COMPOSERSCRIPT"},{"name":"CONTACTLIST"},{"name":"DATAACTION"},{"name":"DATATABLE"},{"name":"DIALOGENGINEBOT"},{"name":"DIALOGENGINEBOTVERSION"},{"name":"DIALOGFLOWAGENT"},{"name":"EMAILROUTE"},{"name":"EMERGENCYGROUP"},{"name":"FLOWACTION"},{"name":"FLOWDATATYPE"},{"name":"FLOWMILESTONE"},{"name":"FLOWOUTCOME"},{"name":"GROUP"},{"name":"INBOUNDCALLFLOW"},{"name":"INBOUNDCHATFLOW"},{"name":"INBOUNDEMAILFLOW"},{"name":"INBOUNDSHORTMESSAGEFLOW"},{"name":"INQUEUECALLFLOW"},{"name":"IVRCONFIGURATION"},{"name":"LANGUAGE"},{"name":"LEXBOT"},{"name":"LEXBOTALIAS"},{"name":"NLUDOMAIN"},{"name":"OUTBOUNDCALLFLOW"},{"name":"QUEUE"},{"name":"RECORDINGPOLICY"},{"name":"RESPONSE"},{"name":"SCHEDULE"},{"name":"SCHEDULEGROUP"},{"name":"SECUREACTION"},{"name":"SECURECALLFLOW"},{"name":"SURVEYINVITEFLOW"},{"name":"SYSTEMPROMPT"},{"name":"TTSENGINE"},{"name":"TTSVOICE"},{"name":"USER"},{"name":"USERPROMPT"},{"name":"WIDGET"},{"name":"WORKFLOW"}]},{"name":"consumingResourceType","in":"query","description":"Types of consuming resources to return, if consuming resources are requested","required":false,"type":"array","items":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","BOTCONNECTORBOT","BOTCONNECTORBOTVERSION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GROUP","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","IVRCONFIGURATION","LANGUAGE","LEXBOT","LEXBOTALIAS","NLUDOMAIN","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","WIDGET","WORKFLOW"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"ACDLANGUAGE"},{"name":"ACDSKILL"},{"name":"ACDWRAPUPCODE"},{"name":"BOTCONNECTORBOT"},{"name":"BOTCONNECTORBOTVERSION"},{"name":"BOTFLOW"},{"name":"BRIDGEACTION"},{"name":"COMMONMODULEFLOW"},{"name":"COMPOSERSCRIPT"},{"name":"CONTACTLIST"},{"name":"DATAACTION"},{"name":"DATATABLE"},{"name":"DIALOGENGINEBOT"},{"name":"DIALOGENGINEBOTVERSION"},{"name":"DIALOGFLOWAGENT"},{"name":"EMAILROUTE"},{"name":"EMERGENCYGROUP"},{"name":"FLOWACTION"},{"name":"FLOWDATATYPE"},{"name":"FLOWMILESTONE"},{"name":"FLOWOUTCOME"},{"name":"GROUP"},{"name":"INBOUNDCALLFLOW"},{"name":"INBOUNDCHATFLOW"},{"name":"INBOUNDEMAILFLOW"},{"name":"INBOUNDSHORTMESSAGEFLOW"},{"name":"INQUEUECALLFLOW"},{"name":"IVRCONFIGURATION"},{"name":"LANGUAGE"},{"name":"LEXBOT"},{"name":"LEXBOTALIAS"},{"name":"NLUDOMAIN"},{"name":"OUTBOUNDCALLFLOW"},{"name":"QUEUE"},{"name":"RECORDINGPOLICY"},{"name":"RESPONSE"},{"name":"SCHEDULE"},{"name":"SCHEDULEGROUP"},{"name":"SECUREACTION"},{"name":"SECURECALLFLOW"},{"name":"SURVEYINVITEFLOW"},{"name":"SYSTEMPROMPT"},{"name":"TTSENGINE"},{"name":"TTSVOICE"},{"name":"USER"},{"name":"USERPROMPT"},{"name":"WIDGET"},{"name":"WORKFLOW"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DependencyObjectEntityListing"}},"206":{"description":"Partial Content - the organization's data is being rebuilt or needs to be rebuilt."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","architect.dependency.object.name.not.specified":"A name was not specified for the dependency object search.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","architect.query.parameter.missing":"A required query parameter is missing or empty.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","architect.dependency.object.invalid.type":"An invalid dependency object type was specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","architect.database.throughput.exceeded":"Database too busy. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:dependencyTracking:view"]},"x-purecloud-method-name":"getArchitectDependencytracking"}},"/api/v2/architect/dependencytracking/consumedresources":{"get":{"tags":["Architect"],"summary":"Get resources that are consumed by a given Dependency Tracking object","description":"","operationId":"getArchitectDependencytrackingConsumedresources","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"Consuming object ID","required":true,"type":"string"},{"name":"version","in":"query","description":"Consuming object version","required":true,"type":"string"},{"name":"objectType","in":"query","description":"Consuming object type. Only versioned types are allowed here.","required":true,"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","BOTCONNECTORBOT","BOTCONNECTORBOTVERSION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GROUP","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","IVRCONFIGURATION","LANGUAGE","LEXBOT","LEXBOTALIAS","NLUDOMAIN","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","WIDGET","WORKFLOW"],"x-genesys-enum-members":[{"name":"ACDLANGUAGE"},{"name":"ACDSKILL"},{"name":"ACDWRAPUPCODE"},{"name":"BOTCONNECTORBOT"},{"name":"BOTCONNECTORBOTVERSION"},{"name":"BOTFLOW"},{"name":"BRIDGEACTION"},{"name":"COMMONMODULEFLOW"},{"name":"COMPOSERSCRIPT"},{"name":"CONTACTLIST"},{"name":"DATAACTION"},{"name":"DATATABLE"},{"name":"DIALOGENGINEBOT"},{"name":"DIALOGENGINEBOTVERSION"},{"name":"DIALOGFLOWAGENT"},{"name":"EMAILROUTE"},{"name":"EMERGENCYGROUP"},{"name":"FLOWACTION"},{"name":"FLOWDATATYPE"},{"name":"FLOWMILESTONE"},{"name":"FLOWOUTCOME"},{"name":"GROUP"},{"name":"INBOUNDCALLFLOW"},{"name":"INBOUNDCHATFLOW"},{"name":"INBOUNDEMAILFLOW"},{"name":"INBOUNDSHORTMESSAGEFLOW"},{"name":"INQUEUECALLFLOW"},{"name":"IVRCONFIGURATION"},{"name":"LANGUAGE"},{"name":"LEXBOT"},{"name":"LEXBOTALIAS"},{"name":"NLUDOMAIN"},{"name":"OUTBOUNDCALLFLOW"},{"name":"QUEUE"},{"name":"RECORDINGPOLICY"},{"name":"RESPONSE"},{"name":"SCHEDULE"},{"name":"SCHEDULEGROUP"},{"name":"SECUREACTION"},{"name":"SECURECALLFLOW"},{"name":"SURVEYINVITEFLOW"},{"name":"SYSTEMPROMPT"},{"name":"TTSENGINE"},{"name":"TTSVOICE"},{"name":"USER"},{"name":"USERPROMPT"},{"name":"WIDGET"},{"name":"WORKFLOW"}]},{"name":"resourceType","in":"query","description":"Types of consumed resources to show","required":false,"type":"array","items":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","BOTCONNECTORBOT","BOTCONNECTORBOTVERSION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GROUP","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","IVRCONFIGURATION","LANGUAGE","LEXBOT","LEXBOTALIAS","NLUDOMAIN","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","WIDGET","WORKFLOW"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"ACDLANGUAGE"},{"name":"ACDSKILL"},{"name":"ACDWRAPUPCODE"},{"name":"BOTCONNECTORBOT"},{"name":"BOTCONNECTORBOTVERSION"},{"name":"BOTFLOW"},{"name":"BRIDGEACTION"},{"name":"COMMONMODULEFLOW"},{"name":"COMPOSERSCRIPT"},{"name":"CONTACTLIST"},{"name":"DATAACTION"},{"name":"DATATABLE"},{"name":"DIALOGENGINEBOT"},{"name":"DIALOGENGINEBOTVERSION"},{"name":"DIALOGFLOWAGENT"},{"name":"EMAILROUTE"},{"name":"EMERGENCYGROUP"},{"name":"FLOWACTION"},{"name":"FLOWDATATYPE"},{"name":"FLOWMILESTONE"},{"name":"FLOWOUTCOME"},{"name":"GROUP"},{"name":"INBOUNDCALLFLOW"},{"name":"INBOUNDCHATFLOW"},{"name":"INBOUNDEMAILFLOW"},{"name":"INBOUNDSHORTMESSAGEFLOW"},{"name":"INQUEUECALLFLOW"},{"name":"IVRCONFIGURATION"},{"name":"LANGUAGE"},{"name":"LEXBOT"},{"name":"LEXBOTALIAS"},{"name":"NLUDOMAIN"},{"name":"OUTBOUNDCALLFLOW"},{"name":"QUEUE"},{"name":"RECORDINGPOLICY"},{"name":"RESPONSE"},{"name":"SCHEDULE"},{"name":"SCHEDULEGROUP"},{"name":"SECUREACTION"},{"name":"SECURECALLFLOW"},{"name":"SURVEYINVITEFLOW"},{"name":"SYSTEMPROMPT"},{"name":"TTSENGINE"},{"name":"TTSVOICE"},{"name":"USER"},{"name":"USERPROMPT"},{"name":"WIDGET"},{"name":"WORKFLOW"}]},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConsumedResourcesEntityListing"}},"206":{"description":"Partial Content - the org data is being rebuilt or needs to be rebuilt."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","architect.dependency.object.version.not.specified":"A version was not specified for the dependency object.","architect.query.parameter.missing":"A required query parameter is missing or empty.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","architect.dependency.object.invalid.type":"An invalid dependency object type was specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.version.missing":"Specified flow version is missing.","not.found":"The requested resource was not found.","architect.dependency.object.not.found":"Could not find the dependency object with specified ID and version.","architect.flow.not.found":"Could not find flow with specified ID."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","architect.database.throughput.exceeded":"Database too busy. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:dependencyTracking:view"]},"x-purecloud-method-name":"getArchitectDependencytrackingConsumedresources"}},"/api/v2/flows":{"get":{"tags":["Architect"],"summary":"Get a pageable list of flows, filtered by query parameters","description":"If one or more IDs are specified, the search will fetch flows that match the given ID(s) and not use any additional supplied query parameters in the search.","operationId":"getFlows","produces":["application/json"],"parameters":[{"name":"type","in":"query","description":"Type","required":false,"type":"array","items":{"type":"string","enum":["bot","commonmodule","inboundcall","inboundchat","inboundemail","inboundshortmessage","outboundcall","inqueuecall","speech","securecall","surveyinvite","workflow"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"bot"},{"name":"commonmodule"},{"name":"inboundcall"},{"name":"inboundchat"},{"name":"inboundemail"},{"name":"inboundshortmessage"},{"name":"outboundcall"},{"name":"inqueuecall"},{"name":"speech"},{"name":"securecall"},{"name":"surveyinvite"},{"name":"workflow"}]},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"id"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc"},{"name":"id","in":"query","description":"ID","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"description","in":"query","description":"Description","required":false,"type":"string"},{"name":"nameOrDescription","in":"query","description":"Name or description","required":false,"type":"string"},{"name":"publishVersionId","in":"query","description":"Publish version ID","required":false,"type":"string"},{"name":"editableBy","in":"query","description":"Editable by","required":false,"type":"string"},{"name":"lockedBy","in":"query","description":"Locked by","required":false,"type":"string"},{"name":"lockedByClientId","in":"query","description":"Locked by client ID","required":false,"type":"string"},{"name":"secure","in":"query","description":"Secure","required":false,"type":"string","enum":["any","checkedin","published"],"x-genesys-enum-members":[{"name":"any"},{"name":"checkedin"},{"name":"published"}]},{"name":"deleted","in":"query","description":"Include deleted","required":false,"type":"boolean","default":false},{"name":"includeSchemas","in":"query","description":"Include variable schemas","required":false,"type":"boolean","default":false},{"name":"publishedAfter","in":"query","description":"Published after","required":false,"type":"string","x-example":"2015-01-01T12:00:00-0600, 2015-01-01T18:00:00Z, 2015-01-01T12:00:00.000-0600, 2015-01-01T18:00:00.000Z, 2015-01-01"},{"name":"publishedBefore","in":"query","description":"Published before","required":false,"type":"string","x-example":"2015-01-01T12:00:00-0600, 2015-01-01T18:00:00Z, 2015-01-01T12:00:00.000-0600, 2015-01-01T18:00:00.000Z, 2015-01-01"},{"name":"divisionId","in":"query","description":"division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","architect.invalid.flow.type":"An invalid flow type was specified.","architect.division.invalid":"One or more of the division IDs are not valid.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.inbound.short.message.flow.invalid.operation":"Cannot perform requested operation on an inbound short message flow.","architect.workflow.invalid.operation":"Cannot perform requested operation on a workflow.","architect.speech.flow.invalid.operation":"Cannot perform requested operation on a speech flow.","architect.secure.call.flow.invalid.operation":"Cannot perform requested operation on a secure call flow.","architect.bot.flow.invalid.operation":"Cannot perform requested operation on a bot flow."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:view"]},"x-purecloud-method-name":"getFlows"},"post":{"tags":["Architect"],"summary":"Create flow","description":"","operationId":"postFlows","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Flow"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Flow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","architect.flow.validate.failed.invalid.name.contains.slash":"Failed to validate flow due to invalid name. Flow names must not contain forward slashes.","architect.flow.validate.failed.invalid.name.no.alpha":"Failed to validate flow due to invalid name. Names must contain at least one alphanumeric character.","bad.request":"The request could not be understood by the server due to malformed syntax.","architect.object.validate.failed":"Failed to validate object.","architect.flow.validate.failed.missing.type":"Failed to validate flow due to missing type.","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","architect.flow.validate.failed.invalid.name.contains.debug":"Failed to validate flow due to invalid name. Flow names must not end with '-debug'.","architect.flow.validate.failed":"Failed to validate flow.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","architect.flow.validate.failed.missing.name":"Failed to validate flow due to missing name."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.inbound.short.message.flow.invalid.operation":"Cannot perform requested operation on an inbound short message flow.","architect.workflow.invalid.operation":"Cannot perform requested operation on a workflow.","architect.speech.flow.invalid.operation":"Cannot perform requested operation on a speech flow.","architect.debug.flow.invalid.operation":"Cannot perform requested operation on a debug flow.","architect.secure.call.flow.invalid.operation":"Cannot perform requested operation on a secure call flow.","architect.bot.flow.invalid.operation":"Cannot perform requested operation on a bot flow.","architect.system.flow.cannot.create":"Users cannot create system flows.","architect.secure.call.flow.not.supported":"Secure call flows are not supported by the current product levels.","architect.survey.invite.flow.invalid.operation":"Cannot perform requested operation on a survey flow."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.already.exists":"A flow of the specified type with the specified name already exists."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:add"]},"x-purecloud-method-name":"postFlows"},"delete":{"tags":["Architect"],"summary":"Batch-delete a list of flows","description":"Multiple IDs can be specified, in which case all specified flows will be deleted. Asynchronous. Notification topic: v2.flows.{flowId}","operationId":"deleteFlows","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"List of Flow IDs","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Operation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","architect.batch.too.large":"Batch size exceeds the maximum allowable size.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","architect.batch.delete.failed":"At least one flow could not be deleted as requested.","architect.query.parameter.missing":"A required query parameter is missing or empty."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.operation.already.in.progress":"An operation is already in progress on the object."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.unspecified.error":"An unknown error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:delete"]},"x-purecloud-method-name":"deleteFlows"}},"/api/v2/userrecordings":{"get":{"tags":["User Recordings"],"summary":"Get a list of user recordings.","description":"","operationId":"getUserrecordings","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["conversation"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"conversation"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserRecordingEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"You are not permitted to get a list of user recordings."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["user-recordings","user-recordings:readonly"]}],"x-purecloud-method-name":"getUserrecordings"}},"/api/v2/users/me/password":{"post":{"tags":["Users"],"summary":"Change your password","description":"","operationId":"postUsersMePassword","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Password","required":true,"schema":{"$ref":"#/definitions/ChangeMyPasswordRequest"}}],"responses":{"204":{"description":"Password changed"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.new.password":"The new password does not meet policy requirements.","invalid.password":"The new password does not meet policy requirements or the old password is incorrect.","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.old.password":"The old password is incorrect.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-purecloud-method-name":"postUsersMePassword"}},"/api/v2/integrations/types/{typeId}":{"get":{"tags":["Integrations"],"summary":"Get integration type.","description":"","operationId":"getIntegrationsType","produces":["application/json"],"parameters":[{"name":"typeId","in":"path","description":"Integration Type Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IntegrationType"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-purecloud-method-name":"getIntegrationsType"}},"/api/v2/conversations/chats":{"get":{"tags":["Conversations"],"summary":"Get active chat conversations for the logged in user","description":"","operationId":"getConversationsChats","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatConversationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsChats"},"post":{"tags":["Conversations"],"summary":"Create a web chat conversation","description":"","operationId":"postConversationsChats","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Create web chat request","required":true,"schema":{"$ref":"#/definitions/CreateWebChatRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.notnull.createconversationrequest.provider":"The provider property may not be null.","chat.error.queue.not.found":"The queue does not exist.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","chat.error.notnull.createconversationrequest.queueid":"The queueId property may not be null.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["conversation:webchat:create"]},"x-purecloud-method-name":"postConversationsChats"}},"/api/v2/conversations/chats/{conversationId}/participants/{participantId}/wrapupcodes":{"get":{"tags":["Conversations"],"summary":"Get list of wrapup codes for this conversation participant","description":"","operationId":"getConversationsChatParticipantWrapupcodes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsChatParticipantWrapupcodes"}},"/api/v2/conversations/chats/{conversationId}/participants/{participantId}/attributes":{"patch":{"tags":["Conversations"],"summary":"Update the attributes on a conversation participant.","description":"","operationId":"patchConversationsChatParticipantAttributes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant attributes","required":true,"schema":{"$ref":"#/definitions/ParticipantAttributes"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.participant.not.found":"Participant does not exist.","conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsChatParticipantAttributes"}},"/api/v2/conversations/chats/{conversationId}":{"get":{"tags":["Conversations"],"summary":"Get chat conversation","description":"","operationId":"getConversationsChat","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsChat"},"patch":{"tags":["Conversations"],"summary":"Update a conversation by disconnecting all of the participants","description":"","operationId":"patchConversationsChat","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation","required":true,"schema":{"$ref":"#/definitions/Conversation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Conversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:disconnect"]},"x-purecloud-method-name":"patchConversationsChat"}},"/api/v2/conversations/chats/{conversationId}/participants/{participantId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation participant. ","description":"","operationId":"getConversationsChatParticipantWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsChatParticipantWrapup"}},"/api/v2/conversations/chats/{conversationId}/participants/{participantId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant","description":"","operationId":"patchConversationsChatParticipant","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Update request","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.participant.update.invalid":"Failed to update all properties on conversation participant.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","conversation.error.wrapup.code.required":"Wrapup code is a required field and cannot be empty.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","conversation.error.wrapup.cannot.skip":"Wrap-up cannot be skipped for this participant.","conversation.error.participant.no.active.conversations":"The participant has no active conversation."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.participant.update.failed":"Failed to update all properties on conversation participant.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsChatParticipant"}},"/api/v2/conversations/chats/{conversationId}/participants/{participantId}/communications/{communicationId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant's communication by disconnecting it.","description":"","operationId":"patchConversationsChatParticipantCommunication","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"communication.state.required":"Can only update a communication's state to disconnected.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsChatParticipantCommunication"}},"/api/v2/conversations/chats/{conversationId}/participants/{participantId}/replace":{"post":{"tags":["Conversations"],"summary":"Replace this participant with the specified user and/or address","description":"","operationId":"postConversationsChatParticipantReplace","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Transfer request","required":true,"schema":{"$ref":"#/definitions/TransferRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversations.error.transfer.same.party":"The target of the transfer cannot be the same as the destination.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","conversations.error.queue.not.found":"Interaction cannot be transferred to a queue that does not exist.","conversations.error.transfer.not.connected":"You can only transfer conversations that are in the connected state.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","conversation.error.participant.not.found":"Participant does not exist.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationsChatParticipantReplace"}},"/api/v2/analytics/reporting/schedules":{"get":{"tags":["Analytics"],"summary":"Get a list of scheduled report jobs","description":"Get a list of scheduled report jobs.","operationId":"getAnalyticsReportingSchedules","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportScheduleEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-purecloud-method-name":"getAnalyticsReportingSchedules"},"post":{"tags":["Analytics"],"summary":"Create a scheduled report job","description":"Create a scheduled report job.","operationId":"postAnalyticsReportingSchedules","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ReportSchedule","required":true,"schema":{"$ref":"#/definitions/ReportSchedule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden to create a scheduled report job."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"scheduler.service.error":"A scheduler service error has occurred.","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["reporting:acd:view, reporting:status:view, reporting:interactions:view, reporting:outbound:view, reporting:quality:view, employee"]},"x-purecloud-method-name":"postAnalyticsReportingSchedules"}},"/api/v2/conversations/messaging/integrations/facebook":{"get":{"tags":["Conversations"],"summary":"Get a list of Facebook Integrations","description":"","operationId":"getConversationsMessagingIntegrationsFacebook","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FacebookIntegrationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:view"]},"x-purecloud-method-name":"getConversationsMessagingIntegrationsFacebook"},"post":{"tags":["Conversations"],"summary":"Create a Facebook Integration","description":"","operationId":"postConversationsMessagingIntegrationsFacebook","produces":["application/json"],"parameters":[{"name":"async","in":"query","description":"Create a Facebook integration in an asynchronous manner. If the parameter value is true, this initiates the generation of a new Facebook integration. An integration ID is returned, it can be used to query the integration. Check the integration's createStatus for Completed or Error to detect the create is finished.","required":false,"type":"boolean","default":false},{"in":"body","name":"body","description":"FacebookIntegrationRequest","required":true,"schema":{"$ref":"#/definitions/FacebookIntegrationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FacebookIntegration"}},"202":{"description":"Accepted - If async is true, the integration creation in progress.","schema":{"$ref":"#/definitions/FacebookIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.integration":"The integration request was invalid for this operation. One or more errors may be reported.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:add"]},"x-purecloud-method-name":"postConversationsMessagingIntegrationsFacebook"}},"/api/v2/integrations/userapps":{"get":{"tags":["Integrations"],"summary":"List permitted user app integrations for the logged in user","description":"","operationId":"getIntegrationsUserapps","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"appHost","in":"query","description":"The type of UserApp to filter by","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserAppEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-purecloud-method-name":"getIntegrationsUserapps"}},"/api/v2/uploads/publicassets/images":{"post":{"tags":["Uploads"],"summary":"Creates presigned url for uploading a public asset image","description":"","operationId":"postUploadsPublicassetsImages","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/UploadUrlRequest"}}],"responses":{"200":{"description":"Presigned url successfully created.","schema":{"$ref":"#/definitions/UploadUrlResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["upload"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["uploads:publicasset:upload"]},"x-purecloud-method-name":"postUploadsPublicassetsImages"}},"/api/v2/workforcemanagement/shifttrades":{"get":{"tags":["Workforce Management"],"summary":"Gets all of my shift trades","description":"","operationId":"getWorkforcemanagementShifttrades","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ShiftTradeListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:shiftTradeRequest:edit","wfm:shiftTradeRequest:view","wfm:agentShiftTradeRequest:participate"]},"x-purecloud-method-name":"getWorkforcemanagementShifttrades"}},"/api/v2/journey/actiontemplates/{actionTemplateId}":{"get":{"tags":["Journey"],"summary":"Retrieve a single action template.","description":"","operationId":"getJourneyActiontemplate","produces":["application/json"],"parameters":[{"name":"actionTemplateId","in":"path","description":"ID of the action template.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actiontemplate:view"]},"x-purecloud-method-name":"getJourneyActiontemplate"},"delete":{"tags":["Journey"],"summary":"Delete a single action template.","description":"","operationId":"deleteJourneyActiontemplate","produces":["application/json"],"parameters":[{"name":"actionTemplateId","in":"path","description":"ID of the action template.","required":true,"type":"string"},{"name":"hardDelete","in":"query","description":"Determines whether Action Template should be soft-deleted (have it's state set to deleted) or hard-deleted (permanently removed). Set to false (soft-delete) by default.","required":false,"type":"boolean"}],"responses":{"204":{"description":"Action template deleted."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actiontemplate:delete"]},"x-purecloud-method-name":"deleteJourneyActiontemplate"},"patch":{"tags":["Journey"],"summary":"Update a single action template.","description":"","operationId":"patchJourneyActiontemplate","produces":["application/json"],"parameters":[{"name":"actionTemplateId","in":"path","description":"ID of the action template.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/PatchActionTemplate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actiontemplate:edit"]},"x-purecloud-method-name":"patchJourneyActiontemplate"}},"/api/v2/integrations/speech/tts/engines/{engineId}":{"get":{"tags":["Integrations"],"summary":"Get details about a TTS engine","description":"","operationId":"getIntegrationsSpeechTtsEngine","produces":["application/json"],"parameters":[{"name":"engineId","in":"path","description":"The engine ID","required":true,"type":"string"},{"name":"includeVoices","in":"query","description":"Include voices for the engine","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TtsEngineEntity"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechTtsEngine"}},"/api/v2/gdpr/subjects":{"get":{"tags":["General Data Protection Regulation"],"summary":"Get GDPR subjects","description":"","operationId":"getGdprSubjects","produces":["application/json"],"parameters":[{"name":"searchType","in":"query","description":"Search Type","required":true,"type":"string","enum":["NAME","ADDRESS","PHONE","EMAIL","TWITTER"],"x-genesys-enum-members":[{"name":"NAME"},{"name":"ADDRESS"},{"name":"PHONE"},{"name":"EMAIL"},{"name":"TWITTER"}]},{"name":"searchValue","in":"query","description":"Search Value","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GDPRSubjectEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.error":"An internal server error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gdpr","gdpr:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gdpr:subject:view"]},"x-purecloud-method-name":"getGdprSubjects"}},"/api/v2/webchat/guest/conversations/{conversationId}/mediarequests":{"get":{"tags":["WebChat"],"summary":"Get all media requests to the guest in the conversation","description":"","operationId":"getWebchatGuestConversationMediarequests","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatGuestMediaRequestEntityList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"Guest Chat JWT":[]}],"x-purecloud-method-name":"getWebchatGuestConversationMediarequests"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/copy":{"post":{"tags":["Workforce Management"],"summary":"Copy a schedule","description":"","operationId":"postWorkforcemanagementBusinessunitWeekScheduleCopy","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"scheduleId","in":"path","description":"The ID of the schedule to copy","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/BuCopyScheduleRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuAsyncScheduleResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitWeekScheduleCopy"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/reschedule":{"post":{"tags":["Workforce Management"],"summary":"Start a rescheduling run","description":"","operationId":"postWorkforcemanagementBusinessunitWeekScheduleReschedule","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"scheduleId","in":"path","description":"The ID of the schedule","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/BuRescheduleRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuAsyncScheduleRunResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.missing.one.of.permission.sets":"You must have access to the division of the business unit or all requested management units for the documented permission","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:generate"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitWeekScheduleReschedule"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/generate":{"post":{"tags":["Workforce Management"],"summary":"Generate a schedule","description":"","operationId":"postWorkforcemanagementBusinessunitWeekSchedulesGenerate","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/BuGenerateScheduleRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuAsyncScheduleRunResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:generate"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitWeekSchedulesGenerate"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules":{"get":{"tags":["Workforce Management"],"summary":"Get the list of week schedules for the specified week","description":"Use \"recent\" for the `weekId` path parameter to fetch all forecasts for +/- 26 weeks from the current date. Response will include any schedule which spans the specified week","operationId":"getWorkforcemanagementBusinessunitWeekSchedules","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format, or 'recent' to get recent schedules","required":true,"type":"string"},{"name":"includeOnlyPublished","in":"query","description":"includeOnlyPublished","required":false,"type":"boolean"},{"name":"expand","in":"query","description":"expand","required":false,"type":"string","enum":["forecast.description"],"x-genesys-enum-members":[{"name":"forecast.description"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuScheduleListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:view","wfm:publishedSchedule:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWeekSchedules"},"post":{"tags":["Workforce Management"],"summary":"Create a blank schedule","description":"","operationId":"postWorkforcemanagementBusinessunitWeekSchedules","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/BuCreateBlankScheduleRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuScheduleMetadata"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"VALIDATION_FAILURE","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitWeekSchedules"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}":{"get":{"tags":["Workforce Management"],"summary":"Get the metadata for the schedule, describing which management units and agents are in the scheduleSchedule data can then be loaded with the query route","description":"","operationId":"getWorkforcemanagementBusinessunitWeekSchedule","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"scheduleId","in":"path","description":"The ID of the schedule","required":true,"type":"string"},{"name":"expand","in":"query","description":"expand","required":false,"type":"string","enum":["managementUnits.agents"],"x-genesys-enum-members":[{"name":"managementUnits.agents"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuScheduleMetadata"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:view","wfm:publishedSchedule:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWeekSchedule"},"delete":{"tags":["Workforce Management"],"summary":"Delete a schedule","description":"","operationId":"deleteWorkforcemanagementBusinessunitWeekSchedule","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"scheduleId","in":"path","description":"The ID of the schedule","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuAsyncScheduleResponse"}},"202":{"description":"The schedule is being deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:delete"]},"x-purecloud-method-name":"deleteWorkforcemanagementBusinessunitWeekSchedule"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/generationresults":{"get":{"tags":["Workforce Management"],"summary":"Get the generation results for a generated schedule","description":"","operationId":"getWorkforcemanagementBusinessunitWeekScheduleGenerationresults","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"scheduleId","in":"path","description":"The ID of the schedule","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScheduleGenerationResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:view","wfm:publishedSchedule:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWeekScheduleGenerationresults"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/headcountforecast":{"get":{"tags":["Workforce Management"],"summary":"Get the headcount forecast by planning group for the schedule","description":"","operationId":"getWorkforcemanagementBusinessunitWeekScheduleHeadcountforecast","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"scheduleId","in":"path","description":"The ID of the schedule","required":true,"type":"string"},{"name":"forceDownload","in":"query","description":"Whether to force the result to come via download url. For testing purposes only","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuHeadcountForecastResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:view","wfm:publishedSchedule:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWeekScheduleHeadcountforecast"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/agentschedules/query":{"post":{"tags":["Workforce Management"],"summary":"Loads agent schedule data from the schedule. Used in combination with the metadata route","description":"","operationId":"postWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQuery","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"scheduleId","in":"path","description":"The ID of the schedule","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/BuQueryAgentSchedulesRequest"}},{"name":"forceAsync","in":"query","description":"Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes","required":false,"type":"boolean"},{"name":"forceDownloadService","in":"query","description":"Force the result of this operation to be sent via download service. For testing/app development purposes","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuAsyncAgentSchedulesQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.too.many.teams.requested":"You may only request up to 10 teams in a single request","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","wfm.requested.teams.and.users":"You may only either teams or users, not both","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.too.many.requests":"Too many requests in a given amount of time","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:view","wfm:publishedSchedule:view"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQuery"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/history/agents/{agentId}":{"get":{"tags":["Workforce Management"],"summary":"Loads agent's schedule history.","description":"","operationId":"getWorkforcemanagementBusinessunitWeekScheduleHistoryAgent","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"scheduleId","in":"path","description":"The ID of the schedule","required":true,"type":"string"},{"name":"agentId","in":"path","description":"THe ID of the agent","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuAgentScheduleHistoryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","wfm.missing.team.permissions":"You must have access to the requested teams"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWeekScheduleHistoryAgent"}},"/api/v2/conversations/emails":{"get":{"tags":["Conversations"],"summary":"Get active email conversations for the logged in user","description":"","operationId":"getConversationsEmails","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailConversationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsEmails"},"post":{"tags":["Conversations"],"summary":"Create an email conversation","description":"If the direction of the request is INBOUND, this will create an external conversation with a third party provider. If the direction of the the request is OUTBOUND, this will create a conversation to send outbound emails on behalf of a queue.","operationId":"postConversationsEmails","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Create email request","required":true,"schema":{"$ref":"#/definitions/CreateEmailRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.create.email.parameters":"One of queueId or flowId must be supplied.","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","postino.error.notnull.createconversationrequest.provider":"The provider property may not be null.","email.error.invalid.queue":"An invalid queue ID was specified.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","bad.flow.id":"Invalid flow ID was specified.","email.outbound.queue.address.required":"The queue does not have an outbound email address configured.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","postino.error.notnull.createconversationrequest.queueid":"The queueId property may not be null.","email.outbound.queue.required":"An outbound email conversation requires a queue ID."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:email:create"]},"x-purecloud-method-name":"postConversationsEmails"}},"/api/v2/conversations/emails/{conversationId}/participants/{participantId}/wrapupcodes":{"get":{"tags":["Conversations"],"summary":"Get list of wrapup codes for this conversation participant","description":"","operationId":"getConversationsEmailParticipantWrapupcodes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsEmailParticipantWrapupcodes"}},"/api/v2/conversations/emails/{conversationId}/participants/{participantId}/attributes":{"patch":{"tags":["Conversations"],"summary":"Update the attributes on a conversation participant.","description":"","operationId":"patchConversationsEmailParticipantAttributes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant attributes","required":true,"schema":{"$ref":"#/definitions/ParticipantAttributes"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsEmailParticipantAttributes"}},"/api/v2/conversations/emails/{conversationId}/messages/draft":{"get":{"tags":["Conversations"],"summary":"Get conversation draft reply","description":"","operationId":"getConversationsEmailMessagesDraft","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","postino.error.org.missing":"OrganizationId header is required.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.get.message.body":"An error occurred retrieving a message body.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.temporarily.unavailable":"The service is currently unavailable","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsEmailMessagesDraft"},"put":{"tags":["Conversations"],"summary":"Update conversation draft reply","description":"","operationId":"putConversationsEmailMessagesDraft","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Draft","required":true,"schema":{"$ref":"#/definitions/EmailMessage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.external.provider":"Operation not supported on emails with external providers.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","postino.error.forbidden":"User is not an active participant on the conversation."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.temporarily.unavailable":"The service is currently unavailable","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"putConversationsEmailMessagesDraft"}},"/api/v2/conversations/emails/{conversationId}":{"get":{"tags":["Conversations"],"summary":"Get email conversation","description":"","operationId":"getConversationsEmail","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","postino.error.wrong.org":"Request organization is incorrect for this conversation.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsEmail"},"patch":{"tags":["Conversations"],"summary":"Update a conversation by disconnecting all of the participants","description":"","operationId":"patchConversationsEmail","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation","required":true,"schema":{"$ref":"#/definitions/Conversation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Conversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:disconnect"]},"x-purecloud-method-name":"patchConversationsEmail"}},"/api/v2/conversations/emails/{conversationId}/participants/{participantId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation participant. ","description":"","operationId":"getConversationsEmailParticipantWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsEmailParticipantWrapup"}},"/api/v2/conversations/emails/{conversationId}/messages":{"get":{"tags":["Conversations"],"summary":"Get conversation messages","description":"","operationId":"getConversationsEmailMessages","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailMessageListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.request.timeout":"The service timeout out waiting on a response.","authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsEmailMessages"},"post":{"tags":["Conversations"],"summary":"Send an email reply","description":"","operationId":"postConversationsEmailMessages","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Reply","required":true,"schema":{"$ref":"#/definitions/EmailMessage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.attachments.upload.size":"Upload too large.","email.error.external.provider":"Operation not supported on emails with external providers.","email.error.domain.not.verified":"The email domain has not been verified.","bad.request":"The request could not be understood by the server due to malformed syntax.","postino.error.reply.no.body":"Replies must have a textBody or htmlBody.","postino.error.reply.no.sender":"No connected internal participant found for the reply.","postino.error.reply.no.to":"Replies must have a to address.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","postino.error.reply.no.receiver":"No connected external participant found for the reply.","postino.error.reply.no.userid":"Reply emails must have a userId.","email.error.invalid.email":"Attempted to send an email with an invalid parameter.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","postino.error.forbidden":"User is not an active participant on the conversation."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.reply.sending":"Error sending an email reply."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.temporarily.unavailable":"The service is currently unavailable","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.request.timeout":"The request has timed out.","authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationsEmailMessages"}},"/api/v2/conversations/emails/{conversationId}/messages/draft/attachments/copy":{"post":{"tags":["Conversations"],"summary":"Copy attachments from an email message to the current draft.","description":"","operationId":"postConversationsEmailMessagesDraftAttachmentsCopy","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Copy Attachment Request","required":true,"schema":{"$ref":"#/definitions/CopyAttachmentsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.external.provider":"Operation not supported on emails with external providers.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","postino.error.bad.request":"The request could not be understood by the server due to malformed syntax.","postino.error.reply.no.userid":"Reply emails must have a userId.","postino.error.wrong.org":"Request organization is incorrect for this conversation.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","postino.error.forbidden":"User is not an active participant on the conversation."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationsEmailMessagesDraftAttachmentsCopy"}},"/api/v2/conversations/emails/{conversationId}/messages/draft/attachments/{attachmentId}":{"delete":{"tags":["Conversations"],"summary":"Delete attachment from draft","description":"","operationId":"deleteConversationsEmailMessagesDraftAttachment","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"attachmentId","in":"path","description":"attachmentId","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","postino.error.org.missing":"OrganizationId header is required."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","postino.error.forbidden":"User is not an active participant on the conversation."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"deleteConversationsEmailMessagesDraftAttachment"}},"/api/v2/conversations/emails/{conversationId}/inboundmessages":{"post":{"tags":["Conversations"],"summary":"Send an email to an external conversation. An external conversation is one where the provider is not PureCloud based. This endpoint allows the sender of the external email to reply or send a new message to the existing conversation. The new message will be treated as part of the existing conversation and chained to it.","description":"","operationId":"postConversationsEmailInboundmessages","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Send external email reply","required":true,"schema":{"$ref":"#/definitions/InboundMessageRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","postino.error.notnull.createconversationrequest.provider":"The provider property may not be null.","email.error.invalid.queue":"An invalid queue ID was specified.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","email.error.internal.provider":"Operation not supported on emails with PureCloud providers","bad.flow.id":"Invalid flow ID was specified.","too.many.external.email.parameters":"Only one of queueId or flowId may be provided","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationsEmailInboundmessages"}},"/api/v2/conversations/emails/{conversationId}/participants/{participantId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant","description":"","operationId":"patchConversationsEmailParticipant","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Update request","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.participant.update.invalid":"Failed to update all properties on conversation participant.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","postino.error.answer.not.alerting":"Only alerting calls can be answered.","postino.error.transfer.canceled":"Answer failed because a pending attended transfer was canceled.","postino.error.wrong.org":"Request organization is incorrect for this conversation.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","conversation.error.participant.no.active.conversations":"The participant has no active conversation."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.participant.update.failed":"Failed to update all properties on conversation participant.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsEmailParticipant"}},"/api/v2/conversations/emails/{conversationId}/participants/{participantId}/communications/{communicationId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant's communication by disconnecting it.","description":"","operationId":"patchConversationsEmailParticipantCommunication","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"communication.state.required":"Can only update a communication's state to disconnected.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsEmailParticipantCommunication"}},"/api/v2/conversations/emails/{conversationId}/participants/{participantId}/replace":{"post":{"tags":["Conversations"],"summary":"Replace this participant with the specified user and/or address","description":"","operationId":"postConversationsEmailParticipantReplace","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Transfer request","required":true,"schema":{"$ref":"#/definitions/TransferRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversations.error.transfer.same.party":"The target of the transfer cannot be the same as the destination.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","conversations.error.queue.not.found":"Interaction cannot be transferred to a queue that does not exist.","conversations.error.transfer.not.connected":"You can only transfer conversations that are in the connected state.","postino.error.transfer.replace.external":"External participants may not be replaced.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","postino.error.transfer.not.connected":"Only connected participants can be transferred."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationsEmailParticipantReplace"}},"/api/v2/conversations/emails/{conversationId}/messages/{messageId}":{"get":{"tags":["Conversations"],"summary":"Get conversation message","description":"","operationId":"getConversationsEmailMessage","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"messageId","in":"path","description":"messageId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","postino.error.org.missing":"OrganizationId header is required.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.get.message.body":"An error occurred retrieving a message body.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.temporarily.unavailable":"The service is currently unavailable","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.request.timeout":"The service timeout out waiting on a response.","authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsEmailMessage"}},"/api/v2/quality/forms/evaluations":{"get":{"tags":["Quality"],"summary":"Get the list of evaluation forms","description":"","operationId":"getQualityFormsEvaluations","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"expand","in":"query","description":"Expand","required":false,"type":"string"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Order to sort results, either asc or desc","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:view"]},"x-purecloud-method-name":"getQualityFormsEvaluations"},"post":{"tags":["Quality"],"summary":"Create an evaluation form.","description":"","operationId":"postQualityFormsEvaluations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Evaluation form","required":true,"schema":{"$ref":"#/definitions/EvaluationForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:add"]},"x-purecloud-method-name":"postQualityFormsEvaluations"}},"/api/v2/alerting/interactionstats/alerts":{"get":{"tags":["Alerting"],"summary":"Get interaction stats alert list.","description":"","operationId":"getAlertingInteractionstatsAlerts","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["notificationUsers"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"notificationUsers"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InteractionStatsAlertContainer"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting","alerting:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:alert:view"]},"x-purecloud-method-name":"getAlertingInteractionstatsAlerts"}},"/api/v2/telephony/providers/edges/certificateauthorities":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of certificate authorities.","description":"","operationId":"getTelephonyProvidersEdgesCertificateauthorities","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CertificateAuthorityEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesCertificateauthorities"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a certificate authority.","description":"","operationId":"postTelephonyProvidersEdgesCertificateauthorities","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"CertificateAuthority","required":true,"schema":{"$ref":"#/definitions/DomainCertificateAuthority"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainCertificateAuthority"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesCertificateauthorities"}},"/api/v2/flows/datatables/{datatableId}/export/jobs/{exportJobId}":{"get":{"tags":["Architect"],"summary":"Returns the state information about an export job","description":"Returns the state information about an export job.","operationId":"getFlowsDatatableExportJob","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"name":"exportJobId","in":"path","description":"id of export job","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataTableExportJob"}},"202":{"description":"Request Accepted","schema":{"$ref":"#/definitions/DataTableExportJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","flows.datatables.session.not.found":"A session was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect:readonly","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:view"]},"x-purecloud-method-name":"getFlowsDatatableExportJob"}},"/api/v2/outbound/sequences/{sequenceId}":{"get":{"tags":["Outbound"],"summary":"Get a dialer campaign sequence.","description":"","operationId":"getOutboundSequence","produces":["application/json"],"parameters":[{"name":"sequenceId","in":"path","description":"Campaign Sequence ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignSequence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaignSequence:view"]},"x-purecloud-method-name":"getOutboundSequence"},"put":{"tags":["Outbound"],"summary":"Update a new campaign sequence.","description":"","operationId":"putOutboundSequence","produces":["application/json"],"parameters":[{"name":"sequenceId","in":"path","description":"Campaign Sequence ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Organization","required":true,"schema":{"$ref":"#/definitions/CampaignSequence"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignSequence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","campaign.sequence.cannot.change.both.status.and.campaigns":"","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","campaign.sequence.missing.campaign":"The dialer campaign sequence is missing the campaign.","campaign.sequence.cannot.add.running.campaign.to.on.sequence":"","campaign.sequence.cannot.remove.running.campaign":"","invalid.update":"","campaign.sequence.invalid.campaign":"At least one campaign is invalid","campaign.sequence.invalid.current.campaign":"Current campaign is invalid","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","campaign.sequence.is.empty":"The dialer campaign sequence is empty.","invalid.update.bad.status.transition":"The status transition is invalid and failed to update.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.wrong.version":""}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaignSequence:edit"]},"x-purecloud-method-name":"putOutboundSequence"},"delete":{"tags":["Outbound"],"summary":"Delete a dialer campaign sequence.","description":"","operationId":"deleteOutboundSequence","produces":["application/json"],"parameters":[{"name":"sequenceId","in":"path","description":"Campaign Sequence ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"campaign.sequence.in.use":"The campaign sequence is already in use.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaignSequence:delete"]},"x-purecloud-method-name":"deleteOutboundSequence"}},"/api/v2/mobiledevices/{deviceId}":{"get":{"tags":["Mobile Devices"],"summary":"Get device","description":"","operationId":"getMobiledevice","produces":["application/json"],"parameters":[{"name":"deviceId","in":"path","description":"Device ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserDevice"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a device with that deviceId","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["devices","devices:readonly"]}],"x-purecloud-method-name":"getMobiledevice"},"put":{"tags":["Mobile Devices"],"summary":"Update device","description":"","operationId":"putMobiledevice","produces":["application/json"],"parameters":[{"name":"deviceId","in":"path","description":"Device ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Device","required":false,"schema":{"$ref":"#/definitions/UserDevice"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserDevice"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["devices"]}],"x-purecloud-method-name":"putMobiledevice"},"delete":{"tags":["Mobile Devices"],"summary":"Delete device","description":"","operationId":"deleteMobiledevice","produces":["application/json"],"parameters":[{"name":"deviceId","in":"path","description":"Device ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["devices"]}],"x-purecloud-method-name":"deleteMobiledevice"}},"/api/v2/greetings/{greetingId}/media":{"get":{"tags":["Greetings"],"summary":"Get media playback URI for this greeting","description":"","operationId":"getGreetingMedia","produces":["application/json"],"parameters":[{"name":"greetingId","in":"path","description":"Greeting ID","required":true,"type":"string"},{"name":"formatId","in":"query","description":"The desired media format.","required":false,"type":"string","default":"WAV","enum":["WAV","WEBM","WAV_ULAW","OGG_VORBIS","OGG_OPUS","MP3","NONE"],"x-genesys-enum-members":[{"name":"WAV"},{"name":"WEBM"},{"name":"WAV_ULAW"},{"name":"OGG_VORBIS"},{"name":"OGG_OPUS"},{"name":"MP3"},{"name":"NONE"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GreetingMediaInfo"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings","greetings:readonly"]}],"x-purecloud-method-name":"getGreetingMedia"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId}":{"get":{"tags":["Workforce Management"],"summary":"Get a service goal template","description":"","operationId":"getWorkforcemanagementBusinessunitServicegoaltemplate","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit.","required":true,"type":"string"},{"name":"serviceGoalTemplateId","in":"path","description":"The ID of a service goal template to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ServiceGoalTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:serviceGoalTemplate:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitServicegoaltemplate"},"delete":{"tags":["Workforce Management"],"summary":"Delete a service goal template","description":"","operationId":"deleteWorkforcemanagementBusinessunitServicegoaltemplate","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit.","required":true,"type":"string"},{"name":"serviceGoalTemplateId","in":"path","description":"The ID of the service goal template to delete","required":true,"type":"string"}],"responses":{"204":{"description":"The service goal template was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:serviceGoalTemplate:delete"]},"x-purecloud-method-name":"deleteWorkforcemanagementBusinessunitServicegoaltemplate"},"patch":{"tags":["Workforce Management"],"summary":"Updates a service goal template","description":"","operationId":"patchWorkforcemanagementBusinessunitServicegoaltemplate","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit.","required":true,"type":"string"},{"name":"serviceGoalTemplateId","in":"path","description":"The ID of a service goal template to update","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/UpdateServiceGoalTemplate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ServiceGoalTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Entity was modified by another request"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:serviceGoalTemplate:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementBusinessunitServicegoaltemplate"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates":{"get":{"tags":["Workforce Management"],"summary":"Gets list of service goal templates","description":"","operationId":"getWorkforcemanagementBusinessunitServicegoaltemplates","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ServiceGoalTemplateList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:serviceGoalTemplate:view","wfm:planningGroup:view","wfm:shortTermForecast:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitServicegoaltemplates"},"post":{"tags":["Workforce Management"],"summary":"Adds a new service goal template","description":"","operationId":"postWorkforcemanagementBusinessunitServicegoaltemplates","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/CreateServiceGoalTemplate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ServiceGoalTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:serviceGoalTemplate:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitServicegoaltemplates"}},"/api/v2/quality/forms/surveys/{formId}":{"get":{"tags":["Quality"],"summary":"Get a survey form","description":"","operationId":"getQualityFormsSurvey","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"survey.not.found":"Survey formId not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:view"]},"x-purecloud-method-name":"getQualityFormsSurvey"},"put":{"tags":["Quality"],"summary":"Update a survey form.","description":"","operationId":"putQualityFormsSurvey","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Survey form","required":true,"schema":{"$ref":"#/definitions/SurveyForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:edit"]},"x-purecloud-method-name":"putQualityFormsSurvey"},"delete":{"tags":["Quality"],"summary":"Delete a survey form.","description":"","operationId":"deleteQualityFormsSurvey","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"survey.cannot.be.deleted":"Cannot delete survey because it has already been published."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:delete"]},"x-purecloud-method-name":"deleteQualityFormsSurvey"},"patch":{"tags":["Quality"],"summary":"Disable a particular version of a survey form and invalidates any invitations that have already been sent to customers using this version of the form.","description":"","operationId":"patchQualityFormsSurvey","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Survey form","required":true,"schema":{"$ref":"#/definitions/SurveyForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:disable"]},"x-purecloud-method-name":"patchQualityFormsSurvey"}},"/api/v2/license/users/{userId}":{"get":{"tags":["License"],"summary":"Get licenses for specified user.","description":"","operationId":"getLicenseUser","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LicenseUser"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["license","license:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:add"]},"x-purecloud-method-name":"getLicenseUser"}},"/api/v2/users/{userId}/superiors":{"get":{"tags":["Users"],"summary":"Get superiors","description":"","operationId":"getUserSuperiors","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"routingStatus"},{"name":"presence"},{"name":"conversationSummary"},{"name":"outOfOffice"},{"name":"geolocation"},{"name":"station"},{"name":"authorization"},{"name":"lasttokenissued"},{"name":"authorization.unusedRoles"},{"name":"team"},{"name":"profileSkills"},{"name":"certifications"},{"name":"locations"},{"name":"groups"},{"name":"skills"},{"name":"languages"},{"name":"languagePreference"},{"name":"employerInfo"},{"name":"biography"}]}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/User"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getUserSuperiors"}},"/api/v2/users/{userId}/favorites":{"get":{"tags":["Users"],"summary":"Get favorites","description":"","operationId":"getUserFavorites","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"routingStatus"},{"name":"presence"},{"name":"conversationSummary"},{"name":"outOfOffice"},{"name":"geolocation"},{"name":"station"},{"name":"authorization"},{"name":"lasttokenissued"},{"name":"authorization.unusedRoles"},{"name":"team"},{"name":"profileSkills"},{"name":"certifications"},{"name":"locations"},{"name":"groups"},{"name":"skills"},{"name":"languages"},{"name":"languagePreference"},{"name":"employerInfo"},{"name":"biography"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getUserFavorites"}},"/api/v2/users/{userId}/adjacents":{"get":{"tags":["Users"],"summary":"Get adjacents","description":"","operationId":"getUserAdjacents","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"routingStatus"},{"name":"presence"},{"name":"conversationSummary"},{"name":"outOfOffice"},{"name":"geolocation"},{"name":"station"},{"name":"authorization"},{"name":"lasttokenissued"},{"name":"authorization.unusedRoles"},{"name":"team"},{"name":"profileSkills"},{"name":"certifications"},{"name":"locations"},{"name":"groups"},{"name":"skills"},{"name":"languages"},{"name":"languagePreference"},{"name":"employerInfo"},{"name":"biography"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Adjacents"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getUserAdjacents"}},"/api/v2/users/{userId}/directreports":{"get":{"tags":["Users"],"summary":"Get direct reports","description":"","operationId":"getUserDirectreports","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"routingStatus"},{"name":"presence"},{"name":"conversationSummary"},{"name":"outOfOffice"},{"name":"geolocation"},{"name":"station"},{"name":"authorization"},{"name":"lasttokenissued"},{"name":"authorization.unusedRoles"},{"name":"team"},{"name":"profileSkills"},{"name":"certifications"},{"name":"locations"},{"name":"groups"},{"name":"skills"},{"name":"languages"},{"name":"languagePreference"},{"name":"employerInfo"},{"name":"biography"}]}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/User"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The specified user was not found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getUserDirectreports"}},"/api/v2/userrecordings/{recordingId}":{"get":{"tags":["User Recordings"],"summary":"Get a user recording.","description":"","operationId":"getUserrecording","produces":["application/json"],"parameters":[{"name":"recordingId","in":"path","description":"User Recording ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["conversation"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"conversation"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserRecording"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["user-recordings","user-recordings:readonly"]}],"x-purecloud-method-name":"getUserrecording"},"put":{"tags":["User Recordings"],"summary":"Update a user recording.","description":"","operationId":"putUserrecording","produces":["application/json"],"parameters":[{"name":"recordingId","in":"path","description":"User Recording ID","required":true,"type":"string"},{"in":"body","name":"body","description":"UserRecording","required":true,"schema":{"$ref":"#/definitions/UserRecording"}},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["conversation"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"conversation"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserRecording"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["user-recordings"]}],"x-purecloud-method-name":"putUserrecording"},"delete":{"tags":["User Recordings"],"summary":"Delete a user recording.","description":"","operationId":"deleteUserrecording","produces":["application/json"],"parameters":[{"name":"recordingId","in":"path","description":"User Recording ID","required":true,"type":"string"}],"responses":{"202":{"description":"Accepted - Processing Delete"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["user-recordings"]}],"x-purecloud-method-name":"deleteUserrecording"}},"/api/v2/scripts/{scriptId}/pages":{"get":{"tags":["Scripts"],"summary":"Get the list of pages","description":"","operationId":"getScriptPages","produces":["application/json"],"parameters":[{"name":"scriptId","in":"path","description":"Script ID","required":true,"type":"string"},{"name":"scriptDataVersion","in":"query","description":"Advanced usage - controls the data version of the script","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/Page"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:script:view"]},"x-purecloud-method-name":"getScriptPages"}},"/api/v2/webchat/guest/conversations/{conversationId}/mediarequests/{mediaRequestId}":{"get":{"tags":["WebChat"],"summary":"Get a media request in the conversation","description":"","operationId":"getWebchatGuestConversationMediarequest","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"mediaRequestId","in":"path","description":"mediaRequestId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatGuestMediaRequest"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.not.found":"The media request was not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"Guest Chat JWT":[]}],"x-purecloud-method-name":"getWebchatGuestConversationMediarequest"},"patch":{"tags":["WebChat"],"summary":"Update a media request in the conversation, setting the state to ACCEPTED/DECLINED/ERRORED","description":"","operationId":"patchWebchatGuestConversationMediarequest","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"mediaRequestId","in":"path","description":"mediaRequestId","required":true,"type":"string"},{"in":"body","name":"body","description":"Request","required":true,"schema":{"$ref":"#/definitions/WebChatGuestMediaRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatGuestMediaRequest"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","chat.error.conversation.state":"The conversation is in a state which does not permit this action.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.not.found":"The media request was not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"Guest Chat JWT":[]}],"x-purecloud-method-name":"patchWebchatGuestConversationMediarequest"}},"/api/v2/authorization/subjects/rolecounts":{"get":{"tags":["Authorization"],"summary":"Get the count of roles granted to a list of subjects","description":"","operationId":"getAuthorizationSubjectsRolecounts","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","max.subject.ids":"Only 100 subjects can be requested at a time.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:view"]},"x-purecloud-method-name":"getAuthorizationSubjectsRolecounts"}},"/api/v2/recording/recordingkeys":{"get":{"tags":["Recording"],"summary":"Get encryption key list","description":"","operationId":"getRecordingRecordingkeys","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EncryptionKeyEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:encryptionKey:view"]},"x-purecloud-method-name":"getRecordingRecordingkeys"},"post":{"tags":["Recording"],"summary":"Create encryption key","description":"","operationId":"postRecordingRecordingkeys","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EncryptionKey"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:encryptionKey:edit"]},"x-purecloud-method-name":"postRecordingRecordingkeys"}},"/api/v2/organizations/whitelist":{"get":{"tags":["Organization"],"summary":"Use PUT /api/v2/organizations/embeddedintegration instead","description":"","operationId":"getOrganizationsWhitelist","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrgWhitelistSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getOrganizationsWhitelist"},"put":{"tags":["Organization"],"summary":"Use PUT /api/v2/organizations/embeddedintegration instead","description":"","operationId":"putOrganizationsWhitelist","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Whitelist settings","required":true,"schema":{"$ref":"#/definitions/OrgWhitelistSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrgWhitelistSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:organization:admin"]},"x-purecloud-method-name":"putOrganizationsWhitelist"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId}":{"get":{"tags":["Workforce Management"],"summary":"Get a scheduling run","description":"","operationId":"getWorkforcemanagementBusinessunitSchedulingRun","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"runId","in":"path","description":"The ID of the schedule run","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuScheduleRun"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:generate","wfm:schedule:edit"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitSchedulingRun"},"delete":{"tags":["Workforce Management"],"summary":"Cancel a scheduling run","description":"","operationId":"deleteWorkforcemanagementBusinessunitSchedulingRun","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"runId","in":"path","description":"The ID of the schedule run","required":true,"type":"string"}],"responses":{"204":{"description":"The run was successfully canceled"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:generate"]},"x-purecloud-method-name":"deleteWorkforcemanagementBusinessunitSchedulingRun"},"patch":{"tags":["Workforce Management"],"summary":"Mark a schedule run as applied","description":"","operationId":"patchWorkforcemanagementBusinessunitSchedulingRun","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"runId","in":"path","description":"The ID of the schedule run","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/PatchBuScheduleRunRequest"}}],"responses":{"204":{"description":"The update was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.missing.one.of.permission.sets":"You must have access to the division of the business unit or all requested management units for the documented permission","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementBusinessunitSchedulingRun"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs":{"get":{"tags":["Workforce Management"],"summary":"Get the list of scheduling runs","description":"","operationId":"getWorkforcemanagementBusinessunitSchedulingRuns","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuScheduleRunListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:generate","wfm:schedule:edit"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitSchedulingRuns"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId}/result":{"get":{"tags":["Workforce Management"],"summary":"Get the result of a rescheduling operation","description":"","operationId":"getWorkforcemanagementBusinessunitSchedulingRunResult","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"runId","in":"path","description":"The ID of the schedule run","required":true,"type":"string"},{"name":"managementUnitIds","in":"query","description":"The IDs of the management units for which to fetch the reschedule results","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"expand","in":"query","description":"The fields to expand. Omitting will return an empty response","required":true,"type":"array","items":{"type":"string","enum":["headcountForecast","generationResults","agentSchedules"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"headcountForecast"},{"name":"generationResults"},{"name":"agentSchedules"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuRescheduleResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.missing.one.of.permission.sets":"You must have access to the division of the business unit or all requested management units for the documented permission","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:edit","wfm:schedule:generate"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitSchedulingRunResult"}},"/api/v2/telephony/providers/edges/phones":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of Phone Instances","description":"","operationId":"getTelephonyProvidersEdgesPhones","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Value by which to sort","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"site.id","in":"query","description":"Filter by site.id","required":false,"type":"string"},{"name":"webRtcUser.id","in":"query","description":"Filter by webRtcUser.id","required":false,"type":"string"},{"name":"phoneBaseSettings.id","in":"query","description":"Filter by phoneBaseSettings.id","required":false,"type":"string"},{"name":"lines.loggedInUser.id","in":"query","description":"Filter by lines.loggedInUser.id","required":false,"type":"string"},{"name":"lines.defaultForUser.id","in":"query","description":"Filter by lines.defaultForUser.id","required":false,"type":"string"},{"name":"phone_hardwareId","in":"query","description":"Filter by phone_hardwareId","required":false,"type":"string"},{"name":"lines.id","in":"query","description":"Filter by lines.id","required":false,"type":"string"},{"name":"lines.name","in":"query","description":"Filter by lines.name","required":false,"type":"string"},{"name":"name","in":"query","description":"Name of the Phone to filter by","required":false,"type":"string"},{"name":"expand","in":"query","description":"Fields to expand in the response, comma-separated","required":false,"type":"array","items":{"type":"string","enum":["properties","site","status","status.primaryEdgesStatus","status.secondaryEdgesStatus","phoneBaseSettings","lines"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"properties"},{"name":"site"},{"name":"status"},{"name":"status.primaryEdgesStatus"},{"name":"status.secondaryEdgesStatus"},{"name":"phoneBaseSettings"},{"name":"lines"}]},{"name":"fields","in":"query","description":"Fields and properties to get, comma-separated","required":false,"type":"array","items":{"type":"string","enum":["webRtcUser","properties.*","lines.loggedInUser","lines.defaultForUser"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"webRtcUser"},{"name":"properties.*"},{"name":"lines.loggedInUser"},{"name":"lines.defaultForUser"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhoneEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesPhones"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a new Phone","description":"","operationId":"postTelephonyProvidersEdgesPhones","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Phone","required":true,"schema":{"$ref":"#/definitions/Phone"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Phone"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","lines.required":"A phone cannot be created without a line.","base.settings.required":"A base setting must be assigned to create a phone.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"Request Timeout","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unknown":"Unspecified error posting phone instance."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.rate.limit":"Request rate limit exceeded.","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesPhones"}},"/api/v2/license/users":{"get":{"tags":["License"],"summary":"Get a page of users and their licenses","description":"Retrieve a page of users in an organization along with the licenses they possess.","operationId":"getLicenseUsers","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserLicensesEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["license","license:readonly"]}],"x-purecloud-method-name":"getLicenseUsers"},"post":{"tags":["License"],"summary":"Fetch user licenses in a batch.","description":"","operationId":"postLicenseUsers","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The user IDs to fetch.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["license","license:readonly"]}],"x-purecloud-method-name":"postLicenseUsers"}},"/api/v2/voicemail/groups/{groupId}/messages":{"get":{"tags":["Voicemail"],"summary":"List voicemail messages","description":"","operationId":"getVoicemailGroupMessages","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMessageEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","voicemail.not.authorized.voicemail.message":"Not authorized to access voicemail messages","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-purecloud-method-name":"getVoicemailGroupMessages"}},"/api/v2/identityproviders/adfs":{"get":{"tags":["Identity Provider"],"summary":"Get ADFS Identity Provider","description":"","operationId":"getIdentityprovidersAdfs","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ADFS"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersAdfs"},"put":{"tags":["Identity Provider"],"summary":"Update/Create ADFS Identity Provider","description":"","operationId":"putIdentityprovidersAdfs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/ADFS"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.issuer.uri":"An issuer URI is required.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.target.url":"The target URL must be a valid HTTPS URL.","certificate.not.yet.valid":"The certificate is not yet valid.","certificate.invalid.base64":"Invalid base64 in certificate.","certificate.unparseable":"The certificate for provider cannot be parsed.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersAdfs"},"delete":{"tags":["Identity Provider"],"summary":"Delete ADFS Identity Provider","description":"","operationId":"deleteIdentityprovidersAdfs","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersAdfs"}},"/api/v2/workforcemanagement/agentschedules/mine":{"post":{"tags":["Workforce Management"],"summary":"Get published schedule for the current user","description":"","operationId":"postWorkforcemanagementAgentschedulesMine","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/BuGetCurrentAgentScheduleRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuCurrentAgentScheduleSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.too.many.requests":"Too many requests in a given amount of time","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentSchedule:view"]},"x-purecloud-method-name":"postWorkforcemanagementAgentschedulesMine"}},"/api/v2/oauth/authorizations":{"get":{"tags":["OAuth"],"summary":"List clients that are authorized by the resource owner","description":"","operationId":"getOauthAuthorizations","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthAuthorizationListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:authorize"]},"x-purecloud-method-name":"getOauthAuthorizations"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes":{"get":{"tags":["Workforce Management"],"summary":"Get activity codes","description":"","operationId":"getWorkforcemanagementBusinessunitActivitycodes","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit, or 'mine' for the business unit of the logged-in user.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BusinessUnitActivityCodeListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentSchedule:view","wfm:agentTimeOffRequest:submit","wfm:activityCode:add","wfm:activityCode:delete","wfm:activityCode:edit","wfm:activityCode:view","wfm:agent:edit","wfm:agent:view","wfm:businessUnit:add","wfm:businessUnit:delete","wfm:businessUnit:edit","wfm:businessUnit:view","wfm:historicalAdherence:view","wfm:intraday:view","wfm:managementUnit:add","wfm:managementUnit:delete","wfm:managementUnit:edit","wfm:managementUnit:view","wfm:realtimeAdherence:view","wfm:schedule:add","wfm:schedule:delete","wfm:schedule:edit","wfm:schedule:generate","wfm:schedule:view","wfm:publishedSchedule:view","wfm:serviceGoalTemplate:add","wfm:serviceGoalTemplate:delete","wfm:serviceGoalTemplate:edit","wfm:serviceGoalTemplate:view","wfm:planningGroup:add","wfm:planningGroup:delete","wfm:planningGroup:edit","wfm:planningGroup:view","wfm:shiftTradeRequest:edit","wfm:shiftTradeRequest:view","wfm:shortTermForecast:add","wfm:shortTermForecast:delete","wfm:shortTermForecast:edit","wfm:shortTermForecast:view","wfm:timeOffRequest:add","wfm:timeOffRequest:edit","wfm:timeOffRequest:view","wfm:workPlan:add","wfm:workPlan:delete","wfm:workPlan:edit","wfm:workPlan:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitActivitycodes"},"post":{"tags":["Workforce Management"],"summary":"Create a new activity code","description":"","operationId":"postWorkforcemanagementBusinessunitActivitycodes","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit, or 'mine' for the business unit of the logged-in user.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/CreateActivityCodeRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BusinessUnitActivityCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:activityCode:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitActivitycodes"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes/{activityCodeId}":{"get":{"tags":["Workforce Management"],"summary":"Get an activity code","description":"","operationId":"getWorkforcemanagementBusinessunitActivitycode","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit, or 'mine' for the business unit of the logged-in user.","required":true,"type":"string"},{"name":"activityCodeId","in":"path","description":"The ID of the activity code to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BusinessUnitActivityCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:activityCode:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitActivitycode"},"delete":{"tags":["Workforce Management"],"summary":"Deletes an activity code","description":"","operationId":"deleteWorkforcemanagementBusinessunitActivitycode","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit, or 'mine' for the business unit of the logged-in user.","required":true,"type":"string"},{"name":"activityCodeId","in":"path","description":"The ID of the activity code to delete","required":true,"type":"string"}],"responses":{"204":{"description":"The activity code was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:activityCode:delete"]},"x-purecloud-method-name":"deleteWorkforcemanagementBusinessunitActivitycode"},"patch":{"tags":["Workforce Management"],"summary":"Update an activity code","description":"","operationId":"patchWorkforcemanagementBusinessunitActivitycode","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit, or 'mine' for the business unit of the logged-in user.","required":true,"type":"string"},{"name":"activityCodeId","in":"path","description":"The ID of the activity code to update","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/UpdateActivityCodeRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BusinessUnitActivityCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Entity was modified by another request"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:activityCode:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementBusinessunitActivitycode"}},"/api/v2/scripts/published":{"get":{"tags":["Scripts"],"summary":"Get the published scripts.","description":"","operationId":"getScriptsPublished","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"Expand","required":false,"type":"string"},{"name":"name","in":"query","description":"Name filter","required":false,"type":"string"},{"name":"feature","in":"query","description":"Feature filter","required":false,"type":"string"},{"name":"flowId","in":"query","description":"Secure flow id filter","required":false,"type":"string"},{"name":"scriptDataVersion","in":"query","description":"Advanced usage - controls the data version of the script","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScriptEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:publishedScript:view"]},"x-purecloud-method-name":"getScriptsPublished"}},"/api/v2/presencedefinitions/{presenceId}":{"get":{"tags":["Presence"],"summary":"Get a Presence Definition","description":"","operationId":"getPresencedefinition","produces":["application/json"],"parameters":[{"name":"presenceId","in":"path","description":"Organization Presence ID","required":true,"type":"string"},{"name":"localeCode","in":"query","description":"The locale code to fetch for the presence definition. Use ALL to fetch everything.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationPresence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence","presence:readonly"]}],"x-purecloud-method-name":"getPresencedefinition"},"put":{"tags":["Presence"],"summary":"Update a Presence Definition","description":"","operationId":"putPresencedefinition","produces":["application/json"],"parameters":[{"name":"presenceId","in":"path","description":"Organization Presence ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The OrganizationPresence to update","required":true,"schema":{"$ref":"#/definitions/OrganizationPresence"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationPresence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["presence:presenceDefinition:edit"]},"x-purecloud-method-name":"putPresencedefinition"},"delete":{"tags":["Presence"],"summary":"Delete a Presence Definition","description":"","operationId":"deletePresencedefinition","produces":["application/json"],"parameters":[{"name":"presenceId","in":"path","description":"Organization Presence ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["presence"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["presence:presenceDefinition:delete"]},"x-purecloud-method-name":"deletePresencedefinition"}},"/api/v2/users/bulk":{"patch":{"tags":["Users"],"summary":"Update bulk acd autoanswer on users","description":"","operationId":"patchUsersBulk","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Users","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/PatchUser"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"max user ids":"Only 50 users can be requested at a time.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:add","directory:user:edit"]},"x-purecloud-method-name":"patchUsersBulk"}},"/api/v2/outbound/contactlistfilters":{"get":{"tags":["Outbound"],"summary":"Query Contact list filters","description":"","operationId":"getOutboundContactlistfilters","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"allowEmptyResult","in":"query","description":"Whether to return an empty page when there are no results for that page","required":false,"type":"boolean","default":false},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"],"x-genesys-enum-members":[{"name":"Equals"},{"name":"RegEx"},{"name":"Contains"},{"name":"Prefix"},{"name":"LessThan"},{"name":"LessThanEqualTo"},{"name":"GreaterThan"},{"name":"GreaterThanEqualTo"},{"name":"BeginsWith"},{"name":"EndsWith"}]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]},{"name":"contactListId","in":"query","description":"Contact List ID","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListFilterEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactListFilter:view"]},"x-purecloud-method-name":"getOutboundContactlistfilters"},"post":{"tags":["Outbound"],"summary":"Create Contact List Filter","description":"","operationId":"postOutboundContactlistfilters","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ContactListFilter","required":true,"schema":{"$ref":"#/definitions/ContactListFilter"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListFilter"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"operator.required":"Could not update the contact list filter because the operator field was empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","contact.list.not.found":"Could not create the contact list filter because the contact list could not be found.","filter.type.required.for.multiple.predicates":"Could not update the contact list filter because the filter type on a clause is required if there are multiple predicates.","filter.type.required.for.multiple.clauses":"Could not update the contact list filter because the filter type is required if there are multiple clauses.","at.least.one.predicate.required":"Could not update the contact list filter because each clause must contain at least one predicate.","value.required":"Could not update the contact list filter because the value field on a predicate was empty and required for that predicate's operator.","range.max.required":"Could not update the contact list filter because the range max field is required for Between operator.","value.did.not.match.column.type":"Could not update the contact list filter because the predicate value field did not match the column type.","value.exceeds.max.digits":"The maximum number of digits for the value on a predicate with a numeric operator has been exceeded.","max.less.than.min":"Could not update the contact list filter because the predicate range max value is less than the min value.","min.did.not.match.column.type":"Could not update the contact list filter because the predicate range min field did not match the column type.","value.exceeds.max.decimal.places":"The maximum number of decimal places in the value on a predicate with a numeric operator has been exceeded.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","column.does.not.match.contact.list":"Could not update the contact list filter because the column on a predicate did not match a column on the selected contact list.","range.required":"Could not update the contact list filter because the range field was empty and is required for Between and In operators.","max.predicates.contains.exceeded":"Could not create the contact list filter because the maximum number of predicates with CONTAINS operators has been exceeded.","contact.list.cannot.be.blank":"Could not create the contact list filter because the contact list field was blank.","invalid.date.value":"Could not update the contact list filter because the value field on the predicate is not a valid date.","clauses.required":"Could not update the contact list filter because the clauses field is required to contain at least one clause.","max.did.not.match.column.type":"Could not update the contact list filter because the predicate range max field did not match the column type.","column.required":"Could not update the contact list filter because the column field was empty on a predicate.","max.entity.count.reached":"The maximum contact list filter count has been reached.","max.predicates.exceeded":"Could not create the contact list filter because the maximum number of predicates has been exceeded.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","range.set.required":"Could not update the contact list filter because the range set field is required for In operator.","range.min.required":"Could not update the contact list filter because the range min field is required for Between operator."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactListFilter:add"]},"x-purecloud-method-name":"postOutboundContactlistfilters"}},"/api/v2/responsemanagement/responses":{"get":{"tags":["Response Management"],"summary":"Gets a list of existing responses.","description":"","operationId":"getResponsemanagementResponses","produces":["application/json"],"parameters":[{"name":"libraryId","in":"query","description":"Library ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"expand","in":"query","description":"Expand instructions for the return value.","required":false,"type":"string","enum":["substitutionsSchema"],"x-genesys-enum-members":[{"name":"substitutionsSchema"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management","response-management:readonly"]}],"x-purecloud-method-name":"getResponsemanagementResponses"},"post":{"tags":["Response Management"],"summary":"Create a response.","description":"","operationId":"postResponsemanagementResponses","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Response","required":true,"schema":{"$ref":"#/definitions/Response"}},{"name":"expand","in":"query","description":"Expand instructions for the return value.","required":false,"type":"string","enum":["substitutionsSchema"],"x-genesys-enum-members":[{"name":"substitutionsSchema"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Response"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"rms.not.a.user":"Unable to find user","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"412":{"description":"Precondition Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"rms.precondition":"Response precondition not met."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management"]}],"x-purecloud-method-name":"postResponsemanagementResponses"}},"/api/v2/telephony/providers/edges/trunks":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of available trunks.","description":"Trunks are created by assigning trunk base settings to an Edge or Edge Group.","operationId":"getTelephonyProvidersEdgesTrunks","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Value by which to sort","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"edge.id","in":"query","description":"Filter by Edge Ids","required":false,"type":"string"},{"name":"trunkBase.id","in":"query","description":"Filter by Trunk Base Ids","required":false,"type":"string"},{"name":"trunkType","in":"query","description":"Filter by a Trunk type","required":false,"type":"string","enum":["EXTERNAL","PHONE","EDGE"],"x-genesys-enum-members":[{"name":"EXTERNAL"},{"name":"PHONE"},{"name":"EDGE"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Available Trunk resources not found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesTrunks"}},"/api/v2/recording/localkeys/settings":{"get":{"tags":["Recording"],"summary":"gets a list local key settings data","description":"","operationId":"getRecordingLocalkeysSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LocalEncryptionConfigurationListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:encryptionKey:view"]},"x-purecloud-method-name":"getRecordingLocalkeysSettings"},"post":{"tags":["Recording"],"summary":"create settings for local key creation","description":"","operationId":"postRecordingLocalkeysSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Local Encryption Configuration","required":true,"schema":{"$ref":"#/definitions/LocalEncryptionConfiguration"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LocalEncryptionConfiguration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:encryptionKey:edit"]},"x-purecloud-method-name":"postRecordingLocalkeysSettings"}},"/api/v2/contentmanagement/workspaces/{workspaceId}/members/{memberId}":{"get":{"tags":["Content Management"],"summary":"Get a workspace member","description":"","operationId":"getContentmanagementWorkspaceMember","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"memberId","in":"path","description":"Member ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["member"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"member"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkspaceMember"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden to get a member from a workspace."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementWorkspaceMember"},"put":{"tags":["Content Management"],"summary":"Add a member to a workspace","description":"","operationId":"putContentmanagementWorkspaceMember","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"memberId","in":"path","description":"Member ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Workspace Member","required":true,"schema":{"$ref":"#/definitions/WorkspaceMember"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkspaceMember"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden to add a member to a workspace."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"putContentmanagementWorkspaceMember"},"delete":{"tags":["Content Management"],"summary":"Delete a member from a workspace","description":"","operationId":"deleteContentmanagementWorkspaceMember","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"memberId","in":"path","description":"Member ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden to delete a member from a workspace."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"deleteContentmanagementWorkspaceMember"}},"/api/v2/outbound/campaigns/{campaignId}/interactions":{"get":{"tags":["Outbound"],"summary":"Get dialer campaign interactions.","description":"","operationId":"getOutboundCampaignInteractions","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignInteractions"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The specified campaignId was not found.","resource.not.found":"Resource not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:view"]},"x-purecloud-method-name":"getOutboundCampaignInteractions"}},"/api/v2/telephony/providers/edges/trunkswithrecording":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get Counts of trunks that have recording disabled or enabled","description":"","operationId":"getTelephonyProvidersEdgesTrunkswithrecording","produces":["application/json"],"parameters":[{"name":"trunkType","in":"query","description":"The type of this trunk base.","required":false,"type":"string","enum":["EXTERNAL","PHONE","EDGE"],"x-genesys-enum-members":[{"name":"EXTERNAL"},{"name":"PHONE"},{"name":"EDGE"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkRecordingEnabledCount"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:retentionPolicy:view","telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesTrunkswithrecording"}},"/api/v2/orgauthorization/trustees":{"get":{"tags":["Organization Authorization"],"summary":"The list of trustees for this organization (i.e. organizations granted access to this organization).","description":"","operationId":"getOrgauthorizationTrustees","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrustee:view"]},"x-purecloud-method-name":"getOrgauthorizationTrustees"},"post":{"tags":["Organization Authorization"],"summary":"Create a new organization authorization trust. This is required to grant other organizations access to your organization.","description":"","operationId":"postOrgauthorizationTrustees","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Trust","required":true,"schema":{"$ref":"#/definitions/TrustCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Trustee"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"self.trust.not.allowed":"The pairing trustee organization id cannot match the creator of the trust's organization id.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","pairing.id.required":"A valid pairingId is required.","trustee.user.or.group.required":"Trustee user or group required","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","trustee.user.required":"At least one trustee user is required."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["authorization:orgTrustee:add","authorization:orgTrusteeUser:add"]},"x-purecloud-method-name":"postOrgauthorizationTrustees"}},"/api/v2/recording/recordingkeys/rotationschedule":{"get":{"tags":["Recording"],"summary":"Get key rotation schedule","description":"","operationId":"getRecordingRecordingkeysRotationschedule","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KeyRotationSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:encryptionKey:view"]},"x-purecloud-method-name":"getRecordingRecordingkeysRotationschedule"},"put":{"tags":["Recording"],"summary":"Update key rotation schedule","description":"","operationId":"putRecordingRecordingkeysRotationschedule","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"KeyRotationSchedule","required":true,"schema":{"$ref":"#/definitions/KeyRotationSchedule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KeyRotationSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:encryptionKey:edit"]},"x-purecloud-method-name":"putRecordingRecordingkeysRotationschedule"}},"/api/v2/quality/surveys/{surveyId}":{"get":{"tags":["Quality"],"summary":"Get a survey for a conversation","description":"","operationId":"getQualitySurvey","produces":["application/json"],"parameters":[{"name":"surveyId","in":"path","description":"surveyId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Survey"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.survey.view.permission.check.failed":"Failed to check required view permission.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:survey:view"]},"x-purecloud-method-name":"getQualitySurvey"}},"/api/v2/telephony/providers/edges/addressvalidation":{"post":{"tags":["Telephony Providers Edge"],"summary":"Validates a street address","description":"","operationId":"postTelephonyProvidersEdgesAddressvalidation","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Address","required":true,"schema":{"$ref":"#/definitions/ValidateAddressRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ValidateAddressResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-purecloud-method-name":"postTelephonyProvidersEdgesAddressvalidation"}},"/api/v2/externalcontacts/organizations/{externalOrganizationId}/contacts":{"get":{"tags":["External Contacts"],"summary":"Search for external contacts in an external organization","description":"","operationId":"getExternalcontactsOrganizationContacts","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":20,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":1,"format":"int32"},{"name":"q","in":"query","description":"User supplied search keywords (no special syntax is currently supported)","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["externalOrganization","externalDataSources"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"externalOrganization"},{"name":"externalDataSources"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:view"]},"x-purecloud-method-name":"getExternalcontactsOrganizationContacts"}},"/api/v2/documentation/search":{"get":{"tags":["Search"],"summary":"Search documentation using the q64 value returned from a previous search","description":"","operationId":"getDocumentationSearch","produces":["application/json"],"parameters":[{"name":"q64","in":"query","description":"q64","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentationSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"getDocumentationSearch"},"post":{"tags":["Search"],"summary":"Search documentation","description":"","operationId":"postDocumentationSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/DocumentationSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentationSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","unsupported.search.entity.type":"Search entity type is not supported."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"postDocumentationSearch"}},"/api/v2/analytics/users/observations/query":{"post":{"tags":["Users","Analytics"],"summary":"Query for user observations","description":"","operationId":"postAnalyticsUsersObservationsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/UserObservationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserObservationQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:userObservation:view"]},"x-purecloud-method-name":"postAnalyticsUsersObservationsQuery"}},"/api/v2/analytics/users/details/jobs":{"post":{"tags":["Users","Analytics"],"summary":"Query for user details asynchronously","description":"","operationId":"postAnalyticsUsersDetailsJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/AsyncUserDetailsQuery"}}],"responses":{"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:userDetail:view"]},"x-purecloud-method-name":"postAnalyticsUsersDetailsJobs"}},"/api/v2/analytics/users/details/jobs/{jobId}":{"get":{"tags":["Users","Analytics"],"summary":"Get status for async query for user details","description":"","operationId":"getAnalyticsUsersDetailsJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:userDetail:view"]},"x-purecloud-method-name":"getAnalyticsUsersDetailsJob"},"delete":{"tags":["Users","Analytics"],"summary":"Delete/cancel an async request","description":"","operationId":"deleteAnalyticsUsersDetailsJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"204":{"description":"Deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:userDetail:view"]},"x-purecloud-method-name":"deleteAnalyticsUsersDetailsJob"}},"/api/v2/analytics/users/details/jobs/{jobId}/results":{"get":{"tags":["Users","Analytics"],"summary":"Fetch a page of results for an async query","description":"","operationId":"getAnalyticsUsersDetailsJobResults","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"},{"name":"cursor","in":"query","description":"Indicates where to resume query results (not required for first page)","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"The desired maximum number of results","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AnalyticsUserDetailsAsyncQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:userDetail:view"]},"x-purecloud-method-name":"getAnalyticsUsersDetailsJobResults"}},"/api/v2/analytics/users/details/jobs/availability":{"get":{"tags":["Users","Analytics"],"summary":"Lookup the datalake availability date and time","description":"","operationId":"getAnalyticsUsersDetailsJobsAvailability","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataAvailabilityResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:userDetail:view"]},"x-purecloud-method-name":"getAnalyticsUsersDetailsJobsAvailability"}},"/api/v2/analytics/users/details/query":{"post":{"tags":["Users","Analytics"],"summary":"Query for user details","description":"","operationId":"postAnalyticsUsersDetailsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/UserDetailsQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AnalyticsUserDetailsQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:userObservation:view"]},"x-purecloud-method-name":"postAnalyticsUsersDetailsQuery"}},"/api/v2/analytics/users/aggregates/query":{"post":{"tags":["Users","Analytics"],"summary":"Query for user aggregates","description":"","operationId":"postAnalyticsUsersAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/UserAggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:userAggregate:view"]},"x-purecloud-method-name":"postAnalyticsUsersAggregatesQuery"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}":{"get":{"tags":["Workforce Management"],"summary":"Get a work plan rotation","description":"","operationId":"getWorkforcemanagementManagementunitWorkplanrotation","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"workPlanRotationId","in":"path","description":"The ID of the work plan rotation to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlanRotationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:workPlanRotation:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitWorkplanrotation"},"delete":{"tags":["Workforce Management"],"summary":"Delete a work plan rotation","description":"","operationId":"deleteWorkforcemanagementManagementunitWorkplanrotation","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"workPlanRotationId","in":"path","description":"The ID of the work plan rotation to be deleted","required":true,"type":"string"}],"responses":{"204":{"description":"The work plan rotation was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:workPlanRotation:delete"]},"x-purecloud-method-name":"deleteWorkforcemanagementManagementunitWorkplanrotation"},"patch":{"tags":["Workforce Management"],"summary":"Update a work plan rotation","description":"","operationId":"patchWorkforcemanagementManagementunitWorkplanrotation","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"workPlanRotationId","in":"path","description":"The ID of the work plan rotation to update","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/UpdateWorkPlanRotationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlanRotationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Version of the request does not match the version on the backend"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:workPlanRotation:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementManagementunitWorkplanrotation"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations":{"get":{"tags":["Workforce Management"],"summary":"Get work plan rotations","description":"","operationId":"getWorkforcemanagementManagementunitWorkplanrotations","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"expand","in":"query","required":false,"type":"array","items":{"type":"string","enum":["agents"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"agents"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlanRotationListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agent:view","wfm:workPlanRotation:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitWorkplanrotations"},"post":{"tags":["Workforce Management"],"summary":"Create a new work plan rotation","description":"","operationId":"postWorkforcemanagementManagementunitWorkplanrotations","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/AddWorkPlanRotationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlanRotationResponse"}},"201":{"description":"The work plan rotation was successfully created","schema":{"$ref":"#/definitions/WorkPlanRotationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:workPlanRotation:add"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitWorkplanrotations"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}/copy":{"post":{"tags":["Workforce Management"],"summary":"Create a copy of work plan rotation","description":"","operationId":"postWorkforcemanagementManagementunitWorkplanrotationCopy","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"workPlanRotationId","in":"path","description":"The ID of the work plan rotation to create a copy","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/CopyWorkPlanRotationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlanRotationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"Name not specified or there is already a work plan rotation with the name mentioned for copy","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:workPlanRotation:add"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitWorkplanrotationCopy"}},"/api/v2/textbots/bots/execute":{"post":{"tags":["Textbots"],"summary":"Send an intent to a bot to start a dialog/interact with it via text","description":"This will either start a bot with the given id or relay a communication to an existing bot session.","operationId":"postTextbotsBotsExecute","produces":["application/json"],"parameters":[{"in":"body","name":"postTextRequest","required":true,"schema":{"$ref":"#/definitions/PostTextRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PostTextResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bots.invalid.bot.product":"The bot product type is unrecognized","bots.invalid.bot.argument":"An argument passed on to the bot was declared invalid by the bot service","bad.request":"The request could not be understood by the server due to malformed syntax.","bots.bot.general.provider.failure":"A general provider failure was detected","bots.syntax.error":"There was an error parsing user data","bots.bot.circuit.open":"The bot service is non responsive and we're in a back-off state until the service is restored.","bots.invalid.bot.vendor":"The bot vendor type is unrecognized","bots.bot.doesnt.exist":"This occurs if the service doesn't recognize the bot that the integration code specifies","bots.bot.session.closed":"The bot session is already closed and cannot be reused","bots.unsupported.integration.type":"The integration type is unsupported or not recognized","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","bots.unsupported.language":"The language code is unsupported or not recognized","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","bots.invalid.bot.session.outcome":"The bot outcome is not recognized","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bots.access.denied":"User doesn't have access to bot","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bots.too.many.calls":"Your operation has failed because you've sent too many calls of this type too quickly.","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bots.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","bots.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["textbots"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["textbots:session:execute"]},"x-purecloud-method-name":"postTextbotsBotsExecute"}},"/api/v2/outbound/campaigns/all/divisionviews":{"get":{"tags":["Outbound"],"summary":"Query across all types of campaigns","description":"","operationId":"getOutboundCampaignsAllDivisionviews","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"id","in":"query","description":"Campaign ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Campaign name(s)","required":false,"type":"string"},{"name":"divisionId","in":"query","description":"Division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"mediaType","in":"query","description":"Media type(s)","required":false,"type":"array","items":{"type":"string","enum":["sms","voice"],"x-genesys-enum-members":[{"name":"sms"},{"name":"voice"}]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"sms"},{"name":"voice"}]},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CommonCampaignDivisionViewEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.filter.field":"Invalid query parameter supplied for filtering.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:search","outbound:messagingCampaign:search"]},"x-purecloud-method-name":"getOutboundCampaignsAllDivisionviews"}},"/api/v2/telephony/providers/edges/{edgeId}/softwareupdate":{"get":{"tags":["Telephony Providers Edge"],"summary":"Gets software update status information about any edge.","description":"","operationId":"getTelephonyProvidersEdgeSoftwareupdate","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainEdgeSoftwareUpdateDto"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-purecloud-method-name":"getTelephonyProvidersEdgeSoftwareupdate"},"post":{"tags":["Telephony Providers Edge"],"summary":"Starts a software update for this edge.","description":"","operationId":"postTelephonyProvidersEdgeSoftwareupdate","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Software update request","required":true,"schema":{"$ref":"#/definitions/DomainEdgeSoftwareUpdateDto"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainEdgeSoftwareUpdateDto"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","managed.property.not.allowed":"Not allowed to set managed property."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-purecloud-method-name":"postTelephonyProvidersEdgeSoftwareupdate"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Cancels any in-progress update for this edge.","description":"","operationId":"deleteTelephonyProvidersEdgeSoftwareupdate","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-purecloud-method-name":"deleteTelephonyProvidersEdgeSoftwareupdate"}},"/api/v2/architect/schedules/{scheduleId}":{"get":{"tags":["Architect"],"summary":"Get a schedule by ID","description":"","operationId":"getArchitectSchedule","produces":["application/json"],"parameters":[{"name":"scheduleId","in":"path","description":"Schedule ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Schedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The specified scheduleId was not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:schedule:view"]},"x-purecloud-method-name":"getArchitectSchedule"},"put":{"tags":["Architect"],"summary":"Update schedule by ID","description":"","operationId":"putArchitectSchedule","produces":["application/json"],"parameters":[{"name":"scheduleId","in":"path","description":"Schedule ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Schedule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Schedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:schedule:edit"]},"x-purecloud-method-name":"putArchitectSchedule"},"delete":{"tags":["Architect"],"summary":"Delete a schedule by id","description":"","operationId":"deleteArchitectSchedule","produces":["application/json"],"parameters":[{"name":"scheduleId","in":"path","description":"Schedule ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The requested schedule could not be found.","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The schedule could not be completed because it is assigned to one or more schedule groups."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:schedule:delete"]},"x-purecloud-method-name":"deleteArchitectSchedule"}},"/api/v2/authorization/roles/{leftRoleId}/comparedefault/{rightRoleId}":{"get":{"tags":["Authorization"],"summary":"Get an org role to default role comparison","description":"Compares any organization role to a default role id and show differences","operationId":"getAuthorizationRoleComparedefaultRightRoleId","produces":["application/json"],"parameters":[{"name":"leftRoleId","in":"path","description":"Left Role ID","required":true,"type":"string"},{"name":"rightRoleId","in":"path","description":"Right Role id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainOrgRoleDifference"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:view"]},"x-purecloud-method-name":"getAuthorizationRoleComparedefaultRightRoleId"},"post":{"tags":["Authorization"],"summary":"Get an unsaved org role to default role comparison","description":"Allows users to compare their existing roles in an unsaved state to its default role","operationId":"postAuthorizationRoleComparedefaultRightRoleId","produces":["application/json"],"parameters":[{"name":"leftRoleId","in":"path","description":"Left Role ID","required":true,"type":"string"},{"name":"rightRoleId","in":"path","description":"Right Role id","required":true,"type":"string"},{"in":"body","name":"body","description":"Organization role","required":true,"schema":{"$ref":"#/definitions/DomainOrganizationRole"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainOrgRoleDifference"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:view"]},"x-purecloud-method-name":"postAuthorizationRoleComparedefaultRightRoleId"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/agentschedules/search":{"post":{"tags":["Workforce Management"],"summary":"Query published schedules for given given time range for set of users","description":"","operationId":"postWorkforcemanagementManagementunitAgentschedulesSearch","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/BuSearchAgentSchedulesRequest"}},{"name":"forceAsync","in":"query","description":"Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes","required":false,"type":"boolean"},{"name":"forceDownloadService","in":"query","description":"Force the result of this operation to be sent via download service. For testing/app development purposes","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuAsyncAgentSchedulesSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:publishedSchedule:view","wfm:schedule:view"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitAgentschedulesSearch"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/schedules/search":{"post":{"tags":["Workforce Management"],"summary":"Query published schedules for given given time range for set of users","description":"","operationId":"postWorkforcemanagementManagementunitSchedulesSearch","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/UserListScheduleRequestBody"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserScheduleContainer"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"Request Timeout","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.deprecated.api.timeout":"The response of this deprecated route needed to come via notification, instead please use /agentschedules/search"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.too.many.requests":"Too many requests in a given amount of time","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:publishedSchedule:view","wfm:schedule:view"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitSchedulesSearch"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}":{"get":{"tags":["Workforce Management"],"summary":"Get a time off request","description":"","operationId":"getWorkforcemanagementManagementunitUserTimeoffrequest","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The muId of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"userId","in":"path","description":"The userId to whom the Time Off Request applies.","required":true,"type":"string"},{"name":"timeOffRequestId","in":"path","description":"Time Off Request Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffRequestResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffRequest:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitUserTimeoffrequest"},"patch":{"tags":["Workforce Management"],"summary":"Update a time off request","description":"","operationId":"patchWorkforcemanagementManagementunitUserTimeoffrequest","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The muId of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"userId","in":"path","description":"The id of the user the requested time off request belongs to","required":true,"type":"string"},{"name":"timeOffRequestId","in":"path","description":"The id of the time off request to update","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/AdminTimeOffRequestPatch"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffRequestResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Entity was modified by another request"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffRequest:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementManagementunitUserTimeoffrequest"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests":{"get":{"tags":["Workforce Management"],"summary":"Get a list of time off requests for a given user","description":"","operationId":"getWorkforcemanagementManagementunitUserTimeoffrequests","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The muId of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"userId","in":"path","description":"The userId to whom the Time Off Request applies.","required":true,"type":"string"},{"name":"recentlyReviewed","in":"query","description":"Limit results to requests that have been reviewed within the preceding 30 days","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffRequestList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffRequest:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitUserTimeoffrequests"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/query":{"post":{"tags":["Workforce Management"],"summary":"Gets the lookup ids to fetch the specified set of requests","description":"","operationId":"postWorkforcemanagementManagementunitTimeoffrequestsQuery","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The muId of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/TimeOffRequestQueryBody"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffRequestListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffRequest:view"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitTimeoffrequestsQuery"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests":{"post":{"tags":["Workforce Management"],"summary":"Create a new time off request","description":"","operationId":"postWorkforcemanagementManagementunitTimeoffrequests","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The muId of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/CreateAdminTimeOffRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffRequestList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffRequest:add"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitTimeoffrequests"}},"/api/v2/telephony/providers/edges/dids/{didId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a DID by ID.","description":"","operationId":"getTelephonyProvidersEdgesDid","produces":["application/json"],"parameters":[{"name":"didId","in":"path","description":"DID ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DID"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesDid"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a DID by ID.","description":"","operationId":"putTelephonyProvidersEdgesDid","produces":["application/json"],"parameters":[{"name":"didId","in":"path","description":"DID ID","required":true,"type":"string"},{"in":"body","name":"body","description":"DID","required":true,"schema":{"$ref":"#/definitions/DID"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DID"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesDid"}},"/api/v2/externalcontacts/contacts/schemas/{schemaId}/versions/{versionId}":{"get":{"tags":["External Contacts"],"summary":"Get a specific version of a schema","description":"","operationId":"getExternalcontactsContactsSchemaVersion","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"},{"name":"versionId","in":"path","description":"Schema version","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"The schema to expand has parse errors"}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getExternalcontactsContactsSchemaVersion"}},"/api/v2/webchat/guest/conversations/{conversationId}/members":{"get":{"tags":["WebChat"],"summary":"Get the members of a chat conversation.","description":"","operationId":"getWebchatGuestConversationMembers","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"The number of entries to return per page, or omitted for the default.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number to return, or omitted for the first page.","required":false,"type":"integer","default":1,"format":"int32"},{"name":"excludeDisconnectedMembers","in":"query","description":"If true, the results will not contain members who have a DISCONNECTED state.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatMemberInfoEntityList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"Guest Chat JWT":[]}],"x-purecloud-method-name":"getWebchatGuestConversationMembers"}},"/api/v2/usage/query/{executionId}/results":{"get":{"tags":["Usage"],"summary":"Get the results of a usage query","description":"","operationId":"getUsageQueryExecutionIdResults","produces":["application/json"],"parameters":[{"name":"executionId","in":"path","description":"ID of the query execution","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ApiUsageQueryResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:view"]},"x-purecloud-method-name":"getUsageQueryExecutionIdResults"}},"/api/v2/voicemail/me/messages":{"get":{"tags":["Voicemail"],"summary":"List voicemail messages","description":"","operationId":"getVoicemailMeMessages","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMessageEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-purecloud-method-name":"getVoicemailMeMessages"}},"/api/v2/routing/utilization":{"get":{"tags":["Routing"],"summary":"Get the organization-wide max utilization settings.","description":"","operationId":"getRoutingUtilization","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Utilization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:utilization:manage","routing:utilization:view"]},"x-purecloud-method-name":"getRoutingUtilization"},"put":{"tags":["Routing"],"summary":"Update the organization-wide max utilization settings. Include only those media types requiring custom configuration.","description":"","operationId":"putRoutingUtilization","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"utilization","required":true,"schema":{"$ref":"#/definitions/Utilization"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Utilization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"An unsupported media type was specified.","interrupt.same.media.type":"A media type cannot be set up to interrupt itself.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.media.capacity":"Value too large or too small for media type.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:utilization:manage"]},"x-purecloud-method-name":"putRoutingUtilization"},"delete":{"tags":["Routing"],"summary":"Delete the organization-wide max utilization settings and revert to the system default.","description":"","operationId":"deleteRoutingUtilization","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:utilization:manage"]},"x-purecloud-method-name":"deleteRoutingUtilization"}},"/api/v2/speechandtextanalytics/conversations/{conversationId}/communications/{communicationId}/transcripturl":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get the pre-signed S3 URL for the transcript of a specific communication of a conversation","description":"","operationId":"getSpeechandtextanalyticsConversationCommunicationTranscripturl","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"Communication ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TranscriptUrl"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden from retrieving transcript url."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"URL is not available."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:recording:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsConversationCommunicationTranscripturl"}},"/api/v2/workforcemanagement/businessunits/divisionviews":{"get":{"tags":["Workforce Management"],"summary":"Get business units across divisions","description":"","operationId":"getWorkforcemanagementBusinessunitsDivisionviews","produces":["application/json"],"parameters":[{"name":"divisionId","in":"query","description":"The divisionIds to filter by. If omitted, will return business units in all divisions","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BusinessUnitListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:businessUnit:search"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitsDivisionviews"}},"/api/v2/outbound/campaigns/{campaignId}/callback/schedule":{"post":{"tags":["Outbound"],"summary":"Schedule a Callback for a Dialer Campaign (Deprecated)","description":"This endpoint is deprecated and may have unexpected results. Please use \"/conversations/{conversationId}/participants/{participantId}/callbacks instead.\"","operationId":"postOutboundCampaignCallbackSchedule","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ContactCallbackRequest","required":true,"schema":{"$ref":"#/definitions/ContactCallbackRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactCallbackRequest"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","schedule.cannot.be.blank":"The schedule cannot be blank.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","contact.cannot.be.blank":"The contact cannot be blank.","contact.list.cannot.be.blank":"The contact list cannot be blank.","invalid.contact.phone.column":"The contact phone columns are invalid.","invalid.schedule.format":"The schedule format is invalid.","callback.schedule.invalid":"The callback schedule is not valid.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The dialer campaign was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","callback.scheduling.error":""}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"deprecated":true,"x-purecloud-method-name":"postOutboundCampaignCallbackSchedule"}},"/api/v2/quality/spotability":{"post":{"tags":["Quality"],"summary":"Retrieve the spotability statistic","description":"","operationId":"postQualitySpotability","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Keyword Set","required":false,"schema":{"$ref":"#/definitions/KeywordSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KeywordSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-purecloud-method-name":"postQualitySpotability"}},"/api/v2/uploads/recordings":{"post":{"tags":["Uploads"],"summary":"Creates presigned url for uploading a recording file","description":"","operationId":"postUploadsRecordings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/UploadUrlRequest"}}],"responses":{"200":{"description":"Presigned url successfully created.","schema":{"$ref":"#/definitions/UploadUrlResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["upload"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["recording:recording:upload"]},"x-purecloud-method-name":"postUploadsRecordings"}},"/api/v2/oauth/clients/{clientId}/usage/query/results/{executionId}":{"get":{"tags":["OAuth"],"summary":"Get the results of a usage query","description":"","operationId":"getOauthClientUsageQueryResult","produces":["application/json"],"parameters":[{"name":"executionId","in":"path","description":"ID of the query execution","required":true,"type":"string"},{"name":"clientId","in":"path","description":"Client ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ApiUsageQueryResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:view"]},"x-purecloud-method-name":"getOauthClientUsageQueryResult"}},"/api/v2/telephony/providers/edges/certificateauthorities/{certificateId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a certificate authority.","description":"","operationId":"getTelephonyProvidersEdgesCertificateauthority","produces":["application/json"],"parameters":[{"name":"certificateId","in":"path","description":"Certificate ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainCertificateAuthority"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Certificate authority resource not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesCertificateauthority"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a certificate authority.","description":"","operationId":"putTelephonyProvidersEdgesCertificateauthority","produces":["application/json"],"parameters":[{"name":"certificateId","in":"path","description":"Certificate ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Certificate authority","required":true,"schema":{"$ref":"#/definitions/DomainCertificateAuthority"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainCertificateAuthority"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesCertificateauthority"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a certificate authority.","description":"","operationId":"deleteTelephonyProvidersEdgesCertificateauthority","produces":["application/json"],"parameters":[{"name":"certificateId","in":"path","description":"Certificate ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Certificate authority resource not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdgesCertificateauthority"}},"/api/v2/conversations":{"get":{"tags":["Conversations"],"summary":"Get active conversations for the logged in user","description":"","operationId":"getConversations","produces":["application/json"],"parameters":[{"name":"communicationType","in":"query","description":"Call or Chat communication filtering","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConversationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversations"}},"/api/v2/profiles/groups":{"get":{"tags":["Groups"],"summary":"Get group profile listing","description":"This api is deprecated. Use /api/v2/groups instead.","operationId":"getProfilesGroups","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ASC","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GroupProfileEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups","groups:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getProfilesGroups"}},"/api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}":{"get":{"tags":["Workforce Management"],"summary":"Get a time off request for the current user","description":"","operationId":"getWorkforcemanagementTimeoffrequest","produces":["application/json"],"parameters":[{"name":"timeOffRequestId","in":"path","description":"Time Off Request Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffRequestResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentSchedule:view","wfm:agentTimeOffRequest:submit"]},"x-purecloud-method-name":"getWorkforcemanagementTimeoffrequest"},"patch":{"tags":["Workforce Management"],"summary":"Update a time off request for the current user","description":"","operationId":"patchWorkforcemanagementTimeoffrequest","produces":["application/json"],"parameters":[{"name":"timeOffRequestId","in":"path","description":"Time Off Request Id","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/AgentTimeOffRequestPatch"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffRequestResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentTimeOffRequest:submit"]},"x-purecloud-method-name":"patchWorkforcemanagementTimeoffrequest"}},"/api/v2/workforcemanagement/timeoffrequests":{"get":{"tags":["Workforce Management"],"summary":"Get a list of time off requests for the current user","description":"","operationId":"getWorkforcemanagementTimeoffrequests","produces":["application/json"],"parameters":[{"name":"recentlyReviewed","in":"query","description":"Limit results to requests that have been reviewed within the preceding 30 days","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffRequestList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.server.error":"WFM Server Error","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentSchedule:view","wfm:agentTimeOffRequest:submit"]},"x-purecloud-method-name":"getWorkforcemanagementTimeoffrequests"},"post":{"tags":["Workforce Management"],"summary":"Create a time off request for the current user","description":"","operationId":"postWorkforcemanagementTimeoffrequests","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/CreateAgentTimeOffRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffRequestResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentTimeOffRequest:submit"]},"x-purecloud-method-name":"postWorkforcemanagementTimeoffrequests"}},"/api/v2/voicemail/queues/{queueId}/messages":{"get":{"tags":["Voicemail"],"summary":"List voicemail messages","description":"","operationId":"getVoicemailQueueMessages","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMessageEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["voicemail:acdVoicemail:view"]},"x-purecloud-method-name":"getVoicemailQueueMessages"}},"/api/v2/users/{userId}/greetings/defaults":{"get":{"tags":["Greetings"],"summary":"Grabs the list of Default Greetings given a User's ID","description":"","operationId":"getUserGreetingsDefaults","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DefaultGreetingList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings","greetings:readonly"]}],"x-purecloud-method-name":"getUserGreetingsDefaults"},"put":{"tags":["Greetings"],"summary":"Updates the DefaultGreetingList of the specified User","description":"","operationId":"putUserGreetingsDefaults","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The updated defaultGreetingList","required":true,"schema":{"$ref":"#/definitions/DefaultGreetingList"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DefaultGreetingList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings"]}],"x-purecloud-method-name":"putUserGreetingsDefaults"}},"/api/v2/routing/email/domains/{domainName}/routes":{"get":{"tags":["Routing"],"summary":"Get routes","description":"","operationId":"getRoutingEmailDomainRoutes","produces":["application/json"],"parameters":[{"name":"domainName","in":"path","description":"email domain","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pattern","in":"query","description":"Filter routes by the route's pattern property","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundRouteEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"getRoutingEmailDomainRoutes"},"post":{"tags":["Routing"],"summary":"Create a route","description":"","operationId":"postRoutingEmailDomainRoutes","produces":["application/json"],"parameters":[{"name":"domainName","in":"path","description":"email domain","required":true,"type":"string"},{"in":"body","name":"body","description":"Route","required":true,"schema":{"$ref":"#/definitions/InboundRoute"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundRoute"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.max.routes.exceeded":"The maximum number of routes for the domain has been exceeded.","reply.route.id.required":"A route ID is required for the reply email address.","postino.max.autobcc.exceeded":"The maximum number of automatic bcc email addresses for the route has been exceeded.","bad.request":"The request could not be understood by the server due to malformed syntax.","postino.invalid.route":"The 'queue' and 'pattern' fields are required.","postino.error.not.found":"The resource could not be found.","postino.domain.exists":"The inbound domain already exists.","postino.error.bad.address":"Invalid email address. Check for invalid control or whitespace characters.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","bad.flow.id":"The flow is not eligible for use here.","postino.route.pattern.exists":"A route already exists for this domain with the specified pattern.","postino.error.queue.required":"A queue id or flow id is required.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"postRoutingEmailDomainRoutes"}},"/api/v2/integrations/workforcemanagement/vendorconnection":{"post":{"tags":["Integrations"],"summary":"Add a vendor connection","description":"","operationId":"postIntegrationsWorkforcemanagementVendorconnection","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/VendorConnectionRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserActionCategoryEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-purecloud-method-name":"postIntegrationsWorkforcemanagementVendorconnection"}},"/api/v2/conversations/messaging/integrations/twitter":{"get":{"tags":["Conversations"],"summary":"Get a list of Twitter Integrations","description":"","operationId":"getConversationsMessagingIntegrationsTwitter","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TwitterIntegrationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:view"]},"x-purecloud-method-name":"getConversationsMessagingIntegrationsTwitter"},"post":{"tags":["Conversations"],"summary":"Create a Twitter Integration","description":"","operationId":"postConversationsMessagingIntegrationsTwitter","produces":["application/json"],"parameters":[{"name":"async","in":"query","description":"Create a Twitter integration in an asynchronous manner. If the parameter value is true, this initiates the generation of a new Twitter integration. An integration ID is returned, it can be used to query the integration. Check the integration's createStatus for Completed or Error to detect the create is finished.","required":false,"type":"boolean","default":false},{"in":"body","name":"body","description":"TwitterIntegrationRequest","required":true,"schema":{"$ref":"#/definitions/TwitterIntegrationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TwitterIntegration"}},"202":{"description":"Accepted - If async is true, the integration creation is in progress.","schema":{"$ref":"#/definitions/TwitterIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.integration":"The integration request was invalid for this operation. One or more errors may be reported.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:add"]},"x-purecloud-method-name":"postConversationsMessagingIntegrationsTwitter"}},"/api/v2/architect/schedulegroups":{"get":{"tags":["Architect"],"summary":"Get a list of schedule groups.","description":"","operationId":"getArchitectSchedulegroups","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"name","in":"query","description":"Name of the Schedule Group to filter by.","required":false,"type":"string"},{"name":"scheduleIds","in":"query","description":"A comma-delimited list of Schedule IDs to filter by.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScheduleGroupEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:scheduleGroup:view"]},"x-purecloud-method-name":"getArchitectSchedulegroups"},"post":{"tags":["Architect"],"summary":"Creates a new schedule group","description":"","operationId":"postArchitectSchedulegroups","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/ScheduleGroup"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScheduleGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:scheduleGroup:add"]},"x-purecloud-method-name":"postArchitectSchedulegroups"}},"/api/v2/conversations/faxes":{"post":{"tags":["Conversations"],"summary":"Create Fax Conversation","description":"","operationId":"postConversationsFaxes","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Fax","required":true,"schema":{"$ref":"#/definitions/FaxSendRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxSendResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"fax.content.type.not.supported":"The fax content type is not supported.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","fax.missing.field":"Missing required field.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"fax.forbidden":"You are not permitted to send faxes.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","fax.internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationsFaxes"}},"/api/v2/systempresences":{"get":{"tags":["Presence"],"summary":"Get the list of SystemPresences","description":"","operationId":"getSystempresences","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/SystemPresence"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence","presence:readonly"]}],"x-purecloud-method-name":"getSystempresences"}},"/api/v2/authorization/divisions/home":{"get":{"tags":["Authorization","Objects"],"summary":"Retrieve the home division for the organization.","description":"Will not include object counts.","operationId":"getAuthorizationDivisionsHome","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuthzDivision"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-purecloud-method-name":"getAuthorizationDivisionsHome"}},"/api/v2/telephony/providers/edges":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of edges.","description":"","operationId":"getTelephonyProvidersEdges","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"site.id","in":"query","description":"Filter by site.id","required":false,"type":"string"},{"name":"edgeGroup.id","in":"query","description":"Filter by edgeGroup.id","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"managed","in":"query","description":"Filter by managed","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"Request Timeout","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unknown":"Unspecified error getting edge listing."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.internal.server.error":"Internal server error while getting edge listing.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdges"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create an edge.","description":"","operationId":"postTelephonyProvidersEdges","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Edge","required":true,"schema":{"$ref":"#/definitions/Edge"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Edge"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","duplicate.edge.name":"The edge name is already in use."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdges"}},"/api/v2/conversations/{conversationId}/recordingmetadata/{recordingId}":{"get":{"tags":["Recording"],"summary":"Get metadata for a specific recording. Does not return playable media.","description":"","operationId":"getConversationRecordingmetadataRecordingId","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"recordingId","in":"path","description":"Recording ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingMetadata"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.recording.view.permission.check.failed":"Failed to verify recording view permission.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","recording.recording.not.found":"Recording with recordingId was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:recording:view"]},"x-purecloud-method-name":"getConversationRecordingmetadataRecordingId"}},"/api/v2/telephony/providers/edges/lines":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of Lines","description":"","operationId":"getTelephonyProvidersEdgesLines","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Value by which to sort","required":false,"type":"string","default":"name"},{"name":"expand","in":"query","description":"Fields to expand in the response, comma-separated","required":false,"type":"array","items":{"type":"string","enum":["properties","site","edgeGroup","primaryEdge","secondaryEdge","edges","assignedUser"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"properties"},{"name":"site"},{"name":"edgeGroup"},{"name":"primaryEdge"},{"name":"secondaryEdge"},{"name":"edges"},{"name":"assignedUser"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LineEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesLines"}},"/api/v2/fax/documents/{documentId}":{"get":{"tags":["Fax"],"summary":"Get a document.","description":"","operationId":"getFaxDocument","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxDocument"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Access to a document is not permitted by given document id."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["fax","fax:readonly"]}],"x-purecloud-method-name":"getFaxDocument"},"put":{"tags":["Fax"],"summary":"Update a fax document.","description":"","operationId":"putFaxDocument","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Document","required":true,"schema":{"$ref":"#/definitions/FaxDocument"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxDocument"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["fax"]}],"x-purecloud-method-name":"putFaxDocument"},"delete":{"tags":["Fax"],"summary":"Delete a fax document.","description":"","operationId":"deleteFaxDocument","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"}],"responses":{"202":{"description":"Accepted - Processing Delete"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["fax"]}],"x-purecloud-method-name":"deleteFaxDocument"}},"/api/v2/quality/keywordsets":{"get":{"tags":["Quality"],"summary":"Get the list of keyword sets","description":"","operationId":"getQualityKeywordsets","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"name","in":"query","description":"the keyword set name - used for filtering results in searches.","required":false,"type":"string"},{"name":"queueId","in":"query","description":"the queue id - used for filtering results in searches.","required":false,"type":"string"},{"name":"agentId","in":"query","description":"the agent id - used for filtering results in searches.","required":false,"type":"string"},{"name":"operator","in":"query","description":"If agentID and queueId are both present, this determines whether the query is an AND or OR between those parameters.","required":false,"type":"string","enum":["AND","OR"],"x-genesys-enum-members":[{"name":"AND"},{"name":"OR"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KeywordSetEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:keywordset:view"]},"x-purecloud-method-name":"getQualityKeywordsets"},"post":{"tags":["Quality"],"summary":"Create a Keyword Set","description":"","operationId":"postQualityKeywordsets","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"keywordSet","required":true,"schema":{"$ref":"#/definitions/KeywordSet"}},{"name":"expand","in":"query","description":"queueId","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KeywordSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"qm.keyword.set.invalid.agent":"One of the agentIds is invalid","quality.keyword.limit.exceeded.for.agent":"Keyword Set keyword limit exceeded for agent","bad.request":"The request could not be understood by the server due to malformed syntax.","qm.keyword.set.invalid.queue":"One of the queueIds is invalid","qm.keyword.set.invalid.language":"Invalid language","quality.keyword.duplicate.phrase":"A Keyword phrase cannot be duplicated in keywords, anti-words or alternate spellings","quality.keyword.limit.exceeded.for.agent.and.queue":"Keyword Set keyword limit exceeded for agent and queue","quality.keyword.limit.exceeded":"Keyword Set keyword limit exceeded","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","quality.keyword.limit.exceeded.for.queue":"Keyword Set keyword limit exceeded for queue","qm.keyword.set.agent.or.queue.required":"A queue or agent is required for a valid Keyword Set","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:keywordset:add"]},"x-purecloud-method-name":"postQualityKeywordsets"},"delete":{"tags":["Quality"],"summary":"Delete keyword sets","description":"Bulk delete of keyword sets; this will only delete the keyword sets that match the ids specified in the query param.","operationId":"deleteQualityKeywordsets","produces":["application/json"],"parameters":[{"name":"ids","in":"query","description":"A comma-delimited list of valid KeywordSet ids","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:keywordset:delete"]},"x-purecloud-method-name":"deleteQualityKeywordsets"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings/{trainingId}":{"get":{"tags":["Knowledge"],"summary":"Get training detail","description":"","operationId":"getKnowledgeKnowledgebaseLanguageTraining","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","de-DE"],"x-genesys-enum-members":[{"name":"en-US"},{"name":"de-DE"}]},{"name":"trainingId","in":"path","description":"Training ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeTraining"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:training:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseLanguageTraining"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings/{trainingId}/promote":{"post":{"tags":["Knowledge"],"summary":"Promote trained documents from draft state to active.","description":"","operationId":"postKnowledgeKnowledgebaseLanguageTrainingPromote","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","de-DE"],"x-genesys-enum-members":[{"name":"en-US"},{"name":"de-DE"}]},{"name":"trainingId","in":"path","description":"Training ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeTraining"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:training:edit"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseLanguageTrainingPromote"}},"/api/v2/integrations/actions/drafts":{"get":{"tags":["Integrations"],"summary":"Retrieves all action drafts associated with the filters passed in via query param.","description":"","operationId":"getIntegrationsActionsDrafts","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Root level field name to sort on.","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Direction to sort 'sortBy' field.","required":false,"type":"string","default":"asc","enum":["ASC","DESC"],"x-genesys-enum-members":[{"name":"ASC"},{"name":"DESC"}]},{"name":"category","in":"query","description":"Filter by category name","required":false,"type":"string"},{"name":"name","in":"query","description":"Filter by action name. Provide full or just the first part of name.","required":false,"type":"string"},{"name":"secure","in":"query","description":"Filter to only include secure actions. True will only include actions marked secured. False will include only unsecure actions. Do not use filter if you want all Actions.","required":false,"type":"string","enum":["true","false"],"x-genesys-enum-members":[{"name":"true"},{"name":"false"}]},{"name":"includeAuthActions","in":"query","description":"Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions.","required":false,"type":"string","default":"false","enum":["true","false"],"x-genesys-enum-members":[{"name":"true"},{"name":"false"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:view","bridge:actions:view"]},"x-purecloud-method-name":"getIntegrationsActionsDrafts"},"post":{"tags":["Integrations"],"summary":"Create a new Draft","description":"","operationId":"postIntegrationsActionsDrafts","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Input used to create Action Draft.","required":true,"schema":{"$ref":"#/definitions/PostActionInput"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Action"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:add"]},"x-purecloud-method-name":"postIntegrationsActionsDrafts"}},"/api/v2/responsemanagement/libraries":{"get":{"tags":["Response Management"],"summary":"Gets a list of existing response libraries.","description":"","operationId":"getResponsemanagementLibraries","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"messagingTemplateFilter","in":"query","description":"Returns a list of libraries that contain responses with at least one messaging template defined for a specific message channel","required":false,"type":"string","enum":["whatsapp"],"x-genesys-enum-members":[{"name":"whatsapp"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LibraryEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management","response-management:readonly"]}],"x-purecloud-method-name":"getResponsemanagementLibraries"},"post":{"tags":["Response Management"],"summary":"Create a response library.","description":"","operationId":"postResponsemanagementLibraries","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Library","required":true,"schema":{"$ref":"#/definitions/Library"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Library"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management"]}],"x-purecloud-method-name":"postResponsemanagementLibraries"}},"/api/v2/analytics/conversations/transcripts/query":{"post":{"tags":["Search","Analytics"],"summary":"Search resources.","description":"","operationId":"postAnalyticsConversationsTranscriptsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/TranscriptConversationDetailSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AnalyticsConversationWithoutAttributesMultiGetResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","too.many.search.requests":"Rate limit for search requests exceeded"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationDetail:view"]},"x-purecloud-method-name":"postAnalyticsConversationsTranscriptsQuery"}},"/api/v2/notifications/availabletopics":{"get":{"tags":["Notifications"],"summary":"Get available notification topics.","description":"","operationId":"getNotificationsAvailabletopics","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["description","requiresPermissions","enforced","schema","visibility","transports","publicApiTemplateUriPaths"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"description"},{"name":"requiresPermissions"},{"name":"enforced"},{"name":"schema"},{"name":"visibility"},{"name":"transports"},{"name":"publicApiTemplateUriPaths"}]},{"name":"includePreview","in":"query","description":"Whether or not to include Preview topics","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AvailableTopicEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["notifications"]}],"x-purecloud-method-name":"getNotificationsAvailabletopics"}},"/api/v2/userrecordings/{recordingId}/media":{"get":{"tags":["User Recordings"],"summary":"Download a user recording.","description":"","operationId":"getUserrecordingMedia","produces":["application/json"],"parameters":[{"name":"recordingId","in":"path","description":"User Recording ID","required":true,"type":"string"},{"name":"formatId","in":"query","description":"The desired media format.","required":false,"type":"string","default":"WEBM","enum":["WAV","WEBM","WAV_ULAW","OGG_VORBIS","OGG_OPUS","MP3","NONE"],"x-genesys-enum-members":[{"name":"WAV"},{"name":"WEBM"},{"name":"WAV_ULAW"},{"name":"OGG_VORBIS"},{"name":"OGG_OPUS"},{"name":"MP3"},{"name":"NONE"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DownloadResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["user-recordings","user-recordings:readonly"]}],"x-purecloud-method-name":"getUserrecordingMedia"}},"/api/v2/journey/outcomes/{outcomeId}":{"get":{"tags":["Journey"],"summary":"Retrieve a single outcome.","description":"","operationId":"getJourneyOutcome","produces":["application/json"],"parameters":[{"name":"outcomeId","in":"path","description":"ID of the outcome.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Outcome"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:outcome:view"]},"x-purecloud-method-name":"getJourneyOutcome"},"delete":{"tags":["Journey"],"summary":"Delete an outcome.","description":"","operationId":"deleteJourneyOutcome","produces":["application/json"],"parameters":[{"name":"outcomeId","in":"path","description":"ID of the outcome.","required":true,"type":"string"}],"responses":{"204":{"description":"Outcome deleted."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:outcome:delete"]},"x-purecloud-method-name":"deleteJourneyOutcome"},"patch":{"tags":["Journey"],"summary":"Update an outcome.","description":"","operationId":"patchJourneyOutcome","produces":["application/json"],"parameters":[{"name":"outcomeId","in":"path","description":"ID of the outcome.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/PatchOutcome"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Outcome"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:outcome:edit"]},"x-purecloud-method-name":"patchJourneyOutcome"}},"/api/v2/chat/settings":{"get":{"tags":["Chat"],"summary":"Get Chat Settings.","description":"","operationId":"getChatSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:setting:view","chat:setting:edit"]},"x-purecloud-method-name":"getChatSettings"},"put":{"tags":["Chat"],"summary":"Update Chat Settings.","description":"","operationId":"putChatSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Chat","required":true,"schema":{"$ref":"#/definitions/ChatSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:setting:edit"]},"x-purecloud-method-name":"putChatSettings"},"patch":{"tags":["Chat"],"summary":"Patch Chat Settings.","description":"","operationId":"patchChatSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Chat","required":true,"schema":{"$ref":"#/definitions/ChatSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:setting:edit"]},"x-purecloud-method-name":"patchChatSettings"}},"/api/v2/groups/search":{"get":{"tags":["Groups","Search"],"summary":"Search groups using the q64 value returned from a previous search","description":"","operationId":"getGroupsSearch","produces":["application/json"],"parameters":[{"name":"q64","in":"query","description":"q64","required":true,"type":"string"},{"name":"expand","in":"query","description":"expand","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GroupsSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups","groups:readonly"]}],"x-purecloud-method-name":"getGroupsSearch"},"post":{"tags":["Groups","Search"],"summary":"Search groups","description":"","operationId":"postGroupsSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/GroupSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GroupsSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups"]}],"x-purecloud-method-name":"postGroupsSearch"}},"/api/v2/identityproviders/gsuite":{"get":{"tags":["Identity Provider"],"summary":"Get G Suite Identity Provider","description":"","operationId":"getIdentityprovidersGsuite","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GSuite"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersGsuite"},"put":{"tags":["Identity Provider"],"summary":"Update/Create G Suite Identity Provider","description":"","operationId":"putIdentityprovidersGsuite","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/GSuite"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.issuer.uri":"An issuer URI is required.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.target.url":"The target URL must be a valid HTTPS URL.","certificate.not.yet.valid":"The certificate is not yet valid.","certificate.invalid.base64":"Invalid base64 in certificate.","certificate.unparseable":"The certificate for provider cannot be parsed.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersGsuite"},"delete":{"tags":["Identity Provider"],"summary":"Delete G Suite Identity Provider","description":"","operationId":"deleteIdentityprovidersGsuite","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersGsuite"}},"/api/v2/journey/actiontargets":{"get":{"tags":["Journey"],"summary":"Retrieve all action targets.","description":"","operationId":"getJourneyActiontargets","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionTargetListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actiontarget:view"]},"x-purecloud-method-name":"getJourneyActiontargets"}},"/api/v2/webchat/settings":{"get":{"tags":["WebChat"],"summary":"Get WebChat deployment settings","description":"","operationId":"getWebchatSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["web-chat","web-chat:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["webchat:deployment:read"]},"x-purecloud-method-name":"getWebchatSettings"},"put":{"tags":["WebChat"],"summary":"Update WebChat deployment settings","description":"","operationId":"putWebchatSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"webChatSettings","required":true,"schema":{"$ref":"#/definitions/WebChatSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["web-chat"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["webchat:deployment:update"]},"x-purecloud-method-name":"putWebchatSettings"},"delete":{"tags":["WebChat"],"summary":"Remove WebChat deployment settings","description":"","operationId":"deleteWebchatSettings","produces":["application/json"],"parameters":[],"responses":{"204":{"description":"Deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["web-chat"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["webchat:deployment:delete"]},"x-purecloud-method-name":"deleteWebchatSettings"}},"/api/v2/fax/documents":{"get":{"tags":["Fax"],"summary":"Get a list of fax documents.","description":"","operationId":"getFaxDocuments","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxDocumentEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Access to a list of fax documents is not permitted."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["fax","fax:readonly"]}],"x-purecloud-method-name":"getFaxDocuments"}},"/api/v2/integrations/actions/categories":{"get":{"tags":["Integrations"],"summary":"Retrieves all categories of available Actions","description":"","operationId":"getIntegrationsActionsCategories","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Root level field name to sort on.","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Direction to sort 'sortBy' field.","required":false,"type":"string","default":"asc","enum":["ASC","DESC"],"x-genesys-enum-members":[{"name":"ASC"},{"name":"DESC"}]},{"name":"secure","in":"query","description":"Filter to only include secure actions. True will only include actions marked secured. False will include only unsecure actions. Do not use filter if you want all Actions.","required":false,"type":"string","enum":["true","false"],"x-genesys-enum-members":[{"name":"true"},{"name":"false"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CategoryEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:view","bridge:actions:view"]},"x-purecloud-method-name":"getIntegrationsActionsCategories"}},"/api/v2/analytics/reporting/metadata":{"get":{"tags":["Analytics"],"summary":"Get list of reporting metadata.","description":"","operationId":"getAnalyticsReportingMetadata","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"locale","in":"query","description":"Locale","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportMetaDataEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["reporting:acd:view, reporting:status:view, reporting:interactions:view, reporting:outbound:view, reporting:quality:view, employee"]},"x-purecloud-method-name":"getAnalyticsReportingMetadata"}},"/api/v2/dataextensions/coretypes/{coretypeName}":{"get":{"tags":["Data Extensions"],"summary":"Get a specific named core type.","description":"","operationId":"getDataextensionsCoretype","produces":["application/json"],"parameters":[{"name":"coretypeName","in":"path","description":"The core type's name","required":true,"type":"string","enum":["text","longtext","url","identifier","enum","date","datetime","integer","number","checkbox","tag"],"x-genesys-enum-members":[{"name":"text"},{"name":"longtext"},{"name":"url"},{"name":"identifier"},{"name":"enum"},{"name":"date"},{"name":"datetime"},{"name":"integer"},{"name":"number"},{"name":"checkbox"},{"name":"tag"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Coretype"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["data-extensions"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getDataextensionsCoretype"}},"/api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}/typing":{"post":{"tags":["WebChat"],"summary":"Send a typing-indicator in a chat conversation.","description":"","operationId":"postWebchatGuestConversationMemberTyping","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"memberId","in":"path","description":"memberId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatTyping"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","chat.error.conversation.state":"The conversation is in a state which does not permit this action.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","chat.error.member.state":"The conversation member is in a state which does not permit this action.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"credentials.expired":"The supplied credentials are expired and cannot be used.","authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.internal":"Internal chat error","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","chat.error":"Error handing chat conversation typing operation."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"Guest Chat JWT":[]}],"x-purecloud-method-name":"postWebchatGuestConversationMemberTyping"}},"/api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}/messages":{"post":{"tags":["WebChat"],"summary":"Send a message in a chat conversation.","description":"","operationId":"postWebchatGuestConversationMemberMessages","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"memberId","in":"path","description":"memberId","required":true,"type":"string"},{"in":"body","name":"body","description":"Message","required":true,"schema":{"$ref":"#/definitions/CreateWebChatMessageRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.notnull.createconversationmessagerequest.body":"The request body may not be null.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","chat.error.conversation.state":"The conversation is in a state which does not permit this action.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","chat.error.member.state":"The conversation member is in a state which does not permit this action.","chat.error.bad.request":"Error occurred due to invalid request.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"credentials.expired":"The supplied credentials are expired and cannot be used.","authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","chat.error":"Error handing chat conversation messages operation."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"Guest Chat JWT":[]}],"x-purecloud-method-name":"postWebchatGuestConversationMemberMessages"}},"/api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}":{"get":{"tags":["WebChat"],"summary":"Get a web chat conversation member","description":"","operationId":"getWebchatGuestConversationMember","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"memberId","in":"path","description":"memberId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatMemberInfo"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"credentials.expired":"The supplied credentials are expired and cannot be used.","authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.not.found":"The web chat conversation member was not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","chat.error":"Error handing chat conversation operation."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"Guest Chat JWT":[]}],"x-purecloud-method-name":"getWebchatGuestConversationMember"},"delete":{"tags":["WebChat"],"summary":"Remove a member from a chat conversation","description":"","operationId":"deleteWebchatGuestConversationMember","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"memberId","in":"path","description":"memberId","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","chat.error.conversation.state":"The conversation is in a state which does not permit this action.","chat.error.member.state":"The conversation member is in a state which does not permit this action."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"credentials.expired":"The supplied credentials are expired and cannot be used.","authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","chat.error":"Error handing chat conversation operation"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"Guest Chat JWT":[]}],"x-purecloud-method-name":"deleteWebchatGuestConversationMember"}},"/api/v2/workforcemanagement/adherence/historical":{"post":{"tags":["Workforce Management"],"summary":"Request a historical adherence report for users across management units","description":"","operationId":"postWorkforcemanagementAdherenceHistorical","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/WfmHistoricalAdherenceQueryForUsers"}}],"responses":{"202":{"description":"Processing request","schema":{"$ref":"#/definitions/WfmHistoricalAdherenceResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.only.authorized.for.team.access":"You are only authorized to call this route for specific teams","wfm.too.many.teams.requested":"You may only request up to 10 teams in a single request","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","wfm.requested.teams.and.users":"You may only either teams or users, not both","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","wfm.missing.team.permissions":"You must have access to the requested teams"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:historicalAdherence:view"]},"x-purecloud-method-name":"postWorkforcemanagementAdherenceHistorical"}},"/api/v2/telephony/providers/edges/physicalinterfaces":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get physical interfaces for edges.","description":"Retrieves a list of all configured physical interfaces for a list of edges. Only 100 edges can be requested at a time.","operationId":"getTelephonyProvidersEdgesPhysicalinterfaces","produces":["application/json"],"parameters":[{"name":"edgeIds","in":"query","description":"Comma separated list of Edge Id's","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhysicalInterfaceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesPhysicalinterfaces"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/adherence":{"get":{"tags":["Workforce Management"],"summary":"Get a list of user schedule adherence records for the requested management unit","description":"","operationId":"getWorkforcemanagementManagementunitAdherence","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The management unit ID of the management unit.","required":true,"type":"string"},{"name":"forceDownloadService","in":"query","description":"Force the result of this operation to be sent via download service. For testing/app development purposes","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserScheduleAdherenceListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:realtimeAdherence:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitAdherence"}},"/api/v2/groups/{groupId}/greetings":{"get":{"tags":["Greetings"],"summary":"Get a list of the Group's Greetings","description":"","operationId":"getGroupGreetings","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GreetingListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings","greetings:readonly"]}],"x-purecloud-method-name":"getGroupGreetings"},"post":{"tags":["Greetings"],"summary":"Creates a Greeting for a Group","description":"","operationId":"postGroupGreetings","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The Greeting to create","required":true,"schema":{"$ref":"#/definitions/Greeting"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Greeting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings"]}],"x-purecloud-method-name":"postGroupGreetings"}},"/api/v2/routing/email/domains/{domainId}":{"get":{"tags":["Routing"],"summary":"Get domain","description":"","operationId":"getRoutingEmailDomain","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"domain ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundDomain"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"getRoutingEmailDomain"},"delete":{"tags":["Routing"],"summary":"Delete a domain","description":"","operationId":"deleteRoutingEmailDomain","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"domain ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"deleteRoutingEmailDomain"},"patch":{"tags":["Routing"],"summary":"Update domain settings","description":"","operationId":"patchRoutingEmailDomain","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"domain ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Domain settings","required":true,"schema":{"$ref":"#/definitions/InboundDomainPatchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundDomain"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.integration.connection":"Unable to connect with the specified integration.","email.error.integration.ssl":"There was a problem with opening a SSL socket to the integration.","email.error.integration.authentication":"Unable to authenticate with the specified integration.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","email.error.invalid.integration":"An invalid integration ID was specified.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","email.error.integration.host":"The specified integration has a bad host."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.domain.not.found":"The inbound domain does not exist.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.integration.timeout":"There was a timeout connecting to the integration.","authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"patchRoutingEmailDomain"}},"/api/v2/routing/email/domains/{domainId}/validate":{"patch":{"tags":["Routing"],"summary":"Validate domain settings","description":"","operationId":"patchRoutingEmailDomainValidate","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"domain ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Domain settings","required":true,"schema":{"$ref":"#/definitions/InboundDomainPatchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundDomain"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.integration.connection":"Unable to connect with the specified integration.","email.error.integration.ssl":"There was a problem with opening a SSL socket to the integration.","email.error.integration.authentication":"Unable to authenticate with the specified integration.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","email.error.invalid.integration":"An invalid integration ID was specified.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","email.error.integration.host":"The specified integration has a bad host."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.domain.not.found":"The inbound domain does not exist.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.integration.timeout":"There was a timeout connecting to the integration.","authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"patchRoutingEmailDomainValidate"}},"/api/v2/routing/email/domains/{domainId}/testconnection":{"post":{"tags":["Routing"],"summary":"Tests the custom SMTP server integration connection set on this domain","description":"The request body is optional. If omitted, this endpoint will just test the connection of the Custom SMTP Server. If the body is specified, there will be an attempt to send an email message to the server.","operationId":"postRoutingEmailDomainTestconnection","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"domain ID","required":true,"type":"string"},{"in":"body","name":"body","description":"TestMessage","required":false,"schema":{"$ref":"#/definitions/TestMessage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TestMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.integration.connection":"Unable to connect with the specified integration.","email.error.integration.ssl":"There was a problem with opening a SSL socket to the integration.","email.error.integration.authentication":"Unable to authenticate with the specified integration.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","email.error.invalid.integration":"An invalid integration ID was specified.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","email.error.integration.host":"The specified integration has a bad host."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","feature.forbidden":"This feature is not enabled for this organization."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.integration.timeout":"There was a timeout connecting to the integration.","authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"postRoutingEmailDomainTestconnection"}},"/api/v2/flows/{flowId}":{"get":{"tags":["Architect"],"summary":"Get flow","description":"","operationId":"getFlow","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"},{"name":"deleted","in":"query","description":"Deleted flows","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Flow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.version.missing":"Specified flow version is missing.","not.found":"The requested resource was not found.","architect.flow.not.found":"Could not find flow with specified ID."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.inbound.short.message.flow.invalid.operation":"Cannot perform requested operation on an inbound short message flow.","Inbound.Email.Flow.Invalid.Operation":"Cannot perform requested operation on an inbound email flow.","architect.workflow.invalid.operation":"Cannot perform requested operation on a workflow.","Outbound.Call.Flow.Invalid.Operation":"Cannot perform requested operation on an outbound call flow.","Inbound.Call.Flow.Invalid.Operation":"Cannot perform requested operation on an inbound call flow.","architect.speech.flow.invalid.operation":"Cannot perform requested operation on a speech flow.","architect.secure.call.flow.invalid.operation":"Cannot perform requested operation on a secure call flow.","Inqueue.Call.Flow.Invalid.Operation":"Cannot perform requested operation on an inqueue call flow.","architect.survey.invite.flow.invalid.operation":"Cannot perform requested operation on a survey invite flow.","architect.bot.flow.invalid.operation":"Cannot perform requested operation on a bot flow.","architect.secure.call.flow.not.supported":"Secure call flows are not supported by the current product levels."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:view"]},"x-purecloud-method-name":"getFlow"},"put":{"tags":["Architect"],"summary":"Update flow","description":"","operationId":"putFlow","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Flow"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Flow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","architect.flow.validate.failed.invalid.name.contains.slash":"Failed to validate flow due to invalid name. Flow names must not contain forward slashes.","architect.flow.validate.failed.invalid.name.no.alpha":"Failed to validate flow due to invalid name. Names must contain at least one alphanumeric character.","bad.request":"The request could not be understood by the server due to malformed syntax.","architect.object.validate.failed":"Failed to validate object.","architect.flow.validate.failed.missing.type":"Failed to validate flow due to missing type.","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","architect.flow.validate.failed.invalid.name.contains.debug":"Failed to validate flow due to invalid name. Flow names must not end with '-debug'.","architect.flow.validate.failed":"Failed to validate flow.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","architect.system.flow.name.or.description.error":"System flow names and descriptions cannot be changed.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","architect.flow.validate.failed.missing.name":"Failed to validate flow due to missing name."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.version.missing":"Specified flow version is missing.","not.found":"The requested resource was not found.","architect.flow.not.found":"Could not find flow with specified ID."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.inbound.short.message.flow.invalid.operation":"Cannot perform requested operation on an inbound short message flow.","architect.debug.flow.invalid.operation":"Cannot perform requested operation on a debug flow.","architect.secure.call.flow.invalid.operation":"Cannot perform requested operation on a secure call flow.","architect.secure.call.flow.not.supported":"Secure call flows are not supported by the current product levels."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.not.locked.by.user":"Flow is not locked by requesting user.","architect.flow.already.exists":"A flow of the specified type with the specified name already exists."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.object.update.failed":"The database update for the object failed.","architect.external.user.query.error":"Failed querying backend service for information on user.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:edit"]},"x-purecloud-method-name":"putFlow"},"delete":{"tags":["Architect"],"summary":"Delete flow","description":"","operationId":"deleteFlow","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.flow.not.found":"Could not find flow with specified ID."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.inbound.short.message.flow.invalid.operation":"Cannot perform requested operation on an inbound short message flow.","architect.default.flow.cannot.delete":"Cannot delete the default in-queue flow.","architect.flow.cannot.delete.user.does.not.have.lock":"Flow cannot be deleted because it is locked by another user.","architect.debug.flow.invalid.operation":"Cannot perform requested operation on a debug flow.","architect.secure.call.flow.invalid.operation":"Cannot perform requested operation on a secure call flow.","architect.secure.call.flow.not.supported":"Secure call flows are not supported by the current product levels."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.cannot.delete.used.in.pe.action.maps":"Flow cannot be deleted due to being used by one or more predictive engagement action maps.","architect.flow.cannot.delete.used.in.ivr.configs":"Flow cannot be deleted due to being used by one or more IVR configurations.","architect.flow.cannot.delete.used.in.email.routes":"Flow cannot be deleted due to being used by one or more email routes.","architect.dependency.object.in.use":"The object cannot be deleted because other objects depend on it.","architect.flow.cannot.delete.used.in.widgets":"Flow cannot be deleted due to being used by one or more widgets.","architect.flow.cannot.delete.used.by.message.addresses":"Flow cannot be deleted due to being used by one or more message addresses.","architect.flow.cannot.delete.used.in.flows":"Flow cannot be deleted due to being used by one or more flows.","architect.flow.cannot.delete.used.in.recording.policies":"Flow cannot be deleted due to being used by one or more recording policies.","architect.flow.cannot.delete.used.in.queues":"Flow cannot be deleted due to being used by one or more queues.","architect.flow.cannot.delete.used.in.composer.scripts":"Flow cannot be deleted due to being used by one or more composer scripts.","architect.flow.cannot.delete.used.in.emergency.groups":"Flow cannot be deleted due to being used by one or more emergency groups."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.object.update.failed":"The database update for the object failed.","architect.external.flow.change.notification.error":"A backend service error occurred while sending out a flow change notification.","architect.external.call.failure":"A call to another backend service failed.","architect.external.user.query.error":"Failed querying backend service for information on user.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","architect.database.throughput.exceeded":"Database too busy. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:delete"]},"x-purecloud-method-name":"deleteFlow"}},"/api/v2/flows/{flowId}/latestconfiguration":{"get":{"tags":["Architect"],"summary":"Get the latest configuration for flow","description":"","operationId":"getFlowLatestconfiguration","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"},{"name":"deleted","in":"query","description":"Deleted flows","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"type":"object"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","flow.no.config.available":"Flow has no saved or checked-in configuration."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.inbound.short.message.flow.invalid.operation":"Cannot perform requested operation on an inbound short message flow.","architect.secure.call.flow.invalid.operation":"Cannot perform requested operation on a secure call flow.","architect.secure.call.flow.not.supported":"Secure call flows are not supported by the current product levels."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:view"]},"x-purecloud-method-name":"getFlowLatestconfiguration"}},"/api/v2/flows/{flowId}/history/{historyId}":{"get":{"tags":["Architect"],"summary":"Get generated flow history","description":"","operationId":"getFlowHistoryHistoryId","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"},{"name":"historyId","in":"path","description":"History request ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"desc"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"timestamp","enum":["action","timestamp","user"],"x-genesys-enum-members":[{"name":"action"},{"name":"timestamp"},{"name":"user"}]},{"name":"action","in":"query","description":"Flow actions to include (omit to include all)","required":false,"type":"array","items":{"type":"string","enum":["checkin","checkout","create","deactivate","debug","delete","publish","revert","save"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"checkin"},{"name":"checkout"},{"name":"create"},{"name":"deactivate"},{"name":"debug"},{"name":"delete"},{"name":"publish"},{"name":"revert"},{"name":"save"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/HistoryListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.flow.not.found":"Could not find flow with specified ID."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:view"]},"x-purecloud-method-name":"getFlowHistoryHistoryId"}},"/api/v2/outbound/contactlistfilters/preview":{"post":{"tags":["Outbound"],"summary":"Get a preview of the output of a contact list filter","description":"","operationId":"postOutboundContactlistfiltersPreview","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ContactListFilter","required":true,"schema":{"$ref":"#/definitions/ContactListFilter"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FilterPreviewResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contact:view"]},"x-purecloud-method-name":"postOutboundContactlistfiltersPreview"}},"/api/v2/outbound/campaigns/all":{"get":{"tags":["Outbound"],"summary":"Query across all types of campaigns by division","description":"","operationId":"getOutboundCampaignsAll","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"id","in":"query","description":"Campaign ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Campaign name(s)","required":false,"type":"string"},{"name":"divisionId","in":"query","description":"Division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"mediaType","in":"query","description":"Media type(s)","required":false,"type":"array","items":{"type":"string","enum":["sms","voice"],"x-genesys-enum-members":[{"name":"sms"},{"name":"voice"}]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"sms"},{"name":"voice"}]},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CommonCampaignEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.filter.field":"Invalid query parameter supplied for filtering.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:view","outbound:messagingCampaign:view"]},"x-purecloud-method-name":"getOutboundCampaignsAll"}},"/api/v2/analytics/reporting/schedules/{scheduleId}/runreport":{"post":{"tags":["Analytics"],"summary":"Place a scheduled report immediately into the reporting queue","description":"","operationId":"postAnalyticsReportingScheduleRunreport","produces":["application/json"],"parameters":[{"name":"scheduleId","in":"path","description":"Schedule ID","required":true,"type":"string"}],"responses":{"202":{"description":"Accepted - Processing Report","schema":{"$ref":"#/definitions/RunNowResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics"]}],"x-purecloud-method-name":"postAnalyticsReportingScheduleRunreport"}},"/api/v2/conversations/{conversationId}":{"get":{"tags":["Conversations"],"summary":"Get conversation","description":"","operationId":"getConversation","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Conversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:view"]},"x-purecloud-method-name":"getConversation"}},"/api/v2/conversations/{conversationId}/assign":{"post":{"tags":["Conversations"],"summary":"Attempts to manually assign a specified conversation to a specified agent. Ignores bullseye ring, PAR score, skills, and languages.","description":"","operationId":"postConversationAssign","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Targeted user","required":true,"schema":{"$ref":"#/definitions/ConversationUser"}}],"responses":{"202":{"description":"The manual assignment request was accepted","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.status":"The agent's current routing status does not allow for new conversation assignments.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","feature.not.enabled":"The feature allowing manual assignment is not enabled for this queue.","operation.failed":"The manual assignment attempt failed.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"You do not have the required permission for this operation."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The conversation or queue could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Too many active requests. Try again later."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:call:pull","conversation:call:assign","conversation:callback:pull","conversation:callback:assign","conversation:webchat:pull","conversation:webchat:assign","conversation:email:pull","conversation:email:assign","conversation:message:pull","conversation:message:assign"]},"x-purecloud-method-name":"postConversationAssign"}},"/api/v2/conversations/{conversationId}/disconnect":{"post":{"tags":["Conversations"],"summary":"Performs a full conversation teardown. Issues disconnect requests for any connected media. Applies a system wrap-up code to any participants that are pending wrap-up. This is not intended to be the normal way of ending interactions but is available in the event of problems with the application to allow a resynchronization of state across all components. It is recommended that users submit a support case if they are relying on this endpoint systematically as there is likely something that needs investigation.","description":"","operationId":"postConversationDisconnect","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"}],"responses":{"202":{"description":"Accepted","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:disconnect"]},"x-purecloud-method-name":"postConversationDisconnect"}},"/api/v2/oauth/clients/{clientId}/secret":{"post":{"tags":["OAuth"],"summary":"Regenerate Client Secret","description":"This operation will set the client secret to a randomly generated cryptographically random value. All clients must be updated with the new secret. This operation should be used with caution.","operationId":"postOauthClientSecret","produces":["application/json"],"parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthClient"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:edit"]},"x-purecloud-method-name":"postOauthClientSecret"}},"/api/v2/oauth/clients/{clientId}":{"get":{"tags":["OAuth"],"summary":"Get OAuth Client","description":"","operationId":"getOauthClient","produces":["application/json"],"parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthClient"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","client.not.found":"Client was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:view"]},"x-purecloud-method-name":"getOauthClient"},"put":{"tags":["OAuth"],"summary":"Update OAuth Client","description":"","operationId":"putOauthClient","produces":["application/json"],"parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Client","required":true,"schema":{"$ref":"#/definitions/OAuthClientRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthClient"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.client.scope":"Client scope is missing.","bad.client.role":"Client role is invalid.","bad.client.state":"Client is disabled.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","bad.grant.type":"Invalid grant type.","missing.client.roles":"Client roles and divisions are missing.","grant.type.required":"Grant type is required.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","client.not.found":"Client was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:edit"]},"x-purecloud-method-name":"putOauthClient"},"delete":{"tags":["OAuth"],"summary":"Delete OAuth Client","description":"","operationId":"deleteOauthClient","produces":["application/json"],"parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","cannot.delete.client":"Clients must be marked as inactive to be eligible for deletion."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","client.not.found":"Client was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["oauth"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:delete"]},"x-purecloud-method-name":"deleteOauthClient"}},"/api/v2/integrations/speech/lex/bot/alias/{aliasId}":{"get":{"tags":["Integrations"],"summary":"Get details about a Lex bot alias","description":"","operationId":"getIntegrationsSpeechLexBotAlias","produces":["application/json"],"parameters":[{"name":"aliasId","in":"path","description":"The alias ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LexBotAlias"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request is badly formed","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechLexBotAlias"}},"/api/v2/routing/skills/{skillId}":{"get":{"tags":["Routing"],"summary":"Get Routing Skill","description":"","operationId":"getRoutingSkill","produces":["application/json"],"parameters":[{"name":"skillId","in":"path","description":"Skill ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RoutingSkill"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-purecloud-method-name":"getRoutingSkill"},"delete":{"tags":["Routing"],"summary":"Delete Routing Skill","description":"","operationId":"deleteRoutingSkill","produces":["application/json"],"parameters":[{"name":"skillId","in":"path","description":"Skill ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:skill:manage"]},"x-purecloud-method-name":"deleteRoutingSkill"}},"/api/v2/authorization/roles/{roleId}/users/remove":{"put":{"tags":["Authorization"],"summary":"Removes the users from the role","description":"","operationId":"putAuthorizationRoleUsersRemove","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"},{"in":"body","name":"body","description":"List of user IDs","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"type":"string"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:delete"]},"x-purecloud-method-name":"putAuthorizationRoleUsersRemove"}},"/api/v2/authorization/roles/{roleId}/users/add":{"put":{"tags":["Authorization"],"summary":"Sets the users for the role","description":"","operationId":"putAuthorizationRoleUsersAdd","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"},{"in":"body","name":"body","description":"List of user IDs","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"type":"string"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:add"]},"x-purecloud-method-name":"putAuthorizationRoleUsersAdd"}},"/api/v2/authorization/roles/{roleId}/users":{"get":{"tags":["Authorization"],"summary":"Get a list of the users in a specified role.","description":"Get an array of the UUIDs of the users in the specified role.","operationId":"getAuthorizationRoleUsers","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-purecloud-method-name":"getAuthorizationRoleUsers"}},"/api/v2/alerting/interactionstats/alerts/{alertId}":{"get":{"tags":["Alerting"],"summary":"Get an interaction stats alert","description":"","operationId":"getAlertingInteractionstatsAlert","produces":["application/json"],"parameters":[{"name":"alertId","in":"path","description":"Alert ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["notificationUsers"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"notificationUsers"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InteractionStatsAlert"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting","alerting:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:alert:view"]},"x-purecloud-method-name":"getAlertingInteractionstatsAlert"},"put":{"tags":["Alerting"],"summary":"Update an interaction stats alert read status","description":"","operationId":"putAlertingInteractionstatsAlert","produces":["application/json"],"parameters":[{"name":"alertId","in":"path","description":"Alert ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["notificationUsers"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"notificationUsers"}]},{"in":"body","name":"body","description":"InteractionStatsAlert","required":true,"schema":{"$ref":"#/definitions/UnreadStatus"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UnreadStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:alert:edit"]},"x-purecloud-method-name":"putAlertingInteractionstatsAlert"},"delete":{"tags":["Alerting"],"summary":"Delete an interaction stats alert","description":"","operationId":"deleteAlertingInteractionstatsAlert","produces":["application/json"],"parameters":[{"name":"alertId","in":"path","description":"Alert ID","required":true,"type":"string"}],"responses":{"204":{"description":"Interaction stats alert deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:alert:delete"]},"x-purecloud-method-name":"deleteAlertingInteractionstatsAlert"}},"/api/v2/users/{userId}/outofoffice":{"get":{"tags":["Users"],"summary":"Get a OutOfOffice","description":"","operationId":"getUserOutofoffice","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutOfOffice"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.usernotfound":"User was not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getUserOutofoffice"},"put":{"tags":["Users"],"summary":"Update an OutOfOffice","description":"","operationId":"putUserOutofoffice","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The updated OutOffOffice","required":true,"schema":{"$ref":"#/definitions/OutOfOffice"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutOfOffice"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-purecloud-method-name":"putUserOutofoffice"}},"/api/v2/telephony/providers/edges/didpools/dids":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a listing of unassigned and/or assigned numbers in a set of DID Pools.","description":"","operationId":"getTelephonyProvidersEdgesDidpoolsDids","produces":["application/json"],"parameters":[{"name":"type","in":"query","description":"The type of numbers to return.","required":true,"type":"string","enum":["ASSIGNED_AND_UNASSIGNED","UNASSIGNED"],"x-genesys-enum-members":[{"name":"ASSIGNED_AND_UNASSIGNED"},{"name":"UNASSIGNED"}]},{"name":"id","in":"query","description":"Filter by a specific list of DID Pools. If this is not provided, numbers from all DID Pools will be returned.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"numberMatch","in":"query","description":"A number to filter the results by.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ascending"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DIDNumberEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesDidpoolsDids"}},"/api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get edge logical interfaces.","description":"Retrieve a list of all configured logical interfaces from a specific edge.","operationId":"getTelephonyProvidersEdgeLogicalinterfaces","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Field to expand in the response","required":false,"type":"array","items":{"type":"string","enum":["externalTrunkBaseAssignments","phoneTrunkBaseAssignments"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"externalTrunkBaseAssignments"},{"name":"phoneTrunkBaseAssignments"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LogicalInterfaceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgeLogicalinterfaces"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create an edge logical interface.","description":"Create","operationId":"postTelephonyProvidersEdgeLogicalinterfaces","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Logical interface","required":true,"schema":{"$ref":"#/definitions/DomainLogicalInterface"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainLogicalInterface"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","duplicate.value":"A logical interface with that vlanTagId already exists on this port.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgeLogicalinterfaces"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/search":{"post":{"tags":["Search","Knowledge"],"summary":"Search Documents","description":"","operationId":"postKnowledgeKnowledgebaseSearch","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/KnowledgeSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","min.length.expected":"The minimum characters for the query is 5","invalid.languagecode":"Language code must be of format lang-iso2 (eg: en-US)","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:knowledgebase:search"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseSearch"}},"/api/v2/users/{userId}/routinglanguages":{"get":{"tags":["Routing","Users"],"summary":"List routing language for user","description":"","operationId":"getUserRoutinglanguages","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ASC","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserLanguageEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"User not found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getUserRoutinglanguages"},"post":{"tags":["Routing","Users"],"summary":"Add routing language to user","description":"","operationId":"postUserRoutinglanguages","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Language","required":true,"schema":{"$ref":"#/definitions/UserRoutingLanguagePost"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserRoutingLanguage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","general.conflict":"Conflict adding route language to user"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:assign","routing:language:assign"]},"x-purecloud-method-name":"postUserRoutinglanguages"}},"/api/v2/users/{userId}/routinglanguages/bulk":{"patch":{"tags":["Routing","Users"],"summary":"Add bulk routing language to user. Max limit 50 languages","description":"","operationId":"patchUserRoutinglanguagesBulk","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Language","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/UserRoutingLanguagePost"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserLanguageEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:assign","routing:language:assign"]},"x-purecloud-method-name":"patchUserRoutinglanguagesBulk"}},"/api/v2/users/{userId}/routinglanguages/{languageId}":{"delete":{"tags":["Routing","Users"],"summary":"Remove routing language from user","description":"","operationId":"deleteUserRoutinglanguage","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"languageId","in":"path","description":"languageId","required":true,"type":"string"}],"responses":{"204":{"description":"Language removed"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Routing language was not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:assign","routing:language:assign"]},"x-purecloud-method-name":"deleteUserRoutinglanguage"},"patch":{"tags":["Routing","Users"],"summary":"Update routing language proficiency or state.","description":"","operationId":"patchUserRoutinglanguage","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"languageId","in":"path","description":"languageId","required":true,"type":"string"},{"in":"body","name":"body","description":"Language","required":true,"schema":{"$ref":"#/definitions/UserRoutingLanguage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserRoutingLanguage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Resource conflict - Unexpected version was provided","x-inin-error-codes":{"general.conflict":"The version supplied does not match the current version of the user"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:assign","routing:language:assign"]},"x-purecloud-method-name":"patchUserRoutinglanguage"}},"/api/v2/telephony/providers/edges/sites/{siteId}/numberplans/{numberPlanId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Number Plan by ID.","description":"","operationId":"getTelephonyProvidersEdgesSiteNumberplan","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"name":"numberPlanId","in":"path","description":"Number Plan ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NumberPlan"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Unable to find a number plan with that id","general.resource.not.found":"Unable to find a number plan with that id","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesSiteNumberplan"}},"/api/v2/architect/dependencytracking/updatedresourceconsumers":{"get":{"tags":["Architect"],"summary":"Get Dependency Tracking objects that depend on updated resources","description":"","operationId":"getArchitectDependencytrackingUpdatedresourceconsumers","produces":["application/json"],"parameters":[{"name":"name","in":"query","description":"Name to search for","required":false,"type":"string"},{"name":"objectType","in":"query","description":"Object type(s) to search for","required":false,"type":"array","items":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","BOTCONNECTORBOT","BOTCONNECTORBOTVERSION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GROUP","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","IVRCONFIGURATION","LANGUAGE","LEXBOT","LEXBOTALIAS","NLUDOMAIN","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","WIDGET","WORKFLOW"],"x-genesys-enum-members":[{"name":"ACDLANGUAGE"},{"name":"ACDSKILL"},{"name":"ACDWRAPUPCODE"},{"name":"BOTCONNECTORBOT"},{"name":"BOTCONNECTORBOTVERSION"},{"name":"BOTFLOW"},{"name":"BRIDGEACTION"},{"name":"COMMONMODULEFLOW"},{"name":"COMPOSERSCRIPT"},{"name":"CONTACTLIST"},{"name":"DATAACTION"},{"name":"DATATABLE"},{"name":"DIALOGENGINEBOT"},{"name":"DIALOGENGINEBOTVERSION"},{"name":"DIALOGFLOWAGENT"},{"name":"EMAILROUTE"},{"name":"EMERGENCYGROUP"},{"name":"FLOWACTION"},{"name":"FLOWDATATYPE"},{"name":"FLOWMILESTONE"},{"name":"FLOWOUTCOME"},{"name":"GROUP"},{"name":"INBOUNDCALLFLOW"},{"name":"INBOUNDCHATFLOW"},{"name":"INBOUNDEMAILFLOW"},{"name":"INBOUNDSHORTMESSAGEFLOW"},{"name":"INQUEUECALLFLOW"},{"name":"IVRCONFIGURATION"},{"name":"LANGUAGE"},{"name":"LEXBOT"},{"name":"LEXBOTALIAS"},{"name":"NLUDOMAIN"},{"name":"OUTBOUNDCALLFLOW"},{"name":"QUEUE"},{"name":"RECORDINGPOLICY"},{"name":"RESPONSE"},{"name":"SCHEDULE"},{"name":"SCHEDULEGROUP"},{"name":"SECUREACTION"},{"name":"SECURECALLFLOW"},{"name":"SURVEYINVITEFLOW"},{"name":"SYSTEMPROMPT"},{"name":"TTSENGINE"},{"name":"TTSVOICE"},{"name":"USER"},{"name":"USERPROMPT"},{"name":"WIDGET"},{"name":"WORKFLOW"}]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"ACDLANGUAGE"},{"name":"ACDSKILL"},{"name":"ACDWRAPUPCODE"},{"name":"BOTCONNECTORBOT"},{"name":"BOTCONNECTORBOTVERSION"},{"name":"BOTFLOW"},{"name":"BRIDGEACTION"},{"name":"COMMONMODULEFLOW"},{"name":"COMPOSERSCRIPT"},{"name":"CONTACTLIST"},{"name":"DATAACTION"},{"name":"DATATABLE"},{"name":"DIALOGENGINEBOT"},{"name":"DIALOGENGINEBOTVERSION"},{"name":"DIALOGFLOWAGENT"},{"name":"EMAILROUTE"},{"name":"EMERGENCYGROUP"},{"name":"FLOWACTION"},{"name":"FLOWDATATYPE"},{"name":"FLOWMILESTONE"},{"name":"FLOWOUTCOME"},{"name":"GROUP"},{"name":"INBOUNDCALLFLOW"},{"name":"INBOUNDCHATFLOW"},{"name":"INBOUNDEMAILFLOW"},{"name":"INBOUNDSHORTMESSAGEFLOW"},{"name":"INQUEUECALLFLOW"},{"name":"IVRCONFIGURATION"},{"name":"LANGUAGE"},{"name":"LEXBOT"},{"name":"LEXBOTALIAS"},{"name":"NLUDOMAIN"},{"name":"OUTBOUNDCALLFLOW"},{"name":"QUEUE"},{"name":"RECORDINGPOLICY"},{"name":"RESPONSE"},{"name":"SCHEDULE"},{"name":"SCHEDULEGROUP"},{"name":"SECUREACTION"},{"name":"SECURECALLFLOW"},{"name":"SURVEYINVITEFLOW"},{"name":"SYSTEMPROMPT"},{"name":"TTSENGINE"},{"name":"TTSVOICE"},{"name":"USER"},{"name":"USERPROMPT"},{"name":"WIDGET"},{"name":"WORKFLOW"}]},{"name":"consumedResources","in":"query","description":"Return consumed resources?","required":false,"type":"boolean","default":false},{"name":"consumedResourceType","in":"query","description":"Resource type(s) to return","required":false,"type":"array","items":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","BOTCONNECTORBOT","BOTCONNECTORBOTVERSION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GROUP","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","IVRCONFIGURATION","LANGUAGE","LEXBOT","LEXBOTALIAS","NLUDOMAIN","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","WIDGET","WORKFLOW"],"x-genesys-enum-members":[{"name":"ACDLANGUAGE"},{"name":"ACDSKILL"},{"name":"ACDWRAPUPCODE"},{"name":"BOTCONNECTORBOT"},{"name":"BOTCONNECTORBOTVERSION"},{"name":"BOTFLOW"},{"name":"BRIDGEACTION"},{"name":"COMMONMODULEFLOW"},{"name":"COMPOSERSCRIPT"},{"name":"CONTACTLIST"},{"name":"DATAACTION"},{"name":"DATATABLE"},{"name":"DIALOGENGINEBOT"},{"name":"DIALOGENGINEBOTVERSION"},{"name":"DIALOGFLOWAGENT"},{"name":"EMAILROUTE"},{"name":"EMERGENCYGROUP"},{"name":"FLOWACTION"},{"name":"FLOWDATATYPE"},{"name":"FLOWMILESTONE"},{"name":"FLOWOUTCOME"},{"name":"GROUP"},{"name":"INBOUNDCALLFLOW"},{"name":"INBOUNDCHATFLOW"},{"name":"INBOUNDEMAILFLOW"},{"name":"INBOUNDSHORTMESSAGEFLOW"},{"name":"INQUEUECALLFLOW"},{"name":"IVRCONFIGURATION"},{"name":"LANGUAGE"},{"name":"LEXBOT"},{"name":"LEXBOTALIAS"},{"name":"NLUDOMAIN"},{"name":"OUTBOUNDCALLFLOW"},{"name":"QUEUE"},{"name":"RECORDINGPOLICY"},{"name":"RESPONSE"},{"name":"SCHEDULE"},{"name":"SCHEDULEGROUP"},{"name":"SECUREACTION"},{"name":"SECURECALLFLOW"},{"name":"SURVEYINVITEFLOW"},{"name":"SYSTEMPROMPT"},{"name":"TTSENGINE"},{"name":"TTSVOICE"},{"name":"USER"},{"name":"USERPROMPT"},{"name":"WIDGET"},{"name":"WORKFLOW"}]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"ACDLANGUAGE"},{"name":"ACDSKILL"},{"name":"ACDWRAPUPCODE"},{"name":"BOTCONNECTORBOT"},{"name":"BOTCONNECTORBOTVERSION"},{"name":"BOTFLOW"},{"name":"BRIDGEACTION"},{"name":"COMMONMODULEFLOW"},{"name":"COMPOSERSCRIPT"},{"name":"CONTACTLIST"},{"name":"DATAACTION"},{"name":"DATATABLE"},{"name":"DIALOGENGINEBOT"},{"name":"DIALOGENGINEBOTVERSION"},{"name":"DIALOGFLOWAGENT"},{"name":"EMAILROUTE"},{"name":"EMERGENCYGROUP"},{"name":"FLOWACTION"},{"name":"FLOWDATATYPE"},{"name":"FLOWMILESTONE"},{"name":"FLOWOUTCOME"},{"name":"GROUP"},{"name":"INBOUNDCALLFLOW"},{"name":"INBOUNDCHATFLOW"},{"name":"INBOUNDEMAILFLOW"},{"name":"INBOUNDSHORTMESSAGEFLOW"},{"name":"INQUEUECALLFLOW"},{"name":"IVRCONFIGURATION"},{"name":"LANGUAGE"},{"name":"LEXBOT"},{"name":"LEXBOTALIAS"},{"name":"NLUDOMAIN"},{"name":"OUTBOUNDCALLFLOW"},{"name":"QUEUE"},{"name":"RECORDINGPOLICY"},{"name":"RESPONSE"},{"name":"SCHEDULE"},{"name":"SCHEDULEGROUP"},{"name":"SECUREACTION"},{"name":"SECURECALLFLOW"},{"name":"SURVEYINVITEFLOW"},{"name":"SYSTEMPROMPT"},{"name":"TTSENGINE"},{"name":"TTSVOICE"},{"name":"USER"},{"name":"USERPROMPT"},{"name":"WIDGET"},{"name":"WORKFLOW"}]},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DependencyObjectEntityListing"}},"206":{"description":"Partial Content - the org data is being rebuilt or needs to be rebuilt."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","architect.dependency.object.invalid.type":"An invalid dependency object type was specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.data.missing":"Flow version data content is missing.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","architect.database.throughput.exceeded":"Database too busy. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:dependencyTracking:view"]},"x-purecloud-method-name":"getArchitectDependencytrackingUpdatedresourceconsumers"}},"/api/v2/scim/v2/users/{userId}":{"get":{"tags":["SCIM"],"summary":"Get a user","description":"","operationId":"getScimV2User","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"name":"userId","in":"path","description":"The ID of a user. Returned with GET /api/v2/scim/v2/users.","required":true,"type":"string"},{"name":"attributes","in":"query","description":"Indicates which attributes to include. Returns these attributes and the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","userName","displayName","title","active","externalId","phoneNumbers","emails","groups","roles","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:User:id","urn:ietf:params:scim:schemas:core:2.0:User:userName","urn:ietf:params:scim:schemas:core:2.0:User:displayName","urn:ietf:params:scim:schemas:core:2.0:User:title","urn:ietf:params:scim:schemas:core:2.0:User:active","urn:ietf:params:scim:schemas:core:2.0:User:externalId","urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers","urn:ietf:params:scim:schemas:core:2.0:User:emails","urn:ietf:params:scim:schemas:core:2.0:User:groups","urn:ietf:params:scim:schemas:core:2.0:User:roles","urn:ietf:params:scim:schemas:core:2.0:User:meta","urn:ietf:params:scim:schemas:core:2.0:User:meta.version","urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"id"},{"name":"userName"},{"name":"displayName"},{"name":"title"},{"name":"active"},{"name":"externalId"},{"name":"phoneNumbers"},{"name":"emails"},{"name":"groups"},{"name":"roles"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:userName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:title"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:active"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:externalId"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:emails"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:groups"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:roles"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"},{"name":"id"},{"name":"userName"},{"name":"displayName"},{"name":"title"},{"name":"active"},{"name":"externalId"},{"name":"phoneNumbers"},{"name":"emails"},{"name":"groups"},{"name":"roles"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:userName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:title"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:active"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:externalId"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:emails"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:groups"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:roles"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"}]},{"name":"excludedAttributes","in":"query","description":"Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","userName","displayName","title","active","externalId","phoneNumbers","emails","groups","roles","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:User:id","urn:ietf:params:scim:schemas:core:2.0:User:userName","urn:ietf:params:scim:schemas:core:2.0:User:displayName","urn:ietf:params:scim:schemas:core:2.0:User:title","urn:ietf:params:scim:schemas:core:2.0:User:active","urn:ietf:params:scim:schemas:core:2.0:User:externalId","urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers","urn:ietf:params:scim:schemas:core:2.0:User:emails","urn:ietf:params:scim:schemas:core:2.0:User:groups","urn:ietf:params:scim:schemas:core:2.0:User:roles","urn:ietf:params:scim:schemas:core:2.0:User:meta","urn:ietf:params:scim:schemas:core:2.0:User:meta.version","urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"id"},{"name":"userName"},{"name":"displayName"},{"name":"title"},{"name":"active"},{"name":"externalId"},{"name":"phoneNumbers"},{"name":"emails"},{"name":"groups"},{"name":"roles"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:userName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:title"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:active"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:externalId"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:emails"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:groups"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:roles"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"},{"name":"id"},{"name":"userName"},{"name":"displayName"},{"name":"title"},{"name":"active"},{"name":"externalId"},{"name":"phoneNumbers"},{"name":"emails"},{"name":"groups"},{"name":"roles"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:userName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:title"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:active"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:externalId"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:emails"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:groups"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:roles"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"}]},{"name":"If-None-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2User"}},"304":{"description":"If-Non-Match header matches current version. No content returned."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"User could not be found.","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.conflict":"Conflict with existing user ID."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimV2User"},"put":{"tags":["SCIM"],"summary":"Replace a user","description":"","operationId":"putScimV2User","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"name":"userId","in":"path","description":"The ID of a user. Returned with GET /api/v2/scim/v2/users.","required":true,"type":"string"},{"name":"If-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".","required":false,"type":"string"},{"in":"body","name":"body","description":"The information used to replace a user.","required":true,"schema":{"$ref":"#/definitions/ScimV2User"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2User"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Version does not match current version.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:edit","directory:user:setPassword","authorization:grant:add","authorization:grant:delete","routing:skill:assign","routing:language:assign"]},"x-purecloud-method-name":"putScimV2User"},"delete":{"tags":["SCIM"],"summary":"Delete a user","description":"","operationId":"deleteScimV2User","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"name":"userId","in":"path","description":"The ID of a user. Returned with GET /api/v2/scim/v2/users.","required":true,"type":"string"},{"name":"If-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"204":{"description":"User Deleted with no content returned."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Version does not match current version.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:delete"]},"x-purecloud-method-name":"deleteScimV2User"},"patch":{"tags":["SCIM"],"summary":"Modify a user","description":"","operationId":"patchScimV2User","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"name":"userId","in":"path","description":"The ID of a user. Returned with GET /api/v2/scim/v2/users.","required":true,"type":"string"},{"name":"If-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".","required":false,"type":"string"},{"in":"body","name":"body","description":"The information used to modify a user.","required":true,"schema":{"$ref":"#/definitions/ScimV2PatchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2User"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Version does not match current version.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:edit","directory:user:setPassword","authorization:grant:add","authorization:grant:delete","routing:skill:assign","routing:language:assign"]},"x-purecloud-method-name":"patchScimV2User"}},"/api/v2/scim/v2/users":{"get":{"tags":["SCIM"],"summary":"Get a list of users","description":"To return all active users, do not use the filter parameter. To return inactive users, set the filter parameter to \"active eq false\". By default, returns SCIM attributes \"externalId\", \"enterprise-user:manager\", and \"roles\". To exclude these attributes, set the attributes parameter to \"id,active\" or the excludeAttributes parameter to \"externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\".","operationId":"getScimV2Users","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"name":"startIndex","in":"query","description":"The 1-based index of the first query result.","required":false,"type":"integer","default":1,"format":"int32"},{"name":"count","in":"query","description":"The requested number of items per page. A value of 0 returns \"totalResults\". A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the \"excludedAttributes\" or \"attributes\" query parameters to exclude or only include secondary lookup values such as \"externalId\", \"roles\", \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages\", or \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills\".","required":false,"type":"integer","default":25,"format":"int32"},{"name":"attributes","in":"query","description":"Indicates which attributes to include. Returns these attributes and the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","userName","displayName","title","active","externalId","phoneNumbers","emails","groups","roles","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:User:id","urn:ietf:params:scim:schemas:core:2.0:User:userName","urn:ietf:params:scim:schemas:core:2.0:User:displayName","urn:ietf:params:scim:schemas:core:2.0:User:title","urn:ietf:params:scim:schemas:core:2.0:User:active","urn:ietf:params:scim:schemas:core:2.0:User:externalId","urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers","urn:ietf:params:scim:schemas:core:2.0:User:emails","urn:ietf:params:scim:schemas:core:2.0:User:groups","urn:ietf:params:scim:schemas:core:2.0:User:roles","urn:ietf:params:scim:schemas:core:2.0:User:meta","urn:ietf:params:scim:schemas:core:2.0:User:meta.version","urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"id"},{"name":"userName"},{"name":"displayName"},{"name":"title"},{"name":"active"},{"name":"externalId"},{"name":"phoneNumbers"},{"name":"emails"},{"name":"groups"},{"name":"roles"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:userName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:title"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:active"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:externalId"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:emails"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:groups"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:roles"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"},{"name":"id"},{"name":"userName"},{"name":"displayName"},{"name":"title"},{"name":"active"},{"name":"externalId"},{"name":"phoneNumbers"},{"name":"emails"},{"name":"groups"},{"name":"roles"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:userName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:title"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:active"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:externalId"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:emails"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:groups"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:roles"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"}]},{"name":"excludedAttributes","in":"query","description":"Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","userName","displayName","title","active","externalId","phoneNumbers","emails","groups","roles","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:User:id","urn:ietf:params:scim:schemas:core:2.0:User:userName","urn:ietf:params:scim:schemas:core:2.0:User:displayName","urn:ietf:params:scim:schemas:core:2.0:User:title","urn:ietf:params:scim:schemas:core:2.0:User:active","urn:ietf:params:scim:schemas:core:2.0:User:externalId","urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers","urn:ietf:params:scim:schemas:core:2.0:User:emails","urn:ietf:params:scim:schemas:core:2.0:User:groups","urn:ietf:params:scim:schemas:core:2.0:User:roles","urn:ietf:params:scim:schemas:core:2.0:User:meta","urn:ietf:params:scim:schemas:core:2.0:User:meta.version","urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"id"},{"name":"userName"},{"name":"displayName"},{"name":"title"},{"name":"active"},{"name":"externalId"},{"name":"phoneNumbers"},{"name":"emails"},{"name":"groups"},{"name":"roles"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:userName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:title"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:active"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:externalId"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:emails"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:groups"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:roles"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"},{"name":"id"},{"name":"userName"},{"name":"displayName"},{"name":"title"},{"name":"active"},{"name":"externalId"},{"name":"phoneNumbers"},{"name":"emails"},{"name":"groups"},{"name":"roles"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:userName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:title"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:active"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:externalId"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:emails"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:groups"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:roles"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"}]},{"name":"filter","in":"query","description":"Filters results. If nothing is specified, returns all active users. Examples of valid values: \"id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\", \"userName eq search@sample.org\", \"manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\", \"email eq search@sample.org\", \"division eq divisionName\", \"externalId eq 167844\", \"active eq false\", \"employeeNumber eq 9876543210\".","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimUserListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimV2Users"},"post":{"tags":["SCIM"],"summary":"Create a user","description":"","operationId":"postScimV2Users","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"in":"body","name":"body","description":"The information used to create a user.","required":true,"schema":{"$ref":"#/definitions/ScimV2CreateUser"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2User"}},"201":{"description":"User Created.","schema":{"$ref":"#/definitions/ScimV2User"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"User name already in use by non-deleted user.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:add","authorization:grant:add","authorization:grant:delete","routing:skill:assign","routing:language:assign"]},"x-purecloud-method-name":"postScimV2Users"}},"/api/v2/users/{userId}/queues":{"get":{"tags":["Routing","Users"],"summary":"Get queues for user","description":"","operationId":"getUserQueues","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"joined","in":"query","description":"Is joined to the queue","required":false,"type":"boolean","default":true},{"name":"divisionId","in":"query","description":"Division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserQueueEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:view","routing:queue:join","routing:queueMember:manage"]},"x-purecloud-method-name":"getUserQueues"},"patch":{"tags":["Routing","Users"],"summary":"Join or unjoin a set of queues for a user","description":"","operationId":"patchUserQueues","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"User Queues","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/UserQueue"}}},{"name":"divisionId","in":"query","description":"Division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserQueueEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be processed due to invalid request data.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:join","routing:queueMember:manage"]},"x-purecloud-method-name":"patchUserQueues"}},"/api/v2/authorization/subjects/me":{"get":{"tags":["Authorization","Users"],"summary":"Returns a listing of roles and permissions for the currently authenticated user.","description":"","operationId":"getAuthorizationSubjectsMe","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuthzSubject"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-purecloud-method-name":"getAuthorizationSubjectsMe"}},"/api/v2/externalcontacts/organizations/{externalOrganizationId}/relationships":{"get":{"tags":["External Contacts"],"summary":"Fetch a relationship for an external organization","description":"","operationId":"getExternalcontactsOrganizationRelationships","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":20,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"which fields, if any, to expand","required":false,"type":"string","enum":["externalDataSources"],"x-genesys-enum-members":[{"name":"externalDataSources"}]},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RelationshipListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:view","externalContacts:externalOrganization:view"]},"x-purecloud-method-name":"getExternalcontactsOrganizationRelationships"}},"/api/v2/telephony/providers/edges/outboundroutes/{outboundRouteId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get outbound route","description":"","operationId":"getTelephonyProvidersEdgesOutboundroute","produces":["application/json"],"parameters":[{"name":"outboundRouteId","in":"path","description":"Outbound route ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutboundRoute"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesOutboundroute"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update outbound route","description":"","operationId":"putTelephonyProvidersEdgesOutboundroute","produces":["application/json"],"parameters":[{"name":"outboundRouteId","in":"path","description":"Outbound route ID","required":true,"type":"string"},{"in":"body","name":"body","description":"OutboundRoute","required":true,"schema":{"$ref":"#/definitions/OutboundRoute"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutboundRoute"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"required.field.missing":"A required field is missing a value.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","duplicate.value":"An outbound route with this name already exists.","address.classification.type.does.not.exist":"One of the address classifications does not exist.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesOutboundroute"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete Outbound Route","description":"","operationId":"deleteTelephonyProvidersEdgesOutboundroute","produces":["application/json"],"parameters":[{"name":"outboundRouteId","in":"path","description":"Outbound route ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdgesOutboundroute"}},"/api/v2/alerting/interactionstats/alerts/unread":{"get":{"tags":["Alerting"],"summary":"Gets user unread count of interaction stats alerts.","description":"","operationId":"getAlertingInteractionstatsAlertsUnread","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UnreadMetric"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting","alerting:readonly"]}],"x-purecloud-method-name":"getAlertingInteractionstatsAlertsUnread"}},"/api/v2/outbound/messagingcampaigns/divisionviews/{messagingCampaignId}":{"get":{"tags":["Outbound"],"summary":"Get a basic Messaging Campaign information object","description":"This returns a simplified version of a Messaging Campaign, consisting of id, name, and division.","operationId":"getOutboundMessagingcampaignsDivisionview","produces":["application/json"],"parameters":[{"name":"messagingCampaignId","in":"path","description":"The Messaging Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingCampaignDivisionView"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:messagingCampaign:search"]},"x-purecloud-method-name":"getOutboundMessagingcampaignsDivisionview"}},"/api/v2/contentmanagement/usage":{"get":{"tags":["Content Management"],"summary":"Get usage details.","description":"","operationId":"getContentmanagementUsage","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Usage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementUsage"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories":{"get":{"tags":["Knowledge"],"summary":"Get categories","description":"","operationId":"getKnowledgeKnowledgebaseLanguageCategories","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","de-DE"],"x-genesys-enum-members":[{"name":"en-US"},{"name":"de-DE"}]},{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"limit","in":"query","description":"Number of entities to return. Maximum of 200. Deprecated in favour of pageSize.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"name":"name","in":"query","description":"Filter to return the categories that starts with the given category name.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CategoryListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","input.validations":"Input parameters do not match the required criteria","kb.not.found":"Knowledge Base does not exist","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:category:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseLanguageCategories"},"post":{"tags":["Knowledge"],"summary":"Create new category","description":"","operationId":"postKnowledgeKnowledgebaseLanguageCategories","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","de-DE"],"x-genesys-enum-members":[{"name":"en-US"},{"name":"de-DE"}]},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeCategoryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeExtendedCategory"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","parent.category.not.found":"Parent category does not exist","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","input.validations":"Input parameters do not match the required criteria","kb.not.found":"Knowledge Base does not exist","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:category:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseLanguageCategories"}},"/api/v2/geolocations/settings":{"get":{"tags":["Geolocation"],"summary":"Get a organization's GeolocationSettings","description":"","operationId":"getGeolocationsSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GeolocationSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["geolocation","geolocation:readonly"]}],"x-purecloud-method-name":"getGeolocationsSettings"},"patch":{"tags":["Geolocation"],"summary":"Patch a organization's GeolocationSettings","description":"","operationId":"patchGeolocationsSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Geolocation settings","required":true,"schema":{"$ref":"#/definitions/GeolocationSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GeolocationSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["geolocation"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["geolocation:settings:edit"]},"x-purecloud-method-name":"patchGeolocationsSettings"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/managementunits":{"get":{"tags":["Workforce Management"],"summary":"Get all authorized management units in the business unit","description":"","operationId":"getWorkforcemanagementBusinessunitManagementunits","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit, or 'mine' for the business unit of the logged-in user.","required":true,"type":"string"},{"name":"feature","in":"query","required":false,"type":"string","enum":["AgentSchedule","AgentTimeOffRequest","Coaching","ActivityCodes","Agents","BuActivityCodes","BusinessUnits","HistoricalAdherence","IntradayMonitoring","BuIntradayMonitoring","ManagementUnits","RealTimeAdherence","Schedules","BuSchedules","ServiceGoalGroups","ServiceGoalTemplates","PlanningGroups","ShiftTrading","ShortTermForecasts","BuShortTermForecasts","TimeOffRequests","WorkPlanRotations","WorkPlans"],"x-genesys-enum-members":[{"name":"AgentSchedule"},{"name":"AgentTimeOffRequest"},{"name":"Coaching"},{"name":"ActivityCodes"},{"name":"Agents"},{"name":"BuActivityCodes"},{"name":"BusinessUnits"},{"name":"HistoricalAdherence"},{"name":"IntradayMonitoring"},{"name":"BuIntradayMonitoring"},{"name":"ManagementUnits"},{"name":"RealTimeAdherence"},{"name":"Schedules"},{"name":"BuSchedules"},{"name":"ServiceGoalGroups"},{"name":"ServiceGoalTemplates"},{"name":"PlanningGroups"},{"name":"ShiftTrading"},{"name":"ShortTermForecasts"},{"name":"BuShortTermForecasts"},{"name":"TimeOffRequests"},{"name":"WorkPlanRotations"},{"name":"WorkPlans"}]},{"name":"divisionId","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ManagementUnitListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.server.error":"WFM Server Error","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-purecloud-method-name":"getWorkforcemanagementBusinessunitManagementunits"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}":{"get":{"tags":["Workforce Management"],"summary":"Get business unit","description":"Expanding \"settings\" will retrieve all settings. All other expands will retrieve only the requested settings field(s).","operationId":"getWorkforcemanagementBusinessunit","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit, or 'mine' for the business unit of the logged-in user.","required":true,"type":"string"},{"name":"expand","in":"query","required":false,"type":"array","items":{"type":"string","enum":["settings","settings.timeZone","settings.startDayOfWeek","settings.shortTermForecasting"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"settings"},{"name":"settings.timeZone"},{"name":"settings.startDayOfWeek"},{"name":"settings.shortTermForecasting"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BusinessUnit"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:activityCode:add","wfm:activityCode:delete","wfm:activityCode:edit","wfm:activityCode:view","wfm:agent:edit","wfm:agentSchedule:view","wfm:agentTimeOffRequest:submit","wfm:agent:view","wfm:businessUnit:add","wfm:businessUnit:delete","wfm:businessUnit:edit","wfm:businessUnit:view","wfm:historicalAdherence:view","wfm:intraday:view","wfm:managementUnit:add","wfm:managementUnit:delete","wfm:managementUnit:edit","wfm:managementUnit:view","wfm:publishedSchedule:view","wfm:realtimeAdherence:view","wfm:schedule:add","wfm:schedule:delete","wfm:schedule:edit","wfm:schedule:generate","wfm:schedule:view","wfm:serviceGoalTemplate:add","wfm:serviceGoalTemplate:delete","wfm:serviceGoalTemplate:edit","wfm:serviceGoalTemplate:view","wfm:planningGroup:add","wfm:planningGroup:delete","wfm:planningGroup:edit","wfm:planningGroup:view","wfm:shiftTradeRequest:edit","wfm:shiftTradeRequest:view","wfm:agentShiftTradeRequest:participate","wfm:shortTermForecast:add","wfm:shortTermForecast:delete","wfm:shortTermForecast:edit","wfm:shortTermForecast:view","wfm:timeOffRequest:add","wfm:timeOffRequest:edit","wfm:timeOffRequest:view","wfm:workPlan:add","wfm:workPlan:delete","wfm:workPlan:edit","wfm:workPlan:view","wfm:workPlanRotation:add","wfm:workPlanRotation:delete","wfm:workPlanRotation:edit","wfm:workPlanRotation:view","coaching:appointment:add","coaching:appointment:edit"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunit"},"delete":{"tags":["Workforce Management"],"summary":"Delete business unit","description":"A business unit cannot be deleted if it contains one or more management units","operationId":"deleteWorkforcemanagementBusinessunit","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit, or 'mine' for the business unit of the logged-in user.","required":true,"type":"string"}],"responses":{"204":{"description":"The business unit was successfully deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.server.error":"WFM Server Error","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:businessUnit:delete"]},"x-purecloud-method-name":"deleteWorkforcemanagementBusinessunit"},"patch":{"tags":["Workforce Management"],"summary":"Update business unit","description":"","operationId":"patchWorkforcemanagementBusinessunit","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit, or 'mine' for the business unit of the logged-in user.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/UpdateBusinessUnitRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BusinessUnit"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Entity was modified by another request"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:businessUnit:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementBusinessunit"}},"/api/v2/telephony/providers/edges/didpools":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a listing of DID Pools","description":"","operationId":"getTelephonyProvidersEdgesDidpools","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"number"},{"name":"id","in":"query","description":"Filter by a specific list of ID's","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DIDPoolEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesDidpools"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a new DID pool","description":"","operationId":"postTelephonyProvidersEdgesDidpools","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"DID pool","required":true,"schema":{"$ref":"#/definitions/DIDPool"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DIDPool"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be completed by the server due to a conflict."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesDidpools"}},"/api/v2/externalcontacts/contacts/schemas":{"get":{"tags":["External Contacts"],"summary":"Get a list of schemas.","description":"","operationId":"getExternalcontactsContactsSchemas","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchemaListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"Unable to expand the schema."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getExternalcontactsContactsSchemas"},"post":{"tags":["External Contacts"],"summary":"Create a schema","description":"","operationId":"postExternalcontactsContactsSchemas","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Schema","required":true,"schema":{"$ref":"#/definitions/DataSchema"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.limit.max.number.of.fields.per.org.would.be.exceeded":"The total number of fields defined for all schemas would exceed 500.","dynamic.schema.limit.max.number.of.schemas.per.org.would.be.exceeded":"There cannot be more than 20 schemas.","bad.request":"The request could not be understood by the server due to malformed syntax.","dynamic.schema.invalid.json.schema":"An invalid JSON schema was provided.","dynamic.schema.limit.max.number.of.fields.per.schema.would.be.exceeded":"A schema cannot have more than 25 fields","dynamic.schema.validation.limit.error":"The schema has a validation limit error.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","dynamic.schema.incompatible.json.schema.update":"The JSON schema provided for update is incompatible with the previous version.","dynamic.schema.limit.max.number.of.characters.for.field.name.would.be.exceeded":"A field name cannot exceed 100 characters","dynamic.schema.validation.limit.missing":"The schema is missing a validation limit.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","dynamic.schema.length.limits.would.be.exceeded":"The schema title should not exceed 50 characters. The schema description should not exceed 200 characters.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.version.conflict":"A valid version is required."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"Unable to expand the schema."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:add"]},"x-purecloud-method-name":"postExternalcontactsContactsSchemas"}},"/api/v2/orgauthorization/trustors/{trustorOrgId}/users/{trusteeUserId}":{"get":{"tags":["Organization Authorization"],"summary":"Get Trustee User","description":"","operationId":"getOrgauthorizationTrustorUser","produces":["application/json"],"parameters":[{"name":"trustorOrgId","in":"path","description":"Trustor Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Trustee User Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustUser"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:view"]},"x-purecloud-method-name":"getOrgauthorizationTrustorUser"},"put":{"tags":["Organization Authorization"],"summary":"Add a Trustee user to the trust.","description":"","operationId":"putOrgauthorizationTrustorUser","produces":["application/json"],"parameters":[{"name":"trustorOrgId","in":"path","description":"Trustor Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Trustee User Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustUser"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.trustor.permissions":"Missing required permission(s)","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["authorization:orgTrusteeUser:add"]},"x-purecloud-method-name":"putOrgauthorizationTrustorUser"},"delete":{"tags":["Organization Authorization"],"summary":"Delete Trustee User","description":"","operationId":"deleteOrgauthorizationTrustorUser","produces":["application/json"],"parameters":[{"name":"trustorOrgId","in":"path","description":"Trustor Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Trustee User Id","required":true,"type":"string"}],"responses":{"204":{"description":"Trust deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.trustor.permissions":"Missing required permission(s)","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:delete"]},"x-purecloud-method-name":"deleteOrgauthorizationTrustorUser"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/activitycodes":{"get":{"tags":["Workforce Management"],"summary":"Get activity codes","description":"","operationId":"getWorkforcemanagementManagementunitActivitycodes","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActivityCodeContainer"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:activityCode:add","wfm:activityCode:delete","wfm:activityCode:edit","wfm:activityCode:view","wfm:agent:edit","wfm:agentSchedule:view","wfm:agentTimeOffRequest:submit","wfm:agent:view","wfm:businessUnit:add","wfm:businessUnit:delete","wfm:businessUnit:edit","wfm:businessUnit:view","wfm:historicalAdherence:view","wfm:intraday:view","wfm:managementUnit:add","wfm:managementUnit:delete","wfm:managementUnit:edit","wfm:managementUnit:view","wfm:publishedSchedule:view","wfm:realtimeAdherence:view","wfm:schedule:add","wfm:schedule:delete","wfm:schedule:edit","wfm:schedule:generate","wfm:schedule:view","wfm:serviceGoalGroup:add","wfm:serviceGoalGroup:delete","wfm:serviceGoalGroup:edit","wfm:serviceGoalGroup:view","wfm:shortTermForecast:add","wfm:shortTermForecast:delete","wfm:shortTermForecast:edit","wfm:shortTermForecast:view","wfm:timeOffRequest:add","wfm:timeOffRequest:edit","wfm:timeOffRequest:view","wfm:workPlan:add","wfm:workPlan:delete","wfm:workPlan:edit","wfm:workPlan:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitActivitycodes"}},"/api/v2/contentmanagement/query":{"get":{"tags":["Content Management"],"summary":"Query content","description":"","operationId":"getContentmanagementQuery","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"name or dateCreated","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"ascending or descending","required":false,"type":"string","default":"ascending"},{"name":"queryPhrase","in":"query","description":"Phrase tokens are ANDed together over all searchable fields","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["acl","workspace"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"acl"},{"name":"workspace"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueryResults"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementQuery"},"post":{"tags":["Content Management"],"summary":"Query content","description":"","operationId":"postContentmanagementQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Allows for a filtered query returning facet information","required":true,"schema":{"$ref":"#/definitions/QueryRequest"}},{"name":"expand","in":"query","description":"Expand some document fields","required":false,"type":"string","enum":["acl","workspace"],"x-genesys-enum-members":[{"name":"acl"},{"name":"workspace"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueryResults"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","trustee.forbidden":"Forbidden due to trustee from deleting query content.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden from deleting query content."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"postContentmanagementQuery"}},"/api/v2/architect/prompts":{"get":{"tags":["Architect"],"summary":"Get a pageable list of user prompts","description":"The returned list is pageable, and query parameters can be used for filtering. Multiple names can be specified, in which case all matching prompts will be returned, and no other filters will be evaluated.","operationId":"getArchitectPrompts","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"description","in":"query","description":"Description","required":false,"type":"string"},{"name":"nameOrDescription","in":"query","description":"Name or description","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"id"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PromptEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","architect.unspecified.error":"An unspecified error has occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:view"]},"x-purecloud-method-name":"getArchitectPrompts"},"post":{"tags":["Architect"],"summary":"Create a new user prompt","description":"","operationId":"postArchitectPrompts","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Prompt"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Prompt"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.validate.failed.invalid.name":"Failed to validate prompt due to invalid name. Prompt names can only contain letters, numbers, and the underscore, and must start with a letter or number.","architect.prompt.resource.validate.failed.language":"Failed to validate prompt resource due to missing or invalid language.","architect.prompt.resource.invalid.tags":"The specified tags are in an invalid format.","bad.request":"The request could not be understood by the server due to malformed syntax.","architect.prompt.validate.failed":"Failed to validate prompt.","architect.object.validate.failed":"Failed to validate object.","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","architect.prompt.resource.validate.failed":"Failed to validate prompt resource.","architect.prompt.validate.failed.name.no.alpha":"Failed to validate prompt due to invalid name. Names must contain at least one alphanumeric character.","architect.prompt.validate.failed.missing.name":"Failed to validate prompt due to missing name.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.already.exists":"A prompt with the specified name already exists."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:add"]},"x-purecloud-method-name":"postArchitectPrompts"},"delete":{"tags":["Architect"],"summary":"Batch-delete a list of prompts","description":"Multiple IDs can be specified, in which case all specified prompts will be deleted. Asynchronous. Notification topic: v2.architect.prompts.{promptId}","operationId":"deleteArchitectPrompts","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"List of Prompt IDs","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Operation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","architect.batch.too.large":"Batch size exceeds the maximum allowable size.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","architect.batch.delete.failed":"At least one prompt could not be deleted as requested.","architect.query.parameter.missing":"A required query parameter is missing or empty."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.not.found":"Could not find prompt with specified ID.","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.operation.already.in.progress":"An operation is already in progress on the object."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.unspecified.error":"An unknown error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:delete"]},"x-purecloud-method-name":"deleteArchitectPrompts"}},"/api/v2/flows/outcomes/{flowOutcomeId}":{"get":{"tags":["Architect"],"summary":"Get a flow outcome","description":"Returns a specified flow outcome","operationId":"getFlowsOutcome","produces":["application/json"],"parameters":[{"name":"flowOutcomeId","in":"path","description":"flow outcome ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowOutcome"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.outcome.not.found":"Specified flow outcome not found.","not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.feature.toggle.unavailable":"The required feature toggle is not enabled for this organization.","architect.flow.outcome.not.available":"Flow outcomes are not available for current organization."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowOutcome:view"]},"x-purecloud-method-name":"getFlowsOutcome"},"put":{"tags":["Architect"],"summary":"Updates a flow outcome","description":"Updates a flow outcome. Asynchronous. Notification topic: v2.flowoutcomes.{flowoutcomeId}","operationId":"putFlowsOutcome","produces":["application/json"],"parameters":[{"name":"flowOutcomeId","in":"path","description":"flow outcome ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/FlowOutcome"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Operation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","architect.flow.outcome.validate.failed.invalid.name":"Failed to validate flow outcome due to invalid name. Names can only contain letters, numbers, and the underscore, and must start with a letter or number.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","architect.property.exceeds.max.character.length":"The name and/or description exceeds the maximum character length.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","architect.flow.outcome.validate.failed.missing.description":"Failed to validate flow outcome due to missing description.","architect.object.validate.failed":"Failed to validate object.","architect.flow.outcome.validate.failed.invalid.name.no.alpha":"Failed to validate flow outcome due to invalid name. Names must contain at least one alphanumeric character.","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","architect.query.parameter.missing":"A required query parameter is missing or empty.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.outcome.not.found":"Could not find the specified flow outcome.","not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.feature.toggle.unavailable":"The required feature toggle is not enabled for this organization.","architect.flow.outcome.not.available":"Flow outcomes are not available for current organization."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.operation.already.in.progress":"An operation is already in progress on the object."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.unspecified.error":"An unknown error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowOutcome:edit"]},"x-purecloud-method-name":"putFlowsOutcome"}},"/api/v2/authorization/subjects/{subjectId}/bulkadd":{"post":{"tags":["Authorization","Users"],"summary":"Bulk-grant roles and divisions to a subject.","description":"","operationId":"postAuthorizationSubjectBulkadd","produces":["application/json"],"parameters":[{"name":"subjectId","in":"path","description":"Subject ID (user or group)","required":true,"type":"string"},{"in":"body","name":"body","description":"Pairs of role and division IDs","required":true,"schema":{"$ref":"#/definitions/RoleDivisionGrants"}},{"name":"subjectType","in":"query","description":"what the type of the subject is (PC_GROUP, PC_USER or PC_OAUTH_CLIENT)","required":false,"type":"string","default":"PC_USER"}],"responses":{"204":{"description":"Bulk Grants Created"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{".bad.role.divisions":"Invalid role divisions in request.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:add"]},"x-purecloud-method-name":"postAuthorizationSubjectBulkadd"}},"/api/v2/authorization/subjects/{subjectId}/divisions/{divisionId}/roles/{roleId}":{"post":{"tags":["Authorization","Users"],"summary":"Make a grant of a role in a division","description":"","operationId":"postAuthorizationSubjectDivisionRole","produces":["application/json"],"parameters":[{"name":"subjectId","in":"path","description":"Subject ID (user or group)","required":true,"type":"string"},{"name":"divisionId","in":"path","description":"the id of the division to which to make the grant","required":true,"type":"string"},{"name":"roleId","in":"path","description":"the id of the role to grant","required":true,"type":"string"},{"name":"subjectType","in":"query","description":"what the type of the subject is: PC_GROUP, PC_USER or PC_OAUTH_CLIENT (note: for cross-org authorization, please use the Organization Authorization endpoints)","required":false,"type":"string","default":"PC_USER"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:add"]},"x-purecloud-method-name":"postAuthorizationSubjectDivisionRole"},"delete":{"tags":["Authorization","Users"],"summary":"Delete a grant of a role in a division","description":"","operationId":"deleteAuthorizationSubjectDivisionRole","produces":["application/json"],"parameters":[{"name":"subjectId","in":"path","description":"Subject ID (user or group)","required":true,"type":"string"},{"name":"divisionId","in":"path","description":"the id of the division of the grant","required":true,"type":"string"},{"name":"roleId","in":"path","description":"the id of the role of the grant","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:delete"]},"x-purecloud-method-name":"deleteAuthorizationSubjectDivisionRole"}},"/api/v2/authorization/subjects/{subjectId}/bulkremove":{"post":{"tags":["Authorization","Users"],"summary":"Bulk-remove grants from a subject.","description":"","operationId":"postAuthorizationSubjectBulkremove","produces":["application/json"],"parameters":[{"name":"subjectId","in":"path","description":"Subject ID (user or group)","required":true,"type":"string"},{"in":"body","name":"body","description":"Pairs of role and division IDs","required":true,"schema":{"$ref":"#/definitions/RoleDivisionGrants"}}],"responses":{"204":{"description":"Bulk Grants Deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:delete"]},"x-purecloud-method-name":"postAuthorizationSubjectBulkremove"}},"/api/v2/authorization/subjects/{subjectId}":{"get":{"tags":["Authorization","Users"],"summary":"Returns a listing of roles and permissions for a user.","description":"","operationId":"getAuthorizationSubject","produces":["application/json"],"parameters":[{"name":"subjectId","in":"path","description":"Subject ID (user or group)","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuthzSubject"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"An internal server error has ocurred."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:view"]},"x-purecloud-method-name":"getAuthorizationSubject"}},"/api/v2/outbound/schedules/campaigns/{campaignId}":{"get":{"tags":["Outbound"],"summary":"Get a dialer campaign schedule.","description":"","operationId":"getOutboundSchedulesCampaign","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The dialer campaign was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:schedule:view"]},"x-purecloud-method-name":"getOutboundSchedulesCampaign"},"put":{"tags":["Outbound"],"summary":"Update a new campaign schedule.","description":"","operationId":"putOutboundSchedulesCampaign","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"},{"in":"body","name":"body","description":"CampaignSchedule","required":true,"schema":{"$ref":"#/definitions/CampaignSchedule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update":"","invalid.interval.time":"","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","future.intervals.exceeded.limit":""}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The dialer campaign was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:schedule:edit"]},"x-purecloud-method-name":"putOutboundSchedulesCampaign"},"delete":{"tags":["Outbound"],"summary":"Delete a dialer campaign schedule.","description":"","operationId":"deleteOutboundSchedulesCampaign","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The dialer campaign was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:schedule:delete"]},"x-purecloud-method-name":"deleteOutboundSchedulesCampaign"}},"/api/v2/outbound/campaignrules":{"get":{"tags":["Outbound"],"summary":"Query Campaign Rule list","description":"","operationId":"getOutboundCampaignrules","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"allowEmptyResult","in":"query","description":"Whether to return an empty page when there are no results for that page","required":false,"type":"boolean","default":false},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"],"x-genesys-enum-members":[{"name":"Equals"},{"name":"RegEx"},{"name":"Contains"},{"name":"Prefix"},{"name":"LessThan"},{"name":"LessThanEqualTo"},{"name":"GreaterThan"},{"name":"GreaterThanEqualTo"},{"name":"BeginsWith"},{"name":"EndsWith"}]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignRuleEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaignRule:view"]},"x-purecloud-method-name":"getOutboundCampaignrules"},"post":{"tags":["Outbound"],"summary":"Create Campaign Rule","description":"","operationId":"postOutboundCampaignrules","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"CampaignRule","required":true,"schema":{"$ref":"#/definitions/CampaignRule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","cannot.create.enabled.campaign.rule":"Cannot create a rule that is enabled.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","missing.campaign.rule.conditions":"Campaign rule must have a condition.","invalid.campaign.rule.action.parameter":"Campaign rule action has an invalid parameter.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","missing.campaign.rule.condition.value":"Campaign rule condition must have an value.","missing.campaign.rule.entity":"Campaign rule must have an entity for conditions.","missing.campaign.rule.action.parameters":"Campaign rule action must have a parameter.","invalid.campaign.rule.condition.parameter":"Campaign rule condition has an invalid parameter.","missing.campaign.rule.condition.type":"Campaign rule condition must have a type.","invalid.campaign.rule.condition.value":"Campaign rule condition has an invalid value.","invalid.turn.on.campaign.action":"Campaign rule action cannot turn on a campaign/sequence based on that campaign/sequence's progress or agent count.","missing.campaign.rule.actions":"Campaign rule must have an action.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","missing.campaign.rule.action.entity":"At least one rule action entity is required.","incorrect.max.value":"Max values must be > 0 and one of them must be defined","invalid.campaign.rule.condition.operator":"Campaign rule condition has an invalid operator.","missing.campaign.rule.condition.parameters":"Campaign rule condition must have a parameter.","max.entity.count.reached":"The maximum campaign rule count has been reached.","missing.campaign.rule.action.type":"Campaign rule action must have a type.","invalid.external.campaign.dialingmode.transition":"Cannot change to/from external dialing mode to/from another dialing mode.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.dialing.mode.update":"Invalid dialing mode specified.","missing.campaign.rule.condition.operator":"Campaign rule condition must have an operator."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaignRule:add"]},"x-purecloud-method-name":"postOutboundCampaignrules"}},"/api/v2/license/organization":{"post":{"tags":["License"],"summary":"Update the organization's license assignments in a batch.","description":"","operationId":"postLicenseOrganization","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The license assignments to update.","required":false,"schema":{"$ref":"#/definitions/LicenseBatchAssignmentRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/LicenseUpdateStatus"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["license"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:add"]},"x-purecloud-method-name":"postLicenseOrganization"}},"/api/v2/routing/queues/me":{"get":{"tags":["Routing"],"summary":"Get a paged listing of queues the user is a member of.","description":"","operationId":"getRoutingQueuesMe","produces":["application/json"],"parameters":[{"name":"joined","in":"query","description":"Joined","required":false,"type":"boolean"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserQueueEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.page.number":"Invalid page number specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-purecloud-method-name":"getRoutingQueuesMe"}},"/api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/query":{"post":{"tags":["Content Management"],"summary":"Perform a prefix query on tags in the workspace","description":"","operationId":"postContentmanagementWorkspaceTagvaluesQuery","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/TagQueryRequest"}},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["acl"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"acl"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TagValueEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"postContentmanagementWorkspaceTagvaluesQuery"}},"/api/v2/oauth/clients":{"get":{"tags":["OAuth"],"summary":"The list of OAuth clients","description":"","operationId":"getOauthClients","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthClientEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"Application is not authorized for scope.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:view"]},"x-purecloud-method-name":"getOauthClients"},"post":{"tags":["OAuth"],"summary":"Create OAuth client","description":"The OAuth Grant/Client is required in order to create an authentication token and gain access to PureCloud. \nThe preferred authorizedGrantTypes is 'CODE' which requires applications to send a client ID and client secret. This is typically a web server. \nIf OAuth PKCE attributes will be used for a code grant, the grant type CODE_PKCE should be used. This will require PKCE challenge and verifier for authentication. \nIf the client is unable to secure the client secret then the 'TOKEN' grant type aka IMPLICIT should be used. This is would be for browser or mobile apps. \nIf a client is to be used outside of the context of a user then the 'CLIENT-CREDENTIALS' grant may be used. In this case the client must be granted roles \nvia the 'roleIds' field.","operationId":"postOauthClients","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Client","required":true,"schema":{"$ref":"#/definitions/OAuthClientRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthClient"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.client.scope":"Client scope is missing.","bad.client.role":"Client role is invalid.","bad.client.state":"New clients can only have an active state","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","auth.too.many.clients":"Too many clients exist in this organization.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","bad.grant.type":"Invalid grant type.","auth.invalid.scope":"Client has invalid scope","missing.client.roles":"Client roles and divisions are missing.","grant.type.required":"Grant type is required.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:add"]},"x-purecloud-method-name":"postOauthClients"}},"/api/v2/telephony/providers/edges/{edgeId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get edge.","description":"","operationId":"getTelephonyProvidersEdge","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Fields to expand in the response, comma-separated","required":false,"type":"array","items":{"type":"string","enum":["site"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"site"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Edge"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Edge was not found.","general.resource.not.found":"Edge was not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdge"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a edge.","description":"","operationId":"putTelephonyProvidersEdge","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Edge","required":true,"schema":{"$ref":"#/definitions/Edge"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Edge"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"cant.modify.edge.group":"Edge group cannot be modified when edge is in service.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","site.required":"The site field is missing a value.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","edge.group.required":"The edge group field is missing a value.","incorrect.fingerprint":"The provided edge fingerprint was not correct.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","fingerprint.too.early":"Fingerprint sent before awaiting fingerprint verification"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"editing.managed.property.not.allowed":"Editing managed properties is not allowed.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","managed.property.not.allowed":"Not allowed to modify a managed edge."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be completed by the server due to a conflict."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdge"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a edge.","description":"","operationId":"deleteTelephonyProvidersEdge","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Edge was not found.","general.resource.not.found":"Edge was not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdge"}},"/api/v2/stations/settings":{"get":{"tags":["Stations"],"summary":"Get an organization's StationSettings","description":"","operationId":"getStationsSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/StationSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["stations","stations:readonly"]}],"x-purecloud-method-name":"getStationsSettings"},"patch":{"tags":["Stations"],"summary":"Patch an organization's StationSettings","description":"","operationId":"patchStationsSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Station settings","required":true,"schema":{"$ref":"#/definitions/StationSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/StationSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["stations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"patchStationsSettings"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions":{"get":{"tags":["Conversations"],"summary":"Get a list of secure sessions for this participant.","description":"","operationId":"getConversationParticipantSecureivrsessions","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SecureSessionEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationParticipantSecureivrsessions"},"post":{"tags":["Conversations"],"summary":"Create secure IVR session. Only a participant in the conversation can invoke a secure IVR.","description":"","operationId":"postConversationParticipantSecureivrsessions","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/CreateSecureSession"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SecureSession"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationParticipantSecureivrsessions"}},"/api/v2/telephony/providers/edges/trunkbasesettings/template":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Trunk Base Settings instance template from a given make and model. This object can then be modified and saved as a new Trunk Base Settings instance","description":"","operationId":"getTelephonyProvidersEdgesTrunkbasesettingsTemplate","produces":["application/json"],"parameters":[{"name":"trunkMetabaseId","in":"query","description":"The id of a metabase object upon which to base this Trunk Base Settings","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesTrunkbasesettingsTemplate"}},"/api/v2/conversations/messaging/integrations/line":{"get":{"tags":["Conversations"],"summary":"Get a list of LINE messenger Integrations","description":"","operationId":"getConversationsMessagingIntegrationsLine","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LineIntegrationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:view"]},"x-purecloud-method-name":"getConversationsMessagingIntegrationsLine"},"post":{"tags":["Conversations"],"summary":"Create a LINE messenger Integration","description":"","operationId":"postConversationsMessagingIntegrationsLine","produces":["application/json"],"parameters":[{"name":"async","in":"query","description":"Create a LINE integration in an asynchronous manner. If the parameter value is true, this initiates the generation of a new LINE integration. An integration ID is returned, it can be used to query the integration. Check the integration's createStatus for Completed or Error to detect the create is finished.","required":false,"type":"boolean","default":false},{"in":"body","name":"body","description":"LineIntegrationRequest","required":true,"schema":{"$ref":"#/definitions/LineIntegrationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LineIntegration"}},"202":{"description":"Accepted - If async is true, the integration creation in progress.","schema":{"$ref":"#/definitions/LineIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.integration":"The integration request was invalid for this operation. One or more errors may be reported.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:add"]},"x-purecloud-method-name":"postConversationsMessagingIntegrationsLine"}},"/api/v2/alerting/interactionstats/rules/{ruleId}":{"get":{"tags":["Alerting"],"summary":"Get an interaction stats rule.","description":"","operationId":"getAlertingInteractionstatsRule","produces":["application/json"],"parameters":[{"name":"ruleId","in":"path","description":"Rule ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["notificationUsers"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"notificationUsers"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InteractionStatsRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting","alerting:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:rule:view"]},"x-purecloud-method-name":"getAlertingInteractionstatsRule"},"put":{"tags":["Alerting"],"summary":"Update an interaction stats rule","description":"","operationId":"putAlertingInteractionstatsRule","produces":["application/json"],"parameters":[{"name":"ruleId","in":"path","description":"Rule ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["notificationUsers"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"notificationUsers"}]},{"in":"body","name":"body","description":"AlertingRule","required":true,"schema":{"$ref":"#/definitions/InteractionStatsRule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InteractionStatsRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:rule:edit"]},"x-purecloud-method-name":"putAlertingInteractionstatsRule"},"delete":{"tags":["Alerting"],"summary":"Delete an interaction stats rule.","description":"","operationId":"deleteAlertingInteractionstatsRule","produces":["application/json"],"parameters":[{"name":"ruleId","in":"path","description":"Rule ID","required":true,"type":"string"}],"responses":{"204":{"description":"Interaction stats rule deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:rule:delete"]},"x-purecloud-method-name":"deleteAlertingInteractionstatsRule"}},"/api/v2/quality/surveys/scoring":{"post":{"tags":["Quality"],"summary":"Score survey","description":"","operationId":"postQualitySurveysScoring","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"surveyAndScoringSet","required":true,"schema":{"$ref":"#/definitions/SurveyFormAndScoringSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyScoringSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-purecloud-method-name":"postQualitySurveysScoring"}},"/api/v2/routing/queues/{queueId}/members":{"get":{"tags":["Routing"],"summary":"Get the members of this queue.","description":"","operationId":"getRoutingQueueMembers","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size [max 100]","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"routingStatus"},{"name":"presence"},{"name":"conversationSummary"},{"name":"outOfOffice"},{"name":"geolocation"},{"name":"station"},{"name":"authorization"},{"name":"lasttokenissued"},{"name":"authorization.unusedRoles"},{"name":"team"},{"name":"profileSkills"},{"name":"certifications"},{"name":"locations"},{"name":"groups"},{"name":"skills"},{"name":"languages"},{"name":"languagePreference"},{"name":"employerInfo"},{"name":"biography"}]},{"name":"joined","in":"query","description":"Filter by joined status","required":false,"type":"boolean"},{"name":"name","in":"query","description":"Filter by queue member name","required":false,"type":"string"},{"name":"profileSkills","in":"query","description":"Filter by profile skill","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"skills","in":"query","description":"Filter by skill","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"languages","in":"query","description":"Filter by language","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"routingStatus","in":"query","description":"Filter by routing status","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"presence","in":"query","description":"Filter by presence","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueMemberEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.page.number":"Invalid page number specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","missing.any.division.permissions":"At least one of the required division permissions is missing"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"external.service.error":"The server is currently unable to handle the request .","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:view","routing:queueMember:manage"]},"x-purecloud-method-name":"getRoutingQueueMembers"},"post":{"tags":["Routing"],"summary":"Bulk add or delete up to 100 queue members","description":"","operationId":"postRoutingQueueMembers","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Queue Members","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/WritableEntity"}}},{"name":"delete","in":"query","description":"True to delete queue members","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid request data. Make sure you submit a valid number of queue members.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","queue.size.limit":"Adding all requested members would exceed queue member limit.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","missing.any.division.permissions":"At least one of the required division permissions is missing"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"Specified queue could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:edit","routing:queueMember:manage"]},"x-purecloud-method-name":"postRoutingQueueMembers"},"patch":{"tags":["Routing"],"summary":"Join or unjoin a set of users for a queue","description":"","operationId":"patchRoutingQueueMembers","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Queue Members","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/QueueMember"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueMemberEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid request data. Make sure a valid number of queue members was submitted, and all have the joined property specified.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","missing.any.division.permissions":"At least one of the required division permissions is missing"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"Specified queue could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:edit","routing:queueMember:manage"]},"x-purecloud-method-name":"patchRoutingQueueMembers"}},"/api/v2/analytics/reporting/timeperiods":{"get":{"tags":["Analytics"],"summary":"Get a list of report time periods.","description":"","operationId":"getAnalyticsReportingTimeperiods","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"type":"string"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-purecloud-method-name":"getAnalyticsReportingTimeperiods"}},"/api/v2/flows/actions/unlock":{"post":{"tags":["Architect"],"summary":"Unlock flow","description":"Allows for unlocking a flow in the case where there is no flow configuration available, and thus a check-in will not unlock the flow. The user must have Architect Admin permissions to perform this action.","operationId":"postFlowsActionsUnlock","produces":["application/json"],"parameters":[{"name":"flow","in":"query","description":"Flow ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Flow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.admin.user":"The requesting user does not have the required Architect admin permission.","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.inbound.short.message.flow.invalid.operation":"Cannot perform requested operation on an inbound short message flow.","architect.debug.flow.invalid.operation":"Cannot perform requested operation on a debug flow.","architect.secure.call.flow.invalid.operation":"Cannot perform requested operation on a secure call flow.","architect.secure.call.flow.not.supported":"Secure call flows are not supported by the current product levels."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.object.update.failed":"The database update for the object failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:unlock"]},"x-purecloud-method-name":"postFlowsActionsUnlock"}},"/api/v2/flows/actions/publish":{"post":{"tags":["Architect"],"summary":"Publish flow","description":"Asynchronous. Notification topic: v2.flows.{flowId}","operationId":"postFlowsActionsPublish","produces":["application/json"],"parameters":[{"name":"flow","in":"query","description":"Flow ID","required":true,"type":"string"},{"name":"version","in":"query","description":"version","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Operation"}},"202":{"description":"Accepted - the publish has begun"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","architect.auth.token.missing":"This operation cannot be performed without an authorization token.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.data.missing":"Flow version data content is missing.","architect.flow.version.missing":"Specified flow version is missing.","not.found":"The requested resource was not found.","architect.flow.not.found":"Could not find flow with specified ID."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.inbound.short.message.flow.invalid.operation":"Cannot perform requested operation on an inbound short message flow.","architect.speech.flow.invalid.operation":"Cannot perform requested operation on a speech flow.","architect.debug.flow.invalid.operation":"Cannot perform requested operation on a debug flow.","architect.secure.call.flow.invalid.operation":"Cannot perform requested operation on a secure call flow.","architect.flow.cannot.publish.default":"Cannot publish default version of flow.","architect.secure.call.flow.not.supported":"Secure call flows are not supported by the current product levels."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.cannot.delete.used.in.ivr.configs":"Flow cannot be deleted due to being used by one or more IVR configurations.","architect.flow.cannot.publish.missing.dependencies":"Flow version cannot be published due to having one or more missing dependencies.","architect.flow.cannot.delete.used.in.email.routes":"Flow cannot be deleted due to being used by one or more email routes.","architect.flow.locked.by.user":"Flow is locked by another user.","architect.flow.cannot.checkin.missing.config":"Flow cannot be checked in because there is no saved configuration.","architect.operation.already.in.progress":"An operation is already in progress on the object.","architect.flow.cannot.delete.used.in.flows":"Flow cannot be deleted due to being used by one or more flows.","architect.flow.variable.missing":"Flow cannot be published because one or more variables are missing.","architect.flow.cannot.delete.used.in.queues":"Flow cannot be deleted due to being used by one or more queues.","architect.flow.cannot.delete.used.in.composer.scripts":"Flow cannot be deleted due to being used by one or more composer scripts."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.save.failed":"Could not save flow data to permanent storage.","architect.flow.data.invalid.format":"Flow version data content is in an invalid format.","architect.object.update.failed":"The database update for the object failed.","architect.external.flow.change.notification.error":"A backend service error occurred while sending out a flow change notification.","architect.external.call.failure":"A call to another backend service failed.","architect.unspecified.error":"An unknown error occurred.","architect.external.publish.error":"A backend service error occurred while publishing the flow.","architect.external.user.query.error":"Failed querying backend service for information on user.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","architect.database.throughput.exceeded":"Database too busy. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:unlock","architect:flow:publish"]},"x-purecloud-method-name":"postFlowsActionsPublish"}},"/api/v2/flows/actions/checkin":{"post":{"tags":["Architect"],"summary":"Check-in flow","description":"Asynchronous. Notification topic: v2.flows.{flowId}","operationId":"postFlowsActionsCheckin","produces":["application/json"],"parameters":[{"name":"flow","in":"query","description":"Flow ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Operation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.inbound.short.message.flow.invalid.operation":"Cannot perform requested operation on an inbound short message flow.","architect.secure.call.flow.invalid.operation":"Cannot perform requested operation on a secure call flow."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.unspecified.error":"An unknown error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:edit","architect:flow:unlock"]},"x-purecloud-method-name":"postFlowsActionsCheckin"}},"/api/v2/flows/actions/revert":{"post":{"tags":["Architect"],"summary":"Revert flow","description":"","operationId":"postFlowsActionsRevert","produces":["application/json"],"parameters":[{"name":"flow","in":"query","description":"Flow ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Flow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.flow.not.found":"Could not find flow with specified ID."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.inbound.short.message.flow.invalid.operation":"Cannot perform requested operation on an inbound short message flow.","architect.debug.flow.invalid.operation":"Cannot perform requested operation on a debug flow.","architect.secure.call.flow.invalid.operation":"Cannot perform requested operation on a secure call flow.","architect.secure.call.flow.not.supported":"Secure call flows are not supported by the current product levels."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.not.locked.by.user":"Flow is not locked by requesting user."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.object.update.failed":"The database update for the object failed.","architect.external.user.query.error":"Failed querying backend service for information on user.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:edit"]},"x-purecloud-method-name":"postFlowsActionsRevert"}},"/api/v2/flows/actions/deactivate":{"post":{"tags":["Architect"],"summary":"Deactivate flow","description":"","operationId":"postFlowsActionsDeactivate","produces":["application/json"],"parameters":[{"name":"flow","in":"query","description":"Flow ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Flow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.flow.not.found":"Could not find flow with specified ID."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.inbound.short.message.flow.invalid.operation":"Cannot perform requested operation on an inbound short message flow.","architect.speech.flow.invalid.operation":"Cannot perform requested operation on a speech flow.","architect.debug.flow.invalid.operation":"Cannot perform requested operation on a debug flow.","architect.default.flow.cannot.deactivate":"Cannot deactivate the default in-queue flow.","architect.secure.call.flow.invalid.operation":"Cannot perform requested operation on a secure call flow.","architect.secure.call.flow.not.supported":"Secure call flows are not supported by the current product levels."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.cannot.deactivate.used.in.emergency.groups":"The flow cannot be deactivated because it's being used by one or more emergency groups.","architect.flow.cannot.deactivate.used.in.pe.action.maps":"The flow cannot be deactivated because it's being used by one or more predictive engagement action maps.","architect.flow.cannot.deactivate.used.in.queues":"The flow cannot be deactivated because it's being used by one or more queues.","architect.flow.cannot.deactivate.used.in.email.routes":"The flow cannot be deactivated because it's being used by one or more email routes.","architect.flow.cannot.deactivate.used.by.message.addresses":"The flow cannot be deactivated because it's being used by one or more message addresses.","architect.flow.cannot.deactivate.used.in.widgets":"The flow cannot be deactivated because it's being used by one or more widgets.","architect.flow.cannot.deactivate.used.in.ivr.configs":"The flow cannot be deactivated because it's being used by one or more IVR configurations.","architect.flow.cannot.deactivate.used.in.recording.policies":"The flow cannot be deactivated because it's being used by one or more recording policies.","architect.flow.cannot.deactivate.used.in.composer.scripts":"The flow cannot be deactivated because it's being used by one or more composer scripts."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.object.update.failed":"The database update for the object failed.","architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:publish"]},"x-purecloud-method-name":"postFlowsActionsDeactivate"}},"/api/v2/flows/actions/checkout":{"post":{"tags":["Architect"],"summary":"Check-out flow","description":"","operationId":"postFlowsActionsCheckout","produces":["application/json"],"parameters":[{"name":"flow","in":"query","description":"Flow ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Flow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.version.missing":"Specified flow version is missing.","not.found":"The requested resource was not found.","architect.flow.not.found":"Could not find flow with specified ID."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.inbound.short.message.flow.invalid.operation":"Cannot perform requested operation on an inbound short message flow.","architect.debug.flow.invalid.operation":"Cannot perform requested operation on a debug flow.","architect.secure.call.flow.invalid.operation":"Cannot perform requested operation on a secure call flow.","architect.secure.call.flow.not.supported":"Secure call flows are not supported by the current product levels."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.locked.by.user":"Flow is locked by another user."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.save.failed":"Could not save flow data to permanent storage.","architect.object.update.failed":"The database update for the object failed.","architect.external.user.query.error":"Failed querying backend service for information on user.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:edit"]},"x-purecloud-method-name":"postFlowsActionsCheckout"}},"/api/v2/routing/languages/{languageId}":{"get":{"tags":["Languages"],"summary":"Get language","description":"","operationId":"getRoutingLanguage","produces":["application/json"],"parameters":[{"name":"languageId","in":"path","description":"Language ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Language"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-purecloud-method-name":"getRoutingLanguage"},"delete":{"tags":["Languages"],"summary":"Delete Language","description":"","operationId":"deleteRoutingLanguage","produces":["application/json"],"parameters":[{"name":"languageId","in":"path","description":"Language ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:manage"]},"x-purecloud-method-name":"deleteRoutingLanguage"}},"/api/v2/routing/wrapupcodes/{codeId}":{"get":{"tags":["Routing"],"summary":"Get details about this wrap-up code.","description":"","operationId":"getRoutingWrapupcode","produces":["application/json"],"parameters":[{"name":"codeId","in":"path","description":"Wrapup Code ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:wrapupCode:view"]},"x-purecloud-method-name":"getRoutingWrapupcode"},"put":{"tags":["Routing"],"summary":"Update wrap-up code","description":"","operationId":"putRoutingWrapupcode","produces":["application/json"],"parameters":[{"name":"codeId","in":"path","description":"Wrapup Code ID","required":true,"type":"string"},{"in":"body","name":"body","description":"WrapupCode","required":true,"schema":{"$ref":"#/definitions/WrapupCode"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.name":"Invalid wrapup code name specified.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","duplicate.name":"A wrapup code with this name already exists.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:wrapupCode:edit"]},"x-purecloud-method-name":"putRoutingWrapupcode"},"delete":{"tags":["Routing"],"summary":"Delete wrap-up code","description":"","operationId":"deleteRoutingWrapupcode","produces":["application/json"],"parameters":[{"name":"codeId","in":"path","description":"Wrapup Code ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:wrapupCode:delete"]},"x-purecloud-method-name":"deleteRoutingWrapupcode"}},"/api/v2/outbound/attemptlimits":{"get":{"tags":["Outbound"],"summary":"Query attempt limits list","description":"","operationId":"getOutboundAttemptlimits","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"allowEmptyResult","in":"query","description":"Whether to return an empty page when there are no results for that page","required":false,"type":"boolean","default":false},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"],"x-genesys-enum-members":[{"name":"Equals"},{"name":"RegEx"},{"name":"Contains"},{"name":"Prefix"},{"name":"LessThan"},{"name":"LessThanEqualTo"},{"name":"GreaterThan"},{"name":"GreaterThanEqualTo"},{"name":"BeginsWith"},{"name":"EndsWith"}]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AttemptLimitsEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:attemptLimits:view"]},"x-purecloud-method-name":"getOutboundAttemptlimits"},"post":{"tags":["Outbound"],"summary":"Create attempt limits","description":"","operationId":"postOutboundAttemptlimits","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"AttemptLimits","required":true,"schema":{"$ref":"#/definitions/AttemptLimits"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AttemptLimits"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"incorrect.max.value":"Max values must be > 0 and one of them must be defined","name.cannot.be.blank":"A name must be provided.","max.entity.count.reached":"The maximum attempt limits count has been reached.","exceeded.max.attempts.per.contact":"The maximum attempts per contact limit is 100.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","duplicate.name":"The name already exists.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.time.zone":"Not recognized as a valid time zone.","exceeded.max.attempts.per.number":"The maximum attempts per number limit is 100.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:attemptLimits:add"]},"x-purecloud-method-name":"postOutboundAttemptlimits"}},"/api/v2/organizations/ipaddressauthentication":{"get":{"tags":["Organization"],"summary":"Get organization IP address whitelist settings","description":"","operationId":"getOrganizationsIpaddressauthentication","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IpAddressAuthentication"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:organization:admin"]},"x-purecloud-method-name":"getOrganizationsIpaddressauthentication"},"put":{"tags":["Organization"],"summary":"Update organization IP address whitelist settings","description":"","operationId":"putOrganizationsIpaddressauthentication","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"IP address Whitelist settings","required":true,"schema":{"$ref":"#/definitions/IpAddressAuthentication"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IpAddressAuthentication"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.issuing.ip.address":"IP address whitelisting cannot be configured with a token that was issued outside of the allowed ranges.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.ip.address":"IP address whitelisting cannot be configured from outside of the allowed ranges.","invalid.host.address":"IP address whitelisting cannot be configured via requests made to this host."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:organization:admin"]},"x-purecloud-method-name":"putOrganizationsIpaddressauthentication"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/codes/{addCommunicationCode}":{"delete":{"tags":["Conversations"],"summary":"Delete a code used to add a communication to this participant","description":"","operationId":"deleteConversationParticipantCode","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"name":"addCommunicationCode","in":"path","description":"addCommunicationCode","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"deleteConversationParticipantCode"}},"/api/v2/flows/datatables/{datatableId}":{"get":{"tags":["Architect"],"summary":"Returns a specific datatable by id","description":"Given a datatableId returns the datatable object and schema associated with it.","operationId":"getFlowsDatatable","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand instructions for the result","required":false,"type":"string","enum":["schema"],"x-genesys-enum-members":[{"name":"schema"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataTable"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","flows.datatables.syntax.error":"There was an error parsing user data","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.table.not.found":"The datatable could not be found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:view"]},"x-purecloud-method-name":"getFlowsDatatable"},"put":{"tags":["Architect"],"summary":"Updates a specific datatable by id","description":"Updates a schema for a datatable with the given datatableId -updates allow only new fields to be added in the schema, no changes or removals of existing fields.","operationId":"putFlowsDatatable","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand instructions for the result","required":false,"type":"string","enum":["schema"],"x-genesys-enum-members":[{"name":"schema"}]},{"in":"body","name":"body","description":"datatable json-schema","required":false,"schema":{"$ref":"#/definitions/DataTable"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataTable"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.cannot.remove.fields":"The updated schema had missing fields from the old schema (can't remove previously existing fields).","flows.datatables.too.many.properties":"The max number of properties allowed in a schema has been reached.","flows.datatables.schema.exception":"The schema is invalid in some way","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","flows.datatables.syntax.error":"There was an error parsing user data","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.table.not.found":"The datatable could not be found.","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.not.unique":"The passed in datatable had a duplicate name."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:edit"]},"x-purecloud-method-name":"putFlowsDatatable"},"delete":{"tags":["Architect"],"summary":"deletes a specific datatable by id","description":"Deletes an entire datatable (including the schema and data) with a given datatableId","operationId":"deleteFlowsDatatable","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"name":"force","in":"query","description":"force delete, even if in use","required":false,"type":"boolean","default":false}],"responses":{"204":{"description":"The datatable was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","flows.datatables.syntax.error":"There was an error parsing user data"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.possibly.in.use":"This datatable may be in use by a published flow.","flows.datatables.in.use":"This datatable is in use by a published flow."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:delete"]},"x-purecloud-method-name":"deleteFlowsDatatable"}},"/api/v2/telephony/providers/edges/{edgeId}/physicalinterfaces/{interfaceId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get edge physical interface.","description":"Retrieve a physical interface from a specific edge.","operationId":"getTelephonyProvidersEdgePhysicalinterface","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"interfaceId","in":"path","description":"Interface ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainPhysicalInterface"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgePhysicalinterface"}},"/api/v2/outbound/contactlists/{contactListId}/importstatus":{"get":{"tags":["Outbound"],"summary":"Get dialer contactList import status.","description":"","operationId":"getOutboundContactlistImportstatus","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"ContactList ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ImportStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactList:view"]},"x-purecloud-method-name":"getOutboundContactlistImportstatus"}},"/api/v2/conversations/{conversationId}/recordings":{"get":{"tags":["Recording"],"summary":"Get all of a Conversation's Recordings.","description":"","operationId":"getConversationRecordings","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"maxWaitMs","in":"query","description":"The maximum number of milliseconds to wait for the recording to be ready. Must be a positive value.","required":false,"type":"integer","default":5000,"format":"int32"},{"name":"formatId","in":"query","description":"The desired media format. Possible values: NONE, MP3, WAV, or WEBM","required":false,"type":"string","default":"WEBM","enum":["WAV","WEBM","WAV_ULAW","OGG_VORBIS","OGG_OPUS","MP3","NONE"],"x-genesys-enum-members":[{"name":"WAV"},{"name":"WEBM"},{"name":"WAV_ULAW"},{"name":"OGG_VORBIS"},{"name":"OGG_OPUS"},{"name":"MP3"},{"name":"NONE"}]}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/Recording"}}},"202":{"description":"Success - recording is transcoding"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.query.invalid.conversation":"Quality query has invalid conversation.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.recording.view.permission.check.failed":"The recording:recording:view permission is required.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","conversation.not.found":"A conversation for the provided conversationId was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["recording:recording:view"]},"x-purecloud-method-name":"getConversationRecordings"}},"/api/v2/telephony/providers/edges/availablelanguages":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of available languages.","description":"","operationId":"getTelephonyProvidersEdgesAvailablelanguages","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AvailableLanguageList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-purecloud-method-name":"getTelephonyProvidersEdgesAvailablelanguages"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}":{"get":{"tags":["Workforce Management"],"summary":"Get management unit","description":"","operationId":"getWorkforcemanagementManagementunit","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"expand","in":"query","required":false,"type":"array","items":{"type":"string","enum":["settings","settings.adherence","settings.timeOff","settings.scheduling","settings.shortTermForecasting","settings.shiftTrading"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"settings"},{"name":"settings.adherence"},{"name":"settings.timeOff"},{"name":"settings.scheduling"},{"name":"settings.shortTermForecasting"},{"name":"settings.shiftTrading"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ManagementUnit"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.server.error":"WFM Server Error","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:activityCode:add","wfm:activityCode:delete","wfm:activityCode:edit","wfm:activityCode:view","wfm:agent:edit","wfm:agentSchedule:view","wfm:agentTimeOffRequest:submit","wfm:agent:view","wfm:businessUnit:add","wfm:businessUnit:delete","wfm:businessUnit:edit","wfm:businessUnit:view","wfm:historicalAdherence:view","wfm:intraday:view","wfm:managementUnit:add","wfm:managementUnit:delete","wfm:managementUnit:edit","wfm:managementUnit:view","wfm:publishedSchedule:view","wfm:realtimeAdherence:view","wfm:schedule:add","wfm:schedule:delete","wfm:schedule:edit","wfm:schedule:generate","wfm:schedule:view","wfm:serviceGoalGroup:add","wfm:serviceGoalGroup:delete","wfm:serviceGoalGroup:edit","wfm:serviceGoalGroup:view","wfm:serviceGoalTemplate:add","wfm:serviceGoalTemplate:delete","wfm:serviceGoalTemplate:edit","wfm:serviceGoalTemplate:view","wfm:planningGroup:add","wfm:planningGroup:delete","wfm:planningGroup:edit","wfm:planningGroup:view","wfm:shiftTradeRequest:edit","wfm:shiftTradeRequest:view","wfm:agentShiftTradeRequest:participate","wfm:shortTermForecast:add","wfm:shortTermForecast:delete","wfm:shortTermForecast:edit","wfm:shortTermForecast:view","wfm:timeOffRequest:add","wfm:timeOffRequest:edit","wfm:timeOffRequest:view","wfm:workPlan:add","wfm:workPlan:delete","wfm:workPlan:edit","wfm:workPlan:view","wfm:workPlanRotation:add","wfm:workPlanRotation:delete","wfm:workPlanRotation:edit","wfm:workPlanRotation:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunit"},"delete":{"tags":["Workforce Management"],"summary":"Delete management unit","description":"","operationId":"deleteWorkforcemanagementManagementunit","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"}],"responses":{"204":{"description":"The management unit was successfully deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:managementUnit:delete"]},"x-purecloud-method-name":"deleteWorkforcemanagementManagementunit"},"patch":{"tags":["Workforce Management"],"summary":"Update the requested management unit","description":"","operationId":"patchWorkforcemanagementManagementunit","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/UpdateManagementUnitRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ManagementUnit"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.missing.one.of.permission.sets":"Unable to perform the requested action. You must have access to the division of the business unit or all requested management units containing permission sets.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Entity was modified by another request"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:managementUnit:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementManagementunit"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/move":{"post":{"tags":["Workforce Management"],"summary":"Move the requested management unit to a new business unit","description":"Returns status 200 if the management unit is already in the requested business unit","operationId":"postWorkforcemanagementManagementunitMove","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/MoveManagementUnitRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MoveManagementUnitResponse"}},"202":{"description":"The management unit is being moved","schema":{"$ref":"#/definitions/MoveManagementUnitResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.business.unit.not.found":"Business unit not found","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.missing.one.of.permission.sets":"Unable to perform the requested action. You must have access to the division of the business unit or all requested management units containing permission sets.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:managementUnit:edit"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitMove"}},"/api/v2/contentmanagement/documents/{documentId}/audits":{"get":{"tags":["Content Management"],"summary":"Get a list of audits for a document.","description":"","operationId":"getContentmanagementDocumentAudits","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"transactionFilter","in":"query","description":"Transaction filter","required":false,"type":"string"},{"name":"level","in":"query","description":"level","required":false,"type":"string","default":"USER"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ascending"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentAuditEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Unable to access document listing."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementDocumentAudits"}},"/api/v2/outbound/dnclists/divisionviews":{"get":{"tags":["Outbound"],"summary":"Query a list of simplified dnc list objects.","description":"This return a simplified version of dnc lists, consisting of the name, division, import status, and size.","operationId":"getOutboundDnclistsDivisionviews","produces":["application/json"],"parameters":[{"name":"includeImportStatus","in":"query","description":"Include import status","required":false,"type":"boolean","default":false},{"name":"includeSize","in":"query","description":"Include size","required":false,"type":"boolean","default":false},{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"],"x-genesys-enum-members":[{"name":"Equals"},{"name":"RegEx"},{"name":"Contains"},{"name":"Prefix"},{"name":"LessThan"},{"name":"LessThanEqualTo"},{"name":"GreaterThan"},{"name":"GreaterThanEqualTo"},{"name":"BeginsWith"},{"name":"EndsWith"}]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DncListDivisionViewListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.bulk.retrieves":"Only 100 dnc lists can be retrieved by id at a time","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:dncList:search"]},"x-purecloud-method-name":"getOutboundDnclistsDivisionviews"}},"/api/v2/outbound/audits":{"post":{"tags":["Outbound"],"summary":"Retrieves audits for dialer.","description":"","operationId":"postOutboundAudits","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"AuditSearch","required":true,"schema":{"$ref":"#/definitions/DialerAuditRequest"}},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"entity.name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ascending"},{"name":"facetsOnly","in":"query","description":"Facets only","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuditSearchResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:audit:view"]},"x-purecloud-method-name":"postOutboundAudits"}},"/api/v2/integrations":{"get":{"tags":["Integrations"],"summary":"List integrations","description":"","operationId":"getIntegrations","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IntegrationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-purecloud-method-name":"getIntegrations"},"post":{"tags":["Integrations"],"summary":"Create an integration.","description":"","operationId":"postIntegrations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Integration","required":false,"schema":{"$ref":"#/definitions/CreateIntegrationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Integration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","max.integrations.reached":"The maximum number of integrations for this type have already been created. One or more integrations must be removed before a new one can be created."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-purecloud-method-name":"postIntegrations"}},"/api/v2/languageunderstanding/domains/{domainId}":{"get":{"tags":["Language Understanding"],"summary":"Find an NLU Domain.","description":"","operationId":"getLanguageunderstandingDomain","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluDomain"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","dialog:readonly","language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomain:view","dialog:bot:view"]},"x-purecloud-method-name":"getLanguageunderstandingDomain"},"delete":{"tags":["Language Understanding"],"summary":"Delete an NLU Domain.","description":"","operationId":"deleteLanguageunderstandingDomain","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"}],"responses":{"204":{"description":""},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","language-understanding"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomain:delete","dialog:bot:delete"]},"x-purecloud-method-name":"deleteLanguageunderstandingDomain"},"patch":{"tags":["Language Understanding"],"summary":"Update an NLU Domain.","description":"","operationId":"patchLanguageunderstandingDomain","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"in":"body","name":"body","description":"The updated NLU Domain.","required":true,"schema":{"$ref":"#/definitions/NluDomain"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluDomain"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","language-understanding"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomain:edit","dialog:bot:edit"]},"x-purecloud-method-name":"patchLanguageunderstandingDomain"}},"/api/v2/webchat/guest/conversations":{"post":{"tags":["WebChat"],"summary":"Create an ACD chat conversation from an external customer.","description":"This endpoint will create a new ACD Chat conversation under the specified Chat Deployment.\n The conversation will begin with a guest member in it (with a role=CUSTOMER) according to the customer information that is supplied. If the guest member is authenticated, the 'memberAuthToken' field should include his JWT as generated by the 'POST /api/v2/signeddata' resource; if the guest member is anonymous (and the Deployment permits it) this field can be omitted.\n The returned data includes the IDs of the conversation created, along with a newly-create JWT token that you can supply to all future endpoints as authentication to perform operations against that conversation. After successfully creating a conversation, you should connect a websocket to the event stream named in the 'eventStreamUri' field of the response; the conversation is not routed until the event stream is attached.","operationId":"postWebchatGuestConversations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"CreateConversationRequest","required":true,"schema":{"$ref":"#/definitions/CreateWebChatConversationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CreateWebChatConversationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.notnull.createconversationrequest.journeycontext.customer":"The customer may not be null.","chat.error.notnull.createconversationrequest.journeycontext.customersession.sessionid":"The sessionid property may not be null.","chat.error.notnull.createconversationrequest.journeycontext.triggeringaction.actionmapversion":"The actionmapversion property may not be null.","chat.error.notnull.createconversationrequest.journeycontext.customersession.sessionidtype":"The sessionidtype property may not be null.","chat.deployment.bad.auth":"The customer member authentication has failed.","chat.error.notnull.createconversationrequest.journeycontext.triggeringaction.actionmapid":"The actionmapid property may not be null.","chat.error.invalid.queue":"The specified queue is not valid.","chat.error.notnull.createconversationrequest.journeycontext.triggeringaction.actionid":"The actionid property may not be null.","bad.request":"The request could not be understood by the server due to malformed syntax.","chat.error.createconversationrequest.routingtarget":"The routing target is not valid.","chat.error.notnull.createconversationrequest.journeycontext.customer.customerid":"The customerid property may not be null.","chat.deployment.disabled":"The web chat deployment is currently disabled.","chat.error.notnull.createconversationrequest.memberinfo.displayname":"The displayname property may not be null.","chat.error.pattern.createconversationrequest.deploymentid":"The deploymentid property may not be null.","chat.error.notnull.createconversationrequest.routingtarget":"The routingtarget property may not be null.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","chat.error.invalid.flow":"Invalid chat flow","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","chat.error.notnull.createconversationrequest.journeycontext.customer.customeridtype":"The customeridtype property may not be null.","chat.error.bad.request":"Error occurred due to invalid request.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","chat.deployment.require.auth":"The deployment requires the customer member to be authenticated."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"credentials.expired":"The supplied credentials are expired and cannot be used.","authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"origin.not.allowed":"Not allowed to create an ACD chat conversation from an external customer.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"caht.error":"Error performing chat conversation operation.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.service.timeout":"Chat service timeout error.","authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"postWebchatGuestConversations"}},"/api/v2/outbound/schedules/sequences/{sequenceId}":{"get":{"tags":["Outbound"],"summary":"Get a dialer sequence schedule.","description":"","operationId":"getOutboundSchedulesSequence","produces":["application/json"],"parameters":[{"name":"sequenceId","in":"path","description":"Sequence ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SequenceSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"campaign.sequence.not.found":"The campaign sequence was not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:schedule:view"]},"x-purecloud-method-name":"getOutboundSchedulesSequence"},"put":{"tags":["Outbound"],"summary":"Update a new sequence schedule.","description":"","operationId":"putOutboundSchedulesSequence","produces":["application/json"],"parameters":[{"name":"sequenceId","in":"path","description":"Sequence ID","required":true,"type":"string"},{"in":"body","name":"body","description":"SequenceSchedule","required":true,"schema":{"$ref":"#/definitions/SequenceSchedule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SequenceSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update":"","invalid.interval.time":"","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","future.intervals.exceeded.limit":""}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"campaign.sequence.not.found":"The campaign sequence was not found.","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.wrong.version":"The sequence schedule version does not match expected"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:schedule:edit"]},"x-purecloud-method-name":"putOutboundSchedulesSequence"},"delete":{"tags":["Outbound"],"summary":"Delete a dialer sequence schedule.","description":"","operationId":"deleteOutboundSchedulesSequence","produces":["application/json"],"parameters":[{"name":"sequenceId","in":"path","description":"Sequence ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"campaign.sequence.not.found":"The campaign sequence was not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:schedule:delete"]},"x-purecloud-method-name":"deleteOutboundSchedulesSequence"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/{agentId}":{"get":{"tags":["Workforce Management"],"summary":"Get data for agent in the management unit","description":"","operationId":"getWorkforcemanagementManagementunitAgent","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The id of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"agentId","in":"path","description":"The agent id","required":true,"type":"string"},{"name":"excludeCapabilities","in":"query","description":"Excludes all capabilities of the agent such as queues, languages, and skills","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WfmAgent"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agent:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitAgent"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/{agentId}/shifttrades":{"get":{"tags":["Workforce Management"],"summary":"Gets all the shift trades for a given agent","description":"","operationId":"getWorkforcemanagementManagementunitAgentShifttrades","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The id of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"agentId","in":"path","description":"The agent id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ShiftTradeListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:shiftTradeRequest:edit","wfm:shiftTradeRequest:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitAgentShifttrades"}},"/api/v2/recording/crossplatform/mediaretentionpolicies":{"get":{"tags":["Recording"],"summary":"Gets media retention policy list with query options to filter on name and enabled.","description":"for a less verbose response, add summary=true to this endpoint","operationId":"getRecordingCrossplatformMediaretentionpolicies","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"name","in":"query","description":"the policy name - used for filtering results in searches.","required":false,"type":"string"},{"name":"enabled","in":"query","description":"checks to see if policy is enabled - use enabled = true or enabled = false","required":false,"type":"boolean"},{"name":"summary","in":"query","description":"provides a less verbose response of policy lists.","required":false,"type":"boolean","default":false},{"name":"hasErrors","in":"query","description":"provides a way to fetch all policies with errors or policies that do not have errors","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PolicyEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:crossPlatformRetentionPolicy:view"]},"x-purecloud-method-name":"getRecordingCrossplatformMediaretentionpolicies"},"post":{"tags":["Recording"],"summary":"Create media retention policy","description":"","operationId":"postRecordingCrossplatformMediaretentionpolicies","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Policy","required":true,"schema":{"$ref":"#/definitions/CrossPlatformPolicyCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CrossPlatformPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.policy.assign.metered.evaluation.evaluator.permission.check.failed":"evaluator permission failure for metered evaluation","recording.media.policy.invalid":"One of the configured actions or conditions was invalid.","recording.policy.calibrator.permission.fail":"General calibrator permission failure","recording.policy.export.integration.disabled":"The specified export integration is not in active state.","recording.policy.invalid.queue":"The specified queues was invalid.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","recording.policy.assign.evaluation.evaluator.permission.check.failed":"evaluator permission failure for evaluation","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","recording.policy.assign.calibration.evaluator.permission.check.failed":"Calibrator permission failure","recording.policy.export.integration.invalid":"The specified export integration is not a valid integration.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:crossPlatformRetentionPolicy:add"]},"x-purecloud-method-name":"postRecordingCrossplatformMediaretentionpolicies"},"delete":{"tags":["Recording"],"summary":"Delete media retention policies","description":"Bulk delete of media retention policies, this will only delete the polices that match the ids specified in the query param.","operationId":"deleteRecordingCrossplatformMediaretentionpolicies","produces":["application/json"],"parameters":[{"name":"ids","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:crossPlatformRetentionPolicy:delete"]},"x-purecloud-method-name":"deleteRecordingCrossplatformMediaretentionpolicies"}},"/api/v2/scripts/{scriptId}/export":{"post":{"tags":["Scripts"],"summary":"Export a script via download service.","description":"","operationId":"postScriptExport","produces":["application/json"],"parameters":[{"name":"scriptId","in":"path","description":"Script ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ExportScriptRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExportScriptResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:script:view"]},"x-purecloud-method-name":"postScriptExport"}},"/api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId}":{"get":{"tags":["Outbound"],"summary":"Get a dialer call analysis response set.","description":"","operationId":"getOutboundCallanalysisresponseset","produces":["application/json"],"parameters":[{"name":"callAnalysisSetId","in":"path","description":"Call Analysis Response Set ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:responseSet:view"]},"x-purecloud-method-name":"getOutboundCallanalysisresponseset"},"put":{"tags":["Outbound"],"summary":"Update a dialer call analysis response set.","description":"","operationId":"putOutboundCallanalysisresponseset","produces":["application/json"],"parameters":[{"name":"callAnalysisSetId","in":"path","description":"Call Analysis Response Set ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ResponseSet","required":true,"schema":{"$ref":"#/definitions/ResponseSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update":"","name.cannot.be.blank":"A name must be provided.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","duplicate.name":"The name already exists.","invalid.flow":"The outbound flow could not be found.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.call.analysis.response.set":"The call analysis response set is invalid.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.call.analysis.response.set.for.agentless.campaign":"The call analysis response set is invalid for agentless campaigns."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.wrong.version":""}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:responseSet:edit"]},"x-purecloud-method-name":"putOutboundCallanalysisresponseset"},"delete":{"tags":["Outbound"],"summary":"Delete a dialer call analysis response set.","description":"","operationId":"deleteOutboundCallanalysisresponseset","produces":["application/json"],"parameters":[{"name":"callAnalysisSetId","in":"path","description":"Call Analysis Response Set ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"call.analysis.response.set.in.use":"The dialer call analysis response set is in use.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","referential.integrity.error":"Could not delete the resource because it is referenced by another entity."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:responseSet:delete"]},"x-purecloud-method-name":"deleteOutboundCallanalysisresponseset"}},"/api/v2/contentmanagement/documents/{documentId}/content":{"get":{"tags":["Content Management"],"summary":"Download a document.","description":"","operationId":"getContentmanagementDocumentContent","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"name":"disposition","in":"query","description":"Request how the content will be downloaded: a file attachment or inline. Default is attachment.","required":false,"type":"string","enum":["attachment","inline"],"x-genesys-enum-members":[{"name":"attachment"},{"name":"inline"}]},{"name":"contentType","in":"query","description":"The requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav","required":false,"type":"string"}],"responses":{"200":{"description":"Download location returned","schema":{"$ref":"#/definitions/DownloadResponse"}},"202":{"description":"Accepted - Preparing file for download - try again soon."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden from downloading content."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementDocumentContent"},"post":{"tags":["Content Management"],"summary":"Replace the contents of a document.","description":"","operationId":"postContentmanagementDocumentContent","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Replace Request","required":true,"schema":{"$ref":"#/definitions/ReplaceRequest"}},{"name":"override","in":"query","description":"Override any lock on the document","required":false,"type":"boolean"}],"responses":{"202":{"description":"Accepted - Ready for upload","schema":{"$ref":"#/definitions/ReplaceResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.null.argument":"Invalid request, null argument provided.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Resource conflict - Unexpected changeNumber was provided","x-inin-error-codes":{"resource.conflict":"Resource conflict - Unexpected changeNumber was provided."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"423":{"description":"Locked - The document is locked by another operation","x-inin-error-codes":{"locked":"Locked - The document is locked by another operation."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"postContentmanagementDocumentContent"}},"/api/v2/quality/forms/{formId}/versions":{"get":{"tags":["Quality"],"summary":"Gets all the revisions for a specific evaluation.","description":"","operationId":"getQualityFormVersions","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:view"]},"x-purecloud-method-name":"getQualityFormVersions"}},"/api/v2/quality/forms/surveys/bulk":{"get":{"tags":["Quality"],"summary":"Retrieve a list of survey forms by their ids","description":"","operationId":"getQualityFormsSurveysBulk","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"A comma-delimited list of valid survey form ids","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyFormEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:view"]},"x-purecloud-method-name":"getQualityFormsSurveysBulk"}},"/api/v2/quality/forms/surveys/bulk/contexts":{"get":{"tags":["Quality"],"summary":"Retrieve a list of the latest form versions by context ids","description":"","operationId":"getQualityFormsSurveysBulkContexts","produces":["application/json"],"parameters":[{"name":"contextId","in":"query","description":"A comma-delimited list of valid survey form context ids","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"published","in":"query","description":"If true, the latest published version will be included. If false, only the unpublished version will be included.","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyFormEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:view"]},"x-purecloud-method-name":"getQualityFormsSurveysBulkContexts"}},"/api/v2/telephony/providers/edges/extensionpools/{extensionPoolId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get an extension pool by ID","description":"","operationId":"getTelephonyProvidersEdgesExtensionpool","produces":["application/json"],"parameters":[{"name":"extensionPoolId","in":"path","description":"Extension pool ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExtensionPool"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesExtensionpool"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update an extension pool by ID","description":"","operationId":"putTelephonyProvidersEdgesExtensionpool","produces":["application/json"],"parameters":[{"name":"extensionPoolId","in":"path","description":"Extension pool ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ExtensionPool","required":true,"schema":{"$ref":"#/definitions/ExtensionPool"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExtensionPool"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be completed by the server due to a conflict."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesExtensionpool"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete an extension pool by ID","description":"","operationId":"deleteTelephonyProvidersEdgesExtensionpool","produces":["application/json"],"parameters":[{"name":"extensionPoolId","in":"path","description":"Extension pool ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find an outbound route with that id","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be completed by the server due to a conflict."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdgesExtensionpool"}},"/api/v2/authorization/products":{"get":{"tags":["Authorization"],"summary":"Get the list of enabled products","description":"Gets the list of enabled products. Some example product names are: collaborateFree, collaboratePro, communicate, and engage.","operationId":"getAuthorizationProducts","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationProductEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-purecloud-method-name":"getAuthorizationProducts"}},"/api/v2/scim/schemas":{"get":{"tags":["SCIM"],"summary":"Get a list of SCIM schemas","description":"","operationId":"getScimSchemas","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"name":"filter","in":"query","description":"Filtered results are invalid and return 403 Unauthorized.","required":false,"type":"string","x-example":"displayName eq groupName"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2SchemaListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimSchemas"}},"/api/v2/scim/schemas/{schemaId}":{"get":{"tags":["SCIM"],"summary":"Get a SCIM schema","description":"","operationId":"getScimSchema","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"name":"schemaId","in":"path","description":"The ID of a schema. Returned with GET /api/v2/scim/schemas.","required":true,"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:core:2.0:Group","urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig","urn:ietf:params:scim:schemas:core:2.0:ResourceType","urn:ietf:params:scim:schemas:core:2.0:Schema","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User"],"x-genesys-enum-members":[{"name":"urn:ietf:params:scim:schemas:core:2.0:User"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group"},{"name":"urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig"},{"name":"urn:ietf:params:scim:schemas:core:2.0:ResourceType"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Schema"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2SchemaDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimSchema"}},"/api/v2/outbound/dnclists":{"get":{"tags":["Outbound"],"summary":"Query dialer DNC lists","description":"","operationId":"getOutboundDnclists","produces":["application/json"],"parameters":[{"name":"includeImportStatus","in":"query","description":"Import status","required":false,"type":"boolean","default":false},{"name":"includeSize","in":"query","description":"Include size","required":false,"type":"boolean","default":false},{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"allowEmptyResult","in":"query","description":"Whether to return an empty page when there are no results for that page","required":false,"type":"boolean","default":false},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"],"x-genesys-enum-members":[{"name":"Equals"},{"name":"RegEx"},{"name":"Contains"},{"name":"Prefix"},{"name":"LessThan"},{"name":"LessThanEqualTo"},{"name":"GreaterThan"},{"name":"GreaterThanEqualTo"},{"name":"BeginsWith"},{"name":"EndsWith"}]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"dncSourceType","in":"query","description":"DncSourceType","required":false,"type":"string","enum":["rds","dnc.com","gryphon"],"x-genesys-enum-members":[{"name":"rds"},{"name":"dnc.com"},{"name":"gryphon"}]},{"name":"divisionId","in":"query","description":"Division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DncListEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dncList:view"]},"x-purecloud-method-name":"getOutboundDnclists"},"post":{"tags":["Outbound"],"summary":"Create dialer DNC list","description":"","operationId":"postOutboundDnclists","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"DncList","required":true,"schema":{"$ref":"#/definitions/DncListCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DncList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","invalid.create":"","dnc.list.phone.columns.empty":"","max.entity.count.reached":"The maximum dnc list count has been reached.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","dnc.source.authentication.failed":"External dnc source was not able to authenticate.","dnc.source.server.error":"External dnc source returned an error condition","dnc.source.configuration.invalid":"The dnc source configuration is invalid","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dncList:add"]},"x-purecloud-method-name":"postOutboundDnclists"}},"/api/v2/groups/{groupId}/members":{"get":{"tags":["Groups"],"summary":"Get group members, includes individuals, owners, and dynamically included people","description":"","operationId":"getGroupMembers","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ASC","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"routingStatus"},{"name":"presence"},{"name":"conversationSummary"},{"name":"outOfOffice"},{"name":"geolocation"},{"name":"station"},{"name":"authorization"},{"name":"lasttokenissued"},{"name":"authorization.unusedRoles"},{"name":"team"},{"name":"profileSkills"},{"name":"certifications"},{"name":"locations"},{"name":"groups"},{"name":"skills"},{"name":"languages"},{"name":"languagePreference"},{"name":"employerInfo"},{"name":"biography"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups","groups:readonly"]}],"x-purecloud-method-name":"getGroupMembers"},"post":{"tags":["Groups"],"summary":"Add members","description":"","operationId":"postGroupMembers","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Add members","required":true,"schema":{"$ref":"#/definitions/GroupMembersUpdate"}}],"responses":{"202":{"description":"Success, group membership was updated","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.resource.not.found":"Group members were not found.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","general.conflict":"Resource conflict updating members."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Resource conflict - Unexpected version was provided","x-inin-error-codes":{"general.conflict":"The version supplied does not match the current version of the user"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups"]}],"x-purecloud-method-name":"postGroupMembers"},"delete":{"tags":["Groups"],"summary":"Remove members","description":"","operationId":"deleteGroupMembers","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"},{"name":"ids","in":"query","description":"Comma separated list of userIds to remove","required":true,"type":"string"}],"responses":{"202":{"description":"Success, group membership was updated","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups"]}],"x-purecloud-method-name":"deleteGroupMembers"}},"/api/v2/users/{userId}/routingskills/bulk":{"put":{"tags":["Routing","Users"],"summary":"Replace all routing skills assigned to a user","description":"","operationId":"putUserRoutingskillsBulk","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Skill","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/UserRoutingSkillPost"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserSkillEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","general.conflict":"Conflicts found replacing routing skills for user"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"One or more route skill(s) not found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:assign"]},"x-purecloud-method-name":"putUserRoutingskillsBulk"},"patch":{"tags":["Routing","Users"],"summary":"Bulk add routing skills to user","description":"","operationId":"patchUserRoutingskillsBulk","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Skill","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/UserRoutingSkillPost"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserSkillEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:assign"]},"x-purecloud-method-name":"patchUserRoutingskillsBulk"}},"/api/v2/users/{userId}/routingskills":{"get":{"tags":["Routing","Users"],"summary":"List routing skills for user","description":"","operationId":"getUserRoutingskills","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ASC","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserSkillEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The route skill specified not found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getUserRoutingskills"},"post":{"tags":["Routing","Users"],"summary":"Add routing skill to user","description":"","operationId":"postUserRoutingskills","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Skill","required":true,"schema":{"$ref":"#/definitions/UserRoutingSkillPost"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserRoutingSkill"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"Error adding route skill to user, bad request","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","general.conflict":"Conflict found adding route skill to user."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The route skill specified not found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:skill:assign"]},"x-purecloud-method-name":"postUserRoutingskills"}},"/api/v2/users/{userId}/routingskills/{skillId}":{"put":{"tags":["Routing","Users"],"summary":"Update routing skill proficiency or state.","description":"","operationId":"putUserRoutingskill","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"skillId","in":"path","description":"skillId","required":true,"type":"string"},{"in":"body","name":"body","description":"Skill","required":true,"schema":{"$ref":"#/definitions/UserRoutingSkill"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserRoutingSkill"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Resource conflict - Unexpected version was provided","x-inin-error-codes":{"general.conflict":"The version supplied does not match the current version of the user"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:skill:assign"]},"x-purecloud-method-name":"putUserRoutingskill"},"delete":{"tags":["Routing","Users"],"summary":"Remove routing skill from user","description":"","operationId":"deleteUserRoutingskill","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"skillId","in":"path","description":"skillId","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Resource not found","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be completed by the server due to a conflict."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:skill:assign"]},"x-purecloud-method-name":"deleteUserRoutingskill"}},"/api/v2/integrations/clientapps":{"get":{"tags":["Integrations"],"summary":"List permitted client app integrations for the logged in user","description":"","operationId":"getIntegrationsClientapps","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ClientAppEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-purecloud-method-name":"getIntegrationsClientapps"}},"/api/v2/externalcontacts/organizations/{externalOrganizationId}/notes/{noteId}":{"get":{"tags":["External Contacts"],"summary":"Fetch a note for an external organization","description":"","operationId":"getExternalcontactsOrganizationNote","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization Id","required":true,"type":"string"},{"name":"noteId","in":"path","description":"Note Id","required":true,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["author","externalDataSources"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"author"},{"name":"externalDataSources"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Note"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Note is not found by note id.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:externalOrganization:view"]},"x-purecloud-method-name":"getExternalcontactsOrganizationNote"},"put":{"tags":["External Contacts"],"summary":"Update a note for an external organization","description":"","operationId":"putExternalcontactsOrganizationNote","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization Id","required":true,"type":"string"},{"name":"noteId","in":"path","description":"Note Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Note","required":true,"schema":{"$ref":"#/definitions/Note"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Note"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided contact was not valid"}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:externalOrganization:edit"]},"x-purecloud-method-name":"putExternalcontactsOrganizationNote"},"delete":{"tags":["External Contacts"],"summary":"Delete a note for an external organization","description":"","operationId":"deleteExternalcontactsOrganizationNote","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization Id","required":true,"type":"string"},{"name":"noteId","in":"path","description":"Note Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:externalOrganization:edit"]},"x-purecloud-method-name":"deleteExternalcontactsOrganizationNote"}},"/api/v2/contentmanagement/shared/{sharedId}":{"get":{"tags":["Content Management"],"summary":"Get shared documents. Securely download a shared document.","description":"This method requires the download sharing URI obtained in the get document response (downloadSharingUri). Documents may be shared between users in the same workspace. Documents may also be shared between any user by creating a content management share.","operationId":"getContentmanagementSharedSharedId","produces":["application/json"],"parameters":[{"name":"sharedId","in":"path","description":"Shared ID","required":true,"type":"string"},{"name":"redirect","in":"query","description":"Turn on or off redirect","required":false,"type":"boolean","default":true},{"name":"disposition","in":"query","description":"Request how the share content will be downloaded: attached as a file or inline. Default is attachment.","required":false,"type":"string","default":"attachment","enum":["attachment","inline","none"],"x-genesys-enum-members":[{"name":"attachment"},{"name":"inline"},{"name":"none"}]},{"name":"contentType","in":"query","description":"The requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav","required":false,"type":"string"},{"name":"expand","in":"query","description":"Expand some document fields","required":false,"type":"string","enum":["document.acl"],"x-genesys-enum-members":[{"name":"document.acl"}]}],"responses":{"200":{"description":"Download location is returned in header, if redirect is set to false and disposition is not set to none. If disposition is none, location header will not be populated, DownloadUri and ViewUri will be populated.","schema":{"$ref":"#/definitions/SharedResponse"}},"202":{"description":"Accepted - Preparing file for download - try again soon."},"307":{"description":"Redirected to download location, if redirect is set to true"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","unauthorized":"Unauthorized to access document.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Unable to access document."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementSharedSharedId"}},"/api/v2/integrations/types":{"get":{"tags":["Integrations"],"summary":"List integration types","description":"","operationId":"getIntegrationsTypes","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IntegrationTypeEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-purecloud-method-name":"getIntegrationsTypes"}},"/api/v2/dataextensions/coretypes":{"get":{"tags":["Data Extensions"],"summary":"Get the core types from which all schemas are built.","description":"","operationId":"getDataextensionsCoretypes","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CoretypeListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["data-extensions"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getDataextensionsCoretypes"}},"/api/v2/locations/{locationId}/sublocations":{"get":{"tags":["Locations"],"summary":"Get sublocations for location ID.","description":"","operationId":"getLocationSublocations","produces":["application/json"],"parameters":[{"name":"locationId","in":"path","description":"Location ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LocationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["locations","locations:readonly"]}],"x-purecloud-method-name":"getLocationSublocations"}},"/api/v2/locations/{locationId}":{"get":{"tags":["Locations"],"summary":"Get Location by ID.","description":"","operationId":"getLocation","produces":["application/json"],"parameters":[{"name":"locationId","in":"path","description":"Location ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["images","addressVerificationDetails"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"images"},{"name":"addressVerificationDetails"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LocationDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Location is not found by given location id.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["locations","locations:readonly"]}],"x-purecloud-method-name":"getLocation"},"delete":{"tags":["Locations"],"summary":"Delete a location","description":"","operationId":"deleteLocation","produces":["application/json"],"parameters":[{"name":"locationId","in":"path","description":"Location ID","required":true,"type":"string"}],"responses":{"204":{"description":"The location was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","general.bad.request":"Unable to delete a location due to invalid request."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["locations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["directory:location:delete"]},"x-purecloud-method-name":"deleteLocation"},"patch":{"tags":["Locations"],"summary":"Update a location","description":"","operationId":"patchLocation","produces":["application/json"],"parameters":[{"name":"locationId","in":"path","description":"Location ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Location","required":true,"schema":{"$ref":"#/definitions/LocationUpdateDefinition"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LocationDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"Unable to update a location due to invalid request.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"Unable to update a location due to a conflict."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["locations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["directory:location:edit"]},"x-purecloud-method-name":"patchLocation"}},"/api/v2/externalcontacts/contacts/{contactId}/notes/{noteId}":{"get":{"tags":["External Contacts"],"summary":"Fetch a note for an external contact","description":"","operationId":"getExternalcontactsContactNote","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact Id","required":true,"type":"string"},{"name":"noteId","in":"path","description":"Note Id","required":true,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["author","externalDataSources"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"author"},{"name":"externalDataSources"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Note"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Note is not found by note id.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:view"]},"x-purecloud-method-name":"getExternalcontactsContactNote"},"put":{"tags":["External Contacts"],"summary":"Update a note for an external contact","description":"","operationId":"putExternalcontactsContactNote","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact Id","required":true,"type":"string"},{"name":"noteId","in":"path","description":"Note Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Note","required":true,"schema":{"$ref":"#/definitions/Note"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Note"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided contact was not valid"}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:edit"]},"x-purecloud-method-name":"putExternalcontactsContactNote"},"delete":{"tags":["External Contacts"],"summary":"Delete a note for an external contact","description":"","operationId":"deleteExternalcontactsContactNote","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact Id","required":true,"type":"string"},{"name":"noteId","in":"path","description":"Note Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:edit"]},"x-purecloud-method-name":"deleteExternalcontactsContactNote"}},"/api/v2/analytics/reporting/exports":{"get":{"tags":["Analytics"],"summary":"Get all view export requests for a user","description":"","operationId":"getAnalyticsReportingExports","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportingExportJobListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["analytics:dataExport:view"]},"x-purecloud-method-name":"getAnalyticsReportingExports"},"post":{"tags":["Analytics"],"summary":"Generate a view export request","description":"This API creates a reporting export but the desired way to export analytics data is to use the analytics query APIs instead","operationId":"postAnalyticsReportingExports","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ReportingExportJobRequest","required":true,"schema":{"$ref":"#/definitions/ReportingExportJobRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportingExportJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"Bad user request","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden to generate a view export request."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["analytics:dataExport:add"]},"x-purecloud-method-name":"postAnalyticsReportingExports"}},"/api/v2/journey/segments/{segmentId}":{"get":{"tags":["Journey"],"summary":"Retrieve a single segment.","description":"","operationId":"getJourneySegment","produces":["application/json"],"parameters":[{"name":"segmentId","in":"path","description":"ID of the segment.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JourneySegment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:segment:view"]},"x-purecloud-method-name":"getJourneySegment"},"delete":{"tags":["Journey"],"summary":"Delete a segment.","description":"","operationId":"deleteJourneySegment","produces":["application/json"],"parameters":[{"name":"segmentId","in":"path","description":"ID of the segment.","required":true,"type":"string"}],"responses":{"204":{"description":"Segment deleted."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:segment:delete"]},"x-purecloud-method-name":"deleteJourneySegment"},"patch":{"tags":["Journey"],"summary":"Update a segment.","description":"","operationId":"patchJourneySegment","produces":["application/json"],"parameters":[{"name":"segmentId","in":"path","description":"ID of the segment.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/PatchSegment"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JourneySegment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:segment:edit"]},"x-purecloud-method-name":"patchJourneySegment"}},"/api/v2/integrations/speech/tts/engines":{"get":{"tags":["Integrations"],"summary":"Get a list of TTS engines enabled for org","description":"","operationId":"getIntegrationsSpeechTtsEngines","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"includeVoices","in":"query","description":"Include voices for the engine","required":false,"type":"boolean","default":false},{"name":"name","in":"query","description":"Filter on engine name","required":false,"type":"string"},{"name":"language","in":"query","description":"Filter on supported language. If includeVoices=true then the voices are also filtered.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TtsEngineEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechTtsEngines"}},"/api/v2/workforcemanagement/businessunits":{"get":{"tags":["Workforce Management"],"summary":"Get business units","description":"","operationId":"getWorkforcemanagementBusinessunits","produces":["application/json"],"parameters":[{"name":"feature","in":"query","required":false,"type":"string","enum":["AgentSchedule","AgentTimeOffRequest","Coaching","ActivityCodes","Agents","BuActivityCodes","BusinessUnits","HistoricalAdherence","IntradayMonitoring","BuIntradayMonitoring","ManagementUnits","RealTimeAdherence","Schedules","BuSchedules","ServiceGoalGroups","ServiceGoalTemplates","PlanningGroups","ShiftTrading","ShortTermForecasts","BuShortTermForecasts","TimeOffRequests","WorkPlanRotations","WorkPlans"],"x-genesys-enum-members":[{"name":"AgentSchedule"},{"name":"AgentTimeOffRequest"},{"name":"Coaching"},{"name":"ActivityCodes"},{"name":"Agents"},{"name":"BuActivityCodes"},{"name":"BusinessUnits"},{"name":"HistoricalAdherence"},{"name":"IntradayMonitoring"},{"name":"BuIntradayMonitoring"},{"name":"ManagementUnits"},{"name":"RealTimeAdherence"},{"name":"Schedules"},{"name":"BuSchedules"},{"name":"ServiceGoalGroups"},{"name":"ServiceGoalTemplates"},{"name":"PlanningGroups"},{"name":"ShiftTrading"},{"name":"ShortTermForecasts"},{"name":"BuShortTermForecasts"},{"name":"TimeOffRequests"},{"name":"WorkPlanRotations"},{"name":"WorkPlans"}]},{"name":"divisionId","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BusinessUnitListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.server.error":"WFM Server Error","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-purecloud-method-name":"getWorkforcemanagementBusinessunits"},"post":{"tags":["Workforce Management"],"summary":"Add a new business unit","description":"It may take a minute or two for a new business unit to be available for api operations","operationId":"postWorkforcemanagementBusinessunits","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/CreateBusinessUnitRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BusinessUnit"}},"201":{"description":"The business unit was successfully created","schema":{"$ref":"#/definitions/BusinessUnit"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.server.error":"WFM Server Error","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:businessUnit:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunits"}},"/api/v2/telephony/providers/edges/metrics":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the metrics for a list of edges.","description":"","operationId":"getTelephonyProvidersEdgesMetrics","produces":["application/json"],"parameters":[{"name":"edgeIds","in":"query","description":"Comma separated list of Edge Id's","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/EdgeMetrics"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be processed due to invalid request data.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesMetrics"}},"/api/v2/voicemail/messages":{"get":{"tags":["Voicemail"],"summary":"List voicemail messages","description":"","operationId":"getVoicemailMessages","produces":["application/json"],"parameters":[{"name":"ids","in":"query","description":"An optional comma separated list of VoicemailMessage ids","required":false,"type":"string"},{"name":"expand","in":"query","description":"If the caller is a known user, which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["callerUser.routingStatus","callerUser.primaryPresence","callerUser.conversationSummary","callerUser.outOfOffice","callerUser.geolocation"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"callerUser.routingStatus"},{"name":"callerUser.primaryPresence"},{"name":"callerUser.conversationSummary"},{"name":"callerUser.outOfOffice"},{"name":"callerUser.geolocation"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMessageEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","voicemail.not.authorized.voicemail.message":"You are not authorized to access a voicemail message.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-purecloud-method-name":"getVoicemailMessages"},"post":{"tags":["Voicemail"],"summary":"Copy a voicemail message to a user or group","description":"","operationId":"postVoicemailMessages","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/CopyVoicemailMessage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","voicemail.copy.missing.voicemail.message.id":"The request requires a voicemailMessageId","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","voicemail.copy.missing.target":"The request requires a userId or groupId","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","voicemail.not.authorized.voicemail.message":"You are not authorized to access the voicemail message.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"voicemail.copy.group.does.not.have.voicemail.enabled":"Cannot copy the voicemail to the group because they do not have voicemail enabled","voicemail.copy.user.does.not.have.voicemail.enabled":"Cannot copy the voicemail to the user because they do not have voicemail enabled"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail"]}],"x-purecloud-method-name":"postVoicemailMessages"},"delete":{"tags":["Voicemail"],"summary":"Delete all voicemail messages","description":"","operationId":"deleteVoicemailMessages","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail"]}],"x-purecloud-method-name":"deleteVoicemailMessages"}},"/api/v2/users/{userId}":{"get":{"tags":["Users"],"summary":"Get user.","description":"","operationId":"getUser","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"routingStatus"},{"name":"presence"},{"name":"conversationSummary"},{"name":"outOfOffice"},{"name":"geolocation"},{"name":"station"},{"name":"authorization"},{"name":"lasttokenissued"},{"name":"authorization.unusedRoles"},{"name":"team"},{"name":"profileSkills"},{"name":"certifications"},{"name":"locations"},{"name":"groups"},{"name":"skills"},{"name":"languages"},{"name":"languagePreference"},{"name":"employerInfo"},{"name":"biography"}]},{"name":"integrationPresenceSource","in":"query","description":"Gets an integration presence for a user instead of their default.","required":false,"type":"string","enum":["MicrosoftTeams","ZoomPhone","RingCentral"],"x-genesys-enum-members":[{"name":"MicrosoftTeams"},{"name":"ZoomPhone"},{"name":"RingCentral"}]},{"name":"state","in":"query","description":"Search for a user with this state","required":false,"type":"string","default":"active","enum":["active","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"deleted"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/User"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"Bad user request","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a user with that userId","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getUser"},"delete":{"tags":["Users"],"summary":"Delete user","description":"","operationId":"deleteUser","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","general.conflict":"Conflict deleting specified userId."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a user with that userId. ","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:delete"]},"x-purecloud-method-name":"deleteUser"},"patch":{"tags":["Users"],"summary":"Update user","description":"","operationId":"patchUser","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"User","required":true,"schema":{"$ref":"#/definitions/UpdateUser"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/User"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","general.conflict":"The version supplied does not match the current version of the user"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","insufficient.permissions":"Insufficient permissions to update a user"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a user with that userId.","not.found":"The requested resource was not found."}},"409":{"description":"Resource conflict - Unexpected version was provided","x-inin-error-codes":{"general.conflict":"The request could not be completed by the server due to a conflict."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:edit"]},"x-purecloud-method-name":"patchUser"}},"/api/v2/users/{userId}/invite":{"post":{"tags":["Users"],"summary":"Send an activation email to the user","description":"","operationId":"postUserInvite","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"force","in":"query","description":"Resend the invitation even if one is already outstanding","required":false,"type":"boolean","default":false}],"responses":{"204":{"description":"Invitation Sent"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","insufficient.permissions":"Insufficient permissions for sending an activation email."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:add"]},"x-purecloud-method-name":"postUserInvite"}},"/api/v2/webchat/guest/conversations/{conversationId}/messages/{messageId}":{"get":{"tags":["WebChat"],"summary":"Get a web chat conversation message","description":"","operationId":"getWebchatGuestConversationMessage","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"messageId","in":"path","description":"messageId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.not.found":"The web chat conversation message was not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"Guest Chat JWT":[]}],"x-purecloud-method-name":"getWebchatGuestConversationMessage"}},"/api/v2/externalcontacts/scan/organizations":{"get":{"tags":["External Contacts"],"summary":"Scan for external organizations using paging","description":"","operationId":"getExternalcontactsScanOrganizations","produces":["application/json"],"parameters":[{"name":"limit","in":"query","description":"The number of organizations per page; must be between 10 and 200, default is 100)","required":false,"type":"integer","format":"int32"},{"name":"cursor","in":"query","description":"Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CursorOrganizationListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or expired cursor","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too many requests in a given amount of time"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:externalOrganization:view"]},"x-purecloud-method-name":"getExternalcontactsScanOrganizations"}},"/api/v2/telephony/providers/edges/extensions/{extensionId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get an extension by ID.","description":"","operationId":"getTelephonyProvidersEdgesExtension","produces":["application/json"],"parameters":[{"name":"extensionId","in":"path","description":"Extension ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Extension"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesExtension"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update an extension by ID.","description":"","operationId":"putTelephonyProvidersEdgesExtension","produces":["application/json"],"parameters":[{"name":"extensionId","in":"path","description":"Extension ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Extension","required":true,"schema":{"$ref":"#/definitions/Extension"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Extension"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesExtension"}},"/api/v2/integrations/speech/dialogflow/agents":{"get":{"tags":["Integrations"],"summary":"Get a list of Dialogflow agents in the customers' Google accounts","description":"","operationId":"getIntegrationsSpeechDialogflowAgents","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"name","in":"query","description":"Filter on agent name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DialogflowAgentSummaryEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.forbidden":"Unauthorized to access of dialog flow agents.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechDialogflowAgents"}},"/api/v2/outbound/contactlists/{contactListId}/contacts/{contactId}":{"get":{"tags":["Outbound"],"summary":"Get a contact.","description":"","operationId":"getOutboundContactlistContact","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"},{"name":"contactId","in":"path","description":"Contact ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DialerContact"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contact:view"]},"x-purecloud-method-name":"getOutboundContactlistContact"},"put":{"tags":["Outbound"],"summary":"Update a contact.","description":"","operationId":"putOutboundContactlistContact","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"},{"name":"contactId","in":"path","description":"Contact ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Contact","required":true,"schema":{"$ref":"#/definitions/DialerContact"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DialerContact"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update":"An attempt was made to update a contact in an invalid way","contact.missing.columns":"The contact is missing columns from its contact list.","invalid.contact.id":"An attempt was made to update a contact with an invalid contact ID","contact.column.length.limit.exceeded":"The length of each contact column must not exceed the limit.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","contact.missing.data":"The data field is required.","contact.columns.limit.exceeded":"Number of contact columns must not exceed the limit.","contact.datum.length.limit.exceeded":"The length of each piece of contact data must not exceed the limit.","contact.does.not.exist":"The contact does not exist.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contact:edit"]},"x-purecloud-method-name":"putOutboundContactlistContact"},"delete":{"tags":["Outbound"],"summary":"Delete a contact.","description":"","operationId":"deleteOutboundContactlistContact","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"},{"name":"contactId","in":"path","description":"Contact ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.in.use":"The contact cannot be deleted because it is currently in use.","invalid.delete":"An attempt was made to delete a contact in an invalid way","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","contact.not.found":"The contact could not be found.","not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contact:delete"]},"x-purecloud-method-name":"deleteOutboundContactlistContact"}},"/api/v2/authorization/roles":{"get":{"tags":["Authorization"],"summary":"Retrieve a list of all roles defined for the organization","description":"","operationId":"getAuthorizationRoles","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"name","in":"query","required":false,"type":"string"},{"name":"permission","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"defaultRoleId","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"userCount","in":"query","required":false,"type":"boolean","default":true},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationRoleEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"max.role.ids":"Only 100 roles can be requested at a time.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"The service is currently unavailable."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:view"]},"x-purecloud-method-name":"getAuthorizationRoles"},"post":{"tags":["Authorization"],"summary":"Create an organization role.","description":"","operationId":"postAuthorizationRoles","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Organization role","required":true,"schema":{"$ref":"#/definitions/DomainOrganizationRoleCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainOrganizationRole"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request is badly formed.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:add"]},"x-purecloud-method-name":"postAuthorizationRoles"}},"/api/v2/contentmanagement/workspaces":{"get":{"tags":["Content Management"],"summary":"Get a list of workspaces.","description":"Specifying 'content' access will return all workspaces the user has document access to, while 'admin' access will return all group workspaces the user has administrative rights to.","operationId":"getContentmanagementWorkspaces","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"access","in":"query","description":"Requested access level.","required":false,"type":"array","items":{"type":"string","enum":["content","admin","document:create","document:viewContent","document:viewMetadata","document:download","document:delete","document:update","document:share","document:shareView","document:email","document:print","document:auditView","document:replace","document:tag","tag:create","tag:view","tag:update","tag:apply","tag:remove","tag:delete"],"default":"document:viewmetadata"},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"content"},{"name":"admin"},{"name":"document:create"},{"name":"document:viewContent"},{"name":"document:viewMetadata"},{"name":"document:download"},{"name":"document:delete"},{"name":"document:update"},{"name":"document:share"},{"name":"document:shareView"},{"name":"document:email"},{"name":"document:print"},{"name":"document:auditView"},{"name":"document:replace"},{"name":"document:tag"},{"name":"tag:create"},{"name":"tag:view"},{"name":"tag:update"},{"name":"tag:apply"},{"name":"tag:remove"},{"name":"tag:delete"}]},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["summary","acl"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"summary"},{"name":"acl"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkspaceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.workspace.access.fields":"Has invalid workspace fields.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementWorkspaces"},"post":{"tags":["Content Management"],"summary":"Create a group workspace","description":"","operationId":"postContentmanagementWorkspaces","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Workspace","required":true,"schema":{"$ref":"#/definitions/WorkspaceCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Workspace"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden to create a workspace."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"postContentmanagementWorkspaces"}},"/api/v2/conversations/messaging/integrations/whatsapp/{integrationId}":{"get":{"tags":["Conversations"],"summary":"Get a WhatsApp messaging integration","description":"","operationId":"getConversationsMessagingIntegrationsWhatsappIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WhatsAppIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:view"]},"x-purecloud-method-name":"getConversationsMessagingIntegrationsWhatsappIntegrationId"},"delete":{"tags":["Conversations"],"summary":"Delete a WhatsApp messaging integration","description":"","operationId":"deleteConversationsMessagingIntegrationsWhatsappIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WhatsAppIntegration"}},"202":{"description":"Request Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:delete"]},"x-purecloud-method-name":"deleteConversationsMessagingIntegrationsWhatsappIntegrationId"},"patch":{"tags":["Conversations"],"summary":"Update or activate a WhatsApp messaging integration.","description":"The following steps are required in order to fully activate a Whatsapp Integration: Initially, you will need to get an activation code by sending: an action set to Activate, and an authenticationMethod choosing from Sms or Voice. Finally, once you have been informed of an activation code on selected authenticationMethod, you will need to confirm the code by sending: an action set to Confirm, and the confirmationCode you have received from Whatsapp.","operationId":"patchConversationsMessagingIntegrationsWhatsappIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"},{"in":"body","name":"body","description":"WhatsAppIntegrationUpdateRequest","required":true,"schema":{"$ref":"#/definitions/WhatsAppIntegrationUpdateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WhatsAppIntegration"}},"202":{"description":"Processing Request - If request was to Activate, do a GET checking for activationStatus set to CodeSent. \nIf request was to Confirm, do a GET checking for the integration status set to Active","schema":{"$ref":"#/definitions/WhatsAppIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wait.required":"User must wait for a specified amount of time before attempting multiple request to Activate WhatsApp messaging integration.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.integration":"The integration request was invalid for this operation. One or more errors may be reported.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:edit"]},"x-purecloud-method-name":"patchConversationsMessagingIntegrationsWhatsappIntegrationId"}},"/api/v2/routing/sms/phonenumbers":{"get":{"tags":["Routing"],"summary":"Get a list of provisioned phone numbers.","description":"","operationId":"getRoutingSmsPhonenumbers","produces":["application/json"],"parameters":[{"name":"phoneNumber","in":"query","description":"Filter on phone number address. Allowable characters are the digits '0-9' and the wild card character '\\*'. If just digits are present, a contains search is done on the address pattern. For example, '317' could be matched anywhere in the address. An '\\*' will match multiple digits. For example, to match a specific area code within the US a pattern like '1317*' could be used.","required":false,"type":"string"},{"name":"phoneNumberType","in":"query","description":"Filter on phone number type","required":false,"type":"string","enum":["local","mobile","tollfree","shortcode"],"x-genesys-enum-members":[{"name":"local"},{"name":"mobile"},{"name":"tollfree"},{"name":"shortcode"}]},{"name":"phoneNumberStatus","in":"query","description":"Filter on phone number status","required":false,"type":"string","enum":["active","invalid","porting"],"x-genesys-enum-members":[{"name":"active"},{"name":"invalid"},{"name":"porting"}]},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SmsPhoneNumberEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:view"]},"x-purecloud-method-name":"getRoutingSmsPhonenumbers"},"post":{"tags":["Routing"],"summary":"Provision a phone number for SMS","description":"","operationId":"postRoutingSmsPhonenumbers","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"SmsPhoneNumber","required":true,"schema":{"$ref":"#/definitions/SmsPhoneNumberProvision"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SmsPhoneNumber"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"requires.verified.identity.document":"This phone number requires a verified identity document, which is not supported.","requires.local.address":"Phone number associated with the country code requires a local address. To provision this number you must have an Address on your account which satisfies the local address requirements.","invalid.short.code.operation":"Phone number Provision operation not allowed for phone number of type shortcode.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","requires.an.address":"The country associated with this phone number requires an address on file. To provision this number you must have an Address on your account.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","phone.number.requires.a.bundle":"This phone number cannot be provisioned without an identity document, which is not supported.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Bad request provisioning phone number for SMS","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:add"]},"x-purecloud-method-name":"postRoutingSmsPhonenumbers"}},"/api/v2/integrations/eventlog/{eventId}":{"get":{"tags":["Integrations"],"summary":"Get a single event","description":"","operationId":"getIntegrationsEventlogEventId","produces":["application/json"],"parameters":[{"name":"eventId","in":"path","description":"Event Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IntegrationEvent"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view","bridge:notification:view"]},"x-purecloud-method-name":"getIntegrationsEventlogEventId"}},"/api/v2/coaching/appointments/{appointmentId}/annotations":{"get":{"tags":["Coaching"],"summary":"Get a list of annotations.","description":"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).","operationId":"getCoachingAppointmentAnnotations","produces":["application/json"],"parameters":[{"name":"appointmentId","in":"path","description":"The ID of the coaching appointment.","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"Annotations retrieved","schema":{"$ref":"#/definitions/CoachingAnnotationList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"User does not have the annotation view permission and is not an attendee, creator or facilitator of the appointment"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.not.found":"Appointment not found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","coaching:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:annotation:view","coaching:privateAnnotation:view"]},"x-purecloud-method-name":"getCoachingAppointmentAnnotations"},"post":{"tags":["Coaching"],"summary":"Create a new annotation.","description":"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).","operationId":"postCoachingAppointmentAnnotations","produces":["application/json"],"parameters":[{"name":"appointmentId","in":"path","description":"The ID of the coaching appointment.","required":true,"type":"string"},{"in":"body","name":"body","description":"The annotation to add","required":true,"schema":{"$ref":"#/definitions/CoachingAnnotationCreateRequest"}}],"responses":{"201":{"description":"Annotation created","schema":{"$ref":"#/definitions/CoachingAnnotation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","validation.failure":"The submitted data was not valid."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"User does not have the annotation add permission and is not an attendee, creator or facilitator of the appointment"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.not.found":"Appointment not found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:annotation:add","coaching:privateAnnotation:add"]},"x-purecloud-method-name":"postCoachingAppointmentAnnotations"}},"/api/v2/flows/datatables/{datatableId}/export/jobs":{"post":{"tags":["Architect"],"summary":"Begin an export process for exporting all rows from a datatable","description":"Create an export job for exporting rows. The caller can then poll for status of the export using the token returned in the response","operationId":"postFlowsDatatableExportJobs","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataTableExportJob"}},"202":{"description":"Request Accepted","schema":{"$ref":"#/definitions/DataTableExportJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.table.not.found":"The datatable could not be found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:view"]},"x-purecloud-method-name":"postFlowsDatatableExportJobs"}},"/api/v2/quality/forms/surveys/{formId}/versions":{"get":{"tags":["Quality"],"summary":"Gets all the revisions for a specific survey.","description":"","operationId":"getQualityFormsSurveyVersions","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyFormEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:view"]},"x-purecloud-method-name":"getQualityFormsSurveyVersions"}},"/api/v2/groups":{"get":{"tags":["Groups"],"summary":"Get a group list","description":"","operationId":"getGroups","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"jabberId","in":"query","description":"A list of jabberIds to fetch by bulk (cannot be used with the \"id\" parameter)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ASC","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GroupEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups","groups:readonly"]}],"x-purecloud-method-name":"getGroups"},"post":{"tags":["Groups"],"summary":"Create a group","description":"","operationId":"postGroups","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Group","required":true,"schema":{"$ref":"#/definitions/GroupCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Group"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:add"]},"x-purecloud-method-name":"postGroups"}},"/api/v2/externalcontacts/relationships/{relationshipId}":{"get":{"tags":["External Contacts"],"summary":"Fetch a relationship","description":"","operationId":"getExternalcontactsRelationship","produces":["application/json"],"parameters":[{"name":"relationshipId","in":"path","description":"Relationship Id","required":true,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand","required":false,"type":"string","enum":["externalDataSources"],"x-genesys-enum-members":[{"name":"externalDataSources"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Relationship"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Relationship is not found by relationship id.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:externalOrganization:view"]},"x-purecloud-method-name":"getExternalcontactsRelationship"},"put":{"tags":["External Contacts"],"summary":"Update a relationship","description":"","operationId":"putExternalcontactsRelationship","produces":["application/json"],"parameters":[{"name":"relationshipId","in":"path","description":"Relationship Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Relationship","required":true,"schema":{"$ref":"#/definitions/Relationship"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Relationship"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided contact was not valid"}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:externalOrganization:edit"]},"x-purecloud-method-name":"putExternalcontactsRelationship"},"delete":{"tags":["External Contacts"],"summary":"Delete a relationship","description":"","operationId":"deleteExternalcontactsRelationship","produces":["application/json"],"parameters":[{"name":"relationshipId","in":"path","description":"Relationship Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:externalOrganization:edit"]},"x-purecloud-method-name":"deleteExternalcontactsRelationship"}},"/api/v2/responsemanagement/responses/query":{"post":{"tags":["Response Management"],"summary":"Query responses","description":"","operationId":"postResponsemanagementResponsesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Response","required":true,"schema":{"$ref":"#/definitions/ResponseQueryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseQueryResults"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","rms.field.unexpected.value":"One or more fields in the payload contained unexpected values."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"rms.internal.server.error":"The request failed due to an internal server error.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management","response-management:readonly"]}],"x-purecloud-method-name":"postResponsemanagementResponsesQuery"}},"/api/v2/telephony/providers/edges/phones/template":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Phone instance template based on a Phone Base Settings object. This object can then be modified and saved as a new Phone instance","description":"","operationId":"getTelephonyProvidersEdgesPhonesTemplate","produces":["application/json"],"parameters":[{"name":"phoneBaseSettingsId","in":"query","description":"The id of a Phone Base Settings object upon which to base this Phone","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Phone"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesPhonesTemplate"}},"/api/v2/voicemail/me/policy":{"get":{"tags":["Voicemail"],"summary":"Get the current user's voicemail policy","description":"","operationId":"getVoicemailMePolicy","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailUserPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-purecloud-method-name":"getVoicemailMePolicy"},"patch":{"tags":["Voicemail"],"summary":"Update the current user's voicemail policy","description":"","operationId":"patchVoicemailMePolicy","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The user's voicemail policy","required":true,"schema":{"$ref":"#/definitions/VoicemailUserPolicy"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailUserPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail"]}],"x-purecloud-method-name":"patchVoicemailMePolicy"}},"/api/v2/routing/queues/{queueId}/users":{"get":{"tags":["Routing"],"summary":"DEPRECATED: use GET /routing/queues/{queueId}/members. Get the members of this queue.","description":"","operationId":"getRoutingQueueUsers","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size [max 100]","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"routingStatus"},{"name":"presence"},{"name":"conversationSummary"},{"name":"outOfOffice"},{"name":"geolocation"},{"name":"station"},{"name":"authorization"},{"name":"lasttokenissued"},{"name":"authorization.unusedRoles"},{"name":"team"},{"name":"profileSkills"},{"name":"certifications"},{"name":"locations"},{"name":"groups"},{"name":"skills"},{"name":"languages"},{"name":"languagePreference"},{"name":"employerInfo"},{"name":"biography"}]},{"name":"joined","in":"query","description":"Filter by joined status","required":false,"type":"boolean"},{"name":"name","in":"query","description":"Filter by queue member name","required":false,"type":"string"},{"name":"profileSkills","in":"query","description":"Filter by profile skill","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"skills","in":"query","description":"Filter by skill","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"languages","in":"query","description":"Filter by language","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"routingStatus","in":"query","description":"Filter by routing status","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"presence","in":"query","description":"Filter by presence","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueMemberEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.page.number":"Invalid page number specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","missing.any.division.permissions":"At least one of the required division permissions is missing"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"external.service.error":"The server is currently unable to handle the request .","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:view","routing:queueMember:manage"]},"x-purecloud-method-name":"getRoutingQueueUsers"},"post":{"tags":["Routing"],"summary":"DEPRECATED: use POST /routing/queues/{queueId}/members. Bulk add or delete up to 100 queue members.","description":"","operationId":"postRoutingQueueUsers","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Queue Members","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/WritableEntity"}}},{"name":"delete","in":"query","description":"True to delete queue members","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid request data. Make sure you submit a valid number of queue members.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","queue.size.limit":"Adding all requested members would exceed queue member limit.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","missing.any.division.permissions":"At least one of the required division permissions is missing"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"Specified queue could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:edit","routing:queueMember:manage"]},"x-purecloud-method-name":"postRoutingQueueUsers"},"patch":{"tags":["Routing"],"summary":"DEPRECATED: use PATCH /routing/queues/{queueId}/members. Join or unjoin a set of users for a queue.","description":"","operationId":"patchRoutingQueueUsers","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Queue Members","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/QueueMember"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueMemberEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid request data. Make sure a valid number of queue members was submitted, and all have the joined property specified.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","missing.any.division.permissions":"At least one of the required division permissions is missing"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"Specified queue could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:edit","routing:queueMember:manage"]},"x-purecloud-method-name":"patchRoutingQueueUsers"}},"/api/v2/contentmanagement/shares/{shareId}":{"get":{"tags":["Content Management"],"summary":"Retrieve details about an existing share.","description":"","operationId":"getContentmanagementShare","produces":["application/json"],"parameters":[{"name":"shareId","in":"path","description":"Share ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["member"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"member"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Share"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementShare"},"delete":{"tags":["Content Management"],"summary":"Deletes an existing share.","description":"This revokes sharing rights specified in the share record","operationId":"deleteContentmanagementShare","produces":["application/json"],"parameters":[{"name":"shareId","in":"path","description":"Share ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden from deleting a share."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"deleteContentmanagementShare"}},"/api/v2/externalcontacts/contacts/{contactId}/notes":{"get":{"tags":["External Contacts"],"summary":"List notes for an external contact","description":"","operationId":"getExternalcontactsContactNotes","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact Id","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":20,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["author","externalDataSources"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"author"},{"name":"externalDataSources"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NoteListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:view"]},"x-purecloud-method-name":"getExternalcontactsContactNotes"},"post":{"tags":["External Contacts"],"summary":"Create a note for an external contact","description":"","operationId":"postExternalcontactsContactNotes","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact Id","required":true,"type":"string"},{"in":"body","name":"body","description":"ExternalContact","required":true,"schema":{"$ref":"#/definitions/Note"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Note"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided contact was not valid"}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:edit"]},"x-purecloud-method-name":"postExternalcontactsContactNotes"}},"/api/v2/authorization/divisions/limit":{"get":{"tags":["Authorization","Objects"],"summary":"Returns the maximum allowed number of divisions.","description":"","operationId":"getAuthorizationDivisionsLimit","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"type":"integer","format":"int32"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-purecloud-method-name":"getAuthorizationDivisionsLimit"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/{tradeId}":{"patch":{"tags":["Workforce Management"],"summary":"Updates a shift trade. This route can only be called by the initiating agent","description":"","operationId":"patchWorkforcemanagementManagementunitWeekShifttrade","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/PatchShiftTradeRequest"}},{"name":"tradeId","in":"path","description":"The ID of the shift trade to update","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ShiftTradeResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Entity was modified by another request"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentShiftTradeRequest:participate"]},"x-purecloud-method-name":"patchWorkforcemanagementManagementunitWeekShifttrade"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades":{"get":{"tags":["Workforce Management"],"summary":"Gets all the shift trades for a given week","description":"","operationId":"getWorkforcemanagementManagementunitWeekShifttrades","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"evaluateMatches","in":"query","description":"Whether to evaluate the matches for violations","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WeekShiftTradeListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"Invalid week date ID in path parameter","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:shiftTradeRequest:view","wfm:shiftTradeRequest:edit"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitWeekShifttrades"},"post":{"tags":["Workforce Management"],"summary":"Adds a shift trade","description":"","operationId":"postWorkforcemanagementManagementunitWeekShifttrades","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/AddShiftTradeRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ShiftTradeResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentShiftTradeRequest:participate"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitWeekShifttrades"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/{tradeId}/match":{"post":{"tags":["Workforce Management"],"summary":"Matches a shift trade. This route can only be called by the receiving agent","description":"","operationId":"postWorkforcemanagementManagementunitWeekShifttradeMatch","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/MatchShiftTradeRequest"}},{"name":"tradeId","in":"path","description":"The ID of the shift trade to update","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MatchShiftTradeResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"Invalid week date ID in path parameter","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Entity was modified by another request"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentShiftTradeRequest:participate"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitWeekShifttradeMatch"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/search":{"post":{"tags":["Workforce Management"],"summary":"Searches for potential shift trade matches for the current agent","description":"","operationId":"postWorkforcemanagementManagementunitWeekShifttradesSearch","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/SearchShiftTradesRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SearchShiftTradesResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"Invalid week date ID in path parameter","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentShiftTradeRequest:participate"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitWeekShifttradesSearch"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/state/bulk":{"post":{"tags":["Workforce Management"],"summary":"Updates the state of a batch of shift trades","description":"Admin functionality is not supported with \"mine\".","operationId":"postWorkforcemanagementManagementunitWeekShifttradesStateBulk","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/BulkShiftTradeStateUpdateRequest"}},{"name":"forceAsync","in":"query","description":"Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkUpdateShiftTradeStateResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Entity was modified by another request"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentShiftTradeRequest:participate","wfm:shiftTradeRequest:edit"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitWeekShifttradesStateBulk"}},"/api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces/{interfaceId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get an edge logical interface","description":"","operationId":"getTelephonyProvidersEdgeLogicalinterface","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"interfaceId","in":"path","description":"Interface ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Field to expand in the response","required":false,"type":"array","items":{"type":"string","enum":["externalTrunkBaseAssignments","phoneTrunkBaseAssignments"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"externalTrunkBaseAssignments"},{"name":"phoneTrunkBaseAssignments"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainLogicalInterface"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgeLogicalinterface"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update an edge logical interface.","description":"","operationId":"putTelephonyProvidersEdgeLogicalinterface","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"interfaceId","in":"path","description":"Interface ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Logical interface","required":true,"schema":{"$ref":"#/definitions/DomainLogicalInterface"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainLogicalInterface"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"Information was missing or malformed in the request","duplicate.value":"A logical interface with that vlanTagId already exists on this port.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgeLogicalinterface"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete an edge logical interface","description":"","operationId":"deleteTelephonyProvidersEdgeLogicalinterface","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"interfaceId","in":"path","description":"Interface ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdgeLogicalinterface"}},"/api/v2/routing/queues":{"get":{"tags":["Routing"],"summary":"Get list of queues.","description":"","operationId":"getRoutingQueues","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"id","in":"query","description":"ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"divisionId","in":"query","description":"Division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.page.number":"Invalid page number specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"Internal server error getting queue listing."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:view"]},"x-purecloud-method-name":"getRoutingQueues"},"post":{"tags":["Routing"],"summary":"Create a queue","description":"","operationId":"postRoutingQueues","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Queue","required":true,"schema":{"$ref":"#/definitions/CreateQueueRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Queue"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Invalid media type specified.","invalid.phone.numbers":"Invalid phone numbers specified.","source.queue.not.found":"Source queue not found.","bad.request":"Invalid request data.","duplicate.name":"A queue with this name already exists.","invalid.rule":"Invalid routing rule specified.","invalid.outbound.messaging.address.state":"Specified outbound messaging address is not active.","queue.deleted":"Queue has been deleted.","invalid.name":"Invalid queue name specified.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.phone.number":"Invalid phone number specified.","invalid.id":"Missing or invalid queue division ID.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","skill.does.not.exist":"Specified skill does not exist.","queue.limit.exceeded":"Adding the requested queue would exceed the queue limit."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"A required resource (e.g., the source queue) was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:add"]},"x-purecloud-method-name":"postRoutingQueues"}},"/api/v2/languageunderstanding/domains/{domainId}/feedback/{feedbackId}":{"get":{"tags":["Language Understanding"],"summary":"Find a Feedback","description":"","operationId":"getLanguageunderstandingDomainFeedbackFeedbackId","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"feedbackId","in":"path","description":"ID of the Feedback","required":true,"type":"string"},{"name":"fields","in":"query","description":"Fields and properties to get, comma-separated","required":false,"type":"array","items":{"type":"string","enum":["version","dateCreated","text","intents"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"version"},{"name":"dateCreated"},{"name":"text"},{"name":"intents"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluFeedbackResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","dialog:readonly","language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:feedback:view","dialog:bot:view"]},"x-purecloud-method-name":"getLanguageunderstandingDomainFeedbackFeedbackId"},"delete":{"tags":["Language Understanding"],"summary":"Delete the feedback on the NLU Domain Version.","description":"","operationId":"deleteLanguageunderstandingDomainFeedbackFeedbackId","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"feedbackId","in":"path","description":"ID of the Feedback","required":true,"type":"string"}],"responses":{"204":{"description":"Feedback deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","language-understanding"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:feedback:delete","dialog:bot:delete"]},"x-purecloud-method-name":"deleteLanguageunderstandingDomainFeedbackFeedbackId"}},"/api/v2/quality/calibrations":{"get":{"tags":["Quality"],"summary":"Get the list of calibrations","description":"","operationId":"getQualityCalibrations","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"conversationId","in":"query","description":"conversation id","required":false,"type":"string"},{"name":"startTime","in":"query","description":"Beginning of the calibration query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","required":false,"type":"string","format":"date-time"},{"name":"endTime","in":"query","description":"end of the calibration query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","required":false,"type":"string","format":"date-time"},{"name":"calibratorId","in":"query","description":"user id of calibrator","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CalibrationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:calibration:view"]},"x-purecloud-method-name":"getQualityCalibrations"},"post":{"tags":["Quality"],"summary":"Create a calibration","description":"","operationId":"postQualityCalibrations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"calibration","required":true,"schema":{"$ref":"#/definitions/CalibrationCreate"}},{"name":"expand","in":"query","description":"calibratorId","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Calibration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.calibration.no.evaluation.form.or.context.id":"evaluation form or context id missing","bad.request":"The request could not be understood by the server due to malformed syntax.","qm.calibration.create.error.no.evaluators":"Failed to create calibration because the specified evaluators do not exist.","quality.evaluation.agent.doesnt.have.participate.permission":"Agent does not have evaluation participate permission","quality.evaluation.form.context.doesnt.exist":"Evaluation form context doesn't exist","quality.calibration.scoring.index.evaluator.must.match.calibrator.or.expert.evaluator":"scoring index evaluator must be a calibrator or expert evaluator","qm.calibration.create.error.no.agent":"Failed to create calibration because the conversation has no agent user","quality.calibration.existing.evaluation.not.finished":"Existing evaluation is not finished for calibration","quality.calibration.expert.evaluator.not.quality.evaluator":"expert evaluator does not have evaluator permissions","quality.calibration.no.existing.evaluation.for.evaluationid":"no evaluation found for existing evaluation","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","quality.calibration.contextid.doesnt.match.evaluation.contextid":"Calibration contextId doesn't match the evaluation contextId","quality.evaluation.evaluator.not.quality.evaluator":"evaluator does not have edit score permission","quality.conversation.doesnt.exist":"unable to find specified conversation","qm.calibration.create.error.no.conversation":"Failed to create calibration because the specified conversation does not exist","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","quality.calibration.create.permission.check.failed":"Calibration create permission check failed","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:calibration:add"]},"x-purecloud-method-name":"postQualityCalibrations"}},"/api/v2/coaching/appointments":{"get":{"tags":["Coaching"],"summary":"Get appointments for users and optional date range","description":"","operationId":"getCoachingAppointments","produces":["application/json"],"parameters":[{"name":"userIds","in":"query","description":"The user IDs for which to retrieve appointments","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"interval","in":"query","description":"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","required":false,"type":"string","format":"interval"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"statuses","in":"query","description":"Appointment Statuses to filter by","required":false,"type":"array","items":{"type":"string","enum":["Scheduled","InProgress","Completed","InvalidSchedule"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"Scheduled"},{"name":"InProgress"},{"name":"Completed"},{"name":"InvalidSchedule"}]},{"name":"facilitatorIds","in":"query","description":"The facilitator IDs for which to retrieve appointments","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortOrder","in":"query","description":"Sort (by due date) either Asc or Desc","required":false,"type":"string","enum":["Desc","Asc"],"x-genesys-enum-members":[{"name":"Desc"},{"name":"Asc"}]},{"name":"relationships","in":"query","description":"Relationships to filter by","required":false,"type":"array","items":{"type":"string","enum":["Creator","Facilitator","Attendee"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"Creator"},{"name":"Facilitator"},{"name":"Attendee"}]},{"name":"completionInterval","in":"query","description":"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","required":false,"type":"string","format":"interval"},{"name":"overdue","in":"query","description":"Overdue status to filter by","required":false,"type":"string","enum":["True","False","Any"],"x-genesys-enum-members":[{"name":"True"},{"name":"False"},{"name":"Any"}]}],"responses":{"200":{"description":"Get users coaching appointments successful","schema":{"$ref":"#/definitions/CoachingAppointmentResponseList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"interval.query.param":"Start date of the interval cannot be greater than the end date","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","users.query.param":"User list cannot be empty or greater than 100 when querying for appointments","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","no.appointment.view.permission":"No permission to view appointments","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","coaching:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:appointment:view"]},"x-purecloud-method-name":"getCoachingAppointments"},"post":{"tags":["Coaching"],"summary":"Create a new appointment","description":"","operationId":"postCoachingAppointments","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The appointment to add","required":true,"schema":{"$ref":"#/definitions/CreateCoachingAppointmentRequest"}}],"responses":{"201":{"description":"Appointment created","schema":{"$ref":"#/definitions/CoachingAppointmentResponse"}},"202":{"description":"Appointment create request accepted","schema":{"$ref":"#/definitions/CoachingAppointmentReference"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"participate.permission.missing":"Some participants are missing the 'coaching:appointment:participate' permission.","validation.error":"Error validating the appointment.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.conflict":"Appointment dates clashes with another"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:appointment:add"]},"x-purecloud-method-name":"postCoachingAppointments"}},"/api/v2/authorization/roles/{roleId}":{"get":{"tags":["Authorization"],"summary":"Get a single organization role.","description":"Get the organization role specified by its ID.","operationId":"getAuthorizationRole","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand. \"unusedPermissions\" returns the permissions not used for the role","required":false,"type":"array","items":{"type":"string","enum":["unusedPermissions"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"unusedPermissions"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainOrganizationRole"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"An internal service error has occurred."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:view"]},"x-purecloud-method-name":"getAuthorizationRole"},"post":{"tags":["Authorization"],"summary":"Bulk-grant subjects and divisions with an organization role.","description":"","operationId":"postAuthorizationRole","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Subjects and Divisions","required":true,"schema":{"$ref":"#/definitions/SubjectDivisions"}},{"name":"subjectType","in":"query","description":"what the type of the subjects are (PC_GROUP, PC_USER or PC_OAUTH_CLIENT)","required":false,"type":"string","default":"PC_USER"}],"responses":{"204":{"description":"Bulk Grants Created"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request is badly formed.","invalid.subject.type":"Bad request, invalid subject type","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:add"]},"x-purecloud-method-name":"postAuthorizationRole"},"put":{"tags":["Authorization"],"summary":"Update an organization role.","description":"Update","operationId":"putAuthorizationRole","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Organization role","required":true,"schema":{"$ref":"#/definitions/DomainOrganizationRoleUpdate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainOrganizationRole"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request is badly formed.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:edit"]},"x-purecloud-method-name":"putAuthorizationRole"},"delete":{"tags":["Authorization"],"summary":"Delete an organization role.","description":"","operationId":"deleteAuthorizationRole","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:delete"]},"x-purecloud-method-name":"deleteAuthorizationRole"},"patch":{"tags":["Authorization"],"summary":"Patch Organization Role for needsUpdate Field","description":"Patch Organization Role for needsUpdate Field","operationId":"patchAuthorizationRole","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Organization role","required":true,"schema":{"$ref":"#/definitions/DomainOrganizationRole"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainOrganizationRole"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:edit"]},"x-purecloud-method-name":"patchAuthorizationRole"}},"/api/v2/outbound/contactlists/{contactListId}/contacts/bulk":{"post":{"tags":["Outbound"],"summary":"Get contacts from a contact list.","description":"","operationId":"postOutboundContactlistContactsBulk","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ContactIds to get.","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/DialerContact"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.contacts.requested":"Only 50 contacts can be retrieved at a time.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contact:view"]},"x-purecloud-method-name":"postOutboundContactlistContactsBulk"}},"/api/v2/orgauthorization/trustees/{trusteeOrgId}":{"get":{"tags":["Organization Authorization"],"summary":"Get Org Trust","description":"","operationId":"getOrgauthorizationTrustee","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Trustee"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrustee:view"]},"x-purecloud-method-name":"getOrgauthorizationTrustee"},"put":{"tags":["Organization Authorization"],"summary":"Update Org Trust","description":"","operationId":"putOrgauthorizationTrustee","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Client","required":true,"schema":{"$ref":"#/definitions/Trustee"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Trustee"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrustee:edit"]},"x-purecloud-method-name":"putOrgauthorizationTrustee"},"delete":{"tags":["Organization Authorization"],"summary":"Delete Org Trust","description":"","operationId":"deleteOrgauthorizationTrustee","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"}],"responses":{"204":{"description":"Trust deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrustee:delete"]},"x-purecloud-method-name":"deleteOrgauthorizationTrustee"}},"/api/v2/outbound/events/{eventId}":{"get":{"tags":["Outbound"],"summary":"Get Dialer Event","description":"","operationId":"getOutboundEvent","produces":["application/json"],"parameters":[{"name":"eventId","in":"path","description":"Event Log ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EventLog"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:eventLog:view"]},"x-purecloud-method-name":"getOutboundEvent"}},"/api/v2/architect/emergencygroups":{"get":{"tags":["Architect"],"summary":"Get a list of emergency groups.","description":"","operationId":"getArchitectEmergencygroups","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"name","in":"query","description":"Name of the Emergency Group to filter by.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmergencyGroupListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:emergencyGroup:view"]},"x-purecloud-method-name":"getArchitectEmergencygroups"},"post":{"tags":["Architect"],"summary":"Creates a new emergency group","description":"","operationId":"postArchitectEmergencygroups","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/EmergencyGroup"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmergencyGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:emergencyGroup:add"]},"x-purecloud-method-name":"postArchitectEmergencygroups"}},"/api/v2/telephony/providers/edges/{edgeId}/logs/jobs/{jobId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get an Edge logs job.","description":"","operationId":"getTelephonyProvidersEdgeLogsJob","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"jobId","in":"path","description":"Job ID","required":true,"type":"string"}],"responses":{"200":{"description":"Edge log list has been returned in the response.","schema":{"$ref":"#/definitions/EdgeLogsJob"}},"202":{"description":"Accepted - Processing Edge logs job, try again soon."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find the Edge logs job by given Id.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgeLogsJob"}},"/api/v2/languages/translations":{"get":{"tags":["Languages"],"summary":"Get all available languages for translation","description":"","operationId":"getLanguagesTranslations","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AvailableTranslations"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getLanguagesTranslations"}},"/api/v2/languages/translations/builtin":{"get":{"tags":["Languages"],"summary":"Get the builtin translation for a language","description":"","operationId":"getLanguagesTranslationsBuiltin","produces":["application/json"],"parameters":[{"name":"language","in":"query","description":"The language of the builtin translation to retrieve","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getLanguagesTranslationsBuiltin"}},"/api/v2/languages/translations/organization":{"get":{"tags":["Languages"],"summary":"Get effective translation for an organization by language","description":"","operationId":"getLanguagesTranslationsOrganization","produces":["application/json"],"parameters":[{"name":"language","in":"query","description":"The language of the translation to retrieve for the organization","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getLanguagesTranslationsOrganization"}},"/api/v2/languages/translations/users/{userId}":{"get":{"tags":["Languages"],"summary":"Get effective language translation for a user","description":"","operationId":"getLanguagesTranslationsUser","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"The user id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getLanguagesTranslationsUser"}},"/api/v2/conversations/messaging/integrations/line/{integrationId}":{"get":{"tags":["Conversations"],"summary":"Get a LINE messenger integration","description":"","operationId":"getConversationsMessagingIntegrationsLineIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LineIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:view"]},"x-purecloud-method-name":"getConversationsMessagingIntegrationsLineIntegrationId"},"put":{"tags":["Conversations"],"summary":"Update a LINE messenger integration","description":"","operationId":"putConversationsMessagingIntegrationsLineIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"},{"in":"body","name":"body","description":"LineIntegrationRequest","required":true,"schema":{"$ref":"#/definitions/LineIntegrationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LineIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.integration":"The integration request was invalid for this operation. One or more errors may be reported.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:edit"]},"x-purecloud-method-name":"putConversationsMessagingIntegrationsLineIntegrationId"},"delete":{"tags":["Conversations"],"summary":"Delete a LINE messenger integration","description":"","operationId":"deleteConversationsMessagingIntegrationsLineIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:delete"]},"x-purecloud-method-name":"deleteConversationsMessagingIntegrationsLineIntegrationId"}},"/api/v2/routing/wrapupcodes":{"get":{"tags":["Routing"],"summary":"Get list of wrapup codes.","description":"","operationId":"getRoutingWrapupcodes","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name","enum":["name","id"],"x-genesys-enum-members":[{"name":"name"},{"name":"id"}]},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ascending","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]},{"name":"name","in":"query","description":"Wrapup code's name ('Sort by' param is ignored unless this field is provided)","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapupCodeEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.page.number":"Invalid page number specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:wrapupCode:view"]},"x-purecloud-method-name":"getRoutingWrapupcodes"},"post":{"tags":["Routing"],"summary":"Create a wrap-up code","description":"","operationId":"postRoutingWrapupcodes","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"WrapupCode","required":true,"schema":{"$ref":"#/definitions/WrapupCode"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.name":"Invalid wrapup code name specified.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","duplicate.name":"A wrapup code with this name already exists.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:wrapupCode:add"]},"x-purecloud-method-name":"postRoutingWrapupcodes"}},"/api/v2/telephony/providers/edges/trunks/{trunkId}/metrics":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the trunk metrics.","description":"","operationId":"getTelephonyProvidersEdgesTrunkMetrics","produces":["application/json"],"parameters":[{"name":"trunkId","in":"path","description":"Trunk Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkMetrics"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find the trunk metrics with that id.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesTrunkMetrics"}},"/api/v2/conversations/messaging/facebook/app":{"get":{"tags":["Conversations"],"summary":"Get Genesys Facebook App Id","description":"","operationId":"getConversationsMessagingFacebookApp","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FacebookAppCredentials"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:add"]},"x-purecloud-method-name":"getConversationsMessagingFacebookApp"}},"/api/v2/recording/batchrequests":{"post":{"tags":["Recording"],"summary":"Submit a batch download request for recordings. Recordings in response will be in their original format/codec - configured in the Trunk configuration.","description":"","operationId":"postRecordingBatchrequests","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Job submission criteria","required":true,"schema":{"$ref":"#/definitions/BatchDownloadJobSubmission"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BatchDownloadJobSubmissionResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"batch.download.too.many.items":"Too many items requested, max 100 allowed","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","batch.download.bad.request":"Request list is required and must not be empty","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-purecloud-method-name":"postRecordingBatchrequests"}},"/api/v2/recording/batchrequests/{jobId}":{"get":{"tags":["Recording"],"summary":"Get the status and results for a batch request job, only the user that submitted the job may retrieve results","description":"","operationId":"getRecordingBatchrequest","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BatchDownloadJobStatusResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"batch.download.permission.denied":"Only user that initiated the job can request results","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","batch.download.job.not.found":"The requested job is unknown"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-purecloud-method-name":"getRecordingBatchrequest"}},"/api/v2/quality/conversations/{conversationId}/audits":{"get":{"tags":["Quality"],"summary":"Get audits for conversation or recording","description":"Different permissions are required for viewing different resource audit entries. The quality:evaluation:viewAudit permission is required to view evaluation audits, the recording:recording:viewAudit permission is required to view recording audits, and so on.","operationId":"getQualityConversationAudits","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"recordingId","in":"query","description":"id of the recording","required":false,"type":"string"},{"name":"entityType","in":"query","description":"entity type options: Recording, Calibration, Evaluation, Annotation, Screen_Recording","required":false,"type":"string","default":"Recording"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QualityAuditPage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.screen.recording.audit.view.permission.check.failed":"Screen recording audit view permission check failed.","recording.recording.audit.view.permission.check.failed":"Recording audit view permission check failed.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:calibration:viewAudit","quality:evaluation:viewAudit","quality:survey:viewAudit","recording:recording:viewAudit","recording:annotation:viewAudit","recording:screenRecording:viewAudit"]},"x-purecloud-method-name":"getQualityConversationAudits"}},"/api/v2/architect/dependencytracking/deletedresourceconsumers":{"get":{"tags":["Architect"],"summary":"Get Dependency Tracking objects that consume deleted resources","description":"","operationId":"getArchitectDependencytrackingDeletedresourceconsumers","produces":["application/json"],"parameters":[{"name":"name","in":"query","description":"Name to search for","required":false,"type":"string"},{"name":"objectType","in":"query","description":"Object type(s) to search for","required":false,"type":"array","items":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","BOTCONNECTORBOT","BOTCONNECTORBOTVERSION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GROUP","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","IVRCONFIGURATION","LANGUAGE","LEXBOT","LEXBOTALIAS","NLUDOMAIN","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","WIDGET","WORKFLOW"],"x-genesys-enum-members":[{"name":"ACDLANGUAGE"},{"name":"ACDSKILL"},{"name":"ACDWRAPUPCODE"},{"name":"BOTCONNECTORBOT"},{"name":"BOTCONNECTORBOTVERSION"},{"name":"BOTFLOW"},{"name":"BRIDGEACTION"},{"name":"COMMONMODULEFLOW"},{"name":"COMPOSERSCRIPT"},{"name":"CONTACTLIST"},{"name":"DATAACTION"},{"name":"DATATABLE"},{"name":"DIALOGENGINEBOT"},{"name":"DIALOGENGINEBOTVERSION"},{"name":"DIALOGFLOWAGENT"},{"name":"EMAILROUTE"},{"name":"EMERGENCYGROUP"},{"name":"FLOWACTION"},{"name":"FLOWDATATYPE"},{"name":"FLOWMILESTONE"},{"name":"FLOWOUTCOME"},{"name":"GROUP"},{"name":"INBOUNDCALLFLOW"},{"name":"INBOUNDCHATFLOW"},{"name":"INBOUNDEMAILFLOW"},{"name":"INBOUNDSHORTMESSAGEFLOW"},{"name":"INQUEUECALLFLOW"},{"name":"IVRCONFIGURATION"},{"name":"LANGUAGE"},{"name":"LEXBOT"},{"name":"LEXBOTALIAS"},{"name":"NLUDOMAIN"},{"name":"OUTBOUNDCALLFLOW"},{"name":"QUEUE"},{"name":"RECORDINGPOLICY"},{"name":"RESPONSE"},{"name":"SCHEDULE"},{"name":"SCHEDULEGROUP"},{"name":"SECUREACTION"},{"name":"SECURECALLFLOW"},{"name":"SURVEYINVITEFLOW"},{"name":"SYSTEMPROMPT"},{"name":"TTSENGINE"},{"name":"TTSVOICE"},{"name":"USER"},{"name":"USERPROMPT"},{"name":"WIDGET"},{"name":"WORKFLOW"}]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"ACDLANGUAGE"},{"name":"ACDSKILL"},{"name":"ACDWRAPUPCODE"},{"name":"BOTCONNECTORBOT"},{"name":"BOTCONNECTORBOTVERSION"},{"name":"BOTFLOW"},{"name":"BRIDGEACTION"},{"name":"COMMONMODULEFLOW"},{"name":"COMPOSERSCRIPT"},{"name":"CONTACTLIST"},{"name":"DATAACTION"},{"name":"DATATABLE"},{"name":"DIALOGENGINEBOT"},{"name":"DIALOGENGINEBOTVERSION"},{"name":"DIALOGFLOWAGENT"},{"name":"EMAILROUTE"},{"name":"EMERGENCYGROUP"},{"name":"FLOWACTION"},{"name":"FLOWDATATYPE"},{"name":"FLOWMILESTONE"},{"name":"FLOWOUTCOME"},{"name":"GROUP"},{"name":"INBOUNDCALLFLOW"},{"name":"INBOUNDCHATFLOW"},{"name":"INBOUNDEMAILFLOW"},{"name":"INBOUNDSHORTMESSAGEFLOW"},{"name":"INQUEUECALLFLOW"},{"name":"IVRCONFIGURATION"},{"name":"LANGUAGE"},{"name":"LEXBOT"},{"name":"LEXBOTALIAS"},{"name":"NLUDOMAIN"},{"name":"OUTBOUNDCALLFLOW"},{"name":"QUEUE"},{"name":"RECORDINGPOLICY"},{"name":"RESPONSE"},{"name":"SCHEDULE"},{"name":"SCHEDULEGROUP"},{"name":"SECUREACTION"},{"name":"SECURECALLFLOW"},{"name":"SURVEYINVITEFLOW"},{"name":"SYSTEMPROMPT"},{"name":"TTSENGINE"},{"name":"TTSVOICE"},{"name":"USER"},{"name":"USERPROMPT"},{"name":"WIDGET"},{"name":"WORKFLOW"}]},{"name":"flowFilter","in":"query","description":"Show only checkedIn or published flows","required":false,"type":"string","enum":["checkedIn","published"],"x-genesys-enum-members":[{"name":"checkedIn"},{"name":"published"}]},{"name":"consumedResources","in":"query","description":"Return consumed resources?","required":false,"type":"boolean","default":false},{"name":"consumedResourceType","in":"query","description":"Resource type(s) to return","required":false,"type":"array","items":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","BOTCONNECTORBOT","BOTCONNECTORBOTVERSION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GROUP","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","IVRCONFIGURATION","LANGUAGE","LEXBOT","LEXBOTALIAS","NLUDOMAIN","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","WIDGET","WORKFLOW"],"x-genesys-enum-members":[{"name":"ACDLANGUAGE"},{"name":"ACDSKILL"},{"name":"ACDWRAPUPCODE"},{"name":"BOTCONNECTORBOT"},{"name":"BOTCONNECTORBOTVERSION"},{"name":"BOTFLOW"},{"name":"BRIDGEACTION"},{"name":"COMMONMODULEFLOW"},{"name":"COMPOSERSCRIPT"},{"name":"CONTACTLIST"},{"name":"DATAACTION"},{"name":"DATATABLE"},{"name":"DIALOGENGINEBOT"},{"name":"DIALOGENGINEBOTVERSION"},{"name":"DIALOGFLOWAGENT"},{"name":"EMAILROUTE"},{"name":"EMERGENCYGROUP"},{"name":"FLOWACTION"},{"name":"FLOWDATATYPE"},{"name":"FLOWMILESTONE"},{"name":"FLOWOUTCOME"},{"name":"GROUP"},{"name":"INBOUNDCALLFLOW"},{"name":"INBOUNDCHATFLOW"},{"name":"INBOUNDEMAILFLOW"},{"name":"INBOUNDSHORTMESSAGEFLOW"},{"name":"INQUEUECALLFLOW"},{"name":"IVRCONFIGURATION"},{"name":"LANGUAGE"},{"name":"LEXBOT"},{"name":"LEXBOTALIAS"},{"name":"NLUDOMAIN"},{"name":"OUTBOUNDCALLFLOW"},{"name":"QUEUE"},{"name":"RECORDINGPOLICY"},{"name":"RESPONSE"},{"name":"SCHEDULE"},{"name":"SCHEDULEGROUP"},{"name":"SECUREACTION"},{"name":"SECURECALLFLOW"},{"name":"SURVEYINVITEFLOW"},{"name":"SYSTEMPROMPT"},{"name":"TTSENGINE"},{"name":"TTSVOICE"},{"name":"USER"},{"name":"USERPROMPT"},{"name":"WIDGET"},{"name":"WORKFLOW"}]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"ACDLANGUAGE"},{"name":"ACDSKILL"},{"name":"ACDWRAPUPCODE"},{"name":"BOTCONNECTORBOT"},{"name":"BOTCONNECTORBOTVERSION"},{"name":"BOTFLOW"},{"name":"BRIDGEACTION"},{"name":"COMMONMODULEFLOW"},{"name":"COMPOSERSCRIPT"},{"name":"CONTACTLIST"},{"name":"DATAACTION"},{"name":"DATATABLE"},{"name":"DIALOGENGINEBOT"},{"name":"DIALOGENGINEBOTVERSION"},{"name":"DIALOGFLOWAGENT"},{"name":"EMAILROUTE"},{"name":"EMERGENCYGROUP"},{"name":"FLOWACTION"},{"name":"FLOWDATATYPE"},{"name":"FLOWMILESTONE"},{"name":"FLOWOUTCOME"},{"name":"GROUP"},{"name":"INBOUNDCALLFLOW"},{"name":"INBOUNDCHATFLOW"},{"name":"INBOUNDEMAILFLOW"},{"name":"INBOUNDSHORTMESSAGEFLOW"},{"name":"INQUEUECALLFLOW"},{"name":"IVRCONFIGURATION"},{"name":"LANGUAGE"},{"name":"LEXBOT"},{"name":"LEXBOTALIAS"},{"name":"NLUDOMAIN"},{"name":"OUTBOUNDCALLFLOW"},{"name":"QUEUE"},{"name":"RECORDINGPOLICY"},{"name":"RESPONSE"},{"name":"SCHEDULE"},{"name":"SCHEDULEGROUP"},{"name":"SECUREACTION"},{"name":"SECURECALLFLOW"},{"name":"SURVEYINVITEFLOW"},{"name":"SYSTEMPROMPT"},{"name":"TTSENGINE"},{"name":"TTSVOICE"},{"name":"USER"},{"name":"USERPROMPT"},{"name":"WIDGET"},{"name":"WORKFLOW"}]},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DependencyObjectEntityListing"}},"206":{"description":"Partial Content - the org data is being rebuilt or needs to be rebuilt."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.dependency.invalid.filter":"An invalid filter was specified.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","architect.dependency.object.invalid.type":"An invalid dependency object type was specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","architect.database.throughput.exceeded":"Database too busy. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:dependencyTracking:view"]},"x-purecloud-method-name":"getArchitectDependencytrackingDeletedresourceconsumers"}},"/api/v2/flows/executions":{"post":{"tags":["Architect"],"summary":"Launch an instance of a flow definition, for flow types that support it such as the 'workflow' type.","description":"The launch is asynchronous, it returns as soon as the flow starts. You can use the returned ID to query its status if you need.","operationId":"postFlowsExecutions","produces":["application/json"],"parameters":[{"in":"body","name":"flowLaunchRequest","required":true,"schema":{"$ref":"#/definitions/FlowExecutionLaunchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowExecutionLaunchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","architect.object.validate.failed":"Failed to validate object.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.flow.not.found":"Could not find flow with specified ID."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.unspecified.error":"An unknown error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:launch"]},"x-purecloud-method-name":"postFlowsExecutions"}},"/api/v2/outbound/dnclists/{dncListId}/importstatus":{"get":{"tags":["Outbound"],"summary":"Get dialer dncList import status.","description":"","operationId":"getOutboundDnclistImportstatus","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ImportStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.not.found":"The do not call list could not be found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dncList:view"]},"x-purecloud-method-name":"getOutboundDnclistImportstatus"}},"/api/v2/coaching/appointments/aggregates/query":{"post":{"tags":["Coaching"],"summary":"Retrieve aggregated appointment data","description":"","operationId":"postCoachingAppointmentsAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Aggregate Request","required":true,"schema":{"$ref":"#/definitions/CoachingAppointmentAggregateRequest"}}],"responses":{"200":{"description":"Query completed successfully","schema":{"$ref":"#/definitions/CoachingAppointmentAggregateResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"aggregate.too.many.users":"Too many users were included in the request.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","validation.failure":"There was a problem with the request, see the message for details"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","no.permission.for.requested.users":"The requested users are in a division you do not have permission to.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","coaching:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:appointment:view"]},"x-purecloud-method-name":"postCoachingAppointmentsAggregatesQuery"}},"/api/v2/routing/queues/{queueId}":{"get":{"tags":["Routing"],"summary":"Get details about this queue.","description":"","operationId":"getRoutingQueue","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Queue"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"At least one of the required division permissions is missing","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:queue:view"]},"x-purecloud-method-name":"getRoutingQueue"},"put":{"tags":["Routing"],"summary":"Update a queue","description":"","operationId":"putRoutingQueue","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Queue","required":true,"schema":{"$ref":"#/definitions/QueueRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Queue"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Invalid media type specified.","source.queue.not.found":"Source queue not found.","bad.request":"Invalid request data.","duplicate.name":"A queue with this name already exists.","invalid.rule":"Invalid routing rule specified.","invalid.outbound.messaging.address.state":"Specified outbound messaging address is not active.","queue.deleted":"Queue has been deleted.","invalid.name":"Invalid queue name specified.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.phone.number":"Invalid phone number specified.","invalid.id":"Missing or invalid queue division ID.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","skill.does.not.exist":"Specified skill does not exist."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:edit"]},"x-purecloud-method-name":"putRoutingQueue"},"delete":{"tags":["Routing"],"summary":"Delete a queue","description":"","operationId":"deleteRoutingQueue","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"forceDelete","in":"query","description":"forceDelete","required":false,"type":"boolean"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","active.queue":"Queue contains active conversations."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"At least one of the required division permissions is missing","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:queue:delete"]},"x-purecloud-method-name":"deleteRoutingQueue"}},"/api/v2/externalcontacts/organizations/{externalOrganizationId}":{"get":{"tags":["External Contacts"],"summary":"Fetch an external organization","description":"","operationId":"getExternalcontactsOrganization","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand (externalDataSources)","required":false,"type":"string","enum":["externalDataSources"],"x-genesys-enum-members":[{"name":"externalDataSources"}]},{"name":"includeTrustors","in":"query","description":"(true or false) whether or not to include trustor information embedded in the externalOrganization","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalOrganization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"External organization is not found by external organization id.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:view","externalContacts:externalOrganization:view"]},"x-purecloud-method-name":"getExternalcontactsOrganization"},"put":{"tags":["External Contacts"],"summary":"Update an external organization","description":"","operationId":"putExternalcontactsOrganization","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ExternalOrganization","required":true,"schema":{"$ref":"#/definitions/ExternalOrganization"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalOrganization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided contact was not valid"}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:edit","externalContacts:externalOrganization:edit"]},"x-purecloud-method-name":"putExternalcontactsOrganization"},"delete":{"tags":["External Contacts"],"summary":"Delete an external organization","description":"","operationId":"deleteExternalcontactsOrganization","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:delete","externalContacts:externalOrganization:delete"]},"x-purecloud-method-name":"deleteExternalcontactsOrganization"}},"/api/v2/scripts/published/{scriptId}/pages":{"get":{"tags":["Scripts"],"summary":"Get the list of published pages","description":"","operationId":"getScriptsPublishedScriptIdPages","produces":["application/json"],"parameters":[{"name":"scriptId","in":"path","description":"Script ID","required":true,"type":"string"},{"name":"scriptDataVersion","in":"query","description":"Advanced usage - controls the data version of the script","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/Page"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:publishedScript:view"]},"x-purecloud-method-name":"getScriptsPublishedScriptIdPages"}},"/api/v2/voicemail/groups/{groupId}/mailbox":{"get":{"tags":["Voicemail"],"summary":"Get the group's mailbox information","description":"","operationId":"getVoicemailGroupMailbox","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"groupId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMailboxInfo"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-purecloud-method-name":"getVoicemailGroupMailbox"}},"/api/v2/voicemail/mailbox":{"get":{"tags":["Voicemail"],"summary":"Get the current user's mailbox information","description":"","operationId":"getVoicemailMailbox","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMailboxInfo"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-purecloud-method-name":"getVoicemailMailbox"}},"/api/v2/voicemail/me/mailbox":{"get":{"tags":["Voicemail"],"summary":"Get the current user's mailbox information","description":"","operationId":"getVoicemailMeMailbox","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMailboxInfo"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-purecloud-method-name":"getVoicemailMeMailbox"}},"/api/v2/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType}/{schemaId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a json schema (Deprecated)","description":"","operationId":"getConfigurationSchemasEdgesVnextSchemaCategorySchemaTypeSchemaId","produces":["application/json"],"parameters":[{"name":"schemaCategory","in":"path","description":"Schema category","required":true,"type":"string"},{"name":"schemaType","in":"path","description":"Schema type","required":true,"type":"string"},{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Organization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getConfigurationSchemasEdgesVnextSchemaCategorySchemaTypeSchemaId"}},"/api/v2/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType}/{schemaId}/{extensionType}/{metadataId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get metadata for a schema (Deprecated)","description":"","operationId":"getConfigurationSchemasEdgesVnextSchemaCategorySchemaTypeSchemaIdExtensionTypeMetadataId","produces":["application/json"],"parameters":[{"name":"schemaCategory","in":"path","description":"Schema category","required":true,"type":"string"},{"name":"schemaType","in":"path","description":"Schema type","required":true,"type":"string"},{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"},{"name":"extensionType","in":"path","description":"extension","required":true,"type":"string"},{"name":"metadataId","in":"path","description":"Metadata ID","required":true,"type":"string"},{"name":"type","in":"query","description":"Type","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Organization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getConfigurationSchemasEdgesVnextSchemaCategorySchemaTypeSchemaIdExtensionTypeMetadataId"}},"/api/v2/notifications/channels":{"get":{"tags":["Notifications"],"summary":"The list of existing channels","description":"","operationId":"getNotificationsChannels","produces":["application/json"],"parameters":[{"name":"includechannels","in":"query","description":"Show user's channels for this specific token or across all tokens for this user and app. Channel Ids for other access tokens will not be shown, but will be presented to show their existence.","required":false,"type":"string","default":"token","enum":["token","oauthclient"],"x-genesys-enum-members":[{"name":"token"},{"name":"oauthclient"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChannelEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["notifications"]}],"x-purecloud-method-name":"getNotificationsChannels"},"post":{"tags":["Notifications"],"summary":"Create a new channel","description":"There is a limit of 20 channels per user/app combination. Creating a 21st channel will remove the channel with oldest last used date. Channels without an active connection will be removed first.","operationId":"postNotificationsChannels","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Channel"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["notifications"]}],"x-purecloud-method-name":"postNotificationsChannels"}},"/api/v2/contentmanagement/workspaces/{workspaceId}/documents":{"get":{"tags":["Content Management"],"summary":"Get a list of documents.","description":"","operationId":"getContentmanagementWorkspaceDocuments","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["acl","workspace"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"acl"},{"name":"workspace"}]},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"name or dateCreated","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"ascending or descending","required":false,"type":"string","default":"ascending"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementWorkspaceDocuments"}},"/api/v2/scim/v2/serviceproviderconfig":{"get":{"tags":["SCIM"],"summary":"Get a service provider's configuration","description":"","operationId":"getScimV2Serviceproviderconfig","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"name":"If-None-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/serviceproviderconfig. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified. ","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimServiceProviderConfig"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimV2Serviceproviderconfig"}},"/api/v2/externalcontacts/organizations/{externalOrganizationId}/trustor/{trustorId}":{"put":{"tags":["External Contacts"],"summary":"Links a Trustor with an External Organization","description":"","operationId":"putExternalcontactsOrganizationTrustorTrustorId","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization ID","required":true,"type":"string"},{"name":"trustorId","in":"path","description":"Trustor ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalOrganizationTrustorLink"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Trustor is not found by trustor id.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"Provided fields are not valid."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:externalOrganization:edit"]},"x-purecloud-method-name":"putExternalcontactsOrganizationTrustorTrustorId"}},"/api/v2/license/infer":{"post":{"tags":["License"],"summary":"Get a list of licenses inferred based on a list of roleIds","description":"","operationId":"postLicenseInfer","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The roleIds to use while inferring licenses","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"type":"string"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["license","license:readonly"]}],"x-purecloud-method-name":"postLicenseInfer"}},"/api/v2/flows/{flowId}/versions/{versionId}":{"get":{"tags":["Architect"],"summary":"Get flow version","description":"","operationId":"getFlowVersion","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"},{"name":"versionId","in":"path","description":"Version ID","required":true,"type":"string"},{"name":"deleted","in":"query","description":"Deleted flows","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowVersion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.data.missing":"Flow version data content is missing.","architect.flow.version.missing":"Specified flow version is missing.","not.found":"The requested resource was not found.","architect.flow.not.found":"Could not find flow with specified ID."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.data.invalid.format":"Flow version data content is in an invalid format.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:view"]},"x-purecloud-method-name":"getFlowVersion"}},"/api/v2/flows/{flowId}/versions/{versionId}/configuration":{"get":{"tags":["Architect"],"summary":"Create flow version configuration","description":"","operationId":"getFlowVersionConfiguration","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"},{"name":"versionId","in":"path","description":"Version ID","required":true,"type":"string"},{"name":"deleted","in":"query","description":"Deleted flows","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"object"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:view"]},"x-purecloud-method-name":"getFlowVersionConfiguration"}},"/api/v2/integrations/speech/tts/engines/{engineId}/voices":{"get":{"tags":["Integrations"],"summary":"Get a list of voices for a TTS engine","description":"","operationId":"getIntegrationsSpeechTtsEngineVoices","produces":["application/json"],"parameters":[{"name":"engineId","in":"path","description":"The engine ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TtsVoiceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechTtsEngineVoices"}},"/api/v2/telephony/providers/edges/timezones":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of Edge-compatible time zones","description":"","operationId":"getTelephonyProvidersEdgesTimezones","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":1000,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeZoneEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"The application is not authorized for the scope.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-purecloud-method-name":"getTelephonyProvidersEdgesTimezones"}},"/api/v2/authorization/roles/{roleId}/subjectgrants":{"get":{"tags":["Authorization"],"summary":"Get the subjects' granted divisions in the specified role.","description":"Includes the divisions for which the subject has a grant.","operationId":"getAuthorizationRoleSubjectgrants","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SubjectDivisionGrantsEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:view"]},"x-purecloud-method-name":"getAuthorizationRoleSubjectgrants"}},"/api/v2/coaching/appointments/{appointmentId}":{"get":{"tags":["Coaching"],"summary":"Retrieve an appointment","description":"Permission not required if you are the attendee, creator or facilitator of the appointment","operationId":"getCoachingAppointment","produces":["application/json"],"parameters":[{"name":"appointmentId","in":"path","description":"The ID of the coaching appointment.","required":true,"type":"string"}],"responses":{"200":{"description":"Retrieved appointment","schema":{"$ref":"#/definitions/CoachingAppointmentResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"User does not have the appointment view permission and is not an attendee, creator or facilitator of the appointment"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.not.found":"Appointment not found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","coaching:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:appointment:view"]},"x-purecloud-method-name":"getCoachingAppointment"},"delete":{"tags":["Coaching"],"summary":"Delete an existing appointment","description":"Permission not required if you are the creator of the appointment","operationId":"deleteCoachingAppointment","produces":["application/json"],"parameters":[{"name":"appointmentId","in":"path","description":"The ID of the coaching appointment.","required":true,"type":"string"}],"responses":{"202":{"description":"Appointment delete request accepted.","schema":{"$ref":"#/definitions/CoachingAppointmentReference"}},"204":{"description":"Appointment deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"User does not have the appointment delete permission and is not a creator of the appointment"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.not.found":"Appointment not found","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.conflict":"There as a conflict deleting the appointment."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:appointment:delete"]},"x-purecloud-method-name":"deleteCoachingAppointment"},"patch":{"tags":["Coaching"],"summary":"Update an existing appointment","description":"Permission not required if you are the creator or facilitator of the appointment","operationId":"patchCoachingAppointment","produces":["application/json"],"parameters":[{"name":"appointmentId","in":"path","description":"The ID of the coaching appointment.","required":true,"type":"string"},{"in":"body","name":"body","description":"The new version of the appointment","required":true,"schema":{"$ref":"#/definitions/UpdateCoachingAppointmentRequest"}}],"responses":{"200":{"description":"Appointment updated","schema":{"$ref":"#/definitions/CoachingAppointmentResponse"}},"202":{"description":"Appointment update request accepted.","schema":{"$ref":"#/definitions/CoachingAppointmentReference"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"participate.permission.missing":"Some participants are missing the 'coaching:appointment:participate' permission.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"User does not have the appointment edit permission and is not a creator or facilitator of the appointment"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.not.found":"Appointment not found","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.conflict":"Appointment dates clashes with another","appointment.state.conflict":"The state of the appointment prevents the changes you are requesting."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:appointment:edit"]},"x-purecloud-method-name":"patchCoachingAppointment"}},"/api/v2/coaching/appointments/{appointmentId}/conversations":{"post":{"tags":["Coaching"],"summary":"Add a conversation to an appointment","description":"Permission not required if you are the creator or facilitator of the appointment","operationId":"postCoachingAppointmentConversations","produces":["application/json"],"parameters":[{"name":"appointmentId","in":"path","description":"The ID of the coaching appointment.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/AddConversationRequest"}}],"responses":{"200":{"description":"Conversation Added","schema":{"$ref":"#/definitions/AddConversationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"User does not have the permissions and is not a creator or facilitator of the appointment"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.not.found":"Appointment not found","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.state.conflict":"The state of the appointment prevents the changes you are requesting."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:appointment:edit","coaching:appointmentConversation:add"]},"x-purecloud-method-name":"postCoachingAppointmentConversations"}},"/api/v2/scripts/published/{scriptId}/pages/{pageId}":{"get":{"tags":["Scripts"],"summary":"Get the published page.","description":"","operationId":"getScriptsPublishedScriptIdPage","produces":["application/json"],"parameters":[{"name":"scriptId","in":"path","description":"Script ID","required":true,"type":"string"},{"name":"pageId","in":"path","description":"Page ID","required":true,"type":"string"},{"name":"scriptDataVersion","in":"query","description":"Advanced usage - controls the data version of the script","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Page"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:publishedScript:view"]},"x-purecloud-method-name":"getScriptsPublishedScriptIdPage"}},"/api/v2/stations/{stationId}":{"get":{"tags":["Stations"],"summary":"Get station.","description":"","operationId":"getStation","produces":["application/json"],"parameters":[{"name":"stationId","in":"path","description":"Station ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Station"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Specified station resource not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["stations","stations:readonly"]}],"x-purecloud-method-name":"getStation"}},"/api/v2/stations/{stationId}/associateduser":{"delete":{"tags":["Stations"],"summary":"Unassigns the user assigned to this station","description":"","operationId":"deleteStationAssociateduser","produces":["application/json"],"parameters":[{"name":"stationId","in":"path","description":"Station ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["stations"]}],"x-purecloud-method-name":"deleteStationAssociateduser"}},"/api/v2/telephony/providers/edges/extensions":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a listing of extensions","description":"","operationId":"getTelephonyProvidersEdgesExtensions","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"number"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"number","in":"query","description":"Filter by number","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExtensionEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesExtensions"}},"/api/v2/conversations/messaging/integrations/twitter/{integrationId}":{"get":{"tags":["Conversations"],"summary":"Get a Twitter messaging integration","description":"","operationId":"getConversationsMessagingIntegrationsTwitterIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TwitterIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:view"]},"x-purecloud-method-name":"getConversationsMessagingIntegrationsTwitterIntegrationId"},"delete":{"tags":["Conversations"],"summary":"Delete a Twitter messaging integration","description":"","operationId":"deleteConversationsMessagingIntegrationsTwitterIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:delete"]},"x-purecloud-method-name":"deleteConversationsMessagingIntegrationsTwitterIntegrationId"},"patch":{"tags":["Conversations"],"summary":"Update Twitter messaging integration","description":"","operationId":"patchConversationsMessagingIntegrationsTwitterIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"},{"in":"body","name":"body","description":"TwitterIntegrationRequest","required":true,"schema":{"$ref":"#/definitions/TwitterIntegrationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TwitterIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.integration":"The integration request was invalid for this operation. One or more errors may be reported.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:edit"]},"x-purecloud-method-name":"patchConversationsMessagingIntegrationsTwitterIntegrationId"}},"/api/v2/conversations/cobrowsesessions":{"get":{"tags":["Conversations"],"summary":"Get active cobrowse conversations for the logged in user","description":"","operationId":"getConversationsCobrowsesessions","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CobrowseConversationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCobrowsesessions"}},"/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/wrapupcodes":{"get":{"tags":["Conversations"],"summary":"Get list of wrapup codes for this conversation participant","description":"","operationId":"getConversationsCobrowsesessionParticipantWrapupcodes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCobrowsesessionParticipantWrapupcodes"}},"/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/attributes":{"patch":{"tags":["Conversations"],"summary":"Update the attributes on a conversation participant.","description":"","operationId":"patchConversationsCobrowsesessionParticipantAttributes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ParticipantAttributes"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsCobrowsesessionParticipantAttributes"}},"/api/v2/conversations/cobrowsesessions/{conversationId}":{"get":{"tags":["Conversations"],"summary":"Get cobrowse conversation","description":"","operationId":"getConversationsCobrowsesession","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CobrowseConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCobrowsesession"},"patch":{"tags":["Conversations"],"summary":"Update a conversation by disconnecting all of the participants","description":"","operationId":"patchConversationsCobrowsesession","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation","required":true,"schema":{"$ref":"#/definitions/Conversation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Conversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:disconnect"]},"x-purecloud-method-name":"patchConversationsCobrowsesession"}},"/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation participant. ","description":"","operationId":"getConversationsCobrowsesessionParticipantWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCobrowsesessionParticipantWrapup"}},"/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/communications/{communicationId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant's communication by disconnecting it.","description":"","operationId":"patchConversationsCobrowsesessionParticipantCommunication","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"communication.state.required":"Can only update a communication's state to disconnected.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsCobrowsesessionParticipantCommunication"}},"/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant","description":"","operationId":"patchConversationsCobrowsesessionParticipant","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.participant.update.invalid":"Failed to update all properties on conversation participant.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.participant.update.failed":"Failed to update all properties on conversation participant.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsCobrowsesessionParticipant"}},"/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/replace":{"post":{"tags":["Conversations"],"summary":"Replace this participant with the specified user and/or address","description":"","operationId":"postConversationsCobrowsesessionParticipantReplace","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/TransferRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","conversations.error.queue.not.found":"Interaction cannot be transferred to a queue that does not exist.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationsCobrowsesessionParticipantReplace"}},"/api/v2/ipranges":{"get":{"tags":["Utilities"],"summary":"Get public ip address ranges for PureCloud","description":"","operationId":"getIpranges","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IpAddressRangeListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":[]}],"x-purecloud-method-name":"getIpranges"}},"/api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get an outbound route","description":"","operationId":"getTelephonyProvidersEdgesSiteOutboundroute","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"name":"outboundRouteId","in":"path","description":"Outbound route ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutboundRouteBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesSiteOutboundroute"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update outbound route","description":"","operationId":"putTelephonyProvidersEdgesSiteOutboundroute","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"name":"outboundRouteId","in":"path","description":"Outbound route ID","required":true,"type":"string"},{"in":"body","name":"body","description":"OutboundRoute","required":true,"schema":{"$ref":"#/definitions/OutboundRouteBase"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutboundRouteBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"required.field.missing":"A required field is missing a value.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.value":"An outbound route with this name already exists.","address.classification.type.does.not.exist":"One of the address classifications does not exist.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"Dependent entities exist."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesSiteOutboundroute"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete Outbound Route","description":"","operationId":"deleteTelephonyProvidersEdgesSiteOutboundroute","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"name":"outboundRouteId","in":"path","description":"Outbound route ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdgesSiteOutboundroute"}},"/api/v2/quality/conversations/{conversationId}/surveys":{"get":{"tags":["Quality"],"summary":"Get the surveys for a conversation","description":"","operationId":"getQualityConversationSurveys","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/Survey"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:survey:view"]},"x-purecloud-method-name":"getQualityConversationSurveys"}},"/api/v2/telephony/providers/edges/{edgeId}/lines/{lineId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get line","description":"","operationId":"getTelephonyProvidersEdgeLine","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"lineId","in":"path","description":"Line ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeLine"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a line with that id","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgeLine"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a line.","description":"","operationId":"putTelephonyProvidersEdgeLine","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"lineId","in":"path","description":"Line ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Line","required":true,"schema":{"$ref":"#/definitions/EdgeLine"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeLine"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgeLine"}},"/api/v2/journey/segments":{"get":{"tags":["Journey"],"summary":"Retrieve all segments.","description":"","operationId":"getJourneySegments","produces":["application/json"],"parameters":[{"name":"sortBy","in":"query","description":"Field(s) to sort by. The response can be sorted by any first level property on the Outcome response. Prefix with '-' for descending (e.g. sortBy=displayName,-createdDate).","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"isActive","in":"query","description":"Determines whether or not to show only active segments.","required":false,"type":"boolean"},{"name":"segmentIds","in":"query","description":"IDs of segments to return. Use of this parameter is not compatible with pagination or sorting. A maximum of 100 segments are allowed per request.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SegmentListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:segment:view"]},"x-purecloud-method-name":"getJourneySegments"},"post":{"tags":["Journey"],"summary":"Create a segment.","description":"","operationId":"postJourneySegments","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/JourneySegment"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JourneySegment"}},"201":{"description":"Segment created.","schema":{"$ref":"#/definitions/JourneySegment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:segment:add"]},"x-purecloud-method-name":"postJourneySegments"}},"/api/v2/users/{userId}/profile":{"get":{"tags":["Users"],"summary":"Get user profile","description":"This api has been deprecated. Use api/v2/users instead","operationId":"getUserProfile","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"userId","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"routingStatus"},{"name":"presence"},{"name":"conversationSummary"},{"name":"outOfOffice"},{"name":"geolocation"},{"name":"station"},{"name":"authorization"},{"name":"lasttokenissued"},{"name":"authorization.unusedRoles"},{"name":"team"}]},{"name":"integrationPresenceSource","in":"query","description":"Gets an integration presence for a user instead of their default.","required":false,"type":"string","enum":["MicrosoftTeams","ZoomPhone","RingCentral"],"x-genesys-enum-members":[{"name":"MicrosoftTeams"},{"name":"ZoomPhone"},{"name":"RingCentral"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserProfile"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find the user profile","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getUserProfile"}},"/api/v2/recordings/deletionprotection":{"post":{"tags":["Recording"],"summary":"Get a list of conversations with protected recordings","description":"","operationId":"postRecordingsDeletionprotection","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"conversationIds","required":true,"schema":{"$ref":"#/definitions/ConversationDeletionProtectionQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/AddressableEntityRef"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.conversation.id.not.uuid":"Request needs recording conversation ID not UUID.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.conversation.not.found":"Recording conversation not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings:readonly"]}],"x-purecloud-method-name":"postRecordingsDeletionprotection"},"put":{"tags":["Recording"],"summary":"Apply or revoke recording protection for conversations","description":"","operationId":"putRecordingsDeletionprotection","produces":["application/json"],"parameters":[{"name":"protect","in":"query","description":"Check for apply, uncheck for revoke (each action requires the respective permission)","required":false,"type":"boolean","default":true},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ConversationDeletionProtectionQuery"}}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.conversation.not.found":"Recording conversation not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:deletionProtection:apply","recording:deletionProtection:revoke"]},"x-purecloud-method-name":"putRecordingsDeletionprotection"}},"/api/v2/usage/query":{"post":{"tags":["Usage"],"summary":"Query organization API Usage - ","description":"After calling this method, you will then need to poll for the query results based on the returned execution Id","operationId":"postUsageQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Query","required":true,"schema":{"$ref":"#/definitions/ApiUsageQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UsageExecutionResult"}},"202":{"description":"Execution not completed, check back for results","schema":{"$ref":"#/definitions/UsageExecutionResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:view"]},"x-purecloud-method-name":"postUsageQuery"}},"/api/v2/integrations/{integrationId}/config/current":{"get":{"tags":["Integrations"],"summary":"Get integration configuration.","description":"","operationId":"getIntegrationConfigCurrent","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IntegrationConfiguration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-purecloud-method-name":"getIntegrationConfigCurrent"},"put":{"tags":["Integrations"],"summary":"Update integration configuration.","description":"","operationId":"putIntegrationConfigCurrent","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Integration Configuration","required":false,"schema":{"$ref":"#/definitions/IntegrationConfiguration"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IntegrationConfiguration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"version.conflict":"Integration configuration update failed due to version conflict."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-purecloud-method-name":"putIntegrationConfigCurrent"}},"/api/v2/authorization/divisions/{divisionId}/grants":{"get":{"tags":["Authorization"],"summary":"Gets all grants for a given division.","description":"Returns all grants assigned to a given division. Maximum page size is 500.","operationId":"getAuthorizationDivisionGrants","produces":["application/json"],"parameters":[{"name":"divisionId","in":"path","description":"Division ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuthzDivisionGrantEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:view"]},"x-purecloud-method-name":"getAuthorizationDivisionGrants"}},"/api/v2/architect/systemprompts":{"get":{"tags":["Architect"],"summary":"Get System Prompts","description":"","operationId":"getArchitectSystemprompts","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"id"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"description","in":"query","description":"Description","required":false,"type":"string"},{"name":"nameOrDescription","in":"query","description":"Name or description","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SystemPromptEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:systemPrompt:view"]},"x-purecloud-method-name":"getArchitectSystemprompts"}},"/api/v2/widgets/deployments/{deploymentId}":{"get":{"tags":["Widgets"],"summary":"Get a Widget deployment","description":"","operationId":"getWidgetsDeployment","produces":["application/json"],"parameters":[{"name":"deploymentId","in":"path","description":"Widget Config Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WidgetDeployment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["widgets","widgets:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["widgets:deployment:view","webchat:deployment:read"]},"x-purecloud-method-name":"getWidgetsDeployment"},"put":{"tags":["Widgets"],"summary":"Update a Widget deployment","description":"","operationId":"putWidgetsDeployment","produces":["application/json"],"parameters":[{"name":"deploymentId","in":"path","description":"Widget Config Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Deployment","required":true,"schema":{"$ref":"#/definitions/WidgetDeployment"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WidgetDeployment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["widgets"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["widgets:deployment:edit","webchat:deployment:update"]},"x-purecloud-method-name":"putWidgetsDeployment"},"delete":{"tags":["Widgets"],"summary":"Delete a Widget deployment","description":"","operationId":"deleteWidgetsDeployment","produces":["application/json"],"parameters":[{"name":"deploymentId","in":"path","description":"Widget Config Id","required":true,"type":"string"}],"responses":{"204":{"description":"Deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["widgets"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["widgets:deployment:delete","webchat:deployment:delete"]},"x-purecloud-method-name":"deleteWidgetsDeployment"}},"/api/v2/telephony/providers/edges/outboundroutes":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get outbound routes","description":"","operationId":"getTelephonyProvidersEdgesOutboundroutes","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"site.id","in":"query","description":"Filter by site.id","required":false,"type":"string"},{"name":"externalTrunkBases.ids","in":"query","description":"Filter by externalTrunkBases.ids","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutboundRouteEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Unable to find an outbound route with that id","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.rate.limit":"Request rate limit exceeded.","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesOutboundroutes"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create outbound rule","description":"","operationId":"postTelephonyProvidersEdgesOutboundroutes","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"OutboundRoute","required":true,"schema":{"$ref":"#/definitions/OutboundRoute"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutboundRoute"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"required.field.missing":"A required field is missing a value.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","number.plan.type.usage.must.be.unique":"The number plan type usage must be unique.","duplicate.value":"An outbound route with this name already exists.","address.classification.type.does.not.exist":"One of the address classifications does not exist.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesOutboundroutes"}},"/api/v2/quality/forms":{"get":{"tags":["Quality"],"summary":"Get the list of evaluation forms","description":"","operationId":"getQualityForms","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"expand","in":"query","description":"Expand","required":false,"type":"string"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Order to sort results, either asc or desc","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:view"]},"x-purecloud-method-name":"getQualityForms"},"post":{"tags":["Quality"],"summary":"Create an evaluation form.","description":"","operationId":"postQualityForms","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Evaluation form","required":true,"schema":{"$ref":"#/definitions/EvaluationForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"evaluation.form.invalid":"Evaluation form is not valid","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:add"]},"x-purecloud-method-name":"postQualityForms"}},"/api/v2/recordings/screensessions":{"get":{"tags":["Recording"],"summary":"Retrieves a paged listing of screen recording sessions","description":"","operationId":"getRecordingsScreensessions","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScreenRecordingSessionListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:screenRecording:view"]},"x-purecloud-method-name":"getRecordingsScreensessions"}},"/api/v2/recordings/screensessions/{recordingSessionId}":{"patch":{"tags":["Recording"],"summary":"Update a screen recording session","description":"","operationId":"patchRecordingsScreensession","produces":["application/json"],"parameters":[{"name":"recordingSessionId","in":"path","description":"Screen recording session ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ScreenRecordingSessionRequest"}}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","qm.screen.recording.state.required":"Can only update a screen recording session's state to stopped.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","recording.recording.stop.permission.check.failed":"Failed to check required stop permission."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:screenRecording:stop"]},"x-purecloud-method-name":"patchRecordingsScreensession"}},"/api/v2/conversations/messaging/integrations/facebook/{integrationId}":{"get":{"tags":["Conversations"],"summary":"Get a Facebook messaging integration","description":"","operationId":"getConversationsMessagingIntegrationsFacebookIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FacebookIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:view"]},"x-purecloud-method-name":"getConversationsMessagingIntegrationsFacebookIntegrationId"},"delete":{"tags":["Conversations"],"summary":"Delete a Facebook messaging integration","description":"","operationId":"deleteConversationsMessagingIntegrationsFacebookIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:delete"]},"x-purecloud-method-name":"deleteConversationsMessagingIntegrationsFacebookIntegrationId"},"patch":{"tags":["Conversations"],"summary":"Update Facebook messaging integration","description":"","operationId":"patchConversationsMessagingIntegrationsFacebookIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"},{"in":"body","name":"body","description":"FacebookIntegrationUpdateRequest","required":true,"schema":{"$ref":"#/definitions/FacebookIntegrationUpdateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FacebookIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.integration":"The integration request was invalid for this operation. One or more errors may be reported.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:edit"]},"x-purecloud-method-name":"patchConversationsMessagingIntegrationsFacebookIntegrationId"}},"/api/v2/scripts/{scriptId}":{"get":{"tags":["Scripts"],"summary":"Get a script","description":"","operationId":"getScript","produces":["application/json"],"parameters":[{"name":"scriptId","in":"path","description":"Script ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Script"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:script:view"]},"x-purecloud-method-name":"getScript"}},"/api/v2/analytics/reporting/schedules/{scheduleId}":{"get":{"tags":["Analytics"],"summary":"Get a scheduled report job.","description":"","operationId":"getAnalyticsReportingSchedule","produces":["application/json"],"parameters":[{"name":"scheduleId","in":"path","description":"Schedule ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-purecloud-method-name":"getAnalyticsReportingSchedule"},"put":{"tags":["Analytics"],"summary":"Update a scheduled report job.","description":"","operationId":"putAnalyticsReportingSchedule","produces":["application/json"],"parameters":[{"name":"scheduleId","in":"path","description":"Schedule ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ReportSchedule","required":true,"schema":{"$ref":"#/definitions/ReportSchedule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["reporting:acd:view, reporting:status:view, reporting:interactions:view, reporting:outbound:view, reporting:quality:view, employee"]},"x-purecloud-method-name":"putAnalyticsReportingSchedule"},"delete":{"tags":["Analytics"],"summary":"Delete a scheduled report job.","description":"","operationId":"deleteAnalyticsReportingSchedule","produces":["application/json"],"parameters":[{"name":"scheduleId","in":"path","description":"Schedule ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics"]}],"x-purecloud-method-name":"deleteAnalyticsReportingSchedule"}},"/api/v2/analytics/surveys/aggregates/query":{"post":{"tags":["Quality","Analytics"],"summary":"Query for survey aggregates","description":"","operationId":"postAnalyticsSurveysAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/SurveyAggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:surveyAggregate:view"]},"x-purecloud-method-name":"postAnalyticsSurveysAggregatesQuery"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/agentschedules/search":{"post":{"tags":["Workforce Management"],"summary":"Search published schedules","description":"","operationId":"postWorkforcemanagementBusinessunitAgentschedulesSearch","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/BuSearchAgentSchedulesRequest"}},{"name":"forceAsync","in":"query","description":"Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes","required":false,"type":"boolean"},{"name":"forceDownloadService","in":"query","description":"Force the result of this operation to be sent via download service. For testing/app development purposes","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuAsyncAgentSchedulesSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:view","wfm:publishedSchedule:view"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitAgentschedulesSearch"}},"/api/v2/routing/skills":{"get":{"tags":["Routing"],"summary":"Get the list of routing skills.","description":"","operationId":"getRoutingSkills","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Filter for results that start with this value","required":false,"type":"string"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SkillEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-purecloud-method-name":"getRoutingSkills"},"post":{"tags":["Routing"],"summary":"Create Skill","description":"","operationId":"postRoutingSkills","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Skill","required":true,"schema":{"$ref":"#/definitions/RoutingSkill"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RoutingSkill"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","general.conflict":"The request could not be completed by the server due to a conflict."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be completed by the server due to a conflict."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:manage"]},"x-purecloud-method-name":"postRoutingSkills"}},"/api/v2/greetings":{"get":{"tags":["Greetings"],"summary":"Gets an Organization's Greetings","description":"","operationId":"getGreetings","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings","greetings:readonly"]}],"x-purecloud-method-name":"getGreetings"},"post":{"tags":["Greetings"],"summary":"Create a Greeting for an Organization","description":"","operationId":"postGreetings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The Greeting to create","required":true,"schema":{"$ref":"#/definitions/Greeting"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Greeting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings"]}],"x-purecloud-method-name":"postGreetings"}},"/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/wrapupcodes":{"get":{"tags":["Conversations"],"summary":"Get list of wrapup codes for this conversation participant","description":"","operationId":"getConversationsCallbackParticipantWrapupcodes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCallbackParticipantWrapupcodes"}},"/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/attributes":{"patch":{"tags":["Conversations"],"summary":"Update the attributes on a conversation participant.","description":"","operationId":"patchConversationsCallbackParticipantAttributes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Attributes","required":true,"schema":{"$ref":"#/definitions/ParticipantAttributes"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsCallbackParticipantAttributes"}},"/api/v2/conversations/callbacks/{conversationId}":{"get":{"tags":["Conversations"],"summary":"Get callback conversation","description":"","operationId":"getConversationsCallback","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallbackConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCallback"},"patch":{"tags":["Conversations"],"summary":"Update a conversation by disconnecting all of the participants","description":"","operationId":"patchConversationsCallback","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation","required":true,"schema":{"$ref":"#/definitions/Conversation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Conversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.empty.conversation.list":"An empty list of conversations is invalid.","conversation.error.cannot.conference.self":"A conversation cannot be merged with itself.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:disconnect"]},"x-purecloud-method-name":"patchConversationsCallback"}},"/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation participant. ","description":"","operationId":"getConversationsCallbackParticipantWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","conversation.error.participant.no.active.conversations":"The participant has no active conversation."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCallbackParticipantWrapup"}},"/api/v2/conversations/callbacks":{"get":{"tags":["Conversations"],"summary":"Get active callback conversations for the logged in user","description":"","operationId":"getConversationsCallbacks","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallbackConversationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCallbacks"},"post":{"tags":["Conversations"],"summary":"Create a Callback","description":"","operationId":"postConversationsCallbacks","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Callback","required":true,"schema":{"$ref":"#/definitions/CreateCallbackCommand"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CreateCallbackResponse"}},"202":{"description":"Accepted - Creating and Processing a Callback"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"callback.error.missing.callback.numbers":"Callback numbers missing","callback.error.missing.queue.id":"Callback missing queue ID","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","callback.error.scheduled.time.too.far.in.future":"Callback is scheduled to far in the future.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["conversation:callback:create"]},"x-purecloud-method-name":"postConversationsCallbacks"}},"/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant","description":"","operationId":"patchConversationsCallbackParticipant","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.participant.update.invalid":"Failed to update all properties on conversation participant.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","callback.error.transfer.canceled":"Answer failed because a pending attended transfer was canceled.","callback.error.answer.not.alerting":"Only alerting calls can be answered.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","conversation.error.participant.no.active.conversations":"The participant has no active conversation.","callback.error.conversation.not.found":"Conversation not found."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.participant.update.failed":"Failed to update all properties on conversation participant.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsCallbackParticipant"}},"/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/communications/{communicationId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant's communication by disconnecting it.","description":"","operationId":"patchConversationsCallbackParticipantCommunication","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"communication.state.required":"Can only update a communication's state to disconnected.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsCallbackParticipantCommunication"}},"/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/replace":{"post":{"tags":["Conversations"],"summary":"Replace this participant with the specified user and/or address","description":"","operationId":"postConversationsCallbackParticipantReplace","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Transfer request","required":true,"schema":{"$ref":"#/definitions/TransferRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversations.error.transfer.same.party":"The target of the transfer cannot be the same as the destination.","callback.error.user.id.queue.id":"In destination, exactly one of userId or queueId is required.","callback.error.parse.call.number":"A callback number cannot be parsed as a phone address.","conversations.error.transfer.acd.call.unattended.":"An ACD call cannot be transferred unattended.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","conversations.error.queue.not.found":"Interaction cannot be transferred to a queue that does not exist.","conversations.error.transfer.not.connected":"You can only transfer conversations that are in the connected state.","callback.error.transfer.not.connected":"Only connected participants can be transferred","callback.error.additional.info.value.length.invalid":"The length of the additional info value is invalid.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"callback.error.unable.to.schedule.callback":"Server error unable to schedule callback.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationsCallbackParticipantReplace"}},"/api/v2/architect/systemprompts/{promptId}/history/{historyId}":{"get":{"tags":["Architect"],"summary":"Get generated prompt history","description":"","operationId":"getArchitectSystempromptHistoryHistoryId","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"promptId","required":true,"type":"string"},{"name":"historyId","in":"path","description":"History request ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"desc"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"timestamp","enum":["action","timestamp","user"],"x-genesys-enum-members":[{"name":"action"},{"name":"timestamp"},{"name":"user"}]},{"name":"action","in":"query","description":"Flow actions to include (omit to include all)","required":false,"type":"array","items":{"type":"string","enum":["checkin","checkout","create","deactivate","debug","delete","publish","revert","save"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"checkin"},{"name":"checkout"},{"name":"create"},{"name":"deactivate"},{"name":"debug"},{"name":"delete"},{"name":"publish"},{"name":"revert"},{"name":"save"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/HistoryListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.system.prompt.not.found":"Could not find system prompt with specified ID.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:systemPrompt:view"]},"x-purecloud-method-name":"getArchitectSystempromptHistoryHistoryId"}},"/api/v2/architect/systemprompts/{promptId}/history":{"post":{"tags":["Architect"],"summary":"Generate system prompt history","description":"Asynchronous. Notification topic: v2.architect.systemprompts.{systemPromptId}","operationId":"postArchitectSystempromptHistory","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"promptId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Operation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:systemPrompt:view"]},"x-purecloud-method-name":"postArchitectSystempromptHistory"}},"/api/v2/architect/systemprompts/{promptId}":{"get":{"tags":["Architect"],"summary":"Get a system prompt","description":"","operationId":"getArchitectSystemprompt","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"promptId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SystemPrompt"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.system.prompt.not.found":"Could not find system prompt with specified ID.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:systemPrompt:view"]},"x-purecloud-method-name":"getArchitectSystemprompt"}},"/api/v2/integrations/actions/{actionId}":{"get":{"tags":["Integrations"],"summary":"Retrieves a single Action matching id.","description":"","operationId":"getIntegrationsAction","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"name":"expand","in":"query","description":"Indicates a field in the response which should be expanded.","required":false,"type":"string","enum":["contract"],"x-genesys-enum-members":[{"name":"contract"}]},{"name":"includeConfig","in":"query","description":"Return config in response.","required":false,"type":"boolean","default":false,"enum":["true","false"],"x-genesys-enum-members":[{"name":"true"},{"name":"false"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Action"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:view","bridge:actions:view"]},"x-purecloud-method-name":"getIntegrationsAction"},"delete":{"tags":["Integrations"],"summary":"Delete an Action","description":"","operationId":"deleteIntegrationsAction","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"}],"responses":{"204":{"description":"Delete was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:delete"]},"x-purecloud-method-name":"deleteIntegrationsAction"},"patch":{"tags":["Integrations"],"summary":"Patch an Action","description":"","operationId":"patchIntegrationsAction","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"in":"body","name":"body","description":"Input used to patch the Action.","required":true,"schema":{"$ref":"#/definitions/UpdateActionInput"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Action"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:edit"]},"x-purecloud-method-name":"patchIntegrationsAction"}},"/api/v2/integrations/actions/{actionId}/test":{"post":{"tags":["Integrations"],"summary":"Test the execution of an action. Responses will show execution steps broken out with intermediate results to help in debugging.","description":"","operationId":"postIntegrationsActionTest","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"in":"body","name":"body","description":"Map of parameters used for variable substitution.","required":true,"schema":{"type":"object","additionalProperties":{"type":"object"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TestExecutionResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:execute","bridge:actions:execute"]},"x-purecloud-method-name":"postIntegrationsActionTest"}},"/api/v2/integrations/actions/{actionId}/schemas/{fileName}":{"get":{"tags":["Integrations"],"summary":"Retrieve schema for an action based on filename.","description":"","operationId":"getIntegrationsActionSchema","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"name":"fileName","in":"path","description":"Name of schema file to be retrieved for this action.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JsonSchemaDocument"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:view","bridge:actions:view"]},"x-purecloud-method-name":"getIntegrationsActionSchema"}},"/api/v2/integrations/actions/{actionId}/templates/{fileName}":{"get":{"tags":["Integrations"],"summary":"Retrieve text of templates for an action based on filename.","description":"","operationId":"getIntegrationsActionTemplate","produces":["text/plain"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"name":"fileName","in":"path","description":"Name of template file to be retrieved for this action.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:view","bridge:actions:view"]},"x-purecloud-method-name":"getIntegrationsActionTemplate"}},"/api/v2/integrations/actions/{actionId}/execute":{"post":{"tags":["Integrations"],"summary":"Execute Action and return response from 3rd party. Responses will follow the schemas defined on the Action for success and error.","description":"","operationId":"postIntegrationsActionExecute","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"in":"body","name":"body","description":"Map of parameters used for variable substitution.","required":true,"schema":{"type":"object","additionalProperties":{"type":"object"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"object"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.substitution":"There was an issue substituting a value in one of the templates","no.results":"No results were found.","too.many.results":"Too many results matched criteria.","bad.request":"The 3rd party indicated an issue with the request","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.schema":"There was an issue validating the schema.","invalid.credentials":"There was an issue validating the credentials.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","bad.request":"The request is badly formed.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"method not allowed":"The request method is not allowed for this resource"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.substitution":"There was an issue substituting a value in one of the templates","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:execute","bridge:actions:execute"]},"x-purecloud-method-name":"postIntegrationsActionExecute"}},"/api/v2/routing/sms/phonenumbers/{addressId}":{"get":{"tags":["Routing"],"summary":"Get a phone number provisioned for SMS.","description":"","operationId":"getRoutingSmsPhonenumber","produces":["application/json"],"parameters":[{"name":"addressId","in":"path","description":"Address ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SmsPhoneNumber"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:view"]},"x-purecloud-method-name":"getRoutingSmsPhonenumber"},"put":{"tags":["Routing"],"summary":"Update a phone number provisioned for SMS.","description":"","operationId":"putRoutingSmsPhonenumber","produces":["application/json"],"parameters":[{"name":"addressId","in":"path","description":"Address ID","required":true,"type":"string"},{"in":"body","name":"body","description":"SmsPhoneNumber","required":true,"schema":{"$ref":"#/definitions/SmsPhoneNumber"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SmsPhoneNumber"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:edit"]},"x-purecloud-method-name":"putRoutingSmsPhonenumber"},"delete":{"tags":["Routing"],"summary":"Delete a phone number provisioned for SMS.","description":"","operationId":"deleteRoutingSmsPhonenumber","produces":["application/json"],"parameters":[{"name":"addressId","in":"path","description":"Address ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.short.code.operation":"Phone number Delete operation not allowed for phone number of type shortcode.","recipient.has.flow":"Phone number cannot be deleted with an existing flow associated to it. Remove associated flow before deleting phone number.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:delete"]},"x-purecloud-method-name":"deleteRoutingSmsPhonenumber"}},"/api/v2/outbound/campaigns/{campaignId}/agents/{userId}":{"put":{"tags":["Outbound"],"summary":"Send notification that an agent's state changed ","description":"New agent state.","operationId":"putOutboundCampaignAgent","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"},{"name":"userId","in":"path","description":"Agent's user ID","required":true,"type":"string"},{"in":"body","name":"body","description":"agent","required":true,"schema":{"$ref":"#/definitions/Agent"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.stage":"No stage was provided.","invalid.campaign.status":"The dialer campaign was not active.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The dialer campaign was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-purecloud-method-name":"putOutboundCampaignAgent"}},"/api/v2/telephony/providers/edges/trunks/{trunkId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Trunk by ID","description":"","operationId":"getTelephonyProvidersEdgesTrunk","produces":["application/json"],"parameters":[{"name":"trunkId","in":"path","description":"Trunk ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Trunk"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Trunk ID not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesTrunk"}},"/api/v2/telephony/providers/edges/edgegroups/{edgeGroupId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get edge group.","description":"","operationId":"getTelephonyProvidersEdgesEdgegroup","produces":["application/json"],"parameters":[{"name":"edgeGroupId","in":"path","description":"Edge group ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Fields to expand in the response","required":false,"type":"array","items":{"type":"string","enum":["phoneTrunkBases","edgeTrunkBaseAssignment"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"phoneTrunkBases"},{"name":"edgeTrunkBaseAssignment"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Edge group was not found.","general.resource.not.found":"Edge group was not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesEdgegroup"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update an edge group.","description":"","operationId":"putTelephonyProvidersEdgesEdgegroup","produces":["application/json"],"parameters":[{"name":"edgeGroupId","in":"path","description":"Edge group ID","required":true,"type":"string"},{"in":"body","name":"body","description":"EdgeGroup","required":true,"schema":{"$ref":"#/definitions/EdgeGroup"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"required.field.missing":"A required field is missing a value.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.value":"An edge group with this name already exists.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","managed.property.not.allowed":"Not allowed to update managed property."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesEdgegroup"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete an edge group.","description":"","operationId":"deleteTelephonyProvidersEdgesEdgegroup","produces":["application/json"],"parameters":[{"name":"edgeGroupId","in":"path","description":"Edge group ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","general.bad.request":"The request could not be understood by the server due to malformed syntax."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Edge group was not found.","general.resource.not.found":"Edge group was not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdgesEdgegroup"}},"/api/v2/telephony/siptraces/download":{"post":{"tags":["Telephony"],"summary":"Request a download of a pcap file to S3","description":"","operationId":"postTelephonySiptracesDownload","produces":["application/json"],"parameters":[{"in":"body","name":"SIPSearchPublicRequest","required":true,"schema":{"$ref":"#/definitions/SIPSearchPublicRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SipDownloadResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["telephony:pcap:add"]},"x-purecloud-method-name":"postTelephonySiptracesDownload"}},"/api/v2/telephony/siptraces/download/{downloadId}":{"get":{"tags":["Telephony"],"summary":"Get signed S3 URL for a pcap download","description":"","operationId":"getTelephonySiptracesDownloadDownloadId","produces":["application/json"],"parameters":[{"name":"downloadId","in":"path","description":"unique id for the downloaded file in S3","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SignedUrlResponse"}},"202":{"description":"Request to download pcap file has been accepted","schema":{"$ref":"#/definitions/SignedUrlResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["telephony:pcap:view"]},"x-purecloud-method-name":"getTelephonySiptracesDownloadDownloadId"}},"/api/v2/telephony/siptraces":{"get":{"tags":["Telephony"],"summary":"Fetch SIP metadata","description":"Fetch SIP metadata that matches a given parameter. If exactMatch is passed as a parameter only sip records that have exactly that value will be returned. For example, some records contain conversationId but not all relevant records for that call may contain the conversationId so only a partial view of the call will be reflected","operationId":"getTelephonySiptraces","produces":["application/json"],"parameters":[{"name":"callId","in":"query","description":"unique identification of the placed call","required":false,"type":"string"},{"name":"toUser","in":"query","description":"User to who the call was placed","required":false,"type":"string"},{"name":"fromUser","in":"query","description":"user who placed the call","required":false,"type":"string"},{"name":"conversationId","in":"query","description":"Unique identification of the conversation","required":false,"type":"string"},{"name":"dateStart","in":"query","description":"Start date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","required":true,"type":"string","format":"date-time"},{"name":"dateEnd","in":"query","description":"End date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","required":true,"type":"string","format":"date-time"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SipSearchResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["telephony:pcap:view"]},"x-purecloud-method-name":"getTelephonySiptraces"}},"/api/v2/contentmanagement/documents":{"get":{"tags":["Content Management"],"summary":"Get a list of documents.","description":"","operationId":"getContentmanagementDocuments","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"query","description":"Workspace ID","required":true,"type":"string"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["acl","workspace"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"acl"},{"name":"workspace"}]},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"name or dateCreated","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"ascending or descending","required":false,"type":"string","default":"ascending"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getContentmanagementDocuments"},"post":{"tags":["Content Management"],"summary":"Add a document.","description":"","operationId":"postContentmanagementDocuments","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Document","required":true,"schema":{"$ref":"#/definitions/DocumentUpload"}},{"name":"copySource","in":"query","description":"Copy a document within a workspace or to a new workspace. Provide a document ID as the copy source.","required":false,"type":"string"},{"name":"moveSource","in":"query","description":"Move a document to a new workspace. Provide a document ID as the move source.","required":false,"type":"string"},{"name":"override","in":"query","description":"Override any lock on the source document","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Document"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.null.argument":"Invalid, null arguments provided.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden from adding a document."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"423":{"description":"Locked - The source document is locked by another operation"},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"postContentmanagementDocuments"}},"/api/v2/presencedefinitions":{"get":{"tags":["Presence"],"summary":"Get an Organization's list of Presence Definitions","description":"","operationId":"getPresencedefinitions","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"deleted","in":"query","description":"Deleted query can be TRUE, FALSE or ALL","required":false,"type":"string","default":"false"},{"name":"localeCode","in":"query","description":"The locale code to fetch for each presence definition. Use ALL to fetch everything.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationPresenceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence","presence:readonly"]}],"x-purecloud-method-name":"getPresencedefinitions"},"post":{"tags":["Presence"],"summary":"Create a Presence Definition","description":"","operationId":"postPresencedefinitions","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The Presence Definition to create","required":true,"schema":{"$ref":"#/definitions/OrganizationPresence"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationPresence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["presence:presenceDefinition:add"]},"x-purecloud-method-name":"postPresencedefinitions"}},"/api/v2/externalcontacts/contacts/{contactId}":{"get":{"tags":["External Contacts"],"summary":"Fetch an external contact","description":"","operationId":"getExternalcontactsContact","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand (externalOrganization,externalDataSources)","required":false,"type":"array","items":{"type":"string","enum":["externalOrganization","externalDataSources"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"externalOrganization"},{"name":"externalDataSources"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalContact"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Specified contactId not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:view"]},"x-purecloud-method-name":"getExternalcontactsContact"},"put":{"tags":["External Contacts"],"summary":"Update an external contact","description":"","operationId":"putExternalcontactsContact","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ExternalContact","required":true,"schema":{"$ref":"#/definitions/ExternalContact"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalContact"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"custom.fields.validation.failed":"The custom fields values failed validation","validation.failed":"The provided contact was not valid"}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:edit"]},"x-purecloud-method-name":"putExternalcontactsContact"},"delete":{"tags":["External Contacts"],"summary":"Delete an external contact","description":"","operationId":"deleteExternalcontactsContact","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Specified contactId not found.","contact.not.found":"Contact is not found by contact id.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:delete"]},"x-purecloud-method-name":"deleteExternalcontactsContact"}},"/api/v2/coaching/appointments/{appointmentId}/annotations/{annotationId}":{"get":{"tags":["Coaching"],"summary":"Retrieve an annotation.","description":"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).","operationId":"getCoachingAppointmentAnnotation","produces":["application/json"],"parameters":[{"name":"appointmentId","in":"path","description":"The ID of the coaching appointment.","required":true,"type":"string"},{"name":"annotationId","in":"path","description":"The ID of the annotation.","required":true,"type":"string"}],"responses":{"200":{"description":"Annotation retrieved","schema":{"$ref":"#/definitions/CoachingAnnotation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"User does not have the annotation view permission and is not an attendee, creator or facilitator of the appointment"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.not.found":"Appointment not found","not.found":"The requested resource was not found.","annotation.not.found":"Annotation not found","annotation.deleted":"Annotation has been deleted"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","coaching:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:annotation:view","coaching:privateAnnotation:view"]},"x-purecloud-method-name":"getCoachingAppointmentAnnotation"},"delete":{"tags":["Coaching"],"summary":"Delete an existing annotation","description":"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","operationId":"deleteCoachingAppointmentAnnotation","produces":["application/json"],"parameters":[{"name":"appointmentId","in":"path","description":"The ID of the coaching appointment.","required":true,"type":"string"},{"name":"annotationId","in":"path","description":"The ID of the annotation.","required":true,"type":"string"}],"responses":{"204":{"description":"Annotation deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"User does not have the annotation delete permission and is not a creator or facilitator of the appointment"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.not.found":"Appointment not found","not.found":"The requested resource was not found.","annotation.not.found":"Annotation not found","annotation.deleted":"Annotation has been deleted"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:annotation:delete","coaching:privateAnnotation:delete"]},"x-purecloud-method-name":"deleteCoachingAppointmentAnnotation"},"patch":{"tags":["Coaching"],"summary":"Update an existing annotation.","description":"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","operationId":"patchCoachingAppointmentAnnotation","produces":["application/json"],"parameters":[{"name":"appointmentId","in":"path","description":"The ID of the coaching appointment.","required":true,"type":"string"},{"name":"annotationId","in":"path","description":"The ID of the annotation.","required":true,"type":"string"},{"in":"body","name":"body","description":"The new version of the annotation","required":true,"schema":{"$ref":"#/definitions/CoachingAnnotation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CoachingAnnotation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","validation.failure":"The submitted data was not valid."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"User does not have the annotation edit permission and is not a creator or facilitator of the appointment"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.not.found":"Appointment not found","not.found":"The requested resource was not found.","annotation.not.found":"Annotation not found","annotation.deleted":"Annotation has been deleted"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:annotation:edit","coaching:privateAnnotation:edit"]},"x-purecloud-method-name":"patchCoachingAppointmentAnnotation"}},"/api/v2/contentmanagement/securityprofiles":{"get":{"tags":["Content Management"],"summary":"Get a List of Security Profiles","description":"","operationId":"getContentmanagementSecurityprofiles","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SecurityProfileEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementSecurityprofiles"}},"/api/v2/tokens/{userId}":{"delete":{"tags":["Tokens"],"summary":"Delete all auth tokens for the specified user.","description":"","operationId":"deleteToken","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Missing required division permission","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["user-basic-info"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:token:delete"]},"x-purecloud-method-name":"deleteToken"}},"/api/v2/architect/dependencytracking/object":{"get":{"tags":["Architect"],"summary":"Get a Dependency Tracking object","description":"","operationId":"getArchitectDependencytrackingObject","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"Object ID","required":true,"type":"string"},{"name":"version","in":"query","description":"Object version","required":false,"type":"string"},{"name":"objectType","in":"query","description":"Object type","required":false,"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","BOTCONNECTORBOT","BOTCONNECTORBOTVERSION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GROUP","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","IVRCONFIGURATION","LANGUAGE","LEXBOT","LEXBOTALIAS","NLUDOMAIN","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","WIDGET","WORKFLOW"],"x-genesys-enum-members":[{"name":"ACDLANGUAGE"},{"name":"ACDSKILL"},{"name":"ACDWRAPUPCODE"},{"name":"BOTCONNECTORBOT"},{"name":"BOTCONNECTORBOTVERSION"},{"name":"BOTFLOW"},{"name":"BRIDGEACTION"},{"name":"COMMONMODULEFLOW"},{"name":"COMPOSERSCRIPT"},{"name":"CONTACTLIST"},{"name":"DATAACTION"},{"name":"DATATABLE"},{"name":"DIALOGENGINEBOT"},{"name":"DIALOGENGINEBOTVERSION"},{"name":"DIALOGFLOWAGENT"},{"name":"EMAILROUTE"},{"name":"EMERGENCYGROUP"},{"name":"FLOWACTION"},{"name":"FLOWDATATYPE"},{"name":"FLOWMILESTONE"},{"name":"FLOWOUTCOME"},{"name":"GROUP"},{"name":"INBOUNDCALLFLOW"},{"name":"INBOUNDCHATFLOW"},{"name":"INBOUNDEMAILFLOW"},{"name":"INBOUNDSHORTMESSAGEFLOW"},{"name":"INQUEUECALLFLOW"},{"name":"IVRCONFIGURATION"},{"name":"LANGUAGE"},{"name":"LEXBOT"},{"name":"LEXBOTALIAS"},{"name":"NLUDOMAIN"},{"name":"OUTBOUNDCALLFLOW"},{"name":"QUEUE"},{"name":"RECORDINGPOLICY"},{"name":"RESPONSE"},{"name":"SCHEDULE"},{"name":"SCHEDULEGROUP"},{"name":"SECUREACTION"},{"name":"SECURECALLFLOW"},{"name":"SURVEYINVITEFLOW"},{"name":"SYSTEMPROMPT"},{"name":"TTSENGINE"},{"name":"TTSVOICE"},{"name":"USER"},{"name":"USERPROMPT"},{"name":"WIDGET"},{"name":"WORKFLOW"}]},{"name":"consumedResources","in":"query","description":"Include resources this item consumes","required":false,"type":"boolean"},{"name":"consumingResources","in":"query","description":"Include resources that consume this item","required":false,"type":"boolean"},{"name":"consumedResourceType","in":"query","description":"Types of consumed resources to return, if consumed resources are requested","required":false,"type":"array","items":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","BOTCONNECTORBOT","BOTCONNECTORBOTVERSION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GROUP","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","IVRCONFIGURATION","LANGUAGE","LEXBOT","LEXBOTALIAS","NLUDOMAIN","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","WIDGET","WORKFLOW"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"ACDLANGUAGE"},{"name":"ACDSKILL"},{"name":"ACDWRAPUPCODE"},{"name":"BOTCONNECTORBOT"},{"name":"BOTCONNECTORBOTVERSION"},{"name":"BOTFLOW"},{"name":"BRIDGEACTION"},{"name":"COMMONMODULEFLOW"},{"name":"COMPOSERSCRIPT"},{"name":"CONTACTLIST"},{"name":"DATAACTION"},{"name":"DATATABLE"},{"name":"DIALOGENGINEBOT"},{"name":"DIALOGENGINEBOTVERSION"},{"name":"DIALOGFLOWAGENT"},{"name":"EMAILROUTE"},{"name":"EMERGENCYGROUP"},{"name":"FLOWACTION"},{"name":"FLOWDATATYPE"},{"name":"FLOWMILESTONE"},{"name":"FLOWOUTCOME"},{"name":"GROUP"},{"name":"INBOUNDCALLFLOW"},{"name":"INBOUNDCHATFLOW"},{"name":"INBOUNDEMAILFLOW"},{"name":"INBOUNDSHORTMESSAGEFLOW"},{"name":"INQUEUECALLFLOW"},{"name":"IVRCONFIGURATION"},{"name":"LANGUAGE"},{"name":"LEXBOT"},{"name":"LEXBOTALIAS"},{"name":"NLUDOMAIN"},{"name":"OUTBOUNDCALLFLOW"},{"name":"QUEUE"},{"name":"RECORDINGPOLICY"},{"name":"RESPONSE"},{"name":"SCHEDULE"},{"name":"SCHEDULEGROUP"},{"name":"SECUREACTION"},{"name":"SECURECALLFLOW"},{"name":"SURVEYINVITEFLOW"},{"name":"SYSTEMPROMPT"},{"name":"TTSENGINE"},{"name":"TTSVOICE"},{"name":"USER"},{"name":"USERPROMPT"},{"name":"WIDGET"},{"name":"WORKFLOW"}]},{"name":"consumingResourceType","in":"query","description":"Types of consuming resources to return, if consuming resources are requested","required":false,"type":"array","items":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","BOTCONNECTORBOT","BOTCONNECTORBOTVERSION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GROUP","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","IVRCONFIGURATION","LANGUAGE","LEXBOT","LEXBOTALIAS","NLUDOMAIN","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","WIDGET","WORKFLOW"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"ACDLANGUAGE"},{"name":"ACDSKILL"},{"name":"ACDWRAPUPCODE"},{"name":"BOTCONNECTORBOT"},{"name":"BOTCONNECTORBOTVERSION"},{"name":"BOTFLOW"},{"name":"BRIDGEACTION"},{"name":"COMMONMODULEFLOW"},{"name":"COMPOSERSCRIPT"},{"name":"CONTACTLIST"},{"name":"DATAACTION"},{"name":"DATATABLE"},{"name":"DIALOGENGINEBOT"},{"name":"DIALOGENGINEBOTVERSION"},{"name":"DIALOGFLOWAGENT"},{"name":"EMAILROUTE"},{"name":"EMERGENCYGROUP"},{"name":"FLOWACTION"},{"name":"FLOWDATATYPE"},{"name":"FLOWMILESTONE"},{"name":"FLOWOUTCOME"},{"name":"GROUP"},{"name":"INBOUNDCALLFLOW"},{"name":"INBOUNDCHATFLOW"},{"name":"INBOUNDEMAILFLOW"},{"name":"INBOUNDSHORTMESSAGEFLOW"},{"name":"INQUEUECALLFLOW"},{"name":"IVRCONFIGURATION"},{"name":"LANGUAGE"},{"name":"LEXBOT"},{"name":"LEXBOTALIAS"},{"name":"NLUDOMAIN"},{"name":"OUTBOUNDCALLFLOW"},{"name":"QUEUE"},{"name":"RECORDINGPOLICY"},{"name":"RESPONSE"},{"name":"SCHEDULE"},{"name":"SCHEDULEGROUP"},{"name":"SECUREACTION"},{"name":"SECURECALLFLOW"},{"name":"SURVEYINVITEFLOW"},{"name":"SYSTEMPROMPT"},{"name":"TTSENGINE"},{"name":"TTSVOICE"},{"name":"USER"},{"name":"USERPROMPT"},{"name":"WIDGET"},{"name":"WORKFLOW"}]},{"name":"consumedResourceRequest","in":"query","description":"Indicate that this is going to look up a consumed resource object","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DependencyObject"}},"206":{"description":"Partial Content - the org data is being rebuilt or needs to be rebuilt."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","architect.dependency.object.not.versioned":"A version was provided for a non-versioned dependency object type.","architect.query.parameter.missing":"A required query parameter is missing or empty.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","architect.dependency.object.invalid.type":"An invalid dependency object type was specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.version.missing":"Specified flow version is missing.","not.found":"The requested resource was not found.","architect.dependency.object.not.found":"Could not find the dependency object with specified ID and version.","architect.flow.not.found":"Could not find flow with specified ID."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","architect.database.throughput.exceeded":"Database too busy. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:dependencyTracking:view"]},"x-purecloud-method-name":"getArchitectDependencytrackingObject"}},"/api/v2/telephony/providers/edges/{edgeId}/logs/jobs/{jobId}/upload":{"post":{"tags":["Telephony Providers Edge"],"summary":"Request that the specified fileIds be uploaded from the Edge.","description":"","operationId":"postTelephonyProvidersEdgeLogsJobUpload","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"jobId","in":"path","description":"Job ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Log upload request","required":true,"schema":{"$ref":"#/definitions/EdgeLogsJobUploadRequest"}}],"responses":{"202":{"description":"Accepted - Files are being uploaded to the job. Watch the uploadStatus property on the job files."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find resource by given id(s).","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgeLogsJobUpload"}},"/api/v2/scripts/published/{scriptId}/variables":{"get":{"tags":["Scripts"],"summary":"Get the published variables","description":"","operationId":"getScriptsPublishedScriptIdVariables","produces":["application/json"],"parameters":[{"name":"scriptId","in":"path","description":"Script ID","required":true,"type":"string"},{"name":"input","in":"query","description":"input","required":false,"type":"string"},{"name":"output","in":"query","description":"output","required":false,"type":"string"},{"name":"type","in":"query","description":"type","required":false,"type":"string"},{"name":"scriptDataVersion","in":"query","description":"Advanced usage - controls the data version of the script","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"object"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:publishedScript:view"]},"x-purecloud-method-name":"getScriptsPublishedScriptIdVariables"}},"/api/v2/flows/datatables":{"get":{"tags":["Architect"],"summary":"Retrieve a list of datatables for the org","description":"Returns a metadata list of the datatables associated with this org, including datatableId, name and description.","operationId":"getFlowsDatatables","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Expand instructions for the result","required":false,"type":"string","enum":["schema"],"x-genesys-enum-members":[{"name":"schema"}]},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"id","enum":["id","name"],"x-genesys-enum-members":[{"name":"id"},{"name":"name"}]},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ascending"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataTablesDomainEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","flows.datatables.syntax.error":"There was an error parsing user data","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:view"]},"x-purecloud-method-name":"getFlowsDatatables"},"post":{"tags":["Architect"],"summary":"Create a new datatable with the specified json-schema definition","description":"This will create a new datatable with fields that match the property definitions in the JSON schema. The schema's title field will be overridden by the name field in the DataTable object. See also http://json-schema.org/","operationId":"postFlowsDatatables","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"datatable json-schema","required":true,"schema":{"$ref":"#/definitions/DataTable"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataTable"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.too.many.properties":"The max number of properties allowed in a schema has been reached.","flows.datatables.schema.exception":"The schema is invalid in some way","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","flows.datatables.too.many.tables":"The max number of datatables allowed has been reached.","flows.datatables.syntax.error":"There was an error parsing user data","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.not.unique":"The passed in datatable had a duplicate name."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:add"]},"x-purecloud-method-name":"postFlowsDatatables"}},"/api/v2/locations/search":{"get":{"tags":["Search","Locations"],"summary":"Search locations using the q64 value returned from a previous search","description":"","operationId":"getLocationsSearch","produces":["application/json"],"parameters":[{"name":"q64","in":"query","description":"q64","required":true,"type":"string"},{"name":"expand","in":"query","description":"Provides more details about a specified resource","required":false,"type":"array","items":{"type":"string","enum":["images","addressVerificationDetails"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"images"},{"name":"addressVerificationDetails"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LocationsSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["locations","locations:readonly","search:readonly"]}],"x-purecloud-method-name":"getLocationsSearch"},"post":{"tags":["Search","Locations"],"summary":"Search locations","description":"","operationId":"postLocationsSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/LocationSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LocationsSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["locations","locations:readonly","search:readonly"]}],"x-purecloud-method-name":"postLocationsSearch"}},"/api/v2/scripts/published/{scriptId}":{"get":{"tags":["Scripts"],"summary":"Get the published script.","description":"","operationId":"getScriptsPublishedScriptId","produces":["application/json"],"parameters":[{"name":"scriptId","in":"path","description":"Script ID","required":true,"type":"string"},{"name":"scriptDataVersion","in":"query","description":"Advanced usage - controls the data version of the script","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Script"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:publishedScript:view"]},"x-purecloud-method-name":"getScriptsPublishedScriptId"}},"/api/v2/users/{userId}/routingstatus":{"get":{"tags":["Users"],"summary":"Fetch the routing status of a user","description":"","operationId":"getUserRoutingstatus","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RoutingStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getUserRoutingstatus"},"put":{"tags":["Users"],"summary":"Update the routing status of a user","description":"","operationId":"putUserRoutingstatus","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Routing Status","required":true,"schema":{"$ref":"#/definitions/RoutingStatus"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RoutingStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"An invalid routing status transition was attempted.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-purecloud-method-name":"putUserRoutingstatus"}},"/api/v2/routing/queues/{queueId}/members/{memberId}":{"delete":{"tags":["Routing"],"summary":"Delete a queue member.","description":"","operationId":"deleteRoutingQueueMember","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"memberId","in":"path","description":"Member ID","required":true,"type":"string"}],"responses":{"204":{"description":"Deleted."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","missing.any.division.permissions":"At least one of the required division permissions is missing"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:edit","routing:queueMember:manage"]},"x-purecloud-method-name":"deleteRoutingQueueMember"},"patch":{"tags":["Routing"],"summary":"Update the ring number OR joined status for a queue member.","description":"","operationId":"patchRoutingQueueMember","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"memberId","in":"path","description":"Member ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Queue Member","required":true,"schema":{"$ref":"#/definitions/QueueMember"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueMember"}},"202":{"description":"User update has been accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid request data. Make sure the joined OR ringNumber property is specified.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","missing.any.division.permissions":"At least one of the required division permissions is missing"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:edit","routing:queueMember:manage"]},"x-purecloud-method-name":"patchRoutingQueueMember"}},"/api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}":{"get":{"tags":["Organization Authorization"],"summary":"Get Trustee User","description":"","operationId":"getOrgauthorizationTrusteeUser","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Trustee User Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustUser"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:view"]},"x-purecloud-method-name":"getOrgauthorizationTrusteeUser"},"delete":{"tags":["Organization Authorization"],"summary":"Delete Trustee User","description":"","operationId":"deleteOrgauthorizationTrusteeUser","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Trustee User Id","required":true,"type":"string"}],"responses":{"204":{"description":"Trust deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:delete"]},"x-purecloud-method-name":"deleteOrgauthorizationTrusteeUser"}},"/api/v2/outbound/contactlists/{contactListId}":{"get":{"tags":["Outbound"],"summary":"Get a dialer contact list.","description":"","operationId":"getOutboundContactlist","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"ContactList ID","required":true,"type":"string"},{"name":"includeImportStatus","in":"query","description":"Import status","required":false,"type":"boolean","default":false},{"name":"includeSize","in":"query","description":"Include size","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The dialer contact list was not found.","not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactList:view"]},"x-purecloud-method-name":"getOutboundContactlist"},"put":{"tags":["Outbound"],"summary":"Update a contact list.","description":"","operationId":"putOutboundContactlist","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"ContactList ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ContactList","required":true,"schema":{"$ref":"#/definitions/ContactList"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.columns.dont.match":"Contact columns field and ordered contact columns field must match.","name.cannot.be.blank":"A name must be provided.","contact.columns.do.not.contain.phone.number.column":"","no.phone.columns":"","name.length.exceeded":"The name length exceeds the limit of 64 characters.","system.column.phone.column":"ContactList Phone column cannot be a system defined column name.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","cannot.edit.automatic.time.zone.mapping.settings":"Automatic time zone mapping and the zip code column cannot be changed after contact list creation","not.unique.phone.columns":"Phone Number Columns contain duplicate values.","no.contact.columns.defined":"There are no contact columns defined.","invalid.update":"","phone.columns.limit.exceeded":"Number of phone columns must not exceed the limit.","not.unique.contact.columns":"Contact Columns contains duplicate values.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","cannot.have.callable.time.column.with.automatic.time.zone.mapping":"The phone columns cannot reference callable time columns when automatic time zone mapping is being used","cannot.update.phone.columns":"The phone columns can not be updated.","cannot.have.zip.code.column.without.automatic.time.zone.mapping":"The zip code column can only be used when automatic time zone mapping is also being used","invalid.contact.phone.column":"The contact phone columns are invalid.","invalid.zip.code.column":"The zip code column must be a column of the contact list and cannot be a phone column","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","cannot.update.contact.column.names":"The contact column names can not be updated."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.wrong.version":""}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactList:edit"]},"x-purecloud-method-name":"putOutboundContactlist"},"delete":{"tags":["Outbound"],"summary":"Delete a contact list.","description":"","operationId":"deleteOutboundContactlist","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"ContactList ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","internal.error":"An internal server error occurred.","referential.integrity.error":"Could not delete the resource because it is referenced by another entity.","contact.list.import.in.progress":"The contact list import is in progress.","contact.list.in.use":"The contact list is in use."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactList:delete"]},"x-purecloud-method-name":"deleteOutboundContactlist"}},"/api/v2/outbound/contactlists/{contactListId}/timezonemappingpreview":{"get":{"tags":["Outbound"],"summary":"Preview the result of applying Automatic Time Zone Mapping to a contact list","description":"","operationId":"getOutboundContactlistTimezonemappingpreview","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"ContactList ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeZoneMappingPreview"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.automatic.time.zone.mapping":"This contact list is not set up for Automatic Time Zone Mapping","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The contact list could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactList:view"]},"x-purecloud-method-name":"getOutboundContactlistTimezonemappingpreview"}},"/api/v2/externalcontacts/organizations":{"get":{"tags":["External Contacts"],"summary":"Search for external organizations","description":"","operationId":"getExternalcontactsOrganizations","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":20,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":1,"format":"int32"},{"name":"q","in":"query","description":"Search query","required":false,"type":"string"},{"name":"trustorId","in":"query","description":"Search for external organizations by trustorIds (limit 25). If supplied, the 'q' parameters is ignored. Items are returned in the order requested","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["externalDataSources"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"externalDataSources"}]},{"name":"includeTrustors","in":"query","description":"(true or false) whether or not to include trustor information embedded in the externalOrganization","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalOrganizationListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:view","externalContacts:externalOrganization:view"]},"x-purecloud-method-name":"getExternalcontactsOrganizations"},"post":{"tags":["External Contacts"],"summary":"Create an external organization","description":"","operationId":"postExternalcontactsOrganizations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ExternalOrganization","required":true,"schema":{"$ref":"#/definitions/ExternalOrganization"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalOrganization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"custom.fields.validation.failed":"The provided custom field is not valid.","validation.failed":"The provided contact was not valid"}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:add","externalContacts:externalOrganization:add"]},"x-purecloud-method-name":"postExternalcontactsOrganizations"}},"/api/v2/organizations/features/{featureName}":{"patch":{"tags":["Organization"],"summary":"Update organization","description":"","operationId":"patchOrganizationsFeature","produces":["application/json"],"parameters":[{"name":"featureName","in":"path","description":"Organization feature","required":true,"type":"string","enum":["realtimeCIC","purecloud","hipaa","ucEnabled","pci","purecloudVoice","xmppFederation","chat","informalPhotos","directory","contactCenter","unifiedCommunications","custserv"],"x-genesys-enum-members":[{"name":"realtimeCIC"},{"name":"purecloud"},{"name":"hipaa"},{"name":"ucEnabled"},{"name":"pci"},{"name":"purecloudVoice"},{"name":"xmppFederation"},{"name":"chat"},{"name":"informalPhotos"},{"name":"directory"},{"name":"contactCenter"},{"name":"unifiedCommunications"},{"name":"custserv"}]},{"in":"body","name":"enabled","description":"New state of feature","required":true,"schema":{"$ref":"#/definitions/FeatureState"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationFeatures"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:organization:admin"]},"x-purecloud-method-name":"patchOrganizationsFeature"}},"/api/v2/scim/v2/resourcetypes/{resourceType}":{"get":{"tags":["SCIM"],"summary":"Get a resource type","description":"","operationId":"getScimV2Resourcetype","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"name":"resourceType","in":"path","description":"The type of resource. Returned with GET /api/v2/scim/v2/resourcetypes.","required":true,"type":"string","enum":["User","Group","ServiceProviderConfig","ResourceType","Schema"],"x-genesys-enum-members":[{"name":"User"},{"name":"Group"},{"name":"ServiceProviderConfig"},{"name":"ResourceType"},{"name":"Schema"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimConfigResourceType"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimV2Resourcetype"}},"/api/v2/scim/v2/resourcetypes":{"get":{"tags":["SCIM"],"summary":"Get a list of resource types","description":"","operationId":"getScimV2Resourcetypes","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimConfigResourceTypesListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimV2Resourcetypes"}},"/api/v2/architect/dependencytracking/build":{"get":{"tags":["Architect"],"summary":"Get Dependency Tracking build status for an organization","description":"","operationId":"getArchitectDependencytrackingBuild","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DependencyStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:dependencyTracking:view"]},"x-purecloud-method-name":"getArchitectDependencytrackingBuild"},"post":{"tags":["Architect"],"summary":"Rebuild Dependency Tracking data for an organization","description":"Asynchronous. Notification topic: v2.architect.dependencytracking.build","operationId":"postArchitectDependencytrackingBuild","produces":["application/json"],"parameters":[],"responses":{"202":{"description":"Accepted - the rebuild has begun."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.admin.user":"The requesting user does not have the required Architect admin permission.","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.dependencies.build.in.progress":"A build of dependency information is already in progress."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:dependencyTracking:rebuild"]},"x-purecloud-method-name":"postArchitectDependencytrackingBuild"}},"/api/v2/outbound/messagingcampaigns":{"get":{"tags":["Outbound"],"summary":"Query a list of Messaging Campaigns","description":"","operationId":"getOutboundMessagingcampaigns","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"The field to sort by","required":false,"type":"string","default":"name","enum":["campaignStatus","name","type"],"x-genesys-enum-members":[{"name":"campaignStatus"},{"name":"name"},{"name":"type"}]},{"name":"sortOrder","in":"query","description":"The direction to sort","required":false,"type":"string","default":"ascending","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"contactListId","in":"query","description":"Contact List ID","required":false,"type":"string"},{"name":"divisionId","in":"query","description":"Division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"type","in":"query","description":"Campaign Type","required":false,"type":"string","enum":["SMS"],"x-genesys-enum-members":[{"name":"SMS"}]},{"name":"senderSmsPhoneNumber","in":"query","description":"Sender SMS Phone Number","required":false,"type":"string"},{"name":"id","in":"query","description":"A list of messaging campaign ids to bulk fetch","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingCampaignEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaign:view"]},"x-purecloud-method-name":"getOutboundMessagingcampaigns"},"post":{"tags":["Outbound"],"summary":"Create a Messaging Campaign","description":"","operationId":"postOutboundMessagingcampaigns","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Messaging Campaign","required":true,"schema":{"$ref":"#/definitions/MessagingCampaign"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingCampaign"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.length.exceeded":"The name length exceeds the limit of 64 characters","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.create":"An attempt was made to create an invalid messaging campaign. See details","duplicate.name":"The name is in use by another messaging campaign","callable.time.set.not.found":"The callable time set could not be found","contact.list.not.found":"The contact list could not be found","invalid.callable.time.set":"The provided callable time set is invalid","invalid.messages.per.minute":"Messages per minute must be provided, and must be an integer between 1 and the maximum allowable messages per minute (see documentation)","invalid.sender.sms.phone.number":"The sender sms phone number must be provided, and must be a valid reference to a short-code or non-NANP mobile or local SMS phone number","invalid.phone.column":"The phone column must be provided, and must be a valid column on the selected contact list","invalid.name":"A name must be provided","invalid.sms.content.template.contenttype":"The contentType of content template is not valid. It must be text/plain","sms.content.template.not.found":"The Content template could not be found","invalid.contact.list":"A valid contact list must be provided","contact.sort.duplicate.field.names":"Multiple Contact Sorts may not be applied to the same field","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","contact.sort.size.exceeded":"A maximum of 4 Contact Sorts may be configured","dnc.list.not.found":"One or more dnc lists could not be found","invalid.message.column":"The message column must be provided, and must be a valid column on the selected contact list","invalid.sms.content.template.responsetype":"The responseType of content template is not valid. It must be CampaignSmsTemplate","contact.sort.field.not.found":"One or more contact sort fields are not valid contact list columns","invalid.sms.config.message":"Only one of the messaging options should be set - messageColumn or contentTemplateId","dnc.list.count.exceeded":"A maximum of 10 dnc lists may be configured","invalid.dnc.list":"One or more DNC List references are invalid","max.entity.count.reached":"The maximum messaging campaign count has been reached","invalid.division":"A valid division must be provided","callable.time.set.conflicts.with.automatic.time.zone.mapping":"A callable time set cannot be included on the campaign when the campaign's contact list uses automatic time zone mapping.","sms.phone.number.not.found":"The SMS phone number could not be found","sms.content.template.not.authorized":"User doesn't have authorization to access content template","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","missing.time.zone.in.contactlist":"When using a callable time set, the contact list must have at least one time zone column defined.","contact.list.import.in.progress":"The contact list is still importing contacts","invalid.type.config":"Exactly one of [smsConfig] must be provided","invalid.sms.content.template.content":"The content of content template is blank"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The messaging campaign could not be found"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaign:add"]},"x-purecloud-method-name":"postOutboundMessagingcampaigns"}},"/api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}/roledivisions":{"put":{"tags":["Organization Authorization"],"summary":"Update Trustee User Roles","description":"","operationId":"putOrgauthorizationTrusteeUserRoledivisions","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Trustee User Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Set of roles with corresponding divisions to apply","required":true,"schema":{"$ref":"#/definitions/RoleDivisionGrants"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserAuthorization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:edit"]},"x-purecloud-method-name":"putOrgauthorizationTrusteeUserRoledivisions"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/users":{"get":{"tags":["Workforce Management"],"summary":"Get users in the management unit","description":"","operationId":"getWorkforcemanagementManagementunitUsers","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WfmUserEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agent:view","wfm:historicalAdherence:view","wfm:publishedSchedule:view","wfm:realtimeAdherence:view","wfm:schedule:view","wfm:timeOffRequest:view","wfm:workPlanRotation:view","wfm:workPlan:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitUsers"}},"/api/v2/telephony/providers/edges/lines/template":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Line instance template based on a Line Base Settings object. This object can then be modified and saved as a new Line instance","description":"","operationId":"getTelephonyProvidersEdgesLinesTemplate","produces":["application/json"],"parameters":[{"name":"lineBaseSettingsId","in":"query","description":"The id of a Line Base Settings object upon which to base this Line","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Line"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a line with that id","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesLinesTemplate"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/intraday":{"post":{"tags":["Workforce Management"],"summary":"Get intraday data for the given date for the requested planningGroupIds","description":"","operationId":"postWorkforcemanagementBusinessunitIntraday","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The business unit ID of the business unit","required":true,"type":"string"},{"name":"forceAsync","in":"query","description":"Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes","required":false,"type":"boolean"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/IntradayPlanningGroupRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncIntradayResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:intraday:view"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitIntraday"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/intraday/planninggroups":{"get":{"tags":["Workforce Management"],"summary":"Get intraday planning groups for the given date","description":"","operationId":"getWorkforcemanagementBusinessunitIntradayPlanninggroups","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The business unit ID of the business unit","required":true,"type":"string"},{"name":"date","in":"query","description":"yyyy-MM-dd date string interpreted in the configured business unit time zone. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WfmIntradayPlanningGroupListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:intraday:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitIntradayPlanninggroups"}},"/api/v2/configuration/schemas/edges/vnext":{"get":{"tags":["Telephony Providers Edge"],"summary":"Lists available schema categories (Deprecated)","description":"","operationId":"getConfigurationSchemasEdgesVnext","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SchemaCategoryEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getConfigurationSchemasEdgesVnext"}},"/api/v2/outbound/settings":{"get":{"tags":["Outbound"],"summary":"Get the outbound settings for this organization","description":"","operationId":"getOutboundSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutboundSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:settings:view"]},"x-purecloud-method-name":"getOutboundSettings"},"patch":{"tags":["Outbound"],"summary":"Update the outbound settings for this organization","description":"","operationId":"patchOutboundSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"outboundSettings","required":true,"schema":{"$ref":"#/definitions/OutboundSettings"}}],"responses":{"204":{"description":"Accepted - Processing Update"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.callable.window.stop.time":"Latest callable time must not be later than 21:00","invalid.callable.window":"Earliest callable time must be before Latest callable time and only one callable time window is allowed","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.max.calls.per.agent":"Max calls per agent must be between values 1 and 15.","missing.time.zone":"Time zone must be provided for unmapped call window","invalid.time.zone":"Invalid time zone for unmapped call window","invalid.abandon.seconds":"Abandon seconds must be between 1 and 300.","invalid.callable.window.start.time":"Earliest callable time must not be earlier than 08:00","invalid.update":"An attempt was made to update the outbound settings in an invalid way","invalid.max.line.utilization":"Max outbound line utilization must be between .01 and 1 and can only have 2 digits after the decimal.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.wrong.version":"outbound settings version does not match expected"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:settings:edit"]},"x-purecloud-method-name":"patchOutboundSettings"}},"/api/v2/outbound/rulesets/{ruleSetId}":{"get":{"tags":["Outbound"],"summary":"Get a Rule Set by ID.","description":"","operationId":"getOutboundRuleset","produces":["application/json"],"parameters":[{"name":"ruleSetId","in":"path","description":"Rule Set ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RuleSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:ruleSet:view"]},"x-purecloud-method-name":"getOutboundRuleset"},"put":{"tags":["Outbound"],"summary":"Update a RuleSet.","description":"","operationId":"putOutboundRuleset","produces":["application/json"],"parameters":[{"name":"ruleSetId","in":"path","description":"Rule Set ID","required":true,"type":"string"},{"in":"body","name":"body","description":"RuleSet","required":true,"schema":{"$ref":"#/definitions/RuleSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RuleSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.rule.action":"","name.cannot.be.blank":"A name must be provided.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","invalid.rule.condition":"","data.action.not.found":"The requested data action could not be found","invalid.update":"","rule.conflict":"Duplicated Rule IDs and/or names.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.rule.condition.category":"The condition is not valid for the given category.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.rule.action.category":"The action is not valid for the given category."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.wrong.version":""}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:ruleSet:edit"]},"x-purecloud-method-name":"putOutboundRuleset"},"delete":{"tags":["Outbound"],"summary":"Delete a Rule set.","description":"","operationId":"deleteOutboundRuleset","produces":["application/json"],"parameters":[{"name":"ruleSetId","in":"path","description":"Rule Set ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","referential.integrity.error":"Could not delete the resource because it is referenced by another entity."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:ruleSet:delete"]},"x-purecloud-method-name":"deleteOutboundRuleset"}},"/api/v2/identityproviders/purecloud":{"get":{"tags":["Identity Provider"],"summary":"Get PureCloud Identity Provider","description":"","operationId":"getIdentityprovidersPurecloud","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PureCloud"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersPurecloud"},"put":{"tags":["Identity Provider"],"summary":"Update/Create PureCloud Identity Provider","description":"","operationId":"putIdentityprovidersPurecloud","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/PureCloud"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.issuer.uri":"An issuer URI is required.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.target.url":"The target URL must be a valid HTTPS URL.","certificate.not.yet.valid":"The certificate is not yet valid.","certificate.invalid.base64":"Invalid base64 in certificate.","certificate.unparseable":"The certificate for provider cannot be parsed.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersPurecloud"},"delete":{"tags":["Identity Provider"],"summary":"Delete PureCloud Identity Provider","description":"","operationId":"deleteIdentityprovidersPurecloud","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersPurecloud"}},"/api/v2/routing/languages":{"get":{"tags":["Routing"],"summary":"Get the list of supported languages.","description":"","operationId":"getRoutingLanguages","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ASC","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LanguageEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-purecloud-method-name":"getRoutingLanguages"},"post":{"tags":["Routing"],"summary":"Create Language","description":"","operationId":"postRoutingLanguages","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Language","required":true,"schema":{"$ref":"#/definitions/Language"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Language"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","general.conflict":"The request could not be completed by the server due to a conflict."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:manage"]},"x-purecloud-method-name":"postRoutingLanguages"}},"/api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId}":{"get":{"tags":["Content Management"],"summary":"Get a workspace tag","description":"","operationId":"getContentmanagementWorkspaceTagvalue","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"tagId","in":"path","description":"Tag ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["acl"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"acl"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TagValue"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementWorkspaceTagvalue"},"put":{"tags":["Content Management"],"summary":"Update a workspace tag. Will update all documents with the new tag value.","description":"","operationId":"putContentmanagementWorkspaceTagvalue","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"tagId","in":"path","description":"Tag ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Workspace","required":true,"schema":{"$ref":"#/definitions/TagValue"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TagValue"}},"202":{"description":"Accepted - Processing Update"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"tag.value.too.long":"The tag value is too long.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","tag.value.empty":"The tag value cannot be empty.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"putContentmanagementWorkspaceTagvalue"},"delete":{"tags":["Content Management"],"summary":"Delete workspace tag","description":"Delete a tag from a workspace. Will remove this tag from all documents.","operationId":"deleteContentmanagementWorkspaceTagvalue","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"tagId","in":"path","description":"Tag ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"deleteContentmanagementWorkspaceTagvalue"}},"/api/v2/profiles/users":{"get":{"tags":["Users"],"summary":"Get a user profile listing","description":"This api is deprecated. User /api/v2/users","operationId":"getProfilesUsers","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"jid","in":"query","description":"jid","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ASC","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","conversationSummary","outOfOffice","geolocation","station","authorization"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"routingStatus"},{"name":"presence"},{"name":"conversationSummary"},{"name":"outOfOffice"},{"name":"geolocation"},{"name":"station"},{"name":"authorization"}]},{"name":"integrationPresenceSource","in":"query","description":"Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an \"expand\".","required":false,"type":"string","enum":["MicrosoftTeams","ZoomPhone","RingCentral"],"x-genesys-enum-members":[{"name":"MicrosoftTeams"},{"name":"ZoomPhone"},{"name":"RingCentral"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserProfileEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getProfilesUsers"}},"/api/v2/integrations/credentials/{credentialId}":{"get":{"tags":["Integrations"],"summary":"Get a single credential with sensitive fields redacted","description":"","operationId":"getIntegrationsCredential","produces":["application/json"],"parameters":[{"name":"credentialId","in":"path","description":"Credential ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Credential"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-purecloud-method-name":"getIntegrationsCredential"},"put":{"tags":["Integrations"],"summary":"Update a set of credentials","description":"","operationId":"putIntegrationsCredential","produces":["application/json"],"parameters":[{"name":"credentialId","in":"path","description":"Credential ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Credential","required":false,"schema":{"$ref":"#/definitions/Credential"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CredentialInfo"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-purecloud-method-name":"putIntegrationsCredential"},"delete":{"tags":["Integrations"],"summary":"Delete a set of credentials","description":"","operationId":"deleteIntegrationsCredential","produces":["application/json"],"parameters":[{"name":"credentialId","in":"path","description":"Credential ID","required":true,"type":"string"}],"responses":{"204":{"description":"Deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-purecloud-method-name":"deleteIntegrationsCredential"}},"/api/v2/conversations/chats/{conversationId}/communications/{communicationId}/typing":{"post":{"tags":["Conversations"],"summary":"Send a typing-indicator on behalf of a communication in a chat conversation.","description":"","operationId":"postConversationsChatCommunicationTyping","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatTyping"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","chat.error.conversation.state":"The conversation is in a state which does not permit this action.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","chat.error.member.state":"The conversation member is in a state which does not permit this action.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.not.found":"chat conversation typing-indicator is not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"postConversationsChatCommunicationTyping"}},"/api/v2/conversations/chats/{conversationId}/communications/{communicationId}/messages":{"post":{"tags":["Conversations"],"summary":"Send a message on behalf of a communication in a chat conversation.","description":"","operationId":"postConversationsChatCommunicationMessages","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Message","required":true,"schema":{"$ref":"#/definitions/CreateWebChatMessageRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.notnull.createconversationmessagerequest.body":"chat error occurred due to null request body.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","chat.error.conversation.state":"The conversation is in a state which does not permit this action.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","chat.error.member.state":"The conversation member is in a state which does not permit this action.","chat.error.bad.request":"Chat error occurred due to bad request.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.not.found":"Chat conversation message is not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"postConversationsChatCommunicationMessages"}},"/api/v2/oauth/authorizations/{clientId}":{"get":{"tags":["OAuth"],"summary":"Get a client that is authorized by the resource owner","description":"","operationId":"getOauthAuthorization","produces":["application/json"],"parameters":[{"name":"clientId","in":"path","description":"The ID of client","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthAuthorization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:authorize"]},"x-purecloud-method-name":"getOauthAuthorization"}},"/api/v2/routing/email/domains/{domainName}/routes/{routeId}":{"get":{"tags":["Routing"],"summary":"Get a route","description":"","operationId":"getRoutingEmailDomainRoute","produces":["application/json"],"parameters":[{"name":"domainName","in":"path","description":"email domain","required":true,"type":"string"},{"name":"routeId","in":"path","description":"route ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundRoute"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"getRoutingEmailDomainRoute"},"put":{"tags":["Routing"],"summary":"Update a route","description":"","operationId":"putRoutingEmailDomainRoute","produces":["application/json"],"parameters":[{"name":"domainName","in":"path","description":"email domain","required":true,"type":"string"},{"name":"routeId","in":"path","description":"route ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Route","required":true,"schema":{"$ref":"#/definitions/InboundRoute"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundRoute"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.bad.address":"Invalid email address. Check for invalid control or whitespace characters.","reply.route.id.required":"A route ID is required for the reply email address.","postino.max.autobcc.exceeded":"The maximum number of automatic bcc email addresses for the route has been exceeded.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","postino.invalid.route":"The 'queue' and 'pattern' fields are required.","bad.flow.id":"The flow is not eligible for use here.","postino.error.queue.required":"A queue id or flow id is required.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"putRoutingEmailDomainRoute"},"delete":{"tags":["Routing"],"summary":"Delete a route","description":"","operationId":"deleteRoutingEmailDomainRoute","produces":["application/json"],"parameters":[{"name":"domainName","in":"path","description":"email domain","required":true,"type":"string"},{"name":"routeId","in":"path","description":"route ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.request.timeout":"The inbound route delete request timed out.","postino.error.not.found":"The resource could not be found.","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.route.conflict":"The inbound route is a reply route in one or more other inbound routes."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"deleteRoutingEmailDomainRoute"}},"/api/v2/certificate/details":{"post":{"tags":["Utilities"],"summary":"Returns the information about an X509 PEM encoded certificate or certificate chain.","description":"","operationId":"postCertificateDetails","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Certificate","required":true,"schema":{"$ref":"#/definitions/Certificate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ParsedCertificate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["user-basic-info"]}],"x-purecloud-method-name":"postCertificateDetails"}},"/api/v2/license/toggles/{featureName}":{"get":{"tags":["License"],"summary":"Get PureCloud license feature toggle value.","description":"","operationId":"getLicenseToggle","produces":["application/json"],"parameters":[{"name":"featureName","in":"path","description":"featureName","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LicenseOrgToggle"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["license","license:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:add"]},"x-purecloud-method-name":"getLicenseToggle"},"post":{"tags":["License"],"summary":"Switch PureCloud license feature toggle value.","description":"","operationId":"postLicenseToggle","produces":["application/json"],"parameters":[{"name":"featureName","in":"path","description":"featureName","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LicenseOrgToggle"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["license"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:add"]},"x-purecloud-method-name":"postLicenseToggle"}},"/api/v2/telephony/providers/edges/{edgeId}/lines":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of lines.","description":"","operationId":"getTelephonyProvidersEdgeLines","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeLineEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgeLines"}},"/api/v2/telephony/providers/edges/phonebasesettings":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of Phone Base Settings objects","description":"","operationId":"getTelephonyProvidersEdgesPhonebasesettings","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Value by which to sort","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"expand","in":"query","description":"Fields to expand in the response, comma-separated","required":false,"type":"array","items":{"type":"string","enum":["properties","lines"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"properties"},{"name":"lines"}]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhoneBaseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.organization.type":"Organization type is invalid.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Phone base not found.","general.resource.not.found":"Phone base not found.","not.found":"The requested resource was not found."}},"408":{"description":"Request Timeout","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unknown":"Unspecified error getting phone base settings."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.rate.limit":"Request rate limit exceeded.","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesPhonebasesettings"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a new Phone Base Settings object","description":"","operationId":"postTelephonyProvidersEdgesPhonebasesettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Phone base settings","required":true,"schema":{"$ref":"#/definitions/PhoneBase"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhoneBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","webrtc.user.required":"A webRtc user is required.","base.settings.required":"A base setting is required.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesPhonebasesettings"}},"/api/v2/outbound/rulesets":{"get":{"tags":["Outbound"],"summary":"Query a list of Rule Sets.","description":"","operationId":"getOutboundRulesets","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"allowEmptyResult","in":"query","description":"Whether to return an empty page when there are no results for that page","required":false,"type":"boolean","default":false},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"],"x-genesys-enum-members":[{"name":"Equals"},{"name":"RegEx"},{"name":"Contains"},{"name":"Prefix"},{"name":"LessThan"},{"name":"LessThanEqualTo"},{"name":"GreaterThan"},{"name":"GreaterThanEqualTo"},{"name":"BeginsWith"},{"name":"EndsWith"}]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RuleSetEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:ruleSet:view"]},"x-purecloud-method-name":"getOutboundRulesets"},"post":{"tags":["Outbound"],"summary":"Create a Dialer Call Analysis Response Set.","description":"","operationId":"postOutboundRulesets","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"RuleSet","required":true,"schema":{"$ref":"#/definitions/RuleSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RuleSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.rule.action":"","name.cannot.be.blank":"A name must be provided.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","invalid.create":"","invalid.rule.condition":"","data.action.not.found":"The requested data action could not be found","max.entity.count.reached":"The maximum rule set count has been reached.","rule.conflict":"Duplicated Rule IDs and/or names.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.rule.condition.category":"The condition is not valid for the given category.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.rule.action.category":"The action is not valid for the given category."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:ruleSet:add"]},"x-purecloud-method-name":"postOutboundRulesets"}},"/api/v2/telephony/providers/edges/{edgeId}/metrics":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the edge metrics.","description":"","operationId":"getTelephonyProvidersEdgeMetrics","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeMetrics"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find edge metrics by given id.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgeMetrics"}},"/api/v2/users/{userId}/profileskills":{"get":{"tags":["Users"],"summary":"List profile skills for a user","description":"","operationId":"getUserProfileskills","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"type":"string"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:userProfile:view"]},"x-purecloud-method-name":"getUserProfileskills"},"put":{"tags":["Users"],"summary":"Update profile skills for a user","description":"","operationId":"putUserProfileskills","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Skills","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"type":"string"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:userProfile:edit"]},"x-purecloud-method-name":"putUserProfileskills"}},"/api/v2/telephony/providers/edges/lines/{lineId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Line by ID","description":"","operationId":"getTelephonyProvidersEdgesLine","produces":["application/json"],"parameters":[{"name":"lineId","in":"path","description":"Line ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Line"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find an outbound route with that id","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesLine"}},"/api/v2/telephony/providers/edges/dids":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a listing of DIDs","description":"","operationId":"getTelephonyProvidersEdgesDids","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"number"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"phoneNumber","in":"query","description":"Filter by phoneNumber","required":false,"type":"string"},{"name":"owner.id","in":"query","description":"Filter by the owner of a phone number","required":false,"type":"string"},{"name":"didPool.id","in":"query","description":"Filter by the DID Pool assignment","required":false,"type":"string"},{"name":"id","in":"query","description":"Filter by a specific list of ID's","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DIDEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"Request Timeout","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unknown":"Unspecified error getting DID listings."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.rate.limit":"Request rate limit exceeded.","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesDids"}},"/api/v2/integrations/credentials/types":{"get":{"tags":["Integrations"],"summary":"List all credential types","description":"","operationId":"getIntegrationsCredentialsTypes","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CredentialTypeListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-purecloud-method-name":"getIntegrationsCredentialsTypes"}},"/api/v2/tokens/me":{"get":{"tags":["Tokens"],"summary":"Fetch information about the current token","description":"","operationId":"getTokensMe","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TokenInfo"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["user-basic-info"]}],"x-purecloud-method-name":"getTokensMe"},"delete":{"tags":["Tokens"],"summary":"Delete auth token used to make the request.","description":"","operationId":"deleteTokensMe","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["user-basic-info"]}],"x-purecloud-method-name":"deleteTokensMe"}},"/api/v2/externalcontacts/contacts":{"get":{"tags":["External Contacts"],"summary":"Search for external contacts","description":"","operationId":"getExternalcontactsContacts","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":20,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":1,"format":"int32"},{"name":"q","in":"query","description":"User supplied search keywords (no special syntax is currently supported)","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["externalOrganization","externalDataSources"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"externalOrganization"},{"name":"externalDataSources"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:view"]},"x-purecloud-method-name":"getExternalcontactsContacts"},"post":{"tags":["External Contacts"],"summary":"Create an external contact","description":"","operationId":"postExternalcontactsContacts","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ExternalContact","required":true,"schema":{"$ref":"#/definitions/ExternalContact"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalContact"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"custom.fields.validation.failed":"The custom fields values failed validation","validation.failed":"The provided contact was not valid"}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:add"]},"x-purecloud-method-name":"postExternalcontactsContacts"}},"/api/v2/documentation/gkn/search":{"get":{"tags":["Search"],"summary":"Search gkn documentation using the q64 value returned from a previous search","description":"","operationId":"getDocumentationGknSearch","produces":["application/json"],"parameters":[{"name":"q64","in":"query","description":"q64","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GKNDocumentationSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"getDocumentationGknSearch"},"post":{"tags":["Search"],"summary":"Search gkn documentation","description":"","operationId":"postDocumentationGknSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/GKNDocumentationSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GKNDocumentationSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"postDocumentationGknSearch"}},"/api/v2/workforcemanagement/schedulingjobs/{jobId}":{"get":{"tags":["Workforce Management"],"summary":"Get status of the scheduling job","description":"","operationId":"getWorkforcemanagementSchedulingjob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"The id of the scheduling job","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SchedulingStatusResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedulingrequest:view"]},"x-purecloud-method-name":"getWorkforcemanagementSchedulingjob"}},"/api/v2/workforcemanagement/managementunits":{"get":{"tags":["Workforce Management"],"summary":"Get management units","description":"","operationId":"getWorkforcemanagementManagementunits","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","required":false,"type":"integer","format":"int32"},{"name":"pageNumber","in":"query","required":false,"type":"integer","format":"int32"},{"name":"expand","in":"query","required":false,"type":"string","enum":["details"],"x-genesys-enum-members":[{"name":"details"}]},{"name":"feature","in":"query","required":false,"type":"string","enum":["AgentSchedule","AgentTimeOffRequest","Coaching","ActivityCodes","Agents","BuActivityCodes","BusinessUnits","HistoricalAdherence","IntradayMonitoring","BuIntradayMonitoring","ManagementUnits","RealTimeAdherence","Schedules","BuSchedules","ServiceGoalGroups","ServiceGoalTemplates","PlanningGroups","ShiftTrading","ShortTermForecasts","BuShortTermForecasts","TimeOffRequests","WorkPlanRotations","WorkPlans"],"x-genesys-enum-members":[{"name":"AgentSchedule"},{"name":"AgentTimeOffRequest"},{"name":"Coaching"},{"name":"ActivityCodes"},{"name":"Agents"},{"name":"BuActivityCodes"},{"name":"BusinessUnits"},{"name":"HistoricalAdherence"},{"name":"IntradayMonitoring"},{"name":"BuIntradayMonitoring"},{"name":"ManagementUnits"},{"name":"RealTimeAdherence"},{"name":"Schedules"},{"name":"BuSchedules"},{"name":"ServiceGoalGroups"},{"name":"ServiceGoalTemplates"},{"name":"PlanningGroups"},{"name":"ShiftTrading"},{"name":"ShortTermForecasts"},{"name":"BuShortTermForecasts"},{"name":"TimeOffRequests"},{"name":"WorkPlanRotations"},{"name":"WorkPlans"}]},{"name":"divisionId","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ManagementUnitListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-purecloud-method-name":"getWorkforcemanagementManagementunits"},"post":{"tags":["Workforce Management"],"summary":"Add a management unit","description":"It may take a minute or two for a new management unit to be available for api operations","operationId":"postWorkforcemanagementManagementunits","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/CreateManagementUnitApiRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ManagementUnit"}},"201":{"description":"The management unit was successfully created","schema":{"$ref":"#/definitions/ManagementUnit"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.business.unit.not.found":"Business unit not found","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.missing.one.of.permission.sets":"Unable to perform the requested action. You must have access to the division of the business unit or all requested management units containing permission sets.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:managementUnit:add"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunits"}},"/api/v2/identityproviders":{"get":{"tags":["Identity Provider"],"summary":"The list of identity providers","description":"","operationId":"getIdentityproviders","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthProviderEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityproviders"}},"/api/v2/orgauthorization/trustees/{trusteeOrgId}/users":{"get":{"tags":["Organization Authorization"],"summary":"The list of trustee users for this organization (i.e. users granted access to this organization).","description":"","operationId":"getOrgauthorizationTrusteeUsers","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustUserEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:view"]},"x-purecloud-method-name":"getOrgauthorizationTrusteeUsers"},"post":{"tags":["Organization Authorization"],"summary":"Add a user to the trust.","description":"","operationId":"postOrgauthorizationTrusteeUsers","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Trust","required":true,"schema":{"$ref":"#/definitions/TrustMemberCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustUser"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","trustee.user.not.found":"Trustee user not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:add"]},"x-purecloud-method-name":"postOrgauthorizationTrusteeUsers"}},"/api/v2/languages":{"get":{"tags":["Languages"],"summary":"Get the list of supported languages. (Deprecated)","description":"This endpoint is deprecated. It has been moved to /routing/languages","operationId":"getLanguages","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ASC","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LanguageEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:manage"]},"x-purecloud-method-name":"getLanguages"},"post":{"tags":["Languages"],"summary":"Create Language (Deprecated)","description":"This endpoint is deprecated. It has been moved to /routing/languages","operationId":"postLanguages","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Language","required":true,"schema":{"$ref":"#/definitions/Language"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Language"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:manage"]},"x-purecloud-method-name":"postLanguages"}},"/api/v2/architect/dependencytracking/types/{typeId}":{"get":{"tags":["Architect"],"summary":"Get a Dependency Tracking type.","description":"","operationId":"getArchitectDependencytrackingType","produces":["application/json"],"parameters":[{"name":"typeId","in":"path","description":"Type ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DependencyType"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.dependency.invalid.type":"An invalid dependency type was specified.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:dependencyTracking:view"]},"x-purecloud-method-name":"getArchitectDependencytrackingType"}},"/api/v2/workforcemanagement/adhocmodelingjobs/{jobId}":{"get":{"tags":["Workforce Management"],"summary":"Get status of the modeling job","description":"","operationId":"getWorkforcemanagementAdhocmodelingjob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"The id of the modeling job","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ModelingStatusResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:adhocModel:view"]},"x-purecloud-method-name":"getWorkforcemanagementAdhocmodelingjob"}},"/api/v2/conversations/messaging/integrations":{"get":{"tags":["Conversations"],"summary":"Get a list of Integrations","description":"","operationId":"getConversationsMessagingIntegrations","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingIntegrationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:view"]},"x-purecloud-method-name":"getConversationsMessagingIntegrations"}},"/api/v2/userrecordings/summary":{"get":{"tags":["User Recordings"],"summary":"Get user recording summary","description":"","operationId":"getUserrecordingsSummary","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxSummary"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["user-recordings","user-recordings:readonly"]}],"x-purecloud-method-name":"getUserrecordingsSummary"}},"/api/v2/outbound/attemptlimits/{attemptLimitsId}":{"get":{"tags":["Outbound"],"summary":"Get attempt limits","description":"","operationId":"getOutboundAttemptlimit","produces":["application/json"],"parameters":[{"name":"attemptLimitsId","in":"path","description":"Attempt limits ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AttemptLimits"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:attemptLimits:view"]},"x-purecloud-method-name":"getOutboundAttemptlimit"},"put":{"tags":["Outbound"],"summary":"Update attempt limits","description":"","operationId":"putOutboundAttemptlimit","produces":["application/json"],"parameters":[{"name":"attemptLimitsId","in":"path","description":"Attempt limits ID","required":true,"type":"string"},{"in":"body","name":"body","description":"AttemptLimits","required":true,"schema":{"$ref":"#/definitions/AttemptLimits"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AttemptLimits"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"incorrect.max.value":"Max values must be > 0 and one of them must be defined","name.cannot.be.blank":"A name must be provided.","exceeded.max.attempts.per.contact":"The maximum attempts allowed per contact is 100.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","duplicate.name":"The name already exists.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.time.zone":"Not recognized as a valid time zone.","exceeded.max.attempts.per.number":"The maximum attempts allowed per number is 100.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:attemptLimits:edit"]},"x-purecloud-method-name":"putOutboundAttemptlimit"},"delete":{"tags":["Outbound"],"summary":"Delete attempt limits","description":"","operationId":"deleteOutboundAttemptlimit","produces":["application/json"],"parameters":[{"name":"attemptLimitsId","in":"path","description":"Attempt limits ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","referential.integrity.error":"Could not delete the resource because it is referenced by another entity."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:attemptLimits:delete"]},"x-purecloud-method-name":"deleteOutboundAttemptlimit"}},"/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/publish":{"post":{"tags":["Language Understanding"],"summary":"Publish the draft NLU Domain Version.","description":"","operationId":"postLanguageunderstandingDomainVersionPublish","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"domainVersionId","in":"path","description":"ID of the NLU domain version.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluDomainVersion"}},"201":{"description":"Published the specified NLU Domain Version","schema":{"$ref":"#/definitions/NluDomainVersion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","language-understanding"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomainVersion:add","dialog:botVersion:add"]},"x-purecloud-method-name":"postLanguageunderstandingDomainVersionPublish"}},"/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/report":{"get":{"tags":["Language Understanding"],"summary":"Retrieved quality report for the specified NLU Domain Version","description":"","operationId":"getLanguageunderstandingDomainVersionReport","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"domainVersionId","in":"path","description":"ID of the NLU domain version.","required":true,"type":"string"}],"responses":{"200":{"description":"Find quality report for NLU Domain Version.","schema":{"$ref":"#/definitions/NluDomainVersionQualityReport"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","dialog:readonly","language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomainVersion:view","dialog:botVersion:view"]},"x-purecloud-method-name":"getLanguageunderstandingDomainVersionReport"}},"/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/detect":{"post":{"tags":["Language Understanding"],"summary":"Detect intent, entities, etc. in the submitted text using the specified NLU domain version.","description":"","operationId":"postLanguageunderstandingDomainVersionDetect","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"domainVersionId","in":"path","description":"ID of the NLU domain version.","required":true,"type":"string"},{"in":"body","name":"body","description":"The input data to perform detection on.","required":true,"schema":{"$ref":"#/definitions/NluDetectionRequest"}}],"responses":{"200":{"description":"Requested NLU detection for the given input using the specified NLU domain version","schema":{"$ref":"#/definitions/NluDetectionResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","dialog:readonly","language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomainVersion:view","dialog:botVersion:view"]},"x-purecloud-method-name":"postLanguageunderstandingDomainVersionDetect"}},"/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/train":{"post":{"tags":["Language Understanding"],"summary":"Train the draft NLU Domain Version.","description":"","operationId":"postLanguageunderstandingDomainVersionTrain","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"domainVersionId","in":"path","description":"ID of the NLU domain version.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluDomainVersionTrainingResponse"}},"202":{"description":"Issued training instruction for the draft NLU Domain Version","schema":{"$ref":"#/definitions/NluDomainVersionTrainingResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","language-understanding"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomainVersion:edit","dialog:botVersion:edit"]},"x-purecloud-method-name":"postLanguageunderstandingDomainVersionTrain"}},"/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}":{"get":{"tags":["Language Understanding"],"summary":"Find an NLU Domain Version.","description":"","operationId":"getLanguageunderstandingDomainVersion","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"domainVersionId","in":"path","description":"ID of the NLU domain version.","required":true,"type":"string"},{"name":"includeUtterances","in":"query","description":"Whether utterances for intent definition should be included when marshalling response.","required":false,"type":"boolean"}],"responses":{"200":{"description":"Retrieved the specified NLU Domain Version","schema":{"$ref":"#/definitions/NluDomainVersion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","dialog:readonly","language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomainVersion:view","dialog:botVersion:view"]},"x-purecloud-method-name":"getLanguageunderstandingDomainVersion"},"put":{"tags":["Language Understanding"],"summary":"Update an NLU Domain Version.","description":"","operationId":"putLanguageunderstandingDomainVersion","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"domainVersionId","in":"path","description":"ID of the NLU domain version.","required":true,"type":"string"},{"in":"body","name":"body","description":"The updated NLU Domain Version.","required":true,"schema":{"$ref":"#/definitions/NluDomainVersion"}}],"responses":{"200":{"description":"Updated the specified NLU Domain Version","schema":{"$ref":"#/definitions/NluDomainVersion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service not available":"The service is not available.","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","language-understanding"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomainVersion:edit","dialog:botVersion:edit"]},"x-purecloud-method-name":"putLanguageunderstandingDomainVersion"},"delete":{"tags":["Language Understanding"],"summary":"Delete an NLU Domain Version","description":"","operationId":"deleteLanguageunderstandingDomainVersion","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"domainVersionId","in":"path","description":"ID of the NLU domain version.","required":true,"type":"string"}],"responses":{"204":{"description":"Deleted the specified NLU Domain Version"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","language-understanding"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomainVersion:delete","dialog:botVersion:delete"]},"x-purecloud-method-name":"deleteLanguageunderstandingDomainVersion"}},"/api/v2/outbound/conversations/{conversationId}/dnc":{"post":{"tags":["Outbound"],"summary":"Add phone numbers to a Dialer DNC list.","description":"","operationId":"postOutboundConversationDnc","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","dnc.list.not.found":"The do not call list could not be found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dnc:add"]},"x-purecloud-method-name":"postOutboundConversationDnc"}},"/api/v2/groups/{groupId}":{"get":{"tags":["Groups"],"summary":"Get group","description":"","operationId":"getGroup","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Group"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a group with that groupId","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups","groups:readonly"]}],"x-purecloud-method-name":"getGroup"},"put":{"tags":["Groups"],"summary":"Update group","description":"","operationId":"putGroup","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Group","required":false,"schema":{"$ref":"#/definitions/GroupUpdate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Group"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request is badly formed.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Resource conflict - Unexpected version was provided"},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:edit"]},"x-purecloud-method-name":"putGroup"},"delete":{"tags":["Groups"],"summary":"Delete group","description":"","operationId":"deleteGroup","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Specified group not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["groups"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:delete"]},"x-purecloud-method-name":"deleteGroup"}},"/api/v2/routing/sms/addresses/{addressId}":{"get":{"tags":["Routing"],"summary":"Get an Address by Id for SMS","description":"","operationId":"getRoutingSmsAddress","produces":["application/json"],"parameters":[{"name":"addressId","in":"path","description":"Address ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SmsAddress"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:view"]},"x-purecloud-method-name":"getRoutingSmsAddress"},"delete":{"tags":["Routing"],"summary":"Delete an Address by Id for SMS","description":"","operationId":"deleteRoutingSmsAddress","produces":["application/json"],"parameters":[{"name":"addressId","in":"path","description":"Address ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:delete"]},"x-purecloud-method-name":"deleteRoutingSmsAddress"}},"/api/v2/locations":{"get":{"tags":["Locations"],"summary":"Get a list of all locations.","description":"","operationId":"getLocations","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","enum":["asc","desc"],"x-genesys-enum-members":[{"name":"asc"},{"name":"desc"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LocationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"Unable to get a location due to invalid request.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["locations","locations:readonly"]}],"x-purecloud-method-name":"getLocations"},"post":{"tags":["Locations"],"summary":"Create a location","description":"","operationId":"postLocations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Location","required":true,"schema":{"$ref":"#/definitions/LocationCreateDefinition"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LocationDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"Unable to create a location due to invalid request.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["locations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["directory:location:add"]},"x-purecloud-method-name":"postLocations"}},"/api/v2/flows/milestones":{"get":{"tags":["Architect"],"summary":"Get a pageable list of flow milestones, filtered by query parameters","description":"Multiple IDs can be specified, in which case all matching flow milestones will be returned, and no other parameters will be evaluated.","operationId":"getFlowsMilestones","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"id"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc"},{"name":"id","in":"query","description":"ID","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"description","in":"query","description":"Description","required":false,"type":"string"},{"name":"nameOrDescription","in":"query","description":"Name or description","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowMilestoneListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.feature.unavailable":"Flow milestones feature is not available for current organization."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowMilestone:view"]},"x-purecloud-method-name":"getFlowsMilestones"},"post":{"tags":["Architect"],"summary":"Create a flow milestone","description":"","operationId":"postFlowsMilestones","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/FlowMilestone"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowMilestone"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.milestone.validate.failed.invalid.name.no.alpha":"Failed to validate flow milestone due to invalid name. Names must contain at least one alphanumeric character.","architect.flow.milestone.validate.failed.invalid.name.spaces":"Failed to validate flow milestone due to invalid name. Names must not contain leading or trailing whitespaces.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","architect.property.exceeds.max.character.length":"The name and/or description exceeds the maximum character length.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","architect.object.validate.failed":"Failed to validate object.","architect.flow.milestone.validate.failed.missing.name":"Failed to validate flow milestone due to missing name.","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.feature.unavailable":"Flow milestones feature is not available for current organization."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.milestone.exceeded.max.amount":"Could not create flow milestone since the maximum number of milestones already exist.","architect.flow.milestone.already.exists":"A flow milestone with the specified name already exists."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowMilestone:add"]},"x-purecloud-method-name":"postFlowsMilestones"}},"/api/v2/telephony/providers/edges/{edgeId}/physicalinterfaces":{"get":{"tags":["Telephony Providers Edge"],"summary":"Retrieve a list of all configured physical interfaces from a specific edge.","description":"","operationId":"getTelephonyProvidersEdgePhysicalinterfaces","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhysicalInterfaceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgePhysicalinterfaces"}},"/api/v2/outbound/messagingcampaigns/divisionviews":{"get":{"tags":["Outbound"],"summary":"Query a list of basic Messaging Campaign information objects","description":"This returns a listing of simplified Messaging Campaigns, each consisting of id, name, and division.","operationId":"getOutboundMessagingcampaignsDivisionviews","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"The direction to sort","required":false,"type":"string","default":"a","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"senderSmsPhoneNumber","in":"query","description":"Sender SMS Phone Number","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingCampaignDivisionViewEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:messagingCampaign:search"]},"x-purecloud-method-name":"getOutboundMessagingcampaignsDivisionviews"}},"/api/v2/voicemail/policy":{"get":{"tags":["Voicemail"],"summary":"Get a policy","description":"","operationId":"getVoicemailPolicy","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailOrganizationPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getVoicemailPolicy"},"put":{"tags":["Voicemail"],"summary":"Update a policy","description":"","operationId":"putVoicemailPolicy","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Policy","required":true,"schema":{"$ref":"#/definitions/VoicemailOrganizationPolicy"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailOrganizationPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"voicemailservice.orgvoicemailconfig.alerttimeouttoolarge":"AlertTimeoutTooLarge","voicemailservice.orgvoicemailconfig.maxpinlengthtoosmall":"MaxPinLengthTooSmall","voicemailservice.orgvoicemailconfig.iterationstoolarge":"IterationsTooLarge","voicemailservice.orgvoicemailconfig.uservoicemailretentionpolicynumberofdaysmissing":"UserVoicemailRetentionPolicyNumberOfDaysMissing","voicemailservice.orgvoicemailconfig.groupvoicemailretentionpolicytypemissing":"GroupVoicemailRetentionPolicyTypeMissing","voicemailservice.orgvoicemailconfig.minrecordingtimegreaterthanmax":"MinRecordingTimeGreaterThanMax","voicemailservice.orgvoicemailconfig.organizationnotfound":"OrganizationNotFound","voicemailservice.orgvoicemailconfig.saltlengthtoolarge":"SaltLengthTooLarge","voicemailservice.orgvoicemailconfig.groupvoicemailretentionpolicynumberofdaysmissing":"GroupVoicemailRetentionPolicyNumberOfDaysMissing","voicemailservice.orgvoicemailconfig.groupvoicemailretentionpolicynumberofdaystoolarge":"GroupVoicemailRetentionPolicyNumberOfDaysTooLarge","voicemailservice.orgvoicemailconfig.uservoicemailretentionpolicytypemissing":"UserVoicemailRetentionPolicyTypeMissing","voicemailservice.orgvoicemailconfig.queuevoicemailretentionpolicytypeunknown":"QueueVoicemailRetentionPolicyTypeUnknown","voicemailservice.orgvoicemailconfig.groupvoicemailretentionpolicynumberofdaystoosmall":"GroupVoicemailRetentionPolicyNumberOfDaysTooSmall","voicemailservice.orgvoicemailconfig.minpinlengthtoosmall":"MinPinLengthTooSmall","voicemailservice.orgvoicemailconfig.maxrecordingtimetoolarge":"MaxRecordingTimeTooLarge","voicemailservice.orgvoicemailconfig.queuevoicemailretentionpolicynumberofdaystoolarge":"QueueVoicemailRetentionPolicyNumberOfDaysTooLarge","voicemailservice.orgvoicemailconfig.uservoicemailretentionpolicytypeunknown":"UserVoicemailRetentionPolicyTypeUnknown","voicemailservice.orgvoicemailconfig.alerttimeouttoosmall":"AlertTimeoutTooSmall","voicemailservice.orgvoicemailconfig.iterationstoosmall":"IterationsTooSmall","voicemailservice.orgvoicemailconfig.uservoicemailretentionpolicynumberofdaystoolarge":"UserVoicemailRetentionPolicyNumberOfDaysTooLarge","voicemailservice.orgvoicemailconfig.invalidalgorithm":"InvalidAlgorithm","voicemailservice.orgvoicemailconfig.keylengthtoosmall":"KeyLengthTooSmall","voicemailservice.orgvoicemailconfig.queuevoicemailretentionpolicynumberofdaystoosmall":"QueueVoicemailRetentionPolicyNumberOfDaysTooSmall","voicemailservice.orgvoicemailconfig.queuevoicemailretentionpolicytypemissing":"QueueVoicemailRetentionPolicyTypeMissing","voicemailservice.orgvoicemailconfig.minrecordingtimetoosmall":"MinRecordingTimeTooSmall","voicemailservice.orgvoicemailconfig.hipaaenabledorganizationcannotsendemailnotifications":"HipaaEnabledOrganizationCannotSendEmailNotifications","voicemailservice.orgvoicemailconfig.queuevoicemailretentionpolicynumberofdaysmissing":"QueueVoicemailRetentionPolicyNumberOfDaysMissing","voicemailservice.orgvoicemailconfig.groupvoicemailretentionpolicytypeunknown":"GroupVoicemailRetentionPolicyTypeUnknown","voicemailservice.orgvoicemailconfig.uservoicemailretentionpolicynumberofdaystoosmall":"UserVoicemailRetentionPolicyNumberOfDaysTooSmall","voicemailservice.orgvoicemailconfig.keylengthtoolarge":"KeyLengthTooLarge","voicemailservice.orgvoicemailconfig.saltlengthtoosmall":"SaltLengthTooSmall","voicemailservice.orgvoicemailconfig.minpinlengthgreaterthanmax":"MinPinLengthGreaterThanMax"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"424":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"voicemailservice.orgvoicemailconfig.unabletoverifyorganizationhipaaenabledflag":"UnableToVerifyOrganizationHipaaEnabledFlag"}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putVoicemailPolicy"}},"/api/v2/webchat/deployments":{"get":{"tags":["WebChat"],"summary":"List WebChat deployments","description":"","operationId":"getWebchatDeployments","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatDeploymentEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["web-chat","web-chat:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["webchat:deployment:read"]},"x-purecloud-method-name":"getWebchatDeployments"},"post":{"tags":["WebChat"],"summary":"Create WebChat deployment","description":"","operationId":"postWebchatDeployments","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Deployment","required":true,"schema":{"$ref":"#/definitions/WebChatDeployment"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatDeployment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.deployments":"Too many deployments being handled","maximum.deployments.exceeded":"No more than 25 deployments allowed"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["web-chat"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["webchat:deployment:create"]},"x-purecloud-method-name":"postWebchatDeployments"}},"/api/v2/outbound/campaigns/progress":{"post":{"tags":["Outbound"],"summary":"Get progress for a list of campaigns","description":"","operationId":"postOutboundCampaignsProgress","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Campaign IDs","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/CampaignProgress"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"callback.error.missing.callback.numbers":"Callback numbers missing","callback.error.missing.queue.id":"Callback missing queue ID","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:view"]},"x-purecloud-method-name":"postOutboundCampaignsProgress"}},"/api/v2/routing/sms/availablephonenumbers":{"get":{"tags":["Routing"],"summary":"Get a list of available phone numbers for SMS provisioning.","description":"This request will return up to 30 random phone numbers matching the criteria specified. To get additional phone numbers repeat the request.","operationId":"getRoutingSmsAvailablephonenumbers","produces":["application/json"],"parameters":[{"name":"countryCode","in":"query","description":"The ISO 3166-1 alpha-2 country code of the county for which available phone numbers should be returned","required":true,"type":"string"},{"name":"region","in":"query","description":"Region/province/state that can be used to restrict the numbers returned","required":false,"type":"string"},{"name":"city","in":"query","description":"City that can be used to restrict the numbers returned","required":false,"type":"string"},{"name":"areaCode","in":"query","description":"Area code that can be used to restrict the numbers returned","required":false,"type":"string"},{"name":"phoneNumberType","in":"query","description":"Type of available phone numbers searched","required":true,"type":"string","enum":["local","mobile","tollfree"],"x-genesys-enum-members":[{"name":"local"},{"name":"mobile"},{"name":"tollfree"}]},{"name":"pattern","in":"query","description":"A pattern to match phone numbers. Valid characters are '*' and [0-9a-zA-Z]. The '*' character will match any single digit.","required":false,"type":"string"},{"name":"addressRequirement","in":"query","description":"This indicates whether the phone number requires to have an Address registered.","required":false,"type":"string","enum":["none","any","local","foreign"],"x-genesys-enum-members":[{"name":"none"},{"name":"any"},{"name":"local"},{"name":"foreign"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SMSAvailablePhoneNumberEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:add"]},"x-purecloud-method-name":"getRoutingSmsAvailablephonenumbers"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions/{secureSessionId}":{"get":{"tags":["Conversations"],"summary":"Fetch info on a secure session","description":"","operationId":"getConversationParticipantSecureivrsession","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"name":"secureSessionId","in":"path","description":"secure IVR session ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SecureSession"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationParticipantSecureivrsession"}},"/api/v2/integrations/actions/{actionId}/draft":{"get":{"tags":["Integrations"],"summary":"Retrieve a Draft","description":"","operationId":"getIntegrationsActionDraft","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"name":"expand","in":"query","description":"Indicates a field in the response which should be expanded.","required":false,"type":"string","enum":["contract"],"x-genesys-enum-members":[{"name":"contract"}]},{"name":"includeConfig","in":"query","description":"Return config in response.","required":false,"type":"boolean","default":false,"enum":["true","false"],"x-genesys-enum-members":[{"name":"true"},{"name":"false"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Action"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:view","bridge:actions:view"]},"x-purecloud-method-name":"getIntegrationsActionDraft"},"post":{"tags":["Integrations"],"summary":"Create a new Draft from existing Action","description":"","operationId":"postIntegrationsActionDraft","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Action"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","policy.violation":"A policy violation occurred creating the new draft.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:edit"]},"x-purecloud-method-name":"postIntegrationsActionDraft"},"delete":{"tags":["Integrations"],"summary":"Delete a Draft","description":"","operationId":"deleteIntegrationsActionDraft","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"}],"responses":{"204":{"description":"Delete was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:delete"]},"x-purecloud-method-name":"deleteIntegrationsActionDraft"},"patch":{"tags":["Integrations"],"summary":"Update an existing Draft","description":"","operationId":"patchIntegrationsActionDraft","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"in":"body","name":"body","description":"Input used to patch the Action Draft.","required":true,"schema":{"$ref":"#/definitions/UpdateDraftInput"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Action"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:edit"]},"x-purecloud-method-name":"patchIntegrationsActionDraft"}},"/api/v2/integrations/actions/{actionId}/draft/schemas/{fileName}":{"get":{"tags":["Integrations"],"summary":"Retrieve schema for a Draft based on filename.","description":"","operationId":"getIntegrationsActionDraftSchema","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"name":"fileName","in":"path","description":"Name of schema file to be retrieved for this draft.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JsonSchemaDocument"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:view","bridge:actions:view"]},"x-purecloud-method-name":"getIntegrationsActionDraftSchema"}},"/api/v2/integrations/actions/{actionId}/draft/templates/{fileName}":{"get":{"tags":["Integrations"],"summary":"Retrieve templates for a Draft based on filename.","description":"","operationId":"getIntegrationsActionDraftTemplate","produces":["text/plain"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"name":"fileName","in":"path","description":"Name of template file to be retrieved for this action draft.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:view","bridge:actions:view"]},"x-purecloud-method-name":"getIntegrationsActionDraftTemplate"}},"/api/v2/integrations/actions/{actionId}/draft/publish":{"post":{"tags":["Integrations"],"summary":"Publish a Draft and make it the active Action configuration","description":"","operationId":"postIntegrationsActionDraftPublish","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"in":"body","name":"body","description":"Input used to patch the Action.","required":true,"schema":{"$ref":"#/definitions/PublishDraftInput"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Action"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:edit"]},"x-purecloud-method-name":"postIntegrationsActionDraftPublish"}},"/api/v2/integrations/actions/{actionId}/draft/validation":{"get":{"tags":["Integrations"],"summary":"Validate current Draft configuration.","description":"","operationId":"getIntegrationsActionDraftValidation","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DraftValidationResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:edit"]},"x-purecloud-method-name":"getIntegrationsActionDraftValidation"}},"/api/v2/integrations/actions/{actionId}/draft/test":{"post":{"tags":["Integrations"],"summary":"Test the execution of a draft. Responses will show execution steps broken out with intermediate results to help in debugging.","description":"","operationId":"postIntegrationsActionDraftTest","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"in":"body","name":"body","description":"Map of parameters used for variable substitution.","required":true,"schema":{"type":"object","additionalProperties":{"type":"object"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TestExecutionResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:execute"]},"x-purecloud-method-name":"postIntegrationsActionDraftTest"}},"/api/v2/quality/publishedforms/evaluations/{formId}":{"get":{"tags":["Quality"],"summary":"Get the most recent published version of an evaluation form.","description":"","operationId":"getQualityPublishedformsEvaluation","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:view"]},"x-purecloud-method-name":"getQualityPublishedformsEvaluation"}},"/api/v2/groups/{groupId}/greetings/defaults":{"get":{"tags":["Greetings"],"summary":"Grabs the list of Default Greetings given a Group's ID","description":"","operationId":"getGroupGreetingsDefaults","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DefaultGreetingList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings","greetings:readonly"]}],"x-purecloud-method-name":"getGroupGreetingsDefaults"},"put":{"tags":["Greetings"],"summary":"Updates the DefaultGreetingList of the specified Group","description":"","operationId":"putGroupGreetingsDefaults","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The updated defaultGreetingList","required":true,"schema":{"$ref":"#/definitions/DefaultGreetingList"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DefaultGreetingList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings"]}],"x-purecloud-method-name":"putGroupGreetingsDefaults"}},"/api/v2/quality/conversations/{conversationId}/evaluations":{"post":{"tags":["Quality"],"summary":"Create an evaluation","description":"","operationId":"postQualityConversationEvaluations","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"evaluation","required":true,"schema":{"$ref":"#/definitions/Evaluation"}},{"name":"expand","in":"query","description":"evaluatorId","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Evaluation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.evaluation.evaluator.doesnt.exist":"Evaluator doesn't exist","quality.evaluation.already.exists":"An evaluation for this conversation already exists","quality.scoring.unanswered.required.questions":"Submitted answers did not contain a response to a required question","bad.request":"The request could not be understood by the server due to malformed syntax.","quality.scoring.question.not.in.evaluation.form":"Submitted answers contained reference to a question which is not in the evaluation form","quality.evaluation.agent.doesnt.have.participate.permission":"Agent doesn't have required permission to participate","quality.evaluation.for.pending.state":"Answers required for pending state","quality.scoring.unanswered.required.comments":"Submitted answers did not contain a comment where it was required","qm.evaluation.create.error.no.agent":"Need an agent user on the conversation to create an evaluation","quality.evaluation.no.answers.for.finished.state":"No answers for finished state","quality.evaluation.form.doesnt.exist":"Evaluation form doesn't exist","qm.evaluation.create.error.no.evaluator":"Submitted evaluation missing evaluator","quality.evaluation.agent.doesnt.exist":"Agent user does not exist","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","quality.scoring.answer.not.in.evaluation.form":"Submitted answers contained reference to an answer which is not in the evaluation form","quality.evaluation.evaluator.not.quality.evaluator":"evaluator does not have edit score permission","quality.scoring.question.group.not.in.evaluation.form":"Submitted answers contained reference to a question group which is not in the evaluation form","quality.evaluation.form.not.published":"Evaluation form is not published","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","quality.evaluation.create.permission.check.failed":"Failed evaluation creation permission check"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluation:add"]},"x-purecloud-method-name":"postQualityConversationEvaluations"}},"/api/v2/telephony/providers/edges/sites":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of Sites.","description":"","operationId":"getTelephonyProvidersEdgesSites","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"location.id","in":"query","description":"Location Id","required":false,"type":"string"},{"name":"managed","in":"query","description":"Filter by managed","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SiteEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-purecloud-method-name":"getTelephonyProvidersEdgesSites"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a Site.","description":"","operationId":"postTelephonyProvidersEdgesSites","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Site","required":true,"schema":{"$ref":"#/definitions/Site"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Site"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","referenced.key.does.not.exist":"Unable to find entity that matches the key.","duplicate.value":"At least one of the values in the request were a duplicate.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesSites"}},"/api/v2/routing/email/setup":{"get":{"tags":["Routing"],"summary":"Get email setup","description":"","operationId":"getRoutingEmailSetup","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailSetup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"getRoutingEmailSetup"}},"/api/v2/users/search":{"get":{"tags":["Search","Users"],"summary":"Search users using the q64 value returned from a previous search","description":"","operationId":"getUsersSearch","produces":["application/json"],"parameters":[{"name":"q64","in":"query","description":"q64","required":true,"type":"string"},{"name":"expand","in":"query","description":"expand","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"integrationPresenceSource","in":"query","description":"integrationPresenceSource","required":false,"type":"string","enum":["MicrosoftTeams","ZoomPhone","RingCentral"],"x-genesys-enum-members":[{"name":"MicrosoftTeams"},{"name":"ZoomPhone"},{"name":"RingCentral"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UsersSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getUsersSearch"},"post":{"tags":["Search","Users"],"summary":"Search users","description":"","operationId":"postUsersSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/UserSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UsersSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"Users not found"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"external.server.error":"An external server error occurred","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:view"]},"x-purecloud-method-name":"postUsersSearch"}},"/api/v2/outbound/contactlists":{"get":{"tags":["Outbound"],"summary":"Query a list of contact lists.","description":"","operationId":"getOutboundContactlists","produces":["application/json"],"parameters":[{"name":"includeImportStatus","in":"query","description":"Include import status","required":false,"type":"boolean","default":false},{"name":"includeSize","in":"query","description":"Include size","required":false,"type":"boolean","default":false},{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"allowEmptyResult","in":"query","description":"Whether to return an empty page when there are no results for that page","required":false,"type":"boolean","default":false},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"],"x-genesys-enum-members":[{"name":"Equals"},{"name":"RegEx"},{"name":"Contains"},{"name":"Prefix"},{"name":"LessThan"},{"name":"LessThanEqualTo"},{"name":"GreaterThan"},{"name":"GreaterThanEqualTo"},{"name":"BeginsWith"},{"name":"EndsWith"}]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"divisionId","in":"query","description":"Division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.bulk.retrieves":"Only 100 contact lists can be retrieved by id at a time","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.error":"An internal server error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactList:view"]},"x-purecloud-method-name":"getOutboundContactlists"},"post":{"tags":["Outbound"],"summary":"Create a contact List.","description":"","operationId":"postOutboundContactlists","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ContactList","required":true,"schema":{"$ref":"#/definitions/ContactList"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.columns.dont.match":"Contact columns field and ordered contact columns field must match.","name.cannot.be.blank":"A name must be provided.","contact.columns.do.not.contain.phone.number.column":"","no.phone.columns":"","name.length.exceeded":"The name length exceeds the limit of 64 characters.","system.column.phone.column":"ContactList Phone column cannot be a system defined column name.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","invalid.create":"","not.unique.phone.columns":"Phone Number Columns contain duplicate values.","division.not.found":"The division could not be found.","no.contact.columns.defined":"There are no contact columns defined.","max.entity.count.reached":"The maximum contact list count has been reached.","phone.columns.limit.exceeded":"Number of phone columns must not exceed the limit.","contact.column.length.limit.exceeded":"The length of each contact column must not exceed the limit.","not.unique.contact.columns":"Contact Columns contains duplicate values.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","cannot.have.callable.time.column.with.automatic.time.zone.mapping":"The phone columns cannot reference callable time columns when automatic time zone mapping is being used","contact.columns.limit.exceeded":"Number of contact columns must not exceed the limit.","cannot.have.zip.code.column.without.automatic.time.zone.mapping":"The zip code column can only be used when automatic time zone mapping is also being used","invalid.contact.phone.column":"The contact phone columns are invalid.","invalid.zip.code.column":"The zip code column must be a column of the contact list and cannot be a phone column","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.error":"An internal server error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactList:add"]},"x-purecloud-method-name":"postOutboundContactlists"},"delete":{"tags":["Outbound"],"summary":"Delete multiple contact lists.","description":"","operationId":"deleteOutboundContactlists","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"contact list id(s) to delete","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"204":{"description":"Contact lists accepted for delete."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.deletes":"There were too many contact lists in the request.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bulk.delete.conflict":"Not all the requested contact lists could be deleted."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactList:delete"]},"x-purecloud-method-name":"deleteOutboundContactlists"}},"/api/v2/analytics/journeys/aggregates/query":{"post":{"tags":["Journey","Analytics"],"summary":"Query for journey aggregates","description":"","operationId":"postAnalyticsJourneysAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/JourneyAggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JourneyAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:journeyAggregate:view"]},"x-purecloud-method-name":"postAnalyticsJourneysAggregatesQuery"}},"/api/v2/orphanrecordings":{"get":{"tags":["Recording"],"summary":"Gets all orphan recordings","description":"","operationId":"getOrphanrecordings","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"hasConversation","in":"query","description":"Filter resulting orphans by whether the conversation is known. False returns all orphans for the organization.","required":false,"type":"boolean","default":false},{"name":"media","in":"query","description":"Filter resulting orphans based on their media type","required":false,"type":"string","enum":["Call","Screen"],"x-genesys-enum-members":[{"name":"Call"},{"name":"Screen"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrphanRecordingListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","recording.orphan.view.permission.check.failed":"Failed to verify recording view permission."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.internal.server.error":"An internal server error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:orphan:view"]},"x-purecloud-method-name":"getOrphanrecordings"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/wrapupcodes":{"get":{"tags":["Conversations"],"summary":"Get list of wrapup codes for this conversation participant","description":"","operationId":"getConversationParticipantWrapupcodes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationParticipantWrapupcodes"}},"/api/v2/conversations/{conversationId}/participants/{participantId}":{"patch":{"tags":["Conversations"],"summary":"Update a participant.","description":"Update conversation participant.","operationId":"patchConversationParticipant","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Update request","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.hold.alerting":"An alerting call cannot be placed on hold","conversation.participant.update.invalid":"Failed to update all properties on conversation participant.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","conversation.error.cannot.confine.party":"The participant for this request cannot be confined.","conversation.error.wrapup.code.required":"Wrapup code is a required field and cannot be empty.","conversation.error.participant.attribute.null":"Cannot update participant attribute map to a null value.","conversation.error.cannot.disconnect.call":"The call for this request cannot be disconnected.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","conversation.error.participant.no.active.conversations":"Participant has no active conversations"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.participant.update.failed":"Failed to update all properties on conversation participant.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationParticipant"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/attributes":{"patch":{"tags":["Conversations"],"summary":"Update the attributes on a conversation participant.","description":"","operationId":"patchConversationParticipantAttributes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant attributes","required":true,"schema":{"$ref":"#/definitions/ParticipantAttributes"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.participant.not.found":"The participant does not exist.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationParticipantAttributes"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation participant. ","description":"","operationId":"getConversationParticipantWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationParticipantWrapup"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/flaggedreason":{"put":{"tags":["Conversations"],"summary":"Set flagged reason on conversation participant to indicate bad conversation quality.","description":"","operationId":"putConversationParticipantFlaggedreason","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"}],"responses":{"204":{"description":"The flagged reason was set successfully."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"putConversationParticipantFlaggedreason"},"delete":{"tags":["Conversations"],"summary":"Remove flagged reason from conversation participant.","description":"","operationId":"deleteConversationParticipantFlaggedreason","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"}],"responses":{"204":{"description":"The flagged reason was removed successfully."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"deleteConversationParticipantFlaggedreason"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/callbacks":{"post":{"tags":["Conversations"],"summary":"Create a new callback for the specified participant on the conversation.","description":"","operationId":"postConversationParticipantCallbacks","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/CreateCallbackOnConversationCommand"}}],"responses":{"201":{"description":"Created"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.cannot.callback.acd":"Cannot create a callback for an ACD participant.","callback.error.callback.already.being.routed":"A callback is already in the process of being routed on this conversation.","callback.error.parse.call.number":"A callback number cannot be parsed as a phone address.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","callback.error.scheduled.callback.already.exists":"A callback is already scheduled on this conversation.","conversation.error.queue.required":"Queue id is required for this request.","callback.error.target.communication.cannot.be.acd.or.ivr":"Target communication cannot belong to an acd or ivr participant.","callback.error.scheduled.time.too.far.in.future":"The callback scheduled time cannot be more than 30 days into the future.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["conversation:callback:create"]},"x-purecloud-method-name":"postConversationParticipantCallbacks"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/replace":{"post":{"tags":["Conversations"],"summary":"Replace this participant with the specified user and/or address","description":"","operationId":"postConversationParticipantReplace","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Transfer request","required":true,"schema":{"$ref":"#/definitions/TransferRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversations.error.transfer.chat.external":"Participants with chats cannot be transferred to external addresses.","bad.request":"The request could not be understood by the server due to malformed syntax.","conversations.error.transfer.usercall.voicemail":"Only personal calls can be transferred to voicemail.","conversation.error.participant.no.active.conversations":"Participant has no active conversations","conversations.error.transfer.same.party":"The target of the transfer cannot be the same as the destination.","conversations.error.transfer.acd.call.unattended":"An ACD call cannot be transferred unattended.","conversations.error.transfer.destination.required":"The destination is a required property for a transfer request.","callback.error.user.id.queue.id":"In destination, exactly one of userId or queueId is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","conversations.error.transfer.userCall.voicemail":"Only personal calls can be transferred to voicemail.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","postino.error.bad.request":"The request could not be understood by the server due to malformed syntax.","conversations.error.queue.not.found":"Interaction cannot be transferred to a queue that does not exist.","conversations.error.transfer.not.connected":"You can only transfer conversations that are in the connected state.","conversations.error.transfer.chat.voicemail":"Participants with chats cannot be transferred to voicemail.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.participant.not.found":"Participant does not exist.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationParticipantReplace"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/digits":{"post":{"tags":["Conversations"],"summary":"Sends DTMF to the participant","description":"","operationId":"postConversationParticipantDigits","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Digits","required":false,"schema":{"$ref":"#/definitions/Digits"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"providerapi.error.station.no.active.edge":"Unable to place call. Could not find an Edge for this station.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationParticipantDigits"}},"/api/v2/integrations/eventlog":{"get":{"tags":["Integrations"],"summary":"List all events","description":"","operationId":"getIntegrationsEventlog","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"timestamp"},{"name":"sortOrder","in":"query","description":"Order by","required":false,"type":"string","default":"descending"},{"name":"entityId","in":"query","description":"Include only events with this entity ID","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IntegrationEventEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view","bridge:notification:view"]},"x-purecloud-method-name":"getIntegrationsEventlog"}},"/api/v2/analytics/transcripts/aggregates/query":{"post":{"tags":["Analytics"],"summary":"Query for transcript aggregates","description":"","operationId":"postAnalyticsTranscriptsAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/TranscriptAggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TranscriptAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:speechAndTextAnalyticsAggregates:view"]},"x-purecloud-method-name":"postAnalyticsTranscriptsAggregatesQuery"}},"/api/v2/users/{userId}/geolocations/{clientId}":{"get":{"tags":["Geolocation","Users"],"summary":"Get a user's Geolocation","description":"","operationId":"getUserGeolocation","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"user Id","required":true,"type":"string"},{"name":"clientId","in":"path","description":"client Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Geolocation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["geolocation","geolocation:readonly"]}],"x-purecloud-method-name":"getUserGeolocation"},"patch":{"tags":["Geolocation","Users"],"summary":"Patch a user's Geolocation","description":"The geolocation object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the client as the user's primary geolocation source. Option 2: Provide the 'latitude' and 'longitude' values. This will enqueue an asynchronous update of the 'city', 'region', and 'country', generating a notification. A subsequent GET operation will include the new values for 'city', 'region' and 'country'. Option 3: Provide the 'city', 'region', 'country' values. Option 1 can be combined with Option 2 or Option 3. For example, update the client as primary and provide latitude and longitude values.","operationId":"patchUserGeolocation","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"user Id","required":true,"type":"string"},{"name":"clientId","in":"path","description":"client Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Geolocation","required":true,"schema":{"$ref":"#/definitions/Geolocation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Geolocation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","geolocationservice.entitypointerror":"Geolocation entity point error","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","geolocation.update.error":"Cannot update another user's Geolocation."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"featuretoggleservice.featurenotenabled":"Geolocation feature toggle not enabled"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"geolocationservice.ratelimited":"Rate limited","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","geolocationservice.toomanyrequests":"Too many requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["geolocation"]}],"x-purecloud-method-name":"patchUserGeolocation"}},"/api/v2/quality/forms/{formId}":{"get":{"tags":["Quality"],"summary":"Get an evaluation form","description":"","operationId":"getQualityForm","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"evaluation.form.invalid":"The specified formId is not valid","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","evaluation.not.found":"Evaluation form not found"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:view"]},"x-purecloud-method-name":"getQualityForm"},"put":{"tags":["Quality"],"summary":"Update an evaluation form.","description":"","operationId":"putQualityForm","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Evaluation form","required":true,"schema":{"$ref":"#/definitions/EvaluationForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"evaluation.name.conflict":"Evaluation form named has a conflict."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:edit"]},"x-purecloud-method-name":"putQualityForm"},"delete":{"tags":["Quality"],"summary":"Delete an evaluation form.","description":"","operationId":"deleteQualityForm","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"evaluation.cannot.be.deleted":"Cannot delete evaluation because it has already been published."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:delete"]},"x-purecloud-method-name":"deleteQualityForm"}},"/api/v2/conversations/chats/{conversationId}/messages/{messageId}":{"get":{"tags":["Conversations"],"summary":"Get a web chat conversation message","description":"The current user must be involved with the conversation to get its messages.","operationId":"getConversationsChatMessage","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"messageId","in":"path","description":"messageId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.not.found":"Chat conversation message is not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsChatMessage"}},"/api/v2/integrations/types/{typeId}/configschemas/{configType}":{"get":{"tags":["Integrations"],"summary":"Get properties config schema for an integration type.","description":"","operationId":"getIntegrationsTypeConfigschema","produces":["application/json"],"parameters":[{"name":"typeId","in":"path","description":"Integration Type Id","required":true,"type":"string"},{"name":"configType","in":"path","description":"Config schema type","required":true,"type":"string","enum":["properties","advanced"],"x-genesys-enum-members":[{"name":"properties"},{"name":"advanced"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JsonSchemaDocument"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-purecloud-method-name":"getIntegrationsTypeConfigschema"}},"/api/v2/routing/users/{userId}/utilization":{"get":{"tags":["Routing","Users"],"summary":"Get the user's max utilization settings. If not configured, the organization-wide default is returned.","description":"","operationId":"getRoutingUserUtilization","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Utilization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:utilization:manage","routing:utilization:view"]},"x-purecloud-method-name":"getRoutingUserUtilization"},"put":{"tags":["Routing","Users"],"summary":"Update the user's max utilization settings. Include only those media types requiring custom configuration.","description":"","operationId":"putRoutingUserUtilization","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"utilization","required":true,"schema":{"$ref":"#/definitions/Utilization"}}],"responses":{"200":{"description":"Operation was successful.","schema":{"$ref":"#/definitions/Utilization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"An unsupported media type was specified.","interrupt.same.media.type":"A media type cannot be set up to interrupt itself.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.media.capacity":"Maximum capacity must be between 1 and 50.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:utilization:manage"]},"x-purecloud-method-name":"putRoutingUserUtilization"},"delete":{"tags":["Routing","Users"],"summary":"Delete the user's max utilization settings and revert to the organization-wide default.","description":"","operationId":"deleteRoutingUserUtilization","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The user was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:utilization:manage"]},"x-purecloud-method-name":"deleteRoutingUserUtilization"}},"/api/v2/voicemail/groups/{groupId}/policy":{"get":{"tags":["Voicemail"],"summary":"Get a group's voicemail policy","description":"","operationId":"getVoicemailGroupPolicy","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailGroupPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"voicemailservice.groupnotfound":"The voicemail policy was not found","general.resource.not.found":"The voicemail policy was not found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:add","directory:group:edit"]},"x-purecloud-method-name":"getVoicemailGroupPolicy"},"patch":{"tags":["Voicemail"],"summary":"Update a group's voicemail policy","description":"","operationId":"patchVoicemailGroupPolicy","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The group's voicemail policy","required":true,"schema":{"$ref":"#/definitions/VoicemailGroupPolicy"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailGroupPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:add","directory:group:edit"]},"x-purecloud-method-name":"patchVoicemailGroupPolicy"}},"/api/v2/outbound/dnclists/divisionviews/{dncListId}":{"get":{"tags":["Outbound"],"summary":"Get a basic DncList information object","description":"This returns a simplified version of a DncList, consisting of the name, division, import status, and size.","operationId":"getOutboundDnclistsDivisionview","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"Dnclist ID","required":true,"type":"string"},{"name":"includeImportStatus","in":"query","description":"Include import status","required":false,"type":"boolean","default":false},{"name":"includeSize","in":"query","description":"Include size","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DncListDivisionView"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:dncList:search"]},"x-purecloud-method-name":"getOutboundDnclistsDivisionview"}},"/api/v2/organizations/me":{"get":{"tags":["Organization"],"summary":"Get organization.","description":"","operationId":"getOrganizationsMe","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Organization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-purecloud-method-name":"getOrganizationsMe"},"put":{"tags":["Organization"],"summary":"Update organization.","description":"","operationId":"putOrganizationsMe","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Organization","required":false,"schema":{"$ref":"#/definitions/Organization"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Organization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Resource conflict - Unexpected version was provided","x-inin-error-codes":{"general.conflict":"The version supplied does not match the current version of the user"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:organization:admin"]},"x-purecloud-method-name":"putOrganizationsMe"}},"/api/v2/telephony/providers/edges/edgeversionreport":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the edge version report.","description":"The report will not have consistent data about the edge version(s) until all edges have been reset.","operationId":"getTelephonyProvidersEdgesEdgeversionreport","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeVersionReport"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-purecloud-method-name":"getTelephonyProvidersEdgesEdgeversionreport"}},"/api/v2/recording/crossplatform/mediaretentionpolicies/{policyId}":{"get":{"tags":["Recording"],"summary":"Get a media retention policy","description":"","operationId":"getRecordingCrossplatformMediaretentionpolicy","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CrossPlatformPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:crossPlatformRetentionPolicy:view"]},"x-purecloud-method-name":"getRecordingCrossplatformMediaretentionpolicy"},"put":{"tags":["Recording"],"summary":"Update a media retention policy","description":"","operationId":"putRecordingCrossplatformMediaretentionpolicy","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Policy","required":true,"schema":{"$ref":"#/definitions/CrossPlatformPolicy"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CrossPlatformPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.policy.assign.metered.evaluation.evaluator.permission.check.failed":"evaluator permission failure for metered evaluation","recording.media.policy.invalid":"One of the configured actions or conditions was invalid.","recording.policy.calibrator.permission.fail":"General calibrator permission failure","recording.policy.export.integration.disabled":"The specified export integration is not in active state.","recording.policy.invalid.queue":"The specified queues was invalid.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","recording.policy.assign.evaluation.evaluator.permission.check.failed":"evaluator permission failure for evaluation","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","recording.policy.assign.calibration.evaluator.permission.check.failed":"Calibrator permission failure","recording.policy.export.integration.invalid":"The specified export integration is not a valid integration.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:crossPlatformRetentionPolicy:edit"]},"x-purecloud-method-name":"putRecordingCrossplatformMediaretentionpolicy"},"delete":{"tags":["Recording"],"summary":"Delete a media retention policy","description":"","operationId":"deleteRecordingCrossplatformMediaretentionpolicy","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.policy.not.found":"The supplied policy was not found or is invalid","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:crossPlatformRetentionPolicy:delete"]},"x-purecloud-method-name":"deleteRecordingCrossplatformMediaretentionpolicy"},"patch":{"tags":["Recording"],"summary":"Patch a media retention policy","description":"","operationId":"patchRecordingCrossplatformMediaretentionpolicy","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Policy","required":true,"schema":{"$ref":"#/definitions/CrossPlatformPolicy"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CrossPlatformPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:crossPlatformRetentionPolicy:edit"]},"x-purecloud-method-name":"patchRecordingCrossplatformMediaretentionpolicy"}},"/api/v2/scripts/{scriptId}/pages/{pageId}":{"get":{"tags":["Scripts"],"summary":"Get a page","description":"","operationId":"getScriptPage","produces":["application/json"],"parameters":[{"name":"scriptId","in":"path","description":"Script ID","required":true,"type":"string"},{"name":"pageId","in":"path","description":"Page ID","required":true,"type":"string"},{"name":"scriptDataVersion","in":"query","description":"Advanced usage - controls the data version of the script","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Page"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:script:view"]},"x-purecloud-method-name":"getScriptPage"}},"/api/v2/quality/forms/evaluations/{formId}":{"get":{"tags":["Quality"],"summary":"Get an evaluation form","description":"","operationId":"getQualityFormsEvaluation","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"evaluation.form.invalid":"The specified formId is not valid","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","evaluation.not.found":"Evaluation form not found"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:view"]},"x-purecloud-method-name":"getQualityFormsEvaluation"},"put":{"tags":["Quality"],"summary":"Update an evaluation form.","description":"","operationId":"putQualityFormsEvaluation","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Evaluation form","required":true,"schema":{"$ref":"#/definitions/EvaluationForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:edit"]},"x-purecloud-method-name":"putQualityFormsEvaluation"},"delete":{"tags":["Quality"],"summary":"Delete an evaluation form.","description":"","operationId":"deleteQualityFormsEvaluation","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"evaluation.cannot.be.deleted":"Cannot delete evaluation because it has already been published."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:delete"]},"x-purecloud-method-name":"deleteQualityFormsEvaluation"}},"/api/v2/contentmanagement/shares":{"get":{"tags":["Content Management"],"summary":"Gets a list of shares. You must specify at least one filter (e.g. entityId).","description":"Failing to specify a filter will return 400.","operationId":"getContentmanagementShares","produces":["application/json"],"parameters":[{"name":"entityId","in":"query","description":"Filters the shares returned to only the entity specified by the value of this parameter.","required":false,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["member"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"member"}]},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ShareEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementShares"},"post":{"tags":["Content Management"],"summary":"Creates a new share or updates an existing share if the entity has already been shared","description":"","operationId":"postContentmanagementShares","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"CreateShareRequest - entity id and type and a single member or list of members are required","required":true,"schema":{"$ref":"#/definitions/CreateShareRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CreateShareResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"forbidden":"Forbidden from saving a share.","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"postContentmanagementShares"}},"/api/v2/billing/reports/billableusage":{"get":{"tags":["Billing"],"summary":"Get a report of the billable license usages","description":"Report is of the billable usages (e.g. licenses and devices utilized) for a given period. If response's status is InProgress, wait a few seconds, then try the same request again.","operationId":"getBillingReportsBillableusage","produces":["application/json"],"parameters":[{"name":"startDate","in":"query","description":"The period start date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","required":true,"type":"string","format":"date-time"},{"name":"endDate","in":"query","description":"The period end date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","required":true,"type":"string","format":"date-time"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BillingUsageReport"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"error":"An internal server error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["billing","billing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["billing:subscription:read","billing:subscription:view"]},"x-purecloud-method-name":"getBillingReportsBillableusage"}},"/api/v2/quality/calibrations/{calibrationId}":{"get":{"tags":["Quality"],"summary":"Get a calibration by id. Requires either calibrator id or conversation id","description":"","operationId":"getQualityCalibration","produces":["application/json"],"parameters":[{"name":"calibrationId","in":"path","description":"Calibration ID","required":true,"type":"string"},{"name":"calibratorId","in":"query","description":"calibratorId","required":false,"type":"string"},{"name":"conversationId","in":"query","description":"conversationId","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Calibration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.calibration.view.permission.check.failed":"calibration view permission check failed","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:calibration:view"]},"x-purecloud-method-name":"getQualityCalibration"},"put":{"tags":["Quality"],"summary":"Update a calibration to the specified calibration via PUT. Editable fields include: evaluators, expertEvaluator, and scoringIndex","description":"","operationId":"putQualityCalibration","produces":["application/json"],"parameters":[{"name":"calibrationId","in":"path","description":"Calibration ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Calibration","required":true,"schema":{"$ref":"#/definitions/Calibration"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Calibration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.evaluation.already.exists":"evaluation already exists","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","quality.calibration.update.permission.check.failed":"calibration update permission check failed","quality.evaluation.evaluator.not.quality.evaluator":"evaluator does not have edit score permission","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","quality.calibration.expert.evaluator.not.quality.evaluator":"expert evaluator does not have evaluator permissions"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:calibration:edit"]},"x-purecloud-method-name":"putQualityCalibration"},"delete":{"tags":["Quality"],"summary":"Delete a calibration by id.","description":"","operationId":"deleteQualityCalibration","produces":["application/json"],"parameters":[{"name":"calibrationId","in":"path","description":"Calibration ID","required":true,"type":"string"},{"name":"calibratorId","in":"query","description":"calibratorId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Calibration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","quality.calibration.delete.permission.check.failed":"calibration delete permission check failed"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:calibration:delete"]},"x-purecloud-method-name":"deleteQualityCalibration"}},"/api/v2/telephony/providers/edges/linebasesettings":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a listing of line base settings objects","description":"","operationId":"getTelephonyProvidersEdgesLinebasesettings","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Value by which to sort","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LineBaseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesLinebasesettings"}},"/api/v2/contentmanagement/workspaces/{workspaceId}":{"get":{"tags":["Content Management"],"summary":"Get a workspace.","description":"","operationId":"getContentmanagementWorkspace","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["summary","acl"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"summary"},{"name":"acl"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Workspace"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden from getting a workspace."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementWorkspace"},"put":{"tags":["Content Management"],"summary":"Update a workspace","description":"","operationId":"putContentmanagementWorkspace","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Workspace","required":true,"schema":{"$ref":"#/definitions/Workspace"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Workspace"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden to update a workspace."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"putContentmanagementWorkspace"},"delete":{"tags":["Content Management"],"summary":"Delete a workspace","description":"","operationId":"deleteContentmanagementWorkspace","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"moveChildrenToWorkspaceId","in":"query","description":"New location for objects in deleted workspace.","required":false,"type":"string"}],"responses":{"202":{"description":"Accepted - Processing Delete"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden from deleting a workspace."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"deleteContentmanagementWorkspace"}},"/api/v2/telephony/providers/edges/phones/{phoneId}/reboot":{"post":{"tags":["Telephony Providers Edge"],"summary":"Reboot a Phone","description":"","operationId":"postTelephonyProvidersEdgesPhoneReboot","produces":["application/json"],"parameters":[{"name":"phoneId","in":"path","description":"Phone Id","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","providerapi.error.phone.no.active.edge":"Phone is not connected to an active edge and cannot be rebooted."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesPhoneReboot"}},"/api/v2/organizations/embeddedintegration":{"get":{"tags":["Organization"],"summary":"Get the list of domains that will be allowed to embed PureCloud applications","description":"","operationId":"getOrganizationsEmbeddedintegration","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmbeddedIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-purecloud-method-name":"getOrganizationsEmbeddedintegration"},"put":{"tags":["Organization"],"summary":"Update the list of domains that will be allowed to embed PureCloud applications","description":"","operationId":"putOrganizationsEmbeddedintegration","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Whitelist settings","required":true,"schema":{"$ref":"#/definitions/EmbeddedIntegration"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmbeddedIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:organization:admin"]},"x-purecloud-method-name":"putOrganizationsEmbeddedintegration"}},"/api/v2/routing/settings":{"get":{"tags":["Routing"],"summary":"Get an organization's routing settings","description":"","operationId":"getRoutingSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RoutingSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-purecloud-method-name":"getRoutingSettings"},"put":{"tags":["Routing"],"summary":"Update an organization's routing settings","description":"","operationId":"putRoutingSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Organization Settings","required":true,"schema":{"$ref":"#/definitions/RoutingSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RoutingSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:settings:edit"]},"x-purecloud-method-name":"putRoutingSettings"},"delete":{"tags":["Routing"],"summary":"Delete an organization's routing settings","description":"","operationId":"deleteRoutingSettings","produces":["application/json"],"parameters":[],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:settings:edit"]},"x-purecloud-method-name":"deleteRoutingSettings"}},"/api/v2/routing/settings/transcription":{"get":{"tags":["Routing"],"summary":"Get Transcription Settings","description":"","operationId":"getRoutingSettingsTranscription","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TranscriptionSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","feature.forbidden":"Requested feature is forbidden"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:transcriptionSettings:view"]},"x-purecloud-method-name":"getRoutingSettingsTranscription"},"put":{"tags":["Routing"],"summary":"Update Transcription Settings","description":"","operationId":"putRoutingSettingsTranscription","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Organization Settings","required":true,"schema":{"$ref":"#/definitions/TranscriptionSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TranscriptionSettings"}},"202":{"description":"Request to update transcription settings has been accepted","schema":{"$ref":"#/definitions/TranscriptionSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:transcriptionSettings:edit"]},"x-purecloud-method-name":"putRoutingSettingsTranscription"}},"/api/v2/routing/settings/contactcenter":{"get":{"tags":["Routing"],"summary":"Get Contact Center Settings","description":"","operationId":"getRoutingSettingsContactcenter","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactCenterSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-purecloud-method-name":"getRoutingSettingsContactcenter"},"patch":{"tags":["Routing"],"summary":"Update Contact Center Settings","description":"","operationId":"patchRoutingSettingsContactcenter","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Contact Center Settings","required":true,"schema":{"$ref":"#/definitions/ContactCenterSettings"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:settings:edit"]},"x-purecloud-method-name":"patchRoutingSettingsContactcenter"}},"/api/v2/architect/schedules":{"get":{"tags":["Architect"],"summary":"Get a list of schedules.","description":"","operationId":"getArchitectSchedules","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"name","in":"query","description":"Name of the Schedule to filter by.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScheduleEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:schedule:view"]},"x-purecloud-method-name":"getArchitectSchedules"},"post":{"tags":["Architect"],"summary":"Create a new schedule.","description":"","operationId":"postArchitectSchedules","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Schedule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Schedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:schedule:add"]},"x-purecloud-method-name":"postArchitectSchedules"}},"/api/v2/identityproviders/salesforce":{"get":{"tags":["Identity Provider"],"summary":"Get Salesforce Identity Provider","description":"","operationId":"getIdentityprovidersSalesforce","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Salesforce"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersSalesforce"},"put":{"tags":["Identity Provider"],"summary":"Update/Create Salesforce Identity Provider","description":"","operationId":"putIdentityprovidersSalesforce","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/Salesforce"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.issuer.uri":"An issuer URI is required.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.target.url":"The target URL must be a valid HTTPS URL.","certificate.not.yet.valid":"The certificate is not yet valid.","certificate.invalid.base64":"Invalid base64 in certificate.","certificate.unparseable":"The certificate for provider cannot be parsed.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersSalesforce"},"delete":{"tags":["Identity Provider"],"summary":"Delete Salesforce Identity Provider","description":"","operationId":"deleteIdentityprovidersSalesforce","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersSalesforce"}},"/api/v2/architect/systemprompts/{promptId}/resources":{"get":{"tags":["Architect"],"summary":"Get system prompt resources.","description":"","operationId":"getArchitectSystempromptResources","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"id"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SystemPromptAssetEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:systemPrompt:view"]},"x-purecloud-method-name":"getArchitectSystempromptResources"},"post":{"tags":["Architect"],"summary":"Create system prompt resource override.","description":"","operationId":"postArchitectSystempromptResources","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/SystemPromptAsset"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SystemPromptAsset"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.resource.validate.failed.language":"Failed to validate prompt resource due to missing or invalid language.","architect.prompt.resource.invalid.tags":"The specified tags are in an invalid format.","architect.system.prompt.resource.lang.missing":"A language was not specified in the request.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","architect.object.validate.failed":"Failed to validate object.","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.resource.tags.already.exist":"The specified tags already exist in another prompt resource.","architect.system.prompt.resource.cannot.create.non.default":"Cannot create a non-default resource for the specified language because a default resource for that language doesn't exist. A default must be created first.","architect.system.prompt.resource.override.already.exists":"The specified system prompt already has an override for the specified language."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:systemPrompt:edit"]},"x-purecloud-method-name":"postArchitectSystempromptResources"}},"/api/v2/greetings/defaults":{"get":{"tags":["Greetings"],"summary":"Get an Organization's DefaultGreetingList","description":"","operationId":"getGreetingsDefaults","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DefaultGreetingList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings","greetings:readonly"]}],"x-purecloud-method-name":"getGreetingsDefaults"},"put":{"tags":["Greetings"],"summary":"Update an Organization's DefaultGreetingList","description":"","operationId":"putGreetingsDefaults","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The updated defaultGreetingList","required":true,"schema":{"$ref":"#/definitions/DefaultGreetingList"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DefaultGreetingList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings"]}],"x-purecloud-method-name":"putGreetingsDefaults"}},"/api/v2/analytics/reporting/exports/metadata":{"get":{"tags":["Analytics"],"summary":"Get all export metadata","description":"","operationId":"getAnalyticsReportingExportsMetadata","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportingExportMetadataJobListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["analytics:dataExport:view"]},"x-purecloud-method-name":"getAnalyticsReportingExportsMetadata"}},"/api/v2/conversations/{conversationId}/recordingmetadata":{"get":{"tags":["Recording"],"summary":"Get recording metadata for a conversation. Does not return playable media.","description":"","operationId":"getConversationRecordingmetadata","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/RecordingMetadata"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.recording.view.permission.check.failed":"Request forbidden due to recording view permissions check failing.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","conversation.not.found":"Conversation with specified conversationId was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-purecloud-method-name":"getConversationRecordingmetadata"}},"/api/v2/recording/settings":{"get":{"tags":["Recording"],"summary":"Get the Recording Settings for the Organization","description":"","operationId":"getRecordingSettings","produces":["application/json"],"parameters":[{"name":"createDefault","in":"query","description":"If no settings are found, a new one is created with default values","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.internal.server.error":"Internal server error getting recording settings","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:screenRecording:view","recording:settings:editScreenRecordings"]},"x-purecloud-method-name":"getRecordingSettings"},"put":{"tags":["Recording"],"summary":"Update the Recording Settings for the Organization","description":"","operationId":"putRecordingSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Recording settings","required":true,"schema":{"$ref":"#/definitions/RecordingSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","recording.org.settings.request.invalid":"invalid recording setting","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:settings:editScreenRecordings"]},"x-purecloud-method-name":"putRecordingSettings"}},"/api/v2/speechandtextanalytics/settings":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get Speech And Text Analytics Settings","description":"","operationId":"getSpeechandtextanalyticsSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SpeechTextAnalyticsSettingsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"settings.not.found":"The organization does not have SpeechAndTextAnalytics settings","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:settings:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsSettings"},"patch":{"tags":["Speech & Text Analytics"],"summary":"Patch Speech And Text Analytics Settings","description":"","operationId":"patchSpeechandtextanalyticsSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Speech And Text Analytics Settings","required":true,"schema":{"$ref":"#/definitions/SpeechTextAnalyticsSettingsRequest"}}],"responses":{"200":{"description":"Speech And Text Analytics settings has been updated","schema":{"$ref":"#/definitions/SpeechTextAnalyticsSettingsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The input is not valid","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:settings:edit"]},"x-purecloud-method-name":"patchSpeechandtextanalyticsSettings"}},"/api/v2/externalcontacts/relationships":{"post":{"tags":["External Contacts"],"summary":"Create a relationship","description":"","operationId":"postExternalcontactsRelationships","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Relationship","required":true,"schema":{"$ref":"#/definitions/Relationship"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Relationship"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided contact was not valid"}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:externalOrganization:edit"]},"x-purecloud-method-name":"postExternalcontactsRelationships"}},"/api/v2/routing/queues/{queueId}/mediatypes/{mediaType}/estimatedwaittime":{"get":{"tags":["Routing"],"summary":"Get Estimated Wait Time","description":"","operationId":"getRoutingQueueMediatypeEstimatedwaittime","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"queueId","required":true,"type":"string"},{"name":"mediaType","in":"path","description":"mediaType","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EstimatedWaitTimePredictions"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"At least one of the required division permissions is missing","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:queue:view"]},"x-purecloud-method-name":"getRoutingQueueMediatypeEstimatedwaittime"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories/{categoryId}":{"get":{"tags":["Knowledge"],"summary":"Get category","description":"","operationId":"getKnowledgeKnowledgebaseLanguageCategory","produces":["application/json"],"parameters":[{"name":"categoryId","in":"path","description":"Category ID","required":true,"type":"string"},{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","de-DE"],"x-genesys-enum-members":[{"name":"en-US"},{"name":"de-DE"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeExtendedCategory"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","parent.category.not.found":"Parent category does not exist","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","input.validations":"Input parameters do not match the required criteria","kb.not.found":"Knowledge Base does not exist","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"404":"Resource not found","category.not.found":"Category does not exist","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:category:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseLanguageCategory"},"delete":{"tags":["Knowledge"],"summary":"Delete category","description":"","operationId":"deleteKnowledgeKnowledgebaseLanguageCategory","produces":["application/json"],"parameters":[{"name":"categoryId","in":"path","description":"Category ID","required":true,"type":"string"},{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","de-DE"],"x-genesys-enum-members":[{"name":"en-US"},{"name":"de-DE"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeCategory"}},"204":{"description":"Category deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","parent.category.not.found":"Parent category does not exist","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","input.validations":"Input parameters do not match the required criteria","kb.not.found":"Knowledge Base does not exist"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"404":"Resource not found","category.not.found":"Category does not exist","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:category:delete"]},"x-purecloud-method-name":"deleteKnowledgeKnowledgebaseLanguageCategory"},"patch":{"tags":["Knowledge"],"summary":"Update category","description":"","operationId":"patchKnowledgeKnowledgebaseLanguageCategory","produces":["application/json"],"parameters":[{"name":"categoryId","in":"path","description":"Category ID","required":true,"type":"string"},{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","de-DE"],"x-genesys-enum-members":[{"name":"en-US"},{"name":"de-DE"}]},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeCategoryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeExtendedCategory"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","parent.category.not.found":"Parent category does not exist","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","input.validations":"Input parameters do not match the required criteria","kb.not.found":"Knowledge Base does not exist","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"category.not.found":"Category does not exist","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:category:edit"]},"x-purecloud-method-name":"patchKnowledgeKnowledgebaseLanguageCategory"}},"/api/v2/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType}":{"get":{"tags":["Telephony Providers Edge"],"summary":"List schemas of a specific category (Deprecated)","description":"","operationId":"getConfigurationSchemasEdgesVnextSchemaCategorySchemaType","produces":["application/json"],"parameters":[{"name":"schemaCategory","in":"path","description":"Schema category","required":true,"type":"string"},{"name":"schemaType","in":"path","description":"Schema type","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SchemaReferenceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getConfigurationSchemasEdgesVnextSchemaCategorySchemaType"}},"/api/v2/configuration/schemas/edges/vnext/{schemaCategory}":{"get":{"tags":["Telephony Providers Edge"],"summary":"List schemas of a specific category (Deprecated)","description":"","operationId":"getConfigurationSchemasEdgesVnextSchemaCategory","produces":["application/json"],"parameters":[{"name":"schemaCategory","in":"path","description":"Schema category","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SchemaReferenceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getConfigurationSchemasEdgesVnextSchemaCategory"}},"/api/v2/scim/v2/groups/{groupId}":{"get":{"tags":["SCIM"],"summary":"Get a group","description":"","operationId":"getScimV2Group","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"name":"groupId","in":"path","description":"The ID of a group. Returned with GET /api/v2/scim/v2/groups.","required":true,"type":"string"},{"name":"attributes","in":"query","description":"Indicates which attributes to include. Returns these attributes and the \"id\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","displayName","members","externalId","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:id","urn:ietf:params:scim:schemas:core:2.0:Group:meta","urn:ietf:params:scim:schemas:core:2.0:Group:meta.version","urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:displayName","urn:ietf:params:scim:schemas:core:2.0:Group:members","urn:ietf:params:scim:schemas:core:2.0:Group:externalId"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"id"},{"name":"displayName"},{"name":"members"},{"name":"externalId"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:members"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:externalId"},{"name":"id"},{"name":"displayName"},{"name":"members"},{"name":"externalId"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:members"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:externalId"}]},{"name":"excludedAttributes","in":"query","description":"Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns \"id\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","displayName","members","externalId","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:id","urn:ietf:params:scim:schemas:core:2.0:Group:meta","urn:ietf:params:scim:schemas:core:2.0:Group:meta.version","urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:displayName","urn:ietf:params:scim:schemas:core:2.0:Group:members","urn:ietf:params:scim:schemas:core:2.0:Group:externalId"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"id"},{"name":"displayName"},{"name":"members"},{"name":"externalId"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:members"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:externalId"},{"name":"id"},{"name":"displayName"},{"name":"members"},{"name":"externalId"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:members"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:externalId"}]},{"name":"If-None-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2Group"}},"304":{"description":"If-Non-Match header matches current version. No content returned."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:edit"]},"x-purecloud-method-name":"getScimV2Group"},"put":{"tags":["SCIM"],"summary":"Replace a group","description":"","operationId":"putScimV2Group","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"name":"groupId","in":"path","description":"The ID of a group. Returned with GET /api/v2/scim/v2/groups.","required":true,"type":"string"},{"name":"If-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".","required":false,"type":"string"},{"in":"body","name":"body","description":"The information used to replace a group.","required":true,"schema":{"$ref":"#/definitions/ScimV2Group"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2Group"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Version does not match current version.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:edit"]},"x-purecloud-method-name":"putScimV2Group"},"patch":{"tags":["SCIM"],"summary":"Modify a group","description":"","operationId":"patchScimV2Group","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"name":"groupId","in":"path","description":"The ID of a group. Returned with GET /api/v2/scim/v2/groups.","required":true,"type":"string"},{"name":"If-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".","required":false,"type":"string"},{"in":"body","name":"body","description":"The information used to modify a group.","required":true,"schema":{"$ref":"#/definitions/ScimV2PatchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2Group"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","org.disabled":"Unable to modify group due to the organization being disabled.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Version does not match current version.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:edit"]},"x-purecloud-method-name":"patchScimV2Group"}},"/api/v2/scim/v2/groups":{"get":{"tags":["SCIM"],"summary":"Get a list of groups","description":"","operationId":"getScimV2Groups","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"name":"startIndex","in":"query","description":"The 1-based index of the first query result.","required":false,"type":"integer","default":1,"format":"int32"},{"name":"count","in":"query","description":"The requested number of items per page. A value of 0 returns \"totalResults\". A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the \"excludedAttributes\" or \"attributes\" query parameters to exclude or only include secondary lookup values such as \"externalId\", \"roles\", \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages\", or \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills\".","required":false,"type":"integer","default":25,"format":"int32"},{"name":"attributes","in":"query","description":"Indicates which attributes to include. Returns these attributes and the \"id\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","displayName","members","externalId","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:id","urn:ietf:params:scim:schemas:core:2.0:Group:meta","urn:ietf:params:scim:schemas:core:2.0:Group:meta.version","urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:displayName","urn:ietf:params:scim:schemas:core:2.0:Group:members","urn:ietf:params:scim:schemas:core:2.0:Group:externalId"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"id"},{"name":"displayName"},{"name":"members"},{"name":"externalId"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:members"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:externalId"},{"name":"id"},{"name":"displayName"},{"name":"members"},{"name":"externalId"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:members"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:externalId"}]},{"name":"excludedAttributes","in":"query","description":"Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns \"id\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","displayName","members","externalId","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:id","urn:ietf:params:scim:schemas:core:2.0:Group:meta","urn:ietf:params:scim:schemas:core:2.0:Group:meta.version","urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:displayName","urn:ietf:params:scim:schemas:core:2.0:Group:members","urn:ietf:params:scim:schemas:core:2.0:Group:externalId"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"id"},{"name":"displayName"},{"name":"members"},{"name":"externalId"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:members"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:externalId"},{"name":"id"},{"name":"displayName"},{"name":"members"},{"name":"externalId"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:members"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:externalId"}]},{"name":"filter","in":"query","description":"Filters results. If nothing is specified, returns all groups. Examples of valid values: \"id eq 5f4bc742-a019-4e38-8e2a-d39d5bc0b0f3\", \"displayname eq Sales\".","required":true,"type":"string","x-example":"displayName eq groupName"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimGroupListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:edit"]},"x-purecloud-method-name":"getScimV2Groups"}},"/api/v2/telephony/providers/edges/{edgeId}/statuscode":{"post":{"tags":["Telephony Providers Edge"],"summary":"Take an Edge in or out of service","description":"","operationId":"postTelephonyProvidersEdgeStatuscode","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Edge Service State","required":false,"schema":{"$ref":"#/definitions/EdgeServiceStateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The active Edge(s) assigned to a Site must all be assigned to the same Edge Group.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Specified edgeId not found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgeStatuscode"}},"/api/v2/recording/localkeys/settings/{settingsId}":{"get":{"tags":["Recording"],"summary":"Get the local encryption settings","description":"","operationId":"getRecordingLocalkeysSetting","produces":["application/json"],"parameters":[{"name":"settingsId","in":"path","description":"Settings Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LocalEncryptionConfiguration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:encryptionKey:view"]},"x-purecloud-method-name":"getRecordingLocalkeysSetting"},"put":{"tags":["Recording"],"summary":"Update the local encryption settings","description":"","operationId":"putRecordingLocalkeysSetting","produces":["application/json"],"parameters":[{"name":"settingsId","in":"path","description":"Settings Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Local Encryption metadata","required":true,"schema":{"$ref":"#/definitions/LocalEncryptionConfiguration"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LocalEncryptionConfiguration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:encryptionKey:edit"]},"x-purecloud-method-name":"putRecordingLocalkeysSetting"}},"/api/v2/architect/prompts/{promptId}/resources":{"get":{"tags":["Architect"],"summary":"Get a pageable list of user prompt resources","description":"The returned list is pageable, and query parameters can be used for filtering.","operationId":"getArchitectPromptResources","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PromptAssetEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.not.found":"Could not find prompt with specified ID.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:view"]},"x-purecloud-method-name":"getArchitectPromptResources"},"post":{"tags":["Architect"],"summary":"Create a new user prompt resource","description":"","operationId":"postArchitectPromptResources","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/PromptAssetCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PromptAsset"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.resource.validate.failed.language":"Failed to validate prompt resource due to missing or invalid language.","architect.prompt.resource.invalid.tags":"The specified tags are in an invalid format.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","architect.object.validate.failed":"Failed to validate object.","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.not.found":"Could not find prompt with specified ID.","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.resource.tags.already.exist":"The specified tags already exist in another prompt resource.","architect.prompt.resource.already.exists":"Prompt already has a resource with specified language."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:edit"]},"x-purecloud-method-name":"postArchitectPromptResources"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents":{"get":{"tags":["Knowledge"],"summary":"Get documents","description":"","operationId":"getKnowledgeKnowledgebaseLanguageDocuments","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","de-DE"],"x-genesys-enum-members":[{"name":"en-US"},{"name":"de-DE"}]},{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"limit","in":"query","description":"Number of entities to return. Maximum of 200. Deprecated in favour of pageSize.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"name":"categories","in":"query","description":"Filter by categories ids, comma separated values expected.","required":false,"type":"string"},{"name":"title","in":"query","description":"Filter by document title.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","input.validations":"Input parameters do not match the required criteria","kb.not.found":"Knowledge Base does not exist","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseLanguageDocuments"},"post":{"tags":["Knowledge"],"summary":"Create document","description":"","operationId":"postKnowledgeKnowledgebaseLanguageDocuments","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","de-DE"],"x-genesys-enum-members":[{"name":"en-US"},{"name":"de-DE"}]},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeDocumentRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocument"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","document.limitexceeded":"Document count exceeded for kbId","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","input.validations":"Input parameters do not match the required criteria","kb.not.found":"Knowledge Base does not exist","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseLanguageDocuments"},"patch":{"tags":["Knowledge"],"summary":"Update documents collection","description":"","operationId":"patchKnowledgeKnowledgebaseLanguageDocuments","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","de-DE"],"x-genesys-enum-members":[{"name":"en-US"},{"name":"de-DE"}]},{"in":"body","name":"body","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/KnowledgeDocumentBulkRequest"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","input.validations":"Input parameters do not match the required criteria","kb.not.found":"Knowledge Base does not exist","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","document.not.found":"Document does not exist"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"500":"Internal server error","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:edit"]},"x-purecloud-method-name":"patchKnowledgeKnowledgebaseLanguageDocuments"}},"/api/v2/externalcontacts/contacts/schemas/{schemaId}/versions":{"get":{"tags":["External Contacts"],"summary":"Get all versions of an external contact's schema","description":"","operationId":"getExternalcontactsContactsSchemaVersions","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"The schema to expand has parse errors"}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getExternalcontactsContactsSchemaVersions"}},"/api/v2/scim/groups/{groupId}":{"get":{"tags":["SCIM"],"summary":"Get a group","description":"","operationId":"getScimGroup","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"name":"groupId","in":"path","description":"The ID of a group. Returned with GET /api/v2/scim/groups.","required":true,"type":"string"},{"name":"attributes","in":"query","description":"Indicates which attributes to include. Returns these attributes and the \"id\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","displayName","members","externalId","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:id","urn:ietf:params:scim:schemas:core:2.0:Group:meta","urn:ietf:params:scim:schemas:core:2.0:Group:meta.version","urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:displayName","urn:ietf:params:scim:schemas:core:2.0:Group:members","urn:ietf:params:scim:schemas:core:2.0:Group:externalId"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"id"},{"name":"displayName"},{"name":"members"},{"name":"externalId"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:members"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:externalId"},{"name":"id"},{"name":"displayName"},{"name":"members"},{"name":"externalId"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:members"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:externalId"}]},{"name":"excludedAttributes","in":"query","description":"Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns \"id\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","displayName","members","externalId","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:id","urn:ietf:params:scim:schemas:core:2.0:Group:meta","urn:ietf:params:scim:schemas:core:2.0:Group:meta.version","urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:displayName","urn:ietf:params:scim:schemas:core:2.0:Group:members","urn:ietf:params:scim:schemas:core:2.0:Group:externalId"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"id"},{"name":"displayName"},{"name":"members"},{"name":"externalId"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:members"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:externalId"},{"name":"id"},{"name":"displayName"},{"name":"members"},{"name":"externalId"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:members"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:externalId"}]},{"name":"If-None-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2Group"}},"304":{"description":"If-Non-Match header matches current version. No content returned."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:edit"]},"x-purecloud-method-name":"getScimGroup"},"put":{"tags":["SCIM"],"summary":"Replace a group","description":"","operationId":"putScimGroup","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"name":"groupId","in":"path","description":"The ID of a group. Returned with GET /api/v2/scim/groups.","required":true,"type":"string"},{"name":"If-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".","required":false,"type":"string"},{"in":"body","name":"body","description":"The information used to replace a group.","required":true,"schema":{"$ref":"#/definitions/ScimV2Group"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2Group"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Version does not match current version.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:edit"]},"x-purecloud-method-name":"putScimGroup"},"patch":{"tags":["SCIM"],"summary":"Modify a group","description":"","operationId":"patchScimGroup","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"name":"groupId","in":"path","description":"The ID of a group. Returned with GET /api/v2/scim/groups.","required":true,"type":"string"},{"name":"If-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".","required":false,"type":"string"},{"in":"body","name":"body","description":"The information used to modify a group.","required":true,"schema":{"$ref":"#/definitions/ScimV2PatchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2Group"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Version does not match current version.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:edit"]},"x-purecloud-method-name":"patchScimGroup"}},"/api/v2/scim/groups":{"get":{"tags":["SCIM"],"summary":"Get a list of groups","description":"","operationId":"getScimGroups","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"name":"startIndex","in":"query","description":"The 1-based index of the first query result.","required":false,"type":"integer","default":1,"format":"int32"},{"name":"count","in":"query","description":"The requested number of items per page. A value of 0 returns \"totalResults\". A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the \"excludedAttributes\" or \"attributes\" query parameters to exclude or only include secondary lookup values such as \"externalId\", \"roles\", \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages\", or \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills\".","required":false,"type":"integer","default":25,"format":"int32"},{"name":"attributes","in":"query","description":"Indicates which attributes to include. Returns these attributes and the \"id\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","displayName","members","externalId","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:id","urn:ietf:params:scim:schemas:core:2.0:Group:meta","urn:ietf:params:scim:schemas:core:2.0:Group:meta.version","urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:displayName","urn:ietf:params:scim:schemas:core:2.0:Group:members","urn:ietf:params:scim:schemas:core:2.0:Group:externalId"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"id"},{"name":"displayName"},{"name":"members"},{"name":"externalId"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:members"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:externalId"},{"name":"id"},{"name":"displayName"},{"name":"members"},{"name":"externalId"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:members"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:externalId"}]},{"name":"excludedAttributes","in":"query","description":"Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns \"id\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","displayName","members","externalId","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:id","urn:ietf:params:scim:schemas:core:2.0:Group:meta","urn:ietf:params:scim:schemas:core:2.0:Group:meta.version","urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:displayName","urn:ietf:params:scim:schemas:core:2.0:Group:members","urn:ietf:params:scim:schemas:core:2.0:Group:externalId"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"id"},{"name":"displayName"},{"name":"members"},{"name":"externalId"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:members"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:externalId"},{"name":"id"},{"name":"displayName"},{"name":"members"},{"name":"externalId"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:members"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:externalId"}]},{"name":"filter","in":"query","description":"Filters results. If nothing is specified, returns all groups. Examples of valid values: \"id eq 5f4bc742-a019-4e38-8e2a-d39d5bc0b0f3\", \"displayname eq Sales\".","required":false,"type":"string","x-example":"displayName eq groupName"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimGroupListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:edit"]},"x-purecloud-method-name":"getScimGroups"}},"/api/v2/authorization/permissions":{"get":{"tags":["Authorization"],"summary":"Get all permissions.","description":"Retrieve a list of all permission defined in the system.","operationId":"getAuthorizationPermissions","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"queryType","in":"query","description":"Query filter type","required":false,"type":"string","enum":["domain","permission"],"x-genesys-enum-members":[{"name":"domain"},{"name":"permission"}]},{"name":"query","in":"query","description":"Comma-separated list of permissions or domains to query","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PermissionCollectionEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"The application is not authorized for the scope.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-purecloud-method-name":"getAuthorizationPermissions"}},"/api/v2/recording/jobs":{"get":{"tags":["Recording"],"summary":"Get the status of all jobs within the user's organization","description":"","operationId":"getRecordingJobs","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"userId","enum":["userId","dateCreated"],"x-genesys-enum-members":[{"name":"userId"},{"name":"dateCreated"}]},{"name":"state","in":"query","description":"Filter by state","required":false,"type":"string","enum":["FULFILLED","PENDING","READY","PROCESSING","CANCELLED","FAILED"],"x-genesys-enum-members":[{"name":"FULFILLED"},{"name":"PENDING"},{"name":"READY"},{"name":"PROCESSING"},{"name":"CANCELLED"},{"name":"FAILED"}]},{"name":"showOnlyMyJobs","in":"query","description":"Show only my jobs","required":false,"type":"boolean"},{"name":"jobType","in":"query","description":"Job Type (Can be left empty for both)","required":false,"type":"string","enum":["DELETE","EXPORT"],"x-genesys-enum-members":[{"name":"DELETE"},{"name":"EXPORT"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingJobEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["recording:job:view"]},"x-purecloud-method-name":"getRecordingJobs"},"post":{"tags":["Recording"],"summary":"Create a recording bulk job","description":"","operationId":"postRecordingJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/RecordingJobsQuery"}}],"responses":{"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/RecordingJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["recording:job:add"]},"x-purecloud-method-name":"postRecordingJobs"}},"/api/v2/architect/dependencytracking/consumingresources":{"get":{"tags":["Architect"],"summary":"Get resources that consume a given Dependency Tracking object","description":"","operationId":"getArchitectDependencytrackingConsumingresources","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"Consumed object ID","required":true,"type":"string"},{"name":"objectType","in":"query","description":"Consumed object type","required":true,"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","BOTCONNECTORBOT","BOTCONNECTORBOTVERSION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GROUP","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","IVRCONFIGURATION","LANGUAGE","LEXBOT","LEXBOTALIAS","NLUDOMAIN","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","WIDGET","WORKFLOW"],"x-genesys-enum-members":[{"name":"ACDLANGUAGE"},{"name":"ACDSKILL"},{"name":"ACDWRAPUPCODE"},{"name":"BOTCONNECTORBOT"},{"name":"BOTCONNECTORBOTVERSION"},{"name":"BOTFLOW"},{"name":"BRIDGEACTION"},{"name":"COMMONMODULEFLOW"},{"name":"COMPOSERSCRIPT"},{"name":"CONTACTLIST"},{"name":"DATAACTION"},{"name":"DATATABLE"},{"name":"DIALOGENGINEBOT"},{"name":"DIALOGENGINEBOTVERSION"},{"name":"DIALOGFLOWAGENT"},{"name":"EMAILROUTE"},{"name":"EMERGENCYGROUP"},{"name":"FLOWACTION"},{"name":"FLOWDATATYPE"},{"name":"FLOWMILESTONE"},{"name":"FLOWOUTCOME"},{"name":"GROUP"},{"name":"INBOUNDCALLFLOW"},{"name":"INBOUNDCHATFLOW"},{"name":"INBOUNDEMAILFLOW"},{"name":"INBOUNDSHORTMESSAGEFLOW"},{"name":"INQUEUECALLFLOW"},{"name":"IVRCONFIGURATION"},{"name":"LANGUAGE"},{"name":"LEXBOT"},{"name":"LEXBOTALIAS"},{"name":"NLUDOMAIN"},{"name":"OUTBOUNDCALLFLOW"},{"name":"QUEUE"},{"name":"RECORDINGPOLICY"},{"name":"RESPONSE"},{"name":"SCHEDULE"},{"name":"SCHEDULEGROUP"},{"name":"SECUREACTION"},{"name":"SECURECALLFLOW"},{"name":"SURVEYINVITEFLOW"},{"name":"SYSTEMPROMPT"},{"name":"TTSENGINE"},{"name":"TTSVOICE"},{"name":"USER"},{"name":"USERPROMPT"},{"name":"WIDGET"},{"name":"WORKFLOW"}]},{"name":"resourceType","in":"query","description":"Types of consuming resources to show. Only versioned types are allowed here.","required":false,"type":"array","items":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","BOTCONNECTORBOT","BOTCONNECTORBOTVERSION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GROUP","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","IVRCONFIGURATION","LANGUAGE","LEXBOT","LEXBOTALIAS","NLUDOMAIN","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","WIDGET","WORKFLOW"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"ACDLANGUAGE"},{"name":"ACDSKILL"},{"name":"ACDWRAPUPCODE"},{"name":"BOTCONNECTORBOT"},{"name":"BOTCONNECTORBOTVERSION"},{"name":"BOTFLOW"},{"name":"BRIDGEACTION"},{"name":"COMMONMODULEFLOW"},{"name":"COMPOSERSCRIPT"},{"name":"CONTACTLIST"},{"name":"DATAACTION"},{"name":"DATATABLE"},{"name":"DIALOGENGINEBOT"},{"name":"DIALOGENGINEBOTVERSION"},{"name":"DIALOGFLOWAGENT"},{"name":"EMAILROUTE"},{"name":"EMERGENCYGROUP"},{"name":"FLOWACTION"},{"name":"FLOWDATATYPE"},{"name":"FLOWMILESTONE"},{"name":"FLOWOUTCOME"},{"name":"GROUP"},{"name":"INBOUNDCALLFLOW"},{"name":"INBOUNDCHATFLOW"},{"name":"INBOUNDEMAILFLOW"},{"name":"INBOUNDSHORTMESSAGEFLOW"},{"name":"INQUEUECALLFLOW"},{"name":"IVRCONFIGURATION"},{"name":"LANGUAGE"},{"name":"LEXBOT"},{"name":"LEXBOTALIAS"},{"name":"NLUDOMAIN"},{"name":"OUTBOUNDCALLFLOW"},{"name":"QUEUE"},{"name":"RECORDINGPOLICY"},{"name":"RESPONSE"},{"name":"SCHEDULE"},{"name":"SCHEDULEGROUP"},{"name":"SECUREACTION"},{"name":"SECURECALLFLOW"},{"name":"SURVEYINVITEFLOW"},{"name":"SYSTEMPROMPT"},{"name":"TTSENGINE"},{"name":"TTSVOICE"},{"name":"USER"},{"name":"USERPROMPT"},{"name":"WIDGET"},{"name":"WORKFLOW"}]},{"name":"version","in":"query","description":"Object version","required":false,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"flowFilter","in":"query","description":"Show only checkedIn or published flows","required":false,"type":"string","enum":["checkedIn","published"],"x-genesys-enum-members":[{"name":"checkedIn"},{"name":"published"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConsumingResourcesEntityListing"}},"206":{"description":"Partial Content - the org data is being rebuilt or needs to be rebuilt."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","architect.query.parameter.missing":"A required query parameter is missing or empty.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","architect.dependency.object.invalid.type":"An invalid dependency object type was specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.version.missing":"Specified flow version is missing.","not.found":"The requested resource was not found.","architect.dependency.object.not.found":"Could not find the dependency object with specified ID and version.","architect.flow.not.found":"Could not find flow with specified ID."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","architect.database.throughput.exceeded":"Database too busy. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:dependencyTracking:view"]},"x-purecloud-method-name":"getArchitectDependencytrackingConsumingresources"}},"/api/v2/users/{userId}/password":{"post":{"tags":["Users"],"summary":"Change a users password","description":"","operationId":"postUserPassword","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Password","required":true,"schema":{"$ref":"#/definitions/ChangePasswordRequest"}}],"responses":{"204":{"description":"Password changed"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.new.password":"The new password does not meet policy requirements","invalid.password":"The new password does not meet policy requirements","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a user with that userId","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:setPassword"]},"x-purecloud-method-name":"postUserPassword"}},"/api/v2/contentmanagement/auditquery":{"post":{"tags":["Content Management"],"summary":"Query audits","description":"","operationId":"postContentmanagementAuditquery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Allows for a filtered query returning facet information","required":true,"schema":{"$ref":"#/definitions/ContentQueryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueryResults"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Query audits forbidden."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"postContentmanagementAuditquery"}},"/api/v2/identityproviders/pureengage":{"get":{"tags":["Identity Provider"],"summary":"Get PureEngage Identity Provider","description":"","operationId":"getIdentityprovidersPureengage","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PureEngage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersPureengage"},"put":{"tags":["Identity Provider"],"summary":"Update/Create PureEngage Identity Provider","description":"","operationId":"putIdentityprovidersPureengage","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/PureEngage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.issuer.uri":"An issuer URI is required.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.target.url":"The target URL must be a valid HTTPS URL.","certificate.not.yet.valid":"The certificate is not yet valid.","certificate.invalid.base64":"Invalid base64 in certificate.","certificate.unparseable":"The certificate for provider cannot be parsed.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersPureengage"},"delete":{"tags":["Identity Provider"],"summary":"Delete PureEngage Identity Provider","description":"","operationId":"deleteIdentityprovidersPureengage","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersPureengage"}},"/api/v2/routing/queues/divisionviews/all":{"get":{"tags":["Routing"],"summary":"Get a paged listing of simplified queue objects. Can be used to get a digest of all queues in an organization.","description":"","operationId":"getRoutingQueuesDivisionviewsAll","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size [max value is 500]","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name","enum":["name","id","divisionId"],"x-genesys-enum-members":[{"name":"name"},{"name":"id"},{"name":"divisionId"}]},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc","enum":["asc","desc","score"],"x-genesys-enum-members":[{"name":"asc"},{"name":"desc"},{"name":"score"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.page.number":"Invalid page number specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:queue:search"]},"x-purecloud-method-name":"getRoutingQueuesDivisionviewsAll"}},"/api/v2/identityproviders/identitynow":{"get":{"tags":["Identity Provider"],"summary":"Get IdentityNow Provider","description":"","operationId":"getIdentityprovidersIdentitynow","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IdentityNow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersIdentitynow"},"put":{"tags":["Identity Provider"],"summary":"Update/Create IdentityNow Provider","description":"","operationId":"putIdentityprovidersIdentitynow","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/IdentityNow"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IdentityNow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.issuer.uri":"An issuer URI is required.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.target.url":"The target URL must be a valid HTTPS URL.","certificate.not.yet.valid":"The certificate is not yet valid.","certificate.invalid.base64":"Invalid base64 in certificate.","certificate.unparseable":"The certificate for provider cannot be parsed.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersIdentitynow"},"delete":{"tags":["Identity Provider"],"summary":"Delete IdentityNow Provider","description":"","operationId":"deleteIdentityprovidersIdentitynow","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersIdentitynow"}},"/api/v2/telephony/providers/edges/sites/{siteId}/numberplans":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of Number Plans for this Site. Only fetches the first 200 records.","description":"","operationId":"getTelephonyProvidersEdgesSiteNumberplans","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/NumberPlan"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesSiteNumberplans"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update the list of Number Plans. A user can update maximum 200 number plans at a time.","description":"","operationId":"putTelephonyProvidersEdgesSiteNumberplans","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"in":"body","name":"body","description":"List of number plans","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/NumberPlan"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/NumberPlan"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"number.plan.in.use":"The number plan is in use by one or more outbound route.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","error.updating.number.plans":"There was a problem updating number plans.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.number.plan.name":"Number Plan names must be unique.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Unable to find a number plan with that id","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesSiteNumberplans"}},"/api/v2/telephony/providers/edges/{edgeId}/setuppackage":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the setup package for a locally deployed edge device. This is needed to complete the setup process for the virtual edge.","description":"","operationId":"getTelephonyProvidersEdgeSetuppackage","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VmPairingInfo"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgeSetuppackage"}},"/api/v2/knowledge/knowledgebases":{"get":{"tags":["Knowledge"],"summary":"Get knowledge bases","description":"","operationId":"getKnowledgeKnowledgebases","produces":["application/json"],"parameters":[{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"limit","in":"query","description":"Number of entities to return. Maximum of 200. Deprecated in favour of pageSize.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"name":"name","in":"query","description":"Name of the KnowledgeBase to filter.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeBaseListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","input.validations":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:knowledgebase:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebases"},"post":{"tags":["Knowledge"],"summary":"Create new knowledge base","description":"","operationId":"postKnowledgeKnowledgebases","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeBase"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"kb.limitexceeded":"Knowledge Base count exceeded","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","input.validations":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:knowledgebase:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebases"}},"/api/v2/integrations/{integrationId}":{"get":{"tags":["Integrations"],"summary":"Get integration.","description":"","operationId":"getIntegration","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration Id","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Integration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-purecloud-method-name":"getIntegration"},"delete":{"tags":["Integrations"],"summary":"Delete integration.","description":"","operationId":"deleteIntegration","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Integration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-purecloud-method-name":"deleteIntegration"},"patch":{"tags":["Integrations"],"summary":"Update an integration.","description":"","operationId":"patchIntegration","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Integration Update","required":false,"schema":{"$ref":"#/definitions/Integration"}},{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Integration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-purecloud-method-name":"patchIntegration"}},"/api/v2/routing/queues/{queueId}/wrapupcodes":{"get":{"tags":["Routing"],"summary":"Get the wrap-up codes for a queue","description":"","operationId":"getRoutingQueueWrapupcodes","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapupCodeEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"At least one of the required division permissions is missing","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The queue could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:queue:view"]},"x-purecloud-method-name":"getRoutingQueueWrapupcodes"},"post":{"tags":["Routing"],"summary":"Add up to 100 wrap-up codes to a queue","description":"","operationId":"postRoutingQueueWrapupcodes","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"in":"body","name":"body","description":"List of wrapup codes","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/WrapUpCodeReference"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid request data. Make sure you submit a valid number of wrapup codes.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"At least one of the required division permissions is missing","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The specified queue was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:queue:edit"]},"x-purecloud-method-name":"postRoutingQueueWrapupcodes"}},"/api/v2/routing/queues/{queueId}/wrapupcodes/{codeId}":{"delete":{"tags":["Routing"],"summary":"Delete a wrap-up code from a queue","description":"","operationId":"deleteRoutingQueueWrapupcode","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"codeId","in":"path","description":"Code ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"At least one of the required division permissions is missing","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The queue could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:queue:edit"]},"x-purecloud-method-name":"deleteRoutingQueueWrapupcode"}},"/api/v2/journey/actiontemplates":{"get":{"tags":["Journey"],"summary":"Retrieve all action templates.","description":"","operationId":"getJourneyActiontemplates","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Field(s) to sort by. Prefix with '-' for descending (e.g. sortBy=name,-createdDate).","required":false,"type":"string"},{"name":"mediaType","in":"query","description":"Media type","required":false,"type":"string","enum":["webchat","webMessagingOffer","contentOffer","integrationAction","architectFlow"],"x-genesys-enum-members":[{"name":"webchat"},{"name":"webMessagingOffer"},{"name":"contentOffer"},{"name":"integrationAction"},{"name":"architectFlow"}]},{"name":"state","in":"query","description":"Action template state","required":false,"type":"string","enum":["Active","Inactive","Deleted"],"x-genesys-enum-members":[{"name":"Active"},{"name":"Inactive"},{"name":"Deleted"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionTemplateListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actiontemplate:view"]},"x-purecloud-method-name":"getJourneyActiontemplates"},"post":{"tags":["Journey"],"summary":"Create a single action template.","description":"","operationId":"postJourneyActiontemplates","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ActionTemplate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionTemplate"}},"201":{"description":"Action template created.","schema":{"$ref":"#/definitions/ActionTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actiontemplate:add"]},"x-purecloud-method-name":"postJourneyActiontemplates"}},"/api/v2/gdpr/requests/{requestId}":{"get":{"tags":["General Data Protection Regulation"],"summary":"Get an existing GDPR request","description":"","operationId":"getGdprRequest","produces":["application/json"],"parameters":[{"name":"requestId","in":"path","description":"Request id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GDPRRequest"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gdpr","gdpr:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gdpr:request:view"]},"x-purecloud-method-name":"getGdprRequest"}},"/api/v2/users/development/activities/aggregates/query":{"post":{"tags":["Users"],"summary":"Retrieve aggregated development activity data","description":"Results are filtered based on the applicable permissions.","operationId":"postUsersDevelopmentActivitiesAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Aggregate Request","required":true,"schema":{"$ref":"#/definitions/DevelopmentActivityAggregateParam"}}],"responses":{"200":{"description":"Query completed successfully","schema":{"$ref":"#/definitions/DevelopmentActivityAggregateResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was a problem with the request, see the message for details","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","coaching:readonly","learning","learning:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:assignment:view","coaching:appointment:view"]},"x-purecloud-method-name":"postUsersDevelopmentActivitiesAggregatesQuery"}},"/api/v2/conversations/chats/{conversationId}/messages":{"get":{"tags":["Conversations"],"summary":"Get the messages of a chat conversation.","description":"The current user must be involved with the conversation to get its messages.","operationId":"getConversationsChatMessages","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"after","in":"query","description":"If specified, get the messages chronologically after the id of this message","required":false,"type":"string"},{"name":"before","in":"query","description":"If specified, get the messages chronologically before the id of this message","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ascending","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]},{"name":"maxResults","in":"query","description":"Limit the returned number of messages, up to a maximum of 100","required":false,"type":"integer","default":100,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatMessageEntityList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.not.found":"Chat conversation message is not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsChatMessages"}},"/api/v2/telephony/providers/edges/sites/{siteId}/rebalance":{"post":{"tags":["Telephony Providers Edge"],"summary":"Triggers the rebalance operation.","description":"","operationId":"postTelephonyProvidersEdgesSiteRebalance","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"}],"responses":{"202":{"description":"Accepted - Processing the Rebalance"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesSiteRebalance"}},"/api/v2/journey/actionmaps/{actionMapId}":{"get":{"tags":["Journey"],"summary":"Retrieve a single action map.","description":"","operationId":"getJourneyActionmap","produces":["application/json"],"parameters":[{"name":"actionMapId","in":"path","description":"ID of the action map.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionMap"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actionmap:view"]},"x-purecloud-method-name":"getJourneyActionmap"},"delete":{"tags":["Journey"],"summary":"Delete single action map.","description":"","operationId":"deleteJourneyActionmap","produces":["application/json"],"parameters":[{"name":"actionMapId","in":"path","description":"ID of the action map.","required":true,"type":"string"}],"responses":{"204":{"description":"Action map deleted."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actionmap:delete"]},"x-purecloud-method-name":"deleteJourneyActionmap"},"patch":{"tags":["Journey"],"summary":"Update single action map.","description":"","operationId":"patchJourneyActionmap","produces":["application/json"],"parameters":[{"name":"actionMapId","in":"path","description":"ID of the action map.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/PatchActionMap"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionMap"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actionmap:edit"]},"x-purecloud-method-name":"patchJourneyActionmap"}},"/api/v2/scim/users/{userId}":{"get":{"tags":["SCIM"],"summary":"Get a user","description":"","operationId":"getScimUser","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"name":"userId","in":"path","description":"The ID of a user. Returned with GET /api/v2/scim/users.","required":true,"type":"string"},{"name":"attributes","in":"query","description":"Indicates which attributes to include. Returns these attributes and the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","userName","displayName","title","active","externalId","phoneNumbers","emails","groups","roles","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:User:id","urn:ietf:params:scim:schemas:core:2.0:User:userName","urn:ietf:params:scim:schemas:core:2.0:User:displayName","urn:ietf:params:scim:schemas:core:2.0:User:title","urn:ietf:params:scim:schemas:core:2.0:User:active","urn:ietf:params:scim:schemas:core:2.0:User:externalId","urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers","urn:ietf:params:scim:schemas:core:2.0:User:emails","urn:ietf:params:scim:schemas:core:2.0:User:groups","urn:ietf:params:scim:schemas:core:2.0:User:roles","urn:ietf:params:scim:schemas:core:2.0:User:meta","urn:ietf:params:scim:schemas:core:2.0:User:meta.version","urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"id"},{"name":"userName"},{"name":"displayName"},{"name":"title"},{"name":"active"},{"name":"externalId"},{"name":"phoneNumbers"},{"name":"emails"},{"name":"groups"},{"name":"roles"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:userName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:title"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:active"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:externalId"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:emails"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:groups"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:roles"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"},{"name":"id"},{"name":"userName"},{"name":"displayName"},{"name":"title"},{"name":"active"},{"name":"externalId"},{"name":"phoneNumbers"},{"name":"emails"},{"name":"groups"},{"name":"roles"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:userName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:title"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:active"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:externalId"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:emails"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:groups"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:roles"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"}]},{"name":"excludedAttributes","in":"query","description":"Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","userName","displayName","title","active","externalId","phoneNumbers","emails","groups","roles","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:User:id","urn:ietf:params:scim:schemas:core:2.0:User:userName","urn:ietf:params:scim:schemas:core:2.0:User:displayName","urn:ietf:params:scim:schemas:core:2.0:User:title","urn:ietf:params:scim:schemas:core:2.0:User:active","urn:ietf:params:scim:schemas:core:2.0:User:externalId","urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers","urn:ietf:params:scim:schemas:core:2.0:User:emails","urn:ietf:params:scim:schemas:core:2.0:User:groups","urn:ietf:params:scim:schemas:core:2.0:User:roles","urn:ietf:params:scim:schemas:core:2.0:User:meta","urn:ietf:params:scim:schemas:core:2.0:User:meta.version","urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"id"},{"name":"userName"},{"name":"displayName"},{"name":"title"},{"name":"active"},{"name":"externalId"},{"name":"phoneNumbers"},{"name":"emails"},{"name":"groups"},{"name":"roles"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:userName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:title"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:active"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:externalId"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:emails"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:groups"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:roles"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"},{"name":"id"},{"name":"userName"},{"name":"displayName"},{"name":"title"},{"name":"active"},{"name":"externalId"},{"name":"phoneNumbers"},{"name":"emails"},{"name":"groups"},{"name":"roles"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:userName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:title"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:active"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:externalId"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:emails"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:groups"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:roles"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"}]},{"name":"If-None-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2User"}},"304":{"description":"If-Non-Match header matches current version. No content returned."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","general.conflict":"A conflict occurred when getting a SCIM user"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The SCIM user was not found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimUser"},"put":{"tags":["SCIM"],"summary":"Replace a user","description":"","operationId":"putScimUser","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"name":"userId","in":"path","description":"The ID of a user. Returned with GET /api/v2/scim/users.","required":true,"type":"string"},{"name":"If-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".","required":false,"type":"string"},{"in":"body","name":"body","description":"The information used to replace a user.","required":true,"schema":{"$ref":"#/definitions/ScimV2User"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2User"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Version does not match current version.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:edit","directory:user:setPassword","authorization:grant:add","authorization:grant:delete","routing:skill:assign","routing:language:assign"]},"x-purecloud-method-name":"putScimUser"},"delete":{"tags":["SCIM"],"summary":"Delete a user","description":"","operationId":"deleteScimUser","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"name":"userId","in":"path","description":"The ID of a user. Returned with GET /api/v2/scim/users.","required":true,"type":"string"},{"name":"If-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"204":{"description":"User Deleted with no content returned."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Version does not match current version.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:delete"]},"x-purecloud-method-name":"deleteScimUser"},"patch":{"tags":["SCIM"],"summary":"Modify a user","description":"","operationId":"patchScimUser","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"name":"userId","in":"path","description":"The ID of a user. Returned with GET /api/v2/scim/users.","required":true,"type":"string"},{"name":"If-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".","required":false,"type":"string"},{"in":"body","name":"body","description":"The information used to modify a user.","required":true,"schema":{"$ref":"#/definitions/ScimV2PatchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2User"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Version does not match current version.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:edit","directory:user:setPassword","authorization:grant:add","authorization:grant:delete","routing:skill:assign","routing:language:assign"]},"x-purecloud-method-name":"patchScimUser"}},"/api/v2/scim/users":{"get":{"tags":["SCIM"],"summary":"Get a list of users","description":"To return all active users, do not use the filter parameter. To return inactive users, set the filter parameter to \"active eq false\". By default, returns SCIM attributes \"externalId\", \"enterprise-user:manager\", and \"roles\". To exclude these attributes, set the attributes parameter to \"id,active\" or the excludeAttributes parameter to \"externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\".","operationId":"getScimUsers","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"name":"startIndex","in":"query","description":"The 1-based index of the first query result.","required":false,"type":"integer","default":1,"format":"int32"},{"name":"count","in":"query","description":"The requested number of items per page. A value of 0 returns \"totalResults\". A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the \"excludedAttributes\" or \"attributes\" query parameters to exclude or only include secondary lookup values such as \"externalId\", \"roles\", \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages\", or \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills\".","required":false,"type":"integer","default":25,"format":"int32"},{"name":"attributes","in":"query","description":"Indicates which attributes to include. Returns these attributes and the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","userName","displayName","title","active","externalId","phoneNumbers","emails","groups","roles","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:User:id","urn:ietf:params:scim:schemas:core:2.0:User:userName","urn:ietf:params:scim:schemas:core:2.0:User:displayName","urn:ietf:params:scim:schemas:core:2.0:User:title","urn:ietf:params:scim:schemas:core:2.0:User:active","urn:ietf:params:scim:schemas:core:2.0:User:externalId","urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers","urn:ietf:params:scim:schemas:core:2.0:User:emails","urn:ietf:params:scim:schemas:core:2.0:User:groups","urn:ietf:params:scim:schemas:core:2.0:User:roles","urn:ietf:params:scim:schemas:core:2.0:User:meta","urn:ietf:params:scim:schemas:core:2.0:User:meta.version","urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"id"},{"name":"userName"},{"name":"displayName"},{"name":"title"},{"name":"active"},{"name":"externalId"},{"name":"phoneNumbers"},{"name":"emails"},{"name":"groups"},{"name":"roles"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:userName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:title"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:active"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:externalId"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:emails"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:groups"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:roles"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"},{"name":"id"},{"name":"userName"},{"name":"displayName"},{"name":"title"},{"name":"active"},{"name":"externalId"},{"name":"phoneNumbers"},{"name":"emails"},{"name":"groups"},{"name":"roles"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:userName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:title"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:active"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:externalId"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:emails"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:groups"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:roles"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"}]},{"name":"excludedAttributes","in":"query","description":"Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","userName","displayName","title","active","externalId","phoneNumbers","emails","groups","roles","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:User:id","urn:ietf:params:scim:schemas:core:2.0:User:userName","urn:ietf:params:scim:schemas:core:2.0:User:displayName","urn:ietf:params:scim:schemas:core:2.0:User:title","urn:ietf:params:scim:schemas:core:2.0:User:active","urn:ietf:params:scim:schemas:core:2.0:User:externalId","urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers","urn:ietf:params:scim:schemas:core:2.0:User:emails","urn:ietf:params:scim:schemas:core:2.0:User:groups","urn:ietf:params:scim:schemas:core:2.0:User:roles","urn:ietf:params:scim:schemas:core:2.0:User:meta","urn:ietf:params:scim:schemas:core:2.0:User:meta.version","urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"id"},{"name":"userName"},{"name":"displayName"},{"name":"title"},{"name":"active"},{"name":"externalId"},{"name":"phoneNumbers"},{"name":"emails"},{"name":"groups"},{"name":"roles"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:userName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:title"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:active"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:externalId"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:emails"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:groups"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:roles"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"},{"name":"id"},{"name":"userName"},{"name":"displayName"},{"name":"title"},{"name":"active"},{"name":"externalId"},{"name":"phoneNumbers"},{"name":"emails"},{"name":"groups"},{"name":"roles"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:userName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:title"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:active"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:externalId"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:emails"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:groups"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:roles"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"}]},{"name":"filter","in":"query","description":"Filters results. If nothing is specified, returns all active users. Examples of valid values: \"id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\", \"userName eq search@sample.org\", \"manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\", \"email eq search@sample.org\", \"division eq divisionName\", \"externalId eq 167844\", \"active eq false\", \"employeeNumber eq 9876543210\".","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimUserListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"An internal server error has occurred."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimUsers"},"post":{"tags":["SCIM"],"summary":"Create a user","description":"","operationId":"postScimUsers","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"in":"body","name":"body","description":"The information used to create a user.","required":true,"schema":{"$ref":"#/definitions/ScimV2CreateUser"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2User"}},"201":{"description":"User Created.","schema":{"$ref":"#/definitions/ScimV2User"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"User name already in use by non-deleted user.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:add","authorization:grant:add","authorization:grant:delete","routing:skill:assign","routing:language:assign"]},"x-purecloud-method-name":"postScimUsers"}},"/api/v2/fax/documents/{documentId}/content":{"get":{"tags":["Fax"],"summary":"Download a fax document.","description":"","operationId":"getFaxDocumentContent","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DownloadResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["fax","fax:readonly"]}],"x-purecloud-method-name":"getFaxDocumentContent"}},"/api/v2/flows/outcomes":{"get":{"tags":["Architect"],"summary":"Get a pageable list of flow outcomes, filtered by query parameters","description":"Multiple IDs can be specified, in which case all matching flow outcomes will be returned, and no other parameters will be evaluated.","operationId":"getFlowsOutcomes","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"id"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc"},{"name":"id","in":"query","description":"ID","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"description","in":"query","description":"Description","required":false,"type":"string"},{"name":"nameOrDescription","in":"query","description":"Name or description","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowOutcomeListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.outcome.not.found":"Could not find resource with specified language in specified system prompt.","not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.feature.toggle.unavailable":"The required feature toggle is not enabled for this organization.","architect.flow.outcome.not.available":"Flow outcomes are not available for current organization."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowOutcome:view"]},"x-purecloud-method-name":"getFlowsOutcomes"},"post":{"tags":["Architect"],"summary":"Create a flow outcome","description":"Asynchronous. Notification topic: v2.flows.outcomes.{flowOutcomeId}","operationId":"postFlowsOutcomes","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/FlowOutcome"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowOutcome"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.outcome.validate.failed":"Failed to validate flow outcome.","architect.flow.outcome.validate.failed.invalid.name":"Failed to validate flow outcome due to invalid name. Names can only contain letters, numbers, and the underscore, and must start with a letter or number.","architect.flow.outcome.validate.failed.missing.name":"Failed to validate flow outcome due to missing name.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","architect.property.exceeds.max.character.length":"The name and/or description exceeds the maximum character length.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","architect.flow.outcome.validate.failed.missing.description":"Failed to validate flow outcome due to missing description.","architect.object.validate.failed":"Failed to validate object.","architect.flow.outcome.validate.failed.invalid.name.no.alpha":"Failed to validate flow outcome due to invalid name. Names must contain at least one alphanumeric character.","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.feature.toggle.unavailable":"The required feature toggle is not enabled for this organization.","architect.flow.outcome.not.available":"Flow outcomes are not available for current organization."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.outcome.already.exists":"A flow outcome with the specified name already exists.","architect.flow.outcome.exceeded.max.amount":"Could not create flow outcome since the maximum number of outcomes already exist."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowOutcome:add"]},"x-purecloud-method-name":"postFlowsOutcomes"}},"/api/v2/outbound/contactlistfilters/{contactListFilterId}":{"get":{"tags":["Outbound"],"summary":"Get Contact list filter","description":"","operationId":"getOutboundContactlistfilter","produces":["application/json"],"parameters":[{"name":"contactListFilterId","in":"path","description":"Contact List Filter ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListFilter"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactListFilter:view"]},"x-purecloud-method-name":"getOutboundContactlistfilter"},"put":{"tags":["Outbound"],"summary":"Update Contact List Filter","description":"","operationId":"putOutboundContactlistfilter","produces":["application/json"],"parameters":[{"name":"contactListFilterId","in":"path","description":"Contact List Filter ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ContactListFilter","required":true,"schema":{"$ref":"#/definitions/ContactListFilter"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListFilter"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"operator.required":"Could not update the contact list filter because the operator field was empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","contact.list.not.found":"Could not update the contact list filter because the contact list could not be found.","filter.type.required.for.multiple.predicates":"Could not update the contact list filter because the filter type on a clause is required if there are multiple predicates.","filter.type.required.for.multiple.clauses":"Could not update the contact list filter because the filter type is required if there are multiple clauses.","at.least.one.predicate.required":"Could not update the contact list filter because each clause must contain at least one predicate.","value.required":"Could not update the contact list filter because the value field on a predicate was empty and required for that predicate's operator.","range.max.required":"Could not update the contact list filter because the range max field is required for Between operator.","value.did.not.match.column.type":"Could not update the contact list filter because the predicate value field did not match the column type.","value.exceeds.max.digits":"The maximum number of digits for the value on a predicate with a numeric operator has been exceeded.","max.less.than.min":"Could not update the contact list filter because the predicate range max value is less than the min value.","min.did.not.match.column.type":"Could not update the contact list filter because the predicate range min field did not match the column type.","value.exceeds.max.decimal.places":"The maximum number of decimal places in the value on a predicate with a numeric operator has been exceeded.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","column.does.not.match.contact.list":"Could not update the contact list filter because the column on a predicate did not match a column on the selected contact list.","range.required":"Could not update the contact list filter because the range field was empty and is required for Between and In operators.","max.predicates.contains.exceeded":"Could not update the contact list filter because the maximum number of predicates with CONTAINS operators has been exceeded.","contact.list.cannot.be.blank":"Could not update the contact list filter because the contact list field was blank.","invalid.date.value":"Could not update the contact list filter because the value field on the predicate is not a valid date.","clauses.required":"Could not update the contact list filter because the clauses field is required to contain at least one clause.","max.did.not.match.column.type":"Could not update the contact list filter because the predicate range max field did not match the column type.","column.required":"Could not update the contact list filter because the column field was empty on a predicate.","max.predicates.exceeded":"Could not update the contact list filter because the maximum number of predicates has been exceeded.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","range.set.required":"Could not update the contact list filter because the range set field is required for In operator.","range.min.required":"Could not update the contact list filter because the range min field is required for Between operator."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactListFilter:edit"]},"x-purecloud-method-name":"putOutboundContactlistfilter"},"delete":{"tags":["Outbound"],"summary":"Delete Contact List Filter","description":"","operationId":"deleteOutboundContactlistfilter","produces":["application/json"],"parameters":[{"name":"contactListFilterId","in":"path","description":"Contact List Filter ID","required":true,"type":"string"}],"responses":{"204":{"description":"Contact list filter deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","referential.integrity.error":"Could not delete the resource because it is referenced by another entity."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactListFilter:delete"]},"x-purecloud-method-name":"deleteOutboundContactlistfilter"}},"/api/v2/fieldconfig":{"get":{"tags":["Organization","Groups","Users"],"summary":"Fetch field config for an entity type","description":"","operationId":"getFieldconfig","produces":["application/json"],"parameters":[{"name":"type","in":"query","description":"Field type","required":true,"type":"string","enum":["person","group","org","externalContact"],"x-genesys-enum-members":[{"name":"person"},{"name":"group"},{"name":"org"},{"name":"externalContact"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FieldConfig"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","bad.entity.type":"The entity type is invalid.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getFieldconfig"}},"/api/v2/languages/{languageId}":{"get":{"tags":["Languages"],"summary":"Get language (Deprecated)","description":"This endpoint is deprecated. It has been moved to /routing/languages/{languageId}","operationId":"getLanguage","produces":["application/json"],"parameters":[{"name":"languageId","in":"path","description":"Language ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Language"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:manage"]},"x-purecloud-method-name":"getLanguage"},"delete":{"tags":["Languages"],"summary":"Delete Language (Deprecated)","description":"This endpoint is deprecated. It has been moved to /routing/languages/{languageId}","operationId":"deleteLanguage","produces":["application/json"],"parameters":[{"name":"languageId","in":"path","description":"Language ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["routing"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:manage"]},"x-purecloud-method-name":"deleteLanguage"}},"/api/v2/outbound/campaigns/divisionviews":{"get":{"tags":["Outbound"],"summary":"Query a list of basic Campaign information objects","description":"This returns a simplified version of a Campaign, consisting of name and division.","operationId":"getOutboundCampaignsDivisionviews","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"],"x-genesys-enum-members":[{"name":"Equals"},{"name":"RegEx"},{"name":"Contains"},{"name":"Prefix"},{"name":"LessThan"},{"name":"LessThanEqualTo"},{"name":"GreaterThan"},{"name":"GreaterThanEqualTo"},{"name":"BeginsWith"},{"name":"EndsWith"}]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignDivisionViewListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:campaign:search"]},"x-purecloud-method-name":"getOutboundCampaignsDivisionviews"}},"/api/v2/coaching/notifications/{notificationId}":{"get":{"tags":["Coaching"],"summary":"Get an existing notification","description":"Permission not required if you are the owner of the notification.","operationId":"getCoachingNotification","produces":["application/json"],"parameters":[{"name":"notificationId","in":"path","description":"The ID of the notification.","required":true,"type":"string"},{"name":"expand","in":"query","description":"Indicates a field in the response which should be expanded.","required":false,"type":"array","items":{"type":"string","enum":["appointment"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"appointment"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CoachingNotification"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"notification.not.found":"The requested notification could not be found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","coaching:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:notification:view"]},"x-purecloud-method-name":"getCoachingNotification"},"patch":{"tags":["Coaching"],"summary":"Update an existing notification.","description":"Can only update your own notifications.","operationId":"patchCoachingNotification","produces":["application/json"],"parameters":[{"name":"notificationId","in":"path","description":"The ID of the notification.","required":true,"type":"string"},{"in":"body","name":"body","description":"Change the read state of a notification","required":true,"schema":{"$ref":"#/definitions/CoachingNotification"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CoachingNotification"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"The requested notification does not belong to this user."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"notification.not.found":"The requested notification could not be found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching"]}],"x-purecloud-method-name":"patchCoachingNotification"}},"/api/v2/telephony/providers/edges/{edgeId}/diagnostic/tracepath":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get networking-related information from an Edge for a target IP or host.","description":"","operationId":"getTelephonyProvidersEdgeDiagnosticTracepath","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge Id","required":true,"type":"string"}],"responses":{"200":{"description":"Request to get network diagnostic was successful.","schema":{"$ref":"#/definitions/EdgeNetworkDiagnosticResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"Request badly formed.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Couldn't find network diagnostic for given command","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgeDiagnosticTracepath"},"post":{"tags":["Telephony Providers Edge"],"summary":"Tracepath request command to collect networking-related information from an Edge for a target IP or host.","description":"","operationId":"postTelephonyProvidersEdgeDiagnosticTracepath","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge Id","required":true,"type":"string"},{"in":"body","name":"body","description":"request payload to get network diagnostic","required":true,"schema":{"$ref":"#/definitions/EdgeNetworkDiagnosticRequest"}}],"responses":{"202":{"description":"Request to get network diagnostic has been accepted","schema":{"$ref":"#/definitions/EdgeNetworkDiagnostic"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgeDiagnosticTracepath"}},"/api/v2/telephony/providers/edges/{edgeId}/diagnostic/nslookup":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get networking-related information from an Edge for a target IP or host.","description":"","operationId":"getTelephonyProvidersEdgeDiagnosticNslookup","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge Id","required":true,"type":"string"}],"responses":{"200":{"description":"Request to get network diagnostic was successful.","schema":{"$ref":"#/definitions/EdgeNetworkDiagnosticResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"Request is badly formed.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Couldn't find network diagnostic for given command","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgeDiagnosticNslookup"},"post":{"tags":["Telephony Providers Edge"],"summary":"Nslookup request command to collect networking-related information from an Edge for a target IP or host.","description":"","operationId":"postTelephonyProvidersEdgeDiagnosticNslookup","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge Id","required":true,"type":"string"},{"in":"body","name":"body","description":"request payload to get network diagnostic","required":true,"schema":{"$ref":"#/definitions/EdgeNetworkDiagnosticRequest"}}],"responses":{"202":{"description":"Request to get network diagnostic has been accepted","schema":{"$ref":"#/definitions/EdgeNetworkDiagnostic"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"Request is badly formed.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgeDiagnosticNslookup"}},"/api/v2/telephony/providers/edges/{edgeId}/diagnostic/route":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get networking-related information from an Edge for a target IP or host.","description":"","operationId":"getTelephonyProvidersEdgeDiagnosticRoute","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge Id","required":true,"type":"string"}],"responses":{"200":{"description":"Request to get network diagnostic was successful.","schema":{"$ref":"#/definitions/EdgeNetworkDiagnosticResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Couldn't find network diagnostic for given command","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgeDiagnosticRoute"},"post":{"tags":["Telephony Providers Edge"],"summary":"Route request command to collect networking-related information from an Edge for a target IP or host.","description":"","operationId":"postTelephonyProvidersEdgeDiagnosticRoute","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge Id","required":true,"type":"string"},{"in":"body","name":"body","description":"request payload to get network diagnostic","required":true,"schema":{"$ref":"#/definitions/EdgeNetworkDiagnosticRequest"}}],"responses":{"202":{"description":"Request to get network diagnostic has been accepted","schema":{"$ref":"#/definitions/EdgeNetworkDiagnostic"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgeDiagnosticRoute"}},"/api/v2/telephony/providers/edges/{edgeId}/diagnostic/ping":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get networking-related information from an Edge for a target IP or host.","description":"","operationId":"getTelephonyProvidersEdgeDiagnosticPing","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge Id","required":true,"type":"string"}],"responses":{"200":{"description":"Request to get network diagnostic was successful.","schema":{"$ref":"#/definitions/EdgeNetworkDiagnosticResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"Request is badly formed.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Couldn't find network diagnostic for given command","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgeDiagnosticPing"},"post":{"tags":["Telephony Providers Edge"],"summary":"Ping Request command to collect networking-related information from an Edge for a target IP or host.","description":"","operationId":"postTelephonyProvidersEdgeDiagnosticPing","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge Id","required":true,"type":"string"},{"in":"body","name":"body","description":"request payload to get network diagnostic","required":true,"schema":{"$ref":"#/definitions/EdgeNetworkDiagnosticRequest"}}],"responses":{"202":{"description":"Request to get network diagnostic has been accepted","schema":{"$ref":"#/definitions/EdgeNetworkDiagnostic"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgeDiagnosticPing"}},"/api/v2/outbound/campaigns/{campaignId}/stats":{"get":{"tags":["Outbound"],"summary":"Get statistics about a Dialer Campaign","description":"","operationId":"getOutboundCampaignStats","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignStats"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The dialer campaign was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:view"]},"x-purecloud-method-name":"getOutboundCampaignStats"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}":{"get":{"tags":["Knowledge"],"summary":"Get document","description":"","operationId":"getKnowledgeKnowledgebaseLanguageDocument","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","de-DE"],"x-genesys-enum-members":[{"name":"en-US"},{"name":"de-DE"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocument"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","input.validations":"Input parameters do not match the required criteria","kb.not.found":"Knowledge Base does not exist","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"404":"Resource code does not exist","not.found":"The requested resource was not found.","document.not.found":"Document does not exist"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseLanguageDocument"},"delete":{"tags":["Knowledge"],"summary":"Delete document","description":"","operationId":"deleteKnowledgeKnowledgebaseLanguageDocument","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","de-DE"],"x-genesys-enum-members":[{"name":"en-US"},{"name":"de-DE"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocument"}},"204":{"description":"Document deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","input.validations":"Input parameters do not match the required criteria","kb.not.found":"Knowledge Base does not exist"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"404":"Resource does not exist","not.found":"The requested resource was not found.","document.not.found":"Document does not exist"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:delete"]},"x-purecloud-method-name":"deleteKnowledgeKnowledgebaseLanguageDocument"},"patch":{"tags":["Knowledge"],"summary":"Update document","description":"","operationId":"patchKnowledgeKnowledgebaseLanguageDocument","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","de-DE"],"x-genesys-enum-members":[{"name":"en-US"},{"name":"de-DE"}]},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeDocumentRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocument"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","input.validations":"Input parameters do not match the required criteria","kb.not.found":"Knowledge Base does not exist","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"404":"Resource does not exist","not.found":"The requested resource was not found.","document.not.found":"Document does not exist"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:edit"]},"x-purecloud-method-name":"patchKnowledgeKnowledgebaseLanguageDocument"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/validate":{"post":{"tags":["Workforce Management"],"summary":"Validate Work Plan","description":"","operationId":"postWorkforcemanagementManagementunitWorkplanValidate","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"workPlanId","in":"path","description":"The ID of the work plan to validate. For new work plan, use the word 'new' for the ID.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/WorkPlanValidationRequest"}},{"name":"expand","in":"query","required":false,"type":"array","items":{"type":"string","enum":["messages"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"messages"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ValidateWorkPlanResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:workPlan:add","wfm:workPlan:edit"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitWorkplanValidate"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}":{"get":{"tags":["Workforce Management"],"summary":"Get a work plan","description":"","operationId":"getWorkforcemanagementManagementunitWorkplan","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"workPlanId","in":"path","description":"The ID of the work plan to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlan"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:workPlanRotation:view","wfm:workPlan:view","wfm:schedule:edit"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitWorkplan"},"delete":{"tags":["Workforce Management"],"summary":"Delete a work plan","description":"","operationId":"deleteWorkforcemanagementManagementunitWorkplan","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"workPlanId","in":"path","description":"The ID of the work plan to delete","required":true,"type":"string"}],"responses":{"204":{"description":"The work plan was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:workPlan:delete"]},"x-purecloud-method-name":"deleteWorkforcemanagementManagementunitWorkplan"},"patch":{"tags":["Workforce Management"],"summary":"Update a work plan","description":"","operationId":"patchWorkforcemanagementManagementunitWorkplan","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"workPlanId","in":"path","description":"The ID of the work plan to update","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/WorkPlan"}},{"name":"validationMode","in":"query","description":"Allows to update work plan even if validation result is invalid","required":false,"type":"string","enum":["Ignore"],"x-genesys-enum-members":[{"name":"Ignore"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlan"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Version of the request does not match the version on the backend"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:workPlan:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementManagementunitWorkplan"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans":{"get":{"tags":["Workforce Management"],"summary":"Get work plans","description":"","operationId":"getWorkforcemanagementManagementunitWorkplans","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"expand","in":"query","required":false,"type":"array","items":{"type":"string","enum":["agentCount","details"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"agentCount"},{"name":"details"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlanListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.server.error":"WFM Server Error","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agent:view","wfm:publishedSchedule:view","wfm:schedule:view","wfm:workPlanRotation:view","wfm:workPlan:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitWorkplans"},"post":{"tags":["Workforce Management"],"summary":"Create a new work plan","description":"","operationId":"postWorkforcemanagementManagementunitWorkplans","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/CreateWorkPlan"}},{"name":"validationMode","in":"query","description":"Allows to create work plan even if the validation result is invalid","required":false,"type":"string","enum":["Ignore"],"x-genesys-enum-members":[{"name":"Ignore"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlan"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:workPlan:add"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitWorkplans"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/copy":{"post":{"tags":["Workforce Management"],"summary":"Create a copy of work plan","description":"","operationId":"postWorkforcemanagementManagementunitWorkplanCopy","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"workPlanId","in":"path","description":"The ID of the work plan to create a copy","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/CopyWorkPlan"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlan"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"Name not specified or there is already a work plan with the name mentioned for copy","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:workPlan:add"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitWorkplanCopy"}},"/api/v2/conversations/messages":{"get":{"tags":["Conversations"],"summary":"Get active message conversations for the logged in user","description":"","operationId":"getConversationsMessages","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessageConversationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsMessages"},"post":{"tags":["Conversations"],"summary":"Create an outbound messaging conversation.","description":"If there is an existing conversation between the remote address and the address associated with the queue specified in createOutboundRequest then the result of this request depends on the state of that conversation and the useExistingConversation field of createOutboundRequest. If the existing conversation is in alerting or connected state, then the request will fail. If the existing conversation is disconnected but still within the conversation window then the request will fail unless useExistingConversation is set to true.","operationId":"postConversationsMessages","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Create outbound messaging conversation","required":true,"schema":{"$ref":"#/definitions/CreateOutboundMessagingConversationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessageConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.phone.numbers":"SMS phone number addresses are not in a valid E.164 format.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.phone.number":"The SMS phone number address is not a valid E.164 format.","queue.address.required":"The queue does not have an outbound messaging address configured.","active.conversation":"An alerting or connected conversation is already in progress.","queue.membership.required":"Queue membership is invalid.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","existing.conversation":"An existing conversation within the conversation window is in progress."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["conversation:message:create"]},"x-purecloud-method-name":"postConversationsMessages"}},"/api/v2/conversations/messages/{conversationId}/participants/{participantId}/wrapupcodes":{"get":{"tags":["Conversations"],"summary":"Get list of wrapup codes for this conversation participant","description":"","operationId":"getConversationsMessageParticipantWrapupcodes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":" conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsMessageParticipantWrapupcodes"}},"/api/v2/conversations/messages/{conversationId}/participants/{participantId}/attributes":{"patch":{"tags":["Conversations"],"summary":"Update the attributes on a conversation participant.","description":"","operationId":"patchConversationsMessageParticipantAttributes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":" conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ParticipantAttributes"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsMessageParticipantAttributes"}},"/api/v2/conversations/messages/{conversationId}":{"get":{"tags":["Conversations"],"summary":"Get message conversation","description":"","operationId":"getConversationsMessage","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessageConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsMessage"},"patch":{"tags":["Conversations"],"summary":"Update a conversation by disconnecting all of the participants","description":"","operationId":"patchConversationsMessage","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation","required":true,"schema":{"$ref":"#/definitions/Conversation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Conversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:disconnect"]},"x-purecloud-method-name":"patchConversationsMessage"}},"/api/v2/conversations/messages/{conversationId}/participants/{participantId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation participant. ","description":"","operationId":"getConversationsMessageParticipantWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsMessageParticipantWrapup"}},"/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages":{"post":{"tags":["Conversations"],"summary":"Send message","description":"Send message on existing conversation/communication. Only one message body field can be accepted, per request. Example: 1 textBody, 1 mediaId, 1 stickerId, or 1 messageTemplate.","operationId":"postConversationsMessageCommunicationMessages","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Message","required":true,"schema":{"$ref":"#/definitions/AdditionalMessage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessageData"}},"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"max.length.exceeded":"One or more attributes is longer than the maximum length allowed.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","not.found":"Message not found.","media.too.large":"Media must comply with the size limits of the channel","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","chat.error":"Server error handing chat."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["conversation:message:create"]},"x-purecloud-method-name":"postConversationsMessageCommunicationMessages"}},"/api/v2/conversations/messages/{conversationId}/messages/bulk":{"post":{"tags":["Conversations"],"summary":"Get messages in batch","description":"The path parameter [conversationId] should contain the conversationId of the conversation being filtered. The body should contain the messageId(s) of messages being requested. For example: [\"a3069a33b-bbb1-4703-9d68-061d9e9db96e\", \"55bc6be3-078c-4a49-a4e6-1e05776ed7e8\"]","operationId":"postConversationsMessageMessagesBulk","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","description":"messageIds","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TextMessageListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:message:view"]},"x-purecloud-method-name":"postConversationsMessageMessagesBulk"}},"/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages/media":{"post":{"tags":["Conversations"],"summary":"Create media","description":"","operationId":"postConversationsMessageCommunicationMessagesMedia","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessageMediaData"}},"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["conversation:message:create"]},"x-purecloud-method-name":"postConversationsMessageCommunicationMessagesMedia"}},"/api/v2/conversations/messages/agentless":{"post":{"tags":["Conversations"],"summary":"Send an agentless outbound message","description":"Send an agentlesss (api participant) outbound message using a client credential grant. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will generate a new Conversation, if there is an existing active Conversation between the fromAddress and toAddress already, then this POST will fail.","operationId":"postConversationsMessagesAgentless","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Create agentless outbound messaging request","required":true,"schema":{"$ref":"#/definitions/SendAgentlessOutboundMessageRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SendAgentlessOutboundMessageResponse"}},"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"max.length.exceeded":"One or more attributes is longer than the maximum length allowed.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","not.a.client":"This request requires a non-user context. User token cannot be used for requests to this resource.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["conversation:message:create"]},"x-purecloud-method-name":"postConversationsMessagesAgentless"}},"/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages/media/{mediaId}":{"get":{"tags":["Conversations"],"summary":"Get media","description":"","operationId":"getConversationsMessageCommunicationMessagesMediaMediaId","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"name":"mediaId","in":"path","description":"mediaId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessageMediaData"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:message:view"]},"x-purecloud-method-name":"getConversationsMessageCommunicationMessagesMediaMediaId"}},"/api/v2/conversations/messages/{conversationId}/participants/{participantId}/communications/{communicationId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant's communication by disconnecting it.","description":"","operationId":"patchConversationsMessageParticipantCommunication","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":" conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"communication.state.required":"Can only update a communication's state to disconnected.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsMessageParticipantCommunication"}},"/api/v2/conversations/messages/{conversationId}/participants/{participantId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant","description":"","operationId":"patchConversationsMessageParticipant","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":" conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.participant.update.invalid":"Failed to update all properties on conversation participant.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","conversation.error.participant.no.active.conversations":"Participant has no active conversations"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.participant.update.failed":"Failed to update all properties on conversation participant.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsMessageParticipant"}},"/api/v2/conversations/messages/{conversationId}/participants/{participantId}/replace":{"post":{"tags":["Conversations"],"summary":"Replace this participant with the specified user and/or address","description":"","operationId":"postConversationsMessageParticipantReplace","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Transfer request","required":true,"schema":{"$ref":"#/definitions/TransferRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","conversations.error.queue.not.found":"Interaction cannot be transferred to a queue that does not exist.","conversations.error.transfer.not.connected":"You can only transfer conversations that are in the connected state.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationsMessageParticipantReplace"}},"/api/v2/conversations/messages/{conversationId}/messages/{messageId}":{"get":{"tags":["Conversations"],"summary":"Get message","description":"","operationId":"getConversationsMessageMessage","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"messageId","in":"path","description":"messageId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessageData"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:message:view"]},"x-purecloud-method-name":"getConversationsMessageMessage"}},"/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/progress":{"get":{"tags":["Outbound"],"summary":"Get messaging campaign's progress","description":"","operationId":"getOutboundMessagingcampaignProgress","produces":["application/json"],"parameters":[{"name":"messagingCampaignId","in":"path","description":"The Messaging Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignProgress"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The messaging campaign was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaign:view"]},"x-purecloud-method-name":"getOutboundMessagingcampaignProgress"}},"/api/v2/outbound/messagingcampaigns/{messagingCampaignId}":{"get":{"tags":["Outbound"],"summary":"Get an Outbound Messaging Campaign","description":"","operationId":"getOutboundMessagingcampaign","produces":["application/json"],"parameters":[{"name":"messagingCampaignId","in":"path","description":"The Messaging Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingCampaign"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The resource could not be found.","resource.not.found":"Specified campaignId was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaign:view"]},"x-purecloud-method-name":"getOutboundMessagingcampaign"},"put":{"tags":["Outbound"],"summary":"Update an Outbound Messaging Campaign","description":"","operationId":"putOutboundMessagingcampaign","produces":["application/json"],"parameters":[{"name":"messagingCampaignId","in":"path","description":"The Messaging Campaign ID","required":true,"type":"string"},{"in":"body","name":"body","description":"MessagingCampaign","required":true,"schema":{"$ref":"#/definitions/MessagingCampaign"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingCampaign"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.length.exceeded":"The name length exceeds the limit of 64 characters","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name is in use by another messaging campaign","callable.time.set.not.found":"The callable time set could not be found","contact.list.not.found":"The contact list could not be found","invalid.callable.time.set":"The provided callable time set is invalid","invalid.messages.per.minute":"Messages per minute must be provided, and must be an integer between 1 and the maximum allowable messages per minute (see documentation)","invalid.sender.sms.phone.number":"The sender sms phone number must be provided, and must be a valid reference to a short-code or non-NANP mobile or local SMS phone number","invalid.update":"An attempt was made to update a messaging campaign in an invalid way. See details","invalid.phone.column":"The phone column must be provided, and must be a valid column on the selected contact list","invalid.name":"A name must be provided","sms.content.template.not.found":"The Content template could not be found","another.campaign.starting":"There is another campaign already in the process of transitioning to on. Once it has transitioned fully then you will be allowed to turn another campaign on.","invalid.contact.list":"A valid contact list must be provided","contact.sort.duplicate.field.names":"Multiple Contact Sorts may not be applied to the same field","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","contact.sort.size.exceeded":"A maximum of 4 Contact Sorts may be configured","dnc.list.not.found":"One or more dnc lists could not be found","invalid.message.column":"The message column must be provided, and must be a valid column on the selected contact list","invalid.sms.content.template.responsetype":"The responseType of content template is not valid. It must be CampaignSmsTemplate","contact.sort.field.not.found":"One or more contact sort fields are not valid contact list columns","invalid.sms.config.message":"Only one of the messaging options should be set - messageColumn or contentTemplateId","dnc.list.count.exceeded":"A maximum of 10 dnc lists may be configured","simultaneous.field.and.status.update":"A Messaging Campaign cannot have other fields changed in the same update as a status transition","invalid.status.transition":"The campaign status transition is invalid","invalid.sms.content.template.contentType":"The contentType of content template is not valid. It must be text/plain","sms.phone.number.in.use":"The SMS phone number is in use by another messaging campaign","invalid.dnc.list":"One or more DNC List references are invalid","invalid.division":"A valid division must be provided","callable.time.set.conflicts.with.automatic.time.zone.mapping":"A callable time set cannot be included on the campaign when the campaign's contact list uses automatic time zone mapping.","too.many.messages.per.minute.requested":"The total number of messages per minute for this organization would be exceeded by turning this campaign on (see documentation)","sms.phone.number.not.found":"The SMS phone number could not be found","sms.content.template.not.authorized":"User doesn't have authorization to access content template","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","missing.time.zone.in.contactlist":"When using a callable time set, the contact list must have at least one time zone column defined.","contact.list.import.in.progress":"The contact list is still importing contacts","invalid.type.config":"Exactly one of [smsConfig] must be provided","contact.list.in.use":"The contact list is in use by another messaging campaign","invalid.sms.content.template.content":"The content of content template is blank"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The messaging campaign could not be found"}},"409":{"description":"Conflict.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"version.conflict":"Unexpected messaging campaign version"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaign:edit"]},"x-purecloud-method-name":"putOutboundMessagingcampaign"},"delete":{"tags":["Outbound"],"summary":"Delete an Outbound Messaging Campaign","description":"","operationId":"deleteOutboundMessagingcampaign","produces":["application/json"],"parameters":[{"name":"messagingCampaignId","in":"path","description":"The Messaging Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingCampaign"}},"204":{"description":"Messaging Campaign Deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.delete":"An attempt was made to delete a messaging campaign in an invalid way. See details","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","cannot.delete.running.campaign":"A messaging campaign in status ON or STOPPING cannot be deleted"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:delete"]},"x-purecloud-method-name":"deleteOutboundMessagingcampaign"}},"/api/v2/flows/datatables/{datatableId}/rows":{"get":{"tags":["Architect"],"summary":"Returns the rows for the datatable with the given id","description":"Returns all of the rows for the datatable with the given datatableId. By default this will just be a truncated list returning the key for each row. Set showBrief to false to return all of the row contents.","operationId":"getFlowsDatatableRows","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"showbrief","in":"query","description":"If true returns just the key value of the row","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataTableRowEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","flows.datatables.syntax.error":"There was an error parsing user data","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.table.not.found":"The datatable could not be found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:view"]},"x-purecloud-method-name":"getFlowsDatatableRows"},"post":{"tags":["Architect"],"summary":"Create a new row entry for the datatable.","description":"Will add the passed in row entry to the datatable with the given datatableId after verifying it against the schema. The DataTableRow should be a json-ized' stream of key -> value pairs\n{ \n \"Field1\": \"XYZZY\", \n \"Field2\": false, \n \"KEY\": \"27272\" \n}","operationId":"postFlowsDatatableRows","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"in":"body","name":"dataTableRow","required":true,"schema":{"type":"object","additionalProperties":{"type":"object"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.schema.exception":"The row didn't conform to the schema in some way","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","flows.datatables.too.many.rows":"The max number of datatable rows allowed has been reached.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","flows.datatables.syntax.error":"There was an error parsing user data","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.table.not.found":"The datatable could not be found.","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.not.unique":"The row had a duplicate keyname."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:add"]},"x-purecloud-method-name":"postFlowsDatatableRows"}},"/api/v2/analytics/queues/observations/query":{"post":{"tags":["Routing","Analytics"],"summary":"Query for queue observations","description":"","operationId":"postAnalyticsQueuesObservationsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/QueueObservationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueObservationQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"This user is not permitted to query for queue.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"An internal server error has occurred."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:queueObservation:view"]},"x-purecloud-method-name":"postAnalyticsQueuesObservationsQuery"}},"/api/v2/identityproviders/okta":{"get":{"tags":["Identity Provider"],"summary":"Get Okta Identity Provider","description":"","operationId":"getIdentityprovidersOkta","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Okta"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersOkta"},"put":{"tags":["Identity Provider"],"summary":"Update/Create Okta Identity Provider","description":"","operationId":"putIdentityprovidersOkta","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/Okta"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.issuer.uri":"An issuer URI is required.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.target.url":"The target URL must be a valid HTTPS URL.","certificate.not.yet.valid":"The certificate is not yet valid.","certificate.invalid.base64":"Invalid base64 in certificate.","certificate.unparseable":"The certificate for provider cannot be parsed.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersOkta"},"delete":{"tags":["Identity Provider"],"summary":"Delete Okta Identity Provider","description":"","operationId":"deleteIdentityprovidersOkta","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersOkta"}},"/api/v2/scim/v2/schemas":{"get":{"tags":["SCIM"],"summary":"Get a list of SCIM schemas","description":"","operationId":"getScimV2Schemas","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"name":"filter","in":"query","description":"Filtered results are invalid and return 403 Unauthorized.","required":false,"type":"string","x-example":"displayName eq groupName"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2SchemaListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimV2Schemas"}},"/api/v2/scim/v2/schemas/{schemaId}":{"get":{"tags":["SCIM"],"summary":"Get a SCIM schema","description":"","operationId":"getScimV2Schema","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"name":"schemaId","in":"path","description":"The ID of a schema. Returned with GET /api/v2/scim/v2/schemas.","required":true,"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:core:2.0:Group","urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig","urn:ietf:params:scim:schemas:core:2.0:ResourceType","urn:ietf:params:scim:schemas:core:2.0:Schema","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User"],"x-genesys-enum-members":[{"name":"urn:ietf:params:scim:schemas:core:2.0:User"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group"},{"name":"urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig"},{"name":"urn:ietf:params:scim:schemas:core:2.0:ResourceType"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Schema"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2SchemaDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimV2Schema"}},"/api/v2/contentmanagement/status":{"get":{"tags":["Content Management"],"summary":"Get a list of statuses for pending operations","description":"","operationId":"getContentmanagementStatus","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CommandStatusEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementStatus"}},"/api/v2/routing/sms/addresses":{"get":{"tags":["Routing"],"summary":"Get a list of Addresses for SMS","description":"","operationId":"getRoutingSmsAddresses","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SmsAddressEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:view"]},"x-purecloud-method-name":"getRoutingSmsAddresses"},"post":{"tags":["Routing"],"summary":"Provision an Address for SMS","description":"","operationId":"postRoutingSmsAddresses","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"SmsAddress","required":true,"schema":{"$ref":"#/definitions/SmsAddressProvision"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SmsAddress"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.address":"The address you have provided cannot be validated. This may be due to spelling error or that the address is not available in a third-party data source for validation.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:add"]},"x-purecloud-method-name":"postRoutingSmsAddresses"}},"/api/v2/telephony/providers/edges/linebasesettings/{lineBaseId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a line base settings object by ID","description":"","operationId":"getTelephonyProvidersEdgesLinebasesetting","produces":["application/json"],"parameters":[{"name":"lineBaseId","in":"path","description":"Line base ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LineBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a line with that id","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesLinebasesetting"}},"/api/v2/languageunderstanding/domains":{"get":{"tags":["Language Understanding"],"summary":"Get all NLU Domains.","description":"","operationId":"getLanguageunderstandingDomains","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluDomainListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","dialog:readonly","language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomain:view","dialog:bot:view"]},"x-purecloud-method-name":"getLanguageunderstandingDomains"},"post":{"tags":["Language Understanding"],"summary":"Create an NLU Domain.","description":"","operationId":"postLanguageunderstandingDomains","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The NLU Domain to create.","required":true,"schema":{"$ref":"#/definitions/NluDomain"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluDomain"}},"201":{"description":"","schema":{"$ref":"#/definitions/NluDomain"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","language-understanding"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomain:add","dialog:bot:add"]},"x-purecloud-method-name":"postLanguageunderstandingDomains"}},"/api/v2/outbound/callabletimesets/{callableTimeSetId}":{"get":{"tags":["Outbound"],"summary":"Get callable time set","description":"","operationId":"getOutboundCallabletimeset","produces":["application/json"],"parameters":[{"name":"callableTimeSetId","in":"path","description":"Callable Time Set ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallableTimeSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:callableTimeSet:view"]},"x-purecloud-method-name":"getOutboundCallabletimeset"},"put":{"tags":["Outbound"],"summary":"Update callable time set","description":"","operationId":"putOutboundCallabletimeset","produces":["application/json"],"parameters":[{"name":"callableTimeSetId","in":"path","description":"Callable Time Set ID","required":true,"type":"string"},{"in":"body","name":"body","description":"DialerCallableTimeSet","required":true,"schema":{"$ref":"#/definitions/CallableTimeSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallableTimeSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update":"","name.cannot.be.blank":"A name must be provided.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","duplicate.name":"The name already exists.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.start.time":"Start time must be before stop time.","invalid.time.zone":"Not recognized as a valid time zone.","missing.time.zone":"Each callable time must have a time zone identifier.","invalid.day":"Days must be within 1 - 7.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.wrong.version":""}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:callableTimeSet:edit"]},"x-purecloud-method-name":"putOutboundCallabletimeset"},"delete":{"tags":["Outbound"],"summary":"Delete callable time set","description":"","operationId":"deleteOutboundCallabletimeset","produces":["application/json"],"parameters":[{"name":"callableTimeSetId","in":"path","description":"Callable Time Set ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","referential.integrity.error":"Could not delete the resource because it is referenced by another entity.","callable.time.set.in.use":"The callable time set is in use."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:callableTimeSet:delete"]},"x-purecloud-method-name":"deleteOutboundCallabletimeset"}},"/api/v2/users/presences/bulk":{"put":{"tags":["Presence"],"summary":"Update bulk user Presences","description":"","operationId":"putUsersPresencesBulk","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"List of User presences","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/UserPresence"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/UserPresence"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","max user presences":"Only 50 user presences can be updated at a time.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence","presence:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:edit"]},"x-purecloud-method-name":"putUsersPresencesBulk"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}":{"get":{"tags":["Workforce Management"],"summary":"Deprecated. Use the equivalent business unit resource instead. Get a week schedule","description":"","operationId":"getWorkforcemanagementManagementunitWeekSchedule","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format.","required":true,"type":"string"},{"name":"scheduleId","in":"path","description":"The ID of the schedule to fetch","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"string","enum":["generationResults","headcountForecast"],"x-genesys-enum-members":[{"name":"generationResults"},{"name":"headcountForecast"}]},{"name":"forceDownloadService","in":"query","description":"Force the result of this operation to be sent via download service. For testing/app development purposes","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WeekScheduleResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:publishedSchedule:view","wfm:schedule:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitWeekSchedule"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules":{"get":{"tags":["Workforce Management"],"summary":"Deprecated. Use the equivalent business unit resource instead. Get the list of schedules in a week in management unit","description":"","operationId":"getWorkforcemanagementManagementunitWeekSchedules","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format.","required":true,"type":"string"},{"name":"includeOnlyPublished","in":"query","description":"Return only published schedules","required":false,"type":"boolean"},{"name":"earliestWeekDate","in":"query","description":"The start date of the earliest week to query in yyyy-MM-dd format","required":false,"type":"string"},{"name":"latestWeekDate","in":"query","description":"The start date of the latest week to query in yyyy-MM-dd format","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WeekScheduleListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:publishedSchedule:view","wfm:schedule:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitWeekSchedules"}},"/api/v2/orgauthorization/trustor/audits":{"post":{"tags":["Organization Authorization"],"summary":"Get Org Trustor Audits","description":"","operationId":"postOrgauthorizationTrustorAudits","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"timestamp"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"descending"},{"in":"body","name":"body","description":"Values to scope the request.","required":true,"schema":{"$ref":"#/definitions/TrustorAuditQueryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuditQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:audit:view"]},"x-purecloud-method-name":"postOrgauthorizationTrustorAudits"}},"/api/v2/externalcontacts/organizations/schemas/{schemaId}":{"get":{"tags":["External Contacts"],"summary":"Get a schema","description":"","operationId":"getExternalcontactsOrganizationsSchema","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getExternalcontactsOrganizationsSchema"},"put":{"tags":["External Contacts"],"summary":"Update a schema","description":"","operationId":"putExternalcontactsOrganizationsSchema","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Data Schema","required":true,"schema":{"$ref":"#/definitions/DataSchema"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.limit.max.number.of.fields.per.org.would.be.exceeded":"The total number of fields defined for all schemas cannot exceed 500.","dynamic.schema.validation.limit.error":"The new JSON schema provided for update has a validation limit error.","dynamic.schema.limit.max.number.of.schemas.per.org.would.be.exceeded":"There cannot be more than 20 schemas.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","dynamic.schema.incompatible.json.schema.update":"The JSON schema provided for update is incompatible with the previous version.","dynamic.schema.limit.max.number.of.characters.for.field.name.would.be.exceeded":"A field name cannot exceed 100 characters","dynamic.schema.validation.limit.missing":"The new JSON schema provided for update is missing a validation limit.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","dynamic.schema.invalid.json.schema":"An invalid JSON schema was provided.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","dynamic.schema.limit.max.number.of.fields.per.schema.would.be.exceeded":"A schema cannot have more than 25 fields"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.version.conflict":"A valid version is required."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"Unable to expand the schema."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:edit"]},"x-purecloud-method-name":"putExternalcontactsOrganizationsSchema"}},"/api/v2/integrations/speech/dialogflow/agents/{agentId}":{"get":{"tags":["Integrations"],"summary":"Get details about a Dialogflow agent","description":"","operationId":"getIntegrationsSpeechDialogflowAgent","produces":["application/json"],"parameters":[{"name":"agentId","in":"path","description":"The agent ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DialogflowAgent"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechDialogflowAgent"}},"/api/v2/routing/email/domains":{"get":{"tags":["Routing"],"summary":"Get domains","description":"","operationId":"getRoutingEmailDomains","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundDomainEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.request.timeout":"Get domains request timed out.","authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"getRoutingEmailDomains"},"post":{"tags":["Routing"],"summary":"Create a domain","description":"","operationId":"postRoutingEmailDomains","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Domain","required":true,"schema":{"$ref":"#/definitions/InboundDomain"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundDomain"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.integration.connection":"Unable to connect with the specified integration.","email.error.integration.ssl":"There was a problem with opening a SSL socket to the integration.","postino.domain.exists":"The inbound domain already exists.","postino.max.domains.exceeded":"The maximum number of domains for the org has been exceeded.","email.error.integration.authentication":"Unable to authenticate with the specified integration.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","email.error.invalid.integration":"An invalid integration ID was specified.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","postino.invalid.domain.name":"The 'domain' field contains some illegal characters.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","email.error.integration.host":"The specified integration has a bad host."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.integration.timeout":"There was a timeout connecting to the integration.","authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"postRoutingEmailDomains"}},"/api/v2/timezones":{"get":{"tags":["Utilities"],"summary":"Get time zones list","description":"","operationId":"getTimezones","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeZoneEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":[]}],"x-purecloud-method-name":"getTimezones"}},"/api/v2/orgauthorization/trustors":{"get":{"tags":["Organization Authorization"],"summary":"The list of organizations that have authorized/trusted your organization.","description":"","operationId":"getOrgauthorizationTrustors","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustorEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrustor:view"]},"x-purecloud-method-name":"getOrgauthorizationTrustors"}},"/api/v2/outbound/callabletimesets":{"get":{"tags":["Outbound"],"summary":"Query callable time set list","description":"","operationId":"getOutboundCallabletimesets","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"allowEmptyResult","in":"query","description":"Whether to return an empty page when there are no results for that page","required":false,"type":"boolean","default":false},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"],"x-genesys-enum-members":[{"name":"Equals"},{"name":"RegEx"},{"name":"Contains"},{"name":"Prefix"},{"name":"LessThan"},{"name":"LessThanEqualTo"},{"name":"GreaterThan"},{"name":"GreaterThanEqualTo"},{"name":"BeginsWith"},{"name":"EndsWith"}]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallableTimeSetEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:callableTimeSet:view"]},"x-purecloud-method-name":"getOutboundCallabletimesets"},"post":{"tags":["Outbound"],"summary":"Create callable time set","description":"","operationId":"postOutboundCallabletimesets","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"DialerCallableTimeSet","required":true,"schema":{"$ref":"#/definitions/CallableTimeSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallableTimeSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","invalid.create":"","invalid.time.zone":"There is an unrecognized time zone.","missing.time.zone":"Each callable time must have a time zone identifier.","max.entity.count.reached":"The maximum callable time set count has been reached.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.start.time":"Start time must be before stop time.","invalid.day":"Days must be within 1 - 7.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:callableTimeSet:add"]},"x-purecloud-method-name":"postOutboundCallabletimesets"}},"/api/v2/architect/systemprompts/{promptId}/resources/{languageCode}":{"get":{"tags":["Architect"],"summary":"Get a system prompt resource.","description":"","operationId":"getArchitectSystempromptResource","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SystemPromptAsset"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.system.prompt.resource.not.found":"Could not find resource with specified language in specified system prompt.","architect.system.prompt.not.found":"Could not find system prompt with specified ID.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:systemPrompt:view"]},"x-purecloud-method-name":"getArchitectSystempromptResource"},"put":{"tags":["Architect"],"summary":"Updates a system prompt resource override.","description":"","operationId":"putArchitectSystempromptResource","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/SystemPromptAsset"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SystemPromptAsset"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.resource.invalid.tags":"The specified tags are in an invalid format.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","architect.object.validate.failed":"Failed to validate object.","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.system.prompt.resource.override.not.found":"Could not find resource override with specified language in specified system prompt.","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.resource.tags.already.exist":"The specified tags already exist in another prompt resource."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.object.update.failed":"The database update for the object failed.","architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:systemPrompt:edit"]},"x-purecloud-method-name":"putArchitectSystempromptResource"},"delete":{"tags":["Architect"],"summary":"Delete a system prompt resource override.","description":"","operationId":"deleteArchitectSystempromptResource","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.system.prompt.resource.cannot.delete.default":"Cannot delete the default resource for the specified language as that would leave that language without a default resource."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:systemPrompt:edit"]},"x-purecloud-method-name":"deleteArchitectSystempromptResource"}},"/api/v2/analytics/conversations/details/jobs/availability":{"get":{"tags":["Conversations","Analytics"],"summary":"Lookup the datalake availability date and time","description":"","operationId":"getAnalyticsConversationsDetailsJobsAvailability","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataAvailabilityResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationDetail:view"]},"x-purecloud-method-name":"getAnalyticsConversationsDetailsJobsAvailability"}},"/api/v2/analytics/conversations/{conversationId}/details/properties":{"post":{"tags":["Conversations","Analytics"],"summary":"Index conversation properties","description":"","operationId":"postAnalyticsConversationDetailsProperties","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"request","required":true,"schema":{"$ref":"#/definitions/PropertyIndexRequest"}}],"responses":{"202":{"description":"Accepted - Indexing properties","schema":{"$ref":"#/definitions/PropertyIndexRequest"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationProperties:index"]},"x-purecloud-method-name":"postAnalyticsConversationDetailsProperties"}},"/api/v2/analytics/conversations/details/query":{"post":{"tags":["Conversations","Analytics"],"summary":"Query for conversation details","description":"","operationId":"postAnalyticsConversationsDetailsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/ConversationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AnalyticsConversationQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","payload.too.large":"The response payload was too large.","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"An internal server error has occurred."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationDetail:view"]},"x-purecloud-method-name":"postAnalyticsConversationsDetailsQuery"}},"/api/v2/analytics/conversations/details":{"get":{"tags":["Conversations","Analytics"],"summary":"Gets multiple conversations by id","description":"","operationId":"getAnalyticsConversationsDetails","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"Comma-separated conversation ids","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AnalyticsConversationWithoutAttributesMultiGetResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationDetail:view"]},"x-purecloud-method-name":"getAnalyticsConversationsDetails"}},"/api/v2/analytics/conversations/aggregates/query":{"post":{"tags":["Conversations","Analytics"],"summary":"Query for conversation aggregates","description":"","operationId":"postAnalyticsConversationsAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/ConversationAggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConversationAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"An internal server error has occurred."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationAggregate:view"]},"x-purecloud-method-name":"postAnalyticsConversationsAggregatesQuery"}},"/api/v2/analytics/conversations/details/jobs":{"post":{"tags":["Conversations","Analytics"],"summary":"Query for conversation details asynchronously","description":"","operationId":"postAnalyticsConversationsDetailsJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/AsyncConversationQuery"}}],"responses":{"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationDetail:view"]},"x-purecloud-method-name":"postAnalyticsConversationsDetailsJobs"}},"/api/v2/analytics/conversations/details/jobs/{jobId}":{"get":{"tags":["Conversations","Analytics"],"summary":"Get status for async query for conversation details","description":"","operationId":"getAnalyticsConversationsDetailsJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationDetail:view"]},"x-purecloud-method-name":"getAnalyticsConversationsDetailsJob"},"delete":{"tags":["Conversations","Analytics"],"summary":"Delete/cancel an async request","description":"","operationId":"deleteAnalyticsConversationsDetailsJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"204":{"description":"Deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationDetail:view"]},"x-purecloud-method-name":"deleteAnalyticsConversationsDetailsJob"}},"/api/v2/analytics/conversations/details/jobs/{jobId}/results":{"get":{"tags":["Conversations","Analytics"],"summary":"Fetch a page of results for an async query","description":"","operationId":"getAnalyticsConversationsDetailsJobResults","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"},{"name":"cursor","in":"query","description":"Indicates where to resume query results (not required for first page)","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"The desired maximum number of results","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AnalyticsConversationAsyncQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationDetail:view"]},"x-purecloud-method-name":"getAnalyticsConversationsDetailsJobResults"}},"/api/v2/analytics/conversations/{conversationId}/details":{"get":{"tags":["Conversations","Analytics"],"summary":"Get a conversation by id","description":"","operationId":"getAnalyticsConversationDetails","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AnalyticsConversationWithoutAttributes"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationDetail:view"]},"x-purecloud-method-name":"getAnalyticsConversationDetails"}},"/api/v2/authorization/divisions/{divisionId}":{"get":{"tags":["Authorization","Objects"],"summary":"Returns an authorization division.","description":"","operationId":"getAuthorizationDivision","produces":["application/json"],"parameters":[{"name":"divisionId","in":"path","description":"Division ID","required":true,"type":"string"},{"name":"objectCount","in":"query","description":"Get count of objects in this division, grouped by type","required":false,"type":"boolean","default":false,"enum":["true","false"],"x-genesys-enum-members":[{"name":"true"},{"name":"false"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuthzDivision"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-purecloud-method-name":"getAuthorizationDivision"},"put":{"tags":["Authorization","Objects"],"summary":"Update a division.","description":"","operationId":"putAuthorizationDivision","produces":["application/json"],"parameters":[{"name":"divisionId","in":"path","description":"Division ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Updated division data","required":true,"schema":{"$ref":"#/definitions/AuthzDivision"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuthzDivision"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:division:edit"]},"x-purecloud-method-name":"putAuthorizationDivision"},"delete":{"tags":["Authorization","Objects"],"summary":"Delete a division.","description":"","operationId":"deleteAuthorizationDivision","produces":["application/json"],"parameters":[{"name":"divisionId","in":"path","description":"Division ID","required":true,"type":"string"},{"name":"force","in":"query","description":"Force delete this division as well as the grants and objects associated with it","required":false,"type":"boolean","default":false}],"responses":{"204":{"description":"Deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"precondition.failure":"One or more preconditions was not met.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:division:delete"]},"x-purecloud-method-name":"deleteAuthorizationDivision"}},"/api/v2/authorization/divisions/{divisionId}/objects/{objectType}":{"post":{"tags":["Authorization","Objects"],"summary":"Assign a list of objects to a division","description":"Set the division of a specified list of objects. The objects must all be of the same type, one of: \nCAMPAIGN, MANAGEMENTUNIT, FLOW, QUEUE, or USER. \nThe body of the request is a list of object IDs, which are expected to be \nGUIDs, e.g. [\"206ce31f-61ec-40ed-a8b1-be6f06303998\",\"250a754e-f5e4-4f51-800f-a92f09d3bf8c\"]","operationId":"postAuthorizationDivisionObject","produces":["application/json"],"parameters":[{"name":"divisionId","in":"path","description":"Division ID","required":true,"type":"string"},{"name":"objectType","in":"path","description":"The type of the objects. Must be one of the valid object types","required":true,"type":"string","enum":["QUEUE","CAMPAIGN","CONTACTLIST","DNCLIST","MESSAGINGCAMPAIGN","MANAGEMENTUNIT","BUSINESSUNIT","FLOW","USER"],"x-genesys-enum-members":[{"name":"QUEUE"},{"name":"CAMPAIGN"},{"name":"CONTACTLIST"},{"name":"DNCLIST"},{"name":"MESSAGINGCAMPAIGN"},{"name":"MANAGEMENTUNIT"},{"name":"BUSINESSUNIT"},{"name":"FLOW"},{"name":"USER"}]},{"in":"body","name":"body","description":"Object Id List","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"204":{"description":"The divisions were updated successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","too.many.bulk.division.updates":"Unable to move objects because the request contained too many objects","empty.bulk.division.update":"Unable to move object because the request contained an empty object.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bulk.move.no.permission.division":"Unable to move object(s) because the requesting user does not have edit permission in the destination division","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.units.not.found":"One or more requested management units were not found","wfm.business.units.not.found":"One or more requested business units were not found","general.resource.not.found":"Requested resource is not available.","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bulk.move.unable.to.move":"One or more of the object(s) failed to be moved to the destination division"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed","bulk.move.permission.check.error":"Failed to check permissions in one or more of the divisions in the request","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-purecloud-method-name":"postAuthorizationDivisionObject"}},"/api/v2/alerting/interactionstats/rules":{"get":{"tags":["Alerting"],"summary":"Get an interaction stats rule list.","description":"","operationId":"getAlertingInteractionstatsRules","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["notificationUsers"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"notificationUsers"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InteractionStatsRuleContainer"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting","alerting:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:rule:view"]},"x-purecloud-method-name":"getAlertingInteractionstatsRules"},"post":{"tags":["Alerting"],"summary":"Create an interaction stats rule.","description":"","operationId":"postAlertingInteractionstatsRules","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["notificationUsers"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"notificationUsers"}]},{"in":"body","name":"body","description":"AlertingRule","required":true,"schema":{"$ref":"#/definitions/InteractionStatsRule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InteractionStatsRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:rule:add"]},"x-purecloud-method-name":"postAlertingInteractionstatsRules"}},"/api/v2/outbound/contactlists/{contactListId}/export":{"get":{"tags":["Outbound"],"summary":"Get the URI of a contact list export.","description":"","operationId":"getOutboundContactlistExport","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"ContactList ID","required":true,"type":"string"},{"name":"download","in":"query","description":"Redirect to download uri","required":false,"type":"string","default":"false"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExportUri"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","exports.black.listed":"This organization has been prohibited from exporting contact lists. Please contact support.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","no.available.list.export.uri":"There is no available download URI for contact list at this time.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:contact:view","outbound:contactList:view"]},"x-purecloud-method-name":"getOutboundContactlistExport"},"post":{"tags":["Outbound"],"summary":"Initiate the export of a contact list.","description":"Returns 200 if received OK.","operationId":"postOutboundContactlistExport","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"ContactList ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainEntityRef"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","contact.list.export.in.progress":"An export is already in progress for this contact list.","exports.black.listed":"This organization has been prohibited from exporting contact lists. Please contact support.","internal.error":"An internal service error occurred.","contact.list.import.in.progress":"The contact list cannot be exported while it is being imported.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:contact:view","outbound:contactList:view"]},"x-purecloud-method-name":"postOutboundContactlistExport"}},"/api/v2/audits/query/{transactionId}":{"get":{"tags":["Audit"],"summary":"Get status of audit query execution","description":"","operationId":"getAuditsQueryTransactionId","produces":["application/json"],"parameters":[{"name":"transactionId","in":"path","description":"Transaction ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuditQueryExecutionStatusResponse"}},"202":{"description":"In progress - Query execution is in progress.","schema":{"$ref":"#/definitions/AuditQueryExecutionStatusResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["audits:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["audits:audit:view"]},"x-purecloud-method-name":"getAuditsQueryTransactionId"}},"/api/v2/audits/query/{transactionId}/results":{"get":{"tags":["Audit"],"summary":"Get results of audit query","description":"","operationId":"getAuditsQueryTransactionIdResults","produces":["application/json"],"parameters":[{"name":"transactionId","in":"path","description":"Transaction ID","required":true,"type":"string"},{"name":"cursor","in":"query","description":"Indicates where to resume query results (not required for first page)","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["user"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"user"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuditQueryExecutionResultsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["audits:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["audits:audit:view"]},"x-purecloud-method-name":"getAuditsQueryTransactionIdResults"}},"/api/v2/audits/query/servicemapping":{"get":{"tags":["Audit"],"summary":"Get service mapping information used in audits.","description":"","operationId":"getAuditsQueryServicemapping","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuditQueryServiceMapping"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["audits:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["audits:audit:view"]},"x-purecloud-method-name":"getAuditsQueryServicemapping"}},"/api/v2/audits/query/realtime/servicemapping":{"get":{"tags":["Audit"],"summary":"Get service mapping information used in realtime audits.","description":"","operationId":"getAuditsQueryRealtimeServicemapping","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuditQueryServiceMapping"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["audits:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["audits:audit:view"]},"x-purecloud-method-name":"getAuditsQueryRealtimeServicemapping"}},"/api/v2/audits/query":{"post":{"tags":["Audit"],"summary":"Create audit query execution","description":"","operationId":"postAuditsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/AuditQueryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuditQueryExecutionStatusResponse"}},"202":{"description":"Accepted - Query execution is accepted.","schema":{"$ref":"#/definitions/AuditQueryExecutionStatusResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["audits:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["audits:audit:view"]},"x-purecloud-method-name":"postAuditsQuery"}},"/api/v2/audits/query/realtime":{"post":{"tags":["Audit"],"summary":"This endpoint will only retrieve 7 days worth of audits for certain services. Please use /query to get a full list and older audits.","description":"","operationId":"postAuditsQueryRealtime","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/AuditRealtimeQueryRequest"}},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["user"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"user"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuditRealtimeQueryResultsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["audits:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["audits:audit:view"]},"x-purecloud-method-name":"postAuditsQueryRealtime"}},"/api/v2/integrations/speech/tts/settings":{"get":{"tags":["Integrations"],"summary":"Get TTS settings for an org","description":"","operationId":"getIntegrationsSpeechTtsSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TtsSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechTtsSettings"},"put":{"tags":["Integrations"],"summary":"Update TTS settings for an org","description":"","operationId":"putIntegrationsSpeechTtsSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Updated TtsSettings","required":true,"schema":{"$ref":"#/definitions/TtsSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TtsSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:edit"]},"x-purecloud-method-name":"putIntegrationsSpeechTtsSettings"}},"/api/v2/telephony/providers/edges/{edgeId}/reboot":{"post":{"tags":["Telephony Providers Edge"],"summary":"Reboot an Edge","description":"","operationId":"postTelephonyProvidersEdgeReboot","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Parameters for the edge reboot","required":false,"schema":{"$ref":"#/definitions/EdgeRebootParameters"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Edge was not found.","general.resource.not.found":"Edge was not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgeReboot"}},"/api/v2/users/{userId}/roles":{"get":{"tags":["Authorization","Users"],"summary":"Returns a listing of roles and permissions for a user.","description":"","operationId":"getUserRoles","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserAuthorization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:view"]},"x-purecloud-method-name":"getUserRoles"},"put":{"tags":["Authorization","Users"],"summary":"Sets the user's roles","description":"","operationId":"putUserRoles","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"List of roles","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserAuthorization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be processed due to invalid request data.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find an active user with that ID in this organization.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"The service is currently unavailable."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:add"]},"x-purecloud-method-name":"putUserRoles"}},"/api/v2/outbound/dnclists/{dncListId}/export":{"get":{"tags":["Outbound"],"summary":"Get the URI of a DNC list export.","description":"","operationId":"getOutboundDnclistExport","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"},{"name":"download","in":"query","description":"Redirect to download uri","required":false,"type":"string","default":"false"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExportUri"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.not.found":"The do not call list could not be found.","no.available.list.export.uri":"There is no available download URI for the dnc list at this time.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:dnc:view","outbound:dncList:view"]},"x-purecloud-method-name":"getOutboundDnclistExport"},"post":{"tags":["Outbound"],"summary":"Initiate the export of a dnc list.","description":"Returns 200 if received OK.","operationId":"postOutboundDnclistExport","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainEntityRef"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.import.in.progress":"The dnc list cannot be exported while it is being imported.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","dnc.list.export.in.progress":"An export is already in progress for this dnc list.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.not.found":"The dnc list could not be found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:dnc:view","outbound:dncList:view"]},"x-purecloud-method-name":"postOutboundDnclistExport"}},"/api/v2/greetings/{greetingId}":{"get":{"tags":["Greetings"],"summary":"Get a Greeting with the given GreetingId","description":"","operationId":"getGreeting","produces":["application/json"],"parameters":[{"name":"greetingId","in":"path","description":"Greeting ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Greeting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings","greetings:readonly"]}],"x-purecloud-method-name":"getGreeting"},"put":{"tags":["Greetings"],"summary":"Updates the Greeting with the given GreetingId","description":"","operationId":"putGreeting","produces":["application/json"],"parameters":[{"name":"greetingId","in":"path","description":"Greeting ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The updated Greeting","required":true,"schema":{"$ref":"#/definitions/Greeting"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Greeting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings"]}],"x-purecloud-method-name":"putGreeting"},"delete":{"tags":["Greetings"],"summary":"Deletes a Greeting with the given GreetingId","description":"","operationId":"deleteGreeting","produces":["application/json"],"parameters":[{"name":"greetingId","in":"path","description":"Greeting ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["greetings"]}],"x-purecloud-method-name":"deleteGreeting"}},"/api/v2/quality/forms/surveys":{"get":{"tags":["Quality"],"summary":"Get the list of survey forms","description":"","operationId":"getQualityFormsSurveys","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"expand","in":"query","description":"Expand","required":false,"type":"string"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Order to sort results, either asc or desc","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyFormEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:view"]},"x-purecloud-method-name":"getQualityFormsSurveys"},"post":{"tags":["Quality"],"summary":"Create a survey form.","description":"","operationId":"postQualityFormsSurveys","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Survey form","required":true,"schema":{"$ref":"#/definitions/SurveyForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:add"]},"x-purecloud-method-name":"postQualityFormsSurveys"}},"/api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}/roles":{"get":{"tags":["Organization Authorization"],"summary":"Get Trustee User Roles","description":"","operationId":"getOrgauthorizationTrusteeUserRoles","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Trustee User Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserAuthorization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:view"]},"x-purecloud-method-name":"getOrgauthorizationTrusteeUserRoles"},"put":{"tags":["Organization Authorization"],"summary":"Update Trustee User Roles","description":"","operationId":"putOrgauthorizationTrusteeUserRoles","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Trustee User Id","required":true,"type":"string"},{"in":"body","name":"body","description":"List of roles","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserAuthorization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:edit"]},"x-purecloud-method-name":"putOrgauthorizationTrusteeUserRoles"},"delete":{"tags":["Organization Authorization"],"summary":"Delete Trustee User Roles","description":"","operationId":"deleteOrgauthorizationTrusteeUserRoles","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Trustee User Id","required":true,"type":"string"}],"responses":{"204":{"description":"Roles deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:delete"]},"x-purecloud-method-name":"deleteOrgauthorizationTrusteeUserRoles"}},"/api/v2/externalcontacts/scan/contacts":{"get":{"tags":["External Contacts"],"summary":"Scan for external contacts using paging","description":"","operationId":"getExternalcontactsScanContacts","produces":["application/json"],"parameters":[{"name":"limit","in":"query","description":"The number of contacts per page; must be between 10 and 200, default is 100)","required":false,"type":"integer","format":"int32"},{"name":"cursor","in":"query","description":"Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CursorContactListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or expired cursor","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too many requests in a given amount of time"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:view"]},"x-purecloud-method-name":"getExternalcontactsScanContacts"}},"/api/v2/users/{userId}/presences/{sourceId}":{"get":{"tags":["Presence"],"summary":"Get a user's Presence","description":"Get a user's presence for the specified source that is not specifically listed. Used to support custom presence sources.","operationId":"getUserPresence","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"user Id","required":true,"type":"string"},{"name":"sourceId","in":"path","description":"Presence source ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserPresence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.usernotfound":"The specified user was not found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","presenceservice.toomanyrequests":"Too many requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence","presence:readonly"]}],"x-purecloud-method-name":"getUserPresence"},"patch":{"tags":["Presence"],"summary":"Patch a user's Presence","description":"Patch a user's presence for the specified source that is not specifically listed. The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the 'source' defined in the path as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.","operationId":"patchUserPresence","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"user Id","required":true,"type":"string"},{"name":"sourceId","in":"path","description":"Presence source ID","required":true,"type":"string"},{"in":"body","name":"body","description":"User presence","required":true,"schema":{"$ref":"#/definitions/UserPresence"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserPresence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.usernotfound":"The specified user was not found","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.conflict":"A previous update request has not yet completed"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","presenceservice.toomanyrequests":"Too many requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence"]}],"x-purecloud-method-name":"patchUserPresence"}},"/api/v2/users/{userId}/presences/purecloud":{"get":{"tags":["Presence"],"summary":"Get a user's Genesys Cloud presence.","description":"Get the default Genesys Cloud user presence source PURECLOUD","operationId":"getUserPresencesPurecloud","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"user Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserPresence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.usernotfound":"The specified user was not found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","presenceservice.toomanyrequests":"Too many requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence","presence:readonly"]}],"x-purecloud-method-name":"getUserPresencesPurecloud"},"patch":{"tags":["Presence"],"summary":"Patch a Genesys Cloud user's presence","description":"The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the PURECLOUD source as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.","operationId":"patchUserPresencesPurecloud","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"user Id","required":true,"type":"string"},{"in":"body","name":"body","description":"User presence","required":true,"schema":{"$ref":"#/definitions/UserPresence"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserPresence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.usernotfound":"The specified user was not found","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.conflict":"A previous update request has not yet completed"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","presenceservice.toomanyrequests":"Too many requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence"]}],"x-purecloud-method-name":"patchUserPresencesPurecloud"}},"/api/v2/users/{userId}/presences/microsoftteams":{"get":{"tags":["Presence"],"summary":"Get a user's Microsoft Teams presence.","description":"Gets the presence for a Microsoft Teams user. This will return the Microsoft Teams presence mapped to Genesys Cloud presence with additional activity details in the message field. This presence source is read-only.","operationId":"getUserPresencesMicrosoftteams","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"user Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PresenceExpand"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Valid session authorization code not created.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"Microsoft Teams presence could not be found for user."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integration:microsoftTeams:view","integrations:integration:view"]},"x-purecloud-method-name":"getUserPresencesMicrosoftteams"}},"/api/v2/routing/message/recipients":{"get":{"tags":["Routing"],"summary":"Get recipients","description":"","operationId":"getRoutingMessageRecipients","produces":["application/json"],"parameters":[{"name":"messengerType","in":"query","description":"Messenger Type","required":false,"type":"string","enum":["sms","facebook","twitter","line","whatsapp"],"x-genesys-enum-members":[{"name":"sms"},{"name":"facebook"},{"name":"twitter"},{"name":"line"},{"name":"whatsapp"}]},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecipientListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:message:manage"]},"x-purecloud-method-name":"getRoutingMessageRecipients"}},"/api/v2/telephony/providers/edges/phonebasesettings/template":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Phone Base Settings instance template from a given make and model. This object can then be modified and saved as a new Phone Base Settings instance","description":"","operationId":"getTelephonyProvidersEdgesPhonebasesettingsTemplate","produces":["application/json"],"parameters":[{"name":"phoneMetabaseId","in":"query","description":"The id of a metabase object upon which to base this Phone Base Settings","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhoneBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesPhonebasesettingsTemplate"}},"/api/v2/externalcontacts/reversewhitepageslookup":{"get":{"tags":["External Contacts"],"summary":"Look up contacts and externalOrganizations based on an attribute. Maximum of 25 values returned.","description":"","operationId":"getExternalcontactsReversewhitepageslookup","produces":["application/json"],"parameters":[{"name":"lookupVal","in":"query","description":"User supplied value to lookup contacts/externalOrganizations (supports email addresses, e164 phone numbers, Twitter screen names)","required":true,"type":"string"},{"name":"expand","in":"query","description":"which field, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["contacts.externalOrganization","externalDataSources"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"contacts.externalOrganization"},{"name":"externalDataSources"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReverseWhitepagesLookupResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:view"]},"x-purecloud-method-name":"getExternalcontactsReversewhitepageslookup"}},"/api/v2/quality/keywordsets/{keywordSetId}":{"get":{"tags":["Quality"],"summary":"Get a keywordSet by id.","description":"","operationId":"getQualityKeywordset","produces":["application/json"],"parameters":[{"name":"keywordSetId","in":"path","description":"KeywordSet ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KeywordSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:keywordset:view"]},"x-purecloud-method-name":"getQualityKeywordset"},"put":{"tags":["Quality"],"summary":"Update a keywordSet to the specified keywordSet via PUT.","description":"","operationId":"putQualityKeywordset","produces":["application/json"],"parameters":[{"name":"keywordSetId","in":"path","description":"KeywordSet ID","required":true,"type":"string"},{"in":"body","name":"body","description":"keywordSet","required":true,"schema":{"$ref":"#/definitions/KeywordSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KeywordSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"qm.keyword.set.invalid.agent":"One of the agentIds is invalid","quality.keyword.limit.exceeded.for.agent":"Keyword Set keyword limit exceeded for agent","bad.request":"The request could not be understood by the server due to malformed syntax.","qm.keyword.set.invalid.queue":"One of the queueIds is invalid","qm.keyword.set.invalid.language":"Invalid language","quality.keyword.duplicate.phrase":"A Keyword phrase cannot be duplicated in keywords, anti-words or alternate spellings","quality.keyword.limit.exceeded.for.agent.and.queue":"Keyword Set keyword limit exceeded for agent and queue","quality.keyword.limit.exceeded":"Keyword Set keyword limit exceeded","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","quality.keyword.limit.exceeded.for.queue":"Keyword Set keyword limit exceeded for queue","qm.keyword.set.agent.or.queue.required":"A queue or agent is required for a valid Keyword Set","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:keywordset:edit"]},"x-purecloud-method-name":"putQualityKeywordset"},"delete":{"tags":["Quality"],"summary":"Delete a keywordSet by id.","description":"","operationId":"deleteQualityKeywordset","produces":["application/json"],"parameters":[{"name":"keywordSetId","in":"path","description":"KeywordSet ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:keywordset:delete"]},"x-purecloud-method-name":"deleteQualityKeywordset"}},"/api/v2/authorization/divisions":{"get":{"tags":["Authorization","Objects"],"summary":"Retrieve a list of all divisions defined for the organization","description":"Request specific divisions by id using a query param \"id\", e.g. \n?id=5f777167-63be-4c24-ad41-374155d9e28b&id=72e9fb25-c484-488d-9312-7acba82435b3","operationId":"getAuthorizationDivisions","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"objectCount","in":"query","description":"Include the count of objects contained in the division","required":false,"type":"boolean","default":false},{"name":"id","in":"query","description":"Optionally request specific divisions by their IDs","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Search term to filter by division name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuthzDivisionEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-purecloud-method-name":"getAuthorizationDivisions"},"post":{"tags":["Authorization","Objects"],"summary":"Create a division.","description":"","operationId":"postAuthorizationDivisions","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Division","required":true,"schema":{"$ref":"#/definitions/AuthzDivision"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuthzDivision"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"max.length.exceeded":"One or more attributes is longer than the maximum length allowed.","max.scopes.exceeded":"Too many divisions for organization.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"resource.already.exists":"A resource with that name already exists."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["authorization:division:add","authorization:grant:add"]},"x-purecloud-method-name":"postAuthorizationDivisions"}},"/api/v2/externalcontacts/organizations/{externalOrganizationId}/notes":{"get":{"tags":["External Contacts"],"summary":"List notes for an external organization","description":"","operationId":"getExternalcontactsOrganizationNotes","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization Id","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":20,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["author","externalDataSources"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"author"},{"name":"externalDataSources"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NoteListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:view","externalContacts:externalOrganization:view"]},"x-purecloud-method-name":"getExternalcontactsOrganizationNotes"},"post":{"tags":["External Contacts"],"summary":"Create a note for an external organization","description":"","operationId":"postExternalcontactsOrganizationNotes","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization Id","required":true,"type":"string"},{"in":"body","name":"body","description":"ExternalContact","required":true,"schema":{"$ref":"#/definitions/Note"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Note"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided contact was not valid"}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:edit","externalContacts:externalOrganization:edit"]},"x-purecloud-method-name":"postExternalcontactsOrganizationNotes"}},"/api/v2/telephony/providers/edges/phonebasesettings/availablemetabases":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of available makes and models to create a new Phone Base Settings","description":"","operationId":"getTelephonyProvidersEdgesPhonebasesettingsAvailablemetabases","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhoneMetaBaseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesPhonebasesettingsAvailablemetabases"}},"/api/v2/architect/emergencygroups/{emergencyGroupId}":{"get":{"tags":["Architect"],"summary":"Gets a emergency group by ID","description":"","operationId":"getArchitectEmergencygroup","produces":["application/json"],"parameters":[{"name":"emergencyGroupId","in":"path","description":"Emergency group ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmergencyGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The specified emergencyGroupId was not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:emergencyGroup:view"]},"x-purecloud-method-name":"getArchitectEmergencygroup"},"put":{"tags":["Architect"],"summary":"Updates a emergency group by ID","description":"","operationId":"putArchitectEmergencygroup","produces":["application/json"],"parameters":[{"name":"emergencyGroupId","in":"path","description":"Emergency group ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/EmergencyGroup"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmergencyGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:emergencyGroup:edit"]},"x-purecloud-method-name":"putArchitectEmergencygroup"},"delete":{"tags":["Architect"],"summary":"Deletes a emergency group by ID","description":"","operationId":"deleteArchitectEmergencygroup","produces":["application/json"],"parameters":[{"name":"emergencyGroupId","in":"path","description":"Emergency group ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"could not find the requested emergency group","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:emergencyGroup:delete"]},"x-purecloud-method-name":"deleteArchitectEmergencygroup"}},"/api/v2/outbound/contactlists/divisionviews":{"get":{"tags":["Outbound"],"summary":"Query a list of simplified contact list objects.","description":"This return a simplified version of contact lists, consisting of the name, division, column names, phone columns, import status, and size.","operationId":"getOutboundContactlistsDivisionviews","produces":["application/json"],"parameters":[{"name":"includeImportStatus","in":"query","description":"Include import status","required":false,"type":"boolean","default":false},{"name":"includeSize","in":"query","description":"Include size","required":false,"type":"boolean","default":false},{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"],"x-genesys-enum-members":[{"name":"Equals"},{"name":"RegEx"},{"name":"Contains"},{"name":"Prefix"},{"name":"LessThan"},{"name":"LessThanEqualTo"},{"name":"GreaterThan"},{"name":"GreaterThanEqualTo"},{"name":"BeginsWith"},{"name":"EndsWith"}]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListDivisionViewListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.bulk.retrieves":"Only 100 contact lists can be retrieved by id at a time","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:contactList:search"]},"x-purecloud-method-name":"getOutboundContactlistsDivisionviews"}},"/api/v2/flows/executions/{flowExecutionId}":{"get":{"tags":["Architect"],"summary":"Get a flow execution's details. Flow execution details are available for several days after the flow is started.","description":"","operationId":"getFlowsExecution","produces":["application/json"],"parameters":[{"name":"flowExecutionId","in":"path","description":"flow execution ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowRuntimeExecution"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.flow.execution.not.found":"Specifiec flow execution not found.","architect.execution.flow.not.found":"Could not find flow execution with specified ID."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.unspecified.error":"An unknown error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flowExecution:view"]},"x-purecloud-method-name":"getFlowsExecution"}},"/api/v2/oauth/clients/{clientId}/usage/summary":{"get":{"tags":["OAuth"],"summary":"Get a summary of OAuth client API usage","description":"After calling this method, you will then need to poll for the query results based on the returned execution Id","operationId":"getOauthClientUsageSummary","produces":["application/json"],"parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"type":"string"},{"name":"days","in":"query","description":"Previous number of days to query","required":false,"type":"string","default":"7"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UsageExecutionResult"}},"202":{"description":"Execution not completed, check back for results","schema":{"$ref":"#/definitions/UsageExecutionResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:view"]},"x-purecloud-method-name":"getOauthClientUsageSummary"}},"/api/v2/oauth/clients/{clientId}/usage/query":{"post":{"tags":["OAuth"],"summary":"Query for OAuth client API usage","description":"After calling this method, you will then need to poll for the query results based on the returned execution Id","operationId":"postOauthClientUsageQuery","produces":["application/json"],"parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Query","required":true,"schema":{"$ref":"#/definitions/ApiUsageQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UsageExecutionResult"}},"202":{"description":"Execution not completed, check back for results","schema":{"$ref":"#/definitions/UsageExecutionResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:view"]},"x-purecloud-method-name":"postOauthClientUsageQuery"}},"/api/v2/scim/serviceproviderconfig":{"get":{"tags":["SCIM"],"summary":"Get a service provider's configuration","description":"","operationId":"getScimServiceproviderconfig","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"name":"If-None-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/serviceproviderconfig. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified. ","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimServiceProviderConfig"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimServiceproviderconfig"}},"/api/v2/workforcemanagement/managementunits/divisionviews":{"get":{"tags":["Workforce Management"],"summary":"Get management units across divisions","description":"","operationId":"getWorkforcemanagementManagementunitsDivisionviews","produces":["application/json"],"parameters":[{"name":"divisionId","in":"query","description":"The divisionIds to filter by. If omitted, will return all divisions","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ManagementUnitListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:managementUnit:search"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitsDivisionviews"}},"/api/v2/routing/queues/{queueId}/estimatedwaittime":{"get":{"tags":["Routing"],"summary":"Get Estimated Wait Time","description":"","operationId":"getRoutingQueueEstimatedwaittime","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"queueId","required":true,"type":"string"},{"name":"conversationId","in":"query","description":"conversationId","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EstimatedWaitTimePredictions"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"At least one of the required division permissions is missing","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:queue:view"]},"x-purecloud-method-name":"getRoutingQueueEstimatedwaittime"}},"/api/v2/authorization/divisionspermitted/paged/me":{"get":{"tags":["Authorization","Users"],"summary":"Returns which divisions the current user has the given permission in.","description":"","operationId":"getAuthorizationDivisionspermittedPagedMe","produces":["application/json"],"parameters":[{"name":"permission","in":"query","description":"The permission string, including the object to access, e.g. routing:queue:view","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DivsPermittedEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","missing.permission.param":"Missing required permission parameter","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-purecloud-method-name":"getAuthorizationDivisionspermittedPagedMe"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups/{planningGroupId}":{"get":{"tags":["Workforce Management"],"summary":"Get a planning group","description":"","operationId":"getWorkforcemanagementBusinessunitPlanninggroup","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit.","required":true,"type":"string"},{"name":"planningGroupId","in":"path","description":"The ID of a planning group to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PlanningGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:planningGroup:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitPlanninggroup"},"delete":{"tags":["Workforce Management"],"summary":"Deletes the planning group","description":"","operationId":"deleteWorkforcemanagementBusinessunitPlanninggroup","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit.","required":true,"type":"string"},{"name":"planningGroupId","in":"path","description":"The ID of a planning group to delete","required":true,"type":"string"}],"responses":{"204":{"description":"The planning group was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:planningGroup:delete"]},"x-purecloud-method-name":"deleteWorkforcemanagementBusinessunitPlanninggroup"},"patch":{"tags":["Workforce Management"],"summary":"Updates the planning group","description":"","operationId":"patchWorkforcemanagementBusinessunitPlanninggroup","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit.","required":true,"type":"string"},{"name":"planningGroupId","in":"path","description":"The ID of a planning group to update","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/UpdatePlanningGroupRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PlanningGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"routing.skill.ids.not.found":"One or more skill IDs were not found","language.ids.not.found":"One or more language IDs were not found","wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found.","queue.ids.not.found":"One or more queue IDs were not found"}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Entity was modified by another request"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:planningGroup:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementBusinessunitPlanninggroup"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups":{"get":{"tags":["Workforce Management"],"summary":"Gets list of planning groups","description":"","operationId":"getWorkforcemanagementBusinessunitPlanninggroups","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PlanningGroupList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:planningGroup:view","wfm:shortTermForecast:view","wfm:intraday:view","wfm:agent:view","wfm:schedule:view","wfm:publishedSchedule:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitPlanninggroups"},"post":{"tags":["Workforce Management"],"summary":"Adds a new planning group","description":"","operationId":"postWorkforcemanagementBusinessunitPlanninggroups","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/CreatePlanningGroupRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PlanningGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"routing.skill.ids.not.found":"One or more skill IDs were not found","language.ids.not.found":"One or more language IDs were not found","wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found.","queue.ids.not.found":"One or more queue IDs were not found"}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Entity was modified by another request"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:planningGroup:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitPlanninggroups"}},"/api/v2/identityproviders/ping":{"get":{"tags":["Identity Provider"],"summary":"Get Ping Identity Provider","description":"","operationId":"getIdentityprovidersPing","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PingIdentity"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersPing"},"put":{"tags":["Identity Provider"],"summary":"Update/Create Ping Identity Provider","description":"","operationId":"putIdentityprovidersPing","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/PingIdentity"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.issuer.uri":"An issuer URI is required.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.target.url":"The target URL must be a valid HTTPS URL.","certificate.not.yet.valid":"The certificate is not yet valid.","certificate.invalid.base64":"Invalid base64 in certificate.","certificate.unparseable":"The certificate for provider cannot be parsed.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersPing"},"delete":{"tags":["Identity Provider"],"summary":"Delete Ping Identity Provider","description":"","operationId":"deleteIdentityprovidersPing","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersPing"}},"/api/v2/telephony/providers/edges/extensionpools":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a listing of extension pools","description":"","operationId":"getTelephonyProvidersEdgesExtensionpools","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"startNumber"},{"name":"number","in":"query","description":"Number","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExtensionPoolEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesExtensionpools"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a new extension pool","description":"","operationId":"postTelephonyProvidersEdgesExtensionpools","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ExtensionPool","required":true,"schema":{"$ref":"#/definitions/ExtensionPool"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExtensionPool"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be completed by the server due to a conflict."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesExtensionpools"}},"/api/v2/orgauthorization/pairings":{"post":{"tags":["Organization Authorization"],"summary":"A pairing id is created by the trustee and given to the trustor to create a trust.","description":"","operationId":"postOrgauthorizationPairings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Pairing Info","required":true,"schema":{"$ref":"#/definitions/TrustRequestCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustRequest"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrustee:add"]},"x-purecloud-method-name":"postOrgauthorizationPairings"}},"/api/v2/telephony/providers/edges/{edgeId}/softwareversions":{"get":{"tags":["Telephony Providers Edge"],"summary":"Gets all the available software versions for this edge.","description":"","operationId":"getTelephonyProvidersEdgeSoftwareversions","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainEdgeSoftwareVersionDtoEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"Request badly formed.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-purecloud-method-name":"getTelephonyProvidersEdgeSoftwareversions"}},"/api/v2/flows/datatables/{datatableId}/import/jobs":{"get":{"tags":["Architect"],"summary":"Get all recent import jobs","description":"Get all recent import jobs","operationId":"getFlowsDatatableImportJobs","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.table.not.found":"The specified datatableId was not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:edit"]},"x-purecloud-method-name":"getFlowsDatatableImportJobs"},"post":{"tags":["Architect"],"summary":"Begin an import process for importing rows into a datatable","description":"Create an import job for importing rows. The caller can then poll for status of the import using the token returned in the response","operationId":"postFlowsDatatableImportJobs","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"in":"body","name":"body","description":"import job information","required":true,"schema":{"$ref":"#/definitions/DataTableImportJob"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataTableImportJob"}},"202":{"description":"Request Accepted","schema":{"$ref":"#/definitions/DataTableImportJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.table.not.found":"The datatable could not be found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:edit"]},"x-purecloud-method-name":"postFlowsDatatableImportJobs"}},"/api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations":{"get":{"tags":["Recording"],"summary":"Get annotations for recording","description":"","operationId":"getConversationRecordingAnnotations","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"recordingId","in":"path","description":"Recording ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/Annotation"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:annotation:view"]},"x-purecloud-method-name":"getConversationRecordingAnnotations"},"post":{"tags":["Recording"],"summary":"Create annotation","description":"","operationId":"postConversationRecordingAnnotations","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"recordingId","in":"path","description":"Recording ID","required":true,"type":"string"},{"in":"body","name":"body","description":"annotation","required":true,"schema":{"$ref":"#/definitions/Annotation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Annotation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","recording.invalid.json":"Request contains invalid JSON.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:annotation:add"]},"x-purecloud-method-name":"postConversationRecordingAnnotations"}},"/api/v2/webchat/guest/conversations/{conversationId}/messages":{"get":{"tags":["WebChat"],"summary":"Get the messages of a chat conversation.","description":"","operationId":"getWebchatGuestConversationMessages","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"after","in":"query","description":"If available, get the messages chronologically after the id of this message","required":false,"type":"string"},{"name":"before","in":"query","description":"If available, get the messages chronologically before the id of this message","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ascending","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]},{"name":"maxResults","in":"query","description":"Limit the returned number of messages, up to a maximum of 100","required":false,"type":"integer","default":100,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatMessageEntityList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"Guest Chat JWT":[]}],"x-purecloud-method-name":"getWebchatGuestConversationMessages"}},"/api/v2/analytics/flows/aggregates/query":{"post":{"tags":["Flows","Analytics"],"summary":"Query for flow aggregates","description":"","operationId":"postAnalyticsFlowsAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/FlowAggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to query for flow aggregates.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:flowAggregate:view"]},"x-purecloud-method-name":"postAnalyticsFlowsAggregatesQuery"}},"/api/v2/analytics/flows/observations/query":{"post":{"tags":["Flows","Analytics"],"summary":"Query for flow observations","description":"","operationId":"postAnalyticsFlowsObservationsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/FlowObservationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowObservationQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:flowObservation:view"]},"x-purecloud-method-name":"postAnalyticsFlowsObservationsQuery"}},"/api/v2/users":{"get":{"tags":["Users"],"summary":"Get the list of available users.","description":"","operationId":"getUsers","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"id","in":"query","description":"A list of user IDs to fetch by bulk","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"jabberId","in":"query","description":"A list of jabberIds to fetch by bulk (cannot be used with the \"id\" parameter)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ASC","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"routingStatus"},{"name":"presence"},{"name":"conversationSummary"},{"name":"outOfOffice"},{"name":"geolocation"},{"name":"station"},{"name":"authorization"},{"name":"lasttokenissued"},{"name":"authorization.unusedRoles"},{"name":"team"},{"name":"profileSkills"},{"name":"certifications"},{"name":"locations"},{"name":"groups"},{"name":"skills"},{"name":"languages"},{"name":"languagePreference"},{"name":"employerInfo"},{"name":"biography"}]},{"name":"integrationPresenceSource","in":"query","description":"Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an \"expand\". When using this parameter the maximum number of users that can be returned is 10.","required":false,"type":"string","enum":["MicrosoftTeams","ZoomPhone","RingCentral"],"x-genesys-enum-members":[{"name":"MicrosoftTeams"},{"name":"ZoomPhone"},{"name":"RingCentral"}]},{"name":"state","in":"query","description":"Only list users of this state","required":false,"type":"string","default":"active","enum":["active","inactive","deleted","any"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"},{"name":"any"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","max.user.ids":"Only 100 users can be requested at a time."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The requested user(s) could not be found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getUsers"},"post":{"tags":["Users"],"summary":"Create user","description":"","operationId":"postUsers","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"User","required":true,"schema":{"$ref":"#/definitions/CreateUser"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/User"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","general.conflict":"The request could not be completed by the server due to a conflict."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be completed by the server due to a conflict."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:add"]},"x-purecloud-method-name":"postUsers"}},"/api/v2/oauth/scopes":{"get":{"tags":["OAuth"],"summary":"The list of OAuth scopes","description":"","operationId":"getOauthScopes","produces":["application/json"],"parameters":[{"name":"Accept-Language","in":"header","description":"The language with which to display the scope descriptions.","required":false,"type":"string","default":"en-us"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthScopeListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-purecloud-method-name":"getOauthScopes"}},"/api/v2/users/{userId}/greetings":{"get":{"tags":["Greetings"],"summary":"Get a list of the User's Greetings","description":"","operationId":"getUserGreetings","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings","greetings:readonly"]}],"x-purecloud-method-name":"getUserGreetings"},"post":{"tags":["Greetings"],"summary":"Creates a Greeting for a User","description":"","operationId":"postUserGreetings","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The Greeting to create","required":true,"schema":{"$ref":"#/definitions/Greeting"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Greeting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings"]}],"x-purecloud-method-name":"postUserGreetings"}},"/api/v2/architect/schedulegroups/{scheduleGroupId}":{"get":{"tags":["Architect"],"summary":"Gets a schedule group by ID","description":"","operationId":"getArchitectSchedulegroup","produces":["application/json"],"parameters":[{"name":"scheduleGroupId","in":"path","description":"Schedule group ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScheduleGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The specified scheduleGroupId was not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:scheduleGroup:view"]},"x-purecloud-method-name":"getArchitectSchedulegroup"},"put":{"tags":["Architect"],"summary":"Updates a schedule group by ID","description":"","operationId":"putArchitectSchedulegroup","produces":["application/json"],"parameters":[{"name":"scheduleGroupId","in":"path","description":"Schedule group ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/ScheduleGroup"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScheduleGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:scheduleGroup:edit"]},"x-purecloud-method-name":"putArchitectSchedulegroup"},"delete":{"tags":["Architect"],"summary":"Deletes a schedule group by ID","description":"","operationId":"deleteArchitectSchedulegroup","produces":["application/json"],"parameters":[{"name":"scheduleGroupId","in":"path","description":"Schedule group ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The specified scheduleGroupId was not found.","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The schedule group could not be completed because it is assigned to one or more IVRs or Sites."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:scheduleGroup:delete"]},"x-purecloud-method-name":"deleteArchitectSchedulegroup"}},"/api/v2/journey/actionmaps":{"get":{"tags":["Journey"],"summary":"Retrieve all action maps.","description":"","operationId":"getJourneyActionmaps","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Field(s) to sort by. Prefix with '-' for descending (e.g. sortBy=displayName,-createdDate).","required":false,"type":"string"},{"name":"filterField","in":"query","description":"Field to filter by (e.g. filterField=weight or filterField=action.actionTemplate.id). Requires 'filterField' to also be set.","required":false,"type":"string"},{"name":"filterValue","in":"query","description":"Value to filter by. Requires 'filterValue' to also be set.","required":false,"type":"string"},{"name":"actionMapIds","in":"query","description":"IDs of action maps to return. Use of this parameter is not compatible with pagination, filtering or sorting. A maximum of 100 action maps are allowed per request.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionMapListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actionmap:view"]},"x-purecloud-method-name":"getJourneyActionmaps"},"post":{"tags":["Journey"],"summary":"Create an action map.","description":"","operationId":"postJourneyActionmaps","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ActionMap"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionMap"}},"201":{"description":"Action map created.","schema":{"$ref":"#/definitions/ActionMap"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actionmap:add"]},"x-purecloud-method-name":"postJourneyActionmaps"}},"/api/v2/dataextensions/limits":{"get":{"tags":["Data Extensions"],"summary":"Get quantitative limits on schemas","description":"","operationId":"getDataextensionsLimits","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SchemaQuantityLimits"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["data-extensions"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getDataextensionsLimits"}},"/api/v2/oauth/scopes/{scopeId}":{"get":{"tags":["OAuth"],"summary":"An OAuth scope","description":"","operationId":"getOauthScope","produces":["application/json"],"parameters":[{"name":"scopeId","in":"path","description":"Scope ID","required":true,"type":"string"},{"name":"Accept-Language","in":"header","description":"The language with which to display the scope description.","required":false,"type":"string","default":"en-us"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthScope"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-purecloud-method-name":"getOauthScope"}},"/api/v2/architect/prompts/{promptId}/history":{"post":{"tags":["Architect"],"summary":"Generate prompt history","description":"Asynchronous. Notification topic: v2.architect.prompts.{promptId}","operationId":"postArchitectPromptHistory","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Operation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:view"]},"x-purecloud-method-name":"postArchitectPromptHistory"}},"/api/v2/architect/prompts/{promptId}/history/{historyId}":{"get":{"tags":["Architect"],"summary":"Get generated prompt history","description":"","operationId":"getArchitectPromptHistoryHistoryId","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"historyId","in":"path","description":"History request ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"desc"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"timestamp","enum":["action","timestamp","user"],"x-genesys-enum-members":[{"name":"action"},{"name":"timestamp"},{"name":"user"}]},{"name":"action","in":"query","description":"Flow actions to include (omit to include all)","required":false,"type":"array","items":{"type":"string","enum":["checkin","checkout","create","deactivate","debug","delete","publish","revert","save"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"checkin"},{"name":"checkout"},{"name":"create"},{"name":"deactivate"},{"name":"debug"},{"name":"delete"},{"name":"publish"},{"name":"revert"},{"name":"save"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/HistoryListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.not.found":"Could not find prompt with specified ID.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:view"]},"x-purecloud-method-name":"getArchitectPromptHistoryHistoryId"}},"/api/v2/architect/prompts/{promptId}":{"get":{"tags":["Architect"],"summary":"Get specified user prompt","description":"","operationId":"getArchitectPrompt","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Prompt"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.not.found":"Could not find prompt with specified ID.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:view"]},"x-purecloud-method-name":"getArchitectPrompt"},"put":{"tags":["Architect"],"summary":"Update specified user prompt","description":"","operationId":"putArchitectPrompt","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Prompt"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Prompt"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.validate.failed.invalid.name":"Failed to validate prompt due to invalid name. Prompt names can only contain letters, numbers, and the underscore, and must start with a letter or number.","architect.prompt.resource.validate.failed.language":"Failed to validate prompt resource due to missing or invalid language.","architect.prompt.resource.invalid.tags":"The specified tags are in an invalid format.","bad.request":"The request could not be understood by the server due to malformed syntax.","architect.prompt.validate.failed":"Failed to validate prompt.","architect.object.validate.failed":"Failed to validate object.","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","architect.prompt.resource.validate.failed":"Failed to validate prompt resource.","architect.prompt.validate.failed.name.no.alpha":"Failed to validate prompt due to invalid name. Names must contain at least one alphanumeric character.","architect.prompt.validate.failed.missing.name":"Failed to validate prompt due to missing name.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.not.found":"Could not find prompt with specified ID.","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.already.exists":"A prompt with the specified name already exists."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.object.update.failed":"The database update for the object failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:edit"]},"x-purecloud-method-name":"putArchitectPrompt"},"delete":{"tags":["Architect"],"summary":"Delete specified user prompt","description":"","operationId":"deleteArchitectPrompt","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"allResources","in":"query","description":"Whether or not to delete all the prompt resources","required":false,"type":"boolean"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.not.found":"Could not find prompt with specified ID.","architect.flow.data.missing":"Flow version data content is missing.","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.cannot.delete.used.in.queues":"Prompt cannot be deleted due to being used by one or more queue configuration(s).","architect.dependency.object.in.use":"The object cannot be deleted because other objects depend on it.","architect.prompt.has.resources":"Cannot delete prompt since it contains prompt resources."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","architect.database.throughput.exceeded":"Database too busy. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:delete"]},"x-purecloud-method-name":"deleteArchitectPrompt"}},"/api/v2/date":{"get":{"tags":["Utilities"],"summary":"Get the current system date/time","description":"","operationId":"getDate","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ServerDate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":[]}],"x-purecloud-method-name":"getDate"}},"/api/v2/externalcontacts/organizations/schemas/{schemaId}/versions/{versionId}":{"get":{"tags":["External Contacts"],"summary":"Get a specific version of a schema","description":"","operationId":"getExternalcontactsOrganizationsSchemaVersion","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"},{"name":"versionId","in":"path","description":"Schema version","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getExternalcontactsOrganizationsSchemaVersion"}},"/api/v2/scripts/uploads/{uploadId}/status":{"get":{"tags":["Scripts"],"summary":"Get the upload status of an imported script","description":"","operationId":"getScriptsUploadStatus","produces":["application/json"],"parameters":[{"name":"uploadId","in":"path","description":"Upload ID","required":true,"type":"string"},{"name":"longPoll","in":"query","description":"Enable longPolling endpoint","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ImportScriptStatusResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:script:view"]},"x-purecloud-method-name":"getScriptsUploadStatus"}},"/api/v2/coaching/appointments/me":{"get":{"tags":["Coaching"],"summary":"Get my appointments for a given date range","description":"","operationId":"getCoachingAppointmentsMe","produces":["application/json"],"parameters":[{"name":"interval","in":"query","description":"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","required":false,"type":"string","format":"interval"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"statuses","in":"query","description":"Appointment Statuses to filter by","required":false,"type":"array","items":{"type":"string","enum":["Scheduled","InProgress","Completed"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"Scheduled"},{"name":"InProgress"},{"name":"Completed"}]},{"name":"facilitatorIds","in":"query","description":"The facilitator IDs for which to retrieve appointments","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortOrder","in":"query","description":"Sort (by due date) either Asc or Desc","required":false,"type":"string","enum":["Desc","Asc"],"x-genesys-enum-members":[{"name":"Desc"},{"name":"Asc"}]},{"name":"relationships","in":"query","description":"Relationships to filter by","required":false,"type":"array","items":{"type":"string","enum":["Creator","Facilitator","Attendee"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"Creator"},{"name":"Facilitator"},{"name":"Attendee"}]},{"name":"completionInterval","in":"query","description":"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","required":false,"type":"string","format":"interval"},{"name":"overdue","in":"query","description":"Overdue status to filter by","required":false,"type":"string","enum":["True","False","Any"],"x-genesys-enum-members":[{"name":"True"},{"name":"False"},{"name":"Any"}]}],"responses":{"200":{"description":"Get my coaching appointments successful","schema":{"$ref":"#/definitions/CoachingAppointmentResponseList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","coaching:readonly"]}],"x-purecloud-method-name":"getCoachingAppointmentsMe"}},"/api/v2/quality/publishedforms/surveys":{"get":{"tags":["Quality"],"summary":"Get the published survey forms.","description":"","operationId":"getQualityPublishedformsSurveys","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"onlyLatestEnabledPerContext","in":"query","description":"onlyLatestEnabledPerContext","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyFormEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:view"]},"x-purecloud-method-name":"getQualityPublishedformsSurveys"},"post":{"tags":["Quality"],"summary":"Publish a survey form.","description":"","operationId":"postQualityPublishedformsSurveys","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Survey form","required":true,"schema":{"$ref":"#/definitions/PublishForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:add"]},"x-purecloud-method-name":"postQualityPublishedformsSurveys"}},"/api/v2/stations":{"get":{"tags":["Stations"],"summary":"Get the list of available stations.","description":"","operationId":"getStations","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"userSelectable","in":"query","description":"True for stations that the user can select otherwise false","required":false,"type":"string"},{"name":"webRtcUserId","in":"query","description":"Filter for the webRtc station of the webRtcUserId","required":false,"type":"string"},{"name":"id","in":"query","description":"Comma separated list of stationIds","required":false,"type":"string"},{"name":"lineAppearanceId","in":"query","description":"lineAppearanceId","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/StationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.organization.type":"Collaborate organizations do not have permission to work with stations","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"Request is badly formed.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"Request Timeout","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unknown":"Unspecified error getting station listing."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.rate.limit":"Request rate limit exceeded.","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.internal.server.error":"Internal server error getting station listing.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["stations","stations:readonly"]}],"x-purecloud-method-name":"getStations"}},"/api/v2/quality/evaluators/activity":{"get":{"tags":["Quality"],"summary":"Get an evaluator activity","description":"","operationId":"getQualityEvaluatorsActivity","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"startTime","in":"query","description":"The start time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","required":false,"type":"string","format":"date-time"},{"name":"endTime","in":"query","description":"The end time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","required":false,"type":"string","format":"date-time"},{"name":"name","in":"query","description":"Evaluator name","required":false,"type":"string"},{"name":"permission","in":"query","description":"permission strings","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"group","in":"query","description":"group id","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluatorActivityEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"qmevaluatoractivity.search.too.many.results":"Too many results in evaluator activity query; user needs to enter more characters for name search","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","qmevaluatoractivity.pagenum.too.big":"Page number too large in evaluator activity query","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","qmevaluatoractivity.pagenum.too.small":"Page number too small in evaluator activity query; cannot be < 1"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","quality.evaluation.view.permission.check.failed":"Failed to check required view permission.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluation:view"]},"x-purecloud-method-name":"getQualityEvaluatorsActivity"}},"/api/v2/coaching/appointments/{appointmentId}/statuses":{"get":{"tags":["Coaching"],"summary":"Get the list of status changes for a coaching appointment.","description":"Permission not required if you are an attendee, creator or facilitator of the appointment","operationId":"getCoachingAppointmentStatuses","produces":["application/json"],"parameters":[{"name":"appointmentId","in":"path","description":"The ID of the coaching appointment.","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"Retrieved appointment statuses","schema":{"$ref":"#/definitions/CoachingAppointmentStatusResponseList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"User does not have the appointment status view permission and is not an attendee, creator or facilitator of the appointment"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.not.found":"Appointment not found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","coaching:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:appointmentStatus:view"]},"x-purecloud-method-name":"getCoachingAppointmentStatuses"}},"/api/v2/coaching/appointments/{appointmentId}/status":{"patch":{"tags":["Coaching"],"summary":"Update the status of a coaching appointment","description":"Permission not required if you are an attendee, creator or facilitator of the appointment","operationId":"patchCoachingAppointmentStatus","produces":["application/json"],"parameters":[{"name":"appointmentId","in":"path","description":"The ID of the coaching appointment.","required":true,"type":"string"},{"in":"body","name":"body","description":"Updated status of the coaching appointment","required":true,"schema":{"$ref":"#/definitions/CoachingAppointmentStatusRequest"}}],"responses":{"200":{"description":"The status is posted successfully","schema":{"$ref":"#/definitions/CoachingAppointmentStatusResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","validation.failure":"Failed to valid the appointment status."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"User does not have the appointment status edit permission and is not an attendee, creator or facilitator of the appointment"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.not.found":"Appointment not found","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.state.conflict":"The state of the appointment prevents the changes you are requesting."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:appointmentStatus:edit"]},"x-purecloud-method-name":"patchCoachingAppointmentStatus"}},"/api/v2/users/{userId}/queues/{queueId}":{"patch":{"tags":["Routing","Users"],"summary":"Join or unjoin a queue for a user","description":"","operationId":"patchUserQueue","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Queue Member","required":true,"schema":{"$ref":"#/definitions/UserQueue"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserQueue"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","missing.any.division.permissions":"At least one of the required division permissions is missing"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:join","routing:queueMember:manage"]},"x-purecloud-method-name":"patchUserQueue"}},"/api/v2/outbound/dnclists/{dncListId}/phonenumbers":{"post":{"tags":["Outbound"],"summary":"Add phone numbers to a Dialer DNC list.","description":"Only Internal DNC lists may be appended to","operationId":"postOutboundDnclistPhonenumbers","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"},{"in":"body","name":"body","description":"DNC Phone Numbers","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.source.operation.not.supported":"An attempt was made to append numbers to a DNC list that is not of type Internal","dnc.phone.numbers.per.list.limit.exceeded":"The DNC list has reached the limit on total records. See details","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","dnc.phone.numbers.per.organization.limit.exceeded":"The organization has reached the limit on total DNC records. See details"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.not.found":"The do not call list could not be found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dnc:add"]},"x-purecloud-method-name":"postOutboundDnclistPhonenumbers"}},"/api/v2/speechandtextanalytics/transcripts/search":{"post":{"tags":["Search","Speech & Text Analytics"],"summary":"Search resources.","description":"","operationId":"postSpeechandtextanalyticsTranscriptsSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/TranscriptSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JsonSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","too.many.search.requests":"Rate limit for search requests exceeded"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly","speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationDetail:view","recording:recording:view"]},"x-purecloud-method-name":"postSpeechandtextanalyticsTranscriptsSearch"}},"/api/v2/telephony/providers/edges/phones/reboot":{"post":{"tags":["Telephony Providers Edge"],"summary":"Reboot Multiple Phones","description":"","operationId":"postTelephonyProvidersEdgesPhonesReboot","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Phones","required":true,"schema":{"$ref":"#/definitions/PhonesReboot"}}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","providerapi.error.phone.no.active.edge":"Phone is not connected to an active edge and cannot be rebooted."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesPhonesReboot"}},"/api/v2/contentmanagement/workspaces/{workspaceId}/members":{"get":{"tags":["Content Management"],"summary":"Get a list workspace members","description":"","operationId":"getContentmanagementWorkspaceMembers","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["member"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"member"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkspaceMemberEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden to get workspace members"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementWorkspaceMembers"}},"/api/v2/outbound/campaigns/divisionviews/{campaignId}":{"get":{"tags":["Outbound"],"summary":"Get a basic Campaign information object","description":"This returns a simplified version of a Campaign, consisting of name and division.","operationId":"getOutboundCampaignsDivisionview","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignDivisionView"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:campaign:search"]},"x-purecloud-method-name":"getOutboundCampaignsDivisionview"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}":{"get":{"tags":["Knowledge"],"summary":"Get knowledge base","description":"","operationId":"getKnowledgeKnowledgebase","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","input.validations":"Input paramaters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","404":"Resource not found","not.found":"The requested resource was not found.","kb.not.found":"Knowledge Base does not exist"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:knowledgebase:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebase"},"delete":{"tags":["Knowledge"],"summary":"Delete knowledge base","description":"","operationId":"deleteKnowledgeKnowledgebase","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeBase"}},"204":{"description":"Knowledge base deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","input.validations":"Input paramaters do not match the required criteria"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","404":"Resource not found","not.found":"The requested resource was not found.","kb.not.found":"Knowledge Base does not exist"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"500":"An internal server error occurred","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:knowledgebase:delete"]},"x-purecloud-method-name":"deleteKnowledgeKnowledgebase"},"patch":{"tags":["Knowledge"],"summary":"Update knowledge base","description":"","operationId":"patchKnowledgeKnowledgebase","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeBase"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","input.validations":"Input paramaters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"404":"Resource not found","not.found":"The requested resource was not found.","kb.not.found":"Knowledge Base does not exist"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:knowledgebase:edit"]},"x-purecloud-method-name":"patchKnowledgeKnowledgebase"}},"/api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues":{"get":{"tags":["Content Management"],"summary":"Get a list of workspace tags","description":"","operationId":"getContentmanagementWorkspaceTagvalues","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"value","in":"query","description":"filter the list of tags returned","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["acl"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"acl"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TagValueEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementWorkspaceTagvalues"},"post":{"tags":["Content Management"],"summary":"Create a workspace tag","description":"","operationId":"postContentmanagementWorkspaceTagvalues","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"in":"body","name":"body","description":"tag","required":true,"schema":{"$ref":"#/definitions/TagValue"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TagValue"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"postContentmanagementWorkspaceTagvalues"}},"/api/v2/outbound/dnclists/{dncListId}":{"get":{"tags":["Outbound"],"summary":"Get dialer DNC list","description":"","operationId":"getOutboundDnclist","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"},{"name":"includeImportStatus","in":"query","description":"Import status","required":false,"type":"boolean","default":false},{"name":"includeSize","in":"query","description":"Include size","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DncList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.not.found":"The dialer DNC list was not found.","not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dncList:view"]},"x-purecloud-method-name":"getOutboundDnclist"},"put":{"tags":["Outbound"],"summary":"Update dialer DNC list","description":"","operationId":"putOutboundDnclist","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"},{"in":"body","name":"body","description":"DncList","required":true,"schema":{"$ref":"#/definitions/DncList"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DncList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update":"","name.cannot.be.blank":"A name must be provided.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","duplicate.name":"The name already exists.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","dnc.source.authentication.failed":"External dnc source was not able to authenticate.","dnc.list.phone.columns.empty":"","dnc.source.server.error":"External dnc source returned an error condition","dnc.source.configuration.invalid":"The dnc source configuration is invalid","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.wrong.version":""}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dncList:edit"]},"x-purecloud-method-name":"putOutboundDnclist"},"delete":{"tags":["Outbound"],"summary":"Delete dialer DNC list","description":"","operationId":"deleteOutboundDnclist","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.in.use":"The dialer DNC list is in use.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","referential.integrity.error":"Could not delete the resource because it is referenced by another entity."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dncList:delete"]},"x-purecloud-method-name":"deleteOutboundDnclist"}},"/api/v2/outbound/callanalysisresponsesets":{"get":{"tags":["Outbound"],"summary":"Query a list of dialer call analysis response sets.","description":"","operationId":"getOutboundCallanalysisresponsesets","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"allowEmptyResult","in":"query","description":"Whether to return an empty page when there are no results for that page","required":false,"type":"boolean","default":false},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"],"x-genesys-enum-members":[{"name":"Equals"},{"name":"RegEx"},{"name":"Contains"},{"name":"Prefix"},{"name":"LessThan"},{"name":"LessThanEqualTo"},{"name":"GreaterThan"},{"name":"GreaterThanEqualTo"},{"name":"BeginsWith"},{"name":"EndsWith"}]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseSetEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:responseSet:view"]},"x-purecloud-method-name":"getOutboundCallanalysisresponsesets"},"post":{"tags":["Outbound"],"summary":"Create a dialer call analysis response set.","description":"","operationId":"postOutboundCallanalysisresponsesets","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ResponseSet","required":true,"schema":{"$ref":"#/definitions/ResponseSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","max.entity.count.reached":"The maximum call analysis response set count has been reached.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","duplicate.name":"The name already exists.","invalid.create":"","invalid.flow":"The outbound flow could not be found.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:responseSet:add"]},"x-purecloud-method-name":"postOutboundCallanalysisresponsesets"}},"/api/v2/notifications/channels/{channelId}/subscriptions":{"get":{"tags":["Notifications"],"summary":"The list of all subscriptions for this channel","description":"","operationId":"getNotificationsChannelSubscriptions","produces":["application/json"],"parameters":[{"name":"channelId","in":"path","description":"Channel ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChannelTopicEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["notifications"]}],"x-purecloud-method-name":"getNotificationsChannelSubscriptions"},"post":{"tags":["Notifications"],"summary":"Add a list of subscriptions to the existing list of subscriptions","description":"","operationId":"postNotificationsChannelSubscriptions","produces":["application/json"],"parameters":[{"name":"channelId","in":"path","description":"Channel ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Body","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/ChannelTopic"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChannelTopicEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"notification.subscription.too.many.subscriptions":"Too many subscriptions","notification.invalid.topic":"The subscription topic is not valid.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","notification.unable.to.get.channel.id":"Unable to get channel Id.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","notification.unauthorized.topic":"Not authorized for this topic.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["notifications"]}],"x-purecloud-method-name":"postNotificationsChannelSubscriptions"},"put":{"tags":["Notifications"],"summary":"Replace the current list of subscriptions with a new list.","description":"","operationId":"putNotificationsChannelSubscriptions","produces":["application/json"],"parameters":[{"name":"channelId","in":"path","description":"Channel ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Body","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/ChannelTopic"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChannelTopicEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"notification.subscription.too.many.subscriptions":"Too many subscriptions.","notification.invalid.topic":"The subscription topic is not valid.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","notification.unable.to.get.channel.id":"Unable to get channel id.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","notification.unauthorized.topic":"Not authorized for this topic.","notification.forbidden.topic":"Topic is forbidden","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"The service is currently unavailable."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["notifications"]}],"x-purecloud-method-name":"putNotificationsChannelSubscriptions"},"delete":{"tags":["Notifications"],"summary":"Remove all subscriptions","description":"","operationId":"deleteNotificationsChannelSubscriptions","produces":["application/json"],"parameters":[{"name":"channelId","in":"path","description":"Channel ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["notifications"]}],"x-purecloud-method-name":"deleteNotificationsChannelSubscriptions"}},"/api/v2/outbound/schedules/sequences":{"get":{"tags":["Outbound"],"summary":"Query for a list of dialer sequence schedules.","description":"","operationId":"getOutboundSchedulesSequences","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/SequenceSchedule"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.interval.time":"","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:schedule:view"]},"x-purecloud-method-name":"getOutboundSchedulesSequences"}},"/api/v2/quality/evaluations/scoring":{"post":{"tags":["Quality"],"summary":"Score evaluation","description":"","operationId":"postQualityEvaluationsScoring","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"evaluationAndScoringSet","required":true,"schema":{"$ref":"#/definitions/EvaluationFormAndScoringSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationScoringSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.scoring.unanswered.required.questions":"Submitted answers did not contain a response to a required question","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","quality.scoring.answer.not.in.evaluation.form":"Submitted answers contained reference to an answer which is not in the evaluation form","general.bad.request":"Request is badly formed.","quality.scoring.question.not.in.evaluation.form":"Submitted answers contained reference to a question which is not in the evaluation form","quality.scoring.question.group.not.in.evaluation.form":"Submitted answers contained reference to a question group which is not in the evaluation form","quality.scoring.unanswered.required.comments":"Submitted answers did not contain a comment where it was required","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-purecloud-method-name":"postQualityEvaluationsScoring"}},"/api/v2/externalcontacts/organizations/{externalOrganizationId}/trustor":{"delete":{"tags":["External Contacts"],"summary":"Unlink the Trustor for this External Organization","description":"","operationId":"deleteExternalcontactsOrganizationTrustor","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization ID","required":true,"type":"string"}],"responses":{"204":{"description":"Trustor link has been deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:externalOrganization:edit"]},"x-purecloud-method-name":"deleteExternalcontactsOrganizationTrustor"}},"/api/v2/architect/ivrs/{ivrId}":{"get":{"tags":["Architect"],"summary":"Get an IVR config.","description":"","operationId":"getArchitectIvr","produces":["application/json"],"parameters":[{"name":"ivrId","in":"path","description":"IVR id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IVR"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:callRoute:view"]},"x-purecloud-method-name":"getArchitectIvr"},"put":{"tags":["Architect"],"summary":"Update an IVR Config.","description":"","operationId":"putArchitectIvr","produces":["application/json"],"parameters":[{"name":"ivrId","in":"path","description":"IVR id","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/IVR"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IVR"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:callRoute:edit"]},"x-purecloud-method-name":"putArchitectIvr"},"delete":{"tags":["Architect"],"summary":"Delete an IVR Config.","description":"","operationId":"deleteArchitectIvr","produces":["application/json"],"parameters":[{"name":"ivrId","in":"path","description":"IVR id","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Could not find the IVR config supplied","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"Conflict occurred while deleting an IVR Config."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:callRoute:delete"]},"x-purecloud-method-name":"deleteArchitectIvr"}},"/api/v2/telephony/providers/edges/{edgeId}/unpair":{"post":{"tags":["Telephony Providers Edge"],"summary":"Unpair an Edge","description":"","operationId":"postTelephonyProvidersEdgeUnpair","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","managed.property.not.allowed":"Not allowed to set managed property."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conflict":"The Edge must have an inactive state to complete this operation."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgeUnpair"}},"/api/v2/users/development/activities/me":{"get":{"tags":["Users"],"summary":"Get list of Development Activities for current user","description":"Results are filtered based on the applicable permissions.","operationId":"getUsersDevelopmentActivitiesMe","produces":["application/json"],"parameters":[{"name":"moduleId","in":"query","description":"Specifies the ID of the learning module.","required":false,"type":"string"},{"name":"interval","in":"query","description":"Specifies the dateDue range to be queried. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. 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","required":false,"type":"string","format":"interval"},{"name":"completionInterval","in":"query","description":"Specifies the range of completion dates to be used for filtering. A maximum of 1 year can be specified in the range. 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","required":false,"type":"string","format":"interval"},{"name":"overdue","in":"query","description":"Specifies if non-overdue, overdue, or all activities are returned. If not specified, all activities are returned","required":false,"type":"string","default":"Any","enum":["True","False","Any"],"x-genesys-enum-members":[{"name":"True","description":"Return only activities which are overdue"},{"name":"False","description":"Return only activities which are non-overdue"},{"name":"Any","description":"Return all activities"}]},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Specifies result set sort order sorted by the date due; if not specified, default sort order is descending (Desc)","required":false,"type":"string","default":"Desc","enum":["Asc","Desc"],"x-genesys-enum-members":[{"name":"Asc"},{"name":"Desc"}]},{"name":"types","in":"query","description":"Specifies the activity types.","required":false,"type":"array","items":{"type":"string","enum":["Informational","Coaching"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"Informational"},{"name":"Coaching"}]},{"name":"statuses","in":"query","description":"Specifies the activity statuses to filter by","required":false,"type":"array","items":{"type":"string","enum":["Planned","InProgress","Completed","InvalidSchedule"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"Planned"},{"name":"InProgress"},{"name":"Completed"},{"name":"InvalidSchedule"}]},{"name":"relationship","in":"query","description":"Specifies how the current user relation should be interpreted, and filters the activities returned to only those that have the specified relationship. If not specified, all relationships are returned.","required":false,"type":"array","items":{"type":"string","enum":["Creator","Facilitator","Attendee"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"Creator"},{"name":"Facilitator"},{"name":"Attendee"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DevelopmentActivityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","wem.learning.forbidden":"The operation failed as the action is forbidden"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","coaching:readonly","learning","learning:readonly"]}],"x-purecloud-method-name":"getUsersDevelopmentActivitiesMe"}},"/api/v2/users/development/activities/{activityId}":{"get":{"tags":["Users"],"summary":"Get a Development Activity","description":"Permission not required if you are the attendee, creator or facilitator of the coaching appointment or you are the assigned user of the learning assignment.","operationId":"getUsersDevelopmentActivity","produces":["application/json"],"parameters":[{"name":"activityId","in":"path","description":"Specifies the activity ID, maps to either assignment or appointment ID","required":true,"type":"string"},{"name":"type","in":"query","description":"Specifies the activity type.","required":true,"type":"string","enum":["Informational","Coaching"],"x-genesys-enum-members":[{"name":"Informational"},{"name":"Coaching"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DevelopmentActivity"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","wem.learning.forbidden":"The operation failed as the action is forbidden"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","coaching:readonly","learning","learning:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:assignment:view","coaching:appointment:view"]},"x-purecloud-method-name":"getUsersDevelopmentActivity"}},"/api/v2/users/development/activities":{"get":{"tags":["Users"],"summary":"Get list of Development Activities","description":"Either moduleId or userId is required. Results are filtered based on the applicable permissions.","operationId":"getUsersDevelopmentActivities","produces":["application/json"],"parameters":[{"name":"userId","in":"query","description":"Specifies the list of user IDs to be queried, up to 100 user IDs. It searches for any relationship for the userId.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"moduleId","in":"query","description":"Specifies the ID of the learning module.","required":false,"type":"string"},{"name":"interval","in":"query","description":"Specifies the dateDue range to be queried. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. 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","required":false,"type":"string","format":"interval"},{"name":"completionInterval","in":"query","description":"Specifies the range of completion dates to be used for filtering. A maximum of 1 year can be specified in the range. 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","required":false,"type":"string","format":"interval"},{"name":"overdue","in":"query","description":"Specifies if non-overdue, overdue, or all activities are returned. If not specified, all activities are returned","required":false,"type":"string","default":"Any","enum":["True","False","Any"],"x-genesys-enum-members":[{"name":"True","description":"Return only activities which are overdue"},{"name":"False","description":"Return only activities which are non-overdue"},{"name":"Any","description":"Return all activities"}]},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Specifies result set sort order sorted by the date due; if not specified, default sort order is descending (Desc)","required":false,"type":"string","default":"Desc","enum":["Asc","Desc"],"x-genesys-enum-members":[{"name":"Asc"},{"name":"Desc"}]},{"name":"types","in":"query","description":"Specifies the activity types.","required":false,"type":"array","items":{"type":"string","enum":["Informational","Coaching"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"Informational"},{"name":"Coaching"}]},{"name":"statuses","in":"query","description":"Specifies the activity statuses to filter by","required":false,"type":"array","items":{"type":"string","enum":["Planned","InProgress","Completed","InvalidSchedule"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"Planned"},{"name":"InProgress"},{"name":"Completed"},{"name":"InvalidSchedule"}]},{"name":"relationship","in":"query","description":"Specifies how the current user relation should be interpreted, and filters the activities returned to only those that have the specified relationship. If not specified, all relationships are returned.","required":false,"type":"array","items":{"type":"string","enum":["Creator","Facilitator","Attendee"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"Creator"},{"name":"Facilitator"},{"name":"Attendee"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DevelopmentActivityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","wem.learning.forbidden":"The operation failed as the action is forbidden"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","coaching:readonly","learning","learning:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:assignment:view","coaching:appointment:view"]},"x-purecloud-method-name":"getUsersDevelopmentActivities"}},"/api/v2/scripts":{"get":{"tags":["Scripts"],"summary":"Get the list of scripts","description":"","operationId":"getScripts","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"Expand","required":false,"type":"string"},{"name":"name","in":"query","description":"Name filter","required":false,"type":"string"},{"name":"feature","in":"query","description":"Feature filter","required":false,"type":"string"},{"name":"flowId","in":"query","description":"Secure flow id filter","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"SortBy","required":false,"type":"string","enum":["modifiedDate","createdDate"],"x-genesys-enum-members":[{"name":"modifiedDate"},{"name":"createdDate"}]},{"name":"sortOrder","in":"query","description":"SortOrder","required":false,"type":"string","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]},{"name":"scriptDataVersion","in":"query","description":"Advanced usage - controls the data version of the script","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScriptEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:script:view"]},"x-purecloud-method-name":"getScripts"}},"/api/v2/outbound/campaignrules/{campaignRuleId}":{"get":{"tags":["Outbound"],"summary":"Get Campaign Rule","description":"","operationId":"getOutboundCampaignrule","produces":["application/json"],"parameters":[{"name":"campaignRuleId","in":"path","description":"Campaign Rule ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaignRule:view"]},"x-purecloud-method-name":"getOutboundCampaignrule"},"put":{"tags":["Outbound"],"summary":"Update Campaign Rule","description":"","operationId":"putOutboundCampaignrule","produces":["application/json"],"parameters":[{"name":"campaignRuleId","in":"path","description":"Campaign Rule ID","required":true,"type":"string"},{"in":"body","name":"body","description":"CampaignRule","required":true,"schema":{"$ref":"#/definitions/CampaignRule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"incorrect.max.value":"Max values must be > 0 and one of them must be defined","name.cannot.be.blank":"A name must be provided.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","missing.campaign.rule.conditions":"Campaign rule must have a condition.","invalid.campaign.rule.action.parameter":"Campaign rule action has an invalid parameter.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","missing.campaign.rule.condition.value":"Campaign rule condition must have an value.","missing.campaign.rule.entity":"Campaign rule must have an entity for conditions.","missing.campaign.rule.action.parameters":"Campaign rule action must have a parameter.","invalid.campaign.rule.condition.operator":"Campaign rule condition has an invalid operator.","cannot.modify.enabled.campaign.rule":"Cannot modify a rule that is enabled.","invalid.campaign.rule.condition.parameter":"Campaign rule condition has an invalid parameter.","missing.campaign.rule.condition.parameters":"Campaign rule condition must have a parameter.","missing.campaign.rule.action.type":"Campaign rule action must have a type.","missing.campaign.rule.condition.type":"Campaign rule condition must have a type.","invalid.external.campaign.dialingmode.transition":"Cannot change to/from external dialing mode to/from another dialing mode.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.campaign.rule.condition.value":"Campaign rule condition has an invalid value.","missing.campaign.rule.actions":"Campaign rule must have an action.","missing.campaign.rule.condition.operator":"Campaign rule condition must have an operator.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","missing.campaign.rule.action.entity":"Campaign rule must have an action entity."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.wrong.version":""}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaignRule:edit"]},"x-purecloud-method-name":"putOutboundCampaignrule"},"delete":{"tags":["Outbound"],"summary":"Delete Campaign Rule","description":"","operationId":"deleteOutboundCampaignrule","produces":["application/json"],"parameters":[{"name":"campaignRuleId","in":"path","description":"Campaign Rule ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","referential.integrity.error":"Could not delete the resource because it is referenced by another entity.","cannot.delete.enabled.campaign.rule":"Cannot delete a rule that is enabled."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaignRule:delete"]},"x-purecloud-method-name":"deleteOutboundCampaignrule"}},"/api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Phone Base Settings object by ID","description":"","operationId":"getTelephonyProvidersEdgesPhonebasesetting","produces":["application/json"],"parameters":[{"name":"phoneBaseId","in":"path","description":"Phone base ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhoneBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Unable to find a phone with that id.","general.resource.not.found":"Unable to find a Phone Base Settings with that id.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unable.to.expand.properties":"Server error, unable to expand base setting properties.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesPhonebasesetting"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a Phone Base Settings by ID","description":"","operationId":"putTelephonyProvidersEdgesPhonebasesetting","produces":["application/json"],"parameters":[{"name":"phoneBaseId","in":"path","description":"Phone base ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Phone base settings","required":true,"schema":{"$ref":"#/definitions/PhoneBase"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhoneBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Unable to find a phone with that id","general.resource.not.found":"Unable to find a phone with that id","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesPhonebasesetting"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a Phone Base Settings by ID","description":"","operationId":"deleteTelephonyProvidersEdgesPhonebasesetting","produces":["application/json"],"parameters":[{"name":"phoneBaseId","in":"path","description":"Phone base ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to delete Phone Base Settings with that id.","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"Phone template cannot be modified in current state."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdgesPhonebasesetting"}},"/api/v2/outbound/messagingcampaigns/progress":{"post":{"tags":["Outbound"],"summary":"Get progress for a list of messaging campaigns","description":"","operationId":"postOutboundMessagingcampaignsProgress","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Messaging Campaign IDs","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/CampaignProgress"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"callback.error.missing.callback.numbers":"Callback numbers missing","callback.error.missing.queue.id":"Callback missing queue ID","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaign:view"]},"x-purecloud-method-name":"postOutboundMessagingcampaignsProgress"}},"/api/v2/flows/datatables/{datatableId}/import/jobs/{importJobId}":{"get":{"tags":["Architect"],"summary":"Returns the state information about an import job","description":"Returns the state information about an import job.","operationId":"getFlowsDatatableImportJob","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"name":"importJobId","in":"path","description":"id of import job","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataTableImportJob"}},"202":{"description":"Request Accepted","schema":{"$ref":"#/definitions/DataTableImportJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","flows.datatables.session.not.found":"A session was not found"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:view"]},"x-purecloud-method-name":"getFlowsDatatableImportJob"}},"/api/v2/telephony/providers/edges/sites/{siteId}/numberplans/classifications":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of Classifications for this Site","description":"","operationId":"getTelephonyProvidersEdgesSiteNumberplansClassifications","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"name":"classification","in":"query","description":"Classification","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","uniqueItems":true,"items":{"type":"string"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesSiteNumberplansClassifications"}},"/api/v2/users/me":{"get":{"tags":["Users"],"summary":"Get current user details.","description":"This request is not valid when using the Client Credentials OAuth grant.","operationId":"getUsersMe","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography","date","geolocationsettings","organization","presencedefinitions","locationdefinitions","orgauthorization","orgproducts","favorites","superiors","directreports","adjacents","routingskills","routinglanguages","fieldconfigs","token","trustors","logCapture"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"routingStatus"},{"name":"presence"},{"name":"conversationSummary"},{"name":"outOfOffice"},{"name":"geolocation"},{"name":"station"},{"name":"authorization"},{"name":"lasttokenissued"},{"name":"authorization.unusedRoles"},{"name":"team"},{"name":"profileSkills"},{"name":"certifications"},{"name":"locations"},{"name":"groups"},{"name":"skills"},{"name":"languages"},{"name":"languagePreference"},{"name":"employerInfo"},{"name":"biography"},{"name":"date"},{"name":"geolocationsettings"},{"name":"organization"},{"name":"presencedefinitions"},{"name":"locationdefinitions"},{"name":"orgauthorization"},{"name":"orgproducts"},{"name":"favorites"},{"name":"superiors"},{"name":"directreports"},{"name":"adjacents"},{"name":"routingskills"},{"name":"routinglanguages"},{"name":"fieldconfigs"},{"name":"token"},{"name":"trustors"},{"name":"logCapture"}]},{"name":"integrationPresenceSource","in":"query","description":"Get your presence for a given integration. This parameter will only be used when presence is provided as an \"expand\".","required":false,"type":"string","enum":["MicrosoftTeams","ZoomPhone","RingCentral"],"x-genesys-enum-members":[{"name":"MicrosoftTeams"},{"name":"ZoomPhone"},{"name":"RingCentral"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserMe"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The requested userID could not be found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["user-basic-info"]}],"x-purecloud-method-name":"getUsersMe"}},"/api/v2/architect/ivrs":{"get":{"tags":["Architect"],"summary":"Get IVR configs.","description":"","operationId":"getArchitectIvrs","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"name","in":"query","description":"Name of the IVR to filter by.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IVREntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:callRoute:view"]},"x-purecloud-method-name":"getArchitectIvrs"},"post":{"tags":["Architect"],"summary":"Create IVR config.","description":"","operationId":"postArchitectIvrs","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/IVR"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IVR"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:callRoute:add"]},"x-purecloud-method-name":"postArchitectIvrs"}},"/api/v2/telephony/providers/edges/trunks/metrics":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the metrics for a list of trunks.","description":"","operationId":"getTelephonyProvidersEdgesTrunksMetrics","produces":["application/json"],"parameters":[{"name":"trunkIds","in":"query","description":"Comma separated list of Trunk Id's","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/TrunkMetrics"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesTrunksMetrics"}},"/api/v2/quality/publishedforms":{"get":{"tags":["Quality"],"summary":"Get the published evaluation forms.","description":"","operationId":"getQualityPublishedforms","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"onlyLatestPerContext","in":"query","description":"onlyLatestPerContext","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:view"]},"x-purecloud-method-name":"getQualityPublishedforms"},"post":{"tags":["Quality"],"summary":"Publish an evaluation form.","description":"","operationId":"postQualityPublishedforms","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Publish request containing id of form to publish","required":true,"schema":{"$ref":"#/definitions/PublishForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"evaluation.already.published":"Evaluation has already been published."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:add"]},"x-purecloud-method-name":"postQualityPublishedforms"}},"/api/v2/architect/prompts/{promptId}/resources/{languageCode}":{"get":{"tags":["Architect"],"summary":"Get specified user prompt resource","description":"","operationId":"getArchitectPromptResource","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PromptAsset"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.not.found":"Could not find resource with specified prompt.","not.found":"The requested resource was not found.","architect.prompt.resource.not.found":"Could not find resource with specified language in specified prompt."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:view"]},"x-purecloud-method-name":"getArchitectPromptResource"},"put":{"tags":["Architect"],"summary":"Update specified user prompt resource","description":"","operationId":"putArchitectPromptResource","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/PromptAsset"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PromptAsset"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.resource.invalid.tags":"The specified tags are in an invalid format.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","architect.object.validate.failed":"Failed to validate object.","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.prompt.resource.not.found":"Could not find resource with specified language in specified prompt."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.resource.tags.already.exist":"The specified tags already exist in another prompt resource."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.object.update.failed":"The database update for the object failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:edit"]},"x-purecloud-method-name":"putArchitectPromptResource"},"delete":{"tags":["Architect"],"summary":"Delete specified user prompt resource","description":"","operationId":"deleteArchitectPromptResource","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.not.found":"Could not find prompt with specified ID.","architect.flow.data.missing":"Flow version data content is missing.","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.dependency.object.in.use":"The object cannot be deleted because other objects depend on it."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","architect.database.throughput.exceeded":"Database too busy. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:edit"]},"x-purecloud-method-name":"deleteArchitectPromptResource"}},"/api/v2/architect/prompts/{promptId}/resources/{languageCode}/audio":{"delete":{"tags":["Architect"],"summary":"Delete specified user prompt resource audio","description":"","operationId":"deleteArchitectPromptResourceAudio","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language","required":true,"type":"string"}],"responses":{"204":{"description":"Audio successfully deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.not.found":"Could not find prompt with specified ID.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.resource.audio.cannot.delete":"Failed to delete the audio for the resource.","architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","architect.database.throughput.exceeded":"Database too busy. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:edit"]},"x-purecloud-method-name":"deleteArchitectPromptResourceAudio"}},"/api/v2/conversations/messaging/integrations/whatsapp":{"get":{"tags":["Conversations"],"summary":"Get a list of WhatsApp Integrations","description":"","operationId":"getConversationsMessagingIntegrationsWhatsapp","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WhatsAppIntegrationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:view"]},"x-purecloud-method-name":"getConversationsMessagingIntegrationsWhatsapp"},"post":{"tags":["Conversations"],"summary":"Create a WhatsApp Integration","description":"You must be approved by WhatsApp to use this feature. Your approved e164-formatted phone number and valid WhatsApp certificate for your number are required. Your WhatsApp certificate must have valid base64 encoding. Please paste carefully and do not add any leading or trailing spaces. Do not alter any characters. An integration must be activated within 7 days of certificate generation. If you cannot complete the addition and activation of the number within 7 days, please obtain a new certificate before creating the integration. Integrations created with an invalid number or certificate may immediately incur additional integration fees. Please carefully enter your number and certificate as described.","operationId":"postConversationsMessagingIntegrationsWhatsapp","produces":["application/json"],"parameters":[{"name":"async","in":"query","description":"Create a WhatsApp integration in an asynchronous manner. If the parameter value is true, this initiates the generation of a new WhatsApp integration. An integration ID is returned, it can be used to query the integration. Check the integration's createStatus for Completed or Error to detect the create is finished.","required":false,"type":"boolean","default":false},{"in":"body","name":"body","description":"WhatsAppIntegrationRequest","required":true,"schema":{"$ref":"#/definitions/WhatsAppIntegrationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WhatsAppIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.integration":"The integration request was invalid for this operation. One or more errors may be reported.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:whatsappIntegration:add"]},"x-purecloud-method-name":"postConversationsMessagingIntegrationsWhatsapp"}},"/api/v2/outbound/contactlists/divisionviews/{contactListId}":{"get":{"tags":["Outbound"],"summary":"Get a basic ContactList information object","description":"This returns a simplified version of a ContactList, consisting of the name, division, column names, phone columns, import status, and size.","operationId":"getOutboundContactlistsDivisionview","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contactlist ID","required":true,"type":"string"},{"name":"includeImportStatus","in":"query","description":"Include import status","required":false,"type":"boolean","default":false},{"name":"includeSize","in":"query","description":"Include size","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListDivisionView"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:contactList:search"]},"x-purecloud-method-name":"getOutboundContactlistsDivisionview"}},"/api/v2/analytics/reporting/{reportId}/metadata":{"get":{"tags":["Analytics"],"summary":"Get a reporting metadata.","description":"","operationId":"getAnalyticsReportingReportIdMetadata","produces":["application/json"],"parameters":[{"name":"reportId","in":"path","description":"Report ID","required":true,"type":"string"},{"name":"locale","in":"query","description":"Locale","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportMetaData"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["reporting:acd:view, reporting:status:view, reporting:interactions:view, reporting:outbound:view, reporting:quality:view, employee"]},"x-purecloud-method-name":"getAnalyticsReportingReportIdMetadata"}},"/api/v2/flows/datatables/{datatableId}/rows/{rowId}":{"get":{"tags":["Architect"],"summary":"Returns a specific row for the datatable","description":"Given a datatableId and a rowId (the value of the key field) this will return the full row contents for that rowId.","operationId":"getFlowsDatatableRow","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"name":"rowId","in":"path","description":"The key for the row","required":true,"type":"string"},{"name":"showbrief","in":"query","description":"if true returns just the key field for the row","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","flows.datatables.syntax.error":"There was an error parsing user data","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.table.not.found":"The datatable could not be found.","not.found":"The requested resource was not found.","flows.datatables.row.not.found":"The datatable row could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:view"]},"x-purecloud-method-name":"getFlowsDatatableRow"},"put":{"tags":["Architect"],"summary":"Update a row entry","description":"Updates a row with the given rowId (the value of the key field) to the new values. The DataTableRow should be a json-ized' stream of key -> value pairs\n{\n \"Field1\": \"XYZZY\",\n \"Field2\": false,\n \"KEY\": \"27272\"\n}","operationId":"putFlowsDatatableRow","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"name":"rowId","in":"path","description":"the key for the row","required":true,"type":"string"},{"in":"body","name":"body","description":"datatable row","required":false,"schema":{"type":"object","additionalProperties":{"type":"object"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.schema.exception":"The row didn't conform to the schema in some way","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","flows.datatables.syntax.error":"There was an error parsing user data","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"The application is not authorized for the scope.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.table.not.found":"The datatable could not be found.","not.found":"The requested resource was not found.","flows.datatables.row.not.found":"The datatable row could not be found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.not.unique":"The row had a duplicate keyname."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:edit"]},"x-purecloud-method-name":"putFlowsDatatableRow"},"delete":{"tags":["Architect"],"summary":"Delete a row entry","description":"Deletes a row with a given rowId (the value of the key field).","operationId":"deleteFlowsDatatableRow","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"name":"rowId","in":"path","description":"the key for the row","required":true,"type":"string"}],"responses":{"204":{"description":"The row was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","flows.datatables.syntax.error":"There was an error parsing user data"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:delete"]},"x-purecloud-method-name":"deleteFlowsDatatableRow"}},"/api/v2/conversations/messaging/stickers/{messengerType}":{"get":{"tags":["Conversations"],"summary":"Get a list of Messaging Stickers","description":"","operationId":"getConversationsMessagingSticker","produces":["application/json"],"parameters":[{"name":"messengerType","in":"path","description":"Messenger Type","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingStickerEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["conversation:message:create"]},"x-purecloud-method-name":"getConversationsMessagingSticker"}},"/api/v2/journey/outcomes":{"get":{"tags":["Journey"],"summary":"Retrieve all outcomes.","description":"","operationId":"getJourneyOutcomes","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Field(s) to sort by. The response can be sorted by any first level property on the Outcome response. Prefix with '-' for descending (e.g. sortBy=displayName,-createdDate).","required":false,"type":"string"},{"name":"outcomeIds","in":"query","description":"IDs of outcomes to return. Use of this parameter is not compatible with pagination or sorting. A maximum of 20 outcomes are allowed per request.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutcomeListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:outcome:view"]},"x-purecloud-method-name":"getJourneyOutcomes"},"post":{"tags":["Journey"],"summary":"Create an outcome.","description":"","operationId":"postJourneyOutcomes","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/Outcome"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Outcome"}},"201":{"description":"Outcome created.","schema":{"$ref":"#/definitions/Outcome"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:outcome:add"]},"x-purecloud-method-name":"postJourneyOutcomes"}},"/api/v2/groups/{groupId}/profile":{"get":{"tags":["Groups"],"summary":"Get group profile","description":"This api is deprecated. Use /api/v2/groups instead","operationId":"getGroupProfile","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"groupId","required":true,"type":"string"},{"name":"fields","in":"query","description":"Comma separated fields to return. Allowable values can be found by querying /api/v2/fieldconfig?type=group and using the key for the elements returned by the fieldList","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GroupProfile"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find the group profile","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups","groups:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getGroupProfile"}},"/api/v2/contentmanagement/securityprofiles/{securityProfileId}":{"get":{"tags":["Content Management"],"summary":"Get a Security Profile","description":"","operationId":"getContentmanagementSecurityprofile","produces":["application/json"],"parameters":[{"name":"securityProfileId","in":"path","description":"Security Profile Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SecurityProfile"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementSecurityprofile"}},"/api/v2/telephony/providers/edges/edgegroups":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of edge groups.","description":"","operationId":"getTelephonyProvidersEdgesEdgegroups","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"managed","in":"query","description":"Filter by managed","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeGroupEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Edge groups not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesEdgegroups"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create an edge group.","description":"","operationId":"postTelephonyProvidersEdgesEdgegroups","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"EdgeGroup","required":true,"schema":{"$ref":"#/definitions/EdgeGroup"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"required.field.missing":"A required field is missing a value.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.value":"An edge group with this name already exists.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesEdgegroups"}},"/api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId}":{"get":{"tags":["Recording"],"summary":"Get annotation","description":"","operationId":"getConversationRecordingAnnotation","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"recordingId","in":"path","description":"Recording ID","required":true,"type":"string"},{"name":"annotationId","in":"path","description":"Annotation ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Annotation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","recording.annotation.view.permission.check.failed":"Failed to verify view annotation permission"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","recording.annotation.not.found":"The recording annotation was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:annotation:view"]},"x-purecloud-method-name":"getConversationRecordingAnnotation"},"put":{"tags":["Recording"],"summary":"Update annotation","description":"","operationId":"putConversationRecordingAnnotation","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"recordingId","in":"path","description":"Recording ID","required":true,"type":"string"},{"name":"annotationId","in":"path","description":"Annotation ID","required":true,"type":"string"},{"in":"body","name":"body","description":"annotation","required":true,"schema":{"$ref":"#/definitions/Annotation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Annotation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","recording.invalid.json":"Request contains invalid JSON.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.recording.view.permission.check.failed":"Failed to verify recording view permission.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","recording.annotation.update.permission.check.failed":"Failed to verify recording update permission."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:annotation:edit"]},"x-purecloud-method-name":"putConversationRecordingAnnotation"},"delete":{"tags":["Recording"],"summary":"Delete annotation","description":"","operationId":"deleteConversationRecordingAnnotation","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"recordingId","in":"path","description":"Recording ID","required":true,"type":"string"},{"name":"annotationId","in":"path","description":"Annotation ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.annotation.cant.delete.for.another.user":"Can't delete a recording annotation for another user.","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","recording.annotation.delete.permission.check.failed":"Failed to verify recording delete permission."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:annotation:delete"]},"x-purecloud-method-name":"deleteConversationRecordingAnnotation"}},"/api/v2/languageunderstanding/domains/{domainId}/versions":{"get":{"tags":["Language Understanding"],"summary":"Get all NLU Domain Versions for a given Domain.","description":"","operationId":"getLanguageunderstandingDomainVersions","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"includeUtterances","in":"query","description":"Whether utterances for intent definition should be included when marshalling response.","required":false,"type":"boolean"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluDomainVersionListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","dialog:readonly","language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomainVersion:view","dialog:botVersion:view"]},"x-purecloud-method-name":"getLanguageunderstandingDomainVersions"},"post":{"tags":["Language Understanding"],"summary":"Create an NLU Domain Version.","description":"","operationId":"postLanguageunderstandingDomainVersions","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"in":"body","name":"body","description":"The NLU Domain Version to create.","required":true,"schema":{"$ref":"#/definitions/NluDomainVersion"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluDomainVersion"}},"201":{"description":"Created an NLU Domain Version","schema":{"$ref":"#/definitions/NluDomainVersion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","language-understanding"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomainVersion:add","dialog:botVersion:add"]},"x-purecloud-method-name":"postLanguageunderstandingDomainVersions"}},"/api/v2/flows/milestones/{milestoneId}":{"get":{"tags":["Architect"],"summary":"Get a flow milestone","description":"Returns a specified flow milestone","operationId":"getFlowsMilestone","produces":["application/json"],"parameters":[{"name":"milestoneId","in":"path","description":"flow milestone ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowMilestone"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.milestone.not.found":"Specified flow milestone not found.","not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.feature.unavailable":"Flow milestones feature is not available for current organization."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowMilestone:view"]},"x-purecloud-method-name":"getFlowsMilestone"},"put":{"tags":["Architect"],"summary":"Updates a flow milestone","description":"","operationId":"putFlowsMilestone","produces":["application/json"],"parameters":[{"name":"milestoneId","in":"path","description":"flow milestone ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/FlowMilestone"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowMilestone"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.milestone.validate.failed.invalid.name.no.alpha":"Failed to validate flow milestone due to invalid name. Names must contain at least one alphanumeric character.","architect.flow.milestone.validate.failed.invalid.name.spaces":"Failed to validate flow milestone due to invalid name. Names must not contain leading or trailing whitespaces.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","architect.property.exceeds.max.character.length":"The name and/or description exceeds the maximum character length.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","architect.object.validate.failed":"Failed to validate object.","architect.flow.milestone.validate.failed.missing.name":"Failed to validate flow milestone due to missing name.","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.milestone.not.found":"Could not find the specified flow milestone.","not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.feature.unavailable":"Flow milestones feature is not available for current organization."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.milestone.already.exists":"A flow milestone with the specified name already exists."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.unspecified.error":"An unknown error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowMilestone:edit"]},"x-purecloud-method-name":"putFlowsMilestone"},"delete":{"tags":["Architect"],"summary":"Delete a flow milestone.","description":"","operationId":"deleteFlowsMilestone","produces":["application/json"],"parameters":[{"name":"milestoneId","in":"path","description":"flow milestone ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"204":{"description":"Delete was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.milestone.not.found":"Could not find the specified flow milestone.","not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.feature.unavailable":"Flow milestones feature is not available for current organization."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.dependency.object.in.use":"The object cannot be deleted because other objects depend on it."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.unspecified.error":"An unknown error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowMilestone:delete"]},"x-purecloud-method-name":"deleteFlowsMilestone"}},"/api/v2/orgauthorization/pairings/{pairingId}":{"get":{"tags":["Organization Authorization"],"summary":"Get Pairing Info","description":"","operationId":"getOrgauthorizationPairing","produces":["application/json"],"parameters":[{"name":"pairingId","in":"path","description":"Pairing Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustRequest"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrustee:view","authorization:orgTrustor:view"]},"x-purecloud-method-name":"getOrgauthorizationPairing"}},"/api/v2/telephony/providers/edges/sites/{siteId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Site by ID.","description":"","operationId":"getTelephonyProvidersEdgesSite","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Site"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Unable to find a site with that id","general.resource.not.found":"Unable to find a site with that id","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all","telephony:sites:view"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesSite"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a Site by ID.","description":"","operationId":"putTelephonyProvidersEdgesSite","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Site","required":true,"schema":{"$ref":"#/definitions/Site"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Site"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","referenced.key.does.not.exist":"The request could not be understood by the server due to malformed syntax.","managed.property.not.allowed":"Not allowed to update managed property","duplicate.value":"At least one of the values in the request were a duplicate.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","managed.property.not.allowed":"NEEDED"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Unable to find a site with that id","general.resource.not.found":"Unable to find a site with that id","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesSite"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a Site by ID","description":"","operationId":"deleteTelephonyProvidersEdgesSite","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","managed.property.not.allowed":"Not allowed to delete a managed site."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Unable to find a site with that id","general.resource.not.found":"Unable to find a site with that id","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"resource.referenced.by.another":"The site is referenced by another resource.","general.conflict":"The site is being referenced or is set as the default site."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdgesSite"}},"/api/v2/orgauthorization/trustors/{trustorOrgId}":{"get":{"tags":["Organization Authorization"],"summary":"Get Org Trust","description":"","operationId":"getOrgauthorizationTrustor","produces":["application/json"],"parameters":[{"name":"trustorOrgId","in":"path","description":"Trustor Organization Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Trustor"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrustor:view"]},"x-purecloud-method-name":"getOrgauthorizationTrustor"},"delete":{"tags":["Organization Authorization"],"summary":"Delete Org Trust","description":"","operationId":"deleteOrgauthorizationTrustor","produces":["application/json"],"parameters":[{"name":"trustorOrgId","in":"path","description":"Trustor Organization Id","required":true,"type":"string"}],"responses":{"204":{"description":"Trust deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrustor:delete"]},"x-purecloud-method-name":"deleteOrgauthorizationTrustor"}},"/api/v2/workforcemanagement/notifications":{"get":{"tags":["Workforce Management"],"summary":"Get a list of notifications for the current user","description":"","operationId":"getWorkforcemanagementNotifications","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NotificationsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-purecloud-method-name":"getWorkforcemanagementNotifications"}},"/api/v2/workforcemanagement/notifications/update":{"post":{"tags":["Workforce Management"],"summary":"Mark a list of notifications as read or unread","description":"","operationId":"postWorkforcemanagementNotificationsUpdate","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/UpdateNotificationsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UpdateNotificationsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-purecloud-method-name":"postWorkforcemanagementNotificationsUpdate"}},"/api/v2/quality/evaluations/query":{"get":{"tags":["Quality"],"summary":"Queries Evaluations and returns a paged list","description":"Query params must include one of conversationId, evaluatorUserId, or agentUserId","operationId":"getQualityEvaluationsQuery","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"conversationId","in":"query","description":"conversationId specified","required":false,"type":"string"},{"name":"agentUserId","in":"query","description":"user id of the agent","required":false,"type":"string"},{"name":"evaluatorUserId","in":"query","description":"evaluator user id","required":false,"type":"string"},{"name":"queueId","in":"query","description":"queue id","required":false,"type":"string"},{"name":"startTime","in":"query","description":"start time of the evaluation query","required":false,"type":"string"},{"name":"endTime","in":"query","description":"end time of the evaluation query","required":false,"type":"string"},{"name":"evaluationState","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"isReleased","in":"query","description":"the evaluation has been released","required":false,"type":"boolean"},{"name":"agentHasRead","in":"query","description":"agent has the evaluation","required":false,"type":"boolean"},{"name":"expandAnswerTotalScores","in":"query","description":"get the total scores for evaluations","required":false,"type":"boolean"},{"name":"maximum","in":"query","description":"maximum","required":false,"type":"integer","format":"int32"},{"name":"sortOrder","in":"query","description":"sort order options for agentUserId or evaluatorUserId query. Valid options are 'a', 'asc', 'ascending', 'd', 'desc', 'descending'","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.query.invalid.conversation":"Quality query has invalid conversation.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","quality.query.invalid.user":"User does not exist","quality.query.spec.one.of.agent.or.evaluator.or.conversation":"Quality query needs one agent, evaluator, or conversation.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.backend.service.timeout":"Backend service timeout","authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluation:view"]},"x-purecloud-method-name":"getQualityEvaluationsQuery"}},"/api/v2/journey/actiontargets/{actionTargetId}":{"get":{"tags":["Journey"],"summary":"Retrieve a single action target.","description":"","operationId":"getJourneyActiontarget","produces":["application/json"],"parameters":[{"name":"actionTargetId","in":"path","description":"ID of the action target.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionTarget"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actiontarget:view"]},"x-purecloud-method-name":"getJourneyActiontarget"},"patch":{"tags":["Journey"],"summary":"Update a single action target.","description":"","operationId":"patchJourneyActiontarget","produces":["application/json"],"parameters":[{"name":"actionTargetId","in":"path","description":"ID of the action target.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/PatchActionTarget"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionTarget"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actiontarget:edit"]},"x-purecloud-method-name":"patchJourneyActiontarget"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/historicaladherencequery":{"post":{"tags":["Workforce Management"],"summary":"Request a historical adherence report","description":"The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true","operationId":"postWorkforcemanagementManagementunitHistoricaladherencequery","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The management unit ID of the management unit","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/WfmHistoricalAdherenceQuery"}}],"responses":{"202":{"description":"Processing request","schema":{"$ref":"#/definitions/WfmHistoricalAdherenceResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.only.authorized.for.team.access":"You are only authorized to call this route for specific teams","wfm.too.many.teams.requested":"You may only request up to 10 teams in a single request","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","wfm.requested.teams.and.users":"You may only either teams or users, not both","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","wfm.missing.team.permissions":"You must have access to the requested teams"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.too.many.requests":"Too many requests in a given amount of time","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:historicalAdherence:view"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitHistoricaladherencequery"}}},"securityDefinitions":{"PureCloud OAuth":{"type":"oauth2","authorizationUrl":"https://login.mypurecloud.com/authorize","flow":"implicit","scopes":{"all":"All the scopes"}},"Guest Chat JWT":{"type":"apiKey","name":"Authorization","in":"header"}},"definitions":{"DialerContactId":{"type":"object","properties":{"id":{"type":"string"},"contactListId":{"type":"string"}}},"DomainEntityRef":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri"}}},"GDPRJourneyCustomer":{"type":"object","properties":{"type":{"type":"string","description":"The type of the customerId within the Journey System (e.g. cookie). Required if `id` is defined."},"id":{"type":"string","description":"An ID of a customer within the Journey System at a point-in-time. Required if `type` is defined."}}},"GDPRRequest":{"type":"object","required":["createdBy","createdDate","requestType","status","subject"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"createdBy":{"description":"The user that created this request","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"replacementTerms":{"type":"array","example":"[ { \"type\": \"EMAIL\": \"existingValue\": \"personal.email@domain.com\", \"updatedValue\": \"updated.personal.email@domain.com\" } ]","description":"The replacement terms for the provided search terms, in the case of a GDPR_UPDATE request","items":{"$ref":"#/definitions/ReplacementTerm"}},"requestType":{"type":"string","description":"The type of GDPR request","enum":["GDPR_EXPORT","GDPR_UPDATE","GDPR_DELETE"],"x-genesys-enum-members":[{"name":"GDPR_EXPORT"},{"name":"GDPR_UPDATE"},{"name":"GDPR_DELETE"}]},"createdDate":{"type":"string","format":"date-time","description":"When the request was submitted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"status":{"type":"string","description":"The status of the request","readOnly":true,"enum":["INITIATED","SEARCHING","UPDATING","DELETING","COMPLETED","ERROR","FINALIZING"],"x-genesys-enum-members":[{"name":"INITIATED"},{"name":"SEARCHING"},{"name":"UPDATING"},{"name":"DELETING"},{"name":"COMPLETED"},{"name":"ERROR"},{"name":"FINALIZING"}]},"subject":{"example":"{ \"emailAddresses\": [\"personal.email@domain.com\"], \"phoneNumbers\": [\"+13115552368\"] }","description":"The subject of the GDPR request","$ref":"#/definitions/GDPRSubject"},"resultsUrl":{"type":"string","description":"The location where the results of the request can be retrieved","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GDPRRequestEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/GDPRRequest"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"GDPRSubject":{"type":"object","properties":{"name":{"type":"string"},"userId":{"type":"string"},"externalContactId":{"type":"string"},"dialerContactId":{"$ref":"#/definitions/DialerContactId"},"journeyCustomer":{"$ref":"#/definitions/GDPRJourneyCustomer"},"socialHandle":{"$ref":"#/definitions/SocialHandle"},"addresses":{"type":"array","items":{"type":"string"}},"phoneNumbers":{"type":"array","items":{"type":"string"}},"emailAddresses":{"type":"array","items":{"type":"string"}}}},"ReplacementTerm":{"type":"object","properties":{"type":{"type":"string","enum":["NAME","ADDRESS","PHONE","EMAIL","TWITTER"],"x-genesys-enum-members":[{"name":"NAME"},{"name":"ADDRESS"},{"name":"PHONE"},{"name":"EMAIL"},{"name":"TWITTER"}]},"existingValue":{"type":"string"},"updatedValue":{"type":"string"}}},"SocialHandle":{"type":"object","properties":{"type":{"type":"string","enum":["TWITTER"],"x-genesys-enum-members":[{"name":"TWITTER"}]},"value":{"type":"string"}}},"UsageExecutionResult":{"type":"object","properties":{"executionId":{"type":"string","description":"The id of the query execution"},"resultsUri":{"type":"string","description":"URI where the query results can be retrieved"}}},"AddressableEntityRef":{"type":"object","properties":{"id":{"type":"string"},"selfUri":{"type":"string","format":"uri"}}},"Biography":{"type":"object","properties":{"biography":{"type":"string","description":"Personal detailed description"},"interests":{"type":"array","items":{"type":"string"}},"hobbies":{"type":"array","items":{"type":"string"}},"spouse":{"type":"string"},"education":{"type":"array","description":"User education details","items":{"$ref":"#/definitions/Education"}}}},"Chat":{"type":"object","properties":{"jabberId":{"type":"string"}}},"Contact":{"type":"object","properties":{"address":{"type":"string","description":"Email address or phone number for this contact type"},"display":{"type":"string","description":"Formatted version of the address property","readOnly":true},"mediaType":{"type":"string","enum":["PHONE","EMAIL","SMS"],"x-genesys-enum-members":[{"name":"PHONE"},{"name":"EMAIL"},{"name":"SMS"}]},"type":{"type":"string","enum":["PRIMARY","WORK","WORK2","WORK3","WORK4","HOME","MOBILE","MAIN"],"x-genesys-enum-members":[{"name":"PRIMARY"},{"name":"WORK"},{"name":"WORK2"},{"name":"WORK3"},{"name":"WORK4"},{"name":"HOME"},{"name":"MOBILE"},{"name":"MAIN"}]},"extension":{"type":"string","description":"Use internal extension instead of address. Mutually exclusive with the address field."},"countryCode":{"type":"string"}}},"Division":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DomainRole":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the role"},"name":{"type":"string","description":"The name of the role"}}},"Education":{"type":"object","properties":{"school":{"type":"string"},"fieldOfStudy":{"type":"string"},"notes":{"type":"string","description":"Notes about education has a 2000 character limit"},"dateStart":{"type":"string","format":"date","description":"Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"dateEnd":{"type":"string","format":"date","description":"Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"}}},"EmployerInfo":{"type":"object","properties":{"officialName":{"type":"string"},"employeeId":{"type":"string"},"employeeType":{"type":"string"},"dateHire":{"type":"string"}}},"Geolocation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"type":{"type":"string","description":"A string used to describe the type of client the geolocation is being updated from e.g. ios, android, web, etc."},"primary":{"type":"boolean","description":"A boolean used to tell whether or not to set this geolocation client as the primary on a PATCH"},"latitude":{"type":"number","format":"double"},"longitude":{"type":"number","format":"double"},"country":{"type":"string"},"region":{"type":"string"},"city":{"type":"string"},"locations":{"type":"array","items":{"$ref":"#/definitions/LocationDefinition"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Group":{"type":"object","required":["name","rulesVisible","type","visibility"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The group name."},"description":{"type":"string"},"dateModified":{"type":"string","format":"date-time","description":"Last modified date/time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"memberCount":{"type":"integer","format":"int64","description":"Number of members.","readOnly":true},"state":{"type":"string","description":"Active, inactive, or deleted state.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"version":{"type":"integer","format":"int32","description":"Current version for this resource.","readOnly":true},"type":{"type":"string","description":"Type of group.","enum":["official","social"],"x-genesys-enum-members":[{"name":"official"},{"name":"social"}]},"images":{"type":"array","items":{"$ref":"#/definitions/UserImage"}},"addresses":{"type":"array","items":{"$ref":"#/definitions/GroupContact"}},"rulesVisible":{"type":"boolean","description":"Are membership rules visible to the person requesting to view the group"},"visibility":{"type":"string","description":"Who can view this group","enum":["public","owners","members"]},"owners":{"type":"array","description":"Owners of the group","items":{"$ref":"#/definitions/User"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GroupContact":{"type":"object","required":["address","mediaType","type"],"properties":{"address":{"type":"string","description":"Phone number for this contact type"},"extension":{"type":"string","description":"Extension is set if the number is e164 valid"},"display":{"type":"string","description":"Formatted version of the address property","readOnly":true},"type":{"type":"string","description":"Contact type of the address","enum":["GROUPRING","GROUPPHONE"],"x-genesys-enum-members":[{"name":"GROUPRING"},{"name":"GROUPPHONE"}]},"mediaType":{"type":"string","description":"Media type of the address","enum":["PHONE"],"x-genesys-enum-members":[{"name":"PHONE"}]}}},"Location":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the location"},"floorplanId":{"type":"string","description":"Unique identifier for the location floorplan image","readOnly":true},"coordinates":{"type":"object","description":"Users coordinates on the floorplan. Only used when floorplanImage is set","additionalProperties":{"type":"number","format":"double"}},"notes":{"type":"string","description":"Optional description on the users location"},"locationDefinition":{"$ref":"#/definitions/LocationDefinition"}}},"LocationAddress":{"type":"object","properties":{"city":{"type":"string"},"country":{"type":"string"},"countryName":{"type":"string"},"state":{"type":"string"},"street1":{"type":"string"},"street2":{"type":"string"},"zipcode":{"type":"string"}}},"LocationAddressVerificationDetails":{"type":"object","properties":{"status":{"type":"string","description":"Status of address verification process","enum":["Pending","InProgress","Retry","Complete","Failed"],"x-genesys-enum-members":[{"name":"Pending"},{"name":"InProgress"},{"name":"Retry"},{"name":"Complete"},{"name":"Failed"}]},"dateFinished":{"type":"string","format":"date-time","description":"Finished time of address verification process. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateStarted":{"type":"string","format":"date-time","description":"Time started of address verification process. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"service":{"type":"string","example":"smartystreets-us","description":"Third party service used for address verification"}}},"LocationDefinition":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"contactUser":{"description":"Site contact for the location entity","$ref":"#/definitions/AddressableEntityRef"},"emergencyNumber":{"description":"Emergency number for the location entity","$ref":"#/definitions/LocationEmergencyNumber"},"address":{"$ref":"#/definitions/LocationAddress"},"state":{"type":"string","description":"Current state of the location entity","enum":["active","deleted"]},"notes":{"type":"string","description":"Notes for the location entity"},"version":{"type":"integer","format":"int32","description":"Current version of the location entity, value to be supplied should be retrieved by a GET or on create/update response"},"path":{"type":"array","description":"A list of ancestor IDs in order","readOnly":true,"items":{"type":"string"}},"profileImage":{"type":"array","description":"Profile image of the location entity, retrieved with ?expand=images query parameter","readOnly":true,"items":{"$ref":"#/definitions/LocationImage"}},"floorplanImage":{"type":"array","description":"Floorplan images of the location entity, retrieved with ?expand=images query parameter","readOnly":true,"items":{"$ref":"#/definitions/LocationImage"}},"addressVerificationDetails":{"description":"Address verification information, retrieve dwith the ?expand=addressVerificationDetails query parameter","readOnly":true,"$ref":"#/definitions/LocationAddressVerificationDetails"},"addressVerified":{"type":"boolean","description":"Boolean field which states if the address has been verified as an actual address","readOnly":true},"addressStored":{"type":"boolean","description":"Boolean field which states if the address has been stored for E911","readOnly":true},"images":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LocationEmergencyNumber":{"type":"object","properties":{"e164":{"type":"string"},"number":{"type":"string"},"type":{"type":"string","description":"The type of emergency number.","enum":["default","elin"]}}},"LocationImage":{"type":"object","properties":{"resolution":{"type":"string","description":"Height and/or width of image. ex: 640x480 or x128"},"imageUri":{"type":"string"}}},"MediaSummary":{"type":"object","properties":{"contactCenter":{"$ref":"#/definitions/MediaSummaryDetail"},"enterprise":{"$ref":"#/definitions/MediaSummaryDetail"}}},"MediaSummaryDetail":{"type":"object","properties":{"active":{"type":"integer","format":"int32"},"acw":{"type":"integer","format":"int32"}}},"OAuthLastTokenIssued":{"type":"object","properties":{"dateIssued":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"OrgUser":{"type":"object","required":["version"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"chat":{"$ref":"#/definitions/Chat"},"department":{"type":"string"},"email":{"type":"string"},"primaryContactInfo":{"type":"array","description":"Auto populated from addresses.","readOnly":true,"items":{"$ref":"#/definitions/Contact"}},"addresses":{"type":"array","description":"Email addresses and phone numbers for this user","items":{"$ref":"#/definitions/Contact"}},"state":{"type":"string","description":"The current state for this user.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"title":{"type":"string"},"username":{"type":"string"},"manager":{"$ref":"#/definitions/User"},"images":{"type":"array","items":{"$ref":"#/definitions/UserImage"}},"version":{"type":"integer","format":"int32","description":"Required when updating a user, this value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH."},"certifications":{"type":"array","items":{"type":"string"}},"biography":{"$ref":"#/definitions/Biography"},"employerInfo":{"$ref":"#/definitions/EmployerInfo"},"routingStatus":{"description":"ACD routing status","readOnly":true,"$ref":"#/definitions/RoutingStatus"},"presence":{"description":"Active presence","readOnly":true,"$ref":"#/definitions/UserPresence"},"conversationSummary":{"description":"Summary of conversion statistics for conversation types.","readOnly":true,"$ref":"#/definitions/UserConversationSummary"},"outOfOffice":{"description":"Determine if out of office is enabled","readOnly":true,"$ref":"#/definitions/OutOfOffice"},"geolocation":{"description":"Current geolocation position","readOnly":true,"$ref":"#/definitions/Geolocation"},"station":{"description":"Effective, default, and last station information","readOnly":true,"$ref":"#/definitions/UserStations"},"authorization":{"description":"Roles and permissions assigned to the user","readOnly":true,"$ref":"#/definitions/UserAuthorization"},"profileSkills":{"type":"array","description":"Profile skills possessed by the user","readOnly":true,"items":{"type":"string"}},"locations":{"type":"array","description":"The user placement at each site location.","readOnly":true,"items":{"$ref":"#/definitions/Location"}},"groups":{"type":"array","description":"The groups the user is a member of","readOnly":true,"items":{"$ref":"#/definitions/Group"}},"team":{"description":"The team the user is a member of","readOnly":true,"$ref":"#/definitions/Team"},"skills":{"type":"array","description":"Routing (ACD) skills possessed by the user","readOnly":true,"items":{"$ref":"#/definitions/UserRoutingSkill"}},"languages":{"type":"array","description":"Routing (ACD) languages possessed by the user","readOnly":true,"items":{"$ref":"#/definitions/UserRoutingLanguage"}},"acdAutoAnswer":{"type":"boolean","description":"acd auto answer"},"languagePreference":{"type":"string","description":"preferred language by the user","readOnly":true},"lastTokenIssued":{"$ref":"#/definitions/OAuthLastTokenIssued"},"organization":{"$ref":"#/definitions/Organization"}}},"Organization":{"type":"object","required":["version"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"defaultLanguage":{"type":"string","description":"The default language for this organization. Example: 'en'"},"defaultCountryCode":{"type":"string","description":"The default country code for this organization. Example: 'US'"},"thirdPartyOrgName":{"type":"string","description":"The short name for the organization. This field is globally unique and cannot be changed.","readOnly":true},"thirdPartyURI":{"type":"string","format":"uri"},"domain":{"type":"string"},"version":{"type":"integer","format":"int32","description":"The current version of the organization."},"state":{"type":"string","description":"The current state. Examples are active, inactive, deleted.","enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"defaultSiteId":{"type":"string"},"supportURI":{"type":"string","description":"Email address where support tickets are sent to."},"voicemailEnabled":{"type":"boolean"},"productPlatform":{"type":"string","description":"Organizations Originating Platform.","readOnly":true,"enum":["GenesysCloud","PureCloud","PureEngage","PureEngageCloud","PureConnect","PureConnectCloud","Unknown"],"x-genesys-enum-members":[{"name":"GenesysCloud"},{"name":"PureCloud"},{"name":"PureEngage"},{"name":"PureEngageCloud"},{"name":"PureConnect"},{"name":"PureConnectCloud"},{"name":"Unknown"}]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"features":{"type":"object","description":"The state of features available for the organization.","readOnly":true,"additionalProperties":{"type":"boolean"}}}},"OutOfOffice":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"user":{"$ref":"#/definitions/User"},"startDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"active":{"type":"boolean"},"indefinite":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PresenceDefinition":{"type":"object","properties":{"id":{"type":"string","description":"description"},"systemPresence":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ResourceConditionNode":{"type":"object","properties":{"variableName":{"type":"string"},"conjunction":{"type":"string","enum":["AND","OR"],"x-genesys-enum-members":[{"name":"AND"},{"name":"OR"}]},"operator":{"type":"string","enum":["EQ","IN","GE","GT","LE","LT"],"x-genesys-enum-members":[{"name":"EQ"},{"name":"IN"},{"name":"GE"},{"name":"GT"},{"name":"LE"},{"name":"LT"}]},"operands":{"type":"array","items":{"$ref":"#/definitions/ResourceConditionValue"}},"terms":{"type":"array","items":{"$ref":"#/definitions/ResourceConditionNode"}}}},"ResourceConditionValue":{"type":"object","properties":{"type":{"type":"string","enum":["SCALAR","VARIABLE","USER","QUEUE"],"x-genesys-enum-members":[{"name":"SCALAR"},{"name":"VARIABLE"},{"name":"USER"},{"name":"QUEUE"}]},"value":{"type":"string"}}},"ResourcePermissionPolicy":{"type":"object","properties":{"id":{"type":"string"},"domain":{"type":"string"},"entityName":{"type":"string"},"policyName":{"type":"string"},"policyDescription":{"type":"string"},"actionSetKey":{"type":"string"},"allowConditions":{"type":"boolean"},"resourceConditionNode":{"$ref":"#/definitions/ResourceConditionNode"},"namedResources":{"type":"array","items":{"type":"string"}},"resourceCondition":{"type":"string"},"actionSet":{"type":"array","uniqueItems":true,"items":{"type":"string"}}}},"RoutingStatus":{"type":"object","properties":{"userId":{"type":"string","description":"The userId of the agent"},"status":{"type":"string","description":"Indicates the Routing State of the agent. A value of OFF_QUEUE will be returned if the specified user does not exist.","enum":["OFF_QUEUE","IDLE","INTERACTING","NOT_RESPONDING","COMMUNICATING"],"x-genesys-enum-members":[{"name":"OFF_QUEUE"},{"name":"IDLE"},{"name":"INTERACTING"},{"name":"NOT_RESPONDING"},{"name":"COMMUNICATING"}]},"startTime":{"type":"string","format":"date-time","description":"The timestamp when the agent went into this state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"Team":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The team name"},"description":{"type":"string","description":"Team information."},"dateModified":{"type":"string","format":"date-time","description":"Last modified datetime. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"memberCount":{"type":"integer","format":"int64","description":"Number of members in a team","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TrustUser":{"type":"object","required":["version"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"chat":{"$ref":"#/definitions/Chat"},"department":{"type":"string"},"email":{"type":"string"},"primaryContactInfo":{"type":"array","description":"Auto populated from addresses.","readOnly":true,"items":{"$ref":"#/definitions/Contact"}},"addresses":{"type":"array","description":"Email addresses and phone numbers for this user","items":{"$ref":"#/definitions/Contact"}},"state":{"type":"string","description":"The current state for this user.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"title":{"type":"string"},"username":{"type":"string"},"manager":{"$ref":"#/definitions/User"},"images":{"type":"array","items":{"$ref":"#/definitions/UserImage"}},"version":{"type":"integer","format":"int32","description":"Required when updating a user, this value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH."},"certifications":{"type":"array","items":{"type":"string"}},"biography":{"$ref":"#/definitions/Biography"},"employerInfo":{"$ref":"#/definitions/EmployerInfo"},"routingStatus":{"description":"ACD routing status","readOnly":true,"$ref":"#/definitions/RoutingStatus"},"presence":{"description":"Active presence","readOnly":true,"$ref":"#/definitions/UserPresence"},"conversationSummary":{"description":"Summary of conversion statistics for conversation types.","readOnly":true,"$ref":"#/definitions/UserConversationSummary"},"outOfOffice":{"description":"Determine if out of office is enabled","readOnly":true,"$ref":"#/definitions/OutOfOffice"},"geolocation":{"description":"Current geolocation position","readOnly":true,"$ref":"#/definitions/Geolocation"},"station":{"description":"Effective, default, and last station information","readOnly":true,"$ref":"#/definitions/UserStations"},"authorization":{"description":"Roles and permissions assigned to the user","readOnly":true,"$ref":"#/definitions/UserAuthorization"},"profileSkills":{"type":"array","description":"Profile skills possessed by the user","readOnly":true,"items":{"type":"string"}},"locations":{"type":"array","description":"The user placement at each site location.","readOnly":true,"items":{"$ref":"#/definitions/Location"}},"groups":{"type":"array","description":"The groups the user is a member of","readOnly":true,"items":{"$ref":"#/definitions/Group"}},"team":{"description":"The team the user is a member of","readOnly":true,"$ref":"#/definitions/Team"},"skills":{"type":"array","description":"Routing (ACD) skills possessed by the user","readOnly":true,"items":{"$ref":"#/definitions/UserRoutingSkill"}},"languages":{"type":"array","description":"Routing (ACD) languages possessed by the user","readOnly":true,"items":{"$ref":"#/definitions/UserRoutingLanguage"}},"acdAutoAnswer":{"type":"boolean","description":"acd auto answer"},"languagePreference":{"type":"string","description":"preferred language by the user","readOnly":true},"lastTokenIssued":{"$ref":"#/definitions/OAuthLastTokenIssued"},"trustUserDetails":{"$ref":"#/definitions/TrustUserDetails"}}},"TrustUserDetails":{"type":"object","properties":{"dateCreated":{"type":"string","format":"date-time","description":"Date Trust User was added. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"createdBy":{"description":"User that added trusted user.","readOnly":true,"$ref":"#/definitions/OrgUser"}}},"TrustUserEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/TrustUser"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"User":{"type":"object","required":["version"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"chat":{"$ref":"#/definitions/Chat"},"department":{"type":"string"},"email":{"type":"string"},"primaryContactInfo":{"type":"array","description":"Auto populated from addresses.","readOnly":true,"items":{"$ref":"#/definitions/Contact"}},"addresses":{"type":"array","description":"Email addresses and phone numbers for this user","items":{"$ref":"#/definitions/Contact"}},"state":{"type":"string","description":"The current state for this user.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"title":{"type":"string"},"username":{"type":"string"},"manager":{"$ref":"#/definitions/User"},"images":{"type":"array","items":{"$ref":"#/definitions/UserImage"}},"version":{"type":"integer","format":"int32","description":"Required when updating a user, this value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH."},"certifications":{"type":"array","items":{"type":"string"}},"biography":{"$ref":"#/definitions/Biography"},"employerInfo":{"$ref":"#/definitions/EmployerInfo"},"routingStatus":{"description":"ACD routing status","readOnly":true,"$ref":"#/definitions/RoutingStatus"},"presence":{"description":"Active presence","readOnly":true,"$ref":"#/definitions/UserPresence"},"conversationSummary":{"description":"Summary of conversion statistics for conversation types.","readOnly":true,"$ref":"#/definitions/UserConversationSummary"},"outOfOffice":{"description":"Determine if out of office is enabled","readOnly":true,"$ref":"#/definitions/OutOfOffice"},"geolocation":{"description":"Current geolocation position","readOnly":true,"$ref":"#/definitions/Geolocation"},"station":{"description":"Effective, default, and last station information","readOnly":true,"$ref":"#/definitions/UserStations"},"authorization":{"description":"Roles and permissions assigned to the user","readOnly":true,"$ref":"#/definitions/UserAuthorization"},"profileSkills":{"type":"array","description":"Profile skills possessed by the user","readOnly":true,"items":{"type":"string"}},"locations":{"type":"array","description":"The user placement at each site location.","readOnly":true,"items":{"$ref":"#/definitions/Location"}},"groups":{"type":"array","description":"The groups the user is a member of","readOnly":true,"items":{"$ref":"#/definitions/Group"}},"team":{"description":"The team the user is a member of","readOnly":true,"$ref":"#/definitions/Team"},"skills":{"type":"array","description":"Routing (ACD) skills possessed by the user","readOnly":true,"items":{"$ref":"#/definitions/UserRoutingSkill"}},"languages":{"type":"array","description":"Routing (ACD) languages possessed by the user","readOnly":true,"items":{"$ref":"#/definitions/UserRoutingLanguage"}},"acdAutoAnswer":{"type":"boolean","description":"acd auto answer"},"languagePreference":{"type":"string","description":"preferred language by the user","readOnly":true},"lastTokenIssued":{"$ref":"#/definitions/OAuthLastTokenIssued"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserAuthorization":{"type":"object","properties":{"roles":{"type":"array","items":{"$ref":"#/definitions/DomainRole"}},"unusedRoles":{"type":"array","description":"A collection of the roles the user is not using","readOnly":true,"items":{"$ref":"#/definitions/DomainRole"}},"permissions":{"type":"array","description":"A collection of the permissions granted by all assigned roles","readOnly":true,"items":{"type":"string"}},"permissionPolicies":{"type":"array","description":"The policies configured for assigned permissions.","readOnly":true,"items":{"$ref":"#/definitions/ResourcePermissionPolicy"}}}},"UserConversationSummary":{"type":"object","properties":{"userId":{"type":"string"},"call":{"$ref":"#/definitions/MediaSummary"},"callback":{"$ref":"#/definitions/MediaSummary"},"email":{"$ref":"#/definitions/MediaSummary"},"message":{"$ref":"#/definitions/MediaSummary"},"chat":{"$ref":"#/definitions/MediaSummary"},"socialExpression":{"$ref":"#/definitions/MediaSummary"},"video":{"$ref":"#/definitions/MediaSummary"}}},"UserImage":{"type":"object","properties":{"resolution":{"type":"string","description":"Height and/or width of image. ex: 640x480 or x128"},"imageUri":{"type":"string"}}},"UserPresence":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"source":{"type":"string","description":"Represents the source where the Presence was set. Some examples are: PURECLOUD, LYNC, OUTLOOK, etc."},"primary":{"type":"boolean","description":"A boolean used to tell whether or not to set this presence source as the primary on a PATCH"},"presenceDefinition":{"$ref":"#/definitions/PresenceDefinition"},"message":{"type":"string"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserRoutingLanguage":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"proficiency":{"type":"number","format":"double","description":"A rating from 0.0 to 5.0 that indicates how fluent an agent is in a particular language. ACD interactions are routed to agents with higher proficiency ratings."},"state":{"type":"string","description":"Activate or deactivate this routing language.","enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"languageUri":{"type":"string","format":"uri","description":"URI to the organization language used by this user language.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Represents an organization language assigned to a user. When assigning to a user specify the organization language id as the id."},"UserRoutingSkill":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"proficiency":{"type":"number","format":"double","description":"A rating from 0.0 to 5.0 that indicates how adept an agent is at a particular skill. When \"Best available skills\" is enabled for a queue in Genesys Cloud, ACD interactions in that queue are routed to agents with higher proficiency ratings."},"state":{"type":"string","description":"Activate or deactivate this routing skill.","enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"skillUri":{"type":"string","format":"uri","description":"URI to the organization skill used by this user skill.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Represents an organization skill assigned to a user. When assigning to a user specify the organization skill id as the id."},"UserStation":{"type":"object","properties":{"id":{"type":"string","description":"A globally unique identifier for this station","readOnly":true},"name":{"type":"string"},"type":{"type":"string"},"associatedUser":{"$ref":"#/definitions/User"},"associatedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"defaultUser":{"$ref":"#/definitions/User"},"providerInfo":{"type":"object","description":"Provider-specific info for this station, e.g. { \"edgeGroupId\": \"ffe7b15c-a9cc-4f4c-88f5-781327819a49\" }","additionalProperties":{"type":"string"}}}},"UserStations":{"type":"object","properties":{"associatedStation":{"description":"Current associated station for this user.","readOnly":true,"$ref":"#/definitions/UserStation"},"effectiveStation":{"description":"The station where the user can be reached based on their default and associated station.","readOnly":true,"$ref":"#/definitions/UserStation"},"defaultStation":{"description":"Default station to be used if not associated with a station.","readOnly":true,"$ref":"#/definitions/UserStation"},"lastAssociatedStation":{"description":"Last associated station for this user.","readOnly":true,"$ref":"#/definitions/UserStation"}}},"Attribute":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The attribute name."},"version":{"type":"integer","format":"int32"},"description":{"type":"string"},"createdBy":{"$ref":"#/definitions/DomainEntityRef"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"$ref":"#/definitions/DomainEntityRef"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Document":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"changeNumber":{"type":"integer","format":"int32"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateUploaded":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"contentUri":{"type":"string","format":"uri"},"workspace":{"$ref":"#/definitions/DomainEntityRef"},"createdBy":{"$ref":"#/definitions/DomainEntityRef"},"uploadedBy":{"$ref":"#/definitions/DomainEntityRef"},"contentType":{"type":"string"},"contentLength":{"type":"integer","format":"int64"},"systemType":{"type":"string","enum":["DOCUMENT","FAX","RECORDING"],"x-genesys-enum-members":[{"name":"DOCUMENT"},{"name":"FAX"},{"name":"RECORDING"}]},"filename":{"type":"string"},"pageCount":{"type":"integer","format":"int64"},"read":{"type":"boolean"},"callerAddress":{"type":"string"},"receiverAddress":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"tagValues":{"type":"array","items":{"$ref":"#/definitions/TagValue"}},"attributes":{"type":"array","items":{"$ref":"#/definitions/DocumentAttribute"}},"thumbnails":{"type":"array","items":{"$ref":"#/definitions/DocumentThumbnail"}},"uploadStatus":{"$ref":"#/definitions/DomainEntityRef"},"uploadDestinationUri":{"type":"string","format":"uri"},"uploadMethod":{"type":"string","enum":["SINGLE_PUT","MULTIPART_POST"],"x-genesys-enum-members":[{"name":"SINGLE_PUT"},{"name":"MULTIPART_POST"}]},"lockInfo":{"$ref":"#/definitions/LockInfo"},"acl":{"type":"array","description":"A list of permitted action rights for the user making the request","items":{"type":"string"}},"sharingStatus":{"type":"string","enum":["NONE","LIMITED","PUBLIC"],"x-genesys-enum-members":[{"name":"NONE"},{"name":"LIMITED"},{"name":"PUBLIC"}]},"sharingUri":{"type":"string","format":"uri"},"downloadSharingUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DocumentAttribute":{"type":"object","properties":{"attribute":{"$ref":"#/definitions/Attribute"},"values":{"type":"array","items":{"type":"string"}}}},"DocumentThumbnail":{"type":"object","properties":{"resolution":{"type":"string"},"imageUri":{"type":"string"},"height":{"type":"integer","format":"int32"},"width":{"type":"integer","format":"int32"}}},"LockInfo":{"type":"object","properties":{"lockedBy":{"$ref":"#/definitions/DomainEntityRef"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateExpires":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"action":{"type":"string","enum":["UPDATE","DELETE","COPY","MOVE","REPLACE","THUMBNAIL","TEXT_EXTRACTION"],"x-genesys-enum-members":[{"name":"UPDATE"},{"name":"DELETE"},{"name":"COPY"},{"name":"MOVE"},{"name":"REPLACE"},{"name":"THUMBNAIL"},{"name":"TEXT_EXTRACTION"}]}}},"TagValue":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The workspace tag name."},"inUse":{"type":"boolean"},"acl":{"type":"array","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DocumentUpdate":{"type":"object","required":["name"],"properties":{"changeNumber":{"type":"integer","format":"int32"},"name":{"type":"string","description":"The name of the document"},"read":{"type":"boolean"},"addTags":{"type":"array","items":{"type":"string"}},"removeTags":{"type":"array","items":{"type":"string"}},"addTagIds":{"type":"array","items":{"type":"string"}},"removeTagIds":{"type":"array","items":{"type":"string"}},"updateAttributes":{"type":"array","items":{"$ref":"#/definitions/DocumentAttribute"}},"removeAttributes":{"type":"array","items":{"type":"string"}}}},"AddressableLicenseDefinition":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LicenseDefinition":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"description":{"type":"string"},"permissions":{"$ref":"#/definitions/Permissions"},"prerequisites":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/AddressableLicenseDefinition"}},"comprises":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/LicenseDefinition"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Permissions":{"type":"object","required":["ids"],"properties":{"ids":{"type":"array","description":"List of permission ids.","items":{"type":"string"}}}},"UserReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EncryptionKey":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"createDate":{"type":"string","format":"date-time","description":"create date of the key pair. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"keydataSummary":{"type":"string","description":"key data summary (base 64 encoded public key)"},"user":{"description":"user that requested generation of public key","$ref":"#/definitions/User"},"localEncryptionConfiguration":{"description":"Local configuration","$ref":"#/definitions/LocalEncryptionConfiguration"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LocalEncryptionConfiguration":{"type":"object","required":["apiId","apiKey","url"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"url":{"type":"string","description":"The url for decryption. This must specify the path to where Purecloud can requests decryption"},"apiId":{"type":"string","description":"The api id for Hawk Authentication."},"apiKey":{"type":"string","description":"The api shared symmetric key used for hawk authentication"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LocalEncryptionKeyRequest":{"type":"object","required":["configId","keypairId","publicKey"],"properties":{"configId":{"type":"string","description":"The local configuration id that contains metadata on private local service"},"publicKey":{"type":"string","description":"Base 64 encoded public key, generated by the local service."},"keypairId":{"type":"string","description":"The key pair id from the local service."}}},"ConversationMetrics":{"type":"object","properties":{"conversation":{"description":"The Conversation Reference","$ref":"#/definitions/AddressableEntityRef"},"sentimentScore":{"type":"number","format":"double","description":"The Sentiment Score"},"sentimentTrend":{"type":"number","format":"double","description":"The Sentiment Trend"}}},"ParticipantMetrics":{"type":"object","properties":{}},"WrapUpCodeMapping":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"defaultSet":{"type":"array","description":"The default set of wrap-up flags. These will be used if there is no entry for a given wrap-up code in the mapping.","uniqueItems":true,"items":{"type":"string","enum":["CONTACT_UNCALLABLE","NUMBER_UNCALLABLE","RIGHT_PARTY_CONTACT"],"x-genesys-enum-members":[{"name":"CONTACT_UNCALLABLE"},{"name":"NUMBER_UNCALLABLE"},{"name":"RIGHT_PARTY_CONTACT"}]}},"mapping":{"type":"object","description":"A map from wrap-up code identifiers to a set of wrap-up flags.","additionalProperties":{"type":"array","uniqueItems":true,"items":{"type":"string","enum":["CONTACT_UNCALLABLE","NUMBER_UNCALLABLE","RIGHT_PARTY_CONTACT"],"x-genesys-enum-members":[{"name":"CONTACT_UNCALLABLE"},{"name":"NUMBER_UNCALLABLE"},{"name":"RIGHT_PARTY_CONTACT"}]}}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"VoicemailUserPolicy":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the user has voicemail enabled","readOnly":true},"alertTimeoutSeconds":{"type":"integer","format":"int32","description":"The number of seconds to ring the user's phone before a call is transfered to voicemail"},"pin":{"type":"string","description":"The user's PIN to access their voicemail. This property is only used for updates and never provided otherwise to ensure security"},"modifiedDate":{"type":"string","format":"date-time","description":"The date the policy was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"sendEmailNotifications":{"type":"boolean","description":"Whether email notifications are sent to the user when a new voicemail is received"}}},"Actions":{"type":"object","properties":{"skillsToRemove":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/SkillsToRemove"}}}},"AcwSettings":{"type":"object","properties":{"wrapupPrompt":{"type":"string","description":"This field controls how the UI prompts the agent for a wrapup.","enum":["MANDATORY","OPTIONAL","MANDATORY_TIMEOUT","MANDATORY_FORCED_TIMEOUT","AGENT_REQUESTED"],"x-genesys-enum-members":[{"name":"MANDATORY"},{"name":"OPTIONAL"},{"name":"MANDATORY_TIMEOUT"},{"name":"MANDATORY_FORCED_TIMEOUT"},{"name":"AGENT_REQUESTED"}]},"timeoutMs":{"type":"integer","format":"int32","description":"The amount of time the agent can stay in ACW (Min: 1 sec, Max: 1 day). Can only be used when ACW is MANDATORY_TIMEOUT or MANDATORY_FORCED_TIMEOUT."}}},"Address":{"type":"object","properties":{"name":{"type":"string","description":"This will be nameRaw if present, or a locality lookup of the address field otherwise."},"nameRaw":{"type":"string","description":"The name as close to the bits on the wire as possible."},"addressNormalized":{"type":"string","description":"The normalized address. This field is acquired from the Address Normalization Table. The addressRaw could have gone through some transformations, such as only using the numeric portion, before being run through the Address Normalization Table."},"addressRaw":{"type":"string","description":"The address as close to the bits on the wire as possible."},"addressDisplayable":{"type":"string","description":"The displayable address. This field is acquired from the Address Normalization Table. The addressRaw could have gone through some transformations, such as only using the numeric portion, before being run through the Address Normalization Table."}}},"AfterCallWork":{"type":"object","properties":{"startTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"state":{"type":"string","enum":["unknown","notApplicable","skipped","pending","complete"],"x-genesys-enum-members":[{"name":"unknown"},{"name":"notApplicable"},{"name":"skipped"},{"name":"pending"},{"name":"complete"}]}}},"AnswerOption":{"type":"object","properties":{"id":{"type":"string"},"text":{"type":"string"},"value":{"type":"integer","format":"int32"}}},"AssignmentGroup":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri"},"type":{"type":"string","enum":["TEAM"],"x-genesys-enum-members":[{"name":"TEAM"}]}}},"Attachment":{"type":"object","properties":{"attachmentId":{"type":"string","description":"The unique identifier for the attachment."},"name":{"type":"string","description":"The name of the attachment."},"contentUri":{"type":"string","description":"The content uri of the attachment. If set, this is commonly a public api download location."},"contentType":{"type":"string","description":"The type of file the attachment is."},"contentLength":{"type":"integer","format":"int32","description":"The length of the attachment file."},"inlineImage":{"type":"boolean","description":"Whether or not the attachment was attached inline.,"}}},"Bullseye":{"type":"object","properties":{"rings":{"type":"array","items":{"$ref":"#/definitions/Ring"}}}},"Calibration":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"calibrator":{"$ref":"#/definitions/User"},"agent":{"$ref":"#/definitions/User"},"conversation":{"$ref":"#/definitions/Conversation"},"evaluationForm":{"$ref":"#/definitions/EvaluationForm"},"contextId":{"type":"string"},"averageScore":{"type":"integer","format":"int32"},"highScore":{"type":"integer","format":"int32"},"lowScore":{"type":"integer","format":"int32"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"evaluations":{"type":"array","items":{"$ref":"#/definitions/Evaluation"}},"evaluators":{"type":"array","items":{"$ref":"#/definitions/User"}},"scoringIndex":{"$ref":"#/definitions/Evaluation"},"expertEvaluator":{"$ref":"#/definitions/User"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Call":{"type":"object","properties":{"state":{"type":"string","description":"The connection state of this communication.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","converting","uploading","transmitting","none"],"x-genesys-enum-members":[{"name":"alerting"},{"name":"dialing"},{"name":"contacting"},{"name":"offering"},{"name":"connected"},{"name":"disconnected"},{"name":"terminated"},{"name":"converting"},{"name":"uploading"},{"name":"transmitting"},{"name":"none"}]},"id":{"type":"string","description":"A globally unique identifier for this communication."},"direction":{"type":"string","description":"The direction of the call","enum":["inbound","outbound"],"x-genesys-enum-members":[{"name":"inbound"},{"name":"outbound"}]},"recording":{"type":"boolean","description":"True if this call is being recorded."},"recordingState":{"type":"string","description":"State of recording on this call.","enum":["none","active","paused"],"x-genesys-enum-members":[{"name":"none"},{"name":"active"},{"name":"paused"}]},"muted":{"type":"boolean","description":"True if this call is muted so that remote participants can't hear any audio from this end."},"confined":{"type":"boolean","description":"True if this call is held and the person on this side hears hold music."},"held":{"type":"boolean","description":"True if this call is held and the person on this side hears silence."},"recordingId":{"type":"string","description":"A globally unique identifier for the recording associated with this call."},"segments":{"type":"array","description":"The time line of the participant's call, divided into activity segments.","items":{"$ref":"#/definitions/Segment"}},"errorInfo":{"$ref":"#/definitions/ErrorInfo"},"disconnectType":{"type":"string","description":"System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.","enum":["endpoint","client","system","timeout","transfer","transfer.conference","transfer.consult","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam","uncallable"],"x-genesys-enum-members":[{"name":"endpoint"},{"name":"client"},{"name":"system"},{"name":"timeout"},{"name":"transfer"},{"name":"transfer.conference"},{"name":"transfer.consult"},{"name":"transfer.forward"},{"name":"transfer.noanswer"},{"name":"transfer.notavailable"},{"name":"transport.failure"},{"name":"error"},{"name":"peer"},{"name":"other"},{"name":"spam"},{"name":"uncallable"}]},"startHoldTime":{"type":"string","format":"date-time","description":"The timestamp the call was placed on hold in the cloud clock if the call is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"documentId":{"type":"string","description":"If call is an outbound fax of a document from content management, then this is the id in content management."},"startAlertingTime":{"type":"string","format":"date-time","description":"The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"disconnectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"disconnectReasons":{"type":"array","description":"List of reasons that this call was disconnected. This will be set once the call disconnects.","items":{"$ref":"#/definitions/DisconnectReason"}},"faxStatus":{"description":"Extra information on fax transmission.","$ref":"#/definitions/FaxStatus"},"provider":{"type":"string","description":"The source provider for the call."},"scriptId":{"type":"string","description":"The UUID of the script to use."},"peerId":{"type":"string","description":"The id of the peer communication corresponding to a matching leg for this communication."},"uuiData":{"type":"string","description":"User to User Information (UUI) data managed by SIP session application."},"self":{"description":"Address and name data for a call endpoint.","$ref":"#/definitions/Address"},"other":{"description":"Address and name data for a call endpoint.","$ref":"#/definitions/Address"},"wrapup":{"description":"Call wrap up or disposition data.","$ref":"#/definitions/Wrapup"},"afterCallWork":{"description":"After-call work for the communication.","$ref":"#/definitions/AfterCallWork"},"afterCallWorkRequired":{"type":"boolean","description":"Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested."},"agentAssistantId":{"type":"string","description":"UUID of virtual agent assistant that provide suggestions to the agent participant during the conversation."}}},"Callback":{"type":"object","properties":{"state":{"type":"string","description":"The connection state of this communication.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","scheduled","none"],"x-genesys-enum-members":[{"name":"alerting"},{"name":"dialing"},{"name":"contacting"},{"name":"offering"},{"name":"connected"},{"name":"disconnected"},{"name":"terminated"},{"name":"scheduled"},{"name":"none"}]},"id":{"type":"string","description":"A globally unique identifier for this communication."},"segments":{"type":"array","description":"The time line of the participant's callback, divided into activity segments.","items":{"$ref":"#/definitions/Segment"}},"direction":{"type":"string","description":"The direction of the call","enum":["inbound","outbound"],"x-genesys-enum-members":[{"name":"inbound"},{"name":"outbound"}]},"held":{"type":"boolean","description":"True if this call is held and the person on this side hears silence."},"disconnectType":{"type":"string","description":"System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.","enum":["endpoint","client","system","timeout","transfer","transfer.conference","transfer.consult","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam","uncallable"],"x-genesys-enum-members":[{"name":"endpoint"},{"name":"client"},{"name":"system"},{"name":"timeout"},{"name":"transfer"},{"name":"transfer.conference"},{"name":"transfer.consult"},{"name":"transfer.forward"},{"name":"transfer.noanswer"},{"name":"transfer.notavailable"},{"name":"transport.failure"},{"name":"error"},{"name":"peer"},{"name":"other"},{"name":"spam"},{"name":"uncallable"}]},"startHoldTime":{"type":"string","format":"date-time","description":"The timestamp the callback was placed on hold in the cloud clock if the callback is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dialerPreview":{"description":"The preview data to be used when this callback is a Preview.","$ref":"#/definitions/DialerPreview"},"voicemail":{"description":"The voicemail data to be used when this callback is an ACD voicemail.","$ref":"#/definitions/Voicemail"},"callbackNumbers":{"type":"array","description":"The phone number(s) to use to place the callback.","items":{"type":"string"}},"callbackUserName":{"type":"string","description":"The name of the user requesting a callback."},"scriptId":{"type":"string","description":"The UUID of the script to use."},"externalCampaign":{"type":"boolean","description":"True if the call for the callback uses external dialing."},"skipEnabled":{"type":"boolean","description":"True if the ability to skip a callback should be enabled."},"timeoutSeconds":{"type":"integer","format":"int32","description":"The number of seconds before the system automatically places a call for a callback. 0 means the automatic placement is disabled."},"startAlertingTime":{"type":"string","format":"date-time","description":"The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"disconnectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"callbackScheduledTime":{"type":"string","format":"date-time","description":"The timestamp when this communication is scheduled in the provider clock. If this value is missing it indicates the callback will be placed immediately. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"automatedCallbackConfigId":{"type":"string","description":"The id of the config for automatically placing the callback (and handling the disposition). If null, the callback will not be placed automatically but routed to an agent as per normal."},"provider":{"type":"string","description":"The source provider for the callback."},"peerId":{"type":"string","description":"The id of the peer communication corresponding to a matching leg for this communication."},"wrapup":{"description":"Call wrap up or disposition data.","$ref":"#/definitions/Wrapup"},"afterCallWork":{"description":"After-call work for the communication.","$ref":"#/definitions/AfterCallWork"},"afterCallWorkRequired":{"type":"boolean","description":"Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested."}}},"Cobrowsesession":{"type":"object","properties":{"state":{"type":"string","description":"The connection state of this communication.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","scheduled","none"],"x-genesys-enum-members":[{"name":"alerting"},{"name":"dialing"},{"name":"contacting"},{"name":"offering"},{"name":"connected"},{"name":"disconnected"},{"name":"terminated"},{"name":"scheduled"},{"name":"none"}]},"id":{"type":"string","description":"A globally unique identifier for this communication."},"disconnectType":{"type":"string","description":"System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.","enum":["endpoint","client","system","timeout","transfer","transfer.conference","transfer.consult","transfer.forward","transport.failure","error","peer","other","spam","uncallable"],"x-genesys-enum-members":[{"name":"endpoint"},{"name":"client"},{"name":"system"},{"name":"timeout"},{"name":"transfer"},{"name":"transfer.conference"},{"name":"transfer.consult"},{"name":"transfer.forward"},{"name":"transport.failure"},{"name":"error"},{"name":"peer"},{"name":"other"},{"name":"spam"},{"name":"uncallable"}]},"self":{"description":"Address and name data for a call endpoint.","$ref":"#/definitions/Address"},"cobrowseSessionId":{"type":"string","description":"The co-browse session ID."},"cobrowseRole":{"type":"string","description":"This value identifies the role of the co-browse client within the co-browse session (a client is a sharer or a viewer)."},"controlling":{"type":"array","description":"ID of co-browse participants for which this client has been granted control (list is empty if this client cannot control any shared pages).","items":{"type":"string"}},"viewerUrl":{"type":"string","description":"The URL that can be used to open co-browse session in web browser."},"providerEventTime":{"type":"string","format":"date-time","description":"The time when the provider event which triggered this conversation update happened in the corrected provider clock (milliseconds since 1970-01-01 00:00:00 UTC). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startAlertingTime":{"type":"string","format":"date-time","description":"The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"disconnectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"provider":{"type":"string","description":"The source provider for the co-browse session."},"peerId":{"type":"string","description":"The id of the peer communication corresponding to a matching leg for this communication."},"segments":{"type":"array","description":"The time line of the participant's call, divided into activity segments.","items":{"$ref":"#/definitions/Segment"}},"wrapup":{"description":"Call wrap up or disposition data.","$ref":"#/definitions/Wrapup"},"afterCallWork":{"description":"After-call work for the communication.","$ref":"#/definitions/AfterCallWork"},"afterCallWorkRequired":{"type":"boolean","description":"Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested."}}},"Conversation":{"type":"object","required":["participants","startTime"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"startTime":{"type":"string","format":"date-time","description":"The time when the conversation started. This will be the time when the first participant joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The time when the conversation ended. This will be the time when the last participant left the conversation, or null when the conversation is still active. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"address":{"type":"string","description":"The address of the conversation as seen from an external participant. For phone calls this will be the DNIS for inbound calls and the ANI for outbound calls. For other media types this will be the address of the destination participant for inbound and the address of the initiating participant for outbound."},"participants":{"type":"array","description":"The list of all participants in the conversation.","items":{"$ref":"#/definitions/Participant"}},"conversationIds":{"type":"array","description":"A list of conversations to merge into this conversation to create a conference. This field is null except when being used to create a conference.","items":{"type":"string"}},"maxParticipants":{"type":"integer","format":"int32","description":"If this is a conference conversation, then this field indicates the maximum number of participants allowed to participant in the conference."},"recordingState":{"type":"string","description":"On update, 'paused' initiates a secure pause, 'active' resumes any paused recordings; otherwise indicates state of conversation recording.","enum":["ACTIVE","PAUSED","NONE"],"x-genesys-enum-members":[{"name":"ACTIVE"},{"name":"PAUSED"},{"name":"NONE"}]},"state":{"type":"string","description":"The conversation's state","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","converting","uploading","transmitting","none"],"x-genesys-enum-members":[{"name":"alerting"},{"name":"dialing"},{"name":"contacting"},{"name":"offering"},{"name":"connected"},{"name":"disconnected"},{"name":"terminated"},{"name":"converting"},{"name":"uploading"},{"name":"transmitting"},{"name":"none"}]},"divisions":{"type":"array","description":"Identifiers of divisions associated with this conversation","items":{"$ref":"#/definitions/ConversationDivisionMembership"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ConversationChat":{"type":"object","properties":{"state":{"type":"string","description":"The connection state of this communication.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","none"],"x-genesys-enum-members":[{"name":"alerting"},{"name":"dialing"},{"name":"contacting"},{"name":"offering"},{"name":"connected"},{"name":"disconnected"},{"name":"terminated"},{"name":"none"}]},"id":{"type":"string","description":"A globally unique identifier for this communication."},"roomId":{"type":"string","description":"The room id for the chat."},"recordingId":{"type":"string","description":"A globally unique identifier for the recording associated with this chat."},"segments":{"type":"array","description":"The time line of the participant's chat, divided into activity segments.","items":{"$ref":"#/definitions/Segment"}},"held":{"type":"boolean","description":"True if this call is held and the person on this side hears silence."},"direction":{"type":"string","description":"The direction of the chat","enum":["inbound","outbound"],"x-genesys-enum-members":[{"name":"inbound"},{"name":"outbound"}]},"disconnectType":{"type":"string","description":"System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.","enum":["endpoint","client","system","transfer","transfer.conference","transfer.consult","transfer.forward","error","peer","other","uncallable","timeout"],"x-genesys-enum-members":[{"name":"endpoint"},{"name":"client"},{"name":"system"},{"name":"transfer"},{"name":"transfer.conference"},{"name":"transfer.consult"},{"name":"transfer.forward"},{"name":"error"},{"name":"peer"},{"name":"other"},{"name":"uncallable"},{"name":"timeout"}]},"startHoldTime":{"type":"string","format":"date-time","description":"The timestamp the chat was placed on hold in the cloud clock if the chat is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startAlertingTime":{"type":"string","format":"date-time","description":"The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"disconnectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"provider":{"type":"string","description":"The source provider for the email."},"scriptId":{"type":"string","description":"The UUID of the script to use."},"peerId":{"type":"string","description":"The id of the peer communication corresponding to a matching leg for this communication."},"avatarImageUrl":{"type":"string","description":"If available, the URI to the avatar image of this communication."},"journeyContext":{"description":"A subset of the Journey System's data relevant to a part of a conversation (for external linkage and internal usage/context).","$ref":"#/definitions/JourneyContext"},"wrapup":{"description":"Call wrap up or disposition data.","$ref":"#/definitions/Wrapup"},"afterCallWork":{"description":"After-call work for the communication.","$ref":"#/definitions/AfterCallWork"},"afterCallWorkRequired":{"type":"boolean","description":"Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested."}}},"ConversationDivisionMembership":{"type":"object","properties":{"division":{"description":"A division the conversation belongs to.","$ref":"#/definitions/DomainEntityRef"},"entities":{"type":"array","description":"The entities on the conversation within the division. These are the users, queues, work flows, etc. that can be on conversations and and be assigned to different divisions.","items":{"$ref":"#/definitions/DomainEntityRef"}}}},"ConversationRoutingData":{"type":"object","properties":{"queue":{"description":"The queue to use for routing decisions","$ref":"#/definitions/AddressableEntityRef"},"language":{"description":"The language to use for routing decisions","$ref":"#/definitions/AddressableEntityRef"},"priority":{"type":"integer","format":"int32","description":"The priority of the conversation to use for routing decisions"},"skills":{"type":"array","description":"The skills to use for routing decisions","items":{"$ref":"#/definitions/AddressableEntityRef"}},"scoredAgents":{"type":"array","description":"A collection of agents and their assigned scores for this conversation (0 - 100, higher being better), for use in routing to preferred agents","items":{"$ref":"#/definitions/ScoredAgent"}}}},"Detail":{"type":"object","properties":{"errorCode":{"type":"string"},"fieldName":{"type":"string"},"entityId":{"type":"string"},"entityName":{"type":"string"}}},"DialerPreview":{"type":"object","properties":{"id":{"type":"string"},"contactId":{"type":"string","description":"The contact associated with this preview data pop"},"contactListId":{"type":"string","description":"The contactList associated with this preview data pop."},"campaignId":{"type":"string","description":"The campaignId associated with this preview data pop."},"phoneNumberColumns":{"type":"array","description":"The phone number columns associated with this campaign","items":{"$ref":"#/definitions/PhoneNumberColumn"}}}},"DisconnectReason":{"type":"object","properties":{"type":{"type":"string","description":"Disconnect reason protocol type.","enum":["q850","sip"],"x-genesys-enum-members":[{"name":"q850"},{"name":"sip"}]},"code":{"type":"integer","format":"int32","description":"Protocol specific reason code. See the Q.850 and SIP specs."},"phrase":{"type":"string","description":"Human readable English description of the disconnect reason."}}},"DomainEntity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DomainEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DomainEntity"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DomainEntityListingEvaluationForm":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/EvaluationForm"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Email":{"type":"object","properties":{"state":{"type":"string","description":"The connection state of this communication.","enum":["alerting","connected","disconnected","none","transmitting"],"x-genesys-enum-members":[{"name":"alerting"},{"name":"connected"},{"name":"disconnected"},{"name":"none"},{"name":"transmitting"}]},"id":{"type":"string","description":"A globally unique identifier for this communication."},"held":{"type":"boolean","description":"True if this call is held and the person on this side hears silence."},"subject":{"type":"string","description":"The subject for the initial email that started this conversation."},"messagesSent":{"type":"integer","format":"int32","description":"The number of email messages sent by this participant."},"segments":{"type":"array","description":"The time line of the participant's email, divided into activity segments.","items":{"$ref":"#/definitions/Segment"}},"direction":{"type":"string","description":"The direction of the email","enum":["inbound","outbound"],"x-genesys-enum-members":[{"name":"inbound"},{"name":"outbound"}]},"recordingId":{"type":"string","description":"A globally unique identifier for the recording associated with this call."},"errorInfo":{"$ref":"#/definitions/ErrorBody"},"disconnectType":{"type":"string","description":"System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.","enum":["endpoint","client","system","timeout","transfer","transfer.conference","transfer.consult","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam","uncallable"],"x-genesys-enum-members":[{"name":"endpoint"},{"name":"client"},{"name":"system"},{"name":"timeout"},{"name":"transfer"},{"name":"transfer.conference"},{"name":"transfer.consult"},{"name":"transfer.forward"},{"name":"transfer.noanswer"},{"name":"transfer.notavailable"},{"name":"transport.failure"},{"name":"error"},{"name":"peer"},{"name":"other"},{"name":"spam"},{"name":"uncallable"}]},"startHoldTime":{"type":"string","format":"date-time","description":"The timestamp the email was placed on hold in the cloud clock if the email is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startAlertingTime":{"type":"string","format":"date-time","description":"The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"disconnectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"autoGenerated":{"type":"boolean","description":"Indicates that the email was auto-generated like an Out of Office reply."},"provider":{"type":"string","description":"The source provider for the email."},"scriptId":{"type":"string","description":"The UUID of the script to use."},"peerId":{"type":"string","description":"The id of the peer communication corresponding to a matching leg for this communication."},"messageId":{"type":"string","description":"A globally unique identifier for the stored content of this communication."},"draftAttachments":{"type":"array","description":"A list of uploaded attachments on the email draft.","items":{"$ref":"#/definitions/Attachment"}},"spam":{"type":"boolean","description":"Indicates if the inbound email was marked as spam."},"wrapup":{"description":"Call wrap up or disposition data.","$ref":"#/definitions/Wrapup"},"afterCallWork":{"description":"After-call work for the communication.","$ref":"#/definitions/AfterCallWork"},"afterCallWorkRequired":{"type":"boolean","description":"Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested."}}},"EmailAddress":{"type":"object","properties":{"email":{"type":"string"},"name":{"type":"string"}}},"ErrorBody":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"string"},"status":{"type":"integer","format":"int32"},"entityId":{"type":"string"},"entityName":{"type":"string"},"messageWithParams":{"type":"string"},"messageParams":{"type":"object","additionalProperties":{"type":"string"}},"contextId":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/definitions/Detail"}},"errors":{"type":"array","items":{"$ref":"#/definitions/ErrorBody"}}}},"ErrorInfo":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"string"}}},"Evaluation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"conversation":{"$ref":"#/definitions/Conversation"},"evaluationForm":{"description":"Evaluation form used for evaluation.","$ref":"#/definitions/EvaluationForm"},"evaluator":{"$ref":"#/definitions/User"},"agent":{"$ref":"#/definitions/User"},"calibration":{"$ref":"#/definitions/Calibration"},"status":{"type":"string","enum":["PENDING","INPROGRESS","FINISHED"],"x-genesys-enum-members":[{"name":"PENDING"},{"name":"INPROGRESS"},{"name":"FINISHED"}]},"answers":{"$ref":"#/definitions/EvaluationScoringSet"},"agentHasRead":{"type":"boolean"},"releaseDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"assignedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"changedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"queue":{"$ref":"#/definitions/Queue"},"mediaType":{"type":"array","description":"List of different communication types used in conversation.","items":{"type":"string","enum":["CALL","CALLBACK","CHAT","COBROWSE","EMAIL","MESSAGE","SOCIAL_EXPRESSION","VIDEO","SCREENSHARE"],"x-genesys-enum-members":[{"name":"CALL"},{"name":"CALLBACK"},{"name":"CHAT"},{"name":"COBROWSE"},{"name":"EMAIL"},{"name":"MESSAGE"},{"name":"SOCIAL_EXPRESSION"},{"name":"VIDEO"},{"name":"SCREENSHARE"}]}},"rescore":{"type":"boolean","description":"Is only true when evaluation is re-scored."},"conversationDate":{"type":"string","format":"date-time","description":"Date of conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationEndDate":{"type":"string","format":"date-time","description":"End date of conversation if it had completed before evaluation creation. Null if created before the conversation ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"neverRelease":{"type":"boolean","description":"Signifies if the evaluation is never to be released. This cannot be set true if release date is also set."},"resourceId":{"type":"string","description":"Only used for email evaluations. Will be null for all other evaluations."},"resourceType":{"type":"string","description":"The type of resource. Only used for email evaluations. Will be null for evaluations on all other resources.","enum":["EMAIL"],"x-genesys-enum-members":[{"name":"EMAIL"}]},"redacted":{"type":"boolean","description":"Is only true when the user making the request does not have sufficient permissions to see evaluation"},"isScoringIndex":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EvaluationForm":{"type":"object","required":["name","questionGroups"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The evaluation form name"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"published":{"type":"boolean"},"contextId":{"type":"string"},"questionGroups":{"type":"array","description":"A list of question groups","items":{"$ref":"#/definitions/EvaluationQuestionGroup"}},"publishedVersions":{"$ref":"#/definitions/DomainEntityListingEvaluationForm"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EvaluationQuestion":{"type":"object","properties":{"id":{"type":"string"},"text":{"type":"string"},"helpText":{"type":"string"},"type":{"type":"string","enum":["multipleChoiceQuestion","freeTextQuestion","npsQuestion","readOnlyTextBlockQuestion"],"x-genesys-enum-members":[{"name":"multipleChoiceQuestion"},{"name":"freeTextQuestion"},{"name":"npsQuestion"},{"name":"readOnlyTextBlockQuestion"}]},"naEnabled":{"type":"boolean"},"commentsRequired":{"type":"boolean"},"visibilityCondition":{"$ref":"#/definitions/VisibilityCondition"},"answerOptions":{"type":"array","description":"Options from which to choose an answer for this question. Only used by Multiple Choice type questions.","items":{"$ref":"#/definitions/AnswerOption"}},"isKill":{"type":"boolean"},"isCritical":{"type":"boolean"}}},"EvaluationQuestionGroup":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"defaultAnswersToHighest":{"type":"boolean"},"defaultAnswersToNA":{"type":"boolean"},"naEnabled":{"type":"boolean"},"weight":{"type":"number","format":"float"},"manualWeight":{"type":"boolean"},"questions":{"type":"array","items":{"$ref":"#/definitions/EvaluationQuestion"}},"visibilityCondition":{"$ref":"#/definitions/VisibilityCondition"}}},"EvaluationQuestionGroupScore":{"type":"object","properties":{"questionGroupId":{"type":"string"},"totalScore":{"type":"number","format":"float"},"maxTotalScore":{"type":"number","format":"float"},"markedNA":{"type":"boolean"},"totalCriticalScore":{"type":"number","format":"float"},"maxTotalCriticalScore":{"type":"number","format":"float"},"totalNonCriticalScore":{"type":"number","format":"float"},"maxTotalNonCriticalScore":{"type":"number","format":"float"},"totalScoreUnweighted":{"type":"number","format":"float"},"maxTotalScoreUnweighted":{"type":"number","format":"float"},"totalCriticalScoreUnweighted":{"type":"number","format":"float"},"maxTotalCriticalScoreUnweighted":{"type":"number","format":"float"},"totalNonCriticalScoreUnweighted":{"type":"number","format":"float"},"maxTotalNonCriticalScoreUnweighted":{"type":"number","format":"float"},"questionScores":{"type":"array","items":{"$ref":"#/definitions/EvaluationQuestionScore"}}}},"EvaluationQuestionScore":{"type":"object","properties":{"questionId":{"type":"string"},"answerId":{"type":"string"},"score":{"type":"integer","format":"int32"},"markedNA":{"type":"boolean"},"failedKillQuestion":{"type":"boolean"},"comments":{"type":"string"}}},"EvaluationScoringSet":{"type":"object","properties":{"totalScore":{"type":"number","format":"float"},"totalCriticalScore":{"type":"number","format":"float"},"totalNonCriticalScore":{"type":"number","format":"float"},"questionGroupScores":{"type":"array","items":{"$ref":"#/definitions/EvaluationQuestionGroupScore"}},"anyFailedKillQuestions":{"type":"boolean"},"comments":{"type":"string"},"agentComments":{"type":"string"}}},"ExpansionCriterium":{"type":"object","properties":{"type":{"type":"string","enum":["TIMEOUT_SECONDS"],"x-genesys-enum-members":[{"name":"TIMEOUT_SECONDS"}]},"threshold":{"type":"number","format":"double"}}},"FaxStatus":{"type":"object","properties":{"direction":{"type":"string","description":"The fax direction, either \"send\" or \"receive\"."},"expectedPages":{"type":"integer","format":"int64","description":"Total number of expected pages, if known."},"activePage":{"type":"integer","format":"int64","description":"Active page of the transmission."},"linesTransmitted":{"type":"integer","format":"int64","description":"Number of lines that have completed transmission."},"bytesTransmitted":{"type":"integer","format":"int64","description":"Number of bytes that have competed transmission."},"baudRate":{"type":"integer","format":"int64","description":"Current signaling rate of transmission, baud rate."},"pageErrors":{"type":"integer","format":"int64","description":"Number of page errors."},"lineErrors":{"type":"integer","format":"int64","description":"Number of line errors."}}},"InboundRoute":{"type":"object","required":["fromEmail","fromName","pattern"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"pattern":{"type":"string","description":"The search pattern that the mailbox name should match."},"queue":{"description":"The queue to route the emails to.","$ref":"#/definitions/DomainEntityRef"},"priority":{"type":"integer","format":"int32","description":"The priority to use for routing."},"skills":{"type":"array","description":"The skills to use for routing.","items":{"$ref":"#/definitions/DomainEntityRef"}},"language":{"description":"The language to use for routing.","$ref":"#/definitions/DomainEntityRef"},"fromName":{"type":"string","description":"The sender name to use for outgoing replies."},"fromEmail":{"type":"string","description":"The sender email to use for outgoing replies."},"flow":{"description":"The flow to use for processing the email.","$ref":"#/definitions/DomainEntityRef"},"replyEmailAddress":{"description":"The route to use for email replies.","$ref":"#/definitions/QueueEmailAddress"},"autoBcc":{"type":"array","description":"The recipients that should be automatically blind copied on outbound emails associated with this InboundRoute.","items":{"$ref":"#/definitions/EmailAddress"}},"spamFlow":{"description":"The flow to use for processing inbound emails that have been marked as spam.","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"JourneyAction":{"type":"object","required":["actionMap","id"],"properties":{"id":{"type":"string","description":"The ID of an action from the Journey System (an action is spawned from an actionMap)"},"actionMap":{"description":"Details about the action map from the Journey System which triggered this action","$ref":"#/definitions/JourneyActionMap"}}},"JourneyActionMap":{"type":"object","required":["id","version"],"properties":{"id":{"type":"string","description":"The ID of the actionMap in the Journey System which triggered this action"},"version":{"type":"integer","format":"int32","description":"The version number of the actionMap in the Journey System at the time this action was triggered"}}},"JourneyContext":{"type":"object","required":["customer"],"properties":{"customer":{"description":"A subset of the Journey System's customer data at a point-in-time (for external linkage and internal usage/context)","$ref":"#/definitions/JourneyCustomer"},"customerSession":{"description":"A subset of the Journey System's tracked customer session data at a point-in-time (for external linkage and internal usage/context)","$ref":"#/definitions/JourneyCustomerSession"},"triggeringAction":{"description":"A subset of the Journey System's action data relevant to a part of a conversation (for external linkage and internal usage/context)","$ref":"#/definitions/JourneyAction"}}},"JourneyCustomer":{"type":"object","required":["id","idType"],"properties":{"id":{"type":"string","description":"An ID of a customer within the Journey System at a point-in-time. Note that a customer entity can have multiple customerIds based on the stitching process. Depending on the context within the PureCloud conversation, this may or may not be mutable."},"idType":{"type":"string","description":"The type of the customerId within the Journey System (e.g. cookie)."}}},"JourneyCustomerSession":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"An ID of a Customer/User's session within the Journey System at a point-in-time"},"type":{"type":"string","description":"The type of the Customer/User's session within the Journey System (e.g. web, app)"}}},"MediaSetting":{"type":"object","properties":{"alertingTimeoutSeconds":{"type":"integer","format":"int32"},"serviceLevel":{"$ref":"#/definitions/ServiceLevel"}}},"Message":{"type":"object","properties":{"state":{"type":"string","description":"The connection state of this communication.","enum":["alerting","connected","disconnected"],"x-genesys-enum-members":[{"name":"alerting"},{"name":"connected"},{"name":"disconnected"}]},"id":{"type":"string","description":"A globally unique identifier for this communication."},"held":{"type":"boolean","description":"True if this call is held and the person on this side hears silence."},"segments":{"type":"array","description":"The time line of the participant's message, divided into activity segments.","items":{"$ref":"#/definitions/Segment"}},"direction":{"type":"string","description":"The direction of the message.","enum":["inbound","outbound"],"x-genesys-enum-members":[{"name":"inbound"},{"name":"outbound"}]},"recordingId":{"type":"string","description":"A globally unique identifier for the recording associated with this message."},"errorInfo":{"$ref":"#/definitions/ErrorBody"},"disconnectType":{"type":"string","description":"System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.","enum":["endpoint","client","system","timeout","transfer","transfer.conference","transfer.consult","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam","uncallable"],"x-genesys-enum-members":[{"name":"endpoint"},{"name":"client"},{"name":"system"},{"name":"timeout"},{"name":"transfer"},{"name":"transfer.conference"},{"name":"transfer.consult"},{"name":"transfer.forward"},{"name":"transfer.noanswer"},{"name":"transfer.notavailable"},{"name":"transport.failure"},{"name":"error"},{"name":"peer"},{"name":"other"},{"name":"spam"},{"name":"uncallable"}]},"startHoldTime":{"type":"string","format":"date-time","description":"The timestamp the message was placed on hold in the cloud clock if the message is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startAlertingTime":{"type":"string","format":"date-time","description":"The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"disconnectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"provider":{"type":"string","description":"The source provider for the message."},"type":{"type":"string","description":"Indicates the type of message platform from which the message originated.","enum":["unknown","sms","twitter","facebook","line","whatsapp","telegram","kakao","webmessaging"],"x-genesys-enum-members":[{"name":"unknown"},{"name":"sms"},{"name":"twitter"},{"name":"facebook"},{"name":"line"},{"name":"whatsapp"},{"name":"telegram"},{"name":"kakao"},{"name":"webmessaging"}]},"recipientCountry":{"type":"string","description":"Indicates the country where the recipient is associated in ISO 3166-1 alpha-2 format."},"recipientType":{"type":"string","description":"The type of the recipient. Eg: Provisioned phoneNumber is the recipient for sms message type."},"scriptId":{"type":"string","description":"The UUID of the script to use."},"peerId":{"type":"string","description":"The id of the peer communication corresponding to a matching leg for this communication."},"toAddress":{"description":"Address and name data for a call endpoint.","$ref":"#/definitions/Address"},"fromAddress":{"description":"Address and name data for a call endpoint.","$ref":"#/definitions/Address"},"messages":{"type":"array","description":"The messages sent on this communication channel.","items":{"$ref":"#/definitions/MessageDetails"}},"journeyContext":{"description":"A subset of the Journey System's data relevant to a part of a conversation (for external linkage and internal usage/context).","$ref":"#/definitions/JourneyContext"},"wrapup":{"description":"Call wrap up or disposition data.","$ref":"#/definitions/Wrapup"},"afterCallWork":{"description":"After-call work for the communication.","$ref":"#/definitions/AfterCallWork"},"afterCallWorkRequired":{"type":"boolean","description":"Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested."}}},"MessageDetails":{"type":"object","properties":{"messageId":{"type":"string","description":"UUID identifying the message media."},"messageURI":{"type":"string","format":"uri","description":"A URI for this message entity."},"messageStatus":{"type":"string","description":"Indicates the delivery status of the message.","enum":["queued","sent","failed","received","delivery-success","delivery-failed","read"],"x-genesys-enum-members":[{"name":"queued"},{"name":"sent"},{"name":"failed"},{"name":"received"},{"name":"delivery-success"},{"name":"delivery-failed"},{"name":"read"}]},"messageSegmentCount":{"type":"integer","format":"int32","description":"The message segment count, greater than 1 if the message content was split into multiple parts for this message type, e.g. SMS character limits."},"messageTime":{"type":"string","format":"date-time","description":"The time when the message was sent or received. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"media":{"type":"array","description":"The media (images, files, etc) associated with this message, if any","items":{"$ref":"#/definitions/MessageMedia"}},"stickers":{"type":"array","description":"One or more stickers associated with this message, if any","items":{"$ref":"#/definitions/MessageSticker"}}}},"MessageMedia":{"type":"object","properties":{"url":{"type":"string","description":"The location of the media, useful for retrieving it"},"mediaType":{"type":"string","description":"The optional internet media type of the the media object. If null then the media type should be dictated by the url"},"contentLengthBytes":{"type":"integer","format":"int32","description":"The optional content length of the the media object, in bytes."},"name":{"type":"string","description":"The optional name of the the media object."},"id":{"type":"string","description":"The optional id of the the media object."}}},"MessageSticker":{"type":"object","properties":{"url":{"type":"string","description":"The location of the sticker, useful for retrieving it"},"id":{"type":"string","description":"The unique id of the the sticker object."}}},"Page":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"versionId":{"type":"string"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"rootContainer":{"type":"object","additionalProperties":{"type":"object"}},"properties":{"type":"object","additionalProperties":{"type":"object"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Participant":{"type":"object","properties":{"id":{"type":"string","description":"A globally unique identifier for this conversation."},"startTime":{"type":"string","format":"date-time","description":"The timestamp when this participant joined the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The timestamp when this participant disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The timestamp when this participant was connected to the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"name":{"type":"string","description":"A human readable name identifying the participant."},"userUri":{"type":"string","description":"If this participant represents a user, then this will be an URI that can be used to fetch the user."},"userId":{"type":"string","description":"If this participant represents a user, then this will be the globally unique identifier for the user."},"externalContactId":{"type":"string","description":"If this participant represents an external contact, then this will be the globally unique identifier for the external contact."},"externalOrganizationId":{"type":"string","description":"If this participant represents an external org, then this will be the globally unique identifier for the external org."},"queueId":{"type":"string","description":"If present, the queue id that the communication channel came in on."},"groupId":{"type":"string","description":"If present, group of users the participant represents."},"teamId":{"type":"string","description":"The team id that this participant is a member of when added to the conversation."},"queueName":{"type":"string","description":"If present, the queue name that the communication channel came in on."},"purpose":{"type":"string","description":"A well known string that specifies the purpose of this participant."},"participantType":{"type":"string","description":"A well known string that specifies the type of this participant."},"consultParticipantId":{"type":"string","description":"If this participant is part of a consult transfer, then this will be the participant id of the participant being transferred."},"address":{"type":"string","description":"The address for the this participant. For a phone call this will be the ANI."},"ani":{"type":"string","description":"The address for the this participant. For a phone call this will be the ANI."},"aniName":{"type":"string","description":"The ani-based name for this participant."},"dnis":{"type":"string","description":"The address for the this participant. For a phone call this will be the ANI."},"locale":{"type":"string","description":"An ISO 639 language code specifying the locale for this participant"},"wrapupRequired":{"type":"boolean","description":"True iff this participant is required to enter wrapup for this conversation."},"wrapupPrompt":{"type":"string","description":"This field controls how the UI prompts the agent for a wrapup.","enum":["mandatory","optional","agentRequested","timeout","forcedTimeout"],"x-genesys-enum-members":[{"name":"mandatory"},{"name":"optional"},{"name":"agentRequested"},{"name":"timeout"},{"name":"forcedTimeout"}]},"wrapupTimeoutMs":{"type":"integer","format":"int32","description":"Specifies how long a timed ACW session will last."},"wrapupSkipped":{"type":"boolean","description":"The UI sets this field when the agent chooses to skip entering a wrapup for this participant."},"wrapup":{"description":"Call wrap up or disposition data.","$ref":"#/definitions/Wrapup"},"conversationRoutingData":{"description":"Information on how a communication should be routed to an agent.","$ref":"#/definitions/ConversationRoutingData"},"alertingTimeoutMs":{"type":"integer","format":"int32","description":"Specifies how long the agent has to answer an interaction before being marked as not responding."},"monitoredParticipantId":{"type":"string","description":"If this participant is a monitor, then this will be the id of the participant that is being monitored."},"coachedParticipantId":{"type":"string","description":"If this participant is a coach, then this will be the id of the participant that is being coached."},"attributes":{"type":"object","description":"Additional participant attributes","additionalProperties":{"type":"string"}},"calls":{"type":"array","items":{"$ref":"#/definitions/Call"}},"callbacks":{"type":"array","items":{"$ref":"#/definitions/Callback"}},"chats":{"type":"array","items":{"$ref":"#/definitions/ConversationChat"}},"cobrowsesessions":{"type":"array","items":{"$ref":"#/definitions/Cobrowsesession"}},"emails":{"type":"array","items":{"$ref":"#/definitions/Email"}},"messages":{"type":"array","items":{"$ref":"#/definitions/Message"}},"screenshares":{"type":"array","items":{"$ref":"#/definitions/Screenshare"}},"socialExpressions":{"type":"array","items":{"$ref":"#/definitions/SocialExpression"}},"videos":{"type":"array","items":{"$ref":"#/definitions/Video"}},"evaluations":{"type":"array","items":{"$ref":"#/definitions/Evaluation"}},"screenRecordingState":{"type":"string","description":"The current screen recording state for this participant.","enum":["requested","active","paused","stopped","error","timeout"],"x-genesys-enum-members":[{"name":"requested"},{"name":"active"},{"name":"paused"},{"name":"stopped"},{"name":"error"},{"name":"timeout"}]},"flaggedReason":{"type":"string","description":"The reason specifying why participant flagged the conversation.","enum":["general"],"x-genesys-enum-members":[{"name":"general"}]},"startAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"PhoneNumberColumn":{"type":"object","properties":{"columnName":{"type":"string"},"type":{"type":"string"}}},"Queue":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The queue description."},"dateCreated":{"type":"string","format":"date-time","description":"The date the queue was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the queue. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the queue."},"createdBy":{"type":"string","description":"The ID of the user that created the queue."},"memberCount":{"type":"integer","format":"int32","description":"The number of users in the queue.","readOnly":true},"mediaSettings":{"type":"object","description":"The media settings for the queue. Valid key values: CALL, CALLBACK, CHAT, EMAIL, MESSAGE, SOCIAL_EXPRESSION, VIDEO_COMM","additionalProperties":{"$ref":"#/definitions/MediaSetting"}},"routingRules":{"type":"array","description":"The routing rules for the queue, used for routing to known or preferred agents.","items":{"$ref":"#/definitions/RoutingRule"}},"bullseye":{"description":"The bulls-eye settings for the queue.","$ref":"#/definitions/Bullseye"},"acwSettings":{"description":"The ACW settings for the queue.","$ref":"#/definitions/AcwSettings"},"skillEvaluationMethod":{"type":"string","description":"The skill evaluation method to use when routing conversations.","enum":["NONE","BEST","ALL"],"x-genesys-enum-members":[{"name":"NONE"},{"name":"BEST"},{"name":"ALL"}]},"queueFlow":{"description":"The in-queue flow to use for conversations waiting in queue.","$ref":"#/definitions/DomainEntityRef"},"whisperPrompt":{"description":"The prompt used for whisper on the queue, if configured.","$ref":"#/definitions/DomainEntityRef"},"autoAnswerOnly":{"type":"boolean","description":"Specifies whether the configured whisper should play for all ACD calls, or only for those which are auto-answered."},"enableTranscription":{"type":"boolean","description":"Indicates whether voice transcription is enabled for this queue."},"enableManualAssignment":{"type":"boolean","description":"Indicates whether manual assignment is enabled for this queue."},"callingPartyName":{"type":"string","description":"The name to use for caller identification for outbound calls from this queue."},"callingPartyNumber":{"type":"string","description":"The phone number to use for caller identification for outbound calls from this queue."},"defaultScripts":{"type":"object","description":"The default script Ids for the communication types.","additionalProperties":{"$ref":"#/definitions/Script"}},"outboundMessagingAddresses":{"description":"The messaging addresses for the queue.","$ref":"#/definitions/QueueMessagingAddresses"},"outboundEmailAddress":{"$ref":"#/definitions/QueueEmailAddress"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"QueueEmailAddress":{"type":"object","properties":{"domain":{"$ref":"#/definitions/DomainEntityRef"},"route":{"$ref":"#/definitions/InboundRoute"}}},"QueueMessagingAddresses":{"type":"object","properties":{"smsAddress":{"$ref":"#/definitions/DomainEntityRef"}}},"Ring":{"type":"object","properties":{"expansionCriteria":{"type":"array","items":{"$ref":"#/definitions/ExpansionCriterium"}},"actions":{"$ref":"#/definitions/Actions"}}},"RoutingRule":{"type":"object","properties":{"operator":{"type":"string","description":"matching operator. MEETS_THRESHOLD matches any agent with a score at or above the rule's threshold. ANY matches all specified agents, regardless of score.","enum":["MEETS_THRESHOLD","ANY"],"x-genesys-enum-members":[{"name":"MEETS_THRESHOLD"},{"name":"ANY"}]},"threshold":{"type":"integer","format":"int32","description":"threshold required for routing attempt (generally an agent score). may be null for operator ANY."},"waitSeconds":{"type":"number","format":"double","description":"seconds to wait in this rule before moving to the next"}}},"ScoredAgent":{"type":"object","properties":{"agent":{"description":"The agent","$ref":"#/definitions/AddressableEntityRef"},"score":{"type":"integer","format":"int32","description":"Agent's score for the current conversation, from 0 - 100, higher being better"}}},"Screenshare":{"type":"object","properties":{"state":{"type":"string","description":"The connection state of this communication.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","none"],"x-genesys-enum-members":[{"name":"alerting"},{"name":"dialing"},{"name":"contacting"},{"name":"offering"},{"name":"connected"},{"name":"disconnected"},{"name":"terminated"},{"name":"none"}]},"id":{"type":"string","description":"A globally unique identifier for this communication."},"context":{"type":"string","description":"The room id context (xmpp jid) for the conference session."},"sharing":{"type":"boolean","description":"Indicates whether this participant is sharing their screen."},"peerCount":{"type":"integer","format":"int32","description":"The number of peer participants from the perspective of the participant in the conference."},"disconnectType":{"type":"string","description":"System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.","enum":["endpoint","client","system","timeout","transfer","transfer.conference","transfer.consult","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam","uncallable"],"x-genesys-enum-members":[{"name":"endpoint"},{"name":"client"},{"name":"system"},{"name":"timeout"},{"name":"transfer"},{"name":"transfer.conference"},{"name":"transfer.consult"},{"name":"transfer.forward"},{"name":"transfer.noanswer"},{"name":"transfer.notavailable"},{"name":"transport.failure"},{"name":"error"},{"name":"peer"},{"name":"other"},{"name":"spam"},{"name":"uncallable"}]},"startAlertingTime":{"type":"string","format":"date-time","description":"The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"disconnectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"provider":{"type":"string","description":"The source provider for the screen share."},"peerId":{"type":"string","description":"The id of the peer communication corresponding to a matching leg for this communication."},"segments":{"type":"array","description":"The time line of the participant's call, divided into activity segments.","items":{"$ref":"#/definitions/Segment"}},"wrapup":{"description":"Call wrap up or disposition data.","$ref":"#/definitions/Wrapup"},"afterCallWork":{"description":"After-call work for the communication.","$ref":"#/definitions/AfterCallWork"},"afterCallWorkRequired":{"type":"boolean","description":"Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested."}}},"Script":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"versionId":{"type":"string"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"publishedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"versionDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startPageId":{"type":"string"},"startPageName":{"type":"string"},"features":{"type":"object"},"variables":{"type":"object"},"customActions":{"type":"object"},"pages":{"type":"array","items":{"$ref":"#/definitions/Page"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Segment":{"type":"object","required":["endTime","startTime"],"properties":{"startTime":{"type":"string","format":"date-time","description":"The timestamp when this segment began. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The timestamp when this segment ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"type":{"type":"string","description":"The activity taking place for the participant in the segment."},"howEnded":{"type":"string","description":"A description of the event that ended the segment."},"disconnectType":{"type":"string","description":"A description of the event that disconnected the segment"}}},"ServiceLevel":{"type":"object","properties":{"percentage":{"type":"number","format":"double","description":"The desired Service Level. A value between 0 and 1."},"durationMs":{"type":"integer","format":"int64","description":"Service Level target in milliseconds."}}},"SkillsToRemove":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"selfUri":{"type":"string","format":"uri"}}},"SocialExpression":{"type":"object","properties":{"state":{"type":"string","description":"The connection state of this communication.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","none"],"x-genesys-enum-members":[{"name":"alerting"},{"name":"dialing"},{"name":"contacting"},{"name":"offering"},{"name":"connected"},{"name":"disconnected"},{"name":"terminated"},{"name":"none"}]},"id":{"type":"string","description":"A globally unique identifier for this communication."},"socialMediaId":{"type":"string","description":"A globally unique identifier for the social media."},"socialMediaHub":{"type":"string","description":"The social network of the communication"},"socialUserName":{"type":"string","description":"The user name for the communication."},"previewText":{"type":"string","description":"The text preview of the communication contents"},"recordingId":{"type":"string","description":"A globally unique identifier for the recording associated with this chat."},"segments":{"type":"array","description":"The time line of the participant's chat, divided into activity segments.","items":{"$ref":"#/definitions/Segment"}},"held":{"type":"boolean","description":"True if this call is held and the person on this side hears silence."},"disconnectType":{"type":"string","description":"System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.","enum":["endpoint","client","system","timeout","transfer","transfer.conference","transfer.consult","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam","uncallable"],"x-genesys-enum-members":[{"name":"endpoint"},{"name":"client"},{"name":"system"},{"name":"timeout"},{"name":"transfer"},{"name":"transfer.conference"},{"name":"transfer.consult"},{"name":"transfer.forward"},{"name":"transfer.noanswer"},{"name":"transfer.notavailable"},{"name":"transport.failure"},{"name":"error"},{"name":"peer"},{"name":"other"},{"name":"spam"},{"name":"uncallable"}]},"startHoldTime":{"type":"string","format":"date-time","description":"The timestamp the chat was placed on hold in the cloud clock if the chat is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startAlertingTime":{"type":"string","format":"date-time","description":"The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"disconnectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"provider":{"type":"string","description":"The source provider for the social expression."},"scriptId":{"type":"string","description":"The UUID of the script to use."},"peerId":{"type":"string","description":"The id of the peer communication corresponding to a matching leg for this communication."},"wrapup":{"description":"Call wrap up or disposition data.","$ref":"#/definitions/Wrapup"},"afterCallWork":{"description":"After-call work for the communication.","$ref":"#/definitions/AfterCallWork"},"afterCallWorkRequired":{"type":"boolean","description":"Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested."}}},"Video":{"type":"object","properties":{"state":{"type":"string","description":"The connection state of this communication.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","none"],"x-genesys-enum-members":[{"name":"alerting"},{"name":"dialing"},{"name":"contacting"},{"name":"offering"},{"name":"connected"},{"name":"disconnected"},{"name":"terminated"},{"name":"none"}]},"id":{"type":"string","description":"A globally unique identifier for this communication."},"context":{"type":"string","description":"The room id context (xmpp jid) for the conference session."},"audioMuted":{"type":"boolean","description":"Indicates whether this participant has muted their outgoing audio."},"videoMuted":{"type":"boolean","description":"Indicates whether this participant has muted/paused their outgoing video."},"sharingScreen":{"type":"boolean","description":"Indicates whether this participant is sharing their screen to the session."},"peerCount":{"type":"integer","format":"int32","description":"The number of peer participants from the perspective of the participant in the conference."},"disconnectType":{"type":"string","description":"System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.","enum":["endpoint","client","system","timeout","transfer","transfer.conference","transfer.consult","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam","uncallable"],"x-genesys-enum-members":[{"name":"endpoint"},{"name":"client"},{"name":"system"},{"name":"timeout"},{"name":"transfer"},{"name":"transfer.conference"},{"name":"transfer.consult"},{"name":"transfer.forward"},{"name":"transfer.noanswer"},{"name":"transfer.notavailable"},{"name":"transport.failure"},{"name":"error"},{"name":"peer"},{"name":"other"},{"name":"spam"},{"name":"uncallable"}]},"startAlertingTime":{"type":"string","format":"date-time","description":"The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"disconnectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"provider":{"type":"string","description":"The source provider for the video."},"peerId":{"type":"string","description":"The id of the peer communication corresponding to a matching leg for this communication."},"msids":{"type":"array","description":"List of media stream ids","items":{"type":"string"}},"self":{"description":"Address and name data for a call endpoint.","$ref":"#/definitions/Address"},"wrapup":{"description":"Call wrap up or disposition data.","$ref":"#/definitions/Wrapup"},"afterCallWork":{"description":"After-call work for the communication.","$ref":"#/definitions/AfterCallWork"},"afterCallWorkRequired":{"type":"boolean","description":"Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested."}}},"VisibilityCondition":{"type":"object","properties":{"combiningOperation":{"type":"string","enum":["AND","OR"],"x-genesys-enum-members":[{"name":"AND"},{"name":"OR"}]},"predicates":{"type":"array","description":"A list of strings, each representing the location in the form of the Answer Option to depend on. In the format of \"/form/questionGroup/{questionGroupIndex}/question/{questionIndex}/answer/{answerIndex}\" or, to assume the current question group, \"../question/{questionIndex}/answer/{answerIndex}\". Note: Indexes are zero-based","items":{"type":"object"}}}},"Voicemail":{"type":"object","properties":{"id":{"type":"string","description":"The voicemail id"},"uploadStatus":{"type":"string","description":"current state of the voicemail upload","enum":["pending","complete","failed","timeout","none"],"x-genesys-enum-members":[{"name":"pending"},{"name":"complete"},{"name":"failed"},{"name":"timeout"},{"name":"none"}]}}},"Wrapup":{"type":"object","properties":{"code":{"type":"string","description":"The user configured wrap up code id."},"name":{"type":"string","description":"The user configured wrap up code name."},"notes":{"type":"string","description":"Text entered by the agent to describe the call or disposition."},"tags":{"type":"array","description":"List of tags selected by the agent to describe the call or disposition.","items":{"type":"string"}},"durationSeconds":{"type":"integer","format":"int32","description":"The length of time in seconds that the agent spent doing after call work."},"endTime":{"type":"string","format":"date-time","description":"The timestamp when the wrapup was finished. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"provisional":{"type":"boolean","description":"Indicates if this is a pending save and should not require a code to be specified. This allows someone to save some temporary wrapup that will be used later."}}},"Annotation":{"type":"object","required":["agentScoreModifier","customerScoreModifier"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"type":{"type":"string"},"location":{"type":"integer","format":"int64","description":"Offset of annotation in milliseconds."},"durationMs":{"type":"integer","format":"int64","description":"Duration of annotation in milliseconds."},"absoluteLocation":{"type":"integer","format":"int64","description":"Offset of annotation (milliseconds) from start of recording."},"absoluteDurationMs":{"type":"integer","format":"int64","description":"Duration of annotation (milliseconds)."},"recordingLocation":{"type":"integer","format":"int64","description":"Offset of annotation (milliseconds) from start of recording, adjusted for any recording cuts"},"recordingDurationMs":{"type":"integer","format":"int64","description":"Duration of annotation (milliseconds), adjusted for any recording cuts."},"user":{"description":"User that created this annotation (if any).","$ref":"#/definitions/User"},"description":{"type":"string","description":"Text of annotation."},"keywordName":{"type":"string","description":"The word or phrase which is being looked for with speech recognition."},"confidence":{"type":"number","format":"float","description":"Actual confidence that this is an accurate match."},"keywordSetId":{"type":"string","description":"A unique identifier for the keyword set to which this spotted keyword belongs."},"keywordSetName":{"type":"string","description":"The keyword set to which this spotted keyword belongs."},"utterance":{"type":"string","description":"The phonetic spellings for the phrase and alternate spellings."},"timeBegin":{"type":"string","description":"Beginning time offset of the keyword spot match."},"timeEnd":{"type":"string","description":"Ending time offset of the keyword spot match."},"keywordConfidenceThreshold":{"type":"string","description":"Configured sensitivity threshold that can be increased to lower false positives or decreased to reduce false negatives."},"agentScoreModifier":{"type":"string","description":"A modifier to the evaluation score when the phrase is spotted in the agent channel."},"customerScoreModifier":{"type":"string","description":"A modifier to the evaluation score when the phrase is spotted in the customer channel."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ChatMessage":{"type":"object","properties":{"body":{"type":"string","description":"The message body"},"id":{"type":"string"},"to":{"type":"string","description":"The message recipient"},"from":{"type":"string","description":"The message sender"},"utc":{"type":"string"},"chat":{"type":"string","description":"The interaction id (if available)"},"message":{"type":"string","description":"The message id"},"type":{"type":"string"},"bodyType":{"type":"string","description":"Type of the message body (v2 chats only)","enum":["STANDARD","ACTIVITY","TYPING","NOTICE","MEMBERJOIN","MEMBERLEAVE","MEDIAREQUEST"],"x-genesys-enum-members":[{"name":"STANDARD"},{"name":"ACTIVITY"},{"name":"TYPING"},{"name":"NOTICE"},{"name":"MEMBERJOIN"},{"name":"MEMBERLEAVE"},{"name":"MEDIAREQUEST"}]},"senderCommunicationId":{"type":"string","description":"Communication of sender (v2 chats only)"},"participantPurpose":{"type":"string","description":"Participant purpose of sender (v2 chats only)"},"user":{"description":"The user information for the sender (if available)","$ref":"#/definitions/ChatMessageUser"}}},"ChatMessageUser":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"displayName":{"type":"string"},"username":{"type":"string"},"images":{"type":"array","items":{"$ref":"#/definitions/UserImage"}}}},"ContactAddress":{"type":"object","properties":{"address1":{"type":"string"},"address2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"postalCode":{"type":"string"},"countryCode":{"type":"string"}}},"DataSchema":{"type":"object","required":["jsonSchema","version"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"version":{"type":"integer","format":"int32","description":"The schema's version, a positive integer. Required for updates."},"appliesTo":{"type":"array","description":"One of \"CONTACT\" or \"EXTERNAL_ORGANIZATION\". Indicates the built-in entity type to which this schema applies.","readOnly":true,"items":{"type":"string","enum":["CONTACT","EXTERNAL_ORGANIZATION"],"x-genesys-enum-members":[{"name":"CONTACT"},{"name":"EXTERNAL_ORGANIZATION"}]}},"enabled":{"type":"boolean","description":"The schema's enabled/disabled status. A disabled schema cannot be assigned to any other entities, but the data on those entities from the schema still exists."},"createdBy":{"description":"The URI of the user that created this schema.","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"dateCreated":{"type":"string","format":"date-time","description":"The date and time this schema was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"jsonSchema":{"example":"{\n \"appliesTo\": [\n \"CONTACT\"\n ],\n \"jsonSchema\": {\n \"title\": \"Example schema\",\n \"description\": \"Uses all of the core types for illustrative purposes\",\n \"properties\": {\n \"field1_text\": {\n \"title\": \"Field 1\",\n \"description\": \"field1\",\n \"allOf\": [ { \"$ref\": \"#/definitions/text\" } ],\n \"minLength\": 0,\n \"maxLength\": 39\n },\n \"field2_longtext\": {\n \"title\": \"Field 2\",\n \"description\": \"field2\",\n \"allOf\": [ { \"$ref\": \"#/definitions/longtext\" } ],\n \"minLength\": 0,\n \"maxLength\": 1000\n },\n \"field3_enum\": {\n \"title\": \"Field 3\",\n \"description\": \"Field 3\",\n \"allOf\": [ { \"$ref\": \"#/definitions/enum\" } ],\n \"enum\": [\n \"enum1\",\n \"enum2\"\n ]\n },\n \"field4_identifier\": {\n \"title\": \"field4\",\n \"description\": \"Field 4\",\n \"allOf\": [ { \"$ref\": \"#/definitions/identifier\" } ],\n \"minLength\": 0,\n \"maxLength\": 37\n },\n \"field5_integer\": {\n \"title\": \"field5\",\n \"description\": \"Field 5\",\n \"allOf\": [ { \"$ref\": \"#/definitions/integer\" } ],\n \"minimum\": 1,\n \"maximum\": 24\n },\n \"field6_number\": {\n \"title\": \"field6\",\n \"description\": \"Field 6\",\n \"allOf\": [ { \"$ref\": \"#/definitions/number\" } ],\n \"minimum\": 2.7,\n \"maximum\": 31.3\n },\n \"field7_date\": {\n \"title\": \"field7\",\n \"description\": \"Field 7\",\n \"allOf\": [ { \"$ref\": \"#/definitions/date\"}]\n },\n \"field8_datetime\": {\n \"title\": \"field8\",\n \"description\": \"Field 8\",\n \"allOf\": [ { \"$ref\": \"#/definitions/datetime\"}]\n },\n \"field9_checkbox\": {\n \"title\": \"field9\",\n \"description\": \"Field 9\",\n \"allOf\": [ { \"$ref\": \"#/definitions/checkbox\"}]\n },\n \"field10_tag\": {\n \"title\": \"field10\",\n \"description\": \"Field 10\",\n \"allOf\": [ { \"$ref\": \"#/definitions/tag\" } ],\n \"items\": {\n \"minLength\": 1,\n \"maxLength\": 20\n },\n \"minItems\": 0,\n \"maxItems\": 10,\n \"uniqueItems\": true\n }\n },\n \"$schema\": \"http://json-schema.org/draft-04/schema#\"\n }\n}","description":"A JSON schema defining the extension to the built-in entity type.","$ref":"#/definitions/JsonSchemaDocument"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EmailAttachment":{"type":"object","properties":{"name":{"type":"string"},"contentPath":{"type":"string"},"contentType":{"type":"string"},"attachmentId":{"type":"string"},"contentLength":{"type":"integer","format":"int32"}}},"Endpoint":{"type":"object","required":["name","schema"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"count":{"type":"integer","format":"int32"},"properties":{"type":"object","additionalProperties":{"type":"object"}},"schema":{"description":"Schema","$ref":"#/definitions/DomainEntityRef"},"enabled":{"type":"boolean"},"site":{"$ref":"#/definitions/DomainEntityRef"},"dids":{"type":"array","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ExternalContact":{"type":"object","required":["firstName","lastName"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"firstName":{"type":"string","description":"The first name of the contact."},"middleName":{"type":"string"},"lastName":{"type":"string","description":"The last name of the contact."},"salutation":{"type":"string"},"title":{"type":"string"},"workPhone":{"$ref":"#/definitions/PhoneNumber"},"cellPhone":{"$ref":"#/definitions/PhoneNumber"},"homePhone":{"$ref":"#/definitions/PhoneNumber"},"otherPhone":{"$ref":"#/definitions/PhoneNumber"},"workEmail":{"type":"string"},"personalEmail":{"type":"string"},"otherEmail":{"type":"string"},"address":{"$ref":"#/definitions/ContactAddress"},"twitterId":{"$ref":"#/definitions/TwitterId"},"lineId":{"$ref":"#/definitions/LineId"},"whatsAppId":{"$ref":"#/definitions/WhatsAppId"},"facebookId":{"$ref":"#/definitions/FacebookId"},"modifyDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"externalOrganization":{"$ref":"#/definitions/ExternalOrganization"},"surveyOptOut":{"type":"boolean"},"externalSystemUrl":{"type":"string","description":"A string that identifies an external system-of-record resource that may have more detailed information on the contact. It should be a valid URL (including the http/https protocol, port, and path [if any]). The value is automatically trimmed of any leading and trailing whitespace."},"schema":{"description":"The schema defining custom fields for this contact","$ref":"#/definitions/DataSchema"},"customFields":{"type":"object","description":"Custom fields defined in the schema referenced by schemaId and schemaVersion.","additionalProperties":{"type":"object"}},"externalDataSources":{"type":"array","description":"Links to the sources of data (e.g. one source might be a CRM) that contributed data to this record. Read-only, and only populated when requested via expand param.","readOnly":true,"items":{"$ref":"#/definitions/ExternalDataSource"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ExternalDataSource":{"type":"object","properties":{"platform":{"type":"string","description":"The platform that was the source of the data. Example: a CRM like SALESFORCE.","enum":["SALESFORCE"]},"url":{"type":"string","description":"An URL that links to the source record that contributed data to the associated entity."}},"description":"Describes a link to a record in an external system that contributed data to a Relate record"},"ExternalOrganization":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"name":{"type":"string","description":"The name of the company."},"companyType":{"type":"string"},"industry":{"type":"string"},"primaryContactId":{"type":"string"},"address":{"$ref":"#/definitions/ContactAddress"},"phoneNumber":{"$ref":"#/definitions/PhoneNumber"},"faxNumber":{"$ref":"#/definitions/PhoneNumber"},"employeeCount":{"type":"integer","format":"int64"},"revenue":{"type":"integer","format":"int64"},"tags":{"type":"array","items":{"type":"string"}},"websites":{"type":"array","items":{"type":"string"}},"tickers":{"type":"array","items":{"$ref":"#/definitions/Ticker"}},"twitterId":{"$ref":"#/definitions/TwitterId"},"externalSystemUrl":{"type":"string","description":"A string that identifies an external system-of-record resource that may have more detailed information on the organization. It should be a valid URL (including the http/https protocol, port, and path [if any]). The value is automatically trimmed of any leading and trailing whitespace."},"modifyDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"trustor":{"$ref":"#/definitions/Trustor"},"schema":{"description":"The schema defining custom fields for this contact","$ref":"#/definitions/DataSchema"},"customFields":{"type":"object","description":"Custom fields defined in the schema referenced by schemaId and schemaVersion.","additionalProperties":{"type":"object"}},"externalDataSources":{"type":"array","description":"Links to the sources of data (e.g. one source might be a CRM) that contributed data to this record. Read-only, and only populated when requested via expand param.","readOnly":true,"items":{"$ref":"#/definitions/ExternalDataSource"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FacebookId":{"type":"object","properties":{"ids":{"type":"array","description":"The set of scopedIds that this person has. Each scopedId is specific to a page or app that the user interacts with.","uniqueItems":true,"items":{"$ref":"#/definitions/FacebookScopedId"}},"displayName":{"type":"string","description":"The displayName of this person's Facebook account. Roughly translates to user.first_name + ' ' + user.last_name in the Facebook API."}},"description":"User information for a Facebook user interacting with a page or app"},"FacebookScopedId":{"type":"object","properties":{"scopedId":{"type":"string","description":"The unique page/app-specific scopedId for the user"}},"description":"Scoped ID for a Facebook user interacting with a page or app"},"JsonSchemaDocument":{"type":"object","properties":{"id":{"type":"string"},"$schema":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"type":{"type":"string"},"required":{"type":"array","items":{"type":"string"}},"properties":{"type":"object","additionalProperties":{"type":"object"}},"additionalProperties":{"type":"object"}},"description":"A JSON Schema document."},"LineId":{"type":"object","properties":{"ids":{"type":"array","description":"The set of Line userIds that this person has. Each userId is specific to the Line channel that the user interacts with.","uniqueItems":true,"items":{"$ref":"#/definitions/LineUserId"}},"displayName":{"type":"string","description":"The displayName of this person's account in Line"}},"description":"User information for a Line account"},"LineUserId":{"type":"object","properties":{"userId":{"type":"string","description":"The unique channel-specific userId for the user"}},"description":"Channel-specific User ID for Line accounts"},"MediaResult":{"type":"object","properties":{"mediaUri":{"type":"string"},"waveformData":{"type":"array","items":{"type":"number","format":"float"}}}},"MessageMediaAttachment":{"type":"object","properties":{"url":{"type":"string","description":"The location of the media, useful for retrieving it"},"mediaType":{"type":"string","description":"The optional internet media type of the the media object.If null then the media type should be dictated by the url.","enum":["image/png","image/jpeg","image/gif"]},"contentLength":{"type":"integer","format":"int64","description":"The optional content length of the the media object, in bytes."},"name":{"type":"string"},"id":{"type":"string"}}},"MessageStickerAttachment":{"type":"object","properties":{"url":{"type":"string","description":"The location of the media, useful for retrieving it"},"id":{"type":"string"}}},"OrphanRecording":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"createdTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"recoveredTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"providerType":{"type":"string","enum":["EDGE","CHAT","EMAIL","SCREEN_RECORDING","PUREENGAGE","PURECONNECT"],"x-genesys-enum-members":[{"name":"EDGE"},{"name":"CHAT"},{"name":"EMAIL"},{"name":"SCREEN_RECORDING"},{"name":"PUREENGAGE"},{"name":"PURECONNECT"}]},"mediaSizeBytes":{"type":"integer","format":"int64"},"mediaType":{"type":"string","enum":["CALL","CHAT","EMAIL","SCREEN"],"x-genesys-enum-members":[{"name":"CALL"},{"name":"CHAT"},{"name":"EMAIL"},{"name":"SCREEN"}]},"fileState":{"type":"string","enum":["ARCHIVED","AVAILABLE","DELETED","RESTORED","RESTORING","UPLOADING"],"x-genesys-enum-members":[{"name":"ARCHIVED"},{"name":"AVAILABLE"},{"name":"DELETED"},{"name":"RESTORED"},{"name":"RESTORING"},{"name":"UPLOADING"}]},"providerEndpoint":{"$ref":"#/definitions/Endpoint"},"recording":{"$ref":"#/definitions/Recording"},"orphanStatus":{"type":"string","description":"The status of the orphaned recording's conversation.","enum":["NO_CONVERSATION","UNKNOWN_CONVERSATION","CONVERSATION_NOT_COMPLETE","CONVERSATION_NOT_EVALUATED","EVALUATED"],"x-genesys-enum-members":[{"name":"NO_CONVERSATION"},{"name":"UNKNOWN_CONVERSATION"},{"name":"CONVERSATION_NOT_COMPLETE"},{"name":"CONVERSATION_NOT_EVALUATED"},{"name":"EVALUATED"}]},"sourceOrphaningId":{"type":"string","description":"An identifier used during recovery operations by the supplying hybrid platform to track back and determine which interaction this recording is associated with"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PhoneNumber":{"type":"object","properties":{"display":{"type":"string"},"extension":{"type":"integer","format":"int64"},"acceptsSMS":{"type":"boolean"},"userInput":{"type":"string"},"e164":{"type":"string"},"countryCode":{"type":"string"}}},"Recording":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"conversationId":{"type":"string"},"path":{"type":"string"},"startTime":{"type":"string","description":"The start time of the recording. Null when there is no playable media."},"endTime":{"type":"string","description":"The end time of the recording. Null when there is no playable media."},"media":{"type":"string","description":"The type of media that the recording is. At the moment that could be audio, chat, or email."},"annotations":{"type":"array","description":"Annotations that belong to the recording.","items":{"$ref":"#/definitions/Annotation"}},"transcript":{"type":"array","description":"Represents a chat transcript","items":{"$ref":"#/definitions/ChatMessage"}},"emailTranscript":{"type":"array","description":"Represents an email transcript","items":{"$ref":"#/definitions/RecordingEmailMessage"}},"messagingTranscript":{"type":"array","description":"Represents a messaging transcript","items":{"$ref":"#/definitions/RecordingMessagingMessage"}},"fileState":{"type":"string","description":"Represents the current file state for a recording. Examples: Uploading, Archived, etc","enum":["ARCHIVED","AVAILABLE","DELETED","RESTORED","RESTORING","UPLOADING","ERROR"],"x-genesys-enum-members":[{"name":"ARCHIVED"},{"name":"AVAILABLE"},{"name":"DELETED"},{"name":"RESTORED"},{"name":"RESTORING"},{"name":"UPLOADING"},{"name":"ERROR"}]},"restoreExpirationTime":{"type":"string","format":"date-time","description":"The amount of time a restored recording will remain restored before being archived again. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"mediaUris":{"type":"object","description":"The different mediaUris for the recording. Null when there is no playable media.","additionalProperties":{"$ref":"#/definitions/MediaResult"}},"estimatedTranscodeTimeMs":{"type":"integer","format":"int64"},"actualTranscodeTimeMs":{"type":"integer","format":"int64"},"archiveDate":{"type":"string","format":"date-time","description":"The date the recording will be archived. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"archiveMedium":{"type":"string","description":"The type of archive medium used. Example: CloudArchive","enum":["CLOUDARCHIVE"],"x-genesys-enum-members":[{"name":"CLOUDARCHIVE"}]},"deleteDate":{"type":"string","format":"date-time","description":"The date the recording will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"exportDate":{"type":"string","format":"date-time","description":"The date the recording will be exported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"exportedDate":{"type":"string","format":"date-time","description":"The date the recording was exported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"outputDurationMs":{"type":"integer","format":"int32","description":"Duration of transcoded media in milliseconds"},"outputSizeInBytes":{"type":"integer","format":"int32","description":"Size of transcoded media in bytes. 0 if there is no transcoded media."},"maxAllowedRestorationsForOrg":{"type":"integer","format":"int32","description":"How many archive restorations the organization is allowed to have."},"remainingRestorationsAllowedForOrg":{"type":"integer","format":"int32","description":"The remaining archive restorations the organization has."},"sessionId":{"type":"string","description":"The session id represents an external resource id, such as email, call, chat, etc"},"users":{"type":"array","description":"The users participating in the conversation","items":{"$ref":"#/definitions/User"}},"recordingFileRole":{"type":"string","description":"Role of the file recording. It can be either customer_experience or adhoc.","enum":["CUSTOMER_EXPERIENCE","ADHOC"],"x-genesys-enum-members":[{"name":"CUSTOMER_EXPERIENCE"},{"name":"ADHOC"}]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"RecordingEmailMessage":{"type":"object","properties":{"htmlBody":{"type":"string"},"textBody":{"type":"string"},"id":{"type":"string"},"to":{"type":"array","items":{"$ref":"#/definitions/EmailAddress"}},"cc":{"type":"array","items":{"$ref":"#/definitions/EmailAddress"}},"bcc":{"type":"array","items":{"$ref":"#/definitions/EmailAddress"}},"from":{"$ref":"#/definitions/EmailAddress"},"subject":{"type":"string"},"attachments":{"type":"array","items":{"$ref":"#/definitions/EmailAttachment"}},"time":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"RecordingMessagingMessage":{"type":"object","properties":{"from":{"type":"string"},"fromUser":{"$ref":"#/definitions/User"},"fromExternalContact":{"$ref":"#/definitions/ExternalContact"},"to":{"type":"string"},"timestamp":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"id":{"type":"string"},"messageText":{"type":"string"},"messageMediaAttachments":{"type":"array","items":{"$ref":"#/definitions/MessageMediaAttachment"}},"messageStickerAttachments":{"type":"array","items":{"$ref":"#/definitions/MessageStickerAttachment"}}}},"Ticker":{"type":"object","required":["exchange","symbol"],"properties":{"symbol":{"type":"string","description":"The ticker symbol for this organization. Example: ININ, AAPL, MSFT, etc."},"exchange":{"type":"string","description":"The exchange for this ticker symbol. Examples: NYSE, FTSE, NASDAQ, etc."}}},"TrusteeAuthorization":{"type":"object","properties":{"permissions":{"type":"array","description":"Permissions that the trustee user has in the trustor organization","readOnly":true,"items":{"type":"string"}}}},"Trustor":{"type":"object","required":["enabled"],"properties":{"id":{"type":"string","description":"Organization Id for this trust.","readOnly":true},"enabled":{"type":"boolean","description":"If disabled no trustee user will have access, even if they were previously added."},"dateCreated":{"type":"string","format":"date-time","description":"Date Trust was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"createdBy":{"description":"User that created trust.","readOnly":true,"$ref":"#/definitions/OrgUser"},"organization":{"description":"Organization associated with this trust.","readOnly":true,"$ref":"#/definitions/Organization"},"authorization":{"description":"Authorization for the trustee user has in this trustor organization","readOnly":true,"$ref":"#/definitions/TrusteeAuthorization"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TwitterId":{"type":"object","properties":{"id":{"type":"string","description":"twitter user.id_str"},"name":{"type":"string","description":"twitter user.name"},"screenName":{"type":"string","description":"twitter user.screen_name"},"verified":{"type":"boolean","description":"whether this data has been verified using the twitter API","readOnly":true},"profileUrl":{"type":"string","description":"url of user's twitter profile","readOnly":true}},"description":"User information for a twitter account"},"WhatsAppId":{"type":"object","properties":{"phoneNumber":{"description":"The phone number associated with this WhatsApp account","$ref":"#/definitions/PhoneNumber"},"displayName":{"type":"string","description":"The displayName of this person's account in WhatsApp"}},"description":"User information for a WhatsApp account"},"OrphanUpdateRequest":{"type":"object","properties":{"archiveDate":{"type":"string","format":"date-time","description":"The orphan recording's archive date. Must be greater than 1 day from now if set. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"deleteDate":{"type":"string","format":"date-time","description":"The orphan recording's delete date. Must be greater than archiveDate if set, otherwise one day from now. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A conversation Id that this orphan's recording is to be attached to. If not present, the conversationId will be deduced from the recording media."}}},"Campaign":{"type":"object","required":["callerAddress","callerName","contactList","dialingMode","name","phoneColumns"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the Campaign."},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"contactList":{"description":"The ContactList for this Campaign to dial.","$ref":"#/definitions/DomainEntityRef"},"queue":{"description":"The Queue for this Campaign to route calls to. Required for all dialing modes except agentless.","$ref":"#/definitions/DomainEntityRef"},"dialingMode":{"type":"string","description":"The strategy this Campaign will use for dialing.","enum":["agentless","preview","power","predictive","progressive","external"],"x-genesys-enum-members":[{"name":"agentless"},{"name":"preview"},{"name":"power"},{"name":"predictive"},{"name":"progressive"},{"name":"external"}]},"script":{"description":"The Script to be displayed to agents that are handling outbound calls. Required for all dialing modes except agentless.","$ref":"#/definitions/DomainEntityRef"},"edgeGroup":{"description":"The EdgeGroup that will place the calls. Required for all dialing modes except preview.","$ref":"#/definitions/DomainEntityRef"},"site":{"description":"The identifier of the site to be used for dialing; can be set in place of an edge group.","$ref":"#/definitions/DomainEntityRef"},"campaignStatus":{"type":"string","description":"The current status of the Campaign. A Campaign may be turned 'on' or 'off'. Required for updates.","enum":["on","stopping","off","complete","invalid","forced_off","forced_stopping"],"x-genesys-enum-members":[{"name":"on"},{"name":"stopping"},{"name":"off"},{"name":"complete"},{"name":"invalid"},{"name":"forced_off"},{"name":"forced_stopping"}]},"phoneColumns":{"type":"array","description":"The ContactPhoneNumberColumns on the ContactList that this Campaign should dial.","items":{"$ref":"#/definitions/PhoneColumn"}},"abandonRate":{"type":"number","format":"double","description":"The targeted abandon rate percentage. Required for progressive, power, and predictive campaigns."},"dncLists":{"type":"array","description":"DncLists for this Campaign to check before placing a call.","items":{"$ref":"#/definitions/DomainEntityRef"}},"callableTimeSet":{"description":"The callable time set for this campaign to check before placing a call.","$ref":"#/definitions/DomainEntityRef"},"callAnalysisResponseSet":{"description":"The call analysis response set to handle call analysis results from the edge. Required for all dialing modes except preview.","$ref":"#/definitions/DomainEntityRef"},"errors":{"type":"array","description":"A list of current error conditions associated with the campaign.","readOnly":true,"items":{"$ref":"#/definitions/RestErrorDetail"}},"callerName":{"type":"string","description":"The caller id name to be displayed on the outbound call."},"callerAddress":{"type":"string","example":"(555) 555-5555","description":"The caller id phone number to be displayed on the outbound call."},"outboundLineCount":{"type":"integer","format":"int32","description":"The number of outbound lines to be concurrently dialed. Only applicable to non-preview campaigns; only required for agentless."},"ruleSets":{"type":"array","description":"Rule sets to be applied while this campaign is dialing.","items":{"$ref":"#/definitions/DomainEntityRef"}},"skipPreviewDisabled":{"type":"boolean","description":"Whether or not agents can skip previews without placing a call. Only applicable for preview campaigns."},"previewTimeOutSeconds":{"type":"integer","format":"int64","description":"The number of seconds before a call will be automatically placed on a preview. A value of 0 indicates no automatic placement of calls. Only applicable to preview campaigns."},"alwaysRunning":{"type":"boolean","description":"Indicates (when true) that the campaign will remain on after contacts are depleted, allowing additional contacts to be appended/added to the contact list and processed by the still-running campaign. The campaign can still be turned off manually."},"contactSort":{"description":"The order in which to sort contacts for dialing, based on a column.","$ref":"#/definitions/ContactSort"},"contactSorts":{"type":"array","description":"The order in which to sort contacts for dialing, based on up to four columns.","items":{"$ref":"#/definitions/ContactSort"}},"noAnswerTimeout":{"type":"integer","format":"int32","description":"How long to wait before dispositioning a call as 'no-answer'. Default 30 seconds. Only applicable to non-preview campaigns."},"callAnalysisLanguage":{"type":"string","description":"The language the edge will use to analyze the call."},"priority":{"type":"integer","format":"int32","description":"The priority of this campaign relative to other campaigns that are running on the same queue. 5 is the highest priority, 1 the lowest."},"contactListFilters":{"type":"array","description":"Filter to apply to the contact list before dialing. Currently a campaign can only have one filter applied.","items":{"$ref":"#/definitions/DomainEntityRef"}},"division":{"description":"The division this campaign belongs to.","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CampaignEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Campaign"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ContactSort":{"type":"object","properties":{"fieldName":{"type":"string"},"direction":{"type":"string","description":"The direction in which to sort contacts.","enum":["ASC","DESC"],"x-genesys-enum-members":[{"name":"ASC"},{"name":"DESC"}]},"numeric":{"type":"boolean","description":"Whether or not the column contains numeric data."}}},"PhoneColumn":{"type":"object","required":["columnName","type"],"properties":{"columnName":{"type":"string","description":"The name of the phone column."},"type":{"type":"string","description":"The type of the phone column. For example, 'cell' or 'home'."}}},"RestErrorDetail":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"name of the error","readOnly":true},"details":{"type":"string","description":"additional information regarding the error","readOnly":true}}},"AgentActivity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"agent":{"$ref":"#/definitions/User"},"numEvaluations":{"type":"integer","format":"int32"},"averageEvaluationScore":{"type":"integer","format":"int32"},"numCriticalEvaluations":{"type":"integer","format":"int32"},"averageCriticalScore":{"type":"number","format":"float"},"highestEvaluationScore":{"type":"number","format":"float"},"lowestEvaluationScore":{"type":"number","format":"float"},"highestCriticalScore":{"type":"number","format":"float"},"lowestCriticalScore":{"type":"number","format":"float"},"agentEvaluatorActivityList":{"type":"array","items":{"$ref":"#/definitions/AgentEvaluatorActivity"}},"numEvaluationsWithoutViewPermission":{"type":"integer","format":"int32"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AgentActivityEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AgentActivity"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AgentEvaluatorActivity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"agent":{"$ref":"#/definitions/User"},"evaluator":{"$ref":"#/definitions/User"},"numEvaluations":{"type":"integer","format":"int32"},"averageEvaluationScore":{"type":"integer","format":"int32"},"numEvaluationsWithoutViewPermission":{"type":"integer","format":"int32"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"VoicemailCopyRecord":{"type":"object","properties":{"user":{"description":"The user that the voicemail message was copied to/from","readOnly":true,"$ref":"#/definitions/User"},"group":{"description":"The group that the voicemail message was copied to/from","readOnly":true,"$ref":"#/definitions/Group"},"date":{"type":"string","format":"date-time","description":"The date when the voicemail was copied. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true}}},"VoicemailMessage":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"conversation":{"description":"The conversation that the voicemail message is associated with","readOnly":true,"$ref":"#/definitions/Conversation"},"read":{"type":"boolean","description":"Whether the voicemail message is marked as read"},"audioRecordingDurationSeconds":{"type":"integer","format":"int32","description":"The voicemail message's audio recording duration in seconds","readOnly":true},"audioRecordingSizeBytes":{"type":"integer","format":"int64","description":"The voicemail message's audio recording size in bytes","readOnly":true},"createdDate":{"type":"string","format":"date-time","description":"The date the voicemail message was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedDate":{"type":"string","format":"date-time","description":"The date the voicemail message was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"deletedDate":{"type":"string","format":"date-time","description":"The date the voicemail message deleted property was set to true. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"callerAddress":{"type":"string","description":"The caller address","readOnly":true},"callerName":{"type":"string","description":"Optionally the name of the caller that left the voicemail message if the caller was a known user","readOnly":true},"callerUser":{"description":"Optionally the user that left the voicemail message if the caller was a known user","readOnly":true,"$ref":"#/definitions/User"},"deleted":{"type":"boolean","description":"Whether the voicemail message has been marked as deleted"},"note":{"type":"string","description":"An optional note"},"user":{"description":"The user that the voicemail message belongs to or null which means the voicemail message belongs to a group or queue","readOnly":true,"$ref":"#/definitions/User"},"group":{"description":"The group that the voicemail message belongs to or null which means the voicemail message belongs to a user or queue","readOnly":true,"$ref":"#/definitions/Group"},"queue":{"description":"The queue that the voicemail message belongs to or null which means the voicemail message belongs to a user or group","readOnly":true,"$ref":"#/definitions/Queue"},"copiedFrom":{"description":"Represents where this voicemail message was copied from","readOnly":true,"$ref":"#/definitions/VoicemailCopyRecord"},"copiedTo":{"type":"array","description":"Represents where this voicemail has been copied to","readOnly":true,"items":{"$ref":"#/definitions/VoicemailCopyRecord"}},"deleteRetentionPolicy":{"description":"The retention policy for this voicemail when deleted is set to true","$ref":"#/definitions/VoicemailRetentionPolicy"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"VoicemailRetentionPolicy":{"type":"object","properties":{"voicemailRetentionPolicyType":{"type":"string","description":"The retention policy type","enum":["RETAIN_INDEFINITELY","RETAIN_WITH_TTL","IMMEDIATE_DELETE"],"x-genesys-enum-members":[{"name":"RETAIN_INDEFINITELY"},{"name":"RETAIN_WITH_TTL"},{"name":"IMMEDIATE_DELETE"}]},"numberOfDays":{"type":"integer","format":"int32","description":"If retentionPolicyType == RETAIN_WITH_TTL, then this value represents the number of days for the TTL"}},"description":"Governs how the voicemail is retained"},"ConversationProperties":{"type":"object","properties":{"isWaiting":{"type":"boolean","description":"Indicates filtering for waiting"},"isActive":{"type":"boolean","description":"Indicates filtering for active"},"isAcd":{"type":"boolean","description":"Indicates filtering for Acd"},"isPreferred":{"type":"boolean","description":"Indicates filtering for Preferred Agent Routing"},"isScreenshare":{"type":"boolean","description":"Indicates filtering for screenshare"},"isCobrowse":{"type":"boolean","description":"Indicates filtering for Cobrowse"},"isVoicemail":{"type":"boolean","description":"Indicates filtering for Voice mail"},"isFlagged":{"type":"boolean","description":"Indicates filtering for flagged"},"isMonitored":{"type":"boolean","description":"Indicates filtering for monitored"},"filterWrapUpNotes":{"type":"boolean","description":"Indicates filtering for WrapUpNotes"},"matchAll":{"type":"boolean","description":"Indicates comparison operation, TRUE indicates filters will use AND logic, FALSE indicates OR logic"}}},"NumericRange":{"type":"object","properties":{"gt":{"type":"number","description":"Greater than"},"gte":{"type":"number","description":"Greater than or equal to"},"lt":{"type":"number","description":"Less than"},"lte":{"type":"number","description":"Less than or equal to"}}},"ReportingExportJobResponse":{"type":"object","required":["createdDateTime","exportFormat","filter","interval","locale","modifiedDateTime","percentageComplete","period","read","runId","status","timeZone","viewType"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"runId":{"type":"string","description":"The unique run id of the export schedule execute"},"status":{"type":"string","description":"The current status of the export request","enum":["SUBMITTED","RUNNING","CANCELLING","CANCELLED","COMPLETED","COMPLETED_WITH_PARTIAL_RESULTS","FAILED"],"x-genesys-enum-members":[{"name":"SUBMITTED"},{"name":"RUNNING"},{"name":"CANCELLING"},{"name":"CANCELLED"},{"name":"COMPLETED"},{"name":"COMPLETED_WITH_PARTIAL_RESULTS"},{"name":"FAILED"}]},"timeZone":{"type":"string","description":"The requested timezone of the exported data. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"exportFormat":{"type":"string","description":"The requested format of the exported data","enum":["CSV","PDF"],"x-genesys-enum-members":[{"name":"CSV"},{"name":"PDF"}]},"interval":{"type":"string","description":"The time period used to limit the the exported data. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"downloadUrl":{"type":"string","description":"The url to download the request if it's status is completed"},"viewType":{"type":"string","description":"The type of view export job to be created","enum":["QUEUE_PERFORMANCE_SUMMARY_VIEW","QUEUE_PERFORMANCE_DETAIL_VIEW","INTERACTION_SEARCH_VIEW","AGENT_PERFORMANCE_SUMMARY_VIEW","AGENT_PERFORMANCE_DETAIL_VIEW","AGENT_STATUS_SUMMARY_VIEW","AGENT_STATUS_DETAIL_VIEW","AGENT_EVALUATION_SUMMARY_VIEW","AGENT_EVALUATION_DETAIL_VIEW","AGENT_QUEUE_DETAIL_VIEW","AGENT_INTERACTION_DETAIL_VIEW","ABANDON_INSIGHTS_VIEW","SKILLS_PERFORMANCE_VIEW","SURVEY_FORM_PERFORMANCE_SUMMARY_VIEW","SURVEY_FORM_PERFORMANCE_DETAIL_VIEW","DNIS_PERFORMANCE_SUMMARY_VIEW","DNIS_PERFORMANCE_DETAIL_VIEW","WRAP_UP_PERFORMANCE_SUMMARY_VIEW","AGENT_WRAP_UP_PERFORMANCE_DETAIL_VIEW","QUEUE_ACTIVITY_SUMMARY_VIEW","QUEUE_ACTIVITY_DETAIL_VIEW","AGENT_QUEUE_ACTIVITY_SUMMARY_VIEW","QUEUE_AGENT_DETAIL_VIEW","QUEUE_INTERACTION_DETAIL_VIEW","AGENT_SCHEDULE_DETAIL_VIEW","IVR_PERFORMANCE_SUMMARY_VIEW","IVR_PERFORMANCE_DETAIL_VIEW","ANSWER_INSIGHTS_VIEW","HANDLE_INSIGHTS_VIEW","TALK_INSIGHTS_VIEW","HOLD_INSIGHTS_VIEW","ACW_INSIGHTS_VIEW","WAIT_INSIGHTS_VIEW","AGENT_WRAP_UP_PERFORMANCE_INTERVAL_DETAIL_VIEW","FLOW_OUTCOME_SUMMARY_VIEW","FLOW_OUTCOME_PERFORMANCE_DETAIL_VIEW","FLOW_OUTCOME_PERFORMANCE_INTERVAL_DETAIL_VIEW","FLOW_DESTINATION_SUMMARY_VIEW","FLOW_DESTINATION_DETAIL_VIEW","API_USAGE_VIEW","SCHEDULED_CALLBACKS_VIEW","CONTENT_SEARCH_VIEW","LANDING_PAGE","DASHBOARD_SUMMARY","DASHBOARD_DETAIL","JOURNEY_ACTION_MAP_SUMMARY_VIEW","JOURNEY_OUTCOME_SUMMARY_VIEW","JOURNEY_SEGMENT_SUMMARY_VIEW","AGENT_DEVELOPMENT_DETAIL_VIEW","AGENT_DEVELOPMENT_DETAIL_ME_VIEW","AGENT_DEVELOPMENT_SUMMARY_VIEW","AGENT_PERFORMANCE_ME_VIEW","AGENT_STATUS_ME_VIEW","AGENT_EVALUATION_ME_VIEW"],"x-genesys-enum-members":[{"name":"QUEUE_PERFORMANCE_SUMMARY_VIEW"},{"name":"QUEUE_PERFORMANCE_DETAIL_VIEW"},{"name":"INTERACTION_SEARCH_VIEW"},{"name":"AGENT_PERFORMANCE_SUMMARY_VIEW"},{"name":"AGENT_PERFORMANCE_DETAIL_VIEW"},{"name":"AGENT_STATUS_SUMMARY_VIEW"},{"name":"AGENT_STATUS_DETAIL_VIEW"},{"name":"AGENT_EVALUATION_SUMMARY_VIEW"},{"name":"AGENT_EVALUATION_DETAIL_VIEW"},{"name":"AGENT_QUEUE_DETAIL_VIEW"},{"name":"AGENT_INTERACTION_DETAIL_VIEW"},{"name":"ABANDON_INSIGHTS_VIEW"},{"name":"SKILLS_PERFORMANCE_VIEW"},{"name":"SURVEY_FORM_PERFORMANCE_SUMMARY_VIEW"},{"name":"SURVEY_FORM_PERFORMANCE_DETAIL_VIEW"},{"name":"DNIS_PERFORMANCE_SUMMARY_VIEW"},{"name":"DNIS_PERFORMANCE_DETAIL_VIEW"},{"name":"WRAP_UP_PERFORMANCE_SUMMARY_VIEW"},{"name":"AGENT_WRAP_UP_PERFORMANCE_DETAIL_VIEW"},{"name":"QUEUE_ACTIVITY_SUMMARY_VIEW"},{"name":"QUEUE_ACTIVITY_DETAIL_VIEW"},{"name":"AGENT_QUEUE_ACTIVITY_SUMMARY_VIEW"},{"name":"QUEUE_AGENT_DETAIL_VIEW"},{"name":"QUEUE_INTERACTION_DETAIL_VIEW"},{"name":"AGENT_SCHEDULE_DETAIL_VIEW"},{"name":"IVR_PERFORMANCE_SUMMARY_VIEW"},{"name":"IVR_PERFORMANCE_DETAIL_VIEW"},{"name":"ANSWER_INSIGHTS_VIEW"},{"name":"HANDLE_INSIGHTS_VIEW"},{"name":"TALK_INSIGHTS_VIEW"},{"name":"HOLD_INSIGHTS_VIEW"},{"name":"ACW_INSIGHTS_VIEW"},{"name":"WAIT_INSIGHTS_VIEW"},{"name":"AGENT_WRAP_UP_PERFORMANCE_INTERVAL_DETAIL_VIEW"},{"name":"FLOW_OUTCOME_SUMMARY_VIEW"},{"name":"FLOW_OUTCOME_PERFORMANCE_DETAIL_VIEW"},{"name":"FLOW_OUTCOME_PERFORMANCE_INTERVAL_DETAIL_VIEW"},{"name":"FLOW_DESTINATION_SUMMARY_VIEW"},{"name":"FLOW_DESTINATION_DETAIL_VIEW"},{"name":"API_USAGE_VIEW"},{"name":"SCHEDULED_CALLBACKS_VIEW"},{"name":"CONTENT_SEARCH_VIEW"},{"name":"LANDING_PAGE"},{"name":"DASHBOARD_SUMMARY"},{"name":"DASHBOARD_DETAIL"},{"name":"JOURNEY_ACTION_MAP_SUMMARY_VIEW"},{"name":"JOURNEY_OUTCOME_SUMMARY_VIEW"},{"name":"JOURNEY_SEGMENT_SUMMARY_VIEW"},{"name":"AGENT_DEVELOPMENT_DETAIL_VIEW"},{"name":"AGENT_DEVELOPMENT_DETAIL_ME_VIEW"},{"name":"AGENT_DEVELOPMENT_SUMMARY_VIEW"},{"name":"AGENT_PERFORMANCE_ME_VIEW"},{"name":"AGENT_STATUS_ME_VIEW"},{"name":"AGENT_EVALUATION_ME_VIEW"}]},"exportErrorMessagesType":{"type":"string","description":"The error message in case the export request failed","enum":["FAILED_CONVERTING_EXPORT_JOB","FAILED_NO_DATA_EXPORT_JOB_FOUND","FAILED_GETTING_DATA_FROM_SERVICE","FAILED_GENERATING_TEMP_FILE","FAILED_SAVING_FILE_TO_S3","FAILED_NOTIFYING_SKYWALKER_OF_DOWNLOAD","FAILED_BUILDING_DOWNLOAD_URL_FROM_SKYWALKER_RESPONSE","FAILED_CONVERTING_EXPORT_JOB_TO_QUEUE_PERFORMANCE_JOB","EXPORT_TYPE_NOT_IMPLEMENTED","REACHED_MAXIMUM_ATTEMPT_OF_RETRY","FAILED_LONG_RUNNING_EXPORT","TOO_MANY_REQUESTS_FROM_AN_ORGANIZATION","FAILED_AS_EXPORT_FILE_SIZE_IS_GREATER_THAN_10MB","NOT_AUTHORIZED_TO_VIEW_EXPORT"],"x-genesys-enum-members":[{"name":"FAILED_CONVERTING_EXPORT_JOB"},{"name":"FAILED_NO_DATA_EXPORT_JOB_FOUND"},{"name":"FAILED_GETTING_DATA_FROM_SERVICE"},{"name":"FAILED_GENERATING_TEMP_FILE"},{"name":"FAILED_SAVING_FILE_TO_S3"},{"name":"FAILED_NOTIFYING_SKYWALKER_OF_DOWNLOAD"},{"name":"FAILED_BUILDING_DOWNLOAD_URL_FROM_SKYWALKER_RESPONSE"},{"name":"FAILED_CONVERTING_EXPORT_JOB_TO_QUEUE_PERFORMANCE_JOB"},{"name":"EXPORT_TYPE_NOT_IMPLEMENTED"},{"name":"REACHED_MAXIMUM_ATTEMPT_OF_RETRY"},{"name":"FAILED_LONG_RUNNING_EXPORT"},{"name":"TOO_MANY_REQUESTS_FROM_AN_ORGANIZATION"},{"name":"FAILED_AS_EXPORT_FILE_SIZE_IS_GREATER_THAN_10MB"},{"name":"NOT_AUTHORIZED_TO_VIEW_EXPORT"}]},"period":{"type":"string","description":"The Period of the request in which to break down the intervals. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"filter":{"description":"Filters to apply to create the view","$ref":"#/definitions/ViewFilter"},"read":{"type":"boolean","description":"Indicates if the request has been marked as read"},"createdDateTime":{"type":"string","format":"date-time","description":"The created date/time of the request. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedDateTime":{"type":"string","format":"date-time","description":"The last modified date/time of the request. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"locale":{"type":"string","description":"The locale use for localization of the exported data, i.e. en-us, es-mx "},"percentageComplete":{"type":"number","format":"double","description":"The percentage of the job that has completed processing"},"hasFormatDurations":{"type":"boolean","description":"Indicates if durations are formatted in hh:mm:ss format instead of ms"},"hasSplitFilters":{"type":"boolean","description":"Indicates if filters will be split in aggregate detail exports"},"excludeEmptyRows":{"type":"boolean","description":"Excludes empty rows from the exports"},"hasSplitByMedia":{"type":"boolean","description":"Indicates if media type will be split in aggregate detail exports"},"hasSummaryRow":{"type":"boolean","description":"Indicates if summary row needs to be present in exports"},"csvDelimiter":{"type":"string","description":"The user supplied csv delimiter string value either of type 'comma' or 'semicolon' permitted for the export request","enum":["SEMICOLON","COMMA"],"x-genesys-enum-members":[{"name":"SEMICOLON"},{"name":"COMMA"}]},"selectedColumns":{"type":"array","description":"The list of ordered selected columns from the export view by the user","items":{"$ref":"#/definitions/SelectedColumns"}},"hasCustomParticipantAttributes":{"type":"boolean","description":"Indicates if custom participant attributes will be exported"},"recipientEmails":{"type":"array","description":"The list of email recipients for the exports","items":{"type":"string"}},"emailStatuses":{"type":"object","description":"The status of individual email addresses as a map","additionalProperties":{"type":"string","enum":["Sent","Pending","Failed"],"x-genesys-enum-members":[{"name":"Sent"},{"name":"Pending"},{"name":"Failed"}]}},"emailErrorDescription":{"type":"string","description":"The optional error message in case the export fail to email"},"enabled":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SelectedColumns":{"type":"object","properties":{"columnOrder":{"type":"integer","format":"int32","description":"Indicates the order/position of the selected column"},"columnName":{"type":"string","description":"Indicates enum name of the column from the export view"}}},"Transcripts":{"type":"object","properties":{"exactMatch":{"type":"array","description":"List of transcript contents which needs to satisfy exact match criteria","items":{"type":"string"}},"contains":{"type":"array","description":"List of transcript contents which needs to satisfy contains criteria","items":{"type":"string"}},"doesNotContain":{"type":"array","description":"List of transcript contents which needs to satisfy does not contain criteria","items":{"type":"string"}}}},"ViewFilter":{"type":"object","properties":{"mediaTypes":{"type":"array","description":"The media types are used to filter the view","items":{"type":"string","enum":["voice","chat","email","callback","cobrowse","video","screenshare","message"],"x-genesys-enum-members":[{"name":"voice"},{"name":"chat"},{"name":"email"},{"name":"callback"},{"name":"cobrowse"},{"name":"video"},{"name":"screenshare"},{"name":"message"}]}},"queueIds":{"type":"array","description":"The queue ids are used to filter the view","items":{"type":"string"}},"skillIds":{"type":"array","description":"The skill ids are used to filter the view","items":{"type":"string"}},"skillGroups":{"type":"array","description":"The skill groups used to filter the view","items":{"type":"string"}},"languageIds":{"type":"array","description":"The language ids are used to filter the view","items":{"type":"string"}},"languageGroups":{"type":"array","description":"The language groups used to filter the view","items":{"type":"string"}},"directions":{"type":"array","description":"The directions are used to filter the view","items":{"type":"string","enum":["inbound","outbound"],"x-genesys-enum-members":[{"name":"inbound"},{"name":"outbound"}]}},"originatingDirections":{"type":"array","description":"The list of orginating directions used to filter the view","items":{"type":"string","enum":["inbound","outbound"],"x-genesys-enum-members":[{"name":"inbound"},{"name":"outbound"}]}},"wrapUpCodes":{"type":"array","description":"The wrap up codes are used to filter the view","items":{"type":"string"}},"dnisList":{"type":"array","description":"The dnis list is used to filter the view","items":{"type":"string"}},"sessionDnisList":{"type":"array","description":"The list of session dnis used to filter the view","items":{"type":"string"}},"filterQueuesByUserIds":{"type":"array","description":"The user ids are used to fetch associated queues for the view","items":{"type":"string"}},"filterUsersByQueueIds":{"type":"array","description":"The queue ids are used to fetch associated users for the view","items":{"type":"string"}},"userIds":{"type":"array","description":"The user ids are used to filter the view","items":{"type":"string"}},"addressTos":{"type":"array","description":"The address To values are used to filter the view","items":{"type":"string"}},"addressFroms":{"type":"array","description":"The address from values are used to filter the view","items":{"type":"string"}},"outboundCampaignIds":{"type":"array","description":"The outbound campaign ids are used to filter the view","items":{"type":"string"}},"outboundContactListIds":{"type":"array","description":"The outbound contact list ids are used to filter the view","items":{"type":"string"}},"contactIds":{"type":"array","description":"The contact ids are used to filter the view","items":{"type":"string"}},"externalContactIds":{"type":"array","description":"The external contact ids are used to filter the view","items":{"type":"string"}},"externalOrgIds":{"type":"array","description":"The external org ids are used to filter the view","items":{"type":"string"}},"aniList":{"type":"array","description":"The ani list ids are used to filter the view","items":{"type":"string"}},"durationsMilliseconds":{"type":"array","description":"The durations in milliseconds used to filter the view","items":{"$ref":"#/definitions/NumericRange"}},"acdDurationsMilliseconds":{"type":"array","description":"The acd durations in milliseconds used to filter the view","items":{"$ref":"#/definitions/NumericRange"}},"talkDurationsMilliseconds":{"type":"array","description":"The talk durations in milliseconds used to filter the view","items":{"$ref":"#/definitions/NumericRange"}},"acwDurationsMilliseconds":{"type":"array","description":"The acw durations in milliseconds used to filter the view","items":{"$ref":"#/definitions/NumericRange"}},"handleDurationsMilliseconds":{"type":"array","description":"The handle durations in milliseconds used to filter the view","items":{"$ref":"#/definitions/NumericRange"}},"holdDurationsMilliseconds":{"type":"array","description":"The hold durations in milliseconds used to filter the view","items":{"$ref":"#/definitions/NumericRange"}},"abandonDurationsMilliseconds":{"type":"array","description":"The abandon durations in milliseconds used to filter the view","items":{"$ref":"#/definitions/NumericRange"}},"evaluationScore":{"description":"The evaluationScore is used to filter the view","$ref":"#/definitions/NumericRange"},"evaluationCriticalScore":{"description":"The evaluationCriticalScore is used to filter the view","$ref":"#/definitions/NumericRange"},"evaluationFormIds":{"type":"array","description":"The evaluation form ids are used to filter the view","items":{"type":"string"}},"evaluatedAgentIds":{"type":"array","description":"The evaluated agent ids are used to filter the view","items":{"type":"string"}},"evaluatorIds":{"type":"array","description":"The evaluator ids are used to filter the view","items":{"type":"string"}},"transferred":{"type":"boolean","description":"Indicates filtering for transfers"},"abandoned":{"type":"boolean","description":"Indicates filtering for abandons"},"answered":{"type":"boolean","description":"Indicates filtering for answered interactions"},"messageTypes":{"type":"array","description":"The message media types used to filter the view","items":{"type":"string","enum":["sms","twitter","line","facebook","whatsapp","webmessaging","general"],"x-genesys-enum-members":[{"name":"sms"},{"name":"twitter"},{"name":"line"},{"name":"facebook"},{"name":"whatsapp"},{"name":"webmessaging"},{"name":"general"}]}},"divisionIds":{"type":"array","description":"The divison Ids used to filter the view","items":{"type":"string"}},"surveyFormIds":{"type":"array","description":"The survey form ids used to filter the view","items":{"type":"string"}},"surveyTotalScore":{"description":"The survey total score used to filter the view","$ref":"#/definitions/NumericRange"},"surveyNpsScore":{"description":"The survey NPS score used to filter the view","$ref":"#/definitions/NumericRange"},"mos":{"description":"The desired range for mos values","$ref":"#/definitions/NumericRange"},"surveyQuestionGroupScore":{"description":"The survey question group score used to filter the view","$ref":"#/definitions/NumericRange"},"surveyPromoterScore":{"description":"The survey promoter score used to filter the view","$ref":"#/definitions/NumericRange"},"surveyFormContextIds":{"type":"array","description":"The list of survey form context ids used to filter the view","items":{"type":"string"}},"conversationIds":{"type":"array","description":"The list of conversation ids used to filter the view","items":{"type":"string"}},"sipCallIds":{"type":"array","description":"The list of SIP call ids used to filter the view","items":{"type":"string"}},"isEnded":{"type":"boolean","description":"Indicates filtering for ended"},"isSurveyed":{"type":"boolean","description":"Indicates filtering for survey"},"surveyScores":{"type":"array","description":"The list of survey score ranges used to filter the view","items":{"$ref":"#/definitions/NumericRange"}},"promoterScores":{"type":"array","description":"The list of promoter score ranges used to filter the view","items":{"$ref":"#/definitions/NumericRange"}},"isCampaign":{"type":"boolean","description":"Indicates filtering for campaign"},"surveyStatuses":{"type":"array","description":"The list of survey statuses used to filter the view","items":{"type":"string"}},"conversationProperties":{"description":"A grouping of conversation level filters","$ref":"#/definitions/ConversationProperties"},"isBlindTransferred":{"type":"boolean","description":"Indicates filtering for blind transferred"},"isConsulted":{"type":"boolean","description":"Indicates filtering for consulted"},"isConsultTransferred":{"type":"boolean","description":"Indicates filtering for consult transferred"},"remoteParticipants":{"type":"array","description":"The list of remote participants used to filter the view","items":{"type":"string"}},"flowIds":{"type":"array","description":"The list of flow Ids","items":{"type":"string"}},"flowOutcomeIds":{"type":"array","description":"A list of outcome ids of the flow","items":{"type":"string"}},"flowOutcomeValues":{"type":"array","description":"A list of outcome values of the flow","items":{"type":"string","enum":["SUCCESS","FAILURE"],"x-genesys-enum-members":[{"name":"SUCCESS"},{"name":"FAILURE"}]}},"flowDestinationTypes":{"type":"array","description":"The list of destination types of the flow","items":{"type":"string","enum":["ACD","USER","GROUP","NUMBER","FLOW","SECURE_FLOW","ACD_VOICEMAIL","USER_VOICEMAIL","GROUP_VOICEMAIL","RETURN_TO_AGENT"],"x-genesys-enum-members":[{"name":"ACD"},{"name":"USER"},{"name":"GROUP"},{"name":"NUMBER"},{"name":"FLOW"},{"name":"SECURE_FLOW"},{"name":"ACD_VOICEMAIL"},{"name":"USER_VOICEMAIL"},{"name":"GROUP_VOICEMAIL"},{"name":"RETURN_TO_AGENT"}]}},"flowDisconnectReasons":{"type":"array","description":"The list of reasons for the flow to disconnect","items":{"type":"string","enum":["FLOW_DISCONNECT","FLOW_ERROR_DISCONNECT","DISCONNECT"],"x-genesys-enum-members":[{"name":"FLOW_DISCONNECT"},{"name":"FLOW_ERROR_DISCONNECT"},{"name":"DISCONNECT"}]}},"flowTypes":{"type":"array","description":"A list of types of the flow","items":{"type":"string","enum":["bot","commonmodule","inboundcall","inboundchat","inboundemail","inboundshortmessage","inqueuecall","outboundcall","securecall","surveyinvite","workflow"],"x-genesys-enum-members":[{"name":"bot"},{"name":"commonmodule"},{"name":"inboundcall"},{"name":"inboundchat"},{"name":"inboundemail"},{"name":"inboundshortmessage"},{"name":"inqueuecall"},{"name":"outboundcall"},{"name":"securecall"},{"name":"surveyinvite"},{"name":"workflow"}]}},"flowEntryTypes":{"type":"array","description":"A list of types of the flow entry","items":{"type":"string","enum":["dnis","direct","flow","agent","outbound"],"x-genesys-enum-members":[{"name":"dnis"},{"name":"direct"},{"name":"flow"},{"name":"agent"},{"name":"outbound"}]}},"flowEntryReasons":{"type":"array","description":"A list of reasons of flow entry","items":{"type":"string"}},"flowVersions":{"type":"array","description":"A list of versions of a flow","items":{"type":"string"}},"groupIds":{"type":"array","description":"A list of directory group ids","items":{"type":"string"}},"hasJourneyCustomerId":{"type":"boolean","description":"Indicates filtering for journey customer id"},"hasJourneyActionMapId":{"type":"boolean","description":"Indicates filtering for Journey action map id"},"hasJourneyVisitId":{"type":"boolean","description":"Indicates filtering for Journey visit id"},"hasMedia":{"type":"boolean","description":"Indicates filtering for presence of MMS media"},"roleIds":{"type":"array","description":"The role Ids used to filter the view","items":{"type":"string"}},"reportsTos":{"type":"array","description":"The report to user IDs used to filter the view","items":{"type":"string"}},"locationIds":{"type":"array","description":"The location Ids used to filter the view","items":{"type":"string"}},"flowOutTypes":{"type":"array","description":"A list of flow out types","items":{"type":"string"}},"providerList":{"type":"array","description":"A list of providers","items":{"type":"string"}},"callbackNumberList":{"type":"array","description":"A list of callback numbers or substrings of numbers (ex: [\"317\", \"13172222222\"])","items":{"type":"string"}},"callbackInterval":{"type":"string","description":"An interval of time to filter for scheduled callbacks. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"usedRoutingTypes":{"type":"array","description":"A list of routing types used","items":{"type":"string","enum":["Predictive","Preferred","Manual","Last","Bullseye","Standard"],"x-genesys-enum-members":[{"name":"Predictive"},{"name":"Preferred"},{"name":"Manual"},{"name":"Last"},{"name":"Bullseye"},{"name":"Standard"}]}},"requestedRoutingTypes":{"type":"array","description":"A list of routing types requested","items":{"type":"string","enum":["Predictive","Preferred","Manual","Last","Bullseye","Standard"],"x-genesys-enum-members":[{"name":"Predictive"},{"name":"Preferred"},{"name":"Manual"},{"name":"Last"},{"name":"Bullseye"},{"name":"Standard"}]}},"hasAgentAssistId":{"type":"boolean","description":"Indicates filtering for agent assist id"},"transcripts":{"type":"array","description":"A list of transcript contents requested","items":{"$ref":"#/definitions/Transcripts"}},"transcriptLanguages":{"type":"array","description":"A list of transcript languages requested","items":{"type":"string"}},"participantPurposes":{"type":"array","description":"A list of participant purpose requested","items":{"type":"string","enum":["internal","external"],"x-genesys-enum-members":[{"name":"internal"},{"name":"external"}]}},"showFirstQueue":{"type":"boolean","description":"Indicates filtering for first queue data"},"teamIds":{"type":"array","description":"The team ids used to filter the view data","items":{"type":"string"}},"filterUsersByTeamIds":{"type":"array","description":"The team ids are used to fetch associated users for the view","items":{"type":"string"}},"journeyActionMapIds":{"type":"array","description":"The journey action map ids are used to fetch action maps for the associated view","items":{"type":"string"}},"journeyOutcomeIds":{"type":"array","description":"The journey outcome ids are used to fetch outcomes for the associated view","items":{"type":"string"}},"journeySegmentIds":{"type":"array","description":"The journey segment ids are used to fetch segments for the associated view","items":{"type":"string"}},"journeyActionMapTypes":{"type":"array","description":"The journey action map types are used to filter action map data for the associated view","items":{"type":"string","enum":["webchat","webMessagingOffer","contentOffer","integrationAction","architectFlow"],"x-genesys-enum-members":[{"name":"webchat"},{"name":"webMessagingOffer"},{"name":"contentOffer"},{"name":"integrationAction"},{"name":"architectFlow"}]}},"developmentRoleList":{"type":"array","description":"The list of development roles used to filter agent development view","items":{"type":"string","enum":["Creator","Facilitator","Attendee"],"x-genesys-enum-members":[{"name":"Creator"},{"name":"Facilitator"},{"name":"Attendee"}]}},"developmentTypeList":{"type":"array","description":"The list of development types used to filter agent development view","items":{"type":"string","enum":["Informational","Coaching"],"x-genesys-enum-members":[{"name":"Informational"},{"name":"Coaching"}]}},"developmentStatusList":{"type":"array","description":"The list of development status used to filter agent development view","items":{"type":"string","enum":["Planned","Scheduled","InvalidSchedule","InProgress","Completed"],"x-genesys-enum-members":[{"name":"Planned"},{"name":"Scheduled"},{"name":"InvalidSchedule"},{"name":"InProgress"},{"name":"Completed"}]}},"developmentModuleIds":{"type":"array","description":"The list of development moduleIds used to filter agent development view","items":{"type":"string"}},"developmentKeyType":{"type":"string","description":"Represents due or completed to filter agent development view","enum":["Due","Completed"],"x-genesys-enum-members":[{"name":"Due"},{"name":"Completed"}]},"developmentActivityOverdue":{"type":"boolean","description":"Indicates filtering for development activities"}}},"UserSchedule":{"type":"object","required":["metadata"],"properties":{"shifts":{"type":"array","description":"The shifts that belong to this schedule","items":{"$ref":"#/definitions/UserScheduleShift"}},"fullDayTimeOffMarkers":{"type":"array","description":"Markers to indicate a full day time off request, relative to the management unit time zone","items":{"$ref":"#/definitions/UserScheduleFullDayTimeOffMarker"}},"delete":{"type":"boolean","description":"If marked true for updating an existing user schedule, it will be deleted"},"metadata":{"description":"Version metadata for this schedule","$ref":"#/definitions/WfmVersionedEntityMetadata"},"workPlanId":{"type":"string","description":"ID of the work plan associated with the user during schedule creation","readOnly":true}},"description":"A schedule for a single user over a given time range"},"UserScheduleActivity":{"type":"object","properties":{"activityCodeId":{"type":"string","description":"The id for the activity code. Look up a map of activity codes with the activities route"},"startDate":{"type":"string","format":"date-time","description":"Start time in UTC for this activity, in ISO-8601 format"},"lengthInMinutes":{"type":"integer","format":"int32","description":"Length in minutes for this activity"},"description":{"type":"string","description":"Description for this activity"},"countsAsPaidTime":{"type":"boolean","description":"Whether this activity is paid"},"isDstFallback":{"type":"boolean","description":"Whether this activity spans a DST fallback"},"timeOffRequestId":{"type":"string","description":"Time off request id of this activity"}},"description":"Represents a single activity in a user's shift"},"UserScheduleContainer":{"type":"object","properties":{"managementUnitTimeZone":{"type":"string","description":"The reference time zone used for the management unit"},"publishedSchedules":{"type":"array","description":"References to all published week schedules overlapping the start/end date query parameters","items":{"$ref":"#/definitions/WeekScheduleReference"}},"userSchedules":{"type":"object","description":"Map of user id to user schedule","additionalProperties":{"$ref":"#/definitions/UserSchedule"}}},"description":"Container object to hold a map of user schedules"},"UserScheduleFullDayTimeOffMarker":{"type":"object","properties":{"managementUnitDate":{"type":"string","description":"The date associated with the time off request that this marker corresponds to. Date only, in ISO-8601 format."},"activityCodeId":{"type":"string","description":"The id for the activity code. Look up a map of activity codes with the activities route"},"isPaid":{"type":"boolean","description":"Whether this is paid time off"},"lengthInMinutes":{"type":"integer","format":"int32","description":"The length in minutes of this time off marker"},"description":{"type":"string","description":"The description associated with the time off request that this marker corresponds to"},"delete":{"type":"boolean","description":"If marked true for updating an existing full day time off marker, it will be deleted"}},"description":"Marker to indicate an approved full day time off request"},"UserScheduleShift":{"type":"object","properties":{"weekSchedule":{"description":"The schedule to which this shift belongs","readOnly":true,"$ref":"#/definitions/WeekScheduleReference"},"id":{"type":"string","description":"ID of the schedule shift. This is only for the case of updating and deleting an existing shift"},"startDate":{"type":"string","format":"date-time","description":"Start time in UTC for this shift. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"lengthInMinutes":{"type":"integer","format":"int32","description":"Length of this shift in minutes","readOnly":true},"activities":{"type":"array","description":"List of activities in this shift","items":{"$ref":"#/definitions/UserScheduleActivity"}},"delete":{"type":"boolean","description":"If marked true for updating this schedule shift, it will be deleted"},"manuallyEdited":{"type":"boolean","description":"Whether the shift was set as manually edited"}},"description":"Single shift in a user's schedule"},"WeekScheduleReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"weekDate":{"type":"string","description":"First day of this week schedule in yyyy-MM-dd format"}}},"WfmVersionedEntityMetadata":{"type":"object","required":["version"],"properties":{"version":{"type":"integer","format":"int32","description":"The version of the associated entity. Used to prevent conflicts on concurrent edits"},"modifiedBy":{"description":"The user who last modified the associated entity","readOnly":true,"$ref":"#/definitions/UserReference"},"dateModified":{"type":"string","format":"date-time","description":"The date the associated entity was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true}},"description":"Metadata to associate with a given entity"},"CurrentUserScheduleRequestBody":{"type":"object","required":["endDate","startDate"],"properties":{"startDate":{"type":"string","format":"date-time","description":"Beginning of the range of schedules to fetch, in ISO-8601 format"},"endDate":{"type":"string","format":"date-time","description":"End of the range of schedules to fetch, in ISO-8601 format"},"loadFullWeeks":{"type":"boolean","description":"Whether to load the full week's schedule (for the current user) of any week overlapping the start/end date query parameters, defaults to false"}},"description":"POST request body for fetching the current user's schedule over a given range"},"Empty":{"type":"object"},"Trunk":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"trunkType":{"type":"string","description":"The type of this trunk.","enum":["EXTERNAL","PHONE","EDGE"],"x-genesys-enum-members":[{"name":"EXTERNAL"},{"name":"PHONE"},{"name":"EDGE"}]},"edge":{"description":"The Edge using this trunk.","$ref":"#/definitions/DomainEntityRef"},"trunkBase":{"description":"The trunk base configuration used on this trunk.","$ref":"#/definitions/DomainEntityRef"},"trunkMetabase":{"description":"The metabase used to create this trunk.","$ref":"#/definitions/DomainEntityRef"},"edgeGroup":{"description":"The edge group associated with this trunk.","$ref":"#/definitions/DomainEntityRef"},"inService":{"type":"boolean","description":"True if this trunk is in-service. This comes from the trunk_enabled property of the referenced trunk base.","readOnly":true},"enabled":{"type":"boolean","description":"True if the Edge used by this trunk is in-service"},"logicalInterface":{"description":"The Logical Interface on the Edge to which the trunk is assigned.","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"connectedStatus":{"description":"The connected status of the trunk","readOnly":true,"$ref":"#/definitions/TrunkConnectedStatus"},"optionsStatus":{"type":"array","description":"The trunk optionsStatus","readOnly":true,"items":{"$ref":"#/definitions/TrunkMetricsOptions"}},"registersStatus":{"type":"array","description":"The trunk registersStatus","readOnly":true,"items":{"$ref":"#/definitions/TrunkMetricsRegisters"}},"ipStatus":{"description":"The trunk ipStatus","readOnly":true,"$ref":"#/definitions/TrunkMetricsNetworkTypeIp"},"optionsEnabledStatus":{"type":"string","description":"Returns Enabled when the trunk base supports the availability interval and it has a value greater than 0.","readOnly":true,"enum":["ENABLED","DISABLED","NOT_SUPPORTED"],"x-genesys-enum-members":[{"name":"ENABLED"},{"name":"DISABLED"},{"name":"NOT_SUPPORTED"}]},"registersEnabledStatus":{"type":"string","description":"Returns Enabled when the trunk base supports the registration interval and it has a value greater than 0.","readOnly":true,"enum":["ENABLED","DISABLED","NOT_SUPPORTED"],"x-genesys-enum-members":[{"name":"ENABLED"},{"name":"DISABLED"},{"name":"NOT_SUPPORTED"}]},"family":{"type":"integer","format":"int32","description":"The IP Network Family of the trunk","readOnly":true},"proxyAddressList":{"type":"array","description":"The list of proxy addresses (ports if provided) for the trunk","readOnly":true,"items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TrunkConnectedStatus":{"type":"object","properties":{"connected":{"type":"boolean"},"connectedStateTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"TrunkEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Trunk"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"TrunkErrorInfo":{"type":"object","properties":{"text":{"type":"string"},"code":{"type":"string"},"details":{"$ref":"#/definitions/TrunkErrorInfoDetails"}}},"TrunkErrorInfoDetails":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"hostname":{"type":"string"}}},"TrunkMetricsNetworkTypeIp":{"type":"object","properties":{"address":{"type":"string","description":"Assigned IP Address for the interface"},"errorInfo":{"description":"Information about the error.","$ref":"#/definitions/TrunkErrorInfo"}}},"TrunkMetricsOptions":{"type":"object","properties":{"proxyAddress":{"type":"string","description":"Server proxy address that this options array element represents."},"optionState":{"type":"boolean"},"optionStateTime":{"type":"string","format":"date-time","description":"ISO 8601 format UTC absolute date & time of the last change of the option state."},"errorInfo":{"$ref":"#/definitions/TrunkErrorInfo"}}},"TrunkMetricsRegisters":{"type":"object","properties":{"proxyAddress":{"type":"string","description":"Server proxy address that this registers array element represents."},"registerState":{"type":"boolean","description":"True if last REGISTER message had positive response; false if error response or no response."},"registerStateTime":{"type":"string","format":"date-time","description":"ISO 8601 format UTC absolute date & time of the last change of the register state."},"errorInfo":{"$ref":"#/definitions/TrunkErrorInfo"}}},"DataSchemaListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/DataSchema"}},"selfUri":{"type":"string","format":"uri"}}},"DIDPool":{"type":"object","required":["endPhoneNumber","name","startPhoneNumber"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"startPhoneNumber":{"type":"string","description":"The starting phone number for the range of this DID pool. Must be in E.164 format"},"endPhoneNumber":{"type":"string","description":"The ending phone number for the range of this DID pool. Must be in E.164 format"},"comments":{"type":"string"},"provider":{"type":"string","description":"The provider for this DID pool","enum":["PURE_CLOUD","PURE_CLOUD_VOICE"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"NamedEntity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the object.","readOnly":true}}},"SubscriptionOverviewUsage":{"type":"object","required":["grouping","name","partNumber","prepayQuantity","unitOfMeasureType","usageQuantity"],"properties":{"name":{"type":"string","description":"Product charge name"},"partNumber":{"type":"string","description":"Product part number"},"grouping":{"type":"string","description":"UI grouping key"},"unitOfMeasureType":{"type":"string","description":"UI unit of measure"},"usageQuantity":{"type":"string","description":"Usage count for specified period"},"overagePrice":{"type":"string","description":"Price for usage / overage charge"},"prepayQuantity":{"type":"string","description":"Items prepaid for specified period"},"prepayPrice":{"type":"string","description":"Price for prepay charge"},"usageNotes":{"type":"string","description":"Notes about the usage/charge item"},"isCancellable":{"type":"boolean","description":"Indicates whether the item is cancellable"},"bundleQuantity":{"type":"string","description":"Quantity multiplier for this charge"},"isThirdParty":{"type":"boolean","description":"A charge from a third party entity"}}},"TrusteeBillingOverview":{"type":"object","required":["currency","enabledProducts","organization","subscriptionType","usages"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"organization":{"description":"Organization","$ref":"#/definitions/NamedEntity"},"currency":{"type":"string","description":"The currency type."},"enabledProducts":{"type":"array","description":"The charge short names for products enabled during the specified period.","items":{"type":"string"}},"subscriptionType":{"type":"string","description":"The subscription type.","enum":["ININ","MONTH_TO_MONTH","FREE_TRIAL_MONTH_TO_MONTH","PREPAY_MONTHLY_COMMITMENT","PREPAY","DEV_ORG_MONTH_TO_MONTH","DEV_ORG_PREPAY_MONTHLY_COMMITMENT","DEV_ORG_PREPAY"],"x-genesys-enum-members":[{"name":"ININ"},{"name":"MONTH_TO_MONTH"},{"name":"FREE_TRIAL_MONTH_TO_MONTH"},{"name":"PREPAY_MONTHLY_COMMITMENT"},{"name":"PREPAY"},{"name":"DEV_ORG_MONTH_TO_MONTH"},{"name":"DEV_ORG_PREPAY_MONTHLY_COMMITMENT"},{"name":"DEV_ORG_PREPAY"}]},"rampPeriodStartDate":{"type":"string","format":"date-time","description":"Date-time the ramp period starts. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"rampPeriodEndDate":{"type":"string","format":"date-time","description":"Date-time the ramp period ends. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"billingPeriodStartDate":{"type":"string","format":"date-time","description":"Date-time the billing period started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"billingPeriodEndDate":{"type":"string","format":"date-time","description":"Date-time the billing period ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"usages":{"type":"array","description":"Usages for the specified period.","items":{"$ref":"#/definitions/SubscriptionOverviewUsage"}},"contractAmendmentDate":{"type":"string","format":"date-time","description":"Date-time the contract was last amended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"contractEffectiveDate":{"type":"string","format":"date-time","description":"Date-time the contract became effective. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"contractEndDate":{"type":"string","format":"date-time","description":"Date-time the contract ends. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"minimumMonthlyAmount":{"type":"string","description":"Minimum amount that will be charged for the month"},"inRampPeriod":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AuthzDivision":{"type":"object","required":["description"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string","description":"A helpful description for the division."},"homeDivision":{"type":"boolean","description":"A flag indicating whether this division is the \"Home\" (default) division. Cannot be modified and any supplied value will be ignored on create or update.","readOnly":true},"objectCounts":{"type":"object","description":"A count of objects in this division, grouped by type.","readOnly":true,"additionalProperties":{"type":"integer","format":"int64"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OutboundRouteBase":{"type":"object","required":["classificationTypes","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"classificationTypes":{"type":"array","description":"The site associated to the outbound route.","items":{"type":"string"}},"enabled":{"type":"boolean"},"distribution":{"type":"string","enum":["SEQUENTIAL","RANDOM"],"x-genesys-enum-members":[{"name":"SEQUENTIAL"},{"name":"RANDOM"}]},"externalTrunkBases":{"type":"array","description":"Trunk base settings of trunkType \"EXTERNAL\". This base must also be set on an edge logical interface for correct routing.","items":{"$ref":"#/definitions/DomainEntityRef"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OutboundRouteBaseEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/OutboundRouteBase"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AggregateMetricData":{"type":"object","properties":{"metric":{"type":"string"},"qualifier":{"type":"string"},"stats":{"$ref":"#/definitions/StatisticalSummary"}}},"AggregateViewData":{"type":"object","properties":{"name":{"type":"string"},"stats":{"$ref":"#/definitions/StatisticalSummary"}}},"EvaluationAggregateDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/StatisticalResponse"}}}},"EvaluationAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/EvaluationAggregateDataContainer"}}}},"StatisticalResponse":{"type":"object","properties":{"interval":{"type":"string"},"metrics":{"type":"array","items":{"$ref":"#/definitions/AggregateMetricData"}},"views":{"type":"array","items":{"$ref":"#/definitions/AggregateViewData"}}}},"StatisticalSummary":{"type":"object","properties":{"max":{"type":"number"},"min":{"type":"number"},"count":{"type":"integer","format":"int64"},"countNegative":{"type":"integer","format":"int64"},"countPositive":{"type":"integer","format":"int64"},"sum":{"type":"number"},"current":{"type":"number"},"ratio":{"type":"number"},"numerator":{"type":"number"},"denominator":{"type":"number"},"target":{"type":"number"}}},"AggregationRange":{"type":"object","properties":{"gte":{"type":"number","description":"Greater than or equal to"},"lt":{"type":"number","description":"Less than"}}},"EvaluationAggregateQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/EvaluationAggregateQueryPredicate"}}}},"EvaluationAggregateQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/EvaluationAggregateQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/EvaluationAggregateQueryPredicate"}}}},"EvaluationAggregateQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"],"x-genesys-enum-members":[{"name":"dimension"},{"name":"property"},{"name":"metric"}]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["calibrationId","contextId","conversationId","divisionId","evaluationCreatedDate","evaluationId","evaluatorId","formId","queueId","rescored","teamId","userId"],"x-genesys-enum-members":[{"name":"calibrationId"},{"name":"contextId"},{"name":"conversationId"},{"name":"divisionId"},{"name":"evaluationCreatedDate"},{"name":"evaluationId"},{"name":"evaluatorId"},{"name":"formId"},{"name":"queueId"},{"name":"rescored"},{"name":"teamId"},{"name":"userId"}]},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"],"x-genesys-enum-members":[{"name":"matches"},{"name":"exists"},{"name":"notExists"}]},"value":{"type":"string","description":"Right hand side for dimension predicates"},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"EvaluationAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["calibrationId","contextId","conversationId","divisionId","evaluationCreatedDate","evaluationId","evaluatorId","formId","queueId","rescored","teamId","userId"],"x-genesys-enum-members":[{"name":"calibrationId"},{"name":"contextId"},{"name":"conversationId"},{"name":"divisionId"},{"name":"evaluationCreatedDate"},{"name":"evaluationId"},{"name":"evaluatorId"},{"name":"formId"},{"name":"queueId"},{"name":"rescored"},{"name":"teamId"},{"name":"userId"}]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/EvaluationAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nEvaluations","nEvaluationsDeleted","nEvaluationsRescored","oTotalCriticalScore","oTotalScore"],"x-genesys-enum-members":[{"name":"nEvaluations"},{"name":"nEvaluationsDeleted"},{"name":"nEvaluationsRescored"},{"name":"oTotalCriticalScore"},{"name":"oTotalScore"}]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/EvaluationAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["evaluationCreatedDate","eventTime"],"x-genesys-enum-members":[{"name":"evaluationCreatedDate"},{"name":"eventTime"}]}}},"EvaluationAggregationView":{"type":"object","required":["function","name","target"],"properties":{"target":{"type":"string","description":"Target metric name","enum":["nEvaluations","nEvaluationsDeleted","nEvaluationsRescored","oTotalCriticalScore","oTotalScore"],"x-genesys-enum-members":[{"name":"nEvaluations"},{"name":"nEvaluationsDeleted"},{"name":"nEvaluationsRescored"},{"name":"oTotalCriticalScore"},{"name":"oTotalScore"}]},"name":{"type":"string","description":"A unique name for this view. Must be distinct from other views and built-in metric names."},"function":{"type":"string","description":"Type of view you wish to create","enum":["rangeBound"],"x-genesys-enum-members":[{"name":"rangeBound"}]},"range":{"description":"Range of numbers for slicing up data","$ref":"#/definitions/AggregationRange"}}},"QueryDivision":{"type":"object","properties":{}},"CampaignSequence":{"type":"object","required":["campaigns","currentCampaign","status"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"campaigns":{"type":"array","description":"The ordered list of Campaigns that this CampaignSequence will run.","items":{"$ref":"#/definitions/DomainEntityRef"}},"currentCampaign":{"type":"integer","format":"int32","description":"A zero-based index indicating which Campaign this CampaignSequence is currently on.","readOnly":true},"status":{"type":"string","description":"The current status of the CampaignSequence. A CampaignSequence can be turned 'on' or 'off'.","enum":["on","off","complete"],"x-genesys-enum-members":[{"name":"on"},{"name":"off"},{"name":"complete"}]},"stopMessage":{"type":"string","description":"A message indicating if and why a CampaignSequence has stopped unexpectedly.","readOnly":true},"repeat":{"type":"boolean","description":"Indicates if a sequence should repeat from the beginning after the last campaign completes. Default is false."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CampaignSequenceEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CampaignSequence"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"UserEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/User"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CursorNoteListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Note"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"Cursors":{"type":"object","properties":{"before":{"type":"string"},"after":{"type":"string"}}},"Note":{"type":"object","required":["createdBy"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"noteText":{"type":"string"},"modifyDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"description":"The author of this note","$ref":"#/definitions/User"},"externalDataSources":{"type":"array","description":"Links to the sources of data (e.g. one source might be a CRM) that contributed data to this record. Read-only, and only populated when requested via expand param.","readOnly":true,"items":{"$ref":"#/definitions/ExternalDataSource"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DependencyType":{"type":"object","properties":{"id":{"type":"string","description":"The dependency type identifier"},"name":{"type":"string"},"versioned":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DependencyTypeEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DependencyType"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"TtsEngineEntity":{"type":"object","required":["languages","outputFormats"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"languages":{"type":"array","description":"The set of languages the TTS engine supports","items":{"type":"string"}},"outputFormats":{"type":"array","description":"The set of output formats the TTS engine can produce","items":{"type":"string"}},"voices":{"type":"array","description":"The set of voices the TTS engine supports","items":{"$ref":"#/definitions/TtsVoiceEntity"}},"isDefault":{"type":"boolean","description":"The TTS engine is the global default engine"},"isSecure":{"type":"boolean","description":"The TTS engine can be used in a secure call flow"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TtsVoiceEntity":{"type":"object","required":["engine","gender","language"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"gender":{"type":"string","description":"The gender of the TTS voice"},"language":{"type":"string","description":"The language supported by the TTS voice"},"engine":{"description":"Ths TTS engine this voice belongs to","$ref":"#/definitions/TtsEngineEntity"},"isDefault":{"type":"boolean","description":"The voice is the default voice for its language"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ArchiveRetention":{"type":"object","properties":{"days":{"type":"integer","format":"int32"},"storageMedium":{"type":"string","enum":["CLOUDARCHIVE"],"x-genesys-enum-members":[{"name":"CLOUDARCHIVE"}]}}},"CalibrationAssignment":{"type":"object","properties":{"calibrator":{"$ref":"#/definitions/User"},"evaluators":{"type":"array","items":{"$ref":"#/definitions/User"}},"evaluationForm":{"$ref":"#/definitions/EvaluationForm"},"expertEvaluator":{"$ref":"#/definitions/User"}}},"CallMediaPolicy":{"type":"object","properties":{"actions":{"description":"Actions applied when specified conditions are met","$ref":"#/definitions/PolicyActions"},"conditions":{"description":"Conditions for when actions should be applied","$ref":"#/definitions/CallMediaPolicyConditions"}}},"CallMediaPolicyConditions":{"type":"object","properties":{"forUsers":{"type":"array","items":{"$ref":"#/definitions/User"}},"dateRanges":{"type":"array","items":{"type":"string"}},"forQueues":{"type":"array","items":{"$ref":"#/definitions/Queue"}},"wrapupCodes":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}},"languages":{"type":"array","items":{"$ref":"#/definitions/Language"}},"timeAllowed":{"$ref":"#/definitions/TimeAllowed"},"directions":{"type":"array","items":{"type":"string","enum":["INBOUND","OUTBOUND"],"x-genesys-enum-members":[{"name":"INBOUND"},{"name":"OUTBOUND"}]}},"duration":{"$ref":"#/definitions/DurationCondition"}}},"ChatMediaPolicy":{"type":"object","properties":{"actions":{"description":"Actions applied when specified conditions are met","$ref":"#/definitions/PolicyActions"},"conditions":{"description":"Conditions for when actions should be applied","$ref":"#/definitions/ChatMediaPolicyConditions"}}},"ChatMediaPolicyConditions":{"type":"object","properties":{"forUsers":{"type":"array","items":{"$ref":"#/definitions/User"}},"dateRanges":{"type":"array","items":{"type":"string"}},"forQueues":{"type":"array","items":{"$ref":"#/definitions/Queue"}},"wrapupCodes":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}},"languages":{"type":"array","items":{"$ref":"#/definitions/Language"}},"timeAllowed":{"$ref":"#/definitions/TimeAllowed"},"duration":{"$ref":"#/definitions/DurationCondition"}}},"DeleteRetention":{"type":"object","properties":{"days":{"type":"integer","format":"int32"}}},"DurationCondition":{"type":"object","properties":{"durationTarget":{"type":"string","enum":["DURATION","DURATION_RANGE"],"x-genesys-enum-members":[{"name":"DURATION"},{"name":"DURATION_RANGE"}]},"durationOperator":{"type":"string"},"durationRange":{"type":"string"}}},"EmailMediaPolicy":{"type":"object","properties":{"actions":{"description":"Actions applied when specified conditions are met","$ref":"#/definitions/PolicyActions"},"conditions":{"description":"Conditions for when actions should be applied","$ref":"#/definitions/EmailMediaPolicyConditions"}}},"EmailMediaPolicyConditions":{"type":"object","properties":{"forUsers":{"type":"array","items":{"$ref":"#/definitions/User"}},"dateRanges":{"type":"array","items":{"type":"string"}},"forQueues":{"type":"array","items":{"$ref":"#/definitions/Queue"}},"wrapupCodes":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}},"languages":{"type":"array","items":{"$ref":"#/definitions/Language"}},"timeAllowed":{"$ref":"#/definitions/TimeAllowed"}}},"EvaluationAssignment":{"type":"object","properties":{"evaluationForm":{"$ref":"#/definitions/EvaluationForm"},"user":{"$ref":"#/definitions/User"}}},"InitiateScreenRecording":{"type":"object","properties":{"recordACW":{"type":"boolean"},"archiveRetention":{"$ref":"#/definitions/ArchiveRetention"},"deleteRetention":{"$ref":"#/definitions/DeleteRetention"}}},"IntegrationExport":{"type":"object","required":["integration"],"properties":{"integration":{"description":"The aws-s3-recording-bulk-actions-integration that the policy uses for exports.","$ref":"#/definitions/DomainEntityRef"},"shouldExportScreenRecordings":{"type":"boolean","description":"True if the policy should export screen recordings in addition to the other conversation media. Default = true"}}},"Language":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The language name."},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"state":{"type":"string","enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"version":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"MediaPolicies":{"type":"object","properties":{"callPolicy":{"description":"Conditions and actions for calls","$ref":"#/definitions/CallMediaPolicy"},"chatPolicy":{"description":"Conditions and actions for chats","$ref":"#/definitions/ChatMediaPolicy"},"emailPolicy":{"description":"Conditions and actions for emails","$ref":"#/definitions/EmailMediaPolicy"},"messagePolicy":{"description":"Conditions and actions for messages","$ref":"#/definitions/MessageMediaPolicy"}}},"MediaTranscription":{"type":"object","properties":{"displayName":{"type":"string"},"transcriptionProvider":{"type":"string","enum":["VOCI","CALLJOURNEY"],"x-genesys-enum-members":[{"name":"VOCI"},{"name":"CALLJOURNEY"}]},"integrationId":{"type":"string"}}},"MessageMediaPolicy":{"type":"object","properties":{"actions":{"description":"Actions applied when specified conditions are met","$ref":"#/definitions/PolicyActions"},"conditions":{"description":"Conditions for when actions should be applied","$ref":"#/definitions/MessageMediaPolicyConditions"}}},"MessageMediaPolicyConditions":{"type":"object","properties":{"forUsers":{"type":"array","items":{"$ref":"#/definitions/User"}},"dateRanges":{"type":"array","items":{"type":"string"}},"forQueues":{"type":"array","items":{"$ref":"#/definitions/Queue"}},"wrapupCodes":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}},"languages":{"type":"array","items":{"$ref":"#/definitions/Language"}},"timeAllowed":{"$ref":"#/definitions/TimeAllowed"}}},"MeteredAssignmentByAgent":{"type":"object","properties":{"evaluationContextId":{"type":"string"},"evaluators":{"type":"array","items":{"$ref":"#/definitions/User"}},"maxNumberEvaluations":{"type":"integer","format":"int32"},"evaluationForm":{"$ref":"#/definitions/EvaluationForm"},"timeInterval":{"$ref":"#/definitions/TimeInterval"},"timeZone":{"type":"string"}}},"MeteredEvaluationAssignment":{"type":"object","properties":{"evaluationContextId":{"type":"string"},"evaluators":{"type":"array","items":{"$ref":"#/definitions/User"}},"maxNumberEvaluations":{"type":"integer","format":"int32"},"evaluationForm":{"$ref":"#/definitions/EvaluationForm"},"assignToActiveUser":{"type":"boolean"},"timeInterval":{"$ref":"#/definitions/TimeInterval"}}},"Policy":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"order":{"type":"integer","format":"int32"},"description":{"type":"string"},"enabled":{"type":"boolean"},"mediaPolicies":{"description":"Conditions and actions per media type","$ref":"#/definitions/MediaPolicies"},"conditions":{"description":"Conditions","$ref":"#/definitions/PolicyConditions"},"actions":{"description":"Actions","$ref":"#/definitions/PolicyActions"},"policyErrors":{"$ref":"#/definitions/PolicyErrors"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PolicyActions":{"type":"object","properties":{"retainRecording":{"type":"boolean","description":"true to retain the recording associated with the conversation. Default = true"},"deleteRecording":{"type":"boolean","description":"true to delete the recording associated with the conversation. If retainRecording = true, this will be ignored. Default = false"},"alwaysDelete":{"type":"boolean","description":"true to delete the recording associated with the conversation regardless of the values of retainRecording or deleteRecording. Default = false"},"assignEvaluations":{"type":"array","items":{"$ref":"#/definitions/EvaluationAssignment"}},"assignMeteredEvaluations":{"type":"array","items":{"$ref":"#/definitions/MeteredEvaluationAssignment"}},"assignMeteredAssignmentByAgent":{"type":"array","items":{"$ref":"#/definitions/MeteredAssignmentByAgent"}},"assignCalibrations":{"type":"array","items":{"$ref":"#/definitions/CalibrationAssignment"}},"assignSurveys":{"type":"array","items":{"$ref":"#/definitions/SurveyAssignment"}},"retentionDuration":{"$ref":"#/definitions/RetentionDuration"},"initiateScreenRecording":{"$ref":"#/definitions/InitiateScreenRecording"},"mediaTranscriptions":{"type":"array","items":{"$ref":"#/definitions/MediaTranscription"}},"integrationExport":{"description":"Policy action for exporting recordings using an integration to 3rd party s3.","$ref":"#/definitions/IntegrationExport"}}},"PolicyConditions":{"type":"object","properties":{"forUsers":{"type":"array","items":{"$ref":"#/definitions/User"}},"directions":{"type":"array","items":{"type":"string","enum":["INBOUND","OUTBOUND"],"x-genesys-enum-members":[{"name":"INBOUND"},{"name":"OUTBOUND"}]}},"dateRanges":{"type":"array","items":{"type":"string"}},"mediaTypes":{"type":"array","items":{"type":"string","enum":["CALL","CHAT"],"x-genesys-enum-members":[{"name":"CALL"},{"name":"CHAT"}]}},"forQueues":{"type":"array","items":{"$ref":"#/definitions/Queue"}},"duration":{"$ref":"#/definitions/DurationCondition"},"wrapupCodes":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}},"timeAllowed":{"$ref":"#/definitions/TimeAllowed"}}},"PolicyErrorMessage":{"type":"object","properties":{"statusCode":{"type":"integer","format":"int32"},"userMessage":{"type":"object"},"userParamsMessage":{"type":"string"},"errorCode":{"type":"string"},"correlationId":{"type":"string"},"userParams":{"type":"array","items":{"$ref":"#/definitions/UserParam"}},"insertDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"PolicyErrors":{"type":"object","properties":{"policyErrorMessages":{"type":"array","items":{"$ref":"#/definitions/PolicyErrorMessage"}}}},"PublishedSurveyFormReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"contextId":{"type":"string","description":"The context id of this form."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"RetentionDuration":{"type":"object","properties":{"archiveRetention":{"$ref":"#/definitions/ArchiveRetention"},"deleteRetention":{"$ref":"#/definitions/DeleteRetention"}}},"SurveyAssignment":{"type":"object","required":["sendingDomain"],"properties":{"surveyForm":{"description":"The survey form used for this survey.","$ref":"#/definitions/PublishedSurveyFormReference"},"flow":{"description":"The URI reference to the flow associated with this survey.","$ref":"#/definitions/DomainEntityRef"},"inviteTimeInterval":{"type":"string","description":"An ISO 8601 repeated interval consisting of the number of repetitions, the start datetime, and the interval (e.g. R2/2018-03-01T13:00:00Z/P1M10DT2H30M). Total duration must not exceed 90 days."},"sendingUser":{"type":"string","description":"User together with sendingDomain used to send email, null to use no-reply"},"sendingDomain":{"type":"string","description":"Validated email domain, required"}}},"TimeAllowed":{"type":"object","properties":{"timeSlots":{"type":"array","items":{"$ref":"#/definitions/TimeSlot"}},"timeZoneId":{"type":"string"},"empty":{"type":"boolean"}}},"TimeInterval":{"type":"object","properties":{"months":{"type":"integer","format":"int32"},"weeks":{"type":"integer","format":"int32"},"days":{"type":"integer","format":"int32"},"hours":{"type":"integer","format":"int32"}}},"TimeSlot":{"type":"object","properties":{"startTime":{"type":"string","description":"start time in xx:xx:xx.xxx format"},"stopTime":{"type":"string","description":"stop time in xx:xx:xx.xxx format"},"day":{"type":"integer","format":"int32","description":"Day for this time slot, Monday = 1 ... Sunday = 7"}}},"UserParam":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}},"WrapupCode":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The wrap-up code name."},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string"},"createdBy":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Flow":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The flow identifier"},"name":{"type":"string","description":"The flow name"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/WritableDivision"},"description":{"type":"string"},"type":{"type":"string","enum":["BOT","COMMONMODULE","INBOUNDCALL","INBOUNDCHAT","INBOUNDEMAIL","INBOUNDSHORTMESSAGE","INQUEUECALL","OUTBOUNDCALL","SECURECALL","SPEECH","SURVEYINVITE","WORKFLOW"],"x-genesys-enum-members":[{"name":"BOT"},{"name":"COMMONMODULE"},{"name":"INBOUNDCALL"},{"name":"INBOUNDCHAT"},{"name":"INBOUNDEMAIL"},{"name":"INBOUNDSHORTMESSAGE"},{"name":"INQUEUECALL"},{"name":"OUTBOUNDCALL"},{"name":"SECURECALL"},{"name":"SPEECH"},{"name":"SURVEYINVITE"},{"name":"WORKFLOW"}]},"lockedUser":{"description":"User that has the flow locked.","$ref":"#/definitions/User"},"lockedClient":{"description":"OAuth client that has the flow locked.","$ref":"#/definitions/DomainEntityRef"},"active":{"type":"boolean"},"system":{"type":"boolean"},"deleted":{"type":"boolean"},"publishedVersion":{"$ref":"#/definitions/FlowVersion"},"savedVersion":{"$ref":"#/definitions/FlowVersion"},"inputSchema":{"type":"object","description":"json schema describing the inputs for the flow"},"outputSchema":{"type":"object","description":"json schema describing the outputs for the flow"},"checkedInVersion":{"$ref":"#/definitions/FlowVersion"},"debugVersion":{"$ref":"#/definitions/FlowVersion"},"publishedBy":{"$ref":"#/definitions/User"},"currentOperation":{"$ref":"#/definitions/Operation"},"nluInfo":{"description":"Information about the natural language understanding configuration for the published version of the flow","readOnly":true,"$ref":"#/definitions/NluInfo"},"supportedLanguages":{"type":"array","description":"List of supported languages for the published version of the flow.","readOnly":true,"items":{"$ref":"#/definitions/SupportedLanguage"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FlowVersion":{"type":"object","properties":{"id":{"type":"string","description":"The flow version identifier"},"name":{"type":"string"},"commitVersion":{"type":"string"},"configurationVersion":{"type":"string"},"type":{"type":"string","enum":["PUBLISH","CHECKIN","SAVE"],"x-genesys-enum-members":[{"name":"PUBLISH"},{"name":"CHECKIN"},{"name":"SAVE"}]},"secure":{"type":"boolean"},"debug":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/User"},"createdByClient":{"$ref":"#/definitions/DomainEntityRef"},"configurationUri":{"type":"string"},"dateCreated":{"type":"integer","format":"int64"},"generationId":{"type":"string"},"publishResultUri":{"type":"string","format":"uri"},"inputSchema":{"$ref":"#/definitions/JsonSchemaDocument"},"outputSchema":{"$ref":"#/definitions/JsonSchemaDocument"},"nluInfo":{"description":"Information about the natural language understanding configuration for the flow version","readOnly":true,"$ref":"#/definitions/NluInfo"},"supportedLanguages":{"type":"array","description":"List of supported languages for this version of the flow","readOnly":true,"items":{"$ref":"#/definitions/SupportedLanguage"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Intent":{"type":"object","properties":{"name":{"type":"string"}}},"NluInfo":{"type":"object","properties":{"intents":{"type":"array","items":{"$ref":"#/definitions/Intent"}}}},"Operation":{"type":"object","properties":{"id":{"type":"string"},"complete":{"type":"boolean"},"user":{"$ref":"#/definitions/User"},"client":{"$ref":"#/definitions/DomainEntityRef"},"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorDetails":{"type":"array","items":{"$ref":"#/definitions/Detail"}},"errorMessageParams":{"type":"object","additionalProperties":{"type":"string"}},"actionName":{"type":"string","description":"Action name","enum":["CREATE","CHECKIN","DEBUG","DELETE","HISTORY","PUBLISH","STATE_CHANGE","UPDATE","VALIDATE"]},"actionStatus":{"type":"string","description":"Action status","enum":["LOCKED","UNLOCKED","STARTED","PENDING_GENERATION","PENDING_BACKEND_NOTIFICATION","SUCCESS","FAILURE"]}}},"Recipient":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"flow":{"description":"An automate flow object which defines the set of actions to be taken, when a message is received by this provisioned phone number.","$ref":"#/definitions/Flow"},"dateCreated":{"type":"string","format":"date-time","description":"Date this recipient was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date this recipient was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"description":"User that created this recipient","$ref":"#/definitions/User"},"modifiedBy":{"description":"User that modified this recipient","$ref":"#/definitions/User"},"messengerType":{"type":"string","description":"The messenger type for this recipient","enum":["sms","facebook","twitter","line","whatsapp","webmessaging"],"x-genesys-enum-members":[{"name":"sms"},{"name":"facebook"},{"name":"twitter"},{"name":"line"},{"name":"whatsapp"},{"name":"webmessaging"}]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SupportedLanguage":{"type":"object","properties":{"language":{"type":"string","description":"Architect supported language tag, e.g. en-us, es-us","readOnly":true},"isDefault":{"type":"boolean","description":"Whether or not this language is the default language","readOnly":true}}},"WritableDivision":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DialerEventEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/EventLog"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EventLog":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"errorEntity":{"$ref":"#/definitions/DomainEntityRef"},"relatedEntity":{"$ref":"#/definitions/DomainEntityRef"},"timestamp":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"level":{"type":"string","enum":["INFO","WARNING","ERROR"],"x-genesys-enum-members":[{"name":"INFO"},{"name":"WARNING"},{"name":"ERROR"}]},"category":{"type":"string","enum":["CALLBACK","CALL_RESTRICTION","CALL_RULE","CAMPAIGN","CAMPAIGN_RULE","CONTACT","CONTACT_LIST_FILTER","DNC_LIST","ENTITY_LIMIT","IMPORT_ERROR","MESSAGING_CAMPAIGN","ORGANIZATION_CONFIGURATION","SCHEDULE"],"x-genesys-enum-members":[{"name":"CALLBACK"},{"name":"CALL_RESTRICTION"},{"name":"CALL_RULE"},{"name":"CAMPAIGN"},{"name":"CAMPAIGN_RULE"},{"name":"CONTACT"},{"name":"CONTACT_LIST_FILTER"},{"name":"DNC_LIST"},{"name":"ENTITY_LIMIT"},{"name":"IMPORT_ERROR"},{"name":"MESSAGING_CAMPAIGN"},{"name":"ORGANIZATION_CONFIGURATION"},{"name":"SCHEDULE"}]},"correlationId":{"type":"string"},"eventMessage":{"$ref":"#/definitions/EventMessage"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EventMessage":{"type":"object","properties":{"code":{"type":"string","enum":["APPROACHING_CONTACT_LIMIT","APPROACHING_DNC_LIST_PHONE_NUMBER_LIMIT","APPROACHING_DNC_ORGANIZATION_PHONE_NUMBER_LIMIT","APPROACHING_ENTITY_LIMIT","AUTOMATIC_TIME_ZONE_ZIP_CODE_INVALID","CAMPAIGN_CONTENT_TEMPLATE_SUBSTITUTION_MISMATCH","CAMPAIGN_MESSAGE_CHARACTER_LIMIT_EXCEEDED","CAMPAIGN_START_ERROR","CAMPAIGN_RULE_START_ERROR","CAMPAIGN_SET_DIALING_MODE_ERROR","CAMPAIGN_STOPPED","CAMPAIGN_THROTTLED","CAMPAIGN_QUEUE_MEMBERS_LIMIT_EXCEEDED","INVALID_CALLABLE_TIME_ZONE","CALLBACK_CREATION_INVALID_NUMBER","CALL_RULE_INVALID_CONTACT_COLUMN","CALL_RULE_MISSING_DATA_ACTION_INPUT","CALL_RULE_MISMATCH_TYPE","CALL_RULE_INVALID_OPERATOR","CALL_RULE_NO_DNC_LISTS_CONFIGURED","CALL_RULE_UPDATED_PHONE_COLUMN","CONTACT_LIST_FILTER_EVALUATION_FAILED","CONTACT_LIST_FILTER_INTERNAL_ERROR","CONTACT_COLUMNS_LIMIT_EXCEEDED","CONTACT_COLUMN_LENGTH_LIMIT_EXCEEDED","CONTACT_DATUM_LENGTH_LIMIT_EXCEEDED","CONTACT_ZIP_CODE_COLUMN_VALUE_INVALID","DATA_ACTION_EXECUTION_FAILED","DATA_ACTION_AUTHENTICATION_FAILURE","DATA_ACTION_NOT_FOUND","DNC_AUTHENTICATION_FAILURE","EXCEEDED_CONTACT_LIMIT","EXCEEDED_DNC_RECORD_LIMIT","INACTIVE_EDGES_FAILED_PLACE_CALLS","INACTIVE_EDGES_TURNED_CAMPAIGN_OFF","INVALID_PHONE_NUMBER","IMPORT_FAILED_TO_READ_HEADERS","IMPORT_COULD_NOT_PARSE_AN_ENTRY","IMPORT_CONTACT_DOES_NOT_MATCH_LIST_FORMAT","IMPORT_ENTRY_DOES_NOT_ALIGN_WITH_HEADERS","IMPORT_INVALID_CUSTOM_ID","IMPORT_INVALID_DATA","IMPORT_COLUMN_EXCEEDS_LENGTH_LIMIT","IMPORT_DATUM_EXCEEDS_LENGTH_LIMIT","IMPORT_MISSING_CUSTOM_ID","IMPORT_NO_COLUMNS_DEFINED","IMPORT_COLUMNS_DO_NOT_EXIST_ON_LIST","IMPORT_LIST_NO_LONGER_EXISTS","IMPORT_FAILED_CONTACT_ZIP_CODE_COLUMN_VALUE_INVALID","IMPORT_TOO_MANY_COLUMNS","IMPORT_TOO_MANY_EXTRA_COLUMNS","ORGANIZATION_HAS_NO_DOMAIN_SET","RECYCLE_CAMPAIGN"],"x-genesys-enum-members":[{"name":"APPROACHING_CONTACT_LIMIT"},{"name":"APPROACHING_DNC_LIST_PHONE_NUMBER_LIMIT"},{"name":"APPROACHING_DNC_ORGANIZATION_PHONE_NUMBER_LIMIT"},{"name":"APPROACHING_ENTITY_LIMIT"},{"name":"AUTOMATIC_TIME_ZONE_ZIP_CODE_INVALID"},{"name":"CAMPAIGN_CONTENT_TEMPLATE_SUBSTITUTION_MISMATCH"},{"name":"CAMPAIGN_MESSAGE_CHARACTER_LIMIT_EXCEEDED"},{"name":"CAMPAIGN_START_ERROR"},{"name":"CAMPAIGN_RULE_START_ERROR"},{"name":"CAMPAIGN_SET_DIALING_MODE_ERROR"},{"name":"CAMPAIGN_STOPPED"},{"name":"CAMPAIGN_THROTTLED"},{"name":"CAMPAIGN_QUEUE_MEMBERS_LIMIT_EXCEEDED"},{"name":"INVALID_CALLABLE_TIME_ZONE"},{"name":"CALLBACK_CREATION_INVALID_NUMBER"},{"name":"CALL_RULE_INVALID_CONTACT_COLUMN"},{"name":"CALL_RULE_MISSING_DATA_ACTION_INPUT"},{"name":"CALL_RULE_MISMATCH_TYPE"},{"name":"CALL_RULE_INVALID_OPERATOR"},{"name":"CALL_RULE_NO_DNC_LISTS_CONFIGURED"},{"name":"CALL_RULE_UPDATED_PHONE_COLUMN"},{"name":"CONTACT_LIST_FILTER_EVALUATION_FAILED"},{"name":"CONTACT_LIST_FILTER_INTERNAL_ERROR"},{"name":"CONTACT_COLUMNS_LIMIT_EXCEEDED"},{"name":"CONTACT_COLUMN_LENGTH_LIMIT_EXCEEDED"},{"name":"CONTACT_DATUM_LENGTH_LIMIT_EXCEEDED"},{"name":"CONTACT_ZIP_CODE_COLUMN_VALUE_INVALID"},{"name":"DATA_ACTION_EXECUTION_FAILED"},{"name":"DATA_ACTION_AUTHENTICATION_FAILURE"},{"name":"DATA_ACTION_NOT_FOUND"},{"name":"DNC_AUTHENTICATION_FAILURE"},{"name":"EXCEEDED_CONTACT_LIMIT"},{"name":"EXCEEDED_DNC_RECORD_LIMIT"},{"name":"INACTIVE_EDGES_FAILED_PLACE_CALLS"},{"name":"INACTIVE_EDGES_TURNED_CAMPAIGN_OFF"},{"name":"INVALID_PHONE_NUMBER"},{"name":"IMPORT_FAILED_TO_READ_HEADERS"},{"name":"IMPORT_COULD_NOT_PARSE_AN_ENTRY"},{"name":"IMPORT_CONTACT_DOES_NOT_MATCH_LIST_FORMAT"},{"name":"IMPORT_ENTRY_DOES_NOT_ALIGN_WITH_HEADERS"},{"name":"IMPORT_INVALID_CUSTOM_ID"},{"name":"IMPORT_INVALID_DATA"},{"name":"IMPORT_COLUMN_EXCEEDS_LENGTH_LIMIT"},{"name":"IMPORT_DATUM_EXCEEDS_LENGTH_LIMIT"},{"name":"IMPORT_MISSING_CUSTOM_ID"},{"name":"IMPORT_NO_COLUMNS_DEFINED"},{"name":"IMPORT_COLUMNS_DO_NOT_EXIST_ON_LIST"},{"name":"IMPORT_LIST_NO_LONGER_EXISTS"},{"name":"IMPORT_FAILED_CONTACT_ZIP_CODE_COLUMN_VALUE_INVALID"},{"name":"IMPORT_TOO_MANY_COLUMNS"},{"name":"IMPORT_TOO_MANY_EXTRA_COLUMNS"},{"name":"ORGANIZATION_HAS_NO_DOMAIN_SET"},{"name":"RECYCLE_CAMPAIGN"}]},"message":{"type":"string"},"messageWithParams":{"type":"string"},"messageParams":{"type":"object","additionalProperties":{"type":"object"}},"documentationUri":{"type":"string"},"resourceURIs":{"type":"array","items":{"type":"string"}}}},"DomainEntityListingSurveyForm":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SurveyForm"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"SurveyForm":{"type":"object","required":["contextId","language","name","questionGroups"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The survey form name"},"modifiedDate":{"type":"string","format":"date-time","description":"Last modified date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"published":{"type":"boolean","description":"Is this form published","readOnly":true},"disabled":{"type":"boolean","description":"Is this form disabled"},"contextId":{"type":"string","description":"Unique Id for all versions of this form","readOnly":true},"language":{"type":"string","description":"Language for survey viewer localization. Currently localized languages: da, de, en-US, es, fi, fr, it, ja, ko, nl, no, pl, pt-BR, sv, th, tr, zh-CH, zh-TW"},"header":{"type":"string","description":"Markdown text for the top of the form."},"footer":{"type":"string","description":"Markdown text for the bottom of the form."},"questionGroups":{"type":"array","description":"A list of question groups","items":{"$ref":"#/definitions/SurveyQuestionGroup"}},"publishedVersions":{"description":"List of published version of this form","readOnly":true,"$ref":"#/definitions/DomainEntityListingSurveyForm"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SurveyQuestion":{"type":"object","properties":{"id":{"type":"string"},"text":{"type":"string"},"helpText":{"type":"string"},"type":{"type":"string","enum":["multipleChoiceQuestion","freeTextQuestion","npsQuestion","readOnlyTextBlockQuestion"],"x-genesys-enum-members":[{"name":"multipleChoiceQuestion"},{"name":"freeTextQuestion"},{"name":"npsQuestion"},{"name":"readOnlyTextBlockQuestion"}]},"naEnabled":{"type":"boolean"},"visibilityCondition":{"$ref":"#/definitions/VisibilityCondition"},"answerOptions":{"type":"array","description":"Options from which to choose an answer for this question. Only used by Multiple Choice type questions.","items":{"$ref":"#/definitions/AnswerOption"}},"maxResponseCharacters":{"type":"integer","format":"int32","description":"How many characters are allowed in the text response to this question. Used by NPS and Free Text question types."},"explanationPrompt":{"type":"string","description":"Prompt for details explaining the chosen NPS score. Used by NPS questions."}}},"SurveyQuestionGroup":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"naEnabled":{"type":"boolean"},"questions":{"type":"array","items":{"$ref":"#/definitions/SurveyQuestion"}},"visibilityCondition":{"$ref":"#/definitions/VisibilityCondition"}}},"CommandStatus":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"expiration":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"userId":{"type":"string"},"statusCode":{"type":"string","enum":["INPROGRESS","COMPLETE","ERROR","CANCELING","CANCELED"],"x-genesys-enum-members":[{"name":"INPROGRESS"},{"name":"COMPLETE"},{"name":"ERROR"},{"name":"CANCELING"},{"name":"CANCELED"}]},"commandType":{"type":"string","enum":["UPLOAD","COPYDOCUMENT","MOVEDOCUMENT","DELETEWORKSPACE","DELETEDOCUMENT","DELETETAG","UPDATETAG","REINDEX","CLEANUP","REPLACEDOCUMENT"],"x-genesys-enum-members":[{"name":"UPLOAD"},{"name":"COPYDOCUMENT"},{"name":"MOVEDOCUMENT"},{"name":"DELETEWORKSPACE"},{"name":"DELETEDOCUMENT"},{"name":"DELETETAG"},{"name":"UPDATETAG"},{"name":"REINDEX"},{"name":"CLEANUP"},{"name":"REPLACEDOCUMENT"}]},"document":{"$ref":"#/definitions/Document"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EdgeTrunkBase":{"type":"object","required":["name","trunkMetabase","trunkType"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"trunkMetabase":{"description":"The meta-base this trunk is based on.","$ref":"#/definitions/DomainEntityRef"},"properties":{"type":"object","additionalProperties":{"type":"object"}},"trunkType":{"type":"string","description":"The type of this trunk base.","enum":["EXTERNAL","PHONE","EDGE"],"x-genesys-enum-members":[{"name":"EXTERNAL"},{"name":"PHONE"},{"name":"EDGE"}]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FlowDivisionView":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The flow identifier"},"name":{"type":"string","description":"The flow name"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/WritableDivision"},"type":{"type":"string","enum":["BOT","COMMONMODULE","INBOUNDCALL","INBOUNDCHAT","INBOUNDEMAIL","INBOUNDSHORTMESSAGE","INQUEUECALL","OUTBOUNDCALL","SECURECALL","SPEECH","SURVEYINVITE","WORKFLOW"],"x-genesys-enum-members":[{"name":"BOT"},{"name":"COMMONMODULE"},{"name":"INBOUNDCALL"},{"name":"INBOUNDCHAT"},{"name":"INBOUNDEMAIL"},{"name":"INBOUNDSHORTMESSAGE"},{"name":"INQUEUECALL"},{"name":"OUTBOUNDCALL"},{"name":"SECURECALL"},{"name":"SPEECH"},{"name":"SURVEYINVITE"},{"name":"WORKFLOW"}]},"inputSchema":{"description":"json schema describing the inputs for the flow","$ref":"#/definitions/JsonSchemaDocument"},"outputSchema":{"description":"json schema describing the outputs for the flow","$ref":"#/definitions/JsonSchemaDocument"},"publishedVersion":{"description":"published version information if there is a published version","$ref":"#/definitions/FlowVersion"},"debugVersion":{"description":"debug version information if there is a debug version","$ref":"#/definitions/FlowVersion"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FlowDivisionViewEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/FlowDivisionView"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"LexBot":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string","description":"A description of the Lex bot"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LexBotAlias":{"type":"object","required":["status"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"bot":{"description":"The Lex bot this is an alias for","$ref":"#/definitions/LexBot"},"botVersion":{"type":"string","description":"The version of the Lex bot this alias points at"},"status":{"type":"string","description":"The status of the Lex bot alias","enum":["BUILDING","READY","FAILED","NOT_BUILT"],"x-genesys-enum-members":[{"name":"BUILDING"},{"name":"READY"},{"name":"FAILED"},{"name":"NOT_BUILT"}]},"failureReason":{"type":"string","description":"If the status is FAILED, Amazon Lex explains why it failed to build the bot"},"language":{"type":"string","description":"The target language of the Lex bot","enum":["en-US"]},"intents":{"type":"array","description":"An array of Intents associated with this bot alias","items":{"$ref":"#/definitions/LexIntent"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LexBotAliasEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/LexBotAlias"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"LexIntent":{"type":"object","required":["name","slots","version"],"properties":{"name":{"type":"string","description":"The intent name"},"description":{"type":"string","description":"A description of the intent"},"slots":{"type":"object","description":"An object mapping slot names to Slot objects","additionalProperties":{"$ref":"#/definitions/LexSlot"}},"version":{"type":"string","description":"The intent version"}}},"LexSlot":{"type":"object","required":["name","type"],"properties":{"name":{"type":"string","description":"The slot name"},"description":{"type":"string","description":"The slot description"},"type":{"type":"string","description":"The slot type"},"priority":{"type":"integer","format":"int32","description":"The priority of the slot"}}},"WidgetClientConfig":{"type":"object","properties":{"v1":{"$ref":"#/definitions/WidgetClientConfigV1"},"v2":{"$ref":"#/definitions/WidgetClientConfigV2"},"v1-http":{"$ref":"#/definitions/WidgetClientConfigV1Http"},"third-party":{"$ref":"#/definitions/WidgetClientConfigThirdParty"}}},"WidgetClientConfigThirdParty":{"type":"object"},"WidgetClientConfigV1":{"type":"object","properties":{"webChatSkin":{"type":"string","enum":["basic","modern-caret-skin"],"x-genesys-enum-members":[{"name":"basic"},{"name":"modern-caret-skin"}]},"authenticationUrl":{"type":"string","format":"uri"}}},"WidgetClientConfigV1Http":{"type":"object","properties":{"webChatSkin":{"type":"string","enum":["basic","modern-caret-skin"],"x-genesys-enum-members":[{"name":"basic"},{"name":"modern-caret-skin"}]},"authenticationUrl":{"type":"string","format":"uri"}}},"WidgetClientConfigV2":{"type":"object"},"WidgetDeployment":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string","description":"A human-readable description of this Deployment."},"authenticationRequired":{"type":"boolean","description":"When true, the customer members starting a chat must be authenticated by supplying their JWT to the create operation."},"disabled":{"type":"boolean","description":"When true, all create chat operations using this Deployment will be rejected."},"flow":{"description":"The URI of the Inbound Chat Flow to run when new chats are initiated under this Deployment.","$ref":"#/definitions/DomainEntityRef"},"allowedDomains":{"type":"array","description":"The list of domains that are approved to use this Deployment; the list will be added to CORS headers for ease of web use.","items":{"type":"string"}},"clientType":{"type":"string","description":"The type of display widget for which this Deployment is configured, which controls the administrator settings shown.","enum":["v1","v2","v1-http","third-party"],"x-genesys-enum-members":[{"name":"v1"},{"name":"v2"},{"name":"v1-http"},{"name":"third-party"}]},"clientConfig":{"description":"The client configuration options that should be made available to the clients of this Deployment.","$ref":"#/definitions/WidgetClientConfig"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WidgetDeploymentEntityListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/WidgetDeployment"}},"selfUri":{"type":"string","format":"uri"}}},"Action":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"integrationId":{"type":"string","description":"The ID of the integration for which this action is associated"},"category":{"type":"string","description":"Category of Action"},"contract":{"description":"Action contract","$ref":"#/definitions/ActionContract"},"version":{"type":"integer","format":"int32","description":"Version of this action"},"secure":{"type":"boolean","description":"Indication of whether or not the action is designed to accept sensitive data"},"config":{"description":"Configuration to support request and response processing","$ref":"#/definitions/ActionConfig"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ActionConfig":{"type":"object","properties":{"request":{"description":"Configuration of outbound request.","$ref":"#/definitions/RequestConfig"},"response":{"description":"Configuration of response processing.","$ref":"#/definitions/ResponseConfig"}},"description":"Defines components of the Action Config."},"ActionContract":{"type":"object","properties":{"output":{"description":"The output to expect when executing this action.","$ref":"#/definitions/ActionOutput"},"input":{"description":"The input required when executing this action.","$ref":"#/definitions/ActionInput"}},"description":"This resource contains all of the schemas needed to define the inputs and outputs, of a single Action."},"ActionInput":{"type":"object","properties":{"inputSchema":{"description":"JSON Schema that defines the body of the request that the client (edge/architect/postman) is sending to the service, on the /execute path. If the 'flatten' query parameter is omitted or false, this field will be returned. Either inputSchema or inputSchemaFlattened will be returned, not both.","$ref":"#/definitions/JsonSchemaDocument"},"inputSchemaFlattened":{"description":"JSON Schema that defines the body of the request that the client (edge/architect/postman) is sending to the service, on the /execute path. The schema is transformed based on Architect's flattened format. If the 'flatten' query parameter is supplied as true, this field will be returned. Either inputSchema or inputSchemaFlattened will be returned, not both.","$ref":"#/definitions/JsonSchemaDocument"},"inputSchemaUri":{"type":"string","description":"The URI of the input schema"}},"description":"Input requirements of Action."},"ActionOutput":{"type":"object","properties":{"successSchema":{"description":"JSON schema that defines the transformed, successful result that will be sent back to the caller. If the 'flatten' query parameter is omitted or false, this field will be returned. Either successSchema or successSchemaFlattened will be returned, not both.","$ref":"#/definitions/JsonSchemaDocument"},"successSchemaUri":{"type":"string","description":"URI to retrieve success schema"},"errorSchema":{"description":"JSON schema that defines the body of response when request is not successful. If the 'flatten' query parameter is omitted or false, this field will be returned. Either errorSchema or errorSchemaFlattened will be returned, not both.","$ref":"#/definitions/JsonSchemaDocument"},"errorSchemaUri":{"type":"string","description":"URI to retrieve error schema"},"successSchemaFlattened":{"description":"JSON schema that defines the transformed, successful result that will be sent back to the caller. The schema is transformed based on Architect's flattened format. If the 'flatten' query parameter is supplied as true, this field will be returned. Either successSchema or successSchemaFlattened will be returned, not both.","$ref":"#/definitions/JsonSchemaDocument"},"errorSchemaFlattened":{"type":"object","description":"JSON schema that defines the body of response when request is not successful. The schema is transformed based on Architect's flattened format. If the 'flatten' query parameter is supplied as true, this field will be returned. Either errorSchema or errorSchemaFlattened will be returned, not both."}},"description":"Output definition of Action."},"RequestConfig":{"type":"object","properties":{"requestUrlTemplate":{"type":"string","description":"URL that may include placeholders for requests to 3rd party service"},"requestTemplate":{"type":"string","description":"Velocity template to define request body sent to 3rd party service."},"requestTemplateUri":{"type":"string","description":"URI to retrieve requestTemplate"},"requestType":{"type":"string","description":"HTTP method to use for request"},"headers":{"type":"object","description":"Headers to include in request in (Header Name, Value) pairs.","additionalProperties":{"type":"string"}}},"description":"Defines response components of the Action Request."},"ResponseConfig":{"type":"object","properties":{"translationMap":{"type":"object","description":"Map 'attribute name' and 'JSON path' pairs used to extract data from REST response.","additionalProperties":{"type":"string"}},"translationMapDefaults":{"type":"object","description":"Map 'attribute name' and 'default value' pairs used as fallback values if JSON path extraction fails for specified key.","additionalProperties":{"type":"string"}},"successTemplate":{"type":"string","description":"Velocity template to build response to return from Action."},"successTemplateUri":{"type":"string","description":"URI to retrieve success template."}},"description":"Defines response components of the Action Request."},"ActionContractInput":{"type":"object","required":["input","output"],"properties":{"input":{"description":"Execution input contract","$ref":"#/definitions/PostInputContract"},"output":{"description":"Execution output contract","$ref":"#/definitions/PostOutputContract"}},"description":"Contract definition."},"PostActionInput":{"type":"object","required":["category","config","contract","integrationId","name"],"properties":{"category":{"type":"string","description":"Category of action, Can be up to 256 characters long"},"name":{"type":"string","description":"Name of action, Can be up to 256 characters long"},"integrationId":{"type":"string","description":"The ID of the integration this action is associated to"},"config":{"description":"Configuration to support request and response processing","$ref":"#/definitions/ActionConfig"},"contract":{"description":"Action contract","$ref":"#/definitions/ActionContractInput"},"secure":{"type":"boolean","description":"Indication of whether or not the action is designed to accept sensitive data"}},"description":"Definition of an Action to be created or updated."},"PostInputContract":{"type":"object","required":["inputSchema"],"properties":{"inputSchema":{"description":"JSON Schema that defines the body of the request that the client (edge/architect/postman) is sending to the service, on the /execute path.","$ref":"#/definitions/JsonSchemaDocument"}},"description":"The schemas defining all of the expected requests/inputs."},"PostOutputContract":{"type":"object","required":["successSchema"],"properties":{"successSchema":{"description":"JSON schema that defines the transformed, successful result that will be sent back to the caller.","$ref":"#/definitions/JsonSchemaDocument"}},"description":"The schemas defining all of the expected responses/outputs."},"ActionEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Action"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ReportRunEntry":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"reportId":{"type":"string"},"runTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"runStatus":{"type":"string","enum":["RUNNING","COMPLETED","COMPLETED_WITH_ERRORS","FAILED","FAILED_TIMEOUT","FAILED_DATALIMIT","UNABLE_TO_COMPLETE"],"x-genesys-enum-members":[{"name":"RUNNING"},{"name":"COMPLETED"},{"name":"COMPLETED_WITH_ERRORS"},{"name":"FAILED"},{"name":"FAILED_TIMEOUT"},{"name":"FAILED_DATALIMIT"},{"name":"UNABLE_TO_COMPLETE"}]},"errorMessage":{"type":"string"},"runDurationMsec":{"type":"integer","format":"int64"},"reportUrl":{"type":"string"},"reportFormat":{"type":"string"},"scheduleUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ReportRunEntryEntityDomainListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ReportRunEntry"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ActiveAlertCount":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"The count of active alerts for a user."}}},"PolicyEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Policy"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"PolicyCreate":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The policy name."},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"order":{"type":"integer","format":"int32"},"description":{"type":"string"},"enabled":{"type":"boolean"},"mediaPolicies":{"description":"Conditions and actions per media type","$ref":"#/definitions/MediaPolicies"},"conditions":{"description":"Conditions","$ref":"#/definitions/PolicyConditions"},"actions":{"description":"Actions","$ref":"#/definitions/PolicyActions"},"policyErrors":{"$ref":"#/definitions/PolicyErrors"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeBase":{"type":"object","required":["coreLanguage"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string","description":"Knowledge base description"},"coreLanguage":{"type":"string","example":"en-us","description":"Core language for knowledge base in which initial content must be created first","enum":["en-US","de-DE"],"x-genesys-enum-members":[{"name":"en-US"},{"name":"de-DE"}]},"dateCreated":{"type":"string","format":"date-time","description":"Knowledge base creation date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Knowledge base last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"faqCount":{"type":"integer","format":"int32","description":"The count representing the number of documents of type FAQ per KnowledgeBase","readOnly":true},"dateDocumentLastModified":{"type":"string","format":"date-time","description":"The date representing when the last document is modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeTraining":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"dateTriggered":{"type":"string","format":"date-time","description":"Trigger date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateCompleted":{"type":"string","format":"date-time","description":"Training completed date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"status":{"type":"string","description":"Training status.","readOnly":true,"enum":["Queued","InProgress","Succeeded","Failed"],"x-genesys-enum-members":[{"name":"Queued"},{"name":"InProgress"},{"name":"Succeeded"},{"name":"Failed"}]},"languageCode":{"type":"string","description":"Language of the documents that are trained.","readOnly":true},"knowledgeBase":{"description":"Knowledge Base that the training belongs to.","readOnly":true,"$ref":"#/definitions/KnowledgeBase"},"errorMessage":{"type":"string","description":"Any error message during the Training or Promote action.","readOnly":true},"knowledgeDocumentsState":{"type":"string","description":"State of the Trained Documents, which can be one of these Draft, Active, Discarded, Archived.","readOnly":true,"enum":["Draft","Active","Discarded","Archived"],"x-genesys-enum-members":[{"name":"Draft"},{"name":"Active"},{"name":"Discarded"},{"name":"Archived"}]},"datePromoted":{"type":"string","format":"date-time","description":"Trained Documents Promoted date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TrainingListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/KnowledgeTraining"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"QueueMember":{"type":"object","properties":{"id":{"type":"string","description":"The queue member's id."},"name":{"type":"string"},"user":{"$ref":"#/definitions/User"},"ringNumber":{"type":"integer","format":"int32"},"joined":{"type":"boolean"},"memberBy":{"type":"string"},"routingStatus":{"$ref":"#/definitions/RoutingStatus"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TrustGroup":{"type":"object","required":["name","rulesVisible","type","visibility"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The group name."},"description":{"type":"string"},"dateModified":{"type":"string","format":"date-time","description":"Last modified date/time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"memberCount":{"type":"integer","format":"int64","description":"Number of members.","readOnly":true},"state":{"type":"string","description":"Active, inactive, or deleted state.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"version":{"type":"integer","format":"int32","description":"Current version for this resource.","readOnly":true},"type":{"type":"string","description":"Type of group.","enum":["official","social"],"x-genesys-enum-members":[{"name":"official"},{"name":"social"}]},"images":{"type":"array","items":{"$ref":"#/definitions/UserImage"}},"addresses":{"type":"array","items":{"$ref":"#/definitions/GroupContact"}},"rulesVisible":{"type":"boolean","description":"Are membership rules visible to the person requesting to view the group"},"visibility":{"type":"string","description":"Who can view this group","enum":["public","owners","members"]},"owners":{"type":"array","description":"Owners of the group","items":{"$ref":"#/definitions/User"}},"dateCreated":{"type":"string","format":"date-time","description":"The date on which the trusted group was added. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"createdBy":{"description":"The user that added trusted group.","readOnly":true,"$ref":"#/definitions/OrgUser"}}},"VoicemailsSearchResponse":{"type":"object","required":["pageCount","pageNumber","pageSize","results","total","types"],"properties":{"total":{"type":"integer","format":"int64","description":"The total number of results found"},"pageCount":{"type":"integer","format":"int32","description":"The total number of pages"},"pageSize":{"type":"integer","format":"int32","description":"The current page size"},"pageNumber":{"type":"integer","format":"int32","description":"The current page number"},"previousPage":{"type":"string","description":"Q64 value for the previous page of results"},"currentPage":{"type":"string","description":"Q64 value for the current page of results"},"nextPage":{"type":"string","description":"Q64 value for the next page of results"},"types":{"type":"array","description":"Resource types the search was performed against","items":{"type":"string"}},"results":{"type":"array","description":"Search results","items":{"$ref":"#/definitions/VoicemailMessage"}}}},"SearchSort":{"type":"object","properties":{"sortOrder":{"type":"string","description":"The sort order for results","enum":["ASC","DESC","SCORE"],"x-genesys-enum-members":[{"name":"ASC"},{"name":"DESC"},{"name":"SCORE"}]},"sortBy":{"type":"string","description":"The field in the resource that you want to sort the results by"}}},"VoicemailSearchCriteria":{"type":"object","required":["type"],"properties":{"endValue":{"type":"string","description":"The end value of the range. This field is used for range search types."},"values":{"type":"array","description":"A list of values for the search to match against","items":{"type":"string"}},"startValue":{"type":"string","description":"The start value of the range. This field is used for range search types."},"fields":{"type":"array","description":"Field names to search against","items":{"type":"string"}},"value":{"type":"string","description":"A value for the search to match against"},"operator":{"type":"string","description":"How to apply this search criteria against other criteria","enum":["AND","OR","NOT"],"x-genesys-enum-members":[{"name":"AND"},{"name":"OR"},{"name":"NOT"}]},"group":{"type":"array","description":"Groups multiple conditions","items":{"$ref":"#/definitions/VoicemailSearchCriteria"}},"dateFormat":{"type":"string","description":"Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."},"type":{"type":"string","description":"Search Type","enum":["EXACT","STARTS_WITH","CONTAINS","REGEX","TERM","TERMS","REQUIRED_FIELDS","MATCH_ALL"],"x-genesys-enum-members":[{"name":"EXACT"},{"name":"STARTS_WITH"},{"name":"CONTAINS"},{"name":"REGEX"},{"name":"TERM"},{"name":"TERMS"},{"name":"REQUIRED_FIELDS"},{"name":"MATCH_ALL"}]}}},"VoicemailSearchRequest":{"type":"object","properties":{"sortOrder":{"type":"string","description":"The sort order for results","enum":["ASC","DESC","SCORE"],"x-genesys-enum-members":[{"name":"ASC"},{"name":"DESC"},{"name":"SCORE"}]},"sortBy":{"type":"string","description":"The field in the resource that you want to sort the results by"},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"},"pageNumber":{"type":"integer","format":"int32","description":"The page of resources you want to retrieve"},"sort":{"type":"array","description":"Multi-value sort order, list of multiple sort values","items":{"$ref":"#/definitions/SearchSort"}},"expand":{"type":"array","description":"Provides more details about a specified resource","items":{"type":"string"}},"query":{"type":"array","items":{"$ref":"#/definitions/VoicemailSearchCriteria"}}}},"CampaignSchedule":{"type":"object","required":["campaign","intervals","timeZone"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"intervals":{"type":"array","description":"A list of intervals during which to run the associated Campaign.","items":{"$ref":"#/definitions/ScheduleInterval"}},"timeZone":{"type":"string","example":"Africa/Abidjan","description":"The time zone for this CampaignSchedule. For example, Africa/Abidjan."},"campaign":{"description":"The Campaign that this CampaignSchedule is for.","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ScheduleInterval":{"type":"object","required":["end","start"],"properties":{"start":{"type":"string","description":"The scheduled start time as an ISO-8601 string, i.e yyyy-MM-ddTHH:mm:ss.SSSZ"},"end":{"type":"string","description":"The scheduled end time as an ISO-8601 string, i.e. yyyy-MM-ddTHH:mm:ss.SSSZ"}}},"AdherenceSettings":{"type":"object","properties":{"severeAlertThresholdMinutes":{"type":"integer","format":"int32","description":"The threshold in minutes where an alert will be triggered when an agent is considered severely out of adherence"},"adherenceTargetPercent":{"type":"integer","format":"int32","description":"Target adherence percentage"},"adherenceExceptionThresholdSeconds":{"type":"integer","format":"int32","description":"The threshold in seconds for which agents should not be penalized for being momentarily out of adherence"},"nonOnQueueActivitiesEquivalent":{"type":"boolean","description":"Whether to treat all non-on-queue activities as equivalent for adherence purposes"},"trackOnQueueActivity":{"type":"boolean","description":"Whether to track on-queue activities"},"ignoredActivityCategories":{"description":"Activity categories that should be ignored for adherence purposes","$ref":"#/definitions/IgnoredActivityCategories"}},"description":"Schedule Adherence Configuration"},"BusinessUnitReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"IgnoredActivityCategories":{"type":"object","properties":{"values":{"type":"array","description":"Activity categories list","items":{"type":"string","enum":["OnQueueWork","Break","Meal","Meeting","OffQueueWork","TimeOff","Training","Unavailable","Unscheduled"],"x-genesys-enum-members":[{"name":"OnQueueWork"},{"name":"Break"},{"name":"Meal"},{"name":"Meeting"},{"name":"OffQueueWork"},{"name":"TimeOff"},{"name":"Training"},{"name":"Unavailable"},{"name":"Unscheduled"}]}}}},"ManagementUnit":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"startDayOfWeek":{"type":"string","description":"Start day of week for scheduling and forecasting purposes. Moving to Business Unit","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"x-genesys-enum-members":[{"name":"Sunday"},{"name":"Monday"},{"name":"Tuesday"},{"name":"Wednesday"},{"name":"Thursday"},{"name":"Friday"},{"name":"Saturday"}]},"timeZone":{"type":"string","description":"The time zone for the management unit in standard Olson format. Moving to Business Unit"},"settings":{"description":"The configuration settings for this management unit","$ref":"#/definitions/ManagementUnitSettingsResponse"},"metadata":{"description":"Version info metadata for this management unit. Deprecated, use settings.metadata","$ref":"#/definitions/WfmVersionedEntityMetadata"},"version":{"type":"integer","format":"int32","description":"The version of the underlying entity. Deprecated, use field from settings.metadata instead","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date and time at which this entity was last modified. Deprecated, use field from settings.metadata instead. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"description":"The user who last modified this entity. Deprecated, use field from settings.metadata instead","readOnly":true,"$ref":"#/definitions/UserReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Management Unit object for Workforce Management"},"ManagementUnitSettingsResponse":{"type":"object","required":["metadata"],"properties":{"adherence":{"description":"Adherence settings for this management unit","$ref":"#/definitions/AdherenceSettings"},"shortTermForecasting":{"description":"Short term forecasting settings for this management unit","$ref":"#/definitions/ShortTermForecastingSettings"},"timeOff":{"description":"Time off request settings for this management unit","$ref":"#/definitions/TimeOffRequestSettings"},"scheduling":{"description":"Scheduling settings for this management unit","$ref":"#/definitions/SchedulingSettingsResponse"},"shiftTrading":{"description":"Shift trade settings for this management unit","$ref":"#/definitions/ShiftTradeSettings"},"metadata":{"description":"Version info metadata for the associated management unit","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"PlanningPeriodSettings":{"type":"object","required":["startDate","weekCount"],"properties":{"weekCount":{"type":"integer","format":"int32","description":"Planning period length in weeks"},"startDate":{"type":"string","format":"date","description":"Start date of the planning period in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"}}},"QueueReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SchedulingSettingsResponse":{"type":"object","properties":{"maxOccupancyPercentForDeferredWork":{"type":"integer","format":"int32","description":"Max occupancy percent for deferred work"},"defaultShrinkagePercent":{"type":"number","format":"double","description":"Default shrinkage percent for scheduling"},"shrinkageOverrides":{"description":"Shrinkage overrides for scheduling","$ref":"#/definitions/ShrinkageOverrides"}},"description":"Scheduling Settings"},"ShiftTradeActivityRule":{"type":"object","required":["action","activityCategory"],"properties":{"activityCategory":{"type":"string","description":"The activity category to which to apply this rule","enum":["OnQueueWork","Break","Meal","Meeting","OffQueueWork","TimeOff","Training","Unavailable","Unscheduled"],"x-genesys-enum-members":[{"name":"OnQueueWork"},{"name":"Break"},{"name":"Meal"},{"name":"Meeting"},{"name":"OffQueueWork"},{"name":"TimeOff"},{"name":"Training"},{"name":"Unavailable"},{"name":"Unscheduled"}]},"action":{"type":"string","description":"The action this rule invokes","enum":["Replace","DoNotAllowTrade","KeepWithSchedule"],"x-genesys-enum-members":[{"name":"Replace"},{"name":"DoNotAllowTrade"},{"name":"KeepWithSchedule"}]},"activityCodeIdReplacement":{"type":"string","description":"The activity code ID with which to replace activities belonging to the original category if applicable (required if action == Replace, must be a default activity code ID)"}}},"ShiftTradeSettings":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether shift trading is enabled for this management unit"},"autoReview":{"type":"boolean","description":"Whether automatic shift trade review is enabled according to the rules defined in for this management unit"},"allowDirectTrades":{"type":"boolean","description":"Whether direct shift trades between agents are allowed"},"minHoursInFuture":{"type":"integer","format":"int32","description":"The minimum number of hours in the future shift trades are allowed"},"unequalPaid":{"type":"string","description":"How to handle shift trades which involve unequal paid times","enum":["Allow","Disallow","AdminReview"],"x-genesys-enum-members":[{"name":"Allow"},{"name":"Disallow"},{"name":"AdminReview"}]},"oneSided":{"type":"string","description":"How to handle one-sided shift trades","enum":["Allow","Disallow","AdminReview"],"x-genesys-enum-members":[{"name":"Allow"},{"name":"Disallow"},{"name":"AdminReview"}]},"weeklyMinPaidViolations":{"type":"string","description":"How to handle shift trades which result in violations of weekly minimum paid time constraint","enum":["Allow","Disallow","AdminReview"],"x-genesys-enum-members":[{"name":"Allow"},{"name":"Disallow"},{"name":"AdminReview"}]},"weeklyMaxPaidViolations":{"type":"string","description":"How to handle shift trades which result in violations of weekly maximum paid time constraint","enum":["Allow","Disallow","AdminReview"],"x-genesys-enum-members":[{"name":"Allow"},{"name":"Disallow"},{"name":"AdminReview"}]},"requiresMatchingQueues":{"type":"boolean","description":"Whether to constrain shift trades to agents with matching queues"},"requiresMatchingLanguages":{"type":"boolean","description":"Whether to constrain shift trades to agents with matching languages"},"requiresMatchingSkills":{"type":"boolean","description":"Whether to constrain shift trades to agents with matching skills"},"requiresMatchingPlanningGroups":{"type":"boolean","description":"Whether to constrain shift trades to agents with matching planning groups"},"activityCategoryRules":{"type":"array","description":"Rules that specify what to do with activity categories that are part of a shift defined in a trade","items":{"$ref":"#/definitions/ShiftTradeActivityRule"}}}},"ShortTermForecastingSettings":{"type":"object","properties":{"defaultHistoryWeeks":{"type":"integer","format":"int32","description":"The number of weeks to consider by default when generating a volume forecast"}},"description":"Short Term Forecasting Settings"},"ShrinkageOverride":{"type":"object","required":["intervalIndex"],"properties":{"intervalIndex":{"type":"integer","format":"int32","description":"Index of shrinkage override interval. Starting index is 0 and indexes are based on 15 minute intervals for a 7 day week"},"shrinkagePercent":{"type":"number","format":"double","description":"Shrinkage override percent. Setting a null value will reset the interval to the default"}}},"ShrinkageOverrides":{"type":"object","properties":{"clear":{"type":"boolean","description":"Set true to clear the shrinkage interval overrides"},"values":{"type":"array","description":"List of interval shrinkage overrides","items":{"$ref":"#/definitions/ShrinkageOverride"}}}},"TimeOffRequestSettings":{"type":"object","properties":{"submissionRangeEnforced":{"type":"boolean","description":"Whether to enforce a submission range for agent time off requests"},"submissionEarliestDaysFromNow":{"type":"integer","format":"int32","description":"The earliest number of days from now for which an agent can submit a time off request. Use negative numbers to indicate days in the past"},"submissionLatestDaysFromNow":{"type":"integer","format":"int32","description":"The latest number of days from now for which an agent can submit a time off request"}},"description":"Time Off Request Settings"},"UserScheduleAdherence":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"user":{"description":"The user for whom this status applies","readOnly":true,"$ref":"#/definitions/UserReference"},"managementUnit":{"description":"The management unit to which this user belongs","readOnly":true,"$ref":"#/definitions/ManagementUnit"},"team":{"description":"The team to which this user belongs","readOnly":true,"$ref":"#/definitions/Team"},"scheduledActivityCategory":{"type":"string","description":"Activity for which the user is scheduled","readOnly":true,"enum":["OnQueueWork","Break","Meal","Meeting","OffQueueWork","TimeOff","Training","Unavailable","Unscheduled"],"x-genesys-enum-members":[{"name":"OnQueueWork"},{"name":"Break"},{"name":"Meal"},{"name":"Meeting"},{"name":"OffQueueWork"},{"name":"TimeOff"},{"name":"Training"},{"name":"Unavailable"},{"name":"Unscheduled"}]},"systemPresence":{"type":"string","description":"Actual underlying system presence value","readOnly":true,"enum":["Available","Away","Busy","Offline","Idle","OnQueue","Meal","Training","Meeting","Break"],"x-genesys-enum-members":[{"name":"Available"},{"name":"Away"},{"name":"Busy"},{"name":"Offline"},{"name":"Idle"},{"name":"OnQueue"},{"name":"Meal"},{"name":"Training"},{"name":"Meeting"},{"name":"Break"}]},"organizationSecondaryPresenceId":{"type":"string","description":"Organization Secondary Presence Id.","readOnly":true},"routingStatus":{"type":"string","description":"Actual underlying routing status, used to determine whether a user is actually in adherence when OnQueue","readOnly":true,"enum":["OFF_QUEUE","IDLE","INTERACTING","NOT_RESPONDING","COMMUNICATING"],"x-genesys-enum-members":[{"name":"OFF_QUEUE"},{"name":"IDLE"},{"name":"INTERACTING"},{"name":"NOT_RESPONDING"},{"name":"COMMUNICATING"}]},"actualActivityCategory":{"type":"string","description":"Activity in which the user is actually engaged","readOnly":true,"enum":["OnQueueWork","Break","Meal","Meeting","OffQueueWork","TimeOff","Training","Unavailable","Unscheduled"],"x-genesys-enum-members":[{"name":"OnQueueWork"},{"name":"Break"},{"name":"Meal"},{"name":"Meeting"},{"name":"OffQueueWork"},{"name":"TimeOff"},{"name":"Training"},{"name":"Unavailable"},{"name":"Unscheduled"}]},"isOutOfOffice":{"type":"boolean","description":"Whether the user is marked OutOfOffice","readOnly":true},"adherenceState":{"type":"string","description":"The user's current adherence state","readOnly":true,"enum":["InAdherence","OutOfAdherence","Unscheduled","Unknown","Ignored"],"x-genesys-enum-members":[{"name":"InAdherence"},{"name":"OutOfAdherence"},{"name":"Unscheduled"},{"name":"Unknown"},{"name":"Ignored"}]},"impact":{"type":"string","description":"The impact of the user's current adherenceState","readOnly":true,"enum":["Positive","Negative","Neutral","Unknown"],"x-genesys-enum-members":[{"name":"Positive"},{"name":"Negative"},{"name":"Neutral"},{"name":"Unknown"}]},"timeOfAdherenceChange":{"type":"string","format":"date-time","description":"Time when the user entered the current adherenceState in ISO-8601 format","readOnly":true},"presenceUpdateTime":{"type":"string","format":"date-time","description":"Time when presence was last updated. Used to calculate time in current status. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"activeQueues":{"type":"array","description":"The list of queues to which this user is joined","readOnly":true,"items":{"$ref":"#/definitions/QueueReference"}},"activeQueuesModifiedTime":{"type":"string","format":"date-time","description":"Time when the list of active queues for this user was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"removedFromManagementUnit":{"type":"boolean","description":"For notification purposes. Used to indicate that a user was removed from the management unit","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AsyncConversationQuery":{"type":"object","required":["interval"],"properties":{"conversationFilters":{"type":"array","description":"Filters that target conversation-level data","items":{"$ref":"#/definitions/ConversationDetailQueryFilter"}},"segmentFilters":{"type":"array","description":"Filters that target individual segments within a conversation","items":{"$ref":"#/definitions/SegmentDetailQueryFilter"}},"evaluationFilters":{"type":"array","description":"Filters that target evaluations","items":{"$ref":"#/definitions/EvaluationDetailQueryFilter"}},"mediaEndpointStatFilters":{"type":"array","description":"Filters that target mediaEndpointStats","items":{"$ref":"#/definitions/MediaEndpointStatDetailQueryFilter"}},"surveyFilters":{"type":"array","description":"Filters that target surveys","items":{"$ref":"#/definitions/SurveyDetailQueryFilter"}},"resolutionFilters":{"type":"array","description":"Filters that target resolutions","items":{"$ref":"#/definitions/ResolutionDetailQueryFilter"}},"order":{"type":"string","description":"Sort the result set in ascending/descending order. Default is ascending","enum":["asc","desc"],"x-genesys-enum-members":[{"name":"asc"},{"name":"desc"}]},"orderBy":{"type":"string","description":"Specify which data element within the result set to use for sorting. The options to use as a basis for sorting the results: conversationStart, segmentStart, and segmentEnd. If not specified, the default is conversationStart","enum":["conversationStart","conversationEnd","segmentStart","segmentEnd"],"x-genesys-enum-members":[{"name":"conversationStart"},{"name":"conversationEnd"},{"name":"segmentStart"},{"name":"segmentEnd"}]},"interval":{"type":"string","description":"Specifies the date and time range of data being queried. Results will include all conversations that had activity during the interval. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"limit":{"type":"integer","format":"int32","description":"Specify number of results to be returned"},"startOfDayIntervalMatching":{"type":"boolean","description":"Add a filter to only include conversations that started after the beginning of the interval start date (UTC)"}}},"ConversationDetailQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/ConversationDetailQueryPredicate"}}}},"ConversationDetailQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/ConversationDetailQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/ConversationDetailQueryPredicate"}}}},"ConversationDetailQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"],"x-genesys-enum-members":[{"name":"dimension"},{"name":"property"},{"name":"metric"}]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["conversationEnd","conversationId","conversationStart","divisionId","mediaStatsMinConversationMos","originatingDirection"],"x-genesys-enum-members":[{"name":"conversationEnd"},{"name":"conversationId"},{"name":"conversationStart"},{"name":"divisionId"},{"name":"mediaStatsMinConversationMos"},{"name":"originatingDirection"}]},"metric":{"type":"string","description":"Left hand side for metric predicates","enum":["nBlindTransferred","nCobrowseSessions","nConnected","nConsult","nConsultTransferred","nError","nFlow","nFlowMilestone","nFlowOutcome","nFlowOutcomeFailed","nOffered","nOutbound","nOutboundAbandoned","nOutboundAttempted","nOutboundConnected","nOverSla","nStateTransitionError","nTransferred","oExternalMediaCount","oFlowMilestone","oMediaCount","tAbandon","tAcd","tAcw","tAgentResponseTime","tAlert","tAnswered","tCallback","tCallbackComplete","tContacting","tConversationDuration","tDialing","tFlow","tFlowDisconnect","tFlowExit","tFlowOut","tFlowOutcome","tHandle","tHeld","tHeldComplete","tIvr","tMonitoring","tNotResponding","tShortAbandon","tTalk","tTalkComplete","tUserResponseTime","tVoicemail"],"x-genesys-enum-members":[{"name":"nBlindTransferred"},{"name":"nCobrowseSessions"},{"name":"nConnected"},{"name":"nConsult"},{"name":"nConsultTransferred"},{"name":"nError"},{"name":"nFlow"},{"name":"nFlowMilestone"},{"name":"nFlowOutcome"},{"name":"nFlowOutcomeFailed"},{"name":"nOffered"},{"name":"nOutbound"},{"name":"nOutboundAbandoned"},{"name":"nOutboundAttempted"},{"name":"nOutboundConnected"},{"name":"nOverSla"},{"name":"nStateTransitionError"},{"name":"nTransferred"},{"name":"oExternalMediaCount"},{"name":"oFlowMilestone"},{"name":"oMediaCount"},{"name":"tAbandon"},{"name":"tAcd"},{"name":"tAcw"},{"name":"tAgentResponseTime"},{"name":"tAlert"},{"name":"tAnswered"},{"name":"tCallback"},{"name":"tCallbackComplete"},{"name":"tContacting"},{"name":"tConversationDuration"},{"name":"tDialing"},{"name":"tFlow"},{"name":"tFlowDisconnect"},{"name":"tFlowExit"},{"name":"tFlowOut"},{"name":"tFlowOutcome"},{"name":"tHandle"},{"name":"tHeld"},{"name":"tHeldComplete"},{"name":"tIvr"},{"name":"tMonitoring"},{"name":"tNotResponding"},{"name":"tShortAbandon"},{"name":"tTalk"},{"name":"tTalkComplete"},{"name":"tUserResponseTime"},{"name":"tVoicemail"}]},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"],"x-genesys-enum-members":[{"name":"matches"},{"name":"exists"},{"name":"notExists"}]},"value":{"type":"string","description":"Right hand side for dimension or metric predicates"},"range":{"description":"Right hand side for dimension or metric predicates","$ref":"#/definitions/NumericRange"}}},"EvaluationDetailQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/EvaluationDetailQueryPredicate"}}}},"EvaluationDetailQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/EvaluationDetailQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/EvaluationDetailQueryPredicate"}}}},"EvaluationDetailQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"],"x-genesys-enum-members":[{"name":"dimension"},{"name":"property"},{"name":"metric"}]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["calibrationId","contextId","deleted","evaluationId","evaluatorId","eventTime","formId","formName","queueId","rescored","userId"],"x-genesys-enum-members":[{"name":"calibrationId"},{"name":"contextId"},{"name":"deleted"},{"name":"evaluationId"},{"name":"evaluatorId"},{"name":"eventTime"},{"name":"formId"},{"name":"formName"},{"name":"queueId"},{"name":"rescored"},{"name":"userId"}]},"metric":{"type":"string","description":"Left hand side for metric predicates","enum":["oTotalCriticalScore","oTotalScore"],"x-genesys-enum-members":[{"name":"oTotalCriticalScore"},{"name":"oTotalScore"}]},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"],"x-genesys-enum-members":[{"name":"matches"},{"name":"exists"},{"name":"notExists"}]},"value":{"type":"string","description":"Right hand side for dimension or metric predicates"},"range":{"description":"Right hand side for dimension or metric predicates","$ref":"#/definitions/NumericRange"}}},"MediaEndpointStatDetailQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/MediaEndpointStatDetailQueryPredicate"}}}},"MediaEndpointStatDetailQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/MediaEndpointStatDetailQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/MediaEndpointStatDetailQueryPredicate"}}}},"MediaEndpointStatDetailQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"],"x-genesys-enum-members":[{"name":"dimension"},{"name":"property"},{"name":"metric"}]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["codec","discardedPackets","duplicatePackets","eventTime","invalidPackets","maxLatencyMs","overrunPackets","receivedPackets","underrunPackets"],"x-genesys-enum-members":[{"name":"codec"},{"name":"discardedPackets"},{"name":"duplicatePackets"},{"name":"eventTime"},{"name":"invalidPackets"},{"name":"maxLatencyMs"},{"name":"overrunPackets"},{"name":"receivedPackets"},{"name":"underrunPackets"}]},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"],"x-genesys-enum-members":[{"name":"matches"},{"name":"exists"},{"name":"notExists"}]},"value":{"type":"string","description":"Right hand side for dimension predicates"},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"RecordingJob":{"type":"object","required":["state"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"state":{"type":"string","description":"The current state of the job.","enum":["FULFILLED","PENDING","READY","PROCESSING","CANCELLED","FAILED"],"x-genesys-enum-members":[{"name":"FULFILLED"},{"name":"PENDING"},{"name":"READY"},{"name":"PROCESSING"},{"name":"CANCELLED"},{"name":"FAILED"}]},"recordingJobsQuery":{"description":"Original query of the job.","readOnly":true,"$ref":"#/definitions/RecordingJobsQuery"},"dateCreated":{"type":"string","format":"date-time","description":"Date when the job was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"totalConversations":{"type":"integer","format":"int32","description":"Total number of conversations affected.","readOnly":true},"totalRecordings":{"type":"integer","format":"int32","description":"Total number of recordings affected.","readOnly":true},"totalProcessedRecordings":{"type":"integer","format":"int32","description":"Total number of recordings have been processed.","readOnly":true},"percentProgress":{"type":"integer","format":"int32","description":"Progress in percentage based on the number of recordings","readOnly":true},"errorMessage":{"type":"string","description":"Error occurred during the job execution","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"user":{"description":"Details of the user created the job","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"}}},"RecordingJobsQuery":{"type":"object","required":["action","actionDate","conversationQuery"],"properties":{"action":{"type":"string","description":"Operation to perform bulk task","enum":["DELETE","EXPORT"],"x-genesys-enum-members":[{"name":"DELETE"},{"name":"EXPORT"}]},"actionDate":{"type":"string","format":"date-time","description":"The date when the action will be performed. If the operation will cause the delete date of a recording to be older than the export date, the export date will be adjusted to the delete date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"integrationId":{"type":"string","description":"IntegrationId to Access AWS S3 bucket for bulk recording exports. This field is required and used only for EXPORT action."},"includeScreenRecordings":{"type":"boolean","description":"Include Screen recordings for export action, default value = true "},"conversationQuery":{"description":"Conversation Query. Note: After the recording is created, it might take up to 48 hours for the recording to be included in the submitted job query.","$ref":"#/definitions/AsyncConversationQuery"}}},"ResolutionDetailQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/ResolutionDetailQueryPredicate"}}}},"ResolutionDetailQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/ResolutionDetailQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/ResolutionDetailQueryPredicate"}}}},"ResolutionDetailQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"],"x-genesys-enum-members":[{"name":"dimension"},{"name":"property"},{"name":"metric"}]},"metric":{"type":"string","description":"Left hand side for metric predicates","enum":["nNextContactAvoided"],"x-genesys-enum-members":[{"name":"nNextContactAvoided"}]},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"],"x-genesys-enum-members":[{"name":"matches"},{"name":"exists"},{"name":"notExists"}]},"value":{"type":"string","description":"Right hand side for metric predicates"},"range":{"description":"Right hand side for metric predicates","$ref":"#/definitions/NumericRange"}}},"SegmentDetailQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/SegmentDetailQueryPredicate"}}}},"SegmentDetailQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/SegmentDetailQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/SegmentDetailQueryPredicate"}}}},"SegmentDetailQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"],"x-genesys-enum-members":[{"name":"dimension"},{"name":"property"},{"name":"metric"}]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["addressFrom","addressTo","agentAssistantId","ani","callbackNumber","callbackScheduledTime","conference","destinationConversationId","direction","disconnectType","dnis","edgeId","errorCode","exitReason","externalContactId","externalOrganizationId","flaggedReason","flowId","flowName","flowOutType","flowOutcome","flowOutcomeId","flowOutcomeValue","flowVersion","groupId","journeyActionId","journeyActionMapId","journeyCustomerId","journeyCustomerIdType","journeyCustomerSessionId","mediaCount","mediaType","messageType","monitoredParticipantId","outboundCampaignId","outboundContactId","outboundContactListId","participantName","protocolCallId","provider","purpose","queueId","recording","remote","remoteNameDisplayable","requestedLanguageId","requestedRouting","requestedRoutingSkillId","scoredAgentId","scriptId","segmentEnd","segmentType","sessionDnis","sipResponseCode","subject","teamId","transferTargetAddress","transferTargetName","transferType","usedRouting","userId","wrapUpCode","wrapUpNote"],"x-genesys-enum-members":[{"name":"addressFrom"},{"name":"addressTo"},{"name":"agentAssistantId"},{"name":"ani"},{"name":"callbackNumber"},{"name":"callbackScheduledTime"},{"name":"conference"},{"name":"destinationConversationId"},{"name":"direction"},{"name":"disconnectType"},{"name":"dnis"},{"name":"edgeId"},{"name":"errorCode"},{"name":"exitReason"},{"name":"externalContactId"},{"name":"externalOrganizationId"},{"name":"flaggedReason"},{"name":"flowId"},{"name":"flowName"},{"name":"flowOutType"},{"name":"flowOutcome"},{"name":"flowOutcomeId"},{"name":"flowOutcomeValue"},{"name":"flowVersion"},{"name":"groupId"},{"name":"journeyActionId"},{"name":"journeyActionMapId"},{"name":"journeyCustomerId"},{"name":"journeyCustomerIdType"},{"name":"journeyCustomerSessionId"},{"name":"mediaCount"},{"name":"mediaType"},{"name":"messageType"},{"name":"monitoredParticipantId"},{"name":"outboundCampaignId"},{"name":"outboundContactId"},{"name":"outboundContactListId"},{"name":"participantName"},{"name":"protocolCallId"},{"name":"provider"},{"name":"purpose"},{"name":"queueId"},{"name":"recording"},{"name":"remote"},{"name":"remoteNameDisplayable"},{"name":"requestedLanguageId"},{"name":"requestedRouting"},{"name":"requestedRoutingSkillId"},{"name":"scoredAgentId"},{"name":"scriptId"},{"name":"segmentEnd"},{"name":"segmentType"},{"name":"sessionDnis"},{"name":"sipResponseCode"},{"name":"subject"},{"name":"teamId"},{"name":"transferTargetAddress"},{"name":"transferTargetName"},{"name":"transferType"},{"name":"usedRouting"},{"name":"userId"},{"name":"wrapUpCode"},{"name":"wrapUpNote"}]},"propertyType":{"type":"string","description":"Left hand side for property predicates","enum":["bool","integer","real","date","string","uuid"],"x-genesys-enum-members":[{"name":"bool"},{"name":"integer"},{"name":"real"},{"name":"date"},{"name":"string"},{"name":"uuid"}]},"property":{"type":"string","description":"Left hand side for property predicates"},"metric":{"type":"string","description":"Left hand side for metric predicates","enum":["tSegmentDuration"],"x-genesys-enum-members":[{"name":"tSegmentDuration"}]},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"],"x-genesys-enum-members":[{"name":"matches"},{"name":"exists"},{"name":"notExists"}]},"value":{"type":"string","description":"Right hand side for dimension, metric, or property predicates"},"range":{"description":"Right hand side for dimension, metric, or property predicates","$ref":"#/definitions/NumericRange"}}},"SurveyDetailQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/SurveyDetailQueryPredicate"}}}},"SurveyDetailQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/SurveyDetailQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/SurveyDetailQueryPredicate"}}}},"SurveyDetailQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"],"x-genesys-enum-members":[{"name":"dimension"},{"name":"property"},{"name":"metric"}]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["eventTime","queueId","surveyCompletedDate","surveyFormContextId","surveyFormId","surveyId","surveyPromoterScore","surveyStatus","userId"],"x-genesys-enum-members":[{"name":"eventTime"},{"name":"queueId"},{"name":"surveyCompletedDate"},{"name":"surveyFormContextId"},{"name":"surveyFormId"},{"name":"surveyId"},{"name":"surveyPromoterScore"},{"name":"surveyStatus"},{"name":"userId"}]},"metric":{"type":"string","description":"Left hand side for metric predicates","enum":["oSurveyTotalScore"],"x-genesys-enum-members":[{"name":"oSurveyTotalScore"}]},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"],"x-genesys-enum-members":[{"name":"matches"},{"name":"exists"},{"name":"notExists"}]},"value":{"type":"string","description":"Right hand side for dimension or metric predicates"},"range":{"description":"Right hand side for dimension or metric predicates","$ref":"#/definitions/NumericRange"}}},"ExecuteRecordingJobsQuery":{"type":"object","required":["state"],"properties":{"state":{"type":"string","description":"The desired state for the job to be set to.","enum":["PROCESSING"],"x-genesys-enum-members":[{"name":"PROCESSING"}]}}},"MessagingTemplate":{"type":"object","properties":{"whatsApp":{"description":"Defines a messaging template for a WhatsApp messaging channel","$ref":"#/definitions/WhatsAppDefinition"}},"description":"The messaging template identifies a structured message templates supported by a messaging channel."},"Response":{"type":"object","required":["libraries","texts"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"version":{"type":"integer","format":"int32","description":"Version number required for updates."},"libraries":{"type":"array","description":"One or more libraries response is associated with.","items":{"$ref":"#/definitions/DomainEntityRef"}},"texts":{"type":"array","description":"One or more texts associated with the response.","items":{"$ref":"#/definitions/ResponseText"}},"createdBy":{"description":"User that created the response","readOnly":true,"$ref":"#/definitions/User"},"dateCreated":{"type":"string","format":"date-time","description":"The date and time the response was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"interactionType":{"type":"string","description":"The interaction type for this response.","enum":["chat","email","twitter"]},"substitutions":{"type":"array","description":"Details about any text substitutions used in the texts for this response.","items":{"$ref":"#/definitions/ResponseSubstitution"}},"substitutionsSchema":{"description":"Metadata about the text substitutions in json schema format.","$ref":"#/definitions/JsonSchemaDocument"},"responseType":{"type":"string","description":"The response type represented by the response.","enum":["MessagingTemplate","CampaignSmsTemplate"],"x-genesys-enum-members":[{"name":"MessagingTemplate","description":"Use MessagingTemplate to provide channel specific template. WhatsApp messaging template is supported currently"},{"name":"CampaignSmsTemplate","description":"Use CampaignSmsTemplate to create canned responses specific to sms campaigns. Only text/plain content type is allowed"}]},"messagingTemplate":{"description":"An optional messaging template definition for responseType.MessagingTemplate.","$ref":"#/definitions/MessagingTemplate"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Contains information about a response."},"ResponseSubstitution":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Response substitution identifier."},"description":{"type":"string","description":"Response substitution description."},"defaultValue":{"type":"string","description":"Response substitution default value."}},"description":"Contains information about the substitutions associated with a response."},"ResponseText":{"type":"object","required":["content"],"properties":{"content":{"type":"string","description":"Response text content."},"contentType":{"type":"string","description":"Response text content type.","enum":["text/plain","text/html"]}},"description":"Contains information about the text associated with a response."},"WhatsAppDefinition":{"type":"object","required":["language","name","namespace"],"properties":{"name":{"type":"string","description":"The messaging template name."},"namespace":{"type":"string","description":"The messaging template namespace."},"language":{"type":"string","description":"The messaging template language configured for this template. This is a WhatsApp specific value. For example, 'en_US'"}},"description":"A WhatsApp messaging template definition as defined in the WhatsApp Business Manager"},"FlowVersionEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/FlowVersion"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DomainOrganizationRole":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"defaultRoleId":{"type":"string"},"permissions":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"unusedPermissions":{"type":"array","description":"A collection of the permissions the role is not using","readOnly":true,"uniqueItems":true,"items":{"type":"string"}},"permissionPolicies":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/DomainPermissionPolicy"}},"userCount":{"type":"integer","format":"int32"},"roleNeedsUpdate":{"type":"boolean","description":"Optional unless patch operation."},"base":{"type":"boolean"},"default":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DomainPermissionPolicy":{"type":"object","properties":{"domain":{"type":"string"},"entityName":{"type":"string"},"policyName":{"type":"string"},"policyDescription":{"type":"string"},"actionSet":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"namedResources":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"allowConditions":{"type":"boolean"},"resourceConditionNode":{"$ref":"#/definitions/DomainResourceConditionNode"}}},"DomainResourceConditionNode":{"type":"object","properties":{"variableName":{"type":"string"},"operator":{"type":"string","enum":["EQ","IN","GE","GT","LE","LT"],"x-genesys-enum-members":[{"name":"EQ"},{"name":"IN"},{"name":"GE"},{"name":"GT"},{"name":"LE"},{"name":"LT"}]},"operands":{"type":"array","items":{"$ref":"#/definitions/DomainResourceConditionValue"}},"conjunction":{"type":"string","enum":["AND","OR"],"x-genesys-enum-members":[{"name":"AND"},{"name":"OR"}]},"terms":{"type":"array","items":{"$ref":"#/definitions/DomainResourceConditionNode"}}}},"DomainResourceConditionValue":{"type":"object","properties":{"user":{"$ref":"#/definitions/User"},"queue":{"$ref":"#/definitions/Queue"},"value":{"type":"string"},"type":{"type":"string","enum":["SCALAR","VARIABLE","USER","QUEUE"],"x-genesys-enum-members":[{"name":"SCALAR"},{"name":"VARIABLE"},{"name":"USER"},{"name":"QUEUE"}]}}},"OrganizationRoleEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DomainOrganizationRole"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AuditQueryResponse":{"type":"object"},"Facet":{"type":"object","required":["name","type"],"properties":{"name":{"type":"string","description":"The name of the field on which to facet."},"type":{"type":"string","description":"The type of the facet, DATE or STRING."}}},"Filter":{"type":"object","required":["name","operator","type","values"],"properties":{"name":{"type":"string","description":"The name of the field by which to filter."},"type":{"type":"string","description":"The type of the filter, DATE or STRING."},"operator":{"type":"string","description":"The operation that the filter performs."},"values":{"type":"array","description":"The values to make the filter comparison against.","items":{"type":"string"}}}},"TrusteeAuditQueryRequest":{"type":"object","required":["trusteeOrganizationIds","trusteeUserIds"],"properties":{"trusteeOrganizationIds":{"type":"array","description":"Limit returned audits to these trustee organizationIds.","items":{"type":"string"}},"trusteeUserIds":{"type":"array","description":"Limit returned audits to these trustee userIds.","items":{"type":"string"}},"startDate":{"type":"string","format":"date-time","description":"Starting date/time for the audit search. ISO-8601 formatted date-time, UTC."},"endDate":{"type":"string","format":"date-time","description":"Ending date/time for the audit search. ISO-8601 formatted date-time, UTC."},"queryPhrase":{"type":"string","description":"Word or phrase to look for in audit bodies."},"facets":{"type":"array","description":"Facet information to be returned with the query results.","items":{"$ref":"#/definitions/Facet"}},"filters":{"type":"array","description":"Additional custom filters to be applied to the query.","items":{"$ref":"#/definitions/Filter"}}}},"WebChatConfig":{"type":"object","properties":{"webChatSkin":{"type":"string","description":"css class to be applied to the web chat widget.","enum":["basic","modern-caret-skin"],"x-genesys-enum-members":[{"name":"basic"},{"name":"modern-caret-skin"}]}}},"WebChatDeployment":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"authenticationRequired":{"type":"boolean"},"authenticationUrl":{"type":"string","description":"URL for third party service authenticating web chat clients. See https://github.com/MyPureCloud/authenticated-web-chat-server-examples"},"disabled":{"type":"boolean"},"webChatConfig":{"$ref":"#/definitions/WebChatConfig"},"allowedDomains":{"type":"array","items":{"type":"string"}},"flow":{"description":"The URI of the Inbound Chat Flow to run when new chats are initiated under this Deployment.","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ScorableSurvey":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"surveyForm":{"description":"Survey form used for this survey.","$ref":"#/definitions/SurveyForm"},"status":{"type":"string","enum":["Pending","Sent","InProgress","Finished","OptOut","Error","Expired"],"x-genesys-enum-members":[{"name":"Pending"},{"name":"Sent"},{"name":"InProgress"},{"name":"Finished"},{"name":"OptOut"},{"name":"Error"},{"name":"Expired"}]},"answers":{"$ref":"#/definitions/SurveyScoringSet"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SurveyQuestionGroupScore":{"type":"object","properties":{"questionGroupId":{"type":"string"},"totalScore":{"type":"number","format":"float"},"maxTotalScore":{"type":"number","format":"float"},"markedNA":{"type":"boolean"},"questionScores":{"type":"array","items":{"$ref":"#/definitions/SurveyQuestionScore"}}}},"SurveyQuestionScore":{"type":"object","properties":{"questionId":{"type":"string"},"answerId":{"type":"string"},"score":{"type":"integer","format":"int32"},"markedNA":{"type":"boolean"},"npsScore":{"type":"integer","format":"int32"},"npsTextAnswer":{"type":"string"},"freeTextAnswer":{"type":"string"}}},"SurveyScoringSet":{"type":"object","properties":{"totalScore":{"type":"number","format":"float"},"npsScore":{"type":"integer","format":"int32"},"questionGroupScores":{"type":"array","items":{"$ref":"#/definitions/SurveyQuestionGroupScore"}}}},"Library":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The library name."},"version":{"type":"integer","format":"int32","description":"Current version for this resource.","readOnly":true},"createdBy":{"description":"User that created the library.","readOnly":true,"$ref":"#/definitions/User"},"dateCreated":{"type":"string","format":"date-time","description":"The date and time the response was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"responseType":{"type":"string","description":"This value is deprecated. Responses representing message templates may be added to any library.","enum":["MessagingTemplate","CampaignSmsTemplate"],"x-genesys-enum-members":[{"name":"MessagingTemplate","description":"Use MessagingTemplate to provide channel specific template. WhatsApp messaging template is supported currently"},{"name":"CampaignSmsTemplate","description":"Use CampaignSmsTemplate to create canned responses specific to sms campaigns. Only text/plain content type is allowed"}]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LexBotEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/LexBot"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"PublishForm":{"type":"object","required":["id","published"],"properties":{"published":{"type":"boolean","description":"Is this form published"},"id":{"type":"string","description":"Unique Id for this version of this form"}}},"EvaluationFormEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/EvaluationForm"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ReportingExportJobRequest":{"type":"object","required":["exportFormat","filter","interval","locale","name","period","timeZone","viewType"],"properties":{"name":{"type":"string","description":"The user supplied name of the export request"},"timeZone":{"type":"string","description":"The requested timezone of the exported data. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"exportFormat":{"type":"string","description":"The requested format of the exported data","enum":["CSV","PDF"],"x-genesys-enum-members":[{"name":"CSV"},{"name":"PDF"}]},"interval":{"type":"string","description":"The time period used to limit the the exported data. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"period":{"type":"string","description":"The Period of the request in which to break down the intervals. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"viewType":{"type":"string","description":"The type of view export job to be created","enum":["QUEUE_PERFORMANCE_SUMMARY_VIEW","QUEUE_PERFORMANCE_DETAIL_VIEW","INTERACTION_SEARCH_VIEW","AGENT_PERFORMANCE_SUMMARY_VIEW","AGENT_PERFORMANCE_DETAIL_VIEW","AGENT_STATUS_SUMMARY_VIEW","AGENT_STATUS_DETAIL_VIEW","AGENT_EVALUATION_SUMMARY_VIEW","AGENT_EVALUATION_DETAIL_VIEW","AGENT_QUEUE_DETAIL_VIEW","AGENT_INTERACTION_DETAIL_VIEW","ABANDON_INSIGHTS_VIEW","SKILLS_PERFORMANCE_VIEW","SURVEY_FORM_PERFORMANCE_SUMMARY_VIEW","SURVEY_FORM_PERFORMANCE_DETAIL_VIEW","DNIS_PERFORMANCE_SUMMARY_VIEW","DNIS_PERFORMANCE_DETAIL_VIEW","WRAP_UP_PERFORMANCE_SUMMARY_VIEW","AGENT_WRAP_UP_PERFORMANCE_DETAIL_VIEW","QUEUE_ACTIVITY_SUMMARY_VIEW","QUEUE_ACTIVITY_DETAIL_VIEW","AGENT_QUEUE_ACTIVITY_SUMMARY_VIEW","QUEUE_AGENT_DETAIL_VIEW","QUEUE_INTERACTION_DETAIL_VIEW","AGENT_SCHEDULE_DETAIL_VIEW","IVR_PERFORMANCE_SUMMARY_VIEW","IVR_PERFORMANCE_DETAIL_VIEW","ANSWER_INSIGHTS_VIEW","HANDLE_INSIGHTS_VIEW","TALK_INSIGHTS_VIEW","HOLD_INSIGHTS_VIEW","ACW_INSIGHTS_VIEW","WAIT_INSIGHTS_VIEW","AGENT_WRAP_UP_PERFORMANCE_INTERVAL_DETAIL_VIEW","FLOW_OUTCOME_SUMMARY_VIEW","FLOW_OUTCOME_PERFORMANCE_DETAIL_VIEW","FLOW_OUTCOME_PERFORMANCE_INTERVAL_DETAIL_VIEW","FLOW_DESTINATION_SUMMARY_VIEW","FLOW_DESTINATION_DETAIL_VIEW","API_USAGE_VIEW","SCHEDULED_CALLBACKS_VIEW","CONTENT_SEARCH_VIEW","LANDING_PAGE","DASHBOARD_SUMMARY","DASHBOARD_DETAIL","JOURNEY_ACTION_MAP_SUMMARY_VIEW","JOURNEY_OUTCOME_SUMMARY_VIEW","JOURNEY_SEGMENT_SUMMARY_VIEW","AGENT_DEVELOPMENT_DETAIL_VIEW","AGENT_DEVELOPMENT_DETAIL_ME_VIEW","AGENT_DEVELOPMENT_SUMMARY_VIEW","AGENT_PERFORMANCE_ME_VIEW","AGENT_STATUS_ME_VIEW","AGENT_EVALUATION_ME_VIEW"],"x-genesys-enum-members":[{"name":"QUEUE_PERFORMANCE_SUMMARY_VIEW"},{"name":"QUEUE_PERFORMANCE_DETAIL_VIEW"},{"name":"INTERACTION_SEARCH_VIEW"},{"name":"AGENT_PERFORMANCE_SUMMARY_VIEW"},{"name":"AGENT_PERFORMANCE_DETAIL_VIEW"},{"name":"AGENT_STATUS_SUMMARY_VIEW"},{"name":"AGENT_STATUS_DETAIL_VIEW"},{"name":"AGENT_EVALUATION_SUMMARY_VIEW"},{"name":"AGENT_EVALUATION_DETAIL_VIEW"},{"name":"AGENT_QUEUE_DETAIL_VIEW"},{"name":"AGENT_INTERACTION_DETAIL_VIEW"},{"name":"ABANDON_INSIGHTS_VIEW"},{"name":"SKILLS_PERFORMANCE_VIEW"},{"name":"SURVEY_FORM_PERFORMANCE_SUMMARY_VIEW"},{"name":"SURVEY_FORM_PERFORMANCE_DETAIL_VIEW"},{"name":"DNIS_PERFORMANCE_SUMMARY_VIEW"},{"name":"DNIS_PERFORMANCE_DETAIL_VIEW"},{"name":"WRAP_UP_PERFORMANCE_SUMMARY_VIEW"},{"name":"AGENT_WRAP_UP_PERFORMANCE_DETAIL_VIEW"},{"name":"QUEUE_ACTIVITY_SUMMARY_VIEW"},{"name":"QUEUE_ACTIVITY_DETAIL_VIEW"},{"name":"AGENT_QUEUE_ACTIVITY_SUMMARY_VIEW"},{"name":"QUEUE_AGENT_DETAIL_VIEW"},{"name":"QUEUE_INTERACTION_DETAIL_VIEW"},{"name":"AGENT_SCHEDULE_DETAIL_VIEW"},{"name":"IVR_PERFORMANCE_SUMMARY_VIEW"},{"name":"IVR_PERFORMANCE_DETAIL_VIEW"},{"name":"ANSWER_INSIGHTS_VIEW"},{"name":"HANDLE_INSIGHTS_VIEW"},{"name":"TALK_INSIGHTS_VIEW"},{"name":"HOLD_INSIGHTS_VIEW"},{"name":"ACW_INSIGHTS_VIEW"},{"name":"WAIT_INSIGHTS_VIEW"},{"name":"AGENT_WRAP_UP_PERFORMANCE_INTERVAL_DETAIL_VIEW"},{"name":"FLOW_OUTCOME_SUMMARY_VIEW"},{"name":"FLOW_OUTCOME_PERFORMANCE_DETAIL_VIEW"},{"name":"FLOW_OUTCOME_PERFORMANCE_INTERVAL_DETAIL_VIEW"},{"name":"FLOW_DESTINATION_SUMMARY_VIEW"},{"name":"FLOW_DESTINATION_DETAIL_VIEW"},{"name":"API_USAGE_VIEW"},{"name":"SCHEDULED_CALLBACKS_VIEW"},{"name":"CONTENT_SEARCH_VIEW"},{"name":"LANDING_PAGE"},{"name":"DASHBOARD_SUMMARY"},{"name":"DASHBOARD_DETAIL"},{"name":"JOURNEY_ACTION_MAP_SUMMARY_VIEW"},{"name":"JOURNEY_OUTCOME_SUMMARY_VIEW"},{"name":"JOURNEY_SEGMENT_SUMMARY_VIEW"},{"name":"AGENT_DEVELOPMENT_DETAIL_VIEW"},{"name":"AGENT_DEVELOPMENT_DETAIL_ME_VIEW"},{"name":"AGENT_DEVELOPMENT_SUMMARY_VIEW"},{"name":"AGENT_PERFORMANCE_ME_VIEW"},{"name":"AGENT_STATUS_ME_VIEW"},{"name":"AGENT_EVALUATION_ME_VIEW"}]},"filter":{"description":"Filters to apply to create the view","$ref":"#/definitions/ViewFilter"},"read":{"type":"boolean","description":"Indicates if the request has been marked as read"},"locale":{"type":"string","description":"The locale use for localization of the exported data, i.e. en-us, es-mx "},"hasFormatDurations":{"type":"boolean","description":"Indicates if durations are formatted in hh:mm:ss format instead of ms"},"hasSplitFilters":{"type":"boolean","description":"Indicates if filters will be split in aggregate detail exports"},"excludeEmptyRows":{"type":"boolean","description":"Excludes empty rows from the exports"},"hasSplitByMedia":{"type":"boolean","description":"Indicates if media type will be split in aggregate detail exports"},"hasSummaryRow":{"type":"boolean","description":"Indicates if summary row needs to be present in exports"},"csvDelimiter":{"type":"string","description":"The user supplied csv delimiter string value either of type 'comma' or 'semicolon' permitted for the export request","enum":["SEMICOLON","COMMA"],"x-genesys-enum-members":[{"name":"SEMICOLON"},{"name":"COMMA"}]},"selectedColumns":{"type":"array","description":"The list of ordered selected columns from the export view by the user","items":{"$ref":"#/definitions/SelectedColumns"}},"hasCustomParticipantAttributes":{"type":"boolean","description":"Indicates if custom participant attributes will be exported"},"recipientEmails":{"type":"array","description":"The list of email recipients for the exports","items":{"type":"string"}}}},"Metabase":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string"},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"type":{"type":"string","enum":["EXTERNAL","EXTERNAL_PCV","EXTERNAL_PCV_AWS","EXTERNAL_BYOC_CARRIER","EXTERNAL_BYOC_PBX","STATION_CDM","STATION_CDM_WEBRTC","STATION","TIE","TIE_DIRECT","TIE_INDIRECT","TIE_CLOUD_PROXY"],"x-genesys-enum-members":[{"name":"EXTERNAL"},{"name":"EXTERNAL_PCV"},{"name":"EXTERNAL_PCV_AWS"},{"name":"EXTERNAL_BYOC_CARRIER"},{"name":"EXTERNAL_BYOC_PBX"},{"name":"STATION_CDM"},{"name":"STATION_CDM_WEBRTC"},{"name":"STATION"},{"name":"TIE"},{"name":"TIE_DIRECT"},{"name":"TIE_INDIRECT"},{"name":"TIE_CLOUD_PROXY"}]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TrunkMetabaseEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Metabase"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CoachingAppointmentResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of coaching appointment","readOnly":true},"description":{"type":"string","description":"The description of coaching appointment","readOnly":true},"dateStart":{"type":"string","format":"date-time","description":"The date/time the coaching appointment starts. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"lengthInMinutes":{"type":"integer","format":"int32","description":"The duration of coaching appointment in minutes","readOnly":true},"status":{"type":"string","description":"The status of coaching appointment","readOnly":true,"enum":["Scheduled","InProgress","Completed","InvalidSchedule"],"x-genesys-enum-members":[{"name":"Scheduled"},{"name":"InProgress"},{"name":"Completed"},{"name":"InvalidSchedule"}]},"facilitator":{"description":"The facilitator of coaching appointment","readOnly":true,"$ref":"#/definitions/UserReference"},"attendees":{"type":"array","description":"The list of attendees attending the coaching","readOnly":true,"uniqueItems":true,"items":{"$ref":"#/definitions/UserReference"}},"createdBy":{"description":"The user who created the coaching appointment","readOnly":true,"$ref":"#/definitions/UserReference"},"dateCreated":{"type":"string","format":"date-time","description":"The date/time the coaching appointment was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"description":"The last user to modify the coaching appointment","readOnly":true,"$ref":"#/definitions/UserReference"},"dateModified":{"type":"string","format":"date-time","description":"The date/time the coaching appointment was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"conversations":{"type":"array","description":"The list of conversations associated with coaching appointment.","readOnly":true,"uniqueItems":true,"items":{"$ref":"#/definitions/ConversationReference"}},"documents":{"type":"array","description":"The list of documents associated with coaching appointment.","readOnly":true,"uniqueItems":true,"items":{"$ref":"#/definitions/DocumentReference"}},"isOverdue":{"type":"boolean","description":"Whether the appointment is overdue.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Coaching appointment response"},"CoachingNotification":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the appointment for this notification.","readOnly":true},"markedAsRead":{"type":"boolean","description":"Indicates if notification is read or unread"},"actionType":{"type":"string","description":"Action causing the notification.","readOnly":true,"enum":["Create","Update","Delete","StatusChange"],"x-genesys-enum-members":[{"name":"Create"},{"name":"Update"},{"name":"Delete"},{"name":"StatusChange"}]},"relationship":{"type":"string","description":"The relationship of this user to this notification's appointment","readOnly":true,"enum":["Attendee","Creator","Facilitator"],"x-genesys-enum-members":[{"name":"Attendee"},{"name":"Creator"},{"name":"Facilitator"}]},"dateStart":{"type":"string","format":"date-time","description":"The start time of the appointment relating to this notification. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"lengthInMinutes":{"type":"integer","format":"int32","description":"The duration of the appointment on this notification","readOnly":true},"status":{"type":"string","description":"The status of the appointment for this notification","readOnly":true,"enum":["Scheduled","InProgress","Completed","InvalidSchedule"],"x-genesys-enum-members":[{"name":"Scheduled"},{"name":"InProgress"},{"name":"Completed"},{"name":"InvalidSchedule"}]},"user":{"description":"The user of this notification","readOnly":true,"$ref":"#/definitions/UserReference"},"appointment":{"description":"The appointment","readOnly":true,"$ref":"#/definitions/CoachingAppointmentResponse"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CoachingNotificationList":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CoachingNotification"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ConversationReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DocumentReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WfmBusinessUnitReference":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the business unit"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WfmScheduleReference":{"type":"object","required":["businessUnit","id","weekDate"],"properties":{"id":{"type":"string","description":"The ID of the WFM schedule"},"businessUnit":{"description":"A reference to a Workforce Management Business Unit","$ref":"#/definitions/WfmBusinessUnitReference"},"weekDate":{"type":"string","format":"date","description":"The start week date for this schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FaxSummary":{"type":"object","properties":{"readCount":{"type":"integer","format":"int32"},"unreadCount":{"type":"integer","format":"int32"},"totalCount":{"type":"integer","format":"int32"}}},"ArrayNode":{"type":"object","properties":{"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"],"x-genesys-enum-members":[{"name":"ARRAY"},{"name":"BINARY"},{"name":"BOOLEAN"},{"name":"MISSING"},{"name":"NULL"},{"name":"NUMBER"},{"name":"OBJECT"},{"name":"POJO"},{"name":"STRING"}]},"float":{"type":"boolean"},"number":{"type":"boolean"},"boolean":{"type":"boolean"},"object":{"type":"boolean"},"valueNode":{"type":"boolean"},"containerNode":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"pojo":{"type":"boolean"},"integralNumber":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean"},"binary":{"type":"boolean"},"missingNode":{"type":"boolean"},"array":{"type":"boolean"},"null":{"type":"boolean"}}},"JsonNodeSearchResponse":{"type":"object","required":["pageCount","pageNumber","pageSize","results","total","types"],"properties":{"total":{"type":"integer","format":"int64","description":"The total number of results found"},"pageCount":{"type":"integer","format":"int32","description":"The total number of pages"},"pageSize":{"type":"integer","format":"int32","description":"The current page size"},"pageNumber":{"type":"integer","format":"int32","description":"The current page number"},"previousPage":{"type":"string","description":"Q64 value for the previous page of results"},"currentPage":{"type":"string","description":"Q64 value for the current page of results"},"nextPage":{"type":"string","description":"Q64 value for the next page of results"},"types":{"type":"array","description":"Resource types the search was performed against","items":{"type":"string"}},"results":{"description":"Search results","$ref":"#/definitions/ArrayNode"},"aggregations":{"$ref":"#/definitions/ArrayNode"}}},"SuggestSearchCriteria":{"type":"object","properties":{"endValue":{"type":"string","description":"The end value of the range. This field is used for range search types."},"values":{"type":"array","description":"A list of values for the search to match against","items":{"type":"string"}},"startValue":{"type":"string","description":"The start value of the range. This field is used for range search types."},"fields":{"type":"array","description":"Field names to search against","items":{"type":"string"}},"value":{"type":"string","description":"A value for the search to match against"},"operator":{"type":"string","description":"How to apply this search criteria against other criteria","enum":["AND","OR","NOT"],"x-genesys-enum-members":[{"name":"AND"},{"name":"OR"},{"name":"NOT"}]},"group":{"type":"array","description":"Groups multiple conditions","items":{"$ref":"#/definitions/SuggestSearchCriteria"}},"dateFormat":{"type":"string","description":"Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."}}},"SuggestSearchRequest":{"type":"object","required":["query","types"],"properties":{"expand":{"type":"array","description":"Provides more details about a specified resource","items":{"type":"string"}},"types":{"type":"array","description":"Resource domain type to search","items":{"type":"string"}},"query":{"type":"array","description":"Suggest query","items":{"$ref":"#/definitions/SuggestSearchCriteria"}}}},"SearchAggregation":{"type":"object","properties":{"field":{"type":"string","description":"The field used for aggregation"},"name":{"type":"string","description":"The name of the aggregation. The response aggregation uses this name."},"type":{"type":"string","description":"The type of aggregation to perform","enum":["COUNT","SUM","AVERAGE","TERM","CONTAINS","STARTS_WITH","ENDS_WITH"],"x-genesys-enum-members":[{"name":"COUNT"},{"name":"SUM"},{"name":"AVERAGE"},{"name":"TERM"},{"name":"CONTAINS"},{"name":"STARTS_WITH"},{"name":"ENDS_WITH"}]},"value":{"type":"string","description":"A value to use for aggregation"},"size":{"type":"integer","format":"int32","description":"The number aggregations results to return out of the entire result set"},"order":{"type":"array","description":"The order in which aggregation results are sorted","items":{"type":"string","enum":["VALUE_DESC","VALUE_ASC","COUNT_DESC","COUNT_ASC"],"x-genesys-enum-members":[{"name":"VALUE_DESC"},{"name":"VALUE_ASC"},{"name":"COUNT_DESC"},{"name":"COUNT_ASC"}]}}}},"SearchCriteria":{"type":"object","properties":{"endValue":{"type":"string","description":"The end value of the range. This field is used for range search types."},"values":{"type":"array","description":"A list of values for the search to match against","items":{"type":"string"}},"startValue":{"type":"string","description":"The start value of the range. This field is used for range search types."},"fields":{"type":"array","description":"Field names to search against","items":{"type":"string"}},"value":{"type":"string","description":"A value for the search to match against"},"operator":{"type":"string","description":"How to apply this search criteria against other criteria","enum":["AND","OR","NOT"],"x-genesys-enum-members":[{"name":"AND"},{"name":"OR"},{"name":"NOT"}]},"group":{"type":"array","description":"Groups multiple conditions","items":{"$ref":"#/definitions/SearchCriteria"}},"dateFormat":{"type":"string","description":"Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."},"type":{"type":"string","enum":["EXACT","CONTAINS","STARTS_WITH","REQUIRED_FIELDS","RANGE","DATE_RANGE","LESS_THAN","LESS_THAN_EQUAL_TO","GREATER_THAN","GREATER_THAN_EQUAL_TO","SIMPLE","TERM","TERMS","QUERY_STRING","MATCH_ALL"],"x-genesys-enum-members":[{"name":"EXACT"},{"name":"CONTAINS"},{"name":"STARTS_WITH"},{"name":"REQUIRED_FIELDS"},{"name":"RANGE"},{"name":"DATE_RANGE"},{"name":"LESS_THAN"},{"name":"LESS_THAN_EQUAL_TO"},{"name":"GREATER_THAN"},{"name":"GREATER_THAN_EQUAL_TO"},{"name":"SIMPLE"},{"name":"TERM"},{"name":"TERMS"},{"name":"QUERY_STRING"},{"name":"MATCH_ALL"}]}}},"SearchRequest":{"type":"object","required":["types"],"properties":{"sortOrder":{"type":"string","description":"The sort order for results","enum":["ASC","DESC","SCORE"],"x-genesys-enum-members":[{"name":"ASC"},{"name":"DESC"},{"name":"SCORE"}]},"sortBy":{"type":"string","description":"The field in the resource that you want to sort the results by"},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"},"pageNumber":{"type":"integer","format":"int32","description":"The page of resources you want to retrieve"},"sort":{"type":"array","description":"Multi-value sort order, list of multiple sort values","items":{"$ref":"#/definitions/SearchSort"}},"returnFields":{"type":"array","description":"A List of strings. Possible values are any field in the resource you are searching on. The other option is to use ALL_FIELDS, when this is provided all fields in the resource will be returned in the search results.","items":{"type":"string"}},"expand":{"type":"array","description":"Provides more details about a specified resource","items":{"type":"string"}},"types":{"type":"array","description":"Resource domain type to search","items":{"type":"string"}},"query":{"type":"array","description":"The search criteria","items":{"$ref":"#/definitions/SearchCriteria"}},"aggregations":{"type":"array","description":"Aggregation criteria","items":{"$ref":"#/definitions/SearchAggregation"}}}},"TrunkBase":{"type":"object","required":["name","trunkMetabase","trunkType"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"trunkMetabase":{"description":"The meta-base this trunk is based on.","$ref":"#/definitions/DomainEntityRef"},"properties":{"type":"object","additionalProperties":{"type":"object"}},"trunkType":{"type":"string","description":"The type of this trunk base.","enum":["EXTERNAL","PHONE","EDGE"],"x-genesys-enum-members":[{"name":"EXTERNAL"},{"name":"PHONE"},{"name":"EDGE"}]},"managed":{"type":"boolean","description":"Is this trunk being managed remotely. This property is synchronized with the managed property of the Edge Group to which it is assigned."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CallForwarding":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"user":{"$ref":"#/definitions/User"},"enabled":{"type":"boolean","description":"Whether or not CallForwarding is enabled"},"phoneNumber":{"type":"string","description":"This property is deprecated. Please use the calls property"},"calls":{"type":"array","description":"An ordered list of CallRoutes to be executed when CallForwarding is enabled","items":{"$ref":"#/definitions/CallRoute"}},"voicemail":{"type":"string","description":"The type of voicemail to use with the callForwarding configuration","enum":["PURECLOUD","LASTCALL","NONE"],"x-genesys-enum-members":[{"name":"PURECLOUD"},{"name":"LASTCALL"},{"name":"NONE"}]},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CallRoute":{"type":"object","properties":{"targets":{"type":"array","description":"A list of CallTargets to be called when the CallRoute is executed","items":{"$ref":"#/definitions/CallTarget"}}}},"CallTarget":{"type":"object","properties":{"type":{"type":"string","description":"The type of call","enum":["STATION","PHONENUMBER"],"x-genesys-enum-members":[{"name":"STATION"},{"name":"PHONENUMBER"}]},"value":{"type":"string","description":"The id of the station or an E.164 formatted phone number"}}},"UserDevice":{"type":"object","required":["acceptNotifications","deviceToken","make","model","notificationId","type"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"deviceToken":{"type":"string","description":"device token sent by mobile clients."},"notificationId":{"type":"string","description":"notification id of the device."},"make":{"type":"string","description":"make of the device."},"model":{"type":"string","description":"Device model"},"acceptNotifications":{"type":"boolean","description":"if the device accepts notifications"},"type":{"type":"string","description":"type of the device; ios or android","enum":["android","ios"],"x-genesys-enum-members":[{"name":"android"},{"name":"ios"}]},"sessionHash":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DirectoryUserDevicesListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UserDevice"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"VoicemailMediaInfo":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"mediaFileUri":{"type":"string","format":"uri"},"mediaImageUri":{"type":"string","format":"uri"},"waveformData":{"type":"array","items":{"type":"number","format":"float"}}}},"CallRecord":{"type":"object","properties":{"lastAttempt":{"type":"string","format":"date-time","description":"Timestamp of the last attempt to reach this number. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"lastResult":{"type":"string","description":"Result of the last attempt to reach this number","readOnly":true}}},"ContactColumnTimeZone":{"type":"object","properties":{"timeZone":{"type":"string","description":"Time zone that the column matched to. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"columnType":{"type":"string","description":"Column Type will be either PHONE or ZIP","readOnly":true,"enum":["PHONE","ZIP"],"x-genesys-enum-members":[{"name":"PHONE"},{"name":"ZIP"}]}}},"DialerContact":{"type":"object","required":["contactListId","data"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"contactListId":{"type":"string","description":"The identifier of the contact list containing this contact."},"data":{"type":"object","description":"An ordered map of the contact's columns and corresponding values.","additionalProperties":{"type":"object"}},"callRecords":{"type":"object","description":"A map of call records for the contact phone columns.","readOnly":true,"additionalProperties":{"$ref":"#/definitions/CallRecord"}},"callable":{"type":"boolean","description":"Indicates whether or not the contact can be called."},"phoneNumberStatus":{"type":"object","description":"A map of phone number columns to PhoneNumberStatuses, which indicate if the phone number is callable or not.","additionalProperties":{"$ref":"#/definitions/PhoneNumberStatus"}},"contactColumnTimeZones":{"type":"object","description":"Map containing data about the timezone the contact is mapped to. This will only be populated if the contact list has automatic timezone mapping turned on. The key is the column name. The value is the timezone it mapped to and the type of column: Phone or Zip","readOnly":true,"additionalProperties":{"$ref":"#/definitions/ContactColumnTimeZone"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"MessageEvaluation":{"type":"object","properties":{"contactColumn":{"type":"string"},"contactAddress":{"type":"string"},"wrapupCodeId":{"type":"string"},"timestamp":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"PhoneNumberStatus":{"type":"object","properties":{"callable":{"type":"boolean","description":"Indicates whether or not a phone number is callable."}}},"WritableDialerContact":{"type":"object","required":["contactListId","data"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"contactListId":{"type":"string","description":"The identifier of the contact list containing this contact."},"data":{"type":"object","description":"An ordered map of the contact's columns and corresponding values.","additionalProperties":{"type":"object"}},"callable":{"type":"boolean","description":"Indicates whether or not the contact can be called."},"phoneNumberStatus":{"type":"object","description":"A map of phone number columns to PhoneNumberStatuses, which indicate if the phone number is callable or not.","additionalProperties":{"$ref":"#/definitions/PhoneNumberStatus"}}}},"CursorRelationshipListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Relationship"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"Relationship":{"type":"object","required":["externalOrganization","relationship","user"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"user":{"description":"The user associated with the external organization","$ref":"#/definitions/User"},"externalOrganization":{"description":"The external organization this relationship is attached to","$ref":"#/definitions/ExternalOrganization"},"relationship":{"type":"string","description":"The relationship or role of the user to this external organization.Examples: Account Manager, Sales Engineer, Implementation Consultant"},"externalDataSources":{"type":"array","description":"Links to the sources of data (e.g. one source might be a CRM) that contributed data to this record. Read-only, and only populated when requested via expand param.","readOnly":true,"items":{"$ref":"#/definitions/ExternalDataSource"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TrustorEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Trustor"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"BuForecastGenerationPlanningGroupResult":{"type":"object","properties":{"planningGroupId":{"type":"string","description":"The ID of the planning group"},"metricResults":{"type":"array","description":"The generation results for the associated planning group","items":{"$ref":"#/definitions/BuForecastTimeSeriesResult"}}}},"BuForecastGenerationResult":{"type":"object","properties":{"planningGroupResults":{"type":"array","description":"Generation results, broken down by planning group","items":{"$ref":"#/definitions/BuForecastGenerationPlanningGroupResult"}}}},"BuForecastTimeSeriesResult":{"type":"object","properties":{"metric":{"type":"string","description":"The metric this result applies to","enum":["Offered","AverageHandleTimeSeconds"],"x-genesys-enum-members":[{"name":"Offered"},{"name":"AverageHandleTimeSeconds"}]},"forecastingMethod":{"type":"string","description":"The forecasting method that was used for this metric","enum":["AutoRegressiveIntegratedMovingAverage","MovingAverage","SingleExponentialSmoothing","RandomWalk","DecompositionUsingAdditiveSeasonality","DecompositionUsingMultiplicativeSeasonality","HoltWintersAdditiveSeasonality","HoltWintersAdditiveSeasonalityWithDampedTrend","HoltWintersMultiplicativeSeasonality","HoltWintersMultiplicativeSeasonalityWithDampedTrend","DampedLinearExponentialSmoothing","DoubleExponentialSmoothing","DoubleMovingAverage","LinearExponentialSmoothing","LinearWeightedMovingAverage","PointEstimateUsingDampedLinearExponentialSmoothing","PointEstimateUsingDoubleExponentialSmoothing","PointEstimateUsingLatestWeek","PointEstimateUsingLinearExponentialSmoothing","PointEstimateUsingWeightedAverage","CurveFit","MultiLinearRegression","DynamicHarmonicRegression","Other"],"x-genesys-enum-members":[{"name":"AutoRegressiveIntegratedMovingAverage"},{"name":"MovingAverage"},{"name":"SingleExponentialSmoothing"},{"name":"RandomWalk"},{"name":"DecompositionUsingAdditiveSeasonality"},{"name":"DecompositionUsingMultiplicativeSeasonality"},{"name":"HoltWintersAdditiveSeasonality"},{"name":"HoltWintersAdditiveSeasonalityWithDampedTrend"},{"name":"HoltWintersMultiplicativeSeasonality"},{"name":"HoltWintersMultiplicativeSeasonalityWithDampedTrend"},{"name":"DampedLinearExponentialSmoothing"},{"name":"DoubleExponentialSmoothing"},{"name":"DoubleMovingAverage"},{"name":"LinearExponentialSmoothing"},{"name":"LinearWeightedMovingAverage"},{"name":"PointEstimateUsingDampedLinearExponentialSmoothing"},{"name":"PointEstimateUsingDoubleExponentialSmoothing"},{"name":"PointEstimateUsingLatestWeek"},{"name":"PointEstimateUsingLinearExponentialSmoothing"},{"name":"PointEstimateUsingWeightedAverage"},{"name":"CurveFit"},{"name":"MultiLinearRegression"},{"name":"DynamicHarmonicRegression"},{"name":"Other"}]}}},"BuShortTermForecastListItem":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"weekDate":{"type":"string","format":"date","description":"The start week date of this forecast in yyyy-MM-dd. Must fall on the start day of week for the associated business unit. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"weekCount":{"type":"integer","format":"int32","description":"The number of weeks this forecast covers"},"creationMethod":{"type":"string","description":"The method by which this forecast was created","enum":["Import","ImportedHistoricalWeightedAverage","HistoricalWeightedAverage","Advanced"],"x-genesys-enum-members":[{"name":"Import"},{"name":"ImportedHistoricalWeightedAverage"},{"name":"HistoricalWeightedAverage"},{"name":"Advanced"}]},"description":{"type":"string","description":"The description of this forecast"},"legacy":{"type":"boolean","description":"Whether this forecast contains modifications on legacy metrics","readOnly":true},"metadata":{"description":"Metadata for this forecast","$ref":"#/definitions/WfmVersionedEntityMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BuShortTermForecastListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/BuShortTermForecastListItem"}}}},"BuForecastModification":{"type":"object","required":["displayGranularity","enabled","metric","type"],"properties":{"type":{"type":"string","description":"The type of the modification","enum":["MinimumPerInterval","MaximumPerInterval","SetValuePerInterval","ChangeValuePerInterval","ChangePercentPerInterval","SetValueOverRange","ChangeValueOverRange","SetValuesForIntervalSet"],"x-genesys-enum-members":[{"name":"MinimumPerInterval"},{"name":"MaximumPerInterval"},{"name":"SetValuePerInterval"},{"name":"ChangeValuePerInterval"},{"name":"ChangePercentPerInterval"},{"name":"SetValueOverRange"},{"name":"ChangeValueOverRange"},{"name":"SetValuesForIntervalSet"}]},"startIntervalIndex":{"type":"integer","format":"int32","description":"The number of 15 minute intervals past referenceStartDate representing the first interval to which to apply this modification. Must be null if values is populated"},"endIntervalIndex":{"type":"integer","format":"int32","description":"The number of 15 minute intervals past referenceStartDate representing the last interval to which to apply this modification. Must be null if values is populated"},"metric":{"type":"string","description":"The metric to which this modification applies","enum":["Offered","AverageHandleTimeSeconds"],"x-genesys-enum-members":[{"name":"Offered"},{"name":"AverageHandleTimeSeconds"}]},"legacyMetric":{"type":"string","description":"The legacy metric to which this modification applies if applicable","readOnly":true,"enum":["AverageAfterCallWorkTimeSeconds","AverageHandleTimeSeconds","AverageTalkTimeSeconds","Offered"],"x-genesys-enum-members":[{"name":"AverageAfterCallWorkTimeSeconds"},{"name":"AverageHandleTimeSeconds"},{"name":"AverageTalkTimeSeconds"},{"name":"Offered"}]},"value":{"type":"number","format":"double","description":"The value of the modification. Must be null if \"values\" is populated"},"values":{"type":"array","description":"The list of values to update. Only applicable for grid-type modifications. Must be null if \"value\" is populated","items":{"$ref":"#/definitions/WfmForecastModificationIntervalOffsetValue"}},"displayGranularity":{"type":"string","description":"The client side display granularity of the modification, expressed in the ISO-8601 duration format. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"granularity":{"type":"string","description":"The actual granularity of the modification as stored behind the scenes, expressed in the ISO-8601 duration format. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"enabled":{"type":"boolean","description":"Whether the modification is enabled for the forecast"},"planningGroupIds":{"type":"array","description":"The IDs of the planning groups to which this forecast modification applies. Leave empty to apply to all","uniqueItems":true,"items":{"type":"string"}}}},"BuShortTermForecast":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"weekDate":{"type":"string","format":"date","description":"The start week date of this forecast in yyyy-MM-dd. Must fall on the start day of week for the associated business unit. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"weekCount":{"type":"integer","format":"int32","description":"The number of weeks this forecast covers"},"creationMethod":{"type":"string","description":"The method by which this forecast was created","enum":["Import","ImportedHistoricalWeightedAverage","HistoricalWeightedAverage","Advanced"],"x-genesys-enum-members":[{"name":"Import"},{"name":"ImportedHistoricalWeightedAverage"},{"name":"HistoricalWeightedAverage"},{"name":"Advanced"}]},"description":{"type":"string","description":"The description of this forecast"},"legacy":{"type":"boolean","description":"Whether this forecast contains modifications on legacy metrics","readOnly":true},"metadata":{"description":"Metadata for this forecast","$ref":"#/definitions/WfmVersionedEntityMetadata"},"referenceStartDate":{"type":"string","format":"date-time","description":"The reference start date for interval-based data for this forecast. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"sourceDays":{"type":"array","description":"The source day pointers for this forecast","items":{"$ref":"#/definitions/ForecastSourceDayPointer"}},"modifications":{"type":"array","description":"Any manual modifications applied to this forecast","items":{"$ref":"#/definitions/BuForecastModification"}},"generationResults":{"description":"Generation result metadata","$ref":"#/definitions/BuForecastGenerationResult"},"timeZone":{"type":"string","description":"The time zone for this forecast"},"planningGroupsVersion":{"type":"integer","format":"int32","description":"The version of the planning groups that was used for this forecast"},"planningGroups":{"description":"A snapshot of the planning groups used for this forecast as of the version number indicated","$ref":"#/definitions/ForecastPlanningGroupsResponse"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ForecastAbandonRateResponse":{"type":"object","properties":{"percent":{"type":"integer","format":"int32","description":"The target percent abandon rate goal"}}},"ForecastAverageSpeedOfAnswerResponse":{"type":"object","properties":{"seconds":{"type":"integer","format":"int32","description":"the average speed of answer goal in seconds"}}},"ForecastPlanningGroupResponse":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the planning group"},"name":{"type":"string","description":"The name of the planning group"},"routePaths":{"type":"array","description":"Route path configuration for this planning group","items":{"$ref":"#/definitions/RoutePathResponse"}},"serviceGoalTemplate":{"description":"Service goals for this planning group","$ref":"#/definitions/ForecastServiceGoalTemplateResponse"}}},"ForecastPlanningGroupsResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ForecastPlanningGroupResponse"}}}},"ForecastServiceGoalTemplateResponse":{"type":"object","properties":{"serviceLevel":{"description":"The service level goal for this forecast","$ref":"#/definitions/ForecastServiceLevelResponse"},"averageSpeedOfAnswer":{"description":"The average speed of answer goal for this forecast","$ref":"#/definitions/ForecastAverageSpeedOfAnswerResponse"},"abandonRate":{"description":"The abandon rate goal for this forecast","$ref":"#/definitions/ForecastAbandonRateResponse"}}},"ForecastServiceLevelResponse":{"type":"object","properties":{"percent":{"type":"integer","format":"int32","description":"The percent of calls to answer in the number of seconds defined"},"seconds":{"type":"integer","format":"int32","description":"The number of seconds to define for the percent of calls to be answered"}}},"ForecastSourceDayPointer":{"type":"object","properties":{"dayOfWeek":{"type":"string","description":"The forecast day of week for this source data","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday","EighthDay"],"x-genesys-enum-members":[{"name":"Sunday"},{"name":"Monday"},{"name":"Tuesday"},{"name":"Wednesday"},{"name":"Thursday"},{"name":"Friday"},{"name":"Saturday"},{"name":"EighthDay"}]},"weight":{"type":"integer","format":"int32","description":"The relative weight to apply to this source data item for weighted averages"},"date":{"type":"string","description":"The date this source data represents, in yyyy-MM-dd format"},"fileName":{"type":"string","description":"The name of the source file this data came from if it originated from a data import"},"dataKey":{"type":"string","description":"The key to look up the forecast source data for this source day"}},"description":"Pointer to look up source data for a short term forecast"},"LanguageReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"RoutePathResponse":{"type":"object","properties":{"queue":{"description":"The ID of the queue associated with the route path","$ref":"#/definitions/QueueReference"},"mediaType":{"type":"string","description":"The media type of the given queue associated with the route path","enum":["Voice","Chat","Email","Callback","Message"],"x-genesys-enum-members":[{"name":"Voice"},{"name":"Chat"},{"name":"Email"},{"name":"Callback"},{"name":"Message"}]},"language":{"description":"The ID of the language associated with the route path","$ref":"#/definitions/LanguageReference"},"skills":{"type":"array","description":"The set of skills associated with the route path","uniqueItems":true,"items":{"$ref":"#/definitions/RoutingSkillReference"}}},"description":"Route path configuration"},"RoutingSkillReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WfmForecastModificationIntervalOffsetValue":{"type":"object","required":["intervalIndex","value"],"properties":{"intervalIndex":{"type":"integer","format":"int32","description":"The number of 15 minute intervals past referenceStartDate to which to apply this modification"},"value":{"type":"number","format":"double","description":"The value to set for the given interval"}},"description":"Override the value of a single interval in a forecast"},"AsyncForecastOperationResult":{"type":"object","properties":{"status":{"type":"string","description":"The status of the operation","enum":["Processing","Complete","Canceled","Error"],"x-genesys-enum-members":[{"name":"Processing"},{"name":"Complete"},{"name":"Canceled"},{"name":"Error"}]},"operationId":{"type":"string","description":"The ID for the operation"},"result":{"description":"The result of the operation. Null unless status == Complete","$ref":"#/definitions/BuShortTermForecast"},"progress":{"type":"integer","format":"int32","description":"Percent progress for the operation"}}},"GenerateBuForecastRequest":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"The description for the forecast"},"weekCount":{"type":"integer","format":"int32","description":"The number of weeks this forecast covers"}}},"BuForecastResult":{"type":"object","properties":{"referenceStartDate":{"type":"string","format":"date-time","description":"The reference start date for interval-based data for this forecast. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"planningGroups":{"type":"array","description":"The forecast data broken up by planning group","items":{"$ref":"#/definitions/ForecastPlanningGroupData"}},"weekNumber":{"type":"integer","format":"int32","description":"The week number represented by this response"},"weekCount":{"type":"integer","format":"int32","description":"The number of weeks in this forecast"}}},"BuForecastResultResponse":{"type":"object","properties":{"result":{"description":"The result of the operation. Populated whenever the result is small enough to pass through the api directly","$ref":"#/definitions/BuForecastResult"},"downloadUrl":{"type":"string","description":"The download url to fetch the result. Only populated if the result is too large to pass through the api directly"}}},"ForecastPlanningGroupData":{"type":"object","properties":{"planningGroupId":{"type":"string","description":"The ID of the planning group to which this data applies. Note this is a snapshot of the planning group at the time of forecast creation and may not correspond to the current configuration"},"offeredPerInterval":{"type":"array","description":"Forecast offered counts per interval for this week of the forecast","items":{"type":"number","format":"double"}},"averageHandleTimeSecondsPerInterval":{"type":"array","description":"Forecast average handle time per interval in seconds","items":{"type":"number","format":"double"}}}},"CopyBuForecastRequest":{"type":"object","required":["description","weekDate"],"properties":{"description":{"type":"string","description":"The description for the forecast"},"weekDate":{"type":"string","format":"date","description":"The start date of the new forecast to create from the existing forecast. Must correspond to the start day of week for the business unit. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"}}},"CredentialInfo":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"createdDate":{"type":"string","format":"date-time","description":"Date the credentials were created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedDate":{"type":"string","format":"date-time","description":"Date credentials were last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"type":{"description":"Type of the credentials.","$ref":"#/definitions/CredentialType"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CredentialInfoListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CredentialInfo"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CredentialType":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"properties":{"type":"object","description":"Properties describing credentials of this type.","readOnly":true},"displayOrder":{"type":"array","description":"Order in which properties should be displayed in the UI.","readOnly":true,"items":{"type":"string"}},"required":{"type":"array","description":"Properties that are required fields.","readOnly":true,"items":{"type":"string"}}}},"Credential":{"type":"object","required":["type"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"type":{"description":"The type of credential.","$ref":"#/definitions/CredentialType"},"credentialFields":{"type":"object","additionalProperties":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UploadUrlResponse":{"type":"object","properties":{"url":{"type":"string","description":"Presigned URL to PUT the file to","readOnly":true},"uploadKey":{"type":"string","description":"Key that identifies the file in the storage including the file name","readOnly":true},"headers":{"type":"object","description":"Required headers when uploading a file through PUT request to the URL","readOnly":true,"additionalProperties":{"type":"string"}}}},"UploadUrlRequest":{"type":"object","properties":{"fileName":{"type":"string","description":"Name of the file to upload. It must not start with a dot and not end with a forward slash. Whitespace and the following characters are not allowed: \\{^}%`]\">[~<#|"},"contentMd5":{"type":"string","description":"Content MD-5 of the file to upload"},"signedUrlTimeoutSeconds":{"type":"integer","format":"int32","description":"The number of seconds the presigned URL is valid for (from 1 to 604800 seconds). If none provided, defaults to 600 seconds"},"serverSideEncryption":{"type":"string","enum":["AES256"],"x-genesys-enum-members":[{"name":"AES256"}]}}},"DomainCapabilities":{"type":"object","properties":{"enabled":{"type":"boolean","description":"True if this address family on the interface is enabled."},"dhcp":{"type":"boolean","description":"True if this address family on the interface is using DHCP."},"metric":{"type":"integer","format":"int32","description":"The metric being used for the address family on this interface. Lower values will have a higher priority. If autoMetric is true, this value will be the automatically calculated metric. To set this value be sure autoMetric is false. If no value is returned, metric configuration is not supported on this Edge."},"autoMetric":{"type":"boolean","description":"True if the metric is being calculated automatically for the address family on this interface."},"supportsMetric":{"type":"boolean","description":"True if metric configuration is supported.","readOnly":true},"pingEnabled":{"type":"boolean","description":"Set to true to enable this address family on this interface to respond to ping requests."}}},"DomainLogicalInterface":{"type":"object","required":["friendlyName","hardwareAddress","name","physicalAdapterId"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"edgeUri":{"type":"string","format":"uri"},"edgeAssignedId":{"type":"string"},"friendlyName":{"type":"string","description":"Friendly Name"},"vlanTagId":{"type":"integer","format":"int32"},"hardwareAddress":{"type":"string","description":"Hardware Address"},"physicalAdapterId":{"type":"string","description":"Physical Adapter Id"},"ifStatus":{"type":"string"},"interfaceType":{"type":"string","description":"The type of this network interface.","readOnly":true,"enum":["DIAGNOSTIC","SYSTEM"],"x-genesys-enum-members":[{"name":"DIAGNOSTIC"},{"name":"SYSTEM"}]},"publicNatAddressIpV4":{"type":"string","description":"IPv4 NENT IP Address"},"publicNatAddressIpV6":{"type":"string","description":"IPv6 NENT IP Address"},"routes":{"type":"array","description":"The list of routes assigned to this interface.","items":{"$ref":"#/definitions/DomainNetworkRoute"}},"addresses":{"type":"array","description":"The list of IP addresses on this interface. Priority of dns addresses are based on order in the list.","items":{"$ref":"#/definitions/DomainNetworkAddress"}},"ipv4Capabilities":{"description":"IPv4 interface settings.","$ref":"#/definitions/DomainCapabilities"},"ipv6Capabilities":{"description":"IPv6 interface settings.","$ref":"#/definitions/DomainCapabilities"},"currentState":{"type":"string","enum":["INIT","CREATING","UPDATING","OK","EXCEPTION","DELETING"],"x-genesys-enum-members":[{"name":"INIT"},{"name":"CREATING"},{"name":"UPDATING"},{"name":"OK"},{"name":"EXCEPTION"},{"name":"DELETING"}]},"lastModifiedUserId":{"type":"string"},"lastModifiedCorrelationId":{"type":"string"},"commandResponses":{"type":"array","items":{"$ref":"#/definitions/DomainNetworkCommandResponse"}},"inheritPhoneTrunkBasesIPv4":{"type":"boolean","description":"The IPv4 phone trunk base assignment will be inherited from the Edge Group."},"inheritPhoneTrunkBasesIPv6":{"type":"boolean","description":"The IPv6 phone trunk base assignment will be inherited from the Edge Group."},"useForInternalEdgeCommunication":{"type":"boolean","description":"This interface will be used for all internal edge-to-edge communication using settings from the edgeTrunkBaseAssignment on the Edge Group."},"useForIndirectEdgeCommunication":{"type":"boolean","description":"Site Interconnects using the \"Indirect\" method will communicate using the Public IP Address specified on the interface. Use this option when a NAT enabled firewall is between the Edge and the far end."},"useForCloudProxyEdgeCommunication":{"type":"boolean","description":"Site Interconnects using the \"Cloud Proxy\" method will broker the connection between them with a Cloud Proxy. This method is required for connections between one or more Sites using Cloud Media, but can optionally be used between two premises Sites if Direct or Indirect are not an option."},"useForWanInterface":{"type":"boolean","description":"This interface will be used for all communication with the internet.","readOnly":true},"externalTrunkBaseAssignments":{"type":"array","description":"External trunk base settings to use for external communication from this interface.","items":{"$ref":"#/definitions/TrunkBaseAssignment"}},"phoneTrunkBaseAssignments":{"type":"array","description":"Phone trunk base settings to use for phone communication from this interface. These settings will be ignored when \"inheritPhoneTrunkBases\" is true.","items":{"$ref":"#/definitions/TrunkBaseAssignment"}},"traceEnabled":{"type":"boolean"},"startDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DomainNetworkAddress":{"type":"object","properties":{"type":{"type":"string","description":"The type of address.","enum":["ip","dns","gateway","tdm"]},"address":{"type":"string","description":"An IPv4 or IPv6 IP address. When specifying an address of type \"ip\", use CIDR format for the subnet mask."},"persistent":{"type":"boolean","description":"True if this address will persist on Edge restart. Addresses assigned by DHCP will be returned as false."},"family":{"type":"integer","format":"int32","description":"The address family for this address.","enum":[2,23]}}},"DomainNetworkCommandResponse":{"type":"object","properties":{"correlationId":{"type":"string"},"commandName":{"type":"string"},"acknowledged":{"type":"boolean"},"errorInfo":{"$ref":"#/definitions/ErrorDetails"}}},"DomainNetworkRoute":{"type":"object","properties":{"prefix":{"type":"string","description":"The IPv4 or IPv6 route prefix in CIDR notation."},"nexthop":{"type":"string","description":"The IPv4 or IPv6 nexthop IP address."},"persistent":{"type":"boolean","description":"True if this route will persist on Edge restart. Routes assigned by DHCP will be returned as false."},"metric":{"type":"integer","format":"int32","description":"The metric being used for route. Lower values will have a higher priority."},"family":{"type":"integer","format":"int32","description":"The address family for this route.","enum":[2,23]}}},"ErrorDetails":{"type":"object","properties":{"status":{"type":"integer","format":"int32"},"message":{"type":"string"},"messageWithParams":{"type":"string"},"messageParams":{"type":"object","additionalProperties":{"type":"string"}},"code":{"type":"string"},"contextId":{"type":"string"},"nested":{"$ref":"#/definitions/ErrorDetails"},"details":{"type":"string","format":"uri"}}},"LogicalInterfaceEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DomainLogicalInterface"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"TrunkBaseAssignment":{"type":"object","properties":{"family":{"type":"integer","format":"int32","description":"The address family to use with the trunk base settings. 2=IPv4, 23=IPv6"},"trunkBase":{"description":"A trunk base settings reference.","$ref":"#/definitions/TrunkBase"}}},"ConversationAssociation":{"type":"object","required":["communicationId","conversationId","mediaType"],"properties":{"externalContactId":{"type":"string","description":"An external contact ID. If not supplied, implies the conversation should be disassociated with any external contact."},"conversationId":{"type":"string","description":"Conversation ID"},"communicationId":{"type":"string","description":"Communication ID"},"mediaType":{"type":"string","description":"Media type","enum":["CALL","CALLBACK","CHAT","COBROWSE","EMAIL","MESSAGE","SOCIAL_EXPRESSION","VIDEO","SCREENSHARE"],"x-genesys-enum-members":[{"name":"CALL"},{"name":"CALLBACK"},{"name":"CHAT"},{"name":"COBROWSE"},{"name":"EMAIL"},{"name":"MESSAGE"},{"name":"SOCIAL_EXPRESSION"},{"name":"VIDEO"},{"name":"SCREENSHARE"}]}}},"DivsPermittedEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AuthzDivision"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"allDivsPermitted":{"type":"boolean"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"QueueEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Queue"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ScimConfigResourceType":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the SCIM resource. Set by the service provider. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readOnly\". \"returned\" is set to \"always\".","readOnly":true},"schemas":{"type":"array","description":"The list of supported schemas.","readOnly":true,"items":{"type":"string"}},"name":{"type":"string","description":"The name of the resource type.","readOnly":true},"description":{"type":"string","description":"The description of the resource type.","readOnly":true},"schema":{"type":"string","description":"The URI of the primary or base schema for the resource type.","readOnly":true},"schemaExtensions":{"type":"array","description":"The list of schema extensions for the resource type.","readOnly":true,"items":{"$ref":"#/definitions/ScimConfigResourceTypeSchemaExtension"}},"endpoint":{"type":"string","description":"The HTTP-addressable endpoint of the resource type. Appears after the base URL.","readOnly":true},"meta":{"description":"The metadata of the SCIM resource. Only \"location\" and \"resourceType\" are set for \"ResourceType\" resources.","readOnly":true,"$ref":"#/definitions/ScimMetadata"}},"description":"Defines a SCIM resource."},"ScimConfigResourceTypeSchemaExtension":{"type":"object","properties":{"schema":{"type":"string","description":"The URI of an extended schema, for example, \"urn:edu:2.0:Staff\". Must be equal to the \"id\" attribute of a schema.","readOnly":true},"required":{"type":"boolean","description":"Indicates whether a schema extension is required.","readOnly":true}},"description":"Defines a SCIM resource type's schema extension."},"ScimMetadata":{"type":"object","properties":{"resourceType":{"type":"string","description":"The type of SCIM resource.","readOnly":true,"enum":["User","Group","ServiceProviderConfig","ResourceType","Schema"],"x-genesys-enum-members":[{"name":"User"},{"name":"Group"},{"name":"ServiceProviderConfig"},{"name":"ResourceType"},{"name":"Schema"}]},"lastModified":{"type":"string","format":"date-time","description":"The last time that the resource was modified. Date time is represented as an \"ISO-8601 string\", for example, yyyy-MM-ddTHH:mm:ss.SSSZ. Not included with \"Schema\" and \"ResourceType\" resources.","readOnly":true},"location":{"type":"string","format":"uri","description":"The URI of the resource.","readOnly":true},"version":{"type":"string","description":"The version of the resource. Matches the ETag HTTP response header. Not included with \"Schema\" and \"ResourceType\" resources.","readOnly":true}},"description":"Defines the SCIM metadata."},"ScimConfigResourceTypesListResponse":{"type":"object","properties":{"totalResults":{"type":"integer","format":"int64","description":"The total number of results.","readOnly":true},"startIndex":{"type":"integer","format":"int64","description":"The 1-based index of the first result returned by this request. Add this to \"itemsPerPage\" when requesting the next page of results.","readOnly":true},"itemsPerPage":{"type":"integer","format":"int64","description":"The number of resources returned per page.","readOnly":true},"Resources":{"type":"array","description":"The list of requested resources.","readOnly":true,"items":{"$ref":"#/definitions/ScimConfigResourceType"}},"schemas":{"type":"array","description":"The list of supported schemas.","items":{"type":"string"}}},"description":"Defines a response for a list of SCIM resource types."},"DomainEdgeSoftwareUpdateDto":{"type":"object","required":["version"],"properties":{"version":{"description":"Version","$ref":"#/definitions/DomainEdgeSoftwareVersionDto"},"maxDownloadRate":{"type":"integer","format":"int32"},"downloadStartTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"executeStartTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"executeStopTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"executeOnIdle":{"type":"boolean"},"status":{"type":"string","enum":["NONE","INIT","IN_PROGRESS","EXPIRED","EXCEPTION","ABORTED","FAILED","SUCCEEDED","DELETE"],"x-genesys-enum-members":[{"name":"NONE"},{"name":"INIT"},{"name":"IN_PROGRESS"},{"name":"EXPIRED"},{"name":"EXCEPTION"},{"name":"ABORTED"},{"name":"FAILED"},{"name":"SUCCEEDED"},{"name":"DELETE"}]},"edgeUri":{"type":"string","format":"uri"},"callDrainingWaitTimeSeconds":{"type":"integer","format":"int64"},"current":{"type":"boolean"}}},"DomainEdgeSoftwareVersionDto":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"edgeVersion":{"type":"string"},"publishDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"edgeUri":{"type":"string","format":"uri"},"latestRelease":{"type":"boolean"},"current":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Edge":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"interfaces":{"type":"array","description":"The list of interfaces for the edge. (Deprecated) Replaced by configuring trunks/ip info on the logical interface instead","items":{"$ref":"#/definitions/EdgeInterface"}},"make":{"type":"string"},"model":{"type":"string"},"apiVersion":{"type":"string"},"softwareVersion":{"type":"string"},"softwareVersionTimestamp":{"type":"string"},"softwareVersionPlatform":{"type":"string"},"softwareVersionConfiguration":{"type":"string"},"fullSoftwareVersion":{"type":"string"},"pairingId":{"type":"string","description":"The pairing Id for a hardware Edge in the format: 00000-00000-00000-00000-00000. This field is only required when creating an Edge with a deployment type of HARDWARE."},"fingerprint":{"type":"string"},"fingerprintHint":{"type":"string"},"currentVersion":{"type":"string"},"stagedVersion":{"type":"string"},"patch":{"type":"string"},"statusCode":{"type":"string","description":"The current status of the Edge.","enum":["NEW","AWAITING_CONNECTION","AWAITING_FINGERPRINT","AWAITING_FINGERPRINT_VERIFICATION","FINGERPRINT_VERIFIED","AWAITING_BOOTSTRAP","ACTIVE","INACTIVE","RMA","UNPAIRING","UNPAIRED","INITIALIZING"],"x-genesys-enum-members":[{"name":"NEW"},{"name":"AWAITING_CONNECTION"},{"name":"AWAITING_FINGERPRINT"},{"name":"AWAITING_FINGERPRINT_VERIFICATION"},{"name":"FINGERPRINT_VERIFIED"},{"name":"AWAITING_BOOTSTRAP"},{"name":"ACTIVE"},{"name":"INACTIVE"},{"name":"RMA"},{"name":"UNPAIRING"},{"name":"UNPAIRED"},{"name":"INITIALIZING"}]},"edgeGroup":{"$ref":"#/definitions/EdgeGroup"},"site":{"description":"The Site to which the Edge is assigned.","$ref":"#/definitions/Site"},"softwareStatus":{"description":"Details about an in-progress or recently in-progress Edge software upgrade. This node appears only if a software upgrade was recently initiated for this Edge.","$ref":"#/definitions/DomainEdgeSoftwareUpdateDto"},"onlineStatus":{"type":"string","enum":["ONLINE","OFFLINE"],"x-genesys-enum-members":[{"name":"ONLINE"},{"name":"OFFLINE"}]},"serialNumber":{"type":"string"},"physicalEdge":{"type":"boolean"},"managed":{"type":"boolean"},"edgeDeploymentType":{"type":"string","enum":["HARDWARE","LDM","CDM","INVALID"],"x-genesys-enum-members":[{"name":"HARDWARE"},{"name":"LDM"},{"name":"CDM"},{"name":"INVALID"}]},"callDrainingState":{"type":"string","description":"The current state of the Edge's call draining process before it can be safely rebooted or updated.","readOnly":true,"enum":["NONE","WAIT","WAIT_TIMEOUT","TERMINATE","COMPLETE"],"x-genesys-enum-members":[{"name":"NONE"},{"name":"WAIT"},{"name":"WAIT_TIMEOUT"},{"name":"TERMINATE"},{"name":"COMPLETE"}]},"conversationCount":{"type":"integer","format":"int32","description":"The remaining number of conversations the Edge has to drain before it can be safely rebooted or updated. When an Edge is not draining conversations, this will be NULL or 0.","readOnly":true},"proxy":{"type":"string","description":"Edge HTTP proxy configuration for the WAN port. The field can be a hostname, FQDN, IPv4 or IPv6 address. If port is not included, port 80 is assumed."},"offlineConfigCalled":{"type":"boolean","description":"True if the offline edge configuration endpoint has been called for this edge.","readOnly":true},"osName":{"type":"string","description":"The name provided by the operating system of the Edge.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EdgeAutoUpdateConfig":{"type":"object","properties":{"timeZone":{"type":"string"},"rrule":{"type":"string"},"start":{"type":"string","format":"local-date-time","description":"Date time is represented as an ISO-8601 string without a timezone. For example: yyyy-MM-ddTHH:mm:ss.SSS"},"end":{"type":"string","format":"local-date-time","description":"Date time is represented as an ISO-8601 string without a timezone. For example: yyyy-MM-ddTHH:mm:ss.SSS"}}},"EdgeGroup":{"type":"object","required":["edgeTrunkBaseAssignment","name","phoneTrunkBases"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"managed":{"type":"boolean","description":"Is this edge group being managed remotely."},"hybrid":{"type":"boolean","description":"Is this edge group hybrid."},"edgeTrunkBaseAssignment":{"description":"A trunk base settings assignment of trunkType \"EDGE\" to use for edge-to-edge communication.","$ref":"#/definitions/TrunkBaseAssignment"},"phoneTrunkBases":{"type":"array","description":"Trunk base settings of trunkType \"PHONE\" to inherit to edge logical interface for phone communication.","items":{"$ref":"#/definitions/TrunkBase"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EdgeInterface":{"type":"object","properties":{"type":{"type":"string"},"ipAddress":{"type":"string"},"name":{"type":"string"},"macAddress":{"type":"string"},"ifName":{"type":"string"},"endpoints":{"type":"array","items":{"$ref":"#/definitions/DomainEntityRef"}},"lineTypes":{"type":"array","items":{"type":"string","enum":["TIE","NETWORK","TRUNK","STATION"],"x-genesys-enum-members":[{"name":"TIE"},{"name":"NETWORK"},{"name":"TRUNK"},{"name":"STATION"}]}},"addressFamilyId":{"type":"string"}}},"Line":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"properties":{"type":"object","additionalProperties":{"type":"object"}},"edgeGroup":{"$ref":"#/definitions/DomainEntityRef"},"template":{"$ref":"#/definitions/DomainEntityRef"},"site":{"$ref":"#/definitions/DomainEntityRef"},"lineBaseSettings":{"$ref":"#/definitions/DomainEntityRef"},"primaryEdge":{"description":"The primary edge associated to the line. (Deprecated)","$ref":"#/definitions/Edge"},"secondaryEdge":{"description":"The secondary edge associated to the line. (Deprecated)","$ref":"#/definitions/Edge"},"loggedInUser":{"$ref":"#/definitions/DomainEntityRef"},"defaultForUser":{"$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LineStatus":{"type":"object","properties":{"id":{"type":"string","description":"The id of this line"},"reachable":{"type":"boolean","description":"Indicates whether the edge can reach the line."},"addressOfRecord":{"type":"string","description":"The line's address of record."},"contactAddresses":{"type":"array","description":"The addresses used to contact the line.","items":{"type":"string"}},"reachableStateTime":{"type":"string","format":"date-time","description":"The time the line entered its current reachable state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"NTPSettings":{"type":"object","properties":{"servers":{"type":"array","description":"List of NTP servers, in priority order","items":{"type":"string"}}}},"Phone":{"type":"object","required":["lines","name","phoneBaseSettings","site"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"site":{"description":"The site associated to the phone.","$ref":"#/definitions/DomainEntityRef"},"phoneBaseSettings":{"description":"Phone Base Settings","$ref":"#/definitions/DomainEntityRef"},"lineBaseSettings":{"$ref":"#/definitions/DomainEntityRef"},"phoneMetaBase":{"$ref":"#/definitions/DomainEntityRef"},"lines":{"type":"array","description":"Lines","items":{"$ref":"#/definitions/Line"}},"status":{"description":"The status of the phone and lines from the primary Edge.","$ref":"#/definitions/PhoneStatus"},"secondaryStatus":{"description":"The status of the phone and lines from the secondary Edge.","$ref":"#/definitions/PhoneStatus"},"userAgentInfo":{"description":"User Agent Information for this phone. This includes model, firmware version, and manufacturer.","readOnly":true,"$ref":"#/definitions/UserAgentInfo"},"properties":{"type":"object","additionalProperties":{"type":"object"}},"capabilities":{"$ref":"#/definitions/PhoneCapabilities"},"webRtcUser":{"description":"This is the user associated with a WebRTC type phone. It is required for all WebRTC phones.","$ref":"#/definitions/DomainEntityRef"},"primaryEdge":{"$ref":"#/definitions/Edge"},"secondaryEdge":{"$ref":"#/definitions/Edge"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PhoneCapabilities":{"type":"object","properties":{"provisions":{"type":"boolean"},"registers":{"type":"boolean"},"dualRegisters":{"type":"boolean"},"hardwareIdType":{"type":"string"},"allowReboot":{"type":"boolean"},"noRebalance":{"type":"boolean"},"noCloudProvisioning":{"type":"boolean"},"mediaCodecs":{"type":"array","items":{"type":"string","enum":["audio/opus","audio/pcmu","audio/pcma","audio/g729","audio/g722"],"x-genesys-enum-members":[{"name":"audio/opus"},{"name":"audio/pcmu"},{"name":"audio/pcma"},{"name":"audio/g729"},{"name":"audio/g722"}]}},"cdm":{"type":"boolean"}}},"PhoneStatus":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"operationalStatus":{"type":"string","description":"The Operational Status of this phone","enum":["OPERATIONAL","DEGRADED","OFFLINE"],"x-genesys-enum-members":[{"name":"OPERATIONAL"},{"name":"DEGRADED"},{"name":"OFFLINE"}]},"edgesStatus":{"type":"string","description":"The status of the primary or secondary Edges assigned to the phone lines.","enum":["IN_SERVICE","MIXED_SERVICE","OUT_OF_SERVICE","NO_EDGES"],"x-genesys-enum-members":[{"name":"IN_SERVICE"},{"name":"MIXED_SERVICE"},{"name":"OUT_OF_SERVICE"},{"name":"NO_EDGES"}]},"eventCreationTime":{"type":"string","description":"Event Creation Time represents an ISO-8601 string. For example: UTC, UTC+01:00, or Europe/London"},"provision":{"description":"Provision information for this phone","$ref":"#/definitions/ProvisionInfo"},"lineStatuses":{"type":"array","description":"A list of LineStatus information for each of the lines of this phone","items":{"$ref":"#/definitions/LineStatus"}},"phoneAssignmentToEdgeType":{"type":"string","description":"The phone status's edge assignment type.","enum":["PRIMARY","SECONDARY"],"x-genesys-enum-members":[{"name":"PRIMARY"},{"name":"SECONDARY"}]},"edge":{"description":"The URI of the edge that provided this status information.","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ProvisionInfo":{"type":"object","properties":{"time":{"type":"string","format":"date-time","description":"The time at which this phone was provisioned. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"source":{"type":"string","description":"The source of the provisioning"},"errorInfo":{"type":"string","description":"The error information from the provision process, if any"}}},"Site":{"type":"object","required":["location","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"primarySites":{"type":"array","items":{"$ref":"#/definitions/DomainEntityRef"}},"secondarySites":{"type":"array","items":{"$ref":"#/definitions/DomainEntityRef"}},"primaryEdges":{"type":"array","items":{"$ref":"#/definitions/Edge"}},"secondaryEdges":{"type":"array","items":{"$ref":"#/definitions/Edge"}},"addresses":{"type":"array","items":{"$ref":"#/definitions/Contact"}},"edges":{"type":"array","items":{"$ref":"#/definitions/Edge"}},"edgeAutoUpdateConfig":{"description":"Recurrance rule, time zone, and start/end settings for automatic edge updates for this site","$ref":"#/definitions/EdgeAutoUpdateConfig"},"mediaRegionsUseLatencyBased":{"type":"boolean"},"location":{"description":"Location","$ref":"#/definitions/LocationDefinition"},"managed":{"type":"boolean"},"ntpSettings":{"description":"Network Time Protocol settings for the site","$ref":"#/definitions/NTPSettings"},"mediaModel":{"type":"string","description":"Media model for the site","enum":["Premises","Cloud"],"x-genesys-enum-members":[{"name":"Premises"},{"name":"Cloud"}]},"coreSite":{"type":"boolean","description":"The core site","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserAgentInfo":{"type":"object","properties":{"firmwareVersion":{"type":"string","description":"The firmware version of the phone."},"manufacturer":{"type":"string","description":"The manufacturer of the phone."},"model":{"type":"string","description":"The model of the phone."}}},"CustomerInteractionCenter":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"disabled":{"type":"boolean"},"issuerURI":{"type":"string"},"ssoTargetURI":{"type":"string"},"certificate":{"type":"string"},"certificates":{"type":"array","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OAuthProvider":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"disabled":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OneLogin":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"disabled":{"type":"boolean"},"issuerURI":{"type":"string"},"ssoTargetURI":{"type":"string"},"certificate":{"type":"string"},"certificates":{"type":"array","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EdgeLogsJobResponse":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The created job id."},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EdgeLogsJobRequest":{"type":"object","properties":{"path":{"type":"string","description":"A relative directory to the root Edge log folder to query from."},"query":{"type":"string","description":"The pattern to use when searching for logs, which may include the wildcards {*, ?}. Multiple search patterns may be combined using a pipe '|' as a delimiter."},"recurse":{"type":"boolean","description":"Boolean whether or not to recurse into directories."}}},"DetectedNamedEntity":{"type":"object","properties":{"name":{"type":"string","description":"The name of the detected named entity.","readOnly":true},"entityType":{"type":"string","description":"The type of the detected named entity.","readOnly":true},"probability":{"type":"number","format":"double","description":"The probability of the detected named entity.","readOnly":true},"value":{"description":"The value of the detected named entity.","readOnly":true,"$ref":"#/definitions/DetectedNamedEntityValue"}}},"DetectedNamedEntityValue":{"type":"object","properties":{"raw":{"type":"string","description":"The raw value of the detected named entity.","readOnly":true},"resolved":{"type":"string","description":"The resolved value of the detected named entity.","readOnly":true}}},"IntentDefinition":{"type":"object","required":["entityTypeBindings","name","utterances"],"properties":{"name":{"type":"string","description":"The name of the intent."},"entityTypeBindings":{"type":"array","description":"The bindings for the named entity types used in this intent.","items":{"$ref":"#/definitions/NamedEntityTypeBinding"}},"utterances":{"type":"array","description":"The utterances that act as training phrases for the intent.","items":{"$ref":"#/definitions/NluUtterance"}}}},"IntentFeedback":{"type":"object","properties":{"name":{"type":"string","description":"The name of the detected intent.","readOnly":true},"probability":{"type":"number","format":"double","description":"The probability of the detected intent.","readOnly":true},"entities":{"type":"array","description":"The collection of named entities detected.","readOnly":true,"items":{"$ref":"#/definitions/DetectedNamedEntity"}},"assessment":{"type":"string","description":"The assessment on the detection for feedback text.","enum":["Incorrect","Correct","Unknown","Disabled"],"x-genesys-enum-members":[{"name":"Incorrect"},{"name":"Correct"},{"name":"Unknown"},{"name":"Disabled"}]}}},"NamedEntityAnnotation":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The name of the annotated named entity."}}},"NamedEntityTypeBinding":{"type":"object","required":["entityName","entityType"],"properties":{"entityType":{"type":"string","description":"The named entity type of the binding. It can be a built-in one such as builtin:number or a custom entity type such as BeverageType."},"entityName":{"type":"string","description":"The name that this named entity type is bound to."}}},"NamedEntityTypeDefinition":{"type":"object","required":["mechanism","name"],"properties":{"name":{"type":"string","description":"The name of the entity type."},"description":{"type":"string","description":"Description of the of the named entity type."},"mechanism":{"description":"The mechanism enabling detection of the named entity type.","$ref":"#/definitions/NamedEntityTypeMechanism"}}},"NamedEntityTypeItem":{"type":"object","required":["value"],"properties":{"value":{"type":"string","description":"A value for an named entity type definition."},"synonyms":{"type":"array","description":"Synonyms for the given named entity value.","items":{"type":"string"}}}},"NamedEntityTypeMechanism":{"type":"object","required":["items","type"],"properties":{"items":{"type":"array","description":"The items that define the named entity type.","items":{"$ref":"#/definitions/NamedEntityTypeItem"}},"restricted":{"type":"boolean","description":"Whether the named entity type is restricted to the items provided. Default: false"},"type":{"type":"string","description":"The type of the mechanism.","enum":["List","Regex","Unknown"],"x-genesys-enum-members":[{"name":"List"},{"name":"Regex"},{"name":"Unknown"}]}}},"NluDomain":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the NLU domain."},"language":{"type":"string","description":"The language culture of the NLU domain, e.g. `en-us`, `de-de`."},"draftVersion":{"description":"The draft version of that NLU domain.","readOnly":true,"$ref":"#/definitions/NluDomainVersion"},"lastPublishedVersion":{"description":"The last published version of that NLU domain.","readOnly":true,"$ref":"#/definitions/NluDomainVersion"},"dateCreated":{"type":"string","format":"date-time","description":"The date when the NLU domain was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date when the NLU domain was updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"NluDomainVersion":{"type":"object","required":["language"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"domain":{"description":"The NLU domain of the version.","readOnly":true,"$ref":"#/definitions/NluDomain"},"description":{"type":"string","description":"The description of the NLU domain version."},"language":{"type":"string","description":"The language that the NLU domain version supports."},"published":{"type":"boolean","description":"Whether this NLU domain version has been published.","readOnly":true},"dateCreated":{"type":"string","format":"date-time","description":"The date when the NLU domain version was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date when the NLU domain version was updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateTrained":{"type":"string","format":"date-time","description":"The date when the NLU domain version was trained. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"datePublished":{"type":"string","format":"date-time","description":"The date when the NLU domain version was published. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"trainingStatus":{"type":"string","description":"The training status of the NLU domain version.","readOnly":true,"enum":["Untrained","Training","Trained","Error","Unknown"],"x-genesys-enum-members":[{"name":"Untrained"},{"name":"Training"},{"name":"Trained"},{"name":"Error"},{"name":"Unknown"}]},"evaluationStatus":{"type":"string","description":"The evaluation status of the NLU domain version.","readOnly":true,"enum":["Unevaluated","Evaluating","Evaluated","Error"],"x-genesys-enum-members":[{"name":"Unevaluated"},{"name":"Evaluating"},{"name":"Evaluated"},{"name":"Error"}]},"intents":{"type":"array","description":"The intents defined for this NLU domain version.","items":{"$ref":"#/definitions/IntentDefinition"}},"entityTypes":{"type":"array","description":"The entity types defined for this NLU domain version.","items":{"$ref":"#/definitions/NamedEntityTypeDefinition"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"NluFeedbackListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/NluFeedbackResponse"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"NluFeedbackResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"text":{"type":"string","description":"The feedback text."},"intents":{"type":"array","description":"Detected intent of the utterance","items":{"$ref":"#/definitions/IntentFeedback"}},"version":{"description":"The domain version of the feedback.","readOnly":true,"$ref":"#/definitions/NluDomainVersion"},"dateCreated":{"type":"string","format":"date-time","description":"The date when the feedback was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"NluUtterance":{"type":"object","required":["segments"],"properties":{"segments":{"type":"array","description":"The list of segments that that constitute this utterance for the given intent.","items":{"$ref":"#/definitions/NluUtteranceSegment"}}}},"NluUtteranceSegment":{"type":"object","required":["text"],"properties":{"text":{"type":"string","description":"The text of the segment."},"entity":{"description":"The entity annotation of the segment.","$ref":"#/definitions/NamedEntityAnnotation"}}},"NluFeedbackRequest":{"type":"object","required":["intents","text","versionId"],"properties":{"text":{"type":"string","description":"The feedback text."},"intents":{"type":"array","description":"Detected intent of the utterance","items":{"$ref":"#/definitions/IntentFeedback"}},"versionId":{"type":"string","description":"The domain version ID of the feedback."}}},"CallableContactsDiagnostic":{"type":"object","properties":{"attemptLimits":{"description":"Attempt limits for the campaign's contact list","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"dncLists":{"type":"array","description":"Do not call lists for the campaign","readOnly":true,"items":{"$ref":"#/definitions/DomainEntityRef"}},"callableTimeSet":{"description":"Callable time sets for the campaign","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"ruleSets":{"type":"array","description":"Rule sets for the campaign","readOnly":true,"items":{"$ref":"#/definitions/DomainEntityRef"}}}},"CampaignDiagnostics":{"type":"object","properties":{"callableContacts":{"description":"Campaign properties that can impact which contacts are callable","readOnly":true,"$ref":"#/definitions/CallableContactsDiagnostic"},"queueUtilizationDiagnostic":{"description":"Information regarding the campaign's queue","readOnly":true,"$ref":"#/definitions/QueueUtilizationDiagnostic"},"ruleSetDiagnostics":{"type":"array","description":"Information regarding the campaign's rule sets","readOnly":true,"items":{"$ref":"#/definitions/RuleSetDiagnostic"}},"outstandingInteractionsCount":{"type":"integer","format":"int32","description":"Current number of outstanding interactions on the campaign","readOnly":true},"scheduledInteractionsCount":{"type":"integer","format":"int32","description":"Current number of scheduled interactions on the campaign","readOnly":true}}},"QueueUtilizationDiagnostic":{"type":"object","properties":{"queue":{"description":"Identifier of the queue","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"usersInQueue":{"type":"integer","format":"int32","description":"The number of users joined to the queue","readOnly":true},"activeUsersInQueue":{"type":"integer","format":"int32","description":"The number of users active on the queue","readOnly":true},"usersOnQueue":{"type":"integer","format":"int32","description":"The number of users with a status of on-queue","readOnly":true},"usersNotUtilized":{"type":"integer","format":"int32","description":"The number of users in the queue currently not engaged","readOnly":true},"usersOnQueueWithStation":{"type":"integer","format":"int32","description":"The number of users in the queue with a station","readOnly":true},"usersOnACampaignCall":{"type":"integer","format":"int32","description":"The number of users currently engaged in a campaign call","readOnly":true},"usersOnDifferentEdgeGroup":{"type":"integer","format":"int32","description":"The number of users whose station is homed to an edge different from the campaign","readOnly":true},"usersOnANonCampaignCall":{"type":"integer","format":"int32","description":"The number of users currently engaged in a communication that is not part of the campaign","readOnly":true}}},"RuleSetDiagnostic":{"type":"object","properties":{"ruleSet":{"description":"A campaign rule set","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"warnings":{"type":"array","description":"Diagnostic warnings for the rule set","readOnly":true,"items":{"type":"string","enum":["WRAPUP_CODE_NOT_IN_QUEUE","CONTACT_ATTRIBUTE_NOT_IN_CONTACT_LIST","NO_DNC_LIST_FOR_APPEND","PHONE_CONDITIONS_WITH_MULTICOLUMN_PREVIEW"],"x-genesys-enum-members":[{"name":"WRAPUP_CODE_NOT_IN_QUEUE"},{"name":"CONTACT_ATTRIBUTE_NOT_IN_CONTACT_LIST"},{"name":"NO_DNC_LIST_FOR_APPEND"},{"name":"PHONE_CONDITIONS_WITH_MULTICOLUMN_PREVIEW"}]}}}},"CampaignProgress":{"type":"object","required":["campaign","contactList"],"properties":{"campaign":{"description":"Identifier of the campaign","$ref":"#/definitions/DomainEntityRef"},"contactList":{"description":"Identifier of the contact list","$ref":"#/definitions/DomainEntityRef"},"numberOfContactsCalled":{"type":"integer","format":"int64","description":"Number of contacts called during the campaign","readOnly":true},"numberOfContactsMessaged":{"type":"integer","format":"int64","description":"Number of contacts messaged during the campaign","readOnly":true},"totalNumberOfContacts":{"type":"integer","format":"int64","description":"Total number of contacts in the campaign","readOnly":true},"percentage":{"type":"integer","format":"int64","description":"Percentage of contacts processed during the campaign","readOnly":true}}},"TrunkBaseEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/TrunkBase"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"IntegrationStatusInfo":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable status as reported by the integration.","readOnly":true,"enum":["ACTIVE","ACTIVATING","INACTIVE","DEACTIVATING","ERROR"],"x-genesys-enum-members":[{"name":"ACTIVE"},{"name":"ACTIVATING"},{"name":"INACTIVE"},{"name":"DEACTIVATING"},{"name":"ERROR"}]},"effective":{"type":"string","description":"Localized, human-readable, effective status of the integration.","readOnly":true},"detail":{"description":"Localizable status details for the integration.","readOnly":true,"$ref":"#/definitions/MessageInfo"},"lastUpdated":{"type":"string","format":"date-time","description":"Date and time (in UTC) when the integration status (i.e. the code field) was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true}},"description":"Status information for an Integration."},"MessageInfo":{"type":"object","properties":{"localizableMessageCode":{"type":"string","description":"Key that can be used to localize the message."},"message":{"type":"string","description":"Description of the message."},"messageWithParams":{"type":"string","description":"Message with template fields for variable replacement."},"messageParams":{"type":"object","description":"Map with fields for variable replacement.","additionalProperties":{"type":"string"}}}},"WfmUserEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/User"}}}},"ShiftTradeMatchesSummaryResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WeekShiftTradeMatchesSummaryResponse"}}}},"WeekShiftTradeMatchesSummaryResponse":{"type":"object","properties":{"weekDate":{"type":"string","format":"date","description":"The schedule week date in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"count":{"type":"integer","format":"int32","description":"The number of trades in the Matched state for the given week"}}},"GenericSAML":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"disabled":{"type":"boolean"},"issuerURI":{"type":"string"},"ssoTargetURI":{"type":"string"},"certificate":{"type":"string"},"certificates":{"type":"array","items":{"type":"string"}},"relyingPartyIdentifier":{"type":"string"},"logoImageData":{"type":"string"},"endpointCompression":{"type":"boolean"},"nameIdentifierFormat":{"type":"string","enum":["urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified","urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress","urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName","urn:oasis:names:tc:SAML:1.1:nameid-format:WindowsDomainQualifiedName","urn:oasis:names:tc:SAML:2.0:nameid-format:kerberos","urn:oasis:names:tc:SAML:2.0:nameid-format:entity","urn:oasis:names:tc:SAML:2.0:nameid-format:persistent","urn:oasis:names:tc:SAML:2.0:nameid-format:transient"],"x-genesys-enum-members":[{"name":"urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified"},{"name":"urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress"},{"name":"urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName"},{"name":"urn:oasis:names:tc:SAML:1.1:nameid-format:WindowsDomainQualifiedName"},{"name":"urn:oasis:names:tc:SAML:2.0:nameid-format:kerberos"},{"name":"urn:oasis:names:tc:SAML:2.0:nameid-format:entity"},{"name":"urn:oasis:names:tc:SAML:2.0:nameid-format:persistent"},{"name":"urn:oasis:names:tc:SAML:2.0:nameid-format:transient"}]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CreateCallResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CreateCallRequest":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"The phone number to dial."},"callerId":{"type":"string","description":"The caller id phone number for this outbound call."},"callerIdName":{"type":"string","description":"The caller id name for this outbound call."},"callFromQueueId":{"type":"string","description":"The queue ID to call on behalf of."},"callQueueId":{"type":"string","description":"The queue ID to call."},"callUserId":{"type":"string","description":"The user ID to call."},"priority":{"type":"integer","format":"int32","description":"The priority to assign to this call (if calling a queue)."},"languageId":{"type":"string","description":"The language skill ID to use for routing this call (if calling a queue)."},"routingSkillsIds":{"type":"array","description":"The skill ID's to use for routing this call (if calling a queue).","items":{"type":"string"}},"conversationIds":{"type":"array","description":"The list of existing call conversations to merge into a new ad-hoc conference.","items":{"type":"string"}},"participants":{"type":"array","description":"The list of participants to call to create a new ad-hoc conference.","items":{"$ref":"#/definitions/Destination"}},"uuiData":{"type":"string","description":"User to User Information (UUI) data managed by SIP session application."}}},"Destination":{"type":"object","required":["address"],"properties":{"address":{"type":"string","description":"Address or phone number."},"name":{"type":"string"},"userId":{"type":"string"},"queueId":{"type":"string"}}},"ConsultTransferResponse":{"type":"object","required":["destinationParticipantId"],"properties":{"destinationParticipantId":{"type":"string","description":"Participant ID to whom the call is being transferred."}}},"ConsultTransferUpdate":{"type":"object","required":["speakTo"],"properties":{"speakTo":{"type":"string","description":"Determines to whom the initiating participant is speaking.","enum":["DESTINATION","OBJECT","BOTH"],"x-genesys-enum-members":[{"name":"DESTINATION"},{"name":"OBJECT"},{"name":"BOTH"}]}}},"ConsultTransfer":{"type":"object","required":["destination"],"properties":{"speakTo":{"type":"string","description":"Determines to whom the initiating participant is speaking. Defaults to DESTINATION","enum":["DESTINATION","OBJECT","BOTH"],"x-genesys-enum-members":[{"name":"DESTINATION"},{"name":"OBJECT"},{"name":"BOTH"}]},"destination":{"description":"Destination phone number and name.","$ref":"#/definitions/Destination"}}},"CallHistoryConversation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"participants":{"type":"array","description":"The list of participants involved in the conversation.","items":{"$ref":"#/definitions/CallHistoryParticipant"}},"direction":{"type":"string","description":"The direction of the call relating to the current user","enum":["inbound","outbound"],"x-genesys-enum-members":[{"name":"inbound"},{"name":"outbound"}]},"wentToVoicemail":{"type":"boolean","description":"Did the call end in the current user's voicemail"},"missedCall":{"type":"boolean","description":"Did the user not answer this conversation"},"startTime":{"type":"string","format":"date-time","description":"The time the user joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"wasConference":{"type":"boolean","description":"Was this conversation a conference"},"wasCallback":{"type":"boolean","description":"Was this conversation a callback"},"hadScreenShare":{"type":"boolean","description":"Did this conversation have a screen share session"},"hadCobrowse":{"type":"boolean","description":"Did this conversation have a cobrowse session"},"wasOutboundCampaign":{"type":"boolean","description":"Was this conversation associated with an outbound campaign"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CallHistoryConversationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CallHistoryConversation"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CallHistoryParticipant":{"type":"object","properties":{"id":{"type":"string","description":"The unique participant ID."},"name":{"type":"string","description":"The display friendly name of the participant."},"address":{"type":"string","description":"The participant address."},"startTime":{"type":"string","format":"date-time","description":"The time when this participant first joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"purpose":{"type":"string","description":"The participant's purpose. Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr"},"direction":{"type":"string","description":"The participant's direction. Values can be: 'inbound' or 'outbound'","enum":["inbound","outbound"],"x-genesys-enum-members":[{"name":"inbound"},{"name":"outbound"}]},"ani":{"type":"string","description":"The call ANI."},"dnis":{"type":"string","description":"The call DNIS."},"user":{"description":"The PureCloud user for this participant.","$ref":"#/definitions/User"},"queue":{"description":"The PureCloud queue for this participant.","$ref":"#/definitions/Queue"},"group":{"description":"The group involved in the group ring call.","$ref":"#/definitions/Group"},"disconnectType":{"type":"string","description":"The reason the participant was disconnected from the conversation.","enum":["endpoint","client","system","transfer","transfer.conference","transfer.consult","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam"],"x-genesys-enum-members":[{"name":"endpoint"},{"name":"client"},{"name":"system"},{"name":"transfer"},{"name":"transfer.conference"},{"name":"transfer.consult"},{"name":"transfer.forward"},{"name":"transfer.noanswer"},{"name":"transfer.notavailable"},{"name":"transport.failure"},{"name":"error"},{"name":"peer"},{"name":"other"},{"name":"spam"}]},"externalContact":{"description":"The PureCloud external contact","$ref":"#/definitions/ExternalContact"},"externalOrganization":{"description":"The PureCloud external organization","$ref":"#/definitions/ExternalOrganization"},"didInteract":{"type":"boolean","description":"Indicates whether the contact ever connected"},"sipResponseCodes":{"type":"array","description":"Indicates SIP Response codes associated with the participant","items":{"type":"integer","format":"int64"}},"flaggedReason":{"type":"string","description":"The reason specifying why participant flagged the conversation.","enum":["general"],"x-genesys-enum-members":[{"name":"general"}]},"outboundCampaign":{"description":"The outbound campaign associated with the participant","$ref":"#/definitions/Campaign"}}},"ParticipantAttributes":{"type":"object","properties":{"attributes":{"type":"object","description":"The map of attribute keys to values.","additionalProperties":{"type":"string"}}}},"CallConversation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"participants":{"type":"array","description":"The list of participants involved in the conversation.","items":{"$ref":"#/definitions/CallMediaParticipant"}},"otherMediaUris":{"type":"array","description":"The list of other media channels involved in the conversation.","items":{"type":"string","format":"uri"}},"recordingState":{"type":"string","enum":["none","active","paused"],"x-genesys-enum-members":[{"name":"none"},{"name":"active"},{"name":"paused"}]},"maxParticipants":{"type":"integer","format":"int32","description":"If this is a conference conversation, then this field indicates the maximum number of participants allowed to participant in the conference."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CallMediaParticipant":{"type":"object","properties":{"id":{"type":"string","description":"The unique participant ID."},"name":{"type":"string","description":"The display friendly name of the participant."},"address":{"type":"string","description":"The participant address."},"startTime":{"type":"string","format":"date-time","description":"The time when this participant first joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The time when this participant went connected for this media (eg: video connected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startHoldTime":{"type":"string","format":"date-time","description":"The time when this participant's hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"purpose":{"type":"string","description":"The participant's purpose. Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr"},"state":{"type":"string","description":"The participant's state. Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","converting","uploading","transmitting","none"],"x-genesys-enum-members":[{"name":"alerting"},{"name":"dialing"},{"name":"contacting"},{"name":"offering"},{"name":"connected"},{"name":"disconnected"},{"name":"terminated"},{"name":"converting"},{"name":"uploading"},{"name":"transmitting"},{"name":"none"}]},"direction":{"type":"string","description":"The participant's direction. Values can be: 'inbound' or 'outbound'","enum":["inbound","outbound"],"x-genesys-enum-members":[{"name":"inbound"},{"name":"outbound"}]},"disconnectType":{"type":"string","description":"The reason the participant was disconnected from the conversation.","enum":["endpoint","client","system","transfer","transfer.conference","transfer.consult","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam"],"x-genesys-enum-members":[{"name":"endpoint"},{"name":"client"},{"name":"system"},{"name":"transfer"},{"name":"transfer.conference"},{"name":"transfer.consult"},{"name":"transfer.forward"},{"name":"transfer.noanswer"},{"name":"transfer.notavailable"},{"name":"transport.failure"},{"name":"error"},{"name":"peer"},{"name":"other"},{"name":"spam"}]},"held":{"type":"boolean","description":"Value is true when the participant is on hold."},"wrapupRequired":{"type":"boolean","description":"Value is true when the participant requires wrap-up."},"wrapupPrompt":{"type":"string","description":"The wrap-up prompt indicating the type of wrap-up to be performed."},"user":{"description":"The PureCloud user for this participant.","$ref":"#/definitions/DomainEntityRef"},"queue":{"description":"The PureCloud queue for this participant.","$ref":"#/definitions/DomainEntityRef"},"team":{"description":"The PureCloud team for this participant.","$ref":"#/definitions/DomainEntityRef"},"attributes":{"type":"object","description":"A list of ad-hoc attributes for the participant.","additionalProperties":{"type":"string"}},"errorInfo":{"description":"If the conversation ends in error, contains additional error details.","$ref":"#/definitions/ErrorInfo"},"script":{"description":"The Engage script that should be used by this participant.","$ref":"#/definitions/DomainEntityRef"},"wrapupTimeoutMs":{"type":"integer","format":"int32","description":"The amount of time the participant has to complete wrap-up."},"wrapupSkipped":{"type":"boolean","description":"Value is true when the participant has skipped wrap-up."},"alertingTimeoutMs":{"type":"integer","format":"int32","description":"Specifies how long the agent has to answer an interaction before being marked as not responding."},"provider":{"type":"string","description":"The source provider for the communication."},"externalContact":{"description":"If this participant represents an external contact, then this will be the reference for the external contact.","$ref":"#/definitions/DomainEntityRef"},"externalOrganization":{"description":"If this participant represents an external org, then this will be the reference for the external org.","$ref":"#/definitions/DomainEntityRef"},"wrapup":{"description":"Wrapup for this participant, if it has been applied.","$ref":"#/definitions/Wrapup"},"peer":{"type":"string","description":"The peer communication corresponding to a matching leg for this communication."},"flaggedReason":{"type":"string","description":"The reason specifying why participant flagged the conversation.","enum":["general"],"x-genesys-enum-members":[{"name":"general"}]},"journeyContext":{"description":"Journey System data/context that is applicable to this communication. When used for historical purposes, the context should be immutable. When null, there is no applicable Journey System context.","$ref":"#/definitions/JourneyContext"},"conversationRoutingData":{"description":"Information on how a communication should be routed to an agent.","$ref":"#/definitions/ConversationRoutingData"},"startAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"muted":{"type":"boolean","description":"Value is true when the call is muted."},"confined":{"type":"boolean","description":"Value is true when the call is confined."},"recording":{"type":"boolean","description":"Value is true when the call is being recorded."},"recordingState":{"type":"string","description":"The state of the call recording.","enum":["none","active","paused"],"x-genesys-enum-members":[{"name":"none"},{"name":"active"},{"name":"paused"}]},"group":{"description":"The group involved in the group ring call.","$ref":"#/definitions/DomainEntityRef"},"ani":{"type":"string","description":"The call ANI."},"dnis":{"type":"string","description":"The call DNIS."},"documentId":{"type":"string","description":"The ID of the Content Management document if the call is a fax."},"faxStatus":{"description":"Extra fax information if the call is a fax.","$ref":"#/definitions/FaxStatus"},"monitoredParticipantId":{"type":"string","description":"The ID of the participant being monitored when performing a call monitor."},"consultParticipantId":{"type":"string","description":"The ID of the consult transfer target participant when performing a consult transfer."},"uuiData":{"type":"string","description":"User-to-User information which maps to a SIP header field defined in RFC7433. UUI data is used in the Public Switched Telephone Network (PSTN) for use cases described in RFC6567."}}},"AssignedWrapupCode":{"type":"object","properties":{"code":{"type":"string","description":"The user configured wrap up code id."},"notes":{"type":"string","description":"Text entered by the agent to describe the call or disposition."},"tags":{"type":"array","description":"List of tags selected by the agent to describe the call or disposition.","items":{"type":"string"}},"durationSeconds":{"type":"integer","format":"int32","description":"The duration in seconds of the wrap-up segment."},"endTime":{"type":"string","format":"date-time","description":"The timestamp when the wrap-up segment ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"MaxParticipants":{"type":"object","properties":{"maxParticipants":{"type":"integer","format":"int32","description":"The maximum number of participants that are allowed on a conversation."}}},"CallCommand":{"type":"object","required":["callNumber"],"properties":{"callNumber":{"type":"string","description":"The phone number to dial for this call."},"phoneColumn":{"type":"string","description":"For a dialer preview or scheduled callback, the phone column associated with the phone number"}}},"SetUuiDataRequest":{"type":"object","properties":{"uuiData":{"type":"string","description":"The value of the uuiData to set."}}},"CallConversationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CallConversation"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"MediaParticipantRequest":{"type":"object","properties":{"wrapup":{"description":"Wrap-up to assign to this participant.","$ref":"#/definitions/Wrapup"},"state":{"type":"string","description":"The state to update to set for this participant's communications. Possible values are: 'connected' and 'disconnected'.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","converting","uploading","transmitting","none"],"x-genesys-enum-members":[{"name":"alerting"},{"name":"dialing"},{"name":"contacting"},{"name":"offering"},{"name":"connected"},{"name":"disconnected"},{"name":"terminated"},{"name":"converting"},{"name":"uploading"},{"name":"transmitting"},{"name":"none"}]},"recording":{"type":"boolean","description":"True to enable recording of this participant, otherwise false to disable recording."},"muted":{"type":"boolean","description":"True to mute this conversation participant."},"confined":{"type":"boolean","description":"True to confine this conversation participant. Should only be used for ad-hoc conferences"},"held":{"type":"boolean","description":"True to hold this conversation participant."},"wrapupSkipped":{"type":"boolean","description":"True to skip wrap-up for this participant."}}},"TransferRequest":{"type":"object","properties":{"userId":{"type":"string","description":"The user ID of the transfer target."},"address":{"type":"string","description":"The phone number or address of the transfer target."},"userName":{"type":"string","description":"The user name of the transfer target."},"queueId":{"type":"string","description":"The queue ID of the transfer target."},"voicemail":{"type":"boolean","description":"If true, transfer to the voicemail inbox of the participant that is being replaced."}}},"Dependency":{"type":"object","properties":{"id":{"type":"string","description":"The dependency identifier"},"name":{"type":"string"},"version":{"type":"string"},"type":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","BOTCONNECTORBOT","BOTCONNECTORBOTVERSION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GROUP","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","IVRCONFIGURATION","LANGUAGE","LEXBOT","LEXBOTALIAS","NLUDOMAIN","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","WIDGET","WORKFLOW"],"x-genesys-enum-members":[{"name":"ACDLANGUAGE"},{"name":"ACDSKILL"},{"name":"ACDWRAPUPCODE"},{"name":"BOTCONNECTORBOT"},{"name":"BOTCONNECTORBOTVERSION"},{"name":"BOTFLOW"},{"name":"BRIDGEACTION"},{"name":"COMMONMODULEFLOW"},{"name":"COMPOSERSCRIPT"},{"name":"CONTACTLIST"},{"name":"DATAACTION"},{"name":"DATATABLE"},{"name":"DIALOGENGINEBOT"},{"name":"DIALOGENGINEBOTVERSION"},{"name":"DIALOGFLOWAGENT"},{"name":"EMAILROUTE"},{"name":"EMERGENCYGROUP"},{"name":"FLOWACTION"},{"name":"FLOWDATATYPE"},{"name":"FLOWMILESTONE"},{"name":"FLOWOUTCOME"},{"name":"GROUP"},{"name":"INBOUNDCALLFLOW"},{"name":"INBOUNDCHATFLOW"},{"name":"INBOUNDEMAILFLOW"},{"name":"INBOUNDSHORTMESSAGEFLOW"},{"name":"INQUEUECALLFLOW"},{"name":"IVRCONFIGURATION"},{"name":"LANGUAGE"},{"name":"LEXBOT"},{"name":"LEXBOTALIAS"},{"name":"NLUDOMAIN"},{"name":"OUTBOUNDCALLFLOW"},{"name":"QUEUE"},{"name":"RECORDINGPOLICY"},{"name":"RESPONSE"},{"name":"SCHEDULE"},{"name":"SCHEDULEGROUP"},{"name":"SECUREACTION"},{"name":"SECURECALLFLOW"},{"name":"SURVEYINVITEFLOW"},{"name":"SYSTEMPROMPT"},{"name":"TTSENGINE"},{"name":"TTSVOICE"},{"name":"USER"},{"name":"USERPROMPT"},{"name":"WIDGET"},{"name":"WORKFLOW"}]},"deleted":{"type":"boolean"},"updated":{"type":"boolean"},"stateUnknown":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DependencyObject":{"type":"object","properties":{"id":{"type":"string","description":"The dependency identifier"},"name":{"type":"string"},"version":{"type":"string"},"type":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","BOTCONNECTORBOT","BOTCONNECTORBOTVERSION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GROUP","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","IVRCONFIGURATION","LANGUAGE","LEXBOT","LEXBOTALIAS","NLUDOMAIN","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","WIDGET","WORKFLOW"],"x-genesys-enum-members":[{"name":"ACDLANGUAGE"},{"name":"ACDSKILL"},{"name":"ACDWRAPUPCODE"},{"name":"BOTCONNECTORBOT"},{"name":"BOTCONNECTORBOTVERSION"},{"name":"BOTFLOW"},{"name":"BRIDGEACTION"},{"name":"COMMONMODULEFLOW"},{"name":"COMPOSERSCRIPT"},{"name":"CONTACTLIST"},{"name":"DATAACTION"},{"name":"DATATABLE"},{"name":"DIALOGENGINEBOT"},{"name":"DIALOGENGINEBOTVERSION"},{"name":"DIALOGFLOWAGENT"},{"name":"EMAILROUTE"},{"name":"EMERGENCYGROUP"},{"name":"FLOWACTION"},{"name":"FLOWDATATYPE"},{"name":"FLOWMILESTONE"},{"name":"FLOWOUTCOME"},{"name":"GROUP"},{"name":"INBOUNDCALLFLOW"},{"name":"INBOUNDCHATFLOW"},{"name":"INBOUNDEMAILFLOW"},{"name":"INBOUNDSHORTMESSAGEFLOW"},{"name":"INQUEUECALLFLOW"},{"name":"IVRCONFIGURATION"},{"name":"LANGUAGE"},{"name":"LEXBOT"},{"name":"LEXBOTALIAS"},{"name":"NLUDOMAIN"},{"name":"OUTBOUNDCALLFLOW"},{"name":"QUEUE"},{"name":"RECORDINGPOLICY"},{"name":"RESPONSE"},{"name":"SCHEDULE"},{"name":"SCHEDULEGROUP"},{"name":"SECUREACTION"},{"name":"SECURECALLFLOW"},{"name":"SURVEYINVITEFLOW"},{"name":"SYSTEMPROMPT"},{"name":"TTSENGINE"},{"name":"TTSVOICE"},{"name":"USER"},{"name":"USERPROMPT"},{"name":"WIDGET"},{"name":"WORKFLOW"}]},"deleted":{"type":"boolean"},"updated":{"type":"boolean"},"stateUnknown":{"type":"boolean"},"consumedResources":{"type":"array","items":{"$ref":"#/definitions/Dependency"}},"consumingResources":{"type":"array","items":{"$ref":"#/definitions/Dependency"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DependencyObjectEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DependencyObject"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ConsumedResourcesEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Dependency"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FlowEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Flow"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"UserRecording":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"contentUri":{"type":"string","format":"uri"},"workspace":{"$ref":"#/definitions/DomainEntityRef"},"createdBy":{"$ref":"#/definitions/DomainEntityRef"},"conversation":{"$ref":"#/definitions/Conversation"},"contentLength":{"type":"integer","format":"int64"},"durationMilliseconds":{"type":"integer","format":"int64"},"thumbnails":{"type":"array","items":{"$ref":"#/definitions/DocumentThumbnail"}},"read":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserRecordingEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UserRecording"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ChangeMyPasswordRequest":{"type":"object","required":["newPassword","oldPassword"],"properties":{"newPassword":{"type":"string","description":"The new password"},"oldPassword":{"type":"string","description":"Your current password"}}},"CredentialSpecification":{"type":"object","properties":{"required":{"type":"boolean","description":"Indicates if the credential must be provided in order for the integration configuration to be valid.","readOnly":true},"title":{"type":"string","description":"Title describing the usage for this credential.","readOnly":true},"credentialTypes":{"type":"array","description":"List of acceptable credential types that can be provided for this credential.","readOnly":true,"items":{"type":"string"}}},"description":"Specifies the requirements for a credential that can be provided for configuring an integration"},"HelpLink":{"type":"object","properties":{"uri":{"type":"string","description":"URI of the help resource","readOnly":true},"title":{"type":"string","description":"Link text of the resource","readOnly":true},"description":{"type":"string","description":"Description of the document or resource","readOnly":true}},"description":"Link to a help or support resource"},"IntegrationType":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the integration type."},"name":{"type":"string"},"description":{"type":"string","description":"Description of the integration type.","readOnly":true},"provider":{"type":"string","description":"PureCloud provider of the integration type.","readOnly":true},"category":{"type":"string","description":"Category describing the integration type.","readOnly":true},"images":{"type":"array","description":"Collection of logos.","readOnly":true,"items":{"$ref":"#/definitions/UserImage"}},"configPropertiesSchemaUri":{"type":"string","description":"URI of the schema describing the key-value properties needed to configure an integration of this type.","readOnly":true},"configAdvancedSchemaUri":{"type":"string","description":"URI of the schema describing the advanced JSON document needed to configure an integration of this type.","readOnly":true},"helpUri":{"type":"string","description":"URI of a page with more information about the integration type","readOnly":true},"termsOfServiceUri":{"type":"string","description":"URI of a page with terms and conditions for the integration type","readOnly":true},"vendorName":{"type":"string","description":"Name of the vendor of this integration type","readOnly":true},"vendorWebsiteUri":{"type":"string","description":"URI of the vendor's website","readOnly":true},"marketplaceUri":{"type":"string","description":"URI of the marketplace listing for this integration type","readOnly":true},"faqUri":{"type":"string","description":"URI of frequently asked questions about the integration type","readOnly":true},"privacyPolicyUri":{"type":"string","description":"URI of a privacy policy for users of the integration type","readOnly":true},"supportContactUri":{"type":"string","description":"URI for vendor support","readOnly":true},"salesContactUri":{"type":"string","description":"URI for vendor sales information","readOnly":true},"helpLinks":{"type":"array","description":"List of links to additional help resources","readOnly":true,"items":{"$ref":"#/definitions/HelpLink"}},"credentials":{"type":"object","description":"Map of credentials for integrations of this type. The key is the name of a credential that can be provided in the credentials property of the integration configuration.","readOnly":true,"additionalProperties":{"$ref":"#/definitions/CredentialSpecification"}},"nonInstallable":{"type":"boolean","description":"Indicates if the integration type is installable or not.","readOnly":true},"maxInstances":{"type":"integer","format":"int32","description":"The maximum number of integration instances allowable for this integration type","readOnly":true},"userPermissions":{"type":"array","description":"List of permissions required to permit user access to the integration type.","readOnly":true,"items":{"type":"string"}},"vendorOAuthClientIds":{"type":"array","description":"List of OAuth Client IDs that must be authorized when the integration is created.","readOnly":true,"items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Descriptor for a type of Integration."},"ChatConversation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"participants":{"type":"array","description":"The list of participants involved in the conversation.","items":{"$ref":"#/definitions/ChatMediaParticipant"}},"otherMediaUris":{"type":"array","description":"The list of other media channels involved in the conversation.","items":{"type":"string","format":"uri"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ChatMediaParticipant":{"type":"object","properties":{"id":{"type":"string","description":"The unique participant ID."},"name":{"type":"string","description":"The display friendly name of the participant."},"address":{"type":"string","description":"The participant address."},"startTime":{"type":"string","format":"date-time","description":"The time when this participant first joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The time when this participant went connected for this media (eg: video connected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startHoldTime":{"type":"string","format":"date-time","description":"The time when this participant's hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"purpose":{"type":"string","description":"The participant's purpose. Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr"},"state":{"type":"string","description":"The participant's state. Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","converting","uploading","transmitting","none"],"x-genesys-enum-members":[{"name":"alerting"},{"name":"dialing"},{"name":"contacting"},{"name":"offering"},{"name":"connected"},{"name":"disconnected"},{"name":"terminated"},{"name":"converting"},{"name":"uploading"},{"name":"transmitting"},{"name":"none"}]},"direction":{"type":"string","description":"The participant's direction. Values can be: 'inbound' or 'outbound'","enum":["inbound","outbound"],"x-genesys-enum-members":[{"name":"inbound"},{"name":"outbound"}]},"disconnectType":{"type":"string","description":"The reason the participant was disconnected from the conversation.","enum":["endpoint","client","system","transfer","transfer.conference","transfer.consult","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam"],"x-genesys-enum-members":[{"name":"endpoint"},{"name":"client"},{"name":"system"},{"name":"transfer"},{"name":"transfer.conference"},{"name":"transfer.consult"},{"name":"transfer.forward"},{"name":"transfer.noanswer"},{"name":"transfer.notavailable"},{"name":"transport.failure"},{"name":"error"},{"name":"peer"},{"name":"other"},{"name":"spam"}]},"held":{"type":"boolean","description":"Value is true when the participant is on hold."},"wrapupRequired":{"type":"boolean","description":"Value is true when the participant requires wrap-up."},"wrapupPrompt":{"type":"string","description":"The wrap-up prompt indicating the type of wrap-up to be performed."},"user":{"description":"The PureCloud user for this participant.","$ref":"#/definitions/DomainEntityRef"},"queue":{"description":"The PureCloud queue for this participant.","$ref":"#/definitions/DomainEntityRef"},"team":{"description":"The PureCloud team for this participant.","$ref":"#/definitions/DomainEntityRef"},"attributes":{"type":"object","description":"A list of ad-hoc attributes for the participant.","additionalProperties":{"type":"string"}},"errorInfo":{"description":"If the conversation ends in error, contains additional error details.","$ref":"#/definitions/ErrorInfo"},"script":{"description":"The Engage script that should be used by this participant.","$ref":"#/definitions/DomainEntityRef"},"wrapupTimeoutMs":{"type":"integer","format":"int32","description":"The amount of time the participant has to complete wrap-up."},"wrapupSkipped":{"type":"boolean","description":"Value is true when the participant has skipped wrap-up."},"alertingTimeoutMs":{"type":"integer","format":"int32","description":"Specifies how long the agent has to answer an interaction before being marked as not responding."},"provider":{"type":"string","description":"The source provider for the communication."},"externalContact":{"description":"If this participant represents an external contact, then this will be the reference for the external contact.","$ref":"#/definitions/DomainEntityRef"},"externalOrganization":{"description":"If this participant represents an external org, then this will be the reference for the external org.","$ref":"#/definitions/DomainEntityRef"},"wrapup":{"description":"Wrapup for this participant, if it has been applied.","$ref":"#/definitions/Wrapup"},"peer":{"type":"string","description":"The peer communication corresponding to a matching leg for this communication."},"flaggedReason":{"type":"string","description":"The reason specifying why participant flagged the conversation.","enum":["general"],"x-genesys-enum-members":[{"name":"general"}]},"journeyContext":{"description":"Journey System data/context that is applicable to this communication. When used for historical purposes, the context should be immutable. When null, there is no applicable Journey System context.","$ref":"#/definitions/JourneyContext"},"conversationRoutingData":{"description":"Information on how a communication should be routed to an agent.","$ref":"#/definitions/ConversationRoutingData"},"startAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"roomId":{"type":"string","description":"The ID of the chat room."},"avatarImageUrl":{"type":"string","description":"If available, the URI to the avatar image of this communication."}}},"CreateWebChatRequest":{"type":"object","required":["provider","queueId"],"properties":{"queueId":{"type":"string","description":"The ID of the queue to use for routing the chat conversation."},"provider":{"type":"string","description":"The name of the provider that is sourcing the web chat."},"skillIds":{"type":"array","description":"The list of skill ID's to use for routing.","items":{"type":"string"}},"languageId":{"type":"string","description":"The ID of the langauge to use for routing."},"priority":{"type":"integer","format":"int64","description":"The priority to assign to the conversation for routing."},"attributes":{"type":"object","description":"The list of attributes to associate with the customer participant.","additionalProperties":{"type":"string"}},"customerName":{"type":"string","description":"The name of the customer participating in the web chat."}}},"ChatConversationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ChatConversation"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ReportSchedule":{"type":"object","required":["interval","quartzCronExpression","reportId"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"quartzCronExpression":{"type":"string","description":"Quartz Cron Expression"},"nextFireTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"description":{"type":"string"},"timeZone":{"type":"string"},"timePeriod":{"type":"string"},"interval":{"type":"string","description":"Interval. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"reportFormat":{"type":"string"},"locale":{"type":"string"},"enabled":{"type":"boolean"},"reportId":{"type":"string","description":"Report ID"},"parameters":{"type":"object","additionalProperties":{"type":"object"}},"lastRun":{"$ref":"#/definitions/ReportRunEntry"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ReportScheduleEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ReportSchedule"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FacebookIntegration":{"type":"object","required":["appId","id","name","version"],"properties":{"id":{"type":"string","description":"A unique Integration Id.","readOnly":true},"name":{"type":"string","description":"The name of the Facebook Integration"},"appId":{"type":"string","description":"The App Id from Facebook messenger"},"pageId":{"type":"string","description":"The Page Id from Facebook messenger"},"status":{"type":"string","description":"The status of the Facebook Integration"},"recipient":{"description":"The recipient reference associated to the Facebook Integration. This recipient is used to associate a flow to an integration","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"dateCreated":{"type":"string","format":"date-time","description":"Date this Integration was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date this Integration was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"description":"User reference that created this Integration","$ref":"#/definitions/DomainEntityRef"},"modifiedBy":{"description":"User reference that last modified this Integration","$ref":"#/definitions/DomainEntityRef"},"version":{"type":"integer","format":"int32","description":"Version number required for updates."},"createStatus":{"type":"string","description":"Status of asynchronous create operation","readOnly":true,"enum":["Initiated","Completed","Error"],"x-genesys-enum-members":[{"name":"Initiated","description":"The integration create request has started"},{"name":"Completed","description":"The integration create request has finished successfully"},{"name":"Error","description":"The integration create request has finished in error."}]},"createError":{"description":"Error information returned, if createStatus is set to Error","readOnly":true,"$ref":"#/definitions/ErrorBody"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FacebookIntegrationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/FacebookIntegration"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"MediaType":{"type":"object","properties":{"type":{"type":"string","description":"The media type string as defined by RFC 2046. You can define specific types such as 'image/jpeg', 'video/mpeg', or specify wild cards for a range of types, 'image/*', or all types '*/*'. See https://www.iana.org/assignments/media-types/media-types.xhtml for a list of registered media types."}},"description":"Media type definition"},"MediaTypeAccess":{"type":"object","properties":{"inbound":{"type":"array","description":"List of media types allowed for inbound messages from customers. If inbound messages from a customer contain media that is not in this list, the media will be dropped from the outbound message.","items":{"$ref":"#/definitions/MediaType"}},"outbound":{"type":"array","description":"List of media types allowed for outbound messages to customers. If an outbound message is sent that contains media that is not in this list, the message will not be sent.","items":{"$ref":"#/definitions/MediaType"}}},"description":"Media type access definitions"},"MediaTypes":{"type":"object","properties":{"allow":{"description":"Specify allowed media types for inbound and outbound messages. If this field is empty, all inbound and outbound media will be blocked.","$ref":"#/definitions/MediaTypeAccess"}},"description":"Media types"},"SupportedContent":{"type":"object","properties":{"mediaTypes":{"description":"Defines the allowable media that may be accepted for an inbound message or to be sent in an outbound message. The following is an example of allowing all inbound media, and for outbound all images and only mpeg video: {\n \"mediaTypes\": {\n \"allow\": {\n \"inbound\": [{\"type\": \"*/*\"}],\n \"outbound\": [{\"type\": \"image/*\"}, {\"type\": \"video/mpeg\"}]\n }\n }\n}","$ref":"#/definitions/MediaTypes"}},"description":"Supported content for inbound and outbound messages"},"FacebookIntegrationRequest":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the Facebook Integration"},"pageAccessToken":{"type":"string","description":"The long-lived Page Access Token of a facebook page. \nSee https://developers.facebook.com/docs/facebook-login/access-tokens. \nWhen a pageAccessToken is provided, pageId and userAccessToken are not required."},"userAccessToken":{"type":"string","description":"The short-lived User Access Token of the facebook user logged into the facebook app. \nSee https://developers.facebook.com/docs/facebook-login/access-tokens. \nWhen userAccessToken is provided, pageId is mandatory. \nWhen userAccessToken/pageId combination is provided, pageAccessToken is not required."},"pageId":{"type":"string","description":"The page Id of a facebook page. The pageId is required when userAccessToken is provided."},"appId":{"type":"string","description":"The app Id of a facebook app. The appId is required when a customer wants to use their own approved facebook app."},"appSecret":{"type":"string","description":"The app Secret of a facebook app. The appSecret is required when appId is provided."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EffectiveConfiguration":{"type":"object","required":["advanced","credentials","name","notes","properties"],"properties":{"properties":{"type":"object","description":"Key-value configuration settings described by the schema in the propertiesSchemaUri field.","additionalProperties":{"type":"object"}},"advanced":{"type":"object","description":"Advanced configuration described by the schema in the advancedSchemaUri field.","additionalProperties":{"type":"object"}},"name":{"type":"string","description":"The name of the integration, used to distinguish this integration from others of the same type."},"notes":{"type":"string","description":"Notes about the integration."},"credentials":{"type":"object","description":"Credentials required by the integration. The required keys are indicated in the credentials property of the Integration Type","additionalProperties":{"$ref":"#/definitions/CredentialInfo"}}},"description":"Effective Configuration for an ClientApp. This is comprised of the integration specific configuration along with overrides specified in the integration type."},"IntegrationConfiguration":{"type":"object","required":["advanced","credentials","name","notes","properties","version"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the integration, used to distinguish this integration from others of the same type."},"version":{"type":"integer","format":"int32","description":"Version number required for updates."},"properties":{"type":"object","description":"Key-value configuration settings described by the schema in the propertiesSchemaUri field."},"advanced":{"type":"object","description":"Advanced configuration described by the schema in the advancedSchemaUri field."},"notes":{"type":"string","description":"Notes about the integration."},"credentials":{"type":"object","description":"Credentials required by the integration. The required keys are indicated in the credentials property of the Integration Type","additionalProperties":{"$ref":"#/definitions/CredentialInfo"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Configuration for an Integration"},"UserApp":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the userApp, used to distinguish this userApp from others of the same type.","readOnly":true},"integrationType":{"description":"Integration Type for the userApp","readOnly":true,"$ref":"#/definitions/IntegrationType"},"config":{"$ref":"#/definitions/UserAppConfigurationInfo"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Details for a UserApp"},"UserAppConfigurationInfo":{"type":"object","properties":{"current":{"description":"The current, active configuration for the integration.","readOnly":true,"$ref":"#/definitions/IntegrationConfiguration"},"effective":{"description":"The effective configuration for the app, containing the integration specific configuration along with overrides specified in the integration type.","readOnly":true,"$ref":"#/definitions/EffectiveConfiguration"}},"description":"Configuration information for the integration"},"UserAppEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UserApp"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ButtonComponent":{"type":"object","properties":{"id":{"type":"string","description":"An ID assigned to this component"},"text":{"type":"string","description":"Deprecated - Use title instead"},"title":{"type":"string","description":"Text to show inside the button"},"actions":{"description":"User actions available on the content. All actions are optional and all actions are executed simultaneously.","$ref":"#/definitions/ContentActions"}},"description":"Structured template button object"},"ContentActions":{"type":"object","properties":{"url":{"type":"string","description":"A URL for a web page to redirect the user to"},"urlTarget":{"type":"string","description":"The target window or tab within the URL's web page. If empty will open a blank page or tab."},"textback":{"type":"string","description":"Text to be sent back in reply when a list item is selected"},"commandName":{"type":"string","description":"Execute an organization's specific command"},"context":{"type":"object","description":"Additional context for the command","additionalProperties":{"type":"object"}}},"description":"User actions available on the content. All actions are optional and all actions are executed simultaneously."},"ContentAttachment":{"type":"object","required":["mediaType"],"properties":{"id":{"type":"string","description":"Vendor specific ID for media. For example, a LINE sticker ID"},"mediaType":{"type":"string","description":"The type of media this instance represents","enum":["Image","Video","Audio","File"],"x-genesys-enum-members":[{"name":"Image"},{"name":"Video"},{"name":"Audio"},{"name":"File"}]},"url":{"type":"string","description":"Content element url"},"mime":{"type":"string","description":"Content mime type from https://www.iana.org/assignments/media-types/media-types.xhtml"},"text":{"type":"string","description":"Text message associated with media element: e.g. caption in case of image."},"sha256":{"type":"string","description":"Secure hash of the media content"},"filename":{"type":"string","description":"Suggested file name for media file"}},"description":"Attachment object"},"ContentGeneric":{"type":"object","properties":{"id":{"type":"string","description":"An ID assigned to this rich message content. Each instance inside the content array has a unique ID."},"title":{"type":"string","description":"Text to show in the title row"},"description":{"type":"string","description":"Text to show in the description row. This is immediately below the title"},"image":{"type":"string","description":"Path or URI to an image file"},"video":{"type":"string","description":"Path or URI to a video file"},"actions":{"description":"User actions available on the content. All actions are optional and all actions are executed simultaneously.","$ref":"#/definitions/ContentActions"},"components":{"type":"array","description":"An array of component objects","items":{"$ref":"#/definitions/ButtonComponent"}}},"description":"Generic content object"},"ContentList":{"type":"object","properties":{"id":{"type":"string","description":"An ID assigned to this rich message content. Each instance inside the content array has a unique ID."},"listType":{"type":"string","description":"The type of list this instance represents","enum":["Selection","Vertical"],"x-genesys-enum-members":[{"name":"Selection"},{"name":"Vertical"}]},"title":{"type":"string","description":"Text to show in the title row"},"description":{"type":"string","description":"Text to show in the description row. This is immediately below the title"},"submitLabel":{"type":"string","description":"Label for Submit button"},"actions":{"description":"User actions available on the content. All actions are optional and all actions are executed simultaneously.","$ref":"#/definitions/ContentActions"},"components":{"type":"array","description":"An array of component objects","items":{"$ref":"#/definitions/ListItemComponent"}}},"description":"List content object"},"ContentLocation":{"type":"object","properties":{"url":{"type":"string","description":"Location map url"},"address":{"type":"string","description":"Location postal address"},"text":{"type":"string","description":"Location name"},"latitude":{"type":"number","format":"double","description":"Latitude of the location"},"longitude":{"type":"number","format":"double","description":"Longitude of the location"}},"description":"Location object"},"ContentNotificationTemplate":{"type":"object","required":["body"],"properties":{"id":{"type":"string","description":"The messaging channel template id. For WhatsApp, 'namespace@name'"},"language":{"type":"string","description":"Template language"},"header":{"description":"Template header object","$ref":"#/definitions/NotificationTemplateHeader"},"body":{"description":"Template body object","$ref":"#/definitions/NotificationTemplateBody"},"footer":{"description":"Template footer object","$ref":"#/definitions/NotificationTemplateFooter"}},"description":"Template notification object"},"ContentPostback":{"type":"object","required":["payload"],"properties":{"id":{"type":"string","description":"An ID assigned to the postback reply. Each object inside the content array has a unique ID."},"text":{"type":"string","description":"The text inside the button clicked (in the structured message template)"},"payload":{"type":"string","description":"Content of the textback payload after clicking a quick reply"}},"description":"The postback object result of a user clicking in a button"},"ContentQuickReply":{"type":"object","required":["text"],"properties":{"id":{"type":"string","description":"An ID assigned to the quick reply. Each object inside the content array has a unique ID."},"text":{"type":"string","description":"Text to show inside the quick reply. This is also used as the response text after clicking on the quick reply."},"payload":{"type":"string","description":"Content of the textback payload after clicking a quick reply"},"image":{"type":"string","description":"Image associated with quick reply"},"action":{"type":"string","description":"Specifies the type of action that is triggered upon clicking the quick reply. Currently, the only supported action is \"Message\" which sends a message using the quick reply text.","enum":["Message"],"x-genesys-enum-members":[{"name":"Message"}]}},"description":"Quick reply object"},"ContentReaction":{"type":"object","properties":{"reactionType":{"type":"string","description":"Type of reaction","enum":["None","Like","Love","Wow","Haha","Sad","Angry","Thankful","Pride","Care"],"x-genesys-enum-members":[{"name":"None"},{"name":"Like"},{"name":"Love"},{"name":"Wow"},{"name":"Haha"},{"name":"Sad"},{"name":"Angry"},{"name":"Thankful"},{"name":"Pride"},{"name":"Care"}]},"count":{"type":"integer","format":"int32","description":"Number of users that reacted this way to this public message"}},"description":"User reaction to public message"},"ListItemComponent":{"type":"object","properties":{"id":{"type":"string","description":"An ID assigned to this component"},"rmid":{"type":"string","description":"An ID of the rich message instance"},"type":{"type":"string","description":"The type of component to render","enum":["ListItem","ListItemBig"],"x-genesys-enum-members":[{"name":"ListItem"},{"name":"ListItemBig"}]},"image":{"type":"string","description":"Path or URI to an image file"},"title":{"type":"string","description":"The main headline of the list item"},"description":{"type":"string","description":"Text to show in the description row"},"actions":{"description":"User actions available on the content. All actions are optional and all actions are executed simultaneously.","$ref":"#/definitions/ContentActions"}},"description":"An entry in List template"},"MessageContent":{"type":"object","required":["contentType"],"properties":{"contentType":{"type":"string","description":"Type of this content element. If contentType = \"Attachment\" only one item is allowed.","enum":["Attachment","Location","QuickReply","Notification","GenericTemplate","ListTemplate","Postback","Reactions","Mention"],"x-genesys-enum-members":[{"name":"Attachment"},{"name":"Location"},{"name":"QuickReply"},{"name":"Notification"},{"name":"GenericTemplate"},{"name":"ListTemplate"},{"name":"Postback"},{"name":"Reactions"},{"name":"Mention"}]},"location":{"description":"Location object","$ref":"#/definitions/ContentLocation"},"attachment":{"description":"Attachment object","$ref":"#/definitions/ContentAttachment"},"quickReply":{"description":"Quick reply object","$ref":"#/definitions/ContentQuickReply"},"generic":{"description":"Generic content object","$ref":"#/definitions/ContentGeneric"},"list":{"description":"List content object","$ref":"#/definitions/ContentList"},"template":{"description":"Template notification object","$ref":"#/definitions/ContentNotificationTemplate"},"reactions":{"type":"array","description":"A list of reactions","items":{"$ref":"#/definitions/ContentReaction"}},"mention":{"description":"This is used to identify who the message is sent to, as well as who it was sent from. This information is channel specific - depends on capabilities to describe party by the platform","$ref":"#/definitions/MessagingRecipient"},"postback":{"description":"The postback object result of a user clicking in a button","$ref":"#/definitions/ContentPostback"}},"description":"Message content element"},"MessagingRecipient":{"type":"object","required":["id"],"properties":{"nickname":{"type":"string","description":"Nickname/user name","readOnly":true},"id":{"type":"string","description":"The recipient identifier specific for particular channel/integration. This is required when sending a message."},"image":{"type":"string","description":"Avatar image","readOnly":true},"firstName":{"type":"string","description":"Sender's first name","readOnly":true},"lastName":{"type":"string","description":"Sender's last name","readOnly":true},"email":{"type":"string","description":"Sender's email address","readOnly":true}},"description":"This is used to identify who the message is sent to, as well as who it was sent from. This information is channel specific - depends on capabilities to describe party by the platform"},"NotificationTemplateBody":{"type":"object","required":["parameters"],"properties":{"text":{"type":"string","description":"Body text. For WhatsApp, ignored"},"parameters":{"type":"array","description":"Template parameters for placeholders in template","items":{"$ref":"#/definitions/NotificationTemplateParameter"}}},"description":"Template body object"},"NotificationTemplateFooter":{"type":"object","properties":{"text":{"type":"string","description":"Footer text. For WhatsApp, ignored"}},"description":"Template footer object"},"NotificationTemplateHeader":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Template header type","enum":["Text","Media"],"x-genesys-enum-members":[{"name":"Text"},{"name":"Media"}]},"text":{"type":"string","description":"Header text. For WhatsApp, ignored"},"media":{"description":"Attachment object","$ref":"#/definitions/ContentAttachment"},"parameters":{"type":"array","description":"Template parameters for placeholders in template","items":{"$ref":"#/definitions/NotificationTemplateParameter"}}},"description":"Template header object"},"NotificationTemplateParameter":{"type":"object","required":["text"],"properties":{"name":{"type":"string","description":"Parameter name"},"text":{"type":"string","description":"Parameter text value"}},"description":"Parameters for placeholders in template"},"BuScheduleReferenceForMuRoute":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"weekDate":{"type":"string","format":"date","description":"The start week date for this schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"businessUnit":{"description":"The start week date for this schedule","$ref":"#/definitions/BusinessUnitReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ShiftTradeListResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ShiftTradeResponse"}}}},"ShiftTradeResponse":{"type":"object","properties":{"id":{"type":"string","description":"The ID of this shift trade"},"weekDate":{"type":"string","format":"date","description":"The start week date of the associated schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"schedule":{"description":"A reference to the associated schedule","$ref":"#/definitions/BuScheduleReferenceForMuRoute"},"state":{"type":"string","description":"The state of this shift trade","enum":["Unmatched","Matched","Approved","Denied","Expired","Canceled"],"x-genesys-enum-members":[{"name":"Unmatched"},{"name":"Matched"},{"name":"Approved"},{"name":"Denied"},{"name":"Expired"},{"name":"Canceled"}]},"initiatingUser":{"description":"The user who initiated this trade","$ref":"#/definitions/UserReference"},"initiatingShiftId":{"type":"string","description":"The ID of the shift offered for trade by the initiating user"},"initiatingShiftStart":{"type":"string","format":"date-time","description":"The start date/time of the shift being offered for trade. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"initiatingShiftEnd":{"type":"string","format":"date-time","description":"The end date/time of the shift being offered for trade. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"receivingUser":{"description":"The user matching the trade, or if the state is not Matched, the user to whom the trade request was sent","$ref":"#/definitions/UserReference"},"receivingShiftId":{"type":"string","description":"The ID of the shift being exchanged for the initiating shift, null if the receiving user is picking up a shift"},"receivingShiftStart":{"type":"string","format":"date-time","description":"The start date/time of the receiving shift. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"receivingShiftEnd":{"type":"string","format":"date-time","description":"The end date/time of the receiving shift. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"expiration":{"type":"string","format":"date-time","description":"When this shift trade offer will expire if not matched or approved. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"oneSided":{"type":"boolean","description":"Whether this is a one-sided shift trade (e.g. the initiating user is not asking for a shift in return)"},"acceptableIntervals":{"type":"array","items":{"type":"string","description":"Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"}},"reviewedBy":{"description":"The user who reviewed this shift trade","$ref":"#/definitions/UserReference"},"reviewedDate":{"type":"string","format":"date-time","description":"The timestamp when this shift trade was reviewed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"metadata":{"description":"Version data for this trade","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"ActionTemplate":{"type":"object","required":["mediaType","name","state"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Name of the action template."},"description":{"type":"string","description":"Description of the action template's functionality."},"mediaType":{"type":"string","description":"Media type of action described by the action template.","enum":["webchat","webMessagingOffer","contentOffer","integrationAction","architectFlow"],"x-genesys-enum-members":[{"name":"webchat"},{"name":"webMessagingOffer"},{"name":"contentOffer"},{"name":"integrationAction"},{"name":"architectFlow"}]},"state":{"type":"string","description":"Whether the action template is currently active, inactive or deleted.","enum":["Active","Inactive","Deleted"],"x-genesys-enum-members":[{"name":"Active"},{"name":"Inactive"},{"name":"Deleted"}]},"contentOffer":{"description":"Properties used to configure an action of type content offer","$ref":"#/definitions/ContentOffer"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"createdDate":{"type":"string","format":"date-time","description":"Date when action template was created in ISO-8601 format.","readOnly":true},"modifiedDate":{"type":"string","format":"date-time","description":"Date when action template was last modified in ISO-8601 format.","readOnly":true}}},"CallToAction":{"type":"object","required":["url"],"properties":{"text":{"type":"string","description":"Text displayed on the call to action button."},"url":{"type":"string","description":"URL to open when user clicks on the call to action button."},"target":{"type":"string","description":"Where the URL should be opened when the user clicks on the call to action button.","enum":["Blank","Self"],"x-genesys-enum-members":[{"name":"Blank"},{"name":"Self"}]}}},"CloseButtonStyleProperties":{"type":"object","properties":{"color":{"type":"string","description":"Color of button. (eg. #FF0000)"},"opacity":{"type":"number","format":"float","description":"Opacity of button."}}},"ContentOffer":{"type":"object","required":["displayMode","layoutMode"],"properties":{"imageUrl":{"type":"string","description":"URL for image displayed to the customer when displaying content offer."},"displayMode":{"type":"string","description":"The display mode of Genesys Widgets when displaying content offer.","enum":["Modal","Overlay","Toast"],"x-genesys-enum-members":[{"name":"Modal"},{"name":"Overlay"},{"name":"Toast"}]},"layoutMode":{"type":"string","description":"The layout mode of the text shown to the user when displaying content offer.","enum":["TextOnly","ImageOnly","LeftText","RightText","TopText","BottomText"],"x-genesys-enum-members":[{"name":"TextOnly"},{"name":"ImageOnly"},{"name":"LeftText"},{"name":"RightText"},{"name":"TopText"},{"name":"BottomText"}]},"title":{"type":"string","description":"Title used in the header of the content offer."},"headline":{"type":"string","description":"Headline displayed above the body text of the content offer."},"body":{"type":"string","description":"Body text of the content offer."},"callToAction":{"description":"Properties customizing the call to action button on the content offer.","$ref":"#/definitions/CallToAction"},"style":{"description":"Properties customizing the styling of the content offer.","$ref":"#/definitions/ContentOfferStylingConfiguration"}}},"ContentOfferStyleProperties":{"type":"object","properties":{"padding":{"type":"string","description":"Padding of the offer. (eg. 10px)"},"color":{"type":"string","description":"Text color of the offer. (eg. #FF0000)"},"backgroundColor":{"type":"string","description":"Background color of the offer. (eg. #000000)"}}},"ContentOfferStylingConfiguration":{"type":"object","properties":{"position":{"description":"Properties for customizing the positioning of the content offer.","$ref":"#/definitions/ContentPositionProperties"},"offer":{"description":"Properties for customizing the appearance of the content offer.","$ref":"#/definitions/ContentOfferStyleProperties"},"closeButton":{"description":"Properties for customizing the appearance of the close button.","$ref":"#/definitions/CloseButtonStyleProperties"},"ctaButton":{"description":"Properties for customizing the appearance of the CTA button.","$ref":"#/definitions/CtaButtonStyleProperties"},"title":{"description":"Properties for customizing the appearance of the title text.","$ref":"#/definitions/TextStyleProperties"},"headline":{"description":"Properties for customizing the appearance of the headline text.","$ref":"#/definitions/TextStyleProperties"},"body":{"description":"Properties for customizing the appearance of the body text.","$ref":"#/definitions/TextStyleProperties"}}},"ContentPositionProperties":{"type":"object","properties":{"top":{"type":"string","description":"Top positioning offset."},"bottom":{"type":"string","description":"Bottom positioning offset."},"left":{"type":"string","description":"Left positioning offset."},"right":{"type":"string","description":"Right positioning offset."}}},"CtaButtonStyleProperties":{"type":"object","properties":{"color":{"type":"string","description":"Color of the text. (eg. #FFFFFF)"},"font":{"type":"string","description":"Font of the text. (eg. Helvetica)"},"fontSize":{"type":"string","description":"Font size of the text. (eg. '12')"},"textAlign":{"type":"string","description":"Text alignment.","enum":["Left","Right","Center"],"x-genesys-enum-members":[{"name":"Left"},{"name":"Right"},{"name":"Center"}]},"backgroundColor":{"type":"string","description":"Background color of the CTA button. (eg. #FF0000)"}}},"IntegrationAction":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"IntegrationActionFields":{"type":"object","properties":{"integrationAction":{"description":"Reference to the Integration Action to be used when integrationAction type is qualified","$ref":"#/definitions/IntegrationAction"},"requestMappings":{"type":"array","description":"Collection of Request Mappings to use","items":{"$ref":"#/definitions/RequestMapping"}}}},"RequestMapping":{"type":"object","properties":{"name":{"type":"string","description":"Name of the Integration Action Attribute to supply the value for"},"attributeType":{"type":"string","description":"Type of the value supplied","enum":["String","Number","Integer","Boolean"],"x-genesys-enum-members":[{"name":"String"},{"name":"Number"},{"name":"Integer"},{"name":"Boolean"}]},"mappingType":{"type":"string","description":"Method of finding value to use with Attribute","enum":["Lookup","HardCoded"],"x-genesys-enum-members":[{"name":"Lookup"},{"name":"HardCoded"}]},"value":{"type":"string","description":"Value to supply for the specified Attribute"}}},"TextStyleProperties":{"type":"object","properties":{"color":{"type":"string","description":"Color of the text. (eg. #FFFFFF)"},"font":{"type":"string","description":"Font of the text. (eg. Helvetica)"},"fontSize":{"type":"string","description":"Font size of the text. (eg. '12')"},"textAlign":{"type":"string","description":"Text alignment.","enum":["Left","Right","Center"],"x-genesys-enum-members":[{"name":"Left"},{"name":"Right"},{"name":"Center"}]}}},"PatchActionTemplate":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name of the action template."},"description":{"type":"string","description":"Description of the action template's functionality."},"mediaType":{"type":"string","description":"Media type of action described by the action template.","enum":["webchat","webMessagingOffer","contentOffer","integrationAction","architectFlow"],"x-genesys-enum-members":[{"name":"webchat"},{"name":"webMessagingOffer"},{"name":"contentOffer"},{"name":"integrationAction"},{"name":"architectFlow"}]},"state":{"type":"string","description":"Whether the action template is currently active, inactive or deleted.","enum":["Active","Inactive","Deleted"],"x-genesys-enum-members":[{"name":"Active"},{"name":"Inactive"},{"name":"Deleted"}]},"contentOffer":{"description":"Properties used to configure an action of type content offer","$ref":"#/definitions/PatchContentOffer"}}},"PatchCallToAction":{"type":"object","properties":{"text":{"type":"string","description":"Text displayed on the call to action button."},"url":{"type":"string","description":"URL to open when user clicks on the call to action button."},"target":{"type":"string","description":"Where the URL should be opened when the user clicks on the call to action button.","enum":["Blank","Self"],"x-genesys-enum-members":[{"name":"Blank"},{"name":"Self"}]}}},"PatchCloseButtonStyleProperties":{"type":"object","properties":{"color":{"type":"string","description":"Color of button. (eg. #FF0000)"},"opacity":{"type":"number","format":"float","description":"Opacity of button."}}},"PatchContentOffer":{"type":"object","properties":{"imageUrl":{"type":"string","description":"URL for image displayed to the customer when displaying content offer."},"displayMode":{"type":"string","description":"The display mode of Genesys Widgets when displaying content offer.","enum":["Modal","Overlay","Toast"],"x-genesys-enum-members":[{"name":"Modal"},{"name":"Overlay"},{"name":"Toast"}]},"layoutMode":{"type":"string","description":"The layout mode of the text shown to the user when displaying content offer.","enum":["TextOnly","ImageOnly","LeftText","RightText","TopText","BottomText"],"x-genesys-enum-members":[{"name":"TextOnly"},{"name":"ImageOnly"},{"name":"LeftText"},{"name":"RightText"},{"name":"TopText"},{"name":"BottomText"}]},"title":{"type":"string","description":"Title used in the header of the content offer."},"headline":{"type":"string","description":"Headline displayed above the body text of the content offer."},"body":{"type":"string","description":"Body text of the content offer."},"callToAction":{"description":"Properties customizing the call to action button on the content offer.","$ref":"#/definitions/PatchCallToAction"},"style":{"description":"Properties customizing the styling of the content offer.","$ref":"#/definitions/PatchContentOfferStylingConfiguration"}}},"PatchContentOfferStyleProperties":{"type":"object","properties":{"padding":{"type":"string","description":"Padding of the offer. (eg. 10px)"},"color":{"type":"string","description":"Text color of the offer. (eg. #FF0000)"},"backgroundColor":{"type":"string","description":"Background color of the offer. (eg. #000000)"}}},"PatchContentOfferStylingConfiguration":{"type":"object","properties":{"position":{"description":"Properties for customizing the positioning of the content offer.","$ref":"#/definitions/PatchContentPositionProperties"},"offer":{"description":"Properties for customizing the appearance of the content offer.","$ref":"#/definitions/PatchContentOfferStyleProperties"},"closeButton":{"description":"Properties for customizing the appearance of the close button.","$ref":"#/definitions/PatchCloseButtonStyleProperties"},"ctaButton":{"description":"Properties for customizing the appearance of the CTA button.","$ref":"#/definitions/PatchCtaButtonStyleProperties"},"title":{"description":"Properties for customizing the appearance of the title text.","$ref":"#/definitions/PatchTextStyleProperties"},"headline":{"description":"Properties for customizing the appearance of the headline text.","$ref":"#/definitions/PatchTextStyleProperties"},"body":{"description":"Properties for customizing the appearance of the body text.","$ref":"#/definitions/PatchTextStyleProperties"}}},"PatchContentPositionProperties":{"type":"object","properties":{"top":{"type":"string","description":"Top positioning offset."},"bottom":{"type":"string","description":"Bottom positioning offset."},"left":{"type":"string","description":"Left positioning offset."},"right":{"type":"string","description":"Right positioning offset."}}},"PatchCtaButtonStyleProperties":{"type":"object","properties":{"color":{"type":"string","description":"Color of the text. (eg. #FFFFFF)"},"font":{"type":"string","description":"Font of the text. (eg. Helvetica)"},"fontSize":{"type":"string","description":"Font size of the text. (eg. '12')"},"textAlign":{"type":"string","description":"Text alignment.","enum":["Left","Right","Center"],"x-genesys-enum-members":[{"name":"Left"},{"name":"Right"},{"name":"Center"}]},"backgroundColor":{"type":"string","description":"Background color of the CTA button. (eg. #A04033)"}}},"PatchIntegrationAction":{"type":"object","properties":{"id":{"type":"string","description":"ID of the integration action to be invoked."}}},"PatchIntegrationActionFields":{"type":"object","properties":{"integrationAction":{"description":"Reference to the Integration Action to be used when integrationAction type is qualified","$ref":"#/definitions/PatchIntegrationAction"},"requestMappings":{"type":"array","description":"Collection of Request Mappings to use","items":{"$ref":"#/definitions/RequestMapping"}}}},"PatchTextStyleProperties":{"type":"object","properties":{"color":{"type":"string","description":"Color of the text. (eg. #FFFFFF)"},"font":{"type":"string","description":"Font of the text. (eg. Helvetica)"},"fontSize":{"type":"string","description":"Font size of the text. (eg. '12')"},"textAlign":{"type":"string","description":"Text alignment.","enum":["Left","Right","Center"],"x-genesys-enum-members":[{"name":"Left"},{"name":"Right"},{"name":"Center"}]}}},"GDPRSubjectEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/GDPRSubject"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"WebChatGuestMediaRequest":{"type":"object","required":["state","types"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"types":{"type":"array","description":"The types of media being requested.","items":{"type":"string","enum":["COBROWSE","SCREENSHARE"],"x-genesys-enum-members":[{"name":"COBROWSE"},{"name":"SCREENSHARE"}]}},"state":{"type":"string","description":"The state of the media request, one of PENDING|ACCEPTED|DECLINED|TIMEDOUT|CANCELLED|ERRORED.","enum":["PENDING","ACCEPTED","DECLINED","TIMEDOUT","CANCELLED","ERRORED"],"x-genesys-enum-members":[{"name":"PENDING"},{"name":"ACCEPTED"},{"name":"DECLINED"},{"name":"TIMEDOUT"},{"name":"CANCELLED"},{"name":"ERRORED"}]},"communicationId":{"type":"string","description":"The ID of the new media communication, if applicable."},"securityKey":{"type":"string","description":"The security information related to a media request."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Object representing the guest model of a media request of a chat conversation."},"WebChatGuestMediaRequestEntityList":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WebChatGuestMediaRequest"}}}},"BuAsyncScheduleResponse":{"type":"object","properties":{"status":{"type":"string","description":"The status of the operation","enum":["Processing","Complete","Canceled","Error"],"x-genesys-enum-members":[{"name":"Processing"},{"name":"Complete"},{"name":"Canceled"},{"name":"Error"}]},"operationId":{"type":"string","description":"The ID for the operation"},"result":{"description":"The result of the operation. Null unless status == Complete","$ref":"#/definitions/BuScheduleMetadata"}}},"BuManagementUnitScheduleSummary":{"type":"object","properties":{"managementUnit":{"description":"The management unit to which this summary applies","$ref":"#/definitions/ManagementUnitReference"},"agentCount":{"type":"integer","format":"int32","description":"The number of agents from this management unit that are in the schedule"},"startDate":{"type":"string","format":"date-time","description":"The start of the schedule change in the management unit. Only populated in schedule update notifications. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endDate":{"type":"string","format":"date-time","description":"The end of the schedule change in the management unit. Only populated in schedule update notifications. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"agents":{"type":"array","description":"The agents in the management unit who are part of this schedule, or in schedule change notifications, the agents that were changed. Note this will come back as an empty list unless the appropriate expand query parameter is passed","items":{"$ref":"#/definitions/UserReference"}}}},"BuScheduleMetadata":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"weekDate":{"type":"string","format":"date","description":"The start week date for this schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"weekCount":{"type":"integer","format":"int32","description":"The number of weeks spanned by this schedule"},"description":{"type":"string","description":"The description of this schedule"},"published":{"type":"boolean","description":"Whether this schedule is published"},"shortTermForecast":{"description":"The forecast used for this schedule, if applicable","$ref":"#/definitions/BuShortTermForecastReference"},"generationResults":{"description":"Generation result summary for this schedule, if applicable","$ref":"#/definitions/ScheduleGenerationResultSummary"},"metadata":{"description":"Version metadata for this schedule","$ref":"#/definitions/WfmVersionedEntityMetadata"},"managementUnits":{"type":"array","description":"High level per-management unit schedule metadata","items":{"$ref":"#/definitions/BuManagementUnitScheduleSummary"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BuShortTermForecastReference":{"type":"object","required":["weekDate"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"weekDate":{"type":"string","format":"date","description":"The weekDate of the short term forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"description":{"type":"string","description":"The description of the short term forecast","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"A pointer to a short term forecast"},"ManagementUnitReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Management unit reference object for Workforce Management (ID/selfUri only)"},"ScheduleGenerationResultSummary":{"type":"object","properties":{"failed":{"type":"boolean","description":"Whether the schedule generation run failed"},"runId":{"type":"string","description":"The run ID for the schedule generation. Reference this when requesting support"},"messageCount":{"type":"integer","format":"int32","description":"The number of schedule generation messages for this schedule generation run"}}},"BuCopyScheduleRequest":{"type":"object","required":["description","weekDate"],"properties":{"description":{"type":"string","description":"The description for the new schedule"},"weekDate":{"type":"string","format":"date","description":"The start weekDate for the new copy of the schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"}}},"BuAsyncScheduleRunResponse":{"type":"object","properties":{"status":{"type":"string","description":"The status of the operation","enum":["Processing","Complete","Canceled","Error"],"x-genesys-enum-members":[{"name":"Processing"},{"name":"Complete"},{"name":"Canceled"},{"name":"Error"}]},"operationId":{"type":"string","description":"The ID for the operation"},"result":{"description":"The result of the operation. Null unless status == Complete","$ref":"#/definitions/BuScheduleRun"}}},"BuScheduleReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"weekDate":{"type":"string","format":"date","description":"The start week date for this schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BuScheduleRun":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"schedulerRunId":{"type":"string","description":"The scheduler run ID. Reference this value for support"},"intradayRescheduling":{"type":"boolean","description":"Whether this is an intraday rescheduling run"},"state":{"type":"string","description":"The state of the generation run","enum":["None","Queued","Scheduling","Canceled","Failed","Complete"],"x-genesys-enum-members":[{"name":"None"},{"name":"Queued"},{"name":"Scheduling"},{"name":"Canceled"},{"name":"Failed"},{"name":"Complete"}]},"weekCount":{"type":"integer","format":"int32","description":"The number of weeks spanned by the schedule"},"percentComplete":{"type":"number","format":"double","description":"Percent completion of the schedule run"},"targetWeek":{"type":"string","format":"date","description":"The start date of the target week. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"schedule":{"description":"The generated schedule. Null unless the schedule run is complete","$ref":"#/definitions/BuScheduleReference"},"scheduleDescription":{"type":"string","description":"The description of the generated schedule"},"schedulingStartTime":{"type":"string","format":"date-time","description":"When the schedule generation run started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"schedulingStartedBy":{"description":"The user who started the scheduling run","$ref":"#/definitions/UserReference"},"schedulingCanceledBy":{"description":"The user who canceled the scheduling run, if applicable","$ref":"#/definitions/UserReference"},"schedulingCompletedTime":{"type":"string","format":"date-time","description":"When the scheduling run was completed, if applicable. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"messageCount":{"type":"integer","format":"int32","description":"The number of schedule generation messages for this schedule generation run"},"reschedulingOptions":{"description":"Rescheduling options for this run. Null unless intradayRescheduling is true","$ref":"#/definitions/ReschedulingOptionsRunResponse"},"reschedulingResultExpiration":{"type":"string","format":"date-time","description":"When the reschedule result will expire. Null unless intradayRescheduling is true. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ReschedulingManagementUnitResponse":{"type":"object","properties":{"managementUnit":{"description":"The management unit","$ref":"#/definitions/ManagementUnitReference"},"applied":{"type":"boolean","description":"Whether the rescheduling run is applied for the given management unit"}}},"ReschedulingOptionsRunResponse":{"type":"object","properties":{"existingSchedule":{"description":"The existing schedule to which this reschedule run applies","$ref":"#/definitions/BuScheduleReference"},"startDate":{"type":"string","format":"date-time","description":"The start date of the period to reschedule. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endDate":{"type":"string","format":"date-time","description":"The end date of the period to reschedule. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"managementUnits":{"type":"array","description":"Per-management unit rescheduling options","items":{"$ref":"#/definitions/ReschedulingManagementUnitResponse"}},"agentCount":{"type":"integer","format":"int32","description":"The number of agents to be considered in the reschedule"},"activityCodeIds":{"type":"array","description":"The IDs of the activity codes being considered for reschedule","uniqueItems":true,"items":{"type":"string"}},"doNotChangeWeeklyPaidTime":{"type":"boolean","description":"Whether weekly paid time is allowed to be changed"},"doNotChangeDailyPaidTime":{"type":"boolean","description":"Whether daily paid time is allowed to be changed"},"doNotChangeShiftStartTimes":{"type":"boolean","description":"Whether shift start times are allowed to be changed"},"doNotChangeManuallyEditedShifts":{"type":"boolean","description":"Whether manually edited shifts are allowed to be changed"}}},"BuRescheduleRequest":{"type":"object","required":["doNotChangeDailyPaidTime","doNotChangeManuallyEditedShifts","doNotChangeShiftStartTimes","doNotChangeWeeklyPaidTime","managementUnitIds"],"properties":{"startDate":{"type":"string","format":"date-time","description":"The start of the range to reschedule. Defaults to the beginning of the schedule. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endDate":{"type":"string","format":"date-time","description":"The end of the range to reschedule. Defaults the the end of the schedule. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"agentIds":{"type":"array","description":"The IDs of the agents to consider for rescheduling. Omit to consider all agents in the specified management units.Agents not in the specified management units will be ignored","items":{"type":"string"}},"activityCodeIds":{"type":"array","description":"The IDs of the activity codes to consider for rescheduling. Omit to consider all activity codes","items":{"type":"string"}},"managementUnitIds":{"type":"array","description":"The IDs of the management units to reschedule","items":{"type":"string"}},"doNotChangeWeeklyPaidTime":{"type":"boolean","description":"Instructs the scheduler whether it is allowed to change weekly paid time"},"doNotChangeDailyPaidTime":{"type":"boolean","description":"Instructs the scheduler whether it is allowed to change daily paid time"},"doNotChangeShiftStartTimes":{"type":"boolean","description":"Instructs the scheduler whether it is allowed to change shift start times"},"doNotChangeManuallyEditedShifts":{"type":"boolean","description":"Instructs the scheduler whether it is allowed to change manually edited shifts"}}},"SchedulingTestingOptionsRequest":{"type":"object","properties":{"fastScheduling":{"type":"boolean","description":"Whether to enable fast scheduling"},"delayScheduling":{"type":"boolean","description":"Whether to force delayed scheduling"},"failScheduling":{"type":"boolean","description":"Whether to force scheduling to fail"},"populateWarnings":{"type":"boolean","description":"Whether to populate warnings in the generated schedule"}}},"BuGenerateScheduleRequest":{"type":"object","required":["description","shortTermForecast","weekCount"],"properties":{"description":{"type":"string","description":"The description for the schedule"},"shortTermForecast":{"description":"The forecast to use when generating the schedule. Note that the forecast must fully encompass the schedule's start week + week count","$ref":"#/definitions/BuShortTermForecastReference"},"weekCount":{"type":"integer","format":"int32","description":"The number of weeks in the schedule. One extra day is added at the end"}}},"BuScheduleListItem":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"weekDate":{"type":"string","format":"date","description":"The start week date for this schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"weekCount":{"type":"integer","format":"int32","description":"The number of weeks spanned by this schedule"},"description":{"type":"string","description":"The description of this schedule"},"published":{"type":"boolean","description":"Whether this schedule is published"},"shortTermForecast":{"description":"The forecast used for this schedule, if applicable","$ref":"#/definitions/BuShortTermForecastReference"},"generationResults":{"description":"Generation result summary for this schedule, if applicable","$ref":"#/definitions/ScheduleGenerationResultSummary"},"metadata":{"description":"Version metadata for this schedule","$ref":"#/definitions/WfmVersionedEntityMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BuScheduleListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/BuScheduleListItem"}}}},"BuCreateBlankScheduleRequest":{"type":"object","required":["description","weekCount"],"properties":{"description":{"type":"string","description":"The description for the schedule"},"shortTermForecast":{"description":"The forecast to use when generating the schedule. Note that the forecast must fully encompass the schedule's start week + week count","$ref":"#/definitions/BuShortTermForecastReference"},"weekCount":{"type":"integer","format":"int32","description":"The number of weeks in the schedule. One extra day is added at the end"}}},"ScheduleGenerationMessage":{"type":"object","properties":{"type":{"type":"string","description":"The type of the message","enum":["AgentNotFound","AgentNotInSelectedManagementUnit","AgentNotLicensed","AgentWithoutWorkPlan","WorkPlanNotEnabled","WorkPlanNotFound","AgentWithoutCapability","NoNeedDays","UnableToProduceAgentSchedule","UnableToScheduleMaxConsecutiveWorkingDays","UnableToScheduleMaxConsecutiveWorkingWeekends","UnableToScheduleMaxWeeklyPaidTime","UnableToScheduleMaxWeeklyWorkDays","UnableToScheduleMaxWorkDayPaidTime","UnableToScheduleMinConsecutiveNonWorkingTimePerWeek","UnableToScheduleMinIntershiftTime","UnableToScheduleMinShiftStartDistance","UnableToScheduleMinWeeklyPaidTime","UnableToScheduleMinWeeklyWorkDays","UnableToScheduleMinWorkDayPaidTime","UnableToSchedulePlanningPeriodMaxDaysOff","UnableToSchedulePlanningPeriodMaxPaidTime","UnableToSchedulePlanningPeriodMinDaysOff","UnableToSchedulePlanningPeriodMinPaidTime","UnableToScheduleShiftVariance","UnableToScheduleWorkDay"],"x-genesys-enum-members":[{"name":"AgentNotFound"},{"name":"AgentNotInSelectedManagementUnit"},{"name":"AgentNotLicensed"},{"name":"AgentWithoutWorkPlan"},{"name":"WorkPlanNotEnabled"},{"name":"WorkPlanNotFound"},{"name":"AgentWithoutCapability"},{"name":"NoNeedDays"},{"name":"UnableToProduceAgentSchedule"},{"name":"UnableToScheduleMaxConsecutiveWorkingDays"},{"name":"UnableToScheduleMaxConsecutiveWorkingWeekends"},{"name":"UnableToScheduleMaxWeeklyPaidTime"},{"name":"UnableToScheduleMaxWeeklyWorkDays"},{"name":"UnableToScheduleMaxWorkDayPaidTime"},{"name":"UnableToScheduleMinConsecutiveNonWorkingTimePerWeek"},{"name":"UnableToScheduleMinIntershiftTime"},{"name":"UnableToScheduleMinShiftStartDistance"},{"name":"UnableToScheduleMinWeeklyPaidTime"},{"name":"UnableToScheduleMinWeeklyWorkDays"},{"name":"UnableToScheduleMinWorkDayPaidTime"},{"name":"UnableToSchedulePlanningPeriodMaxDaysOff"},{"name":"UnableToSchedulePlanningPeriodMaxPaidTime"},{"name":"UnableToSchedulePlanningPeriodMinDaysOff"},{"name":"UnableToSchedulePlanningPeriodMinPaidTime"},{"name":"UnableToScheduleShiftVariance"},{"name":"UnableToScheduleWorkDay"}]},"arguments":{"type":"array","description":"The arguments describing the message","items":{"$ref":"#/definitions/SchedulerMessageArgument"}}}},"ScheduleGenerationResult":{"type":"object","properties":{"failed":{"type":"boolean","description":"Whether the schedule generation run failed"},"runId":{"type":"string","description":"The run ID for the schedule generation. Reference this when requesting support"},"messageCount":{"type":"integer","format":"int32","description":"The number of schedule generation messages for this schedule generation run"},"messages":{"type":"array","description":"User facing messages related to the schedule generation run","items":{"$ref":"#/definitions/ScheduleGenerationMessage"}}}},"SchedulerMessageArgument":{"type":"object","properties":{"type":{"type":"string","description":"The type of this message parameter","enum":["AgentId","Date"],"x-genesys-enum-members":[{"name":"AgentId"},{"name":"Date"}]},"value":{"type":"string","description":"The value of this message parameter"}}},"BuHeadcountForecast":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/BuPlanningGroupHeadcountForecast"}},"referenceStartDate":{"type":"string","format":"date-time","description":"Reference start date for the interval values in each forecast entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"BuHeadcountForecastResponse":{"type":"object","properties":{"result":{"description":"The headcount forecast, null when downloadUrl is provided","$ref":"#/definitions/BuHeadcountForecast"},"downloadUrl":{"type":"string","description":"Download URL. Null unless the response is too large to pass directly through the api"}}},"BuPlanningGroupHeadcountForecast":{"type":"object","properties":{"planningGroup":{"description":"The planning group to which this portion of the headcount forecast applies","$ref":"#/definitions/PlanningGroupReference"},"requiredPerInterval":{"type":"array","description":"Required headcount per interval, referenced against the reference start date","items":{"type":"number","format":"double"}},"requiredWithoutShrinkagePerInterval":{"type":"array","description":"Required headcount per interval without accounting for shrinkage, referenced against the reference start date","items":{"type":"number","format":"double"}}}},"PlanningGroupReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Planning Group"},"BuAgentScheduleActivity":{"type":"object","properties":{"startDate":{"type":"string","format":"date-time","description":"The start date/time of this activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"lengthMinutes":{"type":"integer","format":"int32","description":"The length of this activity in minutes"},"description":{"type":"string","description":"The description of this activity"},"activityCodeId":{"type":"string","description":"The ID of the activity code associated with this activity"},"paid":{"type":"boolean","description":"Whether this activity is paid"},"timeOffRequestId":{"type":"string","description":"The ID of the time off request associated with this activity, if applicable"},"externalActivityId":{"type":"string","description":"The ID of the external activity associated with this activity, if applicable"},"externalActivityType":{"type":"string","description":"The type of the external activity associated with this activity, if applicable","enum":["Coaching"],"x-genesys-enum-members":[{"name":"Coaching"}]}}},"BuAgentScheduleQueryResponse":{"type":"object","properties":{"user":{"description":"The user to whom this agent schedule applies","$ref":"#/definitions/UserReference"},"shifts":{"type":"array","description":"The shift definitions for this agent schedule","items":{"$ref":"#/definitions/BuAgentScheduleShift"}},"fullDayTimeOffMarkers":{"type":"array","description":"Full day time off markers which apply to this agent schedule","items":{"$ref":"#/definitions/BuFullDayTimeOffMarker"}},"workPlan":{"description":"The work plan for this user","$ref":"#/definitions/WorkPlanReference"},"workPlansPerWeek":{"type":"array","description":"The work plans per week for this user from the work plan rotation. Null values in the list denotes that user is not part of any work plan for that week","items":{"$ref":"#/definitions/WorkPlanReference"}},"metadata":{"description":"Versioned entity metadata for this agent schedule","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"BuAgentScheduleShift":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"startDate":{"type":"string","format":"date-time","description":"The start date of this shift. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"lengthMinutes":{"type":"integer","format":"int32","description":"The length of this shift in minutes"},"activities":{"type":"array","description":"The activities associated with this shift","items":{"$ref":"#/definitions/BuAgentScheduleActivity"}},"manuallyEdited":{"type":"boolean","description":"Whether this shift was manually edited. This is only set by clients and is used for rescheduling"},"schedule":{"description":"The schedule to which this shift belongs","readOnly":true,"$ref":"#/definitions/BuScheduleReference"}}},"BuAgentSchedulesQueryResponse":{"type":"object","properties":{"agentSchedules":{"type":"array","description":"The requested agent schedules","items":{"$ref":"#/definitions/BuAgentScheduleQueryResponse"}},"businessUnitTimeZone":{"type":"string","description":"The time zone configured for the business unit to which these schedules apply"}}},"BuAsyncAgentSchedulesQueryResponse":{"type":"object","properties":{"status":{"type":"string","description":"The status of the operation","enum":["Processing","Complete","Canceled","Error"],"x-genesys-enum-members":[{"name":"Processing"},{"name":"Complete"},{"name":"Canceled"},{"name":"Error"}]},"operationId":{"type":"string","description":"The ID for the operation"},"result":{"description":"The result of the operation. Null unless status == Complete","$ref":"#/definitions/BuAgentSchedulesQueryResponse"},"progress":{"type":"integer","format":"int32","description":"Percent progress for the operation"},"downloadUrl":{"type":"string","description":"The URL from which to download the result if it is too large to pass directly"}}},"BuFullDayTimeOffMarker":{"type":"object","properties":{"businessUnitDate":{"type":"string","format":"date","description":"The date of the time off marker, interpreted in the business unit's time zone. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"lengthMinutes":{"type":"integer","format":"int32","description":"The length of the time off marker in minutes"},"description":{"type":"string","description":"The description of the time off marker"},"activityCodeId":{"type":"string","description":"The ID of the activity code associated with the time off marker"},"paid":{"type":"boolean","description":"Whether the time off marker is paid"},"timeOffRequestId":{"type":"string","description":"The ID of the time off request"}}},"WorkPlanReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"managementUnit":{"description":"The management unit to which this work plan belongs. Nullable in some routes","$ref":"#/definitions/ManagementUnitReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Work plan information"},"BuQueryAgentSchedulesRequest":{"type":"object","required":["managementUnitId"],"properties":{"managementUnitId":{"type":"string","description":"The ID of the management unit to query"},"userIds":{"type":"array","description":"The IDs of the users to query. Omit to query all user schedules in the management unit. Note: If teamIds is also specified, only schedules for users in the requested teams will be returned","uniqueItems":true,"items":{"type":"string"}},"teamIds":{"type":"array","description":"The teamIds to report on. If null or not set, results will be queried for requested users if applicable or otherwise all users in the management unit","uniqueItems":true,"items":{"type":"string"}}}},"BuAgentScheduleHistoryChange":{"type":"object","properties":{"metadata":{"description":"The metadata of the change, including who and when the change was made","$ref":"#/definitions/BuAgentScheduleHistoryChangeMetadata"},"shifts":{"type":"array","description":"The list of changed shifts","items":{"$ref":"#/definitions/BuAgentScheduleShift"}},"fullDayTimeOffMarkers":{"type":"array","description":"The list of changed full day time off markers","items":{"$ref":"#/definitions/BuFullDayTimeOffMarker"}},"deletes":{"description":"The deleted shifts, full day time off markers, or the entire agent schedule","$ref":"#/definitions/BuAgentScheduleHistoryDeletedChange"}}},"BuAgentScheduleHistoryChangeMetadata":{"type":"object","properties":{"dateModified":{"type":"string","format":"date-time","description":"The timestamp of the schedule change. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"description":"The user that made the schedule change","$ref":"#/definitions/UserReference"}}},"BuAgentScheduleHistoryDeletedChange":{"type":"object","properties":{"shiftIds":{"type":"array","description":"The IDs of deleted shifts","uniqueItems":true,"items":{"type":"string"}},"fullDayTimeOffMarkerDates":{"type":"array","description":"The dates of any deleted full day time off markers","uniqueItems":true,"items":{"type":"string","format":"date"}},"agentSchedule":{"type":"boolean","description":"Whether the entire agent schedule was deleted"}}},"BuAgentScheduleHistoryDroppedChange":{"type":"object","properties":{"metadata":{"description":"The metadata of the change, including who and when the change was made","$ref":"#/definitions/BuAgentScheduleHistoryChangeMetadata"},"shiftIds":{"type":"array","description":"The IDs of deleted shifts","uniqueItems":true,"items":{"type":"string"}},"fullDayTimeOffMarkerDates":{"type":"array","description":"The dates of any deleted full day time off markers","uniqueItems":true,"items":{"type":"string","format":"date"}},"deletes":{"description":"The deleted shifts, full day time off markers, or the entire agent schedule","$ref":"#/definitions/BuAgentScheduleHistoryDeletedChange"}}},"BuAgentScheduleHistoryResponse":{"type":"object","properties":{"priorPublishedSchedules":{"type":"array","description":"The list of previously published schedules","items":{"$ref":"#/definitions/BuScheduleReference"}},"basePublishedSchedule":{"description":"The originally published agent schedules","$ref":"#/definitions/BuAgentScheduleHistoryChange"},"droppedChanges":{"type":"array","description":"The changes dropped from the schedule history. This will happen if the schedule history is too large","items":{"$ref":"#/definitions/BuAgentScheduleHistoryDroppedChange"}},"changes":{"type":"array","description":"The list of changes for the schedule history","items":{"$ref":"#/definitions/BuAgentScheduleHistoryChange"}}}},"EmailConversation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"participants":{"type":"array","description":"The list of participants involved in the conversation.","items":{"$ref":"#/definitions/EmailMediaParticipant"}},"otherMediaUris":{"type":"array","description":"The list of other media channels involved in the conversation.","items":{"type":"string","format":"uri"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EmailConversationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/EmailConversation"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EmailMediaParticipant":{"type":"object","properties":{"id":{"type":"string","description":"The unique participant ID."},"name":{"type":"string","description":"The display friendly name of the participant."},"address":{"type":"string","description":"The participant address."},"startTime":{"type":"string","format":"date-time","description":"The time when this participant first joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The time when this participant went connected for this media (eg: video connected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startHoldTime":{"type":"string","format":"date-time","description":"The time when this participant's hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"purpose":{"type":"string","description":"The participant's purpose. Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr"},"state":{"type":"string","description":"The participant's state. Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","converting","uploading","transmitting","none"],"x-genesys-enum-members":[{"name":"alerting"},{"name":"dialing"},{"name":"contacting"},{"name":"offering"},{"name":"connected"},{"name":"disconnected"},{"name":"terminated"},{"name":"converting"},{"name":"uploading"},{"name":"transmitting"},{"name":"none"}]},"direction":{"type":"string","description":"The participant's direction. Values can be: 'inbound' or 'outbound'","enum":["inbound","outbound"],"x-genesys-enum-members":[{"name":"inbound"},{"name":"outbound"}]},"disconnectType":{"type":"string","description":"The reason the participant was disconnected from the conversation.","enum":["endpoint","client","system","transfer","transfer.conference","transfer.consult","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam"],"x-genesys-enum-members":[{"name":"endpoint"},{"name":"client"},{"name":"system"},{"name":"transfer"},{"name":"transfer.conference"},{"name":"transfer.consult"},{"name":"transfer.forward"},{"name":"transfer.noanswer"},{"name":"transfer.notavailable"},{"name":"transport.failure"},{"name":"error"},{"name":"peer"},{"name":"other"},{"name":"spam"}]},"held":{"type":"boolean","description":"Value is true when the participant is on hold."},"wrapupRequired":{"type":"boolean","description":"Value is true when the participant requires wrap-up."},"wrapupPrompt":{"type":"string","description":"The wrap-up prompt indicating the type of wrap-up to be performed."},"user":{"description":"The PureCloud user for this participant.","$ref":"#/definitions/DomainEntityRef"},"queue":{"description":"The PureCloud queue for this participant.","$ref":"#/definitions/DomainEntityRef"},"team":{"description":"The PureCloud team for this participant.","$ref":"#/definitions/DomainEntityRef"},"attributes":{"type":"object","description":"A list of ad-hoc attributes for the participant.","additionalProperties":{"type":"string"}},"errorInfo":{"description":"If the conversation ends in error, contains additional error details.","$ref":"#/definitions/ErrorInfo"},"script":{"description":"The Engage script that should be used by this participant.","$ref":"#/definitions/DomainEntityRef"},"wrapupTimeoutMs":{"type":"integer","format":"int32","description":"The amount of time the participant has to complete wrap-up."},"wrapupSkipped":{"type":"boolean","description":"Value is true when the participant has skipped wrap-up."},"alertingTimeoutMs":{"type":"integer","format":"int32","description":"Specifies how long the agent has to answer an interaction before being marked as not responding."},"provider":{"type":"string","description":"The source provider for the communication."},"externalContact":{"description":"If this participant represents an external contact, then this will be the reference for the external contact.","$ref":"#/definitions/DomainEntityRef"},"externalOrganization":{"description":"If this participant represents an external org, then this will be the reference for the external org.","$ref":"#/definitions/DomainEntityRef"},"wrapup":{"description":"Wrapup for this participant, if it has been applied.","$ref":"#/definitions/Wrapup"},"peer":{"type":"string","description":"The peer communication corresponding to a matching leg for this communication."},"flaggedReason":{"type":"string","description":"The reason specifying why participant flagged the conversation.","enum":["general"],"x-genesys-enum-members":[{"name":"general"}]},"journeyContext":{"description":"Journey System data/context that is applicable to this communication. When used for historical purposes, the context should be immutable. When null, there is no applicable Journey System context.","$ref":"#/definitions/JourneyContext"},"conversationRoutingData":{"description":"Information on how a communication should be routed to an agent.","$ref":"#/definitions/ConversationRoutingData"},"startAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"subject":{"type":"string","description":"The subject of the email."},"messagesSent":{"type":"integer","format":"int32","description":"The number of messages that have been sent in this email conversation."},"autoGenerated":{"type":"boolean","description":"Indicates that the email was auto-generated like an Out of Office reply."},"draftAttachments":{"type":"array","description":"A list of uploaded attachments on the email draft.","items":{"$ref":"#/definitions/Attachment"}},"spam":{"type":"boolean","description":"Indicates if the inbound email was marked as spam."},"messageId":{"type":"string","description":"A globally unique identifier for the stored content of this communication."}}},"EmailMessage":{"type":"object","required":["from","textBody","to"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"to":{"type":"array","description":"The recipients of the email message.","items":{"$ref":"#/definitions/EmailAddress"}},"cc":{"type":"array","description":"The recipients that were copied on the email message.","items":{"$ref":"#/definitions/EmailAddress"}},"bcc":{"type":"array","description":"The recipients that were blind copied on the email message.","items":{"$ref":"#/definitions/EmailAddress"}},"from":{"description":"The sender of the email message.","$ref":"#/definitions/EmailAddress"},"subject":{"type":"string","description":"The subject of the email message."},"attachments":{"type":"array","description":"The attachments of the email message.","items":{"$ref":"#/definitions/Attachment"}},"textBody":{"type":"string","description":"The text body of the email message."},"htmlBody":{"type":"string","description":"The html body of the email message."},"time":{"type":"string","format":"date-time","description":"The time when the message was received or sent. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"historyIncluded":{"type":"boolean","description":"Indicates whether the history of previous emails of the conversation is included within the email bodies of this message."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EmailMessageListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/EmailMessage"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CreateEmailRequest":{"type":"object","required":["provider"],"properties":{"queueId":{"type":"string","description":"The ID of the queue to use for routing the email conversation. This field is mutually exclusive with flowId"},"flowId":{"type":"string","description":"The ID of the flow to use for routing email conversation. This field is mutually exclusive with queueId"},"provider":{"type":"string","description":"The name of the provider that is sourcing the emails. The Provider \"PureCloud Email\" is reserved for native emails."},"skillIds":{"type":"array","description":"The list of skill ID's to use for routing.","items":{"type":"string"}},"languageId":{"type":"string","description":"The ID of the language to use for routing."},"priority":{"type":"integer","format":"int64","description":"The priority to assign to the conversation for routing."},"attributes":{"type":"object","description":"The list of attributes to associate with the customer participant.","additionalProperties":{"type":"string"}},"toAddress":{"type":"string","description":"The email address of the recipient of the email."},"toName":{"type":"string","description":"The name of the recipient of the email."},"fromAddress":{"type":"string","description":"The email address of the sender of the email."},"fromName":{"type":"string","description":"The name of the sender of the email."},"subject":{"type":"string","description":"The subject of the email"},"direction":{"type":"string","description":"Specify OUTBOUND to send an email on behalf of a queue, or INBOUND to create an external conversation. An external conversation is one where the provider is not PureCloud based.","enum":["OUTBOUND","INBOUND"],"x-genesys-enum-members":[{"name":"OUTBOUND"},{"name":"INBOUND"}]},"htmlBody":{"type":"string","description":"An HTML body content of the email."},"textBody":{"type":"string","description":"A text body content of the email."}}},"CopyAttachmentsRequest":{"type":"object","required":["attachments","sourceMessage"],"properties":{"sourceMessage":{"description":"A reference to the email message within the current conversation that owns the attachments to be copied","$ref":"#/definitions/DomainEntityRef"},"attachments":{"type":"array","description":"A list of attachments that will be copied from the source message to the current draft","items":{"$ref":"#/definitions/Attachment"}}}},"InboundMessageRequest":{"type":"object","required":["provider"],"properties":{"queueId":{"type":"string","description":"The ID of the queue to use for routing the email conversation. This field is mutually exclusive with flowId"},"flowId":{"type":"string","description":"The ID of the flow to use for routing email conversation. This field is mutually exclusive with queueId"},"provider":{"type":"string","description":"The name of the provider that is sourcing the email such as Oracle, Salesforce, etc."},"skillIds":{"type":"array","description":"The list of skill ID's to use for routing.","items":{"type":"string"}},"languageId":{"type":"string","description":"The ID of the language to use for routing."},"priority":{"type":"integer","format":"int32","description":"The priority to assign to the conversation for routing."},"attributes":{"type":"object","description":"The list of attributes to associate with the customer participant.","additionalProperties":{"type":"string"}},"toAddress":{"type":"string","description":"The email address of the recipient of the email."},"toName":{"type":"string","description":"The name of the recipient of the email."},"fromAddress":{"type":"string","description":"The email address of the sender of the email."},"fromName":{"type":"string","description":"The name of the sender of the email."},"subject":{"type":"string","description":"The subject of the email"}}},"DocumentFaq":{"type":"object","required":["answer","question"],"properties":{"question":{"type":"string","description":"The question for this FAQ"},"answer":{"type":"string","description":"The answer for this FAQ"},"alternatives":{"type":"array","description":"List of Alternative questions related to the answer which helps in improving the likelihood of a match to user query","items":{"type":"string"}}}},"KnowledgeCategory":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Category name"},"description":{"type":"string","description":"Category description"},"knowledgeBase":{"description":"Knowledge base which category does belong to","readOnly":true,"$ref":"#/definitions/KnowledgeBase"},"languageCode":{"type":"string","description":"Actual language of the category","readOnly":true,"enum":["en-US","de-DE"],"x-genesys-enum-members":[{"name":"en-US"},{"name":"de-DE"}]},"dateCreated":{"type":"string","format":"date-time","description":"Category creation date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Category last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeSearchDocument":{"type":"object","required":["languageCode","type"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"languageCode":{"type":"string","description":"Language of the document","enum":["en-US","de-DE"],"x-genesys-enum-members":[{"name":"en-US"},{"name":"de-DE"}]},"type":{"type":"string","description":"Document type","enum":["Faq"],"x-genesys-enum-members":[{"name":"Faq"}]},"faq":{"description":"FAQ document details","$ref":"#/definitions/DocumentFaq"},"dateCreated":{"type":"string","format":"date-time","description":"Document creation date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Document last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"categories":{"type":"array","description":"Document categories","items":{"$ref":"#/definitions/KnowledgeCategory"}},"knowledgeBase":{"description":"Knowledge base which document does belong to","readOnly":true,"$ref":"#/definitions/KnowledgeBase"},"externalUrl":{"type":"string","description":"External URL to the document"},"confidence":{"type":"number","format":"double","description":"The confidence associated with a document with respect to a search query","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"InteractionStatsAlert":{"type":"object","required":["alertTypes","dimension","dimensionValue","mediaType","metric","name","notificationUsers","numericRange","ruleId","startDate","statistic","unread","value"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Name of the rule that generated the alert","readOnly":true},"dimension":{"type":"string","description":"The dimension of concern.","readOnly":true,"enum":["queueId","userId"],"x-genesys-enum-members":[{"name":"queueId"},{"name":"userId"}]},"dimensionValue":{"type":"string","description":"The value of the dimension.","readOnly":true},"metric":{"type":"string","description":"The metric to be assessed.","readOnly":true,"enum":["tAbandon","tAnswered","tTalk","nOffered","tHandle","nTransferred","oServiceLevel","tWait","tHeld","tAcw"],"x-genesys-enum-members":[{"name":"tAbandon"},{"name":"tAnswered"},{"name":"tTalk"},{"name":"nOffered"},{"name":"tHandle"},{"name":"nTransferred"},{"name":"oServiceLevel"},{"name":"tWait"},{"name":"tHeld"},{"name":"tAcw"}]},"mediaType":{"type":"string","description":"The media type.","readOnly":true,"enum":["voice","chat","email","callback","message"],"x-genesys-enum-members":[{"name":"voice"},{"name":"chat"},{"name":"email"},{"name":"callback"},{"name":"message"}]},"numericRange":{"type":"string","description":"The comparison descriptor used against the metric's value.","readOnly":true,"enum":["gt","gte","lt","lte","eq","ne"],"x-genesys-enum-members":[{"name":"gt"},{"name":"gte"},{"name":"lt"},{"name":"lte"},{"name":"eq"},{"name":"ne"}]},"statistic":{"type":"string","description":"The statistic of concern for the metric.","readOnly":true,"enum":["count","min","ratio","max"],"x-genesys-enum-members":[{"name":"count"},{"name":"min"},{"name":"ratio"},{"name":"max"}]},"value":{"type":"number","format":"double","description":"The threshold value.","readOnly":true},"ruleId":{"type":"string","description":"The id of the rule.","readOnly":true},"unread":{"type":"boolean","description":"Indicates if the alert has been read."},"startDate":{"type":"string","format":"date-time","description":"The date/time the alert was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"endDate":{"type":"string","format":"date-time","description":"The date/time the owning rule exiting in alarm status. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"notificationUsers":{"type":"array","description":"The ids of users who were notified of alarm state change.","readOnly":true,"uniqueItems":true,"items":{"$ref":"#/definitions/User"}},"alertTypes":{"type":"array","description":"A collection of notification methods.","readOnly":true,"uniqueItems":true,"items":{"type":"string","enum":["SMS","DEVICE","EMAIL"],"x-genesys-enum-members":[{"name":"SMS"},{"name":"DEVICE"},{"name":"EMAIL"}]}},"ruleUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"InteractionStatsAlertContainer":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/InteractionStatsAlert"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CertificateDetails":{"type":"object","properties":{"issuer":{"type":"string","description":"Information about the issuer of the certificate. The value of this property is a comma separated key=value format. Each key is one of the attribute names supported by X.500."},"subject":{"type":"string","description":"Information about the subject of the certificate. The value of this property is a comma separated key=value format. Each key is one of the attribute names supported by X.500."},"expirationDate":{"type":"string","format":"date-time","description":"The expiration date of the certificate. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"issueDate":{"type":"string","format":"date-time","description":"The issue date of the certificate. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"expired":{"type":"boolean","description":"True if the certificate is expired, false otherwise."},"signatureValid":{"type":"boolean"},"valid":{"type":"boolean"}},"description":"Represents the details of a parsed certificate."},"DomainCertificateAuthority":{"type":"object","required":["certificate","name","services","type"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"certificate":{"type":"string","description":"The authorities signed X509 PEM encoded certificate."},"type":{"type":"string","description":"The certificate authorities type. Managed certificate authorities are generated and maintained by Interactive Intelligence. These are read-only and not modifiable by clients. Remote authorities are customer managed.","enum":["MANAGED","REMOTE"],"x-genesys-enum-members":[{"name":"MANAGED"},{"name":"REMOTE"}]},"services":{"type":"array","description":"The service(s) that the authority can be used to authenticate.","items":{"type":"string","enum":["SIP","PROVISION","PROVISION_PHONE"],"x-genesys-enum-members":[{"name":"SIP"},{"name":"PROVISION"},{"name":"PROVISION_PHONE"}]}},"certificateDetails":{"type":"array","description":"The details of the parsed certificate(s).","items":{"$ref":"#/definitions/CertificateDetails"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"A certificate authority represents an organization that has issued a digital certificate for making secure connections with an edge device."},"CertificateAuthorityEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DomainCertificateAuthority"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DataTableExportJob":{"type":"object","required":["status"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"owner":{"description":"The PureCloud user who started the export job","$ref":"#/definitions/AddressableEntityRef"},"status":{"type":"string","description":"The status of the export job","enum":["Processing","Failed","Succeeded"],"x-genesys-enum-members":[{"name":"Processing"},{"name":"Failed"},{"name":"Succeeded"}]},"dateCreated":{"type":"string","format":"date-time","description":"The timestamp of when the export began. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateCompleted":{"type":"string","format":"date-time","description":"The timestamp of when the export stopped (either successfully or unsuccessfully). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"downloadURI":{"type":"string","format":"uri","description":"The URL of the location at which the caller can download the export file, when available"},"errorInformation":{"description":"Any error information, or null of the processing is not in an error state","$ref":"#/definitions/ErrorBody"},"countRecordsProcessed":{"type":"integer","format":"int32","description":"The current count of the number of records processed"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"State information for an export job of rows from a datatable"},"UserScheduleAdherenceListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UserScheduleAdherence"}},"downloadUrl":{"type":"string","description":"The downloadUrl if the response is too large to send directly via http response","readOnly":true}}},"GreetingMediaInfo":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"mediaFileUri":{"type":"string","format":"uri"},"mediaImageUri":{"type":"string","format":"uri"}}},"BuAbandonRate":{"type":"object","required":["include"],"properties":{"include":{"type":"boolean","description":"Whether to include abandon rate in the associated configuration"},"percent":{"type":"integer","format":"int32","description":"Abandon rate percent goal. Required if include == true"}},"description":"Service goal abandon rate configuration"},"BuAverageSpeedOfAnswer":{"type":"object","required":["include"],"properties":{"include":{"type":"boolean","description":"Whether to include average speed of answer (ASA) in the associated configuration"},"seconds":{"type":"integer","format":"int32","description":"The target average speed of answer (ASA) in seconds. Required if include == true"}},"description":"Service goal average speed of answer configuration"},"BuServiceLevel":{"type":"object","required":["include"],"properties":{"include":{"type":"boolean","description":"Whether to include service level targets in the associated configuration"},"percent":{"type":"integer","format":"int32","description":"Service level target percent answered. Required if include == true"},"seconds":{"type":"integer","format":"int32","description":"Service level target answer time. Required if include == true"}},"description":"Service goal service level configuration"},"ServiceGoalTemplate":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"serviceLevel":{"description":"Service level targets for this service goal template","$ref":"#/definitions/BuServiceLevel"},"averageSpeedOfAnswer":{"description":"Average speed of answer targets for this service goal template","$ref":"#/definitions/BuAverageSpeedOfAnswer"},"abandonRate":{"description":"Abandon rate targets for this service goal template","$ref":"#/definitions/BuAbandonRate"},"metadata":{"description":"Version metadata for the service goal template","$ref":"#/definitions/WfmVersionedEntityMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Service Goal Template"},"UpdateServiceGoalTemplate":{"type":"object","required":["metadata"],"properties":{"name":{"type":"string","description":"The name of the service goal template."},"serviceLevel":{"description":"Service level targets for this service goal template","$ref":"#/definitions/BuServiceLevel"},"averageSpeedOfAnswer":{"description":"Average speed of answer targets for this service goal template","$ref":"#/definitions/BuAverageSpeedOfAnswer"},"abandonRate":{"description":"Abandon rate targets for this service goal template","$ref":"#/definitions/BuAbandonRate"},"metadata":{"description":"Version metadata for the service goal template","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"ServiceGoalTemplateList":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ServiceGoalTemplate"}}},"description":"List of service goal templates"},"CreateServiceGoalTemplate":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The name of the service goal template."},"serviceLevel":{"description":"Service level targets for this service goal template","$ref":"#/definitions/BuServiceLevel"},"averageSpeedOfAnswer":{"description":"Average speed of answer targets for this service goal template","$ref":"#/definitions/BuAverageSpeedOfAnswer"},"abandonRate":{"description":"Abandon rate targets for this service goal template","$ref":"#/definitions/BuAbandonRate"}}},"LicenseUser":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"licenses":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/LicenseDefinition"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Adjacents":{"type":"object","properties":{"superiors":{"type":"array","items":{"$ref":"#/definitions/User"}},"siblings":{"type":"array","items":{"$ref":"#/definitions/User"}},"directReports":{"type":"array","items":{"$ref":"#/definitions/User"}}}},"EncryptionKeyEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/EncryptionKey"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"OrgWhitelistSettings":{"type":"object","properties":{"enableWhitelist":{"type":"boolean"},"domainWhitelist":{"type":"array","items":{"type":"string"}}}},"PatchBuReschedulingOptionsManagementUnitRequest":{"type":"object","required":["managementUnitId"],"properties":{"managementUnitId":{"type":"string","description":"The management unit portion of the rescheduling run to update"},"applied":{"type":"boolean","description":"Whether to mark the run as applied. Only applies to reschedule runs. Once applied, a run cannot be un-marked as applied"}}},"PatchBuReschedulingOptionsRequest":{"type":"object","properties":{"managementUnits":{"type":"array","description":"Per-management unit rescheduling options to update","items":{"$ref":"#/definitions/PatchBuReschedulingOptionsManagementUnitRequest"}}}},"PatchBuScheduleRunRequest":{"type":"object","properties":{"reschedulingOptions":{"description":"The rescheduling options to update","$ref":"#/definitions/PatchBuReschedulingOptionsRequest"}}},"BuScheduleRunListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/BuScheduleRun"}}}},"BuAgentScheduleRescheduleResponse":{"type":"object","properties":{"user":{"description":"The user to whom this agent schedule applies","$ref":"#/definitions/UserReference"},"shifts":{"type":"array","description":"The shift definitions for this agent schedule","items":{"$ref":"#/definitions/BuAgentScheduleShift"}},"fullDayTimeOffMarkers":{"type":"array","description":"Full day time off markers which apply to this agent schedule","items":{"$ref":"#/definitions/BuFullDayTimeOffMarker"}},"workPlan":{"description":"The work plan for this user","$ref":"#/definitions/WorkPlanReference"},"workPlansPerWeek":{"type":"array","description":"The work plans per week for this user from the work plan rotation. Null values in the list denotes that user is not part of any work plan for that week","items":{"$ref":"#/definitions/WorkPlanReference"}}}},"BuRescheduleAgentScheduleResult":{"type":"object","properties":{"managementUnit":{"description":"The management unit to which this part of the result applies","$ref":"#/definitions/ManagementUnitReference"},"downloadResult":{"description":"The agent schedules. Result will always come via the downloadUrl; however the schema is included for documentation","$ref":"#/definitions/MuRescheduleResultWrapper"},"downloadUrl":{"type":"string","description":"The download URL from which to fetch the result"}}},"BuRescheduleResult":{"type":"object","properties":{"generationResults":{"description":"The generation results. Note the result will always be delivered via the downloadUrl; however the schema is included for documentation","$ref":"#/definitions/ScheduleGenerationResult"},"generationResultsDownloadUrl":{"type":"string","description":"The download URL from which to fetch the generation results for the rescheduling run"},"headcountForecast":{"description":"The headcount forecast. Note the result will always be delivered via the downloadUrl; however the schema is included for documentation","$ref":"#/definitions/BuHeadcountForecast"},"headcountForecastDownloadUrl":{"type":"string","description":"The download URL from which to fetch the headcount forecast for the rescheduling run"},"agentSchedules":{"type":"array","description":"List of download links for agent schedules produced by the rescheduling run","items":{"$ref":"#/definitions/BuRescheduleAgentScheduleResult"}}}},"MuRescheduleResultWrapper":{"type":"object","properties":{"agentSchedules":{"type":"array","description":"The list of agent schedules","items":{"$ref":"#/definitions/BuAgentScheduleRescheduleResponse"}}}},"PhoneEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Phone"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"VoicemailMessageEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/VoicemailMessage"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ADFS":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"disabled":{"type":"boolean"},"issuerURI":{"type":"string"},"ssoTargetURI":{"type":"string"},"certificate":{"type":"string"},"certificates":{"type":"array","items":{"type":"string"}},"relyingPartyIdentifier":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BuAgentSchedulePublishedScheduleReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"weekDate":{"type":"string","format":"date","description":"The start week date for this schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"weekCount":{"type":"integer","format":"int32","description":"The number of weeks encompassed by the schedule"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BuAgentScheduleSearchResponse":{"type":"object","properties":{"user":{"description":"The user to whom this agent schedule applies","$ref":"#/definitions/UserReference"},"shifts":{"type":"array","description":"The shift definitions for this agent schedule","items":{"$ref":"#/definitions/BuAgentScheduleShift"}},"fullDayTimeOffMarkers":{"type":"array","description":"Full day time off markers which apply to this agent schedule","items":{"$ref":"#/definitions/BuFullDayTimeOffMarker"}}}},"BuAgentScheduleUpdate":{"type":"object","properties":{"type":{"type":"string","description":"The type of update","enum":["Added","Edited","Deleted"],"x-genesys-enum-members":[{"name":"Added"},{"name":"Edited"},{"name":"Deleted"}]},"shiftStartDates":{"type":"array","description":"The start date for the affected shifts","items":{"type":"string","format":"date-time"}}}},"BuCurrentAgentScheduleSearchResponse":{"type":"object","properties":{"agentSchedules":{"type":"array","description":"The requested agent schedules","items":{"$ref":"#/definitions/BuAgentScheduleSearchResponse"}},"businessUnitTimeZone":{"type":"string","description":"The time zone configured for the business unit to which this schedule applies"},"publishedSchedules":{"type":"array","description":"References to all published week schedules overlapping the start/end date query parameters","items":{"$ref":"#/definitions/BuAgentSchedulePublishedScheduleReference"}},"startDate":{"type":"string","format":"date-time","description":"The start date of the schedules. Only populated on notifications. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endDate":{"type":"string","format":"date-time","description":"The end date of the schedules. Only populated on notifications. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"updates":{"type":"array","description":"The list of updates for the schedule. Only used in notifications","items":{"$ref":"#/definitions/BuAgentScheduleUpdate"}}}},"BuGetCurrentAgentScheduleRequest":{"type":"object","required":["endDate","startDate"],"properties":{"startDate":{"type":"string","format":"date-time","description":"Start date of the range to search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endDate":{"type":"string","format":"date-time","description":"End date of the range to search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"OAuthAuthorization":{"type":"object","properties":{"client":{"$ref":"#/definitions/OAuthClient"},"scope":{"type":"array","items":{"type":"string"}},"resourceOwner":{"$ref":"#/definitions/DomainEntityRef"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"$ref":"#/definitions/DomainEntityRef"},"modifiedBy":{"$ref":"#/definitions/DomainEntityRef"},"pending":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OAuthAuthorizationListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/OAuthAuthorization"}},"selfUri":{"type":"string","format":"uri"}}},"OAuthClient":{"type":"object","required":["authorizedGrantType","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the OAuth client."},"accessTokenValiditySeconds":{"type":"integer","format":"int64","description":"The number of seconds, between 5mins and 48hrs, until tokens created with this client expire. If this field is omitted, a default of 24 hours will be applied."},"description":{"type":"string"},"registeredRedirectUri":{"type":"array","description":"List of allowed callbacks for this client. For example: https://myap.example.com/auth/callback","items":{"type":"string","format":"uri"}},"secret":{"type":"string","description":"System created secret assigned to this client. Secrets are required for code authorization and client credential grants."},"roleIds":{"type":"array","description":"Deprecated. Use roleDivisions instead.","uniqueItems":true,"items":{"type":"string"}},"dateCreated":{"type":"string","format":"date-time","description":"Date this client was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date this client was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"description":"User that created this client","$ref":"#/definitions/DomainEntityRef"},"modifiedBy":{"description":"User that last modified this client","$ref":"#/definitions/DomainEntityRef"},"authorizedGrantType":{"type":"string","description":"The OAuth Grant/Client type supported by this client.\nCode Authorization Grant/Client type - Preferred client type where the Client ID and Secret are required to create tokens. Used where the secret can be secured.\nPKCE-Enabled Code Authorization grant type - Code grant type which requires PKCE challenge and verifier to create tokens. Used in public clients for increased security.\nImplicit grant type - Client ID only is required to create tokens. Used in browser and mobile apps where the secret can not be secured.\nSAML2-Bearer extension grant type - SAML2 assertion provider for user authentication at the token endpoint.\nClient Credential grant type - Used to created access tokens that are tied only to the client.\n","enum":["CODE","CODE_PKCE","TOKEN","SAML2BEARER","PASSWORD","CLIENT_CREDENTIALS"],"x-genesys-enum-members":[{"name":"CODE"},{"name":"CODE_PKCE"},{"name":"TOKEN"},{"name":"SAML2BEARER"},{"name":"PASSWORD"},{"name":"CLIENT_CREDENTIALS"}]},"scope":{"type":"array","description":"The scope requested by this client. Scopes only apply to clients not using the client_credential grant","items":{"type":"string"}},"roleDivisions":{"type":"array","description":"Set of roles and their corresponding divisions associated with this client. Roles and divisions only apply to clients using the client_credential grant","uniqueItems":true,"items":{"$ref":"#/definitions/RoleDivision"}},"state":{"type":"string","description":"The state of the OAuth client.\nActive: The OAuth client can be used to create access tokens. This is the default state.\nDisabled: Access tokens created by the client are invalid and new ones cannot be created.\nInactive: Access tokens cannot be created with this OAuth client and it will be deleted.","enum":["active","disabled","inactive"],"x-genesys-enum-members":[{"name":"active"},{"name":"disabled"},{"name":"inactive"}]},"dateToDelete":{"type":"string","format":"date-time","description":"The time at which this client will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"RoleDivision":{"type":"object","required":["divisionId","roleId"],"properties":{"roleId":{"type":"string","description":"Role to be associated with the given division which forms a grant"},"divisionId":{"type":"string","description":"Division associated with the given role which forms a grant"}}},"BusinessUnitActivityCode":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"active":{"type":"boolean","description":"Whether this activity code is active or has been deleted"},"defaultCode":{"type":"boolean","description":"Whether this is a default activity code"},"category":{"type":"string","description":"The category of the activity code","enum":["OnQueueWork","Break","Meal","Meeting","OffQueueWork","TimeOff","Training","Unavailable","Unscheduled"],"x-genesys-enum-members":[{"name":"OnQueueWork"},{"name":"Break"},{"name":"Meal"},{"name":"Meeting"},{"name":"OffQueueWork"},{"name":"TimeOff"},{"name":"Training"},{"name":"Unavailable"},{"name":"Unscheduled"}]},"lengthInMinutes":{"type":"integer","format":"int32","description":"The default length of the activity in minutes"},"countsAsPaidTime":{"type":"boolean","description":"Whether an agent is paid while performing this activity"},"countsAsWorkTime":{"type":"boolean","description":"Indicates whether or not the activity should be counted as contiguous work time for calculating daily constraints"},"agentTimeOffSelectable":{"type":"boolean","description":"Whether an agent can select this activity code when creating or editing a time off request. Null if the activity's category is not time off."},"metadata":{"description":"Version metadata of this activity code","$ref":"#/definitions/WfmVersionedEntityMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Activity code data"},"BusinessUnitActivityCodeListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/BusinessUnitActivityCode"}}},"description":"List of BusinessUnitActivityCode"},"CreateActivityCodeRequest":{"type":"object","required":["category","name"],"properties":{"name":{"type":"string","description":"The name of the activity code"},"category":{"type":"string","description":"The activity code's category","enum":["OnQueueWork","Break","Meal","Meeting","OffQueueWork","TimeOff","Training","Unavailable","Unscheduled"],"x-genesys-enum-members":[{"name":"OnQueueWork"},{"name":"Break"},{"name":"Meal"},{"name":"Meeting"},{"name":"OffQueueWork"},{"name":"TimeOff"},{"name":"Training"},{"name":"Unavailable"},{"name":"Unscheduled"}]},"lengthInMinutes":{"type":"integer","format":"int32","description":"The default length of the activity in minutes"},"countsAsPaidTime":{"type":"boolean","description":"Whether an agent is paid while performing this activity"},"countsAsWorkTime":{"type":"boolean","description":"Indicates whether or not the activity should be counted as work time"},"agentTimeOffSelectable":{"type":"boolean","description":"Whether an agent can select this activity code when creating or editing a time off request"}},"description":"Activity Code"},"UpdateActivityCodeRequest":{"type":"object","required":["metadata"],"properties":{"name":{"type":"string","description":"The name of the activity code"},"category":{"type":"string","description":"The activity code's category. Attempting to change the category of a default activity code will return an error","enum":["OnQueueWork","Break","Meal","Meeting","OffQueueWork","TimeOff","Training","Unavailable","Unscheduled"],"x-genesys-enum-members":[{"name":"OnQueueWork"},{"name":"Break"},{"name":"Meal"},{"name":"Meeting"},{"name":"OffQueueWork"},{"name":"TimeOff"},{"name":"Training"},{"name":"Unavailable"},{"name":"Unscheduled"}]},"lengthInMinutes":{"type":"integer","format":"int32","description":"The default length of the activity in minutes"},"countsAsPaidTime":{"type":"boolean","description":"Whether an agent is paid while performing this activity"},"countsAsWorkTime":{"type":"boolean","description":"Indicates whether or not the activity should be counted as work time"},"agentTimeOffSelectable":{"type":"boolean","description":"Whether an agent can select this activity code when creating or editing a time off request"},"metadata":{"description":"Version metadata for the associated business unit's list of activity codes","$ref":"#/definitions/WfmVersionedEntityMetadata"}},"description":"Activity Code"},"ScriptEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Script"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"OrganizationPresence":{"type":"object","required":["languageLabels"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"languageLabels":{"type":"object","description":"The label used for the system presence in each specified language","additionalProperties":{"type":"string"}},"systemPresence":{"type":"string"},"deactivated":{"type":"boolean"},"primary":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/User"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"$ref":"#/definitions/User"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PatchUser":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"acdAutoAnswer":{"type":"boolean","description":"The value that denotes if acdAutoAnswer is set on the user"},"certifications":{"type":"array","items":{"type":"string"}},"biography":{"$ref":"#/definitions/Biography"},"employerInfo":{"$ref":"#/definitions/EmployerInfo"}}},"ContactListFilter":{"type":"object","required":["contactList","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the list."},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"contactList":{"description":"The contact list the filter is based on.","$ref":"#/definitions/DomainEntityRef"},"clauses":{"type":"array","description":"Groups of conditions to filter the contacts by.","items":{"$ref":"#/definitions/ContactListFilterClause"}},"filterType":{"type":"string","description":"How to join clauses together.","enum":["AND","OR"],"x-genesys-enum-members":[{"name":"AND"},{"name":"OR"}]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ContactListFilterClause":{"type":"object","properties":{"filterType":{"type":"string","description":"How to join predicates together.","enum":["AND","OR"],"x-genesys-enum-members":[{"name":"AND"},{"name":"OR"}]},"predicates":{"type":"array","description":"Conditions to filter the contacts by.","items":{"$ref":"#/definitions/ContactListFilterPredicate"}}}},"ContactListFilterPredicate":{"type":"object","properties":{"column":{"type":"string","description":"Contact list column from the ContactListFilter's contactList."},"columnType":{"type":"string","description":"The type of data in the contact column.","enum":["numeric","alphabetic"],"x-genesys-enum-members":[{"name":"numeric"},{"name":"alphabetic"}]},"operator":{"type":"string","description":"The operator for this ContactListFilterPredicate.","enum":["EQUALS","LESS_THAN","LESS_THAN_EQUALS","GREATER_THAN","GREATER_THAN_EQUALS","CONTAINS","BEGINS_WITH","ENDS_WITH","BEFORE","AFTER","BETWEEN","IN"],"x-genesys-enum-members":[{"name":"EQUALS"},{"name":"LESS_THAN"},{"name":"LESS_THAN_EQUALS"},{"name":"GREATER_THAN"},{"name":"GREATER_THAN_EQUALS"},{"name":"CONTAINS"},{"name":"BEGINS_WITH"},{"name":"ENDS_WITH"},{"name":"BEFORE"},{"name":"AFTER"},{"name":"BETWEEN"},{"name":"IN"}]},"value":{"type":"string","description":"Value with which to compare the contact's data. This could be text, a number, or a relative time. A value for relative time should follow the format PxxDTyyHzzM, where xx, yy, and zz specify the days, hours and minutes. For example, a value of P01DT08H30M corresponds to 1 day, 8 hours, and 30 minutes from now. To specify a time in the past, include a negative sign before each numeric value. For example, a value of P-01DT-08H-30M corresponds to 1 day, 8 hours, and 30 minutes in the past. You can also do things like P01DT00H-30M, which would correspond to 23 hours and 30 minutes from now (1 day - 30 minutes)."},"range":{"description":"A range of values. Required for operators BETWEEN and IN.","$ref":"#/definitions/ContactListFilterRange"},"inverted":{"type":"boolean","description":"Inverts the result of the predicate (i.e., if the predicate returns true, inverting it will return false)."}}},"ContactListFilterRange":{"type":"object","properties":{"min":{"type":"string","description":"The minimum value of the range. Required for the operator BETWEEN."},"max":{"type":"string","description":"The maximum value of the range. Required for the operator BETWEEN."},"minInclusive":{"type":"boolean","description":"Whether or not to include the minimum in the range."},"maxInclusive":{"type":"boolean","description":"Whether or not to include the maximum in the range."},"inSet":{"type":"array","description":"A set of values that the contact data should be in. Required for the IN operator.","uniqueItems":true,"items":{"type":"string"}}}},"ContactListFilterEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ContactListFilter"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ResponseEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Response"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Context":{"type":"object","required":["patterns"],"properties":{"patterns":{"type":"array","description":"A list of one or more patterns to match.","items":{"$ref":"#/definitions/ContextPattern"}}}},"ContextPattern":{"type":"object","required":["criteria"],"properties":{"criteria":{"type":"array","description":"A list of one or more criteria to satisfy.","items":{"$ref":"#/definitions/EntityTypeCriteria"}}}},"Criteria":{"type":"object","required":["key","shouldIgnoreCase","values"],"properties":{"key":{"type":"string","description":"The criteria key."},"values":{"type":"array","description":"The criteria values.","items":{"type":"string"}},"shouldIgnoreCase":{"type":"boolean","description":"Should criteria be case insensitive."},"operator":{"type":"string","description":"The comparison operator.","enum":["containsAll","containsAny","notContainsAll","notContainsAny","equal","notEqual","greaterThan","greaterThanOrEqual","lessThan","lessThanOrEqual","startsWith","endsWith"],"x-genesys-enum-members":[{"name":"containsAll"},{"name":"containsAny"},{"name":"notContainsAll"},{"name":"notContainsAny"},{"name":"equal"},{"name":"notEqual"},{"name":"greaterThan"},{"name":"greaterThanOrEqual"},{"name":"lessThan"},{"name":"lessThanOrEqual"},{"name":"startsWith"},{"name":"endsWith"}]}}},"EntityTypeCriteria":{"type":"object","required":["key","shouldIgnoreCase","values"],"properties":{"key":{"type":"string","description":"The criteria key."},"values":{"type":"array","description":"The criteria values.","items":{"type":"string"}},"shouldIgnoreCase":{"type":"boolean","description":"Should criteria be case insensitive."},"operator":{"type":"string","description":"The comparison operator.","enum":["containsAll","containsAny","notContainsAll","notContainsAny","equal","notEqual","greaterThan","greaterThanOrEqual","lessThan","lessThanOrEqual","startsWith","endsWith"],"x-genesys-enum-members":[{"name":"containsAll"},{"name":"containsAny"},{"name":"notContainsAll"},{"name":"notContainsAny"},{"name":"equal"},{"name":"notEqual"},{"name":"greaterThan"},{"name":"greaterThanOrEqual"},{"name":"lessThan"},{"name":"lessThanOrEqual"},{"name":"startsWith"},{"name":"endsWith"}]},"entityType":{"type":"string","description":"The entity to match the pattern against.","enum":["visit"],"x-genesys-enum-members":[{"name":"visit"}]}}},"Journey":{"type":"object","required":["patterns"],"properties":{"patterns":{"type":"array","description":"A list of zero or more patterns to match.","items":{"$ref":"#/definitions/JourneyPattern"}}}},"JourneyPattern":{"type":"object","required":["criteria","sessionType","streamType"],"properties":{"criteria":{"type":"array","description":"A list of one or more criteria to satisfy.","items":{"$ref":"#/definitions/Criteria"}},"count":{"type":"integer","format":"int32","description":"The number of times the pattern must match."},"streamType":{"type":"string","description":"The stream type for which this pattern can be matched on.","enum":["Web","Custom","Conversation"],"x-genesys-enum-members":[{"name":"Web"},{"name":"Custom"},{"name":"Conversation"}]},"sessionType":{"type":"string","description":"The session type for which this pattern can be matched on."},"eventName":{"type":"string","description":"The name of the event for which this pattern can be matched on."}}},"Outcome":{"type":"object","required":["displayName"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"isActive":{"type":"boolean","description":"Whether or not the outcome is active."},"displayName":{"type":"string","description":"The display name of the outcome."},"version":{"type":"integer","format":"int32","description":"The version of the outcome."},"description":{"type":"string","description":"A description of the outcome."},"isPositive":{"type":"boolean","description":"Whether or not the outcome is positive."},"context":{"description":"The context of the outcome.","$ref":"#/definitions/Context"},"journey":{"description":"The pattern of rules defining the filter of the outcome.","$ref":"#/definitions/Journey"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"createdDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the outcome was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the outcome was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"LocalEncryptionConfigurationListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/LocalEncryptionConfiguration"}},"selfUri":{"type":"string","format":"uri"}}},"SecurityProfile":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"permissions":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkspaceMember":{"type":"object","required":["memberType"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"workspace":{"$ref":"#/definitions/DomainEntityRef"},"memberType":{"type":"string","description":"The workspace member type.","enum":["USER","GROUP"],"x-genesys-enum-members":[{"name":"USER"},{"name":"GROUP"}]},"member":{"$ref":"#/definitions/DomainEntityRef"},"user":{"$ref":"#/definitions/User"},"group":{"$ref":"#/definitions/Group"},"securityProfile":{"$ref":"#/definitions/SecurityProfile"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CallBasic":{"type":"object","properties":{"state":{"type":"string","description":"The connection state of this communication.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","converting","uploading","transmitting","none"],"x-genesys-enum-members":[{"name":"alerting"},{"name":"dialing"},{"name":"contacting"},{"name":"offering"},{"name":"connected"},{"name":"disconnected"},{"name":"terminated"},{"name":"converting"},{"name":"uploading"},{"name":"transmitting"},{"name":"none"}]},"id":{"type":"string","description":"A globally unique identifier for this communication."},"direction":{"type":"string","description":"The direction of the call","enum":["inbound","outbound"],"x-genesys-enum-members":[{"name":"inbound"},{"name":"outbound"}]},"recording":{"type":"boolean","description":"True if this call is being recorded."},"recordingState":{"type":"string","description":"State of recording on this call.","enum":["none","active","paused"],"x-genesys-enum-members":[{"name":"none"},{"name":"active"},{"name":"paused"}]},"muted":{"type":"boolean","description":"True if this call is muted so that remote participants can't hear any audio from this end."},"confined":{"type":"boolean","description":"True if this call is held and the person on this side hears hold music."},"held":{"type":"boolean","description":"True if this call is held and the person on this side hears silence."},"recordingId":{"type":"string","description":"A globally unique identifier for the recording associated with this call."},"segments":{"type":"array","description":"The time line of the participant's call, divided into activity segments.","items":{"$ref":"#/definitions/Segment"}},"errorInfo":{"$ref":"#/definitions/ErrorInfo"},"disconnectType":{"type":"string","description":"System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.","enum":["endpoint","client","system","timeout","transfer","transfer.conference","transfer.consult","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam","uncallable"],"x-genesys-enum-members":[{"name":"endpoint"},{"name":"client"},{"name":"system"},{"name":"timeout"},{"name":"transfer"},{"name":"transfer.conference"},{"name":"transfer.consult"},{"name":"transfer.forward"},{"name":"transfer.noanswer"},{"name":"transfer.notavailable"},{"name":"transport.failure"},{"name":"error"},{"name":"peer"},{"name":"other"},{"name":"spam"},{"name":"uncallable"}]},"startHoldTime":{"type":"string","format":"date-time","description":"The timestamp the call was placed on hold in the cloud clock if the call is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"documentId":{"type":"string","description":"If call is an outbound fax of a document from content management, then this is the id in content management."},"startAlertingTime":{"type":"string","format":"date-time","description":"The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"disconnectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"disconnectReasons":{"type":"array","description":"List of reasons that this call was disconnected. This will be set once the call disconnects.","items":{"$ref":"#/definitions/DisconnectReason"}},"faxStatus":{"description":"Extra information on fax transmission.","$ref":"#/definitions/FaxStatus"},"provider":{"type":"string","description":"The source provider for the call."},"scriptId":{"type":"string","description":"The UUID of the script to use."},"peerId":{"type":"string","description":"The id of the peer communication corresponding to a matching leg for this communication."},"uuiData":{"type":"string","description":"User to User Information (UUI) data managed by SIP session application."},"self":{"description":"Address and name data for a call endpoint.","$ref":"#/definitions/Address"},"other":{"description":"Address and name data for a call endpoint.","$ref":"#/definitions/Address"},"wrapup":{"description":"Call wrap up or disposition data.","$ref":"#/definitions/Wrapup"},"afterCallWork":{"description":"After-call work for the communication.","$ref":"#/definitions/AfterCallWork"},"afterCallWorkRequired":{"type":"boolean","description":"Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested."},"agentAssistantId":{"type":"string","description":"UUID of virtual agent assistant that provide suggestions to the agent participant during the conversation."}}},"CallbackBasic":{"type":"object","properties":{"state":{"type":"string","description":"The connection state of this communication.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","scheduled","none"],"x-genesys-enum-members":[{"name":"alerting"},{"name":"dialing"},{"name":"contacting"},{"name":"offering"},{"name":"connected"},{"name":"disconnected"},{"name":"terminated"},{"name":"scheduled"},{"name":"none"}]},"id":{"type":"string","description":"A globally unique identifier for this communication."},"segments":{"type":"array","description":"The time line of the participant's callback, divided into activity segments.","items":{"$ref":"#/definitions/Segment"}},"direction":{"type":"string","description":"The direction of the call","enum":["inbound","outbound"],"x-genesys-enum-members":[{"name":"inbound"},{"name":"outbound"}]},"held":{"type":"boolean","description":"True if this call is held and the person on this side hears silence."},"disconnectType":{"type":"string","description":"System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.","enum":["endpoint","client","system","timeout","transfer","transfer.conference","transfer.consult","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam","uncallable"],"x-genesys-enum-members":[{"name":"endpoint"},{"name":"client"},{"name":"system"},{"name":"timeout"},{"name":"transfer"},{"name":"transfer.conference"},{"name":"transfer.consult"},{"name":"transfer.forward"},{"name":"transfer.noanswer"},{"name":"transfer.notavailable"},{"name":"transport.failure"},{"name":"error"},{"name":"peer"},{"name":"other"},{"name":"spam"},{"name":"uncallable"}]},"startHoldTime":{"type":"string","format":"date-time","description":"The timestamp the callback was placed on hold in the cloud clock if the callback is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dialerPreview":{"description":"The preview data to be used when this callback is a Preview.","$ref":"#/definitions/DialerPreview"},"voicemail":{"description":"The voicemail data to be used when this callback is an ACD voicemail.","$ref":"#/definitions/Voicemail"},"callbackNumbers":{"type":"array","description":"The phone number(s) to use to place the callback.","items":{"type":"string"}},"callbackUserName":{"type":"string","description":"The name of the user requesting a callback."},"scriptId":{"type":"string","description":"The UUID of the script to use."},"externalCampaign":{"type":"boolean","description":"True if the call for the callback uses external dialing."},"skipEnabled":{"type":"boolean","description":"True if the ability to skip a callback should be enabled."},"timeoutSeconds":{"type":"integer","format":"int32","description":"The number of seconds before the system automatically places a call for a callback. 0 means the automatic placement is disabled."},"startAlertingTime":{"type":"string","format":"date-time","description":"The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"disconnectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"callbackScheduledTime":{"type":"string","format":"date-time","description":"The timestamp when this communication is scheduled in the provider clock. If this value is missing it indicates the callback will be placed immediately. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"automatedCallbackConfigId":{"type":"string","description":"The id of the config for automatically placing the callback (and handling the disposition). If null, the callback will not be placed automatically but routed to an agent as per normal."},"provider":{"type":"string","description":"The source provider for the callback."},"peerId":{"type":"string","description":"The id of the peer communication corresponding to a matching leg for this communication."},"wrapup":{"description":"Call wrap up or disposition data.","$ref":"#/definitions/Wrapup"},"afterCallWork":{"description":"After-call work for the communication.","$ref":"#/definitions/AfterCallWork"},"afterCallWorkRequired":{"type":"boolean","description":"Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested."}}},"CampaignInteraction":{"type":"object","properties":{"id":{"type":"string"},"campaign":{"$ref":"#/definitions/DomainEntityRef"},"agent":{"$ref":"#/definitions/DomainEntityRef"},"contact":{"$ref":"#/definitions/DomainEntityRef"},"destinationAddress":{"type":"string"},"activePreviewCall":{"type":"boolean","description":"Boolean value if there is an active preview call on the interaction"},"lastActivePreviewWrapupTime":{"type":"string","format":"date-time","description":"The time when the last preview of the interaction was wrapped up. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"creationTime":{"type":"string","format":"date-time","description":"The time when dialer created the interaction. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"callPlacedTime":{"type":"string","format":"date-time","description":"The time when the agent or system places the call. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"callRoutedTime":{"type":"string","format":"date-time","description":"The time when the agent was connected to the call. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"previewConnectedTime":{"type":"string","format":"date-time","description":"The time when the customer and routing participant are connected. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"queue":{"$ref":"#/definitions/DomainEntityRef"},"script":{"$ref":"#/definitions/DomainEntityRef"},"disposition":{"type":"string","description":"Describes what happened with call analysis for instance: disposition.classification.callable.person, disposition.classification.callable.noanswer","enum":["DISCONNECT","LIVE_VOICE","BUSY","MACHINE","NO_ANSWER","SIT_CALLABLE","SIT_UNCALLABLE","FAX"],"x-genesys-enum-members":[{"name":"DISCONNECT"},{"name":"LIVE_VOICE"},{"name":"BUSY"},{"name":"MACHINE"},{"name":"NO_ANSWER"},{"name":"SIT_CALLABLE"},{"name":"SIT_UNCALLABLE"},{"name":"FAX"}]},"callerName":{"type":"string"},"callerAddress":{"type":"string"},"previewPopDeliveredTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversation":{"$ref":"#/definitions/ConversationBasic"},"dialerSystemParticipantId":{"type":"string","description":"conversation participant id that is the dialer system participant to monitor the call from dialer perspective"},"dialingMode":{"type":"string"},"skills":{"type":"array","description":"Any skills that are attached to the call for routing","uniqueItems":true,"items":{"$ref":"#/definitions/DomainEntityRef"}}}},"CampaignInteractions":{"type":"object","properties":{"campaign":{"$ref":"#/definitions/DomainEntityRef"},"pendingInteractions":{"type":"array","items":{"$ref":"#/definitions/CampaignInteraction"}},"proceedingInteractions":{"type":"array","items":{"$ref":"#/definitions/CampaignInteraction"}},"previewingInteractions":{"type":"array","items":{"$ref":"#/definitions/CampaignInteraction"}},"interactingInteractions":{"type":"array","items":{"$ref":"#/definitions/CampaignInteraction"}},"scheduledInteractions":{"type":"array","items":{"$ref":"#/definitions/CampaignInteraction"}}}},"ConversationBasic":{"type":"object","required":["startTime"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"startTime":{"type":"string","format":"date-time","description":"The time when the conversation started. This will be the time when the first participant joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The time when the conversation ended. This will be the time when the last participant left the conversation, or null when the conversation is still active. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"divisions":{"type":"array","description":"Identifiers of divisions associated with this conversation","items":{"$ref":"#/definitions/ConversationDivisionMembership"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"participants":{"type":"array","readOnly":true,"items":{"$ref":"#/definitions/ParticipantBasic"}}}},"ParticipantBasic":{"type":"object","properties":{"id":{"type":"string","description":"A globally unique identifier for this conversation."},"startTime":{"type":"string","format":"date-time","description":"The timestamp when this participant joined the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The timestamp when this participant disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The timestamp when this participant was connected to the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"name":{"type":"string","description":"A human readable name identifying the participant."},"userUri":{"type":"string","description":"If this participant represents a user, then this will be an URI that can be used to fetch the user."},"userId":{"type":"string","description":"If this participant represents a user, then this will be the globally unique identifier for the user."},"externalContactId":{"type":"string","description":"If this participant represents an external contact, then this will be the globally unique identifier for the external contact."},"externalOrganizationId":{"type":"string","description":"If this participant represents an external org, then this will be the globally unique identifier for the external org."},"queueId":{"type":"string","description":"If present, the queue id that the communication channel came in on."},"groupId":{"type":"string","description":"If present, group of users the participant represents."},"teamId":{"type":"string","description":"The team id that this participant is a member of when added to the conversation."},"queueName":{"type":"string","description":"If present, the queue name that the communication channel came in on."},"purpose":{"type":"string","description":"A well known string that specifies the purpose of this participant."},"participantType":{"type":"string","description":"A well known string that specifies the type of this participant."},"consultParticipantId":{"type":"string","description":"If this participant is part of a consult transfer, then this will be the participant id of the participant being transferred."},"address":{"type":"string","description":"The address for the this participant. For a phone call this will be the ANI."},"ani":{"type":"string","description":"The address for the this participant. For a phone call this will be the ANI."},"aniName":{"type":"string","description":"The ani-based name for this participant."},"dnis":{"type":"string","description":"The address for the this participant. For a phone call this will be the ANI."},"locale":{"type":"string","description":"An ISO 639 language code specifying the locale for this participant"},"wrapupRequired":{"type":"boolean","description":"True iff this participant is required to enter wrapup for this conversation."},"wrapupPrompt":{"type":"string","description":"This field controls how the UI prompts the agent for a wrapup.","enum":["mandatory","optional","agentRequested","timeout","forcedTimeout"],"x-genesys-enum-members":[{"name":"mandatory"},{"name":"optional"},{"name":"agentRequested"},{"name":"timeout"},{"name":"forcedTimeout"}]},"wrapupTimeoutMs":{"type":"integer","format":"int32","description":"Specifies how long a timed ACW session will last."},"wrapupSkipped":{"type":"boolean","description":"The UI sets this field when the agent chooses to skip entering a wrapup for this participant."},"wrapup":{"description":"Call wrap up or disposition data.","$ref":"#/definitions/Wrapup"},"conversationRoutingData":{"description":"Information on how a communication should be routed to an agent.","$ref":"#/definitions/ConversationRoutingData"},"alertingTimeoutMs":{"type":"integer","format":"int32","description":"Specifies how long the agent has to answer an interaction before being marked as not responding."},"monitoredParticipantId":{"type":"string","description":"If this participant is a monitor, then this will be the id of the participant that is being monitored."},"coachedParticipantId":{"type":"string","description":"If this participant is a coach, then this will be the id of the participant that is being coached."},"attributes":{"type":"object","description":"Additional participant attributes","additionalProperties":{"type":"string"}},"calls":{"type":"array","items":{"$ref":"#/definitions/CallBasic"}},"callbacks":{"type":"array","items":{"$ref":"#/definitions/CallbackBasic"}},"chats":{"type":"array","items":{"$ref":"#/definitions/ConversationChat"}},"cobrowsesessions":{"type":"array","items":{"$ref":"#/definitions/Cobrowsesession"}},"emails":{"type":"array","items":{"$ref":"#/definitions/Email"}},"messages":{"type":"array","items":{"$ref":"#/definitions/Message"}},"screenshares":{"type":"array","items":{"$ref":"#/definitions/Screenshare"}},"socialExpressions":{"type":"array","items":{"$ref":"#/definitions/SocialExpression"}},"videos":{"type":"array","items":{"$ref":"#/definitions/Video"}},"evaluations":{"type":"array","items":{"$ref":"#/definitions/Evaluation"}},"screenRecordingState":{"type":"string","description":"The current screen recording state for this participant.","enum":["requested","active","paused","stopped","error","timeout"],"x-genesys-enum-members":[{"name":"requested"},{"name":"active"},{"name":"paused"},{"name":"stopped"},{"name":"error"},{"name":"timeout"}]},"flaggedReason":{"type":"string","description":"The reason specifying why participant flagged the conversation.","enum":["general"],"x-genesys-enum-members":[{"name":"general"}]},"startAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"TrunkRecordingEnabledCount":{"type":"object","properties":{"enabledCount":{"type":"integer","format":"int32","description":"The amount of trunks that have recording enabled"},"disabledCount":{"type":"integer","format":"int32","description":"The amount of trunks that do not have recording enabled"}}},"TrustEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Trustee"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Trustee":{"type":"object","required":["enabled"],"properties":{"id":{"type":"string","description":"Organization Id for this trust.","readOnly":true},"enabled":{"type":"boolean","description":"If disabled no trustee user will have access, even if they were previously added."},"dateCreated":{"type":"string","format":"date-time","description":"Date Trust was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"createdBy":{"description":"User that created trust.","readOnly":true,"$ref":"#/definitions/OrgUser"},"organization":{"description":"Organization associated with this trust.","readOnly":true,"$ref":"#/definitions/Organization"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"RoleDivisionGrants":{"type":"object","required":["grants"],"properties":{"grants":{"type":"array","description":"A list containing pairs of role and division IDs","items":{"$ref":"#/definitions/RoleDivisionPair"}}}},"RoleDivisionPair":{"type":"object","required":["divisionId","roleId"],"properties":{"roleId":{"type":"string","description":"The ID of the role"},"divisionId":{"type":"string","description":"The ID of the division"}}},"TrustCreate":{"type":"object","required":["enabled","pairingId"],"properties":{"pairingId":{"type":"string","description":"The pairing Id created by the trustee. This is required to prove that the trustee agrees to the relationship."},"enabled":{"type":"boolean","description":"If disabled no trustee user will have access, even if they were previously added."},"users":{"type":"array","description":"The list of users and their roles to which access will be granted. The users are from the trustee and the roles are from the trustor. If no users are specified, at least one group is required.","items":{"$ref":"#/definitions/TrustMemberCreate"}},"groups":{"type":"array","description":"The list of groups and their roles to which access will be granted. The groups are from the trustee and the roles are from the trustor. If no groups are specified, at least one user is required.","items":{"$ref":"#/definitions/TrustMemberCreate"}}}},"TrustMemberCreate":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Trustee User or Group Id"},"roleIds":{"type":"array","description":"The list of roles to be granted to this user or group. Roles will be granted in all divisions.","items":{"type":"string"}},"roleDivisions":{"description":"The list of trustor organization roles granting this user or group access paired with the divisions for those roles.","$ref":"#/definitions/RoleDivisionGrants"}}},"KeyRotationSchedule":{"type":"object","required":["period"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"period":{"type":"string","description":"Value to set schedule to","enum":["DISABLED","DAILY","WEEKLY","MONTHLY","YEARLY"],"x-genesys-enum-members":[{"name":"DISABLED"},{"name":"DAILY"},{"name":"WEEKLY"},{"name":"MONTHLY"},{"name":"YEARLY"}]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FlowDiagnosticInfo":{"type":"object","properties":{"lastActionId":{"type":"integer","format":"int32","description":"The step number of the survey invite flow where the error occurred."}}},"Survey":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"conversation":{"$ref":"#/definitions/Conversation"},"surveyForm":{"description":"Survey form used for this survey.","$ref":"#/definitions/SurveyForm"},"agent":{"$ref":"#/definitions/DomainEntityRef"},"status":{"type":"string","enum":["Pending","Sent","InProgress","Finished","OptOut","Error","Expired"],"x-genesys-enum-members":[{"name":"Pending"},{"name":"Sent"},{"name":"InProgress"},{"name":"Finished"},{"name":"OptOut"},{"name":"Error"},{"name":"Expired"}]},"queue":{"$ref":"#/definitions/QueueReference"},"answers":{"$ref":"#/definitions/SurveyScoringSet"},"completedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"surveyErrorDetails":{"description":"Additional information about what happened when the survey is in Error status.","$ref":"#/definitions/SurveyErrorDetails"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SurveyErrorDetails":{"type":"object","properties":{"flowDiagnosticInfo":{"description":"Additional information about any errors that occurred in the survey invite flow.","$ref":"#/definitions/FlowDiagnosticInfo"},"surveyErrorReason":{"type":"string","description":"An error code indicating the reason for the survey failure."}}},"Entity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true}}},"SubscriberResponse":{"type":"object","required":["status"],"properties":{"messageReturned":{"type":"array","description":"Suggested valid addresses","items":{"type":"string"}},"status":{"type":"string","description":"http status"}}},"ValidateAddressResponse":{"type":"object","required":["valid"],"properties":{"valid":{"type":"boolean","description":"Was the passed in address valid"},"response":{"description":"Subscriber schema","$ref":"#/definitions/SubscriberResponse"}}},"StreetAddress":{"type":"object","required":["A1","A3","country"],"properties":{"country":{"type":"string","description":"2 Letter Country code, like US or GB"},"A1":{"type":"string","description":"State or Province"},"A3":{"type":"string","description":"City or township"},"RD":{"type":"string"},"HNO":{"type":"string"},"LOC":{"type":"string"},"NAM":{"type":"string"},"PC":{"type":"string"}}},"ValidateAddressRequest":{"type":"object","properties":{"address":{"description":"Address schema","$ref":"#/definitions/StreetAddress"}}},"ContactListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ExternalContact"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DocumentationResult":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","format":"int32","description":"The globally unique identifier for the object."},"categories":{"type":"array","description":"The category of the documentation entity. Will be returned in responses for certain entities.","items":{"type":"integer","format":"int32"}},"description":{"type":"string","description":"The description of the documentation entity. Will be returned in responses for certain entities."},"content":{"type":"string","description":"The text or html content for the documentation entity. Will be returned in responses for certain entities."},"excerpt":{"type":"string","description":"The excerpt of the documentation entity. Will be returned in responses for certain entities."},"link":{"type":"string","description":"URL link for the documentation entity. Will be returned in responses for certain entities."},"modified":{"type":"string","format":"date-time","description":"The modified date for the documentation entity. Will be returned in responses for certain entities. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"name":{"type":"string","description":"The name of the documentation entity. Will be returned in responses for certain entities."},"service":{"type":"array","description":"The service of the documentation entity. Will be returned in responses for certain entities.","items":{"type":"integer","format":"int32"}},"slug":{"type":"string","description":"The slug of the documentation entity. Will be returned in responses for certain entities."},"title":{"type":"string","description":"The title of the documentation entity. Will be returned in responses for certain entities."},"get_type":{"type":"string","description":"The search type. Will be returned in responses for certain entities."},"facet_feature":{"type":"array","description":"The facet feature of the documentation entity. Will be returned in responses for certain entities.","items":{"type":"integer","format":"int32"}},"facet_role":{"type":"array","description":"The facet role of the documentation entity. Will be returned in responses for certain entities.","items":{"type":"integer","format":"int32"}},"facet_service":{"type":"array","description":"The facet service of the documentation entity. Will be returned in responses for certain entities.","items":{"type":"integer","format":"int32"}},"faq_categories":{"type":"array","description":"The faq categories of the documentation entity. Will be returned in responses for certain entities.","items":{"type":"integer","format":"int32"}},"releasenote_category":{"type":"array","description":"The releasenote category of the documentation entity. Will be returned in responses for certain entities.","items":{"type":"integer","format":"int32"}},"releasenote_tag":{"type":"array","description":"The releasenote tag of the documentation entity. Will be returned in responses for certain entities.","items":{"type":"integer","format":"int32"}},"service-area":{"type":"array","description":"The service area of the documentation entity. Will be returned in responses for certain entities.","items":{"type":"integer","format":"int32"}},"video_categories":{"type":"array","description":"The video categories of the documentation entity. Will be returned in responses for certain entities.","items":{"type":"integer","format":"int32"}}}},"DocumentationSearchResponse":{"type":"object","required":["pageCount","pageNumber","pageSize","results","total","types"],"properties":{"total":{"type":"integer","format":"int64","description":"The total number of results found"},"pageCount":{"type":"integer","format":"int32","description":"The total number of pages"},"pageSize":{"type":"integer","format":"int32","description":"The current page size"},"pageNumber":{"type":"integer","format":"int32","description":"The current page number"},"previousPage":{"type":"string","description":"Q64 value for the previous page of results"},"currentPage":{"type":"string","description":"Q64 value for the current page of results"},"nextPage":{"type":"string","description":"Q64 value for the next page of results"},"types":{"type":"array","description":"Resource types the search was performed against","items":{"type":"string"}},"results":{"type":"array","description":"Search results","items":{"$ref":"#/definitions/DocumentationResult"}}}},"DocumentationSearchCriteria":{"type":"object","required":["type"],"properties":{"endValue":{"type":"string","description":"The end value of the range. This field is used for range search types."},"values":{"type":"array","description":"A list of values for the search to match against","items":{"type":"string"}},"startValue":{"type":"string","description":"The start value of the range. This field is used for range search types."},"fields":{"type":"array","description":"Field names to search against","items":{"type":"string"}},"value":{"type":"string","description":"A value for the search to match against"},"operator":{"type":"string","description":"How to apply this search criteria against other criteria","enum":["AND","OR","NOT"],"x-genesys-enum-members":[{"name":"AND"},{"name":"OR"},{"name":"NOT"}]},"group":{"type":"array","description":"Groups multiple conditions","items":{"$ref":"#/definitions/DocumentationSearchCriteria"}},"dateFormat":{"type":"string","description":"Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."},"type":{"type":"string","description":"Search Type","enum":["EXACT","STARTS_WITH","CONTAINS","TERM","TERMS","MATCH_ALL","SIMPLE","QUERY_STRING","MULTI_MATCH"],"x-genesys-enum-members":[{"name":"EXACT"},{"name":"STARTS_WITH"},{"name":"CONTAINS"},{"name":"TERM"},{"name":"TERMS"},{"name":"MATCH_ALL"},{"name":"SIMPLE"},{"name":"QUERY_STRING"},{"name":"MULTI_MATCH"}]}}},"DocumentationSearchRequest":{"type":"object","properties":{"sortOrder":{"type":"string","description":"The sort order for results","enum":["ASC","DESC","SCORE"],"x-genesys-enum-members":[{"name":"ASC"},{"name":"DESC"},{"name":"SCORE"}]},"sortBy":{"type":"string","description":"The field in the resource that you want to sort the results by"},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"},"pageNumber":{"type":"integer","format":"int32","description":"The page of resources you want to retrieve"},"sort":{"type":"array","description":"Multi-value sort order, list of multiple sort values","items":{"$ref":"#/definitions/SearchSort"}},"query":{"type":"array","items":{"$ref":"#/definitions/DocumentationSearchCriteria"}}}},"AnalyticsScoredAgent":{"type":"object","properties":{"scoredAgentId":{"type":"string","description":"Unique identifier of an agent that was scored for this conversation"},"agentScore":{"type":"integer","format":"int32","description":"Assigned agent score for this conversation (0 - 100, higher being better)"}}},"ObservationMetricData":{"type":"object","properties":{"metric":{"type":"string"},"qualifier":{"type":"string"},"stats":{"$ref":"#/definitions/StatisticalSummary"},"truncated":{"type":"boolean","description":"Flag for a truncated list of observations. If truncated, the first half of the list of observations will contain the oldest observations and the second half the newest observations."},"observations":{"type":"array","description":"List of observations sorted by timestamp in ascending order. This list may be truncated.","items":{"$ref":"#/definitions/ObservationValue"}}}},"ObservationValue":{"type":"object","required":["observationDate"],"properties":{"observationDate":{"type":"string","format":"date-time","description":"The time at which the observation occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"Unique identifier for the conversation"},"sessionId":{"type":"string","description":"The unique identifier of this session"},"requestedRoutingSkillIds":{"type":"array","description":"Unique identifier for a skill requested for an interaction","uniqueItems":true,"items":{"type":"string"}},"requestedLanguageId":{"type":"string","description":"Unique identifier for the language requested for an interaction"},"routingPriority":{"type":"integer","format":"int64","description":"Routing priority for the current interaction"},"participantName":{"type":"string","description":"A human readable name identifying the participant"},"userId":{"type":"string","description":"Unique identifier for the user"},"direction":{"type":"string","description":"The direction of the communication","enum":["inbound","outbound"],"x-genesys-enum-members":[{"name":"inbound"},{"name":"outbound"}]},"convertedFrom":{"type":"string","description":"Session media type that was converted from in case of a media type conversion"},"convertedTo":{"type":"string","description":"Session media type that was converted to in case of a media type conversion"},"addressFrom":{"type":"string","description":"The address that initiated an action"},"addressTo":{"type":"string","description":"The address receiving an action"},"ani":{"type":"string","description":"Automatic Number Identification (caller's number)"},"dnis":{"type":"string","description":"Dialed number identification service (number dialed by the calling party)"},"teamId":{"type":"string","description":"The team id the user is a member of"},"requestedRoutings":{"type":"array","description":"All routing types for requested/attempted routing methods","uniqueItems":true,"items":{"type":"string","enum":["Predictive","Preferred","Manual","Last","Bullseye","Standard"],"x-genesys-enum-members":[{"name":"Predictive"},{"name":"Preferred"},{"name":"Manual"},{"name":"Last"},{"name":"Bullseye"},{"name":"Standard"}]}},"usedRouting":{"type":"string","description":"Complete routing method","enum":["Predictive","Preferred","Manual","Last","Bullseye","Standard"],"x-genesys-enum-members":[{"name":"Predictive"},{"name":"Preferred"},{"name":"Manual"},{"name":"Last"},{"name":"Bullseye"},{"name":"Standard"}]},"scoredAgents":{"type":"array","items":{"$ref":"#/definitions/AnalyticsScoredAgent"}}}},"UserObservationDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/ObservationMetricData"}}}},"UserObservationQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/UserObservationDataContainer"}}}},"UserObservationQuery":{"type":"object","required":["filter","metrics"],"properties":{"filter":{"description":"Filter to return a subset of observations. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/UserObservationQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["oActiveQueues","oMemberQueues"],"x-genesys-enum-members":[{"name":"oActiveQueues"},{"name":"oMemberQueues"}]}},"detailMetrics":{"type":"array","description":"Metrics for which to include additional detailed observations","items":{"type":"string","enum":["oActiveQueues","oMemberQueues"],"x-genesys-enum-members":[{"name":"oActiveQueues"},{"name":"oMemberQueues"}]}}}},"UserObservationQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/UserObservationQueryPredicate"}}}},"UserObservationQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/UserObservationQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/UserObservationQueryPredicate"}}}},"UserObservationQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"],"x-genesys-enum-members":[{"name":"dimension"},{"name":"property"},{"name":"metric"}]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["userId"],"x-genesys-enum-members":[{"name":"userId"}]},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"],"x-genesys-enum-members":[{"name":"matches"},{"name":"exists"},{"name":"notExists"}]},"value":{"type":"string","description":"Right hand side for dimension predicates"},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"AsyncQueryResponse":{"type":"object","properties":{"jobId":{"type":"string","description":"Unique identifier for the async query execution. Can be used to check the status of the query and retrieve results."}}},"AsyncUserDetailsQuery":{"type":"object","required":["interval"],"properties":{"interval":{"type":"string","description":"Specifies the date and time range of data being queried. Conversations MUST have started within this time range to potentially be included within the result set. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"userFilters":{"type":"array","description":"Filters that target the users to retrieve data for","items":{"$ref":"#/definitions/UserDetailQueryFilter"}},"presenceFilters":{"type":"array","description":"Filters that target system and organization presence-level data","items":{"$ref":"#/definitions/PresenceDetailQueryFilter"}},"routingStatusFilters":{"type":"array","description":"Filters that target agent routing status-level data","items":{"$ref":"#/definitions/RoutingStatusDetailQueryFilter"}},"order":{"type":"string","description":"Sort the result set in ascending/descending order. Default is ascending","enum":["asc","desc"],"x-genesys-enum-members":[{"name":"asc"},{"name":"desc"}]},"limit":{"type":"integer","format":"int32","description":"Specify number of results to be returned"}}},"PresenceDetailQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/PresenceDetailQueryPredicate"}}}},"PresenceDetailQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/PresenceDetailQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/PresenceDetailQueryPredicate"}}}},"PresenceDetailQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"],"x-genesys-enum-members":[{"name":"dimension"},{"name":"property"},{"name":"metric"}]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["organizationPresenceId","systemPresence"],"x-genesys-enum-members":[{"name":"organizationPresenceId"},{"name":"systemPresence"}]},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"],"x-genesys-enum-members":[{"name":"matches"},{"name":"exists"},{"name":"notExists"}]},"value":{"type":"string","description":"Right hand side for dimension predicates"},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"RoutingStatusDetailQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/RoutingStatusDetailQueryPredicate"}}}},"RoutingStatusDetailQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/RoutingStatusDetailQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/RoutingStatusDetailQueryPredicate"}}}},"RoutingStatusDetailQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"],"x-genesys-enum-members":[{"name":"dimension"},{"name":"property"},{"name":"metric"}]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["routingStatus"],"x-genesys-enum-members":[{"name":"routingStatus"}]},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"],"x-genesys-enum-members":[{"name":"matches"},{"name":"exists"},{"name":"notExists"}]},"value":{"type":"string","description":"Right hand side for dimension predicates"},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"UserDetailQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/UserDetailQueryPredicate"}}}},"UserDetailQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/UserDetailQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/UserDetailQueryPredicate"}}}},"UserDetailQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"],"x-genesys-enum-members":[{"name":"dimension"},{"name":"property"},{"name":"metric"}]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["userId"],"x-genesys-enum-members":[{"name":"userId"}]},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"],"x-genesys-enum-members":[{"name":"matches"},{"name":"exists"},{"name":"notExists"}]},"value":{"type":"string","description":"Right hand side for dimension predicates"},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"AsyncQueryStatus":{"type":"object","properties":{"state":{"type":"string","description":"The current state of the asynchronous query","enum":["QUEUED","PENDING","FAILED","CANCELLED","FULFILLED","EXPIRED"],"x-genesys-enum-members":[{"name":"QUEUED"},{"name":"PENDING"},{"name":"FAILED"},{"name":"CANCELLED"},{"name":"FULFILLED"},{"name":"EXPIRED"}]},"errorMessage":{"type":"string","description":"The error associated with the current query, if the state is FAILED"},"expirationDate":{"type":"string","format":"date-time","description":"The time at which results for this query will expire. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"submissionDate":{"type":"string","format":"date-time","description":"The time at which the query was submitted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"completionDate":{"type":"string","format":"date-time","description":"The time at which the query completed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"AnalyticsRoutingStatusRecord":{"type":"object","properties":{"startTime":{"type":"string","format":"date-time","description":"The start time of the record. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The end time of the record. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"routingStatus":{"type":"string","description":"The user's ACD routing status","enum":["OFF_QUEUE","IDLE","INTERACTING","NOT_RESPONDING","COMMUNICATING"]}}},"AnalyticsUserDetail":{"type":"object","properties":{"userId":{"type":"string","description":"The identifier for the user"},"primaryPresence":{"type":"array","description":"The presence records for the user","items":{"$ref":"#/definitions/AnalyticsUserPresenceRecord"}},"routingStatus":{"type":"array","description":"The ACD routing status records for the user","items":{"$ref":"#/definitions/AnalyticsRoutingStatusRecord"}}}},"AnalyticsUserDetailsAsyncQueryResponse":{"type":"object","properties":{"userDetails":{"type":"array","items":{"$ref":"#/definitions/AnalyticsUserDetail"}},"cursor":{"type":"string","description":"Optional cursor to indicate where to resume the results"},"dataAvailabilityDate":{"type":"string","format":"date-time","description":"Data available up to at least this datetime. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"AnalyticsUserPresenceRecord":{"type":"object","properties":{"startTime":{"type":"string","format":"date-time","description":"The start time of the record. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The end time of the record. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"systemPresence":{"type":"string","description":"The user's system presence","enum":["AVAILABLE","AWAY","BUSY","OFFLINE","IDLE","ON_QUEUE","MEAL","TRAINING","MEETING","BREAK"]},"organizationPresenceId":{"type":"string","description":"The identifier for the user's organization presence"}}},"DataAvailabilityResponse":{"type":"object","properties":{"dataAvailabilityDate":{"type":"string","format":"date-time","description":"Date and time before which data is guaranteed to be available in the datalake. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"AggregationResult":{"type":"object","properties":{"type":{"type":"string","enum":["termFrequency","numericRange"],"x-genesys-enum-members":[{"name":"termFrequency"},{"name":"numericRange"}]},"dimension":{"type":"string","description":"For termFrequency aggregations"},"metric":{"type":"string","description":"For numericRange aggregations"},"count":{"type":"integer","format":"int64"},"results":{"type":"array","items":{"$ref":"#/definitions/AggregationResultEntry"}}}},"AggregationResultEntry":{"type":"object","properties":{"count":{"type":"integer","format":"int64"},"value":{"type":"string","description":"For termFrequency aggregations"},"gte":{"type":"number","description":"For numericRange aggregations"},"lt":{"type":"number","description":"For numericRange aggregations"}}},"AnalyticsUserDetailsQueryResponse":{"type":"object","properties":{"userDetails":{"type":"array","items":{"$ref":"#/definitions/AnalyticsUserDetail"}},"aggregations":{"type":"array","items":{"$ref":"#/definitions/AggregationResult"}}}},"AnalyticsQueryAggregation":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["termFrequency","numericRange"],"x-genesys-enum-members":[{"name":"termFrequency"},{"name":"numericRange"}]},"dimension":{"type":"string","description":"For use with termFrequency aggregations"},"metric":{"type":"string","description":"For use with numericRange aggregations"},"size":{"type":"integer","format":"int32","description":"For use with termFrequency aggregations"},"ranges":{"type":"array","description":"For use with numericRange aggregations","items":{"$ref":"#/definitions/AggregationRange"}}}},"PagingSpec":{"type":"object","required":["pageNumber","pageSize"],"properties":{"pageSize":{"type":"integer","format":"int32","description":"How many results per page"},"pageNumber":{"type":"integer","format":"int32","description":"How many pages in"}}},"UserDetailsQuery":{"type":"object","required":["interval"],"properties":{"interval":{"type":"string","description":"Specifies the date and time range of data being queried. Conversations MUST have started within this time range to potentially be included within the result set. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"userFilters":{"type":"array","description":"Filters that target the users to retrieve data for","items":{"$ref":"#/definitions/UserDetailQueryFilter"}},"presenceFilters":{"type":"array","description":"Filters that target system and organization presence-level data","items":{"$ref":"#/definitions/PresenceDetailQueryFilter"}},"routingStatusFilters":{"type":"array","description":"Filters that target agent routing status-level data","items":{"$ref":"#/definitions/RoutingStatusDetailQueryFilter"}},"order":{"type":"string","description":"Sort the result set in ascending/descending order. Default is ascending","enum":["asc","desc"],"x-genesys-enum-members":[{"name":"asc"},{"name":"desc"}]},"presenceAggregations":{"type":"array","description":"Include faceted search and aggregate roll-ups of presence data in your search results. This does not function as a filter, but rather, summary data about the presence results matching your filters","items":{"$ref":"#/definitions/AnalyticsQueryAggregation"}},"routingStatusAggregations":{"type":"array","description":"Include faceted search and aggregate roll-ups of agent routing status data in your search results. This does not function as a filter, but rather, summary data about the agent routing status results matching your filters","items":{"$ref":"#/definitions/AnalyticsQueryAggregation"}},"paging":{"description":"Page size and number to control iterating through large result sets. Default page size is 25","$ref":"#/definitions/PagingSpec"}}},"UserAggregateDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/StatisticalResponse"}}}},"UserAggregateQueryResponse":{"type":"object","properties":{"systemToOrganizationMappings":{"type":"object","description":"A mapping from system presence to a list of organization presence ids","additionalProperties":{"type":"array","items":{"type":"string"}}},"results":{"type":"array","items":{"$ref":"#/definitions/UserAggregateDataContainer"}}}},"UserAggregateQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/UserAggregateQueryPredicate"}}}},"UserAggregateQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/UserAggregateQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/UserAggregateQueryPredicate"}}}},"UserAggregateQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"],"x-genesys-enum-members":[{"name":"dimension"},{"name":"property"},{"name":"metric"}]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["userId"],"x-genesys-enum-members":[{"name":"userId"}]},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"],"x-genesys-enum-members":[{"name":"matches"},{"name":"exists"},{"name":"notExists"}]},"value":{"type":"string","description":"Right hand side for dimension predicates"},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"UserAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["userId"],"x-genesys-enum-members":[{"name":"userId"}]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/UserAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["tAgentRoutingStatus","tOrganizationPresence","tSystemPresence"],"x-genesys-enum-members":[{"name":"tAgentRoutingStatus"},{"name":"tOrganizationPresence"},{"name":"tSystemPresence"}]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/UserAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"],"x-genesys-enum-members":[{"name":"eventTime"}]}}},"UserAggregationView":{"type":"object","required":["function","name","target"],"properties":{"target":{"type":"string","description":"Target metric name","enum":["tAgentRoutingStatus","tOrganizationPresence","tSystemPresence"],"x-genesys-enum-members":[{"name":"tAgentRoutingStatus"},{"name":"tOrganizationPresence"},{"name":"tSystemPresence"}]},"name":{"type":"string","description":"A unique name for this view. Must be distinct from other views and built-in metric names."},"function":{"type":"string","description":"Type of view you wish to create","enum":["rangeBound"],"x-genesys-enum-members":[{"name":"rangeBound"}]},"range":{"description":"Range of numbers for slicing up data","$ref":"#/definitions/AggregationRange"}}},"DateRangeWithOptionalEnd":{"type":"object","required":["startBusinessUnitDate"],"properties":{"startBusinessUnitDate":{"type":"string","format":"date","description":"The start date for work plan rotation or an agent, interpreted in the business unit's time zone. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"endBusinessUnitDate":{"type":"string","format":"date","description":"The end date for work plan rotation or an agent, interpreted in the business unit's time zone. Null denotes open ended date range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"}}},"WorkPlanPatternResponse":{"type":"object","properties":{"workPlans":{"type":"array","description":"List of work plans in order of rotation on a weekly basis","items":{"$ref":"#/definitions/WorkPlanReference"}}}},"WorkPlanRotationAgentResponse":{"type":"object","properties":{"user":{"description":"The user associated with this work plan rotation","$ref":"#/definitions/UserReference"},"dateRange":{"description":"The date range to which this agent is effective in the work plan rotation","$ref":"#/definitions/DateRangeWithOptionalEnd"},"position":{"type":"integer","format":"int32","description":"Start position of the work plan in the pattern for this agent in the work plan rotation. Position value starts from 0"}}},"WorkPlanRotationResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"enabled":{"type":"boolean","description":"Whether the work plan rotation is enabled for scheduling"},"dateRange":{"description":"The date range to which this work plan rotation applies","$ref":"#/definitions/DateRangeWithOptionalEnd"},"pattern":{"description":"Pattern with ordered list of work plans that rotate on a weekly basis","$ref":"#/definitions/WorkPlanPatternResponse"},"agentCount":{"type":"integer","format":"int32","description":"Number of agents in this work plan rotation"},"agents":{"type":"array","description":"Agents in this work plan rotation. Populate with expand=agents for GET WorkPlanRotationsList (defaults to empty list)","items":{"$ref":"#/definitions/WorkPlanRotationAgentResponse"}},"metadata":{"description":"Version metadata for this work plan rotation","$ref":"#/definitions/WfmVersionedEntityMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UpdateWorkPlanRotationAgentRequest":{"type":"object","required":["userId"],"properties":{"userId":{"type":"string","description":"The ID of an agent in this work plan rotation"},"dateRange":{"description":"The date range to which this agent is effective in the work plan rotation","$ref":"#/definitions/DateRangeWithOptionalEnd"},"position":{"type":"integer","format":"int32","description":"Start position of the work plan in the pattern for this agent in the work plan rotation. Position value starts from 0"},"delete":{"type":"boolean","description":"If marked true for this agent when updating, then this agent will be removed from this work plan rotation"}}},"UpdateWorkPlanRotationRequest":{"type":"object","required":["metadata"],"properties":{"name":{"type":"string","description":"Name of this work plan rotation"},"enabled":{"type":"boolean","description":"Whether the work plan rotation is enabled for scheduling"},"dateRange":{"description":"The date range to which this work plan rotation applies","$ref":"#/definitions/DateRangeWithOptionalEnd"},"agents":{"type":"array","description":"Agents in this work plan rotation","items":{"$ref":"#/definitions/UpdateWorkPlanRotationAgentRequest"}},"pattern":{"description":"Pattern with list of work plan IDs that rotate on a weekly basis","$ref":"#/definitions/WorkPlanPatternRequest"},"metadata":{"description":"Version metadata for this work plan rotation","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"WorkPlanPatternRequest":{"type":"object","required":["workPlanIds"],"properties":{"workPlanIds":{"type":"array","description":"List of work plan IDs in order of rotation on a weekly basis. Values in the list cannot be null or empty","items":{"type":"string"}}}},"WorkPlanRotationListResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WorkPlanRotationResponse"}}}},"AddWorkPlanRotationAgentRequest":{"type":"object","required":["dateRange","position","userId"],"properties":{"userId":{"type":"string","description":"The ID of an agent in this work plan rotation"},"dateRange":{"description":"The date range to which this agent is effective in the work plan rotation","$ref":"#/definitions/DateRangeWithOptionalEnd"},"position":{"type":"integer","format":"int32","description":"Start position of the work plan in the pattern for this agent in the work plan rotation. Position value starts from 0"}}},"AddWorkPlanRotationRequest":{"type":"object","required":["dateRange","name","pattern"],"properties":{"name":{"type":"string","description":"Name of this work plan rotation"},"dateRange":{"description":"The date range to which this work plan rotation applies","$ref":"#/definitions/DateRangeWithOptionalEnd"},"agents":{"type":"array","description":"Agents in this work plan rotation","items":{"$ref":"#/definitions/AddWorkPlanRotationAgentRequest"}},"pattern":{"description":"Pattern with list of work plan IDs that rotate on a weekly basis","$ref":"#/definitions/WorkPlanPatternRequest"}}},"CopyWorkPlanRotationRequest":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name to apply to the new copy of the work plan rotation"}}},"PostTextMessage":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Message type","enum":["Text","Structured","Receipt"],"x-genesys-enum-members":[{"name":"Text"},{"name":"Structured"},{"name":"Receipt"}]},"text":{"type":"string","description":"Message text. If type is structured, used as fallback for clients that do not support particular structured content"},"content":{"type":"array","description":"A list of content elements in message","items":{"$ref":"#/definitions/MessageContent"}}}},"PostTextResponse":{"type":"object","required":["botState"],"properties":{"botState":{"type":"string","description":"The state of the bot after completion of the request","enum":["Complete","Failed","MoreData"],"x-genesys-enum-members":[{"name":"Complete"},{"name":"Failed"},{"name":"MoreData"}]},"replyMessages":{"type":"array","description":"The list of messages to respond with, if any","items":{"$ref":"#/definitions/PostTextMessage"}},"intentName":{"type":"string","description":"The name of the intent the bot is either processing or has processed, this will be blank if no intent could be detected."},"slots":{"type":"object","description":"Data parameters detected and filled by the bot.","additionalProperties":{"type":"string"}},"botCorrelationId":{"type":"string","description":"The optional ID specified in the request"},"amazonLex":{"type":"object","description":"Raw data response from AWS (if called)","additionalProperties":{"type":"object"}},"googleDialogFlow":{"type":"object","description":"Raw data response from Google Dialogflow (if called)","additionalProperties":{"type":"object"}},"genesysDialogEngine":{"type":"object","description":"Raw data response from Genesys' Dialogengine (if called)","additionalProperties":{"type":"object"}}}},"AmazonLexRequest":{"type":"object","properties":{"requestAttributes":{"type":"object","description":"AttributeName/AttributeValue pairs of User Defined Request Attributes to be sent to the amazon bot See - https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-request-attribs","additionalProperties":{"type":"string"}},"sessionAttributes":{"type":"object","description":"AttributeName/AttributeValue pairs of Session Attributes to be sent to the amazon bot. See - https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-session-attribs","additionalProperties":{"type":"string"}}}},"GenesysBotConnector":{"type":"object","properties":{"queryParameters":{"type":"object","description":"User defined name/value parameters passed to the BotConnector bot.","additionalProperties":{"type":"string"}}}},"GoogleDialogflowCustomSettings":{"type":"object","properties":{"environment":{"type":"string","description":"If set this environment will be used to initiate the dialogflow bot, otherwise the default configuration will be used. See https://cloud.google.com/dialogflow/docs/agents-versions"},"eventName":{"type":"string","description":"If set this eventName will be used to initiate the dialogflow bot rather than language processing on the input text. See https://cloud.google.com/dialogflow/es/docs/events-overview"},"webhookQueryParameters":{"type":"object","description":"Parameters passed to the fulfillment webhook of the bot (if any).","additionalProperties":{"type":"string"}},"eventInputParameters":{"type":"object","description":"Parameters passed to the event input of the bot.","additionalProperties":{"type":"string"}}}},"PostTextRequest":{"type":"object","required":["botId","botSessionId","integrationId","postTextMessage"],"properties":{"botId":{"type":"string","description":"ID of the bot to send the text to."},"botAlias":{"type":"string","description":"Alias/Version of the bot"},"integrationId":{"type":"string","description":"the integration service id for the bot's credentials"},"botSessionId":{"type":"string","description":"GUID for this bot's session"},"postTextMessage":{"description":"Message to send to the bot","$ref":"#/definitions/PostTextMessage"},"languageCode":{"type":"string","description":"The launguage code the bot will run under"},"botSessionTimeoutMinutes":{"type":"integer","format":"int32","description":"Override timeout for the bot session. This should be greater than 10 minutes."},"botChannels":{"type":"array","description":"The channels this bot is utilizing","items":{"type":"string","enum":["Call","Callback","Messaging","Webchat"],"x-genesys-enum-members":[{"name":"Call"},{"name":"Callback"},{"name":"Messaging"},{"name":"Webchat"}]}},"botCorrelationId":{"type":"string","description":"Id for tracking the activity - this will be returned in the response"},"messagingPlatformType":{"type":"string","description":"If the channels list contains a 'Messaging' item and the messaging platform is known, include it here to get accurate analytics","enum":["Phone","SMS","GenesysWebWidget","FacebookMessenger","WeChat","Whatsapp","AppleBusinessChat","Telegram","Slack","Signal","Line","Discord","TwitterDirectMessage","Other","Unknown"],"x-genesys-enum-members":[{"name":"Phone"},{"name":"SMS"},{"name":"GenesysWebWidget"},{"name":"FacebookMessenger"},{"name":"WeChat"},{"name":"Whatsapp"},{"name":"AppleBusinessChat"},{"name":"Telegram"},{"name":"Slack"},{"name":"Signal"},{"name":"Line"},{"name":"Discord"},{"name":"TwitterDirectMessage"},{"name":"Other","description":"The transport of the bot conversation is something that isn't explicitly declared."},{"name":"Unknown","description":"The transport of the bot conversation is not known."}]},"amazonLexRequest":{"$ref":"#/definitions/AmazonLexRequest"},"googleDialogflow":{"$ref":"#/definitions/GoogleDialogflowCustomSettings"},"genesysBotConnector":{"$ref":"#/definitions/GenesysBotConnector"}}},"CommonCampaignDivisionView":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the Campaign."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"mediaType":{"type":"string","description":"The media type used for this campaign.","enum":["sms","voice"],"x-genesys-enum-members":[{"name":"sms"},{"name":"voice"}]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CommonCampaignDivisionViewEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CommonCampaignDivisionView"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Schedule":{"type":"object","required":["end","name","rrule","start"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"start":{"type":"string","format":"local-date-time","description":"Date time is represented as an ISO-8601 string without a timezone. For example: yyyy-MM-ddTHH:mm:ss.SSS"},"end":{"type":"string","format":"local-date-time","description":"Date time is represented as an ISO-8601 string without a timezone. For example: yyyy-MM-ddTHH:mm:ss.SSS"},"rrule":{"type":"string","description":"An iCal Recurrence Rule (RRULE) string."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Defines a period of time to perform a specific action. Each schedule must be associated with one or more schedule groups to be used."},"DomainOrgRoleDifference":{"type":"object","properties":{"removedPermissionPolicies":{"type":"array","items":{"$ref":"#/definitions/DomainPermissionPolicy"}},"addedPermissionPolicies":{"type":"array","items":{"$ref":"#/definitions/DomainPermissionPolicy"}},"samePermissionPolicies":{"type":"array","items":{"$ref":"#/definitions/DomainPermissionPolicy"}},"userOrgRole":{"$ref":"#/definitions/DomainOrganizationRole"},"roleFromDefault":{"$ref":"#/definitions/DomainOrganizationRole"}}},"BuAgentSchedulesSearchResponse":{"type":"object","properties":{"agentSchedules":{"type":"array","description":"The requested agent schedules","items":{"$ref":"#/definitions/BuAgentScheduleSearchResponse"}},"businessUnitTimeZone":{"type":"string","description":"The time zone configured for the business unit to which this schedule applies"},"publishedSchedules":{"type":"array","description":"References to all published week schedules overlapping the start/end date query parameters","items":{"$ref":"#/definitions/BuAgentSchedulePublishedScheduleReference"}}}},"BuAsyncAgentSchedulesSearchResponse":{"type":"object","properties":{"status":{"type":"string","description":"The status of the operation","enum":["Processing","Complete","Canceled","Error"],"x-genesys-enum-members":[{"name":"Processing"},{"name":"Complete"},{"name":"Canceled"},{"name":"Error"}]},"operationId":{"type":"string","description":"The ID for the operation"},"result":{"description":"The result of the operation. Null unless status == Complete","$ref":"#/definitions/BuAgentSchedulesSearchResponse"},"progress":{"type":"integer","format":"int32","description":"Percent progress for the operation"},"downloadUrl":{"type":"string","description":"The URL from which to download the result if it is too large to pass directly"}}},"BuSearchAgentSchedulesRequest":{"type":"object","required":["endDate","startDate"],"properties":{"startDate":{"type":"string","format":"date-time","description":"Start date of the range to search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endDate":{"type":"string","format":"date-time","description":"End date of the range to search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"userIds":{"type":"array","description":"IDs of the users for whose schedules to search","items":{"type":"string"}}}},"UserListScheduleRequestBody":{"type":"object","required":["endDate","startDate","userIds"],"properties":{"userIds":{"type":"array","description":"The user ids for which to fetch schedules","items":{"type":"string"}},"startDate":{"type":"string","format":"date-time","description":"Beginning of the range of schedules to fetch, in ISO-8601 format"},"endDate":{"type":"string","format":"date-time","description":"End of the range of schedules to fetch, in ISO-8601 format"},"loadFullWeeks":{"type":"boolean","description":"Whether to load the full week's schedule (for the requested users) of any week overlapping the start/end date query parameters, defaults to false"}},"description":"Request body for fetching the schedule for a group of users over a given time range"},"TimeOffRequestResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"user":{"description":"The user associated with this time off request","$ref":"#/definitions/UserReference"},"isFullDayRequest":{"type":"boolean","description":"Whether this is a full day request (false means partial day)"},"markedAsRead":{"type":"boolean","description":"Whether this request has been marked as read by the agent"},"activityCodeId":{"type":"string","description":"The ID of the activity code associated with this time off request. Activity code must be of the TimeOff category"},"status":{"type":"string","description":"The status of this time off request","enum":["PENDING","APPROVED","DENIED","CANCELED"],"x-genesys-enum-members":[{"name":"PENDING"},{"name":"APPROVED"},{"name":"DENIED"},{"name":"CANCELED"}]},"partialDayStartDateTimes":{"type":"array","description":"A set of start date-times in ISO-8601 format for partial day requests. Will be not empty if isFullDayRequest == false","uniqueItems":true,"items":{"type":"string","format":"date-time"}},"fullDayManagementUnitDates":{"type":"array","description":"A set of dates in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone. Will be not empty if isFullDayRequest == true","uniqueItems":true,"items":{"type":"string"}},"dailyDurationMinutes":{"type":"integer","format":"int32","description":"The daily duration of this time off request in minutes"},"notes":{"type":"string","description":"Notes about the time off request"},"submittedBy":{"description":"The user who submitted this time off request","$ref":"#/definitions/UserReference"},"submittedDate":{"type":"string","format":"date-time","description":"The timestamp when this request was submitted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"reviewedBy":{"description":"The user who reviewed this time off request","$ref":"#/definitions/UserReference"},"reviewedDate":{"type":"string","format":"date-time","description":"The timestamp when this request was reviewed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"description":"The user who last modified this TimeOffRequestResponse","$ref":"#/definitions/UserReference"},"modifiedDate":{"type":"string","format":"date-time","description":"The timestamp when this request was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"metadata":{"description":"The version metadata of the time off request","$ref":"#/definitions/WfmVersionedEntityMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AdminTimeOffRequestPatch":{"type":"object","required":["metadata"],"properties":{"status":{"type":"string","description":"The status of this time off request","enum":["PENDING","APPROVED","DENIED"],"x-genesys-enum-members":[{"name":"PENDING"},{"name":"APPROVED"},{"name":"DENIED"}]},"activityCodeId":{"type":"string","description":"The ID of the activity code associated with this time off request. Activity code must be of the TimeOff category"},"notes":{"type":"string","description":"Notes about the time off request"},"fullDayManagementUnitDates":{"type":"array","description":"A set of dates in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone.","uniqueItems":true,"items":{"type":"string"}},"partialDayStartDateTimes":{"type":"array","description":"A set of start date-times in ISO-8601 format for partial day requests.","uniqueItems":true,"items":{"type":"string","format":"date-time"}},"dailyDurationMinutes":{"type":"integer","format":"int32","description":"The daily duration of this time off request in minutes"},"metadata":{"description":"Version metadata for the time off request","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"TimeOffRequestList":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"timeOffRequests":{"type":"array","items":{"$ref":"#/definitions/TimeOffRequestResponse"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TimeOffRequest":{"type":"object","required":["id","user"],"properties":{"id":{"type":"string","description":"The id of the time off request"},"user":{"description":"The user that the time off request belongs to","$ref":"#/definitions/UserReference"},"isFullDayRequest":{"type":"boolean","description":"Whether this is a full day request (false means partial day)"},"markedAsRead":{"type":"boolean","description":"Whether this request has been marked as read by the agent"},"activityCodeId":{"type":"string","description":"The ID of the activity code associated with this time off request. Activity code must be of the TimeOff category"},"status":{"type":"string","description":"The status of this time off request","enum":["PENDING","APPROVED","DENIED","CANCELED"],"x-genesys-enum-members":[{"name":"PENDING"},{"name":"APPROVED"},{"name":"DENIED"},{"name":"CANCELED"}]},"partialDayStartDateTimes":{"type":"array","description":"A set of start date-times in ISO-8601 format for partial day requests. Will be not empty if isFullDayRequest == false","uniqueItems":true,"items":{"type":"string","format":"date-time"}},"fullDayManagementUnitDates":{"type":"array","description":"A set of dates in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone. Will be not empty if isFullDayRequest == true","uniqueItems":true,"items":{"type":"string"}},"dailyDurationMinutes":{"type":"integer","format":"int32","description":"The daily duration of this time off request in minutes"},"notes":{"type":"string","description":"Notes about the time off request"},"submittedBy":{"description":"The user who submitted this time off request","$ref":"#/definitions/UserReference"},"submittedDate":{"type":"string","format":"date-time","description":"The timestamp when this request was submitted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"reviewedBy":{"description":"The user who reviewed this time off request","$ref":"#/definitions/UserReference"},"reviewedDate":{"type":"string","format":"date-time","description":"The timestamp when this request was reviewed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"metadata":{"description":"The version metadata of the time off request","$ref":"#/definitions/WfmVersionedEntityMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TimeOffRequestListing":{"type":"object","required":["entities"],"properties":{"entities":{"type":"array","description":"List of time off request look up objects","items":{"$ref":"#/definitions/TimeOffRequest"}}}},"DateRange":{"type":"object","properties":{"startDate":{"type":"string","description":"The inclusive start of a date range in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone."},"endDate":{"type":"string","description":"The inclusive end of a date range in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone."}}},"TimeOffRequestQueryBody":{"type":"object","properties":{"userIds":{"type":"array","description":"The set of user ids to filter time off requests","uniqueItems":true,"items":{"type":"string"}},"statuses":{"type":"array","description":"The set of statuses to filter time off requests","uniqueItems":true,"items":{"type":"string","enum":["PENDING"],"x-genesys-enum-members":[{"name":"PENDING"}]}},"dateRange":{"description":"The inclusive range of dates to filter time off requests","$ref":"#/definitions/DateRange"}}},"CreateAdminTimeOffRequest":{"type":"object","required":["activityCodeId","dailyDurationMinutes","status","users"],"properties":{"status":{"type":"string","description":"The status of this time off request","enum":["PENDING","APPROVED"],"x-genesys-enum-members":[{"name":"PENDING"},{"name":"APPROVED"}]},"users":{"type":"array","description":"A set of IDs for users to associate with this time off request","uniqueItems":true,"items":{"$ref":"#/definitions/UserReference"}},"activityCodeId":{"type":"string","description":"The ID of the activity code associated with this time off request. Activity code must be of the TimeOff category"},"notes":{"type":"string","description":"Notes about the time off request"},"fullDayManagementUnitDates":{"type":"array","description":"A set of dates in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone.","uniqueItems":true,"items":{"type":"string"}},"partialDayStartDateTimes":{"type":"array","description":"A set of start date-times in ISO-8601 format for partial day requests.","uniqueItems":true,"items":{"type":"string","format":"date-time"}},"dailyDurationMinutes":{"type":"integer","format":"int32","description":"The daily duration of this time off request in minutes"}}},"DID":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"phoneNumber":{"type":"string"},"didPool":{"$ref":"#/definitions/DomainEntityRef"},"owner":{"description":"A Uri reference to the owner of this DID, which is either a User or an IVR","$ref":"#/definitions/DomainEntityRef"},"ownerType":{"type":"string","enum":["USER","PHONE","IVR_CONFIG","GROUP"],"x-genesys-enum-members":[{"name":"USER"},{"name":"PHONE"},{"name":"IVR_CONFIG"},{"name":"GROUP"}]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ActionMap":{"type":"object","required":["displayName","pageUrlConditions","triggerWithSegments"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"version":{"type":"integer","format":"int32","description":"The version of the action map."},"isActive":{"type":"boolean","description":"Whether the action map is active."},"displayName":{"type":"string","description":"Display name of the action map."},"triggerWithSegments":{"type":"array","description":"Trigger action map if any segment in the list is assigned to a given customer.","items":{"type":"string"}},"triggerWithEventConditions":{"type":"array","description":"List of event conditions that must be satisfied to trigger the action map.","items":{"$ref":"#/definitions/EventCondition"}},"triggerWithOutcomeProbabilityConditions":{"type":"array","description":"Probability conditions for outcomes that must be satisfied to trigger the action map.","items":{"$ref":"#/definitions/OutcomeProbabilityCondition"}},"pageUrlConditions":{"type":"array","description":"URL conditions that a page must match for web actions to be displayable.","items":{"$ref":"#/definitions/UrlCondition"}},"activation":{"description":"Type of activation.","$ref":"#/definitions/Activation"},"weight":{"type":"integer","format":"int32","description":"Weight of the action map with higher number denoting higher weight."},"action":{"description":"The action that will be executed if this action map is triggered.","$ref":"#/definitions/ActionMapAction"},"actionMapScheduleGroups":{"description":"The action map's associated schedule groups.","$ref":"#/definitions/ActionMapScheduleGroups"},"ignoreFrequencyCap":{"type":"boolean","description":"Override organization-level frequency cap and always offer web engagements from this action map."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"createdDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the action map was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the action map was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startDate":{"type":"string","format":"date-time","description":"Timestamp at which the action map is scheduled to start firing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endDate":{"type":"string","format":"date-time","description":"Timestamp at which the action map is scheduled to stop firing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"ActionMapAction":{"type":"object","properties":{"actionTemplate":{"description":"Action template associated with the action map.","$ref":"#/definitions/ActionMapActionTemplate"},"mediaType":{"type":"string","description":"Media type of action.","enum":["webchat","webMessagingOffer","contentOffer","integrationAction","architectFlow"],"x-genesys-enum-members":[{"name":"webchat"},{"name":"webMessagingOffer"},{"name":"contentOffer"},{"name":"integrationAction"},{"name":"architectFlow"}]},"architectFlowFields":{"description":"Architect Flow Id and input contract.","$ref":"#/definitions/ArchitectFlowFields"}}},"ActionMapActionTemplate":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ActionMapScheduleGroup":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the action maps's associated schedule group."}}},"ActionMapScheduleGroups":{"type":"object","required":["actionMapScheduleGroup"],"properties":{"actionMapScheduleGroup":{"description":"The actions map's associated schedule group.","$ref":"#/definitions/ActionMapScheduleGroup"},"emergencyActionMapScheduleGroup":{"description":"The action map's associated emergency schedule group.","$ref":"#/definitions/ActionMapScheduleGroup"}}},"ActionProperties":{"type":"object","properties":{"webchatPrompt":{"type":"string","description":"Prompt message shown to user, used for webchat type action."},"webchatTitleText":{"type":"string","description":"Title shown to the user, used for webchat type action."},"webchatAcceptText":{"type":"string","description":"Accept button text shown to user, used for webchat type action."},"webchatDeclineText":{"type":"string","description":"Decline button text shown to user, used for webchat type action."},"webchatSurvey":{"description":"Survey provided to the user, used for webchat type action.","$ref":"#/definitions/ActionSurvey"}}},"ActionSurvey":{"type":"object","required":["questions"],"properties":{"questions":{"type":"array","description":"Questions shown to the user.","items":{"$ref":"#/definitions/JourneySurveyQuestion"}}}},"ActionTarget":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"userData":{"type":"array","description":"Additional user data associated with the target in key/value format.","items":{"$ref":"#/definitions/KeyValue"}},"supportedMediaTypes":{"type":"array","description":"Supported media types of the target.","items":{"type":"string","enum":["callback","call","email","generic","messaging","social","webchat"],"x-genesys-enum-members":[{"name":"callback"},{"name":"call"},{"name":"email"},{"name":"generic"},{"name":"messaging"},{"name":"social"},{"name":"webchat"}]}},"state":{"type":"string","description":"Indicates the state of the target.","enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"description":{"type":"string","description":"Description of the target."},"serviceLevel":{"description":"Service Level of the action target. Chat offers for the target will be throttled with the aim of achieving this service level.","$ref":"#/definitions/ServiceLevel"},"shortAbandonThreshold":{"type":"integer","format":"int32","description":"Indicates the non-default short abandon threshold"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"createdDate":{"type":"string","format":"date-time","description":"The date the target was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedDate":{"type":"string","format":"date-time","description":"The date the target was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"Activation":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Type of activation."},"delayInSeconds":{"type":"integer","format":"int32","description":"Activation delay time amount."}}},"ArchitectFlowFields":{"type":"object","properties":{"architectFlow":{"description":"The architect flow.","$ref":"#/definitions/AddressableEntityRef"},"flowRequestMappings":{"type":"array","description":"Collection of Architect Flow Request Mappings to use.","items":{"$ref":"#/definitions/RequestMapping"}}}},"EventCondition":{"type":"object","required":["key","sessionType","streamType","values"],"properties":{"key":{"type":"string","description":"The event key."},"values":{"type":"array","description":"The event values.","items":{"type":"string"}},"operator":{"type":"string","description":"The comparison operator.","enum":["containsAll","containsAny","notContainsAll","notContainsAny","equal","notEqual","greaterThan","greaterThanOrEqual","lessThan","lessThanOrEqual","startsWith","endsWith"],"x-genesys-enum-members":[{"name":"containsAll"},{"name":"containsAny"},{"name":"notContainsAll"},{"name":"notContainsAny"},{"name":"equal"},{"name":"notEqual"},{"name":"greaterThan"},{"name":"greaterThanOrEqual"},{"name":"lessThan"},{"name":"lessThanOrEqual"},{"name":"startsWith"},{"name":"endsWith"}]},"streamType":{"type":"string","description":"The stream type for which this condition can be satisfied.","enum":["Web","Custom","Conversation"],"x-genesys-enum-members":[{"name":"Web"},{"name":"Custom"},{"name":"Conversation"}]},"sessionType":{"type":"string","description":"The session type for which this condition can be satisfied."},"eventName":{"type":"string","description":"The name of the event for which this condition can be satisfied."}}},"JourneySegment":{"type":"object","required":["displayName"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"isActive":{"type":"boolean","description":"Whether or not the segment is active."},"displayName":{"type":"string","description":"The display name of the segment."},"version":{"type":"integer","format":"int32","description":"The version of the segment."},"description":{"type":"string","description":"A description of the segment."},"color":{"type":"string","description":"The hexadecimal color value of the segment."},"scope":{"type":"string","description":"The target entity that a segment applies to.","enum":["Session","Customer"],"x-genesys-enum-members":[{"name":"Session"},{"name":"Customer"}]},"shouldDisplayToAgent":{"type":"boolean","description":"Whether or not the segment should be displayed to agent/supervisor users."},"context":{"description":"The context of the segment.","$ref":"#/definitions/Context"},"journey":{"description":"The pattern of rules defining the segment.","$ref":"#/definitions/Journey"},"assignmentExpirationDays":{"type":"integer","format":"int32","description":"Time, in days, from when the segment is assigned until it is automatically unassigned."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"createdDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the segment was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the the segment was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"JourneySurveyQuestion":{"type":"object","required":["label"],"properties":{"type":{"type":"string","description":"Type of survey question.","enum":["text","hidden","select","checkbox","textarea"],"x-genesys-enum-members":[{"name":"text"},{"name":"hidden"},{"name":"select"},{"name":"checkbox"},{"name":"textarea"}]},"label":{"type":"string","description":"Label of question."},"customerProperty":{"type":"string","description":"The customer property that the answer maps to.","enum":["givenName","familyName","email","phone","gender","companyName"],"x-genesys-enum-members":[{"name":"givenName"},{"name":"familyName"},{"name":"email"},{"name":"phone"},{"name":"gender"},{"name":"companyName"}]},"choices":{"type":"array","description":"Choices available to user.","items":{"type":"string"}},"isMandatory":{"type":"boolean","description":"Whether answering this question is mandatory."}}},"KeyValue":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","description":"Key for free-form data."},"value":{"type":"string","description":"Value for free-form data."}}},"OutcomeProbabilityCondition":{"type":"object","required":["maximumProbability","outcomeId"],"properties":{"outcomeId":{"type":"string","description":"The outcome ID."},"maximumProbability":{"type":"number","format":"float","description":"Probability value for the selected outcome at or above which the action map will trigger."},"probability":{"type":"number","format":"float","description":"Additional probability condition, where if set, the action map will trigger if the current outcome probability is lower or equal to the value."}}},"UrlCondition":{"type":"object","required":["operator","values"],"properties":{"values":{"type":"array","description":"The URL condition value.","items":{"type":"string"}},"operator":{"type":"string","description":"The comparison operator.","enum":["containsAll","containsAny","notContainsAll","notContainsAny","equal","notEqual","greaterThan","greaterThanOrEqual","lessThan","lessThanOrEqual","startsWith","endsWith"],"x-genesys-enum-members":[{"name":"containsAll"},{"name":"containsAny"},{"name":"notContainsAll"},{"name":"notContainsAny"},{"name":"equal"},{"name":"notEqual"},{"name":"greaterThan"},{"name":"greaterThanOrEqual"},{"name":"lessThan"},{"name":"lessThanOrEqual"},{"name":"startsWith"},{"name":"endsWith"}]}}},"WebChatMemberInfo":{"type":"object","required":["role"],"properties":{"id":{"type":"string","description":"The communicationId of this member."},"displayName":{"type":"string","description":"The display name of the member."},"firstName":{"type":"string","description":"The first name of the member."},"lastName":{"type":"string","description":"The last name of the member."},"email":{"type":"string","description":"The email address of the member."},"phoneNumber":{"type":"string","description":"The phone number of the member."},"avatarImageUrl":{"type":"string","format":"uri","description":"The url to the avatar image of the member."},"role":{"type":"string","description":"The role of the member, one of [agent, customer, acd, workflow]","enum":["AGENT","CUSTOMER","WORKFLOW","ACD"],"x-genesys-enum-members":[{"name":"AGENT"},{"name":"CUSTOMER"},{"name":"WORKFLOW"},{"name":"ACD"}]},"joinDate":{"type":"string","format":"date-time","description":"The time the member joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"leaveDate":{"type":"string","format":"date-time","description":"The time the member left the conversation, or null if the member is still active in the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"authenticatedGuest":{"type":"boolean","description":"If true, the guest member is an authenticated guest."},"customFields":{"type":"object","description":"Any custom fields of information pertaining to this member.","additionalProperties":{"type":"string"}},"state":{"type":"string","description":"The connection state of this member.","enum":["CONNECTED","DISCONNECTED","ALERTING"],"x-genesys-enum-members":[{"name":"CONNECTED"},{"name":"DISCONNECTED"},{"name":"ALERTING"}]}}},"WebChatMemberInfoEntityList":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WebChatMemberInfo"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"WritableEntity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."}}},"ApiUsageQueryResult":{"type":"object","properties":{"results":{"type":"array","description":"Query results","items":{"$ref":"#/definitions/ApiUsageRow"}},"queryStatus":{"type":"string","description":"Query status","enum":["Complete","Failed","Running"],"x-genesys-enum-members":[{"name":"Complete"},{"name":"Failed"},{"name":"Running"}]}}},"ApiUsageRow":{"type":"object","properties":{"clientId":{"type":"string","description":"Client Id associated with this query result"},"clientName":{"type":"string","description":"Client Name associated with this query result"},"organizationId":{"type":"string","description":"Organization Id associated with this query result"},"userId":{"type":"string","description":"User Id associated with this query result"},"templateUri":{"type":"string","description":"Template Uri associated with this query result"},"httpMethod":{"type":"string","description":"HTTP Method associated with this query result"},"status200":{"type":"integer","format":"int64","description":"Number of requests resulting in a 2xx HTTP status code"},"status300":{"type":"integer","format":"int64","description":"Number of requests resulting in a 3xx HTTP status code"},"status400":{"type":"integer","format":"int64","description":"Number of requests resulting in a 4xx HTTP status code"},"status500":{"type":"integer","format":"int64","description":"Number of requests resulting in a 5xx HTTP status code"},"status429":{"type":"integer","format":"int64","description":"Number of requests resulting in a 429 HTTP status code, this is a subset of the count returned with status400"},"requests":{"type":"integer","format":"int64","description":"Total number of requests"},"date":{"type":"string","format":"date-time","description":"Date of requests, based on granularity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"MediaUtilization":{"type":"object","properties":{"maximumCapacity":{"type":"integer","format":"int32","description":"Defines the maximum number of conversations of this type that an agent can handle at one time."},"interruptableMediaTypes":{"type":"array","description":"Defines the list of other media types that can interrupt a conversation of this media type. Values include call, chat, email, callback, and message.","items":{"type":"string"}},"includeNonAcd":{"type":"boolean","description":"If true, then track non-ACD conversations against utilization"}}},"Utilization":{"type":"object","properties":{"utilization":{"type":"object","description":"Map of media type to utilization settings. Valid media types include call, callback, chat, email, and message.","additionalProperties":{"$ref":"#/definitions/MediaUtilization"}}}},"TranscriptUrl":{"type":"object","properties":{"url":{"type":"string","description":"The pre-signed S3 URL of the transcript"}}},"BusinessUnitListItem":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"authorized":{"type":"boolean","description":"Whether the user has authorization to interact with this business unit","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BusinessUnitListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/BusinessUnitListItem"}}}},"CallbackConversation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"participants":{"type":"array","description":"The list of participants involved in the conversation.","items":{"$ref":"#/definitions/CallbackMediaParticipant"}},"otherMediaUris":{"type":"array","description":"The list of other media channels involved in the conversation.","items":{"type":"string","format":"uri"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CallbackConversationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CallbackConversation"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CallbackMediaParticipant":{"type":"object","properties":{"id":{"type":"string","description":"The unique participant ID."},"name":{"type":"string","description":"The display friendly name of the participant."},"address":{"type":"string","description":"The participant address."},"startTime":{"type":"string","format":"date-time","description":"The time when this participant first joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The time when this participant went connected for this media (eg: video connected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startHoldTime":{"type":"string","format":"date-time","description":"The time when this participant's hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"purpose":{"type":"string","description":"The participant's purpose. Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr"},"state":{"type":"string","description":"The participant's state. Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","converting","uploading","transmitting","none"],"x-genesys-enum-members":[{"name":"alerting"},{"name":"dialing"},{"name":"contacting"},{"name":"offering"},{"name":"connected"},{"name":"disconnected"},{"name":"terminated"},{"name":"converting"},{"name":"uploading"},{"name":"transmitting"},{"name":"none"}]},"direction":{"type":"string","description":"The participant's direction. Values can be: 'inbound' or 'outbound'","enum":["inbound","outbound"],"x-genesys-enum-members":[{"name":"inbound"},{"name":"outbound"}]},"disconnectType":{"type":"string","description":"The reason the participant was disconnected from the conversation.","enum":["endpoint","client","system","transfer","transfer.conference","transfer.consult","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam"],"x-genesys-enum-members":[{"name":"endpoint"},{"name":"client"},{"name":"system"},{"name":"transfer"},{"name":"transfer.conference"},{"name":"transfer.consult"},{"name":"transfer.forward"},{"name":"transfer.noanswer"},{"name":"transfer.notavailable"},{"name":"transport.failure"},{"name":"error"},{"name":"peer"},{"name":"other"},{"name":"spam"}]},"held":{"type":"boolean","description":"Value is true when the participant is on hold."},"wrapupRequired":{"type":"boolean","description":"Value is true when the participant requires wrap-up."},"wrapupPrompt":{"type":"string","description":"The wrap-up prompt indicating the type of wrap-up to be performed."},"user":{"description":"The PureCloud user for this participant.","$ref":"#/definitions/DomainEntityRef"},"queue":{"description":"The PureCloud queue for this participant.","$ref":"#/definitions/DomainEntityRef"},"team":{"description":"The PureCloud team for this participant.","$ref":"#/definitions/DomainEntityRef"},"attributes":{"type":"object","description":"A list of ad-hoc attributes for the participant.","additionalProperties":{"type":"string"}},"errorInfo":{"description":"If the conversation ends in error, contains additional error details.","$ref":"#/definitions/ErrorInfo"},"script":{"description":"The Engage script that should be used by this participant.","$ref":"#/definitions/DomainEntityRef"},"wrapupTimeoutMs":{"type":"integer","format":"int32","description":"The amount of time the participant has to complete wrap-up."},"wrapupSkipped":{"type":"boolean","description":"Value is true when the participant has skipped wrap-up."},"alertingTimeoutMs":{"type":"integer","format":"int32","description":"Specifies how long the agent has to answer an interaction before being marked as not responding."},"provider":{"type":"string","description":"The source provider for the communication."},"externalContact":{"description":"If this participant represents an external contact, then this will be the reference for the external contact.","$ref":"#/definitions/DomainEntityRef"},"externalOrganization":{"description":"If this participant represents an external org, then this will be the reference for the external org.","$ref":"#/definitions/DomainEntityRef"},"wrapup":{"description":"Wrapup for this participant, if it has been applied.","$ref":"#/definitions/Wrapup"},"peer":{"type":"string","description":"The peer communication corresponding to a matching leg for this communication."},"flaggedReason":{"type":"string","description":"The reason specifying why participant flagged the conversation.","enum":["general"],"x-genesys-enum-members":[{"name":"general"}]},"journeyContext":{"description":"Journey System data/context that is applicable to this communication. When used for historical purposes, the context should be immutable. When null, there is no applicable Journey System context.","$ref":"#/definitions/JourneyContext"},"conversationRoutingData":{"description":"Information on how a communication should be routed to an agent.","$ref":"#/definitions/ConversationRoutingData"},"startAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"outboundPreview":{"description":"The outbound preview associated with this callback.","$ref":"#/definitions/DialerPreview"},"voicemail":{"description":"The voicemail associated with this callback.","$ref":"#/definitions/Voicemail"},"callbackNumbers":{"type":"array","description":"The list of phone number to use for this callback.","items":{"type":"string"}},"callbackUserName":{"type":"string","description":"The name of the callback target."},"externalCampaign":{"type":"boolean","description":"True if the call for the callback uses external dialing."},"skipEnabled":{"type":"boolean","description":"If true, the callback can be skipped."},"timeoutSeconds":{"type":"integer","format":"int32","description":"Duration in seconds before the callback will be auto-dialed."},"automatedCallbackConfigId":{"type":"string","description":"The id of the config for automatically placing the callback (and handling the disposition). If absent, the callback will not be placed automatically but routed to an agent as per normal."},"callbackScheduledTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"ContactCallbackRequest":{"type":"object","required":["campaignId","contactId","contactListId","phoneColumn","schedule"],"properties":{"campaignId":{"type":"string","description":"Campaign identifier"},"contactListId":{"type":"string","description":"Contact list identifier"},"contactId":{"type":"string","description":"Contact identifier"},"phoneColumn":{"type":"string","description":"Name of the phone column containing the number to be called"},"schedule":{"type":"string","description":"The scheduled time for the callback as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ\", example = \"2016-01-02T16:59:59\""}}},"Keyword":{"type":"object","required":["agentScoreModifier","confidence","customerScoreModifier","phrase"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"phrase":{"type":"string","description":"The word or phrase which is being looked for with speech recognition."},"confidence":{"type":"integer","format":"int32","description":"A sensitivity threshold that can be increased to lower false positives or decreased to reduce false negatives."},"agentScoreModifier":{"type":"integer","format":"int32","description":"A modifier to the evaluation score when the phrase is spotted in the agent channel"},"customerScoreModifier":{"type":"integer","format":"int32","description":"A modifier to the evaluation score when the phrase is spotted in the customer channel"},"alternateSpellings":{"type":"array","description":"Other spellings of the phrase that can be added to reduce missed spots (false negatives).","items":{"type":"string"}},"pronunciations":{"type":"array","description":"The phonetic spellings for the phrase and alternate spellings.","items":{"type":"string"}},"antiWords":{"type":"array","description":"Words that are similar to the phrase but not desired. Added to reduce incorrect spots (false positives).","items":{"type":"string"}},"antiPronunciations":{"type":"array","description":"The phonetic spellings for the antiWords.","items":{"type":"string"}},"spotabilityIndex":{"type":"number","format":"double","description":"A prediction of how easy it is to unambiguously spot the keyword within its language based on spelling."},"marginOfError":{"type":"number","format":"double"},"pronunciation":{"type":"string"}}},"KeywordSet":{"type":"object","required":["keywords","language","participantPurposes"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"queues":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/Queue"}},"language":{"type":"string","description":"Language code, such as 'en-US'"},"agents":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/User"}},"keywords":{"type":"array","description":"The list of keywords to be used for keyword spotting.","items":{"$ref":"#/definitions/Keyword"}},"participantPurposes":{"type":"array","description":"The types of participants to use keyword spotting on.","uniqueItems":true,"items":{"type":"string","enum":["AGENT","CUSTOMER"],"x-genesys-enum-members":[{"name":"AGENT"},{"name":"CUSTOMER"}]}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ConversationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Conversation"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"GroupProfile":{"type":"object","required":["version"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"state":{"type":"string","description":"The state of the user resource","enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"dateModified":{"type":"string","format":"date-time","description":"Datetime of the last modification. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int64","description":"The version of the group resource"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GroupProfileEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/GroupProfile"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AgentTimeOffRequestPatch":{"type":"object","properties":{"markedAsRead":{"type":"boolean","description":"Whether this request has been read by the agent"},"status":{"type":"string","description":"The status of this time off request. Can only be canceled if the requested date has not already passed","enum":["CANCELED"],"x-genesys-enum-members":[{"name":"CANCELED"}]},"notes":{"type":"string","description":"Notes about the time off request. Can only be edited while the request is still pending"}}},"CreateAgentTimeOffRequest":{"type":"object","required":["activityCodeId","dailyDurationMinutes"],"properties":{"activityCodeId":{"type":"string","description":"The ID of the activity code associated with this time off request. Activity code must be of the TimeOff category"},"notes":{"type":"string","description":"Notes about the time off request"},"fullDayManagementUnitDates":{"type":"array","description":"A set of dates in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone.","uniqueItems":true,"items":{"type":"string"}},"partialDayStartDateTimes":{"type":"array","description":"A set of start date-times in ISO-8601 format for partial day requests.","uniqueItems":true,"items":{"type":"string","format":"date-time"}},"dailyDurationMinutes":{"type":"integer","format":"int32","description":"The daily duration of this time off request in minutes"}}},"DefaultGreetingList":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"owner":{"$ref":"#/definitions/GreetingOwner"},"ownerType":{"type":"string","enum":["USER","ORGANIZATION","GROUP"],"x-genesys-enum-members":[{"name":"USER"},{"name":"ORGANIZATION"},{"name":"GROUP"}]},"greetings":{"type":"object","additionalProperties":{"$ref":"#/definitions/Greeting"}},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"type":"string","format":"uri"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Greeting":{"type":"object","required":["owner","ownerType","type"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"type":{"type":"string","description":"Greeting type","enum":["STATION","VOICEMAIL","NAME"],"x-genesys-enum-members":[{"name":"STATION"},{"name":"VOICEMAIL"},{"name":"NAME"}]},"ownerType":{"type":"string","description":"Greeting owner type","enum":["USER","ORGANIZATION","GROUP"],"x-genesys-enum-members":[{"name":"USER"},{"name":"ORGANIZATION"},{"name":"GROUP"}]},"owner":{"description":"Greeting owner","$ref":"#/definitions/DomainEntity"},"audioFile":{"$ref":"#/definitions/GreetingAudioFile"},"audioTTS":{"type":"string"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"type":"string","format":"uri"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GreetingAudioFile":{"type":"object","properties":{"durationMilliseconds":{"type":"integer","format":"int64"},"sizeBytes":{"type":"integer","format":"int64"},"selfUri":{"type":"string","format":"uri"}}},"GreetingOwner":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"InboundRouteEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/InboundRoute"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"UserActionCategory":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserActionCategoryEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UserActionCategory"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"VendorConnectionRequest":{"type":"object","required":["name","publisher","type"],"properties":{"publisher":{"type":"string","description":"Publisher of the integration or connector who registered the new connection. Typically, inin."},"type":{"type":"string","description":"Integration or connector type that registered the new connection. Example, wfm-rta-integration"},"name":{"type":"string","description":"Name of the integration or connector instance that registered the new connection. Example, my-wfm"}}},"TwitterIntegration":{"type":"object","required":["accessTokenKey","consumerKey","id","name","tier","version"],"properties":{"id":{"type":"string","description":"A unique Integration Id","readOnly":true},"name":{"type":"string","description":"The name of the Twitter Integration"},"accessTokenKey":{"type":"string","description":"The Access Token Key from Twitter messenger"},"consumerKey":{"type":"string","description":"The Consumer Key from Twitter messenger"},"username":{"type":"string","description":"The Username from Twitter"},"userId":{"type":"string","description":"The UserId from Twitter"},"status":{"type":"string","description":"The status of the Twitter Integration"},"tier":{"type":"string","description":"The type of twitter account to be used for the integration","enum":["premium","enterprise"]},"envName":{"type":"string","description":"The Twitter environment name, e.g.: env-beta (required for premium tier)"},"recipient":{"description":"The recipient associated to the Twitter Integration. This recipient is used to associate a flow to an integration","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"dateCreated":{"type":"string","format":"date-time","description":"Date this Integration was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date this Integration was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"description":"User reference that created this Integration","$ref":"#/definitions/DomainEntityRef"},"modifiedBy":{"description":"User reference that last modified this Integration","$ref":"#/definitions/DomainEntityRef"},"version":{"type":"integer","format":"int32","description":"Version number required for updates."},"createStatus":{"type":"string","description":"Status of asynchronous create operation","readOnly":true,"enum":["Initiated","Completed","Error"],"x-genesys-enum-members":[{"name":"Initiated","description":"The integration create request has started"},{"name":"Completed","description":"The integration create request has finished successfully"},{"name":"Error","description":"The integration create request has finished in error."}]},"createError":{"description":"Error information returned, if createStatus is set to Error","readOnly":true,"$ref":"#/definitions/ErrorBody"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TwitterIntegrationRequest":{"type":"object","required":["accessTokenKey","accessTokenSecret","consumerKey","consumerSecret","name","tier"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the Twitter Integration"},"accessTokenKey":{"type":"string","description":"The Access Token Key from Twitter messenger"},"accessTokenSecret":{"type":"string","description":"The Access Token Secret from Twitter messenger"},"consumerKey":{"type":"string","description":"The Consumer Key from Twitter messenger"},"consumerSecret":{"type":"string","description":"The Consumer Secret from Twitter messenger"},"tier":{"type":"string","description":"The type of twitter account to be used for the integration","enum":["premium","enterprise"]},"envName":{"type":"string","description":"The Twitter environment name, e.g.: env-beta (required for premium tier)"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TwitterIntegrationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/TwitterIntegration"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ScheduleGroup":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"timeZone":{"type":"string","description":"The timezone the schedules are a part of. This is not a schedule property to allow a schedule to be used in multiple timezones."},"openSchedules":{"type":"array","description":"The schedules defining the hours an organization is open.","items":{"$ref":"#/definitions/DomainEntityRef"}},"closedSchedules":{"type":"array","description":"The schedules defining the hours an organization is closed.","items":{"$ref":"#/definitions/DomainEntityRef"}},"holidaySchedules":{"type":"array","description":"The schedules defining the hours an organization is closed for the holidays.","items":{"$ref":"#/definitions/DomainEntityRef"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"A group of schedules that define the operating hours of an organization."},"ScheduleGroupEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ScheduleGroup"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FaxSendResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"uploadDestinationUri":{"type":"string","format":"uri"},"uploadMethodType":{"type":"string","enum":["SINGLE_PUT","MULTIPART_POST"],"x-genesys-enum-members":[{"name":"SINGLE_PUT"},{"name":"MULTIPART_POST"}]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CoverSheet":{"type":"object","properties":{"notes":{"type":"string","description":"Text to be added to the coversheet"},"locale":{"type":"string","description":"Locale, e.g. = en-US"}}},"FaxSendRequest":{"type":"object","required":["addresses"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"addresses":{"type":"array","description":"A list of outbound fax dialing addresses. E.g. +13175555555 or 3175555555","items":{"type":"string"}},"documentId":{"type":"string","description":"DocumentId of Content Management artifact. If Content Management document is not used for faxing, documentId should be null"},"contentType":{"type":"string","description":"The content type that is going to be uploaded. If Content Management document is used for faxing, contentType will be ignored","enum":["application/pdf","image/tiff","application/msword","application/vnd.oasis.opendocument.text","application/vnd.openxmlformats-officedocument.wordprocessingml.document"]},"workspace":{"description":"Workspace in which the document should be stored. If Content Management document is used for faxing, workspace will be ignored","$ref":"#/definitions/Workspace"},"coverSheet":{"description":"Data for coversheet generation.","$ref":"#/definitions/CoverSheet"},"timeZoneOffsetMinutes":{"type":"integer","format":"int32","description":"Time zone offset minutes from GMT"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Workspace":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The current name of the workspace."},"type":{"type":"string","enum":["USER","GROUP"],"x-genesys-enum-members":[{"name":"USER"},{"name":"GROUP"}]},"isCurrentUserWorkspace":{"type":"boolean"},"user":{"$ref":"#/definitions/DomainEntityRef"},"bucket":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"summary":{"$ref":"#/definitions/WorkspaceSummary"},"acl":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkspaceSummary":{"type":"object","properties":{"totalDocumentCount":{"type":"integer","format":"int64"},"totalDocumentByteCount":{"type":"integer","format":"int64"}}},"SystemPresence":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EdgeEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Edge"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"RecordingMetadata":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"conversationId":{"type":"string"},"path":{"type":"string"},"startTime":{"type":"string","description":"The start time of the recording for screen recordings. Null for other types."},"endTime":{"type":"string"},"media":{"type":"string","description":"The type of media that the recording is. At the moment that could be audio, chat, email, or message."},"annotations":{"type":"array","description":"Annotations that belong to the recording. Populated when recording filestate is AVAILABLE.","items":{"$ref":"#/definitions/Annotation"}},"fileState":{"type":"string","description":"Represents the current file state for a recording. Examples: Uploading, Archived, etc","enum":["ARCHIVED","AVAILABLE","DELETED","RESTORED","RESTORING","UPLOADING","ERROR"],"x-genesys-enum-members":[{"name":"ARCHIVED"},{"name":"AVAILABLE"},{"name":"DELETED"},{"name":"RESTORED"},{"name":"RESTORING"},{"name":"UPLOADING"},{"name":"ERROR"}]},"restoreExpirationTime":{"type":"string","format":"date-time","description":"The amount of time a restored recording will remain restored before being archived again. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"archiveDate":{"type":"string","format":"date-time","description":"The date the recording will be archived. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"archiveMedium":{"type":"string","description":"The type of archive medium used. Example: CloudArchive","enum":["CLOUDARCHIVE"],"x-genesys-enum-members":[{"name":"CLOUDARCHIVE"}]},"deleteDate":{"type":"string","format":"date-time","description":"The date the recording will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"exportDate":{"type":"string","format":"date-time","description":"The date the recording will be exported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"exportedDate":{"type":"string","format":"date-time","description":"The date the recording was exported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"maxAllowedRestorationsForOrg":{"type":"integer","format":"int32","description":"How many archive restorations the organization is allowed to have."},"remainingRestorationsAllowedForOrg":{"type":"integer","format":"int32","description":"The remaining archive restorations the organization has."},"sessionId":{"type":"string","description":"The session id represents an external resource id, such as email, call, chat, etc"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LineEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Line"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FaxDocument":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"contentUri":{"type":"string","format":"uri"},"workspace":{"$ref":"#/definitions/DomainEntityRef"},"createdBy":{"$ref":"#/definitions/DomainEntityRef"},"contentType":{"type":"string"},"contentLength":{"type":"integer","format":"int64"},"filename":{"type":"string"},"read":{"type":"boolean"},"pageCount":{"type":"integer","format":"int64"},"callerAddress":{"type":"string"},"receiverAddress":{"type":"string"},"thumbnails":{"type":"array","items":{"$ref":"#/definitions/DocumentThumbnail"}},"sharingUri":{"type":"string","format":"uri"},"downloadSharingUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KeywordSetEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/KeywordSet"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"LibraryEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Library"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AnalyticsConversationSegment":{"type":"object","properties":{"segmentStart":{"type":"string","format":"date-time","description":"The timestamp when this segment began. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"segmentEnd":{"type":"string","format":"date-time","description":"The timestamp when this segment ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"queueId":{"type":"string","description":"Queue identifier"},"wrapUpCode":{"type":"string","description":"Wrapup Code id"},"wrapUpNote":{"type":"string","description":"Note entered by an agent during after-call work"},"wrapUpTags":{"type":"array","items":{"type":"string"}},"errorCode":{"type":"string"},"disconnectType":{"type":"string","description":"A description of the event that disconnected the segment","enum":["endpoint","client","system","transfer","error","peer","other","spam","transportFailure","conferenceTransfer","consultTransfer","forwardTransfer","timeout","noAnswerTransfer","notAvailableTransfer","uncallable"],"x-genesys-enum-members":[{"name":"endpoint"},{"name":"client"},{"name":"system"},{"name":"transfer"},{"name":"error"},{"name":"peer"},{"name":"other"},{"name":"spam"},{"name":"transportFailure"},{"name":"conferenceTransfer"},{"name":"consultTransfer"},{"name":"forwardTransfer"},{"name":"timeout"},{"name":"noAnswerTransfer"},{"name":"notAvailableTransfer"},{"name":"uncallable"}]},"segmentType":{"type":"string","description":"The activity taking place for the participant in the segment","enum":["unknown","alert","system","delay","hold","interact","ivr","dialing","wrapup","voicemail","scheduled","contacting","transmitting","converting","uploading","sharing","callback"],"x-genesys-enum-members":[{"name":"unknown"},{"name":"alert"},{"name":"system"},{"name":"delay"},{"name":"hold"},{"name":"interact"},{"name":"ivr"},{"name":"dialing"},{"name":"wrapup"},{"name":"voicemail"},{"name":"scheduled"},{"name":"contacting"},{"name":"transmitting"},{"name":"converting"},{"name":"uploading"},{"name":"sharing"},{"name":"callback"}]},"requestedRoutingUserIds":{"type":"array","items":{"type":"string"}},"requestedRoutingSkillIds":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"requestedLanguageId":{"type":"string","description":"A unique identifier for the language requested for an interaction."},"scoredAgents":{"type":"array","items":{"$ref":"#/definitions/AnalyticsScoredAgent"}},"properties":{"type":"array","items":{"$ref":"#/definitions/AnalyticsProperty"}},"sourceConversationId":{"type":"string"},"destinationConversationId":{"type":"string"},"sourceSessionId":{"type":"string"},"destinationSessionId":{"type":"string"},"sipResponseCodes":{"type":"array","items":{"type":"integer","format":"int64"}},"q850ResponseCodes":{"type":"array","items":{"type":"integer","format":"int64"}},"conference":{"type":"boolean","description":"Indicates whether the segment was a conference"},"groupId":{"type":"string"},"subject":{"type":"string"},"audioMuted":{"type":"boolean"},"videoMuted":{"type":"boolean"}}},"AnalyticsConversationWithoutAttributes":{"type":"object","properties":{"conversationId":{"type":"string","description":"Unique identifier for the conversation"},"conversationStart":{"type":"string","format":"date-time","description":"Date/time the conversation started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationEnd":{"type":"string","format":"date-time","description":"Date/time the conversation ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"mediaStatsMinConversationMos":{"type":"number","format":"double","description":"The lowest estimated average MOS among all the audio streams belonging to this conversation"},"mediaStatsMinConversationRFactor":{"type":"number","format":"double","description":"The lowest R-factor value among all of the audio streams belonging to this conversation"},"originatingDirection":{"type":"string","description":"The original direction of the conversation","enum":["inbound","outbound"],"x-genesys-enum-members":[{"name":"inbound"},{"name":"outbound"}]},"evaluations":{"type":"array","description":"Evaluations tied to this conversation","items":{"$ref":"#/definitions/AnalyticsEvaluation"}},"surveys":{"type":"array","description":"Surveys tied to this conversation","items":{"$ref":"#/definitions/AnalyticsSurvey"}},"resolutions":{"type":"array","description":"Resolutions tied to this conversation","items":{"$ref":"#/definitions/AnalyticsResolution"}},"divisionIds":{"type":"array","description":"Identifiers of divisions associated with this conversation","items":{"type":"string"}},"participants":{"type":"array","description":"Participants in the conversation","items":{"$ref":"#/definitions/AnalyticsParticipantWithoutAttributes"}}}},"AnalyticsConversationWithoutAttributesMultiGetResponse":{"type":"object","properties":{"conversations":{"type":"array","items":{"$ref":"#/definitions/AnalyticsConversationWithoutAttributes"}}}},"AnalyticsEvaluation":{"type":"object","properties":{"evaluationId":{"type":"string","description":"Unique identifier for the evaluation"},"evaluatorId":{"type":"string","description":"A unique identifier of the PureCloud user who evaluated the interaction"},"userId":{"type":"string","description":"Unique identifier for the user being evaluated"},"eventTime":{"type":"string","format":"date-time","description":"Specifies when an evaluation occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"queueId":{"type":"string","description":"Unique identifier for the queue the conversation was on"},"formId":{"type":"string","description":"Unique identifier for the form used to evaluate the conversation/agent"},"contextId":{"type":"string","description":"A unique identifier for an evaluation form, regardless of version"},"formName":{"type":"string","description":"Name of the evaluation form"},"calibrationId":{"type":"string","description":"The calibration id used for the purpose of training evaluators"},"rescored":{"type":"boolean","description":"Whether this evaluation has ever been rescored"},"deleted":{"type":"boolean","description":"Whether this evaluation has been deleted"},"oTotalScore":{"type":"integer","format":"int64"},"oTotalCriticalScore":{"type":"integer","format":"int64"}}},"AnalyticsFlow":{"type":"object","properties":{"flowId":{"type":"string","description":"The unique identifier of this flow"},"flowName":{"type":"string","description":"The name of this flow"},"flowVersion":{"type":"string","description":"The version of this flow"},"flowType":{"type":"string","description":"The type of this flow","enum":["BOT","COMMONMODULE","INBOUNDCALL","INBOUNDCHAT","INBOUNDEMAIL","INBOUNDSHORTMESSAGE","INQUEUECALL","OUTBOUNDCALL","SECURECALL","SPEECH","SURVEYINVITE","WORKFLOW"],"x-genesys-enum-members":[{"name":"BOT"},{"name":"COMMONMODULE"},{"name":"INBOUNDCALL"},{"name":"INBOUNDCHAT"},{"name":"INBOUNDEMAIL"},{"name":"INBOUNDSHORTMESSAGE"},{"name":"INQUEUECALL"},{"name":"OUTBOUNDCALL"},{"name":"SECURECALL"},{"name":"SPEECH"},{"name":"SURVEYINVITE"},{"name":"WORKFLOW"}]},"exitReason":{"type":"string","description":"The exit reason for this flow, e.g. DISCONNECT"},"entryReason":{"type":"string","description":"The particular entry reason for this flow, e.g. an address, userId, or flowId"},"entryType":{"type":"string","description":"The entry type for this flow","enum":["dnis","direct","flow","agent","outbound"],"x-genesys-enum-members":[{"name":"dnis"},{"name":"direct"},{"name":"flow"},{"name":"agent"},{"name":"outbound"}]},"transferType":{"type":"string","description":"The type of transfer for flows that ended with a transfer"},"transferTargetName":{"type":"string","description":"The name of a transfer target"},"transferTargetAddress":{"type":"string","description":"The address of a transfer target"},"issuedCallback":{"type":"boolean","description":"Flag indicating whether the flow issued a callback"},"startingLanguage":{"type":"string","description":"Flow starting language, e.g. en-us"},"endingLanguage":{"type":"string","description":"Flow ending language, e.g. en-us"},"outcomes":{"type":"array","description":"Flow outcomes","items":{"$ref":"#/definitions/AnalyticsFlowOutcome"}}}},"AnalyticsFlowOutcome":{"type":"object","properties":{"flowOutcomeId":{"type":"string","description":"Unique identifiers of a flow outcome"},"flowOutcomeValue":{"type":"string","description":"Flow outcome value, e.g. SUCCESS"},"flowOutcome":{"type":"string","description":"Colon-separated combinations of unique flow outcome identifier and value"},"flowOutcomeStartTimestamp":{"type":"string","format":"date-time","description":"Date/time the outcome started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"flowOutcomeEndTimestamp":{"type":"string","format":"date-time","description":"Date/time the outcome ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"AnalyticsMediaEndpointStat":{"type":"object","properties":{"codecs":{"type":"array","description":"The MIME types of the audio encodings used by the audio streams belonging to this endpoint","items":{"type":"string"}},"minMos":{"type":"number","format":"double","description":"The lowest estimated average MOS among all the audio streams belonging to this endpoint"},"minRFactor":{"type":"number","format":"double","description":"The lowest R-factor value among all of the audio streams belonging to this endpoint"},"maxLatencyMs":{"type":"integer","format":"int64","description":"The maximum latency experienced by any audio stream belonging to this endpoint, in milliseconds"},"receivedPackets":{"type":"integer","format":"int64","description":"The total number of packets received for all audio streams belonging to this endpoint (includes invalid, duplicate, and discarded packets)"},"invalidPackets":{"type":"integer","format":"int64","description":"The total number of malformed or not RTP packets, unknown payload type, or discarded probation packets for all audio streams belonging to this endpoint"},"discardedPackets":{"type":"integer","format":"int64","description":"The total number of packets received too late or too early, jitter queue overrun or underrun, for all audio streams belonging to this endpoint"},"duplicatePackets":{"type":"integer","format":"int64","description":"The total number of packets received with the same sequence number as another one recently received (window of 64 packets), for all audio streams belonging to this endpoint"},"overrunPackets":{"type":"integer","format":"int64","description":"The total number of packets for which there was no room in the jitter queue when it was received, for all audio streams belonging to this endpoint (also counted in discarded)"},"underrunPackets":{"type":"integer","format":"int64","description":"The total number of packets received after their timestamp/seqnum has been played out, for all audio streams belonging to this endpoint (also counted in discarded)"}}},"AnalyticsParticipantWithoutAttributes":{"type":"object","properties":{"participantId":{"type":"string","description":"Unique identifier for the participant"},"participantName":{"type":"string","description":"A human readable name identifying the participant"},"userId":{"type":"string","description":"If a user, then this will be the unique identifier for the user"},"purpose":{"type":"string","description":"The participant's purpose","enum":["manual","dialer","inbound","acd","ivr","voicemail","outbound","agent","user","station","group","customer","external","fax","workflow","campaign","api"],"x-genesys-enum-members":[{"name":"manual"},{"name":"dialer"},{"name":"inbound"},{"name":"acd"},{"name":"ivr"},{"name":"voicemail"},{"name":"outbound"},{"name":"agent"},{"name":"user"},{"name":"station"},{"name":"group"},{"name":"customer"},{"name":"external"},{"name":"fax"},{"name":"workflow"},{"name":"campaign"},{"name":"api"}]},"externalContactId":{"type":"string","description":"External Contact Identifier"},"externalOrganizationId":{"type":"string","description":"External Organization Identifier"},"flaggedReason":{"type":"string","description":"Reason for which participant flagged conversation","enum":["general"],"x-genesys-enum-members":[{"name":"general"}]},"teamId":{"type":"string","description":"The team id the user is a member of"},"sessions":{"type":"array","description":"List of sessions associated to this participant","items":{"$ref":"#/definitions/AnalyticsSession"}}}},"AnalyticsProperty":{"type":"object","required":["property","propertyType","value"],"properties":{"propertyType":{"type":"string","description":"Indicates what the data type is (e.g. integer vs string) and therefore how to evaluate what would constitute a match","enum":["bool","integer","real","date","string","uuid"],"x-genesys-enum-members":[{"name":"bool"},{"name":"integer"},{"name":"real"},{"name":"date"},{"name":"string"},{"name":"uuid"}]},"property":{"type":"string","description":"User-defined rather than intrinsic system-observed values. These are tagged onto segments by other components within PureCloud or by API users directly. This is the name of the user-defined property."},"value":{"type":"string","description":"What property value to match against"}}},"AnalyticsProposedAgent":{"type":"object","properties":{"proposedAgentId":{"type":"string","description":"Unique identifier of an agent that was proposed by predictive routing"},"agentRank":{"type":"integer","format":"int32","description":"Proposed agent rank for this conversation from predictive routing (lower is better)"}}},"AnalyticsResolution":{"type":"object","properties":{"queueId":{"type":"string","description":"The ID of the last queue on which the conversation was handled."},"userId":{"type":"string","description":"The ID of the last user who handled the conversation."},"getnNextContactAvoided":{"type":"integer","format":"int64","description":"The number of interactions for which next contact was avoided."}}},"AnalyticsSession":{"type":"object","properties":{"mediaType":{"type":"string","description":"The session media type","enum":["voice","chat","email","callback","cobrowse","video","screenshare","message"],"x-genesys-enum-members":[{"name":"voice"},{"name":"chat"},{"name":"email"},{"name":"callback"},{"name":"cobrowse"},{"name":"video"},{"name":"screenshare"},{"name":"message"}]},"sessionId":{"type":"string","description":"The unique identifier of this session"},"addressOther":{"type":"string"},"addressSelf":{"type":"string"},"addressFrom":{"type":"string"},"addressTo":{"type":"string"},"messageType":{"type":"string","description":"Message type for messaging services such as sms","enum":["sms","facebook","twitter","line"]},"ani":{"type":"string","description":"Automatic Number Identification (caller's number)"},"direction":{"type":"string","description":"Direction","enum":["inbound","outbound"],"x-genesys-enum-members":[{"name":"inbound"},{"name":"outbound"}]},"dnis":{"type":"string","description":"Dialed number identification service (number dialed by the calling party)"},"sessionDnis":{"type":"string","description":"Dialed number for the current session; this can be different from dnis, e.g. if the call was transferred"},"outboundCampaignId":{"type":"string","description":"(Dialer) Unique identifier of the outbound campaign"},"outboundContactId":{"type":"string","description":"(Dialer) Unique identifier of the contact"},"outboundContactListId":{"type":"string","description":"(Dialer) Unique identifier of the contact list that this contact belongs to"},"dispositionAnalyzer":{"type":"string","description":"(Dialer) Unique identifier of the contact list that this contact belongs to"},"dispositionName":{"type":"string","example":"disposition.classification.callable.machine","description":"(Dialer) Result of the analysis"},"edgeId":{"type":"string","description":"Unique identifier of the edge device"},"remoteNameDisplayable":{"type":"string"},"roomId":{"type":"string","description":"Unique identifier for the room"},"monitoredSessionId":{"type":"string","description":"The sessionID being monitored"},"monitoredParticipantId":{"type":"string"},"callbackUserName":{"type":"string","description":"The name of the user requesting a call back"},"callbackNumbers":{"type":"array","description":"List of numbers to callback","items":{"type":"string"}},"callbackScheduledTime":{"type":"string","format":"date-time","description":"Scheduled callback date/time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"scriptId":{"type":"string","description":"A unique identifier for a script"},"peerId":{"type":"string","description":"A unique identifier for a peer"},"skipEnabled":{"type":"boolean","description":"(Dialer) Whether the agent can skip the dialer contact"},"timeoutSeconds":{"type":"integer","format":"int32","description":"The number of seconds before PureCloud begins the call for a call back. 0 disables automatic calling"},"cobrowseRole":{"type":"string","description":"Describe side of the cobrowse (sharer or viewer)"},"cobrowseRoomId":{"type":"string","description":"A unique identifier for a PureCloud Cobrowse room."},"mediaBridgeId":{"type":"string"},"screenShareAddressSelf":{"type":"string","description":"Direct ScreenShare address"},"sharingScreen":{"type":"boolean","description":"Flag determining if screenShare is started or not (true/false)"},"screenShareRoomId":{"type":"string","description":"A unique identifier for a PureCloud ScreenShare room."},"videoRoomId":{"type":"string","description":"A unique identifier for a PureCloud video room."},"videoAddressSelf":{"type":"string","description":"Direct Video address"},"segments":{"type":"array","description":"List of segments for this session","items":{"$ref":"#/definitions/AnalyticsConversationSegment"}},"metrics":{"type":"array","description":"List of metrics for this session","items":{"$ref":"#/definitions/AnalyticsSessionMetric"}},"flow":{"description":"IVR flow execution associated with this session","$ref":"#/definitions/AnalyticsFlow"},"mediaEndpointStats":{"type":"array","description":"Media endpoint stats associated with this session","items":{"$ref":"#/definitions/AnalyticsMediaEndpointStat"}},"recording":{"type":"boolean","description":"Flag determining if an audio recording was started or not"},"journeyCustomerId":{"type":"string","description":"ID of the journey customer"},"journeyCustomerIdType":{"type":"string","description":"Type of the journey customer ID"},"journeyCustomerSessionId":{"type":"string","description":"ID of the journey customer session"},"journeyCustomerSessionIdType":{"type":"string","description":"Type of the journey customer session ID"},"journeyActionId":{"type":"string","description":"Journey action ID"},"journeyActionMapId":{"type":"string","description":"Journey action map ID"},"journeyActionMapVersion":{"type":"string","description":"Journey action map version"},"protocolCallId":{"type":"string","description":"The original voice protocol call ID, e.g. a SIP call ID"},"provider":{"type":"string","description":"The source provider for the communication"},"remote":{"type":"string","description":"Name, phone number, or email address of the remote party."},"mediaCount":{"type":"integer","format":"int32","description":"Count of any media (images, files, etc) included in this session"},"flowInType":{"type":"string","description":"Type of flow in that occurred, e.g. acd, ivr, etc."},"flowOutType":{"type":"string","description":"Type of flow out that occurred, e.g. voicemail, callback, or acd"},"requestedRoutings":{"type":"array","description":"All routing types for requested/attempted routing methods.","items":{"type":"string","enum":["Predictive","Preferred","Manual","Last","Bullseye","Standard"],"x-genesys-enum-members":[{"name":"Predictive"},{"name":"Preferred"},{"name":"Manual"},{"name":"Last"},{"name":"Bullseye"},{"name":"Standard"}]}},"usedRouting":{"type":"string","description":"Complete routing method","enum":["Predictive","Preferred","Manual","Last","Bullseye","Standard"],"x-genesys-enum-members":[{"name":"Predictive"},{"name":"Preferred"},{"name":"Manual"},{"name":"Last"},{"name":"Bullseye"},{"name":"Standard"}]},"selectedAgentId":{"type":"string","description":"Selected agent id"},"selectedAgentRank":{"type":"integer","format":"int32","description":"Selected agent GPR rank"},"agentAssistantId":{"type":"string","description":"Unique identifier of the active virtual agent assistant"},"proposedAgents":{"type":"array","description":"Proposed agents","items":{"$ref":"#/definitions/AnalyticsProposedAgent"}},"assignerId":{"type":"string","description":"ID of the user that manually assigned a conversation"},"acwSkipped":{"type":"boolean","description":"Marker for an agent that skipped after call work"}}},"AnalyticsSessionMetric":{"type":"object","required":["emitDate","name","value"],"properties":{"name":{"type":"string","description":"Unique name of this metric"},"value":{"type":"integer","format":"int64","description":"The metric value"},"emitDate":{"type":"string","format":"date-time","description":"Metric emission date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"AnalyticsSurvey":{"type":"object","properties":{"surveyId":{"type":"string","description":"Unique identifier for the survey"},"surveyFormId":{"type":"string","description":"Unique identifier for the survey form"},"surveyFormName":{"type":"string","description":"Name of the survey form"},"surveyFormContextId":{"type":"string","description":"Unique identifier for the survey form, regardless of version"},"eventTime":{"type":"string","format":"date-time","description":"Specifies when a survey occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"userId":{"type":"string","description":"A unique identifier of the PureCloud user"},"queueId":{"type":"string","description":"Unique identifier for the queue the conversation was on"},"surveyStatus":{"type":"string","description":"Survey status"},"surveyPromoterScore":{"type":"integer","format":"int32","description":"Promoter score of the survey"},"surveyCompletedDate":{"type":"string","format":"date-time","description":"Completion date/time of the survey. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"oSurveyTotalScore":{"type":"integer","format":"int64"}}},"TranscriptConversationDetailSearchCriteria":{"type":"object","properties":{"endValue":{"type":"string","description":"The end value of the range. This field is used for range search types."},"values":{"type":"array","description":"A list of values for the search to match against","items":{"type":"string"}},"startValue":{"type":"string","description":"The start value of the range. This field is used for range search types."},"fields":{"type":"array","description":"Field names to search against","items":{"type":"string"}},"value":{"type":"string","description":"A value for the search to match against"},"operator":{"type":"string","description":"How to apply this search criteria against other criteria","enum":["AND","OR","NOT"],"x-genesys-enum-members":[{"name":"AND"},{"name":"OR"},{"name":"NOT"}]},"group":{"type":"array","description":"Groups multiple conditions","items":{"$ref":"#/definitions/TranscriptConversationDetailSearchCriteria"}},"dateFormat":{"type":"string","description":"Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."},"type":{"type":"string","enum":["EXACT","EXACT_PHRASE","PHRASE","DATE_RANGE"],"x-genesys-enum-members":[{"name":"EXACT"},{"name":"EXACT_PHRASE"},{"name":"PHRASE"},{"name":"DATE_RANGE"}]}}},"TranscriptConversationDetailSearchRequest":{"type":"object","required":["types"],"properties":{"sortOrder":{"type":"string","description":"The sort order for results","enum":["ASC","DESC","SCORE"],"x-genesys-enum-members":[{"name":"ASC"},{"name":"DESC"},{"name":"SCORE"}]},"sortBy":{"type":"string","description":"The field in the resource that you want to sort the results by"},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"},"pageNumber":{"type":"integer","format":"int32","description":"The page of resources you want to retrieve"},"sort":{"type":"array","description":"Multi-value sort order, list of multiple sort values","items":{"$ref":"#/definitions/SearchSort"}},"types":{"type":"array","description":"Resource domain type to search","items":{"type":"string"}},"query":{"type":"array","description":"The search criteria","items":{"$ref":"#/definitions/TranscriptConversationDetailSearchCriteria"}}}},"AvailableTopic":{"type":"object","properties":{"description":{"type":"string"},"id":{"type":"string"},"requiresPermissions":{"type":"array","description":"Permissions required to subscribe to the topic","items":{"type":"string"}},"requiresDivisionPermissions":{"type":"boolean","description":"True if the subscribing user must belong to the same division as the topic object ID"},"enforced":{"type":"boolean","description":"Whether or not the permissions on this topic are enforced"},"visibility":{"type":"string","description":"Visibility of this topic (Public or Preview)","enum":["Public","Preview"],"x-genesys-enum-members":[{"name":"Public"},{"name":"Preview"}]},"schema":{"type":"object","additionalProperties":{"type":"object"}},"requiresCurrentUser":{"type":"boolean","description":"True if the topic user ID is required to match the subscribing user ID"},"requiresCurrentUserOrPermission":{"type":"boolean","description":"True if permissions are only required when the topic user ID does not match the subscribing user ID"},"transports":{"type":"array","description":"Transports that support events for the topic","items":{"type":"string","enum":["All","Websocket","EventBridge"],"x-genesys-enum-members":[{"name":"All"},{"name":"Websocket"},{"name":"EventBridge"}]}},"publicApiTemplateUriPaths":{"type":"array","items":{"type":"string"}}}},"AvailableTopicEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AvailableTopic"}}}},"DownloadResponse":{"type":"object","properties":{"contentLocationUri":{"type":"string"},"imageUri":{"type":"string"},"thumbnails":{"type":"array","items":{"$ref":"#/definitions/DocumentThumbnail"}}}},"ReportingExportJobListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ReportingExportJobResponse"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"PatchOutcome":{"type":"object","required":["displayName"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"isActive":{"type":"boolean","description":"Whether or not the outcome is active."},"displayName":{"type":"string","description":"The display name of the outcome."},"version":{"type":"integer","format":"int32","description":"The version of the outcome."},"description":{"type":"string","description":"A description of the outcome."},"isPositive":{"type":"boolean","description":"Whether or not the outcome is positive."},"context":{"description":"The context of the outcome.","$ref":"#/definitions/Context"},"journey":{"description":"The pattern of rules defining the filter of the outcome.","$ref":"#/definitions/Journey"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"createdDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the outcome was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the outcome was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"ChatSettings":{"type":"object","properties":{"messageRetentionPeriodDays":{"type":"integer","format":"int32","description":"Retention time for messages in days"}}},"GroupsSearchResponse":{"type":"object","required":["pageCount","pageNumber","pageSize","results","total","types"],"properties":{"total":{"type":"integer","format":"int64","description":"The total number of results found"},"pageCount":{"type":"integer","format":"int32","description":"The total number of pages"},"pageSize":{"type":"integer","format":"int32","description":"The current page size"},"pageNumber":{"type":"integer","format":"int32","description":"The current page number"},"previousPage":{"type":"string","description":"Q64 value for the previous page of results"},"currentPage":{"type":"string","description":"Q64 value for the current page of results"},"nextPage":{"type":"string","description":"Q64 value for the next page of results"},"types":{"type":"array","description":"Resource types the search was performed against","items":{"type":"string"}},"results":{"type":"array","description":"Search results","items":{"$ref":"#/definitions/Group"}}}},"GroupSearchCriteria":{"type":"object","required":["type"],"properties":{"endValue":{"type":"string","description":"The end value of the range. This field is used for range search types."},"values":{"type":"array","description":"A list of values for the search to match against","items":{"type":"string"}},"startValue":{"type":"string","description":"The start value of the range. This field is used for range search types."},"fields":{"type":"array","description":"Field names to search against","items":{"type":"string"}},"value":{"type":"string","description":"A value for the search to match against"},"operator":{"type":"string","description":"How to apply this search criteria against other criteria","enum":["AND","OR","NOT"],"x-genesys-enum-members":[{"name":"AND"},{"name":"OR"},{"name":"NOT"}]},"group":{"type":"array","description":"Groups multiple conditions","items":{"$ref":"#/definitions/GroupSearchCriteria"}},"dateFormat":{"type":"string","description":"Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."},"type":{"type":"string","description":"Search Type","enum":["EXACT","STARTS_WITH","CONTAINS","REGEX","TERM","TERMS","REQUIRED_FIELDS","MATCH_ALL"],"x-genesys-enum-members":[{"name":"EXACT"},{"name":"STARTS_WITH"},{"name":"CONTAINS"},{"name":"REGEX"},{"name":"TERM"},{"name":"TERMS"},{"name":"REQUIRED_FIELDS"},{"name":"MATCH_ALL"}]}}},"GroupSearchRequest":{"type":"object","properties":{"sortOrder":{"type":"string","description":"The sort order for results","enum":["ASC","DESC","SCORE"],"x-genesys-enum-members":[{"name":"ASC"},{"name":"DESC"},{"name":"SCORE"}]},"sortBy":{"type":"string","description":"The field in the resource that you want to sort the results by"},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"},"pageNumber":{"type":"integer","format":"int32","description":"The page of resources you want to retrieve"},"sort":{"type":"array","description":"Multi-value sort order, list of multiple sort values","items":{"$ref":"#/definitions/SearchSort"}},"query":{"type":"array","items":{"$ref":"#/definitions/GroupSearchCriteria"}}}},"GSuite":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"disabled":{"type":"boolean"},"issuerURI":{"type":"string"},"ssoTargetURI":{"type":"string"},"certificate":{"type":"string"},"certificates":{"type":"array","items":{"type":"string"}},"relyingPartyIdentifier":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ActionTargetListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ActionTarget"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"WebChatSettings":{"type":"object","properties":{"requireDeployment":{"type":"boolean"}}},"FaxDocumentEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/FaxDocument"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Category":{"type":"object","properties":{"name":{"type":"string","description":"Category name"}},"description":"List of available Action categories."},"CategoryEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Category"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"pageCount":{"type":"integer","format":"int32"}}},"Parameter":{"type":"object","properties":{"name":{"type":"string"},"parameterType":{"type":"string","enum":["UUID","STRING","UUIDLIST","STRINGLIST"],"x-genesys-enum-members":[{"name":"UUID"},{"name":"STRING"},{"name":"UUIDLIST"},{"name":"STRINGLIST"}]},"domain":{"type":"string","enum":["USERID","QUEUEID","MEDIATYPE","DIALERCAMPAIGNID","QMEVALFORMID","UNKNOWN"],"x-genesys-enum-members":[{"name":"USERID"},{"name":"QUEUEID"},{"name":"MEDIATYPE"},{"name":"DIALERCAMPAIGNID"},{"name":"QMEVALFORMID"},{"name":"UNKNOWN"}]},"required":{"type":"boolean"}}},"ReportMetaData":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"keywords":{"type":"array","items":{"type":"string"}},"availableLocales":{"type":"array","items":{"type":"string"}},"parameters":{"type":"array","items":{"$ref":"#/definitions/Parameter"}},"exampleUrl":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ReportMetaDataEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ReportMetaData"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Coretype":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"version":{"type":"integer","format":"int32","description":"A positive integer denoting the core type's version"},"dateCreated":{"type":"string","format":"date-time","description":"The date the core type was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"schema":{"description":"The core type's built-in schema","$ref":"#/definitions/Schema"},"current":{"type":"boolean","description":"A boolean indicating if the core type's version is the current one in use by the system"},"validationFields":{"type":"array","description":"An array of strings naming the fields of the core type subject to validation. Validation constraints are specified by a schema author using the core type.","items":{"type":"string"}},"validationLimits":{"example":"\"validationLimits\": {\n\"minLength\": {\"min\": 0, \"max\": 100},\n\"maxLength\": {\"min\": 1, \"max\": 100}\n}","description":"A structure denoting the system-imposed minimum and maximum string length (for text-based core types) or numeric values (for number-based) core types. For example, the validationLimits for a text-based core type specify the min/max values for a minimum string length (minLength) constraint supplied by a schemaauthor on a text field. Similarly, the maxLength's min/max specifies maximum string length constraint supplied by a schema author for the same field.","$ref":"#/definitions/ValidationLimits"},"itemValidationFields":{"type":"array","description":"Specific to the \"tag\" core type, this is an array of strings naming the tag item fields of the core type subject to validation","items":{"type":"string"}},"itemValidationLimits":{"example":"\"validationLimits\": {\n \"minLength\": {\"min\": 1, \"max\": 100},\n \"maxLength\": {\"min\": 1, \"max\": 100}\n}","description":"A structure denoting the system-imposed minimum and maximum string length for string-array based core types such as \"tag\" and \"enum\". Forexample, the validationLimits for a schema field using a tag core type specify the min/max values for a minimum string length (minLength) constraint supplied by a schema author on individual tags. Similarly, the maxLength's min/max specifies maximum string length constraint supplied by a schema author for the same field's tags.","$ref":"#/definitions/ItemValidationLimits"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ItemValidationLimits":{"type":"object","required":["maxLength","minLength"],"properties":{"minLength":{"example":"\"minLength\": {\"min\": 0, \"max\": 100}","description":"A structure denoting the system-imposed minimum string length (for text-based core types) or numeric values (for number-based) core types. For example, the validationLimits for a text-based core type specify the min/max values for a minimum string length (minLength) constraint supplied by a schemaauthor on a text field. Similarly, the maxLength's min/max specifies maximum string length constraint supplied by a schema author for the same field.","$ref":"#/definitions/MinLength"},"maxLength":{"example":"\"validationLimits\": {\n\"minLength\": {\"min\": 0, \"max\": 100},\n\"maxLength\": {\"min\": 1, \"max\": 100}\n}","description":"A structure denoting the system-imposed minimum and maximum string length (for text-based core types) or numeric values (for number-based) core types. For example, the validationLimits for a text-based core type specify the min/max values for a minimum string length (minLength) constraint supplied by a schemaauthor on a text field. Similarly, the maxLength's min/max specifies maximum string length constraint supplied by a schema author for the same field.","$ref":"#/definitions/MaxLength"}}},"Items":{"type":"object","properties":{"type":{"type":"string"},"pattern":{"type":"string"}}},"MaxLength":{"type":"object","required":["max","min"],"properties":{"min":{"type":"integer","format":"int64","description":"A non-negative integer for a text-based schema field denoting the minimum largest length string the field can contain for a schema instance."},"max":{"type":"integer","format":"int64","description":"A non-negative integer for a text-based schema field denoting the maximum largest string the field can contain for a schema instance."}}},"MinLength":{"type":"object","required":["max","min"],"properties":{"min":{"type":"integer","format":"int64","description":"A non-negative integer for a text-based schema field denoting the minimum smallest length a string field can contain for a schema instance."},"max":{"type":"integer","format":"int64","description":"A non-negative integer for a text-based schema field denoting the maximum smallest length string the field can contain for a schema instance."}}},"Schema":{"type":"object","properties":{"title":{"type":"string","description":"A core type's title","readOnly":true},"description":{"type":"string","description":"A core type's description","readOnly":true},"type":{"type":"array","example":"[\"string\"] for a text-based core type, [\"integer\"] for a numeric core type, or [\"boolean\", \"null\"] for the checkbox core type","description":"An array of fundamental JSON Schema primitive types on which the core type is based","readOnly":true,"items":{"type":"string"}},"items":{"example":"{\ntype\": \"string\",\n\"pattern\": \"^[\\\\S]+$\"\n}","description":"Denotes the type and pattern of the items in an enum core type","readOnly":true,"$ref":"#/definitions/Items"},"pattern":{"type":"string","description":"For the \"date\" and \"datetime\" core types, denotes the regex prescribing the allowable date/datetime format","readOnly":true}}},"ValidationLimits":{"type":"object","properties":{"minLength":{"$ref":"#/definitions/MinLength"},"maxLength":{"$ref":"#/definitions/MaxLength"},"minItems":{"$ref":"#/definitions/MinLength"},"maxItems":{"$ref":"#/definitions/MaxLength"},"minimum":{"$ref":"#/definitions/MinLength"},"maximum":{"$ref":"#/definitions/MaxLength"}}},"WebChatConversation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"member":{"description":"Chat Member","$ref":"#/definitions/WebChatMemberInfo"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WebChatTyping":{"type":"object","required":["conversation","id","sender","timestamp"],"properties":{"id":{"type":"string","description":"The event identifier of this typing indicator event (useful to guard against event re-delivery"},"conversation":{"description":"The identifier of the conversation","$ref":"#/definitions/WebChatConversation"},"sender":{"description":"The member who sent the message","$ref":"#/definitions/WebChatMemberInfo"},"timestamp":{"type":"string","format":"date-time","description":"The timestamp of the message, in ISO-8601 format"}}},"WebChatMessage":{"type":"object","required":["body","bodyType","conversation","sender","timestamp"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"conversation":{"description":"The identifier of the conversation","$ref":"#/definitions/WebChatConversation"},"sender":{"description":"The member who sent the message","$ref":"#/definitions/WebChatMemberInfo"},"body":{"type":"string","description":"The message body."},"bodyType":{"type":"string","description":"The purpose of the message within the conversation, such as a standard text entry versus a greeting.","enum":["standard","notice","member-join","member-leave","media-request"],"x-genesys-enum-members":[{"name":"standard"},{"name":"notice"},{"name":"member-join"},{"name":"member-leave"},{"name":"media-request"}]},"timestamp":{"type":"string","format":"date-time","description":"The timestamp of the message, in ISO-8601 format"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CreateWebChatMessageRequest":{"type":"object","required":["body"],"properties":{"body":{"type":"string","description":"The message body. Note that message bodies are limited to 4,000 characters."},"bodyType":{"type":"string","description":"The purpose of the message within the conversation, such as a standard text entry versus a greeting.","enum":["standard","notice","member-join","member-leave","media-request"],"x-genesys-enum-members":[{"name":"standard"},{"name":"notice"},{"name":"member-join"},{"name":"member-leave"},{"name":"media-request"}]}}},"HistoricalAdherenceActuals":{"type":"object","properties":{"actualActivityCategory":{"type":"string","description":"Activity in which the user is actually engaged","enum":["OnQueueWork","Break","Meal","Meeting","OffQueueWork","TimeOff","Training","Unavailable","Unscheduled"],"x-genesys-enum-members":[{"name":"OnQueueWork"},{"name":"Break"},{"name":"Meal"},{"name":"Meeting"},{"name":"OffQueueWork"},{"name":"TimeOff"},{"name":"Training"},{"name":"Unavailable"},{"name":"Unscheduled"}]},"startOffsetSeconds":{"type":"integer","format":"int32","description":"Actual start offset in seconds relative to query start time"},"endOffsetSeconds":{"type":"integer","format":"int32","description":"Actual end offset in seconds relative to query start time"}}},"HistoricalAdherenceDayMetrics":{"type":"object","properties":{"dayStartOffsetSecs":{"type":"integer","format":"int32","description":"Start of day offset in seconds relative to query start time"},"adherenceScheduleSecs":{"type":"integer","format":"int32","description":"Duration of schedule in seconds included for adherence percentage calculation"},"conformanceScheduleSecs":{"type":"integer","format":"int32","description":"Total scheduled duration in seconds for OnQueue activities"},"conformanceActualSecs":{"type":"integer","format":"int32","description":"Total actually worked duration in seconds for OnQueue activities"},"exceptionCount":{"type":"integer","format":"int32","description":"Total number of adherence exceptions for this user"},"exceptionDurationSecs":{"type":"integer","format":"int32","description":"Total duration in seconds of adherence exceptions for this user"},"impactSeconds":{"type":"integer","format":"int32","description":"The impact duration in seconds of current adherence state for this user"},"scheduleLengthSecs":{"type":"integer","format":"int32","description":"Total duration in seconds for all scheduled activities"},"actualLengthSecs":{"type":"integer","format":"int32","description":"Total duration in seconds for all actually worked activities"},"adherencePercentage":{"type":"number","format":"double","description":"Total adherence percentage for this user, in the scale of 0 - 100"},"conformancePercentage":{"type":"number","format":"double","description":"Total conformance percentage for this user, in the scale of 0 - 100. Conformance percentage can be greater than 100 when the actual on queue time is greater than the scheduled on queue time for the same period."}}},"HistoricalAdherenceExceptionInfo":{"type":"object","properties":{"startOffsetSeconds":{"type":"integer","format":"int32","description":"Exception start offset in seconds relative to query start time"},"endOffsetSeconds":{"type":"integer","format":"int32","description":"Exception end offset in seconds relative to query start time"},"scheduledActivityCodeId":{"type":"string","description":"The ID of the scheduled activity for this user"},"scheduledActivityCategory":{"type":"string","description":"Activity for which the user is scheduled","enum":["OnQueueWork","Break","Meal","Meeting","OffQueueWork","TimeOff","Training","Unavailable","Unscheduled"],"x-genesys-enum-members":[{"name":"OnQueueWork"},{"name":"Break"},{"name":"Meal"},{"name":"Meeting"},{"name":"OffQueueWork"},{"name":"TimeOff"},{"name":"Training"},{"name":"Unavailable"},{"name":"Unscheduled"}]},"actualActivityCategory":{"type":"string","description":"Activity for which the user is actually engaged","enum":["OnQueueWork","Break","Meal","Meeting","OffQueueWork","TimeOff","Training","Unavailable","Unscheduled"],"x-genesys-enum-members":[{"name":"OnQueueWork"},{"name":"Break"},{"name":"Meal"},{"name":"Meeting"},{"name":"OffQueueWork"},{"name":"TimeOff"},{"name":"Training"},{"name":"Unavailable"},{"name":"Unscheduled"}]},"systemPresence":{"type":"string","description":"Actual underlying system presence value","enum":["Available","Away","Busy","Offline","Idle","OnQueue","Meal","Training","Meeting","Break"],"x-genesys-enum-members":[{"name":"Available"},{"name":"Away"},{"name":"Busy"},{"name":"Offline"},{"name":"Idle"},{"name":"OnQueue"},{"name":"Meal"},{"name":"Training"},{"name":"Meeting"},{"name":"Break"}]},"routingStatus":{"description":"Actual underlying routing status, used to determine whether a user is actually in adherence when OnQueue","$ref":"#/definitions/RoutingStatus"},"impact":{"type":"string","description":"The impact of the current adherence state for this user","enum":["Positive","Negative","Neutral","Unknown"],"x-genesys-enum-members":[{"name":"Positive"},{"name":"Negative"},{"name":"Neutral"},{"name":"Unknown"}]},"secondaryPresenceLookupId":{"type":"string","description":"The lookup ID used to retrieve secondary status from map of lookup ID to corresponding secondary presence ID"}}},"HistoricalAdherenceQueryResult":{"type":"object","properties":{"userId":{"type":"string","description":"The ID of the user for whom the adherence is queried"},"startDate":{"type":"string","format":"date-time","description":"Beginning of the date range that was queried, in ISO-8601 format"},"endDate":{"type":"string","format":"date-time","description":"End of the date range that was queried, in ISO-8601 format. If it was not set, end date will be set to the queried time"},"adherencePercentage":{"type":"number","format":"double","description":"Adherence percentage for this user, in the scale of 0 - 100"},"conformancePercentage":{"type":"number","format":"double","description":"Conformance percentage for this user, in the scale of 0 - 100. Conformance percentage can be greater than 100 when the actual on queue time is greater than the scheduled on queue time for the same period."},"impact":{"type":"string","description":"The impact of the current adherence state for this user","enum":["Positive","Negative","Neutral","Unknown"],"x-genesys-enum-members":[{"name":"Positive"},{"name":"Negative"},{"name":"Neutral"},{"name":"Unknown"}]},"exceptionInfo":{"type":"array","description":"List of adherence exceptions for this user","items":{"$ref":"#/definitions/HistoricalAdherenceExceptionInfo"}},"dayMetrics":{"type":"array","description":"Adherence and conformance metrics for days in query range","items":{"$ref":"#/definitions/HistoricalAdherenceDayMetrics"}},"actuals":{"type":"array","description":"List of actual activity with offset for this user","items":{"$ref":"#/definitions/HistoricalAdherenceActuals"}}}},"WfmHistoricalAdherenceResponse":{"type":"object","properties":{"id":{"type":"string","description":"The query ID to listen for"},"downloadUrl":{"type":"string","description":"Deprecated. Use downloadUrls instead."},"downloadResult":{"description":"Result will always come via downloadUrls; however the schema is included for documentation","$ref":"#/definitions/WfmHistoricalAdherenceResultWrapper"},"downloadUrls":{"type":"array","description":"The uri list to GET the results of the Historical Adherence query. For notification purposes only","items":{"type":"string"}},"queryState":{"type":"string","description":"The state of the adherence query","enum":["Processing","Complete","Error"],"x-genesys-enum-members":[{"name":"Processing"},{"name":"Complete"},{"name":"Error"}]}},"description":"Response for Historical Adherence Query, intended to tell the client what to listen for on a notification topic"},"WfmHistoricalAdherenceResultWrapper":{"type":"object","properties":{"entityId":{"type":"string","description":"The operation ID of the historical adherence query"},"data":{"type":"array","description":"The list of historical adherence query results","items":{"$ref":"#/definitions/HistoricalAdherenceQueryResult"}},"lookupIdToSecondaryPresenceId":{"type":"object","description":"Map of secondary presence lookup ID to corresponding secondary presence ID","additionalProperties":{"type":"string"}}}},"WfmHistoricalAdherenceQueryForUsers":{"type":"object","required":["startDate","userIds"],"properties":{"startDate":{"type":"string","format":"date-time","description":"Beginning of the date range to query in ISO-8601 format"},"endDate":{"type":"string","format":"date-time","description":"End of the date range to query in ISO-8601 format. If it is not set, end date will be set to current time"},"timeZone":{"type":"string","description":"The time zone to use for returned results in olson format. If it is not set, the business unit time zone will be used to compute adherence"},"userIds":{"type":"array","description":"The userIds to report on","uniqueItems":true,"items":{"type":"string"}},"includeExceptions":{"type":"boolean","description":"Whether user exceptions should be returned as part of the results"}}},"DomainPhysicalCapabilities":{"type":"object","properties":{"vlan":{"type":"boolean"},"team":{"type":"boolean"}}},"DomainPhysicalInterface":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"edgeUri":{"type":"string","format":"uri"},"friendlyName":{"type":"string"},"hardwareAddress":{"type":"string"},"portLabel":{"type":"string"},"physicalCapabilities":{"$ref":"#/definitions/DomainPhysicalCapabilities"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PhysicalInterfaceEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DomainPhysicalInterface"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"GreetingListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Greeting"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"InboundDomain":{"type":"object","required":["mxRecordStatus"],"properties":{"id":{"type":"string","description":"Unique Id of the domain such as: example.com"},"name":{"type":"string"},"mxRecordStatus":{"type":"string","description":"Mx Record Status","enum":["VALID","INVALID","NOT_AVAILABLE"],"x-genesys-enum-members":[{"name":"VALID"},{"name":"INVALID"},{"name":"NOT_AVAILABLE"}]},"subDomain":{"type":"boolean","description":"Indicates if this a PureCloud sub-domain. If true, then the appropriate DNS records are created for sending/receiving email."},"mailFromSettings":{"description":"The DNS settings if the inbound domain is using a custom Mail From. These settings can only be used on InboundDomains where subDomain is false.","$ref":"#/definitions/MailFromResult"},"customSMTPServer":{"description":"The custom SMTP server integration to use when sending outbound emails from this domain.","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"MailFromResult":{"type":"object","required":["mailFromDomain"],"properties":{"status":{"type":"string","description":"The verification status.","enum":["FAILED","PENDING","VERIFIED","UNKNOWN"],"x-genesys-enum-members":[{"name":"FAILED"},{"name":"PENDING"},{"name":"VERIFIED"},{"name":"UNKNOWN"}]},"records":{"type":"array","description":"The list of DNS records that pertain that need to exist for verification.","items":{"$ref":"#/definitions/Record"}},"mailFromDomain":{"type":"string","description":"The custom MAIL FROM domain."}}},"Record":{"type":"object","required":["name","type","value"],"properties":{"name":{"type":"string","description":"The name of the record."},"type":{"type":"string","description":"The type of the record. (Example values: MX, TXT, CNAME)"},"value":{"type":"string","description":"The value of the record."}}},"InboundDomainPatchRequest":{"type":"object","properties":{"mailFromSettings":{"description":"The DNS settings if the inbound domain is using a custom Mail From. These settings can only be used on InboundDomains where subDomain is false.","$ref":"#/definitions/MailFromResult"},"customSMTPServer":{"description":"The custom SMTP server integration to use when sending outbound emails from this domain.","$ref":"#/definitions/DomainEntityRef"}}},"TestMessage":{"type":"object","required":["from","textBody","to"],"properties":{"id":{"type":"string","description":"After the message has been sent, this is the value of the Message-ID email header.","readOnly":true},"to":{"type":"array","description":"The recipients of the email message.","items":{"$ref":"#/definitions/EmailAddress"}},"from":{"description":"The sender of the email message.","$ref":"#/definitions/EmailAddress"},"subject":{"type":"string","description":"The subject of the email message."},"textBody":{"type":"string","description":"The text body of the email message."},"htmlBody":{"type":"string","description":"The html body of the email message"},"time":{"type":"string","format":"date-time","description":"The time when the message was sent. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"DialogflowIntent":{"type":"object","required":["name","parameters"],"properties":{"name":{"type":"string","description":"The intent name"},"parameters":{"type":"object","description":"An object mapping parameter names to Parameter objects","additionalProperties":{"$ref":"#/definitions/DialogflowParameter"}}}},"DialogflowParameter":{"type":"object","required":["name","type"],"properties":{"name":{"type":"string","description":"The parameter name"},"type":{"type":"string","description":"The parameter type"}}},"DialogflowProject":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}},"HistoryEntry":{"type":"object","properties":{"action":{"type":"string","description":"The action performed","enum":["CHECKIN","CHECKOUT","CREATE","DEACTIVATE","DEBUG","DELETE","PUBLISH","REVERT","SAVE","TRANSCODE","UPDATE","UPLOAD"]},"resource":{"type":"string","description":"For actions performed not on the item itself, but on a sub-item, this field identifies the sub-item by name. For example, for actions performed on prompt resources, this will be the prompt resource name."},"timestamp":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"user":{"description":"User associated with this entry.","$ref":"#/definitions/User"},"client":{"description":"OAuth client associated with this entry.","$ref":"#/definitions/DomainEntityRef"},"version":{"type":"string"},"secure":{"type":"boolean"}}},"HistoryListing":{"type":"object","properties":{"id":{"type":"string"},"complete":{"type":"boolean"},"user":{"$ref":"#/definitions/User"},"client":{"$ref":"#/definitions/DomainEntityRef"},"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorDetails":{"type":"array","items":{"$ref":"#/definitions/Detail"}},"errorMessageParams":{"type":"object","additionalProperties":{"type":"string"}},"actionName":{"type":"string","description":"Action name","enum":["CREATE","CHECKIN","DEBUG","DELETE","HISTORY","PUBLISH","STATE_CHANGE","UPDATE","VALIDATE"]},"actionStatus":{"type":"string","description":"Action status","enum":["LOCKED","UNLOCKED","STARTED","PENDING_GENERATION","PENDING_BACKEND_NOTIFICATION","SUCCESS","FAILURE"]},"name":{"type":"string"},"description":{"type":"string"},"system":{"type":"boolean"},"started":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"completed":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"entities":{"type":"array","items":{"$ref":"#/definitions/HistoryEntry"}},"total":{"type":"integer","format":"int64"},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"pageCount":{"type":"integer","format":"int32"}}},"FilterPreviewResponse":{"type":"object","properties":{"filteredContacts":{"type":"integer","format":"int64"},"totalContacts":{"type":"integer","format":"int64"},"preview":{"type":"array","items":{"$ref":"#/definitions/DialerContact"}}}},"CommonCampaign":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the Campaign."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"mediaType":{"type":"string","description":"The media type used for this campaign.","enum":["sms","voice"],"x-genesys-enum-members":[{"name":"sms"},{"name":"voice"}]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CommonCampaignEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CommonCampaign"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"RunNowResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ConversationUser":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The globally unique identifier for this user."}}},"WfmAgent":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"user":{"description":"The user associated with this data","$ref":"#/definitions/UserReference"},"workPlan":{"description":"The work plan associated with this agent, if applicable","$ref":"#/definitions/WorkPlanReference"},"workPlanRotation":{"description":"The work plan rotation associated with this agent, if applicable","$ref":"#/definitions/WorkPlanRotationReference"},"acceptDirectShiftTrades":{"type":"boolean","description":"Whether the agent accepts direct shift trade requests"},"queues":{"type":"array","description":"List of queues to which this agent is capable of handling","items":{"$ref":"#/definitions/QueueReference"}},"languages":{"type":"array","description":"The list of languages this agent is capable of handling","items":{"$ref":"#/definitions/LanguageReference"}},"skills":{"type":"array","description":"The list of skills this agent is capable of handling","items":{"$ref":"#/definitions/RoutingSkillReference"}},"schedulable":{"type":"boolean","description":"Whether the agent has the permission to be included in schedule generation"},"metadata":{"description":"Metadata for this agent","$ref":"#/definitions/WfmVersionedEntityMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Workforce management agent data"},"WorkPlanRotationReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OAuthClientRequest":{"type":"object","required":["authorizedGrantType","name"],"properties":{"name":{"type":"string","description":"The name of the OAuth client."},"accessTokenValiditySeconds":{"type":"integer","format":"int64","description":"The number of seconds, between 5mins and 48hrs, until tokens created with this client expire. If this field is omitted, a default of 24 hours will be applied."},"description":{"type":"string"},"registeredRedirectUri":{"type":"array","description":"List of allowed callbacks for this client. For example: https://myap.example.com/auth/callback","items":{"type":"string","format":"uri"}},"roleIds":{"type":"array","description":"Deprecated. Use roleDivisions instead.","uniqueItems":true,"items":{"type":"string"}},"authorizedGrantType":{"type":"string","description":"The OAuth Grant/Client type supported by this client.\nCode Authorization Grant/Client type - Preferred client type where the Client ID and Secret are required to create tokens. Used where the secret can be secured.\nPKCE-Enabled Code Authorization grant type - Code grant type which requires PKCE challenge and verifier to create tokens. Used in public clients for increased security.\nImplicit grant type - Client ID only is required to create tokens. Used in browser and mobile apps where the secret can not be secured.\nSAML2-Bearer extension grant type - SAML2 assertion provider for user authentication at the token endpoint.\nClient Credential grant type - Used to created access tokens that are tied only to the client.\n","enum":["CODE","CODE_PKCE","TOKEN","SAML2BEARER","PASSWORD","CLIENT_CREDENTIALS"],"x-genesys-enum-members":[{"name":"CODE"},{"name":"CODE_PKCE"},{"name":"TOKEN"},{"name":"SAML2BEARER"},{"name":"PASSWORD"},{"name":"CLIENT_CREDENTIALS"}]},"scope":{"type":"array","description":"The scope requested by this client. Scopes only apply to clients not using the client_credential grant","items":{"type":"string"}},"roleDivisions":{"type":"array","description":"Set of roles and their corresponding divisions associated with this client. Roles and divisions only apply to clients using the client_credential grant","uniqueItems":true,"items":{"$ref":"#/definitions/RoleDivision"}},"state":{"type":"string","description":"The state of the OAuth client.\nActive: The OAuth client can be used to create access tokens. This is the default state.\nDisabled: Access tokens created by the client are invalid and new ones cannot be created.\nInactive: Access tokens cannot be created with this OAuth client and it will be deleted.","enum":["active","disabled","inactive"],"x-genesys-enum-members":[{"name":"active"},{"name":"disabled"},{"name":"inactive"}]},"dateToDelete":{"type":"string","format":"date-time","description":"The time at which this client will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"RoutingSkill":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the skill."},"dateModified":{"type":"string","format":"date-time","description":"Date last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"state":{"type":"string","description":"The current state for this skill.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"version":{"type":"string","description":"Required when updating. Version must be the current version. Only the system can assign version.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UnreadStatus":{"type":"object","properties":{"unread":{"type":"boolean","description":"Sets if the alert is read or unread."}}},"DIDNumber":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"number":{"type":"string","description":"The number of the DID formatted as E164."},"assigned":{"type":"boolean","description":"True if this DID is assigned to an entity. False otherwise."},"didPool":{"description":"A Uri reference to the DID Pool this DID is a part of.","$ref":"#/definitions/AddressableEntityRef"},"owner":{"description":"A Uri reference to the owner of this DID. The owner's type can be found in ownerType. If the DID is unassigned, this will be NULL.","$ref":"#/definitions/DomainEntityRef"},"ownerType":{"type":"string","description":"The type of the entity that owns this DID. If the DID is unassigned, this will be NULL.","enum":["USER","PHONE","IVR_CONFIG","GROUP"],"x-genesys-enum-members":[{"name":"USER"},{"name":"PHONE"},{"name":"IVR_CONFIG"},{"name":"GROUP"}]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Represents an unassigned or assigned DID in a DID Pool."},"DIDNumberEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DIDNumber"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"KnowledgeSearchResponse":{"type":"object","properties":{"searchId":{"type":"string","description":"Search Id","readOnly":true},"total":{"type":"integer","format":"int32","description":"Total number of records returned","readOnly":true},"pageCount":{"type":"integer","format":"int32","description":"Number of pages returned in the result calculated according to the pageSize and the total","readOnly":true},"pageSize":{"type":"integer","format":"int32","description":"Number of records according to the page size","readOnly":true},"pageNumber":{"type":"integer","format":"int32","description":"Current page number for the returned records","readOnly":true},"results":{"type":"array","description":"Results associated to the search response","readOnly":true,"items":{"$ref":"#/definitions/KnowledgeSearchDocument"}}}},"KnowledgeSearchRequest":{"type":"object","required":["languageCode","query"],"properties":{"query":{"type":"string","description":"Input query to search content in the knowledge base"},"pageSize":{"type":"integer","format":"int32","description":"Page size of the returned results"},"pageNumber":{"type":"integer","format":"int32","description":"Page number of the returned results"},"documentType":{"type":"string","description":"Document type to be used while searching","enum":["Faq"],"x-genesys-enum-members":[{"name":"Faq"}]},"languageCode":{"type":"string","description":"query search for specific languageCode"},"searchOnDraftDocuments":{"type":"boolean","description":"If true the search query will be executed on draft documents, else it will be on active documents"}}},"UserLanguageEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UserRoutingLanguage"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"UserRoutingLanguagePost":{"type":"object","required":["id","proficiency"],"properties":{"id":{"type":"string","description":"The id of the existing routing language to add to the user"},"proficiency":{"type":"number","format":"double","description":"Proficiency is a rating from 0.0 to 5.0 on how competent an agent is for a particular language. It is used when a queue is set to \"Best available language\" mode to allow acd interactions to target agents with higher proficiency ratings."},"languageUri":{"type":"string","format":"uri","description":"URI to the organization language used by this user language.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Represents an organization language assigned to a user. When assigning to a user specify the organization langauge id as the id."},"DigitLength":{"type":"object","properties":{"start":{"type":"string"},"end":{"type":"string"}}},"Number":{"type":"object","properties":{"start":{"type":"string"},"end":{"type":"string"}}},"NumberPlan":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"match":{"type":"string"},"normalizedFormat":{"type":"string"},"priority":{"type":"integer","format":"int32"},"numbers":{"type":"array","items":{"$ref":"#/definitions/Number"}},"digitLength":{"$ref":"#/definitions/DigitLength"},"classification":{"type":"string"},"matchType":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Manager":{"type":"object","properties":{"value":{"type":"string","description":"The ID of the manager."},"$ref":{"type":"string","format":"uri","description":"The reference URI of the manager's user record.","readOnly":true}},"description":"Defines a SCIM manager."},"ScimEmail":{"type":"object","properties":{"value":{"type":"string","description":"The email address. Is immutable if \"type\" is set to \"other\"."},"type":{"type":"string","description":"The type of email address. \"value\" is immutable if \"type\" is set to \"other\".","enum":["work","other"],"x-genesys-enum-members":[{"name":"work"},{"name":"other"}]},"primary":{"type":"boolean","description":"Indicates whether the email address is the primary email address."}},"description":"Defines a SCIM email address."},"ScimGenesysUserExternalId":{"type":"object","properties":{"authority":{"type":"string","description":"Authority, or scope, of \"externalId\". Allows multiple external identifiers to be defined. Represents the source of the external identifier."},"value":{"type":"string","description":"Identifier of the user in an external system."}},"description":"External Identifiers of user. The external identifier must be unique within the organization and the 'authority'"},"ScimPhoneNumber":{"type":"object","properties":{"value":{"type":"string","description":"The phone number in E.164 or tel URI format, for example, tel:+nnnnnnnn; ext=xxxxx."},"type":{"type":"string","description":"The type of phone number.","enum":["work","work2","work3","work4","home","mobile","other","microsoftteams","zoomphone","ringcentral"],"x-genesys-enum-members":[{"name":"work"},{"name":"work2"},{"name":"work3"},{"name":"work4"},{"name":"home"},{"name":"mobile"},{"name":"other"},{"name":"microsoftteams"},{"name":"zoomphone"},{"name":"ringcentral"}]},"primary":{"type":"boolean","description":"Indicates whether the phone number is the primary phone number."}},"description":"Defines a SCIM phone number."},"ScimUserExtensions":{"type":"object","properties":{"routingSkills":{"type":"array","description":"The list of routing skills assigned to a user. Maximum 50 skills.","items":{"$ref":"#/definitions/ScimUserRoutingSkill"}},"routingLanguages":{"type":"array","description":"The list of routing languages assigned to a user. Maximum 50 languages.","items":{"$ref":"#/definitions/ScimUserRoutingLanguage"}},"externalIds":{"type":"array","description":"The list of external identifiers assigned to user. Always includes an immutable SCIM authority prefixed with \"x-pc:scimv2:v1\".","items":{"$ref":"#/definitions/ScimGenesysUserExternalId"}}},"description":"Genesys Cloud user extensions to SCIM RFC."},"ScimUserRole":{"type":"object","properties":{"value":{"type":"string","description":"The role of the Genesys Cloud user."}},"description":"Defines a user role."},"ScimUserRoutingLanguage":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The case-sensitive name of a routing language configured in Genesys Cloud."},"proficiency":{"type":"number","format":"double","description":"A rating from 0.0 to 5.0 that indicates how fluent an agent is in a particular language. ACD interactions are routed to agents with higher proficiency ratings."}},"description":"The routing language assigned to a user."},"ScimUserRoutingSkill":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The case-sensitive name of a routing skill configured in Genesys Cloud."},"proficiency":{"type":"number","format":"double","description":"A rating from 0.0 to 5.0 that indicates how adept an agent is at a particular skill. When \"Best available skills\" is enabled for a queue in Genesys Cloud, ACD interactions in that queue are routed to agents with higher proficiency ratings."}},"description":"The routing skill assigned to a user."},"ScimV2EnterpriseUser":{"type":"object","properties":{"division":{"type":"string","description":"The division that the user belongs to."},"department":{"type":"string","description":"The department that the user belongs to."},"manager":{"description":"The user's manager.","$ref":"#/definitions/Manager"},"employeeNumber":{"type":"string","description":"The user's employee number."}},"description":"Defines a SCIM enterprise user."},"ScimV2GroupReference":{"type":"object","properties":{"type":{"type":"string","description":"The type of SCIM resource.","readOnly":true,"enum":["User","Group","ServiceProviderConfig","ResourceType","Schema"],"x-genesys-enum-members":[{"name":"User"},{"name":"Group"},{"name":"ServiceProviderConfig"},{"name":"ResourceType"},{"name":"Schema"}]},"value":{"type":"string","description":"The ID of the group member. Can be \"userId\" or \"groupId\"."},"$ref":{"type":"string","format":"uri","description":"The reference URI of the SCIM resource.","readOnly":true}},"description":"Defines a reference to SCIM groups."},"ScimV2User":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the SCIM resource. Set by the service provider. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readOnly\". \"returned\" is set to \"always\".","readOnly":true},"schemas":{"type":"array","description":"The list of supported schemas.","readOnly":true,"items":{"type":"string"}},"active":{"type":"boolean","description":"Indicates whether the user's administrative status is active."},"userName":{"type":"string","description":"The user's Genesys Cloud email address. Must be unique."},"displayName":{"type":"string","description":"The display name of the user."},"password":{"type":"string","description":"The new password for the Genesys Cloud user. Does not return an existing password. When creating a user, if a password is not supplied, then a password will be randomly generated that is 40 characters in length and contains five characters from each of the password policy groups."},"title":{"type":"string","description":"The user's title."},"phoneNumbers":{"type":"array","description":"The list of the user's phone numbers.","items":{"$ref":"#/definitions/ScimPhoneNumber"}},"emails":{"type":"array","description":"The list of the user's email addresses.","items":{"$ref":"#/definitions/ScimEmail"}},"externalId":{"type":"string","description":"The external ID of the user. Set by the provisioning client. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readWrite\"."},"groups":{"type":"array","description":"The list of groups that the user is a member of.","items":{"$ref":"#/definitions/ScimV2GroupReference"}},"roles":{"type":"array","description":"The list of roles assigned to the user.","items":{"$ref":"#/definitions/ScimUserRole"}},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"description":"The URI of the schema for the enterprise user.","$ref":"#/definitions/ScimV2EnterpriseUser"},"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User":{"description":"The URI of the schema for the Genesys Cloud user.","$ref":"#/definitions/ScimUserExtensions"},"meta":{"description":"The metadata of the SCIM resource.","readOnly":true,"$ref":"#/definitions/ScimMetadata"}},"description":"Defines a SCIM user."},"ScimUserListResponse":{"type":"object","properties":{"totalResults":{"type":"integer","format":"int64","description":"The total number of results.","readOnly":true},"startIndex":{"type":"integer","format":"int64","description":"The 1-based index of the first result returned by this request. Add this to \"itemsPerPage\" when requesting the next page of results.","readOnly":true},"itemsPerPage":{"type":"integer","format":"int64","description":"The number of resources returned per page.","readOnly":true},"Resources":{"type":"array","description":"The list of requested resources. If \"count\" is 0, then the list will be empty.","readOnly":true,"items":{"$ref":"#/definitions/ScimV2User"}},"schemas":{"type":"array","description":"The list of supported schemas.","items":{"type":"string"}}},"description":"Defines a response for a list of SCIM users."},"ScimError":{"type":"object","properties":{"status":{"type":"string","description":"The HTTP status code returned for the SCIM error.","readOnly":true},"scimType":{"type":"string","description":"The type of SCIM error when httpStatus is a \"400\" error.","readOnly":true,"enum":["invalidFilter","tooMany","uniqueness","mutability","invalidSyntax","invalidPath","noTarget","invalidValue","invalidVers","sensitive"],"x-genesys-enum-members":[{"name":"invalidFilter"},{"name":"tooMany"},{"name":"uniqueness"},{"name":"mutability"},{"name":"invalidSyntax"},{"name":"invalidPath"},{"name":"noTarget"},{"name":"invalidValue"},{"name":"invalidVers"},{"name":"sensitive"}]},"detail":{"type":"string","description":"The detailed description of the SCIM error.","readOnly":true},"schemas":{"type":"array","description":"The list of schemas for the SCIM error.","readOnly":true,"items":{"type":"string"}}},"description":"Defines a SCIM error."},"JsonNode":{"type":"object","properties":{"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"],"x-genesys-enum-members":[{"name":"ARRAY"},{"name":"BINARY"},{"name":"BOOLEAN"},{"name":"MISSING"},{"name":"NULL"},{"name":"NUMBER"},{"name":"OBJECT"},{"name":"POJO"},{"name":"STRING"}]},"float":{"type":"boolean"},"number":{"type":"boolean"},"boolean":{"type":"boolean"},"object":{"type":"boolean"},"valueNode":{"type":"boolean"},"containerNode":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"pojo":{"type":"boolean"},"integralNumber":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean"},"binary":{"type":"boolean"},"missingNode":{"type":"boolean"},"array":{"type":"boolean"},"null":{"type":"boolean"}}},"ScimV2PatchOperation":{"type":"object","required":["op"],"properties":{"op":{"type":"string","description":"The PATCH operation to perform.","enum":["add","replace","remove"],"x-genesys-enum-members":[{"name":"add"},{"name":"replace"},{"name":"remove"}]},"path":{"type":"string","description":"The attribute path that describes the target of the operation. Required for a \"remove\" operation."},"value":{"description":"The value to set in the path.","$ref":"#/definitions/JsonNode"}},"description":"Defines a SCIM PATCH operation. The path and value follow very specific rules based on operation types. See section 3.5.2 \"Modifying with PATCH\" in RFC 7644 for details."},"ScimV2PatchRequest":{"type":"object","required":["schemas"],"properties":{"schemas":{"type":"array","description":"The list of schemas used in the PATCH request.","items":{"type":"string"}},"Operations":{"type":"array","description":"The list of operations to perform for the PATCH request.","items":{"$ref":"#/definitions/ScimV2PatchOperation"}}},"description":"Defines a SCIM PATCH request. See section 3.5.2 \"Modifying with PATCH\" in RFC 7644 for details."},"ScimV2CreateUser":{"type":"object","required":["displayName","userName"],"properties":{"schemas":{"type":"array","description":"The list of supported schemas.","readOnly":true,"items":{"type":"string"}},"active":{"type":"boolean","description":"Indicates whether the user's administrative status is active."},"userName":{"type":"string","description":"The user's Genesys Cloud email address. Must be unique."},"displayName":{"type":"string","description":"The display name of the user."},"password":{"type":"string","description":"The new password for the Genesys Cloud user. Does not return an existing password. When creating a user, if a password is not supplied, then a password will be randomly generated that is 40 characters in length and contains five characters from each of the password policy groups."},"title":{"type":"string","description":"The user's title."},"phoneNumbers":{"type":"array","description":"The list of the user's phone numbers.","items":{"$ref":"#/definitions/ScimPhoneNumber"}},"emails":{"type":"array","description":"The list of the user's email addresses.","items":{"$ref":"#/definitions/ScimEmail"}},"externalId":{"type":"string","description":"The external ID of the user. Set by the provisioning client. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readWrite\"."},"groups":{"type":"array","description":"The list of groups that the user is a member of.","items":{"$ref":"#/definitions/ScimV2GroupReference"}},"roles":{"type":"array","description":"The list of roles assigned to the user.","items":{"$ref":"#/definitions/ScimUserRole"}},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"description":"The URI of the schema for the enterprise user.","$ref":"#/definitions/ScimV2EnterpriseUser"},"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User":{"description":"The URI of the schema for the Genesys Cloud user.","$ref":"#/definitions/ScimUserExtensions"}},"description":"Defines the creation of a SCIM user."},"UserQueue":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The queue description."},"dateCreated":{"type":"string","format":"date-time","description":"The date the queue was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the queue. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the queue."},"createdBy":{"type":"string","description":"The ID of the user that created the queue."},"memberCount":{"type":"integer","format":"int32","description":"The number of users in the queue.","readOnly":true},"mediaSettings":{"type":"object","description":"The media settings for the queue. Valid key values: CALL, CALLBACK, CHAT, EMAIL, MESSAGE, SOCIAL_EXPRESSION, VIDEO_COMM","additionalProperties":{"$ref":"#/definitions/MediaSetting"}},"routingRules":{"type":"array","description":"The routing rules for the queue, used for routing to known or preferred agents.","items":{"$ref":"#/definitions/RoutingRule"}},"bullseye":{"description":"The bulls-eye settings for the queue.","$ref":"#/definitions/Bullseye"},"acwSettings":{"description":"The ACW settings for the queue.","$ref":"#/definitions/AcwSettings"},"skillEvaluationMethod":{"type":"string","description":"The skill evaluation method to use when routing conversations.","enum":["NONE","BEST","ALL"],"x-genesys-enum-members":[{"name":"NONE"},{"name":"BEST"},{"name":"ALL"}]},"queueFlow":{"description":"The in-queue flow to use for conversations waiting in queue.","$ref":"#/definitions/DomainEntityRef"},"whisperPrompt":{"description":"The prompt used for whisper on the queue, if configured.","$ref":"#/definitions/DomainEntityRef"},"enableTranscription":{"type":"boolean","description":"Indicates whether voice transcription is enabled for this queue."},"enableManualAssignment":{"type":"boolean","description":"Indicates whether manual assignment is enabled for this queue."},"callingPartyName":{"type":"string","description":"The name to use for caller identification for outbound calls from this queue."},"callingPartyNumber":{"type":"string","description":"The phone number to use for caller identification for outbound calls from this queue."},"defaultScripts":{"type":"object","description":"The default script Ids for the communication types.","additionalProperties":{"$ref":"#/definitions/Script"}},"outboundMessagingAddresses":{"description":"The messaging addresses for the queue.","$ref":"#/definitions/QueueMessagingAddresses"},"outboundEmailAddress":{"$ref":"#/definitions/QueueEmailAddress"},"joined":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserQueueEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UserQueue"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AuthzGrant":{"type":"object","properties":{"subjectId":{"type":"string"},"division":{"$ref":"#/definitions/AuthzDivision"},"role":{"$ref":"#/definitions/AuthzGrantRole"},"grantMadeAt":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"AuthzGrantPolicy":{"type":"object","properties":{"actions":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"condition":{"type":"string"},"domain":{"type":"string"},"entityName":{"type":"string"}}},"AuthzGrantRole":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"policies":{"type":"array","items":{"$ref":"#/definitions/AuthzGrantPolicy"}},"default":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AuthzSubject":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"grants":{"type":"array","items":{"$ref":"#/definitions/AuthzGrant"}},"version":{"type":"integer","format":"int32"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"RelationshipListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Relationship"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"OutboundRoute":{"type":"object","required":["classificationTypes","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"classificationTypes":{"type":"array","description":"The site associated to the outbound route.","items":{"type":"string"}},"enabled":{"type":"boolean"},"distribution":{"type":"string","enum":["SEQUENTIAL","RANDOM"],"x-genesys-enum-members":[{"name":"SEQUENTIAL"},{"name":"RANDOM"}]},"externalTrunkBases":{"type":"array","description":"Trunk base settings of trunkType \"EXTERNAL\". This base must also be set on an edge logical interface for correct routing.","items":{"$ref":"#/definitions/DomainEntityRef"}},"site":{"description":"The site associated to the outbound route.","readOnly":true,"$ref":"#/definitions/Site"},"managed":{"type":"boolean","description":"Is this outbound route being managed remotely.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UnreadMetric":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"The count of unread alerts for a specific rule type."}}},"MessagingCampaignDivisionView":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Usage":{"type":"object","properties":{"types":{"type":"array","items":{"$ref":"#/definitions/UsageItem"}}}},"UsageItem":{"type":"object","properties":{"type":{"type":"string","enum":["RECORDING","FAX","DOCUMENT","ALL"],"x-genesys-enum-members":[{"name":"RECORDING"},{"name":"FAX"},{"name":"DOCUMENT"},{"name":"ALL"}]},"totalDocumentByteCount":{"type":"integer","format":"int64"},"totalDocumentCount":{"type":"integer","format":"int64"}}},"CategoryListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/KnowledgeCategory"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"KnowledgeExtendedCategory":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Category name"},"description":{"type":"string","description":"Category description"},"knowledgeBase":{"description":"Knowledge base which category does belong to","readOnly":true,"$ref":"#/definitions/KnowledgeBase"},"languageCode":{"type":"string","description":"Actual language of the category","readOnly":true,"enum":["en-US","de-DE"],"x-genesys-enum-members":[{"name":"en-US"},{"name":"de-DE"}]},"dateCreated":{"type":"string","format":"date-time","description":"Category creation date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Category last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"parent":{"description":"Category parent","readOnly":true,"$ref":"#/definitions/KnowledgeCategory"},"children":{"type":"array","description":"Category children","readOnly":true,"items":{"$ref":"#/definitions/KnowledgeCategory"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DocumentCategoryInput":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"KnowledgeBase Category ID"}}},"KnowledgeCategoryRequest":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Category name"},"description":{"type":"string","description":"Category description"},"parent":{"description":"Category parent","$ref":"#/definitions/DocumentCategoryInput"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GeolocationSettings":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"enabled":{"type":"boolean"},"mapboxKey":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ManagementUnitListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ManagementUnit"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"}}},"BuShortTermForecastingSettings":{"type":"object","properties":{"defaultHistoryWeeks":{"type":"integer","format":"int32","description":"The number of historical weeks to consider when creating a forecast. This setting is only used for legacy weighted average forecasts"}}},"BusinessUnit":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"settings":{"description":"Settings for this business unit","$ref":"#/definitions/BusinessUnitSettings"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BusinessUnitSettings":{"type":"object","required":["metadata","startDayOfWeek","timeZone"],"properties":{"startDayOfWeek":{"type":"string","description":"The start day of week for this business unit","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"x-genesys-enum-members":[{"name":"Sunday"},{"name":"Monday"},{"name":"Tuesday"},{"name":"Wednesday"},{"name":"Thursday"},{"name":"Friday"},{"name":"Saturday"}]},"timeZone":{"type":"string","description":"The time zone for this business unit, using the Olsen tz database format"},"shortTermForecasting":{"description":"Short term forecasting settings","$ref":"#/definitions/BuShortTermForecastingSettings"},"metadata":{"description":"Version metadata for this business unit","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"UpdateBusinessUnitRequest":{"type":"object","properties":{"name":{"type":"string","description":"The name of the business unit"},"divisionId":{"type":"string","description":"The ID of the division to which the business unit should be moved"},"settings":{"description":"Configuration for the business unit","$ref":"#/definitions/UpdateBusinessUnitSettings"}}},"UpdateBusinessUnitSettings":{"type":"object","required":["metadata"],"properties":{"startDayOfWeek":{"type":"string","description":"The start day of week for this business unit","readOnly":true,"enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"x-genesys-enum-members":[{"name":"Sunday"},{"name":"Monday"},{"name":"Tuesday"},{"name":"Wednesday"},{"name":"Thursday"},{"name":"Friday"},{"name":"Saturday"}]},"timeZone":{"type":"string","description":"The time zone for this business unit, using the Olsen tz database format","readOnly":true},"shortTermForecasting":{"description":"Short term forecasting settings","$ref":"#/definitions/BuShortTermForecastingSettings"},"metadata":{"description":"Version metadata for this business unit","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"DIDPoolEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DIDPool"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ActivityCode":{"type":"object","required":["metadata"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"name":{"type":"string","description":"The name of the activity code. Default activity codes will be created with an empty name"},"isActive":{"type":"boolean","description":"Whether this activity code is active or has been deleted"},"isDefault":{"type":"boolean","description":"Whether this is a default activity code"},"category":{"type":"string","description":"The activity code's category.","enum":["OnQueueWork","Break","Meal","Meeting","OffQueueWork","TimeOff","Training","Unavailable","Unscheduled"],"x-genesys-enum-members":[{"name":"OnQueueWork"},{"name":"Break"},{"name":"Meal"},{"name":"Meeting"},{"name":"OffQueueWork"},{"name":"TimeOff"},{"name":"Training"},{"name":"Unavailable"},{"name":"Unscheduled"}]},"lengthInMinutes":{"type":"integer","format":"int32","description":"The default length of the activity in minutes"},"countsAsPaidTime":{"type":"boolean","description":"Whether an agent is paid while performing this activity"},"countsAsWorkTime":{"type":"boolean","description":"Indicates whether or not the activity should be counted as contiguous work time for calculating daily constraints"},"agentTimeOffSelectable":{"type":"boolean","description":"Whether an agent can select this activity code when creating or editing a time off request. Null if the activity's category is not time off."},"metadata":{"description":"Version metadata for the associated management unit's list of activity codes","$ref":"#/definitions/WfmVersionedEntityMetadata"}},"description":"Activity code data"},"ActivityCodeContainer":{"type":"object","required":["metadata"],"properties":{"activityCodes":{"type":"object","description":"Map of activity code id to activity code","additionalProperties":{"$ref":"#/definitions/ActivityCode"}},"metadata":{"description":"Version metadata for the associated management unit's list of activity codes","$ref":"#/definitions/WfmVersionedEntityMetadata"}},"description":"Container for a map of ActivityCodeId to ActivityCode"},"DomainEntityListingQueryResult":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/QueryResult"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FacetEntry":{"type":"object","properties":{"attribute":{"$ref":"#/definitions/TermAttribute"},"statistics":{"$ref":"#/definitions/FacetStatistics"},"other":{"type":"integer","format":"int64"},"total":{"type":"integer","format":"int64"},"missing":{"type":"integer","format":"int64"},"termCount":{"type":"integer","format":"int32"},"termType":{"type":"string","enum":["TERM","NUMBERRANGE","NUMBERHISTOGRAM","DATERANGE","DATEHISTOGRAM","ID"],"x-genesys-enum-members":[{"name":"TERM"},{"name":"NUMBERRANGE"},{"name":"NUMBERHISTOGRAM"},{"name":"DATERANGE"},{"name":"DATEHISTOGRAM"},{"name":"ID"}]},"terms":{"type":"array","items":{"$ref":"#/definitions/FacetTerm"}}}},"FacetKeyAttribute":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"count":{"type":"integer","format":"int32"}}},"FacetStatistics":{"type":"object","properties":{"count":{"type":"integer","format":"int64"},"min":{"type":"number","format":"double"},"max":{"type":"number","format":"double"},"mean":{"type":"number","format":"double"},"stdDeviation":{"type":"number","format":"double"},"dateMin":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateMax":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"FacetTerm":{"type":"object","properties":{"term":{"type":"string"},"key":{"type":"integer","format":"int64"},"id":{"type":"string"},"name":{"type":"string"},"count":{"type":"integer","format":"int64"},"time":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"QueryFacetInfo":{"type":"object","properties":{"attributes":{"type":"array","items":{"$ref":"#/definitions/FacetKeyAttribute"}},"facets":{"type":"array","items":{"$ref":"#/definitions/FacetEntry"}}}},"QueryResult":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"body":{"$ref":"#/definitions/DomainEntity"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"QueryResults":{"type":"object","properties":{"results":{"$ref":"#/definitions/DomainEntityListingQueryResult"},"facetInfo":{"$ref":"#/definitions/QueryFacetInfo"}}},"TermAttribute":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string","enum":["NUMBER","STRING","DATE","BOOLEAN","LIST"],"x-genesys-enum-members":[{"name":"NUMBER"},{"name":"STRING"},{"name":"DATE"},{"name":"BOOLEAN"},{"name":"LIST"}]}}},"AttributeFilterItem":{"type":"object","properties":{"id":{"type":"string"},"operator":{"type":"string","enum":["IN","RANGE","EQUALS","NOTEQUALS","LESSTHAN","LESSTHANEQUALS","GREATERTHAN","GREATERTHANEQUALS","CONTAINS"],"x-genesys-enum-members":[{"name":"IN"},{"name":"RANGE"},{"name":"EQUALS"},{"name":"NOTEQUALS"},{"name":"LESSTHAN"},{"name":"LESSTHANEQUALS"},{"name":"GREATERTHAN"},{"name":"GREATERTHANEQUALS"},{"name":"CONTAINS"}]},"values":{"type":"array","items":{"type":"string"}}}},"ContentFilterItem":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["NUMBER","STRING","DATE","BOOLEAN","LIST"],"x-genesys-enum-members":[{"name":"NUMBER"},{"name":"STRING"},{"name":"DATE"},{"name":"BOOLEAN"},{"name":"LIST"}]},"operator":{"type":"string","enum":["IN","RANGE","EQUALS","NOTEQUALS","LESSTHAN","LESSTHANEQUALS","GREATERTHAN","GREATERTHANEQUALS","CONTAINS"],"x-genesys-enum-members":[{"name":"IN"},{"name":"RANGE"},{"name":"EQUALS"},{"name":"NOTEQUALS"},{"name":"LESSTHAN"},{"name":"LESSTHANEQUALS"},{"name":"GREATERTHAN"},{"name":"GREATERTHANEQUALS"},{"name":"CONTAINS"}]},"values":{"type":"array","items":{"type":"string"}}}},"QueryRequest":{"type":"object","properties":{"queryPhrase":{"type":"string"},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"facetNameRequests":{"type":"array","items":{"type":"string"}},"sort":{"type":"array","items":{"$ref":"#/definitions/SortItem"}},"filters":{"type":"array","items":{"$ref":"#/definitions/ContentFilterItem"}},"attributeFilters":{"type":"array","items":{"$ref":"#/definitions/AttributeFilterItem"}},"includeShares":{"type":"boolean"}}},"SortItem":{"type":"object","properties":{"name":{"type":"string"},"ascending":{"type":"boolean"}}},"Prompt":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The prompt identifier"},"name":{"type":"string","description":"The prompt name."},"description":{"type":"string"},"resources":{"type":"array","description":"List of resources associated with this prompt","readOnly":true,"items":{"$ref":"#/definitions/PromptAsset"}},"currentOperation":{"description":"Current prompt operation status","readOnly":true,"$ref":"#/definitions/Operation"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PromptAsset":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"promptId":{"type":"string","description":"Associated prompt ID","readOnly":true},"language":{"type":"string","description":"Prompt resource language","readOnly":true},"mediaUri":{"type":"string","description":"URI of the resource audio","readOnly":true},"ttsString":{"type":"string","description":"Text to speech of the resource"},"text":{"type":"string","description":"Text of the resource"},"uploadStatus":{"type":"string","description":"Audio upload status","readOnly":true,"enum":["created","uploaded","transcoded","transcodeFailed"],"x-genesys-enum-members":[{"name":"created"},{"name":"uploaded"},{"name":"transcoded"},{"name":"transcodeFailed"}]},"uploadUri":{"type":"string","description":"Upload URI for the resource audio","readOnly":true},"languageDefault":{"type":"boolean","description":"Whether or not this resource locale is the default for the language","readOnly":true},"tags":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"durationSeconds":{"type":"number","format":"double"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PromptEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Prompt"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FlowOutcome":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The flow outcome identifier"},"name":{"type":"string","description":"The flow outcome name."},"description":{"type":"string"},"currentOperation":{"$ref":"#/definitions/Operation"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CampaignRule":{"type":"object","required":["campaignRuleActions","campaignRuleConditions","campaignRuleEntities","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the CampaignRule."},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"campaignRuleEntities":{"description":"The list of entities that this CampaignRule monitors.","$ref":"#/definitions/CampaignRuleEntities"},"campaignRuleConditions":{"type":"array","description":"The list of conditions that are evaluated on the entities.","items":{"$ref":"#/definitions/CampaignRuleCondition"}},"campaignRuleActions":{"type":"array","description":"The list of actions that are executed if the conditions are satisfied.","items":{"$ref":"#/definitions/CampaignRuleAction"}},"matchAnyConditions":{"type":"boolean"},"enabled":{"type":"boolean","description":"Whether or not this CampaignRule is currently enabled. Required on updates."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CampaignRuleAction":{"type":"object","required":["actionType","campaignRuleActionEntities"],"properties":{"id":{"type":"string"},"parameters":{"description":"The parameters for the CampaignRuleAction. Required for certain actionTypes.","$ref":"#/definitions/CampaignRuleParameters"},"actionType":{"type":"string","description":"The action to take on the campaignRuleActionEntities.","enum":["turnOnCampaign","turnOffCampaign","turnOnSequence","turnOffSequence","setCampaignPriority","recycleCampaign","setCampaignDialingMode"],"x-genesys-enum-members":[{"name":"turnOnCampaign"},{"name":"turnOffCampaign"},{"name":"turnOnSequence"},{"name":"turnOffSequence"},{"name":"setCampaignPriority"},{"name":"recycleCampaign"},{"name":"setCampaignDialingMode"}]},"campaignRuleActionEntities":{"description":"The list of entities that this action will apply to.","$ref":"#/definitions/CampaignRuleActionEntities"}}},"CampaignRuleActionEntities":{"type":"object","properties":{"campaigns":{"type":"array","description":"The list of campaigns for a CampaignRule to monitor. Required if the CampaignRule has any conditions that run on a campaign.","items":{"$ref":"#/definitions/DomainEntityRef"}},"sequences":{"type":"array","description":"The list of sequences for a CampaignRule to monitor. Required if the CampaignRule has any conditions that run on a sequence.","items":{"$ref":"#/definitions/DomainEntityRef"}},"useTriggeringEntity":{"type":"boolean","description":"If true, the CampaignRuleAction will apply to the same entity that triggered the CampaignRuleCondition."}}},"CampaignRuleCondition":{"type":"object","required":["conditionType","parameters"],"properties":{"id":{"type":"string"},"parameters":{"description":"The parameters for the CampaignRuleCondition.","$ref":"#/definitions/CampaignRuleParameters"},"conditionType":{"type":"string","description":"The type of condition to evaluate.","enum":["campaignProgress","campaignAgents"],"x-genesys-enum-members":[{"name":"campaignProgress"},{"name":"campaignAgents"}]}}},"CampaignRuleEntities":{"type":"object","properties":{"campaigns":{"type":"array","description":"The list of campaigns for a CampaignRule to monitor. Required if the CampaignRule has any conditions that run on a campaign.","items":{"$ref":"#/definitions/DomainEntityRef"}},"sequences":{"type":"array","description":"The list of sequences for a CampaignRule to monitor. Required if the CampaignRule has any conditions that run on a sequence.","items":{"$ref":"#/definitions/DomainEntityRef"}}}},"CampaignRuleParameters":{"type":"object","properties":{"operator":{"type":"string","description":"The operator for comparison. Required for a CampaignRuleCondition.","enum":["equals","greaterThan","greaterThanEqualTo","lessThan","lessThanEqualTo"],"x-genesys-enum-members":[{"name":"equals"},{"name":"greaterThan"},{"name":"greaterThanEqualTo"},{"name":"lessThan"},{"name":"lessThanEqualTo"}]},"value":{"type":"string","description":"The value for comparison. Required for a CampaignRuleCondition."},"priority":{"type":"string","description":"The priority to set a campaign to. Required for the 'setCampaignPriority' action.","enum":["1","2","3","4","5"],"x-genesys-enum-members":[{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},"dialingMode":{"type":"string","description":"The dialing mode to set a campaign to. Required for the 'setCampaignDialingMode' action.","enum":["agentless","preview","power","predictive","progressive","external"],"x-genesys-enum-members":[{"name":"agentless"},{"name":"preview"},{"name":"power"},{"name":"predictive"},{"name":"progressive"},{"name":"external"}]}}},"CampaignRuleEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CampaignRule"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"LicenseUpdateStatus":{"type":"object","properties":{"userId":{"type":"string"},"licenseId":{"type":"string"},"result":{"type":"string"}}},"LicenseAssignmentRequest":{"type":"object","required":["licenseId","userIdsAdd","userIdsRemove"],"properties":{"licenseId":{"type":"string","description":"The id of the license to assign/unassign."},"userIdsAdd":{"type":"array","description":"The ids of users to assign this license to.","uniqueItems":true,"items":{"type":"string"}},"userIdsRemove":{"type":"array","description":"The ids of users to unassign this license from.","uniqueItems":true,"items":{"type":"string"}}}},"LicenseBatchAssignmentRequest":{"type":"object","required":["assignments"],"properties":{"assignments":{"type":"array","description":"The list of license assignment updates to make.","items":{"$ref":"#/definitions/LicenseAssignmentRequest"}}}},"TagValueEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/TagValue"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"TagQueryRequest":{"type":"object","properties":{"query":{"type":"string"},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"}}},"OAuthClientEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/OAuthClientListing"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"OAuthClientListing":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the OAuth client."},"accessTokenValiditySeconds":{"type":"integer","format":"int64","description":"The number of seconds, between 5mins and 48hrs, until tokens created with this client expire. If this field is omitted, a default of 24 hours will be applied."},"description":{"type":"string"},"registeredRedirectUri":{"type":"array","description":"List of allowed callbacks for this client. For example: https://myap.example.com/auth/callback","items":{"type":"string","format":"uri"}},"secret":{"type":"string","description":"System created secret assigned to this client. Secrets are required for code authorization and client credential grants."},"roleIds":{"type":"array","description":"Deprecated. Use roleDivisions instead.","uniqueItems":true,"items":{"type":"string"}},"dateCreated":{"type":"string","format":"date-time","description":"Date this client was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date this client was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"description":"User that created this client","$ref":"#/definitions/DomainEntityRef"},"modifiedBy":{"description":"User that last modified this client","$ref":"#/definitions/DomainEntityRef"},"scope":{"type":"array","description":"The scope requested by this client. Scopes only apply to clients not using the client_credential grant","items":{"type":"string"}},"roleDivisions":{"type":"array","description":"Set of roles and their corresponding divisions associated with this client. Roles and divisions only apply to clients using the client_credential grant","uniqueItems":true,"items":{"$ref":"#/definitions/RoleDivision"}},"state":{"type":"string","description":"The state of the OAuth client.\nActive: The OAuth client can be used to create access tokens. This is the default state.\nDisabled: Access tokens created by the client are invalid and new ones cannot be created.\nInactive: Access tokens cannot be created with this OAuth client and it will be deleted.","enum":["active","disabled","inactive"],"x-genesys-enum-members":[{"name":"active"},{"name":"disabled"},{"name":"inactive"}]},"dateToDelete":{"type":"string","format":"date-time","description":"The time at which this client will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FreeSeatingConfiguration":{"type":"object","properties":{"freeSeatingState":{"type":"string","description":"The FreeSeatingState for FreeSeatingConfiguration. Can be ON, OFF, or PARTIAL. ON meaning disassociate the user after the ttl expires, OFF meaning never disassociate the user, and PARTIAL meaning only disassociate when a user explicitly clicks log out.","enum":["ON","OFF","PARTIAL"],"x-genesys-enum-members":[{"name":"ON"},{"name":"OFF"},{"name":"PARTIAL"}]},"ttlMinutes":{"type":"integer","format":"int32","description":"The amount of time in minutes until an offline user is disassociated from their station"}}},"StationSettings":{"type":"object","properties":{"freeSeatingConfiguration":{"description":"Configuration options for free-seating","$ref":"#/definitions/FreeSeatingConfiguration"}},"description":"Organization settings for stations"},"SecureSession":{"type":"object","required":["flow","state"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"flow":{"description":"The flow to execute securely","$ref":"#/definitions/DomainEntityRef"},"userData":{"type":"string","description":"Customer-provided data"},"state":{"type":"string","description":"The current state of a secure session","enum":["PENDING","COMPLETED","FAILED"],"x-genesys-enum-members":[{"name":"PENDING"},{"name":"COMPLETED"},{"name":"FAILED"}]},"sourceParticipantId":{"type":"string","description":"Unique identifier for the participant initiating the secure session."},"disconnect":{"type":"boolean","description":"If true, disconnect the agent after creating the session"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SecureSessionEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SecureSession"}}}},"CreateSecureSession":{"type":"object","required":["flowId","userData"],"properties":{"sourceParticipantId":{"type":"string","description":"requesting participant"},"flowId":{"type":"string","description":"the flow id to execute in the secure session"},"userData":{"type":"string","description":"user data for the secure session"},"disconnect":{"type":"boolean","description":"if true, disconnect the agent after creating the session"}}},"LineIntegration":{"type":"object","required":["channelId","id","name","version","webhookUri"],"properties":{"id":{"type":"string","description":"A unique Integration Id","readOnly":true},"name":{"type":"string","description":"The name of the LINE Integration"},"channelId":{"type":"string","description":"The Channel Id from LINE messenger"},"webhookUri":{"type":"string","format":"uri","description":"The Webhook URI to be updated in LINE platform"},"status":{"type":"string","description":"The status of the LINE Integration"},"recipient":{"description":"The recipient associated to the Line Integration. This recipient is used to associate a flow to an integration","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"dateCreated":{"type":"string","format":"date-time","description":"Date this Integration was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date this Integration was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"description":"User reference that created this Integration","$ref":"#/definitions/DomainEntityRef"},"modifiedBy":{"description":"User reference that last modified this Integration","$ref":"#/definitions/DomainEntityRef"},"version":{"type":"integer","format":"int32","description":"Version number required for updates."},"createStatus":{"type":"string","description":"Status of asynchronous create operation","readOnly":true,"enum":["Initiated","Completed","Error"],"x-genesys-enum-members":[{"name":"Initiated","description":"The integration create request has started"},{"name":"Completed","description":"The integration create request has finished successfully"},{"name":"Error","description":"The integration create request has finished in error."}]},"createError":{"description":"Error information returned, if createStatus is set to Error","readOnly":true,"$ref":"#/definitions/ErrorBody"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LineIntegrationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/LineIntegration"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"LineIntegrationRequest":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the LINE Integration"},"channelId":{"type":"string","description":"The Channel Id from LINE messenger.\nNew Official LINE account: To create a new official account, LINE requires a Webhook URL. It can be created without specifying Channel Id & Channel Secret. Once the Official account is created by LINE, use the update LINE Integration API to update Channel Id and Channel Secret. \nAll other accounts: Channel Id is mandatory. (NOTE: ChannelId can only be updated if the integration is set to inactive)"},"channelSecret":{"type":"string","description":"The Channel Secret from LINE messenger. New Official LINE account: To create a new official account, LINE requires a Webhook URL. It can be created without specifying Channel Id & Channel Secret. Once the Official account is created by LINE, use the update LINE Integration API to update Channel Id and Channel Secret. \nAll other accounts: Channel Secret is mandatory. (NOTE: ChannelSecret can only be updated if the integration is set to inactive)"},"switcherSecret":{"type":"string","description":"The Switcher Secret from LINE messenger. Some line official accounts are switcher functionality enabled. If the LINE account used for this integration is switcher enabled, then switcher secret is a required field. This secret can be found in your create documentation provided by LINE"},"serviceCode":{"type":"string","description":"The Service Code from LINE messenger. Only applicable to LINE Enterprise accounts. This service code can be found in your create documentation provided by LINE"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"InteractionStatsRule":{"type":"object","required":["alertTypes","dimension","dimensionValue","enabled","mediaType","metric","name","notificationUsers","numericRange","statistic","value"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Name of the rule"},"dimension":{"type":"string","description":"The dimension of concern.","enum":["queueId","userId"],"x-genesys-enum-members":[{"name":"queueId"},{"name":"userId"}]},"dimensionValue":{"type":"string","description":"The value of the dimension."},"metric":{"type":"string","description":"The metric to be assessed.","enum":["tAbandon","tAnswered","tTalk","nOffered","tHandle","nTransferred","oServiceLevel","tWait","tHeld","tAcw"],"x-genesys-enum-members":[{"name":"tAbandon"},{"name":"tAnswered"},{"name":"tTalk"},{"name":"nOffered"},{"name":"tHandle"},{"name":"nTransferred"},{"name":"oServiceLevel"},{"name":"tWait"},{"name":"tHeld"},{"name":"tAcw"}]},"mediaType":{"type":"string","description":"The media type.","enum":["voice","chat","email","callback","message"],"x-genesys-enum-members":[{"name":"voice"},{"name":"chat"},{"name":"email"},{"name":"callback"},{"name":"message"}]},"numericRange":{"type":"string","description":"The comparison descriptor used against the metric's value.","enum":["gt","gte","lt","lte","eq","ne"],"x-genesys-enum-members":[{"name":"gt"},{"name":"gte"},{"name":"lt"},{"name":"lte"},{"name":"eq"},{"name":"ne"}]},"statistic":{"type":"string","description":"The statistic of concern for the metric.","enum":["count","min","ratio","max"],"x-genesys-enum-members":[{"name":"count"},{"name":"min"},{"name":"ratio"},{"name":"max"}]},"value":{"type":"number","format":"double","description":"The threshold value."},"enabled":{"type":"boolean","description":"Indicates if the rule is enabled."},"inAlarm":{"type":"boolean","description":"Indicates if the rule is in alarm state.","readOnly":true},"notificationUsers":{"type":"array","description":"The ids of users who will be notified of alarm state change.","uniqueItems":true,"items":{"$ref":"#/definitions/User"}},"alertTypes":{"type":"array","description":"A collection of notification methods.","uniqueItems":true,"items":{"type":"string","enum":["SMS","DEVICE","EMAIL"],"x-genesys-enum-members":[{"name":"SMS"},{"name":"DEVICE"},{"name":"EMAIL"}]}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SurveyFormAndScoringSet":{"type":"object","properties":{"surveyForm":{"$ref":"#/definitions/SurveyForm"},"answers":{"$ref":"#/definitions/SurveyScoringSet"}}},"QueueMemberEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/QueueMember"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AttemptLimits":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"maxAttemptsPerContact":{"type":"integer","format":"int32","description":"The maximum number of times a contact can be called within the resetPeriod. Required if maxAttemptsPerNumber is not defined."},"maxAttemptsPerNumber":{"type":"integer","format":"int32","description":"The maximum number of times a phone number can be called within the resetPeriod. Required if maxAttemptsPerContact is not defined."},"timeZoneId":{"type":"string","description":"If the resetPeriod is TODAY, this specifies the timezone in which TODAY occurs. Required if the resetPeriod is TODAY."},"resetPeriod":{"type":"string","description":"After how long the number of attempts will be set back to 0. Defaults to NEVER.","enum":["NEVER","TODAY"],"x-genesys-enum-members":[{"name":"NEVER"},{"name":"TODAY"}]},"recallEntries":{"type":"object","description":"Configuration for recall attempts.","additionalProperties":{"$ref":"#/definitions/RecallEntry"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"RecallEntry":{"type":"object","properties":{"nbrAttempts":{"type":"integer","format":"int32"},"minutesBetweenAttempts":{"type":"integer","format":"int32"}}},"AttemptLimitsEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AttemptLimits"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"IpAddressAuthentication":{"type":"object","properties":{"networkWhitelist":{"type":"array","items":{"type":"string"}}}},"DataTable":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string","description":"The description from the JSON schema (equates to the Description field on the JSON schema.)"},"schema":{"description":"the schema as stored in the system.","$ref":"#/definitions/JsonSchemaDocument"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Contains a metadata representation for a JSON schema stored in DataTables along with an optional field for the schema itself"},"ImportStatus":{"type":"object","required":["completedRecords","percentComplete","state","totalRecords"],"properties":{"state":{"type":"string","description":"current status of the import","readOnly":true,"enum":["IN_PROGRESS","FAILED"],"x-genesys-enum-members":[{"name":"IN_PROGRESS"},{"name":"FAILED"}]},"totalRecords":{"type":"integer","format":"int64","description":"total number of records to be imported","readOnly":true},"completedRecords":{"type":"integer","format":"int64","description":"number of records finished importing","readOnly":true},"percentComplete":{"type":"integer","format":"int32","description":"percentage of records finished importing","readOnly":true},"failureReason":{"type":"string","description":"if the import has failed, the reason for the failure","readOnly":true}}},"AvailableLanguageList":{"type":"object","properties":{"languages":{"type":"array","items":{"type":"string"}}}},"ManagementUnitSettingsRequest":{"type":"object","required":["metadata"],"properties":{"adherence":{"description":"Adherence settings for this management unit","$ref":"#/definitions/AdherenceSettings"},"shortTermForecasting":{"description":"Short term forecasting settings for this management unit. Moving to Business Unit","$ref":"#/definitions/ShortTermForecastingSettings"},"timeOff":{"description":"Time off request settings for this management unit","$ref":"#/definitions/TimeOffRequestSettings"},"scheduling":{"description":"Scheduling settings for this management unit","$ref":"#/definitions/SchedulingSettingsRequest"},"shiftTrading":{"description":"Shift trade settings for this management unit","$ref":"#/definitions/ShiftTradeSettings"},"metadata":{"description":"Version info metadata for the associated management unit","$ref":"#/definitions/WfmVersionedEntityMetadata"}},"description":"Management Unit Settings"},"SchedulingSettingsRequest":{"type":"object","properties":{"maxOccupancyPercentForDeferredWork":{"type":"integer","format":"int32","description":"Max occupancy percent for deferred work"},"defaultShrinkagePercent":{"type":"number","format":"double","description":"Default shrinkage percent for scheduling"},"shrinkageOverrides":{"description":"Shrinkage overrides for scheduling","$ref":"#/definitions/ShrinkageOverrides"}},"description":"Scheduling Settings"},"UpdateManagementUnitRequest":{"type":"object","properties":{"name":{"type":"string","description":"The new name of the management unit"},"divisionId":{"type":"string","description":"The new division id for the management unit"},"settings":{"description":"Updated settings for the management unit","$ref":"#/definitions/ManagementUnitSettingsRequest"}}},"ValueWrapperPlanningPeriodSettings":{"type":"object","properties":{"value":{"description":"The value for the associated field","$ref":"#/definitions/PlanningPeriodSettings"}},"description":"An object to provide context to nullable fields in PATCH requests"},"MoveManagementUnitResponse":{"type":"object","properties":{"businessUnit":{"description":"The new business unit","$ref":"#/definitions/BusinessUnitReference"},"status":{"type":"string","description":"The status of the move. Will always be 'Processing' unless the Management Unit is already in the requested Business Unit in which case it will be 'Complete'","enum":["Processing","Complete","Canceled","Error"],"x-genesys-enum-members":[{"name":"Processing"},{"name":"Complete"},{"name":"Canceled"},{"name":"Error"}]}}},"MoveManagementUnitRequest":{"type":"object","required":["businessUnitId"],"properties":{"businessUnitId":{"type":"string","description":"The ID of the business unit to which to move the management unit"}}},"AuditChange":{"type":"object","properties":{"property":{"type":"string"},"entity":{"$ref":"#/definitions/AuditEntityReference"},"oldValues":{"type":"array","items":{"type":"string"}},"newValues":{"type":"array","items":{"type":"string"}}}},"AuditEntityReference":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri"},"type":{"type":"string","enum":["ATTRIBUTE","ATTRIBUTE_GROUP_INSTANCE","DOCUMENT","DOWNLOAD","FAX","GROUP","RECORDING","TAG","WORKSPACE","USER","PUBLIC"],"x-genesys-enum-members":[{"name":"ATTRIBUTE"},{"name":"ATTRIBUTE_GROUP_INSTANCE"},{"name":"DOCUMENT"},{"name":"DOWNLOAD"},{"name":"FAX"},{"name":"GROUP"},{"name":"RECORDING"},{"name":"TAG"},{"name":"WORKSPACE"},{"name":"USER"},{"name":"PUBLIC"}]},"action":{"type":"string"}}},"DocumentAudit":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"user":{"$ref":"#/definitions/DomainEntityRef"},"workspace":{"$ref":"#/definitions/DomainEntityRef"},"transactionId":{"type":"string"},"transactionInitiator":{"type":"boolean"},"application":{"type":"string"},"serviceName":{"type":"string"},"level":{"type":"string","enum":["USER","SYSTEM"],"x-genesys-enum-members":[{"name":"USER"},{"name":"SYSTEM"}]},"timestamp":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"status":{"type":"string","enum":["SUCCESS","FAILURE","WARNING"],"x-genesys-enum-members":[{"name":"SUCCESS"},{"name":"FAILURE"},{"name":"WARNING"}]},"actionContext":{"type":"string","enum":["CREATE","READ","UPDATE","DELETE","DOWNLOAD","VIEW","UPLOAD","SAVE","MOVE","COPY","ADD","REMOVE","RECEIVE","CONVERT","FAX","CREATE_COVERPAGE","USER_ADD","USER_REMOVE","MEMBER_ADD","MEMBER_REMOVE","MEMBER_UPDATE","TAG_ADD","TAG_REMOVE","TAG_UPDATE","ATTRIBUTE_ADD","ATTRIBUTE_REMOVE","ATTRIBUTE_UPDATE","ATTRIBUTE_GROUP_INSTANCE_ADD","ATTRIBUTE_GROUP_INSTANCE_REMOVE","ATTRIBUTE_GROUP_INSTANCE_UPDATE","INDEX_SAVE","INDEX_DELETE","INDEX_CREATE","FILE_SAVE","FILE_DELETE","FILE_READ","THUMBNAIL_CREATE","TEXT_EXTRACT","SHARE_ADD","SHARE_REMOVE","VERSION_CREATE"],"x-genesys-enum-members":[{"name":"CREATE"},{"name":"READ"},{"name":"UPDATE"},{"name":"DELETE"},{"name":"DOWNLOAD"},{"name":"VIEW"},{"name":"UPLOAD"},{"name":"SAVE"},{"name":"MOVE"},{"name":"COPY"},{"name":"ADD"},{"name":"REMOVE"},{"name":"RECEIVE"},{"name":"CONVERT"},{"name":"FAX"},{"name":"CREATE_COVERPAGE"},{"name":"USER_ADD"},{"name":"USER_REMOVE"},{"name":"MEMBER_ADD"},{"name":"MEMBER_REMOVE"},{"name":"MEMBER_UPDATE"},{"name":"TAG_ADD"},{"name":"TAG_REMOVE"},{"name":"TAG_UPDATE"},{"name":"ATTRIBUTE_ADD"},{"name":"ATTRIBUTE_REMOVE"},{"name":"ATTRIBUTE_UPDATE"},{"name":"ATTRIBUTE_GROUP_INSTANCE_ADD"},{"name":"ATTRIBUTE_GROUP_INSTANCE_REMOVE"},{"name":"ATTRIBUTE_GROUP_INSTANCE_UPDATE"},{"name":"INDEX_SAVE"},{"name":"INDEX_DELETE"},{"name":"INDEX_CREATE"},{"name":"FILE_SAVE"},{"name":"FILE_DELETE"},{"name":"FILE_READ"},{"name":"THUMBNAIL_CREATE"},{"name":"TEXT_EXTRACT"},{"name":"SHARE_ADD"},{"name":"SHARE_REMOVE"},{"name":"VERSION_CREATE"}]},"action":{"type":"string","enum":["CREATE","READ","UPDATE","DELETE","DOWNLOAD","VIEW","UPLOAD","SAVE","MOVE","COPY","ADD","REMOVE","RECEIVE","CONVERT","FAX","CREATE_COVERPAGE","USER_ADD","USER_REMOVE","MEMBER_ADD","MEMBER_REMOVE","MEMBER_UPDATE","TAG_ADD","TAG_REMOVE","TAG_UPDATE","ATTRIBUTE_ADD","ATTRIBUTE_REMOVE","ATTRIBUTE_UPDATE","ATTRIBUTE_GROUP_INSTANCE_ADD","ATTRIBUTE_GROUP_INSTANCE_REMOVE","ATTRIBUTE_GROUP_INSTANCE_UPDATE","INDEX_SAVE","INDEX_DELETE","INDEX_CREATE","FILE_SAVE","FILE_DELETE","FILE_READ","THUMBNAIL_CREATE","TEXT_EXTRACT","SHARE_ADD","SHARE_REMOVE","VERSION_CREATE"],"x-genesys-enum-members":[{"name":"CREATE"},{"name":"READ"},{"name":"UPDATE"},{"name":"DELETE"},{"name":"DOWNLOAD"},{"name":"VIEW"},{"name":"UPLOAD"},{"name":"SAVE"},{"name":"MOVE"},{"name":"COPY"},{"name":"ADD"},{"name":"REMOVE"},{"name":"RECEIVE"},{"name":"CONVERT"},{"name":"FAX"},{"name":"CREATE_COVERPAGE"},{"name":"USER_ADD"},{"name":"USER_REMOVE"},{"name":"MEMBER_ADD"},{"name":"MEMBER_REMOVE"},{"name":"MEMBER_UPDATE"},{"name":"TAG_ADD"},{"name":"TAG_REMOVE"},{"name":"TAG_UPDATE"},{"name":"ATTRIBUTE_ADD"},{"name":"ATTRIBUTE_REMOVE"},{"name":"ATTRIBUTE_UPDATE"},{"name":"ATTRIBUTE_GROUP_INSTANCE_ADD"},{"name":"ATTRIBUTE_GROUP_INSTANCE_REMOVE"},{"name":"ATTRIBUTE_GROUP_INSTANCE_UPDATE"},{"name":"INDEX_SAVE"},{"name":"INDEX_DELETE"},{"name":"INDEX_CREATE"},{"name":"FILE_SAVE"},{"name":"FILE_DELETE"},{"name":"FILE_READ"},{"name":"THUMBNAIL_CREATE"},{"name":"TEXT_EXTRACT"},{"name":"SHARE_ADD"},{"name":"SHARE_REMOVE"},{"name":"VERSION_CREATE"}]},"entity":{"$ref":"#/definitions/AuditEntityReference"},"changes":{"type":"array","items":{"$ref":"#/definitions/AuditChange"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DocumentAuditEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DocumentAudit"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DncListDivisionView":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"importStatus":{"description":"The status of the import process.","readOnly":true,"$ref":"#/definitions/ImportStatus"},"size":{"type":"integer","format":"int64","description":"The number of contacts in the ContactList.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DncListDivisionViewListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DncListDivisionView"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AuditEntity":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"The type of the entity the action of this AuditEntity targeted."},"id":{"type":"string","description":"The id of the entity the action of this AuditEntity targeted."},"name":{"type":"string","description":"The name of the entity the action of this AuditEntity targeted."},"selfUri":{"type":"string","description":"The selfUri for this entity."}}},"AuditMessage":{"type":"object","required":["id","level","receivedTimestamp","serviceName","status"],"properties":{"id":{"type":"string","description":"AuditMessage ID."},"user":{"$ref":"#/definitions/AuditUser"},"correlationId":{"type":"string","description":"Correlation ID."},"transactionId":{"type":"string","description":"Transaction ID."},"transactionInitiator":{"type":"boolean","description":"Whether or not this audit can be considered the initiator of the transaction it is a part of."},"application":{"type":"string","description":"The application through which the action of this AuditMessage was initiated."},"serviceName":{"type":"string","description":"The name of the service which sent this AuditMessage."},"level":{"type":"string","description":"The level of this audit. USER or SYSTEM."},"timestamp":{"type":"string","description":"The time at which the action of this AuditMessage was initiated."},"receivedTimestamp":{"type":"string","description":"The time at which this AuditMessage was received."},"status":{"type":"string","description":"The status of the action of this AuditMessage"},"actionContext":{"type":"string","description":"The context of a system-level action"},"action":{"type":"string","description":"A string representing the action that took place"},"changes":{"type":"array","description":"Details about any changes that occurred in this audit","items":{"$ref":"#/definitions/Change"}},"entity":{"$ref":"#/definitions/AuditEntity"},"serviceContext":{"description":"The service-specific context associated with this AuditMessage.","$ref":"#/definitions/ServiceContext"}}},"AuditSearchResult":{"type":"object","properties":{"pageNumber":{"type":"integer","format":"int32","description":"Which page was returned."},"pageSize":{"type":"integer","format":"int32","description":"The number of results in a page."},"total":{"type":"integer","format":"int32","description":"The total number of results."},"pageCount":{"type":"integer","format":"int32","description":"The number of pages of results."},"facetInfo":{"type":"array","items":{"$ref":"#/definitions/FacetInfo"}},"auditMessages":{"type":"array","items":{"$ref":"#/definitions/AuditMessage"}}}},"AuditUser":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID (UUID) of the user who initiated the action of this AuditMessage."},"name":{"type":"string","description":"The full username of the user who initiated the action of this AuditMessage."},"display":{"type":"string","description":"The display name of the user who initiated the action of this AuditMessage."}}},"Change":{"type":"object","properties":{"entity":{"$ref":"#/definitions/AuditEntity"},"property":{"type":"string","description":"The property that was changed"},"oldValues":{"type":"array","description":"The old values which were modified and/or removed by this action.","items":{"type":"string"}},"newValues":{"type":"array","description":"The new values which were modified and/or added by this action.","items":{"type":"string"}}}},"Entry":{"type":"object","properties":{"value":{"type":"string","description":"A value included in this facet."},"count":{"type":"integer","format":"int32","description":"The number of results with this value."}}},"FacetInfo":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field that was faceted on."},"entries":{"type":"array","description":"The entries resulting from this facet.","items":{"$ref":"#/definitions/Entry"}}}},"ServiceContext":{"type":"object","properties":{"name":{"type":"string","description":"Unused field for the purpose of ensuring a Swagger definition is created for a class with only @JsonIgnore members."}}},"AuditFacet":{"type":"object","required":["name","type"],"properties":{"name":{"type":"string","description":"The name of the field on which to facet."},"type":{"type":"string","description":"The type of the facet, DATE or STRING."}}},"AuditFilter":{"type":"object","required":["name","operator","type","values"],"properties":{"name":{"type":"string","description":"The name of the field by which to filter."},"type":{"type":"string","description":"The type of the filter, DATE or STRING."},"operator":{"type":"string","description":"The operation that the filter performs."},"values":{"type":"array","description":"The values to make the filter comparison against.","items":{"type":"string"}}}},"DialerAuditRequest":{"type":"object","properties":{"queryPhrase":{"type":"string","description":"The word or words to search for."},"queryFields":{"type":"array","description":"The fields in which to search for the queryPhrase.","items":{"type":"string"}},"facets":{"type":"array","description":"The fields to facet on.","items":{"$ref":"#/definitions/AuditFacet"}},"filters":{"type":"array","description":"The fields to filter on.","items":{"$ref":"#/definitions/AuditFilter"}}}},"Integration":{"type":"object","required":["intendedState"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the integration, used to distinguish this integration from others of the same type.","readOnly":true},"integrationType":{"description":"Type of the integration","readOnly":true,"$ref":"#/definitions/IntegrationType"},"notes":{"type":"string","description":"Notes about the integration.","readOnly":true},"intendedState":{"type":"string","description":"Configured state of the integration.","enum":["ENABLED","DISABLED","DELETED"],"x-genesys-enum-members":[{"name":"ENABLED"},{"name":"DISABLED"},{"name":"DELETED"}]},"config":{"description":"Configuration information for the integration.","readOnly":true,"$ref":"#/definitions/IntegrationConfigurationInfo"},"reportedState":{"description":"Last reported status of the integration.","readOnly":true,"$ref":"#/definitions/IntegrationStatusInfo"},"attributes":{"type":"object","description":"Read-only attributes for the integration.","readOnly":true,"additionalProperties":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Details for an Integration"},"IntegrationConfigurationInfo":{"type":"object","properties":{"current":{"description":"The current, active configuration for the integration.","readOnly":true,"$ref":"#/definitions/IntegrationConfiguration"}},"description":"Configuration information for the integration"},"CreateIntegrationRequest":{"type":"object","required":["integrationType","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the integration, used to distinguish this integration from others of the same type."},"integrationType":{"description":"Type of the integration to create.","$ref":"#/definitions/IntegrationType"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Details for an Integration"},"IntegrationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Integration"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DataTableImportJob"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"pageCount":{"type":"integer","format":"int32"}}},"CreateWebChatConversationResponse":{"type":"object","properties":{"id":{"type":"string","description":"Chat Conversation identifier"},"jwt":{"type":"string","description":"The JWT that you can use to identify subsequent calls on this conversation"},"eventStreamUri":{"type":"string","format":"uri","description":"The URI which provides the conversation event stream."},"member":{"description":"Chat Member","$ref":"#/definitions/WebChatMemberInfo"}}},"CreateWebChatConversationRequest":{"type":"object","required":["deploymentId","memberInfo","organizationId","routingTarget"],"properties":{"organizationId":{"type":"string","description":"The organization identifier."},"deploymentId":{"type":"string","description":"The web chat Deployment ID which contains the appropriate settings for this chat conversation."},"routingTarget":{"description":"The routing information to use for the new chat conversation.","$ref":"#/definitions/WebChatRoutingTarget"},"memberInfo":{"description":"The guest member info to use for the new chat conversation.","$ref":"#/definitions/GuestMemberInfo"},"memberAuthToken":{"type":"string","description":"If the guest member is an authenticated member (ie, not anonymous) his JWT is provided here. The token will have been previously generated with the \"POST /api/v2/signeddata\" resource."},"journeyContext":{"description":"A subset of the Journey System's data relevant to this conversation/session request (for external linkage and internal usage/context).","$ref":"#/definitions/JourneyContext"}}},"GuestMemberInfo":{"type":"object","required":["displayName"],"properties":{"displayName":{"type":"string","description":"The display name to use for the guest member in the conversation."},"firstName":{"type":"string","description":"The first name to use for the guest member in the conversation."},"lastName":{"type":"string","description":"The last name to use for the guest member in the conversation."},"email":{"type":"string","description":"The email address to use for the guest member in the conversation."},"phoneNumber":{"type":"string","description":"The phone number to use for the guest member in the conversation."},"avatarImageUrl":{"type":"string","format":"uri","description":"The URL to the avatar image to use for the guest member in the conversation, if any."},"customFields":{"type":"object","description":"Any custom fields of information, in key-value format, to attach to the guest member in the conversation.","additionalProperties":{"type":"string"}}}},"WebChatRoutingTarget":{"type":"object","required":["targetAddress","targetType"],"properties":{"targetType":{"type":"string","description":"The target type of the routing target, such as 'QUEUE'.","enum":["QUEUE"],"x-genesys-enum-members":[{"name":"QUEUE"}]},"targetAddress":{"type":"string","description":"The target of the route, in the format appropriate given the 'targetType'."},"skills":{"type":"array","description":"The list of skill names to use for routing.","items":{"type":"string"}},"language":{"type":"string","description":"The language name to use for routing."},"priority":{"type":"integer","format":"int64","description":"The priority to assign to the conversation for routing."}}},"SequenceSchedule":{"type":"object","required":["intervals","sequence","timeZone"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"intervals":{"type":"array","description":"A list of intervals during which to run the associated CampaignSequence.","items":{"$ref":"#/definitions/ScheduleInterval"}},"timeZone":{"type":"string","example":"Africa/Abidjan","description":"The time zone for this SequenceSchedule. For example, Africa/Abidjan."},"sequence":{"description":"The CampaignSequence that this SequenceSchedule is for.","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CrossPlatformCallMediaPolicy":{"type":"object","properties":{"actions":{"description":"Actions applied when specified conditions are met","$ref":"#/definitions/CrossPlatformPolicyActions"},"conditions":{"description":"Conditions for when actions should be applied","$ref":"#/definitions/CallMediaPolicyConditions"}}},"CrossPlatformChatMediaPolicy":{"type":"object","properties":{"actions":{"description":"Actions applied when specified conditions are met","$ref":"#/definitions/CrossPlatformPolicyActions"},"conditions":{"description":"Conditions for when actions should be applied","$ref":"#/definitions/ChatMediaPolicyConditions"}}},"CrossPlatformEmailMediaPolicy":{"type":"object","properties":{"actions":{"description":"Actions applied when specified conditions are met","$ref":"#/definitions/CrossPlatformPolicyActions"},"conditions":{"description":"Conditions for when actions should be applied","$ref":"#/definitions/EmailMediaPolicyConditions"}}},"CrossPlatformMediaPolicies":{"type":"object","properties":{"callPolicy":{"description":"Conditions and actions for calls","$ref":"#/definitions/CrossPlatformCallMediaPolicy"},"chatPolicy":{"description":"Conditions and actions for chats","$ref":"#/definitions/CrossPlatformChatMediaPolicy"},"emailPolicy":{"description":"Conditions and actions for emails","$ref":"#/definitions/CrossPlatformEmailMediaPolicy"},"messagePolicy":{"description":"Conditions and actions for messages","$ref":"#/definitions/CrossPlatformMessageMediaPolicy"}}},"CrossPlatformMessageMediaPolicy":{"type":"object","properties":{"actions":{"description":"Actions applied when specified conditions are met","$ref":"#/definitions/CrossPlatformPolicyActions"},"conditions":{"description":"Conditions for when actions should be applied","$ref":"#/definitions/MessageMediaPolicyConditions"}}},"CrossPlatformPolicy":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"order":{"type":"integer","format":"int32"},"description":{"type":"string"},"enabled":{"type":"boolean"},"mediaPolicies":{"description":"Conditions and actions per media type","$ref":"#/definitions/CrossPlatformMediaPolicies"},"conditions":{"description":"Conditions","$ref":"#/definitions/PolicyConditions"},"actions":{"description":"Actions","$ref":"#/definitions/CrossPlatformPolicyActions"},"policyErrors":{"$ref":"#/definitions/PolicyErrors"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CrossPlatformPolicyActions":{"type":"object","properties":{"retainRecording":{"type":"boolean","description":"true to retain the recording associated with the conversation. Default = true"},"deleteRecording":{"type":"boolean","description":"true to delete the recording associated with the conversation. If retainRecording = true, this will be ignored. Default = false"},"alwaysDelete":{"type":"boolean","description":"true to delete the recording associated with the conversation regardless of the values of retainRecording or deleteRecording. Default = false"},"assignEvaluations":{"type":"array","items":{"$ref":"#/definitions/EvaluationAssignment"}},"assignMeteredEvaluations":{"type":"array","items":{"$ref":"#/definitions/MeteredEvaluationAssignment"}},"assignMeteredAssignmentByAgent":{"type":"array","items":{"$ref":"#/definitions/MeteredAssignmentByAgent"}},"assignCalibrations":{"type":"array","items":{"$ref":"#/definitions/CalibrationAssignment"}},"retentionDuration":{"$ref":"#/definitions/RetentionDuration"},"mediaTranscriptions":{"type":"array","items":{"$ref":"#/definitions/MediaTranscription"}},"integrationExport":{"description":"Policy action for exporting recordings using an integration to 3rd party s3.","$ref":"#/definitions/IntegrationExport"}}},"CrossPlatformPolicyCreate":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The policy name."},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"order":{"type":"integer","format":"int32"},"description":{"type":"string"},"enabled":{"type":"boolean"},"mediaPolicies":{"description":"Conditions and actions per media type","$ref":"#/definitions/CrossPlatformMediaPolicies"},"conditions":{"description":"Conditions","$ref":"#/definitions/PolicyConditions"},"actions":{"description":"Actions","$ref":"#/definitions/CrossPlatformPolicyActions"},"policyErrors":{"$ref":"#/definitions/PolicyErrors"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ExportScriptResponse":{"type":"object","properties":{"url":{"type":"string"}}},"ExportScriptRequest":{"type":"object","properties":{"fileName":{"type":"string","description":"The final file name (no extension) of the script download: .script"},"versionId":{"type":"string","description":"The UUID version of the script to be exported. Defaults to the current editable version."}},"description":"Creating an exported script via Download Service"},"Reaction":{"type":"object","required":["reactionType"],"properties":{"data":{"type":"string","description":"Parameter for this reaction. For transfer_flow, this would be the outbound flow id."},"name":{"type":"string","description":"Name of the parameter for this reaction. For transfer_flow, this would be the outbound flow name."},"reactionType":{"type":"string","description":"The reaction to take for a given call analysis result.","enum":["hangup","transfer","transfer_flow","play_file"],"x-genesys-enum-members":[{"name":"hangup"},{"name":"transfer"},{"name":"transfer_flow"},{"name":"play_file"}]}}},"ResponseSet":{"type":"object","required":["name","responses"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the ResponseSet."},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"responses":{"type":"object","description":"Map of disposition identifiers to reactions. For example: {\"disposition.classification.callable.person\": {\"reactionType\": \"transfer\"}}.","additionalProperties":{"$ref":"#/definitions/Reaction"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ReplaceResponse":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"changeNumber":{"type":"integer","format":"int32"},"uploadStatus":{"$ref":"#/definitions/DomainEntityRef"},"uploadDestinationUri":{"type":"string","format":"uri"},"uploadMethod":{"type":"string","enum":["SINGLE_PUT","MULTIPART_POST"],"x-genesys-enum-members":[{"name":"SINGLE_PUT"},{"name":"MULTIPART_POST"}]}}},"ReplaceRequest":{"type":"object","properties":{"changeNumber":{"type":"integer","format":"int32"},"name":{"type":"string"},"authToken":{"type":"string"}}},"SurveyFormEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SurveyForm"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ExtensionPool":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"startNumber":{"type":"string","description":"The starting phone number for the range of this Extension pool. Must be in E.164 format"},"endNumber":{"type":"string","description":"The ending phone number for the range of this Extension pool. Must be in E.164 format"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DomainOrganizationProduct":{"type":"object","properties":{"id":{"type":"string"}}},"OrganizationProductEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DomainOrganizationProduct"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"pageCount":{"type":"integer","format":"int32"}}},"ScimV2SchemaAttribute":{"type":"object","properties":{"name":{"type":"string","description":"The name of the attribute.","readOnly":true},"type":{"type":"string","description":"The data type of the attribute.","readOnly":true,"enum":["STRING","BOOLEAN","DECIMAL","INTEGER","DATE_TIME","REFERENCE","COMPLEX"],"x-genesys-enum-members":[{"name":"STRING"},{"name":"BOOLEAN"},{"name":"DECIMAL"},{"name":"INTEGER"},{"name":"DATE_TIME"},{"name":"REFERENCE"},{"name":"COMPLEX"}]},"subAttributes":{"type":"array","description":"The list of subattributes for an attribute of the type \"complex\". Uses the same schema as \"attributes\".","readOnly":true,"items":{"$ref":"#/definitions/ScimV2SchemaAttribute"}},"multiValued":{"type":"boolean","description":"Indicates whether an attribute contains multiple values.","readOnly":true},"description":{"type":"string","description":"The description of the attribute.","readOnly":true},"required":{"type":"boolean","description":"Indicates whether an attribute is required.","readOnly":true},"canonicalValues":{"type":"array","description":"The list of standard values that service providers may use. Service providers may ignore unsupported values.","readOnly":true,"items":{"type":"string"}},"caseExact":{"type":"boolean","description":"Indicates whether a string attribute is case-sensitive. If set to \"true\", the server preserves case sensitivity. If set to \"false\", the server may change the case. The server also uses case sensitivity when evaluating filters. See section 3.4.2.2 \"Filtering\" in RFC 7644 for details.","readOnly":true},"mutability":{"type":"string","description":"The circumstances under which an attribute can be defined or redefined. The default is \"readWrite\".","readOnly":true,"enum":["readWrite","readOnly","immutable","writeOnly"],"x-genesys-enum-members":[{"name":"readWrite"},{"name":"readOnly"},{"name":"immutable"},{"name":"writeOnly"}]},"returned":{"type":"string","description":"The circumstances under which an attribute and its values are returned in response to a GET, PUT, POST, or PATCH request.","readOnly":true,"enum":["ALWAYS","NEVER","DEFAULT","REQUEST"],"x-genesys-enum-members":[{"name":"ALWAYS"},{"name":"NEVER"},{"name":"DEFAULT"},{"name":"REQUEST"}]},"uniqueness":{"type":"string","description":"The method by which the service provider enforces the uniqueness of an attribute value. A server can reject a value by returning the HTTP response code 400 (Bad Request). A client can enforce uniqueness to a greater degree than the server provider enforces. For example, a client could make a value unique even though the server has \"uniqueness\" set to \"none\".","readOnly":true,"enum":["NONE","SERVER","GLOBAL"],"x-genesys-enum-members":[{"name":"NONE"},{"name":"SERVER"},{"name":"GLOBAL"}]},"referenceTypes":{"type":"array","description":"The list of SCIM resource types that may be referenced. Only applies when \"type\" is set to \"reference\".","readOnly":true,"items":{"type":"string","enum":["USER","GROUP","EXTERNAL","URI"],"x-genesys-enum-members":[{"name":"USER"},{"name":"GROUP"},{"name":"EXTERNAL"},{"name":"URI"}]}}},"description":"A complex type that defines service provider attributes or subattributes and their qualities."},"ScimV2SchemaDefinition":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the SCIM resource. Set by the service provider. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readOnly\". \"returned\" is set to \"always\".","readOnly":true},"name":{"type":"string","description":"The name of the schema.","readOnly":true},"description":{"type":"string","description":"The description of the schema.","readOnly":true},"attributes":{"type":"array","description":"The list of service provider attributes.","readOnly":true,"items":{"$ref":"#/definitions/ScimV2SchemaAttribute"}},"meta":{"description":"The metadata of the SCIM resource. Only \"location\" and \"resourceType\" are set for \"Schema\" resources.","readOnly":true,"$ref":"#/definitions/ScimMetadata"}},"description":"Defines a SCIM schema."},"ScimV2SchemaListResponse":{"type":"object","properties":{"totalResults":{"type":"integer","format":"int64","description":"The total number of results.","readOnly":true},"startIndex":{"type":"integer","format":"int64","description":"The 1-based index of the first result returned by this request. Add this to \"itemsPerPage\" when requesting the next page of results.","readOnly":true},"itemsPerPage":{"type":"integer","format":"int64","description":"The number of resources returned per page.","readOnly":true},"Resources":{"type":"array","description":"The list of requested resources.","readOnly":true,"items":{"$ref":"#/definitions/ScimV2SchemaDefinition"}},"schemas":{"type":"array","description":"The list of supported schemas.","items":{"type":"string"}}},"description":"Defines the list response for SCIM resource types."},"DncList":{"type":"object","required":["dncSourceType","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the DncList."},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"importStatus":{"description":"The status of the import process","readOnly":true,"$ref":"#/definitions/ImportStatus"},"size":{"type":"integer","format":"int64","description":"The total number of phone numbers in the DncList.","readOnly":true},"dncSourceType":{"type":"string","description":"The type of the DncList.","readOnly":true,"enum":["rds","dnc.com","gryphon"],"x-genesys-enum-members":[{"name":"rds"},{"name":"dnc.com"},{"name":"gryphon"}]},"loginId":{"type":"string","description":"A dnc.com loginId. Required if the dncSourceType is dnc.com."},"dncCodes":{"type":"array","description":"The list of dnc.com codes to be treated as DNC. Required if the dncSourceType is dnc.com.","uniqueItems":true,"items":{"type":"string"}},"licenseId":{"type":"string","description":"A gryphon license number. Required if the dncSourceType is gryphon."},"division":{"description":"The division this DncList belongs to.","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DncListCreate":{"type":"object","required":["dncSourceType","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the DncList."},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"importStatus":{"description":"The status of the import process","readOnly":true,"$ref":"#/definitions/ImportStatus"},"size":{"type":"integer","format":"int64","description":"The total number of phone numbers in the DncList.","readOnly":true},"dncSourceType":{"type":"string","description":"The type of the DncList.","enum":["rds","dnc.com","gryphon"],"x-genesys-enum-members":[{"name":"rds"},{"name":"dnc.com"},{"name":"gryphon"}]},"loginId":{"type":"string","description":"A dnc.com loginId. Required if the dncSourceType is dnc.com."},"dncCodes":{"type":"array","description":"The list of dnc.com codes to be treated as DNC. Required if the dncSourceType is dnc.com.","uniqueItems":true,"items":{"type":"string"}},"licenseId":{"type":"string","description":"A gryphon license number. Required if the dncSourceType is gryphon."},"division":{"description":"The division this DncList belongs to.","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DncListEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DncList"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"GroupMembersUpdate":{"type":"object","required":["memberIds","version"],"properties":{"memberIds":{"type":"array","description":"A list of the ids of the members to add.","items":{"type":"string"}},"version":{"type":"integer","format":"int32","description":"The current group version."}}},"UserSkillEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UserRoutingSkill"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"UserRoutingSkillPost":{"type":"object","required":["id","proficiency"],"properties":{"id":{"type":"string","description":"The id of the existing routing skill to add to the user"},"proficiency":{"type":"number","format":"double","description":"Proficiency is a rating from 0.0 to 5.0 on how competent an agent is for a particular skill. It is used when a queue is set to \"Best available skills\" mode to allow acd interactions to target agents with higher proficiency ratings."},"skillUri":{"type":"string","format":"uri","description":"URI to the organization skill used by this user skill.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Represents an organization skill assigned to a user. When assigning to a user specify the organization skill id as the id."},"ClientApp":{"type":"object","required":["intendedState"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the integration, used to distinguish this integration from others of the same type.","readOnly":true},"integrationType":{"description":"Type of the integration","readOnly":true,"$ref":"#/definitions/IntegrationType"},"notes":{"type":"string","description":"Notes about the integration.","readOnly":true},"intendedState":{"type":"string","description":"Configured state of the integration.","enum":["ENABLED","DISABLED","DELETED"],"x-genesys-enum-members":[{"name":"ENABLED"},{"name":"DISABLED"},{"name":"DELETED"}]},"config":{"description":"Configuration information for the integration.","readOnly":true,"$ref":"#/definitions/ClientAppConfigurationInfo"},"reportedState":{"description":"Last reported status of the integration.","readOnly":true,"$ref":"#/definitions/IntegrationStatusInfo"},"attributes":{"type":"object","description":"Read-only attributes for the integration.","readOnly":true,"additionalProperties":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Details for a ClientApp"},"ClientAppConfigurationInfo":{"type":"object","properties":{"current":{"description":"The current, active configuration for the integration.","readOnly":true,"$ref":"#/definitions/IntegrationConfiguration"},"effective":{"description":"The effective configuration for the app, containing the integration specific configuration along with overrides specified in the integration type.","readOnly":true,"$ref":"#/definitions/EffectiveConfiguration"}},"description":"Configuration information for the integration"},"ClientAppEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ClientApp"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Share":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"sharedEntityType":{"type":"string","enum":["DOCUMENT"],"x-genesys-enum-members":[{"name":"DOCUMENT"}]},"sharedEntity":{"$ref":"#/definitions/DomainEntityRef"},"memberType":{"type":"string","enum":["USER","GROUP","PUBLIC"],"x-genesys-enum-members":[{"name":"USER"},{"name":"GROUP"},{"name":"PUBLIC"}]},"member":{"$ref":"#/definitions/DomainEntityRef"},"sharedBy":{"$ref":"#/definitions/DomainEntityRef"},"workspace":{"$ref":"#/definitions/DomainEntityRef"},"user":{"$ref":"#/definitions/User"},"group":{"$ref":"#/definitions/Group"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SharedResponse":{"type":"object","properties":{"id":{"type":"string"},"downloadUri":{"type":"string","format":"uri"},"viewUri":{"type":"string","format":"uri"},"document":{"$ref":"#/definitions/Document"},"share":{"$ref":"#/definitions/Share"}}},"IntegrationTypeEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/IntegrationType"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CoretypeListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Coretype"}},"selfUri":{"type":"string","format":"uri"}}},"LocationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/LocationDefinition"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"LocationUpdateDefinition":{"type":"object","required":["name","version"],"properties":{"name":{"type":"string","description":"The name of the Location. Required for creates, not required for updates"},"version":{"type":"integer","format":"int32","description":"Current version of the location"},"state":{"type":"string","description":"Current activity status of the location.","enum":["active","deleted"]},"path":{"type":"array","description":"A list of ancestor ids","items":{"type":"string"}},"notes":{"type":"string","description":"Notes for the location"},"contactUser":{"type":"string","description":"The user id of the location contact"},"emergencyNumber":{"description":"Emergency number for the location","$ref":"#/definitions/LocationEmergencyNumber"},"address":{"description":"Address of the location","$ref":"#/definitions/LocationAddress"}}},"PatchSegment":{"type":"object","required":["displayName"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"isActive":{"type":"boolean","description":"Whether or not the segment is active."},"displayName":{"type":"string","description":"The display name of the segment."},"version":{"type":"integer","format":"int32","description":"The version of the segment."},"description":{"type":"string","description":"A description of the segment."},"color":{"type":"string","description":"The hexadecimal color value of the segment."},"shouldDisplayToAgent":{"type":"boolean","description":"Whether or not the segment should be displayed to agent/supervisor users."},"context":{"description":"The context of the segment.","$ref":"#/definitions/Context"},"journey":{"description":"The pattern of rules defining the segment.","$ref":"#/definitions/Journey"},"assignmentExpirationDays":{"type":"integer","format":"int32","description":"Time, in days, from when the segment is assigned until it is automatically unassigned."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"createdDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the segment was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the the segment was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"TtsEngineEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/TtsEngineEntity"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CreateBusinessUnitRequest":{"type":"object","required":["divisionId","name","settings"],"properties":{"name":{"type":"string","description":"The name of the business unit"},"divisionId":{"type":"string","description":"The ID of the division to which the business unit should be added"},"settings":{"description":"Configuration for the business unit","$ref":"#/definitions/CreateBusinessUnitSettings"}}},"CreateBusinessUnitSettings":{"type":"object","required":["startDayOfWeek","timeZone"],"properties":{"startDayOfWeek":{"type":"string","description":"The start day of week for this business unit","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"x-genesys-enum-members":[{"name":"Sunday"},{"name":"Monday"},{"name":"Tuesday"},{"name":"Wednesday"},{"name":"Thursday"},{"name":"Friday"},{"name":"Saturday"}]},"timeZone":{"type":"string","description":"The time zone for this business unit, using the Olsen tz database format"},"shortTermForecasting":{"description":"Short term forecasting settings","$ref":"#/definitions/BuShortTermForecastingSettings"}}},"EdgeMetrics":{"type":"object","properties":{"edge":{"$ref":"#/definitions/DomainEntityRef"},"eventTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"upTimeMsec":{"type":"integer","format":"int64"},"processors":{"type":"array","items":{"$ref":"#/definitions/EdgeMetricsProcessor"}},"memory":{"type":"array","items":{"$ref":"#/definitions/EdgeMetricsMemory"}},"disks":{"type":"array","items":{"$ref":"#/definitions/EdgeMetricsDisk"}},"subsystems":{"type":"array","items":{"$ref":"#/definitions/EdgeMetricsSubsystem"}},"networks":{"type":"array","items":{"$ref":"#/definitions/EdgeMetricsNetwork"}}}},"EdgeMetricsDisk":{"type":"object","properties":{"availableBytes":{"type":"number","format":"double","description":"Available memory in bytes."},"partitionName":{"type":"string","description":"Disk partition name."},"totalBytes":{"type":"number","format":"double","description":"Total memory in bytes."}}},"EdgeMetricsMemory":{"type":"object","properties":{"availableBytes":{"type":"number","format":"double","description":"Available memory in bytes."},"type":{"type":"string","description":"Type of memory. Virtual or physical."},"totalBytes":{"type":"number","format":"double","description":"Total memory in bytes."}}},"EdgeMetricsNetwork":{"type":"object","properties":{"ifname":{"type":"string","description":"Identifier for the network adapter."},"sentBytesPerSec":{"type":"integer","format":"int32","description":"Number of byes sent per second."},"receivedBytesPerSec":{"type":"integer","format":"int32","description":"Number of byes received per second."},"bandwidthBitsPerSec":{"type":"number","format":"double","description":"Total bandwidth of the adapter in bits per second."},"utilizationPct":{"type":"number","format":"double","description":"Percent utilization of the network adapter."}}},"EdgeMetricsProcessor":{"type":"object","properties":{"activeTimePct":{"type":"number","format":"double","description":"Percent time processor was active."},"cpuId":{"type":"string","description":"Machine CPU identifier. 'total' will always be included in the array and is the total of all CPU resources."},"idleTimePct":{"type":"number","format":"double","description":"Percent time processor was idle."},"privilegedTimePct":{"type":"number","format":"double","description":"Percent time processor spent in privileged mode."},"userTimePct":{"type":"number","format":"double","description":"Percent time processor spent in user mode."}}},"EdgeMetricsSubsystem":{"type":"object","properties":{"delayMs":{"type":"integer","format":"int32","description":"Delay in milliseconds."},"processName":{"type":"string","description":"Name of the Edge process."},"mediaSubsystem":{"description":"Subsystem for an Edge device.","$ref":"#/definitions/EdgeMetricsSubsystem"}}},"CopyVoicemailMessage":{"type":"object","required":["voicemailMessageId"],"properties":{"voicemailMessageId":{"type":"string","description":"The id of the VoicemailMessage to copy"},"userId":{"type":"string","description":"The id of the User to copy the VoicemailMessage to"},"groupId":{"type":"string","description":"The id of the Group to copy the VoicemailMessage to"}},"description":"Used to copy a VoicemailMessage to either a User or a Group"},"UpdateUser":{"type":"object","required":["version"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"chat":{"$ref":"#/definitions/Chat"},"department":{"type":"string"},"email":{"type":"string"},"primaryContactInfo":{"type":"array","description":"The address(s) used for primary contact. Updates to the corresponding address in the addresses list will be reflected here.","readOnly":true,"items":{"$ref":"#/definitions/Contact"}},"addresses":{"type":"array","description":"Email address, phone number, and/or extension for this user. One entry is allowed per media type","items":{"$ref":"#/definitions/Contact"}},"title":{"type":"string"},"username":{"type":"string"},"manager":{"type":"string"},"images":{"type":"array","items":{"$ref":"#/definitions/UserImage"}},"version":{"type":"integer","format":"int32","description":"This value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH."},"profileSkills":{"type":"array","description":"Profile skills possessed by the user","items":{"type":"string"}},"locations":{"type":"array","description":"The user placement at each site location.","items":{"$ref":"#/definitions/Location"}},"groups":{"type":"array","description":"The groups the user is a member of","items":{"$ref":"#/definitions/Group"}},"state":{"type":"string","description":"The state of the user. This property can be used to restore a deleted user or transition between active and inactive. If specified, it is the only modifiable field.","enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"acdAutoAnswer":{"type":"boolean","description":"The value that denotes if acdAutoAnswer is set on the user"},"certifications":{"type":"array","items":{"type":"string"}},"biography":{"$ref":"#/definitions/Biography"},"employerInfo":{"$ref":"#/definitions/EmployerInfo"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CursorOrganizationListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ExternalOrganization"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"Extension":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"number":{"type":"string"},"owner":{"description":"A Uri reference to the owner of this extension, which is either a User or an IVR","$ref":"#/definitions/DomainEntityRef"},"extensionPool":{"$ref":"#/definitions/DomainEntityRef"},"ownerType":{"type":"string","enum":["USER","PHONE","IVR_CONFIG","GROUP"],"x-genesys-enum-members":[{"name":"USER"},{"name":"PHONE"},{"name":"IVR_CONFIG"},{"name":"GROUP"}]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DialogflowAgentSummary":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"project":{"description":"The project this Dialogflow agent belongs to","$ref":"#/definitions/DialogflowProject"},"description":{"type":"string","description":"A description of the Dialogflow agent"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DialogflowAgentSummaryEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DialogflowAgentSummary"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DomainOrganizationRoleCreate":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The role name"},"description":{"type":"string"},"defaultRoleId":{"type":"string"},"permissions":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"unusedPermissions":{"type":"array","description":"A collection of the permissions the role is not using","readOnly":true,"uniqueItems":true,"items":{"type":"string"}},"permissionPolicies":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/DomainPermissionPolicy"}},"userCount":{"type":"integer","format":"int32"},"roleNeedsUpdate":{"type":"boolean","description":"Optional unless patch operation."},"base":{"type":"boolean"},"default":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkspaceCreate":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The workspace name"},"bucket":{"type":"string"},"description":{"type":"string"}}},"WorkspaceEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Workspace"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"WhatsAppIntegration":{"type":"object","required":["id","name","phoneNumber","version"],"properties":{"id":{"type":"string","description":"A unique Integration Id.","readOnly":true},"name":{"type":"string","description":"The name of the WhatsApp integration."},"phoneNumber":{"type":"string","description":"The phone number associated to the whatsApp integration."},"status":{"type":"string","description":"The status of the WhatsApp Integration","enum":["Active","Inactive","Error","Starting","Incomplete","Deleting","DeletionFailed"],"x-genesys-enum-members":[{"name":"Active"},{"name":"Inactive"},{"name":"Error"},{"name":"Starting"},{"name":"Incomplete"},{"name":"Deleting"},{"name":"DeletionFailed"}]},"recipient":{"description":"The recipient associated to the WhatsApp Integration. This recipient is used to associate a flow to an integration","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"dateCreated":{"type":"string","format":"date-time","description":"Date this Integration was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date this Integration was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"description":"User reference that created this Integration","$ref":"#/definitions/DomainEntityRef"},"modifiedBy":{"description":"User reference that last modified this Integration","$ref":"#/definitions/DomainEntityRef"},"version":{"type":"integer","format":"int32","description":"Version number required for updates."},"activationStatusCode":{"type":"string","description":"The status code of WhatsApp Integration activation process","readOnly":true,"enum":["CodeSent","WaitRequired","ActivationFailed","CodeConfirmed","ConfirmationFailed","ResendCode"],"x-genesys-enum-members":[{"name":"CodeSent"},{"name":"WaitRequired"},{"name":"ActivationFailed"},{"name":"CodeConfirmed"},{"name":"ConfirmationFailed"},{"name":"ResendCode"}]},"activationErrorInfo":{"description":"The error information of WhatsApp Integration activation process","readOnly":true,"$ref":"#/definitions/ErrorBody"},"createStatus":{"type":"string","description":"Status of asynchronous create operation","readOnly":true,"enum":["Initiated","Completed","Error"],"x-genesys-enum-members":[{"name":"Initiated","description":"The integration create request has started"},{"name":"Completed","description":"The integration create request has finished successfully"},{"name":"Error","description":"The integration create request has finished in error."}]},"createError":{"description":"Error information returned, if createStatus is set to Error","readOnly":true,"$ref":"#/definitions/ErrorBody"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WhatsAppIntegrationUpdateRequest":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"WhatsApp Integration name","readOnly":true},"action":{"type":"string","description":"The action used to activate and then confirm a WhatsApp Integration.","enum":["Activate","Confirm"],"x-genesys-enum-members":[{"name":"Activate"},{"name":"Confirm"}]},"authenticationMethod":{"type":"string","description":"The authentication method used to confirm a WhatsApp Integration activation. If action is set to Activate, then authenticationMethod is a required field. ","enum":["Sms","Voice"],"x-genesys-enum-members":[{"name":"Sms"},{"name":"Voice"}]},"confirmationCode":{"type":"string","description":"The confirmation code sent by Whatsapp to you during the activation step. If action is set to Confirm, then confirmationCode is a required field."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SmsAddress":{"type":"object","properties":{"id":{"type":"string","description":"The id of this address.","readOnly":true},"name":{"type":"string"},"street":{"type":"string","description":"The number and street address where this address is located."},"city":{"type":"string","description":"The city in which this address is in"},"region":{"type":"string","description":"The state or region this address is in"},"postalCode":{"type":"string","description":"The postal code this address is in"},"countryCode":{"type":"string","description":"The ISO country code of this address"},"validated":{"type":"boolean","description":"In some countries, addresses are validated to comply with local regulation. In those countries, if the address you provide does not pass validation, it will not be accepted as an Address. This value will be true if the Address has been validated, or false for countries that don't require validation or if the Address is non-compliant.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SmsPhoneNumber":{"type":"object","required":["phoneNumber","version"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"phoneNumber":{"type":"string","description":"A phone number provisioned for SMS communications in E.164 format. E.g. +13175555555 or +34234234234"},"phoneNumberType":{"type":"string","description":"Type of the phone number provisioned.","readOnly":true,"enum":["local","mobile","tollfree","shortcode"],"x-genesys-enum-members":[{"name":"local"},{"name":"mobile"},{"name":"tollfree"},{"name":"shortcode"}]},"provisionedThroughPureCloud":{"type":"boolean","description":"Is set to false, if the phone number is provisioned through a SMS provider, outside of PureCloud"},"phoneNumberStatus":{"type":"string","description":"Status of the provisioned phone number.","enum":["INVALID","ACTIVE","PORTING","PENDING","PENDING_CANCELLATION"],"x-genesys-enum-members":[{"name":"INVALID"},{"name":"ACTIVE"},{"name":"PORTING"},{"name":"PENDING"},{"name":"PENDING_CANCELLATION"}]},"capabilities":{"type":"array","description":"The capabilities of the phone number available for provisioning.","readOnly":true,"items":{"type":"string","enum":["sms","mms","voice"],"x-genesys-enum-members":[{"name":"sms"},{"name":"mms"},{"name":"voice"}]}},"countryCode":{"type":"string","description":"The ISO 3166-1 alpha-2 country code of the country this phone number is associated with."},"dateCreated":{"type":"string","format":"date-time","description":"Date this phone number was provisioned. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date this phone number was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"description":"User that provisioned this phone number","$ref":"#/definitions/User"},"modifiedBy":{"description":"User that last modified this phone number","$ref":"#/definitions/User"},"version":{"type":"integer","format":"int32","description":"Version number required for updates."},"purchaseDate":{"type":"string","format":"date-time","description":"Date this phone number was purchased, if the phoneNumberType is shortcode. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"cancellationDate":{"type":"string","format":"date-time","description":"Contract end date of this phone number, if the phoneNumberType is shortcode. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"renewalDate":{"type":"string","format":"date-time","description":"Contract renewal date of this phone number, if the phoneNumberType is shortcode. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"autoRenewable":{"type":"string","description":"Renewal time period of this phone number, if the phoneNumberType is shortcode.","enum":["Quarterly"],"x-genesys-enum-members":[{"name":"Quarterly"}]},"addressId":{"description":"The id of an address attached to this phone number.","$ref":"#/definitions/SmsAddress"},"shortCodeBillingType":{"type":"string","description":"BillingType of this phone number, if the phoneNumberType is shortcode.","enum":["Basic","Vanity"],"x-genesys-enum-members":[{"name":"Basic"},{"name":"Vanity"}]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SmsPhoneNumberEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SmsPhoneNumber"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"SmsPhoneNumberProvision":{"type":"object","required":["countryCode","phoneNumber","phoneNumberType"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"phoneNumber":{"type":"string","description":"A phone number to be used for SMS communications. E.g. +13175555555 or +34234234234"},"phoneNumberType":{"type":"string","description":"Type of the phone number provisioned.","enum":["local","mobile","tollfree","shortcode"],"x-genesys-enum-members":[{"name":"local"},{"name":"mobile"},{"name":"tollfree"},{"name":"shortcode"}]},"countryCode":{"type":"string","description":"The ISO 3166-1 alpha-2 country code of the country this phone number is associated with."},"addressId":{"type":"string","description":"The id of an address added on your account. Due to regulatory requirements in some countries, an address may be required when provisioning a sms number. In those cases you should provide the provisioned sms address id here"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EventEntity":{"type":"object","properties":{"entityType":{"type":"string","description":"Type of entity the event pertains to. e.g. integration"},"id":{"type":"string","description":"ID of the entity the event pertains to."}}},"IntegrationEvent":{"type":"object","properties":{"id":{"type":"string","description":"Unique ID for this event","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"correlationId":{"type":"string","description":"Correlation ID for the event","readOnly":true},"timestamp":{"type":"string","format":"date-time","description":"Time the event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"level":{"type":"string","description":"Indicates the severity of the event.","readOnly":true,"enum":["INFO","WARN","ERROR","CRITICAL"],"x-genesys-enum-members":[{"name":"INFO"},{"name":"WARN"},{"name":"ERROR"},{"name":"CRITICAL"}]},"eventCode":{"type":"string","description":"A classification for the event. Suitable for programmatic searching, sorting, or filtering","readOnly":true},"message":{"description":"Message indicating what happened","readOnly":true,"$ref":"#/definitions/MessageInfo"},"entities":{"type":"array","description":"Collection of entities affected by or pertaining to the event (e.g. a list of Integrations or Bridge connectors)","readOnly":true,"items":{"$ref":"#/definitions/EventEntity"}},"contextAttributes":{"type":"object","description":"Map of context attributes specific to this event.","readOnly":true,"additionalProperties":{"type":"string"}},"detailMessage":{"description":"Message with additional details about the event. (e.g. an exception cause.)","$ref":"#/definitions/MessageInfo"},"user":{"description":"User that took an action that resulted in the event.","readOnly":true,"$ref":"#/definitions/User"}},"description":"Describes an event that has happened related to an integration"},"CoachingAnnotation":{"type":"object","required":["text"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"createdBy":{"description":"The user who created the annotation.","readOnly":true,"$ref":"#/definitions/UserReference"},"dateCreated":{"type":"string","format":"date-time","description":"The date/time the annotation was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"description":"The last user to modify the annotation.","readOnly":true,"$ref":"#/definitions/UserReference"},"dateModified":{"type":"string","format":"date-time","description":"The date/time the annotation was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"text":{"type":"string","description":"The text of the annotation."},"isDeleted":{"type":"boolean","description":"Flag indicating whether the annotation is deleted.","readOnly":true},"accessType":{"type":"string","description":"Determines the permissions required to view this item.","readOnly":true,"enum":["Public","Private"],"x-genesys-enum-members":[{"name":"Public"},{"name":"Private"}]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CoachingAnnotationCreateRequest":{"type":"object","required":["accessType","text"],"properties":{"text":{"type":"string","description":"The text of the annotation."},"accessType":{"type":"string","description":"Determines the permissions required to view this item.","enum":["Public","Private"],"x-genesys-enum-members":[{"name":"Public"},{"name":"Private"}]}}},"CoachingAnnotationList":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CoachingAnnotation"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"GroupEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Group"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"GroupCreate":{"type":"object","required":["name","rulesVisible","type","visibility"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The group name."},"description":{"type":"string"},"dateModified":{"type":"string","format":"date-time","description":"Last modified date/time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"memberCount":{"type":"integer","format":"int64","description":"Number of members.","readOnly":true},"state":{"type":"string","description":"Active, inactive, or deleted state.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"version":{"type":"integer","format":"int32","description":"Current version for this resource.","readOnly":true},"type":{"type":"string","description":"Type of group.","enum":["official","social"],"x-genesys-enum-members":[{"name":"official"},{"name":"social"}]},"images":{"type":"array","items":{"$ref":"#/definitions/UserImage"}},"addresses":{"type":"array","items":{"$ref":"#/definitions/GroupContact"}},"rulesVisible":{"type":"boolean","description":"Are membership rules visible to the person requesting to view the group"},"visibility":{"type":"string","description":"Who can view this group","enum":["public","owners","members"]},"ownerIds":{"type":"array","description":"Owners of the group","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ResponseEntityList":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Response"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}},"description":"Query result list"},"ResponseQueryResults":{"type":"object","required":["results"],"properties":{"results":{"description":"Contains the query results","$ref":"#/definitions/ResponseEntityList"}},"description":"Used to return response query results"},"ResponseFilter":{"type":"object","required":["name","operator","values"],"properties":{"name":{"type":"string","description":"Field to filter on. Allowed values are 'name' and 'libraryId."},"operator":{"type":"string","description":"Filter operation: IN, EQUALS, NOTEQUALS.","enum":["IN","EQUALS","NOTEQUALS"],"x-genesys-enum-members":[{"name":"IN"},{"name":"EQUALS"},{"name":"NOTEQUALS"}]},"values":{"type":"array","description":"Values to filter on.","items":{"type":"string"}}},"description":"Used to filter response queries"},"ResponseQueryRequest":{"type":"object","properties":{"queryPhrase":{"type":"string","description":"Query phrase to search response text and name. If not set will match all."},"pageSize":{"type":"integer","format":"int32","description":"The maximum number of hits to return. Default: 25, Maximum: 500."},"filters":{"type":"array","description":"Filter the query results.","items":{"$ref":"#/definitions/ResponseFilter"}}},"description":"Used to query for responses"},"NoteListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Note"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ListWrapperInterval":{"type":"object","properties":{"values":{"type":"array","items":{"type":"string","description":"Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"}}}},"PatchShiftTradeRequest":{"type":"object","required":["metadata"],"properties":{"receivingUserId":{"description":"Update the ID of the receiving user to direct the request at a specific user, or set the wrapped id to null to open up a trade to be matched by any user.","$ref":"#/definitions/ValueWrapperString"},"expiration":{"description":"Update the expiration time for this shift trade.","$ref":"#/definitions/ValueWrapperDate"},"acceptableIntervals":{"description":"Update the acceptable intervals the initiating user is willing to accept in trade. Setting the enclosed list to empty will make this a one sided trade request","$ref":"#/definitions/ListWrapperInterval"},"metadata":{"description":"Version metadata","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"ValueWrapperDate":{"type":"object","properties":{"value":{"type":"string","format":"date-time","description":"The value for the associated field. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}},"description":"An object to provide context to nullable fields in PATCH requests"},"ValueWrapperString":{"type":"object","properties":{"value":{"type":"string","description":"The value for the associated field"}},"description":"An object to provide context to nullable fields in PATCH requests"},"AddShiftTradeRequest":{"type":"object","required":["initiatingShiftId","scheduleId"],"properties":{"scheduleId":{"type":"string","description":"The ID of the schedule to which the initiating and receiving shifts belong"},"initiatingShiftId":{"type":"string","description":"The ID of the shift that the initiating user wants to give up"},"receivingUserId":{"type":"string","description":"The ID of the user to whom to send the request (for use in direct trade requests)"},"expiration":{"type":"string","format":"date-time","description":"When this shift trade request should expire. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"acceptableIntervals":{"type":"array","items":{"type":"string","description":"Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"}}}},"MatchShiftTradeResponse":{"type":"object","properties":{"trade":{"description":"The associated shift trade","$ref":"#/definitions/ShiftTradeResponse"},"violations":{"type":"array","description":"Constraint violations which disallow this shift trade","items":{"$ref":"#/definitions/ShiftTradeMatchViolation"}},"adminReviewViolations":{"type":"array","description":"Constraint violations for this shift trade which require shift trade administrator review","items":{"$ref":"#/definitions/ShiftTradeMatchViolation"}}}},"ShiftTradeMatchViolation":{"type":"object","properties":{"type":{"type":"string","description":"The type of constraint violation","enum":["AgentCapabilityMismatch","CannotTradeWithYourself","DirectTradeForOtherUser","InitiatingAgentScheduleDoesNotExist","InitiatingShiftDisallowedActivityCategory","InitiatingShiftDoesNotExist","InitiatingShiftHasExternalActivities","InitiatingShiftOverlapsExisting","InitiatingShiftStartTooClose","InitiatingShiftTimesChanged","InitiatingWeeklyMaxPaidTime","InitiatingWeeklyMinPaidTime","InvalidState","OneSidedTradeCreation","ReceivingAgentScheduleDoesNotExist","ReceivingShiftDisallowedActivityCategory","ReceivingShiftDoesNotExist","ReceivingShiftForOneSidedTrade","ReceivingShiftHasExternalActivities","ReceivingShiftMissingForTwoSidedTrade","ReceivingShiftOutsideAcceptableIntervals","ReceivingShiftOverlapsExisting","ReceivingShiftStartTooClose","ReceivingShiftTimesChanged","ReceivingWeeklyMaxPaidTime","ReceivingWeeklyMinPaidTime","ShiftTradingNotEnabled","UnequalPaidTime","WeekScheduleDifferent","WeekScheduleDoesNotExist","WeekScheduleUnpublished"],"x-genesys-enum-members":[{"name":"AgentCapabilityMismatch"},{"name":"CannotTradeWithYourself"},{"name":"DirectTradeForOtherUser"},{"name":"InitiatingAgentScheduleDoesNotExist"},{"name":"InitiatingShiftDisallowedActivityCategory"},{"name":"InitiatingShiftDoesNotExist"},{"name":"InitiatingShiftHasExternalActivities"},{"name":"InitiatingShiftOverlapsExisting"},{"name":"InitiatingShiftStartTooClose"},{"name":"InitiatingShiftTimesChanged"},{"name":"InitiatingWeeklyMaxPaidTime"},{"name":"InitiatingWeeklyMinPaidTime"},{"name":"InvalidState"},{"name":"OneSidedTradeCreation"},{"name":"ReceivingAgentScheduleDoesNotExist"},{"name":"ReceivingShiftDisallowedActivityCategory"},{"name":"ReceivingShiftDoesNotExist"},{"name":"ReceivingShiftForOneSidedTrade"},{"name":"ReceivingShiftHasExternalActivities"},{"name":"ReceivingShiftMissingForTwoSidedTrade"},{"name":"ReceivingShiftOutsideAcceptableIntervals"},{"name":"ReceivingShiftOverlapsExisting"},{"name":"ReceivingShiftStartTooClose"},{"name":"ReceivingShiftTimesChanged"},{"name":"ReceivingWeeklyMaxPaidTime"},{"name":"ReceivingWeeklyMinPaidTime"},{"name":"ShiftTradingNotEnabled"},{"name":"UnequalPaidTime"},{"name":"WeekScheduleDifferent"},{"name":"WeekScheduleDoesNotExist"},{"name":"WeekScheduleUnpublished"}]},"params":{"type":"object","description":"Clarifying user params for constructing helpful error messages","additionalProperties":{"type":"string"}}}},"MatchShiftTradeRequest":{"type":"object","required":["metadata","receivingScheduleId"],"properties":{"receivingScheduleId":{"type":"string","description":"The ID of the schedule with which the shift trade is associated"},"receivingShiftId":{"type":"string","description":"The ID of the shift the receiving user is giving up in trade, if applicable"},"metadata":{"description":"Version metadata for the shift trade","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"SearchShiftTradeResponse":{"type":"object","properties":{"trade":{"description":"A trade which matches search criteria","$ref":"#/definitions/ShiftTradeResponse"},"matchingReceivingShiftIds":{"type":"array","description":"IDs of shifts which match the search criteria","items":{"type":"string"}},"preview":{"description":"A preview of what the shift trade would look like if matched","$ref":"#/definitions/ShiftTradePreviewResponse"}}},"SearchShiftTradesResponse":{"type":"object","properties":{"trades":{"type":"array","description":"The shift trades that match the search criteria","items":{"$ref":"#/definitions/SearchShiftTradeResponse"}}}},"ShiftTradeActivityPreviewResponse":{"type":"object","properties":{"startDate":{"type":"string","format":"date-time","description":"The start date and time of this activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"lengthMinutes":{"type":"integer","format":"int32","description":"The length in minutes of this activity"},"activityCodeId":{"type":"string","description":"The ID of the activity code for this activity"},"countsAsPaidTime":{"type":"boolean","description":"Whether this activity counts as paid time"}}},"ShiftTradePreviewResponse":{"type":"object","properties":{"activities":{"type":"array","description":"List of activities that will make up the new shift if this shift trade is approved","items":{"$ref":"#/definitions/ShiftTradeActivityPreviewResponse"}}}},"SearchShiftTradesRequest":{"type":"object","required":["receivingScheduleId"],"properties":{"receivingScheduleId":{"type":"string","description":"The ID of the schedule for which to search for available shift trades"},"receivingShiftIds":{"type":"array","description":"The IDs of shifts that the receiving user would potentially be willing to trade. If empty, only returns one sided trades (pick up a shift)","uniqueItems":true,"items":{"type":"string"}}}},"ShiftTradeMatchReviewResponse":{"type":"object","properties":{"initiatingUser":{"description":"Details for the initiatingUser side of the shift trade","$ref":"#/definitions/ShiftTradeMatchReviewUserResponse"},"receivingUser":{"description":"Details for the receivingUser side of the shift trade","$ref":"#/definitions/ShiftTradeMatchReviewUserResponse"},"violations":{"type":"array","description":"Constraint violations introduced after being matched that would normally disallow a trade, but which can still be overridden by the shift trade administrator","items":{"$ref":"#/definitions/ShiftTradeMatchViolation"}},"adminReviewViolations":{"type":"array","description":"Constraint violations associated with this shift trade which require shift trade administrator review","items":{"$ref":"#/definitions/ShiftTradeMatchViolation"}}}},"ShiftTradeMatchReviewUserResponse":{"type":"object","properties":{"weeklyMinimumPaidMinutes":{"type":"integer","format":"int32","description":"The minimum weekly paid minutes for this user per the work plan tied to the agent schedule"},"weeklyMaximumPaidMinutes":{"type":"integer","format":"int32","description":"The maximum weekly paid minutes for this user per the work plan tied to the agent schedule"},"preTradeSchedulePaidMinutes":{"type":"integer","format":"int32","description":"The paid minutes on the week schedule for this user prior to the shift trade"},"postTradeSchedulePaidMinutes":{"type":"integer","format":"int32","description":"The paid minutes on the week schedule for this user if the shift trade is approved"},"postTradeNewShift":{"description":"Preview of what the shift will look like for the opposite side of this trade after the match is approved","$ref":"#/definitions/ShiftTradePreviewResponse"}}},"WeekShiftTradeListResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WeekShiftTradeResponse"}}}},"WeekShiftTradeResponse":{"type":"object","properties":{"trade":{"description":"The shift trade details","$ref":"#/definitions/ShiftTradeResponse"},"matchReview":{"description":"A preview of what the schedule would look like if the shift trade is approved plus any violations","$ref":"#/definitions/ShiftTradeMatchReviewResponse"}}},"BulkUpdateShiftTradeStateResponse":{"type":"object","properties":{"status":{"type":"string","description":"The status of the operation","enum":["Processing","Complete","Canceled","Error"],"x-genesys-enum-members":[{"name":"Processing"},{"name":"Complete"},{"name":"Canceled"},{"name":"Error"}]},"operationId":{"type":"string","description":"The ID for the operation"},"result":{"description":"The result of the operation. Null unless status == Complete","$ref":"#/definitions/BulkUpdateShiftTradeStateResult"}}},"BulkUpdateShiftTradeStateResult":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/BulkUpdateShiftTradeStateResultItem"}}}},"BulkUpdateShiftTradeStateResultItem":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"state":{"type":"string","description":"The state of the shift trade after the update request is processed","enum":["Unmatched","Matched","Approved","Denied","Expired","Canceled"],"x-genesys-enum-members":[{"name":"Unmatched"},{"name":"Matched"},{"name":"Approved"},{"name":"Denied"},{"name":"Expired"},{"name":"Canceled"}]},"reviewedBy":{"description":"The user who reviewed the request, if applicable","$ref":"#/definitions/UserReference"},"reviewedDate":{"type":"string","format":"date-time","description":"The date the request was reviewed, if applicable. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"failureReason":{"type":"string","description":"The reason the update failed, if applicable","enum":["InitiatingAgentScheduleNotFound","InitiatingAgentShiftHasExternalActivities","InitiatingAgentShiftNotFound","ReceivingAgentNotFound","ReceivingAgentScheduleNotFound","ReceivingAgentShiftHasExternalActivities","ReceivingAgentShiftNotFound","ScheduleNotPublished","TransitionNotAllowed"],"x-genesys-enum-members":[{"name":"InitiatingAgentScheduleNotFound"},{"name":"InitiatingAgentShiftHasExternalActivities"},{"name":"InitiatingAgentShiftNotFound"},{"name":"ReceivingAgentNotFound"},{"name":"ReceivingAgentScheduleNotFound"},{"name":"ReceivingAgentShiftHasExternalActivities"},{"name":"ReceivingAgentShiftNotFound"},{"name":"ScheduleNotPublished"},{"name":"TransitionNotAllowed"}]},"metadata":{"description":"Version metadata for the shift trade","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"BulkShiftTradeStateUpdateRequest":{"type":"object","required":["entities"],"properties":{"entities":{"type":"array","description":"The shift trades to update","items":{"$ref":"#/definitions/BulkUpdateShiftTradeStateRequestItem"}}}},"BulkUpdateShiftTradeStateRequestItem":{"type":"object","required":["metadata","state"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"state":{"type":"string","description":"The new state to set on the shift trade","enum":["Unmatched","Matched","Approved","Denied","Expired","Canceled"],"x-genesys-enum-members":[{"name":"Unmatched"},{"name":"Matched"},{"name":"Approved"},{"name":"Denied"},{"name":"Expired"},{"name":"Canceled"}]},"metadata":{"description":"Version metadata for the shift trade","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"CreateQueueRequest":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The queue name"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/WritableDivision"},"description":{"type":"string","description":"The queue description."},"dateCreated":{"type":"string","format":"date-time","description":"The date the queue was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the queue. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the queue."},"createdBy":{"type":"string","description":"The ID of the user that created the queue."},"memberCount":{"type":"integer","format":"int32","description":"The number of users in the queue.","readOnly":true},"mediaSettings":{"type":"object","description":"The media settings for the queue. Valid key values: CALL, CALLBACK, CHAT, EMAIL, MESSAGE, SOCIAL_EXPRESSION, VIDEO_COMM","additionalProperties":{"$ref":"#/definitions/MediaSetting"}},"routingRules":{"type":"array","description":"The routing rules for the queue, used for routing to known or preferred agents.","items":{"$ref":"#/definitions/RoutingRule"}},"bullseye":{"description":"The bulls-eye settings for the queue.","$ref":"#/definitions/Bullseye"},"acwSettings":{"description":"The ACW settings for the queue.","$ref":"#/definitions/AcwSettings"},"skillEvaluationMethod":{"type":"string","description":"The skill evaluation method to use when routing conversations.","enum":["NONE","BEST","ALL"],"x-genesys-enum-members":[{"name":"NONE"},{"name":"BEST"},{"name":"ALL"}]},"queueFlow":{"description":"The in-queue flow to use for conversations waiting in queue.","$ref":"#/definitions/DomainEntityRef"},"whisperPrompt":{"description":"The prompt used for whisper on the queue, if configured.","$ref":"#/definitions/DomainEntityRef"},"autoAnswerOnly":{"type":"boolean","description":"Specifies whether the configured whisper should play for all ACD calls, or only for those which are auto-answered."},"enableTranscription":{"type":"boolean","description":"Indicates whether voice transcription is enabled for this queue."},"enableManualAssignment":{"type":"boolean","description":"Indicates whether manual assignment is enabled for this queue."},"callingPartyName":{"type":"string","description":"The name to use for caller identification for outbound calls from this queue."},"callingPartyNumber":{"type":"string","description":"The phone number to use for caller identification for outbound calls from this queue."},"defaultScripts":{"type":"object","description":"The default script Ids for the communication types.","additionalProperties":{"$ref":"#/definitions/Script"}},"outboundMessagingAddresses":{"description":"The messaging addresses for the queue.","$ref":"#/definitions/QueueMessagingAddresses"},"outboundEmailAddress":{"$ref":"#/definitions/QueueEmailAddress"},"sourceQueueId":{"type":"string","description":"The id of an existing queue to copy the settings from when creating a new queue."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CalibrationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Calibration"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CalibrationCreate":{"type":"object","required":["conversation"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"calibrator":{"$ref":"#/definitions/User"},"agent":{"$ref":"#/definitions/User"},"conversation":{"description":"The conversation to use for the calibration.","$ref":"#/definitions/Conversation"},"evaluationForm":{"$ref":"#/definitions/EvaluationForm"},"contextId":{"type":"string"},"averageScore":{"type":"integer","format":"int32"},"highScore":{"type":"integer","format":"int32"},"lowScore":{"type":"integer","format":"int32"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"evaluations":{"type":"array","items":{"$ref":"#/definitions/Evaluation"}},"evaluators":{"type":"array","items":{"$ref":"#/definitions/User"}},"scoringIndex":{"$ref":"#/definitions/Evaluation"},"expertEvaluator":{"$ref":"#/definitions/User"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CoachingAppointmentReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CreateCoachingAppointmentRequest":{"type":"object","required":["attendeeIds","conversationIds","dateStart","description","documentIds","lengthInMinutes","name"],"properties":{"name":{"type":"string","description":"The name of coaching appointment."},"description":{"type":"string","description":"The description of coaching appointment."},"dateStart":{"type":"string","format":"date-time","description":"The date/time the coaching appointment starts. Times will be rounded down to the minute. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"lengthInMinutes":{"type":"integer","format":"int32","description":"The duration of coaching appointment in minutes."},"facilitatorId":{"type":"string","description":"The facilitator ID of coaching appointment."},"attendeeIds":{"type":"array","description":"IDs of attendees in the coaching appointment.","uniqueItems":true,"items":{"type":"string"}},"conversationIds":{"type":"array","description":"IDs of conversations associated with this coaching appointment.","uniqueItems":true,"items":{"type":"string"}},"documentIds":{"type":"array","description":"IDs of documents associated with this coaching appointment.","uniqueItems":true,"items":{"type":"string"}}},"description":"Create coaching appointment request"},"CoachingAppointmentResponseList":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CoachingAppointmentResponse"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"SubjectDivisions":{"type":"object","required":["divisionIds","subjectIds"],"properties":{"subjectIds":{"type":"array","description":"A collection of subject IDs to associate with the given divisions","items":{"type":"string"}},"divisionIds":{"type":"array","description":"A collection of division IDs to associate with the given subjects","items":{"type":"string"}}}},"DomainOrganizationRoleUpdate":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the role"},"description":{"type":"string"},"defaultRoleId":{"type":"string"},"permissions":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"unusedPermissions":{"type":"array","description":"A collection of the permissions the role is not using","readOnly":true,"uniqueItems":true,"items":{"type":"string"}},"permissionPolicies":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/DomainPermissionPolicy"}},"userCount":{"type":"integer","format":"int32"},"roleNeedsUpdate":{"type":"boolean","description":"Optional unless patch operation."},"base":{"type":"boolean"},"default":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EmergencyCallFlow":{"type":"object","properties":{"emergencyFlow":{"description":"The call flow to execute in an emergency.","$ref":"#/definitions/DomainEntityRef"},"ivrs":{"type":"array","description":"The IVR(s) to route to the call flow during an emergency.","items":{"$ref":"#/definitions/DomainEntityRef"}}},"description":"An emergency flow associates a call flow to use in an emergency with the ivr(s) to route to it."},"EmergencyGroup":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"enabled":{"type":"boolean","description":"True if an emergency is occurring and the associated emergency call flow(s) should be used. False otherwise."},"emergencyCallFlows":{"type":"array","description":"The emergency call flow(s) to use during an emergency.","items":{"$ref":"#/definitions/EmergencyCallFlow"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"A group of emergency call flows to use in an emergency."},"EmergencyGroupListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/EmergencyGroup"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EdgeLogsJob":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"files":{"type":"array","description":"The files available to upload from the Edge to the cloud.","items":{"$ref":"#/definitions/EdgeLogsJobFile"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EdgeLogsJobFile":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"timeCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"timeModified":{"type":"string","format":"date-time","description":"The time this log file was last modified on the Edge. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"sizeBytes":{"type":"number","format":"double","description":"The size of this file in bytes."},"uploadStatus":{"type":"string","description":"The status of the upload of this file from the Edge to the cloud. Use /upload to start an upload.","enum":["UPLOADING","NOT_UPLOADED","UPLOADED","ERROR_ON_UPLOAD"],"x-genesys-enum-members":[{"name":"UPLOADING"},{"name":"NOT_UPLOADED"},{"name":"UPLOADED"},{"name":"ERROR_ON_UPLOAD"}]},"edgePath":{"type":"string","format":"uri","description":"The path of this file on the Edge."},"downloadId":{"type":"string","description":"The download ID to use with the downloads API."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AvailableTranslations":{"type":"object","properties":{"orgSpecific":{"type":"array","items":{"type":"string"}},"builtin":{"type":"array","items":{"type":"string"}}}},"WrapupCodeEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"TrunkMetrics":{"type":"object","properties":{"eventTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"logicalInterface":{"$ref":"#/definitions/DomainEntityRef"},"trunk":{"$ref":"#/definitions/DomainEntityRef"},"calls":{"$ref":"#/definitions/TrunkMetricsCalls"},"qos":{"$ref":"#/definitions/TrunkMetricsQoS"}}},"TrunkMetricsCalls":{"type":"object","properties":{"inboundCallCount":{"type":"integer","format":"int32"},"outboundCallCount":{"type":"integer","format":"int32"}}},"TrunkMetricsQoS":{"type":"object","required":["mismatchCount"],"properties":{"mismatchCount":{"type":"integer","format":"int32","description":"Total number of QoS mismatches over the course of the last 24-hour period (sliding window)."}}},"FacebookAppCredentials":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Genesys Cloud Facebook App Id","readOnly":true}}},"BatchDownloadJobSubmissionResult":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BatchDownloadJobSubmission":{"type":"object","required":["batchDownloadRequestList"],"properties":{"batchDownloadRequestList":{"type":"array","description":"List of up to 100 items requested","items":{"$ref":"#/definitions/BatchDownloadRequest"}}}},"BatchDownloadRequest":{"type":"object","properties":{"conversationId":{"type":"string","description":"Conversation id requested"},"recordingId":{"type":"string","description":"Recording id requested, optional. Leave null for all recordings on the conversation"}}},"BatchDownloadJobResult":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"conversationId":{"type":"string","description":"Conversation id of the result"},"recordingId":{"type":"string","description":"Recording id of the result"},"resultUrl":{"type":"string","description":"URL of results... HTTP GET from this location to download results for this item"},"contentType":{"type":"string","description":"Content type of this result"},"errorMsg":{"type":"string","description":"An error message, in case of failed processing will indicate the cause of the failure"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BatchDownloadJobStatusResult":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"jobId":{"type":"string","description":"JobId returned when job was initially submitted"},"expectedResultCount":{"type":"integer","format":"int32","description":"Number of results expected when job is completed"},"resultCount":{"type":"integer","format":"int32","description":"Current number of results available"},"errorCount":{"type":"integer","format":"int32","description":"Number of error results produced so far"},"results":{"type":"array","description":"Current set of results for the job","items":{"$ref":"#/definitions/BatchDownloadJobResult"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"QualityAudit":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"user":{"$ref":"#/definitions/User"},"jobId":{"type":"string"},"level":{"type":"string"},"entity":{"$ref":"#/definitions/AuditEntity"},"timestamp":{"type":"string"},"action":{"type":"string"},"status":{"type":"string"},"changes":{"type":"array","items":{"$ref":"#/definitions/Change"}},"entityType":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"QualityAuditPage":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/QualityAudit"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FlowExecutionLaunchResponse":{"type":"object","properties":{"id":{"type":"string","description":"The flow execution ID"},"name":{"type":"string","description":"The flow execution name."},"flowVersion":{"description":"The version of the flow that launched","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Response object from launching a flow."},"FlowExecutionLaunchRequest":{"type":"object","required":["flowId"],"properties":{"flowId":{"type":"string","description":"ID of the flow to launch."},"flowVersion":{"type":"string","description":"The version of the flow to launch. Omit this value (or supply null/empty) to use the latest published version."},"inputData":{"type":"object","description":"Input values to the flow. Valid values are defined by a flow's input JSON schema.","additionalProperties":{"type":"object"}},"name":{"type":"string","description":"A displayable name to assign to the new flow execution"}},"description":"Parameters for launching a flow."},"CoachingAppointmentAggregateResponse":{"type":"object","properties":{"results":{"type":"array","description":"The results of the query","items":{"$ref":"#/definitions/QueryResponseGroupedData"}}}},"QueryResponseData":{"type":"object","properties":{"interval":{"type":"string","description":"Interval with start and end represented as ISO-8601 string. i.e: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'/yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"},"metrics":{"type":"array","description":"A list of aggregated metrics","items":{"$ref":"#/definitions/QueryResponseMetric"}}}},"QueryResponseGroupedData":{"type":"object","properties":{"group":{"type":"object","description":"The group values for this data","additionalProperties":{"type":"string"}},"data":{"type":"array","description":"The metrics in this group","items":{"$ref":"#/definitions/QueryResponseData"}}}},"QueryResponseMetric":{"type":"object","properties":{"metric":{"type":"string","description":"The metric this applies to","enum":["nActivities","nPlannedActivities","nInProgressActivities","nCompleteActivities","nOverdueActivities","nInvalidScheduleActivities"],"x-genesys-enum-members":[{"name":"nActivities"},{"name":"nPlannedActivities"},{"name":"nInProgressActivities"},{"name":"nCompleteActivities"},{"name":"nOverdueActivities"},{"name":"nInvalidScheduleActivities"}]},"stats":{"description":"The aggregated values for this metric","$ref":"#/definitions/QueryResponseStats"}}},"QueryResponseStats":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"The count for this metric"}}},"CoachingAppointmentAggregateRequest":{"type":"object","required":["filter","interval"],"properties":{"interval":{"type":"string","description":"Interval to aggregate across. 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"},"metrics":{"type":"array","description":"A list of metrics to aggregate. If omitted, all metrics are returned.","items":{"type":"string","enum":["nActivities","nPlannedActivities","nInProgressActivities","nCompleteActivities","nOverdueActivities","nInvalidScheduleActivities"],"x-genesys-enum-members":[{"name":"nActivities"},{"name":"nPlannedActivities"},{"name":"nInProgressActivities"},{"name":"nCompleteActivities"},{"name":"nOverdueActivities"},{"name":"nInvalidScheduleActivities"}]}},"groupBy":{"type":"array","description":"An optional list of items by which to group the result data.","items":{"type":"string","enum":["attendeeId"],"x-genesys-enum-members":[{"name":"attendeeId"}]}},"filter":{"description":"The filter applied to the data","$ref":"#/definitions/QueryRequestFilter"}}},"QueryRequestClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"The logic used to combine the predicates","enum":["And","Or"],"x-genesys-enum-members":[{"name":"And"},{"name":"Or"}]},"predicates":{"type":"array","description":"The list of predicates used to filter the data","items":{"$ref":"#/definitions/QueryRequestPredicate"}}}},"QueryRequestFilter":{"type":"object","required":["clauses","type"],"properties":{"type":{"type":"string","description":"The logic used to combine the clauses","enum":["And","Or"],"x-genesys-enum-members":[{"name":"And"},{"name":"Or"}]},"clauses":{"type":"array","description":"The list of clauses used to filter the data","items":{"$ref":"#/definitions/QueryRequestClause"}}}},"QueryRequestPredicate":{"type":"object","required":["dimension","value"],"properties":{"dimension":{"type":"string","description":"The dimension to be filtered","enum":["attendeeId","facilitatorId","status"],"x-genesys-enum-members":[{"name":"attendeeId"},{"name":"facilitatorId"},{"name":"status"}]},"value":{"type":"string","description":"The value to filter by"}}},"QueueRequest":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The queue name"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/WritableDivision"},"description":{"type":"string","description":"The queue description."},"dateCreated":{"type":"string","format":"date-time","description":"The date the queue was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the queue. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the queue."},"createdBy":{"type":"string","description":"The ID of the user that created the queue."},"memberCount":{"type":"integer","format":"int32","description":"The number of users in the queue.","readOnly":true},"mediaSettings":{"type":"object","description":"The media settings for the queue. Valid key values: CALL, CALLBACK, CHAT, EMAIL, MESSAGE, SOCIAL_EXPRESSION, VIDEO_COMM","additionalProperties":{"$ref":"#/definitions/MediaSetting"}},"routingRules":{"type":"array","description":"The routing rules for the queue, used for routing to known or preferred agents.","items":{"$ref":"#/definitions/RoutingRule"}},"bullseye":{"description":"The bulls-eye settings for the queue.","$ref":"#/definitions/Bullseye"},"acwSettings":{"description":"The ACW settings for the queue.","$ref":"#/definitions/AcwSettings"},"skillEvaluationMethod":{"type":"string","description":"The skill evaluation method to use when routing conversations.","enum":["NONE","BEST","ALL"],"x-genesys-enum-members":[{"name":"NONE"},{"name":"BEST"},{"name":"ALL"}]},"queueFlow":{"description":"The in-queue flow to use for conversations waiting in queue.","$ref":"#/definitions/DomainEntityRef"},"whisperPrompt":{"description":"The prompt used for whisper on the queue, if configured.","$ref":"#/definitions/DomainEntityRef"},"autoAnswerOnly":{"type":"boolean","description":"Specifies whether the configured whisper should play for all ACD calls, or only for those which are auto-answered."},"enableTranscription":{"type":"boolean","description":"Indicates whether voice transcription is enabled for this queue."},"enableManualAssignment":{"type":"boolean","description":"Indicates whether manual assignment is enabled for this queue."},"callingPartyName":{"type":"string","description":"The name to use for caller identification for outbound calls from this queue."},"callingPartyNumber":{"type":"string","description":"The phone number to use for caller identification for outbound calls from this queue."},"defaultScripts":{"type":"object","description":"The default script Ids for the communication types.","additionalProperties":{"$ref":"#/definitions/Script"}},"outboundMessagingAddresses":{"description":"The messaging addresses for the queue.","$ref":"#/definitions/QueueMessagingAddresses"},"outboundEmailAddress":{"$ref":"#/definitions/QueueEmailAddress"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"VoicemailMailboxInfo":{"type":"object","properties":{"usageSizeBytes":{"type":"integer","format":"int64","description":"The total number of bytes for all voicemail message audio recordings","readOnly":true},"totalCount":{"type":"integer","format":"int32","description":"The total number of voicemail messages","readOnly":true},"unreadCount":{"type":"integer","format":"int32","description":"The total number of voicemail messages marked as unread","readOnly":true},"deletedCount":{"type":"integer","format":"int32","description":"The total number of voicemail messages marked as deleted","readOnly":true},"createdDate":{"type":"string","format":"date-time","description":"The date of the oldest voicemail message. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedDate":{"type":"string","format":"date-time","description":"The date of the most recent voicemail message. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true}}},"Channel":{"type":"object","properties":{"connectUri":{"type":"string","format":"uri"},"id":{"type":"string"},"expires":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"ChannelEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Channel"}}}},"DocumentEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Document"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ScimServiceProviderConfig":{"type":"object","properties":{"schemas":{"type":"array","description":"The list of supported schemas.","readOnly":true,"items":{"type":"string"}},"documentationUri":{"type":"string","format":"uri","description":"The HTTP-addressable URL that points to the service provider's documentation.","readOnly":true},"patch":{"description":"The \"patch\" configuration options.","readOnly":true,"$ref":"#/definitions/ScimServiceProviderConfigSimpleFeature"},"filter":{"description":"The \"filter\" configuration options.","readOnly":true,"$ref":"#/definitions/ScimServiceProviderConfigFilterFeature"},"etag":{"description":"The \"etag\" configuration options.","readOnly":true,"$ref":"#/definitions/ScimServiceProviderConfigSimpleFeature"},"sort":{"description":"The \"sort\" configuration options.","readOnly":true,"$ref":"#/definitions/ScimServiceProviderConfigSimpleFeature"},"bulk":{"description":"The \"bulk\" configuration options.","readOnly":true,"$ref":"#/definitions/ScimServiceProviderConfigBulkFeature"},"changePassword":{"description":"The \"changePassword\" configuration options.","readOnly":true,"$ref":"#/definitions/ScimServiceProviderConfigSimpleFeature"},"authenticationSchemes":{"type":"array","description":"The list of supported authentication schemes.","readOnly":true,"items":{"$ref":"#/definitions/ScimServiceProviderConfigAuthenticationScheme"}},"meta":{"description":"The metadata of the SCIM resource.","readOnly":true,"$ref":"#/definitions/ScimMetadata"}},"description":"Defines a SCIM service provider's configuration."},"ScimServiceProviderConfigAuthenticationScheme":{"type":"object","required":["description","name","type"],"properties":{"name":{"type":"string","description":"The name of the authentication scheme, for example, HTTP Basic.","readOnly":true},"description":{"type":"string","description":"The description of the authentication scheme.","readOnly":true},"specUri":{"type":"string","format":"uri","description":"The HTTP-addressable URL that points to the authentication scheme's specification.","readOnly":true},"documentationUri":{"type":"string","format":"uri","description":"The HTTP-addressable URL that points to the authentication scheme's usage documentation.","readOnly":true},"type":{"type":"string","description":"The type of authentication scheme.","readOnly":true,"enum":["oauth","oauth2","oauthbearertoken","httpbasic","httpdigest"],"x-genesys-enum-members":[{"name":"oauth"},{"name":"oauth2"},{"name":"oauthbearertoken"},{"name":"httpbasic"},{"name":"httpdigest"}]},"primary":{"type":"boolean","description":"Indicates whether this authentication scheme is the primary method of authentication.","readOnly":true}},"description":"Defines an authentication scheme in the SCIM service provider's configuration."},"ScimServiceProviderConfigBulkFeature":{"type":"object","properties":{"supported":{"type":"boolean","description":"Indicates whether configuration options are supported.","readOnly":true},"maxOperations":{"type":"integer","format":"int32","description":"The maximum number of operations for each bulk request.","readOnly":true},"maxPayloadSize":{"type":"integer","format":"int32","description":"The maximum payload size.","readOnly":true}},"description":"Defines a \"bulk\" request in the SCIM service provider's configuration."},"ScimServiceProviderConfigFilterFeature":{"type":"object","properties":{"supported":{"type":"boolean","description":"Indicates whether configuration options are supported.","readOnly":true},"maxResults":{"type":"integer","format":"int32","description":"The maximum number of results returned from a filtered query.","readOnly":true}},"description":"Defines a \"filter\" request in the SCIM service provider's configuration."},"ScimServiceProviderConfigSimpleFeature":{"type":"object","properties":{"supported":{"type":"boolean","description":"Indicates whether configuration options are supported.","readOnly":true}},"description":"Defines a request in the SCIM service provider's configuration."},"ExternalOrganizationTrustorLink":{"type":"object","properties":{"externalOrganizationId":{"type":"string","description":"The id of a PureCloud External Organization entity in the External Contacts system that will be used to represent the trustor org"},"trustorOrgId":{"type":"string","description":"The id of a PureCloud organization that has granted trust to this PureCloud organization"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"externalOrganizationUri":{"type":"string","format":"uri","description":"The URI for the External Organization that is linked to the trustor org","readOnly":true}}},"TtsVoiceEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/TtsVoiceEntity"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"RegionTimeZone":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"offset":{"type":"integer","format":"int64"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TimeZoneEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/RegionTimeZone"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"SubjectDivisionGrants":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"divisions":{"type":"array","items":{"$ref":"#/definitions/Division"}},"type":{"type":"string","enum":["PC_USER","PC_GROUP","PC_OAUTH_CLIENT","PC_TRUSTEE_USER","PC_TRUSTEE_GROUP","UNKNOWN"],"x-genesys-enum-members":[{"name":"PC_USER"},{"name":"PC_GROUP"},{"name":"PC_OAUTH_CLIENT"},{"name":"PC_TRUSTEE_USER"},{"name":"PC_TRUSTEE_GROUP"},{"name":"UNKNOWN"}]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SubjectDivisionGrantsEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SubjectDivisionGrants"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AddConversationResponse":{"type":"object","properties":{"conversation":{"description":"The conversation reference","readOnly":true,"$ref":"#/definitions/ConversationReference"},"appointment":{"description":"The appointment reference","readOnly":true,"$ref":"#/definitions/CoachingAppointmentReference"}}},"AddConversationRequest":{"type":"object","required":["conversationId"],"properties":{"conversationId":{"type":"string","description":"The id of the conversation to add"}},"description":"Update coaching appointment request"},"UpdateCoachingAppointmentRequest":{"type":"object","properties":{"name":{"type":"string","description":"The name of coaching appointment."},"description":{"type":"string","description":"The description of coaching appointment."},"dateStart":{"type":"string","format":"date-time","description":"The date/time the coaching appointment starts. Times will be rounded down to the minute. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"lengthInMinutes":{"type":"integer","format":"int32","description":"The duration of coaching appointment in minutes."},"conversationIds":{"type":"array","description":"IDs of conversations associated with this coaching appointment.","uniqueItems":true,"items":{"type":"string"}},"documentIds":{"type":"array","description":"IDs of documents associated with this coaching appointment.","uniqueItems":true,"items":{"type":"string"}},"status":{"type":"string","description":"The status of the coaching appointment.","enum":["Scheduled","InProgress","Completed"],"x-genesys-enum-members":[{"name":"Scheduled"},{"name":"InProgress"},{"name":"Completed"}]}},"description":"Update coaching appointment request"},"Station":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"status":{"type":"string","enum":["AVAILABLE","ASSOCIATED"],"x-genesys-enum-members":[{"name":"AVAILABLE"},{"name":"ASSOCIATED"}]},"userId":{"type":"string","description":"The Id of the user currently logged in and associated with the station."},"webRtcUserId":{"type":"string","description":"The Id of the user configured for the station if it is of type inin_webrtc_softphone. Empty if station type is not inin_webrtc_softphone."},"primaryEdge":{"$ref":"#/definitions/DomainEntityRef"},"secondaryEdge":{"$ref":"#/definitions/DomainEntityRef"},"type":{"type":"string"},"lineAppearanceId":{"type":"string"},"webRtcMediaDscp":{"type":"integer","format":"int32","description":"The default or configured value of media dscp for the station. Empty if station type is not inin_webrtc_softphone.","readOnly":true},"webRtcPersistentEnabled":{"type":"boolean","description":"The default or configured value of persistent connection setting for the station. Empty if station type is not inin_webrtc_softphone.","readOnly":true},"webRtcForceTurn":{"type":"boolean","description":"Whether the station is configured to require TURN for routing WebRTC calls. Empty if station type is not inin_webrtc_softphone.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ExtensionEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Extension"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CobrowseConversation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"participants":{"type":"array","description":"The list of participants involved in the conversation.","items":{"$ref":"#/definitions/CobrowseMediaParticipant"}},"otherMediaUris":{"type":"array","description":"The list of other media channels involved in the conversation.","items":{"type":"string","format":"uri"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CobrowseConversationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CobrowseConversation"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CobrowseMediaParticipant":{"type":"object","properties":{"id":{"type":"string","description":"The unique participant ID."},"name":{"type":"string","description":"The display friendly name of the participant."},"address":{"type":"string","description":"The participant address."},"startTime":{"type":"string","format":"date-time","description":"The time when this participant first joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The time when this participant went connected for this media (eg: video connected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startHoldTime":{"type":"string","format":"date-time","description":"The time when this participant's hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"purpose":{"type":"string","description":"The participant's purpose. Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr"},"state":{"type":"string","description":"The participant's state. Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","converting","uploading","transmitting","none"],"x-genesys-enum-members":[{"name":"alerting"},{"name":"dialing"},{"name":"contacting"},{"name":"offering"},{"name":"connected"},{"name":"disconnected"},{"name":"terminated"},{"name":"converting"},{"name":"uploading"},{"name":"transmitting"},{"name":"none"}]},"direction":{"type":"string","description":"The participant's direction. Values can be: 'inbound' or 'outbound'","enum":["inbound","outbound"],"x-genesys-enum-members":[{"name":"inbound"},{"name":"outbound"}]},"disconnectType":{"type":"string","description":"The reason the participant was disconnected from the conversation.","enum":["endpoint","client","system","transfer","transfer.conference","transfer.consult","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam"],"x-genesys-enum-members":[{"name":"endpoint"},{"name":"client"},{"name":"system"},{"name":"transfer"},{"name":"transfer.conference"},{"name":"transfer.consult"},{"name":"transfer.forward"},{"name":"transfer.noanswer"},{"name":"transfer.notavailable"},{"name":"transport.failure"},{"name":"error"},{"name":"peer"},{"name":"other"},{"name":"spam"}]},"held":{"type":"boolean","description":"Value is true when the participant is on hold."},"wrapupRequired":{"type":"boolean","description":"Value is true when the participant requires wrap-up."},"wrapupPrompt":{"type":"string","description":"The wrap-up prompt indicating the type of wrap-up to be performed."},"user":{"description":"The PureCloud user for this participant.","$ref":"#/definitions/DomainEntityRef"},"queue":{"description":"The PureCloud queue for this participant.","$ref":"#/definitions/DomainEntityRef"},"team":{"description":"The PureCloud team for this participant.","$ref":"#/definitions/DomainEntityRef"},"attributes":{"type":"object","description":"A list of ad-hoc attributes for the participant.","additionalProperties":{"type":"string"}},"errorInfo":{"description":"If the conversation ends in error, contains additional error details.","$ref":"#/definitions/ErrorInfo"},"script":{"description":"The Engage script that should be used by this participant.","$ref":"#/definitions/DomainEntityRef"},"wrapupTimeoutMs":{"type":"integer","format":"int32","description":"The amount of time the participant has to complete wrap-up."},"wrapupSkipped":{"type":"boolean","description":"Value is true when the participant has skipped wrap-up."},"alertingTimeoutMs":{"type":"integer","format":"int32","description":"Specifies how long the agent has to answer an interaction before being marked as not responding."},"provider":{"type":"string","description":"The source provider for the communication."},"externalContact":{"description":"If this participant represents an external contact, then this will be the reference for the external contact.","$ref":"#/definitions/DomainEntityRef"},"externalOrganization":{"description":"If this participant represents an external org, then this will be the reference for the external org.","$ref":"#/definitions/DomainEntityRef"},"wrapup":{"description":"Wrapup for this participant, if it has been applied.","$ref":"#/definitions/Wrapup"},"peer":{"type":"string","description":"The peer communication corresponding to a matching leg for this communication."},"flaggedReason":{"type":"string","description":"The reason specifying why participant flagged the conversation.","enum":["general"],"x-genesys-enum-members":[{"name":"general"}]},"journeyContext":{"description":"Journey System data/context that is applicable to this communication. When used for historical purposes, the context should be immutable. When null, there is no applicable Journey System context.","$ref":"#/definitions/JourneyContext"},"conversationRoutingData":{"description":"Information on how a communication should be routed to an agent.","$ref":"#/definitions/ConversationRoutingData"},"startAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"cobrowseSessionId":{"type":"string","description":"The co-browse session ID."},"cobrowseRole":{"type":"string","description":"This value identifies the role of the co-browse client within the co-browse session (a client is a sharer or a viewer)."},"controlling":{"type":"array","description":"ID of co-browse participants for which this client has been granted control (list is empty if this client cannot control any shared pages).","items":{"type":"string"}},"viewerUrl":{"type":"string","description":"The URL that can be used to open co-browse session in web browser."},"providerEventTime":{"type":"string","format":"date-time","description":"The time when the provider event which triggered this conversation update happened in the corrected provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"IpAddressRange":{"type":"object","properties":{"cidr":{"type":"string"},"service":{"type":"string","enum":["data-actions","smtp"],"x-genesys-enum-members":[{"name":"data-actions"},{"name":"smtp"}]},"region":{"type":"string"}}},"IpAddressRangeListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/IpAddressRange"}}}},"EdgeLine":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"schema":{"$ref":"#/definitions/DomainEntityRef"},"properties":{"type":"object","additionalProperties":{"type":"object"}},"edge":{"$ref":"#/definitions/Edge"},"edgeGroup":{"$ref":"#/definitions/EdgeGroup"},"lineType":{"type":"string","enum":["TIE","NETWORK","TRUNK","STATION"],"x-genesys-enum-members":[{"name":"TIE"},{"name":"NETWORK"},{"name":"TRUNK"},{"name":"STATION"}]},"endpoint":{"$ref":"#/definitions/Endpoint"},"ipAddress":{"type":"string"},"logicalInterfaceId":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SegmentListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/JourneySegment"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"UserExpands":{"type":"object","properties":{"routingStatus":{"description":"ACD routing status","readOnly":true,"$ref":"#/definitions/RoutingStatus"},"presence":{"description":"Active presence","readOnly":true,"$ref":"#/definitions/UserPresence"},"conversationSummary":{"description":"Summary of conversion statistics for conversation types.","readOnly":true,"$ref":"#/definitions/UserConversationSummary"},"outOfOffice":{"description":"Determine if out of office is enabled","readOnly":true,"$ref":"#/definitions/OutOfOffice"},"geolocation":{"description":"Current geolocation position","readOnly":true,"$ref":"#/definitions/Geolocation"},"station":{"description":"Effective, default, and last station information","readOnly":true,"$ref":"#/definitions/UserStations"},"authorization":{"description":"Roles and permissions assigned to the user","readOnly":true,"$ref":"#/definitions/UserAuthorization"}}},"UserProfile":{"type":"object","required":["version"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"state":{"type":"string","description":"The state of the user resource","enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"dateModified":{"type":"string","format":"date-time","description":"Datetime of the last modification. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int64","description":"The version of the group resource"},"expands":{"description":"User information expansions","readOnly":true,"$ref":"#/definitions/UserExpands"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ConversationDeletionProtectionQuery":{"type":"object","required":["conversationIds"],"properties":{"conversationIds":{"type":"array","description":"This is a list of ConversationIds. The list cannot exceed 100 conversationids.","items":{"type":"string"}}}},"ApiUsageQuery":{"type":"object","required":["interval"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Date granularity of the results","enum":["Day","Week","Month"],"x-genesys-enum-members":[{"name":"Day"},{"name":"Week"},{"name":"Month"}]},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["OAuthClientId","OrganizationId","UserId","TemplateUri","HttpMethod"],"x-genesys-enum-members":[{"name":"OAuthClientId"},{"name":"OrganizationId"},{"name":"UserId"},{"name":"TemplateUri"},{"name":"HttpMethod"}]}},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Enables retrieving only named metrics. If omitted, all metrics that are available will be returned (like SELECT *).","items":{"type":"string","enum":["Status200","Status300","Status400","Status500","Status429","Requests"],"x-genesys-enum-members":[{"name":"Status200"},{"name":"Status300"},{"name":"Status400"},{"name":"Status500"},{"name":"Status429"},{"name":"Requests"}]}}}},"AuthzDivisionGrantEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AuthzGrant"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"pageCount":{"type":"integer","format":"int32"}}},"SystemPrompt":{"type":"object","properties":{"id":{"type":"string","description":"The system prompt identifier"},"name":{"type":"string"},"description":{"type":"string"},"resources":{"type":"array","items":{"$ref":"#/definitions/SystemPromptAsset"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SystemPromptAsset":{"type":"object","required":["language"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"promptId":{"type":"string"},"language":{"type":"string","description":"The asset resource language"},"durationSeconds":{"type":"number","format":"double"},"mediaUri":{"type":"string"},"ttsString":{"type":"string"},"text":{"type":"string"},"uploadUri":{"type":"string"},"uploadStatus":{"type":"string","enum":["created","uploaded","transcoded","transcodeFailed"],"x-genesys-enum-members":[{"name":"created"},{"name":"uploaded"},{"name":"transcoded"},{"name":"transcodeFailed"}]},"hasDefault":{"type":"boolean"},"languageDefault":{"type":"boolean"},"tags":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SystemPromptEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SystemPrompt"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"OutboundRouteEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/OutboundRoute"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ScreenRecordingSession":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"user":{"$ref":"#/definitions/User"},"communicationId":{"type":"string","description":"The id of the communication that is being recorded on the conversation"},"conversation":{"$ref":"#/definitions/Conversation"},"startTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ScreenRecordingSessionListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ScreenRecordingSession"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ScreenRecordingSessionRequest":{"type":"object","properties":{"state":{"type":"string","description":"The screen recording session's state. Values can be: 'stopped'","enum":["STOPPED"],"x-genesys-enum-members":[{"name":"STOPPED"}]},"archiveDate":{"type":"string","format":"date-time","description":"The screen recording session's archive date. Must be greater than 1 day from now if set. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"deleteDate":{"type":"string","format":"date-time","description":"The screen recording session's delete date. Must be greater than archiveDate if set, otherwise one day from now. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"FacebookIntegrationUpdateRequest":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the Facebook Integration"},"pageAccessToken":{"type":"string","description":"The long-lived Page Access Token of a facebook page. \nSee https://developers.facebook.com/docs/facebook-login/access-tokens. \nEither pageAccessToken or userAccessToken should be provided."},"userAccessToken":{"type":"string","description":"The short-lived User Access Token of the facebook user logged into the facebook app. \nSee https://developers.facebook.com/docs/facebook-login/access-tokens. \nEither pageAccessToken or userAccessToken should be provided."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SurveyAggregateDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/StatisticalResponse"}}}},"SurveyAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/SurveyAggregateDataContainer"}}}},"SurveyAggregateQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/SurveyAggregateQueryPredicate"}}}},"SurveyAggregateQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/SurveyAggregateQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/SurveyAggregateQueryPredicate"}}}},"SurveyAggregateQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"],"x-genesys-enum-members":[{"name":"dimension"},{"name":"property"},{"name":"metric"}]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["conversationId","divisionId","externalContactId","mediaType","queueId","requestedLanguageId","requestedRoutingSkillId","surveyAnswerId","surveyCreatedDate","surveyErrorReason","surveyFormContextId","surveyFormId","surveyFormName","surveyId","surveyPreviousStatus","surveyPromoterScore","surveyQuestionGroupId","surveyQuestionId","surveyStatus","teamId","userId","wrapUpCode"],"x-genesys-enum-members":[{"name":"conversationId"},{"name":"divisionId"},{"name":"externalContactId"},{"name":"mediaType"},{"name":"queueId"},{"name":"requestedLanguageId"},{"name":"requestedRoutingSkillId"},{"name":"surveyAnswerId"},{"name":"surveyCreatedDate"},{"name":"surveyErrorReason"},{"name":"surveyFormContextId"},{"name":"surveyFormId"},{"name":"surveyFormName"},{"name":"surveyId"},{"name":"surveyPreviousStatus"},{"name":"surveyPromoterScore"},{"name":"surveyQuestionGroupId"},{"name":"surveyQuestionId"},{"name":"surveyStatus"},{"name":"teamId"},{"name":"userId"},{"name":"wrapUpCode"}]},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"],"x-genesys-enum-members":[{"name":"matches"},{"name":"exists"},{"name":"notExists"}]},"value":{"type":"string","description":"Right hand side for dimension predicates"},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"SurveyAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["conversationId","divisionId","externalContactId","mediaType","queueId","requestedLanguageId","requestedRoutingSkillId","surveyAnswerId","surveyCreatedDate","surveyErrorReason","surveyFormContextId","surveyFormId","surveyFormName","surveyId","surveyPreviousStatus","surveyPromoterScore","surveyQuestionGroupId","surveyQuestionId","surveyStatus","teamId","userId","wrapUpCode"],"x-genesys-enum-members":[{"name":"conversationId"},{"name":"divisionId"},{"name":"externalContactId"},{"name":"mediaType"},{"name":"queueId"},{"name":"requestedLanguageId"},{"name":"requestedRoutingSkillId"},{"name":"surveyAnswerId"},{"name":"surveyCreatedDate"},{"name":"surveyErrorReason"},{"name":"surveyFormContextId"},{"name":"surveyFormId"},{"name":"surveyFormName"},{"name":"surveyId"},{"name":"surveyPreviousStatus"},{"name":"surveyPromoterScore"},{"name":"surveyQuestionGroupId"},{"name":"surveyQuestionId"},{"name":"surveyStatus"},{"name":"teamId"},{"name":"userId"},{"name":"wrapUpCode"}]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/SurveyAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nSurveyErrors","nSurveyNpsDetractors","nSurveyNpsPromoters","nSurveyNpsResponses","nSurveyQuestionGroupResponses","nSurveyQuestionResponses","nSurveyResponses","nSurveysAbandoned","nSurveysDeleted","nSurveysExpired","nSurveysSent","nSurveysStarted","oSurveyQuestionGroupScore","oSurveyQuestionScore","oSurveyTotalScore"],"x-genesys-enum-members":[{"name":"nSurveyErrors"},{"name":"nSurveyNpsDetractors"},{"name":"nSurveyNpsPromoters"},{"name":"nSurveyNpsResponses"},{"name":"nSurveyQuestionGroupResponses"},{"name":"nSurveyQuestionResponses"},{"name":"nSurveyResponses"},{"name":"nSurveysAbandoned"},{"name":"nSurveysDeleted"},{"name":"nSurveysExpired"},{"name":"nSurveysSent"},{"name":"nSurveysStarted"},{"name":"oSurveyQuestionGroupScore"},{"name":"oSurveyQuestionScore"},{"name":"oSurveyTotalScore"}]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/SurveyAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime","surveyCreatedDate"],"x-genesys-enum-members":[{"name":"eventTime"},{"name":"surveyCreatedDate"}]}}},"SurveyAggregationView":{"type":"object","required":["function","name","target"],"properties":{"target":{"type":"string","description":"Target metric name","enum":["nSurveyErrors","nSurveyNpsDetractors","nSurveyNpsPromoters","nSurveyNpsResponses","nSurveyQuestionGroupResponses","nSurveyQuestionResponses","nSurveyResponses","nSurveysAbandoned","nSurveysDeleted","nSurveysExpired","nSurveysSent","nSurveysStarted","oSurveyQuestionGroupScore","oSurveyQuestionScore","oSurveyTotalScore"],"x-genesys-enum-members":[{"name":"nSurveyErrors"},{"name":"nSurveyNpsDetractors"},{"name":"nSurveyNpsPromoters"},{"name":"nSurveyNpsResponses"},{"name":"nSurveyQuestionGroupResponses"},{"name":"nSurveyQuestionResponses"},{"name":"nSurveyResponses"},{"name":"nSurveysAbandoned"},{"name":"nSurveysDeleted"},{"name":"nSurveysExpired"},{"name":"nSurveysSent"},{"name":"nSurveysStarted"},{"name":"oSurveyQuestionGroupScore"},{"name":"oSurveyQuestionScore"},{"name":"oSurveyTotalScore"}]},"name":{"type":"string","description":"A unique name for this view. Must be distinct from other views and built-in metric names."},"function":{"type":"string","description":"Type of view you wish to create","enum":["rangeBound"],"x-genesys-enum-members":[{"name":"rangeBound"}]},"range":{"description":"Range of numbers for slicing up data","$ref":"#/definitions/AggregationRange"}}},"SkillEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/RoutingSkill"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"UserLicenses":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"licenses":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserLicensesEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UserLicenses"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"pageCount":{"type":"integer","format":"int32"}}},"CallbackIdentifier":{"type":"object","required":["id","type"],"properties":{"type":{"type":"string","description":"The type of the associated callback participant","enum":["ACD","EXTERNAL"],"x-genesys-enum-members":[{"name":"ACD"},{"name":"EXTERNAL"}]},"id":{"type":"string","description":"The identifier of the callback"}}},"CreateCallbackResponse":{"type":"object","required":["callbackIdentifiers","conversation"],"properties":{"conversation":{"description":"The conversation associated with the callback","$ref":"#/definitions/DomainEntityRef"},"callbackIdentifiers":{"type":"array","description":"The list of communication identifiers for the callback participants","items":{"$ref":"#/definitions/CallbackIdentifier"}}}},"CreateCallbackCommand":{"type":"object","required":["callbackNumbers"],"properties":{"scriptId":{"type":"string","description":"The identifier of the script to be used for the callback"},"queueId":{"type":"string","description":"The identifier of the queue to be used for the callback. Either queueId or routingData is required."},"routingData":{"description":"The routing data to be used for the callback. Either queueId or routingData is required.","$ref":"#/definitions/RoutingData"},"callbackUserName":{"type":"string","description":"The name of the party to be called back."},"callbackNumbers":{"type":"array","description":"A list of phone numbers for the callback.","items":{"type":"string"}},"callbackScheduledTime":{"type":"string","format":"date-time","example":"2015-01-02T16:59:59.000Z","description":"The scheduled date-time for the callback as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"countryCode":{"type":"string","description":"The country code to be associated with the callback numbers."},"validateCallbackNumbers":{"type":"boolean","description":"Whether or not to validate the callback numbers for phone number format."},"data":{"type":"object","description":"A map of key-value pairs containing additional data that can be associated to the callback. These values will appear in the attributes property on the conversation participant. Example: { \"notes\": \"ready to close the deal!\", \"customerPreferredName\": \"Doc\" }","additionalProperties":{"type":"string"}}}},"RoutingData":{"type":"object","required":["queueId"],"properties":{"queueId":{"type":"string","description":"The identifier of the routing queue"},"languageId":{"type":"string","description":"The identifier of a language to be considered in routing"},"priority":{"type":"integer","format":"int32","description":"The priority for routing"},"skillIds":{"type":"array","description":"A list of skill identifiers to be considered in routing","items":{"type":"string"}},"preferredAgentIds":{"type":"array","description":"A list of agents to be preferred in routing","items":{"type":"string"}}}},"TestExecutionOperationResult":{"type":"object","properties":{"step":{"type":"integer","format":"int32","description":"The step number to indicate the order in which the operation was performed"},"name":{"type":"string","description":"Name of the operation performed"},"success":{"type":"boolean","description":"Indicated whether or not the operation was successful"},"result":{"type":"object","description":"The result of the operation"},"error":{"description":"Error that occurred during the operation","$ref":"#/definitions/ErrorBody"}}},"TestExecutionResult":{"type":"object","properties":{"operations":{"type":"array","description":"Execution operations performed as part of the test","items":{"$ref":"#/definitions/TestExecutionOperationResult"}},"error":{"description":"The final error encountered during the test that resulted in test failure","$ref":"#/definitions/ErrorBody"},"finalResult":{"type":"object","description":"The final result of the test. This is the response that would be returned during normal action execution"},"success":{"type":"boolean","description":"Indicates whether or not the test was a success"}}},"UpdateActionInput":{"type":"object","required":["version"],"properties":{"category":{"type":"string","description":"Category of action, Can be up to 256 characters long"},"name":{"type":"string","description":"Name of action, Can be up to 256 characters long"},"config":{"description":"Configuration to support request and response processing","$ref":"#/definitions/ActionConfig"},"version":{"type":"integer","format":"int32","description":"Version of this action"}}},"Agent":{"type":"object","properties":{"stage":{"type":"string","description":"The current stage for this agent"}}},"LogCaptureUserConfiguration":{"type":"object","required":["dateExpired"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"dateExpired":{"type":"string","format":"date-time","description":"Indicates when log capture will be turned off for the user. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SipDownloadResponse":{"type":"object","properties":{"downloadId":{"type":"string","description":"unique id of the downloaded file"},"documentId":{"type":"string","description":"Document id of pcap file"}}},"SIPSearchPublicRequest":{"type":"object","required":["dateEnd","dateStart"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"callId":{"type":"string","description":"unique identification of the placed call"},"toUser":{"type":"string","description":"SIP user to who the call was placed"},"fromUser":{"type":"string","description":"SIP user who placed the call"},"conversationId":{"type":"string","description":"Unique identification of the conversation"},"participantId":{"type":"string","description":"Unique identification of the participant"},"dateStart":{"type":"string","format":"date-time","description":"Start date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateEnd":{"type":"string","format":"date-time","description":"End date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SignedUrlResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"url":{"type":"string","format":"url","description":"Url of the downloaded pcap file"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"HomerRecord":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"date":{"type":"string","format":"date-time","description":"metadata associated to the SIP calls. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"milliTs":{"type":"string","description":"metadata associated to the SIP calls"},"microTs":{"type":"string","description":"metadata associated to the SIP calls"},"method":{"type":"string","description":"metadata associated to the SIP calls"},"replyReason":{"type":"string","description":"metadata associated to the SIP calls"},"ruri":{"type":"string","description":"metadata associated to the SIP calls"},"ruriUser":{"type":"string","description":"metadata associated to the SIP calls"},"ruriDomain":{"type":"string","description":"metadata associated to the SIP calls"},"fromUser":{"type":"string","description":"metadata associated to the SIP calls"},"fromDomain":{"type":"string","description":"metadata associated to the SIP calls"},"fromTag":{"type":"string","description":"metadata associated to the SIP calls"},"toUser":{"type":"string","description":"metadata associated to the SIP calls"},"toDomain":{"type":"string","description":"metadata associated to the SIP calls"},"toTag":{"type":"string","description":"metadata associated to the SIP calls"},"pidUser":{"type":"string","description":"metadata associated to the SIP calls"},"contactUser":{"type":"string","description":"metadata associated to the SIP calls"},"authUser":{"type":"string","description":"metadata associated to the SIP calls"},"callid":{"type":"string","description":"metadata associated to the SIP calls"},"callidAleg":{"type":"string","description":"metadata associated to the SIP calls"},"via1":{"type":"string","description":"metadata associated to the SIP calls"},"via1Branch":{"type":"string","description":"metadata associated to the SIP calls"},"cseq":{"type":"string","description":"metadata associated to the SIP calls"},"diversion":{"type":"string","description":"metadata associated to the SIP calls"},"reason":{"type":"string","description":"metadata associated to the SIP calls"},"contentType":{"type":"string","description":"metadata associated to the SIP calls"},"auth":{"type":"string","description":"metadata associated to the SIP calls"},"userAgent":{"type":"string","description":"metadata associated to the SIP calls"},"sourceIp":{"type":"string","description":"metadata associated to the SIP calls"},"sourcePort":{"type":"string","description":"metadata associated to the SIP calls"},"destinationIp":{"type":"string","description":"metadata associated to the SIP calls"},"destinationPort":{"type":"string","description":"metadata associated to the SIP calls"},"contactIp":{"type":"string","description":"metadata associated to the SIP calls"},"contactPort":{"type":"string","description":"metadata associated to the SIP calls"},"originatorIp":{"type":"string","description":"metadata associated to the SIP calls"},"originatorPort":{"type":"string","description":"metadata associated to the SIP calls"},"correlationId":{"type":"string","description":"metadata associated to the SIP calls"},"proto":{"type":"string","description":"metadata associated to the SIP calls"},"family":{"type":"string","description":"metadata associated to the SIP calls"},"rtpStat":{"type":"string","description":"metadata associated to the SIP calls"},"type":{"type":"string","description":"metadata associated to the SIP calls"},"node":{"type":"string","description":"metadata associated to the SIP calls"},"trans":{"type":"string","description":"metadata associated to the SIP calls"},"dbnode":{"type":"string","description":"metadata associated to the SIP calls"},"msg":{"type":"string","description":"metadata associated to the SIP calls"},"sourceAlias":{"type":"string","description":"metadata associated to the SIP calls"},"destinationAlias":{"type":"string","description":"metadata associated to the SIP calls"},"conversationId":{"type":"string","description":"metadata associated to the SIP calls"},"participantId":{"type":"string","description":"metadata associated to the SIP calls"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SipSearchResult":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"status":{"type":"integer","format":"int32","description":"Status of the search request"},"sid":{"type":"string","description":"Session id associated to the search request"},"auth":{"type":"string","description":"Auth token used for this search request"},"message":{"type":"string","description":"Any messages returned from homer as part of the response"},"data":{"type":"array","description":"Homer search data that is returned","items":{"$ref":"#/definitions/HomerRecord"}},"count":{"type":"integer","format":"int32","description":"Number of records returned"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DocumentUpload":{"type":"object","required":["name","workspace"],"properties":{"name":{"type":"string","description":"The name of the document"},"workspace":{"description":"The workspace the document will be uploaded to","$ref":"#/definitions/DomainEntityRef"},"tags":{"type":"array","items":{"type":"string"}},"tagIds":{"type":"array","items":{"type":"string"}}}},"OrganizationPresenceEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/OrganizationPresence"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"SecurityProfileEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SecurityProfile"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EdgeLogsJobUploadRequest":{"type":"object","required":["fileIds"],"properties":{"fileIds":{"type":"array","description":"A list of file ids to upload.","items":{"type":"string"}}}},"DataTablesDomainEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DataTable"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"LocationsSearchResponse":{"type":"object","required":["pageCount","pageNumber","pageSize","results","total","types"],"properties":{"total":{"type":"integer","format":"int64","description":"The total number of results found"},"pageCount":{"type":"integer","format":"int32","description":"The total number of pages"},"pageSize":{"type":"integer","format":"int32","description":"The current page size"},"pageNumber":{"type":"integer","format":"int32","description":"The current page number"},"previousPage":{"type":"string","description":"Q64 value for the previous page of results"},"currentPage":{"type":"string","description":"Q64 value for the current page of results"},"nextPage":{"type":"string","description":"Q64 value for the next page of results"},"types":{"type":"array","description":"Resource types the search was performed against","items":{"type":"string"}},"results":{"type":"array","description":"Search results","items":{"$ref":"#/definitions/LocationDefinition"}}}},"LocationSearchCriteria":{"type":"object","required":["type"],"properties":{"endValue":{"type":"string","description":"The end value of the range. This field is used for range search types."},"values":{"type":"array","description":"A list of values for the search to match against","items":{"type":"string"}},"startValue":{"type":"string","description":"The start value of the range. This field is used for range search types."},"fields":{"type":"array","description":"Field names to search against","items":{"type":"string"}},"value":{"type":"string","description":"A value for the search to match against"},"operator":{"type":"string","description":"How to apply this search criteria against other criteria","enum":["AND","OR","NOT"],"x-genesys-enum-members":[{"name":"AND"},{"name":"OR"},{"name":"NOT"}]},"group":{"type":"array","description":"Groups multiple conditions","items":{"$ref":"#/definitions/LocationSearchCriteria"}},"dateFormat":{"type":"string","description":"Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."},"type":{"type":"string","description":"Search Type","enum":["EXACT","STARTS_WITH","CONTAINS","REGEX","TERM","TERMS","REQUIRED_FIELDS","MATCH_ALL"],"x-genesys-enum-members":[{"name":"EXACT"},{"name":"STARTS_WITH"},{"name":"CONTAINS"},{"name":"REGEX"},{"name":"TERM"},{"name":"TERMS"},{"name":"REQUIRED_FIELDS"},{"name":"MATCH_ALL"}]}}},"LocationSearchRequest":{"type":"object","properties":{"sortOrder":{"type":"string","description":"The sort order for results","enum":["ASC","DESC","SCORE"],"x-genesys-enum-members":[{"name":"ASC"},{"name":"DESC"},{"name":"SCORE"}]},"sortBy":{"type":"string","description":"The field in the resource that you want to sort the results by"},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"},"pageNumber":{"type":"integer","format":"int32","description":"The page of resources you want to retrieve"},"sort":{"type":"array","description":"Multi-value sort order, list of multiple sort values","items":{"$ref":"#/definitions/SearchSort"}},"expand":{"type":"array","description":"Provides more details about a specified resource","items":{"type":"string"}},"query":{"type":"array","items":{"$ref":"#/definitions/LocationSearchCriteria"}}}},"TimeZoneMappingPreview":{"type":"object","properties":{"contactList":{"description":"The associated ContactList","$ref":"#/definitions/DomainEntityRef"},"contactsPerTimeZone":{"type":"object","description":"The number of contacts per time zone that mapped to only that time zone","additionalProperties":{"type":"integer","format":"int64"}},"contactsMappedUsingZipCode":{"type":"object","description":"The number of contacts per time zone that mapped to only that time zone and were mapped using the zip code column","additionalProperties":{"type":"integer","format":"int64"}},"contactsMappedToASingleZone":{"type":"integer","format":"int64","description":"The total number of contacts that mapped to a single time zone"},"contactsMappedToASingleZoneUsingZipCode":{"type":"integer","format":"int64","description":"The total number of contacts that mapped to a single time zone and were mapped using the zip code column"},"contactsMappedToMultipleZones":{"type":"integer","format":"int64","description":"The total number of contacts that mapped to multiple time zones"},"contactsMappedToMultipleZonesUsingZipCode":{"type":"integer","format":"int64","description":"The total number of contacts that mapped to multiple time zones and were mapped using the zip code column"},"contactsInDefaultWindow":{"type":"integer","format":"int64","description":"The total number of contacts that will be dialed during the default window"},"contactListSize":{"type":"integer","format":"int64","description":"The total number of contacts in the contact list"}}},"ContactList":{"type":"object","required":["columnNames","phoneColumns"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"division":{"description":"The division this entity belongs to.","$ref":"#/definitions/DomainEntityRef"},"columnNames":{"type":"array","description":"The names of the contact data columns.","items":{"type":"string"}},"phoneColumns":{"type":"array","description":"Indicates which columns are phone numbers.","items":{"$ref":"#/definitions/ContactPhoneNumberColumn"}},"importStatus":{"description":"The status of the import process.","readOnly":true,"$ref":"#/definitions/ImportStatus"},"previewModeColumnName":{"type":"string","description":"A column to check if a contact should always be dialed in preview mode."},"previewModeAcceptedValues":{"type":"array","description":"The values in the previewModeColumnName column that indicate a contact should always be dialed in preview mode.","items":{"type":"string"}},"size":{"type":"integer","format":"int64","description":"The number of contacts in the ContactList.","readOnly":true},"attemptLimits":{"description":"AttemptLimits for this ContactList.","$ref":"#/definitions/DomainEntityRef"},"automaticTimeZoneMapping":{"type":"boolean","description":"Indicates if automatic time zone mapping is to be used for this ContactList."},"zipCodeColumnName":{"type":"string","description":"The name of contact list column containing the zip code for use with automatic time zone mapping. Only allowed if 'automaticTimeZoneMapping' is set to true."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ContactPhoneNumberColumn":{"type":"object","required":["columnName","type"],"properties":{"columnName":{"type":"string","description":"The name of the phone column."},"type":{"type":"string","description":"Indicates the type of the phone column. For example, 'cell' or 'home'."},"callableTimeColumn":{"type":"string","description":"A column that indicates the timezone to use for a given contact when checking callable times. Not allowed if 'automaticTimeZoneMapping' is set to true."}}},"ExternalOrganizationListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ExternalOrganization"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"OrganizationFeatures":{"type":"object","properties":{"realtimeCIC":{"type":"boolean"},"purecloud":{"type":"boolean"},"hipaa":{"type":"boolean"},"ucEnabled":{"type":"boolean"},"pci":{"type":"boolean"},"purecloudVoice":{"type":"boolean"},"xmppFederation":{"type":"boolean"},"chat":{"type":"boolean"},"informalPhotos":{"type":"boolean"},"directory":{"type":"boolean"},"contactCenter":{"type":"boolean"},"unifiedCommunications":{"type":"boolean"},"custserv":{"type":"boolean"}}},"FeatureState":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"DependencyStatus":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"user":{"description":"User that initiated the build.","$ref":"#/definitions/User"},"client":{"description":"OAuth client that initiated the build.","$ref":"#/definitions/DomainEntityRef"},"buildId":{"type":"string"},"dateStarted":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateCompleted":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"status":{"type":"string","enum":["BUILDINITIALIZING","BUILDINPROGRESS","NOTBUILT","OPERATIONAL","OPERATIONALNEEDSREBUILD"],"x-genesys-enum-members":[{"name":"BUILDINITIALIZING"},{"name":"BUILDINPROGRESS"},{"name":"NOTBUILT"},{"name":"OPERATIONAL"},{"name":"OPERATIONALNEEDSREBUILD"}]},"failedObjects":{"type":"array","items":{"$ref":"#/definitions/FailedObject"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FailedObject":{"type":"object","properties":{"id":{"type":"string"},"version":{"type":"string"},"name":{"type":"string"},"errorCode":{"type":"string"}}},"MessagingCampaign":{"type":"object","required":["contactList","messagesPerMinute"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"division":{"description":"The division this entity belongs to.","$ref":"#/definitions/DomainEntityRef"},"campaignStatus":{"type":"string","description":"The current status of the messaging campaign. A messaging campaign may be turned 'on' or 'off'.","enum":["on","stopping","off","complete","invalid"],"x-genesys-enum-members":[{"name":"on"},{"name":"stopping"},{"name":"off"},{"name":"complete"},{"name":"invalid"}]},"callableTimeSet":{"description":"The callable time set for this messaging campaign.","$ref":"#/definitions/DomainEntityRef"},"contactList":{"description":"The contact list that this messaging campaign will send messages for.","$ref":"#/definitions/DomainEntityRef"},"dncLists":{"type":"array","description":"The dnc lists to check before sending a message for this messaging campaign.","items":{"$ref":"#/definitions/DomainEntityRef"}},"alwaysRunning":{"type":"boolean","description":"Whether this messaging campaign is always running"},"contactSorts":{"type":"array","description":"The order in which to sort contacts for dialing, based on up to four columns.","items":{"$ref":"#/definitions/ContactSort"}},"messagesPerMinute":{"type":"integer","format":"int32","description":"How many messages this messaging campaign will send per minute."},"errors":{"type":"array","description":"A list of current error conditions associated with this messaging campaign.","items":{"$ref":"#/definitions/RestErrorDetail"}},"smsConfig":{"description":"Configuration for this messaging campaign to send SMS messages.","$ref":"#/definitions/SmsConfig"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SmsConfig":{"type":"object","required":["messageColumn","phoneColumn","senderSmsPhoneNumber"],"properties":{"messageColumn":{"type":"string","description":"The Contact List column specifying the message to send to the contact."},"phoneColumn":{"type":"string","description":"The Contact List column specifying the phone number to send a message to."},"senderSmsPhoneNumber":{"description":"A reference to the SMS Phone Number that will be used as the sender of a message.","$ref":"#/definitions/SmsPhoneNumberRef"}}},"SmsPhoneNumberRef":{"type":"object","required":["phoneNumber"],"properties":{"phoneNumber":{"type":"string","description":"A phone number provisioned for SMS communications in E.164 format. E.g. +13175555555 or +34234234234"},"selfUri":{"type":"string","format":"uri"}}},"MessagingCampaignEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/MessagingCampaign"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AsyncIntradayResponse":{"type":"object","properties":{"status":{"type":"string","description":"The status of the operation","enum":["Processing","Complete","Canceled","Error"],"x-genesys-enum-members":[{"name":"Processing"},{"name":"Complete"},{"name":"Canceled"},{"name":"Error"}]},"operationId":{"type":"string","description":"The ID for the operation"},"result":{"description":"The result of the operation. Null unless status == Complete","$ref":"#/definitions/BuIntradayResponse"}}},"BuIntradayDataGroup":{"type":"object","properties":{"mediaType":{"type":"string","description":"The media type associated with this intraday group","enum":["Voice","Chat","Email","Callback","Message"],"x-genesys-enum-members":[{"name":"Voice"},{"name":"Chat"},{"name":"Email"},{"name":"Callback"},{"name":"Message"}]},"forecastDataSummary":{"description":"Forecast data summary for this date range","$ref":"#/definitions/BuIntradayForecastData"},"forecastDataPerInterval":{"type":"array","description":"Forecast data per interval for this date range","items":{"$ref":"#/definitions/BuIntradayForecastData"}},"scheduleDataSummary":{"description":"Schedule data summary for this date range","$ref":"#/definitions/BuIntradayScheduleData"},"scheduleDataPerInterval":{"type":"array","description":"Schedule data per interval for this date range","items":{"$ref":"#/definitions/BuIntradayScheduleData"}},"performancePredictionDataSummary":{"description":"Performance prediction data summary for this date range","$ref":"#/definitions/IntradayPerformancePredictionData"},"performancePredictionDataPerInterval":{"type":"array","description":"Performance prediction data per interval for this date range","items":{"$ref":"#/definitions/IntradayPerformancePredictionData"}}}},"BuIntradayForecastData":{"type":"object","properties":{"offered":{"type":"number","format":"double","description":"The number of interactions routed into the queues in the selected planning groups for the given media type for an agent to answer"},"averageHandleTimeSeconds":{"type":"number","format":"double","description":"The average handle time in seconds an agent spent handling interactions"}}},"BuIntradayResponse":{"type":"object","properties":{"startDate":{"type":"string","format":"date-time","description":"The start of the date range for which this data applies. This is also the start reference point for the intervals represented in the various arrays. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endDate":{"type":"string","format":"date-time","description":"The end of the date range for which this data applies. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"intervalLengthMinutes":{"type":"integer","format":"int32","description":"The aggregation period in minutes, which determines the interval duration of the returned data"},"noDataReason":{"type":"string","description":"If not null, the reason there was no data for the request","enum":["NoPublishedSchedule","NoSourceForecast"],"x-genesys-enum-members":[{"name":"NoPublishedSchedule"},{"name":"NoSourceForecast"}]},"categories":{"type":"array","description":"The categories to which this data corresponds","items":{"type":"string","enum":["ForecastData","ScheduleData","PerformancePredictionData"],"x-genesys-enum-members":[{"name":"ForecastData"},{"name":"ScheduleData"},{"name":"PerformancePredictionData"}]}},"shortTermForecast":{"description":"Short term forecast reference","$ref":"#/definitions/BuShortTermForecastReference"},"schedule":{"description":"Schedule reference","$ref":"#/definitions/BuScheduleReference"},"intradayDataGroupings":{"type":"array","description":"Intraday data grouped by a single media type and set of planning group IDs","items":{"$ref":"#/definitions/BuIntradayDataGroup"}}}},"BuIntradayScheduleData":{"type":"object","properties":{"onQueueTimeSeconds":{"type":"integer","format":"int64","description":"The total on-queue time in seconds for all agents in this group"}}},"IntradayPerformancePredictionData":{"type":"object","properties":{"serviceLevelPercent":{"type":"number","format":"double","description":"Percentage of interactions that meets service level target as defined in the matching service goal templates"},"averageSpeedOfAnswerSeconds":{"type":"number","format":"double","description":"Predicted average time in seconds it takes to answer an interaction once the interaction becomes available to be routed"},"occupancyPercent":{"type":"number","format":"double","description":"Percentage of on-queue time for all agents in this group that are occupied handling interactions"}}},"IntradayPlanningGroupRequest":{"type":"object","required":["businessUnitDate","categories"],"properties":{"businessUnitDate":{"type":"string","format":"date","description":"Requested date in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"categories":{"type":"array","description":"The metric categories","items":{"type":"string","enum":["ForecastData","ScheduleData","PerformancePredictionData"],"x-genesys-enum-members":[{"name":"ForecastData"},{"name":"ScheduleData"},{"name":"PerformancePredictionData"}]}},"planningGroupIds":{"type":"array","description":"The IDs of the planning groups for which to fetch data. Omitting or passing an empty list will return all available planning groups","items":{"type":"string"}},"intervalLengthMinutes":{"type":"integer","format":"int32","description":"The period/interval in minutes for which to aggregate the data. Required, defaults to 15"}}},"WfmIntradayPlanningGroupListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ForecastPlanningGroupResponse"}},"noDataReason":{"type":"string","description":"The reason there was no data for the request","enum":["NoPublishedSchedule","NoSourceForecast"],"x-genesys-enum-members":[{"name":"NoPublishedSchedule"},{"name":"NoSourceForecast"}]}},"description":"A list of IntradayPlanningGroup objects"},"SchemaCategory":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SchemaCategoryEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SchemaCategory"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AtzmTimeSlot":{"type":"object","properties":{"earliestCallableTime":{"type":"string","example":"08:00","description":"The earliest time to dial a contact. Valid format is HH:mm"},"latestCallableTime":{"type":"string","example":"21:00","description":"The latest time to dial a contact. Valid format is HH:mm"}}},"AtzmTimeSlotWithTimeZone":{"type":"object","properties":{"earliestCallableTime":{"type":"string","example":"08:00","description":"The earliest time to dial a contact. Valid format is HH:mm"},"latestCallableTime":{"type":"string","example":"21:00","description":"The latest time to dial a contact. Valid format is HH:mm"},"timeZoneId":{"type":"string","example":"America/New York","description":"The time zone to use for contacts that cannot be mapped."}}},"AutomaticTimeZoneMappingSettings":{"type":"object","properties":{"callableWindows":{"type":"array","description":"The time intervals to use for automatic time zone mapping.","items":{"$ref":"#/definitions/CallableWindow"}}}},"CallableWindow":{"type":"object","properties":{"mapped":{"description":"The time interval to place outbound calls, for contacts that can be mapped to a time zone.","$ref":"#/definitions/AtzmTimeSlot"},"unmapped":{"description":"The time interval and time zone to place outbound calls, for contacts that cannot be mapped to a time zone.","$ref":"#/definitions/AtzmTimeSlotWithTimeZone"}}},"OutboundSettings":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"maxCallsPerAgent":{"type":"integer","format":"int32","description":"The maximum number of calls that can be placed per agent on any campaign"},"maxConfigurableCallsPerAgent":{"type":"integer","format":"int32","description":"The maximum number of calls that can be configured to be placed per agent on any campaign","readOnly":true},"maxLineUtilization":{"type":"number","format":"double","description":"The maximum percentage of lines that should be used for Outbound, expressed as a decimal in the range [0.0, 1.0]"},"abandonSeconds":{"type":"number","format":"double","description":"The number of seconds used to determine if a call is abandoned"},"complianceAbandonRateDenominator":{"type":"string","description":"The denominator to be used in determining the compliance abandon rate","enum":["ALL_CALLS","CALLS_THAT_REACHED_QUEUE"],"x-genesys-enum-members":[{"name":"ALL_CALLS"},{"name":"CALLS_THAT_REACHED_QUEUE"}]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Condition":{"type":"object","properties":{"type":{"type":"string","description":"The type of the condition.","enum":["wrapupCondition","contactAttributeCondition","phoneNumberCondition","phoneNumberTypeCondition","callAnalysisCondition","contactPropertyCondition","dataActionCondition"],"x-genesys-enum-members":[{"name":"wrapupCondition"},{"name":"contactAttributeCondition"},{"name":"phoneNumberCondition"},{"name":"phoneNumberTypeCondition"},{"name":"callAnalysisCondition"},{"name":"contactPropertyCondition"},{"name":"dataActionCondition"}]},"inverted":{"type":"boolean","description":"If true, inverts the result of evaluating this Condition. Default is false."},"attributeName":{"type":"string","description":"An attribute name associated with this Condition. Required for a contactAttributeCondition."},"value":{"type":"string","description":"A value associated with this Condition. This could be text, a number, or a relative time. Not used for a DataActionCondition."},"valueType":{"type":"string","description":"The type of the value associated with this Condition. Not used for a DataActionCondition.","enum":["STRING","NUMERIC","DATETIME","PERIOD"],"x-genesys-enum-members":[{"name":"STRING"},{"name":"NUMERIC"},{"name":"DATETIME"},{"name":"PERIOD"}]},"operator":{"type":"string","description":"An operation with which to evaluate the Condition. Not used for a DataActionCondition.","enum":["EQUALS","LESS_THAN","LESS_THAN_EQUALS","GREATER_THAN","GREATER_THAN_EQUALS","CONTAINS","BEGINS_WITH","ENDS_WITH","BEFORE","AFTER","IN"],"x-genesys-enum-members":[{"name":"EQUALS"},{"name":"LESS_THAN"},{"name":"LESS_THAN_EQUALS"},{"name":"GREATER_THAN"},{"name":"GREATER_THAN_EQUALS"},{"name":"CONTAINS"},{"name":"BEGINS_WITH"},{"name":"ENDS_WITH"},{"name":"BEFORE"},{"name":"AFTER"},{"name":"IN"}]},"codes":{"type":"array","description":"List of wrap-up code identifiers. Required for a wrapupCondition.","items":{"type":"string"}},"property":{"type":"string","description":"A value associated with the property type of this Condition. Required for a contactPropertyCondition."},"propertyType":{"type":"string","description":"The type of the property associated with this Condition. Required for a contactPropertyCondition.","enum":["LAST_ATTEMPT_BY_COLUMN","LAST_ATTEMPT_OVERALL","LAST_WRAPUP_BY_COLUMN","LAST_WRAPUP_OVERALL"],"x-genesys-enum-members":[{"name":"LAST_ATTEMPT_BY_COLUMN"},{"name":"LAST_ATTEMPT_OVERALL"},{"name":"LAST_WRAPUP_BY_COLUMN"},{"name":"LAST_WRAPUP_OVERALL"}]}}},"ContactColumnToDataActionFieldMapping":{"type":"object","properties":{}},"DataActionConditionPredicate":{"type":"object","properties":{}},"DialerAction":{"type":"object","required":["actionTypeName","type"],"properties":{"type":{"type":"string","description":"The type of this DialerAction.","enum":["Action","modifyContactAttribute"],"x-genesys-enum-members":[{"name":"Action"},{"name":"modifyContactAttribute"}]},"actionTypeName":{"type":"string","description":"Additional type specification for this DialerAction.","enum":["DO_NOT_DIAL","MODIFY_CONTACT_ATTRIBUTE","SWITCH_TO_PREVIEW","APPEND_NUMBER_TO_DNC_LIST","SCHEDULE_CALLBACK","CONTACT_UNCALLABLE","NUMBER_UNCALLABLE","SET_CALLER_ID","SET_SKILLS"],"x-genesys-enum-members":[{"name":"DO_NOT_DIAL"},{"name":"MODIFY_CONTACT_ATTRIBUTE"},{"name":"SWITCH_TO_PREVIEW"},{"name":"APPEND_NUMBER_TO_DNC_LIST"},{"name":"SCHEDULE_CALLBACK"},{"name":"CONTACT_UNCALLABLE"},{"name":"NUMBER_UNCALLABLE"},{"name":"SET_CALLER_ID"},{"name":"SET_SKILLS"}]},"updateOption":{"type":"string","description":"Specifies how a contact attribute should be updated. Required for MODIFY_CONTACT_ATTRIBUTE.","enum":["SET","INCREMENT","DECREMENT","CURRENT_TIME"],"x-genesys-enum-members":[{"name":"SET"},{"name":"INCREMENT"},{"name":"DECREMENT"},{"name":"CURRENT_TIME"}]},"properties":{"type":"object","description":"A map of key-value pairs pertinent to the DialerAction. Different types of DialerActions require different properties. MODIFY_CONTACT_ATTRIBUTE with an updateOption of SET takes a contact column as the key and accepts any value. SCHEDULE_CALLBACK takes a key 'callbackOffset' that specifies how far in the future the callback should be scheduled, in minutes. SET_CALLER_ID takes two keys: 'callerAddress', which should be the caller id phone number, and 'callerName'. For either key, you can also specify a column on the contact to get the value from. To do this, specify 'contact.Column', where 'Column' is the name of the contact column from which to get the value. SET_SKILLS takes a key 'skills' with an array of skill ids wrapped into a string (Example: {'skills': '['skillIdHere']'} ).","additionalProperties":{"type":"string"}}}},"DialerRule":{"type":"object","required":["category","conditions","name"],"properties":{"id":{"type":"string","description":"The identifier of the rule.","readOnly":true},"name":{"type":"string","description":"The name of the rule."},"order":{"type":"integer","format":"int32","description":"The ranked order of the rule. Rules are processed from lowest number to highest."},"category":{"type":"string","description":"The category of the rule.","enum":["DIALER_PRECALL","DIALER_WRAPUP"],"x-genesys-enum-members":[{"name":"DIALER_PRECALL"},{"name":"DIALER_WRAPUP"}]},"conditions":{"type":"array","description":"A list of Conditions. All of the Conditions must evaluate to true to trigger the actions.","items":{"$ref":"#/definitions/Condition"}},"actions":{"type":"array","description":"The list of actions to be taken if the conditions are true.","items":{"$ref":"#/definitions/DialerAction"}}}},"RuleSet":{"type":"object","required":["name","rules"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the RuleSet."},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"contactList":{"description":"A ContactList to provide user-interface suggestions for contact columns on relevant conditions and actions.","$ref":"#/definitions/DomainEntityRef"},"queue":{"description":"A Queue to provide user-interface suggestions for wrap-up codes on relevant conditions and actions.","$ref":"#/definitions/DomainEntityRef"},"rules":{"type":"array","description":"The list of rules.","items":{"$ref":"#/definitions/DialerRule"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PureCloud":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"disabled":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LanguageEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Language"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"UserProfileEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UserProfile"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ParsedCertificate":{"type":"object","properties":{"certificateDetails":{"type":"array","description":"The details of the certificates that were parsed correctly.","items":{"$ref":"#/definitions/CertificateDetails"}}},"description":"Represents the parsed certificate information."},"Certificate":{"type":"object","required":["certificate"],"properties":{"certificate":{"type":"string","description":"The certificate to parse."}},"description":"Represents a certificate to parse."},"LicenseOrgToggle":{"type":"object","properties":{"featureName":{"type":"string"},"enabled":{"type":"boolean"}}},"EdgeLineEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/EdgeLine"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"LineBase":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"lineMetaBase":{"$ref":"#/definitions/DomainEntityRef"},"properties":{"type":"object","additionalProperties":{"type":"object"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PhoneBase":{"type":"object","required":["lines","name","phoneMetaBase"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"phoneMetaBase":{"description":"A phone metabase is essentially a database for storing phone configuration settings, which simplifies the configuration process.","$ref":"#/definitions/DomainEntityRef"},"lines":{"type":"array","description":"The list of linebases associated with the phone base.","items":{"$ref":"#/definitions/LineBase"}},"properties":{"type":"object","additionalProperties":{"type":"object"}},"capabilities":{"$ref":"#/definitions/PhoneCapabilities"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PhoneBaseEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/PhoneBase"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"RuleSetEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/RuleSet"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DIDEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DID"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CredentialTypeListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CredentialType"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"OrgOAuthClient":{"type":"object","required":["authorizedGrantType","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the OAuth client."},"dateCreated":{"type":"string","format":"date-time","description":"Date this client was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date this client was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"description":"User that created this client","$ref":"#/definitions/DomainEntityRef"},"modifiedBy":{"description":"User that last modified this client","$ref":"#/definitions/DomainEntityRef"},"authorizedGrantType":{"type":"string","description":"The OAuth Grant/Client type supported by this client.\nCode Authorization Grant/Client type - Preferred client type where the Client ID and Secret are required to create tokens. Used where the secret can be secured.\nPKCE-Enabled Code Authorization grant type - Code grant type which requires PKCE challenge and verifier to create tokens. Used in public clients for increased security.\nImplicit grant type - Client ID only is required to create tokens. Used in browser and mobile apps where the secret can not be secured.\nSAML2-Bearer extension grant type - SAML2 assertion provider for user authentication at the token endpoint.\nClient Credential grant type - Used to created access tokens that are tied only to the client.\n","enum":["CODE","CODE_PKCE","TOKEN","SAML2BEARER","PASSWORD","CLIENT_CREDENTIALS"],"x-genesys-enum-members":[{"name":"CODE"},{"name":"CODE_PKCE"},{"name":"TOKEN"},{"name":"SAML2BEARER"},{"name":"PASSWORD"},{"name":"CLIENT_CREDENTIALS"}]},"scope":{"type":"array","description":"The scope requested by this client. Scopes only apply to clients not using the client_credential grant","items":{"type":"string"}},"roleDivisions":{"type":"array","description":"Set of roles and their corresponding divisions associated with this client. Roles and divisions only apply to clients using the client_credential grant","uniqueItems":true,"items":{"$ref":"#/definitions/RoleDivision"}},"state":{"type":"string","description":"The state of the OAuth client.\nActive: The OAuth client can be used to create access tokens. This is the default state.\nDisabled: Access tokens created by the client are invalid and new ones cannot be created.\nInactive: Access tokens cannot be created with this OAuth client and it will be deleted.","enum":["active","disabled","inactive"],"x-genesys-enum-members":[{"name":"active"},{"name":"disabled"},{"name":"inactive"}]},"dateToDelete":{"type":"string","format":"date-time","description":"The time at which this client will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"organization":{"description":"The oauth client's organization.","readOnly":true,"$ref":"#/definitions/NamedEntity"}}},"TokenInfo":{"type":"object","properties":{"organization":{"description":"The current organization","readOnly":true,"$ref":"#/definitions/NamedEntity"},"homeOrganization":{"description":"The token's home organization","readOnly":true,"$ref":"#/definitions/NamedEntity"},"authorizedScope":{"type":"array","description":"The list of scopes authorized for the OAuth client","readOnly":true,"items":{"type":"string"}},"clonedUser":{"description":"Only present when a user is a clone of trustee user in the trustor org.","readOnly":true,"$ref":"#/definitions/TokenInfoClonedUser"},"OAuthClient":{"$ref":"#/definitions/OrgOAuthClient"}}},"TokenInfoClonedUser":{"type":"object","properties":{"id":{"type":"string","description":"User id of the original native user","readOnly":true},"organization":{"description":"Organization of the original native user","readOnly":true,"$ref":"#/definitions/Entity"}}},"GKNDocumentationResult":{"type":"object","required":["_type"],"properties":{"content":{"type":"string","description":"The text or html content for the documentation entity. Will be returned in responses for certain entities."},"link":{"type":"string","description":"URL link for the documentation entity. Will be returned in responses for certain entities."},"title":{"type":"string","description":"The title of the documentation entity. Will be returned in responses for certain entities."},"_type":{"type":"string","description":"The search type. Will be returned in responses for certain entities."}}},"GKNDocumentationSearchResponse":{"type":"object","required":["pageCount","pageNumber","pageSize","results","total","types"],"properties":{"total":{"type":"integer","format":"int64","description":"The total number of results found"},"pageCount":{"type":"integer","format":"int32","description":"The total number of pages"},"pageSize":{"type":"integer","format":"int32","description":"The current page size"},"pageNumber":{"type":"integer","format":"int32","description":"The current page number"},"previousPage":{"type":"string","description":"Q64 value for the previous page of results"},"currentPage":{"type":"string","description":"Q64 value for the current page of results"},"nextPage":{"type":"string","description":"Q64 value for the next page of results"},"types":{"type":"array","description":"Resource types the search was performed against","items":{"type":"string"}},"results":{"type":"array","description":"Search results","items":{"$ref":"#/definitions/GKNDocumentationResult"}}}},"GKNDocumentationSearchCriteria":{"type":"object","required":["type"],"properties":{"endValue":{"type":"string","description":"The end value of the range. This field is used for range search types."},"values":{"type":"array","description":"A list of values for the search to match against","items":{"type":"string"}},"startValue":{"type":"string","description":"The start value of the range. This field is used for range search types."},"fields":{"type":"array","description":"Field names to search against","items":{"type":"string"}},"value":{"type":"string","description":"A value for the search to match against"},"operator":{"type":"string","description":"How to apply this search criteria against other criteria","enum":["AND","OR","NOT"],"x-genesys-enum-members":[{"name":"AND"},{"name":"OR"},{"name":"NOT"}]},"group":{"type":"array","description":"Groups multiple conditions","items":{"$ref":"#/definitions/GKNDocumentationSearchCriteria"}},"dateFormat":{"type":"string","description":"Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."},"type":{"type":"string","description":"Search Type","enum":["SIMPLE"],"x-genesys-enum-members":[{"name":"SIMPLE"}]}}},"GKNDocumentationSearchRequest":{"type":"object","properties":{"sortOrder":{"type":"string","description":"The sort order for results","enum":["ASC","DESC","SCORE"],"x-genesys-enum-members":[{"name":"ASC"},{"name":"DESC"},{"name":"SCORE"}]},"sortBy":{"type":"string","description":"The field in the resource that you want to sort the results by"},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"},"pageNumber":{"type":"integer","format":"int32","description":"The page of resources you want to retrieve"},"sort":{"type":"array","description":"Multi-value sort order, list of multiple sort values","items":{"$ref":"#/definitions/SearchSort"}},"query":{"type":"array","items":{"$ref":"#/definitions/GKNDocumentationSearchCriteria"}}}},"SchedulingProcessingError":{"type":"object","properties":{"internalErrorCode":{"type":"string","description":"An internal code representing the type of error. BadJson for 'Unable to parse json.' NotFound for 'Resource not found.' Fail for 'An unexpected server error occured.'","readOnly":true,"enum":["BadJson","NotFound","Fail"],"x-genesys-enum-members":[{"name":"BadJson"},{"name":"NotFound"},{"name":"Fail"}]},"description":{"type":"string","description":"A text description of the error","readOnly":true}}},"SchedulingStatusResponse":{"type":"object","properties":{"id":{"type":"string","description":"The ID generated for the scheduling job. Use to GET result when job is completed.","readOnly":true},"status":{"type":"string","description":"The status of the scheduling job.","readOnly":true,"enum":["Pending","Success","Failed","Ongoing","PartialFailure"],"x-genesys-enum-members":[{"name":"Pending"},{"name":"Success"},{"name":"Failed"},{"name":"Ongoing"},{"name":"PartialFailure"}]},"errorDetails":{"type":"array","description":"If the request could not be properly processed, error details will be given here.","readOnly":true,"items":{"$ref":"#/definitions/SchedulingProcessingError"}},"schedulingResultUri":{"type":"string","description":"The uri of the scheduling result. It has a value if the status is 'Success'.","readOnly":true},"percentComplete":{"type":"integer","format":"int32","description":"The percentage of the job that is complete.","readOnly":true}}},"CreateManagementUnitApiRequest":{"type":"object","required":["businessUnitId","name"],"properties":{"name":{"type":"string","description":"The name of the management unit"},"timeZone":{"type":"string","description":"The default time zone to use for this management unit. Moving to Business Unit"},"startDayOfWeek":{"type":"string","description":"The configured first day of the week for scheduling and forecasting purposes. Moving to Business Unit","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"x-genesys-enum-members":[{"name":"Sunday"},{"name":"Monday"},{"name":"Tuesday"},{"name":"Wednesday"},{"name":"Thursday"},{"name":"Friday"},{"name":"Saturday"}]},"settings":{"description":"The configuration for the management unit. If omitted, reasonable defaults will be assigned","$ref":"#/definitions/CreateManagementUnitSettingsRequest"},"divisionId":{"type":"string","description":"The id of the division to which this management unit belongs. Defaults to home division ID"},"businessUnitId":{"type":"string","description":"The id of the business unit to which this management unit belongs. Required after business unit launch"}},"description":"Create Management Unit"},"CreateManagementUnitSettingsRequest":{"type":"object","properties":{"adherence":{"description":"Adherence settings for this management unit","$ref":"#/definitions/AdherenceSettings"},"shortTermForecasting":{"description":"Short term forecasting settings for this management unit. Moving to Business Unit","$ref":"#/definitions/ShortTermForecastingSettings"},"timeOff":{"description":"Time off request settings for this management unit","$ref":"#/definitions/TimeOffRequestSettings"},"scheduling":{"description":"Scheduling settings for this management unit","$ref":"#/definitions/SchedulingSettingsRequest"},"shiftTrading":{"description":"Shift trade settings for this management unit","$ref":"#/definitions/ShiftTradeSettings"}},"description":"Management Unit Settings"},"OAuthProviderEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/OAuthProvider"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ModelingProcessingError":{"type":"object","properties":{"internalErrorCode":{"type":"string","description":"An internal code representing the type of error. ModelInputMissing for 'Model Builder inputs not found.' ModelInputInvalid for 'Model Builder inputs are invalid. Ensure the input data format is correct.' ModelFailed for 'An error occured while building the model with the given input.'","readOnly":true,"enum":["ModelInputMissing","ModelInputInvalid","ModelFailed"],"x-genesys-enum-members":[{"name":"ModelInputMissing"},{"name":"ModelInputInvalid"},{"name":"ModelFailed"}]},"description":{"type":"string","description":"A text description of the error","readOnly":true}}},"ModelingStatusResponse":{"type":"object","properties":{"id":{"type":"string","description":"The ID generated for the modeling job. Use to GET result when job is completed.","readOnly":true},"status":{"type":"string","description":"The status of the modeling job.","readOnly":true,"enum":["Pending","Success","Failed","Ongoing","PartialFailure"],"x-genesys-enum-members":[{"name":"Pending"},{"name":"Success"},{"name":"Failed"},{"name":"Ongoing"},{"name":"PartialFailure"}]},"errorDetails":{"type":"array","description":"If the request could not be properly processed, error details will be given here.","readOnly":true,"items":{"$ref":"#/definitions/ModelingProcessingError"}},"modelingResultUri":{"type":"string","description":"The uri of the modeling result. It has a value if the status is either 'Success', 'PartialFailure', or 'Failed'.","readOnly":true}}},"MessagingIntegration":{"type":"object","required":["id","messengerType","name","version"],"properties":{"id":{"type":"string","description":"A unique Integration Id","readOnly":true},"name":{"type":"string","description":"The name of the Integration","readOnly":true},"status":{"type":"string","description":"The status of the Integration","readOnly":true,"enum":["Active","Inactive","Error","Starting","Incomplete","Deleting","DeletionFailed"],"x-genesys-enum-members":[{"name":"Active"},{"name":"Inactive"},{"name":"Error"},{"name":"Starting"},{"name":"Incomplete"},{"name":"Deleting"},{"name":"DeletionFailed"}]},"messengerType":{"type":"string","description":"The type of Messaging Integration","readOnly":true,"enum":["sms","facebook","twitter","line","whatsapp","webmessaging"],"x-genesys-enum-members":[{"name":"sms"},{"name":"facebook"},{"name":"twitter"},{"name":"line"},{"name":"whatsapp"},{"name":"webmessaging"}]},"recipient":{"description":"The recipient associated to the Integration. This recipient is used to associate a flow to an integration","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"dateCreated":{"type":"string","format":"date-time","description":"Date this Integration was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Date this Integration was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"createdBy":{"description":"User reference that created this Integration","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"modifiedBy":{"description":"User reference that last modified this Integration","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"version":{"type":"integer","format":"int32","description":"Version number required for updates.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"MessagingIntegrationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/MessagingIntegration"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"NluConfusionMatrixColumn":{"type":"object","required":["name","value"],"properties":{"name":{"type":"string","description":"The name of the intent for the column."},"value":{"type":"number","format":"float","description":"The confusion value between the intents"}}},"NluConfusionMatrixRow":{"type":"object","required":["columns","name"],"properties":{"name":{"type":"string","description":"The name of the intent for the row."},"columns":{"type":"array","description":"The columns of confusion matrix for the intent","items":{"$ref":"#/definitions/NluConfusionMatrixColumn"}}}},"NluDomainVersionQualityReport":{"type":"object","required":["confusionMatrix","summary","version"],"properties":{"version":{"description":"The domain and version details of the quality report","$ref":"#/definitions/NluDomainVersion"},"confusionMatrix":{"type":"array","description":"The confusion matrix for the Domain Version","items":{"$ref":"#/definitions/NluConfusionMatrixRow"}},"summary":{"description":"The quality report summary for the Domain Version","$ref":"#/definitions/NluQualityReportSummary"}}},"NluQualityReportSummary":{"type":"object","required":["metrics"],"properties":{"metrics":{"type":"array","description":"The list of metrics in the summary","items":{"$ref":"#/definitions/NluQualityReportSummaryMetric"}}}},"NluQualityReportSummaryMetric":{"type":"object","required":["name","value"],"properties":{"name":{"type":"string","description":"The name of the metric. e.g. recall, f1_score"},"value":{"type":"number","format":"float","description":"The value of the metric"}}},"DetectedDialogAct":{"type":"object","properties":{"name":{"type":"string","description":"The name of the detected dialog act.","readOnly":true},"probability":{"type":"number","format":"double","description":"The probability of the detected dialog act.","readOnly":true}}},"DetectedIntent":{"type":"object","properties":{"name":{"type":"string","description":"The name of the detected intent.","readOnly":true},"probability":{"type":"number","format":"double","description":"The probability of the detected intent.","readOnly":true},"entities":{"type":"array","description":"The collection of named entities detected.","readOnly":true,"items":{"$ref":"#/definitions/DetectedNamedEntity"}}}},"NluDetectionInput":{"type":"object","required":["text"],"properties":{"text":{"type":"string","description":"The text to perform NLU detection on."}}},"NluDetectionOutput":{"type":"object","properties":{"intents":{"type":"array","description":"The detected intents.","readOnly":true,"items":{"$ref":"#/definitions/DetectedIntent"}},"dialogActs":{"type":"array","description":"The detected dialog acts.","readOnly":true,"items":{"$ref":"#/definitions/DetectedDialogAct"}}}},"NluDetectionResponse":{"type":"object","properties":{"version":{"description":"The NLU domain version which performed the detection.","readOnly":true,"$ref":"#/definitions/NluDomainVersion"},"output":{"$ref":"#/definitions/NluDetectionOutput"},"input":{"$ref":"#/definitions/NluDetectionInput"}}},"ContextEntity":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The name of the entity."}}},"ContextIntent":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The name of the intent."}}},"NluDetectionContext":{"type":"object","properties":{"intent":{"description":"Restrict detection to this intent.","$ref":"#/definitions/ContextIntent"},"entity":{"description":"Use this entity to restrict detection.","$ref":"#/definitions/ContextEntity"}}},"NluDetectionRequest":{"type":"object","required":["input"],"properties":{"input":{"description":"The input subject to NLU detection.","$ref":"#/definitions/NluDetectionInput"},"context":{"description":"The context for the input to NLU detection.","$ref":"#/definitions/NluDetectionContext"}}},"NluDomainVersionTrainingResponse":{"type":"object","properties":{"message":{"type":"string","description":"A message indicating result of the action.","readOnly":true},"version":{"$ref":"#/definitions/NluDomainVersion"}}},"GroupUpdate":{"type":"object","required":["version"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The group name."},"description":{"type":"string"},"state":{"type":"string","description":"State of the group.","enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"version":{"type":"integer","format":"int32","description":"Current version for this resource."},"images":{"type":"array","items":{"$ref":"#/definitions/UserImage"}},"addresses":{"type":"array","items":{"$ref":"#/definitions/GroupContact"}},"rulesVisible":{"type":"boolean","description":"Are membership rules visible to the person requesting to view the group"},"visibility":{"type":"string","description":"Who can view this group","enum":["public","ownerIds","members"]},"ownerIds":{"type":"array","description":"Owners of the group","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LocationCreateDefinition":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The name of the Location. Required for creates, not required for updates"},"version":{"type":"integer","format":"int32","description":"Current version of the location"},"state":{"type":"string","description":"Current activity status of the location.","enum":["active","deleted"]},"path":{"type":"array","description":"A list of ancestor ids","items":{"type":"string"}},"notes":{"type":"string","description":"Notes for the location"},"contactUser":{"type":"string","description":"The user id of the location contact"},"emergencyNumber":{"description":"Emergency number for the location","$ref":"#/definitions/LocationEmergencyNumber"},"address":{"description":"Address of the location","$ref":"#/definitions/LocationAddress"}}},"FlowMilestone":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The flow milestone identifier","readOnly":true},"name":{"type":"string","description":"The flow milestone name."},"description":{"type":"string","description":"The flow milestone description."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FlowMilestoneListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/FlowMilestone"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"MessagingCampaignDivisionViewEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/MessagingCampaignDivisionView"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"PINConfiguration":{"type":"object","properties":{"minimumLength":{"type":"integer","format":"int32"},"maximumLength":{"type":"integer","format":"int32"}}},"VoicemailOrganizationPolicy":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether voicemail is enable for this organization","readOnly":true},"alertTimeoutSeconds":{"type":"integer","format":"int32","description":"The organization's default number of seconds to ring a user's phone before a call is transfered to voicemail"},"pinConfiguration":{"description":"The configuration for user PINs to access their voicemail from a phone","$ref":"#/definitions/PINConfiguration"},"voicemailExtension":{"type":"string","description":"The extension for voicemail retrieval. The default value is *86."},"pinRequired":{"type":"boolean","description":"If this is true, a PIN is required when accessing a user's voicemail from a phone."},"sendEmailNotifications":{"type":"boolean","description":"Whether email notifications are sent for new voicemails in the organization. If false, new voicemail email notifications are not be sent for the organization overriding any user or group setting."},"modifiedDate":{"type":"string","format":"date-time","description":"The date the policy was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true}}},"WebChatDeploymentEntityListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/WebChatDeployment"}},"selfUri":{"type":"string","format":"uri"}}},"SMSAvailablePhoneNumberEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SmsAvailablePhoneNumber"}}}},"SmsAvailablePhoneNumber":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"phoneNumber":{"type":"string","description":"A phone number available for provisioning in E.164 format. E.g. +13175555555 or +34234234234"},"countryCode":{"type":"string","description":"The ISO 3166-1 alpha-2 country code of the country this phone number is associated with."},"region":{"type":"string","description":"The region/province/state the phone number is associated with."},"city":{"type":"string","description":"The city the phone number is associated with."},"capabilities":{"type":"array","description":"The capabilities of the phone number available for provisioning.","items":{"type":"string","enum":["sms","mms","voice"],"x-genesys-enum-members":[{"name":"sms"},{"name":"mms"},{"name":"voice"}]}},"phoneNumberType":{"type":"string","description":"The type of phone number available for provisioning.","enum":["local","mobile","tollfree","shortcode"],"x-genesys-enum-members":[{"name":"local"},{"name":"mobile"},{"name":"tollfree"},{"name":"shortcode"}]},"addressRequirement":{"type":"string","description":"The address requirement needed for provisioning this number. If there is a requirement, the address must be the residence or place of business of the individual or entity using the phone number.","enum":["none","any","local","foreign"],"x-genesys-enum-members":[{"name":"none"},{"name":"any"},{"name":"local"},{"name":"foreign"}]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PublishDraftInput":{"type":"object","required":["version"],"properties":{"version":{"type":"integer","format":"int32","example":"If the current draft version is 2 and the current published version of Action is 33, then you would send 2 here. (Your draft will become published version 34)","description":"The current draft version."}},"description":"Draft to be published"},"DraftValidationResult":{"type":"object","properties":{"valid":{"type":"boolean","description":"Indicates if configuration is valid"},"errors":{"type":"array","description":"List of errors causing validation failure","items":{"$ref":"#/definitions/ErrorBody"}}},"description":"Validation results"},"UpdateDraftInput":{"type":"object","required":["version"],"properties":{"category":{"type":"string","description":"Category of action, Can be up to 256 characters long"},"name":{"type":"string","description":"Name of action, Can be up to 256 characters long"},"config":{"description":"Configuration to support request and response processing","$ref":"#/definitions/ActionConfig"},"contract":{"description":"Action contract","$ref":"#/definitions/ActionContractInput"},"secure":{"type":"boolean","description":"Indication of whether or not the action is designed to accept sensitive data"},"version":{"type":"integer","format":"int32","description":"Version of current Draft"}},"description":"Definition of an Action Draft to be created or updated."},"SiteEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Site"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EmailSetup":{"type":"object","properties":{"rootDomain":{"type":"string","description":"The root PureCloud domain that all sub-domains are created from."}}},"UsersSearchResponse":{"type":"object","required":["pageCount","pageNumber","pageSize","results","total","types"],"properties":{"total":{"type":"integer","format":"int64","description":"The total number of results found"},"pageCount":{"type":"integer","format":"int32","description":"The total number of pages"},"pageSize":{"type":"integer","format":"int32","description":"The current page size"},"pageNumber":{"type":"integer","format":"int32","description":"The current page number"},"previousPage":{"type":"string","description":"Q64 value for the previous page of results"},"currentPage":{"type":"string","description":"Q64 value for the current page of results"},"nextPage":{"type":"string","description":"Q64 value for the next page of results"},"types":{"type":"array","description":"Resource types the search was performed against","items":{"type":"string"}},"results":{"type":"array","description":"Search results","items":{"$ref":"#/definitions/User"}}}},"UserSearchCriteria":{"type":"object","required":["type"],"properties":{"endValue":{"type":"string","description":"The end value of the range. This field is used for range search types."},"values":{"type":"array","description":"A list of values for the search to match against","items":{"type":"string"}},"startValue":{"type":"string","description":"The start value of the range. This field is used for range search types."},"fields":{"type":"array","description":"Field names to search against","items":{"type":"string"}},"value":{"type":"string","description":"A value for the search to match against"},"operator":{"type":"string","description":"How to apply this search criteria against other criteria","enum":["AND","OR","NOT"],"x-genesys-enum-members":[{"name":"AND"},{"name":"OR"},{"name":"NOT"}]},"group":{"type":"array","description":"Groups multiple conditions","items":{"$ref":"#/definitions/UserSearchCriteria"}},"dateFormat":{"type":"string","description":"Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."},"type":{"type":"string","description":"Search Type","enum":["EXACT","STARTS_WITH","CONTAINS","REGEX","TERM","TERMS","REQUIRED_FIELDS","MATCH_ALL","QUERY_STRING"],"x-genesys-enum-members":[{"name":"EXACT"},{"name":"STARTS_WITH"},{"name":"CONTAINS"},{"name":"REGEX"},{"name":"TERM"},{"name":"TERMS"},{"name":"REQUIRED_FIELDS"},{"name":"MATCH_ALL"},{"name":"QUERY_STRING"}]}}},"UserSearchRequest":{"type":"object","properties":{"sortOrder":{"type":"string","description":"The sort order for results","enum":["ASC","DESC","SCORE"],"x-genesys-enum-members":[{"name":"ASC"},{"name":"DESC"},{"name":"SCORE"}]},"sortBy":{"type":"string","description":"The field in the resource that you want to sort the results by"},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"},"pageNumber":{"type":"integer","format":"int32","description":"The page of resources you want to retrieve"},"sort":{"type":"array","description":"Multi-value sort order, list of multiple sort values","items":{"$ref":"#/definitions/SearchSort"}},"expand":{"type":"array","description":"Provides more details about a specified resource","items":{"type":"string"}},"query":{"type":"array","items":{"$ref":"#/definitions/UserSearchCriteria"}},"integrationPresenceSource":{"type":"string","description":"Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an \"expand\". When using this parameter the maximum number of users that can be returned is 10.","enum":["MicrosoftTeams","ZoomPhone","RingCentral"],"x-genesys-enum-members":[{"name":"MicrosoftTeams"},{"name":"ZoomPhone"},{"name":"RingCentral"}]},"enforcePermissions":{"type":"boolean","description":"Enforce view permission on request"}}},"ContactListEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ContactList"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"JourneyAggregateDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/StatisticalResponse"}}}},"JourneyAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/JourneyAggregateDataContainer"}}}},"JourneyAggregateQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/JourneyAggregateQueryPredicate"}}}},"JourneyAggregateQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/JourneyAggregateQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/JourneyAggregateQueryPredicate"}}}},"JourneyAggregateQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"],"x-genesys-enum-members":[{"name":"dimension"},{"name":"property"},{"name":"metric"}]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["journeyActionId","journeyActionMapId","journeyActionMapVersion","journeyActionMediaType","journeyActionTemplateId","journeyCustomerId","journeyCustomerIdType","journeyDeviceCategory","journeyDeviceType","journeyOutcomeId","journeySegmentId","journeySegmentScope","journeySessionSegmentId","journeySessionType","touchpointActionMapId"],"x-genesys-enum-members":[{"name":"journeyActionId"},{"name":"journeyActionMapId"},{"name":"journeyActionMapVersion"},{"name":"journeyActionMediaType"},{"name":"journeyActionTemplateId"},{"name":"journeyCustomerId"},{"name":"journeyCustomerIdType"},{"name":"journeyDeviceCategory"},{"name":"journeyDeviceType"},{"name":"journeyOutcomeId"},{"name":"journeySegmentId"},{"name":"journeySegmentScope"},{"name":"journeySessionSegmentId"},{"name":"journeySessionType"},{"name":"touchpointActionMapId"}]},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"],"x-genesys-enum-members":[{"name":"matches"},{"name":"exists"},{"name":"notExists"}]},"value":{"type":"string","description":"Right hand side for dimension predicates"},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"JourneyAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["journeyActionId","journeyActionMapId","journeyActionMapVersion","journeyActionMediaType","journeyActionTemplateId","journeyCustomerId","journeyCustomerIdType","journeyDeviceCategory","journeyDeviceType","journeyOutcomeId","journeySegmentId","journeySegmentScope","journeySessionSegmentId","journeySessionType","touchpointActionMapId"],"x-genesys-enum-members":[{"name":"journeyActionId"},{"name":"journeyActionMapId"},{"name":"journeyActionMapVersion"},{"name":"journeyActionMediaType"},{"name":"journeyActionTemplateId"},{"name":"journeyCustomerId"},{"name":"journeyCustomerIdType"},{"name":"journeyDeviceCategory"},{"name":"journeyDeviceType"},{"name":"journeyOutcomeId"},{"name":"journeySegmentId"},{"name":"journeySegmentScope"},{"name":"journeySessionSegmentId"},{"name":"journeySessionType"},{"name":"touchpointActionMapId"}]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/JourneyAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nJourneyOutcomesAchieved","nJourneyOutcomesAttributed","nJourneySegmentsAssigned","nJourneySessions","nWebActionsAbandoned","nWebActionsAccepted","nWebActionsEngaged","nWebActionsErrored","nWebActionsIgnored","nWebActionsOffered","nWebActionsQualified","nWebActionsQualifiedOutsideSchedule","nWebActionsRejected","nWebActionsStarted","nWebActionsTimedout","nWebActionsFrequencyCapReached","nWebActionsOfferedOutsideSchedule"],"x-genesys-enum-members":[{"name":"nJourneyOutcomesAchieved"},{"name":"nJourneyOutcomesAttributed"},{"name":"nJourneySegmentsAssigned"},{"name":"nJourneySessions"},{"name":"nWebActionsAbandoned"},{"name":"nWebActionsAccepted"},{"name":"nWebActionsEngaged"},{"name":"nWebActionsErrored"},{"name":"nWebActionsIgnored"},{"name":"nWebActionsOffered"},{"name":"nWebActionsQualified"},{"name":"nWebActionsQualifiedOutsideSchedule"},{"name":"nWebActionsRejected"},{"name":"nWebActionsStarted"},{"name":"nWebActionsTimedout"},{"name":"nWebActionsFrequencyCapReached"},{"name":"nWebActionsOfferedOutsideSchedule"}]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/JourneyAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"],"x-genesys-enum-members":[{"name":"eventTime"}]}}},"JourneyAggregationView":{"type":"object","required":["function","name","target"],"properties":{"target":{"type":"string","description":"Target metric name","enum":["nJourneyOutcomesAchieved","nJourneyOutcomesAttributed","nJourneySegmentsAssigned","nJourneySessions","nWebActionsAbandoned","nWebActionsAccepted","nWebActionsEngaged","nWebActionsErrored","nWebActionsIgnored","nWebActionsOffered","nWebActionsQualified","nWebActionsQualifiedOutsideSchedule","nWebActionsRejected","nWebActionsStarted","nWebActionsTimedout","nWebActionsFrequencyCapReached","nWebActionsOfferedOutsideSchedule"],"x-genesys-enum-members":[{"name":"nJourneyOutcomesAchieved"},{"name":"nJourneyOutcomesAttributed"},{"name":"nJourneySegmentsAssigned"},{"name":"nJourneySessions"},{"name":"nWebActionsAbandoned"},{"name":"nWebActionsAccepted"},{"name":"nWebActionsEngaged"},{"name":"nWebActionsErrored"},{"name":"nWebActionsIgnored"},{"name":"nWebActionsOffered"},{"name":"nWebActionsQualified"},{"name":"nWebActionsQualifiedOutsideSchedule"},{"name":"nWebActionsRejected"},{"name":"nWebActionsStarted"},{"name":"nWebActionsTimedout"},{"name":"nWebActionsFrequencyCapReached"},{"name":"nWebActionsOfferedOutsideSchedule"}]},"name":{"type":"string","description":"A unique name for this view. Must be distinct from other views and built-in metric names."},"function":{"type":"string","description":"Type of view you wish to create","enum":["rangeBound"],"x-genesys-enum-members":[{"name":"rangeBound"}]},"range":{"description":"Range of numbers for slicing up data","$ref":"#/definitions/AggregationRange"}}},"OrphanRecordingListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/OrphanRecording"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CreateCallbackOnConversationCommand":{"type":"object","required":["callbackNumbers"],"properties":{"scriptId":{"type":"string","description":"The identifier of the script to be used for the callback"},"queueId":{"type":"string","description":"The identifier of the queue to be used for the callback. Either queueId or routingData is required."},"routingData":{"description":"The routing data to be used for the callback. Either queueId or routingData is required.","$ref":"#/definitions/RoutingData"},"callbackUserName":{"type":"string","description":"The name of the party to be called back."},"callbackNumbers":{"type":"array","description":"A list of phone numbers for the callback.","items":{"type":"string"}},"callbackScheduledTime":{"type":"string","format":"date-time","example":"2015-01-02T16:59:59.000Z","description":"The scheduled date-time for the callback as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"countryCode":{"type":"string","description":"The country code to be associated with the callback numbers."},"validateCallbackNumbers":{"type":"boolean","description":"Whether or not to validate the callback numbers for phone number format."},"data":{"type":"object","description":"A map of key-value pairs containing additional data that can be associated to the callback. These values will appear in the attributes property on the conversation participant. Example: { \"notes\": \"ready to close the deal!\", \"customerPreferredName\": \"Doc\" }","additionalProperties":{"type":"string"}}}},"Digits":{"type":"object","properties":{"digits":{"type":"string","description":"A string representing the digits pressed on phone."}}},"IntegrationEventEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/IntegrationEvent"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"TranscriptAggregateDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/StatisticalResponse"}}}},"TranscriptAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/TranscriptAggregateDataContainer"}}}},"TranscriptAggregateQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/TranscriptAggregateQueryPredicate"}}}},"TranscriptAggregateQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/TranscriptAggregateQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/TranscriptAggregateQueryPredicate"}}}},"TranscriptAggregateQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"],"x-genesys-enum-members":[{"name":"dimension"},{"name":"property"},{"name":"metric"}]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["addressFrom","addressTo","ani","channel","conversationId","direction","divisionId","dnis","flowId","mediaType","messageType","queueId","teamId","userId"],"x-genesys-enum-members":[{"name":"addressFrom"},{"name":"addressTo"},{"name":"ani"},{"name":"channel"},{"name":"conversationId"},{"name":"direction"},{"name":"divisionId"},{"name":"dnis"},{"name":"flowId"},{"name":"mediaType"},{"name":"messageType"},{"name":"queueId"},{"name":"teamId"},{"name":"userId"}]},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"],"x-genesys-enum-members":[{"name":"matches"},{"name":"exists"},{"name":"notExists"}]},"value":{"type":"string","description":"Right hand side for dimension predicates"},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"TranscriptAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["addressFrom","addressTo","ani","channel","conversationId","direction","divisionId","dnis","flowId","mediaType","messageType","queueId","teamId","userId"],"x-genesys-enum-members":[{"name":"addressFrom"},{"name":"addressTo"},{"name":"ani"},{"name":"channel"},{"name":"conversationId"},{"name":"direction"},{"name":"divisionId"},{"name":"dnis"},{"name":"flowId"},{"name":"mediaType"},{"name":"messageType"},{"name":"queueId"},{"name":"teamId"},{"name":"userId"}]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/TranscriptAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nTopicCommunications","nTopicSegments","oCustomerSentiment"],"x-genesys-enum-members":[{"name":"nTopicCommunications"},{"name":"nTopicSegments"},{"name":"oCustomerSentiment"}]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/TranscriptAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"],"x-genesys-enum-members":[{"name":"eventTime"}]}}},"TranscriptAggregationView":{"type":"object","required":["function","name","target"],"properties":{"target":{"type":"string","description":"Target metric name","enum":["nTopicCommunications","nTopicSegments","oCustomerSentiment"],"x-genesys-enum-members":[{"name":"nTopicCommunications"},{"name":"nTopicSegments"},{"name":"oCustomerSentiment"}]},"name":{"type":"string","description":"A unique name for this view. Must be distinct from other views and built-in metric names."},"function":{"type":"string","description":"Type of view you wish to create","enum":["rangeBound"],"x-genesys-enum-members":[{"name":"rangeBound"}]},"range":{"description":"Range of numbers for slicing up data","$ref":"#/definitions/AggregationRange"}}},"VoicemailGroupPolicy":{"type":"object","properties":{"name":{"type":"string"},"group":{"description":"The group associated with the policy","readOnly":true,"$ref":"#/definitions/Group"},"enabled":{"type":"boolean","description":"Whether voicemail is enabled for the group"},"sendEmailNotifications":{"type":"boolean","description":"Whether email notifications are sent to group members when a new voicemail is received"},"rotateCallsSecs":{"type":"integer","format":"int32","description":"How many seconds to ring before rotating to the next member in the group"},"stopRingingAfterRotations":{"type":"integer","format":"int32","description":"How many rotations to go through"},"overflowGroupId":{"type":"string","description":" A fallback group to contact when all of the members in this group did not answer the call."},"groupAlertType":{"type":"string","description":"Specifies if the members in this group should be contacted randomly, in a specific order, or by round-robin.","enum":["RANDOM","ROUND_ROBIN","SEQUENTIAL"],"x-genesys-enum-members":[{"name":"RANDOM"},{"name":"ROUND_ROBIN"},{"name":"SEQUENTIAL"}]}}},"EdgeVersionInformation":{"type":"object","properties":{"softwareVersion":{"type":"string"}}},"EdgeVersionReport":{"type":"object","properties":{"oldestVersion":{"$ref":"#/definitions/EdgeVersionInformation"},"newestVersion":{"$ref":"#/definitions/EdgeVersionInformation"}}},"CreateShareResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"sharedEntityType":{"type":"string","enum":["DOCUMENT"],"x-genesys-enum-members":[{"name":"DOCUMENT"}]},"sharedEntity":{"$ref":"#/definitions/DomainEntityRef"},"memberType":{"type":"string","enum":["USER","GROUP","PUBLIC"],"x-genesys-enum-members":[{"name":"USER"},{"name":"GROUP"},{"name":"PUBLIC"}]},"member":{"$ref":"#/definitions/DomainEntityRef"},"sharedBy":{"$ref":"#/definitions/DomainEntityRef"},"workspace":{"$ref":"#/definitions/DomainEntityRef"},"succeeded":{"type":"array","items":{"$ref":"#/definitions/Share"}},"failed":{"type":"array","items":{"$ref":"#/definitions/Share"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CreateShareRequest":{"type":"object","required":["sharedEntity","sharedEntityType"],"properties":{"sharedEntityType":{"type":"string","description":"The share entity type","enum":["DOCUMENT"],"x-genesys-enum-members":[{"name":"DOCUMENT"}]},"sharedEntity":{"description":"The entity that will be shared","$ref":"#/definitions/SharedEntity"},"memberType":{"type":"string","enum":["USER","GROUP","PUBLIC"],"x-genesys-enum-members":[{"name":"USER"},{"name":"GROUP"},{"name":"PUBLIC"}]},"member":{"description":"The member that will have access to this share. Only required if a list of members is not provided.","$ref":"#/definitions/SharedEntity"},"members":{"type":"array","items":{"$ref":"#/definitions/CreateShareRequestMember"}}}},"CreateShareRequestMember":{"type":"object","properties":{"memberType":{"type":"string","enum":["USER","GROUP","PUBLIC"],"x-genesys-enum-members":[{"name":"USER"},{"name":"GROUP"},{"name":"PUBLIC"}]},"member":{"$ref":"#/definitions/MemberEntity"}}},"MemberEntity":{"type":"object","properties":{"id":{"type":"string"}}},"SharedEntity":{"type":"object","properties":{"id":{"type":"string"}}},"ShareEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Share"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"BillingUsage":{"type":"object","required":["name","resources","totalUsage"],"properties":{"name":{"type":"string","description":"Identifies the billable usage."},"totalUsage":{"type":"string","description":"The total amount of usage, expressed as a decimal number in string format."},"resources":{"type":"array","description":"The resources for which usage was observed (e.g. license users, devices).","items":{"$ref":"#/definitions/BillingUsageResource"}}}},"BillingUsageReport":{"type":"object","required":["endDate","startDate","usages"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"startDate":{"type":"string","format":"date-time","description":"The period start date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endDate":{"type":"string","format":"date-time","description":"The period end date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"status":{"type":"string","description":"Generation status of report","enum":["InProgress","Complete"],"x-genesys-enum-members":[{"name":"InProgress"},{"name":"Complete"}]},"usages":{"type":"array","description":"The usages for the given period.","items":{"$ref":"#/definitions/BillingUsage"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BillingUsageResource":{"type":"object","required":["date","name"],"properties":{"name":{"type":"string","description":"Identifies the resource (e.g. license user, device)."},"date":{"type":"string","format":"date-time","description":"The date that the usage was first observed by the billing subsystem. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"LineBaseEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/LineBase"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EmbeddedIntegration":{"type":"object","properties":{"enableWhitelist":{"type":"boolean"},"domainWhitelist":{"type":"array","items":{"type":"string"}}}},"RoutingSettings":{"type":"object","properties":{"resetAgentScoreOnPresenceChange":{"type":"boolean","description":"Reset agent score when agent presence changes from off-queue to on-queue"}}},"TranscriptionSettings":{"type":"object","required":["transcription","transcriptionConfidenceThreshold"],"properties":{"transcription":{"type":"string","description":"Setting to enable/disable transcription capability","enum":["Disabled","EnabledGlobally","EnabledQueueFlow"],"x-genesys-enum-members":[{"name":"Disabled"},{"name":"EnabledGlobally"},{"name":"EnabledQueueFlow"}]},"transcriptionConfidenceThreshold":{"type":"integer","format":"int32","description":"Configure confidence threshold. The possible values are from 1 to 100."},"contentSearchEnabled":{"type":"boolean","description":"Setting to enable/disable content search"}}},"ContactCenterSettings":{"type":"object","properties":{"removeSkillsFromBlindTransfer":{"type":"boolean","description":"Strip skills from transfer"}}},"ScheduleEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Schedule"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Salesforce":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"disabled":{"type":"boolean"},"issuerURI":{"type":"string"},"ssoTargetURI":{"type":"string"},"certificate":{"type":"string"},"certificates":{"type":"array","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SystemPromptAssetEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SystemPromptAsset"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ReportingExportMetadataJobListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ReportingExportMetadataJobResponse"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ReportingExportMetadataJobResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"viewType":{"type":"string","description":"The view type of the export metadata","enum":["QUEUE_PERFORMANCE_SUMMARY_VIEW","QUEUE_PERFORMANCE_DETAIL_VIEW","INTERACTION_SEARCH_VIEW","AGENT_PERFORMANCE_SUMMARY_VIEW","AGENT_PERFORMANCE_DETAIL_VIEW","AGENT_STATUS_SUMMARY_VIEW","AGENT_STATUS_DETAIL_VIEW","AGENT_EVALUATION_SUMMARY_VIEW","AGENT_EVALUATION_DETAIL_VIEW","AGENT_QUEUE_DETAIL_VIEW","AGENT_INTERACTION_DETAIL_VIEW","ABANDON_INSIGHTS_VIEW","SKILLS_PERFORMANCE_VIEW","SURVEY_FORM_PERFORMANCE_SUMMARY_VIEW","SURVEY_FORM_PERFORMANCE_DETAIL_VIEW","DNIS_PERFORMANCE_SUMMARY_VIEW","DNIS_PERFORMANCE_DETAIL_VIEW","WRAP_UP_PERFORMANCE_SUMMARY_VIEW","AGENT_WRAP_UP_PERFORMANCE_DETAIL_VIEW","QUEUE_ACTIVITY_SUMMARY_VIEW","QUEUE_ACTIVITY_DETAIL_VIEW","AGENT_QUEUE_ACTIVITY_SUMMARY_VIEW","QUEUE_AGENT_DETAIL_VIEW","QUEUE_INTERACTION_DETAIL_VIEW","AGENT_SCHEDULE_DETAIL_VIEW","IVR_PERFORMANCE_SUMMARY_VIEW","IVR_PERFORMANCE_DETAIL_VIEW","ANSWER_INSIGHTS_VIEW","HANDLE_INSIGHTS_VIEW","TALK_INSIGHTS_VIEW","HOLD_INSIGHTS_VIEW","ACW_INSIGHTS_VIEW","WAIT_INSIGHTS_VIEW","AGENT_WRAP_UP_PERFORMANCE_INTERVAL_DETAIL_VIEW","FLOW_OUTCOME_SUMMARY_VIEW","FLOW_OUTCOME_PERFORMANCE_DETAIL_VIEW","FLOW_OUTCOME_PERFORMANCE_INTERVAL_DETAIL_VIEW","FLOW_DESTINATION_SUMMARY_VIEW","FLOW_DESTINATION_DETAIL_VIEW","API_USAGE_VIEW","SCHEDULED_CALLBACKS_VIEW","CONTENT_SEARCH_VIEW","LANDING_PAGE","DASHBOARD_SUMMARY","DASHBOARD_DETAIL","JOURNEY_ACTION_MAP_SUMMARY_VIEW","JOURNEY_OUTCOME_SUMMARY_VIEW","JOURNEY_SEGMENT_SUMMARY_VIEW","AGENT_DEVELOPMENT_DETAIL_VIEW","AGENT_DEVELOPMENT_DETAIL_ME_VIEW","AGENT_DEVELOPMENT_SUMMARY_VIEW","AGENT_PERFORMANCE_ME_VIEW","AGENT_STATUS_ME_VIEW","AGENT_EVALUATION_ME_VIEW"],"x-genesys-enum-members":[{"name":"QUEUE_PERFORMANCE_SUMMARY_VIEW"},{"name":"QUEUE_PERFORMANCE_DETAIL_VIEW"},{"name":"INTERACTION_SEARCH_VIEW"},{"name":"AGENT_PERFORMANCE_SUMMARY_VIEW"},{"name":"AGENT_PERFORMANCE_DETAIL_VIEW"},{"name":"AGENT_STATUS_SUMMARY_VIEW"},{"name":"AGENT_STATUS_DETAIL_VIEW"},{"name":"AGENT_EVALUATION_SUMMARY_VIEW"},{"name":"AGENT_EVALUATION_DETAIL_VIEW"},{"name":"AGENT_QUEUE_DETAIL_VIEW"},{"name":"AGENT_INTERACTION_DETAIL_VIEW"},{"name":"ABANDON_INSIGHTS_VIEW"},{"name":"SKILLS_PERFORMANCE_VIEW"},{"name":"SURVEY_FORM_PERFORMANCE_SUMMARY_VIEW"},{"name":"SURVEY_FORM_PERFORMANCE_DETAIL_VIEW"},{"name":"DNIS_PERFORMANCE_SUMMARY_VIEW"},{"name":"DNIS_PERFORMANCE_DETAIL_VIEW"},{"name":"WRAP_UP_PERFORMANCE_SUMMARY_VIEW"},{"name":"AGENT_WRAP_UP_PERFORMANCE_DETAIL_VIEW"},{"name":"QUEUE_ACTIVITY_SUMMARY_VIEW"},{"name":"QUEUE_ACTIVITY_DETAIL_VIEW"},{"name":"AGENT_QUEUE_ACTIVITY_SUMMARY_VIEW"},{"name":"QUEUE_AGENT_DETAIL_VIEW"},{"name":"QUEUE_INTERACTION_DETAIL_VIEW"},{"name":"AGENT_SCHEDULE_DETAIL_VIEW"},{"name":"IVR_PERFORMANCE_SUMMARY_VIEW"},{"name":"IVR_PERFORMANCE_DETAIL_VIEW"},{"name":"ANSWER_INSIGHTS_VIEW"},{"name":"HANDLE_INSIGHTS_VIEW"},{"name":"TALK_INSIGHTS_VIEW"},{"name":"HOLD_INSIGHTS_VIEW"},{"name":"ACW_INSIGHTS_VIEW"},{"name":"WAIT_INSIGHTS_VIEW"},{"name":"AGENT_WRAP_UP_PERFORMANCE_INTERVAL_DETAIL_VIEW"},{"name":"FLOW_OUTCOME_SUMMARY_VIEW"},{"name":"FLOW_OUTCOME_PERFORMANCE_DETAIL_VIEW"},{"name":"FLOW_OUTCOME_PERFORMANCE_INTERVAL_DETAIL_VIEW"},{"name":"FLOW_DESTINATION_SUMMARY_VIEW"},{"name":"FLOW_DESTINATION_DETAIL_VIEW"},{"name":"API_USAGE_VIEW"},{"name":"SCHEDULED_CALLBACKS_VIEW"},{"name":"CONTENT_SEARCH_VIEW"},{"name":"LANDING_PAGE"},{"name":"DASHBOARD_SUMMARY"},{"name":"DASHBOARD_DETAIL"},{"name":"JOURNEY_ACTION_MAP_SUMMARY_VIEW"},{"name":"JOURNEY_OUTCOME_SUMMARY_VIEW"},{"name":"JOURNEY_SEGMENT_SUMMARY_VIEW"},{"name":"AGENT_DEVELOPMENT_DETAIL_VIEW"},{"name":"AGENT_DEVELOPMENT_DETAIL_ME_VIEW"},{"name":"AGENT_DEVELOPMENT_SUMMARY_VIEW"},{"name":"AGENT_PERFORMANCE_ME_VIEW"},{"name":"AGENT_STATUS_ME_VIEW"},{"name":"AGENT_EVALUATION_ME_VIEW"}]},"dateLimitations":{"type":"string","description":"The date limitations of the export metadata"},"requiredFilters":{"type":"array","description":"The list of required filters for the export metadata","items":{"type":"string"}},"supportedFilters":{"type":"array","description":"The list of supported filters for the export metadata","items":{"type":"string"}},"requiredColumnIds":{"type":"array","description":"The list of required column ids for the export metadata","items":{"type":"string"}},"dependentColumnIds":{"type":"object","description":"The list of dependent column ids for the export metadata","additionalProperties":{"type":"array","items":{"type":"string"}}},"availableColumnIds":{"type":"array","description":"The list of available column ids for the export metadata","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"RecordingSettings":{"type":"object","properties":{"maxSimultaneousStreams":{"type":"integer","format":"int32","description":"Maximum number of simultaneous screen recording streams"},"maxConfigurableScreenRecordingStreams":{"type":"integer","format":"int32","description":"Upper limit that maxSimultaneousStreams can be configured"}}},"SpeechTextAnalyticsSettingsResponse":{"type":"object","properties":{"defaultProgram":{"description":"Setting to choose name for the default program for topic detection","$ref":"#/definitions/AddressableEntityRef"},"expectedDialects":{"type":"array","description":"Setting to choose expected dialects","items":{"type":"string"}}}},"SpeechTextAnalyticsSettingsRequest":{"type":"object","properties":{"defaultProgramId":{"type":"string","description":"Setting to choose name for the default program for topic detection"},"expectedDialects":{"type":"array","description":"Setting to choose expected dialects","items":{"type":"string"}}}},"EstimatedWaitTimePredictions":{"type":"object","required":["results"],"properties":{"results":{"type":"array","description":"Returned upon a successful estimated wait time request.","items":{"$ref":"#/definitions/PredictionResults"}}}},"PredictionResults":{"type":"object","required":["estimatedWaitTimeSeconds","formula"],"properties":{"intent":{"type":"string","description":"Indicates the media type scope of this estimated wait time","enum":["ALL","CALL","CALLBACK","CHAT","EMAIL","SOCIALEXPRESSION","VIDEOCOMM","MESSAGE"],"x-genesys-enum-members":[{"name":"ALL"},{"name":"CALL"},{"name":"CALLBACK"},{"name":"CHAT"},{"name":"EMAIL"},{"name":"SOCIALEXPRESSION"},{"name":"VIDEOCOMM"},{"name":"MESSAGE"}]},"formula":{"type":"string","description":"Indicates the estimated wait time Formula","enum":["BEST","SIMPLE","ABANDON","PATIENCE_ABANDON"],"x-genesys-enum-members":[{"name":"BEST"},{"name":"SIMPLE"},{"name":"ABANDON"},{"name":"PATIENCE_ABANDON"}]},"estimatedWaitTimeSeconds":{"type":"integer","format":"int32","description":"Estimated wait time in seconds"}}},"DomainSchemaReference":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SchemaReferenceEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DomainSchemaReference"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ScimV2Group":{"type":"object","required":["displayName"],"properties":{"id":{"type":"string","description":"The ID of the SCIM resource. Set by the service provider. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readOnly\". \"returned\" is set to \"always\".","readOnly":true},"schemas":{"type":"array","description":"The list of supported schemas.","readOnly":true,"items":{"type":"string"}},"displayName":{"type":"string","description":"The display name of the group.","readOnly":true},"externalId":{"type":"string","description":"The external ID of the group. Set by the provisioning client. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readWrite\"."},"members":{"type":"array","description":"The list of members in the group.","items":{"$ref":"#/definitions/ScimV2MemberReference"}},"meta":{"description":"The metadata of the SCIM resource.","readOnly":true,"$ref":"#/definitions/ScimMetadata"}},"description":"Defines a SCIM group."},"ScimV2MemberReference":{"type":"object","properties":{"type":{"type":"string","description":"The type of SCIM resource.","readOnly":true,"enum":["User","Group","ServiceProviderConfig","ResourceType","Schema"],"x-genesys-enum-members":[{"name":"User"},{"name":"Group"},{"name":"ServiceProviderConfig"},{"name":"ResourceType"},{"name":"Schema"}]},"value":{"type":"string","description":"The ID of the group member. Can be \"userId\" or \"groupId\"."},"$ref":{"type":"string","format":"uri","description":"The reference URI of the SCIM resource.","readOnly":true}},"description":"Defines a reference to SCIM group members."},"ScimGroupListResponse":{"type":"object","properties":{"totalResults":{"type":"integer","format":"int64","description":"The total number of results.","readOnly":true},"startIndex":{"type":"integer","format":"int64","description":"The 1-based index of the first result returned by this request. Add this to \"itemsPerPage\" when requesting the next page of results.","readOnly":true},"itemsPerPage":{"type":"integer","format":"int64","description":"The number of resources returned per page.","readOnly":true},"Resources":{"type":"array","description":"The list of requested resources. If \"count\" is 0, then the list will be empty.","readOnly":true,"items":{"$ref":"#/definitions/ScimV2Group"}},"schemas":{"type":"array","description":"The list of supported schemas.","items":{"type":"string"}}},"description":"Defines a response for a list of SCIM groups."},"EdgeServiceStateRequest":{"type":"object","required":["inService"],"properties":{"inService":{"type":"boolean","description":"A boolean that sets the Edge in-service or out-of-service."},"callDrainingWaitTimeSeconds":{"type":"integer","format":"int32","description":"The number of seconds to wait for call draining to complete before initiating the reboot. A value of 0 will prevent call draining and all calls will disconnect immediately."}}},"PromptAssetEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/PromptAsset"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"PromptAssetCreate":{"type":"object","required":["language"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"promptId":{"type":"string","description":"Associated prompt ID","readOnly":true},"language":{"type":"string","description":"The prompt language."},"mediaUri":{"type":"string","description":"URI of the resource audio","readOnly":true},"ttsString":{"type":"string","description":"Text to speech of the resource"},"text":{"type":"string","description":"Text of the resource"},"uploadStatus":{"type":"string","description":"Audio upload status","readOnly":true,"enum":["created","uploaded","transcoded","transcodeFailed"],"x-genesys-enum-members":[{"name":"created"},{"name":"uploaded"},{"name":"transcoded"},{"name":"transcodeFailed"}]},"uploadUri":{"type":"string","description":"Upload URI for the resource audio","readOnly":true},"languageDefault":{"type":"boolean","description":"Whether or not this resource locale is the default for the language","readOnly":true},"tags":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"durationSeconds":{"type":"number","format":"double"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeDocument":{"type":"object","required":["languageCode","type"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"languageCode":{"type":"string","description":"Language of the document","enum":["en-US","de-DE"],"x-genesys-enum-members":[{"name":"en-US"},{"name":"de-DE"}]},"type":{"type":"string","description":"Document type","enum":["Faq"],"x-genesys-enum-members":[{"name":"Faq"}]},"faq":{"description":"FAQ document details","$ref":"#/definitions/DocumentFaq"},"dateCreated":{"type":"string","format":"date-time","description":"Document creation date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Document last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"categories":{"type":"array","description":"Document categories","items":{"$ref":"#/definitions/KnowledgeCategory"}},"knowledgeBase":{"description":"Knowledge base which document does belong to","readOnly":true,"$ref":"#/definitions/KnowledgeBase"},"externalUrl":{"type":"string","description":"External URL to the document"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeDocumentRequest":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Document type according to assigned template","enum":["Faq"],"x-genesys-enum-members":[{"name":"Faq"}]},"externalUrl":{"type":"string","description":"External Url to the document"},"faq":{"description":"Faq document details","$ref":"#/definitions/DocumentFaq"},"categories":{"type":"array","description":"Document categories","items":{"$ref":"#/definitions/DocumentCategoryInput"}}}},"DocumentListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/KnowledgeDocument"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"KnowledgeDocumentBulkRequest":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Document type according to assigned template","enum":["Faq"],"x-genesys-enum-members":[{"name":"Faq"}]},"externalUrl":{"type":"string","description":"External Url to the document"},"faq":{"description":"Faq document details","$ref":"#/definitions/DocumentFaq"},"categories":{"type":"array","description":"Document categories","items":{"$ref":"#/definitions/DocumentCategoryInput"}},"id":{"type":"string","description":"Identifier of document for update. Omit for create new Document."}}},"DomainPermission":{"type":"object","properties":{"domain":{"type":"string"},"entityType":{"type":"string"},"action":{"type":"string"},"label":{"type":"string"},"allowsConditions":{"type":"boolean"},"divisionAware":{"type":"boolean"}}},"DomainPermissionCollection":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"domain":{"type":"string"},"permissionMap":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/definitions/DomainPermission"}}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PermissionCollectionEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DomainPermissionCollection"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"RecordingJobEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/RecordingJob"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ConsumingResourcesEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Dependency"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ChangePasswordRequest":{"type":"object","required":["newPassword"],"properties":{"newPassword":{"type":"string","description":"The new password"}}},"ContentAttributeFilterItem":{"type":"object","properties":{"id":{"type":"string"},"operator":{"type":"string","enum":["IN","RANGE","EQUALS","NOTEQUALS","LESSTHAN","LESSTHANEQUALS","GREATERTHAN","GREATERTHANEQUALS","CONTAINS"],"x-genesys-enum-members":[{"name":"IN"},{"name":"RANGE"},{"name":"EQUALS"},{"name":"NOTEQUALS"},{"name":"LESSTHAN"},{"name":"LESSTHANEQUALS"},{"name":"GREATERTHAN"},{"name":"GREATERTHANEQUALS"},{"name":"CONTAINS"}]},"values":{"type":"array","items":{"type":"string"}}}},"ContentFacetFilterItem":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["NUMBER","STRING","DATE","BOOLEAN","LIST"],"x-genesys-enum-members":[{"name":"NUMBER"},{"name":"STRING"},{"name":"DATE"},{"name":"BOOLEAN"},{"name":"LIST"}]},"operator":{"type":"string","enum":["IN","RANGE","EQUALS","NOTEQUALS","LESSTHAN","LESSTHANEQUALS","GREATERTHAN","GREATERTHANEQUALS","CONTAINS"],"x-genesys-enum-members":[{"name":"IN"},{"name":"RANGE"},{"name":"EQUALS"},{"name":"NOTEQUALS"},{"name":"LESSTHAN"},{"name":"LESSTHANEQUALS"},{"name":"GREATERTHAN"},{"name":"GREATERTHANEQUALS"},{"name":"CONTAINS"}]},"values":{"type":"array","items":{"type":"string"}}}},"ContentQueryRequest":{"type":"object","properties":{"queryPhrase":{"type":"string"},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"facetNameRequests":{"type":"array","items":{"type":"string"}},"sort":{"type":"array","items":{"$ref":"#/definitions/ContentSortItem"}},"filters":{"type":"array","items":{"$ref":"#/definitions/ContentFacetFilterItem"}},"attributeFilters":{"type":"array","items":{"$ref":"#/definitions/ContentAttributeFilterItem"}},"includeShares":{"type":"boolean"}}},"ContentSortItem":{"type":"object","properties":{"name":{"type":"string"},"ascending":{"type":"boolean"}}},"PureEngage":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"disabled":{"type":"boolean"},"issuerURI":{"type":"string"},"ssoTargetURI":{"type":"string"},"certificate":{"type":"string"},"certificates":{"type":"array","items":{"type":"string"}},"autoProvisionUsers":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"IdentityNow":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"disabled":{"type":"boolean"},"issuerURI":{"type":"string"},"ssoTargetURI":{"type":"string"},"certificate":{"type":"string"},"certificates":{"type":"array","items":{"type":"string"}},"relyingPartyIdentifier":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"MetaData":{"type":"object","properties":{"pairing-token":{"type":"string"},"pairing-trust":{"type":"array","items":{"type":"string"}},"pairing-url":{"type":"string"}}},"VmPairingInfo":{"type":"object","properties":{"meta-data":{"description":"This is to be used to complete the setup process of a locally deployed virtual edge device.","$ref":"#/definitions/MetaData"},"edge-id":{"type":"string"},"auth-token":{"type":"string"},"org-id":{"type":"string"}}},"KnowledgeBaseListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/KnowledgeBase"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"WrapUpCodeReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."}}},"ActionTemplateListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ActionTemplate"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DevelopmentActivityAggregateQueryResponseData":{"type":"object","properties":{"interval":{"type":"string","description":"Specifies the range of due dates to be used for filtering. A maximum of 1 year can be specified in the range. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"metrics":{"type":"array","description":"The list of aggregated metrics","items":{"$ref":"#/definitions/DevelopmentActivityAggregateQueryResponseMetric"}}}},"DevelopmentActivityAggregateQueryResponseGroupedData":{"type":"object","properties":{"group":{"type":"object","description":"The group values for this data","additionalProperties":{"type":"string"}},"data":{"type":"array","description":"The metrics in this group","items":{"$ref":"#/definitions/DevelopmentActivityAggregateQueryResponseData"}}}},"DevelopmentActivityAggregateQueryResponseMetric":{"type":"object","properties":{"metric":{"type":"string","description":"The metric this applies to","enum":["nActivities","nPlannedActivities","nInProgressActivities","nCompleteActivities","nOverdueActivities","nInvalidScheduleActivities"],"x-genesys-enum-members":[{"name":"nActivities"},{"name":"nPlannedActivities"},{"name":"nInProgressActivities"},{"name":"nCompleteActivities"},{"name":"nOverdueActivities"},{"name":"nInvalidScheduleActivities"}]},"stats":{"description":"The aggregated values for this metric","$ref":"#/definitions/DevelopmentActivityAggregateQueryResponseStatistics"}}},"DevelopmentActivityAggregateQueryResponseStatistics":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"The count for this metric"}}},"DevelopmentActivityAggregateResponse":{"type":"object","properties":{"results":{"type":"array","description":"The results of the query","items":{"$ref":"#/definitions/DevelopmentActivityAggregateQueryResponseGroupedData"}}}},"DevelopmentActivityAggregateParam":{"type":"object","required":["filter","interval"],"properties":{"interval":{"type":"string","description":"Specifies the range of due dates to be used for filtering. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. 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"},"metrics":{"type":"array","description":"The list of metrics to be returned. If omitted, all metrics are returned.","items":{"type":"string","enum":["nActivities","nPlannedActivities","nInProgressActivities","nCompleteActivities","nOverdueActivities","nInvalidScheduleActivities"],"x-genesys-enum-members":[{"name":"nActivities"},{"name":"nPlannedActivities"},{"name":"nInProgressActivities"},{"name":"nCompleteActivities"},{"name":"nOverdueActivities"},{"name":"nInvalidScheduleActivities"}]}},"groupBy":{"type":"array","description":"Specifies if the aggregated data is combined into a single set of metrics (groupBy is empty or not specified), or contains an element per attendeeId (groupBy is \"attendeeId\")","items":{"type":"string","enum":["attendeeId"],"x-genesys-enum-members":[{"name":"attendeeId"}]}},"filter":{"description":"The filter applied to the data. This is ANDed with the interval parameter.","$ref":"#/definitions/DevelopmentActivityAggregateQueryRequestFilter"}}},"DevelopmentActivityAggregateQueryRequestClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"The logic used to combine the predicates","enum":["And","Or"],"x-genesys-enum-members":[{"name":"And"},{"name":"Or"}]},"predicates":{"type":"array","description":"The list of predicates used to filter the data","items":{"$ref":"#/definitions/DevelopmentActivityAggregateQueryRequestPredicate"}}}},"DevelopmentActivityAggregateQueryRequestFilter":{"type":"object","required":["clauses","type"],"properties":{"type":{"type":"string","description":"The logic used to combine the clauses","enum":["And","Or"],"x-genesys-enum-members":[{"name":"And"},{"name":"Or"}]},"clauses":{"type":"array","description":"The list of clauses used to filter the data. Note that clauses must filter by attendeeId and a maximum of 100 user IDs are allowed","items":{"$ref":"#/definitions/DevelopmentActivityAggregateQueryRequestClause"}}}},"DevelopmentActivityAggregateQueryRequestPredicate":{"type":"object","required":["dimension","value"],"properties":{"dimension":{"type":"string","description":"Each predicates specifies a dimension.","enum":["attendeeId","type","moduleId"],"x-genesys-enum-members":[{"name":"attendeeId"},{"name":"type"},{"name":"moduleId"}]},"value":{"type":"string","description":"Corresponding value for dimensions in predicates. If the dimensions is type, Valid Values: Informational, Coaching"}}},"WebChatMessageEntityList":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"entities":{"type":"array","items":{"$ref":"#/definitions/WebChatMessage"}},"previousPage":{"type":"string"},"next":{"type":"string"},"selfUri":{"type":"string","format":"uri"}}},"PatchAction":{"type":"object","required":["mediaType"],"properties":{"mediaType":{"type":"string","description":"Media type of action.","enum":["webchat","webMessagingOffer","contentOffer","integrationAction","architectFlow"],"x-genesys-enum-members":[{"name":"webchat"},{"name":"webMessagingOffer"},{"name":"contentOffer"},{"name":"integrationAction"},{"name":"architectFlow"}]},"actionTemplate":{"description":"Action template associated with the action map.","$ref":"#/definitions/ActionMapActionTemplate"},"architectFlowFields":{"description":"Architect Flow Id and input contract.","$ref":"#/definitions/ArchitectFlowFields"}}},"PatchActionMap":{"type":"object","required":["displayName","pageUrlConditions","triggerWithSegments"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"version":{"type":"integer","format":"int32","description":"The version of the action map."},"isActive":{"type":"boolean","description":"Whether the action map is active."},"displayName":{"type":"string","description":"Display name of the action map."},"triggerWithSegments":{"type":"array","description":"Trigger action map if any segment in the list is assigned to a given customer.","items":{"type":"string"}},"triggerWithEventConditions":{"type":"array","description":"List of event conditions that must be satisfied to trigger the action map.","items":{"$ref":"#/definitions/EventCondition"}},"triggerWithOutcomeProbabilityConditions":{"type":"array","description":"Probability conditions for outcomes that must be satisfied to trigger the action map.","items":{"$ref":"#/definitions/OutcomeProbabilityCondition"}},"pageUrlConditions":{"type":"array","description":"URL conditions that a page must match for web actions to be displayable.","items":{"$ref":"#/definitions/UrlCondition"}},"activation":{"description":"Type of activation.","$ref":"#/definitions/Activation"},"weight":{"type":"integer","format":"int32","description":"Weight of the action map with higher number denoting higher weight."},"action":{"description":"The action that will be executed if this action map is triggered.","$ref":"#/definitions/PatchAction"},"actionMapScheduleGroups":{"description":"The action map's associated schedule groups.","$ref":"#/definitions/PatchActionMapScheduleGroups"},"ignoreFrequencyCap":{"type":"boolean","description":"Override organization-level frequency cap and always offer web engagements from this action map."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"createdDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the action map was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the action map was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startDate":{"type":"string","format":"date-time","description":"Timestamp at which the action map is scheduled to start firing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endDate":{"type":"string","format":"date-time","description":"Timestamp at which the action map is scheduled to stop firing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"PatchActionMapScheduleGroups":{"type":"object","required":["actionMapScheduleGroup"],"properties":{"actionMapScheduleGroup":{"description":"The actions map's associated schedule group.","$ref":"#/definitions/ActionMapScheduleGroup"},"emergencyActionMapScheduleGroup":{"description":"The action map's associated emergency schedule group.","$ref":"#/definitions/ActionMapScheduleGroup"}}},"PatchActionProperties":{"type":"object","properties":{"webchatPrompt":{"type":"string","description":"Prompt message shown to user, used for webchat type action."},"webchatTitleText":{"type":"string","description":"Title shown to the user, used for webchat type action."},"webchatAcceptText":{"type":"string","description":"Accept button text shown to user, used for webchat type action."},"webchatDeclineText":{"type":"string","description":"Decline button text shown to user, used for webchat type action."},"webchatSurvey":{"description":"Survey provided to the user, used for webchat type action.","$ref":"#/definitions/PatchActionSurvey"}}},"PatchActionSurvey":{"type":"object","required":["questions"],"properties":{"questions":{"type":"array","description":"Questions shown to the user.","items":{"$ref":"#/definitions/PatchSurveyQuestion"}}}},"PatchSurveyQuestion":{"type":"object","required":["label"],"properties":{"type":{"type":"string","description":"Type of survey question.","enum":["text","hidden","select","checkbox","textarea"],"x-genesys-enum-members":[{"name":"text"},{"name":"hidden"},{"name":"select"},{"name":"checkbox"},{"name":"textarea"}]},"label":{"type":"string","description":"Label of question."},"customerProperty":{"type":"string","description":"The customer property that the answer maps to.","enum":["givenName","familyName","email","phone","gender","companyName"],"x-genesys-enum-members":[{"name":"givenName"},{"name":"familyName"},{"name":"email"},{"name":"phone"},{"name":"gender"},{"name":"companyName"}]},"choices":{"type":"array","description":"Choices available to user.","items":{"type":"string"}},"isMandatory":{"type":"boolean","description":"Whether answering this question is mandatory."}}},"FlowOutcomeListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/FlowOutcome"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FieldConfig":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"entityType":{"type":"string","enum":["person","group","org","externalContact"],"x-genesys-enum-members":[{"name":"person"},{"name":"group"},{"name":"org"},{"name":"externalContact"}]},"state":{"type":"string"},"sections":{"type":"array","items":{"$ref":"#/definitions/Section"}},"version":{"type":"string"},"schemaVersion":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FieldList":{"type":"object","properties":{"customLabels":{"type":"boolean"},"instructionText":{"type":"string"},"key":{"type":"string"},"labelKeys":{"type":"array","items":{"type":"string"}},"params":{"type":"object","additionalProperties":{"type":"object"}},"repeatable":{"type":"boolean"},"state":{"type":"string"},"type":{"type":"string"},"required":{"type":"boolean"}}},"Section":{"type":"object","properties":{"fieldList":{"type":"array","items":{"$ref":"#/definitions/FieldList"}},"instructionText":{"type":"string"},"key":{"type":"string"},"state":{"type":"string"}}},"CampaignDivisionView":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CampaignDivisionViewListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CampaignDivisionView"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EdgeNetworkDiagnostic":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EdgeNetworkDiagnosticRequest":{"type":"object","required":["host"],"properties":{"host":{"type":"string","description":"IPv4/6 address or host to be probed for connectivity. No port allowed."}}},"EdgeNetworkDiagnosticResponse":{"type":"object","properties":{"commandCorrelationId":{"type":"string","description":"UUID of each executed command on edge"},"diagnostics":{"type":"string","description":"Response string of executed command from edge"}}},"CampaignStats":{"type":"object","properties":{"contactRate":{"description":"Information regarding the campaign's connect rate","readOnly":true,"$ref":"#/definitions/ConnectRate"},"idleAgents":{"type":"integer","format":"int32","description":"Number of available agents not currently being utilized","readOnly":true},"effectiveIdleAgents":{"type":"number","format":"double","description":"Number of effective available agents not currently being utilized","readOnly":true},"adjustedCallsPerAgent":{"type":"number","format":"double","description":"Calls per agent adjusted by pace","readOnly":true},"outstandingCalls":{"type":"integer","format":"int32","description":"Number of campaign calls currently ongoing","readOnly":true},"scheduledCalls":{"type":"integer","format":"int32","description":"Number of campaign calls currently scheduled","readOnly":true}}},"ConnectRate":{"type":"object","properties":{"attempts":{"type":"integer","format":"int64","description":"Number of call attempts made","readOnly":true},"connects":{"type":"integer","format":"int64","description":"Number of calls with a live voice detected","readOnly":true},"connectRatio":{"type":"number","format":"double","description":"Ratio of connects to attempts","readOnly":true}}},"ConstraintConflictMessage":{"type":"object","properties":{"message":{"description":"Message for how to resolve a set of conflicted work plan constraints","$ref":"#/definitions/WorkPlanConstraintConflictMessage"},"conflictedConstraintMessages":{"type":"array","description":"Messages for the set of conflicted work plan constraints. Each element indicates the message of a work plan constraint that is conflicted in the set","items":{"$ref":"#/definitions/WorkPlanConstraintMessage"}}}},"ValidateWorkPlanMessages":{"type":"object","properties":{"violationMessages":{"type":"array","description":"Messages for work plan violating some rules such as no shifts in a work plan","items":{"$ref":"#/definitions/WorkPlanConfigurationViolationMessage"}},"constraintConflictMessage":{"description":"This field is not null when there is a set of work plan constraints that conflict thus agent schedules cannot be generated","$ref":"#/definitions/ConstraintConflictMessage"}}},"ValidateWorkPlanResponse":{"type":"object","properties":{"workPlan":{"description":"The work plan reference associated with this response","$ref":"#/definitions/WorkPlanReference"},"valid":{"type":"boolean","description":"Whether the work plan is valid or not"},"messages":{"description":"Validation messages for this work plan","$ref":"#/definitions/ValidateWorkPlanMessages"}}},"WorkPlanConfigurationViolationMessage":{"type":"object","properties":{"type":{"type":"string","description":"Type of configuration violation message for this work plan","enum":["ActivitiesOverlap","ActivityEndGreaterThanShiftStop","ActivityPaidTimeGreaterThanShiftPaidTime","ActivityStartBeforeShiftStart","ActivityStartGreaterThanEqualToShiftStop","ActivityStartIncrementMinutesNotDivisibleByScheduleIntervalMinutes","DailyExactPaidMinutes","DailyMaxTotalLessThanWeeklyMin","DailyMaxTotalLessThanWeeklyMinWithOptional","DailyMaxTotalLessThanWeeklyMinWithoutOptional","DailyMinTotalGreaterThanWeeklyMax","DailyMinTotalGreaterThanWeeklyMaxWithOptional","DailyMinTotalGreaterThanWeeklyMaxWithoutOptional","DailyRequiredDaysGreaterThanWeeklyMaxDays","DailyShiftHasNoDaysSelected","DailyShiftMaxPossibilitiesViolated","EarliestShiftStopIsTooLate","ExactPaidTimeNotDivisibleByGranularity","MaxConsecutiveWorkingDaysNoMoreThanDoubleMaxWorkingDaysPerWeek","MaxDaysOffPerPlanningPeriodNotCorrect","MaxPaidTimeIsMoreThanShiftLength","MaxPaidTimeNotDivisibleByGranularity","MaxPaidTimePerPlanningPeriod","MaxShifts","MinPaidTimeNotDivisibleByGranularity","MinPaidTimePerPlanningPeriod","NoShifts","PaidTimeGreaterThanMaxWorkTime","PaidTimeLessThanMinWorkTime","PaidTimeNotMetByShiftStartStop","ShiftDaysSelectMoreThanMinWorkingDays","ShiftStopEarlierThanStart","ShiftVarianceCannotBeMet","WeeklyExactPaidMinutes"],"x-genesys-enum-members":[{"name":"ActivitiesOverlap"},{"name":"ActivityEndGreaterThanShiftStop"},{"name":"ActivityPaidTimeGreaterThanShiftPaidTime"},{"name":"ActivityStartBeforeShiftStart"},{"name":"ActivityStartGreaterThanEqualToShiftStop"},{"name":"ActivityStartIncrementMinutesNotDivisibleByScheduleIntervalMinutes"},{"name":"DailyExactPaidMinutes"},{"name":"DailyMaxTotalLessThanWeeklyMin"},{"name":"DailyMaxTotalLessThanWeeklyMinWithOptional"},{"name":"DailyMaxTotalLessThanWeeklyMinWithoutOptional"},{"name":"DailyMinTotalGreaterThanWeeklyMax"},{"name":"DailyMinTotalGreaterThanWeeklyMaxWithOptional"},{"name":"DailyMinTotalGreaterThanWeeklyMaxWithoutOptional"},{"name":"DailyRequiredDaysGreaterThanWeeklyMaxDays"},{"name":"DailyShiftHasNoDaysSelected"},{"name":"DailyShiftMaxPossibilitiesViolated"},{"name":"EarliestShiftStopIsTooLate"},{"name":"ExactPaidTimeNotDivisibleByGranularity"},{"name":"MaxConsecutiveWorkingDaysNoMoreThanDoubleMaxWorkingDaysPerWeek"},{"name":"MaxDaysOffPerPlanningPeriodNotCorrect"},{"name":"MaxPaidTimeIsMoreThanShiftLength"},{"name":"MaxPaidTimeNotDivisibleByGranularity"},{"name":"MaxPaidTimePerPlanningPeriod"},{"name":"MaxShifts"},{"name":"MinPaidTimeNotDivisibleByGranularity"},{"name":"MinPaidTimePerPlanningPeriod"},{"name":"NoShifts"},{"name":"PaidTimeGreaterThanMaxWorkTime"},{"name":"PaidTimeLessThanMinWorkTime"},{"name":"PaidTimeNotMetByShiftStartStop"},{"name":"ShiftDaysSelectMoreThanMinWorkingDays"},{"name":"ShiftStopEarlierThanStart"},{"name":"ShiftVarianceCannotBeMet"},{"name":"WeeklyExactPaidMinutes"}]},"arguments":{"type":"array","description":"Arguments of the message that provide information about the misconfigured value or the threshold that is exceeded by the misconfigured value","items":{"$ref":"#/definitions/WorkPlanValidationMessageArgument"}},"severity":{"type":"string","description":"Severity of the message. A message with Error severity indicates the scheduler won't be able to produce schedules and thus the work plan is invalid.","enum":["Information","Warning","Error"],"x-genesys-enum-members":[{"name":"Information"},{"name":"Warning"},{"name":"Error"}]}}},"WorkPlanConstraintConflictMessage":{"type":"object","properties":{"type":{"type":"string","description":"Type of constraint conflict that can be resolved by clients in order to generate agent schedules","enum":["UnknownFix","WithPotentialFixes"],"x-genesys-enum-members":[{"name":"UnknownFix"},{"name":"WithPotentialFixes"}]},"arguments":{"type":"array","description":"The arguments to the type of the message that can help clients resolve validation issues","items":{"$ref":"#/definitions/WorkPlanValidationMessageArgument"}}}},"WorkPlanConstraintMessage":{"type":"object","properties":{"type":{"type":"string","description":"Type of the work plan constraint in this message","enum":["ActivityEarliestStartTimeMinutesFromMidnight","ActivityEarliestStartTimeMinutesFromShiftStart","ActivityLatestStartTimeMinutesFromMidnight","ActivityLatestStartTimeMinutesFromShiftStart","ActivityMinimumLengthFromShiftEndMinutes","ActivityMinimumLengthFromShiftStartMinutes","ActivityStartTimeIncrementInMinutes","PlanningPeriodMaximumDaysOff","PlanningPeriodMaximumPaidTimeMinutes","PlanningPeriodMinimumDaysOff","PlanningPeriodMinimumPaidTimeMinutes","ShiftDayOffRule","ShiftEarliestStartTimeMinutesFromMidnight","ShiftEarliestStopTimeMinutesFromMidnight","ShiftLatestStartTimeMinutesFromMidnight","ShiftLatestStopTimeMinutesFromMidnight","ShiftMaximumContiguousTimeMinutes","ShiftMaximumPaidTimeMinutes","ShiftMinimumContiguousTimeMinutes","ShiftMinimumPaidTimeMinutes","ShiftStartTimeIncrementInMinutes","ShiftStartVarianceMaximumVarianceMinutes","ShiftStartVariancePaidDuration","WorkPlanMaximumConsecutiveWorkingDays","WorkPlanMaximumConsecutiveWorkingWeekends","WorkPlanMaximumWeeklyPaidTimeMinutes","WorkPlanMaximumWorkingDaysPerWeek","WorkPlanMinimumConsecutiveNonWorkingTimePerWeekMinutes","WorkPlanMinimumInterShiftTimeMinutes","WorkPlanMinimumShiftStartDistanceMinutes","WorkPlanMinimumWeeklyPaidTimeMinutes","WorkPlanMinimumWorkingDaysPerWeek","WorkPlanOptionalDays","WorkPlanPaidTimeGranularityMinutes"],"x-genesys-enum-members":[{"name":"ActivityEarliestStartTimeMinutesFromMidnight"},{"name":"ActivityEarliestStartTimeMinutesFromShiftStart"},{"name":"ActivityLatestStartTimeMinutesFromMidnight"},{"name":"ActivityLatestStartTimeMinutesFromShiftStart"},{"name":"ActivityMinimumLengthFromShiftEndMinutes"},{"name":"ActivityMinimumLengthFromShiftStartMinutes"},{"name":"ActivityStartTimeIncrementInMinutes"},{"name":"PlanningPeriodMaximumDaysOff"},{"name":"PlanningPeriodMaximumPaidTimeMinutes"},{"name":"PlanningPeriodMinimumDaysOff"},{"name":"PlanningPeriodMinimumPaidTimeMinutes"},{"name":"ShiftDayOffRule"},{"name":"ShiftEarliestStartTimeMinutesFromMidnight"},{"name":"ShiftEarliestStopTimeMinutesFromMidnight"},{"name":"ShiftLatestStartTimeMinutesFromMidnight"},{"name":"ShiftLatestStopTimeMinutesFromMidnight"},{"name":"ShiftMaximumContiguousTimeMinutes"},{"name":"ShiftMaximumPaidTimeMinutes"},{"name":"ShiftMinimumContiguousTimeMinutes"},{"name":"ShiftMinimumPaidTimeMinutes"},{"name":"ShiftStartTimeIncrementInMinutes"},{"name":"ShiftStartVarianceMaximumVarianceMinutes"},{"name":"ShiftStartVariancePaidDuration"},{"name":"WorkPlanMaximumConsecutiveWorkingDays"},{"name":"WorkPlanMaximumConsecutiveWorkingWeekends"},{"name":"WorkPlanMaximumWeeklyPaidTimeMinutes"},{"name":"WorkPlanMaximumWorkingDaysPerWeek"},{"name":"WorkPlanMinimumConsecutiveNonWorkingTimePerWeekMinutes"},{"name":"WorkPlanMinimumInterShiftTimeMinutes"},{"name":"WorkPlanMinimumShiftStartDistanceMinutes"},{"name":"WorkPlanMinimumWeeklyPaidTimeMinutes"},{"name":"WorkPlanMinimumWorkingDaysPerWeek"},{"name":"WorkPlanOptionalDays"},{"name":"WorkPlanPaidTimeGranularityMinutes"}]},"arguments":{"type":"array","description":"Arguments of the message that provide information about the constraint that is being conflicted with, such as the value of the constraint","items":{"$ref":"#/definitions/WorkPlanValidationMessageArgument"}}}},"WorkPlanValidationMessageArgument":{"type":"object","properties":{"type":{"type":"string","description":"The type of the argument associated with violation messages","enum":["ActivityId","ActivityId2","ActivityPaidTimeMinutes","ActivityStartTimeMinutes","ActivityValidationId","ActivityValidationId2","ApplicableDays","Count","DailyPaidTimeMinutes","MaximumDays","MaxShiftCount","Minutes","PaidTimeGranularityMinutes","RequiredDays","ShiftId","ShiftPaidTimeMinutes","ShiftStartTimeMinutes","ShiftStopTimeMinutes","ShiftValidationId","WeeklyPaidTimeMinutes","Weeks","WorkTimeMinutes"],"x-genesys-enum-members":[{"name":"ActivityId"},{"name":"ActivityId2"},{"name":"ActivityPaidTimeMinutes"},{"name":"ActivityStartTimeMinutes"},{"name":"ActivityValidationId"},{"name":"ActivityValidationId2"},{"name":"ApplicableDays"},{"name":"Count"},{"name":"DailyPaidTimeMinutes"},{"name":"MaximumDays"},{"name":"MaxShiftCount"},{"name":"Minutes"},{"name":"PaidTimeGranularityMinutes"},{"name":"RequiredDays"},{"name":"ShiftId"},{"name":"ShiftPaidTimeMinutes"},{"name":"ShiftStartTimeMinutes"},{"name":"ShiftStopTimeMinutes"},{"name":"ShiftValidationId"},{"name":"WeeklyPaidTimeMinutes"},{"name":"Weeks"},{"name":"WorkTimeMinutes"}]},"value":{"type":"string","description":"The value of the argument"}}},"DeletableUserReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"delete":{"type":"boolean","description":"If marked true, the user will be removed an associated entity"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"User reference with delete flag to remove the user from an associated entity"},"ListWrapperShiftStartVariance":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/definitions/ShiftStartVariance"}}}},"SetWrapperDayOfWeek":{"type":"object","properties":{"values":{"type":"array","uniqueItems":true,"items":{"type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"x-genesys-enum-members":[{"name":"Sunday"},{"name":"Monday"},{"name":"Tuesday"},{"name":"Wednesday"},{"name":"Thursday"},{"name":"Friday"},{"name":"Saturday"}]}}}},"ShiftStartVariance":{"type":"object","required":["applicableDays","maxShiftStartVarianceMinutes"],"properties":{"applicableDays":{"type":"array","description":"Days for which shift start variance is configured","uniqueItems":true,"items":{"type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"x-genesys-enum-members":[{"name":"Sunday"},{"name":"Monday"},{"name":"Tuesday"},{"name":"Wednesday"},{"name":"Thursday"},{"name":"Friday"},{"name":"Saturday"}]}},"maxShiftStartVarianceMinutes":{"type":"integer","format":"int32","description":"Maximum variance in minutes across shift starts"}},"description":"Variance in minutes among start times of shifts in work plan"},"WorkPlanActivity":{"type":"object","properties":{"activityCodeId":{"type":"string","description":"ID of the activity code associated with this activity"},"description":{"type":"string","description":"Description of the activity"},"lengthMinutes":{"type":"integer","format":"int32","description":"Length of the activity in minutes"},"startTimeIsRelativeToShiftStart":{"type":"boolean","description":"Whether the start time of the activity is relative to the start time of the shift it belongs to"},"flexibleStartTime":{"type":"boolean","description":"Whether the start time of the activity is flexible"},"earliestStartTimeMinutes":{"type":"integer","format":"int32","description":"Earliest activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == true"},"latestStartTimeMinutes":{"type":"integer","format":"int32","description":"Latest activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == true"},"exactStartTimeMinutes":{"type":"integer","format":"int32","description":"Exact activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == false"},"startTimeIncrementMinutes":{"type":"integer","format":"int32","description":"Increment in offset minutes that would contribute to different possible start times for the activity"},"countsAsPaidTime":{"type":"boolean","description":"Whether the activity is paid"},"countsAsContiguousWorkTime":{"type":"boolean","description":"Whether the activity duration is counted towards contiguous work time"},"id":{"type":"string","description":"ID of the activity. This is required only for the case of updating an existing activity"},"delete":{"type":"boolean","description":"If marked true for updating an existing activity, the activity will be permanently deleted"}},"description":"Activity configured for shift in work plan"},"WorkPlanShift":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name of the shift"},"days":{"description":"Days of the week applicable for this shift","$ref":"#/definitions/SetWrapperDayOfWeek"},"flexibleStartTime":{"type":"boolean","description":"Whether the start time of the shift is flexible"},"exactStartTimeMinutesFromMidnight":{"type":"integer","format":"int32","description":"Exact start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == false"},"earliestStartTimeMinutesFromMidnight":{"type":"integer","format":"int32","description":"Earliest start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == true"},"latestStartTimeMinutesFromMidnight":{"type":"integer","format":"int32","description":"Latest start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == true"},"constrainStopTime":{"type":"boolean","description":"Whether the latest stop time constraint for the shift is enabled. Deprecated, use constrainLatestStopTime instead"},"constrainLatestStopTime":{"type":"boolean","description":"Whether the latest stop time constraint for the shift is enabled"},"latestStopTimeMinutesFromMidnight":{"type":"integer","format":"int32","description":"Latest stop time of the shift defined as offset minutes from midnight. Used if constrainStopTime == true"},"startIncrementMinutes":{"type":"integer","format":"int32","description":"Increment in offset minutes that would contribute to different possible start times for the shift. Used if flexibleStartTime == true"},"flexiblePaidTime":{"type":"boolean","description":"Whether the paid time setting for the shift is flexible"},"exactPaidTimeMinutes":{"type":"integer","format":"int32","description":"Exact paid time in minutes configured for the shift. Used if flexiblePaidTime == false"},"minimumPaidTimeMinutes":{"type":"integer","format":"int32","description":"Minimum paid time in minutes configured for the shift. Used if flexiblePaidTime == true"},"maximumPaidTimeMinutes":{"type":"integer","format":"int32","description":"Maximum paid time in minutes configured for the shift. Used if flexiblePaidTime == true"},"constrainContiguousWorkTime":{"type":"boolean","description":"Whether the contiguous time constraint for the shift is enabled"},"minimumContiguousWorkTimeMinutes":{"type":"integer","format":"int32","description":"Minimum contiguous time in minutes configured for the shift. Used if constrainContiguousWorkTime == true"},"maximumContiguousWorkTimeMinutes":{"type":"integer","format":"int32","description":"Maximum contiguous time in minutes configured for the shift. Used if constrainContiguousWorkTime == true"},"activities":{"type":"array","description":"Activities configured for this shift","items":{"$ref":"#/definitions/WorkPlanActivity"}},"id":{"type":"string","description":"ID of the shift. This is required only for the case of updating an existing shift"},"delete":{"type":"boolean","description":"If marked true for updating an existing shift, the shift will be permanently deleted"}},"description":"Shift in a work plan"},"WorkPlanValidationRequest":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"enabled":{"type":"boolean","description":"Whether the work plan is enabled for scheduling"},"constrainWeeklyPaidTime":{"type":"boolean","description":"Whether the weekly paid time constraint is enabled for this work plan"},"flexibleWeeklyPaidTime":{"type":"boolean","description":"Whether the weekly paid time constraint is flexible for this work plan"},"weeklyExactPaidMinutes":{"type":"integer","format":"int32","description":"Exact weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == false"},"weeklyMinimumPaidMinutes":{"type":"integer","format":"int32","description":"Minimum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true"},"weeklyMaximumPaidMinutes":{"type":"integer","format":"int32","description":"Maximum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true"},"constrainPaidTimeGranularity":{"type":"boolean","description":"Whether paid time granularity is constrained for this workplan"},"paidTimeGranularityMinutes":{"type":"integer","format":"int32","description":"Granularity in minutes allowed for shift paid time in this work plan. Used if constrainPaidTimeGranularity == true"},"constrainMinimumTimeBetweenShifts":{"type":"boolean","description":"Whether the minimum time between shifts constraint is enabled for this work plan"},"minimumTimeBetweenShiftsMinutes":{"type":"integer","format":"int32","description":"Minimum time between shifts in minutes defined in this work plan. Used if constrainMinimumTimeBetweenShifts == true"},"maximumDays":{"type":"integer","format":"int32","description":"Maximum number days in a week allowed to be scheduled for this work plan"},"minimumWorkingDaysPerWeek":{"type":"integer","format":"int32","description":"The minimum number of days that agents assigned to a work plan must work per week"},"optionalDays":{"description":"Optional days to schedule for this work plan","$ref":"#/definitions/SetWrapperDayOfWeek"},"shiftStartVariances":{"description":"Variance in minutes among start times of shifts in this work plan","$ref":"#/definitions/ListWrapperShiftStartVariance"},"shifts":{"type":"array","description":"Shifts in this work plan","items":{"$ref":"#/definitions/WorkPlanShift"}},"agents":{"type":"array","description":"Agents in this work plan","items":{"$ref":"#/definitions/DeletableUserReference"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Work plan information"},"WorkPlan":{"type":"object","required":["metadata"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"enabled":{"type":"boolean","description":"Whether the work plan is enabled for scheduling"},"constrainWeeklyPaidTime":{"type":"boolean","description":"Whether the weekly paid time constraint is enabled for this work plan"},"flexibleWeeklyPaidTime":{"type":"boolean","description":"Whether the weekly paid time constraint is flexible for this work plan"},"weeklyExactPaidMinutes":{"type":"integer","format":"int32","description":"Exact weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == false"},"weeklyMinimumPaidMinutes":{"type":"integer","format":"int32","description":"Minimum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true"},"weeklyMaximumPaidMinutes":{"type":"integer","format":"int32","description":"Maximum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true"},"constrainPaidTimeGranularity":{"type":"boolean","description":"Whether paid time granularity is constrained for this workplan"},"paidTimeGranularityMinutes":{"type":"integer","format":"int32","description":"Granularity in minutes allowed for shift paid time in this work plan. Used if constrainPaidTimeGranularity == true"},"constrainMinimumTimeBetweenShifts":{"type":"boolean","description":"Whether the minimum time between shifts constraint is enabled for this work plan"},"minimumTimeBetweenShiftsMinutes":{"type":"integer","format":"int32","description":"Minimum time between shifts in minutes defined in this work plan. Used if constrainMinimumTimeBetweenShifts == true"},"maximumDays":{"type":"integer","format":"int32","description":"Maximum number days in a week allowed to be scheduled for this work plan"},"minimumWorkingDaysPerWeek":{"type":"integer","format":"int32","description":"The minimum number of days that agents assigned to a work plan must work per week"},"optionalDays":{"description":"Optional days to schedule for this work plan","$ref":"#/definitions/SetWrapperDayOfWeek"},"shiftStartVariances":{"description":"Variance in minutes among start times of shifts in this work plan","$ref":"#/definitions/ListWrapperShiftStartVariance"},"shifts":{"type":"array","description":"Shifts in this work plan","items":{"$ref":"#/definitions/WorkPlanShift"}},"agents":{"type":"array","description":"Agents in this work plan","items":{"$ref":"#/definitions/DeletableUserReference"}},"metadata":{"description":"Version metadata for this work plan","$ref":"#/definitions/WfmVersionedEntityMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Work plan information"},"CreateWorkPlan":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name of this work plan"},"enabled":{"type":"boolean","description":"Whether the work plan is enabled for scheduling"},"constrainWeeklyPaidTime":{"type":"boolean","description":"Whether the weekly paid time constraint is enabled for this work plan"},"flexibleWeeklyPaidTime":{"type":"boolean","description":"Whether the weekly paid time constraint is flexible for this work plan"},"weeklyExactPaidMinutes":{"type":"integer","format":"int32","description":"Exact weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == false"},"weeklyMinimumPaidMinutes":{"type":"integer","format":"int32","description":"Minimum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true"},"weeklyMaximumPaidMinutes":{"type":"integer","format":"int32","description":"Maximum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true"},"constrainPaidTimeGranularity":{"type":"boolean","description":"Whether paid time granularity should be constrained for this workplan"},"paidTimeGranularityMinutes":{"type":"integer","format":"int32","description":"Granularity in minutes allowed for shift paid time in this work plan. Used if constrainPaidTimeGranularity == true"},"constrainMinimumTimeBetweenShifts":{"type":"boolean","description":"Whether the minimum time between shifts constraint is enabled for this work plan"},"minimumTimeBetweenShiftsMinutes":{"type":"integer","format":"int32","description":"Minimum time between shifts in minutes defined in this work plan. Used if constrainMinimumTimeBetweenShifts == true"},"maximumDays":{"type":"integer","format":"int32","description":"Maximum number days in a week allowed to be scheduled for this work plan"},"minimumWorkingDaysPerWeek":{"type":"integer","format":"int32","description":"The minimum number of days that agents assigned to a work plan must work per week"},"optionalDays":{"description":"Optional days to schedule for this work plan","$ref":"#/definitions/SetWrapperDayOfWeek"},"shiftStartVariances":{"description":"Variance in minutes among start times of shifts in this work plan","$ref":"#/definitions/ListWrapperShiftStartVariance"},"shifts":{"type":"array","description":"Shifts in this work plan","items":{"$ref":"#/definitions/CreateWorkPlanShift"}},"agents":{"type":"array","description":"Agents in this work plan","items":{"$ref":"#/definitions/UserReference"}}},"description":"Work plan information"},"CreateWorkPlanActivity":{"type":"object","properties":{"activityCodeId":{"type":"string","description":"ID of the activity code associated with this activity"},"description":{"type":"string","description":"Description of the activity"},"lengthMinutes":{"type":"integer","format":"int32","description":"Length of the activity in minutes"},"startTimeIsRelativeToShiftStart":{"type":"boolean","description":"Whether the start time of the activity is relative to the start time of the shift it belongs to"},"flexibleStartTime":{"type":"boolean","description":"Whether the start time of the activity is flexible"},"earliestStartTimeMinutes":{"type":"integer","format":"int32","description":"Earliest activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == true"},"latestStartTimeMinutes":{"type":"integer","format":"int32","description":"Latest activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == true"},"exactStartTimeMinutes":{"type":"integer","format":"int32","description":"Exact activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == false"},"startTimeIncrementMinutes":{"type":"integer","format":"int32","description":"Increment in offset minutes that would contribute to different possible start times for the activity"},"countsAsPaidTime":{"type":"boolean","description":"Whether the activity is paid"},"countsAsContiguousWorkTime":{"type":"boolean","description":"Whether the activity duration is counted towards contiguous work time"}},"description":"Activity configured for shift in work plan"},"CreateWorkPlanShift":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name of the shift"},"days":{"description":"Days of the week applicable for this shift","$ref":"#/definitions/SetWrapperDayOfWeek"},"flexibleStartTime":{"type":"boolean","description":"Whether the start time of the shift is flexible"},"exactStartTimeMinutesFromMidnight":{"type":"integer","format":"int32","description":"Exact start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == false"},"earliestStartTimeMinutesFromMidnight":{"type":"integer","format":"int32","description":"Earliest start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == true"},"latestStartTimeMinutesFromMidnight":{"type":"integer","format":"int32","description":"Latest start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == true"},"constrainStopTime":{"type":"boolean","description":"Whether the latest stop time constraint for the shift is enabled. Deprecated, use constrainLatestStopTime instead"},"constrainLatestStopTime":{"type":"boolean","description":"Whether the latest stop time constraint for the shift is enabled"},"latestStopTimeMinutesFromMidnight":{"type":"integer","format":"int32","description":"Latest stop time of the shift defined as offset minutes from midnight. Used if constrainStopTime == true"},"startIncrementMinutes":{"type":"integer","format":"int32","description":"Increment in offset minutes that would contribute to different possible start times for the shift. Used if flexibleStartTime == true"},"flexiblePaidTime":{"type":"boolean","description":"Whether the paid time setting for the shift is flexible"},"exactPaidTimeMinutes":{"type":"integer","format":"int32","description":"Exact paid time in minutes configured for the shift. Used if flexiblePaidTime == false"},"minimumPaidTimeMinutes":{"type":"integer","format":"int32","description":"Minimum paid time in minutes configured for the shift. Used if flexiblePaidTime == true"},"maximumPaidTimeMinutes":{"type":"integer","format":"int32","description":"Maximum paid time in minutes configured for the shift. Used if flexiblePaidTime == true"},"constrainContiguousWorkTime":{"type":"boolean","description":"Whether the contiguous time constraint for the shift is enabled"},"minimumContiguousWorkTimeMinutes":{"type":"integer","format":"int32","description":"Minimum contiguous time in minutes configured for the shift. Used if constrainContiguousWorkTime == true"},"maximumContiguousWorkTimeMinutes":{"type":"integer","format":"int32","description":"Maximum contiguous time in minutes configured for the shift. Used if constrainContiguousWorkTime == true"},"activities":{"type":"array","description":"Activities configured for this shift","items":{"$ref":"#/definitions/CreateWorkPlanActivity"}}},"description":"Shift in a work plan"},"CopyWorkPlan":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name of the copied work plan"}},"description":"Information associated with a work plan thats created as a copy"},"WorkPlanListItemResponse":{"type":"object","required":["metadata"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"enabled":{"type":"boolean","description":"Whether the work plan is enabled for scheduling"},"constrainWeeklyPaidTime":{"type":"boolean","description":"Whether the weekly paid time constraint is enabled for this work plan"},"flexibleWeeklyPaidTime":{"type":"boolean","description":"Whether the weekly paid time constraint is flexible for this work plan"},"weeklyExactPaidMinutes":{"type":"integer","format":"int32","description":"Exact weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == false"},"weeklyMinimumPaidMinutes":{"type":"integer","format":"int32","description":"Minimum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true"},"weeklyMaximumPaidMinutes":{"type":"integer","format":"int32","description":"Maximum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true"},"constrainPaidTimeGranularity":{"type":"boolean","description":"Whether paid time granularity is constrained for this workplan"},"paidTimeGranularityMinutes":{"type":"integer","format":"int32","description":"Granularity in minutes allowed for shift paid time in this work plan. Used if constrainPaidTimeGranularity == true"},"constrainMinimumTimeBetweenShifts":{"type":"boolean","description":"Whether the minimum time between shifts constraint is enabled for this work plan"},"minimumTimeBetweenShiftsMinutes":{"type":"integer","format":"int32","description":"Minimum time between shifts in minutes defined in this work plan. Used if constrainMinimumTimeBetweenShifts == true"},"maximumDays":{"type":"integer","format":"int32","description":"Maximum number days in a week allowed to be scheduled for this work plan"},"minimumWorkingDaysPerWeek":{"type":"integer","format":"int32","description":"The minimum number of days that agents assigned to a work plan must work per week"},"optionalDays":{"description":"Optional days to schedule for this work plan. Populate with expand=details","$ref":"#/definitions/SetWrapperDayOfWeek"},"shiftStartVariances":{"description":"Variance in minutes among start times of shifts in this work plan. Populate with expand=details","$ref":"#/definitions/ListWrapperShiftStartVariance"},"shifts":{"type":"array","description":"Shifts in this work plan. Populate with expand=details (defaults to empty list)","items":{"$ref":"#/definitions/WorkPlanShift"}},"agents":{"type":"array","description":"Agents in this work plan. Populate with expand=details (defaults to empty list)","items":{"$ref":"#/definitions/DeletableUserReference"}},"metadata":{"description":"Version metadata for this work plan","$ref":"#/definitions/WfmVersionedEntityMetadata"},"agentCount":{"type":"integer","format":"int32","description":"Number of agents in this work plan. Populate with expand=agentCount"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Work plan information"},"WorkPlanListResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WorkPlanListItemResponse"}}}},"MessageConversationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/EmailConversation"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"MessageConversation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"participants":{"type":"array","description":"The list of participants involved in the conversation.","items":{"$ref":"#/definitions/MessageMediaParticipant"}},"otherMediaUris":{"type":"array","description":"The list of other media channels involved in the conversation.","items":{"type":"string","format":"uri"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"MessageMediaParticipant":{"type":"object","properties":{"id":{"type":"string","description":"The unique participant ID."},"name":{"type":"string","description":"The display friendly name of the participant."},"address":{"type":"string","description":"The participant address."},"startTime":{"type":"string","format":"date-time","description":"The time when this participant first joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The time when this participant went connected for this media (eg: video connected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startHoldTime":{"type":"string","format":"date-time","description":"The time when this participant's hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"purpose":{"type":"string","description":"The participant's purpose. Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr"},"state":{"type":"string","description":"The participant's state. Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","converting","uploading","transmitting","none"],"x-genesys-enum-members":[{"name":"alerting"},{"name":"dialing"},{"name":"contacting"},{"name":"offering"},{"name":"connected"},{"name":"disconnected"},{"name":"terminated"},{"name":"converting"},{"name":"uploading"},{"name":"transmitting"},{"name":"none"}]},"direction":{"type":"string","description":"The participant's direction. Values can be: 'inbound' or 'outbound'","enum":["inbound","outbound"],"x-genesys-enum-members":[{"name":"inbound"},{"name":"outbound"}]},"disconnectType":{"type":"string","description":"The reason the participant was disconnected from the conversation.","enum":["endpoint","client","system","transfer","transfer.conference","transfer.consult","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam"],"x-genesys-enum-members":[{"name":"endpoint"},{"name":"client"},{"name":"system"},{"name":"transfer"},{"name":"transfer.conference"},{"name":"transfer.consult"},{"name":"transfer.forward"},{"name":"transfer.noanswer"},{"name":"transfer.notavailable"},{"name":"transport.failure"},{"name":"error"},{"name":"peer"},{"name":"other"},{"name":"spam"}]},"held":{"type":"boolean","description":"Value is true when the participant is on hold."},"wrapupRequired":{"type":"boolean","description":"Value is true when the participant requires wrap-up."},"wrapupPrompt":{"type":"string","description":"The wrap-up prompt indicating the type of wrap-up to be performed."},"user":{"description":"The PureCloud user for this participant.","$ref":"#/definitions/DomainEntityRef"},"queue":{"description":"The PureCloud queue for this participant.","$ref":"#/definitions/DomainEntityRef"},"team":{"description":"The PureCloud team for this participant.","$ref":"#/definitions/DomainEntityRef"},"attributes":{"type":"object","description":"A list of ad-hoc attributes for the participant.","additionalProperties":{"type":"string"}},"errorInfo":{"description":"If the conversation ends in error, contains additional error details.","$ref":"#/definitions/ErrorInfo"},"script":{"description":"The Engage script that should be used by this participant.","$ref":"#/definitions/DomainEntityRef"},"wrapupTimeoutMs":{"type":"integer","format":"int32","description":"The amount of time the participant has to complete wrap-up."},"wrapupSkipped":{"type":"boolean","description":"Value is true when the participant has skipped wrap-up."},"alertingTimeoutMs":{"type":"integer","format":"int32","description":"Specifies how long the agent has to answer an interaction before being marked as not responding."},"provider":{"type":"string","description":"The source provider for the communication."},"externalContact":{"description":"If this participant represents an external contact, then this will be the reference for the external contact.","$ref":"#/definitions/DomainEntityRef"},"externalOrganization":{"description":"If this participant represents an external org, then this will be the reference for the external org.","$ref":"#/definitions/DomainEntityRef"},"wrapup":{"description":"Wrapup for this participant, if it has been applied.","$ref":"#/definitions/Wrapup"},"peer":{"type":"string","description":"The peer communication corresponding to a matching leg for this communication."},"flaggedReason":{"type":"string","description":"The reason specifying why participant flagged the conversation.","enum":["general"],"x-genesys-enum-members":[{"name":"general"}]},"journeyContext":{"description":"Journey System data/context that is applicable to this communication. When used for historical purposes, the context should be immutable. When null, there is no applicable Journey System context.","$ref":"#/definitions/JourneyContext"},"conversationRoutingData":{"description":"Information on how a communication should be routed to an agent.","$ref":"#/definitions/ConversationRoutingData"},"startAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"toAddress":{"description":"Address for the participant on receiving side of the message conversation. If the address is a phone number, E.164 format is recommended.","$ref":"#/definitions/Address"},"fromAddress":{"description":"Address for the participant on the sending side of the message conversation. If the address is a phone number, E.164 format is recommended.","$ref":"#/definitions/Address"},"messages":{"type":"array","description":"Message instance details on the communication.","items":{"$ref":"#/definitions/MessageDetails"}},"type":{"type":"string","description":"Indicates the type of message platform from which the message originated.","enum":["unknown","sms","twitter","facebook","line","whatsapp","telegram","kakao","webmessaging"],"x-genesys-enum-members":[{"name":"unknown"},{"name":"sms"},{"name":"twitter"},{"name":"facebook"},{"name":"line"},{"name":"whatsapp"},{"name":"telegram"},{"name":"kakao"},{"name":"webmessaging"}]},"recipientCountry":{"type":"string","description":"Indicates the country where the recipient is associated in ISO 3166-1 alpha-2 format."},"recipientType":{"type":"string","description":"The type of the recipient. Eg: Provisioned phoneNumber is the recipient for sms message type."}}},"MessageData":{"type":"object","required":["status","textBody","timestamp"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"providerMessageId":{"type":"string","description":"The unique identifier of the message from provider"},"timestamp":{"type":"string","format":"date-time","description":"The time when the message was received or sent. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"fromAddress":{"type":"string","description":"The sender of the text message."},"toAddress":{"type":"string","description":"The recipient of the text message."},"direction":{"type":"string","description":"The direction of the message.","enum":["inbound","outbound"],"x-genesys-enum-members":[{"name":"inbound"},{"name":"outbound"}]},"messengerType":{"type":"string","description":"Type of text messenger.","enum":["sms","facebook","twitter","line","whatsapp","webmessaging"],"x-genesys-enum-members":[{"name":"sms"},{"name":"facebook"},{"name":"twitter"},{"name":"line"},{"name":"whatsapp"},{"name":"webmessaging"}]},"textBody":{"type":"string","description":"The body of the text message."},"status":{"type":"string","description":"The status of the message.","enum":["queued","sent","failed","received","delivery-success","delivery-failed","read"],"x-genesys-enum-members":[{"name":"queued"},{"name":"sent"},{"name":"failed"},{"name":"received"},{"name":"delivery-success"},{"name":"delivery-failed"},{"name":"read"}]},"media":{"type":"array","description":"The media details associated to a message.","items":{"$ref":"#/definitions/MessageMedia"}},"stickers":{"type":"array","description":"The sticker details associated to a message.","items":{"$ref":"#/definitions/MessageSticker"}},"createdBy":{"description":"User who sent this message.","$ref":"#/definitions/User"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AdditionalMessage":{"type":"object","required":["textBody"],"properties":{"textBody":{"type":"string","description":"The body of the text message."},"mediaIds":{"type":"array","description":"The media ids associated with the text message.","items":{"type":"string"}},"stickerIds":{"type":"array","description":"The sticker ids associated with the text message.","items":{"type":"string"}},"messagingTemplate":{"description":"The messaging template use to send a predefined canned response with the message","$ref":"#/definitions/MessagingTemplateRequest"}}},"MessagingTemplateRequest":{"type":"object","properties":{"responseId":{"type":"string","description":"A Response Management response identifier for a messaging template defined response"},"parameters":{"type":"array","description":"A list of Response Management response substitutions for the response's messaging template","items":{"$ref":"#/definitions/TemplateParameter"}}}},"TemplateParameter":{"type":"object","properties":{"id":{"type":"string","description":"Response substitution identifier"},"value":{"type":"string","description":"Response substitution value"}}},"TextMessageListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/MessageData"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CreateOutboundMessagingConversationRequest":{"type":"object","required":["queueId","toAddress","toAddressMessengerType"],"properties":{"queueId":{"type":"string","description":"The ID of the queue to be associated with the message. This will determine the fromAddress of the message."},"toAddress":{"type":"string","description":"The messaging address of the recipient of the message. For an SMS messenger type, the phone number address must be in E.164 format. E.g. +13175555555 or +34234234234"},"toAddressMessengerType":{"type":"string","description":"The messaging address messenger type.","enum":["sms","facebook","twitter","line","whatsapp","webmessaging"],"x-genesys-enum-members":[{"name":"sms"},{"name":"facebook"},{"name":"twitter"},{"name":"line"},{"name":"whatsapp"},{"name":"webmessaging"}]},"useExistingConversation":{"type":"boolean","description":"An override to use an existing conversation. \nIf set to true, an existing conversation will be used if there is one within the conversation window. \nIf set to false, create request fails if there is a conversation within the conversation window."},"externalContactId":{"type":"string","description":"The external contact Id of the recipient of the message."},"externalOrganizationId":{"type":"string","description":"The external organization Id of the recipient of the message."}}},"MessageMediaData":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"url":{"type":"string","description":"The location of the media, useful for retrieving it"},"mediaType":{"type":"string","description":"The detected internet media type of the the media object. If null then the media type should be dictated by the url."},"contentLengthBytes":{"type":"integer","format":"int32","description":"The optional content length of the the media object, in bytes."},"uploadUrl":{"type":"string","description":"The URL returned to upload an attachment"},"status":{"type":"string","description":"The status of the media, indicates if the media is in the process of uploading. If the upload fails, the media becomes invalid","readOnly":true,"enum":["uploading","valid","invalid"],"x-genesys-enum-members":[{"name":"uploading"},{"name":"valid"},{"name":"invalid"}]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SendAgentlessOutboundMessageResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"conversationId":{"type":"string","description":"The identifier of the conversation."},"fromAddress":{"type":"string","description":"The sender of the text message."},"toAddress":{"type":"string","description":"The recipient of the text message."},"messengerType":{"type":"string","description":"Type of text messenger.","enum":["sms","facebook","twitter","line","whatsapp","webmessaging"],"x-genesys-enum-members":[{"name":"sms"},{"name":"facebook"},{"name":"twitter"},{"name":"line"},{"name":"whatsapp"},{"name":"webmessaging"}]},"textBody":{"type":"string","description":"The body of the text message."},"timestamp":{"type":"string","format":"date-time","description":"The time when the message was sent. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"user":{"description":"Details of the user created the job","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"}}},"SendAgentlessOutboundMessageRequest":{"type":"object","required":["fromAddress","textBody","toAddress","toAddressMessengerType"],"properties":{"fromAddress":{"type":"string","description":"The messaging address of the sender of the message. For an SMS messenger type, this must be a currently provisioned sms phone number."},"toAddress":{"type":"string","description":"The messaging address of the recipient of the message. For an SMS messenger type, the phone number address must be in E.164 format. E.g. +13175555555 or +34234234234."},"toAddressMessengerType":{"type":"string","description":"The recipient messaging address messenger type. Currently SMS is the only supported type.","enum":["sms","facebook","twitter","line","whatsapp","webmessaging"],"x-genesys-enum-members":[{"name":"sms"},{"name":"facebook"},{"name":"twitter"},{"name":"line"},{"name":"whatsapp"},{"name":"webmessaging"}]},"textBody":{"type":"string","description":"The text of the message to send"}}},"DataTableRowEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"type":"object","additionalProperties":{"type":"object"}}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"QueueObservationDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/ObservationMetricData"}}}},"QueueObservationQueryResponse":{"type":"object","properties":{"systemToOrganizationMappings":{"type":"object","description":"A mapping from system presence to a list of organization presence ids","additionalProperties":{"type":"array","items":{"type":"string"}}},"results":{"type":"array","items":{"$ref":"#/definitions/QueueObservationDataContainer"}}}},"QueueObservationQuery":{"type":"object","required":["filter","metrics"],"properties":{"filter":{"description":"Filter to return a subset of observations. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/QueueObservationQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["oActiveUsers","oAlerting","oInteracting","oMemberUsers","oOffQueueUsers","oOnQueueUsers","oUserPresences","oUserRoutingStatuses","oWaiting"],"x-genesys-enum-members":[{"name":"oActiveUsers"},{"name":"oAlerting"},{"name":"oInteracting"},{"name":"oMemberUsers"},{"name":"oOffQueueUsers"},{"name":"oOnQueueUsers"},{"name":"oUserPresences"},{"name":"oUserRoutingStatuses"},{"name":"oWaiting"}]}},"detailMetrics":{"type":"array","description":"Metrics for which to include additional detailed observations","items":{"type":"string","enum":["oActiveUsers","oAlerting","oInteracting","oMemberUsers","oOffQueueUsers","oOnQueueUsers","oUserPresences","oUserRoutingStatuses","oWaiting"],"x-genesys-enum-members":[{"name":"oActiveUsers"},{"name":"oAlerting"},{"name":"oInteracting"},{"name":"oMemberUsers"},{"name":"oOffQueueUsers"},{"name":"oOnQueueUsers"},{"name":"oUserPresences"},{"name":"oUserRoutingStatuses"},{"name":"oWaiting"}]}}}},"QueueObservationQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/QueueObservationQueryPredicate"}}}},"QueueObservationQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/QueueObservationQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/QueueObservationQueryPredicate"}}}},"QueueObservationQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"],"x-genesys-enum-members":[{"name":"dimension"},{"name":"property"},{"name":"metric"}]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["mediaType","queueId"],"x-genesys-enum-members":[{"name":"mediaType"},{"name":"queueId"}]},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"],"x-genesys-enum-members":[{"name":"matches"},{"name":"exists"},{"name":"notExists"}]},"value":{"type":"string","description":"Right hand side for dimension predicates"},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"Okta":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"disabled":{"type":"boolean"},"issuerURI":{"type":"string"},"ssoTargetURI":{"type":"string"},"certificate":{"type":"string"},"certificates":{"type":"array","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CommandStatusEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CommandStatus"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"SmsAddressProvision":{"type":"object","required":["city","countryCode","name","postalCode","region","street"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Name associated with this address"},"street":{"type":"string","description":"The number and street address where this address is located."},"city":{"type":"string","description":"The city in which this address is in"},"region":{"type":"string","description":"The state or region this address is in"},"postalCode":{"type":"string","description":"The postal code this address is in"},"countryCode":{"type":"string","description":"The ISO country code of this address"},"autoCorrectAddress":{"type":"boolean","description":"This is used when the address is created. If the value is not set or true, then the system will, if necessary, auto-correct the address you provide. Set this value to false if the system should not auto-correct the address."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SmsAddressEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SmsAddress"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"NluDomainListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/NluDomain"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CallableTime":{"type":"object","required":["timeSlots","timeZoneId"],"properties":{"timeSlots":{"type":"array","description":"The time intervals for which it is acceptable to place outbound calls.","items":{"$ref":"#/definitions/CampaignTimeSlot"}},"timeZoneId":{"type":"string","example":"Africa/Abidjan","description":"The time zone for the time slots; for example, Africa/Abidjan"}}},"CallableTimeSet":{"type":"object","required":["callableTimes","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the CallableTimeSet."},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"callableTimes":{"type":"array","description":"The list of CallableTimes for which it is acceptable to place outbound calls.","items":{"$ref":"#/definitions/CallableTime"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CampaignTimeSlot":{"type":"object","required":["day","startTime","stopTime"],"properties":{"startTime":{"type":"string","example":"08:00:00","description":"The start time of the interval as an ISO-8601 string, i.e. HH:mm:ss"},"stopTime":{"type":"string","example":"08:00:00","description":"The end time of the interval as an ISO-8601 string, i.e. HH:mm:ss"},"day":{"type":"integer","format":"int32","example":1,"description":"The day of the interval. Valid values: [1-7], representing Monday through Sunday"}}},"HeadcountForecast":{"type":"object","required":["required","requiredWithoutShrinkage"],"properties":{"required":{"type":"array","description":"Headcount information with shrinkage","items":{"$ref":"#/definitions/HeadcountInterval"}},"requiredWithoutShrinkage":{"type":"array","description":"Headcount information without shrinkage","items":{"$ref":"#/definitions/HeadcountInterval"}}},"description":"Headcount interval information for schedule"},"HeadcountInterval":{"type":"object","required":["interval","value"],"properties":{"interval":{"type":"string","format":"date-time","description":"The start date-time for this headcount interval in ISO-8601 format, must be within the 8 day schedule"},"value":{"type":"number","format":"double","description":"Headcount value for this interval"}},"description":"Headcount interval information for schedule"},"ScheduleGenerationWarning":{"type":"object","properties":{"userId":{"type":"string","description":"ID of the user in the warning"},"userNotLicensed":{"type":"boolean","description":"Whether the user does not have the appropriate license to be scheduled"},"unableToMeetMaxDays":{"type":"boolean","description":"Whether the number of scheduled days exceeded the maximum days to schedule defined in the agent work plan"},"unableToScheduleRequiredDays":{"type":"array","description":"Days indicated as required to work in agent work plan where no viable shift was found to schedule","uniqueItems":true,"items":{"type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"x-genesys-enum-members":[{"name":"Sunday"},{"name":"Monday"},{"name":"Tuesday"},{"name":"Wednesday"},{"name":"Thursday"},{"name":"Friday"},{"name":"Saturday"}]}},"unableToMeetMinPaidForTheWeek":{"type":"boolean","description":"Whether the schedule did not meet the minimum paid time for the week defined in the agent work plan"},"unableToMeetMaxPaidForTheWeek":{"type":"boolean","description":"Whether the schedule exceeded the maximum paid time for the week defined in the agent work plan"},"noNeedDays":{"type":"array","description":"Days agent was scheduled but there was no need to meet. The scheduled days have no effect on service levels","uniqueItems":true,"items":{"type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"x-genesys-enum-members":[{"name":"Sunday"},{"name":"Monday"},{"name":"Tuesday"},{"name":"Wednesday"},{"name":"Thursday"},{"name":"Friday"},{"name":"Saturday"}]}},"shiftsTooCloseTogether":{"type":"boolean","description":"Whether the schedule did not meet the minimum time between shifts defined in the agent work plan"}},"description":"Schedule generation warning"},"ShortTermForecastReference":{"type":"object","required":["weekDate"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"weekDate":{"type":"string","description":"The weekDate of the short term forecast in yyyy-MM-dd format"},"description":{"type":"string","description":"The description of the short term forecast"}},"description":"A pointer to a short term forecast"},"WeekSchedule":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"weekDate":{"type":"string","description":"First day of this week schedule in yyyy-MM-dd format"},"description":{"type":"string","description":"Description of the week schedule"},"published":{"type":"boolean","description":"Whether the week schedule is published"},"generationResults":{"description":"Summary of the results from the schedule run","$ref":"#/definitions/WeekScheduleGenerationResult"},"shortTermForecast":{"description":"Short term forecast associated with this schedule","$ref":"#/definitions/ShortTermForecastReference"},"metadata":{"description":"Version metadata for this work plan","$ref":"#/definitions/WfmVersionedEntityMetadata"},"userSchedules":{"type":"object","description":"User schedules in the week","additionalProperties":{"$ref":"#/definitions/UserSchedule"}},"headcountForecast":{"description":"Headcount information for the week schedule","$ref":"#/definitions/HeadcountForecast"},"agentSchedulesVersion":{"type":"integer","format":"int32","description":"Version of agent schedules in the week schedule"}},"description":"Week schedule information"},"WeekScheduleGenerationResult":{"type":"object","properties":{"failed":{"type":"boolean","description":"Whether the schedule generation failed"},"runId":{"type":"string","description":"ID of the schedule run"},"agentWarnings":{"type":"array","description":"Warning messages from the schedule run. This will be available only when requesting information for a single week schedule","items":{"$ref":"#/definitions/ScheduleGenerationWarning"}},"agentWarningCount":{"type":"integer","format":"int32","description":"Count of warning messages from the schedule run. This will be available only when requesting multiple week schedules"}}},"WeekScheduleResponse":{"type":"object","properties":{"result":{"description":"The result of the request. The value will be null if response is large","$ref":"#/definitions/WeekSchedule"},"downloadUrl":{"type":"string","description":"The url to fetch the result for large responses. The value is null if result contains the data"}},"description":"Response for query for week schedule for a given week in management unit"},"WeekScheduleListItemResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"weekDate":{"type":"string","description":"First day of this week schedule in yyyy-MM-dd format"},"description":{"type":"string","description":"Description of the week schedule"},"published":{"type":"boolean","description":"Whether the week schedule is published"},"generationResults":{"description":"Summary of the results from the schedule run","$ref":"#/definitions/WeekScheduleGenerationResult"},"shortTermForecast":{"description":"Short term forecast associated with this schedule","$ref":"#/definitions/ShortTermForecastReference"},"metadata":{"description":"Version metadata for this work plan","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"WeekScheduleListResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WeekScheduleListItemResponse"}}},"description":"Week schedule list"},"TrustorAuditQueryRequest":{"type":"object","required":["trusteeUserIds","trustorOrganizationId"],"properties":{"trustorOrganizationId":{"type":"string","description":"Limit returned audits to this trustor organizationId."},"trusteeUserIds":{"type":"array","description":"Limit returned audits to these trustee userIds.","items":{"type":"string"}},"startDate":{"type":"string","format":"date-time","description":"Starting date/time for the audit search. ISO-8601 formatted date-time, UTC."},"endDate":{"type":"string","format":"date-time","description":"Ending date/time for the audit search. ISO-8601 formatted date-time, UTC."},"queryPhrase":{"type":"string","description":"Word or phrase to look for in audit bodies."},"facets":{"type":"array","description":"Facet information to be returned with the query results.","items":{"$ref":"#/definitions/Facet"}},"filters":{"type":"array","description":"Additional custom filters to be applied to the query.","items":{"$ref":"#/definitions/Filter"}}}},"DialogflowAgent":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"project":{"description":"The project this Dialogflow agent belongs to","$ref":"#/definitions/DialogflowProject"},"languages":{"type":"array","description":"The supported languages of the Dialogflow agent","items":{"type":"string"}},"intents":{"type":"array","description":"An array of Intents associated with this agent","items":{"$ref":"#/definitions/DialogflowIntent"}},"environments":{"type":"array","description":"Available environments for this agent","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"InboundDomainEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/InboundDomain"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CallableTimeSetEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CallableTimeSet"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"PropertyIndexRequest":{"type":"object","required":["properties","sessionId","targetDate"],"properties":{"sessionId":{"type":"string","description":"Attach properties to a segment in the indicated session"},"targetDate":{"type":"string","format":"date-time","description":"Attach properties to a segment covering a specific point in time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"properties":{"type":"array","description":"The list of properties to index","items":{"$ref":"#/definitions/AnalyticsProperty"}}}},"AnalyticsConversationQueryResponse":{"type":"object","properties":{"aggregations":{"type":"array","items":{"$ref":"#/definitions/AggregationResult"}},"conversations":{"type":"array","items":{"$ref":"#/definitions/AnalyticsConversationWithoutAttributes"}}}},"ConversationQuery":{"type":"object","required":["interval"],"properties":{"conversationFilters":{"type":"array","description":"Filters that target conversation-level data","items":{"$ref":"#/definitions/ConversationDetailQueryFilter"}},"segmentFilters":{"type":"array","description":"Filters that target individual segments within a conversation","items":{"$ref":"#/definitions/SegmentDetailQueryFilter"}},"evaluationFilters":{"type":"array","description":"Filters that target evaluations","items":{"$ref":"#/definitions/EvaluationDetailQueryFilter"}},"mediaEndpointStatFilters":{"type":"array","description":"Filters that target mediaEndpointStats","items":{"$ref":"#/definitions/MediaEndpointStatDetailQueryFilter"}},"surveyFilters":{"type":"array","description":"Filters that target surveys","items":{"$ref":"#/definitions/SurveyDetailQueryFilter"}},"resolutionFilters":{"type":"array","description":"Filters that target resolutions","items":{"$ref":"#/definitions/ResolutionDetailQueryFilter"}},"order":{"type":"string","description":"Sort the result set in ascending/descending order. Default is ascending","enum":["asc","desc"],"x-genesys-enum-members":[{"name":"asc"},{"name":"desc"}]},"orderBy":{"type":"string","description":"Specify which data element within the result set to use for sorting. The options to use as a basis for sorting the results: conversationStart, segmentStart, and segmentEnd. If not specified, the default is conversationStart","enum":["conversationStart","conversationEnd","segmentStart","segmentEnd"],"x-genesys-enum-members":[{"name":"conversationStart"},{"name":"conversationEnd"},{"name":"segmentStart"},{"name":"segmentEnd"}]},"interval":{"type":"string","description":"Specifies the date and time range of data being queried. Results will only include conversations that started on a day touched by the interval. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"aggregations":{"type":"array","description":"Include faceted search and aggregate roll-ups describing your search results. This does not function as a filter, but rather, summary data about the data matching your filters","items":{"$ref":"#/definitions/AnalyticsQueryAggregation"}},"paging":{"description":"Page size and number to control iterating through large result sets. Default page size is 25","$ref":"#/definitions/PagingSpec"}}},"ConversationAggregateDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/StatisticalResponse"}}}},"ConversationAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/ConversationAggregateDataContainer"}}}},"ConversationAggregateQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/ConversationAggregateQueryPredicate"}}}},"ConversationAggregateQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/ConversationAggregateQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/ConversationAggregateQueryPredicate"}}}},"ConversationAggregateQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"],"x-genesys-enum-members":[{"name":"dimension"},{"name":"property"},{"name":"metric"}]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["addressFrom","addressTo","agentAssistantId","agentRank","agentScore","ani","assignerId","conversationId","convertedFrom","convertedTo","direction","disconnectType","divisionId","dnis","edgeId","externalContactId","externalMediaCount","externalOrganizationId","firstQueue","flaggedReason","flowInType","flowOutType","groupId","interactionType","journeyActionId","journeyActionMapId","journeyActionMapVersion","journeyCustomerId","journeyCustomerIdType","journeyCustomerSessionId","journeyCustomerSessionIdType","mediaCount","mediaType","messageType","originatingDirection","outboundCampaignId","outboundContactId","outboundContactListId","participantName","peerId","proposedAgentId","provider","purpose","queueId","remote","reoffered","requestedLanguageId","requestedRouting","requestedRoutingSkillId","roomId","routingPriority","scoredAgentId","selectedAgentId","selectedAgentRank","sessionDnis","sessionId","stationId","teamId","usedRouting","userId","wrapUpCode"],"x-genesys-enum-members":[{"name":"addressFrom"},{"name":"addressTo"},{"name":"agentAssistantId"},{"name":"agentRank"},{"name":"agentScore"},{"name":"ani"},{"name":"assignerId"},{"name":"conversationId"},{"name":"convertedFrom"},{"name":"convertedTo"},{"name":"direction"},{"name":"disconnectType"},{"name":"divisionId"},{"name":"dnis"},{"name":"edgeId"},{"name":"externalContactId"},{"name":"externalMediaCount"},{"name":"externalOrganizationId"},{"name":"firstQueue"},{"name":"flaggedReason"},{"name":"flowInType"},{"name":"flowOutType"},{"name":"groupId"},{"name":"interactionType"},{"name":"journeyActionId"},{"name":"journeyActionMapId"},{"name":"journeyActionMapVersion"},{"name":"journeyCustomerId"},{"name":"journeyCustomerIdType"},{"name":"journeyCustomerSessionId"},{"name":"journeyCustomerSessionIdType"},{"name":"mediaCount"},{"name":"mediaType"},{"name":"messageType"},{"name":"originatingDirection"},{"name":"outboundCampaignId"},{"name":"outboundContactId"},{"name":"outboundContactListId"},{"name":"participantName"},{"name":"peerId"},{"name":"proposedAgentId"},{"name":"provider"},{"name":"purpose"},{"name":"queueId"},{"name":"remote"},{"name":"reoffered"},{"name":"requestedLanguageId"},{"name":"requestedRouting"},{"name":"requestedRoutingSkillId"},{"name":"roomId"},{"name":"routingPriority"},{"name":"scoredAgentId"},{"name":"selectedAgentId"},{"name":"selectedAgentRank"},{"name":"sessionDnis"},{"name":"sessionId"},{"name":"stationId"},{"name":"teamId"},{"name":"usedRouting"},{"name":"userId"},{"name":"wrapUpCode"}]},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"],"x-genesys-enum-members":[{"name":"matches"},{"name":"exists"},{"name":"notExists"}]},"value":{"type":"string","description":"Right hand side for dimension predicates"},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"ConversationAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["addressFrom","addressTo","agentAssistantId","agentRank","agentScore","ani","assignerId","conversationId","convertedFrom","convertedTo","direction","disconnectType","divisionId","dnis","edgeId","externalContactId","externalMediaCount","externalOrganizationId","firstQueue","flaggedReason","flowInType","flowOutType","groupId","interactionType","journeyActionId","journeyActionMapId","journeyActionMapVersion","journeyCustomerId","journeyCustomerIdType","journeyCustomerSessionId","journeyCustomerSessionIdType","mediaCount","mediaType","messageType","originatingDirection","outboundCampaignId","outboundContactId","outboundContactListId","participantName","peerId","proposedAgentId","provider","purpose","queueId","remote","reoffered","requestedLanguageId","requestedRouting","requestedRoutingSkillId","roomId","routingPriority","scoredAgentId","selectedAgentId","selectedAgentRank","sessionDnis","sessionId","stationId","teamId","usedRouting","userId","wrapUpCode"],"x-genesys-enum-members":[{"name":"addressFrom"},{"name":"addressTo"},{"name":"agentAssistantId"},{"name":"agentRank"},{"name":"agentScore"},{"name":"ani"},{"name":"assignerId"},{"name":"conversationId"},{"name":"convertedFrom"},{"name":"convertedTo"},{"name":"direction"},{"name":"disconnectType"},{"name":"divisionId"},{"name":"dnis"},{"name":"edgeId"},{"name":"externalContactId"},{"name":"externalMediaCount"},{"name":"externalOrganizationId"},{"name":"firstQueue"},{"name":"flaggedReason"},{"name":"flowInType"},{"name":"flowOutType"},{"name":"groupId"},{"name":"interactionType"},{"name":"journeyActionId"},{"name":"journeyActionMapId"},{"name":"journeyActionMapVersion"},{"name":"journeyCustomerId"},{"name":"journeyCustomerIdType"},{"name":"journeyCustomerSessionId"},{"name":"journeyCustomerSessionIdType"},{"name":"mediaCount"},{"name":"mediaType"},{"name":"messageType"},{"name":"originatingDirection"},{"name":"outboundCampaignId"},{"name":"outboundContactId"},{"name":"outboundContactListId"},{"name":"participantName"},{"name":"peerId"},{"name":"proposedAgentId"},{"name":"provider"},{"name":"purpose"},{"name":"queueId"},{"name":"remote"},{"name":"reoffered"},{"name":"requestedLanguageId"},{"name":"requestedRouting"},{"name":"requestedRoutingSkillId"},{"name":"roomId"},{"name":"routingPriority"},{"name":"scoredAgentId"},{"name":"selectedAgentId"},{"name":"selectedAgentRank"},{"name":"sessionDnis"},{"name":"sessionId"},{"name":"stationId"},{"name":"teamId"},{"name":"usedRouting"},{"name":"userId"},{"name":"wrapUpCode"}]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/ConversationAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nBlindTransferred","nCobrowseSessions","nConnected","nConsult","nConsultTransferred","nError","nOffered","nOutbound","nOutboundAbandoned","nOutboundAttempted","nOutboundConnected","nOverSla","nStateTransitionError","nTransferred","oExternalMediaCount","oMediaCount","oServiceLevel","oServiceTarget","tAbandon","tAcd","tAcw","tAgentResponseTime","tAlert","tAnswered","tCallback","tCallbackComplete","tContacting","tDialing","tFlowOut","tHandle","tHeld","tHeldComplete","tIvr","tMonitoring","tNotResponding","tShortAbandon","tTalk","tTalkComplete","tUserResponseTime","tVoicemail","tWait"],"x-genesys-enum-members":[{"name":"nBlindTransferred"},{"name":"nCobrowseSessions"},{"name":"nConnected"},{"name":"nConsult"},{"name":"nConsultTransferred"},{"name":"nError"},{"name":"nOffered"},{"name":"nOutbound"},{"name":"nOutboundAbandoned"},{"name":"nOutboundAttempted"},{"name":"nOutboundConnected"},{"name":"nOverSla"},{"name":"nStateTransitionError"},{"name":"nTransferred"},{"name":"oExternalMediaCount"},{"name":"oMediaCount"},{"name":"oServiceLevel"},{"name":"oServiceTarget"},{"name":"tAbandon"},{"name":"tAcd"},{"name":"tAcw"},{"name":"tAgentResponseTime"},{"name":"tAlert"},{"name":"tAnswered"},{"name":"tCallback"},{"name":"tCallbackComplete"},{"name":"tContacting"},{"name":"tDialing"},{"name":"tFlowOut"},{"name":"tHandle"},{"name":"tHeld"},{"name":"tHeldComplete"},{"name":"tIvr"},{"name":"tMonitoring"},{"name":"tNotResponding"},{"name":"tShortAbandon"},{"name":"tTalk"},{"name":"tTalkComplete"},{"name":"tUserResponseTime"},{"name":"tVoicemail"},{"name":"tWait"}]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/ConversationAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"],"x-genesys-enum-members":[{"name":"eventTime"}]}}},"ConversationAggregationView":{"type":"object","required":["function","name","target"],"properties":{"target":{"type":"string","description":"Target metric name","enum":["nBlindTransferred","nCobrowseSessions","nConnected","nConsult","nConsultTransferred","nError","nOffered","nOutbound","nOutboundAbandoned","nOutboundAttempted","nOutboundConnected","nOverSla","nStateTransitionError","nTransferred","oExternalMediaCount","oMediaCount","oServiceLevel","oServiceTarget","tAbandon","tAcd","tAcw","tAgentResponseTime","tAlert","tAnswered","tCallback","tCallbackComplete","tContacting","tDialing","tFlowOut","tHandle","tHeld","tHeldComplete","tIvr","tMonitoring","tNotResponding","tShortAbandon","tTalk","tTalkComplete","tUserResponseTime","tVoicemail","tWait"],"x-genesys-enum-members":[{"name":"nBlindTransferred"},{"name":"nCobrowseSessions"},{"name":"nConnected"},{"name":"nConsult"},{"name":"nConsultTransferred"},{"name":"nError"},{"name":"nOffered"},{"name":"nOutbound"},{"name":"nOutboundAbandoned"},{"name":"nOutboundAttempted"},{"name":"nOutboundConnected"},{"name":"nOverSla"},{"name":"nStateTransitionError"},{"name":"nTransferred"},{"name":"oExternalMediaCount"},{"name":"oMediaCount"},{"name":"oServiceLevel"},{"name":"oServiceTarget"},{"name":"tAbandon"},{"name":"tAcd"},{"name":"tAcw"},{"name":"tAgentResponseTime"},{"name":"tAlert"},{"name":"tAnswered"},{"name":"tCallback"},{"name":"tCallbackComplete"},{"name":"tContacting"},{"name":"tDialing"},{"name":"tFlowOut"},{"name":"tHandle"},{"name":"tHeld"},{"name":"tHeldComplete"},{"name":"tIvr"},{"name":"tMonitoring"},{"name":"tNotResponding"},{"name":"tShortAbandon"},{"name":"tTalk"},{"name":"tTalkComplete"},{"name":"tUserResponseTime"},{"name":"tVoicemail"},{"name":"tWait"}]},"name":{"type":"string","description":"A unique name for this view. Must be distinct from other views and built-in metric names."},"function":{"type":"string","description":"Type of view you wish to create","enum":["rangeBound"],"x-genesys-enum-members":[{"name":"rangeBound"}]},"range":{"description":"Range of numbers for slicing up data","$ref":"#/definitions/AggregationRange"}}},"AnalyticsConversation":{"type":"object","properties":{"conversationId":{"type":"string","description":"Unique identifier for the conversation"},"conversationStart":{"type":"string","format":"date-time","description":"Date/time the conversation started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationEnd":{"type":"string","format":"date-time","description":"Date/time the conversation ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"mediaStatsMinConversationMos":{"type":"number","format":"double","description":"The lowest estimated average MOS among all the audio streams belonging to this conversation"},"mediaStatsMinConversationRFactor":{"type":"number","format":"double","description":"The lowest R-factor value among all of the audio streams belonging to this conversation"},"originatingDirection":{"type":"string","description":"The original direction of the conversation","enum":["inbound","outbound"],"x-genesys-enum-members":[{"name":"inbound"},{"name":"outbound"}]},"evaluations":{"type":"array","description":"Evaluations tied to this conversation","items":{"$ref":"#/definitions/AnalyticsEvaluation"}},"surveys":{"type":"array","description":"Surveys tied to this conversation","items":{"$ref":"#/definitions/AnalyticsSurvey"}},"resolutions":{"type":"array","description":"Resolutions tied to this conversation","items":{"$ref":"#/definitions/AnalyticsResolution"}},"divisionIds":{"type":"array","description":"Identifiers of divisions associated with this conversation","items":{"type":"string"}},"participants":{"type":"array","description":"Participants in the conversation","items":{"$ref":"#/definitions/AnalyticsParticipant"}}}},"AnalyticsConversationAsyncQueryResponse":{"type":"object","properties":{"cursor":{"type":"string","description":"Optional cursor to indicate where to resume the results"},"dataAvailabilityDate":{"type":"string","format":"date-time","description":"Data available up to at least this datetime. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversations":{"type":"array","items":{"$ref":"#/definitions/AnalyticsConversation"}}}},"AnalyticsParticipant":{"type":"object","properties":{"participantId":{"type":"string","description":"Unique identifier for the participant"},"participantName":{"type":"string","description":"A human readable name identifying the participant"},"userId":{"type":"string","description":"If a user, then this will be the unique identifier for the user"},"purpose":{"type":"string","description":"The participant's purpose","enum":["manual","dialer","inbound","acd","ivr","voicemail","outbound","agent","user","station","group","customer","external","fax","workflow","campaign","api"],"x-genesys-enum-members":[{"name":"manual"},{"name":"dialer"},{"name":"inbound"},{"name":"acd"},{"name":"ivr"},{"name":"voicemail"},{"name":"outbound"},{"name":"agent"},{"name":"user"},{"name":"station"},{"name":"group"},{"name":"customer"},{"name":"external"},{"name":"fax"},{"name":"workflow"},{"name":"campaign"},{"name":"api"}]},"externalContactId":{"type":"string","description":"External Contact Identifier"},"externalOrganizationId":{"type":"string","description":"External Organization Identifier"},"flaggedReason":{"type":"string","description":"Reason for which participant flagged conversation","enum":["general"],"x-genesys-enum-members":[{"name":"general"}]},"teamId":{"type":"string","description":"The team id the user is a member of"},"sessions":{"type":"array","description":"List of sessions associated to this participant","items":{"$ref":"#/definitions/AnalyticsSession"}},"attributes":{"type":"object","description":"List of attributes associated to this participant","additionalProperties":{"type":"string"}}}},"InteractionStatsRuleContainer":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/InteractionStatsRule"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ExportUri":{"type":"object","properties":{"uri":{"type":"string"},"exportTimestamp":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"AuditQueryExecutionStatusResponse":{"type":"object","properties":{"id":{"type":"string","description":"Id of the audit query execution request."},"state":{"type":"string","description":"Status of the audit query execution request.","enum":["Queued","Running","Succeeded","Failed","Cancelled"],"x-genesys-enum-members":[{"name":"Queued"},{"name":"Running"},{"name":"Succeeded"},{"name":"Failed"},{"name":"Cancelled"}]},"startDate":{"type":"string","format":"date-time","description":"Start date and time of the audit query execution. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"interval":{"type":"string","description":"Interval for the audit query. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"serviceName":{"type":"string","description":"Service name for the audit query.","enum":["Architect","ContactCenter","ContentManagement","PeoplePermissions","Presence","Quality","LanguageUnderstanding","TopicsDefinitions","PredictiveEngagement","WorkforceManagement","Triggers","ResponseManagement","Groups","Telephony","Outbound","SpeechAndTextAnalytics"],"x-genesys-enum-members":[{"name":"Architect"},{"name":"ContactCenter"},{"name":"ContentManagement"},{"name":"PeoplePermissions"},{"name":"Presence"},{"name":"Quality"},{"name":"LanguageUnderstanding"},{"name":"TopicsDefinitions"},{"name":"PredictiveEngagement"},{"name":"WorkforceManagement"},{"name":"Triggers"},{"name":"ResponseManagement"},{"name":"Groups"},{"name":"Telephony"},{"name":"Outbound"},{"name":"SpeechAndTextAnalytics"}]},"filters":{"type":"array","description":"Filters for the audit query.","items":{"$ref":"#/definitions/AuditQueryFilter"}},"sort":{"type":"array","description":"Sort parameter for the audit query.","items":{"$ref":"#/definitions/AuditQuerySort"}}}},"AuditQueryFilter":{"type":"object","required":["property","value"],"properties":{"property":{"type":"string","description":"Name of the property to filter.","enum":["UserId","TrusteeOrganizationId","ClientId","Action","EntityType","EntityId"],"x-genesys-enum-members":[{"name":"UserId"},{"name":"TrusteeOrganizationId"},{"name":"ClientId"},{"name":"Action"},{"name":"EntityType"},{"name":"EntityId"}]},"value":{"type":"string","description":"Value of the property to filter."}}},"AuditQuerySort":{"type":"object","required":["name","sortOrder"],"properties":{"name":{"type":"string","description":"Name of the property to sort.","enum":["Timestamp"],"x-genesys-enum-members":[{"name":"Timestamp"}]},"sortOrder":{"type":"string","description":"Sort Order","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]}}},"AuditLogMessage":{"type":"object","properties":{"id":{"type":"string","description":"Id of the audit message."},"userHomeOrgId":{"type":"string","description":"Home Organization Id associated with this audit message."},"user":{"description":"User associated with this audit message.","$ref":"#/definitions/DomainEntityRef"},"client":{"description":"Client associated with this audit message.","$ref":"#/definitions/AddressableEntityRef"},"remoteIp":{"type":"array","description":"List of IP addresses of systems that originated or handled the request.","items":{"type":"string"}},"serviceName":{"type":"string","description":"Name of the service that logged this audit message.","enum":["Architect","ContactCenter","ContentManagement","PeoplePermissions","Presence","Quality","LanguageUnderstanding","TopicsDefinitions","PredictiveEngagement","WorkforceManagement","Triggers","ResponseManagement","Groups","Telephony","Outbound","SpeechAndTextAnalytics"],"x-genesys-enum-members":[{"name":"Architect"},{"name":"ContactCenter"},{"name":"ContentManagement"},{"name":"PeoplePermissions"},{"name":"Presence"},{"name":"Quality"},{"name":"LanguageUnderstanding"},{"name":"TopicsDefinitions"},{"name":"PredictiveEngagement"},{"name":"WorkforceManagement"},{"name":"Triggers"},{"name":"ResponseManagement"},{"name":"Groups"},{"name":"Telephony"},{"name":"Outbound"},{"name":"SpeechAndTextAnalytics"}]},"eventDate":{"type":"string","format":"date-time","description":"Date and time of when the audit message was logged. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"message":{"description":"Message describing the event being audited.","$ref":"#/definitions/MessageInfo"},"action":{"type":"string","description":"Action that took place.","enum":["Create","View","Update","Delete","Download","Upload","MemberAdd","MemberUpdate","MemberRemove","Read","ApplyProtection","RevokeProtection","UpdateRetention","ReadAll","Execute","Publish","Unpublish","Activate","Checkin","Checkout","Deactivate","Debug","Save","Revert","Transcode","Enable","Disable","Authorize","Deauthorize","Authenticate","ChangePassword","Revoke","Export","Append","Recycle"],"x-genesys-enum-members":[{"name":"Create"},{"name":"View"},{"name":"Update"},{"name":"Delete"},{"name":"Download"},{"name":"Upload"},{"name":"MemberAdd"},{"name":"MemberUpdate"},{"name":"MemberRemove"},{"name":"Read"},{"name":"ApplyProtection"},{"name":"RevokeProtection"},{"name":"UpdateRetention"},{"name":"ReadAll"},{"name":"Execute"},{"name":"Publish"},{"name":"Unpublish"},{"name":"Activate"},{"name":"Checkin"},{"name":"Checkout"},{"name":"Deactivate"},{"name":"Debug"},{"name":"Save"},{"name":"Revert"},{"name":"Transcode"},{"name":"Enable"},{"name":"Disable"},{"name":"Authorize"},{"name":"Deauthorize"},{"name":"Authenticate"},{"name":"ChangePassword"},{"name":"Revoke"},{"name":"Export"},{"name":"Append"},{"name":"Recycle"}]},"entity":{"description":"Entity that was impacted.","$ref":"#/definitions/DomainEntityRef"},"entityType":{"type":"string","description":"Type of the entity that was impacted.","enum":["Document","Queue","Recording","Role","VoicemailUserPolicy","UserPresence","WrapupCode","MaxOrgRoutingUtilizationCapacity","AccessToken","OAuthClient","OAuthClientAuthorization","AuthOrganization","AuthUser","OrganizationAuthorizationTrust","OrganizationAuthorizationUserTrust","BulkActions","Feedback","Topic","Program","Segment","Outcome","SessionType","EventType","ClickstreamSettings","Schedule","ScheduleGroup","EmergencyGroup","IVR","Trigger","Response","DependencyTrackingBuild","Flow","Prompt","PromptResource","FlowOutcome","FlowMilestone","Team","Edge","EdgeGroup","Trunk","TrunkBase","DID","DIDPool","Extension","ExtensionPool","Phone","PhoneBase","Line","LineBase","OutboundRoute","NumberPlan","Site","AttemptLimits","CallableTimeSet","Campaign","CampaignRule","Sequence","ContactList","ContactListFilter","DNCList","CallAnalysisResponseSet","RuleSet","TranscriptionSettings","SpeechTextAnalyticsSettings"],"x-genesys-enum-members":[{"name":"Document"},{"name":"Queue"},{"name":"Recording"},{"name":"Role"},{"name":"VoicemailUserPolicy"},{"name":"UserPresence"},{"name":"WrapupCode"},{"name":"MaxOrgRoutingUtilizationCapacity"},{"name":"AccessToken"},{"name":"OAuthClient"},{"name":"OAuthClientAuthorization"},{"name":"AuthOrganization"},{"name":"AuthUser"},{"name":"OrganizationAuthorizationTrust"},{"name":"OrganizationAuthorizationUserTrust"},{"name":"BulkActions"},{"name":"Feedback"},{"name":"Topic"},{"name":"Program"},{"name":"Segment"},{"name":"Outcome"},{"name":"SessionType"},{"name":"EventType"},{"name":"ClickstreamSettings"},{"name":"Schedule"},{"name":"ScheduleGroup"},{"name":"EmergencyGroup"},{"name":"IVR"},{"name":"Trigger"},{"name":"Response"},{"name":"DependencyTrackingBuild"},{"name":"Flow"},{"name":"Prompt"},{"name":"PromptResource"},{"name":"FlowOutcome"},{"name":"FlowMilestone"},{"name":"Team"},{"name":"Edge"},{"name":"EdgeGroup"},{"name":"Trunk"},{"name":"TrunkBase"},{"name":"DID"},{"name":"DIDPool"},{"name":"Extension"},{"name":"ExtensionPool"},{"name":"Phone"},{"name":"PhoneBase"},{"name":"Line"},{"name":"LineBase"},{"name":"OutboundRoute"},{"name":"NumberPlan"},{"name":"Site"},{"name":"AttemptLimits"},{"name":"CallableTimeSet"},{"name":"Campaign"},{"name":"CampaignRule"},{"name":"Sequence"},{"name":"ContactList"},{"name":"ContactListFilter"},{"name":"DNCList"},{"name":"CallAnalysisResponseSet"},{"name":"RuleSet"},{"name":"TranscriptionSettings"},{"name":"SpeechTextAnalyticsSettings"}]},"propertyChanges":{"type":"array","description":"List of properties that were changed and changes made to those properties.","items":{"$ref":"#/definitions/PropertyChange"}},"context":{"type":"object","description":"Additional context for this message.","additionalProperties":{"type":"string"}}}},"AuditQueryExecutionResultsResponse":{"type":"object","properties":{"id":{"type":"string","description":"Id of the audit query execution request."},"pageSize":{"type":"integer","format":"int32","description":"Number of results in a page."},"cursor":{"type":"string","description":"Optional cursor to indicate where to resume the results."},"entities":{"type":"array","description":"List of audit messages.","items":{"$ref":"#/definitions/AuditLogMessage"}}}},"PropertyChange":{"type":"object","properties":{"property":{"type":"string","description":"The property that was changed"},"oldValues":{"type":"array","description":"Previous values for the property.","items":{"type":"string"}},"newValues":{"type":"array","description":"New values for the property.","items":{"type":"string"}}}},"AuditQueryEntity":{"type":"object","properties":{"name":{"type":"string","description":"Name of the Entity","enum":["Document","Queue","Recording","Role","VoicemailUserPolicy","UserPresence","WrapupCode","MaxOrgRoutingUtilizationCapacity","AccessToken","OAuthClient","OAuthClientAuthorization","AuthOrganization","AuthUser","OrganizationAuthorizationTrust","OrganizationAuthorizationUserTrust","BulkActions","Feedback","Topic","Program","Segment","Outcome","SessionType","EventType","ClickstreamSettings","Schedule","ScheduleGroup","EmergencyGroup","IVR","Trigger","Response","DependencyTrackingBuild","Flow","Prompt","PromptResource","FlowOutcome","FlowMilestone","Team","Edge","EdgeGroup","Trunk","TrunkBase","DID","DIDPool","Extension","ExtensionPool","Phone","PhoneBase","Line","LineBase","OutboundRoute","NumberPlan","Site","AttemptLimits","CallableTimeSet","Campaign","CampaignRule","Sequence","ContactList","ContactListFilter","DNCList","CallAnalysisResponseSet","RuleSet","TranscriptionSettings","SpeechTextAnalyticsSettings"],"x-genesys-enum-members":[{"name":"Document"},{"name":"Queue"},{"name":"Recording"},{"name":"Role"},{"name":"VoicemailUserPolicy"},{"name":"UserPresence"},{"name":"WrapupCode"},{"name":"MaxOrgRoutingUtilizationCapacity"},{"name":"AccessToken"},{"name":"OAuthClient"},{"name":"OAuthClientAuthorization"},{"name":"AuthOrganization"},{"name":"AuthUser"},{"name":"OrganizationAuthorizationTrust"},{"name":"OrganizationAuthorizationUserTrust"},{"name":"BulkActions"},{"name":"Feedback"},{"name":"Topic"},{"name":"Program"},{"name":"Segment"},{"name":"Outcome"},{"name":"SessionType"},{"name":"EventType"},{"name":"ClickstreamSettings"},{"name":"Schedule"},{"name":"ScheduleGroup"},{"name":"EmergencyGroup"},{"name":"IVR"},{"name":"Trigger"},{"name":"Response"},{"name":"DependencyTrackingBuild"},{"name":"Flow"},{"name":"Prompt"},{"name":"PromptResource"},{"name":"FlowOutcome"},{"name":"FlowMilestone"},{"name":"Team"},{"name":"Edge"},{"name":"EdgeGroup"},{"name":"Trunk"},{"name":"TrunkBase"},{"name":"DID"},{"name":"DIDPool"},{"name":"Extension"},{"name":"ExtensionPool"},{"name":"Phone"},{"name":"PhoneBase"},{"name":"Line"},{"name":"LineBase"},{"name":"OutboundRoute"},{"name":"NumberPlan"},{"name":"Site"},{"name":"AttemptLimits"},{"name":"CallableTimeSet"},{"name":"Campaign"},{"name":"CampaignRule"},{"name":"Sequence"},{"name":"ContactList"},{"name":"ContactListFilter"},{"name":"DNCList"},{"name":"CallAnalysisResponseSet"},{"name":"RuleSet"},{"name":"TranscriptionSettings"},{"name":"SpeechTextAnalyticsSettings"}]},"actions":{"type":"array","description":"List of Actions","items":{"type":"string","enum":["Create","View","Update","Delete","Download","Upload","MemberAdd","MemberUpdate","MemberRemove","Read","ApplyProtection","RevokeProtection","UpdateRetention","ReadAll","Execute","Publish","Unpublish","Activate","Checkin","Checkout","Deactivate","Debug","Save","Revert","Transcode","Enable","Disable","Authorize","Deauthorize","Authenticate","ChangePassword","Revoke","Export","Append","Recycle"],"x-genesys-enum-members":[{"name":"Create"},{"name":"View"},{"name":"Update"},{"name":"Delete"},{"name":"Download"},{"name":"Upload"},{"name":"MemberAdd"},{"name":"MemberUpdate"},{"name":"MemberRemove"},{"name":"Read"},{"name":"ApplyProtection"},{"name":"RevokeProtection"},{"name":"UpdateRetention"},{"name":"ReadAll"},{"name":"Execute"},{"name":"Publish"},{"name":"Unpublish"},{"name":"Activate"},{"name":"Checkin"},{"name":"Checkout"},{"name":"Deactivate"},{"name":"Debug"},{"name":"Save"},{"name":"Revert"},{"name":"Transcode"},{"name":"Enable"},{"name":"Disable"},{"name":"Authorize"},{"name":"Deauthorize"},{"name":"Authenticate"},{"name":"ChangePassword"},{"name":"Revoke"},{"name":"Export"},{"name":"Append"},{"name":"Recycle"}]}}}},"AuditQueryService":{"type":"object","properties":{"name":{"type":"string","description":"Name of the Service","enum":["Architect","ContactCenter","ContentManagement","PeoplePermissions","Presence","Quality","LanguageUnderstanding","TopicsDefinitions","PredictiveEngagement","WorkforceManagement","Triggers","ResponseManagement","Groups","Telephony","Outbound","SpeechAndTextAnalytics"],"x-genesys-enum-members":[{"name":"Architect"},{"name":"ContactCenter"},{"name":"ContentManagement"},{"name":"PeoplePermissions"},{"name":"Presence"},{"name":"Quality"},{"name":"LanguageUnderstanding"},{"name":"TopicsDefinitions"},{"name":"PredictiveEngagement"},{"name":"WorkforceManagement"},{"name":"Triggers"},{"name":"ResponseManagement"},{"name":"Groups"},{"name":"Telephony"},{"name":"Outbound"},{"name":"SpeechAndTextAnalytics"}]},"entities":{"type":"array","description":"List of Entities","items":{"$ref":"#/definitions/AuditQueryEntity"}}}},"AuditQueryServiceMapping":{"type":"object","properties":{"services":{"type":"array","description":"List of Services","items":{"$ref":"#/definitions/AuditQueryService"}}}},"AuditQueryRequest":{"type":"object","required":["interval","serviceName"],"properties":{"interval":{"type":"string","description":"Date and time range of data to query. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"serviceName":{"type":"string","description":"Name of the service to query audits for.","enum":["Architect","ContactCenter","ContentManagement","PeoplePermissions","Presence","Quality","LanguageUnderstanding","TopicsDefinitions","PredictiveEngagement","WorkforceManagement","Triggers","ResponseManagement","Groups","Telephony","Outbound","SpeechAndTextAnalytics"],"x-genesys-enum-members":[{"name":"Architect"},{"name":"ContactCenter"},{"name":"ContentManagement"},{"name":"PeoplePermissions"},{"name":"Presence"},{"name":"Quality"},{"name":"LanguageUnderstanding"},{"name":"TopicsDefinitions"},{"name":"PredictiveEngagement"},{"name":"WorkforceManagement"},{"name":"Triggers"},{"name":"ResponseManagement"},{"name":"Groups"},{"name":"Telephony"},{"name":"Outbound"},{"name":"SpeechAndTextAnalytics"}]},"filters":{"type":"array","description":"Additional filters for the query.","items":{"$ref":"#/definitions/AuditQueryFilter"}},"sort":{"type":"array","description":"Sort parameter for the query.","items":{"$ref":"#/definitions/AuditQuerySort"}}}},"AuditRealtimeQueryResultsResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AuditLogMessage"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"pageCount":{"type":"integer","format":"int32"}}},"AuditRealtimeQueryRequest":{"type":"object","required":["interval","serviceName"],"properties":{"interval":{"type":"string","description":"Date and time range of data to query. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"serviceName":{"type":"string","description":"Name of the service to query audits for.","enum":["Architect","ContactCenter","ContentManagement","PeoplePermissions","Presence","Quality","LanguageUnderstanding","TopicsDefinitions","PredictiveEngagement","WorkforceManagement","Triggers","ResponseManagement","Groups","Telephony","Outbound","SpeechAndTextAnalytics"],"x-genesys-enum-members":[{"name":"Architect"},{"name":"ContactCenter"},{"name":"ContentManagement"},{"name":"PeoplePermissions"},{"name":"Presence"},{"name":"Quality"},{"name":"LanguageUnderstanding"},{"name":"TopicsDefinitions"},{"name":"PredictiveEngagement"},{"name":"WorkforceManagement"},{"name":"Triggers"},{"name":"ResponseManagement"},{"name":"Groups"},{"name":"Telephony"},{"name":"Outbound"},{"name":"SpeechAndTextAnalytics"}]},"filters":{"type":"array","description":"Additional filters for the query.","items":{"$ref":"#/definitions/AuditQueryFilter"}},"sort":{"type":"array","description":"Sort parameter for the query.","items":{"$ref":"#/definitions/AuditQuerySort"}},"pageNumber":{"type":"integer","format":"int32","description":"Page number"},"pageSize":{"type":"integer","format":"int32","description":"Page size"}}},"LanguageOverride":{"type":"object","required":["engine","language","voice"],"properties":{"language":{"type":"string","description":"The language code of the language being overridden"},"engine":{"type":"string","description":"The ID of the TTS engine to use for this language override"},"voice":{"type":"string","description":"The ID of the voice to use for this language override. The voice must be supported by the chosen engine."}}},"TtsSettings":{"type":"object","required":["defaultEngine","languageOverrides"],"properties":{"defaultEngine":{"type":"string","description":"ID of the global default TTS engine"},"languageOverrides":{"type":"array","description":"The list of default overrides for specific languages","items":{"$ref":"#/definitions/LanguageOverride"}}}},"EdgeRebootParameters":{"type":"object","properties":{"callDrainingWaitTimeSeconds":{"type":"integer","format":"int32","description":"The number of seconds to wait for call draining to complete before initiating the reboot. A value of 0 will prevent call draining and all calls will disconnect immediately."}}},"CursorContactListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ExternalContact"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"PresenceExpand":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"presences":{"type":"array","description":"An array of user presences","items":{"$ref":"#/definitions/UserPresence"}},"outOfOffices":{"type":"array","description":"An array of out of office statuses","items":{"$ref":"#/definitions/OutOfOffice"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"RecipientListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Recipient"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ReverseWhitepagesLookupResult":{"type":"object","properties":{"contacts":{"type":"array","items":{"$ref":"#/definitions/ExternalContact"}},"externalOrganizations":{"type":"array","items":{"$ref":"#/definitions/ExternalOrganization"}}}},"AuthzDivisionEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AuthzDivision"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"PhoneMetaBaseEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Metabase"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ContactListDivisionView":{"type":"object","required":["columnNames","phoneColumns"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"columnNames":{"type":"array","description":"The names of the contact data columns.","items":{"type":"string"}},"phoneColumns":{"type":"array","description":"Indicates which columns are phone numbers.","items":{"$ref":"#/definitions/ContactPhoneNumberColumn"}},"importStatus":{"description":"The status of the import process.","readOnly":true,"$ref":"#/definitions/ImportStatus"},"size":{"type":"integer","format":"int64","description":"The number of contacts in the ContactList.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ContactListDivisionViewListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ContactListDivisionView"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FlowRuntimeExecution":{"type":"object","required":["dateLaunched","flowVersion","status"],"properties":{"id":{"type":"string","description":"The flow execution ID"},"name":{"type":"string","description":"The flow execution name."},"flowVersion":{"description":"The Version of the flow definition of the flow execution.","$ref":"#/definitions/FlowVersion"},"dateLaunched":{"type":"string","format":"date-time","description":"The time the flow was launched. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"status":{"type":"string","description":"The flow's running status, which indicates whether the flow is running normally or completed, etc.","enum":["UNKNOWN","RUNNING","ERROR","TERMINATED","COMPLETED","FAILED"],"x-genesys-enum-members":[{"name":"UNKNOWN"},{"name":"RUNNING"},{"name":"ERROR"},{"name":"TERMINATED"},{"name":"COMPLETED"},{"name":"FAILED"}]},"dateCompleted":{"type":"string","format":"date-time","description":"The time the flow completed, if applicable. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"completionReason":{"type":"string","description":"The completion reason set at the flow completion time, if applicable."},"flowErrorInfo":{"description":"Additional information if the flow is in error","$ref":"#/definitions/ErrorBody"},"outputData":{"type":"object","description":"List of the flow's output variables, if any. Output variables are only supplied for Completed flows.","additionalProperties":{"type":"object"}},"conversation":{"description":"The conversation to which this Flow execution is related","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Details about the current state of a Flow execution"},"PlanningGroup":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"serviceGoalTemplate":{"description":"The ID of the service goal template associated with this planning group","$ref":"#/definitions/ServiceGoalTemplateReference"},"routePaths":{"type":"array","description":"Set of route paths associated with the planning group","uniqueItems":true,"items":{"$ref":"#/definitions/RoutePathResponse"}},"metadata":{"description":"Version metadata for the planning group","$ref":"#/definitions/WfmVersionedEntityMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Planning Group"},"ServiceGoalTemplateReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"RoutePathRequest":{"type":"object","required":["mediaType","queueId"],"properties":{"queueId":{"type":"string","example":"f27450c9-c1a0-451a-804c-2579b268b273","description":"The ID of the queue to associate with the route path"},"mediaType":{"type":"string","example":"Email","description":"The media type of the given queue to associate with the route path","enum":["Voice","Chat","Email","Callback","Message"],"x-genesys-enum-members":[{"name":"Voice"},{"name":"Chat"},{"name":"Email"},{"name":"Callback"},{"name":"Message"}]},"languageId":{"type":"string","example":"e3d65f6a-c0d2-41da-8152-82d3f075d77c","description":"The ID of the language to associate with the route path"},"skillIds":{"type":"array","example":"[\"33d29376-4267-4968-8042-dcabdf2c1d98\"]","description":"The set of skill IDs to associate with the route path","uniqueItems":true,"items":{"type":"string"}},"sourcePlanningGroup":{"description":"The planning group from which to copy route paths","$ref":"#/definitions/SourcePlanningGroupRequest"}},"description":"Route path configuration"},"SetWrapperRoutePathRequest":{"type":"object","properties":{"values":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/RoutePathRequest"}}}},"SourcePlanningGroupRequest":{"type":"object","required":["id","metadata"],"properties":{"id":{"type":"string","description":"The ID of the planning group"},"metadata":{"description":"Version metadata for the planning group","$ref":"#/definitions/WfmVersionedEntityMetadata"}},"description":"Source planning group"},"UpdatePlanningGroupRequest":{"type":"object","required":["metadata"],"properties":{"name":{"type":"string","description":"The name of the planning group"},"routePaths":{"description":"Set of route paths to associate with the planning group","$ref":"#/definitions/SetWrapperRoutePathRequest"},"serviceGoalTemplateId":{"type":"string","description":"The ID of the service goal template to associate with this planning group"},"metadata":{"description":"Version metadata for the planning group","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"PlanningGroupList":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/PlanningGroup"}}},"description":"List of planning groups"},"CreatePlanningGroupRequest":{"type":"object","required":["name","routePaths","serviceGoalTemplateId"],"properties":{"name":{"type":"string","description":"The name of the planning group"},"routePaths":{"type":"array","description":"Set of route paths to associate with the planning group","uniqueItems":true,"items":{"$ref":"#/definitions/RoutePathRequest"}},"serviceGoalTemplateId":{"type":"string","description":"The ID of the service goal template to associate with this planning group"}}},"PingIdentity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"disabled":{"type":"boolean"},"issuerURI":{"type":"string"},"ssoTargetURI":{"type":"string"},"certificate":{"type":"string"},"certificates":{"type":"array","items":{"type":"string"}},"relyingPartyIdentifier":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ExtensionPoolEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ExtensionPool"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"TrustRequest":{"type":"object","required":["trustee"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"createdBy":{"description":"User who created this request.","readOnly":true,"$ref":"#/definitions/OrgUser"},"dateCreated":{"type":"string","format":"date-time","description":"Date request was created. There is a 48 hour expiration on all requests. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"trustee":{"description":"Trustee organization who generated this request.","readOnly":true,"$ref":"#/definitions/Organization"},"users":{"type":"array","description":"The list of trustee users that are requesting access.","readOnly":true,"items":{"$ref":"#/definitions/OrgUser"}},"groups":{"type":"array","description":"The list of trustee groups that are requesting access.","readOnly":true,"items":{"$ref":"#/definitions/TrustGroup"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TrustRequestCreate":{"type":"object","properties":{"userIds":{"type":"array","description":"The list of trustee users that are requesting access. If no users are specified, at least one group is required.","items":{"type":"string"}},"groupIds":{"type":"array","description":"The list of trustee groups that are requesting access. If no groups are specified, at least one user is required.","items":{"type":"string"}}}},"DomainEdgeSoftwareVersionDtoEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DomainEdgeSoftwareVersionDto"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DataTableImportJob":{"type":"object","required":["status"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"owner":{"description":"The PureCloud user who started the import job","$ref":"#/definitions/AddressableEntityRef"},"status":{"type":"string","description":"The status of the import job","enum":["WaitingForUpload","Processing","Failed","Succeeded"],"x-genesys-enum-members":[{"name":"WaitingForUpload"},{"name":"Processing"},{"name":"Failed"},{"name":"Succeeded"}]},"dateCreated":{"type":"string","format":"date-time","description":"The timestamp of when the import began. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateCompleted":{"type":"string","format":"date-time","description":"The timestamp of when the import stopped (either successfully or unsuccessfully). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"uploadURI":{"type":"string","format":"uri","description":"The URL of the location at which the caller can upload the file to be imported"},"importMode":{"type":"string","description":"The indication of whether the processing should remove rows that don't appear in the import file","enum":["ReplaceAll","Append"],"x-genesys-enum-members":[{"name":"ReplaceAll"},{"name":"Append"}]},"errorInformation":{"description":"Any error information, or null of the processing is not in an error state","$ref":"#/definitions/ErrorBody"},"countRecordsUpdated":{"type":"integer","format":"int32","description":"The current count of the number of records processed"},"countRecordsDeleted":{"type":"integer","format":"int32","description":"The current count of the number of records deleted"},"countRecordsFailed":{"type":"integer","format":"int32","description":"The current count of the number of records that failed to import"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"State information for an import job of rows to a datatable"},"FlowAggregateDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/StatisticalResponse"}}}},"FlowAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/FlowAggregateDataContainer"}}}},"FlowAggregateQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/FlowAggregateQueryPredicate"}}}},"FlowAggregateQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/FlowAggregateQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/FlowAggregateQueryPredicate"}}}},"FlowAggregateQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"],"x-genesys-enum-members":[{"name":"dimension"},{"name":"property"},{"name":"metric"}]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["addressFrom","addressTo","agentAssistantId","agentRank","agentScore","ani","assignerId","conversationId","convertedFrom","convertedTo","direction","disconnectType","divisionId","dnis","edgeId","endingLanguage","entryReason","entryType","exitReason","externalContactId","externalMediaCount","externalOrganizationId","firstQueue","flaggedReason","flowId","flowInType","flowMilestoneId","flowName","flowOutType","flowOutcome","flowOutcomeId","flowOutcomeValue","flowType","flowVersion","groupId","interactionType","journeyActionId","journeyActionMapId","journeyActionMapVersion","journeyCustomerId","journeyCustomerIdType","journeyCustomerSessionId","journeyCustomerSessionIdType","mediaCount","mediaType","messageType","originatingDirection","outboundCampaignId","outboundContactId","outboundContactListId","participantName","peerId","proposedAgentId","provider","purpose","queueId","remote","reoffered","requestedLanguageId","requestedRouting","requestedRoutingSkillId","roomId","routingPriority","scoredAgentId","selectedAgentId","selectedAgentRank","sessionDnis","sessionId","startingLanguage","stationId","teamId","transferTargetAddress","transferTargetName","transferType","usedRouting","userId","wrapUpCode"],"x-genesys-enum-members":[{"name":"addressFrom"},{"name":"addressTo"},{"name":"agentAssistantId"},{"name":"agentRank"},{"name":"agentScore"},{"name":"ani"},{"name":"assignerId"},{"name":"conversationId"},{"name":"convertedFrom"},{"name":"convertedTo"},{"name":"direction"},{"name":"disconnectType"},{"name":"divisionId"},{"name":"dnis"},{"name":"edgeId"},{"name":"endingLanguage"},{"name":"entryReason"},{"name":"entryType"},{"name":"exitReason"},{"name":"externalContactId"},{"name":"externalMediaCount"},{"name":"externalOrganizationId"},{"name":"firstQueue"},{"name":"flaggedReason"},{"name":"flowId"},{"name":"flowInType"},{"name":"flowMilestoneId"},{"name":"flowName"},{"name":"flowOutType"},{"name":"flowOutcome"},{"name":"flowOutcomeId"},{"name":"flowOutcomeValue"},{"name":"flowType"},{"name":"flowVersion"},{"name":"groupId"},{"name":"interactionType"},{"name":"journeyActionId"},{"name":"journeyActionMapId"},{"name":"journeyActionMapVersion"},{"name":"journeyCustomerId"},{"name":"journeyCustomerIdType"},{"name":"journeyCustomerSessionId"},{"name":"journeyCustomerSessionIdType"},{"name":"mediaCount"},{"name":"mediaType"},{"name":"messageType"},{"name":"originatingDirection"},{"name":"outboundCampaignId"},{"name":"outboundContactId"},{"name":"outboundContactListId"},{"name":"participantName"},{"name":"peerId"},{"name":"proposedAgentId"},{"name":"provider"},{"name":"purpose"},{"name":"queueId"},{"name":"remote"},{"name":"reoffered"},{"name":"requestedLanguageId"},{"name":"requestedRouting"},{"name":"requestedRoutingSkillId"},{"name":"roomId"},{"name":"routingPriority"},{"name":"scoredAgentId"},{"name":"selectedAgentId"},{"name":"selectedAgentRank"},{"name":"sessionDnis"},{"name":"sessionId"},{"name":"startingLanguage"},{"name":"stationId"},{"name":"teamId"},{"name":"transferTargetAddress"},{"name":"transferTargetName"},{"name":"transferType"},{"name":"usedRouting"},{"name":"userId"},{"name":"wrapUpCode"}]},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"],"x-genesys-enum-members":[{"name":"matches"},{"name":"exists"},{"name":"notExists"}]},"value":{"type":"string","description":"Right hand side for dimension predicates"},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"FlowAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["addressFrom","addressTo","agentAssistantId","agentRank","agentScore","ani","assignerId","conversationId","convertedFrom","convertedTo","direction","disconnectType","divisionId","dnis","edgeId","endingLanguage","entryReason","entryType","exitReason","externalContactId","externalMediaCount","externalOrganizationId","firstQueue","flaggedReason","flowId","flowInType","flowMilestoneId","flowName","flowOutType","flowOutcome","flowOutcomeId","flowOutcomeValue","flowType","flowVersion","groupId","interactionType","journeyActionId","journeyActionMapId","journeyActionMapVersion","journeyCustomerId","journeyCustomerIdType","journeyCustomerSessionId","journeyCustomerSessionIdType","mediaCount","mediaType","messageType","originatingDirection","outboundCampaignId","outboundContactId","outboundContactListId","participantName","peerId","proposedAgentId","provider","purpose","queueId","remote","reoffered","requestedLanguageId","requestedRouting","requestedRoutingSkillId","roomId","routingPriority","scoredAgentId","selectedAgentId","selectedAgentRank","sessionDnis","sessionId","startingLanguage","stationId","teamId","transferTargetAddress","transferTargetName","transferType","usedRouting","userId","wrapUpCode"],"x-genesys-enum-members":[{"name":"addressFrom"},{"name":"addressTo"},{"name":"agentAssistantId"},{"name":"agentRank"},{"name":"agentScore"},{"name":"ani"},{"name":"assignerId"},{"name":"conversationId"},{"name":"convertedFrom"},{"name":"convertedTo"},{"name":"direction"},{"name":"disconnectType"},{"name":"divisionId"},{"name":"dnis"},{"name":"edgeId"},{"name":"endingLanguage"},{"name":"entryReason"},{"name":"entryType"},{"name":"exitReason"},{"name":"externalContactId"},{"name":"externalMediaCount"},{"name":"externalOrganizationId"},{"name":"firstQueue"},{"name":"flaggedReason"},{"name":"flowId"},{"name":"flowInType"},{"name":"flowMilestoneId"},{"name":"flowName"},{"name":"flowOutType"},{"name":"flowOutcome"},{"name":"flowOutcomeId"},{"name":"flowOutcomeValue"},{"name":"flowType"},{"name":"flowVersion"},{"name":"groupId"},{"name":"interactionType"},{"name":"journeyActionId"},{"name":"journeyActionMapId"},{"name":"journeyActionMapVersion"},{"name":"journeyCustomerId"},{"name":"journeyCustomerIdType"},{"name":"journeyCustomerSessionId"},{"name":"journeyCustomerSessionIdType"},{"name":"mediaCount"},{"name":"mediaType"},{"name":"messageType"},{"name":"originatingDirection"},{"name":"outboundCampaignId"},{"name":"outboundContactId"},{"name":"outboundContactListId"},{"name":"participantName"},{"name":"peerId"},{"name":"proposedAgentId"},{"name":"provider"},{"name":"purpose"},{"name":"queueId"},{"name":"remote"},{"name":"reoffered"},{"name":"requestedLanguageId"},{"name":"requestedRouting"},{"name":"requestedRoutingSkillId"},{"name":"roomId"},{"name":"routingPriority"},{"name":"scoredAgentId"},{"name":"selectedAgentId"},{"name":"selectedAgentRank"},{"name":"sessionDnis"},{"name":"sessionId"},{"name":"startingLanguage"},{"name":"stationId"},{"name":"teamId"},{"name":"transferTargetAddress"},{"name":"transferTargetName"},{"name":"transferType"},{"name":"usedRouting"},{"name":"userId"},{"name":"wrapUpCode"}]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/FlowAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nFlow","nFlowMilestone","nFlowOutcome","nFlowOutcomeFailed","oFlowMilestone","tFlow","tFlowDisconnect","tFlowExit","tFlowOutcome"],"x-genesys-enum-members":[{"name":"nFlow"},{"name":"nFlowMilestone"},{"name":"nFlowOutcome"},{"name":"nFlowOutcomeFailed"},{"name":"oFlowMilestone"},{"name":"tFlow"},{"name":"tFlowDisconnect"},{"name":"tFlowExit"},{"name":"tFlowOutcome"}]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/FlowAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"],"x-genesys-enum-members":[{"name":"eventTime"}]}}},"FlowAggregationView":{"type":"object","required":["function","name","target"],"properties":{"target":{"type":"string","description":"Target metric name","enum":["nFlow","nFlowMilestone","nFlowOutcome","nFlowOutcomeFailed","oFlowMilestone","tFlow","tFlowDisconnect","tFlowExit","tFlowOutcome"],"x-genesys-enum-members":[{"name":"nFlow"},{"name":"nFlowMilestone"},{"name":"nFlowOutcome"},{"name":"nFlowOutcomeFailed"},{"name":"oFlowMilestone"},{"name":"tFlow"},{"name":"tFlowDisconnect"},{"name":"tFlowExit"},{"name":"tFlowOutcome"}]},"name":{"type":"string","description":"A unique name for this view. Must be distinct from other views and built-in metric names."},"function":{"type":"string","description":"Type of view you wish to create","enum":["rangeBound"],"x-genesys-enum-members":[{"name":"rangeBound"}]},"range":{"description":"Range of numbers for slicing up data","$ref":"#/definitions/AggregationRange"}}},"FlowObservationDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/ObservationMetricData"}}}},"FlowObservationQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/FlowObservationDataContainer"}}}},"FlowObservationQuery":{"type":"object","required":["filter","metrics"],"properties":{"filter":{"description":"Filter to return a subset of observations. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/FlowObservationQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["oFlow"],"x-genesys-enum-members":[{"name":"oFlow"}]}},"detailMetrics":{"type":"array","description":"Metrics for which to include additional detailed observations","items":{"type":"string","enum":["oFlow"],"x-genesys-enum-members":[{"name":"oFlow"}]}}}},"FlowObservationQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/FlowObservationQueryPredicate"}}}},"FlowObservationQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/FlowObservationQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/FlowObservationQueryPredicate"}}}},"FlowObservationQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"],"x-genesys-enum-members":[{"name":"dimension"},{"name":"property"},{"name":"metric"}]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["flowId","mediaType"],"x-genesys-enum-members":[{"name":"flowId"},{"name":"mediaType"}]},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"],"x-genesys-enum-members":[{"name":"matches"},{"name":"exists"},{"name":"notExists"}]},"value":{"type":"string","description":"Right hand side for dimension predicates"},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"CreateUser":{"type":"object","required":["divisionId","email","name","password"],"properties":{"name":{"type":"string","description":"User's full name"},"department":{"type":"string"},"email":{"type":"string","description":"User's email and username"},"addresses":{"type":"array","description":"Email addresses and phone numbers for this user","items":{"$ref":"#/definitions/Contact"}},"title":{"type":"string"},"password":{"type":"string","description":"User's password"},"divisionId":{"type":"string","description":"The division to which this user will belong"},"state":{"type":"string","description":"Optional initialized state of the user. If not specified, state will be Active if invites are sent, otherwise Inactive.","enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]}}},"OAuthScope":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"description":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OAuthScopeListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/OAuthScope"}},"selfUri":{"type":"string","format":"uri"}}},"ActionMapListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ActionMap"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"SchemaQuantityLimits":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"minFieldNameCharacters":{"type":"integer","format":"int32","example":"\"minFieldNameCharacters\":1","description":"The minimum number of schema field name characters allowed.","readOnly":true},"maxFieldNameCharacters":{"type":"integer","format":"int32","example":"\"minFieldNameCharacters\":100","description":"The maximum number of schema field name characters allowed.","readOnly":true},"minFieldDescriptionCharacters":{"type":"integer","format":"int32","example":"\"minFieldDescriptionCharacters\":0","description":"The minimum number of schema field description characters allowed.","readOnly":true},"maxFieldDescriptionCharacters":{"type":"integer","format":"int32","example":"\"maxFieldDescriptionCharacters\":200","description":"The maximum number of schema field description characters allowed.","readOnly":true},"minSchemaNameCharacters":{"type":"integer","format":"int32","example":"\"minSchemaNameCharacters\":1","description":"The minimum number of schema name characters allowed.","readOnly":true},"maxSchemaNameCharacters":{"type":"integer","format":"int32","example":"\"maxSchemaNameCharacters\":50","description":"The maximum number of schema name characters allowed.","readOnly":true},"minSchemaDescriptionCharacters":{"type":"integer","format":"int32","example":"\"minSchemaDescriptionCharacters\":0","description":"The minimum number of schema description characters allowed.","readOnly":true},"maxSchemaDescriptionCharacters":{"type":"integer","format":"int32","example":"\"maxSchemaDescriptionCharacters\":200","description":"The maximum number of schema description characters allowed.","readOnly":true},"maxNumberOfSchemasPerOrg":{"type":"integer","format":"int32","example":"\"maxNumberOfSchemasPerOrg\":20","description":"The maximum number of schema allowed per org.","readOnly":true},"maxNumberOfFieldsPerSchema":{"type":"integer","format":"int32","example":"\"maxNumberOfFieldsPerSchema\":25","description":"The maximum number of schema fields allowed per schema.","readOnly":true},"maxNumberOfFieldsPerOrg":{"type":"integer","format":"int32","example":"\"maxNumberOfFieldsPerOrg\":500","description":"The maximum number of schema fields allowed per organization across all of their schemas.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ServerDate":{"type":"object","properties":{"currentDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"ImportScriptStatusResponse":{"type":"object","properties":{"url":{"type":"string","format":"uri"},"succeeded":{"type":"boolean"},"message":{"type":"string"}}},"StationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Station"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EvaluatorActivity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"evaluator":{"$ref":"#/definitions/User"},"numEvaluationsAssigned":{"type":"integer","format":"int32"},"numEvaluationsStarted":{"type":"integer","format":"int32"},"numEvaluationsCompleted":{"type":"integer","format":"int32"},"numCalibrationsAssigned":{"type":"integer","format":"int32"},"numCalibrationsStarted":{"type":"integer","format":"int32"},"numCalibrationsCompleted":{"type":"integer","format":"int32"},"numEvaluationsWithoutViewPermission":{"type":"integer","format":"int32"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EvaluatorActivityEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/EvaluatorActivity"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CoachingAppointmentStatusResponse":{"type":"object","properties":{"appointment":{"description":"The coaching appointment this status belongs to","readOnly":true,"$ref":"#/definitions/CoachingAppointmentReference"},"createdBy":{"description":"User who updated the status","readOnly":true,"$ref":"#/definitions/UserReference"},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the status. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"status":{"type":"string","description":"The status of the coaching appointment","readOnly":true,"enum":["Scheduled","InProgress","Completed","InvalidSchedule"],"x-genesys-enum-members":[{"name":"Scheduled"},{"name":"InProgress"},{"name":"Completed"},{"name":"InvalidSchedule"}]}}},"CoachingAppointmentStatusResponseList":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CoachingAppointmentStatusResponse"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"pageCount":{"type":"integer","format":"int32"}}},"CoachingAppointmentStatusRequest":{"type":"object","required":["status"],"properties":{"status":{"type":"string","description":"The status of the coaching appointment","enum":["Scheduled","InProgress","Completed"],"x-genesys-enum-members":[{"name":"Scheduled"},{"name":"InProgress"},{"name":"Completed"}]}}},"JsonSearchResponse":{"type":"object","required":["pageCount","pageNumber","pageSize","results","total","types"],"properties":{"total":{"type":"integer","format":"int64","description":"The total number of results found"},"pageCount":{"type":"integer","format":"int32","description":"The total number of pages"},"pageSize":{"type":"integer","format":"int32","description":"The current page size"},"pageNumber":{"type":"integer","format":"int32","description":"The current page number"},"types":{"type":"array","description":"Resource types the search was performed against","items":{"type":"string"}},"results":{"description":"Search results","$ref":"#/definitions/ArrayNode"},"aggregations":{"$ref":"#/definitions/ArrayNode"}}},"TranscriptSearchCriteria":{"type":"object","properties":{"endValue":{"type":"string","description":"The end value of the range. This field is used for range search types."},"values":{"type":"array","description":"A list of values for the search to match against","items":{"type":"string"}},"startValue":{"type":"string","description":"The start value of the range. This field is used for range search types."},"fields":{"type":"array","description":"Field names to search against","items":{"type":"string"}},"value":{"type":"string","description":"A value for the search to match against"},"operator":{"type":"string","description":"How to apply this search criteria against other criteria","enum":["AND","OR","NOT"],"x-genesys-enum-members":[{"name":"AND"},{"name":"OR"},{"name":"NOT"}]},"group":{"type":"array","description":"Groups multiple conditions","items":{"$ref":"#/definitions/TranscriptSearchCriteria"}},"dateFormat":{"type":"string","description":"Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."},"type":{"type":"string","enum":["EXACT","EXACT_PHRASE","PHRASE","DATE_RANGE","RANGE","GREATER_THAN","LESS_THAN"],"x-genesys-enum-members":[{"name":"EXACT"},{"name":"EXACT_PHRASE"},{"name":"PHRASE"},{"name":"DATE_RANGE"},{"name":"RANGE"},{"name":"GREATER_THAN"},{"name":"LESS_THAN"}]}}},"TranscriptSearchRequest":{"type":"object","required":["types"],"properties":{"sortOrder":{"type":"string","description":"The sort order for results","enum":["ASC","DESC","SCORE"],"x-genesys-enum-members":[{"name":"ASC"},{"name":"DESC"},{"name":"SCORE"}]},"sortBy":{"type":"string","description":"The field in the resource that you want to sort the results by"},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"},"pageNumber":{"type":"integer","format":"int32","description":"The page of resources you want to retrieve"},"sort":{"type":"array","description":"Multi-value sort order, list of multiple sort values","items":{"$ref":"#/definitions/SearchSort"}},"returnFields":{"type":"array","items":{"type":"string"}},"types":{"type":"array","description":"Resource domain type to search","items":{"type":"string"}},"query":{"type":"array","description":"The search criteria","items":{"$ref":"#/definitions/TranscriptSearchCriteria"}}}},"PhonesReboot":{"type":"object","properties":{"phoneIds":{"type":"array","description":"The list of phone Ids to reboot.","items":{"type":"string"}},"siteId":{"type":"string","description":"ID of the site for which to reboot all phones at that site.\nno.active.edge and phone.cannot.resolve errors are ignored."}}},"WorkspaceMemberEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WorkspaceMember"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ResponseSetEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ResponseSet"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ChannelTopic":{"type":"object","properties":{"id":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ChannelTopicEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ChannelTopic"}}}},"EvaluationFormAndScoringSet":{"type":"object","properties":{"evaluationForm":{"$ref":"#/definitions/EvaluationForm"},"answers":{"$ref":"#/definitions/EvaluationScoringSet"}}},"IVR":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"dnis":{"type":"array","description":"The phone number(s) to contact the IVR by. Each phone number must be unique and not in use by another resource. For example, a user and an iVR cannot have the same phone number.","items":{"type":"string"}},"openHoursFlow":{"description":"The Architect flow to execute during the hours an organization is open.","$ref":"#/definitions/DomainEntityRef"},"closedHoursFlow":{"description":"The Architect flow to execute during the hours an organization is closed.","$ref":"#/definitions/DomainEntityRef"},"holidayHoursFlow":{"description":"The Architect flow to execute during an organization's holiday hours.","$ref":"#/definitions/DomainEntityRef"},"scheduleGroup":{"description":"The schedule group defining the open and closed hours for an organization. If this is provided, an open flow and a closed flow must be specified as well.","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Defines the phone numbers, operating hours, and the Architect flows to execute for an IVR."},"DevelopmentActivity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"dateCompleted":{"type":"string","format":"date-time","description":"Date that activity was completed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"createdBy":{"description":"User that created activity","readOnly":true,"$ref":"#/definitions/UserReference"},"dateCreated":{"type":"string","format":"date-time","description":"Date activity was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"name":{"type":"string","position":2,"description":"The name of the activity"},"type":{"type":"string","position":3,"description":"The type of activity","enum":["Informational","Coaching"],"x-genesys-enum-members":[{"name":"Informational"},{"name":"Coaching"}]},"status":{"type":"string","position":4,"description":"The status of the activity","enum":["Planned","InProgress","Completed","InvalidSchedule"],"x-genesys-enum-members":[{"name":"Planned"},{"name":"InProgress"},{"name":"Completed"},{"name":"InvalidSchedule"}]},"dateDue":{"type":"string","format":"date-time","position":5,"description":"Due date for completion of the activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"facilitator":{"position":6,"description":"Facilitator of the activity","$ref":"#/definitions/UserReference"},"attendees":{"type":"array","position":7,"description":"List of users attending the activity","items":{"$ref":"#/definitions/UserReference"}},"isOverdue":{"type":"boolean","position":8,"description":"Indicates if the activity is overdue"}},"description":"Development Activity object"},"DevelopmentActivityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DevelopmentActivity"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FieldConfigs":{"type":"object","properties":{"org":{"$ref":"#/definitions/FieldConfig"},"person":{"$ref":"#/definitions/FieldConfig"},"group":{"$ref":"#/definitions/FieldConfig"},"externalContact":{"$ref":"#/definitions/FieldConfig"}}},"UserMe":{"type":"object","required":["version"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"chat":{"$ref":"#/definitions/Chat"},"department":{"type":"string"},"email":{"type":"string"},"primaryContactInfo":{"type":"array","description":"Auto populated from addresses.","readOnly":true,"items":{"$ref":"#/definitions/Contact"}},"addresses":{"type":"array","description":"Email addresses and phone numbers for this user","items":{"$ref":"#/definitions/Contact"}},"state":{"type":"string","description":"The current state for this user.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"title":{"type":"string"},"username":{"type":"string"},"manager":{"$ref":"#/definitions/User"},"images":{"type":"array","items":{"$ref":"#/definitions/UserImage"}},"version":{"type":"integer","format":"int32","description":"Required when updating a user, this value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH."},"certifications":{"type":"array","items":{"type":"string"}},"biography":{"$ref":"#/definitions/Biography"},"employerInfo":{"$ref":"#/definitions/EmployerInfo"},"routingStatus":{"description":"ACD routing status","readOnly":true,"$ref":"#/definitions/RoutingStatus"},"presence":{"description":"Active presence","readOnly":true,"$ref":"#/definitions/UserPresence"},"conversationSummary":{"description":"Summary of conversion statistics for conversation types.","readOnly":true,"$ref":"#/definitions/UserConversationSummary"},"outOfOffice":{"description":"Determine if out of office is enabled","readOnly":true,"$ref":"#/definitions/OutOfOffice"},"geolocation":{"description":"Current geolocation position","readOnly":true,"$ref":"#/definitions/Geolocation"},"station":{"description":"Effective, default, and last station information","readOnly":true,"$ref":"#/definitions/UserStations"},"authorization":{"description":"Roles and permissions assigned to the user","readOnly":true,"$ref":"#/definitions/UserAuthorization"},"profileSkills":{"type":"array","description":"Profile skills possessed by the user","readOnly":true,"items":{"type":"string"}},"locations":{"type":"array","description":"The user placement at each site location.","readOnly":true,"items":{"$ref":"#/definitions/Location"}},"groups":{"type":"array","description":"The groups the user is a member of","readOnly":true,"items":{"$ref":"#/definitions/Group"}},"team":{"description":"The team the user is a member of","readOnly":true,"$ref":"#/definitions/Team"},"skills":{"type":"array","description":"Routing (ACD) skills possessed by the user","readOnly":true,"items":{"$ref":"#/definitions/UserRoutingSkill"}},"languages":{"type":"array","description":"Routing (ACD) languages possessed by the user","readOnly":true,"items":{"$ref":"#/definitions/UserRoutingLanguage"}},"acdAutoAnswer":{"type":"boolean","description":"acd auto answer"},"languagePreference":{"type":"string","description":"preferred language by the user","readOnly":true},"lastTokenIssued":{"$ref":"#/definitions/OAuthLastTokenIssued"},"date":{"description":"The PureCloud system date time.","readOnly":true,"$ref":"#/definitions/ServerDate"},"geolocationSettings":{"description":"Geolocation settings for user's organization.","readOnly":true,"$ref":"#/definitions/GeolocationSettings"},"organization":{"description":"Organization details for this user.","readOnly":true,"$ref":"#/definitions/Organization"},"presenceDefinitions":{"type":"array","description":"The first 100 presence definitions for user's organization.","readOnly":true,"items":{"$ref":"#/definitions/OrganizationPresence"}},"locationDefinitions":{"type":"array","description":"The first 100 site locations for user's organization","readOnly":true,"items":{"$ref":"#/definitions/LocationDefinition"}},"orgAuthorization":{"type":"array","description":"The first 100 organization roles, with applicable permission policies, for user's organization.","readOnly":true,"items":{"$ref":"#/definitions/DomainOrganizationRole"}},"favorites":{"type":"array","description":"The first 50 favorited users.","readOnly":true,"items":{"$ref":"#/definitions/User"}},"superiors":{"type":"array","description":"The first 50 superiors of this user.","readOnly":true,"items":{"$ref":"#/definitions/User"}},"directReports":{"type":"array","description":"The first 50 direct reports to this user.","readOnly":true,"items":{"$ref":"#/definitions/User"}},"adjacents":{"description":"The first 50 superiors, direct reports, and siblings of this user. Mutually exclusive with superiors and direct reports expands.","readOnly":true,"$ref":"#/definitions/Adjacents"},"routingSkills":{"type":"array","description":"The first 50 routing skills for user's organizations","readOnly":true,"items":{"$ref":"#/definitions/RoutingSkill"}},"fieldConfigs":{"description":"The field config for all entities types of user's organization","readOnly":true,"$ref":"#/definitions/FieldConfigs"},"token":{"description":"Information about the current token","readOnly":true,"$ref":"#/definitions/TokenInfo"},"trustors":{"type":"array","description":"Organizations having this user as a trustee","readOnly":true,"items":{"$ref":"#/definitions/Trustor"}},"orgProducts":{"type":"array","description":"Products enabled in this organization","readOnly":true,"items":{"$ref":"#/definitions/DomainOrganizationProduct"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"IVREntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/IVR"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"WhatsAppIntegrationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WhatsAppIntegration"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"WhatsAppIntegrationRequest":{"type":"object","required":["name","phoneNumber","wabaCertificate"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the WhatsApp Integration"},"phoneNumber":{"type":"string","description":"The phone number associated to the whatsApp integration"},"wabaCertificate":{"type":"string","description":"The waba(WhatsApp Business Manager) certificate associated to the WhatsApp integration phone number"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"MessagingSticker":{"type":"object","required":["messengerType","providerStickerId","stickerType"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"providerStickerId":{"type":"integer","format":"int32","description":"The sticker Id of the sticker, assigned by the sticker provider."},"providerPackageId":{"type":"integer","format":"int32","description":"The package Id of the sticker, assigned by the sticker provider."},"packageName":{"type":"string","description":"The package name of the sticker, assigned by the sticker provider."},"messengerType":{"type":"string","description":"The type of the messenger provider.","enum":["sms","facebook","twitter","line","whatsapp","webmessaging"],"x-genesys-enum-members":[{"name":"sms"},{"name":"facebook"},{"name":"twitter"},{"name":"line"},{"name":"whatsapp"},{"name":"webmessaging"}]},"stickerType":{"type":"string","description":"The type of the sticker.","enum":["standard","free","paid"],"x-genesys-enum-members":[{"name":"standard"},{"name":"free"},{"name":"paid"}]},"providerVersion":{"type":"integer","format":"int64","description":"The version of the sticker, assigned by the provider."},"uriLocation":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"MessagingStickerEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/MessagingSticker"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"OutcomeListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Outcome"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EdgeGroupEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/EdgeGroup"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"NluDomainVersionListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/NluDomainVersion"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"NotificationsResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WfmUserNotification"}}}},"ShiftTradeNotification":{"type":"object","properties":{"weekDate":{"type":"string","description":"The start date of the schedule with which this trade is associated"},"tradeId":{"type":"string","description":"The ID of the shift trade"},"oneSided":{"type":"boolean","description":"Whether this is a one sided shift trade"},"newState":{"type":"string","description":"The new state of the shift trade, null if there was no change","enum":["Unmatched","Matched","Approved","Denied","Expired","Canceled"],"x-genesys-enum-members":[{"name":"Unmatched"},{"name":"Matched"},{"name":"Approved"},{"name":"Denied"},{"name":"Expired"},{"name":"Canceled"}]},"initiatingUser":{"description":"The user who initiated the shift trade","$ref":"#/definitions/UserReference"},"initiatingShiftDate":{"type":"string","format":"date-time","description":"The start date and time of the initiating shift. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"receivingUser":{"description":"The user on the receiving side of this shift trade (null if not matched)","$ref":"#/definitions/UserReference"},"receivingShiftDate":{"type":"string","format":"date-time","description":"The start date and time of the receiving shift (null if not matched or if one-sided. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"TimeOffRequestNotification":{"type":"object","properties":{"timeOffRequestId":{"type":"string","description":"The ID of this time off request"},"user":{"description":"The user associated with this time off request","$ref":"#/definitions/UserReference"},"isFullDayRequest":{"type":"boolean","description":"Whether this is a full day request (false means partial day)"},"status":{"type":"string","description":"The status of this time off request","enum":["PENDING","APPROVED","DENIED","CANCELED"],"x-genesys-enum-members":[{"name":"PENDING"},{"name":"APPROVED"},{"name":"DENIED"},{"name":"CANCELED"}]},"partialDayStartDateTimes":{"type":"array","description":"A set of start date-times in ISO-8601 format for partial day requests. Will be not empty if isFullDayRequest == false","items":{"type":"string","format":"date-time"}},"fullDayManagementUnitDates":{"type":"array","description":"A set of dates in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone. Will be not empty if isFullDayRequest == true","items":{"type":"string"}}}},"WfmUserNotification":{"type":"object","required":["id","markedAsRead","mutableGroupId"],"properties":{"id":{"type":"string","description":"The immutable globally unique identifier for the object."},"mutableGroupId":{"type":"string","description":"The group ID of the notification (mutable, may change on update)"},"timestamp":{"type":"string","format":"date-time","description":"The timestamp for this notification. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"type":{"type":"string","description":"The type of this notification","readOnly":true,"enum":["ShiftTrade","TimeOffRequest"],"x-genesys-enum-members":[{"name":"ShiftTrade"},{"name":"TimeOffRequest"}]},"shiftTrade":{"description":"A shift trade notification. Only set if type == ShiftTrade","readOnly":true,"$ref":"#/definitions/ShiftTradeNotification"},"timeOffRequest":{"description":"A time off request notification. Only set if type == TimeOffRequest","readOnly":true,"$ref":"#/definitions/TimeOffRequestNotification"},"markedAsRead":{"type":"boolean","description":"Whether this notification has been marked \"read\""},"agentNotification":{"type":"boolean","description":"Whether this notification is for an agent","readOnly":true},"otherNotificationIdsInGroup":{"type":"array","description":"Other notification IDs in group. This field is only populated in real-time notifications","readOnly":true,"uniqueItems":true,"items":{"type":"string"}}}},"UpdateNotificationResponse":{"type":"object","properties":{"mutableGroupId":{"type":"string","description":"The mutableGroupId of the notification"},"id":{"type":"string","description":"The id of the notification for mapping the potentially new mutableGroupId"}}},"UpdateNotificationsResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UpdateNotificationResponse"}}}},"UpdateNotificationsRequest":{"type":"object","required":["entities"],"properties":{"entities":{"type":"array","description":"The notifications to update","items":{"$ref":"#/definitions/WfmUserNotification"}}}},"EvaluationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Evaluation"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"PatchActionTarget":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"serviceLevel":{"description":"Service Level of the action target. Chat offers for the target will be throttled with the aim of achieving this service level.","$ref":"#/definitions/ServiceLevel"},"shortAbandonThreshold":{"type":"integer","format":"int32","description":"Indicates the non-default short abandon threshold"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WfmHistoricalAdherenceQuery":{"type":"object","required":["startDate"],"properties":{"startDate":{"type":"string","format":"date-time","description":"Beginning of the date range to query in ISO-8601 format"},"endDate":{"type":"string","format":"date-time","description":"End of the date range to query in ISO-8601 format. If it is not set, end date will be set to current time"},"timeZone":{"type":"string","description":"The time zone to use for returned results in olson format. If it is not set, the business unit time zone will be used to compute adherence"},"userIds":{"type":"array","description":"The userIds to report on. If null or not set, adherence will be computed for all the users in management unit or requested teamIds","uniqueItems":true,"items":{"type":"string"}},"includeExceptions":{"type":"boolean","description":"Whether user exceptions should be returned as part of the results"},"teamIds":{"type":"array","description":"The teamIds to report on. If null or not set, adherence will be computed for requested users if applicable or otherwise all users in the management unit. Note: If teamIds is also specified, only adherence for users in the requested teams will be returned","uniqueItems":true,"items":{"type":"string"}}}}},"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"externalDocs":{"description":"PureCloud API Documentation","url":"https://developer.mypurecloud.com"}} \ No newline at end of file +{"swagger":"2.0","info":{"description":"With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.","version":"v2","title":"PureCloud Platform API","termsOfService":"https://help.mypurecloud.com/articles/terms-and-conditions/","contact":{"name":"PureCloud Developer Evangelists","url":"https://developer.mypurecloud.com","email":"DeveloperEvangelists@genesys.com"},"license":{"name":"UNLICENSED","url":"https://help.mypurecloud.com/articles/terms-and-conditions/"}},"host":"api.mypurecloud.com","tags":[{"name":"Alerting","description":"Rules and alerts","externalDocs":{"description":"Alerting Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/alerting/"}},{"name":"Analytics","description":"Analytics querying and reporting.","externalDocs":{"description":"Analytics Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/analytics/"}},{"name":"Architect","description":"Flows, Prompts, IVR schedules, Dependency Tracking","externalDocs":{"description":"Architect Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/architect/"}},{"name":"Audit","description":"","externalDocs":{"description":"Audit Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/audits/"}},{"name":"Authorization","description":"Roles and permissions","externalDocs":{"description":"Authorization Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/authorization/"}},{"name":"Billing","description":"","externalDocs":{"description":"billing Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/billing/"}},{"name":"Callbacks","description":""},{"name":"Calls","description":""},{"name":"Chat","description":""},{"name":"Coaching","description":"Schedule and manage coaching appointments","externalDocs":{"description":"Coaching","url":"https://developer.mypurecloud.com/api/rest/v2/coaching/index.html"}},{"name":"Configuration","description":"","externalDocs":{"description":"Configuration Documentation","url":""}},{"name":"Content Management","description":"","externalDocs":{"description":"Content Management Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/contentmanagement/"}},{"name":"Conversations","description":"","externalDocs":{"description":"Conversations Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/conversations/"}},{"name":"Data Extensions","description":"Data extensions","externalDocs":{"description":"Data Extensions","url":""}},{"name":"Directory Proxy","description":"Search, Suggest, and people"},{"name":"Emails","description":""},{"name":"External Contacts","description":"External Organizations, contacts, notes and relationships","externalDocs":{"description":"External Contacts","url":"https://developer.mypurecloud.com/api/rest/v2/externalcontacts/"}},{"name":"Fax","description":"","externalDocs":{"description":"Fax Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/fax/"}},{"name":"Flows","description":"IVR Flows","externalDocs":{"description":"Flow Aggregates Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/analytics/flow_aggregate.html"}},{"name":"General Data Protection Regulation","description":"Working with General Data Protection Regulation (GDPR) requests","externalDocs":{"description":"GDPR Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/generaldataprotectionregulation/"}},{"name":"Geolocation","description":"","externalDocs":{"description":"Geolocation Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/geolocation/"}},{"name":"Greetings","description":"","externalDocs":{"description":"Greetings Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/greetings/"}},{"name":"Groups","description":"Groups, members","externalDocs":{"description":"Groups Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/groups/"}},{"name":"Identity Provider","description":"Identity providers","externalDocs":{"description":"Identity Providers Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/identityprovider/"}},{"name":"Integrations","description":"","externalDocs":{"description":"Integrations Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/integrations/"}},{"name":"Journey","description":"Predictive Engagement, Customer Journey","externalDocs":{"description":"Journey documentation","url":""}},{"name":"Languages","description":"Available languages","externalDocs":{"description":"Languages Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/languages/"}},{"name":"Knowledge","description":"Knowledge administration and search"},{"name":"Language Understanding","description":"Language Understanding","externalDocs":{"description":"Language Understanding documentation","url":""}},{"name":"Licensing","description":""},{"name":"License","description":"Per-user platform license assignments","externalDocs":{"description":"License Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/license/"}},{"name":"Locations","description":"Physical locations","externalDocs":{"description":"Locations Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/locations/"}},{"name":"Mobile Devices","description":"Devices","externalDocs":{"description":"Devices Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/mobiledevices/"}},{"name":"Notifications","description":"Channels, subscriptions, topics, mobile push registration","externalDocs":{"description":"Notifications Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/notifications/"}},{"name":"OAuth","description":"OAuth clients, providers","externalDocs":{"description":"OAuth Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/oauth/"}},{"name":"Objects","description":"Access-controlled objects in the platform","externalDocs":{"description":"authorization docs","url":"https://developer.mypurecloud.com/api/rest/v2/authorization/"}},{"name":"Organization","description":"Organization","externalDocs":{"description":"Organization Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/organization/"}},{"name":"Organization Authorization","description":"Organization Authorization","externalDocs":{"description":"Organization Authorization Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/organizationauthorization/"}},{"name":"Outbound","description":"","externalDocs":{"description":"Outbound Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/outbound/"}},{"name":"Presence","description":"User and organization presences","externalDocs":{"description":"Presence Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/presence/"}},{"name":"Quality","description":"Evaluations, calibrations","externalDocs":{"description":"Quality Management Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/quality/"}},{"name":"Recording","description":"Recordings, policies, annotations, orphans","externalDocs":{"description":"Recording Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/recording/"}},{"name":"Response Management","description":"Responses, library, query","externalDocs":{"description":"Response Management Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/responsemanagement/"}},{"name":"Routing","description":"Queues, wrapup codes, skills, email & sms config, predictive routing","externalDocs":{"description":"Routing Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/routing/"}},{"name":"SCIM","description":"System for Cross-domain Identity Management","externalDocs":{"description":"System for Cross-domain Identity Management: Definitions, Overview, Concepts, and Requirements","url":"https://developer.mypurecloud.com/api/rest/v2/scim/scim-overview.html"}},{"name":"Scripts","description":"Agent-facing scripts for interactions","externalDocs":{"description":"Scripts Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/scripts/"}},{"name":"Search","description":"Search aggregate, users, groups","externalDocs":{"description":"Search Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/search/"}},{"name":"Speech & Text Analytics","description":""},{"name":"Stations","description":"Stations","externalDocs":{"description":"Stations Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/stations/"}},{"name":"Suggest","description":"Search suggest user, group, locations"},{"name":"Telephony","description":"Telephony providers and configuration","externalDocs":{"description":"Telephony Documentation","url":""}},{"name":"Telephony Providers Edge","description":"Edge phones, trunks, lines.","externalDocs":{"description":"telephony provider edge","url":"https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/"}},{"name":"Textbots","description":"Chatbot Interactions"},{"name":"Tokens","description":"Authentication Tokens","externalDocs":{"description":"Tokens Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/tokens/"}},{"name":"Uploads","description":"Presigned url generator for uploading files","externalDocs":{"description":"Upload Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/uploads/"}},{"name":"User Recordings","description":"Summary, media","externalDocs":{"description":"User Recordings Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/userrecordings/"}},{"name":"Users","description":"Me, routing, roles","externalDocs":{"description":"Users Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/users/"}},{"name":"Utilities","description":"","externalDocs":{"description":"Utilities Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/utilities/"}},{"name":"Videos","description":""},{"name":"Voicemail","description":"Mailbox, messages, policy","externalDocs":{"description":"Voicemail Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/voicemail/"}},{"name":"WebChat","description":"WebChat deployments","externalDocs":{"description":"WebChat Deployment Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/webchat/"}},{"name":"Widgets","description":"Widget deployments","externalDocs":{"description":"Widget Deployment Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/widgets/"}},{"name":"Usage","description":"View organizational level usage data"},{"name":"Workforce Management","description":"Adherence, Schedules, Forecasts, Intraday Monitoring, Time Off Requests, Configuration","externalDocs":{"description":"Workforce Management Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/workforcemanagement/"}}],"schemes":["https"],"consumes":["application/json"],"produces":["application/json"],"paths":{"/api/v2/contentmanagement/documents/{documentId}":{"get":{"tags":["Content Management"],"summary":"Get a document.","description":"","operationId":"getContentmanagementDocument","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["lockInfo","acl","workspace"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"lockInfo"},{"name":"acl"},{"name":"workspace"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Document"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"forbidden":"Forbidden from getting document","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementDocument"},"post":{"tags":["Content Management"],"summary":"Update a document.","description":"","operationId":"postContentmanagementDocument","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Document","required":true,"schema":{"$ref":"#/definitions/DocumentUpdate"}},{"name":"expand","in":"query","description":"Expand some document fields","required":false,"type":"string","enum":["acl"],"x-genesys-enum-members":[{"name":"acl"}]},{"name":"override","in":"query","description":"Override any lock on the document","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Document"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Resource conflict - Unexpected changeNumber was provided"},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"423":{"description":"Locked - The document is locked by another operation"},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"postContentmanagementDocument"},"delete":{"tags":["Content Management"],"summary":"Delete a document.","description":"","operationId":"deleteContentmanagementDocument","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"name":"override","in":"query","description":"Override any lock on the document","required":false,"type":"boolean"}],"responses":{"202":{"description":"Accepted - Processing Delete"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"423":{"description":"Locked - The document is locked by another operation"},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"deleteContentmanagementDocument"}},"/api/v2/locations/{locationId}/sublocations":{"get":{"tags":["Locations"],"summary":"Get sublocations for location ID.","description":"","operationId":"getLocationSublocations","produces":["application/json"],"parameters":[{"name":"locationId","in":"path","description":"Location ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LocationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["locations","locations:readonly"]}],"x-purecloud-method-name":"getLocationSublocations"}},"/api/v2/locations/{locationId}":{"get":{"tags":["Locations"],"summary":"Get Location by ID.","description":"","operationId":"getLocation","produces":["application/json"],"parameters":[{"name":"locationId","in":"path","description":"Location ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["images","addressVerificationDetails"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"images"},{"name":"addressVerificationDetails"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LocationDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Location is not found by given location id.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["locations","locations:readonly"]}],"x-purecloud-method-name":"getLocation"},"delete":{"tags":["Locations"],"summary":"Delete a location","description":"","operationId":"deleteLocation","produces":["application/json"],"parameters":[{"name":"locationId","in":"path","description":"Location ID","required":true,"type":"string"}],"responses":{"204":{"description":"The location was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","general.bad.request":"Unable to delete a location due to invalid request."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["locations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["directory:location:delete"]},"x-purecloud-method-name":"deleteLocation"},"patch":{"tags":["Locations"],"summary":"Update a location","description":"","operationId":"patchLocation","produces":["application/json"],"parameters":[{"name":"locationId","in":"path","description":"Location ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Location","required":true,"schema":{"$ref":"#/definitions/LocationUpdateDefinition"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LocationDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"Unable to update a location due to invalid request.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"Unable to update a location due to a conflict."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["locations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["directory:location:edit"]},"x-purecloud-method-name":"patchLocation"}},"/api/v2/telephony/providers/edges/lines/{lineId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Line by ID","description":"","operationId":"getTelephonyProvidersEdgesLine","produces":["application/json"],"parameters":[{"name":"lineId","in":"path","description":"Line ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Line"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find an outbound route with that id","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesLine"}},"/api/v2/quality/publishedforms":{"get":{"tags":["Quality"],"summary":"Get the published evaluation forms.","description":"","operationId":"getQualityPublishedforms","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"onlyLatestPerContext","in":"query","description":"onlyLatestPerContext","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:view"]},"x-purecloud-method-name":"getQualityPublishedforms"},"post":{"tags":["Quality"],"summary":"Publish an evaluation form.","description":"","operationId":"postQualityPublishedforms","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Publish request containing id of form to publish","required":true,"schema":{"$ref":"#/definitions/PublishForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"evaluation.already.published":"Evaluation has already been published."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:add"]},"x-purecloud-method-name":"postQualityPublishedforms"}},"/api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get edge logical interfaces.","description":"Retrieve a list of all configured logical interfaces from a specific edge.","operationId":"getTelephonyProvidersEdgeLogicalinterfaces","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Field to expand in the response","required":false,"type":"array","items":{"type":"string","enum":["externalTrunkBaseAssignments","phoneTrunkBaseAssignments"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"externalTrunkBaseAssignments"},{"name":"phoneTrunkBaseAssignments"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LogicalInterfaceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgeLogicalinterfaces"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create an edge logical interface.","description":"Create","operationId":"postTelephonyProvidersEdgeLogicalinterfaces","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Logical interface","required":true,"schema":{"$ref":"#/definitions/DomainLogicalInterface"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainLogicalInterface"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","duplicate.value":"A logical interface with that vlanTagId already exists on this port.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgeLogicalinterfaces"}},"/api/v2/architect/emergencygroups":{"get":{"tags":["Architect"],"summary":"Get a list of emergency groups.","description":"","operationId":"getArchitectEmergencygroups","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"name","in":"query","description":"Name of the Emergency Group to filter by.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmergencyGroupListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:emergencyGroup:view"]},"x-purecloud-method-name":"getArchitectEmergencygroups"},"post":{"tags":["Architect"],"summary":"Creates a new emergency group","description":"","operationId":"postArchitectEmergencygroups","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/EmergencyGroup"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmergencyGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:emergencyGroup:add"]},"x-purecloud-method-name":"postArchitectEmergencygroups"}},"/api/v2/telephony/providers/edges/edgeversionreport":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the edge version report.","description":"The report will not have consistent data about the edge version(s) until all edges have been reset.","operationId":"getTelephonyProvidersEdgesEdgeversionreport","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeVersionReport"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-purecloud-method-name":"getTelephonyProvidersEdgesEdgeversionreport"}},"/api/v2/flows/milestones/{milestoneId}":{"get":{"tags":["Architect"],"summary":"Get a flow milestone","description":"Returns a specified flow milestone","operationId":"getFlowsMilestone","produces":["application/json"],"parameters":[{"name":"milestoneId","in":"path","description":"flow milestone ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowMilestone"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.milestone.not.found":"Specified flow milestone not found.","not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.feature.unavailable":"Flow milestones feature is not available for current organization."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowMilestone:view"]},"x-purecloud-method-name":"getFlowsMilestone"},"put":{"tags":["Architect"],"summary":"Updates a flow milestone","description":"","operationId":"putFlowsMilestone","produces":["application/json"],"parameters":[{"name":"milestoneId","in":"path","description":"flow milestone ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/FlowMilestone"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowMilestone"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.milestone.validate.failed.invalid.name.no.alpha":"Failed to validate flow milestone due to invalid name. Names must contain at least one alphanumeric character.","architect.flow.milestone.validate.failed.invalid.name.spaces":"Failed to validate flow milestone due to invalid name. Names must not contain leading or trailing whitespaces.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","architect.property.exceeds.max.character.length":"The name and/or description exceeds the maximum character length.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","architect.object.validate.failed":"Failed to validate object.","architect.flow.milestone.validate.failed.missing.name":"Failed to validate flow milestone due to missing name.","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.milestone.not.found":"Could not find the specified flow milestone.","not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.feature.unavailable":"Flow milestones feature is not available for current organization."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.milestone.already.exists":"A flow milestone with the specified name already exists."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.unspecified.error":"An unknown error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowMilestone:edit"]},"x-purecloud-method-name":"putFlowsMilestone"},"delete":{"tags":["Architect"],"summary":"Delete a flow milestone.","description":"","operationId":"deleteFlowsMilestone","produces":["application/json"],"parameters":[{"name":"milestoneId","in":"path","description":"flow milestone ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"204":{"description":"Delete was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.milestone.not.found":"Could not find the specified flow milestone.","not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.feature.unavailable":"Flow milestones feature is not available for current organization."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.dependency.object.in.use":"The object cannot be deleted because other objects depend on it."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.unspecified.error":"An unknown error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowMilestone:delete"]},"x-purecloud-method-name":"deleteFlowsMilestone"}},"/api/v2/recording/recordingkeys":{"get":{"tags":["Recording"],"summary":"Get encryption key list","description":"","operationId":"getRecordingRecordingkeys","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EncryptionKeyEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:encryptionKey:view"]},"x-purecloud-method-name":"getRecordingRecordingkeys"},"post":{"tags":["Recording"],"summary":"Create encryption key","description":"","operationId":"postRecordingRecordingkeys","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EncryptionKey"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:encryptionKey:edit"]},"x-purecloud-method-name":"postRecordingRecordingkeys"}},"/api/v2/search/suggest":{"get":{"tags":["Search","Suggest"],"summary":"Suggest resources using the q64 value returned from a previous suggest query.","description":"","operationId":"getSearchSuggest","produces":["application/json"],"parameters":[{"name":"q64","in":"query","description":"q64","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography","callerUser.routingStatus","callerUser.primaryPresence","callerUser.conversationSummary","callerUser.outOfOffice","callerUser.geolocation","images","addressVerificationDetails"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"routingStatus"},{"name":"presence"},{"name":"conversationSummary"},{"name":"outOfOffice"},{"name":"geolocation"},{"name":"station"},{"name":"authorization"},{"name":"lasttokenissued"},{"name":"authorization.unusedRoles"},{"name":"team"},{"name":"profileSkills"},{"name":"certifications"},{"name":"locations"},{"name":"groups"},{"name":"skills"},{"name":"languages"},{"name":"languagePreference"},{"name":"employerInfo"},{"name":"biography"},{"name":"callerUser.routingStatus"},{"name":"callerUser.primaryPresence"},{"name":"callerUser.conversationSummary"},{"name":"callerUser.outOfOffice"},{"name":"callerUser.geolocation"},{"name":"images"},{"name":"addressVerificationDetails"}]},{"name":"profile","in":"query","description":"profile","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JsonNodeSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["search:readonly"]}],"x-purecloud-method-name":"getSearchSuggest"},"post":{"tags":["Search","Suggest"],"summary":"Suggest resources.","description":"","operationId":"postSearchSuggest","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/SuggestSearchRequest"}},{"name":"profile","in":"query","description":"profile","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JsonNodeSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["search:readonly"]}],"x-purecloud-method-name":"postSearchSuggest"}},"/api/v2/search":{"get":{"tags":["Search","Suggest"],"summary":"Search using the q64 value returned from a previous search.","description":"","operationId":"getSearch","produces":["application/json"],"parameters":[{"name":"q64","in":"query","description":"q64","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography","callerUser.routingStatus","callerUser.primaryPresence","callerUser.conversationSummary","callerUser.outOfOffice","callerUser.geolocation","images","addressVerificationDetails"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"routingStatus"},{"name":"presence"},{"name":"conversationSummary"},{"name":"outOfOffice"},{"name":"geolocation"},{"name":"station"},{"name":"authorization"},{"name":"lasttokenissued"},{"name":"authorization.unusedRoles"},{"name":"team"},{"name":"profileSkills"},{"name":"certifications"},{"name":"locations"},{"name":"groups"},{"name":"skills"},{"name":"languages"},{"name":"languagePreference"},{"name":"employerInfo"},{"name":"biography"},{"name":"callerUser.routingStatus"},{"name":"callerUser.primaryPresence"},{"name":"callerUser.conversationSummary"},{"name":"callerUser.outOfOffice"},{"name":"callerUser.geolocation"},{"name":"images"},{"name":"addressVerificationDetails"}]},{"name":"profile","in":"query","description":"profile","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JsonNodeSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","too.many.search.requests":"Rate limit for search requests exceeded"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["search:readonly"]}],"x-purecloud-method-name":"getSearch"},"post":{"tags":["Search","Suggest"],"summary":"Search resources.","description":"","operationId":"postSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/SearchRequest"}},{"name":"profile","in":"query","description":"profile","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JsonNodeSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","user.not.in.organization":"User is not in organization.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","too.many.search.requests":"Rate limit for search requests exceeded"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["search:readonly"]}],"x-purecloud-method-name":"postSearch"}},"/api/v2/recordings/deletionprotection":{"post":{"tags":["Recording"],"summary":"Get a list of conversations with protected recordings","description":"","operationId":"postRecordingsDeletionprotection","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"conversationIds","required":true,"schema":{"$ref":"#/definitions/ConversationDeletionProtectionQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/AddressableEntityRef"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.conversation.id.not.uuid":"Request needs recording conversation ID not UUID.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.conversation.not.found":"Recording conversation not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings:readonly"]}],"x-purecloud-method-name":"postRecordingsDeletionprotection"},"put":{"tags":["Recording"],"summary":"Apply or revoke recording protection for conversations","description":"","operationId":"putRecordingsDeletionprotection","produces":["application/json"],"parameters":[{"name":"protect","in":"query","description":"Check for apply, uncheck for revoke (each action requires the respective permission)","required":false,"type":"boolean","default":true},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ConversationDeletionProtectionQuery"}}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.conversation.not.found":"Recording conversation not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:deletionProtection:apply","recording:deletionProtection:revoke"]},"x-purecloud-method-name":"putRecordingsDeletionprotection"}},"/api/v2/gdpr/subjects":{"get":{"tags":["General Data Protection Regulation"],"summary":"Get GDPR subjects","description":"","operationId":"getGdprSubjects","produces":["application/json"],"parameters":[{"name":"searchType","in":"query","description":"Search Type","required":true,"type":"string","enum":["NAME","ADDRESS","PHONE","EMAIL","TWITTER"],"x-genesys-enum-members":[{"name":"NAME"},{"name":"ADDRESS"},{"name":"PHONE"},{"name":"EMAIL"},{"name":"TWITTER"}]},{"name":"searchValue","in":"query","description":"Search Value","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GDPRSubjectEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.error":"An internal server error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gdpr","gdpr:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gdpr:subject:view"]},"x-purecloud-method-name":"getGdprSubjects"}},"/api/v2/knowledge/knowledgebases":{"get":{"tags":["Knowledge"],"summary":"Get knowledge bases","description":"","operationId":"getKnowledgeKnowledgebases","produces":["application/json"],"parameters":[{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"limit","in":"query","description":"Number of entities to return. Maximum of 200. Deprecated in favour of pageSize.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"name":"name","in":"query","description":"Name of the KnowledgeBase to filter.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeBaseListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","input.validations":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:knowledgebase:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebases"},"post":{"tags":["Knowledge"],"summary":"Create new knowledge base","description":"","operationId":"postKnowledgeKnowledgebases","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeBase"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"kb.limitexceeded":"Knowledge Base count exceeded","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","input.validations":"Input parameters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:knowledgebase:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebases"}},"/api/v2/scripts/published":{"get":{"tags":["Scripts"],"summary":"Get the published scripts.","description":"","operationId":"getScriptsPublished","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"Expand","required":false,"type":"string"},{"name":"name","in":"query","description":"Name filter","required":false,"type":"string"},{"name":"feature","in":"query","description":"Feature filter","required":false,"type":"string"},{"name":"flowId","in":"query","description":"Secure flow id filter","required":false,"type":"string"},{"name":"scriptDataVersion","in":"query","description":"Advanced usage - controls the data version of the script","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScriptEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:publishedScript:view"]},"x-purecloud-method-name":"getScriptsPublished"}},"/api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId}":{"get":{"tags":["Outbound"],"summary":"Get a dialer call analysis response set.","description":"","operationId":"getOutboundCallanalysisresponseset","produces":["application/json"],"parameters":[{"name":"callAnalysisSetId","in":"path","description":"Call Analysis Response Set ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:responseSet:view"]},"x-purecloud-method-name":"getOutboundCallanalysisresponseset"},"put":{"tags":["Outbound"],"summary":"Update a dialer call analysis response set.","description":"","operationId":"putOutboundCallanalysisresponseset","produces":["application/json"],"parameters":[{"name":"callAnalysisSetId","in":"path","description":"Call Analysis Response Set ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ResponseSet","required":true,"schema":{"$ref":"#/definitions/ResponseSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update":"","name.cannot.be.blank":"A name must be provided.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","duplicate.name":"The name already exists.","invalid.flow":"The outbound flow could not be found.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.call.analysis.response.set":"The call analysis response set is invalid.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.call.analysis.response.set.for.agentless.campaign":"The call analysis response set is invalid for agentless campaigns."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.wrong.version":""}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:responseSet:edit"]},"x-purecloud-method-name":"putOutboundCallanalysisresponseset"},"delete":{"tags":["Outbound"],"summary":"Delete a dialer call analysis response set.","description":"","operationId":"deleteOutboundCallanalysisresponseset","produces":["application/json"],"parameters":[{"name":"callAnalysisSetId","in":"path","description":"Call Analysis Response Set ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"call.analysis.response.set.in.use":"The dialer call analysis response set is in use.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","referential.integrity.error":"Could not delete the resource because it is referenced by another entity."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:responseSet:delete"]},"x-purecloud-method-name":"deleteOutboundCallanalysisresponseset"}},"/api/v2/voicemail/policy":{"get":{"tags":["Voicemail"],"summary":"Get a policy","description":"","operationId":"getVoicemailPolicy","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailOrganizationPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getVoicemailPolicy"},"put":{"tags":["Voicemail"],"summary":"Update a policy","description":"","operationId":"putVoicemailPolicy","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Policy","required":true,"schema":{"$ref":"#/definitions/VoicemailOrganizationPolicy"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailOrganizationPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"voicemailservice.orgvoicemailconfig.alerttimeouttoolarge":"AlertTimeoutTooLarge","voicemailservice.orgvoicemailconfig.maxpinlengthtoosmall":"MaxPinLengthTooSmall","voicemailservice.orgvoicemailconfig.iterationstoolarge":"IterationsTooLarge","voicemailservice.orgvoicemailconfig.uservoicemailretentionpolicynumberofdaysmissing":"UserVoicemailRetentionPolicyNumberOfDaysMissing","voicemailservice.orgvoicemailconfig.groupvoicemailretentionpolicytypemissing":"GroupVoicemailRetentionPolicyTypeMissing","voicemailservice.orgvoicemailconfig.minrecordingtimegreaterthanmax":"MinRecordingTimeGreaterThanMax","voicemailservice.orgvoicemailconfig.organizationnotfound":"OrganizationNotFound","voicemailservice.orgvoicemailconfig.saltlengthtoolarge":"SaltLengthTooLarge","voicemailservice.orgvoicemailconfig.groupvoicemailretentionpolicynumberofdaysmissing":"GroupVoicemailRetentionPolicyNumberOfDaysMissing","voicemailservice.orgvoicemailconfig.groupvoicemailretentionpolicynumberofdaystoolarge":"GroupVoicemailRetentionPolicyNumberOfDaysTooLarge","voicemailservice.orgvoicemailconfig.uservoicemailretentionpolicytypemissing":"UserVoicemailRetentionPolicyTypeMissing","voicemailservice.orgvoicemailconfig.queuevoicemailretentionpolicytypeunknown":"QueueVoicemailRetentionPolicyTypeUnknown","voicemailservice.orgvoicemailconfig.groupvoicemailretentionpolicynumberofdaystoosmall":"GroupVoicemailRetentionPolicyNumberOfDaysTooSmall","voicemailservice.orgvoicemailconfig.minpinlengthtoosmall":"MinPinLengthTooSmall","voicemailservice.orgvoicemailconfig.maxrecordingtimetoolarge":"MaxRecordingTimeTooLarge","voicemailservice.orgvoicemailconfig.queuevoicemailretentionpolicynumberofdaystoolarge":"QueueVoicemailRetentionPolicyNumberOfDaysTooLarge","voicemailservice.orgvoicemailconfig.uservoicemailretentionpolicytypeunknown":"UserVoicemailRetentionPolicyTypeUnknown","voicemailservice.orgvoicemailconfig.alerttimeouttoosmall":"AlertTimeoutTooSmall","voicemailservice.orgvoicemailconfig.iterationstoosmall":"IterationsTooSmall","voicemailservice.orgvoicemailconfig.uservoicemailretentionpolicynumberofdaystoolarge":"UserVoicemailRetentionPolicyNumberOfDaysTooLarge","voicemailservice.orgvoicemailconfig.invalidalgorithm":"InvalidAlgorithm","voicemailservice.orgvoicemailconfig.keylengthtoosmall":"KeyLengthTooSmall","voicemailservice.orgvoicemailconfig.queuevoicemailretentionpolicynumberofdaystoosmall":"QueueVoicemailRetentionPolicyNumberOfDaysTooSmall","voicemailservice.orgvoicemailconfig.queuevoicemailretentionpolicytypemissing":"QueueVoicemailRetentionPolicyTypeMissing","voicemailservice.orgvoicemailconfig.minrecordingtimetoosmall":"MinRecordingTimeTooSmall","voicemailservice.orgvoicemailconfig.hipaaenabledorganizationcannotsendemailnotifications":"HipaaEnabledOrganizationCannotSendEmailNotifications","voicemailservice.orgvoicemailconfig.queuevoicemailretentionpolicynumberofdaysmissing":"QueueVoicemailRetentionPolicyNumberOfDaysMissing","voicemailservice.orgvoicemailconfig.groupvoicemailretentionpolicytypeunknown":"GroupVoicemailRetentionPolicyTypeUnknown","voicemailservice.orgvoicemailconfig.uservoicemailretentionpolicynumberofdaystoosmall":"UserVoicemailRetentionPolicyNumberOfDaysTooSmall","voicemailservice.orgvoicemailconfig.keylengthtoolarge":"KeyLengthTooLarge","voicemailservice.orgvoicemailconfig.saltlengthtoosmall":"SaltLengthTooSmall","voicemailservice.orgvoicemailconfig.minpinlengthgreaterthanmax":"MinPinLengthGreaterThanMax"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"424":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"voicemailservice.orgvoicemailconfig.unabletoverifyorganizationhipaaenabledflag":"UnableToVerifyOrganizationHipaaEnabledFlag"}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putVoicemailPolicy"}},"/api/v2/users/me":{"get":{"tags":["Users"],"summary":"Get current user details.","description":"This request is not valid when using the Client Credentials OAuth grant.","operationId":"getUsersMe","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography","date","geolocationsettings","organization","presencedefinitions","locationdefinitions","orgauthorization","orgproducts","favorites","superiors","directreports","adjacents","routingskills","routinglanguages","fieldconfigs","token","trustors","logCapture"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"routingStatus"},{"name":"presence"},{"name":"conversationSummary"},{"name":"outOfOffice"},{"name":"geolocation"},{"name":"station"},{"name":"authorization"},{"name":"lasttokenissued"},{"name":"authorization.unusedRoles"},{"name":"team"},{"name":"profileSkills"},{"name":"certifications"},{"name":"locations"},{"name":"groups"},{"name":"skills"},{"name":"languages"},{"name":"languagePreference"},{"name":"employerInfo"},{"name":"biography"},{"name":"date"},{"name":"geolocationsettings"},{"name":"organization"},{"name":"presencedefinitions"},{"name":"locationdefinitions"},{"name":"orgauthorization"},{"name":"orgproducts"},{"name":"favorites"},{"name":"superiors"},{"name":"directreports"},{"name":"adjacents"},{"name":"routingskills"},{"name":"routinglanguages"},{"name":"fieldconfigs"},{"name":"token"},{"name":"trustors"},{"name":"logCapture"}]},{"name":"integrationPresenceSource","in":"query","description":"Get your presence for a given integration. This parameter will only be used when presence is provided as an \"expand\".","required":false,"type":"string","enum":["MicrosoftTeams","ZoomPhone","RingCentral"],"x-genesys-enum-members":[{"name":"MicrosoftTeams"},{"name":"ZoomPhone"},{"name":"RingCentral"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserMe"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The requested userID could not be found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["user-basic-info"]}],"x-purecloud-method-name":"getUsersMe"}},"/api/v2/outbound/callanalysisresponsesets":{"get":{"tags":["Outbound"],"summary":"Query a list of dialer call analysis response sets.","description":"","operationId":"getOutboundCallanalysisresponsesets","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"allowEmptyResult","in":"query","description":"Whether to return an empty page when there are no results for that page","required":false,"type":"boolean","default":false},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"],"x-genesys-enum-members":[{"name":"Equals"},{"name":"RegEx"},{"name":"Contains"},{"name":"Prefix"},{"name":"LessThan"},{"name":"LessThanEqualTo"},{"name":"GreaterThan"},{"name":"GreaterThanEqualTo"},{"name":"BeginsWith"},{"name":"EndsWith"}]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseSetEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:responseSet:view"]},"x-purecloud-method-name":"getOutboundCallanalysisresponsesets"},"post":{"tags":["Outbound"],"summary":"Create a dialer call analysis response set.","description":"","operationId":"postOutboundCallanalysisresponsesets","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ResponseSet","required":true,"schema":{"$ref":"#/definitions/ResponseSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","max.entity.count.reached":"The maximum call analysis response set count has been reached.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","duplicate.name":"The name already exists.","invalid.create":"","invalid.flow":"The outbound flow could not be found.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:responseSet:add"]},"x-purecloud-method-name":"postOutboundCallanalysisresponsesets"}},"/api/v2/contentmanagement/usage":{"get":{"tags":["Content Management"],"summary":"Get usage details.","description":"","operationId":"getContentmanagementUsage","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Usage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementUsage"}},"/api/v2/outbound/campaigns/{campaignId}/agents/{userId}":{"put":{"tags":["Outbound"],"summary":"Send notification that an agent's state changed ","description":"New agent state.","operationId":"putOutboundCampaignAgent","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"},{"name":"userId","in":"path","description":"Agent's user ID","required":true,"type":"string"},{"in":"body","name":"body","description":"agent","required":true,"schema":{"$ref":"#/definitions/Agent"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.stage":"No stage was provided.","invalid.campaign.status":"The dialer campaign was not active.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The dialer campaign was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-purecloud-method-name":"putOutboundCampaignAgent"}},"/api/v2/workforcemanagement/schedules":{"post":{"tags":["Workforce Management"],"summary":"Get published schedule for the current user","description":"","operationId":"postWorkforcemanagementSchedules","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/CurrentUserScheduleRequestBody"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserScheduleContainer"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentSchedule:view"]},"x-purecloud-method-name":"postWorkforcemanagementSchedules"}},"/api/v2/workforcemanagement/schedulingjobs/{jobId}":{"get":{"tags":["Workforce Management"],"summary":"Get status of the scheduling job","description":"","operationId":"getWorkforcemanagementSchedulingjob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"The id of the scheduling job","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SchedulingStatusResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedulingrequest:view"]},"x-purecloud-method-name":"getWorkforcemanagementSchedulingjob"}},"/api/v2/outbound/campaigns":{"get":{"tags":["Outbound"],"summary":"Query a list of dialer campaigns.","description":"","operationId":"getOutboundCampaigns","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"],"x-genesys-enum-members":[{"name":"Equals"},{"name":"RegEx"},{"name":"Contains"},{"name":"Prefix"},{"name":"LessThan"},{"name":"LessThanEqualTo"},{"name":"GreaterThan"},{"name":"GreaterThanEqualTo"},{"name":"BeginsWith"},{"name":"EndsWith"}]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"contactListId","in":"query","description":"Contact List ID","required":false,"type":"string"},{"name":"dncListIds","in":"query","description":"DNC list ID","required":false,"type":"string"},{"name":"distributionQueueId","in":"query","description":"Distribution queue ID","required":false,"type":"string"},{"name":"edgeGroupId","in":"query","description":"Edge group ID","required":false,"type":"string"},{"name":"callAnalysisResponseSetId","in":"query","description":"Call analysis response set ID","required":false,"type":"string"},{"name":"divisionId","in":"query","description":"Division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.bulk.retrieves":"Only 100 campaigns can be retrieved by id at a time","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:view"]},"x-purecloud-method-name":"getOutboundCampaigns"},"post":{"tags":["Outbound"],"summary":"Create a campaign.","description":"","operationId":"postOutboundCampaigns","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Campaign","required":true,"schema":{"$ref":"#/definitions/Campaign"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Campaign"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","invalid.campaign.outbound.line.count":"","invalid.priority":"The priority must be between 1 and 5 (inclusive)","name.length.exceeded":"The name length exceeds the limit of 64 characters.","too.many.queue.members":"The limit for number of queue members on a campaign configured for agent owned records has been exceeded. See details.","bad.request":"The request could not be understood by the server due to malformed syntax.","callable.time.set.not.found":"The callable time set could not be found.","duplicate.name":"The name already exists.","invalid.create":"","site.has.no.active.edges":"There are no active edges in the site","edge.group.not.found":"The edge group could not be found.","missing.caller.id.name":"No caller id name supplied","too.many.data.action.conditions":"There can be a maximum of 1 data action condition across all rule sets referenced by this campaign","contact.sorts.duplicate.field.names":"The same column name is used in separate contact sorts entries.","invalid.agent.owned.dialing.mode":"Agent owned records are only available for the Preview dialing mode.","contact.list.filter.does.not.match.contact.list":"The contact list on the contact list filter does not match the contact list on the campaign.","more.than.one.contact.list.filter":"Only one contact list filter is allowed per campaign.","managed.site.cannot.be.configured":"Managed Sites cannot be configured on a campaign.","invalid.campaign.preview.timeout.seconds":"The preview timeout seconds must be between 0 and 1200 (inclusive)","call.analysis.response.set.not.found":"The call analysis response set could not be found.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","script.not.found":"The script could not be found.","contact.list.filter.not.found":"The contact list filter could not be found.","site.and.edge.group.cannot.be.configured":"A single campaign cannot have both a site and an edge group configured","dnc.list.not.found":"A do not call list could not be found.","contact.sort.field.not.found":"The contact sort field is not a column on the contact list.","invalid.campaign.agent.owned.column":"The campaign agent owned column is not a valid contact list column.","contact.sorts.invalid.field.name":"A contact sorts field name is not a valid column name in the campaign's contact list.","missing.caller.id.address":"No caller id address supplied","external.calling.property.not.allowed":"Some properties cannot be set on an external calling campaign. See details","edge.group.has.no.active.edges":"There are no active edges in the edge group","rule.set.not.found":"A rule set could not be found.","managed.edge.group.cannot.be.configured":"Managed Edge Groups cannot be configured on a campaign.","property.not.allowed.for.external.calling":"Property is not allowed for external calling","max.entity.count.reached":"The maximum campaign count has been reached.","invalid.ani.address":"The caller id number is invalid.","invalid.campaign.phone.columns":"The campaign phone columns are invalid.","callable.time.set.conflicts.with.automatic.time.zone.mapping":"A callable time set cannot be included on the campaign when the campaign's contact list uses automatic time zone mapping.","contact.sorts.conflict":"The contact sort and contact sorts fields have conflicting values.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","edge.group.is.empty":"There are no edges in the edge group","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","missing.time.zone.in.contactlist":"When using a callable time set, the contact list must have at least one time zone column defined.","invalid.dialing.mode.update":"A campaign may not be updated to or from external dialing mode to any other dialing mode.","site.not.found":"The site could not be found","site.is.empty":"There are no edges in the site","queue.not.found":"The queue could not be found.","no.edge.group.for.site":"No edge group was found for the site"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:add"]},"x-purecloud-method-name":"postOutboundCampaigns"}},"/api/v2/integrations/speech/tts/engines/{engineId}/voices":{"get":{"tags":["Integrations"],"summary":"Get a list of voices for a TTS engine","description":"","operationId":"getIntegrationsSpeechTtsEngineVoices","produces":["application/json"],"parameters":[{"name":"engineId","in":"path","description":"The engine ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TtsVoiceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechTtsEngineVoices"}},"/api/v2/geolocations/settings":{"get":{"tags":["Geolocation"],"summary":"Get a organization's GeolocationSettings","description":"","operationId":"getGeolocationsSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GeolocationSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["geolocation","geolocation:readonly"]}],"x-purecloud-method-name":"getGeolocationsSettings"},"patch":{"tags":["Geolocation"],"summary":"Patch a organization's GeolocationSettings","description":"","operationId":"patchGeolocationsSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Geolocation settings","required":true,"schema":{"$ref":"#/definitions/GeolocationSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GeolocationSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["geolocation"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["geolocation:settings:edit"]},"x-purecloud-method-name":"patchGeolocationsSettings"}},"/api/v2/routing/queues/{queueId}/mediatypes/{mediaType}/estimatedwaittime":{"get":{"tags":["Routing"],"summary":"Get Estimated Wait Time","description":"","operationId":"getRoutingQueueMediatypeEstimatedwaittime","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"queueId","required":true,"type":"string"},{"name":"mediaType","in":"path","description":"mediaType","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EstimatedWaitTimePredictions"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"At least one of the required division permissions is missing","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:queue:view"]},"x-purecloud-method-name":"getRoutingQueueMediatypeEstimatedwaittime"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/{agentId}/shifttrades":{"get":{"tags":["Workforce Management"],"summary":"Gets all the shift trades for a given agent","description":"","operationId":"getWorkforcemanagementManagementunitAgentShifttrades","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The id of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"agentId","in":"path","description":"The agent id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ShiftTradeListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:shiftTradeRequest:edit","wfm:shiftTradeRequest:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitAgentShifttrades"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/{agentId}":{"get":{"tags":["Workforce Management"],"summary":"Get data for agent in the management unit","description":"","operationId":"getWorkforcemanagementManagementunitAgent","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The id of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"agentId","in":"path","description":"The agent id","required":true,"type":"string"},{"name":"excludeCapabilities","in":"query","description":"Excludes all capabilities of the agent such as queues, languages, and skills","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WfmAgent"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agent:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitAgent"}},"/api/v2/integrations/speech/lex/bot/alias/{aliasId}":{"get":{"tags":["Integrations"],"summary":"Get details about a Lex bot alias","description":"","operationId":"getIntegrationsSpeechLexBotAlias","produces":["application/json"],"parameters":[{"name":"aliasId","in":"path","description":"The alias ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LexBotAlias"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request is badly formed","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechLexBotAlias"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/agentschedules/search":{"post":{"tags":["Workforce Management"],"summary":"Search published schedules","description":"","operationId":"postWorkforcemanagementBusinessunitAgentschedulesSearch","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/BuSearchAgentSchedulesRequest"}},{"name":"forceAsync","in":"query","description":"Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes","required":false,"type":"boolean"},{"name":"forceDownloadService","in":"query","description":"Force the result of this operation to be sent via download service. For testing/app development purposes","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuAsyncAgentSchedulesSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:view","wfm:publishedSchedule:view"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitAgentschedulesSearch"}},"/api/v2/integrations/speech/lex/bot/{botId}/aliases":{"get":{"tags":["Integrations"],"summary":"Get a list of aliases for a bot in the customer's AWS accounts","description":"","operationId":"getIntegrationsSpeechLexBotBotIdAliases","produces":["application/json"],"parameters":[{"name":"botId","in":"path","description":"The bot ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"status","in":"query","description":"Filter on alias status","required":false,"type":"string","enum":["READY","FAILED","BUILDING","NOT_BUILT"],"x-genesys-enum-members":[{"name":"READY"},{"name":"FAILED"},{"name":"BUILDING"},{"name":"NOT_BUILT"}]},{"name":"name","in":"query","description":"Filter on alias name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LexBotAliasEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechLexBotBotIdAliases"}},"/api/v2/users/{userId}/queues/{queueId}":{"patch":{"tags":["Routing","Users"],"summary":"Join or unjoin a queue for a user","description":"","operationId":"patchUserQueue","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Queue Member","required":true,"schema":{"$ref":"#/definitions/UserQueue"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserQueue"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","missing.any.division.permissions":"At least one of the required division permissions is missing"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:join","routing:queueMember:manage"]},"x-purecloud-method-name":"patchUserQueue"}},"/api/v2/workforcemanagement/agentschedules/mine":{"post":{"tags":["Workforce Management"],"summary":"Get published schedule for the current user","description":"","operationId":"postWorkforcemanagementAgentschedulesMine","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/BuGetCurrentAgentScheduleRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuCurrentAgentScheduleSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.too.many.requests":"Too many requests in a given amount of time","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentSchedule:view"]},"x-purecloud-method-name":"postWorkforcemanagementAgentschedulesMine"}},"/api/v2/architect/dependencytracking/object":{"get":{"tags":["Architect"],"summary":"Get a Dependency Tracking object","description":"","operationId":"getArchitectDependencytrackingObject","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"Object ID","required":true,"type":"string"},{"name":"version","in":"query","description":"Object version","required":false,"type":"string"},{"name":"objectType","in":"query","description":"Object type","required":false,"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","BOTCONNECTORBOT","BOTCONNECTORBOTVERSION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GROUP","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","IVRCONFIGURATION","LANGUAGE","LEXBOT","LEXBOTALIAS","NLUDOMAIN","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","WIDGET","WORKFLOW"],"x-genesys-enum-members":[{"name":"ACDLANGUAGE"},{"name":"ACDSKILL"},{"name":"ACDWRAPUPCODE"},{"name":"BOTCONNECTORBOT"},{"name":"BOTCONNECTORBOTVERSION"},{"name":"BOTFLOW"},{"name":"BRIDGEACTION"},{"name":"COMMONMODULEFLOW"},{"name":"COMPOSERSCRIPT"},{"name":"CONTACTLIST"},{"name":"DATAACTION"},{"name":"DATATABLE"},{"name":"DIALOGENGINEBOT"},{"name":"DIALOGENGINEBOTVERSION"},{"name":"DIALOGFLOWAGENT"},{"name":"EMAILROUTE"},{"name":"EMERGENCYGROUP"},{"name":"FLOWACTION"},{"name":"FLOWDATATYPE"},{"name":"FLOWMILESTONE"},{"name":"FLOWOUTCOME"},{"name":"GROUP"},{"name":"INBOUNDCALLFLOW"},{"name":"INBOUNDCHATFLOW"},{"name":"INBOUNDEMAILFLOW"},{"name":"INBOUNDSHORTMESSAGEFLOW"},{"name":"INQUEUECALLFLOW"},{"name":"IVRCONFIGURATION"},{"name":"LANGUAGE"},{"name":"LEXBOT"},{"name":"LEXBOTALIAS"},{"name":"NLUDOMAIN"},{"name":"OUTBOUNDCALLFLOW"},{"name":"QUEUE"},{"name":"RECORDINGPOLICY"},{"name":"RESPONSE"},{"name":"SCHEDULE"},{"name":"SCHEDULEGROUP"},{"name":"SECUREACTION"},{"name":"SECURECALLFLOW"},{"name":"SURVEYINVITEFLOW"},{"name":"SYSTEMPROMPT"},{"name":"TTSENGINE"},{"name":"TTSVOICE"},{"name":"USER"},{"name":"USERPROMPT"},{"name":"WIDGET"},{"name":"WORKFLOW"}]},{"name":"consumedResources","in":"query","description":"Include resources this item consumes","required":false,"type":"boolean"},{"name":"consumingResources","in":"query","description":"Include resources that consume this item","required":false,"type":"boolean"},{"name":"consumedResourceType","in":"query","description":"Types of consumed resources to return, if consumed resources are requested","required":false,"type":"array","items":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","BOTCONNECTORBOT","BOTCONNECTORBOTVERSION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GROUP","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","IVRCONFIGURATION","LANGUAGE","LEXBOT","LEXBOTALIAS","NLUDOMAIN","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","WIDGET","WORKFLOW"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"ACDLANGUAGE"},{"name":"ACDSKILL"},{"name":"ACDWRAPUPCODE"},{"name":"BOTCONNECTORBOT"},{"name":"BOTCONNECTORBOTVERSION"},{"name":"BOTFLOW"},{"name":"BRIDGEACTION"},{"name":"COMMONMODULEFLOW"},{"name":"COMPOSERSCRIPT"},{"name":"CONTACTLIST"},{"name":"DATAACTION"},{"name":"DATATABLE"},{"name":"DIALOGENGINEBOT"},{"name":"DIALOGENGINEBOTVERSION"},{"name":"DIALOGFLOWAGENT"},{"name":"EMAILROUTE"},{"name":"EMERGENCYGROUP"},{"name":"FLOWACTION"},{"name":"FLOWDATATYPE"},{"name":"FLOWMILESTONE"},{"name":"FLOWOUTCOME"},{"name":"GROUP"},{"name":"INBOUNDCALLFLOW"},{"name":"INBOUNDCHATFLOW"},{"name":"INBOUNDEMAILFLOW"},{"name":"INBOUNDSHORTMESSAGEFLOW"},{"name":"INQUEUECALLFLOW"},{"name":"IVRCONFIGURATION"},{"name":"LANGUAGE"},{"name":"LEXBOT"},{"name":"LEXBOTALIAS"},{"name":"NLUDOMAIN"},{"name":"OUTBOUNDCALLFLOW"},{"name":"QUEUE"},{"name":"RECORDINGPOLICY"},{"name":"RESPONSE"},{"name":"SCHEDULE"},{"name":"SCHEDULEGROUP"},{"name":"SECUREACTION"},{"name":"SECURECALLFLOW"},{"name":"SURVEYINVITEFLOW"},{"name":"SYSTEMPROMPT"},{"name":"TTSENGINE"},{"name":"TTSVOICE"},{"name":"USER"},{"name":"USERPROMPT"},{"name":"WIDGET"},{"name":"WORKFLOW"}]},{"name":"consumingResourceType","in":"query","description":"Types of consuming resources to return, if consuming resources are requested","required":false,"type":"array","items":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","BOTCONNECTORBOT","BOTCONNECTORBOTVERSION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GROUP","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","IVRCONFIGURATION","LANGUAGE","LEXBOT","LEXBOTALIAS","NLUDOMAIN","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","WIDGET","WORKFLOW"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"ACDLANGUAGE"},{"name":"ACDSKILL"},{"name":"ACDWRAPUPCODE"},{"name":"BOTCONNECTORBOT"},{"name":"BOTCONNECTORBOTVERSION"},{"name":"BOTFLOW"},{"name":"BRIDGEACTION"},{"name":"COMMONMODULEFLOW"},{"name":"COMPOSERSCRIPT"},{"name":"CONTACTLIST"},{"name":"DATAACTION"},{"name":"DATATABLE"},{"name":"DIALOGENGINEBOT"},{"name":"DIALOGENGINEBOTVERSION"},{"name":"DIALOGFLOWAGENT"},{"name":"EMAILROUTE"},{"name":"EMERGENCYGROUP"},{"name":"FLOWACTION"},{"name":"FLOWDATATYPE"},{"name":"FLOWMILESTONE"},{"name":"FLOWOUTCOME"},{"name":"GROUP"},{"name":"INBOUNDCALLFLOW"},{"name":"INBOUNDCHATFLOW"},{"name":"INBOUNDEMAILFLOW"},{"name":"INBOUNDSHORTMESSAGEFLOW"},{"name":"INQUEUECALLFLOW"},{"name":"IVRCONFIGURATION"},{"name":"LANGUAGE"},{"name":"LEXBOT"},{"name":"LEXBOTALIAS"},{"name":"NLUDOMAIN"},{"name":"OUTBOUNDCALLFLOW"},{"name":"QUEUE"},{"name":"RECORDINGPOLICY"},{"name":"RESPONSE"},{"name":"SCHEDULE"},{"name":"SCHEDULEGROUP"},{"name":"SECUREACTION"},{"name":"SECURECALLFLOW"},{"name":"SURVEYINVITEFLOW"},{"name":"SYSTEMPROMPT"},{"name":"TTSENGINE"},{"name":"TTSVOICE"},{"name":"USER"},{"name":"USERPROMPT"},{"name":"WIDGET"},{"name":"WORKFLOW"}]},{"name":"consumedResourceRequest","in":"query","description":"Indicate that this is going to look up a consumed resource object","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DependencyObject"}},"206":{"description":"Partial Content - the org data is being rebuilt or needs to be rebuilt."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","architect.dependency.object.not.versioned":"A version was provided for a non-versioned dependency object type.","architect.query.parameter.missing":"A required query parameter is missing or empty.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","architect.dependency.object.invalid.type":"An invalid dependency object type was specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.version.missing":"Specified flow version is missing.","not.found":"The requested resource was not found.","architect.dependency.object.not.found":"Could not find the dependency object with specified ID and version.","architect.flow.not.found":"Could not find flow with specified ID."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","architect.database.throughput.exceeded":"Database too busy. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:dependencyTracking:view"]},"x-purecloud-method-name":"getArchitectDependencytrackingObject"}},"/api/v2/telephony/providers/edges/{edgeId}/physicalinterfaces":{"get":{"tags":["Telephony Providers Edge"],"summary":"Retrieve a list of all configured physical interfaces from a specific edge.","description":"","operationId":"getTelephonyProvidersEdgePhysicalinterfaces","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhysicalInterfaceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgePhysicalinterfaces"}},"/api/v2/recording/recordingkeys/rotationschedule":{"get":{"tags":["Recording"],"summary":"Get key rotation schedule","description":"","operationId":"getRecordingRecordingkeysRotationschedule","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KeyRotationSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:encryptionKey:view"]},"x-purecloud-method-name":"getRecordingRecordingkeysRotationschedule"},"put":{"tags":["Recording"],"summary":"Update key rotation schedule","description":"","operationId":"putRecordingRecordingkeysRotationschedule","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"KeyRotationSchedule","required":true,"schema":{"$ref":"#/definitions/KeyRotationSchedule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KeyRotationSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:encryptionKey:edit"]},"x-purecloud-method-name":"putRecordingRecordingkeysRotationschedule"}},"/api/v2/fax/summary":{"get":{"tags":["Fax"],"summary":"Get fax summary","description":"","operationId":"getFaxSummary","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxSummary"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["fax","fax:readonly"]}],"x-purecloud-method-name":"getFaxSummary"}},"/api/v2/architect/dependencytracking/updatedresourceconsumers":{"get":{"tags":["Architect"],"summary":"Get Dependency Tracking objects that depend on updated resources","description":"","operationId":"getArchitectDependencytrackingUpdatedresourceconsumers","produces":["application/json"],"parameters":[{"name":"name","in":"query","description":"Name to search for","required":false,"type":"string"},{"name":"objectType","in":"query","description":"Object type(s) to search for","required":false,"type":"array","items":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","BOTCONNECTORBOT","BOTCONNECTORBOTVERSION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GROUP","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","IVRCONFIGURATION","LANGUAGE","LEXBOT","LEXBOTALIAS","NLUDOMAIN","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","WIDGET","WORKFLOW"],"x-genesys-enum-members":[{"name":"ACDLANGUAGE"},{"name":"ACDSKILL"},{"name":"ACDWRAPUPCODE"},{"name":"BOTCONNECTORBOT"},{"name":"BOTCONNECTORBOTVERSION"},{"name":"BOTFLOW"},{"name":"BRIDGEACTION"},{"name":"COMMONMODULEFLOW"},{"name":"COMPOSERSCRIPT"},{"name":"CONTACTLIST"},{"name":"DATAACTION"},{"name":"DATATABLE"},{"name":"DIALOGENGINEBOT"},{"name":"DIALOGENGINEBOTVERSION"},{"name":"DIALOGFLOWAGENT"},{"name":"EMAILROUTE"},{"name":"EMERGENCYGROUP"},{"name":"FLOWACTION"},{"name":"FLOWDATATYPE"},{"name":"FLOWMILESTONE"},{"name":"FLOWOUTCOME"},{"name":"GROUP"},{"name":"INBOUNDCALLFLOW"},{"name":"INBOUNDCHATFLOW"},{"name":"INBOUNDEMAILFLOW"},{"name":"INBOUNDSHORTMESSAGEFLOW"},{"name":"INQUEUECALLFLOW"},{"name":"IVRCONFIGURATION"},{"name":"LANGUAGE"},{"name":"LEXBOT"},{"name":"LEXBOTALIAS"},{"name":"NLUDOMAIN"},{"name":"OUTBOUNDCALLFLOW"},{"name":"QUEUE"},{"name":"RECORDINGPOLICY"},{"name":"RESPONSE"},{"name":"SCHEDULE"},{"name":"SCHEDULEGROUP"},{"name":"SECUREACTION"},{"name":"SECURECALLFLOW"},{"name":"SURVEYINVITEFLOW"},{"name":"SYSTEMPROMPT"},{"name":"TTSENGINE"},{"name":"TTSVOICE"},{"name":"USER"},{"name":"USERPROMPT"},{"name":"WIDGET"},{"name":"WORKFLOW"}]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"ACDLANGUAGE"},{"name":"ACDSKILL"},{"name":"ACDWRAPUPCODE"},{"name":"BOTCONNECTORBOT"},{"name":"BOTCONNECTORBOTVERSION"},{"name":"BOTFLOW"},{"name":"BRIDGEACTION"},{"name":"COMMONMODULEFLOW"},{"name":"COMPOSERSCRIPT"},{"name":"CONTACTLIST"},{"name":"DATAACTION"},{"name":"DATATABLE"},{"name":"DIALOGENGINEBOT"},{"name":"DIALOGENGINEBOTVERSION"},{"name":"DIALOGFLOWAGENT"},{"name":"EMAILROUTE"},{"name":"EMERGENCYGROUP"},{"name":"FLOWACTION"},{"name":"FLOWDATATYPE"},{"name":"FLOWMILESTONE"},{"name":"FLOWOUTCOME"},{"name":"GROUP"},{"name":"INBOUNDCALLFLOW"},{"name":"INBOUNDCHATFLOW"},{"name":"INBOUNDEMAILFLOW"},{"name":"INBOUNDSHORTMESSAGEFLOW"},{"name":"INQUEUECALLFLOW"},{"name":"IVRCONFIGURATION"},{"name":"LANGUAGE"},{"name":"LEXBOT"},{"name":"LEXBOTALIAS"},{"name":"NLUDOMAIN"},{"name":"OUTBOUNDCALLFLOW"},{"name":"QUEUE"},{"name":"RECORDINGPOLICY"},{"name":"RESPONSE"},{"name":"SCHEDULE"},{"name":"SCHEDULEGROUP"},{"name":"SECUREACTION"},{"name":"SECURECALLFLOW"},{"name":"SURVEYINVITEFLOW"},{"name":"SYSTEMPROMPT"},{"name":"TTSENGINE"},{"name":"TTSVOICE"},{"name":"USER"},{"name":"USERPROMPT"},{"name":"WIDGET"},{"name":"WORKFLOW"}]},{"name":"consumedResources","in":"query","description":"Return consumed resources?","required":false,"type":"boolean","default":false},{"name":"consumedResourceType","in":"query","description":"Resource type(s) to return","required":false,"type":"array","items":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","BOTCONNECTORBOT","BOTCONNECTORBOTVERSION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GROUP","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","IVRCONFIGURATION","LANGUAGE","LEXBOT","LEXBOTALIAS","NLUDOMAIN","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","WIDGET","WORKFLOW"],"x-genesys-enum-members":[{"name":"ACDLANGUAGE"},{"name":"ACDSKILL"},{"name":"ACDWRAPUPCODE"},{"name":"BOTCONNECTORBOT"},{"name":"BOTCONNECTORBOTVERSION"},{"name":"BOTFLOW"},{"name":"BRIDGEACTION"},{"name":"COMMONMODULEFLOW"},{"name":"COMPOSERSCRIPT"},{"name":"CONTACTLIST"},{"name":"DATAACTION"},{"name":"DATATABLE"},{"name":"DIALOGENGINEBOT"},{"name":"DIALOGENGINEBOTVERSION"},{"name":"DIALOGFLOWAGENT"},{"name":"EMAILROUTE"},{"name":"EMERGENCYGROUP"},{"name":"FLOWACTION"},{"name":"FLOWDATATYPE"},{"name":"FLOWMILESTONE"},{"name":"FLOWOUTCOME"},{"name":"GROUP"},{"name":"INBOUNDCALLFLOW"},{"name":"INBOUNDCHATFLOW"},{"name":"INBOUNDEMAILFLOW"},{"name":"INBOUNDSHORTMESSAGEFLOW"},{"name":"INQUEUECALLFLOW"},{"name":"IVRCONFIGURATION"},{"name":"LANGUAGE"},{"name":"LEXBOT"},{"name":"LEXBOTALIAS"},{"name":"NLUDOMAIN"},{"name":"OUTBOUNDCALLFLOW"},{"name":"QUEUE"},{"name":"RECORDINGPOLICY"},{"name":"RESPONSE"},{"name":"SCHEDULE"},{"name":"SCHEDULEGROUP"},{"name":"SECUREACTION"},{"name":"SECURECALLFLOW"},{"name":"SURVEYINVITEFLOW"},{"name":"SYSTEMPROMPT"},{"name":"TTSENGINE"},{"name":"TTSVOICE"},{"name":"USER"},{"name":"USERPROMPT"},{"name":"WIDGET"},{"name":"WORKFLOW"}]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"ACDLANGUAGE"},{"name":"ACDSKILL"},{"name":"ACDWRAPUPCODE"},{"name":"BOTCONNECTORBOT"},{"name":"BOTCONNECTORBOTVERSION"},{"name":"BOTFLOW"},{"name":"BRIDGEACTION"},{"name":"COMMONMODULEFLOW"},{"name":"COMPOSERSCRIPT"},{"name":"CONTACTLIST"},{"name":"DATAACTION"},{"name":"DATATABLE"},{"name":"DIALOGENGINEBOT"},{"name":"DIALOGENGINEBOTVERSION"},{"name":"DIALOGFLOWAGENT"},{"name":"EMAILROUTE"},{"name":"EMERGENCYGROUP"},{"name":"FLOWACTION"},{"name":"FLOWDATATYPE"},{"name":"FLOWMILESTONE"},{"name":"FLOWOUTCOME"},{"name":"GROUP"},{"name":"INBOUNDCALLFLOW"},{"name":"INBOUNDCHATFLOW"},{"name":"INBOUNDEMAILFLOW"},{"name":"INBOUNDSHORTMESSAGEFLOW"},{"name":"INQUEUECALLFLOW"},{"name":"IVRCONFIGURATION"},{"name":"LANGUAGE"},{"name":"LEXBOT"},{"name":"LEXBOTALIAS"},{"name":"NLUDOMAIN"},{"name":"OUTBOUNDCALLFLOW"},{"name":"QUEUE"},{"name":"RECORDINGPOLICY"},{"name":"RESPONSE"},{"name":"SCHEDULE"},{"name":"SCHEDULEGROUP"},{"name":"SECUREACTION"},{"name":"SECURECALLFLOW"},{"name":"SURVEYINVITEFLOW"},{"name":"SYSTEMPROMPT"},{"name":"TTSENGINE"},{"name":"TTSVOICE"},{"name":"USER"},{"name":"USERPROMPT"},{"name":"WIDGET"},{"name":"WORKFLOW"}]},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DependencyObjectEntityListing"}},"206":{"description":"Partial Content - the org data is being rebuilt or needs to be rebuilt."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","architect.dependency.object.invalid.type":"An invalid dependency object type was specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.data.missing":"Flow version data content is missing.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","architect.database.throughput.exceeded":"Database too busy. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:dependencyTracking:view"]},"x-purecloud-method-name":"getArchitectDependencytrackingUpdatedresourceconsumers"}},"/api/v2/telephony/providers/edges/{edgeId}/logs/jobs/{jobId}/upload":{"post":{"tags":["Telephony Providers Edge"],"summary":"Request that the specified fileIds be uploaded from the Edge.","description":"","operationId":"postTelephonyProvidersEdgeLogsJobUpload","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"jobId","in":"path","description":"Job ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Log upload request","required":true,"schema":{"$ref":"#/definitions/EdgeLogsJobUploadRequest"}}],"responses":{"202":{"description":"Accepted - Files are being uploaded to the job. Watch the uploadStatus property on the job files."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find resource by given id(s).","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgeLogsJobUpload"}},"/api/v2/externalcontacts/scan/notes":{"get":{"tags":["External Contacts"],"summary":"Scan for notes using paging","description":"","operationId":"getExternalcontactsScanNotes","produces":["application/json"],"parameters":[{"name":"limit","in":"query","description":"The number of notes per page; must be between 10 and 200, default is 100)","required":false,"type":"integer","format":"int32"},{"name":"cursor","in":"query","description":"Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CursorNoteListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or expired cursor","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too many requests in a given amount of time"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:view"]},"x-purecloud-method-name":"getExternalcontactsScanNotes"}},"/api/v2/analytics/reporting/{reportId}/metadata":{"get":{"tags":["Analytics"],"summary":"Get a reporting metadata.","description":"","operationId":"getAnalyticsReportingReportIdMetadata","produces":["application/json"],"parameters":[{"name":"reportId","in":"path","description":"Report ID","required":true,"type":"string"},{"name":"locale","in":"query","description":"Locale","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportMetaData"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["reporting:acd:view, reporting:status:view, reporting:interactions:view, reporting:outbound:view, reporting:quality:view, employee"]},"x-purecloud-method-name":"getAnalyticsReportingReportIdMetadata"}},"/api/v2/outbound/schedules/sequences":{"get":{"tags":["Outbound"],"summary":"Query for a list of dialer sequence schedules.","description":"","operationId":"getOutboundSchedulesSequences","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/SequenceSchedule"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.interval.time":"","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:schedule:view"]},"x-purecloud-method-name":"getOutboundSchedulesSequences"}},"/api/v2/scim/v2/resourcetypes/{resourceType}":{"get":{"tags":["SCIM"],"summary":"Get a resource type","description":"","operationId":"getScimV2Resourcetype","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"name":"resourceType","in":"path","description":"The type of resource. Returned with GET /api/v2/scim/v2/resourcetypes.","required":true,"type":"string","enum":["User","Group","ServiceProviderConfig","ResourceType","Schema"],"x-genesys-enum-members":[{"name":"User"},{"name":"Group"},{"name":"ServiceProviderConfig"},{"name":"ResourceType"},{"name":"Schema"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimConfigResourceType"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimV2Resourcetype"}},"/api/v2/scim/v2/resourcetypes":{"get":{"tags":["SCIM"],"summary":"Get a list of resource types","description":"","operationId":"getScimV2Resourcetypes","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimConfigResourceTypesListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimV2Resourcetypes"}},"/api/v2/groups/{groupId}/individuals":{"get":{"tags":["Groups"],"summary":"Get all individuals associated with the group","description":"","operationId":"getGroupIndividuals","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups","groups:readonly"]}],"x-purecloud-method-name":"getGroupIndividuals"}},"/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/progress":{"get":{"tags":["Outbound"],"summary":"Get messaging campaign's progress","description":"","operationId":"getOutboundMessagingcampaignProgress","produces":["application/json"],"parameters":[{"name":"messagingCampaignId","in":"path","description":"The Messaging Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignProgress"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The messaging campaign was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaign:view"]},"x-purecloud-method-name":"getOutboundMessagingcampaignProgress"}},"/api/v2/outbound/messagingcampaigns/{messagingCampaignId}":{"get":{"tags":["Outbound"],"summary":"Get an Outbound Messaging Campaign","description":"","operationId":"getOutboundMessagingcampaign","produces":["application/json"],"parameters":[{"name":"messagingCampaignId","in":"path","description":"The Messaging Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingCampaign"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The resource could not be found.","resource.not.found":"Specified campaignId was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaign:view"]},"x-purecloud-method-name":"getOutboundMessagingcampaign"},"put":{"tags":["Outbound"],"summary":"Update an Outbound Messaging Campaign","description":"","operationId":"putOutboundMessagingcampaign","produces":["application/json"],"parameters":[{"name":"messagingCampaignId","in":"path","description":"The Messaging Campaign ID","required":true,"type":"string"},{"in":"body","name":"body","description":"MessagingCampaign","required":true,"schema":{"$ref":"#/definitions/MessagingCampaign"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingCampaign"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.length.exceeded":"The name length exceeds the limit of 64 characters","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name is in use by another messaging campaign","callable.time.set.not.found":"The callable time set could not be found","contact.list.not.found":"The contact list could not be found","invalid.callable.time.set":"The provided callable time set is invalid","invalid.messages.per.minute":"Messages per minute must be provided, and must be an integer between 1 and the maximum allowable messages per minute (see documentation)","invalid.sender.sms.phone.number":"The sender sms phone number must be provided, and must be a valid reference to a short-code or non-NANP mobile or local SMS phone number","invalid.update":"An attempt was made to update a messaging campaign in an invalid way. See details","invalid.phone.column":"The phone column must be provided, and must be a valid column on the selected contact list","invalid.name":"A name must be provided","sms.content.template.not.found":"The Content template could not be found","another.campaign.starting":"There is another campaign already in the process of transitioning to on. Once it has transitioned fully then you will be allowed to turn another campaign on.","invalid.contact.list":"A valid contact list must be provided","contact.sort.duplicate.field.names":"Multiple Contact Sorts may not be applied to the same field","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","contact.sort.size.exceeded":"A maximum of 4 Contact Sorts may be configured","dnc.list.not.found":"One or more dnc lists could not be found","invalid.message.column":"The message column must be provided, and must be a valid column on the selected contact list","invalid.sms.content.template.responsetype":"The responseType of content template is not valid. It must be CampaignSmsTemplate","contact.sort.field.not.found":"One or more contact sort fields are not valid contact list columns","invalid.sms.config.message":"Only one of the messaging options should be set - messageColumn or contentTemplateId","dnc.list.count.exceeded":"A maximum of 10 dnc lists may be configured","simultaneous.field.and.status.update":"A Messaging Campaign cannot have other fields changed in the same update as a status transition","invalid.status.transition":"The campaign status transition is invalid","invalid.sms.content.template.contentType":"The contentType of content template is not valid. It must be text/plain","sms.phone.number.in.use":"The SMS phone number is in use by another messaging campaign","invalid.dnc.list":"One or more DNC List references are invalid","invalid.division":"A valid division must be provided","callable.time.set.conflicts.with.automatic.time.zone.mapping":"A callable time set cannot be included on the campaign when the campaign's contact list uses automatic time zone mapping.","too.many.messages.per.minute.requested":"The total number of messages per minute for this organization would be exceeded by turning this campaign on (see documentation)","sms.phone.number.not.found":"The SMS phone number could not be found","sms.content.template.not.authorized":"User doesn't have authorization to access content template","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","missing.time.zone.in.contactlist":"When using a callable time set, the contact list must have at least one time zone column defined.","contact.list.import.in.progress":"The contact list is still importing contacts","invalid.type.config":"Exactly one of [smsConfig] must be provided","contact.list.in.use":"The contact list is in use by another messaging campaign","invalid.sms.content.template.content":"The content of content template is blank"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The messaging campaign could not be found"}},"409":{"description":"Conflict.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"version.conflict":"Unexpected messaging campaign version"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaign:edit"]},"x-purecloud-method-name":"putOutboundMessagingcampaign"},"delete":{"tags":["Outbound"],"summary":"Delete an Outbound Messaging Campaign","description":"","operationId":"deleteOutboundMessagingcampaign","produces":["application/json"],"parameters":[{"name":"messagingCampaignId","in":"path","description":"The Messaging Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingCampaign"}},"204":{"description":"Messaging Campaign Deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.delete":"An attempt was made to delete a messaging campaign in an invalid way. See details","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","cannot.delete.running.campaign":"A messaging campaign in status ON or STOPPING cannot be deleted"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:delete"]},"x-purecloud-method-name":"deleteOutboundMessagingcampaign"}},"/api/v2/license/users/{userId}":{"get":{"tags":["License"],"summary":"Get licenses for specified user.","description":"","operationId":"getLicenseUser","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LicenseUser"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["license","license:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:add"]},"x-purecloud-method-name":"getLicenseUser"}},"/api/v2/outbound/contactlists/divisionviews/{contactListId}":{"get":{"tags":["Outbound"],"summary":"Get a basic ContactList information object","description":"This returns a simplified version of a ContactList, consisting of the name, division, column names, phone columns, import status, and size.","operationId":"getOutboundContactlistsDivisionview","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contactlist ID","required":true,"type":"string"},{"name":"includeImportStatus","in":"query","description":"Include import status","required":false,"type":"boolean","default":false},{"name":"includeSize","in":"query","description":"Include size","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListDivisionView"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:contactList:search"]},"x-purecloud-method-name":"getOutboundContactlistsDivisionview"}},"/api/v2/externalcontacts/contacts/schemas/{schemaId}/versions/{versionId}":{"get":{"tags":["External Contacts"],"summary":"Get a specific version of a schema","description":"","operationId":"getExternalcontactsContactsSchemaVersion","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"},{"name":"versionId","in":"path","description":"Schema version","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"The schema to expand has parse errors"}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getExternalcontactsContactsSchemaVersion"}},"/api/v2/routing/queues":{"get":{"tags":["Routing"],"summary":"Get list of queues.","description":"","operationId":"getRoutingQueues","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"id","in":"query","description":"ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"divisionId","in":"query","description":"Division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.page.number":"Invalid page number specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"Internal server error getting queue listing."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:view"]},"x-purecloud-method-name":"getRoutingQueues"},"post":{"tags":["Routing"],"summary":"Create a queue","description":"","operationId":"postRoutingQueues","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Queue","required":true,"schema":{"$ref":"#/definitions/CreateQueueRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Queue"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Invalid media type specified.","invalid.phone.numbers":"Invalid phone numbers specified.","source.queue.not.found":"Source queue not found.","bad.request":"Invalid request data.","duplicate.name":"A queue with this name already exists.","invalid.rule":"Invalid routing rule specified.","invalid.outbound.messaging.address.state":"Specified outbound messaging address is not active.","queue.deleted":"Queue has been deleted.","invalid.name":"Invalid queue name specified.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.phone.number":"Invalid phone number specified.","invalid.id":"Missing or invalid queue division ID.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","skill.does.not.exist":"Specified skill does not exist.","queue.limit.exceeded":"Adding the requested queue would exceed the queue limit."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"A required resource (e.g., the source queue) was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:add"]},"x-purecloud-method-name":"postRoutingQueues"}},"/api/v2/flows/actions/unlock":{"post":{"tags":["Architect"],"summary":"Unlock flow","description":"Allows for unlocking a flow in the case where there is no flow configuration available, and thus a check-in will not unlock the flow. The user must have Architect Admin permissions to perform this action.","operationId":"postFlowsActionsUnlock","produces":["application/json"],"parameters":[{"name":"flow","in":"query","description":"Flow ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Flow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.admin.user":"The requesting user does not have the required Architect admin permission.","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.inbound.short.message.flow.invalid.operation":"Cannot perform requested operation on an inbound short message flow.","architect.debug.flow.invalid.operation":"Cannot perform requested operation on a debug flow.","architect.secure.call.flow.invalid.operation":"Cannot perform requested operation on a secure call flow.","architect.secure.call.flow.not.supported":"Secure call flows are not supported by the current product levels."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.object.update.failed":"The database update for the object failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:unlock"]},"x-purecloud-method-name":"postFlowsActionsUnlock"}},"/api/v2/flows/actions/publish":{"post":{"tags":["Architect"],"summary":"Publish flow","description":"Asynchronous. Notification topic: v2.flows.{flowId}","operationId":"postFlowsActionsPublish","produces":["application/json"],"parameters":[{"name":"flow","in":"query","description":"Flow ID","required":true,"type":"string"},{"name":"version","in":"query","description":"version","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Operation"}},"202":{"description":"Accepted - the publish has begun"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","architect.auth.token.missing":"This operation cannot be performed without an authorization token.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.data.missing":"Flow version data content is missing.","architect.flow.version.missing":"Specified flow version is missing.","not.found":"The requested resource was not found.","architect.flow.not.found":"Could not find flow with specified ID."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.inbound.short.message.flow.invalid.operation":"Cannot perform requested operation on an inbound short message flow.","architect.speech.flow.invalid.operation":"Cannot perform requested operation on a speech flow.","architect.debug.flow.invalid.operation":"Cannot perform requested operation on a debug flow.","architect.secure.call.flow.invalid.operation":"Cannot perform requested operation on a secure call flow.","architect.flow.cannot.publish.default":"Cannot publish default version of flow.","architect.secure.call.flow.not.supported":"Secure call flows are not supported by the current product levels."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.cannot.delete.used.in.ivr.configs":"Flow cannot be deleted due to being used by one or more IVR configurations.","architect.flow.cannot.publish.missing.dependencies":"Flow version cannot be published due to having one or more missing dependencies.","architect.flow.cannot.delete.used.in.email.routes":"Flow cannot be deleted due to being used by one or more email routes.","architect.flow.locked.by.user":"Flow is locked by another user.","architect.flow.cannot.checkin.missing.config":"Flow cannot be checked in because there is no saved configuration.","architect.operation.already.in.progress":"An operation is already in progress on the object.","architect.flow.cannot.delete.used.in.flows":"Flow cannot be deleted due to being used by one or more flows.","architect.flow.variable.missing":"Flow cannot be published because one or more variables are missing.","architect.flow.cannot.delete.used.in.queues":"Flow cannot be deleted due to being used by one or more queues.","architect.flow.cannot.delete.used.in.composer.scripts":"Flow cannot be deleted due to being used by one or more composer scripts."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.save.failed":"Could not save flow data to permanent storage.","architect.flow.data.invalid.format":"Flow version data content is in an invalid format.","architect.object.update.failed":"The database update for the object failed.","architect.external.flow.change.notification.error":"A backend service error occurred while sending out a flow change notification.","architect.external.call.failure":"A call to another backend service failed.","architect.unspecified.error":"An unknown error occurred.","architect.external.publish.error":"A backend service error occurred while publishing the flow.","architect.external.user.query.error":"Failed querying backend service for information on user.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","architect.database.throughput.exceeded":"Database too busy. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:unlock","architect:flow:publish"]},"x-purecloud-method-name":"postFlowsActionsPublish"}},"/api/v2/flows/actions/checkout":{"post":{"tags":["Architect"],"summary":"Check-out flow","description":"","operationId":"postFlowsActionsCheckout","produces":["application/json"],"parameters":[{"name":"flow","in":"query","description":"Flow ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Flow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.version.missing":"Specified flow version is missing.","not.found":"The requested resource was not found.","architect.flow.not.found":"Could not find flow with specified ID."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.inbound.short.message.flow.invalid.operation":"Cannot perform requested operation on an inbound short message flow.","architect.debug.flow.invalid.operation":"Cannot perform requested operation on a debug flow.","architect.secure.call.flow.invalid.operation":"Cannot perform requested operation on a secure call flow.","architect.secure.call.flow.not.supported":"Secure call flows are not supported by the current product levels."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.locked.by.user":"Flow is locked by another user."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.save.failed":"Could not save flow data to permanent storage.","architect.object.update.failed":"The database update for the object failed.","architect.external.user.query.error":"Failed querying backend service for information on user.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:edit"]},"x-purecloud-method-name":"postFlowsActionsCheckout"}},"/api/v2/flows/actions/revert":{"post":{"tags":["Architect"],"summary":"Revert flow","description":"","operationId":"postFlowsActionsRevert","produces":["application/json"],"parameters":[{"name":"flow","in":"query","description":"Flow ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Flow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.flow.not.found":"Could not find flow with specified ID."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.inbound.short.message.flow.invalid.operation":"Cannot perform requested operation on an inbound short message flow.","architect.debug.flow.invalid.operation":"Cannot perform requested operation on a debug flow.","architect.secure.call.flow.invalid.operation":"Cannot perform requested operation on a secure call flow.","architect.secure.call.flow.not.supported":"Secure call flows are not supported by the current product levels."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.not.locked.by.user":"Flow is not locked by requesting user."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.object.update.failed":"The database update for the object failed.","architect.external.user.query.error":"Failed querying backend service for information on user.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:edit"]},"x-purecloud-method-name":"postFlowsActionsRevert"}},"/api/v2/flows/actions/checkin":{"post":{"tags":["Architect"],"summary":"Check-in flow","description":"Asynchronous. Notification topic: v2.flows.{flowId}","operationId":"postFlowsActionsCheckin","produces":["application/json"],"parameters":[{"name":"flow","in":"query","description":"Flow ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Operation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.inbound.short.message.flow.invalid.operation":"Cannot perform requested operation on an inbound short message flow.","architect.secure.call.flow.invalid.operation":"Cannot perform requested operation on a secure call flow."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.unspecified.error":"An unknown error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:edit","architect:flow:unlock"]},"x-purecloud-method-name":"postFlowsActionsCheckin"}},"/api/v2/flows/actions/deactivate":{"post":{"tags":["Architect"],"summary":"Deactivate flow","description":"","operationId":"postFlowsActionsDeactivate","produces":["application/json"],"parameters":[{"name":"flow","in":"query","description":"Flow ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Flow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.flow.not.found":"Could not find flow with specified ID."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.inbound.short.message.flow.invalid.operation":"Cannot perform requested operation on an inbound short message flow.","architect.speech.flow.invalid.operation":"Cannot perform requested operation on a speech flow.","architect.debug.flow.invalid.operation":"Cannot perform requested operation on a debug flow.","architect.default.flow.cannot.deactivate":"Cannot deactivate the default in-queue flow.","architect.secure.call.flow.invalid.operation":"Cannot perform requested operation on a secure call flow.","architect.secure.call.flow.not.supported":"Secure call flows are not supported by the current product levels."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.cannot.deactivate.used.in.emergency.groups":"The flow cannot be deactivated because it's being used by one or more emergency groups.","architect.flow.cannot.deactivate.used.in.pe.action.maps":"The flow cannot be deactivated because it's being used by one or more predictive engagement action maps.","architect.flow.cannot.deactivate.used.in.queues":"The flow cannot be deactivated because it's being used by one or more queues.","architect.flow.cannot.deactivate.used.in.email.routes":"The flow cannot be deactivated because it's being used by one or more email routes.","architect.flow.cannot.deactivate.used.by.message.addresses":"The flow cannot be deactivated because it's being used by one or more message addresses.","architect.flow.cannot.deactivate.used.in.widgets":"The flow cannot be deactivated because it's being used by one or more widgets.","architect.flow.cannot.deactivate.used.in.ivr.configs":"The flow cannot be deactivated because it's being used by one or more IVR configurations.","architect.flow.cannot.deactivate.used.in.recording.policies":"The flow cannot be deactivated because it's being used by one or more recording policies.","architect.flow.cannot.deactivate.used.in.composer.scripts":"The flow cannot be deactivated because it's being used by one or more composer scripts."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.object.update.failed":"The database update for the object failed.","architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:publish"]},"x-purecloud-method-name":"postFlowsActionsDeactivate"}},"/api/v2/conversations/messaging/integrations/line/{integrationId}":{"get":{"tags":["Conversations"],"summary":"Get a LINE messenger integration","description":"","operationId":"getConversationsMessagingIntegrationsLineIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LineIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:view"]},"x-purecloud-method-name":"getConversationsMessagingIntegrationsLineIntegrationId"},"put":{"tags":["Conversations"],"summary":"Update a LINE messenger integration","description":"","operationId":"putConversationsMessagingIntegrationsLineIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"},{"in":"body","name":"body","description":"LineIntegrationRequest","required":true,"schema":{"$ref":"#/definitions/LineIntegrationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LineIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.integration":"The integration request was invalid for this operation. One or more errors may be reported.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:edit"]},"x-purecloud-method-name":"putConversationsMessagingIntegrationsLineIntegrationId"},"delete":{"tags":["Conversations"],"summary":"Delete a LINE messenger integration","description":"","operationId":"deleteConversationsMessagingIntegrationsLineIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:delete"]},"x-purecloud-method-name":"deleteConversationsMessagingIntegrationsLineIntegrationId"}},"/api/v2/architect/systemprompts":{"get":{"tags":["Architect"],"summary":"Get System Prompts","description":"","operationId":"getArchitectSystemprompts","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"id"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"description","in":"query","description":"Description","required":false,"type":"string"},{"name":"nameOrDescription","in":"query","description":"Name or description","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SystemPromptEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:systemPrompt:view"]},"x-purecloud-method-name":"getArchitectSystemprompts"}},"/api/v2/integrations/eventlog":{"get":{"tags":["Integrations"],"summary":"List all events","description":"","operationId":"getIntegrationsEventlog","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"timestamp"},{"name":"sortOrder","in":"query","description":"Order by","required":false,"type":"string","default":"descending"},{"name":"entityId","in":"query","description":"Include only events with this entity ID","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IntegrationEventEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view","bridge:notification:view"]},"x-purecloud-method-name":"getIntegrationsEventlog"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups/{planningGroupId}":{"get":{"tags":["Workforce Management"],"summary":"Get a planning group","description":"","operationId":"getWorkforcemanagementBusinessunitPlanninggroup","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit.","required":true,"type":"string"},{"name":"planningGroupId","in":"path","description":"The ID of a planning group to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PlanningGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:planningGroup:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitPlanninggroup"},"delete":{"tags":["Workforce Management"],"summary":"Deletes the planning group","description":"","operationId":"deleteWorkforcemanagementBusinessunitPlanninggroup","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit.","required":true,"type":"string"},{"name":"planningGroupId","in":"path","description":"The ID of a planning group to delete","required":true,"type":"string"}],"responses":{"204":{"description":"The planning group was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:planningGroup:delete"]},"x-purecloud-method-name":"deleteWorkforcemanagementBusinessunitPlanninggroup"},"patch":{"tags":["Workforce Management"],"summary":"Updates the planning group","description":"","operationId":"patchWorkforcemanagementBusinessunitPlanninggroup","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit.","required":true,"type":"string"},{"name":"planningGroupId","in":"path","description":"The ID of a planning group to update","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/UpdatePlanningGroupRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PlanningGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"routing.skill.ids.not.found":"One or more skill IDs were not found","language.ids.not.found":"One or more language IDs were not found","wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found.","queue.ids.not.found":"One or more queue IDs were not found"}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Entity was modified by another request"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:planningGroup:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementBusinessunitPlanninggroup"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups":{"get":{"tags":["Workforce Management"],"summary":"Gets list of planning groups","description":"","operationId":"getWorkforcemanagementBusinessunitPlanninggroups","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PlanningGroupList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:planningGroup:view","wfm:shortTermForecast:view","wfm:intraday:view","wfm:agent:view","wfm:schedule:view","wfm:publishedSchedule:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitPlanninggroups"},"post":{"tags":["Workforce Management"],"summary":"Adds a new planning group","description":"","operationId":"postWorkforcemanagementBusinessunitPlanninggroups","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/CreatePlanningGroupRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PlanningGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"routing.skill.ids.not.found":"One or more skill IDs were not found","language.ids.not.found":"One or more language IDs were not found","wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found.","queue.ids.not.found":"One or more queue IDs were not found"}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Entity was modified by another request"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:planningGroup:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitPlanninggroups"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/users":{"get":{"tags":["Workforce Management"],"summary":"Get users in the management unit","description":"","operationId":"getWorkforcemanagementManagementunitUsers","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WfmUserEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agent:view","wfm:historicalAdherence:view","wfm:publishedSchedule:view","wfm:realtimeAdherence:view","wfm:schedule:view","wfm:timeOffRequest:view","wfm:workPlanRotation:view","wfm:workPlan:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitUsers"}},"/api/v2/scim/v2/users":{"get":{"tags":["SCIM"],"summary":"Get a list of users","description":"To return all active users, do not use the filter parameter. To return inactive users, set the filter parameter to \"active eq false\". By default, returns SCIM attributes \"externalId\", \"enterprise-user:manager\", and \"roles\". To exclude these attributes, set the attributes parameter to \"id,active\" or the excludeAttributes parameter to \"externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\".","operationId":"getScimV2Users","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"name":"startIndex","in":"query","description":"The 1-based index of the first query result.","required":false,"type":"integer","default":1,"format":"int32"},{"name":"count","in":"query","description":"The requested number of items per page. A value of 0 returns \"totalResults\". A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the \"excludedAttributes\" or \"attributes\" query parameters to exclude or only include secondary lookup values such as \"externalId\", \"roles\", \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages\", or \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills\".","required":false,"type":"integer","default":25,"format":"int32"},{"name":"attributes","in":"query","description":"Indicates which attributes to include. Returns these attributes and the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","userName","displayName","title","active","externalId","phoneNumbers","emails","groups","roles","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:User:id","urn:ietf:params:scim:schemas:core:2.0:User:userName","urn:ietf:params:scim:schemas:core:2.0:User:displayName","urn:ietf:params:scim:schemas:core:2.0:User:title","urn:ietf:params:scim:schemas:core:2.0:User:active","urn:ietf:params:scim:schemas:core:2.0:User:externalId","urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers","urn:ietf:params:scim:schemas:core:2.0:User:emails","urn:ietf:params:scim:schemas:core:2.0:User:groups","urn:ietf:params:scim:schemas:core:2.0:User:roles","urn:ietf:params:scim:schemas:core:2.0:User:meta","urn:ietf:params:scim:schemas:core:2.0:User:meta.version","urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"id"},{"name":"userName"},{"name":"displayName"},{"name":"title"},{"name":"active"},{"name":"externalId"},{"name":"phoneNumbers"},{"name":"emails"},{"name":"groups"},{"name":"roles"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:userName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:title"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:active"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:externalId"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:emails"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:groups"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:roles"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"},{"name":"id"},{"name":"userName"},{"name":"displayName"},{"name":"title"},{"name":"active"},{"name":"externalId"},{"name":"phoneNumbers"},{"name":"emails"},{"name":"groups"},{"name":"roles"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:userName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:title"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:active"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:externalId"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:emails"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:groups"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:roles"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"}]},{"name":"excludedAttributes","in":"query","description":"Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","userName","displayName","title","active","externalId","phoneNumbers","emails","groups","roles","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:User:id","urn:ietf:params:scim:schemas:core:2.0:User:userName","urn:ietf:params:scim:schemas:core:2.0:User:displayName","urn:ietf:params:scim:schemas:core:2.0:User:title","urn:ietf:params:scim:schemas:core:2.0:User:active","urn:ietf:params:scim:schemas:core:2.0:User:externalId","urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers","urn:ietf:params:scim:schemas:core:2.0:User:emails","urn:ietf:params:scim:schemas:core:2.0:User:groups","urn:ietf:params:scim:schemas:core:2.0:User:roles","urn:ietf:params:scim:schemas:core:2.0:User:meta","urn:ietf:params:scim:schemas:core:2.0:User:meta.version","urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"id"},{"name":"userName"},{"name":"displayName"},{"name":"title"},{"name":"active"},{"name":"externalId"},{"name":"phoneNumbers"},{"name":"emails"},{"name":"groups"},{"name":"roles"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:userName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:title"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:active"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:externalId"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:emails"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:groups"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:roles"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"},{"name":"id"},{"name":"userName"},{"name":"displayName"},{"name":"title"},{"name":"active"},{"name":"externalId"},{"name":"phoneNumbers"},{"name":"emails"},{"name":"groups"},{"name":"roles"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:userName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:title"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:active"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:externalId"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:emails"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:groups"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:roles"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"}]},{"name":"filter","in":"query","description":"Filters results. If nothing is specified, returns all active users. Examples of valid values: \"id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\", \"userName eq search@sample.org\", \"manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\", \"email eq search@sample.org\", \"division eq divisionName\", \"externalId eq 167844\", \"active eq false\", \"employeeNumber eq 9876543210\".","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimUserListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimV2Users"},"post":{"tags":["SCIM"],"summary":"Create a user","description":"","operationId":"postScimV2Users","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"in":"body","name":"body","description":"The information used to create a user.","required":true,"schema":{"$ref":"#/definitions/ScimV2CreateUser"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2User"}},"201":{"description":"User Created.","schema":{"$ref":"#/definitions/ScimV2User"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"User name already in use by non-deleted user.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:add","authorization:grant:add","authorization:grant:delete","routing:skill:assign","routing:language:assign"]},"x-purecloud-method-name":"postScimV2Users"}},"/api/v2/scim/v2/users/{userId}":{"get":{"tags":["SCIM"],"summary":"Get a user","description":"","operationId":"getScimV2User","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"name":"userId","in":"path","description":"The ID of a user. Returned with GET /api/v2/scim/v2/users.","required":true,"type":"string"},{"name":"attributes","in":"query","description":"Indicates which attributes to include. Returns these attributes and the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","userName","displayName","title","active","externalId","phoneNumbers","emails","groups","roles","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:User:id","urn:ietf:params:scim:schemas:core:2.0:User:userName","urn:ietf:params:scim:schemas:core:2.0:User:displayName","urn:ietf:params:scim:schemas:core:2.0:User:title","urn:ietf:params:scim:schemas:core:2.0:User:active","urn:ietf:params:scim:schemas:core:2.0:User:externalId","urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers","urn:ietf:params:scim:schemas:core:2.0:User:emails","urn:ietf:params:scim:schemas:core:2.0:User:groups","urn:ietf:params:scim:schemas:core:2.0:User:roles","urn:ietf:params:scim:schemas:core:2.0:User:meta","urn:ietf:params:scim:schemas:core:2.0:User:meta.version","urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"id"},{"name":"userName"},{"name":"displayName"},{"name":"title"},{"name":"active"},{"name":"externalId"},{"name":"phoneNumbers"},{"name":"emails"},{"name":"groups"},{"name":"roles"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:userName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:title"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:active"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:externalId"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:emails"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:groups"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:roles"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"},{"name":"id"},{"name":"userName"},{"name":"displayName"},{"name":"title"},{"name":"active"},{"name":"externalId"},{"name":"phoneNumbers"},{"name":"emails"},{"name":"groups"},{"name":"roles"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:userName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:title"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:active"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:externalId"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:emails"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:groups"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:roles"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"}]},{"name":"excludedAttributes","in":"query","description":"Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","userName","displayName","title","active","externalId","phoneNumbers","emails","groups","roles","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:User:id","urn:ietf:params:scim:schemas:core:2.0:User:userName","urn:ietf:params:scim:schemas:core:2.0:User:displayName","urn:ietf:params:scim:schemas:core:2.0:User:title","urn:ietf:params:scim:schemas:core:2.0:User:active","urn:ietf:params:scim:schemas:core:2.0:User:externalId","urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers","urn:ietf:params:scim:schemas:core:2.0:User:emails","urn:ietf:params:scim:schemas:core:2.0:User:groups","urn:ietf:params:scim:schemas:core:2.0:User:roles","urn:ietf:params:scim:schemas:core:2.0:User:meta","urn:ietf:params:scim:schemas:core:2.0:User:meta.version","urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"id"},{"name":"userName"},{"name":"displayName"},{"name":"title"},{"name":"active"},{"name":"externalId"},{"name":"phoneNumbers"},{"name":"emails"},{"name":"groups"},{"name":"roles"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:userName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:title"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:active"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:externalId"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:emails"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:groups"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:roles"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"},{"name":"id"},{"name":"userName"},{"name":"displayName"},{"name":"title"},{"name":"active"},{"name":"externalId"},{"name":"phoneNumbers"},{"name":"emails"},{"name":"groups"},{"name":"roles"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:userName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:title"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:active"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:externalId"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:emails"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:groups"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:roles"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"}]},{"name":"If-None-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2User"}},"304":{"description":"If-Non-Match header matches current version. No content returned."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"User could not be found.","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.conflict":"Conflict with existing user ID."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimV2User"},"put":{"tags":["SCIM"],"summary":"Replace a user","description":"","operationId":"putScimV2User","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"name":"userId","in":"path","description":"The ID of a user. Returned with GET /api/v2/scim/v2/users.","required":true,"type":"string"},{"name":"If-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".","required":false,"type":"string"},{"in":"body","name":"body","description":"The information used to replace a user.","required":true,"schema":{"$ref":"#/definitions/ScimV2User"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2User"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Version does not match current version.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:edit","directory:user:setPassword","authorization:grant:add","authorization:grant:delete","routing:skill:assign","routing:language:assign"]},"x-purecloud-method-name":"putScimV2User"},"delete":{"tags":["SCIM"],"summary":"Delete a user","description":"","operationId":"deleteScimV2User","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"name":"userId","in":"path","description":"The ID of a user. Returned with GET /api/v2/scim/v2/users.","required":true,"type":"string"},{"name":"If-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"204":{"description":"User Deleted with no content returned."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Version does not match current version.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:delete"]},"x-purecloud-method-name":"deleteScimV2User"},"patch":{"tags":["SCIM"],"summary":"Modify a user","description":"","operationId":"patchScimV2User","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"name":"userId","in":"path","description":"The ID of a user. Returned with GET /api/v2/scim/v2/users.","required":true,"type":"string"},{"name":"If-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".","required":false,"type":"string"},{"in":"body","name":"body","description":"The information used to modify a user.","required":true,"schema":{"$ref":"#/definitions/ScimV2PatchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2User"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Version does not match current version.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:edit","directory:user:setPassword","authorization:grant:add","authorization:grant:delete","routing:skill:assign","routing:language:assign"]},"x-purecloud-method-name":"patchScimV2User"}},"/api/v2/journey/actiontemplates/{actionTemplateId}":{"get":{"tags":["Journey"],"summary":"Retrieve a single action template.","description":"","operationId":"getJourneyActiontemplate","produces":["application/json"],"parameters":[{"name":"actionTemplateId","in":"path","description":"ID of the action template.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actiontemplate:view"]},"x-purecloud-method-name":"getJourneyActiontemplate"},"delete":{"tags":["Journey"],"summary":"Delete a single action template.","description":"","operationId":"deleteJourneyActiontemplate","produces":["application/json"],"parameters":[{"name":"actionTemplateId","in":"path","description":"ID of the action template.","required":true,"type":"string"},{"name":"hardDelete","in":"query","description":"Determines whether Action Template should be soft-deleted (have it's state set to deleted) or hard-deleted (permanently removed). Set to false (soft-delete) by default.","required":false,"type":"boolean"}],"responses":{"204":{"description":"Action template deleted."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actiontemplate:delete"]},"x-purecloud-method-name":"deleteJourneyActiontemplate"},"patch":{"tags":["Journey"],"summary":"Update a single action template.","description":"","operationId":"patchJourneyActiontemplate","produces":["application/json"],"parameters":[{"name":"actionTemplateId","in":"path","description":"ID of the action template.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/PatchActionTemplate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actiontemplate:edit"]},"x-purecloud-method-name":"patchJourneyActiontemplate"}},"/api/v2/quality/forms/surveys/bulk":{"get":{"tags":["Quality"],"summary":"Retrieve a list of survey forms by their ids","description":"","operationId":"getQualityFormsSurveysBulk","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"A comma-delimited list of valid survey form ids","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyFormEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:view"]},"x-purecloud-method-name":"getQualityFormsSurveysBulk"}},"/api/v2/quality/forms/surveys/bulk/contexts":{"get":{"tags":["Quality"],"summary":"Retrieve a list of the latest form versions by context ids","description":"","operationId":"getQualityFormsSurveysBulkContexts","produces":["application/json"],"parameters":[{"name":"contextId","in":"query","description":"A comma-delimited list of valid survey form context ids","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"published","in":"query","description":"If true, the latest published version will be included. If false, only the unpublished version will be included.","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyFormEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:view"]},"x-purecloud-method-name":"getQualityFormsSurveysBulkContexts"}},"/api/v2/userrecordings/summary":{"get":{"tags":["User Recordings"],"summary":"Get user recording summary","description":"","operationId":"getUserrecordingsSummary","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxSummary"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["user-recordings","user-recordings:readonly"]}],"x-purecloud-method-name":"getUserrecordingsSummary"}},"/api/v2/analytics/reporting/reportformats":{"get":{"tags":["Analytics"],"summary":"Get a list of report formats","description":"Get a list of report formats.","operationId":"getAnalyticsReportingReportformats","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"type":"string"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-purecloud-method-name":"getAnalyticsReportingReportformats"}},"/api/v2/scripts/published/{scriptId}/pages/{pageId}":{"get":{"tags":["Scripts"],"summary":"Get the published page.","description":"","operationId":"getScriptsPublishedScriptIdPage","produces":["application/json"],"parameters":[{"name":"scriptId","in":"path","description":"Script ID","required":true,"type":"string"},{"name":"pageId","in":"path","description":"Page ID","required":true,"type":"string"},{"name":"scriptDataVersion","in":"query","description":"Advanced usage - controls the data version of the script","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Page"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:publishedScript:view"]},"x-purecloud-method-name":"getScriptsPublishedScriptIdPage"}},"/api/v2/telephony/providers/edges/trunks/metrics":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the metrics for a list of trunks.","description":"","operationId":"getTelephonyProvidersEdgesTrunksMetrics","produces":["application/json"],"parameters":[{"name":"trunkIds","in":"query","description":"Comma separated list of Trunk Id's","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/TrunkMetrics"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesTrunksMetrics"}},"/api/v2/telephony/providers/edges/sites/{siteId}/rebalance":{"post":{"tags":["Telephony Providers Edge"],"summary":"Triggers the rebalance operation.","description":"","operationId":"postTelephonyProvidersEdgesSiteRebalance","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"}],"responses":{"202":{"description":"Accepted - Processing the Rebalance"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesSiteRebalance"}},"/api/v2/greetings":{"get":{"tags":["Greetings"],"summary":"Gets an Organization's Greetings","description":"","operationId":"getGreetings","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings","greetings:readonly"]}],"x-purecloud-method-name":"getGreetings"},"post":{"tags":["Greetings"],"summary":"Create a Greeting for an Organization","description":"","operationId":"postGreetings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The Greeting to create","required":true,"schema":{"$ref":"#/definitions/Greeting"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Greeting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings"]}],"x-purecloud-method-name":"postGreetings"}},"/api/v2/speechandtextanalytics/topics/general":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get the Speech & Text Analytics general topics for a given dialect","description":"","operationId":"getSpeechandtextanalyticsTopicsGeneral","produces":["application/json"],"parameters":[{"name":"dialect","in":"query","description":"The dialect of the general topics, dialect format is {language}-{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard","required":false,"type":"string","enum":["en-US","es-US"],"x-genesys-enum-members":[{"name":"en-US"},{"name":"es-US"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GeneralTopicsEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dialect.not.found":"The requested dialect could not be found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:topic:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsTopicsGeneral"}},"/api/v2/conversations/chats/{conversationId}/messages/{messageId}":{"get":{"tags":["Conversations"],"summary":"Get a web chat conversation message","description":"The current user must be involved with the conversation to get its messages.","operationId":"getConversationsChatMessage","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"messageId","in":"path","description":"messageId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.not.found":"Chat conversation message is not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsChatMessage"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/validate":{"post":{"tags":["Workforce Management"],"summary":"Validate Work Plan","description":"","operationId":"postWorkforcemanagementManagementunitWorkplanValidate","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"workPlanId","in":"path","description":"The ID of the work plan to validate. For new work plan, use the word 'new' for the ID.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/WorkPlanValidationRequest"}},{"name":"expand","in":"query","required":false,"type":"array","items":{"type":"string","enum":["messages"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"messages"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ValidateWorkPlanResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:workPlan:add","wfm:workPlan:edit"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitWorkplanValidate"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/copy":{"post":{"tags":["Workforce Management"],"summary":"Create a copy of work plan","description":"","operationId":"postWorkforcemanagementManagementunitWorkplanCopy","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"workPlanId","in":"path","description":"The ID of the work plan to create a copy","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/CopyWorkPlan"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlan"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"Name not specified or there is already a work plan with the name mentioned for copy","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:workPlan:add"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitWorkplanCopy"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans":{"get":{"tags":["Workforce Management"],"summary":"Get work plans","description":"","operationId":"getWorkforcemanagementManagementunitWorkplans","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"expand","in":"query","required":false,"type":"array","items":{"type":"string","enum":["agentCount","details"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"agentCount"},{"name":"details"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlanListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.server.error":"WFM Server Error","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agent:view","wfm:publishedSchedule:view","wfm:schedule:view","wfm:workPlanRotation:view","wfm:workPlan:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitWorkplans"},"post":{"tags":["Workforce Management"],"summary":"Create a new work plan","description":"","operationId":"postWorkforcemanagementManagementunitWorkplans","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/CreateWorkPlan"}},{"name":"validationMode","in":"query","description":"Allows to create work plan even if the validation result is invalid","required":false,"type":"string","enum":["Ignore"],"x-genesys-enum-members":[{"name":"Ignore"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlan"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:workPlan:add"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitWorkplans"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}":{"get":{"tags":["Workforce Management"],"summary":"Get a work plan","description":"","operationId":"getWorkforcemanagementManagementunitWorkplan","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"workPlanId","in":"path","description":"The ID of the work plan to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlan"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:workPlanRotation:view","wfm:workPlan:view","wfm:schedule:edit"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitWorkplan"},"delete":{"tags":["Workforce Management"],"summary":"Delete a work plan","description":"","operationId":"deleteWorkforcemanagementManagementunitWorkplan","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"workPlanId","in":"path","description":"The ID of the work plan to delete","required":true,"type":"string"}],"responses":{"204":{"description":"The work plan was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:workPlan:delete"]},"x-purecloud-method-name":"deleteWorkforcemanagementManagementunitWorkplan"},"patch":{"tags":["Workforce Management"],"summary":"Update a work plan","description":"","operationId":"patchWorkforcemanagementManagementunitWorkplan","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"workPlanId","in":"path","description":"The ID of the work plan to update","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/WorkPlan"}},{"name":"validationMode","in":"query","description":"Allows to update work plan even if validation result is invalid","required":false,"type":"string","enum":["Ignore"],"x-genesys-enum-members":[{"name":"Ignore"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlan"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Version of the request does not match the version on the backend"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:workPlan:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementManagementunitWorkplan"}},"/api/v2/outbound/contactlists/{contactListId}/importstatus":{"get":{"tags":["Outbound"],"summary":"Get dialer contactList import status.","description":"","operationId":"getOutboundContactlistImportstatus","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"ContactList ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ImportStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactList:view"]},"x-purecloud-method-name":"getOutboundContactlistImportstatus"}},"/api/v2/quality/surveys/scorable":{"get":{"tags":["Quality"],"summary":"Get a survey as an end-customer, for the purposes of scoring it.","description":"","operationId":"getQualitySurveysScorable","produces":["application/json"],"parameters":[{"name":"customerSurveyUrl","in":"query","description":"customerSurveyUrl","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScorableSurvey"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.survey.form.context.doesnt.have.valid.published.version":"All published versions of this survey form have been disabled.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"getQualitySurveysScorable"},"put":{"tags":["Quality"],"summary":"Update a survey as an end-customer, for the purposes of scoring it.","description":"","operationId":"putQualitySurveysScorable","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"survey","required":true,"schema":{"$ref":"#/definitions/ScorableSurvey"}},{"name":"customerSurveyUrl","in":"query","description":"customerSurveyUrl","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScorableSurvey"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.survey.unauthenticated.already.finished":"The survey is already finished.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"putQualitySurveysScorable"}},"/api/v2/userrecordings":{"get":{"tags":["User Recordings"],"summary":"Get a list of user recordings.","description":"","operationId":"getUserrecordings","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["conversation"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"conversation"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserRecordingEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"You are not permitted to get a list of user recordings."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["user-recordings","user-recordings:readonly"]}],"x-purecloud-method-name":"getUserrecordings"}},"/api/v2/telephony/providers/edges/outboundroutes":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get outbound routes","description":"","operationId":"getTelephonyProvidersEdgesOutboundroutes","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"site.id","in":"query","description":"Filter by site.id","required":false,"type":"string"},{"name":"externalTrunkBases.ids","in":"query","description":"Filter by externalTrunkBases.ids","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutboundRouteEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Unable to find an outbound route with that id","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.rate.limit":"Request rate limit exceeded.","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesOutboundroutes"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create outbound rule","description":"","operationId":"postTelephonyProvidersEdgesOutboundroutes","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"OutboundRoute","required":true,"schema":{"$ref":"#/definitions/OutboundRoute"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutboundRoute"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"required.field.missing":"A required field is missing a value.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","number.plan.type.usage.must.be.unique":"The number plan type usage must be unique.","duplicate.value":"An outbound route with this name already exists.","address.classification.type.does.not.exist":"One of the address classifications does not exist.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesOutboundroutes"}},"/api/v2/analytics/reporting/schedules/{scheduleId}/history/{runId}":{"get":{"tags":["Analytics"],"summary":"A completed scheduled report job","description":"A completed scheduled report job.","operationId":"getAnalyticsReportingScheduleHistoryRunId","produces":["application/json"],"parameters":[{"name":"runId","in":"path","description":"Run ID","required":true,"type":"string"},{"name":"scheduleId","in":"path","description":"Schedule ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportRunEntry"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-purecloud-method-name":"getAnalyticsReportingScheduleHistoryRunId"}},"/api/v2/outbound/messagingcampaigns/progress":{"post":{"tags":["Outbound"],"summary":"Get progress for a list of messaging campaigns","description":"","operationId":"postOutboundMessagingcampaignsProgress","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Messaging Campaign IDs","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/CampaignProgress"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"callback.error.missing.callback.numbers":"Callback numbers missing","callback.error.missing.queue.id":"Callback missing queue ID","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaign:view"]},"x-purecloud-method-name":"postOutboundMessagingcampaignsProgress"}},"/api/v2/outbound/messagingcampaigns/divisionviews/{messagingCampaignId}":{"get":{"tags":["Outbound"],"summary":"Get a basic Messaging Campaign information object","description":"This returns a simplified version of a Messaging Campaign, consisting of id, name, and division.","operationId":"getOutboundMessagingcampaignsDivisionview","produces":["application/json"],"parameters":[{"name":"messagingCampaignId","in":"path","description":"The Messaging Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingCampaignDivisionView"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:messagingCampaign:search"]},"x-purecloud-method-name":"getOutboundMessagingcampaignsDivisionview"}},"/api/v2/workforcemanagement/managementunits/divisionviews":{"get":{"tags":["Workforce Management"],"summary":"Get management units across divisions","description":"","operationId":"getWorkforcemanagementManagementunitsDivisionviews","produces":["application/json"],"parameters":[{"name":"divisionId","in":"query","description":"The divisionIds to filter by. If omitted, will return all divisions","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ManagementUnitListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:managementUnit:search"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitsDivisionviews"}},"/api/v2/scim/v2/serviceproviderconfig":{"get":{"tags":["SCIM"],"summary":"Get a service provider's configuration","description":"","operationId":"getScimV2Serviceproviderconfig","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"name":"If-None-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/serviceproviderconfig. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified. ","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimServiceProviderConfig"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimV2Serviceproviderconfig"}},"/api/v2/contentmanagement/securityprofiles/{securityProfileId}":{"get":{"tags":["Content Management"],"summary":"Get a Security Profile","description":"","operationId":"getContentmanagementSecurityprofile","produces":["application/json"],"parameters":[{"name":"securityProfileId","in":"path","description":"Security Profile Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SecurityProfile"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementSecurityprofile"}},"/api/v2/usage/query":{"post":{"tags":["Usage"],"summary":"Query organization API Usage - ","description":"After calling this method, you will then need to poll for the query results based on the returned execution Id","operationId":"postUsageQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Query","required":true,"schema":{"$ref":"#/definitions/ApiUsageQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UsageExecutionResult"}},"202":{"description":"Execution not completed, check back for results","schema":{"$ref":"#/definitions/UsageExecutionResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:view"]},"x-purecloud-method-name":"postUsageQuery"}},"/api/v2/dataextensions/limits":{"get":{"tags":["Data Extensions"],"summary":"Get quantitative limits on schemas","description":"","operationId":"getDataextensionsLimits","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SchemaQuantityLimits"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["data-extensions"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getDataextensionsLimits"}},"/api/v2/scim/resourcetypes/{resourceType}":{"get":{"tags":["SCIM"],"summary":"Get a resource type","description":"","operationId":"getScimResourcetype","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"name":"resourceType","in":"path","description":"The type of resource. Returned with GET /api/v2/scim/resourcetypes.","required":true,"type":"string","enum":["User","Group","ServiceProviderConfig","ResourceType","Schema"],"x-genesys-enum-members":[{"name":"User"},{"name":"Group"},{"name":"ServiceProviderConfig"},{"name":"ResourceType"},{"name":"Schema"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimConfigResourceType"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimResourcetype"}},"/api/v2/scim/resourcetypes":{"get":{"tags":["SCIM"],"summary":"Get a list of resource types","description":"","operationId":"getScimResourcetypes","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimConfigResourceTypesListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimResourcetypes"}},"/api/v2/mobiledevices/{deviceId}":{"get":{"tags":["Mobile Devices"],"summary":"Get device","description":"","operationId":"getMobiledevice","produces":["application/json"],"parameters":[{"name":"deviceId","in":"path","description":"Device ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserDevice"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a device with that deviceId","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["devices","devices:readonly"]}],"x-purecloud-method-name":"getMobiledevice"},"put":{"tags":["Mobile Devices"],"summary":"Update device","description":"","operationId":"putMobiledevice","produces":["application/json"],"parameters":[{"name":"deviceId","in":"path","description":"Device ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Device","required":false,"schema":{"$ref":"#/definitions/UserDevice"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserDevice"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["devices"]}],"x-purecloud-method-name":"putMobiledevice"},"delete":{"tags":["Mobile Devices"],"summary":"Delete device","description":"","operationId":"deleteMobiledevice","produces":["application/json"],"parameters":[{"name":"deviceId","in":"path","description":"Device ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["devices"]}],"x-purecloud-method-name":"deleteMobiledevice"}},"/api/v2/speechandtextanalytics/topics/publishjobs/{jobId}":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get a Speech & Text Analytics publish topics job by id","description":"","operationId":"getSpeechandtextanalyticsTopicsPublishjob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"The id of the publish topics job","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TopicJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"job.not.found":"The requested job could not be found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:topic:publish"]},"x-purecloud-method-name":"getSpeechandtextanalyticsTopicsPublishjob"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/codes/{addCommunicationCode}":{"delete":{"tags":["Conversations"],"summary":"Delete a code used to add a communication to this participant","description":"","operationId":"deleteConversationParticipantCode","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"name":"addCommunicationCode","in":"path","description":"addCommunicationCode","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"deleteConversationParticipantCode"}},"/api/v2/conversations/calls":{"get":{"tags":["Conversations"],"summary":"Get active call conversations for the logged in user","description":"","operationId":"getConversationsCalls","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallConversationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCalls"},"post":{"tags":["Conversations"],"summary":"Create a call conversation","description":"","operationId":"postConversationsCalls","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Call request","required":true,"schema":{"$ref":"#/definitions/CreateCallRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CreateCallResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.no.user.station":"A station is required to place a call.","too.many.create.conversation.parameters":"Only a single destination can be supplied in a create conversation request.","conversation.error.cannot.create.conference":"Unable to create a conference.","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","missing.create.conversation.destination.parameter":"At least one destination should be supplied in a create conversation request.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"providerapi.error.station.cannot.resolve":"Cannot resolve station.","providerapi.error.user.does.not.have.a.station":"User does not have a station.","conversation.error.media.failed":"The media request failed.","providerapi.error.edge.cannot.resolve":"Cannot resolve edge.","providerapi.error.ccxml.uri.not_found":"Failed to get CCXML URI from edge config.","providerapi.error.edge.no.active":"Could not find an active Edge in Site.","providerapi.error.phone.cannot.resolve":"Cannot resolve phone.","providerapi.error.phone.no.active.edge":"The phone is not assigned to active Edges."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"providerapi.error.station.no.active.edge":"Unable to place call. Could not find an Edge for this station.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","providerapi.error.no.station.for.edge":"Station assignment for station found, but no primary or secondary Edge id was assigned to it."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:conference:add"]},"x-purecloud-method-name":"postConversationsCalls"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/wrapupcodes":{"get":{"tags":["Conversations"],"summary":"Get list of wrapup codes for this conversation participant","description":"","operationId":"getConversationsCallParticipantWrapupcodes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCallParticipantWrapupcodes"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult":{"post":{"tags":["Conversations"],"summary":"Initiate and update consult transfer","description":"","operationId":"postConversationsCallParticipantConsult","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Destination address & initial speak to","required":true,"schema":{"$ref":"#/definitions/ConsultTransfer"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConsultTransferResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.consult.transfer.no.initiator":"The transfer request has no initiator.","conversation.error.cannot.transfer.to.self":"A user cannot transfer a call to their own number","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","conversation.error.cannot.transfer.conference":"Performing a consult transfer on a conference is not allowed.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","not.a.participant":"You are not a connected participant on the call","object.participant.id.required":"A connected object participant is required.","dest.address.not.specified":"The destination address was not specified.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","conversation.error.consult.transfer.no.destination":"The transfer request has no destination."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation.","conversation.error.consult.transfer.pending.not.found":"The pending consult transfer does not exist."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationsCallParticipantConsult"},"delete":{"tags":["Conversations"],"summary":"Cancel the transfer","description":"","operationId":"deleteConversationsCallParticipantConsult","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","conversation.error.consult.transfer.not.started":"The consult transfer can't be canceled since it hasn't started yet."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","conversation.error.consult.transfer.pending.not.found":"The pending consult transfer does not exist."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"deleteConversationsCallParticipantConsult"},"patch":{"tags":["Conversations"],"summary":"Change who can speak","description":"","operationId":"patchConversationsCallParticipantConsult","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"new speak to","required":true,"schema":{"$ref":"#/definitions/ConsultTransferUpdate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConsultTransferResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.cannot.transfer.to.self":"A user cannot transfer a call to their own number","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","not.a.participant":"You are not a connected participant on the call","object.participant.id.required":"A connected object participant is required.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","conversation.error.participant.no.active.conversations":"Participant has no active conversations"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","conversation.error.consult.transfer.pending.not.found":"The pending consult transfer does not exist."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsCallParticipantConsult"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/monitor":{"post":{"tags":["Conversations"],"summary":"Listen in on the conversation from the point of view of a given participant.","description":"","operationId":"postConversationsCallParticipantMonitor","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"}],"responses":{"201":{"description":"Created"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.monitor.own.conversation":"A user cannot monitor a conversation where they are an active participant.","conversation.error.no.user.station":"A station is required to place a call.","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:call:monitor"]},"x-purecloud-method-name":"postConversationsCallParticipantMonitor"}},"/api/v2/conversations/calls/history":{"get":{"tags":["Conversations"],"summary":"Get call history","description":"","operationId":"getConversationsCallsHistory","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size, maximum 50","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"interval","in":"query","description":"Interval string; format is ISO-8601. Separate start and end times with forward slash '/'","required":false,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["externalorganization","externalcontact","user","queue","group"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"externalorganization"},{"name":"externalcontact"},{"name":"user"},{"name":"queue"},{"name":"group"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallHistoryConversationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCallsHistory"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/attributes":{"patch":{"tags":["Conversations"],"summary":"Update the attributes on a conversation participant.","description":"","operationId":"patchConversationsCallParticipantAttributes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant attributes","required":true,"schema":{"$ref":"#/definitions/ParticipantAttributes"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsCallParticipantAttributes"}},"/api/v2/conversations/calls/{conversationId}":{"get":{"tags":["Conversations"],"summary":"Get call conversation","description":"","operationId":"getConversationsCall","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.no.common.user":"This conference can not be created because there is no common user among all the active participants.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.media.failed":"The media request failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","providerapi.error.no.station.for.edge":"Station assignment for station found, but no primary or secondary Edge id was assigned to it."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCall"},"post":{"tags":["Conversations"],"summary":"Place a new call as part of a callback conversation.","description":"","operationId":"postConversationsCall","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation","required":true,"schema":{"$ref":"#/definitions/CallCommand"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Conversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.no.user.station":"A station is required to place a call.","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","conversation.error.callback.call.cannot.be.placed":"An error occurred while trying to place the callback.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","conversation.error.participant.no.active.conversations":"The participant has no active conversation."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"providerapi.error.station.no.active.edge":"Unable to place call. Could not find an Edge for this station.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","providerapi.error.no.station.for.edge":"Station assignment for station found, but no primary or secondary Edge id was assigned to it."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationsCall"},"patch":{"tags":["Conversations"],"summary":"Update a conversation by setting it's recording state, merging in other conversations to create a conference, or disconnecting all of the participants","description":"","operationId":"patchConversationsCall","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation","required":true,"schema":{"$ref":"#/definitions/Conversation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Conversation"}},"202":{"description":"Accepted - when pausing or resuming recordings (Secure Pause)","schema":{"$ref":"#/definitions/Conversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.empty.conversation.list":"An empty list of conversations is invalid.","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","conversation.error.cannot.merge.alerting.conference":"A conference cannot be created from an alerting call.","conversation.error.call.disconnected":"Call is disconnected, cannot alter recordingState","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:disconnect"]},"x-purecloud-method-name":"patchConversationsCall"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation participant. ","description":"","operationId":"getConversationsCallParticipantWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCallParticipantWrapup"}},"/api/v2/conversations/calls/maximumconferenceparties":{"get":{"tags":["Conversations"],"summary":"Get the maximum number of participants that this user can have on a conference","description":"","operationId":"getConversationsCallsMaximumconferenceparties","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MaxParticipants"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCallsMaximumconferenceparties"}},"/api/v2/conversations/calls/{conversationId}/participants":{"post":{"tags":["Conversations"],"summary":"Add participants to a conversation","description":"","operationId":"postConversationsCallParticipants","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation","required":true,"schema":{"$ref":"#/definitions/Conversation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Conversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","conversation.error.cannot.merge.alerting.conference":"A conference cannot be created from an alerting call.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"providerapi.error.station.no.active.edge":"Unable to place call. Could not find an Edge for this station.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationsCallParticipants"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/coach":{"post":{"tags":["Conversations"],"summary":"Listen in on the conversation from the point of view of a given participant while speaking to just the given participant.","description":"","operationId":"postConversationsCallParticipantCoach","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"}],"responses":{"201":{"description":"Created"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.no.user.station":"A station is required to place a call.","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:call:coach"]},"x-purecloud-method-name":"postConversationsCallParticipantCoach"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}/uuidata":{"put":{"tags":["Conversations"],"summary":"Set uuiData to be sent on future commands.","description":"","operationId":"putConversationsCallParticipantCommunicationUuidata","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"UUIData Request","required":true,"schema":{"$ref":"#/definitions/SetUuiDataRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"204":{"description":"UuiData Applied"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"putConversationsCallParticipantCommunicationUuidata"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant's communication by disconnecting it.","description":"","operationId":"patchConversationsCallParticipantCommunication","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","communication.state.required":"Can only update a communication's state to disconnected.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsCallParticipantCommunication"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant","description":"","operationId":"patchConversationsCallParticipant","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant request","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","conversation.error.call.disconnected":"The call is already disconnected.","conversation.error.user.not.party":"The participant for this request does not belong to the user making the request.","conversation.error.wrapup.cannot.skip":"Wrap-up cannot be skipped for this participant.","conversation.error.participant.no.active.conversations":"The participant has no active conversation.","conversation.error.hold.alerting":"An alerting call cannot be placed on hold.","conversation.error.cannot.create.conference":"Unable to create a conference.","conversation.participant.update.invalid":"Failed to update all properties on conversation participant.","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","callback.error.answer.not.alerting":"Only alerting calls can be answered.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","conversation.error.cannot.confine.party":"The participant for this request cannot be confined.","conversation.error.wrapup.code.required":"Wrapup code is a required field and cannot be empty.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"Conversation not found.","not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.participant.update.failed":"Failed to update all properties on conversation participant.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsCallParticipant"}},"/api/v2/conversations/calls/{conversationId}/participants/{participantId}/replace":{"post":{"tags":["Conversations"],"summary":"Replace this participant with the specified user and/or address","description":"","operationId":"postConversationsCallParticipantReplace","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Transfer request","required":true,"schema":{"$ref":"#/definitions/TransferRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversations.error.transfer.same.party":"The target of the transfer cannot be the same as the destination.","conversations.error.transfer.acd.call.unattended":"An ACD call cannot be transferred unattended.","callback.error.user.id.queue.id":"In destination, exactly one of userId or queueId is required.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","conversations.error.queue.not.found":"Interaction cannot be transferred to a queue that does not exist.","conversations.error.transfer.not.connected":"You can only transfer conversations that are in the connected state.","conversations.error.transfer.usercall.voicemail":"Only personal calls can be transferred to voicemail.","callback.error.transfer.not.connected":"Only connected participants can be transferred.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationsCallParticipantReplace"}},"/api/v2/routing/sms/addresses/{addressId}":{"get":{"tags":["Routing"],"summary":"Get an Address by Id for SMS","description":"","operationId":"getRoutingSmsAddress","produces":["application/json"],"parameters":[{"name":"addressId","in":"path","description":"Address ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SmsAddress"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:view"]},"x-purecloud-method-name":"getRoutingSmsAddress"},"delete":{"tags":["Routing"],"summary":"Delete an Address by Id for SMS","description":"","operationId":"deleteRoutingSmsAddress","produces":["application/json"],"parameters":[{"name":"addressId","in":"path","description":"Address ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:delete"]},"x-purecloud-method-name":"deleteRoutingSmsAddress"}},"/api/v2/users/development/activities/aggregates/query":{"post":{"tags":["Users"],"summary":"Retrieve aggregated development activity data","description":"Results are filtered based on the applicable permissions.","operationId":"postUsersDevelopmentActivitiesAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Aggregate Request","required":true,"schema":{"$ref":"#/definitions/DevelopmentActivityAggregateParam"}}],"responses":{"200":{"description":"Query completed successfully","schema":{"$ref":"#/definitions/DevelopmentActivityAggregateResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was a problem with the request, see the message for details","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","coaching:readonly","learning","learning:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:assignment:view","coaching:appointment:view"]},"x-purecloud-method-name":"postUsersDevelopmentActivitiesAggregatesQuery"}},"/api/v2/alerting/alerts/active":{"get":{"tags":["Alerting"],"summary":"Gets active alert count for a user.","description":"","operationId":"getAlertingAlertsActive","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActiveAlertCount"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting","alerting:readonly"]}],"x-purecloud-method-name":"getAlertingAlertsActive"}},"/api/v2/users/{userId}/profileskills":{"get":{"tags":["Users"],"summary":"List profile skills for a user","description":"","operationId":"getUserProfileskills","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"type":"string"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:userProfile:view"]},"x-purecloud-method-name":"getUserProfileskills"},"put":{"tags":["Users"],"summary":"Update profile skills for a user","description":"","operationId":"putUserProfileskills","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Skills","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"type":"string"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:userProfile:edit"]},"x-purecloud-method-name":"putUserProfileskills"}},"/api/v2/architect/emergencygroups/{emergencyGroupId}":{"get":{"tags":["Architect"],"summary":"Gets a emergency group by ID","description":"","operationId":"getArchitectEmergencygroup","produces":["application/json"],"parameters":[{"name":"emergencyGroupId","in":"path","description":"Emergency group ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmergencyGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The specified emergencyGroupId was not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:emergencyGroup:view"]},"x-purecloud-method-name":"getArchitectEmergencygroup"},"put":{"tags":["Architect"],"summary":"Updates a emergency group by ID","description":"","operationId":"putArchitectEmergencygroup","produces":["application/json"],"parameters":[{"name":"emergencyGroupId","in":"path","description":"Emergency group ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/EmergencyGroup"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmergencyGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:emergencyGroup:edit"]},"x-purecloud-method-name":"putArchitectEmergencygroup"},"delete":{"tags":["Architect"],"summary":"Deletes a emergency group by ID","description":"","operationId":"deleteArchitectEmergencygroup","produces":["application/json"],"parameters":[{"name":"emergencyGroupId","in":"path","description":"Emergency group ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"could not find the requested emergency group","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:emergencyGroup:delete"]},"x-purecloud-method-name":"deleteArchitectEmergencygroup"}},"/api/v2/outbound/audits":{"post":{"tags":["Outbound"],"summary":"Retrieves audits for dialer.","description":"","operationId":"postOutboundAudits","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"AuditSearch","required":true,"schema":{"$ref":"#/definitions/DialerAuditRequest"}},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"entity.name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ascending"},{"name":"facetsOnly","in":"query","description":"Facets only","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuditSearchResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:audit:view"]},"x-purecloud-method-name":"postOutboundAudits"}},"/api/v2/architect/prompts/{promptId}/resources":{"get":{"tags":["Architect"],"summary":"Get a pageable list of user prompt resources","description":"The returned list is pageable, and query parameters can be used for filtering.","operationId":"getArchitectPromptResources","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PromptAssetEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.not.found":"Could not find prompt with specified ID.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:view"]},"x-purecloud-method-name":"getArchitectPromptResources"},"post":{"tags":["Architect"],"summary":"Create a new user prompt resource","description":"","operationId":"postArchitectPromptResources","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/PromptAssetCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PromptAsset"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.resource.validate.failed.language":"Failed to validate prompt resource due to missing or invalid language.","architect.prompt.resource.invalid.tags":"The specified tags are in an invalid format.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","architect.object.validate.failed":"Failed to validate object.","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.not.found":"Could not find prompt with specified ID.","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.resource.tags.already.exist":"The specified tags already exist in another prompt resource.","architect.prompt.resource.already.exists":"Prompt already has a resource with specified language."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:edit"]},"x-purecloud-method-name":"postArchitectPromptResources"}},"/api/v2/outbound/settings":{"get":{"tags":["Outbound"],"summary":"Get the outbound settings for this organization","description":"","operationId":"getOutboundSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutboundSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:settings:view"]},"x-purecloud-method-name":"getOutboundSettings"},"patch":{"tags":["Outbound"],"summary":"Update the outbound settings for this organization","description":"","operationId":"patchOutboundSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"outboundSettings","required":true,"schema":{"$ref":"#/definitions/OutboundSettings"}}],"responses":{"204":{"description":"Accepted - Processing Update"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.callable.window.stop.time":"Latest callable time must not be later than 21:00","invalid.callable.window":"Earliest callable time must be before Latest callable time and only one callable time window is allowed","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.max.calls.per.agent":"Max calls per agent must be between values 1 and 15.","missing.time.zone":"Time zone must be provided for unmapped call window","invalid.time.zone":"Invalid time zone for unmapped call window","invalid.abandon.seconds":"Abandon seconds must be between 1 and 300.","invalid.callable.window.start.time":"Earliest callable time must not be earlier than 08:00","invalid.update":"An attempt was made to update the outbound settings in an invalid way","invalid.max.line.utilization":"Max outbound line utilization must be between .01 and 1 and can only have 2 digits after the decimal.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.wrong.version":"outbound settings version does not match expected"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:settings:edit"]},"x-purecloud-method-name":"patchOutboundSettings"}},"/api/v2/presencedefinitions":{"get":{"tags":["Presence"],"summary":"Get an Organization's list of Presence Definitions","description":"","operationId":"getPresencedefinitions","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"deleted","in":"query","description":"Deleted query can be TRUE, FALSE or ALL","required":false,"type":"string","default":"false"},{"name":"localeCode","in":"query","description":"The locale code to fetch for each presence definition. Use ALL to fetch everything.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationPresenceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence","presence:readonly"]}],"x-purecloud-method-name":"getPresencedefinitions"},"post":{"tags":["Presence"],"summary":"Create a Presence Definition","description":"","operationId":"postPresencedefinitions","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The Presence Definition to create","required":true,"schema":{"$ref":"#/definitions/OrganizationPresence"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationPresence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["presence:presenceDefinition:add"]},"x-purecloud-method-name":"postPresencedefinitions"}},"/api/v2/journey/actiontargets":{"get":{"tags":["Journey"],"summary":"Retrieve all action targets.","description":"","operationId":"getJourneyActiontargets","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionTargetListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actiontarget:view"]},"x-purecloud-method-name":"getJourneyActiontargets"}},"/api/v2/flows/{flowId}/versions/{versionId}":{"get":{"tags":["Architect"],"summary":"Get flow version","description":"","operationId":"getFlowVersion","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"},{"name":"versionId","in":"path","description":"Version ID","required":true,"type":"string"},{"name":"deleted","in":"query","description":"Deleted flows","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowVersion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.data.missing":"Flow version data content is missing.","architect.flow.version.missing":"Specified flow version is missing.","not.found":"The requested resource was not found.","architect.flow.not.found":"Could not find flow with specified ID."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.data.invalid.format":"Flow version data content is in an invalid format.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:view"]},"x-purecloud-method-name":"getFlowVersion"}},"/api/v2/flows/{flowId}/versions/{versionId}/configuration":{"get":{"tags":["Architect"],"summary":"Create flow version configuration","description":"","operationId":"getFlowVersionConfiguration","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"},{"name":"versionId","in":"path","description":"Version ID","required":true,"type":"string"},{"name":"deleted","in":"query","description":"Deleted flows","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"object"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:view"]},"x-purecloud-method-name":"getFlowVersionConfiguration"}},"/api/v2/quality/publishedforms/surveys/{formId}":{"get":{"tags":["Quality"],"summary":"Get the most recent published version of a survey form.","description":"","operationId":"getQualityPublishedformsSurvey","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:view"]},"x-purecloud-method-name":"getQualityPublishedformsSurvey"}},"/api/v2/outbound/contactlistfilters/preview":{"post":{"tags":["Outbound"],"summary":"Get a preview of the output of a contact list filter","description":"","operationId":"postOutboundContactlistfiltersPreview","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ContactListFilter","required":true,"schema":{"$ref":"#/definitions/ContactListFilter"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FilterPreviewResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contact:view"]},"x-purecloud-method-name":"postOutboundContactlistfiltersPreview"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/activitycodes":{"get":{"tags":["Workforce Management"],"summary":"Get activity codes","description":"","operationId":"getWorkforcemanagementManagementunitActivitycodes","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActivityCodeContainer"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:activityCode:add","wfm:activityCode:delete","wfm:activityCode:edit","wfm:activityCode:view","wfm:agent:edit","wfm:agentSchedule:view","wfm:agentTimeOffRequest:submit","wfm:agent:view","wfm:businessUnit:add","wfm:businessUnit:delete","wfm:businessUnit:edit","wfm:businessUnit:view","wfm:historicalAdherence:view","wfm:intraday:view","wfm:managementUnit:add","wfm:managementUnit:delete","wfm:managementUnit:edit","wfm:managementUnit:view","wfm:publishedSchedule:view","wfm:realtimeAdherence:view","wfm:schedule:add","wfm:schedule:delete","wfm:schedule:edit","wfm:schedule:generate","wfm:schedule:view","wfm:shortTermForecast:add","wfm:shortTermForecast:delete","wfm:shortTermForecast:edit","wfm:shortTermForecast:view","wfm:timeOffRequest:add","wfm:timeOffRequest:edit","wfm:timeOffRequest:view","wfm:workPlan:add","wfm:workPlan:delete","wfm:workPlan:edit","wfm:workPlan:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitActivitycodes"}},"/api/v2/scripts/published/{scriptId}":{"get":{"tags":["Scripts"],"summary":"Get the published script.","description":"","operationId":"getScriptsPublishedScriptId","produces":["application/json"],"parameters":[{"name":"scriptId","in":"path","description":"Script ID","required":true,"type":"string"},{"name":"scriptDataVersion","in":"query","description":"Advanced usage - controls the data version of the script","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Script"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:publishedScript:view"]},"x-purecloud-method-name":"getScriptsPublishedScriptId"}},"/api/v2/orgauthorization/trustees/{trusteeOrgId}/users":{"get":{"tags":["Organization Authorization"],"summary":"The list of trustee users for this organization (i.e. users granted access to this organization).","description":"","operationId":"getOrgauthorizationTrusteeUsers","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustUserEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:view"]},"x-purecloud-method-name":"getOrgauthorizationTrusteeUsers"},"post":{"tags":["Organization Authorization"],"summary":"Add a user to the trust.","description":"","operationId":"postOrgauthorizationTrusteeUsers","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Trust","required":true,"schema":{"$ref":"#/definitions/TrustMemberCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustUser"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","trustee.user.not.found":"Trustee user not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:add"]},"x-purecloud-method-name":"postOrgauthorizationTrusteeUsers"}},"/api/v2/organizations/ipaddressauthentication":{"get":{"tags":["Organization"],"summary":"Get organization IP address whitelist settings","description":"","operationId":"getOrganizationsIpaddressauthentication","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IpAddressAuthentication"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:organization:admin"]},"x-purecloud-method-name":"getOrganizationsIpaddressauthentication"},"put":{"tags":["Organization"],"summary":"Update organization IP address whitelist settings","description":"","operationId":"putOrganizationsIpaddressauthentication","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"IP address Whitelist settings","required":true,"schema":{"$ref":"#/definitions/IpAddressAuthentication"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IpAddressAuthentication"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.issuing.ip.address":"IP address whitelisting cannot be configured with a token that was issued outside of the allowed ranges.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.ip.address":"IP address whitelisting cannot be configured from outside of the allowed ranges.","invalid.host.address":"IP address whitelisting cannot be configured via requests made to this host."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:organization:admin"]},"x-purecloud-method-name":"putOrganizationsIpaddressauthentication"}},"/api/v2/externalcontacts/contacts/schemas/{schemaId}":{"get":{"tags":["External Contacts"],"summary":"Get a schema","description":"","operationId":"getExternalcontactsContactsSchema","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getExternalcontactsContactsSchema"},"put":{"tags":["External Contacts"],"summary":"Update a schema","description":"","operationId":"putExternalcontactsContactsSchema","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Data Schema","required":true,"schema":{"$ref":"#/definitions/DataSchema"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.limit.max.number.of.fields.per.org.would.be.exceeded":"The total number of fields defined for all schemas cannot exceed 500.","dynamic.schema.validation.limit.error":"The JSON schema provided for update has a validation limit error.","dynamic.schema.limit.max.number.of.schemas.per.org.would.be.exceeded":"There cannot be more than 20 schemas.","bad.request":"The request could not be understood by the server due to malformed syntax. Check that all required schema fields are present.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","dynamic.schema.incompatible.json.schema.update":"The JSON schema provided for update is incompatible with the previous version.","dynamic.schema.limit.max.number.of.characters.for.field.name.would.be.exceeded":"A field name cannot exceed 100 characters","dynamic.schema.validation.limit.missing":"The new JSON schema provided for update is missing a validation limit.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","dynamic.schema.invalid.json.schema":"An invalid JSON schema was provided.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","dynamic.schema.limit.max.number.of.fields.per.schema.would.be.exceeded":"A schema cannot have more than 25 fields"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.version.conflict":"A valid version is required."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"Unable to expand the schema."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:edit"]},"x-purecloud-method-name":"putExternalcontactsContactsSchema"},"delete":{"tags":["External Contacts"],"summary":"Delete a schema","description":"","operationId":"deleteExternalcontactsContactsSchema","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","feature.forbidden":"Delete operation forbidden."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:edit"]},"x-purecloud-method-name":"deleteExternalcontactsContactsSchema"}},"/api/v2/orgauthorization/trustors/{trustorOrgId}/users/{trusteeUserId}":{"get":{"tags":["Organization Authorization"],"summary":"Get Trustee User","description":"","operationId":"getOrgauthorizationTrustorUser","produces":["application/json"],"parameters":[{"name":"trustorOrgId","in":"path","description":"Trustor Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Trustee User Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustUser"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:view"]},"x-purecloud-method-name":"getOrgauthorizationTrustorUser"},"put":{"tags":["Organization Authorization"],"summary":"Add a Trustee user to the trust.","description":"","operationId":"putOrgauthorizationTrustorUser","produces":["application/json"],"parameters":[{"name":"trustorOrgId","in":"path","description":"Trustor Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Trustee User Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustUser"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.trustor.permissions":"Missing required permission(s)","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["authorization:orgTrusteeUser:add"]},"x-purecloud-method-name":"putOrgauthorizationTrustorUser"},"delete":{"tags":["Organization Authorization"],"summary":"Delete Trustee User","description":"","operationId":"deleteOrgauthorizationTrustorUser","produces":["application/json"],"parameters":[{"name":"trustorOrgId","in":"path","description":"Trustor Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Trustee User Id","required":true,"type":"string"}],"responses":{"204":{"description":"Trust deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.trustor.permissions":"Missing required permission(s)","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:delete"]},"x-purecloud-method-name":"deleteOrgauthorizationTrustorUser"}},"/api/v2/integrations/credentials/{credentialId}":{"get":{"tags":["Integrations"],"summary":"Get a single credential with sensitive fields redacted","description":"","operationId":"getIntegrationsCredential","produces":["application/json"],"parameters":[{"name":"credentialId","in":"path","description":"Credential ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Credential"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-purecloud-method-name":"getIntegrationsCredential"},"put":{"tags":["Integrations"],"summary":"Update a set of credentials","description":"","operationId":"putIntegrationsCredential","produces":["application/json"],"parameters":[{"name":"credentialId","in":"path","description":"Credential ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Credential","required":false,"schema":{"$ref":"#/definitions/Credential"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CredentialInfo"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-purecloud-method-name":"putIntegrationsCredential"},"delete":{"tags":["Integrations"],"summary":"Delete a set of credentials","description":"","operationId":"deleteIntegrationsCredential","produces":["application/json"],"parameters":[{"name":"credentialId","in":"path","description":"Credential ID","required":true,"type":"string"}],"responses":{"204":{"description":"Deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-purecloud-method-name":"deleteIntegrationsCredential"}},"/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/wrapupcodes":{"get":{"tags":["Conversations"],"summary":"Get list of wrapup codes for this conversation participant","description":"","operationId":"getConversationsCallbackParticipantWrapupcodes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCallbackParticipantWrapupcodes"}},"/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/attributes":{"patch":{"tags":["Conversations"],"summary":"Update the attributes on a conversation participant.","description":"","operationId":"patchConversationsCallbackParticipantAttributes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Attributes","required":true,"schema":{"$ref":"#/definitions/ParticipantAttributes"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsCallbackParticipantAttributes"}},"/api/v2/conversations/callbacks/{conversationId}":{"get":{"tags":["Conversations"],"summary":"Get callback conversation","description":"","operationId":"getConversationsCallback","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallbackConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCallback"},"patch":{"tags":["Conversations"],"summary":"Update a conversation by disconnecting all of the participants","description":"","operationId":"patchConversationsCallback","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation","required":true,"schema":{"$ref":"#/definitions/Conversation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Conversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.empty.conversation.list":"An empty list of conversations is invalid.","conversation.error.cannot.conference.self":"A conversation cannot be merged with itself.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:disconnect"]},"x-purecloud-method-name":"patchConversationsCallback"}},"/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation participant. ","description":"","operationId":"getConversationsCallbackParticipantWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","conversation.error.participant.no.active.conversations":"The participant has no active conversation."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCallbackParticipantWrapup"}},"/api/v2/conversations/callbacks":{"get":{"tags":["Conversations"],"summary":"Get active callback conversations for the logged in user","description":"","operationId":"getConversationsCallbacks","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallbackConversationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCallbacks"},"post":{"tags":["Conversations"],"summary":"Create a Callback","description":"","operationId":"postConversationsCallbacks","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Callback","required":true,"schema":{"$ref":"#/definitions/CreateCallbackCommand"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CreateCallbackResponse"}},"202":{"description":"Accepted - Creating and Processing a Callback"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"callback.error.missing.callback.numbers":"Callback numbers missing","callback.error.missing.queue.id":"Callback missing queue ID","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","callback.error.scheduled.time.too.far.in.future":"Callback is scheduled to far in the future.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["conversation:callback:create"]},"x-purecloud-method-name":"postConversationsCallbacks"}},"/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant","description":"","operationId":"patchConversationsCallbackParticipant","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.participant.update.invalid":"Failed to update all properties on conversation participant.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","callback.error.transfer.canceled":"Answer failed because a pending attended transfer was canceled.","callback.error.answer.not.alerting":"Only alerting calls can be answered.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","conversation.error.participant.no.active.conversations":"The participant has no active conversation.","callback.error.conversation.not.found":"Conversation not found."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.participant.update.failed":"Failed to update all properties on conversation participant.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsCallbackParticipant"}},"/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/communications/{communicationId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant's communication by disconnecting it.","description":"","operationId":"patchConversationsCallbackParticipantCommunication","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"communication.state.required":"Can only update a communication's state to disconnected.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsCallbackParticipantCommunication"}},"/api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/replace":{"post":{"tags":["Conversations"],"summary":"Replace this participant with the specified user and/or address","description":"","operationId":"postConversationsCallbackParticipantReplace","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Transfer request","required":true,"schema":{"$ref":"#/definitions/TransferRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversations.error.transfer.same.party":"The target of the transfer cannot be the same as the destination.","callback.error.user.id.queue.id":"In destination, exactly one of userId or queueId is required.","callback.error.parse.call.number":"A callback number cannot be parsed as a phone address.","conversations.error.transfer.acd.call.unattended.":"An ACD call cannot be transferred unattended.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","conversations.error.queue.not.found":"Interaction cannot be transferred to a queue that does not exist.","conversations.error.transfer.not.connected":"You can only transfer conversations that are in the connected state.","callback.error.transfer.not.connected":"Only connected participants can be transferred","callback.error.additional.info.value.length.invalid":"The length of the additional info value is invalid.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"callback.error.unable.to.schedule.callback":"Server error unable to schedule callback.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationsCallbackParticipantReplace"}},"/api/v2/outbound/sequences":{"get":{"tags":["Outbound"],"summary":"Query a list of dialer campaign sequences.","description":"","operationId":"getOutboundSequences","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"allowEmptyResult","in":"query","description":"Whether to return an empty page when there are no results for that page","required":false,"type":"boolean","default":false},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"],"x-genesys-enum-members":[{"name":"Equals"},{"name":"RegEx"},{"name":"Contains"},{"name":"Prefix"},{"name":"LessThan"},{"name":"LessThanEqualTo"},{"name":"GreaterThan"},{"name":"GreaterThanEqualTo"},{"name":"BeginsWith"},{"name":"EndsWith"}]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignSequenceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaignSequence:view"]},"x-purecloud-method-name":"getOutboundSequences"},"post":{"tags":["Outbound"],"summary":"Create a new campaign sequence.","description":"","operationId":"postOutboundSequences","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Organization","required":true,"schema":{"$ref":"#/definitions/CampaignSequence"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignSequence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"A campaign sequence with this name already exists.","invalid.create":"","campaign.sequence.missing.campaign":"The dialer campaign sequence is missing a campaign.","max.entity.count.reached":"The maximum campaign sequence count has been reached.","campaign.sequence.invalid.campaign":"At least one campaign is invalid","campaign.sequence.invalid.current.campaign":"Current campaign is invalid","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","campaign.sequence.is.empty":"The dialer campaign sequence is empty.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaignSequence:add"]},"x-purecloud-method-name":"postOutboundSequences"}},"/api/v2/recordings/screensessions/{recordingSessionId}":{"patch":{"tags":["Recording"],"summary":"Update a screen recording session","description":"","operationId":"patchRecordingsScreensession","produces":["application/json"],"parameters":[{"name":"recordingSessionId","in":"path","description":"Screen recording session ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ScreenRecordingSessionRequest"}}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","qm.screen.recording.state.required":"Can only update a screen recording session's state to stopped.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","recording.recording.stop.permission.check.failed":"Failed to check required stop permission."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:screenRecording:stop"]},"x-purecloud-method-name":"patchRecordingsScreensession"}},"/api/v2/recordings/screensessions":{"get":{"tags":["Recording"],"summary":"Retrieves a paged listing of screen recording sessions","description":"","operationId":"getRecordingsScreensessions","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScreenRecordingSessionListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:screenRecording:view"]},"x-purecloud-method-name":"getRecordingsScreensessions"}},"/api/v2/license/definitions":{"get":{"tags":["License"],"summary":"Get all PureCloud license definitions available for the organization.","description":"","operationId":"getLicenseDefinitions","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/LicenseDefinition"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["license","license:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:add"]},"x-purecloud-method-name":"getLicenseDefinitions"}},"/api/v2/journey/actionmaps/{actionMapId}":{"get":{"tags":["Journey"],"summary":"Retrieve a single action map.","description":"","operationId":"getJourneyActionmap","produces":["application/json"],"parameters":[{"name":"actionMapId","in":"path","description":"ID of the action map.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionMap"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actionmap:view"]},"x-purecloud-method-name":"getJourneyActionmap"},"delete":{"tags":["Journey"],"summary":"Delete single action map.","description":"","operationId":"deleteJourneyActionmap","produces":["application/json"],"parameters":[{"name":"actionMapId","in":"path","description":"ID of the action map.","required":true,"type":"string"}],"responses":{"204":{"description":"Action map deleted."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actionmap:delete"]},"x-purecloud-method-name":"deleteJourneyActionmap"},"patch":{"tags":["Journey"],"summary":"Update single action map.","description":"","operationId":"patchJourneyActionmap","produces":["application/json"],"parameters":[{"name":"actionMapId","in":"path","description":"ID of the action map.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/PatchActionMap"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionMap"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actionmap:edit"]},"x-purecloud-method-name":"patchJourneyActionmap"}},"/api/v2/integrations/{integrationId}/config/current":{"get":{"tags":["Integrations"],"summary":"Get integration configuration.","description":"","operationId":"getIntegrationConfigCurrent","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IntegrationConfiguration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-purecloud-method-name":"getIntegrationConfigCurrent"},"put":{"tags":["Integrations"],"summary":"Update integration configuration.","description":"","operationId":"putIntegrationConfigCurrent","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Integration Configuration","required":false,"schema":{"$ref":"#/definitions/IntegrationConfiguration"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IntegrationConfiguration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"version.conflict":"Integration configuration update failed due to version conflict."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-purecloud-method-name":"putIntegrationConfigCurrent"}},"/api/v2/authorization/roles/{roleId}/users/remove":{"put":{"tags":["Authorization"],"summary":"Removes the users from the role","description":"","operationId":"putAuthorizationRoleUsersRemove","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"},{"in":"body","name":"body","description":"List of user IDs","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"type":"string"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:delete"]},"x-purecloud-method-name":"putAuthorizationRoleUsersRemove"}},"/api/v2/authorization/roles/{roleId}/users":{"get":{"tags":["Authorization"],"summary":"Get a list of the users in a specified role.","description":"Get an array of the UUIDs of the users in the specified role.","operationId":"getAuthorizationRoleUsers","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-purecloud-method-name":"getAuthorizationRoleUsers"}},"/api/v2/authorization/roles/{roleId}/users/add":{"put":{"tags":["Authorization"],"summary":"Sets the users for the role","description":"","operationId":"putAuthorizationRoleUsersAdd","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"},{"in":"body","name":"body","description":"List of user IDs","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"type":"string"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:add"]},"x-purecloud-method-name":"putAuthorizationRoleUsersAdd"}},"/api/v2/integrations/credentials/types":{"get":{"tags":["Integrations"],"summary":"List all credential types","description":"","operationId":"getIntegrationsCredentialsTypes","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CredentialTypeListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-purecloud-method-name":"getIntegrationsCredentialsTypes"}},"/api/v2/workforcemanagement/managementunits":{"get":{"tags":["Workforce Management"],"summary":"Get management units","description":"","operationId":"getWorkforcemanagementManagementunits","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Deprecated, paging is not supported","required":false,"type":"integer","format":"int32"},{"name":"pageNumber","in":"query","description":"Deprecated, paging is not supported","required":false,"type":"integer","format":"int32"},{"name":"expand","in":"query","description":"Deprecated, expand settings on the single MU route","required":false,"type":"string","enum":["details"],"x-genesys-enum-members":[{"name":"details"}]},{"name":"feature","in":"query","required":false,"type":"string","enum":["AgentSchedule","AgentTimeOffRequest","Coaching","ActivityCodes","Agents","BuActivityCodes","BusinessUnits","HistoricalAdherence","IntradayMonitoring","BuIntradayMonitoring","ManagementUnits","RealTimeAdherence","Schedules","BuSchedules","ServiceGoalTemplates","PlanningGroups","ShiftTrading","ShortTermForecasts","BuShortTermForecasts","TimeOffRequests","WorkPlanRotations","WorkPlans"],"x-genesys-enum-members":[{"name":"AgentSchedule"},{"name":"AgentTimeOffRequest"},{"name":"Coaching"},{"name":"ActivityCodes"},{"name":"Agents"},{"name":"BuActivityCodes"},{"name":"BusinessUnits"},{"name":"HistoricalAdherence"},{"name":"IntradayMonitoring"},{"name":"BuIntradayMonitoring"},{"name":"ManagementUnits"},{"name":"RealTimeAdherence"},{"name":"Schedules"},{"name":"BuSchedules"},{"name":"ServiceGoalTemplates"},{"name":"PlanningGroups"},{"name":"ShiftTrading"},{"name":"ShortTermForecasts"},{"name":"BuShortTermForecasts"},{"name":"TimeOffRequests"},{"name":"WorkPlanRotations"},{"name":"WorkPlans"}]},{"name":"divisionId","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ManagementUnitListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-purecloud-method-name":"getWorkforcemanagementManagementunits"},"post":{"tags":["Workforce Management"],"summary":"Add a management unit","description":"It may take a minute or two for a new management unit to be available for api operations","operationId":"postWorkforcemanagementManagementunits","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/CreateManagementUnitApiRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ManagementUnit"}},"201":{"description":"The management unit was successfully created","schema":{"$ref":"#/definitions/ManagementUnit"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.business.unit.not.found":"Business unit not found","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.missing.one.of.permission.sets":"Unable to perform the requested action. You must have access to the division of the business unit or all requested management units containing permission sets.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:managementUnit:add"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunits"}},"/api/v2/routing/email/domains":{"get":{"tags":["Routing"],"summary":"Get domains","description":"","operationId":"getRoutingEmailDomains","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundDomainEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.request.timeout":"Get domains request timed out.","authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"getRoutingEmailDomains"},"post":{"tags":["Routing"],"summary":"Create a domain","description":"","operationId":"postRoutingEmailDomains","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Domain","required":true,"schema":{"$ref":"#/definitions/InboundDomain"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundDomain"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.integration.connection":"Unable to connect with the specified integration.","email.error.integration.ssl":"There was a problem with opening a SSL socket to the integration.","postino.domain.exists":"The inbound domain already exists.","postino.max.domains.exceeded":"The maximum number of domains for the org has been exceeded.","email.error.integration.authentication":"Unable to authenticate with the specified integration.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","email.error.invalid.integration":"An invalid integration ID was specified.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","postino.invalid.domain.name":"The 'domain' field contains some illegal characters.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","email.error.integration.host":"The specified integration has a bad host."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.integration.timeout":"There was a timeout connecting to the integration.","authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"postRoutingEmailDomains"}},"/api/v2/integrations/speech/dialogflow/agents/{agentId}":{"get":{"tags":["Integrations"],"summary":"Get details about a Dialogflow agent","description":"","operationId":"getIntegrationsSpeechDialogflowAgent","produces":["application/json"],"parameters":[{"name":"agentId","in":"path","description":"The agent ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DialogflowAgent"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechDialogflowAgent"}},"/api/v2/voicemail/messages/{messageId}":{"get":{"tags":["Voicemail"],"summary":"Get a voicemail message","description":"","operationId":"getVoicemailMessage","produces":["application/json"],"parameters":[{"name":"messageId","in":"path","description":"Message ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"If the caller is a known user, which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["callerUser.routingStatus","callerUser.primaryPresence","callerUser.conversationSummary","callerUser.outOfOffice","callerUser.geolocation"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"callerUser.routingStatus"},{"name":"callerUser.primaryPresence"},{"name":"callerUser.conversationSummary"},{"name":"callerUser.outOfOffice"},{"name":"callerUser.geolocation"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","voicemail.not.authorized.voicemail.message":"You are not authorized to access the voicemail message.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-purecloud-method-name":"getVoicemailMessage"},"put":{"tags":["Voicemail"],"summary":"Update a voicemail message","description":"A user voicemail can only be modified by its associated user. A group voicemail can only be modified by a user that is a member of the group. A queue voicemail can only be modified by a participant of the conversation the voicemail is associated with.","operationId":"putVoicemailMessage","produces":["application/json"],"parameters":[{"name":"messageId","in":"path","description":"Message ID","required":true,"type":"string"},{"in":"body","name":"body","description":"VoicemailMessage","required":true,"schema":{"$ref":"#/definitions/VoicemailMessage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"voicemail.retention.policy.type.unknown":"The voicemail retention policy type is invalid","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","voicemail.retention.policy.number.of.days.required":"The retention policy's number of days is required for a voicemail with a retention policy type of RETAIN_WITH_TTL","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","voicemail.retention.policy.number.of.days.too.large":"The retention policy's number of days is too large","voicemail.retention.policy.type.required":"The voicemail retention policy type is required","voicemail.retention.policy.number.of.days.too.small":"The retention policy's number of days is too small","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","voicemail.not.authorized.voicemail.message":"You are not authorized to access the voicemail message.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","voicemail.not.authorized.voicemail.delete":"You are not authorized to delete the voicemail message."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"voicemail.notes.length.exceeded":"The voicemail message's note length was exceeded."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail"]}],"x-purecloud-method-name":"putVoicemailMessage"},"delete":{"tags":["Voicemail"],"summary":"Delete a voicemail message.","description":"A user voicemail can only be deleted by its associated user. A group voicemail can only be deleted by a user that is a member of the group. A queue voicemail can only be deleted by a user with the acd voicemail delete permission.","operationId":"deleteVoicemailMessage","produces":["application/json"],"parameters":[{"name":"messageId","in":"path","description":"Message ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","voicemail.not.authorized.voicemail.message":"You are not authorized to access the voicemail message.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail"]}],"x-purecloud-method-name":"deleteVoicemailMessage"},"patch":{"tags":["Voicemail"],"summary":"Update a voicemail message","description":"A user voicemail can only be modified by its associated user. A group voicemail can only be modified by a user that is a member of the group. A queue voicemail can only be modified by a participant of the conversation the voicemail is associated with.","operationId":"patchVoicemailMessage","produces":["application/json"],"parameters":[{"name":"messageId","in":"path","description":"Message ID","required":true,"type":"string"},{"in":"body","name":"body","description":"VoicemailMessage","required":true,"schema":{"$ref":"#/definitions/VoicemailMessage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"voicemail.retention.policy.type.unknown":"The voicemail retention policy type is invalid","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","voicemail.retention.policy.number.of.days.required":"The retention policy's number of days is required for a voicemail with a retention policy type of RETAIN_WITH_TTL","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","voicemail.retention.policy.number.of.days.too.large":"The retention policy's number of days is too large","voicemail.retention.policy.type.required":"The voicemail retention policy type is required","voicemail.retention.policy.number.of.days.too.small":"The retention policy's number of days is too small","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","voicemail.not.authorized.voicemail.message":"You are not authorized to access the voicemail message.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","voicemail.not.authorized.voicemail.delete":"You are not authorized to delete the voicemail message."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"voicemailservice.toomanyrequests":"Too many requests have been made in the given time","voicemail.notes.length.exceeded":"The voicemail message's note length was exceeded."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail"]}],"x-purecloud-method-name":"patchVoicemailMessage"}},"/api/v2/voicemail/messages/{messageId}/media":{"get":{"tags":["Voicemail"],"summary":"Get media playback URI for this voicemail message","description":"","operationId":"getVoicemailMessageMedia","produces":["application/json"],"parameters":[{"name":"messageId","in":"path","description":"Message ID","required":true,"type":"string"},{"name":"formatId","in":"query","description":"The desired media format.","required":false,"type":"string","default":"WEBM","enum":["WAV","WEBM","WAV_ULAW","OGG_VORBIS","OGG_OPUS","MP3","NONE"],"x-genesys-enum-members":[{"name":"WAV"},{"name":"WEBM"},{"name":"WAV_ULAW"},{"name":"OGG_VORBIS"},{"name":"OGG_OPUS"},{"name":"MP3"},{"name":"NONE"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMediaInfo"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","voicemail.not.authorized.voicemail.message":"You are not authorized to access the voicemail message.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-purecloud-method-name":"getVoicemailMessageMedia"}},"/api/v2/outbound/campaigns/{campaignId}/progress":{"get":{"tags":["Outbound"],"summary":"Get campaign progress","description":"","operationId":"getOutboundCampaignProgress","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignProgress"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The dialer campaign was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:view"]},"x-purecloud-method-name":"getOutboundCampaignProgress"},"delete":{"tags":["Outbound"],"summary":"Reset campaign progress and recycle the campaign","description":"","operationId":"deleteOutboundCampaignProgress","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"202":{"description":"Accepted - the campaign will be recycled momentarily"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The dialer campaign was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","too.many.recycles":"A campaign can only be recycled once every 5 seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:edit"]},"x-purecloud-method-name":"deleteOutboundCampaignProgress"}},"/api/v2/outbound/campaigns/{campaignId}":{"get":{"tags":["Outbound"],"summary":"Get dialer campaign.","description":"","operationId":"getOutboundCampaign","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Campaign"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:view"]},"x-purecloud-method-name":"getOutboundCampaign"},"put":{"tags":["Outbound"],"summary":"Update a campaign.","description":"","operationId":"putOutboundCampaign","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Campaign","required":true,"schema":{"$ref":"#/definitions/Campaign"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Campaign"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.priority":"The priority must be between 1 and 5 (inclusive)","name.length.exceeded":"The name length exceeds the limit of 64 characters.","too.many.queue.members":"The limit for number of queue members on a campaign configured for agent owned records has been exceeded. See details.","duplicate.name":"The name already exists.","site.has.no.active.edges":"There are no active edges in the site","edge.group.not.found":"The edge group could not be found.","too.many.data.action.conditions":"There can be a maximum of 1 data action condition across all rule sets referenced by this campaign","contact.sorts.duplicate.field.names":"The same column name is used in separate contact sorts entries.","invalid.update":"","more.than.one.contact.list.filter":"Only one contact list filter is allowed per campaign.","managed.site.cannot.be.configured":"Managed Sites cannot be configured on a campaign.","invalid.campaign.preview.timeout.seconds":"The preview timeout seconds must be between 0 and 1200 (inclusive)","resources.in.use":"Resources are already in use.","invalid.update.bad.status.transition":"The status transition is invalid.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","contact.list.filter.not.found":"The contact list filter could not be found.","dnc.list.not.found":"A do not call list could not be found.","missing.caller.id.address":"No caller id address supplied","agent.owned.column.cannot.be.changed":"The agent owned column cannot be changed.","rule.set.not.found":"A rule set could not be found.","managed.edge.group.cannot.be.configured":"Managed Edge Groups cannot be configured on a campaign.","property.not.allowed.for.external.calling":"The following properties are not allowed to be configured on an external campaign: abandonRate, edgeGroup, site, callAnalysisResponseSet, callerName, callerAddress, outboundLineCount, ruleSets, previewTimeOutSeconds, noAnswerTimeout, and callAnalysisResponseSet.","invalid.campaign.phone.columns":"The campaign phone columns are invalid.","contact.sorts.conflict":"The contact sort and contact sorts fields have conflicting values.","invalid.update.campaign.active":"The campaign is already active","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","site.not.found":"The site could not be found","queue.not.found":"The queue could not be found.","no.edge.group.for.site":"No edge group was found for the site","name.cannot.be.blank":"A name must be provided.","invalid.campaign.outbound.line.count":"","bad.request":"The request could not be understood by the server due to malformed syntax.","callable.time.set.not.found":"The callable time set could not be found.","missing.caller.id.name":"No caller id name supplied","contact.list.filter.does.not.match.contact.list":"The contact list on the contact list filter does not match the contact list on the campaign.","call.analysis.response.set.not.found":"The call analysis response set could not be found.","agent.owned.queue.cannot.be.changed":"The queue cannot be changed on a campaign configured for agent owned records.","script.not.found":"The script could not be found.","site.and.edge.group.cannot.be.configured":"A single campaign cannot have both a site and an edge group configured","contact.sort.field.not.found":"The contact sort field is not a column on the contact list.","invalid.campaign.agent.owned.column":"The campaign agent owned column is not a valid contact list column.","contact.sorts.invalid.field.name":"A contact sorts field name is not a valid column name in the campaign's contact list.","external.calling.property.not.allowed":"Some properties cannot be set on an external calling campaign. See details","edge.group.has.no.active.edges":"There are no active edges in the edge group","invalid.call.analysis.response.set.for.agentless.campaign":"The call analysis response set is invalid for agentless campaigns.","invalid.ani.address":"The caller id number is invalid.","name.required":"A name must be provided.","callable.time.set.conflicts.with.automatic.time.zone.mapping":"A callable time set cannot be included on the campaign when the campaign's contact list uses automatic time zone mapping.","active.campaigns.limit.exceeded":"The maximum number of active campaigns has been reached. Please turn off at least one campaign and wait for it to stop before starting another one.","edge.group.is.empty":"There are no edges in the edge group","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","missing.time.zone.in.contactlist":"When using a callable time set, the contact list must have at least one time zone column defined.","invalid.dialing.mode.update":"Invalid dialing mode","site.is.empty":"There are no edges in the site","contact.list.import.in.progress":"The contact list on the camapign is still importing contacts."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","all.campaigns.black.listed":"This organization has been blacklisted from starting campaigns. Please contact support.","campaign.black.listed":"This campaign has been blacklisted. Please contact support."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"409":{"description":"Conflict.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.campaign.active":"The campaign is already active.","invalid.update.wrong.version":""}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:edit"]},"x-purecloud-method-name":"putOutboundCampaign"},"delete":{"tags":["Outbound"],"summary":"Delete a campaign.","description":"","operationId":"deleteOutboundCampaign","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Campaign"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","referential.integrity.error":"Could not delete the resource because it is referenced by another entity.","campaign.in.use":"The campaign is in use."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:delete"]},"x-purecloud-method-name":"deleteOutboundCampaign"}},"/api/v2/outbound/campaigns/{campaignId}/diagnostics":{"get":{"tags":["Outbound"],"summary":"Get campaign diagnostics","description":"","operationId":"getOutboundCampaignDiagnostics","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignDiagnostics"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The dialer campaign was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:view"]},"x-purecloud-method-name":"getOutboundCampaignDiagnostics"}},"/api/v2/analytics/conversations/transcripts/query":{"post":{"tags":["Search","Analytics"],"summary":"Search resources.","description":"","operationId":"postAnalyticsConversationsTranscriptsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/TranscriptConversationDetailSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AnalyticsConversationWithoutAttributesMultiGetResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","too.many.search.requests":"Rate limit for search requests exceeded"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationDetail:view"]},"x-purecloud-method-name":"postAnalyticsConversationsTranscriptsQuery"}},"/api/v2/webchat/guest/conversations/{conversationId}/messages/{messageId}":{"get":{"tags":["WebChat"],"summary":"Get a web chat conversation message","description":"","operationId":"getWebchatGuestConversationMessage","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"messageId","in":"path","description":"messageId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.not.found":"The web chat conversation message was not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"Guest Chat JWT":[]}],"x-purecloud-method-name":"getWebchatGuestConversationMessage"}},"/api/v2/quality/forms/evaluations/{formId}/versions":{"get":{"tags":["Quality"],"summary":"Gets all the revisions for a specific evaluation.","description":"","operationId":"getQualityFormsEvaluationVersions","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:view"]},"x-purecloud-method-name":"getQualityFormsEvaluationVersions"}},"/api/v2/voicemail/me/messages":{"get":{"tags":["Voicemail"],"summary":"List voicemail messages","description":"","operationId":"getVoicemailMeMessages","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMessageEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-purecloud-method-name":"getVoicemailMeMessages"}},"/api/v2/users/{userId}/station/defaultstation/{stationId}":{"put":{"tags":["Users"],"summary":"Set default station","description":"","operationId":"putUserStationDefaultstationStationId","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"stationId","in":"path","description":"stationId","required":true,"type":"string"}],"responses":{"202":{"description":"Success"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"userservice.stationalreadyhasdefaultuser":"Station is already associated"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","userservice.toomanyrequests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all","telephony:phone:assign"]},"x-purecloud-method-name":"putUserStationDefaultstationStationId"}},"/api/v2/users/{userId}/station/defaultstation":{"delete":{"tags":["Users"],"summary":"Clear default station","description":"","operationId":"deleteUserStationDefaultstation","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"202":{"description":"Success"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all","telephony:phone:assign"]},"x-purecloud-method-name":"deleteUserStationDefaultstation"}},"/api/v2/users/{userId}/station/associatedstation/{stationId}":{"put":{"tags":["Users"],"summary":"Set associated station","description":"","operationId":"putUserStationAssociatedstationStationId","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"stationId","in":"path","description":"stationId","required":true,"type":"string"}],"responses":{"202":{"description":"Success"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","userservice.station.notfound":"Station is not found"}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"userservice.station.providerlocationmissing":"The location of the station could not be found","userservice.stationalreadyassociated":"Station is already associated","userservice.station.nothomed":"The station is incorrectly or not assigned"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"424":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"externalservice.unexpectedresponsecode":"Unexpected backend response code"}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-purecloud-method-name":"putUserStationAssociatedstationStationId"}},"/api/v2/users/{userId}/station/associatedstation":{"delete":{"tags":["Users"],"summary":"Clear associated station","description":"","operationId":"deleteUserStationAssociatedstation","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"202":{"description":"Success"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-purecloud-method-name":"deleteUserStationAssociatedstation"}},"/api/v2/users/{userId}/station":{"get":{"tags":["Users"],"summary":"Get station information for user","description":"","operationId":"getUserStation","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserStations"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"424":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"externalservice.unexpectedresponsecode":"Unexpected backend response code"}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getUserStation"}},"/api/v2/integrations":{"get":{"tags":["Integrations"],"summary":"List integrations","description":"","operationId":"getIntegrations","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IntegrationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-purecloud-method-name":"getIntegrations"},"post":{"tags":["Integrations"],"summary":"Create an integration.","description":"","operationId":"postIntegrations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Integration","required":false,"schema":{"$ref":"#/definitions/CreateIntegrationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Integration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","max.integrations.reached":"The maximum number of integrations for this type have already been created. One or more integrations must be removed before a new one can be created."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-purecloud-method-name":"postIntegrations"}},"/api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces/{interfaceId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get an edge logical interface","description":"","operationId":"getTelephonyProvidersEdgeLogicalinterface","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"interfaceId","in":"path","description":"Interface ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Field to expand in the response","required":false,"type":"array","items":{"type":"string","enum":["externalTrunkBaseAssignments","phoneTrunkBaseAssignments"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"externalTrunkBaseAssignments"},{"name":"phoneTrunkBaseAssignments"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainLogicalInterface"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgeLogicalinterface"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update an edge logical interface.","description":"","operationId":"putTelephonyProvidersEdgeLogicalinterface","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"interfaceId","in":"path","description":"Interface ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Logical interface","required":true,"schema":{"$ref":"#/definitions/DomainLogicalInterface"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainLogicalInterface"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"Information was missing or malformed in the request","duplicate.value":"A logical interface with that vlanTagId already exists on this port.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgeLogicalinterface"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete an edge logical interface","description":"","operationId":"deleteTelephonyProvidersEdgeLogicalinterface","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"interfaceId","in":"path","description":"Interface ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdgeLogicalinterface"}},"/api/v2/contentmanagement/workspaces/{workspaceId}/documents":{"get":{"tags":["Content Management"],"summary":"Get a list of documents.","description":"","operationId":"getContentmanagementWorkspaceDocuments","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["acl","workspace"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"acl"},{"name":"workspace"}]},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"name or dateCreated","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"ascending or descending","required":false,"type":"string","default":"ascending"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementWorkspaceDocuments"}},"/api/v2/telephony/providers/edges/{edgeId}/physicalinterfaces/{interfaceId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get edge physical interface.","description":"Retrieve a physical interface from a specific edge.","operationId":"getTelephonyProvidersEdgePhysicalinterface","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"interfaceId","in":"path","description":"Interface ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainPhysicalInterface"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgePhysicalinterface"}},"/api/v2/architect/dependencytracking/types/{typeId}":{"get":{"tags":["Architect"],"summary":"Get a Dependency Tracking type.","description":"","operationId":"getArchitectDependencytrackingType","produces":["application/json"],"parameters":[{"name":"typeId","in":"path","description":"Type ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DependencyType"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.dependency.invalid.type":"An invalid dependency type was specified.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:dependencyTracking:view"]},"x-purecloud-method-name":"getArchitectDependencytrackingType"}},"/api/v2/outbound/contactlists/{contactListId}/contacts/{contactId}":{"get":{"tags":["Outbound"],"summary":"Get a contact.","description":"","operationId":"getOutboundContactlistContact","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"},{"name":"contactId","in":"path","description":"Contact ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DialerContact"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contact:view"]},"x-purecloud-method-name":"getOutboundContactlistContact"},"put":{"tags":["Outbound"],"summary":"Update a contact.","description":"","operationId":"putOutboundContactlistContact","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"},{"name":"contactId","in":"path","description":"Contact ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Contact","required":true,"schema":{"$ref":"#/definitions/DialerContact"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DialerContact"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update":"An attempt was made to update a contact in an invalid way","contact.missing.columns":"The contact is missing columns from its contact list.","invalid.contact.id":"An attempt was made to update a contact with an invalid contact ID","contact.column.length.limit.exceeded":"The length of each contact column must not exceed the limit.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","contact.missing.data":"The data field is required.","contact.columns.limit.exceeded":"Number of contact columns must not exceed the limit.","contact.datum.length.limit.exceeded":"The length of each piece of contact data must not exceed the limit.","contact.does.not.exist":"The contact does not exist.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contact:edit"]},"x-purecloud-method-name":"putOutboundContactlistContact"},"delete":{"tags":["Outbound"],"summary":"Delete a contact.","description":"","operationId":"deleteOutboundContactlistContact","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"},{"name":"contactId","in":"path","description":"Contact ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.in.use":"The contact cannot be deleted because it is currently in use.","invalid.delete":"An attempt was made to delete a contact in an invalid way","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","contact.not.found":"The contact could not be found.","not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contact:delete"]},"x-purecloud-method-name":"deleteOutboundContactlistContact"}},"/api/v2/telephony/providers/edges/{edgeId}/unpair":{"post":{"tags":["Telephony Providers Edge"],"summary":"Unpair an Edge","description":"","operationId":"postTelephonyProvidersEdgeUnpair","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","managed.property.not.allowed":"Not allowed to set managed property."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conflict":"The Edge must have an inactive state to complete this operation."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgeUnpair"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/wrapupcodes":{"get":{"tags":["Conversations"],"summary":"Get list of wrapup codes for this conversation participant","description":"","operationId":"getConversationParticipantWrapupcodes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationParticipantWrapupcodes"}},"/api/v2/conversations/{conversationId}/participants/{participantId}":{"patch":{"tags":["Conversations"],"summary":"Update a participant.","description":"Update conversation participant.","operationId":"patchConversationParticipant","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Update request","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.hold.alerting":"An alerting call cannot be placed on hold","conversation.participant.update.invalid":"Failed to update all properties on conversation participant.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","conversation.error.cannot.confine.party":"The participant for this request cannot be confined.","conversation.error.wrapup.code.required":"Wrapup code is a required field and cannot be empty.","conversation.error.participant.attribute.null":"Cannot update participant attribute map to a null value.","conversation.error.cannot.disconnect.call":"The call for this request cannot be disconnected.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","conversation.error.participant.no.active.conversations":"Participant has no active conversations"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.participant.update.failed":"Failed to update all properties on conversation participant.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationParticipant"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/callbacks":{"post":{"tags":["Conversations"],"summary":"Create a new callback for the specified participant on the conversation.","description":"","operationId":"postConversationParticipantCallbacks","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/CreateCallbackOnConversationCommand"}}],"responses":{"201":{"description":"Created"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.cannot.callback.acd":"Cannot create a callback for an ACD participant.","callback.error.callback.already.being.routed":"A callback is already in the process of being routed on this conversation.","callback.error.parse.call.number":"A callback number cannot be parsed as a phone address.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","callback.error.scheduled.callback.already.exists":"A callback is already scheduled on this conversation.","conversation.error.queue.required":"Queue id is required for this request.","callback.error.target.communication.cannot.be.acd.or.ivr":"Target communication cannot belong to an acd or ivr participant.","callback.error.scheduled.time.too.far.in.future":"The callback scheduled time cannot be more than 30 days into the future.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["conversation:callback:create"]},"x-purecloud-method-name":"postConversationParticipantCallbacks"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/attributes":{"patch":{"tags":["Conversations"],"summary":"Update the attributes on a conversation participant.","description":"","operationId":"patchConversationParticipantAttributes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant attributes","required":true,"schema":{"$ref":"#/definitions/ParticipantAttributes"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.participant.not.found":"The participant does not exist.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationParticipantAttributes"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation participant. ","description":"","operationId":"getConversationParticipantWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationParticipantWrapup"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/flaggedreason":{"put":{"tags":["Conversations"],"summary":"Set flagged reason on conversation participant to indicate bad conversation quality.","description":"","operationId":"putConversationParticipantFlaggedreason","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"}],"responses":{"204":{"description":"The flagged reason was set successfully."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"putConversationParticipantFlaggedreason"},"delete":{"tags":["Conversations"],"summary":"Remove flagged reason from conversation participant.","description":"","operationId":"deleteConversationParticipantFlaggedreason","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"}],"responses":{"204":{"description":"The flagged reason was removed successfully."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"deleteConversationParticipantFlaggedreason"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/replace":{"post":{"tags":["Conversations"],"summary":"Replace this participant with the specified user and/or address","description":"","operationId":"postConversationParticipantReplace","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Transfer request","required":true,"schema":{"$ref":"#/definitions/TransferRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversations.error.transfer.chat.external":"Participants with chats cannot be transferred to external addresses.","bad.request":"The request could not be understood by the server due to malformed syntax.","conversations.error.transfer.usercall.voicemail":"Only personal calls can be transferred to voicemail.","conversation.error.participant.no.active.conversations":"Participant has no active conversations","conversations.error.transfer.same.party":"The target of the transfer cannot be the same as the destination.","conversations.error.transfer.acd.call.unattended":"An ACD call cannot be transferred unattended.","conversations.error.transfer.destination.required":"The destination is a required property for a transfer request.","callback.error.user.id.queue.id":"In destination, exactly one of userId or queueId is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","conversations.error.transfer.userCall.voicemail":"Only personal calls can be transferred to voicemail.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","postino.error.bad.request":"The request could not be understood by the server due to malformed syntax.","conversations.error.queue.not.found":"Interaction cannot be transferred to a queue that does not exist.","conversations.error.transfer.not.connected":"You can only transfer conversations that are in the connected state.","conversations.error.transfer.chat.voicemail":"Participants with chats cannot be transferred to voicemail.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.participant.not.found":"Participant does not exist.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationParticipantReplace"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/digits":{"post":{"tags":["Conversations"],"summary":"Sends DTMF to the participant","description":"","operationId":"postConversationParticipantDigits","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Digits","required":false,"schema":{"$ref":"#/definitions/Digits"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"providerapi.error.station.no.active.edge":"Unable to place call. Could not find an Edge for this station.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationParticipantDigits"}},"/api/v2/authorization/roles/{roleId}":{"get":{"tags":["Authorization"],"summary":"Get a single organization role.","description":"Get the organization role specified by its ID.","operationId":"getAuthorizationRole","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand. \"unusedPermissions\" returns the permissions not used for the role","required":false,"type":"array","items":{"type":"string","enum":["unusedPermissions"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"unusedPermissions"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainOrganizationRole"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"An internal service error has occurred."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:view"]},"x-purecloud-method-name":"getAuthorizationRole"},"post":{"tags":["Authorization"],"summary":"Bulk-grant subjects and divisions with an organization role.","description":"","operationId":"postAuthorizationRole","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Subjects and Divisions","required":true,"schema":{"$ref":"#/definitions/SubjectDivisions"}},{"name":"subjectType","in":"query","description":"what the type of the subjects are (PC_GROUP, PC_USER or PC_OAUTH_CLIENT)","required":false,"type":"string","default":"PC_USER"}],"responses":{"204":{"description":"Bulk Grants Created"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request is badly formed.","invalid.subject.type":"Bad request, invalid subject type","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:add"]},"x-purecloud-method-name":"postAuthorizationRole"},"put":{"tags":["Authorization"],"summary":"Update an organization role.","description":"Update","operationId":"putAuthorizationRole","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Organization role","required":true,"schema":{"$ref":"#/definitions/DomainOrganizationRoleUpdate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainOrganizationRole"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request is badly formed.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:edit"]},"x-purecloud-method-name":"putAuthorizationRole"},"delete":{"tags":["Authorization"],"summary":"Delete an organization role.","description":"","operationId":"deleteAuthorizationRole","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:delete"]},"x-purecloud-method-name":"deleteAuthorizationRole"},"patch":{"tags":["Authorization"],"summary":"Patch Organization Role for needsUpdate Field","description":"Patch Organization Role for needsUpdate Field","operationId":"patchAuthorizationRole","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Organization role","required":true,"schema":{"$ref":"#/definitions/DomainOrganizationRole"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainOrganizationRole"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:edit"]},"x-purecloud-method-name":"patchAuthorizationRole"}},"/api/v2/routing/queues/{queueId}/wrapupcodes":{"get":{"tags":["Routing"],"summary":"Get the wrap-up codes for a queue","description":"","operationId":"getRoutingQueueWrapupcodes","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapupCodeEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"At least one of the required division permissions is missing","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The queue could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:queue:view"]},"x-purecloud-method-name":"getRoutingQueueWrapupcodes"},"post":{"tags":["Routing"],"summary":"Add up to 100 wrap-up codes to a queue","description":"","operationId":"postRoutingQueueWrapupcodes","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"in":"body","name":"body","description":"List of wrapup codes","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/WrapUpCodeReference"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid request data. Make sure you submit a valid number of wrapup codes.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"At least one of the required division permissions is missing","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The specified queue was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:queue:edit"]},"x-purecloud-method-name":"postRoutingQueueWrapupcodes"}},"/api/v2/routing/queues/{queueId}/wrapupcodes/{codeId}":{"delete":{"tags":["Routing"],"summary":"Delete a wrap-up code from a queue","description":"","operationId":"deleteRoutingQueueWrapupcode","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"codeId","in":"path","description":"Code ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"At least one of the required division permissions is missing","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The queue could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:queue:edit"]},"x-purecloud-method-name":"deleteRoutingQueueWrapupcode"}},"/api/v2/authorization/subjects/{subjectId}/divisions/{divisionId}/roles/{roleId}":{"post":{"tags":["Authorization","Users"],"summary":"Make a grant of a role in a division","description":"","operationId":"postAuthorizationSubjectDivisionRole","produces":["application/json"],"parameters":[{"name":"subjectId","in":"path","description":"Subject ID (user or group)","required":true,"type":"string"},{"name":"divisionId","in":"path","description":"the id of the division to which to make the grant","required":true,"type":"string"},{"name":"roleId","in":"path","description":"the id of the role to grant","required":true,"type":"string"},{"name":"subjectType","in":"query","description":"what the type of the subject is: PC_GROUP, PC_USER or PC_OAUTH_CLIENT (note: for cross-org authorization, please use the Organization Authorization endpoints)","required":false,"type":"string","default":"PC_USER"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:add"]},"x-purecloud-method-name":"postAuthorizationSubjectDivisionRole"},"delete":{"tags":["Authorization","Users"],"summary":"Delete a grant of a role in a division","description":"","operationId":"deleteAuthorizationSubjectDivisionRole","produces":["application/json"],"parameters":[{"name":"subjectId","in":"path","description":"Subject ID (user or group)","required":true,"type":"string"},{"name":"divisionId","in":"path","description":"the id of the division of the grant","required":true,"type":"string"},{"name":"roleId","in":"path","description":"the id of the role of the grant","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:delete"]},"x-purecloud-method-name":"deleteAuthorizationSubjectDivisionRole"}},"/api/v2/authorization/subjects/{subjectId}/bulkadd":{"post":{"tags":["Authorization","Users"],"summary":"Bulk-grant roles and divisions to a subject.","description":"","operationId":"postAuthorizationSubjectBulkadd","produces":["application/json"],"parameters":[{"name":"subjectId","in":"path","description":"Subject ID (user or group)","required":true,"type":"string"},{"in":"body","name":"body","description":"Pairs of role and division IDs","required":true,"schema":{"$ref":"#/definitions/RoleDivisionGrants"}},{"name":"subjectType","in":"query","description":"what the type of the subject is (PC_GROUP, PC_USER or PC_OAUTH_CLIENT)","required":false,"type":"string","default":"PC_USER"}],"responses":{"204":{"description":"Bulk Grants Created"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{".bad.role.divisions":"Invalid role divisions in request.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:add"]},"x-purecloud-method-name":"postAuthorizationSubjectBulkadd"}},"/api/v2/authorization/subjects/{subjectId}/bulkremove":{"post":{"tags":["Authorization","Users"],"summary":"Bulk-remove grants from a subject.","description":"","operationId":"postAuthorizationSubjectBulkremove","produces":["application/json"],"parameters":[{"name":"subjectId","in":"path","description":"Subject ID (user or group)","required":true,"type":"string"},{"in":"body","name":"body","description":"Pairs of role and division IDs","required":true,"schema":{"$ref":"#/definitions/RoleDivisionGrants"}}],"responses":{"204":{"description":"Bulk Grants Deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:delete"]},"x-purecloud-method-name":"postAuthorizationSubjectBulkremove"}},"/api/v2/authorization/subjects/{subjectId}":{"get":{"tags":["Authorization","Users"],"summary":"Returns a listing of roles and permissions for a user.","description":"","operationId":"getAuthorizationSubject","produces":["application/json"],"parameters":[{"name":"subjectId","in":"path","description":"Subject ID (user or group)","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuthzSubject"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"An internal server error has ocurred."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:view"]},"x-purecloud-method-name":"getAuthorizationSubject"}},"/api/v2/architect/ivrs":{"get":{"tags":["Architect"],"summary":"Get IVR configs.","description":"","operationId":"getArchitectIvrs","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"name","in":"query","description":"Name of the IVR to filter by.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IVREntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:callRoute:view"]},"x-purecloud-method-name":"getArchitectIvrs"},"post":{"tags":["Architect"],"summary":"Create IVR config.","description":"","operationId":"postArchitectIvrs","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/IVR"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IVR"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:callRoute:add"]},"x-purecloud-method-name":"postArchitectIvrs"}},"/api/v2/scripts/{scriptId}/pages":{"get":{"tags":["Scripts"],"summary":"Get the list of pages","description":"","operationId":"getScriptPages","produces":["application/json"],"parameters":[{"name":"scriptId","in":"path","description":"Script ID","required":true,"type":"string"},{"name":"scriptDataVersion","in":"query","description":"Advanced usage - controls the data version of the script","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/Page"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:script:view"]},"x-purecloud-method-name":"getScriptPages"}},"/api/v2/telephony/providers/edges/phones/template":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Phone instance template based on a Phone Base Settings object. This object can then be modified and saved as a new Phone instance","description":"","operationId":"getTelephonyProvidersEdgesPhonesTemplate","produces":["application/json"],"parameters":[{"name":"phoneBaseSettingsId","in":"query","description":"The id of a Phone Base Settings object upon which to base this Phone","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Phone"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesPhonesTemplate"}},"/api/v2/routing/queues/{queueId}/members/{memberId}":{"delete":{"tags":["Routing"],"summary":"Delete a queue member.","description":"","operationId":"deleteRoutingQueueMember","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"memberId","in":"path","description":"Member ID","required":true,"type":"string"}],"responses":{"204":{"description":"Deleted."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","missing.any.division.permissions":"At least one of the required division permissions is missing"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:edit","routing:queueMember:manage"]},"x-purecloud-method-name":"deleteRoutingQueueMember"},"patch":{"tags":["Routing"],"summary":"Update the ring number OR joined status for a queue member.","description":"","operationId":"patchRoutingQueueMember","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"memberId","in":"path","description":"Member ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Queue Member","required":true,"schema":{"$ref":"#/definitions/QueueMember"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueMember"}},"202":{"description":"User update has been accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid request data. Make sure the joined OR ringNumber property is specified.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","missing.any.division.permissions":"At least one of the required division permissions is missing"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:edit","routing:queueMember:manage"]},"x-purecloud-method-name":"patchRoutingQueueMember"}},"/api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}/roledivisions":{"put":{"tags":["Organization Authorization"],"summary":"Update Trustee User Roles","description":"","operationId":"putOrgauthorizationTrusteeUserRoledivisions","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Trustee User Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Set of roles with corresponding divisions to apply","required":true,"schema":{"$ref":"#/definitions/RoleDivisionGrants"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserAuthorization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:edit"]},"x-purecloud-method-name":"putOrgauthorizationTrusteeUserRoledivisions"}},"/api/v2/outbound/dnclists/{dncListId}/importstatus":{"get":{"tags":["Outbound"],"summary":"Get dialer dncList import status.","description":"","operationId":"getOutboundDnclistImportstatus","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ImportStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.not.found":"The do not call list could not be found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dncList:view"]},"x-purecloud-method-name":"getOutboundDnclistImportstatus"}},"/api/v2/workforcemanagement/timeoffrequests":{"get":{"tags":["Workforce Management"],"summary":"Get a list of time off requests for the current user","description":"","operationId":"getWorkforcemanagementTimeoffrequests","produces":["application/json"],"parameters":[{"name":"recentlyReviewed","in":"query","description":"Limit results to requests that have been reviewed within the preceding 30 days","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffRequestList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.server.error":"WFM Server Error","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentSchedule:view","wfm:agentTimeOffRequest:submit"]},"x-purecloud-method-name":"getWorkforcemanagementTimeoffrequests"},"post":{"tags":["Workforce Management"],"summary":"Create a time off request for the current user","description":"","operationId":"postWorkforcemanagementTimeoffrequests","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/CreateAgentTimeOffRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffRequestResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentTimeOffRequest:submit"]},"x-purecloud-method-name":"postWorkforcemanagementTimeoffrequests"}},"/api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}":{"get":{"tags":["Workforce Management"],"summary":"Get a time off request for the current user","description":"","operationId":"getWorkforcemanagementTimeoffrequest","produces":["application/json"],"parameters":[{"name":"timeOffRequestId","in":"path","description":"Time Off Request Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffRequestResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentSchedule:view","wfm:agentTimeOffRequest:submit"]},"x-purecloud-method-name":"getWorkforcemanagementTimeoffrequest"},"patch":{"tags":["Workforce Management"],"summary":"Update a time off request for the current user","description":"","operationId":"patchWorkforcemanagementTimeoffrequest","produces":["application/json"],"parameters":[{"name":"timeOffRequestId","in":"path","description":"Time Off Request Id","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/AgentTimeOffRequestPatch"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffRequestResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentTimeOffRequest:submit"]},"x-purecloud-method-name":"patchWorkforcemanagementTimeoffrequest"}},"/api/v2/authorization/divisions/home":{"get":{"tags":["Authorization","Objects"],"summary":"Retrieve the home division for the organization.","description":"Will not include object counts.","operationId":"getAuthorizationDivisionsHome","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuthzDivision"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-purecloud-method-name":"getAuthorizationDivisionsHome"}},"/api/v2/voicemail/search":{"get":{"tags":["Search","Voicemail"],"summary":"Search voicemails using the q64 value returned from a previous search","description":"","operationId":"getVoicemailSearch","produces":["application/json"],"parameters":[{"name":"q64","in":"query","description":"q64","required":true,"type":"string"},{"name":"expand","in":"query","description":"expand","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailsSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-purecloud-method-name":"getVoicemailSearch"},"post":{"tags":["Search","Voicemail"],"summary":"Search voicemails","description":"","operationId":"postVoicemailSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/VoicemailSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailsSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-purecloud-method-name":"postVoicemailSearch"}},"/api/v2/conversations/{conversationId}/recordingmetadata/{recordingId}":{"get":{"tags":["Recording"],"summary":"Get metadata for a specific recording. Does not return playable media.","description":"","operationId":"getConversationRecordingmetadataRecordingId","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"recordingId","in":"path","description":"Recording ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingMetadata"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.recording.view.permission.check.failed":"Failed to verify recording view permission.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","recording.recording.not.found":"Recording with recordingId was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:recording:view"]},"x-purecloud-method-name":"getConversationRecordingmetadataRecordingId"}},"/api/v2/quality/evaluations/query":{"get":{"tags":["Quality"],"summary":"Queries Evaluations and returns a paged list","description":"Query params must include one of conversationId, evaluatorUserId, or agentUserId","operationId":"getQualityEvaluationsQuery","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"conversationId","in":"query","description":"conversationId specified","required":false,"type":"string"},{"name":"agentUserId","in":"query","description":"user id of the agent","required":false,"type":"string"},{"name":"evaluatorUserId","in":"query","description":"evaluator user id","required":false,"type":"string"},{"name":"queueId","in":"query","description":"queue id","required":false,"type":"string"},{"name":"startTime","in":"query","description":"start time of the evaluation query","required":false,"type":"string"},{"name":"endTime","in":"query","description":"end time of the evaluation query","required":false,"type":"string"},{"name":"evaluationState","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"isReleased","in":"query","description":"the evaluation has been released","required":false,"type":"boolean"},{"name":"agentHasRead","in":"query","description":"agent has the evaluation","required":false,"type":"boolean"},{"name":"expandAnswerTotalScores","in":"query","description":"get the total scores for evaluations","required":false,"type":"boolean"},{"name":"maximum","in":"query","description":"maximum","required":false,"type":"integer","format":"int32"},{"name":"sortOrder","in":"query","description":"sort order options for agentUserId or evaluatorUserId query. Valid options are 'a', 'asc', 'ascending', 'd', 'desc', 'descending'","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.query.invalid.conversation":"Quality query has invalid conversation.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","quality.query.spec.one.of.agent.or.evaluator.or.conversation.or.team":"Quality query needs one agent, evaluator, conversation, agent team.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","quality.query.invalid.user":"User does not exist","quality.query.spec.one.of.agent.or.evaluator.or.conversation":"Quality query needs one agent, evaluator, or conversation.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.backend.service.timeout":"Backend service timeout","authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluation:view"]},"x-purecloud-method-name":"getQualityEvaluationsQuery"}},"/api/v2/users/{userId}/routinglanguages/bulk":{"patch":{"tags":["Routing","Users"],"summary":"Add bulk routing language to user. Max limit 50 languages","description":"","operationId":"patchUserRoutinglanguagesBulk","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Language","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/UserRoutingLanguagePost"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserLanguageEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:assign","routing:language:assign"]},"x-purecloud-method-name":"patchUserRoutinglanguagesBulk"}},"/api/v2/users/{userId}/routinglanguages":{"get":{"tags":["Routing","Users"],"summary":"List routing language for user","description":"","operationId":"getUserRoutinglanguages","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ASC","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserLanguageEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"User not found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getUserRoutinglanguages"},"post":{"tags":["Routing","Users"],"summary":"Add routing language to user","description":"","operationId":"postUserRoutinglanguages","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Language","required":true,"schema":{"$ref":"#/definitions/UserRoutingLanguagePost"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserRoutingLanguage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","general.conflict":"Conflict adding route language to user"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:assign","routing:language:assign"]},"x-purecloud-method-name":"postUserRoutinglanguages"}},"/api/v2/users/{userId}/routinglanguages/{languageId}":{"delete":{"tags":["Routing","Users"],"summary":"Remove routing language from user","description":"","operationId":"deleteUserRoutinglanguage","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"languageId","in":"path","description":"languageId","required":true,"type":"string"}],"responses":{"204":{"description":"Language removed"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Routing language was not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:assign","routing:language:assign"]},"x-purecloud-method-name":"deleteUserRoutinglanguage"},"patch":{"tags":["Routing","Users"],"summary":"Update routing language proficiency or state.","description":"","operationId":"patchUserRoutinglanguage","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"languageId","in":"path","description":"languageId","required":true,"type":"string"},{"in":"body","name":"body","description":"Language","required":true,"schema":{"$ref":"#/definitions/UserRoutingLanguage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserRoutingLanguage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Resource conflict - Unexpected version was provided","x-inin-error-codes":{"general.conflict":"The version supplied does not match the current version of the user"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:assign","routing:language:assign"]},"x-purecloud-method-name":"patchUserRoutinglanguage"}},"/api/v2/users/{userId}":{"get":{"tags":["Users"],"summary":"Get user.","description":"","operationId":"getUser","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"routingStatus"},{"name":"presence"},{"name":"conversationSummary"},{"name":"outOfOffice"},{"name":"geolocation"},{"name":"station"},{"name":"authorization"},{"name":"lasttokenissued"},{"name":"authorization.unusedRoles"},{"name":"team"},{"name":"profileSkills"},{"name":"certifications"},{"name":"locations"},{"name":"groups"},{"name":"skills"},{"name":"languages"},{"name":"languagePreference"},{"name":"employerInfo"},{"name":"biography"}]},{"name":"integrationPresenceSource","in":"query","description":"Gets an integration presence for a user instead of their default.","required":false,"type":"string","enum":["MicrosoftTeams","ZoomPhone","RingCentral"],"x-genesys-enum-members":[{"name":"MicrosoftTeams"},{"name":"ZoomPhone"},{"name":"RingCentral"}]},{"name":"state","in":"query","description":"Search for a user with this state","required":false,"type":"string","default":"active","enum":["active","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"deleted"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/User"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"Bad user request","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a user with that userId","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getUser"},"delete":{"tags":["Users"],"summary":"Delete user","description":"","operationId":"deleteUser","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","general.conflict":"Conflict deleting specified userId."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a user with that userId. ","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:delete"]},"x-purecloud-method-name":"deleteUser"},"patch":{"tags":["Users"],"summary":"Update user","description":"","operationId":"patchUser","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"User","required":true,"schema":{"$ref":"#/definitions/UpdateUser"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/User"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","general.conflict":"The version supplied does not match the current version of the user"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","insufficient.permissions":"Insufficient permissions to update a user"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a user with that userId.","not.found":"The requested resource was not found."}},"409":{"description":"Resource conflict - Unexpected version was provided","x-inin-error-codes":{"general.conflict":"The request could not be completed by the server due to a conflict."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:edit"]},"x-purecloud-method-name":"patchUser"}},"/api/v2/users/{userId}/invite":{"post":{"tags":["Users"],"summary":"Send an activation email to the user","description":"","operationId":"postUserInvite","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"force","in":"query","description":"Resend the invitation even if one is already outstanding","required":false,"type":"boolean","default":false}],"responses":{"204":{"description":"Invitation Sent"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","insufficient.permissions":"Insufficient permissions for sending an activation email."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:add"]},"x-purecloud-method-name":"postUserInvite"}},"/api/v2/outbound/messagingcampaigns":{"get":{"tags":["Outbound"],"summary":"Query a list of Messaging Campaigns","description":"","operationId":"getOutboundMessagingcampaigns","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"The field to sort by","required":false,"type":"string","default":"name","enum":["campaignStatus","name","type"],"x-genesys-enum-members":[{"name":"campaignStatus"},{"name":"name"},{"name":"type"}]},{"name":"sortOrder","in":"query","description":"The direction to sort","required":false,"type":"string","default":"ascending","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"contactListId","in":"query","description":"Contact List ID","required":false,"type":"string"},{"name":"divisionId","in":"query","description":"Division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"type","in":"query","description":"Campaign Type","required":false,"type":"string","enum":["SMS"],"x-genesys-enum-members":[{"name":"SMS"}]},{"name":"senderSmsPhoneNumber","in":"query","description":"Sender SMS Phone Number","required":false,"type":"string"},{"name":"id","in":"query","description":"A list of messaging campaign ids to bulk fetch","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingCampaignEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaign:view"]},"x-purecloud-method-name":"getOutboundMessagingcampaigns"},"post":{"tags":["Outbound"],"summary":"Create a Messaging Campaign","description":"","operationId":"postOutboundMessagingcampaigns","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Messaging Campaign","required":true,"schema":{"$ref":"#/definitions/MessagingCampaign"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingCampaign"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.length.exceeded":"The name length exceeds the limit of 64 characters","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.create":"An attempt was made to create an invalid messaging campaign. See details","duplicate.name":"The name is in use by another messaging campaign","callable.time.set.not.found":"The callable time set could not be found","contact.list.not.found":"The contact list could not be found","invalid.callable.time.set":"The provided callable time set is invalid","invalid.messages.per.minute":"Messages per minute must be provided, and must be an integer between 1 and the maximum allowable messages per minute (see documentation)","invalid.sender.sms.phone.number":"The sender sms phone number must be provided, and must be a valid reference to a short-code or non-NANP mobile or local SMS phone number","invalid.phone.column":"The phone column must be provided, and must be a valid column on the selected contact list","invalid.name":"A name must be provided","invalid.sms.content.template.contenttype":"The contentType of content template is not valid. It must be text/plain","sms.content.template.not.found":"The Content template could not be found","invalid.contact.list":"A valid contact list must be provided","contact.sort.duplicate.field.names":"Multiple Contact Sorts may not be applied to the same field","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","contact.sort.size.exceeded":"A maximum of 4 Contact Sorts may be configured","dnc.list.not.found":"One or more dnc lists could not be found","invalid.message.column":"The message column must be provided, and must be a valid column on the selected contact list","invalid.sms.content.template.responsetype":"The responseType of content template is not valid. It must be CampaignSmsTemplate","contact.sort.field.not.found":"One or more contact sort fields are not valid contact list columns","invalid.sms.config.message":"Only one of the messaging options should be set - messageColumn or contentTemplateId","dnc.list.count.exceeded":"A maximum of 10 dnc lists may be configured","invalid.dnc.list":"One or more DNC List references are invalid","max.entity.count.reached":"The maximum messaging campaign count has been reached","invalid.division":"A valid division must be provided","callable.time.set.conflicts.with.automatic.time.zone.mapping":"A callable time set cannot be included on the campaign when the campaign's contact list uses automatic time zone mapping.","sms.phone.number.not.found":"The SMS phone number could not be found","sms.content.template.not.authorized":"User doesn't have authorization to access content template","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","missing.time.zone.in.contactlist":"When using a callable time set, the contact list must have at least one time zone column defined.","contact.list.import.in.progress":"The contact list is still importing contacts","invalid.type.config":"Exactly one of [smsConfig] must be provided","invalid.sms.content.template.content":"The content of content template is blank"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The messaging campaign could not be found"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:messagingCampaign:add"]},"x-purecloud-method-name":"postOutboundMessagingcampaigns"}},"/api/v2/mobiledevices":{"get":{"tags":["Mobile Devices"],"summary":"Get a list of all devices.","description":"","operationId":"getMobiledevices","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ascending","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DirectoryUserDevicesListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["devices","devices:readonly"]}],"x-purecloud-method-name":"getMobiledevices"},"post":{"tags":["Mobile Devices"],"summary":"Create User device","description":"","operationId":"postMobiledevices","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Device","required":true,"schema":{"$ref":"#/definitions/UserDevice"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserDevice"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["devices"]}],"x-purecloud-method-name":"postMobiledevices"}},"/api/v2/authorization/divisions/limit":{"get":{"tags":["Authorization","Objects"],"summary":"Returns the maximum allowed number of divisions.","description":"","operationId":"getAuthorizationDivisionsLimit","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"type":"integer","format":"int32"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-purecloud-method-name":"getAuthorizationDivisionsLimit"}},"/api/v2/conversations/messaging/integrations/whatsapp/{integrationId}":{"get":{"tags":["Conversations"],"summary":"Get a WhatsApp messaging integration","description":"","operationId":"getConversationsMessagingIntegrationsWhatsappIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WhatsAppIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:view"]},"x-purecloud-method-name":"getConversationsMessagingIntegrationsWhatsappIntegrationId"},"delete":{"tags":["Conversations"],"summary":"Delete a WhatsApp messaging integration","description":"","operationId":"deleteConversationsMessagingIntegrationsWhatsappIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WhatsAppIntegration"}},"202":{"description":"Request Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:delete"]},"x-purecloud-method-name":"deleteConversationsMessagingIntegrationsWhatsappIntegrationId"},"patch":{"tags":["Conversations"],"summary":"Update or activate a WhatsApp messaging integration.","description":"The following steps are required in order to fully activate a Whatsapp Integration: Initially, you will need to get an activation code by sending: an action set to Activate, and an authenticationMethod choosing from Sms or Voice. Finally, once you have been informed of an activation code on selected authenticationMethod, you will need to confirm the code by sending: an action set to Confirm, and the confirmationCode you have received from Whatsapp.","operationId":"patchConversationsMessagingIntegrationsWhatsappIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"},{"in":"body","name":"body","description":"WhatsAppIntegrationUpdateRequest","required":true,"schema":{"$ref":"#/definitions/WhatsAppIntegrationUpdateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WhatsAppIntegration"}},"202":{"description":"Processing Request - If request was to Activate, do a GET checking for activationStatus set to CodeSent. \nIf request was to Confirm, do a GET checking for the integration status set to Active","schema":{"$ref":"#/definitions/WhatsAppIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wait.required":"User must wait for a specified amount of time before attempting multiple request to Activate WhatsApp messaging integration.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.integration":"The integration request was invalid for this operation. One or more errors may be reported.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:edit"]},"x-purecloud-method-name":"patchConversationsMessagingIntegrationsWhatsappIntegrationId"}},"/api/v2/uploads/publicassets/images":{"post":{"tags":["Uploads"],"summary":"Creates presigned url for uploading a public asset image","description":"","operationId":"postUploadsPublicassetsImages","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/UploadUrlRequest"}}],"responses":{"200":{"description":"Presigned url successfully created.","schema":{"$ref":"#/definitions/UploadUrlResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["upload"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["uploads:publicasset:upload"]},"x-purecloud-method-name":"postUploadsPublicassetsImages"}},"/api/v2/outbound/contactlistfilters":{"get":{"tags":["Outbound"],"summary":"Query Contact list filters","description":"","operationId":"getOutboundContactlistfilters","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"allowEmptyResult","in":"query","description":"Whether to return an empty page when there are no results for that page","required":false,"type":"boolean","default":false},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"],"x-genesys-enum-members":[{"name":"Equals"},{"name":"RegEx"},{"name":"Contains"},{"name":"Prefix"},{"name":"LessThan"},{"name":"LessThanEqualTo"},{"name":"GreaterThan"},{"name":"GreaterThanEqualTo"},{"name":"BeginsWith"},{"name":"EndsWith"}]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]},{"name":"contactListId","in":"query","description":"Contact List ID","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListFilterEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactListFilter:view"]},"x-purecloud-method-name":"getOutboundContactlistfilters"},"post":{"tags":["Outbound"],"summary":"Create Contact List Filter","description":"","operationId":"postOutboundContactlistfilters","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ContactListFilter","required":true,"schema":{"$ref":"#/definitions/ContactListFilter"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListFilter"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"operator.required":"Could not update the contact list filter because the operator field was empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","contact.list.not.found":"Could not create the contact list filter because the contact list could not be found.","filter.type.required.for.multiple.predicates":"Could not update the contact list filter because the filter type on a clause is required if there are multiple predicates.","filter.type.required.for.multiple.clauses":"Could not update the contact list filter because the filter type is required if there are multiple clauses.","at.least.one.predicate.required":"Could not update the contact list filter because each clause must contain at least one predicate.","value.required":"Could not update the contact list filter because the value field on a predicate was empty and required for that predicate's operator.","range.max.required":"Could not update the contact list filter because the range max field is required for Between operator.","value.did.not.match.column.type":"Could not update the contact list filter because the predicate value field did not match the column type.","value.exceeds.max.digits":"The maximum number of digits for the value on a predicate with a numeric operator has been exceeded.","max.less.than.min":"Could not update the contact list filter because the predicate range max value is less than the min value.","min.did.not.match.column.type":"Could not update the contact list filter because the predicate range min field did not match the column type.","value.exceeds.max.decimal.places":"The maximum number of decimal places in the value on a predicate with a numeric operator has been exceeded.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","column.does.not.match.contact.list":"Could not update the contact list filter because the column on a predicate did not match a column on the selected contact list.","range.required":"Could not update the contact list filter because the range field was empty and is required for Between and In operators.","max.predicates.contains.exceeded":"Could not create the contact list filter because the maximum number of predicates with CONTAINS operators has been exceeded.","contact.list.cannot.be.blank":"Could not create the contact list filter because the contact list field was blank.","invalid.date.value":"Could not update the contact list filter because the value field on the predicate is not a valid date.","clauses.required":"Could not update the contact list filter because the clauses field is required to contain at least one clause.","max.did.not.match.column.type":"Could not update the contact list filter because the predicate range max field did not match the column type.","column.required":"Could not update the contact list filter because the column field was empty on a predicate.","max.entity.count.reached":"The maximum contact list filter count has been reached.","max.predicates.exceeded":"Could not create the contact list filter because the maximum number of predicates has been exceeded.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","range.set.required":"Could not update the contact list filter because the range set field is required for In operator.","range.min.required":"Could not update the contact list filter because the range min field is required for Between operator."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactListFilter:add"]},"x-purecloud-method-name":"postOutboundContactlistfilters"}},"/api/v2/voicemail/queues/{queueId}/messages":{"get":{"tags":["Voicemail"],"summary":"List voicemail messages","description":"","operationId":"getVoicemailQueueMessages","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMessageEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["voicemail:acdVoicemail:view"]},"x-purecloud-method-name":"getVoicemailQueueMessages"}},"/api/v2/greetings/{greetingId}/media":{"get":{"tags":["Greetings"],"summary":"Get media playback URI for this greeting","description":"","operationId":"getGreetingMedia","produces":["application/json"],"parameters":[{"name":"greetingId","in":"path","description":"Greeting ID","required":true,"type":"string"},{"name":"formatId","in":"query","description":"The desired media format.","required":false,"type":"string","default":"WAV","enum":["WAV","WEBM","WAV_ULAW","OGG_VORBIS","OGG_OPUS","MP3","NONE"],"x-genesys-enum-members":[{"name":"WAV"},{"name":"WEBM"},{"name":"WAV_ULAW"},{"name":"OGG_VORBIS"},{"name":"OGG_OPUS"},{"name":"MP3"},{"name":"NONE"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GreetingMediaInfo"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings","greetings:readonly"]}],"x-purecloud-method-name":"getGreetingMedia"}},"/api/v2/voicemail/userpolicies/{userId}":{"get":{"tags":["Voicemail"],"summary":"Get a user's voicemail policy","description":"","operationId":"getVoicemailUserpolicy","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailUserPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"voicemailservice.user.usernotfound":"The specified voicemail user not found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-purecloud-method-name":"getVoicemailUserpolicy"},"patch":{"tags":["Voicemail"],"summary":"Update a user's voicemail policy","description":"","operationId":"patchVoicemailUserpolicy","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The user's voicemail policy","required":true,"schema":{"$ref":"#/definitions/VoicemailUserPolicy"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailUserPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail"]}],"x-purecloud-method-name":"patchVoicemailUserpolicy"}},"/api/v2/telephony/providers/edges/edgegroups/{edgegroupId}/edgetrunkbases/{edgetrunkbaseId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Gets the edge trunk base associated with the edge group","description":"","operationId":"getTelephonyProvidersEdgesEdgegroupEdgetrunkbase","produces":["application/json"],"parameters":[{"name":"edgegroupId","in":"path","description":"Edge Group ID","required":true,"type":"string"},{"name":"edgetrunkbaseId","in":"path","description":"Edge Trunk Base ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeTrunkBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesEdgegroupEdgetrunkbase"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update the edge trunk base associated with the edge group","description":"","operationId":"putTelephonyProvidersEdgesEdgegroupEdgetrunkbase","produces":["application/json"],"parameters":[{"name":"edgegroupId","in":"path","description":"Edge Group ID","required":true,"type":"string"},{"name":"edgetrunkbaseId","in":"path","description":"Edge Trunk Base ID","required":true,"type":"string"},{"in":"body","name":"body","description":"EdgeTrunkBase","required":true,"schema":{"$ref":"#/definitions/EdgeTrunkBase"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeTrunkBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesEdgegroupEdgetrunkbase"}},"/api/v2/tokens/{userId}":{"delete":{"tags":["Tokens"],"summary":"Delete all auth tokens for the specified user.","description":"","operationId":"deleteToken","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Missing required division permission","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["user-basic-info"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:token:delete"]},"x-purecloud-method-name":"deleteToken"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}":{"get":{"tags":["Workforce Management"],"summary":"Deprecated. Use the equivalent business unit resource instead. Get a week schedule","description":"","operationId":"getWorkforcemanagementManagementunitWeekSchedule","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format.","required":true,"type":"string"},{"name":"scheduleId","in":"path","description":"The ID of the schedule to fetch","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"string","enum":["generationResults","headcountForecast"],"x-genesys-enum-members":[{"name":"generationResults"},{"name":"headcountForecast"}]},{"name":"forceDownloadService","in":"query","description":"Force the result of this operation to be sent via download service. For testing/app development purposes","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WeekScheduleResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:publishedSchedule:view","wfm:schedule:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitWeekSchedule"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules":{"get":{"tags":["Workforce Management"],"summary":"Deprecated. Use the equivalent business unit resource instead. Get the list of schedules in a week in management unit","description":"","operationId":"getWorkforcemanagementManagementunitWeekSchedules","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format.","required":true,"type":"string"},{"name":"includeOnlyPublished","in":"query","description":"Return only published schedules","required":false,"type":"boolean"},{"name":"earliestWeekDate","in":"query","description":"The start date of the earliest week to query in yyyy-MM-dd format","required":false,"type":"string"},{"name":"latestWeekDate","in":"query","description":"The start date of the latest week to query in yyyy-MM-dd format","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WeekScheduleListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:publishedSchedule:view","wfm:schedule:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitWeekSchedules"}},"/api/v2/workforcemanagement/businessunits/divisionviews":{"get":{"tags":["Workforce Management"],"summary":"Get business units across divisions","description":"","operationId":"getWorkforcemanagementBusinessunitsDivisionviews","produces":["application/json"],"parameters":[{"name":"divisionId","in":"query","description":"The divisionIds to filter by. If omitted, will return business units in all divisions","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BusinessUnitListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:businessUnit:search"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitsDivisionviews"}},"/api/v2/users/{userId}/profile":{"get":{"tags":["Users"],"summary":"Get user profile","description":"This api has been deprecated. Use api/v2/users instead","operationId":"getUserProfile","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"userId","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"routingStatus"},{"name":"presence"},{"name":"conversationSummary"},{"name":"outOfOffice"},{"name":"geolocation"},{"name":"station"},{"name":"authorization"},{"name":"lasttokenissued"},{"name":"authorization.unusedRoles"},{"name":"team"}]},{"name":"integrationPresenceSource","in":"query","description":"Gets an integration presence for a user instead of their default.","required":false,"type":"string","enum":["MicrosoftTeams","ZoomPhone","RingCentral"],"x-genesys-enum-members":[{"name":"MicrosoftTeams"},{"name":"ZoomPhone"},{"name":"RingCentral"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserProfile"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find the user profile","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getUserProfile"}},"/api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId}":{"get":{"tags":["Quality"],"summary":"Get an evaluation","description":"","operationId":"getQualityConversationEvaluation","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"evaluationId","in":"path","description":"evaluationId","required":true,"type":"string"},{"name":"expand","in":"query","description":"agent, evaluator, evaluationForm","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Evaluation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","quality.evaluation.view.permission.check.failed":"Failed to check required view permission.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluation:view"]},"x-purecloud-method-name":"getQualityConversationEvaluation"},"put":{"tags":["Quality"],"summary":"Update an evaluation","description":"The quality:evaluation:edit permission allows modification of most fields, while the quality:evaluation:editScore permission allows an evaluator to change just the question scores, and the quality:evaluation:editAgentSignoff permission allows an agent to change the agent comments and sign off on the evaluation.","operationId":"putQualityConversationEvaluation","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"evaluationId","in":"path","description":"evaluationId","required":true,"type":"string"},{"in":"body","name":"body","description":"evaluation","required":true,"schema":{"$ref":"#/definitions/Evaluation"}},{"name":"expand","in":"query","description":"evaluatorId","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Evaluation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.evaluation.evaluator.doesnt.exist":"Evaluator doesn't exist","quality.scoring.unanswered.required.questions":"Submitted answers did not contain a response to a required question","quality.evaluation.cannot.change.evaluation.form":"Cannot change evaluation form","quality.evaluation.cannot.change.conversation":"Cannot change conversation","bad.request":"The request could not be understood by the server due to malformed syntax.","quality.scoring.question.not.in.evaluation.form":"Submitted answers contained reference to a question which is not in the evaluation form","quality.evaluation.cannot.change.evaluationid":"Cannot change evaluationId","quality.scoring.unanswered.required.comments":"Submitted answers did not contain a comment where it was required","qm.evaluation.create.error.no.agent":"Need an agent user on the conversation to create an evaluation","quality.evaluation.calibration.and.release.date.both.set":"Calibration and release date both set","quality.evaluation.invalid.state.non.pending.to.pending":"Invalid state, non pending to pending","quality.evaluation.cannot.change.calibration":"Cannot change calibration","quality.evaluation.agent.doesnt.exist":"Agent doesn't exist","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","quality.evaluation.required.answers.for.state":"Answers are required for state","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","quality.scoring.answer.not.in.evaluation.form":"Submitted answers contained reference to an answer which is not in the evaluation form","quality.evaluation.evaluator.not.quality.evaluator":"evaluator does not have edit score permission","quality.scoring.question.group.not.in.evaluation.form":"Submitted answers contained reference to a question group which is not in the evaluation form","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","quality.evaluation.too.old.to.score":"Evaluation is too old to score"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.evaluation.update.permission.check.failed":"Missing evaluation update permission","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.evaluation.no.answer.for.state":"No answers for state","quality.evaluation.form.doesnt.exist":"Evaluation form doesn't exist","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluation:edit","quality:evaluation:editScore","quality:evaluation:editAgentSignoff"]},"x-purecloud-method-name":"putQualityConversationEvaluation"},"delete":{"tags":["Quality"],"summary":"Delete an evaluation","description":"","operationId":"deleteQualityConversationEvaluation","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"evaluationId","in":"path","description":"evaluationId","required":true,"type":"string"},{"name":"expand","in":"query","description":"evaluatorId","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Evaluation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","quality.evaluation.delete.permission.check.failed":"Failed evaluation deletion permission check"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.evaluation.form.doesnt.exist":"Evaluation form doesn't exist","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluation:delete"]},"x-purecloud-method-name":"deleteQualityConversationEvaluation"}},"/api/v2/audits/query":{"post":{"tags":["Audit"],"summary":"Create audit query execution","description":"","operationId":"postAuditsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/AuditQueryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuditQueryExecutionStatusResponse"}},"202":{"description":"Accepted - Query execution is accepted.","schema":{"$ref":"#/definitions/AuditQueryExecutionStatusResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["audits:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["audits:audit:view"]},"x-purecloud-method-name":"postAuditsQuery"}},"/api/v2/audits/query/realtime":{"post":{"tags":["Audit"],"summary":"This endpoint will only retrieve 7 days worth of audits for certain services. Please use /query to get a full list and older audits.","description":"","operationId":"postAuditsQueryRealtime","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/AuditRealtimeQueryRequest"}},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["user"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"user"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuditRealtimeQueryResultsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["audits:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["audits:audit:view"]},"x-purecloud-method-name":"postAuditsQueryRealtime"}},"/api/v2/audits/query/{transactionId}":{"get":{"tags":["Audit"],"summary":"Get status of audit query execution","description":"","operationId":"getAuditsQueryTransactionId","produces":["application/json"],"parameters":[{"name":"transactionId","in":"path","description":"Transaction ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuditQueryExecutionStatusResponse"}},"202":{"description":"In progress - Query execution is in progress.","schema":{"$ref":"#/definitions/AuditQueryExecutionStatusResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["audits:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["audits:audit:view"]},"x-purecloud-method-name":"getAuditsQueryTransactionId"}},"/api/v2/audits/query/{transactionId}/results":{"get":{"tags":["Audit"],"summary":"Get results of audit query","description":"","operationId":"getAuditsQueryTransactionIdResults","produces":["application/json"],"parameters":[{"name":"transactionId","in":"path","description":"Transaction ID","required":true,"type":"string"},{"name":"cursor","in":"query","description":"Indicates where to resume query results (not required for first page)","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["user"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"user"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuditQueryExecutionResultsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["audits:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["audits:audit:view"]},"x-purecloud-method-name":"getAuditsQueryTransactionIdResults"}},"/api/v2/audits/query/servicemapping":{"get":{"tags":["Audit"],"summary":"Get service mapping information used in audits.","description":"","operationId":"getAuditsQueryServicemapping","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuditQueryServiceMapping"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["audits:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["audits:audit:view"]},"x-purecloud-method-name":"getAuditsQueryServicemapping"}},"/api/v2/audits/query/realtime/servicemapping":{"get":{"tags":["Audit"],"summary":"Get service mapping information used in realtime audits.","description":"","operationId":"getAuditsQueryRealtimeServicemapping","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuditQueryServiceMapping"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["audits:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["audits:audit:view"]},"x-purecloud-method-name":"getAuditsQueryRealtimeServicemapping"}},"/api/v2/notifications/channels/{channelId}/subscriptions":{"get":{"tags":["Notifications"],"summary":"The list of all subscriptions for this channel","description":"","operationId":"getNotificationsChannelSubscriptions","produces":["application/json"],"parameters":[{"name":"channelId","in":"path","description":"Channel ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChannelTopicEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["notifications"]}],"x-purecloud-method-name":"getNotificationsChannelSubscriptions"},"post":{"tags":["Notifications"],"summary":"Add a list of subscriptions to the existing list of subscriptions","description":"","operationId":"postNotificationsChannelSubscriptions","produces":["application/json"],"parameters":[{"name":"channelId","in":"path","description":"Channel ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Body","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/ChannelTopic"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChannelTopicEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"notification.subscription.too.many.subscriptions":"Too many subscriptions","notification.invalid.topic":"The subscription topic is not valid.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","notification.unable.to.get.channel.id":"Unable to get channel Id.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","notification.unauthorized.topic":"Not authorized for this topic.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["notifications"]}],"x-purecloud-method-name":"postNotificationsChannelSubscriptions"},"put":{"tags":["Notifications"],"summary":"Replace the current list of subscriptions with a new list.","description":"","operationId":"putNotificationsChannelSubscriptions","produces":["application/json"],"parameters":[{"name":"channelId","in":"path","description":"Channel ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Body","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/ChannelTopic"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChannelTopicEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"notification.subscription.too.many.subscriptions":"Too many subscriptions.","notification.invalid.topic":"The subscription topic is not valid.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","notification.unable.to.get.channel.id":"Unable to get channel id.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","notification.unauthorized.topic":"Not authorized for this topic.","notification.forbidden.topic":"Topic is forbidden","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"The service is currently unavailable."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["notifications"]}],"x-purecloud-method-name":"putNotificationsChannelSubscriptions"},"delete":{"tags":["Notifications"],"summary":"Remove all subscriptions","description":"","operationId":"deleteNotificationsChannelSubscriptions","produces":["application/json"],"parameters":[{"name":"channelId","in":"path","description":"Channel ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["notifications"]}],"x-purecloud-method-name":"deleteNotificationsChannelSubscriptions"}},"/api/v2/alerting/interactionstats/alerts/{alertId}":{"get":{"tags":["Alerting"],"summary":"Get an interaction stats alert","description":"","operationId":"getAlertingInteractionstatsAlert","produces":["application/json"],"parameters":[{"name":"alertId","in":"path","description":"Alert ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["notificationUsers"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"notificationUsers"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InteractionStatsAlert"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting","alerting:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:alert:view"]},"x-purecloud-method-name":"getAlertingInteractionstatsAlert"},"put":{"tags":["Alerting"],"summary":"Update an interaction stats alert read status","description":"","operationId":"putAlertingInteractionstatsAlert","produces":["application/json"],"parameters":[{"name":"alertId","in":"path","description":"Alert ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["notificationUsers"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"notificationUsers"}]},{"in":"body","name":"body","description":"InteractionStatsAlert","required":true,"schema":{"$ref":"#/definitions/UnreadStatus"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UnreadStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:alert:edit"]},"x-purecloud-method-name":"putAlertingInteractionstatsAlert"},"delete":{"tags":["Alerting"],"summary":"Delete an interaction stats alert","description":"","operationId":"deleteAlertingInteractionstatsAlert","produces":["application/json"],"parameters":[{"name":"alertId","in":"path","description":"Alert ID","required":true,"type":"string"}],"responses":{"204":{"description":"Interaction stats alert deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:alert:delete"]},"x-purecloud-method-name":"deleteAlertingInteractionstatsAlert"}},"/api/v2/conversations/messaging/integrations":{"get":{"tags":["Conversations"],"summary":"Get a list of Integrations","description":"","operationId":"getConversationsMessagingIntegrations","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingIntegrationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:view"]},"x-purecloud-method-name":"getConversationsMessagingIntegrations"}},"/api/v2/dataextensions/coretypes/{coretypeName}":{"get":{"tags":["Data Extensions"],"summary":"Get a specific named core type.","description":"","operationId":"getDataextensionsCoretype","produces":["application/json"],"parameters":[{"name":"coretypeName","in":"path","description":"The core type's name","required":true,"type":"string","enum":["text","longtext","url","identifier","enum","date","datetime","integer","number","checkbox","tag"],"x-genesys-enum-members":[{"name":"text"},{"name":"longtext"},{"name":"url"},{"name":"identifier"},{"name":"enum"},{"name":"date"},{"name":"datetime"},{"name":"integer"},{"name":"number"},{"name":"checkbox"},{"name":"tag"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Coretype"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["data-extensions"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getDataextensionsCoretype"}},"/api/v2/recording/crossplatform/mediaretentionpolicies":{"get":{"tags":["Recording"],"summary":"Gets media retention policy list with query options to filter on name and enabled.","description":"for a less verbose response, add summary=true to this endpoint","operationId":"getRecordingCrossplatformMediaretentionpolicies","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"name","in":"query","description":"the policy name - used for filtering results in searches.","required":false,"type":"string"},{"name":"enabled","in":"query","description":"checks to see if policy is enabled - use enabled = true or enabled = false","required":false,"type":"boolean"},{"name":"summary","in":"query","description":"provides a less verbose response of policy lists.","required":false,"type":"boolean","default":false},{"name":"hasErrors","in":"query","description":"provides a way to fetch all policies with errors or policies that do not have errors","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PolicyEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:crossPlatformRetentionPolicy:view"]},"x-purecloud-method-name":"getRecordingCrossplatformMediaretentionpolicies"},"post":{"tags":["Recording"],"summary":"Create media retention policy","description":"","operationId":"postRecordingCrossplatformMediaretentionpolicies","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Policy","required":true,"schema":{"$ref":"#/definitions/CrossPlatformPolicyCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CrossPlatformPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.policy.assign.metered.evaluation.evaluator.permission.check.failed":"evaluator permission failure for metered evaluation","recording.media.policy.invalid":"One of the configured actions or conditions was invalid.","recording.policy.calibrator.permission.fail":"General calibrator permission failure","recording.policy.export.integration.disabled":"The specified export integration is not in active state.","recording.policy.invalid.queue":"The specified queues was invalid.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","recording.policy.assign.evaluation.evaluator.permission.check.failed":"evaluator permission failure for evaluation","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","recording.policy.assign.calibration.evaluator.permission.check.failed":"Calibrator permission failure","recording.policy.export.integration.invalid":"The specified export integration is not a valid integration.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:crossPlatformRetentionPolicy:add"]},"x-purecloud-method-name":"postRecordingCrossplatformMediaretentionpolicies"},"delete":{"tags":["Recording"],"summary":"Delete media retention policies","description":"Bulk delete of media retention policies, this will only delete the polices that match the ids specified in the query param.","operationId":"deleteRecordingCrossplatformMediaretentionpolicies","produces":["application/json"],"parameters":[{"name":"ids","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:crossPlatformRetentionPolicy:delete"]},"x-purecloud-method-name":"deleteRecordingCrossplatformMediaretentionpolicies"}},"/api/v2/journey/actionmaps":{"get":{"tags":["Journey"],"summary":"Retrieve all action maps.","description":"","operationId":"getJourneyActionmaps","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Field(s) to sort by. Prefix with '-' for descending (e.g. sortBy=displayName,-createdDate).","required":false,"type":"string"},{"name":"filterField","in":"query","description":"Field to filter by (e.g. filterField=weight or filterField=action.actionTemplate.id). Requires 'filterField' to also be set.","required":false,"type":"string"},{"name":"filterValue","in":"query","description":"Value to filter by. Requires 'filterValue' to also be set.","required":false,"type":"string"},{"name":"actionMapIds","in":"query","description":"IDs of action maps to return. Use of this parameter is not compatible with pagination, filtering or sorting. A maximum of 100 action maps are allowed per request.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionMapListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actionmap:view"]},"x-purecloud-method-name":"getJourneyActionmaps"},"post":{"tags":["Journey"],"summary":"Create an action map.","description":"","operationId":"postJourneyActionmaps","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ActionMap"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionMap"}},"201":{"description":"Action map created.","schema":{"$ref":"#/definitions/ActionMap"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actionmap:add"]},"x-purecloud-method-name":"postJourneyActionmaps"}},"/api/v2/quality/publishedforms/evaluations/{formId}":{"get":{"tags":["Quality"],"summary":"Get the most recent published version of an evaluation form.","description":"","operationId":"getQualityPublishedformsEvaluation","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:view"]},"x-purecloud-method-name":"getQualityPublishedformsEvaluation"}},"/api/v2/integrations/speech/tts/settings":{"get":{"tags":["Integrations"],"summary":"Get TTS settings for an org","description":"","operationId":"getIntegrationsSpeechTtsSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TtsSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechTtsSettings"},"put":{"tags":["Integrations"],"summary":"Update TTS settings for an org","description":"","operationId":"putIntegrationsSpeechTtsSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Updated TtsSettings","required":true,"schema":{"$ref":"#/definitions/TtsSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TtsSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:edit"]},"x-purecloud-method-name":"putIntegrationsSpeechTtsSettings"}},"/api/v2/recording/localkeys/settings":{"get":{"tags":["Recording"],"summary":"gets a list local key settings data","description":"","operationId":"getRecordingLocalkeysSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LocalEncryptionConfigurationListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:encryptionKey:view"]},"x-purecloud-method-name":"getRecordingLocalkeysSettings"},"post":{"tags":["Recording"],"summary":"create settings for local key creation","description":"","operationId":"postRecordingLocalkeysSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Local Encryption Configuration","required":true,"schema":{"$ref":"#/definitions/LocalEncryptionConfiguration"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LocalEncryptionConfiguration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:encryptionKey:edit"]},"x-purecloud-method-name":"postRecordingLocalkeysSettings"}},"/api/v2/telephony/providers/edges/dids/{didId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a DID by ID.","description":"","operationId":"getTelephonyProvidersEdgesDid","produces":["application/json"],"parameters":[{"name":"didId","in":"path","description":"DID ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DID"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesDid"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a DID by ID.","description":"","operationId":"putTelephonyProvidersEdgesDid","produces":["application/json"],"parameters":[{"name":"didId","in":"path","description":"DID ID","required":true,"type":"string"},{"in":"body","name":"body","description":"DID","required":true,"schema":{"$ref":"#/definitions/DID"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DID"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesDid"}},"/api/v2/userrecordings/{recordingId}/media":{"get":{"tags":["User Recordings"],"summary":"Download a user recording.","description":"","operationId":"getUserrecordingMedia","produces":["application/json"],"parameters":[{"name":"recordingId","in":"path","description":"User Recording ID","required":true,"type":"string"},{"name":"formatId","in":"query","description":"The desired media format.","required":false,"type":"string","default":"WEBM","enum":["WAV","WEBM","WAV_ULAW","OGG_VORBIS","OGG_OPUS","MP3","NONE"],"x-genesys-enum-members":[{"name":"WAV"},{"name":"WEBM"},{"name":"WAV_ULAW"},{"name":"OGG_VORBIS"},{"name":"OGG_OPUS"},{"name":"MP3"},{"name":"NONE"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DownloadResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["user-recordings","user-recordings:readonly"]}],"x-purecloud-method-name":"getUserrecordingMedia"}},"/api/v2/dataextensions/coretypes":{"get":{"tags":["Data Extensions"],"summary":"Get the core types from which all schemas are built.","description":"","operationId":"getDataextensionsCoretypes","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CoretypeListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["data-extensions"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getDataextensionsCoretypes"}},"/api/v2/authorization/divisions/{divisionId}/grants":{"get":{"tags":["Authorization"],"summary":"Gets all grants for a given division.","description":"Returns all grants assigned to a given division. Maximum page size is 500.","operationId":"getAuthorizationDivisionGrants","produces":["application/json"],"parameters":[{"name":"divisionId","in":"path","description":"Division ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuthzDivisionGrantEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:view"]},"x-purecloud-method-name":"getAuthorizationDivisionGrants"}},"/api/v2/systempresences":{"get":{"tags":["Presence"],"summary":"Get the list of SystemPresences","description":"","operationId":"getSystempresences","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/SystemPresence"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence","presence:readonly"]}],"x-purecloud-method-name":"getSystempresences"}},"/api/v2/organizations/me":{"get":{"tags":["Organization"],"summary":"Get organization.","description":"","operationId":"getOrganizationsMe","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Organization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-purecloud-method-name":"getOrganizationsMe"},"put":{"tags":["Organization"],"summary":"Update organization.","description":"","operationId":"putOrganizationsMe","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Organization","required":false,"schema":{"$ref":"#/definitions/Organization"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Organization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Resource conflict - Unexpected version was provided","x-inin-error-codes":{"general.conflict":"The version supplied does not match the current version of the user"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:organization:admin"]},"x-purecloud-method-name":"putOrganizationsMe"}},"/api/v2/textbots/bots/execute":{"post":{"tags":["Textbots"],"summary":"Send an intent to a bot to start a dialog/interact with it via text","description":"This will either start a bot with the given id or relay a communication to an existing bot session.","operationId":"postTextbotsBotsExecute","produces":["application/json"],"parameters":[{"in":"body","name":"postTextRequest","required":true,"schema":{"$ref":"#/definitions/PostTextRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PostTextResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bots.invalid.bot.product":"The bot product type is unrecognized","bots.invalid.bot.argument":"An argument passed on to the bot was declared invalid by the bot service","bad.request":"The request could not be understood by the server due to malformed syntax.","bots.bot.general.provider.failure":"A general provider failure was detected","bots.syntax.error":"There was an error parsing user data","bots.bot.circuit.open":"The bot service is non responsive and we're in a back-off state until the service is restored.","bots.invalid.bot.vendor":"The bot vendor type is unrecognized","bots.bot.doesnt.exist":"This occurs if the service doesn't recognize the bot that the integration code specifies","bots.bot.session.closed":"The bot session is already closed and cannot be reused","bots.unsupported.integration.type":"The integration type is unsupported or not recognized","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","bots.unsupported.language":"The language code is unsupported or not recognized","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","bots.invalid.bot.session.outcome":"The bot outcome is not recognized","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bots.access.denied":"User doesn't have access to bot","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bots.too.many.calls":"Your operation has failed because you've sent too many calls of this type too quickly.","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bots.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","bots.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["textbots"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["textbots:session:execute"]},"x-purecloud-method-name":"postTextbotsBotsExecute"}},"/api/v2/license/users":{"get":{"tags":["License"],"summary":"Get a page of users and their licenses","description":"Retrieve a page of users in an organization along with the licenses they possess.","operationId":"getLicenseUsers","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserLicensesEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["license","license:readonly"]}],"x-purecloud-method-name":"getLicenseUsers"},"post":{"tags":["License"],"summary":"Fetch user licenses in a batch.","description":"","operationId":"postLicenseUsers","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The user IDs to fetch.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["license","license:readonly"]}],"x-purecloud-method-name":"postLicenseUsers"}},"/api/v2/analytics/reporting/exports":{"get":{"tags":["Analytics"],"summary":"Get all view export requests for a user","description":"","operationId":"getAnalyticsReportingExports","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportingExportJobListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["analytics:dataExport:view"]},"x-purecloud-method-name":"getAnalyticsReportingExports"},"post":{"tags":["Analytics"],"summary":"Generate a view export request","description":"This API creates a reporting export but the desired way to export analytics data is to use the analytics query APIs instead","operationId":"postAnalyticsReportingExports","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ReportingExportJobRequest","required":true,"schema":{"$ref":"#/definitions/ReportingExportJobRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportingExportJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"Bad user request","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden to generate a view export request."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["analytics:dataExport:add"]},"x-purecloud-method-name":"postAnalyticsReportingExports"}},"/api/v2/speechandtextanalytics/programs/publishjobs/{jobId}":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get a Speech & Text Analytics publish programs job by id","description":"","operationId":"getSpeechandtextanalyticsProgramsPublishjob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"The id of the publish programs job","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ProgramJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"job.not.found":"The requested job could not be found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:publish"]},"x-purecloud-method-name":"getSpeechandtextanalyticsProgramsPublishjob"}},"/api/v2/outbound/campaigns/{campaignId}/callback/schedule":{"post":{"tags":["Outbound"],"summary":"Schedule a Callback for a Dialer Campaign (Deprecated)","description":"This endpoint is deprecated and may have unexpected results. Please use \"/conversations/{conversationId}/participants/{participantId}/callbacks instead.\"","operationId":"postOutboundCampaignCallbackSchedule","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ContactCallbackRequest","required":true,"schema":{"$ref":"#/definitions/ContactCallbackRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactCallbackRequest"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","schedule.cannot.be.blank":"The schedule cannot be blank.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","contact.cannot.be.blank":"The contact cannot be blank.","contact.list.cannot.be.blank":"The contact list cannot be blank.","invalid.contact.phone.column":"The contact phone columns are invalid.","invalid.schedule.format":"The schedule format is invalid.","callback.schedule.invalid":"The callback schedule is not valid.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The dialer campaign was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","callback.scheduling.error":""}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"deprecated":true,"x-purecloud-method-name":"postOutboundCampaignCallbackSchedule"}},"/api/v2/telephony/providers/edges/linebasesettings/{lineBaseId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a line base settings object by ID","description":"","operationId":"getTelephonyProvidersEdgesLinebasesetting","produces":["application/json"],"parameters":[{"name":"lineBaseId","in":"path","description":"Line base ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LineBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a line with that id","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesLinebasesetting"}},"/api/v2/outbound/campaigns/progress":{"post":{"tags":["Outbound"],"summary":"Get progress for a list of campaigns","description":"","operationId":"postOutboundCampaignsProgress","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Campaign IDs","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/CampaignProgress"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"callback.error.missing.callback.numbers":"Callback numbers missing","callback.error.missing.queue.id":"Callback missing queue ID","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:view"]},"x-purecloud-method-name":"postOutboundCampaignsProgress"}},"/api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId}":{"get":{"tags":["Recording"],"summary":"Get annotation","description":"","operationId":"getConversationRecordingAnnotation","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"recordingId","in":"path","description":"Recording ID","required":true,"type":"string"},{"name":"annotationId","in":"path","description":"Annotation ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Annotation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","recording.annotation.view.permission.check.failed":"Failed to verify view annotation permission"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","recording.annotation.not.found":"The recording annotation was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:annotation:view"]},"x-purecloud-method-name":"getConversationRecordingAnnotation"},"put":{"tags":["Recording"],"summary":"Update annotation","description":"","operationId":"putConversationRecordingAnnotation","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"recordingId","in":"path","description":"Recording ID","required":true,"type":"string"},{"name":"annotationId","in":"path","description":"Annotation ID","required":true,"type":"string"},{"in":"body","name":"body","description":"annotation","required":true,"schema":{"$ref":"#/definitions/Annotation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Annotation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","recording.invalid.json":"Request contains invalid JSON.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.recording.view.permission.check.failed":"Failed to verify recording view permission.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","recording.annotation.update.permission.check.failed":"Failed to verify recording update permission."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:annotation:edit"]},"x-purecloud-method-name":"putConversationRecordingAnnotation"},"delete":{"tags":["Recording"],"summary":"Delete annotation","description":"","operationId":"deleteConversationRecordingAnnotation","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"recordingId","in":"path","description":"Recording ID","required":true,"type":"string"},{"name":"annotationId","in":"path","description":"Annotation ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.annotation.cant.delete.for.another.user":"Can't delete a recording annotation for another user.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","recording.annotation.delete.permission.check.failed":"Failed to verify recording delete permission."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:annotation:delete"]},"x-purecloud-method-name":"deleteConversationRecordingAnnotation"}},"/api/v2/outbound/campaigns/all/divisionviews":{"get":{"tags":["Outbound"],"summary":"Query across all types of campaigns","description":"","operationId":"getOutboundCampaignsAllDivisionviews","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"id","in":"query","description":"Campaign ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Campaign name(s)","required":false,"type":"string"},{"name":"divisionId","in":"query","description":"Division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"mediaType","in":"query","description":"Media type(s)","required":false,"type":"array","items":{"type":"string","enum":["sms","voice"],"x-genesys-enum-members":[{"name":"sms"},{"name":"voice"}]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"sms"},{"name":"voice"}]},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CommonCampaignDivisionViewEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.filter.field":"Invalid query parameter supplied for filtering.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:search","outbound:messagingCampaign:search"]},"x-purecloud-method-name":"getOutboundCampaignsAllDivisionviews"}},"/api/v2/widgets/deployments/{deploymentId}":{"get":{"tags":["Widgets"],"summary":"Get a Widget deployment","description":"","operationId":"getWidgetsDeployment","produces":["application/json"],"parameters":[{"name":"deploymentId","in":"path","description":"Widget Config Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WidgetDeployment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["widgets","widgets:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["widgets:deployment:view","webchat:deployment:read"]},"x-purecloud-method-name":"getWidgetsDeployment"},"put":{"tags":["Widgets"],"summary":"Update a Widget deployment","description":"","operationId":"putWidgetsDeployment","produces":["application/json"],"parameters":[{"name":"deploymentId","in":"path","description":"Widget Config Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Deployment","required":true,"schema":{"$ref":"#/definitions/WidgetDeployment"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WidgetDeployment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["widgets"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["widgets:deployment:edit","webchat:deployment:update"]},"x-purecloud-method-name":"putWidgetsDeployment"},"delete":{"tags":["Widgets"],"summary":"Delete a Widget deployment","description":"","operationId":"deleteWidgetsDeployment","produces":["application/json"],"parameters":[{"name":"deploymentId","in":"path","description":"Widget Config Id","required":true,"type":"string"}],"responses":{"204":{"description":"Deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["widgets"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["widgets:deployment:delete","webchat:deployment:delete"]},"x-purecloud-method-name":"deleteWidgetsDeployment"}},"/api/v2/scim/groups/{groupId}":{"get":{"tags":["SCIM"],"summary":"Get a group","description":"","operationId":"getScimGroup","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"name":"groupId","in":"path","description":"The ID of a group. Returned with GET /api/v2/scim/groups.","required":true,"type":"string"},{"name":"attributes","in":"query","description":"Indicates which attributes to include. Returns these attributes and the \"id\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","displayName","members","externalId","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:id","urn:ietf:params:scim:schemas:core:2.0:Group:meta","urn:ietf:params:scim:schemas:core:2.0:Group:meta.version","urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:displayName","urn:ietf:params:scim:schemas:core:2.0:Group:members","urn:ietf:params:scim:schemas:core:2.0:Group:externalId"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"id"},{"name":"displayName"},{"name":"members"},{"name":"externalId"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:members"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:externalId"},{"name":"id"},{"name":"displayName"},{"name":"members"},{"name":"externalId"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:members"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:externalId"}]},{"name":"excludedAttributes","in":"query","description":"Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns \"id\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","displayName","members","externalId","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:id","urn:ietf:params:scim:schemas:core:2.0:Group:meta","urn:ietf:params:scim:schemas:core:2.0:Group:meta.version","urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:displayName","urn:ietf:params:scim:schemas:core:2.0:Group:members","urn:ietf:params:scim:schemas:core:2.0:Group:externalId"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"id"},{"name":"displayName"},{"name":"members"},{"name":"externalId"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:members"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:externalId"},{"name":"id"},{"name":"displayName"},{"name":"members"},{"name":"externalId"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:members"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:externalId"}]},{"name":"If-None-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2Group"}},"304":{"description":"If-Non-Match header matches current version. No content returned."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:edit"]},"x-purecloud-method-name":"getScimGroup"},"put":{"tags":["SCIM"],"summary":"Replace a group","description":"","operationId":"putScimGroup","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"name":"groupId","in":"path","description":"The ID of a group. Returned with GET /api/v2/scim/groups.","required":true,"type":"string"},{"name":"If-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".","required":false,"type":"string"},{"in":"body","name":"body","description":"The information used to replace a group.","required":true,"schema":{"$ref":"#/definitions/ScimV2Group"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2Group"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Version does not match current version.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:edit"]},"x-purecloud-method-name":"putScimGroup"},"patch":{"tags":["SCIM"],"summary":"Modify a group","description":"","operationId":"patchScimGroup","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"name":"groupId","in":"path","description":"The ID of a group. Returned with GET /api/v2/scim/groups.","required":true,"type":"string"},{"name":"If-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".","required":false,"type":"string"},{"in":"body","name":"body","description":"The information used to modify a group.","required":true,"schema":{"$ref":"#/definitions/ScimV2PatchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2Group"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Version does not match current version.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:edit"]},"x-purecloud-method-name":"patchScimGroup"}},"/api/v2/scim/groups":{"get":{"tags":["SCIM"],"summary":"Get a list of groups","description":"","operationId":"getScimGroups","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"name":"startIndex","in":"query","description":"The 1-based index of the first query result.","required":false,"type":"integer","default":1,"format":"int32"},{"name":"count","in":"query","description":"The requested number of items per page. A value of 0 returns \"totalResults\". A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the \"excludedAttributes\" or \"attributes\" query parameters to exclude or only include secondary lookup values such as \"externalId\", \"roles\", \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages\", or \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills\".","required":false,"type":"integer","default":25,"format":"int32"},{"name":"attributes","in":"query","description":"Indicates which attributes to include. Returns these attributes and the \"id\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","displayName","members","externalId","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:id","urn:ietf:params:scim:schemas:core:2.0:Group:meta","urn:ietf:params:scim:schemas:core:2.0:Group:meta.version","urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:displayName","urn:ietf:params:scim:schemas:core:2.0:Group:members","urn:ietf:params:scim:schemas:core:2.0:Group:externalId"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"id"},{"name":"displayName"},{"name":"members"},{"name":"externalId"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:members"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:externalId"},{"name":"id"},{"name":"displayName"},{"name":"members"},{"name":"externalId"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:members"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:externalId"}]},{"name":"excludedAttributes","in":"query","description":"Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns \"id\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","displayName","members","externalId","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:id","urn:ietf:params:scim:schemas:core:2.0:Group:meta","urn:ietf:params:scim:schemas:core:2.0:Group:meta.version","urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:displayName","urn:ietf:params:scim:schemas:core:2.0:Group:members","urn:ietf:params:scim:schemas:core:2.0:Group:externalId"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"id"},{"name":"displayName"},{"name":"members"},{"name":"externalId"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:members"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:externalId"},{"name":"id"},{"name":"displayName"},{"name":"members"},{"name":"externalId"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:members"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:externalId"}]},{"name":"filter","in":"query","description":"Filters results. If nothing is specified, returns all groups. Examples of valid values: \"id eq 5f4bc742-a019-4e38-8e2a-d39d5bc0b0f3\", \"displayname eq Sales\".","required":false,"type":"string","x-example":"displayName eq groupName"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimGroupListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:edit"]},"x-purecloud-method-name":"getScimGroups"}},"/api/v2/integrations/types/{typeId}":{"get":{"tags":["Integrations"],"summary":"Get integration type.","description":"","operationId":"getIntegrationsType","produces":["application/json"],"parameters":[{"name":"typeId","in":"path","description":"Integration Type Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IntegrationType"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-purecloud-method-name":"getIntegrationsType"}},"/api/v2/scripts/{scriptId}/pages/{pageId}":{"get":{"tags":["Scripts"],"summary":"Get a page","description":"","operationId":"getScriptPage","produces":["application/json"],"parameters":[{"name":"scriptId","in":"path","description":"Script ID","required":true,"type":"string"},{"name":"pageId","in":"path","description":"Page ID","required":true,"type":"string"},{"name":"scriptDataVersion","in":"query","description":"Advanced usage - controls the data version of the script","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Page"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:script:view"]},"x-purecloud-method-name":"getScriptPage"}},"/api/v2/users/bulk":{"patch":{"tags":["Users"],"summary":"Update bulk acd autoanswer on users","description":"","operationId":"patchUsersBulk","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Users","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/PatchUser"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"max user ids":"Only 50 users can be requested at a time.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:add","directory:user:edit"]},"x-purecloud-method-name":"patchUsersBulk"}},"/api/v2/telephony/providers/edges/certificateauthorities":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of certificate authorities.","description":"","operationId":"getTelephonyProvidersEdgesCertificateauthorities","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CertificateAuthorityEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesCertificateauthorities"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a certificate authority.","description":"","operationId":"postTelephonyProvidersEdgesCertificateauthorities","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"CertificateAuthority","required":true,"schema":{"$ref":"#/definitions/DomainCertificateAuthority"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainCertificateAuthority"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesCertificateauthorities"}},"/api/v2/externalcontacts/organizations/{externalOrganizationId}/trustor":{"delete":{"tags":["External Contacts"],"summary":"Unlink the Trustor for this External Organization","description":"","operationId":"deleteExternalcontactsOrganizationTrustor","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization ID","required":true,"type":"string"}],"responses":{"204":{"description":"Trustor link has been deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:externalOrganization:edit"]},"x-purecloud-method-name":"deleteExternalcontactsOrganizationTrustor"}},"/api/v2/scripts/{scriptId}":{"get":{"tags":["Scripts"],"summary":"Get a script","description":"","operationId":"getScript","produces":["application/json"],"parameters":[{"name":"scriptId","in":"path","description":"Script ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Script"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:script:view"]},"x-purecloud-method-name":"getScript"}},"/api/v2/telephony/providers/edges/edgegroups":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of edge groups.","description":"","operationId":"getTelephonyProvidersEdgesEdgegroups","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"managed","in":"query","description":"Filter by managed","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeGroupEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Edge groups not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesEdgegroups"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create an edge group.","description":"","operationId":"postTelephonyProvidersEdgesEdgegroups","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"EdgeGroup","required":true,"schema":{"$ref":"#/definitions/EdgeGroup"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"required.field.missing":"A required field is missing a value.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.value":"An edge group with this name already exists.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesEdgegroups"}},"/api/v2/widgets/deployments":{"get":{"tags":["Widgets"],"summary":"List Widget deployments","description":"","operationId":"getWidgetsDeployments","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WidgetDeploymentEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["widgets","widgets:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["widgets:deployment:view","webchat:deployment:read"]},"x-purecloud-method-name":"getWidgetsDeployments"},"post":{"tags":["Widgets"],"summary":"Create Widget deployment","description":"","operationId":"postWidgetsDeployments","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Deployment","required":true,"schema":{"$ref":"#/definitions/WidgetDeployment"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WidgetDeployment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.deployments":"Conflict caused by too many deployments","maximum.deployments.exceeded":"No more than 10 deployments allowed"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["widgets"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["widgets:deployment:add","webchat:deployment:create"]},"x-purecloud-method-name":"postWidgetsDeployments"}},"/api/v2/telephony/providers/edges/phones":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of Phone Instances","description":"","operationId":"getTelephonyProvidersEdgesPhones","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Value by which to sort","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"site.id","in":"query","description":"Filter by site.id","required":false,"type":"string"},{"name":"webRtcUser.id","in":"query","description":"Filter by webRtcUser.id","required":false,"type":"string"},{"name":"phoneBaseSettings.id","in":"query","description":"Filter by phoneBaseSettings.id","required":false,"type":"string"},{"name":"lines.loggedInUser.id","in":"query","description":"Filter by lines.loggedInUser.id","required":false,"type":"string"},{"name":"lines.defaultForUser.id","in":"query","description":"Filter by lines.defaultForUser.id","required":false,"type":"string"},{"name":"phone_hardwareId","in":"query","description":"Filter by phone_hardwareId","required":false,"type":"string"},{"name":"lines.id","in":"query","description":"Filter by lines.id","required":false,"type":"string"},{"name":"lines.name","in":"query","description":"Filter by lines.name","required":false,"type":"string"},{"name":"name","in":"query","description":"Name of the Phone to filter by","required":false,"type":"string"},{"name":"expand","in":"query","description":"Fields to expand in the response, comma-separated","required":false,"type":"array","items":{"type":"string","enum":["properties","site","status","status.primaryEdgesStatus","status.secondaryEdgesStatus","phoneBaseSettings","lines"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"properties"},{"name":"site"},{"name":"status"},{"name":"status.primaryEdgesStatus"},{"name":"status.secondaryEdgesStatus"},{"name":"phoneBaseSettings"},{"name":"lines"}]},{"name":"fields","in":"query","description":"Fields and properties to get, comma-separated","required":false,"type":"array","items":{"type":"string","enum":["webRtcUser","properties.*","lines.loggedInUser","lines.defaultForUser"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"webRtcUser"},{"name":"properties.*"},{"name":"lines.loggedInUser"},{"name":"lines.defaultForUser"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhoneEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesPhones"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a new Phone","description":"","operationId":"postTelephonyProvidersEdgesPhones","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Phone","required":true,"schema":{"$ref":"#/definitions/Phone"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Phone"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","lines.required":"A phone cannot be created without a line.","base.settings.required":"A base setting must be assigned to create a phone.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"Request Timeout","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unknown":"Unspecified error posting phone instance."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.rate.limit":"Request rate limit exceeded.","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesPhones"}},"/api/v2/coaching/appointments/aggregates/query":{"post":{"tags":["Coaching"],"summary":"Retrieve aggregated appointment data","description":"","operationId":"postCoachingAppointmentsAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Aggregate Request","required":true,"schema":{"$ref":"#/definitions/CoachingAppointmentAggregateRequest"}}],"responses":{"200":{"description":"Query completed successfully","schema":{"$ref":"#/definitions/CoachingAppointmentAggregateResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"aggregate.too.many.users":"Too many users were included in the request.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","validation.failure":"There was a problem with the request, see the message for details"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","no.permission.for.requested.users":"The requested users are in a division you do not have permission to.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","coaching:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:appointment:view"]},"x-purecloud-method-name":"postCoachingAppointmentsAggregatesQuery"}},"/api/v2/speechandtextanalytics/topics":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get the list of Speech & Text Analytics topics","description":"","operationId":"getSpeechandtextanalyticsTopics","produces":["application/json"],"parameters":[{"name":"nextPage","in":"query","description":"The key for listing the next page","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"The page size for the listing","required":false,"type":"integer","default":20,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TopicsEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"page.not.found":"The requested page could not be found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:topic:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsTopics"},"post":{"tags":["Speech & Text Analytics"],"summary":"Create new Speech & Text Analytics topic","description":"","operationId":"postSpeechandtextanalyticsTopics","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The topic to create","required":true,"schema":{"$ref":"#/definitions/TopicRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Topic"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"phrases.limit.exceeded":"1000 phrases quota exceeded","program.not.found":"The requested program could not be found","tags.limit.exceeded":"20 tags quota exceeded","topics.limit.exceeded":"500 topics quota exceeded","bad.request":"Wrong request structure","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conflict":"Topic with the same name and dialect already exists in this Org"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"resource.unavailable":"Resource unavailable","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:topic:add"]},"x-purecloud-method-name":"postSpeechandtextanalyticsTopics"}},"/api/v2/conversations/{conversationId}/recordingmetadata":{"get":{"tags":["Recording"],"summary":"Get recording metadata for a conversation. Does not return playable media.","description":"","operationId":"getConversationRecordingmetadata","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/RecordingMetadata"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.recording.view.permission.check.failed":"Request forbidden due to recording view permissions check failing.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","conversation.not.found":"Conversation with specified conversationId was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-purecloud-method-name":"getConversationRecordingmetadata"}},"/api/v2/users/presences/bulk":{"put":{"tags":["Presence"],"summary":"Update bulk user Presences","description":"","operationId":"putUsersPresencesBulk","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"List of User presences","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/UserPresence"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/UserPresence"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","max user presences":"Only 50 user presences can be updated at a time.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence","presence:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:edit"]},"x-purecloud-method-name":"putUsersPresencesBulk"}},"/api/v2/languageunderstanding/domains/{domainId}/feedback/{feedbackId}":{"get":{"tags":["Language Understanding"],"summary":"Find a Feedback","description":"","operationId":"getLanguageunderstandingDomainFeedbackFeedbackId","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"feedbackId","in":"path","description":"ID of the Feedback","required":true,"type":"string"},{"name":"fields","in":"query","description":"Fields and properties to get, comma-separated","required":false,"type":"array","items":{"type":"string","enum":["version","dateCreated","text","intents"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"version"},{"name":"dateCreated"},{"name":"text"},{"name":"intents"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluFeedbackResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","dialog:readonly","language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:feedback:view","dialog:bot:view"]},"x-purecloud-method-name":"getLanguageunderstandingDomainFeedbackFeedbackId"},"delete":{"tags":["Language Understanding"],"summary":"Delete the feedback on the NLU Domain Version.","description":"","operationId":"deleteLanguageunderstandingDomainFeedbackFeedbackId","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"feedbackId","in":"path","description":"ID of the Feedback","required":true,"type":"string"}],"responses":{"204":{"description":"Feedback deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","language-understanding"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:feedback:delete","dialog:bot:delete"]},"x-purecloud-method-name":"deleteLanguageunderstandingDomainFeedbackFeedbackId"}},"/api/v2/flows/datatables/{datatableId}/import/jobs/{importJobId}":{"get":{"tags":["Architect"],"summary":"Returns the state information about an import job","description":"Returns the state information about an import job.","operationId":"getFlowsDatatableImportJob","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"name":"importJobId","in":"path","description":"id of import job","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataTableImportJob"}},"202":{"description":"Request Accepted","schema":{"$ref":"#/definitions/DataTableImportJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","flows.datatables.session.not.found":"A session was not found"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:view"]},"x-purecloud-method-name":"getFlowsDatatableImportJob"}},"/api/v2/conversations/{conversationId}/recordings":{"get":{"tags":["Recording"],"summary":"Get all of a Conversation's Recordings.","description":"","operationId":"getConversationRecordings","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"maxWaitMs","in":"query","description":"The maximum number of milliseconds to wait for the recording to be ready. Must be a positive value.","required":false,"type":"integer","default":5000,"format":"int32"},{"name":"formatId","in":"query","description":"The desired media format. Possible values: NONE, MP3, WAV, or WEBM","required":false,"type":"string","default":"WEBM","enum":["WAV","WEBM","WAV_ULAW","OGG_VORBIS","OGG_OPUS","MP3","NONE"],"x-genesys-enum-members":[{"name":"WAV"},{"name":"WEBM"},{"name":"WAV_ULAW"},{"name":"OGG_VORBIS"},{"name":"OGG_OPUS"},{"name":"MP3"},{"name":"NONE"}]}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/Recording"}}},"202":{"description":"Success - recording is transcoding"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.query.invalid.conversation":"Quality query has invalid conversation.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.recording.view.permission.check.failed":"The recording:recording:view permission is required.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","conversation.not.found":"A conversation for the provided conversationId was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["recording:recording:view"]},"x-purecloud-method-name":"getConversationRecordings"}},"/api/v2/flows/datatables/{datatableId}/rows":{"get":{"tags":["Architect"],"summary":"Returns the rows for the datatable with the given id","description":"Returns all of the rows for the datatable with the given datatableId. By default this will just be a truncated list returning the key for each row. Set showBrief to false to return all of the row contents.","operationId":"getFlowsDatatableRows","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"showbrief","in":"query","description":"If true returns just the key value of the row","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataTableRowEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","flows.datatables.syntax.error":"There was an error parsing user data","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.table.not.found":"The datatable could not be found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:view"]},"x-purecloud-method-name":"getFlowsDatatableRows"},"post":{"tags":["Architect"],"summary":"Create a new row entry for the datatable.","description":"Will add the passed in row entry to the datatable with the given datatableId after verifying it against the schema. The DataTableRow should be a json-ized' stream of key -> value pairs\n{ \n \"Field1\": \"XYZZY\", \n \"Field2\": false, \n \"KEY\": \"27272\" \n}","operationId":"postFlowsDatatableRows","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"in":"body","name":"dataTableRow","required":true,"schema":{"type":"object","additionalProperties":{"type":"object"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.schema.exception":"The row didn't conform to the schema in some way","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","flows.datatables.too.many.rows":"The max number of datatable rows allowed has been reached.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","flows.datatables.syntax.error":"There was an error parsing user data","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.table.not.found":"The datatable could not be found.","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.not.unique":"The row had a duplicate keyname."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:add"]},"x-purecloud-method-name":"postFlowsDatatableRows"}},"/api/v2/quality/calibrations":{"get":{"tags":["Quality"],"summary":"Get the list of calibrations","description":"","operationId":"getQualityCalibrations","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"conversationId","in":"query","description":"conversation id","required":false,"type":"string"},{"name":"startTime","in":"query","description":"Beginning of the calibration query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","required":false,"type":"string","format":"date-time"},{"name":"endTime","in":"query","description":"end of the calibration query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","required":false,"type":"string","format":"date-time"},{"name":"calibratorId","in":"query","description":"user id of calibrator","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CalibrationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:calibration:view"]},"x-purecloud-method-name":"getQualityCalibrations"},"post":{"tags":["Quality"],"summary":"Create a calibration","description":"","operationId":"postQualityCalibrations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"calibration","required":true,"schema":{"$ref":"#/definitions/CalibrationCreate"}},{"name":"expand","in":"query","description":"calibratorId","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Calibration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.calibration.no.evaluation.form.or.context.id":"evaluation form or context id missing","bad.request":"The request could not be understood by the server due to malformed syntax.","qm.calibration.create.error.no.evaluators":"Failed to create calibration because the specified evaluators do not exist.","quality.evaluation.agent.doesnt.have.participate.permission":"Agent does not have evaluation participate permission","quality.evaluation.form.context.doesnt.exist":"Evaluation form context doesn't exist","quality.calibration.scoring.index.evaluator.must.match.calibrator.or.expert.evaluator":"scoring index evaluator must be a calibrator or expert evaluator","qm.calibration.create.error.no.agent":"Failed to create calibration because the conversation has no agent user","quality.calibration.existing.evaluation.not.finished":"Existing evaluation is not finished for calibration","quality.calibration.expert.evaluator.not.quality.evaluator":"expert evaluator does not have evaluator permissions","quality.calibration.no.existing.evaluation.for.evaluationid":"no evaluation found for existing evaluation","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","quality.calibration.contextid.doesnt.match.evaluation.contextid":"Calibration contextId doesn't match the evaluation contextId","quality.evaluation.evaluator.not.quality.evaluator":"evaluator does not have edit score permission","quality.conversation.doesnt.exist":"unable to find specified conversation","qm.calibration.create.error.no.conversation":"Failed to create calibration because the specified conversation does not exist","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","quality.calibration.create.permission.check.failed":"Calibration create permission check failed","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:calibration:add"]},"x-purecloud-method-name":"postQualityCalibrations"}},"/api/v2/outbound/contactlists/{contactListId}":{"get":{"tags":["Outbound"],"summary":"Get a dialer contact list.","description":"","operationId":"getOutboundContactlist","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"ContactList ID","required":true,"type":"string"},{"name":"includeImportStatus","in":"query","description":"Import status","required":false,"type":"boolean","default":false},{"name":"includeSize","in":"query","description":"Include size","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The dialer contact list was not found.","not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactList:view"]},"x-purecloud-method-name":"getOutboundContactlist"},"put":{"tags":["Outbound"],"summary":"Update a contact list.","description":"","operationId":"putOutboundContactlist","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"ContactList ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ContactList","required":true,"schema":{"$ref":"#/definitions/ContactList"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.columns.dont.match":"Contact columns field and ordered contact columns field must match.","name.cannot.be.blank":"A name must be provided.","contact.columns.do.not.contain.phone.number.column":"","no.phone.columns":"","name.length.exceeded":"The name length exceeds the limit of 64 characters.","system.column.phone.column":"ContactList Phone column cannot be a system defined column name.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","cannot.edit.automatic.time.zone.mapping.settings":"Automatic time zone mapping and the zip code column cannot be changed after contact list creation","not.unique.phone.columns":"Phone Number Columns contain duplicate values.","no.contact.columns.defined":"There are no contact columns defined.","invalid.update":"","phone.columns.limit.exceeded":"Number of phone columns must not exceed the limit.","not.unique.contact.columns":"Contact Columns contains duplicate values.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","cannot.have.callable.time.column.with.automatic.time.zone.mapping":"The phone columns cannot reference callable time columns when automatic time zone mapping is being used","cannot.update.phone.columns":"The phone columns can not be updated.","cannot.have.zip.code.column.without.automatic.time.zone.mapping":"The zip code column can only be used when automatic time zone mapping is also being used","invalid.contact.phone.column":"The contact phone columns are invalid.","invalid.zip.code.column":"The zip code column must be a column of the contact list and cannot be a phone column","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","cannot.update.contact.column.names":"The contact column names can not be updated."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.wrong.version":""}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactList:edit"]},"x-purecloud-method-name":"putOutboundContactlist"},"delete":{"tags":["Outbound"],"summary":"Delete a contact list.","description":"","operationId":"deleteOutboundContactlist","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"ContactList ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","internal.error":"An internal server error occurred.","referential.integrity.error":"Could not delete the resource because it is referenced by another entity.","contact.list.import.in.progress":"The contact list import is in progress.","contact.list.in.use":"The contact list is in use."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactList:delete"]},"x-purecloud-method-name":"deleteOutboundContactlist"}},"/api/v2/outbound/contactlists/{contactListId}/timezonemappingpreview":{"get":{"tags":["Outbound"],"summary":"Preview the result of applying Automatic Time Zone Mapping to a contact list","description":"","operationId":"getOutboundContactlistTimezonemappingpreview","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"ContactList ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeZoneMappingPreview"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.automatic.time.zone.mapping":"This contact list is not set up for Automatic Time Zone Mapping","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The contact list could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactList:view"]},"x-purecloud-method-name":"getOutboundContactlistTimezonemappingpreview"}},"/api/v2/quality/evaluators/activity":{"get":{"tags":["Quality"],"summary":"Get an evaluator activity","description":"","operationId":"getQualityEvaluatorsActivity","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"startTime","in":"query","description":"The start time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","required":false,"type":"string","format":"date-time"},{"name":"endTime","in":"query","description":"The end time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","required":false,"type":"string","format":"date-time"},{"name":"name","in":"query","description":"Evaluator name","required":false,"type":"string"},{"name":"permission","in":"query","description":"permission strings","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"group","in":"query","description":"group id","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluatorActivityEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"qmevaluatoractivity.search.too.many.results":"Too many results in evaluator activity query; user needs to enter more characters for name search","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","qmevaluatoractivity.pagenum.too.big":"Page number too large in evaluator activity query","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","qmevaluatoractivity.pagenum.too.small":"Page number too small in evaluator activity query; cannot be < 1"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","quality.evaluation.view.permission.check.failed":"Failed to check required view permission.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluation:view"]},"x-purecloud-method-name":"getQualityEvaluatorsActivity"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/agentschedules/search":{"post":{"tags":["Workforce Management"],"summary":"Query published schedules for given given time range for set of users","description":"","operationId":"postWorkforcemanagementManagementunitAgentschedulesSearch","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/BuSearchAgentSchedulesRequest"}},{"name":"forceAsync","in":"query","description":"Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes","required":false,"type":"boolean"},{"name":"forceDownloadService","in":"query","description":"Force the result of this operation to be sent via download service. For testing/app development purposes","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuAsyncAgentSchedulesSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:publishedSchedule:view","wfm:schedule:view"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitAgentschedulesSearch"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/schedules/search":{"post":{"tags":["Workforce Management"],"summary":"Query published schedules for given given time range for set of users","description":"","operationId":"postWorkforcemanagementManagementunitSchedulesSearch","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/UserListScheduleRequestBody"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserScheduleContainer"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"408":{"description":"Request Timeout","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.deprecated.api.timeout":"The response of this deprecated route needed to come via notification, instead please use /agentschedules/search"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.too.many.requests":"Too many requests in a given amount of time","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:publishedSchedule:view","wfm:schedule:view"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitSchedulesSearch"}},"/api/v2/uploads/workforcemanagement/historicaldata/json":{"post":{"tags":["Uploads"],"summary":"Creates presigned url for uploading WFM historical data file. Requires data in json format.","description":"","operationId":"postUploadsWorkforcemanagementHistoricaldataJson","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/UploadUrlRequest"}}],"responses":{"200":{"description":"Presigned url successfully created.","schema":{"$ref":"#/definitions/UploadUrlResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["upload"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["wfm:historicalData:upload"]},"x-purecloud-method-name":"postUploadsWorkforcemanagementHistoricaldataJson"}},"/api/v2/uploads/workforcemanagement/historicaldata/csv":{"post":{"tags":["Uploads"],"summary":"Creates presigned url for uploading WFM historical data file. Requires data in csv format.","description":"","operationId":"postUploadsWorkforcemanagementHistoricaldataCsv","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/UploadUrlRequest"}}],"responses":{"200":{"description":"Presigned url successfully created.","schema":{"$ref":"#/definitions/UploadUrlResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["upload"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["wfm:historicalData:upload"]},"x-purecloud-method-name":"postUploadsWorkforcemanagementHistoricaldataCsv"}},"/api/v2/languageunderstanding/domains":{"get":{"tags":["Language Understanding"],"summary":"Get all NLU Domains.","description":"","operationId":"getLanguageunderstandingDomains","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluDomainListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","dialog:readonly","language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomain:view","dialog:bot:view"]},"x-purecloud-method-name":"getLanguageunderstandingDomains"},"post":{"tags":["Language Understanding"],"summary":"Create an NLU Domain.","description":"","operationId":"postLanguageunderstandingDomains","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The NLU Domain to create.","required":true,"schema":{"$ref":"#/definitions/NluDomain"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluDomain"}},"201":{"description":"","schema":{"$ref":"#/definitions/NluDomain"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","language-understanding"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomain:add","dialog:bot:add"]},"x-purecloud-method-name":"postLanguageunderstandingDomains"}},"/api/v2/coaching/notifications":{"get":{"tags":["Coaching"],"summary":"Retrieve the list of your notifications.","description":"","operationId":"getCoachingNotifications","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"expand","in":"query","description":"Indicates a field in the response which should be expanded.","required":false,"type":"array","items":{"type":"string","enum":["appointment"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"appointment"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CoachingNotificationList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","pagination.bad.request":"The page size or page number could not be parsed."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","coaching:readonly"]}],"x-purecloud-method-name":"getCoachingNotifications"}},"/api/v2/groups/{groupId}/members":{"get":{"tags":["Groups"],"summary":"Get group members, includes individuals, owners, and dynamically included people","description":"","operationId":"getGroupMembers","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ASC","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"routingStatus"},{"name":"presence"},{"name":"conversationSummary"},{"name":"outOfOffice"},{"name":"geolocation"},{"name":"station"},{"name":"authorization"},{"name":"lasttokenissued"},{"name":"authorization.unusedRoles"},{"name":"team"},{"name":"profileSkills"},{"name":"certifications"},{"name":"locations"},{"name":"groups"},{"name":"skills"},{"name":"languages"},{"name":"languagePreference"},{"name":"employerInfo"},{"name":"biography"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups","groups:readonly"]}],"x-purecloud-method-name":"getGroupMembers"},"post":{"tags":["Groups"],"summary":"Add members","description":"","operationId":"postGroupMembers","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Add members","required":true,"schema":{"$ref":"#/definitions/GroupMembersUpdate"}}],"responses":{"202":{"description":"Success, group membership was updated","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.resource.not.found":"Group members were not found.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","general.conflict":"Resource conflict updating members."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Resource conflict - Unexpected version was provided","x-inin-error-codes":{"general.conflict":"The version supplied does not match the current version of the user"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups"]}],"x-purecloud-method-name":"postGroupMembers"},"delete":{"tags":["Groups"],"summary":"Remove members","description":"","operationId":"deleteGroupMembers","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"},{"name":"ids","in":"query","description":"Comma separated list of userIds to remove","required":true,"type":"string"}],"responses":{"202":{"description":"Success, group membership was updated","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups"]}],"x-purecloud-method-name":"deleteGroupMembers"}},"/api/v2/analytics/reporting/metadata":{"get":{"tags":["Analytics"],"summary":"Get list of reporting metadata.","description":"","operationId":"getAnalyticsReportingMetadata","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"locale","in":"query","description":"Locale","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportMetaDataEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["reporting:acd:view, reporting:status:view, reporting:interactions:view, reporting:outbound:view, reporting:quality:view, employee"]},"x-purecloud-method-name":"getAnalyticsReportingMetadata"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}":{"get":{"tags":["Workforce Management"],"summary":"Get a work plan rotation","description":"","operationId":"getWorkforcemanagementManagementunitWorkplanrotation","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"workPlanRotationId","in":"path","description":"The ID of the work plan rotation to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlanRotationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:workPlanRotation:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitWorkplanrotation"},"delete":{"tags":["Workforce Management"],"summary":"Delete a work plan rotation","description":"","operationId":"deleteWorkforcemanagementManagementunitWorkplanrotation","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"workPlanRotationId","in":"path","description":"The ID of the work plan rotation to be deleted","required":true,"type":"string"}],"responses":{"204":{"description":"The work plan rotation was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:workPlanRotation:delete"]},"x-purecloud-method-name":"deleteWorkforcemanagementManagementunitWorkplanrotation"},"patch":{"tags":["Workforce Management"],"summary":"Update a work plan rotation","description":"","operationId":"patchWorkforcemanagementManagementunitWorkplanrotation","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"workPlanRotationId","in":"path","description":"The ID of the work plan rotation to update","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/UpdateWorkPlanRotationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlanRotationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Version of the request does not match the version on the backend"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:workPlanRotation:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementManagementunitWorkplanrotation"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}/copy":{"post":{"tags":["Workforce Management"],"summary":"Create a copy of work plan rotation","description":"","operationId":"postWorkforcemanagementManagementunitWorkplanrotationCopy","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"workPlanRotationId","in":"path","description":"The ID of the work plan rotation to create a copy","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/CopyWorkPlanRotationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlanRotationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"Name not specified or there is already a work plan rotation with the name mentioned for copy","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:workPlanRotation:add"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitWorkplanrotationCopy"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations":{"get":{"tags":["Workforce Management"],"summary":"Get work plan rotations","description":"","operationId":"getWorkforcemanagementManagementunitWorkplanrotations","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"expand","in":"query","required":false,"type":"array","items":{"type":"string","enum":["agents"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"agents"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlanRotationListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agent:view","wfm:workPlanRotation:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitWorkplanrotations"},"post":{"tags":["Workforce Management"],"summary":"Create a new work plan rotation","description":"","operationId":"postWorkforcemanagementManagementunitWorkplanrotations","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/AddWorkPlanRotationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlanRotationResponse"}},"201":{"description":"The work plan rotation was successfully created","schema":{"$ref":"#/definitions/WorkPlanRotationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:workPlanRotation:add"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitWorkplanrotations"}},"/api/v2/users/{userId}/presences/purecloud":{"get":{"tags":["Presence"],"summary":"Get a user's Genesys Cloud presence.","description":"Get the default Genesys Cloud user presence source PURECLOUD","operationId":"getUserPresencesPurecloud","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"user Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserPresence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.usernotfound":"The specified user was not found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","presenceservice.toomanyrequests":"Too many requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence","presence:readonly"]}],"x-purecloud-method-name":"getUserPresencesPurecloud"},"patch":{"tags":["Presence"],"summary":"Patch a Genesys Cloud user's presence","description":"The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the PURECLOUD source as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.","operationId":"patchUserPresencesPurecloud","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"user Id","required":true,"type":"string"},{"in":"body","name":"body","description":"User presence","required":true,"schema":{"$ref":"#/definitions/UserPresence"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserPresence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.usernotfound":"The specified user was not found","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.conflict":"A previous update request has not yet completed"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","presenceservice.toomanyrequests":"Too many requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence"]}],"x-purecloud-method-name":"patchUserPresencesPurecloud"}},"/api/v2/users/{userId}/presences/microsoftteams":{"get":{"tags":["Presence"],"summary":"Get a user's Microsoft Teams presence.","description":"Gets the presence for a Microsoft Teams user. This will return the Microsoft Teams presence mapped to Genesys Cloud presence with additional activity details in the message field. This presence source is read-only.","operationId":"getUserPresencesMicrosoftteams","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"user Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PresenceExpand"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Valid session authorization code not created.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"Microsoft Teams presence could not be found for user."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integration:microsoftTeams:view","integrations:integration:view"]},"x-purecloud-method-name":"getUserPresencesMicrosoftteams"}},"/api/v2/users/{userId}/presences/{sourceId}":{"get":{"tags":["Presence"],"summary":"Get a user's Presence","description":"Get a user's presence for the specified source that is not specifically listed. Used to support custom presence sources.","operationId":"getUserPresence","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"user Id","required":true,"type":"string"},{"name":"sourceId","in":"path","description":"Presence source ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserPresence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.usernotfound":"The specified user was not found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","presenceservice.toomanyrequests":"Too many requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence","presence:readonly"]}],"x-purecloud-method-name":"getUserPresence"},"patch":{"tags":["Presence"],"summary":"Patch a user's Presence","description":"Patch a user's presence for the specified source that is not specifically listed. The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the 'source' defined in the path as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.","operationId":"patchUserPresence","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"user Id","required":true,"type":"string"},{"name":"sourceId","in":"path","description":"Presence source ID","required":true,"type":"string"},{"in":"body","name":"body","description":"User presence","required":true,"schema":{"$ref":"#/definitions/UserPresence"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserPresence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.usernotfound":"The specified user was not found","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.conflict":"A previous update request has not yet completed"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","presenceservice.toomanyrequests":"Too many requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence"]}],"x-purecloud-method-name":"patchUserPresence"}},"/api/v2/workforcemanagement/adherence":{"get":{"tags":["Workforce Management"],"summary":"Get a list of UserScheduleAdherence records for the requested users","description":"","operationId":"getWorkforcemanagementAdherence","produces":["application/json"],"parameters":[{"name":"userId","in":"query","description":"User Id(s) for which to fetch current schedule adherence information. Min 1, Max of 100 userIds per request","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/UserScheduleAdherence"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","no.user.ids.specified":"You must specify at least one userId","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","max.user.ids":"Only 100 users can be requested at a time"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"fail":"WFM Server Error","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:realtimeAdherence:view"]},"x-purecloud-method-name":"getWorkforcemanagementAdherence"}},"/api/v2/quality/forms/surveys/{formId}":{"get":{"tags":["Quality"],"summary":"Get a survey form","description":"","operationId":"getQualityFormsSurvey","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"survey.not.found":"Survey formId not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:view"]},"x-purecloud-method-name":"getQualityFormsSurvey"},"put":{"tags":["Quality"],"summary":"Update a survey form.","description":"","operationId":"putQualityFormsSurvey","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Survey form","required":true,"schema":{"$ref":"#/definitions/SurveyForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:edit"]},"x-purecloud-method-name":"putQualityFormsSurvey"},"delete":{"tags":["Quality"],"summary":"Delete a survey form.","description":"","operationId":"deleteQualityFormsSurvey","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"survey.cannot.be.deleted":"Cannot delete survey because it has already been published."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:delete"]},"x-purecloud-method-name":"deleteQualityFormsSurvey"},"patch":{"tags":["Quality"],"summary":"Disable a particular version of a survey form and invalidates any invitations that have already been sent to customers using this version of the form.","description":"","operationId":"patchQualityFormsSurvey","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Survey form","required":true,"schema":{"$ref":"#/definitions/SurveyForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:disable"]},"x-purecloud-method-name":"patchQualityFormsSurvey"}},"/api/v2/orphanrecordings/{orphanId}":{"get":{"tags":["Recording"],"summary":"Gets a single orphan recording","description":"","operationId":"getOrphanrecording","produces":["application/json"],"parameters":[{"name":"orphanId","in":"path","description":"Orphan ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrphanRecording"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:orphan:view"]},"x-purecloud-method-name":"getOrphanrecording"},"put":{"tags":["Recording"],"summary":"Updates an orphan recording to a regular recording with retention values","description":"If this operation is successful the orphan will no longer exist. It will be replaced by the resulting recording in the response. This replacement recording is accessible by the normal Recording api.","operationId":"putOrphanrecording","produces":["application/json"],"parameters":[{"name":"orphanId","in":"path","description":"Orphan ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/OrphanUpdateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Recording"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.orphan.retention.data.invalid":"The provided dates in the payload were invalid.","recording.orphan.unknown.conversation":"The provided conversation in the payload doesn't exist.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","recording.orphan.edit.permission.check.failed":"Requesting user lacks permission to perform this api operation."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:orphan:edit"]},"x-purecloud-method-name":"putOrphanrecording"},"delete":{"tags":["Recording"],"summary":"Deletes a single orphan recording","description":"","operationId":"deleteOrphanrecording","produces":["application/json"],"parameters":[{"name":"orphanId","in":"path","description":"Orphan ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrphanRecording"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:orphan:delete"]},"x-purecloud-method-name":"deleteOrphanrecording"}},"/api/v2/identityproviders/okta":{"get":{"tags":["Identity Provider"],"summary":"Get Okta Identity Provider","description":"","operationId":"getIdentityprovidersOkta","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Okta"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersOkta"},"put":{"tags":["Identity Provider"],"summary":"Update/Create Okta Identity Provider","description":"","operationId":"putIdentityprovidersOkta","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/Okta"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.issuer.uri":"An issuer URI is required.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.target.url":"The target URL must be a valid HTTPS URL.","certificate.not.yet.valid":"The certificate is not yet valid.","certificate.invalid.base64":"Invalid base64 in certificate.","certificate.unparseable":"The certificate for provider cannot be parsed.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersOkta"},"delete":{"tags":["Identity Provider"],"summary":"Delete Okta Identity Provider","description":"","operationId":"deleteIdentityprovidersOkta","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersOkta"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents/{documentId}":{"get":{"tags":["Knowledge"],"summary":"Get document","description":"","operationId":"getKnowledgeKnowledgebaseLanguageDocument","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","de-DE"],"x-genesys-enum-members":[{"name":"en-US"},{"name":"de-DE"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocument"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","input.validations":"Input parameters do not match the required criteria","kb.not.found":"Knowledge Base does not exist","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"404":"Resource code does not exist","not.found":"The requested resource was not found.","document.not.found":"Document does not exist"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseLanguageDocument"},"delete":{"tags":["Knowledge"],"summary":"Delete document","description":"","operationId":"deleteKnowledgeKnowledgebaseLanguageDocument","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","de-DE"],"x-genesys-enum-members":[{"name":"en-US"},{"name":"de-DE"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocument"}},"204":{"description":"Document deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","input.validations":"Input parameters do not match the required criteria","kb.not.found":"Knowledge Base does not exist"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"404":"Resource does not exist","not.found":"The requested resource was not found.","document.not.found":"Document does not exist"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:delete"]},"x-purecloud-method-name":"deleteKnowledgeKnowledgebaseLanguageDocument"},"patch":{"tags":["Knowledge"],"summary":"Update document","description":"","operationId":"patchKnowledgeKnowledgebaseLanguageDocument","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","de-DE"],"x-genesys-enum-members":[{"name":"en-US"},{"name":"de-DE"}]},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeDocumentRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocument"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","input.validations":"Input parameters do not match the required criteria","kb.not.found":"Knowledge Base does not exist","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"404":"Resource does not exist","not.found":"The requested resource was not found.","document.not.found":"Document does not exist"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:edit"]},"x-purecloud-method-name":"patchKnowledgeKnowledgebaseLanguageDocument"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/search":{"post":{"tags":["Search","Knowledge"],"summary":"Search Documents","description":"","operationId":"postKnowledgeKnowledgebaseSearch","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/KnowledgeSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","min.length.expected":"The minimum characters for the query is 5","invalid.languagecode":"Language code must be of format lang-iso2 (eg: en-US)","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:knowledgebase:search"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseSearch"}},"/api/v2/externalcontacts/organizations/{externalOrganizationId}/trustor/{trustorId}":{"put":{"tags":["External Contacts"],"summary":"Links a Trustor with an External Organization","description":"","operationId":"putExternalcontactsOrganizationTrustorTrustorId","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization ID","required":true,"type":"string"},{"name":"trustorId","in":"path","description":"Trustor ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalOrganizationTrustorLink"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Trustor is not found by trustor id.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"Provided fields are not valid."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:externalOrganization:edit"]},"x-purecloud-method-name":"putExternalcontactsOrganizationTrustorTrustorId"}},"/api/v2/orgauthorization/pairings/{pairingId}":{"get":{"tags":["Organization Authorization"],"summary":"Get Pairing Info","description":"","operationId":"getOrgauthorizationPairing","produces":["application/json"],"parameters":[{"name":"pairingId","in":"path","description":"Pairing Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustRequest"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrustee:view","authorization:orgTrustor:view"]},"x-purecloud-method-name":"getOrgauthorizationPairing"}},"/api/v2/contentmanagement/shares":{"get":{"tags":["Content Management"],"summary":"Gets a list of shares. You must specify at least one filter (e.g. entityId).","description":"Failing to specify a filter will return 400.","operationId":"getContentmanagementShares","produces":["application/json"],"parameters":[{"name":"entityId","in":"query","description":"Filters the shares returned to only the entity specified by the value of this parameter.","required":false,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["member"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"member"}]},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ShareEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementShares"},"post":{"tags":["Content Management"],"summary":"Creates a new share or updates an existing share if the entity has already been shared","description":"","operationId":"postContentmanagementShares","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"CreateShareRequest - entity id and type and a single member or list of members are required","required":true,"schema":{"$ref":"#/definitions/CreateShareRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CreateShareResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"forbidden":"Forbidden from saving a share.","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"postContentmanagementShares"}},"/api/v2/outbound/dnclists/{dncListId}/phonenumbers":{"post":{"tags":["Outbound"],"summary":"Add phone numbers to a Dialer DNC list.","description":"Only Internal DNC lists may be appended to","operationId":"postOutboundDnclistPhonenumbers","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"},{"in":"body","name":"body","description":"DNC Phone Numbers","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.source.operation.not.supported":"An attempt was made to append numbers to a DNC list that is not of type Internal","dnc.phone.numbers.per.list.limit.exceeded":"The DNC list has reached the limit on total records. See details","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","dnc.phone.numbers.per.organization.limit.exceeded":"The organization has reached the limit on total DNC records. See details"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.not.found":"The do not call list could not be found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dnc:add"]},"x-purecloud-method-name":"postOutboundDnclistPhonenumbers"}},"/api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId}":{"get":{"tags":["Content Management"],"summary":"Get a workspace tag","description":"","operationId":"getContentmanagementWorkspaceTagvalue","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"tagId","in":"path","description":"Tag ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["acl"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"acl"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TagValue"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementWorkspaceTagvalue"},"put":{"tags":["Content Management"],"summary":"Update a workspace tag. Will update all documents with the new tag value.","description":"","operationId":"putContentmanagementWorkspaceTagvalue","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"tagId","in":"path","description":"Tag ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Workspace","required":true,"schema":{"$ref":"#/definitions/TagValue"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TagValue"}},"202":{"description":"Accepted - Processing Update"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"tag.value.too.long":"The tag value is too long.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","tag.value.empty":"The tag value cannot be empty.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"putContentmanagementWorkspaceTagvalue"},"delete":{"tags":["Content Management"],"summary":"Delete workspace tag","description":"Delete a tag from a workspace. Will remove this tag from all documents.","operationId":"deleteContentmanagementWorkspaceTagvalue","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"tagId","in":"path","description":"Tag ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"deleteContentmanagementWorkspaceTagvalue"}},"/api/v2/externalcontacts/reversewhitepageslookup":{"get":{"tags":["External Contacts"],"summary":"Look up contacts and externalOrganizations based on an attribute. Maximum of 25 values returned.","description":"","operationId":"getExternalcontactsReversewhitepageslookup","produces":["application/json"],"parameters":[{"name":"lookupVal","in":"query","description":"User supplied value to lookup contacts/externalOrganizations (supports email addresses, e164 phone numbers, Twitter screen names)","required":true,"type":"string"},{"name":"expand","in":"query","description":"which field, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["contacts.externalOrganization","externalDataSources"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"contacts.externalOrganization"},{"name":"externalDataSources"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReverseWhitepagesLookupResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:view"]},"x-purecloud-method-name":"getExternalcontactsReversewhitepageslookup"}},"/api/v2/outbound/contactlistfilters/{contactListFilterId}":{"get":{"tags":["Outbound"],"summary":"Get Contact list filter","description":"","operationId":"getOutboundContactlistfilter","produces":["application/json"],"parameters":[{"name":"contactListFilterId","in":"path","description":"Contact List Filter ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListFilter"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactListFilter:view"]},"x-purecloud-method-name":"getOutboundContactlistfilter"},"put":{"tags":["Outbound"],"summary":"Update Contact List Filter","description":"","operationId":"putOutboundContactlistfilter","produces":["application/json"],"parameters":[{"name":"contactListFilterId","in":"path","description":"Contact List Filter ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ContactListFilter","required":true,"schema":{"$ref":"#/definitions/ContactListFilter"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListFilter"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"operator.required":"Could not update the contact list filter because the operator field was empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","contact.list.not.found":"Could not update the contact list filter because the contact list could not be found.","filter.type.required.for.multiple.predicates":"Could not update the contact list filter because the filter type on a clause is required if there are multiple predicates.","filter.type.required.for.multiple.clauses":"Could not update the contact list filter because the filter type is required if there are multiple clauses.","at.least.one.predicate.required":"Could not update the contact list filter because each clause must contain at least one predicate.","value.required":"Could not update the contact list filter because the value field on a predicate was empty and required for that predicate's operator.","range.max.required":"Could not update the contact list filter because the range max field is required for Between operator.","value.did.not.match.column.type":"Could not update the contact list filter because the predicate value field did not match the column type.","value.exceeds.max.digits":"The maximum number of digits for the value on a predicate with a numeric operator has been exceeded.","max.less.than.min":"Could not update the contact list filter because the predicate range max value is less than the min value.","min.did.not.match.column.type":"Could not update the contact list filter because the predicate range min field did not match the column type.","value.exceeds.max.decimal.places":"The maximum number of decimal places in the value on a predicate with a numeric operator has been exceeded.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","column.does.not.match.contact.list":"Could not update the contact list filter because the column on a predicate did not match a column on the selected contact list.","range.required":"Could not update the contact list filter because the range field was empty and is required for Between and In operators.","max.predicates.contains.exceeded":"Could not update the contact list filter because the maximum number of predicates with CONTAINS operators has been exceeded.","contact.list.cannot.be.blank":"Could not update the contact list filter because the contact list field was blank.","invalid.date.value":"Could not update the contact list filter because the value field on the predicate is not a valid date.","clauses.required":"Could not update the contact list filter because the clauses field is required to contain at least one clause.","max.did.not.match.column.type":"Could not update the contact list filter because the predicate range max field did not match the column type.","column.required":"Could not update the contact list filter because the column field was empty on a predicate.","max.predicates.exceeded":"Could not update the contact list filter because the maximum number of predicates has been exceeded.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","range.set.required":"Could not update the contact list filter because the range set field is required for In operator.","range.min.required":"Could not update the contact list filter because the range min field is required for Between operator."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactListFilter:edit"]},"x-purecloud-method-name":"putOutboundContactlistfilter"},"delete":{"tags":["Outbound"],"summary":"Delete Contact List Filter","description":"","operationId":"deleteOutboundContactlistfilter","produces":["application/json"],"parameters":[{"name":"contactListFilterId","in":"path","description":"Contact List Filter ID","required":true,"type":"string"}],"responses":{"204":{"description":"Contact list filter deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","referential.integrity.error":"Could not delete the resource because it is referenced by another entity."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactListFilter:delete"]},"x-purecloud-method-name":"deleteOutboundContactlistfilter"}},"/api/v2/flows/datatables/{datatableId}/export/jobs/{exportJobId}":{"get":{"tags":["Architect"],"summary":"Returns the state information about an export job","description":"Returns the state information about an export job.","operationId":"getFlowsDatatableExportJob","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"name":"exportJobId","in":"path","description":"id of export job","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataTableExportJob"}},"202":{"description":"Request Accepted","schema":{"$ref":"#/definitions/DataTableExportJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","flows.datatables.session.not.found":"A session was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect:readonly","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:view"]},"x-purecloud-method-name":"getFlowsDatatableExportJob"}},"/api/v2/architect/systemprompts/{promptId}/history":{"post":{"tags":["Architect"],"summary":"Generate system prompt history","description":"Asynchronous. Notification topic: v2.architect.systemprompts.{systemPromptId}","operationId":"postArchitectSystempromptHistory","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"promptId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Operation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:systemPrompt:view"]},"x-purecloud-method-name":"postArchitectSystempromptHistory"}},"/api/v2/architect/systemprompts/{promptId}/history/{historyId}":{"get":{"tags":["Architect"],"summary":"Get generated prompt history","description":"","operationId":"getArchitectSystempromptHistoryHistoryId","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"promptId","required":true,"type":"string"},{"name":"historyId","in":"path","description":"History request ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"desc"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"timestamp","enum":["action","timestamp","user"],"x-genesys-enum-members":[{"name":"action"},{"name":"timestamp"},{"name":"user"}]},{"name":"action","in":"query","description":"Flow actions to include (omit to include all)","required":false,"type":"array","items":{"type":"string","enum":["checkin","checkout","create","deactivate","debug","delete","publish","revert","save"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"checkin"},{"name":"checkout"},{"name":"create"},{"name":"deactivate"},{"name":"debug"},{"name":"delete"},{"name":"publish"},{"name":"revert"},{"name":"save"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/HistoryListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.system.prompt.not.found":"Could not find system prompt with specified ID.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:systemPrompt:view"]},"x-purecloud-method-name":"getArchitectSystempromptHistoryHistoryId"}},"/api/v2/architect/systemprompts/{promptId}":{"get":{"tags":["Architect"],"summary":"Get a system prompt","description":"","operationId":"getArchitectSystemprompt","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"promptId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SystemPrompt"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.system.prompt.not.found":"Could not find system prompt with specified ID.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:systemPrompt:view"]},"x-purecloud-method-name":"getArchitectSystemprompt"}},"/api/v2/outbound/schedules/campaigns/{campaignId}":{"get":{"tags":["Outbound"],"summary":"Get a dialer campaign schedule.","description":"","operationId":"getOutboundSchedulesCampaign","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The dialer campaign was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:schedule:view"]},"x-purecloud-method-name":"getOutboundSchedulesCampaign"},"put":{"tags":["Outbound"],"summary":"Update a new campaign schedule.","description":"","operationId":"putOutboundSchedulesCampaign","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"},{"in":"body","name":"body","description":"CampaignSchedule","required":true,"schema":{"$ref":"#/definitions/CampaignSchedule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update":"","invalid.interval.time":"","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","future.intervals.exceeded.limit":""}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The dialer campaign was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:schedule:edit"]},"x-purecloud-method-name":"putOutboundSchedulesCampaign"},"delete":{"tags":["Outbound"],"summary":"Delete a dialer campaign schedule.","description":"","operationId":"deleteOutboundSchedulesCampaign","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The dialer campaign was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:schedule:delete"]},"x-purecloud-method-name":"deleteOutboundSchedulesCampaign"}},"/api/v2/certificate/details":{"post":{"tags":["Utilities"],"summary":"Returns the information about an X509 PEM encoded certificate or certificate chain.","description":"","operationId":"postCertificateDetails","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Certificate","required":true,"schema":{"$ref":"#/definitions/Certificate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ParsedCertificate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["user-basic-info"]}],"x-purecloud-method-name":"postCertificateDetails"}},"/api/v2/voicemail/me/policy":{"get":{"tags":["Voicemail"],"summary":"Get the current user's voicemail policy","description":"","operationId":"getVoicemailMePolicy","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailUserPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-purecloud-method-name":"getVoicemailMePolicy"},"patch":{"tags":["Voicemail"],"summary":"Update the current user's voicemail policy","description":"","operationId":"patchVoicemailMePolicy","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The user's voicemail policy","required":true,"schema":{"$ref":"#/definitions/VoicemailUserPolicy"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailUserPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail"]}],"x-purecloud-method-name":"patchVoicemailMePolicy"}},"/api/v2/externalcontacts/scan/organizations":{"get":{"tags":["External Contacts"],"summary":"Scan for external organizations using paging","description":"","operationId":"getExternalcontactsScanOrganizations","produces":["application/json"],"parameters":[{"name":"limit","in":"query","description":"The number of organizations per page; must be between 10 and 200, default is 100)","required":false,"type":"integer","format":"int32"},{"name":"cursor","in":"query","description":"Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CursorOrganizationListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or expired cursor","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too many requests in a given amount of time"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:externalOrganization:view"]},"x-purecloud-method-name":"getExternalcontactsScanOrganizations"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId}":{"get":{"tags":["Workforce Management"],"summary":"Get a scheduling run","description":"","operationId":"getWorkforcemanagementBusinessunitSchedulingRun","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"runId","in":"path","description":"The ID of the schedule run","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuScheduleRun"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:generate","wfm:schedule:edit"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitSchedulingRun"},"delete":{"tags":["Workforce Management"],"summary":"Cancel a scheduling run","description":"","operationId":"deleteWorkforcemanagementBusinessunitSchedulingRun","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"runId","in":"path","description":"The ID of the schedule run","required":true,"type":"string"}],"responses":{"204":{"description":"The run was successfully canceled"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:generate"]},"x-purecloud-method-name":"deleteWorkforcemanagementBusinessunitSchedulingRun"},"patch":{"tags":["Workforce Management"],"summary":"Mark a schedule run as applied","description":"","operationId":"patchWorkforcemanagementBusinessunitSchedulingRun","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"runId","in":"path","description":"The ID of the schedule run","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/PatchBuScheduleRunRequest"}}],"responses":{"204":{"description":"The update was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.missing.one.of.permission.sets":"You must have access to the division of the business unit or all requested management units for the documented permission","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementBusinessunitSchedulingRun"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs":{"get":{"tags":["Workforce Management"],"summary":"Get the list of scheduling runs","description":"","operationId":"getWorkforcemanagementBusinessunitSchedulingRuns","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuScheduleRunListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:generate","wfm:schedule:edit"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitSchedulingRuns"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId}/result":{"get":{"tags":["Workforce Management"],"summary":"Get the result of a rescheduling operation","description":"","operationId":"getWorkforcemanagementBusinessunitSchedulingRunResult","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"runId","in":"path","description":"The ID of the schedule run","required":true,"type":"string"},{"name":"managementUnitIds","in":"query","description":"The IDs of the management units for which to fetch the reschedule results","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"expand","in":"query","description":"The fields to expand. Omitting will return an empty response","required":true,"type":"array","items":{"type":"string","enum":["headcountForecast","generationResults","agentSchedules"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"headcountForecast"},{"name":"generationResults"},{"name":"agentSchedules"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuRescheduleResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.missing.one.of.permission.sets":"You must have access to the division of the business unit or all requested management units for the documented permission","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:edit","wfm:schedule:generate"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitSchedulingRunResult"}},"/api/v2/groups/search":{"get":{"tags":["Groups","Search"],"summary":"Search groups using the q64 value returned from a previous search","description":"","operationId":"getGroupsSearch","produces":["application/json"],"parameters":[{"name":"q64","in":"query","description":"q64","required":true,"type":"string"},{"name":"expand","in":"query","description":"expand","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GroupsSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups","groups:readonly"]}],"x-purecloud-method-name":"getGroupsSearch"},"post":{"tags":["Groups","Search"],"summary":"Search groups","description":"","operationId":"postGroupsSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/GroupSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GroupsSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups"]}],"x-purecloud-method-name":"postGroupsSearch"}},"/api/v2/routing/sms/availablephonenumbers":{"get":{"tags":["Routing"],"summary":"Get a list of available phone numbers for SMS provisioning.","description":"This request will return up to 30 random phone numbers matching the criteria specified. To get additional phone numbers repeat the request.","operationId":"getRoutingSmsAvailablephonenumbers","produces":["application/json"],"parameters":[{"name":"countryCode","in":"query","description":"The ISO 3166-1 alpha-2 country code of the county for which available phone numbers should be returned","required":true,"type":"string"},{"name":"region","in":"query","description":"Region/province/state that can be used to restrict the numbers returned","required":false,"type":"string"},{"name":"city","in":"query","description":"City that can be used to restrict the numbers returned","required":false,"type":"string"},{"name":"areaCode","in":"query","description":"Area code that can be used to restrict the numbers returned","required":false,"type":"string"},{"name":"phoneNumberType","in":"query","description":"Type of available phone numbers searched","required":true,"type":"string","enum":["local","mobile","tollfree"],"x-genesys-enum-members":[{"name":"local"},{"name":"mobile"},{"name":"tollfree"}]},{"name":"pattern","in":"query","description":"A pattern to match phone numbers. Valid characters are '*' and [0-9a-zA-Z]. The '*' character will match any single digit.","required":false,"type":"string"},{"name":"addressRequirement","in":"query","description":"This indicates whether the phone number requires to have an Address registered.","required":false,"type":"string","enum":["none","any","local","foreign"],"x-genesys-enum-members":[{"name":"none"},{"name":"any"},{"name":"local"},{"name":"foreign"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SMSAvailablePhoneNumberEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:add"]},"x-purecloud-method-name":"getRoutingSmsAvailablephonenumbers"}},"/api/v2/contentmanagement/documents":{"get":{"tags":["Content Management"],"summary":"Get a list of documents.","description":"","operationId":"getContentmanagementDocuments","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"query","description":"Workspace ID","required":true,"type":"string"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["acl","workspace"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"acl"},{"name":"workspace"}]},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"name or dateCreated","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"ascending or descending","required":false,"type":"string","default":"ascending"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getContentmanagementDocuments"},"post":{"tags":["Content Management"],"summary":"Add a document.","description":"","operationId":"postContentmanagementDocuments","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Document","required":true,"schema":{"$ref":"#/definitions/DocumentUpload"}},{"name":"copySource","in":"query","description":"Copy a document within a workspace or to a new workspace. Provide a document ID as the copy source.","required":false,"type":"string"},{"name":"moveSource","in":"query","description":"Move a document to a new workspace. Provide a document ID as the move source.","required":false,"type":"string"},{"name":"override","in":"query","description":"Override any lock on the source document","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Document"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.null.argument":"Invalid, null arguments provided.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden from adding a document."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"423":{"description":"Locked - The source document is locked by another operation"},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"postContentmanagementDocuments"}},"/api/v2/telephony/providers/edges/timezones":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of Edge-compatible time zones","description":"","operationId":"getTelephonyProvidersEdgesTimezones","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":1000,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeZoneEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-purecloud-method-name":"getTelephonyProvidersEdgesTimezones"}},"/api/v2/integrations/{integrationId}":{"get":{"tags":["Integrations"],"summary":"Get integration.","description":"","operationId":"getIntegration","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration Id","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Integration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-purecloud-method-name":"getIntegration"},"delete":{"tags":["Integrations"],"summary":"Delete integration.","description":"","operationId":"deleteIntegration","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Integration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-purecloud-method-name":"deleteIntegration"},"patch":{"tags":["Integrations"],"summary":"Update an integration.","description":"","operationId":"patchIntegration","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Integration Update","required":false,"schema":{"$ref":"#/definitions/Integration"}},{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Integration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-purecloud-method-name":"patchIntegration"}},"/api/v2/telephony/providers/edges/outboundroutes/{outboundRouteId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get outbound route","description":"","operationId":"getTelephonyProvidersEdgesOutboundroute","produces":["application/json"],"parameters":[{"name":"outboundRouteId","in":"path","description":"Outbound route ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutboundRoute"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesOutboundroute"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update outbound route","description":"","operationId":"putTelephonyProvidersEdgesOutboundroute","produces":["application/json"],"parameters":[{"name":"outboundRouteId","in":"path","description":"Outbound route ID","required":true,"type":"string"},{"in":"body","name":"body","description":"OutboundRoute","required":true,"schema":{"$ref":"#/definitions/OutboundRoute"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutboundRoute"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"required.field.missing":"A required field is missing a value.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","duplicate.value":"An outbound route with this name already exists.","address.classification.type.does.not.exist":"One of the address classifications does not exist.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesOutboundroute"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete Outbound Route","description":"","operationId":"deleteTelephonyProvidersEdgesOutboundroute","produces":["application/json"],"parameters":[{"name":"outboundRouteId","in":"path","description":"Outbound route ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdgesOutboundroute"}},"/api/v2/license/toggles/{featureName}":{"get":{"tags":["License"],"summary":"Get PureCloud license feature toggle value.","description":"","operationId":"getLicenseToggle","produces":["application/json"],"parameters":[{"name":"featureName","in":"path","description":"featureName","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LicenseOrgToggle"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["license","license:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:add"]},"x-purecloud-method-name":"getLicenseToggle"},"post":{"tags":["License"],"summary":"Switch PureCloud license feature toggle value.","description":"","operationId":"postLicenseToggle","produces":["application/json"],"parameters":[{"name":"featureName","in":"path","description":"featureName","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LicenseOrgToggle"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["license"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:add"]},"x-purecloud-method-name":"postLicenseToggle"}},"/api/v2/integrations/types":{"get":{"tags":["Integrations"],"summary":"List integration types","description":"","operationId":"getIntegrationsTypes","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IntegrationTypeEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-purecloud-method-name":"getIntegrationsTypes"}},"/api/v2/users/{userId}/geolocations/{clientId}":{"get":{"tags":["Geolocation","Users"],"summary":"Get a user's Geolocation","description":"","operationId":"getUserGeolocation","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"user Id","required":true,"type":"string"},{"name":"clientId","in":"path","description":"client Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Geolocation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["geolocation","geolocation:readonly"]}],"x-purecloud-method-name":"getUserGeolocation"},"patch":{"tags":["Geolocation","Users"],"summary":"Patch a user's Geolocation","description":"The geolocation object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the client as the user's primary geolocation source. Option 2: Provide the 'latitude' and 'longitude' values. This will enqueue an asynchronous update of the 'city', 'region', and 'country', generating a notification. A subsequent GET operation will include the new values for 'city', 'region' and 'country'. Option 3: Provide the 'city', 'region', 'country' values. Option 1 can be combined with Option 2 or Option 3. For example, update the client as primary and provide latitude and longitude values.","operationId":"patchUserGeolocation","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"user Id","required":true,"type":"string"},{"name":"clientId","in":"path","description":"client Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Geolocation","required":true,"schema":{"$ref":"#/definitions/Geolocation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Geolocation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","geolocationservice.entitypointerror":"Geolocation entity point error","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","geolocation.update.error":"Cannot update another user's Geolocation."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"featuretoggleservice.featurenotenabled":"Geolocation feature toggle not enabled"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"geolocationservice.ratelimited":"Rate limited","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","geolocationservice.toomanyrequests":"Too many requests"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["geolocation"]}],"x-purecloud-method-name":"patchUserGeolocation"}},"/api/v2/orphanrecordings":{"get":{"tags":["Recording"],"summary":"Gets all orphan recordings","description":"","operationId":"getOrphanrecordings","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"hasConversation","in":"query","description":"Filter resulting orphans by whether the conversation is known. False returns all orphans for the organization.","required":false,"type":"boolean","default":false},{"name":"media","in":"query","description":"Filter resulting orphans based on their media type","required":false,"type":"string","enum":["Call","Screen"],"x-genesys-enum-members":[{"name":"Call"},{"name":"Screen"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrphanRecordingListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","recording.orphan.view.permission.check.failed":"Failed to verify recording view permission."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.internal.server.error":"An internal server error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:orphan:view"]},"x-purecloud-method-name":"getOrphanrecordings"}},"/api/v2/documentation/gkn/search":{"get":{"tags":["Search"],"summary":"Search gkn documentation using the q64 value returned from a previous search","description":"","operationId":"getDocumentationGknSearch","produces":["application/json"],"parameters":[{"name":"q64","in":"query","description":"q64","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GKNDocumentationSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"getDocumentationGknSearch"},"post":{"tags":["Search"],"summary":"Search gkn documentation","description":"","operationId":"postDocumentationGknSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/GKNDocumentationSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GKNDocumentationSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"postDocumentationGknSearch"}},"/api/v2/alerting/interactionstats/alerts":{"get":{"tags":["Alerting"],"summary":"Get interaction stats alert list.","description":"","operationId":"getAlertingInteractionstatsAlerts","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["notificationUsers"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"notificationUsers"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InteractionStatsAlertContainer"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting","alerting:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:alert:view"]},"x-purecloud-method-name":"getAlertingInteractionstatsAlerts"}},"/api/v2/contentmanagement/status":{"get":{"tags":["Content Management"],"summary":"Get a list of statuses for pending operations","description":"","operationId":"getContentmanagementStatus","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CommandStatusEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementStatus"}},"/api/v2/authorization/divisionspermitted/paged/me":{"get":{"tags":["Authorization","Users"],"summary":"Returns which divisions the current user has the given permission in.","description":"","operationId":"getAuthorizationDivisionspermittedPagedMe","produces":["application/json"],"parameters":[{"name":"permission","in":"query","description":"The permission string, including the object to access, e.g. routing:queue:view","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DivsPermittedEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","missing.permission.param":"Missing required permission parameter","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-purecloud-method-name":"getAuthorizationDivisionspermittedPagedMe"}},"/api/v2/identityproviders/pureengage":{"get":{"tags":["Identity Provider"],"summary":"Get PureEngage Identity Provider","description":"","operationId":"getIdentityprovidersPureengage","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PureEngage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersPureengage"},"put":{"tags":["Identity Provider"],"summary":"Update/Create PureEngage Identity Provider","description":"","operationId":"putIdentityprovidersPureengage","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/PureEngage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.issuer.uri":"An issuer URI is required.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.target.url":"The target URL must be a valid HTTPS URL.","certificate.not.yet.valid":"The certificate is not yet valid.","certificate.invalid.base64":"Invalid base64 in certificate.","certificate.unparseable":"The certificate for provider cannot be parsed.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersPureengage"},"delete":{"tags":["Identity Provider"],"summary":"Delete PureEngage Identity Provider","description":"","operationId":"deleteIdentityprovidersPureengage","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersPureengage"}},"/api/v2/users/{userId}/routingstatus":{"get":{"tags":["Users"],"summary":"Fetch the routing status of a user","description":"","operationId":"getUserRoutingstatus","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RoutingStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getUserRoutingstatus"},"put":{"tags":["Users"],"summary":"Update the routing status of a user","description":"","operationId":"putUserRoutingstatus","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Routing Status","required":true,"schema":{"$ref":"#/definitions/RoutingStatus"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RoutingStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"An invalid routing status transition was attempted.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-purecloud-method-name":"putUserRoutingstatus"}},"/api/v2/users/{userId}/routingskills/bulk":{"put":{"tags":["Routing","Users"],"summary":"Replace all routing skills assigned to a user","description":"","operationId":"putUserRoutingskillsBulk","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Skill","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/UserRoutingSkillPost"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserSkillEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","general.conflict":"Conflicts found replacing routing skills for user"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"One or more route skill(s) not found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:assign"]},"x-purecloud-method-name":"putUserRoutingskillsBulk"},"patch":{"tags":["Routing","Users"],"summary":"Bulk add routing skills to user","description":"","operationId":"patchUserRoutingskillsBulk","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Skill","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/UserRoutingSkillPost"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserSkillEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:assign"]},"x-purecloud-method-name":"patchUserRoutingskillsBulk"}},"/api/v2/users/{userId}/routingskills":{"get":{"tags":["Routing","Users"],"summary":"List routing skills for user","description":"","operationId":"getUserRoutingskills","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ASC","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserSkillEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The route skill specified not found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getUserRoutingskills"},"post":{"tags":["Routing","Users"],"summary":"Add routing skill to user","description":"","operationId":"postUserRoutingskills","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Skill","required":true,"schema":{"$ref":"#/definitions/UserRoutingSkillPost"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserRoutingSkill"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"Error adding route skill to user, bad request","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","general.conflict":"Conflict found adding route skill to user."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The route skill specified not found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:skill:assign"]},"x-purecloud-method-name":"postUserRoutingskills"}},"/api/v2/users/{userId}/routingskills/{skillId}":{"put":{"tags":["Routing","Users"],"summary":"Update routing skill proficiency or state.","description":"","operationId":"putUserRoutingskill","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"skillId","in":"path","description":"skillId","required":true,"type":"string"},{"in":"body","name":"body","description":"Skill","required":true,"schema":{"$ref":"#/definitions/UserRoutingSkill"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserRoutingSkill"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Resource conflict - Unexpected version was provided","x-inin-error-codes":{"general.conflict":"The version supplied does not match the current version of the user"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:skill:assign"]},"x-purecloud-method-name":"putUserRoutingskill"},"delete":{"tags":["Routing","Users"],"summary":"Remove routing skill from user","description":"","operationId":"deleteUserRoutingskill","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"skillId","in":"path","description":"skillId","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Resource not found","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be completed by the server due to a conflict."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:skill:assign"]},"x-purecloud-method-name":"deleteUserRoutingskill"}},"/api/v2/outbound/attemptlimits":{"get":{"tags":["Outbound"],"summary":"Query attempt limits list","description":"","operationId":"getOutboundAttemptlimits","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"allowEmptyResult","in":"query","description":"Whether to return an empty page when there are no results for that page","required":false,"type":"boolean","default":false},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"],"x-genesys-enum-members":[{"name":"Equals"},{"name":"RegEx"},{"name":"Contains"},{"name":"Prefix"},{"name":"LessThan"},{"name":"LessThanEqualTo"},{"name":"GreaterThan"},{"name":"GreaterThanEqualTo"},{"name":"BeginsWith"},{"name":"EndsWith"}]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AttemptLimitsEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:attemptLimits:view"]},"x-purecloud-method-name":"getOutboundAttemptlimits"},"post":{"tags":["Outbound"],"summary":"Create attempt limits","description":"","operationId":"postOutboundAttemptlimits","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"AttemptLimits","required":true,"schema":{"$ref":"#/definitions/AttemptLimits"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AttemptLimits"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"incorrect.max.value":"Max values must be > 0 and one of them must be defined","name.cannot.be.blank":"A name must be provided.","max.entity.count.reached":"The maximum attempt limits count has been reached.","exceeded.max.attempts.per.contact":"The maximum attempts per contact limit is 100.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","duplicate.name":"The name already exists.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.time.zone":"Not recognized as a valid time zone.","exceeded.max.attempts.per.number":"The maximum attempts per number limit is 100.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:attemptLimits:add"]},"x-purecloud-method-name":"postOutboundAttemptlimits"}},"/api/v2/voicemail/groups/{groupId}/policy":{"get":{"tags":["Voicemail"],"summary":"Get a group's voicemail policy","description":"","operationId":"getVoicemailGroupPolicy","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailGroupPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"voicemailservice.groupnotfound":"The voicemail policy was not found","general.resource.not.found":"The voicemail policy was not found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:add","directory:group:edit"]},"x-purecloud-method-name":"getVoicemailGroupPolicy"},"patch":{"tags":["Voicemail"],"summary":"Update a group's voicemail policy","description":"","operationId":"patchVoicemailGroupPolicy","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The group's voicemail policy","required":true,"schema":{"$ref":"#/definitions/VoicemailGroupPolicy"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailGroupPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:add","directory:group:edit"]},"x-purecloud-method-name":"patchVoicemailGroupPolicy"}},"/api/v2/quality/calibrations/{calibrationId}":{"get":{"tags":["Quality"],"summary":"Get a calibration by id. Requires either calibrator id or conversation id","description":"","operationId":"getQualityCalibration","produces":["application/json"],"parameters":[{"name":"calibrationId","in":"path","description":"Calibration ID","required":true,"type":"string"},{"name":"calibratorId","in":"query","description":"calibratorId","required":false,"type":"string"},{"name":"conversationId","in":"query","description":"conversationId","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Calibration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","quality.calibration.view.permission.check.failed":"calibration view permission check failed","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:calibration:view"]},"x-purecloud-method-name":"getQualityCalibration"},"put":{"tags":["Quality"],"summary":"Update a calibration to the specified calibration via PUT. Editable fields include: evaluators, expertEvaluator, and scoringIndex","description":"","operationId":"putQualityCalibration","produces":["application/json"],"parameters":[{"name":"calibrationId","in":"path","description":"Calibration ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Calibration","required":true,"schema":{"$ref":"#/definitions/Calibration"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Calibration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.evaluation.already.exists":"evaluation already exists","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","quality.calibration.update.permission.check.failed":"calibration update permission check failed","quality.evaluation.evaluator.not.quality.evaluator":"evaluator does not have edit score permission","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","quality.calibration.expert.evaluator.not.quality.evaluator":"expert evaluator does not have evaluator permissions"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:calibration:edit"]},"x-purecloud-method-name":"putQualityCalibration"},"delete":{"tags":["Quality"],"summary":"Delete a calibration by id.","description":"","operationId":"deleteQualityCalibration","produces":["application/json"],"parameters":[{"name":"calibrationId","in":"path","description":"Calibration ID","required":true,"type":"string"},{"name":"calibratorId","in":"query","description":"calibratorId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Calibration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","quality.calibration.delete.permission.check.failed":"calibration delete permission check failed"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:calibration:delete"]},"x-purecloud-method-name":"deleteQualityCalibration"}},"/api/v2/license/organization":{"post":{"tags":["License"],"summary":"Update the organization's license assignments in a batch.","description":"","operationId":"postLicenseOrganization","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The license assignments to update.","required":false,"schema":{"$ref":"#/definitions/LicenseBatchAssignmentRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/LicenseUpdateStatus"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["license"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:add"]},"x-purecloud-method-name":"postLicenseOrganization"}},"/api/v2/users/{userId}/greetings/defaults":{"get":{"tags":["Greetings"],"summary":"Grabs the list of Default Greetings given a User's ID","description":"","operationId":"getUserGreetingsDefaults","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DefaultGreetingList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings","greetings:readonly"]}],"x-purecloud-method-name":"getUserGreetingsDefaults"},"put":{"tags":["Greetings"],"summary":"Updates the DefaultGreetingList of the specified User","description":"","operationId":"putUserGreetingsDefaults","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The updated defaultGreetingList","required":true,"schema":{"$ref":"#/definitions/DefaultGreetingList"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DefaultGreetingList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings"]}],"x-purecloud-method-name":"putUserGreetingsDefaults"}},"/api/v2/coaching/appointments/{appointmentId}/statuses":{"get":{"tags":["Coaching"],"summary":"Get the list of status changes for a coaching appointment.","description":"Permission not required if you are an attendee, creator or facilitator of the appointment","operationId":"getCoachingAppointmentStatuses","produces":["application/json"],"parameters":[{"name":"appointmentId","in":"path","description":"The ID of the coaching appointment.","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"Retrieved appointment statuses","schema":{"$ref":"#/definitions/CoachingAppointmentStatusResponseList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"User does not have the appointment status view permission and is not an attendee, creator or facilitator of the appointment"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.not.found":"Appointment not found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","coaching:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:appointmentStatus:view"]},"x-purecloud-method-name":"getCoachingAppointmentStatuses"}},"/api/v2/coaching/appointments/{appointmentId}/status":{"patch":{"tags":["Coaching"],"summary":"Update the status of a coaching appointment","description":"Permission not required if you are an attendee, creator or facilitator of the appointment","operationId":"patchCoachingAppointmentStatus","produces":["application/json"],"parameters":[{"name":"appointmentId","in":"path","description":"The ID of the coaching appointment.","required":true,"type":"string"},{"in":"body","name":"body","description":"Updated status of the coaching appointment","required":true,"schema":{"$ref":"#/definitions/CoachingAppointmentStatusRequest"}}],"responses":{"200":{"description":"The status is posted successfully","schema":{"$ref":"#/definitions/CoachingAppointmentStatusResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","validation.failure":"Failed to validate the appointment status."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"User does not have the appointment status edit permission and is not an attendee, creator or facilitator of the appointment","agent.cannot.change.status":"Agent cannot change the status of a facilitated appointment."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.not.found":"Appointment not found","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.state.conflict":"The state of the appointment prevents the changes you are requesting."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:appointmentStatus:edit"]},"x-purecloud-method-name":"patchCoachingAppointmentStatus"}},"/api/v2/routing/settings/transcription":{"get":{"tags":["Routing"],"summary":"Get Transcription Settings","description":"","operationId":"getRoutingSettingsTranscription","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TranscriptionSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","feature.forbidden":"Requested feature is forbidden"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:transcriptionSettings:view"]},"x-purecloud-method-name":"getRoutingSettingsTranscription"},"put":{"tags":["Routing"],"summary":"Update Transcription Settings","description":"","operationId":"putRoutingSettingsTranscription","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Organization Settings","required":true,"schema":{"$ref":"#/definitions/TranscriptionSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TranscriptionSettings"}},"202":{"description":"Request to update transcription settings has been accepted","schema":{"$ref":"#/definitions/TranscriptionSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:transcriptionSettings:edit"]},"x-purecloud-method-name":"putRoutingSettingsTranscription"}},"/api/v2/routing/settings/contactcenter":{"get":{"tags":["Routing"],"summary":"Get Contact Center Settings","description":"","operationId":"getRoutingSettingsContactcenter","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactCenterSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-purecloud-method-name":"getRoutingSettingsContactcenter"},"patch":{"tags":["Routing"],"summary":"Update Contact Center Settings","description":"","operationId":"patchRoutingSettingsContactcenter","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Contact Center Settings","required":true,"schema":{"$ref":"#/definitions/ContactCenterSettings"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:settings:edit"]},"x-purecloud-method-name":"patchRoutingSettingsContactcenter"}},"/api/v2/routing/settings":{"get":{"tags":["Routing"],"summary":"Get an organization's routing settings","description":"","operationId":"getRoutingSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RoutingSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-purecloud-method-name":"getRoutingSettings"},"put":{"tags":["Routing"],"summary":"Update an organization's routing settings","description":"","operationId":"putRoutingSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Organization Settings","required":true,"schema":{"$ref":"#/definitions/RoutingSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RoutingSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:settings:edit"]},"x-purecloud-method-name":"putRoutingSettings"},"delete":{"tags":["Routing"],"summary":"Delete an organization's routing settings","description":"","operationId":"deleteRoutingSettings","produces":["application/json"],"parameters":[],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:settings:edit"]},"x-purecloud-method-name":"deleteRoutingSettings"}},"/api/v2/license/definitions/{licenseId}":{"get":{"tags":["License"],"summary":"Get PureCloud license definition.","description":"","operationId":"getLicenseDefinition","produces":["application/json"],"parameters":[{"name":"licenseId","in":"path","description":"ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LicenseDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["license","license:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:add"]},"x-purecloud-method-name":"getLicenseDefinition"}},"/api/v2/oauth/clients":{"get":{"tags":["OAuth"],"summary":"The list of OAuth clients","description":"","operationId":"getOauthClients","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthClientEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:view"]},"x-purecloud-method-name":"getOauthClients"},"post":{"tags":["OAuth"],"summary":"Create OAuth client","description":"The OAuth Grant/Client is required in order to create an authentication token and gain access to PureCloud. \nThe preferred authorizedGrantTypes is 'CODE' which requires applications to send a client ID and client secret. This is typically a web server. \nIf OAuth PKCE attributes will be used for a code grant, the grant type CODE_PKCE should be used. This will require PKCE challenge and verifier for authentication. \nIf the client is unable to secure the client secret then the 'TOKEN' grant type aka IMPLICIT should be used. This is would be for browser or mobile apps. \nIf a client is to be used outside of the context of a user then the 'CLIENT-CREDENTIALS' grant may be used. In this case the client must be granted roles \nvia the 'roleIds' field.","operationId":"postOauthClients","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Client","required":true,"schema":{"$ref":"#/definitions/OAuthClientRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthClient"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.client.scope":"Client scope is missing.","bad.client.role":"Client role is invalid.","bad.client.state":"New clients can only have an active state","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","auth.too.many.clients":"Too many clients exist in this organization.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","bad.grant.type":"Invalid grant type.","auth.invalid.scope":"Client has invalid scope","missing.client.roles":"Client roles and divisions are missing.","grant.type.required":"Grant type is required.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:add"]},"x-purecloud-method-name":"postOauthClients"}},"/api/v2/workforcemanagement/adherence/historical":{"post":{"tags":["Workforce Management"],"summary":"Request a historical adherence report for users across management units","description":"","operationId":"postWorkforcemanagementAdherenceHistorical","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/WfmHistoricalAdherenceQueryForUsers"}}],"responses":{"202":{"description":"Processing request","schema":{"$ref":"#/definitions/WfmHistoricalAdherenceResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.only.authorized.for.team.access":"You are only authorized to call this route for specific teams","wfm.too.many.teams.requested":"You may only request up to 10 teams in a single request","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","wfm.requested.teams.and.users":"You may only either teams or users, not both","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","wfm.missing.team.permissions":"You must have access to the requested teams"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:historicalAdherence:view"]},"x-purecloud-method-name":"postWorkforcemanagementAdherenceHistorical"}},"/api/v2/conversations":{"get":{"tags":["Conversations"],"summary":"Get active conversations for the logged in user","description":"","operationId":"getConversations","produces":["application/json"],"parameters":[{"name":"communicationType","in":"query","description":"Call or Chat communication filtering","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConversationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversations"}},"/api/v2/conversations/messages":{"get":{"tags":["Conversations"],"summary":"Get active message conversations for the logged in user","description":"","operationId":"getConversationsMessages","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessageConversationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsMessages"},"post":{"tags":["Conversations"],"summary":"Create an outbound messaging conversation.","description":"If there is an existing conversation between the remote address and the address associated with the queue specified in createOutboundRequest then the result of this request depends on the state of that conversation and the useExistingConversation field of createOutboundRequest. If the existing conversation is in alerting or connected state, then the request will fail. If the existing conversation is disconnected but still within the conversation window then the request will fail unless useExistingConversation is set to true.","operationId":"postConversationsMessages","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Create outbound messaging conversation","required":true,"schema":{"$ref":"#/definitions/CreateOutboundMessagingConversationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessageConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.phone.numbers":"SMS phone number addresses are not in a valid E.164 format.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.phone.number":"The SMS phone number address is not a valid E.164 format.","queue.address.required":"The queue does not have an outbound messaging address configured.","active.conversation":"An alerting or connected conversation is already in progress.","queue.membership.required":"Queue membership is invalid.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","existing.conversation":"An existing conversation within the conversation window is in progress."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["conversation:message:create"]},"x-purecloud-method-name":"postConversationsMessages"}},"/api/v2/conversations/messages/{conversationId}/participants/{participantId}/wrapupcodes":{"get":{"tags":["Conversations"],"summary":"Get list of wrapup codes for this conversation participant","description":"","operationId":"getConversationsMessageParticipantWrapupcodes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":" conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsMessageParticipantWrapupcodes"}},"/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages":{"post":{"tags":["Conversations"],"summary":"Send message","description":"Send message on existing conversation/communication. Only one message body field can be accepted, per request. Example: 1 textBody, 1 mediaId, 1 stickerId, or 1 messageTemplate.","operationId":"postConversationsMessageCommunicationMessages","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Message","required":true,"schema":{"$ref":"#/definitions/AdditionalMessage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessageData"}},"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"max.length.exceeded":"One or more attributes is longer than the maximum length allowed.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","not.found":"Message not found.","media.too.large":"Media must comply with the size limits of the channel","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","chat.error":"Server error handing chat."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["conversation:message:create"]},"x-purecloud-method-name":"postConversationsMessageCommunicationMessages"}},"/api/v2/conversations/messages/{conversationId}/messages/bulk":{"post":{"tags":["Conversations"],"summary":"Get messages in batch","description":"The path parameter [conversationId] should contain the conversationId of the conversation being filtered. The body should contain the messageId(s) of messages being requested. For example: [\"a3069a33b-bbb1-4703-9d68-061d9e9db96e\", \"55bc6be3-078c-4a49-a4e6-1e05776ed7e8\"]","operationId":"postConversationsMessageMessagesBulk","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","required":true,"type":"string"},{"in":"body","name":"body","description":"messageIds","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TextMessageListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:message:view"]},"x-purecloud-method-name":"postConversationsMessageMessagesBulk"}},"/api/v2/conversations/messages/{conversationId}/participants/{participantId}/attributes":{"patch":{"tags":["Conversations"],"summary":"Update the attributes on a conversation participant.","description":"","operationId":"patchConversationsMessageParticipantAttributes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":" conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ParticipantAttributes"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsMessageParticipantAttributes"}},"/api/v2/conversations/messages/{conversationId}":{"get":{"tags":["Conversations"],"summary":"Get message conversation","description":"","operationId":"getConversationsMessage","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessageConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsMessage"},"patch":{"tags":["Conversations"],"summary":"Update a conversation by disconnecting all of the participants","description":"","operationId":"patchConversationsMessage","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation","required":true,"schema":{"$ref":"#/definitions/Conversation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Conversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:disconnect"]},"x-purecloud-method-name":"patchConversationsMessage"}},"/api/v2/conversations/messages/{conversationId}/participants/{participantId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation participant. ","description":"","operationId":"getConversationsMessageParticipantWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsMessageParticipantWrapup"}},"/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages/media/{mediaId}":{"get":{"tags":["Conversations"],"summary":"Get media","description":"","operationId":"getConversationsMessageCommunicationMessagesMediaMediaId","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"name":"mediaId","in":"path","description":"mediaId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessageMediaData"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:message:view"]},"x-purecloud-method-name":"getConversationsMessageCommunicationMessagesMediaMediaId"}},"/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages/media":{"post":{"tags":["Conversations"],"summary":"Create media","description":"","operationId":"postConversationsMessageCommunicationMessagesMedia","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessageMediaData"}},"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["conversation:message:create"]},"x-purecloud-method-name":"postConversationsMessageCommunicationMessagesMedia"}},"/api/v2/conversations/messages/agentless":{"post":{"tags":["Conversations"],"summary":"Send an agentless outbound message","description":"Send an agentlesss (api participant) outbound message using a client credential grant. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will generate a new Conversation, if there is an existing active Conversation between the fromAddress and toAddress already, then this POST will fail.","operationId":"postConversationsMessagesAgentless","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Create agentless outbound messaging request","required":true,"schema":{"$ref":"#/definitions/SendAgentlessOutboundMessageRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SendAgentlessOutboundMessageResponse"}},"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"max.length.exceeded":"One or more attributes is longer than the maximum length allowed.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","not.a.client":"This request requires a non-user context. User token cannot be used for requests to this resource.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["conversation:message:create"]},"x-purecloud-method-name":"postConversationsMessagesAgentless"}},"/api/v2/conversations/messages/{conversationId}/participants/{participantId}/communications/{communicationId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant's communication by disconnecting it.","description":"","operationId":"patchConversationsMessageParticipantCommunication","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":" conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"communication.state.required":"Can only update a communication's state to disconnected.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsMessageParticipantCommunication"}},"/api/v2/conversations/messages/{conversationId}/participants/{participantId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant","description":"","operationId":"patchConversationsMessageParticipant","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":" conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.participant.update.invalid":"Failed to update all properties on conversation participant.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","conversation.error.participant.no.active.conversations":"Participant has no active conversations"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.participant.update.failed":"Failed to update all properties on conversation participant.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsMessageParticipant"}},"/api/v2/conversations/messages/{conversationId}/participants/{participantId}/replace":{"post":{"tags":["Conversations"],"summary":"Replace this participant with the specified user and/or address","description":"","operationId":"postConversationsMessageParticipantReplace","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Transfer request","required":true,"schema":{"$ref":"#/definitions/TransferRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","conversations.error.queue.not.found":"Interaction cannot be transferred to a queue that does not exist.","conversations.error.transfer.not.connected":"You can only transfer conversations that are in the connected state.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationsMessageParticipantReplace"}},"/api/v2/conversations/messages/{conversationId}/messages/{messageId}":{"get":{"tags":["Conversations"],"summary":"Get message","description":"","operationId":"getConversationsMessageMessage","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"messageId","in":"path","description":"messageId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessageData"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:message:view"]},"x-purecloud-method-name":"getConversationsMessageMessage"}},"/api/v2/telephony/providers/edges/phones/{phoneId}/reboot":{"post":{"tags":["Telephony Providers Edge"],"summary":"Reboot a Phone","description":"","operationId":"postTelephonyProvidersEdgesPhoneReboot","produces":["application/json"],"parameters":[{"name":"phoneId","in":"path","description":"Phone Id","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","providerapi.error.phone.no.active.edge":"Phone is not connected to an active edge and cannot be rebooted."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesPhoneReboot"}},"/api/v2/routing/queues/divisionviews/all":{"get":{"tags":["Routing"],"summary":"Get a paged listing of simplified queue objects. Can be used to get a digest of all queues in an organization.","description":"","operationId":"getRoutingQueuesDivisionviewsAll","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size [max value is 500]","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name","enum":["name","id","divisionId"],"x-genesys-enum-members":[{"name":"name"},{"name":"id"},{"name":"divisionId"}]},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc","enum":["asc","desc","score"],"x-genesys-enum-members":[{"name":"asc"},{"name":"desc"},{"name":"score"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.page.number":"Invalid page number specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:queue:search"]},"x-purecloud-method-name":"getRoutingQueuesDivisionviewsAll"}},"/api/v2/responsemanagement/responses":{"get":{"tags":["Response Management"],"summary":"Gets a list of existing responses.","description":"","operationId":"getResponsemanagementResponses","produces":["application/json"],"parameters":[{"name":"libraryId","in":"query","description":"Library ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"expand","in":"query","description":"Expand instructions for the return value.","required":false,"type":"string","enum":["substitutionsSchema"],"x-genesys-enum-members":[{"name":"substitutionsSchema"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management","response-management:readonly"]}],"x-purecloud-method-name":"getResponsemanagementResponses"},"post":{"tags":["Response Management"],"summary":"Create a response.","description":"","operationId":"postResponsemanagementResponses","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Response","required":true,"schema":{"$ref":"#/definitions/Response"}},{"name":"expand","in":"query","description":"Expand instructions for the return value.","required":false,"type":"string","enum":["substitutionsSchema"],"x-genesys-enum-members":[{"name":"substitutionsSchema"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Response"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"rms.not.a.user":"Unable to find user","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"412":{"description":"Precondition Failed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"rms.precondition":"Response precondition not met."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management"]}],"x-purecloud-method-name":"postResponsemanagementResponses"}},"/api/v2/outbound/dnclists":{"get":{"tags":["Outbound"],"summary":"Query dialer DNC lists","description":"","operationId":"getOutboundDnclists","produces":["application/json"],"parameters":[{"name":"includeImportStatus","in":"query","description":"Import status","required":false,"type":"boolean","default":false},{"name":"includeSize","in":"query","description":"Include size","required":false,"type":"boolean","default":false},{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"allowEmptyResult","in":"query","description":"Whether to return an empty page when there are no results for that page","required":false,"type":"boolean","default":false},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"],"x-genesys-enum-members":[{"name":"Equals"},{"name":"RegEx"},{"name":"Contains"},{"name":"Prefix"},{"name":"LessThan"},{"name":"LessThanEqualTo"},{"name":"GreaterThan"},{"name":"GreaterThanEqualTo"},{"name":"BeginsWith"},{"name":"EndsWith"}]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"dncSourceType","in":"query","description":"DncSourceType","required":false,"type":"string","enum":["rds","dnc.com","gryphon"],"x-genesys-enum-members":[{"name":"rds"},{"name":"dnc.com"},{"name":"gryphon"}]},{"name":"divisionId","in":"query","description":"Division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DncListEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dncList:view"]},"x-purecloud-method-name":"getOutboundDnclists"},"post":{"tags":["Outbound"],"summary":"Create dialer DNC list","description":"","operationId":"postOutboundDnclists","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"DncList","required":true,"schema":{"$ref":"#/definitions/DncListCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DncList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","invalid.create":"","dnc.list.phone.columns.empty":"","max.entity.count.reached":"The maximum dnc list count has been reached.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","dnc.source.authentication.failed":"External dnc source was not able to authenticate.","dnc.source.server.error":"External dnc source returned an error condition","dnc.source.configuration.invalid":"The dnc source configuration is invalid","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dncList:add"]},"x-purecloud-method-name":"postOutboundDnclists"}},"/api/v2/journey/segments/{segmentId}":{"get":{"tags":["Journey"],"summary":"Retrieve a single segment.","description":"","operationId":"getJourneySegment","produces":["application/json"],"parameters":[{"name":"segmentId","in":"path","description":"ID of the segment.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JourneySegment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:segment:view"]},"x-purecloud-method-name":"getJourneySegment"},"delete":{"tags":["Journey"],"summary":"Delete a segment.","description":"","operationId":"deleteJourneySegment","produces":["application/json"],"parameters":[{"name":"segmentId","in":"path","description":"ID of the segment.","required":true,"type":"string"}],"responses":{"204":{"description":"Segment deleted."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:segment:delete"]},"x-purecloud-method-name":"deleteJourneySegment"},"patch":{"tags":["Journey"],"summary":"Update a segment.","description":"","operationId":"patchJourneySegment","produces":["application/json"],"parameters":[{"name":"segmentId","in":"path","description":"ID of the segment.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/PatchSegment"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JourneySegment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:segment:edit"]},"x-purecloud-method-name":"patchJourneySegment"}},"/api/v2/externalcontacts/conversations/{conversationId}":{"put":{"tags":["External Contacts"],"summary":"Associate/disassociate an external contact with a conversation","description":"To associate, supply a value for the externalContactId. To disassociate, do not include the property at all.","operationId":"putExternalcontactsConversation","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ConversationAssociation","required":true,"schema":{"$ref":"#/definitions/ConversationAssociation"}},{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"}],"responses":{"202":{"description":"Accepted - Processing association"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The JSON body of the request was not valid.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","eternal.contacts.invalid.entity.id":"The entity ID was invalid.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","conversation.association.communication.id.required":"The communication id is required"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"External contact is not found by conversation id.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:conversation:associate"]},"x-purecloud-method-name":"putExternalcontactsConversation"}},"/api/v2/identityproviders/purecloud":{"get":{"tags":["Identity Provider"],"summary":"Get PureCloud Identity Provider","description":"","operationId":"getIdentityprovidersPurecloud","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PureCloud"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersPurecloud"},"put":{"tags":["Identity Provider"],"summary":"Update/Create PureCloud Identity Provider","description":"","operationId":"putIdentityprovidersPurecloud","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/PureCloud"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.issuer.uri":"An issuer URI is required.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.target.url":"The target URL must be a valid HTTPS URL.","certificate.not.yet.valid":"The certificate is not yet valid.","certificate.invalid.base64":"Invalid base64 in certificate.","certificate.unparseable":"The certificate for provider cannot be parsed.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersPurecloud"},"delete":{"tags":["Identity Provider"],"summary":"Delete PureCloud Identity Provider","description":"","operationId":"deleteIdentityprovidersPurecloud","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersPurecloud"}},"/api/v2/orgauthorization/trustors/{trustorOrgId}/users":{"get":{"tags":["Organization Authorization"],"summary":"The list of users in the trustor organization (i.e. users granted access).","description":"","operationId":"getOrgauthorizationTrustorUsers","produces":["application/json"],"parameters":[{"name":"trustorOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustUserEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.trustor.permissions":"Missing required permission(s)","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:view"]},"x-purecloud-method-name":"getOrgauthorizationTrustorUsers"}},"/api/v2/telephony/providers/edges/{edgeId}/diagnostic/tracepath":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get networking-related information from an Edge for a target IP or host.","description":"","operationId":"getTelephonyProvidersEdgeDiagnosticTracepath","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge Id","required":true,"type":"string"}],"responses":{"200":{"description":"Request to get network diagnostic was successful.","schema":{"$ref":"#/definitions/EdgeNetworkDiagnosticResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"Request badly formed.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Couldn't find network diagnostic for given command","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgeDiagnosticTracepath"},"post":{"tags":["Telephony Providers Edge"],"summary":"Tracepath request command to collect networking-related information from an Edge for a target IP or host.","description":"","operationId":"postTelephonyProvidersEdgeDiagnosticTracepath","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge Id","required":true,"type":"string"},{"in":"body","name":"body","description":"request payload to get network diagnostic","required":true,"schema":{"$ref":"#/definitions/EdgeNetworkDiagnosticRequest"}}],"responses":{"202":{"description":"Request to get network diagnostic has been accepted","schema":{"$ref":"#/definitions/EdgeNetworkDiagnostic"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgeDiagnosticTracepath"}},"/api/v2/telephony/providers/edges/{edgeId}/diagnostic/nslookup":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get networking-related information from an Edge for a target IP or host.","description":"","operationId":"getTelephonyProvidersEdgeDiagnosticNslookup","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge Id","required":true,"type":"string"}],"responses":{"200":{"description":"Request to get network diagnostic was successful.","schema":{"$ref":"#/definitions/EdgeNetworkDiagnosticResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"Request is badly formed.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Couldn't find network diagnostic for given command","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgeDiagnosticNslookup"},"post":{"tags":["Telephony Providers Edge"],"summary":"Nslookup request command to collect networking-related information from an Edge for a target IP or host.","description":"","operationId":"postTelephonyProvidersEdgeDiagnosticNslookup","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge Id","required":true,"type":"string"},{"in":"body","name":"body","description":"request payload to get network diagnostic","required":true,"schema":{"$ref":"#/definitions/EdgeNetworkDiagnosticRequest"}}],"responses":{"202":{"description":"Request to get network diagnostic has been accepted","schema":{"$ref":"#/definitions/EdgeNetworkDiagnostic"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"Request is badly formed.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgeDiagnosticNslookup"}},"/api/v2/telephony/providers/edges/{edgeId}/diagnostic/route":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get networking-related information from an Edge for a target IP or host.","description":"","operationId":"getTelephonyProvidersEdgeDiagnosticRoute","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge Id","required":true,"type":"string"}],"responses":{"200":{"description":"Request to get network diagnostic was successful.","schema":{"$ref":"#/definitions/EdgeNetworkDiagnosticResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Couldn't find network diagnostic for given command","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgeDiagnosticRoute"},"post":{"tags":["Telephony Providers Edge"],"summary":"Route request command to collect networking-related information from an Edge for a target IP or host.","description":"","operationId":"postTelephonyProvidersEdgeDiagnosticRoute","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge Id","required":true,"type":"string"},{"in":"body","name":"body","description":"request payload to get network diagnostic","required":true,"schema":{"$ref":"#/definitions/EdgeNetworkDiagnosticRequest"}}],"responses":{"202":{"description":"Request to get network diagnostic has been accepted","schema":{"$ref":"#/definitions/EdgeNetworkDiagnostic"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgeDiagnosticRoute"}},"/api/v2/telephony/providers/edges/{edgeId}/diagnostic/ping":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get networking-related information from an Edge for a target IP or host.","description":"","operationId":"getTelephonyProvidersEdgeDiagnosticPing","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge Id","required":true,"type":"string"}],"responses":{"200":{"description":"Request to get network diagnostic was successful.","schema":{"$ref":"#/definitions/EdgeNetworkDiagnosticResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"Request is badly formed.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Couldn't find network diagnostic for given command","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgeDiagnosticPing"},"post":{"tags":["Telephony Providers Edge"],"summary":"Ping Request command to collect networking-related information from an Edge for a target IP or host.","description":"","operationId":"postTelephonyProvidersEdgeDiagnosticPing","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge Id","required":true,"type":"string"},{"in":"body","name":"body","description":"request payload to get network diagnostic","required":true,"schema":{"$ref":"#/definitions/EdgeNetworkDiagnosticRequest"}}],"responses":{"202":{"description":"Request to get network diagnostic has been accepted","schema":{"$ref":"#/definitions/EdgeNetworkDiagnostic"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgeDiagnosticPing"}},"/api/v2/routing/sms/addresses":{"get":{"tags":["Routing"],"summary":"Get a list of Addresses for SMS","description":"","operationId":"getRoutingSmsAddresses","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SmsAddressEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:view"]},"x-purecloud-method-name":"getRoutingSmsAddresses"},"post":{"tags":["Routing"],"summary":"Provision an Address for SMS","description":"","operationId":"postRoutingSmsAddresses","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"SmsAddress","required":true,"schema":{"$ref":"#/definitions/SmsAddressProvision"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SmsAddress"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.address":"The address you have provided cannot be validated. This may be due to spelling error or that the address is not available in a third-party data source for validation.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:add"]},"x-purecloud-method-name":"postRoutingSmsAddresses"}},"/api/v2/users/{userId}/password":{"post":{"tags":["Users"],"summary":"Change a users password","description":"","operationId":"postUserPassword","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Password","required":true,"schema":{"$ref":"#/definitions/ChangePasswordRequest"}}],"responses":{"204":{"description":"Password changed"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.new.password":"The new password does not meet policy requirements","invalid.password":"The new password does not meet policy requirements","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a user with that userId","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:setPassword"]},"x-purecloud-method-name":"postUserPassword"}},"/api/v2/architect/schedulegroups":{"get":{"tags":["Architect"],"summary":"Get a list of schedule groups.","description":"","operationId":"getArchitectSchedulegroups","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"name","in":"query","description":"Name of the Schedule Group to filter by.","required":false,"type":"string"},{"name":"scheduleIds","in":"query","description":"A comma-delimited list of Schedule IDs to filter by.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScheduleGroupEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:scheduleGroup:view"]},"x-purecloud-method-name":"getArchitectSchedulegroups"},"post":{"tags":["Architect"],"summary":"Creates a new schedule group","description":"","operationId":"postArchitectSchedulegroups","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/ScheduleGroup"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScheduleGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:scheduleGroup:add"]},"x-purecloud-method-name":"postArchitectSchedulegroups"}},"/api/v2/routing/sms/phonenumbers":{"get":{"tags":["Routing"],"summary":"Get a list of provisioned phone numbers.","description":"","operationId":"getRoutingSmsPhonenumbers","produces":["application/json"],"parameters":[{"name":"phoneNumber","in":"query","description":"Filter on phone number address. Allowable characters are the digits '0-9' and the wild card character '\\*'. If just digits are present, a contains search is done on the address pattern. For example, '317' could be matched anywhere in the address. An '\\*' will match multiple digits. For example, to match a specific area code within the US a pattern like '1317*' could be used.","required":false,"type":"string"},{"name":"phoneNumberType","in":"query","description":"Filter on phone number type","required":false,"type":"string","enum":["local","mobile","tollfree","shortcode"],"x-genesys-enum-members":[{"name":"local"},{"name":"mobile"},{"name":"tollfree"},{"name":"shortcode"}]},{"name":"phoneNumberStatus","in":"query","description":"Filter on phone number status","required":false,"type":"string","enum":["active","invalid","porting"],"x-genesys-enum-members":[{"name":"active"},{"name":"invalid"},{"name":"porting"}]},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SmsPhoneNumberEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:view"]},"x-purecloud-method-name":"getRoutingSmsPhonenumbers"},"post":{"tags":["Routing"],"summary":"Provision a phone number for SMS","description":"","operationId":"postRoutingSmsPhonenumbers","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"SmsPhoneNumber","required":true,"schema":{"$ref":"#/definitions/SmsPhoneNumberProvision"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SmsPhoneNumber"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"requires.verified.identity.document":"This phone number requires a verified identity document, which is not supported.","requires.local.address":"Phone number associated with the country code requires a local address. To provision this number you must have an Address on your account which satisfies the local address requirements.","invalid.short.code.operation":"Phone number Provision operation not allowed for phone number of type shortcode.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","requires.an.address":"The country associated with this phone number requires an address on file. To provision this number you must have an Address on your account.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","phone.number.requires.a.bundle":"This phone number cannot be provisioned without an identity document, which is not supported.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Bad request provisioning phone number for SMS","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:add"]},"x-purecloud-method-name":"postRoutingSmsPhonenumbers"}},"/api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}":{"get":{"tags":["WebChat"],"summary":"Get a web chat conversation member","description":"","operationId":"getWebchatGuestConversationMember","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"memberId","in":"path","description":"memberId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatMemberInfo"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"credentials.expired":"The supplied credentials are expired and cannot be used.","authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.not.found":"The web chat conversation member was not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","chat.error":"Error handing chat conversation operation."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"Guest Chat JWT":[]}],"x-purecloud-method-name":"getWebchatGuestConversationMember"},"delete":{"tags":["WebChat"],"summary":"Remove a member from a chat conversation","description":"","operationId":"deleteWebchatGuestConversationMember","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"memberId","in":"path","description":"memberId","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","chat.error.conversation.state":"The conversation is in a state which does not permit this action.","chat.error.member.state":"The conversation member is in a state which does not permit this action."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"credentials.expired":"The supplied credentials are expired and cannot be used.","authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","chat.error":"Error handing chat conversation operation"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"Guest Chat JWT":[]}],"x-purecloud-method-name":"deleteWebchatGuestConversationMember"}},"/api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}/typing":{"post":{"tags":["WebChat"],"summary":"Send a typing-indicator in a chat conversation.","description":"","operationId":"postWebchatGuestConversationMemberTyping","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"memberId","in":"path","description":"memberId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatTyping"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","chat.error.conversation.state":"The conversation is in a state which does not permit this action.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","chat.error.member.state":"The conversation member is in a state which does not permit this action.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"credentials.expired":"The supplied credentials are expired and cannot be used.","authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.internal":"Internal chat error","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","chat.error":"Error handing chat conversation typing operation."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"Guest Chat JWT":[]}],"x-purecloud-method-name":"postWebchatGuestConversationMemberTyping"}},"/api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}/messages":{"post":{"tags":["WebChat"],"summary":"Send a message in a chat conversation.","description":"","operationId":"postWebchatGuestConversationMemberMessages","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"memberId","in":"path","description":"memberId","required":true,"type":"string"},{"in":"body","name":"body","description":"Message","required":true,"schema":{"$ref":"#/definitions/CreateWebChatMessageRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.notnull.createconversationmessagerequest.body":"The request body may not be null.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","chat.error.conversation.state":"The conversation is in a state which does not permit this action.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","chat.error.member.state":"The conversation member is in a state which does not permit this action.","chat.error.bad.request":"Error occurred due to invalid request.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"credentials.expired":"The supplied credentials are expired and cannot be used.","authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","chat.error":"Error handing chat conversation messages operation."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"Guest Chat JWT":[]}],"x-purecloud-method-name":"postWebchatGuestConversationMemberMessages"}},"/api/v2/users/{userId}/roles":{"get":{"tags":["Authorization","Users"],"summary":"Returns a listing of roles and permissions for a user.","description":"","operationId":"getUserRoles","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserAuthorization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:view"]},"x-purecloud-method-name":"getUserRoles"},"put":{"tags":["Authorization","Users"],"summary":"Sets the user's roles","description":"","operationId":"putUserRoles","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"List of roles","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserAuthorization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be processed due to invalid request data.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find an active user with that ID in this organization.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"The service is currently unavailable."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:add"]},"x-purecloud-method-name":"putUserRoles"}},"/api/v2/groups/{groupId}":{"get":{"tags":["Groups"],"summary":"Get group","description":"","operationId":"getGroup","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Group"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a group with that groupId","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups","groups:readonly"]}],"x-purecloud-method-name":"getGroup"},"put":{"tags":["Groups"],"summary":"Update group","description":"","operationId":"putGroup","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Group","required":false,"schema":{"$ref":"#/definitions/GroupUpdate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Group"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request is badly formed.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Resource conflict - Unexpected version was provided"},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:edit"]},"x-purecloud-method-name":"putGroup"},"delete":{"tags":["Groups"],"summary":"Delete group","description":"","operationId":"deleteGroup","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Specified group not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["groups"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:delete"]},"x-purecloud-method-name":"deleteGroup"}},"/api/v2/notifications/availabletopics":{"get":{"tags":["Notifications"],"summary":"Get available notification topics.","description":"","operationId":"getNotificationsAvailabletopics","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["description","enforced","schema","visibility","transports","publicApiTemplateUriPaths","requiresPermissions","permissionDetails"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"description"},{"name":"enforced"},{"name":"schema"},{"name":"visibility"},{"name":"transports"},{"name":"publicApiTemplateUriPaths"},{"name":"requiresPermissions"},{"name":"permissionDetails"}]},{"name":"includePreview","in":"query","description":"Whether or not to include Preview topics","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AvailableTopicEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["notifications"]}],"x-purecloud-method-name":"getNotificationsAvailabletopics"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}":{"get":{"tags":["Workforce Management"],"summary":"Get management unit","description":"settings.shortTermForecasting is deprecated and now lives on the business unit","operationId":"getWorkforcemanagementManagementunit","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"expand","in":"query","required":false,"type":"array","items":{"type":"string","enum":["settings","settings.adherence","settings.timeOff","settings.scheduling","settings.shortTermForecasting","settings.shiftTrading"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"settings"},{"name":"settings.adherence"},{"name":"settings.timeOff"},{"name":"settings.scheduling"},{"name":"settings.shortTermForecasting"},{"name":"settings.shiftTrading"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ManagementUnit"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.server.error":"WFM Server Error","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:activityCode:add","wfm:activityCode:delete","wfm:activityCode:edit","wfm:activityCode:view","wfm:agent:edit","wfm:agentSchedule:view","wfm:agentTimeOffRequest:submit","wfm:agent:view","wfm:businessUnit:add","wfm:businessUnit:delete","wfm:businessUnit:edit","wfm:businessUnit:view","wfm:historicalAdherence:view","wfm:intraday:view","wfm:managementUnit:add","wfm:managementUnit:delete","wfm:managementUnit:edit","wfm:managementUnit:view","wfm:publishedSchedule:view","wfm:realtimeAdherence:view","wfm:schedule:add","wfm:schedule:delete","wfm:schedule:edit","wfm:schedule:generate","wfm:schedule:view","wfm:serviceGoalTemplate:add","wfm:serviceGoalTemplate:delete","wfm:serviceGoalTemplate:edit","wfm:serviceGoalTemplate:view","wfm:planningGroup:add","wfm:planningGroup:delete","wfm:planningGroup:edit","wfm:planningGroup:view","wfm:shiftTradeRequest:edit","wfm:shiftTradeRequest:view","wfm:agentShiftTradeRequest:participate","wfm:shortTermForecast:add","wfm:shortTermForecast:delete","wfm:shortTermForecast:edit","wfm:shortTermForecast:view","wfm:timeOffRequest:add","wfm:timeOffRequest:edit","wfm:timeOffRequest:view","wfm:workPlan:add","wfm:workPlan:delete","wfm:workPlan:edit","wfm:workPlan:view","wfm:workPlanRotation:add","wfm:workPlanRotation:delete","wfm:workPlanRotation:edit","wfm:workPlanRotation:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunit"},"delete":{"tags":["Workforce Management"],"summary":"Delete management unit","description":"","operationId":"deleteWorkforcemanagementManagementunit","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"}],"responses":{"204":{"description":"The management unit was successfully deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:managementUnit:delete"]},"x-purecloud-method-name":"deleteWorkforcemanagementManagementunit"},"patch":{"tags":["Workforce Management"],"summary":"Update the requested management unit","description":"","operationId":"patchWorkforcemanagementManagementunit","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/UpdateManagementUnitRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ManagementUnit"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.missing.one.of.permission.sets":"Unable to perform the requested action. You must have access to the division of the business unit or all requested management units containing permission sets.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Entity was modified by another request"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:managementUnit:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementManagementunit"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/move":{"post":{"tags":["Workforce Management"],"summary":"Move the requested management unit to a new business unit","description":"Returns status 200 if the management unit is already in the requested business unit","operationId":"postWorkforcemanagementManagementunitMove","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/MoveManagementUnitRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MoveManagementUnitResponse"}},"202":{"description":"The management unit is being moved","schema":{"$ref":"#/definitions/MoveManagementUnitResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.business.unit.not.found":"Business unit not found","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.missing.one.of.permission.sets":"Unable to perform the requested action. You must have access to the division of the business unit or all requested management units containing permission sets.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:managementUnit:edit"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitMove"}},"/api/v2/architect/dependencytracking/deletedresourceconsumers":{"get":{"tags":["Architect"],"summary":"Get Dependency Tracking objects that consume deleted resources","description":"","operationId":"getArchitectDependencytrackingDeletedresourceconsumers","produces":["application/json"],"parameters":[{"name":"name","in":"query","description":"Name to search for","required":false,"type":"string"},{"name":"objectType","in":"query","description":"Object type(s) to search for","required":false,"type":"array","items":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","BOTCONNECTORBOT","BOTCONNECTORBOTVERSION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GROUP","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","IVRCONFIGURATION","LANGUAGE","LEXBOT","LEXBOTALIAS","NLUDOMAIN","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","WIDGET","WORKFLOW"],"x-genesys-enum-members":[{"name":"ACDLANGUAGE"},{"name":"ACDSKILL"},{"name":"ACDWRAPUPCODE"},{"name":"BOTCONNECTORBOT"},{"name":"BOTCONNECTORBOTVERSION"},{"name":"BOTFLOW"},{"name":"BRIDGEACTION"},{"name":"COMMONMODULEFLOW"},{"name":"COMPOSERSCRIPT"},{"name":"CONTACTLIST"},{"name":"DATAACTION"},{"name":"DATATABLE"},{"name":"DIALOGENGINEBOT"},{"name":"DIALOGENGINEBOTVERSION"},{"name":"DIALOGFLOWAGENT"},{"name":"EMAILROUTE"},{"name":"EMERGENCYGROUP"},{"name":"FLOWACTION"},{"name":"FLOWDATATYPE"},{"name":"FLOWMILESTONE"},{"name":"FLOWOUTCOME"},{"name":"GROUP"},{"name":"INBOUNDCALLFLOW"},{"name":"INBOUNDCHATFLOW"},{"name":"INBOUNDEMAILFLOW"},{"name":"INBOUNDSHORTMESSAGEFLOW"},{"name":"INQUEUECALLFLOW"},{"name":"IVRCONFIGURATION"},{"name":"LANGUAGE"},{"name":"LEXBOT"},{"name":"LEXBOTALIAS"},{"name":"NLUDOMAIN"},{"name":"OUTBOUNDCALLFLOW"},{"name":"QUEUE"},{"name":"RECORDINGPOLICY"},{"name":"RESPONSE"},{"name":"SCHEDULE"},{"name":"SCHEDULEGROUP"},{"name":"SECUREACTION"},{"name":"SECURECALLFLOW"},{"name":"SURVEYINVITEFLOW"},{"name":"SYSTEMPROMPT"},{"name":"TTSENGINE"},{"name":"TTSVOICE"},{"name":"USER"},{"name":"USERPROMPT"},{"name":"WIDGET"},{"name":"WORKFLOW"}]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"ACDLANGUAGE"},{"name":"ACDSKILL"},{"name":"ACDWRAPUPCODE"},{"name":"BOTCONNECTORBOT"},{"name":"BOTCONNECTORBOTVERSION"},{"name":"BOTFLOW"},{"name":"BRIDGEACTION"},{"name":"COMMONMODULEFLOW"},{"name":"COMPOSERSCRIPT"},{"name":"CONTACTLIST"},{"name":"DATAACTION"},{"name":"DATATABLE"},{"name":"DIALOGENGINEBOT"},{"name":"DIALOGENGINEBOTVERSION"},{"name":"DIALOGFLOWAGENT"},{"name":"EMAILROUTE"},{"name":"EMERGENCYGROUP"},{"name":"FLOWACTION"},{"name":"FLOWDATATYPE"},{"name":"FLOWMILESTONE"},{"name":"FLOWOUTCOME"},{"name":"GROUP"},{"name":"INBOUNDCALLFLOW"},{"name":"INBOUNDCHATFLOW"},{"name":"INBOUNDEMAILFLOW"},{"name":"INBOUNDSHORTMESSAGEFLOW"},{"name":"INQUEUECALLFLOW"},{"name":"IVRCONFIGURATION"},{"name":"LANGUAGE"},{"name":"LEXBOT"},{"name":"LEXBOTALIAS"},{"name":"NLUDOMAIN"},{"name":"OUTBOUNDCALLFLOW"},{"name":"QUEUE"},{"name":"RECORDINGPOLICY"},{"name":"RESPONSE"},{"name":"SCHEDULE"},{"name":"SCHEDULEGROUP"},{"name":"SECUREACTION"},{"name":"SECURECALLFLOW"},{"name":"SURVEYINVITEFLOW"},{"name":"SYSTEMPROMPT"},{"name":"TTSENGINE"},{"name":"TTSVOICE"},{"name":"USER"},{"name":"USERPROMPT"},{"name":"WIDGET"},{"name":"WORKFLOW"}]},{"name":"flowFilter","in":"query","description":"Show only checkedIn or published flows","required":false,"type":"string","enum":["checkedIn","published"],"x-genesys-enum-members":[{"name":"checkedIn"},{"name":"published"}]},{"name":"consumedResources","in":"query","description":"Return consumed resources?","required":false,"type":"boolean","default":false},{"name":"consumedResourceType","in":"query","description":"Resource type(s) to return","required":false,"type":"array","items":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","BOTCONNECTORBOT","BOTCONNECTORBOTVERSION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GROUP","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","IVRCONFIGURATION","LANGUAGE","LEXBOT","LEXBOTALIAS","NLUDOMAIN","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","WIDGET","WORKFLOW"],"x-genesys-enum-members":[{"name":"ACDLANGUAGE"},{"name":"ACDSKILL"},{"name":"ACDWRAPUPCODE"},{"name":"BOTCONNECTORBOT"},{"name":"BOTCONNECTORBOTVERSION"},{"name":"BOTFLOW"},{"name":"BRIDGEACTION"},{"name":"COMMONMODULEFLOW"},{"name":"COMPOSERSCRIPT"},{"name":"CONTACTLIST"},{"name":"DATAACTION"},{"name":"DATATABLE"},{"name":"DIALOGENGINEBOT"},{"name":"DIALOGENGINEBOTVERSION"},{"name":"DIALOGFLOWAGENT"},{"name":"EMAILROUTE"},{"name":"EMERGENCYGROUP"},{"name":"FLOWACTION"},{"name":"FLOWDATATYPE"},{"name":"FLOWMILESTONE"},{"name":"FLOWOUTCOME"},{"name":"GROUP"},{"name":"INBOUNDCALLFLOW"},{"name":"INBOUNDCHATFLOW"},{"name":"INBOUNDEMAILFLOW"},{"name":"INBOUNDSHORTMESSAGEFLOW"},{"name":"INQUEUECALLFLOW"},{"name":"IVRCONFIGURATION"},{"name":"LANGUAGE"},{"name":"LEXBOT"},{"name":"LEXBOTALIAS"},{"name":"NLUDOMAIN"},{"name":"OUTBOUNDCALLFLOW"},{"name":"QUEUE"},{"name":"RECORDINGPOLICY"},{"name":"RESPONSE"},{"name":"SCHEDULE"},{"name":"SCHEDULEGROUP"},{"name":"SECUREACTION"},{"name":"SECURECALLFLOW"},{"name":"SURVEYINVITEFLOW"},{"name":"SYSTEMPROMPT"},{"name":"TTSENGINE"},{"name":"TTSVOICE"},{"name":"USER"},{"name":"USERPROMPT"},{"name":"WIDGET"},{"name":"WORKFLOW"}]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"ACDLANGUAGE"},{"name":"ACDSKILL"},{"name":"ACDWRAPUPCODE"},{"name":"BOTCONNECTORBOT"},{"name":"BOTCONNECTORBOTVERSION"},{"name":"BOTFLOW"},{"name":"BRIDGEACTION"},{"name":"COMMONMODULEFLOW"},{"name":"COMPOSERSCRIPT"},{"name":"CONTACTLIST"},{"name":"DATAACTION"},{"name":"DATATABLE"},{"name":"DIALOGENGINEBOT"},{"name":"DIALOGENGINEBOTVERSION"},{"name":"DIALOGFLOWAGENT"},{"name":"EMAILROUTE"},{"name":"EMERGENCYGROUP"},{"name":"FLOWACTION"},{"name":"FLOWDATATYPE"},{"name":"FLOWMILESTONE"},{"name":"FLOWOUTCOME"},{"name":"GROUP"},{"name":"INBOUNDCALLFLOW"},{"name":"INBOUNDCHATFLOW"},{"name":"INBOUNDEMAILFLOW"},{"name":"INBOUNDSHORTMESSAGEFLOW"},{"name":"INQUEUECALLFLOW"},{"name":"IVRCONFIGURATION"},{"name":"LANGUAGE"},{"name":"LEXBOT"},{"name":"LEXBOTALIAS"},{"name":"NLUDOMAIN"},{"name":"OUTBOUNDCALLFLOW"},{"name":"QUEUE"},{"name":"RECORDINGPOLICY"},{"name":"RESPONSE"},{"name":"SCHEDULE"},{"name":"SCHEDULEGROUP"},{"name":"SECUREACTION"},{"name":"SECURECALLFLOW"},{"name":"SURVEYINVITEFLOW"},{"name":"SYSTEMPROMPT"},{"name":"TTSENGINE"},{"name":"TTSVOICE"},{"name":"USER"},{"name":"USERPROMPT"},{"name":"WIDGET"},{"name":"WORKFLOW"}]},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DependencyObjectEntityListing"}},"206":{"description":"Partial Content - the org data is being rebuilt or needs to be rebuilt."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.dependency.invalid.filter":"An invalid filter was specified.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","architect.dependency.object.invalid.type":"An invalid dependency object type was specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","architect.database.throughput.exceeded":"Database too busy. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:dependencyTracking:view"]},"x-purecloud-method-name":"getArchitectDependencytrackingDeletedresourceconsumers"}},"/api/v2/routing/skills":{"get":{"tags":["Routing"],"summary":"Get the list of routing skills.","description":"","operationId":"getRoutingSkills","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Filter for results that start with this value","required":false,"type":"string"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SkillEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-purecloud-method-name":"getRoutingSkills"},"post":{"tags":["Routing"],"summary":"Create Skill","description":"","operationId":"postRoutingSkills","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Skill","required":true,"schema":{"$ref":"#/definitions/RoutingSkill"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RoutingSkill"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","general.conflict":"The request could not be completed by the server due to a conflict."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be completed by the server due to a conflict."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:manage"]},"x-purecloud-method-name":"postRoutingSkills"}},"/api/v2/orgauthorization/trustors":{"get":{"tags":["Organization Authorization"],"summary":"The list of organizations that have authorized/trusted your organization.","description":"","operationId":"getOrgauthorizationTrustors","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustorEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrustor:view"]},"x-purecloud-method-name":"getOrgauthorizationTrustors"}},"/api/v2/quality/spotability":{"post":{"tags":["Quality"],"summary":"Retrieve the spotability statistic","description":"","operationId":"postQualitySpotability","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Keyword Set","required":false,"schema":{"$ref":"#/definitions/KeywordSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KeywordSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-purecloud-method-name":"postQualitySpotability"}},"/api/v2/outbound/events/{eventId}":{"get":{"tags":["Outbound"],"summary":"Get Dialer Event","description":"","operationId":"getOutboundEvent","produces":["application/json"],"parameters":[{"name":"eventId","in":"path","description":"Event Log ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EventLog"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:eventLog:view"]},"x-purecloud-method-name":"getOutboundEvent"}},"/api/v2/telephony/providers/edges/{edgeId}/logs/jobs":{"post":{"tags":["Telephony Providers Edge"],"summary":"Create a job to upload a list of Edge logs.","description":"","operationId":"postTelephonyProvidersEdgeLogsJobs","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"in":"body","name":"body","description":"EdgeLogsJobRequest","required":true,"schema":{"$ref":"#/definitions/EdgeLogsJobRequest"}}],"responses":{"202":{"description":"Accepted - Job is being processed. The job ID is returned.","schema":{"$ref":"#/definitions/EdgeLogsJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgeLogsJobs"}},"/api/v2/contentmanagement/workspaces/{workspaceId}":{"get":{"tags":["Content Management"],"summary":"Get a workspace.","description":"","operationId":"getContentmanagementWorkspace","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["summary","acl"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"summary"},{"name":"acl"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Workspace"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden from getting a workspace."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementWorkspace"},"put":{"tags":["Content Management"],"summary":"Update a workspace","description":"","operationId":"putContentmanagementWorkspace","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Workspace","required":true,"schema":{"$ref":"#/definitions/Workspace"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Workspace"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden to update a workspace."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"putContentmanagementWorkspace"},"delete":{"tags":["Content Management"],"summary":"Delete a workspace","description":"","operationId":"deleteContentmanagementWorkspace","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"moveChildrenToWorkspaceId","in":"query","description":"New location for objects in deleted workspace.","required":false,"type":"string"}],"responses":{"202":{"description":"Accepted - Processing Delete"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden from deleting a workspace."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"deleteContentmanagementWorkspace"}},"/api/v2/telephony/providers/edges/{edgeId}/logs/jobs/{jobId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get an Edge logs job.","description":"","operationId":"getTelephonyProvidersEdgeLogsJob","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"jobId","in":"path","description":"Job ID","required":true,"type":"string"}],"responses":{"200":{"description":"Edge log list has been returned in the response.","schema":{"$ref":"#/definitions/EdgeLogsJob"}},"202":{"description":"Accepted - Processing Edge logs job, try again soon."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find the Edge logs job by given Id.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgeLogsJob"}},"/api/v2/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType}/{schemaId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a json schema (Deprecated)","description":"","operationId":"getConfigurationSchemasEdgesVnextSchemaCategorySchemaTypeSchemaId","produces":["application/json"],"parameters":[{"name":"schemaCategory","in":"path","description":"Schema category","required":true,"type":"string"},{"name":"schemaType","in":"path","description":"Schema type","required":true,"type":"string"},{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Organization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getConfigurationSchemasEdgesVnextSchemaCategorySchemaTypeSchemaId"}},"/api/v2/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType}/{schemaId}/{extensionType}/{metadataId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get metadata for a schema (Deprecated)","description":"","operationId":"getConfigurationSchemasEdgesVnextSchemaCategorySchemaTypeSchemaIdExtensionTypeMetadataId","produces":["application/json"],"parameters":[{"name":"schemaCategory","in":"path","description":"Schema category","required":true,"type":"string"},{"name":"schemaType","in":"path","description":"Schema type","required":true,"type":"string"},{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"},{"name":"extensionType","in":"path","description":"extension","required":true,"type":"string"},{"name":"metadataId","in":"path","description":"Metadata ID","required":true,"type":"string"},{"name":"type","in":"query","description":"Type","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Organization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getConfigurationSchemasEdgesVnextSchemaCategorySchemaTypeSchemaIdExtensionTypeMetadataId"}},"/api/v2/webchat/guest/conversations/{conversationId}/messages":{"get":{"tags":["WebChat"],"summary":"Get the messages of a chat conversation.","description":"","operationId":"getWebchatGuestConversationMessages","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"after","in":"query","description":"If available, get the messages chronologically after the id of this message","required":false,"type":"string"},{"name":"before","in":"query","description":"If available, get the messages chronologically before the id of this message","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ascending","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]},{"name":"maxResults","in":"query","description":"Limit the returned number of messages, up to a maximum of 100","required":false,"type":"integer","default":100,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatMessageEntityList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"Guest Chat JWT":[]}],"x-purecloud-method-name":"getWebchatGuestConversationMessages"}},"/api/v2/telephony/providers/edges/lines/template":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Line instance template based on a Line Base Settings object. This object can then be modified and saved as a new Line instance","description":"","operationId":"getTelephonyProvidersEdgesLinesTemplate","produces":["application/json"],"parameters":[{"name":"lineBaseSettingsId","in":"query","description":"The id of a Line Base Settings object upon which to base this Line","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Line"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a line with that id","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesLinesTemplate"}},"/api/v2/contentmanagement/status/{statusId}":{"get":{"tags":["Content Management"],"summary":"Get a status.","description":"","operationId":"getContentmanagementStatusStatusId","produces":["application/json"],"parameters":[{"name":"statusId","in":"path","description":"Status ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CommandStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementStatusStatusId"},"delete":{"tags":["Content Management"],"summary":"Cancel the command for this status","description":"","operationId":"deleteContentmanagementStatusStatusId","produces":["application/json"],"parameters":[{"name":"statusId","in":"path","description":"Status ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"deleteContentmanagementStatusStatusId"}},"/api/v2/billing/reports/billableusage":{"get":{"tags":["Billing"],"summary":"Get a report of the billable license usages","description":"Report is of the billable usages (e.g. licenses and devices utilized) for a given period. If response's status is InProgress, wait a few seconds, then try the same request again.","operationId":"getBillingReportsBillableusage","produces":["application/json"],"parameters":[{"name":"startDate","in":"query","description":"The period start date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","required":true,"type":"string","format":"date-time"},{"name":"endDate","in":"query","description":"The period end date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","required":true,"type":"string","format":"date-time"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BillingUsageReport"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"error":"An internal server error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["billing","billing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["billing:subscription:read","billing:subscription:view"]},"x-purecloud-method-name":"getBillingReportsBillableusage"}},"/api/v2/telephony/providers/edges/trunks":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of available trunks.","description":"Trunks are created by assigning trunk base settings to an Edge or Edge Group.","operationId":"getTelephonyProvidersEdgesTrunks","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Value by which to sort","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"edge.id","in":"query","description":"Filter by Edge Ids","required":false,"type":"string"},{"name":"trunkBase.id","in":"query","description":"Filter by Trunk Base Ids","required":false,"type":"string"},{"name":"trunkType","in":"query","description":"Filter by a Trunk type","required":false,"type":"string","enum":["EXTERNAL","PHONE","EDGE"],"x-genesys-enum-members":[{"name":"EXTERNAL"},{"name":"PHONE"},{"name":"EDGE"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Available Trunk resources not found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesTrunks"}},"/api/v2/telephony/providers/edges/edgegroups/{edgeGroupId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get edge group.","description":"","operationId":"getTelephonyProvidersEdgesEdgegroup","produces":["application/json"],"parameters":[{"name":"edgeGroupId","in":"path","description":"Edge group ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Fields to expand in the response","required":false,"type":"array","items":{"type":"string","enum":["phoneTrunkBases","edgeTrunkBaseAssignment"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"phoneTrunkBases"},{"name":"edgeTrunkBaseAssignment"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Edge group was not found.","general.resource.not.found":"Edge group was not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesEdgegroup"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update an edge group.","description":"","operationId":"putTelephonyProvidersEdgesEdgegroup","produces":["application/json"],"parameters":[{"name":"edgeGroupId","in":"path","description":"Edge group ID","required":true,"type":"string"},{"in":"body","name":"body","description":"EdgeGroup","required":true,"schema":{"$ref":"#/definitions/EdgeGroup"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"required.field.missing":"A required field is missing a value.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.value":"An edge group with this name already exists.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","managed.property.not.allowed":"Not allowed to update managed property."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesEdgegroup"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete an edge group.","description":"","operationId":"deleteTelephonyProvidersEdgesEdgegroup","produces":["application/json"],"parameters":[{"name":"edgeGroupId","in":"path","description":"Edge group ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","general.bad.request":"The request could not be understood by the server due to malformed syntax."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Edge group was not found.","general.resource.not.found":"Edge group was not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdgesEdgegroup"}},"/api/v2/externalcontacts/contacts/schemas/{schemaId}/versions":{"get":{"tags":["External Contacts"],"summary":"Get all versions of an external contact's schema","description":"","operationId":"getExternalcontactsContactsSchemaVersions","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"The schema to expand has parse errors"}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getExternalcontactsContactsSchemaVersions"}},"/api/v2/users/{userId}/queues":{"get":{"tags":["Routing","Users"],"summary":"Get queues for user","description":"","operationId":"getUserQueues","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"joined","in":"query","description":"Is joined to the queue","required":false,"type":"boolean","default":true},{"name":"divisionId","in":"query","description":"Division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserQueueEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:view","routing:queue:join","routing:queueMember:manage"]},"x-purecloud-method-name":"getUserQueues"},"patch":{"tags":["Routing","Users"],"summary":"Join or unjoin a set of queues for a user","description":"","operationId":"patchUserQueues","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"User Queues","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/UserQueue"}}},{"name":"divisionId","in":"query","description":"Division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserQueueEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be processed due to invalid request data.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:join","routing:queueMember:manage"]},"x-purecloud-method-name":"patchUserQueues"}},"/api/v2/flows":{"get":{"tags":["Architect"],"summary":"Get a pageable list of flows, filtered by query parameters","description":"If one or more IDs are specified, the search will fetch flows that match the given ID(s) and not use any additional supplied query parameters in the search.","operationId":"getFlows","produces":["application/json"],"parameters":[{"name":"type","in":"query","description":"Type","required":false,"type":"array","items":{"type":"string","enum":["bot","commonmodule","inboundcall","inboundchat","inboundemail","inboundshortmessage","outboundcall","inqueuecall","speech","securecall","surveyinvite","workflow"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"bot"},{"name":"commonmodule"},{"name":"inboundcall"},{"name":"inboundchat"},{"name":"inboundemail"},{"name":"inboundshortmessage"},{"name":"outboundcall"},{"name":"inqueuecall"},{"name":"speech"},{"name":"securecall"},{"name":"surveyinvite"},{"name":"workflow"}]},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"id"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc"},{"name":"id","in":"query","description":"ID","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"description","in":"query","description":"Description","required":false,"type":"string"},{"name":"nameOrDescription","in":"query","description":"Name or description","required":false,"type":"string"},{"name":"publishVersionId","in":"query","description":"Publish version ID","required":false,"type":"string"},{"name":"editableBy","in":"query","description":"Editable by","required":false,"type":"string"},{"name":"lockedBy","in":"query","description":"Locked by","required":false,"type":"string"},{"name":"lockedByClientId","in":"query","description":"Locked by client ID","required":false,"type":"string"},{"name":"secure","in":"query","description":"Secure","required":false,"type":"string","enum":["any","checkedin","published"],"x-genesys-enum-members":[{"name":"any"},{"name":"checkedin"},{"name":"published"}]},{"name":"deleted","in":"query","description":"Include deleted","required":false,"type":"boolean","default":false},{"name":"includeSchemas","in":"query","description":"Include variable schemas","required":false,"type":"boolean","default":false},{"name":"publishedAfter","in":"query","description":"Published after","required":false,"type":"string","x-example":"2015-01-01T12:00:00-0600, 2015-01-01T18:00:00Z, 2015-01-01T12:00:00.000-0600, 2015-01-01T18:00:00.000Z, 2015-01-01"},{"name":"publishedBefore","in":"query","description":"Published before","required":false,"type":"string","x-example":"2015-01-01T12:00:00-0600, 2015-01-01T18:00:00Z, 2015-01-01T12:00:00.000-0600, 2015-01-01T18:00:00.000Z, 2015-01-01"},{"name":"divisionId","in":"query","description":"division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","architect.invalid.flow.type":"An invalid flow type was specified.","architect.division.invalid":"One or more of the division IDs are not valid.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.inbound.short.message.flow.invalid.operation":"Cannot perform requested operation on an inbound short message flow.","architect.workflow.invalid.operation":"Cannot perform requested operation on a workflow.","architect.speech.flow.invalid.operation":"Cannot perform requested operation on a speech flow.","architect.secure.call.flow.invalid.operation":"Cannot perform requested operation on a secure call flow.","architect.bot.flow.invalid.operation":"Cannot perform requested operation on a bot flow."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:view"]},"x-purecloud-method-name":"getFlows"},"post":{"tags":["Architect"],"summary":"Create flow","description":"","operationId":"postFlows","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Flow"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Flow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","architect.flow.validate.failed.invalid.name.contains.slash":"Failed to validate flow due to invalid name. Flow names must not contain forward slashes.","architect.flow.validate.failed.invalid.name.no.alpha":"Failed to validate flow due to invalid name. Names must contain at least one alphanumeric character.","bad.request":"The request could not be understood by the server due to malformed syntax.","architect.object.validate.failed":"Failed to validate object.","architect.flow.validate.failed.missing.type":"Failed to validate flow due to missing type.","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","architect.flow.validate.failed.invalid.name.contains.debug":"Failed to validate flow due to invalid name. Flow names must not end with '-debug'.","architect.flow.validate.failed":"Failed to validate flow.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","architect.flow.validate.failed.missing.name":"Failed to validate flow due to missing name."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.inbound.short.message.flow.invalid.operation":"Cannot perform requested operation on an inbound short message flow.","architect.workflow.invalid.operation":"Cannot perform requested operation on a workflow.","architect.speech.flow.invalid.operation":"Cannot perform requested operation on a speech flow.","architect.debug.flow.invalid.operation":"Cannot perform requested operation on a debug flow.","architect.secure.call.flow.invalid.operation":"Cannot perform requested operation on a secure call flow.","architect.bot.flow.invalid.operation":"Cannot perform requested operation on a bot flow.","architect.system.flow.cannot.create":"Users cannot create system flows.","architect.secure.call.flow.not.supported":"Secure call flows are not supported by the current product levels.","architect.survey.invite.flow.invalid.operation":"Cannot perform requested operation on a survey flow."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.already.exists":"A flow of the specified type with the specified name already exists."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:add"]},"x-purecloud-method-name":"postFlows"},"delete":{"tags":["Architect"],"summary":"Batch-delete a list of flows","description":"Multiple IDs can be specified, in which case all specified flows will be deleted. Asynchronous. Notification topic: v2.flows.{flowId}","operationId":"deleteFlows","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"List of Flow IDs","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Operation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","architect.batch.too.large":"Batch size exceeds the maximum allowable size.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","architect.batch.delete.failed":"At least one flow could not be deleted as requested.","architect.query.parameter.missing":"A required query parameter is missing or empty."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.operation.already.in.progress":"An operation is already in progress on the object."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.unspecified.error":"An unknown error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:delete"]},"x-purecloud-method-name":"deleteFlows"}},"/api/v2/presencedefinitions/{presenceId}":{"get":{"tags":["Presence"],"summary":"Get a Presence Definition","description":"","operationId":"getPresencedefinition","produces":["application/json"],"parameters":[{"name":"presenceId","in":"path","description":"Organization Presence ID","required":true,"type":"string"},{"name":"localeCode","in":"query","description":"The locale code to fetch for the presence definition. Use ALL to fetch everything.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationPresence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence","presence:readonly"]}],"x-purecloud-method-name":"getPresencedefinition"},"put":{"tags":["Presence"],"summary":"Update a Presence Definition","description":"","operationId":"putPresencedefinition","produces":["application/json"],"parameters":[{"name":"presenceId","in":"path","description":"Organization Presence ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The OrganizationPresence to update","required":true,"schema":{"$ref":"#/definitions/OrganizationPresence"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationPresence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["presence"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["presence:presenceDefinition:edit"]},"x-purecloud-method-name":"putPresencedefinition"},"delete":{"tags":["Presence"],"summary":"Delete a Presence Definition","description":"","operationId":"deletePresencedefinition","produces":["application/json"],"parameters":[{"name":"presenceId","in":"path","description":"Organization Presence ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["presence"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["presence:presenceDefinition:delete"]},"x-purecloud-method-name":"deletePresencedefinition"}},"/api/v2/conversations/emails":{"get":{"tags":["Conversations"],"summary":"Get active email conversations for the logged in user","description":"","operationId":"getConversationsEmails","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailConversationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsEmails"},"post":{"tags":["Conversations"],"summary":"Create an email conversation","description":"If the direction of the request is INBOUND, this will create an external conversation with a third party provider. If the direction of the the request is OUTBOUND, this will create a conversation to send outbound emails on behalf of a queue.","operationId":"postConversationsEmails","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Create email request","required":true,"schema":{"$ref":"#/definitions/CreateEmailRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.create.email.parameters":"One of queueId or flowId must be supplied.","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","postino.error.notnull.createconversationrequest.provider":"The provider property may not be null.","email.error.invalid.queue":"An invalid queue ID was specified.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","bad.flow.id":"Invalid flow ID was specified.","email.outbound.queue.address.required":"The queue does not have an outbound email address configured.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","postino.error.notnull.createconversationrequest.queueid":"The queueId property may not be null.","email.outbound.queue.required":"An outbound email conversation requires a queue ID."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:email:create"]},"x-purecloud-method-name":"postConversationsEmails"}},"/api/v2/conversations/emails/{conversationId}/participants/{participantId}/wrapupcodes":{"get":{"tags":["Conversations"],"summary":"Get list of wrapup codes for this conversation participant","description":"","operationId":"getConversationsEmailParticipantWrapupcodes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsEmailParticipantWrapupcodes"}},"/api/v2/conversations/emails/{conversationId}/messages":{"get":{"tags":["Conversations"],"summary":"Get conversation messages","description":"","operationId":"getConversationsEmailMessages","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailMessageListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.request.timeout":"The service timeout out waiting on a response.","authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsEmailMessages"},"post":{"tags":["Conversations"],"summary":"Send an email reply","description":"","operationId":"postConversationsEmailMessages","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Reply","required":true,"schema":{"$ref":"#/definitions/EmailMessage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.attachments.upload.size":"Upload too large.","email.error.external.provider":"Operation not supported on emails with external providers.","email.error.domain.not.verified":"The email domain has not been verified.","bad.request":"The request could not be understood by the server due to malformed syntax.","postino.error.reply.no.body":"Replies must have a textBody or htmlBody.","postino.error.reply.no.sender":"No connected internal participant found for the reply.","postino.error.reply.no.to":"Replies must have a to address.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","postino.error.reply.no.receiver":"No connected external participant found for the reply.","postino.error.reply.no.userid":"Reply emails must have a userId.","email.error.invalid.email":"Attempted to send an email with an invalid parameter.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","postino.error.forbidden":"User is not an active participant on the conversation."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.reply.sending":"Error sending an email reply."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.temporarily.unavailable":"The service is currently unavailable","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.request.timeout":"The request has timed out.","authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationsEmailMessages"}},"/api/v2/conversations/emails/{conversationId}/participants/{participantId}/attributes":{"patch":{"tags":["Conversations"],"summary":"Update the attributes on a conversation participant.","description":"","operationId":"patchConversationsEmailParticipantAttributes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant attributes","required":true,"schema":{"$ref":"#/definitions/ParticipantAttributes"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsEmailParticipantAttributes"}},"/api/v2/conversations/emails/{conversationId}/messages/draft":{"get":{"tags":["Conversations"],"summary":"Get conversation draft reply","description":"","operationId":"getConversationsEmailMessagesDraft","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","postino.error.org.missing":"OrganizationId header is required.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.get.message.body":"An error occurred retrieving a message body.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.temporarily.unavailable":"The service is currently unavailable","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsEmailMessagesDraft"},"put":{"tags":["Conversations"],"summary":"Update conversation draft reply","description":"","operationId":"putConversationsEmailMessagesDraft","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Draft","required":true,"schema":{"$ref":"#/definitions/EmailMessage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.external.provider":"Operation not supported on emails with external providers.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","postino.error.forbidden":"User is not an active participant on the conversation."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.temporarily.unavailable":"The service is currently unavailable","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"putConversationsEmailMessagesDraft"}},"/api/v2/conversations/emails/{conversationId}":{"get":{"tags":["Conversations"],"summary":"Get email conversation","description":"","operationId":"getConversationsEmail","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","postino.error.wrong.org":"Request organization is incorrect for this conversation.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsEmail"},"patch":{"tags":["Conversations"],"summary":"Update a conversation by disconnecting all of the participants","description":"","operationId":"patchConversationsEmail","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation","required":true,"schema":{"$ref":"#/definitions/Conversation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Conversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:disconnect"]},"x-purecloud-method-name":"patchConversationsEmail"}},"/api/v2/conversations/emails/{conversationId}/participants/{participantId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation participant. ","description":"","operationId":"getConversationsEmailParticipantWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsEmailParticipantWrapup"}},"/api/v2/conversations/emails/{conversationId}/messages/draft/attachments/{attachmentId}":{"delete":{"tags":["Conversations"],"summary":"Delete attachment from draft","description":"","operationId":"deleteConversationsEmailMessagesDraftAttachment","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"attachmentId","in":"path","description":"attachmentId","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","postino.error.org.missing":"OrganizationId header is required."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","postino.error.forbidden":"User is not an active participant on the conversation."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"deleteConversationsEmailMessagesDraftAttachment"}},"/api/v2/conversations/emails/{conversationId}/messages/draft/attachments/copy":{"post":{"tags":["Conversations"],"summary":"Copy attachments from an email message to the current draft.","description":"","operationId":"postConversationsEmailMessagesDraftAttachmentsCopy","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Copy Attachment Request","required":true,"schema":{"$ref":"#/definitions/CopyAttachmentsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.external.provider":"Operation not supported on emails with external providers.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","postino.error.bad.request":"The request could not be understood by the server due to malformed syntax.","postino.error.reply.no.userid":"Reply emails must have a userId.","postino.error.wrong.org":"Request organization is incorrect for this conversation.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","postino.error.forbidden":"User is not an active participant on the conversation."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationsEmailMessagesDraftAttachmentsCopy"}},"/api/v2/conversations/emails/{conversationId}/inboundmessages":{"post":{"tags":["Conversations"],"summary":"Send an email to an external conversation. An external conversation is one where the provider is not PureCloud based. This endpoint allows the sender of the external email to reply or send a new message to the existing conversation. The new message will be treated as part of the existing conversation and chained to it.","description":"","operationId":"postConversationsEmailInboundmessages","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Send external email reply","required":true,"schema":{"$ref":"#/definitions/InboundMessageRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","postino.error.notnull.createconversationrequest.provider":"The provider property may not be null.","email.error.invalid.queue":"An invalid queue ID was specified.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","email.error.internal.provider":"Operation not supported on emails with PureCloud providers","bad.flow.id":"Invalid flow ID was specified.","too.many.external.email.parameters":"Only one of queueId or flowId may be provided","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationsEmailInboundmessages"}},"/api/v2/conversations/emails/{conversationId}/participants/{participantId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant","description":"","operationId":"patchConversationsEmailParticipant","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Update request","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.participant.update.invalid":"Failed to update all properties on conversation participant.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","postino.error.answer.not.alerting":"Only alerting calls can be answered.","postino.error.transfer.canceled":"Answer failed because a pending attended transfer was canceled.","postino.error.wrong.org":"Request organization is incorrect for this conversation.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","conversation.error.participant.no.active.conversations":"The participant has no active conversation."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.participant.update.failed":"Failed to update all properties on conversation participant.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsEmailParticipant"}},"/api/v2/conversations/emails/{conversationId}/participants/{participantId}/communications/{communicationId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant's communication by disconnecting it.","description":"","operationId":"patchConversationsEmailParticipantCommunication","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"communication.state.required":"Can only update a communication's state to disconnected.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsEmailParticipantCommunication"}},"/api/v2/conversations/emails/{conversationId}/participants/{participantId}/replace":{"post":{"tags":["Conversations"],"summary":"Replace this participant with the specified user and/or address","description":"","operationId":"postConversationsEmailParticipantReplace","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Transfer request","required":true,"schema":{"$ref":"#/definitions/TransferRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversations.error.transfer.same.party":"The target of the transfer cannot be the same as the destination.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","conversations.error.queue.not.found":"Interaction cannot be transferred to a queue that does not exist.","conversations.error.transfer.not.connected":"You can only transfer conversations that are in the connected state.","postino.error.transfer.replace.external":"External participants may not be replaced.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","postino.error.transfer.not.connected":"Only connected participants can be transferred."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationsEmailParticipantReplace"}},"/api/v2/conversations/emails/{conversationId}/messages/{messageId}":{"get":{"tags":["Conversations"],"summary":"Get conversation message","description":"","operationId":"getConversationsEmailMessage","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"messageId","in":"path","description":"messageId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","postino.error.org.missing":"OrganizationId header is required.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.get.message.body":"An error occurred retrieving a message body.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.temporarily.unavailable":"The service is currently unavailable","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.request.timeout":"The service timeout out waiting on a response.","authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsEmailMessage"}},"/api/v2/workforcemanagement/notifications":{"get":{"tags":["Workforce Management"],"summary":"Get a list of notifications for the current user","description":"","operationId":"getWorkforcemanagementNotifications","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NotificationsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-purecloud-method-name":"getWorkforcemanagementNotifications"}},"/api/v2/workforcemanagement/notifications/update":{"post":{"tags":["Workforce Management"],"summary":"Mark a list of notifications as read or unread","description":"","operationId":"postWorkforcemanagementNotificationsUpdate","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/UpdateNotificationsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UpdateNotificationsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-purecloud-method-name":"postWorkforcemanagementNotificationsUpdate"}},"/api/v2/outbound/messagingcampaigns/divisionviews":{"get":{"tags":["Outbound"],"summary":"Query a list of basic Messaging Campaign information objects","description":"This returns a listing of simplified Messaging Campaigns, each consisting of id, name, and division.","operationId":"getOutboundMessagingcampaignsDivisionviews","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"The direction to sort","required":false,"type":"string","default":"a","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"senderSmsPhoneNumber","in":"query","description":"Sender SMS Phone Number","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingCampaignDivisionViewEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:messagingCampaign:search"]},"x-purecloud-method-name":"getOutboundMessagingcampaignsDivisionviews"}},"/api/v2/externalcontacts/organizations/{externalOrganizationId}":{"get":{"tags":["External Contacts"],"summary":"Fetch an external organization","description":"","operationId":"getExternalcontactsOrganization","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand (externalDataSources)","required":false,"type":"string","enum":["externalDataSources"],"x-genesys-enum-members":[{"name":"externalDataSources"}]},{"name":"includeTrustors","in":"query","description":"(true or false) whether or not to include trustor information embedded in the externalOrganization","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalOrganization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"External organization is not found by external organization id.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:view","externalContacts:externalOrganization:view"]},"x-purecloud-method-name":"getExternalcontactsOrganization"},"put":{"tags":["External Contacts"],"summary":"Update an external organization","description":"","operationId":"putExternalcontactsOrganization","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ExternalOrganization","required":true,"schema":{"$ref":"#/definitions/ExternalOrganization"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalOrganization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided contact was not valid"}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:edit","externalContacts:externalOrganization:edit"]},"x-purecloud-method-name":"putExternalcontactsOrganization"},"delete":{"tags":["External Contacts"],"summary":"Delete an external organization","description":"","operationId":"deleteExternalcontactsOrganization","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:delete","externalContacts:externalOrganization:delete"]},"x-purecloud-method-name":"deleteExternalcontactsOrganization"}},"/api/v2/languages":{"get":{"tags":["Languages"],"summary":"Get the list of supported languages. (Deprecated)","description":"This endpoint is deprecated. It has been moved to /routing/languages","operationId":"getLanguages","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ASC","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LanguageEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:manage"]},"x-purecloud-method-name":"getLanguages"},"post":{"tags":["Languages"],"summary":"Create Language (Deprecated)","description":"This endpoint is deprecated. It has been moved to /routing/languages","operationId":"postLanguages","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Language","required":true,"schema":{"$ref":"#/definitions/Language"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Language"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:manage"]},"x-purecloud-method-name":"postLanguages"}},"/api/v2/identityproviders/cic":{"get":{"tags":["Identity Provider"],"summary":"Get Customer Interaction Center (CIC) Identity Provider","description":"","operationId":"getIdentityprovidersCic","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CustomerInteractionCenter"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersCic"},"put":{"tags":["Identity Provider"],"summary":"Update/Create Customer Interaction Center (CIC) Identity Provider","description":"","operationId":"putIdentityprovidersCic","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/CustomerInteractionCenter"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.issuer.uri":"An issuer URI is required.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.target.url":"The target URL must be a valid HTTPS URL.","certificate.not.yet.valid":"The certificate is not yet valid.","certificate.invalid.base64":"Invalid base64 in certificate.","certificate.unparseable":"The certificate for provider cannot be parsed.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersCic"},"delete":{"tags":["Identity Provider"],"summary":"Delete Customer Interaction Center (CIC) Identity Provider","description":"","operationId":"deleteIdentityprovidersCic","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersCic"}},"/api/v2/analytics/queues/observations/query":{"post":{"tags":["Routing","Analytics"],"summary":"Query for queue observations","description":"","operationId":"postAnalyticsQueuesObservationsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/QueueObservationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueObservationQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"This user is not permitted to query for queue.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"An internal server error has occurred."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:queueObservation:view"]},"x-purecloud-method-name":"postAnalyticsQueuesObservationsQuery"}},"/api/v2/architect/dependencytracking/build":{"get":{"tags":["Architect"],"summary":"Get Dependency Tracking build status for an organization","description":"","operationId":"getArchitectDependencytrackingBuild","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DependencyStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:dependencyTracking:view"]},"x-purecloud-method-name":"getArchitectDependencytrackingBuild"},"post":{"tags":["Architect"],"summary":"Rebuild Dependency Tracking data for an organization","description":"Asynchronous. Notification topic: v2.architect.dependencytracking.build","operationId":"postArchitectDependencytrackingBuild","produces":["application/json"],"parameters":[],"responses":{"202":{"description":"Accepted - the rebuild has begun."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.admin.user":"The requesting user does not have the required Architect admin permission.","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.dependencies.build.in.progress":"A build of dependency information is already in progress."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:dependencyTracking:rebuild"]},"x-purecloud-method-name":"postArchitectDependencytrackingBuild"}},"/api/v2/identityproviders/generic":{"get":{"tags":["Identity Provider"],"summary":"Get Generic SAML Identity Provider","description":"","operationId":"getIdentityprovidersGeneric","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GenericSAML"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersGeneric"},"put":{"tags":["Identity Provider"],"summary":"Update/Create Generic SAML Identity Provider","description":"","operationId":"putIdentityprovidersGeneric","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/GenericSAML"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.provider.name":"The name for a generic SAML provider cannot be blank or empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","provider.logo.too.large":"The logo image size is greater than allowed value of 25kb.","invalid.target.url":"The target URL must be a valid HTTPS URL.","certificate.unparseable":"The certificate for provider cannot be parsed.","missing.issuer.uri":"An issuer URI is required.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","certificate.not.yet.valid":"The certificate is not yet valid.","invalid.nameid.format":"The name identifier format is invalid.","certificate.invalid.base64":"Invalid base64 in certificate.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersGeneric"},"delete":{"tags":["Identity Provider"],"summary":"Delete Generic SAML Identity Provider","description":"","operationId":"deleteIdentityprovidersGeneric","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersGeneric"}},"/api/v2/alerting/interactionstats/rules":{"get":{"tags":["Alerting"],"summary":"Get an interaction stats rule list.","description":"","operationId":"getAlertingInteractionstatsRules","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["notificationUsers"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"notificationUsers"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InteractionStatsRuleContainer"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting","alerting:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:rule:view"]},"x-purecloud-method-name":"getAlertingInteractionstatsRules"},"post":{"tags":["Alerting"],"summary":"Create an interaction stats rule.","description":"","operationId":"postAlertingInteractionstatsRules","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["notificationUsers"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"notificationUsers"}]},{"in":"body","name":"body","description":"AlertingRule","required":true,"schema":{"$ref":"#/definitions/InteractionStatsRule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InteractionStatsRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:rule:add"]},"x-purecloud-method-name":"postAlertingInteractionstatsRules"}},"/api/v2/flows/datatables":{"get":{"tags":["Architect"],"summary":"Retrieve a list of datatables for the org","description":"Returns a metadata list of the datatables associated with this org, including datatableId, name and description.","operationId":"getFlowsDatatables","produces":["application/json"],"parameters":[{"name":"expand","in":"query","description":"Expand instructions for the result","required":false,"type":"string","enum":["schema"],"x-genesys-enum-members":[{"name":"schema"}]},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"id","enum":["id","name"],"x-genesys-enum-members":[{"name":"id"},{"name":"name"}]},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ascending"},{"name":"divisionId","in":"query","description":"division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataTablesDomainEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","flows.datatables.syntax.error":"There was an error parsing user data","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:view"]},"x-purecloud-method-name":"getFlowsDatatables"},"post":{"tags":["Architect"],"summary":"Create a new datatable with the specified json-schema definition","description":"This will create a new datatable with fields that match the property definitions in the JSON schema. The schema's title field will be overridden by the name field in the DataTable object. See also http://json-schema.org/","operationId":"postFlowsDatatables","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"datatable json-schema","required":true,"schema":{"$ref":"#/definitions/DataTable"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataTable"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.too.many.properties":"The max number of properties allowed in a schema has been reached.","flows.datatables.schema.exception":"The schema is invalid in some way","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","flows.datatables.too.many.tables":"The max number of datatables allowed has been reached.","flows.datatables.syntax.error":"There was an error parsing user data","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.not.unique":"The passed in datatable had a duplicate name."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:add"]},"x-purecloud-method-name":"postFlowsDatatables"}},"/api/v2/oauth/clients/{clientId}/usage/summary":{"get":{"tags":["OAuth"],"summary":"Get a summary of OAuth client API usage","description":"After calling this method, you will then need to poll for the query results based on the returned execution Id","operationId":"getOauthClientUsageSummary","produces":["application/json"],"parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"type":"string"},{"name":"days","in":"query","description":"Previous number of days to query","required":false,"type":"string","default":"7"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UsageExecutionResult"}},"202":{"description":"Execution not completed, check back for results","schema":{"$ref":"#/definitions/UsageExecutionResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:view"]},"x-purecloud-method-name":"getOauthClientUsageSummary"}},"/api/v2/oauth/clients/{clientId}/usage/query":{"post":{"tags":["OAuth"],"summary":"Query for OAuth client API usage","description":"After calling this method, you will then need to poll for the query results based on the returned execution Id","operationId":"postOauthClientUsageQuery","produces":["application/json"],"parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Query","required":true,"schema":{"$ref":"#/definitions/ApiUsageQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UsageExecutionResult"}},"202":{"description":"Execution not completed, check back for results","schema":{"$ref":"#/definitions/UsageExecutionResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:view"]},"x-purecloud-method-name":"postOauthClientUsageQuery"}},"/api/v2/chat/settings":{"get":{"tags":["Chat"],"summary":"Get Chat Settings.","description":"","operationId":"getChatSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:setting:view","chat:setting:edit"]},"x-purecloud-method-name":"getChatSettings"},"put":{"tags":["Chat"],"summary":"Update Chat Settings.","description":"","operationId":"putChatSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Chat","required":true,"schema":{"$ref":"#/definitions/ChatSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:setting:edit"]},"x-purecloud-method-name":"putChatSettings"},"patch":{"tags":["Chat"],"summary":"Patch Chat Settings.","description":"","operationId":"patchChatSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Chat","required":true,"schema":{"$ref":"#/definitions/ChatSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["chat:setting:edit"]},"x-purecloud-method-name":"patchChatSettings"}},"/api/v2/greetings/defaults":{"get":{"tags":["Greetings"],"summary":"Get an Organization's DefaultGreetingList","description":"","operationId":"getGreetingsDefaults","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DefaultGreetingList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings","greetings:readonly"]}],"x-purecloud-method-name":"getGreetingsDefaults"},"put":{"tags":["Greetings"],"summary":"Update an Organization's DefaultGreetingList","description":"","operationId":"putGreetingsDefaults","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The updated defaultGreetingList","required":true,"schema":{"$ref":"#/definitions/DefaultGreetingList"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DefaultGreetingList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings"]}],"x-purecloud-method-name":"putGreetingsDefaults"}},"/api/v2/architect/prompts/{promptId}/resources/{languageCode}":{"get":{"tags":["Architect"],"summary":"Get specified user prompt resource","description":"","operationId":"getArchitectPromptResource","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PromptAsset"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.not.found":"Could not find resource with specified prompt.","not.found":"The requested resource was not found.","architect.prompt.resource.not.found":"Could not find resource with specified language in specified prompt."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:view"]},"x-purecloud-method-name":"getArchitectPromptResource"},"put":{"tags":["Architect"],"summary":"Update specified user prompt resource","description":"","operationId":"putArchitectPromptResource","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/PromptAsset"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PromptAsset"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.resource.invalid.tags":"The specified tags are in an invalid format.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","architect.object.validate.failed":"Failed to validate object.","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.prompt.resource.not.found":"Could not find resource with specified language in specified prompt."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.resource.tags.already.exist":"The specified tags already exist in another prompt resource."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.object.update.failed":"The database update for the object failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:edit"]},"x-purecloud-method-name":"putArchitectPromptResource"},"delete":{"tags":["Architect"],"summary":"Delete specified user prompt resource","description":"","operationId":"deleteArchitectPromptResource","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.not.found":"Could not find prompt with specified ID.","architect.flow.data.missing":"Flow version data content is missing.","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.dependency.object.in.use":"The object cannot be deleted because other objects depend on it."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","architect.database.throughput.exceeded":"Database too busy. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:edit"]},"x-purecloud-method-name":"deleteArchitectPromptResource"}},"/api/v2/architect/prompts/{promptId}/resources/{languageCode}/audio":{"delete":{"tags":["Architect"],"summary":"Delete specified user prompt resource audio","description":"","operationId":"deleteArchitectPromptResourceAudio","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language","required":true,"type":"string"}],"responses":{"204":{"description":"Audio successfully deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.not.found":"Could not find prompt with specified ID.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.resource.audio.cannot.delete":"Failed to delete the audio for the resource.","architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","architect.database.throughput.exceeded":"Database too busy. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:edit"]},"x-purecloud-method-name":"deleteArchitectPromptResourceAudio"}},"/api/v2/oauth/scopes":{"get":{"tags":["OAuth"],"summary":"The list of OAuth scopes","description":"","operationId":"getOauthScopes","produces":["application/json"],"parameters":[{"name":"Accept-Language","in":"header","description":"The language with which to display the scope descriptions.","required":false,"type":"string","default":"en-us"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthScopeListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-purecloud-method-name":"getOauthScopes"}},"/api/v2/recording/batchrequests/{jobId}":{"get":{"tags":["Recording"],"summary":"Get the status and results for a batch request job, only the user that submitted the job may retrieve results","description":"","operationId":"getRecordingBatchrequest","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BatchDownloadJobStatusResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"batch.download.permission.denied":"Only user that initiated the job can request results","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","batch.download.job.not.found":"The requested job is unknown"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-purecloud-method-name":"getRecordingBatchrequest"}},"/api/v2/recording/batchrequests":{"post":{"tags":["Recording"],"summary":"Submit a batch download request for recordings. Recordings in response will be in their original format/codec - configured in the Trunk configuration.","description":"","operationId":"postRecordingBatchrequests","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Job submission criteria","required":true,"schema":{"$ref":"#/definitions/BatchDownloadJobSubmission"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BatchDownloadJobSubmissionResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"batch.download.too.many.items":"Too many items requested, max 100 allowed","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","batch.download.bad.request":"Request list is required and must not be empty","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-purecloud-method-name":"postRecordingBatchrequests"}},"/api/v2/flows/outcomes":{"get":{"tags":["Architect"],"summary":"Get a pageable list of flow outcomes, filtered by query parameters","description":"Multiple IDs can be specified, in which case all matching flow outcomes will be returned, and no other parameters will be evaluated.","operationId":"getFlowsOutcomes","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"id"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc"},{"name":"id","in":"query","description":"ID","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"description","in":"query","description":"Description","required":false,"type":"string"},{"name":"nameOrDescription","in":"query","description":"Name or description","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowOutcomeListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.outcome.not.found":"Could not find resource with specified language in specified system prompt.","not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.feature.toggle.unavailable":"The required feature toggle is not enabled for this organization.","architect.flow.outcome.not.available":"Flow outcomes are not available for current organization."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowOutcome:view"]},"x-purecloud-method-name":"getFlowsOutcomes"},"post":{"tags":["Architect"],"summary":"Create a flow outcome","description":"Asynchronous. Notification topic: v2.flows.outcomes.{flowOutcomeId}","operationId":"postFlowsOutcomes","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/FlowOutcome"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowOutcome"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.outcome.validate.failed":"Failed to validate flow outcome.","architect.flow.outcome.validate.failed.invalid.name":"Failed to validate flow outcome due to invalid name. Names can only contain letters, numbers, and the underscore, and must start with a letter or number.","architect.flow.outcome.validate.failed.missing.name":"Failed to validate flow outcome due to missing name.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","architect.property.exceeds.max.character.length":"The name and/or description exceeds the maximum character length.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","architect.flow.outcome.validate.failed.missing.description":"Failed to validate flow outcome due to missing description.","architect.object.validate.failed":"Failed to validate object.","architect.flow.outcome.validate.failed.invalid.name.no.alpha":"Failed to validate flow outcome due to invalid name. Names must contain at least one alphanumeric character.","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.feature.toggle.unavailable":"The required feature toggle is not enabled for this organization.","architect.flow.outcome.not.available":"Flow outcomes are not available for current organization."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.outcome.already.exists":"A flow outcome with the specified name already exists.","architect.flow.outcome.exceeded.max.amount":"Could not create flow outcome since the maximum number of outcomes already exist."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowOutcome:add"]},"x-purecloud-method-name":"postFlowsOutcomes"}},"/api/v2/telephony/providers/edges/addressvalidation":{"post":{"tags":["Telephony Providers Edge"],"summary":"Validates a street address","description":"","operationId":"postTelephonyProvidersEdgesAddressvalidation","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Address","required":true,"schema":{"$ref":"#/definitions/ValidateAddressRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ValidateAddressResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-purecloud-method-name":"postTelephonyProvidersEdgesAddressvalidation"}},"/api/v2/quality/forms/{formId}":{"get":{"tags":["Quality"],"summary":"Get an evaluation form","description":"","operationId":"getQualityForm","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"evaluation.form.invalid":"The specified formId is not valid","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","evaluation.not.found":"Evaluation form not found"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:view"]},"x-purecloud-method-name":"getQualityForm"},"put":{"tags":["Quality"],"summary":"Update an evaluation form.","description":"","operationId":"putQualityForm","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Evaluation form","required":true,"schema":{"$ref":"#/definitions/EvaluationForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"evaluation.name.conflict":"Evaluation form named has a conflict."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:edit"]},"x-purecloud-method-name":"putQualityForm"},"delete":{"tags":["Quality"],"summary":"Delete an evaluation form.","description":"","operationId":"deleteQualityForm","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"evaluation.cannot.be.deleted":"Cannot delete evaluation because it has already been published."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:delete"]},"x-purecloud-method-name":"deleteQualityForm"}},"/api/v2/telephony/providers/edges/{edgeId}/softwareupdate":{"get":{"tags":["Telephony Providers Edge"],"summary":"Gets software update status information about any edge.","description":"","operationId":"getTelephonyProvidersEdgeSoftwareupdate","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainEdgeSoftwareUpdateDto"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-purecloud-method-name":"getTelephonyProvidersEdgeSoftwareupdate"},"post":{"tags":["Telephony Providers Edge"],"summary":"Starts a software update for this edge.","description":"","operationId":"postTelephonyProvidersEdgeSoftwareupdate","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Software update request","required":true,"schema":{"$ref":"#/definitions/DomainEdgeSoftwareUpdateDto"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainEdgeSoftwareUpdateDto"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","managed.property.not.allowed":"Not allowed to set managed property."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-purecloud-method-name":"postTelephonyProvidersEdgeSoftwareupdate"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Cancels any in-progress update for this edge.","description":"","operationId":"deleteTelephonyProvidersEdgeSoftwareupdate","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-purecloud-method-name":"deleteTelephonyProvidersEdgeSoftwareupdate"}},"/api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations":{"get":{"tags":["Recording"],"summary":"Get annotations for recording","description":"","operationId":"getConversationRecordingAnnotations","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"recordingId","in":"path","description":"Recording ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/Annotation"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:annotation:view"]},"x-purecloud-method-name":"getConversationRecordingAnnotations"},"post":{"tags":["Recording"],"summary":"Create annotation","description":"","operationId":"postConversationRecordingAnnotations","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"recordingId","in":"path","description":"Recording ID","required":true,"type":"string"},{"in":"body","name":"body","description":"annotation","required":true,"schema":{"$ref":"#/definitions/Annotation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Annotation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","recording.invalid.json":"Request contains invalid JSON.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:annotation:add"]},"x-purecloud-method-name":"postConversationRecordingAnnotations"}},"/api/v2/speechandtextanalytics/programs/general/jobs":{"post":{"tags":["Speech & Text Analytics"],"summary":"Create new Speech & Text Analytics general program job","description":"","operationId":"postSpeechandtextanalyticsProgramsGeneralJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The general programs job to create","required":true,"schema":{"$ref":"#/definitions/GeneralProgramJobRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GeneralProgramJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"topics.limit.exceeded":"500 topics quota exceeded","programs.limit.exceeded":"100 programs quota exceeded","bad.request":"Wrong request structure","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:add","speechAndTextAnalytics:program:edit","speechAndTextAnalytics:topic:add","speechAndTextAnalytics:topic:edit"]},"x-purecloud-method-name":"postSpeechandtextanalyticsProgramsGeneralJobs"}},"/api/v2/orphanrecordings/{orphanId}/media":{"get":{"tags":["Recording"],"summary":"Gets the media of a single orphan recording","description":"A 202 response means the orphaned media is currently transcoding and will be available shortly.A 200 response denotes the transcoded orphan media is available now and is contained in the response body.","operationId":"getOrphanrecordingMedia","produces":["application/json"],"parameters":[{"name":"orphanId","in":"path","description":"Orphan ID","required":true,"type":"string"},{"name":"formatId","in":"query","description":"The desired media format.","required":false,"type":"string","default":"WEBM","enum":["WAV","WEBM","WAV_ULAW","OGG_VORBIS","OGG_OPUS","MP3","NONE"],"x-genesys-enum-members":[{"name":"WAV"},{"name":"WEBM"},{"name":"WAV_ULAW"},{"name":"OGG_VORBIS"},{"name":"OGG_OPUS"},{"name":"MP3"},{"name":"NONE"}]},{"name":"emailFormatId","in":"query","description":"The desired media format when downloading an email recording.","required":false,"type":"string","default":"EML","enum":["EML","NONE"],"x-genesys-enum-members":[{"name":"EML"},{"name":"NONE"}]},{"name":"chatFormatId","in":"query","description":"The desired media format when downloading a chat recording.","required":false,"type":"string","default":"ZIP","enum":["ZIP","NONE"],"x-genesys-enum-members":[{"name":"ZIP"},{"name":"NONE"}]},{"name":"messageFormatId","in":"query","description":"The desired media format when downloading a message recording.","required":false,"type":"string","default":"ZIP","enum":["ZIP","NONE"],"x-genesys-enum-members":[{"name":"ZIP"},{"name":"NONE"}]},{"name":"download","in":"query","description":"requesting a download format of the recording","required":false,"type":"boolean","default":false,"enum":["true","false"],"x-genesys-enum-members":[{"name":"true"},{"name":"false"}]},{"name":"fileName","in":"query","description":"the name of the downloaded fileName","required":false,"type":"string"},{"name":"locale","in":"query","description":"The locale for the requested file when downloading, as an ISO 639-1 code","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Recording"}},"202":{"description":"Accepted - Transcoding orphan media"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:orphan:view"]},"x-purecloud-method-name":"getOrphanrecordingMedia"}},"/api/v2/fax/documents/{documentId}/content":{"get":{"tags":["Fax"],"summary":"Download a fax document.","description":"","operationId":"getFaxDocumentContent","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DownloadResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["fax","fax:readonly"]}],"x-purecloud-method-name":"getFaxDocumentContent"}},"/api/v2/authorization/roles/default":{"post":{"tags":["Authorization"],"summary":"Restores all default roles","description":"This endpoint serves several purposes. 1. It provides the org with default roles. This is important for default roles that will be added after go-live (they can retroactively add the new default-role). Note: When not using a query param of force=true, it only adds the default roles not configured for the org; it does not overwrite roles. 2. Using the query param force=true, you can restore all default roles. Note: This does not have an effect on custom roles.","operationId":"postAuthorizationRolesDefault","produces":["application/json"],"parameters":[{"name":"force","in":"query","description":"Restore default roles","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationRoleEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:edit"]},"x-purecloud-method-name":"postAuthorizationRolesDefault"},"put":{"tags":["Authorization"],"summary":"Restore specified default roles","description":"","operationId":"putAuthorizationRolesDefault","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Organization roles list","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/DomainOrganizationRole"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationRoleEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:edit"]},"x-purecloud-method-name":"putAuthorizationRolesDefault"}},"/api/v2/tokens/me":{"get":{"tags":["Tokens"],"summary":"Fetch information about the current token","description":"","operationId":"getTokensMe","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TokenInfo"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["user-basic-info"]}],"x-purecloud-method-name":"getTokensMe"},"delete":{"tags":["Tokens"],"summary":"Delete auth token used to make the request.","description":"","operationId":"deleteTokensMe","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["user-basic-info"]}],"x-purecloud-method-name":"deleteTokensMe"}},"/api/v2/flows/executions/{flowExecutionId}":{"get":{"tags":["Architect"],"summary":"Get a flow execution's details. Flow execution details are available for several days after the flow is started.","description":"","operationId":"getFlowsExecution","produces":["application/json"],"parameters":[{"name":"flowExecutionId","in":"path","description":"flow execution ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowRuntimeExecution"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.flow.execution.not.found":"Specifiec flow execution not found.","architect.execution.flow.not.found":"Could not find flow execution with specified ID."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.unspecified.error":"An unknown error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flowExecution:view"]},"x-purecloud-method-name":"getFlowsExecution"}},"/api/v2/users/{userId}/callforwarding":{"get":{"tags":["Users"],"summary":"Get a user's CallForwarding","description":"","operationId":"getUserCallforwarding","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallForwarding"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","callforwarding.usernotpermitted":"User is not permitted to use call forwarding","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"424":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"externalservice.unexpectedresponsecode":"Unexpected response code from external service"}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getUserCallforwarding"},"put":{"tags":["Users"],"summary":"Update a user's CallForwarding","description":"","operationId":"putUserCallforwarding","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Call forwarding","required":true,"schema":{"$ref":"#/definitions/CallForwarding"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallForwarding"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"callforwarding.voicemaillastcallrequiresatleastonecalltoaphonenumber":"Setting voicemail 'lastcall' requires a call to a phone number","callforwarding.voicemailpurecloudrequiresatleastonecall":"Setting voicemail 'purecloud' cannot be used without a call","callforwarding.calltargetrequirestype":"A call target requires a type","callforwarding.enablednotallowedwhileonqueue":"Call forwarding is not allowed to be enabled while on queue","callforwarding.voicemaillastcallcannotusestation":"Setting voicemail 'lastcall' cannot be used with a station","callforwarding.enablednotallowedwithoutcalls":"Call forwarding is not allowed to be enabled without calls","callforwarding.webrtcstationmustbelongtouser":"WebRtc station must belong to the user","callforwarding.maxnumberofcallsexceeded":"The number of calls exceeds the limit","callforwarding.maxnumberofcalltargetsexceeded":"The number of targets per call exceeds the limit","callforwarding.invalidphonenumberformat":"Invalid E164 phone number","callforwarding.calltargetstationrequiresstation":"Call target with type of 'station' requires the value to be a valid station id","callforwarding.invalidextension":"Invalid extension","callforwarding.callrequiresatleastonetarget":"A call requires at least one target","callforwarding.enabledcannotbenull":"Enabled must be true or false","callforwarding.calltargetunknowntype":"A call target has unknown type","callforwarding.duplicatetargetnotallowed":"A phone number or station can only be used once","callforwarding.invalidtargettype":"Value for the target type is invalid","callforwarding.voicemailpermissionrequired":"Setting voicemail to 'purecloud' requires the user to have voicemail permission","callforwarding.calltargetphonenumberrequiresvalue":"Call target with type of 'phonenumber' requires the value to be a valid phone number or extension","callforwarding.voicemaillastcallmustbeanexternalphonenumber":"Setting voicemail to 'lastcall' requires the last call to use a single phone number to an external non-PureCloud operated number","callforwarding.calltargetrequiresvalue":"A call target requires a value","callforwarding.voicemaillastcallcannotuseextension":"Setting voicemail 'lastcall' cannot be used with an extension"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-purecloud-method-name":"putUserCallforwarding"},"patch":{"tags":["Users"],"summary":"Patch a user's CallForwarding","description":"","operationId":"patchUserCallforwarding","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Call forwarding","required":true,"schema":{"$ref":"#/definitions/CallForwarding"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallForwarding"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"callforwarding.voicemaillastcallrequiresatleastonecalltoaphonenumber":"Setting voicemail 'lastcall' requires a call to a phone number","callforwarding.voicemailpurecloudrequiresatleastonecall":"Setting voicemail 'purecloud' cannot be used without a call","callforwarding.calltargetrequirestype":"A call target requires a type","callforwarding.enablednotallowedwhileonqueue":"Call forwarding is not allowed to be enabled while on queue","callforwarding.voicemaillastcallcannotusestation":"Setting voicemail 'lastcall' cannot be used with a station","callforwarding.enablednotallowedwithoutcalls":"Call forwarding is not allowed to be enabled without calls","callforwarding.webrtcstationmustbelongtouser":"WebRtc station must belong to the user","callforwarding.maxnumberofcallsexceeded":"The number of calls exceeds the limit","callforwarding.maxnumberofcalltargetsexceeded":"The number of targets per call exceeds the limit","callforwarding.invalidphonenumberformat":"Invalid E164 phone number","callforwarding.calltargetstationrequiresstation":"Call target with type of 'station' requires the value to be a valid station id","callforwarding.invalidextension":"Invalid extension","callforwarding.callrequiresatleastonetarget":"A call requires at least one target","callforwarding.enabledcannotbenull":"Enabled must be true or false","callforwarding.calltargetunknowntype":"A call target has unknown type","callforwarding.duplicatetargetnotallowed":"A phone number or station can only be used once","callforwarding.invalidtargettype":"Value for the target type is invalid","callforwarding.voicemailpermissionrequired":"Setting voicemail to 'purecloud' requires the user to have voicemail permission","callforwarding.calltargetphonenumberrequiresvalue":"Call target with type of 'phonenumber' requires the value to be a valid phone number or extension","callforwarding.voicemaillastcallmustbeanexternalphonenumber":"Setting voicemail to 'lastcall' requires the last call to use a single phone number to an external non-PureCloud operated number","callforwarding.calltargetrequiresvalue":"A call target requires a value","callforwarding.voicemaillastcallcannotuseextension":"Setting voicemail 'lastcall' cannot be used with an extension"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-purecloud-method-name":"patchUserCallforwarding"}},"/api/v2/routing/queues/{queueId}":{"get":{"tags":["Routing"],"summary":"Get details about this queue.","description":"","operationId":"getRoutingQueue","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Queue"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"At least one of the required division permissions is missing","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:queue:view"]},"x-purecloud-method-name":"getRoutingQueue"},"put":{"tags":["Routing"],"summary":"Update a queue","description":"","operationId":"putRoutingQueue","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Queue","required":true,"schema":{"$ref":"#/definitions/QueueRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Queue"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Invalid media type specified.","source.queue.not.found":"Source queue not found.","bad.request":"Invalid request data.","duplicate.name":"A queue with this name already exists.","invalid.rule":"Invalid routing rule specified.","invalid.outbound.messaging.address.state":"Specified outbound messaging address is not active.","queue.deleted":"Queue has been deleted.","invalid.name":"Invalid queue name specified.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.phone.number":"Invalid phone number specified.","invalid.id":"Missing or invalid queue division ID.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","skill.does.not.exist":"Specified skill does not exist."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:edit"]},"x-purecloud-method-name":"putRoutingQueue"},"delete":{"tags":["Routing"],"summary":"Delete a queue","description":"","operationId":"deleteRoutingQueue","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"forceDelete","in":"query","description":"forceDelete","required":false,"type":"boolean"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","active.queue":"Queue contains active conversations."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"At least one of the required division permissions is missing","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:queue:delete"]},"x-purecloud-method-name":"deleteRoutingQueue"}},"/api/v2/telephony/providers/edges/trunkbasesettings":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get Trunk Base Settings listing","description":"Managed properties will not be returned unless the user is assigned the internal:trunk:edit permission.","operationId":"getTelephonyProvidersEdgesTrunkbasesettings","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Value by which to sort","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"recordingEnabled","in":"query","description":"Filter trunks by recording enabled","required":false,"type":"boolean"},{"name":"ignoreHidden","in":"query","description":"Set this to true to not receive trunk properties that are meant to be hidden or for internal system usage only.","required":false,"type":"boolean"},{"name":"managed","in":"query","description":"Filter by managed","required":false,"type":"boolean"},{"name":"expand","in":"query","description":"Fields to expand in the response, comma-separated","required":false,"type":"array","items":{"type":"string","enum":["properties"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"properties"}]},{"name":"name","in":"query","description":"Name of the TrunkBase to filter by","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkBaseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.resource.not.found":"Trunk base settings not found","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesTrunkbasesettings"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a Trunk Base Settings object","description":"","operationId":"postTelephonyProvidersEdgesTrunkbasesettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Trunk base settings","required":true,"schema":{"$ref":"#/definitions/TrunkBase"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"required.field.missing":"A required field is missing a value.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","trunk.metabase.required":"A metabase is required for this function.","duplicate.value":"A trunk with that name already exists.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","general.access.denied":"The requested action is forbidden.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be made due to conflict with the server resources"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesTrunkbasesettings"}},"/api/v2/flows/datatables/{datatableId}/export/jobs":{"post":{"tags":["Architect"],"summary":"Begin an export process for exporting all rows from a datatable","description":"Create an export job for exporting rows. The caller can then poll for status of the export using the token returned in the response","operationId":"postFlowsDatatableExportJobs","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataTableExportJob"}},"202":{"description":"Request Accepted","schema":{"$ref":"#/definitions/DataTableExportJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.table.not.found":"The datatable could not be found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:view"]},"x-purecloud-method-name":"postFlowsDatatableExportJobs"}},"/api/v2/journey/actiontemplates":{"get":{"tags":["Journey"],"summary":"Retrieve all action templates.","description":"","operationId":"getJourneyActiontemplates","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Field(s) to sort by. Prefix with '-' for descending (e.g. sortBy=name,-createdDate).","required":false,"type":"string"},{"name":"mediaType","in":"query","description":"Media type","required":false,"type":"string","enum":["webchat","webMessagingOffer","contentOffer","integrationAction","architectFlow"],"x-genesys-enum-members":[{"name":"webchat"},{"name":"webMessagingOffer"},{"name":"contentOffer"},{"name":"integrationAction"},{"name":"architectFlow"}]},{"name":"state","in":"query","description":"Action template state","required":false,"type":"string","enum":["Active","Inactive","Deleted"],"x-genesys-enum-members":[{"name":"Active"},{"name":"Inactive"},{"name":"Deleted"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionTemplateListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actiontemplate:view"]},"x-purecloud-method-name":"getJourneyActiontemplates"},"post":{"tags":["Journey"],"summary":"Create a single action template.","description":"","operationId":"postJourneyActiontemplates","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ActionTemplate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionTemplate"}},"201":{"description":"Action template created.","schema":{"$ref":"#/definitions/ActionTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actiontemplate:add"]},"x-purecloud-method-name":"postJourneyActiontemplates"}},"/api/v2/routing/languages":{"get":{"tags":["Routing"],"summary":"Get the list of supported languages.","description":"","operationId":"getRoutingLanguages","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ASC","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LanguageEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-purecloud-method-name":"getRoutingLanguages"},"post":{"tags":["Routing"],"summary":"Create Language","description":"","operationId":"postRoutingLanguages","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Language","required":true,"schema":{"$ref":"#/definitions/Language"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Language"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","general.conflict":"The request could not be completed by the server due to a conflict."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:manage"]},"x-purecloud-method-name":"postRoutingLanguages"}},"/api/v2/telephony/providers/edges/{edgeId}/lines/{lineId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get line","description":"","operationId":"getTelephonyProvidersEdgeLine","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"lineId","in":"path","description":"Line ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeLine"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a line with that id","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgeLine"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a line.","description":"","operationId":"putTelephonyProvidersEdgeLine","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"lineId","in":"path","description":"Line ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Line","required":true,"schema":{"$ref":"#/definitions/EdgeLine"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeLine"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgeLine"}},"/api/v2/routing/queues/{queueId}/users":{"get":{"tags":["Routing"],"summary":"DEPRECATED: use GET /routing/queues/{queueId}/members. Get the members of this queue.","description":"","operationId":"getRoutingQueueUsers","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size [max 100]","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"routingStatus"},{"name":"presence"},{"name":"conversationSummary"},{"name":"outOfOffice"},{"name":"geolocation"},{"name":"station"},{"name":"authorization"},{"name":"lasttokenissued"},{"name":"authorization.unusedRoles"},{"name":"team"},{"name":"profileSkills"},{"name":"certifications"},{"name":"locations"},{"name":"groups"},{"name":"skills"},{"name":"languages"},{"name":"languagePreference"},{"name":"employerInfo"},{"name":"biography"}]},{"name":"joined","in":"query","description":"Filter by joined status","required":false,"type":"boolean"},{"name":"name","in":"query","description":"Filter by queue member name","required":false,"type":"string"},{"name":"profileSkills","in":"query","description":"Filter by profile skill","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"skills","in":"query","description":"Filter by skill","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"languages","in":"query","description":"Filter by language","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"routingStatus","in":"query","description":"Filter by routing status","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"presence","in":"query","description":"Filter by presence","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueMemberEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.page.number":"Invalid page number specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","missing.any.division.permissions":"At least one of the required division permissions is missing"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"external.service.error":"The server is currently unable to handle the request .","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:view","routing:queueMember:manage"]},"x-purecloud-method-name":"getRoutingQueueUsers"},"post":{"tags":["Routing"],"summary":"DEPRECATED: use POST /routing/queues/{queueId}/members. Bulk add or delete up to 100 queue members.","description":"","operationId":"postRoutingQueueUsers","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Queue Members","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/WritableEntity"}}},{"name":"delete","in":"query","description":"True to delete queue members","required":false,"type":"boolean","default":false}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid request data. Make sure you submit a valid number of queue members.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","queue.size.limit":"Adding all requested members would exceed queue member limit.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","missing.any.division.permissions":"At least one of the required division permissions is missing"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"Specified queue could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["routing"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:edit","routing:queueMember:manage"]},"x-purecloud-method-name":"postRoutingQueueUsers"},"patch":{"tags":["Routing"],"summary":"DEPRECATED: use PATCH /routing/queues/{queueId}/members. Join or unjoin a set of users for a queue.","description":"","operationId":"patchRoutingQueueUsers","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Queue Members","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/QueueMember"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueMemberEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid request data. Make sure a valid number of queue members was submitted, and all have the joined property specified.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","missing.any.division.permissions":"At least one of the required division permissions is missing"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"Specified queue could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:edit","routing:queueMember:manage"]},"x-purecloud-method-name":"patchRoutingQueueUsers"}},"/api/v2/webchat/guest/conversations/{conversationId}/mediarequests/{mediaRequestId}":{"get":{"tags":["WebChat"],"summary":"Get a media request in the conversation","description":"","operationId":"getWebchatGuestConversationMediarequest","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"mediaRequestId","in":"path","description":"mediaRequestId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatGuestMediaRequest"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.not.found":"The media request was not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"Guest Chat JWT":[]}],"x-purecloud-method-name":"getWebchatGuestConversationMediarequest"},"patch":{"tags":["WebChat"],"summary":"Update a media request in the conversation, setting the state to ACCEPTED/DECLINED/ERRORED","description":"","operationId":"patchWebchatGuestConversationMediarequest","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"mediaRequestId","in":"path","description":"mediaRequestId","required":true,"type":"string"},{"in":"body","name":"body","description":"Request","required":true,"schema":{"$ref":"#/definitions/WebChatGuestMediaRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatGuestMediaRequest"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","chat.error.conversation.state":"The conversation is in a state which does not permit this action.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.not.found":"The media request was not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"Guest Chat JWT":[]}],"x-purecloud-method-name":"patchWebchatGuestConversationMediarequest"}},"/api/v2/routing/message/recipients":{"get":{"tags":["Routing"],"summary":"Get recipients","description":"","operationId":"getRoutingMessageRecipients","produces":["application/json"],"parameters":[{"name":"messengerType","in":"query","description":"Messenger Type","required":false,"type":"string","enum":["sms","facebook","twitter","line","whatsapp"],"x-genesys-enum-members":[{"name":"sms"},{"name":"facebook"},{"name":"twitter"},{"name":"line"},{"name":"whatsapp"}]},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecipientListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:message:manage"]},"x-purecloud-method-name":"getRoutingMessageRecipients"}},"/api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Phone Base Settings object by ID","description":"","operationId":"getTelephonyProvidersEdgesPhonebasesetting","produces":["application/json"],"parameters":[{"name":"phoneBaseId","in":"path","description":"Phone base ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhoneBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Unable to find a phone with that id.","general.resource.not.found":"Unable to find a Phone Base Settings with that id.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unable.to.expand.properties":"Server error, unable to expand base setting properties.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesPhonebasesetting"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a Phone Base Settings by ID","description":"","operationId":"putTelephonyProvidersEdgesPhonebasesetting","produces":["application/json"],"parameters":[{"name":"phoneBaseId","in":"path","description":"Phone base ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Phone base settings","required":true,"schema":{"$ref":"#/definitions/PhoneBase"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhoneBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Unable to find a phone with that id","general.resource.not.found":"Unable to find a phone with that id","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesPhonebasesetting"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a Phone Base Settings by ID","description":"","operationId":"deleteTelephonyProvidersEdgesPhonebasesetting","produces":["application/json"],"parameters":[{"name":"phoneBaseId","in":"path","description":"Phone base ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to delete Phone Base Settings with that id.","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"Phone template cannot be modified in current state."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdgesPhonebasesetting"}},"/api/v2/webchat/guest/conversations/{conversationId}/members":{"get":{"tags":["WebChat"],"summary":"Get the members of a chat conversation.","description":"","operationId":"getWebchatGuestConversationMembers","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"The number of entries to return per page, or omitted for the default.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number to return, or omitted for the first page.","required":false,"type":"integer","default":1,"format":"int32"},{"name":"excludeDisconnectedMembers","in":"query","description":"If true, the results will not contain members who have a DISCONNECTED state.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatMemberInfoEntityList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"Guest Chat JWT":[]}],"x-purecloud-method-name":"getWebchatGuestConversationMembers"}},"/api/v2/telephony/providers/edges/{edgeId}/setuppackage":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the setup package for a locally deployed edge device. This is needed to complete the setup process for the virtual edge.","description":"","operationId":"getTelephonyProvidersEdgeSetuppackage","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VmPairingInfo"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgeSetuppackage"}},"/api/v2/orgauthorization/trustees":{"get":{"tags":["Organization Authorization"],"summary":"The list of trustees for this organization (i.e. organizations granted access to this organization).","description":"","operationId":"getOrgauthorizationTrustees","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrustee:view"]},"x-purecloud-method-name":"getOrgauthorizationTrustees"},"post":{"tags":["Organization Authorization"],"summary":"Create a new organization authorization trust. This is required to grant other organizations access to your organization.","description":"","operationId":"postOrgauthorizationTrustees","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Trust","required":true,"schema":{"$ref":"#/definitions/TrustCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Trustee"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"self.trust.not.allowed":"The pairing trustee organization id cannot match the creator of the trust's organization id.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","pairing.id.required":"A valid pairingId is required.","trustee.user.or.group.required":"Trustee user or group required","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","trustee.user.required":"At least one trustee user is required."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["authorization:orgTrustee:add","authorization:orgTrusteeUser:add"]},"x-purecloud-method-name":"postOrgauthorizationTrustees"}},"/api/v2/recording/settings":{"get":{"tags":["Recording"],"summary":"Get the Recording Settings for the Organization","description":"","operationId":"getRecordingSettings","produces":["application/json"],"parameters":[{"name":"createDefault","in":"query","description":"If no settings are found, a new one is created with default values","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.internal.server.error":"Internal server error getting recording settings","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:screenRecording:view","recording:settings:editScreenRecordings"]},"x-purecloud-method-name":"getRecordingSettings"},"put":{"tags":["Recording"],"summary":"Update the Recording Settings for the Organization","description":"","operationId":"putRecordingSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Recording settings","required":true,"schema":{"$ref":"#/definitions/RecordingSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","recording.org.settings.request.invalid":"invalid recording setting","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:settings:editScreenRecordings"]},"x-purecloud-method-name":"putRecordingSettings"}},"/api/v2/coaching/notifications/{notificationId}":{"get":{"tags":["Coaching"],"summary":"Get an existing notification","description":"Permission not required if you are the owner of the notification.","operationId":"getCoachingNotification","produces":["application/json"],"parameters":[{"name":"notificationId","in":"path","description":"The ID of the notification.","required":true,"type":"string"},{"name":"expand","in":"query","description":"Indicates a field in the response which should be expanded.","required":false,"type":"array","items":{"type":"string","enum":["appointment"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"appointment"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CoachingNotification"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"notification.not.found":"The requested notification could not be found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","coaching:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:notification:view"]},"x-purecloud-method-name":"getCoachingNotification"},"patch":{"tags":["Coaching"],"summary":"Update an existing notification.","description":"Can only update your own notifications.","operationId":"patchCoachingNotification","produces":["application/json"],"parameters":[{"name":"notificationId","in":"path","description":"The ID of the notification.","required":true,"type":"string"},{"in":"body","name":"body","description":"Change the read state of a notification","required":true,"schema":{"$ref":"#/definitions/CoachingNotification"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CoachingNotification"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"The requested notification does not belong to this user."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"notification.not.found":"The requested notification could not be found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching"]}],"x-purecloud-method-name":"patchCoachingNotification"}},"/api/v2/externalcontacts/organizations/schemas/{schemaId}":{"get":{"tags":["External Contacts"],"summary":"Get a schema","description":"","operationId":"getExternalcontactsOrganizationsSchema","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getExternalcontactsOrganizationsSchema"},"put":{"tags":["External Contacts"],"summary":"Update a schema","description":"","operationId":"putExternalcontactsOrganizationsSchema","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Data Schema","required":true,"schema":{"$ref":"#/definitions/DataSchema"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.limit.max.number.of.fields.per.org.would.be.exceeded":"The total number of fields defined for all schemas cannot exceed 500.","dynamic.schema.validation.limit.error":"The new JSON schema provided for update has a validation limit error.","dynamic.schema.limit.max.number.of.schemas.per.org.would.be.exceeded":"There cannot be more than 20 schemas.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","dynamic.schema.incompatible.json.schema.update":"The JSON schema provided for update is incompatible with the previous version.","dynamic.schema.limit.max.number.of.characters.for.field.name.would.be.exceeded":"A field name cannot exceed 100 characters","dynamic.schema.validation.limit.missing":"The new JSON schema provided for update is missing a validation limit.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","dynamic.schema.invalid.json.schema":"An invalid JSON schema was provided.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","dynamic.schema.limit.max.number.of.fields.per.schema.would.be.exceeded":"A schema cannot have more than 25 fields"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.version.conflict":"A valid version is required."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"Unable to expand the schema."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:edit"]},"x-purecloud-method-name":"putExternalcontactsOrganizationsSchema"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/{tradeId}":{"patch":{"tags":["Workforce Management"],"summary":"Updates a shift trade. This route can only be called by the initiating agent","description":"","operationId":"patchWorkforcemanagementManagementunitWeekShifttrade","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/PatchShiftTradeRequest"}},{"name":"tradeId","in":"path","description":"The ID of the shift trade to update","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ShiftTradeResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Entity was modified by another request"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentShiftTradeRequest:participate"]},"x-purecloud-method-name":"patchWorkforcemanagementManagementunitWeekShifttrade"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/{tradeId}/match":{"post":{"tags":["Workforce Management"],"summary":"Matches a shift trade. This route can only be called by the receiving agent","description":"","operationId":"postWorkforcemanagementManagementunitWeekShifttradeMatch","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/MatchShiftTradeRequest"}},{"name":"tradeId","in":"path","description":"The ID of the shift trade to update","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MatchShiftTradeResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"Invalid week date ID in path parameter","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Entity was modified by another request"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentShiftTradeRequest:participate"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitWeekShifttradeMatch"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades":{"get":{"tags":["Workforce Management"],"summary":"Gets all the shift trades for a given week","description":"","operationId":"getWorkforcemanagementManagementunitWeekShifttrades","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"evaluateMatches","in":"query","description":"Whether to evaluate the matches for violations","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WeekShiftTradeListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"Invalid week date ID in path parameter","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:shiftTradeRequest:view","wfm:shiftTradeRequest:edit"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitWeekShifttrades"},"post":{"tags":["Workforce Management"],"summary":"Adds a shift trade","description":"","operationId":"postWorkforcemanagementManagementunitWeekShifttrades","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/AddShiftTradeRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ShiftTradeResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentShiftTradeRequest:participate"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitWeekShifttrades"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/search":{"post":{"tags":["Workforce Management"],"summary":"Searches for potential shift trade matches for the current agent","description":"","operationId":"postWorkforcemanagementManagementunitWeekShifttradesSearch","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/SearchShiftTradesRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SearchShiftTradesResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"Invalid week date ID in path parameter","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentShiftTradeRequest:participate"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitWeekShifttradesSearch"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/state/bulk":{"post":{"tags":["Workforce Management"],"summary":"Updates the state of a batch of shift trades","description":"Admin functionality is not supported with \"mine\".","operationId":"postWorkforcemanagementManagementunitWeekShifttradesStateBulk","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/BulkShiftTradeStateUpdateRequest"}},{"name":"forceAsync","in":"query","description":"Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BulkUpdateShiftTradeStateResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Entity was modified by another request"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentShiftTradeRequest:participate","wfm:shiftTradeRequest:edit"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitWeekShifttradesStateBulk"}},"/api/v2/authorization/divisions/{divisionId}/objects/{objectType}":{"post":{"tags":["Authorization","Objects"],"summary":"Assign a list of objects to a division","description":"Set the division of a specified list of objects. The objects must all be of the same type, one of: \nCAMPAIGN, MANAGEMENTUNIT, FLOW, QUEUE, DATATABLES or USER. \nThe body of the request is a list of object IDs, which are expected to be \nGUIDs, e.g. [\"206ce31f-61ec-40ed-a8b1-be6f06303998\",\"250a754e-f5e4-4f51-800f-a92f09d3bf8c\"]","operationId":"postAuthorizationDivisionObject","produces":["application/json"],"parameters":[{"name":"divisionId","in":"path","description":"Division ID","required":true,"type":"string"},{"name":"objectType","in":"path","description":"The type of the objects. Must be one of the valid object types","required":true,"type":"string","enum":["QUEUE","CAMPAIGN","CONTACTLIST","DNCLIST","MESSAGINGCAMPAIGN","MANAGEMENTUNIT","BUSINESSUNIT","FLOW","USER","DATATABLES"],"x-genesys-enum-members":[{"name":"QUEUE"},{"name":"CAMPAIGN"},{"name":"CONTACTLIST"},{"name":"DNCLIST"},{"name":"MESSAGINGCAMPAIGN"},{"name":"MANAGEMENTUNIT"},{"name":"BUSINESSUNIT"},{"name":"FLOW"},{"name":"USER"},{"name":"DATATABLES"}]},{"in":"body","name":"body","description":"Object Id List","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"204":{"description":"The divisions were updated successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","too.many.bulk.division.updates":"Unable to move objects because the request contained too many objects","empty.bulk.division.update":"Unable to move object because the request contained an empty object.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bulk.move.no.permission.division":"Unable to move object(s) because the requesting user does not have edit permission in the destination division","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.units.not.found":"One or more requested management units were not found","wfm.business.units.not.found":"One or more requested business units were not found","general.resource.not.found":"Requested resource is not available.","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bulk.move.unable.to.move":"One or more of the object(s) failed to be moved to the destination division"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed","bulk.move.permission.check.error":"Failed to check permissions in one or more of the divisions in the request","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-purecloud-method-name":"postAuthorizationDivisionObject"}},"/api/v2/authorization/divisions/{divisionId}":{"get":{"tags":["Authorization","Objects"],"summary":"Returns an authorization division.","description":"","operationId":"getAuthorizationDivision","produces":["application/json"],"parameters":[{"name":"divisionId","in":"path","description":"Division ID","required":true,"type":"string"},{"name":"objectCount","in":"query","description":"Get count of objects in this division, grouped by type","required":false,"type":"boolean","default":false,"enum":["true","false"],"x-genesys-enum-members":[{"name":"true"},{"name":"false"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuthzDivision"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-purecloud-method-name":"getAuthorizationDivision"},"put":{"tags":["Authorization","Objects"],"summary":"Update a division.","description":"","operationId":"putAuthorizationDivision","produces":["application/json"],"parameters":[{"name":"divisionId","in":"path","description":"Division ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Updated division data","required":true,"schema":{"$ref":"#/definitions/AuthzDivision"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuthzDivision"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:division:edit"]},"x-purecloud-method-name":"putAuthorizationDivision"},"delete":{"tags":["Authorization","Objects"],"summary":"Delete a division.","description":"","operationId":"deleteAuthorizationDivision","produces":["application/json"],"parameters":[{"name":"divisionId","in":"path","description":"Division ID","required":true,"type":"string"},{"name":"force","in":"query","description":"Force delete this division as well as the grants and objects associated with it","required":false,"type":"boolean","default":false}],"responses":{"204":{"description":"Deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"precondition.failure":"One or more preconditions was not met.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:division:delete"]},"x-purecloud-method-name":"deleteAuthorizationDivision"}},"/api/v2/flows/divisionviews":{"get":{"tags":["Architect"],"summary":"Get a pageable list of basic flow information objects filterable by query parameters.","description":"This returns a simplified version of /flow consisting of name and type. If one or more IDs are specified, the search will fetch flows that match the given ID(s) and not use any additional supplied query parameters in the search.","operationId":"getFlowsDivisionviews","produces":["application/json"],"parameters":[{"name":"type","in":"query","description":"Type","required":false,"type":"array","items":{"type":"string","enum":["bot","commonmodule","inboundcall","inboundchat","inboundemail","inboundshortmessage","outboundcall","inqueuecall","speech","securecall","surveyinvite","workflow"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"bot"},{"name":"commonmodule"},{"name":"inboundcall"},{"name":"inboundchat"},{"name":"inboundemail"},{"name":"inboundshortmessage"},{"name":"outboundcall"},{"name":"inqueuecall"},{"name":"speech"},{"name":"securecall"},{"name":"surveyinvite"},{"name":"workflow"}]},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"id"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc"},{"name":"id","in":"query","description":"ID","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"publishVersionId","in":"query","description":"Publish version ID","required":false,"type":"string"},{"name":"publishedAfter","in":"query","description":"Published after","required":false,"type":"string","x-example":"2015-01-01T12:00:00-0600, 2015-01-01T18:00:00Z, 2015-01-01T12:00:00.000-0600, 2015-01-01T18:00:00.000Z, 2015-01-01"},{"name":"publishedBefore","in":"query","description":"Published before","required":false,"type":"string","x-example":"2015-01-01T12:00:00-0600, 2015-01-01T18:00:00Z, 2015-01-01T12:00:00.000-0600, 2015-01-01T18:00:00.000Z, 2015-01-01"},{"name":"divisionId","in":"query","description":"division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"includeSchemas","in":"query","description":"Include variable schemas","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowDivisionViewEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.invalid.id":"An invalid flow Id was specified.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","architect.invalid.flow.type":"An invalid flow type was specified.","architect.division.invalid":"One or more of the division IDs are not valid","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","feature.forbidden":"This feature is not enabled for this organization.","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.inbound.short.message.flow.invalid.operation":"Cannot perform requested operation on an inbound short message flow.","architect.workflow.invalid.operation":"Cannot perform requested operation on a workflow.","architect.speech.flow.invalid.operation":"Cannot perform requested operation on a speech flow.","architect.bot.flow.invalid.operation":"Cannot perform requested operation on a bot flow."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"501":{"description":"Not Implemented","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.implemented":"Feature toggle is not enabled for this endpoint."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flow:search"]},"x-purecloud-method-name":"getFlowsDivisionviews"}},"/api/v2/languages/{languageId}":{"get":{"tags":["Languages"],"summary":"Get language (Deprecated)","description":"This endpoint is deprecated. It has been moved to /routing/languages/{languageId}","operationId":"getLanguage","produces":["application/json"],"parameters":[{"name":"languageId","in":"path","description":"Language ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Language"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:manage"]},"x-purecloud-method-name":"getLanguage"},"delete":{"tags":["Languages"],"summary":"Delete Language (Deprecated)","description":"This endpoint is deprecated. It has been moved to /routing/languages/{languageId}","operationId":"deleteLanguage","produces":["application/json"],"parameters":[{"name":"languageId","in":"path","description":"Language ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["routing"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:manage"]},"x-purecloud-method-name":"deleteLanguage"}},"/api/v2/routing/skills/{skillId}":{"get":{"tags":["Routing"],"summary":"Get Routing Skill","description":"","operationId":"getRoutingSkill","produces":["application/json"],"parameters":[{"name":"skillId","in":"path","description":"Skill ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RoutingSkill"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-purecloud-method-name":"getRoutingSkill"},"delete":{"tags":["Routing"],"summary":"Delete Routing Skill","description":"","operationId":"deleteRoutingSkill","produces":["application/json"],"parameters":[{"name":"skillId","in":"path","description":"Skill ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:skill:manage"]},"x-purecloud-method-name":"deleteRoutingSkill"}},"/api/v2/userrecordings/{recordingId}":{"get":{"tags":["User Recordings"],"summary":"Get a user recording.","description":"","operationId":"getUserrecording","produces":["application/json"],"parameters":[{"name":"recordingId","in":"path","description":"User Recording ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["conversation"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"conversation"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserRecording"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["user-recordings","user-recordings:readonly"]}],"x-purecloud-method-name":"getUserrecording"},"put":{"tags":["User Recordings"],"summary":"Update a user recording.","description":"","operationId":"putUserrecording","produces":["application/json"],"parameters":[{"name":"recordingId","in":"path","description":"User Recording ID","required":true,"type":"string"},{"in":"body","name":"body","description":"UserRecording","required":true,"schema":{"$ref":"#/definitions/UserRecording"}},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["conversation"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"conversation"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserRecording"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["user-recordings"]}],"x-purecloud-method-name":"putUserrecording"},"delete":{"tags":["User Recordings"],"summary":"Delete a user recording.","description":"","operationId":"deleteUserrecording","produces":["application/json"],"parameters":[{"name":"recordingId","in":"path","description":"User Recording ID","required":true,"type":"string"}],"responses":{"202":{"description":"Accepted - Processing Delete"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["user-recordings"]}],"x-purecloud-method-name":"deleteUserrecording"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/intraday":{"post":{"tags":["Workforce Management"],"summary":"Get intraday data for the given date for the requested planningGroupIds","description":"","operationId":"postWorkforcemanagementBusinessunitIntraday","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The business unit ID of the business unit","required":true,"type":"string"},{"name":"forceAsync","in":"query","description":"Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes","required":false,"type":"boolean"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/IntradayPlanningGroupRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncIntradayResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:intraday:view"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitIntraday"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/intraday/planninggroups":{"get":{"tags":["Workforce Management"],"summary":"Get intraday planning groups for the given date","description":"","operationId":"getWorkforcemanagementBusinessunitIntradayPlanninggroups","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The business unit ID of the business unit","required":true,"type":"string"},{"name":"date","in":"query","description":"yyyy-MM-dd date string interpreted in the configured business unit time zone. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WfmIntradayPlanningGroupListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:intraday:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitIntradayPlanninggroups"}},"/api/v2/oauth/authorizations/{clientId}":{"get":{"tags":["OAuth"],"summary":"Get a client that is authorized by the resource owner","description":"","operationId":"getOauthAuthorization","produces":["application/json"],"parameters":[{"name":"clientId","in":"path","description":"The ID of client","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthAuthorization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:authorize"]},"x-purecloud-method-name":"getOauthAuthorization"}},"/api/v2/outbound/campaigns/{campaignId}/interactions":{"get":{"tags":["Outbound"],"summary":"Get dialer campaign interactions.","description":"","operationId":"getOutboundCampaignInteractions","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignInteractions"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The specified campaignId was not found.","resource.not.found":"Resource not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:view"]},"x-purecloud-method-name":"getOutboundCampaignInteractions"}},"/api/v2/license/infer":{"post":{"tags":["License"],"summary":"Get a list of licenses inferred based on a list of roleIds","description":"","operationId":"postLicenseInfer","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The roleIds to use while inferring licenses","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"type":"string"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["license","license:readonly"]}],"x-purecloud-method-name":"postLicenseInfer"}},"/api/v2/outbound/dnclists/divisionviews":{"get":{"tags":["Outbound"],"summary":"Query a list of simplified dnc list objects.","description":"This return a simplified version of dnc lists, consisting of the name, division, import status, and size.","operationId":"getOutboundDnclistsDivisionviews","produces":["application/json"],"parameters":[{"name":"includeImportStatus","in":"query","description":"Include import status","required":false,"type":"boolean","default":false},{"name":"includeSize","in":"query","description":"Include size","required":false,"type":"boolean","default":false},{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"],"x-genesys-enum-members":[{"name":"Equals"},{"name":"RegEx"},{"name":"Contains"},{"name":"Prefix"},{"name":"LessThan"},{"name":"LessThanEqualTo"},{"name":"GreaterThan"},{"name":"GreaterThanEqualTo"},{"name":"BeginsWith"},{"name":"EndsWith"}]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DncListDivisionViewListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.bulk.retrieves":"Only 100 dnc lists can be retrieved by id at a time","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:dncList:search"]},"x-purecloud-method-name":"getOutboundDnclistsDivisionviews"}},"/api/v2/telephony/providers/edges/extensions":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a listing of extensions","description":"","operationId":"getTelephonyProvidersEdgesExtensions","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"number"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"number","in":"query","description":"Filter by number","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExtensionEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesExtensions"}},"/api/v2/coaching/appointments/{appointmentId}/annotations/{annotationId}":{"get":{"tags":["Coaching"],"summary":"Retrieve an annotation.","description":"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).","operationId":"getCoachingAppointmentAnnotation","produces":["application/json"],"parameters":[{"name":"appointmentId","in":"path","description":"The ID of the coaching appointment.","required":true,"type":"string"},{"name":"annotationId","in":"path","description":"The ID of the annotation.","required":true,"type":"string"}],"responses":{"200":{"description":"Annotation retrieved","schema":{"$ref":"#/definitions/CoachingAnnotation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"User does not have the annotation view permission and is not an attendee, creator or facilitator of the appointment"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.not.found":"Appointment not found","not.found":"The requested resource was not found.","annotation.not.found":"Annotation not found","annotation.deleted":"Annotation has been deleted"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","coaching:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:annotation:view","coaching:privateAnnotation:view"]},"x-purecloud-method-name":"getCoachingAppointmentAnnotation"},"delete":{"tags":["Coaching"],"summary":"Delete an existing annotation","description":"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","operationId":"deleteCoachingAppointmentAnnotation","produces":["application/json"],"parameters":[{"name":"appointmentId","in":"path","description":"The ID of the coaching appointment.","required":true,"type":"string"},{"name":"annotationId","in":"path","description":"The ID of the annotation.","required":true,"type":"string"}],"responses":{"204":{"description":"Annotation deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"User does not have the annotation delete permission and is not a creator or facilitator of the appointment"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.not.found":"Appointment not found","not.found":"The requested resource was not found.","annotation.not.found":"Annotation not found","annotation.deleted":"Annotation has been deleted"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:annotation:delete","coaching:privateAnnotation:delete"]},"x-purecloud-method-name":"deleteCoachingAppointmentAnnotation"},"patch":{"tags":["Coaching"],"summary":"Update an existing annotation.","description":"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","operationId":"patchCoachingAppointmentAnnotation","produces":["application/json"],"parameters":[{"name":"appointmentId","in":"path","description":"The ID of the coaching appointment.","required":true,"type":"string"},{"name":"annotationId","in":"path","description":"The ID of the annotation.","required":true,"type":"string"},{"in":"body","name":"body","description":"The new version of the annotation","required":true,"schema":{"$ref":"#/definitions/CoachingAnnotation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CoachingAnnotation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","validation.failure":"The submitted data was not valid."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"User does not have the annotation edit permission and is not a creator or facilitator of the appointment"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.not.found":"Appointment not found","not.found":"The requested resource was not found.","annotation.not.found":"Annotation not found","annotation.deleted":"Annotation has been deleted"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:annotation:edit","coaching:privateAnnotation:edit"]},"x-purecloud-method-name":"patchCoachingAppointmentAnnotation"}},"/api/v2/conversations/messaging/integrations/facebook":{"get":{"tags":["Conversations"],"summary":"Get a list of Facebook Integrations","description":"","operationId":"getConversationsMessagingIntegrationsFacebook","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FacebookIntegrationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:view"]},"x-purecloud-method-name":"getConversationsMessagingIntegrationsFacebook"},"post":{"tags":["Conversations"],"summary":"Create a Facebook Integration","description":"","operationId":"postConversationsMessagingIntegrationsFacebook","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"FacebookIntegrationRequest","required":true,"schema":{"$ref":"#/definitions/FacebookIntegrationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FacebookIntegration"}},"202":{"description":"Accepted - If async is true, the integration creation in progress.","schema":{"$ref":"#/definitions/FacebookIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.integration":"The integration request was invalid for this operation. One or more errors may be reported.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:add"]},"x-purecloud-method-name":"postConversationsMessagingIntegrationsFacebook"}},"/api/v2/scim/serviceproviderconfig":{"get":{"tags":["SCIM"],"summary":"Get a service provider's configuration","description":"","operationId":"getScimServiceproviderconfig","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"name":"If-None-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/serviceproviderconfig. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified. ","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimServiceProviderConfig"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimServiceproviderconfig"}},"/api/v2/gdpr/requests":{"get":{"tags":["General Data Protection Regulation"],"summary":"Get all GDPR requests","description":"","operationId":"getGdprRequests","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GDPRRequestEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gdpr","gdpr:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gdpr:request:view"]},"x-purecloud-method-name":"getGdprRequests"},"post":{"tags":["General Data Protection Regulation"],"summary":"Submit a new GDPR request","description":"","operationId":"postGdprRequests","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"GDPR request","required":true,"schema":{"$ref":"#/definitions/GDPRRequest"}},{"name":"deleteConfirmed","in":"query","description":"Confirm delete","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GDPRRequest"}},"202":{"description":"Accepted","schema":{"$ref":"#/definitions/GDPRRequest"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gdpr"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gdpr:request:add"]},"x-purecloud-method-name":"postGdprRequests"}},"/api/v2/outbound/sequences/{sequenceId}":{"get":{"tags":["Outbound"],"summary":"Get a dialer campaign sequence.","description":"","operationId":"getOutboundSequence","produces":["application/json"],"parameters":[{"name":"sequenceId","in":"path","description":"Campaign Sequence ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignSequence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaignSequence:view"]},"x-purecloud-method-name":"getOutboundSequence"},"put":{"tags":["Outbound"],"summary":"Update a new campaign sequence.","description":"","operationId":"putOutboundSequence","produces":["application/json"],"parameters":[{"name":"sequenceId","in":"path","description":"Campaign Sequence ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Organization","required":true,"schema":{"$ref":"#/definitions/CampaignSequence"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignSequence"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","campaign.sequence.cannot.change.both.status.and.campaigns":"","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","campaign.sequence.missing.campaign":"The dialer campaign sequence is missing the campaign.","campaign.sequence.cannot.add.running.campaign.to.on.sequence":"","campaign.sequence.cannot.remove.running.campaign":"","invalid.update":"","campaign.sequence.invalid.campaign":"At least one campaign is invalid","campaign.sequence.invalid.current.campaign":"Current campaign is invalid","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","campaign.sequence.is.empty":"The dialer campaign sequence is empty.","invalid.update.bad.status.transition":"The status transition is invalid and failed to update.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.wrong.version":""}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaignSequence:edit"]},"x-purecloud-method-name":"putOutboundSequence"},"delete":{"tags":["Outbound"],"summary":"Delete a dialer campaign sequence.","description":"","operationId":"deleteOutboundSequence","produces":["application/json"],"parameters":[{"name":"sequenceId","in":"path","description":"Campaign Sequence ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"campaign.sequence.in.use":"The campaign sequence is already in use.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaignSequence:delete"]},"x-purecloud-method-name":"deleteOutboundSequence"}},"/api/v2/groups/{groupId}/profile":{"get":{"tags":["Groups"],"summary":"Get group profile","description":"This api is deprecated. Use /api/v2/groups instead","operationId":"getGroupProfile","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"groupId","required":true,"type":"string"},{"name":"fields","in":"query","description":"Comma separated fields to return. Allowable values can be found by querying /api/v2/fieldconfig?type=group and using the key for the elements returned by the fieldList","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GroupProfile"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find the group profile","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups","groups:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getGroupProfile"}},"/api/v2/telephony/providers/edges/extensionpools/{extensionPoolId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get an extension pool by ID","description":"","operationId":"getTelephonyProvidersEdgesExtensionpool","produces":["application/json"],"parameters":[{"name":"extensionPoolId","in":"path","description":"Extension pool ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExtensionPool"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesExtensionpool"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update an extension pool by ID","description":"","operationId":"putTelephonyProvidersEdgesExtensionpool","produces":["application/json"],"parameters":[{"name":"extensionPoolId","in":"path","description":"Extension pool ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ExtensionPool","required":true,"schema":{"$ref":"#/definitions/ExtensionPool"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExtensionPool"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be completed by the server due to a conflict."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesExtensionpool"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete an extension pool by ID","description":"","operationId":"deleteTelephonyProvidersEdgesExtensionpool","produces":["application/json"],"parameters":[{"name":"extensionPoolId","in":"path","description":"Extension pool ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find an outbound route with that id","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be completed by the server due to a conflict."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdgesExtensionpool"}},"/api/v2/users":{"get":{"tags":["Users"],"summary":"Get the list of available users.","description":"","operationId":"getUsers","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"id","in":"query","description":"A list of user IDs to fetch by bulk","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"jabberId","in":"query","description":"A list of jabberIds to fetch by bulk (cannot be used with the \"id\" parameter)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ASC","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"routingStatus"},{"name":"presence"},{"name":"conversationSummary"},{"name":"outOfOffice"},{"name":"geolocation"},{"name":"station"},{"name":"authorization"},{"name":"lasttokenissued"},{"name":"authorization.unusedRoles"},{"name":"team"},{"name":"profileSkills"},{"name":"certifications"},{"name":"locations"},{"name":"groups"},{"name":"skills"},{"name":"languages"},{"name":"languagePreference"},{"name":"employerInfo"},{"name":"biography"}]},{"name":"integrationPresenceSource","in":"query","description":"Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an \"expand\". When using this parameter the maximum number of users that can be returned is 10.","required":false,"type":"string","enum":["MicrosoftTeams","ZoomPhone","RingCentral"],"x-genesys-enum-members":[{"name":"MicrosoftTeams"},{"name":"ZoomPhone"},{"name":"RingCentral"}]},{"name":"state","in":"query","description":"Only list users of this state","required":false,"type":"string","default":"active","enum":["active","inactive","deleted","any"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"},{"name":"any"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","max.user.ids":"Only 100 users can be requested at a time."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The requested user(s) could not be found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getUsers"},"post":{"tags":["Users"],"summary":"Create user","description":"","operationId":"postUsers","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"User","required":true,"schema":{"$ref":"#/definitions/CreateUser"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/User"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","general.conflict":"The request could not be completed by the server due to a conflict."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be completed by the server due to a conflict."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:add"]},"x-purecloud-method-name":"postUsers"}},"/api/v2/externalcontacts/scan/contacts":{"get":{"tags":["External Contacts"],"summary":"Scan for external contacts using paging","description":"","operationId":"getExternalcontactsScanContacts","produces":["application/json"],"parameters":[{"name":"limit","in":"query","description":"The number of contacts per page; must be between 10 and 200, default is 100)","required":false,"type":"integer","format":"int32"},{"name":"cursor","in":"query","description":"Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CursorContactListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or expired cursor","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too many requests in a given amount of time"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:view"]},"x-purecloud-method-name":"getExternalcontactsScanContacts"}},"/api/v2/externalcontacts/organizations/{externalOrganizationId}/notes":{"get":{"tags":["External Contacts"],"summary":"List notes for an external organization","description":"","operationId":"getExternalcontactsOrganizationNotes","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization Id","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":20,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["author","externalDataSources"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"author"},{"name":"externalDataSources"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NoteListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:view","externalContacts:externalOrganization:view"]},"x-purecloud-method-name":"getExternalcontactsOrganizationNotes"},"post":{"tags":["External Contacts"],"summary":"Create a note for an external organization","description":"","operationId":"postExternalcontactsOrganizationNotes","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization Id","required":true,"type":"string"},{"in":"body","name":"body","description":"ExternalContact","required":true,"schema":{"$ref":"#/definitions/Note"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Note"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided contact was not valid"}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:edit","externalContacts:externalOrganization:edit"]},"x-purecloud-method-name":"postExternalcontactsOrganizationNotes"}},"/api/v2/alerting/interactionstats/rules/{ruleId}":{"get":{"tags":["Alerting"],"summary":"Get an interaction stats rule.","description":"","operationId":"getAlertingInteractionstatsRule","produces":["application/json"],"parameters":[{"name":"ruleId","in":"path","description":"Rule ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["notificationUsers"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"notificationUsers"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InteractionStatsRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting","alerting:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:rule:view"]},"x-purecloud-method-name":"getAlertingInteractionstatsRule"},"put":{"tags":["Alerting"],"summary":"Update an interaction stats rule","description":"","operationId":"putAlertingInteractionstatsRule","produces":["application/json"],"parameters":[{"name":"ruleId","in":"path","description":"Rule ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["notificationUsers"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"notificationUsers"}]},{"in":"body","name":"body","description":"AlertingRule","required":true,"schema":{"$ref":"#/definitions/InteractionStatsRule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InteractionStatsRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:rule:edit"]},"x-purecloud-method-name":"putAlertingInteractionstatsRule"},"delete":{"tags":["Alerting"],"summary":"Delete an interaction stats rule.","description":"","operationId":"deleteAlertingInteractionstatsRule","produces":["application/json"],"parameters":[{"name":"ruleId","in":"path","description":"Rule ID","required":true,"type":"string"}],"responses":{"204":{"description":"Interaction stats rule deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["alerting:rule:delete"]},"x-purecloud-method-name":"deleteAlertingInteractionstatsRule"}},"/api/v2/conversations/messaging/integrations/twitter":{"get":{"tags":["Conversations"],"summary":"Get a list of Twitter Integrations","description":"","operationId":"getConversationsMessagingIntegrationsTwitter","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TwitterIntegrationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:view"]},"x-purecloud-method-name":"getConversationsMessagingIntegrationsTwitter"},"post":{"tags":["Conversations"],"summary":"Create a Twitter Integration","description":"","operationId":"postConversationsMessagingIntegrationsTwitter","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"TwitterIntegrationRequest","required":true,"schema":{"$ref":"#/definitions/TwitterIntegrationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TwitterIntegration"}},"202":{"description":"Accepted - If async is true, the integration creation is in progress.","schema":{"$ref":"#/definitions/TwitterIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.integration":"The integration request was invalid for this operation. One or more errors may be reported.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:add"]},"x-purecloud-method-name":"postConversationsMessagingIntegrationsTwitter"}},"/api/v2/users/{userId}/trustors":{"get":{"tags":["Users"],"summary":"List the organizations that have authorized/trusted the user.","description":"","operationId":"getUserTrustors","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustorEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find a user with that userId","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["authorization:orgTrustor:view"]},"x-purecloud-method-name":"getUserTrustors"}},"/api/v2/telephony/providers/edges/linebasesettings":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a listing of line base settings objects","description":"","operationId":"getTelephonyProvidersEdgesLinebasesettings","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Value by which to sort","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LineBaseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesLinebasesettings"}},"/api/v2/conversations/cobrowsesessions":{"get":{"tags":["Conversations"],"summary":"Get active cobrowse conversations for the logged in user","description":"","operationId":"getConversationsCobrowsesessions","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CobrowseConversationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCobrowsesessions"}},"/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/wrapupcodes":{"get":{"tags":["Conversations"],"summary":"Get list of wrapup codes for this conversation participant","description":"","operationId":"getConversationsCobrowsesessionParticipantWrapupcodes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCobrowsesessionParticipantWrapupcodes"}},"/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/attributes":{"patch":{"tags":["Conversations"],"summary":"Update the attributes on a conversation participant.","description":"","operationId":"patchConversationsCobrowsesessionParticipantAttributes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ParticipantAttributes"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsCobrowsesessionParticipantAttributes"}},"/api/v2/conversations/cobrowsesessions/{conversationId}":{"get":{"tags":["Conversations"],"summary":"Get cobrowse conversation","description":"","operationId":"getConversationsCobrowsesession","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CobrowseConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCobrowsesession"},"patch":{"tags":["Conversations"],"summary":"Update a conversation by disconnecting all of the participants","description":"","operationId":"patchConversationsCobrowsesession","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation","required":true,"schema":{"$ref":"#/definitions/Conversation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Conversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:disconnect"]},"x-purecloud-method-name":"patchConversationsCobrowsesession"}},"/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation participant. ","description":"","operationId":"getConversationsCobrowsesessionParticipantWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsCobrowsesessionParticipantWrapup"}},"/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/communications/{communicationId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant's communication by disconnecting it.","description":"","operationId":"patchConversationsCobrowsesessionParticipantCommunication","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"communication.state.required":"Can only update a communication's state to disconnected.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsCobrowsesessionParticipantCommunication"}},"/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant","description":"","operationId":"patchConversationsCobrowsesessionParticipant","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.participant.update.invalid":"Failed to update all properties on conversation participant.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.participant.update.failed":"Failed to update all properties on conversation participant.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsCobrowsesessionParticipant"}},"/api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/replace":{"post":{"tags":["Conversations"],"summary":"Replace this participant with the specified user and/or address","description":"","operationId":"postConversationsCobrowsesessionParticipantReplace","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/TransferRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","conversations.error.queue.not.found":"Interaction cannot be transferred to a queue that does not exist.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationsCobrowsesessionParticipantReplace"}},"/api/v2/telephony/providers/edges/logicalinterfaces":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get edge logical interfaces.","description":"Retrieve the configured logical interfaces for a list edges. Only 100 edges can be requested at a time.","operationId":"getTelephonyProvidersEdgesLogicalinterfaces","produces":["application/json"],"parameters":[{"name":"edgeIds","in":"query","description":"Comma separated list of Edge Id's","required":true,"type":"string"},{"name":"expand","in":"query","description":"Field to expand in the response","required":false,"type":"array","items":{"type":"string","enum":["externalTrunkBaseAssignments","phoneTrunkBaseAssignments"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"externalTrunkBaseAssignments"},{"name":"phoneTrunkBaseAssignments"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LogicalInterfaceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesLogicalinterfaces"}},"/api/v2/quality/agents/activity":{"get":{"tags":["Quality"],"summary":"Gets a list of Agent Activities","description":"Including the number of evaluations and average evaluation score","operationId":"getQualityAgentsActivity","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"startTime","in":"query","description":"Start time of agent activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","required":false,"type":"string","format":"date-time"},{"name":"endTime","in":"query","description":"End time of agent activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","required":false,"type":"string","format":"date-time"},{"name":"agentUserId","in":"query","description":"user id of agent requested","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"evaluatorUserId","in":"query","description":"user id of the evaluator","required":false,"type":"string"},{"name":"name","in":"query","description":"name","required":false,"type":"string"},{"name":"group","in":"query","description":"group id","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AgentActivityEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","quality.evaluation.view.permission.check.failed":"Failed to check required view permission.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluation:view"]},"x-purecloud-method-name":"getQualityAgentsActivity"}},"/api/v2/responsemanagement/responses/{responseId}":{"get":{"tags":["Response Management"],"summary":"Get details about an existing response.","description":"","operationId":"getResponsemanagementResponse","produces":["application/json"],"parameters":[{"name":"responseId","in":"path","description":"Response ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand instructions for the return value.","required":false,"type":"string","enum":["substitutionsSchema"],"x-genesys-enum-members":[{"name":"substitutionsSchema"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Response"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","rms.response.not.found":"The response could not be found"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management","response-management:readonly"]}],"x-purecloud-method-name":"getResponsemanagementResponse"},"put":{"tags":["Response Management"],"summary":"Update an existing response.","description":"Fields that can be updated: name, libraries, and texts. The most recent version is required for updates.","operationId":"putResponsemanagementResponse","produces":["application/json"],"parameters":[{"name":"responseId","in":"path","description":"Response ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Response","required":true,"schema":{"$ref":"#/definitions/Response"}},{"name":"expand","in":"query","description":"Expand instructions for the return value.","required":false,"type":"string","enum":["substitutionsSchema"],"x-genesys-enum-members":[{"name":"substitutionsSchema"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Response"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Resource conflict - Unexpected version was provided"},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management"]}],"x-purecloud-method-name":"putResponsemanagementResponse"},"delete":{"tags":["Response Management"],"summary":"Delete an existing response.","description":"This will remove the response from any libraries associated with it.","operationId":"deleteResponsemanagementResponse","produces":["application/json"],"parameters":[{"name":"responseId","in":"path","description":"Response ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["response-management"]}],"x-purecloud-method-name":"deleteResponsemanagementResponse"}},"/api/v2/telephony/providers/edges/{edgeId}/softwareversions":{"get":{"tags":["Telephony Providers Edge"],"summary":"Gets all the available software versions for this edge.","description":"","operationId":"getTelephonyProvidersEdgeSoftwareversions","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainEdgeSoftwareVersionDtoEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"Request badly formed.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-purecloud-method-name":"getTelephonyProvidersEdgeSoftwareversions"}},"/api/v2/flows/outcomes/{flowOutcomeId}":{"get":{"tags":["Architect"],"summary":"Get a flow outcome","description":"Returns a specified flow outcome","operationId":"getFlowsOutcome","produces":["application/json"],"parameters":[{"name":"flowOutcomeId","in":"path","description":"flow outcome ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowOutcome"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.outcome.not.found":"Specified flow outcome not found.","not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.feature.toggle.unavailable":"The required feature toggle is not enabled for this organization.","architect.flow.outcome.not.available":"Flow outcomes are not available for current organization."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowOutcome:view"]},"x-purecloud-method-name":"getFlowsOutcome"},"put":{"tags":["Architect"],"summary":"Updates a flow outcome","description":"Updates a flow outcome. Asynchronous. Notification topic: v2.flowoutcomes.{flowoutcomeId}","operationId":"putFlowsOutcome","produces":["application/json"],"parameters":[{"name":"flowOutcomeId","in":"path","description":"flow outcome ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/FlowOutcome"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Operation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","architect.flow.outcome.validate.failed.invalid.name":"Failed to validate flow outcome due to invalid name. Names can only contain letters, numbers, and the underscore, and must start with a letter or number.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","architect.property.exceeds.max.character.length":"The name and/or description exceeds the maximum character length.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","architect.flow.outcome.validate.failed.missing.description":"Failed to validate flow outcome due to missing description.","architect.object.validate.failed":"Failed to validate object.","architect.flow.outcome.validate.failed.invalid.name.no.alpha":"Failed to validate flow outcome due to invalid name. Names must contain at least one alphanumeric character.","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","architect.query.parameter.missing":"A required query parameter is missing or empty.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.outcome.not.found":"Could not find the specified flow outcome.","not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.feature.toggle.unavailable":"The required feature toggle is not enabled for this organization.","architect.flow.outcome.not.available":"Flow outcomes are not available for current organization."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.operation.already.in.progress":"An operation is already in progress on the object."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.unspecified.error":"An unknown error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowOutcome:edit"]},"x-purecloud-method-name":"putFlowsOutcome"}},"/api/v2/quality/surveys/{surveyId}":{"get":{"tags":["Quality"],"summary":"Get a survey for a conversation","description":"","operationId":"getQualitySurvey","produces":["application/json"],"parameters":[{"name":"surveyId","in":"path","description":"surveyId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Survey"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.survey.view.permission.check.failed":"Failed to check required view permission.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:survey:view"]},"x-purecloud-method-name":"getQualitySurvey"}},"/api/v2/scripts/{scriptId}/export":{"post":{"tags":["Scripts"],"summary":"Export a script via download service.","description":"","operationId":"postScriptExport","produces":["application/json"],"parameters":[{"name":"scriptId","in":"path","description":"Script ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/ExportScriptRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExportScriptResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:script:view"]},"x-purecloud-method-name":"postScriptExport"}},"/api/v2/telephony/providers/edges/{edgeId}/statuscode":{"post":{"tags":["Telephony Providers Edge"],"summary":"Take an Edge in or out of service","description":"","operationId":"postTelephonyProvidersEdgeStatuscode","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Edge Service State","required":false,"schema":{"$ref":"#/definitions/EdgeServiceStateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The active Edge(s) assigned to a Site must all be assigned to the same Edge Group.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Specified edgeId not found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgeStatuscode"}},"/api/v2/externalcontacts/contacts/{contactId}/notes/{noteId}":{"get":{"tags":["External Contacts"],"summary":"Fetch a note for an external contact","description":"","operationId":"getExternalcontactsContactNote","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact Id","required":true,"type":"string"},{"name":"noteId","in":"path","description":"Note Id","required":true,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["author","externalDataSources"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"author"},{"name":"externalDataSources"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Note"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Note is not found by note id.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:view"]},"x-purecloud-method-name":"getExternalcontactsContactNote"},"put":{"tags":["External Contacts"],"summary":"Update a note for an external contact","description":"","operationId":"putExternalcontactsContactNote","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact Id","required":true,"type":"string"},{"name":"noteId","in":"path","description":"Note Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Note","required":true,"schema":{"$ref":"#/definitions/Note"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Note"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided contact was not valid"}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:edit"]},"x-purecloud-method-name":"putExternalcontactsContactNote"},"delete":{"tags":["External Contacts"],"summary":"Delete a note for an external contact","description":"","operationId":"deleteExternalcontactsContactNote","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact Id","required":true,"type":"string"},{"name":"noteId","in":"path","description":"Note Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:edit"]},"x-purecloud-method-name":"deleteExternalcontactsContactNote"}},"/api/v2/routing/sms/phonenumbers/{addressId}":{"get":{"tags":["Routing"],"summary":"Get a phone number provisioned for SMS.","description":"","operationId":"getRoutingSmsPhonenumber","produces":["application/json"],"parameters":[{"name":"addressId","in":"path","description":"Address ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SmsPhoneNumber"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:view"]},"x-purecloud-method-name":"getRoutingSmsPhonenumber"},"put":{"tags":["Routing"],"summary":"Update a phone number provisioned for SMS.","description":"","operationId":"putRoutingSmsPhonenumber","produces":["application/json"],"parameters":[{"name":"addressId","in":"path","description":"Address ID","required":true,"type":"string"},{"in":"body","name":"body","description":"SmsPhoneNumber","required":true,"schema":{"$ref":"#/definitions/SmsPhoneNumber"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SmsPhoneNumber"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:edit"]},"x-purecloud-method-name":"putRoutingSmsPhonenumber"},"delete":{"tags":["Routing"],"summary":"Delete a phone number provisioned for SMS.","description":"","operationId":"deleteRoutingSmsPhonenumber","produces":["application/json"],"parameters":[{"name":"addressId","in":"path","description":"Address ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.short.code.operation":"Phone number Delete operation not allowed for phone number of type shortcode.","recipient.has.flow":"Phone number cannot be deleted with an existing flow associated to it. Remove associated flow before deleting phone number.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["sms:phoneNumber:delete"]},"x-purecloud-method-name":"deleteRoutingSmsPhonenumber"}},"/api/v2/outbound/callabletimesets":{"get":{"tags":["Outbound"],"summary":"Query callable time set list","description":"","operationId":"getOutboundCallabletimesets","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"allowEmptyResult","in":"query","description":"Whether to return an empty page when there are no results for that page","required":false,"type":"boolean","default":false},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"],"x-genesys-enum-members":[{"name":"Equals"},{"name":"RegEx"},{"name":"Contains"},{"name":"Prefix"},{"name":"LessThan"},{"name":"LessThanEqualTo"},{"name":"GreaterThan"},{"name":"GreaterThanEqualTo"},{"name":"BeginsWith"},{"name":"EndsWith"}]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallableTimeSetEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:callableTimeSet:view"]},"x-purecloud-method-name":"getOutboundCallabletimesets"},"post":{"tags":["Outbound"],"summary":"Create callable time set","description":"","operationId":"postOutboundCallabletimesets","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"DialerCallableTimeSet","required":true,"schema":{"$ref":"#/definitions/CallableTimeSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallableTimeSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","invalid.create":"","invalid.time.zone":"There is an unrecognized time zone.","missing.time.zone":"Each callable time must have a time zone identifier.","max.entity.count.reached":"The maximum callable time set count has been reached.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.start.time":"Start time must be before stop time.","invalid.day":"Days must be within 1 - 7.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:callableTimeSet:add"]},"x-purecloud-method-name":"postOutboundCallabletimesets"}},"/api/v2/architect/dependencytracking/types":{"get":{"tags":["Architect"],"summary":"Get Dependency Tracking types.","description":"","operationId":"getArchitectDependencytrackingTypes","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DependencyTypeEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:dependencyTracking:view"]},"x-purecloud-method-name":"getArchitectDependencytrackingTypes"}},"/api/v2/quality/forms/evaluations":{"get":{"tags":["Quality"],"summary":"Get the list of evaluation forms","description":"","operationId":"getQualityFormsEvaluations","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"expand","in":"query","description":"Expand","required":false,"type":"string"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Order to sort results, either asc or desc","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:view"]},"x-purecloud-method-name":"getQualityFormsEvaluations"},"post":{"tags":["Quality"],"summary":"Create an evaluation form.","description":"","operationId":"postQualityFormsEvaluations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Evaluation form","required":true,"schema":{"$ref":"#/definitions/EvaluationForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:add"]},"x-purecloud-method-name":"postQualityFormsEvaluations"}},"/api/v2/externalcontacts/organizations/schemas":{"get":{"tags":["External Contacts"],"summary":"Get a list of schemas.","description":"","operationId":"getExternalcontactsOrganizationsSchemas","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchemaListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"Unable to expand the schema."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getExternalcontactsOrganizationsSchemas"},"post":{"tags":["External Contacts"],"summary":"Create a schema","description":"","operationId":"postExternalcontactsOrganizationsSchemas","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Schema","required":true,"schema":{"$ref":"#/definitions/DataSchema"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.limit.max.number.of.fields.per.org.would.be.exceeded":"The total number of fields defined for all schemas cannot exceed 500.","dynamic.schema.validation.limit.error":"The new JSON schema provided for update has a validation limit error.","dynamic.schema.limit.max.number.of.schemas.per.org.would.be.exceeded":"There cannot be more than 20 schemas.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","dynamic.schema.incompatible.json.schema.update":"The JSON schema provided for update is incompatible with the previous version.","dynamic.schema.limit.max.number.of.characters.for.field.name.would.be.exceeded":"A field name cannot exceed 100 characters","dynamic.schema.validation.limit.missing":"The new JSON schema provided for update is missing a validation limit.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","dynamic.schema.invalid.json.schema":"An invalid JSON schema was provided.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","dynamic.schema.limit.max.number.of.fields.per.schema.would.be.exceeded":"A schema cannot have more than 25 fields"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.version.conflict":"A valid version is required."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"Unable to expand the schema."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:add"]},"x-purecloud-method-name":"postExternalcontactsOrganizationsSchemas"}},"/api/v2/routing/queues/me":{"get":{"tags":["Routing"],"summary":"Get a paged listing of queues the user is a member of.","description":"","operationId":"getRoutingQueuesMe","produces":["application/json"],"parameters":[{"name":"joined","in":"query","description":"Joined","required":false,"type":"boolean"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserQueueEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.page.number":"Invalid page number specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-purecloud-method-name":"getRoutingQueuesMe"}},"/api/v2/languageunderstanding/domains/{domainId}/versions":{"get":{"tags":["Language Understanding"],"summary":"Get all NLU Domain Versions for a given Domain.","description":"","operationId":"getLanguageunderstandingDomainVersions","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"includeUtterances","in":"query","description":"Whether utterances for intent definition should be included when marshalling response.","required":false,"type":"boolean"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluDomainVersionListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","dialog:readonly","language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomainVersion:view","dialog:botVersion:view"]},"x-purecloud-method-name":"getLanguageunderstandingDomainVersions"},"post":{"tags":["Language Understanding"],"summary":"Create an NLU Domain Version.","description":"","operationId":"postLanguageunderstandingDomainVersions","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"in":"body","name":"body","description":"The NLU Domain Version to create.","required":true,"schema":{"$ref":"#/definitions/NluDomainVersion"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluDomainVersion"}},"201":{"description":"Created an NLU Domain Version","schema":{"$ref":"#/definitions/NluDomainVersion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","language-understanding"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomainVersion:add","dialog:botVersion:add"]},"x-purecloud-method-name":"postLanguageunderstandingDomainVersions"}},"/api/v2/externalcontacts/relationships/{relationshipId}":{"get":{"tags":["External Contacts"],"summary":"Fetch a relationship","description":"","operationId":"getExternalcontactsRelationship","produces":["application/json"],"parameters":[{"name":"relationshipId","in":"path","description":"Relationship Id","required":true,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand","required":false,"type":"string","enum":["externalDataSources"],"x-genesys-enum-members":[{"name":"externalDataSources"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Relationship"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Relationship is not found by relationship id.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:externalOrganization:view"]},"x-purecloud-method-name":"getExternalcontactsRelationship"},"put":{"tags":["External Contacts"],"summary":"Update a relationship","description":"","operationId":"putExternalcontactsRelationship","produces":["application/json"],"parameters":[{"name":"relationshipId","in":"path","description":"Relationship Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Relationship","required":true,"schema":{"$ref":"#/definitions/Relationship"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Relationship"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided contact was not valid"}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:externalOrganization:edit"]},"x-purecloud-method-name":"putExternalcontactsRelationship"},"delete":{"tags":["External Contacts"],"summary":"Delete a relationship","description":"","operationId":"deleteExternalcontactsRelationship","produces":["application/json"],"parameters":[{"name":"relationshipId","in":"path","description":"Relationship Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:externalOrganization:edit"]},"x-purecloud-method-name":"deleteExternalcontactsRelationship"}},"/api/v2/organizations/whitelist":{"get":{"tags":["Organization"],"summary":"Use PUT /api/v2/organizations/embeddedintegration instead","description":"","operationId":"getOrganizationsWhitelist","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrgWhitelistSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getOrganizationsWhitelist"},"put":{"tags":["Organization"],"summary":"Use PUT /api/v2/organizations/embeddedintegration instead","description":"","operationId":"putOrganizationsWhitelist","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Whitelist settings","required":true,"schema":{"$ref":"#/definitions/OrgWhitelistSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrgWhitelistSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:organization:admin"]},"x-purecloud-method-name":"putOrganizationsWhitelist"}},"/api/v2/responsemanagement/libraries":{"get":{"tags":["Response Management"],"summary":"Gets a list of existing response libraries.","description":"","operationId":"getResponsemanagementLibraries","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"messagingTemplateFilter","in":"query","description":"Returns a list of libraries that contain responses with at least one messaging template defined for a specific message channel","required":false,"type":"string","enum":["whatsapp"],"x-genesys-enum-members":[{"name":"whatsapp"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LibraryEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management","response-management:readonly"]}],"x-purecloud-method-name":"getResponsemanagementLibraries"},"post":{"tags":["Response Management"],"summary":"Create a response library.","description":"","operationId":"postResponsemanagementLibraries","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Library","required":true,"schema":{"$ref":"#/definitions/Library"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Library"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management"]}],"x-purecloud-method-name":"postResponsemanagementLibraries"}},"/api/v2/conversations/faxes":{"post":{"tags":["Conversations"],"summary":"Create Fax Conversation","description":"","operationId":"postConversationsFaxes","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Fax","required":true,"schema":{"$ref":"#/definitions/FaxSendRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxSendResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"fax.content.type.not.supported":"The fax content type is not supported.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","fax.missing.field":"Missing required field.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"fax.forbidden":"You are not permitted to send faxes.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","fax.internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationsFaxes"}},"/api/v2/conversations/messaging/integrations/facebook/{integrationId}":{"get":{"tags":["Conversations"],"summary":"Get a Facebook messaging integration","description":"","operationId":"getConversationsMessagingIntegrationsFacebookIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FacebookIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:view"]},"x-purecloud-method-name":"getConversationsMessagingIntegrationsFacebookIntegrationId"},"delete":{"tags":["Conversations"],"summary":"Delete a Facebook messaging integration","description":"","operationId":"deleteConversationsMessagingIntegrationsFacebookIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:delete"]},"x-purecloud-method-name":"deleteConversationsMessagingIntegrationsFacebookIntegrationId"},"patch":{"tags":["Conversations"],"summary":"Update Facebook messaging integration","description":"","operationId":"patchConversationsMessagingIntegrationsFacebookIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"},{"in":"body","name":"body","description":"FacebookIntegrationUpdateRequest","required":true,"schema":{"$ref":"#/definitions/FacebookIntegrationUpdateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FacebookIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.integration":"The integration request was invalid for this operation. One or more errors may be reported.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:edit"]},"x-purecloud-method-name":"patchConversationsMessagingIntegrationsFacebookIntegrationId"}},"/api/v2/integrations/workforcemanagement/vendorconnection":{"post":{"tags":["Integrations"],"summary":"Add a vendor connection","description":"","operationId":"postIntegrationsWorkforcemanagementVendorconnection","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/VendorConnectionRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserActionCategoryEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-purecloud-method-name":"postIntegrationsWorkforcemanagementVendorconnection"}},"/api/v2/responsemanagement/responses/query":{"post":{"tags":["Response Management"],"summary":"Query responses","description":"","operationId":"postResponsemanagementResponsesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Response","required":true,"schema":{"$ref":"#/definitions/ResponseQueryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ResponseQueryResults"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","rms.field.unexpected.value":"One or more fields in the payload contained unexpected values."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"rms.internal.server.error":"The request failed due to an internal server error.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management","response-management:readonly"]}],"x-purecloud-method-name":"postResponsemanagementResponsesQuery"}},"/api/v2/conversations/{conversationId}":{"get":{"tags":["Conversations"],"summary":"Get conversation","description":"","operationId":"getConversation","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Conversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:view"]},"x-purecloud-method-name":"getConversation"}},"/api/v2/conversations/{conversationId}/assign":{"post":{"tags":["Conversations"],"summary":"Attempts to manually assign a specified conversation to a specified agent. Ignores bullseye ring, PAR score, skills, and languages.","description":"","operationId":"postConversationAssign","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Targeted user","required":true,"schema":{"$ref":"#/definitions/ConversationUser"}}],"responses":{"202":{"description":"The manual assignment request was accepted","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.status":"The agent's current routing status does not allow for new conversation assignments.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","feature.not.enabled":"The feature allowing manual assignment is not enabled for this queue.","operation.failed":"The manual assignment attempt failed.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"You do not have the required permission for this operation."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The conversation or queue could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Too many active requests. Try again later."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:call:pull","conversation:call:assign","conversation:callback:pull","conversation:callback:assign","conversation:webchat:pull","conversation:webchat:assign","conversation:email:pull","conversation:email:assign","conversation:message:pull","conversation:message:assign"]},"x-purecloud-method-name":"postConversationAssign"}},"/api/v2/conversations/{conversationId}/disconnect":{"post":{"tags":["Conversations"],"summary":"Performs a full conversation teardown. Issues disconnect requests for any connected media. Applies a system wrap-up code to any participants that are pending wrap-up. This is not intended to be the normal way of ending interactions but is available in the event of problems with the application to allow a resynchronization of state across all components. It is recommended that users submit a support case if they are relying on this endpoint systematically as there is likely something that needs investigation.","description":"","operationId":"postConversationDisconnect","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"}],"responses":{"202":{"description":"Accepted","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:disconnect"]},"x-purecloud-method-name":"postConversationDisconnect"}},"/api/v2/authorization/roles/{roleId}/subjectgrants":{"get":{"tags":["Authorization"],"summary":"Get the subjects' granted divisions in the specified role.","description":"Includes the divisions for which the subject has a grant.","operationId":"getAuthorizationRoleSubjectgrants","produces":["application/json"],"parameters":[{"name":"roleId","in":"path","description":"Role ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SubjectDivisionGrantsEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:view"]},"x-purecloud-method-name":"getAuthorizationRoleSubjectgrants"}},"/api/v2/quality/evaluations/scoring":{"post":{"tags":["Quality"],"summary":"Score evaluation","description":"","operationId":"postQualityEvaluationsScoring","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"evaluationAndScoringSet","required":true,"schema":{"$ref":"#/definitions/EvaluationFormAndScoringSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationScoringSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.scoring.unanswered.required.questions":"Submitted answers did not contain a response to a required question","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","quality.scoring.answer.not.in.evaluation.form":"Submitted answers contained reference to an answer which is not in the evaluation form","general.bad.request":"Request is badly formed.","quality.scoring.question.not.in.evaluation.form":"Submitted answers contained reference to a question which is not in the evaluation form","quality.scoring.question.group.not.in.evaluation.form":"Submitted answers contained reference to a question group which is not in the evaluation form","quality.scoring.unanswered.required.comments":"Submitted answers did not contain a comment where it was required","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-purecloud-method-name":"postQualityEvaluationsScoring"}},"/api/v2/recording/jobs/{jobId}":{"get":{"tags":["Recording"],"summary":"Get the status of the job associated with the job id.","description":"","operationId":"getRecordingJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["recording:job:view"]},"x-purecloud-method-name":"getRecordingJob"},"put":{"tags":["Recording"],"summary":"Execute the recording bulk job.","description":"A job must be executed by the same user whom originally created the job. In addition, the user must have permission to update the recording's retention.","operationId":"putRecordingJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"},{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/ExecuteRecordingJobsQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["recording:job:edit","recording:recording:editRetention","recording:screenRecording:editRetention"]},"x-purecloud-method-name":"putRecordingJob"},"delete":{"tags":["Recording"],"summary":"Delete the recording bulk job","description":"","operationId":"deleteRecordingJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["recording:job:delete"]},"x-purecloud-method-name":"deleteRecordingJob"}},"/api/v2/quality/forms/{formId}/versions":{"get":{"tags":["Quality"],"summary":"Gets all the revisions for a specific evaluation.","description":"","operationId":"getQualityFormVersions","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:view"]},"x-purecloud-method-name":"getQualityFormVersions"}},"/api/v2/telephony/providers/edges/{edgeId}/reboot":{"post":{"tags":["Telephony Providers Edge"],"summary":"Reboot an Edge","description":"","operationId":"postTelephonyProvidersEdgeReboot","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Parameters for the edge reboot","required":false,"schema":{"$ref":"#/definitions/EdgeRebootParameters"}}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Edge was not found.","general.resource.not.found":"Edge was not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgeReboot"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/shifttrades/matched":{"get":{"tags":["Workforce Management"],"summary":"Gets a summary of all shift trades in the matched state","description":"","operationId":"getWorkforcemanagementManagementunitShifttradesMatched","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ShiftTradeMatchesSummaryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:shiftTradeRequest:view","wfm:shiftTradeRequest:edit"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitShifttradesMatched"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/shifttrades/users":{"get":{"tags":["Workforce Management"],"summary":"Gets list of users available for whom you can send direct shift trade requests","description":"","operationId":"getWorkforcemanagementManagementunitShifttradesUsers","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WfmUserEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentShiftTradeRequest:participate"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitShifttradesUsers"}},"/api/v2/flows/datatables/{datatableId}/rows/{rowId}":{"get":{"tags":["Architect"],"summary":"Returns a specific row for the datatable","description":"Given a datatableId and a rowId (the value of the key field) this will return the full row contents for that rowId.","operationId":"getFlowsDatatableRow","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"name":"rowId","in":"path","description":"The key for the row","required":true,"type":"string"},{"name":"showbrief","in":"query","description":"if true returns just the key field for the row","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","flows.datatables.syntax.error":"There was an error parsing user data","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.table.not.found":"The datatable could not be found.","not.found":"The requested resource was not found.","flows.datatables.row.not.found":"The datatable row could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:view"]},"x-purecloud-method-name":"getFlowsDatatableRow"},"put":{"tags":["Architect"],"summary":"Update a row entry","description":"Updates a row with the given rowId (the value of the key field) to the new values. The DataTableRow should be a json-ized' stream of key -> value pairs\n{\n \"Field1\": \"XYZZY\",\n \"Field2\": false,\n \"KEY\": \"27272\"\n}","operationId":"putFlowsDatatableRow","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"name":"rowId","in":"path","description":"the key for the row","required":true,"type":"string"},{"in":"body","name":"body","description":"datatable row","required":false,"schema":{"type":"object","additionalProperties":{"type":"object"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.schema.exception":"The row didn't conform to the schema in some way","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","flows.datatables.syntax.error":"There was an error parsing user data","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.table.not.found":"The datatable could not be found.","not.found":"The requested resource was not found.","flows.datatables.row.not.found":"The datatable row could not be found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.not.unique":"The row had a duplicate keyname."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:edit"]},"x-purecloud-method-name":"putFlowsDatatableRow"},"delete":{"tags":["Architect"],"summary":"Delete a row entry","description":"Deletes a row with a given rowId (the value of the key field).","operationId":"deleteFlowsDatatableRow","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"name":"rowId","in":"path","description":"the key for the row","required":true,"type":"string"}],"responses":{"204":{"description":"The row was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","flows.datatables.syntax.error":"There was an error parsing user data"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:delete"]},"x-purecloud-method-name":"deleteFlowsDatatableRow"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/generationresults":{"get":{"tags":["Workforce Management"],"summary":"Gets the forecast generation results","description":"","operationId":"getWorkforcemanagementBusinessunitWeekShorttermforecastGenerationresults","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The business unit ID of the business unit to which the forecast belongs","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"forecastId","in":"path","description":"The ID of the forecast","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuForecastGenerationResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:shortTermForecast:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWeekShorttermforecastGenerationresults"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts":{"get":{"tags":["Workforce Management"],"summary":"Get short term forecasts","description":"Use \"recent\" for the `weekDateId` path parameter to fetch all forecasts for +/- 26 weeks from the current date. Response will include any forecast which spans the specified week","operationId":"getWorkforcemanagementBusinessunitWeekShorttermforecasts","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The business unit ID of the business unit to which the forecast belongs","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The week start date of the forecast in yyyy-MM-dd format or 'recent' to fetch recent forecasts","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuShortTermForecastListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.too.many.requests":"Too many requests in a given amount of time","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:generate","wfm:shortTermForecast:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWeekShorttermforecasts"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/generate":{"post":{"tags":["Workforce Management"],"summary":"Generate a short term forecast","description":"","operationId":"postWorkforcemanagementBusinessunitWeekShorttermforecastsGenerate","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The business unit ID of the business unit to which the forecast belongs","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"forceAsync","in":"query","description":"Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes","required":false,"type":"boolean"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/GenerateBuForecastRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncForecastOperationResult"}},"201":{"description":"The forecast was successfully generated","schema":{"$ref":"#/definitions/AsyncForecastOperationResult"}},"202":{"description":"The request was accepted and the result will be sent asynchronously via notification","schema":{"$ref":"#/definitions/AsyncForecastOperationResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"502":{"description":"Bad Gateway","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.server.error":"WFM Server Error"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:shortTermForecast:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitWeekShorttermforecastsGenerate"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}":{"get":{"tags":["Workforce Management"],"summary":"Get a short term forecast","description":"","operationId":"getWorkforcemanagementBusinessunitWeekShorttermforecast","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The business unit ID of the business unit to which the forecast belongs","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"forecastId","in":"path","description":"The ID of the forecast","required":true,"type":"string"},{"name":"expand","in":"query","required":false,"type":"array","items":{"type":"string","enum":["planningGroups","generationResults"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"planningGroups"},{"name":"generationResults"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuShortTermForecast"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:shortTermForecast:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWeekShorttermforecast"},"delete":{"tags":["Workforce Management"],"summary":"Delete a short term forecast","description":"Must not be tied to any schedules","operationId":"deleteWorkforcemanagementBusinessunitWeekShorttermforecast","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The business unit ID of the business unit to which the forecast belongs","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"forecastId","in":"path","description":"The ID of the forecast","required":true,"type":"string"}],"responses":{"204":{"description":"The forecast was successfully deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:shortTermForecast:delete"]},"x-purecloud-method-name":"deleteWorkforcemanagementBusinessunitWeekShorttermforecast"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/planninggroups":{"get":{"tags":["Workforce Management"],"summary":"Gets the forecast planning group snapshot","description":"","operationId":"getWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroups","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The business unit ID of the business unit to which the forecast belongs","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"forecastId","in":"path","description":"The ID of the forecast","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ForecastPlanningGroupsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:shortTermForecast:view","wfm:schedule:view","wfm:publishedSchedule:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroups"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/data":{"get":{"tags":["Workforce Management"],"summary":"Get the result of a short term forecast calculation","description":"Includes modifications unless you pass the doNotApplyModifications query parameter","operationId":"getWorkforcemanagementBusinessunitWeekShorttermforecastData","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The business unit ID of the business unit to which the forecast belongs","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"forecastId","in":"path","description":"The ID of the forecast","required":true,"type":"string"},{"name":"weekNumber","in":"query","description":"The week number to fetch (for multi-week forecasts)","required":false,"type":"integer","format":"int32"},{"name":"forceDownloadService","in":"query","description":"Force the result of this operation to be sent via download service. For testing/app development purposes","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuForecastResultResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:shortTermForecast:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWeekShorttermforecastData"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/copy":{"post":{"tags":["Workforce Management"],"summary":"Copy a short term forecast","description":"","operationId":"postWorkforcemanagementBusinessunitWeekShorttermforecastCopy","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The business unit ID of the business unit to which the forecast belongs","required":true,"type":"string"},{"name":"weekDateId","in":"path","description":"The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"forecastId","in":"path","description":"The ID of the forecast to copy","required":true,"type":"string"},{"name":"forceAsync","in":"query","description":"Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes","required":false,"type":"boolean"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/CopyBuForecastRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncForecastOperationResult"}},"201":{"description":"The forecast was created","schema":{"$ref":"#/definitions/AsyncForecastOperationResult"}},"202":{"description":"The request was accepted and the result will be sent asynchronously via notification","schema":{"$ref":"#/definitions/AsyncForecastOperationResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:shortTermForecast:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitWeekShorttermforecastCopy"}},"/api/v2/flows/{flowId}/versions":{"get":{"tags":["Architect"],"summary":"Get flow version list","description":"","operationId":"getFlowVersions","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"deleted","in":"query","description":"Include Deleted flows","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowVersionEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.flow.not.found":"Could not find flow with specified ID."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:view"]},"x-purecloud-method-name":"getFlowVersions"},"post":{"tags":["Architect"],"summary":"Create flow version","description":"","operationId":"postFlowVersions","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"type":"object","additionalProperties":{"type":"object"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowVersion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","architect.flow.data.missing":"Flow version data content is missing.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","architect.object.validate.failed":"Failed to validate object.","architect.flow.version.validate.failed.configuration.version":"Flow version object configuration version is missing or invalid.","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.flow.not.found":"Could not find flow with specified ID."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.debug.flow.invalid.operation":"Cannot perform requested operation on a debug flow."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.not.locked.by.user":"Flow is not locked by requesting user."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.save.failed":"Could not save flow data to permanent storage.","architect.object.update.failed":"The database update for the object failed.","architect.flow.data.invalid.format":"Flow version data content is in an invalid format.","architect.flow.serialize.failed":"Could not serialize flow data.","architect.external.user.query.error":"Failed querying backend service for information on user.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:edit"]},"x-purecloud-method-name":"postFlowVersions"}},"/api/v2/authorization/divisionspermitted/me":{"get":{"tags":["Authorization","Users"],"summary":"Returns which divisions the current user has the given permission in.","description":"This route is deprecated, use authorization/divisionspermitted/paged/me instead.","operationId":"getAuthorizationDivisionspermittedMe","produces":["application/json"],"parameters":[{"name":"name","in":"query","description":"Search term to filter by division name","required":false,"type":"string"},{"name":"permission","in":"query","description":"The permission string, including the object to access, e.g. routing:queue:view","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/AuthzDivision"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","missing.permission.param":"Missing required permission parameter","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getAuthorizationDivisionspermittedMe"}},"/api/v2/fax/documents/{documentId}":{"get":{"tags":["Fax"],"summary":"Get a document.","description":"","operationId":"getFaxDocument","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxDocument"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Access to a document is not permitted by given document id."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["fax","fax:readonly"]}],"x-purecloud-method-name":"getFaxDocument"},"put":{"tags":["Fax"],"summary":"Update a fax document.","description":"","operationId":"putFaxDocument","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Document","required":true,"schema":{"$ref":"#/definitions/FaxDocument"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxDocument"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["fax"]}],"x-purecloud-method-name":"putFaxDocument"},"delete":{"tags":["Fax"],"summary":"Delete a fax document.","description":"","operationId":"deleteFaxDocument","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"}],"responses":{"202":{"description":"Accepted - Processing Delete"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["fax"]}],"x-purecloud-method-name":"deleteFaxDocument"}},"/api/v2/telephony/providers/edges/didpools":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a listing of DID Pools","description":"","operationId":"getTelephonyProvidersEdgesDidpools","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"number"},{"name":"id","in":"query","description":"Filter by a specific list of ID's","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DIDPoolEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesDidpools"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a new DID pool","description":"","operationId":"postTelephonyProvidersEdgesDidpools","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"DID pool","required":true,"schema":{"$ref":"#/definitions/DIDPool"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DIDPool"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be completed by the server due to a conflict."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesDidpools"}},"/api/v2/timezones":{"get":{"tags":["Utilities"],"summary":"Get time zones list","description":"","operationId":"getTimezones","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeZoneEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":[]}],"x-purecloud-method-name":"getTimezones"}},"/api/v2/workforcemanagement/adhocmodelingjobs/{jobId}":{"get":{"tags":["Workforce Management"],"summary":"Get status of the modeling job","description":"","operationId":"getWorkforcemanagementAdhocmodelingjob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"The id of the modeling job","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ModelingStatusResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:adhocModel:view"]},"x-purecloud-method-name":"getWorkforcemanagementAdhocmodelingjob"}},"/api/v2/contentmanagement/workspaces/{workspaceId}/members/{memberId}":{"get":{"tags":["Content Management"],"summary":"Get a workspace member","description":"","operationId":"getContentmanagementWorkspaceMember","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"memberId","in":"path","description":"Member ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["member"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"member"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkspaceMember"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden to get a member from a workspace."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementWorkspaceMember"},"put":{"tags":["Content Management"],"summary":"Add a member to a workspace","description":"","operationId":"putContentmanagementWorkspaceMember","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"memberId","in":"path","description":"Member ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Workspace Member","required":true,"schema":{"$ref":"#/definitions/WorkspaceMember"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkspaceMember"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden to add a member to a workspace."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"putContentmanagementWorkspaceMember"},"delete":{"tags":["Content Management"],"summary":"Delete a member from a workspace","description":"","operationId":"deleteContentmanagementWorkspaceMember","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"memberId","in":"path","description":"Member ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden to delete a member from a workspace."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"deleteContentmanagementWorkspaceMember"}},"/api/v2/authorization/products":{"get":{"tags":["Authorization"],"summary":"Get the list of enabled products","description":"Gets the list of enabled products. Some example product names are: collaborateFree, collaboratePro, communicate, and engage.","operationId":"getAuthorizationProducts","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationProductEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-purecloud-method-name":"getAuthorizationProducts"}},"/api/v2/contentmanagement/workspaces/{workspaceId}/members":{"get":{"tags":["Content Management"],"summary":"Get a list workspace members","description":"","operationId":"getContentmanagementWorkspaceMembers","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["member"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"member"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkspaceMemberEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden to get workspace members"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementWorkspaceMembers"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings":{"get":{"tags":["Knowledge"],"summary":"Get all trainings information for a knowledgebase","description":"","operationId":"getKnowledgeKnowledgebaseLanguageTrainings","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","de-DE"],"x-genesys-enum-members":[{"name":"en-US"},{"name":"de-DE"}]},{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"limit","in":"query","description":"Number of entities to return. Maximum of 200. Deprecated in favour of pageSize.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"name":"knowledgeDocumentsState","in":"query","description":"Return the training with the specified state of the trained documents.","required":false,"type":"string","enum":["Draft","Active","Discarded","Archived"],"x-genesys-enum-members":[{"name":"Draft"},{"name":"Active"},{"name":"Discarded"},{"name":"Archived"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrainingListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:training:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseLanguageTrainings"},"post":{"tags":["Knowledge"],"summary":"Trigger training","description":"","operationId":"postKnowledgeKnowledgebaseLanguageTrainings","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","de-DE"],"x-genesys-enum-members":[{"name":"en-US"},{"name":"de-DE"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeTraining"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:training:create"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseLanguageTrainings"}},"/api/v2/externalcontacts/organizations/{externalOrganizationId}/relationships":{"get":{"tags":["External Contacts"],"summary":"Fetch a relationship for an external organization","description":"","operationId":"getExternalcontactsOrganizationRelationships","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":20,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"which fields, if any, to expand","required":false,"type":"string","enum":["externalDataSources"],"x-genesys-enum-members":[{"name":"externalDataSources"}]},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RelationshipListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:view","externalContacts:externalOrganization:view"]},"x-purecloud-method-name":"getExternalcontactsOrganizationRelationships"}},"/api/v2/outbound/campaigns/divisionviews":{"get":{"tags":["Outbound"],"summary":"Query a list of basic Campaign information objects","description":"This returns a simplified version of a Campaign, consisting of name and division.","operationId":"getOutboundCampaignsDivisionviews","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"],"x-genesys-enum-members":[{"name":"Equals"},{"name":"RegEx"},{"name":"Contains"},{"name":"Prefix"},{"name":"LessThan"},{"name":"LessThanEqualTo"},{"name":"GreaterThan"},{"name":"GreaterThanEqualTo"},{"name":"BeginsWith"},{"name":"EndsWith"}]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignDivisionViewListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:campaign:search"]},"x-purecloud-method-name":"getOutboundCampaignsDivisionviews"}},"/api/v2/outbound/dnclists/divisionviews/{dncListId}":{"get":{"tags":["Outbound"],"summary":"Get a basic DncList information object","description":"This returns a simplified version of a DncList, consisting of the name, division, import status, and size.","operationId":"getOutboundDnclistsDivisionview","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"Dnclist ID","required":true,"type":"string"},{"name":"includeImportStatus","in":"query","description":"Include import status","required":false,"type":"boolean","default":false},{"name":"includeSize","in":"query","description":"Include size","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DncListDivisionView"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:dncList:search"]},"x-purecloud-method-name":"getOutboundDnclistsDivisionview"}},"/api/v2/outbound/attemptlimits/{attemptLimitsId}":{"get":{"tags":["Outbound"],"summary":"Get attempt limits","description":"","operationId":"getOutboundAttemptlimit","produces":["application/json"],"parameters":[{"name":"attemptLimitsId","in":"path","description":"Attempt limits ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AttemptLimits"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:attemptLimits:view"]},"x-purecloud-method-name":"getOutboundAttemptlimit"},"put":{"tags":["Outbound"],"summary":"Update attempt limits","description":"","operationId":"putOutboundAttemptlimit","produces":["application/json"],"parameters":[{"name":"attemptLimitsId","in":"path","description":"Attempt limits ID","required":true,"type":"string"},{"in":"body","name":"body","description":"AttemptLimits","required":true,"schema":{"$ref":"#/definitions/AttemptLimits"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AttemptLimits"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"incorrect.max.value":"Max values must be > 0 and one of them must be defined","name.cannot.be.blank":"A name must be provided.","exceeded.max.attempts.per.contact":"The maximum attempts allowed per contact is 100.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","duplicate.name":"The name already exists.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.time.zone":"Not recognized as a valid time zone.","exceeded.max.attempts.per.number":"The maximum attempts allowed per number is 100.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:attemptLimits:edit"]},"x-purecloud-method-name":"putOutboundAttemptlimit"},"delete":{"tags":["Outbound"],"summary":"Delete attempt limits","description":"","operationId":"deleteOutboundAttemptlimit","produces":["application/json"],"parameters":[{"name":"attemptLimitsId","in":"path","description":"Attempt limits ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","referential.integrity.error":"Could not delete the resource because it is referenced by another entity."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:attemptLimits:delete"]},"x-purecloud-method-name":"deleteOutboundAttemptlimit"}},"/api/v2/stations/settings":{"get":{"tags":["Stations"],"summary":"Get an organization's StationSettings","description":"","operationId":"getStationsSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/StationSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["stations","stations:readonly"]}],"x-purecloud-method-name":"getStationsSettings"},"patch":{"tags":["Stations"],"summary":"Patch an organization's StationSettings","description":"","operationId":"patchStationsSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Station settings","required":true,"schema":{"$ref":"#/definitions/StationSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/StationSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["stations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"patchStationsSettings"}},"/api/v2/usage/query/{executionId}/results":{"get":{"tags":["Usage"],"summary":"Get the results of a usage query","description":"","operationId":"getUsageQueryExecutionIdResults","produces":["application/json"],"parameters":[{"name":"executionId","in":"path","description":"ID of the query execution","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ApiUsageQueryResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:view"]},"x-purecloud-method-name":"getUsageQueryExecutionIdResults"}},"/api/v2/groups/{groupId}/greetings":{"get":{"tags":["Greetings"],"summary":"Get a list of the Group's Greetings","description":"","operationId":"getGroupGreetings","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GreetingListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings","greetings:readonly"]}],"x-purecloud-method-name":"getGroupGreetings"},"post":{"tags":["Greetings"],"summary":"Creates a Greeting for a Group","description":"","operationId":"postGroupGreetings","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The Greeting to create","required":true,"schema":{"$ref":"#/definitions/Greeting"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Greeting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings"]}],"x-purecloud-method-name":"postGroupGreetings"}},"/api/v2/configuration/schemas/edges/vnext":{"get":{"tags":["Telephony Providers Edge"],"summary":"Lists available schema categories (Deprecated)","description":"","operationId":"getConfigurationSchemasEdgesVnext","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SchemaCategoryEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getConfigurationSchemasEdgesVnext"}},"/api/v2/notifications/channels":{"get":{"tags":["Notifications"],"summary":"The list of existing channels","description":"","operationId":"getNotificationsChannels","produces":["application/json"],"parameters":[{"name":"includechannels","in":"query","description":"Show user's channels for this specific token or across all tokens for this user and app. Channel Ids for other access tokens will not be shown, but will be presented to show their existence.","required":false,"type":"string","default":"token","enum":["token","oauthclient"],"x-genesys-enum-members":[{"name":"token"},{"name":"oauthclient"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChannelEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["notifications"]}],"x-purecloud-method-name":"getNotificationsChannels"},"post":{"tags":["Notifications"],"summary":"Create a new channel","description":"There is a limit of 20 channels per user/app combination. Creating a 21st channel will remove the channel with oldest last used date. Channels without an active connection will be removed first.","operationId":"postNotificationsChannels","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Channel"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["notifications"]}],"x-purecloud-method-name":"postNotificationsChannels"}},"/api/v2/telephony/providers/edges/phones/reboot":{"post":{"tags":["Telephony Providers Edge"],"summary":"Reboot Multiple Phones","description":"","operationId":"postTelephonyProvidersEdgesPhonesReboot","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Phones","required":true,"schema":{"$ref":"#/definitions/PhonesReboot"}}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","providerapi.error.phone.no.active.edge":"Phone is not connected to an active edge and cannot be rebooted."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesPhonesReboot"}},"/api/v2/telephony/providers/edges/availablelanguages":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of available languages.","description":"","operationId":"getTelephonyProvidersEdgesAvailablelanguages","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AvailableLanguageList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-purecloud-method-name":"getTelephonyProvidersEdgesAvailablelanguages"}},"/api/v2/quality/conversations/{conversationId}/audits":{"get":{"tags":["Quality"],"summary":"Get audits for conversation or recording","description":"Different permissions are required for viewing different resource audit entries. The quality:evaluation:viewAudit permission is required to view evaluation audits, the recording:recording:viewAudit permission is required to view recording audits, and so on.","operationId":"getQualityConversationAudits","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"recordingId","in":"query","description":"id of the recording","required":false,"type":"string"},{"name":"entityType","in":"query","description":"entity type options: Recording, Calibration, Evaluation, Annotation, Screen_Recording","required":false,"type":"string","default":"Recording"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QualityAuditPage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.screen.recording.audit.view.permission.check.failed":"Screen recording audit view permission check failed.","recording.recording.audit.view.permission.check.failed":"Recording audit view permission check failed.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:calibration:viewAudit","quality:evaluation:viewAudit","quality:survey:viewAudit","recording:recording:viewAudit","recording:annotation:viewAudit","recording:screenRecording:viewAudit"]},"x-purecloud-method-name":"getQualityConversationAudits"}},"/api/v2/integrations/actions/categories":{"get":{"tags":["Integrations"],"summary":"Retrieves all categories of available Actions","description":"","operationId":"getIntegrationsActionsCategories","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Root level field name to sort on.","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Direction to sort 'sortBy' field.","required":false,"type":"string","default":"asc","enum":["ASC","DESC"],"x-genesys-enum-members":[{"name":"ASC"},{"name":"DESC"}]},{"name":"secure","in":"query","description":"Filter to only include secure actions. True will only include actions marked secured. False will include only unsecure actions. Do not use filter if you want all Actions.","required":false,"type":"string","enum":["true","false"],"x-genesys-enum-members":[{"name":"true"},{"name":"false"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CategoryEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:view","bridge:actions:view"]},"x-purecloud-method-name":"getIntegrationsActionsCategories"}},"/api/v2/fieldconfig":{"get":{"tags":["Organization","Groups","Users"],"summary":"Fetch field config for an entity type","description":"","operationId":"getFieldconfig","produces":["application/json"],"parameters":[{"name":"type","in":"query","description":"Field type","required":true,"type":"string","enum":["person","group","org","externalContact"],"x-genesys-enum-members":[{"name":"person"},{"name":"group"},{"name":"org"},{"name":"externalContact"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FieldConfig"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","bad.entity.type":"The entity type is invalid.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getFieldconfig"}},"/api/v2/voicemail/groups/{groupId}/messages":{"get":{"tags":["Voicemail"],"summary":"List voicemail messages","description":"","operationId":"getVoicemailGroupMessages","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMessageEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","voicemail.not.authorized.voicemail.message":"Not authorized to access voicemail messages","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-purecloud-method-name":"getVoicemailGroupMessages"}},"/api/v2/identityproviders/salesforce":{"get":{"tags":["Identity Provider"],"summary":"Get Salesforce Identity Provider","description":"","operationId":"getIdentityprovidersSalesforce","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Salesforce"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersSalesforce"},"put":{"tags":["Identity Provider"],"summary":"Update/Create Salesforce Identity Provider","description":"","operationId":"putIdentityprovidersSalesforce","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/Salesforce"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.issuer.uri":"An issuer URI is required.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.target.url":"The target URL must be a valid HTTPS URL.","certificate.not.yet.valid":"The certificate is not yet valid.","certificate.invalid.base64":"Invalid base64 in certificate.","certificate.unparseable":"The certificate for provider cannot be parsed.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersSalesforce"},"delete":{"tags":["Identity Provider"],"summary":"Delete Salesforce Identity Provider","description":"","operationId":"deleteIdentityprovidersSalesforce","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersSalesforce"}},"/api/v2/documentation/search":{"get":{"tags":["Search"],"summary":"Search documentation using the q64 value returned from a previous search","description":"","operationId":"getDocumentationSearch","produces":["application/json"],"parameters":[{"name":"q64","in":"query","description":"q64","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentationSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"getDocumentationSearch"},"post":{"tags":["Search"],"summary":"Search documentation","description":"","operationId":"postDocumentationSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/DocumentationSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentationSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","unsupported.search.entity.type":"Search entity type is not supported."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"postDocumentationSearch"}},"/api/v2/architect/dependencytracking/consumedresources":{"get":{"tags":["Architect"],"summary":"Get resources that are consumed by a given Dependency Tracking object","description":"","operationId":"getArchitectDependencytrackingConsumedresources","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"Consuming object ID","required":true,"type":"string"},{"name":"version","in":"query","description":"Consuming object version","required":true,"type":"string"},{"name":"objectType","in":"query","description":"Consuming object type. Only versioned types are allowed here.","required":true,"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","BOTCONNECTORBOT","BOTCONNECTORBOTVERSION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GROUP","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","IVRCONFIGURATION","LANGUAGE","LEXBOT","LEXBOTALIAS","NLUDOMAIN","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","WIDGET","WORKFLOW"],"x-genesys-enum-members":[{"name":"ACDLANGUAGE"},{"name":"ACDSKILL"},{"name":"ACDWRAPUPCODE"},{"name":"BOTCONNECTORBOT"},{"name":"BOTCONNECTORBOTVERSION"},{"name":"BOTFLOW"},{"name":"BRIDGEACTION"},{"name":"COMMONMODULEFLOW"},{"name":"COMPOSERSCRIPT"},{"name":"CONTACTLIST"},{"name":"DATAACTION"},{"name":"DATATABLE"},{"name":"DIALOGENGINEBOT"},{"name":"DIALOGENGINEBOTVERSION"},{"name":"DIALOGFLOWAGENT"},{"name":"EMAILROUTE"},{"name":"EMERGENCYGROUP"},{"name":"FLOWACTION"},{"name":"FLOWDATATYPE"},{"name":"FLOWMILESTONE"},{"name":"FLOWOUTCOME"},{"name":"GROUP"},{"name":"INBOUNDCALLFLOW"},{"name":"INBOUNDCHATFLOW"},{"name":"INBOUNDEMAILFLOW"},{"name":"INBOUNDSHORTMESSAGEFLOW"},{"name":"INQUEUECALLFLOW"},{"name":"IVRCONFIGURATION"},{"name":"LANGUAGE"},{"name":"LEXBOT"},{"name":"LEXBOTALIAS"},{"name":"NLUDOMAIN"},{"name":"OUTBOUNDCALLFLOW"},{"name":"QUEUE"},{"name":"RECORDINGPOLICY"},{"name":"RESPONSE"},{"name":"SCHEDULE"},{"name":"SCHEDULEGROUP"},{"name":"SECUREACTION"},{"name":"SECURECALLFLOW"},{"name":"SURVEYINVITEFLOW"},{"name":"SYSTEMPROMPT"},{"name":"TTSENGINE"},{"name":"TTSVOICE"},{"name":"USER"},{"name":"USERPROMPT"},{"name":"WIDGET"},{"name":"WORKFLOW"}]},{"name":"resourceType","in":"query","description":"Types of consumed resources to show","required":false,"type":"array","items":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","BOTCONNECTORBOT","BOTCONNECTORBOTVERSION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GROUP","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","IVRCONFIGURATION","LANGUAGE","LEXBOT","LEXBOTALIAS","NLUDOMAIN","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","WIDGET","WORKFLOW"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"ACDLANGUAGE"},{"name":"ACDSKILL"},{"name":"ACDWRAPUPCODE"},{"name":"BOTCONNECTORBOT"},{"name":"BOTCONNECTORBOTVERSION"},{"name":"BOTFLOW"},{"name":"BRIDGEACTION"},{"name":"COMMONMODULEFLOW"},{"name":"COMPOSERSCRIPT"},{"name":"CONTACTLIST"},{"name":"DATAACTION"},{"name":"DATATABLE"},{"name":"DIALOGENGINEBOT"},{"name":"DIALOGENGINEBOTVERSION"},{"name":"DIALOGFLOWAGENT"},{"name":"EMAILROUTE"},{"name":"EMERGENCYGROUP"},{"name":"FLOWACTION"},{"name":"FLOWDATATYPE"},{"name":"FLOWMILESTONE"},{"name":"FLOWOUTCOME"},{"name":"GROUP"},{"name":"INBOUNDCALLFLOW"},{"name":"INBOUNDCHATFLOW"},{"name":"INBOUNDEMAILFLOW"},{"name":"INBOUNDSHORTMESSAGEFLOW"},{"name":"INQUEUECALLFLOW"},{"name":"IVRCONFIGURATION"},{"name":"LANGUAGE"},{"name":"LEXBOT"},{"name":"LEXBOTALIAS"},{"name":"NLUDOMAIN"},{"name":"OUTBOUNDCALLFLOW"},{"name":"QUEUE"},{"name":"RECORDINGPOLICY"},{"name":"RESPONSE"},{"name":"SCHEDULE"},{"name":"SCHEDULEGROUP"},{"name":"SECUREACTION"},{"name":"SECURECALLFLOW"},{"name":"SURVEYINVITEFLOW"},{"name":"SYSTEMPROMPT"},{"name":"TTSENGINE"},{"name":"TTSVOICE"},{"name":"USER"},{"name":"USERPROMPT"},{"name":"WIDGET"},{"name":"WORKFLOW"}]},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConsumedResourcesEntityListing"}},"206":{"description":"Partial Content - the org data is being rebuilt or needs to be rebuilt."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","architect.dependency.object.version.not.specified":"A version was not specified for the dependency object.","architect.query.parameter.missing":"A required query parameter is missing or empty.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","architect.dependency.object.invalid.type":"An invalid dependency object type was specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.version.missing":"Specified flow version is missing.","not.found":"The requested resource was not found.","architect.dependency.object.not.found":"Could not find the dependency object with specified ID and version.","architect.flow.not.found":"Could not find flow with specified ID."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","architect.database.throughput.exceeded":"Database too busy. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:dependencyTracking:view"]},"x-purecloud-method-name":"getArchitectDependencytrackingConsumedresources"}},"/api/v2/conversations/chats/{conversationId}/communications/{communicationId}/typing":{"post":{"tags":["Conversations"],"summary":"Send a typing-indicator on behalf of a communication in a chat conversation.","description":"","operationId":"postConversationsChatCommunicationTyping","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatTyping"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","chat.error.conversation.state":"The conversation is in a state which does not permit this action.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","chat.error.member.state":"The conversation member is in a state which does not permit this action.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.not.found":"chat conversation typing-indicator is not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"postConversationsChatCommunicationTyping"}},"/api/v2/conversations/chats/{conversationId}/communications/{communicationId}/messages":{"post":{"tags":["Conversations"],"summary":"Send a message on behalf of a communication in a chat conversation.","description":"","operationId":"postConversationsChatCommunicationMessages","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Message","required":true,"schema":{"$ref":"#/definitions/CreateWebChatMessageRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.notnull.createconversationmessagerequest.body":"chat error occurred due to null request body.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","chat.error.conversation.state":"The conversation is in a state which does not permit this action.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","chat.error.member.state":"The conversation member is in a state which does not permit this action.","chat.error.bad.request":"Chat error occurred due to bad request.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.not.found":"Chat conversation message is not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"postConversationsChatCommunicationMessages"}},"/api/v2/coaching/appointments/{appointmentId}":{"get":{"tags":["Coaching"],"summary":"Retrieve an appointment","description":"Permission not required if you are the attendee, creator or facilitator of the appointment","operationId":"getCoachingAppointment","produces":["application/json"],"parameters":[{"name":"appointmentId","in":"path","description":"The ID of the coaching appointment.","required":true,"type":"string"}],"responses":{"200":{"description":"Retrieved appointment","schema":{"$ref":"#/definitions/CoachingAppointmentResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"User does not have the appointment view permission and is not an attendee, creator or facilitator of the appointment"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.not.found":"Appointment not found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","coaching:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:appointment:view"]},"x-purecloud-method-name":"getCoachingAppointment"},"delete":{"tags":["Coaching"],"summary":"Delete an existing appointment","description":"Permission not required if you are the creator of the appointment","operationId":"deleteCoachingAppointment","produces":["application/json"],"parameters":[{"name":"appointmentId","in":"path","description":"The ID of the coaching appointment.","required":true,"type":"string"}],"responses":{"202":{"description":"Appointment delete request accepted.","schema":{"$ref":"#/definitions/CoachingAppointmentReference"}},"204":{"description":"Appointment deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"User does not have the appointment delete permission and is not a creator of the appointment"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.not.found":"Appointment not found","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.conflict":"There as a conflict deleting the appointment."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:appointment:delete"]},"x-purecloud-method-name":"deleteCoachingAppointment"},"patch":{"tags":["Coaching"],"summary":"Update an existing appointment","description":"Permission not required if you are the creator or facilitator of the appointment","operationId":"patchCoachingAppointment","produces":["application/json"],"parameters":[{"name":"appointmentId","in":"path","description":"The ID of the coaching appointment.","required":true,"type":"string"},{"in":"body","name":"body","description":"The new version of the appointment","required":true,"schema":{"$ref":"#/definitions/UpdateCoachingAppointmentRequest"}}],"responses":{"200":{"description":"Appointment updated","schema":{"$ref":"#/definitions/CoachingAppointmentResponse"}},"202":{"description":"Appointment update request accepted.","schema":{"$ref":"#/definitions/CoachingAppointmentReference"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"participate.permission.missing":"Some participants are missing the 'coaching:appointment:participate' permission.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"User does not have the appointment edit permission and is not a creator or facilitator of the appointment"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.not.found":"Appointment not found","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.conflict":"Appointment dates clashes with another","appointment.state.conflict":"The state of the appointment prevents the changes you are requesting."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:appointment:edit"]},"x-purecloud-method-name":"patchCoachingAppointment"}},"/api/v2/coaching/appointments/{appointmentId}/conversations":{"post":{"tags":["Coaching"],"summary":"Add a conversation to an appointment","description":"Permission not required if you are the creator or facilitator of the appointment","operationId":"postCoachingAppointmentConversations","produces":["application/json"],"parameters":[{"name":"appointmentId","in":"path","description":"The ID of the coaching appointment.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/AddConversationRequest"}}],"responses":{"200":{"description":"Conversation Added","schema":{"$ref":"#/definitions/AddConversationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"User does not have the permissions and is not a creator or facilitator of the appointment"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.not.found":"Appointment not found","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.state.conflict":"The state of the appointment prevents the changes you are requesting."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:appointment:edit","coaching:appointmentConversation:add"]},"x-purecloud-method-name":"postCoachingAppointmentConversations"}},"/api/v2/conversations/messaging/integrations/whatsapp":{"get":{"tags":["Conversations"],"summary":"Get a list of WhatsApp Integrations","description":"","operationId":"getConversationsMessagingIntegrationsWhatsapp","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WhatsAppIntegrationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:view"]},"x-purecloud-method-name":"getConversationsMessagingIntegrationsWhatsapp"},"post":{"tags":["Conversations"],"summary":"Create a WhatsApp Integration","description":"You must be approved by WhatsApp to use this feature. Your approved e164-formatted phone number and valid WhatsApp certificate for your number are required. Your WhatsApp certificate must have valid base64 encoding. Please paste carefully and do not add any leading or trailing spaces. Do not alter any characters. An integration must be activated within 7 days of certificate generation. If you cannot complete the addition and activation of the number within 7 days, please obtain a new certificate before creating the integration. Integrations created with an invalid number or certificate may immediately incur additional integration fees. Please carefully enter your number and certificate as described.","operationId":"postConversationsMessagingIntegrationsWhatsapp","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"WhatsAppIntegrationRequest","required":true,"schema":{"$ref":"#/definitions/WhatsAppIntegrationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WhatsAppIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.integration":"The integration request was invalid for this operation. One or more errors may be reported.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:whatsappIntegration:add"]},"x-purecloud-method-name":"postConversationsMessagingIntegrationsWhatsapp"}},"/api/v2/outbound/wrapupcodemappings":{"get":{"tags":["Outbound"],"summary":"Get the Dialer wrap up code mapping.","description":"","operationId":"getOutboundWrapupcodemappings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapUpCodeMapping"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:wrapUpCodeMapping:view"]},"x-purecloud-method-name":"getOutboundWrapupcodemappings"},"put":{"tags":["Outbound"],"summary":"Update the Dialer wrap up code mapping.","description":"","operationId":"putOutboundWrapupcodemappings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"wrapUpCodeMapping","required":true,"schema":{"$ref":"#/definitions/WrapUpCodeMapping"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapUpCodeMapping"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update":"An attempt was made to update a wrap up code mapping in an invalid way","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.wrong.version":"Wrap up code mapping version does not match expected"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:wrapUpCodeMapping:edit"]},"x-purecloud-method-name":"putOutboundWrapupcodemappings"}},"/api/v2/routing/utilization":{"get":{"tags":["Routing"],"summary":"Get the organization-wide max utilization settings.","description":"","operationId":"getRoutingUtilization","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Utilization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:utilization:manage","routing:utilization:view"]},"x-purecloud-method-name":"getRoutingUtilization"},"put":{"tags":["Routing"],"summary":"Update the organization-wide max utilization settings. Include only those media types requiring custom configuration.","description":"","operationId":"putRoutingUtilization","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"utilization","required":true,"schema":{"$ref":"#/definitions/Utilization"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Utilization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"An unsupported media type was specified.","interrupt.same.media.type":"A media type cannot be set up to interrupt itself.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.media.capacity":"Value too large or too small for media type.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:utilization:manage"]},"x-purecloud-method-name":"putRoutingUtilization"},"delete":{"tags":["Routing"],"summary":"Delete the organization-wide max utilization settings and revert to the system default.","description":"","operationId":"deleteRoutingUtilization","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:utilization:manage"]},"x-purecloud-method-name":"deleteRoutingUtilization"}},"/api/v2/externalcontacts/organizations/{externalOrganizationId}/contacts":{"get":{"tags":["External Contacts"],"summary":"Search for external contacts in an external organization","description":"","operationId":"getExternalcontactsOrganizationContacts","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":20,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":1,"format":"int32"},{"name":"q","in":"query","description":"User supplied search keywords (no special syntax is currently supported)","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["externalOrganization","externalDataSources"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"externalOrganization"},{"name":"externalDataSources"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:view"]},"x-purecloud-method-name":"getExternalcontactsOrganizationContacts"}},"/api/v2/telephony/providers/edges/physicalinterfaces":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get physical interfaces for edges.","description":"Retrieves a list of all configured physical interfaces for a list of edges. Only 100 edges can be requested at a time.","operationId":"getTelephonyProvidersEdgesPhysicalinterfaces","produces":["application/json"],"parameters":[{"name":"edgeIds","in":"query","description":"Comma separated list of Edge Id's","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhysicalInterfaceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesPhysicalinterfaces"}},"/api/v2/architect/dependencytracking":{"get":{"tags":["Architect"],"summary":"Get Dependency Tracking objects that have a given display name","description":"","operationId":"getArchitectDependencytracking","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"name","in":"query","description":"Object name to search for","required":true,"type":"string"},{"name":"objectType","in":"query","description":"Object type(s) to search for","required":false,"type":"array","items":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","BOTCONNECTORBOT","BOTCONNECTORBOTVERSION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GROUP","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","IVRCONFIGURATION","LANGUAGE","LEXBOT","LEXBOTALIAS","NLUDOMAIN","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","WIDGET","WORKFLOW"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"ACDLANGUAGE"},{"name":"ACDSKILL"},{"name":"ACDWRAPUPCODE"},{"name":"BOTCONNECTORBOT"},{"name":"BOTCONNECTORBOTVERSION"},{"name":"BOTFLOW"},{"name":"BRIDGEACTION"},{"name":"COMMONMODULEFLOW"},{"name":"COMPOSERSCRIPT"},{"name":"CONTACTLIST"},{"name":"DATAACTION"},{"name":"DATATABLE"},{"name":"DIALOGENGINEBOT"},{"name":"DIALOGENGINEBOTVERSION"},{"name":"DIALOGFLOWAGENT"},{"name":"EMAILROUTE"},{"name":"EMERGENCYGROUP"},{"name":"FLOWACTION"},{"name":"FLOWDATATYPE"},{"name":"FLOWMILESTONE"},{"name":"FLOWOUTCOME"},{"name":"GROUP"},{"name":"INBOUNDCALLFLOW"},{"name":"INBOUNDCHATFLOW"},{"name":"INBOUNDEMAILFLOW"},{"name":"INBOUNDSHORTMESSAGEFLOW"},{"name":"INQUEUECALLFLOW"},{"name":"IVRCONFIGURATION"},{"name":"LANGUAGE"},{"name":"LEXBOT"},{"name":"LEXBOTALIAS"},{"name":"NLUDOMAIN"},{"name":"OUTBOUNDCALLFLOW"},{"name":"QUEUE"},{"name":"RECORDINGPOLICY"},{"name":"RESPONSE"},{"name":"SCHEDULE"},{"name":"SCHEDULEGROUP"},{"name":"SECUREACTION"},{"name":"SECURECALLFLOW"},{"name":"SURVEYINVITEFLOW"},{"name":"SYSTEMPROMPT"},{"name":"TTSENGINE"},{"name":"TTSVOICE"},{"name":"USER"},{"name":"USERPROMPT"},{"name":"WIDGET"},{"name":"WORKFLOW"}]},{"name":"consumedResources","in":"query","description":"Include resources each result item consumes","required":false,"type":"boolean"},{"name":"consumingResources","in":"query","description":"Include resources that consume each result item","required":false,"type":"boolean"},{"name":"consumedResourceType","in":"query","description":"Types of consumed resources to return, if consumed resources are requested","required":false,"type":"array","items":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","BOTCONNECTORBOT","BOTCONNECTORBOTVERSION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GROUP","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","IVRCONFIGURATION","LANGUAGE","LEXBOT","LEXBOTALIAS","NLUDOMAIN","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","WIDGET","WORKFLOW"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"ACDLANGUAGE"},{"name":"ACDSKILL"},{"name":"ACDWRAPUPCODE"},{"name":"BOTCONNECTORBOT"},{"name":"BOTCONNECTORBOTVERSION"},{"name":"BOTFLOW"},{"name":"BRIDGEACTION"},{"name":"COMMONMODULEFLOW"},{"name":"COMPOSERSCRIPT"},{"name":"CONTACTLIST"},{"name":"DATAACTION"},{"name":"DATATABLE"},{"name":"DIALOGENGINEBOT"},{"name":"DIALOGENGINEBOTVERSION"},{"name":"DIALOGFLOWAGENT"},{"name":"EMAILROUTE"},{"name":"EMERGENCYGROUP"},{"name":"FLOWACTION"},{"name":"FLOWDATATYPE"},{"name":"FLOWMILESTONE"},{"name":"FLOWOUTCOME"},{"name":"GROUP"},{"name":"INBOUNDCALLFLOW"},{"name":"INBOUNDCHATFLOW"},{"name":"INBOUNDEMAILFLOW"},{"name":"INBOUNDSHORTMESSAGEFLOW"},{"name":"INQUEUECALLFLOW"},{"name":"IVRCONFIGURATION"},{"name":"LANGUAGE"},{"name":"LEXBOT"},{"name":"LEXBOTALIAS"},{"name":"NLUDOMAIN"},{"name":"OUTBOUNDCALLFLOW"},{"name":"QUEUE"},{"name":"RECORDINGPOLICY"},{"name":"RESPONSE"},{"name":"SCHEDULE"},{"name":"SCHEDULEGROUP"},{"name":"SECUREACTION"},{"name":"SECURECALLFLOW"},{"name":"SURVEYINVITEFLOW"},{"name":"SYSTEMPROMPT"},{"name":"TTSENGINE"},{"name":"TTSVOICE"},{"name":"USER"},{"name":"USERPROMPT"},{"name":"WIDGET"},{"name":"WORKFLOW"}]},{"name":"consumingResourceType","in":"query","description":"Types of consuming resources to return, if consuming resources are requested","required":false,"type":"array","items":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","BOTCONNECTORBOT","BOTCONNECTORBOTVERSION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GROUP","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","IVRCONFIGURATION","LANGUAGE","LEXBOT","LEXBOTALIAS","NLUDOMAIN","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","WIDGET","WORKFLOW"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"ACDLANGUAGE"},{"name":"ACDSKILL"},{"name":"ACDWRAPUPCODE"},{"name":"BOTCONNECTORBOT"},{"name":"BOTCONNECTORBOTVERSION"},{"name":"BOTFLOW"},{"name":"BRIDGEACTION"},{"name":"COMMONMODULEFLOW"},{"name":"COMPOSERSCRIPT"},{"name":"CONTACTLIST"},{"name":"DATAACTION"},{"name":"DATATABLE"},{"name":"DIALOGENGINEBOT"},{"name":"DIALOGENGINEBOTVERSION"},{"name":"DIALOGFLOWAGENT"},{"name":"EMAILROUTE"},{"name":"EMERGENCYGROUP"},{"name":"FLOWACTION"},{"name":"FLOWDATATYPE"},{"name":"FLOWMILESTONE"},{"name":"FLOWOUTCOME"},{"name":"GROUP"},{"name":"INBOUNDCALLFLOW"},{"name":"INBOUNDCHATFLOW"},{"name":"INBOUNDEMAILFLOW"},{"name":"INBOUNDSHORTMESSAGEFLOW"},{"name":"INQUEUECALLFLOW"},{"name":"IVRCONFIGURATION"},{"name":"LANGUAGE"},{"name":"LEXBOT"},{"name":"LEXBOTALIAS"},{"name":"NLUDOMAIN"},{"name":"OUTBOUNDCALLFLOW"},{"name":"QUEUE"},{"name":"RECORDINGPOLICY"},{"name":"RESPONSE"},{"name":"SCHEDULE"},{"name":"SCHEDULEGROUP"},{"name":"SECUREACTION"},{"name":"SECURECALLFLOW"},{"name":"SURVEYINVITEFLOW"},{"name":"SYSTEMPROMPT"},{"name":"TTSENGINE"},{"name":"TTSVOICE"},{"name":"USER"},{"name":"USERPROMPT"},{"name":"WIDGET"},{"name":"WORKFLOW"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DependencyObjectEntityListing"}},"206":{"description":"Partial Content - the organization's data is being rebuilt or needs to be rebuilt."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","architect.dependency.object.name.not.specified":"A name was not specified for the dependency object search.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","architect.query.parameter.missing":"A required query parameter is missing or empty.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","architect.dependency.object.invalid.type":"An invalid dependency object type was specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","architect.database.throughput.exceeded":"Database too busy. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:dependencyTracking:view"]},"x-purecloud-method-name":"getArchitectDependencytracking"}},"/api/v2/conversations/messaging/facebook/app":{"get":{"tags":["Conversations"],"summary":"Get Genesys Facebook App Id","description":"","operationId":"getConversationsMessagingFacebookApp","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FacebookAppCredentials"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:add"]},"x-purecloud-method-name":"getConversationsMessagingFacebookApp"}},"/api/v2/quality/surveys/scoring":{"post":{"tags":["Quality"],"summary":"Score survey","description":"","operationId":"postQualitySurveysScoring","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"surveyAndScoringSet","required":true,"schema":{"$ref":"#/definitions/SurveyFormAndScoringSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyScoringSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-purecloud-method-name":"postQualitySurveysScoring"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories":{"get":{"tags":["Knowledge"],"summary":"Get categories","description":"","operationId":"getKnowledgeKnowledgebaseLanguageCategories","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","de-DE"],"x-genesys-enum-members":[{"name":"en-US"},{"name":"de-DE"}]},{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"limit","in":"query","description":"Number of entities to return. Maximum of 200. Deprecated in favour of pageSize.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"name":"name","in":"query","description":"Filter to return the categories that starts with the given category name.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CategoryListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","input.validations":"Input parameters do not match the required criteria","kb.not.found":"Knowledge Base does not exist","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:category:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseLanguageCategories"},"post":{"tags":["Knowledge"],"summary":"Create new category","description":"","operationId":"postKnowledgeKnowledgebaseLanguageCategories","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","de-DE"],"x-genesys-enum-members":[{"name":"en-US"},{"name":"de-DE"}]},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeCategoryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeExtendedCategory"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","parent.category.not.found":"Parent category does not exist","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","input.validations":"Input parameters do not match the required criteria","kb.not.found":"Knowledge Base does not exist","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:category:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseLanguageCategories"}},"/api/v2/speechandtextanalytics/programs/general/jobs/{jobId}":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get a Speech & Text Analytics general program job by id","description":"","operationId":"getSpeechandtextanalyticsProgramsGeneralJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"The id of the publish programs job","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GeneralProgramJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"job.not.found":"The requested job could not be found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:add","speechAndTextAnalytics:program:edit","speechAndTextAnalytics:topic:add","speechAndTextAnalytics:topic:edit"]},"x-purecloud-method-name":"getSpeechandtextanalyticsProgramsGeneralJob"}},"/api/v2/voicemail/me/mailbox":{"get":{"tags":["Voicemail"],"summary":"Get the current user's mailbox information","description":"","operationId":"getVoicemailMeMailbox","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMailboxInfo"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-purecloud-method-name":"getVoicemailMeMailbox"}},"/api/v2/voicemail/mailbox":{"get":{"tags":["Voicemail"],"summary":"Get the current user's mailbox information","description":"","operationId":"getVoicemailMailbox","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMailboxInfo"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-purecloud-method-name":"getVoicemailMailbox"}},"/api/v2/voicemail/groups/{groupId}/mailbox":{"get":{"tags":["Voicemail"],"summary":"Get the group's mailbox information","description":"","operationId":"getVoicemailGroupMailbox","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"groupId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMailboxInfo"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-purecloud-method-name":"getVoicemailGroupMailbox"}},"/api/v2/languageunderstanding/domains/{domainId}/feedback":{"get":{"tags":["Language Understanding"],"summary":"Get all feedback in the given NLU Domain Version.","description":"","operationId":"getLanguageunderstandingDomainFeedback","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"intentName","in":"query","description":"The top intent name to retrieve feedback for.","required":false,"type":"string"},{"name":"assessment","in":"query","description":"The top assessment to retrieve feedback for.","required":false,"type":"string","enum":["Incorrect","Correct","Unknown","Disabled"],"x-genesys-enum-members":[{"name":"Incorrect"},{"name":"Correct"},{"name":"Unknown"},{"name":"Disabled"}]},{"name":"dateStart","in":"query","description":"Begin of time window as ISO-8601 date.","required":false,"type":"string","format":"date"},{"name":"dateEnd","in":"query","description":"End of time window as ISO-8601 date.","required":false,"type":"string","format":"date"},{"name":"includeDeleted","in":"query","description":"Whether to include soft-deleted items in the result.","required":false,"type":"boolean"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"enableCursorPagination","in":"query","description":"Enable Cursor Pagination","required":false,"type":"boolean","default":false},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned. This is considered only when enableCursorPagination=true","required":false,"type":"string"},{"name":"fields","in":"query","description":"Fields and properties to get, comma-separated","required":false,"type":"array","items":{"type":"string","enum":["version","dateCreated","text","intents"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"version"},{"name":"dateCreated"},{"name":"text"},{"name":"intents"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluFeedbackListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","dialog:readonly","language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:feedback:view","dialog:bot:view"]},"x-purecloud-method-name":"getLanguageunderstandingDomainFeedback"},"post":{"tags":["Language Understanding"],"summary":"Create feedback for the NLU Domain Version.","description":"","operationId":"postLanguageunderstandingDomainFeedback","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"in":"body","name":"body","description":"The Feedback to create.","required":true,"schema":{"$ref":"#/definitions/NluFeedbackRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluFeedbackResponse"}},"201":{"description":"Feedback created successfully","schema":{"$ref":"#/definitions/NluFeedbackResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","language-understanding"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:feedback:add","dialog:bot:add"]},"x-purecloud-method-name":"postLanguageunderstandingDomainFeedback"}},"/api/v2/telephony/providers/edges/certificateauthorities/{certificateId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a certificate authority.","description":"","operationId":"getTelephonyProvidersEdgesCertificateauthority","produces":["application/json"],"parameters":[{"name":"certificateId","in":"path","description":"Certificate ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainCertificateAuthority"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Certificate authority resource not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesCertificateauthority"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a certificate authority.","description":"","operationId":"putTelephonyProvidersEdgesCertificateauthority","produces":["application/json"],"parameters":[{"name":"certificateId","in":"path","description":"Certificate ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Certificate authority","required":true,"schema":{"$ref":"#/definitions/DomainCertificateAuthority"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainCertificateAuthority"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesCertificateauthority"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a certificate authority.","description":"","operationId":"deleteTelephonyProvidersEdgesCertificateauthority","produces":["application/json"],"parameters":[{"name":"certificateId","in":"path","description":"Certificate ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Certificate authority resource not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdgesCertificateauthority"}},"/api/v2/authorization/divisionspermitted/paged/{subjectId}":{"get":{"tags":["Authorization","Users"],"summary":"Returns which divisions the specified user has the given permission in.","description":"This route is deprecated, use authorization/divisionspermitted/paged/me instead.","operationId":"getAuthorizationDivisionspermittedPagedSubjectId","produces":["application/json"],"parameters":[{"name":"subjectId","in":"path","description":"Subject ID (user or group)","required":true,"type":"string"},{"name":"permission","in":"query","description":"The permission string, including the object to access, e.g. routing:queue:view","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DivsPermittedEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","missing.permission.param":"Missing required permission parameter","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getAuthorizationDivisionspermittedPagedSubjectId"}},"/api/v2/contentmanagement/securityprofiles":{"get":{"tags":["Content Management"],"summary":"Get a List of Security Profiles","description":"","operationId":"getContentmanagementSecurityprofiles","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SecurityProfileEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementSecurityprofiles"}},"/api/v2/routing/queues/{queueId}/estimatedwaittime":{"get":{"tags":["Routing"],"summary":"Get Estimated Wait Time","description":"","operationId":"getRoutingQueueEstimatedwaittime","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"queueId","required":true,"type":"string"},{"name":"conversationId","in":"query","description":"conversationId","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EstimatedWaitTimePredictions"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","missing.division.permissions":"At least one of the required division permissions is missing","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:queue:view"]},"x-purecloud-method-name":"getRoutingQueueEstimatedwaittime"}},"/api/v2/routing/wrapupcodes/{codeId}":{"get":{"tags":["Routing"],"summary":"Get details about this wrap-up code.","description":"","operationId":"getRoutingWrapupcode","produces":["application/json"],"parameters":[{"name":"codeId","in":"path","description":"Wrapup Code ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:wrapupCode:view"]},"x-purecloud-method-name":"getRoutingWrapupcode"},"put":{"tags":["Routing"],"summary":"Update wrap-up code","description":"","operationId":"putRoutingWrapupcode","produces":["application/json"],"parameters":[{"name":"codeId","in":"path","description":"Wrapup Code ID","required":true,"type":"string"},{"in":"body","name":"body","description":"WrapupCode","required":true,"schema":{"$ref":"#/definitions/WrapupCode"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.name":"Invalid wrapup code name specified.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","duplicate.name":"A wrapup code with this name already exists.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:wrapupCode:edit"]},"x-purecloud-method-name":"putRoutingWrapupcode"},"delete":{"tags":["Routing"],"summary":"Delete wrap-up code","description":"","operationId":"deleteRoutingWrapupcode","produces":["application/json"],"parameters":[{"name":"codeId","in":"path","description":"Wrapup Code ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:wrapupCode:delete"]},"x-purecloud-method-name":"deleteRoutingWrapupcode"}},"/api/v2/quality/publishedforms/evaluations":{"get":{"tags":["Quality"],"summary":"Get the published evaluation forms.","description":"","operationId":"getQualityPublishedformsEvaluations","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"onlyLatestPerContext","in":"query","description":"onlyLatestPerContext","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:view"]},"x-purecloud-method-name":"getQualityPublishedformsEvaluations"},"post":{"tags":["Quality"],"summary":"Publish an evaluation form.","description":"","operationId":"postQualityPublishedformsEvaluations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Publish request containing id of form to publish","required":true,"schema":{"$ref":"#/definitions/PublishForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:add"]},"x-purecloud-method-name":"postQualityPublishedformsEvaluations"}},"/api/v2/quality/conversations/{conversationId}/evaluations":{"post":{"tags":["Quality"],"summary":"Create an evaluation","description":"","operationId":"postQualityConversationEvaluations","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"evaluation","required":true,"schema":{"$ref":"#/definitions/Evaluation"}},{"name":"expand","in":"query","description":"evaluatorId","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Evaluation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.evaluation.evaluator.doesnt.exist":"Evaluator doesn't exist","quality.evaluation.already.exists":"An evaluation for this conversation already exists","quality.scoring.unanswered.required.questions":"Submitted answers did not contain a response to a required question","bad.request":"The request could not be understood by the server due to malformed syntax.","quality.scoring.question.not.in.evaluation.form":"Submitted answers contained reference to a question which is not in the evaluation form","quality.evaluation.agent.doesnt.have.participate.permission":"Agent doesn't have required permission to participate","quality.evaluation.for.pending.state":"Answers required for pending state","quality.scoring.unanswered.required.comments":"Submitted answers did not contain a comment where it was required","qm.evaluation.create.error.no.agent":"Need an agent user on the conversation to create an evaluation","quality.evaluation.no.answers.for.finished.state":"No answers for finished state","quality.evaluation.form.doesnt.exist":"Evaluation form doesn't exist","qm.evaluation.create.error.no.evaluator":"Submitted evaluation missing evaluator","quality.evaluation.agent.doesnt.exist":"Agent user does not exist","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","quality.scoring.answer.not.in.evaluation.form":"Submitted answers contained reference to an answer which is not in the evaluation form","quality.evaluation.evaluator.not.quality.evaluator":"evaluator does not have edit score permission","quality.scoring.question.group.not.in.evaluation.form":"Submitted answers contained reference to a question group which is not in the evaluation form","quality.evaluation.form.not.published":"Evaluation form is not published","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","quality.evaluation.create.permission.check.failed":"Failed evaluation creation permission check"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluation:add"]},"x-purecloud-method-name":"postQualityConversationEvaluations"}},"/api/v2/telephony/providers/edges/didpools/dids":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a listing of unassigned and/or assigned numbers in a set of DID Pools.","description":"","operationId":"getTelephonyProvidersEdgesDidpoolsDids","produces":["application/json"],"parameters":[{"name":"type","in":"query","description":"The type of numbers to return.","required":true,"type":"string","enum":["ASSIGNED_AND_UNASSIGNED","UNASSIGNED"],"x-genesys-enum-members":[{"name":"ASSIGNED_AND_UNASSIGNED"},{"name":"UNASSIGNED"}]},{"name":"id","in":"query","description":"Filter by a specific list of DID Pools. If this is not provided, numbers from all DID Pools will be returned.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"numberMatch","in":"query","description":"A number to filter the results by.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ascending"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DIDNumberEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesDidpoolsDids"}},"/api/v2/architect/schedulegroups/{scheduleGroupId}":{"get":{"tags":["Architect"],"summary":"Gets a schedule group by ID","description":"","operationId":"getArchitectSchedulegroup","produces":["application/json"],"parameters":[{"name":"scheduleGroupId","in":"path","description":"Schedule group ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScheduleGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The specified scheduleGroupId was not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:scheduleGroup:view"]},"x-purecloud-method-name":"getArchitectSchedulegroup"},"put":{"tags":["Architect"],"summary":"Updates a schedule group by ID","description":"","operationId":"putArchitectSchedulegroup","produces":["application/json"],"parameters":[{"name":"scheduleGroupId","in":"path","description":"Schedule group ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/ScheduleGroup"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScheduleGroup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:scheduleGroup:edit"]},"x-purecloud-method-name":"putArchitectSchedulegroup"},"delete":{"tags":["Architect"],"summary":"Deletes a schedule group by ID","description":"","operationId":"deleteArchitectSchedulegroup","produces":["application/json"],"parameters":[{"name":"scheduleGroupId","in":"path","description":"Schedule group ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The specified scheduleGroupId was not found.","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The schedule group could not be completed because it is assigned to one or more IVRs or Sites."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:scheduleGroup:delete"]},"x-purecloud-method-name":"deleteArchitectSchedulegroup"}},"/api/v2/analytics/users/details/query":{"post":{"tags":["Users","Analytics"],"summary":"Query for user details","description":"","operationId":"postAnalyticsUsersDetailsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/UserDetailsQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AnalyticsUserDetailsQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:userObservation:view"]},"x-purecloud-method-name":"postAnalyticsUsersDetailsQuery"}},"/api/v2/analytics/users/aggregates/query":{"post":{"tags":["Users","Analytics"],"summary":"Query for user aggregates","description":"","operationId":"postAnalyticsUsersAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/UserAggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:userAggregate:view"]},"x-purecloud-method-name":"postAnalyticsUsersAggregatesQuery"}},"/api/v2/analytics/users/observations/query":{"post":{"tags":["Users","Analytics"],"summary":"Query for user observations","description":"","operationId":"postAnalyticsUsersObservationsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/UserObservationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserObservationQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:userObservation:view"]},"x-purecloud-method-name":"postAnalyticsUsersObservationsQuery"}},"/api/v2/analytics/users/details/jobs":{"post":{"tags":["Users","Analytics"],"summary":"Query for user details asynchronously","description":"","operationId":"postAnalyticsUsersDetailsJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/AsyncUserDetailsQuery"}}],"responses":{"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:userDetail:view"]},"x-purecloud-method-name":"postAnalyticsUsersDetailsJobs"}},"/api/v2/analytics/users/details/jobs/{jobId}":{"get":{"tags":["Users","Analytics"],"summary":"Get status for async query for user details","description":"","operationId":"getAnalyticsUsersDetailsJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:userDetail:view"]},"x-purecloud-method-name":"getAnalyticsUsersDetailsJob"},"delete":{"tags":["Users","Analytics"],"summary":"Delete/cancel an async request","description":"","operationId":"deleteAnalyticsUsersDetailsJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"204":{"description":"Deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:userDetail:view"]},"x-purecloud-method-name":"deleteAnalyticsUsersDetailsJob"}},"/api/v2/analytics/users/details/jobs/{jobId}/results":{"get":{"tags":["Users","Analytics"],"summary":"Fetch a page of results for an async query","description":"","operationId":"getAnalyticsUsersDetailsJobResults","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"},{"name":"cursor","in":"query","description":"Indicates where to resume query results (not required for first page)","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"The desired maximum number of results","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AnalyticsUserDetailsAsyncQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:userDetail:view"]},"x-purecloud-method-name":"getAnalyticsUsersDetailsJobResults"}},"/api/v2/analytics/users/details/jobs/availability":{"get":{"tags":["Users","Analytics"],"summary":"Lookup the datalake availability date and time","description":"","operationId":"getAnalyticsUsersDetailsJobsAvailability","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataAvailabilityResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:userDetail:view"]},"x-purecloud-method-name":"getAnalyticsUsersDetailsJobsAvailability"}},"/api/v2/orgauthorization/pairings":{"post":{"tags":["Organization Authorization"],"summary":"A pairing id is created by the trustee and given to the trustor to create a trust.","description":"","operationId":"postOrgauthorizationPairings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Pairing Info","required":true,"schema":{"$ref":"#/definitions/TrustRequestCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustRequest"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrustee:add"]},"x-purecloud-method-name":"postOrgauthorizationPairings"}},"/api/v2/scripts/published/{scriptId}/variables":{"get":{"tags":["Scripts"],"summary":"Get the published variables","description":"","operationId":"getScriptsPublishedScriptIdVariables","produces":["application/json"],"parameters":[{"name":"scriptId","in":"path","description":"Script ID","required":true,"type":"string"},{"name":"input","in":"query","description":"input","required":false,"type":"string"},{"name":"output","in":"query","description":"output","required":false,"type":"string"},{"name":"type","in":"query","description":"type","required":false,"type":"string"},{"name":"scriptDataVersion","in":"query","description":"Advanced usage - controls the data version of the script","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"object"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:publishedScript:view"]},"x-purecloud-method-name":"getScriptsPublishedScriptIdVariables"}},"/api/v2/telephony/providers/edges/sites/{siteId}/numberplans":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of Number Plans for this Site. Only fetches the first 200 records.","description":"","operationId":"getTelephonyProvidersEdgesSiteNumberplans","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/NumberPlan"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesSiteNumberplans"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update the list of Number Plans. A user can update maximum 200 number plans at a time.","description":"","operationId":"putTelephonyProvidersEdgesSiteNumberplans","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"in":"body","name":"body","description":"List of number plans","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/NumberPlan"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/NumberPlan"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"number.plan.in.use":"The number plan is in use by one or more outbound route.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","error.updating.number.plans":"There was a problem updating number plans.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.number.plan.name":"Number Plan names must be unique.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Unable to find a number plan with that id","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesSiteNumberplans"}},"/api/v2/billing/trusteebillingoverview/{trustorOrgId}":{"get":{"tags":["Billing"],"summary":"Get the billing overview for an organization that is managed by a partner.","description":"Tax Disclaimer: Prices returned by this API do not include applicable taxes. It is the responsibility of the customer to pay all taxes that are appropriate in their jurisdiction. See the PureCloud API Documentation in the Developer Center for more information about this API: https://developer.mypurecloud.com/api/rest/v2/","operationId":"getBillingTrusteebillingoverviewTrustorOrgId","produces":["application/json"],"parameters":[{"name":"billingPeriodIndex","in":"query","description":"0 for active period (overview data may change until period closes). 1 for prior completed billing period. 2 for two billing cycles prior, and so on.","required":false,"type":"integer","default":0,"format":"int32"},{"name":"trustorOrgId","in":"path","description":"The organization ID of the trustor (customer) organization.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrusteeBillingOverview"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["billing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["affiliateOrganization:clientBilling:view"]},"x-purecloud-method-name":"getBillingTrusteebillingoverviewTrustorOrgId"}},"/api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Trunk Base Settings object by ID","description":"Managed properties will not be returned unless the user is assigned the internal:trunk:edit permission.","operationId":"getTelephonyProvidersEdgesTrunkbasesetting","produces":["application/json"],"parameters":[{"name":"trunkBaseSettingsId","in":"path","description":"Trunk Base ID","required":true,"type":"string"},{"name":"ignoreHidden","in":"query","description":"Set this to true to not receive trunk properties that are meant to be hidden or for internal system usage only.","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"The requested entity was not found.","general.resource.not.found":"Unable to find the trunk base settings with that id.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesTrunkbasesetting"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a Trunk Base Settings object by ID","description":"","operationId":"putTelephonyProvidersEdgesTrunkbasesetting","produces":["application/json"],"parameters":[{"name":"trunkBaseSettingsId","in":"path","description":"Trunk Base ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Trunk base settings","required":true,"schema":{"$ref":"#/definitions/TrunkBase"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"required.field.missing":"A required field is missing a value.","validation.error":"Error validating the data.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.value":"A trunk with that name already exists.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","general.access.denied":"The requested action is forbidden.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"The requested entity was not found.","general.resource.not.found":"The requested resource was not found.","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be made due to conflict with the server resources"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesTrunkbasesetting"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a Trunk Base Settings object by ID","description":"","operationId":"deleteTelephonyProvidersEdgesTrunkbasesetting","produces":["application/json"],"parameters":[{"name":"trunkBaseSettingsId","in":"path","description":"Trunk Base ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"delete.referenced.entity":"The trunk is being referenced.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","general.bad.request":"The request could not be understood by the server due to malformed syntax."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"The requested entity was not found.","general.resource.not.found":"Unable to delete trunk base settings with that id.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdgesTrunkbasesetting"}},"/api/v2/journey/actiontargets/{actionTargetId}":{"get":{"tags":["Journey"],"summary":"Retrieve a single action target.","description":"","operationId":"getJourneyActiontarget","produces":["application/json"],"parameters":[{"name":"actionTargetId","in":"path","description":"ID of the action target.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionTarget"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actiontarget:view"]},"x-purecloud-method-name":"getJourneyActiontarget"},"patch":{"tags":["Journey"],"summary":"Update a single action target.","description":"","operationId":"patchJourneyActiontarget","produces":["application/json"],"parameters":[{"name":"actionTargetId","in":"path","description":"ID of the action target.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/PatchActionTarget"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionTarget"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:actiontarget:edit"]},"x-purecloud-method-name":"patchJourneyActiontarget"}},"/api/v2/uploads/recordings":{"post":{"tags":["Uploads"],"summary":"Creates presigned url for uploading a recording file","description":"","operationId":"postUploadsRecordings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/UploadUrlRequest"}}],"responses":{"200":{"description":"Presigned url successfully created.","schema":{"$ref":"#/definitions/UploadUrlResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["upload"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["recording:recording:upload"]},"x-purecloud-method-name":"postUploadsRecordings"}},"/api/v2/configuration/schemas/edges/vnext/{schemaCategory}/{schemaType}":{"get":{"tags":["Telephony Providers Edge"],"summary":"List schemas of a specific category (Deprecated)","description":"","operationId":"getConfigurationSchemasEdgesVnextSchemaCategorySchemaType","produces":["application/json"],"parameters":[{"name":"schemaCategory","in":"path","description":"Schema category","required":true,"type":"string"},{"name":"schemaType","in":"path","description":"Schema type","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SchemaReferenceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getConfigurationSchemasEdgesVnextSchemaCategorySchemaType"}},"/api/v2/configuration/schemas/edges/vnext/{schemaCategory}":{"get":{"tags":["Telephony Providers Edge"],"summary":"List schemas of a specific category (Deprecated)","description":"","operationId":"getConfigurationSchemasEdgesVnextSchemaCategory","produces":["application/json"],"parameters":[{"name":"schemaCategory","in":"path","description":"Schema category","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SchemaReferenceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getConfigurationSchemasEdgesVnextSchemaCategory"}},"/api/v2/analytics/reporting/schedules/{scheduleId}/runreport":{"post":{"tags":["Analytics"],"summary":"Place a scheduled report immediately into the reporting queue","description":"","operationId":"postAnalyticsReportingScheduleRunreport","produces":["application/json"],"parameters":[{"name":"scheduleId","in":"path","description":"Schedule ID","required":true,"type":"string"}],"responses":{"202":{"description":"Accepted - Processing Report","schema":{"$ref":"#/definitions/RunNowResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics"]}],"x-purecloud-method-name":"postAnalyticsReportingScheduleRunreport"}},"/api/v2/telephony/providers/edges/metrics":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the metrics for a list of edges.","description":"","operationId":"getTelephonyProvidersEdgesMetrics","produces":["application/json"],"parameters":[{"name":"edgeIds","in":"query","description":"Comma separated list of Edge Id's","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/EdgeMetrics"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be processed due to invalid request data.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesMetrics"}},"/api/v2/telephony/providers/edges/sites/{siteId}/numberplans/classifications":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of Classifications for this Site","description":"","operationId":"getTelephonyProvidersEdgesSiteNumberplansClassifications","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"name":"classification","in":"query","description":"Classification","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","uniqueItems":true,"items":{"type":"string"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesSiteNumberplansClassifications"}},"/api/v2/quality/publishedforms/surveys":{"get":{"tags":["Quality"],"summary":"Get the published survey forms.","description":"","operationId":"getQualityPublishedformsSurveys","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"onlyLatestEnabledPerContext","in":"query","description":"onlyLatestEnabledPerContext","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyFormEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:view"]},"x-purecloud-method-name":"getQualityPublishedformsSurveys"},"post":{"tags":["Quality"],"summary":"Publish a survey form.","description":"","operationId":"postQualityPublishedformsSurveys","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Survey form","required":true,"schema":{"$ref":"#/definitions/PublishForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:add"]},"x-purecloud-method-name":"postQualityPublishedformsSurveys"}},"/api/v2/languages/translations":{"get":{"tags":["Languages"],"summary":"Get all available languages for translation","description":"","operationId":"getLanguagesTranslations","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AvailableTranslations"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getLanguagesTranslations"}},"/api/v2/languages/translations/builtin":{"get":{"tags":["Languages"],"summary":"Get the builtin translation for a language","description":"","operationId":"getLanguagesTranslationsBuiltin","produces":["application/json"],"parameters":[{"name":"language","in":"query","description":"The language of the builtin translation to retrieve","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getLanguagesTranslationsBuiltin"}},"/api/v2/languages/translations/organization":{"get":{"tags":["Languages"],"summary":"Get effective translation for an organization by language","description":"","operationId":"getLanguagesTranslationsOrganization","produces":["application/json"],"parameters":[{"name":"language","in":"query","description":"The language of the translation to retrieve for the organization","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getLanguagesTranslationsOrganization"}},"/api/v2/languages/translations/users/{userId}":{"get":{"tags":["Languages"],"summary":"Get effective language translation for a user","description":"","operationId":"getLanguagesTranslationsUser","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"The user id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getLanguagesTranslationsUser"}},"/api/v2/authorization/roles/{leftRoleId}/comparedefault/{rightRoleId}":{"get":{"tags":["Authorization"],"summary":"Get an org role to default role comparison","description":"Compares any organization role to a default role id and show differences","operationId":"getAuthorizationRoleComparedefaultRightRoleId","produces":["application/json"],"parameters":[{"name":"leftRoleId","in":"path","description":"Left Role ID","required":true,"type":"string"},{"name":"rightRoleId","in":"path","description":"Right Role id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainOrgRoleDifference"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:view"]},"x-purecloud-method-name":"getAuthorizationRoleComparedefaultRightRoleId"},"post":{"tags":["Authorization"],"summary":"Get an unsaved org role to default role comparison","description":"Allows users to compare their existing roles in an unsaved state to its default role","operationId":"postAuthorizationRoleComparedefaultRightRoleId","produces":["application/json"],"parameters":[{"name":"leftRoleId","in":"path","description":"Left Role ID","required":true,"type":"string"},{"name":"rightRoleId","in":"path","description":"Right Role id","required":true,"type":"string"},{"in":"body","name":"body","description":"Organization role","required":true,"schema":{"$ref":"#/definitions/DomainOrganizationRole"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainOrgRoleDifference"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:view"]},"x-purecloud-method-name":"postAuthorizationRoleComparedefaultRightRoleId"}},"/api/v2/users/development/activities/{activityId}":{"get":{"tags":["Users"],"summary":"Get a Development Activity","description":"Permission not required if you are the attendee, creator or facilitator of the coaching appointment or you are the assigned user of the learning assignment.","operationId":"getUsersDevelopmentActivity","produces":["application/json"],"parameters":[{"name":"activityId","in":"path","description":"Specifies the activity ID, maps to either assignment or appointment ID","required":true,"type":"string"},{"name":"type","in":"query","description":"Specifies the activity type.","required":true,"type":"string","enum":["Informational","Coaching"],"x-genesys-enum-members":[{"name":"Informational"},{"name":"Coaching"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DevelopmentActivity"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","wem.learning.forbidden":"The operation failed as the action is forbidden"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","coaching:readonly","learning","learning:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:assignment:view","coaching:appointment:view"]},"x-purecloud-method-name":"getUsersDevelopmentActivity"}},"/api/v2/users/development/activities":{"get":{"tags":["Users"],"summary":"Get list of Development Activities","description":"Either moduleId or userId is required. Results are filtered based on the applicable permissions.","operationId":"getUsersDevelopmentActivities","produces":["application/json"],"parameters":[{"name":"userId","in":"query","description":"Specifies the list of user IDs to be queried, up to 100 user IDs. It searches for any relationship for the userId.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"moduleId","in":"query","description":"Specifies the ID of the learning module.","required":false,"type":"string"},{"name":"interval","in":"query","description":"Specifies the dateDue range to be queried. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. 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","required":false,"type":"string","format":"interval"},{"name":"completionInterval","in":"query","description":"Specifies the range of completion dates to be used for filtering. A maximum of 1 year can be specified in the range. 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","required":false,"type":"string","format":"interval"},{"name":"overdue","in":"query","description":"Specifies if non-overdue, overdue, or all activities are returned. If not specified, all activities are returned","required":false,"type":"string","default":"Any","enum":["True","False","Any"],"x-genesys-enum-members":[{"name":"True","description":"Return only activities which are overdue"},{"name":"False","description":"Return only activities which are non-overdue"},{"name":"Any","description":"Return all activities"}]},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Specifies result set sort order sorted by the date due; if not specified, default sort order is descending (Desc)","required":false,"type":"string","default":"Desc","enum":["Asc","Desc"],"x-genesys-enum-members":[{"name":"Asc"},{"name":"Desc"}]},{"name":"types","in":"query","description":"Specifies the activity types.","required":false,"type":"array","items":{"type":"string","enum":["Informational","Coaching"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"Informational"},{"name":"Coaching"}]},{"name":"statuses","in":"query","description":"Specifies the activity statuses to filter by","required":false,"type":"array","items":{"type":"string","enum":["Planned","InProgress","Completed","InvalidSchedule"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"Planned"},{"name":"InProgress"},{"name":"Completed"},{"name":"InvalidSchedule"}]},{"name":"relationship","in":"query","description":"Specifies how the current user relation should be interpreted, and filters the activities returned to only the activities that have the specified relationship. If a value besides Attendee is specified, it will only return Coaching Appointments. If not specified, no filtering is applied.","required":false,"type":"array","items":{"type":"string","enum":["Creator","Facilitator","Attendee"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"Creator"},{"name":"Facilitator"},{"name":"Attendee"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DevelopmentActivityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","wem.learning.forbidden":"The operation failed as the action is forbidden"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","coaching:readonly","learning","learning:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["learning:assignment:view","coaching:appointment:view"]},"x-purecloud-method-name":"getUsersDevelopmentActivities"}},"/api/v2/users/development/activities/me":{"get":{"tags":["Users"],"summary":"Get list of Development Activities for current user","description":"Results are filtered based on the applicable permissions.","operationId":"getUsersDevelopmentActivitiesMe","produces":["application/json"],"parameters":[{"name":"moduleId","in":"query","description":"Specifies the ID of the learning module.","required":false,"type":"string"},{"name":"interval","in":"query","description":"Specifies the dateDue range to be queried. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. 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","required":false,"type":"string","format":"interval"},{"name":"completionInterval","in":"query","description":"Specifies the range of completion dates to be used for filtering. A maximum of 1 year can be specified in the range. 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","required":false,"type":"string","format":"interval"},{"name":"overdue","in":"query","description":"Specifies if non-overdue, overdue, or all activities are returned. If not specified, all activities are returned","required":false,"type":"string","default":"Any","enum":["True","False","Any"],"x-genesys-enum-members":[{"name":"True","description":"Return only activities which are overdue"},{"name":"False","description":"Return only activities which are non-overdue"},{"name":"Any","description":"Return all activities"}]},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Specifies result set sort order sorted by the date due; if not specified, default sort order is descending (Desc)","required":false,"type":"string","default":"Desc","enum":["Asc","Desc"],"x-genesys-enum-members":[{"name":"Asc"},{"name":"Desc"}]},{"name":"types","in":"query","description":"Specifies the activity types.","required":false,"type":"array","items":{"type":"string","enum":["Informational","Coaching"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"Informational"},{"name":"Coaching"}]},{"name":"statuses","in":"query","description":"Specifies the activity statuses to filter by","required":false,"type":"array","items":{"type":"string","enum":["Planned","InProgress","Completed","InvalidSchedule"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"Planned"},{"name":"InProgress"},{"name":"Completed"},{"name":"InvalidSchedule"}]},{"name":"relationship","in":"query","description":"Specifies how the current user relation should be interpreted, and filters the activities returned to only the activities that have the specified relationship. If a value besides Attendee is specified, it will only return Coaching Appointments. If not specified, no filtering is applied.","required":false,"type":"array","items":{"type":"string","enum":["Creator","Facilitator","Attendee"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"Creator"},{"name":"Facilitator"},{"name":"Attendee"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DevelopmentActivityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.input.validation.error":"There was an error parsing argument","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","wem.learning.forbidden":"The operation failed as the action is forbidden"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.internal.server.error":"The operation failed in an unexpected way","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wem.learning.server.too.busy":"The operation failed because the service is too busy","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","coaching:readonly","learning","learning:readonly"]}],"x-purecloud-method-name":"getUsersDevelopmentActivitiesMe"}},"/api/v2/routing/queues/{queueId}/members":{"get":{"tags":["Routing"],"summary":"Get the members of this queue.","description":"","operationId":"getRoutingQueueMembers","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size [max 100]","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"routingStatus"},{"name":"presence"},{"name":"conversationSummary"},{"name":"outOfOffice"},{"name":"geolocation"},{"name":"station"},{"name":"authorization"},{"name":"lasttokenissued"},{"name":"authorization.unusedRoles"},{"name":"team"},{"name":"profileSkills"},{"name":"certifications"},{"name":"locations"},{"name":"groups"},{"name":"skills"},{"name":"languages"},{"name":"languagePreference"},{"name":"employerInfo"},{"name":"biography"}]},{"name":"joined","in":"query","description":"Filter by joined status","required":false,"type":"boolean"},{"name":"name","in":"query","description":"Filter by queue member name","required":false,"type":"string"},{"name":"profileSkills","in":"query","description":"Filter by profile skill","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"skills","in":"query","description":"Filter by skill","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"languages","in":"query","description":"Filter by language","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"routingStatus","in":"query","description":"Filter by routing status","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"presence","in":"query","description":"Filter by presence","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueMemberEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.page.number":"Invalid page number specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","missing.any.division.permissions":"At least one of the required division permissions is missing"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"external.service.error":"The server is currently unable to handle the request .","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:view","routing:queueMember:manage"]},"x-purecloud-method-name":"getRoutingQueueMembers"},"post":{"tags":["Routing"],"summary":"Bulk add or delete up to 100 queue members","description":"","operationId":"postRoutingQueueMembers","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Queue Members","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/WritableEntity"}}},{"name":"delete","in":"query","description":"True to delete queue members","required":false,"type":"boolean","default":false}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid request data. Make sure you submit a valid number of queue members.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","queue.size.limit":"Adding all requested members would exceed queue member limit.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","missing.any.division.permissions":"At least one of the required division permissions is missing"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"Specified queue could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:edit","routing:queueMember:manage"]},"x-purecloud-method-name":"postRoutingQueueMembers"},"patch":{"tags":["Routing"],"summary":"Join or unjoin a set of users for a queue","description":"","operationId":"patchRoutingQueueMembers","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Queue Members","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/QueueMember"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueMemberEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid request data. Make sure a valid number of queue members was submitted, and all have the joined property specified.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","missing.any.division.permissions":"At least one of the required division permissions is missing"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"Specified queue could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:edit","routing:queueMember:manage"]},"x-purecloud-method-name":"patchRoutingQueueMembers"}},"/api/v2/integrations/actions/{actionId}/draft":{"get":{"tags":["Integrations"],"summary":"Retrieve a Draft","description":"","operationId":"getIntegrationsActionDraft","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"name":"expand","in":"query","description":"Indicates a field in the response which should be expanded.","required":false,"type":"string","enum":["contract"],"x-genesys-enum-members":[{"name":"contract"}]},{"name":"includeConfig","in":"query","description":"Return config in response.","required":false,"type":"boolean","default":false,"enum":["true","false"],"x-genesys-enum-members":[{"name":"true"},{"name":"false"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Action"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:view","bridge:actions:view"]},"x-purecloud-method-name":"getIntegrationsActionDraft"},"post":{"tags":["Integrations"],"summary":"Create a new Draft from existing Action","description":"","operationId":"postIntegrationsActionDraft","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Action"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","policy.violation":"A policy violation occurred creating the new draft.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:edit"]},"x-purecloud-method-name":"postIntegrationsActionDraft"},"delete":{"tags":["Integrations"],"summary":"Delete a Draft","description":"","operationId":"deleteIntegrationsActionDraft","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"}],"responses":{"204":{"description":"Delete was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:delete"]},"x-purecloud-method-name":"deleteIntegrationsActionDraft"},"patch":{"tags":["Integrations"],"summary":"Update an existing Draft","description":"","operationId":"patchIntegrationsActionDraft","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"in":"body","name":"body","description":"Input used to patch the Action Draft.","required":true,"schema":{"$ref":"#/definitions/UpdateDraftInput"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Action"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:edit"]},"x-purecloud-method-name":"patchIntegrationsActionDraft"}},"/api/v2/integrations/actions/{actionId}/draft/schemas/{fileName}":{"get":{"tags":["Integrations"],"summary":"Retrieve schema for a Draft based on filename.","description":"","operationId":"getIntegrationsActionDraftSchema","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"name":"fileName","in":"path","description":"Name of schema file to be retrieved for this draft.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JsonSchemaDocument"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:view","bridge:actions:view"]},"x-purecloud-method-name":"getIntegrationsActionDraftSchema"}},"/api/v2/integrations/actions/{actionId}/draft/templates/{fileName}":{"get":{"tags":["Integrations"],"summary":"Retrieve templates for a Draft based on filename.","description":"","operationId":"getIntegrationsActionDraftTemplate","produces":["text/plain"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"name":"fileName","in":"path","description":"Name of template file to be retrieved for this action draft.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:view","bridge:actions:view"]},"x-purecloud-method-name":"getIntegrationsActionDraftTemplate"}},"/api/v2/integrations/actions/{actionId}/draft/publish":{"post":{"tags":["Integrations"],"summary":"Publish a Draft and make it the active Action configuration","description":"","operationId":"postIntegrationsActionDraftPublish","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"in":"body","name":"body","description":"Input used to patch the Action.","required":true,"schema":{"$ref":"#/definitions/PublishDraftInput"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Action"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:edit"]},"x-purecloud-method-name":"postIntegrationsActionDraftPublish"}},"/api/v2/integrations/actions/{actionId}/draft/validation":{"get":{"tags":["Integrations"],"summary":"Validate current Draft configuration.","description":"","operationId":"getIntegrationsActionDraftValidation","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DraftValidationResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:edit"]},"x-purecloud-method-name":"getIntegrationsActionDraftValidation"}},"/api/v2/integrations/actions/{actionId}/draft/test":{"post":{"tags":["Integrations"],"summary":"Test the execution of a draft. Responses will show execution steps broken out with intermediate results to help in debugging.","description":"","operationId":"postIntegrationsActionDraftTest","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"in":"body","name":"body","description":"Map of parameters used for variable substitution.","required":true,"schema":{"type":"object","additionalProperties":{"type":"object"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TestExecutionResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:execute"]},"x-purecloud-method-name":"postIntegrationsActionDraftTest"}},"/api/v2/externalcontacts/scan/relationships":{"get":{"tags":["External Contacts"],"summary":"Scan for relationships","description":"","operationId":"getExternalcontactsScanRelationships","produces":["application/json"],"parameters":[{"name":"limit","in":"query","description":"The number of relationships per page; must be between 10 and 200, default is 100)","required":false,"type":"integer","format":"int32"},{"name":"cursor","in":"query","description":"Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CursorRelationshipListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid query parameter or expired cursor","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Too many requests in a given amount of time"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:view"]},"x-purecloud-method-name":"getExternalcontactsScanRelationships"}},"/api/v2/integrations/types/{typeId}/configschemas/{configType}":{"get":{"tags":["Integrations"],"summary":"Get properties config schema for an integration type.","description":"","operationId":"getIntegrationsTypeConfigschema","produces":["application/json"],"parameters":[{"name":"typeId","in":"path","description":"Integration Type Id","required":true,"type":"string"},{"name":"configType","in":"path","description":"Config schema type","required":true,"type":"string","enum":["properties","advanced"],"x-genesys-enum-members":[{"name":"properties"},{"name":"advanced"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JsonSchemaDocument"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-purecloud-method-name":"getIntegrationsTypeConfigschema"}},"/api/v2/quality/forms/evaluations/{formId}":{"get":{"tags":["Quality"],"summary":"Get an evaluation form","description":"","operationId":"getQualityFormsEvaluation","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"evaluation.form.invalid":"The specified formId is not valid","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","evaluation.not.found":"Evaluation form not found"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:view"]},"x-purecloud-method-name":"getQualityFormsEvaluation"},"put":{"tags":["Quality"],"summary":"Update an evaluation form.","description":"","operationId":"putQualityFormsEvaluation","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Evaluation form","required":true,"schema":{"$ref":"#/definitions/EvaluationForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:edit"]},"x-purecloud-method-name":"putQualityFormsEvaluation"},"delete":{"tags":["Quality"],"summary":"Delete an evaluation form.","description":"","operationId":"deleteQualityFormsEvaluation","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"evaluation.cannot.be.deleted":"Cannot delete evaluation because it has already been published."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:delete"]},"x-purecloud-method-name":"deleteQualityFormsEvaluation"}},"/api/v2/externalcontacts/contacts/{contactId}/notes":{"get":{"tags":["External Contacts"],"summary":"List notes for an external contact","description":"","operationId":"getExternalcontactsContactNotes","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact Id","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":20,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["author","externalDataSources"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"author"},{"name":"externalDataSources"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NoteListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:view"]},"x-purecloud-method-name":"getExternalcontactsContactNotes"},"post":{"tags":["External Contacts"],"summary":"Create a note for an external contact","description":"","operationId":"postExternalcontactsContactNotes","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact Id","required":true,"type":"string"},{"in":"body","name":"body","description":"ExternalContact","required":true,"schema":{"$ref":"#/definitions/Note"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Note"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided contact was not valid"}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:edit"]},"x-purecloud-method-name":"postExternalcontactsContactNotes"}},"/api/v2/languageunderstanding/domains/{domainId}":{"get":{"tags":["Language Understanding"],"summary":"Find an NLU Domain.","description":"","operationId":"getLanguageunderstandingDomain","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluDomain"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","dialog:readonly","language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomain:view","dialog:bot:view"]},"x-purecloud-method-name":"getLanguageunderstandingDomain"},"delete":{"tags":["Language Understanding"],"summary":"Delete an NLU Domain.","description":"","operationId":"deleteLanguageunderstandingDomain","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"}],"responses":{"204":{"description":""},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","language-understanding"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomain:delete","dialog:bot:delete"]},"x-purecloud-method-name":"deleteLanguageunderstandingDomain"},"patch":{"tags":["Language Understanding"],"summary":"Update an NLU Domain.","description":"","operationId":"patchLanguageunderstandingDomain","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"in":"body","name":"body","description":"The updated NLU Domain.","required":true,"schema":{"$ref":"#/definitions/NluDomain"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluDomain"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","language-understanding"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomain:edit","dialog:bot:edit"]},"x-purecloud-method-name":"patchLanguageunderstandingDomain"}},"/api/v2/scim/schemas":{"get":{"tags":["SCIM"],"summary":"Get a list of SCIM schemas","description":"","operationId":"getScimSchemas","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"name":"filter","in":"query","description":"Filtered results are invalid and return 403 Unauthorized.","required":false,"type":"string","x-example":"displayName eq groupName"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2SchemaListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimSchemas"}},"/api/v2/scim/schemas/{schemaId}":{"get":{"tags":["SCIM"],"summary":"Get a SCIM schema","description":"","operationId":"getScimSchema","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"name":"schemaId","in":"path","description":"The ID of a schema. Returned with GET /api/v2/scim/schemas.","required":true,"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:core:2.0:Group","urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig","urn:ietf:params:scim:schemas:core:2.0:ResourceType","urn:ietf:params:scim:schemas:core:2.0:Schema","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User"],"x-genesys-enum-members":[{"name":"urn:ietf:params:scim:schemas:core:2.0:User"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group"},{"name":"urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig"},{"name":"urn:ietf:params:scim:schemas:core:2.0:ResourceType"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Schema"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2SchemaDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimSchema"}},"/api/v2/architect/schedules":{"get":{"tags":["Architect"],"summary":"Get a list of schedules.","description":"","operationId":"getArchitectSchedules","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"name","in":"query","description":"Name of the Schedule to filter by.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScheduleEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:schedule:view"]},"x-purecloud-method-name":"getArchitectSchedules"},"post":{"tags":["Architect"],"summary":"Create a new schedule.","description":"","operationId":"postArchitectSchedules","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Schedule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Schedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:schedule:add"]},"x-purecloud-method-name":"postArchitectSchedules"}},"/api/v2/telephony/providers/edges/trunkbasesettings/template":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Trunk Base Settings instance template from a given make and model. This object can then be modified and saved as a new Trunk Base Settings instance","description":"","operationId":"getTelephonyProvidersEdgesTrunkbasesettingsTemplate","produces":["application/json"],"parameters":[{"name":"trunkMetabaseId","in":"query","description":"The id of a metabase object upon which to base this Trunk Base Settings","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesTrunkbasesettingsTemplate"}},"/api/v2/routing/queues/{queueId}/users/{memberId}":{"delete":{"tags":["Routing"],"summary":"DEPRECATED: use DELETE /routing/queues/{queueId}/members/{memberId}. Delete queue member.","description":"","operationId":"deleteRoutingQueueUser","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"memberId","in":"path","description":"Member ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","missing.any.division.permissions":"At least one of the required division permissions is missing"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:edit","routing:queueMember:manage"]},"x-purecloud-method-name":"deleteRoutingQueueUser"},"patch":{"tags":["Routing"],"summary":"DEPRECATED: use PATCH /routing/queues/{queueId}/members/{memberId}. Update the ring number OR joined status for a User in a Queue.","description":"","operationId":"patchRoutingQueueUser","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"memberId","in":"path","description":"Member ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Queue Member","required":true,"schema":{"$ref":"#/definitions/QueueMember"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueMember"}},"202":{"description":"User update has been accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Invalid request data. Make sure the joined OR ringNumber property is specified.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","missing.any.division.permissions":"At least one of the required division permissions is missing"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:queue:edit","routing:queueMember:manage"]},"x-purecloud-method-name":"patchRoutingQueueUser"}},"/api/v2/groups/{groupId}/greetings/defaults":{"get":{"tags":["Greetings"],"summary":"Grabs the list of Default Greetings given a Group's ID","description":"","operationId":"getGroupGreetingsDefaults","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DefaultGreetingList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings","greetings:readonly"]}],"x-purecloud-method-name":"getGroupGreetingsDefaults"},"put":{"tags":["Greetings"],"summary":"Updates the DefaultGreetingList of the specified Group","description":"","operationId":"putGroupGreetingsDefaults","produces":["application/json"],"parameters":[{"name":"groupId","in":"path","description":"Group ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The updated defaultGreetingList","required":true,"schema":{"$ref":"#/definitions/DefaultGreetingList"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DefaultGreetingList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings"]}],"x-purecloud-method-name":"putGroupGreetingsDefaults"}},"/api/v2/telephony/providers/edges/extensionpools":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a listing of extension pools","description":"","operationId":"getTelephonyProvidersEdgesExtensionpools","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"startNumber"},{"name":"number","in":"query","description":"Number","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExtensionPoolEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesExtensionpools"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a new extension pool","description":"","operationId":"postTelephonyProvidersEdgesExtensionpools","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ExtensionPool","required":true,"schema":{"$ref":"#/definitions/ExtensionPool"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExtensionPool"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be completed by the server due to a conflict."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesExtensionpools"}},"/api/v2/scim/v2/schemas":{"get":{"tags":["SCIM"],"summary":"Get a list of SCIM schemas","description":"","operationId":"getScimV2Schemas","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"name":"filter","in":"query","description":"Filtered results are invalid and return 403 Unauthorized.","required":false,"type":"string","x-example":"displayName eq groupName"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2SchemaListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimV2Schemas"}},"/api/v2/scim/v2/schemas/{schemaId}":{"get":{"tags":["SCIM"],"summary":"Get a SCIM schema","description":"","operationId":"getScimV2Schema","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"name":"schemaId","in":"path","description":"The ID of a schema. Returned with GET /api/v2/scim/v2/schemas.","required":true,"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User","urn:ietf:params:scim:schemas:core:2.0:Group","urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig","urn:ietf:params:scim:schemas:core:2.0:ResourceType","urn:ietf:params:scim:schemas:core:2.0:Schema","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User"],"x-genesys-enum-members":[{"name":"urn:ietf:params:scim:schemas:core:2.0:User"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group"},{"name":"urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig"},{"name":"urn:ietf:params:scim:schemas:core:2.0:ResourceType"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Schema"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2SchemaDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimV2Schema"}},"/api/v2/contentmanagement/documents/{documentId}/content":{"get":{"tags":["Content Management"],"summary":"Download a document.","description":"","operationId":"getContentmanagementDocumentContent","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"name":"disposition","in":"query","description":"Request how the content will be downloaded: a file attachment or inline. Default is attachment.","required":false,"type":"string","enum":["attachment","inline"],"x-genesys-enum-members":[{"name":"attachment"},{"name":"inline"}]},{"name":"contentType","in":"query","description":"The requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav","required":false,"type":"string"}],"responses":{"200":{"description":"Download location returned","schema":{"$ref":"#/definitions/DownloadResponse"}},"202":{"description":"Accepted - Preparing file for download - try again soon."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden from downloading content."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementDocumentContent"},"post":{"tags":["Content Management"],"summary":"Replace the contents of a document.","description":"","operationId":"postContentmanagementDocumentContent","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Replace Request","required":true,"schema":{"$ref":"#/definitions/ReplaceRequest"}},{"name":"override","in":"query","description":"Override any lock on the document","required":false,"type":"boolean"}],"responses":{"202":{"description":"Accepted - Ready for upload","schema":{"$ref":"#/definitions/ReplaceResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.null.argument":"Invalid request, null argument provided.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Resource conflict - Unexpected changeNumber was provided","x-inin-error-codes":{"resource.conflict":"Resource conflict - Unexpected changeNumber was provided."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"423":{"description":"Locked - The document is locked by another operation","x-inin-error-codes":{"locked":"Locked - The document is locked by another operation."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"postContentmanagementDocumentContent"}},"/api/v2/telephony/providers/edges/trunkbasesettings/availablemetabases":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of available makes and models to create a new Trunk Base Settings","description":"","operationId":"getTelephonyProvidersEdgesTrunkbasesettingsAvailablemetabases","produces":["application/json"],"parameters":[{"name":"type","in":"query","required":false,"type":"string","enum":["EXTERNAL","PHONE","EDGE"],"x-genesys-enum-members":[{"name":"EXTERNAL"},{"name":"PHONE"},{"name":"EDGE"}]},{"name":"pageSize","in":"query","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkMetabaseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesTrunkbasesettingsAvailablemetabases"}},"/api/v2/telephony/siptraces/download/{downloadId}":{"get":{"tags":["Telephony"],"summary":"Get signed S3 URL for a pcap download","description":"","operationId":"getTelephonySiptracesDownloadDownloadId","produces":["application/json"],"parameters":[{"name":"downloadId","in":"path","description":"unique id for the downloaded file in S3","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SignedUrlResponse"}},"202":{"description":"Request to download pcap file has been accepted","schema":{"$ref":"#/definitions/SignedUrlResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["telephony:pcap:view"]},"x-purecloud-method-name":"getTelephonySiptracesDownloadDownloadId"}},"/api/v2/telephony/siptraces":{"get":{"tags":["Telephony"],"summary":"Fetch SIP metadata","description":"Fetch SIP metadata that matches a given parameter. If exactMatch is passed as a parameter only sip records that have exactly that value will be returned. For example, some records contain conversationId but not all relevant records for that call may contain the conversationId so only a partial view of the call will be reflected","operationId":"getTelephonySiptraces","produces":["application/json"],"parameters":[{"name":"callId","in":"query","description":"unique identification of the placed call","required":false,"type":"string"},{"name":"toUser","in":"query","description":"User to who the call was placed","required":false,"type":"string"},{"name":"fromUser","in":"query","description":"user who placed the call","required":false,"type":"string"},{"name":"conversationId","in":"query","description":"Unique identification of the conversation","required":false,"type":"string"},{"name":"dateStart","in":"query","description":"Start date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","required":true,"type":"string","format":"date-time"},{"name":"dateEnd","in":"query","description":"End date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","required":true,"type":"string","format":"date-time"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SipSearchResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["telephony:pcap:view"]},"x-purecloud-method-name":"getTelephonySiptraces"}},"/api/v2/telephony/siptraces/download":{"post":{"tags":["Telephony"],"summary":"Request a download of a pcap file to S3","description":"","operationId":"postTelephonySiptracesDownload","produces":["application/json"],"parameters":[{"in":"body","name":"SIPSearchPublicRequest","required":true,"schema":{"$ref":"#/definitions/SIPSearchPublicRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SipDownloadResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["telephony:pcap:add"]},"x-purecloud-method-name":"postTelephonySiptracesDownload"}},"/api/v2/analytics/journeys/aggregates/query":{"post":{"tags":["Journey","Analytics"],"summary":"Query for journey aggregates","description":"","operationId":"postAnalyticsJourneysAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/JourneyAggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JourneyAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:journeyAggregate:view"]},"x-purecloud-method-name":"postAnalyticsJourneysAggregatesQuery"}},"/api/v2/routing/languages/{languageId}":{"get":{"tags":["Languages"],"summary":"Get language","description":"","operationId":"getRoutingLanguage","produces":["application/json"],"parameters":[{"name":"languageId","in":"path","description":"Language ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Language"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-purecloud-method-name":"getRoutingLanguage"},"delete":{"tags":["Languages"],"summary":"Delete Language","description":"","operationId":"deleteRoutingLanguage","produces":["application/json"],"parameters":[{"name":"languageId","in":"path","description":"Language ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:skill:manage"]},"x-purecloud-method-name":"deleteRoutingLanguage"}},"/api/v2/flows/datatables/{datatableId}":{"get":{"tags":["Architect"],"summary":"Returns a specific datatable by id","description":"Given a datatableId returns the datatable object and schema associated with it.","operationId":"getFlowsDatatable","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand instructions for the result","required":false,"type":"string","enum":["schema"],"x-genesys-enum-members":[{"name":"schema"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataTable"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","flows.datatables.syntax.error":"There was an error parsing user data","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.table.not.found":"The datatable could not be found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:view"]},"x-purecloud-method-name":"getFlowsDatatable"},"put":{"tags":["Architect"],"summary":"Updates a specific datatable by id","description":"Updates a schema for a datatable with the given datatableId -updates allow only new fields to be added in the schema, no changes or removals of existing fields.","operationId":"putFlowsDatatable","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand instructions for the result","required":false,"type":"string","enum":["schema"],"x-genesys-enum-members":[{"name":"schema"}]},{"in":"body","name":"body","description":"datatable json-schema","required":false,"schema":{"$ref":"#/definitions/DataTable"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataTable"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.cannot.remove.fields":"The updated schema had missing fields from the old schema (can't remove previously existing fields).","flows.datatables.too.many.properties":"The max number of properties allowed in a schema has been reached.","flows.datatables.schema.exception":"The schema is invalid in some way","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","flows.datatables.syntax.error":"There was an error parsing user data","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.table.not.found":"The datatable could not be found.","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.not.unique":"The passed in datatable had a duplicate name."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:edit"]},"x-purecloud-method-name":"putFlowsDatatable"},"delete":{"tags":["Architect"],"summary":"deletes a specific datatable by id","description":"Deletes an entire datatable (including the schema and data) with a given datatableId","operationId":"deleteFlowsDatatable","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"name":"force","in":"query","description":"force delete, even if in use","required":false,"type":"boolean","default":false}],"responses":{"204":{"description":"The datatable was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","flows.datatables.syntax.error":"There was an error parsing user data"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.possibly.in.use":"This datatable may be in use by a published flow.","flows.datatables.in.use":"This datatable is in use by a published flow."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:delete"]},"x-purecloud-method-name":"deleteFlowsDatatable"}},"/api/v2/routing/message/recipients/{recipientId}":{"get":{"tags":["Routing"],"summary":"Get a recipient","description":"","operationId":"getRoutingMessageRecipient","produces":["application/json"],"parameters":[{"name":"recipientId","in":"path","description":"Recipient ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Recipient"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:message:manage"]},"x-purecloud-method-name":"getRoutingMessageRecipient"},"put":{"tags":["Routing"],"summary":"Update a recipient","description":"","operationId":"putRoutingMessageRecipient","produces":["application/json"],"parameters":[{"name":"recipientId","in":"path","description":"Recipient ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Recipient","required":true,"schema":{"$ref":"#/definitions/Recipient"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Recipient"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:message:manage"]},"x-purecloud-method-name":"putRoutingMessageRecipient"}},"/api/v2/recording/crossplatform/mediaretentionpolicies/{policyId}":{"get":{"tags":["Recording"],"summary":"Get a media retention policy","description":"","operationId":"getRecordingCrossplatformMediaretentionpolicy","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CrossPlatformPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:crossPlatformRetentionPolicy:view"]},"x-purecloud-method-name":"getRecordingCrossplatformMediaretentionpolicy"},"put":{"tags":["Recording"],"summary":"Update a media retention policy","description":"","operationId":"putRecordingCrossplatformMediaretentionpolicy","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Policy","required":true,"schema":{"$ref":"#/definitions/CrossPlatformPolicy"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CrossPlatformPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.policy.assign.metered.evaluation.evaluator.permission.check.failed":"evaluator permission failure for metered evaluation","recording.media.policy.invalid":"One of the configured actions or conditions was invalid.","recording.policy.calibrator.permission.fail":"General calibrator permission failure","recording.policy.export.integration.disabled":"The specified export integration is not in active state.","recording.policy.invalid.queue":"The specified queues was invalid.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","recording.policy.assign.evaluation.evaluator.permission.check.failed":"evaluator permission failure for evaluation","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","recording.policy.assign.calibration.evaluator.permission.check.failed":"Calibrator permission failure","recording.policy.export.integration.invalid":"The specified export integration is not a valid integration.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:crossPlatformRetentionPolicy:edit"]},"x-purecloud-method-name":"putRecordingCrossplatformMediaretentionpolicy"},"delete":{"tags":["Recording"],"summary":"Delete a media retention policy","description":"","operationId":"deleteRecordingCrossplatformMediaretentionpolicy","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.policy.not.found":"The supplied policy was not found or is invalid","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:crossPlatformRetentionPolicy:delete"]},"x-purecloud-method-name":"deleteRecordingCrossplatformMediaretentionpolicy"},"patch":{"tags":["Recording"],"summary":"Patch a media retention policy","description":"","operationId":"patchRecordingCrossplatformMediaretentionpolicy","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Policy","required":true,"schema":{"$ref":"#/definitions/CrossPlatformPolicy"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CrossPlatformPolicy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:crossPlatformRetentionPolicy:edit"]},"x-purecloud-method-name":"patchRecordingCrossplatformMediaretentionpolicy"}},"/api/v2/quality/forms/surveys":{"get":{"tags":["Quality"],"summary":"Get the list of survey forms","description":"","operationId":"getQualityFormsSurveys","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"expand","in":"query","description":"Expand","required":false,"type":"string"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Order to sort results, either asc or desc","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyFormEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:view"]},"x-purecloud-method-name":"getQualityFormsSurveys"},"post":{"tags":["Quality"],"summary":"Create a survey form.","description":"","operationId":"postQualityFormsSurveys","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Survey form","required":true,"schema":{"$ref":"#/definitions/SurveyForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:add"]},"x-purecloud-method-name":"postQualityFormsSurveys"}},"/api/v2/integrations/speech/lex/bots":{"get":{"tags":["Integrations"],"summary":"Get a list of Lex bots in the customers' AWS accounts","description":"","operationId":"getIntegrationsSpeechLexBots","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"name","in":"query","description":"Filter on bot name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LexBotEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechLexBots"}},"/api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}/roles":{"get":{"tags":["Organization Authorization"],"summary":"Get Trustee User Roles","description":"","operationId":"getOrgauthorizationTrusteeUserRoles","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Trustee User Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserAuthorization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:view"]},"x-purecloud-method-name":"getOrgauthorizationTrusteeUserRoles"},"put":{"tags":["Organization Authorization"],"summary":"Update Trustee User Roles","description":"","operationId":"putOrgauthorizationTrusteeUserRoles","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Trustee User Id","required":true,"type":"string"},{"in":"body","name":"body","description":"List of roles","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserAuthorization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:edit"]},"x-purecloud-method-name":"putOrgauthorizationTrusteeUserRoles"},"delete":{"tags":["Organization Authorization"],"summary":"Delete Trustee User Roles","description":"","operationId":"deleteOrgauthorizationTrusteeUserRoles","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Trustee User Id","required":true,"type":"string"}],"responses":{"204":{"description":"Roles deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:delete"]},"x-purecloud-method-name":"deleteOrgauthorizationTrusteeUserRoles"}},"/api/v2/users/{userId}/outofoffice":{"get":{"tags":["Users"],"summary":"Get a OutOfOffice","description":"","operationId":"getUserOutofoffice","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutOfOffice"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.usernotfound":"User was not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getUserOutofoffice"},"put":{"tags":["Users"],"summary":"Update an OutOfOffice","description":"","operationId":"putUserOutofoffice","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The updated OutOffOffice","required":true,"schema":{"$ref":"#/definitions/OutOfOffice"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutOfOffice"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-purecloud-method-name":"putUserOutofoffice"}},"/api/v2/identityproviders/adfs":{"get":{"tags":["Identity Provider"],"summary":"Get ADFS Identity Provider","description":"","operationId":"getIdentityprovidersAdfs","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ADFS"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersAdfs"},"put":{"tags":["Identity Provider"],"summary":"Update/Create ADFS Identity Provider","description":"","operationId":"putIdentityprovidersAdfs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/ADFS"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.issuer.uri":"An issuer URI is required.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.target.url":"The target URL must be a valid HTTPS URL.","certificate.not.yet.valid":"The certificate is not yet valid.","certificate.invalid.base64":"Invalid base64 in certificate.","certificate.unparseable":"The certificate for provider cannot be parsed.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersAdfs"},"delete":{"tags":["Identity Provider"],"summary":"Delete ADFS Identity Provider","description":"","operationId":"deleteIdentityprovidersAdfs","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersAdfs"}},"/api/v2/speechandtextanalytics/conversations/{conversationId}/communications/{communicationId}/transcripturl":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get the pre-signed S3 URL for the transcript of a specific communication of a conversation","description":"","operationId":"getSpeechandtextanalyticsConversationCommunicationTranscripturl","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"Communication ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TranscriptUrl"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden from retrieving transcript url."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"URL is not available."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:recording:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsConversationCommunicationTranscripturl"}},"/api/v2/profiles/users":{"get":{"tags":["Users"],"summary":"Get a user profile listing","description":"This api is deprecated. User /api/v2/users","operationId":"getProfilesUsers","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"jid","in":"query","description":"jid","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ASC","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","conversationSummary","outOfOffice","geolocation","station","authorization"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"routingStatus"},{"name":"presence"},{"name":"conversationSummary"},{"name":"outOfOffice"},{"name":"geolocation"},{"name":"station"},{"name":"authorization"}]},{"name":"integrationPresenceSource","in":"query","description":"Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an \"expand\".","required":false,"type":"string","enum":["MicrosoftTeams","ZoomPhone","RingCentral"],"x-genesys-enum-members":[{"name":"MicrosoftTeams"},{"name":"ZoomPhone"},{"name":"RingCentral"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserProfileEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getProfilesUsers"}},"/api/v2/scim/v2/groups/{groupId}":{"get":{"tags":["SCIM"],"summary":"Get a group","description":"","operationId":"getScimV2Group","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"name":"groupId","in":"path","description":"The ID of a group. Returned with GET /api/v2/scim/v2/groups.","required":true,"type":"string"},{"name":"attributes","in":"query","description":"Indicates which attributes to include. Returns these attributes and the \"id\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","displayName","members","externalId","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:id","urn:ietf:params:scim:schemas:core:2.0:Group:meta","urn:ietf:params:scim:schemas:core:2.0:Group:meta.version","urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:displayName","urn:ietf:params:scim:schemas:core:2.0:Group:members","urn:ietf:params:scim:schemas:core:2.0:Group:externalId"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"id"},{"name":"displayName"},{"name":"members"},{"name":"externalId"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:members"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:externalId"},{"name":"id"},{"name":"displayName"},{"name":"members"},{"name":"externalId"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:members"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:externalId"}]},{"name":"excludedAttributes","in":"query","description":"Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns \"id\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","displayName","members","externalId","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:id","urn:ietf:params:scim:schemas:core:2.0:Group:meta","urn:ietf:params:scim:schemas:core:2.0:Group:meta.version","urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:displayName","urn:ietf:params:scim:schemas:core:2.0:Group:members","urn:ietf:params:scim:schemas:core:2.0:Group:externalId"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"id"},{"name":"displayName"},{"name":"members"},{"name":"externalId"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:members"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:externalId"},{"name":"id"},{"name":"displayName"},{"name":"members"},{"name":"externalId"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:members"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:externalId"}]},{"name":"If-None-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2Group"}},"304":{"description":"If-Non-Match header matches current version. No content returned."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:edit"]},"x-purecloud-method-name":"getScimV2Group"},"put":{"tags":["SCIM"],"summary":"Replace a group","description":"","operationId":"putScimV2Group","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"name":"groupId","in":"path","description":"The ID of a group. Returned with GET /api/v2/scim/v2/groups.","required":true,"type":"string"},{"name":"If-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".","required":false,"type":"string"},{"in":"body","name":"body","description":"The information used to replace a group.","required":true,"schema":{"$ref":"#/definitions/ScimV2Group"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2Group"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Version does not match current version.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:edit"]},"x-purecloud-method-name":"putScimV2Group"},"patch":{"tags":["SCIM"],"summary":"Modify a group","description":"","operationId":"patchScimV2Group","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"name":"groupId","in":"path","description":"The ID of a group. Returned with GET /api/v2/scim/v2/groups.","required":true,"type":"string"},{"name":"If-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".","required":false,"type":"string"},{"in":"body","name":"body","description":"The information used to modify a group.","required":true,"schema":{"$ref":"#/definitions/ScimV2PatchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2Group"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","org.disabled":"Unable to modify group due to the organization being disabled.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Version does not match current version.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:edit"]},"x-purecloud-method-name":"patchScimV2Group"}},"/api/v2/scim/v2/groups":{"get":{"tags":["SCIM"],"summary":"Get a list of groups","description":"","operationId":"getScimV2Groups","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"name":"startIndex","in":"query","description":"The 1-based index of the first query result.","required":false,"type":"integer","default":1,"format":"int32"},{"name":"count","in":"query","description":"The requested number of items per page. A value of 0 returns \"totalResults\". A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the \"excludedAttributes\" or \"attributes\" query parameters to exclude or only include secondary lookup values such as \"externalId\", \"roles\", \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages\", or \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills\".","required":false,"type":"integer","default":25,"format":"int32"},{"name":"attributes","in":"query","description":"Indicates which attributes to include. Returns these attributes and the \"id\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","displayName","members","externalId","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:id","urn:ietf:params:scim:schemas:core:2.0:Group:meta","urn:ietf:params:scim:schemas:core:2.0:Group:meta.version","urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:displayName","urn:ietf:params:scim:schemas:core:2.0:Group:members","urn:ietf:params:scim:schemas:core:2.0:Group:externalId"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"id"},{"name":"displayName"},{"name":"members"},{"name":"externalId"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:members"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:externalId"},{"name":"id"},{"name":"displayName"},{"name":"members"},{"name":"externalId"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:members"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:externalId"}]},{"name":"excludedAttributes","in":"query","description":"Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns \"id\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","displayName","members","externalId","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:id","urn:ietf:params:scim:schemas:core:2.0:Group:meta","urn:ietf:params:scim:schemas:core:2.0:Group:meta.version","urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:Group:displayName","urn:ietf:params:scim:schemas:core:2.0:Group:members","urn:ietf:params:scim:schemas:core:2.0:Group:externalId"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"id"},{"name":"displayName"},{"name":"members"},{"name":"externalId"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:members"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:externalId"},{"name":"id"},{"name":"displayName"},{"name":"members"},{"name":"externalId"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:members"},{"name":"urn:ietf:params:scim:schemas:core:2.0:Group:externalId"}]},{"name":"filter","in":"query","description":"Filters results. If nothing is specified, returns all groups. Examples of valid values: \"id eq 5f4bc742-a019-4e38-8e2a-d39d5bc0b0f3\", \"displayname eq Sales\".","required":true,"type":"string","x-example":"displayName eq groupName"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimGroupListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:edit"]},"x-purecloud-method-name":"getScimV2Groups"}},"/api/v2/architect/dependencytracking/consumingresources":{"get":{"tags":["Architect"],"summary":"Get resources that consume a given Dependency Tracking object","description":"","operationId":"getArchitectDependencytrackingConsumingresources","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"Consumed object ID","required":true,"type":"string"},{"name":"objectType","in":"query","description":"Consumed object type","required":true,"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","BOTCONNECTORBOT","BOTCONNECTORBOTVERSION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GROUP","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","IVRCONFIGURATION","LANGUAGE","LEXBOT","LEXBOTALIAS","NLUDOMAIN","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","WIDGET","WORKFLOW"],"x-genesys-enum-members":[{"name":"ACDLANGUAGE"},{"name":"ACDSKILL"},{"name":"ACDWRAPUPCODE"},{"name":"BOTCONNECTORBOT"},{"name":"BOTCONNECTORBOTVERSION"},{"name":"BOTFLOW"},{"name":"BRIDGEACTION"},{"name":"COMMONMODULEFLOW"},{"name":"COMPOSERSCRIPT"},{"name":"CONTACTLIST"},{"name":"DATAACTION"},{"name":"DATATABLE"},{"name":"DIALOGENGINEBOT"},{"name":"DIALOGENGINEBOTVERSION"},{"name":"DIALOGFLOWAGENT"},{"name":"EMAILROUTE"},{"name":"EMERGENCYGROUP"},{"name":"FLOWACTION"},{"name":"FLOWDATATYPE"},{"name":"FLOWMILESTONE"},{"name":"FLOWOUTCOME"},{"name":"GROUP"},{"name":"INBOUNDCALLFLOW"},{"name":"INBOUNDCHATFLOW"},{"name":"INBOUNDEMAILFLOW"},{"name":"INBOUNDSHORTMESSAGEFLOW"},{"name":"INQUEUECALLFLOW"},{"name":"IVRCONFIGURATION"},{"name":"LANGUAGE"},{"name":"LEXBOT"},{"name":"LEXBOTALIAS"},{"name":"NLUDOMAIN"},{"name":"OUTBOUNDCALLFLOW"},{"name":"QUEUE"},{"name":"RECORDINGPOLICY"},{"name":"RESPONSE"},{"name":"SCHEDULE"},{"name":"SCHEDULEGROUP"},{"name":"SECUREACTION"},{"name":"SECURECALLFLOW"},{"name":"SURVEYINVITEFLOW"},{"name":"SYSTEMPROMPT"},{"name":"TTSENGINE"},{"name":"TTSVOICE"},{"name":"USER"},{"name":"USERPROMPT"},{"name":"WIDGET"},{"name":"WORKFLOW"}]},{"name":"resourceType","in":"query","description":"Types of consuming resources to show. Only versioned types are allowed here.","required":false,"type":"array","items":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","BOTCONNECTORBOT","BOTCONNECTORBOTVERSION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GROUP","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","IVRCONFIGURATION","LANGUAGE","LEXBOT","LEXBOTALIAS","NLUDOMAIN","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","WIDGET","WORKFLOW"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"ACDLANGUAGE"},{"name":"ACDSKILL"},{"name":"ACDWRAPUPCODE"},{"name":"BOTCONNECTORBOT"},{"name":"BOTCONNECTORBOTVERSION"},{"name":"BOTFLOW"},{"name":"BRIDGEACTION"},{"name":"COMMONMODULEFLOW"},{"name":"COMPOSERSCRIPT"},{"name":"CONTACTLIST"},{"name":"DATAACTION"},{"name":"DATATABLE"},{"name":"DIALOGENGINEBOT"},{"name":"DIALOGENGINEBOTVERSION"},{"name":"DIALOGFLOWAGENT"},{"name":"EMAILROUTE"},{"name":"EMERGENCYGROUP"},{"name":"FLOWACTION"},{"name":"FLOWDATATYPE"},{"name":"FLOWMILESTONE"},{"name":"FLOWOUTCOME"},{"name":"GROUP"},{"name":"INBOUNDCALLFLOW"},{"name":"INBOUNDCHATFLOW"},{"name":"INBOUNDEMAILFLOW"},{"name":"INBOUNDSHORTMESSAGEFLOW"},{"name":"INQUEUECALLFLOW"},{"name":"IVRCONFIGURATION"},{"name":"LANGUAGE"},{"name":"LEXBOT"},{"name":"LEXBOTALIAS"},{"name":"NLUDOMAIN"},{"name":"OUTBOUNDCALLFLOW"},{"name":"QUEUE"},{"name":"RECORDINGPOLICY"},{"name":"RESPONSE"},{"name":"SCHEDULE"},{"name":"SCHEDULEGROUP"},{"name":"SECUREACTION"},{"name":"SECURECALLFLOW"},{"name":"SURVEYINVITEFLOW"},{"name":"SYSTEMPROMPT"},{"name":"TTSENGINE"},{"name":"TTSVOICE"},{"name":"USER"},{"name":"USERPROMPT"},{"name":"WIDGET"},{"name":"WORKFLOW"}]},{"name":"version","in":"query","description":"Object version","required":false,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"flowFilter","in":"query","description":"Show only checkedIn or published flows","required":false,"type":"string","enum":["checkedIn","published"],"x-genesys-enum-members":[{"name":"checkedIn"},{"name":"published"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConsumingResourcesEntityListing"}},"206":{"description":"Partial Content - the org data is being rebuilt or needs to be rebuilt."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","architect.query.parameter.missing":"A required query parameter is missing or empty.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","architect.dependency.object.invalid.type":"An invalid dependency object type was specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.version.missing":"Specified flow version is missing.","not.found":"The requested resource was not found.","architect.dependency.object.not.found":"Could not find the dependency object with specified ID and version.","architect.flow.not.found":"Could not find flow with specified ID."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","architect.database.throughput.exceeded":"Database too busy. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:dependencyTracking:view"]},"x-purecloud-method-name":"getArchitectDependencytrackingConsumingresources"}},"/api/v2/identityproviders":{"get":{"tags":["Identity Provider"],"summary":"The list of identity providers","description":"","operationId":"getIdentityproviders","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthProviderEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityproviders"}},"/api/v2/recording/mediaretentionpolicies":{"get":{"tags":["Recording"],"summary":"Gets media retention policy list with query options to filter on name and enabled.","description":"for a less verbose response, add summary=true to this endpoint","operationId":"getRecordingMediaretentionpolicies","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"name","in":"query","description":"the policy name - used for filtering results in searches.","required":false,"type":"string"},{"name":"enabled","in":"query","description":"checks to see if policy is enabled - use enabled = true or enabled = false","required":false,"type":"boolean"},{"name":"summary","in":"query","description":"provides a less verbose response of policy lists.","required":false,"type":"boolean","default":false},{"name":"hasErrors","in":"query","description":"provides a way to fetch all policies with errors or policies that do not have errors","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PolicyEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:retentionPolicy:view"]},"x-purecloud-method-name":"getRecordingMediaretentionpolicies"},"post":{"tags":["Recording"],"summary":"Create media retention policy","description":"","operationId":"postRecordingMediaretentionpolicies","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Policy","required":true,"schema":{"$ref":"#/definitions/PolicyCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Policy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.media.policy.invalid":"One of the configured actions or conditions was invalid.","bad.request":"The request could not be understood by the server due to malformed syntax.","recording.policy.assign.evaluation.evaluator.permission.check.failed":"evaluator permission failure for evaluation","recording.policy.assign.calibration.evaluator.permission.check.failed":"Calibrator permission failure","recording.policy.export.integration.invalid":"The specified export integration is not a valid integration.","recording.policy.assign.metered.evaluation.evaluator.permission.check.failed":"evaluator permission failure for metered evaluation","recording.policy.calibrator.permission.fail":"General calibrator permission failure","recording.policy.export.integration.disabled":"The specified export integration is not in active state.","recording.policy.invalid.queue":"The specified queues was invalid.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","recording.policy.name.duplicate.name":"Policy name already exists, cannot duplicate.","recording.policy.description.exceeds.limit":"Policy description exceeds size limit.","recording.policy.assign.survey.sending.domain.does.not.exist":"Sending domain does not exist in the organization","recording.policy.name.exceeds.limit":"Policy named exceeds size limit.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:retentionPolicy:add"]},"x-purecloud-method-name":"postRecordingMediaretentionpolicies"},"delete":{"tags":["Recording"],"summary":"Delete media retention policies","description":"Bulk delete of media retention policies, this will only delete the polices that match the ids specified in the query param.","operationId":"deleteRecordingMediaretentionpolicies","produces":["application/json"],"parameters":[{"name":"ids","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:retentionPolicy:delete"]},"x-purecloud-method-name":"deleteRecordingMediaretentionpolicies"}},"/api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get outbound routes","description":"","operationId":"getTelephonyProvidersEdgesSiteOutboundroutes","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"externalTrunkBases.ids","in":"query","description":"externalTrunkBases.ids","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutboundRouteBaseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesSiteOutboundroutes"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create outbound route","description":"","operationId":"postTelephonyProvidersEdgesSiteOutboundroutes","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"in":"body","name":"body","description":"OutboundRoute","required":true,"schema":{"$ref":"#/definitions/OutboundRouteBase"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutboundRouteBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"required.field.missing":"A required field is missing a value.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","number.plan.type.usage.must.be.unique":"The number plan type usage must be unique.","address.classification.type.does.not.exist\t":"The address classification does not exist.","duplicate.value":"An outbound route with this name already exists.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesSiteOutboundroutes"}},"/api/v2/externalcontacts/organizations":{"get":{"tags":["External Contacts"],"summary":"Search for external organizations","description":"","operationId":"getExternalcontactsOrganizations","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":20,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":1,"format":"int32"},{"name":"q","in":"query","description":"Search query","required":false,"type":"string"},{"name":"trustorId","in":"query","description":"Search for external organizations by trustorIds (limit 25). If supplied, the 'q' parameters is ignored. Items are returned in the order requested","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["externalDataSources"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"externalDataSources"}]},{"name":"includeTrustors","in":"query","description":"(true or false) whether or not to include trustor information embedded in the externalOrganization","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalOrganizationListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:view","externalContacts:externalOrganization:view"]},"x-purecloud-method-name":"getExternalcontactsOrganizations"},"post":{"tags":["External Contacts"],"summary":"Create an external organization","description":"","operationId":"postExternalcontactsOrganizations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ExternalOrganization","required":true,"schema":{"$ref":"#/definitions/ExternalOrganization"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalOrganization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"custom.fields.validation.failed":"The provided custom field is not valid.","validation.failed":"The provided contact was not valid"}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["relate:externalOrganization:add","externalContacts:externalOrganization:add"]},"x-purecloud-method-name":"postExternalcontactsOrganizations"}},"/api/v2/outbound/campaigns/divisionviews/{campaignId}":{"get":{"tags":["Outbound"],"summary":"Get a basic Campaign information object","description":"This returns a simplified version of a Campaign, consisting of name and division.","operationId":"getOutboundCampaignsDivisionview","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignDivisionView"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:campaign:search"]},"x-purecloud-method-name":"getOutboundCampaignsDivisionview"}},"/api/v2/integrations/credentials":{"get":{"tags":["Integrations"],"summary":"List multiple sets of credentials","description":"","operationId":"getIntegrationsCredentials","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CredentialInfoListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-purecloud-method-name":"getIntegrationsCredentials"},"post":{"tags":["Integrations"],"summary":"Create a set of credentials","description":"","operationId":"postIntegrationsCredentials","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Credential","required":false,"schema":{"$ref":"#/definitions/Credential"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CredentialInfo"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-purecloud-method-name":"postIntegrationsCredentials"}},"/api/v2/outbound/rulesets/{ruleSetId}":{"get":{"tags":["Outbound"],"summary":"Get a Rule Set by ID.","description":"","operationId":"getOutboundRuleset","produces":["application/json"],"parameters":[{"name":"ruleSetId","in":"path","description":"Rule Set ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RuleSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:ruleSet:view"]},"x-purecloud-method-name":"getOutboundRuleset"},"put":{"tags":["Outbound"],"summary":"Update a RuleSet.","description":"","operationId":"putOutboundRuleset","produces":["application/json"],"parameters":[{"name":"ruleSetId","in":"path","description":"Rule Set ID","required":true,"type":"string"},{"in":"body","name":"body","description":"RuleSet","required":true,"schema":{"$ref":"#/definitions/RuleSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RuleSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.rule.action":"","name.cannot.be.blank":"A name must be provided.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","invalid.rule.condition":"","data.action.not.found":"The requested data action could not be found","invalid.update":"","rule.conflict":"Duplicated Rule IDs and/or names.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.rule.condition.category":"The condition is not valid for the given category.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.rule.action.category":"The action is not valid for the given category."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.wrong.version":""}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:ruleSet:edit"]},"x-purecloud-method-name":"putOutboundRuleset"},"delete":{"tags":["Outbound"],"summary":"Delete a Rule set.","description":"","operationId":"deleteOutboundRuleset","produces":["application/json"],"parameters":[{"name":"ruleSetId","in":"path","description":"Rule Set ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","referential.integrity.error":"Could not delete the resource because it is referenced by another entity."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:ruleSet:delete"]},"x-purecloud-method-name":"deleteOutboundRuleset"}},"/api/v2/analytics/surveys/aggregates/query":{"post":{"tags":["Quality","Analytics"],"summary":"Query for survey aggregates","description":"","operationId":"postAnalyticsSurveysAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/SurveyAggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:surveyAggregate:view"]},"x-purecloud-method-name":"postAnalyticsSurveysAggregatesQuery"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes/{activityCodeId}":{"get":{"tags":["Workforce Management"],"summary":"Get an activity code","description":"","operationId":"getWorkforcemanagementBusinessunitActivitycode","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit, or 'mine' for the business unit of the logged-in user.","required":true,"type":"string"},{"name":"activityCodeId","in":"path","description":"The ID of the activity code to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BusinessUnitActivityCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:activityCode:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitActivitycode"},"delete":{"tags":["Workforce Management"],"summary":"Deletes an activity code","description":"","operationId":"deleteWorkforcemanagementBusinessunitActivitycode","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit, or 'mine' for the business unit of the logged-in user.","required":true,"type":"string"},{"name":"activityCodeId","in":"path","description":"The ID of the activity code to delete","required":true,"type":"string"}],"responses":{"204":{"description":"The activity code was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:activityCode:delete"]},"x-purecloud-method-name":"deleteWorkforcemanagementBusinessunitActivitycode"},"patch":{"tags":["Workforce Management"],"summary":"Update an activity code","description":"","operationId":"patchWorkforcemanagementBusinessunitActivitycode","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit, or 'mine' for the business unit of the logged-in user.","required":true,"type":"string"},{"name":"activityCodeId","in":"path","description":"The ID of the activity code to update","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/UpdateActivityCodeRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BusinessUnitActivityCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Entity was modified by another request"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:activityCode:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementBusinessunitActivitycode"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes":{"get":{"tags":["Workforce Management"],"summary":"Get activity codes","description":"","operationId":"getWorkforcemanagementBusinessunitActivitycodes","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit, or 'mine' for the business unit of the logged-in user.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BusinessUnitActivityCodeListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:agentSchedule:view","wfm:agentTimeOffRequest:submit","wfm:activityCode:add","wfm:activityCode:delete","wfm:activityCode:edit","wfm:activityCode:view","wfm:agent:edit","wfm:agent:view","wfm:businessUnit:add","wfm:businessUnit:delete","wfm:businessUnit:edit","wfm:businessUnit:view","wfm:historicalAdherence:view","wfm:intraday:view","wfm:managementUnit:add","wfm:managementUnit:delete","wfm:managementUnit:edit","wfm:managementUnit:view","wfm:realtimeAdherence:view","wfm:schedule:add","wfm:schedule:delete","wfm:schedule:edit","wfm:schedule:generate","wfm:schedule:view","wfm:publishedSchedule:view","wfm:serviceGoalTemplate:add","wfm:serviceGoalTemplate:delete","wfm:serviceGoalTemplate:edit","wfm:serviceGoalTemplate:view","wfm:planningGroup:add","wfm:planningGroup:delete","wfm:planningGroup:edit","wfm:planningGroup:view","wfm:shiftTradeRequest:edit","wfm:shiftTradeRequest:view","wfm:shortTermForecast:add","wfm:shortTermForecast:delete","wfm:shortTermForecast:edit","wfm:shortTermForecast:view","wfm:timeOffRequest:add","wfm:timeOffRequest:edit","wfm:timeOffRequest:view","wfm:workPlan:add","wfm:workPlan:delete","wfm:workPlan:edit","wfm:workPlan:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitActivitycodes"},"post":{"tags":["Workforce Management"],"summary":"Create a new activity code","description":"","operationId":"postWorkforcemanagementBusinessunitActivitycodes","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit, or 'mine' for the business unit of the logged-in user.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/CreateActivityCodeRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BusinessUnitActivityCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:activityCode:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitActivitycodes"}},"/api/v2/journey/outcomes/{outcomeId}":{"get":{"tags":["Journey"],"summary":"Retrieve a single outcome.","description":"","operationId":"getJourneyOutcome","produces":["application/json"],"parameters":[{"name":"outcomeId","in":"path","description":"ID of the outcome.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Outcome"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:outcome:view"]},"x-purecloud-method-name":"getJourneyOutcome"},"delete":{"tags":["Journey"],"summary":"Delete an outcome.","description":"","operationId":"deleteJourneyOutcome","produces":["application/json"],"parameters":[{"name":"outcomeId","in":"path","description":"ID of the outcome.","required":true,"type":"string"}],"responses":{"204":{"description":"Outcome deleted."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:outcome:delete"]},"x-purecloud-method-name":"deleteJourneyOutcome"},"patch":{"tags":["Journey"],"summary":"Update an outcome.","description":"","operationId":"patchJourneyOutcome","produces":["application/json"],"parameters":[{"name":"outcomeId","in":"path","description":"ID of the outcome.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/PatchOutcome"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Outcome"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:outcome:edit"]},"x-purecloud-method-name":"patchJourneyOutcome"}},"/api/v2/coaching/appointments/me":{"get":{"tags":["Coaching"],"summary":"Get my appointments for a given date range","description":"","operationId":"getCoachingAppointmentsMe","produces":["application/json"],"parameters":[{"name":"interval","in":"query","description":"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","required":false,"type":"string","format":"interval"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"statuses","in":"query","description":"Appointment Statuses to filter by","required":false,"type":"array","items":{"type":"string","enum":["Scheduled","InProgress","Completed"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"Scheduled"},{"name":"InProgress"},{"name":"Completed"}]},{"name":"facilitatorIds","in":"query","description":"The facilitator IDs for which to retrieve appointments","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortOrder","in":"query","description":"Sort (by due date) either Asc or Desc","required":false,"type":"string","enum":["Desc","Asc"],"x-genesys-enum-members":[{"name":"Desc"},{"name":"Asc"}]},{"name":"relationships","in":"query","description":"Relationships to filter by","required":false,"type":"array","items":{"type":"string","enum":["Creator","Facilitator","Attendee"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"Creator"},{"name":"Facilitator"},{"name":"Attendee"}]},{"name":"completionInterval","in":"query","description":"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","required":false,"type":"string","format":"interval"},{"name":"overdue","in":"query","description":"Overdue status to filter by","required":false,"type":"string","enum":["True","False","Any"],"x-genesys-enum-members":[{"name":"True"},{"name":"False"},{"name":"Any"}]}],"responses":{"200":{"description":"Get my coaching appointments successful","schema":{"$ref":"#/definitions/CoachingAppointmentResponseList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","coaching:readonly"]}],"x-purecloud-method-name":"getCoachingAppointmentsMe"}},"/api/v2/coaching/appointments/{appointmentId}/annotations":{"get":{"tags":["Coaching"],"summary":"Get a list of annotations.","description":"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).","operationId":"getCoachingAppointmentAnnotations","produces":["application/json"],"parameters":[{"name":"appointmentId","in":"path","description":"The ID of the coaching appointment.","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"Annotations retrieved","schema":{"$ref":"#/definitions/CoachingAnnotationList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"User does not have the annotation view permission and is not an attendee, creator or facilitator of the appointment"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.not.found":"Appointment not found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","coaching:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:annotation:view","coaching:privateAnnotation:view"]},"x-purecloud-method-name":"getCoachingAppointmentAnnotations"},"post":{"tags":["Coaching"],"summary":"Create a new annotation.","description":"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).","operationId":"postCoachingAppointmentAnnotations","produces":["application/json"],"parameters":[{"name":"appointmentId","in":"path","description":"The ID of the coaching appointment.","required":true,"type":"string"},{"in":"body","name":"body","description":"The annotation to add","required":true,"schema":{"$ref":"#/definitions/CoachingAnnotationCreateRequest"}}],"responses":{"201":{"description":"Annotation created","schema":{"$ref":"#/definitions/CoachingAnnotation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","validation.failure":"The submitted data was not valid."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"User does not have the annotation add permission and is not an attendee, creator or facilitator of the appointment"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.not.found":"Appointment not found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:annotation:add","coaching:privateAnnotation:add"]},"x-purecloud-method-name":"postCoachingAppointmentAnnotations"}},"/api/v2/journey/segments":{"get":{"tags":["Journey"],"summary":"Retrieve all segments.","description":"","operationId":"getJourneySegments","produces":["application/json"],"parameters":[{"name":"sortBy","in":"query","description":"Field(s) to sort by. The response can be sorted by any first level property on the Outcome response. Prefix with '-' for descending (e.g. sortBy=displayName,-createdDate).","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"isActive","in":"query","description":"Determines whether or not to show only active segments.","required":false,"type":"boolean"},{"name":"segmentIds","in":"query","description":"IDs of segments to return. Use of this parameter is not compatible with pagination or sorting. A maximum of 100 segments are allowed per request.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SegmentListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:segment:view"]},"x-purecloud-method-name":"getJourneySegments"},"post":{"tags":["Journey"],"summary":"Create a segment.","description":"","operationId":"postJourneySegments","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/JourneySegment"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JourneySegment"}},"201":{"description":"Segment created.","schema":{"$ref":"#/definitions/JourneySegment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:segment:add"]},"x-purecloud-method-name":"postJourneySegments"}},"/api/v2/externalcontacts/contacts":{"get":{"tags":["External Contacts"],"summary":"Search for external contacts","description":"","operationId":"getExternalcontactsContacts","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":20,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)","required":false,"type":"integer","default":1,"format":"int32"},{"name":"q","in":"query","description":"User supplied search keywords (no special syntax is currently supported)","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["externalOrganization","externalDataSources"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"externalOrganization"},{"name":"externalDataSources"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:view"]},"x-purecloud-method-name":"getExternalcontactsContacts"},"post":{"tags":["External Contacts"],"summary":"Create an external contact","description":"","operationId":"postExternalcontactsContacts","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ExternalContact","required":true,"schema":{"$ref":"#/definitions/ExternalContact"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalContact"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"custom.fields.validation.failed":"The custom fields values failed validation","validation.failed":"The provided contact was not valid"}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:add"]},"x-purecloud-method-name":"postExternalcontactsContacts"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId}":{"get":{"tags":["Workforce Management"],"summary":"Get a service goal template","description":"","operationId":"getWorkforcemanagementBusinessunitServicegoaltemplate","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit.","required":true,"type":"string"},{"name":"serviceGoalTemplateId","in":"path","description":"The ID of a service goal template to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ServiceGoalTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:serviceGoalTemplate:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitServicegoaltemplate"},"delete":{"tags":["Workforce Management"],"summary":"Delete a service goal template","description":"","operationId":"deleteWorkforcemanagementBusinessunitServicegoaltemplate","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit.","required":true,"type":"string"},{"name":"serviceGoalTemplateId","in":"path","description":"The ID of the service goal template to delete","required":true,"type":"string"}],"responses":{"204":{"description":"The service goal template was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:serviceGoalTemplate:delete"]},"x-purecloud-method-name":"deleteWorkforcemanagementBusinessunitServicegoaltemplate"},"patch":{"tags":["Workforce Management"],"summary":"Updates a service goal template","description":"","operationId":"patchWorkforcemanagementBusinessunitServicegoaltemplate","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit.","required":true,"type":"string"},{"name":"serviceGoalTemplateId","in":"path","description":"The ID of a service goal template to update","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/UpdateServiceGoalTemplate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ServiceGoalTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Entity was modified by another request"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:serviceGoalTemplate:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementBusinessunitServicegoaltemplate"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates":{"get":{"tags":["Workforce Management"],"summary":"Gets list of service goal templates","description":"","operationId":"getWorkforcemanagementBusinessunitServicegoaltemplates","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ServiceGoalTemplateList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:serviceGoalTemplate:view","wfm:planningGroup:view","wfm:shortTermForecast:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitServicegoaltemplates"},"post":{"tags":["Workforce Management"],"summary":"Adds a new service goal template","description":"","operationId":"postWorkforcemanagementBusinessunitServicegoaltemplates","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/CreateServiceGoalTemplate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ServiceGoalTemplate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:serviceGoalTemplate:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitServicegoaltemplates"}},"/api/v2/users/{userId}/greetings":{"get":{"tags":["Greetings"],"summary":"Get a list of the User's Greetings","description":"","operationId":"getUserGreetings","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings","greetings:readonly"]}],"x-purecloud-method-name":"getUserGreetings"},"post":{"tags":["Greetings"],"summary":"Creates a Greeting for a User","description":"","operationId":"postUserGreetings","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The Greeting to create","required":true,"schema":{"$ref":"#/definitions/Greeting"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Greeting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings"]}],"x-purecloud-method-name":"postUserGreetings"}},"/api/v2/externalcontacts/organizations/schemas/{schemaId}/versions":{"get":{"tags":["External Contacts"],"summary":"Get all versions of an external organization's schema","description":"","operationId":"getExternalcontactsOrganizationsSchemaVersions","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"The schema to expand has parse errors"}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getExternalcontactsOrganizationsSchemaVersions"}},"/api/v2/outbound/campaigns/{campaignId}/stats":{"get":{"tags":["Outbound"],"summary":"Get statistics about a Dialer Campaign","description":"","operationId":"getOutboundCampaignStats","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignStats"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","campaign.not.found":"The dialer campaign was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:view"]},"x-purecloud-method-name":"getOutboundCampaignStats"}},"/api/v2/outbound/contactlists/divisionviews":{"get":{"tags":["Outbound"],"summary":"Query a list of simplified contact list objects.","description":"This return a simplified version of contact lists, consisting of the name, division, column names, phone columns, import status, and size.","operationId":"getOutboundContactlistsDivisionviews","produces":["application/json"],"parameters":[{"name":"includeImportStatus","in":"query","description":"Include import status","required":false,"type":"boolean","default":false},{"name":"includeSize","in":"query","description":"Include size","required":false,"type":"boolean","default":false},{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"],"x-genesys-enum-members":[{"name":"Equals"},{"name":"RegEx"},{"name":"Contains"},{"name":"Prefix"},{"name":"LessThan"},{"name":"LessThanEqualTo"},{"name":"GreaterThan"},{"name":"GreaterThanEqualTo"},{"name":"BeginsWith"},{"name":"EndsWith"}]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListDivisionViewListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.bulk.retrieves":"Only 100 contact lists can be retrieved by id at a time","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:contactList:search"]},"x-purecloud-method-name":"getOutboundContactlistsDivisionviews"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/historicaladherencequery":{"post":{"tags":["Workforce Management"],"summary":"Request a historical adherence report","description":"The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true","operationId":"postWorkforcemanagementManagementunitHistoricaladherencequery","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The management unit ID of the management unit","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/WfmHistoricalAdherenceQuery"}}],"responses":{"202":{"description":"Processing request","schema":{"$ref":"#/definitions/WfmHistoricalAdherenceResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.only.authorized.for.team.access":"You are only authorized to call this route for specific teams","wfm.too.many.teams.requested":"You may only request up to 10 teams in a single request","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","wfm.requested.teams.and.users":"You may only either teams or users, not both","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","wfm.missing.team.permissions":"You must have access to the requested teams"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.too.many.requests":"Too many requests in a given amount of time","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:historicalAdherence:view"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitHistoricaladherencequery"}},"/api/v2/outbound/conversations/{conversationId}/dnc":{"post":{"tags":["Outbound"],"summary":"Add phone numbers to a Dialer DNC list.","description":"","operationId":"postOutboundConversationDnc","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","dnc.list.not.found":"The do not call list could not be found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dnc:add"]},"x-purecloud-method-name":"postOutboundConversationDnc"}},"/api/v2/telephony/providers/edges/{edgeId}/lines":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of lines.","description":"","operationId":"getTelephonyProvidersEdgeLines","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeLineEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgeLines"}},"/api/v2/analytics/flows/aggregates/query":{"post":{"tags":["Flows","Analytics"],"summary":"Query for flow aggregates","description":"","operationId":"postAnalyticsFlowsAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/FlowAggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to query for flow aggregates.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:flowAggregate:view"]},"x-purecloud-method-name":"postAnalyticsFlowsAggregatesQuery"}},"/api/v2/analytics/flows/observations/query":{"post":{"tags":["Flows","Analytics"],"summary":"Query for flow observations","description":"","operationId":"postAnalyticsFlowsObservationsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/FlowObservationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowObservationQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:flowObservation:view"]},"x-purecloud-method-name":"postAnalyticsFlowsObservationsQuery"}},"/api/v2/routing/email/domains/{domainName}/routes/{routeId}":{"get":{"tags":["Routing"],"summary":"Get a route","description":"","operationId":"getRoutingEmailDomainRoute","produces":["application/json"],"parameters":[{"name":"domainName","in":"path","description":"email domain","required":true,"type":"string"},{"name":"routeId","in":"path","description":"route ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundRoute"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"getRoutingEmailDomainRoute"},"put":{"tags":["Routing"],"summary":"Update a route","description":"","operationId":"putRoutingEmailDomainRoute","produces":["application/json"],"parameters":[{"name":"domainName","in":"path","description":"email domain","required":true,"type":"string"},{"name":"routeId","in":"path","description":"route ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Route","required":true,"schema":{"$ref":"#/definitions/InboundRoute"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundRoute"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.bad.address":"Invalid email address. Check for invalid control or whitespace characters.","reply.route.id.required":"A route ID is required for the reply email address.","postino.max.autobcc.exceeded":"The maximum number of automatic bcc email addresses for the route has been exceeded.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","postino.invalid.route":"The 'queue' and 'pattern' fields are required.","bad.flow.id":"The flow is not eligible for use here.","postino.error.queue.required":"A queue id or flow id is required.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"putRoutingEmailDomainRoute"},"delete":{"tags":["Routing"],"summary":"Delete a route","description":"","operationId":"deleteRoutingEmailDomainRoute","produces":["application/json"],"parameters":[{"name":"domainName","in":"path","description":"email domain","required":true,"type":"string"},{"name":"routeId","in":"path","description":"route ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.request.timeout":"The inbound route delete request timed out.","postino.error.not.found":"The resource could not be found.","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.route.conflict":"The inbound route is a reply route in one or more other inbound routes."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"deleteRoutingEmailDomainRoute"}},"/api/v2/integrations/speech/tts/engines/{engineId}":{"get":{"tags":["Integrations"],"summary":"Get details about a TTS engine","description":"","operationId":"getIntegrationsSpeechTtsEngine","produces":["application/json"],"parameters":[{"name":"engineId","in":"path","description":"The engine ID","required":true,"type":"string"},{"name":"includeVoices","in":"query","description":"Include voices for the engine","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TtsEngineEntity"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechTtsEngine"}},"/api/v2/quality/forms/surveys/{formId}/versions":{"get":{"tags":["Quality"],"summary":"Gets all the revisions for a specific survey.","description":"","operationId":"getQualityFormsSurveyVersions","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SurveyFormEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["quality:surveyForm:view"]},"x-purecloud-method-name":"getQualityFormsSurveyVersions"}},"/api/v2/outbound/campaignrules":{"get":{"tags":["Outbound"],"summary":"Query Campaign Rule list","description":"","operationId":"getOutboundCampaignrules","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"allowEmptyResult","in":"query","description":"Whether to return an empty page when there are no results for that page","required":false,"type":"boolean","default":false},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"],"x-genesys-enum-members":[{"name":"Equals"},{"name":"RegEx"},{"name":"Contains"},{"name":"Prefix"},{"name":"LessThan"},{"name":"LessThanEqualTo"},{"name":"GreaterThan"},{"name":"GreaterThanEqualTo"},{"name":"BeginsWith"},{"name":"EndsWith"}]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignRuleEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaignRule:view"]},"x-purecloud-method-name":"getOutboundCampaignrules"},"post":{"tags":["Outbound"],"summary":"Create Campaign Rule","description":"","operationId":"postOutboundCampaignrules","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"CampaignRule","required":true,"schema":{"$ref":"#/definitions/CampaignRule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"name.cannot.be.blank":"A name must be provided.","cannot.create.enabled.campaign.rule":"Cannot create a rule that is enabled.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","missing.campaign.rule.conditions":"Campaign rule must have a condition.","invalid.campaign.rule.action.parameter":"Campaign rule action has an invalid parameter.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","missing.campaign.rule.condition.value":"Campaign rule condition must have an value.","missing.campaign.rule.entity":"Campaign rule must have an entity for conditions.","missing.campaign.rule.action.parameters":"Campaign rule action must have a parameter.","invalid.campaign.rule.condition.parameter":"Campaign rule condition has an invalid parameter.","missing.campaign.rule.condition.type":"Campaign rule condition must have a type.","invalid.campaign.rule.condition.value":"Campaign rule condition has an invalid value.","invalid.turn.on.campaign.action":"Campaign rule action cannot turn on a campaign/sequence based on that campaign/sequence's progress or agent count.","missing.campaign.rule.actions":"Campaign rule must have an action.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","missing.campaign.rule.action.entity":"At least one rule action entity is required.","incorrect.max.value":"Max values must be > 0 and one of them must be defined","invalid.campaign.rule.condition.operator":"Campaign rule condition has an invalid operator.","missing.campaign.rule.condition.parameters":"Campaign rule condition must have a parameter.","max.entity.count.reached":"The maximum campaign rule count has been reached.","missing.campaign.rule.action.type":"Campaign rule action must have a type.","invalid.external.campaign.dialingmode.transition":"Cannot change to/from external dialing mode to/from another dialing mode.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.dialing.mode.update":"Invalid dialing mode specified.","missing.campaign.rule.condition.operator":"Campaign rule condition must have an operator."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaignRule:add"]},"x-purecloud-method-name":"postOutboundCampaignrules"}},"/api/v2/authorization/divisions":{"get":{"tags":["Authorization","Objects"],"summary":"Retrieve a list of all divisions defined for the organization","description":"Request specific divisions by id using a query param \"id\", e.g. \n?id=5f777167-63be-4c24-ad41-374155d9e28b&id=72e9fb25-c484-488d-9312-7acba82435b3","operationId":"getAuthorizationDivisions","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"objectCount","in":"query","description":"Include the count of objects contained in the division","required":false,"type":"boolean","default":false},{"name":"id","in":"query","description":"Optionally request specific divisions by their IDs","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Search term to filter by division name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuthzDivisionEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-purecloud-method-name":"getAuthorizationDivisions"},"post":{"tags":["Authorization","Objects"],"summary":"Create a division.","description":"","operationId":"postAuthorizationDivisions","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Division","required":true,"schema":{"$ref":"#/definitions/AuthzDivision"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuthzDivision"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"max.length.exceeded":"One or more attributes is longer than the maximum length allowed.","max.scopes.exceeded":"Too many divisions for organization.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"resource.already.exists":"A resource with that name already exists."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["authorization:division:add","authorization:grant:add"]},"x-purecloud-method-name":"postAuthorizationDivisions"}},"/api/v2/conversations/{conversationId}/recordings/{recordingId}":{"get":{"tags":["Recording"],"summary":"Gets a specific recording.","description":"","operationId":"getConversationRecording","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"recordingId","in":"path","description":"Recording ID","required":true,"type":"string"},{"name":"formatId","in":"query","description":"The desired media format.","required":false,"type":"string","default":"WEBM","enum":["WAV","WEBM","WAV_ULAW","OGG_VORBIS","OGG_OPUS","MP3","NONE"],"x-genesys-enum-members":[{"name":"WAV"},{"name":"WEBM"},{"name":"WAV_ULAW"},{"name":"OGG_VORBIS"},{"name":"OGG_OPUS"},{"name":"MP3"},{"name":"NONE"}]},{"name":"emailFormatId","in":"query","description":"The desired media format when downloading an email recording.","required":false,"type":"string","default":"EML","enum":["EML","NONE"],"x-genesys-enum-members":[{"name":"EML"},{"name":"NONE"}]},{"name":"chatFormatId","in":"query","description":"The desired media format when downloading a chat recording.","required":false,"type":"string","default":"ZIP","enum":["ZIP","NONE"],"x-genesys-enum-members":[{"name":"ZIP"},{"name":"NONE"}]},{"name":"messageFormatId","in":"query","description":"The desired media format when downloading a message recording.","required":false,"type":"string","default":"ZIP","enum":["ZIP","NONE"],"x-genesys-enum-members":[{"name":"ZIP"},{"name":"NONE"}]},{"name":"download","in":"query","description":"requesting a download format of the recording","required":false,"type":"boolean","default":false,"enum":["true","false"],"x-genesys-enum-members":[{"name":"true"},{"name":"false"}]},{"name":"fileName","in":"query","description":"the name of the downloaded fileName","required":false,"type":"string"},{"name":"locale","in":"query","description":"The locale for the requested file when downloading, as an ISO 639-1 code","required":false,"type":"string"}],"responses":{"202":{"description":"Success - recording is transcoding","schema":{"$ref":"#/definitions/Recording"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"quality.query.invalid.conversation":"The conversation query was invalid.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.recording.view.permission.check.failed":"Failed to verify recording view permission.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:recording:view"]},"x-purecloud-method-name":"getConversationRecording"},"put":{"tags":["Recording"],"summary":"Updates the retention records on a recording.","description":"Currently supports updating and removing both archive and delete dates for eligible recordings. A request to change the archival date of an archived recording will result in a restoration of the recording until the new date set. The recording:recording:view permission is required for the recording, as well as either the recording:recording:editRetention or recording:screenRecording:editRetention permissions depending on the type of recording.","operationId":"putConversationRecording","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"recordingId","in":"path","description":"Recording ID","required":true,"type":"string"},{"in":"body","name":"body","description":"recording","required":true,"schema":{"$ref":"#/definitions/Recording"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Recording"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","recording.not.archivable":"Recording has been deleted or is still uploading","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","recording.invalid.json":"Recording request contains invalid JSON","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","recording.recording.edit.retention.permission.check.failed":"Failed to verify recording edit retention permission.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","recording.recording.restore.permission.check.failed":"improper permissions found when attempting to restore recordings"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.not.archivable":"Recording is not achievable","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:recording:view","recording:recording:editRetention","recording:screenRecording:editRetention"]},"x-purecloud-method-name":"putConversationRecording"}},"/api/v2/journey/outcomes":{"get":{"tags":["Journey"],"summary":"Retrieve all outcomes.","description":"","operationId":"getJourneyOutcomes","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Field(s) to sort by. The response can be sorted by any first level property on the Outcome response. Prefix with '-' for descending (e.g. sortBy=displayName,-createdDate).","required":false,"type":"string"},{"name":"outcomeIds","in":"query","description":"IDs of outcomes to return. Use of this parameter is not compatible with pagination or sorting. A maximum of 20 outcomes are allowed per request.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutcomeListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:outcome:view"]},"x-purecloud-method-name":"getJourneyOutcomes"},"post":{"tags":["Journey"],"summary":"Create an outcome.","description":"","operationId":"postJourneyOutcomes","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/Outcome"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Outcome"}},"201":{"description":"Outcome created.","schema":{"$ref":"#/definitions/Outcome"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["journey"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["journey:outcome:add"]},"x-purecloud-method-name":"postJourneyOutcomes"}},"/api/v2/integrations/clientapps":{"get":{"tags":["Integrations"],"summary":"List permitted client app integrations for the logged in user","description":"","operationId":"getIntegrationsClientapps","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ClientAppEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-purecloud-method-name":"getIntegrationsClientapps"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/categories/{categoryId}":{"get":{"tags":["Knowledge"],"summary":"Get category","description":"","operationId":"getKnowledgeKnowledgebaseLanguageCategory","produces":["application/json"],"parameters":[{"name":"categoryId","in":"path","description":"Category ID","required":true,"type":"string"},{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","de-DE"],"x-genesys-enum-members":[{"name":"en-US"},{"name":"de-DE"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeExtendedCategory"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","parent.category.not.found":"Parent category does not exist","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","input.validations":"Input parameters do not match the required criteria","kb.not.found":"Knowledge Base does not exist","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"404":"Resource not found","category.not.found":"Category does not exist","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:category:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseLanguageCategory"},"delete":{"tags":["Knowledge"],"summary":"Delete category","description":"","operationId":"deleteKnowledgeKnowledgebaseLanguageCategory","produces":["application/json"],"parameters":[{"name":"categoryId","in":"path","description":"Category ID","required":true,"type":"string"},{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","de-DE"],"x-genesys-enum-members":[{"name":"en-US"},{"name":"de-DE"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeCategory"}},"204":{"description":"Category deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","parent.category.not.found":"Parent category does not exist","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","input.validations":"Input parameters do not match the required criteria","kb.not.found":"Knowledge Base does not exist"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"404":"Resource not found","category.not.found":"Category does not exist","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:category:delete"]},"x-purecloud-method-name":"deleteKnowledgeKnowledgebaseLanguageCategory"},"patch":{"tags":["Knowledge"],"summary":"Update category","description":"","operationId":"patchKnowledgeKnowledgebaseLanguageCategory","produces":["application/json"],"parameters":[{"name":"categoryId","in":"path","description":"Category ID","required":true,"type":"string"},{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","de-DE"],"x-genesys-enum-members":[{"name":"en-US"},{"name":"de-DE"}]},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeCategoryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeExtendedCategory"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","parent.category.not.found":"Parent category does not exist","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","input.validations":"Input parameters do not match the required criteria","kb.not.found":"Knowledge Base does not exist","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"category.not.found":"Category does not exist","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:category:edit"]},"x-purecloud-method-name":"patchKnowledgeKnowledgebaseLanguageCategory"}},"/api/v2/groups":{"get":{"tags":["Groups"],"summary":"Get a group list","description":"","operationId":"getGroups","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"jabberId","in":"query","description":"A list of jabberIds to fetch by bulk (cannot be used with the \"id\" parameter)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ASC","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GroupEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups","groups:readonly"]}],"x-purecloud-method-name":"getGroups"},"post":{"tags":["Groups"],"summary":"Create a group","description":"","operationId":"postGroups","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Group","required":true,"schema":{"$ref":"#/definitions/GroupCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Group"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:group:add"]},"x-purecloud-method-name":"postGroups"}},"/api/v2/integrations/actions":{"get":{"tags":["Integrations"],"summary":"Retrieves all actions associated with filters passed in via query param.","description":"","operationId":"getIntegrationsActions","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Root level field name to sort on.","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Direction to sort 'sortBy' field.","required":false,"type":"string","default":"asc","enum":["ASC","DESC"],"x-genesys-enum-members":[{"name":"ASC"},{"name":"DESC"}]},{"name":"category","in":"query","description":"Filter by category name","required":false,"type":"string"},{"name":"name","in":"query","description":"Filter by action name. Provide full or just the first part of name.","required":false,"type":"string"},{"name":"secure","in":"query","description":"Filter to only include secure actions. True will only include actions marked secured. False will include only unsecure actions. Do not use filter if you want all Actions.","required":false,"type":"string","enum":["true","false"],"x-genesys-enum-members":[{"name":"true"},{"name":"false"}]},{"name":"includeAuthActions","in":"query","description":"Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions.","required":false,"type":"string","default":"false","enum":["true","false"],"x-genesys-enum-members":[{"name":"true"},{"name":"false"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:view","bridge:actions:view"]},"x-purecloud-method-name":"getIntegrationsActions"},"post":{"tags":["Integrations"],"summary":"Create a new Action","description":"","operationId":"postIntegrationsActions","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Input used to create Action.","required":true,"schema":{"$ref":"#/definitions/PostActionInput"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Action"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.schema":"There is an error preventing a file from being read","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:add"]},"x-purecloud-method-name":"postIntegrationsActions"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/managementunits":{"get":{"tags":["Workforce Management"],"summary":"Get all authorized management units in the business unit","description":"","operationId":"getWorkforcemanagementBusinessunitManagementunits","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit, or 'mine' for the business unit of the logged-in user.","required":true,"type":"string"},{"name":"feature","in":"query","required":false,"type":"string","enum":["AgentSchedule","AgentTimeOffRequest","Coaching","ActivityCodes","Agents","BuActivityCodes","BusinessUnits","HistoricalAdherence","IntradayMonitoring","BuIntradayMonitoring","ManagementUnits","RealTimeAdherence","Schedules","BuSchedules","ServiceGoalTemplates","PlanningGroups","ShiftTrading","ShortTermForecasts","BuShortTermForecasts","TimeOffRequests","WorkPlanRotations","WorkPlans"],"x-genesys-enum-members":[{"name":"AgentSchedule"},{"name":"AgentTimeOffRequest"},{"name":"Coaching"},{"name":"ActivityCodes"},{"name":"Agents"},{"name":"BuActivityCodes"},{"name":"BusinessUnits"},{"name":"HistoricalAdherence"},{"name":"IntradayMonitoring"},{"name":"BuIntradayMonitoring"},{"name":"ManagementUnits"},{"name":"RealTimeAdherence"},{"name":"Schedules"},{"name":"BuSchedules"},{"name":"ServiceGoalTemplates"},{"name":"PlanningGroups"},{"name":"ShiftTrading"},{"name":"ShortTermForecasts"},{"name":"BuShortTermForecasts"},{"name":"TimeOffRequests"},{"name":"WorkPlanRotations"},{"name":"WorkPlans"}]},{"name":"divisionId","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ManagementUnitListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.server.error":"WFM Server Error","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-purecloud-method-name":"getWorkforcemanagementBusinessunitManagementunits"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}":{"get":{"tags":["Workforce Management"],"summary":"Get business unit","description":"Expanding \"settings\" will retrieve all settings. All other expands will retrieve only the requested settings field(s).","operationId":"getWorkforcemanagementBusinessunit","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit, or 'mine' for the business unit of the logged-in user.","required":true,"type":"string"},{"name":"expand","in":"query","required":false,"type":"array","items":{"type":"string","enum":["settings","settings.timeZone","settings.startDayOfWeek","settings.shortTermForecasting"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"settings"},{"name":"settings.timeZone"},{"name":"settings.startDayOfWeek"},{"name":"settings.shortTermForecasting"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BusinessUnit"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:activityCode:add","wfm:activityCode:delete","wfm:activityCode:edit","wfm:activityCode:view","wfm:agent:edit","wfm:agentSchedule:view","wfm:agentTimeOffRequest:submit","wfm:agent:view","wfm:businessUnit:add","wfm:businessUnit:delete","wfm:businessUnit:edit","wfm:businessUnit:view","wfm:historicalAdherence:view","wfm:intraday:view","wfm:managementUnit:add","wfm:managementUnit:delete","wfm:managementUnit:edit","wfm:managementUnit:view","wfm:publishedSchedule:view","wfm:realtimeAdherence:view","wfm:schedule:add","wfm:schedule:delete","wfm:schedule:edit","wfm:schedule:generate","wfm:schedule:view","wfm:serviceGoalTemplate:add","wfm:serviceGoalTemplate:delete","wfm:serviceGoalTemplate:edit","wfm:serviceGoalTemplate:view","wfm:planningGroup:add","wfm:planningGroup:delete","wfm:planningGroup:edit","wfm:planningGroup:view","wfm:shiftTradeRequest:edit","wfm:shiftTradeRequest:view","wfm:agentShiftTradeRequest:participate","wfm:shortTermForecast:add","wfm:shortTermForecast:delete","wfm:shortTermForecast:edit","wfm:shortTermForecast:view","wfm:timeOffRequest:add","wfm:timeOffRequest:edit","wfm:timeOffRequest:view","wfm:workPlan:add","wfm:workPlan:delete","wfm:workPlan:edit","wfm:workPlan:view","wfm:workPlanRotation:add","wfm:workPlanRotation:delete","wfm:workPlanRotation:edit","wfm:workPlanRotation:view","coaching:appointment:add","coaching:appointment:edit"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunit"},"delete":{"tags":["Workforce Management"],"summary":"Delete business unit","description":"A business unit cannot be deleted if it contains one or more management units","operationId":"deleteWorkforcemanagementBusinessunit","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit, or 'mine' for the business unit of the logged-in user.","required":true,"type":"string"}],"responses":{"204":{"description":"The business unit was successfully deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.server.error":"WFM Server Error","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:businessUnit:delete"]},"x-purecloud-method-name":"deleteWorkforcemanagementBusinessunit"},"patch":{"tags":["Workforce Management"],"summary":"Update business unit","description":"","operationId":"patchWorkforcemanagementBusinessunit","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit, or 'mine' for the business unit of the logged-in user.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/UpdateBusinessUnitRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BusinessUnit"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","wfm.business.unit.not.found":"Business unit not found","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Entity was modified by another request"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:businessUnit:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementBusinessunit"}},"/api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/query":{"post":{"tags":["Content Management"],"summary":"Perform a prefix query on tags in the workspace","description":"","operationId":"postContentmanagementWorkspaceTagvaluesQuery","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/TagQueryRequest"}},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["acl"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"acl"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TagValueEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"postContentmanagementWorkspaceTagvaluesQuery"}},"/api/v2/telephony/providers/edges/dids":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a listing of DIDs","description":"","operationId":"getTelephonyProvidersEdgesDids","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"number"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"phoneNumber","in":"query","description":"Filter by phoneNumber","required":false,"type":"string"},{"name":"owner.id","in":"query","description":"Filter by the owner of a phone number","required":false,"type":"string"},{"name":"didPool.id","in":"query","description":"Filter by the DID Pool assignment","required":false,"type":"string"},{"name":"id","in":"query","description":"Filter by a specific list of ID's","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DIDEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"Request Timeout","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unknown":"Unspecified error getting DID listings."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.rate.limit":"Request rate limit exceeded.","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesDids"}},"/api/v2/quality/keywordsets":{"get":{"tags":["Quality"],"summary":"Get the list of keyword sets","description":"","operationId":"getQualityKeywordsets","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"name","in":"query","description":"the keyword set name - used for filtering results in searches.","required":false,"type":"string"},{"name":"queueId","in":"query","description":"the queue id - used for filtering results in searches.","required":false,"type":"string"},{"name":"agentId","in":"query","description":"the agent id - used for filtering results in searches.","required":false,"type":"string"},{"name":"operator","in":"query","description":"If agentID and queueId are both present, this determines whether the query is an AND or OR between those parameters.","required":false,"type":"string","enum":["AND","OR"],"x-genesys-enum-members":[{"name":"AND"},{"name":"OR"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KeywordSetEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:keywordset:view"]},"x-purecloud-method-name":"getQualityKeywordsets"},"post":{"tags":["Quality"],"summary":"Create a Keyword Set","description":"","operationId":"postQualityKeywordsets","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"keywordSet","required":true,"schema":{"$ref":"#/definitions/KeywordSet"}},{"name":"expand","in":"query","description":"queueId","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KeywordSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"qm.keyword.set.invalid.agent":"One of the agentIds is invalid","quality.keyword.limit.exceeded.for.agent":"Keyword Set keyword limit exceeded for agent","bad.request":"The request could not be understood by the server due to malformed syntax.","qm.keyword.set.invalid.queue":"One of the queueIds is invalid","qm.keyword.set.invalid.language":"Invalid language","quality.keyword.duplicate.phrase":"A Keyword phrase cannot be duplicated in keywords, anti-words or alternate spellings","quality.keyword.limit.exceeded.for.agent.and.queue":"Keyword Set keyword limit exceeded for agent and queue","quality.keyword.limit.exceeded":"Keyword Set keyword limit exceeded","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","quality.keyword.limit.exceeded.for.queue":"Keyword Set keyword limit exceeded for queue","qm.keyword.set.agent.or.queue.required":"A queue or agent is required for a valid Keyword Set","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:keywordset:add"]},"x-purecloud-method-name":"postQualityKeywordsets"},"delete":{"tags":["Quality"],"summary":"Delete keyword sets","description":"Bulk delete of keyword sets; this will only delete the keyword sets that match the ids specified in the query param.","operationId":"deleteQualityKeywordsets","produces":["application/json"],"parameters":[{"name":"ids","in":"query","description":"A comma-delimited list of valid KeywordSet ids","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:keywordset:delete"]},"x-purecloud-method-name":"deleteQualityKeywordsets"}},"/api/v2/voicemail/messages":{"get":{"tags":["Voicemail"],"summary":"List voicemail messages","description":"","operationId":"getVoicemailMessages","produces":["application/json"],"parameters":[{"name":"ids","in":"query","description":"An optional comma separated list of VoicemailMessage ids","required":false,"type":"string"},{"name":"expand","in":"query","description":"If the caller is a known user, which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["callerUser.routingStatus","callerUser.primaryPresence","callerUser.conversationSummary","callerUser.outOfOffice","callerUser.geolocation"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"callerUser.routingStatus"},{"name":"callerUser.primaryPresence"},{"name":"callerUser.conversationSummary"},{"name":"callerUser.outOfOffice"},{"name":"callerUser.geolocation"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMessageEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","voicemail.not.authorized.voicemail.message":"You are not authorized to access a voicemail message.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail","voicemail:readonly"]}],"x-purecloud-method-name":"getVoicemailMessages"},"post":{"tags":["Voicemail"],"summary":"Copy a voicemail message to a user or group","description":"","operationId":"postVoicemailMessages","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/CopyVoicemailMessage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/VoicemailMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","voicemail.copy.missing.voicemail.message.id":"The request requires a voicemailMessageId","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","voicemail.copy.missing.target":"The request requires a userId or groupId","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","voicemail.not.authorized.voicemail.message":"You are not authorized to access the voicemail message.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"voicemail.copy.group.does.not.have.voicemail.enabled":"Cannot copy the voicemail to the group because they do not have voicemail enabled","voicemail.copy.user.does.not.have.voicemail.enabled":"Cannot copy the voicemail to the user because they do not have voicemail enabled"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail"]}],"x-purecloud-method-name":"postVoicemailMessages"},"delete":{"tags":["Voicemail"],"summary":"Delete all voicemail messages","description":"","operationId":"deleteVoicemailMessages","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["voicemail"]}],"x-purecloud-method-name":"deleteVoicemailMessages"}},"/api/v2/telephony/providers/edges/{edgeId}/metrics":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the edge metrics.","description":"","operationId":"getTelephonyProvidersEdgeMetrics","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeMetrics"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find edge metrics by given id.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgeMetrics"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents":{"get":{"tags":["Knowledge"],"summary":"Get documents","description":"","operationId":"getKnowledgeKnowledgebaseLanguageDocuments","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","de-DE"],"x-genesys-enum-members":[{"name":"en-US"},{"name":"de-DE"}]},{"name":"before","in":"query","description":"The cursor that points to the start of the set of entities that has been returned.","required":false,"type":"string"},{"name":"after","in":"query","description":"The cursor that points to the end of the set of entities that has been returned.","required":false,"type":"string"},{"name":"limit","in":"query","description":"Number of entities to return. Maximum of 200. Deprecated in favour of pageSize.","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Number of entities to return. Maximum of 200.","required":false,"type":"string"},{"name":"categories","in":"query","description":"Filter by categories ids, comma separated values expected.","required":false,"type":"string"},{"name":"title","in":"query","description":"Filter by document title.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","input.validations":"Input parameters do not match the required criteria","kb.not.found":"Knowledge Base does not exist","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseLanguageDocuments"},"post":{"tags":["Knowledge"],"summary":"Create document","description":"","operationId":"postKnowledgeKnowledgebaseLanguageDocuments","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","de-DE"],"x-genesys-enum-members":[{"name":"en-US"},{"name":"de-DE"}]},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeDocumentRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocument"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","document.limitexceeded":"Document count exceeded for kbId","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","input.validations":"Input parameters do not match the required criteria","kb.not.found":"Knowledge Base does not exist","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseLanguageDocuments"},"patch":{"tags":["Knowledge"],"summary":"Update documents collection","description":"","operationId":"patchKnowledgeKnowledgebaseLanguageDocuments","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","de-DE"],"x-genesys-enum-members":[{"name":"en-US"},{"name":"de-DE"}]},{"in":"body","name":"body","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/KnowledgeDocumentBulkRequest"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","input.validations":"Input parameters do not match the required criteria","kb.not.found":"Knowledge Base does not exist","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","document.not.found":"Document does not exist"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"500":"Internal server error","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:document:edit"]},"x-purecloud-method-name":"patchKnowledgeKnowledgebaseLanguageDocuments"}},"/api/v2/telephony/providers/edges/sites/{siteId}/numberplans/{numberPlanId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Number Plan by ID.","description":"","operationId":"getTelephonyProvidersEdgesSiteNumberplan","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"name":"numberPlanId","in":"path","description":"Number Plan ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NumberPlan"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Unable to find a number plan with that id","general.resource.not.found":"Unable to find a number plan with that id","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesSiteNumberplan"}},"/api/v2/flows/executions":{"post":{"tags":["Architect"],"summary":"Launch an instance of a flow definition, for flow types that support it such as the 'workflow' type.","description":"The launch is asynchronous, it returns as soon as the flow starts. You can use the returned ID to query its status if you need.","operationId":"postFlowsExecutions","produces":["application/json"],"parameters":[{"in":"body","name":"flowLaunchRequest","required":true,"schema":{"$ref":"#/definitions/FlowExecutionLaunchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowExecutionLaunchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","architect.object.validate.failed":"Failed to validate object.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.flow.not.found":"Could not find flow with specified ID."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.unspecified.error":"An unknown error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:launch"]},"x-purecloud-method-name":"postFlowsExecutions"}},"/api/v2/integrations/userapps":{"get":{"tags":["Integrations"],"summary":"List permitted user app integrations for the logged in user","description":"","operationId":"getIntegrationsUserapps","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"appHost","in":"query","description":"The type of UserApp to filter by","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserAppEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-purecloud-method-name":"getIntegrationsUserapps"}},"/api/v2/orgauthorization/trustor/audits":{"post":{"tags":["Organization Authorization"],"summary":"Get Org Trustor Audits","description":"","operationId":"postOrgauthorizationTrustorAudits","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"timestamp"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"descending"},{"in":"body","name":"body","description":"Values to scope the request.","required":true,"schema":{"$ref":"#/definitions/TrustorAuditQueryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuditQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:audit:view"]},"x-purecloud-method-name":"postOrgauthorizationTrustorAudits"}},"/api/v2/orgauthorization/trustors/{trustorOrgId}":{"get":{"tags":["Organization Authorization"],"summary":"Get Org Trust","description":"","operationId":"getOrgauthorizationTrustor","produces":["application/json"],"parameters":[{"name":"trustorOrgId","in":"path","description":"Trustor Organization Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Trustor"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrustor:view"]},"x-purecloud-method-name":"getOrgauthorizationTrustor"},"delete":{"tags":["Organization Authorization"],"summary":"Delete Org Trust","description":"","operationId":"deleteOrgauthorizationTrustor","produces":["application/json"],"parameters":[{"name":"trustorOrgId","in":"path","description":"Trustor Organization Id","required":true,"type":"string"}],"responses":{"204":{"description":"Trust deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrustor:delete"]},"x-purecloud-method-name":"deleteOrgauthorizationTrustor"}},"/api/v2/workforcemanagement/shifttrades":{"get":{"tags":["Workforce Management"],"summary":"Gets all of my shift trades","description":"","operationId":"getWorkforcemanagementShifttrades","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ShiftTradeListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:shiftTradeRequest:edit","wfm:shiftTradeRequest:view","wfm:agentShiftTradeRequest:participate"]},"x-purecloud-method-name":"getWorkforcemanagementShifttrades"}},"/api/v2/telephony/providers/edges/{edgeId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get edge.","description":"","operationId":"getTelephonyProvidersEdge","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Fields to expand in the response, comma-separated","required":false,"type":"array","items":{"type":"string","enum":["site"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"site"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Edge"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Edge was not found.","general.resource.not.found":"Edge was not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdge"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a edge.","description":"","operationId":"putTelephonyProvidersEdge","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Edge","required":true,"schema":{"$ref":"#/definitions/Edge"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Edge"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"cant.modify.edge.group":"Edge group cannot be modified when edge is in service.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","site.required":"The site field is missing a value.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","edge.group.required":"The edge group field is missing a value.","incorrect.fingerprint":"The provided edge fingerprint was not correct.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","fingerprint.too.early":"Fingerprint sent before awaiting fingerprint verification"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"editing.managed.property.not.allowed":"Editing managed properties is not allowed.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","managed.property.not.allowed":"Not allowed to modify a managed edge."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be completed by the server due to a conflict."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdge"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a edge.","description":"","operationId":"deleteTelephonyProvidersEdge","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Edge was not found.","general.resource.not.found":"Edge was not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdge"}},"/api/v2/organizations/features/{featureName}":{"patch":{"tags":["Organization"],"summary":"Update organization","description":"","operationId":"patchOrganizationsFeature","produces":["application/json"],"parameters":[{"name":"featureName","in":"path","description":"Organization feature","required":true,"type":"string","enum":["realtimeCIC","purecloud","hipaa","ucEnabled","pci","purecloudVoice","xmppFederation","chat","informalPhotos","directory","contactCenter","unifiedCommunications","custserv"],"x-genesys-enum-members":[{"name":"realtimeCIC"},{"name":"purecloud"},{"name":"hipaa"},{"name":"ucEnabled"},{"name":"pci"},{"name":"purecloudVoice"},{"name":"xmppFederation"},{"name":"chat"},{"name":"informalPhotos"},{"name":"directory"},{"name":"contactCenter"},{"name":"unifiedCommunications"},{"name":"custserv"}]},{"in":"body","name":"enabled","description":"New state of feature","required":true,"schema":{"$ref":"#/definitions/FeatureState"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationFeatures"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:organization:admin"]},"x-purecloud-method-name":"patchOrganizationsFeature"}},"/api/v2/stations":{"get":{"tags":["Stations"],"summary":"Get the list of available stations.","description":"","operationId":"getStations","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"userSelectable","in":"query","description":"True for stations that the user can select otherwise false","required":false,"type":"string"},{"name":"webRtcUserId","in":"query","description":"Filter for the webRtc station of the webRtcUserId","required":false,"type":"string"},{"name":"id","in":"query","description":"Comma separated list of stationIds","required":false,"type":"string"},{"name":"lineAppearanceId","in":"query","description":"lineAppearanceId","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/StationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.organization.type":"Collaborate organizations do not have permission to work with stations","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"Request is badly formed.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"Request Timeout","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unknown":"Unspecified error getting station listing."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.rate.limit":"Request rate limit exceeded.","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.internal.server.error":"Internal server error getting station listing.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["stations","stations:readonly"]}],"x-purecloud-method-name":"getStations"}},"/api/v2/locations/search":{"get":{"tags":["Search","Locations"],"summary":"Search locations using the q64 value returned from a previous search","description":"","operationId":"getLocationsSearch","produces":["application/json"],"parameters":[{"name":"q64","in":"query","description":"q64","required":true,"type":"string"},{"name":"expand","in":"query","description":"Provides more details about a specified resource","required":false,"type":"array","items":{"type":"string","enum":["images","addressVerificationDetails"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"images"},{"name":"addressVerificationDetails"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LocationsSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["locations","locations:readonly","search:readonly"]}],"x-purecloud-method-name":"getLocationsSearch"},"post":{"tags":["Search","Locations"],"summary":"Search locations","description":"","operationId":"postLocationsSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/LocationSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LocationsSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["locations","locations:readonly","search:readonly"]}],"x-purecloud-method-name":"postLocationsSearch"}},"/api/v2/recording/localkeys":{"post":{"tags":["Recording"],"summary":"create a local recording key","description":"","operationId":"postRecordingLocalkeys","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Local Encryption body","required":true,"schema":{"$ref":"#/definitions/LocalEncryptionKeyRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EncryptionKey"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:encryptionKey:edit"]},"x-purecloud-method-name":"postRecordingLocalkeys"}},"/api/v2/architect/ivrs/{ivrId}":{"get":{"tags":["Architect"],"summary":"Get an IVR config.","description":"","operationId":"getArchitectIvr","produces":["application/json"],"parameters":[{"name":"ivrId","in":"path","description":"IVR id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IVR"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:callRoute:view"]},"x-purecloud-method-name":"getArchitectIvr"},"put":{"tags":["Architect"],"summary":"Update an IVR Config.","description":"","operationId":"putArchitectIvr","produces":["application/json"],"parameters":[{"name":"ivrId","in":"path","description":"IVR id","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/IVR"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IVR"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:callRoute:edit"]},"x-purecloud-method-name":"putArchitectIvr"},"delete":{"tags":["Architect"],"summary":"Delete an IVR Config.","description":"","operationId":"deleteArchitectIvr","produces":["application/json"],"parameters":[{"name":"ivrId","in":"path","description":"IVR id","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Could not find the IVR config supplied","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"Conflict occurred while deleting an IVR Config."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:callRoute:delete"]},"x-purecloud-method-name":"deleteArchitectIvr"}},"/api/v2/webchat/deployments/{deploymentId}":{"get":{"tags":["WebChat"],"summary":"Get a WebChat deployment","description":"","operationId":"getWebchatDeployment","produces":["application/json"],"parameters":[{"name":"deploymentId","in":"path","description":"Deployment Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatDeployment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["web-chat","web-chat:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["webchat:deployment:read"]},"x-purecloud-method-name":"getWebchatDeployment"},"put":{"tags":["WebChat"],"summary":"Update a WebChat deployment","description":"","operationId":"putWebchatDeployment","produces":["application/json"],"parameters":[{"name":"deploymentId","in":"path","description":"Deployment Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Deployment","required":true,"schema":{"$ref":"#/definitions/WebChatDeployment"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatDeployment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["web-chat"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["webchat:deployment:update"]},"x-purecloud-method-name":"putWebchatDeployment"},"delete":{"tags":["WebChat"],"summary":"Delete a WebChat deployment","description":"","operationId":"deleteWebchatDeployment","produces":["application/json"],"parameters":[{"name":"deploymentId","in":"path","description":"Deployment Id","required":true,"type":"string"}],"responses":{"204":{"description":"Deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["web-chat"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["webchat:deployment:delete"]},"x-purecloud-method-name":"deleteWebchatDeployment"}},"/api/v2/outbound/dnclists/{dncListId}":{"get":{"tags":["Outbound"],"summary":"Get dialer DNC list","description":"","operationId":"getOutboundDnclist","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"},{"name":"includeImportStatus","in":"query","description":"Import status","required":false,"type":"boolean","default":false},{"name":"includeSize","in":"query","description":"Include size","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DncList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.not.found":"The dialer DNC list was not found.","not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dncList:view"]},"x-purecloud-method-name":"getOutboundDnclist"},"put":{"tags":["Outbound"],"summary":"Update dialer DNC list","description":"","operationId":"putOutboundDnclist","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"},{"in":"body","name":"body","description":"DncList","required":true,"schema":{"$ref":"#/definitions/DncList"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DncList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update":"","name.cannot.be.blank":"A name must be provided.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","duplicate.name":"The name already exists.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","dnc.source.authentication.failed":"External dnc source was not able to authenticate.","dnc.list.phone.columns.empty":"","dnc.source.server.error":"External dnc source returned an error condition","dnc.source.configuration.invalid":"The dnc source configuration is invalid","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.wrong.version":""}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dncList:edit"]},"x-purecloud-method-name":"putOutboundDnclist"},"delete":{"tags":["Outbound"],"summary":"Delete dialer DNC list","description":"","operationId":"deleteOutboundDnclist","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.in.use":"The dialer DNC list is in use.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","referential.integrity.error":"Could not delete the resource because it is referenced by another entity."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:dncList:delete"]},"x-purecloud-method-name":"deleteOutboundDnclist"}},"/api/v2/identityproviders/ping":{"get":{"tags":["Identity Provider"],"summary":"Get Ping Identity Provider","description":"","operationId":"getIdentityprovidersPing","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PingIdentity"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersPing"},"put":{"tags":["Identity Provider"],"summary":"Update/Create Ping Identity Provider","description":"","operationId":"putIdentityprovidersPing","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/PingIdentity"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.issuer.uri":"An issuer URI is required.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.target.url":"The target URL must be a valid HTTPS URL.","certificate.not.yet.valid":"The certificate is not yet valid.","certificate.invalid.base64":"Invalid base64 in certificate.","certificate.unparseable":"The certificate for provider cannot be parsed.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersPing"},"delete":{"tags":["Identity Provider"],"summary":"Delete Ping Identity Provider","description":"","operationId":"deleteIdentityprovidersPing","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersPing"}},"/api/v2/greetings/{greetingId}":{"get":{"tags":["Greetings"],"summary":"Get a Greeting with the given GreetingId","description":"","operationId":"getGreeting","produces":["application/json"],"parameters":[{"name":"greetingId","in":"path","description":"Greeting ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Greeting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings","greetings:readonly"]}],"x-purecloud-method-name":"getGreeting"},"put":{"tags":["Greetings"],"summary":"Updates the Greeting with the given GreetingId","description":"","operationId":"putGreeting","produces":["application/json"],"parameters":[{"name":"greetingId","in":"path","description":"Greeting ID","required":true,"type":"string"},{"in":"body","name":"body","description":"The updated Greeting","required":true,"schema":{"$ref":"#/definitions/Greeting"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Greeting"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["greetings"]}],"x-purecloud-method-name":"putGreeting"},"delete":{"tags":["Greetings"],"summary":"Deletes a Greeting with the given GreetingId","description":"","operationId":"deleteGreeting","produces":["application/json"],"parameters":[{"name":"greetingId","in":"path","description":"Greeting ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["greetings"]}],"x-purecloud-method-name":"deleteGreeting"}},"/api/v2/speechandtextanalytics/programs":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get the list of Speech & Text Analytics programs","description":"","operationId":"getSpeechandtextanalyticsPrograms","produces":["application/json"],"parameters":[{"name":"nextPage","in":"query","description":"The key for listing the next page","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"The page size for the listing","required":false,"type":"integer","default":20,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ProgramsEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"page.not.found":"The requested page could not be found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsPrograms"},"post":{"tags":["Speech & Text Analytics"],"summary":"Create new Speech & Text Analytics program","description":"","operationId":"postSpeechandtextanalyticsPrograms","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The program to create","required":true,"schema":{"$ref":"#/definitions/ProgramRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Program"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"tags.limit.exceeded":"20 tags quota exceeded","programs.limit.exceeded":"100 programs quota exceeded","bad.request":"Wrong request structure","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","topic.not.found":"The requested topic could not be found"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conflict":"A program with the same name already exists in this Org"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"resource.unavailable":"Resource unavailable","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:add"]},"x-purecloud-method-name":"postSpeechandtextanalyticsPrograms"}},"/api/v2/telephony/providers/edges/phonebasesettings/availablemetabases":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of available makes and models to create a new Phone Base Settings","description":"","operationId":"getTelephonyProvidersEdgesPhonebasesettingsAvailablemetabases","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhoneMetaBaseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesPhonebasesettingsAvailablemetabases"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/reschedule":{"post":{"tags":["Workforce Management"],"summary":"Start a rescheduling run","description":"","operationId":"postWorkforcemanagementBusinessunitWeekScheduleReschedule","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"scheduleId","in":"path","description":"The ID of the schedule","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/BuRescheduleRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuAsyncScheduleRunResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.missing.one.of.permission.sets":"You must have access to the division of the business unit or all requested management units for the documented permission","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:generate"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitWeekScheduleReschedule"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}":{"get":{"tags":["Workforce Management"],"summary":"Get the metadata for the schedule, describing which management units and agents are in the scheduleSchedule data can then be loaded with the query route","description":"","operationId":"getWorkforcemanagementBusinessunitWeekSchedule","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"scheduleId","in":"path","description":"The ID of the schedule","required":true,"type":"string"},{"name":"expand","in":"query","description":"expand","required":false,"type":"string","enum":["managementUnits.agents"],"x-genesys-enum-members":[{"name":"managementUnits.agents"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuScheduleMetadata"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:view","wfm:publishedSchedule:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWeekSchedule"},"delete":{"tags":["Workforce Management"],"summary":"Delete a schedule","description":"","operationId":"deleteWorkforcemanagementBusinessunitWeekSchedule","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"scheduleId","in":"path","description":"The ID of the schedule","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuAsyncScheduleResponse"}},"202":{"description":"The schedule is being deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:delete"]},"x-purecloud-method-name":"deleteWorkforcemanagementBusinessunitWeekSchedule"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/generationresults":{"get":{"tags":["Workforce Management"],"summary":"Get the generation results for a generated schedule","description":"","operationId":"getWorkforcemanagementBusinessunitWeekScheduleGenerationresults","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"scheduleId","in":"path","description":"The ID of the schedule","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScheduleGenerationResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:view","wfm:publishedSchedule:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWeekScheduleGenerationresults"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules":{"get":{"tags":["Workforce Management"],"summary":"Get the list of week schedules for the specified week","description":"Use \"recent\" for the `weekId` path parameter to fetch all forecasts for +/- 26 weeks from the current date. Response will include any schedule which spans the specified week","operationId":"getWorkforcemanagementBusinessunitWeekSchedules","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format, or 'recent' to get recent schedules","required":true,"type":"string"},{"name":"includeOnlyPublished","in":"query","description":"includeOnlyPublished","required":false,"type":"boolean"},{"name":"expand","in":"query","description":"expand","required":false,"type":"string","enum":["forecast.description"],"x-genesys-enum-members":[{"name":"forecast.description"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuScheduleListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:view","wfm:publishedSchedule:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWeekSchedules"},"post":{"tags":["Workforce Management"],"summary":"Create a blank schedule","description":"","operationId":"postWorkforcemanagementBusinessunitWeekSchedules","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/BuCreateBlankScheduleRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuScheduleMetadata"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"VALIDATION_FAILURE","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitWeekSchedules"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/generate":{"post":{"tags":["Workforce Management"],"summary":"Generate a schedule","description":"","operationId":"postWorkforcemanagementBusinessunitWeekSchedulesGenerate","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/BuGenerateScheduleRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuAsyncScheduleRunResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:generate"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitWeekSchedulesGenerate"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/copy":{"post":{"tags":["Workforce Management"],"summary":"Copy a schedule","description":"","operationId":"postWorkforcemanagementBusinessunitWeekScheduleCopy","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"scheduleId","in":"path","description":"The ID of the schedule to copy","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/BuCopyScheduleRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuAsyncScheduleResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitWeekScheduleCopy"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/headcountforecast":{"get":{"tags":["Workforce Management"],"summary":"Get the headcount forecast by planning group for the schedule","description":"","operationId":"getWorkforcemanagementBusinessunitWeekScheduleHeadcountforecast","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"scheduleId","in":"path","description":"The ID of the schedule","required":true,"type":"string"},{"name":"forceDownload","in":"query","description":"Whether to force the result to come via download url. For testing purposes only","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuHeadcountForecastResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:view","wfm:publishedSchedule:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWeekScheduleHeadcountforecast"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/agentschedules/query":{"post":{"tags":["Workforce Management"],"summary":"Loads agent schedule data from the schedule. Used in combination with the metadata route","description":"","operationId":"postWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQuery","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"scheduleId","in":"path","description":"The ID of the schedule","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/BuQueryAgentSchedulesRequest"}},{"name":"forceAsync","in":"query","description":"Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes","required":false,"type":"boolean"},{"name":"forceDownloadService","in":"query","description":"Force the result of this operation to be sent via download service. For testing/app development purposes","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuAsyncAgentSchedulesQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.too.many.teams.requested":"You may only request up to 10 teams in a single request","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","wfm.requested.teams.and.users":"You may only either teams or users, not both","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.too.many.requests":"Too many requests in a given amount of time","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:view","wfm:publishedSchedule:view"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitWeekScheduleAgentschedulesQuery"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/history/agents/{agentId}":{"get":{"tags":["Workforce Management"],"summary":"Loads agent's schedule history.","description":"","operationId":"getWorkforcemanagementBusinessunitWeekScheduleHistoryAgent","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"weekId","in":"path","description":"First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd","required":true,"type":"string","format":"date"},{"name":"scheduleId","in":"path","description":"The ID of the schedule","required":true,"type":"string"},{"name":"agentId","in":"path","description":"THe ID of the agent","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuAgentScheduleHistoryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","wfm.missing.team.permissions":"You must have access to the requested teams"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.business.unit.not.found":"Business unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:schedule:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWeekScheduleHistoryAgent"}},"/api/v2/profiles/groups":{"get":{"tags":["Groups"],"summary":"Get group profile listing","description":"This api is deprecated. Use /api/v2/groups instead.","operationId":"getProfilesGroups","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortOrder","in":"query","description":"Ascending or descending sort order","required":false,"type":"string","default":"ASC","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GroupProfileEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["groups","groups:readonly"]}],"deprecated":true,"x-purecloud-method-name":"getProfilesGroups"}},"/api/v2/conversations/chats/{conversationId}/messages":{"get":{"tags":["Conversations"],"summary":"Get the messages of a chat conversation.","description":"The current user must be involved with the conversation to get its messages.","operationId":"getConversationsChatMessages","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"after","in":"query","description":"If specified, get the messages chronologically after the id of this message","required":false,"type":"string"},{"name":"before","in":"query","description":"If specified, get the messages chronologically before the id of this message","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ascending","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]},{"name":"maxResults","in":"query","description":"Limit the returned number of messages, up to a maximum of 100","required":false,"type":"integer","default":100,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatMessageEntityList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.not.found":"Chat conversation message is not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsChatMessages"}},"/api/v2/scim/users":{"get":{"tags":["SCIM"],"summary":"Get a list of users","description":"To return all active users, do not use the filter parameter. To return inactive users, set the filter parameter to \"active eq false\". By default, returns SCIM attributes \"externalId\", \"enterprise-user:manager\", and \"roles\". To exclude these attributes, set the attributes parameter to \"id,active\" or the excludeAttributes parameter to \"externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\".","operationId":"getScimUsers","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"name":"startIndex","in":"query","description":"The 1-based index of the first query result.","required":false,"type":"integer","default":1,"format":"int32"},{"name":"count","in":"query","description":"The requested number of items per page. A value of 0 returns \"totalResults\". A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the \"excludedAttributes\" or \"attributes\" query parameters to exclude or only include secondary lookup values such as \"externalId\", \"roles\", \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages\", or \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills\".","required":false,"type":"integer","default":25,"format":"int32"},{"name":"attributes","in":"query","description":"Indicates which attributes to include. Returns these attributes and the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","userName","displayName","title","active","externalId","phoneNumbers","emails","groups","roles","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:User:id","urn:ietf:params:scim:schemas:core:2.0:User:userName","urn:ietf:params:scim:schemas:core:2.0:User:displayName","urn:ietf:params:scim:schemas:core:2.0:User:title","urn:ietf:params:scim:schemas:core:2.0:User:active","urn:ietf:params:scim:schemas:core:2.0:User:externalId","urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers","urn:ietf:params:scim:schemas:core:2.0:User:emails","urn:ietf:params:scim:schemas:core:2.0:User:groups","urn:ietf:params:scim:schemas:core:2.0:User:roles","urn:ietf:params:scim:schemas:core:2.0:User:meta","urn:ietf:params:scim:schemas:core:2.0:User:meta.version","urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"id"},{"name":"userName"},{"name":"displayName"},{"name":"title"},{"name":"active"},{"name":"externalId"},{"name":"phoneNumbers"},{"name":"emails"},{"name":"groups"},{"name":"roles"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:userName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:title"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:active"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:externalId"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:emails"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:groups"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:roles"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"},{"name":"id"},{"name":"userName"},{"name":"displayName"},{"name":"title"},{"name":"active"},{"name":"externalId"},{"name":"phoneNumbers"},{"name":"emails"},{"name":"groups"},{"name":"roles"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:userName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:title"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:active"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:externalId"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:emails"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:groups"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:roles"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"}]},{"name":"excludedAttributes","in":"query","description":"Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","userName","displayName","title","active","externalId","phoneNumbers","emails","groups","roles","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:User:id","urn:ietf:params:scim:schemas:core:2.0:User:userName","urn:ietf:params:scim:schemas:core:2.0:User:displayName","urn:ietf:params:scim:schemas:core:2.0:User:title","urn:ietf:params:scim:schemas:core:2.0:User:active","urn:ietf:params:scim:schemas:core:2.0:User:externalId","urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers","urn:ietf:params:scim:schemas:core:2.0:User:emails","urn:ietf:params:scim:schemas:core:2.0:User:groups","urn:ietf:params:scim:schemas:core:2.0:User:roles","urn:ietf:params:scim:schemas:core:2.0:User:meta","urn:ietf:params:scim:schemas:core:2.0:User:meta.version","urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"id"},{"name":"userName"},{"name":"displayName"},{"name":"title"},{"name":"active"},{"name":"externalId"},{"name":"phoneNumbers"},{"name":"emails"},{"name":"groups"},{"name":"roles"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:userName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:title"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:active"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:externalId"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:emails"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:groups"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:roles"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"},{"name":"id"},{"name":"userName"},{"name":"displayName"},{"name":"title"},{"name":"active"},{"name":"externalId"},{"name":"phoneNumbers"},{"name":"emails"},{"name":"groups"},{"name":"roles"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:userName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:title"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:active"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:externalId"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:emails"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:groups"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:roles"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"}]},{"name":"filter","in":"query","description":"Filters results. If nothing is specified, returns all active users. Examples of valid values: \"id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\", \"userName eq search@sample.org\", \"manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\", \"email eq search@sample.org\", \"division eq divisionName\", \"externalId eq 167844\", \"active eq false\", \"employeeNumber eq 9876543210\".","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimUserListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"An internal server error has occurred."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimUsers"},"post":{"tags":["SCIM"],"summary":"Create a user","description":"","operationId":"postScimUsers","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"in":"body","name":"body","description":"The information used to create a user.","required":true,"schema":{"$ref":"#/definitions/ScimV2CreateUser"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2User"}},"201":{"description":"User Created.","schema":{"$ref":"#/definitions/ScimV2User"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"User name already in use by non-deleted user.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:add","authorization:grant:add","authorization:grant:delete","routing:skill:assign","routing:language:assign"]},"x-purecloud-method-name":"postScimUsers"}},"/api/v2/scim/users/{userId}":{"get":{"tags":["SCIM"],"summary":"Get a user","description":"","operationId":"getScimUser","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"name":"userId","in":"path","description":"The ID of a user. Returned with GET /api/v2/scim/users.","required":true,"type":"string"},{"name":"attributes","in":"query","description":"Indicates which attributes to include. Returns these attributes and the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","userName","displayName","title","active","externalId","phoneNumbers","emails","groups","roles","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:User:id","urn:ietf:params:scim:schemas:core:2.0:User:userName","urn:ietf:params:scim:schemas:core:2.0:User:displayName","urn:ietf:params:scim:schemas:core:2.0:User:title","urn:ietf:params:scim:schemas:core:2.0:User:active","urn:ietf:params:scim:schemas:core:2.0:User:externalId","urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers","urn:ietf:params:scim:schemas:core:2.0:User:emails","urn:ietf:params:scim:schemas:core:2.0:User:groups","urn:ietf:params:scim:schemas:core:2.0:User:roles","urn:ietf:params:scim:schemas:core:2.0:User:meta","urn:ietf:params:scim:schemas:core:2.0:User:meta.version","urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"id"},{"name":"userName"},{"name":"displayName"},{"name":"title"},{"name":"active"},{"name":"externalId"},{"name":"phoneNumbers"},{"name":"emails"},{"name":"groups"},{"name":"roles"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:userName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:title"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:active"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:externalId"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:emails"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:groups"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:roles"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"},{"name":"id"},{"name":"userName"},{"name":"displayName"},{"name":"title"},{"name":"active"},{"name":"externalId"},{"name":"phoneNumbers"},{"name":"emails"},{"name":"groups"},{"name":"roles"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:userName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:title"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:active"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:externalId"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:emails"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:groups"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:roles"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"}]},{"name":"excludedAttributes","in":"query","description":"Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.","required":false,"type":"array","items":{"type":"string","enum":["id","userName","displayName","title","active","externalId","phoneNumbers","emails","groups","roles","meta","meta.version","meta.lastModified","urn:ietf:params:scim:schemas:core:2.0:User:id","urn:ietf:params:scim:schemas:core:2.0:User:userName","urn:ietf:params:scim:schemas:core:2.0:User:displayName","urn:ietf:params:scim:schemas:core:2.0:User:title","urn:ietf:params:scim:schemas:core:2.0:User:active","urn:ietf:params:scim:schemas:core:2.0:User:externalId","urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers","urn:ietf:params:scim:schemas:core:2.0:User:emails","urn:ietf:params:scim:schemas:core:2.0:User:groups","urn:ietf:params:scim:schemas:core:2.0:User:roles","urn:ietf:params:scim:schemas:core:2.0:User:meta","urn:ietf:params:scim:schemas:core:2.0:User:meta.version","urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value","urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages","urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"id"},{"name":"userName"},{"name":"displayName"},{"name":"title"},{"name":"active"},{"name":"externalId"},{"name":"phoneNumbers"},{"name":"emails"},{"name":"groups"},{"name":"roles"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:userName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:title"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:active"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:externalId"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:emails"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:groups"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:roles"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"},{"name":"id"},{"name":"userName"},{"name":"displayName"},{"name":"title"},{"name":"active"},{"name":"externalId"},{"name":"phoneNumbers"},{"name":"emails"},{"name":"groups"},{"name":"roles"},{"name":"meta"},{"name":"meta.version"},{"name":"meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:id"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:userName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:displayName"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:title"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:active"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:externalId"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:emails"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:groups"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:roles"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.version"},{"name":"urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value"},{"name":"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages"},{"name":"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds"}]},{"name":"If-None-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2User"}},"304":{"description":"If-Non-Match header matches current version. No content returned."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","general.conflict":"A conflict occurred when getting a SCIM user"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The SCIM user was not found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim","scim:readonly"]}],"x-purecloud-method-name":"getScimUser"},"put":{"tags":["SCIM"],"summary":"Replace a user","description":"","operationId":"putScimUser","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"name":"userId","in":"path","description":"The ID of a user. Returned with GET /api/v2/scim/users.","required":true,"type":"string"},{"name":"If-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".","required":false,"type":"string"},{"in":"body","name":"body","description":"The information used to replace a user.","required":true,"schema":{"$ref":"#/definitions/ScimV2User"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2User"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Version does not match current version.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:edit","directory:user:setPassword","authorization:grant:add","authorization:grant:delete","routing:skill:assign","routing:language:assign"]},"x-purecloud-method-name":"putScimUser"},"delete":{"tags":["SCIM"],"summary":"Delete a user","description":"","operationId":"deleteScimUser","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"name":"userId","in":"path","description":"The ID of a user. Returned with GET /api/v2/scim/users.","required":true,"type":"string"},{"name":"If-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"204":{"description":"User Deleted with no content returned."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Version does not match current version.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:delete"]},"x-purecloud-method-name":"deleteScimUser"},"patch":{"tags":["SCIM"],"summary":"Modify a user","description":"","operationId":"patchScimUser","consumes":["application/json","application/scim+json"],"produces":["application/json","application/scim+json"],"parameters":[{"name":"userId","in":"path","description":"The ID of a user. Returned with GET /api/v2/scim/users.","required":true,"type":"string"},{"name":"If-Match","in":"header","description":"The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".","required":false,"type":"string"},{"in":"body","name":"body","description":"The information used to modify a user.","required":true,"schema":{"$ref":"#/definitions/ScimV2PatchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScimV2User"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Version does not match current version.","schema":{"$ref":"#/definitions/ScimError"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scim"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:user:edit","directory:user:setPassword","authorization:grant:add","authorization:grant:delete","routing:skill:assign","routing:language:assign"]},"x-purecloud-method-name":"patchScimUser"}},"/api/v2/oauth/scopes/{scopeId}":{"get":{"tags":["OAuth"],"summary":"An OAuth scope","description":"","operationId":"getOauthScope","produces":["application/json"],"parameters":[{"name":"scopeId","in":"path","description":"Scope ID","required":true,"type":"string"},{"name":"Accept-Language","in":"header","description":"The language with which to display the scope description.","required":false,"type":"string","default":"en-us"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthScope"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-purecloud-method-name":"getOauthScope"}},"/api/v2/quality/conversations/{conversationId}/surveys":{"get":{"tags":["Quality"],"summary":"Get the surveys for a conversation","description":"","operationId":"getQualityConversationSurveys","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/Survey"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:survey:view"]},"x-purecloud-method-name":"getQualityConversationSurveys"}},"/api/v2/externalcontacts/contacts/schemas":{"get":{"tags":["External Contacts"],"summary":"Get a list of schemas.","description":"","operationId":"getExternalcontactsContactsSchemas","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchemaListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"Unable to expand the schema."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getExternalcontactsContactsSchemas"},"post":{"tags":["External Contacts"],"summary":"Create a schema","description":"","operationId":"postExternalcontactsContactsSchemas","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Schema","required":true,"schema":{"$ref":"#/definitions/DataSchema"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.limit.max.number.of.fields.per.org.would.be.exceeded":"The total number of fields defined for all schemas would exceed 500.","dynamic.schema.limit.max.number.of.schemas.per.org.would.be.exceeded":"There cannot be more than 20 schemas.","bad.request":"The request could not be understood by the server due to malformed syntax.","dynamic.schema.invalid.json.schema":"An invalid JSON schema was provided.","dynamic.schema.limit.max.number.of.fields.per.schema.would.be.exceeded":"A schema cannot have more than 25 fields","dynamic.schema.validation.limit.error":"The schema has a validation limit error.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","dynamic.schema.incompatible.json.schema.update":"The JSON schema provided for update is incompatible with the previous version.","dynamic.schema.limit.max.number.of.characters.for.field.name.would.be.exceeded":"A field name cannot exceed 100 characters","dynamic.schema.validation.limit.missing":"The schema is missing a validation limit.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","dynamic.schema.length.limits.would.be.exceeded":"The schema title should not exceed 50 characters. The schema description should not exceed 200 characters.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.version.conflict":"A valid version is required."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dynamic.schema.expand.failed":"Unable to expand the schema."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:add"]},"x-purecloud-method-name":"postExternalcontactsContactsSchemas"}},"/api/v2/routing/users/{userId}/utilization":{"get":{"tags":["Routing","Users"],"summary":"Get the user's max utilization settings. If not configured, the organization-wide default is returned.","description":"","operationId":"getRoutingUserUtilization","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Utilization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:utilization:manage","routing:utilization:view"]},"x-purecloud-method-name":"getRoutingUserUtilization"},"put":{"tags":["Routing","Users"],"summary":"Update the user's max utilization settings. Include only those media types requiring custom configuration.","description":"","operationId":"putRoutingUserUtilization","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"utilization","required":true,"schema":{"$ref":"#/definitions/Utilization"}}],"responses":{"200":{"description":"Operation was successful.","schema":{"$ref":"#/definitions/Utilization"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"An unsupported media type was specified.","interrupt.same.media.type":"A media type cannot be set up to interrupt itself.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.media.capacity":"Maximum capacity must be between 1 and 50.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:utilization:manage"]},"x-purecloud-method-name":"putRoutingUserUtilization"},"delete":{"tags":["Routing","Users"],"summary":"Delete the user's max utilization settings and revert to the organization-wide default.","description":"","operationId":"deleteRoutingUserUtilization","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The user was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:utilization:manage"]},"x-purecloud-method-name":"deleteRoutingUserUtilization"}},"/api/v2/contentmanagement/auditquery":{"post":{"tags":["Content Management"],"summary":"Query audits","description":"","operationId":"postContentmanagementAuditquery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Allows for a filtered query returning facet information","required":true,"schema":{"$ref":"#/definitions/ContentQueryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueryResults"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Query audits forbidden."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"postContentmanagementAuditquery"}},"/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/publish":{"post":{"tags":["Language Understanding"],"summary":"Publish the draft NLU Domain Version.","description":"","operationId":"postLanguageunderstandingDomainVersionPublish","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"domainVersionId","in":"path","description":"ID of the NLU domain version.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluDomainVersion"}},"201":{"description":"Published the specified NLU Domain Version","schema":{"$ref":"#/definitions/NluDomainVersion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","language-understanding"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomainVersion:add","dialog:botVersion:add"]},"x-purecloud-method-name":"postLanguageunderstandingDomainVersionPublish"}},"/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/report":{"get":{"tags":["Language Understanding"],"summary":"Retrieved quality report for the specified NLU Domain Version","description":"","operationId":"getLanguageunderstandingDomainVersionReport","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"domainVersionId","in":"path","description":"ID of the NLU domain version.","required":true,"type":"string"}],"responses":{"200":{"description":"Find quality report for NLU Domain Version.","schema":{"$ref":"#/definitions/NluDomainVersionQualityReport"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","dialog:readonly","language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomainVersion:view","dialog:botVersion:view"]},"x-purecloud-method-name":"getLanguageunderstandingDomainVersionReport"}},"/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/train":{"post":{"tags":["Language Understanding"],"summary":"Train the draft NLU Domain Version.","description":"","operationId":"postLanguageunderstandingDomainVersionTrain","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"domainVersionId","in":"path","description":"ID of the NLU domain version.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/NluDomainVersionTrainingResponse"}},"202":{"description":"Issued training instruction for the draft NLU Domain Version","schema":{"$ref":"#/definitions/NluDomainVersionTrainingResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","language-understanding"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomainVersion:edit","dialog:botVersion:edit"]},"x-purecloud-method-name":"postLanguageunderstandingDomainVersionTrain"}},"/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/detect":{"post":{"tags":["Language Understanding"],"summary":"Detect intent, entities, etc. in the submitted text using the specified NLU domain version.","description":"","operationId":"postLanguageunderstandingDomainVersionDetect","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"domainVersionId","in":"path","description":"ID of the NLU domain version.","required":true,"type":"string"},{"in":"body","name":"body","description":"The input data to perform detection on.","required":true,"schema":{"$ref":"#/definitions/NluDetectionRequest"}}],"responses":{"200":{"description":"Requested NLU detection for the given input using the specified NLU domain version","schema":{"$ref":"#/definitions/NluDetectionResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","dialog:readonly","language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomainVersion:view","dialog:botVersion:view"]},"x-purecloud-method-name":"postLanguageunderstandingDomainVersionDetect"}},"/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}":{"get":{"tags":["Language Understanding"],"summary":"Find an NLU Domain Version.","description":"","operationId":"getLanguageunderstandingDomainVersion","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"domainVersionId","in":"path","description":"ID of the NLU domain version.","required":true,"type":"string"},{"name":"includeUtterances","in":"query","description":"Whether utterances for intent definition should be included when marshalling response.","required":false,"type":"boolean"}],"responses":{"200":{"description":"Retrieved the specified NLU Domain Version","schema":{"$ref":"#/definitions/NluDomainVersion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","dialog:readonly","language-understanding","language-understanding:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomainVersion:view","dialog:botVersion:view"]},"x-purecloud-method-name":"getLanguageunderstandingDomainVersion"},"put":{"tags":["Language Understanding"],"summary":"Update an NLU Domain Version.","description":"","operationId":"putLanguageunderstandingDomainVersion","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"domainVersionId","in":"path","description":"ID of the NLU domain version.","required":true,"type":"string"},{"in":"body","name":"body","description":"The updated NLU Domain Version.","required":true,"schema":{"$ref":"#/definitions/NluDomainVersion"}}],"responses":{"200":{"description":"Updated the specified NLU Domain Version","schema":{"$ref":"#/definitions/NluDomainVersion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service not available":"The service is not available.","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","language-understanding"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomainVersion:edit","dialog:botVersion:edit"]},"x-purecloud-method-name":"putLanguageunderstandingDomainVersion"},"delete":{"tags":["Language Understanding"],"summary":"Delete an NLU Domain Version","description":"","operationId":"deleteLanguageunderstandingDomainVersion","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"ID of the NLU domain.","required":true,"type":"string"},{"name":"domainVersionId","in":"path","description":"ID of the NLU domain version.","required":true,"type":"string"}],"responses":{"204":{"description":"Deleted the specified NLU Domain Version"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["dialog","language-understanding"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["languageUnderstanding:nluDomainVersion:delete","dialog:botVersion:delete"]},"x-purecloud-method-name":"deleteLanguageunderstandingDomainVersion"}},"/api/v2/stations/{stationId}":{"get":{"tags":["Stations"],"summary":"Get station.","description":"","operationId":"getStation","produces":["application/json"],"parameters":[{"name":"stationId","in":"path","description":"Station ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Station"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Specified station resource not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["stations","stations:readonly"]}],"x-purecloud-method-name":"getStation"}},"/api/v2/stations/{stationId}/associateduser":{"delete":{"tags":["Stations"],"summary":"Unassigns the user assigned to this station","description":"","operationId":"deleteStationAssociateduser","produces":["application/json"],"parameters":[{"name":"stationId","in":"path","description":"Station ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["stations"]}],"x-purecloud-method-name":"deleteStationAssociateduser"}},"/api/v2/routing/email/domains/{domainId}":{"get":{"tags":["Routing"],"summary":"Get domain","description":"","operationId":"getRoutingEmailDomain","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"domain ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundDomain"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"getRoutingEmailDomain"},"delete":{"tags":["Routing"],"summary":"Delete a domain","description":"","operationId":"deleteRoutingEmailDomain","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"domain ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"deleteRoutingEmailDomain"},"patch":{"tags":["Routing"],"summary":"Update domain settings","description":"","operationId":"patchRoutingEmailDomain","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"domain ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Domain settings","required":true,"schema":{"$ref":"#/definitions/InboundDomainPatchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundDomain"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.integration.connection":"Unable to connect with the specified integration.","email.error.integration.ssl":"There was a problem with opening a SSL socket to the integration.","email.error.integration.authentication":"Unable to authenticate with the specified integration.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","email.error.invalid.integration":"An invalid integration ID was specified.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","email.error.integration.host":"The specified integration has a bad host."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.domain.not.found":"The inbound domain does not exist.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.integration.timeout":"There was a timeout connecting to the integration.","authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"patchRoutingEmailDomain"}},"/api/v2/routing/email/domains/{domainId}/validate":{"patch":{"tags":["Routing"],"summary":"Validate domain settings","description":"","operationId":"patchRoutingEmailDomainValidate","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"domain ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Domain settings","required":true,"schema":{"$ref":"#/definitions/InboundDomainPatchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundDomain"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.integration.connection":"Unable to connect with the specified integration.","email.error.integration.ssl":"There was a problem with opening a SSL socket to the integration.","email.error.integration.authentication":"Unable to authenticate with the specified integration.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","email.error.invalid.integration":"An invalid integration ID was specified.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","email.error.integration.host":"The specified integration has a bad host."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.domain.not.found":"The inbound domain does not exist.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.integration.timeout":"There was a timeout connecting to the integration.","authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"patchRoutingEmailDomainValidate"}},"/api/v2/routing/email/domains/{domainId}/testconnection":{"post":{"tags":["Routing"],"summary":"Tests the custom SMTP server integration connection set on this domain","description":"The request body is optional. If omitted, this endpoint will just test the connection of the Custom SMTP Server. If the body is specified, there will be an attempt to send an email message to the server.","operationId":"postRoutingEmailDomainTestconnection","produces":["application/json"],"parameters":[{"name":"domainId","in":"path","description":"domain ID","required":true,"type":"string"},{"in":"body","name":"body","description":"TestMessage","required":false,"schema":{"$ref":"#/definitions/TestMessage"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TestMessage"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.integration.connection":"Unable to connect with the specified integration.","email.error.integration.ssl":"There was a problem with opening a SSL socket to the integration.","email.error.integration.authentication":"Unable to authenticate with the specified integration.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","email.error.invalid.integration":"An invalid integration ID was specified.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","email.error.integration.host":"The specified integration has a bad host."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","feature.forbidden":"This feature is not enabled for this organization."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"email.error.integration.timeout":"There was a timeout connecting to the integration.","authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"postRoutingEmailDomainTestconnection"}},"/api/v2/outbound/campaigns/all":{"get":{"tags":["Outbound"],"summary":"Query across all types of campaigns by division","description":"","operationId":"getOutboundCampaignsAll","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"id","in":"query","description":"Campaign ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Campaign name(s)","required":false,"type":"string"},{"name":"divisionId","in":"query","description":"Division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"mediaType","in":"query","description":"Media type(s)","required":false,"type":"array","items":{"type":"string","enum":["sms","voice"],"x-genesys-enum-members":[{"name":"sms"},{"name":"voice"}]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"sms"},{"name":"voice"}]},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CommonCampaignEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.filter.field":"Invalid query parameter supplied for filtering.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaign:view","outbound:messagingCampaign:view"]},"x-purecloud-method-name":"getOutboundCampaignsAll"}},"/api/v2/recording/jobs":{"get":{"tags":["Recording"],"summary":"Get the status of all jobs within the user's organization","description":"","operationId":"getRecordingJobs","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"userId","enum":["userId","dateCreated"],"x-genesys-enum-members":[{"name":"userId"},{"name":"dateCreated"}]},{"name":"state","in":"query","description":"Filter by state","required":false,"type":"string","enum":["FULFILLED","PENDING","READY","PROCESSING","CANCELLED","FAILED"],"x-genesys-enum-members":[{"name":"FULFILLED"},{"name":"PENDING"},{"name":"READY"},{"name":"PROCESSING"},{"name":"CANCELLED"},{"name":"FAILED"}]},{"name":"showOnlyMyJobs","in":"query","description":"Show only my jobs","required":false,"type":"boolean"},{"name":"jobType","in":"query","description":"Job Type (Can be left empty for both)","required":false,"type":"string","enum":["DELETE","EXPORT"],"x-genesys-enum-members":[{"name":"DELETE"},{"name":"EXPORT"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecordingJobEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["recording:job:view"]},"x-purecloud-method-name":"getRecordingJobs"},"post":{"tags":["Recording"],"summary":"Create a recording bulk job","description":"","operationId":"postRecordingJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/RecordingJobsQuery"}}],"responses":{"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/RecordingJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["recording:job:add"]},"x-purecloud-method-name":"postRecordingJobs"}},"/api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues":{"get":{"tags":["Content Management"],"summary":"Get a list of workspace tags","description":"","operationId":"getContentmanagementWorkspaceTagvalues","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"name":"value","in":"query","description":"filter the list of tags returned","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["acl"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"acl"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TagValueEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementWorkspaceTagvalues"},"post":{"tags":["Content Management"],"summary":"Create a workspace tag","description":"","operationId":"postContentmanagementWorkspaceTagvalues","produces":["application/json"],"parameters":[{"name":"workspaceId","in":"path","description":"Workspace ID","required":true,"type":"string"},{"in":"body","name":"body","description":"tag","required":true,"schema":{"$ref":"#/definitions/TagValue"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TagValue"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"postContentmanagementWorkspaceTagvalues"}},"/api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}":{"get":{"tags":["Organization Authorization"],"summary":"Get Trustee User","description":"","operationId":"getOrgauthorizationTrusteeUser","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Trustee User Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustUser"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:view"]},"x-purecloud-method-name":"getOrgauthorizationTrusteeUser"},"delete":{"tags":["Organization Authorization"],"summary":"Delete Trustee User","description":"","operationId":"deleteOrgauthorizationTrusteeUser","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"name":"trusteeUserId","in":"path","description":"Trustee User Id","required":true,"type":"string"}],"responses":{"204":{"description":"Trust deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrusteeUser:delete"]},"x-purecloud-method-name":"deleteOrgauthorizationTrusteeUser"}},"/api/v2/speechandtextanalytics/dialects":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get list of supported Speech & Text Analytics dialects","description":"","operationId":"getSpeechandtextanalyticsDialects","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"type":"object"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-purecloud-method-name":"getSpeechandtextanalyticsDialects"}},"/api/v2/outbound/events":{"get":{"tags":["Outbound"],"summary":"Query Event Logs","description":"","operationId":"getOutboundEvents","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"],"x-genesys-enum-members":[{"name":"Equals"},{"name":"RegEx"},{"name":"Contains"},{"name":"Prefix"},{"name":"LessThan"},{"name":"LessThanEqualTo"},{"name":"GreaterThan"},{"name":"GreaterThanEqualTo"},{"name":"BeginsWith"},{"name":"EndsWith"}]},{"name":"category","in":"query","description":"Category","required":false,"type":"string"},{"name":"level","in":"query","description":"Level","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DialerEventEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:eventLog:view"]},"x-purecloud-method-name":"getOutboundEvents"}},"/api/v2/telephony/providers/edges":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of edges.","description":"","operationId":"getTelephonyProvidersEdges","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"site.id","in":"query","description":"Filter by site.id","required":false,"type":"string"},{"name":"edgeGroup.id","in":"query","description":"Filter by edgeGroup.id","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"managed","in":"query","description":"Filter by managed","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EdgeEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"Request Timeout","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unknown":"Unspecified error getting edge listing."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.internal.server.error":"Internal server error while getting edge listing.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdges"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create an edge.","description":"","operationId":"postTelephonyProvidersEdges","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Edge","required":true,"schema":{"$ref":"#/definitions/Edge"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Edge"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","duplicate.edge.name":"The edge name is already in use."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdges"}},"/api/v2/users/search":{"get":{"tags":["Search","Users"],"summary":"Search users using the q64 value returned from a previous search","description":"","operationId":"getUsersSearch","produces":["application/json"],"parameters":[{"name":"q64","in":"query","description":"q64","required":true,"type":"string"},{"name":"expand","in":"query","description":"expand","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"integrationPresenceSource","in":"query","description":"integrationPresenceSource","required":false,"type":"string","enum":["MicrosoftTeams","ZoomPhone","RingCentral"],"x-genesys-enum-members":[{"name":"MicrosoftTeams"},{"name":"ZoomPhone"},{"name":"RingCentral"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UsersSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getUsersSearch"},"post":{"tags":["Search","Users"],"summary":"Search users","description":"","operationId":"postUsersSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/UserSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UsersSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"Users not found"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"external.server.error":"An external server error occurred","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"postUsersSearch"}},"/api/v2/speechandtextanalytics/conversations/{conversationId}":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get Speech and Text Analytics for a specific conversation","description":"","operationId":"getSpeechandtextanalyticsConversation","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConversationMetrics"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden from retrieving Speech and Text Analytics."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"Speech and Text Analytics Not found"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:recording:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsConversation"}},"/api/v2/telephony/providers/edges/lines":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of Lines","description":"","operationId":"getTelephonyProvidersEdgesLines","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Value by which to sort","required":false,"type":"string","default":"name"},{"name":"expand","in":"query","description":"Fields to expand in the response, comma-separated","required":false,"type":"array","items":{"type":"string","enum":["properties","site","edgeGroup","primaryEdge","secondaryEdge","edges","assignedUser"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"properties"},{"name":"site"},{"name":"edgeGroup"},{"name":"primaryEdge"},{"name":"secondaryEdge"},{"name":"edges"},{"name":"assignedUser"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LineEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesLines"}},"/api/v2/gdpr/requests/{requestId}":{"get":{"tags":["General Data Protection Regulation"],"summary":"Get an existing GDPR request","description":"","operationId":"getGdprRequest","produces":["application/json"],"parameters":[{"name":"requestId","in":"path","description":"Request id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GDPRRequest"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["gdpr","gdpr:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["gdpr:request:view"]},"x-purecloud-method-name":"getGdprRequest"}},"/api/v2/contentmanagement/query":{"get":{"tags":["Content Management"],"summary":"Query content","description":"","operationId":"getContentmanagementQuery","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"name or dateCreated","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"ascending or descending","required":false,"type":"string","default":"ascending"},{"name":"queryPhrase","in":"query","description":"Phrase tokens are ANDed together over all searchable fields","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["acl","workspace"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"acl"},{"name":"workspace"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueryResults"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementQuery"},"post":{"tags":["Content Management"],"summary":"Query content","description":"","operationId":"postContentmanagementQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Allows for a filtered query returning facet information","required":true,"schema":{"$ref":"#/definitions/QueryRequest"}},{"name":"expand","in":"query","description":"Expand some document fields","required":false,"type":"string","enum":["acl","workspace"],"x-genesys-enum-members":[{"name":"acl"},{"name":"workspace"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueryResults"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","trustee.forbidden":"Forbidden due to trustee from deleting query content.","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden from deleting query content."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"postContentmanagementQuery"}},"/api/v2/alerting/interactionstats/alerts/unread":{"get":{"tags":["Alerting"],"summary":"Gets user unread count of interaction stats alerts.","description":"","operationId":"getAlertingInteractionstatsAlertsUnread","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UnreadMetric"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["alerting","alerting:readonly"]}],"x-purecloud-method-name":"getAlertingInteractionstatsAlertsUnread"}},"/api/v2/identityproviders/gsuite":{"get":{"tags":["Identity Provider"],"summary":"Get G Suite Identity Provider","description":"","operationId":"getIdentityprovidersGsuite","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GSuite"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersGsuite"},"put":{"tags":["Identity Provider"],"summary":"Update/Create G Suite Identity Provider","description":"","operationId":"putIdentityprovidersGsuite","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/GSuite"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.issuer.uri":"An issuer URI is required.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.target.url":"The target URL must be a valid HTTPS URL.","certificate.not.yet.valid":"The certificate is not yet valid.","certificate.invalid.base64":"Invalid base64 in certificate.","certificate.unparseable":"The certificate for provider cannot be parsed.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersGsuite"},"delete":{"tags":["Identity Provider"],"summary":"Delete G Suite Identity Provider","description":"","operationId":"deleteIdentityprovidersGsuite","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersGsuite"}},"/api/v2/analytics/conversations/{conversationId}/details":{"get":{"tags":["Conversations","Analytics"],"summary":"Get a conversation by id","description":"","operationId":"getAnalyticsConversationDetails","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AnalyticsConversationWithoutAttributes"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationDetail:view"]},"x-purecloud-method-name":"getAnalyticsConversationDetails"}},"/api/v2/analytics/conversations/{conversationId}/details/properties":{"post":{"tags":["Conversations","Analytics"],"summary":"Index conversation properties","description":"","operationId":"postAnalyticsConversationDetailsProperties","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"request","required":true,"schema":{"$ref":"#/definitions/PropertyIndexRequest"}}],"responses":{"202":{"description":"Accepted - Indexing properties","schema":{"$ref":"#/definitions/PropertyIndexRequest"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationProperties:index"]},"x-purecloud-method-name":"postAnalyticsConversationDetailsProperties"}},"/api/v2/analytics/conversations/aggregates/query":{"post":{"tags":["Conversations","Analytics"],"summary":"Query for conversation aggregates","description":"","operationId":"postAnalyticsConversationsAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/ConversationAggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConversationAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"An internal server error has occurred."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationAggregate:view"]},"x-purecloud-method-name":"postAnalyticsConversationsAggregatesQuery"}},"/api/v2/analytics/conversations/details/query":{"post":{"tags":["Conversations","Analytics"],"summary":"Query for conversation details","description":"","operationId":"postAnalyticsConversationsDetailsQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/ConversationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AnalyticsConversationQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","payload.too.large":"The response payload was too large.","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"An internal server error has occurred."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationDetail:view"]},"x-purecloud-method-name":"postAnalyticsConversationsDetailsQuery"}},"/api/v2/analytics/conversations/details":{"get":{"tags":["Conversations","Analytics"],"summary":"Gets multiple conversations by id","description":"","operationId":"getAnalyticsConversationsDetails","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"Comma-separated conversation ids","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AnalyticsConversationWithoutAttributesMultiGetResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationDetail:view"]},"x-purecloud-method-name":"getAnalyticsConversationsDetails"}},"/api/v2/analytics/conversations/details/jobs":{"post":{"tags":["Conversations","Analytics"],"summary":"Query for conversation details asynchronously","description":"","operationId":"postAnalyticsConversationsDetailsJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/AsyncConversationQuery"}}],"responses":{"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationDetail:view"]},"x-purecloud-method-name":"postAnalyticsConversationsDetailsJobs"}},"/api/v2/analytics/conversations/details/jobs/{jobId}":{"get":{"tags":["Conversations","Analytics"],"summary":"Get status for async query for conversation details","description":"","operationId":"getAnalyticsConversationsDetailsJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"202":{"description":"Accepted - Running query asynchronously","schema":{"$ref":"#/definitions/AsyncQueryStatus"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationDetail:view"]},"x-purecloud-method-name":"getAnalyticsConversationsDetailsJob"},"delete":{"tags":["Conversations","Analytics"],"summary":"Delete/cancel an async request","description":"","operationId":"deleteAnalyticsConversationsDetailsJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"}],"responses":{"204":{"description":"Deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationDetail:view"]},"x-purecloud-method-name":"deleteAnalyticsConversationsDetailsJob"}},"/api/v2/analytics/conversations/details/jobs/{jobId}/results":{"get":{"tags":["Conversations","Analytics"],"summary":"Fetch a page of results for an async query","description":"","operationId":"getAnalyticsConversationsDetailsJobResults","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"},{"name":"cursor","in":"query","description":"Indicates where to resume query results (not required for first page)","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"The desired maximum number of results","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AnalyticsConversationAsyncQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationDetail:view"]},"x-purecloud-method-name":"getAnalyticsConversationsDetailsJobResults"}},"/api/v2/analytics/conversations/details/jobs/availability":{"get":{"tags":["Conversations","Analytics"],"summary":"Lookup the datalake availability date and time","description":"","operationId":"getAnalyticsConversationsDetailsJobsAvailability","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataAvailabilityResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationDetail:view"]},"x-purecloud-method-name":"getAnalyticsConversationsDetailsJobsAvailability"}},"/api/v2/quality/forms":{"get":{"tags":["Quality"],"summary":"Get the list of evaluation forms","description":"","operationId":"getQualityForms","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"expand","in":"query","description":"Expand","required":false,"type":"string"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Order to sort results, either asc or desc","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationFormEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:view"]},"x-purecloud-method-name":"getQualityForms"},"post":{"tags":["Quality"],"summary":"Create an evaluation form.","description":"","operationId":"postQualityForms","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Evaluation form","required":true,"schema":{"$ref":"#/definitions/EvaluationForm"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"evaluation.form.invalid":"Evaluation form is not valid","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:add"]},"x-purecloud-method-name":"postQualityForms"}},"/api/v2/outbound/contactlists/{contactListId}/export":{"get":{"tags":["Outbound"],"summary":"Get the URI of a contact list export.","description":"","operationId":"getOutboundContactlistExport","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"ContactList ID","required":true,"type":"string"},{"name":"download","in":"query","description":"Redirect to download uri","required":false,"type":"string","default":"false"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExportUri"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","exports.black.listed":"This organization has been prohibited from exporting contact lists. Please contact support.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","no.available.list.export.uri":"There is no available download URI for contact list at this time.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:contact:view","outbound:contactList:view"]},"x-purecloud-method-name":"getOutboundContactlistExport"},"post":{"tags":["Outbound"],"summary":"Initiate the export of a contact list.","description":"Returns 200 if received OK.","operationId":"postOutboundContactlistExport","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"ContactList ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainEntityRef"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","contact.list.export.in.progress":"An export is already in progress for this contact list.","exports.black.listed":"This organization has been prohibited from exporting contact lists. Please contact support.","internal.error":"An internal service error occurred.","contact.list.import.in.progress":"The contact list cannot be exported while it is being imported.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:contact:view","outbound:contactList:view"]},"x-purecloud-method-name":"postOutboundContactlistExport"}},"/api/v2/flows/milestones":{"get":{"tags":["Architect"],"summary":"Get a pageable list of flow milestones, filtered by query parameters","description":"Multiple IDs can be specified, in which case all matching flow milestones will be returned, and no other parameters will be evaluated.","operationId":"getFlowsMilestones","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"id"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc"},{"name":"id","in":"query","description":"ID","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"description","in":"query","description":"Description","required":false,"type":"string"},{"name":"nameOrDescription","in":"query","description":"Name or description","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowMilestoneListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.feature.unavailable":"Flow milestones feature is not available for current organization."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowMilestone:view"]},"x-purecloud-method-name":"getFlowsMilestones"},"post":{"tags":["Architect"],"summary":"Create a flow milestone","description":"","operationId":"postFlowsMilestones","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/FlowMilestone"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FlowMilestone"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.milestone.validate.failed.invalid.name.no.alpha":"Failed to validate flow milestone due to invalid name. Names must contain at least one alphanumeric character.","architect.flow.milestone.validate.failed.invalid.name.spaces":"Failed to validate flow milestone due to invalid name. Names must not contain leading or trailing whitespaces.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","architect.property.exceeds.max.character.length":"The name and/or description exceeds the maximum character length.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","architect.object.validate.failed":"Failed to validate object.","architect.flow.milestone.validate.failed.missing.name":"Failed to validate flow milestone due to missing name.","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.feature.unavailable":"Flow milestones feature is not available for current organization."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.milestone.exceeded.max.amount":"Could not create flow milestone since the maximum number of milestones already exist.","architect.flow.milestone.already.exists":"A flow milestone with the specified name already exists."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:flowMilestone:add"]},"x-purecloud-method-name":"postFlowsMilestones"}},"/api/v2/outbound/contactlists/{contactListId}/contacts/bulk":{"post":{"tags":["Outbound"],"summary":"Get contacts from a contact list.","description":"","operationId":"postOutboundContactlistContactsBulk","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ContactIds to get.","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/DialerContact"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.contacts.requested":"Only 50 contacts can be retrieved at a time.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contact:view"]},"x-purecloud-method-name":"postOutboundContactlistContactsBulk"}},"/api/v2/telephony/providers/edges/phonebasesettings/template":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Phone Base Settings instance template from a given make and model. This object can then be modified and saved as a new Phone Base Settings instance","description":"","operationId":"getTelephonyProvidersEdgesPhonebasesettingsTemplate","produces":["application/json"],"parameters":[{"name":"phoneMetabaseId","in":"query","description":"The id of a metabase object upon which to base this Phone Base Settings","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhoneBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesPhonebasesettingsTemplate"}},"/api/v2/users/me/password":{"post":{"tags":["Users"],"summary":"Change your password","description":"","operationId":"postUsersMePassword","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Password","required":true,"schema":{"$ref":"#/definitions/ChangeMyPasswordRequest"}}],"responses":{"204":{"description":"Password changed"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.new.password":"The new password does not meet policy requirements.","invalid.password":"The new password does not meet policy requirements or the old password is incorrect.","not.a.user":"This request requires a user context. Client credentials cannot be used for requests to this resource.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.old.password":"The old password is incorrect.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users"]}],"x-purecloud-method-name":"postUsersMePassword"}},"/api/v2/contentmanagement/shared/{sharedId}":{"get":{"tags":["Content Management"],"summary":"Get shared documents. Securely download a shared document.","description":"This method requires the download sharing URI obtained in the get document response (downloadSharingUri). Documents may be shared between users in the same workspace. Documents may also be shared between any user by creating a content management share.","operationId":"getContentmanagementSharedSharedId","produces":["application/json"],"parameters":[{"name":"sharedId","in":"path","description":"Shared ID","required":true,"type":"string"},{"name":"redirect","in":"query","description":"Turn on or off redirect","required":false,"type":"boolean","default":true},{"name":"disposition","in":"query","description":"Request how the share content will be downloaded: attached as a file or inline. Default is attachment.","required":false,"type":"string","default":"attachment","enum":["attachment","inline","none"],"x-genesys-enum-members":[{"name":"attachment"},{"name":"inline"},{"name":"none"}]},{"name":"contentType","in":"query","description":"The requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav","required":false,"type":"string"},{"name":"expand","in":"query","description":"Expand some document fields","required":false,"type":"string","enum":["document.acl"],"x-genesys-enum-members":[{"name":"document.acl"}]}],"responses":{"200":{"description":"Download location is returned in header, if redirect is set to false and disposition is not set to none. If disposition is none, location header will not be populated, DownloadUri and ViewUri will be populated.","schema":{"$ref":"#/definitions/SharedResponse"}},"202":{"description":"Accepted - Preparing file for download - try again soon."},"307":{"description":"Redirected to download location, if redirect is set to true"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","unauthorized":"Unauthorized to access document.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Unable to access document."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementSharedSharedId"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}":{"get":{"tags":["Knowledge"],"summary":"Get knowledge base","description":"","operationId":"getKnowledgeKnowledgebase","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","input.validations":"Input paramaters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","404":"Resource not found","not.found":"The requested resource was not found.","kb.not.found":"Knowledge Base does not exist"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:knowledgebase:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebase"},"delete":{"tags":["Knowledge"],"summary":"Delete knowledge base","description":"","operationId":"deleteKnowledgeKnowledgebase","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeBase"}},"204":{"description":"Knowledge base deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","input.validations":"Input paramaters do not match the required criteria"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"400":"Invalid request","404":"Resource not found","not.found":"The requested resource was not found.","kb.not.found":"Knowledge Base does not exist"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"500":"An internal server error occurred","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:knowledgebase:delete"]},"x-purecloud-method-name":"deleteKnowledgeKnowledgebase"},"patch":{"tags":["Knowledge"],"summary":"Update knowledge base","description":"","operationId":"patchKnowledgeKnowledgebase","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeBase"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","input.validations":"Input paramaters do not match the required criteria","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"404":"Resource not found","not.found":"The requested resource was not found.","kb.not.found":"Knowledge Base does not exist"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:knowledgebase:edit"]},"x-purecloud-method-name":"patchKnowledgeKnowledgebase"}},"/api/v2/telephony/providers/edges/didpools/{didPoolId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a DID Pool by ID.","description":"","operationId":"getTelephonyProvidersEdgesDidpool","produces":["application/json"],"parameters":[{"name":"didPoolId","in":"path","description":"DID pool ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DIDPool"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The DID Pool was not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesDidpool"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a DID Pool by ID.","description":"","operationId":"putTelephonyProvidersEdgesDidpool","produces":["application/json"],"parameters":[{"name":"didPoolId","in":"path","description":"DID pool ID","required":true,"type":"string"},{"in":"body","name":"body","description":"DID pool","required":true,"schema":{"$ref":"#/definitions/DIDPool"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DIDPool"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The DID Pool was not found.","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be completed by the server due to a conflict."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesDidpool"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a DID Pool by ID.","description":"","operationId":"deleteTelephonyProvidersEdgesDidpool","produces":["application/json"],"parameters":[{"name":"didPoolId","in":"path","description":"DID pool ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Edge group was not found.","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The request could not be completed by the server due to a conflict."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdgesDidpool"}},"/api/v2/authorization/permissions":{"get":{"tags":["Authorization"],"summary":"Get all permissions.","description":"Retrieve a list of all permission defined in the system.","operationId":"getAuthorizationPermissions","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"queryType","in":"query","description":"Query filter type","required":false,"type":"string","enum":["domain","permission"],"x-genesys-enum-members":[{"name":"domain"},{"name":"permission"}]},{"name":"query","in":"query","description":"Comma-separated list of permissions or domains to query","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PermissionCollectionEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-purecloud-method-name":"getAuthorizationPermissions"}},"/api/v2/telephony/providers/edges/trunks/{trunkId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Trunk by ID","description":"","operationId":"getTelephonyProvidersEdgesTrunk","produces":["application/json"],"parameters":[{"name":"trunkId","in":"path","description":"Trunk ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Trunk"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Trunk ID not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesTrunk"}},"/api/v2/date":{"get":{"tags":["Utilities"],"summary":"Get the current system date/time","description":"","operationId":"getDate","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ServerDate"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":[]}],"x-purecloud-method-name":"getDate"}},"/api/v2/contentmanagement/shares/{shareId}":{"get":{"tags":["Content Management"],"summary":"Retrieve details about an existing share.","description":"","operationId":"getContentmanagementShare","produces":["application/json"],"parameters":[{"name":"shareId","in":"path","description":"Share ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["member"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"member"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Share"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementShare"},"delete":{"tags":["Content Management"],"summary":"Deletes an existing share.","description":"This revokes sharing rights specified in the share record","operationId":"deleteContentmanagementShare","produces":["application/json"],"parameters":[{"name":"shareId","in":"path","description":"Share ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden from deleting a share."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"deleteContentmanagementShare"}},"/api/v2/integrations/actions/drafts":{"get":{"tags":["Integrations"],"summary":"Retrieves all action drafts associated with the filters passed in via query param.","description":"","operationId":"getIntegrationsActionsDrafts","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Root level field name to sort on.","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Direction to sort 'sortBy' field.","required":false,"type":"string","default":"asc","enum":["ASC","DESC"],"x-genesys-enum-members":[{"name":"ASC"},{"name":"DESC"}]},{"name":"category","in":"query","description":"Filter by category name","required":false,"type":"string"},{"name":"name","in":"query","description":"Filter by action name. Provide full or just the first part of name.","required":false,"type":"string"},{"name":"secure","in":"query","description":"Filter to only include secure actions. True will only include actions marked secured. False will include only unsecure actions. Do not use filter if you want all Actions.","required":false,"type":"string","enum":["true","false"],"x-genesys-enum-members":[{"name":"true"},{"name":"false"}]},{"name":"includeAuthActions","in":"query","description":"Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions.","required":false,"type":"string","default":"false","enum":["true","false"],"x-genesys-enum-members":[{"name":"true"},{"name":"false"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActionEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:view","bridge:actions:view"]},"x-purecloud-method-name":"getIntegrationsActionsDrafts"},"post":{"tags":["Integrations"],"summary":"Create a new Draft","description":"","operationId":"postIntegrationsActionsDrafts","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Input used to create Action Draft.","required":true,"schema":{"$ref":"#/definitions/PostActionInput"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Action"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:add"]},"x-purecloud-method-name":"postIntegrationsActionsDrafts"}},"/api/v2/outbound/contactlists/{contactListId}/clear":{"post":{"tags":["Outbound"],"summary":"Deletes all contacts out of a list. All outstanding recalls or rule-scheduled callbacks for non-preview campaigns configured with the contactlist will be cancelled.","description":"","operationId":"postOutboundContactlistClear","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"}],"responses":{"204":{"description":"Contacts will be deleted."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.is.on.running.campaign":"The contacts cannot be removed from a contactlist that is on a campaign that is in state ON or STOPPING.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","contact.list.import.in.progress":"The contacts cannot be removed from a contactlist that is currently in progress of an import.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.error":"An internal server error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contact:delete"]},"x-purecloud-method-name":"postOutboundContactlistClear"}},"/api/v2/architect/prompts/{promptId}/history":{"post":{"tags":["Architect"],"summary":"Generate prompt history","description":"Asynchronous. Notification topic: v2.architect.prompts.{promptId}","operationId":"postArchitectPromptHistory","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Operation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:view"]},"x-purecloud-method-name":"postArchitectPromptHistory"}},"/api/v2/architect/prompts/{promptId}":{"get":{"tags":["Architect"],"summary":"Get specified user prompt","description":"","operationId":"getArchitectPrompt","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Prompt"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.not.found":"Could not find prompt with specified ID.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:view"]},"x-purecloud-method-name":"getArchitectPrompt"},"put":{"tags":["Architect"],"summary":"Update specified user prompt","description":"","operationId":"putArchitectPrompt","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Prompt"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Prompt"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.validate.failed.invalid.name":"Failed to validate prompt due to invalid name. Prompt names can only contain letters, numbers, and the underscore, and must start with a letter or number.","architect.prompt.resource.validate.failed.language":"Failed to validate prompt resource due to missing or invalid language.","architect.prompt.resource.invalid.tags":"The specified tags are in an invalid format.","bad.request":"The request could not be understood by the server due to malformed syntax.","architect.prompt.validate.failed":"Failed to validate prompt.","architect.object.validate.failed":"Failed to validate object.","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","architect.prompt.resource.validate.failed":"Failed to validate prompt resource.","architect.prompt.validate.failed.name.no.alpha":"Failed to validate prompt due to invalid name. Names must contain at least one alphanumeric character.","architect.prompt.validate.failed.missing.name":"Failed to validate prompt due to missing name.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.not.found":"Could not find prompt with specified ID.","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.already.exists":"A prompt with the specified name already exists."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.object.update.failed":"The database update for the object failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:edit"]},"x-purecloud-method-name":"putArchitectPrompt"},"delete":{"tags":["Architect"],"summary":"Delete specified user prompt","description":"","operationId":"deleteArchitectPrompt","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"allResources","in":"query","description":"Whether or not to delete all the prompt resources","required":false,"type":"boolean"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.not.found":"Could not find prompt with specified ID.","architect.flow.data.missing":"Flow version data content is missing.","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.cannot.delete.used.in.queues":"Prompt cannot be deleted due to being used by one or more queue configuration(s).","architect.dependency.object.in.use":"The object cannot be deleted because other objects depend on it.","architect.prompt.has.resources":"Cannot delete prompt since it contains prompt resources."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","architect.database.throughput.exceeded":"Database too busy. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:delete"]},"x-purecloud-method-name":"deleteArchitectPrompt"}},"/api/v2/architect/prompts/{promptId}/history/{historyId}":{"get":{"tags":["Architect"],"summary":"Get generated prompt history","description":"","operationId":"getArchitectPromptHistoryHistoryId","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"historyId","in":"path","description":"History request ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"desc"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"timestamp","enum":["action","timestamp","user"],"x-genesys-enum-members":[{"name":"action"},{"name":"timestamp"},{"name":"user"}]},{"name":"action","in":"query","description":"Flow actions to include (omit to include all)","required":false,"type":"array","items":{"type":"string","enum":["checkin","checkout","create","deactivate","debug","delete","publish","revert","save"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"checkin"},{"name":"checkout"},{"name":"create"},{"name":"deactivate"},{"name":"debug"},{"name":"delete"},{"name":"publish"},{"name":"revert"},{"name":"save"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/HistoryListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.not.found":"Could not find prompt with specified ID.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:view"]},"x-purecloud-method-name":"getArchitectPromptHistoryHistoryId"}},"/api/v2/externalcontacts/contacts/{contactId}":{"get":{"tags":["External Contacts"],"summary":"Fetch an external contact","description":"","operationId":"getExternalcontactsContact","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand (externalOrganization,externalDataSources)","required":false,"type":"array","items":{"type":"string","enum":["externalOrganization","externalDataSources"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"externalOrganization"},{"name":"externalDataSources"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalContact"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Specified contactId not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:view"]},"x-purecloud-method-name":"getExternalcontactsContact"},"put":{"tags":["External Contacts"],"summary":"Update an external contact","description":"","operationId":"putExternalcontactsContact","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ExternalContact","required":true,"schema":{"$ref":"#/definitions/ExternalContact"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalContact"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"custom.fields.validation.failed":"The custom fields values failed validation","validation.failed":"The provided contact was not valid"}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:edit"]},"x-purecloud-method-name":"putExternalcontactsContact"},"delete":{"tags":["External Contacts"],"summary":"Delete an external contact","description":"","operationId":"deleteExternalcontactsContact","produces":["application/json"],"parameters":[{"name":"contactId","in":"path","description":"ExternalContact ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Specified contactId not found.","contact.not.found":"Contact is not found by contact id.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:contact:delete"]},"x-purecloud-method-name":"deleteExternalcontactsContact"}},"/api/v2/telephony/providers/edges/extensions/{extensionId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get an extension by ID.","description":"","operationId":"getTelephonyProvidersEdgesExtension","produces":["application/json"],"parameters":[{"name":"extensionId","in":"path","description":"Extension ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Extension"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesExtension"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update an extension by ID.","description":"","operationId":"putTelephonyProvidersEdgesExtension","produces":["application/json"],"parameters":[{"name":"extensionId","in":"path","description":"Extension ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Extension","required":true,"schema":{"$ref":"#/definitions/Extension"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Extension"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesExtension"}},"/api/v2/flows/{flowId}":{"get":{"tags":["Architect"],"summary":"Get flow","description":"","operationId":"getFlow","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"},{"name":"deleted","in":"query","description":"Deleted flows","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Flow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.version.missing":"Specified flow version is missing.","not.found":"The requested resource was not found.","architect.flow.not.found":"Could not find flow with specified ID."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.inbound.short.message.flow.invalid.operation":"Cannot perform requested operation on an inbound short message flow.","Inbound.Email.Flow.Invalid.Operation":"Cannot perform requested operation on an inbound email flow.","architect.workflow.invalid.operation":"Cannot perform requested operation on a workflow.","Outbound.Call.Flow.Invalid.Operation":"Cannot perform requested operation on an outbound call flow.","Inbound.Call.Flow.Invalid.Operation":"Cannot perform requested operation on an inbound call flow.","architect.speech.flow.invalid.operation":"Cannot perform requested operation on a speech flow.","architect.secure.call.flow.invalid.operation":"Cannot perform requested operation on a secure call flow.","Inqueue.Call.Flow.Invalid.Operation":"Cannot perform requested operation on an inqueue call flow.","architect.survey.invite.flow.invalid.operation":"Cannot perform requested operation on a survey invite flow.","architect.bot.flow.invalid.operation":"Cannot perform requested operation on a bot flow.","architect.secure.call.flow.not.supported":"Secure call flows are not supported by the current product levels."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:view"]},"x-purecloud-method-name":"getFlow"},"put":{"tags":["Architect"],"summary":"Update flow","description":"","operationId":"putFlow","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Flow"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Flow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","architect.flow.validate.failed.invalid.name.contains.slash":"Failed to validate flow due to invalid name. Flow names must not contain forward slashes.","architect.flow.validate.failed.invalid.name.no.alpha":"Failed to validate flow due to invalid name. Names must contain at least one alphanumeric character.","bad.request":"The request could not be understood by the server due to malformed syntax.","architect.object.validate.failed":"Failed to validate object.","architect.flow.validate.failed.missing.type":"Failed to validate flow due to missing type.","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","architect.flow.validate.failed.invalid.name.contains.debug":"Failed to validate flow due to invalid name. Flow names must not end with '-debug'.","architect.flow.validate.failed":"Failed to validate flow.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","architect.system.flow.name.or.description.error":"System flow names and descriptions cannot be changed.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","architect.flow.validate.failed.missing.name":"Failed to validate flow due to missing name."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.version.missing":"Specified flow version is missing.","not.found":"The requested resource was not found.","architect.flow.not.found":"Could not find flow with specified ID."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.inbound.short.message.flow.invalid.operation":"Cannot perform requested operation on an inbound short message flow.","architect.debug.flow.invalid.operation":"Cannot perform requested operation on a debug flow.","architect.secure.call.flow.invalid.operation":"Cannot perform requested operation on a secure call flow.","architect.secure.call.flow.not.supported":"Secure call flows are not supported by the current product levels."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.not.locked.by.user":"Flow is not locked by requesting user.","architect.flow.already.exists":"A flow of the specified type with the specified name already exists."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.object.update.failed":"The database update for the object failed.","architect.external.user.query.error":"Failed querying backend service for information on user.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:edit"]},"x-purecloud-method-name":"putFlow"},"delete":{"tags":["Architect"],"summary":"Delete flow","description":"","operationId":"deleteFlow","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.flow.not.found":"Could not find flow with specified ID."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.inbound.short.message.flow.invalid.operation":"Cannot perform requested operation on an inbound short message flow.","architect.default.flow.cannot.delete":"Cannot delete the default in-queue flow.","architect.flow.cannot.delete.user.does.not.have.lock":"Flow cannot be deleted because it is locked by another user.","architect.debug.flow.invalid.operation":"Cannot perform requested operation on a debug flow.","architect.secure.call.flow.invalid.operation":"Cannot perform requested operation on a secure call flow.","architect.secure.call.flow.not.supported":"Secure call flows are not supported by the current product levels."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.cannot.delete.used.in.pe.action.maps":"Flow cannot be deleted due to being used by one or more predictive engagement action maps.","architect.flow.cannot.delete.used.in.ivr.configs":"Flow cannot be deleted due to being used by one or more IVR configurations.","architect.flow.cannot.delete.used.in.email.routes":"Flow cannot be deleted due to being used by one or more email routes.","architect.dependency.object.in.use":"The object cannot be deleted because other objects depend on it.","architect.flow.cannot.delete.used.in.widgets":"Flow cannot be deleted due to being used by one or more widgets.","architect.flow.cannot.delete.used.by.message.addresses":"Flow cannot be deleted due to being used by one or more message addresses.","architect.flow.cannot.delete.used.in.flows":"Flow cannot be deleted due to being used by one or more flows.","architect.flow.cannot.delete.used.in.recording.policies":"Flow cannot be deleted due to being used by one or more recording policies.","architect.flow.cannot.delete.used.in.queues":"Flow cannot be deleted due to being used by one or more queues.","architect.flow.cannot.delete.used.in.composer.scripts":"Flow cannot be deleted due to being used by one or more composer scripts.","architect.flow.cannot.delete.used.in.emergency.groups":"Flow cannot be deleted due to being used by one or more emergency groups."}},"410":{"description":"Gone","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.deleted":"Flow has been deleted."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.object.update.failed":"The database update for the object failed.","architect.external.flow.change.notification.error":"A backend service error occurred while sending out a flow change notification.","architect.external.call.failure":"A call to another backend service failed.","architect.external.user.query.error":"Failed querying backend service for information on user.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","architect.database.throughput.exceeded":"Database too busy. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:delete"]},"x-purecloud-method-name":"deleteFlow"}},"/api/v2/flows/{flowId}/latestconfiguration":{"get":{"tags":["Architect"],"summary":"Get the latest configuration for flow","description":"","operationId":"getFlowLatestconfiguration","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"},{"name":"deleted","in":"query","description":"Deleted flows","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"type":"object"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","flow.no.config.available":"Flow has no saved or checked-in configuration."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.inbound.short.message.flow.invalid.operation":"Cannot perform requested operation on an inbound short message flow.","architect.secure.call.flow.invalid.operation":"Cannot perform requested operation on a secure call flow.","architect.secure.call.flow.not.supported":"Secure call flows are not supported by the current product levels."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:view"]},"x-purecloud-method-name":"getFlowLatestconfiguration"}},"/api/v2/flows/{flowId}/history/{historyId}":{"get":{"tags":["Architect"],"summary":"Get generated flow history","description":"","operationId":"getFlowHistoryHistoryId","produces":["application/json"],"parameters":[{"name":"flowId","in":"path","description":"Flow ID","required":true,"type":"string"},{"name":"historyId","in":"path","description":"History request ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"desc"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"timestamp","enum":["action","timestamp","user"],"x-genesys-enum-members":[{"name":"action"},{"name":"timestamp"},{"name":"user"}]},{"name":"action","in":"query","description":"Flow actions to include (omit to include all)","required":false,"type":"array","items":{"type":"string","enum":["checkin","checkout","create","deactivate","debug","delete","publish","revert","save"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"checkin"},{"name":"checkout"},{"name":"create"},{"name":"deactivate"},{"name":"debug"},{"name":"delete"},{"name":"publish"},{"name":"revert"},{"name":"save"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/HistoryListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","architect.flow.not.found":"Could not find flow with specified ID."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:flow:view"]},"x-purecloud-method-name":"getFlowHistoryHistoryId"}},"/api/v2/outbound/contactlists/{contactListId}/contacts":{"post":{"tags":["Outbound"],"summary":"Add contacts to a contact list.","description":"","operationId":"postOutboundContactlistContacts","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Contact","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/WritableDialerContact"}}},{"name":"priority","in":"query","description":"Contact priority. True means the contact(s) will be dialed next; false means the contact will go to the end of the contact queue.","required":false,"type":"boolean"},{"name":"clearSystemData","in":"query","description":"Clear system data. True means the system columns (attempts, callable status, etc) stored on the contact will be cleared if the contact already exists; false means they won't.","required":false,"type":"boolean"},{"name":"doNotQueue","in":"query","description":"Do not queue. True means that updated contacts will not have their positions in the queue altered, so contacts that have already been dialed will not be redialed. For new contacts, this parameter has no effect; False means that updated contacts will be re-queued, according to the 'priority' parameter.","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/DialerContact"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.contacts.added":"Too many contacts added, the limit is 1000 per request","uploads.black.listed":"This organization has been prohibited from uploading contacts. Please contact support.","contact.missing.columns":"The contact is missing columns from its contact list.","invalid.contact.columns":"The contact columns are invalid.","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.create":"An attempt was made to create contacts in an invalid way","invalid.update":"An attempt was made to update contacts in an invalid way","invalid.contact.id":"The custom contactId field is not valid. It cannot contain special characters.","contact.column.length.limit.exceeded":"The length of each contact column must not exceed the limit.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","contact.missing.data":"The data field is required.","contact.columns.limit.exceeded":"Number of contact columns must not exceed the limit.","contact.datum.length.limit.exceeded":"The length of each piece of contact data must not exceed the limit.","contacts.per.org.limit.exceeded":"The organization has reached the limit on total contacts","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.error":"An internal service error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contact:add"]},"x-purecloud-method-name":"postOutboundContactlistContacts"},"delete":{"tags":["Outbound"],"summary":"Delete contacts from a contact list.","description":"","operationId":"deleteOutboundContactlistContacts","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"},{"name":"contactIds","in":"query","description":"ContactIds to delete.","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"Contacts Deleted."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.contacts.added":"There were too many contacts in the request, the limit is 250","invalid.contact.id":"One or more of the contacts was invalidly formed with non UTF-8 characters.","invalid.delete":"An attempt was made to delete contacts in an invalid way","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","no.contacts.specified":"There were no contacts specified in the request."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.list.not.found":"The contact list could not be found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contact:delete"]},"x-purecloud-method-name":"deleteOutboundContactlistContacts"}},"/api/v2/flows/datatables/{datatableId}/import/jobs":{"get":{"tags":["Architect"],"summary":"Get all recent import jobs","description":"Get all recent import jobs","operationId":"getFlowsDatatableImportJobs","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.table.not.found":"The specified datatableId was not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:edit"]},"x-purecloud-method-name":"getFlowsDatatableImportJobs"},"post":{"tags":["Architect"],"summary":"Begin an import process for importing rows into a datatable","description":"Create an import job for importing rows. The caller can then poll for status of the import using the token returned in the response","operationId":"postFlowsDatatableImportJobs","produces":["application/json"],"parameters":[{"name":"datatableId","in":"path","description":"id of datatable","required":true,"type":"string"},{"in":"body","name":"body","description":"import job information","required":true,"schema":{"$ref":"#/definitions/DataTableImportJob"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataTableImportJob"}},"202":{"description":"Request Accepted","schema":{"$ref":"#/definitions/DataTableImportJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.table.not.found":"The datatable could not be found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"flows.datatables.internal.server.error":"The operation failed in an unexpected way.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","flows.datatables.server.too.busy":"The operation failed because the service is too busy"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["architect:datatable:edit"]},"x-purecloud-method-name":"postFlowsDatatableImportJobs"}},"/api/v2/webchat/settings":{"get":{"tags":["WebChat"],"summary":"Get WebChat deployment settings","description":"","operationId":"getWebchatSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["web-chat","web-chat:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["webchat:deployment:read"]},"x-purecloud-method-name":"getWebchatSettings"},"put":{"tags":["WebChat"],"summary":"Update WebChat deployment settings","description":"","operationId":"putWebchatSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"webChatSettings","required":true,"schema":{"$ref":"#/definitions/WebChatSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["web-chat"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["webchat:deployment:update"]},"x-purecloud-method-name":"putWebchatSettings"},"delete":{"tags":["WebChat"],"summary":"Remove WebChat deployment settings","description":"","operationId":"deleteWebchatSettings","produces":["application/json"],"parameters":[],"responses":{"204":{"description":"Deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["web-chat"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["webchat:deployment:delete"]},"x-purecloud-method-name":"deleteWebchatSettings"}},"/api/v2/analytics/evaluations/aggregates/query":{"post":{"tags":["Quality","Analytics"],"summary":"Query for evaluation aggregates","description":"","operationId":"postAnalyticsEvaluationsAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/EvaluationAggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:evaluationAggregate:view"]},"x-purecloud-method-name":"postAnalyticsEvaluationsAggregatesQuery"}},"/api/v2/organizations/embeddedintegration":{"get":{"tags":["Organization"],"summary":"Get the list of domains that will be allowed to embed PureCloud applications","description":"","operationId":"getOrganizationsEmbeddedintegration","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmbeddedIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization","organization:readonly"]}],"x-purecloud-method-name":"getOrganizationsEmbeddedintegration"},"put":{"tags":["Organization"],"summary":"Update the list of domains that will be allowed to embed PureCloud applications","description":"","operationId":"putOrganizationsEmbeddedintegration","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Whitelist settings","required":true,"schema":{"$ref":"#/definitions/EmbeddedIntegration"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmbeddedIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["directory:organization:admin"]},"x-purecloud-method-name":"putOrganizationsEmbeddedintegration"}},"/api/v2/orgauthorization/trustees/{trusteeOrgId}":{"get":{"tags":["Organization Authorization"],"summary":"Get Org Trust","description":"","operationId":"getOrgauthorizationTrustee","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Trustee"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrustee:view"]},"x-purecloud-method-name":"getOrgauthorizationTrustee"},"put":{"tags":["Organization Authorization"],"summary":"Update Org Trust","description":"","operationId":"putOrgauthorizationTrustee","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Client","required":true,"schema":{"$ref":"#/definitions/Trustee"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Trustee"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrustee:edit"]},"x-purecloud-method-name":"putOrgauthorizationTrustee"},"delete":{"tags":["Organization Authorization"],"summary":"Delete Org Trust","description":"","operationId":"deleteOrgauthorizationTrustee","produces":["application/json"],"parameters":[{"name":"trusteeOrgId","in":"path","description":"Trustee Organization Id","required":true,"type":"string"}],"responses":{"204":{"description":"Trust deleted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:orgTrustee:delete"]},"x-purecloud-method-name":"deleteOrgauthorizationTrustee"}},"/api/v2/telephony/providers/edges/trunkswithrecording":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get Counts of trunks that have recording disabled or enabled","description":"","operationId":"getTelephonyProvidersEdgesTrunkswithrecording","produces":["application/json"],"parameters":[{"name":"trunkType","in":"query","description":"The type of this trunk base.","required":false,"type":"string","enum":["EXTERNAL","PHONE","EDGE"],"x-genesys-enum-members":[{"name":"EXTERNAL"},{"name":"PHONE"},{"name":"EDGE"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkRecordingEnabledCount"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:retentionPolicy:view","telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesTrunkswithrecording"}},"/api/v2/routing/email/setup":{"get":{"tags":["Routing"],"summary":"Get email setup","description":"","operationId":"getRoutingEmailSetup","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EmailSetup"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"getRoutingEmailSetup"}},"/api/v2/outbound/callabletimesets/{callableTimeSetId}":{"get":{"tags":["Outbound"],"summary":"Get callable time set","description":"","operationId":"getOutboundCallabletimeset","produces":["application/json"],"parameters":[{"name":"callableTimeSetId","in":"path","description":"Callable Time Set ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallableTimeSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:callableTimeSet:view"]},"x-purecloud-method-name":"getOutboundCallabletimeset"},"put":{"tags":["Outbound"],"summary":"Update callable time set","description":"","operationId":"putOutboundCallabletimeset","produces":["application/json"],"parameters":[{"name":"callableTimeSetId","in":"path","description":"Callable Time Set ID","required":true,"type":"string"},{"in":"body","name":"body","description":"DialerCallableTimeSet","required":true,"schema":{"$ref":"#/definitions/CallableTimeSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CallableTimeSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update":"","name.cannot.be.blank":"A name must be provided.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","duplicate.name":"The name already exists.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.start.time":"Start time must be before stop time.","invalid.time.zone":"Not recognized as a valid time zone.","missing.time.zone":"Each callable time must have a time zone identifier.","invalid.day":"Days must be within 1 - 7.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.wrong.version":""}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:callableTimeSet:edit"]},"x-purecloud-method-name":"putOutboundCallabletimeset"},"delete":{"tags":["Outbound"],"summary":"Delete callable time set","description":"","operationId":"deleteOutboundCallabletimeset","produces":["application/json"],"parameters":[{"name":"callableTimeSetId","in":"path","description":"Callable Time Set ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","referential.integrity.error":"Could not delete the resource because it is referenced by another entity.","callable.time.set.in.use":"The callable time set is in use."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:callableTimeSet:delete"]},"x-purecloud-method-name":"deleteOutboundCallabletimeset"}},"/api/v2/speechandtextanalytics/programs/{programId}":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get a Speech & Text Analytics program by id","description":"","operationId":"getSpeechandtextanalyticsProgram","produces":["application/json"],"parameters":[{"name":"programId","in":"path","description":"The id of the program","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Program"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"program.not.found":"The requested program could not be found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsProgram"},"put":{"tags":["Speech & Text Analytics"],"summary":"Update existing Speech & Text Analytics program","description":"","operationId":"putSpeechandtextanalyticsProgram","produces":["application/json"],"parameters":[{"name":"programId","in":"path","description":"The id of the program","required":true,"type":"string"},{"in":"body","name":"body","description":"The program to update","required":true,"schema":{"$ref":"#/definitions/ProgramRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Program"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"tags.limit.exceeded":"20 tags quota exceeded","bad.request":"Wrong request structure","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","topic.not.found":"The requested topic could not be found"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"program.not.found":"The requested program could not be found","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conflict":"A program with the same name already exists in this Org"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"resource.unavailable":"Resource unavailable","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:edit"]},"x-purecloud-method-name":"putSpeechandtextanalyticsProgram"},"delete":{"tags":["Speech & Text Analytics"],"summary":"Delete a Speech & Text Analytics program by id","description":"","operationId":"deleteSpeechandtextanalyticsProgram","produces":["application/json"],"parameters":[{"name":"programId","in":"path","description":"The id of the program","required":true,"type":"string"},{"name":"forceDelete","in":"query","description":"Indicates whether the program is forced to be deleted or not. Required when the program to delete is the default program.","required":false,"type":"boolean","default":false,"enum":["true","false"],"x-genesys-enum-members":[{"name":"true"},{"name":"false"}]}],"responses":{"204":{"description":"The program was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Default program deletion is not allowed","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:delete"]},"x-purecloud-method-name":"deleteSpeechandtextanalyticsProgram"}},"/api/v2/integrations/actions/{actionId}":{"get":{"tags":["Integrations"],"summary":"Retrieves a single Action matching id.","description":"","operationId":"getIntegrationsAction","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"name":"expand","in":"query","description":"Indicates a field in the response which should be expanded.","required":false,"type":"string","enum":["contract"],"x-genesys-enum-members":[{"name":"contract"}]},{"name":"includeConfig","in":"query","description":"Return config in response.","required":false,"type":"boolean","default":false,"enum":["true","false"],"x-genesys-enum-members":[{"name":"true"},{"name":"false"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Action"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:view","bridge:actions:view"]},"x-purecloud-method-name":"getIntegrationsAction"},"delete":{"tags":["Integrations"],"summary":"Delete an Action","description":"","operationId":"deleteIntegrationsAction","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"}],"responses":{"204":{"description":"Delete was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:delete"]},"x-purecloud-method-name":"deleteIntegrationsAction"},"patch":{"tags":["Integrations"],"summary":"Patch an Action","description":"","operationId":"patchIntegrationsAction","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"in":"body","name":"body","description":"Input used to patch the Action.","required":true,"schema":{"$ref":"#/definitions/UpdateActionInput"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Action"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:edit"]},"x-purecloud-method-name":"patchIntegrationsAction"}},"/api/v2/integrations/actions/{actionId}/test":{"post":{"tags":["Integrations"],"summary":"Test the execution of an action. Responses will show execution steps broken out with intermediate results to help in debugging.","description":"","operationId":"postIntegrationsActionTest","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"in":"body","name":"body","description":"Map of parameters used for variable substitution.","required":true,"schema":{"type":"object","additionalProperties":{"type":"object"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TestExecutionResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:execute","bridge:actions:execute"]},"x-purecloud-method-name":"postIntegrationsActionTest"}},"/api/v2/integrations/actions/{actionId}/schemas/{fileName}":{"get":{"tags":["Integrations"],"summary":"Retrieve schema for an action based on filename.","description":"","operationId":"getIntegrationsActionSchema","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"name":"fileName","in":"path","description":"Name of schema file to be retrieved for this action.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JsonSchemaDocument"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:view","bridge:actions:view"]},"x-purecloud-method-name":"getIntegrationsActionSchema"}},"/api/v2/integrations/actions/{actionId}/templates/{fileName}":{"get":{"tags":["Integrations"],"summary":"Retrieve text of templates for an action based on filename.","description":"","operationId":"getIntegrationsActionTemplate","produces":["text/plain"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"name":"fileName","in":"path","description":"Name of template file to be retrieved for this action.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"string"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:view","bridge:actions:view"]},"x-purecloud-method-name":"getIntegrationsActionTemplate"}},"/api/v2/integrations/actions/{actionId}/execute":{"post":{"tags":["Integrations"],"summary":"Execute Action and return response from 3rd party. Responses will follow the schemas defined on the Action for success and error.","description":"","operationId":"postIntegrationsActionExecute","produces":["application/json"],"parameters":[{"name":"actionId","in":"path","description":"actionId","required":true,"type":"string"},{"in":"body","name":"body","description":"Map of parameters used for variable substitution.","required":true,"schema":{"type":"object","additionalProperties":{"type":"object"}}}],"responses":{"200":{"description":"successful operation","schema":{"type":"object"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.substitution":"There was an issue substituting a value in one of the templates","no.results":"No results were found.","too.many.results":"Too many results matched criteria.","bad.request":"The 3rd party indicated an issue with the request","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.schema":"There was an issue validating the schema.","invalid.credentials":"There was an issue validating the credentials.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","bad.request":"The request is badly formed.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"method not allowed":"The request method is not allowed for this resource"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.substitution":"There was an issue substituting a value in one of the templates","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:action:execute","bridge:actions:execute"]},"x-purecloud-method-name":"postIntegrationsActionExecute"}},"/api/v2/telephony/providers/edges/sites/{siteId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Site by ID.","description":"","operationId":"getTelephonyProvidersEdgesSite","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Site"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Unable to find a site with that id","general.resource.not.found":"Unable to find a site with that id","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all","telephony:sites:view"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesSite"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a Site by ID.","description":"","operationId":"putTelephonyProvidersEdgesSite","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Site","required":true,"schema":{"$ref":"#/definitions/Site"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Site"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","referenced.key.does.not.exist":"The request could not be understood by the server due to malformed syntax.","managed.property.not.allowed":"Not allowed to update managed property","duplicate.value":"At least one of the values in the request were a duplicate.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","managed.property.not.allowed":"NEEDED"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Unable to find a site with that id","general.resource.not.found":"Unable to find a site with that id","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesSite"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a Site by ID","description":"","operationId":"deleteTelephonyProvidersEdgesSite","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","managed.property.not.allowed":"Not allowed to delete a managed site."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Unable to find a site with that id","general.resource.not.found":"Unable to find a site with that id","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"resource.referenced.by.another":"The site is referenced by another resource.","general.conflict":"The site is being referenced or is set as the default site."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdgesSite"}},"/api/v2/recording/mediaretentionpolicies/{policyId}":{"get":{"tags":["Recording"],"summary":"Get a media retention policy","description":"","operationId":"getRecordingMediaretentionpolicy","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Policy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:retentionPolicy:view"]},"x-purecloud-method-name":"getRecordingMediaretentionpolicy"},"put":{"tags":["Recording"],"summary":"Update a media retention policy","description":"","operationId":"putRecordingMediaretentionpolicy","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Policy","required":true,"schema":{"$ref":"#/definitions/Policy"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Policy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.media.policy.invalid":"One of the configured actions or conditions was invalid.","bad.request":"The request could not be understood by the server due to malformed syntax.","recording.policy.assign.evaluation.evaluator.permission.check.failed":"evaluator permission failure for evaluation","recording.policy.assign.calibration.evaluator.permission.check.failed":"Calibrator permission failure","recording.policy.export.integration.invalid":"The specified export integration is not a valid integration.","recording.policy.assign.metered.evaluation.evaluator.permission.check.failed":"evaluator permission failure for metered evaluation","recording.policy.calibrator.permission.fail":"General calibrator permission failure","recording.policy.export.integration.disabled":"The specified export integration is not in active state.","recording.policy.invalid.queue":"The specified queues was invalid.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","recording.policy.name.required":"Recording policy named required.","recording.policy.assign.survey.sending.domain.does.not.exist":"Sending domain does not exist in the organization","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.internal.server.error":"Internal server error updating policy.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:retentionPolicy:edit"]},"x-purecloud-method-name":"putRecordingMediaretentionpolicy"},"delete":{"tags":["Recording"],"summary":"Delete a media retention policy","description":"","operationId":"deleteRecordingMediaretentionpolicy","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"recording.policy.not.found":"The supplied policy was not found or is invalid","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:retentionPolicy:delete"]},"x-purecloud-method-name":"deleteRecordingMediaretentionpolicy"},"patch":{"tags":["Recording"],"summary":"Patch a media retention policy","description":"","operationId":"patchRecordingMediaretentionpolicy","produces":["application/json"],"parameters":[{"name":"policyId","in":"path","description":"Policy ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Policy","required":true,"schema":{"$ref":"#/definitions/Policy"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Policy"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:retentionPolicy:edit"]},"x-purecloud-method-name":"patchRecordingMediaretentionpolicy"}},"/api/v2/recording/localkeys/settings/{settingsId}":{"get":{"tags":["Recording"],"summary":"Get the local encryption settings","description":"","operationId":"getRecordingLocalkeysSetting","produces":["application/json"],"parameters":[{"name":"settingsId","in":"path","description":"Settings Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LocalEncryptionConfiguration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings","recordings:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:encryptionKey:view"]},"x-purecloud-method-name":"getRecordingLocalkeysSetting"},"put":{"tags":["Recording"],"summary":"Update the local encryption settings","description":"","operationId":"putRecordingLocalkeysSetting","produces":["application/json"],"parameters":[{"name":"settingsId","in":"path","description":"Settings Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Local Encryption metadata","required":true,"schema":{"$ref":"#/definitions/LocalEncryptionConfiguration"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LocalEncryptionConfiguration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["recordings"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:encryptionKey:edit"]},"x-purecloud-method-name":"putRecordingLocalkeysSetting"}},"/api/v2/authorization/subjects/rolecounts":{"get":{"tags":["Authorization"],"summary":"Get the count of roles granted to a list of subjects","description":"","operationId":"getAuthorizationSubjectsRolecounts","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"type":"object","additionalProperties":{"type":"object"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","max.subject.ids":"Only 100 subjects can be requested at a time.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:grant:view"]},"x-purecloud-method-name":"getAuthorizationSubjectsRolecounts"}},"/api/v2/analytics/transcripts/aggregates/query":{"post":{"tags":["Analytics"],"summary":"Query for transcript aggregates","description":"","operationId":"postAnalyticsTranscriptsAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"query","required":true,"schema":{"$ref":"#/definitions/TranscriptAggregationQuery"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TranscriptAggregateQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:speechAndTextAnalyticsAggregates:view"]},"x-purecloud-method-name":"postAnalyticsTranscriptsAggregatesQuery"}},"/api/v2/externalcontacts/relationships":{"post":{"tags":["External Contacts"],"summary":"Create a relationship","description":"","operationId":"postExternalcontactsRelationships","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Relationship","required":true,"schema":{"$ref":"#/definitions/Relationship"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Relationship"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided contact was not valid"}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:externalOrganization:edit"]},"x-purecloud-method-name":"postExternalcontactsRelationships"}},"/api/v2/architect/systemprompts/{promptId}/resources/{languageCode}":{"get":{"tags":["Architect"],"summary":"Get a system prompt resource.","description":"","operationId":"getArchitectSystempromptResource","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SystemPromptAsset"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.system.prompt.resource.not.found":"Could not find resource with specified language in specified system prompt.","architect.system.prompt.not.found":"Could not find system prompt with specified ID.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:systemPrompt:view"]},"x-purecloud-method-name":"getArchitectSystempromptResource"},"put":{"tags":["Architect"],"summary":"Updates a system prompt resource override.","description":"","operationId":"putArchitectSystempromptResource","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/SystemPromptAsset"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SystemPromptAsset"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.resource.invalid.tags":"The specified tags are in an invalid format.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","architect.object.validate.failed":"Failed to validate object.","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.system.prompt.resource.override.not.found":"Could not find resource override with specified language in specified system prompt.","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.resource.tags.already.exist":"The specified tags already exist in another prompt resource."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.object.update.failed":"The database update for the object failed.","architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:systemPrompt:edit"]},"x-purecloud-method-name":"putArchitectSystempromptResource"},"delete":{"tags":["Architect"],"summary":"Delete a system prompt resource override.","description":"","operationId":"deleteArchitectSystempromptResource","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.system.prompt.resource.cannot.delete.default":"Cannot delete the default resource for the specified language as that would leave that language without a default resource."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:systemPrompt:edit"]},"x-purecloud-method-name":"deleteArchitectSystempromptResource"}},"/api/v2/oauth/authorizations":{"get":{"tags":["OAuth"],"summary":"List clients that are authorized by the resource owner","description":"","operationId":"getOauthAuthorizations","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthAuthorizationListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:authorize"]},"x-purecloud-method-name":"getOauthAuthorizations"}},"/api/v2/workforcemanagement/businessunits":{"get":{"tags":["Workforce Management"],"summary":"Get business units","description":"","operationId":"getWorkforcemanagementBusinessunits","produces":["application/json"],"parameters":[{"name":"feature","in":"query","required":false,"type":"string","enum":["AgentSchedule","AgentTimeOffRequest","Coaching","ActivityCodes","Agents","BuActivityCodes","BusinessUnits","HistoricalAdherence","IntradayMonitoring","BuIntradayMonitoring","ManagementUnits","RealTimeAdherence","Schedules","BuSchedules","ServiceGoalTemplates","PlanningGroups","ShiftTrading","ShortTermForecasts","BuShortTermForecasts","TimeOffRequests","WorkPlanRotations","WorkPlans"],"x-genesys-enum-members":[{"name":"AgentSchedule"},{"name":"AgentTimeOffRequest"},{"name":"Coaching"},{"name":"ActivityCodes"},{"name":"Agents"},{"name":"BuActivityCodes"},{"name":"BusinessUnits"},{"name":"HistoricalAdherence"},{"name":"IntradayMonitoring"},{"name":"BuIntradayMonitoring"},{"name":"ManagementUnits"},{"name":"RealTimeAdherence"},{"name":"Schedules"},{"name":"BuSchedules"},{"name":"ServiceGoalTemplates"},{"name":"PlanningGroups"},{"name":"ShiftTrading"},{"name":"ShortTermForecasts"},{"name":"BuShortTermForecasts"},{"name":"TimeOffRequests"},{"name":"WorkPlanRotations"},{"name":"WorkPlans"}]},{"name":"divisionId","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BusinessUnitListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.server.error":"WFM Server Error","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-purecloud-method-name":"getWorkforcemanagementBusinessunits"},"post":{"tags":["Workforce Management"],"summary":"Add a new business unit","description":"It may take a minute or two for a new business unit to be available for api operations","operationId":"postWorkforcemanagementBusinessunits","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/CreateBusinessUnitRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BusinessUnit"}},"201":{"description":"The business unit was successfully created","schema":{"$ref":"#/definitions/BusinessUnit"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.server.error":"WFM Server Error","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:businessUnit:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunits"}},"/api/v2/analytics/reporting/timeperiods":{"get":{"tags":["Analytics"],"summary":"Get a list of report time periods.","description":"","operationId":"getAnalyticsReportingTimeperiods","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"type":"string"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-purecloud-method-name":"getAnalyticsReportingTimeperiods"}},"/api/v2/architect/systemprompts/{promptId}/resources":{"get":{"tags":["Architect"],"summary":"Get system prompt resources.","description":"","operationId":"getArchitectSystempromptResources","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"id"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SystemPromptAssetEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:systemPrompt:view"]},"x-purecloud-method-name":"getArchitectSystempromptResources"},"post":{"tags":["Architect"],"summary":"Create system prompt resource override.","description":"","operationId":"postArchitectSystempromptResources","produces":["application/json"],"parameters":[{"name":"promptId","in":"path","description":"Prompt ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/SystemPromptAsset"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SystemPromptAsset"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.resource.validate.failed.language":"Failed to validate prompt resource due to missing or invalid language.","architect.prompt.resource.invalid.tags":"The specified tags are in an invalid format.","architect.system.prompt.resource.lang.missing":"A language was not specified in the request.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","architect.object.validate.failed":"Failed to validate object.","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.resource.tags.already.exist":"The specified tags already exist in another prompt resource.","architect.system.prompt.resource.cannot.create.non.default":"Cannot create a non-default resource for the specified language because a default resource for that language doesn't exist. A default must be created first.","architect.system.prompt.resource.override.already.exists":"The specified system prompt already has an override for the specified language."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:systemPrompt:edit"]},"x-purecloud-method-name":"postArchitectSystempromptResources"}},"/api/v2/oauth/clients/{clientId}/secret":{"post":{"tags":["OAuth"],"summary":"Regenerate Client Secret","description":"This operation will set the client secret to a randomly generated cryptographically random value. All clients must be updated with the new secret. This operation should be used with caution.","operationId":"postOauthClientSecret","produces":["application/json"],"parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthClient"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:edit"]},"x-purecloud-method-name":"postOauthClientSecret"}},"/api/v2/oauth/clients/{clientId}":{"get":{"tags":["OAuth"],"summary":"Get OAuth Client","description":"","operationId":"getOauthClient","produces":["application/json"],"parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthClient"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","client.not.found":"Client was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:view"]},"x-purecloud-method-name":"getOauthClient"},"put":{"tags":["OAuth"],"summary":"Update OAuth Client","description":"","operationId":"putOauthClient","produces":["application/json"],"parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Client","required":true,"schema":{"$ref":"#/definitions/OAuthClientRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthClient"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.client.scope":"Client scope is missing.","bad.client.role":"Client role is invalid.","bad.client.state":"Client is disabled.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","bad.grant.type":"Invalid grant type.","missing.client.roles":"Client roles and divisions are missing.","grant.type.required":"Grant type is required.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","client.not.found":"Client was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:edit"]},"x-purecloud-method-name":"putOauthClient"},"delete":{"tags":["OAuth"],"summary":"Delete OAuth Client","description":"","operationId":"deleteOauthClient","produces":["application/json"],"parameters":[{"name":"clientId","in":"path","description":"Client ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","cannot.delete.client":"Clients must be marked as inactive to be eligible for deletion."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","client.not.found":"Client was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["oauth"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:delete"]},"x-purecloud-method-name":"deleteOauthClient"}},"/api/v2/telephony/providers/edges/phonebasesettings":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a list of Phone Base Settings objects","description":"","operationId":"getTelephonyProvidersEdgesPhonebasesettings","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Value by which to sort","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"expand","in":"query","description":"Fields to expand in the response, comma-separated","required":false,"type":"array","items":{"type":"string","enum":["properties","lines"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"properties"},{"name":"lines"}]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhoneBaseEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.organization.type":"Organization type is invalid.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Phone base not found.","general.resource.not.found":"Phone base not found.","not.found":"The requested resource was not found."}},"408":{"description":"Request Timeout","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unknown":"Unspecified error getting phone base settings."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.rate.limit":"Request rate limit exceeded.","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesPhonebasesettings"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a new Phone Base Settings object","description":"","operationId":"postTelephonyProvidersEdgesPhonebasesettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Phone base settings","required":true,"schema":{"$ref":"#/definitions/PhoneBase"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PhoneBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","webrtc.user.required":"A webRtc user is required.","base.settings.required":"A base setting is required.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesPhonebasesettings"}},"/api/v2/quality/keywordsets/{keywordSetId}":{"get":{"tags":["Quality"],"summary":"Get a keywordSet by id.","description":"","operationId":"getQualityKeywordset","produces":["application/json"],"parameters":[{"name":"keywordSetId","in":"path","description":"KeywordSet ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KeywordSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:keywordset:view"]},"x-purecloud-method-name":"getQualityKeywordset"},"put":{"tags":["Quality"],"summary":"Update a keywordSet to the specified keywordSet via PUT.","description":"","operationId":"putQualityKeywordset","produces":["application/json"],"parameters":[{"name":"keywordSetId","in":"path","description":"KeywordSet ID","required":true,"type":"string"},{"in":"body","name":"body","description":"keywordSet","required":true,"schema":{"$ref":"#/definitions/KeywordSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KeywordSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"qm.keyword.set.invalid.agent":"One of the agentIds is invalid","quality.keyword.limit.exceeded.for.agent":"Keyword Set keyword limit exceeded for agent","bad.request":"The request could not be understood by the server due to malformed syntax.","qm.keyword.set.invalid.queue":"One of the queueIds is invalid","qm.keyword.set.invalid.language":"Invalid language","quality.keyword.duplicate.phrase":"A Keyword phrase cannot be duplicated in keywords, anti-words or alternate spellings","quality.keyword.limit.exceeded.for.agent.and.queue":"Keyword Set keyword limit exceeded for agent and queue","quality.keyword.limit.exceeded":"Keyword Set keyword limit exceeded","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","quality.keyword.limit.exceeded.for.queue":"Keyword Set keyword limit exceeded for queue","qm.keyword.set.agent.or.queue.required":"A queue or agent is required for a valid Keyword Set","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:keywordset:edit"]},"x-purecloud-method-name":"putQualityKeywordset"},"delete":{"tags":["Quality"],"summary":"Delete a keywordSet by id.","description":"","operationId":"deleteQualityKeywordset","produces":["application/json"],"parameters":[{"name":"keywordSetId","in":"path","description":"KeywordSet ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["quality"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:keywordset:delete"]},"x-purecloud-method-name":"deleteQualityKeywordset"}},"/api/v2/authorization/roles":{"get":{"tags":["Authorization"],"summary":"Retrieve a list of all roles defined for the organization","description":"","operationId":"getAuthorizationRoles","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"The total page size requested","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"The page number requested","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"variable name requested to sort by","required":false,"type":"string"},{"name":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"nextPage","in":"query","description":"next page token","required":false,"type":"string"},{"name":"previousPage","in":"query","description":"Previous page token","required":false,"type":"string"},{"name":"name","in":"query","required":false,"type":"string"},{"name":"permission","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"defaultRoleId","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"userCount","in":"query","required":false,"type":"boolean","default":true},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OrganizationRoleEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"max.role.ids":"Only 100 roles can be requested at a time.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"The service is currently unavailable."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:view"]},"x-purecloud-method-name":"getAuthorizationRoles"},"post":{"tags":["Authorization"],"summary":"Create an organization role.","description":"","operationId":"postAuthorizationRoles","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Organization role","required":true,"schema":{"$ref":"#/definitions/DomainOrganizationRoleCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainOrganizationRole"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request is badly formed.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:role:add"]},"x-purecloud-method-name":"postAuthorizationRoles"}},"/api/v2/contentmanagement/workspaces":{"get":{"tags":["Content Management"],"summary":"Get a list of workspaces.","description":"Specifying 'content' access will return all workspaces the user has document access to, while 'admin' access will return all group workspaces the user has administrative rights to.","operationId":"getContentmanagementWorkspaces","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"access","in":"query","description":"Requested access level.","required":false,"type":"array","items":{"type":"string","enum":["content","admin","document:create","document:viewContent","document:viewMetadata","document:download","document:delete","document:update","document:share","document:shareView","document:email","document:print","document:auditView","document:replace","document:tag","tag:create","tag:view","tag:update","tag:apply","tag:remove","tag:delete"],"default":"document:viewmetadata"},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"content"},{"name":"admin"},{"name":"document:create"},{"name":"document:viewContent"},{"name":"document:viewMetadata"},{"name":"document:download"},{"name":"document:delete"},{"name":"document:update"},{"name":"document:share"},{"name":"document:shareView"},{"name":"document:email"},{"name":"document:print"},{"name":"document:auditView"},{"name":"document:replace"},{"name":"document:tag"},{"name":"tag:create"},{"name":"tag:view"},{"name":"tag:update"},{"name":"tag:apply"},{"name":"tag:remove"},{"name":"tag:delete"}]},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"array","items":{"type":"string","enum":["summary","acl"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"summary"},{"name":"acl"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkspaceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.workspace.access.fields":"Has invalid workspace fields.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementWorkspaces"},"post":{"tags":["Content Management"],"summary":"Create a group workspace","description":"","operationId":"postContentmanagementWorkspaces","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Workspace","required":true,"schema":{"$ref":"#/definitions/WorkspaceCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Workspace"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden to create a workspace."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management"]}],"x-purecloud-method-name":"postContentmanagementWorkspaces"}},"/api/v2/outbound/schedules/campaigns":{"get":{"tags":["Outbound"],"summary":"Query for a list of dialer campaign schedules.","description":"","operationId":"getOutboundSchedulesCampaigns","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/CampaignSchedule"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:schedule:view"]},"x-purecloud-method-name":"getOutboundSchedulesCampaigns"}},"/api/v2/outbound/campaignrules/{campaignRuleId}":{"get":{"tags":["Outbound"],"summary":"Get Campaign Rule","description":"","operationId":"getOutboundCampaignrule","produces":["application/json"],"parameters":[{"name":"campaignRuleId","in":"path","description":"Campaign Rule ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaignRule:view"]},"x-purecloud-method-name":"getOutboundCampaignrule"},"put":{"tags":["Outbound"],"summary":"Update Campaign Rule","description":"","operationId":"putOutboundCampaignrule","produces":["application/json"],"parameters":[{"name":"campaignRuleId","in":"path","description":"Campaign Rule ID","required":true,"type":"string"},{"in":"body","name":"body","description":"CampaignRule","required":true,"schema":{"$ref":"#/definitions/CampaignRule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CampaignRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"incorrect.max.value":"Max values must be > 0 and one of them must be defined","name.cannot.be.blank":"A name must be provided.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","missing.campaign.rule.conditions":"Campaign rule must have a condition.","invalid.campaign.rule.action.parameter":"Campaign rule action has an invalid parameter.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","missing.campaign.rule.condition.value":"Campaign rule condition must have an value.","missing.campaign.rule.entity":"Campaign rule must have an entity for conditions.","missing.campaign.rule.action.parameters":"Campaign rule action must have a parameter.","invalid.campaign.rule.condition.operator":"Campaign rule condition has an invalid operator.","cannot.modify.enabled.campaign.rule":"Cannot modify a rule that is enabled.","invalid.campaign.rule.condition.parameter":"Campaign rule condition has an invalid parameter.","missing.campaign.rule.condition.parameters":"Campaign rule condition must have a parameter.","missing.campaign.rule.action.type":"Campaign rule action must have a type.","missing.campaign.rule.condition.type":"Campaign rule condition must have a type.","invalid.external.campaign.dialingmode.transition":"Cannot change to/from external dialing mode to/from another dialing mode.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.campaign.rule.condition.value":"Campaign rule condition has an invalid value.","missing.campaign.rule.actions":"Campaign rule must have an action.","missing.campaign.rule.condition.operator":"Campaign rule condition must have an operator.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","missing.campaign.rule.action.entity":"Campaign rule must have an action entity."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.wrong.version":""}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaignRule:edit"]},"x-purecloud-method-name":"putOutboundCampaignrule"},"delete":{"tags":["Outbound"],"summary":"Delete Campaign Rule","description":"","operationId":"deleteOutboundCampaignrule","produces":["application/json"],"parameters":[{"name":"campaignRuleId","in":"path","description":"Campaign Rule ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","referential.integrity.error":"Could not delete the resource because it is referenced by another entity.","cannot.delete.enabled.campaign.rule":"Cannot delete a rule that is enabled."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","resource.not.found":"The resource could not be found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:campaignRule:delete"]},"x-purecloud-method-name":"deleteOutboundCampaignrule"}},"/api/v2/architect/schedules/{scheduleId}":{"get":{"tags":["Architect"],"summary":"Get a schedule by ID","description":"","operationId":"getArchitectSchedule","produces":["application/json"],"parameters":[{"name":"scheduleId","in":"path","description":"Schedule ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Schedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The specified scheduleId was not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:schedule:view"]},"x-purecloud-method-name":"getArchitectSchedule"},"put":{"tags":["Architect"],"summary":"Update schedule by ID","description":"","operationId":"putArchitectSchedule","produces":["application/json"],"parameters":[{"name":"scheduleId","in":"path","description":"Schedule ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Schedule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Schedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:schedule:edit"]},"x-purecloud-method-name":"putArchitectSchedule"},"delete":{"tags":["Architect"],"summary":"Delete a schedule by id","description":"","operationId":"deleteArchitectSchedule","produces":["application/json"],"parameters":[{"name":"scheduleId","in":"path","description":"Schedule ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The requested schedule could not be found.","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"The schedule could not be completed because it is assigned to one or more schedule groups."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["routing:schedule:delete"]},"x-purecloud-method-name":"deleteArchitectSchedule"}},"/api/v2/externalcontacts/organizations/schemas/{schemaId}/versions/{versionId}":{"get":{"tags":["External Contacts"],"summary":"Get a specific version of a schema","description":"","operationId":"getExternalcontactsOrganizationsSchemaVersion","produces":["application/json"],"parameters":[{"name":"schemaId","in":"path","description":"Schema ID","required":true,"type":"string"},{"name":"versionId","in":"path","description":"Schema version","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DataSchema"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:customFields:view"]},"x-purecloud-method-name":"getExternalcontactsOrganizationsSchemaVersion"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions":{"get":{"tags":["Conversations"],"summary":"Get a list of secure sessions for this participant.","description":"","operationId":"getConversationParticipantSecureivrsessions","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SecureSessionEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationParticipantSecureivrsessions"},"post":{"tags":["Conversations"],"summary":"Create secure IVR session. Only a participant in the conversation can invoke a secure IVR.","description":"","operationId":"postConversationParticipantSecureivrsessions","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/CreateSecureSession"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SecureSession"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationParticipantSecureivrsessions"}},"/api/v2/identityproviders/identitynow":{"get":{"tags":["Identity Provider"],"summary":"Get IdentityNow Provider","description":"","operationId":"getIdentityprovidersIdentitynow","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IdentityNow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersIdentitynow"},"put":{"tags":["Identity Provider"],"summary":"Update/Create IdentityNow Provider","description":"","operationId":"putIdentityprovidersIdentitynow","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/IdentityNow"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IdentityNow"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.issuer.uri":"An issuer URI is required.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.target.url":"The target URL must be a valid HTTPS URL.","certificate.not.yet.valid":"The certificate is not yet valid.","certificate.invalid.base64":"Invalid base64 in certificate.","certificate.unparseable":"The certificate for provider cannot be parsed.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersIdentitynow"},"delete":{"tags":["Identity Provider"],"summary":"Delete IdentityNow Provider","description":"","operationId":"deleteIdentityprovidersIdentitynow","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersIdentitynow"}},"/api/v2/outbound/contactlists":{"get":{"tags":["Outbound"],"summary":"Query a list of contact lists.","description":"","operationId":"getOutboundContactlists","produces":["application/json"],"parameters":[{"name":"includeImportStatus","in":"query","description":"Include import status","required":false,"type":"boolean","default":false},{"name":"includeSize","in":"query","description":"Include size","required":false,"type":"boolean","default":false},{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"allowEmptyResult","in":"query","description":"Whether to return an empty page when there are no results for that page","required":false,"type":"boolean","default":false},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"],"x-genesys-enum-members":[{"name":"Equals"},{"name":"RegEx"},{"name":"Contains"},{"name":"Prefix"},{"name":"LessThan"},{"name":"LessThanEqualTo"},{"name":"GreaterThan"},{"name":"GreaterThanEqualTo"},{"name":"BeginsWith"},{"name":"EndsWith"}]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"divisionId","in":"query","description":"Division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactListEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.bulk.retrieves":"Only 100 contact lists can be retrieved by id at a time","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.error":"An internal server error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactList:view"]},"x-purecloud-method-name":"getOutboundContactlists"},"post":{"tags":["Outbound"],"summary":"Create a contact List.","description":"","operationId":"postOutboundContactlists","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ContactList","required":true,"schema":{"$ref":"#/definitions/ContactList"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"contact.columns.dont.match":"Contact columns field and ordered contact columns field must match.","name.cannot.be.blank":"A name must be provided.","contact.columns.do.not.contain.phone.number.column":"","no.phone.columns":"","name.length.exceeded":"The name length exceeds the limit of 64 characters.","system.column.phone.column":"ContactList Phone column cannot be a system defined column name.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","invalid.create":"","not.unique.phone.columns":"Phone Number Columns contain duplicate values.","division.not.found":"The division could not be found.","no.contact.columns.defined":"There are no contact columns defined.","max.entity.count.reached":"The maximum contact list count has been reached.","phone.columns.limit.exceeded":"Number of phone columns must not exceed the limit.","contact.column.length.limit.exceeded":"The length of each contact column must not exceed the limit.","not.unique.contact.columns":"Contact Columns contains duplicate values.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","cannot.have.callable.time.column.with.automatic.time.zone.mapping":"The phone columns cannot reference callable time columns when automatic time zone mapping is being used","contact.columns.limit.exceeded":"Number of contact columns must not exceed the limit.","cannot.have.zip.code.column.without.automatic.time.zone.mapping":"The zip code column can only be used when automatic time zone mapping is also being used","invalid.contact.phone.column":"The contact phone columns are invalid.","invalid.zip.code.column":"The zip code column must be a column of the contact list and cannot be a phone column","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.error":"An internal server error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactList:add"]},"x-purecloud-method-name":"postOutboundContactlists"},"delete":{"tags":["Outbound"],"summary":"Delete multiple contact lists.","description":"","operationId":"deleteOutboundContactlists","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"contact list id(s) to delete","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"204":{"description":"Contact lists accepted for delete."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.deletes":"There were too many contact lists in the request.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bulk.delete.conflict":"Not all the requested contact lists could be deleted."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:contactList:delete"]},"x-purecloud-method-name":"deleteOutboundContactlists"}},"/api/v2/integrations/speech/dialogflow/agents":{"get":{"tags":["Integrations"],"summary":"Get a list of Dialogflow agents in the customers' Google accounts","description":"","operationId":"getIntegrationsSpeechDialogflowAgents","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"name","in":"query","description":"Filter on agent name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DialogflowAgentSummaryEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.forbidden":"Unauthorized to access of dialog flow agents.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechDialogflowAgents"}},"/api/v2/scripts/published/{scriptId}/pages":{"get":{"tags":["Scripts"],"summary":"Get the list of published pages","description":"","operationId":"getScriptsPublishedScriptIdPages","produces":["application/json"],"parameters":[{"name":"scriptId","in":"path","description":"Script ID","required":true,"type":"string"},{"name":"scriptDataVersion","in":"query","description":"Advanced usage - controls the data version of the script","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/Page"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:publishedScript:view"]},"x-purecloud-method-name":"getScriptsPublishedScriptIdPages"}},"/api/v2/telephony/providers/edges/sites":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of Sites.","description":"","operationId":"getTelephonyProvidersEdgesSites","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"location.id","in":"query","description":"Location Id","required":false,"type":"string"},{"name":"managed","in":"query","description":"Filter by managed","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SiteEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-purecloud-method-name":"getTelephonyProvidersEdgesSites"},"post":{"tags":["Telephony Providers Edge"],"summary":"Create a Site.","description":"","operationId":"postTelephonyProvidersEdgesSites","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Site","required":true,"schema":{"$ref":"#/definitions/Site"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Site"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","referenced.key.does.not.exist":"Unable to find entity that matches the key.","duplicate.value":"At least one of the values in the request were a duplicate.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesSites"}},"/api/v2/routing/queues/divisionviews":{"get":{"tags":["Routing"],"summary":"Get a paged listing of simplified queue objects, filterable by name, queue ID(s), or division ID(s).","description":"","operationId":"getRoutingQueuesDivisionviews","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size [max value is 100]","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number [max value is 5]","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name","enum":["name","id","divisionId"],"x-genesys-enum-members":[{"name":"name"},{"name":"id"},{"name":"divisionId"}]},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc","enum":["asc","desc","score"],"x-genesys-enum-members":[{"name":"asc"},{"name":"desc"},{"name":"score"}]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"id","in":"query","description":"Queue ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"divisionId","in":"query","description":"Division ID(s)","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/QueueEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","general.internal.server.error":"Internal server error getting paged listing of queue objects."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:queue:search"]},"x-purecloud-method-name":"getRoutingQueuesDivisionviews"}},"/api/v2/oauth/clients/{clientId}/usage/query/results/{executionId}":{"get":{"tags":["OAuth"],"summary":"Get the results of a usage query","description":"","operationId":"getOauthClientUsageQueryResult","produces":["application/json"],"parameters":[{"name":"executionId","in":"path","description":"ID of the query execution","required":true,"type":"string"},{"name":"clientId","in":"path","description":"Client ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ApiUsageQueryResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["oauth","oauth:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["oauth:client:view"]},"x-purecloud-method-name":"getOauthClientUsageQueryResult"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/adherence":{"get":{"tags":["Workforce Management"],"summary":"Get a list of user schedule adherence records for the requested management unit","description":"","operationId":"getWorkforcemanagementManagementunitAdherence","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The management unit ID of the management unit.","required":true,"type":"string"},{"name":"forceDownloadService","in":"query","description":"Force the result of this operation to be sent via download service. For testing/app development purposes","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserScheduleAdherenceListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:realtimeAdherence:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitAdherence"}},"/api/v2/ipranges":{"get":{"tags":["Utilities"],"summary":"Get public ip address ranges for PureCloud","description":"","operationId":"getIpranges","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IpAddressRangeListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":[]}],"x-purecloud-method-name":"getIpranges"}},"/api/v2/webchat/deployments":{"get":{"tags":["WebChat"],"summary":"List WebChat deployments","description":"","operationId":"getWebchatDeployments","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatDeploymentEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["web-chat","web-chat:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["webchat:deployment:read"]},"x-purecloud-method-name":"getWebchatDeployments"},"post":{"tags":["WebChat"],"summary":"Create WebChat deployment","description":"","operationId":"postWebchatDeployments","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Deployment","required":true,"schema":{"$ref":"#/definitions/WebChatDeployment"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatDeployment"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.deployments":"Too many deployments being handled","maximum.deployments.exceeded":"No more than 25 deployments allowed"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["web-chat"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["webchat:deployment:create"]},"x-purecloud-method-name":"postWebchatDeployments"}},"/api/v2/conversations/messaging/stickers/{messengerType}":{"get":{"tags":["Conversations"],"summary":"Get a list of Messaging Stickers","description":"","operationId":"getConversationsMessagingSticker","produces":["application/json"],"parameters":[{"name":"messengerType","in":"path","description":"Messenger Type","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MessagingStickerEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["conversation:message:create"]},"x-purecloud-method-name":"getConversationsMessagingSticker"}},"/api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions/{secureSessionId}":{"get":{"tags":["Conversations"],"summary":"Fetch info on a secure session","description":"","operationId":"getConversationParticipantSecureivrsession","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversation ID","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participant ID","required":true,"type":"string"},{"name":"secureSessionId","in":"path","description":"secure IVR session ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SecureSession"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationParticipantSecureivrsession"}},"/api/v2/webchat/guest/conversations":{"post":{"tags":["WebChat"],"summary":"Create an ACD chat conversation from an external customer.","description":"This endpoint will create a new ACD Chat conversation under the specified Chat Deployment.\n The conversation will begin with a guest member in it (with a role=CUSTOMER) according to the customer information that is supplied. If the guest member is authenticated, the 'memberAuthToken' field should include his JWT as generated by the 'POST /api/v2/signeddata' resource; if the guest member is anonymous (and the Deployment permits it) this field can be omitted.\n The returned data includes the IDs of the conversation created, along with a newly-create JWT token that you can supply to all future endpoints as authentication to perform operations against that conversation. After successfully creating a conversation, you should connect a websocket to the event stream named in the 'eventStreamUri' field of the response; the conversation is not routed until the event stream is attached.","operationId":"postWebchatGuestConversations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"CreateConversationRequest","required":true,"schema":{"$ref":"#/definitions/CreateWebChatConversationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CreateWebChatConversationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.notnull.createconversationrequest.journeycontext.customer":"The customer may not be null.","chat.error.notnull.createconversationrequest.journeycontext.customersession.sessionid":"The sessionid property may not be null.","chat.error.notnull.createconversationrequest.journeycontext.triggeringaction.actionmapversion":"The actionmapversion property may not be null.","chat.error.notnull.createconversationrequest.journeycontext.customersession.sessionidtype":"The sessionidtype property may not be null.","chat.deployment.bad.auth":"The customer member authentication has failed.","chat.error.notnull.createconversationrequest.journeycontext.triggeringaction.actionmapid":"The actionmapid property may not be null.","chat.error.invalid.queue":"The specified queue is not valid.","chat.error.notnull.createconversationrequest.journeycontext.triggeringaction.actionid":"The actionid property may not be null.","bad.request":"The request could not be understood by the server due to malformed syntax.","chat.error.createconversationrequest.routingtarget":"The routing target is not valid.","chat.error.notnull.createconversationrequest.journeycontext.customer.customerid":"The customerid property may not be null.","chat.deployment.disabled":"The web chat deployment is currently disabled.","chat.error.notnull.createconversationrequest.memberinfo.displayname":"The displayname property may not be null.","chat.error.pattern.createconversationrequest.deploymentid":"The deploymentid property may not be null.","chat.error.notnull.createconversationrequest.routingtarget":"The routingtarget property may not be null.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","chat.error.invalid.flow":"Invalid chat flow","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","chat.error.notnull.createconversationrequest.journeycontext.customer.customeridtype":"The customeridtype property may not be null.","chat.error.bad.request":"Error occurred due to invalid request.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","chat.deployment.require.auth":"The deployment requires the customer member to be authenticated."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"credentials.expired":"The supplied credentials are expired and cannot be used.","authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"origin.not.allowed":"Not allowed to create an ACD chat conversation from an external customer.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"caht.error":"Error performing chat conversation operation.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.service.timeout":"Chat service timeout error.","authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"x-purecloud-method-name":"postWebchatGuestConversations"}},"/api/v2/scripts":{"get":{"tags":["Scripts"],"summary":"Get the list of scripts","description":"","operationId":"getScripts","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"expand","in":"query","description":"Expand","required":false,"type":"string"},{"name":"name","in":"query","description":"Name filter","required":false,"type":"string"},{"name":"feature","in":"query","description":"Feature filter","required":false,"type":"string"},{"name":"flowId","in":"query","description":"Secure flow id filter","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"SortBy","required":false,"type":"string","enum":["modifiedDate","createdDate"],"x-genesys-enum-members":[{"name":"modifiedDate"},{"name":"createdDate"}]},{"name":"sortOrder","in":"query","description":"SortOrder","required":false,"type":"string","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]},{"name":"scriptDataVersion","in":"query","description":"Advanced usage - controls the data version of the script","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ScriptEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:script:view"]},"x-purecloud-method-name":"getScripts"}},"/api/v2/speechandtextanalytics/topics/publishjobs":{"post":{"tags":["Speech & Text Analytics"],"summary":"Create new Speech & Text Analytics publish topics job","description":"","operationId":"postSpeechandtextanalyticsTopicsPublishjobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The publish topics job to create","required":true,"schema":{"$ref":"#/definitions/TopicJobRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TopicJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"topics.limit.exceeded":"Limit of 50 topics to publish exceeded","bad.request":"Wrong request structure","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","topic.not.provided":"At least one Topic Id should be provided","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","topic.not.found":"The requested topic could not be found"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"resource.unavailable":"Resource unavailable","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:topic:publish"]},"x-purecloud-method-name":"postSpeechandtextanalyticsTopicsPublishjobs"}},"/api/v2/integrations/speech/tts/engines":{"get":{"tags":["Integrations"],"summary":"Get a list of TTS engines enabled for org","description":"","operationId":"getIntegrationsSpeechTtsEngines","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"includeVoices","in":"query","description":"Include voices for the engine","required":false,"type":"boolean","default":false},{"name":"name","in":"query","description":"Filter on engine name","required":false,"type":"string"},{"name":"language","in":"query","description":"Filter on supported language. If includeVoices=true then the voices are also filtered.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TtsEngineEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechTtsEngines"}},"/api/v2/conversations/messaging/integrations/twitter/{integrationId}":{"get":{"tags":["Conversations"],"summary":"Get a Twitter messaging integration","description":"","operationId":"getConversationsMessagingIntegrationsTwitterIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TwitterIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:view"]},"x-purecloud-method-name":"getConversationsMessagingIntegrationsTwitterIntegrationId"},"delete":{"tags":["Conversations"],"summary":"Delete a Twitter messaging integration","description":"","operationId":"deleteConversationsMessagingIntegrationsTwitterIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"}],"responses":{"204":{"description":"Operation was successful"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:delete"]},"x-purecloud-method-name":"deleteConversationsMessagingIntegrationsTwitterIntegrationId"},"patch":{"tags":["Conversations"],"summary":"Update Twitter messaging integration","description":"","operationId":"patchConversationsMessagingIntegrationsTwitterIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"},{"in":"body","name":"body","description":"TwitterIntegrationRequest","required":true,"schema":{"$ref":"#/definitions/TwitterIntegrationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TwitterIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.integration":"The integration request was invalid for this operation. One or more errors may be reported.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:edit"]},"x-purecloud-method-name":"patchConversationsMessagingIntegrationsTwitterIntegrationId"}},"/api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get an outbound route","description":"","operationId":"getTelephonyProvidersEdgesSiteOutboundroute","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"name":"outboundRouteId","in":"path","description":"Outbound route ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutboundRouteBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesSiteOutboundroute"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update outbound route","description":"","operationId":"putTelephonyProvidersEdgesSiteOutboundroute","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"name":"outboundRouteId","in":"path","description":"Outbound route ID","required":true,"type":"string"},{"in":"body","name":"body","description":"OutboundRoute","required":true,"schema":{"$ref":"#/definitions/OutboundRouteBase"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OutboundRouteBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"required.field.missing":"A required field is missing a value.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.value":"An outbound route with this name already exists.","address.classification.type.does.not.exist":"One of the address classifications does not exist.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.conflict":"Dependent entities exist."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesSiteOutboundroute"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete Outbound Route","description":"","operationId":"deleteTelephonyProvidersEdgesSiteOutboundroute","produces":["application/json"],"parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"type":"string"},{"name":"outboundRouteId","in":"path","description":"Outbound route ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdgesSiteOutboundroute"}},"/api/v2/analytics/reporting/exports/metadata":{"get":{"tags":["Analytics"],"summary":"Get all export metadata","description":"","operationId":"getAnalyticsReportingExportsMetadata","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportingExportMetadataJobListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["analytics:dataExport:view"]},"x-purecloud-method-name":"getAnalyticsReportingExportsMetadata"}},"/api/v2/orgauthorization/trustees/audits":{"post":{"tags":["Organization Authorization"],"summary":"Get Org Trustee Audits","description":"","operationId":"postOrgauthorizationTrusteesAudits","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"timestamp"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"descending"},{"in":"body","name":"body","description":"Values to scope the request.","required":true,"schema":{"$ref":"#/definitions/TrusteeAuditQueryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuditQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["organization-authorization","organization-authorization:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["authorization:audit:view"]},"x-purecloud-method-name":"postOrgauthorizationTrusteesAudits"}},"/api/v2/conversations/messaging/integrations/line":{"get":{"tags":["Conversations"],"summary":"Get a list of LINE messenger Integrations","description":"","operationId":"getConversationsMessagingIntegrationsLine","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LineIntegrationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging","messaging:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:view"]},"x-purecloud-method-name":"getConversationsMessagingIntegrationsLine"},"post":{"tags":["Conversations"],"summary":"Create a LINE messenger Integration","description":"","operationId":"postConversationsMessagingIntegrationsLine","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"LineIntegrationRequest","required":true,"schema":{"$ref":"#/definitions/LineIntegrationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LineIntegration"}},"202":{"description":"Accepted - If async is true, the integration creation in progress.","schema":{"$ref":"#/definitions/LineIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.integration":"The integration request was invalid for this operation. One or more errors may be reported.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["messaging"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["messaging:integration:add"]},"x-purecloud-method-name":"postConversationsMessagingIntegrationsLine"}},"/api/v2/externalcontacts/organizations/{externalOrganizationId}/notes/{noteId}":{"get":{"tags":["External Contacts"],"summary":"Fetch a note for an external organization","description":"","operationId":"getExternalcontactsOrganizationNote","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization Id","required":true,"type":"string"},{"name":"noteId","in":"path","description":"Note Id","required":true,"type":"string"},{"name":"expand","in":"query","description":"which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["author","externalDataSources"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"author"},{"name":"externalDataSources"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Note"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"entity.not.found":"Note is not found by note id.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts","external-contacts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:externalOrganization:view"]},"x-purecloud-method-name":"getExternalcontactsOrganizationNote"},"put":{"tags":["External Contacts"],"summary":"Update a note for an external organization","description":"","operationId":"putExternalcontactsOrganizationNote","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization Id","required":true,"type":"string"},{"name":"noteId","in":"path","description":"Note Id","required":true,"type":"string"},{"in":"body","name":"body","description":"Note","required":true,"schema":{"$ref":"#/definitions/Note"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Note"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided contact was not valid"}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:externalOrganization:edit"]},"x-purecloud-method-name":"putExternalcontactsOrganizationNote"},"delete":{"tags":["External Contacts"],"summary":"Delete a note for an external organization","description":"","operationId":"deleteExternalcontactsOrganizationNote","produces":["application/json"],"parameters":[{"name":"externalOrganizationId","in":"path","description":"External Organization Id","required":true,"type":"string"},{"name":"noteId","in":"path","description":"Note Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:externalOrganization:edit"]},"x-purecloud-method-name":"deleteExternalcontactsOrganizationNote"}},"/api/v2/outbound/rulesets":{"get":{"tags":["Outbound"],"summary":"Query a list of Rule Sets.","description":"","operationId":"getOutboundRulesets","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size. The max that will be returned is 100.","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"allowEmptyResult","in":"query","description":"Whether to return an empty page when there are no results for that page","required":false,"type":"boolean","default":false},{"name":"filterType","in":"query","description":"Filter type","required":false,"type":"string","default":"Prefix","enum":["Equals","RegEx","Contains","Prefix","LessThan","LessThanEqualTo","GreaterThan","GreaterThanEqualTo","BeginsWith","EndsWith"],"x-genesys-enum-members":[{"name":"Equals"},{"name":"RegEx"},{"name":"Contains"},{"name":"Prefix"},{"name":"LessThan"},{"name":"LessThanEqualTo"},{"name":"GreaterThan"},{"name":"GreaterThanEqualTo"},{"name":"BeginsWith"},{"name":"EndsWith"}]},{"name":"name","in":"query","description":"Name","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"a","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RuleSetEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:ruleSet:view"]},"x-purecloud-method-name":"getOutboundRulesets"},"post":{"tags":["Outbound"],"summary":"Create a Dialer Call Analysis Response Set.","description":"","operationId":"postOutboundRulesets","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"RuleSet","required":true,"schema":{"$ref":"#/definitions/RuleSet"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RuleSet"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.rule.action":"","name.cannot.be.blank":"A name must be provided.","name.length.exceeded":"The name length exceeds the limit of 64 characters.","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","invalid.create":"","invalid.rule.condition":"","data.action.not.found":"The requested data action could not be found","max.entity.count.reached":"The maximum rule set count has been reached.","rule.conflict":"Duplicated Rule IDs and/or names.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.rule.condition.category":"The condition is not valid for the given category.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.rule.action.category":"The action is not valid for the given category."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:ruleSet:add"]},"x-purecloud-method-name":"postOutboundRulesets"}},"/api/v2/routing/email/domains/{domainName}/routes":{"get":{"tags":["Routing"],"summary":"Get routes","description":"","operationId":"getRoutingEmailDomainRoutes","produces":["application/json"],"parameters":[{"name":"domainName","in":"path","description":"email domain","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pattern","in":"query","description":"Filter routes by the route's pattern property","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundRouteEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"getRoutingEmailDomainRoutes"},"post":{"tags":["Routing"],"summary":"Create a route","description":"","operationId":"postRoutingEmailDomainRoutes","produces":["application/json"],"parameters":[{"name":"domainName","in":"path","description":"email domain","required":true,"type":"string"},{"in":"body","name":"body","description":"Route","required":true,"schema":{"$ref":"#/definitions/InboundRoute"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/InboundRoute"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.max.routes.exceeded":"The maximum number of routes for the domain has been exceeded.","reply.route.id.required":"A route ID is required for the reply email address.","postino.max.autobcc.exceeded":"The maximum number of automatic bcc email addresses for the route has been exceeded.","bad.request":"The request could not be understood by the server due to malformed syntax.","postino.invalid.route":"The 'queue' and 'pattern' fields are required.","postino.error.not.found":"The resource could not be found.","postino.domain.exists":"The inbound domain already exists.","postino.error.bad.address":"Invalid email address. Check for invalid control or whitespace characters.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","bad.flow.id":"The flow is not eligible for use here.","postino.route.pattern.exists":"A route already exists for this domain with the specified pattern.","postino.error.queue.required":"A queue id or flow id is required.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.not.found":"The resource could not be found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:email:manage"]},"x-purecloud-method-name":"postRoutingEmailDomainRoutes"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings/{trainingId}":{"get":{"tags":["Knowledge"],"summary":"Get training detail","description":"","operationId":"getKnowledgeKnowledgebaseLanguageTraining","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","de-DE"],"x-genesys-enum-members":[{"name":"en-US"},{"name":"de-DE"}]},{"name":"trainingId","in":"path","description":"Training ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeTraining"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:training:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseLanguageTraining"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings/{trainingId}/promote":{"post":{"tags":["Knowledge"],"summary":"Promote trained documents from draft state to active.","description":"","operationId":"postKnowledgeKnowledgebaseLanguageTrainingPromote","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"languageCode","in":"path","description":"Language code, format: iso2-LOCALE","required":true,"type":"string","x-example":"en-US","enum":["en-US","de-DE"],"x-genesys-enum-members":[{"name":"en-US"},{"name":"de-DE"}]},{"name":"trainingId","in":"path","description":"Training ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeTraining"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["knowledge"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:training:edit"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseLanguageTrainingPromote"}},"/api/v2/identityproviders/onelogin":{"get":{"tags":["Identity Provider"],"summary":"Get OneLogin Identity Provider","description":"","operationId":"getIdentityprovidersOnelogin","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OneLogin"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers","identity-providers:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:view"]},"x-purecloud-method-name":"getIdentityprovidersOnelogin"},"put":{"tags":["Identity Provider"],"summary":"Update/Create OneLogin Identity Provider","description":"","operationId":"putIdentityprovidersOnelogin","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Provider","required":true,"schema":{"$ref":"#/definitions/OneLogin"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/OAuthProvider"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.issuer.uri":"An issuer URI is required.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","certificate.expired":"The certificate has expired.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.target.url":"The target URL must be a valid HTTPS URL.","certificate.not.yet.valid":"The certificate is not yet valid.","certificate.invalid.base64":"Invalid base64 in certificate.","certificate.unparseable":"The certificate for provider cannot be parsed.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:add","sso:provider:edit"]},"x-purecloud-method-name":"putIdentityprovidersOnelogin"},"delete":{"tags":["Identity Provider"],"summary":"Delete OneLogin Identity Provider","description":"","operationId":"deleteIdentityprovidersOnelogin","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["identity-providers"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["sso:provider:delete"]},"x-purecloud-method-name":"deleteIdentityprovidersOnelogin"}},"/api/v2/speechandtextanalytics/transcripts/search":{"post":{"tags":["Search","Speech & Text Analytics"],"summary":"Search resources.","description":"","operationId":"postSpeechandtextanalyticsTranscriptsSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/TranscriptSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JsonSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","too.many.search.requests":"Rate limit for search requests exceeded"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly","speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["analytics:conversationDetail:view","recording:recording:view"]},"x-purecloud-method-name":"postSpeechandtextanalyticsTranscriptsSearch"}},"/api/v2/architect/prompts":{"get":{"tags":["Architect"],"summary":"Get a pageable list of user prompts","description":"The returned list is pageable, and query parameters can be used for filtering. Multiple names can be specified, in which case all matching prompts will be returned, and no other filters will be evaluated.","operationId":"getArchitectPrompts","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"name","in":"query","description":"Name","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"description","in":"query","description":"Description","required":false,"type":"string"},{"name":"nameOrDescription","in":"query","description":"Name or description","required":false,"type":"string"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"id"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"asc"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PromptEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.external.call.failure":"A call to another backend service failed.","architect.unspecified.error":"An unspecified error has occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect","architect:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:view"]},"x-purecloud-method-name":"getArchitectPrompts"},"post":{"tags":["Architect"],"summary":"Create a new user prompt","description":"","operationId":"postArchitectPrompts","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Prompt"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Prompt"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.validate.failed.invalid.name":"Failed to validate prompt due to invalid name. Prompt names can only contain letters, numbers, and the underscore, and must start with a letter or number.","architect.prompt.resource.validate.failed.language":"Failed to validate prompt resource due to missing or invalid language.","architect.prompt.resource.invalid.tags":"The specified tags are in an invalid format.","bad.request":"The request could not be understood by the server due to malformed syntax.","architect.prompt.validate.failed":"Failed to validate prompt.","architect.object.validate.failed":"Failed to validate object.","architect.object.validate.failed.value":"Failed to validate object due to invalid field value.","architect.prompt.resource.validate.failed":"Failed to validate prompt resource.","architect.prompt.validate.failed.name.no.alpha":"Failed to validate prompt due to invalid name. Names must contain at least one alphanumeric character.","architect.prompt.validate.failed.missing.name":"Failed to validate prompt due to missing name.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.already.exists":"A prompt with the specified name already exists."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:add"]},"x-purecloud-method-name":"postArchitectPrompts"},"delete":{"tags":["Architect"],"summary":"Batch-delete a list of prompts","description":"Multiple IDs can be specified, in which case all specified prompts will be deleted. Asynchronous. Notification topic: v2.architect.prompts.{promptId}","operationId":"deleteArchitectPrompts","produces":["application/json"],"parameters":[{"name":"id","in":"query","description":"List of Prompt IDs","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Operation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.request.header.missing":"A required request header is missing or empty.","architect.batch.too.large":"Batch size exceeds the maximum allowable size.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","architect.batch.delete.failed":"At least one prompt could not be deleted as requested.","architect.query.parameter.missing":"A required query parameter is missing or empty."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","architect.not.editor.or.admin.user":"The requesting user does not have the required Architect editor or Architect admin permission.","architect.missing.permission":"You are not authorized to perform the requested action."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.prompt.not.found":"Could not find prompt with specified ID.","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.operation.already.in.progress":"An operation is already in progress on the object."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.unspecified.error":"An unknown error occurred.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["architect"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["architect:userPrompt:delete"]},"x-purecloud-method-name":"deleteArchitectPrompts"}},"/api/v2/routing/wrapupcodes":{"get":{"tags":["Routing"],"summary":"Get list of wrapup codes.","description":"","operationId":"getRoutingWrapupcodes","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string","default":"name","enum":["name","id"],"x-genesys-enum-members":[{"name":"name"},{"name":"id"}]},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ascending","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]},{"name":"name","in":"query","description":"Wrapup code's name ('Sort by' param is ignored unless this field is provided)","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapupCodeEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.page.number":"Invalid page number specified."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing","routing:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:wrapupCode:view"]},"x-purecloud-method-name":"getRoutingWrapupcodes"},"post":{"tags":["Routing"],"summary":"Create a wrap-up code","description":"","operationId":"postRoutingWrapupcodes","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"WrapupCode","required":true,"schema":{"$ref":"#/definitions/WrapupCode"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.name":"Invalid wrapup code name specified.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","duplicate.name":"A wrapup code with this name already exists.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"An internal server error occurred. Please try again."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["routing"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["routing:wrapupCode:add"]},"x-purecloud-method-name":"postRoutingWrapupcodes"}},"/api/v2/analytics/reporting/schedules":{"get":{"tags":["Analytics"],"summary":"Get a list of scheduled report jobs","description":"Get a list of scheduled report jobs.","operationId":"getAnalyticsReportingSchedules","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportScheduleEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-purecloud-method-name":"getAnalyticsReportingSchedules"},"post":{"tags":["Analytics"],"summary":"Create a scheduled report job","description":"Create a scheduled report job.","operationId":"postAnalyticsReportingSchedules","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ReportSchedule","required":true,"schema":{"$ref":"#/definitions/ReportSchedule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Forbidden to create a scheduled report job."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"scheduler.service.error":"A scheduler service error has occurred.","service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["reporting:acd:view, reporting:status:view, reporting:interactions:view, reporting:outbound:view, reporting:quality:view, employee"]},"x-purecloud-method-name":"postAnalyticsReportingSchedules"}},"/api/v2/integrations/speech/tts/engines/{engineId}/voices/{voiceId}":{"get":{"tags":["Integrations"],"summary":"Get details about a specific voice for a TTS engine","description":"","operationId":"getIntegrationsSpeechTtsEngineVoice","produces":["application/json"],"parameters":[{"name":"engineId","in":"path","description":"The engine ID","required":true,"type":"string"},{"name":"voiceId","in":"path","description":"The voice ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TtsVoiceEntity"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view"]},"x-purecloud-method-name":"getIntegrationsSpeechTtsEngineVoice"}},"/api/v2/outbound/dnclists/{dncListId}/export":{"get":{"tags":["Outbound"],"summary":"Get the URI of a DNC list export.","description":"","operationId":"getOutboundDnclistExport","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"},{"name":"download","in":"query","description":"Redirect to download uri","required":false,"type":"string","default":"false"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExportUri"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.not.found":"The do not call list could not be found.","no.available.list.export.uri":"There is no available download URI for the dnc list at this time.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:dnc:view","outbound:dncList:view"]},"x-purecloud-method-name":"getOutboundDnclistExport"},"post":{"tags":["Outbound"],"summary":"Initiate the export of a dnc list.","description":"Returns 200 if received OK.","operationId":"postOutboundDnclistExport","produces":["application/json"],"parameters":[{"name":"dncListId","in":"path","description":"DncList ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DomainEntityRef"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.import.in.progress":"The dnc list cannot be exported while it is being imported.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","dnc.list.export.in.progress":"An export is already in progress for this dnc list.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"dnc.list.not.found":"The dnc list could not be found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["outbound:dnc:view","outbound:dncList:view"]},"x-purecloud-method-name":"postOutboundDnclistExport"}},"/api/v2/locations":{"get":{"tags":["Locations"],"summary":"Get a list of all locations.","description":"","operationId":"getLocations","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"id","in":"query","description":"id","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","enum":["asc","desc"],"x-genesys-enum-members":[{"name":"asc"},{"name":"desc"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LocationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"Unable to get a location due to invalid request.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["locations","locations:readonly"]}],"x-purecloud-method-name":"getLocations"},"post":{"tags":["Locations"],"summary":"Create a location","description":"","operationId":"postLocations","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Location","required":true,"schema":{"$ref":"#/definitions/LocationCreateDefinition"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LocationDefinition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"Unable to create a location due to invalid request.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["locations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["directory:location:add"]},"x-purecloud-method-name":"postLocations"}},"/api/v2/speechandtextanalytics/topics/{topicId}":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get a Speech & Text Analytics topic by id","description":"","operationId":"getSpeechandtextanalyticsTopic","produces":["application/json"],"parameters":[{"name":"topicId","in":"path","description":"The id of the topic","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Topic"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","topic.not.found":"The requested topic could not be found"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:topic:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsTopic"},"put":{"tags":["Speech & Text Analytics"],"summary":"Update existing Speech & Text Analytics topic","description":"","operationId":"putSpeechandtextanalyticsTopic","produces":["application/json"],"parameters":[{"name":"topicId","in":"path","description":"The id of the topic","required":true,"type":"string"},{"in":"body","name":"body","description":"The topic to update","required":true,"schema":{"$ref":"#/definitions/TopicRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Topic"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"phrases.limit.exceeded":"1000 phrases quota exceeded","program.not.found":"The requested program could not be found","tags.limit.exceeded":"20 tags quota exceeded","topics.limit.exceeded":"500 topics quota exceeded","bad.request":"Wrong request structure","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","updating.dialect.is.forbidden":"Updating dialect is forbidden","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","topic.not.found":"The requested topic could not be found"}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conflict":"Topic with the same name and dialect already exists in this Org"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"resource.unavailable":"Resource unavailable","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:topic:edit"]},"x-purecloud-method-name":"putSpeechandtextanalyticsTopic"},"delete":{"tags":["Speech & Text Analytics"],"summary":"Delete a Speech & Text Analytics topic by id","description":"","operationId":"deleteSpeechandtextanalyticsTopic","produces":["application/json"],"parameters":[{"name":"topicId","in":"path","description":"The id of the topic","required":true,"type":"string"}],"responses":{"204":{"description":"The topic was deleted successfully"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:topic:delete"]},"x-purecloud-method-name":"deleteSpeechandtextanalyticsTopic"}},"/api/v2/webchat/guest/conversations/{conversationId}/mediarequests":{"get":{"tags":["WebChat"],"summary":"Get all media requests to the guest in the conversation","description":"","operationId":"getWebchatGuestConversationMediarequests","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WebChatGuestMediaRequestEntityList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"Guest Chat JWT":[]}],"x-purecloud-method-name":"getWebchatGuestConversationMediarequests"}},"/api/v2/quality/publishedforms/{formId}":{"get":{"tags":["Quality"],"summary":"Get the published evaluation forms.","description":"","operationId":"getQualityPublishedform","produces":["application/json"],"parameters":[{"name":"formId","in":"path","description":"Form ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EvaluationForm"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found.","evaluation.not.found":"Requested formId not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["quality","quality:readonly"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["quality:evaluationForm:view"]},"x-purecloud-method-name":"getQualityPublishedform"}},"/api/v2/telephony/providers/edges/trunks/{trunkId}/metrics":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the trunk metrics.","description":"","operationId":"getTelephonyProvidersEdgesTrunkMetrics","produces":["application/json"],"parameters":[{"name":"trunkId","in":"path","description":"Trunk Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkMetrics"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find the trunk metrics with that id.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesTrunkMetrics"}},"/api/v2/integrations/eventlog/{eventId}":{"get":{"tags":["Integrations"],"summary":"Get a single event","description":"","operationId":"getIntegrationsEventlogEventId","produces":["application/json"],"parameters":[{"name":"eventId","in":"path","description":"Event Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/IntegrationEvent"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["integrations","integrations:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["integrations:integration:view","bridge:notification:view"]},"x-purecloud-method-name":"getIntegrationsEventlogEventId"}},"/api/v2/fax/documents":{"get":{"tags":["Fax"],"summary":"Get a list of fax documents.","description":"","operationId":"getFaxDocuments","produces":["application/json"],"parameters":[{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/FaxDocumentEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Access to a list of fax documents is not permitted."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["fax","fax:readonly"]}],"x-purecloud-method-name":"getFaxDocuments"}},"/api/v2/coaching/appointments":{"get":{"tags":["Coaching"],"summary":"Get appointments for users and optional date range","description":"","operationId":"getCoachingAppointments","produces":["application/json"],"parameters":[{"name":"userIds","in":"query","description":"The user IDs for which to retrieve appointments","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"interval","in":"query","description":"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","required":false,"type":"string","format":"interval"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"statuses","in":"query","description":"Appointment Statuses to filter by","required":false,"type":"array","items":{"type":"string","enum":["Scheduled","InProgress","Completed","InvalidSchedule"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"Scheduled"},{"name":"InProgress"},{"name":"Completed"},{"name":"InvalidSchedule"}]},{"name":"facilitatorIds","in":"query","description":"The facilitator IDs for which to retrieve appointments","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"sortOrder","in":"query","description":"Sort (by due date) either Asc or Desc","required":false,"type":"string","enum":["Desc","Asc"],"x-genesys-enum-members":[{"name":"Desc"},{"name":"Asc"}]},{"name":"relationships","in":"query","description":"Relationships to filter by","required":false,"type":"array","items":{"type":"string","enum":["Creator","Facilitator","Attendee"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"Creator"},{"name":"Facilitator"},{"name":"Attendee"}]},{"name":"completionInterval","in":"query","description":"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","required":false,"type":"string","format":"interval"},{"name":"overdue","in":"query","description":"Overdue status to filter by","required":false,"type":"string","enum":["True","False","Any"],"x-genesys-enum-members":[{"name":"True"},{"name":"False"},{"name":"Any"}]}],"responses":{"200":{"description":"Get users coaching appointments successful","schema":{"$ref":"#/definitions/CoachingAppointmentResponseList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"interval.query.param":"Start date of the interval cannot be greater than the end date","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","users.query.param":"User list cannot be empty or greater than 100 when querying for appointments","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","no.appointment.view.permission":"No permission to view appointments","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching","coaching:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:appointment:view"]},"x-purecloud-method-name":"getCoachingAppointments"},"post":{"tags":["Coaching"],"summary":"Create a new appointment","description":"","operationId":"postCoachingAppointments","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The appointment to add","required":true,"schema":{"$ref":"#/definitions/CreateCoachingAppointmentRequest"}}],"responses":{"201":{"description":"Appointment created","schema":{"$ref":"#/definitions/CoachingAppointmentResponse"}},"202":{"description":"Appointment create request accepted","schema":{"$ref":"#/definitions/CoachingAppointmentReference"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"participate.permission.missing":"Some participants are missing the 'coaching:appointment:participate' permission.","validation.error":"Error validating the appointment.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"appointment.conflict":"Appointment dates clashes with another"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["coaching"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["coaching:appointment:add"]},"x-purecloud-method-name":"postCoachingAppointments"}},"/api/v2/responsemanagement/libraries/{libraryId}":{"get":{"tags":["Response Management"],"summary":"Get details about an existing response library.","description":"","operationId":"getResponsemanagementLibrary","produces":["application/json"],"parameters":[{"name":"libraryId","in":"path","description":"Library ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Library"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"rms.library.not.found":"The response library could not be found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management","response-management:readonly"]}],"x-purecloud-method-name":"getResponsemanagementLibrary"},"put":{"tags":["Response Management"],"summary":"Update an existing response library.","description":"Fields that can be updated: name. The most recent version is required for updates.","operationId":"putResponsemanagementLibrary","produces":["application/json"],"parameters":[{"name":"libraryId","in":"path","description":"Library ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Library","required":true,"schema":{"$ref":"#/definitions/Library"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Library"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"409":{"description":"Resource conflict - Unexpected version was provided"},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["response-management"]}],"x-purecloud-method-name":"putResponsemanagementLibrary"},"delete":{"tags":["Response Management"],"summary":"Delete an existing response library.","description":"This will remove any responses associated with the library.","operationId":"deleteResponsemanagementLibrary","produces":["application/json"],"parameters":[{"name":"libraryId","in":"path","description":"Library ID","required":true,"type":"string"}],"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}},"default":{"description":"successful operation"}},"security":[{"PureCloud OAuth":["response-management"]}],"x-purecloud-method-name":"deleteResponsemanagementLibrary"}},"/api/v2/analytics/reporting/schedules/{scheduleId}":{"get":{"tags":["Analytics"],"summary":"Get a scheduled report job.","description":"","operationId":"getAnalyticsReportingSchedule","produces":["application/json"],"parameters":[{"name":"scheduleId","in":"path","description":"Schedule ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-purecloud-method-name":"getAnalyticsReportingSchedule"},"put":{"tags":["Analytics"],"summary":"Update a scheduled report job.","description":"","operationId":"putAnalyticsReportingSchedule","produces":["application/json"],"parameters":[{"name":"scheduleId","in":"path","description":"Schedule ID","required":true,"type":"string"},{"in":"body","name":"body","description":"ReportSchedule","required":true,"schema":{"$ref":"#/definitions/ReportSchedule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["reporting:acd:view, reporting:status:view, reporting:interactions:view, reporting:outbound:view, reporting:quality:view, employee"]},"x-purecloud-method-name":"putAnalyticsReportingSchedule"},"delete":{"tags":["Analytics"],"summary":"Delete a scheduled report job.","description":"","operationId":"deleteAnalyticsReportingSchedule","produces":["application/json"],"parameters":[{"name":"scheduleId","in":"path","description":"Schedule ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics"]}],"x-purecloud-method-name":"deleteAnalyticsReportingSchedule"}},"/api/v2/analytics/reporting/schedules/{scheduleId}/history":{"get":{"tags":["Analytics"],"summary":"Get list of completed scheduled report jobs.","description":"","operationId":"getAnalyticsReportingScheduleHistory","produces":["application/json"],"parameters":[{"name":"scheduleId","in":"path","description":"Schedule ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportRunEntryEntityDomainListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-purecloud-method-name":"getAnalyticsReportingScheduleHistory"}},"/api/v2/analytics/reporting/schedules/{scheduleId}/history/latest":{"get":{"tags":["Analytics"],"summary":"Get most recently completed scheduled report job.","description":"","operationId":"getAnalyticsReportingScheduleHistoryLatest","produces":["application/json"],"parameters":[{"name":"scheduleId","in":"path","description":"Schedule ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ReportRunEntry"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["analytics","analytics:readonly"]}],"x-purecloud-method-name":"getAnalyticsReportingScheduleHistoryLatest"}},"/api/v2/scripts/uploads/{uploadId}/status":{"get":{"tags":["Scripts"],"summary":"Get the upload status of an imported script","description":"","operationId":"getScriptsUploadStatus","produces":["application/json"],"parameters":[{"name":"uploadId","in":"path","description":"Upload ID","required":true,"type":"string"},{"name":"longPoll","in":"query","description":"Enable longPolling endpoint","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ImportScriptStatusResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["scripts","scripts:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["scripter:script:view"]},"x-purecloud-method-name":"getScriptsUploadStatus"}},"/api/v2/speechandtextanalytics/programs/publishjobs":{"post":{"tags":["Speech & Text Analytics"],"summary":"Create new Speech & Text Analytics publish programs job","description":"","operationId":"postSpeechandtextanalyticsProgramsPublishjobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The publish programs job to create","required":true,"schema":{"$ref":"#/definitions/ProgramJobRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ProgramJob"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"program.not.found":"The requested program could not be found","programs.limit.exceeded":"Limit of 10 programs to publish exceeded","bad.request":"Wrong request structure","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","program.not.provided":"At least one Program Id should be provided","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"resource.unavailable":"Resource unavailable","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:publish"]},"x-purecloud-method-name":"postSpeechandtextanalyticsProgramsPublishjobs"}},"/api/v2/conversations/chats":{"get":{"tags":["Conversations"],"summary":"Get active chat conversations for the logged in user","description":"","operationId":"getConversationsChats","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatConversationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsChats"},"post":{"tags":["Conversations"],"summary":"Create a web chat conversation","description":"","operationId":"postConversationsChats","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Create web chat request","required":true,"schema":{"$ref":"#/definitions/CreateWebChatRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"chat.error.notnull.createconversationrequest.provider":"The provider property may not be null.","chat.error.queue.not.found":"The queue does not exist.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","chat.error.notnull.createconversationrequest.queueid":"The queueId property may not be null.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["conversation:webchat:create"]},"x-purecloud-method-name":"postConversationsChats"}},"/api/v2/conversations/chats/{conversationId}/participants/{participantId}/wrapupcodes":{"get":{"tags":["Conversations"],"summary":"Get list of wrapup codes for this conversation participant","description":"","operationId":"getConversationsChatParticipantWrapupcodes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsChatParticipantWrapupcodes"}},"/api/v2/conversations/chats/{conversationId}/participants/{participantId}/attributes":{"patch":{"tags":["Conversations"],"summary":"Update the attributes on a conversation participant.","description":"","operationId":"patchConversationsChatParticipantAttributes","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant attributes","required":true,"schema":{"$ref":"#/definitions/ParticipantAttributes"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.participant.not.found":"Participant does not exist.","conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsChatParticipantAttributes"}},"/api/v2/conversations/chats/{conversationId}":{"get":{"tags":["Conversations"],"summary":"Get chat conversation","description":"","operationId":"getConversationsChat","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatConversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsChat"},"patch":{"tags":["Conversations"],"summary":"Update a conversation by disconnecting all of the participants","description":"","operationId":"patchConversationsChat","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Conversation","required":true,"schema":{"$ref":"#/definitions/Conversation"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Conversation"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["conversation:communication:disconnect"]},"x-purecloud-method-name":"patchConversationsChat"}},"/api/v2/conversations/chats/{conversationId}/participants/{participantId}/wrapup":{"get":{"tags":["Conversations"],"summary":"Get the wrap-up for this conversation participant. ","description":"","operationId":"getConversationsChatParticipantWrapup","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"provisional","in":"query","description":"Indicates if the wrap-up code is provisional.","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssignedWrapupCode"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations","conversations:readonly"]}],"x-purecloud-method-name":"getConversationsChatParticipantWrapup"}},"/api/v2/conversations/chats/{conversationId}/participants/{participantId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant","description":"","operationId":"patchConversationsChatParticipant","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Update request","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.participant.update.invalid":"Failed to update all properties on conversation participant.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","conversation.error.wrapup.code.required":"Wrapup code is a required field and cannot be empty.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","conversation.error.wrapup.cannot.skip":"Wrap-up cannot be skipped for this participant.","conversation.error.participant.no.active.conversations":"The participant has no active conversation."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","not.found":"The requested resource was not found.","conversation.error.not.conversation.participant":"User is not a participant in the conversation."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.participant.update.failed":"Failed to update all properties on conversation participant.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsChatParticipant"}},"/api/v2/conversations/chats/{conversationId}/participants/{participantId}/communications/{communicationId}":{"patch":{"tags":["Conversations"],"summary":"Update conversation participant's communication by disconnecting it.","description":"","operationId":"patchConversationsChatParticipantCommunication","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"name":"communicationId","in":"path","description":"communicationId","required":true,"type":"string"},{"in":"body","name":"body","description":"Participant","required":true,"schema":{"$ref":"#/definitions/MediaParticipantRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"communication.state.required":"Can only update a communication's state to disconnected.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"patchConversationsChatParticipantCommunication"}},"/api/v2/conversations/chats/{conversationId}/participants/{participantId}/replace":{"post":{"tags":["Conversations"],"summary":"Replace this participant with the specified user and/or address","description":"","operationId":"postConversationsChatParticipantReplace","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"conversationId","required":true,"type":"string"},{"name":"participantId","in":"path","description":"participantId","required":true,"type":"string"},{"in":"body","name":"body","description":"Transfer request","required":true,"schema":{"$ref":"#/definitions/TransferRequest"}}],"responses":{"202":{"description":"Accepted"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversations.error.transfer.same.party":"The target of the transfer cannot be the same as the destination.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","conversations.error.queue.not.found":"Interaction cannot be transferred to a queue that does not exist.","conversations.error.transfer.not.connected":"You can only transfer conversations that are in the connected state.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","conversation.error.forbidden.not.active.participant":"User is not active on call and cannot alter recordingState"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"conversation.error.conversation.not.found":"The conversation does not exist.","conversation.error.participant.not.found":"Participant does not exist.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["conversations"]}],"x-purecloud-method-name":"postConversationsChatParticipantReplace"}},"/api/v2/telephony/providers/edges/phones/{phoneId}":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get a Phone by ID","description":"","operationId":"getTelephonyProvidersEdgesPhone","produces":["application/json"],"parameters":[{"name":"phoneId","in":"path","description":"Phone ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Phone"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"Request is badly formed.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to find the phone with that Id.","not.found":"The requested resource was not found."}},"408":{"description":"Request Timeout","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unknown":"Unspecified error find phone with that Id."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.rate.limit":"Request rate limit exceeded.","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesPhone"},"put":{"tags":["Telephony Providers Edge"],"summary":"Update a Phone by ID","description":"","operationId":"putTelephonyProvidersEdgesPhone","produces":["application/json"],"parameters":[{"name":"phoneId","in":"path","description":"Phone ID","required":true,"type":"string"},{"in":"body","name":"body","description":"Phone","required":true,"schema":{"$ref":"#/definitions/Phone"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Phone"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.bad.request":"The request could not be understood by the server due to malformed syntax.","webrtc.user.required":"A webRtcUser is required.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to update Phone with that id.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesPhone"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Delete a Phone by ID","description":"","operationId":"deleteTelephonyProvidersEdgesPhone","produces":["application/json"],"parameters":[{"name":"phoneId","in":"path","description":"Phone ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","general.bad.request":"The request could not be understood by the server due to malformed syntax."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"Unable to delete Phone with that id.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdgesPhone"}},"/api/v2/telephony/providers/edges/{edgeId}/trunks":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list of available trunks for the given Edge.","description":"Trunks are created by assigning trunk base settings to an Edge or Edge Group.","operationId":"getTelephonyProvidersEdgeTrunks","produces":["application/json"],"parameters":[{"name":"edgeId","in":"path","description":"Edge ID","required":true,"type":"string"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"Value by which to sort","required":false,"type":"string","default":"name"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"trunkBase.id","in":"query","description":"Filter by Trunk Base Ids","required":false,"type":"string"},{"name":"trunkType","in":"query","description":"Filter by a Trunk type","required":false,"type":"string","enum":["EXTERNAL","PHONE","EDGE"],"x-genesys-enum-members":[{"name":"EXTERNAL"},{"name":"PHONE"},{"name":"EDGE"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrunkEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","general.resource.not.found":"Specified edgeId not found.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all"]},"x-purecloud-method-name":"getTelephonyProvidersEdgeTrunks"}},"/api/v2/speechandtextanalytics/programs/unpublished":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get the list of Speech & Text Analytics unpublished programs","description":"","operationId":"getSpeechandtextanalyticsProgramsUnpublished","produces":["application/json"],"parameters":[{"name":"nextPage","in":"query","description":"The key for listing the next page","required":false,"type":"string"},{"name":"pageSize","in":"query","description":"The page size for the listing","required":false,"type":"integer","default":20,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UnpublishedProgramsEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"page.not.found":"The requested page could not be found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:program:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsProgramsUnpublished"}},"/api/v2/contentmanagement/documents/{documentId}/audits":{"get":{"tags":["Content Management"],"summary":"Get a list of audits for a document.","description":"","operationId":"getContentmanagementDocumentAudits","produces":["application/json"],"parameters":[{"name":"documentId","in":"path","description":"Document ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"transactionFilter","in":"query","description":"Transaction filter","required":false,"type":"string"},{"name":"level","in":"query","description":"level","required":false,"type":"string","default":"USER"},{"name":"sortBy","in":"query","description":"Sort by","required":false,"type":"string"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ascending"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentAuditEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","forbidden":"Unable to access document listing."}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["content-management","content-management:readonly"]}],"x-purecloud-method-name":"getContentmanagementDocumentAudits"}},"/api/v2/authorization/subjects/me":{"get":{"tags":["Authorization","Users"],"summary":"Returns a listing of roles and permissions for the currently authenticated user.","description":"","operationId":"getAuthorizationSubjectsMe","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuthzSubject"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["authorization","authorization:readonly"]}],"x-purecloud-method-name":"getAuthorizationSubjectsMe"}},"/api/v2/outbound/schedules/sequences/{sequenceId}":{"get":{"tags":["Outbound"],"summary":"Get a dialer sequence schedule.","description":"","operationId":"getOutboundSchedulesSequence","produces":["application/json"],"parameters":[{"name":"sequenceId","in":"path","description":"Sequence ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SequenceSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"campaign.sequence.not.found":"The campaign sequence was not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound","outbound:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:schedule:view"]},"x-purecloud-method-name":"getOutboundSchedulesSequence"},"put":{"tags":["Outbound"],"summary":"Update a new sequence schedule.","description":"","operationId":"putOutboundSchedulesSequence","produces":["application/json"],"parameters":[{"name":"sequenceId","in":"path","description":"Sequence ID","required":true,"type":"string"},{"in":"body","name":"body","description":"SequenceSchedule","required":true,"schema":{"$ref":"#/definitions/SequenceSchedule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SequenceSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update":"","invalid.interval.time":"","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","future.intervals.exceeded.limit":""}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"campaign.sequence.not.found":"The campaign sequence was not found.","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.update.wrong.version":"The sequence schedule version does not match expected"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:schedule:edit"]},"x-purecloud-method-name":"putOutboundSchedulesSequence"},"delete":{"tags":["Outbound"],"summary":"Delete a dialer sequence schedule.","description":"","operationId":"deleteOutboundSchedulesSequence","produces":["application/json"],"parameters":[{"name":"sequenceId","in":"path","description":"Sequence ID","required":true,"type":"string"}],"responses":{"200":{"description":"Operation was successful."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"campaign.sequence.not.found":"The campaign sequence was not found.","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["outbound"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["outbound:schedule:delete"]},"x-purecloud-method-name":"deleteOutboundSchedulesSequence"}},"/api/v2/users/{userId}/directreports":{"get":{"tags":["Users"],"summary":"Get direct reports","description":"","operationId":"getUserDirectreports","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"routingStatus"},{"name":"presence"},{"name":"conversationSummary"},{"name":"outOfOffice"},{"name":"geolocation"},{"name":"station"},{"name":"authorization"},{"name":"lasttokenissued"},{"name":"authorization.unusedRoles"},{"name":"team"},{"name":"profileSkills"},{"name":"certifications"},{"name":"locations"},{"name":"groups"},{"name":"skills"},{"name":"languages"},{"name":"languagePreference"},{"name":"employerInfo"},{"name":"biography"}]}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/User"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"general.resource.not.found":"The specified user was not found","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getUserDirectreports"}},"/api/v2/users/{userId}/favorites":{"get":{"tags":["Users"],"summary":"Get favorites","description":"","operationId":"getUserFavorites","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"pageSize","in":"query","description":"Page size","required":false,"type":"integer","default":25,"format":"int32"},{"name":"pageNumber","in":"query","description":"Page number","required":false,"type":"integer","default":1,"format":"int32"},{"name":"sortOrder","in":"query","description":"Sort order","required":false,"type":"string","default":"ASC"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"routingStatus"},{"name":"presence"},{"name":"conversationSummary"},{"name":"outOfOffice"},{"name":"geolocation"},{"name":"station"},{"name":"authorization"},{"name":"lasttokenissued"},{"name":"authorization.unusedRoles"},{"name":"team"},{"name":"profileSkills"},{"name":"certifications"},{"name":"locations"},{"name":"groups"},{"name":"skills"},{"name":"languages"},{"name":"languagePreference"},{"name":"employerInfo"},{"name":"biography"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UserEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getUserFavorites"}},"/api/v2/users/{userId}/adjacents":{"get":{"tags":["Users"],"summary":"Get adjacents","description":"","operationId":"getUserAdjacents","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"routingStatus"},{"name":"presence"},{"name":"conversationSummary"},{"name":"outOfOffice"},{"name":"geolocation"},{"name":"station"},{"name":"authorization"},{"name":"lasttokenissued"},{"name":"authorization.unusedRoles"},{"name":"team"},{"name":"profileSkills"},{"name":"certifications"},{"name":"locations"},{"name":"groups"},{"name":"skills"},{"name":"languages"},{"name":"languagePreference"},{"name":"employerInfo"},{"name":"biography"}]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Adjacents"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getUserAdjacents"}},"/api/v2/users/{userId}/superiors":{"get":{"tags":["Users"],"summary":"Get superiors","description":"","operationId":"getUserSuperiors","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography"]},"collectionFormat":"multi","x-genesys-enum-members":[{"name":"routingStatus"},{"name":"presence"},{"name":"conversationSummary"},{"name":"outOfOffice"},{"name":"geolocation"},{"name":"station"},{"name":"authorization"},{"name":"lasttokenissued"},{"name":"authorization.unusedRoles"},{"name":"team"},{"name":"profileSkills"},{"name":"certifications"},{"name":"locations"},{"name":"groups"},{"name":"skills"},{"name":"languages"},{"name":"languagePreference"},{"name":"employerInfo"},{"name":"biography"}]}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/User"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["users","users:readonly"]}],"x-purecloud-method-name":"getUserSuperiors"}},"/api/v2/speechandtextanalytics/settings":{"get":{"tags":["Speech & Text Analytics"],"summary":"Get Speech And Text Analytics Settings","description":"","operationId":"getSpeechandtextanalyticsSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SpeechTextAnalyticsSettingsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"settings.not.found":"The organization does not have SpeechAndTextAnalytics settings","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics","speech-and-text-analytics:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:settings:view"]},"x-purecloud-method-name":"getSpeechandtextanalyticsSettings"},"patch":{"tags":["Speech & Text Analytics"],"summary":"Patch Speech And Text Analytics Settings","description":"","operationId":"patchSpeechandtextanalyticsSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Speech And Text Analytics Settings","required":true,"schema":{"$ref":"#/definitions/SpeechTextAnalyticsSettingsRequest"}}],"responses":{"200":{"description":"Speech And Text Analytics settings has been updated","schema":{"$ref":"#/definitions/SpeechTextAnalyticsSettingsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The input is not valid","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["speech-and-text-analytics"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["speechAndTextAnalytics:settings:edit"]},"x-purecloud-method-name":"patchSpeechandtextanalyticsSettings"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/query":{"post":{"tags":["Workforce Management"],"summary":"Gets the lookup ids to fetch the specified set of requests","description":"","operationId":"postWorkforcemanagementManagementunitTimeoffrequestsQuery","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The muId of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/TimeOffRequestQueryBody"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffRequestListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffRequest:view"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitTimeoffrequestsQuery"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests":{"get":{"tags":["Workforce Management"],"summary":"Get a list of time off requests for a given user","description":"","operationId":"getWorkforcemanagementManagementunitUserTimeoffrequests","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The muId of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"userId","in":"path","description":"The userId to whom the Time Off Request applies.","required":true,"type":"string"},{"name":"recentlyReviewed","in":"query","description":"Limit results to requests that have been reviewed within the preceding 30 days","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffRequestList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffRequest:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitUserTimeoffrequests"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}":{"get":{"tags":["Workforce Management"],"summary":"Get a time off request","description":"","operationId":"getWorkforcemanagementManagementunitUserTimeoffrequest","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The muId of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"userId","in":"path","description":"The userId to whom the Time Off Request applies.","required":true,"type":"string"},{"name":"timeOffRequestId","in":"path","description":"Time Off Request Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffRequestResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management","workforce-management:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffRequest:view"]},"x-purecloud-method-name":"getWorkforcemanagementManagementunitUserTimeoffrequest"},"patch":{"tags":["Workforce Management"],"summary":"Update a time off request","description":"","operationId":"patchWorkforcemanagementManagementunitUserTimeoffrequest","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The muId of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"name":"userId","in":"path","description":"The id of the user the requested time off request belongs to","required":true,"type":"string"},{"name":"timeOffRequestId","in":"path","description":"The id of the time off request to update","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/AdminTimeOffRequestPatch"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffRequestResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.transaction.conflict":"Entity was modified by another request"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffRequest:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementManagementunitUserTimeoffrequest"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests":{"post":{"tags":["Workforce Management"],"summary":"Create a new time off request","description":"","operationId":"postWorkforcemanagementManagementunitTimeoffrequests","produces":["application/json"],"parameters":[{"name":"managementUnitId","in":"path","description":"The muId of the management unit, or 'mine' for the management unit of the logged-in user.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/CreateAdminTimeOffRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TimeOffRequestList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.entity.not.found":"One of the requested resources in the request body was not found, please check the error details for more information","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","wfm.not.allowed":"One of the attempted actions was not allowed, please check the error details for more information","wfm.validation.failure":"One or more of the request's fields did not pass validation. See userParams and the error message for more details","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wfm.management.unit.not.found":"Management unit not found","wfm.entity.not.found":"One of the requested resources in the path variables was not found, please check the error details for more information","not.found":"The requested resource was not found."}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.payload.too.large":"The request is over the size limit. Maximum bytes: %s","request.entity.too.large":"The request is over the size limit. Content-Length: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["workforce-management"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["wfm:timeOffRequest:add"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitTimeoffrequests"}}},"securityDefinitions":{"PureCloud OAuth":{"type":"oauth2","authorizationUrl":"https://login.mypurecloud.com/authorize","flow":"implicit","scopes":{"all":"All the scopes"}},"Guest Chat JWT":{"type":"apiKey","name":"Authorization","in":"header"}},"definitions":{"Attribute":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The attribute name."},"version":{"type":"integer","format":"int32"},"description":{"type":"string"},"createdBy":{"$ref":"#/definitions/DomainEntityRef"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"$ref":"#/definitions/DomainEntityRef"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Document":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"changeNumber":{"type":"integer","format":"int32"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateUploaded":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"contentUri":{"type":"string","format":"uri"},"workspace":{"$ref":"#/definitions/DomainEntityRef"},"createdBy":{"$ref":"#/definitions/DomainEntityRef"},"uploadedBy":{"$ref":"#/definitions/DomainEntityRef"},"contentType":{"type":"string"},"contentLength":{"type":"integer","format":"int64"},"systemType":{"type":"string","enum":["DOCUMENT","FAX","RECORDING"],"x-genesys-enum-members":[{"name":"DOCUMENT"},{"name":"FAX"},{"name":"RECORDING"}]},"filename":{"type":"string"},"pageCount":{"type":"integer","format":"int64"},"read":{"type":"boolean"},"callerAddress":{"type":"string"},"receiverAddress":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"tagValues":{"type":"array","items":{"$ref":"#/definitions/TagValue"}},"attributes":{"type":"array","items":{"$ref":"#/definitions/DocumentAttribute"}},"thumbnails":{"type":"array","items":{"$ref":"#/definitions/DocumentThumbnail"}},"uploadStatus":{"$ref":"#/definitions/DomainEntityRef"},"uploadDestinationUri":{"type":"string","format":"uri"},"uploadMethod":{"type":"string","enum":["SINGLE_PUT","MULTIPART_POST"],"x-genesys-enum-members":[{"name":"SINGLE_PUT"},{"name":"MULTIPART_POST"}]},"lockInfo":{"$ref":"#/definitions/LockInfo"},"acl":{"type":"array","description":"A list of permitted action rights for the user making the request","items":{"type":"string"}},"sharingStatus":{"type":"string","enum":["NONE","LIMITED","PUBLIC"],"x-genesys-enum-members":[{"name":"NONE"},{"name":"LIMITED"},{"name":"PUBLIC"}]},"sharingUri":{"type":"string","format":"uri"},"downloadSharingUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DocumentAttribute":{"type":"object","properties":{"attribute":{"$ref":"#/definitions/Attribute"},"values":{"type":"array","items":{"type":"string"}}}},"DocumentThumbnail":{"type":"object","properties":{"resolution":{"type":"string"},"imageUri":{"type":"string"},"height":{"type":"integer","format":"int32"},"width":{"type":"integer","format":"int32"}}},"DomainEntityRef":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri"}}},"LockInfo":{"type":"object","properties":{"lockedBy":{"$ref":"#/definitions/DomainEntityRef"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateExpires":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"action":{"type":"string","enum":["UPDATE","DELETE","COPY","MOVE","REPLACE","THUMBNAIL","TEXT_EXTRACTION"],"x-genesys-enum-members":[{"name":"UPDATE"},{"name":"DELETE"},{"name":"COPY"},{"name":"MOVE"},{"name":"REPLACE"},{"name":"THUMBNAIL"},{"name":"TEXT_EXTRACTION"}]}}},"TagValue":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The workspace tag name."},"inUse":{"type":"boolean"},"acl":{"type":"array","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DocumentUpdate":{"type":"object","required":["name"],"properties":{"changeNumber":{"type":"integer","format":"int32"},"name":{"type":"string","description":"The name of the document"},"read":{"type":"boolean"},"addTags":{"type":"array","items":{"type":"string"}},"removeTags":{"type":"array","items":{"type":"string"}},"addTagIds":{"type":"array","items":{"type":"string"}},"removeTagIds":{"type":"array","items":{"type":"string"}},"updateAttributes":{"type":"array","items":{"$ref":"#/definitions/DocumentAttribute"}},"removeAttributes":{"type":"array","items":{"type":"string"}}}},"AddressableEntityRef":{"type":"object","properties":{"id":{"type":"string"},"selfUri":{"type":"string","format":"uri"}}},"LocationAddress":{"type":"object","properties":{"city":{"type":"string"},"country":{"type":"string"},"countryName":{"type":"string"},"state":{"type":"string"},"street1":{"type":"string"},"street2":{"type":"string"},"zipcode":{"type":"string"}}},"LocationAddressVerificationDetails":{"type":"object","properties":{"status":{"type":"string","description":"Status of address verification process","enum":["Pending","InProgress","Retry","Complete","Failed"],"x-genesys-enum-members":[{"name":"Pending"},{"name":"InProgress"},{"name":"Retry"},{"name":"Complete"},{"name":"Failed"}]},"dateFinished":{"type":"string","format":"date-time","description":"Finished time of address verification process. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateStarted":{"type":"string","format":"date-time","description":"Time started of address verification process. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"service":{"type":"string","example":"smartystreets-us","description":"Third party service used for address verification"}}},"LocationDefinition":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"contactUser":{"description":"Site contact for the location entity","$ref":"#/definitions/AddressableEntityRef"},"emergencyNumber":{"description":"Emergency number for the location entity","$ref":"#/definitions/LocationEmergencyNumber"},"address":{"$ref":"#/definitions/LocationAddress"},"state":{"type":"string","description":"Current state of the location entity","enum":["active","deleted"]},"notes":{"type":"string","description":"Notes for the location entity"},"version":{"type":"integer","format":"int32","description":"Current version of the location entity, value to be supplied should be retrieved by a GET or on create/update response"},"path":{"type":"array","description":"A list of ancestor IDs in order","readOnly":true,"items":{"type":"string"}},"profileImage":{"type":"array","description":"Profile image of the location entity, retrieved with ?expand=images query parameter","readOnly":true,"items":{"$ref":"#/definitions/LocationImage"}},"floorplanImage":{"type":"array","description":"Floorplan images of the location entity, retrieved with ?expand=images query parameter","readOnly":true,"items":{"$ref":"#/definitions/LocationImage"}},"addressVerificationDetails":{"description":"Address verification information, retrieve dwith the ?expand=addressVerificationDetails query parameter","readOnly":true,"$ref":"#/definitions/LocationAddressVerificationDetails"},"addressVerified":{"type":"boolean","description":"Boolean field which states if the address has been verified as an actual address","readOnly":true},"addressStored":{"type":"boolean","description":"Boolean field which states if the address has been stored for E911","readOnly":true},"images":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LocationEmergencyNumber":{"type":"object","properties":{"e164":{"type":"string"},"number":{"type":"string"},"type":{"type":"string","description":"The type of emergency number.","enum":["default","elin"]}}},"LocationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/LocationDefinition"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"LocationImage":{"type":"object","properties":{"resolution":{"type":"string","description":"Height and/or width of image. ex: 640x480 or x128"},"imageUri":{"type":"string"}}},"LocationUpdateDefinition":{"type":"object","required":["name","version"],"properties":{"name":{"type":"string","description":"The name of the Location. Required for creates, not required for updates"},"version":{"type":"integer","format":"int32","description":"Current version of the location"},"state":{"type":"string","description":"Current activity status of the location.","enum":["active","deleted"]},"path":{"type":"array","description":"A list of ancestor ids","items":{"type":"string"}},"notes":{"type":"string","description":"Notes for the location"},"contactUser":{"type":"string","description":"The user id of the location contact"},"emergencyNumber":{"description":"Emergency number for the location","$ref":"#/definitions/LocationEmergencyNumber"},"address":{"description":"Address of the location","$ref":"#/definitions/LocationAddress"}}},"Contact":{"type":"object","properties":{"address":{"type":"string","description":"Email address or phone number for this contact type"},"display":{"type":"string","description":"Formatted version of the address property","readOnly":true},"mediaType":{"type":"string","enum":["PHONE","EMAIL","SMS"],"x-genesys-enum-members":[{"name":"PHONE"},{"name":"EMAIL"},{"name":"SMS"}]},"type":{"type":"string","enum":["PRIMARY","WORK","WORK2","WORK3","WORK4","HOME","MOBILE","MAIN"],"x-genesys-enum-members":[{"name":"PRIMARY"},{"name":"WORK"},{"name":"WORK2"},{"name":"WORK3"},{"name":"WORK4"},{"name":"HOME"},{"name":"MOBILE"},{"name":"MAIN"}]},"extension":{"type":"string","description":"Use internal extension instead of address. Mutually exclusive with the address field."},"countryCode":{"type":"string"}}},"DomainEdgeSoftwareUpdateDto":{"type":"object","required":["version"],"properties":{"version":{"description":"Version","$ref":"#/definitions/DomainEdgeSoftwareVersionDto"},"maxDownloadRate":{"type":"integer","format":"int32"},"downloadStartTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"executeStartTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"executeStopTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"executeOnIdle":{"type":"boolean"},"status":{"type":"string","enum":["NONE","INIT","IN_PROGRESS","EXPIRED","EXCEPTION","ABORTED","FAILED","SUCCEEDED","DELETE"],"x-genesys-enum-members":[{"name":"NONE"},{"name":"INIT"},{"name":"IN_PROGRESS"},{"name":"EXPIRED"},{"name":"EXCEPTION"},{"name":"ABORTED"},{"name":"FAILED"},{"name":"SUCCEEDED"},{"name":"DELETE"}]},"edgeUri":{"type":"string","format":"uri"},"callDrainingWaitTimeSeconds":{"type":"integer","format":"int64"},"current":{"type":"boolean"}}},"DomainEdgeSoftwareVersionDto":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"edgeVersion":{"type":"string"},"publishDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"edgeUri":{"type":"string","format":"uri"},"latestRelease":{"type":"boolean"},"current":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Edge":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"interfaces":{"type":"array","description":"The list of interfaces for the edge. (Deprecated) Replaced by configuring trunks/ip info on the logical interface instead","items":{"$ref":"#/definitions/EdgeInterface"}},"make":{"type":"string"},"model":{"type":"string"},"apiVersion":{"type":"string"},"softwareVersion":{"type":"string"},"softwareVersionTimestamp":{"type":"string"},"softwareVersionPlatform":{"type":"string"},"softwareVersionConfiguration":{"type":"string"},"fullSoftwareVersion":{"type":"string"},"pairingId":{"type":"string","description":"The pairing Id for a hardware Edge in the format: 00000-00000-00000-00000-00000. This field is only required when creating an Edge with a deployment type of HARDWARE."},"fingerprint":{"type":"string"},"fingerprintHint":{"type":"string"},"currentVersion":{"type":"string"},"stagedVersion":{"type":"string"},"patch":{"type":"string"},"statusCode":{"type":"string","description":"The current status of the Edge.","enum":["NEW","AWAITING_CONNECTION","AWAITING_FINGERPRINT","AWAITING_FINGERPRINT_VERIFICATION","FINGERPRINT_VERIFIED","AWAITING_BOOTSTRAP","ACTIVE","INACTIVE","RMA","UNPAIRING","UNPAIRED","INITIALIZING"],"x-genesys-enum-members":[{"name":"NEW"},{"name":"AWAITING_CONNECTION"},{"name":"AWAITING_FINGERPRINT"},{"name":"AWAITING_FINGERPRINT_VERIFICATION"},{"name":"FINGERPRINT_VERIFIED"},{"name":"AWAITING_BOOTSTRAP"},{"name":"ACTIVE"},{"name":"INACTIVE"},{"name":"RMA"},{"name":"UNPAIRING"},{"name":"UNPAIRED"},{"name":"INITIALIZING"}]},"edgeGroup":{"$ref":"#/definitions/EdgeGroup"},"site":{"description":"The Site to which the Edge is assigned.","$ref":"#/definitions/Site"},"softwareStatus":{"description":"Details about an in-progress or recently in-progress Edge software upgrade. This node appears only if a software upgrade was recently initiated for this Edge.","$ref":"#/definitions/DomainEdgeSoftwareUpdateDto"},"onlineStatus":{"type":"string","enum":["ONLINE","OFFLINE"],"x-genesys-enum-members":[{"name":"ONLINE"},{"name":"OFFLINE"}]},"serialNumber":{"type":"string"},"physicalEdge":{"type":"boolean"},"managed":{"type":"boolean"},"edgeDeploymentType":{"type":"string","enum":["HARDWARE","LDM","CDM","INVALID"],"x-genesys-enum-members":[{"name":"HARDWARE"},{"name":"LDM"},{"name":"CDM"},{"name":"INVALID"}]},"callDrainingState":{"type":"string","description":"The current state of the Edge's call draining process before it can be safely rebooted or updated.","readOnly":true,"enum":["NONE","WAIT","WAIT_TIMEOUT","TERMINATE","COMPLETE"],"x-genesys-enum-members":[{"name":"NONE"},{"name":"WAIT"},{"name":"WAIT_TIMEOUT"},{"name":"TERMINATE"},{"name":"COMPLETE"}]},"conversationCount":{"type":"integer","format":"int32","description":"The remaining number of conversations the Edge has to drain before it can be safely rebooted or updated. When an Edge is not draining conversations, this will be NULL or 0.","readOnly":true},"proxy":{"type":"string","description":"Edge HTTP proxy configuration for the WAN port. The field can be a hostname, FQDN, IPv4 or IPv6 address. If port is not included, port 80 is assumed."},"offlineConfigCalled":{"type":"boolean","description":"True if the offline edge configuration endpoint has been called for this edge.","readOnly":true},"osName":{"type":"string","description":"The name provided by the operating system of the Edge.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EdgeAutoUpdateConfig":{"type":"object","properties":{"timeZone":{"type":"string"},"rrule":{"type":"string"},"start":{"type":"string","format":"local-date-time","description":"Date time is represented as an ISO-8601 string without a timezone. For example: yyyy-MM-ddTHH:mm:ss.SSS"},"end":{"type":"string","format":"local-date-time","description":"Date time is represented as an ISO-8601 string without a timezone. For example: yyyy-MM-ddTHH:mm:ss.SSS"}}},"EdgeGroup":{"type":"object","required":["edgeTrunkBaseAssignment","name","phoneTrunkBases"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"managed":{"type":"boolean","description":"Is this edge group being managed remotely."},"hybrid":{"type":"boolean","description":"Is this edge group hybrid."},"edgeTrunkBaseAssignment":{"description":"A trunk base settings assignment of trunkType \"EDGE\" to use for edge-to-edge communication.","$ref":"#/definitions/TrunkBaseAssignment"},"phoneTrunkBases":{"type":"array","description":"Trunk base settings of trunkType \"PHONE\" to inherit to edge logical interface for phone communication.","items":{"$ref":"#/definitions/TrunkBase"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EdgeInterface":{"type":"object","properties":{"type":{"type":"string"},"ipAddress":{"type":"string"},"name":{"type":"string"},"macAddress":{"type":"string"},"ifName":{"type":"string"},"endpoints":{"type":"array","items":{"$ref":"#/definitions/DomainEntityRef"}},"lineTypes":{"type":"array","items":{"type":"string","enum":["TIE","NETWORK","TRUNK","STATION"],"x-genesys-enum-members":[{"name":"TIE"},{"name":"NETWORK"},{"name":"TRUNK"},{"name":"STATION"}]}},"addressFamilyId":{"type":"string"}}},"Line":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"properties":{"type":"object","additionalProperties":{"type":"object"}},"edgeGroup":{"$ref":"#/definitions/DomainEntityRef"},"template":{"$ref":"#/definitions/DomainEntityRef"},"site":{"$ref":"#/definitions/DomainEntityRef"},"lineBaseSettings":{"$ref":"#/definitions/DomainEntityRef"},"primaryEdge":{"description":"The primary edge associated to the line. (Deprecated)","$ref":"#/definitions/Edge"},"secondaryEdge":{"description":"The secondary edge associated to the line. (Deprecated)","$ref":"#/definitions/Edge"},"loggedInUser":{"$ref":"#/definitions/DomainEntityRef"},"defaultForUser":{"$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"NTPSettings":{"type":"object","properties":{"servers":{"type":"array","description":"List of NTP servers, in priority order","items":{"type":"string"}}}},"Site":{"type":"object","required":["location","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"primarySites":{"type":"array","items":{"$ref":"#/definitions/DomainEntityRef"}},"secondarySites":{"type":"array","items":{"$ref":"#/definitions/DomainEntityRef"}},"primaryEdges":{"type":"array","items":{"$ref":"#/definitions/Edge"}},"secondaryEdges":{"type":"array","items":{"$ref":"#/definitions/Edge"}},"addresses":{"type":"array","items":{"$ref":"#/definitions/Contact"}},"edges":{"type":"array","items":{"$ref":"#/definitions/Edge"}},"edgeAutoUpdateConfig":{"description":"Recurrance rule, time zone, and start/end settings for automatic edge updates for this site","$ref":"#/definitions/EdgeAutoUpdateConfig"},"mediaRegionsUseLatencyBased":{"type":"boolean"},"location":{"description":"Location","$ref":"#/definitions/LocationDefinition"},"managed":{"type":"boolean"},"ntpSettings":{"description":"Network Time Protocol settings for the site","$ref":"#/definitions/NTPSettings"},"mediaModel":{"type":"string","description":"Media model for the site","enum":["Premises","Cloud"],"x-genesys-enum-members":[{"name":"Premises"},{"name":"Cloud"}]},"coreSite":{"type":"boolean","description":"The core site","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TrunkBase":{"type":"object","required":["name","trunkMetabase","trunkType"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"trunkMetabase":{"description":"The meta-base this trunk is based on.","$ref":"#/definitions/DomainEntityRef"},"properties":{"type":"object","additionalProperties":{"type":"object"}},"trunkType":{"type":"string","description":"The type of this trunk base.","enum":["EXTERNAL","PHONE","EDGE"],"x-genesys-enum-members":[{"name":"EXTERNAL"},{"name":"PHONE"},{"name":"EDGE"}]},"managed":{"type":"boolean","description":"Is this trunk being managed remotely. This property is synchronized with the managed property of the Edge Group to which it is assigned."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TrunkBaseAssignment":{"type":"object","properties":{"family":{"type":"integer","format":"int32","description":"The address family to use with the trunk base settings. 2=IPv4, 23=IPv6"},"trunkBase":{"description":"A trunk base settings reference.","$ref":"#/definitions/TrunkBase"}}},"Detail":{"type":"object","properties":{"errorCode":{"type":"string"},"fieldName":{"type":"string"},"entityId":{"type":"string"},"entityName":{"type":"string"}}},"ErrorBody":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"string"},"status":{"type":"integer","format":"int32"},"entityId":{"type":"string"},"entityName":{"type":"string"},"messageWithParams":{"type":"string"},"messageParams":{"type":"object","additionalProperties":{"type":"string"}},"contextId":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/definitions/Detail"}},"errors":{"type":"array","items":{"$ref":"#/definitions/ErrorBody"}}}},"MediaType":{"type":"object","properties":{"type":{"type":"string","description":"The media type string as defined by RFC 2046. You can define specific types such as 'image/jpeg', 'video/mpeg', or specify wild cards for a range of types, 'image/*', or all types '*/*'. See https://www.iana.org/assignments/media-types/media-types.xhtml for a list of registered media types."}},"description":"Media type definition"},"MediaTypeAccess":{"type":"object","properties":{"inbound":{"type":"array","description":"List of media types allowed for inbound messages from customers. If inbound messages from a customer contain media that is not in this list, the media will be dropped from the outbound message.","items":{"$ref":"#/definitions/MediaType"}},"outbound":{"type":"array","description":"List of media types allowed for outbound messages to customers. If an outbound message is sent that contains media that is not in this list, the message will not be sent.","items":{"$ref":"#/definitions/MediaType"}}},"description":"Media type access definitions"},"MediaTypes":{"type":"object","properties":{"allow":{"description":"Specify allowed media types for inbound and outbound messages. If this field is empty, all inbound and outbound media will be blocked.","$ref":"#/definitions/MediaTypeAccess"}},"description":"Media types"},"SupportedContentReference":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The SupportedContent unique identifier associated with this integration"},"name":{"type":"string","description":"The SupportedContent profile name","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The SupportedContent profile URI","readOnly":true},"mediaTypes":{"description":"Media types definition for the supported content","readOnly":true,"$ref":"#/definitions/MediaTypes"}},"description":"Reference to supported content profile associated with the integration"},"Division":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AnswerOption":{"type":"object","properties":{"id":{"type":"string"},"text":{"type":"string"},"value":{"type":"integer","format":"int32"}}},"DomainEntity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DomainEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DomainEntity"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DomainEntityListingEvaluationForm":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/EvaluationForm"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EvaluationForm":{"type":"object","required":["name","questionGroups"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The evaluation form name"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"published":{"type":"boolean"},"contextId":{"type":"string"},"questionGroups":{"type":"array","description":"A list of question groups","items":{"$ref":"#/definitions/EvaluationQuestionGroup"}},"publishedVersions":{"$ref":"#/definitions/DomainEntityListingEvaluationForm"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EvaluationQuestion":{"type":"object","properties":{"id":{"type":"string"},"text":{"type":"string"},"helpText":{"type":"string"},"type":{"type":"string","enum":["multipleChoiceQuestion","freeTextQuestion","npsQuestion","readOnlyTextBlockQuestion"],"x-genesys-enum-members":[{"name":"multipleChoiceQuestion"},{"name":"freeTextQuestion"},{"name":"npsQuestion"},{"name":"readOnlyTextBlockQuestion"}]},"naEnabled":{"type":"boolean"},"commentsRequired":{"type":"boolean"},"visibilityCondition":{"$ref":"#/definitions/VisibilityCondition"},"answerOptions":{"type":"array","description":"Options from which to choose an answer for this question. Only used by Multiple Choice type questions.","items":{"$ref":"#/definitions/AnswerOption"}},"isKill":{"type":"boolean"},"isCritical":{"type":"boolean"}}},"EvaluationQuestionGroup":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"defaultAnswersToHighest":{"type":"boolean"},"defaultAnswersToNA":{"type":"boolean"},"naEnabled":{"type":"boolean"},"weight":{"type":"number","format":"float"},"manualWeight":{"type":"boolean"},"questions":{"type":"array","items":{"$ref":"#/definitions/EvaluationQuestion"}},"visibilityCondition":{"$ref":"#/definitions/VisibilityCondition"}}},"VisibilityCondition":{"type":"object","properties":{"combiningOperation":{"type":"string","enum":["AND","OR"],"x-genesys-enum-members":[{"name":"AND"},{"name":"OR"}]},"predicates":{"type":"array","description":"A list of strings, each representing the location in the form of the Answer Option to depend on. In the format of \"/form/questionGroup/{questionGroupIndex}/question/{questionIndex}/answer/{answerIndex}\" or, to assume the current question group, \"../question/{questionIndex}/answer/{answerIndex}\". Note: Indexes are zero-based","items":{"type":"object"}}}},"PublishForm":{"type":"object","required":["id","published"],"properties":{"published":{"type":"boolean","description":"Is this form published"},"id":{"type":"string","description":"Unique Id for this version of this form"}}},"EvaluationFormEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/EvaluationForm"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DomainCapabilities":{"type":"object","properties":{"enabled":{"type":"boolean","description":"True if this address family on the interface is enabled."},"dhcp":{"type":"boolean","description":"True if this address family on the interface is using DHCP."},"metric":{"type":"integer","format":"int32","description":"The metric being used for the address family on this interface. Lower values will have a higher priority. If autoMetric is true, this value will be the automatically calculated metric. To set this value be sure autoMetric is false. If no value is returned, metric configuration is not supported on this Edge."},"autoMetric":{"type":"boolean","description":"True if the metric is being calculated automatically for the address family on this interface."},"supportsMetric":{"type":"boolean","description":"True if metric configuration is supported.","readOnly":true},"pingEnabled":{"type":"boolean","description":"Set to true to enable this address family on this interface to respond to ping requests."}}},"DomainLogicalInterface":{"type":"object","required":["friendlyName","hardwareAddress","name","physicalAdapterId"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"edgeUri":{"type":"string","format":"uri"},"edgeAssignedId":{"type":"string"},"friendlyName":{"type":"string","description":"Friendly Name"},"vlanTagId":{"type":"integer","format":"int32"},"hardwareAddress":{"type":"string","description":"Hardware Address"},"physicalAdapterId":{"type":"string","description":"Physical Adapter Id"},"ifStatus":{"type":"string"},"interfaceType":{"type":"string","description":"The type of this network interface.","readOnly":true,"enum":["DIAGNOSTIC","SYSTEM"],"x-genesys-enum-members":[{"name":"DIAGNOSTIC"},{"name":"SYSTEM"}]},"publicNatAddressIpV4":{"type":"string","description":"IPv4 NENT IP Address"},"publicNatAddressIpV6":{"type":"string","description":"IPv6 NENT IP Address"},"routes":{"type":"array","description":"The list of routes assigned to this interface.","items":{"$ref":"#/definitions/DomainNetworkRoute"}},"addresses":{"type":"array","description":"The list of IP addresses on this interface. Priority of dns addresses are based on order in the list.","items":{"$ref":"#/definitions/DomainNetworkAddress"}},"ipv4Capabilities":{"description":"IPv4 interface settings.","$ref":"#/definitions/DomainCapabilities"},"ipv6Capabilities":{"description":"IPv6 interface settings.","$ref":"#/definitions/DomainCapabilities"},"currentState":{"type":"string","enum":["INIT","CREATING","UPDATING","OK","EXCEPTION","DELETING"],"x-genesys-enum-members":[{"name":"INIT"},{"name":"CREATING"},{"name":"UPDATING"},{"name":"OK"},{"name":"EXCEPTION"},{"name":"DELETING"}]},"lastModifiedUserId":{"type":"string"},"lastModifiedCorrelationId":{"type":"string"},"commandResponses":{"type":"array","items":{"$ref":"#/definitions/DomainNetworkCommandResponse"}},"inheritPhoneTrunkBasesIPv4":{"type":"boolean","description":"The IPv4 phone trunk base assignment will be inherited from the Edge Group."},"inheritPhoneTrunkBasesIPv6":{"type":"boolean","description":"The IPv6 phone trunk base assignment will be inherited from the Edge Group."},"useForInternalEdgeCommunication":{"type":"boolean","description":"This interface will be used for all internal edge-to-edge communication using settings from the edgeTrunkBaseAssignment on the Edge Group."},"useForIndirectEdgeCommunication":{"type":"boolean","description":"Site Interconnects using the \"Indirect\" method will communicate using the Public IP Address specified on the interface. Use this option when a NAT enabled firewall is between the Edge and the far end."},"useForCloudProxyEdgeCommunication":{"type":"boolean","description":"Site Interconnects using the \"Cloud Proxy\" method will broker the connection between them with a Cloud Proxy. This method is required for connections between one or more Sites using Cloud Media, but can optionally be used between two premises Sites if Direct or Indirect are not an option."},"useForWanInterface":{"type":"boolean","description":"This interface will be used for all communication with the internet.","readOnly":true},"externalTrunkBaseAssignments":{"type":"array","description":"External trunk base settings to use for external communication from this interface.","items":{"$ref":"#/definitions/TrunkBaseAssignment"}},"phoneTrunkBaseAssignments":{"type":"array","description":"Phone trunk base settings to use for phone communication from this interface. These settings will be ignored when \"inheritPhoneTrunkBases\" is true.","items":{"$ref":"#/definitions/TrunkBaseAssignment"}},"traceEnabled":{"type":"boolean"},"startDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DomainNetworkAddress":{"type":"object","properties":{"type":{"type":"string","description":"The type of address.","enum":["ip","dns","gateway","tdm"]},"address":{"type":"string","description":"An IPv4 or IPv6 IP address. When specifying an address of type \"ip\", use CIDR format for the subnet mask."},"persistent":{"type":"boolean","description":"True if this address will persist on Edge restart. Addresses assigned by DHCP will be returned as false."},"family":{"type":"integer","format":"int32","description":"The address family for this address.","enum":[2,23]}}},"DomainNetworkCommandResponse":{"type":"object","properties":{"correlationId":{"type":"string"},"commandName":{"type":"string"},"acknowledged":{"type":"boolean"},"errorInfo":{"$ref":"#/definitions/ErrorDetails"}}},"DomainNetworkRoute":{"type":"object","properties":{"prefix":{"type":"string","description":"The IPv4 or IPv6 route prefix in CIDR notation."},"nexthop":{"type":"string","description":"The IPv4 or IPv6 nexthop IP address."},"persistent":{"type":"boolean","description":"True if this route will persist on Edge restart. Routes assigned by DHCP will be returned as false."},"metric":{"type":"integer","format":"int32","description":"The metric being used for route. Lower values will have a higher priority."},"family":{"type":"integer","format":"int32","description":"The address family for this route.","enum":[2,23]}}},"ErrorDetails":{"type":"object","properties":{"status":{"type":"integer","format":"int32"},"message":{"type":"string"},"messageWithParams":{"type":"string"},"messageParams":{"type":"object","additionalProperties":{"type":"string"}},"code":{"type":"string"},"contextId":{"type":"string"},"nested":{"$ref":"#/definitions/ErrorDetails"},"details":{"type":"string","format":"uri"}}},"LogicalInterfaceEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DomainLogicalInterface"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EmergencyCallFlow":{"type":"object","properties":{"emergencyFlow":{"description":"The call flow to execute in an emergency.","$ref":"#/definitions/DomainEntityRef"},"ivrs":{"type":"array","description":"The IVR(s) to route to the call flow during an emergency.","items":{"$ref":"#/definitions/DomainEntityRef"}}},"description":"An emergency flow associates a call flow to use in an emergency with the ivr(s) to route to it."},"EmergencyGroup":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"enabled":{"type":"boolean","description":"True if an emergency is occurring and the associated emergency call flow(s) should be used. False otherwise."},"emergencyCallFlows":{"type":"array","description":"The emergency call flow(s) to use during an emergency.","items":{"$ref":"#/definitions/EmergencyCallFlow"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"A group of emergency call flows to use in an emergency."},"EmergencyGroupListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/EmergencyGroup"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EdgeVersionInformation":{"type":"object","properties":{"softwareVersion":{"type":"string"}}},"EdgeVersionReport":{"type":"object","properties":{"oldestVersion":{"$ref":"#/definitions/EdgeVersionInformation"},"newestVersion":{"$ref":"#/definitions/EdgeVersionInformation"}}},"ConversationRoutingData":{"type":"object","properties":{"queue":{"description":"The queue to use for routing decisions","$ref":"#/definitions/AddressableEntityRef"},"language":{"description":"The language to use for routing decisions","$ref":"#/definitions/AddressableEntityRef"},"priority":{"type":"integer","format":"int32","description":"The priority of the conversation to use for routing decisions"},"skills":{"type":"array","description":"The skills to use for routing decisions","items":{"$ref":"#/definitions/AddressableEntityRef"}},"scoredAgents":{"type":"array","description":"A collection of agents and their assigned scores for this conversation (0 - 100, higher being better), for use in routing to preferred agents","items":{"$ref":"#/definitions/ScoredAgent"}}}},"ErrorInfo":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"string"}}},"JourneyAction":{"type":"object","required":["actionMap","id"],"properties":{"id":{"type":"string","description":"The ID of an action from the Journey System (an action is spawned from an actionMap)"},"actionMap":{"description":"Details about the action map from the Journey System which triggered this action","$ref":"#/definitions/JourneyActionMap"}}},"JourneyActionMap":{"type":"object","required":["id","version"],"properties":{"id":{"type":"string","description":"The ID of the actionMap in the Journey System which triggered this action"},"version":{"type":"integer","format":"int32","description":"The version number of the actionMap in the Journey System at the time this action was triggered"}}},"JourneyContext":{"type":"object","required":["customer"],"properties":{"customer":{"description":"A subset of the Journey System's customer data at a point-in-time (for external linkage and internal usage/context)","$ref":"#/definitions/JourneyCustomer"},"customerSession":{"description":"A subset of the Journey System's tracked customer session data at a point-in-time (for external linkage and internal usage/context)","$ref":"#/definitions/JourneyCustomerSession"},"triggeringAction":{"description":"A subset of the Journey System's action data relevant to a part of a conversation (for external linkage and internal usage/context)","$ref":"#/definitions/JourneyAction"}}},"JourneyCustomer":{"type":"object","required":["id","idType"],"properties":{"id":{"type":"string","description":"An ID of a customer within the Journey System at a point-in-time. Note that a customer entity can have multiple customerIds based on the stitching process. Depending on the context within the PureCloud conversation, this may or may not be mutable."},"idType":{"type":"string","description":"The type of the customerId within the Journey System (e.g. cookie)."}}},"JourneyCustomerSession":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"An ID of a Customer/User's session within the Journey System at a point-in-time"},"type":{"type":"string","description":"The type of the Customer/User's session within the Journey System (e.g. web, app)"}}},"ScoredAgent":{"type":"object","properties":{"agent":{"description":"The agent","$ref":"#/definitions/AddressableEntityRef"},"score":{"type":"integer","format":"int32","description":"Agent's score for the current conversation, from 0 - 100, higher being better"}}},"Wrapup":{"type":"object","properties":{"code":{"type":"string","description":"The user configured wrap up code id."},"name":{"type":"string","description":"The user configured wrap up code name."},"notes":{"type":"string","description":"Text entered by the agent to describe the call or disposition."},"tags":{"type":"array","description":"List of tags selected by the agent to describe the call or disposition.","items":{"type":"string"}},"durationSeconds":{"type":"integer","format":"int32","description":"The length of time in seconds that the agent spent doing after call work."},"endTime":{"type":"string","format":"date-time","description":"The timestamp when the wrapup was finished. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"provisional":{"type":"boolean","description":"Indicates if this is a pending save and should not require a code to be specified. This allows someone to save some temporary wrapup that will be used later."}}},"WrapupCode":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The wrap-up code name."},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string"},"createdBy":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ParticipantAttributes":{"type":"object","properties":{"attributes":{"type":"object","description":"The map of attribute keys to values.","additionalProperties":{"type":"string"}}}},"Actions":{"type":"object","properties":{"skillsToRemove":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/SkillsToRemove"}}}},"AcwSettings":{"type":"object","properties":{"wrapupPrompt":{"type":"string","description":"This field controls how the UI prompts the agent for a wrapup.","enum":["MANDATORY","OPTIONAL","MANDATORY_TIMEOUT","MANDATORY_FORCED_TIMEOUT","AGENT_REQUESTED"],"x-genesys-enum-members":[{"name":"MANDATORY"},{"name":"OPTIONAL"},{"name":"MANDATORY_TIMEOUT"},{"name":"MANDATORY_FORCED_TIMEOUT"},{"name":"AGENT_REQUESTED"}]},"timeoutMs":{"type":"integer","format":"int32","description":"The amount of time the agent can stay in ACW (Min: 1 sec, Max: 1 day). Can only be used when ACW is MANDATORY_TIMEOUT or MANDATORY_FORCED_TIMEOUT."}}},"Address":{"type":"object","properties":{"name":{"type":"string","description":"This will be nameRaw if present, or a locality lookup of the address field otherwise."},"nameRaw":{"type":"string","description":"The name as close to the bits on the wire as possible."},"addressNormalized":{"type":"string","description":"The normalized address. This field is acquired from the Address Normalization Table. The addressRaw could have gone through some transformations, such as only using the numeric portion, before being run through the Address Normalization Table."},"addressRaw":{"type":"string","description":"The address as close to the bits on the wire as possible."},"addressDisplayable":{"type":"string","description":"The displayable address. This field is acquired from the Address Normalization Table. The addressRaw could have gone through some transformations, such as only using the numeric portion, before being run through the Address Normalization Table."}}},"AfterCallWork":{"type":"object","properties":{"startTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"state":{"type":"string","enum":["unknown","notApplicable","skipped","pending","complete"],"x-genesys-enum-members":[{"name":"unknown"},{"name":"notApplicable"},{"name":"skipped"},{"name":"pending"},{"name":"complete"}]}}},"AssignmentGroup":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri"},"type":{"type":"string","enum":["TEAM"],"x-genesys-enum-members":[{"name":"TEAM"}]}}},"Attachment":{"type":"object","properties":{"attachmentId":{"type":"string","description":"The unique identifier for the attachment."},"name":{"type":"string","description":"The name of the attachment."},"contentUri":{"type":"string","description":"The content uri of the attachment. If set, this is commonly a public api download location."},"contentType":{"type":"string","description":"The type of file the attachment is."},"contentLength":{"type":"integer","format":"int32","description":"The length of the attachment file."},"inlineImage":{"type":"boolean","description":"Whether or not the attachment was attached inline.,"}}},"Biography":{"type":"object","properties":{"biography":{"type":"string","description":"Personal detailed description"},"interests":{"type":"array","items":{"type":"string"}},"hobbies":{"type":"array","items":{"type":"string"}},"spouse":{"type":"string"},"education":{"type":"array","description":"User education details","items":{"$ref":"#/definitions/Education"}}}},"Bullseye":{"type":"object","properties":{"rings":{"type":"array","items":{"$ref":"#/definitions/Ring"}}}},"Calibration":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"calibrator":{"$ref":"#/definitions/User"},"agent":{"$ref":"#/definitions/User"},"conversation":{"$ref":"#/definitions/Conversation"},"evaluationForm":{"$ref":"#/definitions/EvaluationForm"},"contextId":{"type":"string"},"averageScore":{"type":"integer","format":"int32"},"highScore":{"type":"integer","format":"int32"},"lowScore":{"type":"integer","format":"int32"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"evaluations":{"type":"array","items":{"$ref":"#/definitions/Evaluation"}},"evaluators":{"type":"array","items":{"$ref":"#/definitions/User"}},"scoringIndex":{"$ref":"#/definitions/Evaluation"},"expertEvaluator":{"$ref":"#/definitions/User"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Call":{"type":"object","properties":{"state":{"type":"string","description":"The connection state of this communication.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","converting","uploading","transmitting","none"],"x-genesys-enum-members":[{"name":"alerting"},{"name":"dialing"},{"name":"contacting"},{"name":"offering"},{"name":"connected"},{"name":"disconnected"},{"name":"terminated"},{"name":"converting"},{"name":"uploading"},{"name":"transmitting"},{"name":"none"}]},"id":{"type":"string","description":"A globally unique identifier for this communication."},"direction":{"type":"string","description":"The direction of the call","enum":["inbound","outbound"],"x-genesys-enum-members":[{"name":"inbound"},{"name":"outbound"}]},"recording":{"type":"boolean","description":"True if this call is being recorded."},"recordingState":{"type":"string","description":"State of recording on this call.","enum":["none","active","paused"],"x-genesys-enum-members":[{"name":"none"},{"name":"active"},{"name":"paused"}]},"muted":{"type":"boolean","description":"True if this call is muted so that remote participants can't hear any audio from this end."},"confined":{"type":"boolean","description":"True if this call is held and the person on this side hears hold music."},"held":{"type":"boolean","description":"True if this call is held and the person on this side hears silence."},"recordingId":{"type":"string","description":"A globally unique identifier for the recording associated with this call."},"segments":{"type":"array","description":"The time line of the participant's call, divided into activity segments.","items":{"$ref":"#/definitions/Segment"}},"errorInfo":{"$ref":"#/definitions/ErrorInfo"},"disconnectType":{"type":"string","description":"System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.","enum":["endpoint","client","system","timeout","transfer","transfer.conference","transfer.consult","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam","uncallable"],"x-genesys-enum-members":[{"name":"endpoint"},{"name":"client"},{"name":"system"},{"name":"timeout"},{"name":"transfer"},{"name":"transfer.conference"},{"name":"transfer.consult"},{"name":"transfer.forward"},{"name":"transfer.noanswer"},{"name":"transfer.notavailable"},{"name":"transport.failure"},{"name":"error"},{"name":"peer"},{"name":"other"},{"name":"spam"},{"name":"uncallable"}]},"startHoldTime":{"type":"string","format":"date-time","description":"The timestamp the call was placed on hold in the cloud clock if the call is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"documentId":{"type":"string","description":"If call is an outbound fax of a document from content management, then this is the id in content management."},"startAlertingTime":{"type":"string","format":"date-time","description":"The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"disconnectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"disconnectReasons":{"type":"array","description":"List of reasons that this call was disconnected. This will be set once the call disconnects.","items":{"$ref":"#/definitions/DisconnectReason"}},"faxStatus":{"description":"Extra information on fax transmission.","$ref":"#/definitions/FaxStatus"},"provider":{"type":"string","description":"The source provider for the call."},"scriptId":{"type":"string","description":"The UUID of the script to use."},"peerId":{"type":"string","description":"The id of the peer communication corresponding to a matching leg for this communication."},"uuiData":{"type":"string","description":"User to User Information (UUI) data managed by SIP session application."},"self":{"description":"Address and name data for a call endpoint.","$ref":"#/definitions/Address"},"other":{"description":"Address and name data for a call endpoint.","$ref":"#/definitions/Address"},"wrapup":{"description":"Call wrap up or disposition data.","$ref":"#/definitions/Wrapup"},"afterCallWork":{"description":"After-call work for the communication.","$ref":"#/definitions/AfterCallWork"},"afterCallWorkRequired":{"type":"boolean","description":"Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested."},"agentAssistantId":{"type":"string","description":"UUID of virtual agent assistant that provide suggestions to the agent participant during the conversation."}}},"Callback":{"type":"object","properties":{"state":{"type":"string","description":"The connection state of this communication.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","scheduled","none"],"x-genesys-enum-members":[{"name":"alerting"},{"name":"dialing"},{"name":"contacting"},{"name":"offering"},{"name":"connected"},{"name":"disconnected"},{"name":"terminated"},{"name":"scheduled"},{"name":"none"}]},"id":{"type":"string","description":"A globally unique identifier for this communication."},"segments":{"type":"array","description":"The time line of the participant's callback, divided into activity segments.","items":{"$ref":"#/definitions/Segment"}},"direction":{"type":"string","description":"The direction of the call","enum":["inbound","outbound"],"x-genesys-enum-members":[{"name":"inbound"},{"name":"outbound"}]},"held":{"type":"boolean","description":"True if this call is held and the person on this side hears silence."},"disconnectType":{"type":"string","description":"System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.","enum":["endpoint","client","system","timeout","transfer","transfer.conference","transfer.consult","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam","uncallable"],"x-genesys-enum-members":[{"name":"endpoint"},{"name":"client"},{"name":"system"},{"name":"timeout"},{"name":"transfer"},{"name":"transfer.conference"},{"name":"transfer.consult"},{"name":"transfer.forward"},{"name":"transfer.noanswer"},{"name":"transfer.notavailable"},{"name":"transport.failure"},{"name":"error"},{"name":"peer"},{"name":"other"},{"name":"spam"},{"name":"uncallable"}]},"startHoldTime":{"type":"string","format":"date-time","description":"The timestamp the callback was placed on hold in the cloud clock if the callback is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dialerPreview":{"description":"The preview data to be used when this callback is a Preview.","$ref":"#/definitions/DialerPreview"},"voicemail":{"description":"The voicemail data to be used when this callback is an ACD voicemail.","$ref":"#/definitions/Voicemail"},"callbackNumbers":{"type":"array","description":"The phone number(s) to use to place the callback.","items":{"type":"string"}},"callbackUserName":{"type":"string","description":"The name of the user requesting a callback."},"scriptId":{"type":"string","description":"The UUID of the script to use."},"externalCampaign":{"type":"boolean","description":"True if the call for the callback uses external dialing."},"skipEnabled":{"type":"boolean","description":"True if the ability to skip a callback should be enabled."},"timeoutSeconds":{"type":"integer","format":"int32","description":"The number of seconds before the system automatically places a call for a callback. 0 means the automatic placement is disabled."},"startAlertingTime":{"type":"string","format":"date-time","description":"The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"disconnectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"callbackScheduledTime":{"type":"string","format":"date-time","description":"The timestamp when this communication is scheduled in the provider clock. If this value is missing it indicates the callback will be placed immediately. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"automatedCallbackConfigId":{"type":"string","description":"The id of the config for automatically placing the callback (and handling the disposition). If null, the callback will not be placed automatically but routed to an agent as per normal."},"provider":{"type":"string","description":"The source provider for the callback."},"peerId":{"type":"string","description":"The id of the peer communication corresponding to a matching leg for this communication."},"wrapup":{"description":"Call wrap up or disposition data.","$ref":"#/definitions/Wrapup"},"afterCallWork":{"description":"After-call work for the communication.","$ref":"#/definitions/AfterCallWork"},"afterCallWorkRequired":{"type":"boolean","description":"Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested."}}},"Chat":{"type":"object","properties":{"jabberId":{"type":"string"}}},"Cobrowsesession":{"type":"object","properties":{"state":{"type":"string","description":"The connection state of this communication.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","scheduled","none"],"x-genesys-enum-members":[{"name":"alerting"},{"name":"dialing"},{"name":"contacting"},{"name":"offering"},{"name":"connected"},{"name":"disconnected"},{"name":"terminated"},{"name":"scheduled"},{"name":"none"}]},"id":{"type":"string","description":"A globally unique identifier for this communication."},"disconnectType":{"type":"string","description":"System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.","enum":["endpoint","client","system","timeout","transfer","transfer.conference","transfer.consult","transfer.forward","transport.failure","error","peer","other","spam","uncallable"],"x-genesys-enum-members":[{"name":"endpoint"},{"name":"client"},{"name":"system"},{"name":"timeout"},{"name":"transfer"},{"name":"transfer.conference"},{"name":"transfer.consult"},{"name":"transfer.forward"},{"name":"transport.failure"},{"name":"error"},{"name":"peer"},{"name":"other"},{"name":"spam"},{"name":"uncallable"}]},"self":{"description":"Address and name data for a call endpoint.","$ref":"#/definitions/Address"},"cobrowseSessionId":{"type":"string","description":"The co-browse session ID."},"cobrowseRole":{"type":"string","description":"This value identifies the role of the co-browse client within the co-browse session (a client is a sharer or a viewer)."},"controlling":{"type":"array","description":"ID of co-browse participants for which this client has been granted control (list is empty if this client cannot control any shared pages).","items":{"type":"string"}},"viewerUrl":{"type":"string","description":"The URL that can be used to open co-browse session in web browser."},"providerEventTime":{"type":"string","format":"date-time","description":"The time when the provider event which triggered this conversation update happened in the corrected provider clock (milliseconds since 1970-01-01 00:00:00 UTC). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startAlertingTime":{"type":"string","format":"date-time","description":"The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"disconnectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"provider":{"type":"string","description":"The source provider for the co-browse session."},"peerId":{"type":"string","description":"The id of the peer communication corresponding to a matching leg for this communication."},"segments":{"type":"array","description":"The time line of the participant's call, divided into activity segments.","items":{"$ref":"#/definitions/Segment"}},"wrapup":{"description":"Call wrap up or disposition data.","$ref":"#/definitions/Wrapup"},"afterCallWork":{"description":"After-call work for the communication.","$ref":"#/definitions/AfterCallWork"},"afterCallWorkRequired":{"type":"boolean","description":"Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested."}}},"Conversation":{"type":"object","required":["participants","startTime"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"startTime":{"type":"string","format":"date-time","description":"The time when the conversation started. This will be the time when the first participant joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The time when the conversation ended. This will be the time when the last participant left the conversation, or null when the conversation is still active. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"address":{"type":"string","description":"The address of the conversation as seen from an external participant. For phone calls this will be the DNIS for inbound calls and the ANI for outbound calls. For other media types this will be the address of the destination participant for inbound and the address of the initiating participant for outbound."},"participants":{"type":"array","description":"The list of all participants in the conversation.","items":{"$ref":"#/definitions/Participant"}},"conversationIds":{"type":"array","description":"A list of conversations to merge into this conversation to create a conference. This field is null except when being used to create a conference.","items":{"type":"string"}},"maxParticipants":{"type":"integer","format":"int32","description":"If this is a conference conversation, then this field indicates the maximum number of participants allowed to participant in the conference."},"recordingState":{"type":"string","description":"On update, 'paused' initiates a secure pause, 'active' resumes any paused recordings; otherwise indicates state of conversation recording.","enum":["ACTIVE","PAUSED","NONE"],"x-genesys-enum-members":[{"name":"ACTIVE"},{"name":"PAUSED"},{"name":"NONE"}]},"state":{"type":"string","description":"The conversation's state","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","converting","uploading","transmitting","none"],"x-genesys-enum-members":[{"name":"alerting"},{"name":"dialing"},{"name":"contacting"},{"name":"offering"},{"name":"connected"},{"name":"disconnected"},{"name":"terminated"},{"name":"converting"},{"name":"uploading"},{"name":"transmitting"},{"name":"none"}]},"divisions":{"type":"array","description":"Identifiers of divisions associated with this conversation","items":{"$ref":"#/definitions/ConversationDivisionMembership"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ConversationChat":{"type":"object","properties":{"state":{"type":"string","description":"The connection state of this communication.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","none"],"x-genesys-enum-members":[{"name":"alerting"},{"name":"dialing"},{"name":"contacting"},{"name":"offering"},{"name":"connected"},{"name":"disconnected"},{"name":"terminated"},{"name":"none"}]},"id":{"type":"string","description":"A globally unique identifier for this communication."},"roomId":{"type":"string","description":"The room id for the chat."},"recordingId":{"type":"string","description":"A globally unique identifier for the recording associated with this chat."},"segments":{"type":"array","description":"The time line of the participant's chat, divided into activity segments.","items":{"$ref":"#/definitions/Segment"}},"held":{"type":"boolean","description":"True if this call is held and the person on this side hears silence."},"direction":{"type":"string","description":"The direction of the chat","enum":["inbound","outbound"],"x-genesys-enum-members":[{"name":"inbound"},{"name":"outbound"}]},"disconnectType":{"type":"string","description":"System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.","enum":["endpoint","client","system","transfer","transfer.conference","transfer.consult","transfer.forward","error","peer","other","uncallable","timeout"],"x-genesys-enum-members":[{"name":"endpoint"},{"name":"client"},{"name":"system"},{"name":"transfer"},{"name":"transfer.conference"},{"name":"transfer.consult"},{"name":"transfer.forward"},{"name":"error"},{"name":"peer"},{"name":"other"},{"name":"uncallable"},{"name":"timeout"}]},"startHoldTime":{"type":"string","format":"date-time","description":"The timestamp the chat was placed on hold in the cloud clock if the chat is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startAlertingTime":{"type":"string","format":"date-time","description":"The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"disconnectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"provider":{"type":"string","description":"The source provider for the email."},"scriptId":{"type":"string","description":"The UUID of the script to use."},"peerId":{"type":"string","description":"The id of the peer communication corresponding to a matching leg for this communication."},"avatarImageUrl":{"type":"string","description":"If available, the URI to the avatar image of this communication."},"journeyContext":{"description":"A subset of the Journey System's data relevant to a part of a conversation (for external linkage and internal usage/context).","$ref":"#/definitions/JourneyContext"},"wrapup":{"description":"Call wrap up or disposition data.","$ref":"#/definitions/Wrapup"},"afterCallWork":{"description":"After-call work for the communication.","$ref":"#/definitions/AfterCallWork"},"afterCallWorkRequired":{"type":"boolean","description":"Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested."}}},"ConversationDivisionMembership":{"type":"object","properties":{"division":{"description":"A division the conversation belongs to.","$ref":"#/definitions/DomainEntityRef"},"entities":{"type":"array","description":"The entities on the conversation within the division. These are the users, queues, work flows, etc. that can be on conversations and and be assigned to different divisions.","items":{"$ref":"#/definitions/DomainEntityRef"}}}},"DialerPreview":{"type":"object","properties":{"id":{"type":"string"},"contactId":{"type":"string","description":"The contact associated with this preview data pop"},"contactListId":{"type":"string","description":"The contactList associated with this preview data pop."},"campaignId":{"type":"string","description":"The campaignId associated with this preview data pop."},"phoneNumberColumns":{"type":"array","description":"The phone number columns associated with this campaign","items":{"$ref":"#/definitions/PhoneNumberColumn"}}}},"DisconnectReason":{"type":"object","properties":{"type":{"type":"string","description":"Disconnect reason protocol type.","enum":["q850","sip"],"x-genesys-enum-members":[{"name":"q850"},{"name":"sip"}]},"code":{"type":"integer","format":"int32","description":"Protocol specific reason code. See the Q.850 and SIP specs."},"phrase":{"type":"string","description":"Human readable English description of the disconnect reason."}}},"DomainRole":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the role"},"name":{"type":"string","description":"The name of the role"}}},"Education":{"type":"object","properties":{"school":{"type":"string"},"fieldOfStudy":{"type":"string"},"notes":{"type":"string","description":"Notes about education has a 2000 character limit"},"dateStart":{"type":"string","format":"date","description":"Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"dateEnd":{"type":"string","format":"date","description":"Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"}}},"Email":{"type":"object","properties":{"state":{"type":"string","description":"The connection state of this communication.","enum":["alerting","connected","disconnected","none","transmitting"],"x-genesys-enum-members":[{"name":"alerting"},{"name":"connected"},{"name":"disconnected"},{"name":"none"},{"name":"transmitting"}]},"id":{"type":"string","description":"A globally unique identifier for this communication."},"held":{"type":"boolean","description":"True if this call is held and the person on this side hears silence."},"subject":{"type":"string","description":"The subject for the initial email that started this conversation."},"messagesSent":{"type":"integer","format":"int32","description":"The number of email messages sent by this participant."},"segments":{"type":"array","description":"The time line of the participant's email, divided into activity segments.","items":{"$ref":"#/definitions/Segment"}},"direction":{"type":"string","description":"The direction of the email","enum":["inbound","outbound"],"x-genesys-enum-members":[{"name":"inbound"},{"name":"outbound"}]},"recordingId":{"type":"string","description":"A globally unique identifier for the recording associated with this call."},"errorInfo":{"$ref":"#/definitions/ErrorBody"},"disconnectType":{"type":"string","description":"System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.","enum":["endpoint","client","system","timeout","transfer","transfer.conference","transfer.consult","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam","uncallable"],"x-genesys-enum-members":[{"name":"endpoint"},{"name":"client"},{"name":"system"},{"name":"timeout"},{"name":"transfer"},{"name":"transfer.conference"},{"name":"transfer.consult"},{"name":"transfer.forward"},{"name":"transfer.noanswer"},{"name":"transfer.notavailable"},{"name":"transport.failure"},{"name":"error"},{"name":"peer"},{"name":"other"},{"name":"spam"},{"name":"uncallable"}]},"startHoldTime":{"type":"string","format":"date-time","description":"The timestamp the email was placed on hold in the cloud clock if the email is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startAlertingTime":{"type":"string","format":"date-time","description":"The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"disconnectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"autoGenerated":{"type":"boolean","description":"Indicates that the email was auto-generated like an Out of Office reply."},"provider":{"type":"string","description":"The source provider for the email."},"scriptId":{"type":"string","description":"The UUID of the script to use."},"peerId":{"type":"string","description":"The id of the peer communication corresponding to a matching leg for this communication."},"messageId":{"type":"string","description":"A globally unique identifier for the stored content of this communication."},"draftAttachments":{"type":"array","description":"A list of uploaded attachments on the email draft.","items":{"$ref":"#/definitions/Attachment"}},"spam":{"type":"boolean","description":"Indicates if the inbound email was marked as spam."},"wrapup":{"description":"Call wrap up or disposition data.","$ref":"#/definitions/Wrapup"},"afterCallWork":{"description":"After-call work for the communication.","$ref":"#/definitions/AfterCallWork"},"afterCallWorkRequired":{"type":"boolean","description":"Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested."}}},"EmailAddress":{"type":"object","properties":{"email":{"type":"string"},"name":{"type":"string"}}},"EmployerInfo":{"type":"object","properties":{"officialName":{"type":"string"},"employeeId":{"type":"string"},"employeeType":{"type":"string"},"dateHire":{"type":"string"}}},"Evaluation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"conversation":{"$ref":"#/definitions/Conversation"},"evaluationForm":{"description":"Evaluation form used for evaluation.","$ref":"#/definitions/EvaluationForm"},"evaluator":{"$ref":"#/definitions/User"},"agent":{"$ref":"#/definitions/User"},"calibration":{"$ref":"#/definitions/Calibration"},"status":{"type":"string","enum":["PENDING","INPROGRESS","FINISHED"],"x-genesys-enum-members":[{"name":"PENDING"},{"name":"INPROGRESS"},{"name":"FINISHED"}]},"answers":{"$ref":"#/definitions/EvaluationScoringSet"},"agentHasRead":{"type":"boolean"},"releaseDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"assignedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"changedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"queue":{"$ref":"#/definitions/Queue"},"mediaType":{"type":"array","description":"List of different communication types used in conversation.","items":{"type":"string","enum":["CALL","CALLBACK","CHAT","COBROWSE","EMAIL","MESSAGE","SOCIAL_EXPRESSION","VIDEO","SCREENSHARE"],"x-genesys-enum-members":[{"name":"CALL"},{"name":"CALLBACK"},{"name":"CHAT"},{"name":"COBROWSE"},{"name":"EMAIL"},{"name":"MESSAGE"},{"name":"SOCIAL_EXPRESSION"},{"name":"VIDEO"},{"name":"SCREENSHARE"}]}},"rescore":{"type":"boolean","description":"Is only true when evaluation is re-scored."},"conversationDate":{"type":"string","format":"date-time","description":"Date of conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationEndDate":{"type":"string","format":"date-time","description":"End date of conversation if it had completed before evaluation creation. Null if created before the conversation ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"neverRelease":{"type":"boolean","description":"Signifies if the evaluation is never to be released. This cannot be set true if release date is also set."},"resourceId":{"type":"string","description":"Only used for email evaluations. Will be null for all other evaluations."},"resourceType":{"type":"string","description":"The type of resource. Only used for email evaluations. Will be null for evaluations on all other resources.","enum":["EMAIL"],"x-genesys-enum-members":[{"name":"EMAIL"}]},"redacted":{"type":"boolean","description":"Is only true when the user making the request does not have sufficient permissions to see evaluation"},"isScoringIndex":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EvaluationQuestionGroupScore":{"type":"object","properties":{"questionGroupId":{"type":"string"},"totalScore":{"type":"number","format":"float"},"maxTotalScore":{"type":"number","format":"float"},"markedNA":{"type":"boolean"},"totalCriticalScore":{"type":"number","format":"float"},"maxTotalCriticalScore":{"type":"number","format":"float"},"totalNonCriticalScore":{"type":"number","format":"float"},"maxTotalNonCriticalScore":{"type":"number","format":"float"},"totalScoreUnweighted":{"type":"number","format":"float"},"maxTotalScoreUnweighted":{"type":"number","format":"float"},"totalCriticalScoreUnweighted":{"type":"number","format":"float"},"maxTotalCriticalScoreUnweighted":{"type":"number","format":"float"},"totalNonCriticalScoreUnweighted":{"type":"number","format":"float"},"maxTotalNonCriticalScoreUnweighted":{"type":"number","format":"float"},"questionScores":{"type":"array","items":{"$ref":"#/definitions/EvaluationQuestionScore"}}}},"EvaluationQuestionScore":{"type":"object","properties":{"questionId":{"type":"string"},"answerId":{"type":"string"},"score":{"type":"integer","format":"int32"},"markedNA":{"type":"boolean"},"failedKillQuestion":{"type":"boolean"},"comments":{"type":"string"}}},"EvaluationScoringSet":{"type":"object","properties":{"totalScore":{"type":"number","format":"float"},"totalCriticalScore":{"type":"number","format":"float"},"totalNonCriticalScore":{"type":"number","format":"float"},"questionGroupScores":{"type":"array","items":{"$ref":"#/definitions/EvaluationQuestionGroupScore"}},"anyFailedKillQuestions":{"type":"boolean"},"comments":{"type":"string"},"agentComments":{"type":"string"}}},"ExpansionCriterium":{"type":"object","properties":{"type":{"type":"string","enum":["TIMEOUT_SECONDS"],"x-genesys-enum-members":[{"name":"TIMEOUT_SECONDS"}]},"threshold":{"type":"number","format":"double"}}},"FaxStatus":{"type":"object","properties":{"direction":{"type":"string","description":"The fax direction, either \"send\" or \"receive\"."},"expectedPages":{"type":"integer","format":"int64","description":"Total number of expected pages, if known."},"activePage":{"type":"integer","format":"int64","description":"Active page of the transmission."},"linesTransmitted":{"type":"integer","format":"int64","description":"Number of lines that have completed transmission."},"bytesTransmitted":{"type":"integer","format":"int64","description":"Number of bytes that have competed transmission."},"baudRate":{"type":"integer","format":"int64","description":"Current signaling rate of transmission, baud rate."},"pageErrors":{"type":"integer","format":"int64","description":"Number of page errors."},"lineErrors":{"type":"integer","format":"int64","description":"Number of line errors."}}},"Geolocation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"type":{"type":"string","description":"A string used to describe the type of client the geolocation is being updated from e.g. ios, android, web, etc."},"primary":{"type":"boolean","description":"A boolean used to tell whether or not to set this geolocation client as the primary on a PATCH"},"latitude":{"type":"number","format":"double"},"longitude":{"type":"number","format":"double"},"country":{"type":"string"},"region":{"type":"string"},"city":{"type":"string"},"locations":{"type":"array","items":{"$ref":"#/definitions/LocationDefinition"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Group":{"type":"object","required":["name","rulesVisible","type","visibility"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The group name."},"description":{"type":"string"},"dateModified":{"type":"string","format":"date-time","description":"Last modified date/time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"memberCount":{"type":"integer","format":"int64","description":"Number of members.","readOnly":true},"state":{"type":"string","description":"Active, inactive, or deleted state.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"version":{"type":"integer","format":"int32","description":"Current version for this resource.","readOnly":true},"type":{"type":"string","description":"Type of group.","enum":["official","social"],"x-genesys-enum-members":[{"name":"official"},{"name":"social"}]},"images":{"type":"array","items":{"$ref":"#/definitions/UserImage"}},"addresses":{"type":"array","items":{"$ref":"#/definitions/GroupContact"}},"rulesVisible":{"type":"boolean","description":"Are membership rules visible to the person requesting to view the group"},"visibility":{"type":"string","description":"Who can view this group","enum":["public","owners","members"]},"owners":{"type":"array","description":"Owners of the group","items":{"$ref":"#/definitions/User"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GroupContact":{"type":"object","required":["address","mediaType","type"],"properties":{"address":{"type":"string","description":"Phone number for this contact type"},"extension":{"type":"string","description":"Extension is set if the number is e164 valid"},"display":{"type":"string","description":"Formatted version of the address property","readOnly":true},"type":{"type":"string","description":"Contact type of the address","enum":["GROUPRING","GROUPPHONE"],"x-genesys-enum-members":[{"name":"GROUPRING"},{"name":"GROUPPHONE"}]},"mediaType":{"type":"string","description":"Media type of the address","enum":["PHONE"],"x-genesys-enum-members":[{"name":"PHONE"}]}}},"InboundRoute":{"type":"object","required":["fromEmail","fromName","pattern"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"pattern":{"type":"string","description":"The search pattern that the mailbox name should match."},"queue":{"description":"The queue to route the emails to.","$ref":"#/definitions/DomainEntityRef"},"priority":{"type":"integer","format":"int32","description":"The priority to use for routing."},"skills":{"type":"array","description":"The skills to use for routing.","items":{"$ref":"#/definitions/DomainEntityRef"}},"language":{"description":"The language to use for routing.","$ref":"#/definitions/DomainEntityRef"},"fromName":{"type":"string","description":"The sender name to use for outgoing replies."},"fromEmail":{"type":"string","description":"The sender email to use for outgoing replies."},"flow":{"description":"The flow to use for processing the email.","$ref":"#/definitions/DomainEntityRef"},"replyEmailAddress":{"description":"The route to use for email replies.","$ref":"#/definitions/QueueEmailAddress"},"autoBcc":{"type":"array","description":"The recipients that should be automatically blind copied on outbound emails associated with this InboundRoute.","items":{"$ref":"#/definitions/EmailAddress"}},"spamFlow":{"description":"The flow to use for processing inbound emails that have been marked as spam.","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Location":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the location"},"floorplanId":{"type":"string","description":"Unique identifier for the location floorplan image","readOnly":true},"coordinates":{"type":"object","description":"Users coordinates on the floorplan. Only used when floorplanImage is set","additionalProperties":{"type":"number","format":"double"}},"notes":{"type":"string","description":"Optional description on the users location"},"locationDefinition":{"$ref":"#/definitions/LocationDefinition"}}},"MediaSetting":{"type":"object","properties":{"alertingTimeoutSeconds":{"type":"integer","format":"int32"},"serviceLevel":{"$ref":"#/definitions/ServiceLevel"}}},"MediaSummary":{"type":"object","properties":{"contactCenter":{"$ref":"#/definitions/MediaSummaryDetail"},"enterprise":{"$ref":"#/definitions/MediaSummaryDetail"}}},"MediaSummaryDetail":{"type":"object","properties":{"active":{"type":"integer","format":"int32"},"acw":{"type":"integer","format":"int32"}}},"Message":{"type":"object","properties":{"state":{"type":"string","description":"The connection state of this communication.","enum":["alerting","connected","disconnected"],"x-genesys-enum-members":[{"name":"alerting"},{"name":"connected"},{"name":"disconnected"}]},"id":{"type":"string","description":"A globally unique identifier for this communication."},"held":{"type":"boolean","description":"True if this call is held and the person on this side hears silence."},"segments":{"type":"array","description":"The time line of the participant's message, divided into activity segments.","items":{"$ref":"#/definitions/Segment"}},"direction":{"type":"string","description":"The direction of the message.","enum":["inbound","outbound"],"x-genesys-enum-members":[{"name":"inbound"},{"name":"outbound"}]},"recordingId":{"type":"string","description":"A globally unique identifier for the recording associated with this message."},"errorInfo":{"$ref":"#/definitions/ErrorBody"},"disconnectType":{"type":"string","description":"System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.","enum":["endpoint","client","system","timeout","transfer","transfer.conference","transfer.consult","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam","uncallable"],"x-genesys-enum-members":[{"name":"endpoint"},{"name":"client"},{"name":"system"},{"name":"timeout"},{"name":"transfer"},{"name":"transfer.conference"},{"name":"transfer.consult"},{"name":"transfer.forward"},{"name":"transfer.noanswer"},{"name":"transfer.notavailable"},{"name":"transport.failure"},{"name":"error"},{"name":"peer"},{"name":"other"},{"name":"spam"},{"name":"uncallable"}]},"startHoldTime":{"type":"string","format":"date-time","description":"The timestamp the message was placed on hold in the cloud clock if the message is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startAlertingTime":{"type":"string","format":"date-time","description":"The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"disconnectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"provider":{"type":"string","description":"The source provider for the message."},"type":{"type":"string","description":"Indicates the type of message platform from which the message originated.","enum":["unknown","sms","twitter","facebook","line","whatsapp","telegram","kakao","webmessaging"],"x-genesys-enum-members":[{"name":"unknown"},{"name":"sms"},{"name":"twitter"},{"name":"facebook"},{"name":"line"},{"name":"whatsapp"},{"name":"telegram"},{"name":"kakao"},{"name":"webmessaging"}]},"recipientCountry":{"type":"string","description":"Indicates the country where the recipient is associated in ISO 3166-1 alpha-2 format."},"recipientType":{"type":"string","description":"The type of the recipient. Eg: Provisioned phoneNumber is the recipient for sms message type."},"scriptId":{"type":"string","description":"The UUID of the script to use."},"peerId":{"type":"string","description":"The id of the peer communication corresponding to a matching leg for this communication."},"toAddress":{"description":"Address and name data for a call endpoint.","$ref":"#/definitions/Address"},"fromAddress":{"description":"Address and name data for a call endpoint.","$ref":"#/definitions/Address"},"messages":{"type":"array","description":"The messages sent on this communication channel.","items":{"$ref":"#/definitions/MessageDetails"}},"journeyContext":{"description":"A subset of the Journey System's data relevant to a part of a conversation (for external linkage and internal usage/context).","$ref":"#/definitions/JourneyContext"},"wrapup":{"description":"Call wrap up or disposition data.","$ref":"#/definitions/Wrapup"},"afterCallWork":{"description":"After-call work for the communication.","$ref":"#/definitions/AfterCallWork"},"afterCallWorkRequired":{"type":"boolean","description":"Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested."}}},"MessageDetails":{"type":"object","properties":{"messageId":{"type":"string","description":"UUID identifying the message media."},"messageURI":{"type":"string","format":"uri","description":"A URI for this message entity."},"messageStatus":{"type":"string","description":"Indicates the delivery status of the message.","enum":["queued","sent","failed","received","delivery-success","delivery-failed","read"],"x-genesys-enum-members":[{"name":"queued"},{"name":"sent"},{"name":"failed"},{"name":"received"},{"name":"delivery-success"},{"name":"delivery-failed"},{"name":"read"}]},"messageSegmentCount":{"type":"integer","format":"int32","description":"The message segment count, greater than 1 if the message content was split into multiple parts for this message type, e.g. SMS character limits."},"messageTime":{"type":"string","format":"date-time","description":"The time when the message was sent or received. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"media":{"type":"array","description":"The media (images, files, etc) associated with this message, if any","items":{"$ref":"#/definitions/MessageMedia"}},"stickers":{"type":"array","description":"One or more stickers associated with this message, if any","items":{"$ref":"#/definitions/MessageSticker"}}}},"MessageMedia":{"type":"object","properties":{"url":{"type":"string","description":"The location of the media, useful for retrieving it"},"mediaType":{"type":"string","description":"The optional internet media type of the the media object. If null then the media type should be dictated by the url"},"contentLengthBytes":{"type":"integer","format":"int32","description":"The optional content length of the the media object, in bytes."},"name":{"type":"string","description":"The optional name of the the media object."},"id":{"type":"string","description":"The optional id of the the media object."}}},"MessageSticker":{"type":"object","properties":{"url":{"type":"string","description":"The location of the sticker, useful for retrieving it"},"id":{"type":"string","description":"The unique id of the the sticker object."}}},"OAuthLastTokenIssued":{"type":"object","properties":{"dateIssued":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"OutOfOffice":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"user":{"$ref":"#/definitions/User"},"startDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"active":{"type":"boolean"},"indefinite":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Page":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"versionId":{"type":"string"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"rootContainer":{"type":"object","additionalProperties":{"type":"object"}},"properties":{"type":"object","additionalProperties":{"type":"object"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Participant":{"type":"object","properties":{"id":{"type":"string","description":"A globally unique identifier for this conversation."},"startTime":{"type":"string","format":"date-time","description":"The timestamp when this participant joined the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The timestamp when this participant disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The timestamp when this participant was connected to the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"name":{"type":"string","description":"A human readable name identifying the participant."},"userUri":{"type":"string","description":"If this participant represents a user, then this will be an URI that can be used to fetch the user."},"userId":{"type":"string","description":"If this participant represents a user, then this will be the globally unique identifier for the user."},"externalContactId":{"type":"string","description":"If this participant represents an external contact, then this will be the globally unique identifier for the external contact."},"externalOrganizationId":{"type":"string","description":"If this participant represents an external org, then this will be the globally unique identifier for the external org."},"queueId":{"type":"string","description":"If present, the queue id that the communication channel came in on."},"groupId":{"type":"string","description":"If present, group of users the participant represents."},"teamId":{"type":"string","description":"The team id that this participant is a member of when added to the conversation."},"queueName":{"type":"string","description":"If present, the queue name that the communication channel came in on."},"purpose":{"type":"string","description":"A well known string that specifies the purpose of this participant."},"participantType":{"type":"string","description":"A well known string that specifies the type of this participant."},"consultParticipantId":{"type":"string","description":"If this participant is part of a consult transfer, then this will be the participant id of the participant being transferred."},"address":{"type":"string","description":"The address for the this participant. For a phone call this will be the ANI."},"ani":{"type":"string","description":"The address for the this participant. For a phone call this will be the ANI."},"aniName":{"type":"string","description":"The ani-based name for this participant."},"dnis":{"type":"string","description":"The address for the this participant. For a phone call this will be the ANI."},"locale":{"type":"string","description":"An ISO 639 language code specifying the locale for this participant"},"wrapupRequired":{"type":"boolean","description":"True iff this participant is required to enter wrapup for this conversation."},"wrapupPrompt":{"type":"string","description":"This field controls how the UI prompts the agent for a wrapup.","enum":["mandatory","optional","agentRequested","timeout","forcedTimeout"],"x-genesys-enum-members":[{"name":"mandatory"},{"name":"optional"},{"name":"agentRequested"},{"name":"timeout"},{"name":"forcedTimeout"}]},"wrapupTimeoutMs":{"type":"integer","format":"int32","description":"Specifies how long a timed ACW session will last."},"wrapupSkipped":{"type":"boolean","description":"The UI sets this field when the agent chooses to skip entering a wrapup for this participant."},"wrapup":{"description":"Call wrap up or disposition data.","$ref":"#/definitions/Wrapup"},"conversationRoutingData":{"description":"Information on how a communication should be routed to an agent.","$ref":"#/definitions/ConversationRoutingData"},"alertingTimeoutMs":{"type":"integer","format":"int32","description":"Specifies how long the agent has to answer an interaction before being marked as not responding."},"monitoredParticipantId":{"type":"string","description":"If this participant is a monitor, then this will be the id of the participant that is being monitored."},"coachedParticipantId":{"type":"string","description":"If this participant is a coach, then this will be the id of the participant that is being coached."},"attributes":{"type":"object","description":"Additional participant attributes","additionalProperties":{"type":"string"}},"calls":{"type":"array","items":{"$ref":"#/definitions/Call"}},"callbacks":{"type":"array","items":{"$ref":"#/definitions/Callback"}},"chats":{"type":"array","items":{"$ref":"#/definitions/ConversationChat"}},"cobrowsesessions":{"type":"array","items":{"$ref":"#/definitions/Cobrowsesession"}},"emails":{"type":"array","items":{"$ref":"#/definitions/Email"}},"messages":{"type":"array","items":{"$ref":"#/definitions/Message"}},"screenshares":{"type":"array","items":{"$ref":"#/definitions/Screenshare"}},"socialExpressions":{"type":"array","items":{"$ref":"#/definitions/SocialExpression"}},"videos":{"type":"array","items":{"$ref":"#/definitions/Video"}},"evaluations":{"type":"array","items":{"$ref":"#/definitions/Evaluation"}},"screenRecordingState":{"type":"string","description":"The current screen recording state for this participant.","enum":["requested","active","paused","stopped","error","timeout"],"x-genesys-enum-members":[{"name":"requested"},{"name":"active"},{"name":"paused"},{"name":"stopped"},{"name":"error"},{"name":"timeout"}]},"flaggedReason":{"type":"string","description":"The reason specifying why participant flagged the conversation.","enum":["general"],"x-genesys-enum-members":[{"name":"general"}]},"startAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"PhoneNumberColumn":{"type":"object","properties":{"columnName":{"type":"string"},"type":{"type":"string"}}},"PresenceDefinition":{"type":"object","properties":{"id":{"type":"string","description":"description"},"systemPresence":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Queue":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The queue description."},"dateCreated":{"type":"string","format":"date-time","description":"The date the queue was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the queue. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the queue."},"createdBy":{"type":"string","description":"The ID of the user that created the queue."},"memberCount":{"type":"integer","format":"int32","description":"The number of users in the queue.","readOnly":true},"mediaSettings":{"type":"object","description":"The media settings for the queue. Valid key values: CALL, CALLBACK, CHAT, EMAIL, MESSAGE, SOCIAL_EXPRESSION, VIDEO_COMM","additionalProperties":{"$ref":"#/definitions/MediaSetting"}},"routingRules":{"type":"array","description":"The routing rules for the queue, used for routing to known or preferred agents.","items":{"$ref":"#/definitions/RoutingRule"}},"bullseye":{"description":"The bulls-eye settings for the queue.","$ref":"#/definitions/Bullseye"},"acwSettings":{"description":"The ACW settings for the queue.","$ref":"#/definitions/AcwSettings"},"skillEvaluationMethod":{"type":"string","description":"The skill evaluation method to use when routing conversations.","enum":["NONE","BEST","ALL"],"x-genesys-enum-members":[{"name":"NONE"},{"name":"BEST"},{"name":"ALL"}]},"queueFlow":{"description":"The in-queue flow to use for conversations waiting in queue.","$ref":"#/definitions/DomainEntityRef"},"whisperPrompt":{"description":"The prompt used for whisper on the queue, if configured.","$ref":"#/definitions/DomainEntityRef"},"autoAnswerOnly":{"type":"boolean","description":"Specifies whether the configured whisper should play for all ACD calls, or only for those which are auto-answered."},"enableTranscription":{"type":"boolean","description":"Indicates whether voice transcription is enabled for this queue."},"enableManualAssignment":{"type":"boolean","description":"Indicates whether manual assignment is enabled for this queue."},"callingPartyName":{"type":"string","description":"The name to use for caller identification for outbound calls from this queue."},"callingPartyNumber":{"type":"string","description":"The phone number to use for caller identification for outbound calls from this queue."},"defaultScripts":{"type":"object","description":"The default script Ids for the communication types.","additionalProperties":{"$ref":"#/definitions/Script"}},"outboundMessagingAddresses":{"description":"The messaging addresses for the queue.","$ref":"#/definitions/QueueMessagingAddresses"},"outboundEmailAddress":{"$ref":"#/definitions/QueueEmailAddress"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"QueueEmailAddress":{"type":"object","properties":{"domain":{"$ref":"#/definitions/DomainEntityRef"},"route":{"$ref":"#/definitions/InboundRoute"}}},"QueueMessagingAddresses":{"type":"object","properties":{"smsAddress":{"$ref":"#/definitions/DomainEntityRef"}}},"ResourceConditionNode":{"type":"object","properties":{"variableName":{"type":"string"},"conjunction":{"type":"string","enum":["AND","OR"],"x-genesys-enum-members":[{"name":"AND"},{"name":"OR"}]},"operator":{"type":"string","enum":["EQ","IN","GE","GT","LE","LT"],"x-genesys-enum-members":[{"name":"EQ"},{"name":"IN"},{"name":"GE"},{"name":"GT"},{"name":"LE"},{"name":"LT"}]},"operands":{"type":"array","items":{"$ref":"#/definitions/ResourceConditionValue"}},"terms":{"type":"array","items":{"$ref":"#/definitions/ResourceConditionNode"}}}},"ResourceConditionValue":{"type":"object","properties":{"type":{"type":"string","enum":["SCALAR","VARIABLE","USER","QUEUE"],"x-genesys-enum-members":[{"name":"SCALAR"},{"name":"VARIABLE"},{"name":"USER"},{"name":"QUEUE"}]},"value":{"type":"string"}}},"ResourcePermissionPolicy":{"type":"object","properties":{"id":{"type":"string"},"domain":{"type":"string"},"entityName":{"type":"string"},"policyName":{"type":"string"},"policyDescription":{"type":"string"},"actionSetKey":{"type":"string"},"allowConditions":{"type":"boolean"},"resourceConditionNode":{"$ref":"#/definitions/ResourceConditionNode"},"namedResources":{"type":"array","items":{"type":"string"}},"resourceCondition":{"type":"string"},"actionSet":{"type":"array","uniqueItems":true,"items":{"type":"string"}}}},"Ring":{"type":"object","properties":{"expansionCriteria":{"type":"array","items":{"$ref":"#/definitions/ExpansionCriterium"}},"actions":{"$ref":"#/definitions/Actions"}}},"RoutingRule":{"type":"object","properties":{"operator":{"type":"string","description":"matching operator. MEETS_THRESHOLD matches any agent with a score at or above the rule's threshold. ANY matches all specified agents, regardless of score.","enum":["MEETS_THRESHOLD","ANY"],"x-genesys-enum-members":[{"name":"MEETS_THRESHOLD"},{"name":"ANY"}]},"threshold":{"type":"integer","format":"int32","description":"threshold required for routing attempt (generally an agent score). may be null for operator ANY."},"waitSeconds":{"type":"number","format":"double","description":"seconds to wait in this rule before moving to the next"}}},"RoutingStatus":{"type":"object","properties":{"userId":{"type":"string","description":"The userId of the agent"},"status":{"type":"string","description":"Indicates the Routing State of the agent. A value of OFF_QUEUE will be returned if the specified user does not exist.","enum":["OFF_QUEUE","IDLE","INTERACTING","NOT_RESPONDING","COMMUNICATING"],"x-genesys-enum-members":[{"name":"OFF_QUEUE"},{"name":"IDLE"},{"name":"INTERACTING"},{"name":"NOT_RESPONDING"},{"name":"COMMUNICATING"}]},"startTime":{"type":"string","format":"date-time","description":"The timestamp when the agent went into this state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"Screenshare":{"type":"object","properties":{"state":{"type":"string","description":"The connection state of this communication.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","none"],"x-genesys-enum-members":[{"name":"alerting"},{"name":"dialing"},{"name":"contacting"},{"name":"offering"},{"name":"connected"},{"name":"disconnected"},{"name":"terminated"},{"name":"none"}]},"id":{"type":"string","description":"A globally unique identifier for this communication."},"context":{"type":"string","description":"The room id context (xmpp jid) for the conference session."},"sharing":{"type":"boolean","description":"Indicates whether this participant is sharing their screen."},"peerCount":{"type":"integer","format":"int32","description":"The number of peer participants from the perspective of the participant in the conference."},"disconnectType":{"type":"string","description":"System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.","enum":["endpoint","client","system","timeout","transfer","transfer.conference","transfer.consult","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam","uncallable"],"x-genesys-enum-members":[{"name":"endpoint"},{"name":"client"},{"name":"system"},{"name":"timeout"},{"name":"transfer"},{"name":"transfer.conference"},{"name":"transfer.consult"},{"name":"transfer.forward"},{"name":"transfer.noanswer"},{"name":"transfer.notavailable"},{"name":"transport.failure"},{"name":"error"},{"name":"peer"},{"name":"other"},{"name":"spam"},{"name":"uncallable"}]},"startAlertingTime":{"type":"string","format":"date-time","description":"The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"disconnectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"provider":{"type":"string","description":"The source provider for the screen share."},"peerId":{"type":"string","description":"The id of the peer communication corresponding to a matching leg for this communication."},"segments":{"type":"array","description":"The time line of the participant's call, divided into activity segments.","items":{"$ref":"#/definitions/Segment"}},"wrapup":{"description":"Call wrap up or disposition data.","$ref":"#/definitions/Wrapup"},"afterCallWork":{"description":"After-call work for the communication.","$ref":"#/definitions/AfterCallWork"},"afterCallWorkRequired":{"type":"boolean","description":"Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested."}}},"Script":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"versionId":{"type":"string"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"publishedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"versionDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startPageId":{"type":"string"},"startPageName":{"type":"string"},"features":{"type":"object"},"variables":{"type":"object"},"customActions":{"type":"object"},"pages":{"type":"array","items":{"$ref":"#/definitions/Page"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Segment":{"type":"object","required":["endTime","startTime"],"properties":{"startTime":{"type":"string","format":"date-time","description":"The timestamp when this segment began. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The timestamp when this segment ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"type":{"type":"string","description":"The activity taking place for the participant in the segment."},"howEnded":{"type":"string","description":"A description of the event that ended the segment."},"disconnectType":{"type":"string","description":"A description of the event that disconnected the segment"}}},"ServiceLevel":{"type":"object","properties":{"percentage":{"type":"number","format":"double","description":"The desired Service Level. A value between 0 and 1."},"durationMs":{"type":"integer","format":"int64","description":"Service Level target in milliseconds."}}},"SkillsToRemove":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"selfUri":{"type":"string","format":"uri"}}},"SocialExpression":{"type":"object","properties":{"state":{"type":"string","description":"The connection state of this communication.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","none"],"x-genesys-enum-members":[{"name":"alerting"},{"name":"dialing"},{"name":"contacting"},{"name":"offering"},{"name":"connected"},{"name":"disconnected"},{"name":"terminated"},{"name":"none"}]},"id":{"type":"string","description":"A globally unique identifier for this communication."},"socialMediaId":{"type":"string","description":"A globally unique identifier for the social media."},"socialMediaHub":{"type":"string","description":"The social network of the communication"},"socialUserName":{"type":"string","description":"The user name for the communication."},"previewText":{"type":"string","description":"The text preview of the communication contents"},"recordingId":{"type":"string","description":"A globally unique identifier for the recording associated with this chat."},"segments":{"type":"array","description":"The time line of the participant's chat, divided into activity segments.","items":{"$ref":"#/definitions/Segment"}},"held":{"type":"boolean","description":"True if this call is held and the person on this side hears silence."},"disconnectType":{"type":"string","description":"System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.","enum":["endpoint","client","system","timeout","transfer","transfer.conference","transfer.consult","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam","uncallable"],"x-genesys-enum-members":[{"name":"endpoint"},{"name":"client"},{"name":"system"},{"name":"timeout"},{"name":"transfer"},{"name":"transfer.conference"},{"name":"transfer.consult"},{"name":"transfer.forward"},{"name":"transfer.noanswer"},{"name":"transfer.notavailable"},{"name":"transport.failure"},{"name":"error"},{"name":"peer"},{"name":"other"},{"name":"spam"},{"name":"uncallable"}]},"startHoldTime":{"type":"string","format":"date-time","description":"The timestamp the chat was placed on hold in the cloud clock if the chat is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startAlertingTime":{"type":"string","format":"date-time","description":"The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"disconnectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"provider":{"type":"string","description":"The source provider for the social expression."},"scriptId":{"type":"string","description":"The UUID of the script to use."},"peerId":{"type":"string","description":"The id of the peer communication corresponding to a matching leg for this communication."},"wrapup":{"description":"Call wrap up or disposition data.","$ref":"#/definitions/Wrapup"},"afterCallWork":{"description":"After-call work for the communication.","$ref":"#/definitions/AfterCallWork"},"afterCallWorkRequired":{"type":"boolean","description":"Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested."}}},"Team":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The team name"},"description":{"type":"string","description":"Team information."},"dateModified":{"type":"string","format":"date-time","description":"Last modified datetime. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"memberCount":{"type":"integer","format":"int64","description":"Number of members in a team","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"User":{"type":"object","required":["version"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"chat":{"$ref":"#/definitions/Chat"},"department":{"type":"string"},"email":{"type":"string"},"primaryContactInfo":{"type":"array","description":"Auto populated from addresses.","readOnly":true,"items":{"$ref":"#/definitions/Contact"}},"addresses":{"type":"array","description":"Email addresses and phone numbers for this user","items":{"$ref":"#/definitions/Contact"}},"state":{"type":"string","description":"The current state for this user.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"title":{"type":"string"},"username":{"type":"string"},"manager":{"$ref":"#/definitions/User"},"images":{"type":"array","items":{"$ref":"#/definitions/UserImage"}},"version":{"type":"integer","format":"int32","description":"Required when updating a user, this value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH."},"certifications":{"type":"array","items":{"type":"string"}},"biography":{"$ref":"#/definitions/Biography"},"employerInfo":{"$ref":"#/definitions/EmployerInfo"},"routingStatus":{"description":"ACD routing status","readOnly":true,"$ref":"#/definitions/RoutingStatus"},"presence":{"description":"Active presence","readOnly":true,"$ref":"#/definitions/UserPresence"},"conversationSummary":{"description":"Summary of conversion statistics for conversation types.","readOnly":true,"$ref":"#/definitions/UserConversationSummary"},"outOfOffice":{"description":"Determine if out of office is enabled","readOnly":true,"$ref":"#/definitions/OutOfOffice"},"geolocation":{"description":"Current geolocation position","readOnly":true,"$ref":"#/definitions/Geolocation"},"station":{"description":"Effective, default, and last station information","readOnly":true,"$ref":"#/definitions/UserStations"},"authorization":{"description":"Roles and permissions assigned to the user","readOnly":true,"$ref":"#/definitions/UserAuthorization"},"profileSkills":{"type":"array","description":"Profile skills possessed by the user","readOnly":true,"items":{"type":"string"}},"locations":{"type":"array","description":"The user placement at each site location.","readOnly":true,"items":{"$ref":"#/definitions/Location"}},"groups":{"type":"array","description":"The groups the user is a member of","readOnly":true,"items":{"$ref":"#/definitions/Group"}},"team":{"description":"The team the user is a member of","readOnly":true,"$ref":"#/definitions/Team"},"skills":{"type":"array","description":"Routing (ACD) skills possessed by the user","readOnly":true,"items":{"$ref":"#/definitions/UserRoutingSkill"}},"languages":{"type":"array","description":"Routing (ACD) languages possessed by the user","readOnly":true,"items":{"$ref":"#/definitions/UserRoutingLanguage"}},"acdAutoAnswer":{"type":"boolean","description":"acd auto answer"},"languagePreference":{"type":"string","description":"preferred language by the user","readOnly":true},"lastTokenIssued":{"$ref":"#/definitions/OAuthLastTokenIssued"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserAuthorization":{"type":"object","properties":{"roles":{"type":"array","items":{"$ref":"#/definitions/DomainRole"}},"unusedRoles":{"type":"array","description":"A collection of the roles the user is not using","readOnly":true,"items":{"$ref":"#/definitions/DomainRole"}},"permissions":{"type":"array","description":"A collection of the permissions granted by all assigned roles","readOnly":true,"items":{"type":"string"}},"permissionPolicies":{"type":"array","description":"The policies configured for assigned permissions.","readOnly":true,"items":{"$ref":"#/definitions/ResourcePermissionPolicy"}}}},"UserConversationSummary":{"type":"object","properties":{"userId":{"type":"string"},"call":{"$ref":"#/definitions/MediaSummary"},"callback":{"$ref":"#/definitions/MediaSummary"},"email":{"$ref":"#/definitions/MediaSummary"},"message":{"$ref":"#/definitions/MediaSummary"},"chat":{"$ref":"#/definitions/MediaSummary"},"socialExpression":{"$ref":"#/definitions/MediaSummary"},"video":{"$ref":"#/definitions/MediaSummary"}}},"UserImage":{"type":"object","properties":{"resolution":{"type":"string","description":"Height and/or width of image. ex: 640x480 or x128"},"imageUri":{"type":"string"}}},"UserPresence":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"source":{"type":"string","description":"Represents the source where the Presence was set. Some examples are: PURECLOUD, LYNC, OUTLOOK, etc."},"primary":{"type":"boolean","description":"A boolean used to tell whether or not to set this presence source as the primary on a PATCH"},"presenceDefinition":{"$ref":"#/definitions/PresenceDefinition"},"message":{"type":"string"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserRoutingLanguage":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"proficiency":{"type":"number","format":"double","description":"A rating from 0.0 to 5.0 that indicates how fluent an agent is in a particular language. ACD interactions are routed to agents with higher proficiency ratings."},"state":{"type":"string","description":"Activate or deactivate this routing language.","enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"languageUri":{"type":"string","format":"uri","description":"URI to the organization language used by this user language.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Represents an organization language assigned to a user. When assigning to a user specify the organization language id as the id."},"UserRoutingSkill":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"proficiency":{"type":"number","format":"double","description":"A rating from 0.0 to 5.0 that indicates how adept an agent is at a particular skill. When \"Best available skills\" is enabled for a queue in Genesys Cloud, ACD interactions in that queue are routed to agents with higher proficiency ratings."},"state":{"type":"string","description":"Activate or deactivate this routing skill.","enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"skillUri":{"type":"string","format":"uri","description":"URI to the organization skill used by this user skill.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Represents an organization skill assigned to a user. When assigning to a user specify the organization skill id as the id."},"UserStation":{"type":"object","properties":{"id":{"type":"string","description":"A globally unique identifier for this station","readOnly":true},"name":{"type":"string"},"type":{"type":"string"},"associatedUser":{"$ref":"#/definitions/User"},"associatedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"defaultUser":{"$ref":"#/definitions/User"},"providerInfo":{"type":"object","description":"Provider-specific info for this station, e.g. { \"edgeGroupId\": \"ffe7b15c-a9cc-4f4c-88f5-781327819a49\" }","additionalProperties":{"type":"string"}}}},"UserStations":{"type":"object","properties":{"associatedStation":{"description":"Current associated station for this user.","readOnly":true,"$ref":"#/definitions/UserStation"},"effectiveStation":{"description":"The station where the user can be reached based on their default and associated station.","readOnly":true,"$ref":"#/definitions/UserStation"},"defaultStation":{"description":"Default station to be used if not associated with a station.","readOnly":true,"$ref":"#/definitions/UserStation"},"lastAssociatedStation":{"description":"Last associated station for this user.","readOnly":true,"$ref":"#/definitions/UserStation"}}},"Video":{"type":"object","properties":{"state":{"type":"string","description":"The connection state of this communication.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","none"],"x-genesys-enum-members":[{"name":"alerting"},{"name":"dialing"},{"name":"contacting"},{"name":"offering"},{"name":"connected"},{"name":"disconnected"},{"name":"terminated"},{"name":"none"}]},"id":{"type":"string","description":"A globally unique identifier for this communication."},"context":{"type":"string","description":"The room id context (xmpp jid) for the conference session."},"audioMuted":{"type":"boolean","description":"Indicates whether this participant has muted their outgoing audio."},"videoMuted":{"type":"boolean","description":"Indicates whether this participant has muted/paused their outgoing video."},"sharingScreen":{"type":"boolean","description":"Indicates whether this participant is sharing their screen to the session."},"peerCount":{"type":"integer","format":"int32","description":"The number of peer participants from the perspective of the participant in the conference."},"disconnectType":{"type":"string","description":"System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.","enum":["endpoint","client","system","timeout","transfer","transfer.conference","transfer.consult","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam","uncallable"],"x-genesys-enum-members":[{"name":"endpoint"},{"name":"client"},{"name":"system"},{"name":"timeout"},{"name":"transfer"},{"name":"transfer.conference"},{"name":"transfer.consult"},{"name":"transfer.forward"},{"name":"transfer.noanswer"},{"name":"transfer.notavailable"},{"name":"transport.failure"},{"name":"error"},{"name":"peer"},{"name":"other"},{"name":"spam"},{"name":"uncallable"}]},"startAlertingTime":{"type":"string","format":"date-time","description":"The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"disconnectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"provider":{"type":"string","description":"The source provider for the video."},"peerId":{"type":"string","description":"The id of the peer communication corresponding to a matching leg for this communication."},"msids":{"type":"array","description":"List of media stream ids","items":{"type":"string"}},"self":{"description":"Address and name data for a call endpoint.","$ref":"#/definitions/Address"},"wrapup":{"description":"Call wrap up or disposition data.","$ref":"#/definitions/Wrapup"},"afterCallWork":{"description":"After-call work for the communication.","$ref":"#/definitions/AfterCallWork"},"afterCallWorkRequired":{"type":"boolean","description":"Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested."}}},"Voicemail":{"type":"object","properties":{"id":{"type":"string","description":"The voicemail id"},"uploadStatus":{"type":"string","description":"current state of the voicemail upload","enum":["pending","complete","failed","timeout","none"],"x-genesys-enum-members":[{"name":"pending"},{"name":"complete"},{"name":"failed"},{"name":"timeout"},{"name":"none"}]}}},"AssignedWrapupCode":{"type":"object","properties":{"code":{"type":"string","description":"The user configured wrap up code id."},"notes":{"type":"string","description":"Text entered by the agent to describe the call or disposition."},"tags":{"type":"array","description":"List of tags selected by the agent to describe the call or disposition.","items":{"type":"string"}},"durationSeconds":{"type":"integer","format":"int32","description":"The duration in seconds of the wrap-up segment."},"endTime":{"type":"string","format":"date-time","description":"The timestamp when the wrap-up segment ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"Empty":{"type":"object"},"MediaParticipantRequest":{"type":"object","properties":{"wrapup":{"description":"Wrap-up to assign to this participant.","$ref":"#/definitions/Wrapup"},"state":{"type":"string","description":"The state to update to set for this participant's communications. Possible values are: 'connected' and 'disconnected'.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","converting","uploading","transmitting","none"],"x-genesys-enum-members":[{"name":"alerting"},{"name":"dialing"},{"name":"contacting"},{"name":"offering"},{"name":"connected"},{"name":"disconnected"},{"name":"terminated"},{"name":"converting"},{"name":"uploading"},{"name":"transmitting"},{"name":"none"}]},"recording":{"type":"boolean","description":"True to enable recording of this participant, otherwise false to disable recording."},"muted":{"type":"boolean","description":"True to mute this conversation participant."},"confined":{"type":"boolean","description":"True to confine this conversation participant. Should only be used for ad-hoc conferences"},"held":{"type":"boolean","description":"True to hold this conversation participant."},"wrapupSkipped":{"type":"boolean","description":"True to skip wrap-up for this participant."}}},"TransferRequest":{"type":"object","properties":{"userId":{"type":"string","description":"The user ID of the transfer target."},"address":{"type":"string","description":"The phone number or address of the transfer target."},"userName":{"type":"string","description":"The user name of the transfer target."},"queueId":{"type":"string","description":"The queue ID of the transfer target."},"voicemail":{"type":"boolean","description":"If true, transfer to the voicemail inbox of the participant that is being replaced."}}},"FlowMilestone":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The flow milestone identifier","readOnly":true},"name":{"type":"string","description":"The flow milestone name."},"description":{"type":"string","description":"The flow milestone description."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EncryptionKey":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"createDate":{"type":"string","format":"date-time","description":"create date of the key pair. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"keydataSummary":{"type":"string","description":"key data summary (base 64 encoded public key)"},"user":{"description":"user that requested generation of public key","$ref":"#/definitions/User"},"localEncryptionConfiguration":{"description":"Local configuration","$ref":"#/definitions/LocalEncryptionConfiguration"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EncryptionKeyEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/EncryptionKey"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"LocalEncryptionConfiguration":{"type":"object","required":["apiId","apiKey","url"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"url":{"type":"string","description":"The url for decryption. This must specify the path to where Purecloud can requests decryption"},"apiId":{"type":"string","description":"The api id for Hawk Authentication."},"apiKey":{"type":"string","description":"The api shared symmetric key used for hawk authentication"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ArrayNode":{"type":"object","properties":{"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"],"x-genesys-enum-members":[{"name":"ARRAY"},{"name":"BINARY"},{"name":"BOOLEAN"},{"name":"MISSING"},{"name":"NULL"},{"name":"NUMBER"},{"name":"OBJECT"},{"name":"POJO"},{"name":"STRING"}]},"float":{"type":"boolean"},"number":{"type":"boolean"},"boolean":{"type":"boolean"},"object":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"integralNumber":{"type":"boolean"},"valueNode":{"type":"boolean"},"missingNode":{"type":"boolean"},"containerNode":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean"},"binary":{"type":"boolean"},"pojo":{"type":"boolean"},"array":{"type":"boolean"},"null":{"type":"boolean"}}},"JsonNodeSearchResponse":{"type":"object","required":["pageCount","pageNumber","pageSize","results","total","types"],"properties":{"total":{"type":"integer","format":"int64","description":"The total number of results found"},"pageCount":{"type":"integer","format":"int32","description":"The total number of pages"},"pageSize":{"type":"integer","format":"int32","description":"The current page size"},"pageNumber":{"type":"integer","format":"int32","description":"The current page number"},"previousPage":{"type":"string","description":"Q64 value for the previous page of results"},"currentPage":{"type":"string","description":"Q64 value for the current page of results"},"nextPage":{"type":"string","description":"Q64 value for the next page of results"},"types":{"type":"array","description":"Resource types the search was performed against","items":{"type":"string"}},"results":{"description":"Search results","$ref":"#/definitions/ArrayNode"},"aggregations":{"$ref":"#/definitions/ArrayNode"}}},"SuggestSearchCriteria":{"type":"object","properties":{"endValue":{"type":"string","description":"The end value of the range. This field is used for range search types."},"values":{"type":"array","description":"A list of values for the search to match against","items":{"type":"string"}},"startValue":{"type":"string","description":"The start value of the range. This field is used for range search types."},"fields":{"type":"array","description":"Field names to search against","items":{"type":"string"}},"value":{"type":"string","description":"A value for the search to match against"},"operator":{"type":"string","description":"How to apply this search criteria against other criteria","enum":["AND","OR","NOT"],"x-genesys-enum-members":[{"name":"AND"},{"name":"OR"},{"name":"NOT"}]},"group":{"type":"array","description":"Groups multiple conditions","items":{"$ref":"#/definitions/SuggestSearchCriteria"}},"dateFormat":{"type":"string","description":"Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."}}},"SuggestSearchRequest":{"type":"object","required":["query","types"],"properties":{"expand":{"type":"array","description":"Provides more details about a specified resource","items":{"type":"string"}},"types":{"type":"array","description":"Resource domain type to search","items":{"type":"string"}},"query":{"type":"array","description":"Suggest query","items":{"$ref":"#/definitions/SuggestSearchCriteria"}}}},"SearchAggregation":{"type":"object","properties":{"field":{"type":"string","description":"The field used for aggregation"},"name":{"type":"string","description":"The name of the aggregation. The response aggregation uses this name."},"type":{"type":"string","description":"The type of aggregation to perform","enum":["COUNT","SUM","AVERAGE","TERM","CONTAINS","STARTS_WITH","ENDS_WITH"],"x-genesys-enum-members":[{"name":"COUNT"},{"name":"SUM"},{"name":"AVERAGE"},{"name":"TERM"},{"name":"CONTAINS"},{"name":"STARTS_WITH"},{"name":"ENDS_WITH"}]},"value":{"type":"string","description":"A value to use for aggregation"},"size":{"type":"integer","format":"int32","description":"The number aggregations results to return out of the entire result set"},"order":{"type":"array","description":"The order in which aggregation results are sorted","items":{"type":"string","enum":["VALUE_DESC","VALUE_ASC","COUNT_DESC","COUNT_ASC"],"x-genesys-enum-members":[{"name":"VALUE_DESC"},{"name":"VALUE_ASC"},{"name":"COUNT_DESC"},{"name":"COUNT_ASC"}]}}}},"SearchCriteria":{"type":"object","properties":{"endValue":{"type":"string","description":"The end value of the range. This field is used for range search types."},"values":{"type":"array","description":"A list of values for the search to match against","items":{"type":"string"}},"startValue":{"type":"string","description":"The start value of the range. This field is used for range search types."},"fields":{"type":"array","description":"Field names to search against","items":{"type":"string"}},"value":{"type":"string","description":"A value for the search to match against"},"operator":{"type":"string","description":"How to apply this search criteria against other criteria","enum":["AND","OR","NOT"],"x-genesys-enum-members":[{"name":"AND"},{"name":"OR"},{"name":"NOT"}]},"group":{"type":"array","description":"Groups multiple conditions","items":{"$ref":"#/definitions/SearchCriteria"}},"dateFormat":{"type":"string","description":"Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."},"type":{"type":"string","enum":["EXACT","CONTAINS","STARTS_WITH","REQUIRED_FIELDS","RANGE","DATE_RANGE","LESS_THAN","LESS_THAN_EQUAL_TO","GREATER_THAN","GREATER_THAN_EQUAL_TO","SIMPLE","TERM","TERMS","QUERY_STRING","MATCH_ALL"],"x-genesys-enum-members":[{"name":"EXACT"},{"name":"CONTAINS"},{"name":"STARTS_WITH"},{"name":"REQUIRED_FIELDS"},{"name":"RANGE"},{"name":"DATE_RANGE"},{"name":"LESS_THAN"},{"name":"LESS_THAN_EQUAL_TO"},{"name":"GREATER_THAN"},{"name":"GREATER_THAN_EQUAL_TO"},{"name":"SIMPLE"},{"name":"TERM"},{"name":"TERMS"},{"name":"QUERY_STRING"},{"name":"MATCH_ALL"}]}}},"SearchRequest":{"type":"object","required":["types"],"properties":{"sortOrder":{"type":"string","description":"The sort order for results","enum":["ASC","DESC","SCORE"],"x-genesys-enum-members":[{"name":"ASC"},{"name":"DESC"},{"name":"SCORE"}]},"sortBy":{"type":"string","description":"The field in the resource that you want to sort the results by"},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"},"pageNumber":{"type":"integer","format":"int32","description":"The page of resources you want to retrieve"},"sort":{"type":"array","description":"Multi-value sort order, list of multiple sort values","items":{"$ref":"#/definitions/SearchSort"}},"returnFields":{"type":"array","description":"A List of strings. Possible values are any field in the resource you are searching on. The other option is to use ALL_FIELDS, when this is provided all fields in the resource will be returned in the search results.","items":{"type":"string"}},"expand":{"type":"array","description":"Provides more details about a specified resource","items":{"type":"string"}},"types":{"type":"array","description":"Resource domain type to search","items":{"type":"string"}},"query":{"type":"array","description":"The search criteria","items":{"$ref":"#/definitions/SearchCriteria"}},"aggregations":{"type":"array","description":"Aggregation criteria","items":{"$ref":"#/definitions/SearchAggregation"}}}},"SearchSort":{"type":"object","properties":{"sortOrder":{"type":"string","description":"The sort order for results","enum":["ASC","DESC","SCORE"],"x-genesys-enum-members":[{"name":"ASC"},{"name":"DESC"},{"name":"SCORE"}]},"sortBy":{"type":"string","description":"The field in the resource that you want to sort the results by"}}},"ButtonComponent":{"type":"object","properties":{"id":{"type":"string","description":"An ID assigned to this component"},"text":{"type":"string","description":"Deprecated - Use title instead"},"title":{"type":"string","description":"Text to show inside the button"},"actions":{"description":"User actions available on the content. All actions are optional and all actions are executed simultaneously.","$ref":"#/definitions/ContentActions"}},"description":"Structured template button object"},"ContentActions":{"type":"object","properties":{"url":{"type":"string","description":"A URL for a web page to redirect the user to"},"urlTarget":{"type":"string","description":"The target window or tab within the URL's web page. If empty will open a blank page or tab."},"textback":{"type":"string","description":"Text to be sent back in reply when a list item is selected"},"commandName":{"type":"string","description":"Execute an organization's specific command"},"context":{"type":"object","description":"Additional context for the command","additionalProperties":{"type":"object"}}},"description":"User actions available on the content. All actions are optional and all actions are executed simultaneously."},"ContentAttachment":{"type":"object","required":["mediaType"],"properties":{"id":{"type":"string","description":"Vendor specific ID for media. For example, a LINE sticker ID"},"mediaType":{"type":"string","description":"The type of media this instance represents","enum":["Image","Video","Audio","File"],"x-genesys-enum-members":[{"name":"Image"},{"name":"Video"},{"name":"Audio"},{"name":"File"}]},"url":{"type":"string","description":"Content element url"},"mime":{"type":"string","description":"Content mime type from https://www.iana.org/assignments/media-types/media-types.xhtml"},"text":{"type":"string","description":"Text message associated with media element: e.g. caption in case of image."},"sha256":{"type":"string","description":"Secure hash of the media content"},"filename":{"type":"string","description":"Suggested file name for media file"}},"description":"Attachment object"},"ContentGeneric":{"type":"object","properties":{"id":{"type":"string","description":"An ID assigned to this rich message content. Each instance inside the content array has a unique ID."},"title":{"type":"string","description":"Text to show in the title row"},"description":{"type":"string","description":"Text to show in the description row. This is immediately below the title"},"image":{"type":"string","description":"Path or URI to an image file"},"video":{"type":"string","description":"Path or URI to a video file"},"actions":{"description":"User actions available on the content. All actions are optional and all actions are executed simultaneously.","$ref":"#/definitions/ContentActions"},"components":{"type":"array","description":"An array of component objects","items":{"$ref":"#/definitions/ButtonComponent"}}},"description":"Generic content object"},"ContentList":{"type":"object","properties":{"id":{"type":"string","description":"An ID assigned to this rich message content. Each instance inside the content array has a unique ID."},"listType":{"type":"string","description":"The type of list this instance represents","enum":["Selection","Vertical"],"x-genesys-enum-members":[{"name":"Selection"},{"name":"Vertical"}]},"title":{"type":"string","description":"Text to show in the title row"},"description":{"type":"string","description":"Text to show in the description row. This is immediately below the title"},"submitLabel":{"type":"string","description":"Label for Submit button"},"actions":{"description":"User actions available on the content. All actions are optional and all actions are executed simultaneously.","$ref":"#/definitions/ContentActions"},"components":{"type":"array","description":"An array of component objects","items":{"$ref":"#/definitions/ListItemComponent"}}},"description":"List content object"},"ContentLocation":{"type":"object","properties":{"url":{"type":"string","description":"Location map url"},"address":{"type":"string","description":"Location postal address"},"text":{"type":"string","description":"Location name"},"latitude":{"type":"number","format":"double","description":"Latitude of the location"},"longitude":{"type":"number","format":"double","description":"Longitude of the location"}},"description":"Location object"},"ContentNotificationTemplate":{"type":"object","required":["body"],"properties":{"id":{"type":"string","description":"The messaging channel template id. For WhatsApp, 'namespace@name'"},"language":{"type":"string","description":"Template language"},"header":{"description":"Template header object","$ref":"#/definitions/NotificationTemplateHeader"},"body":{"description":"Template body object","$ref":"#/definitions/NotificationTemplateBody"},"footer":{"description":"Template footer object","$ref":"#/definitions/NotificationTemplateFooter"}},"description":"Template notification object"},"ContentPostback":{"type":"object","required":["payload"],"properties":{"id":{"type":"string","description":"An ID assigned to the postback reply. Each object inside the content array has a unique ID."},"text":{"type":"string","description":"The text inside the button clicked (in the structured message template)"},"payload":{"type":"string","description":"Content of the textback payload after clicking a quick reply"}},"description":"The postback object result of a user clicking in a button"},"ContentQuickReply":{"type":"object","required":["text"],"properties":{"id":{"type":"string","description":"An ID assigned to the quick reply. Each object inside the content array has a unique ID."},"text":{"type":"string","description":"Text to show inside the quick reply. This is also used as the response text after clicking on the quick reply."},"payload":{"type":"string","description":"Content of the textback payload after clicking a quick reply"},"image":{"type":"string","description":"Image associated with quick reply"},"action":{"type":"string","description":"Specifies the type of action that is triggered upon clicking the quick reply. Currently, the only supported action is \"Message\" which sends a message using the quick reply text.","enum":["Message"],"x-genesys-enum-members":[{"name":"Message"}]}},"description":"Quick reply object"},"ContentReaction":{"type":"object","properties":{"reactionType":{"type":"string","description":"Type of reaction","enum":["None","Like","Love","Wow","Haha","Sad","Angry","Thankful","Pride","Care"],"x-genesys-enum-members":[{"name":"None"},{"name":"Like"},{"name":"Love"},{"name":"Wow"},{"name":"Haha"},{"name":"Sad"},{"name":"Angry"},{"name":"Thankful"},{"name":"Pride"},{"name":"Care"}]},"count":{"type":"integer","format":"int32","description":"Number of users that reacted this way to this public message"}},"description":"User reaction to public message"},"ListItemComponent":{"type":"object","properties":{"id":{"type":"string","description":"An ID assigned to this component"},"rmid":{"type":"string","description":"An ID of the rich message instance"},"type":{"type":"string","description":"The type of component to render","enum":["ListItem","ListItemBig"],"x-genesys-enum-members":[{"name":"ListItem"},{"name":"ListItemBig"}]},"image":{"type":"string","description":"Path or URI to an image file"},"title":{"type":"string","description":"The main headline of the list item"},"description":{"type":"string","description":"Text to show in the description row"},"actions":{"description":"User actions available on the content. All actions are optional and all actions are executed simultaneously.","$ref":"#/definitions/ContentActions"}},"description":"An entry in List template"},"MessageContent":{"type":"object","required":["contentType"],"properties":{"contentType":{"type":"string","description":"Type of this content element. If contentType = \"Attachment\" only one item is allowed.","enum":["Attachment","Location","QuickReply","Notification","GenericTemplate","ListTemplate","Postback","Reactions","Mention"],"x-genesys-enum-members":[{"name":"Attachment"},{"name":"Location"},{"name":"QuickReply"},{"name":"Notification"},{"name":"GenericTemplate"},{"name":"ListTemplate"},{"name":"Postback"},{"name":"Reactions"},{"name":"Mention"}]},"location":{"description":"Location object","$ref":"#/definitions/ContentLocation"},"attachment":{"description":"Attachment object","$ref":"#/definitions/ContentAttachment"},"quickReply":{"description":"Quick reply object","$ref":"#/definitions/ContentQuickReply"},"generic":{"description":"Generic content object","$ref":"#/definitions/ContentGeneric"},"list":{"description":"List content object","$ref":"#/definitions/ContentList"},"template":{"description":"Template notification object","$ref":"#/definitions/ContentNotificationTemplate"},"reactions":{"type":"array","description":"A list of reactions","items":{"$ref":"#/definitions/ContentReaction"}},"mention":{"description":"This is used to identify who the message is sent to, as well as who it was sent from. This information is channel specific - depends on capabilities to describe party by the platform","$ref":"#/definitions/MessagingRecipient"},"postback":{"description":"The postback object result of a user clicking in a button","$ref":"#/definitions/ContentPostback"}},"description":"Message content element"},"MessagingRecipient":{"type":"object","required":["id"],"properties":{"nickname":{"type":"string","description":"Nickname/user name","readOnly":true},"id":{"type":"string","description":"The recipient identifier specific for particular channel/integration. This is required when sending a message."},"image":{"type":"string","description":"Avatar image","readOnly":true},"firstName":{"type":"string","description":"Sender's first name","readOnly":true},"lastName":{"type":"string","description":"Sender's last name","readOnly":true},"email":{"type":"string","description":"Sender's email address","readOnly":true}},"description":"This is used to identify who the message is sent to, as well as who it was sent from. This information is channel specific - depends on capabilities to describe party by the platform"},"NotificationTemplateBody":{"type":"object","required":["parameters"],"properties":{"text":{"type":"string","description":"Body text. For WhatsApp, ignored"},"parameters":{"type":"array","description":"Template parameters for placeholders in template","items":{"$ref":"#/definitions/NotificationTemplateParameter"}}},"description":"Template body object"},"NotificationTemplateFooter":{"type":"object","properties":{"text":{"type":"string","description":"Footer text. For WhatsApp, ignored"}},"description":"Template footer object"},"NotificationTemplateHeader":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Template header type","enum":["Text","Media"],"x-genesys-enum-members":[{"name":"Text"},{"name":"Media"}]},"text":{"type":"string","description":"Header text. For WhatsApp, ignored"},"media":{"description":"Attachment object","$ref":"#/definitions/ContentAttachment"},"parameters":{"type":"array","description":"Template parameters for placeholders in template","items":{"$ref":"#/definitions/NotificationTemplateParameter"}}},"description":"Template header object"},"NotificationTemplateParameter":{"type":"object","required":["text"],"properties":{"name":{"type":"string","description":"Parameter name"},"text":{"type":"string","description":"Parameter text value"}},"description":"Parameters for placeholders in template"},"ConversationDeletionProtectionQuery":{"type":"object","required":["conversationIds"],"properties":{"conversationIds":{"type":"array","description":"This is a list of ConversationIds. The list cannot exceed 100 conversationids.","items":{"type":"string"}}}},"DialerContactId":{"type":"object","properties":{"id":{"type":"string"},"contactListId":{"type":"string"}}},"GDPRJourneyCustomer":{"type":"object","properties":{"type":{"type":"string","description":"The type of the customerId within the Journey System (e.g. cookie). Required if `id` is defined."},"id":{"type":"string","description":"An ID of a customer within the Journey System at a point-in-time. Required if `type` is defined."}}},"GDPRSubject":{"type":"object","properties":{"name":{"type":"string"},"userId":{"type":"string"},"externalContactId":{"type":"string"},"dialerContactId":{"$ref":"#/definitions/DialerContactId"},"journeyCustomer":{"$ref":"#/definitions/GDPRJourneyCustomer"},"socialHandle":{"$ref":"#/definitions/SocialHandle"},"addresses":{"type":"array","items":{"type":"string"}},"phoneNumbers":{"type":"array","items":{"type":"string"}},"emailAddresses":{"type":"array","items":{"type":"string"}}}},"GDPRSubjectEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/GDPRSubject"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"SocialHandle":{"type":"object","properties":{"type":{"type":"string","enum":["TWITTER"],"x-genesys-enum-members":[{"name":"TWITTER"}]},"value":{"type":"string"}}},"KnowledgeBase":{"type":"object","required":["coreLanguage"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string","description":"Knowledge base description"},"coreLanguage":{"type":"string","example":"en-us","description":"Core language for knowledge base in which initial content must be created first","enum":["en-US","de-DE"],"x-genesys-enum-members":[{"name":"en-US"},{"name":"de-DE"}]},"dateCreated":{"type":"string","format":"date-time","description":"Knowledge base creation date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Knowledge base last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"faqCount":{"type":"integer","format":"int32","description":"The count representing the number of documents of type FAQ per KnowledgeBase","readOnly":true},"dateDocumentLastModified":{"type":"string","format":"date-time","description":"The date representing when the last document is modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeBaseListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/KnowledgeBase"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"ScriptEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Script"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"OrgUser":{"type":"object","required":["version"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"chat":{"$ref":"#/definitions/Chat"},"department":{"type":"string"},"email":{"type":"string"},"primaryContactInfo":{"type":"array","description":"Auto populated from addresses.","readOnly":true,"items":{"$ref":"#/definitions/Contact"}},"addresses":{"type":"array","description":"Email addresses and phone numbers for this user","items":{"$ref":"#/definitions/Contact"}},"state":{"type":"string","description":"The current state for this user.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"title":{"type":"string"},"username":{"type":"string"},"manager":{"$ref":"#/definitions/User"},"images":{"type":"array","items":{"$ref":"#/definitions/UserImage"}},"version":{"type":"integer","format":"int32","description":"Required when updating a user, this value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH."},"certifications":{"type":"array","items":{"type":"string"}},"biography":{"$ref":"#/definitions/Biography"},"employerInfo":{"$ref":"#/definitions/EmployerInfo"},"routingStatus":{"description":"ACD routing status","readOnly":true,"$ref":"#/definitions/RoutingStatus"},"presence":{"description":"Active presence","readOnly":true,"$ref":"#/definitions/UserPresence"},"conversationSummary":{"description":"Summary of conversion statistics for conversation types.","readOnly":true,"$ref":"#/definitions/UserConversationSummary"},"outOfOffice":{"description":"Determine if out of office is enabled","readOnly":true,"$ref":"#/definitions/OutOfOffice"},"geolocation":{"description":"Current geolocation position","readOnly":true,"$ref":"#/definitions/Geolocation"},"station":{"description":"Effective, default, and last station information","readOnly":true,"$ref":"#/definitions/UserStations"},"authorization":{"description":"Roles and permissions assigned to the user","readOnly":true,"$ref":"#/definitions/UserAuthorization"},"profileSkills":{"type":"array","description":"Profile skills possessed by the user","readOnly":true,"items":{"type":"string"}},"locations":{"type":"array","description":"The user placement at each site location.","readOnly":true,"items":{"$ref":"#/definitions/Location"}},"groups":{"type":"array","description":"The groups the user is a member of","readOnly":true,"items":{"$ref":"#/definitions/Group"}},"team":{"description":"The team the user is a member of","readOnly":true,"$ref":"#/definitions/Team"},"skills":{"type":"array","description":"Routing (ACD) skills possessed by the user","readOnly":true,"items":{"$ref":"#/definitions/UserRoutingSkill"}},"languages":{"type":"array","description":"Routing (ACD) languages possessed by the user","readOnly":true,"items":{"$ref":"#/definitions/UserRoutingLanguage"}},"acdAutoAnswer":{"type":"boolean","description":"acd auto answer"},"languagePreference":{"type":"string","description":"preferred language by the user","readOnly":true},"lastTokenIssued":{"$ref":"#/definitions/OAuthLastTokenIssued"},"organization":{"$ref":"#/definitions/Organization"}}},"Organization":{"type":"object","required":["version"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"defaultLanguage":{"type":"string","description":"The default language for this organization. Example: 'en'"},"defaultCountryCode":{"type":"string","description":"The default country code for this organization. Example: 'US'"},"thirdPartyOrgName":{"type":"string","description":"The short name for the organization. This field is globally unique and cannot be changed.","readOnly":true},"thirdPartyURI":{"type":"string","format":"uri"},"domain":{"type":"string"},"version":{"type":"integer","format":"int32","description":"The current version of the organization."},"state":{"type":"string","description":"The current state. Examples are active, inactive, deleted.","enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"defaultSiteId":{"type":"string"},"supportURI":{"type":"string","description":"Email address where support tickets are sent to."},"voicemailEnabled":{"type":"boolean"},"productPlatform":{"type":"string","description":"Organizations Originating Platform.","readOnly":true,"enum":["GenesysCloud","PureCloud","PureEngage","PureEngageCloud","PureConnect","PureConnectCloud","Unknown"],"x-genesys-enum-members":[{"name":"GenesysCloud"},{"name":"PureCloud"},{"name":"PureEngage"},{"name":"PureEngageCloud"},{"name":"PureConnect"},{"name":"PureConnectCloud"},{"name":"Unknown"}]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"features":{"type":"object","description":"The state of features available for the organization.","readOnly":true,"additionalProperties":{"type":"boolean"}}}},"TrustGroup":{"type":"object","required":["name","rulesVisible","type","visibility"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The group name."},"description":{"type":"string"},"dateModified":{"type":"string","format":"date-time","description":"Last modified date/time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"memberCount":{"type":"integer","format":"int64","description":"Number of members.","readOnly":true},"state":{"type":"string","description":"Active, inactive, or deleted state.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"version":{"type":"integer","format":"int32","description":"Current version for this resource.","readOnly":true},"type":{"type":"string","description":"Type of group.","enum":["official","social"],"x-genesys-enum-members":[{"name":"official"},{"name":"social"}]},"images":{"type":"array","items":{"$ref":"#/definitions/UserImage"}},"addresses":{"type":"array","items":{"$ref":"#/definitions/GroupContact"}},"rulesVisible":{"type":"boolean","description":"Are membership rules visible to the person requesting to view the group"},"visibility":{"type":"string","description":"Who can view this group","enum":["public","owners","members"]},"owners":{"type":"array","description":"Owners of the group","items":{"$ref":"#/definitions/User"}},"dateCreated":{"type":"string","format":"date-time","description":"The date on which the trusted group was added. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"createdBy":{"description":"The user that added trusted group.","readOnly":true,"$ref":"#/definitions/OrgUser"}}},"Reaction":{"type":"object","required":["reactionType"],"properties":{"data":{"type":"string","description":"Parameter for this reaction. For transfer_flow, this would be the outbound flow id."},"name":{"type":"string","description":"Name of the parameter for this reaction. For transfer_flow, this would be the outbound flow name."},"reactionType":{"type":"string","description":"The reaction to take for a given call analysis result.","enum":["hangup","transfer","transfer_flow","play_file"],"x-genesys-enum-members":[{"name":"hangup"},{"name":"transfer"},{"name":"transfer_flow"},{"name":"play_file"}]}}},"ResponseSet":{"type":"object","required":["name","responses"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the ResponseSet."},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"responses":{"type":"object","description":"Map of disposition identifiers to reactions. For example: {\"disposition.classification.callable.person\": {\"reactionType\": \"transfer\"}}.","additionalProperties":{"$ref":"#/definitions/Reaction"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"RoleDivisionGrants":{"type":"object","required":["grants"],"properties":{"grants":{"type":"array","description":"A list containing pairs of role and division IDs","items":{"$ref":"#/definitions/RoleDivisionPair"}}}},"RoleDivisionPair":{"type":"object","required":["divisionId","roleId"],"properties":{"roleId":{"type":"string","description":"The ID of the role"},"divisionId":{"type":"string","description":"The ID of the division"}}},"TrustMemberCreate":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Trustee User or Group Id"},"roleIds":{"type":"array","description":"The list of roles to be granted to this user or group. Roles will be granted in all divisions.","items":{"type":"string"}},"roleDivisions":{"description":"The list of trustor organization roles granting this user or group access paired with the divisions for those roles.","$ref":"#/definitions/RoleDivisionGrants"}}},"ConversationProperties":{"type":"object","properties":{"isWaiting":{"type":"boolean","description":"Indicates filtering for waiting"},"isActive":{"type":"boolean","description":"Indicates filtering for active"},"isAcd":{"type":"boolean","description":"Indicates filtering for Acd"},"isPreferred":{"type":"boolean","description":"Indicates filtering for Preferred Agent Routing"},"isScreenshare":{"type":"boolean","description":"Indicates filtering for screenshare"},"isCobrowse":{"type":"boolean","description":"Indicates filtering for Cobrowse"},"isVoicemail":{"type":"boolean","description":"Indicates filtering for Voice mail"},"isFlagged":{"type":"boolean","description":"Indicates filtering for flagged"},"isMonitored":{"type":"boolean","description":"Indicates filtering for monitored"},"filterWrapUpNotes":{"type":"boolean","description":"Indicates filtering for WrapUpNotes"},"matchAll":{"type":"boolean","description":"Indicates comparison operation, TRUE indicates filters will use AND logic, FALSE indicates OR logic"}}},"NumericRange":{"type":"object","properties":{"gt":{"type":"number","description":"Greater than"},"gte":{"type":"number","description":"Greater than or equal to"},"lt":{"type":"number","description":"Less than"},"lte":{"type":"number","description":"Less than or equal to"}}},"Transcripts":{"type":"object","properties":{"exactMatch":{"type":"array","description":"List of transcript contents which needs to satisfy exact match criteria","items":{"type":"string"}},"contains":{"type":"array","description":"List of transcript contents which needs to satisfy contains criteria","items":{"type":"string"}},"doesNotContain":{"type":"array","description":"List of transcript contents which needs to satisfy does not contain criteria","items":{"type":"string"}}}},"ViewFilter":{"type":"object","properties":{"mediaTypes":{"type":"array","description":"The media types are used to filter the view","items":{"type":"string","enum":["voice","chat","email","callback","cobrowse","video","screenshare","message"],"x-genesys-enum-members":[{"name":"voice"},{"name":"chat"},{"name":"email"},{"name":"callback"},{"name":"cobrowse"},{"name":"video"},{"name":"screenshare"},{"name":"message"}]}},"queueIds":{"type":"array","description":"The queue ids are used to filter the view","items":{"type":"string"}},"skillIds":{"type":"array","description":"The skill ids are used to filter the view","items":{"type":"string"}},"skillGroups":{"type":"array","description":"The skill groups used to filter the view","items":{"type":"string"}},"languageIds":{"type":"array","description":"The language ids are used to filter the view","items":{"type":"string"}},"languageGroups":{"type":"array","description":"The language groups used to filter the view","items":{"type":"string"}},"directions":{"type":"array","description":"The directions are used to filter the view","items":{"type":"string","enum":["inbound","outbound"],"x-genesys-enum-members":[{"name":"inbound"},{"name":"outbound"}]}},"originatingDirections":{"type":"array","description":"The list of orginating directions used to filter the view","items":{"type":"string","enum":["inbound","outbound"],"x-genesys-enum-members":[{"name":"inbound"},{"name":"outbound"}]}},"wrapUpCodes":{"type":"array","description":"The wrap up codes are used to filter the view","items":{"type":"string"}},"dnisList":{"type":"array","description":"The dnis list is used to filter the view","items":{"type":"string"}},"sessionDnisList":{"type":"array","description":"The list of session dnis used to filter the view","items":{"type":"string"}},"filterQueuesByUserIds":{"type":"array","description":"The user ids are used to fetch associated queues for the view","items":{"type":"string"}},"filterUsersByQueueIds":{"type":"array","description":"The queue ids are used to fetch associated users for the view","items":{"type":"string"}},"userIds":{"type":"array","description":"The user ids are used to filter the view","items":{"type":"string"}},"addressTos":{"type":"array","description":"The address To values are used to filter the view","items":{"type":"string"}},"addressFroms":{"type":"array","description":"The address from values are used to filter the view","items":{"type":"string"}},"outboundCampaignIds":{"type":"array","description":"The outbound campaign ids are used to filter the view","items":{"type":"string"}},"outboundContactListIds":{"type":"array","description":"The outbound contact list ids are used to filter the view","items":{"type":"string"}},"contactIds":{"type":"array","description":"The contact ids are used to filter the view","items":{"type":"string"}},"externalContactIds":{"type":"array","description":"The external contact ids are used to filter the view","items":{"type":"string"}},"externalOrgIds":{"type":"array","description":"The external org ids are used to filter the view","items":{"type":"string"}},"aniList":{"type":"array","description":"The ani list ids are used to filter the view","items":{"type":"string"}},"durationsMilliseconds":{"type":"array","description":"The durations in milliseconds used to filter the view","items":{"$ref":"#/definitions/NumericRange"}},"acdDurationsMilliseconds":{"type":"array","description":"The acd durations in milliseconds used to filter the view","items":{"$ref":"#/definitions/NumericRange"}},"talkDurationsMilliseconds":{"type":"array","description":"The talk durations in milliseconds used to filter the view","items":{"$ref":"#/definitions/NumericRange"}},"acwDurationsMilliseconds":{"type":"array","description":"The acw durations in milliseconds used to filter the view","items":{"$ref":"#/definitions/NumericRange"}},"handleDurationsMilliseconds":{"type":"array","description":"The handle durations in milliseconds used to filter the view","items":{"$ref":"#/definitions/NumericRange"}},"holdDurationsMilliseconds":{"type":"array","description":"The hold durations in milliseconds used to filter the view","items":{"$ref":"#/definitions/NumericRange"}},"abandonDurationsMilliseconds":{"type":"array","description":"The abandon durations in milliseconds used to filter the view","items":{"$ref":"#/definitions/NumericRange"}},"evaluationScore":{"description":"The evaluationScore is used to filter the view","$ref":"#/definitions/NumericRange"},"evaluationCriticalScore":{"description":"The evaluationCriticalScore is used to filter the view","$ref":"#/definitions/NumericRange"},"evaluationFormIds":{"type":"array","description":"The evaluation form ids are used to filter the view","items":{"type":"string"}},"evaluatedAgentIds":{"type":"array","description":"The evaluated agent ids are used to filter the view","items":{"type":"string"}},"evaluatorIds":{"type":"array","description":"The evaluator ids are used to filter the view","items":{"type":"string"}},"transferred":{"type":"boolean","description":"Indicates filtering for transfers"},"abandoned":{"type":"boolean","description":"Indicates filtering for abandons"},"answered":{"type":"boolean","description":"Indicates filtering for answered interactions"},"messageTypes":{"type":"array","description":"The message media types used to filter the view","items":{"type":"string","enum":["sms","twitter","line","facebook","whatsapp","webmessaging","general"],"x-genesys-enum-members":[{"name":"sms"},{"name":"twitter"},{"name":"line"},{"name":"facebook"},{"name":"whatsapp"},{"name":"webmessaging"},{"name":"general"}]}},"divisionIds":{"type":"array","description":"The divison Ids used to filter the view","items":{"type":"string"}},"surveyFormIds":{"type":"array","description":"The survey form ids used to filter the view","items":{"type":"string"}},"surveyTotalScore":{"description":"The survey total score used to filter the view","$ref":"#/definitions/NumericRange"},"surveyNpsScore":{"description":"The survey NPS score used to filter the view","$ref":"#/definitions/NumericRange"},"mos":{"description":"The desired range for mos values","$ref":"#/definitions/NumericRange"},"surveyQuestionGroupScore":{"description":"The survey question group score used to filter the view","$ref":"#/definitions/NumericRange"},"surveyPromoterScore":{"description":"The survey promoter score used to filter the view","$ref":"#/definitions/NumericRange"},"surveyFormContextIds":{"type":"array","description":"The list of survey form context ids used to filter the view","items":{"type":"string"}},"conversationIds":{"type":"array","description":"The list of conversation ids used to filter the view","items":{"type":"string"}},"sipCallIds":{"type":"array","description":"The list of SIP call ids used to filter the view","items":{"type":"string"}},"isEnded":{"type":"boolean","description":"Indicates filtering for ended"},"isSurveyed":{"type":"boolean","description":"Indicates filtering for survey"},"surveyScores":{"type":"array","description":"The list of survey score ranges used to filter the view","items":{"$ref":"#/definitions/NumericRange"}},"promoterScores":{"type":"array","description":"The list of promoter score ranges used to filter the view","items":{"$ref":"#/definitions/NumericRange"}},"isCampaign":{"type":"boolean","description":"Indicates filtering for campaign"},"surveyStatuses":{"type":"array","description":"The list of survey statuses used to filter the view","items":{"type":"string"}},"conversationProperties":{"description":"A grouping of conversation level filters","$ref":"#/definitions/ConversationProperties"},"isBlindTransferred":{"type":"boolean","description":"Indicates filtering for blind transferred"},"isConsulted":{"type":"boolean","description":"Indicates filtering for consulted"},"isConsultTransferred":{"type":"boolean","description":"Indicates filtering for consult transferred"},"remoteParticipants":{"type":"array","description":"The list of remote participants used to filter the view","items":{"type":"string"}},"flowIds":{"type":"array","description":"The list of flow Ids","items":{"type":"string"}},"flowOutcomeIds":{"type":"array","description":"A list of outcome ids of the flow","items":{"type":"string"}},"flowOutcomeValues":{"type":"array","description":"A list of outcome values of the flow","items":{"type":"string","enum":["SUCCESS","FAILURE"],"x-genesys-enum-members":[{"name":"SUCCESS"},{"name":"FAILURE"}]}},"flowDestinationTypes":{"type":"array","description":"The list of destination types of the flow","items":{"type":"string","enum":["ACD","USER","GROUP","NUMBER","FLOW","SECURE_FLOW","ACD_VOICEMAIL","USER_VOICEMAIL","GROUP_VOICEMAIL","RETURN_TO_AGENT"],"x-genesys-enum-members":[{"name":"ACD"},{"name":"USER"},{"name":"GROUP"},{"name":"NUMBER"},{"name":"FLOW"},{"name":"SECURE_FLOW"},{"name":"ACD_VOICEMAIL"},{"name":"USER_VOICEMAIL"},{"name":"GROUP_VOICEMAIL"},{"name":"RETURN_TO_AGENT"}]}},"flowDisconnectReasons":{"type":"array","description":"The list of reasons for the flow to disconnect","items":{"type":"string","enum":["FLOW_DISCONNECT","FLOW_ERROR_DISCONNECT","DISCONNECT"],"x-genesys-enum-members":[{"name":"FLOW_DISCONNECT"},{"name":"FLOW_ERROR_DISCONNECT"},{"name":"DISCONNECT"}]}},"flowTypes":{"type":"array","description":"A list of types of the flow","items":{"type":"string","enum":["bot","commonmodule","inboundcall","inboundchat","inboundemail","inboundshortmessage","inqueuecall","outboundcall","securecall","surveyinvite","workflow"],"x-genesys-enum-members":[{"name":"bot"},{"name":"commonmodule"},{"name":"inboundcall"},{"name":"inboundchat"},{"name":"inboundemail"},{"name":"inboundshortmessage"},{"name":"inqueuecall"},{"name":"outboundcall"},{"name":"securecall"},{"name":"surveyinvite"},{"name":"workflow"}]}},"flowEntryTypes":{"type":"array","description":"A list of types of the flow entry","items":{"type":"string","enum":["dnis","direct","flow","agent","outbound"],"x-genesys-enum-members":[{"name":"dnis"},{"name":"direct"},{"name":"flow"},{"name":"agent"},{"name":"outbound"}]}},"flowEntryReasons":{"type":"array","description":"A list of reasons of flow entry","items":{"type":"string"}},"flowVersions":{"type":"array","description":"A list of versions of a flow","items":{"type":"string"}},"groupIds":{"type":"array","description":"A list of directory group ids","items":{"type":"string"}},"hasJourneyCustomerId":{"type":"boolean","description":"Indicates filtering for journey customer id"},"hasJourneyActionMapId":{"type":"boolean","description":"Indicates filtering for Journey action map id"},"hasJourneyVisitId":{"type":"boolean","description":"Indicates filtering for Journey visit id"},"hasMedia":{"type":"boolean","description":"Indicates filtering for presence of MMS media"},"roleIds":{"type":"array","description":"The role Ids used to filter the view","items":{"type":"string"}},"reportsTos":{"type":"array","description":"The report to user IDs used to filter the view","items":{"type":"string"}},"locationIds":{"type":"array","description":"The location Ids used to filter the view","items":{"type":"string"}},"flowOutTypes":{"type":"array","description":"A list of flow out types","items":{"type":"string"}},"providerList":{"type":"array","description":"A list of providers","items":{"type":"string"}},"callbackNumberList":{"type":"array","description":"A list of callback numbers or substrings of numbers (ex: [\"317\", \"13172222222\"])","items":{"type":"string"}},"callbackInterval":{"type":"string","description":"An interval of time to filter for scheduled callbacks. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"usedRoutingTypes":{"type":"array","description":"A list of routing types used","items":{"type":"string","enum":["Predictive","Preferred","Manual","Last","Bullseye","Standard"],"x-genesys-enum-members":[{"name":"Predictive"},{"name":"Preferred"},{"name":"Manual"},{"name":"Last"},{"name":"Bullseye"},{"name":"Standard"}]}},"requestedRoutingTypes":{"type":"array","description":"A list of routing types requested","items":{"type":"string","enum":["Predictive","Preferred","Manual","Last","Bullseye","Standard"],"x-genesys-enum-members":[{"name":"Predictive"},{"name":"Preferred"},{"name":"Manual"},{"name":"Last"},{"name":"Bullseye"},{"name":"Standard"}]}},"hasAgentAssistId":{"type":"boolean","description":"Indicates filtering for agent assist id"},"transcripts":{"type":"array","description":"A list of transcript contents requested","items":{"$ref":"#/definitions/Transcripts"}},"transcriptLanguages":{"type":"array","description":"A list of transcript languages requested","items":{"type":"string"}},"participantPurposes":{"type":"array","description":"A list of participant purpose requested","items":{"type":"string","enum":["internal","external"],"x-genesys-enum-members":[{"name":"internal"},{"name":"external"}]}},"showFirstQueue":{"type":"boolean","description":"Indicates filtering for first queue data"},"teamIds":{"type":"array","description":"The team ids used to filter the view data","items":{"type":"string"}},"filterUsersByTeamIds":{"type":"array","description":"The team ids are used to fetch associated users for the view","items":{"type":"string"}},"journeyActionMapIds":{"type":"array","description":"The journey action map ids are used to fetch action maps for the associated view","items":{"type":"string"}},"journeyOutcomeIds":{"type":"array","description":"The journey outcome ids are used to fetch outcomes for the associated view","items":{"type":"string"}},"journeySegmentIds":{"type":"array","description":"The journey segment ids are used to fetch segments for the associated view","items":{"type":"string"}},"journeyActionMapTypes":{"type":"array","description":"The journey action map types are used to filter action map data for the associated view","items":{"type":"string","enum":["webchat","webMessagingOffer","contentOffer","integrationAction","architectFlow"],"x-genesys-enum-members":[{"name":"webchat"},{"name":"webMessagingOffer"},{"name":"contentOffer"},{"name":"integrationAction"},{"name":"architectFlow"}]}},"developmentRoleList":{"type":"array","description":"The list of development roles used to filter agent development view","items":{"type":"string","enum":["Creator","Facilitator","Attendee"],"x-genesys-enum-members":[{"name":"Creator"},{"name":"Facilitator"},{"name":"Attendee"}]}},"developmentTypeList":{"type":"array","description":"The list of development types used to filter agent development view","items":{"type":"string","enum":["Informational","Coaching"],"x-genesys-enum-members":[{"name":"Informational"},{"name":"Coaching"}]}},"developmentStatusList":{"type":"array","description":"The list of development status used to filter agent development view","items":{"type":"string","enum":["Planned","Scheduled","InvalidSchedule","InProgress","Completed"],"x-genesys-enum-members":[{"name":"Planned"},{"name":"Scheduled"},{"name":"InvalidSchedule"},{"name":"InProgress"},{"name":"Completed"}]}},"developmentModuleIds":{"type":"array","description":"The list of development moduleIds used to filter agent development view","items":{"type":"string"}},"developmentKeyType":{"type":"string","description":"Represents due or completed to filter agent development view","enum":["Due","Completed"],"x-genesys-enum-members":[{"name":"Due"},{"name":"Completed"}]},"developmentActivityOverdue":{"type":"boolean","description":"Indicates filtering for development activities"}}},"PINConfiguration":{"type":"object","properties":{"minimumLength":{"type":"integer","format":"int32"},"maximumLength":{"type":"integer","format":"int32"}}},"VoicemailOrganizationPolicy":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether voicemail is enable for this organization","readOnly":true},"alertTimeoutSeconds":{"type":"integer","format":"int32","description":"The organization's default number of seconds to ring a user's phone before a call is transfered to voicemail"},"pinConfiguration":{"description":"The configuration for user PINs to access their voicemail from a phone","$ref":"#/definitions/PINConfiguration"},"voicemailExtension":{"type":"string","description":"The extension for voicemail retrieval. The default value is *86."},"pinRequired":{"type":"boolean","description":"If this is true, a PIN is required when accessing a user's voicemail from a phone."},"sendEmailNotifications":{"type":"boolean","description":"Whether email notifications are sent for new voicemails in the organization. If false, new voicemail email notifications are not be sent for the organization overriding any user or group setting."},"modifiedDate":{"type":"string","format":"date-time","description":"The date the policy was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true}}},"Adjacents":{"type":"object","properties":{"superiors":{"type":"array","items":{"$ref":"#/definitions/User"}},"siblings":{"type":"array","items":{"$ref":"#/definitions/User"}},"directReports":{"type":"array","items":{"$ref":"#/definitions/User"}}}},"DomainOrganizationProduct":{"type":"object","properties":{"id":{"type":"string"}}},"DomainOrganizationRole":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"defaultRoleId":{"type":"string"},"permissions":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"unusedPermissions":{"type":"array","description":"A collection of the permissions the role is not using","readOnly":true,"uniqueItems":true,"items":{"type":"string"}},"permissionPolicies":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/DomainPermissionPolicy"}},"userCount":{"type":"integer","format":"int32"},"roleNeedsUpdate":{"type":"boolean","description":"Optional unless patch operation."},"default":{"type":"boolean"},"base":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DomainPermissionPolicy":{"type":"object","properties":{"domain":{"type":"string"},"entityName":{"type":"string"},"policyName":{"type":"string"},"policyDescription":{"type":"string"},"actionSet":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"namedResources":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"allowConditions":{"type":"boolean"},"resourceConditionNode":{"$ref":"#/definitions/DomainResourceConditionNode"}}},"DomainResourceConditionNode":{"type":"object","properties":{"variableName":{"type":"string"},"operator":{"type":"string","enum":["EQ","IN","GE","GT","LE","LT"],"x-genesys-enum-members":[{"name":"EQ"},{"name":"IN"},{"name":"GE"},{"name":"GT"},{"name":"LE"},{"name":"LT"}]},"operands":{"type":"array","items":{"$ref":"#/definitions/DomainResourceConditionValue"}},"conjunction":{"type":"string","enum":["AND","OR"],"x-genesys-enum-members":[{"name":"AND"},{"name":"OR"}]},"terms":{"type":"array","items":{"$ref":"#/definitions/DomainResourceConditionNode"}}}},"DomainResourceConditionValue":{"type":"object","properties":{"user":{"$ref":"#/definitions/User"},"queue":{"$ref":"#/definitions/Queue"},"value":{"type":"string"},"type":{"type":"string","enum":["SCALAR","VARIABLE","USER","QUEUE"],"x-genesys-enum-members":[{"name":"SCALAR"},{"name":"VARIABLE"},{"name":"USER"},{"name":"QUEUE"}]}}},"Entity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true}}},"FieldConfig":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"entityType":{"type":"string","enum":["person","group","org","externalContact"],"x-genesys-enum-members":[{"name":"person"},{"name":"group"},{"name":"org"},{"name":"externalContact"}]},"state":{"type":"string"},"sections":{"type":"array","items":{"$ref":"#/definitions/Section"}},"version":{"type":"string"},"schemaVersion":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FieldConfigs":{"type":"object","properties":{"org":{"$ref":"#/definitions/FieldConfig"},"person":{"$ref":"#/definitions/FieldConfig"},"group":{"$ref":"#/definitions/FieldConfig"},"externalContact":{"$ref":"#/definitions/FieldConfig"}}},"FieldList":{"type":"object","properties":{"customLabels":{"type":"boolean"},"instructionText":{"type":"string"},"key":{"type":"string"},"labelKeys":{"type":"array","items":{"type":"string"}},"params":{"type":"object","additionalProperties":{"type":"object"}},"repeatable":{"type":"boolean"},"state":{"type":"string"},"type":{"type":"string"},"required":{"type":"boolean"}}},"GeolocationSettings":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"enabled":{"type":"boolean"},"mapboxKey":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LogCaptureUserConfiguration":{"type":"object","required":["dateExpired"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"dateExpired":{"type":"string","format":"date-time","description":"Indicates when log capture will be turned off for the user. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"NamedEntity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the object.","readOnly":true}}},"OrgOAuthClient":{"type":"object","required":["authorizedGrantType","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the OAuth client."},"dateCreated":{"type":"string","format":"date-time","description":"Date this client was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date this client was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"description":"User that created this client","$ref":"#/definitions/DomainEntityRef"},"modifiedBy":{"description":"User that last modified this client","$ref":"#/definitions/DomainEntityRef"},"authorizedGrantType":{"type":"string","description":"The OAuth Grant/Client type supported by this client.\nCode Authorization Grant/Client type - Preferred client type where the Client ID and Secret are required to create tokens. Used where the secret can be secured.\nPKCE-Enabled Code Authorization grant type - Code grant type which requires PKCE challenge and verifier to create tokens. Used in public clients for increased security.\nImplicit grant type - Client ID only is required to create tokens. Used in browser and mobile apps where the secret can not be secured.\nSAML2-Bearer extension grant type - SAML2 assertion provider for user authentication at the token endpoint.\nClient Credential grant type - Used to created access tokens that are tied only to the client.\n","enum":["CODE","CODE_PKCE","TOKEN","SAML2BEARER","PASSWORD","CLIENT_CREDENTIALS"],"x-genesys-enum-members":[{"name":"CODE"},{"name":"CODE_PKCE"},{"name":"TOKEN"},{"name":"SAML2BEARER"},{"name":"PASSWORD"},{"name":"CLIENT_CREDENTIALS"}]},"scope":{"type":"array","description":"The scope requested by this client. Scopes only apply to clients not using the client_credential grant","items":{"type":"string"}},"roleDivisions":{"type":"array","description":"Set of roles and their corresponding divisions associated with this client. Roles and divisions only apply to clients using the client_credential grant","uniqueItems":true,"items":{"$ref":"#/definitions/RoleDivision"}},"state":{"type":"string","description":"The state of the OAuth client.\nActive: The OAuth client can be used to create access tokens. This is the default state.\nDisabled: Access tokens created by the client are invalid and new ones cannot be created.\nInactive: Access tokens cannot be created with this OAuth client and it will be deleted.","enum":["active","disabled","inactive"],"x-genesys-enum-members":[{"name":"active"},{"name":"disabled"},{"name":"inactive"}]},"dateToDelete":{"type":"string","format":"date-time","description":"The time at which this client will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"organization":{"description":"The oauth client's organization.","readOnly":true,"$ref":"#/definitions/NamedEntity"}}},"OrganizationPresence":{"type":"object","required":["languageLabels"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"languageLabels":{"type":"object","description":"The label used for the system presence in each specified language","additionalProperties":{"type":"string"}},"systemPresence":{"type":"string"},"deactivated":{"type":"boolean"},"primary":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/User"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"$ref":"#/definitions/User"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"RoleDivision":{"type":"object","required":["divisionId","roleId"],"properties":{"roleId":{"type":"string","description":"Role to be associated with the given division which forms a grant"},"divisionId":{"type":"string","description":"Division associated with the given role which forms a grant"}}},"RoutingSkill":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the skill."},"dateModified":{"type":"string","format":"date-time","description":"Date last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"state":{"type":"string","description":"The current state for this skill.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"version":{"type":"string","description":"Required when updating. Version must be the current version. Only the system can assign version.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Section":{"type":"object","properties":{"fieldList":{"type":"array","items":{"$ref":"#/definitions/FieldList"}},"instructionText":{"type":"string"},"key":{"type":"string"},"state":{"type":"string"}}},"ServerDate":{"type":"object","properties":{"currentDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"TokenInfo":{"type":"object","properties":{"organization":{"description":"The current organization","readOnly":true,"$ref":"#/definitions/NamedEntity"},"homeOrganization":{"description":"The token's home organization","readOnly":true,"$ref":"#/definitions/NamedEntity"},"authorizedScope":{"type":"array","description":"The list of scopes authorized for the OAuth client","readOnly":true,"items":{"type":"string"}},"clonedUser":{"description":"Only present when a user is a clone of trustee user in the trustor org.","readOnly":true,"$ref":"#/definitions/TokenInfoClonedUser"},"OAuthClient":{"$ref":"#/definitions/OrgOAuthClient"}}},"TokenInfoClonedUser":{"type":"object","properties":{"id":{"type":"string","description":"User id of the original native user","readOnly":true},"organization":{"description":"Organization of the original native user","readOnly":true,"$ref":"#/definitions/Entity"}}},"TrusteeAuthorization":{"type":"object","properties":{"permissions":{"type":"array","description":"Permissions that the trustee user has in the trustor organization","readOnly":true,"items":{"type":"string"}}}},"Trustor":{"type":"object","required":["enabled"],"properties":{"id":{"type":"string","description":"Organization Id for this trust.","readOnly":true},"enabled":{"type":"boolean","description":"If disabled no trustee user will have access, even if they were previously added."},"dateCreated":{"type":"string","format":"date-time","description":"Date Trust was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"createdBy":{"description":"User that created trust.","readOnly":true,"$ref":"#/definitions/OrgUser"},"organization":{"description":"Organization associated with this trust.","readOnly":true,"$ref":"#/definitions/Organization"},"authorization":{"description":"Authorization for the trustee user has in this trustor organization","readOnly":true,"$ref":"#/definitions/TrusteeAuthorization"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserMe":{"type":"object","required":["version"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"chat":{"$ref":"#/definitions/Chat"},"department":{"type":"string"},"email":{"type":"string"},"primaryContactInfo":{"type":"array","description":"Auto populated from addresses.","readOnly":true,"items":{"$ref":"#/definitions/Contact"}},"addresses":{"type":"array","description":"Email addresses and phone numbers for this user","items":{"$ref":"#/definitions/Contact"}},"state":{"type":"string","description":"The current state for this user.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"title":{"type":"string"},"username":{"type":"string"},"manager":{"$ref":"#/definitions/User"},"images":{"type":"array","items":{"$ref":"#/definitions/UserImage"}},"version":{"type":"integer","format":"int32","description":"Required when updating a user, this value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH."},"certifications":{"type":"array","items":{"type":"string"}},"biography":{"$ref":"#/definitions/Biography"},"employerInfo":{"$ref":"#/definitions/EmployerInfo"},"routingStatus":{"description":"ACD routing status","readOnly":true,"$ref":"#/definitions/RoutingStatus"},"presence":{"description":"Active presence","readOnly":true,"$ref":"#/definitions/UserPresence"},"conversationSummary":{"description":"Summary of conversion statistics for conversation types.","readOnly":true,"$ref":"#/definitions/UserConversationSummary"},"outOfOffice":{"description":"Determine if out of office is enabled","readOnly":true,"$ref":"#/definitions/OutOfOffice"},"geolocation":{"description":"Current geolocation position","readOnly":true,"$ref":"#/definitions/Geolocation"},"station":{"description":"Effective, default, and last station information","readOnly":true,"$ref":"#/definitions/UserStations"},"authorization":{"description":"Roles and permissions assigned to the user","readOnly":true,"$ref":"#/definitions/UserAuthorization"},"profileSkills":{"type":"array","description":"Profile skills possessed by the user","readOnly":true,"items":{"type":"string"}},"locations":{"type":"array","description":"The user placement at each site location.","readOnly":true,"items":{"$ref":"#/definitions/Location"}},"groups":{"type":"array","description":"The groups the user is a member of","readOnly":true,"items":{"$ref":"#/definitions/Group"}},"team":{"description":"The team the user is a member of","readOnly":true,"$ref":"#/definitions/Team"},"skills":{"type":"array","description":"Routing (ACD) skills possessed by the user","readOnly":true,"items":{"$ref":"#/definitions/UserRoutingSkill"}},"languages":{"type":"array","description":"Routing (ACD) languages possessed by the user","readOnly":true,"items":{"$ref":"#/definitions/UserRoutingLanguage"}},"acdAutoAnswer":{"type":"boolean","description":"acd auto answer"},"languagePreference":{"type":"string","description":"preferred language by the user","readOnly":true},"lastTokenIssued":{"$ref":"#/definitions/OAuthLastTokenIssued"},"date":{"description":"The PureCloud system date time.","readOnly":true,"$ref":"#/definitions/ServerDate"},"geolocationSettings":{"description":"Geolocation settings for user's organization.","readOnly":true,"$ref":"#/definitions/GeolocationSettings"},"organization":{"description":"Organization details for this user.","readOnly":true,"$ref":"#/definitions/Organization"},"presenceDefinitions":{"type":"array","description":"The first 100 presence definitions for user's organization.","readOnly":true,"items":{"$ref":"#/definitions/OrganizationPresence"}},"locationDefinitions":{"type":"array","description":"The first 100 site locations for user's organization","readOnly":true,"items":{"$ref":"#/definitions/LocationDefinition"}},"orgAuthorization":{"type":"array","description":"The first 100 organization roles, with applicable permission policies, for user's organization.","readOnly":true,"items":{"$ref":"#/definitions/DomainOrganizationRole"}},"favorites":{"type":"array","description":"The first 50 favorited users.","readOnly":true,"items":{"$ref":"#/definitions/User"}},"superiors":{"type":"array","description":"The first 50 superiors of this user.","readOnly":true,"items":{"$ref":"#/definitions/User"}},"directReports":{"type":"array","description":"The first 50 direct reports to this user.","readOnly":true,"items":{"$ref":"#/definitions/User"}},"adjacents":{"description":"The first 50 superiors, direct reports, and siblings of this user. Mutually exclusive with superiors and direct reports expands.","readOnly":true,"$ref":"#/definitions/Adjacents"},"routingSkills":{"type":"array","description":"The first 50 routing skills for user's organizations","readOnly":true,"items":{"$ref":"#/definitions/RoutingSkill"}},"fieldConfigs":{"description":"The field config for all entities types of user's organization","readOnly":true,"$ref":"#/definitions/FieldConfigs"},"token":{"description":"Information about the current token","readOnly":true,"$ref":"#/definitions/TokenInfo"},"trustors":{"type":"array","description":"Organizations having this user as a trustee","readOnly":true,"items":{"$ref":"#/definitions/Trustor"}},"orgProducts":{"type":"array","description":"Products enabled in this organization","readOnly":true,"items":{"$ref":"#/definitions/DomainOrganizationProduct"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ResponseSetEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ResponseSet"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Usage":{"type":"object","properties":{"types":{"type":"array","items":{"$ref":"#/definitions/UsageItem"}}}},"UsageItem":{"type":"object","properties":{"type":{"type":"string","enum":["RECORDING","FAX","DOCUMENT","ALL"],"x-genesys-enum-members":[{"name":"RECORDING"},{"name":"FAX"},{"name":"DOCUMENT"},{"name":"ALL"}]},"totalDocumentByteCount":{"type":"integer","format":"int64"},"totalDocumentCount":{"type":"integer","format":"int64"}}},"Agent":{"type":"object","properties":{"stage":{"type":"string","description":"The current stage for this agent"}}},"UserReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserSchedule":{"type":"object","required":["metadata"],"properties":{"shifts":{"type":"array","description":"The shifts that belong to this schedule","items":{"$ref":"#/definitions/UserScheduleShift"}},"fullDayTimeOffMarkers":{"type":"array","description":"Markers to indicate a full day time off request, relative to the management unit time zone","items":{"$ref":"#/definitions/UserScheduleFullDayTimeOffMarker"}},"delete":{"type":"boolean","description":"If marked true for updating an existing user schedule, it will be deleted"},"metadata":{"description":"Version metadata for this schedule","$ref":"#/definitions/WfmVersionedEntityMetadata"},"workPlanId":{"type":"string","description":"ID of the work plan associated with the user during schedule creation","readOnly":true}},"description":"A schedule for a single user over a given time range"},"UserScheduleActivity":{"type":"object","properties":{"activityCodeId":{"type":"string","description":"The id for the activity code. Look up a map of activity codes with the activities route"},"startDate":{"type":"string","format":"date-time","description":"Start time in UTC for this activity, in ISO-8601 format"},"lengthInMinutes":{"type":"integer","format":"int32","description":"Length in minutes for this activity"},"description":{"type":"string","description":"Description for this activity"},"countsAsPaidTime":{"type":"boolean","description":"Whether this activity is paid"},"isDstFallback":{"type":"boolean","description":"Whether this activity spans a DST fallback"},"timeOffRequestId":{"type":"string","description":"Time off request id of this activity"}},"description":"Represents a single activity in a user's shift"},"UserScheduleContainer":{"type":"object","properties":{"managementUnitTimeZone":{"type":"string","description":"The reference time zone used for the management unit"},"publishedSchedules":{"type":"array","description":"References to all published week schedules overlapping the start/end date query parameters","items":{"$ref":"#/definitions/WeekScheduleReference"}},"userSchedules":{"type":"object","description":"Map of user id to user schedule","additionalProperties":{"$ref":"#/definitions/UserSchedule"}}},"description":"Container object to hold a map of user schedules"},"UserScheduleFullDayTimeOffMarker":{"type":"object","properties":{"managementUnitDate":{"type":"string","description":"The date associated with the time off request that this marker corresponds to. Date only, in ISO-8601 format."},"activityCodeId":{"type":"string","description":"The id for the activity code. Look up a map of activity codes with the activities route"},"isPaid":{"type":"boolean","description":"Whether this is paid time off"},"lengthInMinutes":{"type":"integer","format":"int32","description":"The length in minutes of this time off marker"},"description":{"type":"string","description":"The description associated with the time off request that this marker corresponds to"},"delete":{"type":"boolean","description":"If marked true for updating an existing full day time off marker, it will be deleted"}},"description":"Marker to indicate an approved full day time off request"},"UserScheduleShift":{"type":"object","properties":{"weekSchedule":{"description":"The schedule to which this shift belongs","readOnly":true,"$ref":"#/definitions/WeekScheduleReference"},"id":{"type":"string","description":"ID of the schedule shift. This is only for the case of updating and deleting an existing shift"},"startDate":{"type":"string","format":"date-time","description":"Start time in UTC for this shift. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"lengthInMinutes":{"type":"integer","format":"int32","description":"Length of this shift in minutes","readOnly":true},"activities":{"type":"array","description":"List of activities in this shift","items":{"$ref":"#/definitions/UserScheduleActivity"}},"delete":{"type":"boolean","description":"If marked true for updating this schedule shift, it will be deleted"},"manuallyEdited":{"type":"boolean","description":"Whether the shift was set as manually edited"}},"description":"Single shift in a user's schedule"},"WeekScheduleReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"weekDate":{"type":"string","description":"First day of this week schedule in yyyy-MM-dd format"}}},"WfmVersionedEntityMetadata":{"type":"object","required":["version"],"properties":{"version":{"type":"integer","format":"int32","description":"The version of the associated entity. Used to prevent conflicts on concurrent edits"},"modifiedBy":{"description":"The user who last modified the associated entity","readOnly":true,"$ref":"#/definitions/UserReference"},"dateModified":{"type":"string","format":"date-time","description":"The date the associated entity was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true}},"description":"Metadata to associate with a given entity"},"CurrentUserScheduleRequestBody":{"type":"object","required":["endDate","startDate"],"properties":{"startDate":{"type":"string","format":"date-time","description":"Beginning of the range of schedules to fetch, in ISO-8601 format"},"endDate":{"type":"string","format":"date-time","description":"End of the range of schedules to fetch, in ISO-8601 format"},"loadFullWeeks":{"type":"boolean","description":"Whether to load the full week's schedule (for the current user) of any week overlapping the start/end date query parameters, defaults to false"}},"description":"POST request body for fetching the current user's schedule over a given range"},"SchedulingProcessingError":{"type":"object","properties":{"internalErrorCode":{"type":"string","description":"An internal code representing the type of error. BadJson for 'Unable to parse json.' NotFound for 'Resource not found.' Fail for 'An unexpected server error occured.'","readOnly":true,"enum":["BadJson","NotFound","Fail"],"x-genesys-enum-members":[{"name":"BadJson"},{"name":"NotFound"},{"name":"Fail"}]},"description":{"type":"string","description":"A text description of the error","readOnly":true}}},"SchedulingStatusResponse":{"type":"object","properties":{"id":{"type":"string","description":"The ID generated for the scheduling job. Use to GET result when job is completed.","readOnly":true},"status":{"type":"string","description":"The status of the scheduling job.","readOnly":true,"enum":["Pending","Success","Failed","Ongoing","PartialFailure"],"x-genesys-enum-members":[{"name":"Pending"},{"name":"Success"},{"name":"Failed"},{"name":"Ongoing"},{"name":"PartialFailure"}]},"errorDetails":{"type":"array","description":"If the request could not be properly processed, error details will be given here.","readOnly":true,"items":{"$ref":"#/definitions/SchedulingProcessingError"}},"schedulingResultUri":{"type":"string","description":"The uri of the scheduling result. It has a value if the status is 'Success'.","readOnly":true},"percentComplete":{"type":"integer","format":"int32","description":"The percentage of the job that is complete.","readOnly":true}}},"Campaign":{"type":"object","required":["callerAddress","callerName","contactList","dialingMode","name","phoneColumns"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the Campaign."},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"contactList":{"description":"The ContactList for this Campaign to dial.","$ref":"#/definitions/DomainEntityRef"},"queue":{"description":"The Queue for this Campaign to route calls to. Required for all dialing modes except agentless.","$ref":"#/definitions/DomainEntityRef"},"dialingMode":{"type":"string","description":"The strategy this Campaign will use for dialing.","enum":["agentless","preview","power","predictive","progressive","external"],"x-genesys-enum-members":[{"name":"agentless"},{"name":"preview"},{"name":"power"},{"name":"predictive"},{"name":"progressive"},{"name":"external"}]},"script":{"description":"The Script to be displayed to agents that are handling outbound calls. Required for all dialing modes except agentless.","$ref":"#/definitions/DomainEntityRef"},"edgeGroup":{"description":"The EdgeGroup that will place the calls. Required for all dialing modes except preview.","$ref":"#/definitions/DomainEntityRef"},"site":{"description":"The identifier of the site to be used for dialing; can be set in place of an edge group.","$ref":"#/definitions/DomainEntityRef"},"campaignStatus":{"type":"string","description":"The current status of the Campaign. A Campaign may be turned 'on' or 'off'. Required for updates.","enum":["on","stopping","off","complete","invalid","forced_off","forced_stopping"],"x-genesys-enum-members":[{"name":"on"},{"name":"stopping"},{"name":"off"},{"name":"complete"},{"name":"invalid"},{"name":"forced_off"},{"name":"forced_stopping"}]},"phoneColumns":{"type":"array","description":"The ContactPhoneNumberColumns on the ContactList that this Campaign should dial.","items":{"$ref":"#/definitions/PhoneColumn"}},"abandonRate":{"type":"number","format":"double","description":"The targeted abandon rate percentage. Required for progressive, power, and predictive campaigns."},"dncLists":{"type":"array","description":"DncLists for this Campaign to check before placing a call.","items":{"$ref":"#/definitions/DomainEntityRef"}},"callableTimeSet":{"description":"The callable time set for this campaign to check before placing a call.","$ref":"#/definitions/DomainEntityRef"},"callAnalysisResponseSet":{"description":"The call analysis response set to handle call analysis results from the edge. Required for all dialing modes except preview.","$ref":"#/definitions/DomainEntityRef"},"errors":{"type":"array","description":"A list of current error conditions associated with the campaign.","readOnly":true,"items":{"$ref":"#/definitions/RestErrorDetail"}},"callerName":{"type":"string","description":"The caller id name to be displayed on the outbound call."},"callerAddress":{"type":"string","example":"(555) 555-5555","description":"The caller id phone number to be displayed on the outbound call."},"outboundLineCount":{"type":"integer","format":"int32","description":"The number of outbound lines to be concurrently dialed. Only applicable to non-preview campaigns; only required for agentless."},"ruleSets":{"type":"array","description":"Rule sets to be applied while this campaign is dialing.","items":{"$ref":"#/definitions/DomainEntityRef"}},"skipPreviewDisabled":{"type":"boolean","description":"Whether or not agents can skip previews without placing a call. Only applicable for preview campaigns."},"previewTimeOutSeconds":{"type":"integer","format":"int64","description":"The number of seconds before a call will be automatically placed on a preview. A value of 0 indicates no automatic placement of calls. Only applicable to preview campaigns."},"alwaysRunning":{"type":"boolean","description":"Indicates (when true) that the campaign will remain on after contacts are depleted, allowing additional contacts to be appended/added to the contact list and processed by the still-running campaign. The campaign can still be turned off manually."},"contactSort":{"description":"The order in which to sort contacts for dialing, based on a column.","$ref":"#/definitions/ContactSort"},"contactSorts":{"type":"array","description":"The order in which to sort contacts for dialing, based on up to four columns.","items":{"$ref":"#/definitions/ContactSort"}},"noAnswerTimeout":{"type":"integer","format":"int32","description":"How long to wait before dispositioning a call as 'no-answer'. Default 30 seconds. Only applicable to non-preview campaigns."},"callAnalysisLanguage":{"type":"string","description":"The language the edge will use to analyze the call."},"priority":{"type":"integer","format":"int32","description":"The priority of this campaign relative to other campaigns that are running on the same queue. 5 is the highest priority, 1 the lowest."},"contactListFilters":{"type":"array","description":"Filter to apply to the contact list before dialing. Currently a campaign can only have one filter applied.","items":{"$ref":"#/definitions/DomainEntityRef"}},"division":{"description":"The division this campaign belongs to.","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CampaignEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Campaign"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ContactSort":{"type":"object","properties":{"fieldName":{"type":"string"},"direction":{"type":"string","description":"The direction in which to sort contacts.","enum":["ASC","DESC"],"x-genesys-enum-members":[{"name":"ASC"},{"name":"DESC"}]},"numeric":{"type":"boolean","description":"Whether or not the column contains numeric data."}}},"PhoneColumn":{"type":"object","required":["columnName","type"],"properties":{"columnName":{"type":"string","description":"The name of the phone column."},"type":{"type":"string","description":"The type of the phone column. For example, 'cell' or 'home'."}}},"RestErrorDetail":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"name of the error","readOnly":true},"details":{"type":"string","description":"additional information regarding the error","readOnly":true}}},"TtsEngineEntity":{"type":"object","required":["languages","outputFormats"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"languages":{"type":"array","description":"The set of languages the TTS engine supports","items":{"type":"string"}},"outputFormats":{"type":"array","description":"The set of output formats the TTS engine can produce","items":{"type":"string"}},"voices":{"type":"array","description":"The set of voices the TTS engine supports","items":{"$ref":"#/definitions/TtsVoiceEntity"}},"isDefault":{"type":"boolean","description":"The TTS engine is the global default engine"},"isSecure":{"type":"boolean","description":"The TTS engine can be used in a secure call flow"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TtsVoiceEntity":{"type":"object","required":["engine","gender","language"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"gender":{"type":"string","description":"The gender of the TTS voice"},"language":{"type":"string","description":"The language supported by the TTS voice"},"engine":{"description":"Ths TTS engine this voice belongs to","$ref":"#/definitions/TtsEngineEntity"},"isDefault":{"type":"boolean","description":"The voice is the default voice for its language"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TtsVoiceEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/TtsVoiceEntity"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EstimatedWaitTimePredictions":{"type":"object","required":["results"],"properties":{"results":{"type":"array","description":"Returned upon a successful estimated wait time request.","items":{"$ref":"#/definitions/PredictionResults"}}}},"PredictionResults":{"type":"object","required":["estimatedWaitTimeSeconds","formula"],"properties":{"intent":{"type":"string","description":"Indicates the media type scope of this estimated wait time","enum":["ALL","CALL","CALLBACK","CHAT","EMAIL","SOCIALEXPRESSION","VIDEOCOMM","MESSAGE"],"x-genesys-enum-members":[{"name":"ALL"},{"name":"CALL"},{"name":"CALLBACK"},{"name":"CHAT"},{"name":"EMAIL"},{"name":"SOCIALEXPRESSION"},{"name":"VIDEOCOMM"},{"name":"MESSAGE"}]},"formula":{"type":"string","description":"Indicates the estimated wait time Formula","enum":["BEST","SIMPLE","ABANDON","PATIENCE_ABANDON"],"x-genesys-enum-members":[{"name":"BEST"},{"name":"SIMPLE"},{"name":"ABANDON"},{"name":"PATIENCE_ABANDON"}]},"estimatedWaitTimeSeconds":{"type":"integer","format":"int32","description":"Estimated wait time in seconds"}}},"BuScheduleReferenceForMuRoute":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"weekDate":{"type":"string","format":"date","description":"The start week date for this schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"businessUnit":{"description":"The start week date for this schedule","$ref":"#/definitions/BusinessUnitReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BusinessUnitReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ShiftTradeListResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ShiftTradeResponse"}}}},"ShiftTradeResponse":{"type":"object","properties":{"id":{"type":"string","description":"The ID of this shift trade"},"weekDate":{"type":"string","format":"date","description":"The start week date of the associated schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"schedule":{"description":"A reference to the associated schedule","$ref":"#/definitions/BuScheduleReferenceForMuRoute"},"state":{"type":"string","description":"The state of this shift trade","enum":["Unmatched","Matched","Approved","Denied","Expired","Canceled"],"x-genesys-enum-members":[{"name":"Unmatched"},{"name":"Matched"},{"name":"Approved"},{"name":"Denied"},{"name":"Expired"},{"name":"Canceled"}]},"initiatingUser":{"description":"The user who initiated this trade","$ref":"#/definitions/UserReference"},"initiatingShiftId":{"type":"string","description":"The ID of the shift offered for trade by the initiating user"},"initiatingShiftStart":{"type":"string","format":"date-time","description":"The start date/time of the shift being offered for trade. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"initiatingShiftEnd":{"type":"string","format":"date-time","description":"The end date/time of the shift being offered for trade. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"receivingUser":{"description":"The user matching the trade, or if the state is not Matched, the user to whom the trade request was sent","$ref":"#/definitions/UserReference"},"receivingShiftId":{"type":"string","description":"The ID of the shift being exchanged for the initiating shift, null if the receiving user is picking up a shift"},"receivingShiftStart":{"type":"string","format":"date-time","description":"The start date/time of the receiving shift. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"receivingShiftEnd":{"type":"string","format":"date-time","description":"The end date/time of the receiving shift. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"expiration":{"type":"string","format":"date-time","description":"When this shift trade offer will expire if not matched or approved. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"oneSided":{"type":"boolean","description":"Whether this is a one-sided shift trade (e.g. the initiating user is not asking for a shift in return)"},"acceptableIntervals":{"type":"array","items":{"type":"string","description":"Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"}},"reviewedBy":{"description":"The user who reviewed this shift trade","$ref":"#/definitions/UserReference"},"reviewedDate":{"type":"string","format":"date-time","description":"The timestamp when this shift trade was reviewed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"metadata":{"description":"Version data for this trade","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"LanguageReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ManagementUnitReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Management unit reference object for Workforce Management (ID/selfUri only)"},"QueueReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"RoutingSkillReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WfmAgent":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"user":{"description":"The user associated with this data","$ref":"#/definitions/UserReference"},"workPlan":{"description":"The work plan associated with this agent, if applicable","$ref":"#/definitions/WorkPlanReference"},"workPlanRotation":{"description":"The work plan rotation associated with this agent, if applicable","$ref":"#/definitions/WorkPlanRotationReference"},"acceptDirectShiftTrades":{"type":"boolean","description":"Whether the agent accepts direct shift trade requests"},"queues":{"type":"array","description":"List of queues to which this agent is capable of handling","items":{"$ref":"#/definitions/QueueReference"}},"languages":{"type":"array","description":"The list of languages this agent is capable of handling","items":{"$ref":"#/definitions/LanguageReference"}},"skills":{"type":"array","description":"The list of skills this agent is capable of handling","items":{"$ref":"#/definitions/RoutingSkillReference"}},"schedulable":{"type":"boolean","description":"Whether the agent has the permission to be included in schedule generation"},"metadata":{"description":"Metadata for this agent","$ref":"#/definitions/WfmVersionedEntityMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Workforce management agent data"},"WorkPlanReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"managementUnit":{"description":"The management unit to which this work plan belongs. Nullable in some routes","$ref":"#/definitions/ManagementUnitReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Work plan information"},"WorkPlanRotationReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LexBot":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string","description":"A description of the Lex bot"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LexBotAlias":{"type":"object","required":["status"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"bot":{"description":"The Lex bot this is an alias for","$ref":"#/definitions/LexBot"},"botVersion":{"type":"string","description":"The version of the Lex bot this alias points at"},"status":{"type":"string","description":"The status of the Lex bot alias","enum":["BUILDING","READY","FAILED","NOT_BUILT"],"x-genesys-enum-members":[{"name":"BUILDING"},{"name":"READY"},{"name":"FAILED"},{"name":"NOT_BUILT"}]},"failureReason":{"type":"string","description":"If the status is FAILED, Amazon Lex explains why it failed to build the bot"},"language":{"type":"string","description":"The target language of the Lex bot","enum":["en-US"]},"intents":{"type":"array","description":"An array of Intents associated with this bot alias","items":{"$ref":"#/definitions/LexIntent"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LexIntent":{"type":"object","required":["name","slots","version"],"properties":{"name":{"type":"string","description":"The intent name"},"description":{"type":"string","description":"A description of the intent"},"slots":{"type":"object","description":"An object mapping slot names to Slot objects","additionalProperties":{"$ref":"#/definitions/LexSlot"}},"version":{"type":"string","description":"The intent version"}}},"LexSlot":{"type":"object","required":["name","type"],"properties":{"name":{"type":"string","description":"The slot name"},"description":{"type":"string","description":"The slot description"},"type":{"type":"string","description":"The slot type"},"priority":{"type":"integer","format":"int32","description":"The priority of the slot"}}},"BuAgentScheduleActivity":{"type":"object","properties":{"startDate":{"type":"string","format":"date-time","description":"The start date/time of this activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"lengthMinutes":{"type":"integer","format":"int32","description":"The length of this activity in minutes"},"description":{"type":"string","description":"The description of this activity"},"activityCodeId":{"type":"string","description":"The ID of the activity code associated with this activity"},"paid":{"type":"boolean","description":"Whether this activity is paid"},"timeOffRequestId":{"type":"string","description":"The ID of the time off request associated with this activity, if applicable"},"externalActivityId":{"type":"string","description":"The ID of the external activity associated with this activity, if applicable"},"externalActivityType":{"type":"string","description":"The type of the external activity associated with this activity, if applicable","enum":["Coaching"],"x-genesys-enum-members":[{"name":"Coaching"}]}}},"BuAgentSchedulePublishedScheduleReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"weekDate":{"type":"string","format":"date","description":"The start week date for this schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"weekCount":{"type":"integer","format":"int32","description":"The number of weeks encompassed by the schedule"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BuAgentScheduleSearchResponse":{"type":"object","properties":{"user":{"description":"The user to whom this agent schedule applies","$ref":"#/definitions/UserReference"},"shifts":{"type":"array","description":"The shift definitions for this agent schedule","items":{"$ref":"#/definitions/BuAgentScheduleShift"}},"fullDayTimeOffMarkers":{"type":"array","description":"Full day time off markers which apply to this agent schedule","items":{"$ref":"#/definitions/BuFullDayTimeOffMarker"}}}},"BuAgentScheduleShift":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"startDate":{"type":"string","format":"date-time","description":"The start date of this shift. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"lengthMinutes":{"type":"integer","format":"int32","description":"The length of this shift in minutes"},"activities":{"type":"array","description":"The activities associated with this shift","items":{"$ref":"#/definitions/BuAgentScheduleActivity"}},"manuallyEdited":{"type":"boolean","description":"Whether this shift was manually edited. This is only set by clients and is used for rescheduling"},"schedule":{"description":"The schedule to which this shift belongs","readOnly":true,"$ref":"#/definitions/BuScheduleReference"}}},"BuAgentSchedulesSearchResponse":{"type":"object","properties":{"agentSchedules":{"type":"array","description":"The requested agent schedules","items":{"$ref":"#/definitions/BuAgentScheduleSearchResponse"}},"businessUnitTimeZone":{"type":"string","description":"The time zone configured for the business unit to which this schedule applies"},"publishedSchedules":{"type":"array","description":"References to all published week schedules overlapping the start/end date query parameters","items":{"$ref":"#/definitions/BuAgentSchedulePublishedScheduleReference"}}}},"BuAsyncAgentSchedulesSearchResponse":{"type":"object","properties":{"status":{"type":"string","description":"The status of the operation","enum":["Processing","Complete","Canceled","Error"],"x-genesys-enum-members":[{"name":"Processing"},{"name":"Complete"},{"name":"Canceled"},{"name":"Error"}]},"operationId":{"type":"string","description":"The ID for the operation"},"result":{"description":"The result of the operation. Null unless status == Complete","$ref":"#/definitions/BuAgentSchedulesSearchResponse"},"progress":{"type":"integer","format":"int32","description":"Percent progress for the operation"},"downloadUrl":{"type":"string","description":"The URL from which to download the result if it is too large to pass directly"}}},"BuFullDayTimeOffMarker":{"type":"object","properties":{"businessUnitDate":{"type":"string","format":"date","description":"The date of the time off marker, interpreted in the business unit's time zone. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"lengthMinutes":{"type":"integer","format":"int32","description":"The length of the time off marker in minutes"},"description":{"type":"string","description":"The description of the time off marker"},"activityCodeId":{"type":"string","description":"The ID of the activity code associated with the time off marker"},"paid":{"type":"boolean","description":"Whether the time off marker is paid"},"timeOffRequestId":{"type":"string","description":"The ID of the time off request"}}},"BuScheduleReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"weekDate":{"type":"string","format":"date","description":"The start week date for this schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BuSearchAgentSchedulesRequest":{"type":"object","required":["endDate","startDate"],"properties":{"startDate":{"type":"string","format":"date-time","description":"Start date of the range to search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endDate":{"type":"string","format":"date-time","description":"End date of the range to search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"userIds":{"type":"array","description":"IDs of the users for whose schedules to search","items":{"type":"string"}}}},"LexBotAliasEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/LexBotAlias"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"UserQueue":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The queue description."},"dateCreated":{"type":"string","format":"date-time","description":"The date the queue was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the queue. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the queue."},"createdBy":{"type":"string","description":"The ID of the user that created the queue."},"memberCount":{"type":"integer","format":"int32","description":"The number of users in the queue.","readOnly":true},"mediaSettings":{"type":"object","description":"The media settings for the queue. Valid key values: CALL, CALLBACK, CHAT, EMAIL, MESSAGE, SOCIAL_EXPRESSION, VIDEO_COMM","additionalProperties":{"$ref":"#/definitions/MediaSetting"}},"routingRules":{"type":"array","description":"The routing rules for the queue, used for routing to known or preferred agents.","items":{"$ref":"#/definitions/RoutingRule"}},"bullseye":{"description":"The bulls-eye settings for the queue.","$ref":"#/definitions/Bullseye"},"acwSettings":{"description":"The ACW settings for the queue.","$ref":"#/definitions/AcwSettings"},"skillEvaluationMethod":{"type":"string","description":"The skill evaluation method to use when routing conversations.","enum":["NONE","BEST","ALL"],"x-genesys-enum-members":[{"name":"NONE"},{"name":"BEST"},{"name":"ALL"}]},"queueFlow":{"description":"The in-queue flow to use for conversations waiting in queue.","$ref":"#/definitions/DomainEntityRef"},"whisperPrompt":{"description":"The prompt used for whisper on the queue, if configured.","$ref":"#/definitions/DomainEntityRef"},"enableTranscription":{"type":"boolean","description":"Indicates whether voice transcription is enabled for this queue."},"enableManualAssignment":{"type":"boolean","description":"Indicates whether manual assignment is enabled for this queue."},"callingPartyName":{"type":"string","description":"The name to use for caller identification for outbound calls from this queue."},"callingPartyNumber":{"type":"string","description":"The phone number to use for caller identification for outbound calls from this queue."},"defaultScripts":{"type":"object","description":"The default script Ids for the communication types.","additionalProperties":{"$ref":"#/definitions/Script"}},"outboundMessagingAddresses":{"description":"The messaging addresses for the queue.","$ref":"#/definitions/QueueMessagingAddresses"},"outboundEmailAddress":{"$ref":"#/definitions/QueueEmailAddress"},"joined":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserActionCategory":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserActionCategoryEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UserActionCategory"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"BuAgentScheduleUpdate":{"type":"object","properties":{"type":{"type":"string","description":"The type of update","enum":["Added","Edited","Deleted"],"x-genesys-enum-members":[{"name":"Added"},{"name":"Edited"},{"name":"Deleted"}]},"shiftStartDates":{"type":"array","description":"The start date for the affected shifts","items":{"type":"string","format":"date-time"}}}},"BuCurrentAgentScheduleSearchResponse":{"type":"object","properties":{"agentSchedules":{"type":"array","description":"The requested agent schedules","items":{"$ref":"#/definitions/BuAgentScheduleSearchResponse"}},"businessUnitTimeZone":{"type":"string","description":"The time zone configured for the business unit to which this schedule applies"},"publishedSchedules":{"type":"array","description":"References to all published week schedules overlapping the start/end date query parameters","items":{"$ref":"#/definitions/BuAgentSchedulePublishedScheduleReference"}},"startDate":{"type":"string","format":"date-time","description":"The start date of the schedules. Only populated on notifications. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endDate":{"type":"string","format":"date-time","description":"The end date of the schedules. Only populated on notifications. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"updates":{"type":"array","description":"The list of updates for the schedule. Only used in notifications","items":{"$ref":"#/definitions/BuAgentScheduleUpdate"}}}},"BuGetCurrentAgentScheduleRequest":{"type":"object","required":["endDate","startDate"],"properties":{"startDate":{"type":"string","format":"date-time","description":"Start date of the range to search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endDate":{"type":"string","format":"date-time","description":"End date of the range to search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"Dependency":{"type":"object","properties":{"id":{"type":"string","description":"The dependency identifier"},"name":{"type":"string"},"version":{"type":"string"},"type":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","BOTCONNECTORBOT","BOTCONNECTORBOTVERSION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GROUP","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","IVRCONFIGURATION","LANGUAGE","LEXBOT","LEXBOTALIAS","NLUDOMAIN","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","WIDGET","WORKFLOW"],"x-genesys-enum-members":[{"name":"ACDLANGUAGE"},{"name":"ACDSKILL"},{"name":"ACDWRAPUPCODE"},{"name":"BOTCONNECTORBOT"},{"name":"BOTCONNECTORBOTVERSION"},{"name":"BOTFLOW"},{"name":"BRIDGEACTION"},{"name":"COMMONMODULEFLOW"},{"name":"COMPOSERSCRIPT"},{"name":"CONTACTLIST"},{"name":"DATAACTION"},{"name":"DATATABLE"},{"name":"DIALOGENGINEBOT"},{"name":"DIALOGENGINEBOTVERSION"},{"name":"DIALOGFLOWAGENT"},{"name":"EMAILROUTE"},{"name":"EMERGENCYGROUP"},{"name":"FLOWACTION"},{"name":"FLOWDATATYPE"},{"name":"FLOWMILESTONE"},{"name":"FLOWOUTCOME"},{"name":"GROUP"},{"name":"INBOUNDCALLFLOW"},{"name":"INBOUNDCHATFLOW"},{"name":"INBOUNDEMAILFLOW"},{"name":"INBOUNDSHORTMESSAGEFLOW"},{"name":"INQUEUECALLFLOW"},{"name":"IVRCONFIGURATION"},{"name":"LANGUAGE"},{"name":"LEXBOT"},{"name":"LEXBOTALIAS"},{"name":"NLUDOMAIN"},{"name":"OUTBOUNDCALLFLOW"},{"name":"QUEUE"},{"name":"RECORDINGPOLICY"},{"name":"RESPONSE"},{"name":"SCHEDULE"},{"name":"SCHEDULEGROUP"},{"name":"SECUREACTION"},{"name":"SECURECALLFLOW"},{"name":"SURVEYINVITEFLOW"},{"name":"SYSTEMPROMPT"},{"name":"TTSENGINE"},{"name":"TTSVOICE"},{"name":"USER"},{"name":"USERPROMPT"},{"name":"WIDGET"},{"name":"WORKFLOW"}]},"deleted":{"type":"boolean"},"updated":{"type":"boolean"},"stateUnknown":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DependencyObject":{"type":"object","properties":{"id":{"type":"string","description":"The dependency identifier"},"name":{"type":"string"},"version":{"type":"string"},"type":{"type":"string","enum":["ACDLANGUAGE","ACDSKILL","ACDWRAPUPCODE","BOTCONNECTORBOT","BOTCONNECTORBOTVERSION","BOTFLOW","BRIDGEACTION","COMMONMODULEFLOW","COMPOSERSCRIPT","CONTACTLIST","DATAACTION","DATATABLE","DIALOGENGINEBOT","DIALOGENGINEBOTVERSION","DIALOGFLOWAGENT","EMAILROUTE","EMERGENCYGROUP","FLOWACTION","FLOWDATATYPE","FLOWMILESTONE","FLOWOUTCOME","GROUP","INBOUNDCALLFLOW","INBOUNDCHATFLOW","INBOUNDEMAILFLOW","INBOUNDSHORTMESSAGEFLOW","INQUEUECALLFLOW","IVRCONFIGURATION","LANGUAGE","LEXBOT","LEXBOTALIAS","NLUDOMAIN","OUTBOUNDCALLFLOW","QUEUE","RECORDINGPOLICY","RESPONSE","SCHEDULE","SCHEDULEGROUP","SECUREACTION","SECURECALLFLOW","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","WIDGET","WORKFLOW"],"x-genesys-enum-members":[{"name":"ACDLANGUAGE"},{"name":"ACDSKILL"},{"name":"ACDWRAPUPCODE"},{"name":"BOTCONNECTORBOT"},{"name":"BOTCONNECTORBOTVERSION"},{"name":"BOTFLOW"},{"name":"BRIDGEACTION"},{"name":"COMMONMODULEFLOW"},{"name":"COMPOSERSCRIPT"},{"name":"CONTACTLIST"},{"name":"DATAACTION"},{"name":"DATATABLE"},{"name":"DIALOGENGINEBOT"},{"name":"DIALOGENGINEBOTVERSION"},{"name":"DIALOGFLOWAGENT"},{"name":"EMAILROUTE"},{"name":"EMERGENCYGROUP"},{"name":"FLOWACTION"},{"name":"FLOWDATATYPE"},{"name":"FLOWMILESTONE"},{"name":"FLOWOUTCOME"},{"name":"GROUP"},{"name":"INBOUNDCALLFLOW"},{"name":"INBOUNDCHATFLOW"},{"name":"INBOUNDEMAILFLOW"},{"name":"INBOUNDSHORTMESSAGEFLOW"},{"name":"INQUEUECALLFLOW"},{"name":"IVRCONFIGURATION"},{"name":"LANGUAGE"},{"name":"LEXBOT"},{"name":"LEXBOTALIAS"},{"name":"NLUDOMAIN"},{"name":"OUTBOUNDCALLFLOW"},{"name":"QUEUE"},{"name":"RECORDINGPOLICY"},{"name":"RESPONSE"},{"name":"SCHEDULE"},{"name":"SCHEDULEGROUP"},{"name":"SECUREACTION"},{"name":"SECURECALLFLOW"},{"name":"SURVEYINVITEFLOW"},{"name":"SYSTEMPROMPT"},{"name":"TTSENGINE"},{"name":"TTSVOICE"},{"name":"USER"},{"name":"USERPROMPT"},{"name":"WIDGET"},{"name":"WORKFLOW"}]},"deleted":{"type":"boolean"},"updated":{"type":"boolean"},"stateUnknown":{"type":"boolean"},"consumedResources":{"type":"array","items":{"$ref":"#/definitions/Dependency"}},"consumingResources":{"type":"array","items":{"$ref":"#/definitions/Dependency"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DomainPhysicalCapabilities":{"type":"object","properties":{"vlan":{"type":"boolean"},"team":{"type":"boolean"}}},"DomainPhysicalInterface":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"edgeUri":{"type":"string","format":"uri"},"friendlyName":{"type":"string"},"hardwareAddress":{"type":"string"},"portLabel":{"type":"string"},"physicalCapabilities":{"$ref":"#/definitions/DomainPhysicalCapabilities"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PhysicalInterfaceEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DomainPhysicalInterface"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"KeyRotationSchedule":{"type":"object","required":["period"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"period":{"type":"string","description":"Value to set schedule to","enum":["DISABLED","DAILY","WEEKLY","MONTHLY","YEARLY"],"x-genesys-enum-members":[{"name":"DISABLED"},{"name":"DAILY"},{"name":"WEEKLY"},{"name":"MONTHLY"},{"name":"YEARLY"}]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FaxSummary":{"type":"object","properties":{"readCount":{"type":"integer","format":"int32"},"unreadCount":{"type":"integer","format":"int32"},"totalCount":{"type":"integer","format":"int32"}}},"DependencyObjectEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DependencyObject"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EdgeLogsJobUploadRequest":{"type":"object","required":["fileIds"],"properties":{"fileIds":{"type":"array","description":"A list of file ids to upload.","items":{"type":"string"}}}},"CursorNoteListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Note"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"Cursors":{"type":"object","properties":{"before":{"type":"string"},"after":{"type":"string"}}},"ExternalDataSource":{"type":"object","properties":{"platform":{"type":"string","description":"The platform that was the source of the data. Example: a CRM like SALESFORCE.","enum":["SALESFORCE"]},"url":{"type":"string","description":"An URL that links to the source record that contributed data to the associated entity."}},"description":"Describes a link to a record in an external system that contributed data to a Relate record"},"Note":{"type":"object","required":["createdBy"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"noteText":{"type":"string"},"modifyDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"description":"The author of this note","$ref":"#/definitions/User"},"externalDataSources":{"type":"array","description":"Links to the sources of data (e.g. one source might be a CRM) that contributed data to this record. Read-only, and only populated when requested via expand param.","readOnly":true,"items":{"$ref":"#/definitions/ExternalDataSource"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AuditEntity":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"The type of the entity the action of this AuditEntity targeted."},"id":{"type":"string","description":"The id of the entity the action of this AuditEntity targeted."},"name":{"type":"string","description":"The name of the entity the action of this AuditEntity targeted."},"selfUri":{"type":"string","description":"The selfUri for this entity."}}},"AuditUser":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID (UUID) of the user who initiated the action of this AuditMessage."},"name":{"type":"string","description":"The full username of the user who initiated the action of this AuditMessage."},"display":{"type":"string","description":"The display name of the user who initiated the action of this AuditMessage."}}},"Change":{"type":"object","properties":{"entity":{"$ref":"#/definitions/AuditEntity"},"property":{"type":"string","description":"The property that was changed"},"oldValues":{"type":"array","description":"The old values which were modified and/or removed by this action.","items":{"type":"string"}},"newValues":{"type":"array","description":"The new values which were modified and/or added by this action.","items":{"type":"string"}}}},"IntegrationStatusInfo":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable status as reported by the integration.","readOnly":true,"enum":["ACTIVE","ACTIVATING","INACTIVE","DEACTIVATING","ERROR"],"x-genesys-enum-members":[{"name":"ACTIVE"},{"name":"ACTIVATING"},{"name":"INACTIVE"},{"name":"DEACTIVATING"},{"name":"ERROR"}]},"effective":{"type":"string","description":"Localized, human-readable, effective status of the integration.","readOnly":true},"detail":{"description":"Localizable status details for the integration.","readOnly":true,"$ref":"#/definitions/MessageInfo"},"lastUpdated":{"type":"string","format":"date-time","description":"Date and time (in UTC) when the integration status (i.e. the code field) was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true}},"description":"Status information for an Integration."},"MessageInfo":{"type":"object","properties":{"localizableMessageCode":{"type":"string","description":"Key that can be used to localize the message."},"message":{"type":"string","description":"Description of the message."},"messageWithParams":{"type":"string","description":"Message with template fields for variable replacement."},"messageParams":{"type":"object","description":"Map with fields for variable replacement.","additionalProperties":{"type":"string"}}}},"ReportingExportJobResponse":{"type":"object","required":["createdDateTime","exportFormat","filter","interval","locale","modifiedDateTime","percentageComplete","period","read","runId","status","timeZone","viewType"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"runId":{"type":"string","description":"The unique run id of the export schedule execute"},"status":{"type":"string","description":"The current status of the export request","enum":["SUBMITTED","RUNNING","CANCELLING","CANCELLED","COMPLETED","COMPLETED_WITH_PARTIAL_RESULTS","FAILED"],"x-genesys-enum-members":[{"name":"SUBMITTED"},{"name":"RUNNING"},{"name":"CANCELLING"},{"name":"CANCELLED"},{"name":"COMPLETED"},{"name":"COMPLETED_WITH_PARTIAL_RESULTS"},{"name":"FAILED"}]},"timeZone":{"type":"string","description":"The requested timezone of the exported data. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"exportFormat":{"type":"string","description":"The requested format of the exported data","enum":["CSV","PDF"],"x-genesys-enum-members":[{"name":"CSV"},{"name":"PDF"}]},"interval":{"type":"string","description":"The time period used to limit the the exported data. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"downloadUrl":{"type":"string","description":"The url to download the request if it's status is completed"},"viewType":{"type":"string","description":"The type of view export job to be created","enum":["QUEUE_PERFORMANCE_SUMMARY_VIEW","QUEUE_PERFORMANCE_DETAIL_VIEW","INTERACTION_SEARCH_VIEW","AGENT_PERFORMANCE_SUMMARY_VIEW","AGENT_PERFORMANCE_DETAIL_VIEW","AGENT_STATUS_SUMMARY_VIEW","AGENT_STATUS_DETAIL_VIEW","AGENT_EVALUATION_SUMMARY_VIEW","AGENT_EVALUATION_DETAIL_VIEW","AGENT_QUEUE_DETAIL_VIEW","AGENT_INTERACTION_DETAIL_VIEW","ABANDON_INSIGHTS_VIEW","SKILLS_PERFORMANCE_VIEW","SURVEY_FORM_PERFORMANCE_SUMMARY_VIEW","SURVEY_FORM_PERFORMANCE_DETAIL_VIEW","DNIS_PERFORMANCE_SUMMARY_VIEW","DNIS_PERFORMANCE_DETAIL_VIEW","WRAP_UP_PERFORMANCE_SUMMARY_VIEW","AGENT_WRAP_UP_PERFORMANCE_DETAIL_VIEW","QUEUE_ACTIVITY_SUMMARY_VIEW","QUEUE_ACTIVITY_DETAIL_VIEW","AGENT_QUEUE_ACTIVITY_SUMMARY_VIEW","QUEUE_AGENT_DETAIL_VIEW","QUEUE_INTERACTION_DETAIL_VIEW","AGENT_SCHEDULE_DETAIL_VIEW","IVR_PERFORMANCE_SUMMARY_VIEW","IVR_PERFORMANCE_DETAIL_VIEW","ANSWER_INSIGHTS_VIEW","HANDLE_INSIGHTS_VIEW","TALK_INSIGHTS_VIEW","HOLD_INSIGHTS_VIEW","ACW_INSIGHTS_VIEW","WAIT_INSIGHTS_VIEW","AGENT_WRAP_UP_PERFORMANCE_INTERVAL_DETAIL_VIEW","FLOW_OUTCOME_SUMMARY_VIEW","FLOW_OUTCOME_PERFORMANCE_DETAIL_VIEW","FLOW_OUTCOME_PERFORMANCE_INTERVAL_DETAIL_VIEW","FLOW_DESTINATION_SUMMARY_VIEW","FLOW_DESTINATION_DETAIL_VIEW","API_USAGE_VIEW","SCHEDULED_CALLBACKS_VIEW","CONTENT_SEARCH_VIEW","LANDING_PAGE","DASHBOARD_SUMMARY","DASHBOARD_DETAIL","JOURNEY_ACTION_MAP_SUMMARY_VIEW","JOURNEY_OUTCOME_SUMMARY_VIEW","JOURNEY_SEGMENT_SUMMARY_VIEW","AGENT_DEVELOPMENT_DETAIL_VIEW","AGENT_DEVELOPMENT_DETAIL_ME_VIEW","AGENT_DEVELOPMENT_SUMMARY_VIEW","AGENT_PERFORMANCE_ME_VIEW","AGENT_STATUS_ME_VIEW","AGENT_EVALUATION_ME_VIEW"],"x-genesys-enum-members":[{"name":"QUEUE_PERFORMANCE_SUMMARY_VIEW"},{"name":"QUEUE_PERFORMANCE_DETAIL_VIEW"},{"name":"INTERACTION_SEARCH_VIEW"},{"name":"AGENT_PERFORMANCE_SUMMARY_VIEW"},{"name":"AGENT_PERFORMANCE_DETAIL_VIEW"},{"name":"AGENT_STATUS_SUMMARY_VIEW"},{"name":"AGENT_STATUS_DETAIL_VIEW"},{"name":"AGENT_EVALUATION_SUMMARY_VIEW"},{"name":"AGENT_EVALUATION_DETAIL_VIEW"},{"name":"AGENT_QUEUE_DETAIL_VIEW"},{"name":"AGENT_INTERACTION_DETAIL_VIEW"},{"name":"ABANDON_INSIGHTS_VIEW"},{"name":"SKILLS_PERFORMANCE_VIEW"},{"name":"SURVEY_FORM_PERFORMANCE_SUMMARY_VIEW"},{"name":"SURVEY_FORM_PERFORMANCE_DETAIL_VIEW"},{"name":"DNIS_PERFORMANCE_SUMMARY_VIEW"},{"name":"DNIS_PERFORMANCE_DETAIL_VIEW"},{"name":"WRAP_UP_PERFORMANCE_SUMMARY_VIEW"},{"name":"AGENT_WRAP_UP_PERFORMANCE_DETAIL_VIEW"},{"name":"QUEUE_ACTIVITY_SUMMARY_VIEW"},{"name":"QUEUE_ACTIVITY_DETAIL_VIEW"},{"name":"AGENT_QUEUE_ACTIVITY_SUMMARY_VIEW"},{"name":"QUEUE_AGENT_DETAIL_VIEW"},{"name":"QUEUE_INTERACTION_DETAIL_VIEW"},{"name":"AGENT_SCHEDULE_DETAIL_VIEW"},{"name":"IVR_PERFORMANCE_SUMMARY_VIEW"},{"name":"IVR_PERFORMANCE_DETAIL_VIEW"},{"name":"ANSWER_INSIGHTS_VIEW"},{"name":"HANDLE_INSIGHTS_VIEW"},{"name":"TALK_INSIGHTS_VIEW"},{"name":"HOLD_INSIGHTS_VIEW"},{"name":"ACW_INSIGHTS_VIEW"},{"name":"WAIT_INSIGHTS_VIEW"},{"name":"AGENT_WRAP_UP_PERFORMANCE_INTERVAL_DETAIL_VIEW"},{"name":"FLOW_OUTCOME_SUMMARY_VIEW"},{"name":"FLOW_OUTCOME_PERFORMANCE_DETAIL_VIEW"},{"name":"FLOW_OUTCOME_PERFORMANCE_INTERVAL_DETAIL_VIEW"},{"name":"FLOW_DESTINATION_SUMMARY_VIEW"},{"name":"FLOW_DESTINATION_DETAIL_VIEW"},{"name":"API_USAGE_VIEW"},{"name":"SCHEDULED_CALLBACKS_VIEW"},{"name":"CONTENT_SEARCH_VIEW"},{"name":"LANDING_PAGE"},{"name":"DASHBOARD_SUMMARY"},{"name":"DASHBOARD_DETAIL"},{"name":"JOURNEY_ACTION_MAP_SUMMARY_VIEW"},{"name":"JOURNEY_OUTCOME_SUMMARY_VIEW"},{"name":"JOURNEY_SEGMENT_SUMMARY_VIEW"},{"name":"AGENT_DEVELOPMENT_DETAIL_VIEW"},{"name":"AGENT_DEVELOPMENT_DETAIL_ME_VIEW"},{"name":"AGENT_DEVELOPMENT_SUMMARY_VIEW"},{"name":"AGENT_PERFORMANCE_ME_VIEW"},{"name":"AGENT_STATUS_ME_VIEW"},{"name":"AGENT_EVALUATION_ME_VIEW"}]},"exportErrorMessagesType":{"type":"string","description":"The error message in case the export request failed","enum":["FAILED_CONVERTING_EXPORT_JOB","FAILED_NO_DATA_EXPORT_JOB_FOUND","FAILED_GETTING_DATA_FROM_SERVICE","FAILED_GENERATING_TEMP_FILE","FAILED_SAVING_FILE_TO_S3","FAILED_NOTIFYING_SKYWALKER_OF_DOWNLOAD","FAILED_BUILDING_DOWNLOAD_URL_FROM_SKYWALKER_RESPONSE","FAILED_CONVERTING_EXPORT_JOB_TO_QUEUE_PERFORMANCE_JOB","EXPORT_TYPE_NOT_IMPLEMENTED","REACHED_MAXIMUM_ATTEMPT_OF_RETRY","FAILED_LONG_RUNNING_EXPORT","TOO_MANY_REQUESTS_FROM_AN_ORGANIZATION","FAILED_AS_EXPORT_FILE_SIZE_IS_GREATER_THAN_10MB","NOT_AUTHORIZED_TO_VIEW_EXPORT"],"x-genesys-enum-members":[{"name":"FAILED_CONVERTING_EXPORT_JOB"},{"name":"FAILED_NO_DATA_EXPORT_JOB_FOUND"},{"name":"FAILED_GETTING_DATA_FROM_SERVICE"},{"name":"FAILED_GENERATING_TEMP_FILE"},{"name":"FAILED_SAVING_FILE_TO_S3"},{"name":"FAILED_NOTIFYING_SKYWALKER_OF_DOWNLOAD"},{"name":"FAILED_BUILDING_DOWNLOAD_URL_FROM_SKYWALKER_RESPONSE"},{"name":"FAILED_CONVERTING_EXPORT_JOB_TO_QUEUE_PERFORMANCE_JOB"},{"name":"EXPORT_TYPE_NOT_IMPLEMENTED"},{"name":"REACHED_MAXIMUM_ATTEMPT_OF_RETRY"},{"name":"FAILED_LONG_RUNNING_EXPORT"},{"name":"TOO_MANY_REQUESTS_FROM_AN_ORGANIZATION"},{"name":"FAILED_AS_EXPORT_FILE_SIZE_IS_GREATER_THAN_10MB"},{"name":"NOT_AUTHORIZED_TO_VIEW_EXPORT"}]},"period":{"type":"string","description":"The Period of the request in which to break down the intervals. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"filter":{"description":"Filters to apply to create the view","$ref":"#/definitions/ViewFilter"},"read":{"type":"boolean","description":"Indicates if the request has been marked as read"},"createdDateTime":{"type":"string","format":"date-time","description":"The created date/time of the request. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedDateTime":{"type":"string","format":"date-time","description":"The last modified date/time of the request. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"locale":{"type":"string","description":"The locale use for localization of the exported data, i.e. en-us, es-mx "},"percentageComplete":{"type":"number","format":"double","description":"The percentage of the job that has completed processing"},"hasFormatDurations":{"type":"boolean","description":"Indicates if durations are formatted in hh:mm:ss format instead of ms"},"hasSplitFilters":{"type":"boolean","description":"Indicates if filters will be split in aggregate detail exports"},"excludeEmptyRows":{"type":"boolean","description":"Excludes empty rows from the exports"},"hasSplitByMedia":{"type":"boolean","description":"Indicates if media type will be split in aggregate detail exports"},"hasSummaryRow":{"type":"boolean","description":"Indicates if summary row needs to be present in exports"},"csvDelimiter":{"type":"string","description":"The user supplied csv delimiter string value either of type 'comma' or 'semicolon' permitted for the export request","enum":["SEMICOLON","COMMA"],"x-genesys-enum-members":[{"name":"SEMICOLON"},{"name":"COMMA"}]},"selectedColumns":{"type":"array","description":"The list of ordered selected columns from the export view by the user","items":{"$ref":"#/definitions/SelectedColumns"}},"hasCustomParticipantAttributes":{"type":"boolean","description":"Indicates if custom participant attributes will be exported"},"recipientEmails":{"type":"array","description":"The list of email recipients for the exports","items":{"type":"string"}},"emailStatuses":{"type":"object","description":"The status of individual email addresses as a map","additionalProperties":{"type":"string","enum":["Sent","Pending","Failed"],"x-genesys-enum-members":[{"name":"Sent"},{"name":"Pending"},{"name":"Failed"}]}},"emailErrorDescription":{"type":"string","description":"The optional error message in case the export fail to email"},"enabled":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SelectedColumns":{"type":"object","properties":{"columnOrder":{"type":"integer","format":"int32","description":"Indicates the order/position of the selected column"},"columnName":{"type":"string","description":"Indicates enum name of the column from the export view"}}},"Parameter":{"type":"object","properties":{"name":{"type":"string"},"parameterType":{"type":"string","enum":["UUID","STRING","UUIDLIST","STRINGLIST"],"x-genesys-enum-members":[{"name":"UUID"},{"name":"STRING"},{"name":"UUIDLIST"},{"name":"STRINGLIST"}]},"domain":{"type":"string","enum":["USERID","QUEUEID","MEDIATYPE","DIALERCAMPAIGNID","QMEVALFORMID","UNKNOWN"],"x-genesys-enum-members":[{"name":"USERID"},{"name":"QUEUEID"},{"name":"MEDIATYPE"},{"name":"DIALERCAMPAIGNID"},{"name":"QMEVALFORMID"},{"name":"UNKNOWN"}]},"required":{"type":"boolean"}}},"ReportMetaData":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"keywords":{"type":"array","items":{"type":"string"}},"availableLocales":{"type":"array","items":{"type":"string"}},"parameters":{"type":"array","items":{"$ref":"#/definitions/Parameter"}},"exampleUrl":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ScheduleInterval":{"type":"object","required":["end","start"],"properties":{"start":{"type":"string","description":"The scheduled start time as an ISO-8601 string, i.e yyyy-MM-ddTHH:mm:ss.SSSZ"},"end":{"type":"string","description":"The scheduled end time as an ISO-8601 string, i.e. yyyy-MM-ddTHH:mm:ss.SSSZ"}}},"SequenceSchedule":{"type":"object","required":["intervals","sequence","timeZone"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"intervals":{"type":"array","description":"A list of intervals during which to run the associated CampaignSequence.","items":{"$ref":"#/definitions/ScheduleInterval"}},"timeZone":{"type":"string","example":"Africa/Abidjan","description":"The time zone for this SequenceSchedule. For example, Africa/Abidjan."},"sequence":{"description":"The CampaignSequence that this SequenceSchedule is for.","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ScimConfigResourceType":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the SCIM resource. Set by the service provider. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readOnly\". \"returned\" is set to \"always\".","readOnly":true},"schemas":{"type":"array","description":"The list of supported schemas.","readOnly":true,"items":{"type":"string"}},"name":{"type":"string","description":"The name of the resource type.","readOnly":true},"description":{"type":"string","description":"The description of the resource type.","readOnly":true},"schema":{"type":"string","description":"The URI of the primary or base schema for the resource type.","readOnly":true},"schemaExtensions":{"type":"array","description":"The list of schema extensions for the resource type.","readOnly":true,"items":{"$ref":"#/definitions/ScimConfigResourceTypeSchemaExtension"}},"endpoint":{"type":"string","description":"The HTTP-addressable endpoint of the resource type. Appears after the base URL.","readOnly":true},"meta":{"description":"The metadata of the SCIM resource. Only \"location\" and \"resourceType\" are set for \"ResourceType\" resources.","readOnly":true,"$ref":"#/definitions/ScimMetadata"}},"description":"Defines a SCIM resource."},"ScimConfigResourceTypeSchemaExtension":{"type":"object","properties":{"schema":{"type":"string","description":"The URI of an extended schema, for example, \"urn:edu:2.0:Staff\". Must be equal to the \"id\" attribute of a schema.","readOnly":true},"required":{"type":"boolean","description":"Indicates whether a schema extension is required.","readOnly":true}},"description":"Defines a SCIM resource type's schema extension."},"ScimMetadata":{"type":"object","properties":{"resourceType":{"type":"string","description":"The type of SCIM resource.","readOnly":true,"enum":["User","Group","ServiceProviderConfig","ResourceType","Schema"],"x-genesys-enum-members":[{"name":"User"},{"name":"Group"},{"name":"ServiceProviderConfig"},{"name":"ResourceType"},{"name":"Schema"}]},"lastModified":{"type":"string","format":"date-time","description":"The last time that the resource was modified. Date time is represented as an \"ISO-8601 string\", for example, yyyy-MM-ddTHH:mm:ss.SSSZ. Not included with \"Schema\" and \"ResourceType\" resources.","readOnly":true},"location":{"type":"string","format":"uri","description":"The URI of the resource.","readOnly":true},"version":{"type":"string","description":"The version of the resource. Matches the ETag HTTP response header. Not included with \"Schema\" and \"ResourceType\" resources.","readOnly":true}},"description":"Defines the SCIM metadata."},"ScimConfigResourceTypesListResponse":{"type":"object","properties":{"totalResults":{"type":"integer","format":"int64","description":"The total number of results.","readOnly":true},"startIndex":{"type":"integer","format":"int64","description":"The 1-based index of the first result returned by this request. Add this to \"itemsPerPage\" when requesting the next page of results.","readOnly":true},"itemsPerPage":{"type":"integer","format":"int64","description":"The number of resources returned per page.","readOnly":true},"Resources":{"type":"array","description":"The list of requested resources.","readOnly":true,"items":{"$ref":"#/definitions/ScimConfigResourceType"}},"schemas":{"type":"array","description":"The list of supported schemas.","items":{"type":"string"}}},"description":"Defines a response for a list of SCIM resource types."},"UserEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/User"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CampaignProgress":{"type":"object","required":["campaign","contactList"],"properties":{"campaign":{"description":"Identifier of the campaign","$ref":"#/definitions/DomainEntityRef"},"contactList":{"description":"Identifier of the contact list","$ref":"#/definitions/DomainEntityRef"},"numberOfContactsCalled":{"type":"integer","format":"int64","description":"Number of contacts called during the campaign","readOnly":true},"numberOfContactsMessaged":{"type":"integer","format":"int64","description":"Number of contacts messaged during the campaign","readOnly":true},"totalNumberOfContacts":{"type":"integer","format":"int64","description":"Total number of contacts in the campaign","readOnly":true},"percentage":{"type":"integer","format":"int64","description":"Percentage of contacts processed during the campaign","readOnly":true}}},"MessagingCampaign":{"type":"object","required":["contactList","messagesPerMinute"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"division":{"description":"The division this entity belongs to.","$ref":"#/definitions/DomainEntityRef"},"campaignStatus":{"type":"string","description":"The current status of the messaging campaign. A messaging campaign may be turned 'on' or 'off'.","enum":["on","stopping","off","complete","invalid"],"x-genesys-enum-members":[{"name":"on"},{"name":"stopping"},{"name":"off"},{"name":"complete"},{"name":"invalid"}]},"callableTimeSet":{"description":"The callable time set for this messaging campaign.","$ref":"#/definitions/DomainEntityRef"},"contactList":{"description":"The contact list that this messaging campaign will send messages for.","$ref":"#/definitions/DomainEntityRef"},"dncLists":{"type":"array","description":"The dnc lists to check before sending a message for this messaging campaign.","items":{"$ref":"#/definitions/DomainEntityRef"}},"alwaysRunning":{"type":"boolean","description":"Whether this messaging campaign is always running"},"contactSorts":{"type":"array","description":"The order in which to sort contacts for dialing, based on up to four columns.","items":{"$ref":"#/definitions/ContactSort"}},"messagesPerMinute":{"type":"integer","format":"int32","description":"How many messages this messaging campaign will send per minute."},"errors":{"type":"array","description":"A list of current error conditions associated with this messaging campaign.","items":{"$ref":"#/definitions/RestErrorDetail"}},"smsConfig":{"description":"Configuration for this messaging campaign to send SMS messages.","$ref":"#/definitions/SmsConfig"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SmsConfig":{"type":"object","required":["messageColumn","phoneColumn","senderSmsPhoneNumber"],"properties":{"messageColumn":{"type":"string","description":"The Contact List column specifying the message to send to the contact."},"phoneColumn":{"type":"string","description":"The Contact List column specifying the phone number to send a message to."},"senderSmsPhoneNumber":{"description":"A reference to the SMS Phone Number that will be used as the sender of a message.","$ref":"#/definitions/SmsPhoneNumberRef"}}},"SmsPhoneNumberRef":{"type":"object","required":["phoneNumber"],"properties":{"phoneNumber":{"type":"string","description":"A phone number provisioned for SMS communications in E.164 format. E.g. +13175555555 or +34234234234"},"selfUri":{"type":"string","format":"uri"}}},"AddressableLicenseDefinition":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LicenseDefinition":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"description":{"type":"string"},"permissions":{"$ref":"#/definitions/Permissions"},"prerequisites":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/AddressableLicenseDefinition"}},"comprises":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/LicenseDefinition"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LicenseUser":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"licenses":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/LicenseDefinition"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Permissions":{"type":"object","required":["ids"],"properties":{"ids":{"type":"array","description":"List of permission ids.","items":{"type":"string"}}}},"ContactListDivisionView":{"type":"object","required":["columnNames","phoneColumns"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"columnNames":{"type":"array","description":"The names of the contact data columns.","items":{"type":"string"}},"phoneColumns":{"type":"array","description":"Indicates which columns are phone numbers.","items":{"$ref":"#/definitions/ContactPhoneNumberColumn"}},"importStatus":{"description":"The status of the import process.","readOnly":true,"$ref":"#/definitions/ImportStatus"},"size":{"type":"integer","format":"int64","description":"The number of contacts in the ContactList.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ContactPhoneNumberColumn":{"type":"object","required":["columnName","type"],"properties":{"columnName":{"type":"string","description":"The name of the phone column."},"type":{"type":"string","description":"Indicates the type of the phone column. For example, 'cell' or 'home'."},"callableTimeColumn":{"type":"string","description":"A column that indicates the timezone to use for a given contact when checking callable times. Not allowed if 'automaticTimeZoneMapping' is set to true."}}},"ImportStatus":{"type":"object","required":["completedRecords","percentComplete","state","totalRecords"],"properties":{"state":{"type":"string","description":"current status of the import","readOnly":true,"enum":["IN_PROGRESS","FAILED"],"x-genesys-enum-members":[{"name":"IN_PROGRESS"},{"name":"FAILED"}]},"totalRecords":{"type":"integer","format":"int64","description":"total number of records to be imported","readOnly":true},"completedRecords":{"type":"integer","format":"int64","description":"number of records finished importing","readOnly":true},"percentComplete":{"type":"integer","format":"int32","description":"percentage of records finished importing","readOnly":true},"failureReason":{"type":"string","description":"if the import has failed, the reason for the failure","readOnly":true}}},"AggregateMetricData":{"type":"object","properties":{"metric":{"type":"string"},"qualifier":{"type":"string"},"stats":{"$ref":"#/definitions/StatisticalSummary"}}},"AggregateViewData":{"type":"object","properties":{"name":{"type":"string"},"stats":{"$ref":"#/definitions/StatisticalSummary"}}},"StatisticalResponse":{"type":"object","properties":{"interval":{"type":"string"},"metrics":{"type":"array","items":{"$ref":"#/definitions/AggregateMetricData"}},"views":{"type":"array","items":{"$ref":"#/definitions/AggregateViewData"}}}},"StatisticalSummary":{"type":"object","properties":{"max":{"type":"number"},"min":{"type":"number"},"count":{"type":"integer","format":"int64"},"countNegative":{"type":"integer","format":"int64"},"countPositive":{"type":"integer","format":"int64"},"sum":{"type":"number"},"current":{"type":"number"},"ratio":{"type":"number"},"numerator":{"type":"number"},"denominator":{"type":"number"},"target":{"type":"number"}}},"AggregationRange":{"type":"object","properties":{"gte":{"type":"number","description":"Greater than or equal to"},"lt":{"type":"number","description":"Less than"}}},"QueryDivision":{"type":"object","properties":{}},"DataSchema":{"type":"object","required":["jsonSchema","version"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"version":{"type":"integer","format":"int32","description":"The schema's version, a positive integer. Required for updates."},"appliesTo":{"type":"array","description":"One of \"CONTACT\" or \"EXTERNAL_ORGANIZATION\". Indicates the built-in entity type to which this schema applies.","readOnly":true,"items":{"type":"string","enum":["CONTACT","EXTERNAL_ORGANIZATION"],"x-genesys-enum-members":[{"name":"CONTACT"},{"name":"EXTERNAL_ORGANIZATION"}]}},"enabled":{"type":"boolean","description":"The schema's enabled/disabled status. A disabled schema cannot be assigned to any other entities, but the data on those entities from the schema still exists."},"createdBy":{"description":"The URI of the user that created this schema.","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"dateCreated":{"type":"string","format":"date-time","description":"The date and time this schema was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"jsonSchema":{"example":"{\n \"appliesTo\": [\n \"CONTACT\"\n ],\n \"jsonSchema\": {\n \"title\": \"Example schema\",\n \"description\": \"Uses all of the core types for illustrative purposes\",\n \"properties\": {\n \"field1_text\": {\n \"title\": \"Field 1\",\n \"description\": \"field1\",\n \"allOf\": [ { \"$ref\": \"#/definitions/text\" } ],\n \"minLength\": 0,\n \"maxLength\": 39\n },\n \"field2_longtext\": {\n \"title\": \"Field 2\",\n \"description\": \"field2\",\n \"allOf\": [ { \"$ref\": \"#/definitions/longtext\" } ],\n \"minLength\": 0,\n \"maxLength\": 1000\n },\n \"field3_enum\": {\n \"title\": \"Field 3\",\n \"description\": \"Field 3\",\n \"allOf\": [ { \"$ref\": \"#/definitions/enum\" } ],\n \"enum\": [\n \"enum1\",\n \"enum2\"\n ]\n },\n \"field4_identifier\": {\n \"title\": \"field4\",\n \"description\": \"Field 4\",\n \"allOf\": [ { \"$ref\": \"#/definitions/identifier\" } ],\n \"minLength\": 0,\n \"maxLength\": 37\n },\n \"field5_integer\": {\n \"title\": \"field5\",\n \"description\": \"Field 5\",\n \"allOf\": [ { \"$ref\": \"#/definitions/integer\" } ],\n \"minimum\": 1,\n \"maximum\": 24\n },\n \"field6_number\": {\n \"title\": \"field6\",\n \"description\": \"Field 6\",\n \"allOf\": [ { \"$ref\": \"#/definitions/number\" } ],\n \"minimum\": 2.7,\n \"maximum\": 31.3\n },\n \"field7_date\": {\n \"title\": \"field7\",\n \"description\": \"Field 7\",\n \"allOf\": [ { \"$ref\": \"#/definitions/date\"}]\n },\n \"field8_datetime\": {\n \"title\": \"field8\",\n \"description\": \"Field 8\",\n \"allOf\": [ { \"$ref\": \"#/definitions/datetime\"}]\n },\n \"field9_checkbox\": {\n \"title\": \"field9\",\n \"description\": \"Field 9\",\n \"allOf\": [ { \"$ref\": \"#/definitions/checkbox\"}]\n },\n \"field10_tag\": {\n \"title\": \"field10\",\n \"description\": \"Field 10\",\n \"allOf\": [ { \"$ref\": \"#/definitions/tag\" } ],\n \"items\": {\n \"minLength\": 1,\n \"maxLength\": 20\n },\n \"minItems\": 0,\n \"maxItems\": 10,\n \"uniqueItems\": true\n }\n },\n \"$schema\": \"http://json-schema.org/draft-04/schema#\"\n }\n}","description":"A JSON schema defining the extension to the built-in entity type.","$ref":"#/definitions/JsonSchemaDocument"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"JsonSchemaDocument":{"type":"object","properties":{"id":{"type":"string"},"$schema":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"type":{"type":"string"},"required":{"type":"array","items":{"type":"string"}},"properties":{"type":"object","additionalProperties":{"type":"object"}},"additionalProperties":{"type":"object"}},"description":"A JSON Schema document."},"QueueEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Queue"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CreateQueueRequest":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The queue name"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/WritableDivision"},"description":{"type":"string","description":"The queue description."},"dateCreated":{"type":"string","format":"date-time","description":"The date the queue was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the queue. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the queue."},"createdBy":{"type":"string","description":"The ID of the user that created the queue."},"memberCount":{"type":"integer","format":"int32","description":"The number of users in the queue.","readOnly":true},"mediaSettings":{"type":"object","description":"The media settings for the queue. Valid key values: CALL, CALLBACK, CHAT, EMAIL, MESSAGE, SOCIAL_EXPRESSION, VIDEO_COMM","additionalProperties":{"$ref":"#/definitions/MediaSetting"}},"routingRules":{"type":"array","description":"The routing rules for the queue, used for routing to known or preferred agents.","items":{"$ref":"#/definitions/RoutingRule"}},"bullseye":{"description":"The bulls-eye settings for the queue.","$ref":"#/definitions/Bullseye"},"acwSettings":{"description":"The ACW settings for the queue.","$ref":"#/definitions/AcwSettings"},"skillEvaluationMethod":{"type":"string","description":"The skill evaluation method to use when routing conversations.","enum":["NONE","BEST","ALL"],"x-genesys-enum-members":[{"name":"NONE"},{"name":"BEST"},{"name":"ALL"}]},"queueFlow":{"description":"The in-queue flow to use for conversations waiting in queue.","$ref":"#/definitions/DomainEntityRef"},"whisperPrompt":{"description":"The prompt used for whisper on the queue, if configured.","$ref":"#/definitions/DomainEntityRef"},"autoAnswerOnly":{"type":"boolean","description":"Specifies whether the configured whisper should play for all ACD calls, or only for those which are auto-answered."},"enableTranscription":{"type":"boolean","description":"Indicates whether voice transcription is enabled for this queue."},"enableManualAssignment":{"type":"boolean","description":"Indicates whether manual assignment is enabled for this queue."},"callingPartyName":{"type":"string","description":"The name to use for caller identification for outbound calls from this queue."},"callingPartyNumber":{"type":"string","description":"The phone number to use for caller identification for outbound calls from this queue."},"defaultScripts":{"type":"object","description":"The default script Ids for the communication types.","additionalProperties":{"$ref":"#/definitions/Script"}},"outboundMessagingAddresses":{"description":"The messaging addresses for the queue.","$ref":"#/definitions/QueueMessagingAddresses"},"outboundEmailAddress":{"$ref":"#/definitions/QueueEmailAddress"},"sourceQueueId":{"type":"string","description":"The id of an existing queue to copy the settings from when creating a new queue."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WritableDivision":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Flow":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The flow identifier"},"name":{"type":"string","description":"The flow name"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/WritableDivision"},"description":{"type":"string"},"type":{"type":"string","enum":["BOT","COMMONMODULE","INBOUNDCALL","INBOUNDCHAT","INBOUNDEMAIL","INBOUNDSHORTMESSAGE","INQUEUECALL","OUTBOUNDCALL","SECURECALL","SPEECH","SURVEYINVITE","WORKFLOW"],"x-genesys-enum-members":[{"name":"BOT"},{"name":"COMMONMODULE"},{"name":"INBOUNDCALL"},{"name":"INBOUNDCHAT"},{"name":"INBOUNDEMAIL"},{"name":"INBOUNDSHORTMESSAGE"},{"name":"INQUEUECALL"},{"name":"OUTBOUNDCALL"},{"name":"SECURECALL"},{"name":"SPEECH"},{"name":"SURVEYINVITE"},{"name":"WORKFLOW"}]},"lockedUser":{"description":"User that has the flow locked.","$ref":"#/definitions/User"},"lockedClient":{"description":"OAuth client that has the flow locked.","$ref":"#/definitions/DomainEntityRef"},"active":{"type":"boolean"},"system":{"type":"boolean"},"deleted":{"type":"boolean"},"publishedVersion":{"$ref":"#/definitions/FlowVersion"},"savedVersion":{"$ref":"#/definitions/FlowVersion"},"inputSchema":{"type":"object","description":"json schema describing the inputs for the flow"},"outputSchema":{"type":"object","description":"json schema describing the outputs for the flow"},"checkedInVersion":{"$ref":"#/definitions/FlowVersion"},"debugVersion":{"$ref":"#/definitions/FlowVersion"},"publishedBy":{"$ref":"#/definitions/User"},"currentOperation":{"$ref":"#/definitions/Operation"},"nluInfo":{"description":"Information about the natural language understanding configuration for the published version of the flow","readOnly":true,"$ref":"#/definitions/NluInfo"},"supportedLanguages":{"type":"array","description":"List of supported languages for the published version of the flow.","readOnly":true,"items":{"$ref":"#/definitions/SupportedLanguage"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FlowVersion":{"type":"object","properties":{"id":{"type":"string","description":"The flow version identifier"},"name":{"type":"string"},"commitVersion":{"type":"string"},"configurationVersion":{"type":"string"},"type":{"type":"string","enum":["PUBLISH","CHECKIN","SAVE"],"x-genesys-enum-members":[{"name":"PUBLISH"},{"name":"CHECKIN"},{"name":"SAVE"}]},"secure":{"type":"boolean"},"debug":{"type":"boolean"},"createdBy":{"$ref":"#/definitions/User"},"createdByClient":{"$ref":"#/definitions/DomainEntityRef"},"configurationUri":{"type":"string"},"dateCreated":{"type":"integer","format":"int64"},"generationId":{"type":"string"},"publishResultUri":{"type":"string","format":"uri"},"inputSchema":{"$ref":"#/definitions/JsonSchemaDocument"},"outputSchema":{"$ref":"#/definitions/JsonSchemaDocument"},"nluInfo":{"description":"Information about the natural language understanding configuration for the flow version","readOnly":true,"$ref":"#/definitions/NluInfo"},"supportedLanguages":{"type":"array","description":"List of supported languages for this version of the flow","readOnly":true,"items":{"$ref":"#/definitions/SupportedLanguage"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Intent":{"type":"object","properties":{"name":{"type":"string"}}},"NluInfo":{"type":"object","properties":{"intents":{"type":"array","items":{"$ref":"#/definitions/Intent"}}}},"Operation":{"type":"object","properties":{"id":{"type":"string"},"complete":{"type":"boolean"},"user":{"$ref":"#/definitions/User"},"client":{"$ref":"#/definitions/DomainEntityRef"},"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorDetails":{"type":"array","items":{"$ref":"#/definitions/Detail"}},"errorMessageParams":{"type":"object","additionalProperties":{"type":"string"}},"actionName":{"type":"string","description":"Action name","enum":["CREATE","CHECKIN","DEBUG","DELETE","HISTORY","PUBLISH","STATE_CHANGE","UPDATE","VALIDATE"]},"actionStatus":{"type":"string","description":"Action status","enum":["LOCKED","UNLOCKED","STARTED","PENDING_GENERATION","PENDING_BACKEND_NOTIFICATION","SUCCESS","FAILURE"]}}},"SupportedLanguage":{"type":"object","properties":{"language":{"type":"string","description":"Architect supported language tag, e.g. en-us, es-us","readOnly":true},"isDefault":{"type":"boolean","description":"Whether or not this language is the default language","readOnly":true}}},"DialogflowIntent":{"type":"object","required":["name","parameters"],"properties":{"name":{"type":"string","description":"The intent name"},"parameters":{"type":"object","description":"An object mapping parameter names to Parameter objects","additionalProperties":{"$ref":"#/definitions/DialogflowParameter"}}}},"DialogflowParameter":{"type":"object","required":["name","type"],"properties":{"name":{"type":"string","description":"The parameter name"},"type":{"type":"string","description":"The parameter type"}}},"DialogflowProject":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}},"IntentDefinition":{"type":"object","required":["entityTypeBindings","name","utterances"],"properties":{"name":{"type":"string","description":"The name of the intent."},"entityTypeBindings":{"type":"array","description":"The bindings for the named entity types used in this intent.","items":{"$ref":"#/definitions/NamedEntityTypeBinding"}},"utterances":{"type":"array","description":"The utterances that act as training phrases for the intent.","items":{"$ref":"#/definitions/NluUtterance"}}}},"NamedEntityAnnotation":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The name of the annotated named entity."}}},"NamedEntityTypeBinding":{"type":"object","required":["entityName","entityType"],"properties":{"entityType":{"type":"string","description":"The named entity type of the binding. It can be a built-in one such as builtin:number or a custom entity type such as BeverageType."},"entityName":{"type":"string","description":"The name that this named entity type is bound to."}}},"NamedEntityTypeDefinition":{"type":"object","required":["mechanism","name"],"properties":{"name":{"type":"string","description":"The name of the entity type."},"description":{"type":"string","description":"Description of the of the named entity type."},"mechanism":{"description":"The mechanism enabling detection of the named entity type.","$ref":"#/definitions/NamedEntityTypeMechanism"}}},"NamedEntityTypeItem":{"type":"object","required":["value"],"properties":{"value":{"type":"string","description":"A value for an named entity type definition."},"synonyms":{"type":"array","description":"Synonyms for the given named entity value.","items":{"type":"string"}}}},"NamedEntityTypeMechanism":{"type":"object","required":["items","type"],"properties":{"items":{"type":"array","description":"The items that define the named entity type.","items":{"$ref":"#/definitions/NamedEntityTypeItem"}},"restricted":{"type":"boolean","description":"Whether the named entity type is restricted to the items provided. Default: false"},"type":{"type":"string","description":"The type of the mechanism.","enum":["List","Regex","Unknown"],"x-genesys-enum-members":[{"name":"List"},{"name":"Regex"},{"name":"Unknown"}]}}},"NluUtterance":{"type":"object","required":["segments"],"properties":{"segments":{"type":"array","description":"The list of segments that that constitute this utterance for the given intent.","items":{"$ref":"#/definitions/NluUtteranceSegment"}}}},"NluUtteranceSegment":{"type":"object","required":["text"],"properties":{"text":{"type":"string","description":"The text of the segment."},"entity":{"description":"The entity annotation of the segment.","$ref":"#/definitions/NamedEntityAnnotation"}}},"LineIntegration":{"type":"object","required":["channelId","id","name","version","webhookUri"],"properties":{"id":{"type":"string","description":"A unique Integration Id","readOnly":true},"name":{"type":"string","description":"The name of the LINE Integration"},"channelId":{"type":"string","description":"The Channel Id from LINE messenger"},"webhookUri":{"type":"string","format":"uri","description":"The Webhook URI to be updated in LINE platform"},"status":{"type":"string","description":"The status of the LINE Integration"},"recipient":{"description":"The recipient associated to the Line Integration. This recipient is used to associate a flow to an integration","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"dateCreated":{"type":"string","format":"date-time","description":"Date this Integration was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date this Integration was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"description":"User reference that created this Integration","$ref":"#/definitions/DomainEntityRef"},"modifiedBy":{"description":"User reference that last modified this Integration","$ref":"#/definitions/DomainEntityRef"},"version":{"type":"integer","format":"int32","description":"Version number required for updates."},"createStatus":{"type":"string","description":"Status of asynchronous create operation","readOnly":true,"enum":["Initiated","Completed","Error"],"x-genesys-enum-members":[{"name":"Initiated","description":"The integration create request has started"},{"name":"Completed","description":"The integration create request has finished successfully"},{"name":"Error","description":"The integration create request has finished in error."}]},"createError":{"description":"Error information returned, if createStatus is set to Error","readOnly":true,"$ref":"#/definitions/ErrorBody"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LineIntegrationRequest":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the LINE Integration"},"channelId":{"type":"string","description":"The Channel Id from LINE messenger.\nNew Official LINE account: To create a new official account, LINE requires a Webhook URL. It can be created without specifying Channel Id & Channel Secret. Once the Official account is created by LINE, use the update LINE Integration API to update Channel Id and Channel Secret. \nAll other accounts: Channel Id is mandatory. (NOTE: ChannelId can only be updated if the integration is set to inactive)"},"channelSecret":{"type":"string","description":"The Channel Secret from LINE messenger. New Official LINE account: To create a new official account, LINE requires a Webhook URL. It can be created without specifying Channel Id & Channel Secret. Once the Official account is created by LINE, use the update LINE Integration API to update Channel Id and Channel Secret. \nAll other accounts: Channel Secret is mandatory. (NOTE: ChannelSecret can only be updated if the integration is set to inactive)"},"switcherSecret":{"type":"string","description":"The Switcher Secret from LINE messenger. Some line official accounts are switcher functionality enabled. If the LINE account used for this integration is switcher enabled, then switcher secret is a required field. This secret can be found in your create documentation provided by LINE"},"serviceCode":{"type":"string","description":"The Service Code from LINE messenger. Only applicable to LINE Enterprise accounts. This service code can be found in your create documentation provided by LINE"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SystemPrompt":{"type":"object","properties":{"id":{"type":"string","description":"The system prompt identifier"},"name":{"type":"string"},"description":{"type":"string"},"resources":{"type":"array","items":{"$ref":"#/definitions/SystemPromptAsset"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SystemPromptAsset":{"type":"object","required":["language"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"promptId":{"type":"string"},"language":{"type":"string","description":"The asset resource language"},"durationSeconds":{"type":"number","format":"double"},"mediaUri":{"type":"string"},"ttsString":{"type":"string"},"text":{"type":"string"},"uploadUri":{"type":"string"},"uploadStatus":{"type":"string","enum":["created","uploaded","transcoded","transcodeFailed"],"x-genesys-enum-members":[{"name":"created"},{"name":"uploaded"},{"name":"transcoded"},{"name":"transcodeFailed"}]},"hasDefault":{"type":"boolean"},"languageDefault":{"type":"boolean"},"tags":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SystemPromptEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SystemPrompt"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EventEntity":{"type":"object","properties":{"entityType":{"type":"string","description":"Type of entity the event pertains to. e.g. integration"},"id":{"type":"string","description":"ID of the entity the event pertains to."}}},"IntegrationEvent":{"type":"object","properties":{"id":{"type":"string","description":"Unique ID for this event","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"correlationId":{"type":"string","description":"Correlation ID for the event","readOnly":true},"timestamp":{"type":"string","format":"date-time","description":"Time the event occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"level":{"type":"string","description":"Indicates the severity of the event.","readOnly":true,"enum":["INFO","WARN","ERROR","CRITICAL"],"x-genesys-enum-members":[{"name":"INFO"},{"name":"WARN"},{"name":"ERROR"},{"name":"CRITICAL"}]},"eventCode":{"type":"string","description":"A classification for the event. Suitable for programmatic searching, sorting, or filtering","readOnly":true},"message":{"description":"Message indicating what happened","readOnly":true,"$ref":"#/definitions/MessageInfo"},"entities":{"type":"array","description":"Collection of entities affected by or pertaining to the event (e.g. a list of Integrations or Bridge connectors)","readOnly":true,"items":{"$ref":"#/definitions/EventEntity"}},"contextAttributes":{"type":"object","description":"Map of context attributes specific to this event.","readOnly":true,"additionalProperties":{"type":"string"}},"detailMessage":{"description":"Message with additional details about the event. (e.g. an exception cause.)","$ref":"#/definitions/MessageInfo"},"user":{"description":"User that took an action that resulted in the event.","readOnly":true,"$ref":"#/definitions/User"}},"description":"Describes an event that has happened related to an integration"},"IntegrationEventEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/IntegrationEvent"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"PlanningGroup":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"serviceGoalTemplate":{"description":"The ID of the service goal template associated with this planning group","$ref":"#/definitions/ServiceGoalTemplateReference"},"routePaths":{"type":"array","description":"Set of route paths associated with the planning group","uniqueItems":true,"items":{"$ref":"#/definitions/RoutePathResponse"}},"metadata":{"description":"Version metadata for the planning group","$ref":"#/definitions/WfmVersionedEntityMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Planning Group"},"RoutePathResponse":{"type":"object","properties":{"queue":{"description":"The ID of the queue associated with the route path","$ref":"#/definitions/QueueReference"},"mediaType":{"type":"string","description":"The media type of the given queue associated with the route path","enum":["Voice","Chat","Email","Callback","Message"],"x-genesys-enum-members":[{"name":"Voice"},{"name":"Chat"},{"name":"Email"},{"name":"Callback"},{"name":"Message"}]},"language":{"description":"The ID of the language associated with the route path","$ref":"#/definitions/LanguageReference"},"skills":{"type":"array","description":"The set of skills associated with the route path","uniqueItems":true,"items":{"$ref":"#/definitions/RoutingSkillReference"}}},"description":"Route path configuration"},"ServiceGoalTemplateReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"RoutePathRequest":{"type":"object","required":["mediaType","queueId"],"properties":{"queueId":{"type":"string","example":"f27450c9-c1a0-451a-804c-2579b268b273","description":"The ID of the queue to associate with the route path"},"mediaType":{"type":"string","example":"Email","description":"The media type of the given queue to associate with the route path","enum":["Voice","Chat","Email","Callback","Message"],"x-genesys-enum-members":[{"name":"Voice"},{"name":"Chat"},{"name":"Email"},{"name":"Callback"},{"name":"Message"}]},"languageId":{"type":"string","example":"e3d65f6a-c0d2-41da-8152-82d3f075d77c","description":"The ID of the language to associate with the route path"},"skillIds":{"type":"array","example":"[\"33d29376-4267-4968-8042-dcabdf2c1d98\"]","description":"The set of skill IDs to associate with the route path","uniqueItems":true,"items":{"type":"string"}},"sourcePlanningGroup":{"description":"The planning group from which to copy route paths","$ref":"#/definitions/SourcePlanningGroupRequest"}},"description":"Route path configuration"},"SetWrapperRoutePathRequest":{"type":"object","properties":{"values":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/RoutePathRequest"}}}},"SourcePlanningGroupRequest":{"type":"object","required":["id","metadata"],"properties":{"id":{"type":"string","description":"The ID of the planning group"},"metadata":{"description":"Version metadata for the planning group","$ref":"#/definitions/WfmVersionedEntityMetadata"}},"description":"Source planning group"},"UpdatePlanningGroupRequest":{"type":"object","required":["metadata"],"properties":{"name":{"type":"string","description":"The name of the planning group"},"routePaths":{"description":"Set of route paths to associate with the planning group","$ref":"#/definitions/SetWrapperRoutePathRequest"},"serviceGoalTemplateId":{"type":"string","description":"The ID of the service goal template to associate with this planning group"},"metadata":{"description":"Version metadata for the planning group","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"PlanningGroupList":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/PlanningGroup"}}},"description":"List of planning groups"},"CreatePlanningGroupRequest":{"type":"object","required":["name","routePaths","serviceGoalTemplateId"],"properties":{"name":{"type":"string","description":"The name of the planning group"},"routePaths":{"type":"array","description":"Set of route paths to associate with the planning group","uniqueItems":true,"items":{"$ref":"#/definitions/RoutePathRequest"}},"serviceGoalTemplateId":{"type":"string","description":"The ID of the service goal template to associate with this planning group"}}},"WfmUserEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/User"}}}},"Manager":{"type":"object","properties":{"value":{"type":"string","description":"The ID of the manager."},"$ref":{"type":"string","format":"uri","description":"The reference URI of the manager's user record.","readOnly":true}},"description":"Defines a SCIM manager."},"ScimEmail":{"type":"object","properties":{"value":{"type":"string","description":"The email address. Is immutable if \"type\" is set to \"other\"."},"type":{"type":"string","description":"The type of email address. \"value\" is immutable if \"type\" is set to \"other\".","enum":["work","other"],"x-genesys-enum-members":[{"name":"work"},{"name":"other"}]},"primary":{"type":"boolean","description":"Indicates whether the email address is the primary email address."}},"description":"Defines a SCIM email address."},"ScimGenesysUserExternalId":{"type":"object","properties":{"authority":{"type":"string","description":"Authority, or scope, of \"externalId\". Allows multiple external identifiers to be defined. Represents the source of the external identifier."},"value":{"type":"string","description":"Identifier of the user in an external system."}},"description":"External Identifiers of user. The external identifier must be unique within the organization and the 'authority'"},"ScimPhoneNumber":{"type":"object","properties":{"value":{"type":"string","description":"The phone number in E.164 or tel URI format, for example, tel:+nnnnnnnn; ext=xxxxx."},"type":{"type":"string","description":"The type of phone number.","enum":["work","work2","work3","work4","home","mobile","other","microsoftteams","zoomphone","ringcentral"],"x-genesys-enum-members":[{"name":"work"},{"name":"work2"},{"name":"work3"},{"name":"work4"},{"name":"home"},{"name":"mobile"},{"name":"other"},{"name":"microsoftteams"},{"name":"zoomphone"},{"name":"ringcentral"}]},"primary":{"type":"boolean","description":"Indicates whether the phone number is the primary phone number."}},"description":"Defines a SCIM phone number."},"ScimUserExtensions":{"type":"object","properties":{"routingSkills":{"type":"array","description":"The list of routing skills assigned to a user. Maximum 50 skills.","items":{"$ref":"#/definitions/ScimUserRoutingSkill"}},"routingLanguages":{"type":"array","description":"The list of routing languages assigned to a user. Maximum 50 languages.","items":{"$ref":"#/definitions/ScimUserRoutingLanguage"}},"externalIds":{"type":"array","description":"The list of external identifiers assigned to user. Always includes an immutable SCIM authority prefixed with \"x-pc:scimv2:v1\".","items":{"$ref":"#/definitions/ScimGenesysUserExternalId"}}},"description":"Genesys Cloud user extensions to SCIM RFC."},"ScimUserRole":{"type":"object","properties":{"value":{"type":"string","description":"The role of the Genesys Cloud user."}},"description":"Defines a user role."},"ScimUserRoutingLanguage":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The case-sensitive name of a routing language configured in Genesys Cloud."},"proficiency":{"type":"number","format":"double","description":"A rating from 0.0 to 5.0 that indicates how fluent an agent is in a particular language. ACD interactions are routed to agents with higher proficiency ratings."}},"description":"The routing language assigned to a user."},"ScimUserRoutingSkill":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The case-sensitive name of a routing skill configured in Genesys Cloud."},"proficiency":{"type":"number","format":"double","description":"A rating from 0.0 to 5.0 that indicates how adept an agent is at a particular skill. When \"Best available skills\" is enabled for a queue in Genesys Cloud, ACD interactions in that queue are routed to agents with higher proficiency ratings."}},"description":"The routing skill assigned to a user."},"ScimV2EnterpriseUser":{"type":"object","properties":{"division":{"type":"string","description":"The division that the user belongs to."},"department":{"type":"string","description":"The department that the user belongs to."},"manager":{"description":"The user's manager.","$ref":"#/definitions/Manager"},"employeeNumber":{"type":"string","description":"The user's employee number."}},"description":"Defines a SCIM enterprise user."},"ScimV2GroupReference":{"type":"object","properties":{"type":{"type":"string","description":"The type of SCIM resource.","readOnly":true,"enum":["User","Group","ServiceProviderConfig","ResourceType","Schema"],"x-genesys-enum-members":[{"name":"User"},{"name":"Group"},{"name":"ServiceProviderConfig"},{"name":"ResourceType"},{"name":"Schema"}]},"value":{"type":"string","description":"The ID of the group member. Can be \"userId\" or \"groupId\"."},"$ref":{"type":"string","format":"uri","description":"The reference URI of the SCIM resource.","readOnly":true}},"description":"Defines a reference to SCIM groups."},"ScimV2User":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the SCIM resource. Set by the service provider. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readOnly\". \"returned\" is set to \"always\".","readOnly":true},"schemas":{"type":"array","description":"The list of supported schemas.","readOnly":true,"items":{"type":"string"}},"active":{"type":"boolean","description":"Indicates whether the user's administrative status is active."},"userName":{"type":"string","description":"The user's Genesys Cloud email address. Must be unique."},"displayName":{"type":"string","description":"The display name of the user."},"password":{"type":"string","description":"The new password for the Genesys Cloud user. Does not return an existing password. When creating a user, if a password is not supplied, then a password will be randomly generated that is 40 characters in length and contains five characters from each of the password policy groups."},"title":{"type":"string","description":"The user's title."},"phoneNumbers":{"type":"array","description":"The list of the user's phone numbers.","items":{"$ref":"#/definitions/ScimPhoneNumber"}},"emails":{"type":"array","description":"The list of the user's email addresses.","items":{"$ref":"#/definitions/ScimEmail"}},"externalId":{"type":"string","description":"The external ID of the user. Set by the provisioning client. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readWrite\"."},"groups":{"type":"array","description":"The list of groups that the user is a member of.","items":{"$ref":"#/definitions/ScimV2GroupReference"}},"roles":{"type":"array","description":"The list of roles assigned to the user.","items":{"$ref":"#/definitions/ScimUserRole"}},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"description":"The URI of the schema for the enterprise user.","$ref":"#/definitions/ScimV2EnterpriseUser"},"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User":{"description":"The URI of the schema for the Genesys Cloud user.","$ref":"#/definitions/ScimUserExtensions"},"meta":{"description":"The metadata of the SCIM resource.","readOnly":true,"$ref":"#/definitions/ScimMetadata"}},"description":"Defines a SCIM user."},"ScimError":{"type":"object","properties":{"status":{"type":"string","description":"The HTTP status code returned for the SCIM error.","readOnly":true},"scimType":{"type":"string","description":"The type of SCIM error when httpStatus is a \"400\" error.","readOnly":true,"enum":["invalidFilter","tooMany","uniqueness","mutability","invalidSyntax","invalidPath","noTarget","invalidValue","invalidVers","sensitive"],"x-genesys-enum-members":[{"name":"invalidFilter"},{"name":"tooMany"},{"name":"uniqueness"},{"name":"mutability"},{"name":"invalidSyntax"},{"name":"invalidPath"},{"name":"noTarget"},{"name":"invalidValue"},{"name":"invalidVers"},{"name":"sensitive"}]},"detail":{"type":"string","description":"The detailed description of the SCIM error.","readOnly":true},"schemas":{"type":"array","description":"The list of schemas for the SCIM error.","readOnly":true,"items":{"type":"string"}}},"description":"Defines a SCIM error."},"ScimV2CreateUser":{"type":"object","required":["displayName","userName"],"properties":{"schemas":{"type":"array","description":"The list of supported schemas.","readOnly":true,"items":{"type":"string"}},"active":{"type":"boolean","description":"Indicates whether the user's administrative status is active."},"userName":{"type":"string","description":"The user's Genesys Cloud email address. Must be unique."},"displayName":{"type":"string","description":"The display name of the user."},"password":{"type":"string","description":"The new password for the Genesys Cloud user. Does not return an existing password. When creating a user, if a password is not supplied, then a password will be randomly generated that is 40 characters in length and contains five characters from each of the password policy groups."},"title":{"type":"string","description":"The user's title."},"phoneNumbers":{"type":"array","description":"The list of the user's phone numbers.","items":{"$ref":"#/definitions/ScimPhoneNumber"}},"emails":{"type":"array","description":"The list of the user's email addresses.","items":{"$ref":"#/definitions/ScimEmail"}},"externalId":{"type":"string","description":"The external ID of the user. Set by the provisioning client. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readWrite\"."},"groups":{"type":"array","description":"The list of groups that the user is a member of.","items":{"$ref":"#/definitions/ScimV2GroupReference"}},"roles":{"type":"array","description":"The list of roles assigned to the user.","items":{"$ref":"#/definitions/ScimUserRole"}},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"description":"The URI of the schema for the enterprise user.","$ref":"#/definitions/ScimV2EnterpriseUser"},"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User":{"description":"The URI of the schema for the Genesys Cloud user.","$ref":"#/definitions/ScimUserExtensions"}},"description":"Defines the creation of a SCIM user."},"JsonNode":{"type":"object","properties":{"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"],"x-genesys-enum-members":[{"name":"ARRAY"},{"name":"BINARY"},{"name":"BOOLEAN"},{"name":"MISSING"},{"name":"NULL"},{"name":"NUMBER"},{"name":"OBJECT"},{"name":"POJO"},{"name":"STRING"}]},"float":{"type":"boolean"},"number":{"type":"boolean"},"boolean":{"type":"boolean"},"object":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"integralNumber":{"type":"boolean"},"valueNode":{"type":"boolean"},"missingNode":{"type":"boolean"},"containerNode":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean"},"binary":{"type":"boolean"},"pojo":{"type":"boolean"},"array":{"type":"boolean"},"null":{"type":"boolean"}}},"ScimV2PatchOperation":{"type":"object","required":["op"],"properties":{"op":{"type":"string","description":"The PATCH operation to perform.","enum":["add","replace","remove"],"x-genesys-enum-members":[{"name":"add"},{"name":"replace"},{"name":"remove"}]},"path":{"type":"string","description":"The attribute path that describes the target of the operation. Required for a \"remove\" operation."},"value":{"description":"The value to set in the path.","$ref":"#/definitions/JsonNode"}},"description":"Defines a SCIM PATCH operation. The path and value follow very specific rules based on operation types. See section 3.5.2 \"Modifying with PATCH\" in RFC 7644 for details."},"ScimV2PatchRequest":{"type":"object","required":["schemas"],"properties":{"schemas":{"type":"array","description":"The list of schemas used in the PATCH request.","items":{"type":"string"}},"Operations":{"type":"array","description":"The list of operations to perform for the PATCH request.","items":{"$ref":"#/definitions/ScimV2PatchOperation"}}},"description":"Defines a SCIM PATCH request. See section 3.5.2 \"Modifying with PATCH\" in RFC 7644 for details."},"ScimUserListResponse":{"type":"object","properties":{"totalResults":{"type":"integer","format":"int64","description":"The total number of results.","readOnly":true},"startIndex":{"type":"integer","format":"int64","description":"The 1-based index of the first result returned by this request. Add this to \"itemsPerPage\" when requesting the next page of results.","readOnly":true},"itemsPerPage":{"type":"integer","format":"int64","description":"The number of resources returned per page.","readOnly":true},"Resources":{"type":"array","description":"The list of requested resources. If \"count\" is 0, then the list will be empty.","readOnly":true,"items":{"$ref":"#/definitions/ScimV2User"}},"schemas":{"type":"array","description":"The list of supported schemas.","items":{"type":"string"}}},"description":"Defines a response for a list of SCIM users."},"ActionTemplate":{"type":"object","required":["mediaType","name","state"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Name of the action template."},"description":{"type":"string","description":"Description of the action template's functionality."},"mediaType":{"type":"string","description":"Media type of action described by the action template.","enum":["webchat","webMessagingOffer","contentOffer","integrationAction","architectFlow"],"x-genesys-enum-members":[{"name":"webchat"},{"name":"webMessagingOffer"},{"name":"contentOffer"},{"name":"integrationAction"},{"name":"architectFlow"}]},"state":{"type":"string","description":"Whether the action template is currently active, inactive or deleted.","enum":["Active","Inactive","Deleted"],"x-genesys-enum-members":[{"name":"Active"},{"name":"Inactive"},{"name":"Deleted"}]},"contentOffer":{"description":"Properties used to configure an action of type content offer","$ref":"#/definitions/ContentOffer"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"createdDate":{"type":"string","format":"date-time","description":"Date when action template was created in ISO-8601 format.","readOnly":true},"modifiedDate":{"type":"string","format":"date-time","description":"Date when action template was last modified in ISO-8601 format.","readOnly":true}}},"CallToAction":{"type":"object","required":["url"],"properties":{"text":{"type":"string","description":"Text displayed on the call to action button."},"url":{"type":"string","description":"URL to open when user clicks on the call to action button."},"target":{"type":"string","description":"Where the URL should be opened when the user clicks on the call to action button.","enum":["Blank","Self"],"x-genesys-enum-members":[{"name":"Blank"},{"name":"Self"}]}}},"CloseButtonStyleProperties":{"type":"object","properties":{"color":{"type":"string","description":"Color of button. (eg. #FF0000)"},"opacity":{"type":"number","format":"float","description":"Opacity of button."}}},"ContentOffer":{"type":"object","required":["displayMode","layoutMode"],"properties":{"imageUrl":{"type":"string","description":"URL for image displayed to the customer when displaying content offer."},"displayMode":{"type":"string","description":"The display mode of Genesys Widgets when displaying content offer.","enum":["Modal","Overlay","Toast"],"x-genesys-enum-members":[{"name":"Modal"},{"name":"Overlay"},{"name":"Toast"}]},"layoutMode":{"type":"string","description":"The layout mode of the text shown to the user when displaying content offer.","enum":["TextOnly","ImageOnly","LeftText","RightText","TopText","BottomText"],"x-genesys-enum-members":[{"name":"TextOnly"},{"name":"ImageOnly"},{"name":"LeftText"},{"name":"RightText"},{"name":"TopText"},{"name":"BottomText"}]},"title":{"type":"string","description":"Title used in the header of the content offer."},"headline":{"type":"string","description":"Headline displayed above the body text of the content offer."},"body":{"type":"string","description":"Body text of the content offer."},"callToAction":{"description":"Properties customizing the call to action button on the content offer.","$ref":"#/definitions/CallToAction"},"style":{"description":"Properties customizing the styling of the content offer.","$ref":"#/definitions/ContentOfferStylingConfiguration"}}},"ContentOfferStyleProperties":{"type":"object","properties":{"padding":{"type":"string","description":"Padding of the offer. (eg. 10px)"},"color":{"type":"string","description":"Text color of the offer. (eg. #FF0000)"},"backgroundColor":{"type":"string","description":"Background color of the offer. (eg. #000000)"}}},"ContentOfferStylingConfiguration":{"type":"object","properties":{"position":{"description":"Properties for customizing the positioning of the content offer.","$ref":"#/definitions/ContentPositionProperties"},"offer":{"description":"Properties for customizing the appearance of the content offer.","$ref":"#/definitions/ContentOfferStyleProperties"},"closeButton":{"description":"Properties for customizing the appearance of the close button.","$ref":"#/definitions/CloseButtonStyleProperties"},"ctaButton":{"description":"Properties for customizing the appearance of the CTA button.","$ref":"#/definitions/CtaButtonStyleProperties"},"title":{"description":"Properties for customizing the appearance of the title text.","$ref":"#/definitions/TextStyleProperties"},"headline":{"description":"Properties for customizing the appearance of the headline text.","$ref":"#/definitions/TextStyleProperties"},"body":{"description":"Properties for customizing the appearance of the body text.","$ref":"#/definitions/TextStyleProperties"}}},"ContentPositionProperties":{"type":"object","properties":{"top":{"type":"string","description":"Top positioning offset."},"bottom":{"type":"string","description":"Bottom positioning offset."},"left":{"type":"string","description":"Left positioning offset."},"right":{"type":"string","description":"Right positioning offset."}}},"CtaButtonStyleProperties":{"type":"object","properties":{"color":{"type":"string","description":"Color of the text. (eg. #FFFFFF)"},"font":{"type":"string","description":"Font of the text. (eg. Helvetica)"},"fontSize":{"type":"string","description":"Font size of the text. (eg. '12')"},"textAlign":{"type":"string","description":"Text alignment.","enum":["Left","Right","Center"],"x-genesys-enum-members":[{"name":"Left"},{"name":"Right"},{"name":"Center"}]},"backgroundColor":{"type":"string","description":"Background color of the CTA button. (eg. #FF0000)"}}},"IntegrationAction":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"IntegrationActionFields":{"type":"object","properties":{"integrationAction":{"description":"Reference to the Integration Action to be used when integrationAction type is qualified","$ref":"#/definitions/IntegrationAction"},"requestMappings":{"type":"array","description":"Collection of Request Mappings to use","items":{"$ref":"#/definitions/RequestMapping"}}}},"RequestMapping":{"type":"object","properties":{"name":{"type":"string","description":"Name of the Integration Action Attribute to supply the value for"},"attributeType":{"type":"string","description":"Type of the value supplied","enum":["String","Number","Integer","Boolean"],"x-genesys-enum-members":[{"name":"String"},{"name":"Number"},{"name":"Integer"},{"name":"Boolean"}]},"mappingType":{"type":"string","description":"Method of finding value to use with Attribute","enum":["Lookup","HardCoded"],"x-genesys-enum-members":[{"name":"Lookup"},{"name":"HardCoded"}]},"value":{"type":"string","description":"Value to supply for the specified Attribute"}}},"TextStyleProperties":{"type":"object","properties":{"color":{"type":"string","description":"Color of the text. (eg. #FFFFFF)"},"font":{"type":"string","description":"Font of the text. (eg. Helvetica)"},"fontSize":{"type":"string","description":"Font size of the text. (eg. '12')"},"textAlign":{"type":"string","description":"Text alignment.","enum":["Left","Right","Center"],"x-genesys-enum-members":[{"name":"Left"},{"name":"Right"},{"name":"Center"}]}}},"PatchActionTemplate":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name of the action template."},"description":{"type":"string","description":"Description of the action template's functionality."},"mediaType":{"type":"string","description":"Media type of action described by the action template.","enum":["webchat","webMessagingOffer","contentOffer","integrationAction","architectFlow"],"x-genesys-enum-members":[{"name":"webchat"},{"name":"webMessagingOffer"},{"name":"contentOffer"},{"name":"integrationAction"},{"name":"architectFlow"}]},"state":{"type":"string","description":"Whether the action template is currently active, inactive or deleted.","enum":["Active","Inactive","Deleted"],"x-genesys-enum-members":[{"name":"Active"},{"name":"Inactive"},{"name":"Deleted"}]},"contentOffer":{"description":"Properties used to configure an action of type content offer","$ref":"#/definitions/PatchContentOffer"}}},"PatchCallToAction":{"type":"object","properties":{"text":{"type":"string","description":"Text displayed on the call to action button."},"url":{"type":"string","description":"URL to open when user clicks on the call to action button."},"target":{"type":"string","description":"Where the URL should be opened when the user clicks on the call to action button.","enum":["Blank","Self"],"x-genesys-enum-members":[{"name":"Blank"},{"name":"Self"}]}}},"PatchCloseButtonStyleProperties":{"type":"object","properties":{"color":{"type":"string","description":"Color of button. (eg. #FF0000)"},"opacity":{"type":"number","format":"float","description":"Opacity of button."}}},"PatchContentOffer":{"type":"object","properties":{"imageUrl":{"type":"string","description":"URL for image displayed to the customer when displaying content offer."},"displayMode":{"type":"string","description":"The display mode of Genesys Widgets when displaying content offer.","enum":["Modal","Overlay","Toast"],"x-genesys-enum-members":[{"name":"Modal"},{"name":"Overlay"},{"name":"Toast"}]},"layoutMode":{"type":"string","description":"The layout mode of the text shown to the user when displaying content offer.","enum":["TextOnly","ImageOnly","LeftText","RightText","TopText","BottomText"],"x-genesys-enum-members":[{"name":"TextOnly"},{"name":"ImageOnly"},{"name":"LeftText"},{"name":"RightText"},{"name":"TopText"},{"name":"BottomText"}]},"title":{"type":"string","description":"Title used in the header of the content offer."},"headline":{"type":"string","description":"Headline displayed above the body text of the content offer."},"body":{"type":"string","description":"Body text of the content offer."},"callToAction":{"description":"Properties customizing the call to action button on the content offer.","$ref":"#/definitions/PatchCallToAction"},"style":{"description":"Properties customizing the styling of the content offer.","$ref":"#/definitions/PatchContentOfferStylingConfiguration"}}},"PatchContentOfferStyleProperties":{"type":"object","properties":{"padding":{"type":"string","description":"Padding of the offer. (eg. 10px)"},"color":{"type":"string","description":"Text color of the offer. (eg. #FF0000)"},"backgroundColor":{"type":"string","description":"Background color of the offer. (eg. #000000)"}}},"PatchContentOfferStylingConfiguration":{"type":"object","properties":{"position":{"description":"Properties for customizing the positioning of the content offer.","$ref":"#/definitions/PatchContentPositionProperties"},"offer":{"description":"Properties for customizing the appearance of the content offer.","$ref":"#/definitions/PatchContentOfferStyleProperties"},"closeButton":{"description":"Properties for customizing the appearance of the close button.","$ref":"#/definitions/PatchCloseButtonStyleProperties"},"ctaButton":{"description":"Properties for customizing the appearance of the CTA button.","$ref":"#/definitions/PatchCtaButtonStyleProperties"},"title":{"description":"Properties for customizing the appearance of the title text.","$ref":"#/definitions/PatchTextStyleProperties"},"headline":{"description":"Properties for customizing the appearance of the headline text.","$ref":"#/definitions/PatchTextStyleProperties"},"body":{"description":"Properties for customizing the appearance of the body text.","$ref":"#/definitions/PatchTextStyleProperties"}}},"PatchContentPositionProperties":{"type":"object","properties":{"top":{"type":"string","description":"Top positioning offset."},"bottom":{"type":"string","description":"Bottom positioning offset."},"left":{"type":"string","description":"Left positioning offset."},"right":{"type":"string","description":"Right positioning offset."}}},"PatchCtaButtonStyleProperties":{"type":"object","properties":{"color":{"type":"string","description":"Color of the text. (eg. #FFFFFF)"},"font":{"type":"string","description":"Font of the text. (eg. Helvetica)"},"fontSize":{"type":"string","description":"Font size of the text. (eg. '12')"},"textAlign":{"type":"string","description":"Text alignment.","enum":["Left","Right","Center"],"x-genesys-enum-members":[{"name":"Left"},{"name":"Right"},{"name":"Center"}]},"backgroundColor":{"type":"string","description":"Background color of the CTA button. (eg. #A04033)"}}},"PatchIntegrationAction":{"type":"object","properties":{"id":{"type":"string","description":"ID of the integration action to be invoked."}}},"PatchIntegrationActionFields":{"type":"object","properties":{"integrationAction":{"description":"Reference to the Integration Action to be used when integrationAction type is qualified","$ref":"#/definitions/PatchIntegrationAction"},"requestMappings":{"type":"array","description":"Collection of Request Mappings to use","items":{"$ref":"#/definitions/RequestMapping"}}}},"PatchTextStyleProperties":{"type":"object","properties":{"color":{"type":"string","description":"Color of the text. (eg. #FFFFFF)"},"font":{"type":"string","description":"Font of the text. (eg. Helvetica)"},"fontSize":{"type":"string","description":"Font size of the text. (eg. '12')"},"textAlign":{"type":"string","description":"Text alignment.","enum":["Left","Right","Center"],"x-genesys-enum-members":[{"name":"Left"},{"name":"Right"},{"name":"Center"}]}}},"DomainEntityListingSurveyForm":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SurveyForm"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"SurveyForm":{"type":"object","required":["contextId","language","name","questionGroups"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The survey form name"},"modifiedDate":{"type":"string","format":"date-time","description":"Last modified date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"published":{"type":"boolean","description":"Is this form published","readOnly":true},"disabled":{"type":"boolean","description":"Is this form disabled"},"contextId":{"type":"string","description":"Unique Id for all versions of this form","readOnly":true},"language":{"type":"string","description":"Language for survey viewer localization. Currently localized languages: da, de, en-US, es, fi, fr, it, ja, ko, nl, no, pl, pt-BR, sv, th, tr, zh-CH, zh-TW"},"header":{"type":"string","description":"Markdown text for the top of the form."},"footer":{"type":"string","description":"Markdown text for the bottom of the form."},"questionGroups":{"type":"array","description":"A list of question groups","items":{"$ref":"#/definitions/SurveyQuestionGroup"}},"publishedVersions":{"description":"List of published version of this form","readOnly":true,"$ref":"#/definitions/DomainEntityListingSurveyForm"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SurveyFormEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SurveyForm"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"SurveyQuestion":{"type":"object","properties":{"id":{"type":"string"},"text":{"type":"string"},"helpText":{"type":"string"},"type":{"type":"string","enum":["multipleChoiceQuestion","freeTextQuestion","npsQuestion","readOnlyTextBlockQuestion"],"x-genesys-enum-members":[{"name":"multipleChoiceQuestion"},{"name":"freeTextQuestion"},{"name":"npsQuestion"},{"name":"readOnlyTextBlockQuestion"}]},"naEnabled":{"type":"boolean"},"visibilityCondition":{"$ref":"#/definitions/VisibilityCondition"},"answerOptions":{"type":"array","description":"Options from which to choose an answer for this question. Only used by Multiple Choice type questions.","items":{"$ref":"#/definitions/AnswerOption"}},"maxResponseCharacters":{"type":"integer","format":"int32","description":"How many characters are allowed in the text response to this question. Used by NPS and Free Text question types."},"explanationPrompt":{"type":"string","description":"Prompt for details explaining the chosen NPS score. Used by NPS questions."}}},"SurveyQuestionGroup":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"naEnabled":{"type":"boolean"},"questions":{"type":"array","items":{"$ref":"#/definitions/SurveyQuestion"}},"visibilityCondition":{"$ref":"#/definitions/VisibilityCondition"}}},"ReportingExportJobListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ReportingExportJobResponse"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"TrunkMetrics":{"type":"object","properties":{"eventTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"logicalInterface":{"$ref":"#/definitions/DomainEntityRef"},"trunk":{"$ref":"#/definitions/DomainEntityRef"},"calls":{"$ref":"#/definitions/TrunkMetricsCalls"},"qos":{"$ref":"#/definitions/TrunkMetricsQoS"}}},"TrunkMetricsCalls":{"type":"object","properties":{"inboundCallCount":{"type":"integer","format":"int32"},"outboundCallCount":{"type":"integer","format":"int32"}}},"TrunkMetricsQoS":{"type":"object","required":["mismatchCount"],"properties":{"mismatchCount":{"type":"integer","format":"int32","description":"Total number of QoS mismatches over the course of the last 24-hour period (sliding window)."}}},"Greeting":{"type":"object","required":["owner","ownerType","type"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"type":{"type":"string","description":"Greeting type","enum":["STATION","VOICEMAIL","NAME"],"x-genesys-enum-members":[{"name":"STATION"},{"name":"VOICEMAIL"},{"name":"NAME"}]},"ownerType":{"type":"string","description":"Greeting owner type","enum":["USER","ORGANIZATION","GROUP"],"x-genesys-enum-members":[{"name":"USER"},{"name":"ORGANIZATION"},{"name":"GROUP"}]},"owner":{"description":"Greeting owner","$ref":"#/definitions/DomainEntity"},"audioFile":{"$ref":"#/definitions/GreetingAudioFile"},"audioTTS":{"type":"string"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"type":"string","format":"uri"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GreetingAudioFile":{"type":"object","properties":{"durationMilliseconds":{"type":"integer","format":"int64"},"sizeBytes":{"type":"integer","format":"int64"},"selfUri":{"type":"string","format":"uri"}}},"GeneralTopic":{"type":"object","properties":{"name":{"type":"string"}}},"GeneralTopicsEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/GeneralTopic"}}}},"WebChatConversation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"member":{"description":"Chat Member","$ref":"#/definitions/WebChatMemberInfo"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WebChatMemberInfo":{"type":"object","required":["role"],"properties":{"id":{"type":"string","description":"The communicationId of this member."},"displayName":{"type":"string","description":"The display name of the member."},"firstName":{"type":"string","description":"The first name of the member."},"lastName":{"type":"string","description":"The last name of the member."},"email":{"type":"string","description":"The email address of the member."},"phoneNumber":{"type":"string","description":"The phone number of the member."},"avatarImageUrl":{"type":"string","format":"uri","description":"The url to the avatar image of the member."},"role":{"type":"string","description":"The role of the member, one of [agent, customer, acd, workflow]","enum":["AGENT","CUSTOMER","WORKFLOW","ACD"],"x-genesys-enum-members":[{"name":"AGENT"},{"name":"CUSTOMER"},{"name":"WORKFLOW"},{"name":"ACD"}]},"joinDate":{"type":"string","format":"date-time","description":"The time the member joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"leaveDate":{"type":"string","format":"date-time","description":"The time the member left the conversation, or null if the member is still active in the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"authenticatedGuest":{"type":"boolean","description":"If true, the guest member is an authenticated guest."},"customFields":{"type":"object","description":"Any custom fields of information pertaining to this member.","additionalProperties":{"type":"string"}},"state":{"type":"string","description":"The connection state of this member.","enum":["CONNECTED","DISCONNECTED","ALERTING"],"x-genesys-enum-members":[{"name":"CONNECTED"},{"name":"DISCONNECTED"},{"name":"ALERTING"}]}}},"WebChatMessage":{"type":"object","required":["body","bodyType","conversation","sender","timestamp"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"conversation":{"description":"The identifier of the conversation","$ref":"#/definitions/WebChatConversation"},"sender":{"description":"The member who sent the message","$ref":"#/definitions/WebChatMemberInfo"},"body":{"type":"string","description":"The message body."},"bodyType":{"type":"string","description":"The purpose of the message within the conversation, such as a standard text entry versus a greeting.","enum":["standard","notice","member-join","member-leave","media-request"],"x-genesys-enum-members":[{"name":"standard"},{"name":"notice"},{"name":"member-join"},{"name":"member-leave"},{"name":"media-request"}]},"timestamp":{"type":"string","format":"date-time","description":"The timestamp of the message, in ISO-8601 format"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DataTable":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"description":{"type":"string","description":"The description from the JSON schema (equates to the Description field on the JSON schema.)"},"schema":{"description":"the schema as stored in the system.","$ref":"#/definitions/JsonSchemaDocument"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Contains a metadata representation for a JSON schema stored in DataTables along with an optional field for the schema itself"},"DataTablesDomainEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DataTable"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ConstraintConflictMessage":{"type":"object","properties":{"message":{"description":"Message for how to resolve a set of conflicted work plan constraints","$ref":"#/definitions/WorkPlanConstraintConflictMessage"},"conflictedConstraintMessages":{"type":"array","description":"Messages for the set of conflicted work plan constraints. Each element indicates the message of a work plan constraint that is conflicted in the set","items":{"$ref":"#/definitions/WorkPlanConstraintMessage"}}}},"ValidateWorkPlanMessages":{"type":"object","properties":{"violationMessages":{"type":"array","description":"Messages for work plan violating some rules such as no shifts in a work plan","items":{"$ref":"#/definitions/WorkPlanConfigurationViolationMessage"}},"constraintConflictMessage":{"description":"This field is not null when there is a set of work plan constraints that conflict thus agent schedules cannot be generated","$ref":"#/definitions/ConstraintConflictMessage"}}},"ValidateWorkPlanResponse":{"type":"object","properties":{"workPlan":{"description":"The work plan reference associated with this response","$ref":"#/definitions/WorkPlanReference"},"valid":{"type":"boolean","description":"Whether the work plan is valid or not"},"messages":{"description":"Validation messages for this work plan","$ref":"#/definitions/ValidateWorkPlanMessages"}}},"WorkPlanConfigurationViolationMessage":{"type":"object","properties":{"type":{"type":"string","description":"Type of configuration violation message for this work plan","enum":["ActivitiesOverlap","ActivityEndGreaterThanShiftStop","ActivityPaidTimeGreaterThanShiftPaidTime","ActivityStartBeforeShiftStart","ActivityStartGreaterThanEqualToShiftStop","ActivityStartIncrementMinutesNotDivisibleByScheduleIntervalMinutes","DailyExactPaidMinutes","DailyMaxTotalLessThanWeeklyMin","DailyMaxTotalLessThanWeeklyMinWithOptional","DailyMaxTotalLessThanWeeklyMinWithoutOptional","DailyMinTotalGreaterThanWeeklyMax","DailyMinTotalGreaterThanWeeklyMaxWithOptional","DailyMinTotalGreaterThanWeeklyMaxWithoutOptional","DailyRequiredDaysGreaterThanWeeklyMaxDays","DailyShiftHasNoDaysSelected","DailyShiftMaxPossibilitiesViolated","EarliestShiftStopIsTooLate","ExactPaidTimeNotDivisibleByGranularity","MaxConsecutiveWorkingDaysNoMoreThanDoubleMaxWorkingDaysPerWeek","MaxDaysOffPerPlanningPeriodNotCorrect","MaxPaidTimeIsMoreThanShiftLength","MaxPaidTimeNotDivisibleByGranularity","MaxPaidTimePerPlanningPeriod","MaxShifts","MinPaidTimeNotDivisibleByGranularity","MinPaidTimePerPlanningPeriod","NoShifts","PaidTimeGreaterThanMaxWorkTime","PaidTimeLessThanMinWorkTime","PaidTimeNotMetByShiftStartStop","ShiftDaysSelectMoreThanMinWorkingDays","ShiftStopEarlierThanStart","ShiftVarianceCannotBeMet","WeeklyExactPaidMinutes"],"x-genesys-enum-members":[{"name":"ActivitiesOverlap"},{"name":"ActivityEndGreaterThanShiftStop"},{"name":"ActivityPaidTimeGreaterThanShiftPaidTime"},{"name":"ActivityStartBeforeShiftStart"},{"name":"ActivityStartGreaterThanEqualToShiftStop"},{"name":"ActivityStartIncrementMinutesNotDivisibleByScheduleIntervalMinutes"},{"name":"DailyExactPaidMinutes"},{"name":"DailyMaxTotalLessThanWeeklyMin"},{"name":"DailyMaxTotalLessThanWeeklyMinWithOptional"},{"name":"DailyMaxTotalLessThanWeeklyMinWithoutOptional"},{"name":"DailyMinTotalGreaterThanWeeklyMax"},{"name":"DailyMinTotalGreaterThanWeeklyMaxWithOptional"},{"name":"DailyMinTotalGreaterThanWeeklyMaxWithoutOptional"},{"name":"DailyRequiredDaysGreaterThanWeeklyMaxDays"},{"name":"DailyShiftHasNoDaysSelected"},{"name":"DailyShiftMaxPossibilitiesViolated"},{"name":"EarliestShiftStopIsTooLate"},{"name":"ExactPaidTimeNotDivisibleByGranularity"},{"name":"MaxConsecutiveWorkingDaysNoMoreThanDoubleMaxWorkingDaysPerWeek"},{"name":"MaxDaysOffPerPlanningPeriodNotCorrect"},{"name":"MaxPaidTimeIsMoreThanShiftLength"},{"name":"MaxPaidTimeNotDivisibleByGranularity"},{"name":"MaxPaidTimePerPlanningPeriod"},{"name":"MaxShifts"},{"name":"MinPaidTimeNotDivisibleByGranularity"},{"name":"MinPaidTimePerPlanningPeriod"},{"name":"NoShifts"},{"name":"PaidTimeGreaterThanMaxWorkTime"},{"name":"PaidTimeLessThanMinWorkTime"},{"name":"PaidTimeNotMetByShiftStartStop"},{"name":"ShiftDaysSelectMoreThanMinWorkingDays"},{"name":"ShiftStopEarlierThanStart"},{"name":"ShiftVarianceCannotBeMet"},{"name":"WeeklyExactPaidMinutes"}]},"arguments":{"type":"array","description":"Arguments of the message that provide information about the misconfigured value or the threshold that is exceeded by the misconfigured value","items":{"$ref":"#/definitions/WorkPlanValidationMessageArgument"}},"severity":{"type":"string","description":"Severity of the message. A message with Error severity indicates the scheduler won't be able to produce schedules and thus the work plan is invalid.","enum":["Information","Warning","Error"],"x-genesys-enum-members":[{"name":"Information"},{"name":"Warning"},{"name":"Error"}]}}},"WorkPlanConstraintConflictMessage":{"type":"object","properties":{"type":{"type":"string","description":"Type of constraint conflict that can be resolved by clients in order to generate agent schedules","enum":["UnknownFix","WithPotentialFixes"],"x-genesys-enum-members":[{"name":"UnknownFix"},{"name":"WithPotentialFixes"}]},"arguments":{"type":"array","description":"The arguments to the type of the message that can help clients resolve validation issues","items":{"$ref":"#/definitions/WorkPlanValidationMessageArgument"}}}},"WorkPlanConstraintMessage":{"type":"object","properties":{"type":{"type":"string","description":"Type of the work plan constraint in this message","enum":["ActivityEarliestStartTimeMinutesFromMidnight","ActivityEarliestStartTimeMinutesFromShiftStart","ActivityLatestStartTimeMinutesFromMidnight","ActivityLatestStartTimeMinutesFromShiftStart","ActivityMinimumLengthFromShiftEndMinutes","ActivityMinimumLengthFromShiftStartMinutes","ActivityStartTimeIncrementInMinutes","PlanningPeriodMaximumDaysOff","PlanningPeriodMaximumPaidTimeMinutes","PlanningPeriodMinimumDaysOff","PlanningPeriodMinimumPaidTimeMinutes","ShiftDayOffRule","ShiftEarliestStartTimeMinutesFromMidnight","ShiftEarliestStopTimeMinutesFromMidnight","ShiftLatestStartTimeMinutesFromMidnight","ShiftLatestStopTimeMinutesFromMidnight","ShiftMaximumContiguousTimeMinutes","ShiftMaximumPaidTimeMinutes","ShiftMinimumContiguousTimeMinutes","ShiftMinimumPaidTimeMinutes","ShiftStartTimeIncrementInMinutes","ShiftStartVarianceMaximumVarianceMinutes","ShiftStartVariancePaidDuration","WorkPlanMaximumConsecutiveWorkingDays","WorkPlanMaximumConsecutiveWorkingWeekends","WorkPlanMaximumWeeklyPaidTimeMinutes","WorkPlanMaximumWorkingDaysPerWeek","WorkPlanMinimumConsecutiveNonWorkingTimePerWeekMinutes","WorkPlanMinimumInterShiftTimeMinutes","WorkPlanMinimumShiftStartDistanceMinutes","WorkPlanMinimumWeeklyPaidTimeMinutes","WorkPlanMinimumWorkingDaysPerWeek","WorkPlanOptionalDays","WorkPlanPaidTimeGranularityMinutes"],"x-genesys-enum-members":[{"name":"ActivityEarliestStartTimeMinutesFromMidnight"},{"name":"ActivityEarliestStartTimeMinutesFromShiftStart"},{"name":"ActivityLatestStartTimeMinutesFromMidnight"},{"name":"ActivityLatestStartTimeMinutesFromShiftStart"},{"name":"ActivityMinimumLengthFromShiftEndMinutes"},{"name":"ActivityMinimumLengthFromShiftStartMinutes"},{"name":"ActivityStartTimeIncrementInMinutes"},{"name":"PlanningPeriodMaximumDaysOff"},{"name":"PlanningPeriodMaximumPaidTimeMinutes"},{"name":"PlanningPeriodMinimumDaysOff"},{"name":"PlanningPeriodMinimumPaidTimeMinutes"},{"name":"ShiftDayOffRule"},{"name":"ShiftEarliestStartTimeMinutesFromMidnight"},{"name":"ShiftEarliestStopTimeMinutesFromMidnight"},{"name":"ShiftLatestStartTimeMinutesFromMidnight"},{"name":"ShiftLatestStopTimeMinutesFromMidnight"},{"name":"ShiftMaximumContiguousTimeMinutes"},{"name":"ShiftMaximumPaidTimeMinutes"},{"name":"ShiftMinimumContiguousTimeMinutes"},{"name":"ShiftMinimumPaidTimeMinutes"},{"name":"ShiftStartTimeIncrementInMinutes"},{"name":"ShiftStartVarianceMaximumVarianceMinutes"},{"name":"ShiftStartVariancePaidDuration"},{"name":"WorkPlanMaximumConsecutiveWorkingDays"},{"name":"WorkPlanMaximumConsecutiveWorkingWeekends"},{"name":"WorkPlanMaximumWeeklyPaidTimeMinutes"},{"name":"WorkPlanMaximumWorkingDaysPerWeek"},{"name":"WorkPlanMinimumConsecutiveNonWorkingTimePerWeekMinutes"},{"name":"WorkPlanMinimumInterShiftTimeMinutes"},{"name":"WorkPlanMinimumShiftStartDistanceMinutes"},{"name":"WorkPlanMinimumWeeklyPaidTimeMinutes"},{"name":"WorkPlanMinimumWorkingDaysPerWeek"},{"name":"WorkPlanOptionalDays"},{"name":"WorkPlanPaidTimeGranularityMinutes"}]},"arguments":{"type":"array","description":"Arguments of the message that provide information about the constraint that is being conflicted with, such as the value of the constraint","items":{"$ref":"#/definitions/WorkPlanValidationMessageArgument"}}}},"WorkPlanValidationMessageArgument":{"type":"object","properties":{"type":{"type":"string","description":"The type of the argument associated with violation messages","enum":["ActivityId","ActivityId2","ActivityPaidTimeMinutes","ActivityStartTimeMinutes","ActivityValidationId","ActivityValidationId2","ApplicableDays","Count","DailyPaidTimeMinutes","MaximumDays","MaxShiftCount","Minutes","PaidTimeGranularityMinutes","RequiredDays","ShiftId","ShiftPaidTimeMinutes","ShiftStartTimeMinutes","ShiftStopTimeMinutes","ShiftValidationId","WeeklyPaidTimeMinutes","Weeks","WorkTimeMinutes"],"x-genesys-enum-members":[{"name":"ActivityId"},{"name":"ActivityId2"},{"name":"ActivityPaidTimeMinutes"},{"name":"ActivityStartTimeMinutes"},{"name":"ActivityValidationId"},{"name":"ActivityValidationId2"},{"name":"ApplicableDays"},{"name":"Count"},{"name":"DailyPaidTimeMinutes"},{"name":"MaximumDays"},{"name":"MaxShiftCount"},{"name":"Minutes"},{"name":"PaidTimeGranularityMinutes"},{"name":"RequiredDays"},{"name":"ShiftId"},{"name":"ShiftPaidTimeMinutes"},{"name":"ShiftStartTimeMinutes"},{"name":"ShiftStopTimeMinutes"},{"name":"ShiftValidationId"},{"name":"WeeklyPaidTimeMinutes"},{"name":"Weeks"},{"name":"WorkTimeMinutes"}]},"value":{"type":"string","description":"The value of the argument"}}},"DeletableUserReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"delete":{"type":"boolean","description":"If marked true, the user will be removed an associated entity"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"User reference with delete flag to remove the user from an associated entity"},"ListWrapperShiftStartVariance":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/definitions/ShiftStartVariance"}}}},"SetWrapperDayOfWeek":{"type":"object","properties":{"values":{"type":"array","uniqueItems":true,"items":{"type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"x-genesys-enum-members":[{"name":"Sunday"},{"name":"Monday"},{"name":"Tuesday"},{"name":"Wednesday"},{"name":"Thursday"},{"name":"Friday"},{"name":"Saturday"}]}}}},"ShiftStartVariance":{"type":"object","required":["applicableDays","maxShiftStartVarianceMinutes"],"properties":{"applicableDays":{"type":"array","description":"Days for which shift start variance is configured","uniqueItems":true,"items":{"type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"x-genesys-enum-members":[{"name":"Sunday"},{"name":"Monday"},{"name":"Tuesday"},{"name":"Wednesday"},{"name":"Thursday"},{"name":"Friday"},{"name":"Saturday"}]}},"maxShiftStartVarianceMinutes":{"type":"integer","format":"int32","description":"Maximum variance in minutes across shift starts"}},"description":"Variance in minutes among start times of shifts in work plan"},"WorkPlanActivity":{"type":"object","properties":{"activityCodeId":{"type":"string","description":"ID of the activity code associated with this activity"},"description":{"type":"string","description":"Description of the activity"},"lengthMinutes":{"type":"integer","format":"int32","description":"Length of the activity in minutes"},"startTimeIsRelativeToShiftStart":{"type":"boolean","description":"Whether the start time of the activity is relative to the start time of the shift it belongs to"},"flexibleStartTime":{"type":"boolean","description":"Whether the start time of the activity is flexible"},"earliestStartTimeMinutes":{"type":"integer","format":"int32","description":"Earliest activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == true"},"latestStartTimeMinutes":{"type":"integer","format":"int32","description":"Latest activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == true"},"exactStartTimeMinutes":{"type":"integer","format":"int32","description":"Exact activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == false"},"startTimeIncrementMinutes":{"type":"integer","format":"int32","description":"Increment in offset minutes that would contribute to different possible start times for the activity"},"countsAsPaidTime":{"type":"boolean","description":"Whether the activity is paid"},"countsAsContiguousWorkTime":{"type":"boolean","description":"Whether the activity duration is counted towards contiguous work time"},"minimumLengthFromShiftStartMinutes":{"type":"integer","format":"int32","description":"The minimum duration between shift start and shift item (e.g., break or meal) start in minutes"},"minimumLengthFromShiftEndMinutes":{"type":"integer","format":"int32","description":"The minimum duration between shift item (e.g., break or meal) end and shift end in minutes"},"id":{"type":"string","description":"ID of the activity. This is required only for the case of updating an existing activity"},"delete":{"type":"boolean","description":"If marked true for updating an existing activity, the activity will be permanently deleted"}},"description":"Activity configured for shift in work plan"},"WorkPlanShift":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name of the shift"},"days":{"description":"Days of the week applicable for this shift","$ref":"#/definitions/SetWrapperDayOfWeek"},"flexibleStartTime":{"type":"boolean","description":"Whether the start time of the shift is flexible"},"exactStartTimeMinutesFromMidnight":{"type":"integer","format":"int32","description":"Exact start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == false"},"earliestStartTimeMinutesFromMidnight":{"type":"integer","format":"int32","description":"Earliest start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == true"},"latestStartTimeMinutesFromMidnight":{"type":"integer","format":"int32","description":"Latest start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == true"},"constrainStopTime":{"type":"boolean","description":"Whether the latest stop time constraint for the shift is enabled. Deprecated, use constrainLatestStopTime instead"},"constrainLatestStopTime":{"type":"boolean","description":"Whether the latest stop time constraint for the shift is enabled"},"latestStopTimeMinutesFromMidnight":{"type":"integer","format":"int32","description":"Latest stop time of the shift defined as offset minutes from midnight. Used if constrainStopTime == true"},"constrainEarliestStopTime":{"type":"boolean","description":"Whether the earliest stop time constraint for the shift is enabled"},"earliestStopTimeMinutesFromMidnight":{"type":"integer","format":"int32","description":"This is the earliest time a shift can end"},"startIncrementMinutes":{"type":"integer","format":"int32","description":"Increment in offset minutes that would contribute to different possible start times for the shift. Used if flexibleStartTime == true"},"flexiblePaidTime":{"type":"boolean","description":"Whether the paid time setting for the shift is flexible"},"exactPaidTimeMinutes":{"type":"integer","format":"int32","description":"Exact paid time in minutes configured for the shift. Used if flexiblePaidTime == false"},"minimumPaidTimeMinutes":{"type":"integer","format":"int32","description":"Minimum paid time in minutes configured for the shift. Used if flexiblePaidTime == true"},"maximumPaidTimeMinutes":{"type":"integer","format":"int32","description":"Maximum paid time in minutes configured for the shift. Used if flexiblePaidTime == true"},"constrainContiguousWorkTime":{"type":"boolean","description":"Whether the contiguous time constraint for the shift is enabled"},"minimumContiguousWorkTimeMinutes":{"type":"integer","format":"int32","description":"Minimum contiguous time in minutes configured for the shift. Used if constrainContiguousWorkTime == true"},"maximumContiguousWorkTimeMinutes":{"type":"integer","format":"int32","description":"Maximum contiguous time in minutes configured for the shift. Used if constrainContiguousWorkTime == true"},"activities":{"type":"array","description":"Activities configured for this shift","items":{"$ref":"#/definitions/WorkPlanActivity"}},"id":{"type":"string","description":"ID of the shift. This is required only for the case of updating an existing shift"},"delete":{"type":"boolean","description":"If marked true for updating an existing shift, the shift will be permanently deleted"}},"description":"Shift in a work plan"},"WorkPlanValidationRequest":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"enabled":{"type":"boolean","description":"Whether the work plan is enabled for scheduling"},"constrainWeeklyPaidTime":{"type":"boolean","description":"Whether the weekly paid time constraint is enabled for this work plan"},"flexibleWeeklyPaidTime":{"type":"boolean","description":"Whether the weekly paid time constraint is flexible for this work plan"},"weeklyExactPaidMinutes":{"type":"integer","format":"int32","description":"Exact weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == false"},"weeklyMinimumPaidMinutes":{"type":"integer","format":"int32","description":"Minimum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true"},"weeklyMaximumPaidMinutes":{"type":"integer","format":"int32","description":"Maximum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true"},"constrainPaidTimeGranularity":{"type":"boolean","description":"Whether paid time granularity is constrained for this work plan"},"paidTimeGranularityMinutes":{"type":"integer","format":"int32","description":"Granularity in minutes allowed for shift paid time in this work plan. Used if constrainPaidTimeGranularity == true"},"constrainMinimumTimeBetweenShifts":{"type":"boolean","description":"Whether the minimum time between shifts constraint is enabled for this work plan"},"minimumTimeBetweenShiftsMinutes":{"type":"integer","format":"int32","description":"Minimum time between shifts in minutes defined in this work plan. Used if constrainMinimumTimeBetweenShifts == true"},"maximumDays":{"type":"integer","format":"int32","description":"Maximum number days in a week allowed to be scheduled for this work plan"},"minimumConsecutiveNonWorkingMinutesPerWeek":{"type":"integer","format":"int32","description":"Minimum amount of consecutive non working minutes per week that agents who are assigned this work plan are allowed to have off"},"constrainMaximumConsecutiveWorkingWeekends":{"type":"boolean","description":"Whether to constrain the maximum consecutive working weekends"},"maximumConsecutiveWorkingWeekends":{"type":"integer","format":"int32","description":"The maximum number of consecutive weekends that agents who are assigned to this work plan are allowed to work"},"minimumWorkingDaysPerWeek":{"type":"integer","format":"int32","description":"The minimum number of days that agents assigned to a work plan must work per week"},"constrainMaximumConsecutiveWorkingDays":{"type":"boolean","description":"Whether to constrain the maximum consecutive working days"},"maximumConsecutiveWorkingDays":{"type":"integer","format":"int32","description":"The maximum number of consecutive days that agents assigned to this work plan are allowed to work. Used if constrainMaximumConsecutiveWorkingDays == true"},"minimumShiftStartDistanceMinutes":{"type":"integer","format":"int32","description":"The time period in minutes for the duration between the start times of two consecutive working days"},"minimumDaysOffPerPlanningPeriod":{"type":"integer","format":"int32","description":"Minimum days off in the planning period"},"maximumDaysOffPerPlanningPeriod":{"type":"integer","format":"int32","description":"Maximum days off in the planning period"},"minimumPaidMinutesPerPlanningPeriod":{"type":"integer","format":"int32","description":"Minimum paid minutes in the planning period"},"maximumPaidMinutesPerPlanningPeriod":{"type":"integer","format":"int32","description":"Maximum paid minutes in the planning period"},"optionalDays":{"description":"Optional days to schedule for this work plan","$ref":"#/definitions/SetWrapperDayOfWeek"},"shiftStartVarianceType":{"type":"string","description":"This constraint ensures that an agent starts each workday within a user-defined time threshold","enum":["ShiftStart","ShiftStartAndPaidDuration"],"x-genesys-enum-members":[{"name":"ShiftStart"},{"name":"ShiftStartAndPaidDuration"}]},"shiftStartVariances":{"description":"Variance in minutes among start times of shifts in this work plan","$ref":"#/definitions/ListWrapperShiftStartVariance"},"shifts":{"type":"array","description":"Shifts in this work plan","items":{"$ref":"#/definitions/WorkPlanShift"}},"agents":{"type":"array","description":"Agents in this work plan","items":{"$ref":"#/definitions/DeletableUserReference"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Work plan information"},"WorkPlan":{"type":"object","required":["metadata"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"enabled":{"type":"boolean","description":"Whether the work plan is enabled for scheduling"},"constrainWeeklyPaidTime":{"type":"boolean","description":"Whether the weekly paid time constraint is enabled for this work plan"},"flexibleWeeklyPaidTime":{"type":"boolean","description":"Whether the weekly paid time constraint is flexible for this work plan"},"weeklyExactPaidMinutes":{"type":"integer","format":"int32","description":"Exact weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == false"},"weeklyMinimumPaidMinutes":{"type":"integer","format":"int32","description":"Minimum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true"},"weeklyMaximumPaidMinutes":{"type":"integer","format":"int32","description":"Maximum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true"},"constrainPaidTimeGranularity":{"type":"boolean","description":"Whether paid time granularity is constrained for this work plan"},"paidTimeGranularityMinutes":{"type":"integer","format":"int32","description":"Granularity in minutes allowed for shift paid time in this work plan. Used if constrainPaidTimeGranularity == true"},"constrainMinimumTimeBetweenShifts":{"type":"boolean","description":"Whether the minimum time between shifts constraint is enabled for this work plan"},"minimumTimeBetweenShiftsMinutes":{"type":"integer","format":"int32","description":"Minimum time between shifts in minutes defined in this work plan. Used if constrainMinimumTimeBetweenShifts == true"},"maximumDays":{"type":"integer","format":"int32","description":"Maximum number days in a week allowed to be scheduled for this work plan"},"minimumConsecutiveNonWorkingMinutesPerWeek":{"type":"integer","format":"int32","description":"Minimum amount of consecutive non working minutes per week that agents who are assigned this work plan are allowed to have off"},"constrainMaximumConsecutiveWorkingWeekends":{"type":"boolean","description":"Whether to constrain the maximum consecutive working weekends"},"maximumConsecutiveWorkingWeekends":{"type":"integer","format":"int32","description":"The maximum number of consecutive weekends that agents who are assigned to this work plan are allowed to work"},"minimumWorkingDaysPerWeek":{"type":"integer","format":"int32","description":"The minimum number of days that agents assigned to a work plan must work per week"},"constrainMaximumConsecutiveWorkingDays":{"type":"boolean","description":"Whether to constrain the maximum consecutive working days"},"maximumConsecutiveWorkingDays":{"type":"integer","format":"int32","description":"The maximum number of consecutive days that agents assigned to this work plan are allowed to work. Used if constrainMaximumConsecutiveWorkingDays == true"},"minimumShiftStartDistanceMinutes":{"type":"integer","format":"int32","description":"The time period in minutes for the duration between the start times of two consecutive working days"},"minimumDaysOffPerPlanningPeriod":{"type":"integer","format":"int32","description":"Minimum days off in the planning period"},"maximumDaysOffPerPlanningPeriod":{"type":"integer","format":"int32","description":"Maximum days off in the planning period"},"minimumPaidMinutesPerPlanningPeriod":{"type":"integer","format":"int32","description":"Minimum paid minutes in the planning period"},"maximumPaidMinutesPerPlanningPeriod":{"type":"integer","format":"int32","description":"Maximum paid minutes in the planning period"},"optionalDays":{"description":"Optional days to schedule for this work plan","$ref":"#/definitions/SetWrapperDayOfWeek"},"shiftStartVarianceType":{"type":"string","description":"This constraint ensures that an agent starts each workday within a user-defined time threshold","enum":["ShiftStart","ShiftStartAndPaidDuration"],"x-genesys-enum-members":[{"name":"ShiftStart"},{"name":"ShiftStartAndPaidDuration"}]},"shiftStartVariances":{"description":"Variance in minutes among start times of shifts in this work plan","$ref":"#/definitions/ListWrapperShiftStartVariance"},"shifts":{"type":"array","description":"Shifts in this work plan","items":{"$ref":"#/definitions/WorkPlanShift"}},"agents":{"type":"array","description":"Agents in this work plan","items":{"$ref":"#/definitions/DeletableUserReference"}},"metadata":{"description":"Version metadata for this work plan","$ref":"#/definitions/WfmVersionedEntityMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Work plan information"},"CopyWorkPlan":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name of the copied work plan"}},"description":"Information associated with a work plan thats created as a copy"},"CreateWorkPlan":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name of this work plan"},"enabled":{"type":"boolean","description":"Whether the work plan is enabled for scheduling"},"constrainWeeklyPaidTime":{"type":"boolean","description":"Whether the weekly paid time constraint is enabled for this work plan"},"flexibleWeeklyPaidTime":{"type":"boolean","description":"Whether the weekly paid time constraint is flexible for this work plan"},"weeklyExactPaidMinutes":{"type":"integer","format":"int32","description":"Exact weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == false"},"weeklyMinimumPaidMinutes":{"type":"integer","format":"int32","description":"Minimum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true"},"weeklyMaximumPaidMinutes":{"type":"integer","format":"int32","description":"Maximum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true"},"constrainPaidTimeGranularity":{"type":"boolean","description":"Whether paid time granularity should be constrained for this workplan"},"paidTimeGranularityMinutes":{"type":"integer","format":"int32","description":"Granularity in minutes allowed for shift paid time in this work plan. Used if constrainPaidTimeGranularity == true"},"constrainMinimumTimeBetweenShifts":{"type":"boolean","description":"Whether the minimum time between shifts constraint is enabled for this work plan"},"minimumTimeBetweenShiftsMinutes":{"type":"integer","format":"int32","description":"Minimum time between shifts in minutes defined in this work plan. Used if constrainMinimumTimeBetweenShifts == true"},"maximumDays":{"type":"integer","format":"int32","description":"Maximum number days in a week allowed to be scheduled for this work plan"},"minimumConsecutiveNonWorkingMinutesPerWeek":{"type":"integer","format":"int32","description":"Minimum amount of consecutive non working minutes per week that agents who are assigned this work plan are allowed to have off"},"constrainMaximumConsecutiveWorkingWeekends":{"type":"boolean","description":"Whether to constrain the maximum consecutive working weekends"},"maximumConsecutiveWorkingWeekends":{"type":"integer","format":"int32","description":"The maximum number of consecutive weekends that agents who are assigned to this work plan are allowed to work"},"minimumWorkingDaysPerWeek":{"type":"integer","format":"int32","description":"The minimum number of days that agents assigned to a work plan must work per week"},"constrainMaximumConsecutiveWorkingDays":{"type":"boolean","description":"Whether to constrain the maximum consecutive working days"},"maximumConsecutiveWorkingDays":{"type":"integer","format":"int32","description":"The maximum number of consecutive days that agents assigned to this work plan are allowed to work. Used if constrainMaximumConsecutiveWorkingDays == true"},"minimumShiftStartDistanceMinutes":{"type":"integer","format":"int32","description":"The time period in minutes for the duration between the start times of two consecutive working days"},"minimumDaysOffPerPlanningPeriod":{"type":"integer","format":"int32","description":"Minimum days off in the planning period"},"maximumDaysOffPerPlanningPeriod":{"type":"integer","format":"int32","description":"Maximum days off in the planning period"},"minimumPaidMinutesPerPlanningPeriod":{"type":"integer","format":"int32","description":"Minimum paid minutes in the planning period"},"maximumPaidMinutesPerPlanningPeriod":{"type":"integer","format":"int32","description":"Maximum paid minutes in the planning period"},"optionalDays":{"description":"Optional days to schedule for this work plan","$ref":"#/definitions/SetWrapperDayOfWeek"},"shiftStartVarianceType":{"type":"string","description":"This constraint ensures that an agent starts each workday within a user-defined time threshold","enum":["ShiftStart","ShiftStartAndPaidDuration"],"x-genesys-enum-members":[{"name":"ShiftStart"},{"name":"ShiftStartAndPaidDuration"}]},"shiftStartVariances":{"description":"Variance in minutes among start times of shifts in this work plan","$ref":"#/definitions/ListWrapperShiftStartVariance"},"shifts":{"type":"array","description":"Shifts in this work plan","items":{"$ref":"#/definitions/CreateWorkPlanShift"}},"agents":{"type":"array","description":"Agents in this work plan","items":{"$ref":"#/definitions/UserReference"}}},"description":"Work plan information"},"CreateWorkPlanActivity":{"type":"object","properties":{"activityCodeId":{"type":"string","description":"ID of the activity code associated with this activity"},"description":{"type":"string","description":"Description of the activity"},"lengthMinutes":{"type":"integer","format":"int32","description":"Length of the activity in minutes"},"startTimeIsRelativeToShiftStart":{"type":"boolean","description":"Whether the start time of the activity is relative to the start time of the shift it belongs to"},"flexibleStartTime":{"type":"boolean","description":"Whether the start time of the activity is flexible"},"earliestStartTimeMinutes":{"type":"integer","format":"int32","description":"Earliest activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == true"},"latestStartTimeMinutes":{"type":"integer","format":"int32","description":"Latest activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == true"},"exactStartTimeMinutes":{"type":"integer","format":"int32","description":"Exact activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == false"},"startTimeIncrementMinutes":{"type":"integer","format":"int32","description":"Increment in offset minutes that would contribute to different possible start times for the activity"},"countsAsPaidTime":{"type":"boolean","description":"Whether the activity is paid"},"countsAsContiguousWorkTime":{"type":"boolean","description":"Whether the activity duration is counted towards contiguous work time"},"minimumLengthFromShiftStartMinutes":{"type":"integer","format":"int32","description":"The minimum duration between shift start and shift item (e.g., break or meal) start in minutes"},"minimumLengthFromShiftEndMinutes":{"type":"integer","format":"int32","description":"The minimum duration between shift item (e.g., break or meal) end and shift end in minutes"}},"description":"Activity configured for shift in work plan"},"CreateWorkPlanShift":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name of the shift"},"days":{"description":"Days of the week applicable for this shift","$ref":"#/definitions/SetWrapperDayOfWeek"},"flexibleStartTime":{"type":"boolean","description":"Whether the start time of the shift is flexible"},"exactStartTimeMinutesFromMidnight":{"type":"integer","format":"int32","description":"Exact start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == false"},"earliestStartTimeMinutesFromMidnight":{"type":"integer","format":"int32","description":"Earliest start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == true"},"latestStartTimeMinutesFromMidnight":{"type":"integer","format":"int32","description":"Latest start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == true"},"constrainStopTime":{"type":"boolean","description":"Whether the latest stop time constraint for the shift is enabled. Deprecated, use constrainLatestStopTime instead"},"constrainLatestStopTime":{"type":"boolean","description":"Whether the latest stop time constraint for the shift is enabled"},"latestStopTimeMinutesFromMidnight":{"type":"integer","format":"int32","description":"Latest stop time of the shift defined as offset minutes from midnight. Used if constrainStopTime == true"},"constrainEarliestStopTime":{"type":"boolean","description":"Whether the earliest stop time constraint for the shift is enabled"},"earliestStopTimeMinutesFromMidnight":{"type":"integer","format":"int32","description":"This is the earliest time a shift can end"},"startIncrementMinutes":{"type":"integer","format":"int32","description":"Increment in offset minutes that would contribute to different possible start times for the shift. Used if flexibleStartTime == true"},"flexiblePaidTime":{"type":"boolean","description":"Whether the paid time setting for the shift is flexible"},"exactPaidTimeMinutes":{"type":"integer","format":"int32","description":"Exact paid time in minutes configured for the shift. Used if flexiblePaidTime == false"},"minimumPaidTimeMinutes":{"type":"integer","format":"int32","description":"Minimum paid time in minutes configured for the shift. Used if flexiblePaidTime == true"},"maximumPaidTimeMinutes":{"type":"integer","format":"int32","description":"Maximum paid time in minutes configured for the shift. Used if flexiblePaidTime == true"},"constrainContiguousWorkTime":{"type":"boolean","description":"Whether the contiguous time constraint for the shift is enabled"},"minimumContiguousWorkTimeMinutes":{"type":"integer","format":"int32","description":"Minimum contiguous time in minutes configured for the shift. Used if constrainContiguousWorkTime == true"},"maximumContiguousWorkTimeMinutes":{"type":"integer","format":"int32","description":"Maximum contiguous time in minutes configured for the shift. Used if constrainContiguousWorkTime == true"},"activities":{"type":"array","description":"Activities configured for this shift","items":{"$ref":"#/definitions/CreateWorkPlanActivity"}}},"description":"Shift in a work plan"},"WorkPlanListItemResponse":{"type":"object","required":["metadata"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"enabled":{"type":"boolean","description":"Whether the work plan is enabled for scheduling"},"constrainWeeklyPaidTime":{"type":"boolean","description":"Whether the weekly paid time constraint is enabled for this work plan"},"flexibleWeeklyPaidTime":{"type":"boolean","description":"Whether the weekly paid time constraint is flexible for this work plan"},"weeklyExactPaidMinutes":{"type":"integer","format":"int32","description":"Exact weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == false"},"weeklyMinimumPaidMinutes":{"type":"integer","format":"int32","description":"Minimum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true"},"weeklyMaximumPaidMinutes":{"type":"integer","format":"int32","description":"Maximum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true"},"constrainPaidTimeGranularity":{"type":"boolean","description":"Whether paid time granularity is constrained for this work plan"},"paidTimeGranularityMinutes":{"type":"integer","format":"int32","description":"Granularity in minutes allowed for shift paid time in this work plan. Used if constrainPaidTimeGranularity == true"},"constrainMinimumTimeBetweenShifts":{"type":"boolean","description":"Whether the minimum time between shifts constraint is enabled for this work plan"},"minimumTimeBetweenShiftsMinutes":{"type":"integer","format":"int32","description":"Minimum time between shifts in minutes defined in this work plan. Used if constrainMinimumTimeBetweenShifts == true"},"maximumDays":{"type":"integer","format":"int32","description":"Maximum number days in a week allowed to be scheduled for this work plan"},"minimumConsecutiveNonWorkingMinutesPerWeek":{"type":"integer","format":"int32","description":"Minimum amount of consecutive non working minutes per week that agents who are assigned this work plan are allowed to have off"},"constrainMaximumConsecutiveWorkingWeekends":{"type":"boolean","description":"Whether to constrain the maximum consecutive working weekends"},"maximumConsecutiveWorkingWeekends":{"type":"integer","format":"int32","description":"The maximum number of consecutive weekends that agents who are assigned to this work plan are allowed to work"},"minimumWorkingDaysPerWeek":{"type":"integer","format":"int32","description":"The minimum number of days that agents assigned to a work plan must work per week"},"constrainMaximumConsecutiveWorkingDays":{"type":"boolean","description":"Whether to constrain the maximum consecutive working days"},"maximumConsecutiveWorkingDays":{"type":"integer","format":"int32","description":"The maximum number of consecutive days that agents assigned to this work plan are allowed to work. Used if constrainMaximumConsecutiveWorkingDays == true"},"minimumShiftStartDistanceMinutes":{"type":"integer","format":"int32","description":"The time period in minutes for the duration between the start times of two consecutive working days"},"minimumDaysOffPerPlanningPeriod":{"type":"integer","format":"int32","description":"Minimum days off in the planning period"},"maximumDaysOffPerPlanningPeriod":{"type":"integer","format":"int32","description":"Maximum days off in the planning period"},"minimumPaidMinutesPerPlanningPeriod":{"type":"integer","format":"int32","description":"Minimum paid minutes in the planning period"},"maximumPaidMinutesPerPlanningPeriod":{"type":"integer","format":"int32","description":"Maximum paid minutes in the planning period"},"optionalDays":{"description":"Optional days to schedule for this work plan. Populate with expand=details","$ref":"#/definitions/SetWrapperDayOfWeek"},"shiftStartVarianceType":{"type":"string","description":"This constraint ensures that an agent starts each workday within a user-defined time threshold","enum":["ShiftStart","ShiftStartAndPaidDuration"],"x-genesys-enum-members":[{"name":"ShiftStart"},{"name":"ShiftStartAndPaidDuration"}]},"shiftStartVariances":{"description":"Variance in minutes among start times of shifts in this work plan. Populate with expand=details","$ref":"#/definitions/ListWrapperShiftStartVariance"},"shifts":{"type":"array","description":"Shifts in this work plan. Populate with expand=details (defaults to empty list)","items":{"$ref":"#/definitions/WorkPlanShift"}},"agents":{"type":"array","description":"Agents in this work plan. Populate with expand=details (defaults to empty list)","items":{"$ref":"#/definitions/DeletableUserReference"}},"metadata":{"description":"Version metadata for this work plan","$ref":"#/definitions/WfmVersionedEntityMetadata"},"agentCount":{"type":"integer","format":"int32","description":"Number of agents in this work plan. Populate with expand=agentCount"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Work plan information"},"WorkPlanListResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WorkPlanListItemResponse"}}}},"ScorableSurvey":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"surveyForm":{"description":"Survey form used for this survey.","$ref":"#/definitions/SurveyForm"},"status":{"type":"string","enum":["Pending","Sent","InProgress","Finished","OptOut","Error","Expired"],"x-genesys-enum-members":[{"name":"Pending"},{"name":"Sent"},{"name":"InProgress"},{"name":"Finished"},{"name":"OptOut"},{"name":"Error"},{"name":"Expired"}]},"answers":{"$ref":"#/definitions/SurveyScoringSet"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SurveyQuestionGroupScore":{"type":"object","properties":{"questionGroupId":{"type":"string"},"totalScore":{"type":"number","format":"float"},"maxTotalScore":{"type":"number","format":"float"},"markedNA":{"type":"boolean"},"questionScores":{"type":"array","items":{"$ref":"#/definitions/SurveyQuestionScore"}}}},"SurveyQuestionScore":{"type":"object","properties":{"questionId":{"type":"string"},"answerId":{"type":"string"},"score":{"type":"integer","format":"int32"},"markedNA":{"type":"boolean"},"npsScore":{"type":"integer","format":"int32"},"npsTextAnswer":{"type":"string"},"freeTextAnswer":{"type":"string"}}},"SurveyScoringSet":{"type":"object","properties":{"totalScore":{"type":"number","format":"float"},"npsScore":{"type":"integer","format":"int32"},"questionGroupScores":{"type":"array","items":{"$ref":"#/definitions/SurveyQuestionGroupScore"}}}},"WritableEntity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."}}},"UserRecording":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"contentUri":{"type":"string","format":"uri"},"workspace":{"$ref":"#/definitions/DomainEntityRef"},"createdBy":{"$ref":"#/definitions/DomainEntityRef"},"conversation":{"$ref":"#/definitions/Conversation"},"contentLength":{"type":"integer","format":"int64"},"durationMilliseconds":{"type":"integer","format":"int64"},"thumbnails":{"type":"array","items":{"$ref":"#/definitions/DocumentThumbnail"}},"read":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserRecordingEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UserRecording"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"OutboundRoute":{"type":"object","required":["classificationTypes","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"classificationTypes":{"type":"array","description":"The site associated to the outbound route.","items":{"type":"string"}},"enabled":{"type":"boolean"},"distribution":{"type":"string","enum":["SEQUENTIAL","RANDOM"],"x-genesys-enum-members":[{"name":"SEQUENTIAL"},{"name":"RANDOM"}]},"externalTrunkBases":{"type":"array","description":"Trunk base settings of trunkType \"EXTERNAL\". This base must also be set on an edge logical interface for correct routing.","items":{"$ref":"#/definitions/DomainEntityRef"}},"site":{"description":"The site associated to the outbound route.","readOnly":true,"$ref":"#/definitions/Site"},"managed":{"type":"boolean","description":"Is this outbound route being managed remotely.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OutboundRouteEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/OutboundRoute"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ReportRunEntry":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"reportId":{"type":"string"},"runTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"runStatus":{"type":"string","enum":["RUNNING","COMPLETED","COMPLETED_WITH_ERRORS","FAILED","FAILED_TIMEOUT","FAILED_DATALIMIT","UNABLE_TO_COMPLETE"],"x-genesys-enum-members":[{"name":"RUNNING"},{"name":"COMPLETED"},{"name":"COMPLETED_WITH_ERRORS"},{"name":"FAILED"},{"name":"FAILED_TIMEOUT"},{"name":"FAILED_DATALIMIT"},{"name":"UNABLE_TO_COMPLETE"}]},"errorMessage":{"type":"string"},"runDurationMsec":{"type":"integer","format":"int64"},"reportUrl":{"type":"string"},"reportFormat":{"type":"string"},"scheduleUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"MessagingCampaignDivisionView":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AdherenceSettings":{"type":"object","properties":{"severeAlertThresholdMinutes":{"type":"integer","format":"int32","description":"The threshold in minutes where an alert will be triggered when an agent is considered severely out of adherence"},"adherenceTargetPercent":{"type":"integer","format":"int32","description":"Target adherence percentage"},"adherenceExceptionThresholdSeconds":{"type":"integer","format":"int32","description":"The threshold in seconds for which agents should not be penalized for being momentarily out of adherence"},"nonOnQueueActivitiesEquivalent":{"type":"boolean","description":"Whether to treat all non-on-queue activities as equivalent for adherence purposes"},"trackOnQueueActivity":{"type":"boolean","description":"Whether to track on-queue activities"},"ignoredActivityCategories":{"description":"Activity categories that should be ignored for adherence purposes","$ref":"#/definitions/IgnoredActivityCategories"}},"description":"Schedule Adherence Configuration"},"IgnoredActivityCategories":{"type":"object","properties":{"values":{"type":"array","description":"Activity categories list","items":{"type":"string","enum":["OnQueueWork","Break","Meal","Meeting","OffQueueWork","TimeOff","Training","Unavailable","Unscheduled"],"x-genesys-enum-members":[{"name":"OnQueueWork"},{"name":"Break"},{"name":"Meal"},{"name":"Meeting"},{"name":"OffQueueWork"},{"name":"TimeOff"},{"name":"Training"},{"name":"Unavailable"},{"name":"Unscheduled"}]}}}},"ManagementUnit":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"businessUnit":{"description":"The business unit to which this management unit belongs","$ref":"#/definitions/BusinessUnitReference"},"startDayOfWeek":{"type":"string","description":"Start day of week for scheduling and forecasting purposes. Moving to Business Unit","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"x-genesys-enum-members":[{"name":"Sunday"},{"name":"Monday"},{"name":"Tuesday"},{"name":"Wednesday"},{"name":"Thursday"},{"name":"Friday"},{"name":"Saturday"}]},"timeZone":{"type":"string","description":"The time zone for the management unit in standard Olson format. Moving to Business Unit"},"settings":{"description":"The configuration settings for this management unit","$ref":"#/definitions/ManagementUnitSettingsResponse"},"metadata":{"description":"Version info metadata for this management unit. Deprecated, use settings.metadata","$ref":"#/definitions/WfmVersionedEntityMetadata"},"version":{"type":"integer","format":"int32","description":"The version of the underlying entity. Deprecated, use field from settings.metadata instead","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date and time at which this entity was last modified. Deprecated, use field from settings.metadata instead. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"description":"The user who last modified this entity. Deprecated, use field from settings.metadata instead","readOnly":true,"$ref":"#/definitions/UserReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Management Unit object for Workforce Management"},"ManagementUnitListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ManagementUnit"}},"pageSize":{"type":"integer","format":"int32","description":"Deprecated, paging is not supported"},"pageNumber":{"type":"integer","format":"int32","description":"Deprecated, paging is not supported"},"total":{"type":"integer","format":"int64","description":"Deprecated, paging is not supported"},"firstUri":{"type":"string","format":"uri","description":"Deprecated, paging is not supported"},"nextUri":{"type":"string","format":"uri","description":"Deprecated, paging is not supported"},"pageCount":{"type":"integer","format":"int32","description":"Deprecated, paging is not supported"},"lastUri":{"type":"string","format":"uri","description":"Deprecated, paging is not supported"},"previousUri":{"type":"string","format":"uri","description":"Deprecated, paging is not supported"},"selfUri":{"type":"string","format":"uri"}}},"ManagementUnitSettingsResponse":{"type":"object","required":["metadata"],"properties":{"adherence":{"description":"Adherence settings for this management unit","$ref":"#/definitions/AdherenceSettings"},"shortTermForecasting":{"description":"Short term forecasting settings for this management unit","$ref":"#/definitions/ShortTermForecastingSettings"},"timeOff":{"description":"Time off request settings for this management unit","$ref":"#/definitions/TimeOffRequestSettings"},"scheduling":{"description":"Scheduling settings for this management unit","$ref":"#/definitions/SchedulingSettingsResponse"},"shiftTrading":{"description":"Shift trade settings for this management unit","$ref":"#/definitions/ShiftTradeSettings"},"metadata":{"description":"Version info metadata for the associated management unit","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"PlanningPeriodSettings":{"type":"object","required":["startDate","weekCount"],"properties":{"weekCount":{"type":"integer","format":"int32","description":"Planning period length in weeks"},"startDate":{"type":"string","format":"date","description":"Start date of the planning period in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"}}},"SchedulingSettingsResponse":{"type":"object","properties":{"maxOccupancyPercentForDeferredWork":{"type":"integer","format":"int32","description":"Max occupancy percent for deferred work"},"defaultShrinkagePercent":{"type":"number","format":"double","description":"Default shrinkage percent for scheduling"},"shrinkageOverrides":{"description":"Shrinkage overrides for scheduling","$ref":"#/definitions/ShrinkageOverrides"},"planningPeriod":{"description":"Planning period settings for scheduling","$ref":"#/definitions/PlanningPeriodSettings"},"startDayOfWeekend":{"type":"string","description":"Start day of weekend for scheduling","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"x-genesys-enum-members":[{"name":"Sunday"},{"name":"Monday"},{"name":"Tuesday"},{"name":"Wednesday"},{"name":"Thursday"},{"name":"Friday"},{"name":"Saturday"}]}},"description":"Scheduling Settings"},"ShiftTradeActivityRule":{"type":"object","required":["action","activityCategory"],"properties":{"activityCategory":{"type":"string","description":"The activity category to which to apply this rule","enum":["OnQueueWork","Break","Meal","Meeting","OffQueueWork","TimeOff","Training","Unavailable","Unscheduled"],"x-genesys-enum-members":[{"name":"OnQueueWork"},{"name":"Break"},{"name":"Meal"},{"name":"Meeting"},{"name":"OffQueueWork"},{"name":"TimeOff"},{"name":"Training"},{"name":"Unavailable"},{"name":"Unscheduled"}]},"action":{"type":"string","description":"The action this rule invokes","enum":["Replace","DoNotAllowTrade","KeepWithSchedule"],"x-genesys-enum-members":[{"name":"Replace"},{"name":"DoNotAllowTrade"},{"name":"KeepWithSchedule"}]},"activityCodeIdReplacement":{"type":"string","description":"The activity code ID with which to replace activities belonging to the original category if applicable (required if action == Replace, must be a default activity code ID)"}}},"ShiftTradeSettings":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether shift trading is enabled for this management unit"},"autoReview":{"type":"boolean","description":"Whether automatic shift trade review is enabled according to the rules defined in for this management unit"},"allowDirectTrades":{"type":"boolean","description":"Whether direct shift trades between agents are allowed"},"minHoursInFuture":{"type":"integer","format":"int32","description":"The minimum number of hours in the future shift trades are allowed"},"unequalPaid":{"type":"string","description":"How to handle shift trades which involve unequal paid times","enum":["Allow","Disallow","AdminReview"],"x-genesys-enum-members":[{"name":"Allow"},{"name":"Disallow"},{"name":"AdminReview"}]},"oneSided":{"type":"string","description":"How to handle one-sided shift trades","enum":["Allow","Disallow","AdminReview"],"x-genesys-enum-members":[{"name":"Allow"},{"name":"Disallow"},{"name":"AdminReview"}]},"weeklyMinPaidViolations":{"type":"string","description":"How to handle shift trades which result in violations of weekly minimum paid time constraint","enum":["Allow","Disallow","AdminReview"],"x-genesys-enum-members":[{"name":"Allow"},{"name":"Disallow"},{"name":"AdminReview"}]},"weeklyMaxPaidViolations":{"type":"string","description":"How to handle shift trades which result in violations of weekly maximum paid time constraint","enum":["Allow","Disallow","AdminReview"],"x-genesys-enum-members":[{"name":"Allow"},{"name":"Disallow"},{"name":"AdminReview"}]},"requiresMatchingQueues":{"type":"boolean","description":"Whether to constrain shift trades to agents with matching queues"},"requiresMatchingLanguages":{"type":"boolean","description":"Whether to constrain shift trades to agents with matching languages"},"requiresMatchingSkills":{"type":"boolean","description":"Whether to constrain shift trades to agents with matching skills"},"requiresMatchingPlanningGroups":{"type":"boolean","description":"Whether to constrain shift trades to agents with matching planning groups"},"activityCategoryRules":{"type":"array","description":"Rules that specify what to do with activity categories that are part of a shift defined in a trade","items":{"$ref":"#/definitions/ShiftTradeActivityRule"}}}},"ShortTermForecastingSettings":{"type":"object","properties":{"defaultHistoryWeeks":{"type":"integer","format":"int32","description":"The number of weeks to consider by default when generating a volume forecast"}},"description":"Short Term Forecasting Settings"},"ShrinkageOverride":{"type":"object","required":["intervalIndex"],"properties":{"intervalIndex":{"type":"integer","format":"int32","description":"Index of shrinkage override interval. Starting index is 0 and indexes are based on 15 minute intervals for a 7 day week"},"shrinkagePercent":{"type":"number","format":"double","description":"Shrinkage override percent. Setting a null value will reset the interval to the default"}}},"ShrinkageOverrides":{"type":"object","properties":{"clear":{"type":"boolean","description":"Set true to clear the shrinkage interval overrides"},"values":{"type":"array","description":"List of interval shrinkage overrides","items":{"$ref":"#/definitions/ShrinkageOverride"}}}},"TimeOffRequestSettings":{"type":"object","properties":{"submissionRangeEnforced":{"type":"boolean","description":"Whether to enforce a submission range for agent time off requests"},"submissionEarliestDaysFromNow":{"type":"integer","format":"int32","description":"The earliest number of days from now for which an agent can submit a time off request. Use negative numbers to indicate days in the past"},"submissionLatestDaysFromNow":{"type":"integer","format":"int32","description":"The latest number of days from now for which an agent can submit a time off request"}},"description":"Time Off Request Settings"},"ScimServiceProviderConfig":{"type":"object","properties":{"schemas":{"type":"array","description":"The list of supported schemas.","readOnly":true,"items":{"type":"string"}},"documentationUri":{"type":"string","format":"uri","description":"The HTTP-addressable URL that points to the service provider's documentation.","readOnly":true},"patch":{"description":"The \"patch\" configuration options.","readOnly":true,"$ref":"#/definitions/ScimServiceProviderConfigSimpleFeature"},"filter":{"description":"The \"filter\" configuration options.","readOnly":true,"$ref":"#/definitions/ScimServiceProviderConfigFilterFeature"},"etag":{"description":"The \"etag\" configuration options.","readOnly":true,"$ref":"#/definitions/ScimServiceProviderConfigSimpleFeature"},"sort":{"description":"The \"sort\" configuration options.","readOnly":true,"$ref":"#/definitions/ScimServiceProviderConfigSimpleFeature"},"bulk":{"description":"The \"bulk\" configuration options.","readOnly":true,"$ref":"#/definitions/ScimServiceProviderConfigBulkFeature"},"changePassword":{"description":"The \"changePassword\" configuration options.","readOnly":true,"$ref":"#/definitions/ScimServiceProviderConfigSimpleFeature"},"authenticationSchemes":{"type":"array","description":"The list of supported authentication schemes.","readOnly":true,"items":{"$ref":"#/definitions/ScimServiceProviderConfigAuthenticationScheme"}},"meta":{"description":"The metadata of the SCIM resource.","readOnly":true,"$ref":"#/definitions/ScimMetadata"}},"description":"Defines a SCIM service provider's configuration."},"ScimServiceProviderConfigAuthenticationScheme":{"type":"object","required":["description","name","type"],"properties":{"name":{"type":"string","description":"The name of the authentication scheme, for example, HTTP Basic.","readOnly":true},"description":{"type":"string","description":"The description of the authentication scheme.","readOnly":true},"specUri":{"type":"string","format":"uri","description":"The HTTP-addressable URL that points to the authentication scheme's specification.","readOnly":true},"documentationUri":{"type":"string","format":"uri","description":"The HTTP-addressable URL that points to the authentication scheme's usage documentation.","readOnly":true},"type":{"type":"string","description":"The type of authentication scheme.","readOnly":true,"enum":["oauth","oauth2","oauthbearertoken","httpbasic","httpdigest"],"x-genesys-enum-members":[{"name":"oauth"},{"name":"oauth2"},{"name":"oauthbearertoken"},{"name":"httpbasic"},{"name":"httpdigest"}]},"primary":{"type":"boolean","description":"Indicates whether this authentication scheme is the primary method of authentication.","readOnly":true}},"description":"Defines an authentication scheme in the SCIM service provider's configuration."},"ScimServiceProviderConfigBulkFeature":{"type":"object","properties":{"supported":{"type":"boolean","description":"Indicates whether configuration options are supported.","readOnly":true},"maxOperations":{"type":"integer","format":"int32","description":"The maximum number of operations for each bulk request.","readOnly":true},"maxPayloadSize":{"type":"integer","format":"int32","description":"The maximum payload size.","readOnly":true}},"description":"Defines a \"bulk\" request in the SCIM service provider's configuration."},"ScimServiceProviderConfigFilterFeature":{"type":"object","properties":{"supported":{"type":"boolean","description":"Indicates whether configuration options are supported.","readOnly":true},"maxResults":{"type":"integer","format":"int32","description":"The maximum number of results returned from a filtered query.","readOnly":true}},"description":"Defines a \"filter\" request in the SCIM service provider's configuration."},"ScimServiceProviderConfigSimpleFeature":{"type":"object","properties":{"supported":{"type":"boolean","description":"Indicates whether configuration options are supported.","readOnly":true}},"description":"Defines a request in the SCIM service provider's configuration."},"SecurityProfile":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"permissions":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UsageExecutionResult":{"type":"object","properties":{"executionId":{"type":"string","description":"The id of the query execution"},"resultsUri":{"type":"string","description":"URI where the query results can be retrieved"}}},"ApiUsageQuery":{"type":"object","required":["interval"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Date granularity of the results","enum":["Day","Week","Month"],"x-genesys-enum-members":[{"name":"Day"},{"name":"Week"},{"name":"Month"}]},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["OAuthClientId","OrganizationId","UserId","TemplateUri","HttpMethod"],"x-genesys-enum-members":[{"name":"OAuthClientId"},{"name":"OrganizationId"},{"name":"UserId"},{"name":"TemplateUri"},{"name":"HttpMethod"}]}},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Enables retrieving only named metrics. If omitted, all metrics that are available will be returned (like SELECT *).","items":{"type":"string","enum":["Status200","Status300","Status400","Status500","Status429","Requests"],"x-genesys-enum-members":[{"name":"Status200"},{"name":"Status300"},{"name":"Status400"},{"name":"Status500"},{"name":"Status429"},{"name":"Requests"}]}}}},"SchemaQuantityLimits":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"minFieldNameCharacters":{"type":"integer","format":"int32","example":"\"minFieldNameCharacters\":1","description":"The minimum number of schema field name characters allowed.","readOnly":true},"maxFieldNameCharacters":{"type":"integer","format":"int32","example":"\"minFieldNameCharacters\":100","description":"The maximum number of schema field name characters allowed.","readOnly":true},"minFieldDescriptionCharacters":{"type":"integer","format":"int32","example":"\"minFieldDescriptionCharacters\":0","description":"The minimum number of schema field description characters allowed.","readOnly":true},"maxFieldDescriptionCharacters":{"type":"integer","format":"int32","example":"\"maxFieldDescriptionCharacters\":200","description":"The maximum number of schema field description characters allowed.","readOnly":true},"minSchemaNameCharacters":{"type":"integer","format":"int32","example":"\"minSchemaNameCharacters\":1","description":"The minimum number of schema name characters allowed.","readOnly":true},"maxSchemaNameCharacters":{"type":"integer","format":"int32","example":"\"maxSchemaNameCharacters\":50","description":"The maximum number of schema name characters allowed.","readOnly":true},"minSchemaDescriptionCharacters":{"type":"integer","format":"int32","example":"\"minSchemaDescriptionCharacters\":0","description":"The minimum number of schema description characters allowed.","readOnly":true},"maxSchemaDescriptionCharacters":{"type":"integer","format":"int32","example":"\"maxSchemaDescriptionCharacters\":200","description":"The maximum number of schema description characters allowed.","readOnly":true},"maxNumberOfSchemasPerOrg":{"type":"integer","format":"int32","example":"\"maxNumberOfSchemasPerOrg\":20","description":"The maximum number of schema allowed per org.","readOnly":true},"maxNumberOfFieldsPerSchema":{"type":"integer","format":"int32","example":"\"maxNumberOfFieldsPerSchema\":25","description":"The maximum number of schema fields allowed per schema.","readOnly":true},"maxNumberOfFieldsPerOrg":{"type":"integer","format":"int32","example":"\"maxNumberOfFieldsPerOrg\":500","description":"The maximum number of schema fields allowed per organization across all of their schemas.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeTraining":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"dateTriggered":{"type":"string","format":"date-time","description":"Trigger date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateCompleted":{"type":"string","format":"date-time","description":"Training completed date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"status":{"type":"string","description":"Training status.","readOnly":true,"enum":["Queued","InProgress","Succeeded","Failed"],"x-genesys-enum-members":[{"name":"Queued"},{"name":"InProgress"},{"name":"Succeeded"},{"name":"Failed"}]},"languageCode":{"type":"string","description":"Language of the documents that are trained.","readOnly":true},"knowledgeBase":{"description":"Knowledge Base that the training belongs to.","readOnly":true,"$ref":"#/definitions/KnowledgeBase"},"errorMessage":{"type":"string","description":"Any error message during the Training or Promote action.","readOnly":true},"knowledgeDocumentsState":{"type":"string","description":"State of the Trained Documents, which can be one of these Draft, Active, Discarded, Archived.","readOnly":true,"enum":["Draft","Active","Discarded","Archived"],"x-genesys-enum-members":[{"name":"Draft"},{"name":"Active"},{"name":"Discarded"},{"name":"Archived"}]},"datePromoted":{"type":"string","format":"date-time","description":"Trained Documents Promoted date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserDevice":{"type":"object","required":["acceptNotifications","deviceToken","make","model","notificationId","type"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"deviceToken":{"type":"string","description":"device token sent by mobile clients."},"notificationId":{"type":"string","description":"notification id of the device."},"make":{"type":"string","description":"make of the device."},"model":{"type":"string","description":"Device model"},"acceptNotifications":{"type":"boolean","description":"if the device accepts notifications"},"type":{"type":"string","description":"type of the device; ios or android","enum":["android","ios"],"x-genesys-enum-members":[{"name":"android"},{"name":"ios"}]},"sessionHash":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BaseTopicEntitiy":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TopicJob":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"state":{"type":"string","enum":["Running","Completed","Failed"],"x-genesys-enum-members":[{"name":"Running"},{"name":"Completed"},{"name":"Failed"}]},"topics":{"type":"array","items":{"$ref":"#/definitions/BaseTopicEntitiy"}},"createdBy":{"$ref":"#/definitions/AddressableEntityRef"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CreateCallResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CreateCallRequest":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"The phone number to dial."},"callerId":{"type":"string","description":"The caller id phone number for this outbound call."},"callerIdName":{"type":"string","description":"The caller id name for this outbound call."},"callFromQueueId":{"type":"string","description":"The queue ID to call on behalf of."},"callQueueId":{"type":"string","description":"The queue ID to call."},"callUserId":{"type":"string","description":"The user ID to call."},"priority":{"type":"integer","format":"int32","description":"The priority to assign to this call (if calling a queue)."},"languageId":{"type":"string","description":"The language skill ID to use for routing this call (if calling a queue)."},"routingSkillsIds":{"type":"array","description":"The skill ID's to use for routing this call (if calling a queue).","items":{"type":"string"}},"conversationIds":{"type":"array","description":"The list of existing call conversations to merge into a new ad-hoc conference.","items":{"type":"string"}},"participants":{"type":"array","description":"The list of participants to call to create a new ad-hoc conference.","items":{"$ref":"#/definitions/Destination"}},"uuiData":{"type":"string","description":"User to User Information (UUI) data managed by SIP session application."}}},"Destination":{"type":"object","required":["address"],"properties":{"address":{"type":"string","description":"Address or phone number."},"name":{"type":"string"},"userId":{"type":"string"},"queueId":{"type":"string"}}},"ConsultTransferResponse":{"type":"object","required":["destinationParticipantId"],"properties":{"destinationParticipantId":{"type":"string","description":"Participant ID to whom the call is being transferred."}}},"ConsultTransferUpdate":{"type":"object","required":["speakTo"],"properties":{"speakTo":{"type":"string","description":"Determines to whom the initiating participant is speaking.","enum":["DESTINATION","OBJECT","BOTH"],"x-genesys-enum-members":[{"name":"DESTINATION"},{"name":"OBJECT"},{"name":"BOTH"}]}}},"ConsultTransfer":{"type":"object","required":["destination"],"properties":{"speakTo":{"type":"string","description":"Determines to whom the initiating participant is speaking. Defaults to DESTINATION","enum":["DESTINATION","OBJECT","BOTH"],"x-genesys-enum-members":[{"name":"DESTINATION"},{"name":"OBJECT"},{"name":"BOTH"}]},"destination":{"description":"Destination phone number and name.","$ref":"#/definitions/Destination"}}},"CallHistoryConversation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"participants":{"type":"array","description":"The list of participants involved in the conversation.","items":{"$ref":"#/definitions/CallHistoryParticipant"}},"direction":{"type":"string","description":"The direction of the call relating to the current user","enum":["inbound","outbound"],"x-genesys-enum-members":[{"name":"inbound"},{"name":"outbound"}]},"wentToVoicemail":{"type":"boolean","description":"Did the call end in the current user's voicemail"},"missedCall":{"type":"boolean","description":"Did the user not answer this conversation"},"startTime":{"type":"string","format":"date-time","description":"The time the user joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"wasConference":{"type":"boolean","description":"Was this conversation a conference"},"wasCallback":{"type":"boolean","description":"Was this conversation a callback"},"hadScreenShare":{"type":"boolean","description":"Did this conversation have a screen share session"},"hadCobrowse":{"type":"boolean","description":"Did this conversation have a cobrowse session"},"wasOutboundCampaign":{"type":"boolean","description":"Was this conversation associated with an outbound campaign"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CallHistoryConversationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CallHistoryConversation"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CallHistoryParticipant":{"type":"object","properties":{"id":{"type":"string","description":"The unique participant ID."},"name":{"type":"string","description":"The display friendly name of the participant."},"address":{"type":"string","description":"The participant address."},"startTime":{"type":"string","format":"date-time","description":"The time when this participant first joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"purpose":{"type":"string","description":"The participant's purpose. Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr"},"direction":{"type":"string","description":"The participant's direction. Values can be: 'inbound' or 'outbound'","enum":["inbound","outbound"],"x-genesys-enum-members":[{"name":"inbound"},{"name":"outbound"}]},"ani":{"type":"string","description":"The call ANI."},"dnis":{"type":"string","description":"The call DNIS."},"user":{"description":"The PureCloud user for this participant.","$ref":"#/definitions/User"},"queue":{"description":"The PureCloud queue for this participant.","$ref":"#/definitions/Queue"},"group":{"description":"The group involved in the group ring call.","$ref":"#/definitions/Group"},"disconnectType":{"type":"string","description":"The reason the participant was disconnected from the conversation.","enum":["endpoint","client","system","transfer","transfer.conference","transfer.consult","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam"],"x-genesys-enum-members":[{"name":"endpoint"},{"name":"client"},{"name":"system"},{"name":"transfer"},{"name":"transfer.conference"},{"name":"transfer.consult"},{"name":"transfer.forward"},{"name":"transfer.noanswer"},{"name":"transfer.notavailable"},{"name":"transport.failure"},{"name":"error"},{"name":"peer"},{"name":"other"},{"name":"spam"}]},"externalContact":{"description":"The PureCloud external contact","$ref":"#/definitions/ExternalContact"},"externalOrganization":{"description":"The PureCloud external organization","$ref":"#/definitions/ExternalOrganization"},"didInteract":{"type":"boolean","description":"Indicates whether the contact ever connected"},"sipResponseCodes":{"type":"array","description":"Indicates SIP Response codes associated with the participant","items":{"type":"integer","format":"int64"}},"flaggedReason":{"type":"string","description":"The reason specifying why participant flagged the conversation.","enum":["general"],"x-genesys-enum-members":[{"name":"general"}]},"outboundCampaign":{"description":"The outbound campaign associated with the participant","$ref":"#/definitions/Campaign"}}},"ContactAddress":{"type":"object","properties":{"address1":{"type":"string"},"address2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"postalCode":{"type":"string"},"countryCode":{"type":"string"}}},"ExternalContact":{"type":"object","required":["firstName","lastName"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"firstName":{"type":"string","description":"The first name of the contact."},"middleName":{"type":"string"},"lastName":{"type":"string","description":"The last name of the contact."},"salutation":{"type":"string"},"title":{"type":"string"},"workPhone":{"$ref":"#/definitions/PhoneNumber"},"cellPhone":{"$ref":"#/definitions/PhoneNumber"},"homePhone":{"$ref":"#/definitions/PhoneNumber"},"otherPhone":{"$ref":"#/definitions/PhoneNumber"},"workEmail":{"type":"string"},"personalEmail":{"type":"string"},"otherEmail":{"type":"string"},"address":{"$ref":"#/definitions/ContactAddress"},"twitterId":{"$ref":"#/definitions/TwitterId"},"lineId":{"$ref":"#/definitions/LineId"},"whatsAppId":{"$ref":"#/definitions/WhatsAppId"},"facebookId":{"$ref":"#/definitions/FacebookId"},"modifyDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"externalOrganization":{"$ref":"#/definitions/ExternalOrganization"},"surveyOptOut":{"type":"boolean"},"externalSystemUrl":{"type":"string","description":"A string that identifies an external system-of-record resource that may have more detailed information on the contact. It should be a valid URL (including the http/https protocol, port, and path [if any]). The value is automatically trimmed of any leading and trailing whitespace."},"schema":{"description":"The schema defining custom fields for this contact","$ref":"#/definitions/DataSchema"},"customFields":{"type":"object","description":"Custom fields defined in the schema referenced by schemaId and schemaVersion.","additionalProperties":{"type":"object"}},"externalDataSources":{"type":"array","description":"Links to the sources of data (e.g. one source might be a CRM) that contributed data to this record. Read-only, and only populated when requested via expand param.","readOnly":true,"items":{"$ref":"#/definitions/ExternalDataSource"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ExternalOrganization":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"name":{"type":"string","description":"The name of the company."},"companyType":{"type":"string"},"industry":{"type":"string"},"primaryContactId":{"type":"string"},"address":{"$ref":"#/definitions/ContactAddress"},"phoneNumber":{"$ref":"#/definitions/PhoneNumber"},"faxNumber":{"$ref":"#/definitions/PhoneNumber"},"employeeCount":{"type":"integer","format":"int64"},"revenue":{"type":"integer","format":"int64"},"tags":{"type":"array","items":{"type":"string"}},"websites":{"type":"array","items":{"type":"string"}},"tickers":{"type":"array","items":{"$ref":"#/definitions/Ticker"}},"twitterId":{"$ref":"#/definitions/TwitterId"},"externalSystemUrl":{"type":"string","description":"A string that identifies an external system-of-record resource that may have more detailed information on the organization. It should be a valid URL (including the http/https protocol, port, and path [if any]). The value is automatically trimmed of any leading and trailing whitespace."},"modifyDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"trustor":{"$ref":"#/definitions/Trustor"},"schema":{"description":"The schema defining custom fields for this contact","$ref":"#/definitions/DataSchema"},"customFields":{"type":"object","description":"Custom fields defined in the schema referenced by schemaId and schemaVersion.","additionalProperties":{"type":"object"}},"externalDataSources":{"type":"array","description":"Links to the sources of data (e.g. one source might be a CRM) that contributed data to this record. Read-only, and only populated when requested via expand param.","readOnly":true,"items":{"$ref":"#/definitions/ExternalDataSource"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FacebookId":{"type":"object","properties":{"ids":{"type":"array","description":"The set of scopedIds that this person has. Each scopedId is specific to a page or app that the user interacts with.","uniqueItems":true,"items":{"$ref":"#/definitions/FacebookScopedId"}},"displayName":{"type":"string","description":"The displayName of this person's Facebook account. Roughly translates to user.first_name + ' ' + user.last_name in the Facebook API."}},"description":"User information for a Facebook user interacting with a page or app"},"FacebookScopedId":{"type":"object","properties":{"scopedId":{"type":"string","description":"The unique page/app-specific scopedId for the user"}},"description":"Scoped ID for a Facebook user interacting with a page or app"},"LineId":{"type":"object","properties":{"ids":{"type":"array","description":"The set of Line userIds that this person has. Each userId is specific to the Line channel that the user interacts with.","uniqueItems":true,"items":{"$ref":"#/definitions/LineUserId"}},"displayName":{"type":"string","description":"The displayName of this person's account in Line"}},"description":"User information for a Line account"},"LineUserId":{"type":"object","properties":{"userId":{"type":"string","description":"The unique channel-specific userId for the user"}},"description":"Channel-specific User ID for Line accounts"},"PhoneNumber":{"type":"object","properties":{"display":{"type":"string"},"extension":{"type":"integer","format":"int64"},"acceptsSMS":{"type":"boolean"},"userInput":{"type":"string"},"e164":{"type":"string"},"countryCode":{"type":"string"}}},"Ticker":{"type":"object","required":["exchange","symbol"],"properties":{"symbol":{"type":"string","description":"The ticker symbol for this organization. Example: ININ, AAPL, MSFT, etc."},"exchange":{"type":"string","description":"The exchange for this ticker symbol. Examples: NYSE, FTSE, NASDAQ, etc."}}},"TwitterId":{"type":"object","properties":{"id":{"type":"string","description":"twitter user.id_str"},"name":{"type":"string","description":"twitter user.name"},"screenName":{"type":"string","description":"twitter user.screen_name"},"verified":{"type":"boolean","description":"whether this data has been verified using the twitter API","readOnly":true},"profileUrl":{"type":"string","description":"url of user's twitter profile","readOnly":true}},"description":"User information for a twitter account"},"WhatsAppId":{"type":"object","properties":{"phoneNumber":{"description":"The phone number associated with this WhatsApp account","$ref":"#/definitions/PhoneNumber"},"displayName":{"type":"string","description":"The displayName of this person's account in WhatsApp"}},"description":"User information for a WhatsApp account"},"CallConversation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"participants":{"type":"array","description":"The list of participants involved in the conversation.","items":{"$ref":"#/definitions/CallMediaParticipant"}},"otherMediaUris":{"type":"array","description":"The list of other media channels involved in the conversation.","items":{"type":"string","format":"uri"}},"recordingState":{"type":"string","enum":["none","active","paused"],"x-genesys-enum-members":[{"name":"none"},{"name":"active"},{"name":"paused"}]},"maxParticipants":{"type":"integer","format":"int32","description":"If this is a conference conversation, then this field indicates the maximum number of participants allowed to participant in the conference."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CallMediaParticipant":{"type":"object","properties":{"id":{"type":"string","description":"The unique participant ID."},"name":{"type":"string","description":"The display friendly name of the participant."},"address":{"type":"string","description":"The participant address."},"startTime":{"type":"string","format":"date-time","description":"The time when this participant first joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The time when this participant went connected for this media (eg: video connected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startHoldTime":{"type":"string","format":"date-time","description":"The time when this participant's hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"purpose":{"type":"string","description":"The participant's purpose. Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr"},"state":{"type":"string","description":"The participant's state. Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","converting","uploading","transmitting","none"],"x-genesys-enum-members":[{"name":"alerting"},{"name":"dialing"},{"name":"contacting"},{"name":"offering"},{"name":"connected"},{"name":"disconnected"},{"name":"terminated"},{"name":"converting"},{"name":"uploading"},{"name":"transmitting"},{"name":"none"}]},"direction":{"type":"string","description":"The participant's direction. Values can be: 'inbound' or 'outbound'","enum":["inbound","outbound"],"x-genesys-enum-members":[{"name":"inbound"},{"name":"outbound"}]},"disconnectType":{"type":"string","description":"The reason the participant was disconnected from the conversation.","enum":["endpoint","client","system","transfer","transfer.conference","transfer.consult","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam"],"x-genesys-enum-members":[{"name":"endpoint"},{"name":"client"},{"name":"system"},{"name":"transfer"},{"name":"transfer.conference"},{"name":"transfer.consult"},{"name":"transfer.forward"},{"name":"transfer.noanswer"},{"name":"transfer.notavailable"},{"name":"transport.failure"},{"name":"error"},{"name":"peer"},{"name":"other"},{"name":"spam"}]},"held":{"type":"boolean","description":"Value is true when the participant is on hold."},"wrapupRequired":{"type":"boolean","description":"Value is true when the participant requires wrap-up."},"wrapupPrompt":{"type":"string","description":"The wrap-up prompt indicating the type of wrap-up to be performed."},"user":{"description":"The PureCloud user for this participant.","$ref":"#/definitions/DomainEntityRef"},"queue":{"description":"The PureCloud queue for this participant.","$ref":"#/definitions/DomainEntityRef"},"team":{"description":"The PureCloud team for this participant.","$ref":"#/definitions/DomainEntityRef"},"attributes":{"type":"object","description":"A list of ad-hoc attributes for the participant.","additionalProperties":{"type":"string"}},"errorInfo":{"description":"If the conversation ends in error, contains additional error details.","$ref":"#/definitions/ErrorInfo"},"script":{"description":"The Engage script that should be used by this participant.","$ref":"#/definitions/DomainEntityRef"},"wrapupTimeoutMs":{"type":"integer","format":"int32","description":"The amount of time the participant has to complete wrap-up."},"wrapupSkipped":{"type":"boolean","description":"Value is true when the participant has skipped wrap-up."},"alertingTimeoutMs":{"type":"integer","format":"int32","description":"Specifies how long the agent has to answer an interaction before being marked as not responding."},"provider":{"type":"string","description":"The source provider for the communication."},"externalContact":{"description":"If this participant represents an external contact, then this will be the reference for the external contact.","$ref":"#/definitions/DomainEntityRef"},"externalOrganization":{"description":"If this participant represents an external org, then this will be the reference for the external org.","$ref":"#/definitions/DomainEntityRef"},"wrapup":{"description":"Wrapup for this participant, if it has been applied.","$ref":"#/definitions/Wrapup"},"peer":{"type":"string","description":"The peer communication corresponding to a matching leg for this communication."},"flaggedReason":{"type":"string","description":"The reason specifying why participant flagged the conversation.","enum":["general"],"x-genesys-enum-members":[{"name":"general"}]},"journeyContext":{"description":"Journey System data/context that is applicable to this communication. When used for historical purposes, the context should be immutable. When null, there is no applicable Journey System context.","$ref":"#/definitions/JourneyContext"},"conversationRoutingData":{"description":"Information on how a communication should be routed to an agent.","$ref":"#/definitions/ConversationRoutingData"},"startAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"muted":{"type":"boolean","description":"Value is true when the call is muted."},"confined":{"type":"boolean","description":"Value is true when the call is confined."},"recording":{"type":"boolean","description":"Value is true when the call is being recorded."},"recordingState":{"type":"string","description":"The state of the call recording.","enum":["none","active","paused"],"x-genesys-enum-members":[{"name":"none"},{"name":"active"},{"name":"paused"}]},"group":{"description":"The group involved in the group ring call.","$ref":"#/definitions/DomainEntityRef"},"ani":{"type":"string","description":"The call ANI."},"dnis":{"type":"string","description":"The call DNIS."},"documentId":{"type":"string","description":"The ID of the Content Management document if the call is a fax."},"faxStatus":{"description":"Extra fax information if the call is a fax.","$ref":"#/definitions/FaxStatus"},"monitoredParticipantId":{"type":"string","description":"The ID of the participant being monitored when performing a call monitor."},"consultParticipantId":{"type":"string","description":"The ID of the consult transfer target participant when performing a consult transfer."},"uuiData":{"type":"string","description":"User-to-User information which maps to a SIP header field defined in RFC7433. UUI data is used in the Public Switched Telephone Network (PSTN) for use cases described in RFC6567."}}},"MaxParticipants":{"type":"object","properties":{"maxParticipants":{"type":"integer","format":"int32","description":"The maximum number of participants that are allowed on a conversation."}}},"CallCommand":{"type":"object","required":["callNumber"],"properties":{"callNumber":{"type":"string","description":"The phone number to dial for this call."},"phoneColumn":{"type":"string","description":"For a dialer preview or scheduled callback, the phone column associated with the phone number"}}},"SetUuiDataRequest":{"type":"object","properties":{"uuiData":{"type":"string","description":"The value of the uuiData to set."}}},"CallConversationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CallConversation"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"SmsAddress":{"type":"object","properties":{"id":{"type":"string","description":"The id of this address.","readOnly":true},"name":{"type":"string"},"street":{"type":"string","description":"The number and street address where this address is located."},"city":{"type":"string","description":"The city in which this address is in"},"region":{"type":"string","description":"The state or region this address is in"},"postalCode":{"type":"string","description":"The postal code this address is in"},"countryCode":{"type":"string","description":"The ISO country code of this address"},"validated":{"type":"boolean","description":"In some countries, addresses are validated to comply with local regulation. In those countries, if the address you provide does not pass validation, it will not be accepted as an Address. This value will be true if the Address has been validated, or false for countries that don't require validation or if the Address is non-compliant.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DevelopmentActivityAggregateQueryResponseData":{"type":"object","properties":{"interval":{"type":"string","description":"Specifies the range of due dates to be used for filtering. A maximum of 1 year can be specified in the range. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"metrics":{"type":"array","description":"The list of aggregated metrics","items":{"$ref":"#/definitions/DevelopmentActivityAggregateQueryResponseMetric"}}}},"DevelopmentActivityAggregateQueryResponseGroupedData":{"type":"object","properties":{"group":{"type":"object","description":"The group values for this data","additionalProperties":{"type":"string"}},"data":{"type":"array","description":"The metrics in this group","items":{"$ref":"#/definitions/DevelopmentActivityAggregateQueryResponseData"}}}},"DevelopmentActivityAggregateQueryResponseMetric":{"type":"object","properties":{"metric":{"type":"string","description":"The metric this applies to","enum":["nActivities","nPlannedActivities","nInProgressActivities","nCompleteActivities","nOverdueActivities","nInvalidScheduleActivities"],"x-genesys-enum-members":[{"name":"nActivities"},{"name":"nPlannedActivities"},{"name":"nInProgressActivities"},{"name":"nCompleteActivities"},{"name":"nOverdueActivities"},{"name":"nInvalidScheduleActivities"}]},"stats":{"description":"The aggregated values for this metric","$ref":"#/definitions/DevelopmentActivityAggregateQueryResponseStatistics"}}},"DevelopmentActivityAggregateQueryResponseStatistics":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"The count for this metric"}}},"DevelopmentActivityAggregateResponse":{"type":"object","properties":{"results":{"type":"array","description":"The results of the query","items":{"$ref":"#/definitions/DevelopmentActivityAggregateQueryResponseGroupedData"}}}},"DevelopmentActivityAggregateParam":{"type":"object","required":["filter","interval"],"properties":{"interval":{"type":"string","description":"Specifies the range of due dates to be used for filtering. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. 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"},"metrics":{"type":"array","description":"The list of metrics to be returned. If omitted, all metrics are returned.","items":{"type":"string","enum":["nActivities","nPlannedActivities","nInProgressActivities","nCompleteActivities","nOverdueActivities","nInvalidScheduleActivities"],"x-genesys-enum-members":[{"name":"nActivities"},{"name":"nPlannedActivities"},{"name":"nInProgressActivities"},{"name":"nCompleteActivities"},{"name":"nOverdueActivities"},{"name":"nInvalidScheduleActivities"}]}},"groupBy":{"type":"array","description":"Specifies if the aggregated data is combined into a single set of metrics (groupBy is empty or not specified), or contains an element per attendeeId (groupBy is \"attendeeId\")","items":{"type":"string","enum":["attendeeId"],"x-genesys-enum-members":[{"name":"attendeeId"}]}},"filter":{"description":"The filter applied to the data. This is ANDed with the interval parameter.","$ref":"#/definitions/DevelopmentActivityAggregateQueryRequestFilter"}}},"DevelopmentActivityAggregateQueryRequestClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"The logic used to combine the predicates","enum":["And","Or"],"x-genesys-enum-members":[{"name":"And"},{"name":"Or"}]},"predicates":{"type":"array","description":"The list of predicates used to filter the data","items":{"$ref":"#/definitions/DevelopmentActivityAggregateQueryRequestPredicate"}}}},"DevelopmentActivityAggregateQueryRequestFilter":{"type":"object","required":["clauses","type"],"properties":{"type":{"type":"string","description":"The logic used to combine the clauses","enum":["And","Or"],"x-genesys-enum-members":[{"name":"And"},{"name":"Or"}]},"clauses":{"type":"array","description":"The list of clauses used to filter the data. Note that clauses must filter by attendeeId and a maximum of 100 user IDs are allowed","items":{"$ref":"#/definitions/DevelopmentActivityAggregateQueryRequestClause"}}}},"DevelopmentActivityAggregateQueryRequestPredicate":{"type":"object","required":["dimension","value"],"properties":{"dimension":{"type":"string","description":"Each predicates specifies a dimension.","enum":["attendeeId","type","moduleId"],"x-genesys-enum-members":[{"name":"attendeeId"},{"name":"type"},{"name":"moduleId"}]},"value":{"type":"string","description":"Corresponding value for dimensions in predicates. If the dimensions is type, Valid Values: Informational, Coaching"}}},"ActiveAlertCount":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"The count of active alerts for a user."}}},"AuditMessage":{"type":"object","required":["id","level","receivedTimestamp","serviceName","status"],"properties":{"id":{"type":"string","description":"AuditMessage ID."},"user":{"$ref":"#/definitions/AuditUser"},"correlationId":{"type":"string","description":"Correlation ID."},"transactionId":{"type":"string","description":"Transaction ID."},"transactionInitiator":{"type":"boolean","description":"Whether or not this audit can be considered the initiator of the transaction it is a part of."},"application":{"type":"string","description":"The application through which the action of this AuditMessage was initiated."},"serviceName":{"type":"string","description":"The name of the service which sent this AuditMessage."},"level":{"type":"string","description":"The level of this audit. USER or SYSTEM."},"timestamp":{"type":"string","description":"The time at which the action of this AuditMessage was initiated."},"receivedTimestamp":{"type":"string","description":"The time at which this AuditMessage was received."},"status":{"type":"string","description":"The status of the action of this AuditMessage"},"actionContext":{"type":"string","description":"The context of a system-level action"},"action":{"type":"string","description":"A string representing the action that took place"},"changes":{"type":"array","description":"Details about any changes that occurred in this audit","items":{"$ref":"#/definitions/Change"}},"entity":{"$ref":"#/definitions/AuditEntity"},"serviceContext":{"description":"The service-specific context associated with this AuditMessage.","$ref":"#/definitions/ServiceContext"}}},"AuditSearchResult":{"type":"object","properties":{"pageNumber":{"type":"integer","format":"int32","description":"Which page was returned."},"pageSize":{"type":"integer","format":"int32","description":"The number of results in a page."},"total":{"type":"integer","format":"int32","description":"The total number of results."},"pageCount":{"type":"integer","format":"int32","description":"The number of pages of results."},"facetInfo":{"type":"array","items":{"$ref":"#/definitions/FacetInfo"}},"auditMessages":{"type":"array","items":{"$ref":"#/definitions/AuditMessage"}}}},"Entry":{"type":"object","properties":{"value":{"type":"string","description":"A value included in this facet."},"count":{"type":"integer","format":"int32","description":"The number of results with this value."}}},"FacetInfo":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field that was faceted on."},"entries":{"type":"array","description":"The entries resulting from this facet.","items":{"$ref":"#/definitions/Entry"}}}},"ServiceContext":{"type":"object","properties":{"name":{"type":"string","description":"Unused field for the purpose of ensuring a Swagger definition is created for a class with only @JsonIgnore members."}}},"AuditFacet":{"type":"object","required":["name","type"],"properties":{"name":{"type":"string","description":"The name of the field on which to facet."},"type":{"type":"string","description":"The type of the facet, DATE or STRING."}}},"AuditFilter":{"type":"object","required":["name","operator","type","values"],"properties":{"name":{"type":"string","description":"The name of the field by which to filter."},"type":{"type":"string","description":"The type of the filter, DATE or STRING."},"operator":{"type":"string","description":"The operation that the filter performs."},"values":{"type":"array","description":"The values to make the filter comparison against.","items":{"type":"string"}}}},"DialerAuditRequest":{"type":"object","properties":{"queryPhrase":{"type":"string","description":"The word or words to search for."},"queryFields":{"type":"array","description":"The fields in which to search for the queryPhrase.","items":{"type":"string"}},"facets":{"type":"array","description":"The fields to facet on.","items":{"$ref":"#/definitions/AuditFacet"}},"filters":{"type":"array","description":"The fields to filter on.","items":{"$ref":"#/definitions/AuditFilter"}}}},"PromptAsset":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"promptId":{"type":"string","description":"Associated prompt ID","readOnly":true},"language":{"type":"string","description":"Prompt resource language","readOnly":true},"mediaUri":{"type":"string","description":"URI of the resource audio","readOnly":true},"ttsString":{"type":"string","description":"Text to speech of the resource"},"text":{"type":"string","description":"Text of the resource"},"uploadStatus":{"type":"string","description":"Audio upload status","readOnly":true,"enum":["created","uploaded","transcoded","transcodeFailed"],"x-genesys-enum-members":[{"name":"created"},{"name":"uploaded"},{"name":"transcoded"},{"name":"transcodeFailed"}]},"uploadUri":{"type":"string","description":"Upload URI for the resource audio","readOnly":true},"languageDefault":{"type":"boolean","description":"Whether or not this resource locale is the default for the language","readOnly":true},"tags":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"durationSeconds":{"type":"number","format":"double"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PromptAssetCreate":{"type":"object","required":["language"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"promptId":{"type":"string","description":"Associated prompt ID","readOnly":true},"language":{"type":"string","description":"The prompt language."},"mediaUri":{"type":"string","description":"URI of the resource audio","readOnly":true},"ttsString":{"type":"string","description":"Text to speech of the resource"},"text":{"type":"string","description":"Text of the resource"},"uploadStatus":{"type":"string","description":"Audio upload status","readOnly":true,"enum":["created","uploaded","transcoded","transcodeFailed"],"x-genesys-enum-members":[{"name":"created"},{"name":"uploaded"},{"name":"transcoded"},{"name":"transcodeFailed"}]},"uploadUri":{"type":"string","description":"Upload URI for the resource audio","readOnly":true},"languageDefault":{"type":"boolean","description":"Whether or not this resource locale is the default for the language","readOnly":true},"tags":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"durationSeconds":{"type":"number","format":"double"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PromptAssetEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/PromptAsset"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AtzmTimeSlot":{"type":"object","properties":{"earliestCallableTime":{"type":"string","example":"08:00","description":"The earliest time to dial a contact. Valid format is HH:mm"},"latestCallableTime":{"type":"string","example":"21:00","description":"The latest time to dial a contact. Valid format is HH:mm"}}},"AtzmTimeSlotWithTimeZone":{"type":"object","properties":{"earliestCallableTime":{"type":"string","example":"08:00","description":"The earliest time to dial a contact. Valid format is HH:mm"},"latestCallableTime":{"type":"string","example":"21:00","description":"The latest time to dial a contact. Valid format is HH:mm"},"timeZoneId":{"type":"string","example":"America/New York","description":"The time zone to use for contacts that cannot be mapped."}}},"AutomaticTimeZoneMappingSettings":{"type":"object","properties":{"callableWindows":{"type":"array","description":"The time intervals to use for automatic time zone mapping.","items":{"$ref":"#/definitions/CallableWindow"}}}},"CallableWindow":{"type":"object","properties":{"mapped":{"description":"The time interval to place outbound calls, for contacts that can be mapped to a time zone.","$ref":"#/definitions/AtzmTimeSlot"},"unmapped":{"description":"The time interval and time zone to place outbound calls, for contacts that cannot be mapped to a time zone.","$ref":"#/definitions/AtzmTimeSlotWithTimeZone"}}},"OutboundSettings":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"maxCallsPerAgent":{"type":"integer","format":"int32","description":"The maximum number of calls that can be placed per agent on any campaign"},"maxConfigurableCallsPerAgent":{"type":"integer","format":"int32","description":"The maximum number of calls that can be configured to be placed per agent on any campaign","readOnly":true},"maxLineUtilization":{"type":"number","format":"double","description":"The maximum percentage of lines that should be used for Outbound, expressed as a decimal in the range [0.0, 1.0]"},"abandonSeconds":{"type":"number","format":"double","description":"The number of seconds used to determine if a call is abandoned"},"complianceAbandonRateDenominator":{"type":"string","description":"The denominator to be used in determining the compliance abandon rate","enum":["ALL_CALLS","CALLS_THAT_REACHED_QUEUE"],"x-genesys-enum-members":[{"name":"ALL_CALLS"},{"name":"CALLS_THAT_REACHED_QUEUE"}]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OrganizationPresenceEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/OrganizationPresence"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ActionTarget":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"userData":{"type":"array","description":"Additional user data associated with the target in key/value format.","items":{"$ref":"#/definitions/KeyValue"}},"supportedMediaTypes":{"type":"array","description":"Supported media types of the target.","items":{"type":"string","enum":["callback","call","email","generic","messaging","social","webchat"],"x-genesys-enum-members":[{"name":"callback"},{"name":"call"},{"name":"email"},{"name":"generic"},{"name":"messaging"},{"name":"social"},{"name":"webchat"}]}},"state":{"type":"string","description":"Indicates the state of the target.","enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"description":{"type":"string","description":"Description of the target."},"serviceLevel":{"description":"Service Level of the action target. Chat offers for the target will be throttled with the aim of achieving this service level.","$ref":"#/definitions/ServiceLevel"},"shortAbandonThreshold":{"type":"integer","format":"int32","description":"Indicates the non-default short abandon threshold"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"createdDate":{"type":"string","format":"date-time","description":"The date the target was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedDate":{"type":"string","format":"date-time","description":"The date the target was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"ActionTargetListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ActionTarget"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"KeyValue":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","description":"Key for free-form data."},"value":{"type":"string","description":"Value for free-form data."}}},"CallRecord":{"type":"object","properties":{"lastAttempt":{"type":"string","format":"date-time","description":"Timestamp of the last attempt to reach this number. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"lastResult":{"type":"string","description":"Result of the last attempt to reach this number","readOnly":true}}},"ContactColumnTimeZone":{"type":"object","properties":{"timeZone":{"type":"string","description":"Time zone that the column matched to. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"columnType":{"type":"string","description":"Column Type will be either PHONE or ZIP","readOnly":true,"enum":["PHONE","ZIP"],"x-genesys-enum-members":[{"name":"PHONE"},{"name":"ZIP"}]}}},"DialerContact":{"type":"object","required":["contactListId","data"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"contactListId":{"type":"string","description":"The identifier of the contact list containing this contact."},"data":{"type":"object","description":"An ordered map of the contact's columns and corresponding values.","additionalProperties":{"type":"object"}},"callRecords":{"type":"object","description":"A map of call records for the contact phone columns.","readOnly":true,"additionalProperties":{"$ref":"#/definitions/CallRecord"}},"callable":{"type":"boolean","description":"Indicates whether or not the contact can be called."},"phoneNumberStatus":{"type":"object","description":"A map of phone number columns to PhoneNumberStatuses, which indicate if the phone number is callable or not.","additionalProperties":{"$ref":"#/definitions/PhoneNumberStatus"}},"contactColumnTimeZones":{"type":"object","description":"Map containing data about the timezone the contact is mapped to. This will only be populated if the contact list has automatic timezone mapping turned on. The key is the column name. The value is the timezone it mapped to and the type of column: Phone or Zip","readOnly":true,"additionalProperties":{"$ref":"#/definitions/ContactColumnTimeZone"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FilterPreviewResponse":{"type":"object","properties":{"filteredContacts":{"type":"integer","format":"int64"},"totalContacts":{"type":"integer","format":"int64"},"preview":{"type":"array","items":{"$ref":"#/definitions/DialerContact"}}}},"MessageEvaluation":{"type":"object","properties":{"contactColumn":{"type":"string"},"contactAddress":{"type":"string"},"wrapupCodeId":{"type":"string"},"timestamp":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"PhoneNumberStatus":{"type":"object","properties":{"callable":{"type":"boolean","description":"Indicates whether or not a phone number is callable."}}},"ContactListFilter":{"type":"object","required":["contactList","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the list."},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"contactList":{"description":"The contact list the filter is based on.","$ref":"#/definitions/DomainEntityRef"},"clauses":{"type":"array","description":"Groups of conditions to filter the contacts by.","items":{"$ref":"#/definitions/ContactListFilterClause"}},"filterType":{"type":"string","description":"How to join clauses together.","enum":["AND","OR"],"x-genesys-enum-members":[{"name":"AND"},{"name":"OR"}]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ContactListFilterClause":{"type":"object","properties":{"filterType":{"type":"string","description":"How to join predicates together.","enum":["AND","OR"],"x-genesys-enum-members":[{"name":"AND"},{"name":"OR"}]},"predicates":{"type":"array","description":"Conditions to filter the contacts by.","items":{"$ref":"#/definitions/ContactListFilterPredicate"}}}},"ContactListFilterPredicate":{"type":"object","properties":{"column":{"type":"string","description":"Contact list column from the ContactListFilter's contactList."},"columnType":{"type":"string","description":"The type of data in the contact column.","enum":["numeric","alphabetic"],"x-genesys-enum-members":[{"name":"numeric"},{"name":"alphabetic"}]},"operator":{"type":"string","description":"The operator for this ContactListFilterPredicate.","enum":["EQUALS","LESS_THAN","LESS_THAN_EQUALS","GREATER_THAN","GREATER_THAN_EQUALS","CONTAINS","BEGINS_WITH","ENDS_WITH","BEFORE","AFTER","BETWEEN","IN"],"x-genesys-enum-members":[{"name":"EQUALS"},{"name":"LESS_THAN"},{"name":"LESS_THAN_EQUALS"},{"name":"GREATER_THAN"},{"name":"GREATER_THAN_EQUALS"},{"name":"CONTAINS"},{"name":"BEGINS_WITH"},{"name":"ENDS_WITH"},{"name":"BEFORE"},{"name":"AFTER"},{"name":"BETWEEN"},{"name":"IN"}]},"value":{"type":"string","description":"Value with which to compare the contact's data. This could be text, a number, or a relative time. A value for relative time should follow the format PxxDTyyHzzM, where xx, yy, and zz specify the days, hours and minutes. For example, a value of P01DT08H30M corresponds to 1 day, 8 hours, and 30 minutes from now. To specify a time in the past, include a negative sign before each numeric value. For example, a value of P-01DT-08H-30M corresponds to 1 day, 8 hours, and 30 minutes in the past. You can also do things like P01DT00H-30M, which would correspond to 23 hours and 30 minutes from now (1 day - 30 minutes)."},"range":{"description":"A range of values. Required for operators BETWEEN and IN.","$ref":"#/definitions/ContactListFilterRange"},"inverted":{"type":"boolean","description":"Inverts the result of the predicate (i.e., if the predicate returns true, inverting it will return false)."}}},"ContactListFilterRange":{"type":"object","properties":{"min":{"type":"string","description":"The minimum value of the range. Required for the operator BETWEEN."},"max":{"type":"string","description":"The maximum value of the range. Required for the operator BETWEEN."},"minInclusive":{"type":"boolean","description":"Whether or not to include the minimum in the range."},"maxInclusive":{"type":"boolean","description":"Whether or not to include the maximum in the range."},"inSet":{"type":"array","description":"A set of values that the contact data should be in. Required for the IN operator.","uniqueItems":true,"items":{"type":"string"}}}},"ActivityCode":{"type":"object","required":["metadata"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"name":{"type":"string","description":"The name of the activity code. Default activity codes will be created with an empty name"},"isActive":{"type":"boolean","description":"Whether this activity code is active or has been deleted"},"isDefault":{"type":"boolean","description":"Whether this is a default activity code"},"category":{"type":"string","description":"The activity code's category.","enum":["OnQueueWork","Break","Meal","Meeting","OffQueueWork","TimeOff","Training","Unavailable","Unscheduled"],"x-genesys-enum-members":[{"name":"OnQueueWork"},{"name":"Break"},{"name":"Meal"},{"name":"Meeting"},{"name":"OffQueueWork"},{"name":"TimeOff"},{"name":"Training"},{"name":"Unavailable"},{"name":"Unscheduled"}]},"lengthInMinutes":{"type":"integer","format":"int32","description":"The default length of the activity in minutes"},"countsAsPaidTime":{"type":"boolean","description":"Whether an agent is paid while performing this activity"},"countsAsWorkTime":{"type":"boolean","description":"Indicates whether or not the activity should be counted as contiguous work time for calculating daily constraints"},"agentTimeOffSelectable":{"type":"boolean","description":"Whether an agent can select this activity code when creating or editing a time off request. Null if the activity's category is not time off."},"metadata":{"description":"Version metadata for the associated management unit's list of activity codes","$ref":"#/definitions/WfmVersionedEntityMetadata"}},"description":"Activity code data"},"ActivityCodeContainer":{"type":"object","required":["metadata"],"properties":{"activityCodes":{"type":"object","description":"Map of activity code id to activity code","additionalProperties":{"$ref":"#/definitions/ActivityCode"}},"metadata":{"description":"Version metadata for the associated management unit's list of activity codes","$ref":"#/definitions/WfmVersionedEntityMetadata"}},"description":"Container for a map of ActivityCodeId to ActivityCode"},"TrustUser":{"type":"object","required":["version"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"chat":{"$ref":"#/definitions/Chat"},"department":{"type":"string"},"email":{"type":"string"},"primaryContactInfo":{"type":"array","description":"Auto populated from addresses.","readOnly":true,"items":{"$ref":"#/definitions/Contact"}},"addresses":{"type":"array","description":"Email addresses and phone numbers for this user","items":{"$ref":"#/definitions/Contact"}},"state":{"type":"string","description":"The current state for this user.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"title":{"type":"string"},"username":{"type":"string"},"manager":{"$ref":"#/definitions/User"},"images":{"type":"array","items":{"$ref":"#/definitions/UserImage"}},"version":{"type":"integer","format":"int32","description":"Required when updating a user, this value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH."},"certifications":{"type":"array","items":{"type":"string"}},"biography":{"$ref":"#/definitions/Biography"},"employerInfo":{"$ref":"#/definitions/EmployerInfo"},"routingStatus":{"description":"ACD routing status","readOnly":true,"$ref":"#/definitions/RoutingStatus"},"presence":{"description":"Active presence","readOnly":true,"$ref":"#/definitions/UserPresence"},"conversationSummary":{"description":"Summary of conversion statistics for conversation types.","readOnly":true,"$ref":"#/definitions/UserConversationSummary"},"outOfOffice":{"description":"Determine if out of office is enabled","readOnly":true,"$ref":"#/definitions/OutOfOffice"},"geolocation":{"description":"Current geolocation position","readOnly":true,"$ref":"#/definitions/Geolocation"},"station":{"description":"Effective, default, and last station information","readOnly":true,"$ref":"#/definitions/UserStations"},"authorization":{"description":"Roles and permissions assigned to the user","readOnly":true,"$ref":"#/definitions/UserAuthorization"},"profileSkills":{"type":"array","description":"Profile skills possessed by the user","readOnly":true,"items":{"type":"string"}},"locations":{"type":"array","description":"The user placement at each site location.","readOnly":true,"items":{"$ref":"#/definitions/Location"}},"groups":{"type":"array","description":"The groups the user is a member of","readOnly":true,"items":{"$ref":"#/definitions/Group"}},"team":{"description":"The team the user is a member of","readOnly":true,"$ref":"#/definitions/Team"},"skills":{"type":"array","description":"Routing (ACD) skills possessed by the user","readOnly":true,"items":{"$ref":"#/definitions/UserRoutingSkill"}},"languages":{"type":"array","description":"Routing (ACD) languages possessed by the user","readOnly":true,"items":{"$ref":"#/definitions/UserRoutingLanguage"}},"acdAutoAnswer":{"type":"boolean","description":"acd auto answer"},"languagePreference":{"type":"string","description":"preferred language by the user","readOnly":true},"lastTokenIssued":{"$ref":"#/definitions/OAuthLastTokenIssued"},"trustUserDetails":{"$ref":"#/definitions/TrustUserDetails"}}},"TrustUserDetails":{"type":"object","properties":{"dateCreated":{"type":"string","format":"date-time","description":"Date Trust User was added. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"createdBy":{"description":"User that added trusted user.","readOnly":true,"$ref":"#/definitions/OrgUser"}}},"TrustUserEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/TrustUser"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"IpAddressAuthentication":{"type":"object","properties":{"networkWhitelist":{"type":"array","items":{"type":"string"}}}},"Credential":{"type":"object","required":["type"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"type":{"description":"The type of credential.","$ref":"#/definitions/CredentialType"},"credentialFields":{"type":"object","additionalProperties":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CredentialType":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"properties":{"type":"object","description":"Properties describing credentials of this type.","readOnly":true},"displayOrder":{"type":"array","description":"Order in which properties should be displayed in the UI.","readOnly":true,"items":{"type":"string"}},"required":{"type":"array","description":"Properties that are required fields.","readOnly":true,"items":{"type":"string"}}}},"CredentialInfo":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"createdDate":{"type":"string","format":"date-time","description":"Date the credentials were created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedDate":{"type":"string","format":"date-time","description":"Date credentials were last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"type":{"description":"Type of the credentials.","$ref":"#/definitions/CredentialType"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CallbackConversation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"participants":{"type":"array","description":"The list of participants involved in the conversation.","items":{"$ref":"#/definitions/CallbackMediaParticipant"}},"otherMediaUris":{"type":"array","description":"The list of other media channels involved in the conversation.","items":{"type":"string","format":"uri"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CallbackMediaParticipant":{"type":"object","properties":{"id":{"type":"string","description":"The unique participant ID."},"name":{"type":"string","description":"The display friendly name of the participant."},"address":{"type":"string","description":"The participant address."},"startTime":{"type":"string","format":"date-time","description":"The time when this participant first joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The time when this participant went connected for this media (eg: video connected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startHoldTime":{"type":"string","format":"date-time","description":"The time when this participant's hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"purpose":{"type":"string","description":"The participant's purpose. Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr"},"state":{"type":"string","description":"The participant's state. Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","converting","uploading","transmitting","none"],"x-genesys-enum-members":[{"name":"alerting"},{"name":"dialing"},{"name":"contacting"},{"name":"offering"},{"name":"connected"},{"name":"disconnected"},{"name":"terminated"},{"name":"converting"},{"name":"uploading"},{"name":"transmitting"},{"name":"none"}]},"direction":{"type":"string","description":"The participant's direction. Values can be: 'inbound' or 'outbound'","enum":["inbound","outbound"],"x-genesys-enum-members":[{"name":"inbound"},{"name":"outbound"}]},"disconnectType":{"type":"string","description":"The reason the participant was disconnected from the conversation.","enum":["endpoint","client","system","transfer","transfer.conference","transfer.consult","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam"],"x-genesys-enum-members":[{"name":"endpoint"},{"name":"client"},{"name":"system"},{"name":"transfer"},{"name":"transfer.conference"},{"name":"transfer.consult"},{"name":"transfer.forward"},{"name":"transfer.noanswer"},{"name":"transfer.notavailable"},{"name":"transport.failure"},{"name":"error"},{"name":"peer"},{"name":"other"},{"name":"spam"}]},"held":{"type":"boolean","description":"Value is true when the participant is on hold."},"wrapupRequired":{"type":"boolean","description":"Value is true when the participant requires wrap-up."},"wrapupPrompt":{"type":"string","description":"The wrap-up prompt indicating the type of wrap-up to be performed."},"user":{"description":"The PureCloud user for this participant.","$ref":"#/definitions/DomainEntityRef"},"queue":{"description":"The PureCloud queue for this participant.","$ref":"#/definitions/DomainEntityRef"},"team":{"description":"The PureCloud team for this participant.","$ref":"#/definitions/DomainEntityRef"},"attributes":{"type":"object","description":"A list of ad-hoc attributes for the participant.","additionalProperties":{"type":"string"}},"errorInfo":{"description":"If the conversation ends in error, contains additional error details.","$ref":"#/definitions/ErrorInfo"},"script":{"description":"The Engage script that should be used by this participant.","$ref":"#/definitions/DomainEntityRef"},"wrapupTimeoutMs":{"type":"integer","format":"int32","description":"The amount of time the participant has to complete wrap-up."},"wrapupSkipped":{"type":"boolean","description":"Value is true when the participant has skipped wrap-up."},"alertingTimeoutMs":{"type":"integer","format":"int32","description":"Specifies how long the agent has to answer an interaction before being marked as not responding."},"provider":{"type":"string","description":"The source provider for the communication."},"externalContact":{"description":"If this participant represents an external contact, then this will be the reference for the external contact.","$ref":"#/definitions/DomainEntityRef"},"externalOrganization":{"description":"If this participant represents an external org, then this will be the reference for the external org.","$ref":"#/definitions/DomainEntityRef"},"wrapup":{"description":"Wrapup for this participant, if it has been applied.","$ref":"#/definitions/Wrapup"},"peer":{"type":"string","description":"The peer communication corresponding to a matching leg for this communication."},"flaggedReason":{"type":"string","description":"The reason specifying why participant flagged the conversation.","enum":["general"],"x-genesys-enum-members":[{"name":"general"}]},"journeyContext":{"description":"Journey System data/context that is applicable to this communication. When used for historical purposes, the context should be immutable. When null, there is no applicable Journey System context.","$ref":"#/definitions/JourneyContext"},"conversationRoutingData":{"description":"Information on how a communication should be routed to an agent.","$ref":"#/definitions/ConversationRoutingData"},"startAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"outboundPreview":{"description":"The outbound preview associated with this callback.","$ref":"#/definitions/DialerPreview"},"voicemail":{"description":"The voicemail associated with this callback.","$ref":"#/definitions/Voicemail"},"callbackNumbers":{"type":"array","description":"The list of phone number to use for this callback.","items":{"type":"string"}},"callbackUserName":{"type":"string","description":"The name of the callback target."},"externalCampaign":{"type":"boolean","description":"True if the call for the callback uses external dialing."},"skipEnabled":{"type":"boolean","description":"If true, the callback can be skipped."},"timeoutSeconds":{"type":"integer","format":"int32","description":"Duration in seconds before the callback will be auto-dialed."},"automatedCallbackConfigId":{"type":"string","description":"The id of the config for automatically placing the callback (and handling the disposition). If absent, the callback will not be placed automatically but routed to an agent as per normal."},"callbackScheduledTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"CallbackIdentifier":{"type":"object","required":["id","type"],"properties":{"type":{"type":"string","description":"The type of the associated callback participant","enum":["ACD","EXTERNAL"],"x-genesys-enum-members":[{"name":"ACD"},{"name":"EXTERNAL"}]},"id":{"type":"string","description":"The identifier of the callback"}}},"CreateCallbackResponse":{"type":"object","required":["callbackIdentifiers","conversation"],"properties":{"conversation":{"description":"The conversation associated with the callback","$ref":"#/definitions/DomainEntityRef"},"callbackIdentifiers":{"type":"array","description":"The list of communication identifiers for the callback participants","items":{"$ref":"#/definitions/CallbackIdentifier"}}}},"CreateCallbackCommand":{"type":"object","required":["callbackNumbers"],"properties":{"scriptId":{"type":"string","description":"The identifier of the script to be used for the callback"},"queueId":{"type":"string","description":"The identifier of the queue to be used for the callback. Either queueId or routingData is required."},"routingData":{"description":"The routing data to be used for the callback. Either queueId or routingData is required.","$ref":"#/definitions/RoutingData"},"callbackUserName":{"type":"string","description":"The name of the party to be called back."},"callbackNumbers":{"type":"array","description":"A list of phone numbers for the callback.","items":{"type":"string"}},"callbackScheduledTime":{"type":"string","format":"date-time","example":"2015-01-02T16:59:59.000Z","description":"The scheduled date-time for the callback as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"countryCode":{"type":"string","description":"The country code to be associated with the callback numbers."},"validateCallbackNumbers":{"type":"boolean","description":"Whether or not to validate the callback numbers for phone number format."},"data":{"type":"object","description":"A map of key-value pairs containing additional data that can be associated to the callback. These values will appear in the attributes property on the conversation participant. Example: { \"notes\": \"ready to close the deal!\", \"customerPreferredName\": \"Doc\" }","additionalProperties":{"type":"string"}}}},"RoutingData":{"type":"object","required":["queueId"],"properties":{"queueId":{"type":"string","description":"The identifier of the routing queue"},"languageId":{"type":"string","description":"The identifier of a language to be considered in routing"},"priority":{"type":"integer","format":"int32","description":"The priority for routing"},"skillIds":{"type":"array","description":"A list of skill identifiers to be considered in routing","items":{"type":"string"}},"preferredAgentIds":{"type":"array","description":"A list of agents to be preferred in routing","items":{"type":"string"}},"scoredAgents":{"type":"array","description":"A list of scored agents for routing decisions","items":{"$ref":"#/definitions/ScoredAgent"}}}},"CallbackConversationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CallbackConversation"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CampaignSequence":{"type":"object","required":["campaigns","currentCampaign","status"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"campaigns":{"type":"array","description":"The ordered list of Campaigns that this CampaignSequence will run.","items":{"$ref":"#/definitions/DomainEntityRef"}},"currentCampaign":{"type":"integer","format":"int32","description":"A zero-based index indicating which Campaign this CampaignSequence is currently on.","readOnly":true},"status":{"type":"string","description":"The current status of the CampaignSequence. A CampaignSequence can be turned 'on' or 'off'.","enum":["on","off","complete"],"x-genesys-enum-members":[{"name":"on"},{"name":"off"},{"name":"complete"}]},"stopMessage":{"type":"string","description":"A message indicating if and why a CampaignSequence has stopped unexpectedly.","readOnly":true},"repeat":{"type":"boolean","description":"Indicates if a sequence should repeat from the beginning after the last campaign completes. Default is false."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CampaignSequenceEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CampaignSequence"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ScreenRecordingSessionRequest":{"type":"object","properties":{"state":{"type":"string","description":"The screen recording session's state. Values can be: 'stopped'","enum":["STOPPED"],"x-genesys-enum-members":[{"name":"STOPPED"}]},"archiveDate":{"type":"string","format":"date-time","description":"The screen recording session's archive date. Must be greater than 1 day from now if set. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"deleteDate":{"type":"string","format":"date-time","description":"The screen recording session's delete date. Must be greater than archiveDate if set, otherwise one day from now. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"ScreenRecordingSession":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"user":{"$ref":"#/definitions/User"},"communicationId":{"type":"string","description":"The id of the communication that is being recorded on the conversation"},"conversation":{"$ref":"#/definitions/Conversation"},"startTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ScreenRecordingSessionListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ScreenRecordingSession"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ActionMap":{"type":"object","required":["displayName","pageUrlConditions","triggerWithSegments"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"version":{"type":"integer","format":"int32","description":"The version of the action map."},"isActive":{"type":"boolean","description":"Whether the action map is active."},"displayName":{"type":"string","description":"Display name of the action map."},"triggerWithSegments":{"type":"array","description":"Trigger action map if any segment in the list is assigned to a given customer.","items":{"type":"string"}},"triggerWithEventConditions":{"type":"array","description":"List of event conditions that must be satisfied to trigger the action map.","items":{"$ref":"#/definitions/EventCondition"}},"triggerWithOutcomeProbabilityConditions":{"type":"array","description":"Probability conditions for outcomes that must be satisfied to trigger the action map.","items":{"$ref":"#/definitions/OutcomeProbabilityCondition"}},"pageUrlConditions":{"type":"array","description":"URL conditions that a page must match for web actions to be displayable.","items":{"$ref":"#/definitions/UrlCondition"}},"activation":{"description":"Type of activation.","$ref":"#/definitions/Activation"},"weight":{"type":"integer","format":"int32","description":"Weight of the action map with higher number denoting higher weight."},"action":{"description":"The action that will be executed if this action map is triggered.","$ref":"#/definitions/ActionMapAction"},"actionMapScheduleGroups":{"description":"The action map's associated schedule groups.","$ref":"#/definitions/ActionMapScheduleGroups"},"ignoreFrequencyCap":{"type":"boolean","description":"Override organization-level frequency cap and always offer web engagements from this action map."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"createdDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the action map was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the action map was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startDate":{"type":"string","format":"date-time","description":"Timestamp at which the action map is scheduled to start firing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endDate":{"type":"string","format":"date-time","description":"Timestamp at which the action map is scheduled to stop firing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"ActionMapAction":{"type":"object","properties":{"actionTemplate":{"description":"Action template associated with the action map.","$ref":"#/definitions/ActionMapActionTemplate"},"mediaType":{"type":"string","description":"Media type of action.","enum":["webchat","webMessagingOffer","contentOffer","integrationAction","architectFlow"],"x-genesys-enum-members":[{"name":"webchat"},{"name":"webMessagingOffer"},{"name":"contentOffer"},{"name":"integrationAction"},{"name":"architectFlow"}]},"architectFlowFields":{"description":"Architect Flow Id and input contract.","$ref":"#/definitions/ArchitectFlowFields"}}},"ActionMapActionTemplate":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ActionMapScheduleGroup":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the action maps's associated schedule group."}}},"ActionMapScheduleGroups":{"type":"object","required":["actionMapScheduleGroup"],"properties":{"actionMapScheduleGroup":{"description":"The actions map's associated schedule group.","$ref":"#/definitions/ActionMapScheduleGroup"},"emergencyActionMapScheduleGroup":{"description":"The action map's associated emergency schedule group.","$ref":"#/definitions/ActionMapScheduleGroup"}}},"ActionProperties":{"type":"object","properties":{"webchatPrompt":{"type":"string","description":"Prompt message shown to user, used for webchat type action."},"webchatTitleText":{"type":"string","description":"Title shown to the user, used for webchat type action."},"webchatAcceptText":{"type":"string","description":"Accept button text shown to user, used for webchat type action."},"webchatDeclineText":{"type":"string","description":"Decline button text shown to user, used for webchat type action."},"webchatSurvey":{"description":"Survey provided to the user, used for webchat type action.","$ref":"#/definitions/ActionSurvey"}}},"ActionSurvey":{"type":"object","required":["questions"],"properties":{"questions":{"type":"array","description":"Questions shown to the user.","items":{"$ref":"#/definitions/JourneySurveyQuestion"}}}},"Activation":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Type of activation."},"delayInSeconds":{"type":"integer","format":"int32","description":"Activation delay time amount."}}},"ArchitectFlowFields":{"type":"object","properties":{"architectFlow":{"description":"The architect flow.","$ref":"#/definitions/AddressableEntityRef"},"flowRequestMappings":{"type":"array","description":"Collection of Architect Flow Request Mappings to use.","items":{"$ref":"#/definitions/RequestMapping"}}}},"EventCondition":{"type":"object","required":["key","sessionType","streamType","values"],"properties":{"key":{"type":"string","description":"The event key."},"values":{"type":"array","description":"The event values.","items":{"type":"string"}},"operator":{"type":"string","description":"The comparison operator.","enum":["containsAll","containsAny","notContainsAll","notContainsAny","equal","notEqual","greaterThan","greaterThanOrEqual","lessThan","lessThanOrEqual","startsWith","endsWith"],"x-genesys-enum-members":[{"name":"containsAll"},{"name":"containsAny"},{"name":"notContainsAll"},{"name":"notContainsAny"},{"name":"equal"},{"name":"notEqual"},{"name":"greaterThan"},{"name":"greaterThanOrEqual"},{"name":"lessThan"},{"name":"lessThanOrEqual"},{"name":"startsWith"},{"name":"endsWith"}]},"streamType":{"type":"string","description":"The stream type for which this condition can be satisfied.","enum":["Web","Custom","Conversation"],"x-genesys-enum-members":[{"name":"Web"},{"name":"Custom"},{"name":"Conversation"}]},"sessionType":{"type":"string","description":"The session type for which this condition can be satisfied."},"eventName":{"type":"string","description":"The name of the event for which this condition can be satisfied."}}},"JourneySurveyQuestion":{"type":"object","required":["label"],"properties":{"type":{"type":"string","description":"Type of survey question.","enum":["text","hidden","select","checkbox","textarea"],"x-genesys-enum-members":[{"name":"text"},{"name":"hidden"},{"name":"select"},{"name":"checkbox"},{"name":"textarea"}]},"label":{"type":"string","description":"Label of question."},"customerProperty":{"type":"string","description":"The customer property that the answer maps to.","enum":["givenName","familyName","email","phone","gender","companyName"],"x-genesys-enum-members":[{"name":"givenName"},{"name":"familyName"},{"name":"email"},{"name":"phone"},{"name":"gender"},{"name":"companyName"}]},"choices":{"type":"array","description":"Choices available to user.","items":{"type":"string"}},"isMandatory":{"type":"boolean","description":"Whether answering this question is mandatory."}}},"OutcomeProbabilityCondition":{"type":"object","required":["maximumProbability","outcomeId"],"properties":{"outcomeId":{"type":"string","description":"The outcome ID."},"maximumProbability":{"type":"number","format":"float","description":"Probability value for the selected outcome at or above which the action map will trigger."},"probability":{"type":"number","format":"float","description":"Additional probability condition, where if set, the action map will trigger if the current outcome probability is lower or equal to the value."}}},"UrlCondition":{"type":"object","required":["operator","values"],"properties":{"values":{"type":"array","description":"The URL condition value.","items":{"type":"string"}},"operator":{"type":"string","description":"The comparison operator.","enum":["containsAll","containsAny","notContainsAll","notContainsAny","equal","notEqual","greaterThan","greaterThanOrEqual","lessThan","lessThanOrEqual","startsWith","endsWith"],"x-genesys-enum-members":[{"name":"containsAll"},{"name":"containsAny"},{"name":"notContainsAll"},{"name":"notContainsAny"},{"name":"equal"},{"name":"notEqual"},{"name":"greaterThan"},{"name":"greaterThanOrEqual"},{"name":"lessThan"},{"name":"lessThanOrEqual"},{"name":"startsWith"},{"name":"endsWith"}]}}},"PatchAction":{"type":"object","required":["mediaType"],"properties":{"mediaType":{"type":"string","description":"Media type of action.","enum":["webchat","webMessagingOffer","contentOffer","integrationAction","architectFlow"],"x-genesys-enum-members":[{"name":"webchat"},{"name":"webMessagingOffer"},{"name":"contentOffer"},{"name":"integrationAction"},{"name":"architectFlow"}]},"actionTemplate":{"description":"Action template associated with the action map.","$ref":"#/definitions/ActionMapActionTemplate"},"architectFlowFields":{"description":"Architect Flow Id and input contract.","$ref":"#/definitions/ArchitectFlowFields"}}},"PatchActionMap":{"type":"object","required":["displayName","pageUrlConditions","triggerWithSegments"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"version":{"type":"integer","format":"int32","description":"The version of the action map."},"isActive":{"type":"boolean","description":"Whether the action map is active."},"displayName":{"type":"string","description":"Display name of the action map."},"triggerWithSegments":{"type":"array","description":"Trigger action map if any segment in the list is assigned to a given customer.","items":{"type":"string"}},"triggerWithEventConditions":{"type":"array","description":"List of event conditions that must be satisfied to trigger the action map.","items":{"$ref":"#/definitions/EventCondition"}},"triggerWithOutcomeProbabilityConditions":{"type":"array","description":"Probability conditions for outcomes that must be satisfied to trigger the action map.","items":{"$ref":"#/definitions/OutcomeProbabilityCondition"}},"pageUrlConditions":{"type":"array","description":"URL conditions that a page must match for web actions to be displayable.","items":{"$ref":"#/definitions/UrlCondition"}},"activation":{"description":"Type of activation.","$ref":"#/definitions/Activation"},"weight":{"type":"integer","format":"int32","description":"Weight of the action map with higher number denoting higher weight."},"action":{"description":"The action that will be executed if this action map is triggered.","$ref":"#/definitions/PatchAction"},"actionMapScheduleGroups":{"description":"The action map's associated schedule groups.","$ref":"#/definitions/PatchActionMapScheduleGroups"},"ignoreFrequencyCap":{"type":"boolean","description":"Override organization-level frequency cap and always offer web engagements from this action map."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"createdDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the action map was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the action map was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startDate":{"type":"string","format":"date-time","description":"Timestamp at which the action map is scheduled to start firing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endDate":{"type":"string","format":"date-time","description":"Timestamp at which the action map is scheduled to stop firing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"PatchActionMapScheduleGroups":{"type":"object","required":["actionMapScheduleGroup"],"properties":{"actionMapScheduleGroup":{"description":"The actions map's associated schedule group.","$ref":"#/definitions/ActionMapScheduleGroup"},"emergencyActionMapScheduleGroup":{"description":"The action map's associated emergency schedule group.","$ref":"#/definitions/ActionMapScheduleGroup"}}},"PatchActionProperties":{"type":"object","properties":{"webchatPrompt":{"type":"string","description":"Prompt message shown to user, used for webchat type action."},"webchatTitleText":{"type":"string","description":"Title shown to the user, used for webchat type action."},"webchatAcceptText":{"type":"string","description":"Accept button text shown to user, used for webchat type action."},"webchatDeclineText":{"type":"string","description":"Decline button text shown to user, used for webchat type action."},"webchatSurvey":{"description":"Survey provided to the user, used for webchat type action.","$ref":"#/definitions/PatchActionSurvey"}}},"PatchActionSurvey":{"type":"object","required":["questions"],"properties":{"questions":{"type":"array","description":"Questions shown to the user.","items":{"$ref":"#/definitions/PatchSurveyQuestion"}}}},"PatchSurveyQuestion":{"type":"object","required":["label"],"properties":{"type":{"type":"string","description":"Type of survey question.","enum":["text","hidden","select","checkbox","textarea"],"x-genesys-enum-members":[{"name":"text"},{"name":"hidden"},{"name":"select"},{"name":"checkbox"},{"name":"textarea"}]},"label":{"type":"string","description":"Label of question."},"customerProperty":{"type":"string","description":"The customer property that the answer maps to.","enum":["givenName","familyName","email","phone","gender","companyName"],"x-genesys-enum-members":[{"name":"givenName"},{"name":"familyName"},{"name":"email"},{"name":"phone"},{"name":"gender"},{"name":"companyName"}]},"choices":{"type":"array","description":"Choices available to user.","items":{"type":"string"}},"isMandatory":{"type":"boolean","description":"Whether answering this question is mandatory."}}},"IntegrationConfiguration":{"type":"object","required":["advanced","credentials","name","notes","properties","version"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the integration, used to distinguish this integration from others of the same type."},"version":{"type":"integer","format":"int32","description":"Version number required for updates."},"properties":{"type":"object","description":"Key-value configuration settings described by the schema in the propertiesSchemaUri field."},"advanced":{"type":"object","description":"Advanced configuration described by the schema in the advancedSchemaUri field."},"notes":{"type":"string","description":"Notes about the integration."},"credentials":{"type":"object","description":"Credentials required by the integration. The required keys are indicated in the credentials property of the Integration Type","additionalProperties":{"$ref":"#/definitions/CredentialInfo"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Configuration for an Integration"},"CredentialTypeListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CredentialType"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CreateManagementUnitApiRequest":{"type":"object","required":["businessUnitId","name"],"properties":{"name":{"type":"string","description":"The name of the management unit"},"timeZone":{"type":"string","description":"The default time zone to use for this management unit. Moving to Business Unit"},"startDayOfWeek":{"type":"string","description":"The configured first day of the week for scheduling and forecasting purposes. Moving to Business Unit","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"x-genesys-enum-members":[{"name":"Sunday"},{"name":"Monday"},{"name":"Tuesday"},{"name":"Wednesday"},{"name":"Thursday"},{"name":"Friday"},{"name":"Saturday"}]},"settings":{"description":"The configuration for the management unit. If omitted, reasonable defaults will be assigned","$ref":"#/definitions/CreateManagementUnitSettingsRequest"},"divisionId":{"type":"string","description":"The id of the division to which this management unit belongs. Defaults to home division ID"},"businessUnitId":{"type":"string","description":"The id of the business unit to which this management unit belongs"}},"description":"Create Management Unit"},"CreateManagementUnitSettingsRequest":{"type":"object","properties":{"adherence":{"description":"Adherence settings for this management unit","$ref":"#/definitions/AdherenceSettings"},"shortTermForecasting":{"description":"Short term forecasting settings for this management unit. Moving to Business Unit","$ref":"#/definitions/ShortTermForecastingSettings"},"timeOff":{"description":"Time off request settings for this management unit","$ref":"#/definitions/TimeOffRequestSettings"},"scheduling":{"description":"Scheduling settings for this management unit","$ref":"#/definitions/SchedulingSettingsRequest"},"shiftTrading":{"description":"Shift trade settings for this management unit","$ref":"#/definitions/ShiftTradeSettings"}},"description":"Management Unit Settings"},"SchedulingSettingsRequest":{"type":"object","properties":{"maxOccupancyPercentForDeferredWork":{"type":"integer","format":"int32","description":"Max occupancy percent for deferred work"},"defaultShrinkagePercent":{"type":"number","format":"double","description":"Default shrinkage percent for scheduling"},"shrinkageOverrides":{"description":"Shrinkage overrides for scheduling","$ref":"#/definitions/ShrinkageOverrides"},"planningPeriod":{"description":"Planning period settings for scheduling","$ref":"#/definitions/ValueWrapperPlanningPeriodSettings"},"startDayOfWeekend":{"type":"string","description":"Start day of weekend for scheduling","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"x-genesys-enum-members":[{"name":"Sunday"},{"name":"Monday"},{"name":"Tuesday"},{"name":"Wednesday"},{"name":"Thursday"},{"name":"Friday"},{"name":"Saturday"}]}},"description":"Scheduling Settings"},"ValueWrapperPlanningPeriodSettings":{"type":"object","properties":{"value":{"description":"The value for the associated field","$ref":"#/definitions/PlanningPeriodSettings"}},"description":"An object to provide context to nullable fields in PATCH requests"},"InboundDomain":{"type":"object","required":["mxRecordStatus"],"properties":{"id":{"type":"string","description":"Unique Id of the domain such as: example.com"},"name":{"type":"string"},"mxRecordStatus":{"type":"string","description":"Mx Record Status","enum":["VALID","INVALID","NOT_AVAILABLE"],"x-genesys-enum-members":[{"name":"VALID"},{"name":"INVALID"},{"name":"NOT_AVAILABLE"}]},"subDomain":{"type":"boolean","description":"Indicates if this a PureCloud sub-domain. If true, then the appropriate DNS records are created for sending/receiving email."},"mailFromSettings":{"description":"The DNS settings if the inbound domain is using a custom Mail From. These settings can only be used on InboundDomains where subDomain is false.","$ref":"#/definitions/MailFromResult"},"customSMTPServer":{"description":"The custom SMTP server integration to use when sending outbound emails from this domain.","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"MailFromResult":{"type":"object","required":["mailFromDomain"],"properties":{"status":{"type":"string","description":"The verification status.","enum":["FAILED","PENDING","VERIFIED","UNKNOWN"],"x-genesys-enum-members":[{"name":"FAILED"},{"name":"PENDING"},{"name":"VERIFIED"},{"name":"UNKNOWN"}]},"records":{"type":"array","description":"The list of DNS records that pertain that need to exist for verification.","items":{"$ref":"#/definitions/Record"}},"mailFromDomain":{"type":"string","description":"The custom MAIL FROM domain."}}},"Record":{"type":"object","required":["name","type","value"],"properties":{"name":{"type":"string","description":"The name of the record."},"type":{"type":"string","description":"The type of the record. (Example values: MX, TXT, CNAME)"},"value":{"type":"string","description":"The value of the record."}}},"InboundDomainEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/InboundDomain"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DialogflowAgent":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"project":{"description":"The project this Dialogflow agent belongs to","$ref":"#/definitions/DialogflowProject"},"languages":{"type":"array","description":"The supported languages of the Dialogflow agent","items":{"type":"string"}},"intents":{"type":"array","description":"An array of Intents associated with this agent","items":{"$ref":"#/definitions/DialogflowIntent"}},"environments":{"type":"array","description":"Available environments for this agent","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"VoicemailCopyRecord":{"type":"object","properties":{"user":{"description":"The user that the voicemail message was copied to/from","readOnly":true,"$ref":"#/definitions/User"},"group":{"description":"The group that the voicemail message was copied to/from","readOnly":true,"$ref":"#/definitions/Group"},"date":{"type":"string","format":"date-time","description":"The date when the voicemail was copied. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true}}},"VoicemailMessage":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"conversation":{"description":"The conversation that the voicemail message is associated with","readOnly":true,"$ref":"#/definitions/Conversation"},"read":{"type":"boolean","description":"Whether the voicemail message is marked as read"},"audioRecordingDurationSeconds":{"type":"integer","format":"int32","description":"The voicemail message's audio recording duration in seconds","readOnly":true},"audioRecordingSizeBytes":{"type":"integer","format":"int64","description":"The voicemail message's audio recording size in bytes","readOnly":true},"createdDate":{"type":"string","format":"date-time","description":"The date the voicemail message was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedDate":{"type":"string","format":"date-time","description":"The date the voicemail message was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"deletedDate":{"type":"string","format":"date-time","description":"The date the voicemail message deleted property was set to true. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"callerAddress":{"type":"string","description":"The caller address","readOnly":true},"callerName":{"type":"string","description":"Optionally the name of the caller that left the voicemail message if the caller was a known user","readOnly":true},"callerUser":{"description":"Optionally the user that left the voicemail message if the caller was a known user","readOnly":true,"$ref":"#/definitions/User"},"deleted":{"type":"boolean","description":"Whether the voicemail message has been marked as deleted"},"note":{"type":"string","description":"An optional note"},"user":{"description":"The user that the voicemail message belongs to or null which means the voicemail message belongs to a group or queue","readOnly":true,"$ref":"#/definitions/User"},"group":{"description":"The group that the voicemail message belongs to or null which means the voicemail message belongs to a user or queue","readOnly":true,"$ref":"#/definitions/Group"},"queue":{"description":"The queue that the voicemail message belongs to or null which means the voicemail message belongs to a user or group","readOnly":true,"$ref":"#/definitions/Queue"},"copiedFrom":{"description":"Represents where this voicemail message was copied from","readOnly":true,"$ref":"#/definitions/VoicemailCopyRecord"},"copiedTo":{"type":"array","description":"Represents where this voicemail has been copied to","readOnly":true,"items":{"$ref":"#/definitions/VoicemailCopyRecord"}},"deleteRetentionPolicy":{"description":"The retention policy for this voicemail when deleted is set to true","$ref":"#/definitions/VoicemailRetentionPolicy"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"VoicemailRetentionPolicy":{"type":"object","properties":{"voicemailRetentionPolicyType":{"type":"string","description":"The retention policy type","enum":["RETAIN_INDEFINITELY","RETAIN_WITH_TTL","IMMEDIATE_DELETE"],"x-genesys-enum-members":[{"name":"RETAIN_INDEFINITELY"},{"name":"RETAIN_WITH_TTL"},{"name":"IMMEDIATE_DELETE"}]},"numberOfDays":{"type":"integer","format":"int32","description":"If retentionPolicyType == RETAIN_WITH_TTL, then this value represents the number of days for the TTL"}},"description":"Governs how the voicemail is retained"},"VoicemailMediaInfo":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"mediaFileUri":{"type":"string","format":"uri"},"mediaImageUri":{"type":"string","format":"uri"},"waveformData":{"type":"array","items":{"type":"number","format":"float"}}}},"CallableContactsDiagnostic":{"type":"object","properties":{"attemptLimits":{"description":"Attempt limits for the campaign's contact list","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"dncLists":{"type":"array","description":"Do not call lists for the campaign","readOnly":true,"items":{"$ref":"#/definitions/DomainEntityRef"}},"callableTimeSet":{"description":"Callable time sets for the campaign","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"ruleSets":{"type":"array","description":"Rule sets for the campaign","readOnly":true,"items":{"$ref":"#/definitions/DomainEntityRef"}}}},"CampaignDiagnostics":{"type":"object","properties":{"callableContacts":{"description":"Campaign properties that can impact which contacts are callable","readOnly":true,"$ref":"#/definitions/CallableContactsDiagnostic"},"queueUtilizationDiagnostic":{"description":"Information regarding the campaign's queue","readOnly":true,"$ref":"#/definitions/QueueUtilizationDiagnostic"},"ruleSetDiagnostics":{"type":"array","description":"Information regarding the campaign's rule sets","readOnly":true,"items":{"$ref":"#/definitions/RuleSetDiagnostic"}},"outstandingInteractionsCount":{"type":"integer","format":"int32","description":"Current number of outstanding interactions on the campaign","readOnly":true},"scheduledInteractionsCount":{"type":"integer","format":"int32","description":"Current number of scheduled interactions on the campaign","readOnly":true}}},"QueueUtilizationDiagnostic":{"type":"object","properties":{"queue":{"description":"Identifier of the queue","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"usersInQueue":{"type":"integer","format":"int32","description":"The number of users joined to the queue","readOnly":true},"activeUsersInQueue":{"type":"integer","format":"int32","description":"The number of users active on the queue","readOnly":true},"usersOnQueue":{"type":"integer","format":"int32","description":"The number of users with a status of on-queue","readOnly":true},"usersNotUtilized":{"type":"integer","format":"int32","description":"The number of users in the queue currently not engaged","readOnly":true},"usersOnQueueWithStation":{"type":"integer","format":"int32","description":"The number of users in the queue with a station","readOnly":true},"usersOnACampaignCall":{"type":"integer","format":"int32","description":"The number of users currently engaged in a campaign call","readOnly":true},"usersOnDifferentEdgeGroup":{"type":"integer","format":"int32","description":"The number of users whose station is homed to an edge different from the campaign","readOnly":true},"usersOnANonCampaignCall":{"type":"integer","format":"int32","description":"The number of users currently engaged in a communication that is not part of the campaign","readOnly":true}}},"RuleSetDiagnostic":{"type":"object","properties":{"ruleSet":{"description":"A campaign rule set","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"warnings":{"type":"array","description":"Diagnostic warnings for the rule set","readOnly":true,"items":{"type":"string","enum":["WRAPUP_CODE_NOT_IN_QUEUE","CONTACT_ATTRIBUTE_NOT_IN_CONTACT_LIST","NO_DNC_LIST_FOR_APPEND","PHONE_CONDITIONS_WITH_MULTICOLUMN_PREVIEW"],"x-genesys-enum-members":[{"name":"WRAPUP_CODE_NOT_IN_QUEUE"},{"name":"CONTACT_ATTRIBUTE_NOT_IN_CONTACT_LIST"},{"name":"NO_DNC_LIST_FOR_APPEND"},{"name":"PHONE_CONDITIONS_WITH_MULTICOLUMN_PREVIEW"}]}}}},"AnalyticsConversationSegment":{"type":"object","properties":{"segmentStart":{"type":"string","format":"date-time","description":"The timestamp when this segment began. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"segmentEnd":{"type":"string","format":"date-time","description":"The timestamp when this segment ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"queueId":{"type":"string","description":"Queue identifier"},"wrapUpCode":{"type":"string","description":"Wrapup Code id"},"wrapUpNote":{"type":"string","description":"Note entered by an agent during after-call work"},"wrapUpTags":{"type":"array","items":{"type":"string"}},"errorCode":{"type":"string"},"disconnectType":{"type":"string","description":"A description of the event that disconnected the segment","enum":["endpoint","client","system","transfer","error","peer","other","spam","transportFailure","conferenceTransfer","consultTransfer","forwardTransfer","timeout","noAnswerTransfer","notAvailableTransfer","uncallable"],"x-genesys-enum-members":[{"name":"endpoint"},{"name":"client"},{"name":"system"},{"name":"transfer"},{"name":"error"},{"name":"peer"},{"name":"other"},{"name":"spam"},{"name":"transportFailure"},{"name":"conferenceTransfer"},{"name":"consultTransfer"},{"name":"forwardTransfer"},{"name":"timeout"},{"name":"noAnswerTransfer"},{"name":"notAvailableTransfer"},{"name":"uncallable"}]},"segmentType":{"type":"string","description":"The activity taking place for the participant in the segment","enum":["unknown","alert","system","delay","hold","interact","ivr","dialing","wrapup","voicemail","scheduled","contacting","transmitting","converting","uploading","sharing","callback"],"x-genesys-enum-members":[{"name":"unknown"},{"name":"alert"},{"name":"system"},{"name":"delay"},{"name":"hold"},{"name":"interact"},{"name":"ivr"},{"name":"dialing"},{"name":"wrapup"},{"name":"voicemail"},{"name":"scheduled"},{"name":"contacting"},{"name":"transmitting"},{"name":"converting"},{"name":"uploading"},{"name":"sharing"},{"name":"callback"}]},"requestedRoutingUserIds":{"type":"array","items":{"type":"string"}},"requestedRoutingSkillIds":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"requestedLanguageId":{"type":"string","description":"A unique identifier for the language requested for an interaction."},"scoredAgents":{"type":"array","items":{"$ref":"#/definitions/AnalyticsScoredAgent"}},"properties":{"type":"array","items":{"$ref":"#/definitions/AnalyticsProperty"}},"sourceConversationId":{"type":"string"},"destinationConversationId":{"type":"string"},"sourceSessionId":{"type":"string"},"destinationSessionId":{"type":"string"},"sipResponseCodes":{"type":"array","items":{"type":"integer","format":"int64"}},"q850ResponseCodes":{"type":"array","items":{"type":"integer","format":"int64"}},"conference":{"type":"boolean","description":"Indicates whether the segment was a conference"},"groupId":{"type":"string"},"subject":{"type":"string"},"audioMuted":{"type":"boolean"},"videoMuted":{"type":"boolean"}}},"AnalyticsConversationWithoutAttributes":{"type":"object","properties":{"conversationId":{"type":"string","description":"Unique identifier for the conversation"},"conversationStart":{"type":"string","format":"date-time","description":"Date/time the conversation started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationEnd":{"type":"string","format":"date-time","description":"Date/time the conversation ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"mediaStatsMinConversationMos":{"type":"number","format":"double","description":"The lowest estimated average MOS among all the audio streams belonging to this conversation"},"mediaStatsMinConversationRFactor":{"type":"number","format":"double","description":"The lowest R-factor value among all of the audio streams belonging to this conversation"},"originatingDirection":{"type":"string","description":"The original direction of the conversation","enum":["inbound","outbound"],"x-genesys-enum-members":[{"name":"inbound"},{"name":"outbound"}]},"evaluations":{"type":"array","description":"Evaluations tied to this conversation","items":{"$ref":"#/definitions/AnalyticsEvaluation"}},"surveys":{"type":"array","description":"Surveys tied to this conversation","items":{"$ref":"#/definitions/AnalyticsSurvey"}},"resolutions":{"type":"array","description":"Resolutions tied to this conversation","items":{"$ref":"#/definitions/AnalyticsResolution"}},"divisionIds":{"type":"array","description":"Identifiers of divisions associated with this conversation","items":{"type":"string"}},"participants":{"type":"array","description":"Participants in the conversation","items":{"$ref":"#/definitions/AnalyticsParticipantWithoutAttributes"}}}},"AnalyticsConversationWithoutAttributesMultiGetResponse":{"type":"object","properties":{"conversations":{"type":"array","items":{"$ref":"#/definitions/AnalyticsConversationWithoutAttributes"}}}},"AnalyticsEvaluation":{"type":"object","properties":{"evaluationId":{"type":"string","description":"Unique identifier for the evaluation"},"evaluatorId":{"type":"string","description":"A unique identifier of the PureCloud user who evaluated the interaction"},"userId":{"type":"string","description":"Unique identifier for the user being evaluated"},"eventTime":{"type":"string","format":"date-time","description":"Specifies when an evaluation occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"queueId":{"type":"string","description":"Unique identifier for the queue the conversation was on"},"formId":{"type":"string","description":"Unique identifier for the form used to evaluate the conversation/agent"},"contextId":{"type":"string","description":"A unique identifier for an evaluation form, regardless of version"},"formName":{"type":"string","description":"Name of the evaluation form"},"calibrationId":{"type":"string","description":"The calibration id used for the purpose of training evaluators"},"rescored":{"type":"boolean","description":"Whether this evaluation has ever been rescored"},"deleted":{"type":"boolean","description":"Whether this evaluation has been deleted"},"oTotalCriticalScore":{"type":"integer","format":"int64"},"oTotalScore":{"type":"integer","format":"int64"}}},"AnalyticsFlow":{"type":"object","properties":{"flowId":{"type":"string","description":"The unique identifier of this flow"},"flowName":{"type":"string","description":"The name of this flow"},"flowVersion":{"type":"string","description":"The version of this flow"},"flowType":{"type":"string","description":"The type of this flow","enum":["BOT","COMMONMODULE","INBOUNDCALL","INBOUNDCHAT","INBOUNDEMAIL","INBOUNDSHORTMESSAGE","INQUEUECALL","OUTBOUNDCALL","SECURECALL","SPEECH","SURVEYINVITE","WORKFLOW"],"x-genesys-enum-members":[{"name":"BOT"},{"name":"COMMONMODULE"},{"name":"INBOUNDCALL"},{"name":"INBOUNDCHAT"},{"name":"INBOUNDEMAIL"},{"name":"INBOUNDSHORTMESSAGE"},{"name":"INQUEUECALL"},{"name":"OUTBOUNDCALL"},{"name":"SECURECALL"},{"name":"SPEECH"},{"name":"SURVEYINVITE"},{"name":"WORKFLOW"}]},"exitReason":{"type":"string","description":"The exit reason for this flow, e.g. DISCONNECT"},"entryReason":{"type":"string","description":"The particular entry reason for this flow, e.g. an address, userId, or flowId"},"entryType":{"type":"string","description":"The entry type for this flow","enum":["dnis","direct","flow","agent","outbound"],"x-genesys-enum-members":[{"name":"dnis"},{"name":"direct"},{"name":"flow"},{"name":"agent"},{"name":"outbound"}]},"transferType":{"type":"string","description":"The type of transfer for flows that ended with a transfer"},"transferTargetName":{"type":"string","description":"The name of a transfer target"},"transferTargetAddress":{"type":"string","description":"The address of a transfer target"},"issuedCallback":{"type":"boolean","description":"Flag indicating whether the flow issued a callback"},"startingLanguage":{"type":"string","description":"Flow starting language, e.g. en-us"},"endingLanguage":{"type":"string","description":"Flow ending language, e.g. en-us"},"outcomes":{"type":"array","description":"Flow outcomes","items":{"$ref":"#/definitions/AnalyticsFlowOutcome"}}}},"AnalyticsFlowOutcome":{"type":"object","properties":{"flowOutcomeId":{"type":"string","description":"Unique identifiers of a flow outcome"},"flowOutcomeValue":{"type":"string","description":"Flow outcome value, e.g. SUCCESS"},"flowOutcome":{"type":"string","description":"Colon-separated combinations of unique flow outcome identifier and value"},"flowOutcomeStartTimestamp":{"type":"string","format":"date-time","description":"Date/time the outcome started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"flowOutcomeEndTimestamp":{"type":"string","format":"date-time","description":"Date/time the outcome ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"AnalyticsMediaEndpointStat":{"type":"object","properties":{"codecs":{"type":"array","description":"The MIME types of the audio encodings used by the audio streams belonging to this endpoint","items":{"type":"string"}},"minMos":{"type":"number","format":"double","description":"The lowest estimated average MOS among all the audio streams belonging to this endpoint"},"minRFactor":{"type":"number","format":"double","description":"The lowest R-factor value among all of the audio streams belonging to this endpoint"},"maxLatencyMs":{"type":"integer","format":"int64","description":"The maximum latency experienced by any audio stream belonging to this endpoint, in milliseconds"},"receivedPackets":{"type":"integer","format":"int64","description":"The total number of packets received for all audio streams belonging to this endpoint (includes invalid, duplicate, and discarded packets)"},"invalidPackets":{"type":"integer","format":"int64","description":"The total number of malformed or not RTP packets, unknown payload type, or discarded probation packets for all audio streams belonging to this endpoint"},"discardedPackets":{"type":"integer","format":"int64","description":"The total number of packets received too late or too early, jitter queue overrun or underrun, for all audio streams belonging to this endpoint"},"duplicatePackets":{"type":"integer","format":"int64","description":"The total number of packets received with the same sequence number as another one recently received (window of 64 packets), for all audio streams belonging to this endpoint"},"overrunPackets":{"type":"integer","format":"int64","description":"The total number of packets for which there was no room in the jitter queue when it was received, for all audio streams belonging to this endpoint (also counted in discarded)"},"underrunPackets":{"type":"integer","format":"int64","description":"The total number of packets received after their timestamp/seqnum has been played out, for all audio streams belonging to this endpoint (also counted in discarded)"}}},"AnalyticsParticipantWithoutAttributes":{"type":"object","properties":{"participantId":{"type":"string","description":"Unique identifier for the participant"},"participantName":{"type":"string","description":"A human readable name identifying the participant"},"userId":{"type":"string","description":"If a user, then this will be the unique identifier for the user"},"purpose":{"type":"string","description":"The participant's purpose","enum":["manual","dialer","inbound","acd","ivr","voicemail","outbound","agent","user","station","group","customer","external","fax","workflow","campaign","api"],"x-genesys-enum-members":[{"name":"manual"},{"name":"dialer"},{"name":"inbound"},{"name":"acd"},{"name":"ivr"},{"name":"voicemail"},{"name":"outbound"},{"name":"agent"},{"name":"user"},{"name":"station"},{"name":"group"},{"name":"customer"},{"name":"external"},{"name":"fax"},{"name":"workflow"},{"name":"campaign"},{"name":"api"}]},"externalContactId":{"type":"string","description":"External Contact Identifier"},"externalOrganizationId":{"type":"string","description":"External Organization Identifier"},"flaggedReason":{"type":"string","description":"Reason for which participant flagged conversation","enum":["general"],"x-genesys-enum-members":[{"name":"general"}]},"teamId":{"type":"string","description":"The team id the user is a member of"},"sessions":{"type":"array","description":"List of sessions associated to this participant","items":{"$ref":"#/definitions/AnalyticsSession"}}}},"AnalyticsProperty":{"type":"object","required":["property","propertyType","value"],"properties":{"propertyType":{"type":"string","description":"Indicates what the data type is (e.g. integer vs string) and therefore how to evaluate what would constitute a match","enum":["bool","integer","real","date","string","uuid"],"x-genesys-enum-members":[{"name":"bool"},{"name":"integer"},{"name":"real"},{"name":"date"},{"name":"string"},{"name":"uuid"}]},"property":{"type":"string","description":"User-defined rather than intrinsic system-observed values. These are tagged onto segments by other components within PureCloud or by API users directly. This is the name of the user-defined property."},"value":{"type":"string","description":"What property value to match against"}}},"AnalyticsProposedAgent":{"type":"object","properties":{"proposedAgentId":{"type":"string","description":"Unique identifier of an agent that was proposed by predictive routing"},"agentRank":{"type":"integer","format":"int32","description":"Proposed agent rank for this conversation from predictive routing (lower is better)"}}},"AnalyticsResolution":{"type":"object","properties":{"queueId":{"type":"string","description":"The ID of the last queue on which the conversation was handled."},"userId":{"type":"string","description":"The ID of the last user who handled the conversation."},"getnNextContactAvoided":{"type":"integer","format":"int64","description":"The number of interactions for which next contact was avoided."}}},"AnalyticsScoredAgent":{"type":"object","properties":{"scoredAgentId":{"type":"string","description":"Unique identifier of an agent that was scored for this conversation"},"agentScore":{"type":"integer","format":"int32","description":"Assigned agent score for this conversation (0 - 100, higher being better)"}}},"AnalyticsSession":{"type":"object","properties":{"mediaType":{"type":"string","description":"The session media type","enum":["voice","chat","email","callback","cobrowse","video","screenshare","message"],"x-genesys-enum-members":[{"name":"voice"},{"name":"chat"},{"name":"email"},{"name":"callback"},{"name":"cobrowse"},{"name":"video"},{"name":"screenshare"},{"name":"message"}]},"sessionId":{"type":"string","description":"The unique identifier of this session"},"addressOther":{"type":"string"},"addressSelf":{"type":"string"},"addressFrom":{"type":"string"},"addressTo":{"type":"string"},"messageType":{"type":"string","description":"Message type for messaging services such as sms","enum":["sms","facebook","twitter","line"]},"ani":{"type":"string","description":"Automatic Number Identification (caller's number)"},"direction":{"type":"string","description":"Direction","enum":["inbound","outbound"],"x-genesys-enum-members":[{"name":"inbound"},{"name":"outbound"}]},"dnis":{"type":"string","description":"Dialed number identification service (number dialed by the calling party)"},"sessionDnis":{"type":"string","description":"Dialed number for the current session; this can be different from dnis, e.g. if the call was transferred"},"outboundCampaignId":{"type":"string","description":"(Dialer) Unique identifier of the outbound campaign"},"outboundContactId":{"type":"string","description":"(Dialer) Unique identifier of the contact"},"outboundContactListId":{"type":"string","description":"(Dialer) Unique identifier of the contact list that this contact belongs to"},"dispositionAnalyzer":{"type":"string","description":"(Dialer) Unique identifier of the contact list that this contact belongs to"},"dispositionName":{"type":"string","example":"disposition.classification.callable.machine","description":"(Dialer) Result of the analysis"},"edgeId":{"type":"string","description":"Unique identifier of the edge device"},"remoteNameDisplayable":{"type":"string"},"roomId":{"type":"string","description":"Unique identifier for the room"},"monitoredSessionId":{"type":"string","description":"The sessionID being monitored"},"monitoredParticipantId":{"type":"string"},"callbackUserName":{"type":"string","description":"The name of the user requesting a call back"},"callbackNumbers":{"type":"array","description":"List of numbers to callback","items":{"type":"string"}},"callbackScheduledTime":{"type":"string","format":"date-time","description":"Scheduled callback date/time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"scriptId":{"type":"string","description":"A unique identifier for a script"},"peerId":{"type":"string","description":"A unique identifier for a peer"},"skipEnabled":{"type":"boolean","description":"(Dialer) Whether the agent can skip the dialer contact"},"timeoutSeconds":{"type":"integer","format":"int32","description":"The number of seconds before PureCloud begins the call for a call back. 0 disables automatic calling"},"cobrowseRole":{"type":"string","description":"Describe side of the cobrowse (sharer or viewer)"},"cobrowseRoomId":{"type":"string","description":"A unique identifier for a PureCloud Cobrowse room."},"mediaBridgeId":{"type":"string"},"screenShareAddressSelf":{"type":"string","description":"Direct ScreenShare address"},"sharingScreen":{"type":"boolean","description":"Flag determining if screenShare is started or not (true/false)"},"screenShareRoomId":{"type":"string","description":"A unique identifier for a PureCloud ScreenShare room."},"videoRoomId":{"type":"string","description":"A unique identifier for a PureCloud video room."},"videoAddressSelf":{"type":"string","description":"Direct Video address"},"segments":{"type":"array","description":"List of segments for this session","items":{"$ref":"#/definitions/AnalyticsConversationSegment"}},"metrics":{"type":"array","description":"List of metrics for this session","items":{"$ref":"#/definitions/AnalyticsSessionMetric"}},"flow":{"description":"IVR flow execution associated with this session","$ref":"#/definitions/AnalyticsFlow"},"mediaEndpointStats":{"type":"array","description":"Media endpoint stats associated with this session","items":{"$ref":"#/definitions/AnalyticsMediaEndpointStat"}},"recording":{"type":"boolean","description":"Flag determining if an audio recording was started or not"},"journeyCustomerId":{"type":"string","description":"ID of the journey customer"},"journeyCustomerIdType":{"type":"string","description":"Type of the journey customer ID"},"journeyCustomerSessionId":{"type":"string","description":"ID of the journey customer session"},"journeyCustomerSessionIdType":{"type":"string","description":"Type of the journey customer session ID"},"journeyActionId":{"type":"string","description":"Journey action ID"},"journeyActionMapId":{"type":"string","description":"Journey action map ID"},"journeyActionMapVersion":{"type":"string","description":"Journey action map version"},"protocolCallId":{"type":"string","description":"The original voice protocol call ID, e.g. a SIP call ID"},"provider":{"type":"string","description":"The source provider for the communication"},"remote":{"type":"string","description":"Name, phone number, or email address of the remote party."},"mediaCount":{"type":"integer","format":"int32","description":"Count of any media (images, files, etc) included in this session"},"flowInType":{"type":"string","description":"Type of flow in that occurred, e.g. acd, ivr, etc."},"flowOutType":{"type":"string","description":"Type of flow out that occurred, e.g. voicemail, callback, or acd"},"requestedRoutings":{"type":"array","description":"All routing types for requested/attempted routing methods.","items":{"type":"string","enum":["Predictive","Preferred","Manual","Last","Bullseye","Standard"],"x-genesys-enum-members":[{"name":"Predictive"},{"name":"Preferred"},{"name":"Manual"},{"name":"Last"},{"name":"Bullseye"},{"name":"Standard"}]}},"usedRouting":{"type":"string","description":"Complete routing method","enum":["Predictive","Preferred","Manual","Last","Bullseye","Standard"],"x-genesys-enum-members":[{"name":"Predictive"},{"name":"Preferred"},{"name":"Manual"},{"name":"Last"},{"name":"Bullseye"},{"name":"Standard"}]},"selectedAgentId":{"type":"string","description":"Selected agent id"},"selectedAgentRank":{"type":"integer","format":"int32","description":"Selected agent GPR rank"},"agentAssistantId":{"type":"string","description":"Unique identifier of the active virtual agent assistant"},"proposedAgents":{"type":"array","description":"Proposed agents","items":{"$ref":"#/definitions/AnalyticsProposedAgent"}},"assignerId":{"type":"string","description":"ID of the user that manually assigned a conversation"},"acwSkipped":{"type":"boolean","description":"Marker for an agent that skipped after call work"}}},"AnalyticsSessionMetric":{"type":"object","required":["emitDate","name","value"],"properties":{"name":{"type":"string","description":"Unique name of this metric"},"value":{"type":"integer","format":"int64","description":"The metric value"},"emitDate":{"type":"string","format":"date-time","description":"Metric emission date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"AnalyticsSurvey":{"type":"object","properties":{"surveyId":{"type":"string","description":"Unique identifier for the survey"},"surveyFormId":{"type":"string","description":"Unique identifier for the survey form"},"surveyFormName":{"type":"string","description":"Name of the survey form"},"surveyFormContextId":{"type":"string","description":"Unique identifier for the survey form, regardless of version"},"eventTime":{"type":"string","format":"date-time","description":"Specifies when a survey occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"userId":{"type":"string","description":"A unique identifier of the PureCloud user"},"queueId":{"type":"string","description":"Unique identifier for the queue the conversation was on"},"surveyStatus":{"type":"string","description":"Survey status"},"surveyPromoterScore":{"type":"integer","format":"int32","description":"Promoter score of the survey"},"surveyCompletedDate":{"type":"string","format":"date-time","description":"Completion date/time of the survey. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"oSurveyTotalScore":{"type":"integer","format":"int64"}}},"TranscriptConversationDetailSearchCriteria":{"type":"object","properties":{"endValue":{"type":"string","description":"The end value of the range. This field is used for range search types."},"values":{"type":"array","description":"A list of values for the search to match against","items":{"type":"string"}},"startValue":{"type":"string","description":"The start value of the range. This field is used for range search types."},"fields":{"type":"array","description":"Field names to search against","items":{"type":"string"}},"value":{"type":"string","description":"A value for the search to match against"},"operator":{"type":"string","description":"How to apply this search criteria against other criteria","enum":["AND","OR","NOT"],"x-genesys-enum-members":[{"name":"AND"},{"name":"OR"},{"name":"NOT"}]},"group":{"type":"array","description":"Groups multiple conditions","items":{"$ref":"#/definitions/TranscriptConversationDetailSearchCriteria"}},"dateFormat":{"type":"string","description":"Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."},"type":{"type":"string","enum":["EXACT","EXACT_PHRASE","PHRASE","DATE_RANGE"],"x-genesys-enum-members":[{"name":"EXACT"},{"name":"EXACT_PHRASE"},{"name":"PHRASE"},{"name":"DATE_RANGE"}]}}},"TranscriptConversationDetailSearchRequest":{"type":"object","required":["types"],"properties":{"sortOrder":{"type":"string","description":"The sort order for results","enum":["ASC","DESC","SCORE"],"x-genesys-enum-members":[{"name":"ASC"},{"name":"DESC"},{"name":"SCORE"}]},"sortBy":{"type":"string","description":"The field in the resource that you want to sort the results by"},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"},"pageNumber":{"type":"integer","format":"int32","description":"The page of resources you want to retrieve"},"sort":{"type":"array","description":"Multi-value sort order, list of multiple sort values","items":{"$ref":"#/definitions/SearchSort"}},"types":{"type":"array","description":"Resource domain type to search","items":{"type":"string"}},"query":{"type":"array","description":"The search criteria","items":{"$ref":"#/definitions/TranscriptConversationDetailSearchCriteria"}}}},"VoicemailMessageEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/VoicemailMessage"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CredentialSpecification":{"type":"object","properties":{"required":{"type":"boolean","description":"Indicates if the credential must be provided in order for the integration configuration to be valid.","readOnly":true},"title":{"type":"string","description":"Title describing the usage for this credential.","readOnly":true},"credentialTypes":{"type":"array","description":"List of acceptable credential types that can be provided for this credential.","readOnly":true,"items":{"type":"string"}}},"description":"Specifies the requirements for a credential that can be provided for configuring an integration"},"HelpLink":{"type":"object","properties":{"uri":{"type":"string","description":"URI of the help resource","readOnly":true},"title":{"type":"string","description":"Link text of the resource","readOnly":true},"description":{"type":"string","description":"Description of the document or resource","readOnly":true}},"description":"Link to a help or support resource"},"Integration":{"type":"object","required":["intendedState"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the integration, used to distinguish this integration from others of the same type.","readOnly":true},"integrationType":{"description":"Type of the integration","readOnly":true,"$ref":"#/definitions/IntegrationType"},"notes":{"type":"string","description":"Notes about the integration.","readOnly":true},"intendedState":{"type":"string","description":"Configured state of the integration.","enum":["ENABLED","DISABLED","DELETED"],"x-genesys-enum-members":[{"name":"ENABLED"},{"name":"DISABLED"},{"name":"DELETED"}]},"config":{"description":"Configuration information for the integration.","readOnly":true,"$ref":"#/definitions/IntegrationConfigurationInfo"},"reportedState":{"description":"Last reported status of the integration.","readOnly":true,"$ref":"#/definitions/IntegrationStatusInfo"},"attributes":{"type":"object","description":"Read-only attributes for the integration.","readOnly":true,"additionalProperties":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Details for an Integration"},"IntegrationConfigurationInfo":{"type":"object","properties":{"current":{"description":"The current, active configuration for the integration.","readOnly":true,"$ref":"#/definitions/IntegrationConfiguration"}},"description":"Configuration information for the integration"},"IntegrationType":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the integration type."},"name":{"type":"string"},"description":{"type":"string","description":"Description of the integration type.","readOnly":true},"provider":{"type":"string","description":"PureCloud provider of the integration type.","readOnly":true},"category":{"type":"string","description":"Category describing the integration type.","readOnly":true},"images":{"type":"array","description":"Collection of logos.","readOnly":true,"items":{"$ref":"#/definitions/UserImage"}},"configPropertiesSchemaUri":{"type":"string","description":"URI of the schema describing the key-value properties needed to configure an integration of this type.","readOnly":true},"configAdvancedSchemaUri":{"type":"string","description":"URI of the schema describing the advanced JSON document needed to configure an integration of this type.","readOnly":true},"helpUri":{"type":"string","description":"URI of a page with more information about the integration type","readOnly":true},"termsOfServiceUri":{"type":"string","description":"URI of a page with terms and conditions for the integration type","readOnly":true},"vendorName":{"type":"string","description":"Name of the vendor of this integration type","readOnly":true},"vendorWebsiteUri":{"type":"string","description":"URI of the vendor's website","readOnly":true},"marketplaceUri":{"type":"string","description":"URI of the marketplace listing for this integration type","readOnly":true},"faqUri":{"type":"string","description":"URI of frequently asked questions about the integration type","readOnly":true},"privacyPolicyUri":{"type":"string","description":"URI of a privacy policy for users of the integration type","readOnly":true},"supportContactUri":{"type":"string","description":"URI for vendor support","readOnly":true},"salesContactUri":{"type":"string","description":"URI for vendor sales information","readOnly":true},"helpLinks":{"type":"array","description":"List of links to additional help resources","readOnly":true,"items":{"$ref":"#/definitions/HelpLink"}},"credentials":{"type":"object","description":"Map of credentials for integrations of this type. The key is the name of a credential that can be provided in the credentials property of the integration configuration.","readOnly":true,"additionalProperties":{"$ref":"#/definitions/CredentialSpecification"}},"nonInstallable":{"type":"boolean","description":"Indicates if the integration type is installable or not.","readOnly":true},"maxInstances":{"type":"integer","format":"int32","description":"The maximum number of integration instances allowable for this integration type","readOnly":true},"userPermissions":{"type":"array","description":"List of permissions required to permit user access to the integration type.","readOnly":true,"items":{"type":"string"}},"vendorOAuthClientIds":{"type":"array","description":"List of OAuth Client IDs that must be authorized when the integration is created.","readOnly":true,"items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Descriptor for a type of Integration."},"CreateIntegrationRequest":{"type":"object","required":["integrationType","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the integration, used to distinguish this integration from others of the same type."},"integrationType":{"description":"Type of the integration to create.","$ref":"#/definitions/IntegrationType"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Details for an Integration"},"IntegrationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Integration"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DocumentEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Document"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DependencyType":{"type":"object","properties":{"id":{"type":"string","description":"The dependency type identifier"},"name":{"type":"string"},"versioned":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CreateCallbackOnConversationCommand":{"type":"object","required":["callbackNumbers"],"properties":{"scriptId":{"type":"string","description":"The identifier of the script to be used for the callback"},"queueId":{"type":"string","description":"The identifier of the queue to be used for the callback. Either queueId or routingData is required."},"routingData":{"description":"The routing data to be used for the callback. Either queueId or routingData is required.","$ref":"#/definitions/RoutingData"},"callbackUserName":{"type":"string","description":"The name of the party to be called back."},"callbackNumbers":{"type":"array","description":"A list of phone numbers for the callback.","items":{"type":"string"}},"callbackScheduledTime":{"type":"string","format":"date-time","example":"2015-01-02T16:59:59.000Z","description":"The scheduled date-time for the callback as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"},"countryCode":{"type":"string","description":"The country code to be associated with the callback numbers."},"validateCallbackNumbers":{"type":"boolean","description":"Whether or not to validate the callback numbers for phone number format."},"data":{"type":"object","description":"A map of key-value pairs containing additional data that can be associated to the callback. These values will appear in the attributes property on the conversation participant. Example: { \"notes\": \"ready to close the deal!\", \"customerPreferredName\": \"Doc\" }","additionalProperties":{"type":"string"}}}},"Digits":{"type":"object","properties":{"digits":{"type":"string","description":"A string representing the digits pressed on phone."}}},"SubjectDivisions":{"type":"object","required":["divisionIds","subjectIds"],"properties":{"subjectIds":{"type":"array","description":"A collection of subject IDs to associate with the given divisions","items":{"type":"string"}},"divisionIds":{"type":"array","description":"A collection of division IDs to associate with the given subjects","items":{"type":"string"}}}},"DomainOrganizationRoleUpdate":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the role"},"description":{"type":"string"},"defaultRoleId":{"type":"string"},"permissions":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"unusedPermissions":{"type":"array","description":"A collection of the permissions the role is not using","readOnly":true,"uniqueItems":true,"items":{"type":"string"}},"permissionPolicies":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/DomainPermissionPolicy"}},"userCount":{"type":"integer","format":"int32"},"roleNeedsUpdate":{"type":"boolean","description":"Optional unless patch operation."},"default":{"type":"boolean"},"base":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WrapUpCodeReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."}}},"WrapupCodeEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AuthzDivision":{"type":"object","required":["description"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string","description":"A helpful description for the division."},"homeDivision":{"type":"boolean","description":"A flag indicating whether this division is the \"Home\" (default) division. Cannot be modified and any supplied value will be ignored on create or update.","readOnly":true},"objectCounts":{"type":"object","description":"A count of objects in this division, grouped by type.","readOnly":true,"additionalProperties":{"type":"integer","format":"int64"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AuthzGrant":{"type":"object","properties":{"subjectId":{"type":"string"},"division":{"$ref":"#/definitions/AuthzDivision"},"role":{"$ref":"#/definitions/AuthzGrantRole"},"grantMadeAt":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"AuthzGrantPolicy":{"type":"object","properties":{"actions":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"condition":{"type":"string"},"domain":{"type":"string"},"entityName":{"type":"string"}}},"AuthzGrantRole":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"policies":{"type":"array","items":{"$ref":"#/definitions/AuthzGrantPolicy"}},"default":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AuthzSubject":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"grants":{"type":"array","items":{"$ref":"#/definitions/AuthzGrant"}},"version":{"type":"integer","format":"int32"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"IVR":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"dnis":{"type":"array","description":"The phone number(s) to contact the IVR by. Each phone number must be unique and not in use by another resource. For example, a user and an iVR cannot have the same phone number.","items":{"type":"string"}},"openHoursFlow":{"description":"The Architect flow to execute during the hours an organization is open.","$ref":"#/definitions/DomainEntityRef"},"closedHoursFlow":{"description":"The Architect flow to execute during the hours an organization is closed.","$ref":"#/definitions/DomainEntityRef"},"holidayHoursFlow":{"description":"The Architect flow to execute during an organization's holiday hours.","$ref":"#/definitions/DomainEntityRef"},"scheduleGroup":{"description":"The schedule group defining the open and closed hours for an organization. If this is provided, an open flow and a closed flow must be specified as well.","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Defines the phone numbers, operating hours, and the Architect flows to execute for an IVR."},"IVREntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/IVR"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"LineStatus":{"type":"object","properties":{"id":{"type":"string","description":"The id of this line"},"reachable":{"type":"boolean","description":"Indicates whether the edge can reach the line."},"addressOfRecord":{"type":"string","description":"The line's address of record."},"contactAddresses":{"type":"array","description":"The addresses used to contact the line.","items":{"type":"string"}},"reachableStateTime":{"type":"string","format":"date-time","description":"The time the line entered its current reachable state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"Phone":{"type":"object","required":["lines","name","phoneBaseSettings","site"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"site":{"description":"The site associated to the phone.","$ref":"#/definitions/DomainEntityRef"},"phoneBaseSettings":{"description":"Phone Base Settings","$ref":"#/definitions/DomainEntityRef"},"lineBaseSettings":{"$ref":"#/definitions/DomainEntityRef"},"phoneMetaBase":{"$ref":"#/definitions/DomainEntityRef"},"lines":{"type":"array","description":"Lines","items":{"$ref":"#/definitions/Line"}},"status":{"description":"The status of the phone and lines from the primary Edge.","$ref":"#/definitions/PhoneStatus"},"secondaryStatus":{"description":"The status of the phone and lines from the secondary Edge.","$ref":"#/definitions/PhoneStatus"},"userAgentInfo":{"description":"User Agent Information for this phone. This includes model, firmware version, and manufacturer.","readOnly":true,"$ref":"#/definitions/UserAgentInfo"},"properties":{"type":"object","additionalProperties":{"type":"object"}},"capabilities":{"$ref":"#/definitions/PhoneCapabilities"},"webRtcUser":{"description":"This is the user associated with a WebRTC type phone. It is required for all WebRTC phones.","$ref":"#/definitions/DomainEntityRef"},"primaryEdge":{"$ref":"#/definitions/Edge"},"secondaryEdge":{"$ref":"#/definitions/Edge"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PhoneCapabilities":{"type":"object","properties":{"provisions":{"type":"boolean"},"registers":{"type":"boolean"},"dualRegisters":{"type":"boolean"},"hardwareIdType":{"type":"string"},"allowReboot":{"type":"boolean"},"noRebalance":{"type":"boolean"},"noCloudProvisioning":{"type":"boolean"},"mediaCodecs":{"type":"array","items":{"type":"string","enum":["audio/opus","audio/pcmu","audio/pcma","audio/g729","audio/g722"],"x-genesys-enum-members":[{"name":"audio/opus"},{"name":"audio/pcmu"},{"name":"audio/pcma"},{"name":"audio/g729"},{"name":"audio/g722"}]}},"cdm":{"type":"boolean"}}},"PhoneStatus":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"operationalStatus":{"type":"string","description":"The Operational Status of this phone","enum":["OPERATIONAL","DEGRADED","OFFLINE"],"x-genesys-enum-members":[{"name":"OPERATIONAL"},{"name":"DEGRADED"},{"name":"OFFLINE"}]},"edgesStatus":{"type":"string","description":"The status of the primary or secondary Edges assigned to the phone lines.","enum":["IN_SERVICE","MIXED_SERVICE","OUT_OF_SERVICE","NO_EDGES"],"x-genesys-enum-members":[{"name":"IN_SERVICE"},{"name":"MIXED_SERVICE"},{"name":"OUT_OF_SERVICE"},{"name":"NO_EDGES"}]},"eventCreationTime":{"type":"string","description":"Event Creation Time represents an ISO-8601 string. For example: UTC, UTC+01:00, or Europe/London"},"provision":{"description":"Provision information for this phone","$ref":"#/definitions/ProvisionInfo"},"lineStatuses":{"type":"array","description":"A list of LineStatus information for each of the lines of this phone","items":{"$ref":"#/definitions/LineStatus"}},"phoneAssignmentToEdgeType":{"type":"string","description":"The phone status's edge assignment type.","enum":["PRIMARY","SECONDARY"],"x-genesys-enum-members":[{"name":"PRIMARY"},{"name":"SECONDARY"}]},"edge":{"description":"The URI of the edge that provided this status information.","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ProvisionInfo":{"type":"object","properties":{"time":{"type":"string","format":"date-time","description":"The time at which this phone was provisioned. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"source":{"type":"string","description":"The source of the provisioning"},"errorInfo":{"type":"string","description":"The error information from the provision process, if any"}}},"UserAgentInfo":{"type":"object","properties":{"firmwareVersion":{"type":"string","description":"The firmware version of the phone."},"manufacturer":{"type":"string","description":"The manufacturer of the phone."},"model":{"type":"string","description":"The model of the phone."}}},"QueueMember":{"type":"object","properties":{"id":{"type":"string","description":"The queue member's id."},"name":{"type":"string"},"user":{"$ref":"#/definitions/User"},"ringNumber":{"type":"integer","format":"int32"},"joined":{"type":"boolean"},"memberBy":{"type":"string"},"routingStatus":{"$ref":"#/definitions/RoutingStatus"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TimeOffRequestList":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"timeOffRequests":{"type":"array","items":{"$ref":"#/definitions/TimeOffRequestResponse"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TimeOffRequestResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"user":{"description":"The user associated with this time off request","$ref":"#/definitions/UserReference"},"isFullDayRequest":{"type":"boolean","description":"Whether this is a full day request (false means partial day)"},"markedAsRead":{"type":"boolean","description":"Whether this request has been marked as read by the agent"},"activityCodeId":{"type":"string","description":"The ID of the activity code associated with this time off request. Activity code must be of the TimeOff category"},"status":{"type":"string","description":"The status of this time off request","enum":["PENDING","APPROVED","DENIED","CANCELED"],"x-genesys-enum-members":[{"name":"PENDING"},{"name":"APPROVED"},{"name":"DENIED"},{"name":"CANCELED"}]},"partialDayStartDateTimes":{"type":"array","description":"A set of start date-times in ISO-8601 format for partial day requests. Will be not empty if isFullDayRequest == false","uniqueItems":true,"items":{"type":"string","format":"date-time"}},"fullDayManagementUnitDates":{"type":"array","description":"A set of dates in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone. Will be not empty if isFullDayRequest == true","uniqueItems":true,"items":{"type":"string"}},"dailyDurationMinutes":{"type":"integer","format":"int32","description":"The daily duration of this time off request in minutes"},"notes":{"type":"string","description":"Notes about the time off request"},"submittedBy":{"description":"The user who submitted this time off request","$ref":"#/definitions/UserReference"},"submittedDate":{"type":"string","format":"date-time","description":"The timestamp when this request was submitted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"reviewedBy":{"description":"The user who reviewed this time off request","$ref":"#/definitions/UserReference"},"reviewedDate":{"type":"string","format":"date-time","description":"The timestamp when this request was reviewed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"description":"The user who last modified this TimeOffRequestResponse","$ref":"#/definitions/UserReference"},"modifiedDate":{"type":"string","format":"date-time","description":"The timestamp when this request was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"metadata":{"description":"The version metadata of the time off request","$ref":"#/definitions/WfmVersionedEntityMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CreateAgentTimeOffRequest":{"type":"object","required":["activityCodeId","dailyDurationMinutes"],"properties":{"activityCodeId":{"type":"string","description":"The ID of the activity code associated with this time off request. Activity code must be of the TimeOff category"},"notes":{"type":"string","description":"Notes about the time off request"},"fullDayManagementUnitDates":{"type":"array","description":"A set of dates in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone.","uniqueItems":true,"items":{"type":"string"}},"partialDayStartDateTimes":{"type":"array","description":"A set of start date-times in ISO-8601 format for partial day requests.","uniqueItems":true,"items":{"type":"string","format":"date-time"}},"dailyDurationMinutes":{"type":"integer","format":"int32","description":"The daily duration of this time off request in minutes"}}},"AgentTimeOffRequestPatch":{"type":"object","properties":{"markedAsRead":{"type":"boolean","description":"Whether this request has been read by the agent"},"status":{"type":"string","description":"The status of this time off request. Can only be canceled if the requested date has not already passed","enum":["CANCELED"],"x-genesys-enum-members":[{"name":"CANCELED"}]},"notes":{"type":"string","description":"Notes about the time off request. Can only be edited while the request is still pending"}}},"VoicemailsSearchResponse":{"type":"object","required":["pageCount","pageNumber","pageSize","results","total","types"],"properties":{"total":{"type":"integer","format":"int64","description":"The total number of results found"},"pageCount":{"type":"integer","format":"int32","description":"The total number of pages"},"pageSize":{"type":"integer","format":"int32","description":"The current page size"},"pageNumber":{"type":"integer","format":"int32","description":"The current page number"},"previousPage":{"type":"string","description":"Q64 value for the previous page of results"},"currentPage":{"type":"string","description":"Q64 value for the current page of results"},"nextPage":{"type":"string","description":"Q64 value for the next page of results"},"types":{"type":"array","description":"Resource types the search was performed against","items":{"type":"string"}},"results":{"type":"array","description":"Search results","items":{"$ref":"#/definitions/VoicemailMessage"}}}},"VoicemailSearchCriteria":{"type":"object","required":["type"],"properties":{"endValue":{"type":"string","description":"The end value of the range. This field is used for range search types."},"values":{"type":"array","description":"A list of values for the search to match against","items":{"type":"string"}},"startValue":{"type":"string","description":"The start value of the range. This field is used for range search types."},"fields":{"type":"array","description":"Field names to search against","items":{"type":"string"}},"value":{"type":"string","description":"A value for the search to match against"},"operator":{"type":"string","description":"How to apply this search criteria against other criteria","enum":["AND","OR","NOT"],"x-genesys-enum-members":[{"name":"AND"},{"name":"OR"},{"name":"NOT"}]},"group":{"type":"array","description":"Groups multiple conditions","items":{"$ref":"#/definitions/VoicemailSearchCriteria"}},"dateFormat":{"type":"string","description":"Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."},"type":{"type":"string","description":"Search Type","enum":["EXACT","STARTS_WITH","CONTAINS","REGEX","TERM","TERMS","REQUIRED_FIELDS","MATCH_ALL"],"x-genesys-enum-members":[{"name":"EXACT"},{"name":"STARTS_WITH"},{"name":"CONTAINS"},{"name":"REGEX"},{"name":"TERM"},{"name":"TERMS"},{"name":"REQUIRED_FIELDS"},{"name":"MATCH_ALL"}]}}},"VoicemailSearchRequest":{"type":"object","properties":{"sortOrder":{"type":"string","description":"The sort order for results","enum":["ASC","DESC","SCORE"],"x-genesys-enum-members":[{"name":"ASC"},{"name":"DESC"},{"name":"SCORE"}]},"sortBy":{"type":"string","description":"The field in the resource that you want to sort the results by"},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"},"pageNumber":{"type":"integer","format":"int32","description":"The page of resources you want to retrieve"},"sort":{"type":"array","description":"Multi-value sort order, list of multiple sort values","items":{"$ref":"#/definitions/SearchSort"}},"expand":{"type":"array","description":"Provides more details about a specified resource","items":{"type":"string"}},"query":{"type":"array","items":{"$ref":"#/definitions/VoicemailSearchCriteria"}}}},"Annotation":{"type":"object","required":["agentScoreModifier","customerScoreModifier"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"type":{"type":"string"},"location":{"type":"integer","format":"int64","description":"Offset of annotation in milliseconds."},"durationMs":{"type":"integer","format":"int64","description":"Duration of annotation in milliseconds."},"absoluteLocation":{"type":"integer","format":"int64","description":"Offset of annotation (milliseconds) from start of recording."},"absoluteDurationMs":{"type":"integer","format":"int64","description":"Duration of annotation (milliseconds)."},"recordingLocation":{"type":"integer","format":"int64","description":"Offset of annotation (milliseconds) from start of recording, adjusted for any recording cuts"},"recordingDurationMs":{"type":"integer","format":"int64","description":"Duration of annotation (milliseconds), adjusted for any recording cuts."},"user":{"description":"User that created this annotation (if any).","$ref":"#/definitions/User"},"description":{"type":"string","description":"Text of annotation."},"keywordName":{"type":"string","description":"The word or phrase which is being looked for with speech recognition."},"confidence":{"type":"number","format":"float","description":"Actual confidence that this is an accurate match."},"keywordSetId":{"type":"string","description":"A unique identifier for the keyword set to which this spotted keyword belongs."},"keywordSetName":{"type":"string","description":"The keyword set to which this spotted keyword belongs."},"utterance":{"type":"string","description":"The phonetic spellings for the phrase and alternate spellings."},"timeBegin":{"type":"string","description":"Beginning time offset of the keyword spot match."},"timeEnd":{"type":"string","description":"Ending time offset of the keyword spot match."},"keywordConfidenceThreshold":{"type":"string","description":"Configured sensitivity threshold that can be increased to lower false positives or decreased to reduce false negatives."},"agentScoreModifier":{"type":"string","description":"A modifier to the evaluation score when the phrase is spotted in the agent channel."},"customerScoreModifier":{"type":"string","description":"A modifier to the evaluation score when the phrase is spotted in the customer channel."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"RecordingMetadata":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"conversationId":{"type":"string"},"path":{"type":"string"},"startTime":{"type":"string","description":"The start time of the recording for screen recordings. Null for other types."},"endTime":{"type":"string"},"media":{"type":"string","description":"The type of media that the recording is. At the moment that could be audio, chat, email, or message."},"annotations":{"type":"array","description":"Annotations that belong to the recording. Populated when recording filestate is AVAILABLE.","items":{"$ref":"#/definitions/Annotation"}},"fileState":{"type":"string","description":"Represents the current file state for a recording. Examples: Uploading, Archived, etc","enum":["ARCHIVED","AVAILABLE","DELETED","RESTORED","RESTORING","UPLOADING","ERROR"],"x-genesys-enum-members":[{"name":"ARCHIVED"},{"name":"AVAILABLE"},{"name":"DELETED"},{"name":"RESTORED"},{"name":"RESTORING"},{"name":"UPLOADING"},{"name":"ERROR"}]},"restoreExpirationTime":{"type":"string","format":"date-time","description":"The amount of time a restored recording will remain restored before being archived again. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"archiveDate":{"type":"string","format":"date-time","description":"The date the recording will be archived. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"archiveMedium":{"type":"string","description":"The type of archive medium used. Example: CloudArchive","enum":["CLOUDARCHIVE"],"x-genesys-enum-members":[{"name":"CLOUDARCHIVE"}]},"deleteDate":{"type":"string","format":"date-time","description":"The date the recording will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"exportDate":{"type":"string","format":"date-time","description":"The date the recording will be exported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"exportedDate":{"type":"string","format":"date-time","description":"The date the recording was exported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"maxAllowedRestorationsForOrg":{"type":"integer","format":"int32","description":"How many archive restorations the organization is allowed to have."},"remainingRestorationsAllowedForOrg":{"type":"integer","format":"int32","description":"The remaining archive restorations the organization has."},"sessionId":{"type":"string","description":"The session id represents an external resource id, such as email, call, chat, etc"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EvaluationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Evaluation"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"UserLanguageEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UserRoutingLanguage"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"UserRoutingLanguagePost":{"type":"object","required":["id","proficiency"],"properties":{"id":{"type":"string","description":"The id of the existing routing language to add to the user"},"proficiency":{"type":"number","format":"double","description":"Proficiency is a rating from 0.0 to 5.0 on how competent an agent is for a particular language. It is used when a queue is set to \"Best available language\" mode to allow acd interactions to target agents with higher proficiency ratings."},"languageUri":{"type":"string","format":"uri","description":"URI to the organization language used by this user language.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Represents an organization language assigned to a user. When assigning to a user specify the organization langauge id as the id."},"UpdateUser":{"type":"object","required":["version"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"chat":{"$ref":"#/definitions/Chat"},"department":{"type":"string"},"email":{"type":"string"},"primaryContactInfo":{"type":"array","description":"The address(s) used for primary contact. Updates to the corresponding address in the addresses list will be reflected here.","readOnly":true,"items":{"$ref":"#/definitions/Contact"}},"addresses":{"type":"array","description":"Email address, phone number, and/or extension for this user. One entry is allowed per media type","items":{"$ref":"#/definitions/Contact"}},"title":{"type":"string"},"username":{"type":"string"},"manager":{"type":"string"},"images":{"type":"array","items":{"$ref":"#/definitions/UserImage"}},"version":{"type":"integer","format":"int32","description":"This value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH."},"profileSkills":{"type":"array","description":"Profile skills possessed by the user","items":{"type":"string"}},"locations":{"type":"array","description":"The user placement at each site location.","items":{"$ref":"#/definitions/Location"}},"groups":{"type":"array","description":"The groups the user is a member of","items":{"$ref":"#/definitions/Group"}},"state":{"type":"string","description":"The state of the user. This property can be used to restore a deleted user or transition between active and inactive. If specified, it is the only modifiable field.","enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"acdAutoAnswer":{"type":"boolean","description":"The value that denotes if acdAutoAnswer is set on the user"},"certifications":{"type":"array","items":{"type":"string"}},"biography":{"$ref":"#/definitions/Biography"},"employerInfo":{"$ref":"#/definitions/EmployerInfo"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"MessagingCampaignEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/MessagingCampaign"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DirectoryUserDevicesListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UserDevice"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"WhatsAppIntegration":{"type":"object","required":["id","name","phoneNumber","version"],"properties":{"id":{"type":"string","description":"A unique Integration Id.","readOnly":true},"name":{"type":"string","description":"The name of the WhatsApp integration."},"phoneNumber":{"type":"string","description":"The phone number associated to the whatsApp integration."},"status":{"type":"string","description":"The status of the WhatsApp Integration","enum":["Active","Inactive","Error","Starting","Incomplete","Deleting","DeletionFailed"],"x-genesys-enum-members":[{"name":"Active"},{"name":"Inactive"},{"name":"Error"},{"name":"Starting"},{"name":"Incomplete"},{"name":"Deleting"},{"name":"DeletionFailed"}]},"recipient":{"description":"The recipient associated to the WhatsApp Integration. This recipient is used to associate a flow to an integration","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"dateCreated":{"type":"string","format":"date-time","description":"Date this Integration was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date this Integration was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"description":"User reference that created this Integration","$ref":"#/definitions/DomainEntityRef"},"modifiedBy":{"description":"User reference that last modified this Integration","$ref":"#/definitions/DomainEntityRef"},"version":{"type":"integer","format":"int32","description":"Version number required for updates."},"activationStatusCode":{"type":"string","description":"The status code of WhatsApp Integration activation process","readOnly":true,"enum":["CodeSent","WaitRequired","ActivationFailed","CodeConfirmed","ConfirmationFailed","ResendCode"],"x-genesys-enum-members":[{"name":"CodeSent"},{"name":"WaitRequired"},{"name":"ActivationFailed"},{"name":"CodeConfirmed"},{"name":"ConfirmationFailed"},{"name":"ResendCode"}]},"activationErrorInfo":{"description":"The error information of WhatsApp Integration activation process","readOnly":true,"$ref":"#/definitions/ErrorBody"},"createStatus":{"type":"string","description":"Status of asynchronous create operation","readOnly":true,"enum":["Initiated","Completed","Error"],"x-genesys-enum-members":[{"name":"Initiated","description":"The integration create request has started"},{"name":"Completed","description":"The integration create request has finished successfully"},{"name":"Error","description":"The integration create request has finished in error."}]},"createError":{"description":"Error information returned, if createStatus is set to Error","readOnly":true,"$ref":"#/definitions/ErrorBody"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WhatsAppIntegrationUpdateRequest":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"WhatsApp Integration name","readOnly":true},"action":{"type":"string","description":"The action used to activate and then confirm a WhatsApp Integration.","enum":["Activate","Confirm"],"x-genesys-enum-members":[{"name":"Activate"},{"name":"Confirm"}]},"authenticationMethod":{"type":"string","description":"The authentication method used to confirm a WhatsApp Integration activation. If action is set to Activate, then authenticationMethod is a required field. ","enum":["Sms","Voice"],"x-genesys-enum-members":[{"name":"Sms"},{"name":"Voice"}]},"confirmationCode":{"type":"string","description":"The confirmation code sent by Whatsapp to you during the activation step. If action is set to Confirm, then confirmationCode is a required field."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UploadUrlResponse":{"type":"object","properties":{"url":{"type":"string","description":"Presigned URL to PUT the file to","readOnly":true},"uploadKey":{"type":"string","description":"Key that identifies the file in the storage including the file name","readOnly":true},"headers":{"type":"object","description":"Required headers when uploading a file through PUT request to the URL","readOnly":true,"additionalProperties":{"type":"string"}}}},"UploadUrlRequest":{"type":"object","properties":{"fileName":{"type":"string","description":"Name of the file to upload. It must not start with a dot and not end with a forward slash. Whitespace and the following characters are not allowed: \\{^}%`]\">[~<#|"},"contentMd5":{"type":"string","description":"Content MD-5 of the file to upload"},"signedUrlTimeoutSeconds":{"type":"integer","format":"int32","description":"The number of seconds the presigned URL is valid for (from 1 to 604800 seconds). If none provided, defaults to 600 seconds"},"serverSideEncryption":{"type":"string","enum":["AES256"],"x-genesys-enum-members":[{"name":"AES256"}]}}},"ContactListFilterEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ContactListFilter"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"GreetingMediaInfo":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"mediaFileUri":{"type":"string","format":"uri"},"mediaImageUri":{"type":"string","format":"uri"}}},"VoicemailUserPolicy":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether the user has voicemail enabled","readOnly":true},"alertTimeoutSeconds":{"type":"integer","format":"int32","description":"The number of seconds to ring the user's phone before a call is transfered to voicemail"},"pin":{"type":"string","description":"The user's PIN to access their voicemail. This property is only used for updates and never provided otherwise to ensure security"},"modifiedDate":{"type":"string","format":"date-time","description":"The date the policy was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"sendEmailNotifications":{"type":"boolean","description":"Whether email notifications are sent to the user when a new voicemail is received"}}},"EdgeTrunkBase":{"type":"object","required":["name","trunkMetabase","trunkType"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"trunkMetabase":{"description":"The meta-base this trunk is based on.","$ref":"#/definitions/DomainEntityRef"},"properties":{"type":"object","additionalProperties":{"type":"object"}},"trunkType":{"type":"string","description":"The type of this trunk base.","enum":["EXTERNAL","PHONE","EDGE"],"x-genesys-enum-members":[{"name":"EXTERNAL"},{"name":"PHONE"},{"name":"EDGE"}]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"HeadcountForecast":{"type":"object","required":["required","requiredWithoutShrinkage"],"properties":{"required":{"type":"array","description":"Headcount information with shrinkage","items":{"$ref":"#/definitions/HeadcountInterval"}},"requiredWithoutShrinkage":{"type":"array","description":"Headcount information without shrinkage","items":{"$ref":"#/definitions/HeadcountInterval"}}},"description":"Headcount interval information for schedule"},"HeadcountInterval":{"type":"object","required":["interval","value"],"properties":{"interval":{"type":"string","format":"date-time","description":"The start date-time for this headcount interval in ISO-8601 format, must be within the 8 day schedule"},"value":{"type":"number","format":"double","description":"Headcount value for this interval"}},"description":"Headcount interval information for schedule"},"ScheduleGenerationWarning":{"type":"object","properties":{"userId":{"type":"string","description":"ID of the user in the warning"},"userNotLicensed":{"type":"boolean","description":"Whether the user does not have the appropriate license to be scheduled"},"unableToMeetMaxDays":{"type":"boolean","description":"Whether the number of scheduled days exceeded the maximum days to schedule defined in the agent work plan"},"unableToScheduleRequiredDays":{"type":"array","description":"Days indicated as required to work in agent work plan where no viable shift was found to schedule","uniqueItems":true,"items":{"type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"x-genesys-enum-members":[{"name":"Sunday"},{"name":"Monday"},{"name":"Tuesday"},{"name":"Wednesday"},{"name":"Thursday"},{"name":"Friday"},{"name":"Saturday"}]}},"unableToMeetMinPaidForTheWeek":{"type":"boolean","description":"Whether the schedule did not meet the minimum paid time for the week defined in the agent work plan"},"unableToMeetMaxPaidForTheWeek":{"type":"boolean","description":"Whether the schedule exceeded the maximum paid time for the week defined in the agent work plan"},"noNeedDays":{"type":"array","description":"Days agent was scheduled but there was no need to meet. The scheduled days have no effect on service levels","uniqueItems":true,"items":{"type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"x-genesys-enum-members":[{"name":"Sunday"},{"name":"Monday"},{"name":"Tuesday"},{"name":"Wednesday"},{"name":"Thursday"},{"name":"Friday"},{"name":"Saturday"}]}},"shiftsTooCloseTogether":{"type":"boolean","description":"Whether the schedule did not meet the minimum time between shifts defined in the agent work plan"}},"description":"Schedule generation warning"},"ShortTermForecastReference":{"type":"object","required":["weekDate"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"weekDate":{"type":"string","description":"The weekDate of the short term forecast in yyyy-MM-dd format"},"description":{"type":"string","description":"The description of the short term forecast"}},"description":"A pointer to a short term forecast"},"WeekSchedule":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"weekDate":{"type":"string","description":"First day of this week schedule in yyyy-MM-dd format"},"description":{"type":"string","description":"Description of the week schedule"},"published":{"type":"boolean","description":"Whether the week schedule is published"},"generationResults":{"description":"Summary of the results from the schedule run","$ref":"#/definitions/WeekScheduleGenerationResult"},"shortTermForecast":{"description":"Short term forecast associated with this schedule","$ref":"#/definitions/ShortTermForecastReference"},"metadata":{"description":"Version metadata for this work plan","$ref":"#/definitions/WfmVersionedEntityMetadata"},"userSchedules":{"type":"object","description":"User schedules in the week","additionalProperties":{"$ref":"#/definitions/UserSchedule"}},"headcountForecast":{"description":"Headcount information for the week schedule","$ref":"#/definitions/HeadcountForecast"},"agentSchedulesVersion":{"type":"integer","format":"int32","description":"Version of agent schedules in the week schedule"}},"description":"Week schedule information"},"WeekScheduleGenerationResult":{"type":"object","properties":{"failed":{"type":"boolean","description":"Whether the schedule generation failed"},"runId":{"type":"string","description":"ID of the schedule run"},"agentWarnings":{"type":"array","description":"Warning messages from the schedule run. This will be available only when requesting information for a single week schedule","items":{"$ref":"#/definitions/ScheduleGenerationWarning"}},"agentWarningCount":{"type":"integer","format":"int32","description":"Count of warning messages from the schedule run. This will be available only when requesting multiple week schedules"}}},"WeekScheduleResponse":{"type":"object","properties":{"result":{"description":"The result of the request. The value will be null if response is large","$ref":"#/definitions/WeekSchedule"},"downloadUrl":{"type":"string","description":"The url to fetch the result for large responses. The value is null if result contains the data"}},"description":"Response for query for week schedule for a given week in management unit"},"WeekScheduleListItemResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"weekDate":{"type":"string","description":"First day of this week schedule in yyyy-MM-dd format"},"description":{"type":"string","description":"Description of the week schedule"},"published":{"type":"boolean","description":"Whether the week schedule is published"},"generationResults":{"description":"Summary of the results from the schedule run","$ref":"#/definitions/WeekScheduleGenerationResult"},"shortTermForecast":{"description":"Short term forecast associated with this schedule","$ref":"#/definitions/ShortTermForecastReference"},"metadata":{"description":"Version metadata for this work plan","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"WeekScheduleListResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WeekScheduleListItemResponse"}}},"description":"Week schedule list"},"BusinessUnitListItem":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"authorized":{"type":"boolean","description":"Whether the user has authorization to interact with this business unit","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BusinessUnitListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/BusinessUnitListItem"}}}},"UserExpands":{"type":"object","properties":{"routingStatus":{"description":"ACD routing status","readOnly":true,"$ref":"#/definitions/RoutingStatus"},"presence":{"description":"Active presence","readOnly":true,"$ref":"#/definitions/UserPresence"},"conversationSummary":{"description":"Summary of conversion statistics for conversation types.","readOnly":true,"$ref":"#/definitions/UserConversationSummary"},"outOfOffice":{"description":"Determine if out of office is enabled","readOnly":true,"$ref":"#/definitions/OutOfOffice"},"geolocation":{"description":"Current geolocation position","readOnly":true,"$ref":"#/definitions/Geolocation"},"station":{"description":"Effective, default, and last station information","readOnly":true,"$ref":"#/definitions/UserStations"},"authorization":{"description":"Roles and permissions assigned to the user","readOnly":true,"$ref":"#/definitions/UserAuthorization"}}},"UserProfile":{"type":"object","required":["version"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"state":{"type":"string","description":"The state of the user resource","enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"dateModified":{"type":"string","format":"date-time","description":"Datetime of the last modification. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int64","description":"The version of the group resource"},"expands":{"description":"User information expansions","readOnly":true,"$ref":"#/definitions/UserExpands"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AuditQueryExecutionStatusResponse":{"type":"object","properties":{"id":{"type":"string","description":"Id of the audit query execution request."},"state":{"type":"string","description":"Status of the audit query execution request.","enum":["Queued","Running","Succeeded","Failed","Cancelled"],"x-genesys-enum-members":[{"name":"Queued"},{"name":"Running"},{"name":"Succeeded"},{"name":"Failed"},{"name":"Cancelled"}]},"startDate":{"type":"string","format":"date-time","description":"Start date and time of the audit query execution. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"interval":{"type":"string","description":"Interval for the audit query. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"serviceName":{"type":"string","description":"Service name for the audit query.","enum":["Architect","ContactCenter","ContentManagement","PeoplePermissions","Presence","Quality","LanguageUnderstanding","TopicsDefinitions","PredictiveEngagement","WorkforceManagement","Triggers","ResponseManagement","Groups","Telephony","Outbound","SpeechAndTextAnalytics","Routing"],"x-genesys-enum-members":[{"name":"Architect"},{"name":"ContactCenter"},{"name":"ContentManagement"},{"name":"PeoplePermissions"},{"name":"Presence"},{"name":"Quality"},{"name":"LanguageUnderstanding"},{"name":"TopicsDefinitions"},{"name":"PredictiveEngagement"},{"name":"WorkforceManagement"},{"name":"Triggers"},{"name":"ResponseManagement"},{"name":"Groups"},{"name":"Telephony"},{"name":"Outbound"},{"name":"SpeechAndTextAnalytics"},{"name":"Routing"}]},"filters":{"type":"array","description":"Filters for the audit query.","items":{"$ref":"#/definitions/AuditQueryFilter"}},"sort":{"type":"array","description":"Sort parameter for the audit query.","items":{"$ref":"#/definitions/AuditQuerySort"}}}},"AuditQueryFilter":{"type":"object","required":["property","value"],"properties":{"property":{"type":"string","description":"Name of the property to filter.","enum":["UserId","TrusteeOrganizationId","ClientId","Action","EntityType","EntityId"],"x-genesys-enum-members":[{"name":"UserId"},{"name":"TrusteeOrganizationId"},{"name":"ClientId"},{"name":"Action"},{"name":"EntityType"},{"name":"EntityId"}]},"value":{"type":"string","description":"Value of the property to filter."}}},"AuditQuerySort":{"type":"object","required":["name","sortOrder"],"properties":{"name":{"type":"string","description":"Name of the property to sort.","enum":["Timestamp"],"x-genesys-enum-members":[{"name":"Timestamp"}]},"sortOrder":{"type":"string","description":"Sort Order","enum":["ascending","descending"],"x-genesys-enum-members":[{"name":"ascending"},{"name":"descending"}]}}},"AuditQueryRequest":{"type":"object","required":["interval","serviceName"],"properties":{"interval":{"type":"string","description":"Date and time range of data to query. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"serviceName":{"type":"string","description":"Name of the service to query audits for.","enum":["Architect","ContactCenter","ContentManagement","PeoplePermissions","Presence","Quality","LanguageUnderstanding","TopicsDefinitions","PredictiveEngagement","WorkforceManagement","Triggers","ResponseManagement","Groups","Telephony","Outbound","SpeechAndTextAnalytics","Routing"],"x-genesys-enum-members":[{"name":"Architect"},{"name":"ContactCenter"},{"name":"ContentManagement"},{"name":"PeoplePermissions"},{"name":"Presence"},{"name":"Quality"},{"name":"LanguageUnderstanding"},{"name":"TopicsDefinitions"},{"name":"PredictiveEngagement"},{"name":"WorkforceManagement"},{"name":"Triggers"},{"name":"ResponseManagement"},{"name":"Groups"},{"name":"Telephony"},{"name":"Outbound"},{"name":"SpeechAndTextAnalytics"},{"name":"Routing"}]},"filters":{"type":"array","description":"Additional filters for the query.","items":{"$ref":"#/definitions/AuditQueryFilter"}},"sort":{"type":"array","description":"Sort parameter for the query.","items":{"$ref":"#/definitions/AuditQuerySort"}}}},"AuditLogMessage":{"type":"object","properties":{"id":{"type":"string","description":"Id of the audit message."},"userHomeOrgId":{"type":"string","description":"Home Organization Id associated with this audit message."},"user":{"description":"User associated with this audit message.","$ref":"#/definitions/DomainEntityRef"},"client":{"description":"Client associated with this audit message.","$ref":"#/definitions/AddressableEntityRef"},"remoteIp":{"type":"array","description":"List of IP addresses of systems that originated or handled the request.","items":{"type":"string"}},"serviceName":{"type":"string","description":"Name of the service that logged this audit message.","enum":["Architect","ContactCenter","ContentManagement","PeoplePermissions","Presence","Quality","LanguageUnderstanding","TopicsDefinitions","PredictiveEngagement","WorkforceManagement","Triggers","ResponseManagement","Groups","Telephony","Outbound","SpeechAndTextAnalytics","Routing"],"x-genesys-enum-members":[{"name":"Architect"},{"name":"ContactCenter"},{"name":"ContentManagement"},{"name":"PeoplePermissions"},{"name":"Presence"},{"name":"Quality"},{"name":"LanguageUnderstanding"},{"name":"TopicsDefinitions"},{"name":"PredictiveEngagement"},{"name":"WorkforceManagement"},{"name":"Triggers"},{"name":"ResponseManagement"},{"name":"Groups"},{"name":"Telephony"},{"name":"Outbound"},{"name":"SpeechAndTextAnalytics"},{"name":"Routing"}]},"eventDate":{"type":"string","format":"date-time","description":"Date and time of when the audit message was logged. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"message":{"description":"Message describing the event being audited.","$ref":"#/definitions/MessageInfo"},"action":{"type":"string","description":"Action that took place.","enum":["Create","View","Update","Delete","Download","Upload","MemberAdd","MemberUpdate","MemberRemove","Read","ApplyProtection","RevokeProtection","UpdateRetention","ReadAll","Execute","Publish","Unpublish","Activate","Checkin","Checkout","Deactivate","Debug","Save","Revert","Transcode","Enable","Disable","Authorize","Deauthorize","Authenticate","ChangePassword","Revoke","Export","Append","Recycle"],"x-genesys-enum-members":[{"name":"Create"},{"name":"View"},{"name":"Update"},{"name":"Delete"},{"name":"Download"},{"name":"Upload"},{"name":"MemberAdd"},{"name":"MemberUpdate"},{"name":"MemberRemove"},{"name":"Read"},{"name":"ApplyProtection"},{"name":"RevokeProtection"},{"name":"UpdateRetention"},{"name":"ReadAll"},{"name":"Execute"},{"name":"Publish"},{"name":"Unpublish"},{"name":"Activate"},{"name":"Checkin"},{"name":"Checkout"},{"name":"Deactivate"},{"name":"Debug"},{"name":"Save"},{"name":"Revert"},{"name":"Transcode"},{"name":"Enable"},{"name":"Disable"},{"name":"Authorize"},{"name":"Deauthorize"},{"name":"Authenticate"},{"name":"ChangePassword"},{"name":"Revoke"},{"name":"Export"},{"name":"Append"},{"name":"Recycle"}]},"entity":{"description":"Entity that was impacted.","$ref":"#/definitions/DomainEntityRef"},"entityType":{"type":"string","description":"Type of the entity that was impacted.","enum":["Document","Queue","Recording","Role","VoicemailUserPolicy","UserPresence","WrapupCode","MaxOrgRoutingUtilizationCapacity","AccessToken","OAuthClient","OAuthClientAuthorization","AuthOrganization","AuthUser","OrganizationAuthorizationTrust","OrganizationAuthorizationUserTrust","BulkActions","Feedback","Topic","Program","Segment","Outcome","SessionType","EventType","ClickstreamSettings","Schedule","ScheduleGroup","EmergencyGroup","IVR","Trigger","Response","DependencyTrackingBuild","Flow","Prompt","PromptResource","FlowOutcome","FlowMilestone","Team","Edge","EdgeGroup","Trunk","TrunkBase","DID","DIDPool","Extension","ExtensionPool","Phone","PhoneBase","Line","LineBase","OutboundRoute","NumberPlan","Site","AttemptLimits","CallableTimeSet","Campaign","CampaignRule","Sequence","ContactList","ContactListFilter","DNCList","CallAnalysisResponseSet","RuleSet","CampaignSchedule","SequenceSchedule","OrganizationProperties","WrapUpCodeMapping","MessagingCampaign","TranscriptionSettings","SpeechTextAnalyticsSettings","Predictor"],"x-genesys-enum-members":[{"name":"Document"},{"name":"Queue"},{"name":"Recording"},{"name":"Role"},{"name":"VoicemailUserPolicy"},{"name":"UserPresence"},{"name":"WrapupCode"},{"name":"MaxOrgRoutingUtilizationCapacity"},{"name":"AccessToken"},{"name":"OAuthClient"},{"name":"OAuthClientAuthorization"},{"name":"AuthOrganization"},{"name":"AuthUser"},{"name":"OrganizationAuthorizationTrust"},{"name":"OrganizationAuthorizationUserTrust"},{"name":"BulkActions"},{"name":"Feedback"},{"name":"Topic"},{"name":"Program"},{"name":"Segment"},{"name":"Outcome"},{"name":"SessionType"},{"name":"EventType"},{"name":"ClickstreamSettings"},{"name":"Schedule"},{"name":"ScheduleGroup"},{"name":"EmergencyGroup"},{"name":"IVR"},{"name":"Trigger"},{"name":"Response"},{"name":"DependencyTrackingBuild"},{"name":"Flow"},{"name":"Prompt"},{"name":"PromptResource"},{"name":"FlowOutcome"},{"name":"FlowMilestone"},{"name":"Team"},{"name":"Edge"},{"name":"EdgeGroup"},{"name":"Trunk"},{"name":"TrunkBase"},{"name":"DID"},{"name":"DIDPool"},{"name":"Extension"},{"name":"ExtensionPool"},{"name":"Phone"},{"name":"PhoneBase"},{"name":"Line"},{"name":"LineBase"},{"name":"OutboundRoute"},{"name":"NumberPlan"},{"name":"Site"},{"name":"AttemptLimits"},{"name":"CallableTimeSet"},{"name":"Campaign"},{"name":"CampaignRule"},{"name":"Sequence"},{"name":"ContactList"},{"name":"ContactListFilter"},{"name":"DNCList"},{"name":"CallAnalysisResponseSet"},{"name":"RuleSet"},{"name":"CampaignSchedule"},{"name":"SequenceSchedule"},{"name":"OrganizationProperties"},{"name":"WrapUpCodeMapping"},{"name":"MessagingCampaign"},{"name":"TranscriptionSettings"},{"name":"SpeechTextAnalyticsSettings"},{"name":"Predictor"}]},"propertyChanges":{"type":"array","description":"List of properties that were changed and changes made to those properties.","items":{"$ref":"#/definitions/PropertyChange"}},"context":{"type":"object","description":"Additional context for this message.","additionalProperties":{"type":"string"}}}},"AuditRealtimeQueryResultsResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AuditLogMessage"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"pageCount":{"type":"integer","format":"int32"}}},"PropertyChange":{"type":"object","properties":{"property":{"type":"string","description":"The property that was changed"},"oldValues":{"type":"array","description":"Previous values for the property.","items":{"type":"string"}},"newValues":{"type":"array","description":"New values for the property.","items":{"type":"string"}}}},"AuditRealtimeQueryRequest":{"type":"object","required":["interval","serviceName"],"properties":{"interval":{"type":"string","description":"Date and time range of data to query. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"serviceName":{"type":"string","description":"Name of the service to query audits for.","enum":["Architect","ContactCenter","ContentManagement","PeoplePermissions","Presence","Quality","LanguageUnderstanding","TopicsDefinitions","PredictiveEngagement","WorkforceManagement","Triggers","ResponseManagement","Groups","Telephony","Outbound","SpeechAndTextAnalytics","Routing"],"x-genesys-enum-members":[{"name":"Architect"},{"name":"ContactCenter"},{"name":"ContentManagement"},{"name":"PeoplePermissions"},{"name":"Presence"},{"name":"Quality"},{"name":"LanguageUnderstanding"},{"name":"TopicsDefinitions"},{"name":"PredictiveEngagement"},{"name":"WorkforceManagement"},{"name":"Triggers"},{"name":"ResponseManagement"},{"name":"Groups"},{"name":"Telephony"},{"name":"Outbound"},{"name":"SpeechAndTextAnalytics"},{"name":"Routing"}]},"filters":{"type":"array","description":"Additional filters for the query.","items":{"$ref":"#/definitions/AuditQueryFilter"}},"sort":{"type":"array","description":"Sort parameter for the query.","items":{"$ref":"#/definitions/AuditQuerySort"}},"pageNumber":{"type":"integer","format":"int32","description":"Page number"},"pageSize":{"type":"integer","format":"int32","description":"Page size"}}},"AuditQueryExecutionResultsResponse":{"type":"object","properties":{"id":{"type":"string","description":"Id of the audit query execution request."},"pageSize":{"type":"integer","format":"int32","description":"Number of results in a page."},"cursor":{"type":"string","description":"Optional cursor to indicate where to resume the results."},"entities":{"type":"array","description":"List of audit messages.","items":{"$ref":"#/definitions/AuditLogMessage"}}}},"AuditQueryEntity":{"type":"object","properties":{"name":{"type":"string","description":"Name of the Entity","enum":["Document","Queue","Recording","Role","VoicemailUserPolicy","UserPresence","WrapupCode","MaxOrgRoutingUtilizationCapacity","AccessToken","OAuthClient","OAuthClientAuthorization","AuthOrganization","AuthUser","OrganizationAuthorizationTrust","OrganizationAuthorizationUserTrust","BulkActions","Feedback","Topic","Program","Segment","Outcome","SessionType","EventType","ClickstreamSettings","Schedule","ScheduleGroup","EmergencyGroup","IVR","Trigger","Response","DependencyTrackingBuild","Flow","Prompt","PromptResource","FlowOutcome","FlowMilestone","Team","Edge","EdgeGroup","Trunk","TrunkBase","DID","DIDPool","Extension","ExtensionPool","Phone","PhoneBase","Line","LineBase","OutboundRoute","NumberPlan","Site","AttemptLimits","CallableTimeSet","Campaign","CampaignRule","Sequence","ContactList","ContactListFilter","DNCList","CallAnalysisResponseSet","RuleSet","CampaignSchedule","SequenceSchedule","OrganizationProperties","WrapUpCodeMapping","MessagingCampaign","TranscriptionSettings","SpeechTextAnalyticsSettings","Predictor"],"x-genesys-enum-members":[{"name":"Document"},{"name":"Queue"},{"name":"Recording"},{"name":"Role"},{"name":"VoicemailUserPolicy"},{"name":"UserPresence"},{"name":"WrapupCode"},{"name":"MaxOrgRoutingUtilizationCapacity"},{"name":"AccessToken"},{"name":"OAuthClient"},{"name":"OAuthClientAuthorization"},{"name":"AuthOrganization"},{"name":"AuthUser"},{"name":"OrganizationAuthorizationTrust"},{"name":"OrganizationAuthorizationUserTrust"},{"name":"BulkActions"},{"name":"Feedback"},{"name":"Topic"},{"name":"Program"},{"name":"Segment"},{"name":"Outcome"},{"name":"SessionType"},{"name":"EventType"},{"name":"ClickstreamSettings"},{"name":"Schedule"},{"name":"ScheduleGroup"},{"name":"EmergencyGroup"},{"name":"IVR"},{"name":"Trigger"},{"name":"Response"},{"name":"DependencyTrackingBuild"},{"name":"Flow"},{"name":"Prompt"},{"name":"PromptResource"},{"name":"FlowOutcome"},{"name":"FlowMilestone"},{"name":"Team"},{"name":"Edge"},{"name":"EdgeGroup"},{"name":"Trunk"},{"name":"TrunkBase"},{"name":"DID"},{"name":"DIDPool"},{"name":"Extension"},{"name":"ExtensionPool"},{"name":"Phone"},{"name":"PhoneBase"},{"name":"Line"},{"name":"LineBase"},{"name":"OutboundRoute"},{"name":"NumberPlan"},{"name":"Site"},{"name":"AttemptLimits"},{"name":"CallableTimeSet"},{"name":"Campaign"},{"name":"CampaignRule"},{"name":"Sequence"},{"name":"ContactList"},{"name":"ContactListFilter"},{"name":"DNCList"},{"name":"CallAnalysisResponseSet"},{"name":"RuleSet"},{"name":"CampaignSchedule"},{"name":"SequenceSchedule"},{"name":"OrganizationProperties"},{"name":"WrapUpCodeMapping"},{"name":"MessagingCampaign"},{"name":"TranscriptionSettings"},{"name":"SpeechTextAnalyticsSettings"},{"name":"Predictor"}]},"actions":{"type":"array","description":"List of Actions","items":{"type":"string","enum":["Create","View","Update","Delete","Download","Upload","MemberAdd","MemberUpdate","MemberRemove","Read","ApplyProtection","RevokeProtection","UpdateRetention","ReadAll","Execute","Publish","Unpublish","Activate","Checkin","Checkout","Deactivate","Debug","Save","Revert","Transcode","Enable","Disable","Authorize","Deauthorize","Authenticate","ChangePassword","Revoke","Export","Append","Recycle"],"x-genesys-enum-members":[{"name":"Create"},{"name":"View"},{"name":"Update"},{"name":"Delete"},{"name":"Download"},{"name":"Upload"},{"name":"MemberAdd"},{"name":"MemberUpdate"},{"name":"MemberRemove"},{"name":"Read"},{"name":"ApplyProtection"},{"name":"RevokeProtection"},{"name":"UpdateRetention"},{"name":"ReadAll"},{"name":"Execute"},{"name":"Publish"},{"name":"Unpublish"},{"name":"Activate"},{"name":"Checkin"},{"name":"Checkout"},{"name":"Deactivate"},{"name":"Debug"},{"name":"Save"},{"name":"Revert"},{"name":"Transcode"},{"name":"Enable"},{"name":"Disable"},{"name":"Authorize"},{"name":"Deauthorize"},{"name":"Authenticate"},{"name":"ChangePassword"},{"name":"Revoke"},{"name":"Export"},{"name":"Append"},{"name":"Recycle"}]}}}},"AuditQueryService":{"type":"object","properties":{"name":{"type":"string","description":"Name of the Service","enum":["Architect","ContactCenter","ContentManagement","PeoplePermissions","Presence","Quality","LanguageUnderstanding","TopicsDefinitions","PredictiveEngagement","WorkforceManagement","Triggers","ResponseManagement","Groups","Telephony","Outbound","SpeechAndTextAnalytics","Routing"],"x-genesys-enum-members":[{"name":"Architect"},{"name":"ContactCenter"},{"name":"ContentManagement"},{"name":"PeoplePermissions"},{"name":"Presence"},{"name":"Quality"},{"name":"LanguageUnderstanding"},{"name":"TopicsDefinitions"},{"name":"PredictiveEngagement"},{"name":"WorkforceManagement"},{"name":"Triggers"},{"name":"ResponseManagement"},{"name":"Groups"},{"name":"Telephony"},{"name":"Outbound"},{"name":"SpeechAndTextAnalytics"},{"name":"Routing"}]},"entities":{"type":"array","description":"List of Entities","items":{"$ref":"#/definitions/AuditQueryEntity"}}}},"AuditQueryServiceMapping":{"type":"object","properties":{"services":{"type":"array","description":"List of Services","items":{"$ref":"#/definitions/AuditQueryService"}}}},"ChannelTopic":{"type":"object","properties":{"id":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ChannelTopicEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ChannelTopic"}}}},"UnreadStatus":{"type":"object","properties":{"unread":{"type":"boolean","description":"Sets if the alert is read or unread."}}},"InteractionStatsAlert":{"type":"object","required":["alertTypes","dimension","dimensionValue","mediaType","metric","name","notificationUsers","numericRange","ruleId","startDate","statistic","unread","value"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Name of the rule that generated the alert","readOnly":true},"dimension":{"type":"string","description":"The dimension of concern.","readOnly":true,"enum":["queueId","userId"],"x-genesys-enum-members":[{"name":"queueId"},{"name":"userId"}]},"dimensionValue":{"type":"string","description":"The value of the dimension.","readOnly":true},"metric":{"type":"string","description":"The metric to be assessed.","readOnly":true,"enum":["tAbandon","tAnswered","tTalk","nOffered","tHandle","nTransferred","oServiceLevel","tWait","tHeld","tAcw"],"x-genesys-enum-members":[{"name":"tAbandon"},{"name":"tAnswered"},{"name":"tTalk"},{"name":"nOffered"},{"name":"tHandle"},{"name":"nTransferred"},{"name":"oServiceLevel"},{"name":"tWait"},{"name":"tHeld"},{"name":"tAcw"}]},"mediaType":{"type":"string","description":"The media type.","readOnly":true,"enum":["voice","chat","email","callback","message"],"x-genesys-enum-members":[{"name":"voice"},{"name":"chat"},{"name":"email"},{"name":"callback"},{"name":"message"}]},"numericRange":{"type":"string","description":"The comparison descriptor used against the metric's value.","readOnly":true,"enum":["gt","gte","lt","lte","eq","ne"],"x-genesys-enum-members":[{"name":"gt"},{"name":"gte"},{"name":"lt"},{"name":"lte"},{"name":"eq"},{"name":"ne"}]},"statistic":{"type":"string","description":"The statistic of concern for the metric.","readOnly":true,"enum":["count","min","ratio","max"],"x-genesys-enum-members":[{"name":"count"},{"name":"min"},{"name":"ratio"},{"name":"max"}]},"value":{"type":"number","format":"double","description":"The threshold value.","readOnly":true},"ruleId":{"type":"string","description":"The id of the rule.","readOnly":true},"unread":{"type":"boolean","description":"Indicates if the alert has been read."},"startDate":{"type":"string","format":"date-time","description":"The date/time the alert was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"endDate":{"type":"string","format":"date-time","description":"The date/time the owning rule exiting in alarm status. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"notificationUsers":{"type":"array","description":"The ids of users who were notified of alarm state change.","readOnly":true,"uniqueItems":true,"items":{"$ref":"#/definitions/User"}},"alertTypes":{"type":"array","description":"A collection of notification methods.","readOnly":true,"uniqueItems":true,"items":{"type":"string","enum":["SMS","DEVICE","EMAIL"],"x-genesys-enum-members":[{"name":"SMS"},{"name":"DEVICE"},{"name":"EMAIL"}]}},"ruleUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"MessagingIntegration":{"type":"object","required":["id","messengerType","name","version"],"properties":{"id":{"type":"string","description":"A unique Integration Id","readOnly":true},"name":{"type":"string","description":"The name of the Integration","readOnly":true},"status":{"type":"string","description":"The status of the Integration","readOnly":true,"enum":["Active","Inactive","Error","Starting","Incomplete","Deleting","DeletionFailed"],"x-genesys-enum-members":[{"name":"Active"},{"name":"Inactive"},{"name":"Error"},{"name":"Starting"},{"name":"Incomplete"},{"name":"Deleting"},{"name":"DeletionFailed"}]},"messengerType":{"type":"string","description":"The type of Messaging Integration","readOnly":true,"enum":["sms","facebook","twitter","line","whatsapp","webmessaging"],"x-genesys-enum-members":[{"name":"sms"},{"name":"facebook"},{"name":"twitter"},{"name":"line"},{"name":"whatsapp"},{"name":"webmessaging"}]},"recipient":{"description":"The recipient associated to the Integration. This recipient is used to associate a flow to an integration","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"dateCreated":{"type":"string","format":"date-time","description":"Date this Integration was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Date this Integration was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"createdBy":{"description":"User reference that created this Integration","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"modifiedBy":{"description":"User reference that last modified this Integration","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"version":{"type":"integer","format":"int32","description":"Version number required for updates.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"MessagingIntegrationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/MessagingIntegration"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Coretype":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"version":{"type":"integer","format":"int32","description":"A positive integer denoting the core type's version"},"dateCreated":{"type":"string","format":"date-time","description":"The date the core type was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"schema":{"description":"The core type's built-in schema","$ref":"#/definitions/Schema"},"current":{"type":"boolean","description":"A boolean indicating if the core type's version is the current one in use by the system"},"validationFields":{"type":"array","description":"An array of strings naming the fields of the core type subject to validation. Validation constraints are specified by a schema author using the core type.","items":{"type":"string"}},"validationLimits":{"example":"\"validationLimits\": {\n\"minLength\": {\"min\": 0, \"max\": 100},\n\"maxLength\": {\"min\": 1, \"max\": 100}\n}","description":"A structure denoting the system-imposed minimum and maximum string length (for text-based core types) or numeric values (for number-based) core types. For example, the validationLimits for a text-based core type specify the min/max values for a minimum string length (minLength) constraint supplied by a schemaauthor on a text field. Similarly, the maxLength's min/max specifies maximum string length constraint supplied by a schema author for the same field.","$ref":"#/definitions/ValidationLimits"},"itemValidationFields":{"type":"array","description":"Specific to the \"tag\" core type, this is an array of strings naming the tag item fields of the core type subject to validation","items":{"type":"string"}},"itemValidationLimits":{"example":"\"validationLimits\": {\n \"minLength\": {\"min\": 1, \"max\": 100},\n \"maxLength\": {\"min\": 1, \"max\": 100}\n}","description":"A structure denoting the system-imposed minimum and maximum string length for string-array based core types such as \"tag\" and \"enum\". Forexample, the validationLimits for a schema field using a tag core type specify the min/max values for a minimum string length (minLength) constraint supplied by a schema author on individual tags. Similarly, the maxLength's min/max specifies maximum string length constraint supplied by a schema author for the same field's tags.","$ref":"#/definitions/ItemValidationLimits"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ItemValidationLimits":{"type":"object","required":["maxLength","minLength"],"properties":{"minLength":{"example":"\"minLength\": {\"min\": 0, \"max\": 100}","description":"A structure denoting the system-imposed minimum string length (for text-based core types) or numeric values (for number-based) core types. For example, the validationLimits for a text-based core type specify the min/max values for a minimum string length (minLength) constraint supplied by a schemaauthor on a text field. Similarly, the maxLength's min/max specifies maximum string length constraint supplied by a schema author for the same field.","$ref":"#/definitions/MinLength"},"maxLength":{"example":"\"validationLimits\": {\n\"minLength\": {\"min\": 0, \"max\": 100},\n\"maxLength\": {\"min\": 1, \"max\": 100}\n}","description":"A structure denoting the system-imposed minimum and maximum string length (for text-based core types) or numeric values (for number-based) core types. For example, the validationLimits for a text-based core type specify the min/max values for a minimum string length (minLength) constraint supplied by a schemaauthor on a text field. Similarly, the maxLength's min/max specifies maximum string length constraint supplied by a schema author for the same field.","$ref":"#/definitions/MaxLength"}}},"Items":{"type":"object","properties":{"type":{"type":"string"},"pattern":{"type":"string"}}},"MaxLength":{"type":"object","required":["max","min"],"properties":{"min":{"type":"integer","format":"int64","description":"A non-negative integer for a text-based schema field denoting the minimum largest length string the field can contain for a schema instance."},"max":{"type":"integer","format":"int64","description":"A non-negative integer for a text-based schema field denoting the maximum largest string the field can contain for a schema instance."}}},"MinLength":{"type":"object","required":["max","min"],"properties":{"min":{"type":"integer","format":"int64","description":"A non-negative integer for a text-based schema field denoting the minimum smallest length a string field can contain for a schema instance."},"max":{"type":"integer","format":"int64","description":"A non-negative integer for a text-based schema field denoting the maximum smallest length string the field can contain for a schema instance."}}},"Schema":{"type":"object","properties":{"title":{"type":"string","description":"A core type's title","readOnly":true},"description":{"type":"string","description":"A core type's description","readOnly":true},"type":{"type":"array","example":"[\"string\"] for a text-based core type, [\"integer\"] for a numeric core type, or [\"boolean\", \"null\"] for the checkbox core type","description":"An array of fundamental JSON Schema primitive types on which the core type is based","readOnly":true,"items":{"type":"string"}},"items":{"example":"{\ntype\": \"string\",\n\"pattern\": \"^[\\\\S]+$\"\n}","description":"Denotes the type and pattern of the items in an enum core type","readOnly":true,"$ref":"#/definitions/Items"},"pattern":{"type":"string","description":"For the \"date\" and \"datetime\" core types, denotes the regex prescribing the allowable date/datetime format","readOnly":true}}},"ValidationLimits":{"type":"object","properties":{"minLength":{"$ref":"#/definitions/MinLength"},"maxLength":{"$ref":"#/definitions/MaxLength"},"minItems":{"$ref":"#/definitions/MinLength"},"maxItems":{"$ref":"#/definitions/MaxLength"},"minimum":{"$ref":"#/definitions/MinLength"},"maximum":{"$ref":"#/definitions/MaxLength"}}},"ArchiveRetention":{"type":"object","properties":{"days":{"type":"integer","format":"int32"},"storageMedium":{"type":"string","enum":["CLOUDARCHIVE"],"x-genesys-enum-members":[{"name":"CLOUDARCHIVE"}]}}},"CalibrationAssignment":{"type":"object","properties":{"calibrator":{"$ref":"#/definitions/User"},"evaluators":{"type":"array","items":{"$ref":"#/definitions/User"}},"evaluationForm":{"$ref":"#/definitions/EvaluationForm"},"expertEvaluator":{"$ref":"#/definitions/User"}}},"CallMediaPolicy":{"type":"object","properties":{"actions":{"description":"Actions applied when specified conditions are met","$ref":"#/definitions/PolicyActions"},"conditions":{"description":"Conditions for when actions should be applied","$ref":"#/definitions/CallMediaPolicyConditions"}}},"CallMediaPolicyConditions":{"type":"object","properties":{"forUsers":{"type":"array","items":{"$ref":"#/definitions/User"}},"dateRanges":{"type":"array","items":{"type":"string"}},"forQueues":{"type":"array","items":{"$ref":"#/definitions/Queue"}},"wrapupCodes":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}},"languages":{"type":"array","items":{"$ref":"#/definitions/Language"}},"timeAllowed":{"$ref":"#/definitions/TimeAllowed"},"directions":{"type":"array","items":{"type":"string","enum":["INBOUND","OUTBOUND"],"x-genesys-enum-members":[{"name":"INBOUND"},{"name":"OUTBOUND"}]}},"duration":{"$ref":"#/definitions/DurationCondition"}}},"ChatMediaPolicy":{"type":"object","properties":{"actions":{"description":"Actions applied when specified conditions are met","$ref":"#/definitions/PolicyActions"},"conditions":{"description":"Conditions for when actions should be applied","$ref":"#/definitions/ChatMediaPolicyConditions"}}},"ChatMediaPolicyConditions":{"type":"object","properties":{"forUsers":{"type":"array","items":{"$ref":"#/definitions/User"}},"dateRanges":{"type":"array","items":{"type":"string"}},"forQueues":{"type":"array","items":{"$ref":"#/definitions/Queue"}},"wrapupCodes":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}},"languages":{"type":"array","items":{"$ref":"#/definitions/Language"}},"timeAllowed":{"$ref":"#/definitions/TimeAllowed"},"duration":{"$ref":"#/definitions/DurationCondition"}}},"DeleteRetention":{"type":"object","properties":{"days":{"type":"integer","format":"int32"}}},"DurationCondition":{"type":"object","properties":{"durationTarget":{"type":"string","enum":["DURATION","DURATION_RANGE"],"x-genesys-enum-members":[{"name":"DURATION"},{"name":"DURATION_RANGE"}]},"durationOperator":{"type":"string"},"durationRange":{"type":"string"}}},"EmailMediaPolicy":{"type":"object","properties":{"actions":{"description":"Actions applied when specified conditions are met","$ref":"#/definitions/PolicyActions"},"conditions":{"description":"Conditions for when actions should be applied","$ref":"#/definitions/EmailMediaPolicyConditions"}}},"EmailMediaPolicyConditions":{"type":"object","properties":{"forUsers":{"type":"array","items":{"$ref":"#/definitions/User"}},"dateRanges":{"type":"array","items":{"type":"string"}},"forQueues":{"type":"array","items":{"$ref":"#/definitions/Queue"}},"wrapupCodes":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}},"languages":{"type":"array","items":{"$ref":"#/definitions/Language"}},"timeAllowed":{"$ref":"#/definitions/TimeAllowed"}}},"EvaluationAssignment":{"type":"object","properties":{"evaluationForm":{"$ref":"#/definitions/EvaluationForm"},"user":{"$ref":"#/definitions/User"}}},"InitiateScreenRecording":{"type":"object","properties":{"recordACW":{"type":"boolean"},"archiveRetention":{"$ref":"#/definitions/ArchiveRetention"},"deleteRetention":{"$ref":"#/definitions/DeleteRetention"}}},"IntegrationExport":{"type":"object","required":["integration"],"properties":{"integration":{"description":"The aws-s3-recording-bulk-actions-integration that the policy uses for exports.","$ref":"#/definitions/DomainEntityRef"},"shouldExportScreenRecordings":{"type":"boolean","description":"True if the policy should export screen recordings in addition to the other conversation media. Default = true"}}},"Language":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The language name."},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"state":{"type":"string","enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"version":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"MediaPolicies":{"type":"object","properties":{"callPolicy":{"description":"Conditions and actions for calls","$ref":"#/definitions/CallMediaPolicy"},"chatPolicy":{"description":"Conditions and actions for chats","$ref":"#/definitions/ChatMediaPolicy"},"emailPolicy":{"description":"Conditions and actions for emails","$ref":"#/definitions/EmailMediaPolicy"},"messagePolicy":{"description":"Conditions and actions for messages","$ref":"#/definitions/MessageMediaPolicy"}}},"MediaTranscription":{"type":"object","properties":{"displayName":{"type":"string"},"transcriptionProvider":{"type":"string","enum":["VOCI","CALLJOURNEY"],"x-genesys-enum-members":[{"name":"VOCI"},{"name":"CALLJOURNEY"}]},"integrationId":{"type":"string"}}},"MessageMediaPolicy":{"type":"object","properties":{"actions":{"description":"Actions applied when specified conditions are met","$ref":"#/definitions/PolicyActions"},"conditions":{"description":"Conditions for when actions should be applied","$ref":"#/definitions/MessageMediaPolicyConditions"}}},"MessageMediaPolicyConditions":{"type":"object","properties":{"forUsers":{"type":"array","items":{"$ref":"#/definitions/User"}},"dateRanges":{"type":"array","items":{"type":"string"}},"forQueues":{"type":"array","items":{"$ref":"#/definitions/Queue"}},"wrapupCodes":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}},"languages":{"type":"array","items":{"$ref":"#/definitions/Language"}},"timeAllowed":{"$ref":"#/definitions/TimeAllowed"}}},"MeteredAssignmentByAgent":{"type":"object","properties":{"evaluationContextId":{"type":"string"},"evaluators":{"type":"array","items":{"$ref":"#/definitions/User"}},"maxNumberEvaluations":{"type":"integer","format":"int32"},"evaluationForm":{"$ref":"#/definitions/EvaluationForm"},"timeInterval":{"$ref":"#/definitions/TimeInterval"},"timeZone":{"type":"string"}}},"MeteredEvaluationAssignment":{"type":"object","properties":{"evaluationContextId":{"type":"string"},"evaluators":{"type":"array","items":{"$ref":"#/definitions/User"}},"maxNumberEvaluations":{"type":"integer","format":"int32"},"evaluationForm":{"$ref":"#/definitions/EvaluationForm"},"assignToActiveUser":{"type":"boolean"},"timeInterval":{"$ref":"#/definitions/TimeInterval"}}},"Policy":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"order":{"type":"integer","format":"int32"},"description":{"type":"string"},"enabled":{"type":"boolean"},"mediaPolicies":{"description":"Conditions and actions per media type","$ref":"#/definitions/MediaPolicies"},"conditions":{"description":"Conditions","$ref":"#/definitions/PolicyConditions"},"actions":{"description":"Actions","$ref":"#/definitions/PolicyActions"},"policyErrors":{"$ref":"#/definitions/PolicyErrors"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PolicyActions":{"type":"object","properties":{"retainRecording":{"type":"boolean","description":"true to retain the recording associated with the conversation. Default = true"},"deleteRecording":{"type":"boolean","description":"true to delete the recording associated with the conversation. If retainRecording = true, this will be ignored. Default = false"},"alwaysDelete":{"type":"boolean","description":"true to delete the recording associated with the conversation regardless of the values of retainRecording or deleteRecording. Default = false"},"assignEvaluations":{"type":"array","items":{"$ref":"#/definitions/EvaluationAssignment"}},"assignMeteredEvaluations":{"type":"array","items":{"$ref":"#/definitions/MeteredEvaluationAssignment"}},"assignMeteredAssignmentByAgent":{"type":"array","items":{"$ref":"#/definitions/MeteredAssignmentByAgent"}},"assignCalibrations":{"type":"array","items":{"$ref":"#/definitions/CalibrationAssignment"}},"assignSurveys":{"type":"array","items":{"$ref":"#/definitions/SurveyAssignment"}},"retentionDuration":{"$ref":"#/definitions/RetentionDuration"},"initiateScreenRecording":{"$ref":"#/definitions/InitiateScreenRecording"},"mediaTranscriptions":{"type":"array","items":{"$ref":"#/definitions/MediaTranscription"}},"integrationExport":{"description":"Policy action for exporting recordings using an integration to 3rd party s3.","$ref":"#/definitions/IntegrationExport"}}},"PolicyConditions":{"type":"object","properties":{"forUsers":{"type":"array","items":{"$ref":"#/definitions/User"}},"directions":{"type":"array","items":{"type":"string","enum":["INBOUND","OUTBOUND"],"x-genesys-enum-members":[{"name":"INBOUND"},{"name":"OUTBOUND"}]}},"dateRanges":{"type":"array","items":{"type":"string"}},"mediaTypes":{"type":"array","items":{"type":"string","enum":["CALL","CHAT"],"x-genesys-enum-members":[{"name":"CALL"},{"name":"CHAT"}]}},"forQueues":{"type":"array","items":{"$ref":"#/definitions/Queue"}},"duration":{"$ref":"#/definitions/DurationCondition"},"wrapupCodes":{"type":"array","items":{"$ref":"#/definitions/WrapupCode"}},"timeAllowed":{"$ref":"#/definitions/TimeAllowed"}}},"PolicyEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Policy"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"PolicyErrorMessage":{"type":"object","properties":{"statusCode":{"type":"integer","format":"int32"},"userMessage":{"type":"object"},"userParamsMessage":{"type":"string"},"errorCode":{"type":"string"},"correlationId":{"type":"string"},"userParams":{"type":"array","items":{"$ref":"#/definitions/UserParam"}},"insertDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"PolicyErrors":{"type":"object","properties":{"policyErrorMessages":{"type":"array","items":{"$ref":"#/definitions/PolicyErrorMessage"}}}},"PublishedSurveyFormReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"contextId":{"type":"string","description":"The context id of this form."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"RetentionDuration":{"type":"object","properties":{"archiveRetention":{"$ref":"#/definitions/ArchiveRetention"},"deleteRetention":{"$ref":"#/definitions/DeleteRetention"}}},"SurveyAssignment":{"type":"object","required":["sendingDomain"],"properties":{"surveyForm":{"description":"The survey form used for this survey.","$ref":"#/definitions/PublishedSurveyFormReference"},"flow":{"description":"The URI reference to the flow associated with this survey.","$ref":"#/definitions/DomainEntityRef"},"inviteTimeInterval":{"type":"string","description":"An ISO 8601 repeated interval consisting of the number of repetitions, the start datetime, and the interval (e.g. R2/2018-03-01T13:00:00Z/P1M10DT2H30M). Total duration must not exceed 90 days."},"sendingUser":{"type":"string","description":"User together with sendingDomain used to send email, null to use no-reply"},"sendingDomain":{"type":"string","description":"Validated email domain, required"}}},"TimeAllowed":{"type":"object","properties":{"timeSlots":{"type":"array","items":{"$ref":"#/definitions/TimeSlot"}},"timeZoneId":{"type":"string"},"empty":{"type":"boolean"}}},"TimeInterval":{"type":"object","properties":{"months":{"type":"integer","format":"int32"},"weeks":{"type":"integer","format":"int32"},"days":{"type":"integer","format":"int32"},"hours":{"type":"integer","format":"int32"}}},"TimeSlot":{"type":"object","properties":{"startTime":{"type":"string","description":"start time in xx:xx:xx.xxx format"},"stopTime":{"type":"string","description":"stop time in xx:xx:xx.xxx format"},"day":{"type":"integer","format":"int32","description":"Day for this time slot, Monday = 1 ... Sunday = 7"}}},"UserParam":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}},"CrossPlatformCallMediaPolicy":{"type":"object","properties":{"actions":{"description":"Actions applied when specified conditions are met","$ref":"#/definitions/CrossPlatformPolicyActions"},"conditions":{"description":"Conditions for when actions should be applied","$ref":"#/definitions/CallMediaPolicyConditions"}}},"CrossPlatformChatMediaPolicy":{"type":"object","properties":{"actions":{"description":"Actions applied when specified conditions are met","$ref":"#/definitions/CrossPlatformPolicyActions"},"conditions":{"description":"Conditions for when actions should be applied","$ref":"#/definitions/ChatMediaPolicyConditions"}}},"CrossPlatformEmailMediaPolicy":{"type":"object","properties":{"actions":{"description":"Actions applied when specified conditions are met","$ref":"#/definitions/CrossPlatformPolicyActions"},"conditions":{"description":"Conditions for when actions should be applied","$ref":"#/definitions/EmailMediaPolicyConditions"}}},"CrossPlatformMediaPolicies":{"type":"object","properties":{"callPolicy":{"description":"Conditions and actions for calls","$ref":"#/definitions/CrossPlatformCallMediaPolicy"},"chatPolicy":{"description":"Conditions and actions for chats","$ref":"#/definitions/CrossPlatformChatMediaPolicy"},"emailPolicy":{"description":"Conditions and actions for emails","$ref":"#/definitions/CrossPlatformEmailMediaPolicy"},"messagePolicy":{"description":"Conditions and actions for messages","$ref":"#/definitions/CrossPlatformMessageMediaPolicy"}}},"CrossPlatformMessageMediaPolicy":{"type":"object","properties":{"actions":{"description":"Actions applied when specified conditions are met","$ref":"#/definitions/CrossPlatformPolicyActions"},"conditions":{"description":"Conditions for when actions should be applied","$ref":"#/definitions/MessageMediaPolicyConditions"}}},"CrossPlatformPolicy":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"order":{"type":"integer","format":"int32"},"description":{"type":"string"},"enabled":{"type":"boolean"},"mediaPolicies":{"description":"Conditions and actions per media type","$ref":"#/definitions/CrossPlatformMediaPolicies"},"conditions":{"description":"Conditions","$ref":"#/definitions/PolicyConditions"},"actions":{"description":"Actions","$ref":"#/definitions/CrossPlatformPolicyActions"},"policyErrors":{"$ref":"#/definitions/PolicyErrors"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CrossPlatformPolicyActions":{"type":"object","properties":{"retainRecording":{"type":"boolean","description":"true to retain the recording associated with the conversation. Default = true"},"deleteRecording":{"type":"boolean","description":"true to delete the recording associated with the conversation. If retainRecording = true, this will be ignored. Default = false"},"alwaysDelete":{"type":"boolean","description":"true to delete the recording associated with the conversation regardless of the values of retainRecording or deleteRecording. Default = false"},"assignEvaluations":{"type":"array","items":{"$ref":"#/definitions/EvaluationAssignment"}},"assignMeteredEvaluations":{"type":"array","items":{"$ref":"#/definitions/MeteredEvaluationAssignment"}},"assignMeteredAssignmentByAgent":{"type":"array","items":{"$ref":"#/definitions/MeteredAssignmentByAgent"}},"assignCalibrations":{"type":"array","items":{"$ref":"#/definitions/CalibrationAssignment"}},"retentionDuration":{"$ref":"#/definitions/RetentionDuration"},"mediaTranscriptions":{"type":"array","items":{"$ref":"#/definitions/MediaTranscription"}},"integrationExport":{"description":"Policy action for exporting recordings using an integration to 3rd party s3.","$ref":"#/definitions/IntegrationExport"}}},"CrossPlatformPolicyCreate":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The policy name."},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"order":{"type":"integer","format":"int32"},"description":{"type":"string"},"enabled":{"type":"boolean"},"mediaPolicies":{"description":"Conditions and actions per media type","$ref":"#/definitions/CrossPlatformMediaPolicies"},"conditions":{"description":"Conditions","$ref":"#/definitions/PolicyConditions"},"actions":{"description":"Actions","$ref":"#/definitions/CrossPlatformPolicyActions"},"policyErrors":{"$ref":"#/definitions/PolicyErrors"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ActionMapListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ActionMap"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"LanguageOverride":{"type":"object","required":["engine","language","voice"],"properties":{"language":{"type":"string","description":"The language code of the language being overridden"},"engine":{"type":"string","description":"The ID of the TTS engine to use for this language override"},"voice":{"type":"string","description":"The ID of the voice to use for this language override. The voice must be supported by the chosen engine."}}},"TtsSettings":{"type":"object","required":["defaultEngine","languageOverrides"],"properties":{"defaultEngine":{"type":"string","description":"ID of the global default TTS engine"},"languageOverrides":{"type":"array","description":"The list of default overrides for specific languages","items":{"$ref":"#/definitions/LanguageOverride"}}}},"LocalEncryptionConfigurationListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/LocalEncryptionConfiguration"}},"selfUri":{"type":"string","format":"uri"}}},"DID":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"phoneNumber":{"type":"string"},"didPool":{"$ref":"#/definitions/DomainEntityRef"},"owner":{"description":"A Uri reference to the owner of this DID, which is either a User or an IVR","$ref":"#/definitions/DomainEntityRef"},"ownerType":{"type":"string","enum":["USER","PHONE","IVR_CONFIG","GROUP"],"x-genesys-enum-members":[{"name":"USER"},{"name":"PHONE"},{"name":"IVR_CONFIG"},{"name":"GROUP"}]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DownloadResponse":{"type":"object","properties":{"contentLocationUri":{"type":"string"},"imageUri":{"type":"string"},"thumbnails":{"type":"array","items":{"$ref":"#/definitions/DocumentThumbnail"}}}},"CoretypeListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/Coretype"}},"selfUri":{"type":"string","format":"uri"}}},"AuthzDivisionGrantEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AuthzGrant"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"pageCount":{"type":"integer","format":"int32"}}},"SystemPresence":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PostTextMessage":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Message type","enum":["Text","Structured","Receipt"],"x-genesys-enum-members":[{"name":"Text"},{"name":"Structured"},{"name":"Receipt"}]},"text":{"type":"string","description":"Message text. If type is structured, used as fallback for clients that do not support particular structured content"},"content":{"type":"array","description":"A list of content elements in message","items":{"$ref":"#/definitions/MessageContent"}}}},"PostTextResponse":{"type":"object","required":["botState"],"properties":{"botState":{"type":"string","description":"The state of the bot after completion of the request","enum":["Complete","Failed","MoreData"],"x-genesys-enum-members":[{"name":"Complete"},{"name":"Failed"},{"name":"MoreData"}]},"replyMessages":{"type":"array","description":"The list of messages to respond with, if any","items":{"$ref":"#/definitions/PostTextMessage"}},"intentName":{"type":"string","description":"The name of the intent the bot is either processing or has processed, this will be blank if no intent could be detected."},"slots":{"type":"object","description":"Data parameters detected and filled by the bot.","additionalProperties":{"type":"string"}},"botCorrelationId":{"type":"string","description":"The optional ID specified in the request"},"amazonLex":{"type":"object","description":"Raw data response from AWS (if called)","additionalProperties":{"type":"object"}},"googleDialogFlow":{"type":"object","description":"Raw data response from Google Dialogflow (if called)","additionalProperties":{"type":"object"}},"genesysDialogEngine":{"type":"object","description":"Raw data response from Genesys' Dialogengine (if called)","additionalProperties":{"type":"object"}}}},"AmazonLexRequest":{"type":"object","properties":{"requestAttributes":{"type":"object","description":"AttributeName/AttributeValue pairs of User Defined Request Attributes to be sent to the amazon bot See - https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-request-attribs","additionalProperties":{"type":"string"}},"sessionAttributes":{"type":"object","description":"AttributeName/AttributeValue pairs of Session Attributes to be sent to the amazon bot. See - https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-session-attribs","additionalProperties":{"type":"string"}}}},"GenesysBotConnector":{"type":"object","properties":{"queryParameters":{"type":"object","description":"User defined name/value parameters passed to the BotConnector bot.","additionalProperties":{"type":"string"}}}},"GoogleDialogflowCustomSettings":{"type":"object","properties":{"environment":{"type":"string","description":"If set this environment will be used to initiate the dialogflow bot, otherwise the default configuration will be used. See https://cloud.google.com/dialogflow/docs/agents-versions"},"eventName":{"type":"string","description":"If set this eventName will be used to initiate the dialogflow bot rather than language processing on the input text. See https://cloud.google.com/dialogflow/es/docs/events-overview"},"webhookQueryParameters":{"type":"object","description":"Parameters passed to the fulfillment webhook of the bot (if any).","additionalProperties":{"type":"string"}},"eventInputParameters":{"type":"object","description":"Parameters passed to the event input of the bot.","additionalProperties":{"type":"string"}}}},"PostTextRequest":{"type":"object","required":["botId","botSessionId","integrationId","postTextMessage"],"properties":{"botId":{"type":"string","description":"ID of the bot to send the text to."},"botAlias":{"type":"string","description":"Alias/Version of the bot"},"integrationId":{"type":"string","description":"the integration service id for the bot's credentials"},"botSessionId":{"type":"string","description":"GUID for this bot's session"},"postTextMessage":{"description":"Message to send to the bot","$ref":"#/definitions/PostTextMessage"},"languageCode":{"type":"string","description":"The launguage code the bot will run under"},"botSessionTimeoutMinutes":{"type":"integer","format":"int32","description":"Override timeout for the bot session. This should be greater than 10 minutes."},"botChannels":{"type":"array","description":"The channels this bot is utilizing","items":{"type":"string","enum":["Call","Callback","Messaging","Webchat"],"x-genesys-enum-members":[{"name":"Call"},{"name":"Callback"},{"name":"Messaging"},{"name":"Webchat"}]}},"botCorrelationId":{"type":"string","description":"Id for tracking the activity - this will be returned in the response"},"messagingPlatformType":{"type":"string","description":"If the channels list contains a 'Messaging' item and the messaging platform is known, include it here to get accurate analytics","enum":["Phone","SMS","GenesysWebWidget","FacebookMessenger","WeChat","Whatsapp","AppleBusinessChat","Telegram","Slack","Signal","Line","Discord","TwitterDirectMessage","Other","Unknown"],"x-genesys-enum-members":[{"name":"Phone"},{"name":"SMS"},{"name":"GenesysWebWidget"},{"name":"FacebookMessenger"},{"name":"WeChat"},{"name":"Whatsapp"},{"name":"AppleBusinessChat"},{"name":"Telegram"},{"name":"Slack"},{"name":"Signal"},{"name":"Line"},{"name":"Discord"},{"name":"TwitterDirectMessage"},{"name":"Other","description":"The transport of the bot conversation is something that isn't explicitly declared."},{"name":"Unknown","description":"The transport of the bot conversation is not known."}]},"amazonLexRequest":{"$ref":"#/definitions/AmazonLexRequest"},"googleDialogflow":{"$ref":"#/definitions/GoogleDialogflowCustomSettings"},"genesysBotConnector":{"$ref":"#/definitions/GenesysBotConnector"}}},"ReportingExportJobRequest":{"type":"object","required":["exportFormat","filter","interval","locale","name","period","timeZone","viewType"],"properties":{"name":{"type":"string","description":"The user supplied name of the export request"},"timeZone":{"type":"string","description":"The requested timezone of the exported data. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"exportFormat":{"type":"string","description":"The requested format of the exported data","enum":["CSV","PDF"],"x-genesys-enum-members":[{"name":"CSV"},{"name":"PDF"}]},"interval":{"type":"string","description":"The time period used to limit the the exported data. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"period":{"type":"string","description":"The Period of the request in which to break down the intervals. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"viewType":{"type":"string","description":"The type of view export job to be created","enum":["QUEUE_PERFORMANCE_SUMMARY_VIEW","QUEUE_PERFORMANCE_DETAIL_VIEW","INTERACTION_SEARCH_VIEW","AGENT_PERFORMANCE_SUMMARY_VIEW","AGENT_PERFORMANCE_DETAIL_VIEW","AGENT_STATUS_SUMMARY_VIEW","AGENT_STATUS_DETAIL_VIEW","AGENT_EVALUATION_SUMMARY_VIEW","AGENT_EVALUATION_DETAIL_VIEW","AGENT_QUEUE_DETAIL_VIEW","AGENT_INTERACTION_DETAIL_VIEW","ABANDON_INSIGHTS_VIEW","SKILLS_PERFORMANCE_VIEW","SURVEY_FORM_PERFORMANCE_SUMMARY_VIEW","SURVEY_FORM_PERFORMANCE_DETAIL_VIEW","DNIS_PERFORMANCE_SUMMARY_VIEW","DNIS_PERFORMANCE_DETAIL_VIEW","WRAP_UP_PERFORMANCE_SUMMARY_VIEW","AGENT_WRAP_UP_PERFORMANCE_DETAIL_VIEW","QUEUE_ACTIVITY_SUMMARY_VIEW","QUEUE_ACTIVITY_DETAIL_VIEW","AGENT_QUEUE_ACTIVITY_SUMMARY_VIEW","QUEUE_AGENT_DETAIL_VIEW","QUEUE_INTERACTION_DETAIL_VIEW","AGENT_SCHEDULE_DETAIL_VIEW","IVR_PERFORMANCE_SUMMARY_VIEW","IVR_PERFORMANCE_DETAIL_VIEW","ANSWER_INSIGHTS_VIEW","HANDLE_INSIGHTS_VIEW","TALK_INSIGHTS_VIEW","HOLD_INSIGHTS_VIEW","ACW_INSIGHTS_VIEW","WAIT_INSIGHTS_VIEW","AGENT_WRAP_UP_PERFORMANCE_INTERVAL_DETAIL_VIEW","FLOW_OUTCOME_SUMMARY_VIEW","FLOW_OUTCOME_PERFORMANCE_DETAIL_VIEW","FLOW_OUTCOME_PERFORMANCE_INTERVAL_DETAIL_VIEW","FLOW_DESTINATION_SUMMARY_VIEW","FLOW_DESTINATION_DETAIL_VIEW","API_USAGE_VIEW","SCHEDULED_CALLBACKS_VIEW","CONTENT_SEARCH_VIEW","LANDING_PAGE","DASHBOARD_SUMMARY","DASHBOARD_DETAIL","JOURNEY_ACTION_MAP_SUMMARY_VIEW","JOURNEY_OUTCOME_SUMMARY_VIEW","JOURNEY_SEGMENT_SUMMARY_VIEW","AGENT_DEVELOPMENT_DETAIL_VIEW","AGENT_DEVELOPMENT_DETAIL_ME_VIEW","AGENT_DEVELOPMENT_SUMMARY_VIEW","AGENT_PERFORMANCE_ME_VIEW","AGENT_STATUS_ME_VIEW","AGENT_EVALUATION_ME_VIEW"],"x-genesys-enum-members":[{"name":"QUEUE_PERFORMANCE_SUMMARY_VIEW"},{"name":"QUEUE_PERFORMANCE_DETAIL_VIEW"},{"name":"INTERACTION_SEARCH_VIEW"},{"name":"AGENT_PERFORMANCE_SUMMARY_VIEW"},{"name":"AGENT_PERFORMANCE_DETAIL_VIEW"},{"name":"AGENT_STATUS_SUMMARY_VIEW"},{"name":"AGENT_STATUS_DETAIL_VIEW"},{"name":"AGENT_EVALUATION_SUMMARY_VIEW"},{"name":"AGENT_EVALUATION_DETAIL_VIEW"},{"name":"AGENT_QUEUE_DETAIL_VIEW"},{"name":"AGENT_INTERACTION_DETAIL_VIEW"},{"name":"ABANDON_INSIGHTS_VIEW"},{"name":"SKILLS_PERFORMANCE_VIEW"},{"name":"SURVEY_FORM_PERFORMANCE_SUMMARY_VIEW"},{"name":"SURVEY_FORM_PERFORMANCE_DETAIL_VIEW"},{"name":"DNIS_PERFORMANCE_SUMMARY_VIEW"},{"name":"DNIS_PERFORMANCE_DETAIL_VIEW"},{"name":"WRAP_UP_PERFORMANCE_SUMMARY_VIEW"},{"name":"AGENT_WRAP_UP_PERFORMANCE_DETAIL_VIEW"},{"name":"QUEUE_ACTIVITY_SUMMARY_VIEW"},{"name":"QUEUE_ACTIVITY_DETAIL_VIEW"},{"name":"AGENT_QUEUE_ACTIVITY_SUMMARY_VIEW"},{"name":"QUEUE_AGENT_DETAIL_VIEW"},{"name":"QUEUE_INTERACTION_DETAIL_VIEW"},{"name":"AGENT_SCHEDULE_DETAIL_VIEW"},{"name":"IVR_PERFORMANCE_SUMMARY_VIEW"},{"name":"IVR_PERFORMANCE_DETAIL_VIEW"},{"name":"ANSWER_INSIGHTS_VIEW"},{"name":"HANDLE_INSIGHTS_VIEW"},{"name":"TALK_INSIGHTS_VIEW"},{"name":"HOLD_INSIGHTS_VIEW"},{"name":"ACW_INSIGHTS_VIEW"},{"name":"WAIT_INSIGHTS_VIEW"},{"name":"AGENT_WRAP_UP_PERFORMANCE_INTERVAL_DETAIL_VIEW"},{"name":"FLOW_OUTCOME_SUMMARY_VIEW"},{"name":"FLOW_OUTCOME_PERFORMANCE_DETAIL_VIEW"},{"name":"FLOW_OUTCOME_PERFORMANCE_INTERVAL_DETAIL_VIEW"},{"name":"FLOW_DESTINATION_SUMMARY_VIEW"},{"name":"FLOW_DESTINATION_DETAIL_VIEW"},{"name":"API_USAGE_VIEW"},{"name":"SCHEDULED_CALLBACKS_VIEW"},{"name":"CONTENT_SEARCH_VIEW"},{"name":"LANDING_PAGE"},{"name":"DASHBOARD_SUMMARY"},{"name":"DASHBOARD_DETAIL"},{"name":"JOURNEY_ACTION_MAP_SUMMARY_VIEW"},{"name":"JOURNEY_OUTCOME_SUMMARY_VIEW"},{"name":"JOURNEY_SEGMENT_SUMMARY_VIEW"},{"name":"AGENT_DEVELOPMENT_DETAIL_VIEW"},{"name":"AGENT_DEVELOPMENT_DETAIL_ME_VIEW"},{"name":"AGENT_DEVELOPMENT_SUMMARY_VIEW"},{"name":"AGENT_PERFORMANCE_ME_VIEW"},{"name":"AGENT_STATUS_ME_VIEW"},{"name":"AGENT_EVALUATION_ME_VIEW"}]},"filter":{"description":"Filters to apply to create the view","$ref":"#/definitions/ViewFilter"},"read":{"type":"boolean","description":"Indicates if the request has been marked as read"},"locale":{"type":"string","description":"The locale use for localization of the exported data, i.e. en-us, es-mx "},"hasFormatDurations":{"type":"boolean","description":"Indicates if durations are formatted in hh:mm:ss format instead of ms"},"hasSplitFilters":{"type":"boolean","description":"Indicates if filters will be split in aggregate detail exports"},"excludeEmptyRows":{"type":"boolean","description":"Excludes empty rows from the exports"},"hasSplitByMedia":{"type":"boolean","description":"Indicates if media type will be split in aggregate detail exports"},"hasSummaryRow":{"type":"boolean","description":"Indicates if summary row needs to be present in exports"},"csvDelimiter":{"type":"string","description":"The user supplied csv delimiter string value either of type 'comma' or 'semicolon' permitted for the export request","enum":["SEMICOLON","COMMA"],"x-genesys-enum-members":[{"name":"SEMICOLON"},{"name":"COMMA"}]},"selectedColumns":{"type":"array","description":"The list of ordered selected columns from the export view by the user","items":{"$ref":"#/definitions/SelectedColumns"}},"hasCustomParticipantAttributes":{"type":"boolean","description":"Indicates if custom participant attributes will be exported"},"recipientEmails":{"type":"array","description":"The list of email recipients for the exports","items":{"type":"string"}}}},"BaseProgramEntity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ProgramJob":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"state":{"type":"string","enum":["Running","Completed","Failed"],"x-genesys-enum-members":[{"name":"Running"},{"name":"Completed"},{"name":"Failed"}]},"programs":{"type":"array","items":{"$ref":"#/definitions/BaseProgramEntity"}},"createdBy":{"$ref":"#/definitions/AddressableEntityRef"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ContactCallbackRequest":{"type":"object","required":["campaignId","contactId","contactListId","phoneColumn","schedule"],"properties":{"campaignId":{"type":"string","description":"Campaign identifier"},"contactListId":{"type":"string","description":"Contact list identifier"},"contactId":{"type":"string","description":"Contact identifier"},"phoneColumn":{"type":"string","description":"Name of the phone column containing the number to be called"},"schedule":{"type":"string","description":"The scheduled time for the callback as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ\", example = \"2016-01-02T16:59:59\""}}},"LineBase":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"lineMetaBase":{"$ref":"#/definitions/DomainEntityRef"},"properties":{"type":"object","additionalProperties":{"type":"object"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CommonCampaignDivisionView":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the Campaign."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"mediaType":{"type":"string","description":"The media type used for this campaign.","enum":["sms","voice"],"x-genesys-enum-members":[{"name":"sms"},{"name":"voice"}]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CommonCampaignDivisionViewEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CommonCampaignDivisionView"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"WidgetClientConfig":{"type":"object","properties":{"v1":{"$ref":"#/definitions/WidgetClientConfigV1"},"v2":{"$ref":"#/definitions/WidgetClientConfigV2"},"v1-http":{"$ref":"#/definitions/WidgetClientConfigV1Http"},"third-party":{"$ref":"#/definitions/WidgetClientConfigThirdParty"}}},"WidgetClientConfigThirdParty":{"type":"object"},"WidgetClientConfigV1":{"type":"object","properties":{"webChatSkin":{"type":"string","enum":["basic","modern-caret-skin"],"x-genesys-enum-members":[{"name":"basic"},{"name":"modern-caret-skin"}]},"authenticationUrl":{"type":"string","format":"uri"}}},"WidgetClientConfigV1Http":{"type":"object","properties":{"webChatSkin":{"type":"string","enum":["basic","modern-caret-skin"],"x-genesys-enum-members":[{"name":"basic"},{"name":"modern-caret-skin"}]},"authenticationUrl":{"type":"string","format":"uri"}}},"WidgetClientConfigV2":{"type":"object"},"WidgetDeployment":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string","description":"A human-readable description of this Deployment."},"authenticationRequired":{"type":"boolean","description":"When true, the customer members starting a chat must be authenticated by supplying their JWT to the create operation."},"disabled":{"type":"boolean","description":"When true, all create chat operations using this Deployment will be rejected."},"flow":{"description":"The URI of the Inbound Chat Flow to run when new chats are initiated under this Deployment.","$ref":"#/definitions/DomainEntityRef"},"allowedDomains":{"type":"array","description":"The list of domains that are approved to use this Deployment; the list will be added to CORS headers for ease of web use.","items":{"type":"string"}},"clientType":{"type":"string","description":"The type of display widget for which this Deployment is configured, which controls the administrator settings shown.","enum":["v1","v2","v1-http","third-party"],"x-genesys-enum-members":[{"name":"v1"},{"name":"v2"},{"name":"v1-http"},{"name":"third-party"}]},"clientConfig":{"description":"The client configuration options that should be made available to the clients of this Deployment.","$ref":"#/definitions/WidgetClientConfig"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ScimV2Group":{"type":"object","required":["displayName"],"properties":{"id":{"type":"string","description":"The ID of the SCIM resource. Set by the service provider. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readOnly\". \"returned\" is set to \"always\".","readOnly":true},"schemas":{"type":"array","description":"The list of supported schemas.","readOnly":true,"items":{"type":"string"}},"displayName":{"type":"string","description":"The display name of the group.","readOnly":true},"externalId":{"type":"string","description":"The external ID of the group. Set by the provisioning client. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readWrite\"."},"members":{"type":"array","description":"The list of members in the group.","items":{"$ref":"#/definitions/ScimV2MemberReference"}},"meta":{"description":"The metadata of the SCIM resource.","readOnly":true,"$ref":"#/definitions/ScimMetadata"}},"description":"Defines a SCIM group."},"ScimV2MemberReference":{"type":"object","properties":{"type":{"type":"string","description":"The type of SCIM resource.","readOnly":true,"enum":["User","Group","ServiceProviderConfig","ResourceType","Schema"],"x-genesys-enum-members":[{"name":"User"},{"name":"Group"},{"name":"ServiceProviderConfig"},{"name":"ResourceType"},{"name":"Schema"}]},"value":{"type":"string","description":"The ID of the group member. Can be \"userId\" or \"groupId\"."},"$ref":{"type":"string","format":"uri","description":"The reference URI of the SCIM resource.","readOnly":true}},"description":"Defines a reference to SCIM group members."},"ScimGroupListResponse":{"type":"object","properties":{"totalResults":{"type":"integer","format":"int64","description":"The total number of results.","readOnly":true},"startIndex":{"type":"integer","format":"int64","description":"The 1-based index of the first result returned by this request. Add this to \"itemsPerPage\" when requesting the next page of results.","readOnly":true},"itemsPerPage":{"type":"integer","format":"int64","description":"The number of resources returned per page.","readOnly":true},"Resources":{"type":"array","description":"The list of requested resources. If \"count\" is 0, then the list will be empty.","readOnly":true,"items":{"$ref":"#/definitions/ScimV2Group"}},"schemas":{"type":"array","description":"The list of supported schemas.","items":{"type":"string"}}},"description":"Defines a response for a list of SCIM groups."},"ChatConversation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"participants":{"type":"array","description":"The list of participants involved in the conversation.","items":{"$ref":"#/definitions/ChatMediaParticipant"}},"otherMediaUris":{"type":"array","description":"The list of other media channels involved in the conversation.","items":{"type":"string","format":"uri"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ChatConversationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ChatConversation"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ChatMediaParticipant":{"type":"object","properties":{"id":{"type":"string","description":"The unique participant ID."},"name":{"type":"string","description":"The display friendly name of the participant."},"address":{"type":"string","description":"The participant address."},"startTime":{"type":"string","format":"date-time","description":"The time when this participant first joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The time when this participant went connected for this media (eg: video connected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startHoldTime":{"type":"string","format":"date-time","description":"The time when this participant's hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"purpose":{"type":"string","description":"The participant's purpose. Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr"},"state":{"type":"string","description":"The participant's state. Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","converting","uploading","transmitting","none"],"x-genesys-enum-members":[{"name":"alerting"},{"name":"dialing"},{"name":"contacting"},{"name":"offering"},{"name":"connected"},{"name":"disconnected"},{"name":"terminated"},{"name":"converting"},{"name":"uploading"},{"name":"transmitting"},{"name":"none"}]},"direction":{"type":"string","description":"The participant's direction. Values can be: 'inbound' or 'outbound'","enum":["inbound","outbound"],"x-genesys-enum-members":[{"name":"inbound"},{"name":"outbound"}]},"disconnectType":{"type":"string","description":"The reason the participant was disconnected from the conversation.","enum":["endpoint","client","system","transfer","transfer.conference","transfer.consult","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam"],"x-genesys-enum-members":[{"name":"endpoint"},{"name":"client"},{"name":"system"},{"name":"transfer"},{"name":"transfer.conference"},{"name":"transfer.consult"},{"name":"transfer.forward"},{"name":"transfer.noanswer"},{"name":"transfer.notavailable"},{"name":"transport.failure"},{"name":"error"},{"name":"peer"},{"name":"other"},{"name":"spam"}]},"held":{"type":"boolean","description":"Value is true when the participant is on hold."},"wrapupRequired":{"type":"boolean","description":"Value is true when the participant requires wrap-up."},"wrapupPrompt":{"type":"string","description":"The wrap-up prompt indicating the type of wrap-up to be performed."},"user":{"description":"The PureCloud user for this participant.","$ref":"#/definitions/DomainEntityRef"},"queue":{"description":"The PureCloud queue for this participant.","$ref":"#/definitions/DomainEntityRef"},"team":{"description":"The PureCloud team for this participant.","$ref":"#/definitions/DomainEntityRef"},"attributes":{"type":"object","description":"A list of ad-hoc attributes for the participant.","additionalProperties":{"type":"string"}},"errorInfo":{"description":"If the conversation ends in error, contains additional error details.","$ref":"#/definitions/ErrorInfo"},"script":{"description":"The Engage script that should be used by this participant.","$ref":"#/definitions/DomainEntityRef"},"wrapupTimeoutMs":{"type":"integer","format":"int32","description":"The amount of time the participant has to complete wrap-up."},"wrapupSkipped":{"type":"boolean","description":"Value is true when the participant has skipped wrap-up."},"alertingTimeoutMs":{"type":"integer","format":"int32","description":"Specifies how long the agent has to answer an interaction before being marked as not responding."},"provider":{"type":"string","description":"The source provider for the communication."},"externalContact":{"description":"If this participant represents an external contact, then this will be the reference for the external contact.","$ref":"#/definitions/DomainEntityRef"},"externalOrganization":{"description":"If this participant represents an external org, then this will be the reference for the external org.","$ref":"#/definitions/DomainEntityRef"},"wrapup":{"description":"Wrapup for this participant, if it has been applied.","$ref":"#/definitions/Wrapup"},"peer":{"type":"string","description":"The peer communication corresponding to a matching leg for this communication."},"flaggedReason":{"type":"string","description":"The reason specifying why participant flagged the conversation.","enum":["general"],"x-genesys-enum-members":[{"name":"general"}]},"journeyContext":{"description":"Journey System data/context that is applicable to this communication. When used for historical purposes, the context should be immutable. When null, there is no applicable Journey System context.","$ref":"#/definitions/JourneyContext"},"conversationRoutingData":{"description":"Information on how a communication should be routed to an agent.","$ref":"#/definitions/ConversationRoutingData"},"startAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"roomId":{"type":"string","description":"The ID of the chat room."},"avatarImageUrl":{"type":"string","description":"If available, the URI to the avatar image of this communication."}}},"PatchUser":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"acdAutoAnswer":{"type":"boolean","description":"The value that denotes if acdAutoAnswer is set on the user"},"certifications":{"type":"array","items":{"type":"string"}},"biography":{"$ref":"#/definitions/Biography"},"employerInfo":{"$ref":"#/definitions/EmployerInfo"}}},"CertificateDetails":{"type":"object","properties":{"issuer":{"type":"string","description":"Information about the issuer of the certificate. The value of this property is a comma separated key=value format. Each key is one of the attribute names supported by X.500."},"subject":{"type":"string","description":"Information about the subject of the certificate. The value of this property is a comma separated key=value format. Each key is one of the attribute names supported by X.500."},"expirationDate":{"type":"string","format":"date-time","description":"The expiration date of the certificate. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"issueDate":{"type":"string","format":"date-time","description":"The issue date of the certificate. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"expired":{"type":"boolean","description":"True if the certificate is expired, false otherwise."},"signatureValid":{"type":"boolean"},"valid":{"type":"boolean"}},"description":"Represents the details of a parsed certificate."},"DomainCertificateAuthority":{"type":"object","required":["certificate","name","services","type"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"certificate":{"type":"string","description":"The authorities signed X509 PEM encoded certificate."},"type":{"type":"string","description":"The certificate authorities type. Managed certificate authorities are generated and maintained by Interactive Intelligence. These are read-only and not modifiable by clients. Remote authorities are customer managed.","enum":["MANAGED","REMOTE"],"x-genesys-enum-members":[{"name":"MANAGED"},{"name":"REMOTE"}]},"services":{"type":"array","description":"The service(s) that the authority can be used to authenticate.","items":{"type":"string","enum":["SIP","PROVISION","PROVISION_PHONE"],"x-genesys-enum-members":[{"name":"SIP"},{"name":"PROVISION"},{"name":"PROVISION_PHONE"}]}},"certificateDetails":{"type":"array","description":"The details of the parsed certificate(s).","items":{"$ref":"#/definitions/CertificateDetails"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"A certificate authority represents an organization that has issued a digital certificate for making secure connections with an edge device."},"CertificateAuthorityEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DomainCertificateAuthority"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EdgeGroupEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/EdgeGroup"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"WidgetDeploymentEntityListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/WidgetDeployment"}},"selfUri":{"type":"string","format":"uri"}}},"PhoneEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Phone"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CoachingAppointmentAggregateResponse":{"type":"object","properties":{"results":{"type":"array","description":"The results of the query","items":{"$ref":"#/definitions/QueryResponseGroupedData"}}}},"QueryResponseData":{"type":"object","properties":{"interval":{"type":"string","description":"Interval with start and end represented as ISO-8601 string. i.e: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'/yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"},"metrics":{"type":"array","description":"A list of aggregated metrics","items":{"$ref":"#/definitions/QueryResponseMetric"}}}},"QueryResponseGroupedData":{"type":"object","properties":{"group":{"type":"object","description":"The group values for this data","additionalProperties":{"type":"string"}},"data":{"type":"array","description":"The metrics in this group","items":{"$ref":"#/definitions/QueryResponseData"}}}},"QueryResponseMetric":{"type":"object","properties":{"metric":{"type":"string","description":"The metric this applies to","enum":["nActivities","nPlannedActivities","nInProgressActivities","nCompleteActivities","nOverdueActivities","nInvalidScheduleActivities"],"x-genesys-enum-members":[{"name":"nActivities"},{"name":"nPlannedActivities"},{"name":"nInProgressActivities"},{"name":"nCompleteActivities"},{"name":"nOverdueActivities"},{"name":"nInvalidScheduleActivities"}]},"stats":{"description":"The aggregated values for this metric","$ref":"#/definitions/QueryResponseStats"}}},"QueryResponseStats":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"The count for this metric"}}},"CoachingAppointmentAggregateRequest":{"type":"object","required":["filter","interval"],"properties":{"interval":{"type":"string","description":"Interval to aggregate across. 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"},"metrics":{"type":"array","description":"A list of metrics to aggregate. If omitted, all metrics are returned.","items":{"type":"string","enum":["nActivities","nPlannedActivities","nInProgressActivities","nCompleteActivities","nOverdueActivities","nInvalidScheduleActivities"],"x-genesys-enum-members":[{"name":"nActivities"},{"name":"nPlannedActivities"},{"name":"nInProgressActivities"},{"name":"nCompleteActivities"},{"name":"nOverdueActivities"},{"name":"nInvalidScheduleActivities"}]}},"groupBy":{"type":"array","description":"An optional list of items by which to group the result data.","items":{"type":"string","enum":["attendeeId"],"x-genesys-enum-members":[{"name":"attendeeId"}]}},"filter":{"description":"The filter applied to the data","$ref":"#/definitions/QueryRequestFilter"}}},"QueryRequestClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"The logic used to combine the predicates","enum":["And","Or"],"x-genesys-enum-members":[{"name":"And"},{"name":"Or"}]},"predicates":{"type":"array","description":"The list of predicates used to filter the data","items":{"$ref":"#/definitions/QueryRequestPredicate"}}}},"QueryRequestFilter":{"type":"object","required":["clauses","type"],"properties":{"type":{"type":"string","description":"The logic used to combine the clauses","enum":["And","Or"],"x-genesys-enum-members":[{"name":"And"},{"name":"Or"}]},"clauses":{"type":"array","description":"The list of clauses used to filter the data","items":{"$ref":"#/definitions/QueryRequestClause"}}}},"QueryRequestPredicate":{"type":"object","required":["dimension","value"],"properties":{"dimension":{"type":"string","description":"The dimension to be filtered","enum":["attendeeId","facilitatorId","status"],"x-genesys-enum-members":[{"name":"attendeeId"},{"name":"facilitatorId"},{"name":"status"}]},"value":{"type":"string","description":"The value to filter by"}}},"ListedTopic":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"published":{"type":"boolean"},"strictness":{"type":"string","enum":["1","55","65","72","85","90"],"x-genesys-enum-members":[{"name":"1"},{"name":"55"},{"name":"65"},{"name":"72"},{"name":"85"},{"name":"90"}]},"programsCount":{"type":"integer","format":"int32"},"tags":{"type":"array","items":{"type":"string"}},"dialect":{"type":"string"},"participants":{"type":"string","enum":["External","Internal","All"],"x-genesys-enum-members":[{"name":"External"},{"name":"Internal"},{"name":"All"}]},"phrasesCount":{"type":"integer","format":"int32"},"modifiedBy":{"$ref":"#/definitions/AddressableEntityRef"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TopicsEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ListedTopic"}},"pageSize":{"type":"integer","format":"int32"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Phrase":{"type":"object","required":["text"],"properties":{"text":{"type":"string","description":"The phrase text"},"strictness":{"type":"string","description":"The phrase strictness, default value is null","enum":["1","55","65","72","85","90"],"x-genesys-enum-members":[{"name":"1"},{"name":"55"},{"name":"65"},{"name":"72"},{"name":"85"},{"name":"90"}]},"sentiment":{"type":"string","description":"The phrase sentiment, default value is Unspecified","enum":["Unspecified","Positive","Neutral","Negative"],"x-genesys-enum-members":[{"name":"Unspecified"},{"name":"Positive"},{"name":"Neutral"},{"name":"Negative"}]}}},"Topic":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"published":{"type":"boolean"},"strictness":{"type":"string","enum":["1","55","65","72","85","90"],"x-genesys-enum-members":[{"name":"1"},{"name":"55"},{"name":"65"},{"name":"72"},{"name":"85"},{"name":"90"}]},"programs":{"type":"array","items":{"$ref":"#/definitions/BaseProgramEntity"}},"tags":{"type":"array","items":{"type":"string"}},"dialect":{"type":"string"},"participants":{"type":"string","enum":["External","Internal","All"],"x-genesys-enum-members":[{"name":"External"},{"name":"Internal"},{"name":"All"}]},"phrases":{"type":"array","items":{"$ref":"#/definitions/Phrase"}},"modifiedBy":{"$ref":"#/definitions/AddressableEntityRef"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"publishedBy":{"$ref":"#/definitions/AddressableEntityRef"},"datePublished":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TopicRequest":{"type":"object","required":["dialect","name"],"properties":{"name":{"type":"string","description":"The topic name"},"description":{"type":"string","description":"The topic description"},"strictness":{"type":"string","description":"The topic strictness, default value is 72","enum":["1","55","65","72","85","90"],"x-genesys-enum-members":[{"name":"1"},{"name":"55"},{"name":"65"},{"name":"72"},{"name":"85"},{"name":"90"}]},"programIds":{"type":"array","description":"The ids of programs associated to the topic","items":{"type":"string"}},"tags":{"type":"array","description":"The topic tags","items":{"type":"string"}},"dialect":{"type":"string","description":"The topic dialect"},"participants":{"type":"string","description":"The topic participants, default value is All","enum":["External","Internal","All"],"x-genesys-enum-members":[{"name":"External"},{"name":"Internal"},{"name":"All"}]},"phrases":{"type":"array","description":"The topic phrases","items":{"$ref":"#/definitions/Phrase"}}}},"DetectedNamedEntity":{"type":"object","properties":{"name":{"type":"string","description":"The name of the detected named entity.","readOnly":true},"entityType":{"type":"string","description":"The type of the detected named entity.","readOnly":true},"probability":{"type":"number","format":"double","description":"The probability of the detected named entity.","readOnly":true},"value":{"description":"The value of the detected named entity.","readOnly":true,"$ref":"#/definitions/DetectedNamedEntityValue"}}},"DetectedNamedEntityValue":{"type":"object","properties":{"raw":{"type":"string","description":"The raw value of the detected named entity.","readOnly":true},"resolved":{"type":"string","description":"The resolved value of the detected named entity.","readOnly":true}}},"IntentFeedback":{"type":"object","properties":{"name":{"type":"string","description":"The name of the detected intent.","readOnly":true},"probability":{"type":"number","format":"double","description":"The probability of the detected intent.","readOnly":true},"entities":{"type":"array","description":"The collection of named entities detected.","readOnly":true,"items":{"$ref":"#/definitions/DetectedNamedEntity"}},"assessment":{"type":"string","description":"The assessment on the detection for feedback text.","enum":["Incorrect","Correct","Unknown","Disabled"],"x-genesys-enum-members":[{"name":"Incorrect"},{"name":"Correct"},{"name":"Unknown"},{"name":"Disabled"}]}}},"NluDomain":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the NLU domain."},"language":{"type":"string","description":"The language culture of the NLU domain, e.g. `en-us`, `de-de`."},"draftVersion":{"description":"The draft version of that NLU domain.","readOnly":true,"$ref":"#/definitions/NluDomainVersion"},"lastPublishedVersion":{"description":"The last published version of that NLU domain.","readOnly":true,"$ref":"#/definitions/NluDomainVersion"},"dateCreated":{"type":"string","format":"date-time","description":"The date when the NLU domain was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date when the NLU domain was updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"NluDomainVersion":{"type":"object","required":["language"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"domain":{"description":"The NLU domain of the version.","readOnly":true,"$ref":"#/definitions/NluDomain"},"description":{"type":"string","description":"The description of the NLU domain version."},"language":{"type":"string","description":"The language that the NLU domain version supports."},"published":{"type":"boolean","description":"Whether this NLU domain version has been published.","readOnly":true},"dateCreated":{"type":"string","format":"date-time","description":"The date when the NLU domain version was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"The date when the NLU domain version was updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateTrained":{"type":"string","format":"date-time","description":"The date when the NLU domain version was trained. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"datePublished":{"type":"string","format":"date-time","description":"The date when the NLU domain version was published. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"trainingStatus":{"type":"string","description":"The training status of the NLU domain version.","readOnly":true,"enum":["Untrained","Training","Trained","Error","Unknown"],"x-genesys-enum-members":[{"name":"Untrained"},{"name":"Training"},{"name":"Trained"},{"name":"Error"},{"name":"Unknown"}]},"evaluationStatus":{"type":"string","description":"The evaluation status of the NLU domain version.","readOnly":true,"enum":["Unevaluated","Evaluating","Evaluated","Error"],"x-genesys-enum-members":[{"name":"Unevaluated"},{"name":"Evaluating"},{"name":"Evaluated"},{"name":"Error"}]},"intents":{"type":"array","description":"The intents defined for this NLU domain version.","items":{"$ref":"#/definitions/IntentDefinition"}},"entityTypes":{"type":"array","description":"The entity types defined for this NLU domain version.","items":{"$ref":"#/definitions/NamedEntityTypeDefinition"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"NluFeedbackResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"text":{"type":"string","description":"The feedback text."},"intents":{"type":"array","description":"Detected intent of the utterance","items":{"$ref":"#/definitions/IntentFeedback"}},"version":{"description":"The domain version of the feedback.","readOnly":true,"$ref":"#/definitions/NluDomainVersion"},"dateCreated":{"type":"string","format":"date-time","description":"The date when the feedback was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DataTableImportJob":{"type":"object","required":["status"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"owner":{"description":"The PureCloud user who started the import job","$ref":"#/definitions/AddressableEntityRef"},"status":{"type":"string","description":"The status of the import job","enum":["WaitingForUpload","Processing","Failed","Succeeded"],"x-genesys-enum-members":[{"name":"WaitingForUpload"},{"name":"Processing"},{"name":"Failed"},{"name":"Succeeded"}]},"dateCreated":{"type":"string","format":"date-time","description":"The timestamp of when the import began. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateCompleted":{"type":"string","format":"date-time","description":"The timestamp of when the import stopped (either successfully or unsuccessfully). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"uploadURI":{"type":"string","format":"uri","description":"The URL of the location at which the caller can upload the file to be imported"},"importMode":{"type":"string","description":"The indication of whether the processing should remove rows that don't appear in the import file","enum":["ReplaceAll","Append"],"x-genesys-enum-members":[{"name":"ReplaceAll"},{"name":"Append"}]},"errorInformation":{"description":"Any error information, or null of the processing is not in an error state","$ref":"#/definitions/ErrorBody"},"countRecordsUpdated":{"type":"integer","format":"int32","description":"The current count of the number of records processed"},"countRecordsDeleted":{"type":"integer","format":"int32","description":"The current count of the number of records deleted"},"countRecordsFailed":{"type":"integer","format":"int32","description":"The current count of the number of records that failed to import"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"State information for an import job of rows to a datatable"},"ChatMessage":{"type":"object","properties":{"body":{"type":"string","description":"The message body"},"id":{"type":"string"},"to":{"type":"string","description":"The message recipient"},"from":{"type":"string","description":"The message sender"},"utc":{"type":"string"},"chat":{"type":"string","description":"The interaction id (if available)"},"message":{"type":"string","description":"The message id"},"type":{"type":"string"},"bodyType":{"type":"string","description":"Type of the message body (v2 chats only)","enum":["STANDARD","ACTIVITY","TYPING","NOTICE","MEMBERJOIN","MEMBERLEAVE","MEDIAREQUEST"],"x-genesys-enum-members":[{"name":"STANDARD"},{"name":"ACTIVITY"},{"name":"TYPING"},{"name":"NOTICE"},{"name":"MEMBERJOIN"},{"name":"MEMBERLEAVE"},{"name":"MEDIAREQUEST"}]},"senderCommunicationId":{"type":"string","description":"Communication of sender (v2 chats only)"},"participantPurpose":{"type":"string","description":"Participant purpose of sender (v2 chats only)"},"user":{"description":"The user information for the sender (if available)","$ref":"#/definitions/ChatMessageUser"}}},"ChatMessageUser":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"displayName":{"type":"string"},"username":{"type":"string"},"images":{"type":"array","items":{"$ref":"#/definitions/UserImage"}}}},"EmailAttachment":{"type":"object","properties":{"name":{"type":"string"},"contentPath":{"type":"string"},"contentType":{"type":"string"},"attachmentId":{"type":"string"},"contentLength":{"type":"integer","format":"int32"}}},"MediaResult":{"type":"object","properties":{"mediaUri":{"type":"string"},"waveformData":{"type":"array","items":{"type":"number","format":"float"}}}},"MessageMediaAttachment":{"type":"object","properties":{"url":{"type":"string","description":"The location of the media, useful for retrieving it"},"mediaType":{"type":"string","description":"The optional internet media type of the the media object.If null then the media type should be dictated by the url.","enum":["image/png","image/jpeg","image/gif"]},"contentLength":{"type":"integer","format":"int64","description":"The optional content length of the the media object, in bytes."},"name":{"type":"string"},"id":{"type":"string"}}},"MessageStickerAttachment":{"type":"object","properties":{"url":{"type":"string","description":"The location of the media, useful for retrieving it"},"id":{"type":"string"}}},"Recording":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"conversationId":{"type":"string"},"path":{"type":"string"},"startTime":{"type":"string","description":"The start time of the recording. Null when there is no playable media."},"endTime":{"type":"string","description":"The end time of the recording. Null when there is no playable media."},"media":{"type":"string","description":"The type of media that the recording is. At the moment that could be audio, chat, or email."},"annotations":{"type":"array","description":"Annotations that belong to the recording.","items":{"$ref":"#/definitions/Annotation"}},"transcript":{"type":"array","description":"Represents a chat transcript","items":{"$ref":"#/definitions/ChatMessage"}},"emailTranscript":{"type":"array","description":"Represents an email transcript","items":{"$ref":"#/definitions/RecordingEmailMessage"}},"messagingTranscript":{"type":"array","description":"Represents a messaging transcript","items":{"$ref":"#/definitions/RecordingMessagingMessage"}},"fileState":{"type":"string","description":"Represents the current file state for a recording. Examples: Uploading, Archived, etc","enum":["ARCHIVED","AVAILABLE","DELETED","RESTORED","RESTORING","UPLOADING","ERROR"],"x-genesys-enum-members":[{"name":"ARCHIVED"},{"name":"AVAILABLE"},{"name":"DELETED"},{"name":"RESTORED"},{"name":"RESTORING"},{"name":"UPLOADING"},{"name":"ERROR"}]},"restoreExpirationTime":{"type":"string","format":"date-time","description":"The amount of time a restored recording will remain restored before being archived again. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"mediaUris":{"type":"object","description":"The different mediaUris for the recording. Null when there is no playable media.","additionalProperties":{"$ref":"#/definitions/MediaResult"}},"estimatedTranscodeTimeMs":{"type":"integer","format":"int64"},"actualTranscodeTimeMs":{"type":"integer","format":"int64"},"archiveDate":{"type":"string","format":"date-time","description":"The date the recording will be archived. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"archiveMedium":{"type":"string","description":"The type of archive medium used. Example: CloudArchive","enum":["CLOUDARCHIVE"],"x-genesys-enum-members":[{"name":"CLOUDARCHIVE"}]},"deleteDate":{"type":"string","format":"date-time","description":"The date the recording will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"exportDate":{"type":"string","format":"date-time","description":"The date the recording will be exported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"exportedDate":{"type":"string","format":"date-time","description":"The date the recording was exported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"outputDurationMs":{"type":"integer","format":"int32","description":"Duration of transcoded media in milliseconds"},"outputSizeInBytes":{"type":"integer","format":"int32","description":"Size of transcoded media in bytes. 0 if there is no transcoded media."},"maxAllowedRestorationsForOrg":{"type":"integer","format":"int32","description":"How many archive restorations the organization is allowed to have."},"remainingRestorationsAllowedForOrg":{"type":"integer","format":"int32","description":"The remaining archive restorations the organization has."},"sessionId":{"type":"string","description":"The session id represents an external resource id, such as email, call, chat, etc"},"users":{"type":"array","description":"The users participating in the conversation","items":{"$ref":"#/definitions/User"}},"recordingFileRole":{"type":"string","description":"Role of the file recording. It can be either customer_experience or adhoc.","enum":["CUSTOMER_EXPERIENCE","ADHOC"],"x-genesys-enum-members":[{"name":"CUSTOMER_EXPERIENCE"},{"name":"ADHOC"}]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"RecordingEmailMessage":{"type":"object","properties":{"htmlBody":{"type":"string"},"textBody":{"type":"string"},"id":{"type":"string"},"to":{"type":"array","items":{"$ref":"#/definitions/EmailAddress"}},"cc":{"type":"array","items":{"$ref":"#/definitions/EmailAddress"}},"bcc":{"type":"array","items":{"$ref":"#/definitions/EmailAddress"}},"from":{"$ref":"#/definitions/EmailAddress"},"subject":{"type":"string"},"attachments":{"type":"array","items":{"$ref":"#/definitions/EmailAttachment"}},"time":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"RecordingMessagingMessage":{"type":"object","properties":{"from":{"type":"string"},"fromUser":{"$ref":"#/definitions/User"},"fromExternalContact":{"$ref":"#/definitions/ExternalContact"},"to":{"type":"string"},"timestamp":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"id":{"type":"string"},"messageText":{"type":"string"},"messageMediaAttachments":{"type":"array","items":{"$ref":"#/definitions/MessageMediaAttachment"}},"messageStickerAttachments":{"type":"array","items":{"$ref":"#/definitions/MessageStickerAttachment"}}}},"DataTableRowEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"type":"object","additionalProperties":{"type":"object"}}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CalibrationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Calibration"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CalibrationCreate":{"type":"object","required":["conversation"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"calibrator":{"$ref":"#/definitions/User"},"agent":{"$ref":"#/definitions/User"},"conversation":{"description":"The conversation to use for the calibration.","$ref":"#/definitions/Conversation"},"evaluationForm":{"$ref":"#/definitions/EvaluationForm"},"contextId":{"type":"string"},"averageScore":{"type":"integer","format":"int32"},"highScore":{"type":"integer","format":"int32"},"lowScore":{"type":"integer","format":"int32"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"evaluations":{"type":"array","items":{"$ref":"#/definitions/Evaluation"}},"evaluators":{"type":"array","items":{"$ref":"#/definitions/User"}},"scoringIndex":{"$ref":"#/definitions/Evaluation"},"expertEvaluator":{"$ref":"#/definitions/User"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ContactList":{"type":"object","required":["columnNames","phoneColumns"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"division":{"description":"The division this entity belongs to.","$ref":"#/definitions/DomainEntityRef"},"columnNames":{"type":"array","description":"The names of the contact data columns.","items":{"type":"string"}},"phoneColumns":{"type":"array","description":"Indicates which columns are phone numbers.","items":{"$ref":"#/definitions/ContactPhoneNumberColumn"}},"importStatus":{"description":"The status of the import process.","readOnly":true,"$ref":"#/definitions/ImportStatus"},"previewModeColumnName":{"type":"string","description":"A column to check if a contact should always be dialed in preview mode."},"previewModeAcceptedValues":{"type":"array","description":"The values in the previewModeColumnName column that indicate a contact should always be dialed in preview mode.","items":{"type":"string"}},"size":{"type":"integer","format":"int64","description":"The number of contacts in the ContactList.","readOnly":true},"attemptLimits":{"description":"AttemptLimits for this ContactList.","$ref":"#/definitions/DomainEntityRef"},"automaticTimeZoneMapping":{"type":"boolean","description":"Indicates if automatic time zone mapping is to be used for this ContactList."},"zipCodeColumnName":{"type":"string","description":"The name of contact list column containing the zip code for use with automatic time zone mapping. Only allowed if 'automaticTimeZoneMapping' is set to true."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TimeZoneMappingPreview":{"type":"object","properties":{"contactList":{"description":"The associated ContactList","$ref":"#/definitions/DomainEntityRef"},"contactsPerTimeZone":{"type":"object","description":"The number of contacts per time zone that mapped to only that time zone","additionalProperties":{"type":"integer","format":"int64"}},"contactsMappedUsingZipCode":{"type":"object","description":"The number of contacts per time zone that mapped to only that time zone and were mapped using the zip code column","additionalProperties":{"type":"integer","format":"int64"}},"contactsMappedToASingleZone":{"type":"integer","format":"int64","description":"The total number of contacts that mapped to a single time zone"},"contactsMappedToASingleZoneUsingZipCode":{"type":"integer","format":"int64","description":"The total number of contacts that mapped to a single time zone and were mapped using the zip code column"},"contactsMappedToMultipleZones":{"type":"integer","format":"int64","description":"The total number of contacts that mapped to multiple time zones"},"contactsMappedToMultipleZonesUsingZipCode":{"type":"integer","format":"int64","description":"The total number of contacts that mapped to multiple time zones and were mapped using the zip code column"},"contactsInDefaultWindow":{"type":"integer","format":"int64","description":"The total number of contacts that will be dialed during the default window"},"contactListSize":{"type":"integer","format":"int64","description":"The total number of contacts in the contact list"}}},"EvaluatorActivity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"evaluator":{"$ref":"#/definitions/User"},"numEvaluationsAssigned":{"type":"integer","format":"int32"},"numEvaluationsStarted":{"type":"integer","format":"int32"},"numEvaluationsCompleted":{"type":"integer","format":"int32"},"numCalibrationsAssigned":{"type":"integer","format":"int32"},"numCalibrationsStarted":{"type":"integer","format":"int32"},"numCalibrationsCompleted":{"type":"integer","format":"int32"},"numEvaluationsWithoutViewPermission":{"type":"integer","format":"int32"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EvaluatorActivityEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/EvaluatorActivity"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"UserListScheduleRequestBody":{"type":"object","required":["endDate","startDate","userIds"],"properties":{"userIds":{"type":"array","description":"The user ids for which to fetch schedules","items":{"type":"string"}},"startDate":{"type":"string","format":"date-time","description":"Beginning of the range of schedules to fetch, in ISO-8601 format"},"endDate":{"type":"string","format":"date-time","description":"End of the range of schedules to fetch, in ISO-8601 format"},"loadFullWeeks":{"type":"boolean","description":"Whether to load the full week's schedule (for the requested users) of any week overlapping the start/end date query parameters, defaults to false"}},"description":"Request body for fetching the schedule for a group of users over a given time range"},"Context":{"type":"object","required":["patterns"],"properties":{"patterns":{"type":"array","description":"A list of one or more patterns to match.","items":{"$ref":"#/definitions/ContextPattern"}}}},"ContextPattern":{"type":"object","required":["criteria"],"properties":{"criteria":{"type":"array","description":"A list of one or more criteria to satisfy.","items":{"$ref":"#/definitions/EntityTypeCriteria"}}}},"Criteria":{"type":"object","required":["key","shouldIgnoreCase","values"],"properties":{"key":{"type":"string","description":"The criteria key."},"values":{"type":"array","description":"The criteria values.","items":{"type":"string"}},"shouldIgnoreCase":{"type":"boolean","description":"Should criteria be case insensitive."},"operator":{"type":"string","description":"The comparison operator.","enum":["containsAll","containsAny","notContainsAll","notContainsAny","equal","notEqual","greaterThan","greaterThanOrEqual","lessThan","lessThanOrEqual","startsWith","endsWith"],"x-genesys-enum-members":[{"name":"containsAll"},{"name":"containsAny"},{"name":"notContainsAll"},{"name":"notContainsAny"},{"name":"equal"},{"name":"notEqual"},{"name":"greaterThan"},{"name":"greaterThanOrEqual"},{"name":"lessThan"},{"name":"lessThanOrEqual"},{"name":"startsWith"},{"name":"endsWith"}]}}},"EntityTypeCriteria":{"type":"object","required":["key","shouldIgnoreCase","values"],"properties":{"key":{"type":"string","description":"The criteria key."},"values":{"type":"array","description":"The criteria values.","items":{"type":"string"}},"shouldIgnoreCase":{"type":"boolean","description":"Should criteria be case insensitive."},"operator":{"type":"string","description":"The comparison operator.","enum":["containsAll","containsAny","notContainsAll","notContainsAny","equal","notEqual","greaterThan","greaterThanOrEqual","lessThan","lessThanOrEqual","startsWith","endsWith"],"x-genesys-enum-members":[{"name":"containsAll"},{"name":"containsAny"},{"name":"notContainsAll"},{"name":"notContainsAny"},{"name":"equal"},{"name":"notEqual"},{"name":"greaterThan"},{"name":"greaterThanOrEqual"},{"name":"lessThan"},{"name":"lessThanOrEqual"},{"name":"startsWith"},{"name":"endsWith"}]},"entityType":{"type":"string","description":"The entity to match the pattern against.","enum":["visit"],"x-genesys-enum-members":[{"name":"visit"}]}}},"Journey":{"type":"object","required":["patterns"],"properties":{"patterns":{"type":"array","description":"A list of zero or more patterns to match.","items":{"$ref":"#/definitions/JourneyPattern"}}}},"JourneyPattern":{"type":"object","required":["criteria","sessionType","streamType"],"properties":{"criteria":{"type":"array","description":"A list of one or more criteria to satisfy.","items":{"$ref":"#/definitions/Criteria"}},"count":{"type":"integer","format":"int32","description":"The number of times the pattern must match."},"streamType":{"type":"string","description":"The stream type for which this pattern can be matched on.","enum":["Web","Custom","Conversation"],"x-genesys-enum-members":[{"name":"Web"},{"name":"Custom"},{"name":"Conversation"}]},"sessionType":{"type":"string","description":"The session type for which this pattern can be matched on."},"eventName":{"type":"string","description":"The name of the event for which this pattern can be matched on."}}},"Outcome":{"type":"object","required":["displayName"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"isActive":{"type":"boolean","description":"Whether or not the outcome is active."},"displayName":{"type":"string","description":"The display name of the outcome."},"version":{"type":"integer","format":"int32","description":"The version of the outcome."},"description":{"type":"string","description":"A description of the outcome."},"isPositive":{"type":"boolean","description":"Whether or not the outcome is positive."},"context":{"description":"The context of the outcome.","$ref":"#/definitions/Context"},"journey":{"description":"The pattern of rules defining the filter of the outcome.","$ref":"#/definitions/Journey"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"createdDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the outcome was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the outcome was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"NluDomainListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/NluDomain"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CoachingAppointmentResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of coaching appointment","readOnly":true},"description":{"type":"string","description":"The description of coaching appointment","readOnly":true},"dateStart":{"type":"string","format":"date-time","description":"The date/time the coaching appointment starts. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"lengthInMinutes":{"type":"integer","format":"int32","description":"The duration of coaching appointment in minutes","readOnly":true},"status":{"type":"string","description":"The status of coaching appointment","readOnly":true,"enum":["Scheduled","InProgress","Completed","InvalidSchedule"],"x-genesys-enum-members":[{"name":"Scheduled"},{"name":"InProgress"},{"name":"Completed"},{"name":"InvalidSchedule"}]},"facilitator":{"description":"The facilitator of coaching appointment","readOnly":true,"$ref":"#/definitions/UserReference"},"attendees":{"type":"array","description":"The list of attendees attending the coaching","readOnly":true,"uniqueItems":true,"items":{"$ref":"#/definitions/UserReference"}},"createdBy":{"description":"The user who created the coaching appointment","readOnly":true,"$ref":"#/definitions/UserReference"},"dateCreated":{"type":"string","format":"date-time","description":"The date/time the coaching appointment was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"description":"The last user to modify the coaching appointment","readOnly":true,"$ref":"#/definitions/UserReference"},"dateModified":{"type":"string","format":"date-time","description":"The date/time the coaching appointment was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"conversations":{"type":"array","description":"The list of conversations associated with coaching appointment.","readOnly":true,"uniqueItems":true,"items":{"$ref":"#/definitions/ConversationReference"}},"documents":{"type":"array","description":"The list of documents associated with coaching appointment.","readOnly":true,"uniqueItems":true,"items":{"$ref":"#/definitions/DocumentReference"}},"isOverdue":{"type":"boolean","description":"Whether the appointment is overdue.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Coaching appointment response"},"CoachingNotification":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the appointment for this notification.","readOnly":true},"markedAsRead":{"type":"boolean","description":"Indicates if notification is read or unread"},"actionType":{"type":"string","description":"Action causing the notification.","readOnly":true,"enum":["Create","Update","Delete","StatusChange"],"x-genesys-enum-members":[{"name":"Create"},{"name":"Update"},{"name":"Delete"},{"name":"StatusChange"}]},"relationship":{"type":"string","description":"The relationship of this user to this notification's appointment","readOnly":true,"enum":["Attendee","Creator","Facilitator"],"x-genesys-enum-members":[{"name":"Attendee"},{"name":"Creator"},{"name":"Facilitator"}]},"dateStart":{"type":"string","format":"date-time","description":"The start time of the appointment relating to this notification. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"lengthInMinutes":{"type":"integer","format":"int32","description":"The duration of the appointment on this notification","readOnly":true},"status":{"type":"string","description":"The status of the appointment for this notification","readOnly":true,"enum":["Scheduled","InProgress","Completed","InvalidSchedule"],"x-genesys-enum-members":[{"name":"Scheduled"},{"name":"InProgress"},{"name":"Completed"},{"name":"InvalidSchedule"}]},"user":{"description":"The user of this notification","readOnly":true,"$ref":"#/definitions/UserReference"},"appointment":{"description":"The appointment","readOnly":true,"$ref":"#/definitions/CoachingAppointmentResponse"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CoachingNotificationList":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CoachingNotification"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ConversationReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DocumentReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WfmBusinessUnitReference":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the business unit"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WfmScheduleReference":{"type":"object","required":["businessUnit","id","weekDate"],"properties":{"id":{"type":"string","description":"The ID of the WFM schedule"},"businessUnit":{"description":"A reference to a Workforce Management Business Unit","$ref":"#/definitions/WfmBusinessUnitReference"},"weekDate":{"type":"string","format":"date","description":"The start week date for this schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GroupMembersUpdate":{"type":"object","required":["memberIds","version"],"properties":{"memberIds":{"type":"array","description":"A list of the ids of the members to add.","items":{"type":"string"}},"version":{"type":"integer","format":"int32","description":"The current group version."}}},"ReportMetaDataEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ReportMetaData"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DateRangeWithOptionalEnd":{"type":"object","required":["startBusinessUnitDate"],"properties":{"startBusinessUnitDate":{"type":"string","format":"date","description":"The start date for work plan rotation or an agent, interpreted in the business unit's time zone. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"endBusinessUnitDate":{"type":"string","format":"date","description":"The end date for work plan rotation or an agent, interpreted in the business unit's time zone. Null denotes open ended date range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"}}},"WorkPlanPatternResponse":{"type":"object","properties":{"workPlans":{"type":"array","description":"List of work plans in order of rotation on a weekly basis","items":{"$ref":"#/definitions/WorkPlanReference"}}}},"WorkPlanRotationAgentResponse":{"type":"object","properties":{"user":{"description":"The user associated with this work plan rotation","$ref":"#/definitions/UserReference"},"dateRange":{"description":"The date range to which this agent is effective in the work plan rotation","$ref":"#/definitions/DateRangeWithOptionalEnd"},"position":{"type":"integer","format":"int32","description":"Start position of the work plan in the pattern for this agent in the work plan rotation. Position value starts from 0"}}},"WorkPlanRotationResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"enabled":{"type":"boolean","description":"Whether the work plan rotation is enabled for scheduling"},"dateRange":{"description":"The date range to which this work plan rotation applies","$ref":"#/definitions/DateRangeWithOptionalEnd"},"pattern":{"description":"Pattern with ordered list of work plans that rotate on a weekly basis","$ref":"#/definitions/WorkPlanPatternResponse"},"agentCount":{"type":"integer","format":"int32","description":"Number of agents in this work plan rotation"},"agents":{"type":"array","description":"Agents in this work plan rotation. Populate with expand=agents for GET WorkPlanRotationsList (defaults to empty list)","items":{"$ref":"#/definitions/WorkPlanRotationAgentResponse"}},"metadata":{"description":"Version metadata for this work plan rotation","$ref":"#/definitions/WfmVersionedEntityMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UpdateWorkPlanRotationAgentRequest":{"type":"object","required":["userId"],"properties":{"userId":{"type":"string","description":"The ID of an agent in this work plan rotation"},"dateRange":{"description":"The date range to which this agent is effective in the work plan rotation","$ref":"#/definitions/DateRangeWithOptionalEnd"},"position":{"type":"integer","format":"int32","description":"Start position of the work plan in the pattern for this agent in the work plan rotation. Position value starts from 0"},"delete":{"type":"boolean","description":"If marked true for this agent when updating, then this agent will be removed from this work plan rotation"}}},"UpdateWorkPlanRotationRequest":{"type":"object","required":["metadata"],"properties":{"name":{"type":"string","description":"Name of this work plan rotation"},"enabled":{"type":"boolean","description":"Whether the work plan rotation is enabled for scheduling"},"dateRange":{"description":"The date range to which this work plan rotation applies","$ref":"#/definitions/DateRangeWithOptionalEnd"},"agents":{"type":"array","description":"Agents in this work plan rotation","items":{"$ref":"#/definitions/UpdateWorkPlanRotationAgentRequest"}},"pattern":{"description":"Pattern with list of work plan IDs that rotate on a weekly basis","$ref":"#/definitions/WorkPlanPatternRequest"},"metadata":{"description":"Version metadata for this work plan rotation","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"WorkPlanPatternRequest":{"type":"object","required":["workPlanIds"],"properties":{"workPlanIds":{"type":"array","description":"List of work plan IDs in order of rotation on a weekly basis. Values in the list cannot be null or empty","items":{"type":"string"}}}},"CopyWorkPlanRotationRequest":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name to apply to the new copy of the work plan rotation"}}},"WorkPlanRotationListResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WorkPlanRotationResponse"}}}},"AddWorkPlanRotationAgentRequest":{"type":"object","required":["dateRange","position","userId"],"properties":{"userId":{"type":"string","description":"The ID of an agent in this work plan rotation"},"dateRange":{"description":"The date range to which this agent is effective in the work plan rotation","$ref":"#/definitions/DateRangeWithOptionalEnd"},"position":{"type":"integer","format":"int32","description":"Start position of the work plan in the pattern for this agent in the work plan rotation. Position value starts from 0"}}},"AddWorkPlanRotationRequest":{"type":"object","required":["dateRange","name","pattern"],"properties":{"name":{"type":"string","description":"Name of this work plan rotation"},"dateRange":{"description":"The date range to which this work plan rotation applies","$ref":"#/definitions/DateRangeWithOptionalEnd"},"agents":{"type":"array","description":"Agents in this work plan rotation","items":{"$ref":"#/definitions/AddWorkPlanRotationAgentRequest"}},"pattern":{"description":"Pattern with list of work plan IDs that rotate on a weekly basis","$ref":"#/definitions/WorkPlanPatternRequest"}}},"PresenceExpand":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"presences":{"type":"array","description":"An array of user presences","items":{"$ref":"#/definitions/UserPresence"}},"outOfOffices":{"type":"array","description":"An array of out of office statuses","items":{"$ref":"#/definitions/OutOfOffice"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserScheduleAdherence":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"user":{"description":"The user for whom this status applies","readOnly":true,"$ref":"#/definitions/UserReference"},"managementUnit":{"description":"The management unit to which this user belongs","readOnly":true,"$ref":"#/definitions/ManagementUnit"},"team":{"description":"The team to which this user belongs","readOnly":true,"$ref":"#/definitions/Team"},"scheduledActivityCategory":{"type":"string","description":"Activity for which the user is scheduled","readOnly":true,"enum":["OnQueueWork","Break","Meal","Meeting","OffQueueWork","TimeOff","Training","Unavailable","Unscheduled"],"x-genesys-enum-members":[{"name":"OnQueueWork"},{"name":"Break"},{"name":"Meal"},{"name":"Meeting"},{"name":"OffQueueWork"},{"name":"TimeOff"},{"name":"Training"},{"name":"Unavailable"},{"name":"Unscheduled"}]},"systemPresence":{"type":"string","description":"Actual underlying system presence value","readOnly":true,"enum":["Available","Away","Busy","Offline","Idle","OnQueue","Meal","Training","Meeting","Break"],"x-genesys-enum-members":[{"name":"Available"},{"name":"Away"},{"name":"Busy"},{"name":"Offline"},{"name":"Idle"},{"name":"OnQueue"},{"name":"Meal"},{"name":"Training"},{"name":"Meeting"},{"name":"Break"}]},"organizationSecondaryPresenceId":{"type":"string","description":"Organization Secondary Presence Id.","readOnly":true},"routingStatus":{"type":"string","description":"Actual underlying routing status, used to determine whether a user is actually in adherence when OnQueue","readOnly":true,"enum":["OFF_QUEUE","IDLE","INTERACTING","NOT_RESPONDING","COMMUNICATING"],"x-genesys-enum-members":[{"name":"OFF_QUEUE"},{"name":"IDLE"},{"name":"INTERACTING"},{"name":"NOT_RESPONDING"},{"name":"COMMUNICATING"}]},"actualActivityCategory":{"type":"string","description":"Activity in which the user is actually engaged","readOnly":true,"enum":["OnQueueWork","Break","Meal","Meeting","OffQueueWork","TimeOff","Training","Unavailable","Unscheduled"],"x-genesys-enum-members":[{"name":"OnQueueWork"},{"name":"Break"},{"name":"Meal"},{"name":"Meeting"},{"name":"OffQueueWork"},{"name":"TimeOff"},{"name":"Training"},{"name":"Unavailable"},{"name":"Unscheduled"}]},"isOutOfOffice":{"type":"boolean","description":"Whether the user is marked OutOfOffice","readOnly":true},"adherenceState":{"type":"string","description":"The user's current adherence state","readOnly":true,"enum":["InAdherence","OutOfAdherence","Unscheduled","Unknown","Ignored"],"x-genesys-enum-members":[{"name":"InAdherence"},{"name":"OutOfAdherence"},{"name":"Unscheduled"},{"name":"Unknown"},{"name":"Ignored"}]},"impact":{"type":"string","description":"The impact of the user's current adherenceState","readOnly":true,"enum":["Positive","Negative","Neutral","Unknown"],"x-genesys-enum-members":[{"name":"Positive"},{"name":"Negative"},{"name":"Neutral"},{"name":"Unknown"}]},"timeOfAdherenceChange":{"type":"string","format":"date-time","description":"Time when the user entered the current adherenceState in ISO-8601 format","readOnly":true},"presenceUpdateTime":{"type":"string","format":"date-time","description":"Time when presence was last updated. Used to calculate time in current status. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"activeQueues":{"type":"array","description":"The list of queues to which this user is joined","readOnly":true,"items":{"$ref":"#/definitions/QueueReference"}},"activeQueuesModifiedTime":{"type":"string","format":"date-time","description":"Time when the list of active queues for this user was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"removedFromManagementUnit":{"type":"boolean","description":"For notification purposes. Used to indicate that a user was removed from the management unit","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Endpoint":{"type":"object","required":["name","schema"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"count":{"type":"integer","format":"int32"},"properties":{"type":"object","additionalProperties":{"type":"object"}},"schema":{"description":"Schema","$ref":"#/definitions/DomainEntityRef"},"enabled":{"type":"boolean"},"site":{"$ref":"#/definitions/DomainEntityRef"},"dids":{"type":"array","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OrphanRecording":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"createdTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"recoveredTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"providerType":{"type":"string","enum":["EDGE","CHAT","EMAIL","SCREEN_RECORDING","PUREENGAGE","PURECONNECT"],"x-genesys-enum-members":[{"name":"EDGE"},{"name":"CHAT"},{"name":"EMAIL"},{"name":"SCREEN_RECORDING"},{"name":"PUREENGAGE"},{"name":"PURECONNECT"}]},"mediaSizeBytes":{"type":"integer","format":"int64"},"mediaType":{"type":"string","enum":["CALL","CHAT","EMAIL","SCREEN"],"x-genesys-enum-members":[{"name":"CALL"},{"name":"CHAT"},{"name":"EMAIL"},{"name":"SCREEN"}]},"fileState":{"type":"string","enum":["ARCHIVED","AVAILABLE","DELETED","RESTORED","RESTORING","UPLOADING"],"x-genesys-enum-members":[{"name":"ARCHIVED"},{"name":"AVAILABLE"},{"name":"DELETED"},{"name":"RESTORED"},{"name":"RESTORING"},{"name":"UPLOADING"}]},"providerEndpoint":{"$ref":"#/definitions/Endpoint"},"recording":{"$ref":"#/definitions/Recording"},"orphanStatus":{"type":"string","description":"The status of the orphaned recording's conversation.","enum":["NO_CONVERSATION","UNKNOWN_CONVERSATION","CONVERSATION_NOT_COMPLETE","CONVERSATION_NOT_EVALUATED","EVALUATED"],"x-genesys-enum-members":[{"name":"NO_CONVERSATION"},{"name":"UNKNOWN_CONVERSATION"},{"name":"CONVERSATION_NOT_COMPLETE"},{"name":"CONVERSATION_NOT_EVALUATED"},{"name":"EVALUATED"}]},"sourceOrphaningId":{"type":"string","description":"An identifier used during recovery operations by the supplying hybrid platform to track back and determine which interaction this recording is associated with"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OrphanUpdateRequest":{"type":"object","properties":{"archiveDate":{"type":"string","format":"date-time","description":"The orphan recording's archive date. Must be greater than 1 day from now if set. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"deleteDate":{"type":"string","format":"date-time","description":"The orphan recording's delete date. Must be greater than archiveDate if set, otherwise one day from now. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"A conversation Id that this orphan's recording is to be attached to. If not present, the conversationId will be deduced from the recording media."}}},"Okta":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"disabled":{"type":"boolean"},"issuerURI":{"type":"string"},"ssoTargetURI":{"type":"string"},"certificate":{"type":"string"},"certificates":{"type":"array","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OAuthProvider":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"disabled":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DocumentFaq":{"type":"object","required":["answer","question"],"properties":{"question":{"type":"string","description":"The question for this FAQ"},"answer":{"type":"string","description":"The answer for this FAQ"},"alternatives":{"type":"array","description":"List of Alternative questions related to the answer which helps in improving the likelihood of a match to user query","items":{"type":"string"}}}},"KnowledgeCategory":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Category name"},"description":{"type":"string","description":"Category description"},"knowledgeBase":{"description":"Knowledge base which category does belong to","readOnly":true,"$ref":"#/definitions/KnowledgeBase"},"languageCode":{"type":"string","description":"Actual language of the category","readOnly":true,"enum":["en-US","de-DE"],"x-genesys-enum-members":[{"name":"en-US"},{"name":"de-DE"}]},"dateCreated":{"type":"string","format":"date-time","description":"Category creation date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Category last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeDocument":{"type":"object","required":["languageCode","type"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"languageCode":{"type":"string","description":"Language of the document","enum":["en-US","de-DE"],"x-genesys-enum-members":[{"name":"en-US"},{"name":"de-DE"}]},"type":{"type":"string","description":"Document type","enum":["Faq"],"x-genesys-enum-members":[{"name":"Faq"}]},"faq":{"description":"FAQ document details","$ref":"#/definitions/DocumentFaq"},"dateCreated":{"type":"string","format":"date-time","description":"Document creation date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Document last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"categories":{"type":"array","description":"Document categories","items":{"$ref":"#/definitions/KnowledgeCategory"}},"knowledgeBase":{"description":"Knowledge base which document does belong to","readOnly":true,"$ref":"#/definitions/KnowledgeBase"},"externalUrl":{"type":"string","description":"External URL to the document"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DocumentCategoryInput":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"KnowledgeBase Category ID"}}},"KnowledgeDocumentRequest":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Document type according to assigned template","enum":["Faq"],"x-genesys-enum-members":[{"name":"Faq"}]},"externalUrl":{"type":"string","description":"External Url to the document"},"faq":{"description":"Faq document details","$ref":"#/definitions/DocumentFaq"},"categories":{"type":"array","description":"Document categories","items":{"$ref":"#/definitions/DocumentCategoryInput"}}}},"KnowledgeSearchDocument":{"type":"object","required":["languageCode","type"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"languageCode":{"type":"string","description":"Language of the document","enum":["en-US","de-DE"],"x-genesys-enum-members":[{"name":"en-US"},{"name":"de-DE"}]},"type":{"type":"string","description":"Document type","enum":["Faq"],"x-genesys-enum-members":[{"name":"Faq"}]},"faq":{"description":"FAQ document details","$ref":"#/definitions/DocumentFaq"},"dateCreated":{"type":"string","format":"date-time","description":"Document creation date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Document last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"categories":{"type":"array","description":"Document categories","items":{"$ref":"#/definitions/KnowledgeCategory"}},"knowledgeBase":{"description":"Knowledge base which document does belong to","readOnly":true,"$ref":"#/definitions/KnowledgeBase"},"externalUrl":{"type":"string","description":"External URL to the document"},"confidence":{"type":"number","format":"double","description":"The confidence associated with a document with respect to a search query","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeSearchResponse":{"type":"object","properties":{"searchId":{"type":"string","description":"Search Id","readOnly":true},"total":{"type":"integer","format":"int32","description":"Total number of records returned","readOnly":true},"pageCount":{"type":"integer","format":"int32","description":"Number of pages returned in the result calculated according to the pageSize and the total","readOnly":true},"pageSize":{"type":"integer","format":"int32","description":"Number of records according to the page size","readOnly":true},"pageNumber":{"type":"integer","format":"int32","description":"Current page number for the returned records","readOnly":true},"results":{"type":"array","description":"Results associated to the search response","readOnly":true,"items":{"$ref":"#/definitions/KnowledgeSearchDocument"}}}},"KnowledgeSearchRequest":{"type":"object","required":["languageCode","query"],"properties":{"query":{"type":"string","description":"Input query to search content in the knowledge base"},"pageSize":{"type":"integer","format":"int32","description":"Page size of the returned results"},"pageNumber":{"type":"integer","format":"int32","description":"Page number of the returned results"},"documentType":{"type":"string","description":"Document type to be used while searching","enum":["Faq"],"x-genesys-enum-members":[{"name":"Faq"}]},"languageCode":{"type":"string","description":"query search for specific languageCode"},"searchOnDraftDocuments":{"type":"boolean","description":"If true the search query will be executed on draft documents, else it will be on active documents"}}},"ExternalOrganizationTrustorLink":{"type":"object","properties":{"externalOrganizationId":{"type":"string","description":"The id of a PureCloud External Organization entity in the External Contacts system that will be used to represent the trustor org"},"trustorOrgId":{"type":"string","description":"The id of a PureCloud organization that has granted trust to this PureCloud organization"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"externalOrganizationUri":{"type":"string","format":"uri","description":"The URI for the External Organization that is linked to the trustor org","readOnly":true}}},"TrustRequest":{"type":"object","required":["trustee"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"createdBy":{"description":"User who created this request.","readOnly":true,"$ref":"#/definitions/OrgUser"},"dateCreated":{"type":"string","format":"date-time","description":"Date request was created. There is a 48 hour expiration on all requests. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"trustee":{"description":"Trustee organization who generated this request.","readOnly":true,"$ref":"#/definitions/Organization"},"users":{"type":"array","description":"The list of trustee users that are requesting access.","readOnly":true,"items":{"$ref":"#/definitions/OrgUser"}},"groups":{"type":"array","description":"The list of trustee groups that are requesting access.","readOnly":true,"items":{"$ref":"#/definitions/TrustGroup"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CreateShareResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"sharedEntityType":{"type":"string","enum":["DOCUMENT"],"x-genesys-enum-members":[{"name":"DOCUMENT"}]},"sharedEntity":{"$ref":"#/definitions/DomainEntityRef"},"memberType":{"type":"string","enum":["USER","GROUP","PUBLIC"],"x-genesys-enum-members":[{"name":"USER"},{"name":"GROUP"},{"name":"PUBLIC"}]},"member":{"$ref":"#/definitions/DomainEntityRef"},"sharedBy":{"$ref":"#/definitions/DomainEntityRef"},"workspace":{"$ref":"#/definitions/DomainEntityRef"},"succeeded":{"type":"array","items":{"$ref":"#/definitions/Share"}},"failed":{"type":"array","items":{"$ref":"#/definitions/Share"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Share":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"sharedEntityType":{"type":"string","enum":["DOCUMENT"],"x-genesys-enum-members":[{"name":"DOCUMENT"}]},"sharedEntity":{"$ref":"#/definitions/DomainEntityRef"},"memberType":{"type":"string","enum":["USER","GROUP","PUBLIC"],"x-genesys-enum-members":[{"name":"USER"},{"name":"GROUP"},{"name":"PUBLIC"}]},"member":{"$ref":"#/definitions/DomainEntityRef"},"sharedBy":{"$ref":"#/definitions/DomainEntityRef"},"workspace":{"$ref":"#/definitions/DomainEntityRef"},"user":{"$ref":"#/definitions/User"},"group":{"$ref":"#/definitions/Group"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CreateShareRequest":{"type":"object","required":["sharedEntity","sharedEntityType"],"properties":{"sharedEntityType":{"type":"string","description":"The share entity type","enum":["DOCUMENT"],"x-genesys-enum-members":[{"name":"DOCUMENT"}]},"sharedEntity":{"description":"The entity that will be shared","$ref":"#/definitions/SharedEntity"},"memberType":{"type":"string","enum":["USER","GROUP","PUBLIC"],"x-genesys-enum-members":[{"name":"USER"},{"name":"GROUP"},{"name":"PUBLIC"}]},"member":{"description":"The member that will have access to this share. Only required if a list of members is not provided.","$ref":"#/definitions/SharedEntity"},"members":{"type":"array","items":{"$ref":"#/definitions/CreateShareRequestMember"}}}},"CreateShareRequestMember":{"type":"object","properties":{"memberType":{"type":"string","enum":["USER","GROUP","PUBLIC"],"x-genesys-enum-members":[{"name":"USER"},{"name":"GROUP"},{"name":"PUBLIC"}]},"member":{"$ref":"#/definitions/MemberEntity"}}},"MemberEntity":{"type":"object","properties":{"id":{"type":"string"}}},"SharedEntity":{"type":"object","properties":{"id":{"type":"string"}}},"ShareEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Share"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ReverseWhitepagesLookupResult":{"type":"object","properties":{"contacts":{"type":"array","items":{"$ref":"#/definitions/ExternalContact"}},"externalOrganizations":{"type":"array","items":{"$ref":"#/definitions/ExternalOrganization"}}}},"DataTableExportJob":{"type":"object","required":["status"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"owner":{"description":"The PureCloud user who started the export job","$ref":"#/definitions/AddressableEntityRef"},"status":{"type":"string","description":"The status of the export job","enum":["Processing","Failed","Succeeded"],"x-genesys-enum-members":[{"name":"Processing"},{"name":"Failed"},{"name":"Succeeded"}]},"dateCreated":{"type":"string","format":"date-time","description":"The timestamp of when the export began. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateCompleted":{"type":"string","format":"date-time","description":"The timestamp of when the export stopped (either successfully or unsuccessfully). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"downloadURI":{"type":"string","format":"uri","description":"The URL of the location at which the caller can download the export file, when available"},"errorInformation":{"description":"Any error information, or null of the processing is not in an error state","$ref":"#/definitions/ErrorBody"},"countRecordsProcessed":{"type":"integer","format":"int32","description":"The current count of the number of records processed"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"State information for an export job of rows from a datatable"},"HistoryEntry":{"type":"object","properties":{"action":{"type":"string","description":"The action performed","enum":["CHECKIN","CHECKOUT","CREATE","DEACTIVATE","DEBUG","DELETE","PUBLISH","REVERT","SAVE","TRANSCODE","UPDATE","UPLOAD"]},"resource":{"type":"string","description":"For actions performed not on the item itself, but on a sub-item, this field identifies the sub-item by name. For example, for actions performed on prompt resources, this will be the prompt resource name."},"timestamp":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"user":{"description":"User associated with this entry.","$ref":"#/definitions/User"},"client":{"description":"OAuth client associated with this entry.","$ref":"#/definitions/DomainEntityRef"},"version":{"type":"string"},"secure":{"type":"boolean"}}},"HistoryListing":{"type":"object","properties":{"id":{"type":"string"},"complete":{"type":"boolean"},"user":{"$ref":"#/definitions/User"},"client":{"$ref":"#/definitions/DomainEntityRef"},"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"errorDetails":{"type":"array","items":{"$ref":"#/definitions/Detail"}},"errorMessageParams":{"type":"object","additionalProperties":{"type":"string"}},"actionName":{"type":"string","description":"Action name","enum":["CREATE","CHECKIN","DEBUG","DELETE","HISTORY","PUBLISH","STATE_CHANGE","UPDATE","VALIDATE"]},"actionStatus":{"type":"string","description":"Action status","enum":["LOCKED","UNLOCKED","STARTED","PENDING_GENERATION","PENDING_BACKEND_NOTIFICATION","SUCCESS","FAILURE"]},"name":{"type":"string"},"description":{"type":"string"},"system":{"type":"boolean"},"started":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"completed":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"entities":{"type":"array","items":{"$ref":"#/definitions/HistoryEntry"}},"total":{"type":"integer","format":"int64"},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"pageCount":{"type":"integer","format":"int32"}}},"CampaignSchedule":{"type":"object","required":["campaign","intervals","timeZone"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"intervals":{"type":"array","description":"A list of intervals during which to run the associated Campaign.","items":{"$ref":"#/definitions/ScheduleInterval"}},"timeZone":{"type":"string","example":"Africa/Abidjan","description":"The time zone for this CampaignSchedule. For example, Africa/Abidjan."},"campaign":{"description":"The Campaign that this CampaignSchedule is for.","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ParsedCertificate":{"type":"object","properties":{"certificateDetails":{"type":"array","description":"The details of the certificates that were parsed correctly.","items":{"$ref":"#/definitions/CertificateDetails"}}},"description":"Represents the parsed certificate information."},"Certificate":{"type":"object","required":["certificate"],"properties":{"certificate":{"type":"string","description":"The certificate to parse."}},"description":"Represents a certificate to parse."},"CursorOrganizationListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ExternalOrganization"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"BuScheduleRun":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"schedulerRunId":{"type":"string","description":"The scheduler run ID. Reference this value for support"},"intradayRescheduling":{"type":"boolean","description":"Whether this is an intraday rescheduling run"},"state":{"type":"string","description":"The state of the generation run","enum":["None","Queued","Scheduling","Canceled","Failed","Complete"],"x-genesys-enum-members":[{"name":"None"},{"name":"Queued"},{"name":"Scheduling"},{"name":"Canceled"},{"name":"Failed"},{"name":"Complete"}]},"weekCount":{"type":"integer","format":"int32","description":"The number of weeks spanned by the schedule"},"percentComplete":{"type":"number","format":"double","description":"Percent completion of the schedule run"},"targetWeek":{"type":"string","format":"date","description":"The start date of the target week. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"schedule":{"description":"The generated schedule. Null unless the schedule run is complete","$ref":"#/definitions/BuScheduleReference"},"scheduleDescription":{"type":"string","description":"The description of the generated schedule"},"schedulingStartTime":{"type":"string","format":"date-time","description":"When the schedule generation run started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"schedulingStartedBy":{"description":"The user who started the scheduling run","$ref":"#/definitions/UserReference"},"schedulingCanceledBy":{"description":"The user who canceled the scheduling run, if applicable","$ref":"#/definitions/UserReference"},"schedulingCompletedTime":{"type":"string","format":"date-time","description":"When the scheduling run was completed, if applicable. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"messageCount":{"type":"integer","format":"int32","description":"The number of schedule generation messages for this schedule generation run"},"reschedulingOptions":{"description":"Rescheduling options for this run. Null unless intradayRescheduling is true","$ref":"#/definitions/ReschedulingOptionsRunResponse"},"reschedulingResultExpiration":{"type":"string","format":"date-time","description":"When the reschedule result will expire. Null unless intradayRescheduling is true. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ReschedulingManagementUnitResponse":{"type":"object","properties":{"managementUnit":{"description":"The management unit","$ref":"#/definitions/ManagementUnitReference"},"applied":{"type":"boolean","description":"Whether the rescheduling run is applied for the given management unit"}}},"ReschedulingOptionsRunResponse":{"type":"object","properties":{"existingSchedule":{"description":"The existing schedule to which this reschedule run applies","$ref":"#/definitions/BuScheduleReference"},"startDate":{"type":"string","format":"date-time","description":"The start date of the period to reschedule. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endDate":{"type":"string","format":"date-time","description":"The end date of the period to reschedule. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"managementUnits":{"type":"array","description":"Per-management unit rescheduling options","items":{"$ref":"#/definitions/ReschedulingManagementUnitResponse"}},"agentCount":{"type":"integer","format":"int32","description":"The number of agents to be considered in the reschedule"},"activityCodeIds":{"type":"array","description":"The IDs of the activity codes being considered for reschedule","uniqueItems":true,"items":{"type":"string"}},"doNotChangeWeeklyPaidTime":{"type":"boolean","description":"Whether weekly paid time is allowed to be changed"},"doNotChangeDailyPaidTime":{"type":"boolean","description":"Whether daily paid time is allowed to be changed"},"doNotChangeShiftStartTimes":{"type":"boolean","description":"Whether shift start times are allowed to be changed"},"doNotChangeManuallyEditedShifts":{"type":"boolean","description":"Whether manually edited shifts are allowed to be changed"}}},"PatchBuReschedulingOptionsManagementUnitRequest":{"type":"object","required":["managementUnitId"],"properties":{"managementUnitId":{"type":"string","description":"The management unit portion of the rescheduling run to update"},"applied":{"type":"boolean","description":"Whether to mark the run as applied. Only applies to reschedule runs. Once applied, a run cannot be un-marked as applied"}}},"PatchBuReschedulingOptionsRequest":{"type":"object","properties":{"managementUnits":{"type":"array","description":"Per-management unit rescheduling options to update","items":{"$ref":"#/definitions/PatchBuReschedulingOptionsManagementUnitRequest"}}}},"PatchBuScheduleRunRequest":{"type":"object","properties":{"reschedulingOptions":{"description":"The rescheduling options to update","$ref":"#/definitions/PatchBuReschedulingOptionsRequest"}}},"BuScheduleRunListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/BuScheduleRun"}}}},"BuAgentScheduleRescheduleResponse":{"type":"object","properties":{"user":{"description":"The user to whom this agent schedule applies","$ref":"#/definitions/UserReference"},"shifts":{"type":"array","description":"The shift definitions for this agent schedule","items":{"$ref":"#/definitions/BuAgentScheduleShift"}},"fullDayTimeOffMarkers":{"type":"array","description":"Full day time off markers which apply to this agent schedule","items":{"$ref":"#/definitions/BuFullDayTimeOffMarker"}},"workPlan":{"description":"The work plan for this user","$ref":"#/definitions/WorkPlanReference"},"workPlansPerWeek":{"type":"array","description":"The work plans per week for this user from the work plan rotation. Null values in the list denotes that user is not part of any work plan for that week","items":{"$ref":"#/definitions/WorkPlanReference"}}}},"BuHeadcountForecast":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/BuPlanningGroupHeadcountForecast"}},"referenceStartDate":{"type":"string","format":"date-time","description":"Reference start date for the interval values in each forecast entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"BuPlanningGroupHeadcountForecast":{"type":"object","properties":{"planningGroup":{"description":"The planning group to which this portion of the headcount forecast applies","$ref":"#/definitions/PlanningGroupReference"},"requiredPerInterval":{"type":"array","description":"Required headcount per interval, referenced against the reference start date","items":{"type":"number","format":"double"}},"requiredWithoutShrinkagePerInterval":{"type":"array","description":"Required headcount per interval without accounting for shrinkage, referenced against the reference start date","items":{"type":"number","format":"double"}}}},"BuRescheduleAgentScheduleResult":{"type":"object","properties":{"managementUnit":{"description":"The management unit to which this part of the result applies","$ref":"#/definitions/ManagementUnitReference"},"downloadResult":{"description":"The agent schedules. Result will always come via the downloadUrl; however the schema is included for documentation","$ref":"#/definitions/MuRescheduleResultWrapper"},"downloadUrl":{"type":"string","description":"The download URL from which to fetch the result"}}},"BuRescheduleResult":{"type":"object","properties":{"generationResults":{"description":"The generation results. Note the result will always be delivered via the downloadUrl; however the schema is included for documentation","$ref":"#/definitions/ScheduleGenerationResult"},"generationResultsDownloadUrl":{"type":"string","description":"The download URL from which to fetch the generation results for the rescheduling run"},"headcountForecast":{"description":"The headcount forecast. Note the result will always be delivered via the downloadUrl; however the schema is included for documentation","$ref":"#/definitions/BuHeadcountForecast"},"headcountForecastDownloadUrl":{"type":"string","description":"The download URL from which to fetch the headcount forecast for the rescheduling run"},"agentSchedules":{"type":"array","description":"List of download links for agent schedules produced by the rescheduling run","items":{"$ref":"#/definitions/BuRescheduleAgentScheduleResult"}}}},"MuRescheduleResultWrapper":{"type":"object","properties":{"agentSchedules":{"type":"array","description":"The list of agent schedules","items":{"$ref":"#/definitions/BuAgentScheduleRescheduleResponse"}}}},"PlanningGroupReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Planning Group"},"ScheduleGenerationMessage":{"type":"object","properties":{"type":{"type":"string","description":"The type of the message","enum":["AgentNotFound","AgentNotInSelectedManagementUnit","AgentNotLicensed","AgentWithoutWorkPlan","WorkPlanNotEnabled","WorkPlanNotFound","AgentWithoutCapability","NoNeedDays","UnableToProduceAgentSchedule","UnableToScheduleMaxConsecutiveWorkingDays","UnableToScheduleMaxConsecutiveWorkingWeekends","UnableToScheduleMaxWeeklyPaidTime","UnableToScheduleMaxWeeklyWorkDays","UnableToScheduleMaxWorkDayPaidTime","UnableToScheduleMinConsecutiveNonWorkingTimePerWeek","UnableToScheduleMinIntershiftTime","UnableToScheduleMinShiftStartDistance","UnableToScheduleMinWeeklyPaidTime","UnableToScheduleMinWeeklyWorkDays","UnableToScheduleMinWorkDayPaidTime","UnableToSchedulePlanningPeriodMaxDaysOff","UnableToSchedulePlanningPeriodMaxPaidTime","UnableToSchedulePlanningPeriodMinDaysOff","UnableToSchedulePlanningPeriodMinPaidTime","UnableToScheduleShiftVariance","UnableToScheduleWorkDay"],"x-genesys-enum-members":[{"name":"AgentNotFound"},{"name":"AgentNotInSelectedManagementUnit"},{"name":"AgentNotLicensed"},{"name":"AgentWithoutWorkPlan"},{"name":"WorkPlanNotEnabled"},{"name":"WorkPlanNotFound"},{"name":"AgentWithoutCapability"},{"name":"NoNeedDays"},{"name":"UnableToProduceAgentSchedule"},{"name":"UnableToScheduleMaxConsecutiveWorkingDays"},{"name":"UnableToScheduleMaxConsecutiveWorkingWeekends"},{"name":"UnableToScheduleMaxWeeklyPaidTime"},{"name":"UnableToScheduleMaxWeeklyWorkDays"},{"name":"UnableToScheduleMaxWorkDayPaidTime"},{"name":"UnableToScheduleMinConsecutiveNonWorkingTimePerWeek"},{"name":"UnableToScheduleMinIntershiftTime"},{"name":"UnableToScheduleMinShiftStartDistance"},{"name":"UnableToScheduleMinWeeklyPaidTime"},{"name":"UnableToScheduleMinWeeklyWorkDays"},{"name":"UnableToScheduleMinWorkDayPaidTime"},{"name":"UnableToSchedulePlanningPeriodMaxDaysOff"},{"name":"UnableToSchedulePlanningPeriodMaxPaidTime"},{"name":"UnableToSchedulePlanningPeriodMinDaysOff"},{"name":"UnableToSchedulePlanningPeriodMinPaidTime"},{"name":"UnableToScheduleShiftVariance"},{"name":"UnableToScheduleWorkDay"}]},"arguments":{"type":"array","description":"The arguments describing the message","items":{"$ref":"#/definitions/SchedulerMessageArgument"}}}},"ScheduleGenerationResult":{"type":"object","properties":{"failed":{"type":"boolean","description":"Whether the schedule generation run failed"},"runId":{"type":"string","description":"The run ID for the schedule generation. Reference this when requesting support"},"messageCount":{"type":"integer","format":"int32","description":"The number of schedule generation messages for this schedule generation run"},"messages":{"type":"array","description":"User facing messages related to the schedule generation run","items":{"$ref":"#/definitions/ScheduleGenerationMessage"}}}},"SchedulerMessageArgument":{"type":"object","properties":{"type":{"type":"string","description":"The type of this message parameter","enum":["AgentId","Date"],"x-genesys-enum-members":[{"name":"AgentId"},{"name":"Date"}]},"value":{"type":"string","description":"The value of this message parameter"}}},"GroupsSearchResponse":{"type":"object","required":["pageCount","pageNumber","pageSize","results","total","types"],"properties":{"total":{"type":"integer","format":"int64","description":"The total number of results found"},"pageCount":{"type":"integer","format":"int32","description":"The total number of pages"},"pageSize":{"type":"integer","format":"int32","description":"The current page size"},"pageNumber":{"type":"integer","format":"int32","description":"The current page number"},"previousPage":{"type":"string","description":"Q64 value for the previous page of results"},"currentPage":{"type":"string","description":"Q64 value for the current page of results"},"nextPage":{"type":"string","description":"Q64 value for the next page of results"},"types":{"type":"array","description":"Resource types the search was performed against","items":{"type":"string"}},"results":{"type":"array","description":"Search results","items":{"$ref":"#/definitions/Group"}}}},"GroupSearchCriteria":{"type":"object","required":["type"],"properties":{"endValue":{"type":"string","description":"The end value of the range. This field is used for range search types."},"values":{"type":"array","description":"A list of values for the search to match against","items":{"type":"string"}},"startValue":{"type":"string","description":"The start value of the range. This field is used for range search types."},"fields":{"type":"array","description":"Field names to search against","items":{"type":"string"}},"value":{"type":"string","description":"A value for the search to match against"},"operator":{"type":"string","description":"How to apply this search criteria against other criteria","enum":["AND","OR","NOT"],"x-genesys-enum-members":[{"name":"AND"},{"name":"OR"},{"name":"NOT"}]},"group":{"type":"array","description":"Groups multiple conditions","items":{"$ref":"#/definitions/GroupSearchCriteria"}},"dateFormat":{"type":"string","description":"Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."},"type":{"type":"string","description":"Search Type","enum":["EXACT","STARTS_WITH","CONTAINS","REGEX","TERM","TERMS","REQUIRED_FIELDS","MATCH_ALL"],"x-genesys-enum-members":[{"name":"EXACT"},{"name":"STARTS_WITH"},{"name":"CONTAINS"},{"name":"REGEX"},{"name":"TERM"},{"name":"TERMS"},{"name":"REQUIRED_FIELDS"},{"name":"MATCH_ALL"}]}}},"GroupSearchRequest":{"type":"object","properties":{"sortOrder":{"type":"string","description":"The sort order for results","enum":["ASC","DESC","SCORE"],"x-genesys-enum-members":[{"name":"ASC"},{"name":"DESC"},{"name":"SCORE"}]},"sortBy":{"type":"string","description":"The field in the resource that you want to sort the results by"},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"},"pageNumber":{"type":"integer","format":"int32","description":"The page of resources you want to retrieve"},"sort":{"type":"array","description":"Multi-value sort order, list of multiple sort values","items":{"$ref":"#/definitions/SearchSort"}},"query":{"type":"array","items":{"$ref":"#/definitions/GroupSearchCriteria"}}}},"SMSAvailablePhoneNumberEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SmsAvailablePhoneNumber"}}}},"SmsAvailablePhoneNumber":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"phoneNumber":{"type":"string","description":"A phone number available for provisioning in E.164 format. E.g. +13175555555 or +34234234234"},"countryCode":{"type":"string","description":"The ISO 3166-1 alpha-2 country code of the country this phone number is associated with."},"region":{"type":"string","description":"The region/province/state the phone number is associated with."},"city":{"type":"string","description":"The city the phone number is associated with."},"capabilities":{"type":"array","description":"The capabilities of the phone number available for provisioning.","items":{"type":"string","enum":["sms","mms","voice"],"x-genesys-enum-members":[{"name":"sms"},{"name":"mms"},{"name":"voice"}]}},"phoneNumberType":{"type":"string","description":"The type of phone number available for provisioning.","enum":["local","mobile","tollfree","shortcode"],"x-genesys-enum-members":[{"name":"local"},{"name":"mobile"},{"name":"tollfree"},{"name":"shortcode"}]},"addressRequirement":{"type":"string","description":"The address requirement needed for provisioning this number. If there is a requirement, the address must be the residence or place of business of the individual or entity using the phone number.","enum":["none","any","local","foreign"],"x-genesys-enum-members":[{"name":"none"},{"name":"any"},{"name":"local"},{"name":"foreign"}]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DocumentUpload":{"type":"object","required":["name","workspace"],"properties":{"name":{"type":"string","description":"The name of the document"},"workspace":{"description":"The workspace the document will be uploaded to","$ref":"#/definitions/DomainEntityRef"},"tags":{"type":"array","items":{"type":"string"}},"tagIds":{"type":"array","items":{"type":"string"}}}},"RegionTimeZone":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"offset":{"type":"integer","format":"int64"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TimeZoneEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/RegionTimeZone"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"LicenseOrgToggle":{"type":"object","properties":{"featureName":{"type":"string"},"enabled":{"type":"boolean"}}},"IntegrationTypeEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/IntegrationType"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"OrphanRecordingListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/OrphanRecording"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"GKNDocumentationResult":{"type":"object","required":["_type"],"properties":{"content":{"type":"string","description":"The text or html content for the documentation entity. Will be returned in responses for certain entities."},"link":{"type":"string","description":"URL link for the documentation entity. Will be returned in responses for certain entities."},"title":{"type":"string","description":"The title of the documentation entity. Will be returned in responses for certain entities."},"_type":{"type":"string","description":"The search type. Will be returned in responses for certain entities."}}},"GKNDocumentationSearchResponse":{"type":"object","required":["pageCount","pageNumber","pageSize","results","total","types"],"properties":{"total":{"type":"integer","format":"int64","description":"The total number of results found"},"pageCount":{"type":"integer","format":"int32","description":"The total number of pages"},"pageSize":{"type":"integer","format":"int32","description":"The current page size"},"pageNumber":{"type":"integer","format":"int32","description":"The current page number"},"previousPage":{"type":"string","description":"Q64 value for the previous page of results"},"currentPage":{"type":"string","description":"Q64 value for the current page of results"},"nextPage":{"type":"string","description":"Q64 value for the next page of results"},"types":{"type":"array","description":"Resource types the search was performed against","items":{"type":"string"}},"results":{"type":"array","description":"Search results","items":{"$ref":"#/definitions/GKNDocumentationResult"}}}},"GKNDocumentationSearchCriteria":{"type":"object","required":["type"],"properties":{"endValue":{"type":"string","description":"The end value of the range. This field is used for range search types."},"values":{"type":"array","description":"A list of values for the search to match against","items":{"type":"string"}},"startValue":{"type":"string","description":"The start value of the range. This field is used for range search types."},"fields":{"type":"array","description":"Field names to search against","items":{"type":"string"}},"value":{"type":"string","description":"A value for the search to match against"},"operator":{"type":"string","description":"How to apply this search criteria against other criteria","enum":["AND","OR","NOT"],"x-genesys-enum-members":[{"name":"AND"},{"name":"OR"},{"name":"NOT"}]},"group":{"type":"array","description":"Groups multiple conditions","items":{"$ref":"#/definitions/GKNDocumentationSearchCriteria"}},"dateFormat":{"type":"string","description":"Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."},"type":{"type":"string","description":"Search Type","enum":["SIMPLE"],"x-genesys-enum-members":[{"name":"SIMPLE"}]}}},"GKNDocumentationSearchRequest":{"type":"object","properties":{"sortOrder":{"type":"string","description":"The sort order for results","enum":["ASC","DESC","SCORE"],"x-genesys-enum-members":[{"name":"ASC"},{"name":"DESC"},{"name":"SCORE"}]},"sortBy":{"type":"string","description":"The field in the resource that you want to sort the results by"},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"},"pageNumber":{"type":"integer","format":"int32","description":"The page of resources you want to retrieve"},"sort":{"type":"array","description":"Multi-value sort order, list of multiple sort values","items":{"$ref":"#/definitions/SearchSort"}},"query":{"type":"array","items":{"$ref":"#/definitions/GKNDocumentationSearchCriteria"}}}},"InteractionStatsAlertContainer":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/InteractionStatsAlert"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CommandStatus":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"expiration":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"userId":{"type":"string"},"statusCode":{"type":"string","enum":["INPROGRESS","COMPLETE","ERROR","CANCELING","CANCELED"],"x-genesys-enum-members":[{"name":"INPROGRESS"},{"name":"COMPLETE"},{"name":"ERROR"},{"name":"CANCELING"},{"name":"CANCELED"}]},"commandType":{"type":"string","enum":["UPLOAD","COPYDOCUMENT","MOVEDOCUMENT","DELETEWORKSPACE","DELETEDOCUMENT","DELETETAG","UPDATETAG","REINDEX","CLEANUP","REPLACEDOCUMENT"],"x-genesys-enum-members":[{"name":"UPLOAD"},{"name":"COPYDOCUMENT"},{"name":"MOVEDOCUMENT"},{"name":"DELETEWORKSPACE"},{"name":"DELETEDOCUMENT"},{"name":"DELETETAG"},{"name":"UPDATETAG"},{"name":"REINDEX"},{"name":"CLEANUP"},{"name":"REPLACEDOCUMENT"}]},"document":{"$ref":"#/definitions/Document"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CommandStatusEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CommandStatus"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DivsPermittedEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AuthzDivision"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"allDivsPermitted":{"type":"boolean"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"PureEngage":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"disabled":{"type":"boolean"},"issuerURI":{"type":"string"},"ssoTargetURI":{"type":"string"},"certificate":{"type":"string"},"certificates":{"type":"array","items":{"type":"string"}},"autoProvisionUsers":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserSkillEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UserRoutingSkill"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"UserRoutingSkillPost":{"type":"object","required":["id","proficiency"],"properties":{"id":{"type":"string","description":"The id of the existing routing skill to add to the user"},"proficiency":{"type":"number","format":"double","description":"Proficiency is a rating from 0.0 to 5.0 on how competent an agent is for a particular skill. It is used when a queue is set to \"Best available skills\" mode to allow acd interactions to target agents with higher proficiency ratings."},"skillUri":{"type":"string","format":"uri","description":"URI to the organization skill used by this user skill.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Represents an organization skill assigned to a user. When assigning to a user specify the organization skill id as the id."},"AttemptLimits":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"maxAttemptsPerContact":{"type":"integer","format":"int32","description":"The maximum number of times a contact can be called within the resetPeriod. Required if maxAttemptsPerNumber is not defined."},"maxAttemptsPerNumber":{"type":"integer","format":"int32","description":"The maximum number of times a phone number can be called within the resetPeriod. Required if maxAttemptsPerContact is not defined."},"timeZoneId":{"type":"string","description":"If the resetPeriod is TODAY, this specifies the timezone in which TODAY occurs. Required if the resetPeriod is TODAY."},"resetPeriod":{"type":"string","description":"After how long the number of attempts will be set back to 0. Defaults to NEVER.","enum":["NEVER","TODAY"],"x-genesys-enum-members":[{"name":"NEVER"},{"name":"TODAY"}]},"recallEntries":{"type":"object","description":"Configuration for recall attempts.","additionalProperties":{"$ref":"#/definitions/RecallEntry"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"RecallEntry":{"type":"object","properties":{"nbrAttempts":{"type":"integer","format":"int32"},"minutesBetweenAttempts":{"type":"integer","format":"int32"}}},"AttemptLimitsEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AttemptLimits"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EmailConversation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"participants":{"type":"array","description":"The list of participants involved in the conversation.","items":{"$ref":"#/definitions/EmailMediaParticipant"}},"otherMediaUris":{"type":"array","description":"The list of other media channels involved in the conversation.","items":{"type":"string","format":"uri"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EmailConversationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/EmailConversation"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EmailMediaParticipant":{"type":"object","properties":{"id":{"type":"string","description":"The unique participant ID."},"name":{"type":"string","description":"The display friendly name of the participant."},"address":{"type":"string","description":"The participant address."},"startTime":{"type":"string","format":"date-time","description":"The time when this participant first joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The time when this participant went connected for this media (eg: video connected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startHoldTime":{"type":"string","format":"date-time","description":"The time when this participant's hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"purpose":{"type":"string","description":"The participant's purpose. Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr"},"state":{"type":"string","description":"The participant's state. Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","converting","uploading","transmitting","none"],"x-genesys-enum-members":[{"name":"alerting"},{"name":"dialing"},{"name":"contacting"},{"name":"offering"},{"name":"connected"},{"name":"disconnected"},{"name":"terminated"},{"name":"converting"},{"name":"uploading"},{"name":"transmitting"},{"name":"none"}]},"direction":{"type":"string","description":"The participant's direction. Values can be: 'inbound' or 'outbound'","enum":["inbound","outbound"],"x-genesys-enum-members":[{"name":"inbound"},{"name":"outbound"}]},"disconnectType":{"type":"string","description":"The reason the participant was disconnected from the conversation.","enum":["endpoint","client","system","transfer","transfer.conference","transfer.consult","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam"],"x-genesys-enum-members":[{"name":"endpoint"},{"name":"client"},{"name":"system"},{"name":"transfer"},{"name":"transfer.conference"},{"name":"transfer.consult"},{"name":"transfer.forward"},{"name":"transfer.noanswer"},{"name":"transfer.notavailable"},{"name":"transport.failure"},{"name":"error"},{"name":"peer"},{"name":"other"},{"name":"spam"}]},"held":{"type":"boolean","description":"Value is true when the participant is on hold."},"wrapupRequired":{"type":"boolean","description":"Value is true when the participant requires wrap-up."},"wrapupPrompt":{"type":"string","description":"The wrap-up prompt indicating the type of wrap-up to be performed."},"user":{"description":"The PureCloud user for this participant.","$ref":"#/definitions/DomainEntityRef"},"queue":{"description":"The PureCloud queue for this participant.","$ref":"#/definitions/DomainEntityRef"},"team":{"description":"The PureCloud team for this participant.","$ref":"#/definitions/DomainEntityRef"},"attributes":{"type":"object","description":"A list of ad-hoc attributes for the participant.","additionalProperties":{"type":"string"}},"errorInfo":{"description":"If the conversation ends in error, contains additional error details.","$ref":"#/definitions/ErrorInfo"},"script":{"description":"The Engage script that should be used by this participant.","$ref":"#/definitions/DomainEntityRef"},"wrapupTimeoutMs":{"type":"integer","format":"int32","description":"The amount of time the participant has to complete wrap-up."},"wrapupSkipped":{"type":"boolean","description":"Value is true when the participant has skipped wrap-up."},"alertingTimeoutMs":{"type":"integer","format":"int32","description":"Specifies how long the agent has to answer an interaction before being marked as not responding."},"provider":{"type":"string","description":"The source provider for the communication."},"externalContact":{"description":"If this participant represents an external contact, then this will be the reference for the external contact.","$ref":"#/definitions/DomainEntityRef"},"externalOrganization":{"description":"If this participant represents an external org, then this will be the reference for the external org.","$ref":"#/definitions/DomainEntityRef"},"wrapup":{"description":"Wrapup for this participant, if it has been applied.","$ref":"#/definitions/Wrapup"},"peer":{"type":"string","description":"The peer communication corresponding to a matching leg for this communication."},"flaggedReason":{"type":"string","description":"The reason specifying why participant flagged the conversation.","enum":["general"],"x-genesys-enum-members":[{"name":"general"}]},"journeyContext":{"description":"Journey System data/context that is applicable to this communication. When used for historical purposes, the context should be immutable. When null, there is no applicable Journey System context.","$ref":"#/definitions/JourneyContext"},"conversationRoutingData":{"description":"Information on how a communication should be routed to an agent.","$ref":"#/definitions/ConversationRoutingData"},"startAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"subject":{"type":"string","description":"The subject of the email."},"messagesSent":{"type":"integer","format":"int32","description":"The number of messages that have been sent in this email conversation."},"autoGenerated":{"type":"boolean","description":"Indicates that the email was auto-generated like an Out of Office reply."},"draftAttachments":{"type":"array","description":"A list of uploaded attachments on the email draft.","items":{"$ref":"#/definitions/Attachment"}},"spam":{"type":"boolean","description":"Indicates if the inbound email was marked as spam."},"messageId":{"type":"string","description":"A globally unique identifier for the stored content of this communication."}}},"VoicemailGroupPolicy":{"type":"object","properties":{"name":{"type":"string"},"group":{"description":"The group associated with the policy","readOnly":true,"$ref":"#/definitions/Group"},"enabled":{"type":"boolean","description":"Whether voicemail is enabled for the group"},"sendEmailNotifications":{"type":"boolean","description":"Whether email notifications are sent to group members when a new voicemail is received"},"rotateCallsSecs":{"type":"integer","format":"int32","description":"How many seconds to ring before rotating to the next member in the group"},"stopRingingAfterRotations":{"type":"integer","format":"int32","description":"How many rotations to go through"},"overflowGroupId":{"type":"string","description":" A fallback group to contact when all of the members in this group did not answer the call."},"groupAlertType":{"type":"string","description":"Specifies if the members in this group should be contacted randomly, in a specific order, or by round-robin.","enum":["RANDOM","ROUND_ROBIN","SEQUENTIAL"],"x-genesys-enum-members":[{"name":"RANDOM"},{"name":"ROUND_ROBIN"},{"name":"SEQUENTIAL"}]}}},"LicenseUpdateStatus":{"type":"object","properties":{"userId":{"type":"string"},"licenseId":{"type":"string"},"result":{"type":"string"}}},"LicenseAssignmentRequest":{"type":"object","required":["licenseId","userIdsAdd","userIdsRemove"],"properties":{"licenseId":{"type":"string","description":"The id of the license to assign/unassign."},"userIdsAdd":{"type":"array","description":"The ids of users to assign this license to.","uniqueItems":true,"items":{"type":"string"}},"userIdsRemove":{"type":"array","description":"The ids of users to unassign this license from.","uniqueItems":true,"items":{"type":"string"}}}},"LicenseBatchAssignmentRequest":{"type":"object","required":["assignments"],"properties":{"assignments":{"type":"array","description":"The list of license assignment updates to make.","items":{"$ref":"#/definitions/LicenseAssignmentRequest"}}}},"DefaultGreetingList":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"owner":{"$ref":"#/definitions/GreetingOwner"},"ownerType":{"type":"string","enum":["USER","ORGANIZATION","GROUP"],"x-genesys-enum-members":[{"name":"USER"},{"name":"ORGANIZATION"},{"name":"GROUP"}]},"greetings":{"type":"object","additionalProperties":{"$ref":"#/definitions/Greeting"}},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"type":"string","format":"uri"},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GreetingOwner":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CoachingAppointmentReference":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CoachingAppointmentStatusResponse":{"type":"object","properties":{"appointment":{"description":"The coaching appointment this status belongs to","readOnly":true,"$ref":"#/definitions/CoachingAppointmentReference"},"createdBy":{"description":"User who updated the status","readOnly":true,"$ref":"#/definitions/UserReference"},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the status. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"status":{"type":"string","description":"The status of the coaching appointment","readOnly":true,"enum":["Scheduled","InProgress","Completed","InvalidSchedule"],"x-genesys-enum-members":[{"name":"Scheduled"},{"name":"InProgress"},{"name":"Completed"},{"name":"InvalidSchedule"}]}}},"CoachingAppointmentStatusResponseList":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CoachingAppointmentStatusResponse"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"pageCount":{"type":"integer","format":"int32"}}},"CoachingAppointmentStatusRequest":{"type":"object","required":["status"],"properties":{"status":{"type":"string","description":"The status of the coaching appointment","enum":["Scheduled","InProgress","Completed"],"x-genesys-enum-members":[{"name":"Scheduled"},{"name":"InProgress"},{"name":"Completed"}]}}},"TranscriptionSettings":{"type":"object","required":["transcription","transcriptionConfidenceThreshold"],"properties":{"transcription":{"type":"string","description":"Setting to enable/disable transcription capability","enum":["Disabled","EnabledGlobally","EnabledQueueFlow"],"x-genesys-enum-members":[{"name":"Disabled"},{"name":"EnabledGlobally"},{"name":"EnabledQueueFlow"}]},"transcriptionConfidenceThreshold":{"type":"integer","format":"int32","description":"Configure confidence threshold. The possible values are from 1 to 100."},"contentSearchEnabled":{"type":"boolean","description":"Setting to enable/disable content search"}}},"ContactCenterSettings":{"type":"object","properties":{"removeSkillsFromBlindTransfer":{"type":"boolean","description":"Strip skills from transfer"}}},"RoutingSettings":{"type":"object","properties":{"resetAgentScoreOnPresenceChange":{"type":"boolean","description":"Reset agent score when agent presence changes from off-queue to on-queue"}}},"OAuthClientEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/OAuthClientListing"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"OAuthClientListing":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the OAuth client."},"accessTokenValiditySeconds":{"type":"integer","format":"int64","description":"The number of seconds, between 5mins and 48hrs, until tokens created with this client expire. If this field is omitted, a default of 24 hours will be applied."},"description":{"type":"string"},"registeredRedirectUri":{"type":"array","description":"List of allowed callbacks for this client. For example: https://myap.example.com/auth/callback","items":{"type":"string","format":"uri"}},"secret":{"type":"string","description":"System created secret assigned to this client. Secrets are required for code authorization and client credential grants."},"roleIds":{"type":"array","description":"Deprecated. Use roleDivisions instead.","uniqueItems":true,"items":{"type":"string"}},"dateCreated":{"type":"string","format":"date-time","description":"Date this client was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date this client was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"description":"User that created this client","$ref":"#/definitions/DomainEntityRef"},"modifiedBy":{"description":"User that last modified this client","$ref":"#/definitions/DomainEntityRef"},"scope":{"type":"array","description":"The scope requested by this client. Scopes only apply to clients not using the client_credential grant","items":{"type":"string"}},"roleDivisions":{"type":"array","description":"Set of roles and their corresponding divisions associated with this client. Roles and divisions only apply to clients using the client_credential grant","uniqueItems":true,"items":{"$ref":"#/definitions/RoleDivision"}},"state":{"type":"string","description":"The state of the OAuth client.\nActive: The OAuth client can be used to create access tokens. This is the default state.\nDisabled: Access tokens created by the client are invalid and new ones cannot be created.\nInactive: Access tokens cannot be created with this OAuth client and it will be deleted.","enum":["active","disabled","inactive"],"x-genesys-enum-members":[{"name":"active"},{"name":"disabled"},{"name":"inactive"}]},"dateToDelete":{"type":"string","format":"date-time","description":"The time at which this client will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OAuthClient":{"type":"object","required":["authorizedGrantType","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the OAuth client."},"accessTokenValiditySeconds":{"type":"integer","format":"int64","description":"The number of seconds, between 5mins and 48hrs, until tokens created with this client expire. If this field is omitted, a default of 24 hours will be applied."},"description":{"type":"string"},"registeredRedirectUri":{"type":"array","description":"List of allowed callbacks for this client. For example: https://myap.example.com/auth/callback","items":{"type":"string","format":"uri"}},"secret":{"type":"string","description":"System created secret assigned to this client. Secrets are required for code authorization and client credential grants."},"roleIds":{"type":"array","description":"Deprecated. Use roleDivisions instead.","uniqueItems":true,"items":{"type":"string"}},"dateCreated":{"type":"string","format":"date-time","description":"Date this client was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date this client was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"description":"User that created this client","$ref":"#/definitions/DomainEntityRef"},"modifiedBy":{"description":"User that last modified this client","$ref":"#/definitions/DomainEntityRef"},"authorizedGrantType":{"type":"string","description":"The OAuth Grant/Client type supported by this client.\nCode Authorization Grant/Client type - Preferred client type where the Client ID and Secret are required to create tokens. Used where the secret can be secured.\nPKCE-Enabled Code Authorization grant type - Code grant type which requires PKCE challenge and verifier to create tokens. Used in public clients for increased security.\nImplicit grant type - Client ID only is required to create tokens. Used in browser and mobile apps where the secret can not be secured.\nSAML2-Bearer extension grant type - SAML2 assertion provider for user authentication at the token endpoint.\nClient Credential grant type - Used to created access tokens that are tied only to the client.\n","enum":["CODE","CODE_PKCE","TOKEN","SAML2BEARER","PASSWORD","CLIENT_CREDENTIALS"],"x-genesys-enum-members":[{"name":"CODE"},{"name":"CODE_PKCE"},{"name":"TOKEN"},{"name":"SAML2BEARER"},{"name":"PASSWORD"},{"name":"CLIENT_CREDENTIALS"}]},"scope":{"type":"array","description":"The scope requested by this client. Scopes only apply to clients not using the client_credential grant","items":{"type":"string"}},"roleDivisions":{"type":"array","description":"Set of roles and their corresponding divisions associated with this client. Roles and divisions only apply to clients using the client_credential grant","uniqueItems":true,"items":{"$ref":"#/definitions/RoleDivision"}},"state":{"type":"string","description":"The state of the OAuth client.\nActive: The OAuth client can be used to create access tokens. This is the default state.\nDisabled: Access tokens created by the client are invalid and new ones cannot be created.\nInactive: Access tokens cannot be created with this OAuth client and it will be deleted.","enum":["active","disabled","inactive"],"x-genesys-enum-members":[{"name":"active"},{"name":"disabled"},{"name":"inactive"}]},"dateToDelete":{"type":"string","format":"date-time","description":"The time at which this client will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OAuthClientRequest":{"type":"object","required":["authorizedGrantType","name"],"properties":{"name":{"type":"string","description":"The name of the OAuth client."},"accessTokenValiditySeconds":{"type":"integer","format":"int64","description":"The number of seconds, between 5mins and 48hrs, until tokens created with this client expire. If this field is omitted, a default of 24 hours will be applied."},"description":{"type":"string"},"registeredRedirectUri":{"type":"array","description":"List of allowed callbacks for this client. For example: https://myap.example.com/auth/callback","items":{"type":"string","format":"uri"}},"roleIds":{"type":"array","description":"Deprecated. Use roleDivisions instead.","uniqueItems":true,"items":{"type":"string"}},"authorizedGrantType":{"type":"string","description":"The OAuth Grant/Client type supported by this client.\nCode Authorization Grant/Client type - Preferred client type where the Client ID and Secret are required to create tokens. Used where the secret can be secured.\nPKCE-Enabled Code Authorization grant type - Code grant type which requires PKCE challenge and verifier to create tokens. Used in public clients for increased security.\nImplicit grant type - Client ID only is required to create tokens. Used in browser and mobile apps where the secret can not be secured.\nSAML2-Bearer extension grant type - SAML2 assertion provider for user authentication at the token endpoint.\nClient Credential grant type - Used to created access tokens that are tied only to the client.\n","enum":["CODE","CODE_PKCE","TOKEN","SAML2BEARER","PASSWORD","CLIENT_CREDENTIALS"],"x-genesys-enum-members":[{"name":"CODE"},{"name":"CODE_PKCE"},{"name":"TOKEN"},{"name":"SAML2BEARER"},{"name":"PASSWORD"},{"name":"CLIENT_CREDENTIALS"}]},"scope":{"type":"array","description":"The scope requested by this client. Scopes only apply to clients not using the client_credential grant","items":{"type":"string"}},"roleDivisions":{"type":"array","description":"Set of roles and their corresponding divisions associated with this client. Roles and divisions only apply to clients using the client_credential grant","uniqueItems":true,"items":{"$ref":"#/definitions/RoleDivision"}},"state":{"type":"string","description":"The state of the OAuth client.\nActive: The OAuth client can be used to create access tokens. This is the default state.\nDisabled: Access tokens created by the client are invalid and new ones cannot be created.\nInactive: Access tokens cannot be created with this OAuth client and it will be deleted.","enum":["active","disabled","inactive"],"x-genesys-enum-members":[{"name":"active"},{"name":"disabled"},{"name":"inactive"}]},"dateToDelete":{"type":"string","format":"date-time","description":"The time at which this client will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"HistoricalAdherenceActuals":{"type":"object","properties":{"actualActivityCategory":{"type":"string","description":"Activity in which the user is actually engaged","enum":["OnQueueWork","Break","Meal","Meeting","OffQueueWork","TimeOff","Training","Unavailable","Unscheduled"],"x-genesys-enum-members":[{"name":"OnQueueWork"},{"name":"Break"},{"name":"Meal"},{"name":"Meeting"},{"name":"OffQueueWork"},{"name":"TimeOff"},{"name":"Training"},{"name":"Unavailable"},{"name":"Unscheduled"}]},"startOffsetSeconds":{"type":"integer","format":"int32","description":"Actual start offset in seconds relative to query start time"},"endOffsetSeconds":{"type":"integer","format":"int32","description":"Actual end offset in seconds relative to query start time"}}},"HistoricalAdherenceDayMetrics":{"type":"object","properties":{"dayStartOffsetSecs":{"type":"integer","format":"int32","description":"Start of day offset in seconds relative to query start time"},"adherenceScheduleSecs":{"type":"integer","format":"int32","description":"Duration of schedule in seconds included for adherence percentage calculation"},"conformanceScheduleSecs":{"type":"integer","format":"int32","description":"Total scheduled duration in seconds for OnQueue activities"},"conformanceActualSecs":{"type":"integer","format":"int32","description":"Total actually worked duration in seconds for OnQueue activities"},"exceptionCount":{"type":"integer","format":"int32","description":"Total number of adherence exceptions for this user"},"exceptionDurationSecs":{"type":"integer","format":"int32","description":"Total duration in seconds of adherence exceptions for this user"},"impactSeconds":{"type":"integer","format":"int32","description":"The impact duration in seconds of current adherence state for this user"},"scheduleLengthSecs":{"type":"integer","format":"int32","description":"Total duration in seconds for all scheduled activities"},"actualLengthSecs":{"type":"integer","format":"int32","description":"Total duration in seconds for all actually worked activities"},"adherencePercentage":{"type":"number","format":"double","description":"Total adherence percentage for this user, in the scale of 0 - 100"},"conformancePercentage":{"type":"number","format":"double","description":"Total conformance percentage for this user, in the scale of 0 - 100. Conformance percentage can be greater than 100 when the actual on queue time is greater than the scheduled on queue time for the same period."}}},"HistoricalAdherenceExceptionInfo":{"type":"object","properties":{"startOffsetSeconds":{"type":"integer","format":"int32","description":"Exception start offset in seconds relative to query start time"},"endOffsetSeconds":{"type":"integer","format":"int32","description":"Exception end offset in seconds relative to query start time"},"scheduledActivityCodeId":{"type":"string","description":"The ID of the scheduled activity for this user"},"scheduledActivityCategory":{"type":"string","description":"Activity for which the user is scheduled","enum":["OnQueueWork","Break","Meal","Meeting","OffQueueWork","TimeOff","Training","Unavailable","Unscheduled"],"x-genesys-enum-members":[{"name":"OnQueueWork"},{"name":"Break"},{"name":"Meal"},{"name":"Meeting"},{"name":"OffQueueWork"},{"name":"TimeOff"},{"name":"Training"},{"name":"Unavailable"},{"name":"Unscheduled"}]},"actualActivityCategory":{"type":"string","description":"Activity for which the user is actually engaged","enum":["OnQueueWork","Break","Meal","Meeting","OffQueueWork","TimeOff","Training","Unavailable","Unscheduled"],"x-genesys-enum-members":[{"name":"OnQueueWork"},{"name":"Break"},{"name":"Meal"},{"name":"Meeting"},{"name":"OffQueueWork"},{"name":"TimeOff"},{"name":"Training"},{"name":"Unavailable"},{"name":"Unscheduled"}]},"systemPresence":{"type":"string","description":"Actual underlying system presence value","enum":["Available","Away","Busy","Offline","Idle","OnQueue","Meal","Training","Meeting","Break"],"x-genesys-enum-members":[{"name":"Available"},{"name":"Away"},{"name":"Busy"},{"name":"Offline"},{"name":"Idle"},{"name":"OnQueue"},{"name":"Meal"},{"name":"Training"},{"name":"Meeting"},{"name":"Break"}]},"routingStatus":{"description":"Actual underlying routing status, used to determine whether a user is actually in adherence when OnQueue","$ref":"#/definitions/RoutingStatus"},"impact":{"type":"string","description":"The impact of the current adherence state for this user","enum":["Positive","Negative","Neutral","Unknown"],"x-genesys-enum-members":[{"name":"Positive"},{"name":"Negative"},{"name":"Neutral"},{"name":"Unknown"}]},"secondaryPresenceLookupId":{"type":"string","description":"The lookup ID used to retrieve secondary status from map of lookup ID to corresponding secondary presence ID"}}},"HistoricalAdherenceQueryResult":{"type":"object","properties":{"userId":{"type":"string","description":"The ID of the user for whom the adherence is queried"},"startDate":{"type":"string","format":"date-time","description":"Beginning of the date range that was queried, in ISO-8601 format"},"endDate":{"type":"string","format":"date-time","description":"End of the date range that was queried, in ISO-8601 format. If it was not set, end date will be set to the queried time"},"adherencePercentage":{"type":"number","format":"double","description":"Adherence percentage for this user, in the scale of 0 - 100"},"conformancePercentage":{"type":"number","format":"double","description":"Conformance percentage for this user, in the scale of 0 - 100. Conformance percentage can be greater than 100 when the actual on queue time is greater than the scheduled on queue time for the same period."},"impact":{"type":"string","description":"The impact of the current adherence state for this user","enum":["Positive","Negative","Neutral","Unknown"],"x-genesys-enum-members":[{"name":"Positive"},{"name":"Negative"},{"name":"Neutral"},{"name":"Unknown"}]},"exceptionInfo":{"type":"array","description":"List of adherence exceptions for this user","items":{"$ref":"#/definitions/HistoricalAdherenceExceptionInfo"}},"dayMetrics":{"type":"array","description":"Adherence and conformance metrics for days in query range","items":{"$ref":"#/definitions/HistoricalAdherenceDayMetrics"}},"actuals":{"type":"array","description":"List of actual activity with offset for this user","items":{"$ref":"#/definitions/HistoricalAdherenceActuals"}}}},"WfmHistoricalAdherenceResponse":{"type":"object","properties":{"id":{"type":"string","description":"The query ID to listen for"},"downloadUrl":{"type":"string","description":"Deprecated. Use downloadUrls instead."},"downloadResult":{"description":"Result will always come via downloadUrls; however the schema is included for documentation","$ref":"#/definitions/WfmHistoricalAdherenceResultWrapper"},"downloadUrls":{"type":"array","description":"The uri list to GET the results of the Historical Adherence query. For notification purposes only","items":{"type":"string"}},"queryState":{"type":"string","description":"The state of the adherence query","enum":["Processing","Complete","Error"],"x-genesys-enum-members":[{"name":"Processing"},{"name":"Complete"},{"name":"Error"}]}},"description":"Response for Historical Adherence Query, intended to tell the client what to listen for on a notification topic"},"WfmHistoricalAdherenceResultWrapper":{"type":"object","properties":{"entityId":{"type":"string","description":"The operation ID of the historical adherence query"},"data":{"type":"array","description":"The list of historical adherence query results","items":{"$ref":"#/definitions/HistoricalAdherenceQueryResult"}},"lookupIdToSecondaryPresenceId":{"type":"object","description":"Map of secondary presence lookup ID to corresponding secondary presence ID","additionalProperties":{"type":"string"}}}},"WfmHistoricalAdherenceQueryForUsers":{"type":"object","required":["startDate","userIds"],"properties":{"startDate":{"type":"string","format":"date-time","description":"Beginning of the date range to query in ISO-8601 format"},"endDate":{"type":"string","format":"date-time","description":"End of the date range to query in ISO-8601 format. If it is not set, end date will be set to current time"},"timeZone":{"type":"string","description":"The time zone to use for returned results in olson format. If it is not set, the business unit time zone will be used to compute adherence"},"userIds":{"type":"array","description":"The userIds to report on","uniqueItems":true,"items":{"type":"string"}},"includeExceptions":{"type":"boolean","description":"Whether user exceptions should be returned as part of the results"}}},"ConversationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Conversation"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"MessageConversationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/EmailConversation"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"MessageData":{"type":"object","required":["status","textBody","timestamp"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"providerMessageId":{"type":"string","description":"The unique identifier of the message from provider"},"timestamp":{"type":"string","format":"date-time","description":"The time when the message was received or sent. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"fromAddress":{"type":"string","description":"The sender of the text message."},"toAddress":{"type":"string","description":"The recipient of the text message."},"direction":{"type":"string","description":"The direction of the message.","enum":["inbound","outbound"],"x-genesys-enum-members":[{"name":"inbound"},{"name":"outbound"}]},"messengerType":{"type":"string","description":"Type of text messenger.","enum":["sms","facebook","twitter","line","whatsapp","webmessaging"],"x-genesys-enum-members":[{"name":"sms"},{"name":"facebook"},{"name":"twitter"},{"name":"line"},{"name":"whatsapp"},{"name":"webmessaging"}]},"textBody":{"type":"string","description":"The body of the text message."},"status":{"type":"string","description":"The status of the message.","enum":["queued","sent","failed","received","delivery-success","delivery-failed","read"],"x-genesys-enum-members":[{"name":"queued"},{"name":"sent"},{"name":"failed"},{"name":"received"},{"name":"delivery-success"},{"name":"delivery-failed"},{"name":"read"}]},"media":{"type":"array","description":"The media details associated to a message.","items":{"$ref":"#/definitions/MessageMedia"}},"stickers":{"type":"array","description":"The sticker details associated to a message.","items":{"$ref":"#/definitions/MessageSticker"}},"createdBy":{"description":"User who sent this message.","$ref":"#/definitions/User"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AdditionalMessage":{"type":"object","required":["textBody"],"properties":{"textBody":{"type":"string","description":"The body of the text message."},"mediaIds":{"type":"array","description":"The media ids associated with the text message.","items":{"type":"string"}},"stickerIds":{"type":"array","description":"The sticker ids associated with the text message.","items":{"type":"string"}},"messagingTemplate":{"description":"The messaging template use to send a predefined canned response with the message","$ref":"#/definitions/MessagingTemplateRequest"}}},"MessagingTemplateRequest":{"type":"object","properties":{"responseId":{"type":"string","description":"A Response Management response identifier for a messaging template defined response"},"parameters":{"type":"array","description":"A list of Response Management response substitutions for the response's messaging template","items":{"$ref":"#/definitions/TemplateParameter"}}}},"TemplateParameter":{"type":"object","properties":{"id":{"type":"string","description":"Response substitution identifier"},"value":{"type":"string","description":"Response substitution value"}}},"TextMessageListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/MessageData"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"MessageConversation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"participants":{"type":"array","description":"The list of participants involved in the conversation.","items":{"$ref":"#/definitions/MessageMediaParticipant"}},"otherMediaUris":{"type":"array","description":"The list of other media channels involved in the conversation.","items":{"type":"string","format":"uri"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"MessageMediaParticipant":{"type":"object","properties":{"id":{"type":"string","description":"The unique participant ID."},"name":{"type":"string","description":"The display friendly name of the participant."},"address":{"type":"string","description":"The participant address."},"startTime":{"type":"string","format":"date-time","description":"The time when this participant first joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The time when this participant went connected for this media (eg: video connected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startHoldTime":{"type":"string","format":"date-time","description":"The time when this participant's hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"purpose":{"type":"string","description":"The participant's purpose. Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr"},"state":{"type":"string","description":"The participant's state. Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","converting","uploading","transmitting","none"],"x-genesys-enum-members":[{"name":"alerting"},{"name":"dialing"},{"name":"contacting"},{"name":"offering"},{"name":"connected"},{"name":"disconnected"},{"name":"terminated"},{"name":"converting"},{"name":"uploading"},{"name":"transmitting"},{"name":"none"}]},"direction":{"type":"string","description":"The participant's direction. Values can be: 'inbound' or 'outbound'","enum":["inbound","outbound"],"x-genesys-enum-members":[{"name":"inbound"},{"name":"outbound"}]},"disconnectType":{"type":"string","description":"The reason the participant was disconnected from the conversation.","enum":["endpoint","client","system","transfer","transfer.conference","transfer.consult","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam"],"x-genesys-enum-members":[{"name":"endpoint"},{"name":"client"},{"name":"system"},{"name":"transfer"},{"name":"transfer.conference"},{"name":"transfer.consult"},{"name":"transfer.forward"},{"name":"transfer.noanswer"},{"name":"transfer.notavailable"},{"name":"transport.failure"},{"name":"error"},{"name":"peer"},{"name":"other"},{"name":"spam"}]},"held":{"type":"boolean","description":"Value is true when the participant is on hold."},"wrapupRequired":{"type":"boolean","description":"Value is true when the participant requires wrap-up."},"wrapupPrompt":{"type":"string","description":"The wrap-up prompt indicating the type of wrap-up to be performed."},"user":{"description":"The PureCloud user for this participant.","$ref":"#/definitions/DomainEntityRef"},"queue":{"description":"The PureCloud queue for this participant.","$ref":"#/definitions/DomainEntityRef"},"team":{"description":"The PureCloud team for this participant.","$ref":"#/definitions/DomainEntityRef"},"attributes":{"type":"object","description":"A list of ad-hoc attributes for the participant.","additionalProperties":{"type":"string"}},"errorInfo":{"description":"If the conversation ends in error, contains additional error details.","$ref":"#/definitions/ErrorInfo"},"script":{"description":"The Engage script that should be used by this participant.","$ref":"#/definitions/DomainEntityRef"},"wrapupTimeoutMs":{"type":"integer","format":"int32","description":"The amount of time the participant has to complete wrap-up."},"wrapupSkipped":{"type":"boolean","description":"Value is true when the participant has skipped wrap-up."},"alertingTimeoutMs":{"type":"integer","format":"int32","description":"Specifies how long the agent has to answer an interaction before being marked as not responding."},"provider":{"type":"string","description":"The source provider for the communication."},"externalContact":{"description":"If this participant represents an external contact, then this will be the reference for the external contact.","$ref":"#/definitions/DomainEntityRef"},"externalOrganization":{"description":"If this participant represents an external org, then this will be the reference for the external org.","$ref":"#/definitions/DomainEntityRef"},"wrapup":{"description":"Wrapup for this participant, if it has been applied.","$ref":"#/definitions/Wrapup"},"peer":{"type":"string","description":"The peer communication corresponding to a matching leg for this communication."},"flaggedReason":{"type":"string","description":"The reason specifying why participant flagged the conversation.","enum":["general"],"x-genesys-enum-members":[{"name":"general"}]},"journeyContext":{"description":"Journey System data/context that is applicable to this communication. When used for historical purposes, the context should be immutable. When null, there is no applicable Journey System context.","$ref":"#/definitions/JourneyContext"},"conversationRoutingData":{"description":"Information on how a communication should be routed to an agent.","$ref":"#/definitions/ConversationRoutingData"},"startAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"toAddress":{"description":"Address for the participant on receiving side of the message conversation. If the address is a phone number, E.164 format is recommended.","$ref":"#/definitions/Address"},"fromAddress":{"description":"Address for the participant on the sending side of the message conversation. If the address is a phone number, E.164 format is recommended.","$ref":"#/definitions/Address"},"messages":{"type":"array","description":"Message instance details on the communication.","items":{"$ref":"#/definitions/MessageDetails"}},"type":{"type":"string","description":"Indicates the type of message platform from which the message originated.","enum":["unknown","sms","twitter","facebook","line","whatsapp","telegram","kakao","webmessaging"],"x-genesys-enum-members":[{"name":"unknown"},{"name":"sms"},{"name":"twitter"},{"name":"facebook"},{"name":"line"},{"name":"whatsapp"},{"name":"telegram"},{"name":"kakao"},{"name":"webmessaging"}]},"recipientCountry":{"type":"string","description":"Indicates the country where the recipient is associated in ISO 3166-1 alpha-2 format."},"recipientType":{"type":"string","description":"The type of the recipient. Eg: Provisioned phoneNumber is the recipient for sms message type."}}},"MessageMediaData":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"url":{"type":"string","description":"The location of the media, useful for retrieving it"},"mediaType":{"type":"string","description":"The detected internet media type of the the media object. If null then the media type should be dictated by the url."},"contentLengthBytes":{"type":"integer","format":"int32","description":"The optional content length of the the media object, in bytes."},"uploadUrl":{"type":"string","description":"The URL returned to upload an attachment"},"status":{"type":"string","description":"The status of the media, indicates if the media is in the process of uploading. If the upload fails, the media becomes invalid","readOnly":true,"enum":["uploading","valid","invalid"],"x-genesys-enum-members":[{"name":"uploading"},{"name":"valid"},{"name":"invalid"}]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CreateOutboundMessagingConversationRequest":{"type":"object","required":["queueId","toAddress","toAddressMessengerType"],"properties":{"queueId":{"type":"string","description":"The ID of the queue to be associated with the message. This will determine the fromAddress of the message."},"toAddress":{"type":"string","description":"The messaging address of the recipient of the message. For an SMS messenger type, the phone number address must be in E.164 format. E.g. +13175555555 or +34234234234"},"toAddressMessengerType":{"type":"string","description":"The messaging address messenger type.","enum":["sms","facebook","twitter","line","whatsapp","webmessaging"],"x-genesys-enum-members":[{"name":"sms"},{"name":"facebook"},{"name":"twitter"},{"name":"line"},{"name":"whatsapp"},{"name":"webmessaging"}]},"useExistingConversation":{"type":"boolean","description":"An override to use an existing conversation. \nIf set to true, an existing conversation will be used if there is one within the conversation window. \nIf set to false, create request fails if there is a conversation within the conversation window."},"externalContactId":{"type":"string","description":"The external contact Id of the recipient of the message."},"externalOrganizationId":{"type":"string","description":"The external organization Id of the recipient of the message."}}},"SendAgentlessOutboundMessageResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"conversationId":{"type":"string","description":"The identifier of the conversation."},"fromAddress":{"type":"string","description":"The sender of the text message."},"toAddress":{"type":"string","description":"The recipient of the text message."},"messengerType":{"type":"string","description":"Type of text messenger.","enum":["sms","facebook","twitter","line","whatsapp","webmessaging"],"x-genesys-enum-members":[{"name":"sms"},{"name":"facebook"},{"name":"twitter"},{"name":"line"},{"name":"whatsapp"},{"name":"webmessaging"}]},"textBody":{"type":"string","description":"The body of the text message."},"timestamp":{"type":"string","format":"date-time","description":"The time when the message was sent. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"user":{"description":"Details of the user created the job","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"}}},"SendAgentlessOutboundMessageRequest":{"type":"object","required":["fromAddress","textBody","toAddress","toAddressMessengerType"],"properties":{"fromAddress":{"type":"string","description":"The messaging address of the sender of the message. For an SMS messenger type, this must be a currently provisioned sms phone number."},"toAddress":{"type":"string","description":"The messaging address of the recipient of the message. For an SMS messenger type, the phone number address must be in E.164 format. E.g. +13175555555 or +34234234234."},"toAddressMessengerType":{"type":"string","description":"The recipient messaging address messenger type. Currently SMS is the only supported type.","enum":["sms","facebook","twitter","line","whatsapp","webmessaging"],"x-genesys-enum-members":[{"name":"sms"},{"name":"facebook"},{"name":"twitter"},{"name":"line"},{"name":"whatsapp"},{"name":"webmessaging"}]},"textBody":{"type":"string","description":"The text of the message to send"}}},"MessagingTemplate":{"type":"object","properties":{"whatsApp":{"description":"Defines a messaging template for a WhatsApp messaging channel","$ref":"#/definitions/WhatsAppDefinition"}},"description":"The messaging template identifies a structured message templates supported by a messaging channel."},"Response":{"type":"object","required":["libraries","texts"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"version":{"type":"integer","format":"int32","description":"Version number required for updates."},"libraries":{"type":"array","description":"One or more libraries response is associated with.","items":{"$ref":"#/definitions/DomainEntityRef"}},"texts":{"type":"array","description":"One or more texts associated with the response.","items":{"$ref":"#/definitions/ResponseText"}},"createdBy":{"description":"User that created the response","readOnly":true,"$ref":"#/definitions/User"},"dateCreated":{"type":"string","format":"date-time","description":"The date and time the response was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"interactionType":{"type":"string","description":"The interaction type for this response.","enum":["chat","email","twitter"]},"substitutions":{"type":"array","description":"Details about any text substitutions used in the texts for this response.","items":{"$ref":"#/definitions/ResponseSubstitution"}},"substitutionsSchema":{"description":"Metadata about the text substitutions in json schema format.","$ref":"#/definitions/JsonSchemaDocument"},"responseType":{"type":"string","description":"The response type represented by the response.","enum":["MessagingTemplate","CampaignSmsTemplate"],"x-genesys-enum-members":[{"name":"MessagingTemplate","description":"Use MessagingTemplate to provide channel specific template. WhatsApp messaging template is supported currently"},{"name":"CampaignSmsTemplate","description":"Use CampaignSmsTemplate to create canned responses specific to sms campaigns. Only text/plain content type is allowed"}]},"messagingTemplate":{"description":"An optional messaging template definition for responseType.MessagingTemplate.","$ref":"#/definitions/MessagingTemplate"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Contains information about a response."},"ResponseSubstitution":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Response substitution identifier."},"description":{"type":"string","description":"Response substitution description."},"defaultValue":{"type":"string","description":"Response substitution default value."}},"description":"Contains information about the substitutions associated with a response."},"ResponseText":{"type":"object","required":["content"],"properties":{"content":{"type":"string","description":"Response text content."},"contentType":{"type":"string","description":"Response text content type.","enum":["text/plain","text/html"]}},"description":"Contains information about the text associated with a response."},"WhatsAppDefinition":{"type":"object","required":["language","name","namespace"],"properties":{"name":{"type":"string","description":"The messaging template name."},"namespace":{"type":"string","description":"The messaging template namespace."},"language":{"type":"string","description":"The messaging template language configured for this template. This is a WhatsApp specific value. For example, 'en_US'"}},"description":"A WhatsApp messaging template definition as defined in the WhatsApp Business Manager"},"ResponseEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Response"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DncList":{"type":"object","required":["dncSourceType","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the DncList."},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"importStatus":{"description":"The status of the import process","readOnly":true,"$ref":"#/definitions/ImportStatus"},"size":{"type":"integer","format":"int64","description":"The total number of phone numbers in the DncList.","readOnly":true},"dncSourceType":{"type":"string","description":"The type of the DncList.","readOnly":true,"enum":["rds","dnc.com","gryphon"],"x-genesys-enum-members":[{"name":"rds"},{"name":"dnc.com"},{"name":"gryphon"}]},"loginId":{"type":"string","description":"A dnc.com loginId. Required if the dncSourceType is dnc.com."},"dncCodes":{"type":"array","description":"The list of dnc.com codes to be treated as DNC. Required if the dncSourceType is dnc.com.","uniqueItems":true,"items":{"type":"string"}},"licenseId":{"type":"string","description":"A gryphon license number. Required if the dncSourceType is gryphon."},"division":{"description":"The division this DncList belongs to.","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DncListEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DncList"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DncListCreate":{"type":"object","required":["dncSourceType","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the DncList."},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"importStatus":{"description":"The status of the import process","readOnly":true,"$ref":"#/definitions/ImportStatus"},"size":{"type":"integer","format":"int64","description":"The total number of phone numbers in the DncList.","readOnly":true},"dncSourceType":{"type":"string","description":"The type of the DncList.","enum":["rds","dnc.com","gryphon"],"x-genesys-enum-members":[{"name":"rds"},{"name":"dnc.com"},{"name":"gryphon"}]},"loginId":{"type":"string","description":"A dnc.com loginId. Required if the dncSourceType is dnc.com."},"dncCodes":{"type":"array","description":"The list of dnc.com codes to be treated as DNC. Required if the dncSourceType is dnc.com.","uniqueItems":true,"items":{"type":"string"}},"licenseId":{"type":"string","description":"A gryphon license number. Required if the dncSourceType is gryphon."},"division":{"description":"The division this DncList belongs to.","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ExternalSegment":{"type":"object","required":["id","name","source"],"properties":{"id":{"type":"string","description":"Identifier for the external segment in the system where it originates from."},"name":{"type":"string","description":"Name for the external segment in the system where it originates from."},"source":{"type":"string","description":"The external system where the segment originates from.","enum":["AdobeExperiencePlatform","Custom"],"x-genesys-enum-members":[{"name":"AdobeExperiencePlatform"},{"name":"Custom"}]}}},"JourneySegment":{"type":"object","required":["displayName"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"isActive":{"type":"boolean","description":"Whether or not the segment is active."},"displayName":{"type":"string","description":"The display name of the segment."},"version":{"type":"integer","format":"int32","description":"The version of the segment."},"description":{"type":"string","description":"A description of the segment."},"color":{"type":"string","description":"The hexadecimal color value of the segment."},"scope":{"type":"string","description":"The target entity that a segment applies to.","enum":["Session","Customer"],"x-genesys-enum-members":[{"name":"Session"},{"name":"Customer"}]},"shouldDisplayToAgent":{"type":"boolean","description":"Whether or not the segment should be displayed to agent/supervisor users."},"context":{"description":"The context of the segment.","$ref":"#/definitions/Context"},"journey":{"description":"The pattern of rules defining the segment.","$ref":"#/definitions/Journey"},"externalSegment":{"description":"Details of an entity corresponding to this segment in an external system.","$ref":"#/definitions/ExternalSegment"},"assignmentExpirationDays":{"type":"integer","format":"int32","description":"Time, in days, from when the segment is assigned until it is automatically unassigned."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"createdDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the segment was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the the segment was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"PatchExternalSegment":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name for the external segment in the system where it originates from."}}},"PatchSegment":{"type":"object","required":["displayName"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"isActive":{"type":"boolean","description":"Whether or not the segment is active."},"displayName":{"type":"string","description":"The display name of the segment."},"version":{"type":"integer","format":"int32","description":"The version of the segment."},"description":{"type":"string","description":"A description of the segment."},"color":{"type":"string","description":"The hexadecimal color value of the segment."},"shouldDisplayToAgent":{"type":"boolean","description":"Whether or not the segment should be displayed to agent/supervisor users."},"context":{"description":"The context of the segment.","$ref":"#/definitions/Context"},"journey":{"description":"The pattern of rules defining the segment.","$ref":"#/definitions/Journey"},"externalSegment":{"description":"Details of an entity corresponding to this segment in an external system.","$ref":"#/definitions/PatchExternalSegment"},"assignmentExpirationDays":{"type":"integer","format":"int32","description":"Time, in days, from when the segment is assigned until it is automatically unassigned."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"createdDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the segment was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the the segment was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"ConversationAssociation":{"type":"object","required":["communicationId","conversationId","mediaType"],"properties":{"externalContactId":{"type":"string","description":"An external contact ID. If not supplied, implies the conversation should be disassociated with any external contact."},"conversationId":{"type":"string","description":"Conversation ID"},"communicationId":{"type":"string","description":"Communication ID"},"mediaType":{"type":"string","description":"Media type","enum":["CALL","CALLBACK","CHAT","COBROWSE","EMAIL","MESSAGE","SOCIAL_EXPRESSION","VIDEO","SCREENSHARE"],"x-genesys-enum-members":[{"name":"CALL"},{"name":"CALLBACK"},{"name":"CHAT"},{"name":"COBROWSE"},{"name":"EMAIL"},{"name":"MESSAGE"},{"name":"SOCIAL_EXPRESSION"},{"name":"VIDEO"},{"name":"SCREENSHARE"}]}}},"PureCloud":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"disabled":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EdgeNetworkDiagnosticResponse":{"type":"object","properties":{"commandCorrelationId":{"type":"string","description":"UUID of each executed command on edge"},"diagnostics":{"type":"string","description":"Response string of executed command from edge"}}},"EdgeNetworkDiagnostic":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EdgeNetworkDiagnosticRequest":{"type":"object","required":["host"],"properties":{"host":{"type":"string","description":"IPv4/6 address or host to be probed for connectivity. No port allowed."}}},"SmsAddressProvision":{"type":"object","required":["city","countryCode","name","postalCode","region","street"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Name associated with this address"},"street":{"type":"string","description":"The number and street address where this address is located."},"city":{"type":"string","description":"The city in which this address is in"},"region":{"type":"string","description":"The state or region this address is in"},"postalCode":{"type":"string","description":"The postal code this address is in"},"countryCode":{"type":"string","description":"The ISO country code of this address"},"autoCorrectAddress":{"type":"boolean","description":"This is used when the address is created. If the value is not set or true, then the system will, if necessary, auto-correct the address you provide. Set this value to false if the system should not auto-correct the address."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SmsAddressEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SmsAddress"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ChangePasswordRequest":{"type":"object","required":["newPassword"],"properties":{"newPassword":{"type":"string","description":"The new password"}}},"ScheduleGroup":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"timeZone":{"type":"string","description":"The timezone the schedules are a part of. This is not a schedule property to allow a schedule to be used in multiple timezones."},"openSchedules":{"type":"array","description":"The schedules defining the hours an organization is open.","items":{"$ref":"#/definitions/DomainEntityRef"}},"closedSchedules":{"type":"array","description":"The schedules defining the hours an organization is closed.","items":{"$ref":"#/definitions/DomainEntityRef"}},"holidaySchedules":{"type":"array","description":"The schedules defining the hours an organization is closed for the holidays.","items":{"$ref":"#/definitions/DomainEntityRef"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"A group of schedules that define the operating hours of an organization."},"ScheduleGroupEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ScheduleGroup"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"SmsPhoneNumber":{"type":"object","required":["phoneNumber","version"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"phoneNumber":{"type":"string","description":"A phone number provisioned for SMS communications in E.164 format. E.g. +13175555555 or +34234234234"},"phoneNumberType":{"type":"string","description":"Type of the phone number provisioned.","readOnly":true,"enum":["local","mobile","tollfree","shortcode"],"x-genesys-enum-members":[{"name":"local"},{"name":"mobile"},{"name":"tollfree"},{"name":"shortcode"}]},"provisionedThroughPureCloud":{"type":"boolean","description":"Is set to false, if the phone number is provisioned through a SMS provider, outside of PureCloud"},"phoneNumberStatus":{"type":"string","description":"Status of the provisioned phone number.","enum":["INVALID","ACTIVE","PORTING","PENDING","PENDING_CANCELLATION"],"x-genesys-enum-members":[{"name":"INVALID"},{"name":"ACTIVE"},{"name":"PORTING"},{"name":"PENDING"},{"name":"PENDING_CANCELLATION"}]},"capabilities":{"type":"array","description":"The capabilities of the phone number available for provisioning.","readOnly":true,"items":{"type":"string","enum":["sms","mms","voice"],"x-genesys-enum-members":[{"name":"sms"},{"name":"mms"},{"name":"voice"}]}},"countryCode":{"type":"string","description":"The ISO 3166-1 alpha-2 country code of the country this phone number is associated with."},"dateCreated":{"type":"string","format":"date-time","description":"Date this phone number was provisioned. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date this phone number was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"description":"User that provisioned this phone number","$ref":"#/definitions/User"},"modifiedBy":{"description":"User that last modified this phone number","$ref":"#/definitions/User"},"version":{"type":"integer","format":"int32","description":"Version number required for updates."},"purchaseDate":{"type":"string","format":"date-time","description":"Date this phone number was purchased, if the phoneNumberType is shortcode. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"cancellationDate":{"type":"string","format":"date-time","description":"Contract end date of this phone number, if the phoneNumberType is shortcode. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"renewalDate":{"type":"string","format":"date-time","description":"Contract renewal date of this phone number, if the phoneNumberType is shortcode. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"autoRenewable":{"type":"string","description":"Renewal time period of this phone number, if the phoneNumberType is shortcode.","enum":["Quarterly"],"x-genesys-enum-members":[{"name":"Quarterly"}]},"addressId":{"description":"The id of an address attached to this phone number.","$ref":"#/definitions/SmsAddress"},"shortCodeBillingType":{"type":"string","description":"BillingType of this phone number, if the phoneNumberType is shortcode.","enum":["Basic","Vanity"],"x-genesys-enum-members":[{"name":"Basic"},{"name":"Vanity"}]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SmsPhoneNumberEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SmsPhoneNumber"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"SmsPhoneNumberProvision":{"type":"object","required":["countryCode","phoneNumber","phoneNumberType"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"phoneNumber":{"type":"string","description":"A phone number to be used for SMS communications. E.g. +13175555555 or +34234234234"},"phoneNumberType":{"type":"string","description":"Type of the phone number provisioned.","enum":["local","mobile","tollfree","shortcode"],"x-genesys-enum-members":[{"name":"local"},{"name":"mobile"},{"name":"tollfree"},{"name":"shortcode"}]},"countryCode":{"type":"string","description":"The ISO 3166-1 alpha-2 country code of the country this phone number is associated with."},"addressId":{"type":"string","description":"The id of an address added on your account. Due to regulatory requirements in some countries, an address may be required when provisioning a sms number. In those cases you should provide the provisioned sms address id here"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WebChatTyping":{"type":"object","required":["conversation","id","sender","timestamp"],"properties":{"id":{"type":"string","description":"The event identifier of this typing indicator event (useful to guard against event re-delivery"},"conversation":{"description":"The identifier of the conversation","$ref":"#/definitions/WebChatConversation"},"sender":{"description":"The member who sent the message","$ref":"#/definitions/WebChatMemberInfo"},"timestamp":{"type":"string","format":"date-time","description":"The timestamp of the message, in ISO-8601 format"}}},"CreateWebChatMessageRequest":{"type":"object","required":["body"],"properties":{"body":{"type":"string","description":"The message body. Note that message bodies are limited to 4,000 characters."},"bodyType":{"type":"string","description":"The purpose of the message within the conversation, such as a standard text entry versus a greeting.","enum":["standard","notice","member-join","member-leave","media-request"],"x-genesys-enum-members":[{"name":"standard"},{"name":"notice"},{"name":"member-join"},{"name":"member-leave"},{"name":"media-request"}]}}},"GroupUpdate":{"type":"object","required":["version"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The group name."},"description":{"type":"string"},"state":{"type":"string","description":"State of the group.","enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"version":{"type":"integer","format":"int32","description":"Current version for this resource."},"images":{"type":"array","items":{"$ref":"#/definitions/UserImage"}},"addresses":{"type":"array","items":{"$ref":"#/definitions/GroupContact"}},"rulesVisible":{"type":"boolean","description":"Are membership rules visible to the person requesting to view the group"},"visibility":{"type":"string","description":"Who can view this group","enum":["public","ownerIds","members"]},"ownerIds":{"type":"array","description":"Owners of the group","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AvailableTopic":{"type":"object","properties":{"description":{"type":"string"},"id":{"type":"string"},"permissionDetails":{"type":"array","description":"Full detailed permissions required to subscribe to the topic","items":{"$ref":"#/definitions/PermissionDetails"}},"requiresPermissions":{"type":"array","description":"Permissions required to subscribe to the topic","items":{"type":"string"}},"requiresDivisionPermissions":{"type":"boolean","description":"True if the subscribing user must belong to the same division as the topic object ID"},"enforced":{"type":"boolean","description":"Whether or not the permissions on this topic are enforced"},"visibility":{"type":"string","description":"Visibility of this topic (Public or Preview)","enum":["Public","Preview"],"x-genesys-enum-members":[{"name":"Public"},{"name":"Preview"}]},"schema":{"type":"object","additionalProperties":{"type":"object"}},"requiresCurrentUser":{"type":"boolean","description":"True if the topic user ID is required to match the subscribing user ID"},"requiresCurrentUserOrPermission":{"type":"boolean","description":"True if permissions are only required when the topic user ID does not match the subscribing user ID"},"transports":{"type":"array","description":"Transports that support events for the topic","items":{"type":"string","enum":["All","Websocket","EventBridge"],"x-genesys-enum-members":[{"name":"All"},{"name":"Websocket"},{"name":"EventBridge"}]}},"publicApiTemplateUriPaths":{"type":"array","items":{"type":"string"}}}},"AvailableTopicEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AvailableTopic"}}}},"PermissionDetails":{"type":"object","properties":{"type":{"type":"string","description":"The type of permission requirement","enum":["requiresCurrentUser","requiresPermissions","requiresDivisionPermissions","requiresAnyDivisionPermissions"],"x-genesys-enum-members":[{"name":"requiresCurrentUser"},{"name":"requiresPermissions"},{"name":"requiresDivisionPermissions"},{"name":"requiresAnyDivisionPermissions"}]},"permissions":{"type":"array","description":"List of required permissions","items":{"type":"string"}},"allowsCurrentUser":{"type":"boolean","description":"Whether the current user can subscribe, when division permissions are otherwise required"},"enforced":{"type":"boolean","description":"Whether or not this permission requirement is enforced"}}},"ManagementUnitSettingsRequest":{"type":"object","required":["metadata"],"properties":{"adherence":{"description":"Adherence settings for this management unit","$ref":"#/definitions/AdherenceSettings"},"shortTermForecasting":{"description":"Short term forecasting settings for this management unit. Moving to Business Unit","$ref":"#/definitions/ShortTermForecastingSettings"},"timeOff":{"description":"Time off request settings for this management unit","$ref":"#/definitions/TimeOffRequestSettings"},"scheduling":{"description":"Scheduling settings for this management unit","$ref":"#/definitions/SchedulingSettingsRequest"},"shiftTrading":{"description":"Shift trade settings for this management unit","$ref":"#/definitions/ShiftTradeSettings"},"metadata":{"description":"Version info metadata for the associated management unit","$ref":"#/definitions/WfmVersionedEntityMetadata"}},"description":"Management Unit Settings"},"UpdateManagementUnitRequest":{"type":"object","properties":{"name":{"type":"string","description":"The new name of the management unit"},"divisionId":{"type":"string","description":"The new division id for the management unit"},"settings":{"description":"Updated settings for the management unit","$ref":"#/definitions/ManagementUnitSettingsRequest"}}},"MoveManagementUnitResponse":{"type":"object","properties":{"businessUnit":{"description":"The new business unit","$ref":"#/definitions/BusinessUnitReference"},"status":{"type":"string","description":"The status of the move. Will always be 'Processing' unless the Management Unit is already in the requested Business Unit in which case it will be 'Complete'","enum":["Processing","Complete","Canceled","Error"],"x-genesys-enum-members":[{"name":"Processing"},{"name":"Complete"},{"name":"Canceled"},{"name":"Error"}]}}},"MoveManagementUnitRequest":{"type":"object","required":["businessUnitId"],"properties":{"businessUnitId":{"type":"string","description":"The ID of the business unit to which to move the management unit"}}},"SkillEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/RoutingSkill"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"TrustorEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Trustor"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Keyword":{"type":"object","required":["agentScoreModifier","confidence","customerScoreModifier","phrase"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"phrase":{"type":"string","description":"The word or phrase which is being looked for with speech recognition."},"confidence":{"type":"integer","format":"int32","description":"A sensitivity threshold that can be increased to lower false positives or decreased to reduce false negatives."},"agentScoreModifier":{"type":"integer","format":"int32","description":"A modifier to the evaluation score when the phrase is spotted in the agent channel"},"customerScoreModifier":{"type":"integer","format":"int32","description":"A modifier to the evaluation score when the phrase is spotted in the customer channel"},"alternateSpellings":{"type":"array","description":"Other spellings of the phrase that can be added to reduce missed spots (false negatives).","items":{"type":"string"}},"pronunciations":{"type":"array","description":"The phonetic spellings for the phrase and alternate spellings.","items":{"type":"string"}},"antiWords":{"type":"array","description":"Words that are similar to the phrase but not desired. Added to reduce incorrect spots (false positives).","items":{"type":"string"}},"antiPronunciations":{"type":"array","description":"The phonetic spellings for the antiWords.","items":{"type":"string"}},"spotabilityIndex":{"type":"number","format":"double","description":"A prediction of how easy it is to unambiguously spot the keyword within its language based on spelling."},"marginOfError":{"type":"number","format":"double"},"pronunciation":{"type":"string"}}},"KeywordSet":{"type":"object","required":["keywords","language","participantPurposes"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"queues":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/Queue"}},"language":{"type":"string","description":"Language code, such as 'en-US'"},"agents":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/User"}},"keywords":{"type":"array","description":"The list of keywords to be used for keyword spotting.","items":{"$ref":"#/definitions/Keyword"}},"participantPurposes":{"type":"array","description":"The types of participants to use keyword spotting on.","uniqueItems":true,"items":{"type":"string","enum":["AGENT","CUSTOMER"],"x-genesys-enum-members":[{"name":"AGENT"},{"name":"CUSTOMER"}]}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EventLog":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"errorEntity":{"$ref":"#/definitions/DomainEntityRef"},"relatedEntity":{"$ref":"#/definitions/DomainEntityRef"},"timestamp":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"level":{"type":"string","enum":["INFO","WARNING","ERROR"],"x-genesys-enum-members":[{"name":"INFO"},{"name":"WARNING"},{"name":"ERROR"}]},"category":{"type":"string","enum":["CALLBACK","CALL_RESTRICTION","CALL_RULE","CAMPAIGN","CAMPAIGN_RULE","CONTACT","CONTACT_LIST_FILTER","DNC_LIST","ENTITY_LIMIT","IMPORT_ERROR","MESSAGING_CAMPAIGN","ORGANIZATION_CONFIGURATION","SCHEDULE"],"x-genesys-enum-members":[{"name":"CALLBACK"},{"name":"CALL_RESTRICTION"},{"name":"CALL_RULE"},{"name":"CAMPAIGN"},{"name":"CAMPAIGN_RULE"},{"name":"CONTACT"},{"name":"CONTACT_LIST_FILTER"},{"name":"DNC_LIST"},{"name":"ENTITY_LIMIT"},{"name":"IMPORT_ERROR"},{"name":"MESSAGING_CAMPAIGN"},{"name":"ORGANIZATION_CONFIGURATION"},{"name":"SCHEDULE"}]},"correlationId":{"type":"string"},"eventMessage":{"$ref":"#/definitions/EventMessage"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EventMessage":{"type":"object","properties":{"code":{"type":"string","enum":["APPROACHING_CONTACT_LIMIT","APPROACHING_DNC_LIST_PHONE_NUMBER_LIMIT","APPROACHING_DNC_ORGANIZATION_PHONE_NUMBER_LIMIT","APPROACHING_ENTITY_LIMIT","AUTOMATIC_TIME_ZONE_ZIP_CODE_INVALID","CAMPAIGN_CONTENT_TEMPLATE_SUBSTITUTION_MISMATCH","CAMPAIGN_MESSAGE_CHARACTER_LIMIT_EXCEEDED","CAMPAIGN_START_ERROR","CAMPAIGN_RULE_START_ERROR","CAMPAIGN_SET_DIALING_MODE_ERROR","CAMPAIGN_STOPPED","CAMPAIGN_THROTTLED","CAMPAIGN_QUEUE_MEMBERS_LIMIT_EXCEEDED","INVALID_CALLABLE_TIME_ZONE","CALLBACK_CREATION_INVALID_NUMBER","CALL_RULE_INVALID_CONTACT_COLUMN","CALL_RULE_MISSING_DATA_ACTION_INPUT","CALL_RULE_MISMATCH_TYPE","CALL_RULE_INVALID_OPERATOR","CALL_RULE_NO_DNC_LISTS_CONFIGURED","CALL_RULE_UPDATED_PHONE_COLUMN","CONTACT_LIST_FILTER_EVALUATION_FAILED","CONTACT_LIST_FILTER_INTERNAL_ERROR","CONTACT_COLUMNS_LIMIT_EXCEEDED","CONTACT_COLUMN_LENGTH_LIMIT_EXCEEDED","CONTACT_DATUM_LENGTH_LIMIT_EXCEEDED","CONTACT_ZIP_CODE_COLUMN_VALUE_INVALID","DATA_ACTION_EXECUTION_FAILED","DATA_ACTION_AUTHENTICATION_FAILURE","DATA_ACTION_NOT_FOUND","DNC_AUTHENTICATION_FAILURE","EXCEEDED_CONTACT_LIMIT","EXCEEDED_DNC_RECORD_LIMIT","INACTIVE_EDGES_FAILED_PLACE_CALLS","INACTIVE_EDGES_TURNED_CAMPAIGN_OFF","INVALID_PHONE_NUMBER","IMPORT_FAILED_TO_READ_HEADERS","IMPORT_COULD_NOT_PARSE_AN_ENTRY","IMPORT_CONTACT_DOES_NOT_MATCH_LIST_FORMAT","IMPORT_ENTRY_DOES_NOT_ALIGN_WITH_HEADERS","IMPORT_INVALID_CUSTOM_ID","IMPORT_INVALID_DATA","IMPORT_COLUMN_EXCEEDS_LENGTH_LIMIT","IMPORT_DATUM_EXCEEDS_LENGTH_LIMIT","IMPORT_MISSING_CUSTOM_ID","IMPORT_NO_COLUMNS_DEFINED","IMPORT_COLUMNS_DO_NOT_EXIST_ON_LIST","IMPORT_LIST_NO_LONGER_EXISTS","IMPORT_FAILED_CONTACT_ZIP_CODE_COLUMN_VALUE_INVALID","IMPORT_TOO_MANY_COLUMNS","IMPORT_TOO_MANY_EXTRA_COLUMNS","ORGANIZATION_HAS_NO_DOMAIN_SET","RECYCLE_CAMPAIGN"],"x-genesys-enum-members":[{"name":"APPROACHING_CONTACT_LIMIT"},{"name":"APPROACHING_DNC_LIST_PHONE_NUMBER_LIMIT"},{"name":"APPROACHING_DNC_ORGANIZATION_PHONE_NUMBER_LIMIT"},{"name":"APPROACHING_ENTITY_LIMIT"},{"name":"AUTOMATIC_TIME_ZONE_ZIP_CODE_INVALID"},{"name":"CAMPAIGN_CONTENT_TEMPLATE_SUBSTITUTION_MISMATCH"},{"name":"CAMPAIGN_MESSAGE_CHARACTER_LIMIT_EXCEEDED"},{"name":"CAMPAIGN_START_ERROR"},{"name":"CAMPAIGN_RULE_START_ERROR"},{"name":"CAMPAIGN_SET_DIALING_MODE_ERROR"},{"name":"CAMPAIGN_STOPPED"},{"name":"CAMPAIGN_THROTTLED"},{"name":"CAMPAIGN_QUEUE_MEMBERS_LIMIT_EXCEEDED"},{"name":"INVALID_CALLABLE_TIME_ZONE"},{"name":"CALLBACK_CREATION_INVALID_NUMBER"},{"name":"CALL_RULE_INVALID_CONTACT_COLUMN"},{"name":"CALL_RULE_MISSING_DATA_ACTION_INPUT"},{"name":"CALL_RULE_MISMATCH_TYPE"},{"name":"CALL_RULE_INVALID_OPERATOR"},{"name":"CALL_RULE_NO_DNC_LISTS_CONFIGURED"},{"name":"CALL_RULE_UPDATED_PHONE_COLUMN"},{"name":"CONTACT_LIST_FILTER_EVALUATION_FAILED"},{"name":"CONTACT_LIST_FILTER_INTERNAL_ERROR"},{"name":"CONTACT_COLUMNS_LIMIT_EXCEEDED"},{"name":"CONTACT_COLUMN_LENGTH_LIMIT_EXCEEDED"},{"name":"CONTACT_DATUM_LENGTH_LIMIT_EXCEEDED"},{"name":"CONTACT_ZIP_CODE_COLUMN_VALUE_INVALID"},{"name":"DATA_ACTION_EXECUTION_FAILED"},{"name":"DATA_ACTION_AUTHENTICATION_FAILURE"},{"name":"DATA_ACTION_NOT_FOUND"},{"name":"DNC_AUTHENTICATION_FAILURE"},{"name":"EXCEEDED_CONTACT_LIMIT"},{"name":"EXCEEDED_DNC_RECORD_LIMIT"},{"name":"INACTIVE_EDGES_FAILED_PLACE_CALLS"},{"name":"INACTIVE_EDGES_TURNED_CAMPAIGN_OFF"},{"name":"INVALID_PHONE_NUMBER"},{"name":"IMPORT_FAILED_TO_READ_HEADERS"},{"name":"IMPORT_COULD_NOT_PARSE_AN_ENTRY"},{"name":"IMPORT_CONTACT_DOES_NOT_MATCH_LIST_FORMAT"},{"name":"IMPORT_ENTRY_DOES_NOT_ALIGN_WITH_HEADERS"},{"name":"IMPORT_INVALID_CUSTOM_ID"},{"name":"IMPORT_INVALID_DATA"},{"name":"IMPORT_COLUMN_EXCEEDS_LENGTH_LIMIT"},{"name":"IMPORT_DATUM_EXCEEDS_LENGTH_LIMIT"},{"name":"IMPORT_MISSING_CUSTOM_ID"},{"name":"IMPORT_NO_COLUMNS_DEFINED"},{"name":"IMPORT_COLUMNS_DO_NOT_EXIST_ON_LIST"},{"name":"IMPORT_LIST_NO_LONGER_EXISTS"},{"name":"IMPORT_FAILED_CONTACT_ZIP_CODE_COLUMN_VALUE_INVALID"},{"name":"IMPORT_TOO_MANY_COLUMNS"},{"name":"IMPORT_TOO_MANY_EXTRA_COLUMNS"},{"name":"ORGANIZATION_HAS_NO_DOMAIN_SET"},{"name":"RECYCLE_CAMPAIGN"}]},"message":{"type":"string"},"messageWithParams":{"type":"string"},"messageParams":{"type":"object","additionalProperties":{"type":"object"}},"documentationUri":{"type":"string"},"resourceURIs":{"type":"array","items":{"type":"string"}}}},"EdgeLogsJobResponse":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The created job id."},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EdgeLogsJobRequest":{"type":"object","properties":{"path":{"type":"string","description":"A relative directory to the root Edge log folder to query from."},"query":{"type":"string","description":"The pattern to use when searching for logs, which may include the wildcards {*, ?}. Multiple search patterns may be combined using a pipe '|' as a delimiter."},"recurse":{"type":"boolean","description":"Boolean whether or not to recurse into directories."}}},"Workspace":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The current name of the workspace."},"type":{"type":"string","enum":["USER","GROUP"],"x-genesys-enum-members":[{"name":"USER"},{"name":"GROUP"}]},"isCurrentUserWorkspace":{"type":"boolean"},"user":{"$ref":"#/definitions/DomainEntityRef"},"bucket":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"summary":{"$ref":"#/definitions/WorkspaceSummary"},"acl":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkspaceSummary":{"type":"object","properties":{"totalDocumentCount":{"type":"integer","format":"int64"},"totalDocumentByteCount":{"type":"integer","format":"int64"}}},"EdgeLogsJob":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"files":{"type":"array","description":"The files available to upload from the Edge to the cloud.","items":{"$ref":"#/definitions/EdgeLogsJobFile"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EdgeLogsJobFile":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"timeCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"timeModified":{"type":"string","format":"date-time","description":"The time this log file was last modified on the Edge. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"sizeBytes":{"type":"number","format":"double","description":"The size of this file in bytes."},"uploadStatus":{"type":"string","description":"The status of the upload of this file from the Edge to the cloud. Use /upload to start an upload.","enum":["UPLOADING","NOT_UPLOADED","UPLOADED","ERROR_ON_UPLOAD"],"x-genesys-enum-members":[{"name":"UPLOADING"},{"name":"NOT_UPLOADED"},{"name":"UPLOADED"},{"name":"ERROR_ON_UPLOAD"}]},"edgePath":{"type":"string","format":"uri","description":"The path of this file on the Edge."},"downloadId":{"type":"string","description":"The download ID to use with the downloads API."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WebChatMessageEntityList":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32"},"entities":{"type":"array","items":{"$ref":"#/definitions/WebChatMessage"}},"previousPage":{"type":"string"},"next":{"type":"string"},"selfUri":{"type":"string","format":"uri"}}},"BillingUsage":{"type":"object","required":["name","resources","totalUsage"],"properties":{"name":{"type":"string","description":"Identifies the billable usage."},"totalUsage":{"type":"string","description":"The total amount of usage, expressed as a decimal number in string format."},"resources":{"type":"array","description":"The resources for which usage was observed (e.g. license users, devices).","items":{"$ref":"#/definitions/BillingUsageResource"}}}},"BillingUsageReport":{"type":"object","required":["endDate","startDate","usages"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"startDate":{"type":"string","format":"date-time","description":"The period start date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endDate":{"type":"string","format":"date-time","description":"The period end date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"status":{"type":"string","description":"Generation status of report","enum":["InProgress","Complete"],"x-genesys-enum-members":[{"name":"InProgress"},{"name":"Complete"}]},"usages":{"type":"array","description":"The usages for the given period.","items":{"$ref":"#/definitions/BillingUsage"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BillingUsageResource":{"type":"object","required":["date","name"],"properties":{"name":{"type":"string","description":"Identifies the resource (e.g. license user, device)."},"date":{"type":"string","format":"date-time","description":"The date that the usage was first observed by the billing subsystem. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"Trunk":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"trunkType":{"type":"string","description":"The type of this trunk.","enum":["EXTERNAL","PHONE","EDGE"],"x-genesys-enum-members":[{"name":"EXTERNAL"},{"name":"PHONE"},{"name":"EDGE"}]},"edge":{"description":"The Edge using this trunk.","$ref":"#/definitions/DomainEntityRef"},"trunkBase":{"description":"The trunk base configuration used on this trunk.","$ref":"#/definitions/DomainEntityRef"},"trunkMetabase":{"description":"The metabase used to create this trunk.","$ref":"#/definitions/DomainEntityRef"},"edgeGroup":{"description":"The edge group associated with this trunk.","$ref":"#/definitions/DomainEntityRef"},"inService":{"type":"boolean","description":"True if this trunk is in-service. This comes from the trunk_enabled property of the referenced trunk base.","readOnly":true},"enabled":{"type":"boolean","description":"True if the Edge used by this trunk is in-service"},"logicalInterface":{"description":"The Logical Interface on the Edge to which the trunk is assigned.","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"connectedStatus":{"description":"The connected status of the trunk","readOnly":true,"$ref":"#/definitions/TrunkConnectedStatus"},"optionsStatus":{"type":"array","description":"The trunk optionsStatus","readOnly":true,"items":{"$ref":"#/definitions/TrunkMetricsOptions"}},"registersStatus":{"type":"array","description":"The trunk registersStatus","readOnly":true,"items":{"$ref":"#/definitions/TrunkMetricsRegisters"}},"ipStatus":{"description":"The trunk ipStatus","readOnly":true,"$ref":"#/definitions/TrunkMetricsNetworkTypeIp"},"optionsEnabledStatus":{"type":"string","description":"Returns Enabled when the trunk base supports the availability interval and it has a value greater than 0.","readOnly":true,"enum":["ENABLED","DISABLED","NOT_SUPPORTED"],"x-genesys-enum-members":[{"name":"ENABLED"},{"name":"DISABLED"},{"name":"NOT_SUPPORTED"}]},"registersEnabledStatus":{"type":"string","description":"Returns Enabled when the trunk base supports the registration interval and it has a value greater than 0.","readOnly":true,"enum":["ENABLED","DISABLED","NOT_SUPPORTED"],"x-genesys-enum-members":[{"name":"ENABLED"},{"name":"DISABLED"},{"name":"NOT_SUPPORTED"}]},"family":{"type":"integer","format":"int32","description":"The IP Network Family of the trunk","readOnly":true},"proxyAddressList":{"type":"array","description":"The list of proxy addresses (ports if provided) for the trunk","readOnly":true,"items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TrunkConnectedStatus":{"type":"object","properties":{"connected":{"type":"boolean"},"connectedStateTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"TrunkEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Trunk"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"TrunkErrorInfo":{"type":"object","properties":{"text":{"type":"string"},"code":{"type":"string"},"details":{"$ref":"#/definitions/TrunkErrorInfoDetails"}}},"TrunkErrorInfoDetails":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"hostname":{"type":"string"}}},"TrunkMetricsNetworkTypeIp":{"type":"object","properties":{"address":{"type":"string","description":"Assigned IP Address for the interface"},"errorInfo":{"description":"Information about the error.","$ref":"#/definitions/TrunkErrorInfo"}}},"TrunkMetricsOptions":{"type":"object","properties":{"proxyAddress":{"type":"string","description":"Server proxy address that this options array element represents."},"optionState":{"type":"boolean"},"optionStateTime":{"type":"string","format":"date-time","description":"ISO 8601 format UTC absolute date & time of the last change of the option state."},"errorInfo":{"$ref":"#/definitions/TrunkErrorInfo"}}},"TrunkMetricsRegisters":{"type":"object","properties":{"proxyAddress":{"type":"string","description":"Server proxy address that this registers array element represents."},"registerState":{"type":"boolean","description":"True if last REGISTER message had positive response; false if error response or no response."},"registerStateTime":{"type":"string","format":"date-time","description":"ISO 8601 format UTC absolute date & time of the last change of the register state."},"errorInfo":{"$ref":"#/definitions/TrunkErrorInfo"}}},"UserQueueEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UserQueue"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FlowEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Flow"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EmailMessage":{"type":"object","required":["from","textBody","to"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"to":{"type":"array","description":"The recipients of the email message.","items":{"$ref":"#/definitions/EmailAddress"}},"cc":{"type":"array","description":"The recipients that were copied on the email message.","items":{"$ref":"#/definitions/EmailAddress"}},"bcc":{"type":"array","description":"The recipients that were blind copied on the email message.","items":{"$ref":"#/definitions/EmailAddress"}},"from":{"description":"The sender of the email message.","$ref":"#/definitions/EmailAddress"},"subject":{"type":"string","description":"The subject of the email message."},"attachments":{"type":"array","description":"The attachments of the email message.","items":{"$ref":"#/definitions/Attachment"}},"textBody":{"type":"string","description":"The text body of the email message."},"htmlBody":{"type":"string","description":"The html body of the email message."},"time":{"type":"string","format":"date-time","description":"The time when the message was received or sent. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"historyIncluded":{"type":"boolean","description":"Indicates whether the history of previous emails of the conversation is included within the email bodies of this message."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EmailMessageListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/EmailMessage"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CreateEmailRequest":{"type":"object","required":["provider"],"properties":{"queueId":{"type":"string","description":"The ID of the queue to use for routing the email conversation. This field is mutually exclusive with flowId"},"flowId":{"type":"string","description":"The ID of the flow to use for routing email conversation. This field is mutually exclusive with queueId"},"provider":{"type":"string","description":"The name of the provider that is sourcing the emails. The Provider \"PureCloud Email\" is reserved for native emails."},"skillIds":{"type":"array","description":"The list of skill ID's to use for routing.","items":{"type":"string"}},"languageId":{"type":"string","description":"The ID of the language to use for routing."},"priority":{"type":"integer","format":"int64","description":"The priority to assign to the conversation for routing."},"attributes":{"type":"object","description":"The list of attributes to associate with the customer participant.","additionalProperties":{"type":"string"}},"toAddress":{"type":"string","description":"The email address of the recipient of the email."},"toName":{"type":"string","description":"The name of the recipient of the email."},"fromAddress":{"type":"string","description":"The email address of the sender of the email."},"fromName":{"type":"string","description":"The name of the sender of the email."},"subject":{"type":"string","description":"The subject of the email"},"direction":{"type":"string","description":"Specify OUTBOUND to send an email on behalf of a queue, or INBOUND to create an external conversation. An external conversation is one where the provider is not PureCloud based.","enum":["OUTBOUND","INBOUND"],"x-genesys-enum-members":[{"name":"OUTBOUND"},{"name":"INBOUND"}]},"htmlBody":{"type":"string","description":"An HTML body content of the email."},"textBody":{"type":"string","description":"A text body content of the email."}}},"CopyAttachmentsRequest":{"type":"object","required":["attachments","sourceMessage"],"properties":{"sourceMessage":{"description":"A reference to the email message within the current conversation that owns the attachments to be copied","$ref":"#/definitions/DomainEntityRef"},"attachments":{"type":"array","description":"A list of attachments that will be copied from the source message to the current draft","items":{"$ref":"#/definitions/Attachment"}}}},"InboundMessageRequest":{"type":"object","required":["provider"],"properties":{"queueId":{"type":"string","description":"The ID of the queue to use for routing the email conversation. This field is mutually exclusive with flowId"},"flowId":{"type":"string","description":"The ID of the flow to use for routing email conversation. This field is mutually exclusive with queueId"},"provider":{"type":"string","description":"The name of the provider that is sourcing the email such as Oracle, Salesforce, etc."},"skillIds":{"type":"array","description":"The list of skill ID's to use for routing.","items":{"type":"string"}},"languageId":{"type":"string","description":"The ID of the language to use for routing."},"priority":{"type":"integer","format":"int32","description":"The priority to assign to the conversation for routing."},"attributes":{"type":"object","description":"The list of attributes to associate with the customer participant.","additionalProperties":{"type":"string"}},"toAddress":{"type":"string","description":"The email address of the recipient of the email."},"toName":{"type":"string","description":"The name of the recipient of the email."},"fromAddress":{"type":"string","description":"The email address of the sender of the email."},"fromName":{"type":"string","description":"The name of the sender of the email."},"subject":{"type":"string","description":"The subject of the email"}}},"NotificationsResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WfmUserNotification"}}}},"ShiftTradeNotification":{"type":"object","properties":{"weekDate":{"type":"string","description":"The start date of the schedule with which this trade is associated"},"tradeId":{"type":"string","description":"The ID of the shift trade"},"oneSided":{"type":"boolean","description":"Whether this is a one sided shift trade"},"newState":{"type":"string","description":"The new state of the shift trade, null if there was no change","enum":["Unmatched","Matched","Approved","Denied","Expired","Canceled"],"x-genesys-enum-members":[{"name":"Unmatched"},{"name":"Matched"},{"name":"Approved"},{"name":"Denied"},{"name":"Expired"},{"name":"Canceled"}]},"initiatingUser":{"description":"The user who initiated the shift trade","$ref":"#/definitions/UserReference"},"initiatingShiftDate":{"type":"string","format":"date-time","description":"The start date and time of the initiating shift. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"receivingUser":{"description":"The user on the receiving side of this shift trade (null if not matched)","$ref":"#/definitions/UserReference"},"receivingShiftDate":{"type":"string","format":"date-time","description":"The start date and time of the receiving shift (null if not matched or if one-sided. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"TimeOffRequestNotification":{"type":"object","properties":{"timeOffRequestId":{"type":"string","description":"The ID of this time off request"},"user":{"description":"The user associated with this time off request","$ref":"#/definitions/UserReference"},"isFullDayRequest":{"type":"boolean","description":"Whether this is a full day request (false means partial day)"},"status":{"type":"string","description":"The status of this time off request","enum":["PENDING","APPROVED","DENIED","CANCELED"],"x-genesys-enum-members":[{"name":"PENDING"},{"name":"APPROVED"},{"name":"DENIED"},{"name":"CANCELED"}]},"partialDayStartDateTimes":{"type":"array","description":"A set of start date-times in ISO-8601 format for partial day requests. Will be not empty if isFullDayRequest == false","items":{"type":"string","format":"date-time"}},"fullDayManagementUnitDates":{"type":"array","description":"A set of dates in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone. Will be not empty if isFullDayRequest == true","items":{"type":"string"}}}},"WfmUserNotification":{"type":"object","required":["id","markedAsRead","mutableGroupId"],"properties":{"id":{"type":"string","description":"The immutable globally unique identifier for the object."},"mutableGroupId":{"type":"string","description":"The group ID of the notification (mutable, may change on update)"},"timestamp":{"type":"string","format":"date-time","description":"The timestamp for this notification. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"type":{"type":"string","description":"The type of this notification","readOnly":true,"enum":["ShiftTrade","TimeOffRequest"],"x-genesys-enum-members":[{"name":"ShiftTrade"},{"name":"TimeOffRequest"}]},"shiftTrade":{"description":"A shift trade notification. Only set if type == ShiftTrade","readOnly":true,"$ref":"#/definitions/ShiftTradeNotification"},"timeOffRequest":{"description":"A time off request notification. Only set if type == TimeOffRequest","readOnly":true,"$ref":"#/definitions/TimeOffRequestNotification"},"markedAsRead":{"type":"boolean","description":"Whether this notification has been marked \"read\""},"agentNotification":{"type":"boolean","description":"Whether this notification is for an agent","readOnly":true},"otherNotificationIdsInGroup":{"type":"array","description":"Other notification IDs in group. This field is only populated in real-time notifications","readOnly":true,"uniqueItems":true,"items":{"type":"string"}}}},"UpdateNotificationResponse":{"type":"object","properties":{"mutableGroupId":{"type":"string","description":"The mutableGroupId of the notification"},"id":{"type":"string","description":"The id of the notification for mapping the potentially new mutableGroupId"}}},"UpdateNotificationsResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UpdateNotificationResponse"}}}},"UpdateNotificationsRequest":{"type":"object","required":["entities"],"properties":{"entities":{"type":"array","description":"The notifications to update","items":{"$ref":"#/definitions/WfmUserNotification"}}}},"MessagingCampaignDivisionViewEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/MessagingCampaignDivisionView"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"LanguageEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Language"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CustomerInteractionCenter":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"disabled":{"type":"boolean"},"issuerURI":{"type":"string"},"ssoTargetURI":{"type":"string"},"certificate":{"type":"string"},"certificates":{"type":"array","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ObservationMetricData":{"type":"object","properties":{"metric":{"type":"string"},"qualifier":{"type":"string"},"stats":{"$ref":"#/definitions/StatisticalSummary"},"truncated":{"type":"boolean","description":"Flag for a truncated list of observations. If truncated, the first half of the list of observations will contain the oldest observations and the second half the newest observations."},"observations":{"type":"array","description":"List of observations sorted by timestamp in ascending order. This list may be truncated.","items":{"$ref":"#/definitions/ObservationValue"}}}},"ObservationValue":{"type":"object","required":["observationDate"],"properties":{"observationDate":{"type":"string","format":"date-time","description":"The time at which the observation occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationId":{"type":"string","description":"Unique identifier for the conversation"},"sessionId":{"type":"string","description":"The unique identifier of this session"},"requestedRoutingSkillIds":{"type":"array","description":"Unique identifier for a skill requested for an interaction","uniqueItems":true,"items":{"type":"string"}},"requestedLanguageId":{"type":"string","description":"Unique identifier for the language requested for an interaction"},"routingPriority":{"type":"integer","format":"int64","description":"Routing priority for the current interaction"},"participantName":{"type":"string","description":"A human readable name identifying the participant"},"userId":{"type":"string","description":"Unique identifier for the user"},"direction":{"type":"string","description":"The direction of the communication","enum":["inbound","outbound"],"x-genesys-enum-members":[{"name":"inbound"},{"name":"outbound"}]},"convertedFrom":{"type":"string","description":"Session media type that was converted from in case of a media type conversion"},"convertedTo":{"type":"string","description":"Session media type that was converted to in case of a media type conversion"},"addressFrom":{"type":"string","description":"The address that initiated an action"},"addressTo":{"type":"string","description":"The address receiving an action"},"ani":{"type":"string","description":"Automatic Number Identification (caller's number)"},"dnis":{"type":"string","description":"Dialed number identification service (number dialed by the calling party)"},"teamId":{"type":"string","description":"The team id the user is a member of"},"requestedRoutings":{"type":"array","description":"All routing types for requested/attempted routing methods","uniqueItems":true,"items":{"type":"string","enum":["Predictive","Preferred","Manual","Last","Bullseye","Standard"],"x-genesys-enum-members":[{"name":"Predictive"},{"name":"Preferred"},{"name":"Manual"},{"name":"Last"},{"name":"Bullseye"},{"name":"Standard"}]}},"usedRouting":{"type":"string","description":"Complete routing method","enum":["Predictive","Preferred","Manual","Last","Bullseye","Standard"],"x-genesys-enum-members":[{"name":"Predictive"},{"name":"Preferred"},{"name":"Manual"},{"name":"Last"},{"name":"Bullseye"},{"name":"Standard"}]},"scoredAgents":{"type":"array","items":{"$ref":"#/definitions/AnalyticsScoredAgent"}}}},"QueueObservationDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/ObservationMetricData"}}}},"QueueObservationQueryResponse":{"type":"object","properties":{"systemToOrganizationMappings":{"type":"object","description":"A mapping from system presence to a list of organization presence ids","additionalProperties":{"type":"array","items":{"type":"string"}}},"results":{"type":"array","items":{"$ref":"#/definitions/QueueObservationDataContainer"}}}},"QueueObservationQuery":{"type":"object","required":["filter","metrics"],"properties":{"filter":{"description":"Filter to return a subset of observations. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/QueueObservationQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["oActiveUsers","oAlerting","oInteracting","oMemberUsers","oOffQueueUsers","oOnQueueUsers","oUserPresences","oUserRoutingStatuses","oWaiting"],"x-genesys-enum-members":[{"name":"oActiveUsers"},{"name":"oAlerting"},{"name":"oInteracting"},{"name":"oMemberUsers"},{"name":"oOffQueueUsers"},{"name":"oOnQueueUsers"},{"name":"oUserPresences"},{"name":"oUserRoutingStatuses"},{"name":"oWaiting"}]}},"detailMetrics":{"type":"array","description":"Metrics for which to include additional detailed observations","items":{"type":"string","enum":["oActiveUsers","oAlerting","oInteracting","oMemberUsers","oOffQueueUsers","oOnQueueUsers","oUserPresences","oUserRoutingStatuses","oWaiting"],"x-genesys-enum-members":[{"name":"oActiveUsers"},{"name":"oAlerting"},{"name":"oInteracting"},{"name":"oMemberUsers"},{"name":"oOffQueueUsers"},{"name":"oOnQueueUsers"},{"name":"oUserPresences"},{"name":"oUserRoutingStatuses"},{"name":"oWaiting"}]}}}},"QueueObservationQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/QueueObservationQueryPredicate"}}}},"QueueObservationQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/QueueObservationQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/QueueObservationQueryPredicate"}}}},"QueueObservationQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"],"x-genesys-enum-members":[{"name":"dimension"},{"name":"property"},{"name":"metric"}]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["mediaType","queueId"],"x-genesys-enum-members":[{"name":"mediaType"},{"name":"queueId"}]},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"],"x-genesys-enum-members":[{"name":"matches"},{"name":"exists"},{"name":"notExists"}]},"value":{"type":"string","description":"Right hand side for dimension predicates"},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"DependencyStatus":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"user":{"description":"User that initiated the build.","$ref":"#/definitions/User"},"client":{"description":"OAuth client that initiated the build.","$ref":"#/definitions/DomainEntityRef"},"buildId":{"type":"string"},"dateStarted":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateCompleted":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"status":{"type":"string","enum":["BUILDINITIALIZING","BUILDINPROGRESS","NOTBUILT","OPERATIONAL","OPERATIONALNEEDSREBUILD"],"x-genesys-enum-members":[{"name":"BUILDINITIALIZING"},{"name":"BUILDINPROGRESS"},{"name":"NOTBUILT"},{"name":"OPERATIONAL"},{"name":"OPERATIONALNEEDSREBUILD"}]},"failedObjects":{"type":"array","items":{"$ref":"#/definitions/FailedObject"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FailedObject":{"type":"object","properties":{"id":{"type":"string"},"version":{"type":"string"},"name":{"type":"string"},"errorCode":{"type":"string"}}},"GenericSAML":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"disabled":{"type":"boolean"},"issuerURI":{"type":"string"},"ssoTargetURI":{"type":"string"},"certificate":{"type":"string"},"certificates":{"type":"array","items":{"type":"string"}},"relyingPartyIdentifier":{"type":"string"},"logoImageData":{"type":"string"},"endpointCompression":{"type":"boolean"},"nameIdentifierFormat":{"type":"string","enum":["urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified","urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress","urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName","urn:oasis:names:tc:SAML:1.1:nameid-format:WindowsDomainQualifiedName","urn:oasis:names:tc:SAML:2.0:nameid-format:kerberos","urn:oasis:names:tc:SAML:2.0:nameid-format:entity","urn:oasis:names:tc:SAML:2.0:nameid-format:persistent","urn:oasis:names:tc:SAML:2.0:nameid-format:transient"],"x-genesys-enum-members":[{"name":"urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified"},{"name":"urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress"},{"name":"urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName"},{"name":"urn:oasis:names:tc:SAML:1.1:nameid-format:WindowsDomainQualifiedName"},{"name":"urn:oasis:names:tc:SAML:2.0:nameid-format:kerberos"},{"name":"urn:oasis:names:tc:SAML:2.0:nameid-format:entity"},{"name":"urn:oasis:names:tc:SAML:2.0:nameid-format:persistent"},{"name":"urn:oasis:names:tc:SAML:2.0:nameid-format:transient"}]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"InteractionStatsRule":{"type":"object","required":["alertTypes","dimension","dimensionValue","enabled","mediaType","metric","name","notificationUsers","numericRange","statistic","value"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Name of the rule"},"dimension":{"type":"string","description":"The dimension of concern.","enum":["queueId","userId"],"x-genesys-enum-members":[{"name":"queueId"},{"name":"userId"}]},"dimensionValue":{"type":"string","description":"The value of the dimension."},"metric":{"type":"string","description":"The metric to be assessed.","enum":["tAbandon","tAnswered","tTalk","nOffered","tHandle","nTransferred","oServiceLevel","tWait","tHeld","tAcw"],"x-genesys-enum-members":[{"name":"tAbandon"},{"name":"tAnswered"},{"name":"tTalk"},{"name":"nOffered"},{"name":"tHandle"},{"name":"nTransferred"},{"name":"oServiceLevel"},{"name":"tWait"},{"name":"tHeld"},{"name":"tAcw"}]},"mediaType":{"type":"string","description":"The media type.","enum":["voice","chat","email","callback","message"],"x-genesys-enum-members":[{"name":"voice"},{"name":"chat"},{"name":"email"},{"name":"callback"},{"name":"message"}]},"numericRange":{"type":"string","description":"The comparison descriptor used against the metric's value.","enum":["gt","gte","lt","lte","eq","ne"],"x-genesys-enum-members":[{"name":"gt"},{"name":"gte"},{"name":"lt"},{"name":"lte"},{"name":"eq"},{"name":"ne"}]},"statistic":{"type":"string","description":"The statistic of concern for the metric.","enum":["count","min","ratio","max"],"x-genesys-enum-members":[{"name":"count"},{"name":"min"},{"name":"ratio"},{"name":"max"}]},"value":{"type":"number","format":"double","description":"The threshold value."},"enabled":{"type":"boolean","description":"Indicates if the rule is enabled."},"inAlarm":{"type":"boolean","description":"Indicates if the rule is in alarm state.","readOnly":true},"notificationUsers":{"type":"array","description":"The ids of users who will be notified of alarm state change.","uniqueItems":true,"items":{"$ref":"#/definitions/User"}},"alertTypes":{"type":"array","description":"A collection of notification methods.","uniqueItems":true,"items":{"type":"string","enum":["SMS","DEVICE","EMAIL"],"x-genesys-enum-members":[{"name":"SMS"},{"name":"DEVICE"},{"name":"EMAIL"}]}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"InteractionStatsRuleContainer":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/InteractionStatsRule"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ChatSettings":{"type":"object","properties":{"messageRetentionPeriodDays":{"type":"integer","format":"int32","description":"Retention time for messages in days"}}},"OAuthScope":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"description":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OAuthScopeListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/OAuthScope"}},"selfUri":{"type":"string","format":"uri"}}},"BatchDownloadJobResult":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"conversationId":{"type":"string","description":"Conversation id of the result"},"recordingId":{"type":"string","description":"Recording id of the result"},"resultUrl":{"type":"string","description":"URL of results... HTTP GET from this location to download results for this item"},"contentType":{"type":"string","description":"Content type of this result"},"errorMsg":{"type":"string","description":"An error message, in case of failed processing will indicate the cause of the failure"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BatchDownloadJobStatusResult":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"jobId":{"type":"string","description":"JobId returned when job was initially submitted"},"expectedResultCount":{"type":"integer","format":"int32","description":"Number of results expected when job is completed"},"resultCount":{"type":"integer","format":"int32","description":"Current number of results available"},"errorCount":{"type":"integer","format":"int32","description":"Number of error results produced so far"},"results":{"type":"array","description":"Current set of results for the job","items":{"$ref":"#/definitions/BatchDownloadJobResult"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BatchDownloadJobSubmissionResult":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BatchDownloadJobSubmission":{"type":"object","required":["batchDownloadRequestList"],"properties":{"batchDownloadRequestList":{"type":"array","description":"List of up to 100 items requested","items":{"$ref":"#/definitions/BatchDownloadRequest"}}}},"BatchDownloadRequest":{"type":"object","properties":{"conversationId":{"type":"string","description":"Conversation id requested"},"recordingId":{"type":"string","description":"Recording id requested, optional. Leave null for all recordings on the conversation"}}},"FlowOutcome":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The flow outcome identifier"},"name":{"type":"string","description":"The flow outcome name."},"description":{"type":"string"},"currentOperation":{"$ref":"#/definitions/Operation"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FlowOutcomeListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/FlowOutcome"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"SubscriberResponse":{"type":"object","required":["status"],"properties":{"messageReturned":{"type":"array","description":"Suggested valid addresses","items":{"type":"string"}},"status":{"type":"string","description":"http status"}}},"ValidateAddressResponse":{"type":"object","required":["valid"],"properties":{"valid":{"type":"boolean","description":"Was the passed in address valid"},"response":{"description":"Subscriber schema","$ref":"#/definitions/SubscriberResponse"}}},"StreetAddress":{"type":"object","required":["A1","A3","country"],"properties":{"country":{"type":"string","description":"2 Letter Country code, like US or GB"},"A1":{"type":"string","description":"State or Province"},"A3":{"type":"string","description":"City or township"},"RD":{"type":"string"},"HNO":{"type":"string"},"LOC":{"type":"string"},"NAM":{"type":"string"},"PC":{"type":"string"}}},"ValidateAddressRequest":{"type":"object","properties":{"address":{"description":"Address schema","$ref":"#/definitions/StreetAddress"}}},"GeneralProgramJob":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"state":{"type":"string","enum":["Running","Completed","Failed"],"x-genesys-enum-members":[{"name":"Running"},{"name":"Completed"},{"name":"Failed"}]},"createdBy":{"$ref":"#/definitions/AddressableEntityRef"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GeneralProgramJobRequest":{"type":"object","required":["dialect"],"properties":{"dialect":{"type":"string","description":"The dialect of the topics to link with the general program, dialect format is {language}-{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard","enum":["en-US","es-US","en-AU","en-GB"]},"mode":{"type":"string","description":"The mode to use for the general program job, default value is Skip","enum":["Skip","Merge"],"x-genesys-enum-members":[{"name":"Skip"},{"name":"Merge"}]}}},"OrganizationRoleEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DomainOrganizationRole"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FlowRuntimeExecution":{"type":"object","required":["dateLaunched","flowVersion","status"],"properties":{"id":{"type":"string","description":"The flow execution ID"},"name":{"type":"string","description":"The flow execution name."},"flowVersion":{"description":"The Version of the flow definition of the flow execution.","$ref":"#/definitions/FlowVersion"},"dateLaunched":{"type":"string","format":"date-time","description":"The time the flow was launched. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"status":{"type":"string","description":"The flow's running status, which indicates whether the flow is running normally or completed, etc.","enum":["UNKNOWN","RUNNING","ERROR","TERMINATED","COMPLETED","FAILED"],"x-genesys-enum-members":[{"name":"UNKNOWN"},{"name":"RUNNING"},{"name":"ERROR"},{"name":"TERMINATED"},{"name":"COMPLETED"},{"name":"FAILED"}]},"dateCompleted":{"type":"string","format":"date-time","description":"The time the flow completed, if applicable. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"completionReason":{"type":"string","description":"The completion reason set at the flow completion time, if applicable."},"flowErrorInfo":{"description":"Additional information if the flow is in error","$ref":"#/definitions/ErrorBody"},"outputData":{"type":"object","description":"List of the flow's output variables, if any. Output variables are only supplied for Completed flows.","additionalProperties":{"type":"object"}},"conversation":{"description":"The conversation to which this Flow execution is related","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Details about the current state of a Flow execution"},"CallForwarding":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"user":{"$ref":"#/definitions/User"},"enabled":{"type":"boolean","description":"Whether or not CallForwarding is enabled"},"phoneNumber":{"type":"string","description":"This property is deprecated. Please use the calls property"},"calls":{"type":"array","description":"An ordered list of CallRoutes to be executed when CallForwarding is enabled","items":{"$ref":"#/definitions/CallRoute"}},"voicemail":{"type":"string","description":"The type of voicemail to use with the callForwarding configuration","enum":["PURECLOUD","LASTCALL","NONE"],"x-genesys-enum-members":[{"name":"PURECLOUD"},{"name":"LASTCALL"},{"name":"NONE"}]},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CallRoute":{"type":"object","properties":{"targets":{"type":"array","description":"A list of CallTargets to be called when the CallRoute is executed","items":{"$ref":"#/definitions/CallTarget"}}}},"CallTarget":{"type":"object","properties":{"type":{"type":"string","description":"The type of call","enum":["STATION","PHONENUMBER"],"x-genesys-enum-members":[{"name":"STATION"},{"name":"PHONENUMBER"}]},"value":{"type":"string","description":"The id of the station or an E.164 formatted phone number"}}},"QueueRequest":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The queue name"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/WritableDivision"},"description":{"type":"string","description":"The queue description."},"dateCreated":{"type":"string","format":"date-time","description":"The date the queue was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the queue. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the queue."},"createdBy":{"type":"string","description":"The ID of the user that created the queue."},"memberCount":{"type":"integer","format":"int32","description":"The number of users in the queue.","readOnly":true},"mediaSettings":{"type":"object","description":"The media settings for the queue. Valid key values: CALL, CALLBACK, CHAT, EMAIL, MESSAGE, SOCIAL_EXPRESSION, VIDEO_COMM","additionalProperties":{"$ref":"#/definitions/MediaSetting"}},"routingRules":{"type":"array","description":"The routing rules for the queue, used for routing to known or preferred agents.","items":{"$ref":"#/definitions/RoutingRule"}},"bullseye":{"description":"The bulls-eye settings for the queue.","$ref":"#/definitions/Bullseye"},"acwSettings":{"description":"The ACW settings for the queue.","$ref":"#/definitions/AcwSettings"},"skillEvaluationMethod":{"type":"string","description":"The skill evaluation method to use when routing conversations.","enum":["NONE","BEST","ALL"],"x-genesys-enum-members":[{"name":"NONE"},{"name":"BEST"},{"name":"ALL"}]},"queueFlow":{"description":"The in-queue flow to use for conversations waiting in queue.","$ref":"#/definitions/DomainEntityRef"},"whisperPrompt":{"description":"The prompt used for whisper on the queue, if configured.","$ref":"#/definitions/DomainEntityRef"},"autoAnswerOnly":{"type":"boolean","description":"Specifies whether the configured whisper should play for all ACD calls, or only for those which are auto-answered."},"enableTranscription":{"type":"boolean","description":"Indicates whether voice transcription is enabled for this queue."},"enableManualAssignment":{"type":"boolean","description":"Indicates whether manual assignment is enabled for this queue."},"callingPartyName":{"type":"string","description":"The name to use for caller identification for outbound calls from this queue."},"callingPartyNumber":{"type":"string","description":"The phone number to use for caller identification for outbound calls from this queue."},"defaultScripts":{"type":"object","description":"The default script Ids for the communication types.","additionalProperties":{"$ref":"#/definitions/Script"}},"outboundMessagingAddresses":{"description":"The messaging addresses for the queue.","$ref":"#/definitions/QueueMessagingAddresses"},"outboundEmailAddress":{"$ref":"#/definitions/QueueEmailAddress"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TrunkBaseEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/TrunkBase"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ActionTemplateListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ActionTemplate"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EdgeLine":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"schema":{"$ref":"#/definitions/DomainEntityRef"},"properties":{"type":"object","additionalProperties":{"type":"object"}},"edge":{"$ref":"#/definitions/Edge"},"edgeGroup":{"$ref":"#/definitions/EdgeGroup"},"lineType":{"type":"string","enum":["TIE","NETWORK","TRUNK","STATION"],"x-genesys-enum-members":[{"name":"TIE"},{"name":"NETWORK"},{"name":"TRUNK"},{"name":"STATION"}]},"endpoint":{"$ref":"#/definitions/Endpoint"},"ipAddress":{"type":"string"},"logicalInterfaceId":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"QueueMemberEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/QueueMember"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"WebChatGuestMediaRequest":{"type":"object","required":["state","types"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"types":{"type":"array","description":"The types of media being requested.","items":{"type":"string","enum":["COBROWSE","SCREENSHARE"],"x-genesys-enum-members":[{"name":"COBROWSE"},{"name":"SCREENSHARE"}]}},"state":{"type":"string","description":"The state of the media request, one of PENDING|ACCEPTED|DECLINED|TIMEDOUT|CANCELLED|ERRORED.","enum":["PENDING","ACCEPTED","DECLINED","TIMEDOUT","CANCELLED","ERRORED"],"x-genesys-enum-members":[{"name":"PENDING"},{"name":"ACCEPTED"},{"name":"DECLINED"},{"name":"TIMEDOUT"},{"name":"CANCELLED"},{"name":"ERRORED"}]},"communicationId":{"type":"string","description":"The ID of the new media communication, if applicable."},"securityKey":{"type":"string","description":"The security information related to a media request."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Object representing the guest model of a media request of a chat conversation."},"Recipient":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"flow":{"description":"An automate flow object which defines the set of actions to be taken, when a message is received by this provisioned phone number.","$ref":"#/definitions/Flow"},"dateCreated":{"type":"string","format":"date-time","description":"Date this recipient was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date this recipient was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"description":"User that created this recipient","$ref":"#/definitions/User"},"modifiedBy":{"description":"User that modified this recipient","$ref":"#/definitions/User"},"messengerType":{"type":"string","description":"The messenger type for this recipient","enum":["sms","facebook","twitter","line","whatsapp","webmessaging"],"x-genesys-enum-members":[{"name":"sms"},{"name":"facebook"},{"name":"twitter"},{"name":"line"},{"name":"whatsapp"},{"name":"webmessaging"}]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"RecipientListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Recipient"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"PhoneBase":{"type":"object","required":["lines","name","phoneMetaBase"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"phoneMetaBase":{"description":"A phone metabase is essentially a database for storing phone configuration settings, which simplifies the configuration process.","$ref":"#/definitions/DomainEntityRef"},"lines":{"type":"array","description":"The list of linebases associated with the phone base.","items":{"$ref":"#/definitions/LineBase"}},"properties":{"type":"object","additionalProperties":{"type":"object"}},"capabilities":{"$ref":"#/definitions/PhoneCapabilities"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WebChatMemberInfoEntityList":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WebChatMemberInfo"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"MetaData":{"type":"object","properties":{"pairing-token":{"type":"string"},"pairing-trust":{"type":"array","items":{"type":"string"}},"pairing-url":{"type":"string"}}},"VmPairingInfo":{"type":"object","properties":{"meta-data":{"description":"This is to be used to complete the setup process of a locally deployed virtual edge device.","$ref":"#/definitions/MetaData"},"edge-id":{"type":"string"},"auth-token":{"type":"string"},"org-id":{"type":"string"}}},"TrustEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Trustee"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Trustee":{"type":"object","required":["enabled"],"properties":{"id":{"type":"string","description":"Organization Id for this trust.","readOnly":true},"enabled":{"type":"boolean","description":"If disabled no trustee user will have access, even if they were previously added."},"dateCreated":{"type":"string","format":"date-time","description":"Date Trust was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"createdBy":{"description":"User that created trust.","readOnly":true,"$ref":"#/definitions/OrgUser"},"organization":{"description":"Organization associated with this trust.","readOnly":true,"$ref":"#/definitions/Organization"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TrustCreate":{"type":"object","required":["enabled","pairingId"],"properties":{"pairingId":{"type":"string","description":"The pairing Id created by the trustee. This is required to prove that the trustee agrees to the relationship."},"enabled":{"type":"boolean","description":"If disabled no trustee user will have access, even if they were previously added."},"users":{"type":"array","description":"The list of users and their roles to which access will be granted. The users are from the trustee and the roles are from the trustor. If no users are specified, at least one group is required.","items":{"$ref":"#/definitions/TrustMemberCreate"}},"groups":{"type":"array","description":"The list of groups and their roles to which access will be granted. The groups are from the trustee and the roles are from the trustor. If no groups are specified, at least one user is required.","items":{"$ref":"#/definitions/TrustMemberCreate"}}}},"RecordingSettings":{"type":"object","properties":{"maxSimultaneousStreams":{"type":"integer","format":"int32","description":"Maximum number of simultaneous screen recording streams"},"maxConfigurableScreenRecordingStreams":{"type":"integer","format":"int32","description":"Upper limit that maxSimultaneousStreams can be configured"}}},"ListWrapperInterval":{"type":"object","properties":{"values":{"type":"array","items":{"type":"string","description":"Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"}}}},"PatchShiftTradeRequest":{"type":"object","required":["metadata"],"properties":{"receivingUserId":{"description":"Update the ID of the receiving user to direct the request at a specific user, or set the wrapped id to null to open up a trade to be matched by any user.","$ref":"#/definitions/ValueWrapperString"},"expiration":{"description":"Update the expiration time for this shift trade.","$ref":"#/definitions/ValueWrapperDate"},"acceptableIntervals":{"description":"Update the acceptable intervals the initiating user is willing to accept in trade. Setting the enclosed list to empty will make this a one sided trade request","$ref":"#/definitions/ListWrapperInterval"},"metadata":{"description":"Version metadata","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"ValueWrapperDate":{"type":"object","properties":{"value":{"type":"string","format":"date-time","description":"The value for the associated field. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}},"description":"An object to provide context to nullable fields in PATCH requests"},"ValueWrapperString":{"type":"object","properties":{"value":{"type":"string","description":"The value for the associated field"}},"description":"An object to provide context to nullable fields in PATCH requests"},"MatchShiftTradeResponse":{"type":"object","properties":{"trade":{"description":"The associated shift trade","$ref":"#/definitions/ShiftTradeResponse"},"violations":{"type":"array","description":"Constraint violations which disallow this shift trade","items":{"$ref":"#/definitions/ShiftTradeMatchViolation"}},"adminReviewViolations":{"type":"array","description":"Constraint violations for this shift trade which require shift trade administrator review","items":{"$ref":"#/definitions/ShiftTradeMatchViolation"}}}},"ShiftTradeMatchViolation":{"type":"object","properties":{"type":{"type":"string","description":"The type of constraint violation","enum":["AgentCapabilityMismatch","CannotTradeWithYourself","DirectTradeForOtherUser","InitiatingAgentScheduleDoesNotExist","InitiatingShiftDisallowedActivityCategory","InitiatingShiftDoesNotExist","InitiatingShiftHasExternalActivities","InitiatingShiftOverlapsExisting","InitiatingShiftStartTooClose","InitiatingShiftTimesChanged","InitiatingWeeklyMaxPaidTime","InitiatingWeeklyMinPaidTime","InvalidState","OneSidedTradeCreation","ReceivingAgentScheduleDoesNotExist","ReceivingShiftDisallowedActivityCategory","ReceivingShiftDoesNotExist","ReceivingShiftForOneSidedTrade","ReceivingShiftHasExternalActivities","ReceivingShiftMissingForTwoSidedTrade","ReceivingShiftOutsideAcceptableIntervals","ReceivingShiftOverlapsExisting","ReceivingShiftStartTooClose","ReceivingShiftTimesChanged","ReceivingWeeklyMaxPaidTime","ReceivingWeeklyMinPaidTime","ShiftTradingNotEnabled","UnequalPaidTime","WeekScheduleDifferent","WeekScheduleDoesNotExist","WeekScheduleUnpublished"],"x-genesys-enum-members":[{"name":"AgentCapabilityMismatch"},{"name":"CannotTradeWithYourself"},{"name":"DirectTradeForOtherUser"},{"name":"InitiatingAgentScheduleDoesNotExist"},{"name":"InitiatingShiftDisallowedActivityCategory"},{"name":"InitiatingShiftDoesNotExist"},{"name":"InitiatingShiftHasExternalActivities"},{"name":"InitiatingShiftOverlapsExisting"},{"name":"InitiatingShiftStartTooClose"},{"name":"InitiatingShiftTimesChanged"},{"name":"InitiatingWeeklyMaxPaidTime"},{"name":"InitiatingWeeklyMinPaidTime"},{"name":"InvalidState"},{"name":"OneSidedTradeCreation"},{"name":"ReceivingAgentScheduleDoesNotExist"},{"name":"ReceivingShiftDisallowedActivityCategory"},{"name":"ReceivingShiftDoesNotExist"},{"name":"ReceivingShiftForOneSidedTrade"},{"name":"ReceivingShiftHasExternalActivities"},{"name":"ReceivingShiftMissingForTwoSidedTrade"},{"name":"ReceivingShiftOutsideAcceptableIntervals"},{"name":"ReceivingShiftOverlapsExisting"},{"name":"ReceivingShiftStartTooClose"},{"name":"ReceivingShiftTimesChanged"},{"name":"ReceivingWeeklyMaxPaidTime"},{"name":"ReceivingWeeklyMinPaidTime"},{"name":"ShiftTradingNotEnabled"},{"name":"UnequalPaidTime"},{"name":"WeekScheduleDifferent"},{"name":"WeekScheduleDoesNotExist"},{"name":"WeekScheduleUnpublished"}]},"params":{"type":"object","description":"Clarifying user params for constructing helpful error messages","additionalProperties":{"type":"string"}}}},"MatchShiftTradeRequest":{"type":"object","required":["metadata","receivingScheduleId"],"properties":{"receivingScheduleId":{"type":"string","description":"The ID of the schedule with which the shift trade is associated"},"receivingShiftId":{"type":"string","description":"The ID of the shift the receiving user is giving up in trade, if applicable"},"metadata":{"description":"Version metadata for the shift trade","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"AddShiftTradeRequest":{"type":"object","required":["initiatingShiftId","scheduleId"],"properties":{"scheduleId":{"type":"string","description":"The ID of the schedule to which the initiating and receiving shifts belong"},"initiatingShiftId":{"type":"string","description":"The ID of the shift that the initiating user wants to give up"},"receivingUserId":{"type":"string","description":"The ID of the user to whom to send the request (for use in direct trade requests)"},"expiration":{"type":"string","format":"date-time","description":"When this shift trade request should expire. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"acceptableIntervals":{"type":"array","items":{"type":"string","description":"Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"}}}},"SearchShiftTradeResponse":{"type":"object","properties":{"trade":{"description":"A trade which matches search criteria","$ref":"#/definitions/ShiftTradeResponse"},"matchingReceivingShiftIds":{"type":"array","description":"IDs of shifts which match the search criteria","items":{"type":"string"}},"preview":{"description":"A preview of what the shift trade would look like if matched","$ref":"#/definitions/ShiftTradePreviewResponse"}}},"SearchShiftTradesResponse":{"type":"object","properties":{"trades":{"type":"array","description":"The shift trades that match the search criteria","items":{"$ref":"#/definitions/SearchShiftTradeResponse"}}}},"ShiftTradeActivityPreviewResponse":{"type":"object","properties":{"startDate":{"type":"string","format":"date-time","description":"The start date and time of this activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"lengthMinutes":{"type":"integer","format":"int32","description":"The length in minutes of this activity"},"activityCodeId":{"type":"string","description":"The ID of the activity code for this activity"},"countsAsPaidTime":{"type":"boolean","description":"Whether this activity counts as paid time"}}},"ShiftTradePreviewResponse":{"type":"object","properties":{"activities":{"type":"array","description":"List of activities that will make up the new shift if this shift trade is approved","items":{"$ref":"#/definitions/ShiftTradeActivityPreviewResponse"}}}},"SearchShiftTradesRequest":{"type":"object","required":["receivingScheduleId"],"properties":{"receivingScheduleId":{"type":"string","description":"The ID of the schedule for which to search for available shift trades"},"receivingShiftIds":{"type":"array","description":"The IDs of shifts that the receiving user would potentially be willing to trade. If empty, only returns one sided trades (pick up a shift)","uniqueItems":true,"items":{"type":"string"}}}},"ShiftTradeMatchReviewResponse":{"type":"object","properties":{"initiatingUser":{"description":"Details for the initiatingUser side of the shift trade","$ref":"#/definitions/ShiftTradeMatchReviewUserResponse"},"receivingUser":{"description":"Details for the receivingUser side of the shift trade","$ref":"#/definitions/ShiftTradeMatchReviewUserResponse"},"violations":{"type":"array","description":"Constraint violations introduced after being matched that would normally disallow a trade, but which can still be overridden by the shift trade administrator","items":{"$ref":"#/definitions/ShiftTradeMatchViolation"}},"adminReviewViolations":{"type":"array","description":"Constraint violations associated with this shift trade which require shift trade administrator review","items":{"$ref":"#/definitions/ShiftTradeMatchViolation"}}}},"ShiftTradeMatchReviewUserResponse":{"type":"object","properties":{"weeklyMinimumPaidMinutes":{"type":"integer","format":"int32","description":"The minimum weekly paid minutes for this user per the work plan tied to the agent schedule"},"weeklyMaximumPaidMinutes":{"type":"integer","format":"int32","description":"The maximum weekly paid minutes for this user per the work plan tied to the agent schedule"},"preTradeSchedulePaidMinutes":{"type":"integer","format":"int32","description":"The paid minutes on the week schedule for this user prior to the shift trade"},"postTradeSchedulePaidMinutes":{"type":"integer","format":"int32","description":"The paid minutes on the week schedule for this user if the shift trade is approved"},"postTradeNewShift":{"description":"Preview of what the shift will look like for the opposite side of this trade after the match is approved","$ref":"#/definitions/ShiftTradePreviewResponse"}}},"WeekShiftTradeListResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WeekShiftTradeResponse"}}}},"WeekShiftTradeResponse":{"type":"object","properties":{"trade":{"description":"The shift trade details","$ref":"#/definitions/ShiftTradeResponse"},"matchReview":{"description":"A preview of what the schedule would look like if the shift trade is approved plus any violations","$ref":"#/definitions/ShiftTradeMatchReviewResponse"}}},"BulkUpdateShiftTradeStateResponse":{"type":"object","properties":{"status":{"type":"string","description":"The status of the operation","enum":["Processing","Complete","Canceled","Error"],"x-genesys-enum-members":[{"name":"Processing"},{"name":"Complete"},{"name":"Canceled"},{"name":"Error"}]},"operationId":{"type":"string","description":"The ID for the operation"},"result":{"description":"The result of the operation. Null unless status == Complete","$ref":"#/definitions/BulkUpdateShiftTradeStateResult"}}},"BulkUpdateShiftTradeStateResult":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/BulkUpdateShiftTradeStateResultItem"}}}},"BulkUpdateShiftTradeStateResultItem":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"state":{"type":"string","description":"The state of the shift trade after the update request is processed","enum":["Unmatched","Matched","Approved","Denied","Expired","Canceled"],"x-genesys-enum-members":[{"name":"Unmatched"},{"name":"Matched"},{"name":"Approved"},{"name":"Denied"},{"name":"Expired"},{"name":"Canceled"}]},"reviewedBy":{"description":"The user who reviewed the request, if applicable","$ref":"#/definitions/UserReference"},"reviewedDate":{"type":"string","format":"date-time","description":"The date the request was reviewed, if applicable. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"failureReason":{"type":"string","description":"The reason the update failed, if applicable","enum":["InitiatingAgentScheduleNotFound","InitiatingAgentShiftHasExternalActivities","InitiatingAgentShiftNotFound","ReceivingAgentNotFound","ReceivingAgentScheduleNotFound","ReceivingAgentShiftHasExternalActivities","ReceivingAgentShiftNotFound","ScheduleNotPublished","TransitionNotAllowed"],"x-genesys-enum-members":[{"name":"InitiatingAgentScheduleNotFound"},{"name":"InitiatingAgentShiftHasExternalActivities"},{"name":"InitiatingAgentShiftNotFound"},{"name":"ReceivingAgentNotFound"},{"name":"ReceivingAgentScheduleNotFound"},{"name":"ReceivingAgentShiftHasExternalActivities"},{"name":"ReceivingAgentShiftNotFound"},{"name":"ScheduleNotPublished"},{"name":"TransitionNotAllowed"}]},"metadata":{"description":"Version metadata for the shift trade","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"BulkShiftTradeStateUpdateRequest":{"type":"object","required":["entities"],"properties":{"entities":{"type":"array","description":"The shift trades to update","items":{"$ref":"#/definitions/BulkUpdateShiftTradeStateRequestItem"}}}},"BulkUpdateShiftTradeStateRequestItem":{"type":"object","required":["metadata","state"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"state":{"type":"string","description":"The new state to set on the shift trade","enum":["Unmatched","Matched","Approved","Denied","Expired","Canceled"],"x-genesys-enum-members":[{"name":"Unmatched"},{"name":"Matched"},{"name":"Approved"},{"name":"Denied"},{"name":"Expired"},{"name":"Canceled"}]},"metadata":{"description":"Version metadata for the shift trade","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"FlowDivisionView":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The flow identifier"},"name":{"type":"string","description":"The flow name"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/WritableDivision"},"type":{"type":"string","enum":["BOT","COMMONMODULE","INBOUNDCALL","INBOUNDCHAT","INBOUNDEMAIL","INBOUNDSHORTMESSAGE","INQUEUECALL","OUTBOUNDCALL","SECURECALL","SPEECH","SURVEYINVITE","WORKFLOW"],"x-genesys-enum-members":[{"name":"BOT"},{"name":"COMMONMODULE"},{"name":"INBOUNDCALL"},{"name":"INBOUNDCHAT"},{"name":"INBOUNDEMAIL"},{"name":"INBOUNDSHORTMESSAGE"},{"name":"INQUEUECALL"},{"name":"OUTBOUNDCALL"},{"name":"SECURECALL"},{"name":"SPEECH"},{"name":"SURVEYINVITE"},{"name":"WORKFLOW"}]},"inputSchema":{"description":"json schema describing the inputs for the flow","$ref":"#/definitions/JsonSchemaDocument"},"outputSchema":{"description":"json schema describing the outputs for the flow","$ref":"#/definitions/JsonSchemaDocument"},"publishedVersion":{"description":"published version information if there is a published version","$ref":"#/definitions/FlowVersion"},"debugVersion":{"description":"debug version information if there is a debug version","$ref":"#/definitions/FlowVersion"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FlowDivisionViewEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/FlowDivisionView"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AsyncIntradayResponse":{"type":"object","properties":{"status":{"type":"string","description":"The status of the operation","enum":["Processing","Complete","Canceled","Error"],"x-genesys-enum-members":[{"name":"Processing"},{"name":"Complete"},{"name":"Canceled"},{"name":"Error"}]},"operationId":{"type":"string","description":"The ID for the operation"},"result":{"description":"The result of the operation. Null unless status == Complete","$ref":"#/definitions/BuIntradayResponse"}}},"BuIntradayDataGroup":{"type":"object","properties":{"mediaType":{"type":"string","description":"The media type associated with this intraday group","enum":["Voice","Chat","Email","Callback","Message"],"x-genesys-enum-members":[{"name":"Voice"},{"name":"Chat"},{"name":"Email"},{"name":"Callback"},{"name":"Message"}]},"forecastDataSummary":{"description":"Forecast data summary for this date range","$ref":"#/definitions/BuIntradayForecastData"},"forecastDataPerInterval":{"type":"array","description":"Forecast data per interval for this date range","items":{"$ref":"#/definitions/BuIntradayForecastData"}},"scheduleDataSummary":{"description":"Schedule data summary for this date range","$ref":"#/definitions/BuIntradayScheduleData"},"scheduleDataPerInterval":{"type":"array","description":"Schedule data per interval for this date range","items":{"$ref":"#/definitions/BuIntradayScheduleData"}},"performancePredictionDataSummary":{"description":"Performance prediction data summary for this date range","$ref":"#/definitions/IntradayPerformancePredictionData"},"performancePredictionDataPerInterval":{"type":"array","description":"Performance prediction data per interval for this date range","items":{"$ref":"#/definitions/IntradayPerformancePredictionData"}}}},"BuIntradayForecastData":{"type":"object","properties":{"offered":{"type":"number","format":"double","description":"The number of interactions routed into the queues in the selected planning groups for the given media type for an agent to answer"},"averageHandleTimeSeconds":{"type":"number","format":"double","description":"The average handle time in seconds an agent spent handling interactions"}}},"BuIntradayResponse":{"type":"object","properties":{"startDate":{"type":"string","format":"date-time","description":"The start of the date range for which this data applies. This is also the start reference point for the intervals represented in the various arrays. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endDate":{"type":"string","format":"date-time","description":"The end of the date range for which this data applies. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"intervalLengthMinutes":{"type":"integer","format":"int32","description":"The aggregation period in minutes, which determines the interval duration of the returned data"},"noDataReason":{"type":"string","description":"If not null, the reason there was no data for the request","enum":["NoPublishedSchedule","NoSourceForecast"],"x-genesys-enum-members":[{"name":"NoPublishedSchedule"},{"name":"NoSourceForecast"}]},"categories":{"type":"array","description":"The categories to which this data corresponds","items":{"type":"string","enum":["ForecastData","ScheduleData","PerformancePredictionData"],"x-genesys-enum-members":[{"name":"ForecastData"},{"name":"ScheduleData"},{"name":"PerformancePredictionData"}]}},"shortTermForecast":{"description":"Short term forecast reference","$ref":"#/definitions/BuShortTermForecastReference"},"schedule":{"description":"Schedule reference","$ref":"#/definitions/BuScheduleReference"},"intradayDataGroupings":{"type":"array","description":"Intraday data grouped by a single media type and set of planning group IDs","items":{"$ref":"#/definitions/BuIntradayDataGroup"}}}},"BuIntradayScheduleData":{"type":"object","properties":{"onQueueTimeSeconds":{"type":"integer","format":"int64","description":"The total on-queue time in seconds for all agents in this group"}}},"BuShortTermForecastReference":{"type":"object","required":["weekDate"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"weekDate":{"type":"string","format":"date","description":"The weekDate of the short term forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"description":{"type":"string","description":"The description of the short term forecast","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"A pointer to a short term forecast"},"IntradayPerformancePredictionData":{"type":"object","properties":{"serviceLevelPercent":{"type":"number","format":"double","description":"Percentage of interactions that meets service level target as defined in the matching service goal templates"},"averageSpeedOfAnswerSeconds":{"type":"number","format":"double","description":"Predicted average time in seconds it takes to answer an interaction once the interaction becomes available to be routed"},"occupancyPercent":{"type":"number","format":"double","description":"Percentage of on-queue time for all agents in this group that are occupied handling interactions"}}},"IntradayPlanningGroupRequest":{"type":"object","required":["businessUnitDate","categories"],"properties":{"businessUnitDate":{"type":"string","format":"date","description":"Requested date in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"categories":{"type":"array","description":"The metric categories","items":{"type":"string","enum":["ForecastData","ScheduleData","PerformancePredictionData"],"x-genesys-enum-members":[{"name":"ForecastData"},{"name":"ScheduleData"},{"name":"PerformancePredictionData"}]}},"planningGroupIds":{"type":"array","description":"The IDs of the planning groups for which to fetch data. Omitting or passing an empty list will return all available planning groups","items":{"type":"string"}},"intervalLengthMinutes":{"type":"integer","format":"int32","description":"The period/interval in minutes for which to aggregate the data. Required, defaults to 15"}}},"ForecastAbandonRateResponse":{"type":"object","properties":{"percent":{"type":"integer","format":"int32","description":"The target percent abandon rate goal"}}},"ForecastAverageSpeedOfAnswerResponse":{"type":"object","properties":{"seconds":{"type":"integer","format":"int32","description":"the average speed of answer goal in seconds"}}},"ForecastPlanningGroupResponse":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the planning group"},"name":{"type":"string","description":"The name of the planning group"},"routePaths":{"type":"array","description":"Route path configuration for this planning group","items":{"$ref":"#/definitions/RoutePathResponse"}},"serviceGoalTemplate":{"description":"Service goals for this planning group","$ref":"#/definitions/ForecastServiceGoalTemplateResponse"}}},"ForecastServiceGoalTemplateResponse":{"type":"object","properties":{"serviceLevel":{"description":"The service level goal for this forecast","$ref":"#/definitions/ForecastServiceLevelResponse"},"averageSpeedOfAnswer":{"description":"The average speed of answer goal for this forecast","$ref":"#/definitions/ForecastAverageSpeedOfAnswerResponse"},"abandonRate":{"description":"The abandon rate goal for this forecast","$ref":"#/definitions/ForecastAbandonRateResponse"}}},"ForecastServiceLevelResponse":{"type":"object","properties":{"percent":{"type":"integer","format":"int32","description":"The percent of calls to answer in the number of seconds defined"},"seconds":{"type":"integer","format":"int32","description":"The number of seconds to define for the percent of calls to be answered"}}},"WfmIntradayPlanningGroupListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ForecastPlanningGroupResponse"}},"noDataReason":{"type":"string","description":"The reason there was no data for the request","enum":["NoPublishedSchedule","NoSourceForecast"],"x-genesys-enum-members":[{"name":"NoPublishedSchedule"},{"name":"NoSourceForecast"}]}},"description":"A list of IntradayPlanningGroup objects"},"EntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DataTableImportJob"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"pageCount":{"type":"integer","format":"int32"}}},"OAuthAuthorization":{"type":"object","properties":{"client":{"$ref":"#/definitions/OAuthClient"},"scope":{"type":"array","items":{"type":"string"}},"resourceOwner":{"$ref":"#/definitions/DomainEntityRef"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"$ref":"#/definitions/DomainEntityRef"},"modifiedBy":{"$ref":"#/definitions/DomainEntityRef"},"pending":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CallBasic":{"type":"object","properties":{"state":{"type":"string","description":"The connection state of this communication.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","converting","uploading","transmitting","none"],"x-genesys-enum-members":[{"name":"alerting"},{"name":"dialing"},{"name":"contacting"},{"name":"offering"},{"name":"connected"},{"name":"disconnected"},{"name":"terminated"},{"name":"converting"},{"name":"uploading"},{"name":"transmitting"},{"name":"none"}]},"id":{"type":"string","description":"A globally unique identifier for this communication."},"direction":{"type":"string","description":"The direction of the call","enum":["inbound","outbound"],"x-genesys-enum-members":[{"name":"inbound"},{"name":"outbound"}]},"recording":{"type":"boolean","description":"True if this call is being recorded."},"recordingState":{"type":"string","description":"State of recording on this call.","enum":["none","active","paused"],"x-genesys-enum-members":[{"name":"none"},{"name":"active"},{"name":"paused"}]},"muted":{"type":"boolean","description":"True if this call is muted so that remote participants can't hear any audio from this end."},"confined":{"type":"boolean","description":"True if this call is held and the person on this side hears hold music."},"held":{"type":"boolean","description":"True if this call is held and the person on this side hears silence."},"recordingId":{"type":"string","description":"A globally unique identifier for the recording associated with this call."},"segments":{"type":"array","description":"The time line of the participant's call, divided into activity segments.","items":{"$ref":"#/definitions/Segment"}},"errorInfo":{"$ref":"#/definitions/ErrorInfo"},"disconnectType":{"type":"string","description":"System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.","enum":["endpoint","client","system","timeout","transfer","transfer.conference","transfer.consult","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam","uncallable"],"x-genesys-enum-members":[{"name":"endpoint"},{"name":"client"},{"name":"system"},{"name":"timeout"},{"name":"transfer"},{"name":"transfer.conference"},{"name":"transfer.consult"},{"name":"transfer.forward"},{"name":"transfer.noanswer"},{"name":"transfer.notavailable"},{"name":"transport.failure"},{"name":"error"},{"name":"peer"},{"name":"other"},{"name":"spam"},{"name":"uncallable"}]},"startHoldTime":{"type":"string","format":"date-time","description":"The timestamp the call was placed on hold in the cloud clock if the call is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"documentId":{"type":"string","description":"If call is an outbound fax of a document from content management, then this is the id in content management."},"startAlertingTime":{"type":"string","format":"date-time","description":"The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"disconnectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"disconnectReasons":{"type":"array","description":"List of reasons that this call was disconnected. This will be set once the call disconnects.","items":{"$ref":"#/definitions/DisconnectReason"}},"faxStatus":{"description":"Extra information on fax transmission.","$ref":"#/definitions/FaxStatus"},"provider":{"type":"string","description":"The source provider for the call."},"scriptId":{"type":"string","description":"The UUID of the script to use."},"peerId":{"type":"string","description":"The id of the peer communication corresponding to a matching leg for this communication."},"uuiData":{"type":"string","description":"User to User Information (UUI) data managed by SIP session application."},"self":{"description":"Address and name data for a call endpoint.","$ref":"#/definitions/Address"},"other":{"description":"Address and name data for a call endpoint.","$ref":"#/definitions/Address"},"wrapup":{"description":"Call wrap up or disposition data.","$ref":"#/definitions/Wrapup"},"afterCallWork":{"description":"After-call work for the communication.","$ref":"#/definitions/AfterCallWork"},"afterCallWorkRequired":{"type":"boolean","description":"Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested."},"agentAssistantId":{"type":"string","description":"UUID of virtual agent assistant that provide suggestions to the agent participant during the conversation."}}},"CallbackBasic":{"type":"object","properties":{"state":{"type":"string","description":"The connection state of this communication.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","scheduled","none"],"x-genesys-enum-members":[{"name":"alerting"},{"name":"dialing"},{"name":"contacting"},{"name":"offering"},{"name":"connected"},{"name":"disconnected"},{"name":"terminated"},{"name":"scheduled"},{"name":"none"}]},"id":{"type":"string","description":"A globally unique identifier for this communication."},"segments":{"type":"array","description":"The time line of the participant's callback, divided into activity segments.","items":{"$ref":"#/definitions/Segment"}},"direction":{"type":"string","description":"The direction of the call","enum":["inbound","outbound"],"x-genesys-enum-members":[{"name":"inbound"},{"name":"outbound"}]},"held":{"type":"boolean","description":"True if this call is held and the person on this side hears silence."},"disconnectType":{"type":"string","description":"System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.","enum":["endpoint","client","system","timeout","transfer","transfer.conference","transfer.consult","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam","uncallable"],"x-genesys-enum-members":[{"name":"endpoint"},{"name":"client"},{"name":"system"},{"name":"timeout"},{"name":"transfer"},{"name":"transfer.conference"},{"name":"transfer.consult"},{"name":"transfer.forward"},{"name":"transfer.noanswer"},{"name":"transfer.notavailable"},{"name":"transport.failure"},{"name":"error"},{"name":"peer"},{"name":"other"},{"name":"spam"},{"name":"uncallable"}]},"startHoldTime":{"type":"string","format":"date-time","description":"The timestamp the callback was placed on hold in the cloud clock if the callback is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dialerPreview":{"description":"The preview data to be used when this callback is a Preview.","$ref":"#/definitions/DialerPreview"},"voicemail":{"description":"The voicemail data to be used when this callback is an ACD voicemail.","$ref":"#/definitions/Voicemail"},"callbackNumbers":{"type":"array","description":"The phone number(s) to use to place the callback.","items":{"type":"string"}},"callbackUserName":{"type":"string","description":"The name of the user requesting a callback."},"scriptId":{"type":"string","description":"The UUID of the script to use."},"externalCampaign":{"type":"boolean","description":"True if the call for the callback uses external dialing."},"skipEnabled":{"type":"boolean","description":"True if the ability to skip a callback should be enabled."},"timeoutSeconds":{"type":"integer","format":"int32","description":"The number of seconds before the system automatically places a call for a callback. 0 means the automatic placement is disabled."},"startAlertingTime":{"type":"string","format":"date-time","description":"The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"disconnectedTime":{"type":"string","format":"date-time","description":"The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"callbackScheduledTime":{"type":"string","format":"date-time","description":"The timestamp when this communication is scheduled in the provider clock. If this value is missing it indicates the callback will be placed immediately. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"automatedCallbackConfigId":{"type":"string","description":"The id of the config for automatically placing the callback (and handling the disposition). If null, the callback will not be placed automatically but routed to an agent as per normal."},"provider":{"type":"string","description":"The source provider for the callback."},"peerId":{"type":"string","description":"The id of the peer communication corresponding to a matching leg for this communication."},"wrapup":{"description":"Call wrap up or disposition data.","$ref":"#/definitions/Wrapup"},"afterCallWork":{"description":"After-call work for the communication.","$ref":"#/definitions/AfterCallWork"},"afterCallWorkRequired":{"type":"boolean","description":"Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested."}}},"CampaignInteraction":{"type":"object","properties":{"id":{"type":"string"},"campaign":{"$ref":"#/definitions/DomainEntityRef"},"agent":{"$ref":"#/definitions/DomainEntityRef"},"contact":{"$ref":"#/definitions/DomainEntityRef"},"destinationAddress":{"type":"string"},"activePreviewCall":{"type":"boolean","description":"Boolean value if there is an active preview call on the interaction"},"lastActivePreviewWrapupTime":{"type":"string","format":"date-time","description":"The time when the last preview of the interaction was wrapped up. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"creationTime":{"type":"string","format":"date-time","description":"The time when dialer created the interaction. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"callPlacedTime":{"type":"string","format":"date-time","description":"The time when the agent or system places the call. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"callRoutedTime":{"type":"string","format":"date-time","description":"The time when the agent was connected to the call. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"previewConnectedTime":{"type":"string","format":"date-time","description":"The time when the customer and routing participant are connected. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"queue":{"$ref":"#/definitions/DomainEntityRef"},"script":{"$ref":"#/definitions/DomainEntityRef"},"disposition":{"type":"string","description":"Describes what happened with call analysis for instance: disposition.classification.callable.person, disposition.classification.callable.noanswer","enum":["DISCONNECT","LIVE_VOICE","BUSY","MACHINE","NO_ANSWER","SIT_CALLABLE","SIT_UNCALLABLE","FAX"],"x-genesys-enum-members":[{"name":"DISCONNECT"},{"name":"LIVE_VOICE"},{"name":"BUSY"},{"name":"MACHINE"},{"name":"NO_ANSWER"},{"name":"SIT_CALLABLE"},{"name":"SIT_UNCALLABLE"},{"name":"FAX"}]},"callerName":{"type":"string"},"callerAddress":{"type":"string"},"previewPopDeliveredTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversation":{"$ref":"#/definitions/ConversationBasic"},"dialerSystemParticipantId":{"type":"string","description":"conversation participant id that is the dialer system participant to monitor the call from dialer perspective"},"dialingMode":{"type":"string"},"skills":{"type":"array","description":"Any skills that are attached to the call for routing","uniqueItems":true,"items":{"$ref":"#/definitions/DomainEntityRef"}}}},"CampaignInteractions":{"type":"object","properties":{"campaign":{"$ref":"#/definitions/DomainEntityRef"},"pendingInteractions":{"type":"array","items":{"$ref":"#/definitions/CampaignInteraction"}},"proceedingInteractions":{"type":"array","items":{"$ref":"#/definitions/CampaignInteraction"}},"previewingInteractions":{"type":"array","items":{"$ref":"#/definitions/CampaignInteraction"}},"interactingInteractions":{"type":"array","items":{"$ref":"#/definitions/CampaignInteraction"}},"scheduledInteractions":{"type":"array","items":{"$ref":"#/definitions/CampaignInteraction"}}}},"ConversationBasic":{"type":"object","required":["startTime"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"startTime":{"type":"string","format":"date-time","description":"The time when the conversation started. This will be the time when the first participant joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The time when the conversation ended. This will be the time when the last participant left the conversation, or null when the conversation is still active. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"divisions":{"type":"array","description":"Identifiers of divisions associated with this conversation","items":{"$ref":"#/definitions/ConversationDivisionMembership"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"participants":{"type":"array","readOnly":true,"items":{"$ref":"#/definitions/ParticipantBasic"}}}},"ParticipantBasic":{"type":"object","properties":{"id":{"type":"string","description":"A globally unique identifier for this conversation."},"startTime":{"type":"string","format":"date-time","description":"The timestamp when this participant joined the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The timestamp when this participant disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The timestamp when this participant was connected to the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"name":{"type":"string","description":"A human readable name identifying the participant."},"userUri":{"type":"string","description":"If this participant represents a user, then this will be an URI that can be used to fetch the user."},"userId":{"type":"string","description":"If this participant represents a user, then this will be the globally unique identifier for the user."},"externalContactId":{"type":"string","description":"If this participant represents an external contact, then this will be the globally unique identifier for the external contact."},"externalOrganizationId":{"type":"string","description":"If this participant represents an external org, then this will be the globally unique identifier for the external org."},"queueId":{"type":"string","description":"If present, the queue id that the communication channel came in on."},"groupId":{"type":"string","description":"If present, group of users the participant represents."},"teamId":{"type":"string","description":"The team id that this participant is a member of when added to the conversation."},"queueName":{"type":"string","description":"If present, the queue name that the communication channel came in on."},"purpose":{"type":"string","description":"A well known string that specifies the purpose of this participant."},"participantType":{"type":"string","description":"A well known string that specifies the type of this participant."},"consultParticipantId":{"type":"string","description":"If this participant is part of a consult transfer, then this will be the participant id of the participant being transferred."},"address":{"type":"string","description":"The address for the this participant. For a phone call this will be the ANI."},"ani":{"type":"string","description":"The address for the this participant. For a phone call this will be the ANI."},"aniName":{"type":"string","description":"The ani-based name for this participant."},"dnis":{"type":"string","description":"The address for the this participant. For a phone call this will be the ANI."},"locale":{"type":"string","description":"An ISO 639 language code specifying the locale for this participant"},"wrapupRequired":{"type":"boolean","description":"True iff this participant is required to enter wrapup for this conversation."},"wrapupPrompt":{"type":"string","description":"This field controls how the UI prompts the agent for a wrapup.","enum":["mandatory","optional","agentRequested","timeout","forcedTimeout"],"x-genesys-enum-members":[{"name":"mandatory"},{"name":"optional"},{"name":"agentRequested"},{"name":"timeout"},{"name":"forcedTimeout"}]},"wrapupTimeoutMs":{"type":"integer","format":"int32","description":"Specifies how long a timed ACW session will last."},"wrapupSkipped":{"type":"boolean","description":"The UI sets this field when the agent chooses to skip entering a wrapup for this participant."},"wrapup":{"description":"Call wrap up or disposition data.","$ref":"#/definitions/Wrapup"},"conversationRoutingData":{"description":"Information on how a communication should be routed to an agent.","$ref":"#/definitions/ConversationRoutingData"},"alertingTimeoutMs":{"type":"integer","format":"int32","description":"Specifies how long the agent has to answer an interaction before being marked as not responding."},"monitoredParticipantId":{"type":"string","description":"If this participant is a monitor, then this will be the id of the participant that is being monitored."},"coachedParticipantId":{"type":"string","description":"If this participant is a coach, then this will be the id of the participant that is being coached."},"attributes":{"type":"object","description":"Additional participant attributes","additionalProperties":{"type":"string"}},"calls":{"type":"array","items":{"$ref":"#/definitions/CallBasic"}},"callbacks":{"type":"array","items":{"$ref":"#/definitions/CallbackBasic"}},"chats":{"type":"array","items":{"$ref":"#/definitions/ConversationChat"}},"cobrowsesessions":{"type":"array","items":{"$ref":"#/definitions/Cobrowsesession"}},"emails":{"type":"array","items":{"$ref":"#/definitions/Email"}},"messages":{"type":"array","items":{"$ref":"#/definitions/Message"}},"screenshares":{"type":"array","items":{"$ref":"#/definitions/Screenshare"}},"socialExpressions":{"type":"array","items":{"$ref":"#/definitions/SocialExpression"}},"videos":{"type":"array","items":{"$ref":"#/definitions/Video"}},"evaluations":{"type":"array","items":{"$ref":"#/definitions/Evaluation"}},"screenRecordingState":{"type":"string","description":"The current screen recording state for this participant.","enum":["requested","active","paused","stopped","error","timeout"],"x-genesys-enum-members":[{"name":"requested"},{"name":"active"},{"name":"paused"},{"name":"stopped"},{"name":"error"},{"name":"timeout"}]},"flaggedReason":{"type":"string","description":"The reason specifying why participant flagged the conversation.","enum":["general"],"x-genesys-enum-members":[{"name":"general"}]},"startAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"DncListDivisionView":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"importStatus":{"description":"The status of the import process.","readOnly":true,"$ref":"#/definitions/ImportStatus"},"size":{"type":"integer","format":"int64","description":"The number of contacts in the ContactList.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DncListDivisionViewListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DncListDivisionView"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Extension":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"number":{"type":"string"},"owner":{"description":"A Uri reference to the owner of this extension, which is either a User or an IVR","$ref":"#/definitions/DomainEntityRef"},"extensionPool":{"$ref":"#/definitions/DomainEntityRef"},"ownerType":{"type":"string","enum":["USER","PHONE","IVR_CONFIG","GROUP"],"x-genesys-enum-members":[{"name":"USER"},{"name":"PHONE"},{"name":"IVR_CONFIG"},{"name":"GROUP"}]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ExtensionEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Extension"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CoachingAnnotation":{"type":"object","required":["text"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"createdBy":{"description":"The user who created the annotation.","readOnly":true,"$ref":"#/definitions/UserReference"},"dateCreated":{"type":"string","format":"date-time","description":"The date/time the annotation was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedBy":{"description":"The last user to modify the annotation.","readOnly":true,"$ref":"#/definitions/UserReference"},"dateModified":{"type":"string","format":"date-time","description":"The date/time the annotation was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"text":{"type":"string","description":"The text of the annotation."},"isDeleted":{"type":"boolean","description":"Flag indicating whether the annotation is deleted.","readOnly":true},"accessType":{"type":"string","description":"Determines the permissions required to view this item.","readOnly":true,"enum":["Public","Private"],"x-genesys-enum-members":[{"name":"Public"},{"name":"Private"}]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FacebookIntegration":{"type":"object","required":["appId","id","name","version"],"properties":{"id":{"type":"string","description":"A unique Integration Id.","readOnly":true},"name":{"type":"string","description":"The name of the Facebook Integration"},"appId":{"type":"string","description":"The App Id from Facebook messenger"},"pageId":{"type":"string","description":"The Page Id from Facebook messenger"},"status":{"type":"string","description":"The status of the Facebook Integration"},"recipient":{"description":"The recipient reference associated to the Facebook Integration. This recipient is used to associate a flow to an integration","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"dateCreated":{"type":"string","format":"date-time","description":"Date this Integration was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date this Integration was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"description":"User reference that created this Integration","$ref":"#/definitions/DomainEntityRef"},"modifiedBy":{"description":"User reference that last modified this Integration","$ref":"#/definitions/DomainEntityRef"},"version":{"type":"integer","format":"int32","description":"Version number required for updates."},"createStatus":{"type":"string","description":"Status of asynchronous create operation","readOnly":true,"enum":["Initiated","Completed","Error"],"x-genesys-enum-members":[{"name":"Initiated","description":"The integration create request has started"},{"name":"Completed","description":"The integration create request has finished successfully"},{"name":"Error","description":"The integration create request has finished in error."}]},"createError":{"description":"Error information returned, if createStatus is set to Error","readOnly":true,"$ref":"#/definitions/ErrorBody"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FacebookIntegrationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/FacebookIntegration"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FacebookIntegrationRequest":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the Facebook Integration"},"pageAccessToken":{"type":"string","description":"The long-lived Page Access Token of a facebook page. \nSee https://developers.facebook.com/docs/facebook-login/access-tokens. \nWhen a pageAccessToken is provided, pageId and userAccessToken are not required."},"userAccessToken":{"type":"string","description":"The short-lived User Access Token of the facebook user logged into the facebook app. \nSee https://developers.facebook.com/docs/facebook-login/access-tokens. \nWhen userAccessToken is provided, pageId is mandatory. \nWhen userAccessToken/pageId combination is provided, pageAccessToken is not required."},"pageId":{"type":"string","description":"The page Id of a facebook page. The pageId is required when userAccessToken is provided."},"appId":{"type":"string","description":"The app Id of a facebook app. The appId is required when a customer wants to use their own approved facebook app."},"appSecret":{"type":"string","description":"The app Secret of a facebook app. The appSecret is required when appId is provided."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GDPRRequest":{"type":"object","required":["createdBy","createdDate","requestType","status","subject"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"createdBy":{"description":"The user that created this request","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"replacementTerms":{"type":"array","example":"[ { \"type\": \"EMAIL\": \"existingValue\": \"personal.email@domain.com\", \"updatedValue\": \"updated.personal.email@domain.com\" } ]","description":"The replacement terms for the provided search terms, in the case of a GDPR_UPDATE request","items":{"$ref":"#/definitions/ReplacementTerm"}},"requestType":{"type":"string","description":"The type of GDPR request","enum":["GDPR_EXPORT","GDPR_UPDATE","GDPR_DELETE"],"x-genesys-enum-members":[{"name":"GDPR_EXPORT"},{"name":"GDPR_UPDATE"},{"name":"GDPR_DELETE"}]},"createdDate":{"type":"string","format":"date-time","description":"When the request was submitted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"status":{"type":"string","description":"The status of the request","readOnly":true,"enum":["INITIATED","SEARCHING","UPDATING","DELETING","COMPLETED","ERROR","FINALIZING"],"x-genesys-enum-members":[{"name":"INITIATED"},{"name":"SEARCHING"},{"name":"UPDATING"},{"name":"DELETING"},{"name":"COMPLETED"},{"name":"ERROR"},{"name":"FINALIZING"}]},"subject":{"example":"{ \"emailAddresses\": [\"personal.email@domain.com\"], \"phoneNumbers\": [\"+13115552368\"] }","description":"The subject of the GDPR request","$ref":"#/definitions/GDPRSubject"},"resultsUrl":{"type":"string","description":"The location where the results of the request can be retrieved","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GDPRRequestEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/GDPRRequest"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ReplacementTerm":{"type":"object","properties":{"type":{"type":"string","enum":["NAME","ADDRESS","PHONE","EMAIL","TWITTER"],"x-genesys-enum-members":[{"name":"NAME"},{"name":"ADDRESS"},{"name":"PHONE"},{"name":"EMAIL"},{"name":"TWITTER"}]},"existingValue":{"type":"string"},"updatedValue":{"type":"string"}}},"GroupProfile":{"type":"object","required":["version"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"state":{"type":"string","description":"The state of the user resource","enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"dateModified":{"type":"string","format":"date-time","description":"Datetime of the last modification. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int64","description":"The version of the group resource"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ExtensionPool":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"startNumber":{"type":"string","description":"The starting phone number for the range of this Extension pool. Must be in E.164 format"},"endNumber":{"type":"string","description":"The ending phone number for the range of this Extension pool. Must be in E.164 format"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CreateUser":{"type":"object","required":["divisionId","email","name","password"],"properties":{"name":{"type":"string","description":"User's full name"},"department":{"type":"string"},"email":{"type":"string","description":"User's email and username"},"addresses":{"type":"array","description":"Email addresses and phone numbers for this user","items":{"$ref":"#/definitions/Contact"}},"title":{"type":"string"},"password":{"type":"string","description":"User's password"},"divisionId":{"type":"string","description":"The division to which this user will belong"},"state":{"type":"string","description":"Optional initialized state of the user. If not specified, state will be Active if invites are sent, otherwise Inactive.","enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]}}},"CursorContactListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ExternalContact"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"NoteListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Note"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"TwitterIntegration":{"type":"object","required":["accessTokenKey","consumerKey","id","name","tier","version"],"properties":{"id":{"type":"string","description":"A unique Integration Id","readOnly":true},"name":{"type":"string","description":"The name of the Twitter Integration"},"accessTokenKey":{"type":"string","description":"The Access Token Key from Twitter messenger"},"consumerKey":{"type":"string","description":"The Consumer Key from Twitter messenger"},"username":{"type":"string","description":"The Username from Twitter"},"userId":{"type":"string","description":"The UserId from Twitter"},"status":{"type":"string","description":"The status of the Twitter Integration"},"tier":{"type":"string","description":"The type of twitter account to be used for the integration","enum":["premium","enterprise"]},"envName":{"type":"string","description":"The Twitter environment name, e.g.: env-beta (required for premium tier)"},"recipient":{"description":"The recipient associated to the Twitter Integration. This recipient is used to associate a flow to an integration","readOnly":true,"$ref":"#/definitions/DomainEntityRef"},"dateCreated":{"type":"string","format":"date-time","description":"Date this Integration was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date this Integration was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdBy":{"description":"User reference that created this Integration","$ref":"#/definitions/DomainEntityRef"},"modifiedBy":{"description":"User reference that last modified this Integration","$ref":"#/definitions/DomainEntityRef"},"version":{"type":"integer","format":"int32","description":"Version number required for updates."},"createStatus":{"type":"string","description":"Status of asynchronous create operation","readOnly":true,"enum":["Initiated","Completed","Error"],"x-genesys-enum-members":[{"name":"Initiated","description":"The integration create request has started"},{"name":"Completed","description":"The integration create request has finished successfully"},{"name":"Error","description":"The integration create request has finished in error."}]},"createError":{"description":"Error information returned, if createStatus is set to Error","readOnly":true,"$ref":"#/definitions/ErrorBody"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TwitterIntegrationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/TwitterIntegration"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"TwitterIntegrationRequest":{"type":"object","required":["accessTokenKey","accessTokenSecret","consumerKey","consumerSecret","name","tier"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the Twitter Integration"},"accessTokenKey":{"type":"string","description":"The Access Token Key from Twitter messenger"},"accessTokenSecret":{"type":"string","description":"The Access Token Secret from Twitter messenger"},"consumerKey":{"type":"string","description":"The Consumer Key from Twitter messenger"},"consumerSecret":{"type":"string","description":"The Consumer Secret from Twitter messenger"},"tier":{"type":"string","description":"The type of twitter account to be used for the integration","enum":["premium","enterprise"]},"envName":{"type":"string","description":"The Twitter environment name, e.g.: env-beta (required for premium tier)"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LineBaseEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/LineBase"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CobrowseConversation":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"participants":{"type":"array","description":"The list of participants involved in the conversation.","items":{"$ref":"#/definitions/CobrowseMediaParticipant"}},"otherMediaUris":{"type":"array","description":"The list of other media channels involved in the conversation.","items":{"type":"string","format":"uri"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CobrowseConversationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CobrowseConversation"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CobrowseMediaParticipant":{"type":"object","properties":{"id":{"type":"string","description":"The unique participant ID."},"name":{"type":"string","description":"The display friendly name of the participant."},"address":{"type":"string","description":"The participant address."},"startTime":{"type":"string","format":"date-time","description":"The time when this participant first joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"connectedTime":{"type":"string","format":"date-time","description":"The time when this participant went connected for this media (eg: video connected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"startHoldTime":{"type":"string","format":"date-time","description":"The time when this participant's hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"purpose":{"type":"string","description":"The participant's purpose. Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr"},"state":{"type":"string","description":"The participant's state. Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","converting","uploading","transmitting","none"],"x-genesys-enum-members":[{"name":"alerting"},{"name":"dialing"},{"name":"contacting"},{"name":"offering"},{"name":"connected"},{"name":"disconnected"},{"name":"terminated"},{"name":"converting"},{"name":"uploading"},{"name":"transmitting"},{"name":"none"}]},"direction":{"type":"string","description":"The participant's direction. Values can be: 'inbound' or 'outbound'","enum":["inbound","outbound"],"x-genesys-enum-members":[{"name":"inbound"},{"name":"outbound"}]},"disconnectType":{"type":"string","description":"The reason the participant was disconnected from the conversation.","enum":["endpoint","client","system","transfer","transfer.conference","transfer.consult","transfer.forward","transfer.noanswer","transfer.notavailable","transport.failure","error","peer","other","spam"],"x-genesys-enum-members":[{"name":"endpoint"},{"name":"client"},{"name":"system"},{"name":"transfer"},{"name":"transfer.conference"},{"name":"transfer.consult"},{"name":"transfer.forward"},{"name":"transfer.noanswer"},{"name":"transfer.notavailable"},{"name":"transport.failure"},{"name":"error"},{"name":"peer"},{"name":"other"},{"name":"spam"}]},"held":{"type":"boolean","description":"Value is true when the participant is on hold."},"wrapupRequired":{"type":"boolean","description":"Value is true when the participant requires wrap-up."},"wrapupPrompt":{"type":"string","description":"The wrap-up prompt indicating the type of wrap-up to be performed."},"user":{"description":"The PureCloud user for this participant.","$ref":"#/definitions/DomainEntityRef"},"queue":{"description":"The PureCloud queue for this participant.","$ref":"#/definitions/DomainEntityRef"},"team":{"description":"The PureCloud team for this participant.","$ref":"#/definitions/DomainEntityRef"},"attributes":{"type":"object","description":"A list of ad-hoc attributes for the participant.","additionalProperties":{"type":"string"}},"errorInfo":{"description":"If the conversation ends in error, contains additional error details.","$ref":"#/definitions/ErrorInfo"},"script":{"description":"The Engage script that should be used by this participant.","$ref":"#/definitions/DomainEntityRef"},"wrapupTimeoutMs":{"type":"integer","format":"int32","description":"The amount of time the participant has to complete wrap-up."},"wrapupSkipped":{"type":"boolean","description":"Value is true when the participant has skipped wrap-up."},"alertingTimeoutMs":{"type":"integer","format":"int32","description":"Specifies how long the agent has to answer an interaction before being marked as not responding."},"provider":{"type":"string","description":"The source provider for the communication."},"externalContact":{"description":"If this participant represents an external contact, then this will be the reference for the external contact.","$ref":"#/definitions/DomainEntityRef"},"externalOrganization":{"description":"If this participant represents an external org, then this will be the reference for the external org.","$ref":"#/definitions/DomainEntityRef"},"wrapup":{"description":"Wrapup for this participant, if it has been applied.","$ref":"#/definitions/Wrapup"},"peer":{"type":"string","description":"The peer communication corresponding to a matching leg for this communication."},"flaggedReason":{"type":"string","description":"The reason specifying why participant flagged the conversation.","enum":["general"],"x-genesys-enum-members":[{"name":"general"}]},"journeyContext":{"description":"Journey System data/context that is applicable to this communication. When used for historical purposes, the context should be immutable. When null, there is no applicable Journey System context.","$ref":"#/definitions/JourneyContext"},"conversationRoutingData":{"description":"Information on how a communication should be routed to an agent.","$ref":"#/definitions/ConversationRoutingData"},"startAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endAcwTime":{"type":"string","format":"date-time","description":"The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"cobrowseSessionId":{"type":"string","description":"The co-browse session ID."},"cobrowseRole":{"type":"string","description":"This value identifies the role of the co-browse client within the co-browse session (a client is a sharer or a viewer)."},"controlling":{"type":"array","description":"ID of co-browse participants for which this client has been granted control (list is empty if this client cannot control any shared pages).","items":{"type":"string"}},"viewerUrl":{"type":"string","description":"The URL that can be used to open co-browse session in web browser."},"providerEventTime":{"type":"string","format":"date-time","description":"The time when the provider event which triggered this conversation update happened in the corrected provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"AgentActivity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"agent":{"$ref":"#/definitions/User"},"numEvaluations":{"type":"integer","format":"int32"},"averageEvaluationScore":{"type":"integer","format":"int32"},"numCriticalEvaluations":{"type":"integer","format":"int32"},"averageCriticalScore":{"type":"number","format":"float"},"highestEvaluationScore":{"type":"number","format":"float"},"lowestEvaluationScore":{"type":"number","format":"float"},"highestCriticalScore":{"type":"number","format":"float"},"lowestCriticalScore":{"type":"number","format":"float"},"agentEvaluatorActivityList":{"type":"array","items":{"$ref":"#/definitions/AgentEvaluatorActivity"}},"numEvaluationsWithoutViewPermission":{"type":"integer","format":"int32"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AgentActivityEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AgentActivity"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AgentEvaluatorActivity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"agent":{"$ref":"#/definitions/User"},"evaluator":{"$ref":"#/definitions/User"},"numEvaluations":{"type":"integer","format":"int32"},"averageEvaluationScore":{"type":"integer","format":"int32"},"numEvaluationsWithoutViewPermission":{"type":"integer","format":"int32"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DomainEdgeSoftwareVersionDtoEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DomainEdgeSoftwareVersionDto"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FlowDiagnosticInfo":{"type":"object","properties":{"lastActionId":{"type":"integer","format":"int32","description":"The step number of the survey invite flow where the error occurred."}}},"Survey":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"conversation":{"$ref":"#/definitions/Conversation"},"surveyForm":{"description":"Survey form used for this survey.","$ref":"#/definitions/SurveyForm"},"agent":{"$ref":"#/definitions/DomainEntityRef"},"status":{"type":"string","enum":["Pending","Sent","InProgress","Finished","OptOut","Error","Expired"],"x-genesys-enum-members":[{"name":"Pending"},{"name":"Sent"},{"name":"InProgress"},{"name":"Finished"},{"name":"OptOut"},{"name":"Error"},{"name":"Expired"}]},"queue":{"$ref":"#/definitions/QueueReference"},"answers":{"$ref":"#/definitions/SurveyScoringSet"},"completedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"surveyErrorDetails":{"description":"Additional information about what happened when the survey is in Error status.","$ref":"#/definitions/SurveyErrorDetails"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SurveyErrorDetails":{"type":"object","properties":{"flowDiagnosticInfo":{"description":"Additional information about any errors that occurred in the survey invite flow.","$ref":"#/definitions/FlowDiagnosticInfo"},"surveyErrorReason":{"type":"string","description":"An error code indicating the reason for the survey failure."}}},"UserLicenses":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"licenses":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"UserLicensesEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UserLicenses"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"pageCount":{"type":"integer","format":"int32"}}},"ExportScriptResponse":{"type":"object","properties":{"url":{"type":"string"}}},"ExportScriptRequest":{"type":"object","properties":{"fileName":{"type":"string","description":"The final file name (no extension) of the script download: .script"},"versionId":{"type":"string","description":"The UUID version of the script to be exported. Defaults to the current editable version."}},"description":"Creating an exported script via Download Service"},"EdgeServiceStateRequest":{"type":"object","required":["inService"],"properties":{"inService":{"type":"boolean","description":"A boolean that sets the Edge in-service or out-of-service."},"callDrainingWaitTimeSeconds":{"type":"integer","format":"int32","description":"The number of seconds to wait for call draining to complete before initiating the reboot. A value of 0 will prevent call draining and all calls will disconnect immediately."}}},"CallableTime":{"type":"object","required":["timeSlots","timeZoneId"],"properties":{"timeSlots":{"type":"array","description":"The time intervals for which it is acceptable to place outbound calls.","items":{"$ref":"#/definitions/CampaignTimeSlot"}},"timeZoneId":{"type":"string","example":"Africa/Abidjan","description":"The time zone for the time slots; for example, Africa/Abidjan"}}},"CallableTimeSet":{"type":"object","required":["callableTimes","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the CallableTimeSet."},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"callableTimes":{"type":"array","description":"The list of CallableTimes for which it is acceptable to place outbound calls.","items":{"$ref":"#/definitions/CallableTime"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CampaignTimeSlot":{"type":"object","required":["day","startTime","stopTime"],"properties":{"startTime":{"type":"string","example":"08:00:00","description":"The start time of the interval as an ISO-8601 string, i.e. HH:mm:ss"},"stopTime":{"type":"string","example":"08:00:00","description":"The end time of the interval as an ISO-8601 string, i.e. HH:mm:ss"},"day":{"type":"integer","format":"int32","example":1,"description":"The day of the interval. Valid values: [1-7], representing Monday through Sunday"}}},"CallableTimeSetEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CallableTimeSet"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DependencyTypeEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DependencyType"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DataSchemaListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/DataSchema"}},"selfUri":{"type":"string","format":"uri"}}},"NluDomainVersionListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/NluDomainVersion"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Relationship":{"type":"object","required":["externalOrganization","relationship","user"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"user":{"description":"The user associated with the external organization","$ref":"#/definitions/User"},"externalOrganization":{"description":"The external organization this relationship is attached to","$ref":"#/definitions/ExternalOrganization"},"relationship":{"type":"string","description":"The relationship or role of the user to this external organization.Examples: Account Manager, Sales Engineer, Implementation Consultant"},"externalDataSources":{"type":"array","description":"Links to the sources of data (e.g. one source might be a CRM) that contributed data to this record. Read-only, and only populated when requested via expand param.","readOnly":true,"items":{"$ref":"#/definitions/ExternalDataSource"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OrgWhitelistSettings":{"type":"object","properties":{"enableWhitelist":{"type":"boolean"},"domainWhitelist":{"type":"array","items":{"type":"string"}}}},"Library":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The library name."},"version":{"type":"integer","format":"int32","description":"Current version for this resource.","readOnly":true},"createdBy":{"description":"User that created the library.","readOnly":true,"$ref":"#/definitions/User"},"dateCreated":{"type":"string","format":"date-time","description":"The date and time the response was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"responseType":{"type":"string","description":"This value is deprecated. Responses representing message templates may be added to any library.","enum":["MessagingTemplate","CampaignSmsTemplate"],"x-genesys-enum-members":[{"name":"MessagingTemplate","description":"Use MessagingTemplate to provide channel specific template. WhatsApp messaging template is supported currently"},{"name":"CampaignSmsTemplate","description":"Use CampaignSmsTemplate to create canned responses specific to sms campaigns. Only text/plain content type is allowed"}]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"LibraryEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Library"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FaxSendResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"uploadDestinationUri":{"type":"string","format":"uri"},"uploadMethodType":{"type":"string","enum":["SINGLE_PUT","MULTIPART_POST"],"x-genesys-enum-members":[{"name":"SINGLE_PUT"},{"name":"MULTIPART_POST"}]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CoverSheet":{"type":"object","properties":{"notes":{"type":"string","description":"Text to be added to the coversheet"},"locale":{"type":"string","description":"Locale, e.g. = en-US"}}},"FaxSendRequest":{"type":"object","required":["addresses"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"addresses":{"type":"array","description":"A list of outbound fax dialing addresses. E.g. +13175555555 or 3175555555","items":{"type":"string"}},"documentId":{"type":"string","description":"DocumentId of Content Management artifact. If Content Management document is not used for faxing, documentId should be null"},"contentType":{"type":"string","description":"The content type that is going to be uploaded. If Content Management document is used for faxing, contentType will be ignored","enum":["application/pdf","image/tiff","application/msword","application/vnd.oasis.opendocument.text","application/vnd.openxmlformats-officedocument.wordprocessingml.document"]},"workspace":{"description":"Workspace in which the document should be stored. If Content Management document is used for faxing, workspace will be ignored","$ref":"#/definitions/Workspace"},"coverSheet":{"description":"Data for coversheet generation.","$ref":"#/definitions/CoverSheet"},"timeZoneOffsetMinutes":{"type":"integer","format":"int32","description":"Time zone offset minutes from GMT"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"FacebookIntegrationUpdateRequest":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the Facebook Integration"},"pageAccessToken":{"type":"string","description":"The long-lived Page Access Token of a facebook page. \nSee https://developers.facebook.com/docs/facebook-login/access-tokens. \nEither pageAccessToken or userAccessToken should be provided."},"userAccessToken":{"type":"string","description":"The short-lived User Access Token of the facebook user logged into the facebook app. \nSee https://developers.facebook.com/docs/facebook-login/access-tokens. \nEither pageAccessToken or userAccessToken should be provided."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"VendorConnectionRequest":{"type":"object","required":["name","publisher","type"],"properties":{"publisher":{"type":"string","description":"Publisher of the integration or connector who registered the new connection. Typically, inin."},"type":{"type":"string","description":"Integration or connector type that registered the new connection. Example, wfm-rta-integration"},"name":{"type":"string","description":"Name of the integration or connector instance that registered the new connection. Example, my-wfm"}}},"ResponseEntityList":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Response"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}},"description":"Query result list"},"ResponseQueryResults":{"type":"object","required":["results"],"properties":{"results":{"description":"Contains the query results","$ref":"#/definitions/ResponseEntityList"}},"description":"Used to return response query results"},"ResponseFilter":{"type":"object","required":["name","operator","values"],"properties":{"name":{"type":"string","description":"Field to filter on. Allowed values are 'name' and 'libraryId."},"operator":{"type":"string","description":"Filter operation: IN, EQUALS, NOTEQUALS.","enum":["IN","EQUALS","NOTEQUALS"],"x-genesys-enum-members":[{"name":"IN"},{"name":"EQUALS"},{"name":"NOTEQUALS"}]},"values":{"type":"array","description":"Values to filter on.","items":{"type":"string"}}},"description":"Used to filter response queries"},"ResponseQueryRequest":{"type":"object","properties":{"queryPhrase":{"type":"string","description":"Query phrase to search response text and name. If not set will match all."},"pageSize":{"type":"integer","format":"int32","description":"The maximum number of hits to return. Default: 25, Maximum: 500."},"filters":{"type":"array","description":"Filter the query results.","items":{"$ref":"#/definitions/ResponseFilter"}}},"description":"Used to query for responses"},"ConversationUser":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The globally unique identifier for this user."}}},"SubjectDivisionGrants":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"divisions":{"type":"array","items":{"$ref":"#/definitions/Division"}},"type":{"type":"string","enum":["PC_USER","PC_GROUP","PC_OAUTH_CLIENT","PC_TRUSTEE_USER","PC_TRUSTEE_GROUP","UNKNOWN"],"x-genesys-enum-members":[{"name":"PC_USER"},{"name":"PC_GROUP"},{"name":"PC_OAUTH_CLIENT"},{"name":"PC_TRUSTEE_USER"},{"name":"PC_TRUSTEE_GROUP"},{"name":"UNKNOWN"}]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SubjectDivisionGrantsEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SubjectDivisionGrants"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EvaluationFormAndScoringSet":{"type":"object","properties":{"evaluationForm":{"$ref":"#/definitions/EvaluationForm"},"answers":{"$ref":"#/definitions/EvaluationScoringSet"}}},"AsyncConversationQuery":{"type":"object","required":["interval"],"properties":{"conversationFilters":{"type":"array","description":"Filters that target conversation-level data","items":{"$ref":"#/definitions/ConversationDetailQueryFilter"}},"segmentFilters":{"type":"array","description":"Filters that target individual segments within a conversation","items":{"$ref":"#/definitions/SegmentDetailQueryFilter"}},"evaluationFilters":{"type":"array","description":"Filters that target evaluations","items":{"$ref":"#/definitions/EvaluationDetailQueryFilter"}},"mediaEndpointStatFilters":{"type":"array","description":"Filters that target mediaEndpointStats","items":{"$ref":"#/definitions/MediaEndpointStatDetailQueryFilter"}},"surveyFilters":{"type":"array","description":"Filters that target surveys","items":{"$ref":"#/definitions/SurveyDetailQueryFilter"}},"resolutionFilters":{"type":"array","description":"Filters that target resolutions","items":{"$ref":"#/definitions/ResolutionDetailQueryFilter"}},"order":{"type":"string","description":"Sort the result set in ascending/descending order. Default is ascending","enum":["asc","desc"],"x-genesys-enum-members":[{"name":"asc"},{"name":"desc"}]},"orderBy":{"type":"string","description":"Specify which data element within the result set to use for sorting. The options to use as a basis for sorting the results: conversationStart, segmentStart, and segmentEnd. If not specified, the default is conversationStart","enum":["conversationStart","conversationEnd","segmentStart","segmentEnd"],"x-genesys-enum-members":[{"name":"conversationStart"},{"name":"conversationEnd"},{"name":"segmentStart"},{"name":"segmentEnd"}]},"interval":{"type":"string","description":"Specifies the date and time range of data being queried. Results will include all conversations that had activity during the interval. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"limit":{"type":"integer","format":"int32","description":"Specify number of results to be returned"},"startOfDayIntervalMatching":{"type":"boolean","description":"Add a filter to only include conversations that started after the beginning of the interval start date (UTC)"}}},"ConversationDetailQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/ConversationDetailQueryPredicate"}}}},"ConversationDetailQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/ConversationDetailQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/ConversationDetailQueryPredicate"}}}},"ConversationDetailQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"],"x-genesys-enum-members":[{"name":"dimension"},{"name":"property"},{"name":"metric"}]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["conversationEnd","conversationId","conversationStart","divisionId","mediaStatsMinConversationMos","originatingDirection"],"x-genesys-enum-members":[{"name":"conversationEnd"},{"name":"conversationId"},{"name":"conversationStart"},{"name":"divisionId"},{"name":"mediaStatsMinConversationMos"},{"name":"originatingDirection"}]},"metric":{"type":"string","description":"Left hand side for metric predicates","enum":["nBlindTransferred","nCobrowseSessions","nConnected","nConsult","nConsultTransferred","nError","nFlow","nFlowMilestone","nFlowOutcome","nFlowOutcomeFailed","nOffered","nOutbound","nOutboundAbandoned","nOutboundAttempted","nOutboundConnected","nOverSla","nStateTransitionError","nTransferred","oExternalMediaCount","oFlowMilestone","oMediaCount","tAbandon","tAcd","tAcw","tAgentResponseTime","tAlert","tAnswered","tCallback","tCallbackComplete","tContacting","tConversationDuration","tDialing","tFlow","tFlowDisconnect","tFlowExit","tFlowOut","tFlowOutcome","tHandle","tHeld","tHeldComplete","tIvr","tMonitoring","tNotResponding","tShortAbandon","tTalk","tTalkComplete","tUserResponseTime","tVoicemail"],"x-genesys-enum-members":[{"name":"nBlindTransferred"},{"name":"nCobrowseSessions"},{"name":"nConnected"},{"name":"nConsult"},{"name":"nConsultTransferred"},{"name":"nError"},{"name":"nFlow"},{"name":"nFlowMilestone"},{"name":"nFlowOutcome"},{"name":"nFlowOutcomeFailed"},{"name":"nOffered"},{"name":"nOutbound"},{"name":"nOutboundAbandoned"},{"name":"nOutboundAttempted"},{"name":"nOutboundConnected"},{"name":"nOverSla"},{"name":"nStateTransitionError"},{"name":"nTransferred"},{"name":"oExternalMediaCount"},{"name":"oFlowMilestone"},{"name":"oMediaCount"},{"name":"tAbandon"},{"name":"tAcd"},{"name":"tAcw"},{"name":"tAgentResponseTime"},{"name":"tAlert"},{"name":"tAnswered"},{"name":"tCallback"},{"name":"tCallbackComplete"},{"name":"tContacting"},{"name":"tConversationDuration"},{"name":"tDialing"},{"name":"tFlow"},{"name":"tFlowDisconnect"},{"name":"tFlowExit"},{"name":"tFlowOut"},{"name":"tFlowOutcome"},{"name":"tHandle"},{"name":"tHeld"},{"name":"tHeldComplete"},{"name":"tIvr"},{"name":"tMonitoring"},{"name":"tNotResponding"},{"name":"tShortAbandon"},{"name":"tTalk"},{"name":"tTalkComplete"},{"name":"tUserResponseTime"},{"name":"tVoicemail"}]},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"],"x-genesys-enum-members":[{"name":"matches"},{"name":"exists"},{"name":"notExists"}]},"value":{"type":"string","description":"Right hand side for dimension or metric predicates"},"range":{"description":"Right hand side for dimension or metric predicates","$ref":"#/definitions/NumericRange"}}},"EvaluationDetailQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/EvaluationDetailQueryPredicate"}}}},"EvaluationDetailQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/EvaluationDetailQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/EvaluationDetailQueryPredicate"}}}},"EvaluationDetailQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"],"x-genesys-enum-members":[{"name":"dimension"},{"name":"property"},{"name":"metric"}]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["calibrationId","contextId","deleted","evaluationId","evaluatorId","eventTime","formId","formName","queueId","rescored","userId"],"x-genesys-enum-members":[{"name":"calibrationId"},{"name":"contextId"},{"name":"deleted"},{"name":"evaluationId"},{"name":"evaluatorId"},{"name":"eventTime"},{"name":"formId"},{"name":"formName"},{"name":"queueId"},{"name":"rescored"},{"name":"userId"}]},"metric":{"type":"string","description":"Left hand side for metric predicates","enum":["oTotalCriticalScore","oTotalScore"],"x-genesys-enum-members":[{"name":"oTotalCriticalScore"},{"name":"oTotalScore"}]},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"],"x-genesys-enum-members":[{"name":"matches"},{"name":"exists"},{"name":"notExists"}]},"value":{"type":"string","description":"Right hand side for dimension or metric predicates"},"range":{"description":"Right hand side for dimension or metric predicates","$ref":"#/definitions/NumericRange"}}},"MediaEndpointStatDetailQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/MediaEndpointStatDetailQueryPredicate"}}}},"MediaEndpointStatDetailQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/MediaEndpointStatDetailQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/MediaEndpointStatDetailQueryPredicate"}}}},"MediaEndpointStatDetailQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"],"x-genesys-enum-members":[{"name":"dimension"},{"name":"property"},{"name":"metric"}]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["codec","discardedPackets","duplicatePackets","eventTime","invalidPackets","maxLatencyMs","overrunPackets","receivedPackets","underrunPackets"],"x-genesys-enum-members":[{"name":"codec"},{"name":"discardedPackets"},{"name":"duplicatePackets"},{"name":"eventTime"},{"name":"invalidPackets"},{"name":"maxLatencyMs"},{"name":"overrunPackets"},{"name":"receivedPackets"},{"name":"underrunPackets"}]},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"],"x-genesys-enum-members":[{"name":"matches"},{"name":"exists"},{"name":"notExists"}]},"value":{"type":"string","description":"Right hand side for dimension predicates"},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"RecordingJob":{"type":"object","required":["state"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"state":{"type":"string","description":"The current state of the job.","enum":["FULFILLED","PENDING","READY","PROCESSING","CANCELLED","FAILED"],"x-genesys-enum-members":[{"name":"FULFILLED"},{"name":"PENDING"},{"name":"READY"},{"name":"PROCESSING"},{"name":"CANCELLED"},{"name":"FAILED"}]},"recordingJobsQuery":{"description":"Original query of the job.","readOnly":true,"$ref":"#/definitions/RecordingJobsQuery"},"dateCreated":{"type":"string","format":"date-time","description":"Date when the job was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"totalConversations":{"type":"integer","format":"int32","description":"Total number of conversations affected.","readOnly":true},"totalRecordings":{"type":"integer","format":"int32","description":"Total number of recordings affected.","readOnly":true},"totalProcessedRecordings":{"type":"integer","format":"int32","description":"Total number of recordings have been processed.","readOnly":true},"percentProgress":{"type":"integer","format":"int32","description":"Progress in percentage based on the number of recordings","readOnly":true},"errorMessage":{"type":"string","description":"Error occurred during the job execution","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"user":{"description":"Details of the user created the job","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"}}},"RecordingJobsQuery":{"type":"object","required":["action","actionDate","conversationQuery"],"properties":{"action":{"type":"string","description":"Operation to perform bulk task","enum":["DELETE","EXPORT"],"x-genesys-enum-members":[{"name":"DELETE"},{"name":"EXPORT"}]},"actionDate":{"type":"string","format":"date-time","description":"The date when the action will be performed. If the operation will cause the delete date of a recording to be older than the export date, the export date will be adjusted to the delete date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"integrationId":{"type":"string","description":"IntegrationId to Access AWS S3 bucket for bulk recording exports. This field is required and used only for EXPORT action."},"includeScreenRecordings":{"type":"boolean","description":"Include Screen recordings for export action, default value = true "},"conversationQuery":{"description":"Conversation Query. Note: After the recording is created, it might take up to 48 hours for the recording to be included in the submitted job query.","$ref":"#/definitions/AsyncConversationQuery"}}},"ResolutionDetailQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/ResolutionDetailQueryPredicate"}}}},"ResolutionDetailQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/ResolutionDetailQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/ResolutionDetailQueryPredicate"}}}},"ResolutionDetailQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"],"x-genesys-enum-members":[{"name":"dimension"},{"name":"property"},{"name":"metric"}]},"metric":{"type":"string","description":"Left hand side for metric predicates","enum":["nNextContactAvoided"],"x-genesys-enum-members":[{"name":"nNextContactAvoided"}]},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"],"x-genesys-enum-members":[{"name":"matches"},{"name":"exists"},{"name":"notExists"}]},"value":{"type":"string","description":"Right hand side for metric predicates"},"range":{"description":"Right hand side for metric predicates","$ref":"#/definitions/NumericRange"}}},"SegmentDetailQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/SegmentDetailQueryPredicate"}}}},"SegmentDetailQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/SegmentDetailQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/SegmentDetailQueryPredicate"}}}},"SegmentDetailQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"],"x-genesys-enum-members":[{"name":"dimension"},{"name":"property"},{"name":"metric"}]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["addressFrom","addressTo","agentAssistantId","ani","callbackNumber","callbackScheduledTime","conference","destinationConversationId","direction","disconnectType","dnis","edgeId","errorCode","exitReason","externalContactId","externalOrganizationId","flaggedReason","flowId","flowName","flowOutType","flowOutcome","flowOutcomeId","flowOutcomeValue","flowVersion","groupId","journeyActionId","journeyActionMapId","journeyCustomerId","journeyCustomerIdType","journeyCustomerSessionId","mediaCount","mediaType","messageType","monitoredParticipantId","outboundCampaignId","outboundContactId","outboundContactListId","participantName","protocolCallId","provider","purpose","queueId","recording","remote","remoteNameDisplayable","requestedLanguageId","requestedRouting","requestedRoutingSkillId","scoredAgentId","scriptId","segmentEnd","segmentType","sessionDnis","sipResponseCode","subject","teamId","transferTargetAddress","transferTargetName","transferType","usedRouting","userId","wrapUpCode","wrapUpNote"],"x-genesys-enum-members":[{"name":"addressFrom"},{"name":"addressTo"},{"name":"agentAssistantId"},{"name":"ani"},{"name":"callbackNumber"},{"name":"callbackScheduledTime"},{"name":"conference"},{"name":"destinationConversationId"},{"name":"direction"},{"name":"disconnectType"},{"name":"dnis"},{"name":"edgeId"},{"name":"errorCode"},{"name":"exitReason"},{"name":"externalContactId"},{"name":"externalOrganizationId"},{"name":"flaggedReason"},{"name":"flowId"},{"name":"flowName"},{"name":"flowOutType"},{"name":"flowOutcome"},{"name":"flowOutcomeId"},{"name":"flowOutcomeValue"},{"name":"flowVersion"},{"name":"groupId"},{"name":"journeyActionId"},{"name":"journeyActionMapId"},{"name":"journeyCustomerId"},{"name":"journeyCustomerIdType"},{"name":"journeyCustomerSessionId"},{"name":"mediaCount"},{"name":"mediaType"},{"name":"messageType"},{"name":"monitoredParticipantId"},{"name":"outboundCampaignId"},{"name":"outboundContactId"},{"name":"outboundContactListId"},{"name":"participantName"},{"name":"protocolCallId"},{"name":"provider"},{"name":"purpose"},{"name":"queueId"},{"name":"recording"},{"name":"remote"},{"name":"remoteNameDisplayable"},{"name":"requestedLanguageId"},{"name":"requestedRouting"},{"name":"requestedRoutingSkillId"},{"name":"scoredAgentId"},{"name":"scriptId"},{"name":"segmentEnd"},{"name":"segmentType"},{"name":"sessionDnis"},{"name":"sipResponseCode"},{"name":"subject"},{"name":"teamId"},{"name":"transferTargetAddress"},{"name":"transferTargetName"},{"name":"transferType"},{"name":"usedRouting"},{"name":"userId"},{"name":"wrapUpCode"},{"name":"wrapUpNote"}]},"propertyType":{"type":"string","description":"Left hand side for property predicates","enum":["bool","integer","real","date","string","uuid"],"x-genesys-enum-members":[{"name":"bool"},{"name":"integer"},{"name":"real"},{"name":"date"},{"name":"string"},{"name":"uuid"}]},"property":{"type":"string","description":"Left hand side for property predicates"},"metric":{"type":"string","description":"Left hand side for metric predicates","enum":["tSegmentDuration"],"x-genesys-enum-members":[{"name":"tSegmentDuration"}]},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"],"x-genesys-enum-members":[{"name":"matches"},{"name":"exists"},{"name":"notExists"}]},"value":{"type":"string","description":"Right hand side for dimension, metric, or property predicates"},"range":{"description":"Right hand side for dimension, metric, or property predicates","$ref":"#/definitions/NumericRange"}}},"SurveyDetailQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/SurveyDetailQueryPredicate"}}}},"SurveyDetailQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/SurveyDetailQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/SurveyDetailQueryPredicate"}}}},"SurveyDetailQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"],"x-genesys-enum-members":[{"name":"dimension"},{"name":"property"},{"name":"metric"}]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["eventTime","queueId","surveyCompletedDate","surveyFormContextId","surveyFormId","surveyId","surveyPromoterScore","surveyStatus","userId"],"x-genesys-enum-members":[{"name":"eventTime"},{"name":"queueId"},{"name":"surveyCompletedDate"},{"name":"surveyFormContextId"},{"name":"surveyFormId"},{"name":"surveyId"},{"name":"surveyPromoterScore"},{"name":"surveyStatus"},{"name":"userId"}]},"metric":{"type":"string","description":"Left hand side for metric predicates","enum":["oSurveyTotalScore"],"x-genesys-enum-members":[{"name":"oSurveyTotalScore"}]},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"],"x-genesys-enum-members":[{"name":"matches"},{"name":"exists"},{"name":"notExists"}]},"value":{"type":"string","description":"Right hand side for dimension or metric predicates"},"range":{"description":"Right hand side for dimension or metric predicates","$ref":"#/definitions/NumericRange"}}},"ExecuteRecordingJobsQuery":{"type":"object","required":["state"],"properties":{"state":{"type":"string","description":"The desired state for the job to be set to.","enum":["PROCESSING"],"x-genesys-enum-members":[{"name":"PROCESSING"}]}}},"EdgeRebootParameters":{"type":"object","properties":{"callDrainingWaitTimeSeconds":{"type":"integer","format":"int32","description":"The number of seconds to wait for call draining to complete before initiating the reboot. A value of 0 will prevent call draining and all calls will disconnect immediately."}}},"ShiftTradeMatchesSummaryResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WeekShiftTradeMatchesSummaryResponse"}}}},"WeekShiftTradeMatchesSummaryResponse":{"type":"object","properties":{"weekDate":{"type":"string","format":"date","description":"The schedule week date in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"count":{"type":"integer","format":"int32","description":"The number of trades in the Matched state for the given week"}}},"BuForecastGenerationPlanningGroupResult":{"type":"object","properties":{"planningGroupId":{"type":"string","description":"The ID of the planning group"},"metricResults":{"type":"array","description":"The generation results for the associated planning group","items":{"$ref":"#/definitions/BuForecastTimeSeriesResult"}}}},"BuForecastGenerationResult":{"type":"object","properties":{"planningGroupResults":{"type":"array","description":"Generation results, broken down by planning group","items":{"$ref":"#/definitions/BuForecastGenerationPlanningGroupResult"}}}},"BuForecastTimeSeriesResult":{"type":"object","properties":{"metric":{"type":"string","description":"The metric this result applies to","enum":["Offered","AverageHandleTimeSeconds"],"x-genesys-enum-members":[{"name":"Offered"},{"name":"AverageHandleTimeSeconds"}]},"forecastingMethod":{"type":"string","description":"The forecasting method that was used for this metric","enum":["AutoRegressiveIntegratedMovingAverage","MovingAverage","SingleExponentialSmoothing","RandomWalk","DecompositionUsingAdditiveSeasonality","DecompositionUsingMultiplicativeSeasonality","HoltWintersAdditiveSeasonality","HoltWintersAdditiveSeasonalityWithDampedTrend","HoltWintersMultiplicativeSeasonality","HoltWintersMultiplicativeSeasonalityWithDampedTrend","DampedLinearExponentialSmoothing","DoubleExponentialSmoothing","DoubleMovingAverage","LinearExponentialSmoothing","LinearWeightedMovingAverage","PointEstimateUsingDampedLinearExponentialSmoothing","PointEstimateUsingDoubleExponentialSmoothing","PointEstimateUsingLatestWeek","PointEstimateUsingLinearExponentialSmoothing","PointEstimateUsingWeightedAverage","CurveFit","MultiLinearRegression","DynamicHarmonicRegression","Other"],"x-genesys-enum-members":[{"name":"AutoRegressiveIntegratedMovingAverage"},{"name":"MovingAverage"},{"name":"SingleExponentialSmoothing"},{"name":"RandomWalk"},{"name":"DecompositionUsingAdditiveSeasonality"},{"name":"DecompositionUsingMultiplicativeSeasonality"},{"name":"HoltWintersAdditiveSeasonality"},{"name":"HoltWintersAdditiveSeasonalityWithDampedTrend"},{"name":"HoltWintersMultiplicativeSeasonality"},{"name":"HoltWintersMultiplicativeSeasonalityWithDampedTrend"},{"name":"DampedLinearExponentialSmoothing"},{"name":"DoubleExponentialSmoothing"},{"name":"DoubleMovingAverage"},{"name":"LinearExponentialSmoothing"},{"name":"LinearWeightedMovingAverage"},{"name":"PointEstimateUsingDampedLinearExponentialSmoothing"},{"name":"PointEstimateUsingDoubleExponentialSmoothing"},{"name":"PointEstimateUsingLatestWeek"},{"name":"PointEstimateUsingLinearExponentialSmoothing"},{"name":"PointEstimateUsingWeightedAverage"},{"name":"CurveFit"},{"name":"MultiLinearRegression"},{"name":"DynamicHarmonicRegression"},{"name":"Other"}]}}},"AsyncForecastOperationResult":{"type":"object","properties":{"status":{"type":"string","description":"The status of the operation","enum":["Processing","Complete","Canceled","Error"],"x-genesys-enum-members":[{"name":"Processing"},{"name":"Complete"},{"name":"Canceled"},{"name":"Error"}]},"operationId":{"type":"string","description":"The ID for the operation"},"result":{"description":"The result of the operation. Null unless status == Complete","$ref":"#/definitions/BuShortTermForecast"},"progress":{"type":"integer","format":"int32","description":"Percent progress for the operation"}}},"BuForecastModification":{"type":"object","required":["displayGranularity","enabled","metric","type"],"properties":{"type":{"type":"string","description":"The type of the modification","enum":["MinimumPerInterval","MaximumPerInterval","SetValuePerInterval","ChangeValuePerInterval","ChangePercentPerInterval","SetValueOverRange","ChangeValueOverRange","SetValuesForIntervalSet"],"x-genesys-enum-members":[{"name":"MinimumPerInterval"},{"name":"MaximumPerInterval"},{"name":"SetValuePerInterval"},{"name":"ChangeValuePerInterval"},{"name":"ChangePercentPerInterval"},{"name":"SetValueOverRange"},{"name":"ChangeValueOverRange"},{"name":"SetValuesForIntervalSet"}]},"startIntervalIndex":{"type":"integer","format":"int32","description":"The number of 15 minute intervals past referenceStartDate representing the first interval to which to apply this modification. Must be null if values is populated"},"endIntervalIndex":{"type":"integer","format":"int32","description":"The number of 15 minute intervals past referenceStartDate representing the last interval to which to apply this modification. Must be null if values is populated"},"metric":{"type":"string","description":"The metric to which this modification applies","enum":["Offered","AverageHandleTimeSeconds"],"x-genesys-enum-members":[{"name":"Offered"},{"name":"AverageHandleTimeSeconds"}]},"legacyMetric":{"type":"string","description":"The legacy metric to which this modification applies if applicable","readOnly":true,"enum":["AverageAfterCallWorkTimeSeconds","AverageHandleTimeSeconds","AverageTalkTimeSeconds","Offered"],"x-genesys-enum-members":[{"name":"AverageAfterCallWorkTimeSeconds"},{"name":"AverageHandleTimeSeconds"},{"name":"AverageTalkTimeSeconds"},{"name":"Offered"}]},"value":{"type":"number","format":"double","description":"The value of the modification. Must be null if \"values\" is populated"},"values":{"type":"array","description":"The list of values to update. Only applicable for grid-type modifications. Must be null if \"value\" is populated","items":{"$ref":"#/definitions/WfmForecastModificationIntervalOffsetValue"}},"displayGranularity":{"type":"string","description":"The client side display granularity of the modification, expressed in the ISO-8601 duration format. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"granularity":{"type":"string","description":"The actual granularity of the modification as stored behind the scenes, expressed in the ISO-8601 duration format. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"enabled":{"type":"boolean","description":"Whether the modification is enabled for the forecast"},"planningGroupIds":{"type":"array","description":"The IDs of the planning groups to which this forecast modification applies. Leave empty to apply to all","uniqueItems":true,"items":{"type":"string"}}}},"BuShortTermForecast":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"weekDate":{"type":"string","format":"date","description":"The start week date of this forecast in yyyy-MM-dd. Must fall on the start day of week for the associated business unit. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"weekCount":{"type":"integer","format":"int32","description":"The number of weeks this forecast covers"},"creationMethod":{"type":"string","description":"The method by which this forecast was created","enum":["Import","ImportedHistoricalWeightedAverage","HistoricalWeightedAverage","Advanced"],"x-genesys-enum-members":[{"name":"Import"},{"name":"ImportedHistoricalWeightedAverage"},{"name":"HistoricalWeightedAverage"},{"name":"Advanced"}]},"description":{"type":"string","description":"The description of this forecast"},"legacy":{"type":"boolean","description":"Whether this forecast contains modifications on legacy metrics","readOnly":true},"metadata":{"description":"Metadata for this forecast","$ref":"#/definitions/WfmVersionedEntityMetadata"},"referenceStartDate":{"type":"string","format":"date-time","description":"The reference start date for interval-based data for this forecast. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"sourceDays":{"type":"array","description":"The source day pointers for this forecast","items":{"$ref":"#/definitions/ForecastSourceDayPointer"}},"modifications":{"type":"array","description":"Any manual modifications applied to this forecast","items":{"$ref":"#/definitions/BuForecastModification"}},"generationResults":{"description":"Generation result metadata","$ref":"#/definitions/BuForecastGenerationResult"},"timeZone":{"type":"string","description":"The time zone for this forecast"},"planningGroupsVersion":{"type":"integer","format":"int32","description":"The version of the planning groups that was used for this forecast"},"planningGroups":{"description":"A snapshot of the planning groups used for this forecast as of the version number indicated","$ref":"#/definitions/ForecastPlanningGroupsResponse"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ForecastPlanningGroupsResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ForecastPlanningGroupResponse"}}}},"ForecastSourceDayPointer":{"type":"object","properties":{"dayOfWeek":{"type":"string","description":"The forecast day of week for this source data","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday","EighthDay"],"x-genesys-enum-members":[{"name":"Sunday"},{"name":"Monday"},{"name":"Tuesday"},{"name":"Wednesday"},{"name":"Thursday"},{"name":"Friday"},{"name":"Saturday"},{"name":"EighthDay"}]},"weight":{"type":"integer","format":"int32","description":"The relative weight to apply to this source data item for weighted averages"},"date":{"type":"string","description":"The date this source data represents, in yyyy-MM-dd format"},"fileName":{"type":"string","description":"The name of the source file this data came from if it originated from a data import"},"dataKey":{"type":"string","description":"The key to look up the forecast source data for this source day"}},"description":"Pointer to look up source data for a short term forecast"},"WfmForecastModificationIntervalOffsetValue":{"type":"object","required":["intervalIndex","value"],"properties":{"intervalIndex":{"type":"integer","format":"int32","description":"The number of 15 minute intervals past referenceStartDate to which to apply this modification"},"value":{"type":"number","format":"double","description":"The value to set for the given interval"}},"description":"Override the value of a single interval in a forecast"},"BuShortTermForecastListItem":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"weekDate":{"type":"string","format":"date","description":"The start week date of this forecast in yyyy-MM-dd. Must fall on the start day of week for the associated business unit. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"weekCount":{"type":"integer","format":"int32","description":"The number of weeks this forecast covers"},"creationMethod":{"type":"string","description":"The method by which this forecast was created","enum":["Import","ImportedHistoricalWeightedAverage","HistoricalWeightedAverage","Advanced"],"x-genesys-enum-members":[{"name":"Import"},{"name":"ImportedHistoricalWeightedAverage"},{"name":"HistoricalWeightedAverage"},{"name":"Advanced"}]},"description":{"type":"string","description":"The description of this forecast"},"legacy":{"type":"boolean","description":"Whether this forecast contains modifications on legacy metrics","readOnly":true},"metadata":{"description":"Metadata for this forecast","$ref":"#/definitions/WfmVersionedEntityMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BuShortTermForecastListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/BuShortTermForecastListItem"}}}},"GenerateBuForecastRequest":{"type":"object","required":["description"],"properties":{"description":{"type":"string","description":"The description for the forecast"},"weekCount":{"type":"integer","format":"int32","description":"The number of weeks this forecast covers"}}},"BuForecastResult":{"type":"object","properties":{"referenceStartDate":{"type":"string","format":"date-time","description":"The reference start date for interval-based data for this forecast. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"planningGroups":{"type":"array","description":"The forecast data broken up by planning group","items":{"$ref":"#/definitions/ForecastPlanningGroupData"}},"weekNumber":{"type":"integer","format":"int32","description":"The week number represented by this response"},"weekCount":{"type":"integer","format":"int32","description":"The number of weeks in this forecast"}}},"BuForecastResultResponse":{"type":"object","properties":{"result":{"description":"The result of the operation. Populated whenever the result is small enough to pass through the api directly","$ref":"#/definitions/BuForecastResult"},"downloadUrl":{"type":"string","description":"The download url to fetch the result. Only populated if the result is too large to pass through the api directly"}}},"ForecastPlanningGroupData":{"type":"object","properties":{"planningGroupId":{"type":"string","description":"The ID of the planning group to which this data applies. Note this is a snapshot of the planning group at the time of forecast creation and may not correspond to the current configuration"},"offeredPerInterval":{"type":"array","description":"Forecast offered counts per interval for this week of the forecast","items":{"type":"number","format":"double"}},"averageHandleTimeSecondsPerInterval":{"type":"array","description":"Forecast average handle time per interval in seconds","items":{"type":"number","format":"double"}}}},"CopyBuForecastRequest":{"type":"object","required":["description","weekDate"],"properties":{"description":{"type":"string","description":"The description for the forecast"},"weekDate":{"type":"string","format":"date","description":"The start date of the new forecast to create from the existing forecast. Must correspond to the start day of week for the business unit. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"}}},"FlowVersionEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/FlowVersion"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FaxDocument":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"contentUri":{"type":"string","format":"uri"},"workspace":{"$ref":"#/definitions/DomainEntityRef"},"createdBy":{"$ref":"#/definitions/DomainEntityRef"},"contentType":{"type":"string"},"contentLength":{"type":"integer","format":"int64"},"filename":{"type":"string"},"read":{"type":"boolean"},"pageCount":{"type":"integer","format":"int64"},"callerAddress":{"type":"string"},"receiverAddress":{"type":"string"},"thumbnails":{"type":"array","items":{"$ref":"#/definitions/DocumentThumbnail"}},"sharingUri":{"type":"string","format":"uri"},"downloadSharingUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DIDPool":{"type":"object","required":["endPhoneNumber","name","startPhoneNumber"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"startPhoneNumber":{"type":"string","description":"The starting phone number for the range of this DID pool. Must be in E.164 format"},"endPhoneNumber":{"type":"string","description":"The ending phone number for the range of this DID pool. Must be in E.164 format"},"comments":{"type":"string"},"provider":{"type":"string","description":"The provider for this DID pool","enum":["PURE_CLOUD","PURE_CLOUD_VOICE"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DIDPoolEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DIDPool"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ModelingProcessingError":{"type":"object","properties":{"internalErrorCode":{"type":"string","description":"An internal code representing the type of error. ModelInputMissing for 'Model Builder inputs not found.' ModelInputInvalid for 'Model Builder inputs are invalid. Ensure the input data format is correct.' ModelFailed for 'An error occured while building the model with the given input.'","readOnly":true,"enum":["ModelInputMissing","ModelInputInvalid","ModelFailed"],"x-genesys-enum-members":[{"name":"ModelInputMissing"},{"name":"ModelInputInvalid"},{"name":"ModelFailed"}]},"description":{"type":"string","description":"A text description of the error","readOnly":true}}},"ModelingStatusResponse":{"type":"object","properties":{"id":{"type":"string","description":"The ID generated for the modeling job. Use to GET result when job is completed.","readOnly":true},"status":{"type":"string","description":"The status of the modeling job.","readOnly":true,"enum":["Pending","Success","Failed","Ongoing","PartialFailure"],"x-genesys-enum-members":[{"name":"Pending"},{"name":"Success"},{"name":"Failed"},{"name":"Ongoing"},{"name":"PartialFailure"}]},"errorDetails":{"type":"array","description":"If the request could not be properly processed, error details will be given here.","readOnly":true,"items":{"$ref":"#/definitions/ModelingProcessingError"}},"modelingResultUri":{"type":"string","description":"The uri of the modeling result. It has a value if the status is either 'Success', 'PartialFailure', or 'Failed'.","readOnly":true}}},"WorkspaceMember":{"type":"object","required":["memberType"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"workspace":{"$ref":"#/definitions/DomainEntityRef"},"memberType":{"type":"string","description":"The workspace member type.","enum":["USER","GROUP"],"x-genesys-enum-members":[{"name":"USER"},{"name":"GROUP"}]},"member":{"$ref":"#/definitions/DomainEntityRef"},"user":{"$ref":"#/definitions/User"},"group":{"$ref":"#/definitions/Group"},"securityProfile":{"$ref":"#/definitions/SecurityProfile"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OrganizationProductEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DomainOrganizationProduct"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"pageCount":{"type":"integer","format":"int32"}}},"WorkspaceMemberEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WorkspaceMember"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"TrainingListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/KnowledgeTraining"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"RelationshipListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Relationship"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CampaignDivisionView":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CampaignDivisionViewListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CampaignDivisionView"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FreeSeatingConfiguration":{"type":"object","properties":{"freeSeatingState":{"type":"string","description":"The FreeSeatingState for FreeSeatingConfiguration. Can be ON, OFF, or PARTIAL. ON meaning disassociate the user after the ttl expires, OFF meaning never disassociate the user, and PARTIAL meaning only disassociate when a user explicitly clicks log out.","enum":["ON","OFF","PARTIAL"],"x-genesys-enum-members":[{"name":"ON"},{"name":"OFF"},{"name":"PARTIAL"}]},"ttlMinutes":{"type":"integer","format":"int32","description":"The amount of time in minutes until an offline user is disassociated from their station"}}},"StationSettings":{"type":"object","properties":{"freeSeatingConfiguration":{"description":"Configuration options for free-seating","$ref":"#/definitions/FreeSeatingConfiguration"}},"description":"Organization settings for stations"},"ApiUsageQueryResult":{"type":"object","properties":{"results":{"type":"array","description":"Query results","items":{"$ref":"#/definitions/ApiUsageRow"}},"queryStatus":{"type":"string","description":"Query status","enum":["Complete","Failed","Running"],"x-genesys-enum-members":[{"name":"Complete"},{"name":"Failed"},{"name":"Running"}]}}},"ApiUsageRow":{"type":"object","properties":{"clientId":{"type":"string","description":"Client Id associated with this query result"},"clientName":{"type":"string","description":"Client Name associated with this query result"},"organizationId":{"type":"string","description":"Organization Id associated with this query result"},"userId":{"type":"string","description":"User Id associated with this query result"},"templateUri":{"type":"string","description":"Template Uri associated with this query result"},"httpMethod":{"type":"string","description":"HTTP Method associated with this query result"},"status200":{"type":"integer","format":"int64","description":"Number of requests resulting in a 2xx HTTP status code"},"status300":{"type":"integer","format":"int64","description":"Number of requests resulting in a 3xx HTTP status code"},"status400":{"type":"integer","format":"int64","description":"Number of requests resulting in a 4xx HTTP status code"},"status500":{"type":"integer","format":"int64","description":"Number of requests resulting in a 5xx HTTP status code"},"status429":{"type":"integer","format":"int64","description":"Number of requests resulting in a 429 HTTP status code, this is a subset of the count returned with status400"},"requests":{"type":"integer","format":"int64","description":"Total number of requests"},"date":{"type":"string","format":"date-time","description":"Date of requests, based on granularity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"GreetingListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Greeting"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"SchemaCategory":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SchemaCategoryEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SchemaCategory"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Channel":{"type":"object","properties":{"connectUri":{"type":"string","format":"uri"},"id":{"type":"string"},"expires":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"ChannelEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Channel"}}}},"PhonesReboot":{"type":"object","properties":{"phoneIds":{"type":"array","description":"The list of phone Ids to reboot.","items":{"type":"string"}},"siteId":{"type":"string","description":"ID of the site for which to reboot all phones at that site.\nno.active.edge and phone.cannot.resolve errors are ignored."}}},"AvailableLanguageList":{"type":"object","properties":{"languages":{"type":"array","items":{"type":"string"}}}},"QualityAudit":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"user":{"$ref":"#/definitions/User"},"jobId":{"type":"string"},"level":{"type":"string"},"entity":{"$ref":"#/definitions/AuditEntity"},"timestamp":{"type":"string"},"action":{"type":"string"},"status":{"type":"string"},"changes":{"type":"array","items":{"$ref":"#/definitions/Change"}},"entityType":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"QualityAuditPage":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/QualityAudit"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Category":{"type":"object","properties":{"name":{"type":"string","description":"Category name"}},"description":"List of available Action categories."},"CategoryEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Category"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"pageCount":{"type":"integer","format":"int32"}}},"Salesforce":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"disabled":{"type":"boolean"},"issuerURI":{"type":"string"},"ssoTargetURI":{"type":"string"},"certificate":{"type":"string"},"certificates":{"type":"array","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DocumentationResult":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","format":"int32","description":"The globally unique identifier for the object."},"categories":{"type":"array","description":"The category of the documentation entity. Will be returned in responses for certain entities.","items":{"type":"integer","format":"int32"}},"description":{"type":"string","description":"The description of the documentation entity. Will be returned in responses for certain entities."},"content":{"type":"string","description":"The text or html content for the documentation entity. Will be returned in responses for certain entities."},"excerpt":{"type":"string","description":"The excerpt of the documentation entity. Will be returned in responses for certain entities."},"link":{"type":"string","description":"URL link for the documentation entity. Will be returned in responses for certain entities."},"modified":{"type":"string","format":"date-time","description":"The modified date for the documentation entity. Will be returned in responses for certain entities. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"name":{"type":"string","description":"The name of the documentation entity. Will be returned in responses for certain entities."},"service":{"type":"array","description":"The service of the documentation entity. Will be returned in responses for certain entities.","items":{"type":"integer","format":"int32"}},"slug":{"type":"string","description":"The slug of the documentation entity. Will be returned in responses for certain entities."},"title":{"type":"string","description":"The title of the documentation entity. Will be returned in responses for certain entities."},"get_type":{"type":"string","description":"The search type. Will be returned in responses for certain entities."},"facet_feature":{"type":"array","description":"The facet feature of the documentation entity. Will be returned in responses for certain entities.","items":{"type":"integer","format":"int32"}},"facet_role":{"type":"array","description":"The facet role of the documentation entity. Will be returned in responses for certain entities.","items":{"type":"integer","format":"int32"}},"facet_service":{"type":"array","description":"The facet service of the documentation entity. Will be returned in responses for certain entities.","items":{"type":"integer","format":"int32"}},"faq_categories":{"type":"array","description":"The faq categories of the documentation entity. Will be returned in responses for certain entities.","items":{"type":"integer","format":"int32"}},"releasenote_category":{"type":"array","description":"The releasenote category of the documentation entity. Will be returned in responses for certain entities.","items":{"type":"integer","format":"int32"}},"releasenote_tag":{"type":"array","description":"The releasenote tag of the documentation entity. Will be returned in responses for certain entities.","items":{"type":"integer","format":"int32"}},"service-area":{"type":"array","description":"The service area of the documentation entity. Will be returned in responses for certain entities.","items":{"type":"integer","format":"int32"}},"video_categories":{"type":"array","description":"The video categories of the documentation entity. Will be returned in responses for certain entities.","items":{"type":"integer","format":"int32"}}}},"DocumentationSearchResponse":{"type":"object","required":["pageCount","pageNumber","pageSize","results","total","types"],"properties":{"total":{"type":"integer","format":"int64","description":"The total number of results found"},"pageCount":{"type":"integer","format":"int32","description":"The total number of pages"},"pageSize":{"type":"integer","format":"int32","description":"The current page size"},"pageNumber":{"type":"integer","format":"int32","description":"The current page number"},"previousPage":{"type":"string","description":"Q64 value for the previous page of results"},"currentPage":{"type":"string","description":"Q64 value for the current page of results"},"nextPage":{"type":"string","description":"Q64 value for the next page of results"},"types":{"type":"array","description":"Resource types the search was performed against","items":{"type":"string"}},"results":{"type":"array","description":"Search results","items":{"$ref":"#/definitions/DocumentationResult"}}}},"DocumentationSearchCriteria":{"type":"object","required":["type"],"properties":{"endValue":{"type":"string","description":"The end value of the range. This field is used for range search types."},"values":{"type":"array","description":"A list of values for the search to match against","items":{"type":"string"}},"startValue":{"type":"string","description":"The start value of the range. This field is used for range search types."},"fields":{"type":"array","description":"Field names to search against","items":{"type":"string"}},"value":{"type":"string","description":"A value for the search to match against"},"operator":{"type":"string","description":"How to apply this search criteria against other criteria","enum":["AND","OR","NOT"],"x-genesys-enum-members":[{"name":"AND"},{"name":"OR"},{"name":"NOT"}]},"group":{"type":"array","description":"Groups multiple conditions","items":{"$ref":"#/definitions/DocumentationSearchCriteria"}},"dateFormat":{"type":"string","description":"Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."},"type":{"type":"string","description":"Search Type","enum":["EXACT","STARTS_WITH","CONTAINS","TERM","TERMS","MATCH_ALL","SIMPLE","QUERY_STRING","MULTI_MATCH"],"x-genesys-enum-members":[{"name":"EXACT"},{"name":"STARTS_WITH"},{"name":"CONTAINS"},{"name":"TERM"},{"name":"TERMS"},{"name":"MATCH_ALL"},{"name":"SIMPLE"},{"name":"QUERY_STRING"},{"name":"MULTI_MATCH"}]}}},"DocumentationSearchRequest":{"type":"object","properties":{"sortOrder":{"type":"string","description":"The sort order for results","enum":["ASC","DESC","SCORE"],"x-genesys-enum-members":[{"name":"ASC"},{"name":"DESC"},{"name":"SCORE"}]},"sortBy":{"type":"string","description":"The field in the resource that you want to sort the results by"},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"},"pageNumber":{"type":"integer","format":"int32","description":"The page of resources you want to retrieve"},"sort":{"type":"array","description":"Multi-value sort order, list of multiple sort values","items":{"$ref":"#/definitions/SearchSort"}},"query":{"type":"array","items":{"$ref":"#/definitions/DocumentationSearchCriteria"}}}},"ConsumedResourcesEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Dependency"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AddConversationResponse":{"type":"object","properties":{"conversation":{"description":"The conversation reference","readOnly":true,"$ref":"#/definitions/ConversationReference"},"appointment":{"description":"The appointment reference","readOnly":true,"$ref":"#/definitions/CoachingAppointmentReference"}}},"AddConversationRequest":{"type":"object","required":["conversationId"],"properties":{"conversationId":{"type":"string","description":"The id of the conversation to add"}},"description":"Update coaching appointment request"},"UpdateCoachingAppointmentRequest":{"type":"object","properties":{"name":{"type":"string","description":"The name of coaching appointment."},"description":{"type":"string","description":"The description of coaching appointment."},"dateStart":{"type":"string","format":"date-time","description":"The date/time the coaching appointment starts. Times will be rounded down to the minute. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"lengthInMinutes":{"type":"integer","format":"int32","description":"The duration of coaching appointment in minutes."},"conversationIds":{"type":"array","description":"IDs of conversations associated with this coaching appointment.","uniqueItems":true,"items":{"type":"string"}},"documentIds":{"type":"array","description":"IDs of documents associated with this coaching appointment.","uniqueItems":true,"items":{"type":"string"}},"status":{"type":"string","description":"The status of the coaching appointment.","enum":["Scheduled","InProgress","Completed"],"x-genesys-enum-members":[{"name":"Scheduled"},{"name":"InProgress"},{"name":"Completed"}]}},"description":"Update coaching appointment request"},"WhatsAppIntegrationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WhatsAppIntegration"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"WhatsAppIntegrationRequest":{"type":"object","required":["name","phoneNumber","wabaCertificate"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the WhatsApp Integration"},"phoneNumber":{"type":"string","description":"The phone number associated to the whatsApp integration"},"wabaCertificate":{"type":"string","description":"The waba(WhatsApp Business Manager) certificate associated to the WhatsApp integration phone number"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WrapUpCodeMapping":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"defaultSet":{"type":"array","description":"The default set of wrap-up flags. These will be used if there is no entry for a given wrap-up code in the mapping.","uniqueItems":true,"items":{"type":"string","enum":["CONTACT_UNCALLABLE","NUMBER_UNCALLABLE","RIGHT_PARTY_CONTACT"],"x-genesys-enum-members":[{"name":"CONTACT_UNCALLABLE"},{"name":"NUMBER_UNCALLABLE"},{"name":"RIGHT_PARTY_CONTACT"}]}},"mapping":{"type":"object","description":"A map from wrap-up code identifiers to a set of wrap-up flags.","additionalProperties":{"type":"array","uniqueItems":true,"items":{"type":"string","enum":["CONTACT_UNCALLABLE","NUMBER_UNCALLABLE","RIGHT_PARTY_CONTACT"],"x-genesys-enum-members":[{"name":"CONTACT_UNCALLABLE"},{"name":"NUMBER_UNCALLABLE"},{"name":"RIGHT_PARTY_CONTACT"}]}}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"MediaUtilization":{"type":"object","properties":{"maximumCapacity":{"type":"integer","format":"int32","description":"Defines the maximum number of conversations of this type that an agent can handle at one time."},"interruptableMediaTypes":{"type":"array","description":"Defines the list of other media types that can interrupt a conversation of this media type. Values include call, chat, email, callback, and message.","items":{"type":"string"}},"includeNonAcd":{"type":"boolean","description":"If true, then track non-ACD conversations against utilization"}}},"Utilization":{"type":"object","properties":{"utilization":{"type":"object","description":"Map of media type to utilization settings. Valid media types include call, callback, chat, email, and message.","additionalProperties":{"$ref":"#/definitions/MediaUtilization"}}}},"ContactListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ExternalContact"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FacebookAppCredentials":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Genesys Cloud Facebook App Id","readOnly":true}}},"SurveyFormAndScoringSet":{"type":"object","properties":{"surveyForm":{"$ref":"#/definitions/SurveyForm"},"answers":{"$ref":"#/definitions/SurveyScoringSet"}}},"CategoryListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/KnowledgeCategory"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"KnowledgeExtendedCategory":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Category name"},"description":{"type":"string","description":"Category description"},"knowledgeBase":{"description":"Knowledge base which category does belong to","readOnly":true,"$ref":"#/definitions/KnowledgeBase"},"languageCode":{"type":"string","description":"Actual language of the category","readOnly":true,"enum":["en-US","de-DE"],"x-genesys-enum-members":[{"name":"en-US"},{"name":"de-DE"}]},"dateCreated":{"type":"string","format":"date-time","description":"Category creation date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Category last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"parent":{"description":"Category parent","readOnly":true,"$ref":"#/definitions/KnowledgeCategory"},"children":{"type":"array","description":"Category children","readOnly":true,"items":{"$ref":"#/definitions/KnowledgeCategory"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeCategoryRequest":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Category name"},"description":{"type":"string","description":"Category description"},"parent":{"description":"Category parent","$ref":"#/definitions/DocumentCategoryInput"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"VoicemailMailboxInfo":{"type":"object","properties":{"usageSizeBytes":{"type":"integer","format":"int64","description":"The total number of bytes for all voicemail message audio recordings","readOnly":true},"totalCount":{"type":"integer","format":"int32","description":"The total number of voicemail messages","readOnly":true},"unreadCount":{"type":"integer","format":"int32","description":"The total number of voicemail messages marked as unread","readOnly":true},"deletedCount":{"type":"integer","format":"int32","description":"The total number of voicemail messages marked as deleted","readOnly":true},"createdDate":{"type":"string","format":"date-time","description":"The date of the oldest voicemail message. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"modifiedDate":{"type":"string","format":"date-time","description":"The date of the most recent voicemail message. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true}}},"NluFeedbackListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/NluFeedbackResponse"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"NluFeedbackRequest":{"type":"object","required":["intents","text","versionId"],"properties":{"text":{"type":"string","description":"The feedback text."},"intents":{"type":"array","description":"Detected intent of the utterance","items":{"$ref":"#/definitions/IntentFeedback"}},"versionId":{"type":"string","description":"The domain version ID of the feedback."}}},"SecurityProfileEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SecurityProfile"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DIDNumber":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"number":{"type":"string","description":"The number of the DID formatted as E164."},"assigned":{"type":"boolean","description":"True if this DID is assigned to an entity. False otherwise."},"didPool":{"description":"A Uri reference to the DID Pool this DID is a part of.","$ref":"#/definitions/AddressableEntityRef"},"owner":{"description":"A Uri reference to the owner of this DID. The owner's type can be found in ownerType. If the DID is unassigned, this will be NULL.","$ref":"#/definitions/DomainEntityRef"},"ownerType":{"type":"string","description":"The type of the entity that owns this DID. If the DID is unassigned, this will be NULL.","enum":["USER","PHONE","IVR_CONFIG","GROUP"],"x-genesys-enum-members":[{"name":"USER"},{"name":"PHONE"},{"name":"IVR_CONFIG"},{"name":"GROUP"}]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Represents an unassigned or assigned DID in a DID Pool."},"DIDNumberEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DIDNumber"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AggregationResult":{"type":"object","properties":{"type":{"type":"string","enum":["termFrequency","numericRange"],"x-genesys-enum-members":[{"name":"termFrequency"},{"name":"numericRange"}]},"dimension":{"type":"string","description":"For termFrequency aggregations"},"metric":{"type":"string","description":"For numericRange aggregations"},"count":{"type":"integer","format":"int64"},"results":{"type":"array","items":{"$ref":"#/definitions/AggregationResultEntry"}}}},"AggregationResultEntry":{"type":"object","properties":{"count":{"type":"integer","format":"int64"},"value":{"type":"string","description":"For termFrequency aggregations"},"gte":{"type":"number","description":"For numericRange aggregations"},"lt":{"type":"number","description":"For numericRange aggregations"}}},"AnalyticsRoutingStatusRecord":{"type":"object","properties":{"startTime":{"type":"string","format":"date-time","description":"The start time of the record. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The end time of the record. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"routingStatus":{"type":"string","description":"The user's ACD routing status","enum":["OFF_QUEUE","IDLE","INTERACTING","NOT_RESPONDING","COMMUNICATING"]}}},"AnalyticsUserDetail":{"type":"object","properties":{"userId":{"type":"string","description":"The identifier for the user"},"primaryPresence":{"type":"array","description":"The presence records for the user","items":{"$ref":"#/definitions/AnalyticsUserPresenceRecord"}},"routingStatus":{"type":"array","description":"The ACD routing status records for the user","items":{"$ref":"#/definitions/AnalyticsRoutingStatusRecord"}}}},"AnalyticsUserDetailsQueryResponse":{"type":"object","properties":{"userDetails":{"type":"array","items":{"$ref":"#/definitions/AnalyticsUserDetail"}},"aggregations":{"type":"array","items":{"$ref":"#/definitions/AggregationResult"}}}},"AnalyticsUserPresenceRecord":{"type":"object","properties":{"startTime":{"type":"string","format":"date-time","description":"The start time of the record. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endTime":{"type":"string","format":"date-time","description":"The end time of the record. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"systemPresence":{"type":"string","description":"The user's system presence","enum":["AVAILABLE","AWAY","BUSY","OFFLINE","IDLE","ON_QUEUE","MEAL","TRAINING","MEETING","BREAK"]},"organizationPresenceId":{"type":"string","description":"The identifier for the user's organization presence"}}},"AnalyticsQueryAggregation":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["termFrequency","numericRange"],"x-genesys-enum-members":[{"name":"termFrequency"},{"name":"numericRange"}]},"dimension":{"type":"string","description":"For use with termFrequency aggregations"},"metric":{"type":"string","description":"For use with numericRange aggregations"},"size":{"type":"integer","format":"int32","description":"For use with termFrequency aggregations"},"ranges":{"type":"array","description":"For use with numericRange aggregations","items":{"$ref":"#/definitions/AggregationRange"}}}},"PagingSpec":{"type":"object","required":["pageNumber","pageSize"],"properties":{"pageSize":{"type":"integer","format":"int32","description":"How many results per page"},"pageNumber":{"type":"integer","format":"int32","description":"How many pages in"}}},"PresenceDetailQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/PresenceDetailQueryPredicate"}}}},"PresenceDetailQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/PresenceDetailQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/PresenceDetailQueryPredicate"}}}},"PresenceDetailQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"],"x-genesys-enum-members":[{"name":"dimension"},{"name":"property"},{"name":"metric"}]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["organizationPresenceId","systemPresence"],"x-genesys-enum-members":[{"name":"organizationPresenceId"},{"name":"systemPresence"}]},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"],"x-genesys-enum-members":[{"name":"matches"},{"name":"exists"},{"name":"notExists"}]},"value":{"type":"string","description":"Right hand side for dimension predicates"},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"RoutingStatusDetailQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/RoutingStatusDetailQueryPredicate"}}}},"RoutingStatusDetailQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/RoutingStatusDetailQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/RoutingStatusDetailQueryPredicate"}}}},"RoutingStatusDetailQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"],"x-genesys-enum-members":[{"name":"dimension"},{"name":"property"},{"name":"metric"}]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["routingStatus"],"x-genesys-enum-members":[{"name":"routingStatus"}]},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"],"x-genesys-enum-members":[{"name":"matches"},{"name":"exists"},{"name":"notExists"}]},"value":{"type":"string","description":"Right hand side for dimension predicates"},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"UserDetailQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/UserDetailQueryPredicate"}}}},"UserDetailQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/UserDetailQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/UserDetailQueryPredicate"}}}},"UserDetailQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"],"x-genesys-enum-members":[{"name":"dimension"},{"name":"property"},{"name":"metric"}]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["userId"],"x-genesys-enum-members":[{"name":"userId"}]},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"],"x-genesys-enum-members":[{"name":"matches"},{"name":"exists"},{"name":"notExists"}]},"value":{"type":"string","description":"Right hand side for dimension predicates"},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"UserDetailsQuery":{"type":"object","required":["interval"],"properties":{"interval":{"type":"string","description":"Specifies the date and time range of data being queried. Conversations MUST have started within this time range to potentially be included within the result set. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"userFilters":{"type":"array","description":"Filters that target the users to retrieve data for","items":{"$ref":"#/definitions/UserDetailQueryFilter"}},"presenceFilters":{"type":"array","description":"Filters that target system and organization presence-level data","items":{"$ref":"#/definitions/PresenceDetailQueryFilter"}},"routingStatusFilters":{"type":"array","description":"Filters that target agent routing status-level data","items":{"$ref":"#/definitions/RoutingStatusDetailQueryFilter"}},"order":{"type":"string","description":"Sort the result set in ascending/descending order. Default is ascending","enum":["asc","desc"],"x-genesys-enum-members":[{"name":"asc"},{"name":"desc"}]},"presenceAggregations":{"type":"array","description":"Include faceted search and aggregate roll-ups of presence data in your search results. This does not function as a filter, but rather, summary data about the presence results matching your filters","items":{"$ref":"#/definitions/AnalyticsQueryAggregation"}},"routingStatusAggregations":{"type":"array","description":"Include faceted search and aggregate roll-ups of agent routing status data in your search results. This does not function as a filter, but rather, summary data about the agent routing status results matching your filters","items":{"$ref":"#/definitions/AnalyticsQueryAggregation"}},"paging":{"description":"Page size and number to control iterating through large result sets. Default page size is 25","$ref":"#/definitions/PagingSpec"}}},"UserAggregateDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/StatisticalResponse"}}}},"UserAggregateQueryResponse":{"type":"object","properties":{"systemToOrganizationMappings":{"type":"object","description":"A mapping from system presence to a list of organization presence ids","additionalProperties":{"type":"array","items":{"type":"string"}}},"results":{"type":"array","items":{"$ref":"#/definitions/UserAggregateDataContainer"}}}},"UserAggregateQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/UserAggregateQueryPredicate"}}}},"UserAggregateQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/UserAggregateQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/UserAggregateQueryPredicate"}}}},"UserAggregateQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"],"x-genesys-enum-members":[{"name":"dimension"},{"name":"property"},{"name":"metric"}]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["userId"],"x-genesys-enum-members":[{"name":"userId"}]},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"],"x-genesys-enum-members":[{"name":"matches"},{"name":"exists"},{"name":"notExists"}]},"value":{"type":"string","description":"Right hand side for dimension predicates"},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"UserAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["userId"],"x-genesys-enum-members":[{"name":"userId"}]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/UserAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["tAgentRoutingStatus","tOrganizationPresence","tSystemPresence"],"x-genesys-enum-members":[{"name":"tAgentRoutingStatus"},{"name":"tOrganizationPresence"},{"name":"tSystemPresence"}]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/UserAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"],"x-genesys-enum-members":[{"name":"eventTime"}]}}},"UserAggregationView":{"type":"object","required":["function","name","target"],"properties":{"target":{"type":"string","description":"Target metric name","enum":["tAgentRoutingStatus","tOrganizationPresence","tSystemPresence"],"x-genesys-enum-members":[{"name":"tAgentRoutingStatus"},{"name":"tOrganizationPresence"},{"name":"tSystemPresence"}]},"name":{"type":"string","description":"A unique name for this view. Must be distinct from other views and built-in metric names."},"function":{"type":"string","description":"Type of view you wish to create","enum":["rangeBound"],"x-genesys-enum-members":[{"name":"rangeBound"}]},"range":{"description":"Range of numbers for slicing up data","$ref":"#/definitions/AggregationRange"}}},"UserObservationDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/ObservationMetricData"}}}},"UserObservationQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/UserObservationDataContainer"}}}},"UserObservationQuery":{"type":"object","required":["filter","metrics"],"properties":{"filter":{"description":"Filter to return a subset of observations. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/UserObservationQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["oActiveQueues","oMemberQueues"],"x-genesys-enum-members":[{"name":"oActiveQueues"},{"name":"oMemberQueues"}]}},"detailMetrics":{"type":"array","description":"Metrics for which to include additional detailed observations","items":{"type":"string","enum":["oActiveQueues","oMemberQueues"],"x-genesys-enum-members":[{"name":"oActiveQueues"},{"name":"oMemberQueues"}]}}}},"UserObservationQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/UserObservationQueryPredicate"}}}},"UserObservationQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/UserObservationQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/UserObservationQueryPredicate"}}}},"UserObservationQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"],"x-genesys-enum-members":[{"name":"dimension"},{"name":"property"},{"name":"metric"}]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["userId"],"x-genesys-enum-members":[{"name":"userId"}]},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"],"x-genesys-enum-members":[{"name":"matches"},{"name":"exists"},{"name":"notExists"}]},"value":{"type":"string","description":"Right hand side for dimension predicates"},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"AsyncQueryResponse":{"type":"object","properties":{"jobId":{"type":"string","description":"Unique identifier for the async query execution. Can be used to check the status of the query and retrieve results."}}},"AsyncUserDetailsQuery":{"type":"object","required":["interval"],"properties":{"interval":{"type":"string","description":"Specifies the date and time range of data being queried. Conversations MUST have started within this time range to potentially be included within the result set. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"userFilters":{"type":"array","description":"Filters that target the users to retrieve data for","items":{"$ref":"#/definitions/UserDetailQueryFilter"}},"presenceFilters":{"type":"array","description":"Filters that target system and organization presence-level data","items":{"$ref":"#/definitions/PresenceDetailQueryFilter"}},"routingStatusFilters":{"type":"array","description":"Filters that target agent routing status-level data","items":{"$ref":"#/definitions/RoutingStatusDetailQueryFilter"}},"order":{"type":"string","description":"Sort the result set in ascending/descending order. Default is ascending","enum":["asc","desc"],"x-genesys-enum-members":[{"name":"asc"},{"name":"desc"}]},"limit":{"type":"integer","format":"int32","description":"Specify number of results to be returned"}}},"AsyncQueryStatus":{"type":"object","properties":{"state":{"type":"string","description":"The current state of the asynchronous query","enum":["QUEUED","PENDING","FAILED","CANCELLED","FULFILLED","EXPIRED"],"x-genesys-enum-members":[{"name":"QUEUED"},{"name":"PENDING"},{"name":"FAILED"},{"name":"CANCELLED"},{"name":"FULFILLED"},{"name":"EXPIRED"}]},"errorMessage":{"type":"string","description":"The error associated with the current query, if the state is FAILED"},"expirationDate":{"type":"string","format":"date-time","description":"The time at which results for this query will expire. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"submissionDate":{"type":"string","format":"date-time","description":"The time at which the query was submitted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"completionDate":{"type":"string","format":"date-time","description":"The time at which the query completed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"AnalyticsUserDetailsAsyncQueryResponse":{"type":"object","properties":{"userDetails":{"type":"array","items":{"$ref":"#/definitions/AnalyticsUserDetail"}},"cursor":{"type":"string","description":"Optional cursor to indicate where to resume the results"},"dataAvailabilityDate":{"type":"string","format":"date-time","description":"Data available up to at least this datetime. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"DataAvailabilityResponse":{"type":"object","properties":{"dataAvailabilityDate":{"type":"string","format":"date-time","description":"Date and time before which data is guaranteed to be available in the datalake. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"TrustRequestCreate":{"type":"object","properties":{"userIds":{"type":"array","description":"The list of trustee users that are requesting access. If no users are specified, at least one group is required.","items":{"type":"string"}},"groupIds":{"type":"array","description":"The list of trustee groups that are requesting access. If no groups are specified, at least one user is required.","items":{"type":"string"}}}},"DigitLength":{"type":"object","properties":{"start":{"type":"string"},"end":{"type":"string"}}},"Number":{"type":"object","properties":{"start":{"type":"string"},"end":{"type":"string"}}},"NumberPlan":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"match":{"type":"string"},"normalizedFormat":{"type":"string"},"priority":{"type":"integer","format":"int32"},"numbers":{"type":"array","items":{"$ref":"#/definitions/Number"}},"digitLength":{"$ref":"#/definitions/DigitLength"},"classification":{"type":"string"},"matchType":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SubscriptionOverviewUsage":{"type":"object","required":["grouping","name","partNumber","prepayQuantity","unitOfMeasureType","usageQuantity"],"properties":{"name":{"type":"string","description":"Product charge name"},"partNumber":{"type":"string","description":"Product part number"},"grouping":{"type":"string","description":"UI grouping key"},"unitOfMeasureType":{"type":"string","description":"UI unit of measure"},"usageQuantity":{"type":"string","description":"Usage count for specified period"},"overagePrice":{"type":"string","description":"Price for usage / overage charge"},"prepayQuantity":{"type":"string","description":"Items prepaid for specified period"},"prepayPrice":{"type":"string","description":"Price for prepay charge"},"usageNotes":{"type":"string","description":"Notes about the usage/charge item"},"isCancellable":{"type":"boolean","description":"Indicates whether the item is cancellable"},"bundleQuantity":{"type":"string","description":"Quantity multiplier for this charge"},"isThirdParty":{"type":"boolean","description":"A charge from a third party entity"}}},"TrusteeBillingOverview":{"type":"object","required":["currency","enabledProducts","organization","subscriptionType","usages"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"organization":{"description":"Organization","$ref":"#/definitions/NamedEntity"},"currency":{"type":"string","description":"The currency type."},"enabledProducts":{"type":"array","description":"The charge short names for products enabled during the specified period.","items":{"type":"string"}},"subscriptionType":{"type":"string","description":"The subscription type.","enum":["ININ","MONTH_TO_MONTH","FREE_TRIAL_MONTH_TO_MONTH","PREPAY_MONTHLY_COMMITMENT","PREPAY","DEV_ORG_MONTH_TO_MONTH","DEV_ORG_PREPAY_MONTHLY_COMMITMENT","DEV_ORG_PREPAY"],"x-genesys-enum-members":[{"name":"ININ"},{"name":"MONTH_TO_MONTH"},{"name":"FREE_TRIAL_MONTH_TO_MONTH"},{"name":"PREPAY_MONTHLY_COMMITMENT"},{"name":"PREPAY"},{"name":"DEV_ORG_MONTH_TO_MONTH"},{"name":"DEV_ORG_PREPAY_MONTHLY_COMMITMENT"},{"name":"DEV_ORG_PREPAY"}]},"rampPeriodStartDate":{"type":"string","format":"date-time","description":"Date-time the ramp period starts. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"rampPeriodEndDate":{"type":"string","format":"date-time","description":"Date-time the ramp period ends. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"billingPeriodStartDate":{"type":"string","format":"date-time","description":"Date-time the billing period started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"billingPeriodEndDate":{"type":"string","format":"date-time","description":"Date-time the billing period ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"usages":{"type":"array","description":"Usages for the specified period.","items":{"$ref":"#/definitions/SubscriptionOverviewUsage"}},"contractAmendmentDate":{"type":"string","format":"date-time","description":"Date-time the contract was last amended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"contractEffectiveDate":{"type":"string","format":"date-time","description":"Date-time the contract became effective. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"contractEndDate":{"type":"string","format":"date-time","description":"Date-time the contract ends. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"minimumMonthlyAmount":{"type":"string","description":"Minimum amount that will be charged for the month"},"inRampPeriod":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PatchActionTarget":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"serviceLevel":{"description":"Service Level of the action target. Chat offers for the target will be throttled with the aim of achieving this service level.","$ref":"#/definitions/ServiceLevel"},"shortAbandonThreshold":{"type":"integer","format":"int32","description":"Indicates the non-default short abandon threshold"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DomainSchemaReference":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SchemaReferenceEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DomainSchemaReference"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"RunNowResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"EdgeMetrics":{"type":"object","properties":{"edge":{"$ref":"#/definitions/DomainEntityRef"},"eventTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"upTimeMsec":{"type":"integer","format":"int64"},"processors":{"type":"array","items":{"$ref":"#/definitions/EdgeMetricsProcessor"}},"memory":{"type":"array","items":{"$ref":"#/definitions/EdgeMetricsMemory"}},"disks":{"type":"array","items":{"$ref":"#/definitions/EdgeMetricsDisk"}},"subsystems":{"type":"array","items":{"$ref":"#/definitions/EdgeMetricsSubsystem"}},"networks":{"type":"array","items":{"$ref":"#/definitions/EdgeMetricsNetwork"}}}},"EdgeMetricsDisk":{"type":"object","properties":{"availableBytes":{"type":"number","format":"double","description":"Available memory in bytes."},"partitionName":{"type":"string","description":"Disk partition name."},"totalBytes":{"type":"number","format":"double","description":"Total memory in bytes."}}},"EdgeMetricsMemory":{"type":"object","properties":{"availableBytes":{"type":"number","format":"double","description":"Available memory in bytes."},"type":{"type":"string","description":"Type of memory. Virtual or physical."},"totalBytes":{"type":"number","format":"double","description":"Total memory in bytes."}}},"EdgeMetricsNetwork":{"type":"object","properties":{"ifname":{"type":"string","description":"Identifier for the network adapter."},"sentBytesPerSec":{"type":"integer","format":"int32","description":"Number of byes sent per second."},"receivedBytesPerSec":{"type":"integer","format":"int32","description":"Number of byes received per second."},"bandwidthBitsPerSec":{"type":"number","format":"double","description":"Total bandwidth of the adapter in bits per second."},"utilizationPct":{"type":"number","format":"double","description":"Percent utilization of the network adapter."}}},"EdgeMetricsProcessor":{"type":"object","properties":{"activeTimePct":{"type":"number","format":"double","description":"Percent time processor was active."},"cpuId":{"type":"string","description":"Machine CPU identifier. 'total' will always be included in the array and is the total of all CPU resources."},"idleTimePct":{"type":"number","format":"double","description":"Percent time processor was idle."},"privilegedTimePct":{"type":"number","format":"double","description":"Percent time processor spent in privileged mode."},"userTimePct":{"type":"number","format":"double","description":"Percent time processor spent in user mode."}}},"EdgeMetricsSubsystem":{"type":"object","properties":{"delayMs":{"type":"integer","format":"int32","description":"Delay in milliseconds."},"processName":{"type":"string","description":"Name of the Edge process."},"mediaSubsystem":{"description":"Subsystem for an Edge device.","$ref":"#/definitions/EdgeMetricsSubsystem"}}},"AvailableTranslations":{"type":"object","properties":{"orgSpecific":{"type":"array","items":{"type":"string"}},"builtin":{"type":"array","items":{"type":"string"}}}},"DomainOrgRoleDifference":{"type":"object","properties":{"removedPermissionPolicies":{"type":"array","items":{"$ref":"#/definitions/DomainPermissionPolicy"}},"addedPermissionPolicies":{"type":"array","items":{"$ref":"#/definitions/DomainPermissionPolicy"}},"samePermissionPolicies":{"type":"array","items":{"$ref":"#/definitions/DomainPermissionPolicy"}},"userOrgRole":{"$ref":"#/definitions/DomainOrganizationRole"},"roleFromDefault":{"$ref":"#/definitions/DomainOrganizationRole"}}},"DevelopmentActivity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"dateCompleted":{"type":"string","format":"date-time","description":"Date that activity was completed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"createdBy":{"description":"User that created activity","readOnly":true,"$ref":"#/definitions/UserReference"},"dateCreated":{"type":"string","format":"date-time","description":"Date activity was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"name":{"type":"string","position":2,"description":"The name of the activity"},"type":{"type":"string","position":3,"description":"The type of activity","enum":["Informational","Coaching"],"x-genesys-enum-members":[{"name":"Informational"},{"name":"Coaching"}]},"status":{"type":"string","position":4,"description":"The status of the activity","enum":["Planned","InProgress","Completed","InvalidSchedule"],"x-genesys-enum-members":[{"name":"Planned"},{"name":"InProgress"},{"name":"Completed"},{"name":"InvalidSchedule"}]},"dateDue":{"type":"string","format":"date-time","position":5,"description":"Due date for completion of the activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"facilitator":{"position":6,"description":"Facilitator of the activity","$ref":"#/definitions/UserReference"},"attendees":{"type":"array","position":7,"description":"List of users attending the activity","items":{"$ref":"#/definitions/UserReference"}},"isOverdue":{"type":"boolean","position":8,"description":"Indicates if the activity is overdue"}},"description":"Development Activity object"},"DevelopmentActivityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DevelopmentActivity"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Action":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"integrationId":{"type":"string","description":"The ID of the integration for which this action is associated"},"category":{"type":"string","description":"Category of Action"},"contract":{"description":"Action contract","$ref":"#/definitions/ActionContract"},"version":{"type":"integer","format":"int32","description":"Version of this action"},"secure":{"type":"boolean","description":"Indication of whether or not the action is designed to accept sensitive data"},"config":{"description":"Configuration to support request and response processing","$ref":"#/definitions/ActionConfig"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ActionConfig":{"type":"object","properties":{"request":{"description":"Configuration of outbound request.","$ref":"#/definitions/RequestConfig"},"response":{"description":"Configuration of response processing.","$ref":"#/definitions/ResponseConfig"}},"description":"Defines components of the Action Config."},"ActionContract":{"type":"object","properties":{"output":{"description":"The output to expect when executing this action.","$ref":"#/definitions/ActionOutput"},"input":{"description":"The input required when executing this action.","$ref":"#/definitions/ActionInput"}},"description":"This resource contains all of the schemas needed to define the inputs and outputs, of a single Action."},"ActionInput":{"type":"object","properties":{"inputSchema":{"description":"JSON Schema that defines the body of the request that the client (edge/architect/postman) is sending to the service, on the /execute path. If the 'flatten' query parameter is omitted or false, this field will be returned. Either inputSchema or inputSchemaFlattened will be returned, not both.","$ref":"#/definitions/JsonSchemaDocument"},"inputSchemaFlattened":{"description":"JSON Schema that defines the body of the request that the client (edge/architect/postman) is sending to the service, on the /execute path. The schema is transformed based on Architect's flattened format. If the 'flatten' query parameter is supplied as true, this field will be returned. Either inputSchema or inputSchemaFlattened will be returned, not both.","$ref":"#/definitions/JsonSchemaDocument"},"inputSchemaUri":{"type":"string","description":"The URI of the input schema"}},"description":"Input requirements of Action."},"ActionOutput":{"type":"object","properties":{"successSchema":{"description":"JSON schema that defines the transformed, successful result that will be sent back to the caller. If the 'flatten' query parameter is omitted or false, this field will be returned. Either successSchema or successSchemaFlattened will be returned, not both.","$ref":"#/definitions/JsonSchemaDocument"},"successSchemaUri":{"type":"string","description":"URI to retrieve success schema"},"errorSchema":{"description":"JSON schema that defines the body of response when request is not successful. If the 'flatten' query parameter is omitted or false, this field will be returned. Either errorSchema or errorSchemaFlattened will be returned, not both.","$ref":"#/definitions/JsonSchemaDocument"},"errorSchemaUri":{"type":"string","description":"URI to retrieve error schema"},"successSchemaFlattened":{"description":"JSON schema that defines the transformed, successful result that will be sent back to the caller. The schema is transformed based on Architect's flattened format. If the 'flatten' query parameter is supplied as true, this field will be returned. Either successSchema or successSchemaFlattened will be returned, not both.","$ref":"#/definitions/JsonSchemaDocument"},"errorSchemaFlattened":{"type":"object","description":"JSON schema that defines the body of response when request is not successful. The schema is transformed based on Architect's flattened format. If the 'flatten' query parameter is supplied as true, this field will be returned. Either errorSchema or errorSchemaFlattened will be returned, not both."}},"description":"Output definition of Action."},"RequestConfig":{"type":"object","properties":{"requestUrlTemplate":{"type":"string","description":"URL that may include placeholders for requests to 3rd party service"},"requestTemplate":{"type":"string","description":"Velocity template to define request body sent to 3rd party service."},"requestTemplateUri":{"type":"string","description":"URI to retrieve requestTemplate"},"requestType":{"type":"string","description":"HTTP method to use for request"},"headers":{"type":"object","description":"Headers to include in request in (Header Name, Value) pairs.","additionalProperties":{"type":"string"}}},"description":"Defines response components of the Action Request."},"ResponseConfig":{"type":"object","properties":{"translationMap":{"type":"object","description":"Map 'attribute name' and 'JSON path' pairs used to extract data from REST response.","additionalProperties":{"type":"string"}},"translationMapDefaults":{"type":"object","description":"Map 'attribute name' and 'default value' pairs used as fallback values if JSON path extraction fails for specified key.","additionalProperties":{"type":"string"}},"successTemplate":{"type":"string","description":"Velocity template to build response to return from Action."},"successTemplateUri":{"type":"string","description":"URI to retrieve success template."}},"description":"Defines response components of the Action Request."},"PublishDraftInput":{"type":"object","required":["version"],"properties":{"version":{"type":"integer","format":"int32","example":"If the current draft version is 2 and the current published version of Action is 33, then you would send 2 here. (Your draft will become published version 34)","description":"The current draft version."}},"description":"Draft to be published"},"DraftValidationResult":{"type":"object","properties":{"valid":{"type":"boolean","description":"Indicates if configuration is valid"},"errors":{"type":"array","description":"List of errors causing validation failure","items":{"$ref":"#/definitions/ErrorBody"}}},"description":"Validation results"},"TestExecutionOperationResult":{"type":"object","properties":{"step":{"type":"integer","format":"int32","description":"The step number to indicate the order in which the operation was performed"},"name":{"type":"string","description":"Name of the operation performed"},"success":{"type":"boolean","description":"Indicated whether or not the operation was successful"},"result":{"type":"object","description":"The result of the operation"},"error":{"description":"Error that occurred during the operation","$ref":"#/definitions/ErrorBody"}}},"TestExecutionResult":{"type":"object","properties":{"operations":{"type":"array","description":"Execution operations performed as part of the test","items":{"$ref":"#/definitions/TestExecutionOperationResult"}},"error":{"description":"The final error encountered during the test that resulted in test failure","$ref":"#/definitions/ErrorBody"},"finalResult":{"type":"object","description":"The final result of the test. This is the response that would be returned during normal action execution"},"success":{"type":"boolean","description":"Indicates whether or not the test was a success"}}},"ActionContractInput":{"type":"object","required":["input","output"],"properties":{"input":{"description":"Execution input contract","$ref":"#/definitions/PostInputContract"},"output":{"description":"Execution output contract","$ref":"#/definitions/PostOutputContract"}},"description":"Contract definition."},"PostInputContract":{"type":"object","required":["inputSchema"],"properties":{"inputSchema":{"description":"JSON Schema that defines the body of the request that the client (edge/architect/postman) is sending to the service, on the /execute path.","$ref":"#/definitions/JsonSchemaDocument"}},"description":"The schemas defining all of the expected requests/inputs."},"PostOutputContract":{"type":"object","required":["successSchema"],"properties":{"successSchema":{"description":"JSON schema that defines the transformed, successful result that will be sent back to the caller.","$ref":"#/definitions/JsonSchemaDocument"}},"description":"The schemas defining all of the expected responses/outputs."},"UpdateDraftInput":{"type":"object","required":["version"],"properties":{"category":{"type":"string","description":"Category of action, Can be up to 256 characters long"},"name":{"type":"string","description":"Name of action, Can be up to 256 characters long"},"config":{"description":"Configuration to support request and response processing","$ref":"#/definitions/ActionConfig"},"contract":{"description":"Action contract","$ref":"#/definitions/ActionContractInput"},"secure":{"type":"boolean","description":"Indication of whether or not the action is designed to accept sensitive data"},"version":{"type":"integer","format":"int32","description":"Version of current Draft"}},"description":"Definition of an Action Draft to be created or updated."},"CursorRelationshipListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Relationship"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"ScimV2SchemaAttribute":{"type":"object","properties":{"name":{"type":"string","description":"The name of the attribute.","readOnly":true},"type":{"type":"string","description":"The data type of the attribute.","readOnly":true,"enum":["STRING","BOOLEAN","DECIMAL","INTEGER","DATE_TIME","REFERENCE","COMPLEX"],"x-genesys-enum-members":[{"name":"STRING"},{"name":"BOOLEAN"},{"name":"DECIMAL"},{"name":"INTEGER"},{"name":"DATE_TIME"},{"name":"REFERENCE"},{"name":"COMPLEX"}]},"subAttributes":{"type":"array","description":"The list of subattributes for an attribute of the type \"complex\". Uses the same schema as \"attributes\".","readOnly":true,"items":{"$ref":"#/definitions/ScimV2SchemaAttribute"}},"multiValued":{"type":"boolean","description":"Indicates whether an attribute contains multiple values.","readOnly":true},"description":{"type":"string","description":"The description of the attribute.","readOnly":true},"required":{"type":"boolean","description":"Indicates whether an attribute is required.","readOnly":true},"canonicalValues":{"type":"array","description":"The list of standard values that service providers may use. Service providers may ignore unsupported values.","readOnly":true,"items":{"type":"string"}},"caseExact":{"type":"boolean","description":"Indicates whether a string attribute is case-sensitive. If set to \"true\", the server preserves case sensitivity. If set to \"false\", the server may change the case. The server also uses case sensitivity when evaluating filters. See section 3.4.2.2 \"Filtering\" in RFC 7644 for details.","readOnly":true},"mutability":{"type":"string","description":"The circumstances under which an attribute can be defined or redefined. The default is \"readWrite\".","readOnly":true,"enum":["readWrite","readOnly","immutable","writeOnly"],"x-genesys-enum-members":[{"name":"readWrite"},{"name":"readOnly"},{"name":"immutable"},{"name":"writeOnly"}]},"returned":{"type":"string","description":"The circumstances under which an attribute and its values are returned in response to a GET, PUT, POST, or PATCH request.","readOnly":true,"enum":["ALWAYS","NEVER","DEFAULT","REQUEST"],"x-genesys-enum-members":[{"name":"ALWAYS"},{"name":"NEVER"},{"name":"DEFAULT"},{"name":"REQUEST"}]},"uniqueness":{"type":"string","description":"The method by which the service provider enforces the uniqueness of an attribute value. A server can reject a value by returning the HTTP response code 400 (Bad Request). A client can enforce uniqueness to a greater degree than the server provider enforces. For example, a client could make a value unique even though the server has \"uniqueness\" set to \"none\".","readOnly":true,"enum":["NONE","SERVER","GLOBAL"],"x-genesys-enum-members":[{"name":"NONE"},{"name":"SERVER"},{"name":"GLOBAL"}]},"referenceTypes":{"type":"array","description":"The list of SCIM resource types that may be referenced. Only applies when \"type\" is set to \"reference\".","readOnly":true,"items":{"type":"string","enum":["USER","GROUP","EXTERNAL","URI"],"x-genesys-enum-members":[{"name":"USER"},{"name":"GROUP"},{"name":"EXTERNAL"},{"name":"URI"}]}}},"description":"A complex type that defines service provider attributes or subattributes and their qualities."},"ScimV2SchemaDefinition":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the SCIM resource. Set by the service provider. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readOnly\". \"returned\" is set to \"always\".","readOnly":true},"name":{"type":"string","description":"The name of the schema.","readOnly":true},"description":{"type":"string","description":"The description of the schema.","readOnly":true},"attributes":{"type":"array","description":"The list of service provider attributes.","readOnly":true,"items":{"$ref":"#/definitions/ScimV2SchemaAttribute"}},"meta":{"description":"The metadata of the SCIM resource. Only \"location\" and \"resourceType\" are set for \"Schema\" resources.","readOnly":true,"$ref":"#/definitions/ScimMetadata"}},"description":"Defines a SCIM schema."},"ScimV2SchemaListResponse":{"type":"object","properties":{"totalResults":{"type":"integer","format":"int64","description":"The total number of results.","readOnly":true},"startIndex":{"type":"integer","format":"int64","description":"The 1-based index of the first result returned by this request. Add this to \"itemsPerPage\" when requesting the next page of results.","readOnly":true},"itemsPerPage":{"type":"integer","format":"int64","description":"The number of resources returned per page.","readOnly":true},"Resources":{"type":"array","description":"The list of requested resources.","readOnly":true,"items":{"$ref":"#/definitions/ScimV2SchemaDefinition"}},"schemas":{"type":"array","description":"The list of supported schemas.","items":{"type":"string"}}},"description":"Defines the list response for SCIM resource types."},"Schedule":{"type":"object","required":["end","name","rrule","start"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"start":{"type":"string","format":"local-date-time","description":"Date time is represented as an ISO-8601 string without a timezone. For example: yyyy-MM-ddTHH:mm:ss.SSS"},"end":{"type":"string","format":"local-date-time","description":"Date time is represented as an ISO-8601 string without a timezone. For example: yyyy-MM-ddTHH:mm:ss.SSS"},"rrule":{"type":"string","description":"An iCal Recurrence Rule (RRULE) string."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Defines a period of time to perform a specific action. Each schedule must be associated with one or more schedule groups to be used."},"ScheduleEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Schedule"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ExtensionPoolEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ExtensionPool"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ReplaceResponse":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"changeNumber":{"type":"integer","format":"int32"},"uploadStatus":{"$ref":"#/definitions/DomainEntityRef"},"uploadDestinationUri":{"type":"string","format":"uri"},"uploadMethod":{"type":"string","enum":["SINGLE_PUT","MULTIPART_POST"],"x-genesys-enum-members":[{"name":"SINGLE_PUT"},{"name":"MULTIPART_POST"}]}}},"ReplaceRequest":{"type":"object","properties":{"changeNumber":{"type":"integer","format":"int32"},"name":{"type":"string"},"authToken":{"type":"string"}}},"Metabase":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string"},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"type":{"type":"string","enum":["EXTERNAL","EXTERNAL_PCV","EXTERNAL_PCV_AWS","EXTERNAL_BYOC_CARRIER","EXTERNAL_BYOC_PBX","STATION_CDM","STATION_CDM_WEBRTC","STATION","TIE","TIE_DIRECT","TIE_INDIRECT","TIE_CLOUD_PROXY"],"x-genesys-enum-members":[{"name":"EXTERNAL"},{"name":"EXTERNAL_PCV"},{"name":"EXTERNAL_PCV_AWS"},{"name":"EXTERNAL_BYOC_CARRIER"},{"name":"EXTERNAL_BYOC_PBX"},{"name":"STATION_CDM"},{"name":"STATION_CDM_WEBRTC"},{"name":"STATION"},{"name":"TIE"},{"name":"TIE_DIRECT"},{"name":"TIE_INDIRECT"},{"name":"TIE_CLOUD_PROXY"}]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TrunkMetabaseEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Metabase"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"SignedUrlResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"url":{"type":"string","format":"url","description":"Url of the downloaded pcap file"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"HomerRecord":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"date":{"type":"string","format":"date-time","description":"metadata associated to the SIP calls. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"milliTs":{"type":"string","description":"metadata associated to the SIP calls"},"microTs":{"type":"string","description":"metadata associated to the SIP calls"},"method":{"type":"string","description":"metadata associated to the SIP calls"},"replyReason":{"type":"string","description":"metadata associated to the SIP calls"},"ruri":{"type":"string","description":"metadata associated to the SIP calls"},"ruriUser":{"type":"string","description":"metadata associated to the SIP calls"},"ruriDomain":{"type":"string","description":"metadata associated to the SIP calls"},"fromUser":{"type":"string","description":"metadata associated to the SIP calls"},"fromDomain":{"type":"string","description":"metadata associated to the SIP calls"},"fromTag":{"type":"string","description":"metadata associated to the SIP calls"},"toUser":{"type":"string","description":"metadata associated to the SIP calls"},"toDomain":{"type":"string","description":"metadata associated to the SIP calls"},"toTag":{"type":"string","description":"metadata associated to the SIP calls"},"pidUser":{"type":"string","description":"metadata associated to the SIP calls"},"contactUser":{"type":"string","description":"metadata associated to the SIP calls"},"authUser":{"type":"string","description":"metadata associated to the SIP calls"},"callid":{"type":"string","description":"metadata associated to the SIP calls"},"callidAleg":{"type":"string","description":"metadata associated to the SIP calls"},"via1":{"type":"string","description":"metadata associated to the SIP calls"},"via1Branch":{"type":"string","description":"metadata associated to the SIP calls"},"cseq":{"type":"string","description":"metadata associated to the SIP calls"},"diversion":{"type":"string","description":"metadata associated to the SIP calls"},"reason":{"type":"string","description":"metadata associated to the SIP calls"},"contentType":{"type":"string","description":"metadata associated to the SIP calls"},"auth":{"type":"string","description":"metadata associated to the SIP calls"},"userAgent":{"type":"string","description":"metadata associated to the SIP calls"},"sourceIp":{"type":"string","description":"metadata associated to the SIP calls"},"sourcePort":{"type":"string","description":"metadata associated to the SIP calls"},"destinationIp":{"type":"string","description":"metadata associated to the SIP calls"},"destinationPort":{"type":"string","description":"metadata associated to the SIP calls"},"contactIp":{"type":"string","description":"metadata associated to the SIP calls"},"contactPort":{"type":"string","description":"metadata associated to the SIP calls"},"originatorIp":{"type":"string","description":"metadata associated to the SIP calls"},"originatorPort":{"type":"string","description":"metadata associated to the SIP calls"},"correlationId":{"type":"string","description":"metadata associated to the SIP calls"},"proto":{"type":"string","description":"metadata associated to the SIP calls"},"family":{"type":"string","description":"metadata associated to the SIP calls"},"rtpStat":{"type":"string","description":"metadata associated to the SIP calls"},"type":{"type":"string","description":"metadata associated to the SIP calls"},"node":{"type":"string","description":"metadata associated to the SIP calls"},"trans":{"type":"string","description":"metadata associated to the SIP calls"},"dbnode":{"type":"string","description":"metadata associated to the SIP calls"},"msg":{"type":"string","description":"metadata associated to the SIP calls"},"sourceAlias":{"type":"string","description":"metadata associated to the SIP calls"},"destinationAlias":{"type":"string","description":"metadata associated to the SIP calls"},"conversationId":{"type":"string","description":"metadata associated to the SIP calls"},"participantId":{"type":"string","description":"metadata associated to the SIP calls"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SipSearchResult":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"status":{"type":"integer","format":"int32","description":"Status of the search request"},"sid":{"type":"string","description":"Session id associated to the search request"},"auth":{"type":"string","description":"Auth token used for this search request"},"message":{"type":"string","description":"Any messages returned from homer as part of the response"},"data":{"type":"array","description":"Homer search data that is returned","items":{"$ref":"#/definitions/HomerRecord"}},"count":{"type":"integer","format":"int32","description":"Number of records returned"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SipDownloadResponse":{"type":"object","properties":{"downloadId":{"type":"string","description":"unique id of the downloaded file"},"documentId":{"type":"string","description":"Document id of pcap file"}}},"SIPSearchPublicRequest":{"type":"object","required":["dateEnd","dateStart"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"callId":{"type":"string","description":"unique identification of the placed call"},"toUser":{"type":"string","description":"SIP user to who the call was placed"},"fromUser":{"type":"string","description":"SIP user who placed the call"},"conversationId":{"type":"string","description":"Unique identification of the conversation"},"participantId":{"type":"string","description":"Unique identification of the participant"},"dateStart":{"type":"string","format":"date-time","description":"Start date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateEnd":{"type":"string","format":"date-time","description":"End date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"JourneyAggregateDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/StatisticalResponse"}}}},"JourneyAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/JourneyAggregateDataContainer"}}}},"JourneyAggregateQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/JourneyAggregateQueryPredicate"}}}},"JourneyAggregateQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/JourneyAggregateQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/JourneyAggregateQueryPredicate"}}}},"JourneyAggregateQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"],"x-genesys-enum-members":[{"name":"dimension"},{"name":"property"},{"name":"metric"}]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["journeyActionId","journeyActionMapId","journeyActionMapVersion","journeyActionMediaType","journeyActionTemplateId","journeyCustomerId","journeyCustomerIdType","journeyDeviceCategory","journeyDeviceType","journeyOutcomeId","journeySegmentId","journeySegmentScope","journeySessionSegmentId","journeySessionType","touchpointActionMapId"],"x-genesys-enum-members":[{"name":"journeyActionId"},{"name":"journeyActionMapId"},{"name":"journeyActionMapVersion"},{"name":"journeyActionMediaType"},{"name":"journeyActionTemplateId"},{"name":"journeyCustomerId"},{"name":"journeyCustomerIdType"},{"name":"journeyDeviceCategory"},{"name":"journeyDeviceType"},{"name":"journeyOutcomeId"},{"name":"journeySegmentId"},{"name":"journeySegmentScope"},{"name":"journeySessionSegmentId"},{"name":"journeySessionType"},{"name":"touchpointActionMapId"}]},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"],"x-genesys-enum-members":[{"name":"matches"},{"name":"exists"},{"name":"notExists"}]},"value":{"type":"string","description":"Right hand side for dimension predicates"},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"JourneyAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["journeyActionId","journeyActionMapId","journeyActionMapVersion","journeyActionMediaType","journeyActionTemplateId","journeyCustomerId","journeyCustomerIdType","journeyDeviceCategory","journeyDeviceType","journeyOutcomeId","journeySegmentId","journeySegmentScope","journeySessionSegmentId","journeySessionType","touchpointActionMapId"],"x-genesys-enum-members":[{"name":"journeyActionId"},{"name":"journeyActionMapId"},{"name":"journeyActionMapVersion"},{"name":"journeyActionMediaType"},{"name":"journeyActionTemplateId"},{"name":"journeyCustomerId"},{"name":"journeyCustomerIdType"},{"name":"journeyDeviceCategory"},{"name":"journeyDeviceType"},{"name":"journeyOutcomeId"},{"name":"journeySegmentId"},{"name":"journeySegmentScope"},{"name":"journeySessionSegmentId"},{"name":"journeySessionType"},{"name":"touchpointActionMapId"}]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/JourneyAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nJourneyOutcomesAchieved","nJourneyOutcomesAttributed","nJourneySegmentsAssigned","nJourneySessions","nWebActionsAbandoned","nWebActionsAccepted","nWebActionsEngaged","nWebActionsErrored","nWebActionsIgnored","nWebActionsOffered","nWebActionsQualified","nWebActionsQualifiedOutsideSchedule","nWebActionsRejected","nWebActionsStarted","nWebActionsTimedout","nWebActionsFrequencyCapReached","nWebActionsOfferedOutsideSchedule"],"x-genesys-enum-members":[{"name":"nJourneyOutcomesAchieved"},{"name":"nJourneyOutcomesAttributed"},{"name":"nJourneySegmentsAssigned"},{"name":"nJourneySessions"},{"name":"nWebActionsAbandoned"},{"name":"nWebActionsAccepted"},{"name":"nWebActionsEngaged"},{"name":"nWebActionsErrored"},{"name":"nWebActionsIgnored"},{"name":"nWebActionsOffered"},{"name":"nWebActionsQualified"},{"name":"nWebActionsQualifiedOutsideSchedule"},{"name":"nWebActionsRejected"},{"name":"nWebActionsStarted"},{"name":"nWebActionsTimedout"},{"name":"nWebActionsFrequencyCapReached"},{"name":"nWebActionsOfferedOutsideSchedule"}]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/JourneyAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"],"x-genesys-enum-members":[{"name":"eventTime"}]}}},"JourneyAggregationView":{"type":"object","required":["function","name","target"],"properties":{"target":{"type":"string","description":"Target metric name","enum":["nJourneyOutcomesAchieved","nJourneyOutcomesAttributed","nJourneySegmentsAssigned","nJourneySessions","nWebActionsAbandoned","nWebActionsAccepted","nWebActionsEngaged","nWebActionsErrored","nWebActionsIgnored","nWebActionsOffered","nWebActionsQualified","nWebActionsQualifiedOutsideSchedule","nWebActionsRejected","nWebActionsStarted","nWebActionsTimedout","nWebActionsFrequencyCapReached","nWebActionsOfferedOutsideSchedule"],"x-genesys-enum-members":[{"name":"nJourneyOutcomesAchieved"},{"name":"nJourneyOutcomesAttributed"},{"name":"nJourneySegmentsAssigned"},{"name":"nJourneySessions"},{"name":"nWebActionsAbandoned"},{"name":"nWebActionsAccepted"},{"name":"nWebActionsEngaged"},{"name":"nWebActionsErrored"},{"name":"nWebActionsIgnored"},{"name":"nWebActionsOffered"},{"name":"nWebActionsQualified"},{"name":"nWebActionsQualifiedOutsideSchedule"},{"name":"nWebActionsRejected"},{"name":"nWebActionsStarted"},{"name":"nWebActionsTimedout"},{"name":"nWebActionsFrequencyCapReached"},{"name":"nWebActionsOfferedOutsideSchedule"}]},"name":{"type":"string","description":"A unique name for this view. Must be distinct from other views and built-in metric names."},"function":{"type":"string","description":"Type of view you wish to create","enum":["rangeBound"],"x-genesys-enum-members":[{"name":"rangeBound"}]},"range":{"description":"Range of numbers for slicing up data","$ref":"#/definitions/AggregationRange"}}},"LexBotEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/LexBot"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ADFS":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"disabled":{"type":"boolean"},"issuerURI":{"type":"string"},"ssoTargetURI":{"type":"string"},"certificate":{"type":"string"},"certificates":{"type":"array","items":{"type":"string"}},"relyingPartyIdentifier":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TranscriptUrl":{"type":"object","properties":{"url":{"type":"string","description":"The pre-signed S3 URL of the transcript"}}},"UserProfileEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UserProfile"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ConsumingResourcesEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Dependency"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"OAuthProviderEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/OAuthProvider"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"PolicyCreate":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The policy name."},"modifiedDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"createdDate":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"order":{"type":"integer","format":"int32"},"description":{"type":"string"},"enabled":{"type":"boolean"},"mediaPolicies":{"description":"Conditions and actions per media type","$ref":"#/definitions/MediaPolicies"},"conditions":{"description":"Conditions","$ref":"#/definitions/PolicyConditions"},"actions":{"description":"Actions","$ref":"#/definitions/PolicyActions"},"policyErrors":{"$ref":"#/definitions/PolicyErrors"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OutboundRouteBase":{"type":"object","required":["classificationTypes","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the entity."},"description":{"type":"string","description":"The resource's description."},"version":{"type":"integer","format":"int32","description":"The current version of the resource."},"dateCreated":{"type":"string","format":"date-time","description":"The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"type":"string","description":"The ID of the user that last modified the resource."},"createdBy":{"type":"string","description":"The ID of the user that created the resource."},"state":{"type":"string","description":"Indicates if the resource is active, inactive, or deleted.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"modifiedByApp":{"type":"string","description":"The application that last modified the resource."},"createdByApp":{"type":"string","description":"The application that created the resource."},"classificationTypes":{"type":"array","description":"The site associated to the outbound route.","items":{"type":"string"}},"enabled":{"type":"boolean"},"distribution":{"type":"string","enum":["SEQUENTIAL","RANDOM"],"x-genesys-enum-members":[{"name":"SEQUENTIAL"},{"name":"RANDOM"}]},"externalTrunkBases":{"type":"array","description":"Trunk base settings of trunkType \"EXTERNAL\". This base must also be set on an edge logical interface for correct routing.","items":{"$ref":"#/definitions/DomainEntityRef"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"OutboundRouteBaseEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/OutboundRouteBase"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ExternalOrganizationListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ExternalOrganization"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CredentialInfoListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CredentialInfo"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Condition":{"type":"object","properties":{"type":{"type":"string","description":"The type of the condition.","enum":["wrapupCondition","contactAttributeCondition","phoneNumberCondition","phoneNumberTypeCondition","callAnalysisCondition","contactPropertyCondition","dataActionCondition"],"x-genesys-enum-members":[{"name":"wrapupCondition"},{"name":"contactAttributeCondition"},{"name":"phoneNumberCondition"},{"name":"phoneNumberTypeCondition"},{"name":"callAnalysisCondition"},{"name":"contactPropertyCondition"},{"name":"dataActionCondition"}]},"inverted":{"type":"boolean","description":"If true, inverts the result of evaluating this Condition. Default is false."},"attributeName":{"type":"string","description":"An attribute name associated with this Condition. Required for a contactAttributeCondition."},"value":{"type":"string","description":"A value associated with this Condition. This could be text, a number, or a relative time. Not used for a DataActionCondition."},"valueType":{"type":"string","description":"The type of the value associated with this Condition. Not used for a DataActionCondition.","enum":["STRING","NUMERIC","DATETIME","PERIOD"],"x-genesys-enum-members":[{"name":"STRING"},{"name":"NUMERIC"},{"name":"DATETIME"},{"name":"PERIOD"}]},"operator":{"type":"string","description":"An operation with which to evaluate the Condition. Not used for a DataActionCondition.","enum":["EQUALS","LESS_THAN","LESS_THAN_EQUALS","GREATER_THAN","GREATER_THAN_EQUALS","CONTAINS","BEGINS_WITH","ENDS_WITH","BEFORE","AFTER","IN"],"x-genesys-enum-members":[{"name":"EQUALS"},{"name":"LESS_THAN"},{"name":"LESS_THAN_EQUALS"},{"name":"GREATER_THAN"},{"name":"GREATER_THAN_EQUALS"},{"name":"CONTAINS"},{"name":"BEGINS_WITH"},{"name":"ENDS_WITH"},{"name":"BEFORE"},{"name":"AFTER"},{"name":"IN"}]},"codes":{"type":"array","description":"List of wrap-up code identifiers. Required for a wrapupCondition.","items":{"type":"string"}},"property":{"type":"string","description":"A value associated with the property type of this Condition. Required for a contactPropertyCondition."},"propertyType":{"type":"string","description":"The type of the property associated with this Condition. Required for a contactPropertyCondition.","enum":["LAST_ATTEMPT_BY_COLUMN","LAST_ATTEMPT_OVERALL","LAST_WRAPUP_BY_COLUMN","LAST_WRAPUP_OVERALL"],"x-genesys-enum-members":[{"name":"LAST_ATTEMPT_BY_COLUMN"},{"name":"LAST_ATTEMPT_OVERALL"},{"name":"LAST_WRAPUP_BY_COLUMN"},{"name":"LAST_WRAPUP_OVERALL"}]}}},"ContactColumnToDataActionFieldMapping":{"type":"object","properties":{}},"DataActionConditionPredicate":{"type":"object","properties":{}},"DialerAction":{"type":"object","required":["actionTypeName","type"],"properties":{"type":{"type":"string","description":"The type of this DialerAction.","enum":["Action","modifyContactAttribute"],"x-genesys-enum-members":[{"name":"Action"},{"name":"modifyContactAttribute"}]},"actionTypeName":{"type":"string","description":"Additional type specification for this DialerAction.","enum":["DO_NOT_DIAL","MODIFY_CONTACT_ATTRIBUTE","SWITCH_TO_PREVIEW","APPEND_NUMBER_TO_DNC_LIST","SCHEDULE_CALLBACK","CONTACT_UNCALLABLE","NUMBER_UNCALLABLE","SET_CALLER_ID","SET_SKILLS"],"x-genesys-enum-members":[{"name":"DO_NOT_DIAL"},{"name":"MODIFY_CONTACT_ATTRIBUTE"},{"name":"SWITCH_TO_PREVIEW"},{"name":"APPEND_NUMBER_TO_DNC_LIST"},{"name":"SCHEDULE_CALLBACK"},{"name":"CONTACT_UNCALLABLE"},{"name":"NUMBER_UNCALLABLE"},{"name":"SET_CALLER_ID"},{"name":"SET_SKILLS"}]},"updateOption":{"type":"string","description":"Specifies how a contact attribute should be updated. Required for MODIFY_CONTACT_ATTRIBUTE.","enum":["SET","INCREMENT","DECREMENT","CURRENT_TIME"],"x-genesys-enum-members":[{"name":"SET"},{"name":"INCREMENT"},{"name":"DECREMENT"},{"name":"CURRENT_TIME"}]},"properties":{"type":"object","description":"A map of key-value pairs pertinent to the DialerAction. Different types of DialerActions require different properties. MODIFY_CONTACT_ATTRIBUTE with an updateOption of SET takes a contact column as the key and accepts any value. SCHEDULE_CALLBACK takes a key 'callbackOffset' that specifies how far in the future the callback should be scheduled, in minutes. SET_CALLER_ID takes two keys: 'callerAddress', which should be the caller id phone number, and 'callerName'. For either key, you can also specify a column on the contact to get the value from. To do this, specify 'contact.Column', where 'Column' is the name of the contact column from which to get the value. SET_SKILLS takes a key 'skills' with an array of skill ids wrapped into a string (Example: {'skills': '['skillIdHere']'} ).","additionalProperties":{"type":"string"}}}},"DialerRule":{"type":"object","required":["category","conditions","name"],"properties":{"id":{"type":"string","description":"The identifier of the rule.","readOnly":true},"name":{"type":"string","description":"The name of the rule."},"order":{"type":"integer","format":"int32","description":"The ranked order of the rule. Rules are processed from lowest number to highest."},"category":{"type":"string","description":"The category of the rule.","enum":["DIALER_PRECALL","DIALER_WRAPUP"],"x-genesys-enum-members":[{"name":"DIALER_PRECALL"},{"name":"DIALER_WRAPUP"}]},"conditions":{"type":"array","description":"A list of Conditions. All of the Conditions must evaluate to true to trigger the actions.","items":{"$ref":"#/definitions/Condition"}},"actions":{"type":"array","description":"The list of actions to be taken if the conditions are true.","items":{"$ref":"#/definitions/DialerAction"}}}},"RuleSet":{"type":"object","required":["name","rules"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the RuleSet."},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"contactList":{"description":"A ContactList to provide user-interface suggestions for contact columns on relevant conditions and actions.","$ref":"#/definitions/DomainEntityRef"},"queue":{"description":"A Queue to provide user-interface suggestions for wrap-up codes on relevant conditions and actions.","$ref":"#/definitions/DomainEntityRef"},"rules":{"type":"array","description":"The list of rules.","items":{"$ref":"#/definitions/DialerRule"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SurveyAggregateDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/StatisticalResponse"}}}},"SurveyAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/SurveyAggregateDataContainer"}}}},"SurveyAggregateQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/SurveyAggregateQueryPredicate"}}}},"SurveyAggregateQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/SurveyAggregateQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/SurveyAggregateQueryPredicate"}}}},"SurveyAggregateQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"],"x-genesys-enum-members":[{"name":"dimension"},{"name":"property"},{"name":"metric"}]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["conversationId","divisionId","externalContactId","mediaType","queueId","requestedLanguageId","requestedRoutingSkillId","surveyAnswerId","surveyCreatedDate","surveyErrorReason","surveyFormContextId","surveyFormId","surveyFormName","surveyId","surveyPreviousStatus","surveyPromoterScore","surveyQuestionGroupId","surveyQuestionId","surveyStatus","teamId","userId","wrapUpCode"],"x-genesys-enum-members":[{"name":"conversationId"},{"name":"divisionId"},{"name":"externalContactId"},{"name":"mediaType"},{"name":"queueId"},{"name":"requestedLanguageId"},{"name":"requestedRoutingSkillId"},{"name":"surveyAnswerId"},{"name":"surveyCreatedDate"},{"name":"surveyErrorReason"},{"name":"surveyFormContextId"},{"name":"surveyFormId"},{"name":"surveyFormName"},{"name":"surveyId"},{"name":"surveyPreviousStatus"},{"name":"surveyPromoterScore"},{"name":"surveyQuestionGroupId"},{"name":"surveyQuestionId"},{"name":"surveyStatus"},{"name":"teamId"},{"name":"userId"},{"name":"wrapUpCode"}]},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"],"x-genesys-enum-members":[{"name":"matches"},{"name":"exists"},{"name":"notExists"}]},"value":{"type":"string","description":"Right hand side for dimension predicates"},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"SurveyAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["conversationId","divisionId","externalContactId","mediaType","queueId","requestedLanguageId","requestedRoutingSkillId","surveyAnswerId","surveyCreatedDate","surveyErrorReason","surveyFormContextId","surveyFormId","surveyFormName","surveyId","surveyPreviousStatus","surveyPromoterScore","surveyQuestionGroupId","surveyQuestionId","surveyStatus","teamId","userId","wrapUpCode"],"x-genesys-enum-members":[{"name":"conversationId"},{"name":"divisionId"},{"name":"externalContactId"},{"name":"mediaType"},{"name":"queueId"},{"name":"requestedLanguageId"},{"name":"requestedRoutingSkillId"},{"name":"surveyAnswerId"},{"name":"surveyCreatedDate"},{"name":"surveyErrorReason"},{"name":"surveyFormContextId"},{"name":"surveyFormId"},{"name":"surveyFormName"},{"name":"surveyId"},{"name":"surveyPreviousStatus"},{"name":"surveyPromoterScore"},{"name":"surveyQuestionGroupId"},{"name":"surveyQuestionId"},{"name":"surveyStatus"},{"name":"teamId"},{"name":"userId"},{"name":"wrapUpCode"}]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/SurveyAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nSurveyErrors","nSurveyNpsDetractors","nSurveyNpsPromoters","nSurveyNpsResponses","nSurveyQuestionGroupResponses","nSurveyQuestionResponses","nSurveyResponses","nSurveysAbandoned","nSurveysDeleted","nSurveysExpired","nSurveysSent","nSurveysStarted","oSurveyQuestionGroupScore","oSurveyQuestionScore","oSurveyTotalScore"],"x-genesys-enum-members":[{"name":"nSurveyErrors"},{"name":"nSurveyNpsDetractors"},{"name":"nSurveyNpsPromoters"},{"name":"nSurveyNpsResponses"},{"name":"nSurveyQuestionGroupResponses"},{"name":"nSurveyQuestionResponses"},{"name":"nSurveyResponses"},{"name":"nSurveysAbandoned"},{"name":"nSurveysDeleted"},{"name":"nSurveysExpired"},{"name":"nSurveysSent"},{"name":"nSurveysStarted"},{"name":"oSurveyQuestionGroupScore"},{"name":"oSurveyQuestionScore"},{"name":"oSurveyTotalScore"}]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/SurveyAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime","surveyCreatedDate"],"x-genesys-enum-members":[{"name":"eventTime"},{"name":"surveyCreatedDate"}]}}},"SurveyAggregationView":{"type":"object","required":["function","name","target"],"properties":{"target":{"type":"string","description":"Target metric name","enum":["nSurveyErrors","nSurveyNpsDetractors","nSurveyNpsPromoters","nSurveyNpsResponses","nSurveyQuestionGroupResponses","nSurveyQuestionResponses","nSurveyResponses","nSurveysAbandoned","nSurveysDeleted","nSurveysExpired","nSurveysSent","nSurveysStarted","oSurveyQuestionGroupScore","oSurveyQuestionScore","oSurveyTotalScore"],"x-genesys-enum-members":[{"name":"nSurveyErrors"},{"name":"nSurveyNpsDetractors"},{"name":"nSurveyNpsPromoters"},{"name":"nSurveyNpsResponses"},{"name":"nSurveyQuestionGroupResponses"},{"name":"nSurveyQuestionResponses"},{"name":"nSurveyResponses"},{"name":"nSurveysAbandoned"},{"name":"nSurveysDeleted"},{"name":"nSurveysExpired"},{"name":"nSurveysSent"},{"name":"nSurveysStarted"},{"name":"oSurveyQuestionGroupScore"},{"name":"oSurveyQuestionScore"},{"name":"oSurveyTotalScore"}]},"name":{"type":"string","description":"A unique name for this view. Must be distinct from other views and built-in metric names."},"function":{"type":"string","description":"Type of view you wish to create","enum":["rangeBound"],"x-genesys-enum-members":[{"name":"rangeBound"}]},"range":{"description":"Range of numbers for slicing up data","$ref":"#/definitions/AggregationRange"}}},"BusinessUnitActivityCode":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"active":{"type":"boolean","description":"Whether this activity code is active or has been deleted"},"defaultCode":{"type":"boolean","description":"Whether this is a default activity code"},"category":{"type":"string","description":"The category of the activity code","enum":["OnQueueWork","Break","Meal","Meeting","OffQueueWork","TimeOff","Training","Unavailable","Unscheduled"],"x-genesys-enum-members":[{"name":"OnQueueWork"},{"name":"Break"},{"name":"Meal"},{"name":"Meeting"},{"name":"OffQueueWork"},{"name":"TimeOff"},{"name":"Training"},{"name":"Unavailable"},{"name":"Unscheduled"}]},"lengthInMinutes":{"type":"integer","format":"int32","description":"The default length of the activity in minutes"},"countsAsPaidTime":{"type":"boolean","description":"Whether an agent is paid while performing this activity"},"countsAsWorkTime":{"type":"boolean","description":"Indicates whether or not the activity should be counted as contiguous work time for calculating daily constraints"},"agentTimeOffSelectable":{"type":"boolean","description":"Whether an agent can select this activity code when creating or editing a time off request. Null if the activity's category is not time off."},"metadata":{"description":"Version metadata of this activity code","$ref":"#/definitions/WfmVersionedEntityMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Activity code data"},"CreateActivityCodeRequest":{"type":"object","required":["category","name"],"properties":{"name":{"type":"string","description":"The name of the activity code"},"category":{"type":"string","description":"The activity code's category","enum":["OnQueueWork","Break","Meal","Meeting","OffQueueWork","TimeOff","Training","Unavailable","Unscheduled"],"x-genesys-enum-members":[{"name":"OnQueueWork"},{"name":"Break"},{"name":"Meal"},{"name":"Meeting"},{"name":"OffQueueWork"},{"name":"TimeOff"},{"name":"Training"},{"name":"Unavailable"},{"name":"Unscheduled"}]},"lengthInMinutes":{"type":"integer","format":"int32","description":"The default length of the activity in minutes"},"countsAsPaidTime":{"type":"boolean","description":"Whether an agent is paid while performing this activity"},"countsAsWorkTime":{"type":"boolean","description":"Indicates whether or not the activity should be counted as work time"},"agentTimeOffSelectable":{"type":"boolean","description":"Whether an agent can select this activity code when creating or editing a time off request"}},"description":"Activity Code"},"UpdateActivityCodeRequest":{"type":"object","required":["metadata"],"properties":{"name":{"type":"string","description":"The name of the activity code"},"category":{"type":"string","description":"The activity code's category. Attempting to change the category of a default activity code will return an error","enum":["OnQueueWork","Break","Meal","Meeting","OffQueueWork","TimeOff","Training","Unavailable","Unscheduled"],"x-genesys-enum-members":[{"name":"OnQueueWork"},{"name":"Break"},{"name":"Meal"},{"name":"Meeting"},{"name":"OffQueueWork"},{"name":"TimeOff"},{"name":"Training"},{"name":"Unavailable"},{"name":"Unscheduled"}]},"lengthInMinutes":{"type":"integer","format":"int32","description":"The default length of the activity in minutes"},"countsAsPaidTime":{"type":"boolean","description":"Whether an agent is paid while performing this activity"},"countsAsWorkTime":{"type":"boolean","description":"Indicates whether or not the activity should be counted as work time"},"agentTimeOffSelectable":{"type":"boolean","description":"Whether an agent can select this activity code when creating or editing a time off request"},"metadata":{"description":"Version metadata for the associated business unit's list of activity codes","$ref":"#/definitions/WfmVersionedEntityMetadata"}},"description":"Activity Code"},"BusinessUnitActivityCodeListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/BusinessUnitActivityCode"}}},"description":"List of BusinessUnitActivityCode"},"PatchOutcome":{"type":"object","required":["displayName"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"isActive":{"type":"boolean","description":"Whether or not the outcome is active."},"displayName":{"type":"string","description":"The display name of the outcome."},"version":{"type":"integer","format":"int32","description":"The version of the outcome."},"description":{"type":"string","description":"A description of the outcome."},"isPositive":{"type":"boolean","description":"Whether or not the outcome is positive."},"context":{"description":"The context of the outcome.","$ref":"#/definitions/Context"},"journey":{"description":"The pattern of rules defining the filter of the outcome.","$ref":"#/definitions/Journey"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"createdDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the outcome was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedDate":{"type":"string","format":"date-time","description":"Timestamp indicating when the outcome was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"CoachingAppointmentResponseList":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CoachingAppointmentResponse"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CoachingAnnotationCreateRequest":{"type":"object","required":["accessType","text"],"properties":{"text":{"type":"string","description":"The text of the annotation."},"accessType":{"type":"string","description":"Determines the permissions required to view this item.","enum":["Public","Private"],"x-genesys-enum-members":[{"name":"Public"},{"name":"Private"}]}}},"CoachingAnnotationList":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CoachingAnnotation"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"SegmentListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/JourneySegment"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"BuAbandonRate":{"type":"object","required":["include"],"properties":{"include":{"type":"boolean","description":"Whether to include abandon rate in the associated configuration"},"percent":{"type":"integer","format":"int32","description":"Abandon rate percent goal. Required if include == true"}},"description":"Service goal abandon rate configuration"},"BuAverageSpeedOfAnswer":{"type":"object","required":["include"],"properties":{"include":{"type":"boolean","description":"Whether to include average speed of answer (ASA) in the associated configuration"},"seconds":{"type":"integer","format":"int32","description":"The target average speed of answer (ASA) in seconds. Required if include == true"}},"description":"Service goal average speed of answer configuration"},"BuServiceLevel":{"type":"object","required":["include"],"properties":{"include":{"type":"boolean","description":"Whether to include service level targets in the associated configuration"},"percent":{"type":"integer","format":"int32","description":"Service level target percent answered. Required if include == true"},"seconds":{"type":"integer","format":"int32","description":"Service level target answer time. Required if include == true"}},"description":"Service goal service level configuration"},"ServiceGoalTemplate":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"serviceLevel":{"description":"Service level targets for this service goal template","$ref":"#/definitions/BuServiceLevel"},"averageSpeedOfAnswer":{"description":"Average speed of answer targets for this service goal template","$ref":"#/definitions/BuAverageSpeedOfAnswer"},"abandonRate":{"description":"Abandon rate targets for this service goal template","$ref":"#/definitions/BuAbandonRate"},"metadata":{"description":"Version metadata for the service goal template","$ref":"#/definitions/WfmVersionedEntityMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Service Goal Template"},"UpdateServiceGoalTemplate":{"type":"object","required":["metadata"],"properties":{"name":{"type":"string","description":"The name of the service goal template."},"serviceLevel":{"description":"Service level targets for this service goal template","$ref":"#/definitions/BuServiceLevel"},"averageSpeedOfAnswer":{"description":"Average speed of answer targets for this service goal template","$ref":"#/definitions/BuAverageSpeedOfAnswer"},"abandonRate":{"description":"Abandon rate targets for this service goal template","$ref":"#/definitions/BuAbandonRate"},"metadata":{"description":"Version metadata for the service goal template","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"ServiceGoalTemplateList":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ServiceGoalTemplate"}}},"description":"List of service goal templates"},"CreateServiceGoalTemplate":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The name of the service goal template."},"serviceLevel":{"description":"Service level targets for this service goal template","$ref":"#/definitions/BuServiceLevel"},"averageSpeedOfAnswer":{"description":"Average speed of answer targets for this service goal template","$ref":"#/definitions/BuAverageSpeedOfAnswer"},"abandonRate":{"description":"Abandon rate targets for this service goal template","$ref":"#/definitions/BuAbandonRate"}}},"CampaignStats":{"type":"object","properties":{"contactRate":{"description":"Information regarding the campaign's connect rate","readOnly":true,"$ref":"#/definitions/ConnectRate"},"idleAgents":{"type":"integer","format":"int32","description":"Number of available agents not currently being utilized","readOnly":true},"effectiveIdleAgents":{"type":"number","format":"double","description":"Number of effective available agents not currently being utilized","readOnly":true},"adjustedCallsPerAgent":{"type":"number","format":"double","description":"Calls per agent adjusted by pace","readOnly":true},"outstandingCalls":{"type":"integer","format":"int32","description":"Number of campaign calls currently ongoing","readOnly":true},"scheduledCalls":{"type":"integer","format":"int32","description":"Number of campaign calls currently scheduled","readOnly":true}}},"ConnectRate":{"type":"object","properties":{"attempts":{"type":"integer","format":"int64","description":"Number of call attempts made","readOnly":true},"connects":{"type":"integer","format":"int64","description":"Number of calls with a live voice detected","readOnly":true},"connectRatio":{"type":"number","format":"double","description":"Ratio of connects to attempts","readOnly":true}}},"ContactListDivisionViewListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ContactListDivisionView"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"WfmHistoricalAdherenceQuery":{"type":"object","required":["startDate"],"properties":{"startDate":{"type":"string","format":"date-time","description":"Beginning of the date range to query in ISO-8601 format"},"endDate":{"type":"string","format":"date-time","description":"End of the date range to query in ISO-8601 format. If it is not set, end date will be set to current time"},"timeZone":{"type":"string","description":"The time zone to use for returned results in olson format. If it is not set, the business unit time zone will be used to compute adherence"},"userIds":{"type":"array","description":"The userIds to report on. If null or not set, adherence will be computed for all the users in management unit or requested teamIds","uniqueItems":true,"items":{"type":"string"}},"includeExceptions":{"type":"boolean","description":"Whether user exceptions should be returned as part of the results"},"teamIds":{"type":"array","description":"The teamIds to report on. If null or not set, adherence will be computed for requested users if applicable or otherwise all users in the management unit. Note: If teamIds is also specified, only adherence for users in the requested teams will be returned","uniqueItems":true,"items":{"type":"string"}}}},"EdgeLineEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/EdgeLine"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FlowAggregateDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/StatisticalResponse"}}}},"FlowAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/FlowAggregateDataContainer"}}}},"FlowAggregateQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/FlowAggregateQueryPredicate"}}}},"FlowAggregateQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/FlowAggregateQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/FlowAggregateQueryPredicate"}}}},"FlowAggregateQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"],"x-genesys-enum-members":[{"name":"dimension"},{"name":"property"},{"name":"metric"}]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["addressFrom","addressTo","agentAssistantId","agentRank","agentScore","ani","assignerId","conversationId","convertedFrom","convertedTo","direction","disconnectType","divisionId","dnis","edgeId","endingLanguage","entryReason","entryType","exitReason","externalContactId","externalMediaCount","externalOrganizationId","firstQueue","flaggedReason","flowId","flowInType","flowMilestoneId","flowName","flowOutType","flowOutcome","flowOutcomeId","flowOutcomeValue","flowType","flowVersion","groupId","interactionType","journeyActionId","journeyActionMapId","journeyActionMapVersion","journeyCustomerId","journeyCustomerIdType","journeyCustomerSessionId","journeyCustomerSessionIdType","mediaCount","mediaType","messageType","originatingDirection","outboundCampaignId","outboundContactId","outboundContactListId","participantName","peerId","proposedAgentId","provider","purpose","queueId","remote","reoffered","requestedLanguageId","requestedRouting","requestedRoutingSkillId","roomId","routingPriority","scoredAgentId","selectedAgentId","selectedAgentRank","sessionDnis","sessionId","startingLanguage","stationId","teamId","transferTargetAddress","transferTargetName","transferType","usedRouting","userId","wrapUpCode"],"x-genesys-enum-members":[{"name":"addressFrom"},{"name":"addressTo"},{"name":"agentAssistantId"},{"name":"agentRank"},{"name":"agentScore"},{"name":"ani"},{"name":"assignerId"},{"name":"conversationId"},{"name":"convertedFrom"},{"name":"convertedTo"},{"name":"direction"},{"name":"disconnectType"},{"name":"divisionId"},{"name":"dnis"},{"name":"edgeId"},{"name":"endingLanguage"},{"name":"entryReason"},{"name":"entryType"},{"name":"exitReason"},{"name":"externalContactId"},{"name":"externalMediaCount"},{"name":"externalOrganizationId"},{"name":"firstQueue"},{"name":"flaggedReason"},{"name":"flowId"},{"name":"flowInType"},{"name":"flowMilestoneId"},{"name":"flowName"},{"name":"flowOutType"},{"name":"flowOutcome"},{"name":"flowOutcomeId"},{"name":"flowOutcomeValue"},{"name":"flowType"},{"name":"flowVersion"},{"name":"groupId"},{"name":"interactionType"},{"name":"journeyActionId"},{"name":"journeyActionMapId"},{"name":"journeyActionMapVersion"},{"name":"journeyCustomerId"},{"name":"journeyCustomerIdType"},{"name":"journeyCustomerSessionId"},{"name":"journeyCustomerSessionIdType"},{"name":"mediaCount"},{"name":"mediaType"},{"name":"messageType"},{"name":"originatingDirection"},{"name":"outboundCampaignId"},{"name":"outboundContactId"},{"name":"outboundContactListId"},{"name":"participantName"},{"name":"peerId"},{"name":"proposedAgentId"},{"name":"provider"},{"name":"purpose"},{"name":"queueId"},{"name":"remote"},{"name":"reoffered"},{"name":"requestedLanguageId"},{"name":"requestedRouting"},{"name":"requestedRoutingSkillId"},{"name":"roomId"},{"name":"routingPriority"},{"name":"scoredAgentId"},{"name":"selectedAgentId"},{"name":"selectedAgentRank"},{"name":"sessionDnis"},{"name":"sessionId"},{"name":"startingLanguage"},{"name":"stationId"},{"name":"teamId"},{"name":"transferTargetAddress"},{"name":"transferTargetName"},{"name":"transferType"},{"name":"usedRouting"},{"name":"userId"},{"name":"wrapUpCode"}]},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"],"x-genesys-enum-members":[{"name":"matches"},{"name":"exists"},{"name":"notExists"}]},"value":{"type":"string","description":"Right hand side for dimension predicates"},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"FlowAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["addressFrom","addressTo","agentAssistantId","agentRank","agentScore","ani","assignerId","conversationId","convertedFrom","convertedTo","direction","disconnectType","divisionId","dnis","edgeId","endingLanguage","entryReason","entryType","exitReason","externalContactId","externalMediaCount","externalOrganizationId","firstQueue","flaggedReason","flowId","flowInType","flowMilestoneId","flowName","flowOutType","flowOutcome","flowOutcomeId","flowOutcomeValue","flowType","flowVersion","groupId","interactionType","journeyActionId","journeyActionMapId","journeyActionMapVersion","journeyCustomerId","journeyCustomerIdType","journeyCustomerSessionId","journeyCustomerSessionIdType","mediaCount","mediaType","messageType","originatingDirection","outboundCampaignId","outboundContactId","outboundContactListId","participantName","peerId","proposedAgentId","provider","purpose","queueId","remote","reoffered","requestedLanguageId","requestedRouting","requestedRoutingSkillId","roomId","routingPriority","scoredAgentId","selectedAgentId","selectedAgentRank","sessionDnis","sessionId","startingLanguage","stationId","teamId","transferTargetAddress","transferTargetName","transferType","usedRouting","userId","wrapUpCode"],"x-genesys-enum-members":[{"name":"addressFrom"},{"name":"addressTo"},{"name":"agentAssistantId"},{"name":"agentRank"},{"name":"agentScore"},{"name":"ani"},{"name":"assignerId"},{"name":"conversationId"},{"name":"convertedFrom"},{"name":"convertedTo"},{"name":"direction"},{"name":"disconnectType"},{"name":"divisionId"},{"name":"dnis"},{"name":"edgeId"},{"name":"endingLanguage"},{"name":"entryReason"},{"name":"entryType"},{"name":"exitReason"},{"name":"externalContactId"},{"name":"externalMediaCount"},{"name":"externalOrganizationId"},{"name":"firstQueue"},{"name":"flaggedReason"},{"name":"flowId"},{"name":"flowInType"},{"name":"flowMilestoneId"},{"name":"flowName"},{"name":"flowOutType"},{"name":"flowOutcome"},{"name":"flowOutcomeId"},{"name":"flowOutcomeValue"},{"name":"flowType"},{"name":"flowVersion"},{"name":"groupId"},{"name":"interactionType"},{"name":"journeyActionId"},{"name":"journeyActionMapId"},{"name":"journeyActionMapVersion"},{"name":"journeyCustomerId"},{"name":"journeyCustomerIdType"},{"name":"journeyCustomerSessionId"},{"name":"journeyCustomerSessionIdType"},{"name":"mediaCount"},{"name":"mediaType"},{"name":"messageType"},{"name":"originatingDirection"},{"name":"outboundCampaignId"},{"name":"outboundContactId"},{"name":"outboundContactListId"},{"name":"participantName"},{"name":"peerId"},{"name":"proposedAgentId"},{"name":"provider"},{"name":"purpose"},{"name":"queueId"},{"name":"remote"},{"name":"reoffered"},{"name":"requestedLanguageId"},{"name":"requestedRouting"},{"name":"requestedRoutingSkillId"},{"name":"roomId"},{"name":"routingPriority"},{"name":"scoredAgentId"},{"name":"selectedAgentId"},{"name":"selectedAgentRank"},{"name":"sessionDnis"},{"name":"sessionId"},{"name":"startingLanguage"},{"name":"stationId"},{"name":"teamId"},{"name":"transferTargetAddress"},{"name":"transferTargetName"},{"name":"transferType"},{"name":"usedRouting"},{"name":"userId"},{"name":"wrapUpCode"}]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/FlowAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nFlow","nFlowMilestone","nFlowOutcome","nFlowOutcomeFailed","oFlowMilestone","tFlow","tFlowDisconnect","tFlowExit","tFlowOutcome"],"x-genesys-enum-members":[{"name":"nFlow"},{"name":"nFlowMilestone"},{"name":"nFlowOutcome"},{"name":"nFlowOutcomeFailed"},{"name":"oFlowMilestone"},{"name":"tFlow"},{"name":"tFlowDisconnect"},{"name":"tFlowExit"},{"name":"tFlowOutcome"}]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/FlowAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"],"x-genesys-enum-members":[{"name":"eventTime"}]}}},"FlowAggregationView":{"type":"object","required":["function","name","target"],"properties":{"target":{"type":"string","description":"Target metric name","enum":["nFlow","nFlowMilestone","nFlowOutcome","nFlowOutcomeFailed","oFlowMilestone","tFlow","tFlowDisconnect","tFlowExit","tFlowOutcome"],"x-genesys-enum-members":[{"name":"nFlow"},{"name":"nFlowMilestone"},{"name":"nFlowOutcome"},{"name":"nFlowOutcomeFailed"},{"name":"oFlowMilestone"},{"name":"tFlow"},{"name":"tFlowDisconnect"},{"name":"tFlowExit"},{"name":"tFlowOutcome"}]},"name":{"type":"string","description":"A unique name for this view. Must be distinct from other views and built-in metric names."},"function":{"type":"string","description":"Type of view you wish to create","enum":["rangeBound"],"x-genesys-enum-members":[{"name":"rangeBound"}]},"range":{"description":"Range of numbers for slicing up data","$ref":"#/definitions/AggregationRange"}}},"FlowObservationDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/ObservationMetricData"}}}},"FlowObservationQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/FlowObservationDataContainer"}}}},"FlowObservationQuery":{"type":"object","required":["filter","metrics"],"properties":{"filter":{"description":"Filter to return a subset of observations. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/FlowObservationQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["oFlow"],"x-genesys-enum-members":[{"name":"oFlow"}]}},"detailMetrics":{"type":"array","description":"Metrics for which to include additional detailed observations","items":{"type":"string","enum":["oFlow"],"x-genesys-enum-members":[{"name":"oFlow"}]}}}},"FlowObservationQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/FlowObservationQueryPredicate"}}}},"FlowObservationQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/FlowObservationQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/FlowObservationQueryPredicate"}}}},"FlowObservationQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"],"x-genesys-enum-members":[{"name":"dimension"},{"name":"property"},{"name":"metric"}]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["flowId","mediaType"],"x-genesys-enum-members":[{"name":"flowId"},{"name":"mediaType"}]},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"],"x-genesys-enum-members":[{"name":"matches"},{"name":"exists"},{"name":"notExists"}]},"value":{"type":"string","description":"Right hand side for dimension predicates"},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"CampaignRule":{"type":"object","required":["campaignRuleActions","campaignRuleConditions","campaignRuleEntities","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the CampaignRule."},"dateCreated":{"type":"string","format":"date-time","description":"Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"dateModified":{"type":"string","format":"date-time","description":"Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"version":{"type":"integer","format":"int32","description":"Required for updates, must match the version number of the most recent update"},"campaignRuleEntities":{"description":"The list of entities that this CampaignRule monitors.","$ref":"#/definitions/CampaignRuleEntities"},"campaignRuleConditions":{"type":"array","description":"The list of conditions that are evaluated on the entities.","items":{"$ref":"#/definitions/CampaignRuleCondition"}},"campaignRuleActions":{"type":"array","description":"The list of actions that are executed if the conditions are satisfied.","items":{"$ref":"#/definitions/CampaignRuleAction"}},"matchAnyConditions":{"type":"boolean"},"enabled":{"type":"boolean","description":"Whether or not this CampaignRule is currently enabled. Required on updates."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CampaignRuleAction":{"type":"object","required":["actionType","campaignRuleActionEntities"],"properties":{"id":{"type":"string"},"parameters":{"description":"The parameters for the CampaignRuleAction. Required for certain actionTypes.","$ref":"#/definitions/CampaignRuleParameters"},"actionType":{"type":"string","description":"The action to take on the campaignRuleActionEntities.","enum":["turnOnCampaign","turnOffCampaign","turnOnSequence","turnOffSequence","setCampaignPriority","recycleCampaign","setCampaignDialingMode"],"x-genesys-enum-members":[{"name":"turnOnCampaign"},{"name":"turnOffCampaign"},{"name":"turnOnSequence"},{"name":"turnOffSequence"},{"name":"setCampaignPriority"},{"name":"recycleCampaign"},{"name":"setCampaignDialingMode"}]},"campaignRuleActionEntities":{"description":"The list of entities that this action will apply to.","$ref":"#/definitions/CampaignRuleActionEntities"}}},"CampaignRuleActionEntities":{"type":"object","properties":{"campaigns":{"type":"array","description":"The list of campaigns for a CampaignRule to monitor. Required if the CampaignRule has any conditions that run on a campaign.","items":{"$ref":"#/definitions/DomainEntityRef"}},"sequences":{"type":"array","description":"The list of sequences for a CampaignRule to monitor. Required if the CampaignRule has any conditions that run on a sequence.","items":{"$ref":"#/definitions/DomainEntityRef"}},"useTriggeringEntity":{"type":"boolean","description":"If true, the CampaignRuleAction will apply to the same entity that triggered the CampaignRuleCondition."}}},"CampaignRuleCondition":{"type":"object","required":["conditionType","parameters"],"properties":{"id":{"type":"string"},"parameters":{"description":"The parameters for the CampaignRuleCondition.","$ref":"#/definitions/CampaignRuleParameters"},"conditionType":{"type":"string","description":"The type of condition to evaluate.","enum":["campaignProgress","campaignAgents"],"x-genesys-enum-members":[{"name":"campaignProgress"},{"name":"campaignAgents"}]}}},"CampaignRuleEntities":{"type":"object","properties":{"campaigns":{"type":"array","description":"The list of campaigns for a CampaignRule to monitor. Required if the CampaignRule has any conditions that run on a campaign.","items":{"$ref":"#/definitions/DomainEntityRef"}},"sequences":{"type":"array","description":"The list of sequences for a CampaignRule to monitor. Required if the CampaignRule has any conditions that run on a sequence.","items":{"$ref":"#/definitions/DomainEntityRef"}}}},"CampaignRuleParameters":{"type":"object","properties":{"operator":{"type":"string","description":"The operator for comparison. Required for a CampaignRuleCondition.","enum":["equals","greaterThan","greaterThanEqualTo","lessThan","lessThanEqualTo"],"x-genesys-enum-members":[{"name":"equals"},{"name":"greaterThan"},{"name":"greaterThanEqualTo"},{"name":"lessThan"},{"name":"lessThanEqualTo"}]},"value":{"type":"string","description":"The value for comparison. Required for a CampaignRuleCondition."},"priority":{"type":"string","description":"The priority to set a campaign to. Required for the 'setCampaignPriority' action.","enum":["1","2","3","4","5"],"x-genesys-enum-members":[{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},"dialingMode":{"type":"string","description":"The dialing mode to set a campaign to. Required for the 'setCampaignDialingMode' action.","enum":["agentless","preview","power","predictive","progressive","external"],"x-genesys-enum-members":[{"name":"agentless"},{"name":"preview"},{"name":"power"},{"name":"predictive"},{"name":"progressive"},{"name":"external"}]}}},"CampaignRuleEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CampaignRule"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AuthzDivisionEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AuthzDivision"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"OutcomeListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Outcome"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ClientApp":{"type":"object","required":["intendedState"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the integration, used to distinguish this integration from others of the same type.","readOnly":true},"integrationType":{"description":"Type of the integration","readOnly":true,"$ref":"#/definitions/IntegrationType"},"notes":{"type":"string","description":"Notes about the integration.","readOnly":true},"intendedState":{"type":"string","description":"Configured state of the integration.","enum":["ENABLED","DISABLED","DELETED"],"x-genesys-enum-members":[{"name":"ENABLED"},{"name":"DISABLED"},{"name":"DELETED"}]},"config":{"description":"Configuration information for the integration.","readOnly":true,"$ref":"#/definitions/ClientAppConfigurationInfo"},"reportedState":{"description":"Last reported status of the integration.","readOnly":true,"$ref":"#/definitions/IntegrationStatusInfo"},"attributes":{"type":"object","description":"Read-only attributes for the integration.","readOnly":true,"additionalProperties":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Details for a ClientApp"},"ClientAppConfigurationInfo":{"type":"object","properties":{"current":{"description":"The current, active configuration for the integration.","readOnly":true,"$ref":"#/definitions/IntegrationConfiguration"},"effective":{"description":"The effective configuration for the app, containing the integration specific configuration along with overrides specified in the integration type.","readOnly":true,"$ref":"#/definitions/EffectiveConfiguration"}},"description":"Configuration information for the integration"},"ClientAppEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ClientApp"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EffectiveConfiguration":{"type":"object","required":["advanced","credentials","name","notes","properties"],"properties":{"properties":{"type":"object","description":"Key-value configuration settings described by the schema in the propertiesSchemaUri field.","additionalProperties":{"type":"object"}},"advanced":{"type":"object","description":"Advanced configuration described by the schema in the advancedSchemaUri field.","additionalProperties":{"type":"object"}},"name":{"type":"string","description":"The name of the integration, used to distinguish this integration from others of the same type."},"notes":{"type":"string","description":"Notes about the integration."},"credentials":{"type":"object","description":"Credentials required by the integration. The required keys are indicated in the credentials property of the Integration Type","additionalProperties":{"$ref":"#/definitions/CredentialInfo"}}},"description":"Effective Configuration for an ClientApp. This is comprised of the integration specific configuration along with overrides specified in the integration type."},"GroupEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Group"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"GroupCreate":{"type":"object","required":["name","rulesVisible","type","visibility"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The group name."},"description":{"type":"string"},"dateModified":{"type":"string","format":"date-time","description":"Last modified date/time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"memberCount":{"type":"integer","format":"int64","description":"Number of members.","readOnly":true},"state":{"type":"string","description":"Active, inactive, or deleted state.","readOnly":true,"enum":["active","inactive","deleted"],"x-genesys-enum-members":[{"name":"active"},{"name":"inactive"},{"name":"deleted"}]},"version":{"type":"integer","format":"int32","description":"Current version for this resource.","readOnly":true},"type":{"type":"string","description":"Type of group.","enum":["official","social"],"x-genesys-enum-members":[{"name":"official"},{"name":"social"}]},"images":{"type":"array","items":{"$ref":"#/definitions/UserImage"}},"addresses":{"type":"array","items":{"$ref":"#/definitions/GroupContact"}},"rulesVisible":{"type":"boolean","description":"Are membership rules visible to the person requesting to view the group"},"visibility":{"type":"string","description":"Who can view this group","enum":["public","owners","members"]},"ownerIds":{"type":"array","description":"Owners of the group","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PostActionInput":{"type":"object","required":["category","config","contract","integrationId","name"],"properties":{"category":{"type":"string","description":"Category of action, Can be up to 256 characters long"},"name":{"type":"string","description":"Name of action, Can be up to 256 characters long"},"integrationId":{"type":"string","description":"The ID of the integration this action is associated to"},"config":{"description":"Configuration to support request and response processing","$ref":"#/definitions/ActionConfig"},"contract":{"description":"Action contract","$ref":"#/definitions/ActionContractInput"},"secure":{"type":"boolean","description":"Indication of whether or not the action is designed to accept sensitive data"}},"description":"Definition of an Action to be created or updated."},"ActionEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Action"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"BuShortTermForecastingSettings":{"type":"object","properties":{"defaultHistoryWeeks":{"type":"integer","format":"int32","description":"The number of historical weeks to consider when creating a forecast. This setting is only used for legacy weighted average forecasts"}}},"BusinessUnit":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"settings":{"description":"Settings for this business unit","$ref":"#/definitions/BusinessUnitSettings"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BusinessUnitSettings":{"type":"object","required":["metadata","startDayOfWeek","timeZone"],"properties":{"startDayOfWeek":{"type":"string","description":"The start day of week for this business unit","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"x-genesys-enum-members":[{"name":"Sunday"},{"name":"Monday"},{"name":"Tuesday"},{"name":"Wednesday"},{"name":"Thursday"},{"name":"Friday"},{"name":"Saturday"}]},"timeZone":{"type":"string","description":"The time zone for this business unit, using the Olsen tz database format"},"shortTermForecasting":{"description":"Short term forecasting settings","$ref":"#/definitions/BuShortTermForecastingSettings"},"metadata":{"description":"Version metadata for this business unit","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"UpdateBusinessUnitRequest":{"type":"object","properties":{"name":{"type":"string","description":"The name of the business unit"},"divisionId":{"type":"string","description":"The ID of the division to which the business unit should be moved"},"settings":{"description":"Configuration for the business unit","$ref":"#/definitions/UpdateBusinessUnitSettings"}}},"UpdateBusinessUnitSettings":{"type":"object","required":["metadata"],"properties":{"startDayOfWeek":{"type":"string","description":"The start day of week for this business unit","readOnly":true,"enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"x-genesys-enum-members":[{"name":"Sunday"},{"name":"Monday"},{"name":"Tuesday"},{"name":"Wednesday"},{"name":"Thursday"},{"name":"Friday"},{"name":"Saturday"}]},"timeZone":{"type":"string","description":"The time zone for this business unit, using the Olsen tz database format","readOnly":true},"shortTermForecasting":{"description":"Short term forecasting settings","$ref":"#/definitions/BuShortTermForecastingSettings"},"metadata":{"description":"Version metadata for this business unit","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"TagValueEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/TagValue"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"TagQueryRequest":{"type":"object","properties":{"query":{"type":"string"},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"}}},"DIDEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DID"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"KeywordSetEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/KeywordSet"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CopyVoicemailMessage":{"type":"object","required":["voicemailMessageId"],"properties":{"voicemailMessageId":{"type":"string","description":"The id of the VoicemailMessage to copy"},"userId":{"type":"string","description":"The id of the User to copy the VoicemailMessage to"},"groupId":{"type":"string","description":"The id of the Group to copy the VoicemailMessage to"}},"description":"Used to copy a VoicemailMessage to either a User or a Group"},"DocumentListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/KnowledgeDocument"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"KnowledgeDocumentBulkRequest":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Document type according to assigned template","enum":["Faq"],"x-genesys-enum-members":[{"name":"Faq"}]},"externalUrl":{"type":"string","description":"External Url to the document"},"faq":{"description":"Faq document details","$ref":"#/definitions/DocumentFaq"},"categories":{"type":"array","description":"Document categories","items":{"$ref":"#/definitions/DocumentCategoryInput"}},"id":{"type":"string","description":"Identifier of document for update. Omit for create new Document."}}},"FlowExecutionLaunchResponse":{"type":"object","properties":{"id":{"type":"string","description":"The flow execution ID"},"name":{"type":"string","description":"The flow execution name."},"flowVersion":{"description":"The version of the flow that launched","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Response object from launching a flow."},"FlowExecutionLaunchRequest":{"type":"object","required":["flowId"],"properties":{"flowId":{"type":"string","description":"ID of the flow to launch."},"flowVersion":{"type":"string","description":"The version of the flow to launch. Omit this value (or supply null/empty) to use the latest published version."},"inputData":{"type":"object","description":"Input values to the flow. Valid values are defined by a flow's input JSON schema.","additionalProperties":{"type":"object"}},"name":{"type":"string","description":"A displayable name to assign to the new flow execution"}},"description":"Parameters for launching a flow."},"UserApp":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the userApp, used to distinguish this userApp from others of the same type.","readOnly":true},"integrationType":{"description":"Integration Type for the userApp","readOnly":true,"$ref":"#/definitions/IntegrationType"},"config":{"$ref":"#/definitions/UserAppConfigurationInfo"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Details for a UserApp"},"UserAppConfigurationInfo":{"type":"object","properties":{"current":{"description":"The current, active configuration for the integration.","readOnly":true,"$ref":"#/definitions/IntegrationConfiguration"},"effective":{"description":"The effective configuration for the app, containing the integration specific configuration along with overrides specified in the integration type.","readOnly":true,"$ref":"#/definitions/EffectiveConfiguration"}},"description":"Configuration information for the integration"},"UserAppEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UserApp"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AuditQueryResponse":{"type":"object"},"Facet":{"type":"object","required":["name","type"],"properties":{"name":{"type":"string","description":"The name of the field on which to facet."},"type":{"type":"string","description":"The type of the facet, DATE or STRING."}}},"Filter":{"type":"object","required":["name","operator","type","values"],"properties":{"name":{"type":"string","description":"The name of the field by which to filter."},"type":{"type":"string","description":"The type of the filter, DATE or STRING."},"operator":{"type":"string","description":"The operation that the filter performs."},"values":{"type":"array","description":"The values to make the filter comparison against.","items":{"type":"string"}}}},"TrustorAuditQueryRequest":{"type":"object","required":["trusteeUserIds","trustorOrganizationId"],"properties":{"trustorOrganizationId":{"type":"string","description":"Limit returned audits to this trustor organizationId."},"trusteeUserIds":{"type":"array","description":"Limit returned audits to these trustee userIds.","items":{"type":"string"}},"startDate":{"type":"string","format":"date-time","description":"Starting date/time for the audit search. ISO-8601 formatted date-time, UTC."},"endDate":{"type":"string","format":"date-time","description":"Ending date/time for the audit search. ISO-8601 formatted date-time, UTC."},"queryPhrase":{"type":"string","description":"Word or phrase to look for in audit bodies."},"facets":{"type":"array","description":"Facet information to be returned with the query results.","items":{"$ref":"#/definitions/Facet"}},"filters":{"type":"array","description":"Additional custom filters to be applied to the query.","items":{"$ref":"#/definitions/Filter"}}}},"OrganizationFeatures":{"type":"object","properties":{"realtimeCIC":{"type":"boolean"},"purecloud":{"type":"boolean"},"hipaa":{"type":"boolean"},"ucEnabled":{"type":"boolean"},"pci":{"type":"boolean"},"purecloudVoice":{"type":"boolean"},"xmppFederation":{"type":"boolean"},"chat":{"type":"boolean"},"informalPhotos":{"type":"boolean"},"directory":{"type":"boolean"},"contactCenter":{"type":"boolean"},"unifiedCommunications":{"type":"boolean"},"custserv":{"type":"boolean"}}},"FeatureState":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"Station":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"status":{"type":"string","enum":["AVAILABLE","ASSOCIATED"],"x-genesys-enum-members":[{"name":"AVAILABLE"},{"name":"ASSOCIATED"}]},"userId":{"type":"string","description":"The Id of the user currently logged in and associated with the station."},"webRtcUserId":{"type":"string","description":"The Id of the user configured for the station if it is of type inin_webrtc_softphone. Empty if station type is not inin_webrtc_softphone."},"primaryEdge":{"$ref":"#/definitions/DomainEntityRef"},"secondaryEdge":{"$ref":"#/definitions/DomainEntityRef"},"type":{"type":"string"},"lineAppearanceId":{"type":"string"},"webRtcMediaDscp":{"type":"integer","format":"int32","description":"The default or configured value of media dscp for the station. Empty if station type is not inin_webrtc_softphone.","readOnly":true},"webRtcPersistentEnabled":{"type":"boolean","description":"The default or configured value of persistent connection setting for the station. Empty if station type is not inin_webrtc_softphone.","readOnly":true},"webRtcForceTurn":{"type":"boolean","description":"Whether the station is configured to require TURN for routing WebRTC calls. Empty if station type is not inin_webrtc_softphone.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"StationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Station"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"LocationsSearchResponse":{"type":"object","required":["pageCount","pageNumber","pageSize","results","total","types"],"properties":{"total":{"type":"integer","format":"int64","description":"The total number of results found"},"pageCount":{"type":"integer","format":"int32","description":"The total number of pages"},"pageSize":{"type":"integer","format":"int32","description":"The current page size"},"pageNumber":{"type":"integer","format":"int32","description":"The current page number"},"previousPage":{"type":"string","description":"Q64 value for the previous page of results"},"currentPage":{"type":"string","description":"Q64 value for the current page of results"},"nextPage":{"type":"string","description":"Q64 value for the next page of results"},"types":{"type":"array","description":"Resource types the search was performed against","items":{"type":"string"}},"results":{"type":"array","description":"Search results","items":{"$ref":"#/definitions/LocationDefinition"}}}},"LocationSearchCriteria":{"type":"object","required":["type"],"properties":{"endValue":{"type":"string","description":"The end value of the range. This field is used for range search types."},"values":{"type":"array","description":"A list of values for the search to match against","items":{"type":"string"}},"startValue":{"type":"string","description":"The start value of the range. This field is used for range search types."},"fields":{"type":"array","description":"Field names to search against","items":{"type":"string"}},"value":{"type":"string","description":"A value for the search to match against"},"operator":{"type":"string","description":"How to apply this search criteria against other criteria","enum":["AND","OR","NOT"],"x-genesys-enum-members":[{"name":"AND"},{"name":"OR"},{"name":"NOT"}]},"group":{"type":"array","description":"Groups multiple conditions","items":{"$ref":"#/definitions/LocationSearchCriteria"}},"dateFormat":{"type":"string","description":"Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."},"type":{"type":"string","description":"Search Type","enum":["EXACT","STARTS_WITH","CONTAINS","REGEX","TERM","TERMS","REQUIRED_FIELDS","MATCH_ALL"],"x-genesys-enum-members":[{"name":"EXACT"},{"name":"STARTS_WITH"},{"name":"CONTAINS"},{"name":"REGEX"},{"name":"TERM"},{"name":"TERMS"},{"name":"REQUIRED_FIELDS"},{"name":"MATCH_ALL"}]}}},"LocationSearchRequest":{"type":"object","properties":{"sortOrder":{"type":"string","description":"The sort order for results","enum":["ASC","DESC","SCORE"],"x-genesys-enum-members":[{"name":"ASC"},{"name":"DESC"},{"name":"SCORE"}]},"sortBy":{"type":"string","description":"The field in the resource that you want to sort the results by"},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"},"pageNumber":{"type":"integer","format":"int32","description":"The page of resources you want to retrieve"},"sort":{"type":"array","description":"Multi-value sort order, list of multiple sort values","items":{"$ref":"#/definitions/SearchSort"}},"expand":{"type":"array","description":"Provides more details about a specified resource","items":{"type":"string"}},"query":{"type":"array","items":{"$ref":"#/definitions/LocationSearchCriteria"}}}},"LocalEncryptionKeyRequest":{"type":"object","required":["configId","keypairId","publicKey"],"properties":{"configId":{"type":"string","description":"The local configuration id that contains metadata on private local service"},"publicKey":{"type":"string","description":"Base 64 encoded public key, generated by the local service."},"keypairId":{"type":"string","description":"The key pair id from the local service."}}},"WebChatConfig":{"type":"object","properties":{"webChatSkin":{"type":"string","description":"css class to be applied to the web chat widget.","enum":["basic","modern-caret-skin"],"x-genesys-enum-members":[{"name":"basic"},{"name":"modern-caret-skin"}]}}},"WebChatDeployment":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"authenticationRequired":{"type":"boolean"},"authenticationUrl":{"type":"string","description":"URL for third party service authenticating web chat clients. See https://github.com/MyPureCloud/authenticated-web-chat-server-examples"},"disabled":{"type":"boolean"},"webChatConfig":{"$ref":"#/definitions/WebChatConfig"},"allowedDomains":{"type":"array","items":{"type":"string"}},"flow":{"description":"The URI of the Inbound Chat Flow to run when new chats are initiated under this Deployment.","$ref":"#/definitions/DomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PingIdentity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"disabled":{"type":"boolean"},"issuerURI":{"type":"string"},"ssoTargetURI":{"type":"string"},"certificate":{"type":"string"},"certificates":{"type":"array","items":{"type":"string"}},"relyingPartyIdentifier":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ListedProgram":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"published":{"type":"boolean"},"topicsCount":{"type":"integer","format":"int32"},"tags":{"type":"array","items":{"type":"string"}},"modifiedBy":{"$ref":"#/definitions/AddressableEntityRef"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ProgramsEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ListedProgram"}},"pageSize":{"type":"integer","format":"int32"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Program":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"published":{"type":"boolean"},"topics":{"type":"array","items":{"$ref":"#/definitions/BaseTopicEntitiy"}},"tags":{"type":"array","items":{"type":"string"}},"modifiedBy":{"$ref":"#/definitions/AddressableEntityRef"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"publishedBy":{"$ref":"#/definitions/AddressableEntityRef"},"datePublished":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ProgramRequest":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The program name"},"description":{"type":"string","description":"The program description"},"topicIds":{"type":"array","description":"The ids of topics associated to the program","items":{"type":"string"}},"tags":{"type":"array","description":"The program tags","items":{"type":"string"}}}},"PhoneMetaBaseEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Metabase"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"BuAsyncScheduleRunResponse":{"type":"object","properties":{"status":{"type":"string","description":"The status of the operation","enum":["Processing","Complete","Canceled","Error"],"x-genesys-enum-members":[{"name":"Processing"},{"name":"Complete"},{"name":"Canceled"},{"name":"Error"}]},"operationId":{"type":"string","description":"The ID for the operation"},"result":{"description":"The result of the operation. Null unless status == Complete","$ref":"#/definitions/BuScheduleRun"}}},"BuRescheduleRequest":{"type":"object","required":["doNotChangeDailyPaidTime","doNotChangeManuallyEditedShifts","doNotChangeShiftStartTimes","doNotChangeWeeklyPaidTime","managementUnitIds"],"properties":{"startDate":{"type":"string","format":"date-time","description":"The start of the range to reschedule. Defaults to the beginning of the schedule. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endDate":{"type":"string","format":"date-time","description":"The end of the range to reschedule. Defaults the the end of the schedule. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"agentIds":{"type":"array","description":"The IDs of the agents to consider for rescheduling. Omit to consider all agents in the specified management units.Agents not in the specified management units will be ignored","items":{"type":"string"}},"activityCodeIds":{"type":"array","description":"The IDs of the activity codes to consider for rescheduling. Omit to consider all activity codes","items":{"type":"string"}},"managementUnitIds":{"type":"array","description":"The IDs of the management units to reschedule","items":{"type":"string"}},"doNotChangeWeeklyPaidTime":{"type":"boolean","description":"Instructs the scheduler whether it is allowed to change weekly paid time"},"doNotChangeDailyPaidTime":{"type":"boolean","description":"Instructs the scheduler whether it is allowed to change daily paid time"},"doNotChangeShiftStartTimes":{"type":"boolean","description":"Instructs the scheduler whether it is allowed to change shift start times"},"doNotChangeManuallyEditedShifts":{"type":"boolean","description":"Instructs the scheduler whether it is allowed to change manually edited shifts"}}},"SchedulingTestingOptionsRequest":{"type":"object","properties":{"fastScheduling":{"type":"boolean","description":"Whether to enable fast scheduling"},"delayScheduling":{"type":"boolean","description":"Whether to force delayed scheduling"},"failScheduling":{"type":"boolean","description":"Whether to force scheduling to fail"},"populateWarnings":{"type":"boolean","description":"Whether to populate warnings in the generated schedule"}}},"BuManagementUnitScheduleSummary":{"type":"object","properties":{"managementUnit":{"description":"The management unit to which this summary applies","$ref":"#/definitions/ManagementUnitReference"},"agentCount":{"type":"integer","format":"int32","description":"The number of agents from this management unit that are in the schedule"},"startDate":{"type":"string","format":"date-time","description":"The start of the schedule change in the management unit. Only populated in schedule update notifications. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"endDate":{"type":"string","format":"date-time","description":"The end of the schedule change in the management unit. Only populated in schedule update notifications. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"agents":{"type":"array","description":"The agents in the management unit who are part of this schedule, or in schedule change notifications, the agents that were changed. Note this will come back as an empty list unless the appropriate expand query parameter is passed","items":{"$ref":"#/definitions/UserReference"}}}},"BuScheduleMetadata":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"weekDate":{"type":"string","format":"date","description":"The start week date for this schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"weekCount":{"type":"integer","format":"int32","description":"The number of weeks spanned by this schedule"},"description":{"type":"string","description":"The description of this schedule"},"published":{"type":"boolean","description":"Whether this schedule is published"},"shortTermForecast":{"description":"The forecast used for this schedule, if applicable","$ref":"#/definitions/BuShortTermForecastReference"},"generationResults":{"description":"Generation result summary for this schedule, if applicable","$ref":"#/definitions/ScheduleGenerationResultSummary"},"metadata":{"description":"Version metadata for this schedule","$ref":"#/definitions/WfmVersionedEntityMetadata"},"managementUnits":{"type":"array","description":"High level per-management unit schedule metadata","items":{"$ref":"#/definitions/BuManagementUnitScheduleSummary"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ScheduleGenerationResultSummary":{"type":"object","properties":{"failed":{"type":"boolean","description":"Whether the schedule generation run failed"},"runId":{"type":"string","description":"The run ID for the schedule generation. Reference this when requesting support"},"messageCount":{"type":"integer","format":"int32","description":"The number of schedule generation messages for this schedule generation run"}}},"BuScheduleListItem":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"weekDate":{"type":"string","format":"date","description":"The start week date for this schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"weekCount":{"type":"integer","format":"int32","description":"The number of weeks spanned by this schedule"},"description":{"type":"string","description":"The description of this schedule"},"published":{"type":"boolean","description":"Whether this schedule is published"},"shortTermForecast":{"description":"The forecast used for this schedule, if applicable","$ref":"#/definitions/BuShortTermForecastReference"},"generationResults":{"description":"Generation result summary for this schedule, if applicable","$ref":"#/definitions/ScheduleGenerationResultSummary"},"metadata":{"description":"Version metadata for this schedule","$ref":"#/definitions/WfmVersionedEntityMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BuScheduleListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/BuScheduleListItem"}}}},"BuGenerateScheduleRequest":{"type":"object","required":["description","shortTermForecast","weekCount"],"properties":{"description":{"type":"string","description":"The description for the schedule"},"shortTermForecast":{"description":"The forecast to use when generating the schedule. Note that the forecast must fully encompass the schedule's start week + week count","$ref":"#/definitions/BuShortTermForecastReference"},"weekCount":{"type":"integer","format":"int32","description":"The number of weeks in the schedule. One extra day is added at the end"}}},"BuAsyncScheduleResponse":{"type":"object","properties":{"status":{"type":"string","description":"The status of the operation","enum":["Processing","Complete","Canceled","Error"],"x-genesys-enum-members":[{"name":"Processing"},{"name":"Complete"},{"name":"Canceled"},{"name":"Error"}]},"operationId":{"type":"string","description":"The ID for the operation"},"result":{"description":"The result of the operation. Null unless status == Complete","$ref":"#/definitions/BuScheduleMetadata"}}},"BuCopyScheduleRequest":{"type":"object","required":["description","weekDate"],"properties":{"description":{"type":"string","description":"The description for the new schedule"},"weekDate":{"type":"string","format":"date","description":"The start weekDate for the new copy of the schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"}}},"BuCreateBlankScheduleRequest":{"type":"object","required":["description","weekCount"],"properties":{"description":{"type":"string","description":"The description for the schedule"},"shortTermForecast":{"description":"The forecast to use when generating the schedule. Note that the forecast must fully encompass the schedule's start week + week count","$ref":"#/definitions/BuShortTermForecastReference"},"weekCount":{"type":"integer","format":"int32","description":"The number of weeks in the schedule. One extra day is added at the end"}}},"BuHeadcountForecastResponse":{"type":"object","properties":{"result":{"description":"The headcount forecast, null when downloadUrl is provided","$ref":"#/definitions/BuHeadcountForecast"},"downloadUrl":{"type":"string","description":"Download URL. Null unless the response is too large to pass directly through the api"}}},"BuAgentScheduleQueryResponse":{"type":"object","properties":{"user":{"description":"The user to whom this agent schedule applies","$ref":"#/definitions/UserReference"},"shifts":{"type":"array","description":"The shift definitions for this agent schedule","items":{"$ref":"#/definitions/BuAgentScheduleShift"}},"fullDayTimeOffMarkers":{"type":"array","description":"Full day time off markers which apply to this agent schedule","items":{"$ref":"#/definitions/BuFullDayTimeOffMarker"}},"workPlan":{"description":"The work plan for this user","$ref":"#/definitions/WorkPlanReference"},"workPlansPerWeek":{"type":"array","description":"The work plans per week for this user from the work plan rotation. Null values in the list denotes that user is not part of any work plan for that week","items":{"$ref":"#/definitions/WorkPlanReference"}},"metadata":{"description":"Versioned entity metadata for this agent schedule","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"BuAgentSchedulesQueryResponse":{"type":"object","properties":{"agentSchedules":{"type":"array","description":"The requested agent schedules","items":{"$ref":"#/definitions/BuAgentScheduleQueryResponse"}},"businessUnitTimeZone":{"type":"string","description":"The time zone configured for the business unit to which these schedules apply"}}},"BuAsyncAgentSchedulesQueryResponse":{"type":"object","properties":{"status":{"type":"string","description":"The status of the operation","enum":["Processing","Complete","Canceled","Error"],"x-genesys-enum-members":[{"name":"Processing"},{"name":"Complete"},{"name":"Canceled"},{"name":"Error"}]},"operationId":{"type":"string","description":"The ID for the operation"},"result":{"description":"The result of the operation. Null unless status == Complete","$ref":"#/definitions/BuAgentSchedulesQueryResponse"},"progress":{"type":"integer","format":"int32","description":"Percent progress for the operation"},"downloadUrl":{"type":"string","description":"The URL from which to download the result if it is too large to pass directly"}}},"BuQueryAgentSchedulesRequest":{"type":"object","required":["managementUnitId"],"properties":{"managementUnitId":{"type":"string","description":"The ID of the management unit to query"},"userIds":{"type":"array","description":"The IDs of the users to query. Omit to query all user schedules in the management unit. Note: If teamIds is also specified, only schedules for users in the requested teams will be returned","uniqueItems":true,"items":{"type":"string"}},"teamIds":{"type":"array","description":"The teamIds to report on. If null or not set, results will be queried for requested users if applicable or otherwise all users in the management unit","uniqueItems":true,"items":{"type":"string"}}}},"BuAgentScheduleHistoryChange":{"type":"object","properties":{"metadata":{"description":"The metadata of the change, including who and when the change was made","$ref":"#/definitions/BuAgentScheduleHistoryChangeMetadata"},"shifts":{"type":"array","description":"The list of changed shifts","items":{"$ref":"#/definitions/BuAgentScheduleShift"}},"fullDayTimeOffMarkers":{"type":"array","description":"The list of changed full day time off markers","items":{"$ref":"#/definitions/BuFullDayTimeOffMarker"}},"deletes":{"description":"The deleted shifts, full day time off markers, or the entire agent schedule","$ref":"#/definitions/BuAgentScheduleHistoryDeletedChange"}}},"BuAgentScheduleHistoryChangeMetadata":{"type":"object","properties":{"dateModified":{"type":"string","format":"date-time","description":"The timestamp of the schedule change. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"description":"The user that made the schedule change","$ref":"#/definitions/UserReference"}}},"BuAgentScheduleHistoryDeletedChange":{"type":"object","properties":{"shiftIds":{"type":"array","description":"The IDs of deleted shifts","uniqueItems":true,"items":{"type":"string"}},"fullDayTimeOffMarkerDates":{"type":"array","description":"The dates of any deleted full day time off markers","uniqueItems":true,"items":{"type":"string","format":"date"}},"agentSchedule":{"type":"boolean","description":"Whether the entire agent schedule was deleted"}}},"BuAgentScheduleHistoryDroppedChange":{"type":"object","properties":{"metadata":{"description":"The metadata of the change, including who and when the change was made","$ref":"#/definitions/BuAgentScheduleHistoryChangeMetadata"},"shiftIds":{"type":"array","description":"The IDs of deleted shifts","uniqueItems":true,"items":{"type":"string"}},"fullDayTimeOffMarkerDates":{"type":"array","description":"The dates of any deleted full day time off markers","uniqueItems":true,"items":{"type":"string","format":"date"}},"deletes":{"description":"The deleted shifts, full day time off markers, or the entire agent schedule","$ref":"#/definitions/BuAgentScheduleHistoryDeletedChange"}}},"BuAgentScheduleHistoryResponse":{"type":"object","properties":{"priorPublishedSchedules":{"type":"array","description":"The list of previously published schedules","items":{"$ref":"#/definitions/BuScheduleReference"}},"basePublishedSchedule":{"description":"The originally published agent schedules","$ref":"#/definitions/BuAgentScheduleHistoryChange"},"droppedChanges":{"type":"array","description":"The changes dropped from the schedule history. This will happen if the schedule history is too large","items":{"$ref":"#/definitions/BuAgentScheduleHistoryDroppedChange"}},"changes":{"type":"array","description":"The list of changes for the schedule history","items":{"$ref":"#/definitions/BuAgentScheduleHistoryChange"}}}},"GroupProfileEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/GroupProfile"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DomainEntityListingQueryResult":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/QueryResult"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"FacetEntry":{"type":"object","properties":{"attribute":{"$ref":"#/definitions/TermAttribute"},"statistics":{"$ref":"#/definitions/FacetStatistics"},"other":{"type":"integer","format":"int64"},"total":{"type":"integer","format":"int64"},"missing":{"type":"integer","format":"int64"},"termCount":{"type":"integer","format":"int32"},"termType":{"type":"string","enum":["TERM","NUMBERRANGE","NUMBERHISTOGRAM","DATERANGE","DATEHISTOGRAM","ID"],"x-genesys-enum-members":[{"name":"TERM"},{"name":"NUMBERRANGE"},{"name":"NUMBERHISTOGRAM"},{"name":"DATERANGE"},{"name":"DATEHISTOGRAM"},{"name":"ID"}]},"terms":{"type":"array","items":{"$ref":"#/definitions/FacetTerm"}}}},"FacetKeyAttribute":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"count":{"type":"integer","format":"int32"}}},"FacetStatistics":{"type":"object","properties":{"count":{"type":"integer","format":"int64"},"min":{"type":"number","format":"double"},"max":{"type":"number","format":"double"},"mean":{"type":"number","format":"double"},"stdDeviation":{"type":"number","format":"double"},"dateMin":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateMax":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"FacetTerm":{"type":"object","properties":{"term":{"type":"string"},"key":{"type":"integer","format":"int64"},"id":{"type":"string"},"name":{"type":"string"},"count":{"type":"integer","format":"int64"},"time":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"QueryFacetInfo":{"type":"object","properties":{"attributes":{"type":"array","items":{"$ref":"#/definitions/FacetKeyAttribute"}},"facets":{"type":"array","items":{"$ref":"#/definitions/FacetEntry"}}}},"QueryResult":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"body":{"$ref":"#/definitions/DomainEntity"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"QueryResults":{"type":"object","properties":{"results":{"$ref":"#/definitions/DomainEntityListingQueryResult"},"facetInfo":{"$ref":"#/definitions/QueryFacetInfo"}}},"TermAttribute":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string","enum":["NUMBER","STRING","DATE","BOOLEAN","LIST"],"x-genesys-enum-members":[{"name":"NUMBER"},{"name":"STRING"},{"name":"DATE"},{"name":"BOOLEAN"},{"name":"LIST"}]}}},"ContentAttributeFilterItem":{"type":"object","properties":{"id":{"type":"string"},"operator":{"type":"string","enum":["IN","RANGE","EQUALS","NOTEQUALS","LESSTHAN","LESSTHANEQUALS","GREATERTHAN","GREATERTHANEQUALS","CONTAINS"],"x-genesys-enum-members":[{"name":"IN"},{"name":"RANGE"},{"name":"EQUALS"},{"name":"NOTEQUALS"},{"name":"LESSTHAN"},{"name":"LESSTHANEQUALS"},{"name":"GREATERTHAN"},{"name":"GREATERTHANEQUALS"},{"name":"CONTAINS"}]},"values":{"type":"array","items":{"type":"string"}}}},"ContentFacetFilterItem":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["NUMBER","STRING","DATE","BOOLEAN","LIST"],"x-genesys-enum-members":[{"name":"NUMBER"},{"name":"STRING"},{"name":"DATE"},{"name":"BOOLEAN"},{"name":"LIST"}]},"operator":{"type":"string","enum":["IN","RANGE","EQUALS","NOTEQUALS","LESSTHAN","LESSTHANEQUALS","GREATERTHAN","GREATERTHANEQUALS","CONTAINS"],"x-genesys-enum-members":[{"name":"IN"},{"name":"RANGE"},{"name":"EQUALS"},{"name":"NOTEQUALS"},{"name":"LESSTHAN"},{"name":"LESSTHANEQUALS"},{"name":"GREATERTHAN"},{"name":"GREATERTHANEQUALS"},{"name":"CONTAINS"}]},"values":{"type":"array","items":{"type":"string"}}}},"ContentQueryRequest":{"type":"object","properties":{"queryPhrase":{"type":"string"},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"facetNameRequests":{"type":"array","items":{"type":"string"}},"sort":{"type":"array","items":{"$ref":"#/definitions/ContentSortItem"}},"filters":{"type":"array","items":{"$ref":"#/definitions/ContentFacetFilterItem"}},"attributeFilters":{"type":"array","items":{"$ref":"#/definitions/ContentAttributeFilterItem"}},"includeShares":{"type":"boolean"}}},"ContentSortItem":{"type":"object","properties":{"name":{"type":"string"},"ascending":{"type":"boolean"}}},"NluConfusionMatrixColumn":{"type":"object","required":["name","value"],"properties":{"name":{"type":"string","description":"The name of the intent for the column."},"value":{"type":"number","format":"float","description":"The confusion value between the intents"}}},"NluConfusionMatrixRow":{"type":"object","required":["columns","name"],"properties":{"name":{"type":"string","description":"The name of the intent for the row."},"columns":{"type":"array","description":"The columns of confusion matrix for the intent","items":{"$ref":"#/definitions/NluConfusionMatrixColumn"}}}},"NluDomainVersionQualityReport":{"type":"object","required":["confusionMatrix","summary","version"],"properties":{"version":{"description":"The domain and version details of the quality report","$ref":"#/definitions/NluDomainVersion"},"confusionMatrix":{"type":"array","description":"The confusion matrix for the Domain Version","items":{"$ref":"#/definitions/NluConfusionMatrixRow"}},"summary":{"description":"The quality report summary for the Domain Version","$ref":"#/definitions/NluQualityReportSummary"}}},"NluQualityReportSummary":{"type":"object","required":["metrics"],"properties":{"metrics":{"type":"array","description":"The list of metrics in the summary","items":{"$ref":"#/definitions/NluQualityReportSummaryMetric"}}}},"NluQualityReportSummaryMetric":{"type":"object","required":["name","value"],"properties":{"name":{"type":"string","description":"The name of the metric. e.g. recall, f1_score"},"value":{"type":"number","format":"float","description":"The value of the metric"}}},"NluDomainVersionTrainingResponse":{"type":"object","properties":{"message":{"type":"string","description":"A message indicating result of the action.","readOnly":true},"version":{"$ref":"#/definitions/NluDomainVersion"}}},"DetectedDialogAct":{"type":"object","properties":{"name":{"type":"string","description":"The name of the detected dialog act.","readOnly":true},"probability":{"type":"number","format":"double","description":"The probability of the detected dialog act.","readOnly":true}}},"DetectedIntent":{"type":"object","properties":{"name":{"type":"string","description":"The name of the detected intent.","readOnly":true},"probability":{"type":"number","format":"double","description":"The probability of the detected intent.","readOnly":true},"entities":{"type":"array","description":"The collection of named entities detected.","readOnly":true,"items":{"$ref":"#/definitions/DetectedNamedEntity"}}}},"NluDetectionInput":{"type":"object","required":["text"],"properties":{"text":{"type":"string","description":"The text to perform NLU detection on."}}},"NluDetectionOutput":{"type":"object","properties":{"intents":{"type":"array","description":"The detected intents.","readOnly":true,"items":{"$ref":"#/definitions/DetectedIntent"}},"dialogActs":{"type":"array","description":"The detected dialog acts.","readOnly":true,"items":{"$ref":"#/definitions/DetectedDialogAct"}}}},"NluDetectionResponse":{"type":"object","properties":{"version":{"description":"The NLU domain version which performed the detection.","readOnly":true,"$ref":"#/definitions/NluDomainVersion"},"output":{"$ref":"#/definitions/NluDetectionOutput"},"input":{"$ref":"#/definitions/NluDetectionInput"}}},"ContextEntity":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The name of the entity."}}},"ContextIntent":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The name of the intent."}}},"NluDetectionContext":{"type":"object","properties":{"intent":{"description":"Restrict detection to this intent.","$ref":"#/definitions/ContextIntent"},"entity":{"description":"Use this entity to restrict detection.","$ref":"#/definitions/ContextEntity"}}},"NluDetectionRequest":{"type":"object","required":["input"],"properties":{"input":{"description":"The input subject to NLU detection.","$ref":"#/definitions/NluDetectionInput"},"context":{"description":"The context for the input to NLU detection.","$ref":"#/definitions/NluDetectionContext"}}},"InboundDomainPatchRequest":{"type":"object","properties":{"mailFromSettings":{"description":"The DNS settings if the inbound domain is using a custom Mail From. These settings can only be used on InboundDomains where subDomain is false.","$ref":"#/definitions/MailFromResult"},"customSMTPServer":{"description":"The custom SMTP server integration to use when sending outbound emails from this domain.","$ref":"#/definitions/DomainEntityRef"}}},"TestMessage":{"type":"object","required":["from","textBody","to"],"properties":{"id":{"type":"string","description":"After the message has been sent, this is the value of the Message-ID email header.","readOnly":true},"to":{"type":"array","description":"The recipients of the email message.","items":{"$ref":"#/definitions/EmailAddress"}},"from":{"description":"The sender of the email message.","$ref":"#/definitions/EmailAddress"},"subject":{"type":"string","description":"The subject of the email message."},"textBody":{"type":"string","description":"The text body of the email message."},"htmlBody":{"type":"string","description":"The html body of the email message"},"time":{"type":"string","format":"date-time","description":"The time when the message was sent. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"CommonCampaign":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the Campaign."},"division":{"description":"The division to which this entity belongs.","$ref":"#/definitions/Division"},"mediaType":{"type":"string","description":"The media type used for this campaign.","enum":["sms","voice"],"x-genesys-enum-members":[{"name":"sms"},{"name":"voice"}]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CommonCampaignEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CommonCampaign"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"RecordingJobEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/RecordingJob"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DialerEventEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/EventLog"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EdgeEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Edge"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"UsersSearchResponse":{"type":"object","required":["pageCount","pageNumber","pageSize","results","total","types"],"properties":{"total":{"type":"integer","format":"int64","description":"The total number of results found"},"pageCount":{"type":"integer","format":"int32","description":"The total number of pages"},"pageSize":{"type":"integer","format":"int32","description":"The current page size"},"pageNumber":{"type":"integer","format":"int32","description":"The current page number"},"previousPage":{"type":"string","description":"Q64 value for the previous page of results"},"currentPage":{"type":"string","description":"Q64 value for the current page of results"},"nextPage":{"type":"string","description":"Q64 value for the next page of results"},"types":{"type":"array","description":"Resource types the search was performed against","items":{"type":"string"}},"results":{"type":"array","description":"Search results","items":{"$ref":"#/definitions/User"}}}},"UserSearchCriteria":{"type":"object","required":["type"],"properties":{"endValue":{"type":"string","description":"The end value of the range. This field is used for range search types."},"values":{"type":"array","description":"A list of values for the search to match against","items":{"type":"string"}},"startValue":{"type":"string","description":"The start value of the range. This field is used for range search types."},"fields":{"type":"array","description":"Field names to search against","items":{"type":"string"}},"value":{"type":"string","description":"A value for the search to match against"},"operator":{"type":"string","description":"How to apply this search criteria against other criteria","enum":["AND","OR","NOT"],"x-genesys-enum-members":[{"name":"AND"},{"name":"OR"},{"name":"NOT"}]},"group":{"type":"array","description":"Groups multiple conditions","items":{"$ref":"#/definitions/UserSearchCriteria"}},"dateFormat":{"type":"string","description":"Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."},"type":{"type":"string","description":"Search Type","enum":["EXACT","STARTS_WITH","CONTAINS","REGEX","TERM","TERMS","REQUIRED_FIELDS","MATCH_ALL","QUERY_STRING"],"x-genesys-enum-members":[{"name":"EXACT"},{"name":"STARTS_WITH"},{"name":"CONTAINS"},{"name":"REGEX"},{"name":"TERM"},{"name":"TERMS"},{"name":"REQUIRED_FIELDS"},{"name":"MATCH_ALL"},{"name":"QUERY_STRING"}]}}},"UserSearchRequest":{"type":"object","properties":{"sortOrder":{"type":"string","description":"The sort order for results","enum":["ASC","DESC","SCORE"],"x-genesys-enum-members":[{"name":"ASC"},{"name":"DESC"},{"name":"SCORE"}]},"sortBy":{"type":"string","description":"The field in the resource that you want to sort the results by"},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"},"pageNumber":{"type":"integer","format":"int32","description":"The page of resources you want to retrieve"},"sort":{"type":"array","description":"Multi-value sort order, list of multiple sort values","items":{"$ref":"#/definitions/SearchSort"}},"expand":{"type":"array","description":"Provides more details about a specified resource","items":{"type":"string"}},"query":{"type":"array","items":{"$ref":"#/definitions/UserSearchCriteria"}},"integrationPresenceSource":{"type":"string","description":"Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an \"expand\". When using this parameter the maximum number of users that can be returned is 10.","enum":["MicrosoftTeams","ZoomPhone","RingCentral"],"x-genesys-enum-members":[{"name":"MicrosoftTeams"},{"name":"ZoomPhone"},{"name":"RingCentral"}]},"enforcePermissions":{"type":"boolean","description":"When set to true add additional search criteria to filter users by directory:user:view"}}},"ConversationMetrics":{"type":"object","properties":{"conversation":{"description":"The Conversation Reference","$ref":"#/definitions/AddressableEntityRef"},"sentimentScore":{"type":"number","format":"double","description":"The Sentiment Score"},"sentimentTrend":{"type":"number","format":"double","description":"The Sentiment Trend"}}},"ParticipantMetrics":{"type":"object","properties":{}},"LineEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Line"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AttributeFilterItem":{"type":"object","properties":{"id":{"type":"string"},"operator":{"type":"string","enum":["IN","RANGE","EQUALS","NOTEQUALS","LESSTHAN","LESSTHANEQUALS","GREATERTHAN","GREATERTHANEQUALS","CONTAINS"],"x-genesys-enum-members":[{"name":"IN"},{"name":"RANGE"},{"name":"EQUALS"},{"name":"NOTEQUALS"},{"name":"LESSTHAN"},{"name":"LESSTHANEQUALS"},{"name":"GREATERTHAN"},{"name":"GREATERTHANEQUALS"},{"name":"CONTAINS"}]},"values":{"type":"array","items":{"type":"string"}}}},"ContentFilterItem":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["NUMBER","STRING","DATE","BOOLEAN","LIST"],"x-genesys-enum-members":[{"name":"NUMBER"},{"name":"STRING"},{"name":"DATE"},{"name":"BOOLEAN"},{"name":"LIST"}]},"operator":{"type":"string","enum":["IN","RANGE","EQUALS","NOTEQUALS","LESSTHAN","LESSTHANEQUALS","GREATERTHAN","GREATERTHANEQUALS","CONTAINS"],"x-genesys-enum-members":[{"name":"IN"},{"name":"RANGE"},{"name":"EQUALS"},{"name":"NOTEQUALS"},{"name":"LESSTHAN"},{"name":"LESSTHANEQUALS"},{"name":"GREATERTHAN"},{"name":"GREATERTHANEQUALS"},{"name":"CONTAINS"}]},"values":{"type":"array","items":{"type":"string"}}}},"QueryRequest":{"type":"object","properties":{"queryPhrase":{"type":"string"},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"facetNameRequests":{"type":"array","items":{"type":"string"}},"sort":{"type":"array","items":{"$ref":"#/definitions/SortItem"}},"filters":{"type":"array","items":{"$ref":"#/definitions/ContentFilterItem"}},"attributeFilters":{"type":"array","items":{"$ref":"#/definitions/AttributeFilterItem"}},"includeShares":{"type":"boolean"}}},"SortItem":{"type":"object","properties":{"name":{"type":"string"},"ascending":{"type":"boolean"}}},"UnreadMetric":{"type":"object","properties":{"count":{"type":"integer","format":"int32","description":"The count of unread alerts for a specific rule type."}}},"GSuite":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"disabled":{"type":"boolean"},"issuerURI":{"type":"string"},"ssoTargetURI":{"type":"string"},"certificate":{"type":"string"},"certificates":{"type":"array","items":{"type":"string"}},"relyingPartyIdentifier":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PropertyIndexRequest":{"type":"object","required":["properties","sessionId","targetDate"],"properties":{"sessionId":{"type":"string","description":"Attach properties to a segment in the indicated session"},"targetDate":{"type":"string","format":"date-time","description":"Attach properties to a segment covering a specific point in time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"properties":{"type":"array","description":"The list of properties to index","items":{"$ref":"#/definitions/AnalyticsProperty"}}}},"ConversationAggregateDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/StatisticalResponse"}}}},"ConversationAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/ConversationAggregateDataContainer"}}}},"ConversationAggregateQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/ConversationAggregateQueryPredicate"}}}},"ConversationAggregateQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/ConversationAggregateQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/ConversationAggregateQueryPredicate"}}}},"ConversationAggregateQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"],"x-genesys-enum-members":[{"name":"dimension"},{"name":"property"},{"name":"metric"}]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["addressFrom","addressTo","agentAssistantId","agentRank","agentScore","ani","assignerId","conversationId","convertedFrom","convertedTo","direction","disconnectType","divisionId","dnis","edgeId","externalContactId","externalMediaCount","externalOrganizationId","firstQueue","flaggedReason","flowInType","flowOutType","groupId","interactionType","journeyActionId","journeyActionMapId","journeyActionMapVersion","journeyCustomerId","journeyCustomerIdType","journeyCustomerSessionId","journeyCustomerSessionIdType","mediaCount","mediaType","messageType","originatingDirection","outboundCampaignId","outboundContactId","outboundContactListId","participantName","peerId","proposedAgentId","provider","purpose","queueId","remote","reoffered","requestedLanguageId","requestedRouting","requestedRoutingSkillId","roomId","routingPriority","scoredAgentId","selectedAgentId","selectedAgentRank","sessionDnis","sessionId","stationId","teamId","usedRouting","userId","wrapUpCode"],"x-genesys-enum-members":[{"name":"addressFrom"},{"name":"addressTo"},{"name":"agentAssistantId"},{"name":"agentRank"},{"name":"agentScore"},{"name":"ani"},{"name":"assignerId"},{"name":"conversationId"},{"name":"convertedFrom"},{"name":"convertedTo"},{"name":"direction"},{"name":"disconnectType"},{"name":"divisionId"},{"name":"dnis"},{"name":"edgeId"},{"name":"externalContactId"},{"name":"externalMediaCount"},{"name":"externalOrganizationId"},{"name":"firstQueue"},{"name":"flaggedReason"},{"name":"flowInType"},{"name":"flowOutType"},{"name":"groupId"},{"name":"interactionType"},{"name":"journeyActionId"},{"name":"journeyActionMapId"},{"name":"journeyActionMapVersion"},{"name":"journeyCustomerId"},{"name":"journeyCustomerIdType"},{"name":"journeyCustomerSessionId"},{"name":"journeyCustomerSessionIdType"},{"name":"mediaCount"},{"name":"mediaType"},{"name":"messageType"},{"name":"originatingDirection"},{"name":"outboundCampaignId"},{"name":"outboundContactId"},{"name":"outboundContactListId"},{"name":"participantName"},{"name":"peerId"},{"name":"proposedAgentId"},{"name":"provider"},{"name":"purpose"},{"name":"queueId"},{"name":"remote"},{"name":"reoffered"},{"name":"requestedLanguageId"},{"name":"requestedRouting"},{"name":"requestedRoutingSkillId"},{"name":"roomId"},{"name":"routingPriority"},{"name":"scoredAgentId"},{"name":"selectedAgentId"},{"name":"selectedAgentRank"},{"name":"sessionDnis"},{"name":"sessionId"},{"name":"stationId"},{"name":"teamId"},{"name":"usedRouting"},{"name":"userId"},{"name":"wrapUpCode"}]},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"],"x-genesys-enum-members":[{"name":"matches"},{"name":"exists"},{"name":"notExists"}]},"value":{"type":"string","description":"Right hand side for dimension predicates"},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"ConversationAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["addressFrom","addressTo","agentAssistantId","agentRank","agentScore","ani","assignerId","conversationId","convertedFrom","convertedTo","direction","disconnectType","divisionId","dnis","edgeId","externalContactId","externalMediaCount","externalOrganizationId","firstQueue","flaggedReason","flowInType","flowOutType","groupId","interactionType","journeyActionId","journeyActionMapId","journeyActionMapVersion","journeyCustomerId","journeyCustomerIdType","journeyCustomerSessionId","journeyCustomerSessionIdType","mediaCount","mediaType","messageType","originatingDirection","outboundCampaignId","outboundContactId","outboundContactListId","participantName","peerId","proposedAgentId","provider","purpose","queueId","remote","reoffered","requestedLanguageId","requestedRouting","requestedRoutingSkillId","roomId","routingPriority","scoredAgentId","selectedAgentId","selectedAgentRank","sessionDnis","sessionId","stationId","teamId","usedRouting","userId","wrapUpCode"],"x-genesys-enum-members":[{"name":"addressFrom"},{"name":"addressTo"},{"name":"agentAssistantId"},{"name":"agentRank"},{"name":"agentScore"},{"name":"ani"},{"name":"assignerId"},{"name":"conversationId"},{"name":"convertedFrom"},{"name":"convertedTo"},{"name":"direction"},{"name":"disconnectType"},{"name":"divisionId"},{"name":"dnis"},{"name":"edgeId"},{"name":"externalContactId"},{"name":"externalMediaCount"},{"name":"externalOrganizationId"},{"name":"firstQueue"},{"name":"flaggedReason"},{"name":"flowInType"},{"name":"flowOutType"},{"name":"groupId"},{"name":"interactionType"},{"name":"journeyActionId"},{"name":"journeyActionMapId"},{"name":"journeyActionMapVersion"},{"name":"journeyCustomerId"},{"name":"journeyCustomerIdType"},{"name":"journeyCustomerSessionId"},{"name":"journeyCustomerSessionIdType"},{"name":"mediaCount"},{"name":"mediaType"},{"name":"messageType"},{"name":"originatingDirection"},{"name":"outboundCampaignId"},{"name":"outboundContactId"},{"name":"outboundContactListId"},{"name":"participantName"},{"name":"peerId"},{"name":"proposedAgentId"},{"name":"provider"},{"name":"purpose"},{"name":"queueId"},{"name":"remote"},{"name":"reoffered"},{"name":"requestedLanguageId"},{"name":"requestedRouting"},{"name":"requestedRoutingSkillId"},{"name":"roomId"},{"name":"routingPriority"},{"name":"scoredAgentId"},{"name":"selectedAgentId"},{"name":"selectedAgentRank"},{"name":"sessionDnis"},{"name":"sessionId"},{"name":"stationId"},{"name":"teamId"},{"name":"usedRouting"},{"name":"userId"},{"name":"wrapUpCode"}]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/ConversationAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nBlindTransferred","nCobrowseSessions","nConnected","nConsult","nConsultTransferred","nError","nOffered","nOutbound","nOutboundAbandoned","nOutboundAttempted","nOutboundConnected","nOverSla","nStateTransitionError","nTransferred","oExternalMediaCount","oMediaCount","oServiceLevel","oServiceTarget","tAbandon","tAcd","tAcw","tAgentResponseTime","tAlert","tAnswered","tCallback","tCallbackComplete","tContacting","tDialing","tFlowOut","tHandle","tHeld","tHeldComplete","tIvr","tMonitoring","tNotResponding","tShortAbandon","tTalk","tTalkComplete","tUserResponseTime","tVoicemail","tWait"],"x-genesys-enum-members":[{"name":"nBlindTransferred"},{"name":"nCobrowseSessions"},{"name":"nConnected"},{"name":"nConsult"},{"name":"nConsultTransferred"},{"name":"nError"},{"name":"nOffered"},{"name":"nOutbound"},{"name":"nOutboundAbandoned"},{"name":"nOutboundAttempted"},{"name":"nOutboundConnected"},{"name":"nOverSla"},{"name":"nStateTransitionError"},{"name":"nTransferred"},{"name":"oExternalMediaCount"},{"name":"oMediaCount"},{"name":"oServiceLevel"},{"name":"oServiceTarget"},{"name":"tAbandon"},{"name":"tAcd"},{"name":"tAcw"},{"name":"tAgentResponseTime"},{"name":"tAlert"},{"name":"tAnswered"},{"name":"tCallback"},{"name":"tCallbackComplete"},{"name":"tContacting"},{"name":"tDialing"},{"name":"tFlowOut"},{"name":"tHandle"},{"name":"tHeld"},{"name":"tHeldComplete"},{"name":"tIvr"},{"name":"tMonitoring"},{"name":"tNotResponding"},{"name":"tShortAbandon"},{"name":"tTalk"},{"name":"tTalkComplete"},{"name":"tUserResponseTime"},{"name":"tVoicemail"},{"name":"tWait"}]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/ConversationAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"],"x-genesys-enum-members":[{"name":"eventTime"}]}}},"ConversationAggregationView":{"type":"object","required":["function","name","target"],"properties":{"target":{"type":"string","description":"Target metric name","enum":["nBlindTransferred","nCobrowseSessions","nConnected","nConsult","nConsultTransferred","nError","nOffered","nOutbound","nOutboundAbandoned","nOutboundAttempted","nOutboundConnected","nOverSla","nStateTransitionError","nTransferred","oExternalMediaCount","oMediaCount","oServiceLevel","oServiceTarget","tAbandon","tAcd","tAcw","tAgentResponseTime","tAlert","tAnswered","tCallback","tCallbackComplete","tContacting","tDialing","tFlowOut","tHandle","tHeld","tHeldComplete","tIvr","tMonitoring","tNotResponding","tShortAbandon","tTalk","tTalkComplete","tUserResponseTime","tVoicemail","tWait"],"x-genesys-enum-members":[{"name":"nBlindTransferred"},{"name":"nCobrowseSessions"},{"name":"nConnected"},{"name":"nConsult"},{"name":"nConsultTransferred"},{"name":"nError"},{"name":"nOffered"},{"name":"nOutbound"},{"name":"nOutboundAbandoned"},{"name":"nOutboundAttempted"},{"name":"nOutboundConnected"},{"name":"nOverSla"},{"name":"nStateTransitionError"},{"name":"nTransferred"},{"name":"oExternalMediaCount"},{"name":"oMediaCount"},{"name":"oServiceLevel"},{"name":"oServiceTarget"},{"name":"tAbandon"},{"name":"tAcd"},{"name":"tAcw"},{"name":"tAgentResponseTime"},{"name":"tAlert"},{"name":"tAnswered"},{"name":"tCallback"},{"name":"tCallbackComplete"},{"name":"tContacting"},{"name":"tDialing"},{"name":"tFlowOut"},{"name":"tHandle"},{"name":"tHeld"},{"name":"tHeldComplete"},{"name":"tIvr"},{"name":"tMonitoring"},{"name":"tNotResponding"},{"name":"tShortAbandon"},{"name":"tTalk"},{"name":"tTalkComplete"},{"name":"tUserResponseTime"},{"name":"tVoicemail"},{"name":"tWait"}]},"name":{"type":"string","description":"A unique name for this view. Must be distinct from other views and built-in metric names."},"function":{"type":"string","description":"Type of view you wish to create","enum":["rangeBound"],"x-genesys-enum-members":[{"name":"rangeBound"}]},"range":{"description":"Range of numbers for slicing up data","$ref":"#/definitions/AggregationRange"}}},"AnalyticsConversationQueryResponse":{"type":"object","properties":{"aggregations":{"type":"array","items":{"$ref":"#/definitions/AggregationResult"}},"conversations":{"type":"array","items":{"$ref":"#/definitions/AnalyticsConversationWithoutAttributes"}}}},"ConversationQuery":{"type":"object","required":["interval"],"properties":{"conversationFilters":{"type":"array","description":"Filters that target conversation-level data","items":{"$ref":"#/definitions/ConversationDetailQueryFilter"}},"segmentFilters":{"type":"array","description":"Filters that target individual segments within a conversation","items":{"$ref":"#/definitions/SegmentDetailQueryFilter"}},"evaluationFilters":{"type":"array","description":"Filters that target evaluations","items":{"$ref":"#/definitions/EvaluationDetailQueryFilter"}},"mediaEndpointStatFilters":{"type":"array","description":"Filters that target mediaEndpointStats","items":{"$ref":"#/definitions/MediaEndpointStatDetailQueryFilter"}},"surveyFilters":{"type":"array","description":"Filters that target surveys","items":{"$ref":"#/definitions/SurveyDetailQueryFilter"}},"resolutionFilters":{"type":"array","description":"Filters that target resolutions","items":{"$ref":"#/definitions/ResolutionDetailQueryFilter"}},"order":{"type":"string","description":"Sort the result set in ascending/descending order. Default is ascending","enum":["asc","desc"],"x-genesys-enum-members":[{"name":"asc"},{"name":"desc"}]},"orderBy":{"type":"string","description":"Specify which data element within the result set to use for sorting. The options to use as a basis for sorting the results: conversationStart, segmentStart, and segmentEnd. If not specified, the default is conversationStart","enum":["conversationStart","conversationEnd","segmentStart","segmentEnd"],"x-genesys-enum-members":[{"name":"conversationStart"},{"name":"conversationEnd"},{"name":"segmentStart"},{"name":"segmentEnd"}]},"interval":{"type":"string","description":"Specifies the date and time range of data being queried. Results will only include conversations that started on a day touched by the interval. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"aggregations":{"type":"array","description":"Include faceted search and aggregate roll-ups describing your search results. This does not function as a filter, but rather, summary data about the data matching your filters","items":{"$ref":"#/definitions/AnalyticsQueryAggregation"}},"paging":{"description":"Page size and number to control iterating through large result sets. Default page size is 25","$ref":"#/definitions/PagingSpec"}}},"AnalyticsConversation":{"type":"object","properties":{"conversationId":{"type":"string","description":"Unique identifier for the conversation"},"conversationStart":{"type":"string","format":"date-time","description":"Date/time the conversation started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversationEnd":{"type":"string","format":"date-time","description":"Date/time the conversation ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"mediaStatsMinConversationMos":{"type":"number","format":"double","description":"The lowest estimated average MOS among all the audio streams belonging to this conversation"},"mediaStatsMinConversationRFactor":{"type":"number","format":"double","description":"The lowest R-factor value among all of the audio streams belonging to this conversation"},"originatingDirection":{"type":"string","description":"The original direction of the conversation","enum":["inbound","outbound"],"x-genesys-enum-members":[{"name":"inbound"},{"name":"outbound"}]},"evaluations":{"type":"array","description":"Evaluations tied to this conversation","items":{"$ref":"#/definitions/AnalyticsEvaluation"}},"surveys":{"type":"array","description":"Surveys tied to this conversation","items":{"$ref":"#/definitions/AnalyticsSurvey"}},"resolutions":{"type":"array","description":"Resolutions tied to this conversation","items":{"$ref":"#/definitions/AnalyticsResolution"}},"divisionIds":{"type":"array","description":"Identifiers of divisions associated with this conversation","items":{"type":"string"}},"participants":{"type":"array","description":"Participants in the conversation","items":{"$ref":"#/definitions/AnalyticsParticipant"}}}},"AnalyticsConversationAsyncQueryResponse":{"type":"object","properties":{"cursor":{"type":"string","description":"Optional cursor to indicate where to resume the results"},"dataAvailabilityDate":{"type":"string","format":"date-time","description":"Data available up to at least this datetime. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"conversations":{"type":"array","items":{"$ref":"#/definitions/AnalyticsConversation"}}}},"AnalyticsParticipant":{"type":"object","properties":{"participantId":{"type":"string","description":"Unique identifier for the participant"},"participantName":{"type":"string","description":"A human readable name identifying the participant"},"userId":{"type":"string","description":"If a user, then this will be the unique identifier for the user"},"purpose":{"type":"string","description":"The participant's purpose","enum":["manual","dialer","inbound","acd","ivr","voicemail","outbound","agent","user","station","group","customer","external","fax","workflow","campaign","api"],"x-genesys-enum-members":[{"name":"manual"},{"name":"dialer"},{"name":"inbound"},{"name":"acd"},{"name":"ivr"},{"name":"voicemail"},{"name":"outbound"},{"name":"agent"},{"name":"user"},{"name":"station"},{"name":"group"},{"name":"customer"},{"name":"external"},{"name":"fax"},{"name":"workflow"},{"name":"campaign"},{"name":"api"}]},"externalContactId":{"type":"string","description":"External Contact Identifier"},"externalOrganizationId":{"type":"string","description":"External Organization Identifier"},"flaggedReason":{"type":"string","description":"Reason for which participant flagged conversation","enum":["general"],"x-genesys-enum-members":[{"name":"general"}]},"teamId":{"type":"string","description":"The team id the user is a member of"},"sessions":{"type":"array","description":"List of sessions associated to this participant","items":{"$ref":"#/definitions/AnalyticsSession"}},"attributes":{"type":"object","description":"List of attributes associated to this participant","additionalProperties":{"type":"string"}}}},"ExportUri":{"type":"object","properties":{"uri":{"type":"string"},"exportTimestamp":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"FlowMilestoneListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/FlowMilestone"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ChangeMyPasswordRequest":{"type":"object","required":["newPassword","oldPassword"],"properties":{"newPassword":{"type":"string","description":"The new password"},"oldPassword":{"type":"string","description":"Your current password"}}},"SharedResponse":{"type":"object","properties":{"id":{"type":"string"},"downloadUri":{"type":"string","format":"uri"},"viewUri":{"type":"string","format":"uri"},"document":{"$ref":"#/definitions/Document"},"share":{"$ref":"#/definitions/Share"}}},"UserScheduleAdherenceListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UserScheduleAdherence"}},"downloadUrl":{"type":"string","description":"The downloadUrl if the response is too large to send directly via http response","readOnly":true}}},"DomainPermission":{"type":"object","properties":{"domain":{"type":"string"},"entityType":{"type":"string"},"action":{"type":"string"},"label":{"type":"string"},"allowsConditions":{"type":"boolean"},"divisionAware":{"type":"boolean"}}},"DomainPermissionCollection":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"domain":{"type":"string"},"permissionMap":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/definitions/DomainPermission"}}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"PermissionCollectionEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DomainPermissionCollection"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"Prompt":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The prompt identifier"},"name":{"type":"string","description":"The prompt name."},"description":{"type":"string"},"resources":{"type":"array","description":"List of resources associated with this prompt","readOnly":true,"items":{"$ref":"#/definitions/PromptAsset"}},"currentOperation":{"description":"Current prompt operation status","readOnly":true,"$ref":"#/definitions/Operation"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WritableDialerContact":{"type":"object","required":["contactListId","data"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object."},"contactListId":{"type":"string","description":"The identifier of the contact list containing this contact."},"data":{"type":"object","description":"An ordered map of the contact's columns and corresponding values.","additionalProperties":{"type":"object"}},"callable":{"type":"boolean","description":"Indicates whether or not the contact can be called."},"phoneNumberStatus":{"type":"object","description":"A map of phone number columns to PhoneNumberStatuses, which indicate if the phone number is callable or not.","additionalProperties":{"$ref":"#/definitions/PhoneNumberStatus"}}}},"WebChatSettings":{"type":"object","properties":{"requireDeployment":{"type":"boolean"}}},"EvaluationAggregateDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/StatisticalResponse"}}}},"EvaluationAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/EvaluationAggregateDataContainer"}}}},"EvaluationAggregateQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/EvaluationAggregateQueryPredicate"}}}},"EvaluationAggregateQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/EvaluationAggregateQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/EvaluationAggregateQueryPredicate"}}}},"EvaluationAggregateQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"],"x-genesys-enum-members":[{"name":"dimension"},{"name":"property"},{"name":"metric"}]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["calibrationId","contextId","conversationId","divisionId","evaluationCreatedDate","evaluationId","evaluatorId","formId","queueId","rescored","teamId","userId"],"x-genesys-enum-members":[{"name":"calibrationId"},{"name":"contextId"},{"name":"conversationId"},{"name":"divisionId"},{"name":"evaluationCreatedDate"},{"name":"evaluationId"},{"name":"evaluatorId"},{"name":"formId"},{"name":"queueId"},{"name":"rescored"},{"name":"teamId"},{"name":"userId"}]},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"],"x-genesys-enum-members":[{"name":"matches"},{"name":"exists"},{"name":"notExists"}]},"value":{"type":"string","description":"Right hand side for dimension predicates"},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"EvaluationAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["calibrationId","contextId","conversationId","divisionId","evaluationCreatedDate","evaluationId","evaluatorId","formId","queueId","rescored","teamId","userId"],"x-genesys-enum-members":[{"name":"calibrationId"},{"name":"contextId"},{"name":"conversationId"},{"name":"divisionId"},{"name":"evaluationCreatedDate"},{"name":"evaluationId"},{"name":"evaluatorId"},{"name":"formId"},{"name":"queueId"},{"name":"rescored"},{"name":"teamId"},{"name":"userId"}]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/EvaluationAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nEvaluations","nEvaluationsDeleted","nEvaluationsRescored","oTotalCriticalScore","oTotalScore"],"x-genesys-enum-members":[{"name":"nEvaluations"},{"name":"nEvaluationsDeleted"},{"name":"nEvaluationsRescored"},{"name":"oTotalCriticalScore"},{"name":"oTotalScore"}]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/EvaluationAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["evaluationCreatedDate","eventTime"],"x-genesys-enum-members":[{"name":"evaluationCreatedDate"},{"name":"eventTime"}]}}},"EvaluationAggregationView":{"type":"object","required":["function","name","target"],"properties":{"target":{"type":"string","description":"Target metric name","enum":["nEvaluations","nEvaluationsDeleted","nEvaluationsRescored","oTotalCriticalScore","oTotalScore"],"x-genesys-enum-members":[{"name":"nEvaluations"},{"name":"nEvaluationsDeleted"},{"name":"nEvaluationsRescored"},{"name":"oTotalCriticalScore"},{"name":"oTotalScore"}]},"name":{"type":"string","description":"A unique name for this view. Must be distinct from other views and built-in metric names."},"function":{"type":"string","description":"Type of view you wish to create","enum":["rangeBound"],"x-genesys-enum-members":[{"name":"rangeBound"}]},"range":{"description":"Range of numbers for slicing up data","$ref":"#/definitions/AggregationRange"}}},"EmbeddedIntegration":{"type":"object","properties":{"enableWhitelist":{"type":"boolean"},"domainWhitelist":{"type":"array","items":{"type":"string"}}}},"TrunkRecordingEnabledCount":{"type":"object","properties":{"enabledCount":{"type":"integer","format":"int32","description":"The amount of trunks that have recording enabled"},"disabledCount":{"type":"integer","format":"int32","description":"The amount of trunks that do not have recording enabled"}}},"EmailSetup":{"type":"object","properties":{"rootDomain":{"type":"string","description":"The root PureCloud domain that all sub-domains are created from."}}},"UpdateActionInput":{"type":"object","required":["version"],"properties":{"category":{"type":"string","description":"Category of action, Can be up to 256 characters long"},"name":{"type":"string","description":"Name of action, Can be up to 256 characters long"},"config":{"description":"Configuration to support request and response processing","$ref":"#/definitions/ActionConfig"},"version":{"type":"integer","format":"int32","description":"Version of this action"}}},"TranscriptAggregateDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/StatisticalResponse"}}}},"TranscriptAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/TranscriptAggregateDataContainer"}}}},"TranscriptAggregateQueryClause":{"type":"object","required":["predicates","type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/TranscriptAggregateQueryPredicate"}}}},"TranscriptAggregateQueryFilter":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Boolean operation to apply to the provided predicates and clauses","enum":["and","or"],"x-genesys-enum-members":[{"name":"and"},{"name":"or"}]},"clauses":{"type":"array","description":"Boolean 'and/or' logic with up to two-levels of nesting","items":{"$ref":"#/definitions/TranscriptAggregateQueryClause"}},"predicates":{"type":"array","description":"Like a three-word sentence: (attribute-name) (operator) (target-value).","items":{"$ref":"#/definitions/TranscriptAggregateQueryPredicate"}}}},"TranscriptAggregateQueryPredicate":{"type":"object","properties":{"type":{"type":"string","description":"Optional type, can usually be inferred","enum":["dimension","property","metric"],"x-genesys-enum-members":[{"name":"dimension"},{"name":"property"},{"name":"metric"}]},"dimension":{"type":"string","description":"Left hand side for dimension predicates","enum":["addressFrom","addressTo","ani","channel","conversationId","direction","divisionId","dnis","flowId","flowVersion","mediaType","messageType","queueId","teamId","topicId","userId"],"x-genesys-enum-members":[{"name":"addressFrom"},{"name":"addressTo"},{"name":"ani"},{"name":"channel"},{"name":"conversationId"},{"name":"direction"},{"name":"divisionId"},{"name":"dnis"},{"name":"flowId"},{"name":"flowVersion"},{"name":"mediaType"},{"name":"messageType"},{"name":"queueId"},{"name":"teamId"},{"name":"topicId"},{"name":"userId"}]},"operator":{"type":"string","description":"Optional operator, default is matches","enum":["matches","exists","notExists"],"x-genesys-enum-members":[{"name":"matches"},{"name":"exists"},{"name":"notExists"}]},"value":{"type":"string","description":"Right hand side for dimension predicates"},"range":{"description":"Right hand side for dimension predicates","$ref":"#/definitions/NumericRange"}}},"TranscriptAggregationQuery":{"type":"object","required":["interval","metrics"],"properties":{"interval":{"type":"string","description":"Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"granularity":{"type":"string","description":"Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"},"timeZone":{"type":"string","description":"Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"},"groupBy":{"type":"array","description":"Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.","items":{"type":"string","enum":["addressFrom","addressTo","ani","channel","conversationId","direction","divisionId","dnis","flowId","flowVersion","mediaType","messageType","queueId","teamId","topicId","userId"],"x-genesys-enum-members":[{"name":"addressFrom"},{"name":"addressTo"},{"name":"ani"},{"name":"channel"},{"name":"conversationId"},{"name":"direction"},{"name":"divisionId"},{"name":"dnis"},{"name":"flowId"},{"name":"flowVersion"},{"name":"mediaType"},{"name":"messageType"},{"name":"queueId"},{"name":"teamId"},{"name":"topicId"},{"name":"userId"}]}},"filter":{"description":"Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters","$ref":"#/definitions/TranscriptAggregateQueryFilter"},"metrics":{"type":"array","description":"Behaves like a SQL SELECT clause. Only named metrics will be retrieved.","items":{"type":"string","enum":["nTopicCommunications","nTopicSegments","oCustomerSentiment"],"x-genesys-enum-members":[{"name":"nTopicCommunications"},{"name":"nTopicSegments"},{"name":"oCustomerSentiment"}]}},"flattenMultivaluedDimensions":{"type":"boolean","description":"Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"},"views":{"type":"array","description":"Custom derived metric views","items":{"$ref":"#/definitions/TranscriptAggregationView"}},"alternateTimeDimension":{"type":"string","description":"Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.","enum":["eventTime"],"x-genesys-enum-members":[{"name":"eventTime"}]}}},"TranscriptAggregationView":{"type":"object","required":["function","name","target"],"properties":{"target":{"type":"string","description":"Target metric name","enum":["nTopicCommunications","nTopicSegments","oCustomerSentiment"],"x-genesys-enum-members":[{"name":"nTopicCommunications"},{"name":"nTopicSegments"},{"name":"oCustomerSentiment"}]},"name":{"type":"string","description":"A unique name for this view. Must be distinct from other views and built-in metric names."},"function":{"type":"string","description":"Type of view you wish to create","enum":["rangeBound"],"x-genesys-enum-members":[{"name":"rangeBound"}]},"range":{"description":"Range of numbers for slicing up data","$ref":"#/definitions/AggregationRange"}}},"OAuthAuthorizationListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/OAuthAuthorization"}},"selfUri":{"type":"string","format":"uri"}}},"CreateBusinessUnitRequest":{"type":"object","required":["divisionId","name","settings"],"properties":{"name":{"type":"string","description":"The name of the business unit"},"divisionId":{"type":"string","description":"The ID of the division to which the business unit should be added"},"settings":{"description":"Configuration for the business unit","$ref":"#/definitions/CreateBusinessUnitSettings"}}},"CreateBusinessUnitSettings":{"type":"object","required":["startDayOfWeek","timeZone"],"properties":{"startDayOfWeek":{"type":"string","description":"The start day of week for this business unit","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"x-genesys-enum-members":[{"name":"Sunday"},{"name":"Monday"},{"name":"Tuesday"},{"name":"Wednesday"},{"name":"Thursday"},{"name":"Friday"},{"name":"Saturday"}]},"timeZone":{"type":"string","description":"The time zone for this business unit, using the Olsen tz database format"},"shortTermForecasting":{"description":"Short term forecasting settings","$ref":"#/definitions/BuShortTermForecastingSettings"}}},"SystemPromptAssetEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SystemPromptAsset"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"PhoneBaseEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/PhoneBase"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DomainOrganizationRoleCreate":{"type":"object","required":["name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The role name"},"description":{"type":"string"},"defaultRoleId":{"type":"string"},"permissions":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"unusedPermissions":{"type":"array","description":"A collection of the permissions the role is not using","readOnly":true,"uniqueItems":true,"items":{"type":"string"}},"permissionPolicies":{"type":"array","uniqueItems":true,"items":{"$ref":"#/definitions/DomainPermissionPolicy"}},"userCount":{"type":"integer","format":"int32"},"roleNeedsUpdate":{"type":"boolean","description":"Optional unless patch operation."},"default":{"type":"boolean"},"base":{"type":"boolean"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkspaceCreate":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The workspace name"},"bucket":{"type":"string"},"description":{"type":"string"}}},"WorkspaceEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Workspace"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"SecureSession":{"type":"object","required":["flow","state"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"flow":{"description":"The flow to execute securely","$ref":"#/definitions/DomainEntityRef"},"userData":{"type":"string","description":"Customer-provided data"},"state":{"type":"string","description":"The current state of a secure session","enum":["PENDING","COMPLETED","FAILED"],"x-genesys-enum-members":[{"name":"PENDING"},{"name":"COMPLETED"},{"name":"FAILED"}]},"sourceParticipantId":{"type":"string","description":"Unique identifier for the participant initiating the secure session."},"disconnect":{"type":"boolean","description":"If true, disconnect the agent after creating the session"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CreateSecureSession":{"type":"object","required":["flowId","userData"],"properties":{"sourceParticipantId":{"type":"string","description":"requesting participant"},"flowId":{"type":"string","description":"the flow id to execute in the secure session"},"userData":{"type":"string","description":"user data for the secure session"},"disconnect":{"type":"boolean","description":"if true, disconnect the agent after creating the session"}}},"SecureSessionEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SecureSession"}}}},"IdentityNow":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"disabled":{"type":"boolean"},"issuerURI":{"type":"string"},"ssoTargetURI":{"type":"string"},"certificate":{"type":"string"},"certificates":{"type":"array","items":{"type":"string"}},"relyingPartyIdentifier":{"type":"string"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ContactListEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ContactList"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DialogflowAgentSummary":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"project":{"description":"The project this Dialogflow agent belongs to","$ref":"#/definitions/DialogflowProject"},"description":{"type":"string","description":"A description of the Dialogflow agent"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DialogflowAgentSummaryEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DialogflowAgentSummary"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"SiteEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Site"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"IpAddressRange":{"type":"object","properties":{"cidr":{"type":"string"},"service":{"type":"string","enum":["data-actions","smtp"],"x-genesys-enum-members":[{"name":"data-actions"},{"name":"smtp"}]},"region":{"type":"string"}}},"IpAddressRangeListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/IpAddressRange"}}}},"WebChatDeploymentEntityListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/WebChatDeployment"}},"selfUri":{"type":"string","format":"uri"}}},"MessagingSticker":{"type":"object","required":["messengerType","providerStickerId","stickerType"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"providerStickerId":{"type":"integer","format":"int32","description":"The sticker Id of the sticker, assigned by the sticker provider."},"providerPackageId":{"type":"integer","format":"int32","description":"The package Id of the sticker, assigned by the sticker provider."},"packageName":{"type":"string","description":"The package name of the sticker, assigned by the sticker provider."},"messengerType":{"type":"string","description":"The type of the messenger provider.","enum":["sms","facebook","twitter","line","whatsapp","webmessaging"],"x-genesys-enum-members":[{"name":"sms"},{"name":"facebook"},{"name":"twitter"},{"name":"line"},{"name":"whatsapp"},{"name":"webmessaging"}]},"stickerType":{"type":"string","description":"The type of the sticker.","enum":["standard","free","paid"],"x-genesys-enum-members":[{"name":"standard"},{"name":"free"},{"name":"paid"}]},"providerVersion":{"type":"integer","format":"int64","description":"The version of the sticker, assigned by the provider."},"uriLocation":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"MessagingStickerEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/MessagingSticker"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CreateWebChatConversationResponse":{"type":"object","properties":{"id":{"type":"string","description":"Chat Conversation identifier"},"jwt":{"type":"string","description":"The JWT that you can use to identify subsequent calls on this conversation"},"eventStreamUri":{"type":"string","format":"uri","description":"The URI which provides the conversation event stream."},"member":{"description":"Chat Member","$ref":"#/definitions/WebChatMemberInfo"}}},"CreateWebChatConversationRequest":{"type":"object","required":["deploymentId","memberInfo","organizationId","routingTarget"],"properties":{"organizationId":{"type":"string","description":"The organization identifier."},"deploymentId":{"type":"string","description":"The web chat Deployment ID which contains the appropriate settings for this chat conversation."},"routingTarget":{"description":"The routing information to use for the new chat conversation.","$ref":"#/definitions/WebChatRoutingTarget"},"memberInfo":{"description":"The guest member info to use for the new chat conversation.","$ref":"#/definitions/GuestMemberInfo"},"memberAuthToken":{"type":"string","description":"If the guest member is an authenticated member (ie, not anonymous) his JWT is provided here. The token will have been previously generated with the \"POST /api/v2/signeddata\" resource."},"journeyContext":{"description":"A subset of the Journey System's data relevant to this conversation/session request (for external linkage and internal usage/context).","$ref":"#/definitions/JourneyContext"}}},"GuestMemberInfo":{"type":"object","required":["displayName"],"properties":{"displayName":{"type":"string","description":"The display name to use for the guest member in the conversation."},"firstName":{"type":"string","description":"The first name to use for the guest member in the conversation."},"lastName":{"type":"string","description":"The last name to use for the guest member in the conversation."},"email":{"type":"string","description":"The email address to use for the guest member in the conversation."},"phoneNumber":{"type":"string","description":"The phone number to use for the guest member in the conversation."},"avatarImageUrl":{"type":"string","format":"uri","description":"The URL to the avatar image to use for the guest member in the conversation, if any."},"customFields":{"type":"object","description":"Any custom fields of information, in key-value format, to attach to the guest member in the conversation.","additionalProperties":{"type":"string"}}}},"WebChatRoutingTarget":{"type":"object","required":["targetAddress","targetType"],"properties":{"targetType":{"type":"string","description":"The target type of the routing target, such as 'QUEUE'.","enum":["QUEUE"],"x-genesys-enum-members":[{"name":"QUEUE"}]},"targetAddress":{"type":"string","description":"The target of the route, in the format appropriate given the 'targetType'."},"skills":{"type":"array","description":"The list of skill names to use for routing.","items":{"type":"string"}},"language":{"type":"string","description":"The language name to use for routing."},"priority":{"type":"integer","format":"int64","description":"The priority to assign to the conversation for routing."}}},"TopicJobRequest":{"type":"object","required":["topicIds"],"properties":{"topicIds":{"type":"array","description":"The ids of the topics used for this job","items":{"type":"string"}}}},"TtsEngineEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/TtsEngineEntity"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ReportingExportMetadataJobListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ReportingExportMetadataJobResponse"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ReportingExportMetadataJobResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"viewType":{"type":"string","description":"The view type of the export metadata","enum":["QUEUE_PERFORMANCE_SUMMARY_VIEW","QUEUE_PERFORMANCE_DETAIL_VIEW","INTERACTION_SEARCH_VIEW","AGENT_PERFORMANCE_SUMMARY_VIEW","AGENT_PERFORMANCE_DETAIL_VIEW","AGENT_STATUS_SUMMARY_VIEW","AGENT_STATUS_DETAIL_VIEW","AGENT_EVALUATION_SUMMARY_VIEW","AGENT_EVALUATION_DETAIL_VIEW","AGENT_QUEUE_DETAIL_VIEW","AGENT_INTERACTION_DETAIL_VIEW","ABANDON_INSIGHTS_VIEW","SKILLS_PERFORMANCE_VIEW","SURVEY_FORM_PERFORMANCE_SUMMARY_VIEW","SURVEY_FORM_PERFORMANCE_DETAIL_VIEW","DNIS_PERFORMANCE_SUMMARY_VIEW","DNIS_PERFORMANCE_DETAIL_VIEW","WRAP_UP_PERFORMANCE_SUMMARY_VIEW","AGENT_WRAP_UP_PERFORMANCE_DETAIL_VIEW","QUEUE_ACTIVITY_SUMMARY_VIEW","QUEUE_ACTIVITY_DETAIL_VIEW","AGENT_QUEUE_ACTIVITY_SUMMARY_VIEW","QUEUE_AGENT_DETAIL_VIEW","QUEUE_INTERACTION_DETAIL_VIEW","AGENT_SCHEDULE_DETAIL_VIEW","IVR_PERFORMANCE_SUMMARY_VIEW","IVR_PERFORMANCE_DETAIL_VIEW","ANSWER_INSIGHTS_VIEW","HANDLE_INSIGHTS_VIEW","TALK_INSIGHTS_VIEW","HOLD_INSIGHTS_VIEW","ACW_INSIGHTS_VIEW","WAIT_INSIGHTS_VIEW","AGENT_WRAP_UP_PERFORMANCE_INTERVAL_DETAIL_VIEW","FLOW_OUTCOME_SUMMARY_VIEW","FLOW_OUTCOME_PERFORMANCE_DETAIL_VIEW","FLOW_OUTCOME_PERFORMANCE_INTERVAL_DETAIL_VIEW","FLOW_DESTINATION_SUMMARY_VIEW","FLOW_DESTINATION_DETAIL_VIEW","API_USAGE_VIEW","SCHEDULED_CALLBACKS_VIEW","CONTENT_SEARCH_VIEW","LANDING_PAGE","DASHBOARD_SUMMARY","DASHBOARD_DETAIL","JOURNEY_ACTION_MAP_SUMMARY_VIEW","JOURNEY_OUTCOME_SUMMARY_VIEW","JOURNEY_SEGMENT_SUMMARY_VIEW","AGENT_DEVELOPMENT_DETAIL_VIEW","AGENT_DEVELOPMENT_DETAIL_ME_VIEW","AGENT_DEVELOPMENT_SUMMARY_VIEW","AGENT_PERFORMANCE_ME_VIEW","AGENT_STATUS_ME_VIEW","AGENT_EVALUATION_ME_VIEW"],"x-genesys-enum-members":[{"name":"QUEUE_PERFORMANCE_SUMMARY_VIEW"},{"name":"QUEUE_PERFORMANCE_DETAIL_VIEW"},{"name":"INTERACTION_SEARCH_VIEW"},{"name":"AGENT_PERFORMANCE_SUMMARY_VIEW"},{"name":"AGENT_PERFORMANCE_DETAIL_VIEW"},{"name":"AGENT_STATUS_SUMMARY_VIEW"},{"name":"AGENT_STATUS_DETAIL_VIEW"},{"name":"AGENT_EVALUATION_SUMMARY_VIEW"},{"name":"AGENT_EVALUATION_DETAIL_VIEW"},{"name":"AGENT_QUEUE_DETAIL_VIEW"},{"name":"AGENT_INTERACTION_DETAIL_VIEW"},{"name":"ABANDON_INSIGHTS_VIEW"},{"name":"SKILLS_PERFORMANCE_VIEW"},{"name":"SURVEY_FORM_PERFORMANCE_SUMMARY_VIEW"},{"name":"SURVEY_FORM_PERFORMANCE_DETAIL_VIEW"},{"name":"DNIS_PERFORMANCE_SUMMARY_VIEW"},{"name":"DNIS_PERFORMANCE_DETAIL_VIEW"},{"name":"WRAP_UP_PERFORMANCE_SUMMARY_VIEW"},{"name":"AGENT_WRAP_UP_PERFORMANCE_DETAIL_VIEW"},{"name":"QUEUE_ACTIVITY_SUMMARY_VIEW"},{"name":"QUEUE_ACTIVITY_DETAIL_VIEW"},{"name":"AGENT_QUEUE_ACTIVITY_SUMMARY_VIEW"},{"name":"QUEUE_AGENT_DETAIL_VIEW"},{"name":"QUEUE_INTERACTION_DETAIL_VIEW"},{"name":"AGENT_SCHEDULE_DETAIL_VIEW"},{"name":"IVR_PERFORMANCE_SUMMARY_VIEW"},{"name":"IVR_PERFORMANCE_DETAIL_VIEW"},{"name":"ANSWER_INSIGHTS_VIEW"},{"name":"HANDLE_INSIGHTS_VIEW"},{"name":"TALK_INSIGHTS_VIEW"},{"name":"HOLD_INSIGHTS_VIEW"},{"name":"ACW_INSIGHTS_VIEW"},{"name":"WAIT_INSIGHTS_VIEW"},{"name":"AGENT_WRAP_UP_PERFORMANCE_INTERVAL_DETAIL_VIEW"},{"name":"FLOW_OUTCOME_SUMMARY_VIEW"},{"name":"FLOW_OUTCOME_PERFORMANCE_DETAIL_VIEW"},{"name":"FLOW_OUTCOME_PERFORMANCE_INTERVAL_DETAIL_VIEW"},{"name":"FLOW_DESTINATION_SUMMARY_VIEW"},{"name":"FLOW_DESTINATION_DETAIL_VIEW"},{"name":"API_USAGE_VIEW"},{"name":"SCHEDULED_CALLBACKS_VIEW"},{"name":"CONTENT_SEARCH_VIEW"},{"name":"LANDING_PAGE"},{"name":"DASHBOARD_SUMMARY"},{"name":"DASHBOARD_DETAIL"},{"name":"JOURNEY_ACTION_MAP_SUMMARY_VIEW"},{"name":"JOURNEY_OUTCOME_SUMMARY_VIEW"},{"name":"JOURNEY_SEGMENT_SUMMARY_VIEW"},{"name":"AGENT_DEVELOPMENT_DETAIL_VIEW"},{"name":"AGENT_DEVELOPMENT_DETAIL_ME_VIEW"},{"name":"AGENT_DEVELOPMENT_SUMMARY_VIEW"},{"name":"AGENT_PERFORMANCE_ME_VIEW"},{"name":"AGENT_STATUS_ME_VIEW"},{"name":"AGENT_EVALUATION_ME_VIEW"}]},"dateLimitations":{"type":"string","description":"The date limitations of the export metadata"},"requiredFilters":{"type":"array","description":"The list of required filters for the export metadata","items":{"type":"string"}},"supportedFilters":{"type":"array","description":"The list of supported filters for the export metadata","items":{"type":"string"}},"requiredColumnIds":{"type":"array","description":"The list of required column ids for the export metadata","items":{"type":"string"}},"dependentColumnIds":{"type":"object","description":"The list of dependent column ids for the export metadata","additionalProperties":{"type":"array","items":{"type":"string"}}},"availableColumnIds":{"type":"array","description":"The list of available column ids for the export metadata","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TrusteeAuditQueryRequest":{"type":"object","required":["trusteeOrganizationIds","trusteeUserIds"],"properties":{"trusteeOrganizationIds":{"type":"array","description":"Limit returned audits to these trustee organizationIds.","items":{"type":"string"}},"trusteeUserIds":{"type":"array","description":"Limit returned audits to these trustee userIds.","items":{"type":"string"}},"startDate":{"type":"string","format":"date-time","description":"Starting date/time for the audit search. ISO-8601 formatted date-time, UTC."},"endDate":{"type":"string","format":"date-time","description":"Ending date/time for the audit search. ISO-8601 formatted date-time, UTC."},"queryPhrase":{"type":"string","description":"Word or phrase to look for in audit bodies."},"facets":{"type":"array","description":"Facet information to be returned with the query results.","items":{"$ref":"#/definitions/Facet"}},"filters":{"type":"array","description":"Additional custom filters to be applied to the query.","items":{"$ref":"#/definitions/Filter"}}}},"LineIntegrationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/LineIntegration"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"RuleSetEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/RuleSet"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"InboundRouteEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/InboundRoute"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"OneLogin":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"disabled":{"type":"boolean"},"issuerURI":{"type":"string"},"ssoTargetURI":{"type":"string"},"certificate":{"type":"string"},"certificates":{"type":"array","items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"JsonSearchResponse":{"type":"object","required":["pageCount","pageNumber","pageSize","results","total","types"],"properties":{"total":{"type":"integer","format":"int64","description":"The total number of results found"},"pageCount":{"type":"integer","format":"int32","description":"The total number of pages"},"pageSize":{"type":"integer","format":"int32","description":"The current page size"},"pageNumber":{"type":"integer","format":"int32","description":"The current page number"},"types":{"type":"array","description":"Resource types the search was performed against","items":{"type":"string"}},"results":{"description":"Search results","$ref":"#/definitions/ArrayNode"},"aggregations":{"$ref":"#/definitions/ArrayNode"}}},"TranscriptSearchCriteria":{"type":"object","properties":{"endValue":{"type":"string","description":"The end value of the range. This field is used for range search types."},"values":{"type":"array","description":"A list of values for the search to match against","items":{"type":"string"}},"startValue":{"type":"string","description":"The start value of the range. This field is used for range search types."},"fields":{"type":"array","description":"Field names to search against","items":{"type":"string"}},"value":{"type":"string","description":"A value for the search to match against"},"operator":{"type":"string","description":"How to apply this search criteria against other criteria","enum":["AND","OR","NOT"],"x-genesys-enum-members":[{"name":"AND"},{"name":"OR"},{"name":"NOT"}]},"group":{"type":"array","description":"Groups multiple conditions","items":{"$ref":"#/definitions/TranscriptSearchCriteria"}},"dateFormat":{"type":"string","description":"Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX."},"type":{"type":"string","enum":["EXACT","EXACT_PHRASE","PHRASE","DATE_RANGE","RANGE","GREATER_THAN","LESS_THAN"],"x-genesys-enum-members":[{"name":"EXACT"},{"name":"EXACT_PHRASE"},{"name":"PHRASE"},{"name":"DATE_RANGE"},{"name":"RANGE"},{"name":"GREATER_THAN"},{"name":"LESS_THAN"}]}}},"TranscriptSearchRequest":{"type":"object","required":["types"],"properties":{"sortOrder":{"type":"string","description":"The sort order for results","enum":["ASC","DESC","SCORE"],"x-genesys-enum-members":[{"name":"ASC"},{"name":"DESC"},{"name":"SCORE"}]},"sortBy":{"type":"string","description":"The field in the resource that you want to sort the results by"},"pageSize":{"type":"integer","format":"int32","description":"The number of results per page"},"pageNumber":{"type":"integer","format":"int32","description":"The page of resources you want to retrieve"},"sort":{"type":"array","description":"Multi-value sort order, list of multiple sort values","items":{"$ref":"#/definitions/SearchSort"}},"returnFields":{"type":"array","items":{"type":"string"}},"types":{"type":"array","description":"Resource domain type to search","items":{"type":"string"}},"query":{"type":"array","description":"The search criteria","items":{"$ref":"#/definitions/TranscriptSearchCriteria"}}}},"PromptEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Prompt"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ReportSchedule":{"type":"object","required":["interval","quartzCronExpression","reportId"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"quartzCronExpression":{"type":"string","description":"Quartz Cron Expression"},"nextFireTime":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateCreated":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateModified":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"description":{"type":"string"},"timeZone":{"type":"string"},"timePeriod":{"type":"string"},"interval":{"type":"string","description":"Interval. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"reportFormat":{"type":"string"},"locale":{"type":"string"},"enabled":{"type":"boolean"},"reportId":{"type":"string","description":"Report ID"},"parameters":{"type":"object","additionalProperties":{"type":"object"}},"lastRun":{"$ref":"#/definitions/ReportRunEntry"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ReportScheduleEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ReportSchedule"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"LocationCreateDefinition":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The name of the Location. Required for creates, not required for updates"},"version":{"type":"integer","format":"int32","description":"Current version of the location"},"state":{"type":"string","description":"Current activity status of the location.","enum":["active","deleted"]},"path":{"type":"array","description":"A list of ancestor ids","items":{"type":"string"}},"notes":{"type":"string","description":"Notes for the location"},"contactUser":{"type":"string","description":"The user id of the location contact"},"emergencyNumber":{"description":"Emergency number for the location","$ref":"#/definitions/LocationEmergencyNumber"},"address":{"description":"Address of the location","$ref":"#/definitions/LocationAddress"}}},"WebChatGuestMediaRequestEntityList":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WebChatGuestMediaRequest"}}}},"FaxDocumentEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/FaxDocument"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"CreateCoachingAppointmentRequest":{"type":"object","required":["attendeeIds","conversationIds","dateStart","description","documentIds","lengthInMinutes","name"],"properties":{"name":{"type":"string","description":"The name of coaching appointment."},"description":{"type":"string","description":"The description of coaching appointment."},"dateStart":{"type":"string","format":"date-time","description":"The date/time the coaching appointment starts. Times will be rounded down to the minute. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"lengthInMinutes":{"type":"integer","format":"int32","description":"The duration of coaching appointment in minutes."},"facilitatorId":{"type":"string","description":"The facilitator ID of coaching appointment."},"attendeeIds":{"type":"array","description":"IDs of attendees in the coaching appointment.","uniqueItems":true,"items":{"type":"string"}},"conversationIds":{"type":"array","description":"IDs of conversations associated with this coaching appointment.","uniqueItems":true,"items":{"type":"string"}},"documentIds":{"type":"array","description":"IDs of documents associated with this coaching appointment.","uniqueItems":true,"items":{"type":"string"}}},"description":"Create coaching appointment request"},"ReportRunEntryEntityDomainListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ReportRunEntry"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ImportScriptStatusResponse":{"type":"object","properties":{"url":{"type":"string","format":"uri"},"succeeded":{"type":"boolean"},"message":{"type":"string"}}},"ProgramJobRequest":{"type":"object","required":["programIds"],"properties":{"programIds":{"type":"array","description":"The ids of the programs used for this job","items":{"type":"string"}}}},"CreateWebChatRequest":{"type":"object","required":["provider","queueId"],"properties":{"queueId":{"type":"string","description":"The ID of the queue to use for routing the chat conversation."},"provider":{"type":"string","description":"The name of the provider that is sourcing the web chat."},"skillIds":{"type":"array","description":"The list of skill ID's to use for routing.","items":{"type":"string"}},"languageId":{"type":"string","description":"The ID of the langauge to use for routing."},"priority":{"type":"integer","format":"int64","description":"The priority to assign to the conversation for routing."},"attributes":{"type":"object","description":"The list of attributes to associate with the customer participant.","additionalProperties":{"type":"string"}},"customerName":{"type":"string","description":"The name of the customer participating in the web chat."}}},"UnpublishedProgramsEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Program"}},"pageSize":{"type":"integer","format":"int32"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AuditChange":{"type":"object","properties":{"property":{"type":"string"},"entity":{"$ref":"#/definitions/AuditEntityReference"},"oldValues":{"type":"array","items":{"type":"string"}},"newValues":{"type":"array","items":{"type":"string"}}}},"AuditEntityReference":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri"},"type":{"type":"string","enum":["ATTRIBUTE","ATTRIBUTE_GROUP_INSTANCE","DOCUMENT","DOWNLOAD","FAX","GROUP","RECORDING","TAG","WORKSPACE","USER","PUBLIC"],"x-genesys-enum-members":[{"name":"ATTRIBUTE"},{"name":"ATTRIBUTE_GROUP_INSTANCE"},{"name":"DOCUMENT"},{"name":"DOWNLOAD"},{"name":"FAX"},{"name":"GROUP"},{"name":"RECORDING"},{"name":"TAG"},{"name":"WORKSPACE"},{"name":"USER"},{"name":"PUBLIC"}]},"action":{"type":"string"}}},"DocumentAudit":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"user":{"$ref":"#/definitions/DomainEntityRef"},"workspace":{"$ref":"#/definitions/DomainEntityRef"},"transactionId":{"type":"string"},"transactionInitiator":{"type":"boolean"},"application":{"type":"string"},"serviceName":{"type":"string"},"level":{"type":"string","enum":["USER","SYSTEM"],"x-genesys-enum-members":[{"name":"USER"},{"name":"SYSTEM"}]},"timestamp":{"type":"string","format":"date-time","description":"Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"status":{"type":"string","enum":["SUCCESS","FAILURE","WARNING"],"x-genesys-enum-members":[{"name":"SUCCESS"},{"name":"FAILURE"},{"name":"WARNING"}]},"actionContext":{"type":"string","enum":["CREATE","READ","UPDATE","DELETE","DOWNLOAD","VIEW","UPLOAD","SAVE","MOVE","COPY","ADD","REMOVE","RECEIVE","CONVERT","FAX","CREATE_COVERPAGE","USER_ADD","USER_REMOVE","MEMBER_ADD","MEMBER_REMOVE","MEMBER_UPDATE","TAG_ADD","TAG_REMOVE","TAG_UPDATE","ATTRIBUTE_ADD","ATTRIBUTE_REMOVE","ATTRIBUTE_UPDATE","ATTRIBUTE_GROUP_INSTANCE_ADD","ATTRIBUTE_GROUP_INSTANCE_REMOVE","ATTRIBUTE_GROUP_INSTANCE_UPDATE","INDEX_SAVE","INDEX_DELETE","INDEX_CREATE","FILE_SAVE","FILE_DELETE","FILE_READ","THUMBNAIL_CREATE","TEXT_EXTRACT","SHARE_ADD","SHARE_REMOVE","VERSION_CREATE"],"x-genesys-enum-members":[{"name":"CREATE"},{"name":"READ"},{"name":"UPDATE"},{"name":"DELETE"},{"name":"DOWNLOAD"},{"name":"VIEW"},{"name":"UPLOAD"},{"name":"SAVE"},{"name":"MOVE"},{"name":"COPY"},{"name":"ADD"},{"name":"REMOVE"},{"name":"RECEIVE"},{"name":"CONVERT"},{"name":"FAX"},{"name":"CREATE_COVERPAGE"},{"name":"USER_ADD"},{"name":"USER_REMOVE"},{"name":"MEMBER_ADD"},{"name":"MEMBER_REMOVE"},{"name":"MEMBER_UPDATE"},{"name":"TAG_ADD"},{"name":"TAG_REMOVE"},{"name":"TAG_UPDATE"},{"name":"ATTRIBUTE_ADD"},{"name":"ATTRIBUTE_REMOVE"},{"name":"ATTRIBUTE_UPDATE"},{"name":"ATTRIBUTE_GROUP_INSTANCE_ADD"},{"name":"ATTRIBUTE_GROUP_INSTANCE_REMOVE"},{"name":"ATTRIBUTE_GROUP_INSTANCE_UPDATE"},{"name":"INDEX_SAVE"},{"name":"INDEX_DELETE"},{"name":"INDEX_CREATE"},{"name":"FILE_SAVE"},{"name":"FILE_DELETE"},{"name":"FILE_READ"},{"name":"THUMBNAIL_CREATE"},{"name":"TEXT_EXTRACT"},{"name":"SHARE_ADD"},{"name":"SHARE_REMOVE"},{"name":"VERSION_CREATE"}]},"action":{"type":"string","enum":["CREATE","READ","UPDATE","DELETE","DOWNLOAD","VIEW","UPLOAD","SAVE","MOVE","COPY","ADD","REMOVE","RECEIVE","CONVERT","FAX","CREATE_COVERPAGE","USER_ADD","USER_REMOVE","MEMBER_ADD","MEMBER_REMOVE","MEMBER_UPDATE","TAG_ADD","TAG_REMOVE","TAG_UPDATE","ATTRIBUTE_ADD","ATTRIBUTE_REMOVE","ATTRIBUTE_UPDATE","ATTRIBUTE_GROUP_INSTANCE_ADD","ATTRIBUTE_GROUP_INSTANCE_REMOVE","ATTRIBUTE_GROUP_INSTANCE_UPDATE","INDEX_SAVE","INDEX_DELETE","INDEX_CREATE","FILE_SAVE","FILE_DELETE","FILE_READ","THUMBNAIL_CREATE","TEXT_EXTRACT","SHARE_ADD","SHARE_REMOVE","VERSION_CREATE"],"x-genesys-enum-members":[{"name":"CREATE"},{"name":"READ"},{"name":"UPDATE"},{"name":"DELETE"},{"name":"DOWNLOAD"},{"name":"VIEW"},{"name":"UPLOAD"},{"name":"SAVE"},{"name":"MOVE"},{"name":"COPY"},{"name":"ADD"},{"name":"REMOVE"},{"name":"RECEIVE"},{"name":"CONVERT"},{"name":"FAX"},{"name":"CREATE_COVERPAGE"},{"name":"USER_ADD"},{"name":"USER_REMOVE"},{"name":"MEMBER_ADD"},{"name":"MEMBER_REMOVE"},{"name":"MEMBER_UPDATE"},{"name":"TAG_ADD"},{"name":"TAG_REMOVE"},{"name":"TAG_UPDATE"},{"name":"ATTRIBUTE_ADD"},{"name":"ATTRIBUTE_REMOVE"},{"name":"ATTRIBUTE_UPDATE"},{"name":"ATTRIBUTE_GROUP_INSTANCE_ADD"},{"name":"ATTRIBUTE_GROUP_INSTANCE_REMOVE"},{"name":"ATTRIBUTE_GROUP_INSTANCE_UPDATE"},{"name":"INDEX_SAVE"},{"name":"INDEX_DELETE"},{"name":"INDEX_CREATE"},{"name":"FILE_SAVE"},{"name":"FILE_DELETE"},{"name":"FILE_READ"},{"name":"THUMBNAIL_CREATE"},{"name":"TEXT_EXTRACT"},{"name":"SHARE_ADD"},{"name":"SHARE_REMOVE"},{"name":"VERSION_CREATE"}]},"entity":{"$ref":"#/definitions/AuditEntityReference"},"changes":{"type":"array","items":{"$ref":"#/definitions/AuditChange"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DocumentAuditEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DocumentAudit"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"SpeechTextAnalyticsSettingsResponse":{"type":"object","properties":{"defaultProgram":{"description":"Setting to choose name for the default program for topic detection","$ref":"#/definitions/AddressableEntityRef"},"expectedDialects":{"type":"array","description":"Setting to choose expected dialects","items":{"type":"string"}}}},"SpeechTextAnalyticsSettingsRequest":{"type":"object","properties":{"defaultProgramId":{"type":"string","description":"Setting to choose name for the default program for topic detection"},"expectedDialects":{"type":"array","description":"Setting to choose expected dialects","items":{"type":"string"}}}},"TimeOffRequest":{"type":"object","required":["id","user"],"properties":{"id":{"type":"string","description":"The id of the time off request"},"user":{"description":"The user that the time off request belongs to","$ref":"#/definitions/UserReference"},"isFullDayRequest":{"type":"boolean","description":"Whether this is a full day request (false means partial day)"},"markedAsRead":{"type":"boolean","description":"Whether this request has been marked as read by the agent"},"activityCodeId":{"type":"string","description":"The ID of the activity code associated with this time off request. Activity code must be of the TimeOff category"},"status":{"type":"string","description":"The status of this time off request","enum":["PENDING","APPROVED","DENIED","CANCELED"],"x-genesys-enum-members":[{"name":"PENDING"},{"name":"APPROVED"},{"name":"DENIED"},{"name":"CANCELED"}]},"partialDayStartDateTimes":{"type":"array","description":"A set of start date-times in ISO-8601 format for partial day requests. Will be not empty if isFullDayRequest == false","uniqueItems":true,"items":{"type":"string","format":"date-time"}},"fullDayManagementUnitDates":{"type":"array","description":"A set of dates in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone. Will be not empty if isFullDayRequest == true","uniqueItems":true,"items":{"type":"string"}},"dailyDurationMinutes":{"type":"integer","format":"int32","description":"The daily duration of this time off request in minutes"},"notes":{"type":"string","description":"Notes about the time off request"},"submittedBy":{"description":"The user who submitted this time off request","$ref":"#/definitions/UserReference"},"submittedDate":{"type":"string","format":"date-time","description":"The timestamp when this request was submitted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"reviewedBy":{"description":"The user who reviewed this time off request","$ref":"#/definitions/UserReference"},"reviewedDate":{"type":"string","format":"date-time","description":"The timestamp when this request was reviewed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"metadata":{"description":"The version metadata of the time off request","$ref":"#/definitions/WfmVersionedEntityMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"TimeOffRequestListing":{"type":"object","required":["entities"],"properties":{"entities":{"type":"array","description":"List of time off request look up objects","items":{"$ref":"#/definitions/TimeOffRequest"}}}},"DateRange":{"type":"object","properties":{"startDate":{"type":"string","description":"The inclusive start of a date range in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone."},"endDate":{"type":"string","description":"The inclusive end of a date range in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone."}}},"TimeOffRequestQueryBody":{"type":"object","properties":{"userIds":{"type":"array","description":"The set of user ids to filter time off requests","uniqueItems":true,"items":{"type":"string"}},"statuses":{"type":"array","description":"The set of statuses to filter time off requests","uniqueItems":true,"items":{"type":"string","enum":["PENDING"],"x-genesys-enum-members":[{"name":"PENDING"}]}},"dateRange":{"description":"The inclusive range of dates to filter time off requests","$ref":"#/definitions/DateRange"}}},"CreateAdminTimeOffRequest":{"type":"object","required":["activityCodeId","dailyDurationMinutes","status","users"],"properties":{"status":{"type":"string","description":"The status of this time off request","enum":["PENDING","APPROVED"],"x-genesys-enum-members":[{"name":"PENDING"},{"name":"APPROVED"}]},"users":{"type":"array","description":"A set of IDs for users to associate with this time off request","uniqueItems":true,"items":{"$ref":"#/definitions/UserReference"}},"activityCodeId":{"type":"string","description":"The ID of the activity code associated with this time off request. Activity code must be of the TimeOff category"},"notes":{"type":"string","description":"Notes about the time off request"},"fullDayManagementUnitDates":{"type":"array","description":"A set of dates in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone.","uniqueItems":true,"items":{"type":"string"}},"partialDayStartDateTimes":{"type":"array","description":"A set of start date-times in ISO-8601 format for partial day requests.","uniqueItems":true,"items":{"type":"string","format":"date-time"}},"dailyDurationMinutes":{"type":"integer","format":"int32","description":"The daily duration of this time off request in minutes"}}},"AdminTimeOffRequestPatch":{"type":"object","required":["metadata"],"properties":{"status":{"type":"string","description":"The status of this time off request","enum":["PENDING","APPROVED","DENIED"],"x-genesys-enum-members":[{"name":"PENDING"},{"name":"APPROVED"},{"name":"DENIED"}]},"activityCodeId":{"type":"string","description":"The ID of the activity code associated with this time off request. Activity code must be of the TimeOff category"},"notes":{"type":"string","description":"Notes about the time off request"},"fullDayManagementUnitDates":{"type":"array","description":"A set of dates in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone.","uniqueItems":true,"items":{"type":"string"}},"partialDayStartDateTimes":{"type":"array","description":"A set of start date-times in ISO-8601 format for partial day requests.","uniqueItems":true,"items":{"type":"string","format":"date-time"}},"dailyDurationMinutes":{"type":"integer","format":"int32","description":"The daily duration of this time off request in minutes"},"metadata":{"description":"Version metadata for the time off request","$ref":"#/definitions/WfmVersionedEntityMetadata"}}}},"responses":{"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"}},"413":{"description":"The request is over the size limit. Content-Length: %s","schema":{"$ref":"#/definitions/ErrorBody"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"}},"429":{"description":"Rate limit exceeded the maximum [%s] requests within [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"}}},"externalDocs":{"description":"PureCloud API Documentation","url":"https://developer.mypurecloud.com"}} \ No newline at end of file diff --git a/version.json b/version.json index a8a07ddf1..ca18fe64d 100644 --- a/version.json +++ b/version.json @@ -1,9 +1,9 @@ { - "major": 33, + "major": 34, "minor": 0, - "point": 3, + "point": 0, "prerelease": "", "apiVersion": 0, - "display": "33.0.3", - "displayFull": "33.0.3" + "display": "34.0.0", + "displayFull": "34.0.0" } \ No newline at end of file